Files
IPB/applications/convert/sources/Software/Forums/Vanilla.php
T
2025-12-19 16:57:00 -08:00

752 lines
21 KiB
PHP

<?php
/**
* @brief Converter Vanilla Class
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @package IPS Social Suite
* @subpackage convert
* @since 21 Jan 2015
*/
namespace IPS\convert\Software\Forums;
use DomainException;
use Exception;
use InvalidArgumentException;
use IPS\Content;
use IPS\convert\App;
use IPS\convert\Software;
use IPS\convert\Software\Core\Vanilla as VanillaCore;
use IPS\Db;
use IPS\Http\Url;
use IPS\Member;
use IPS\Patterns\ActiveRecordIterator;
use IPS\Request;
use IPS\Task;
use OutOfRangeException;
use UnderflowException;
use function count;
use function defined;
use function unserialize;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Vanilla Forums Converter
*/
class Vanilla extends Software
{
/**
* @brief Store the result of the check for reaction support
*/
protected static $_supportsReactions = 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, $needDB=TRUE )
{
$return = parent::__construct( $app, $needDB );
/* Check for reaction support - This is a Vanilla2 addon, so it may not be installed */
if ( $needDB )
{
static::$_supportsReactions = $this->db->checkForTable( 'Action' );
}
return $return;
}
/**
* Software Name
*
* @return string
*/
public static function softwareName(): string
{
/* Child classes must override this method */
return "Vanilla (3.x)";
}
/**
* Software Key
*
* @return string
*/
public static function softwareKey(): string
{
/* Child classes must override this method */
return "vanilla";
}
/**
* 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( 'vanilla' ) );
}
/**
* Content we can convert from this software.
*
* @return array|null
*/
public static function canConvert(): ?array
{
return array(
'convertForumsForums' => array(
'table' => 'Category',
'where' => NULL
),
'convertForumsTopics' => array(
'table' => 'Discussion',
'where' => NULL
),
'convertForumsPosts' => array(
'table' => 'Discussion',
'where' => NULL,
'extra_steps' => array( 'convertForumsPosts2' )
),
'convertForumsPosts2' => array(
'table' => 'Comment',
'where' => NULL
),
'convertAttachments' => array(
'table' => 'Media',
'where' => array( 'ForeignTable=? OR ForeignTable=?', 'discussion', 'comment' )
)
);
}
/**
* Allows software to add additional menu row options
*
* @return array
*/
public function extraMenuRows(): array
{
$rows = array();
$rows['convertForumsPosts2'] = array(
'step_title' => 'convert_forums_posts',
'step_method' => 'convertForumsPosts2',
'ips_rows' => Db::i()->select( 'COUNT(*)', 'forums_posts' ),
'source_rows' => array( 'table' => static::canConvert()['convertForumsPosts2']['table'], 'where' => static::canConvert()['convertForumsPosts2']['where'] ),
'per_cycle' => 200,
'dependencies' => array( 'convertForumsPosts' ),
'link_type' => 'forums_posts',
'requires_rebuild' => TRUE
);
return $rows;
}
/**
* Count Source Rows for a specific step
*
* @param string $table The table containing the rows to count.
* @param string|array|NULL $where WHERE clause to only count specific rows, or NULL to count all.
* @param bool $recache Skip cache and pull directly (updating cache)
* @return integer
* @throws \IPS\convert\Exception
*/
public function countRows( string $table, string|array|null $where=NULL, bool $recache=FALSE ): int
{
switch( $table )
{
case 'Comment':
try
{
$count = 0;
$count += $this->db->select( 'COUNT(*)', 'Discussion' )->first();
$count += $this->db->select( 'COUNT(*)', 'Comment' )->first();
return $count;
}
catch( Exception $e )
{
throw new \IPS\convert\Exception( sprintf( Member::loggedIn()->language()->get( 'could_not_count_rows' ), $table ) );
}
break;
default:
return parent::countRows( $table, $where, $recache );
break;
}
}
/**
* Can we convert passwords from this software.
*
* @return boolean
*/
public static function loginEnabled(): bool
{
return TRUE;
}
/**
* List of conversion methods that require additional information
*
* @return array
*/
public static function checkConf(): array
{
return array(
'convertForumsForums',
'convertAttachments',
'convertForumsPosts'
);
}
/**
* Get More Information
*
* @param string $method Conversion method
* @return array|null
*/
public function getMoreInfo( string $method ): ?array
{
$return = array();
switch( $method )
{
case 'convertForumsForums':
$return['convertForumsForums'] = array();
/* Find out where the photos live */
Member::loggedIn()->language()->words['attach_location_desc'] = Member::loggedIn()->language()->addToStack( 'attach_location' );
$return['convertForumsForums']['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_vanilla_photopath'),
);
break;
case 'convertForumsPosts':
/* Get our reactions to let the admin map them - this is a Vanilla2 addon so it may not be installed */
if( static::$_supportsReactions )
{
$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 ) . '<br>' . $reaction->_description;
}
$return['convertForumsPosts'] = array();
foreach( $this->db->select( '*', 'Action' ) as $reaction )
{
Member::loggedIn()->language()->words['reaction_' . $reaction['ActionID'] ] = $reaction['Name'];
Member::loggedIn()->language()->words['reaction_' . $reaction['ActionID'] . '_desc' ] = Member::loggedIn()->language()->addToStack('reaction_convert_help');
$return['convertForumsPosts']['reaction_' . $reaction['ActionID'] ] = array(
'field_class' => 'IPS\\Helpers\\Form\\Radio',
'field_default' => NULL,
'field_required' => TRUE,
'field_extra' => array( 'parse' => 'image', 'options' => $options, 'descriptions' => $descriptions ),
'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_vanilla_photopath'),
'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' ) );
/* Rebuild Leaderboard */
Task::queue( 'core', 'RebuildReputationLeaderboard', array(), 4 );
Db::i()->delete('core_reputation_leaderboard_history');
/* 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 The post
* @param string|null Content Classname passed by post-conversion rebuild
* @param int|null 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 VanillaCore::fixPostData( $post, $className, $contentId );
}
/**
* Convert attachments
*
* @return void
*/
public function convertAttachments()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'MediaID' );
foreach( $this->fetch( 'Media', 'MediaID', array( 'ForeignTable=? OR ForeignTable=?', 'discussion', 'comment' ) ) AS $row )
{
if( $row['ForeignTable'] == 'discussion' )
{
$map = array(
'id1' => 'fp-' . $row['ForeignID'],
'id2' => $row['ForeignID'],
);
}
else
{
try
{
$discussionId = $this->db->select( 'DiscussionID', 'Comment', array( 'CommentID=?', $row['ForeignID'] ) )->first();
}
catch( UnderflowException $ex )
{
$libraryClass->setLastKeyValue( $row['MediaID'] );
continue;
}
$map = array(
'id1' => $discussionId,
'id2' => $row['ForeignID'],
);
}
/* File extension */
$ext = explode( '.', $row['Path'] );
$ext = array_pop( $ext );
$info = array(
'attach_id' => $row['MediaID'],
'attach_file' => $row['Name'],
'attach_date' => VanillaCore::mysqlToDateTime( $row['DateInserted'] ),
'attach_member_id' => $row['InsertUserID'],
'attach_hits' => 0,
'attach_ext' => $ext,
'attach_filesize' => $row['Size'],
);
$uploadPath = VanillaCore::parseMediaLocation( $row['Path'], $this->app->_session['more_info']['convertAttachments']['attach_location'] );
$libraryClass->convertAttachment( $info, $map, $uploadPath );
$libraryClass->setLastKeyValue( $row['MediaID'] );
}
}
/**
* Convert forums
*
* @return void
*/
public function convertForumsForums()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'c.CategoryID' );
$uploadsPath = $this->app->_session['more_info']['convertForumsForums']['attach_location'];
$forums = $this->fetch( array( 'Category', 'c' ), 'CategoryID', array( 'c.CategoryID<>?', -1 ),
'c.*, lcu.UserID as LastCommentUserID, lcu.Name as LastCommentUserName, ld.Name as LastDiscussionName'
);
$forums->join( array( 'User', 'lcu' ), 'c.LastCommentID=lcu.UserID' );
$forums->join( array( 'Discussion', 'ld' ), 'c.LastDiscussionID=ld.DiscussionID' );
foreach( $forums AS $row )
{
$icon = ( isset( $row['Icon'] ) AND $row['Icon'] ) ? VanillaCore::parseMediaLocation( $row['Icon'], $uploadsPath ) : NULL;
$info = [
'id' => $row['CategoryID'],
'name' => $row['Name'],
'description' => $row['Description'],
'topics' => $row['CountDiscussions'],
'posts' => $row['CountComments'],
'last_post' => VanillaCore::mysqlToDateTime( $row['LastDateInserted'] ),
'last_poster_id' => $row['LastCommentID'],
'last_poster_name' => $row['LastCommentUserName'],
'parent_id' => ( (int) $row['ParentCategoryID'] > 0 ) ? $row['ParentCategoryID'] : NULL,
'position' => $row['Sort'],
'last_title' => $row['LastDiscussionName'],
'icon' => $icon,
'sub_can_post' => $row['AllowDiscussions'] ?: 0
];
$libraryClass->convertForumsForum( $info, NULL, $icon );
$libraryClass->setLastKeyValue( $row['CategoryID'] );
}
}
/**
* Convert topics
*
* @return void
*/
public function convertForumsTopics()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'd.DiscussionID' );
$discussions = $this->fetch( array( 'Discussion', 'd' ), 'DiscussionID', NULL,
'd.*, u.Name as UserName, lcu.UserID as LastCommentUserID, lcu.Name as LastCommentUserName'
);
$discussions->join( array( 'User', 'u' ), 'd.InsertUserID=u.UserID' );
$discussions->join( array( 'User', 'lcu' ), 'd.LastCommentUserID=lcu.UserID' );
$data = iterator_to_array( $discussions );
$this->app->preCacheLinks( $data, [ 'core_members' => 'InsertUserID', 'forums_forums' => 'CategoryID' ] );
foreach( $data AS $row )
{
/* Skip reports */
$attributes = [];
if( !empty( $row['attributes'] ) )
{
if( substr( $row['Attributes'], 0, 2 ) == 'a:' ) // Probably serialize
{
$attributes = unserialize( $row['Attributes'] );
}
else
{
$attributes = json_decode( $row['Attributes'], TRUE );
}
}
if( isset( $attributes['Report'] ) OR $row['Type'] == 'Report' )
{
$libraryClass->setLastKeyValue( $row['DiscussionID'] );
continue;
}
$row['DateLastComment'] = 0;
$row['LastCommentUserID'] = 0;
$row['LastCommentUserName'] = '';
/* If last post info is empty, fetch it */
if( $row['DateLastComment'] === NULL )
{
try
{
$data = $this->db->select( 'Comment.InsertUserID, Comment.DateInserted, User.Name', 'Comment', array( 'DiscussionID=?', $row['DiscussionID'] ), 'CommentID DESC', array( 0, 1 ) )
->join( 'User', 'Comment.InsertUserID=User.UserID' )
->first();
$row['DateLastComment'] = $data['DateInserted'];
$row['LastCommentUserID'] = $data['InsertUserId'];
$row['LastCommentUserName'] = $data['Name'];
}
catch( UnderflowException $e ) {}
}
$info = array(
'tid' => $row['DiscussionID'],
'title' => $row['Name'],
'forum_id' => $row['CategoryID'],
'state' => ( $row['Closed'] == 0 ) ? 'open' : 'closed',
'posts' => $row['CountComments'],
'starter_id' => $row['InsertUserID'],
'start_date' => VanillaCore::mysqlToDateTime( $row['DateInserted'] ),
'last_poster_id' => $row['LastCommentUserID'],
'last_post' => VanillaCore::mysqlToDateTime( $row['DateLastComment'] ),
'starter_name' => $row['UserName'],
'last_poster_name' => $row['LastCommentUserName'],
'views' => $row['CountViews'],
);
$libraryClass->convertForumsTopic( $info );
/* Tags */
if( !empty( $row['Tags'] ) )
{
$tags = explode( ',', $row['Tags'] );
if ( count( $tags ) )
{
foreach( $tags AS $tag )
{
$toConvert = explode( ' ', $tag );
foreach( $toConvert as $spacedTag )
{
$libraryClass->convertTag( array(
'tag_meta_app' => 'forums',
'tag_meta_area' => 'forums',
'tag_meta_parent_id' => $row['CategoryID'],
'tag_meta_id' => $row['DiscussionID'],
'tag_text' => $spacedTag,
'tag_member_id' => $row['InsertUserID'],
'tag_added' => $info['start_date'],
'tag_prefix' => 0,
) );
}
}
}
}
$libraryClass->setLastKeyValue( $row['DiscussionID'] );
}
}
/**
* Convert posts
*
* @return void
*/
public function convertForumsPosts()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'DiscussionID' );
$data = iterator_to_array( $this->fetch( 'Discussion', 'DiscussionID' ) );
$this->app->preCacheLinks( $data, [ 'core_members' => 'InsertUserID', 'forums_topics' => 'DiscussionID' ] );
foreach( $data AS $row )
{
/* Skip reports */
$attributes = [];
if( !empty( $row['attributes'] ) )
{
if( substr( $row['Attributes'], 0, 2 ) == 'a:' ) // Probably serialize
{
$attributes = unserialize( $row['Attributes'] );
}
else
{
$attributes = json_decode( $row['Attributes'], TRUE );
}
}
if( isset( $attributes['Report'] ) OR $row['Type'] == 'Report' )
{
$libraryClass->setLastKeyValue( $row['DiscussionID'] );
continue;
}
$editName = NULL;
if( $row['UpdateUserID'] )
{
try
{
$editName = $this->db->select( 'Name', 'User', array( 'UserID=?', $row['UpdateUserID'] ) )->first();
}
catch( UnderflowException $e ) {}
}
// Add Format Type (for later processing) if Markdown
if( $row['Format'] == 'Markdown' )
{
$row['Body'] = '<!--Markdown-->' . $row['Body'];
}
// First post
$info = array(
'pid' => 'fp-' . $row['DiscussionID'],
'topic_id' => $row['DiscussionID'],
'post' => $row['Body'],
'new_topic' => 1,
'edit_time' => ( $editName === NULL ) ? NULL : VanillaCore::mysqlToDateTime( $row['DateUpdated'] ),
'edit_name' => $editName,
'author_id' => $row['InsertUserID'],
'ip_address' => $row['InsertIPAddress'],
'post_date' => VanillaCore::mysqlToDateTime( $row['DateInserted'] ),
);
$libraryClass->convertForumsPost( $info );
$libraryClass->setLastKeyValue( $row['DiscussionID'] );
/* Reputation - Reactions are only supported if the YAGA addon was used. */
if( static::$_supportsReactions )
{
$reputation = iterator_to_array( $this->db->select( '*', 'Reaction', array( "ParentType=? AND ParentID=?", 'comment', $row['DiscussionID'] ) ) );
$this->app->preCacheLinks( $reputation, [ 'core_members' => [ 'InsertUserID', 'ParentAuthorID' ] ] );
foreach( $reputation AS $rep )
{
$reaction = $this->app->_session['more_info']['convertForumsPosts']['reaction_' . $rep['ActionID'] ];
$libraryClass->convertReputation( array(
'id' => $rep['ReactionID'],
'app' => 'forums',
'type' => 'pid',
'type_id' => 'fp-' . $row['DiscussionID'],
'member_id' => $rep['InsertUserID'],
'member_received' => $rep['ParentAuthorID'],
'rep_date' => VanillaCore::mysqlToDateTime( $row['DateInserted'] ),
'reaction' => $reaction
) );
}
}
}
}
/**
* Convert other posts
*
* @return void
*/
public function convertForumsPosts2()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'CommentID' );
$data = iterator_to_array( $this->fetch( 'Comment', 'CommentID' ) );
$this->app->preCacheLinks( $data, [ 'core_members' => 'InsertUserID', 'forums_topics' => 'DiscussionID' ] );
foreach( $data AS $row )
{
/* Check whether this is a report */
if( !empty( $row['Attributes'] ) )
{
if( substr( $row['Attributes'], 0, 2 ) == 'a:' ) // Probably serialize
{
$attributes = unserialize( $row['Attributes'] );
}
else
{
$attributes = json_decode( $row['Attributes'], TRUE );
}
if( !empty( $attributes['Type'] ) AND $attributes['Type'] == 'Report' )
{
$libraryClass->setLastKeyValue( $row['CommentID'] );
continue;
}
}
$editName = NULL;
if( $row['UpdateUserID'] )
{
try
{
$editName = $this->db->select( 'Name', 'User', array( 'UserID=?', $row['UpdateUserID'] ) )->first();
}
catch( UnderflowException $e ) {}
}
// Add Format Type (for later processing) if Markdown
if( $row['Format'] == 'Markdown' )
{
$row['Body'] = '<!--Markdown-->' . $row['Body'];
}
$info = [
'pid' => $row['CommentID'],
'topic_id' => $row['DiscussionID'],
'post' => $row['Body'],
'edit_time' => ( $editName === NULL ) ? NULL : VanillaCore::mysqlToDateTime( $row['DateUpdated'] ),
'edit_name' => $editName,
'author_id' => $row['InsertUserID'],
'ip_address' => $row['InsertIPAddress'],
'post_date' => VanillaCore::mysqlToDateTime( $row['DateInserted'] ),
];
$libraryClass->convertForumsPost( $info );
$libraryClass->setLastKeyValue( $row['CommentID'] );
}
}
/**
* Check if we can redirect the legacy URLs from this software to the new locations
*
* @return Url|NULL
* @note Forums and profiles don't use an ID in the URL. While we may be able to somehow cross reference this with our SEO slug, it wouldn't be reliable.
*/
public function checkRedirects(): ?Url
{
$url = Request::i()->url();
if( preg_match( '#/discussion/([0-9]+)/#i', $url->data[ Url::COMPONENT_PATH ], $matches ) )
{
$class = '\IPS\forums\Topic';
$types = array( 'topics', 'forums_topics' );
$oldId = (int) $matches[1];
}
elseif( preg_match( '#/discussion/comment/([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();
}
}
}
catch( Exception $e )
{
return NULL;
}
}
return NULL;
}
}