SimplePress5
Implementation of SimplePress v5 converter.
Description
Source
File: bp-forums/admin/converters/SimplePress5.php
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 | class SimplePress5 extends BBP_Converter_Base { /** * Main Constructor * * @uses SimplePress5::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' => 'sfforums' , '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' => 'sfforums' , 'from_fieldname' => 'parent' , 'to_type' => 'forum' , 'to_fieldname' => '_bbp_forum_parent_id' ); // Forum topic count (Stored in postmeta) $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'topic_count' , 'to_type' => 'forum' , 'to_fieldname' => '_bbp_topic_count' ); // Forum reply count (Stored in postmeta) $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'post_count' , 'to_type' => 'forum' , 'to_fieldname' => '_bbp_reply_count' ); // Forum total topic count (Stored in postmeta) $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'topic_count' , 'to_type' => 'forum' , 'to_fieldname' => '_bbp_total_topic_count' ); // Forum total reply count (Stored in postmeta) $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'post_count' , 'to_type' => 'forum' , 'to_fieldname' => '_bbp_total_reply_count' ); // Forum title. $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'forum_name' , 'to_type' => 'forum' , 'to_fieldname' => 'post_title' ); // Forum slug (Clean name to avoid conflicts) $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'forum_name' , 'to_type' => 'forum' , 'to_fieldname' => 'post_name' , 'callback_method' => 'callback_slug' ); // Forum description. $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'forum_desc' , 'to_type' => 'forum' , 'to_fieldname' => 'post_content' , 'callback_method' => 'callback_null' ); // Forum display order (Starts from 1) $this ->field_map[] = array ( 'from_tablename' => 'sfforums' , 'from_fieldname' => 'forum_seq' , 'to_type' => 'forum' , 'to_fieldname' => 'menu_order' ); // Forum dates. $this ->field_map[] = array ( 'to_type' => 'forums' , 'to_fieldname' => 'post_date' , 'default' => date ( 'Y-m-d H:i:s' ) ); $this ->field_map[] = array ( 'to_type' => 'forums' , 'to_fieldname' => 'post_date_gmt' , 'default' => date ( 'Y-m-d H:i:s' ) ); $this ->field_map[] = array ( 'to_type' => 'forums' , 'to_fieldname' => 'post_modified' , 'default' => date ( 'Y-m-d H:i:s' ) ); $this ->field_map[] = array ( 'to_type' => 'forums' , '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' => 'sftopics' , 'from_fieldname' => 'topic_id' , 'to_type' => 'topic' , 'to_fieldname' => '_bbp_topic_id' ); // Topic reply count (Stored in postmeta) $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'post_count' , 'to_type' => 'topic' , 'to_fieldname' => '_bbp_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' => 'sftopics' , 'from_fieldname' => 'forum_id' , 'to_type' => 'topic' , 'to_fieldname' => '_bbp_forum_id' , 'callback_method' => 'callback_forumid' ); // Topic author. $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'user_id' , 'to_type' => 'topic' , 'to_fieldname' => 'post_author' , 'callback_method' => 'callback_userid' ); // Topic content. // Note: We join the sfposts table because sftopics do not have content. $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'post_content' , 'join_tablename' => 'sftopics' , 'join_type' => 'INNER' , 'join_expression' => 'USING (topic_id) WHERE sfposts.post_index = 1' , 'to_type' => 'topic' , 'to_fieldname' => 'post_content' , 'callback_method' => 'callback_html' ); // Topic title. $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_name' , 'to_type' => 'topic' , 'to_fieldname' => 'post_title' ); // Topic slug (Clean name to avoid conflicts) $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_name' , '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' => 'sftopics' , 'from_fieldname' => 'forum_id' , 'to_type' => 'topic' , 'to_fieldname' => 'post_parent' , 'callback_method' => 'callback_forumid' ); // Topic status (Open or Closed) $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_status' , 'to_type' => 'topic' , 'to_fieldname' => 'post_status' , 'callback_method' => 'callback_status' ); // Sticky status (Stored in postmeta)) $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_pinned' , 'to_type' => 'topic' , 'to_fieldname' => '_bbp_old_sticky_status' , 'callback_method' => 'callback_sticky_status' ); // Topic dates. $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_date' , 'to_type' => 'topic' , 'to_fieldname' => 'post_date' ); $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_date' , 'to_type' => 'topic' , 'to_fieldname' => 'post_date_gmt' ); $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_date' , 'to_type' => 'topic' , 'to_fieldname' => 'post_modified' ); $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_date' , 'to_type' => 'topic' , 'to_fieldname' => 'post_modified_gmt' ); $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_date' , 'to_type' => 'topic' , 'to_fieldname' => '_bbp_last_active_time' ); /** Tags Section ******************************************************/ /** * SimplePress Forums do not support topic tags without paid extensions */ /** Reply Section *****************************************************/ // Reply id (Stored in postmeta) $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , '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' => 'sfposts' , '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' => 'sfposts' , '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' => 'sfposts' , 'from_fieldname' => 'poster_ip' , 'to_type' => 'reply' , 'to_fieldname' => '_bbp_author_ip' ); // Reply author. $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'user_id' , 'to_type' => 'reply' , 'to_fieldname' => 'post_author' , 'callback_method' => 'callback_userid' ); // Reply title. // Note: We join the sftopics table because sfposts table does not include topic title. $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_name' , 'join_tablename' => 'sfposts' , 'join_type' => 'LEFT' , 'join_expression' => 'USING (topic_id) WHERE sfposts.post_index != 1' , 'to_type' => 'reply' , 'to_fieldname' => 'post_title' , 'callback_method' => 'callback_reply_title' ); // Reply slug (Clean name to avoid conflicts) // Note: We join the sftopics table because sfposts table does not include topic title. $this ->field_map[] = array ( 'from_tablename' => 'sftopics' , 'from_fieldname' => 'topic_name' , 'join_tablename' => 'sfposts' , 'join_type' => 'LEFT' , 'join_expression' => 'USING (topic_id) WHERE sfposts.post_index != 1' , 'to_type' => 'reply' , 'to_fieldname' => 'post_name' , 'callback_method' => 'callback_slug' ); // Reply content. $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'post_content' , 'to_type' => 'reply' , 'to_fieldname' => 'post_content' , 'callback_method' => 'callback_html' ); // Reply parent topic id (If no parent, then 0) $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'topic_id' , 'to_type' => 'reply' , 'to_fieldname' => 'post_parent' , 'callback_method' => 'callback_topicid' ); // Reply dates. $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'post_date' , 'to_type' => 'reply' , 'to_fieldname' => 'post_date' ); $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'post_date' , 'to_type' => 'reply' , 'to_fieldname' => 'post_date_gmt' ); $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'post_date' , 'to_type' => 'reply' , 'to_fieldname' => 'post_modified' ); $this ->field_map[] = array ( 'from_tablename' => 'sfposts' , 'from_fieldname' => 'post_date' , 'to_type' => 'reply' , 'to_fieldname' => 'post_modified_gmt' ); /** User Section ******************************************************/ // Store old User id (Stored in usermeta) $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'ID' , 'to_type' => 'user' , 'to_fieldname' => '_bbp_user_id' ); // Store old User password (Stored in usermeta) $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_pass' , 'to_type' => 'user' , 'to_fieldname' => '_bbp_password' ); // User name. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_login' , 'to_type' => 'user' , 'to_fieldname' => 'user_login' ); // User nice name. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_nicename' , 'to_type' => 'user' , 'to_fieldname' => 'user_nicename' ); // User email. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_email' , 'to_type' => 'user' , 'to_fieldname' => 'user_email' ); // User homepage. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_url' , 'to_type' => 'user' , 'to_fieldname' => 'user_url' ); // User registered. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_registered' , 'to_type' => 'user' , 'to_fieldname' => 'user_registered' ); // User status. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'user_status' , 'to_type' => 'user' , 'to_fieldname' => 'user_status' ); // User display name. $this ->field_map[] = array ( 'from_tablename' => 'users' , 'from_fieldname' => 'display_name' , 'to_type' => 'user' , 'to_fieldname' => 'display_name' ); } /** * 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 ) { return false; } /** * 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 ) { return false; } /** * Translate the post status from Simple:Press v5.x numeric's to WordPress's strings. * * @param int $status Simple:Press numeric status * @return string WordPress safe */ public function callback_status( $status = 0 ) { switch ( $status ) { case 1 : $status = 'closed' ; break ; case 0 : default : $status = 'publish' ; break ; } return $status ; } /** * Translate the topic sticky status type from Simple:Press v5.x numeric's to WordPress's strings. * * @param int $status Simple:Press v5.x numeric forum type * @return string WordPress safe */ public function callback_sticky_status( $status = 0 ) { switch ( $status ) { case 1 : $status = 'sticky' ; // Simple:Press Sticky 'topic_sticky = 1' break ; case 0 : default : $status = 'normal' ; // Simple:Press Normal Topic 'topic_sticky = 0' break ; } return $status ; } /** * Verify the topic reply count. * * @param int $count Simple:Press v5.x reply count * @return string WordPress safe */ public function callback_topic_reply_count( $count = 1 ) { $count = absint( (int) $count - 1 ); return $count ; } /** * Set the reply title * * @param string $title Simple:Press v5.x topic title of this reply * @return string Prefixed topic title, or empty string */ public function callback_reply_title( $title = '' ) { $title = ! empty ( $title ) ? __( 'Re: ' , 'buddyboss' ) . html_entity_decode( $title ) : '' ; return $title ; } /** * This callback processes any custom parser.php attributes and custom HTML code with preg_replace */ protected function callback_html( $field ) { // Strip any custom HTML not supported by parser.php first from $field before parsing $field to parser.php $simplepress_markup = $field ; $simplepress_markup = html_entity_decode( $simplepress_markup ); // Replace any SimplePress smilies from path '/sp-resources/forum-smileys/sf-smily.gif' with the equivelant WordPress Smilie $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-confused\.gif(.*?)\" \/>/' , ':?' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-cool\.gif(.*?)\" \/>/' , ':cool:' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-cry\.gif(.*?)\" \/>/' , ':cry:' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-embarassed\.gif(.*?)\" \/>/' , ':oops:' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-frown\.gif(.*?)\" \/>/' , ':(' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-kiss\.gif(.*?)\" \/>/' , ':P' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-laugh\.gif(.*?)\" \/>/' , ':D' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-smile\.gif(.*?)\" \/>/' , ':smile:' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-surprised\.gif(.*?)\" \/>/' , ':o' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-wink\.gif(.*?)\" \/>/' , ':wink:' , $simplepress_markup ); $simplepress_markup = preg_replace( '/\<img src=(.*?)\/sp-resources\/forum-smileys\/sf-yell\.gif(.*?)\" \/>/' , ':x' , $simplepress_markup ); // Replace '<div class="sfcode">example code</div>' with '<code>*</code>' $simplepress_markup = preg_replace( '/\<div class\=\"sfcode\"\>(.*?)\<\/div\>/' , '<code>$1</code>' , $simplepress_markup ); // Replace '<strong>username said </strong>' with '@username said:' $simplepress_markup = preg_replace ( '/\<strong\>(.*?)\ said\ \<\/strong\>/' , '@$1 said:' , $simplepress_markup ); // Replace '<p> </p>' with '<p> </p>' $simplepress_markup = preg_replace ( '/\n( |[\s\p{Z}\xA0\x{00A0}]+)\r/' , '<br>' , $simplepress_markup ); // Now that SimplePress' custom HTML codes have been stripped put the cleaned HTML back in $field $field = $simplepress_markup ; // Parse out any bbCodes 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 ) ); } } |
Changelog
Version | Description |
---|---|
bbPress (r4638) | Introduced. |
Methods
- __construct — Main Constructor
- authenticate_pass — This method is to take the pass out of the database and compare to a pass the user has typed in.
- callback_html — This callback processes any custom parser.php attributes and custom HTML code with preg_replace
- callback_reply_title — Set the reply title
- callback_savepass — 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.
- callback_status — Translate the post status from Simple:Press v5.x numeric's to WordPress's strings.
- callback_sticky_status — Translate the topic sticky status type from Simple:Press v5.x numeric's to WordPress's strings.
- callback_topic_reply_count — Verify the topic reply count.
- info — This method allows us to indicates what is or is not converted for each converter.
- setup_globals — Sets up the field mappings
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.