<?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 Converter
* @since 21 Jan 2015
*/
namespace IPS\convert\Software\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;
}
class _Vanilla extends \IPS\convert\Software
{
/**
* Software Name
*
* @return string
*/
public static function softwareName()
{
/* Child classes must override this method */
return "Vanilla 2 (2.2.x/2.3.x)";
}
/**
* Software Key
*
* @return string
*/
public static function softwareKey()
{
/* Child classes must override this method */
return "vanilla";
}
/**
* @brief The activity type ID for status updates
*/
protected static $activityStatusType = NULL;
/**
* Constructor
*
* @param \IPS\convert\App The application to reference for database and other information.
* @throws \InvalidArgumentException
*/
public function __construct( \IPS\convert\App $app, $needDB=TRUE )
{
$return = parent::__construct( $app, $needDB );
if ( $needDB )
{
/* What is the activity type ID for status updates? */
if ( static::$activityStatusType === NULL )
{
try
{
static::$activityStatusType = $this->db->select( 'ActivityTypeID', 'ActivityType',
array( 'Name=?', 'Status' ), NULL, 1
)->first();
}
catch ( \Exception $e ) {}
}
}
return $return;
}
/**
* Can we convert settings?
*
* @return boolean
*/
public static function canConvertSettings()
{
return TRUE;
}
/**
* Settings Map Listing
*
* @return array
*/
public function settingsMapList()
{
$settings = array(
'fluid' => array( 'title' => \IPS\Member::loggedIn()->language()->addToStack( 'use_fluid_view_convert' ), 'value' => true, 'our_key' => 'use_fluid_view_convert', 'our_title' => \IPS\Member::loggedIn()->language()->addToStack( 'use_fluid_view_convert' ) )
);
return $settings;
}
/**
* Convert one or more settings
*
* @param array $settings Settings to convert
* @return void
*/
public function convertSettings( $settings=array() )
{
if ( !isset( $settings['use_fluid_view_convert'] ) OR $settings['use_fluid_view_convert'] == FALSE )
{
return;
}
\IPS\Db::i()->update( 'core_sys_conf_settings', array( 'conf_value' => 'fluid' ), array( "conf_key=?", 'forums_default_view' ) );
}
/**
* Resolve the filesystem location of a file from a path stored in the database
* There are several different ways Vanilla may store these, including as remote URL's
*
* @param string $location File location retrieved from the database
* @param string $uploadsPath Configured uploads path
* @return \IPS\Http\Url|string|void
*/
public static function parseMediaLocation( $location, $uploadsPath )
{
$uploadsPath = str_replace( '\\', '/', $uploadsPath );
// URL
if ( preg_match( '`^https?://`', $location ) )
{
return \IPS\Http\Url::external( $location );
}
// Full filesystem path
elseif ( mb_strpos( $location, $uploadsPath ) === 0 )
{
return $location;
}
// Deprecated "plugin based" path
elseif ( preg_match( '`^~([^/]*)/(.*)$`', $location, $matches ) )
{
return $uploadsPath.'/'.$matches[2];
}
else
{
$parts = parse_url( $location );
if ( empty( $parts['scheme'] ) )
{
return $uploadsPath.'/'.$location;
}
else
{
if ( !isset( $parts['path'], $parts['host'] ) )
{
return;
}
// This is a url in the format type:://domain/path.
$result = array(
'name' => ltrim( $parts['path'], '/'),
'type' => $parts['scheme'],
'domain' => $parts['host']
);
// @TODO: This is deprecated, and I'm not sure what it was for.
#$format = "{$result['type']}://{$result['domain']}/%s";
#return sprintf( $format, $result['name'] );
}
}
}
/**
* Attempt to convert a MySQL datetime string into a unix timestamp
*
* @param string $date Date(Time) string
* @return int|null Timestamp on successful conversion, otherwise NULL
*/
public static function mysqlToDateTime( $date )
{
return \IPS\DateTime::ts( strtotime( $date ) ?: time() );
}
/**
* Content we can convert from this software.
*
* @return array
*/
public static function canConvert()
{
return array(
'convertGroups' => array(
'table' => 'Role',
'where' => NULL
),
'convertMembers' => array(
'table' => 'User',
'where' => NULL,
),
'convertStatuses' => array(
'table' => 'Activity',
'where' => array( 'ActivityTypeId=?', (int) static::$activityStatusType )
),
'convertPrivateMessages' => array(
'table' => 'Conversation',
'where' => NULL
),
'convertPrivateMessageReplies' => array(
'table' => 'ConversationMessage',
'where' => NULL,
)
);
}
/**
* Can we convert passwords from this software.
*
* @return boolean
*/
public static function loginEnabled()
{
return TRUE;
}
/**
* Returns a block of text, or a language string, that explains what the admin must do to start this conversion
*
* @return string
*/
public static function getPreConversionInformation()
{
return 'convert_vanilla_preconvert';
}
/**
* List of conversion methods that require additional information
*
* @return array
*/
public static function checkConf()
{
return array(
'convertGroups',
'convertMembers'
);
}
/**
* Get More Information
*
* @param string $method Conversion method
* @return array
*/
public function getMoreInfo( $method )
{
switch( $method )
{
case 'convertGroups':
$return['convertGroups'] = array();
$options = array();
$options['none'] = 'None';
foreach( new \IPS\Patterns\ActiveRecordIterator( \IPS\Db::i()->select( '*', 'core_groups' ), 'IPS\Member\Group' ) AS $group )
{
$options[ $group->g_id ] = $group->name;
}
foreach( $this->db->select( '*', 'Role' ) AS $group )
{
\IPS\Member::loggedIn()->language()->words["map_group_{$group['RoleID']}"] = $group['Name'];
\IPS\Member::loggedIn()->language()->words["map_group_{$group['RoleID']}_desc"] = \IPS\Member::loggedIn()->language()->addToStack( 'map_group_desc' );
$return['convertGroups']["map_group_{$group['RoleID']}"] = array(
'field_class' => 'IPS\\Helpers\\Form\\Select',
'field_default' => NULL,
'field_required' => FALSE,
'field_extra' => array( 'options' => $options ),
'field_hint' => NULL,
);
}
break;
case 'convertMembers':
$return['convertMembers'] = array();
/* Find out where the photos live */
\IPS\Member::loggedIn()->language()->words['attach_location_desc'] = \IPS\Member::loggedIn()->language()->addToStack( 'attach_location' );
$return['convertMembers']['attach_location'] = array(
'field_class' => 'IPS\\Helpers\\Form\\Text',
'field_default' => NULL,
'field_required' => TRUE,
'field_extra' => array(),
'field_hint' => \IPS\Member::loggedIn()->language()->addToStack('convert_vanilla_photopath'),
);
break;
}
return ( isset( $return[ $method ] ) ) ? $return[ $method ] : array();
}
/**
* Finish - Adds everything it needs to the queues and clears data store
*
* @return string Message to display
*/
public function finish()
{
/* Search Index Rebuild */
\IPS\Content\Search\Index::i()->rebuild();
/* Clear Cache and Store */
\IPS\Data\Store::i()->clearAll();
\IPS\Data\Cache::i()->clearAll();
/* Content Rebuilds */
\IPS\Task::queue( 'convert', 'RebuildContent', array( 'app' => $this->app->app_id, 'link' => 'core_member_status_updates', 'class' => 'IPS\core\Statuses\Status' ), 2, array( 'app', 'link', 'class' ) );
/* Non-Content Rebuilds */
\IPS\Task::queue( 'convert', 'RebuildNonContent', array( 'app' => $this->app->app_id, 'link' => 'core_message_posts', 'extension' => 'core_Messaging' ), 2, array( 'app', 'link', 'extension' ) );
\IPS\Task::queue( 'convert', 'RebuildNonContent', array( 'app' => $this->app->app_id, 'link' => 'core_members', 'extension' => 'core_Signatures' ), 2, array( 'app', 'link', 'extension' ) );
/* Content Counts */
\IPS\Task::queue( 'core', 'RecountMemberContent', array( 'app' => $this->app->app_id ), 4, array( 'app' ) );
/* First Post Data */
\IPS\Task::queue( 'convert', 'RebuildConversationFirstIds', array( 'app' => $this->app->app_id ), 2, array( 'app' ) );
/* Attachments */
\IPS\Task::queue( 'core', 'RebuildAttachmentThumbnails', array( 'app' => $this->app->app_id ), 1, array( 'app' ) );
return array( "f_search_index_rebuild", "f_clear_caches", "f_rebuild_pms", "f_signatures_rebuild", "f_rebuild_attachments" );
}
/**
* Fix post data
*
* @param string raw post data
* @return string parsed post data
*/
public static function fixPostData( $post )
{
return $post;
}
/**
* Convert groups
*
* @return void
*/
public function convertGroups()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'r.RoleID' );
/* Ready Roles */
$roles = $this->fetch( array( 'Role', 'r' ), 'RoleID' );
//$roles->join( array( 'Permission', 'p' ), 'r.RoleID=p.PermissionID' );
/* Run conversions */
foreach ( $roles as $row )
{
$info = array(
'g_id' => $row['RoleID'],
'g_name' => $row['Name'],
);
$merge = ( $this->app->_session['more_info']['convertGroups']["map_group_{$row['RoleID']}"] != 'none' )
? $this->app->_session['more_info']['convertGroups']["map_group_{$row['RoleID']}"]
: NULL;
$libraryClass->convertGroup( $info, $merge );
$libraryClass->setLastKeyValue( $row['RoleID'] );
}
/* Now check for group promotions */
if( count( $libraryClass->groupPromotions ) )
{
foreach( $libraryClass->groupPromotions as $groupPromotion )
{
$libraryClass->convertGroupPromotion( $groupPromotion );
}
}
}
/**
* Convert members
*
* @return void
*/
public function convertMembers()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'u.UserID' );
$uploadsPath = $this->app->_session['more_info']['convertMembers']['attach_location'];
$users = $this->fetch( array( 'User', 'u' ), 'u.UserID', array( "u.Deleted<>?", 1 ) );
$users->join( array( 'UserRole', 'ur' ), 'ur.UserID=u.UserID' );
foreach( $users AS $row )
{
/* Work out birthday */
$bdayDay = NULL;
$bdayMonth = NULL;
$bdayYear = NULL;
$dateOfBirth = !empty( $row['DateOfBirth'] ) ? @\IPS\DateTime::ts( strtotime( $row['DateOfBirth'] ) ) : NULL;
if ( $dateOfBirth instanceof \IPS\DateTime )
{
$bdayYear = $dateOfBirth->format( 'Y' );
$bdayMonth = $dateOfBirth->format( 'n' );
$bdayDay = $dateOfBirth->format( 'j' );
}
/* Work out banned stuff */
$tempBan = ( $row['Banned'] == 1 ) ? -1 : 0;
/* Array of basic data */
$info = array(
'member_id' => $row['UserID'],
'email' => $row['Email'],
'name' => $row['Name'],
'password' => $row['Password'],
'member_group_id' => $row['RoleID'] ?: NULL,
'joined' => static::mysqlToDateTime( $row['DateInserted'] ),
'ip_address' => $row['InsertIPAddress'],
'temp_ban' => $tempBan,
'bday_day' => $bdayDay,
'bday_month' => $bdayMonth,
'bday_year' => $bdayYear,
'msg_count_new' => (int) $row['CountUnreadDiscussions'],
'msg_count_total' => (int) $row['CountDiscussions'],
'last_visit' => static::mysqlToDateTime( $row['DateLastActive'] ),
'timezone' => !empty( $row['HourOffset'] )
? (int) $row['HourOffset']
: new \DateTimeZone(
'UTC'
),
'member_posts' => (int) $row['CountComments'],
);
/* Profile Photos */
$filepath = NULL;
$filename = NULL;
if ( !empty( $row['Photo'] ) AND ( $location = static::parseMediaLocation( $row['Photo'], $uploadsPath ) ) )
{
if ( $location instanceof \IPS\Http\Url )
{
/* The library uses file_get_contents() so we can just pop the file name off and pass the URL directly */
$filebits = explode( '/', (string) $location );
$filename = array_pop( $filebits );
$filepath = implode( '/', $filebits );
}
else
{
// Full-sized profile photos start with "p", small profile photos start with "n"
$filename = 'p' . pathinfo( $location, \PATHINFO_BASENAME );
$filepath = pathinfo( $location, \PATHINFO_DIRNAME );
}
}
/* Finally */
$libraryClass->convertMember( $info, NULL, $filename, $filepath );
$libraryClass->setLastKeyValue( $row['UserID'] );
}
}
/**
* Convert statuses
*
* @return void
*/
public function convertStatuses()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'ActivityID' );
$statuses = $this->fetch( 'Activity', 'ActivityID', array( 'ActivityTypeID=?', static::$activityStatusType ) );
/* Run conversions */
foreach ( $statuses as $row )
{
$info = array(
'status_id' => $row['ActivityID'],
'status_member_id' => $row['ActivityUserID'],
'status_date' => \IPS\DateTime::ts( strtotime( $row['DateInserted'] ) ?: time() ),
'status_content' => $row['Story'],
//'status_replies' => $this->countRows( 'ActivityComment', array( 'ActivityID=?', $row['ActivityID'] ) ),
'status_author_id' => $row['ActivityUserID'],
'status_author_ip' => $row['InsertIPAddress'],
);
$libraryClass->convertStatus( $info );
$libraryClass->setLastKeyValue( $row['ActivityID'] );
}
}
/**
* Convert PMs
*
* @return void
*/
public function convertPrivateMessages()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'ConversationID' );
$messages = $this->fetch( 'Conversation', 'ConversationID' );
/* Run conversions */
foreach ( $messages as $row )
{
/* Message topic information */
//$firstMessageId = $row['FirstMessageID'];
$topicInfo = array(
'mt_id' => $row['ConversationID'],
'mt_title' => $row['Subject'] ?: NULL,
'mt_date' => static::mysqlToDateTime( $row['DateInserted'] ),
'mt_starter_id' => $row['InsertUserID'],
'mt_last_post_time' => static::mysqlToDateTime( $row['DateUpdated'] ),
'mt_to_count' => ( isset( $row['CountParticipants'] ) ) ? $row['CountParticipants'] : count( \unserialize( $row['Contributors'] ) ),
'mt_replies' => $row['CountMessages'],
);
/* Message maps */
$maps = array();
$rows = $this->fetch( 'UserConversation', 'UserID', array( 'ConversationID=?', $row['ConversationID'] ) );
foreach ( $rows as $row )
{
$maps[ $row['UserID'] ] = array(
'map_user_id' => $row['UserID'],
'map_read_time' => static::mysqlToDateTime( $row['DateLastViewed'] ),
//'map_folder_id' => TODO: Create a Bookmarks folder for "Bookmarked" conversations?
'map_user_active' => (int) ( $row['Deleted'] != '0' ),
'map_last_topic_reply' => static::mysqlToDateTime( $row['DateConversationUpdated'] )
);
}
$libraryClass->convertPrivateMessage( $topicInfo, $maps );
$libraryClass->setLastKeyValue( $row['ConversationID'] );
}
}
/**
* Convert PM replies
*
* @return void
*/
public function convertPrivateMessageReplies()
{
$libraryClass = $this->getLibrary();
$libraryClass::setKey( 'MessageID' );
foreach( $this->fetch( 'ConversationMessage', 'MessageID' ) AS $row )
{
$libraryClass->convertPrivateMessageReply( array(
'msg_id' => $row['MessageID'],
'msg_topic_id' => $row['ConversationID'],
'msg_date' => static::mysqlToDateTime( $row['DateInserted'] ),
'msg_post' => $row['Body'],
'msg_author_id' => $row['InsertUserID'],
'msg_ip_address' => $row['InsertIPAddress']
) );
$libraryClass->setLastKeyValue( $row['MessageID'] );
}
}
/**
* Process a login
*
* @param \IPS\Member $member The member
* @param string $password Password from form
* @return bool
*/
public function login( $member, $password )
{
/* Vanilla 2.2 */
if( preg_match( '/^\$2[ay]\$(0[4-9]|[1-2][0-9]|3[0-1])\$[a-zA-Z0-9.\/]{53}/', $member->conv_password ) OR mb_substr( $member->conv_password, 0, 3 ) == '$P$' )
{
require_once \IPS\ROOT_PATH . "/applications/convert/sources/Login/PasswordHash.php";
$ph = new \PasswordHash( 8, TRUE );
return $ph->CheckPassword( $password, $member->conv_password ) ? TRUE : FALSE;
}
if ( \IPS\Login::compareHashes( $member->conv_password, md5( md5( str_replace( ''', "'", html_entity_decode( $password ) ) ) . $member->misc ) ) )
{
return TRUE;
}
else
{
return FALSE;
}
}
}