Skip to content

Instantly share code, notes, and snippets.

@ntwb

ntwb/Snitz.php Secret

Created November 5, 2014 03:17
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ntwb/a1108513e7382272cfc8 to your computer and use it in GitHub Desktop.
Save ntwb/a1108513e7382272cfc8 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Snitz.php
<?php
/**
* Snitz converter base impoprter template for bbPress
*
* @since bbPress (rXXXX)
* @link Codex Docs http://codex.bbpress.org/import-forums/custom-import
*/
class Snitz extends BBP_Converter_Base {
/**
* Main Constructor
*
* @uses Snitz_Converter::setup_globals()
*/
function __construct() {
parent::__construct();
$this->setup_globals();
}
/**
* Sets up the field mappings
*/
public function setup_globals() {
/** Forum Section *****************************************************/
// Forum id (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'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' => 'FORUM_FORUM',
'from_fieldname' => 'CAT_ID',
'to_type' => 'forum',
'to_fieldname' => '_bbp_forum_parent_id'
);
// Forum topic count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_TOPICS',
'to_type' => 'forum',
'to_fieldname' => '_bbp_topic_count'
);
// Forum reply count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_COUNT',
'to_type' => 'forum',
'to_fieldname' => '_bbp_reply_count'
);
// Forum total topic count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_TOPICS',
'to_type' => 'forum',
'to_fieldname' => '_bbp_total_topic_count'
);
// Forum total reply count (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_COUNT',
'to_type' => 'forum',
'to_fieldname' => '_bbp_total_reply_count'
);
// Forum title.
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_SUBJECT',
'to_type' => 'forum',
'to_fieldname' => 'post_title'
);
// Forum slug (Clean name to avoid confilcts)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_SUBJECT',
'to_type' => 'forum',
'to_fieldname' => 'post_name',
'callback_method' => 'callback_slug'
);
// Forum description.
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_DESCRIPTION',
'to_type' => 'forum',
'to_fieldname' => 'post_content',
'callback_method' => 'callback_null'
);
// Forum display order (Starts from 1)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'FORUM_ORDER',
'to_type' => 'forum',
'to_fieldname' => 'menu_order'
);
// Forum status (Unlocked = 0 or Locked = 1, Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_FORUM',
'from_fieldname' => 'F_STATUS',
'to_type' => 'forum',
'to_fieldname' => '_bbp_status',
'callback_method' => 'callback_forum_status'
);
// 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')
);
/** Topic 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' => 'T_REPLIES',
'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' => 'T_REPLIES',
'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' => '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' => 'T_AUTHOR',
'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' => 'T_IP',
'to_type' => 'topic',
'to_fieldname' => '_bbp_author_ip'
);
// Topic content.
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_MESSAGE',
'to_type' => 'topic',
'to_fieldname' => 'post_content',
'callback_method' => 'callback_html'
);
// Topic title.
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_SUBJECT',
'to_type' => 'topic',
'to_fieldname' => 'post_title'
);
// Topic slug (Clean name to avoid conflicts)
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_SUBJECT',
'to_type' => 'topic',
'to_fieldname' => 'post_name',
'callback_method' => 'callback_slug'
);
// Topic status (Open or Closed)
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_STATUS',
'to_type' => 'topic',
'to_fieldname' => 'post_status',
'callback_method' => 'callback_topic_status'
);
// 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' => 'T_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' => 'T_DATE',
'to_type' => 'topic',
'to_fieldname' => 'post_date',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_DATE',
'to_type' => 'topic',
'to_fieldname' => 'post_date_gmt',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_LAST_POST',
'to_type' => 'topic',
'to_fieldname' => 'post_modified',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_LAST_POST',
'to_type' => 'topic',
'to_fieldname' => 'post_modified_gmt',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_TOPICS',
'from_fieldname' => 'T_LAST_POST',
'to_type' => 'topic',
'to_fieldname' => '_bbp_last_active_time',
'callback_method' => 'callback_datetime'
);
/** Tags Section ******************************************************/
/* Snitz does not support topic tags
// 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 *****************************************************/
// Reply id (Stored in postmeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'REPLY_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_REPLY',
'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_REPLY',
'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_REPLY',
'from_fieldname' => 'R_IP',
'to_type' => 'reply',
'to_fieldname' => '_bbp_author_ip'
);
// Reply author.
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'R_AUTHOR',
'to_type' => 'reply',
'to_fieldname' => 'post_author',
'callback_method' => 'callback_userid'
);
// Reply title and reply slugs
// Note: We don't actually want either a reply title or a reply slug as
// we want single replies to use their ID as the permalink.
// Reply content.
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'R_MESSAGE',
'to_type' => 'reply',
'to_fieldname' => 'post_content',
'callback_method' => 'callback_html'
);
/* Snizt doesnt use reply order
// Reply order.
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'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_REPLY',
'from_fieldname' => 'TOPIC_ID',
'to_type' => 'reply',
'to_fieldname' => 'post_parent',
'callback_method' => 'callback_topicid'
);
// Reply dates.
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'R_DATE',
'to_type' => 'reply',
'to_fieldname' => 'post_date',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'R_DATE',
'to_type' => 'reply',
'to_fieldname' => 'post_date_gmt',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'R_DATE',
'to_type' => 'reply',
'to_fieldname' => 'post_modified',
'callback_method' => 'callback_datetime'
);
$this->field_map[] = array(
'from_tablename' => 'FORUM_REPLY',
'from_fieldname' => 'R_DATE',
'to_type' => 'reply',
'to_fieldname' => 'post_modified_gmt',
'callback_method' => 'callback_datetime'
);
/** User Section ******************************************************/
// Store old User id (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_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' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_PASSWORD',
'to_type' => 'user',
'to_fieldname' => '_bbp_password',
'callback_method' => 'callback_savepass'
);
/* We are unable to convert Snitz members passwords
// Store old User Salt (This is only used for the SELECT row info for the above password save)
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'the_users_password_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' => 'Snitz'
);
*/
// User name.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_NAME',
'to_type' => 'user',
'to_fieldname' => 'user_login'
);
// User nice name.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_NAME',
'to_type' => 'user',
'to_fieldname' => 'user_nicename'
);
// User email.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_EMAIL',
'to_type' => 'user',
'to_fieldname' => 'user_email'
);
// User homepage.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_HOMEPAGE',
'to_type' => 'user',
'to_fieldname' => 'user_url'
);
/* Snitz doesn't use user registered
// User registered.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'the_users_registration_date',
'to_type' => 'user',
'to_fieldname' => 'user_registered',
'callback_method' => 'callback_datetime'
);
*/
/* Snitz doesn't use user status
// User status.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'the_users_status',
'to_type' => 'user',
'to_fieldname' => 'user_status'
);
*/
// User display name.
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_NAME',
'to_type' => 'user',
'to_fieldname' => 'display_name'
);
// User AIM (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_AIM',
'to_type' => 'user',
'to_fieldname' => 'aim'
);
// User Yahoo (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_YAHOO',
'to_type' => 'user',
'to_fieldname' => 'yim'
);
// User Signature (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'M_SIG',
'to_type' => 'user',
'to_fieldname' => '_bbp_snitz_user_sig'
);
/* Snitz doesnt use Jabber
// User Jabber (Stored in usermeta)
$this->field_map[] = array(
'from_tablename' => 'FORUM_MEMBERS',
'from_fieldname' => 'the_users_jabber',
'to_type' => 'user',
'to_fieldname' => 'jabber'
);
*/
}
/**
* This method allows us to indicates what is or is not converted for each
* converter.
*/
public function info() {
return '';
}
/**
* 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'] ) );
}
/**
* Translate the forum status from Snitz v3.x numeric's to WordPress's strings.
*
* @param int $status Snitz v3.x numeric forum status
* @return string WordPress safe
*/
public function callback_forum_status( $status = 1 ) {
switch ( $status ) {
case 0 :
$status = 'closed'; // Snitz forum status closed 'F_STATUS = 0'
break;
case 1 :
default :
$status = 'open'; // Snitz forum status open 'F_STATUS = 1'
break;
}
return $status;
}
/**
* Translate the topic status from Snitz v3.x numeric's to WordPress's strings.
*
* @param int $status Snitz v3.x numeric topic status
* @return string WordPress safe
*/
public function callback_topic_status( $status = 1 ) {
switch ( $status ) {
case 0 :
$status = 'closed'; // Snitz topic status closed 'T_STATUS = 0'
break;
case 1 :
default :
$status = 'publish'; // Snitz topic status open 'T_STATUS = 1'
break;
}
return $status;
}
/**
* Translate the topic sticky status type from Snitz 3.x numeric's to WordPress's strings.
*
* @param int $status Snitz 3.x numeric forum type
* @return string WordPress safe
*/
public function callback_sticky_status( $status = 0 ) {
switch ( $status ) {
case 1 :
$status = 'sticky'; // Snitz Sticky 'T_STICKY = 1'
break;
case 0 :
default :
$status = 'normal'; // Snitz normal topic 'T_STICKY = 0'
break;
}
return $status;
}
/**
* Verify the topic reply count.
*
* @param int $count Snitz 3.x topic and reply counts
* @return string WordPress safe
*/
public function callback_topic_reply_count( $count = 1 ) {
$count = absint( (int) $count );
return $count;
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment