Skip to content

Instantly share code, notes, and snippets.

@RickeyMessick
Last active August 29, 2015 14:17
Show Gist options
  • Save RickeyMessick/780b857970a4bb72a79f to your computer and use it in GitHub Desktop.
Save RickeyMessick/780b857970a4bb72a79f to your computer and use it in GitHub Desktop.
bbpress custom import Expression Engine
<?php
/**
* ExpressionEngine converter base impoprter template for bbPress
*
* @since bbPress (r4689)
* @link Codex Docs http://codex.bbpress.org/import-forums/custom-import
*/
class ExpressionEngine extends BBP_Converter_Base {
/**
* Main Constructor
*
* @uses Example_Converter::setup_globals()
*/
function __construct() {
parent::__construct();
$this->setup_globals();
}
/**
* Sets up the field mappings
*/
public function setup_globals() {
/** Forum Section *****************************************************/
// Setup table joins for the forum section at the base of this section
// Forum id (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_id',
'to_type' => 'forum',
'to_fieldname' => '_bbp_forum_id'
);
// Forum parent id (If no parent, then 0. Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_parent',
'to_type' => 'forum',
'to_fieldname' => '_bbp_forum_parent_id'
);
// Forum topic count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_total_topics',
'to_type' => 'forum',
'to_fieldname' => '_bbp_topic_count'
);
// Forum reply count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_total_posts',
'to_type' => 'forum',
'to_fieldname' => '_bbp_reply_count'
);
// Forum total topic count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_total_topics',
'to_type' => 'forum',
'to_fieldname' => '_bbp_total_topic_count'
);
// Forum total reply count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_total_posts',
'to_type' => 'forum',
'to_fieldname' => '_bbp_total_reply_count'
);
// Forum title.
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_name',
'to_type' => 'forum',
'to_fieldname' => 'post_title'
);
// Forum slug (Clean name to avoid confilcts)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_name',
'to_type' => 'forum',
'to_fieldname' => 'post_name',
'callback_method' => 'callback_slug'
);
// Forum description.
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_description',
'to_type' => 'forum',
'to_fieldname' => 'post_content',
'callback_method' => 'callback_html'
);
// Forum display order (Starts from 1)
$this->field_map[] = array(
'from_tablename' => 'forums',
'from_fieldname' => 'forum_order',
'to_type' => 'forum',
'to_fieldname' => 'menu_order'
);
// Forum dates.
$this->field_map[] = array(
'to_type' => 'forum',
'to_fieldname' => 'post_date',
'default' => date('Y-m-d H:i:s')
);
$this->field_map[] = array(
'to_type' => 'forum',
'to_fieldname' => 'post_date_gmt',
'default' => date('Y-m-d H:i:s')
);
$this->field_map[] = array(
'to_type' => 'forum',
'to_fieldname' => 'post_modified',
'default' => date('Y-m-d H:i:s')
);
$this->field_map[] = array(
'to_type' => 'forum',
'to_fieldname' => 'post_modified_gmt',
'default' => date('Y-m-d H:i:s')
);
// Setup the table joins for the forum section
//$this->field_map[] = array(
// 'from_tablename' => 'groups_table',
// 'from_fieldname' => 'forum_id',
// 'join_tablename' => 'forums',
// 'join_type' => 'INNER',
// 'join_expression' => 'USING groups_table.forum_id = forums.forum_id',
// 'from_expression' => 'WHERE forums.forum_id != 1',
// 'to_type' => 'forum'
//);
/** Topic Section *****************************************************/
// Setup table joins for the topic section at the base of this section
// Topic id (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'topic_id',
'to_type' => 'topic',
'to_fieldname' => '_bbp_topic_id'
);
// Topic reply count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'thread_total',
'to_type' => 'topic',
'to_fieldname' => '_bbp_reply_count',
'callback_method' => 'callback_topic_reply_count'
);
// Topic total reply count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'thread_total',
'to_type' => 'topic',
'to_fieldname' => '_bbp_total_reply_count',
'callback_method' => 'callback_topic_reply_count'
);
// Topic parent forum id (If no parent, then 0. Stored in postmeta)
/*
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'the_topic_parent_forum_id',
'to_type' => 'topic',
'to_fieldname' => '_bbp_forum_id',
'callback_method' => 'callback_forumid'
);
*/
// Topic author.
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'author_id',
'to_type' => 'topic',
'to_fieldname' => 'post_author',
'callback_method' => 'callback_userid'
);
// Topic author ip (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'ip_address',
'to_type' => 'topic',
'to_fieldname' => '_bbp_author_ip'
);
// Topic content.
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'body',
'to_type' => 'topic',
'to_fieldname' => 'post_content',
'callback_method' => 'callback_html'
);
// Topic title.
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'title',
'to_type' => 'topic',
'to_fieldname' => 'post_title'
);
// Topic slug (Clean name to avoid conflicts)
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'title',
'to_type' => 'topic',
'to_fieldname' => 'post_name',
'callback_method' => 'callback_slug'
);
// Topic parent forum id (If no parent, then 0)
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'forum_id',
'to_type' => 'topic',
'to_fieldname' => 'post_parent',
'callback_method' => 'callback_forumid'
);
// Sticky status (Stored in postmeta))
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'sticky',
'to_type' => 'topic',
'to_fieldname' => '_bbp_old_sticky_status',
'callback_method' => 'callback_sticky_status'
);
// Topic dates.
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'topic_date',
'to_type' => 'topic',
'to_fieldname' => 'post_date',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'topic_date',
'to_type' => 'topic',
'to_fieldname' => 'post_date_gmt',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'topic_edit_date',
'to_type' => 'topic',
'to_fieldname' => 'post_modified',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'topic_edit_date',
'to_type' => 'topic',
'to_fieldname' => 'post_modified_gmt',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'topic_edit_date',
'to_type' => 'topic',
'to_fieldname' => '_bbp_last_active_time',
'callback_method' => 'callback_datetime'
);
// Setup any table joins needed for the topic section
/*
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'the_topic_id',
'join_tablename' => 'forum_topics',
'join_type' => 'INNER',
'join_expression' => 'USING forum_posts.the_topic_id = forum_topics.the_topic_id',
'from_expression' => 'WHERE forums.the_topic_id = 0',
'to_type' => 'topic'
);
*/
/** Tags Section ******************************************************/
/*
// Setup table joins for the tag section at the base of this section
// Setup any table joins needed for the tags section
$this->field_map[] = array(
'from_tablename' => 'tag_table',
'from_fieldname' => 'the_topic_id',
'join_tablename' => 'tagcontent_table',
'join_type' => 'INNER',
'join_expression' => 'USING tagcontent_table.tag_id = tags_table.tag_id',
'from_expression' => 'WHERE tagcontent_table.tag_id = tag_table.tag_id',
'to_type' => 'tags'
);
// Topic id.
$this->field_map[] = array(
'from_tablename' => 'tagcontent_table',
'from_fieldname' => 'contentid',
'to_type' => 'tags',
'to_fieldname' => 'objectid',
'callback_method' => 'callback_topicid'
);
// Taxonomy ID.
$this->field_map[] = array(
'from_tablename' => 'tagcontent_table',
'from_fieldname' => 'tagid',
'to_type' => 'tags',
'to_fieldname' => 'taxonomy'
);
// Term text.
$this->field_map[] = array(
'from_tablename' => 'tag_table',
'from_fieldname' => 'tagtext',
'to_type' => 'tags',
'to_fieldname' => 'name'
);
// Term slug.
$this->field_map[] = array(
'from_tablename' => 'tag_table',
'from_fieldname' => 'tagslug',
'to_type' => 'tags',
'to_fieldname' => 'slug',
'callback_method' => 'callback_slug'
);
// Term description.
$this->field_map[] = array(
'from_tablename' => 'tag_table',
'from_fieldname' => 'tagdescription',
'to_type' => 'tags',
'to_fieldname' => 'description'
);
*/
/** Reply Section *****************************************************/
// Setup table joins for the reply section at the base of this section
// Reply id (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'post_id',
'to_type' => 'reply',
'to_fieldname' => '_bbp_post_id'
);
// Reply parent forum id (If no parent, then 0. Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'forum_id',
'to_type' => 'reply',
'to_fieldname' => '_bbp_forum_id',
'callback_method' => 'callback_topicid_to_forumid'
);
// Reply parent topic id (If no parent, then 0. Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'topic_id',
'to_type' => 'reply',
'to_fieldname' => '_bbp_topic_id',
'callback_method' => 'callback_topicid'
);
// Reply author ip (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'ip_address',
'to_type' => 'reply',
'to_fieldname' => '_bbp_author_ip'
);
// Reply author.
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'author_id',
'to_type' => 'reply',
'to_fieldname' => 'post_author',
'callback_method' => 'callback_userid'
);
// Reply title.
/*
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'the_reply_title',
'to_type' => 'reply',
'to_fieldname' => 'post_title'
);
// Reply slug (Clean name to avoid conflicts)
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'the_reply_slug',
'to_type' => 'reply',
'to_fieldname' => 'post_name',
'callback_method' => 'callback_slug'
);
*/
// Reply content.
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'body',
'to_type' => 'reply',
'to_fieldname' => 'post_content',
'callback_method' => 'callback_html'
);
/*
// Reply order.
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'the_reply_order',
'to_type' => 'reply',
'to_fieldname' => 'menu_order'
);
*/
// Reply parent topic id (If no parent, then 0)
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'topic_id',
'to_type' => 'reply',
'to_fieldname' => 'post_parent',
'callback_method' => 'callback_topicid'
);
// Reply dates.
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'post_date',
'to_type' => 'reply',
'to_fieldname' => 'post_date',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'post_date',
'to_type' => 'reply',
'to_fieldname' => 'post_date_gmt',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'post_edit_date',
'to_type' => 'reply',
'to_fieldname' => 'post_modified',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'forum_posts',
'from_fieldname' => 'post_edit_date',
'to_type' => 'reply',
'to_fieldname' => 'post_modified_gmt',
'callback_method' => 'callback_datetime'
);
/*
// Setup any table joins needed for the reply section
$this->field_map[] = array(
'from_tablename' => 'forum_topics',
'from_fieldname' => 'the_topic_id',
'join_tablename' => 'forum_posts',
'join_type' => 'INNER',
'join_expression' => 'USING forum_topics.the_topic_id = forum_posts.the_topic_id',
'from_expression' => 'WHERE forum_topics.first_post != 0',
'to_type' => 'reply'
);
*/
/** User Section ******************************************************/
// Setup table joins for the user section at the base of this section
// Store old User id (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'member_id',
'to_type' => 'user',
'to_fieldname' => '_bbp_user_id'
);
// Store old User password (Stored in usermeta serialized with salt)
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'password',
'to_type' => 'user',
'to_fieldname' => '_bbp_password',
'callback_method' => 'callback_savepass'
);
// Store old User Salt (This is only used for the SELECT row info for the above password save)
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'salt',
'to_type' => 'user',
'to_fieldname' => ''
);
// User password verify class (Stored in usermeta for verifying password)
$this->field_map[] = array(
'to_type' => 'user',
'to_fieldname' => '_bbp_class',
'default' => 'ExpressionEngine'
);
// User name.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'username',
'to_type' => 'user',
'to_fieldname' => 'user_login'
);
// User nice name.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'screen_name',
'to_type' => 'user',
'to_fieldname' => 'user_nicename'
);
// User email.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'email',
'to_type' => 'user',
'to_fieldname' => 'user_email'
);
// User homepage.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'url',
'to_type' => 'user',
'to_fieldname' => 'user_url'
);
// User registered.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'join_date',
'to_type' => 'user',
'to_fieldname' => 'user_registered',
'callback_method' => 'callback_datetime'
);
/*
// User status.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'the_users_status',
'to_type' => 'user',
'to_fieldname' => 'user_status'
);
*/
// User display name.
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'screen_name',
'to_type' => 'user',
'to_fieldname' => 'display_name'
);
/*
// User AIM (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'the_users_aim',
'to_type' => 'user',
'to_fieldname' => 'aim'
);
// User Yahoo (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'the_users_yahoo',
'to_type' => 'user',
'to_fieldname' => 'yim'
);
// User Jabber (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'members',
'from_fieldname' => 'the_users_jabber',
'to_type' => 'user',
'to_fieldname' => 'jabber'
);
// Setup any table joins needed for the user section
$this->field_map[] = array(
'from_tablename' => 'users_profile_table',
'from_fieldname' => 'the_users_id',
'join_tablename' => 'members',
'join_type' => 'INNER',
'join_expression' => 'USING users_profile_table.the_user_id = members.the_user_id',
'from_expression' => 'WHERE members.the_user_id != -1',
'to_type' => 'user'
);
*/
}
/**
* This method allows us to indicates what is or is not converted for each
* converter.
*/
public function info() {
return '';
}
/**
* Verify the topic reply count.
*
* @param int $count phpBB v3.x reply count
* @return string WordPress safe
*/
public function callback_topic_reply_count( $count = 1 ) {
$count = absint( (int) $count - 1 );
return $count;
}
/**
* This method is to save the salt and password together. That
* way when we authenticate it we can get it out of the database
* as one value. Array values are auto sanitized by WordPress.
*/
public function callback_savepass( $field, $row ) {
$pass_array = array( 'hash' => $field, 'salt' => $row['salt'] );
return $pass_array;
}
/**
* This method is to take the pass out of the database and compare
* to a pass the user has typed in.
*/
public function authenticate_pass( $password, $serialized_pass ) {
$pass_array = unserialize( $serialized_pass );
//return ( $pass_array['hash'] == md5( md5( $password ). $pass_array['salt'] ) );
// get length of hash to know which algo it uses
$h_byte_size = strlen($pass_array['hash']);
$hashed_pair = ee_hash_password($password, $pass_array['salt'], $h_byte_size);
//$hashed_pair = $this->hash_password($password, $m_salt, $h_byte_size);
//
//return ( $pass_array['hash'] == $hashed_pair['password'] );
return ( $pass_array['hash'] === $hashed_pair['password'] ? true : false );
}
/**
* This method is to take to create hash the way EE does it.
*
*/
public function ee_hash_password($password, $salt = FALSE, $h_byte_size = FALSE)
{
// Even for md5, collisions usually happen above 1024 bits, so
// we artifically limit their password to reasonable size.
if ( ! $password OR strlen($password) > 250)
{
return FALSE;
}
$hash_algos = array(
'sha512' => 128,
'sha256' => 64,
'sha1' => 40,
'md5' => 32
);
//$h_byte_size = strlen($db_hashedpassword);
// No hash function specified? Use the best one
// we have access to in this environment.
if ($h_byte_size === FALSE)
{
//reset($this->hash_algos);
//$h_byte_size = key($this->hash_algos);
$h_byte_size = "sha512";
}
//elseif ( ! isset($this->hash_algos[$h_byte_size]))
//{
// What are they feeding us? This can happen if
// they move servers and the new environment is
// less secure. Nothing we can do but fail. Hard.
//die('Fatal Error: No matching hash algorithm.');
//}
// No salt? (not even blank), we'll regenerate
if ($salt === FALSE)
{
$salt = '';
// The salt should never be displayed, so any
// visible ascii character is fair game.
for ($i = 0; $i < $h_byte_size; $i++)
{
$salt .= chr(mt_rand(33, 126));
}
}
elseif (strlen($salt) !== $h_byte_size)
{
// they passed us a salt that isn't the right length,
// this can happen if old code resets a new password
// ignore it
$salt = '';
}
return array(
'salt' => $salt,
'password' => hash(array_search($h_byte_size, $hash_algos), $salt.$password)
);
}
/**
* Translate the topic sticky status type from phpBB 3.x numeric's to WordPress's strings.
*
* @param int $status phpBB 3.x numeric forum type
* @return string WordPress safe
*/
public function callback_sticky_status( $status = 'n' ) {
switch ( $status ) {
case 'y' :
$status = 'sticky'; // phpBB Sticky 'topic_type = 1'
break;
case 'n' :
default :
$status = 'normal'; // phpBB normal topic 'topic_type = 0'
break;
}
return $status;
}
/**
* This callback processes any custom parser.php attributes and custom code with preg_replace
*/
protected function callback_html( $field ) {
// Strips custom phpBB 'magic_url' and 'bbcode_uid' first from $field before parsing $field to parser.php
$phpbb_uid = $field;
$phpbb_uid = html_entity_decode( $phpbb_uid );
// Replace [quote author="XXXXXXX" date="XXXXXXX"] with '<blockquote>'
$phpbb_uid = preg_replace( '/\[quote author="(.*?)" date="(.*?)"\]/', '<em>@$1 wrote:</em><blockquote>', $phpbb_uid );
// Replace '[/quote]' with '</blockquote>'
$phpbb_uid = preg_replace( '/\[\/quote\]/', '</blockquote>', $phpbb_uid );
// Now that phpBB's 'magic_url' and 'bbcode_uid' have been stripped put the cleaned HTML back in $field
$field = $phpbb_uid;
// Parse out any bbCodes in $field with the BBCode 'parser.php'
require_once( bbpress()->admin->admin_dir . 'parser.php' );
$bbcode = BBCode::getInstance();
$bbcode->enable_smileys = false;
$bbcode->smiley_regex = false;
return html_entity_decode( $bbcode->Parse( $field ) );
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment