[ Index ]

PHP Cross Reference of phpBB-3.2.0-deutsch

title

Body

[close]

/includes/ -> functions_content.php (source)

   1  <?php
   2  /**
   3  *
   4  * This file is part of the phpBB Forum Software package.
   5  *
   6  * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7  * @license GNU General Public License, version 2 (GPL-2.0)
   8  *
   9  * For full copyright and license information, please see
  10  * the docs/CREDITS.txt file.
  11  *
  12  */
  13  
  14  /**
  15  * @ignore
  16  */
  17  if (!defined('IN_PHPBB'))
  18  {
  19      exit;
  20  }
  21  
  22  /**
  23  * gen_sort_selects()
  24  * make_jumpbox()
  25  * bump_topic_allowed()
  26  * get_context()
  27  * phpbb_clean_search_string()
  28  * decode_message()
  29  * strip_bbcode()
  30  * generate_text_for_display()
  31  * generate_text_for_storage()
  32  * generate_text_for_edit()
  33  * make_clickable_callback()
  34  * make_clickable()
  35  * censor_text()
  36  * bbcode_nl2br()
  37  * smiley_text()
  38  * parse_attachments()
  39  * extension_allowed()
  40  * truncate_string()
  41  * get_username_string()
  42  * class bitfield
  43  */
  44  
  45  /**
  46  * Generate sort selection fields
  47  */
  48  function gen_sort_selects(&$limit_days, &$sort_by_text, &$sort_days, &$sort_key, &$sort_dir, &$s_limit_days, &$s_sort_key, &$s_sort_dir, &$u_sort_param, $def_st = false, $def_sk = false, $def_sd = false)
  49  {
  50      global $user, $phpbb_dispatcher;
  51  
  52      $sort_dir_text = array('a' => $user->lang['ASCENDING'], 'd' => $user->lang['DESCENDING']);
  53  
  54      $sorts = array(
  55          'st'    => array(
  56              'key'        => 'sort_days',
  57              'default'    => $def_st,
  58              'options'    => $limit_days,
  59              'output'    => &$s_limit_days,
  60          ),
  61  
  62          'sk'    => array(
  63              'key'        => 'sort_key',
  64              'default'    => $def_sk,
  65              'options'    => $sort_by_text,
  66              'output'    => &$s_sort_key,
  67          ),
  68  
  69          'sd'    => array(
  70              'key'        => 'sort_dir',
  71              'default'    => $def_sd,
  72              'options'    => $sort_dir_text,
  73              'output'    => &$s_sort_dir,
  74          ),
  75      );
  76      $u_sort_param  = '';
  77  
  78      foreach ($sorts as $name => $sort_ary)
  79      {
  80          $key = $sort_ary['key'];
  81          $selected = ${$sort_ary['key']};
  82  
  83          // Check if the key is selectable. If not, we reset to the default or first key found.
  84          // This ensures the values are always valid. We also set $sort_dir/sort_key/etc. to the
  85          // correct value, else the protection is void. ;)
  86          if (!isset($sort_ary['options'][$selected]))
  87          {
  88              if ($sort_ary['default'] !== false)
  89              {
  90                  $selected = ${$key} = $sort_ary['default'];
  91              }
  92              else
  93              {
  94                  @reset($sort_ary['options']);
  95                  $selected = ${$key} = key($sort_ary['options']);
  96              }
  97          }
  98  
  99          $sort_ary['output'] = '<select name="' . $name . '" id="' . $name . '">';
 100          foreach ($sort_ary['options'] as $option => $text)
 101          {
 102              $sort_ary['output'] .= '<option value="' . $option . '"' . (($selected == $option) ? ' selected="selected"' : '') . '>' . $text . '</option>';
 103          }
 104          $sort_ary['output'] .= '</select>';
 105  
 106          $u_sort_param .= ($selected !== $sort_ary['default']) ? ((strlen($u_sort_param)) ? '&amp;' : '') . "{$name}={$selected}" : '';
 107      }
 108  
 109      /**
 110       * Run code before generated sort selects are returned
 111       *
 112       * @event core.gen_sort_selects_after
 113       * @var    int      limit_days     Days limit
 114       * @var    array    sort_by_text   Sort by text options
 115       * @var    int      sort_days      Sort by days flag
 116       * @var    string   sort_key       Sort key
 117       * @var    string   sort_dir       Sort dir
 118       * @var    string   s_limit_days   String of days limit
 119       * @var    string   s_sort_key     String of sort key
 120       * @var    string   s_sort_dir     String of sort dir
 121       * @var    string   u_sort_param   Sort URL params
 122       * @var    bool     def_st         Default sort days
 123       * @var    bool     def_sk         Default sort key
 124       * @var    bool     def_sd         Default sort dir
 125       * @var    array    sorts          Sorts
 126       * @since 3.1.9-RC1
 127       */
 128      $vars = array(
 129          'limit_days',
 130          'sort_by_text',
 131          'sort_days',
 132          'sort_key',
 133          'sort_dir',
 134          's_limit_days',
 135          's_sort_key',
 136          's_sort_dir',
 137          'u_sort_param',
 138          'def_st',
 139          'def_sk',
 140          'def_sd',
 141          'sorts',
 142      );
 143      extract($phpbb_dispatcher->trigger_event('core.gen_sort_selects_after', compact($vars)));
 144  
 145      return;
 146  }
 147  
 148  /**
 149  * Generate Jumpbox
 150  */
 151  function make_jumpbox($action, $forum_id = false, $select_all = false, $acl_list = false, $force_display = false)
 152  {
 153      global $config, $auth, $template, $user, $db, $phpbb_path_helper, $phpbb_dispatcher;
 154  
 155      // We only return if the jumpbox is not forced to be displayed (in case it is needed for functionality)
 156      if (!$config['load_jumpbox'] && $force_display === false)
 157      {
 158          return;
 159      }
 160  
 161      $sql = 'SELECT forum_id, forum_name, parent_id, forum_type, left_id, right_id
 162          FROM ' . FORUMS_TABLE . '
 163          ORDER BY left_id ASC';
 164      $result = $db->sql_query($sql, 600);
 165  
 166      $rowset = array();
 167      while ($row = $db->sql_fetchrow($result))
 168      {
 169          $rowset[(int) $row['forum_id']] = $row;
 170      }
 171      $db->sql_freeresult($result);
 172  
 173      $right = $padding = 0;
 174      $padding_store = array('0' => 0);
 175      $display_jumpbox = false;
 176      $iteration = 0;
 177  
 178      /**
 179      * Modify the jumpbox forum list data
 180      *
 181      * @event core.make_jumpbox_modify_forum_list
 182      * @var    array    rowset    Array with the forums list data
 183      * @since 3.1.10-RC1
 184      */
 185      $vars = array('rowset');
 186      extract($phpbb_dispatcher->trigger_event('core.make_jumpbox_modify_forum_list', compact($vars)));
 187  
 188      // Sometimes it could happen that forums will be displayed here not be displayed within the index page
 189      // This is the result of forums not displayed at index, having list permissions and a parent of a forum with no permissions.
 190      // If this happens, the padding could be "broken"
 191  
 192      foreach ($rowset as $row)
 193      {
 194          if ($row['left_id'] < $right)
 195          {
 196              $padding++;
 197              $padding_store[$row['parent_id']] = $padding;
 198          }
 199          else if ($row['left_id'] > $right + 1)
 200          {
 201              // Ok, if the $padding_store for this parent is empty there is something wrong. For now we will skip over it.
 202              // @todo digging deep to find out "how" this can happen.
 203              $padding = (isset($padding_store[$row['parent_id']])) ? $padding_store[$row['parent_id']] : $padding;
 204          }
 205  
 206          $right = $row['right_id'];
 207  
 208          if ($row['forum_type'] == FORUM_CAT && ($row['left_id'] + 1 == $row['right_id']))
 209          {
 210              // Non-postable forum with no subforums, don't display
 211              continue;
 212          }
 213  
 214          if (!$auth->acl_get('f_list', $row['forum_id']))
 215          {
 216              // if the user does not have permissions to list this forum skip
 217              continue;
 218          }
 219  
 220          if ($acl_list && !$auth->acl_gets($acl_list, $row['forum_id']))
 221          {
 222              continue;
 223          }
 224  
 225          $tpl_ary = array();
 226          if (!$display_jumpbox)
 227          {
 228              $tpl_ary[] = array(
 229                  'FORUM_ID'        => ($select_all) ? 0 : -1,
 230                  'FORUM_NAME'    => ($select_all) ? $user->lang['ALL_FORUMS'] : $user->lang['SELECT_FORUM'],
 231                  'S_FORUM_COUNT'    => $iteration,
 232                  'LINK'            => $phpbb_path_helper->append_url_params($action, array('f' => $forum_id)),
 233              );
 234  
 235              $iteration++;
 236              $display_jumpbox = true;
 237          }
 238  
 239          $tpl_ary[] = array(
 240              'FORUM_ID'        => $row['forum_id'],
 241              'FORUM_NAME'    => $row['forum_name'],
 242              'SELECTED'        => ($row['forum_id'] == $forum_id) ? ' selected="selected"' : '',
 243              'S_FORUM_COUNT'    => $iteration,
 244              'S_IS_CAT'        => ($row['forum_type'] == FORUM_CAT) ? true : false,
 245              'S_IS_LINK'        => ($row['forum_type'] == FORUM_LINK) ? true : false,
 246              'S_IS_POST'        => ($row['forum_type'] == FORUM_POST) ? true : false,
 247              'LINK'            => $phpbb_path_helper->append_url_params($action, array('f' => $row['forum_id'])),
 248          );
 249  
 250          /**
 251           * Modify the jumpbox before it is assigned to the template
 252           *
 253           * @event core.make_jumpbox_modify_tpl_ary
 254           * @var    array    row                The data of the forum
 255           * @var    array    tpl_ary            Template data of the forum
 256           * @since 3.1.10-RC1
 257           */
 258          $vars = array(
 259              'row',
 260              'tpl_ary',
 261          );
 262          extract($phpbb_dispatcher->trigger_event('core.make_jumpbox_modify_tpl_ary', compact($vars)));
 263  
 264          $template->assign_block_vars_array('jumpbox_forums', $tpl_ary);
 265  
 266          unset($tpl_ary);
 267  
 268          for ($i = 0; $i < $padding; $i++)
 269          {
 270              $template->assign_block_vars('jumpbox_forums.level', array());
 271          }
 272          $iteration++;
 273      }
 274      unset($padding_store, $rowset);
 275  
 276      $url_parts = $phpbb_path_helper->get_url_parts($action);
 277  
 278      $template->assign_vars(array(
 279          'S_DISPLAY_JUMPBOX'            => $display_jumpbox,
 280          'S_JUMPBOX_ACTION'            => $action,
 281          'HIDDEN_FIELDS_FOR_JUMPBOX'    => build_hidden_fields($url_parts['params']),
 282      ));
 283  
 284      return;
 285  }
 286  
 287  /**
 288  * Bump Topic Check - used by posting and viewtopic
 289  */
 290  function bump_topic_allowed($forum_id, $topic_bumped, $last_post_time, $topic_poster, $last_topic_poster)
 291  {
 292      global $config, $auth, $user;
 293  
 294      // Check permission and make sure the last post was not already bumped
 295      if (!$auth->acl_get('f_bump', $forum_id) || $topic_bumped)
 296      {
 297          return false;
 298      }
 299  
 300      // Check bump time range, is the user really allowed to bump the topic at this time?
 301      $bump_time = ($config['bump_type'] == 'm') ? $config['bump_interval'] * 60 : (($config['bump_type'] == 'h') ? $config['bump_interval'] * 3600 : $config['bump_interval'] * 86400);
 302  
 303      // Check bump time
 304      if ($last_post_time + $bump_time > time())
 305      {
 306          return false;
 307      }
 308  
 309      // Check bumper, only topic poster and last poster are allowed to bump
 310      if ($topic_poster != $user->data['user_id'] && $last_topic_poster != $user->data['user_id'])
 311      {
 312          return false;
 313      }
 314  
 315      // A bump time of 0 will completely disable the bump feature... not intended but might be useful.
 316      return $bump_time;
 317  }
 318  
 319  /**
 320  * Generates a text with approx. the specified length which contains the specified words and their context
 321  *
 322  * @param    string    $text    The full text from which context shall be extracted
 323  * @param    string    $words    An array of words which should be contained in the result, has to be a valid part of a PCRE pattern (escape with preg_quote!)
 324  * @param    int        $length    The desired length of the resulting text, however the result might be shorter or longer than this value
 325  *
 326  * @return    string            Context of the specified words separated by "..."
 327  */
 328  function get_context($text, $words, $length = 400)
 329  {
 330      // first replace all whitespaces with single spaces
 331      $text = preg_replace('/ +/', ' ', strtr($text, "\t\n\r\x0C ", '     '));
 332  
 333      // we need to turn the entities back into their original form, to not cut the message in between them
 334      $entities = array('&lt;', '&gt;', '&#91;', '&#93;', '&#46;', '&#58;', '&#058;');
 335      $characters = array('<', '>', '[', ']', '.', ':', ':');
 336      $text = str_replace($entities, $characters, $text);
 337  
 338      $word_indizes = array();
 339      if (sizeof($words))
 340      {
 341          $match = '';
 342          // find the starting indizes of all words
 343          foreach ($words as $word)
 344          {
 345              if ($word)
 346              {
 347                  if (preg_match('#(?:[^\w]|^)(' . $word . ')(?:[^\w]|$)#i', $text, $match))
 348                  {
 349                      if (empty($match[1]))
 350                      {
 351                          continue;
 352                      }
 353  
 354                      $pos = utf8_strpos($text, $match[1]);
 355                      if ($pos !== false)
 356                      {
 357                          $word_indizes[] = $pos;
 358                      }
 359                  }
 360              }
 361          }
 362          unset($match);
 363  
 364          if (sizeof($word_indizes))
 365          {
 366              $word_indizes = array_unique($word_indizes);
 367              sort($word_indizes);
 368  
 369              $wordnum = sizeof($word_indizes);
 370              // number of characters on the right and left side of each word
 371              $sequence_length = (int) ($length / (2 * $wordnum)) - 2;
 372              $final_text = '';
 373              $word = $j = 0;
 374              $final_text_index = -1;
 375  
 376              // cycle through every character in the original text
 377              for ($i = $word_indizes[$word], $n = utf8_strlen($text); $i < $n; $i++)
 378              {
 379                  // if the current position is the start of one of the words then append $sequence_length characters to the final text
 380                  if (isset($word_indizes[$word]) && ($i == $word_indizes[$word]))
 381                  {
 382                      if ($final_text_index < $i - $sequence_length - 1)
 383                      {
 384                          $final_text .= '... ' . preg_replace('#^([^ ]*)#', '', utf8_substr($text, $i - $sequence_length, $sequence_length));
 385                      }
 386                      else
 387                      {
 388                          // if the final text is already nearer to the current word than $sequence_length we only append the text
 389                          // from its current index on and distribute the unused length to all other sequenes
 390                          $sequence_length += (int) (($final_text_index - $i + $sequence_length + 1) / (2 * $wordnum));
 391                          $final_text .= utf8_substr($text, $final_text_index + 1, $i - $final_text_index - 1);
 392                      }
 393                      $final_text_index = $i - 1;
 394  
 395                      // add the following characters to the final text (see below)
 396                      $word++;
 397                      $j = 1;
 398                  }
 399  
 400                  if ($j > 0)
 401                  {
 402                      // add the character to the final text and increment the sequence counter
 403                      $final_text .= utf8_substr($text, $i, 1);
 404                      $final_text_index++;
 405                      $j++;
 406  
 407                      // if this is a whitespace then check whether we are done with this sequence
 408                      if (utf8_substr($text, $i, 1) == ' ')
 409                      {
 410                          // only check whether we have to exit the context generation completely if we haven't already reached the end anyway
 411                          if ($i + 4 < $n)
 412                          {
 413                              if (($j > $sequence_length && $word >= $wordnum) || utf8_strlen($final_text) > $length)
 414                              {
 415                                  $final_text .= ' ...';
 416                                  break;
 417                              }
 418                          }
 419                          else
 420                          {
 421                              // make sure the text really reaches the end
 422                              $j -= 4;
 423                          }
 424  
 425                          // stop context generation and wait for the next word
 426                          if ($j > $sequence_length)
 427                          {
 428                              $j = 0;
 429                          }
 430                      }
 431                  }
 432              }
 433              return str_replace($characters, $entities, $final_text);
 434          }
 435      }
 436  
 437      if (!sizeof($words) || !sizeof($word_indizes))
 438      {
 439          return str_replace($characters, $entities, ((utf8_strlen($text) >= $length + 3) ? utf8_substr($text, 0, $length) . '...' : $text));
 440      }
 441  }
 442  
 443  /**
 444  * Cleans a search string by removing single wildcards from it and replacing multiple spaces with a single one.
 445  *
 446  * @param string $search_string The full search string which should be cleaned.
 447  *
 448  * @return string The cleaned search string without any wildcards and multiple spaces.
 449  */
 450  function phpbb_clean_search_string($search_string)
 451  {
 452      // This regular expressions matches every single wildcard.
 453      // That means one after a whitespace or the beginning of the string or one before a whitespace or the end of the string.
 454      $search_string = preg_replace('#(?<=^|\s)\*+(?=\s|$)#', '', $search_string);
 455      $search_string = trim($search_string);
 456      $search_string = preg_replace(array('#\s+#u', '#\*+#u'), array(' ', '*'), $search_string);
 457      return $search_string;
 458  }
 459  
 460  /**
 461  * Decode text whereby text is coming from the db and expected to be pre-parsed content
 462  * We are placing this outside of the message parser because we are often in need of it...
 463  *
 464  * NOTE: special chars are kept encoded
 465  *
 466  * @param string &$message Original message, passed by reference
 467  * @param string $bbcode_uid BBCode UID
 468  * @return null
 469  */
 470  function decode_message(&$message, $bbcode_uid = '')
 471  {
 472      global $phpbb_container, $phpbb_dispatcher;
 473  
 474      /**
 475       * Use this event to modify the message before it is decoded
 476       *
 477       * @event core.decode_message_before
 478       * @var string    message_text    The message content
 479       * @var string    bbcode_uid        The message BBCode UID
 480       * @since 3.1.9-RC1
 481       */
 482      $message_text = $message;
 483      $vars = array('message_text', 'bbcode_uid');
 484      extract($phpbb_dispatcher->trigger_event('core.decode_message_before', compact($vars)));
 485      $message = $message_text;
 486  
 487      if (preg_match('#^<[rt][ >]#', $message))
 488      {
 489          $message = htmlspecialchars($phpbb_container->get('text_formatter.utils')->unparse($message), ENT_COMPAT);
 490      }
 491      else
 492      {
 493          if ($bbcode_uid)
 494          {
 495              $match = array('<br />', "[/*:m:$bbcode_uid]", ":u:$bbcode_uid", ":o:$bbcode_uid", ":$bbcode_uid");
 496              $replace = array("\n", '', '', '', '');
 497          }
 498          else
 499          {
 500              $match = array('<br />');
 501              $replace = array("\n");
 502          }
 503  
 504          $message = str_replace($match, $replace, $message);
 505  
 506          $match = get_preg_expression('bbcode_htm');
 507          $replace = array('\1', '\1', '\2', '\2', '\1', '', '');
 508  
 509          $message = preg_replace($match, $replace, $message);
 510      }
 511  
 512      /**
 513      * Use this event to modify the message after it is decoded
 514      *
 515      * @event core.decode_message_after
 516      * @var string    message_text    The message content
 517      * @var string    bbcode_uid        The message BBCode UID
 518      * @since 3.1.9-RC1
 519      */
 520      $message_text = $message;
 521      $vars = array('message_text', 'bbcode_uid');
 522      extract($phpbb_dispatcher->trigger_event('core.decode_message_after', compact($vars)));
 523      $message = $message_text;
 524  }
 525  
 526  /**
 527  * Strips all bbcode from a text in place
 528  */
 529  function strip_bbcode(&$text, $uid = '')
 530  {
 531      global $phpbb_container;
 532  
 533      if (preg_match('#^<[rt][ >]#', $text))
 534      {
 535          $text = $phpbb_container->get('text_formatter.utils')->clean_formatting($text);
 536      }
 537      else
 538      {
 539          if (!$uid)
 540          {
 541              $uid = '[0-9a-z]{5,}';
 542          }
 543  
 544          $text = preg_replace("#\[\/?[a-z0-9\*\+\-]+(?:=(?:&quot;.*&quot;|[^\]]*))?(?::[a-z])?(\:$uid)\]#", ' ', $text);
 545  
 546          $match = get_preg_expression('bbcode_htm');
 547          $replace = array('\1', '\1', '\2', '\1', '', '');
 548  
 549          $text = preg_replace($match, $replace, $text);
 550      }
 551  }
 552  
 553  /**
 554  * For display of custom parsed text on user-facing pages
 555  * Expects $text to be the value directly from the database (stored value)
 556  */
 557  function generate_text_for_display($text, $uid, $bitfield, $flags, $censor_text = true)
 558  {
 559      static $bbcode;
 560      global $phpbb_dispatcher, $phpbb_container;
 561  
 562      if ($text === '')
 563      {
 564          return '';
 565      }
 566  
 567      /**
 568      * Use this event to modify the text before it is parsed
 569      *
 570      * @event core.modify_text_for_display_before
 571      * @var string    text            The text to parse
 572      * @var string    uid                The BBCode UID
 573      * @var string    bitfield        The BBCode Bitfield
 574      * @var int        flags            The BBCode Flags
 575      * @var bool        censor_text        Whether or not to apply word censors
 576      * @since 3.1.0-a1
 577      */
 578      $vars = array('text', 'uid', 'bitfield', 'flags', 'censor_text');
 579      extract($phpbb_dispatcher->trigger_event('core.modify_text_for_display_before', compact($vars)));
 580  
 581      if (preg_match('#^<[rt][ >]#', $text))
 582      {
 583          $renderer = $phpbb_container->get('text_formatter.renderer');
 584  
 585          // Temporarily switch off viewcensors if applicable
 586          $old_censor = $renderer->get_viewcensors();
 587          if ($old_censor !== $censor_text)
 588          {
 589              $renderer->set_viewcensors($censor_text);
 590          }
 591  
 592          $text = $renderer->render($text);
 593  
 594          // Restore the previous value
 595          if ($old_censor !== $censor_text)
 596          {
 597              $renderer->set_viewcensors($old_censor);
 598          }
 599      }
 600      else
 601      {
 602          if ($censor_text)
 603          {
 604              $text = censor_text($text);
 605          }
 606  
 607          // Parse bbcode if bbcode uid stored and bbcode enabled
 608          if ($uid && ($flags & OPTION_FLAG_BBCODE))
 609          {
 610              if (!class_exists('bbcode'))
 611              {
 612                  global $phpbb_root_path, $phpEx;
 613                  include($phpbb_root_path . 'includes/bbcode.' . $phpEx);
 614              }
 615  
 616              if (empty($bbcode))
 617              {
 618                  $bbcode = new bbcode($bitfield);
 619              }
 620              else
 621              {
 622                  $bbcode->bbcode($bitfield);
 623              }
 624  
 625              $bbcode->bbcode_second_pass($text, $uid);
 626          }
 627  
 628          $text = bbcode_nl2br($text);
 629          $text = smiley_text($text, !($flags & OPTION_FLAG_SMILIES));
 630      }
 631  
 632      /**
 633      * Use this event to modify the text after it is parsed
 634      *
 635      * @event core.modify_text_for_display_after
 636      * @var string    text        The text to parse
 637      * @var string    uid            The BBCode UID
 638      * @var string    bitfield    The BBCode Bitfield
 639      * @var int        flags        The BBCode Flags
 640      * @since 3.1.0-a1
 641      */
 642      $vars = array('text', 'uid', 'bitfield', 'flags');
 643      extract($phpbb_dispatcher->trigger_event('core.modify_text_for_display_after', compact($vars)));
 644  
 645      return $text;
 646  }
 647  
 648  /**
 649  * For parsing custom parsed text to be stored within the database.
 650  * This function additionally returns the uid and bitfield that needs to be stored.
 651  * Expects $text to be the value directly from $request->variable() and in it's non-parsed form
 652  *
 653  * @param string $text The text to be replaced with the parsed one
 654  * @param string $uid The BBCode uid for this parse
 655  * @param string $bitfield The BBCode bitfield for this parse
 656  * @param int $flags The allow_bbcode, allow_urls and allow_smilies compiled into a single integer.
 657  * @param bool $allow_bbcode If BBCode is allowed (i.e. if BBCode is parsed)
 658  * @param bool $allow_urls If urls is allowed
 659  * @param bool $allow_smilies If smilies are allowed
 660  * @param bool $allow_img_bbcode
 661  * @param bool $allow_flash_bbcode
 662  * @param bool $allow_quote_bbcode
 663  * @param bool $allow_url_bbcode
 664  * @param string $mode Mode to parse text as, e.g. post or sig
 665  *
 666  * @return array    An array of string with the errors that occurred while parsing
 667  */
 668  function generate_text_for_storage(&$text, &$uid, &$bitfield, &$flags, $allow_bbcode = false, $allow_urls = false, $allow_smilies = false, $allow_img_bbcode = true, $allow_flash_bbcode = true, $allow_quote_bbcode = true, $allow_url_bbcode = true, $mode = 'post')
 669  {
 670      global $phpbb_root_path, $phpEx, $phpbb_dispatcher;
 671  
 672      /**
 673      * Use this event to modify the text before it is prepared for storage
 674      *
 675      * @event core.modify_text_for_storage_before
 676      * @var string    text            The text to parse
 677      * @var string    uid                The BBCode UID
 678      * @var string    bitfield        The BBCode Bitfield
 679      * @var int        flags            The BBCode Flags
 680      * @var bool        allow_bbcode    Whether or not to parse BBCode
 681      * @var bool        allow_urls        Whether or not to parse URLs
 682      * @var bool        allow_smilies    Whether or not to parse Smilies
 683      * @var bool        allow_img_bbcode    Whether or not to parse the [img] BBCode
 684      * @var bool        allow_flash_bbcode    Whether or not to parse the [flash] BBCode
 685      * @var bool        allow_quote_bbcode    Whether or not to parse the [quote] BBCode
 686      * @var bool        allow_url_bbcode    Whether or not to parse the [url] BBCode
 687      * @var string    mode                Mode to parse text as, e.g. post or sig
 688      * @since 3.1.0-a1
 689      * @changed 3.2.0-a1
 690      */
 691      $vars = array(
 692          'text',
 693          'uid',
 694          'bitfield',
 695          'flags',
 696          'allow_bbcode',
 697          'allow_urls',
 698          'allow_smilies',
 699          'allow_img_bbcode',
 700          'allow_flash_bbcode',
 701          'allow_quote_bbcode',
 702          'allow_url_bbcode',
 703          'mode',
 704      );
 705      extract($phpbb_dispatcher->trigger_event('core.modify_text_for_storage_before', compact($vars)));
 706  
 707      $uid = $bitfield = '';
 708      $flags = (($allow_bbcode) ? OPTION_FLAG_BBCODE : 0) + (($allow_smilies) ? OPTION_FLAG_SMILIES : 0) + (($allow_urls) ? OPTION_FLAG_LINKS : 0);
 709  
 710      if (!class_exists('parse_message'))
 711      {
 712          include($phpbb_root_path . 'includes/message_parser.' . $phpEx);
 713      }
 714  
 715      $message_parser = new parse_message($text);
 716      $message_parser->parse($allow_bbcode, $allow_urls, $allow_smilies, $allow_img_bbcode, $allow_flash_bbcode, $allow_quote_bbcode, $allow_url_bbcode, true, $mode);
 717  
 718      $text = $message_parser->message;
 719      $uid = $message_parser->bbcode_uid;
 720  
 721      // If the bbcode_bitfield is empty, there is no need for the uid to be stored.
 722      if (!$message_parser->bbcode_bitfield)
 723      {
 724          $uid = '';
 725      }
 726  
 727      $bitfield = $message_parser->bbcode_bitfield;
 728  
 729      /**
 730      * Use this event to modify the text after it is prepared for storage
 731      *
 732      * @event core.modify_text_for_storage_after
 733      * @var string    text            The text to parse
 734      * @var string    uid                The BBCode UID
 735      * @var string    bitfield        The BBCode Bitfield
 736      * @var int        flags            The BBCode Flags
 737      * @since 3.1.0-a1
 738      */
 739      $vars = array('text', 'uid', 'bitfield', 'flags');
 740      extract($phpbb_dispatcher->trigger_event('core.modify_text_for_storage_after', compact($vars)));
 741  
 742      return $message_parser->warn_msg;
 743  }
 744  
 745  /**
 746  * For decoding custom parsed text for edits as well as extracting the flags
 747  * Expects $text to be the value directly from the database (pre-parsed content)
 748  */
 749  function generate_text_for_edit($text, $uid, $flags)
 750  {
 751      global $phpbb_dispatcher;
 752  
 753      /**
 754      * Use this event to modify the text before it is decoded for editing
 755      *
 756      * @event core.modify_text_for_edit_before
 757      * @var string    text            The text to parse
 758      * @var string    uid                The BBCode UID
 759      * @var int        flags            The BBCode Flags
 760      * @since 3.1.0-a1
 761      */
 762      $vars = array('text', 'uid', 'flags');
 763      extract($phpbb_dispatcher->trigger_event('core.modify_text_for_edit_before', compact($vars)));
 764  
 765      decode_message($text, $uid);
 766  
 767      /**
 768      * Use this event to modify the text after it is decoded for editing
 769      *
 770      * @event core.modify_text_for_edit_after
 771      * @var string    text            The text to parse
 772      * @var int        flags            The BBCode Flags
 773      * @since 3.1.0-a1
 774      */
 775      $vars = array('text', 'flags');
 776      extract($phpbb_dispatcher->trigger_event('core.modify_text_for_edit_after', compact($vars)));
 777  
 778      return array(
 779          'allow_bbcode'    => ($flags & OPTION_FLAG_BBCODE) ? 1 : 0,
 780          'allow_smilies'    => ($flags & OPTION_FLAG_SMILIES) ? 1 : 0,
 781          'allow_urls'    => ($flags & OPTION_FLAG_LINKS) ? 1 : 0,
 782          'text'            => $text
 783      );
 784  }
 785  
 786  /**
 787  * A subroutine of make_clickable used with preg_replace
 788  * It places correct HTML around an url, shortens the displayed text
 789  * and makes sure no entities are inside URLs
 790  */
 791  function make_clickable_callback($type, $whitespace, $url, $relative_url, $class)
 792  {
 793      $orig_url        = $url;
 794      $orig_relative    = $relative_url;
 795      $append            = '';
 796      $url            = htmlspecialchars_decode($url);
 797      $relative_url    = htmlspecialchars_decode($relative_url);
 798  
 799      // make sure no HTML entities were matched
 800      $chars = array('<', '>', '"');
 801      $split = false;
 802  
 803      foreach ($chars as $char)
 804      {
 805          $next_split = strpos($url, $char);
 806          if ($next_split !== false)
 807          {
 808              $split = ($split !== false) ? min($split, $next_split) : $next_split;
 809          }
 810      }
 811  
 812      if ($split !== false)
 813      {
 814          // an HTML entity was found, so the URL has to end before it
 815          $append            = substr($url, $split) . $relative_url;
 816          $url            = substr($url, 0, $split);
 817          $relative_url    = '';
 818      }
 819      else if ($relative_url)
 820      {
 821          // same for $relative_url
 822          $split = false;
 823          foreach ($chars as $char)
 824          {
 825              $next_split = strpos($relative_url, $char);
 826              if ($next_split !== false)
 827              {
 828                  $split = ($split !== false) ? min($split, $next_split) : $next_split;
 829              }
 830          }
 831  
 832          if ($split !== false)
 833          {
 834              $append            = substr($relative_url, $split);
 835              $relative_url    = substr($relative_url, 0, $split);
 836          }
 837      }
 838  
 839      // if the last character of the url is a punctuation mark, exclude it from the url
 840      $last_char = ($relative_url) ? $relative_url[strlen($relative_url) - 1] : $url[strlen($url) - 1];
 841  
 842      switch ($last_char)
 843      {
 844          case '.':
 845          case '?':
 846          case '!':
 847          case ':':
 848          case ',':
 849              $append = $last_char;
 850              if ($relative_url)
 851              {
 852                  $relative_url = substr($relative_url, 0, -1);
 853              }
 854              else
 855              {
 856                  $url = substr($url, 0, -1);
 857              }
 858          break;
 859  
 860          // set last_char to empty here, so the variable can be used later to
 861          // check whether a character was removed
 862          default:
 863              $last_char = '';
 864          break;
 865      }
 866  
 867      $short_url = (utf8_strlen($url) > 55) ? utf8_substr($url, 0, 39) . ' ... ' . utf8_substr($url, -10) : $url;
 868  
 869      switch ($type)
 870      {
 871          case MAGIC_URL_LOCAL:
 872              $tag            = 'l';
 873              $relative_url    = preg_replace('/[&?]sid=[0-9a-f]{32}$/', '', preg_replace('/([&?])sid=[0-9a-f]{32}&/', '$1', $relative_url));
 874              $url            = $url . '/' . $relative_url;
 875              $text            = $relative_url;
 876  
 877              // this url goes to http://domain.tld/path/to/board/ which
 878              // would result in an empty link if treated as local so
 879              // don't touch it and let MAGIC_URL_FULL take care of it.
 880              if (!$relative_url)
 881              {
 882                  return $whitespace . $orig_url . '/' . $orig_relative; // slash is taken away by relative url pattern
 883              }
 884          break;
 885  
 886          case MAGIC_URL_FULL:
 887              $tag    = 'm';
 888              $text    = $short_url;
 889          break;
 890  
 891          case MAGIC_URL_WWW:
 892              $tag    = 'w';
 893              $url    = 'http://' . $url;
 894              $text    = $short_url;
 895          break;
 896  
 897          case MAGIC_URL_EMAIL:
 898              $tag    = 'e';
 899              $text    = $short_url;
 900              $url    = 'mailto:' . $url;
 901          break;
 902      }
 903  
 904      $url    = htmlspecialchars($url);
 905      $text    = htmlspecialchars($text);
 906      $append    = htmlspecialchars($append);
 907  
 908      $html    = "$whitespace<!-- $tag --><a$class href=\"$url\">$text</a><!-- $tag -->$append";
 909  
 910      return $html;
 911  }
 912  
 913  /**
 914  * make_clickable function
 915  *
 916  * Replace magic urls of form http://xxx.xxx., www.xxx. and xxx@xxx.xxx.
 917  * Cuts down displayed size of link if over 50 chars, turns absolute links
 918  * into relative versions when the server/script path matches the link
 919  */
 920  function make_clickable($text, $server_url = false, $class = 'postlink')
 921  {
 922      if ($server_url === false)
 923      {
 924          $server_url = generate_board_url();
 925      }
 926  
 927      static $static_class;
 928      static $magic_url_match_args;
 929  
 930      if (!isset($magic_url_match_args[$server_url]) || $static_class != $class)
 931      {
 932          $static_class = $class;
 933          $class = ($static_class) ? ' class="' . $static_class . '"' : '';
 934          $local_class = ($static_class) ? ' class="' . $static_class . '-local"' : '';
 935  
 936          if (!is_array($magic_url_match_args))
 937          {
 938              $magic_url_match_args = array();
 939          }
 940  
 941          // relative urls for this board
 942          $magic_url_match_args[$server_url][] = array(
 943              '#(^|[\n\t (>.])(' . preg_quote($server_url, '#') . ')/(' . get_preg_expression('relative_url_inline') . ')#iu',
 944              MAGIC_URL_LOCAL,
 945              $local_class,
 946          );
 947  
 948          // matches a xxxx://aaaaa.bbb.cccc. ...
 949          $magic_url_match_args[$server_url][] = array(
 950              '#(^|[\n\t (>.])(' . get_preg_expression('url_inline') . ')#iu',
 951              MAGIC_URL_FULL,
 952              $class,
 953          );
 954  
 955          // matches a "www.xxxx.yyyy[/zzzz]" kinda lazy URL thing
 956          $magic_url_match_args[$server_url][] = array(
 957              '#(^|[\n\t (>])(' . get_preg_expression('www_url_inline') . ')#iu',
 958              MAGIC_URL_WWW,
 959              $class,
 960          );
 961  
 962          // matches an email@domain type address at the start of a line, or after a space or after what might be a BBCode.
 963          $magic_url_match_args[$server_url][] = array(
 964              '/(^|[\n\t (>])(' . get_preg_expression('email') . ')/iu',
 965              MAGIC_URL_EMAIL,
 966              '',
 967          );
 968      }
 969  
 970      foreach ($magic_url_match_args[$server_url] as $magic_args)
 971      {
 972          if (preg_match($magic_args[0], $text, $matches))
 973          {
 974              $text = preg_replace_callback($magic_args[0], function($matches) use ($magic_args)
 975              {
 976                  $relative_url = isset($matches[3]) ? $matches[3] : '';
 977                  return make_clickable_callback($magic_args[1], $matches[1], $matches[2], $relative_url, $magic_args[2]);
 978              }, $text);
 979          }
 980      }
 981  
 982      return $text;
 983  }
 984  
 985  /**
 986  * Censoring
 987  */
 988  function censor_text($text)
 989  {
 990      static $censors;
 991  
 992      // Nothing to do?
 993      if ($text === '')
 994      {
 995          return '';
 996      }
 997  
 998      // We moved the word censor checks in here because we call this function quite often - and then only need to do the check once
 999      if (!isset($censors) || !is_array($censors))
1000      {
1001          global $config, $user, $auth, $cache;
1002  
1003          // We check here if the user is having viewing censors disabled (and also allowed to do so).
1004          if (!$user->optionget('viewcensors') && $config['allow_nocensors'] && $auth->acl_get('u_chgcensors'))
1005          {
1006              $censors = array();
1007          }
1008          else
1009          {
1010              $censors = $cache->obtain_word_list();
1011          }
1012      }
1013  
1014      if (sizeof($censors))
1015      {
1016          return preg_replace($censors['match'], $censors['replace'], $text);
1017      }
1018  
1019      return $text;
1020  }
1021  
1022  /**
1023  * custom version of nl2br which takes custom BBCodes into account
1024  */
1025  function bbcode_nl2br($text)
1026  {
1027      // custom BBCodes might contain carriage returns so they
1028      // are not converted into <br /> so now revert that
1029      $text = str_replace(array("\n", "\r"), array('<br />', "\n"), $text);
1030      return $text;
1031  }
1032  
1033  /**
1034  * Smiley processing
1035  */
1036  function smiley_text($text, $force_option = false)
1037  {
1038      global $config, $user, $phpbb_path_helper, $phpbb_dispatcher;
1039  
1040      if ($force_option || !$config['allow_smilies'] || !$user->optionget('viewsmilies'))
1041      {
1042          return preg_replace('#<!\-\- s(.*?) \-\-><img src="\{SMILIES_PATH\}\/.*? \/><!\-\- s\1 \-\->#', '\1', $text);
1043      }
1044      else
1045      {
1046          $root_path = (defined('PHPBB_USE_BOARD_URL_PATH') && PHPBB_USE_BOARD_URL_PATH) ? generate_board_url() . '/' : $phpbb_path_helper->get_web_root_path();
1047  
1048          /**
1049          * Event to override the root_path for smilies
1050          *
1051          * @event core.smiley_text_root_path
1052          * @var string root_path root_path for smilies
1053          * @since 3.1.11-RC1
1054          */
1055          $vars = array('root_path');
1056          extract($phpbb_dispatcher->trigger_event('core.smiley_text_root_path', compact($vars)));
1057          return preg_replace('#<!\-\- s(.*?) \-\-><img src="\{SMILIES_PATH\}\/(.*?) \/><!\-\- s\1 \-\->#', '<img class="smilies" src="' . $root_path . $config['smilies_path'] . '/\2 />', $text);
1058      }
1059  }
1060  
1061  /**
1062  * General attachment parsing
1063  *
1064  * @param mixed $forum_id The forum id the attachments are displayed in (false if in private message)
1065  * @param string &$message The post/private message
1066  * @param array &$attachments The attachments to parse for (inline) display. The attachments array will hold templated data after parsing.
1067  * @param array &$update_count_ary The attachment counts to be updated - will be filled
1068  * @param bool $preview If set to true the attachments are parsed for preview. Within preview mode the comments are fetched from the given $attachments array and not fetched from the database.
1069  */
1070  function parse_attachments($forum_id, &$message, &$attachments, &$update_count_ary, $preview = false)
1071  {
1072      if (!sizeof($attachments))
1073      {
1074          return;
1075      }
1076  
1077      global $template, $cache, $user, $phpbb_dispatcher;
1078      global $extensions, $config, $phpbb_root_path, $phpEx;
1079  
1080      //
1081      $compiled_attachments = array();
1082  
1083      if (!isset($template->filename['attachment_tpl']))
1084      {
1085          $template->set_filenames(array(
1086              'attachment_tpl'    => 'attachment.html')
1087          );
1088      }
1089  
1090      if (empty($extensions) || !is_array($extensions))
1091      {
1092          $extensions = $cache->obtain_attach_extensions($forum_id);
1093      }
1094  
1095      // Look for missing attachment information...
1096      $attach_ids = array();
1097      foreach ($attachments as $pos => $attachment)
1098      {
1099          // If is_orphan is set, we need to retrieve the attachments again...
1100          if (!isset($attachment['extension']) && !isset($attachment['physical_filename']))
1101          {
1102              $attach_ids[(int) $attachment['attach_id']] = $pos;
1103          }
1104      }
1105  
1106      // Grab attachments (security precaution)
1107      if (sizeof($attach_ids))
1108      {
1109          global $db;
1110  
1111          $new_attachment_data = array();
1112  
1113          $sql = 'SELECT *
1114              FROM ' . ATTACHMENTS_TABLE . '
1115              WHERE ' . $db->sql_in_set('attach_id', array_keys($attach_ids));
1116          $result = $db->sql_query($sql);
1117  
1118          while ($row = $db->sql_fetchrow($result))
1119          {
1120              if (!isset($attach_ids[$row['attach_id']]))
1121              {
1122                  continue;
1123              }
1124  
1125              // If we preview attachments we will set some retrieved values here
1126              if ($preview)
1127              {
1128                  $row['attach_comment'] = $attachments[$attach_ids[$row['attach_id']]]['attach_comment'];
1129              }
1130  
1131              $new_attachment_data[$attach_ids[$row['attach_id']]] = $row;
1132          }
1133          $db->sql_freeresult($result);
1134  
1135          $attachments = $new_attachment_data;
1136          unset($new_attachment_data);
1137      }
1138  
1139      // Make sure attachments are properly ordered
1140      ksort($attachments);
1141  
1142      foreach ($attachments as $attachment)
1143      {
1144          if (!sizeof($attachment))
1145          {
1146              continue;
1147          }
1148  
1149          // We need to reset/empty the _file block var, because this function might be called more than once
1150          $template->destroy_block_vars('_file');
1151  
1152          $block_array = array();
1153  
1154          // Some basics...
1155          $attachment['extension'] = strtolower(trim($attachment['extension']));
1156          $filename = $phpbb_root_path . $config['upload_path'] . '/' . utf8_basename($attachment['physical_filename']);
1157  
1158          $upload_icon = '';
1159  
1160          if (isset($extensions[$attachment['extension']]))
1161          {
1162              if ($user->img('icon_topic_attach', '') && !$extensions[$attachment['extension']]['upload_icon'])
1163              {
1164                  $upload_icon = $user->img('icon_topic_attach', '');
1165              }
1166              else if ($extensions[$attachment['extension']]['upload_icon'])
1167              {
1168                  $upload_icon = '<img src="' . $phpbb_root_path . $config['upload_icons_path'] . '/' . trim($extensions[$attachment['extension']]['upload_icon']) . '" alt="" />';
1169              }
1170          }
1171  
1172          $filesize = get_formatted_filesize($attachment['filesize'], false);
1173  
1174          $comment = bbcode_nl2br(censor_text($attachment['attach_comment']));
1175  
1176          $block_array += array(
1177              'UPLOAD_ICON'        => $upload_icon,
1178              'FILESIZE'            => $filesize['value'],
1179              'SIZE_LANG'            => $filesize['unit'],
1180              'DOWNLOAD_NAME'        => utf8_basename($attachment['real_filename']),
1181              'COMMENT'            => $comment,
1182          );
1183  
1184          $denied = false;
1185  
1186          if (!extension_allowed($forum_id, $attachment['extension'], $extensions))
1187          {
1188              $denied = true;
1189  
1190              $block_array += array(
1191                  'S_DENIED'            => true,
1192                  'DENIED_MESSAGE'    => sprintf($user->lang['EXTENSION_DISABLED_AFTER_POSTING'], $attachment['extension'])
1193              );
1194          }
1195  
1196          if (!$denied)
1197          {
1198              $display_cat = $extensions[$attachment['extension']]['display_cat'];
1199  
1200              if ($display_cat == ATTACHMENT_CATEGORY_IMAGE)
1201              {
1202                  if ($attachment['thumbnail'])
1203                  {
1204                      $display_cat = ATTACHMENT_CATEGORY_THUMB;
1205                  }
1206                  else
1207                  {
1208                      if ($config['img_display_inlined'])
1209                      {
1210                          if ($config['img_link_width'] || $config['img_link_height'])
1211                          {
1212                              $dimension = @getimagesize($filename);
1213  
1214                              // If the dimensions could not be determined or the image being 0x0 we display it as a link for safety purposes
1215                              if ($dimension === false || empty($dimension[0]) || empty($dimension[1]))
1216                              {
1217                                  $display_cat = ATTACHMENT_CATEGORY_NONE;
1218                              }
1219                              else
1220                              {
1221                                  $display_cat = ($dimension[0] <= $config['img_link_width'] && $dimension[1] <= $config['img_link_height']) ? ATTACHMENT_CATEGORY_IMAGE : ATTACHMENT_CATEGORY_NONE;
1222                              }
1223                          }
1224                      }
1225                      else
1226                      {
1227                          $display_cat = ATTACHMENT_CATEGORY_NONE;
1228                      }
1229                  }
1230              }
1231  
1232              // Make some descisions based on user options being set.
1233              if (($display_cat == ATTACHMENT_CATEGORY_IMAGE || $display_cat == ATTACHMENT_CATEGORY_THUMB) && !$user->optionget('viewimg'))
1234              {
1235                  $display_cat = ATTACHMENT_CATEGORY_NONE;
1236              }
1237  
1238              if ($display_cat == ATTACHMENT_CATEGORY_FLASH && !$user->optionget('viewflash'))
1239              {
1240                  $display_cat = ATTACHMENT_CATEGORY_NONE;
1241              }
1242  
1243              $download_link = append_sid("{$phpbb_root_path}download/file.$phpEx", 'id=' . $attachment['attach_id']);
1244              $l_downloaded_viewed = 'VIEWED_COUNTS';
1245  
1246              switch ($display_cat)
1247              {
1248                  // Images
1249                  case ATTACHMENT_CATEGORY_IMAGE:
1250                      $inline_link = append_sid("{$phpbb_root_path}download/file.$phpEx", 'id=' . $attachment['attach_id']);
1251                      $download_link .= '&amp;mode=view';
1252  
1253                      $block_array += array(
1254                          'S_IMAGE'        => true,
1255                          'U_INLINE_LINK'        => $inline_link,
1256                      );
1257  
1258                      $update_count_ary[] = $attachment['attach_id'];
1259                  break;
1260  
1261                  // Images, but display Thumbnail
1262                  case ATTACHMENT_CATEGORY_THUMB:
1263                      $thumbnail_link = append_sid("{$phpbb_root_path}download/file.$phpEx", 'id=' . $attachment['attach_id'] . '&amp;t=1');
1264                      $download_link .= '&amp;mode=view';
1265  
1266                      $block_array += array(
1267                          'S_THUMBNAIL'        => true,
1268                          'THUMB_IMAGE'        => $thumbnail_link,
1269                      );
1270  
1271                      $update_count_ary[] = $attachment['attach_id'];
1272                  break;
1273  
1274                  // Macromedia Flash Files
1275                  case ATTACHMENT_CATEGORY_FLASH:
1276                      list($width, $height) = @getimagesize($filename);
1277  
1278                      $block_array += array(
1279                          'S_FLASH_FILE'    => true,
1280                          'WIDTH'            => $width,
1281                          'HEIGHT'        => $height,
1282                          'U_VIEW_LINK'    => $download_link . '&amp;view=1',
1283                      );
1284  
1285                      // Viewed/Heared File ... update the download count
1286                      $update_count_ary[] = $attachment['attach_id'];
1287                  break;
1288  
1289                  default:
1290                      $l_downloaded_viewed = 'DOWNLOAD_COUNTS';
1291  
1292                      $block_array += array(
1293                          'S_FILE'        => true,
1294                      );
1295                  break;
1296              }
1297  
1298              if (!isset($attachment['download_count']))
1299              {
1300                  $attachment['download_count'] = 0;
1301              }
1302  
1303              $block_array += array(
1304                  'U_DOWNLOAD_LINK'        => $download_link,
1305                  'L_DOWNLOAD_COUNT'        => $user->lang($l_downloaded_viewed, (int) $attachment['download_count']),
1306              );
1307          }
1308  
1309          $update_count = $update_count_ary;
1310          /**
1311          * Use this event to modify the attachment template data.
1312          *
1313          * This event is triggered once per attachment.
1314          *
1315          * @event core.parse_attachments_modify_template_data
1316          * @var array    attachment        Array with attachment data
1317          * @var array    block_array        Template data of the attachment
1318          * @var int        display_cat        Attachment category data
1319          * @var string    download_link    Attachment download link
1320          * @var array    extensions        Array with attachment extensions data
1321          * @var mixed     forum_id         The forum id the attachments are displayed in (false if in private message)
1322          * @var bool        preview            Flag indicating if we are in post preview mode
1323          * @var array    update_count    Array with attachment ids to update download count
1324          * @since 3.1.0-RC5
1325          */
1326          $vars = array(
1327              'attachment',
1328              'block_array',
1329              'display_cat',
1330              'download_link',
1331              'extensions',
1332              'forum_id',
1333              'preview',
1334              'update_count',
1335          );
1336          extract($phpbb_dispatcher->trigger_event('core.parse_attachments_modify_template_data', compact($vars)));
1337          $update_count_ary = $update_count;
1338          unset($update_count);
1339  
1340          $template->assign_block_vars('_file', $block_array);
1341  
1342          $compiled_attachments[] = $template->assign_display('attachment_tpl');
1343      }
1344  
1345      $attachments = $compiled_attachments;
1346      unset($compiled_attachments);
1347  
1348      $unset_tpl = array();
1349  
1350      preg_match_all('#<!\-\- ia([0-9]+) \-\->(.*?)<!\-\- ia\1 \-\->#', $message, $matches, PREG_PATTERN_ORDER);
1351  
1352      $replace = array();
1353      foreach ($matches[0] as $num => $capture)
1354      {
1355          $index = $matches[1][$num];
1356  
1357          $replace['from'][] = $matches[0][$num];
1358          $replace['to'][] = (isset($attachments[$index])) ? $attachments[$index] : sprintf($user->lang['MISSING_INLINE_ATTACHMENT'], $matches[2][array_search($index, $matches[1])]);
1359  
1360          $unset_tpl[] = $index;
1361      }
1362  
1363      if (isset($replace['from']))
1364      {
1365          $message = str_replace($replace['from'], $replace['to'], $message);
1366      }
1367  
1368      $unset_tpl = array_unique($unset_tpl);
1369  
1370      // Sort correctly
1371      if ($config['display_order'])
1372      {
1373          // Ascending sort
1374          krsort($attachments);
1375      }
1376      else
1377      {
1378          // Descending sort
1379          ksort($attachments);
1380      }
1381  
1382      // Needed to let not display the inlined attachments at the end of the post again
1383      foreach ($unset_tpl as $index)
1384      {
1385          unset($attachments[$index]);
1386      }
1387  }
1388  
1389  /**
1390  * Check if extension is allowed to be posted.
1391  *
1392  * @param mixed $forum_id The forum id to check or false if private message
1393  * @param string $extension The extension to check, for example zip.
1394  * @param array &$extensions The extension array holding the information from the cache (will be obtained if empty)
1395  *
1396  * @return bool False if the extension is not allowed to be posted, else true.
1397  */
1398  function extension_allowed($forum_id, $extension, &$extensions)
1399  {
1400      if (empty($extensions))
1401      {
1402          global $cache;
1403          $extensions = $cache->obtain_attach_extensions($forum_id);
1404      }
1405  
1406      return (!isset($extensions['_allowed_'][$extension])) ? false : true;
1407  }
1408  
1409  /**
1410  * Truncates string while retaining special characters if going over the max length
1411  * The default max length is 60 at the moment
1412  * The maximum storage length is there to fit the string within the given length. The string may be further truncated due to html entities.
1413  * For example: string given is 'a "quote"' (length: 9), would be a stored as 'a &quot;quote&quot;' (length: 19)
1414  *
1415  * @param string $string The text to truncate to the given length. String is specialchared.
1416  * @param int $max_length Maximum length of string (multibyte character count as 1 char / Html entity count as 1 char)
1417  * @param int $max_store_length Maximum character length of string (multibyte character count as 1 char / Html entity count as entity chars).
1418  * @param bool $allow_reply Allow Re: in front of string
1419  *     NOTE: This parameter can cause undesired behavior (returning strings longer than $max_store_length) and is deprecated.
1420  * @param string $append String to be appended
1421  */
1422  function truncate_string($string, $max_length = 60, $max_store_length = 255, $allow_reply = false, $append = '')
1423  {
1424      $strip_reply = false;
1425      $stripped = false;
1426      if ($allow_reply && strpos($string, 'Re: ') === 0)
1427      {
1428          $strip_reply = true;
1429          $string = substr($string, 4);
1430      }
1431  
1432      $_chars = utf8_str_split(htmlspecialchars_decode($string));
1433      $chars = array_map('utf8_htmlspecialchars', $_chars);
1434  
1435      // Now check the length ;)
1436      if (sizeof($chars) > $max_length)
1437      {
1438          // Cut off the last elements from the array
1439          $string = implode('', array_slice($chars, 0, $max_length - utf8_strlen($append)));
1440          $stripped = true;
1441      }
1442  
1443      // Due to specialchars, we may not be able to store the string...
1444      if (utf8_strlen($string) > $max_store_length)
1445      {
1446          // let's split again, we do not want half-baked strings where entities are split
1447          $_chars = utf8_str_split(htmlspecialchars_decode($string));
1448          $chars = array_map('utf8_htmlspecialchars', $_chars);
1449  
1450          do
1451          {
1452              array_pop($chars);
1453              $string = implode('', $chars);
1454          }
1455          while (!empty($chars) && utf8_strlen($string) > $max_store_length);
1456      }
1457  
1458      if ($strip_reply)
1459      {
1460          $string = 'Re: ' . $string;
1461      }
1462  
1463      if ($append != '' && $stripped)
1464      {
1465          $string = $string . $append;
1466      }
1467  
1468      return $string;
1469  }
1470  
1471  /**
1472  * Get username details for placing into templates.
1473  * This function caches all modes on first call, except for no_profile and anonymous user - determined by $user_id.
1474  *
1475  * @param string $mode Can be profile (for getting an url to the profile), username (for obtaining the username), colour (for obtaining the user colour), full (for obtaining a html string representing a coloured link to the users profile) or no_profile (the same as full but forcing no profile link)
1476  * @param int $user_id The users id
1477  * @param string $username The users name
1478  * @param string $username_colour The users colour
1479  * @param string $guest_username optional parameter to specify the guest username. It will be used in favor of the GUEST language variable then.
1480  * @param string $custom_profile_url optional parameter to specify a profile url. The user id get appended to this url as &amp;u={user_id}
1481  *
1482  * @return string A string consisting of what is wanted based on $mode.
1483  */
1484  function get_username_string($mode, $user_id, $username, $username_colour = '', $guest_username = false, $custom_profile_url = false)
1485  {
1486      static $_profile_cache;
1487      global $phpbb_dispatcher;
1488  
1489      // We cache some common variables we need within this function
1490      if (empty($_profile_cache))
1491      {
1492          global $phpbb_root_path, $phpEx;
1493  
1494          $_profile_cache['base_url'] = append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=viewprofile&amp;u={USER_ID}');
1495          $_profile_cache['tpl_noprofile'] = '<span class="username">{USERNAME}</span>';
1496          $_profile_cache['tpl_noprofile_colour'] = '<span style="color: {USERNAME_COLOUR};" class="username-coloured">{USERNAME}</span>';
1497          $_profile_cache['tpl_profile'] = '<a href="{PROFILE_URL}" class="username">{USERNAME}</a>';
1498          $_profile_cache['tpl_profile_colour'] = '<a href="{PROFILE_URL}" style="color: {USERNAME_COLOUR};" class="username-coloured">{USERNAME}</a>';
1499      }
1500  
1501      global $user, $auth;
1502  
1503      // This switch makes sure we only run code required for the mode
1504      switch ($mode)
1505      {
1506          case 'full':
1507          case 'no_profile':
1508          case 'colour':
1509  
1510              // Build correct username colour
1511              $username_colour = ($username_colour) ? '#' . $username_colour : '';
1512  
1513              // Return colour
1514              if ($mode == 'colour')
1515              {
1516                  $username_string = $username_colour;
1517                  break;
1518              }
1519  
1520          // no break;
1521  
1522          case 'username':
1523  
1524              // Build correct username
1525              if ($guest_username === false)
1526              {
1527                  $username = ($username) ? $username : $user->lang['GUEST'];
1528              }
1529              else
1530              {
1531                  $username = ($user_id && $user_id != ANONYMOUS) ? $username : ((!empty($guest_username)) ? $guest_username : $user->lang['GUEST']);
1532              }
1533  
1534              // Return username
1535              if ($mode == 'username')
1536              {
1537                  $username_string = $username;
1538                  break;
1539              }
1540  
1541          // no break;
1542  
1543          case 'profile':
1544  
1545              // Build correct profile url - only show if not anonymous and permission to view profile if registered user
1546              // For anonymous the link leads to a login page.
1547              if ($user_id && $user_id != ANONYMOUS && ($user->data['user_id'] == ANONYMOUS || $auth->acl_get('u_viewprofile')))
1548              {
1549                  $profile_url = ($custom_profile_url !== false) ? $custom_profile_url . '&amp;u=' . (int) $user_id : str_replace(array('={USER_ID}', '=%7BUSER_ID%7D'), '=' . (int) $user_id, $_profile_cache['base_url']);
1550              }
1551              else
1552              {
1553                  $profile_url = '';
1554              }
1555  
1556              // Return profile
1557              if ($mode == 'profile')
1558              {
1559                  $username_string = $profile_url;
1560                  break;
1561              }
1562  
1563          // no break;
1564      }
1565  
1566      if (!isset($username_string))
1567      {
1568          if (($mode == 'full' && !$profile_url) || $mode == 'no_profile')
1569          {
1570              $username_string = str_replace(array('{USERNAME_COLOUR}', '{USERNAME}'), array($username_colour, $username), (!$username_colour) ? $_profile_cache['tpl_noprofile'] : $_profile_cache['tpl_noprofile_colour']);
1571          }
1572          else
1573          {
1574              $username_string = str_replace(array('{PROFILE_URL}', '{USERNAME_COLOUR}', '{USERNAME}'), array($profile_url, $username_colour, $username), (!$username_colour) ? $_profile_cache['tpl_profile'] : $_profile_cache['tpl_profile_colour']);
1575          }
1576      }
1577  
1578      /**
1579      * Use this event to change the output of get_username_string()
1580      *
1581      * @event core.modify_username_string
1582      * @var string mode                profile|username|colour|full|no_profile
1583      * @var int user_id                String or array of additional url
1584      *                                parameters
1585      * @var string username            The user's username
1586      * @var string username_colour    The user's colour
1587      * @var string guest_username    Optional parameter to specify the
1588      *                                guest username.
1589      * @var string custom_profile_url Optional parameter to specify a
1590      *                                profile url.
1591      * @var string username_string    The string that has been generated
1592      * @var array _profile_cache        Array of original return templates
1593      * @since 3.1.0-a1
1594      */
1595      $vars = array(
1596          'mode',
1597          'user_id',
1598          'username',
1599          'username_colour',
1600          'guest_username',
1601          'custom_profile_url',
1602          'username_string',
1603          '_profile_cache',
1604      );
1605      extract($phpbb_dispatcher->trigger_event('core.modify_username_string', compact($vars)));
1606  
1607      return $username_string;
1608  }
1609  
1610  /**
1611   * Add an option to the quick-mod tools.
1612   *
1613   * @param string $url The recepting URL for the quickmod actions.
1614   * @param string $option The language key for the value of the option.
1615   * @param string $lang_string The language string to use.
1616   */
1617  function phpbb_add_quickmod_option($url, $option, $lang_string)
1618  {
1619      global $template, $user, $phpbb_path_helper;
1620  
1621      $lang_string = $user->lang($lang_string);
1622      $template->assign_block_vars('quickmod', array(
1623          'VALUE'        => $option,
1624          'TITLE'        => $lang_string,
1625          'LINK'        => $phpbb_path_helper->append_url_params($url, array('action' => $option)),
1626      ));
1627  }
1628  
1629  /**
1630  * Concatenate an array into a string list.
1631  *
1632  * @param array $items Array of items to concatenate
1633  * @param object $user The phpBB $user object.
1634  *
1635  * @return string String list. Examples: "A"; "A and B"; "A, B, and C"
1636  */
1637  function phpbb_generate_string_list($items, $user)
1638  {
1639      if (empty($items))
1640      {
1641          return '';
1642      }
1643  
1644      $count = sizeof($items);
1645      $last_item = array_pop($items);
1646      $lang_key = 'STRING_LIST_MULTI';
1647  
1648      if ($count == 1)
1649      {
1650          return $last_item;
1651      }
1652      else if ($count == 2)
1653      {
1654          $lang_key = 'STRING_LIST_SIMPLE';
1655      }
1656      $list = implode($user->lang['COMMA_SEPARATOR'], $items);
1657  
1658      return $user->lang($lang_key, $list, $last_item);
1659  }
1660  
1661  class bitfield
1662  {
1663      var $data;
1664  
1665  	function bitfield($bitfield = '')
1666      {
1667          $this->data = base64_decode($bitfield);
1668      }
1669  
1670      /**
1671      */
1672  	function get($n)
1673      {
1674          // Get the ($n / 8)th char
1675          $byte = $n >> 3;
1676  
1677          if (strlen($this->data) >= $byte + 1)
1678          {
1679              $c = $this->data[$byte];
1680  
1681              // Lookup the ($n % 8)th bit of the byte
1682              $bit = 7 - ($n & 7);
1683              return (bool) (ord($c) & (1 << $bit));
1684          }
1685          else
1686          {
1687              return false;
1688          }
1689      }
1690  
1691  	function set($n)
1692      {
1693          $byte = $n >> 3;
1694          $bit = 7 - ($n & 7);
1695  
1696          if (strlen($this->data) >= $byte + 1)
1697          {
1698              $this->data[$byte] = $this->data[$byte] | chr(1 << $bit);
1699          }
1700          else
1701          {
1702              $this->data .= str_repeat("\0", $byte - strlen($this->data));
1703              $this->data .= chr(1 << $bit);
1704          }
1705      }
1706  
1707  	function clear($n)
1708      {
1709          $byte = $n >> 3;
1710  
1711          if (strlen($this->data) >= $byte + 1)
1712          {
1713              $bit = 7 - ($n & 7);
1714              $this->data[$byte] = $this->data[$byte] &~ chr(1 << $bit);
1715          }
1716      }
1717  
1718  	function get_blob()
1719      {
1720          return $this->data;
1721      }
1722  
1723  	function get_base64()
1724      {
1725          return base64_encode($this->data);
1726      }
1727  
1728  	function get_bin()
1729      {
1730          $bin = '';
1731          $len = strlen($this->data);
1732  
1733          for ($i = 0; $i < $len; ++$i)
1734          {
1735              $bin .= str_pad(decbin(ord($this->data[$i])), 8, '0', STR_PAD_LEFT);
1736          }
1737  
1738          return $bin;
1739      }
1740  
1741  	function get_all_set()
1742      {
1743          return array_keys(array_filter(str_split($this->get_bin())));
1744      }
1745  
1746  	function merge($bitfield)
1747      {
1748          $this->data = $this->data | $bitfield->get_blob();
1749      }
1750  }


Generated: Sun Feb 19 19:47:08 2017 Cross-referenced by PHPXref 0.7.1