Invision Power Services, Inc. * @copyright (c) Invision Power Services, Inc. * @license https://www.invisioncommunity.com/legal/standards/ * @package Invision Community * @since 1 Jul 2015 */ namespace IPS\core; /* To prevent PHP errors (extending class does not exist) revealing path */ if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) ) { header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' ); exit; } /** * RSS Exports */ class _Rss extends \IPS\Node\Model { /** * @brief [ActiveRecord] Multiton Store */ protected static $multitons; /** * @brief [ActiveRecord] Database Table */ public static $databaseTable = 'core_rss_export'; /** * @brief [ActiveRecord] Database Prefix */ public static $databasePrefix = 'rss_'; /** * @brief [Node] Order Database Column */ public static $databaseColumnOrder = 'position'; /** * @brief [Node] Node Title */ public static $nodeTitle = 'rss_exports'; /** * @brief [Node] Title prefix. If specified, will look for a language key with "{$key}_title" as the key */ public static $titleLangPrefix = 'rss_export_title_'; /** * @brief [Node] Description suffix. If specified, will look for a language key with "{$titleLangPrefix}_{$id}_{$descriptionLangSuffix}" as the key */ public static $descriptionLangSuffix = '_desc'; /** * @brief [Node] Enabled/Disabled Column */ public static $databaseColumnEnabledDisabled = 'enabled'; /** * @brief [Node] ACP Restrictions * @code array( 'app' => 'core', // The application key which holds the restrictrions 'module' => 'foo', // The module key which holds the restrictions 'map' => array( // [Optional] The key for each restriction - can alternatively use "prefix" 'add' => 'foo_add', 'edit' => 'foo_edit', 'permissions' => 'foo_perms', 'delete' => 'foo_delete' ), 'all' => 'foo_manage', // [Optional] The key to use for any restriction not provided in the map (only needed if not providing all 4) 'prefix' => 'foo_', // [Optional] Rather than specifying each key in the map, you can specify a prefix, and it will automatically look for restrictions with the key "[prefix]_add/edit/permissions/delete" * @encode */ protected static $restrictions = array( 'app' => 'core', 'module' => 'discovery', 'all' => 'rss_export_manage', ); /** * @brief [Node] URL Base */ public static $urlBase = 'app=core&module=discover&controller=rss&id='; /** * @brief [Node] SEO Template */ public static $urlTemplate = 'rss_feed'; /** * @brief SEO Title Column */ public static $seoTitleColumn = 'seo_title'; /** * Load Record * * @see \IPS\Db::build * @param int|string $id ID * @param string $idField The database column that the $id parameter pertains to (NULL will use static::$databaseColumnId) * @param mixed $extraWhereClause Additional where clause(s) (see \IPS\Db::build for details) * @return static * @throws \InvalidArgumentException * @throws \OutOfRangeException */ public static function load( $id, $idField=NULL, $extraWhereClause=NULL ) { $feeds = static::getAllFeeds(); if ( isset( $feeds[ $id ] ) ) { return $feeds[ $id ]; } return parent::load( $id, $idField, $extraWhereClause ); } /** * [Node] Add/Edit Form * * @param \IPS\Helpers\Form $form The form * @return void */ public function form( &$form ) { /* Main Settings Form */ $form->addHeader( 'rss_settings' ); $form->add( new \IPS\Helpers\Form\Translatable( 'rss_name', NULL, TRUE, array( 'app' => 'core', 'key' => ( $this->_id ) ? "rss_export_title_{$this->_id}" : NULL ) ) ); $form->add( new \IPS\Helpers\Form\Translatable( 'rss_desc', NULL, TRUE, array( 'app' => 'core', 'key' => ( $this->_id ) ? "rss_export_title_{$this->_id}_desc" : NULL ) ) ); $form->add( new \IPS\Helpers\Form\Number( 'rss_count', ( $this->_id ) ? $this->count : 25, TRUE, array( 'min' => 1, 'max' => 100 ) ) ); $groups = array(); foreach( \IPS\Member\Group::groups() AS $group_id => $group ) { $groups[ $group_id ] = $group->name; } $form->add( new \IPS\Helpers\Form\Select( 'rss_groups', ( $this->_id ) ? $this->groups : '*', FALSE, array( 'options' => $groups, 'multiple' => TRUE, 'unlimited' => '*' ) ) ); /* Content Form */ $form->addHeader( 'rss_content' ); foreach( \IPS\Content::routedClasses( TRUE, FALSE, TRUE ) AS $class ) { $options = array(); $containerClass = NULL; if ( isset( $class::$containerNodeClass ) ) { $options = array( 'togglesOn' => array( 'rss_nodes_' . $class::$title ) ); $containerClass = $class::$containerNodeClass; } \IPS\Member::loggedIn()->language()->words["rss_classes_{$class}"] = \IPS\Member::loggedIn()->language()->addToStack( $class::$title . '_pl' ); $form->add( new \IPS\Helpers\Form\YesNo( 'rss_classes_' . $class, ( $this->_id ) ? in_array( $class, $this->configuration['classes'] ) : FALSE, FALSE, $options ) ); if ( $containerClass ) { \IPS\Member::loggedIn()->language()->words["nodes_{$class}"] = \IPS\Member::loggedIn()->language()->addToStack( $containerClass::$nodeTitle ); $form->add( new \IPS\Helpers\Form\Node( "nodes_{$class}", ( $this->_id AND isset( $this->configuration['containers'][$class] ) ) ? $this->configuration['containers'][$class] : 0, FALSE, array( 'class' => $containerClass, 'zeroVal' => 'all', 'multiple' => TRUE, 'permissionCheck' => function( $val ) { return $val->can( 'view', new \IPS\Member ); } ), NULL, NULL, NULL, "rss_nodes_{$class::$title}" ) ); } } $members = NULL; if ( $this->_id AND isset( $this->configuration['members'] ) ) { if ( count( $this->configuration['members'] ) ) { $members = array(); foreach( $this->configuration['members'] AS $member ) { $members[] = \IPS\Member::load( $member ); } } } $form->add( new \IPS\Helpers\Form\Member( 'rss_members', $members, FALSE, array( 'multiple' => NULL, 'nullLang' => 'everyone' ) ) ); } /** * [Node] Format form values from add/edit form for save * * @param array $values Values from the form * @return array */ public function formatFormValues( $values ) { /* Build our config */ $config = array( 'classes' => array(), 'containers' => array(), 'members' => array() ); /* Set the classes and containers */ foreach( $values AS $k => $v ) { if ( mb_substr( $k, 0, 12 ) == 'rss_classes_' ) { if ( $values[$k] == TRUE ) { $config['classes'][] = str_replace( 'rss_classes_', '', $k ); } unset( $values[$k] ); } else if ( mb_substr( $k, 0, 6 ) == 'nodes_' ) { if ( is_array( $v ) ) { foreach( $v AS $id => $node ) { if ( $node instanceof \IPS\Node\Model ) { $config['containers'][ str_replace( 'nodes_', '', $k ) ][] = $node->_id; } else { $config['containers'][ str_replace( 'nodes_', '', $k )][] = $node; } } } else { if ( $v instanceof \IPS\Node\Model ) { $config['containers'][ str_replace( 'nodes_', '', $k ) ][] = $v->_id; } else { $config['containers'][ str_replace( 'nodes_', '', $k ) ] = $v; } } unset( $values[$k] ); } } /* Set the members */ if ( array_key_exists( 'rss_members', $values ) ) { if ( is_array( $values['rss_members'] ) ) { foreach( $values['rss_members'] AS $member ) { if ( $member instanceof \IPS\Member ) { $config['members'][] = $member->member_id; } } } else if ( $values['rss_members'] instanceof \IPS\Member ) { $config['members'][] = $values['rss_members']->member_id; } unset( $values['rss_members'] ); } $this->configuration = $config; /* Save, as we need the ID after this point */ if ( !$this->_id ) { $this->save(); } /* Custom Language Strings */ if ( array_key_exists( 'rss_name', $values ) ) { \IPS\Lang::saveCustom( 'core', "rss_export_title_{$this->_id}", $values['rss_name'] ); if ( is_array( $values['rss_name'] ) ) { reset( $values['rss_name'] ); $this->seo_title = \IPS\Http\Url\Friendly::seoTitle( $values['rss_name'][ key( $values['rss_name'] ) ] ); } else { $this->seo_title = \IPS\Http\Url\Friendly::seoTitle( $values['rss_name'] ); } unset( $values['rss_name'] ); } if ( array_key_exists( 'rss_desc', $values ) ) { \IPS\Lang::saveCustom( 'core', "rss_export_title_{$this->_id}_desc", $values['rss_desc'] ); unset( $values['rss_desc'] ); } /* Pass to parent */ return parent::formatFormValues( $values ); } /** * [Node] Perform actions after saving the form * * @param array $values Values from the form * @return void */ public function postSaveForm( $values ) { unset( \IPS\Data\Store::i()->rssFeeds ); parent::postSaveForm( $values ); } /** * [ActiveRecord] Delete Record * * @return void */ public function delete() { parent::delete(); unset( \IPS\Data\Store::i()->rssFeeds ); } /** * Get Configuration * * @return array */ public function get_configuration() { return json_decode( $this->_data['configuration'], TRUE ); } /** * Set Configuration * * @param array The configuration * @return void */ public function set_configuration( array $values ) { $this->_data['configuration'] = json_encode( $values ); } /** * Set Groups * * @param array|string The groups, or an asterisk for all groups * @return void */ public function set_groups( $values ) { if ( is_array( $values ) ) { $this->_data['groups'] = implode( ',', $values ); } else { $this->_data['groups'] = '*'; } } /** * Get Groups * * @return array */ public function get_groups() { if ( $this->_data['groups'] == '*' ) { return $this->_data['groups']; } return explode( ',', $this->_data['groups'] ); } /** * Generate the feed * * @param \IPS\Member|NULL The member, or NULL for a Guest * @return string */ public function generate( $member=NULL ) { $member = $member ?: new \IPS\Member; $search = \IPS\Content\Search\Query::init( $member ); if ( count( $this->configuration['classes'] ) ) { $filters = array(); foreach( $this->configuration['classes'] AS $class ) { if ( isset( $class::$firstCommentRequired ) AND $class::$firstCommentRequired ) { $filter = \IPS\Content\Search\ContentFilter::init( $class, TRUE, TRUE, FALSE )->onlyFirstComment(); } else { $filter = \IPS\Content\Search\ContentFilter::init( $class, TRUE, FALSE, FALSE ); } if ( !empty( $this->configuration['containers'][$class] ) ) { $filter->onlyInContainers( $this->configuration['containers'][$class] ); } $filters[] = $filter; } $search->filterByContent( $filters ); } if ( isset( $this->configuration['members'] ) AND count( $this->configuration['members'] ) ) { $search->filterByAuthor( $this->configuration['members'] ); } $search->setLimit( $this->count ); $search->setOrder( \IPS\Content\Search\Query::ORDER_NEWEST_CREATED ); $results = $search->search(); /* We have to use get() to ensure CDATA tags wrap the title properly */ $title = \IPS\Member::loggedIn()->language()->get( "rss_export_title_{$this->_id}" ); $description = \IPS\Member::loggedIn()->language()->get( "rss_export_title_{$this->_id}_desc" ); $document = \IPS\Xml\Rss::newDocument( $this->url(), $title, $description ); foreach( $results AS $result ) { $result->addToRssFeed( $document ); } return $document->asXML(); } /** * Get All Available Feeds * * @return array */ public static function getAllFeeds() { if ( !isset( \IPS\Data\Store::i()->rssFeeds ) ) { $rows = array(); foreach( \IPS\Db::i()->select( '*', 'core_rss_export', NULL, 'rss_position' ) AS $row ) { $rows[ $row['rss_id'] ] = $row; } \IPS\Data\Store::i()->rssFeeds = $rows; } $return = array(); if ( count( \IPS\Data\Store::i()->rssFeeds ) ) { foreach( \IPS\Data\Store::i()->rssFeeds AS $feed_id => $feed ) { $feed = static::constructFromData( $feed ); if ( $feed->_enabled ) { $return[ $feed->_id ] = $feed; } } } return $return; } /** * Get URL * * @return \IPS\Http\Url */ public function url() { $url = parent::url(); if ( \IPS\Member::loggedIn()->member_id ) { $url = $url->setQueryString( array( 'member_id' => \IPS\Member::loggedIn()->member_id, 'key' => md5( \IPS\Member::loggedIn()->member_id . \IPS\Member::loggedIn()->email . \IPS\Member::loggedIn()->member_pass_hash . \IPS\Member::loggedIn()->member_pass_salt ) ) ); } return $url; } }