phpBB/includes/bbcode.php

   1 18.04.2009<?php
   2 /**
   3 *
   4 * @package phpBB3
   5 * @version $Id$
   6 * @copyright (c) 2005 phpBB Group
   7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
   8 *
   9 */
  10
  11 /**
  12 * @ignore
  13 */
  14 if (!defined('IN_PHPBB'))
  15 {
  16         exit;
  17 }
  18
  19 /**
  20 * BBCode class
  21 * @package phpBB3
  22 */
  23 class bbcode
  24 {
  25         var $bbcode_uid = '';
  26         var $bbcode_bitfield = '';
  27         var $bbcode_cache = array();
  28         var $bbcode_template = array();
  29
  30         var $bbcodes = array();
  31
  32         var $template_bitfield;
  33         var $template_filename = '';
  34
  35         /**
  36         * Constructor
  37         * Init bbcode cache entries if bitfield is specified
  38         */
  39         function __construct($bitfield = '')
  40         {
  41                 if ($bitfield)
  42                 {
  43                         $this->bbcode_bitfield = $bitfield;
  44                         $this->bbcode_cache_init();
  45                 }
  46         }
  47
  48         /**
  49         * Second pass bbcodes
  50         */
  51         function bbcode_second_pass(&$message, $bbcode_uid = '', $bbcode_bitfield = false)
  52         {
  53                 if ($bbcode_uid)
  54                 {
  55                         $this->bbcode_uid = $bbcode_uid;
  56                 }
  57
  58                 if ($bbcode_bitfield !== false)
  59                 {
  60                         $this->bbcode_bitfield = $bbcode_bitfield;
  61
  62                         // Init those added with a new bbcode_bitfield (already stored codes will not get parsed again)
  63                         $this->bbcode_cache_init();
  64                 }
  65
  66                 if (!$this->bbcode_bitfield)
  67                 {
  68                         // Remove the uid from tags that have not been transformed into HTML
  69                         if ($this->bbcode_uid)
  70                         {
  71                                 $message = str_replace(':' . $this->bbcode_uid, '', $message);
  72                         }
  73
  74                         return;
  75                 }
  76
  77                 $str = array('search' => array(), 'replace' => array());
  78                 $preg = array('search' => array(), 'replace' => array());
  79
  80                 $bitfield = new bitfield($this->bbcode_bitfield);
  81                 $bbcodes_set = $bitfield->get_all_set();
  82
  83                 $undid_bbcode_specialchars = false;
  84                 foreach ($bbcodes_set as $bbcode_id)
  85                 {
  86                         if (!empty($this->bbcode_cache[$bbcode_id]))
  87                         {
  88                                 foreach ($this->bbcode_cache[$bbcode_id] as $type => $array)
  89                                 {
  90                                         foreach ($array as $search => $replace)
  91                                         {
  92                                                 ${$type}['search'][] = str_replace('$uid', $this->bbcode_uid, $search);
  93                                                 ${$type}['replace'][] = $replace;
  94                                         }
  95
  96                                         if (sizeof($str['search']))
  97                                         {
  98                                                 $message = str_replace($str['search'], $str['replace'], $message);
  99                                                 $str = array('search' => array(), 'replace' => array());
 100                                         }
 101
 102                                         if (sizeof($preg['search']))
 103                                         {
 104                                                 // we need to turn the entities back into their original form to allow the
 105                                                 // search patterns to work properly
 106                                                 if (!$undid_bbcode_specialchars)
 107                                                 {
 108                                                         $message = str_replace(array('&#58;', '&#46;'), array(':', '.'), $message);
 109                                                         $undid_bbcode_specialchars = true;
 110                                                 }
 111
 112                                                 $message = preg_replace($preg['search'], $preg['replace'], $message);
 113                                                 $preg = array('search' => array(), 'replace' => array());
 114                                         }
 115                                 }
 116                         }
 117                 }
 118
 119                 // Remove the uid from tags that have not been transformed into HTML
 120                 $message = str_replace(':' . $this->bbcode_uid, '', $message);
 121         }
 122
 123         /**
 124         * Init bbcode cache
 125         *
 126         * requires: $this->bbcode_bitfield
 127         * sets: $this->bbcode_cache with bbcode templates needed for bbcode_bitfield
 128         */
 129         function bbcode_cache_init()
 130         {
 131                 if (empty($this->template_filename))
 132                 {
 133                         $this->template_bitfield = new bitfield(phpbb::$user->theme['bbcode_bitfield']);
 134                         $this->template_filename = PHPBB_ROOT_PATH . 'styles/' . phpbb::$user->theme['template_path'] . '/template/bbcode.html';
 135
 136                         if (!@file_exists($this->template_filename))
 137                         {
 138                                 trigger_error('The file ' . $this->template_filename . ' is missing.', E_USER_ERROR);
 139                         }
 140                 }
 141
 142                 $bbcode_ids = $rowset = $sql = array();
 143
 144                 $bitfield = new bitfield($this->bbcode_bitfield);
 145                 $bbcodes_set = $bitfield->get_all_set();
 146
 147                 foreach ($bbcodes_set as $bbcode_id)
 148                 {
 149                         if (isset($this->bbcode_cache[$bbcode_id]))
 150                         {
 151                                 // do not try to re-cache it if it's already in
 152                                 continue;
 153                         }
 154                         $bbcode_ids[] = $bbcode_id;
 155
 156                         if ($bbcode_id > NUM_CORE_BBCODES)
 157                         {
 158                                 $sql[] = $bbcode_id;
 159                         }
 160                 }
 161
 162                 if (sizeof($sql))
 163                 {
 164                         $sql = 'SELECT *
 165                                 FROM ' . BBCODES_TABLE . '
 166                                 WHERE ' . phpbb::$db->sql_in_set('bbcode_id', $sql);
 167                         $result = phpbb::$db->sql_query($sql, 3600);
 168
 169                         while ($row = phpbb::$db->sql_fetchrow($result))
 170                         {
 171                                 // To circumvent replacing newlines with <br /> for the generated html,
 172                                 // we use carriage returns here. They are later changed back to newlines
 173                                 $row['bbcode_tpl'] = str_replace("\n", "\r", $row['bbcode_tpl']);
 174                                 $row['second_pass_replace'] = str_replace("\n", "\r", $row['second_pass_replace']);
 175
 176                                 $rowset[$row['bbcode_id']] = $row;
 177                         }
 178                         phpbb::$db->sql_freeresult($result);
 179                 }
 180
 181                 foreach ($bbcode_ids as $bbcode_id)
 182                 {
 183                         switch ($bbcode_id)
 184                         {
 185                                 case 0:
 186                                         $this->bbcode_cache[$bbcode_id] = array(
 187                                                 'str' => array(
 188                                                         '[/quote:$uid]' => $this->bbcode_tpl('quote_close', $bbcode_id)
 189                                                 ),
 190                                                 'preg' => array(
 191                                                         '#\[quote(?:=&quot;(.*?)&quot;)?:$uid\]((?!\[quote(?:=&quot;.*?&quot;)?:$uid\]).)?#ise' => "\$this->bbcode_second_pass_quote('\$1', '\$2')"
 192                                                 )
 193                                         );
 194                                 break;
 195
 196                                 case 1:
 197                                         $this->bbcode_cache[$bbcode_id] = array(
 198                                                 'str' => array(
 199                                                         '[b:$uid]'      => $this->bbcode_tpl('b_open', $bbcode_id),
 200                                                         '[/b:$uid]'     => $this->bbcode_tpl('b_close', $bbcode_id),
 201                                                 )
 202                                         );
 203                                 break;
 204
 205                                 case 2:
 206                                         $this->bbcode_cache[$bbcode_id] = array(
 207                                                 'str' => array(
 208                                                         '[i:$uid]'      => $this->bbcode_tpl('i_open', $bbcode_id),
 209                                                         '[/i:$uid]'     => $this->bbcode_tpl('i_close', $bbcode_id),
 210                                                 )
 211                                         );
 212                                 break;
 213
 214                                 case 3:
 215                                         $this->bbcode_cache[$bbcode_id] = array(
 216                                                 'preg' => array(
 217                                                         '#\[url:$uid\]((.*?))\[/url:$uid\]#s'                   => $this->bbcode_tpl('url', $bbcode_id),
 218                                                         '#\[url=([^\[]+?):$uid\](.*?)\[/url:$uid\]#s'   => $this->bbcode_tpl('url', $bbcode_id),
 219                                                 )
 220                                         );
 221                                 break;
 222
 223                                 case 4:
 224                                         if (phpbb::$user->optionget('viewimg'))
 225                                         {
 226                                                 $this->bbcode_cache[$bbcode_id] = array(
 227                                                         'preg' => array(
 228                                                                 '#\[img:$uid\](.*?)\[/img:$uid\]#s'             => $this->bbcode_tpl('img', $bbcode_id),
 229                                                         )
 230                                                 );
 231                                         }
 232                                         else
 233                                         {
 234                                                 $this->bbcode_cache[$bbcode_id] = array(
 235                                                         'preg' => array(
 236                                                                 '#\[img:$uid\](.*?)\[/img:$uid\]#s'             => str_replace('$2', '[ img ]', $this->bbcode_tpl('url', $bbcode_id, true)),
 237                                                         )
 238                                                 );
 239                                         }
 240                                 break;
 241
 242                                 case 5:
 243                                         $this->bbcode_cache[$bbcode_id] = array(
 244                                                 'preg' => array(
 245                                                         '#\[size=([\-\+]?\d+):$uid\](.*?)\[/size:$uid\]#s'      => $this->bbcode_tpl('size', $bbcode_id),
 246                                                 )
 247                                         );
 248                                 break;
 249
 250                                 case 6:
 251                                         $this->bbcode_cache[$bbcode_id] = array(
 252                                                 'preg' => array(
 253                                                         '!\[color=(#[0-9a-f]{6}|[a-z\-]+):$uid\](.*?)\[/color:$uid\]!is'        => $this->bbcode_tpl('color', $bbcode_id),
 254                                                 )
 255                                         );
 256                                 break;
 257
 258                                 case 7:
 259                                         $this->bbcode_cache[$bbcode_id] = array(
 260                                                 'str' => array(
 261                                                         '[u:$uid]'      => $this->bbcode_tpl('u_open', $bbcode_id),
 262                                                         '[/u:$uid]'     => $this->bbcode_tpl('u_close', $bbcode_id),
 263                                                 )
 264                                         );
 265                                 break;
 266
 267                                 case 8:
 268                                         $this->bbcode_cache[$bbcode_id] = array(
 269                                                 'preg' => array(
 270                                                         '#\[code(?:=([a-z]+))?:$uid\](.*?)\[/code:$uid\]#ise'   => "\$this->bbcode_second_pass_code('\$1', '\$2')",
 271                                                 )
 272                                         );
 273                                 break;
 274
 275                                 case 9:
 276                                         $this->bbcode_cache[$bbcode_id] = array(
 277                                                 'preg' => array(
 278                                                         '#(\[\/?(list|\*):[mou]?:?$uid\])[\n]{1}#'      => "\$1",
 279                                                         '#(\[list=([^\[]+):$uid\])[\n]{1}#'                     => "\$1",
 280                                                         '#\[list=([^\[]+):$uid\]#e'                                     => "\$this->bbcode_list('\$1')",
 281                                                 ),
 282                                                 'str' => array(
 283                                                         '[list:$uid]'           => $this->bbcode_tpl('ulist_open_default', $bbcode_id),
 284                                                         '[/list:u:$uid]'        => $this->bbcode_tpl('ulist_close', $bbcode_id),
 285                                                         '[/list:o:$uid]'        => $this->bbcode_tpl('olist_close', $bbcode_id),
 286                                                         '[*:$uid]'                      => $this->bbcode_tpl('listitem', $bbcode_id),
 287                                                         '[/*:$uid]'                     => $this->bbcode_tpl('listitem_close', $bbcode_id),
 288                                                         '[/*:m:$uid]'           => $this->bbcode_tpl('listitem_close', $bbcode_id)
 289                                                 ),
 290                                         );
 291                                 break;
 292
 293                                 case 10:
 294                                         $this->bbcode_cache[$bbcode_id] = array(
 295                                                 'preg' => array(
 296                                                         '#\[email:$uid\]((.*?))\[/email:$uid\]#is'                      => $this->bbcode_tpl('email', $bbcode_id),
 297                                                         '#\[email=([^\[]+):$uid\](.*?)\[/email:$uid\]#is'       => $this->bbcode_tpl('email', $bbcode_id)
 298                                                 )
 299                                         );
 300                                 break;
 301
 302                                 case 11:
 303                                         if (phpbb::$user->optionget('viewflash'))
 304                                         {
 305                                                 $this->bbcode_cache[$bbcode_id] = array(
 306                                                         'preg' => array(
 307                                                                 '#\[flash=([0-9]+),([0-9]+):$uid\](.*?)\[/flash:$uid\]#'        => $this->bbcode_tpl('flash', $bbcode_id),
 308                                                         )
 309                                                 );
 310                                         }
 311                                         else
 312                                         {
 313                                                 $this->bbcode_cache[$bbcode_id] = array(
 314                                                         'preg' => array(
 315                                                                 '#\[flash=([0-9]+),([0-9]+):$uid\](.*?)\[/flash:$uid\]#'        => str_replace('$1', '$3', str_replace('$2', '[ flash ]', $this->bbcode_tpl('url', $bbcode_id, true)))
 316                                                         )
 317                                                 );
 318                                         }
 319                                 break;
 320
 321                                 case 12:
 322                                         $this->bbcode_cache[$bbcode_id] = array(
 323                                                 'str'   => array(
 324                                                         '[/attachment:$uid]'    => $this->bbcode_tpl('inline_attachment_close', $bbcode_id)
 325                                                 ),
 326                                                 'preg'  => array(
 327                                                         '#\[attachment=([0-9]+):$uid\]#'        => $this->bbcode_tpl('inline_attachment_open', $bbcode_id)
 328                                                 )
 329                                         );
 330                                 break;
 331
 332                                 default:
 333                                         if (isset($rowset[$bbcode_id]))
 334                                         {
 335                                                 if ($this->template_bitfield->get($bbcode_id))
 336                                                 {
 337                                                         // The bbcode requires a custom template to be loaded
 338                                                         if (!$bbcode_tpl = $this->bbcode_tpl($rowset[$bbcode_id]['bbcode_tag'], $bbcode_id))
 339                                                         {
 340                                                                 // For some reason, the required template seems not to be available, use the default template
 341                                                                 $bbcode_tpl = (!empty($rowset[$bbcode_id]['second_pass_replace'])) ? $rowset[$bbcode_id]['second_pass_replace'] : $rowset[$bbcode_id]['bbcode_tpl'];
 342                                                         }
 343                                                         else
 344                                                         {
 345                                                                 // In order to use templates with custom bbcodes we need
 346                                                                 // to replace all {VARS} to corresponding backreferences
 347                                                                 // Note that backreferences are numbered from bbcode_match
 348                                                                 if (preg_match_all('/\{(URL|LOCAL_URL|EMAIL|TEXT|SIMPLETEXT|IDENTIFIER|COLOR|NUMBER)[0-9]*\}/', $rowset[$bbcode_id]['bbcode_match'], $m))
 349                                                                 {
 350                                                                         foreach ($m[0] as $i => $tok)
 351                                                                         {
 352                                                                                 $bbcode_tpl = str_replace($tok, '$' . ($i + 1), $bbcode_tpl);
 353                                                                         }
 354                                                                 }
 355                                                         }
 356                                                 }
 357                                                 else
 358                                                 {
 359                                                         // Default template
 360                                                         $bbcode_tpl = (!empty($rowset[$bbcode_id]['second_pass_replace'])) ? $rowset[$bbcode_id]['second_pass_replace'] : $rowset[$bbcode_id]['bbcode_tpl'];
 361                                                 }
 362
 363                                                 // Replace {L_*} lang strings
 364                                                 $bbcode_tpl = preg_replace('/{L_([A-Z_]+)}/e', "phpbb::\$user->lang('\$1')", $bbcode_tpl);
 365
 366                                                 if (!empty($rowset[$bbcode_id]['second_pass_replace']))
 367                                                 {
 368                                                         // The custom BBCode requires second-pass pattern replacements
 369                                                         $this->bbcode_cache[$bbcode_id] = array(
 370                                                                 'preg' => array($rowset[$bbcode_id]['second_pass_match'] => $bbcode_tpl)
 371                                                         );
 372                                                 }
 373                                                 else
 374                                                 {
 375                                                         $this->bbcode_cache[$bbcode_id] = array(
 376                                                                 'str' => array($rowset[$bbcode_id]['second_pass_match'] => $bbcode_tpl)
 377                                                         );
 378                                                 }
 379                                         }
 380                                         else
 381                                         {
 382                                                 $this->bbcode_cache[$bbcode_id] = false;
 383                                         }
 384                                 break;
 385                         }
 386                 }
 387         }
 388
 389         /**
 390         * Return bbcode template
 391         */
 392         function bbcode_tpl($tpl_name, $bbcode_id = -1, $skip_bitfield_check = false)
 393         {
 394                 static $bbcode_hardtpl = array();
 395                 if (empty($bbcode_hardtpl))
 396                 {
 397                         $bbcode_hardtpl = array(
 398                                 'b_open'        => '<span style="font-weight: bold">',
 399                                 'b_close'       => '</span>',
 400                                 'i_open'        => '<span style="font-style: italic">',
 401                                 'i_close'       => '</span>',
 402                                 'u_open'        => '<span style="text-decoration: underline">',
 403                                 'u_close'       => '</span>',
 404                                 'img'           => '<img src="$1" alt="' . phpbb::$user->lang['IMAGE'] . '" />',
 405                                 'size'          => '<span style="font-size: $1%; line-height: normal">$2</span>',
 406                                 'color'         => '<span style="color: $1">$2</span>',
 407                                 'email'         => '<a href="mailto:$1">$2</a>'
 408                         );
 409                 }
 410
 411                 if ($bbcode_id != -1 && !$skip_bitfield_check && !$this->template_bitfield->get($bbcode_id))
 412                 {
 413                         return (isset($bbcode_hardtpl[$tpl_name])) ? $bbcode_hardtpl[$tpl_name] : false;
 414                 }
 415
 416                 if (empty($this->bbcode_template))
 417                 {
 418                         if (($tpl = file_get_contents($this->template_filename)) === false)
 419                         {
 420                                 trigger_error('Could not load bbcode template', E_USER_ERROR);
 421                         }
 422
 423                         // replace \ with \\ and then ' with \'.
 424                         $tpl = str_replace('\\', '\\\\', $tpl);
 425                         $tpl = str_replace("'", "\'", $tpl);
 426
 427                         // strip newlines and indent
 428                         $tpl = preg_replace("/\n[\n\r\s\t]*/", '', $tpl);
 429
 430                         // Turn template blocks into PHP assignment statements for the values of $bbcode_tpl..
 431                         $this->bbcode_template = array();
 432
 433                         $matches = preg_match_all('#<!-- BEGIN (.*?) -->(.*?)<!-- END (?:.*?) -->#', $tpl, $match);
 434
 435                         for ($i = 0; $i < $matches; $i++)
 436                         {
 437                                 if (empty($match[1][$i]))
 438                                 {
 439                                         continue;
 440                                 }
 441
 442                                 $this->bbcode_template[$match[1][$i]] = $this->bbcode_tpl_replace($match[1][$i], $match[2][$i]);
 443                         }
 444                 }
 445
 446                 return (isset($this->bbcode_template[$tpl_name])) ? $this->bbcode_template[$tpl_name] : ((isset($bbcode_hardtpl[$tpl_name])) ? $bbcode_hardtpl[$tpl_name] : false);
 447         }
 448
 449         /**
 450         * Return bbcode template replacement
 451         */
 452         function bbcode_tpl_replace($tpl_name, $tpl)
 453         {
 454                 static $replacements = array(
 455                         'quote_username_open'   => array('{USERNAME}'   => '$1'),
 456                         'color'                                 => array('{COLOR}'              => '$1', '{TEXT}'                       => '$2'),
 457                         'size'                                  => array('{SIZE}'               => '$1', '{TEXT}'                       => '$2'),
 458                         'img'                                   => array('{URL}'                => '$1'),
 459                         'flash'                                 => array('{WIDTH}'              => '$1', '{HEIGHT}'                     => '$2', '{URL}'        => '$3'),
 460                         'url'                                   => array('{URL}'                => '$1', '{DESCRIPTION}'        => '$2'),
 461                         'email'                                 => array('{EMAIL}'              => '$1', '{DESCRIPTION}'        => '$2')
 462                 );
 463
 464                 $tpl = preg_replace('/{L_([A-Z_]+)}/e', "phpbb::\$user->lang('\$1')", $tpl);
 465
 466                 if (!empty($replacements[$tpl_name]))
 467                 {
 468                         $tpl = strtr($tpl, $replacements[$tpl_name]);
 469                 }
 470
 471                 return trim($tpl);
 472         }
 473
 474         /**
 475         * Second parse list bbcode
 476         */
 477         function bbcode_list($type)
 478         {
 479                 if ($type == '')
 480                 {
 481                         $tpl = 'ulist_open_default';
 482                         $type = 'default';
 483                 }
 484                 else if ($type == 'i')
 485                 {
 486                         $tpl = 'olist_open';
 487                         $type = 'lower-roman';
 488                 }
 489                 else if ($type == 'I')
 490                 {
 491                         $tpl = 'olist_open';
 492                         $type = 'upper-roman';
 493                 }
 494                 else if (preg_match('#^(disc|circle|square)$#i', $type))
 495                 {
 496                         $tpl = 'ulist_open';
 497                         $type = strtolower($type);
 498                 }
 499                 else if (preg_match('#^[a-z]$#', $type))
 500                 {
 501                         $tpl = 'olist_open';
 502                         $type = 'lower-alpha';
 503                 }
 504                 else if (preg_match('#[A-Z]#', $type))
 505                 {
 506                         $tpl = 'olist_open';
 507                         $type = 'upper-alpha';
 508                 }
 509                 else if (is_numeric($type))
 510                 {
 511                         $tpl = 'olist_open';
 512                         $type = 'decimal';
 513                 }
 514                 else
 515                 {
 516                         $tpl = 'olist_open';
 517                         $type = 'decimal';
 518                 }
 519
 520                 return str_replace('{LIST_TYPE}', $type, $this->bbcode_tpl($tpl));
 521         }
 522
 523         /**
 524         * Second parse quote tag
 525         */
 526         function bbcode_second_pass_quote($username, $quote)
 527         {
 528                 // when using the /e modifier, preg_replace slashes double-quotes but does not
 529                 // seem to slash anything else
 530                 $quote = str_replace('\"', '"', $quote);
 531                 $username = str_replace('\"', '"', $username);
 532
 533                 // remove newline at the beginning
 534                 if ($quote == "\n")
 535                 {
 536                         $quote = '';
 537                 }
 538
 539                 $quote = (($username) ? str_replace('$1', $username, $this->bbcode_tpl('quote_username_open')) : $this->bbcode_tpl('quote_open')) . $quote;
 540
 541                 return $quote;
 542         }
 543
 544         /**
 545         * Second parse code tag
 546         */
 547         function bbcode_second_pass_code($type, $code)
 548         {
 549                 // when using the /e modifier, preg_replace slashes double-quotes but does not
 550                 // seem to slash anything else
 551                 $code = str_replace('\"', '"', $code);
 552
 553                 switch ($type)
 554                 {
 555                         case 'php':
 556                                 // Not the english way, but valid because of hardcoded syntax highlighting
 557                                 if (strpos($code, '<span class="syntaxdefault"><br /></span>') === 0)
 558                                 {
 559                                         $code = substr($code, 41);
 560                                 }
 561
 562                         // no break;
 563
 564                         default:
 565                                 $code = str_replace("\t", '&nbsp; &nbsp;', $code);
 566                                 $code = str_replace('  ', '&nbsp; ', $code);
 567                                 $code = str_replace('  ', ' &nbsp;', $code);
 568
 569                                 // remove newline at the beginning
 570                                 if (!empty($code) && $code[0] == "\n")
 571                                 {
 572                                         $code = substr($code, 1);
 573                                 }
 574                         break;
 575                 }
 576
 577                 $code = $this->bbcode_tpl('code_open') . $code . $this->bbcode_tpl('code_close');
 578
 579                 return $code;
 580         }
 581 }
 582
 583 ?>