source: trunk/admin/include/functions.php @ 11853

Revision 11853, 50.8 KB checked in by rvelices, 8 years ago (diff)

feature 2387: addd a filter by tag in the batch manager

  • Property svn:eol-style set to LF
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2011 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
24include(PHPWG_ROOT_PATH.'admin/include/functions_metadata.php');
25
26// The function delete_site deletes a site and call the function
27// delete_categories for each primary category of the site
28function delete_site( $id )
29{
30  // destruction of the categories of the site
31  $query = '
32SELECT id
33  FROM '.CATEGORIES_TABLE.'
34  WHERE site_id = '.$id.'
35;';
36  $result = pwg_query($query);
37  $category_ids = array();
38  while ($row = pwg_db_fetch_assoc($result))
39  {
40    array_push($category_ids, $row['id']);
41  }
42  delete_categories($category_ids);
43
44  // destruction of the site
45  $query = '
46DELETE FROM '.SITES_TABLE.'
47  WHERE id = '.$id.'
48;';
49  pwg_query($query);
50}
51
52
53// The function delete_categories deletes the categories identified by the
54// (numeric) key of the array $ids. It also deletes (in the database) :
55//    - all the elements physically linked to the category (delete_elements, see further)
56//    - all the links between elements and this category
57//    - all the restrictions linked to the category
58// The function works recursively.
59//
60// the $photo_deletion_mode is for photos virtually linked to the categorty
61//   * no_delete : delete no photo, may create orphans
62//   * delete_orphans : delete photos that are no longer linked to any category
63//   * force_delete : delete photos even if they are linked to another category
64function delete_categories($ids, $photo_deletion_mode='no_delete')
65{
66  if (count($ids) == 0)
67  {
68    return;
69  }
70
71  // add sub-category ids to the given ids : if a category is deleted, all
72  // sub-categories must be so
73  $ids = get_subcat_ids($ids);
74
75  // destruction of all photos physically linked to the category
76  $query = '
77SELECT id
78  FROM '.IMAGES_TABLE.'
79  WHERE storage_category_id IN (
80'.wordwrap(implode(', ', $ids), 80, "\n").')
81;';
82  $result = pwg_query($query);
83  $element_ids = array();
84  while ($row = pwg_db_fetch_assoc($result))
85  {
86    array_push($element_ids, $row['id']);
87  }
88  delete_elements($element_ids);
89
90  // now, should we delete photos that are virtually linked to the category?
91  if ('delete_orphans' == $photo_deletion_mode or 'force_delete' == $photo_deletion_mode)
92  {
93    $query = '
94SELECT
95    DISTINCT(image_id)
96  FROM '.IMAGE_CATEGORY_TABLE.'
97  WHERE category_id IN ('.implode(',', $ids).')
98;';
99    $image_ids_linked = array_from_query($query, 'image_id');
100
101    if (count($image_ids_linked) > 0)
102    {
103      if ('delete_orphans' == $photo_deletion_mode)
104      {
105        $query = '
106SELECT
107    DISTINCT(image_id)
108  FROM '.IMAGE_CATEGORY_TABLE.'
109  WHERE image_id IN ('.implode(',', $image_ids_linked).')
110    AND category_id NOT IN ('.implode(',', $ids).')
111;';
112        $image_ids_not_orphans = array_from_query($query, 'image_id');
113        $image_ids_to_delete = array_diff($image_ids_linked, $image_ids_not_orphans);
114      }
115
116      if ('force_delete' == $photo_deletion_mode)
117      {
118        $image_ids_to_delete = $image_ids_linked;
119      }
120
121      delete_elements($image_ids_to_delete, true);
122    }
123  }
124
125  // destruction of the links between images and this category
126  $query = '
127DELETE FROM '.IMAGE_CATEGORY_TABLE.'
128  WHERE category_id IN (
129'.wordwrap(implode(', ', $ids), 80, "\n").')
130;';
131  pwg_query($query);
132
133  // destruction of the access linked to the category
134  $query = '
135DELETE FROM '.USER_ACCESS_TABLE.'
136  WHERE cat_id IN (
137'.wordwrap(implode(', ', $ids), 80, "\n").')
138;';
139  pwg_query($query);
140
141  $query = '
142DELETE FROM '.GROUP_ACCESS_TABLE.'
143  WHERE cat_id IN (
144'.wordwrap(implode(', ', $ids), 80, "\n").')
145;';
146  pwg_query($query);
147
148  // destruction of the category
149  $query = '
150DELETE FROM '.CATEGORIES_TABLE.'
151  WHERE id IN (
152'.wordwrap(implode(', ', $ids), 80, "\n").')
153;';
154  pwg_query($query);
155
156  $query='
157DELETE FROM '.OLD_PERMALINKS_TABLE.'
158  WHERE cat_id IN ('.implode(',',$ids).')';
159  pwg_query($query);
160
161  $query='
162DELETE FROM '.USER_CACHE_CATEGORIES_TABLE.'
163  WHERE cat_id IN ('.implode(',',$ids).')';
164  pwg_query($query);
165
166  trigger_action('delete_categories', $ids);
167}
168
169// Deletes all files (on disk) related to given image ids
170// @return image ids where files are deleted successfully
171function delete_element_files($ids)
172{
173  if (count($ids) == 0)
174  {
175    return 0;
176  }
177
178  include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
179 
180  $new_ids = array();
181
182  $query = '
183SELECT
184    id,
185    path,
186    tn_ext,
187    has_high,
188    representative_ext
189  FROM '.IMAGES_TABLE.'
190  WHERE id IN ('.implode(',', $ids).')
191;';
192  $result = pwg_query($query);
193  while ($row = pwg_db_fetch_assoc($result))
194  {
195    if (url_is_remote($row['path']))
196    {
197      continue;
198    }
199   
200    $files = array();
201    $files[] = get_element_path($row);
202
203    if (!empty($row['tn_ext']))
204    {
205      $files[] = get_thumbnail_path($row);
206    }
207   
208    if (!empty($row['has_high']) and get_boolean($row['has_high']))
209    {
210      $files[] = get_high_path($row);
211    }
212   
213    if (!empty($row['representative_ext']))
214    {
215      $pi = pathinfo($row['path']);
216      $file_wo_ext = get_filename_wo_extension($pi['basename']);
217      $files[] = PHPWG_ROOT_PATH.$pi['dirname'].'/pwg_representative/'.$file_wo_ext.'.'.$row['representative_ext'];
218    }
219
220    $ok = true;
221    foreach ($files as $path)
222    {
223      if (is_file($path) and !unlink($path))
224      {
225        $ok = false;
226        trigger_error('"'.$path.'" cannot be removed', E_USER_WARNING);
227        break;
228      }
229    }
230   
231    if ($ok)
232    {
233      $new_ids[] += $row['id'];
234    }
235    else
236    {
237      break;
238    }
239  }
240  return $new_ids;
241}
242
243// The function delete_elements deletes the elements identified by the
244// (numeric) values of the array $ids. It also deletes (in the database) :
245//    - all the comments related to elements
246//    - all the links between categories and elements
247//    - all the favorites associated to elements
248// @return number of deleted elements
249function delete_elements($ids, $physical_deletion=false)
250{
251  if (count($ids) == 0)
252  {
253    return 0;
254  }
255  trigger_action('begin_delete_elements', $ids);
256
257  if ($physical_deletion)
258  {
259    $ids = delete_element_files($ids);
260    if (count($ids)==0)
261    {
262      return 0;
263    }
264  }
265
266  // destruction of the comments on the image
267  $query = '
268DELETE FROM '.COMMENTS_TABLE.'
269  WHERE image_id IN (
270'.wordwrap(implode(', ', $ids), 80, "\n").')
271;';
272  pwg_query($query);
273
274  // destruction of the links between images and this category
275  $query = '
276DELETE FROM '.IMAGE_CATEGORY_TABLE.'
277  WHERE image_id IN (
278'.wordwrap(implode(', ', $ids), 80, "\n").')
279;';
280  pwg_query($query);
281
282  // destruction of the links between images and tags
283  $query = '
284DELETE FROM '.IMAGE_TAG_TABLE.'
285  WHERE image_id IN (
286'.wordwrap(implode(', ', $ids), 80, "\n").')
287;';
288  pwg_query($query);
289
290  // destruction of the favorites associated with the picture
291  $query = '
292DELETE FROM '.FAVORITES_TABLE.'
293  WHERE image_id IN (
294'.wordwrap(implode(', ', $ids), 80, "\n").')
295;';
296  pwg_query($query);
297
298  // destruction of the rates associated to this element
299  $query = '
300DELETE FROM '.RATE_TABLE.'
301  WHERE element_id IN (
302'.wordwrap(implode(', ', $ids), 80, "\n").')
303;';
304  pwg_query($query);
305
306  // destruction of the rates associated to this element
307  $query = '
308DELETE FROM '.CADDIE_TABLE.'
309  WHERE element_id IN (
310'.wordwrap(implode(', ', $ids), 80, "\n").')
311;';
312  pwg_query($query);
313
314  // destruction of the image
315  $query = '
316DELETE FROM '.IMAGES_TABLE.'
317  WHERE id IN (
318'.wordwrap(implode(', ', $ids), 80, "\n").')
319;';
320  pwg_query($query);
321
322  // are the photo used as category representant?
323  $query = '
324SELECT
325    id
326  FROM '.CATEGORIES_TABLE.'
327  WHERE representative_picture_id IN (
328'.wordwrap(implode(', ', $ids), 80, "\n").')
329;';
330  $category_ids = array_from_query($query, 'id');
331  if (count($category_ids) > 0)
332  {
333    update_category($category_ids);
334  }
335
336  trigger_action('delete_elements', $ids);
337  return count($ids);
338}
339
340// The delete_user function delete a user identified by the $user_id
341// It also deletes :
342//     - all the access linked to this user
343//     - all the links to any group
344//     - all the favorites linked to this user
345//     - calculated permissions linked to the user
346//     - all datas about notifications for the user
347function delete_user($user_id)
348{
349  global $conf;
350  $tables = array(
351    // destruction of the access linked to the user
352    USER_ACCESS_TABLE,
353    // destruction of data notification by mail for this user
354    USER_MAIL_NOTIFICATION_TABLE,
355    // destruction of data RSS notification for this user
356    USER_FEED_TABLE,
357    // deletion of calculated permissions linked to the user
358    USER_CACHE_TABLE,
359    // deletion of computed cache data linked to the user
360    USER_CACHE_CATEGORIES_TABLE,
361    // destruction of the group links for this user
362    USER_GROUP_TABLE,
363    // destruction of the favorites associated with the user
364    FAVORITES_TABLE,
365    // destruction of the caddie associated with the user
366    CADDIE_TABLE,
367    // deletion of piwigo specific informations
368    USER_INFOS_TABLE,
369    );
370
371  foreach ($tables as $table)
372  {
373    $query = '
374DELETE FROM '.$table.'
375  WHERE user_id = '.$user_id.'
376;';
377    pwg_query($query);
378  }
379
380  // destruction of the user
381  $query = '
382DELETE FROM '.SESSIONS_TABLE.'
383  WHERE data LIKE \'pwg_uid|i:'.(int)$user_id.';%\'
384;';
385  pwg_query($query);
386
387  // destruction of the user
388  $query = '
389DELETE FROM '.USERS_TABLE.'
390  WHERE '.$conf['user_fields']['id'].' = '.$user_id.'
391;';
392  pwg_query($query);
393
394  trigger_action('delete_user', $user_id);
395}
396
397/**
398 * Deletes all tags linked to no photo
399 */
400function delete_orphan_tags()
401{
402  $orphan_tags = get_orphan_tags();
403 
404  if (count($orphan_tags) > 0)
405  {
406    $orphan_tag_ids = array();
407    foreach ($orphan_tags as $tag)
408    {
409      array_push($orphan_tag_ids, $tag['id']);
410    }
411
412    $query = '
413DELETE
414  FROM '.TAGS_TABLE.'
415  WHERE id IN ('.implode(',', $orphan_tag_ids).')
416;';
417    pwg_query($query);
418  }
419}
420
421/**
422 * Get all tags (id + name) linked to no photo
423 */
424function get_orphan_tags()
425{
426  $orphan_tags = array();
427 
428  $query = '
429SELECT
430    id,
431    name
432  FROM '.TAGS_TABLE.'
433    LEFT JOIN '.IMAGE_TAG_TABLE.' ON id = tag_id
434  WHERE tag_id IS NULL
435;';
436  $result = pwg_query($query);
437  while ($row = pwg_db_fetch_assoc($result))
438  {
439    array_push($orphan_tags, $row);
440  }
441
442  return $orphan_tags;
443}
444
445/**
446 * Verifies that the representative picture really exists in the db and
447 * picks up a random represantive if possible and based on config.
448 *
449 * @param mixed category id
450 * @returns void
451 */
452function update_category($ids = 'all')
453{
454  global $conf;
455
456  if ($ids=='all')
457  {
458    $where_cats = '1=1';
459  }
460  elseif ( !is_array($ids) )
461  {
462    $where_cats = '%s='.$ids;
463  }
464  else
465  {
466    if (count($ids) == 0)
467    {
468      return false;
469    }
470    $where_cats = '%s IN('.wordwrap(implode(', ', $ids), 120, "\n").')';
471  }
472
473  // find all categories where the setted representative is not possible :
474  // the picture does not exist
475  $query = '
476SELECT DISTINCT c.id
477  FROM '.CATEGORIES_TABLE.' AS c LEFT JOIN '.IMAGES_TABLE.' AS i
478    ON c.representative_picture_id = i.id
479  WHERE representative_picture_id IS NOT NULL
480    AND '.sprintf($where_cats, 'c.id').'
481    AND i.id IS NULL
482;';
483  $wrong_representant = array_from_query($query, 'id');
484
485  if (count($wrong_representant) > 0)
486  {
487    $query = '
488UPDATE '.CATEGORIES_TABLE.'
489  SET representative_picture_id = NULL
490  WHERE id IN ('.wordwrap(implode(', ', $wrong_representant), 120, "\n").')
491;';
492    pwg_query($query);
493  }
494
495  if (!$conf['allow_random_representative'])
496  {
497    // If the random representant is not allowed, we need to find
498    // categories with elements and with no representant. Those categories
499    // must be added to the list of categories to set to a random
500    // representant.
501    $query = '
502SELECT DISTINCT id
503  FROM '.CATEGORIES_TABLE.' INNER JOIN '.IMAGE_CATEGORY_TABLE.'
504    ON id = category_id
505  WHERE representative_picture_id IS NULL
506    AND '.sprintf($where_cats, 'category_id').'
507;';
508    $to_rand = array_from_query($query, 'id');
509    if (count($to_rand) > 0)
510    {
511      set_random_representant($to_rand);
512    }
513  }
514}
515
516/**
517 * returns an array containing sub-directories which can be a category,
518 * recursive by default
519 *
520 * directories nammed "thumbnail", "pwg_high" or "pwg_representative" are
521 * omitted
522 *
523 * @param string $basedir
524 * @return array
525 */
526function get_fs_directories($path, $recursive = true)
527{
528  $dirs = array();
529
530  if (is_dir($path))
531  {
532    if ($contents = opendir($path))
533    {
534      while (($node = readdir($contents)) !== false)
535      {
536        if (is_dir($path.'/'.$node)
537            and $node != '.'
538            and $node != '..'
539            and $node != '.svn'
540            and $node != 'thumbnail'
541            and $node != 'pwg_high'
542            and $node != 'pwg_representative')
543        {
544          array_push($dirs, $path.'/'.$node);
545          if ($recursive)
546          {
547            $dirs = array_merge($dirs, get_fs_directories($path.'/'.$node));
548          }
549        }
550      }
551      closedir($contents);
552    }
553  }
554
555  return $dirs;
556}
557
558/**
559 * order categories (update categories.rank and global_rank database fields)
560 * so that rank field are consecutive integers starting at 1 for each child
561 * @return void
562 */
563function update_global_rank()
564{
565  $query = '
566SELECT id, id_uppercat, uppercats, rank, global_rank
567  FROM '.CATEGORIES_TABLE.'
568  ORDER BY id_uppercat,rank,name';
569
570  $cat_map = array();
571
572  $current_rank = 0;
573  $current_uppercat = '';
574
575  $result = pwg_query($query);
576  while ($row = pwg_db_fetch_assoc($result))
577  {
578    if ($row['id_uppercat'] != $current_uppercat)
579    {
580      $current_rank = 0;
581      $current_uppercat = $row['id_uppercat'];
582    }
583    ++$current_rank;
584    $cat =
585      array(
586        'rank' =>        $current_rank,
587        'rank_changed' =>$current_rank!=$row['rank'],
588        'global_rank' => $row['global_rank'],
589        'uppercats' =>   $row['uppercats'],
590        );
591    $cat_map[ $row['id'] ] = $cat;
592  }
593
594  $datas = array();
595
596  foreach( $cat_map as $id=>$cat )
597  {
598    $new_global_rank = preg_replace(
599          '/(\d+)/e',
600          "\$cat_map['$1']['rank']",
601          str_replace(',', '.', $cat['uppercats'] )
602          );
603    if ( $cat['rank_changed']
604      or $new_global_rank!=$cat['global_rank']
605      )
606    {
607      $datas[] = array(
608          'id' => $id,
609          'rank' => $cat['rank'],
610          'global_rank' => $new_global_rank,
611        );
612    }
613  }
614
615  mass_updates(
616    CATEGORIES_TABLE,
617    array(
618      'primary' => array('id'),
619      'update'  => array('rank', 'global_rank')
620      ),
621    $datas
622    );
623  return count($datas);
624}
625
626/**
627 * change the visible property on a set of categories
628 *
629 * @param array categories
630 * @param string value
631 * @return void
632 */
633function set_cat_visible($categories, $value)
634{
635  if (!in_array($value, array('true', 'false')))
636  {
637    trigger_error("set_cat_visible invalid param $value", E_USER_WARNING);
638    return false;
639  }
640
641  // unlocking a category => all its parent categories become unlocked
642  if ($value == 'true')
643  {
644    $uppercats = get_uppercat_ids($categories);
645    $query = '
646UPDATE '.CATEGORIES_TABLE.'
647  SET visible = \'true\'
648  WHERE id IN ('.implode(',', $uppercats).')';
649    pwg_query($query);
650  }
651  // locking a category   => all its child categories become locked
652  if ($value == 'false')
653  {
654    $subcats = get_subcat_ids($categories);
655    $query = '
656UPDATE '.CATEGORIES_TABLE.'
657  SET visible = \'false\'
658  WHERE id IN ('.implode(',', $subcats).')';
659    pwg_query($query);
660  }
661}
662
663/**
664 * change the status property on a set of categories : private or public
665 *
666 * @param array categories
667 * @param string value
668 * @return void
669 */
670function set_cat_status($categories, $value)
671{
672  if (!in_array($value, array('public', 'private')))
673  {
674    trigger_error("set_cat_status invalid param $value", E_USER_WARNING);
675    return false;
676  }
677
678  // make public a category => all its parent categories become public
679  if ($value == 'public')
680  {
681    $uppercats = get_uppercat_ids($categories);
682    $query = '
683UPDATE '.CATEGORIES_TABLE.'
684  SET status = \'public\'
685  WHERE id IN ('.implode(',', $uppercats).')
686;';
687    pwg_query($query);
688  }
689  // make a category private => all its child categories become private
690  if ($value == 'private')
691  {
692    $subcats = get_subcat_ids($categories);
693    $query = '
694UPDATE '.CATEGORIES_TABLE.'
695  SET status = \'private\'
696  WHERE id IN ('.implode(',', $subcats).')';
697    pwg_query($query);
698  }
699}
700
701/**
702 * returns all uppercats category ids of the given category ids
703 *
704 * @param array cat_ids
705 * @return array
706 */
707function get_uppercat_ids($cat_ids)
708{
709  if (!is_array($cat_ids) or count($cat_ids) < 1)
710  {
711    return array();
712  }
713
714  $uppercats = array();
715
716  $query = '
717SELECT uppercats
718  FROM '.CATEGORIES_TABLE.'
719  WHERE id IN ('.implode(',', $cat_ids).')
720;';
721  $result = pwg_query($query);
722  while ($row = pwg_db_fetch_assoc($result))
723  {
724    $uppercats = array_merge($uppercats,
725                             explode(',', $row['uppercats']));
726  }
727  $uppercats = array_unique($uppercats);
728
729  return $uppercats;
730}
731
732/**
733 * set a new random representant to the categories
734 *
735 * @param array categories
736 */
737function set_random_representant($categories)
738{
739  $datas = array();
740  foreach ($categories as $category_id)
741  {
742    $query = '
743SELECT image_id
744  FROM '.IMAGE_CATEGORY_TABLE.'
745  WHERE category_id = '.$category_id.'
746  ORDER BY '.DB_RANDOM_FUNCTION.'()
747  LIMIT 1
748;';
749    list($representative) = pwg_db_fetch_row(pwg_query($query));
750
751    array_push(
752      $datas,
753      array(
754        'id' => $category_id,
755        'representative_picture_id' => $representative,
756        )
757      );
758  }
759
760  mass_updates(
761    CATEGORIES_TABLE,
762    array(
763      'primary' => array('id'),
764      'update' => array('representative_picture_id')
765      ),
766    $datas
767    );
768}
769
770/**
771 * returns the fulldir for each given category id
772 *
773 * @param array cat_ids
774 * @return array
775 */
776function get_fulldirs($cat_ids)
777{
778  if (count($cat_ids) == 0)
779  {
780    return array();
781  }
782
783  // caching directories of existing categories
784  $query = '
785SELECT id, dir
786  FROM '.CATEGORIES_TABLE.'
787  WHERE dir IS NOT NULL
788;';
789  $cat_dirs = simple_hash_from_query($query, 'id', 'dir');
790
791  // caching galleries_url
792  $query = '
793SELECT id, galleries_url
794  FROM '.SITES_TABLE.'
795;';
796  $galleries_url = simple_hash_from_query($query, 'id', 'galleries_url');
797
798  // categories : id, site_id, uppercats
799  $categories = array();
800
801  $query = '
802SELECT id, uppercats, site_id
803  FROM '.CATEGORIES_TABLE.'
804  WHERE dir IS NOT NULL
805    AND id IN (
806'.wordwrap(implode(', ', $cat_ids), 80, "\n").')
807;';
808  $result = pwg_query($query);
809  while ($row = pwg_db_fetch_assoc($result))
810  {
811    array_push($categories, $row);
812  }
813
814  // filling $cat_fulldirs
815  $cat_fulldirs = array();
816  foreach ($categories as $category)
817  {
818    $uppercats = str_replace(',', '/', $category['uppercats']);
819    $cat_fulldirs[$category['id']] = $galleries_url[$category['site_id']];
820    $cat_fulldirs[$category['id']].= preg_replace('/(\d+)/e',
821                                                  "\$cat_dirs['$1']",
822                                                  $uppercats);
823  }
824
825  return $cat_fulldirs;
826}
827
828/**
829 * returns an array with all file system files according to
830 * $conf['file_ext']
831 *
832 * @param string $path
833 * @param bool recursive
834 * @return array
835 */
836function get_fs($path, $recursive = true)
837{
838  global $conf;
839
840  // because isset is faster than in_array...
841  if (!isset($conf['flip_picture_ext']))
842  {
843    $conf['flip_picture_ext'] = array_flip($conf['picture_ext']);
844  }
845  if (!isset($conf['flip_file_ext']))
846  {
847    $conf['flip_file_ext'] = array_flip($conf['file_ext']);
848  }
849
850  $fs['elements'] = array();
851  $fs['thumbnails'] = array();
852  $fs['representatives'] = array();
853  $subdirs = array();
854
855  if (is_dir($path))
856  {
857    if ($contents = opendir($path))
858    {
859      while (($node = readdir($contents)) !== false)
860      {
861        if (is_file($path.'/'.$node))
862        {
863          $extension = get_extension($node);
864
865//          if (in_array($extension, $conf['picture_ext']))
866          if (isset($conf['flip_picture_ext'][$extension]))
867          {
868            if (basename($path) == 'thumbnail')
869            {
870              array_push($fs['thumbnails'], $path.'/'.$node);
871            }
872            else if (basename($path) == 'pwg_representative')
873            {
874              array_push($fs['representatives'], $path.'/'.$node);
875            }
876            else
877            {
878              array_push($fs['elements'], $path.'/'.$node);
879            }
880          }
881//          else if (in_array($extension, $conf['file_ext']))
882          else if (isset($conf['flip_file_ext'][$extension]))
883          {
884            array_push($fs['elements'], $path.'/'.$node);
885          }
886        }
887        else if (is_dir($path.'/'.$node)
888                 and $node != '.'
889                 and $node != '..'
890                 and $node != 'pwg_high'
891                 and $recursive)
892        {
893          array_push($subdirs, $node);
894        }
895      }
896    }
897    closedir($contents);
898
899    foreach ($subdirs as $subdir)
900    {
901      $tmp_fs = get_fs($path.'/'.$subdir);
902
903      $fs['elements']        = array_merge($fs['elements'],
904                                           $tmp_fs['elements']);
905
906      $fs['thumbnails']      = array_merge($fs['thumbnails'],
907                                           $tmp_fs['thumbnails']);
908
909      $fs['representatives'] = array_merge($fs['representatives'],
910                                           $tmp_fs['representatives']);
911    }
912  }
913  return $fs;
914}
915
916/**
917 * synchronize base users list and related users list
918 *
919 * compares and synchronizes base users table (USERS_TABLE) with its child
920 * tables (USER_INFOS_TABLE, USER_ACCESS, USER_CACHE, USER_GROUP) : each
921 * base user must be present in child tables, users in child tables not
922 * present in base table must be deleted.
923 *
924 * @return void
925 */
926function sync_users()
927{
928  global $conf;
929
930  $query = '
931SELECT '.$conf['user_fields']['id'].' AS id
932  FROM '.USERS_TABLE.'
933;';
934  $base_users = array_from_query($query, 'id');
935
936  $query = '
937SELECT user_id
938  FROM '.USER_INFOS_TABLE.'
939;';
940  $infos_users = array_from_query($query, 'user_id');
941
942  // users present in $base_users and not in $infos_users must be added
943  $to_create = array_diff($base_users, $infos_users);
944
945  if (count($to_create) > 0)
946  {
947    create_user_infos($to_create);
948  }
949
950  // users present in user related tables must be present in the base user
951  // table
952  $tables = array(
953    USER_MAIL_NOTIFICATION_TABLE,
954    USER_FEED_TABLE,
955    USER_INFOS_TABLE,
956    USER_ACCESS_TABLE,
957    USER_CACHE_TABLE,
958    USER_CACHE_CATEGORIES_TABLE,
959    USER_GROUP_TABLE
960    );
961
962  foreach ($tables as $table)
963  {
964    $query = '
965SELECT DISTINCT user_id
966  FROM '.$table.'
967;';
968    $to_delete = array_diff(
969      array_from_query($query, 'user_id'),
970      $base_users
971      );
972
973    if (count($to_delete) > 0)
974    {
975      $query = '
976DELETE
977  FROM '.$table.'
978  WHERE user_id in ('.implode(',', $to_delete).')
979;';
980      pwg_query($query);
981    }
982  }
983}
984
985/**
986 * updates categories.uppercats field based on categories.id +
987 * categories.id_uppercat
988 *
989 * @return void
990 */
991function update_uppercats()
992{
993  $query = '
994SELECT id, id_uppercat, uppercats
995  FROM '.CATEGORIES_TABLE.'
996;';
997  $cat_map = hash_from_query($query, 'id');
998
999  $datas = array();
1000  foreach ($cat_map as $id => $cat)
1001  {
1002    $upper_list = array();
1003
1004    $uppercat = $id;
1005    while ($uppercat)
1006    {
1007      array_push($upper_list, $uppercat);
1008      $uppercat = $cat_map[$uppercat]['id_uppercat'];
1009    }
1010
1011    $new_uppercats = implode(',', array_reverse($upper_list));
1012    if ($new_uppercats != $cat['uppercats'])
1013    {
1014      array_push(
1015        $datas,
1016        array(
1017          'id' => $id,
1018          'uppercats' => $new_uppercats
1019          )
1020        );
1021    }
1022  }
1023  $fields = array('primary' => array('id'), 'update' => array('uppercats'));
1024  mass_updates(CATEGORIES_TABLE, $fields, $datas);
1025}
1026
1027/**
1028 * update images.path field
1029 *
1030 * @return void
1031 */
1032function update_path()
1033{
1034  $query = '
1035SELECT DISTINCT(storage_category_id)
1036  FROM '.IMAGES_TABLE.'
1037  WHERE storage_category_id IS NOT NULL
1038;';
1039  $cat_ids = array_from_query($query, 'storage_category_id');
1040  $fulldirs = get_fulldirs($cat_ids);
1041
1042  foreach ($cat_ids as $cat_id)
1043  {
1044    $query = '
1045UPDATE '.IMAGES_TABLE.'
1046  SET path = '.pwg_db_concat(array("'".$fulldirs[$cat_id]."/'",'file')).'
1047  WHERE storage_category_id = '.$cat_id.'
1048;';
1049    pwg_query($query);
1050  }
1051}
1052
1053/**
1054 * change the parent category of the given categories. The categories are
1055 * supposed virtual.
1056 *
1057 * @param array category identifiers
1058 * @param int parent category identifier
1059 * @return void
1060 */
1061function move_categories($category_ids, $new_parent = -1)
1062{
1063  global $page;
1064
1065  if (count($category_ids) == 0)
1066  {
1067    return;
1068  }
1069
1070  $new_parent = $new_parent < 1 ? 'NULL' : $new_parent;
1071
1072  $categories = array();
1073
1074  $query = '
1075SELECT id, id_uppercat, status, uppercats
1076  FROM '.CATEGORIES_TABLE.'
1077  WHERE id IN ('.implode(',', $category_ids).')
1078;';
1079  $result = pwg_query($query);
1080  while ($row = pwg_db_fetch_assoc($result))
1081  {
1082    $categories[$row['id']] =
1083      array(
1084        'parent' => empty($row['id_uppercat']) ? 'NULL' : $row['id_uppercat'],
1085        'status' => $row['status'],
1086        'uppercats' => $row['uppercats']
1087        );
1088  }
1089
1090  // is the movement possible? The movement is impossible if you try to move
1091  // a category in a sub-category or itself
1092  if ('NULL' != $new_parent)
1093  {
1094    $query = '
1095SELECT uppercats
1096  FROM '.CATEGORIES_TABLE.'
1097  WHERE id = '.$new_parent.'
1098;';
1099    list($new_parent_uppercats) = pwg_db_fetch_row(pwg_query($query));
1100
1101    foreach ($categories as $category)
1102    {
1103      // technically, you can't move a category with uppercats 12,125,13,14
1104      // into a new parent category with uppercats 12,125,13,14,24
1105      if (preg_match('/^'.$category['uppercats'].'(,|$)/', $new_parent_uppercats))
1106      {
1107        array_push(
1108          $page['errors'],
1109          l10n('You cannot move an album in its own sub album')
1110          );
1111        return;
1112      }
1113    }
1114  }
1115
1116  $tables =
1117    array(
1118      USER_ACCESS_TABLE => 'user_id',
1119      GROUP_ACCESS_TABLE => 'group_id'
1120      );
1121
1122  $query = '
1123UPDATE '.CATEGORIES_TABLE.'
1124  SET id_uppercat = '.$new_parent.'
1125  WHERE id IN ('.implode(',', $category_ids).')
1126;';
1127  pwg_query($query);
1128
1129  update_uppercats();
1130  update_global_rank();
1131
1132  // status and related permissions management
1133  if ('NULL' == $new_parent)
1134  {
1135    $parent_status = 'public';
1136  }
1137  else
1138  {
1139    $query = '
1140SELECT status
1141  FROM '.CATEGORIES_TABLE.'
1142  WHERE id = '.$new_parent.'
1143;';
1144    list($parent_status) = pwg_db_fetch_row(pwg_query($query));
1145  }
1146
1147  if ('private' == $parent_status)
1148  {
1149    foreach ($categories as $cat_id => $category)
1150    {
1151      switch ($category['status'])
1152      {
1153        case 'public' :
1154        {
1155          set_cat_status(array($cat_id), 'private');
1156          break;
1157        }
1158        case 'private' :
1159        {
1160          $subcats = get_subcat_ids(array($cat_id));
1161
1162          foreach ($tables as $table => $field)
1163          {
1164            $query = '
1165SELECT '.$field.'
1166  FROM '.$table.'
1167  WHERE cat_id = '.$cat_id.'
1168;';
1169            $category_access = array_from_query($query, $field);
1170
1171            $query = '
1172SELECT '.$field.'
1173  FROM '.$table.'
1174  WHERE cat_id = '.$new_parent.'
1175;';
1176            $parent_access = array_from_query($query, $field);
1177
1178            $to_delete = array_diff($parent_access, $category_access);
1179
1180            if (count($to_delete) > 0)
1181            {
1182              $query = '
1183DELETE FROM '.$table.'
1184  WHERE '.$field.' IN ('.implode(',', $to_delete).')
1185    AND cat_id IN ('.implode(',', $subcats).')
1186;';
1187              pwg_query($query);
1188            }
1189          }
1190          break;
1191        }
1192      }
1193    }
1194  }
1195
1196  array_push(
1197    $page['infos'],
1198    l10n_dec(
1199      '%d album moved', '%d albums moved',
1200      count($categories)
1201      )
1202    );
1203}
1204
1205/**
1206 * create a virtual category
1207 *
1208 * @param string category name
1209 * @param int parent category id
1210 * @return array with ('info' and 'id') or ('error') key
1211 */
1212function create_virtual_category($category_name, $parent_id=null)
1213{
1214  global $conf, $user;
1215
1216  // is the given category name only containing blank spaces ?
1217  if (preg_match('/^\s*$/', $category_name))
1218  {
1219    return array('error' => l10n('The name of an album must not be empty'));
1220  }
1221
1222  $parent_id = !empty($parent_id) ? $parent_id : 'NULL';
1223
1224  $query = '
1225SELECT MAX(rank)
1226  FROM '.CATEGORIES_TABLE.'
1227  WHERE id_uppercat '.(is_numeric($parent_id) ? '= '.$parent_id : 'IS NULL').'
1228;';
1229  list($current_rank) = pwg_db_fetch_row(pwg_query($query));
1230
1231  $insert = array(
1232    'name' => $category_name,
1233    'rank' => ++$current_rank,
1234    'commentable' => boolean_to_string($conf['newcat_default_commentable']),
1235    );
1236
1237  if ($parent_id != 'NULL')
1238  {
1239    $query = '
1240SELECT id, uppercats, global_rank, visible, status
1241  FROM '.CATEGORIES_TABLE.'
1242  WHERE id = '.$parent_id.'
1243;';
1244    $parent = pwg_db_fetch_assoc(pwg_query($query));
1245
1246    $insert['id_uppercat'] = $parent['id'];
1247    $insert['global_rank'] = $parent['global_rank'].'.'.$insert['rank'];
1248
1249    // at creation, must a category be visible or not ? Warning : if the
1250    // parent category is invisible, the category is automatically create
1251    // invisible. (invisible = locked)
1252    if ('false' == $parent['visible'])
1253    {
1254      $insert['visible'] = 'false';
1255    }
1256    else
1257    {
1258      $insert['visible'] = boolean_to_string($conf['newcat_default_visible']);
1259    }
1260
1261    // at creation, must a category be public or private ? Warning : if the
1262    // parent category is private, the category is automatically create
1263    // private.
1264    if ('private' == $parent['status'])
1265    {
1266      $insert['status'] = 'private';
1267    }
1268    else
1269    {
1270      $insert['status'] = $conf['newcat_default_status'];
1271    }
1272  }
1273  else
1274  {
1275    $insert['visible'] = boolean_to_string($conf['newcat_default_visible']);
1276    $insert['status'] = $conf['newcat_default_status'];
1277    $insert['global_rank'] = $insert['rank'];
1278  }
1279
1280  // we have then to add the virtual category
1281  mass_inserts(
1282    CATEGORIES_TABLE,
1283    array(
1284      'site_id', 'name', 'id_uppercat', 'rank', 'commentable',
1285      'visible', 'status', 'global_rank',
1286      ),
1287    array($insert)
1288    );
1289
1290  $inserted_id = pwg_db_insert_id(CATEGORIES_TABLE);
1291
1292  $query = '
1293UPDATE
1294  '.CATEGORIES_TABLE.'
1295  SET uppercats = \''.
1296    (isset($parent) ? $parent{'uppercats'}.',' : '').
1297    $inserted_id.
1298    '\'
1299  WHERE id = '.$inserted_id.'
1300;';
1301  pwg_query($query);
1302
1303  if ('private' == $insert['status'])
1304  {
1305    add_permission_on_category($inserted_id, array_unique(array_merge(get_admins(), array($user['id']))));
1306  }
1307
1308  return array(
1309    'info' => l10n('Virtual album added'),
1310    'id'   => $inserted_id,
1311    );
1312}
1313
1314/**
1315 * Set tags to an image. Warning: given tags are all tags associated to the
1316 * image, not additionnal tags.
1317 *
1318 * @param array tag ids
1319 * @param int image id
1320 * @return void
1321 */
1322function set_tags($tags, $image_id)
1323{
1324  $query = '
1325DELETE
1326  FROM '.IMAGE_TAG_TABLE.'
1327  WHERE image_id = '.$image_id.'
1328;';
1329  pwg_query($query);
1330
1331  if (count($tags) > 0)
1332  {
1333    $inserts = array();
1334    foreach ($tags as $tag_id)
1335    {
1336      array_push(
1337        $inserts,
1338        array(
1339          'tag_id' => $tag_id,
1340          'image_id' => $image_id
1341          )
1342        );
1343    }
1344    mass_inserts(
1345      IMAGE_TAG_TABLE,
1346      array_keys($inserts[0]),
1347      $inserts
1348      );
1349  }
1350}
1351
1352/**
1353 * Add new tags to a set of images.
1354 *
1355 * @param array tag ids
1356 * @param array image ids
1357 * @return void
1358 */
1359function add_tags($tags, $images)
1360{
1361  if (count($tags) == 0 or count($images) == 0)
1362  {
1363    return;
1364  }
1365
1366  // we can't insert twice the same {image_id,tag_id} so we must first
1367  // delete lines we'll insert later
1368  $query = '
1369DELETE
1370  FROM '.IMAGE_TAG_TABLE.'
1371  WHERE image_id IN ('.implode(',', $images).')
1372    AND tag_id IN ('.implode(',', $tags).')
1373;';
1374  pwg_query($query);
1375
1376  $inserts = array();
1377  foreach ($images as $image_id)
1378  {
1379    foreach ($tags as $tag_id)
1380    {
1381      array_push(
1382        $inserts,
1383        array(
1384          'image_id' => $image_id,
1385          'tag_id' => $tag_id,
1386          )
1387        );
1388    }
1389  }
1390  mass_inserts(
1391    IMAGE_TAG_TABLE,
1392    array_keys($inserts[0]),
1393    $inserts
1394    );
1395}
1396
1397function tag_id_from_tag_name($tag_name)
1398{
1399  global $page;
1400
1401  $tag_name = trim($tag_name);
1402  if (isset($page['tag_id_from_tag_name_cache'][$tag_name]))
1403  {
1404    return $page['tag_id_from_tag_name_cache'][$tag_name];
1405  }
1406
1407  // does the tag already exists?
1408  $query = '
1409SELECT id
1410  FROM '.TAGS_TABLE.'
1411  WHERE name = \''.$tag_name.'\'
1412;';
1413  $existing_tags = array_from_query($query, 'id');
1414
1415  if (count($existing_tags) == 0)
1416  {
1417    mass_inserts(
1418      TAGS_TABLE,
1419      array('name', 'url_name'),
1420      array(
1421        array(
1422          'name' => $tag_name,
1423          'url_name' => str2url($tag_name),
1424          )
1425        )
1426      );
1427
1428    $page['tag_id_from_tag_name_cache'][$tag_name] = pwg_db_insert_id(TAGS_TABLE);
1429  }
1430  else
1431  {
1432    $page['tag_id_from_tag_name_cache'][$tag_name] = $existing_tags[0];
1433  }
1434
1435  return $page['tag_id_from_tag_name_cache'][$tag_name];
1436}
1437
1438function set_tags_of($tags_of)
1439{
1440  if (count($tags_of) > 0)
1441  {
1442    $query = '
1443DELETE
1444  FROM '.IMAGE_TAG_TABLE.'
1445  WHERE image_id IN ('.implode(',', array_keys($tags_of)).')
1446;';
1447    pwg_query($query);
1448
1449    $inserts = array();
1450
1451    foreach ($tags_of as $image_id => $tag_ids)
1452    {
1453      foreach ($tag_ids as $tag_id)
1454      {
1455        array_push(
1456          $inserts,
1457          array(
1458            'image_id' => $image_id,
1459            'tag_id' => $tag_id,
1460            )
1461          );
1462      }
1463    }
1464
1465    mass_inserts(
1466      IMAGE_TAG_TABLE,
1467      array_keys($inserts[0]),
1468      $inserts
1469      );
1470  }
1471}
1472
1473/**
1474 * Associate a list of images to a list of categories.
1475 *
1476 * The function will not duplicate links
1477 *
1478 * @param array images
1479 * @param array categories
1480 * @return void
1481 */
1482function associate_images_to_categories($images, $categories)
1483{
1484  if (count($images) == 0
1485      or count($categories) == 0)
1486  {
1487    return false;
1488  }
1489
1490  $query = '
1491DELETE
1492  FROM '.IMAGE_CATEGORY_TABLE.'
1493  WHERE image_id IN ('.implode(',', $images).')
1494    AND category_id IN ('.implode(',', $categories).')
1495;';
1496  pwg_query($query);
1497
1498  $inserts = array();
1499  foreach ($categories as $category_id)
1500  {
1501    foreach ($images as $image_id)
1502    {
1503      array_push(
1504        $inserts,
1505        array(
1506          'image_id' => $image_id,
1507          'category_id' => $category_id,
1508          )
1509        );
1510    }
1511  }
1512
1513  mass_inserts(
1514    IMAGE_CATEGORY_TABLE,
1515    array_keys($inserts[0]),
1516    $inserts
1517    );
1518
1519  update_category($categories);
1520}
1521
1522/**
1523 * Associate images associated to a list of source categories to a list of
1524 * destination categories.
1525 *
1526 * @param array sources
1527 * @param array destinations
1528 * @return void
1529 */
1530function associate_categories_to_categories($sources, $destinations)
1531{
1532  if (count($sources) == 0)
1533  {
1534    return false;
1535  }
1536
1537  $query = '
1538SELECT image_id
1539  FROM '.IMAGE_CATEGORY_TABLE.'
1540  WHERE category_id IN ('.implode(',', $sources).')
1541;';
1542  $images = array_from_query($query, 'image_id');
1543
1544  associate_images_to_categories($images, $destinations);
1545}
1546
1547/**
1548 * Refer main Piwigo URLs (currently PHPWG_DOMAIN domain)
1549 *
1550 * @param void
1551 * @return array like $conf['links']
1552 */
1553function pwg_URL()
1554{
1555  $urls = array(
1556    'HOME'       => 'http://'.PHPWG_DOMAIN,
1557    'WIKI'       => 'http://'.PHPWG_DOMAIN.'/doc',
1558    'DEMO'       => 'http://'.PHPWG_DOMAIN.'/demo',
1559    'FORUM'      => 'http://'.PHPWG_DOMAIN.'/forum',
1560    'BUGS'       => 'http://'.PHPWG_DOMAIN.'/bugs',
1561    'EXTENSIONS' => 'http://'.PHPWG_DOMAIN.'/ext',
1562    );
1563  return $urls;
1564}
1565
1566/**
1567 * Invalidates cahed data (permissions and category counts) for all users.
1568 */
1569function invalidate_user_cache($full = true)
1570{
1571  if ($full)
1572  {
1573    $query = '
1574TRUNCATE TABLE '.USER_CACHE_CATEGORIES_TABLE.';';
1575    pwg_query($query);
1576    $query = '
1577TRUNCATE TABLE '.USER_CACHE_TABLE.';';
1578    pwg_query($query);
1579  }
1580  else
1581  {
1582    $query = '
1583UPDATE '.USER_CACHE_TABLE.'
1584  SET need_update = \'true\';';
1585    pwg_query($query);
1586  }
1587  trigger_action('invalidate_user_cache', $full);
1588}
1589
1590/**
1591 * adds the caracter set to a create table sql query.
1592 * all CREATE TABLE queries must call this function
1593 * @param string query - the sql query
1594 */
1595function create_table_add_character_set($query)
1596{
1597  defined('DB_CHARSET') or fatal_error('create_table_add_character_set DB_CHARSET undefined');
1598  if ('DB_CHARSET'!='')
1599  {
1600    if ( version_compare(mysql_get_server_info(), '4.1.0', '<') )
1601    {
1602      return $query;
1603    }
1604    $charset_collate = " DEFAULT CHARACTER SET ".DB_CHARSET;
1605    if (DB_COLLATE!='')
1606    {
1607      $charset_collate .= " COLLATE ".DB_COLLATE;
1608    }
1609    if ( is_array($query) )
1610    {
1611      foreach( $query as $id=>$q)
1612      {
1613        $q=trim($q);
1614        $q=trim($q, ';');
1615        if (preg_match('/^CREATE\s+TABLE/i',$q))
1616        {
1617          $q.=$charset_collate;
1618        }
1619        $q .= ';';
1620        $query[$id] = $q;
1621      }
1622    }
1623    else
1624    {
1625      $query=trim($query);
1626      $query=trim($query, ';');
1627      if (preg_match('/^CREATE\s+TABLE/i',$query))
1628      {
1629        $query.=$charset_collate;
1630      }
1631      $query .= ';';
1632    }
1633  }
1634  return $query;
1635}
1636
1637/**
1638 * Returns array use on template with html_options method
1639 * @param Min and Max access to use
1640 * @return array of user access level
1641 */
1642function get_user_access_level_html_options($MinLevelAccess = ACCESS_FREE, $MaxLevelAccess = ACCESS_CLOSED)
1643{
1644  $tpl_options = array();
1645  for ($level = $MinLevelAccess; $level <= $MaxLevelAccess; $level++)
1646  {
1647    $tpl_options[$level] = l10n(sprintf('ACCESS_%d', $level));
1648  }
1649  return $tpl_options;
1650}
1651
1652/**
1653 * returns a list of templates currently available in template-extension
1654 * Each .tpl file is extracted from template-extension.
1655 * @return array
1656 */
1657function get_extents($start='')
1658{
1659  if ($start == '') { $start = './template-extension'; }
1660  $dir = opendir($start);
1661  $extents = array();
1662
1663  while (($file = readdir($dir)) !== false)
1664  {
1665    if ( $file == '.' or $file == '..' or $file == '.svn') continue;
1666    $path = $start . '/' . $file;
1667    if (is_dir($path))
1668    {
1669      $extents = array_merge($extents, get_extents($path));
1670    }
1671    elseif ( !is_link($path) and file_exists($path)
1672            and get_extension($path) == 'tpl' )
1673    {
1674      $extents[] = substr($path, 21);
1675    }
1676  }
1677  return $extents;
1678}
1679
1680function create_tag($tag_name)
1681{
1682  // does the tag already exists?
1683  $query = '
1684SELECT id
1685  FROM '.TAGS_TABLE.'
1686  WHERE name = \''.$tag_name.'\'
1687;';
1688  $existing_tags = array_from_query($query, 'id');
1689
1690  if (count($existing_tags) == 0)
1691  {
1692    mass_inserts(
1693      TAGS_TABLE,
1694      array('name', 'url_name'),
1695      array(
1696        array(
1697          'name' => $tag_name,
1698          'url_name' => str2url($tag_name),
1699          )
1700        )
1701      );
1702
1703    $inserted_id = pwg_db_insert_id(TAGS_TABLE);
1704
1705    return array(
1706      'info' => sprintf(
1707        l10n('Tag "%s" was added'),
1708        stripslashes($tag_name)
1709        ),
1710      'id' => $inserted_id,
1711      );
1712  }
1713  else
1714  {
1715    return array(
1716      'error' => sprintf(
1717        l10n('Tag "%s" already exists'),
1718        stripslashes($tag_name)
1719        )
1720      );
1721  }
1722}
1723
1724/**
1725 * Is the category accessible to the (Admin) user ?
1726 *
1727 * Note : if the user is not authorized to see this category, category jump
1728 * will be replaced by admin cat_modify page
1729 *
1730 * @param int category id to verify
1731 * @return bool
1732 */
1733function cat_admin_access($category_id)
1734{
1735  global $user;
1736
1737  // $filter['visible_categories'] and $filter['visible_images']
1738  // are not used because it's not necessary (filter <> restriction)
1739  if (in_array($category_id, explode(',', $user['forbidden_categories'])))
1740  {
1741    return false;
1742  }
1743  return true;
1744}
1745
1746/**
1747 * Retrieve data from external URL
1748 *
1749 * @param string $src: URL
1750 * @param global $dest: can be a file ressource or string
1751 * @return bool
1752 */
1753function fetchRemote($src, &$dest, $get_data=array(), $post_data=array(), $user_agent='Piwigo', $step=0)
1754{
1755  // Try to retrieve data from local file?
1756  if (!url_is_remote($src))
1757  {
1758    $content = @file_get_contents($src);
1759    if ($content !== false)
1760    {
1761      is_resource($dest) ? @fwrite($dest, $content) : $dest = $content;
1762      return true;
1763    }
1764    else
1765    {
1766      return false;
1767    }
1768  }
1769
1770  // After 3 redirections, return false
1771  if ($step > 3) return false;
1772
1773  // Initialization
1774  $method  = empty($post_data) ? 'GET' : 'POST';
1775  $request = empty($post_data) ? '' : http_build_query($post_data, '', '&');
1776  if (!empty($get_data))
1777  {
1778    $src .= strpos($src, '?') === false ? '?' : '&';
1779    $src .= http_build_query($get_data, '', '&');
1780  }
1781
1782  // Initialize $dest
1783  is_resource($dest) or $dest = '';
1784
1785  // Try curl to read remote file
1786  if (function_exists('curl_init'))
1787  {
1788    $ch = @curl_init();
1789    @curl_setopt($ch, CURLOPT_URL, $src);
1790    @curl_setopt($ch, CURLOPT_HEADER, 1);
1791    @curl_setopt($ch, CURLOPT_USERAGENT, $user_agent);
1792    @curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
1793    if ($method == 'POST')
1794    {
1795      @curl_setopt($ch, CURLOPT_POST, 1);
1796      @curl_setopt($ch, CURLOPT_POSTFIELDS, $request);
1797    }
1798    $content = @curl_exec($ch);
1799    $header_length = @curl_getinfo($ch, CURLINFO_HEADER_SIZE);
1800    $status = @curl_getinfo($ch, CURLINFO_HTTP_CODE);
1801    @curl_close($ch);
1802    if ($content !== false and $status >= 200 and $status < 400)
1803    {
1804      if (preg_match('/Location:\s+?(.+)/', substr($content, 0, $header_length), $m))
1805      {
1806        return fetchRemote($m[1], $dest, array(), array(), $user_agent, $step+1);
1807      }
1808      $content = substr($content, $header_length);
1809      is_resource($dest) ? @fwrite($dest, $content) : $dest = $content;
1810      return true;
1811    }
1812  }
1813
1814  // Try file_get_contents to read remote file
1815  if (ini_get('allow_url_fopen'))
1816  {
1817    $opts = array(
1818      'http' => array(
1819        'method' => $method,
1820        'user_agent' => $user_agent,
1821      )
1822    );
1823    if ($method == 'POST')
1824    {
1825      $opts['http']['content'] = $request;
1826    }
1827    $context = @stream_context_create($opts);
1828    $content = @file_get_contents($src, false, $context);
1829    if ($content !== false)
1830    {
1831      is_resource($dest) ? @fwrite($dest, $content) : $dest = $content;
1832      return true;
1833    }
1834  }
1835
1836  // Try fsockopen to read remote file
1837  $src = parse_url($src);
1838  $host = $src['host'];
1839  $path = isset($src['path']) ? $src['path'] : '/';
1840  $path .= isset($src['query']) ? '?'.$src['query'] : '';
1841
1842  if (($s = @fsockopen($host,80,$errno,$errstr,5)) === false)
1843  {
1844    return false;
1845  }
1846
1847  $http_request  = $method." ".$path." HTTP/1.0\r\n";
1848  $http_request .= "Host: ".$host."\r\n";
1849  if ($method == 'POST')
1850  {
1851    $http_request .= "Content-Type: application/x-www-form-urlencoded;\r\n";
1852    $http_request .= "Content-Length: ".strlen($request)."\r\n";
1853  }
1854  $http_request .= "User-Agent: ".$user_agent."\r\n";
1855  $http_request .= "Accept: */*\r\n";
1856  $http_request .= "\r\n";
1857  $http_request .= $request;
1858
1859  fwrite($s, $http_request);
1860
1861  $i = 0;
1862  $in_content = false;
1863  while (!feof($s))
1864  {
1865    $line = fgets($s);
1866
1867    if (rtrim($line,"\r\n") == '' && !$in_content)
1868    {
1869      $in_content = true;
1870      $i++;
1871      continue;
1872    }
1873    if ($i == 0)
1874    {
1875      if (!preg_match('/HTTP\/(\\d\\.\\d)\\s*(\\d+)\\s*(.*)/',rtrim($line,"\r\n"), $m))
1876      {
1877        fclose($s);
1878        return false;
1879      }
1880      $status = (integer) $m[2];
1881      if ($status < 200 || $status >= 400)
1882      {
1883        fclose($s);
1884        return false;
1885      }
1886    }
1887    if (!$in_content)
1888    {
1889      if (preg_match('/Location:\s+?(.+)$/',rtrim($line,"\r\n"),$m))
1890      {
1891        fclose($s);
1892        return fetchRemote(trim($m[1]),$dest,array(),array(),$user_agent,$step+1);
1893      }
1894      $i++;
1895      continue;
1896    }
1897    is_resource($dest) ? @fwrite($dest, $line) : $dest .= $line;
1898    $i++;
1899  }
1900  fclose($s);
1901  return true;
1902}
1903
1904
1905/**
1906 * returns the groupname corresponding to the given group identifier if
1907 * exists
1908 *
1909 * @param int group_id
1910 * @return mixed
1911 */
1912function get_groupname($group_id)
1913{
1914  $query = '
1915SELECT name
1916  FROM '.GROUPS_TABLE.'
1917  WHERE id = '.intval($group_id).'
1918;';
1919  $result = pwg_query($query);
1920  if (pwg_db_num_rows($result) > 0)
1921  {
1922    list($groupname) = pwg_db_fetch_row($result);
1923  }
1924  else
1925  {
1926    return false;
1927  }
1928
1929  return $groupname;
1930}
1931
1932/**
1933 * returns the username corresponding to the given user identifier if exists
1934 *
1935 * @param int user_id
1936 * @return mixed
1937 */
1938function get_username($user_id)
1939{
1940  global $conf;
1941
1942  $query = '
1943SELECT '.$conf['user_fields']['username'].'
1944  FROM '.USERS_TABLE.'
1945  WHERE '.$conf['user_fields']['id'].' = '.intval($user_id).'
1946;';
1947  $result = pwg_query($query);
1948  if (pwg_db_num_rows($result) > 0)
1949  {
1950    list($username) = pwg_db_fetch_row($result);
1951  }
1952  else
1953  {
1954    return false;
1955  }
1956
1957  return stripslashes($username);
1958}
1959
1960function get_newsletter_subscribe_base_url($language) {
1961  $subscribe_domain = 'piwigo.org';
1962
1963  $domain_of = array(
1964    'fr_FR' => 'fr.piwigo.org',
1965    'it_IT' => 'it.piwigo.org',
1966    'de_DE' => 'de.piwigo.org',
1967    'es_ES' => 'es.piwigo.org',
1968    'zh_CN' => 'cn.piwigo.org',
1969    'pl_PL' => 'pl.piwigo.org',
1970    'hu_HU' => 'hu.piwigo.org',
1971    'ru_RU' => 'ru.piwigo.org',
1972        'nl_NL' => 'nl.piwigo.org',
1973    );
1974
1975  if (isset($domain_of[$language])) {
1976    $subscribe_domain = $domain_of[$language];
1977  }
1978
1979  return 'http://'.$subscribe_domain.'/announcement/subscribe/';
1980}
1981
1982/**
1983 * Accordion menus need to know which section to open by default when
1984 * loading the page
1985 */
1986function get_active_menu($menu_page)
1987{
1988  global $page;
1989
1990  if (isset($page['active_menu']))
1991  {
1992    return $page['active_menu'];
1993  }
1994
1995  switch ($menu_page)
1996  {
1997    case 'photos_add':
1998    case 'rating':
1999    case 'tags':
2000    case 'picture_modify':
2001    case 'batch_manager':
2002      return 0;
2003
2004    case 'cat_list':
2005    case 'cat_modify':
2006    case 'cat_move':
2007    case 'cat_options':
2008    case 'cat_perm':
2009    case 'permalinks':
2010      return 1;
2011
2012    case 'user_list':
2013    case 'user_perm':
2014    case 'group_list':
2015    case 'group_perm':
2016    case 'notification_by_mail':
2017      return 2;
2018
2019    case 'plugins':
2020    case 'plugin':
2021      return 3;
2022
2023    case 'site_manager':
2024    case 'site_update':
2025    case 'stats':
2026    case 'history':
2027    case 'maintenance':
2028    case 'thumbnail':
2029    case 'comments':
2030    case 'updates':
2031      return 4;
2032
2033    case 'configuration':
2034    case 'extend_for_templates':
2035    case 'menubar':
2036    case 'themes':
2037    case 'theme':
2038    case 'languages':
2039      return 5;
2040  }
2041  return 0;
2042}
2043
2044function get_taglist($query)
2045{
2046  $result = pwg_query($query);
2047 
2048  $taglist = array();
2049  while ($row = pwg_db_fetch_assoc($result))
2050  {
2051    if (preg_match_all('#\[lang=(.*?)\](.*?)\[/lang\]#is', $row['name'], $matches))
2052    {
2053      foreach ($matches[2] as $tag_name)
2054      {
2055        array_push(
2056          $taglist,
2057          array(
2058            'name' => trigger_event('render_tag_name', $tag_name),
2059            'id' => '~~'.$row['id'].'~~',
2060            )
2061          );
2062      }
2063
2064      $row['tag_name'] = preg_replace('#\[lang=(.*?)\](.*?)\[/lang\]#is', null, $row['tag_name']);
2065    }
2066   
2067    if (strlen($row['name']) > 0)
2068    {
2069      array_push(
2070        $taglist,
2071        array(
2072          'name' => trigger_event('render_tag_name', $row['name']),
2073          'id' => '~~'.$row['id'].'~~',
2074          )
2075        );
2076    }
2077  }
2078 
2079  $cmp = create_function('$a,$b', 'return strcasecmp($a["name"], $b["name"]);');
2080  usort($taglist, $cmp);
2081
2082  return $taglist;
2083}
2084
2085function get_tag_ids($raw_tags, $allow_create=true)
2086{
2087  // In $raw_tags we receive something like array('~~6~~', '~~59~~', 'New
2088  // tag', 'Another new tag') The ~~34~~ means that it is an existing
2089  // tag. I've added the surrounding ~~ to permit creation of tags like "10"
2090  // or "1234" (numeric characters only)
2091
2092  $tag_ids = array();
2093  $raw_tags = explode(',',$raw_tags);
2094
2095  foreach ($raw_tags as $raw_tag)
2096  {
2097    if (preg_match('/^~~(\d+)~~$/', $raw_tag, $matches))
2098    {
2099      array_push($tag_ids, $matches[1]);
2100    }
2101    elseif ($allow_create)
2102    {
2103      // we have to create a new tag
2104      $tag_ids[] = tag_id_from_tag_name($raw_tag);
2105    }
2106  }
2107
2108  return $tag_ids;
2109}
2110
2111/** returns the argument_ids array with new sequenced keys based on related
2112 * names. Sequence is not case sensitive.
2113 * Warning: By definition, this function breaks original keys
2114 */
2115function order_by_name($element_ids,$name)
2116{
2117  $ordered_element_ids = array();
2118  foreach ($element_ids as $k_id => $element_id)
2119  {
2120    $key = strtolower($name[$element_id]) .'-'. $name[$element_id] .'-'. $k_id;
2121    $ordered_element_ids[$key] = $element_id;
2122  }
2123  ksort($ordered_element_ids);
2124  return $ordered_element_ids;
2125}
2126
2127function add_permission_on_category($category_ids, $user_ids)
2128{
2129  // array-ify categories and users
2130  if (!is_array($category_ids))
2131  {
2132    $category_ids = array($category_ids);
2133  }
2134
2135  if (!is_array($user_ids))
2136  {
2137    $user_ids = array($user_ids);
2138  }
2139
2140  // check for emptiness
2141  if (count($category_ids) == 0 or count($user_ids) == 0)
2142  {
2143    return;
2144  }
2145 
2146  // make sure categories are private and select uppercats
2147  $query = '
2148SELECT
2149    id
2150  FROM '.CATEGORIES_TABLE.'
2151  WHERE id IN ('.implode(',', get_uppercat_ids($category_ids)).')
2152    AND status = \'private\'
2153;';
2154  $private_uppercats = array_from_query($query, 'id');
2155
2156  if (count($private_uppercats) == 0)
2157  {
2158    return;
2159  }
2160 
2161  // We must not reinsert already existing lines in user_access table
2162  $granteds = array();
2163  foreach ($private_uppercats as $cat_id)
2164  {
2165    $granteds[$cat_id] = array();
2166  }
2167 
2168  $query = '
2169SELECT
2170    user_id,
2171    cat_id
2172  FROM '.USER_ACCESS_TABLE.'
2173  WHERE cat_id IN ('.implode(',', $private_uppercats).')
2174    AND user_id IN ('.implode(',', $user_ids).')
2175;';
2176  $result = pwg_query($query);
2177  while ($row = pwg_db_fetch_assoc($result))
2178  {
2179    array_push($granteds[$row['cat_id']], $row['user_id']);
2180  }
2181
2182  $inserts = array();
2183 
2184  foreach ($private_uppercats as $cat_id)
2185  {
2186    $grant_to_users = array_diff($user_ids, $granteds[$cat_id]);
2187   
2188    foreach ($grant_to_users as $user_id)
2189    {
2190      array_push(
2191        $inserts,
2192        array(
2193          'user_id' => $user_id,
2194          'cat_id' => $cat_id
2195          )
2196        );
2197    }
2198  }
2199
2200  if (count($inserts) > 0)
2201  {
2202    mass_inserts(USER_ACCESS_TABLE, array_keys($inserts[0]), $inserts);
2203  }
2204}
2205
2206
2207function get_admins($include_webmaster=true)
2208{
2209  $status_list = array('admin');
2210
2211  if ($include_webmaster)
2212  {
2213    $status_list[] = 'webmaster';
2214  }
2215 
2216  $query = '
2217SELECT
2218    user_id
2219  FROM '.USER_INFOS_TABLE.'
2220  WHERE status in (\''.implode("','", $status_list).'\')
2221;';
2222
2223  return array_from_query($query, 'user_id');
2224}
2225?>
Note: See TracBrowser for help on using the repository browser.