Invision Power Services, Inc. * @copyright (c) Invision Power Services, Inc. * @package Invision Community * @subpackage convert * @since 21 Jan 2015 */ namespace IPS\convert\Software\Forums; /* To prevent PHP errors (extending class does not exist) revealing path */ use DomainException; use Exception; use InvalidArgumentException; use IPS\Content; use IPS\convert\App; use IPS\convert\Software; use IPS\convert\Software\Core\Xenforo as XenforoCore; use IPS\Db; use IPS\Http\Url; use IPS\Member; use IPS\Node\Model; use IPS\Patterns\ActiveRecordIterator; use IPS\Request; use IPS\Task; use OutOfRangeException; use UnderflowException; use function count; use function defined; use function is_array; use function is_null; use function unserialize; if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) ) { header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' ); exit; } /** * Xenforo Forums Converter */ class Xenforo extends Software { use \IPS\convert\Tools\Xenforo; /** * @brief The similarities between XF1 and XF2 are close enough that we can use the same converter */ public static ?bool $isLegacy = NULL; /** * @brief Flag to indicate the post data has been fixed during conversion, and we only need to use Legacy Parser */ public static bool $contentFixed = TRUE; /** * @brief XF2.1 changed serialized data to json decoded */ public static bool $useJson = FALSE; /** * Constructor * * @param App $app The application to reference for database and other information. * @param bool $needDB Establish a DB connection * @return void * @throws InvalidArgumentException */ public function __construct( App $app, bool $needDB=TRUE ) { parent::__construct( $app, $needDB ); if ( $needDB ) { try { /* Is this XF1 or XF2 */ if ( static::$isLegacy === NULL ) { $version = $this->db->select( 'MAX(version_id)', 'xf_template', array( Db::i()->in( 'addon_id', array( 'XF', 'XenForo' ) ) ) )->first(); if ( $version < 2000010 ) { /* XF1 */ static::$isLegacy = TRUE; } else { /* XF2 */ static::$isLegacy = FALSE; } /* Is this XF 2.1 */ if ( $version > 2010010 ) { static::$useJson = TRUE; } } } catch( Exception $e ) {} # If we can't query, we won't be able to do anything anyway } } /** * Software Name * * @return string */ public static function softwareName(): string { /* Child classes must override this method */ return "XenForo (1.5.x/2.0.x/2.1.x/2.2.x)"; } /** * Software Key * * @return string */ public static function softwareKey(): string { /* Child classes must override this method */ return "xenforo"; } /** * Content we can convert from this software. * * @return array|null */ public static function canConvert(): ?array { return array( 'convertForumsForums' => array( 'table' => 'xf_node', 'where' => array( Db::i()->in( 'node_type_id', array( 'Category', 'Forum', 'LinkForum' ) ) ) ), 'convertForumsTopics' => array( 'table' => 'xf_thread', 'where' => NULL ), 'convertForumsPosts' => array( 'table' => 'xf_post', 'where' => NULL, ), 'convertAttachments' => array( 'table' => 'xf_attachment', 'where' => array( "content_type=?", 'post' ) ) ); } /** * Requires Parent * * @return boolean */ public static function requiresParent(): bool { return TRUE; } /** * Possible Parent Conversions * * @return array|null */ public static function parents(): ?array { return array( 'core' => array( 'xenforo' ) ); } /** * List of conversion methods that require additional information * * @return array */ public static function checkConf(): array { $return = array( 'convertAttachments' ); if( !static::$useJson ) { $return[] = 'convertForumsPosts'; } return $return; } /** * Get More Information * * @param string $method Conversion method * @return array|null */ public function getMoreInfo( string $method ): ?array { $return = array(); switch( $method ) { case 'convertForumsPosts': /* XF 1 & 2 */ if( !static::$useJson ) { /* Get our reactions to let the admin map them */ $options = array(); $descriptions = array(); foreach( new ActiveRecordIterator( Db::i()->select( '*', 'core_reactions' ), 'IPS\Content\Reaction' ) AS $reaction ) { $options[ $reaction->id ] = $reaction->_icon->url; $descriptions[ $reaction->id ] = Member::loggedIn()->language()->addToStack('reaction_title_' . $reaction->id ); } $return['convertForumsPosts'] = array( 'rep_like' => array( 'field_class' => 'IPS\\Helpers\\Form\\Radio', 'field_default' => NULL, 'field_required' => TRUE, 'field_extra' => array( 'parse' => 'image', 'options' => $options, 'descriptions' => $descriptions, 'gridspan' => 2 ), 'field_hint' => NULL, 'field_validation' => NULL, ), ); } break; case 'convertAttachments': $return['convertAttachments'] = array( 'attach_location' => array( 'field_class' => 'IPS\\Helpers\\Form\\Text', 'field_default' => NULL, 'field_required' => TRUE, 'field_extra' => array(), 'field_hint' => Member::loggedIn()->language()->addToStack('convert_xf_attach_path'), 'field_validation' => function( $value ) { if ( !@is_dir( $value ) ) { throw new DomainException( 'path_invalid' ); } }, ) ); break; } return ( isset( $return[ $method ] ) ) ? $return[ $method ] : array(); } /** * Finish - Adds everything it needs to the queues and clears data store * * @return array Messages to display */ public function finish(): array { /* Content Rebuilds */ Task::queue( 'core', 'RebuildContainerCounts', array( 'class' => 'IPS\forums\Forum', 'count' => 0 ), 4, array( 'class' ) ); Task::queue( 'convert', 'RebuildContent', array( 'app' => $this->app->app_id, 'link' => 'forums_posts', 'class' => 'IPS\forums\Topic\Post' ), 2, array( 'app', 'link', 'class' ) ); Task::queue( 'core', 'RebuildItemCounts', array( 'class' => 'IPS\forums\Topic' ), 3, array( 'class' ) ); Task::queue( 'convert', 'RebuildFirstPostIds', array( 'app' => $this->app->app_id ), 2, array( 'app' ) ); Task::queue( 'convert', 'DeleteEmptyTopics', array( 'app' => $this->app->app_id ), 5, array( 'app' ) ); /* Caches */ Task::queue( 'convert', 'RebuildTagCache', array( 'app' => $this->app->app_id, 'link' => 'forums_topics', 'class' => 'IPS\forums\Topic' ), 3, array( 'app', 'link', 'class' ) ); return array( "f_forum_last_post_data", "f_rebuild_posts", "f_recounting_forums", "f_recounting_topics", "f_topic_tags_recount" ); } /** * Pre-process content for the Invision Community text parser * * @param string $post The post * @param string|null $className Content Classname passed by post-conversion rebuild * @param int|null $contentId Content ID passed by post-conversion rebuild * @return string The converted post */ public static function fixPostData( string $post, ?string $className=null, ?int $contentId=null ): string { return XenforoCore::fixPostData( $post, $className, $contentId ); } /** * Helper to fetch a xenforo phrase * * @param string $xfOneTitle XF1 Phrase title * @param string $xfTwoTitle XF2 Phrase Title * @return string|null */ protected function getPhrase( string $xfOneTitle, string $xfTwoTitle ) : ?string { try { $title = ( static::$isLegacy === FALSE OR is_null( static::$isLegacy ) ) ? $xfTwoTitle : $xfOneTitle; return $this->db->select( 'phrase_text', 'xf_phrase', array( "title=?", $title ) )->first(); } catch( UnderflowException $e ) { return NULL; } } /** * Convert forums * * @return void */ public function convertForumsForums() : void { $libraryClass = $this->getLibrary(); $libraryClass::setKey( 'node_id' ); foreach( $this->fetch( 'xf_node', 'node_id', array( $this->db->in( 'node_type_id', array( 'Category', 'Forum', 'LinkForum' ) ) ) ) AS $row ) { $data = array(); try { switch( $row['node_type_id'] ) { case 'Forum': $data = $this->db->select( '*', 'xf_forum', array( "node_id=?", $row['node_id'] ) )->first(); break; case 'LinkForum': $data = $this->db->select( '*', 'xf_link_forum', array( "node_id=?", $row['node_id'] ) )->first(); break; } } catch( UnderflowException $e ) {} $info = array( 'id' => $row['node_id'], 'name' => $row['title'], 'description' => $row['description'], 'topics' => ( isset( $data['discussion_count'] ) ) ? $data['discussion_count'] : 0, 'posts' => ( isset( $data['message_count'] ) ) ? $data['message_count'] : 0, 'last_post' => ( isset( $data['last_post_date'] ) ) ? $data['last_post_date'] : 0, 'last_poster_id' => ( isset( $data['last_post_user_id'] ) ) ? $data['last_post_user_id'] : 0, 'last_poster_name' => ( isset( $data['last_poster_name'] ) ) ? $data['last_post_username'] : '', 'parent_id' => ( $row['parent_node_id'] == 0 ) ? -1 : $row['parent_node_id'], 'position' => $row['display_order'], 'last_title' => ( isset( $data['last_thread_title'] ) ) ? $data['last_thread_title'] : '', 'allow_poll' => ( isset( $data['allow_poll'] ) ) ? $data['allow_poll'] : 0, 'inc_postcount' => ( isset( $data['count_messages'] ) ) ? $data['count_messages'] : 0, 'redirect_url' => ( isset( $data['link_url'] ) ) ? $data['link_url'] : NULL, 'redirect_on' => ( $row['node_type_id'] == 'LinkForum' ) ? 1 : 0, 'redirect_hits' => ( isset( $data['redirect_count'] ) ) ? $data['redirect_count'] : 0, 'sub_can_post' => ( isset( $data['allow_posting'] ) ) ? $data['allow_posting'] : 0, ); $libraryClass->convertForumsForum( $info ); /* Follows */ foreach( $this->db->select( '*', 'xf_forum_watch', array( "node_id=? AND notify_on=?", $row['node_id'], 'thread' ) ) AS $follow ) { $libraryClass->convertFollow( array( 'follow_app' => 'forums', 'follow_area' => 'forum', 'follow_rel_id' => $row['node_id'], 'follow_rel_id_type' => 'forums_forums', 'follow_member_id' => $follow['user_id'], 'follow_is_anon' => 0, 'follow_added' => time(), 'follow_notify_do' => 1, 'follow_notify_meta' => '', 'follow_notify_freq' => ( $follow['send_alert'] OR $follow['send_email'] ) ? 'immediate' : 'none', 'follow_notify_sent' => 0, 'follow_visible' => 1, ) ); } $libraryClass->setLastKeyValue( $row['node_id'] ); } } /** * Convert topics * * @return void */ public function convertForumsTopics() : void { $libraryClass = $this->getLibrary(); $libraryClass::setKey( 'thread_id' ); $data = iterator_to_array( $this->fetch( 'xf_thread', 'thread_id' ) ); $this->app->preCacheLinks( $data, [ 'forums_forums' => 'node_id', 'core_members' => [ 'user_id', 'last_post_user_id' ] ] ); foreach( $data AS $row ) { /* Poll */ $poll = NULL; if ( $row['discussion_type'] == 'poll' ) { try { $poll_data = $this->db->select( '*', 'xf_poll', array( "content_type=? AND content_id=?", 'thread', $row['thread_id'] ) )->first(); $choices = array(); $votes = array(); $index = 1; foreach( $this->db->select( '*', 'xf_poll_response', array( "poll_id=?", $poll_data['poll_id'] ) ) AS $choice ) { $choices[$index] = $choice['response']; $votes[$index] = $choice['response_vote_count']; $search[$index] = $choice['poll_response_id']; $index++; } $poll['poll_data'] = array( 'pid' => $poll_data['poll_id'], 'choices' => array( 1 => array( 'question' => $poll_data['question'], 'multi' => ( $poll_data['max_votes'] > 1 ) ? 1 : 0, 'choice' => $choices, 'votes' => $votes ) ), 'poll_question' => $poll_data['question'], 'start_date' => $row['post_date'], 'starter_id' => $row['user_id'], 'votes' => array_sum( $votes ), 'poll_view_voters' => $poll_data['public_votes'] ); $poll['vote_data'] = array(); $ourVotes = array(); foreach( $this->db->select( '*', 'xf_poll_vote', array( "poll_id=?", $poll_data['poll_id'] ) ) AS $vote ) { if ( !isset( $ourVotes[$vote['user_id']] ) ) { $ourVotes[$vote['user_id']] = array( 'votes' => array() ); } $ourVotes[$vote['user_id']]['votes'][] = array_search( $vote['poll_response_id'], $search ); $ourVotes[$vote['user_id']]['member_id'] = $vote['user_id']; } foreach( $ourVotes AS $member_id => $vote ) { $poll['vote_data'][$member_id] = array( 'member_id' => $vote['member_id'], 'member_choices' => array( 1 => $vote['votes'] ), ); } } catch( UnderflowException $e ) {} } /* Approval */ switch( $row['discussion_state'] ) { case 'visible': $approved = 1; break; case 'moderation': $approved = 0; break; case 'deleted': $approved = -1; break; } /* Moved To */ $moved_to = NULL; if ( $row['discussion_type'] == 'redirect' ) { try { $redirect = $this->db->select( '*', 'xf_thread_redirect', array( "thread_id=?", $row['thread_id'] ) )->first(); $key = explode( '-', $redirect['redirect_key'] ); $moved_to = array( $key[1], $key[2] ); } catch( UnderflowException $e ) {} } $info = array( 'tid' => $row['thread_id'], 'title' => $row['title'], 'forum_id' => $row['node_id'], 'state' => ( $row['discussion_open'] ) ? 'open' : 'closed', 'posts' => $row['reply_count'], 'starter_id' => $row['user_id'], 'start_date' => $row['post_date'], 'last_poster_id' => $row['last_post_user_id'], 'last_post' => $row['last_post_date'], 'starter_name' => $row['username'], 'last_poster_name' => $row['last_post_username'], 'poll_state' => $poll, 'views' => $row['view_count'], 'approved' => $approved ?? 0, 'pinned' => $row['sticky'], 'moved_to' => $moved_to, ); $libraryClass->convertForumsTopic( $info ); /* Follows */ foreach( $this->db->select( '*', 'xf_thread_watch', array( "thread_id=?", $row['thread_id'] ) ) AS $follow ) { $libraryClass->convertFollow( array( 'follow_app' => 'forums', 'follow_area' => 'topic', 'follow_rel_id' => $row['thread_id'], 'follow_rel_id_type' => 'forums_topics', 'follow_member_id' => $follow['user_id'], 'follow_is_anon' => 0, 'follow_added' => time(), 'follow_notify_do' => 1, 'follow_notify_meta' => '', 'follow_notify_freq' => ( $follow['email_subscribe'] ) ? 'immediate' : 'none', 'follow_notify_sent' => 0, 'follow_visible' => 1, ) ); } /* Tag Prefix */ if ( $row['prefix_id'] ) { $prefix = $this->getPhrase( "thread_prefix_{$row['prefix_id']}", "thread_prefix.{$row['prefix_id']}" ); if ( !is_null( $prefix ) ) { $libraryClass->convertTag( array( 'tag_meta_app' => 'forums', 'tag_meta_area' => 'forums', 'tag_meta_parent_id' => $row['node_id'], 'tag_meta_id' => $row['thread_id'], 'tag_text' => $prefix, 'tag_member_id' => $row['user_id'], 'tag_added' => $row['post_date'], 'tag_prefix' => 1, # key to this whole operation right here ) ); } } /* Other tags */ if ( $row['tags'] ) { $tags = static::unpack( $row['tags'] ); if ( count( $tags ) ) { foreach( $tags AS $key => $tag ) { $libraryClass->convertTag( array( 'tag_meta_app' => 'forums', 'tag_meta_area' => 'forums', 'tag_meta_parent_id' => $row['node_id'], 'tag_meta_id' => $row['thread_id'], 'tag_text' => $tag['tag'], 'tag_member_id' => $row['user_id'], 'tag_added' => $row['post_date'], 'tag_prefix' => 0 ) ); } } } $libraryClass->setLastKeyValue( $row['thread_id'] ); } } /** * Convert posts * * @return void */ public function convertForumsPosts() : void { $libraryClass = $this->getLibrary(); $libraryClass::setKey( 'post_id' ); $posts = iterator_to_array( $this->fetch( 'xf_post', 'post_id', null, 'xf_post.*, xf_ip.ip, xf_thread.discussion_state' ) ->join( 'xf_ip', 'xf_post.ip_id=xf_ip.ip_id' ) ->join( 'xf_thread', 'xf_post.thread_id=xf_thread.thread_id' ) ); $this->app->preCacheLinks( $posts, [ 'forums_topics' => 'thread_id', 'core_members' => 'user_id' ] ); foreach( $posts AS $row ) { /* Figure out queued stuff */ if ( $row['discussion_state'] == 'deleted' ) { $row['message_state'] = 'topic_hidden'; } switch( $row['message_state'] ) { case 'visible': $queued = 0; break; case 'moderated': $queued = 1; break; case 'deleted': $queued = -1; break; case 'topic_hidden': $queued = 2; break; } $editName = NULL; try { if( $row['last_edit_user_id'] ) { $editName = $this->db->select( 'username', 'xf_user', array( 'user_id=?', $row['last_edit_user_id'] ) )->first(); } } catch( UnderflowException $e ) {} $info = array( 'pid' => $row['post_id'], 'topic_id' => $row['thread_id'], 'post' => static::fixPostData( $row['message'] ), 'edit_time' => $row['last_edit_date'], 'edit_name' => $editName, 'append_edit' => $editName ? 1 : NULL, 'author_id' => $row['user_id'], 'author_name' => $row['username'], 'ip_address' => $row['ip'] ?? '127.0.0.1', 'post_date' => $row['post_date'], 'queued' => $queued ?? 0, ); $libraryClass->convertForumsPost( $info ); /* Reputation */ if ( !static::$useJson ) { $likes = unserialize( $row['like_users'] ); if ( is_array( $likes ) AND count( $likes ) ) { foreach( $likes AS $like ) { $libraryClass->convertReputation( array( 'app' => 'forums', 'type' => 'pid', 'type_id' => $row['post_id'], 'member_id' => $like['user_id'], 'member_received' => $row['user_id'], 'reaction' => $this->app->_session['more_info']['convertForumsPosts']['rep_like'], 'rep_date' => $row['post_date'] ) ); } } } else { $reputation = iterator_to_array( $this->db->select( '*', 'xf_reaction_content', array( "content_type=? AND content_id=?", 'post', $row['post_id'] ) ) ); $this->app->preCacheLinks( $reputation, [ 'core_members' => 'reaction_user_id' ] ); foreach( $reputation as $reaction ) { $libraryClass->convertReputation( array( 'id' => $reaction['reaction_content_id'], 'app' => 'forums', 'type' => 'pid', 'type_id' => $row['post_id'], 'member_id' => $reaction['reaction_user_id'], 'member_received' => $row['user_id'], 'reaction' => $reaction['reaction_id'], 'rep_date' => $reaction['reaction_date'] ) ); } } /* Warnings */ foreach( $this->db->select( '*', 'xf_warning', array( "content_type=? AND content_id=?", 'post', $row['post_id'] ) ) AS $warn ) { $warnId = $libraryClass->convertWarnLog( array( 'wl_id' => $warn['warning_id'], 'wl_member' => $warn['user_id'], 'wl_moderator' => $warn['warning_user_id'], 'wl_date' => $warn['warning_date'], 'wl_points' => $warn['points'], 'wl_note_member' => $warn['title'], 'wl_note_mods' => $warn['notes'], ) ); /* Add a member history record for this member */ $libraryClass->convertMemberHistory( array( 'log_id' => 'w' . $warn['warning_id'], 'log_member' => $warn['user_id'], 'log_by' => $warn['warning_user_id'], 'log_type' => 'warning', 'log_data' => array( 'wid' => $warnId ), 'log_date' => $warn['warning_date'] ) ); } /* Edit History */ $reason = NULL; $name = NULL; $newText = $info['post']; foreach( $this->db->select( '*', 'xf_edit_history', array( "content_type=? AND content_id=?", 'post', $row['post_id'] ) ) AS $edit ) { $editHistory = array( 'id' => $edit['edit_history_id'], 'class' => 'IPS\\forums\\Topic\\Post', 'comment_id' => $row['post_id'], 'member' => $edit['edit_user_id'], 'time' => $edit['edit_date'], 'old' => static::fixPostData( $edit['old_text'] ), 'new' => $newText ); $libraryClass->convertEditHistory( $editHistory ); $newText = $editHistory['old']; } $libraryClass->setLastKeyValue( $row['post_id'] ); } } /** * Convert attachments * * @return void */ public function convertAttachments() : void { $libraryClass = $this->getLibrary(); $libraryClass::setKey( 'xf_attachment.attachment_id' ); $it = $this->fetch( 'xf_attachment', 'xf_attachment.attachment_id', array( "content_type=?", 'post' ) )->join( 'xf_attachment_data', 'xf_attachment.data_id = xf_attachment_data.data_id' ); foreach( $it AS $row ) { try { $topic = $this->db->select( 'thread_id', 'xf_post', array( "post_id=?", $row['content_id'] ) )->first(); } catch( UnderflowException $e ) { $this->app->log( 'xf_attach_missing_topic_link', __METHOD__, App::LOG_WARNING, $row['attachment_id'] ); $libraryClass->setLastKeyValue( $row['attachment_id'] ); continue; } $map = array( 'id1' => $topic, 'id2' => $row['content_id'], ); $ext = explode( '.', $row['filename'] ); $ext = array_pop( $ext ); $info = array( 'attach_id' => $row['attachment_id'], 'attach_file' => $row['filename'], 'attach_date' => $row['upload_date'], 'attach_member_id' => $row['user_id'], 'attach_hits' => $row['view_count'], 'attach_ext' => $ext, 'attach_filesize' => $row['file_size'], ); $physical_name = $row['data_id'] . '-' . $row['file_hash'] . '.data'; $group = floor( $row['data_id'] / 1000 ); $path = rtrim( $this->app->_session['more_info']['convertAttachments']['attach_location'], '/' ) . '/' . $group . '/' . $physical_name; $attachId = $libraryClass->convertAttachment( $info, $map, $path ); /* Update Post if we can */ try { if ( $attachId !== FALSE ) { $pid = $this->app->getLink( $row['content_id'], 'forums_posts' ); $post = Db::i()->select( 'post', 'forums_posts', array( "pid=?", $pid ) )->first(); if ( preg_match( "/\[ATTACH([^\]]+?)?\]" . $row['attachment_id'] . "(\._xfImport)?\[\/ATTACH\]/i", $post ) ) { $post = preg_replace( "/\[ATTACH([^\]]+?)?\]" . $row['attachment_id'] . "(\._xfImport)?\[\/ATTACH\]/i", '[attachment=' . $attachId . ':name]', $post ); Db::i()->update( 'forums_posts', array( 'post' => $post ), array( "pid=?", $pid ) ); } } } catch( UnderflowException|OutOfRangeException $e ) {} $libraryClass->setLastKeyValue( $row['attachment_id'] ); } } /** * Check if we can redirect the legacy URLs from this software to the new locations * * @return Url|NULL */ public function checkRedirects(): ?Url { $url = Request::i()->url(); if( preg_match( '#/(forums|threads)/(.+?)\.([0-9]+)#i', $url->data[ Url::COMPONENT_PATH ], $matches ) ) { $oldId = (int) $matches[3]; switch( $matches[1] ) { case 'forums': $class = '\IPS\forums\Forum'; $types = array( 'forums', 'forums_forums' ); break; case 'threads': $class = '\IPS\forums\Topic'; $types = array( 'topics', 'forums_topics' ); break; } } elseif( preg_match( '#/posts/([0-9]+)/#i', $url->data[ Url::COMPONENT_PATH ], $matches ) ) { $class = '\IPS\forums\Topic\Post'; $types = array( 'posts', 'forums_posts' ); $oldId = $matches[1]; } if( isset( $class ) ) { try { try { $data = (string) $this->app->getLink( $oldId, $types ); } catch( OutOfRangeException $e ) { $data = (string) $this->app->getLink( $oldId, $types, FALSE, TRUE ); } $item = $class::load( $data ); if( $item instanceof Content ) { if( $item->canView() ) { return $item->url(); } } elseif( $item instanceof Model ) { if( $item->can( 'view' ) ) { return $item->url(); } } } catch( Exception $e ) { return NULL; } } return NULL; } }