source: trunk/include/functions_html.inc.php @ 17975

Revision 17975, 15.8 KB checked in by rvelices, 7 years ago (diff)

distinguish event render_element name and description

  • Property svn:eol-style set to LF
RevLine 
[476]1<?php
2// +-----------------------------------------------------------------------+
[8728]3// | Piwigo - a PHP based photo gallery                                    |
[2297]4// +-----------------------------------------------------------------------+
[12920]5// | Copyright(C) 2008-2012 Piwigo Team                  http://piwigo.org |
[2297]6// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
7// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
8// +-----------------------------------------------------------------------+
9// | This program is free software; you can redistribute it and/or modify  |
10// | it under the terms of the GNU General Public License as published by  |
11// | the Free Software Foundation                                          |
12// |                                                                       |
13// | This program is distributed in the hope that it will be useful, but   |
14// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
15// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
16// | General Public License for more details.                              |
17// |                                                                       |
18// | You should have received a copy of the GNU General Public License     |
19// | along with this program; if not, write to the Free Software           |
20// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
21// | USA.                                                                  |
22// +-----------------------------------------------------------------------+
[476]23
[572]24/**
25 * returns the list of categories as a HTML string
26 *
27 * categories string returned contains categories as given in the input
[1866]28 * array $cat_informations. $cat_informations array must be an array
29 * of array( id=>?, name=>?, permalink=>?). If url input parameter is null,
[572]30 * returns only the categories name without links.
31 *
32 * @param array cat_informations
33 * @param string url
34 * @param boolean replace_space
35 * @return string
36 */
[569]37function get_cat_display_name($cat_informations,
[1092]38                              $url = '',
[569]39                              $replace_space = true)
[476]40{
[642]41  global $conf;
[1090]42
[5917]43  //$output = '<a href="'.get_absolute_root_url().$conf['home_page'].'">'.l10n('Home').'</a>';
44  $output = '';
[5924]45  $is_first=true;
[8247]46
[1866]47  foreach ($cat_informations as $cat)
[476]48  {
[1861]49    is_array($cat) or trigger_error(
[1866]50        'get_cat_display_name wrong type for category ', E_USER_WARNING
[1861]51      );
[2433]52
53    $cat['name'] = trigger_event(
54      'render_category_name',
55      $cat['name'],
56      'get_cat_display_name'
57      );
[5924]58
59    if ($is_first)
[5917]60    {
[5924]61      $is_first=false;
62    }
63    else
64    {
[5917]65      $output.= $conf['level_separator'];
66    }
[2433]67
[1092]68    if ( !isset($url) )
[569]69    {
[1861]70      $output.= $cat['name'];
[569]71    }
[1092]72    elseif ($url == '')
73    {
[1789]74      $output.= '<a href="'
[1748]75            .make_index_url(
[1131]76                array(
[1861]77                  'category' => $cat,
[1748]78                  )
[1131]79              )
80            .'">';
[1861]81      $output.= $cat['name'].'</a>';
[1092]82    }
[569]83    else
84    {
[1866]85      $output.= '<a href="'.PHPWG_ROOT_PATH.$url.$cat['id'].'">';
[1861]86      $output.= $cat['name'].'</a>';
[569]87    }
[476]88  }
[569]89  if ($replace_space)
90  {
91    return replace_space($output);
92  }
93  else
94  {
95    return $output;
96  }
[476]97}
98
99/**
[610]100 * returns the list of categories as a HTML string, with cache of names
101 *
102 * categories string returned contains categories as given in the input
103 * array $cat_informations. $uppercats is the list of category ids to
104 * display in the right order. If url input parameter is empty, returns only
105 * the categories name without links.
106 *
107 * @param string uppercats
108 * @param string url
109 * @param boolean replace_space
110 * @return string
111 */
112function get_cat_display_name_cache($uppercats,
[1092]113                                    $url = '',
[9367]114                                    $replace_space = true,
115                                    $single_link = false,
116                                    $link_class = null)
[610]117{
[1861]118  global $cache, $conf;
[610]119
[1861]120  if (!isset($cache['cat_names']))
[610]121  {
122    $query = '
[1866]123SELECT id, name, permalink
[610]124  FROM '.CATEGORIES_TABLE.'
125;';
[1866]126    $cache['cat_names'] = hash_from_query($query, 'id');
[610]127  }
[1090]128
[610]129  $output = '';
[9367]130  if ($single_link)
131  {
132    $single_url = get_root_url().$url.array_pop(explode(',', $uppercats));
133    $output.= '<a href="'.$single_url.'"';
134    if (isset($link_class))
135    {
136      $output.= ' class="'.$link_class.'"';
137    }
138    $output.= '>';
139  }
[610]140  $is_first = true;
141  foreach (explode(',', $uppercats) as $category_id)
142  {
[1861]143    $cat = $cache['cat_names'][$category_id];
[1090]144
[2433]145    $cat['name'] = trigger_event(
146      'render_category_name',
147      $cat['name'],
148      'get_cat_display_name_cache'
149      );
150
[610]151    if ($is_first)
152    {
153      $is_first = false;
154    }
155    else
156    {
[642]157      $output.= $conf['level_separator'];
[610]158    }
159
[9367]160    if ( !isset($url) or $single_link )
[610]161    {
[1861]162      $output.= $cat['name'];
[610]163    }
[1092]164    elseif ($url == '')
165    {
166      $output.= '
[1789]167<a href="'
[1131]168      .make_index_url(
169          array(
[1861]170            'category' => $cat,
[1131]171            )
172        )
[1861]173      .'">'.$cat['name'].'</a>';
[1092]174    }
[610]175    else
176    {
177      $output.= '
[1861]178<a href="'.PHPWG_ROOT_PATH.$url.$category_id.'">'.$cat['name'].'</a>';
[610]179    }
180  }
[12920]181
[9367]182  if ($single_link and isset($single_url))
183  {
184    $output.= '</a>';
185  }
186
[610]187  if ($replace_space)
188  {
189    return replace_space($output);
190  }
191  else
192  {
193    return $output;
194  }
195}
196
197/**
[579]198 * returns HTMLized comment contents retrieved from database
199 *
200 * newlines becomes br tags, _word_ becomes underline, /word/ becomes
201 * italic, *word* becomes bolded
202 *
203 * @param string content
204 * @return string
205 */
[8247]206function render_comment_content($content)
[579]207{
[8247]208  $content = htmlspecialchars($content);
[1031]209  $pattern = '/(https?:\/\/\S*)/';
210  $replacement = '<a href="$1" rel="nofollow">$1</a>';
211  $content = preg_replace($pattern, $replacement, $content);
212
[579]213  $content = nl2br($content);
[1090]214
[579]215  // replace _word_ by an underlined word
[1030]216  $pattern = '/\b_(\S*)_\b/';
217  $replacement = '<span style="text-decoration:underline;">$1</span>';
[579]218  $content = preg_replace($pattern, $replacement, $content);
[1090]219
[579]220  // replace *word* by a bolded word
[1030]221  $pattern = '/\b\*(\S*)\*\b/';
222  $replacement = '<span style="font-weight:bold;">$1</span>';
[579]223  $content = preg_replace($pattern, $replacement, $content);
[1090]224
[579]225  // replace /word/ by an italic word
[1031]226  $pattern = "/\/(\S*)\/(\s)/";
227  $replacement = '<span style="font-style:italic;">$1$2</span>';
228  $content = preg_replace($pattern, $replacement, $content);
[579]229
230  return $content;
231}
[817]232
233function get_cat_display_name_from_id($cat_id,
[1092]234                                      $url = '',
[817]235                                      $replace_space = true)
236{
237  $cat_info = get_cat_info($cat_id);
[1861]238  return get_cat_display_name($cat_info['upper_names'], $url, $replace_space);
[817]239}
[1113]240
241/**
[1119]242 * Returns an HTML list of tags. It can be a multi select field or a list of
243 * checkboxes.
244 *
245 * @param string HTML field name
246 * @param array selected tag ids
247 * @return array
248 */
249function get_html_tag_selection(
250  $tags,
251  $fieldname,
252  $selecteds = array(),
253  $forbidden_categories = null
254  )
255{
256  global $conf;
[1131]257
[1201]258  if (count ($tags) == 0 )
259  {
260    return '';
261  }
[1119]262  $output = '<ul class="tagSelection">';
263  foreach ($tags as $tag)
264  {
265    $output.=
266      '<li>'
267      .'<label>'
268      .'<input type="checkbox" name="'.$fieldname.'[]"'
[1815]269      .' value="'.$tag['id'].'"'
[1119]270      ;
271
[1815]272    if (in_array($tag['id'], $selecteds))
[1119]273    {
274      $output.= ' checked="checked"';
275    }
[1131]276
[1119]277    $output.=
[11317]278      '> '
[8725]279      .$tag['name']
[1119]280      .'</label>'
281      .'</li>'
282      ."\n"
283      ;
284  }
285  $output.= '</ul>';
286
287  return $output;
288}
289
290function name_compare($a, $b)
291{
[1310]292  return strcmp(strtolower($a['name']), strtolower($b['name']));
[1119]293}
294
[2409]295function tag_alpha_compare($a, $b)
296{
[13240]297  global $cache;
[12920]298
[12761]299  foreach (array($a, $b) as $tag)
300  {
[13240]301    if (!isset($cache[__FUNCTION__][ $tag['name'] ]))
[12761]302    {
[17748]303      $cache[__FUNCTION__][ $tag['name'] ] = transliterate($tag['name']);
[12761]304    }
305  }
306
[13240]307  return strcmp($cache[__FUNCTION__][ $a['name'] ], $cache[__FUNCTION__][ $b['name'] ]);
[2409]308}
309
[1119]310/**
[1113]311 * exits the current script (either exit or redirect)
312 */
313function access_denied()
314{
[2265]315  global $user;
[1113]316
317  $login_url =
318      get_root_url().'identification.php?redirect='
319      .urlencode(urlencode($_SERVER['REQUEST_URI']));
320
[2543]321  set_status_header(401);
[2029]322  if ( isset($user) and !is_a_guest() )
[1113]323  {
[2884]324    echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8">';
[5021]325    echo '<div style="text-align:center;">'.l10n('You are not authorized to access the requested page').'<br>';
[6316]326    echo '<a href="'.get_root_url().'identification.php">'.l10n('Identification').'</a>&nbsp;';
[5021]327    echo '<a href="'.make_index_url().'">'.l10n('Home').'</a></div>';
[2543]328    echo str_repeat( ' ', 512); //IE6 doesn't error output if below a size
[1113]329    exit();
330  }
331  else
332  {
[1649]333    redirect_html($login_url);
[1113]334  }
335}
[1288]336
337/**
[1652]338 * exits the current script with 403 code
339 * @param string msg a message to display
340 * @param string alternate_url redirect to this url
341 */
342function page_forbidden($msg, $alternate_url=null)
343{
344  set_status_header(403);
345  if ($alternate_url==null)
346    $alternate_url = make_index_url();
347  redirect_html( $alternate_url,
348    '<div style="text-align:left; margin-left:5em;margin-bottom:5em;">
[15384]349<h1 style="text-align:left; font-size:36px;">'.l10n('Forbidden').'</h1><br>'
[1652]350.$msg.'</div>',
351    5 );
352}
353
354/**
[1852]355 * exits the current script with 400 code
356 * @param string msg a message to display
357 * @param string alternate_url redirect to this url
358 */
359function bad_request($msg, $alternate_url=null)
360{
361  set_status_header(400);
362  if ($alternate_url==null)
363    $alternate_url = make_index_url();
364  redirect_html( $alternate_url,
365    '<div style="text-align:left; margin-left:5em;margin-bottom:5em;">
[15384]366<h1 style="text-align:left; font-size:36px;">'.l10n('Bad request').'</h1><br>'
[1852]367.$msg.'</div>',
368    5 );
369}
370
371/**
[1288]372 * exits the current script with 404 code when a page cannot be found
373 * @param string msg a message to display
374 * @param string alternate_url redirect to this url
375 */
376function page_not_found($msg, $alternate_url=null)
377{
[1643]378  set_status_header(404);
[1288]379  if ($alternate_url==null)
380    $alternate_url = make_index_url();
[1649]381  redirect_html( $alternate_url,
[1288]382    '<div style="text-align:left; margin-left:5em;margin-bottom:5em;">
[15384]383<h1 style="text-align:left; font-size:36px;">'.l10n('Page not found').'</h1><br>'
[1288]384.$msg.'</div>',
385    5 );
386}
[1606]387
[2502]388/**
389 * exits the current script with 500 http code
390 * this method can be called at any time (does not use template/language/user etc...)
391 * @param string msg a message to display
392 */
[5985]393function fatal_error($msg, $title=null, $show_trace=true)
[2502]394{
[5985]395  if (empty($title))
396  {
[15381]397    $title = l10n('Piwigo encountered a non recoverable error');
[5985]398  }
[8247]399
[2502]400  $btrace_msg = '';
[5985]401  if ($show_trace and function_exists('debug_backtrace'))
[2502]402  {
403    $bt = debug_backtrace();
404    for ($i=1; $i<count($bt); $i++)
405    {
406      $class = isset($bt[$i]['class']) ? (@$bt[$i]['class'].'::') : '';
407      $btrace_msg .= "#$i\t".$class.@$bt[$i]['function'].' '.@$bt[$i]['file']."(".@$bt[$i]['line'].")\n";
408    }
409    $btrace_msg = trim($btrace_msg);
410    $msg .= "\n";
411  }
412
[2747]413  $display = "<meta http-equiv='Content-Type' content='text/html; charset=utf-8'>
[5985]414<h1>$title</h1>
[2502]415<pre style='font-size:larger;background:white;color:red;padding:1em;margin:0;clear:both;display:block;width:auto;height:auto;overflow:auto'>
416<b>$msg</b>
417$btrace_msg
418</pre>\n";
419
420  @set_status_header(500);
[2543]421  echo $display.str_repeat( ' ', 300); //IE6 doesn't error output if below a size
[2502]422
423  if ( function_exists('ini_set') )
424  {// if possible turn off error display (we display it)
425    ini_set('display_errors', false);
426  }
427  error_reporting( E_ALL );
428  trigger_error( strip_tags($msg).$btrace_msg, E_USER_ERROR );
429  die(0); // just in case
430}
431
[1606]432/* returns the title to be displayed above thumbnails on tag page
433 */
434function get_tags_content_title()
435{
436  global $page;
[5021]437  $title = count($page['tags']) > 1 ? l10n('Tag') : l10n('Tag');
[1606]438  $title.= ' ';
439
440  for ($i=0; $i<count($page['tags']); $i++)
441  {
442    $title.= $i>0 ? ' + ' : '';
443
444    $title.=
445      '<a href="'
446      .make_index_url(
447        array(
448          'tags' => array( $page['tags'][$i] )
449          )
450        )
451      .'" title="'
[8665]452      .l10n('display photos linked to this tag')
[1606]453      .'">'
[11317]454      .trigger_event('render_tag_name', $page['tags'][$i]['name'])
[1606]455      .'</a>';
456
[5706]457    $remove_url = null;
458    if (count($page['tags']) == 1)
[1606]459    {
[5706]460      $remove_url = get_root_url().'tags.php';
461    }
462    else
463    {
[1606]464      $other_tags = $page['tags'];
[5706]465      unset($other_tags[$i]);
466      $remove_url = make_index_url(
467        array(
468          'tags' => $other_tags
[1606]469          )
[5706]470        );
471    }
[8247]472
[5706]473    $title.=
474      '<a href="'.$remove_url.'" style="border:none;" title="'
475      .l10n('remove this tag from the list')
476      .'"><img src="'
[1606]477        .get_root_url().get_themeconf('icon_dir').'/remove_s.png'
[12479]478      .'" alt="x" style="vertical-align:bottom;">'
[5706]479      .'</a>';
[1606]480  }
481  return $title;
482}
[1643]483
484/**
485  Sets the http status header (200,401,...)
486 */
487function set_status_header($code, $text='')
488{
489  if (empty($text))
490  {
491    switch ($code)
492    {
493      case 200: $text='OK';break;
494      case 301: $text='Moved permanently';break;
495      case 302: $text='Moved temporarily';break;
496      case 304: $text='Not modified';break;
497      case 400: $text='Bad request';break;
498      case 401: $text='Authorization required';break;
499      case 403: $text='Forbidden';break;
500      case 404: $text='Not found';break;
[2053]501      case 500: $text='Server error';break;
[2543]502      case 501: $text='Not implemented';break;
[2053]503      case 503: $text='Service unavailable';break;
[1643]504    }
505  }
[5682]506  $protocol = $_SERVER["SERVER_PROTOCOL"];
507  if ( ('HTTP/1.1' != $protocol) && ('HTTP/1.0' != $protocol) )
508    $protocol = 'HTTP/1.0';
[2053]509
[8247]510  header( "$protocol $code $text", true, $code );
[1744]511  trigger_action('set_status_header', $code, $text);
[1643]512}
[1769]513
[2117]514/** returns the category comment for rendering in html textual mode (subcatify)
515 * this is an event handler. don't call directly
516 */
517function render_category_literal_description($desc)
518{
519  return strip_tags($desc, '<span><p><a><br><b><i><small><big><strong><em>');
520}
[2349]521
[2488]522/*event handler for menu*/
523function register_default_menubar_blocks( $menu_ref_arr )
524{
525  $menu = & $menu_ref_arr[0];
526  if ($menu->get_id() != 'menubar')
527    return;
528  $menu->register_block( new RegisteredBlock( 'mbLinks', 'Links', 'piwigo'));
[6993]529  $menu->register_block( new RegisteredBlock( 'mbCategories', 'Albums', 'piwigo'));
[2488]530  $menu->register_block( new RegisteredBlock( 'mbTags', 'Related tags', 'piwigo'));
[5178]531  $menu->register_block( new RegisteredBlock( 'mbSpecials', 'Specials', 'piwigo'));
532  $menu->register_block( new RegisteredBlock( 'mbMenu', 'Menu', 'piwigo'));
533  $menu->register_block( new RegisteredBlock( 'mbIdentification', 'Identification', 'piwigo') );
[2488]534}
535
[12920]536/**
537 */
538function render_element_name($info)
539{
540  $name = $info['name'];
541  if (!empty($name))
542  {
[17975]543    $name = trigger_event('render_element_name', $name);
[12920]544    return $name;
545  }
546
547  return get_name_from_file($info['file']);
548}
549
550function render_element_description($info)
551{
552  $comment = $info['comment'];
553  if (!empty($comment))
554  {
555    $comment = trigger_event('render_element_description', $comment);
556    return $comment;
557  }
558  return '';
559}
560
561/**
562 * returns the title of the thumbnail based on photo properties
563 */
564function get_thumbnail_title($info, $title, $comment)
565{
566  global $conf, $user;
567
568  $details = array();
569
570  if (!empty($info['hit']))
571  {
572    $details[] = $info['hit'].' '.strtolower(l10n('Visits'));
573  }
574
575  if ($conf['rate'] and !empty($info['rating_score']))
576  {
577    $details[] = strtolower(l10n('Rating score')).' '.$info['rating_score'];
578  }
579
580  if (isset($info['nb_comments']) and $info['nb_comments'] != 0)
581  {
582    $details[] = l10n_dec('%d comment', '%d comments', $info['nb_comments']);
583  }
584
585  if (count($details) > 0)
586  {
587    $title.= ' ('.implode(', ', $details).')';
588  }
589
590  if (!empty($comment))
591  {
592    $title.= ' '.substr($info['comment'], 0, 100).(strlen($info['comment']) > 100 ? '...' : '');
593  }
594
595  $title = htmlspecialchars(strip_tags($title));
596  $title = trigger_event('get_thumbnail_title', $title, $info);
597  return $title;
598}
599
[6993]600?>
Note: See TracBrowser for help on using the repository browser.