source: trunk/include/functions_category.inc.php @ 13170

Last change on this file since 13170 was 13074, checked in by rvelices, 9 years ago
  • remove square/thumb from choices on picture
  • fix content margin on password register
  • purge derivative cache by type of derivative
  • session saved infos/messages are not given to the page on html redirections
  • shorter/faster code in functions_xxx
  • Property svn:eol-style set to LF
File size: 12.7 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2012 Piwigo Team                  http://piwigo.org |
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// +-----------------------------------------------------------------------+
23
24/**
25 * Provides functions to handle categories.
26 *
27 *
28 */
29
30/**
31 * Is the category accessible to the connected user ?
32 *
33 * Note : if the user is not authorized to see this category, page creation
34 * ends (exit command in this function)
35 *
36 * @param int category id to verify
37 * @return void
38 */
39function check_restrictions($category_id)
40{
41  global $user;
42
43  // $filter['visible_categories'] and $filter['visible_images']
44  // are not used because it's not necessary (filter <> restriction)
45  if (in_array($category_id, explode(',', $user['forbidden_categories'])))
46  {
47    access_denied();
48  }
49}
50
51function get_categories_menu()
52{
53  global $page, $user, $filter, $conf;
54
55  $query = '
56SELECT ';
57  // From CATEGORIES_TABLE
58  $query.= '
59  id, name, permalink, nb_images, global_rank,';
60  // From USER_CACHE_CATEGORIES_TABLE
61  $query.= '
62  date_last, max_date_last, count_images, count_categories';
63
64  // $user['forbidden_categories'] including with USER_CACHE_CATEGORIES_TABLE
65  $query.= '
66FROM '.CATEGORIES_TABLE.' INNER JOIN '.USER_CACHE_CATEGORIES_TABLE.'
67  ON id = cat_id and user_id = '.$user['id'];
68
69  // Always expand when filter is activated
70  if (!$user['expand'] and !$filter['enabled'])
71  {
72    $where = '
73(id_uppercat is NULL';
74    if (isset($page['category']))
75    {
76      $where .= ' OR id_uppercat IN ('.$page['category']['uppercats'].')';
77    }
78    $where .= ')';
79  }
80  else
81  {
82    $where = '
83  '.get_sql_condition_FandF
84    (
85      array
86        (
87          'visible_categories' => 'id',
88        ),
89      null,
90      true
91    );
92  }
93
94  $where = trigger_event('get_categories_menu_sql_where',
95    $where, $user['expand'], $filter['enabled'] );
96
97  $query.= '
98WHERE '.$where.'
99;';
100
101  $result = pwg_query($query);
102  $cats = array();
103  $selected_category = isset($page['category']) ? $page['category'] : null;
104  while ($row = pwg_db_fetch_assoc($result))
105  {
106    $child_date_last = @$row['max_date_last']> @$row['date_last'];
107    $row = array_merge($row,
108      array(
109        'NAME' => trigger_event(
110          'render_category_name',
111          $row['name'],
112          'get_categories_menu'
113          ),
114        'TITLE' => get_display_images_count(
115          $row['nb_images'],
116          $row['count_images'],
117          $row['count_categories'],
118          false,
119          ' / '
120          ),
121        'URL' => make_index_url(array('category' => $row)),
122        'LEVEL' => substr_count($row['global_rank'], '.') + 1,
123        'SELECTED' => $selected_category['id'] == $row['id'] ? true : false,
124        'IS_UPPERCAT' => $selected_category['id_uppercat'] == $row['id'] ? true : false,
125        )
126      );
127    if ($conf['index_new_icon'])
128    {
129      $row['icon_ts'] = get_icon($row['max_date_last'], $child_date_last);
130    }
131    array_push($cats, $row);
132    if ($row['id']==@$page['category']['id']) //save the number of subcats for later optim
133      $page['category']['count_categories'] = $row['count_categories'];
134  }
135  usort($cats, 'global_rank_compare');
136
137  // Update filtered data
138  if (function_exists('update_cats_with_filtered_data'))
139  {
140    update_cats_with_filtered_data($cats);
141  }
142
143  return $cats;
144}
145
146
147/**
148 * Retrieve informations about a category in the database
149 *
150 * Returns an array with following keys :
151 *
152 *  - comment
153 *  - dir : directory, might be empty for virtual categories
154 *  - name : an array with indexes from 0 (lowest cat name) to n (most
155 *           uppercat name findable)
156 *  - nb_images
157 *  - id_uppercat
158 *  - site_id
159 *  -
160 *
161 * @param int category id
162 * @return array
163 */
164function get_cat_info( $id )
165{
166  $query = '
167SELECT *
168  FROM '.CATEGORIES_TABLE.'
169  WHERE id = '.$id.'
170;';
171  $cat = pwg_db_fetch_assoc(pwg_query($query));
172  if (empty($cat))
173    return null;
174
175  foreach ($cat as $k => $v)
176  {
177    // If the field is true or false, the variable is transformed into a
178    // boolean value.
179    if ($cat[$k] == 'true' or $cat[$k] == 'false')
180    {
181      $cat[$k] = get_boolean( $cat[$k] );
182    }
183  }
184
185  $upper_ids = explode(',', $cat['uppercats']);
186  if ( count($upper_ids)==1 )
187  {// no need to make a query for level 1
188    $cat['upper_names'] = array(
189        array(
190          'id' => $cat['id'],
191          'name' => $cat['name'],
192          'permalink' => $cat['permalink'],
193          )
194      );
195  }
196  else
197  {
198    $names = array();
199    $query = '
200  SELECT id, name, permalink
201    FROM '.CATEGORIES_TABLE.'
202    WHERE id IN ('.$cat['uppercats'].')
203  ;';
204    $names = hash_from_query($query, 'id');
205
206    // category names must be in the same order than uppercats list
207    $cat['upper_names'] = array();
208    foreach ($upper_ids as $cat_id)
209    {
210      array_push( $cat['upper_names'], $names[$cat_id]);
211    }
212  }
213  return $cat;
214}
215
216
217
218// returns an array of image orders available for users/visitors
219function get_category_preferred_image_orders()
220{
221  global $conf, $page;
222
223  return trigger_event('get_category_preferred_image_orders',
224    array(
225    array(l10n('Default'), '', true),
226    array(l10n('Rating score'), 'rating_score DESC', $conf['rate']),
227    array(l10n('Most visited'), 'hit DESC', true),
228    array(l10n('Creation date'), 'date_creation DESC', true),
229    array(l10n('Post date'), 'date_available DESC', true),
230    array(l10n('File name'), 'file ASC', true),
231    array(
232      l10n('Rank'),
233      'rank ASC',
234      ('categories' == @$page['section'] and !isset($page['flat']) and !isset($page['chronology_field']) )
235      ),
236    array( l10n('Permissions'), 'level DESC', is_admin() )
237    ));
238}
239
240function display_select_categories($categories,
241                                   $selecteds,
242                                   $blockname,
243                                   $fullname = true)
244{
245  global $template;
246
247  $tpl_cats = array();
248  foreach ($categories as $category)
249  {
250    if (!empty($category['permalink']))
251    {
252      $category['name'] .= ' &radic;';
253    }
254    if ($fullname)
255    {
256      $option = strip_tags(
257        get_cat_display_name_cache(
258          $category['uppercats'],
259          null,
260          false
261          )
262        );
263    }
264    else
265    {
266      $option = str_repeat('&nbsp;',
267                           (3 * substr_count($category['global_rank'], '.')));
268      $option.= '- ';
269      $option.= strip_tags(
270        trigger_event(
271          'render_category_name',
272          $category['name'],
273          'display_select_categories'
274          )
275        );
276    }
277    $tpl_cats[ $category['id'] ] = $option;
278  }
279
280  $template->assign( $blockname, $tpl_cats);
281  $template->assign( $blockname.'_selected', $selecteds);
282}
283
284function display_select_cat_wrapper($query, $selecteds, $blockname,
285                                    $fullname = true)
286{
287  $result = pwg_query($query);
288  $categories = array();
289  if (!empty($result))
290  {
291    while ($row = pwg_db_fetch_assoc($result))
292    {
293      array_push($categories, $row);
294    }
295  }
296  usort($categories, 'global_rank_compare');
297  display_select_categories($categories, $selecteds, $blockname, $fullname);
298}
299
300/**
301 * returns all subcategory identifiers of given category ids
302 *
303 * @param array ids
304 * @return array
305 */
306function get_subcat_ids($ids)
307{
308  $query = '
309SELECT DISTINCT(id)
310  FROM '.CATEGORIES_TABLE.'
311  WHERE ';
312  foreach ($ids as $num => $category_id)
313  {
314    is_numeric($category_id)
315      or trigger_error(
316        'get_subcat_ids expecting numeric, not '.gettype($category_id),
317        E_USER_WARNING
318      );
319    if ($num > 0)
320    {
321      $query.= '
322    OR ';
323    }
324    $query.= 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.$category_id.'(,|$)\'';
325  }
326  $query.= '
327;';
328  $result = pwg_query($query);
329
330  $subcats = array();
331  while ($row = pwg_db_fetch_assoc($result))
332  {
333    array_push($subcats, $row['id']);
334  }
335  return $subcats;
336}
337
338/** finds a matching category id from a potential list of permalinks
339 * @param array permalinks example: holiday holiday/france holiday/france/paris
340 * @param int idx - output of the index in $permalinks that matches
341 * return category id or null if no match
342 */
343function get_cat_id_from_permalinks( $permalinks, &$idx )
344{
345  $in = '';
346  foreach($permalinks as $permalink)
347  {
348    if ( !empty($in) ) $in.=', ';
349    $in .= '\''.$permalink.'\'';
350  }
351  $query ='
352SELECT cat_id AS id, permalink, 1 AS is_old
353  FROM '.OLD_PERMALINKS_TABLE.'
354  WHERE permalink IN ('.$in.')
355UNION
356SELECT id, permalink, 0 AS is_old
357  FROM '.CATEGORIES_TABLE.'
358  WHERE permalink IN ('.$in.')
359;';
360  $perma_hash = hash_from_query($query, 'permalink');
361
362  if ( empty($perma_hash) )
363    return null;
364  for ($i=count($permalinks)-1; $i>=0; $i--)
365  {
366    if ( isset( $perma_hash[ $permalinks[$i] ] ) )
367    {
368      $idx = $i;
369      $cat_id = $perma_hash[ $permalinks[$i] ]['id'];
370      if ($perma_hash[ $permalinks[$i] ]['is_old'])
371      {
372        $query='
373UPDATE '.OLD_PERMALINKS_TABLE.' SET last_hit=NOW(), hit=hit+1
374  WHERE permalink=\''.$permalinks[$i].'\' AND cat_id='.$cat_id.'
375  LIMIT 1';
376        pwg_query($query);
377      }
378      return $cat_id;
379    }
380  }
381  return null;
382}
383
384function global_rank_compare($a, $b)
385{
386  return strnatcasecmp($a['global_rank'], $b['global_rank']);
387}
388
389function rank_compare($a, $b)
390{
391  if ($a['rank'] == $b['rank'])
392  {
393    return 0;
394  }
395
396  return ($a['rank'] < $b['rank']) ? -1 : 1;
397}
398
399/**
400 * returns display text for information images of category
401 *
402 * @param array categories
403 * @return string
404 */
405function get_display_images_count($cat_nb_images, $cat_count_images, $cat_count_categories, $short_message = true, $Separator = '\n')
406{
407  $display_text = '';
408
409  if ($cat_count_images > 0)
410  {
411    if ($cat_nb_images > 0 and $cat_nb_images < $cat_count_images)
412    {
413      $display_text.= get_display_images_count($cat_nb_images, $cat_nb_images, 0, $short_message, $Separator).$Separator;
414      $cat_count_images-= $cat_nb_images;
415      $cat_nb_images = 0;
416    }
417
418    //at least one image direct or indirect
419    $display_text.= l10n_dec('%d photo', '%d photos', $cat_count_images);
420
421    if ($cat_count_categories == 0 or $cat_nb_images == $cat_count_images)
422    {
423      //no descendant categories or descendants do not contain images
424      if (! $short_message)
425      {
426        $display_text.= ' '.l10n('in this album');
427      }
428    }
429    else
430    {
431      $display_text.= ' '.l10n_dec('in %d sub-album', 'in %d sub-albums', $cat_count_categories);
432    }
433  }
434
435  return $display_text;
436}
437
438/**
439 * Find a random photo among all photos below a given album in the tree (not
440 * only photo directly associated to the album but also to sub-albums)
441 *
442 * we need $category['uppercats'], $category['id'], $category['count_images']
443 */
444function get_random_image_in_category($category, $recursive=true)
445{
446  $image_id = null;
447  if ($category['count_images']>0)
448  {
449    $query = '
450SELECT image_id
451  FROM '.CATEGORIES_TABLE.' AS c
452    INNER JOIN '.IMAGE_CATEGORY_TABLE.' AS ic ON ic.category_id = c.id
453  WHERE ';
454    if ($recursive)
455    {
456      $query.= '
457    (c.id='.$category['id'].' OR uppercats LIKE \''.$category['uppercats'].',%\')';
458    }
459    else
460    {
461      $query.= '
462    c.id='.$category['id'];
463    }
464    $query.= '
465    '.get_sql_condition_FandF
466    (
467      array
468        (
469          'forbidden_categories' => 'c.id',
470          'visible_categories' => 'c.id',
471          'visible_images' => 'image_id',
472        ),
473      "\n  AND"
474    ).'
475  ORDER BY '.DB_RANDOM_FUNCTION.'()
476  LIMIT 1
477;';
478    $result = pwg_query($query);
479    if (pwg_db_num_rows($result) > 0)
480    {
481      list($image_id) = pwg_db_fetch_row($result);
482    }
483  }
484
485  return $image_id;
486}
487
488
489?>
Note: See TracBrowser for help on using the repository browser.