source: trunk/include/ws_functions.inc.php @ 17669

Last change on this file since 17669 was 17669, checked in by plg, 8 years ago

merge r17668 from branch 2.4 to trunk

bug 2733 fixed: when creating a sub-album in a private album with
pwg.categories.add, it is automatically private too.

  • Property svn:eol-style set to LF
File size: 84.2 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/**** IMPLEMENTATION OF WEB SERVICE METHODS ***********************************/
25
26/**
27 * Event handler for method invocation security check. Should return a PwgError
28 * if the preconditions are not satifsied for method invocation.
29 */
30function ws_isInvokeAllowed($res, $methodName, $params)
31{
32  global $conf;
33
34  if ( strpos($methodName,'reflection.')===0 )
35  { // OK for reflection
36    return $res;
37  }
38
39  if ( !is_autorize_status(ACCESS_GUEST) and
40      strpos($methodName,'pwg.session.')!==0 )
41  {
42    return new PwgError(401, 'Access denied');
43  }
44
45  return $res;
46}
47
48/**
49 * returns a "standard" (for our web service) array of sql where clauses that
50 * filters the images (images table only)
51 */
52function ws_std_image_sql_filter( $params, $tbl_name='' )
53{
54  $clauses = array();
55  if ( is_numeric($params['f_min_rate']) )
56  {
57    $clauses[] = $tbl_name.'rating_score>'.$params['f_min_rate'];
58  }
59  if ( is_numeric($params['f_max_rate']) )
60  {
61    $clauses[] = $tbl_name.'rating_score<='.$params['f_max_rate'];
62  }
63  if ( is_numeric($params['f_min_hit']) )
64  {
65    $clauses[] = $tbl_name.'hit>'.$params['f_min_hit'];
66  }
67  if ( is_numeric($params['f_max_hit']) )
68  {
69    $clauses[] = $tbl_name.'hit<='.$params['f_max_hit'];
70  }
71  if ( isset($params['f_min_date_available']) )
72  {
73    $clauses[] = $tbl_name."date_available>='".$params['f_min_date_available']."'";
74  }
75  if ( isset($params['f_max_date_available']) )
76  {
77    $clauses[] = $tbl_name."date_available<'".$params['f_max_date_available']."'";
78  }
79  if ( isset($params['f_min_date_created']) )
80  {
81    $clauses[] = $tbl_name."date_creation>='".$params['f_min_date_created']."'";
82  }
83  if ( isset($params['f_max_date_created']) )
84  {
85    $clauses[] = $tbl_name."date_creation<'".$params['f_max_date_created']."'";
86  }
87  if ( is_numeric($params['f_min_ratio']) )
88  {
89    $clauses[] = $tbl_name.'width/'.$tbl_name.'height>'.$params['f_min_ratio'];
90  }
91  if ( is_numeric($params['f_max_ratio']) )
92  {
93    $clauses[] = $tbl_name.'width/'.$tbl_name.'height<='.$params['f_max_ratio'];
94  }
95  if (is_numeric($params['f_max_level']) )
96  {
97    $clauses[] = $tbl_name.'level <= '.$params['f_max_level'];
98  }
99  return $clauses;
100}
101
102/**
103 * returns a "standard" (for our web service) ORDER BY sql clause for images
104 */
105function ws_std_image_sql_order( $params, $tbl_name='' )
106{
107  $ret = '';
108  if ( empty($params['order']) )
109  {
110    return $ret;
111  }
112  $matches = array();
113  preg_match_all('/([a-z_]+) *(?:(asc|desc)(?:ending)?)? *(?:, *|$)/i',
114    $params['order'], $matches);
115  for ($i=0; $i<count($matches[1]); $i++)
116  {
117    switch ($matches[1][$i])
118    {
119      case 'date_created':
120        $matches[1][$i] = 'date_creation'; break;
121      case 'date_posted':
122        $matches[1][$i] = 'date_available'; break;
123      case 'rand': case 'random':
124        $matches[1][$i] = DB_RANDOM_FUNCTION.'()'; break;
125    }
126    $sortable_fields = array('id', 'file', 'name', 'hit', 'rating_score',
127      'date_creation', 'date_available', DB_RANDOM_FUNCTION.'()' );
128    if ( in_array($matches[1][$i], $sortable_fields) )
129    {
130      if (!empty($ret))
131        $ret .= ', ';
132      if ($matches[1][$i] != DB_RANDOM_FUNCTION.'()' )
133      {
134        $ret .= $tbl_name;
135      }
136      $ret .= $matches[1][$i];
137      $ret .= ' '.$matches[2][$i];
138    }
139  }
140  return $ret;
141}
142
143/**
144 * returns an array map of urls (thumb/element) for image_row - to be returned
145 * in a standard way by different web service methods
146 */
147function ws_std_get_urls($image_row)
148{
149  $ret = array();
150
151  $src_image = new SrcImage($image_row);
152
153  if ( $src_image->is_original() )
154  {// we have a photo
155    global $user;
156    if ($user['enabled_high'])
157    {
158      $ret['element_url'] = $src_image->get_url();
159    }
160  }
161  else
162  {
163    $ret['element_url'] = get_element_url($image_row);
164  }
165
166  $derivatives = DerivativeImage::get_all($src_image);
167  $derivatives_arr = array();
168  foreach($derivatives as $type=>$derivative)
169  {
170    $size = $derivative->get_size();
171    $size != null or $size=array(null,null);
172    $derivatives_arr[$type] = array('url' => $derivative->get_url(), 'width'=>$size[0], 'height'=>$size[1] );
173  }
174  $ret['derivatives'] = $derivatives_arr;;
175  return $ret;
176}
177
178/**
179 * returns an array of image attributes that are to be encoded as xml attributes
180 * instead of xml elements
181 */
182function ws_std_get_image_xml_attributes()
183{
184  return array(
185    'id','element_url', 'file','width','height','hit','date_available','date_creation'
186    );
187}
188
189function ws_getMissingDerivatives($params, &$service)
190{
191  if (!is_admin())
192  {
193    return new PwgError(403, 'Forbidden');
194  }
195
196  if ( empty($params['types']) )
197  {
198    $types = array_keys(ImageStdParams::get_defined_type_map());
199  }
200  else
201  {
202    $types = array_intersect(array_keys(ImageStdParams::get_defined_type_map()), $params['types']);
203    if (count($types)==0)
204    {
205      return new PwgError(WS_ERR_INVALID_PARAM, "Invalid types");
206    }
207  }
208
209  if ( ($max_urls = intval($params['max_urls'])) <= 0)
210  {
211    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid max_urls");
212  }
213
214  list($max_id, $image_count) = pwg_db_fetch_row( pwg_query('SELECT MAX(id)+1, COUNT(*) FROM '.IMAGES_TABLE) );
215
216  if (0 == $image_count)
217  {
218    return array();
219  }
220
221  $start_id = intval($params['prev_page']);
222  if ($start_id<=0)
223  {
224    $start_id = $max_id;
225  }
226
227  $uid = '&b='.time();
228  global $conf;
229  $conf['question_mark_in_urls'] = $conf['php_extension_in_urls'] = true;
230  $conf['derivative_url_style']=2; //script
231
232  $qlimit = min(5000, ceil(max($image_count/500, $max_urls/count($types))));
233  $where_clauses = ws_std_image_sql_filter( $params, '' );
234  $where_clauses[] = 'id<start_id';
235  if ( !empty($params['ids']) )
236  {
237    $where_clauses[] = 'id IN ('.implode(',',$params['ids']).')';
238  }
239
240  $query_model = 'SELECT id, path, representative_ext, width,height,rotation
241  FROM '.IMAGES_TABLE.'
242  WHERE '.implode(' AND ', $where_clauses).'
243  ORDER BY id DESC
244  LIMIT '.$qlimit;
245
246  $urls=array();
247  do
248  {
249    $result = pwg_query( str_replace('start_id', $start_id, $query_model));
250    $is_last = pwg_db_num_rows($result) < $qlimit;
251    while ($row=pwg_db_fetch_assoc($result))
252    {
253      $start_id = $row['id'];
254      $src_image = new SrcImage($row);
255      if ($src_image->is_mimetype())
256        continue;
257      foreach($types as $type)
258      {
259        $derivative = new DerivativeImage($type, $src_image);
260        if ($type != $derivative->get_type())
261          continue;
262        if (@filemtime($derivative->get_path())===false)
263        {
264          $urls[] = $derivative->get_url().$uid;
265        }
266      }
267      if (count($urls)>=$max_urls && !$is_last)
268        break;
269    }
270    if ($is_last)
271    {
272      $start_id = 0;
273    }
274  }while (count($urls)<$max_urls && $start_id);
275
276  $ret = array();
277  if ($start_id)
278  {
279    $ret['next_page']=$start_id;
280  }
281  $ret['urls']=$urls;
282  return $ret;
283}
284
285/**
286 * returns PWG version (web service method)
287 */
288function ws_getVersion($params, &$service)
289{
290  global $conf;
291  if ($conf['show_version'] or is_admin() )
292    return PHPWG_VERSION;
293  else
294    return new PwgError(403, 'Forbidden');
295}
296
297/**
298 * returns general informations (web service method)
299 */
300function ws_getInfos($params, &$service)
301{
302  if (!is_admin())
303  {
304    return new PwgError(403, 'Forbidden');
305  }
306
307  $infos['version'] = PHPWG_VERSION;
308
309  $query = 'SELECT COUNT(*) FROM '.IMAGES_TABLE.';';
310  list($infos['nb_elements']) = pwg_db_fetch_row(pwg_query($query));
311
312  $query = 'SELECT COUNT(*) FROM '.CATEGORIES_TABLE.';';
313  list($infos['nb_categories']) = pwg_db_fetch_row(pwg_query($query));
314
315  $query = 'SELECT COUNT(*) FROM '.CATEGORIES_TABLE.' WHERE dir IS NULL;';
316  list($infos['nb_virtual']) = pwg_db_fetch_row(pwg_query($query));
317
318  $query = 'SELECT COUNT(*) FROM '.CATEGORIES_TABLE.' WHERE dir IS NOT NULL;';
319  list($infos['nb_physical']) = pwg_db_fetch_row(pwg_query($query));
320
321  $query = 'SELECT COUNT(*) FROM '.IMAGE_CATEGORY_TABLE.';';
322  list($infos['nb_image_category']) = pwg_db_fetch_row(pwg_query($query));
323
324  $query = 'SELECT COUNT(*) FROM '.TAGS_TABLE.';';
325  list($infos['nb_tags']) = pwg_db_fetch_row(pwg_query($query));
326
327  $query = 'SELECT COUNT(*) FROM '.IMAGE_TAG_TABLE.';';
328  list($infos['nb_image_tag']) = pwg_db_fetch_row(pwg_query($query));
329
330  $query = 'SELECT COUNT(*) FROM '.USERS_TABLE.';';
331  list($infos['nb_users']) = pwg_db_fetch_row(pwg_query($query));
332
333  $query = 'SELECT COUNT(*) FROM '.GROUPS_TABLE.';';
334  list($infos['nb_groups']) = pwg_db_fetch_row(pwg_query($query));
335
336  $query = 'SELECT COUNT(*) FROM '.COMMENTS_TABLE.';';
337  list($infos['nb_comments']) = pwg_db_fetch_row(pwg_query($query));
338
339  // first element
340  if ($infos['nb_elements'] > 0)
341  {
342    $query = 'SELECT MIN(date_available) FROM '.IMAGES_TABLE.';';
343    list($infos['first_date']) = pwg_db_fetch_row(pwg_query($query));
344  }
345
346  // unvalidated comments
347  if ($infos['nb_comments'] > 0)
348  {
349    $query = 'SELECT COUNT(*) FROM '.COMMENTS_TABLE.' WHERE validated=\'false\';';
350    list($infos['nb_unvalidated_comments']) = pwg_db_fetch_row(pwg_query($query));
351  }
352
353  foreach ($infos as $name => $value)
354  {
355    $output[] = array(
356      'name' => $name,
357      'value' => $value,
358    );
359  }
360
361  return array('infos' => new PwgNamedArray($output, 'item'));
362}
363
364function ws_caddie_add($params, &$service)
365{
366  if (!is_admin())
367  {
368    return new PwgError(401, 'Access denied');
369  }
370  $params['image_id'] = array_map( 'intval',$params['image_id'] );
371  if ( empty($params['image_id']) )
372  {
373    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
374  }
375  global $user;
376  $query = '
377SELECT id
378  FROM '.IMAGES_TABLE.' LEFT JOIN '.CADDIE_TABLE.' ON id=element_id AND user_id='.$user['id'].'
379  WHERE id IN ('.implode(',',$params['image_id']).')
380    AND element_id IS NULL';
381  $datas = array();
382  foreach ( array_from_query($query, 'id') as $id )
383  {
384    array_push($datas, array('element_id'=>$id, 'user_id'=>$user['id']) );
385  }
386  if (count($datas))
387  {
388    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
389    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
390  }
391  return count($datas);
392}
393
394/**
395 * returns images per category (web service method)
396 */
397function ws_categories_getImages($params, &$service)
398{
399  global $user, $conf;
400
401  $images = array();
402
403  //------------------------------------------------- get the related categories
404  $where_clauses = array();
405  foreach($params['cat_id'] as $cat_id)
406  {
407    $cat_id = (int)$cat_id;
408    if ($cat_id<=0)
409      continue;
410    if ($params['recursive'])
411    {
412      $where_clauses[] = 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.$cat_id.'(,|$)\'';
413    }
414    else
415    {
416      $where_clauses[] = 'id='.$cat_id;
417    }
418  }
419  if (!empty($where_clauses))
420  {
421    $where_clauses = array( '('.
422    implode('
423    OR ', $where_clauses) . ')'
424      );
425  }
426  $where_clauses[] = get_sql_condition_FandF(
427        array('forbidden_categories' => 'id'),
428        NULL, true
429      );
430
431  $query = '
432SELECT id, name, permalink, image_order
433  FROM '.CATEGORIES_TABLE.'
434  WHERE '. implode('
435    AND ', $where_clauses);
436  $result = pwg_query($query);
437  $cats = array();
438  while ($row = pwg_db_fetch_assoc($result))
439  {
440    $row['id'] = (int)$row['id'];
441    $cats[ $row['id'] ] = $row;
442  }
443
444  //-------------------------------------------------------- get the images
445  if ( !empty($cats) )
446  {
447    $where_clauses = ws_std_image_sql_filter( $params, 'i.' );
448    $where_clauses[] = 'category_id IN ('
449      .implode(',', array_keys($cats) )
450      .')';
451    $where_clauses[] = get_sql_condition_FandF( array(
452          'visible_images' => 'i.id'
453        ), null, true
454      );
455
456    $order_by = ws_std_image_sql_order($params, 'i.');
457    if ( empty($order_by)
458          and count($params['cat_id'])==1
459          and isset($cats[ $params['cat_id'][0] ]['image_order'])
460        )
461    {
462      $order_by = $cats[ $params['cat_id'][0] ]['image_order'];
463    }
464    $order_by = empty($order_by) ? $conf['order_by'] : 'ORDER BY '.$order_by;
465
466    $query = '
467SELECT i.*, GROUP_CONCAT(category_id) AS cat_ids
468  FROM '.IMAGES_TABLE.' i
469    INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON i.id=image_id
470  WHERE '. implode('
471    AND ', $where_clauses).'
472GROUP BY i.id
473'.$order_by.'
474LIMIT '.(int)$params['per_page'].' OFFSET '.(int)($params['per_page']*$params['page']);
475
476    $result = pwg_query($query);
477    while ($row = pwg_db_fetch_assoc($result))
478    {
479      $image = array();
480      foreach ( array('id', 'width', 'height', 'hit') as $k )
481      {
482        if (isset($row[$k]))
483        {
484          $image[$k] = (int)$row[$k];
485        }
486      }
487      foreach ( array('file', 'name', 'comment', 'date_creation', 'date_available') as $k )
488      {
489        $image[$k] = $row[$k];
490      }
491      $image = array_merge( $image, ws_std_get_urls($row) );
492
493      $image_cats = array();
494      foreach ( explode(',', $row['cat_ids']) as $cat_id )
495      {
496        $url = make_index_url(
497                array(
498                  'category' => $cats[$cat_id],
499                  )
500                );
501        $page_url = make_picture_url(
502                array(
503                  'category' => $cats[$cat_id],
504                  'image_id' => $row['id'],
505                  'image_file' => $row['file'],
506                  )
507                );
508        array_push( $image_cats,  array(
509              WS_XML_ATTRIBUTES => array (
510                  'id' => (int)$cat_id,
511                  'url' => $url,
512                  'page_url' => $page_url,
513                )
514            )
515          );
516      }
517
518      $image['categories'] = new PwgNamedArray(
519            $image_cats,'category', array('id','url','page_url')
520          );
521      array_push($images, $image);
522    }
523  }
524
525  return array( 'images' =>
526    array (
527      WS_XML_ATTRIBUTES =>
528        array(
529            'page' => $params['page'],
530            'per_page' => $params['per_page'],
531            'count' => count($images)
532          ),
533       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
534          ws_std_get_image_xml_attributes() )
535      )
536    );
537}
538
539
540/**
541 * create a tree from a flat list of categories, no recursivity for high speed
542 */
543function categories_flatlist_to_tree($categories)
544{
545  $tree = array();
546  $key_of_cat = array();
547
548  foreach ($categories as $key => &$node)
549  {
550    $key_of_cat[$node['id']] = $key;
551
552    if (!isset($node['id_uppercat']))
553    {
554      $tree[$key] = &$node;
555    }
556    else
557    {
558      if (!isset($categories[ $key_of_cat[ $node['id_uppercat'] ] ]['sub_categories']))
559      {
560        $categories[ $key_of_cat[ $node['id_uppercat'] ] ]['sub_categories'] = array();
561      }
562
563      $categories[ $key_of_cat[ $node['id_uppercat'] ] ]['sub_categories'][$key] = &$node;
564    }
565  }
566
567  return $tree;
568}
569
570/**
571 * returns a list of categories (web service method)
572 */
573function ws_categories_getList($params, &$service)
574{
575  global $user,$conf;
576
577  if ($params['tree_output'])
578  {
579    if (!isset($_GET['format']) or !in_array($_GET['format'], array('php', 'json')))
580    {
581      // the algorithm used to build a tree from a flat list of categories
582      // keeps original array keys, which is not compatible with
583      // PwgNamedArray.
584      //
585      // PwgNamedArray is useful to define which data is an attribute and
586      // which is an element in the XML output. The "hierarchy" output is
587      // only compatible with json/php output.
588
589      return new PwgError(405, "The tree_output option is only compatible with json/php output formats");
590    }
591  }
592
593  $where = array('1=1');
594  $join_type = 'INNER';
595  $join_user = $user['id'];
596
597  if (!$params['recursive'])
598  {
599    if ($params['cat_id']>0)
600      $where[] = '(id_uppercat='.(int)($params['cat_id']).'
601    OR id='.(int)($params['cat_id']).')';
602    else
603      $where[] = 'id_uppercat IS NULL';
604  }
605  else if ($params['cat_id']>0)
606  {
607    $where[] = 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.
608      (int)($params['cat_id'])
609      .'(,|$)\'';
610  }
611
612  if ($params['public'])
613  {
614    $where[] = 'status = "public"';
615    $where[] = 'visible = "true"';
616
617    $join_user = $conf['guest_id'];
618  }
619  elseif (is_admin())
620  {
621    // in this very specific case, we don't want to hide empty
622    // categories. Function calculate_permissions will only return
623    // categories that are either locked or private and not permitted
624    //
625    // calculate_permissions does not consider empty categories as forbidden
626    $forbidden_categories = calculate_permissions($user['id'], $user['status']);
627    $where[]= 'id NOT IN ('.$forbidden_categories.')';
628    $join_type = 'LEFT';
629  }
630
631  $query = '
632SELECT id, name, permalink, uppercats, global_rank, id_uppercat,
633    comment,
634    nb_images, count_images AS total_nb_images,
635    representative_picture_id, user_representative_picture_id, count_images, count_categories,
636    date_last, max_date_last, count_categories AS nb_categories
637  FROM '.CATEGORIES_TABLE.'
638   '.$join_type.' JOIN '.USER_CACHE_CATEGORIES_TABLE.' ON id=cat_id AND user_id='.$join_user.'
639  WHERE '. implode('
640    AND ', $where);
641
642  $result = pwg_query($query);
643
644  // management of the album thumbnail -- starts here
645  $image_ids = array();
646  $categories = array();
647  $user_representative_updates_for = array();
648  // management of the album thumbnail -- stops here
649
650  $cats = array();
651  while ($row = pwg_db_fetch_assoc($result))
652  {
653    $row['url'] = make_index_url(
654        array(
655          'category' => $row
656          )
657      );
658    foreach( array('id','nb_images','total_nb_images','nb_categories') as $key)
659    {
660      $row[$key] = (int)$row[$key];
661    }
662
663    if ($params['fullname'])
664    {
665      $row['name'] = strip_tags(get_cat_display_name_cache($row['uppercats'], null, false));
666    }
667    else
668    {
669      $row['name'] = strip_tags(
670        trigger_event(
671          'render_category_name',
672          $row['name'],
673          'ws_categories_getList'
674          )
675        );
676    }
677
678    $row['comment'] = strip_tags(
679      trigger_event(
680        'render_category_description',
681        $row['comment'],
682        'ws_categories_getList'
683        )
684      );
685
686    // management of the album thumbnail -- starts here
687    //
688    // on branch 2.3, the algorithm is duplicated from
689    // include/category_cats, but we should use a common code for Piwigo 2.4
690    //
691    // warning : if the API method is called with $params['public'], the
692    // album thumbnail may be not accurate. The thumbnail can be viewed by
693    // the connected user, but maybe not by the guest. Changing the
694    // filtering method would be too complicated for now. We will simply
695    // avoid to persist the user_representative_picture_id in the database
696    // if $params['public']
697    if (!empty($row['user_representative_picture_id']))
698    {
699      $image_id = $row['user_representative_picture_id'];
700    }
701    else if (!empty($row['representative_picture_id']))
702    { // if a representative picture is set, it has priority
703      $image_id = $row['representative_picture_id'];
704    }
705    else if ($conf['allow_random_representative'])
706    {
707      // searching a random representant among elements in sub-categories
708      $image_id = get_random_image_in_category($row);
709    }
710    else
711    { // searching a random representant among representant of sub-categories
712      if ($row['count_categories']>0 and $row['count_images']>0)
713      {
714        $query = '
715  SELECT representative_picture_id
716    FROM '.CATEGORIES_TABLE.' INNER JOIN '.USER_CACHE_CATEGORIES_TABLE.'
717    ON id = cat_id and user_id = '.$user['id'].'
718    WHERE uppercats LIKE \''.$row['uppercats'].',%\'
719      AND representative_picture_id IS NOT NULL'
720          .get_sql_condition_FandF
721          (
722            array
723            (
724              'visible_categories' => 'id',
725              ),
726            "\n  AND"
727            ).'
728    ORDER BY '.DB_RANDOM_FUNCTION.'()
729    LIMIT 1
730  ;';
731        $subresult = pwg_query($query);
732        if (pwg_db_num_rows($subresult) > 0)
733        {
734          list($image_id) = pwg_db_fetch_row($subresult);
735        }
736      }
737    }
738
739    if (isset($image_id))
740    {
741      if ($conf['representative_cache_on_subcats'] and $row['user_representative_picture_id'] != $image_id)
742      {
743        $user_representative_updates_for[ $user['id'].'#'.$row['id'] ] = $image_id;
744      }
745
746      $row['representative_picture_id'] = $image_id;
747      array_push($image_ids, $image_id);
748      array_push($categories, $row);
749    }
750    unset($image_id);
751    // management of the album thumbnail -- stops here
752
753
754    array_push($cats, $row);
755  }
756  usort($cats, 'global_rank_compare');
757
758  // management of the album thumbnail -- starts here
759  if (count($categories) > 0)
760  {
761    $thumbnail_src_of = array();
762    $new_image_ids = array();
763
764    $query = '
765SELECT id, path, representative_ext, level
766  FROM '.IMAGES_TABLE.'
767  WHERE id IN ('.implode(',', $image_ids).')
768;';
769    $result = pwg_query($query);
770    while ($row = pwg_db_fetch_assoc($result))
771    {
772      if ($row['level'] <= $user['level'])
773      {
774        $thumbnail_src_of[$row['id']] = DerivativeImage::thumb_url($row);
775      }
776      else
777      {
778        // problem: we must not display the thumbnail of a photo which has a
779        // higher privacy level than user privacy level
780        //
781        // * what is the represented category?
782        // * find a random photo matching user permissions
783        // * register it at user_representative_picture_id
784        // * set it as the representative_picture_id for the category
785
786        foreach ($categories as &$category)
787        {
788          if ($row['id'] == $category['representative_picture_id'])
789          {
790            // searching a random representant among elements in sub-categories
791            $image_id = get_random_image_in_category($category);
792
793            if (isset($image_id) and !in_array($image_id, $image_ids))
794            {
795              array_push($new_image_ids, $image_id);
796            }
797
798            if ($conf['representative_cache_on_level'])
799            {
800              $user_representative_updates_for[ $user['id'].'#'.$category['id'] ] = $image_id;
801            }
802
803            $category['representative_picture_id'] = $image_id;
804          }
805        }
806        unset($category);
807      }
808    }
809
810    if (count($new_image_ids) > 0)
811    {
812      $query = '
813SELECT id, path, representative_ext
814  FROM '.IMAGES_TABLE.'
815  WHERE id IN ('.implode(',', $new_image_ids).')
816;';
817      $result = pwg_query($query);
818      while ($row = pwg_db_fetch_assoc($result))
819      {
820        $thumbnail_src_of[$row['id']] = DerivativeImage::thumb_url($row);
821      }
822    }
823  }
824
825  // compared to code in include/category_cats, we only persist the new
826  // user_representative if we have used $user['id'] and not the guest id,
827  // or else the real guest may see thumbnail that he should not
828  if (!$params['public'] and count($user_representative_updates_for))
829  {
830    $updates = array();
831
832    foreach ($user_representative_updates_for as $user_cat => $image_id)
833    {
834      list($user_id, $cat_id) = explode('#', $user_cat);
835
836      array_push(
837        $updates,
838        array(
839          'user_id' => $user_id,
840          'cat_id' => $cat_id,
841          'user_representative_picture_id' => $image_id,
842          )
843        );
844    }
845
846    mass_updates(
847      USER_CACHE_CATEGORIES_TABLE,
848      array(
849        'primary' => array('user_id', 'cat_id'),
850        'update'  => array('user_representative_picture_id')
851        ),
852      $updates
853      );
854  }
855
856  foreach ($cats as &$cat)
857  {
858    foreach ($categories as $category)
859    {
860      if ($category['id'] == $cat['id'] and isset($category['representative_picture_id']))
861      {
862        $cat['tn_url'] = $thumbnail_src_of[$category['representative_picture_id']];
863      }
864    }
865    // we don't want them in the output
866    unset($cat['user_representative_picture_id']);
867    unset($cat['count_images']);
868    unset($cat['count_categories']);
869  }
870  unset($cat);
871  // management of the album thumbnail -- stops here
872
873  if ($params['tree_output'])
874  {
875    return categories_flatlist_to_tree($cats);
876  }
877  else
878  {
879    return array(
880      'categories' => new PwgNamedArray(
881        $cats,
882        'category',
883        array(
884          'id',
885          'url',
886          'nb_images',
887          'total_nb_images',
888          'nb_categories',
889          'date_last',
890          'max_date_last',
891          )
892        )
893      );
894  }
895}
896
897/**
898 * returns the list of categories as you can see them in administration (web
899 * service method).
900 *
901 * Only admin can run this method and permissions are not taken into
902 * account.
903 */
904function ws_categories_getAdminList($params, &$service)
905{
906  if (!is_admin())
907  {
908    return new PwgError(401, 'Access denied');
909  }
910
911  $query = '
912SELECT
913    category_id,
914    COUNT(*) AS counter
915  FROM '.IMAGE_CATEGORY_TABLE.'
916  GROUP BY category_id
917;';
918  $nb_images_of = simple_hash_from_query($query, 'category_id', 'counter');
919
920  $query = '
921SELECT
922    id,
923    name,
924    comment,
925    uppercats,
926    global_rank
927  FROM '.CATEGORIES_TABLE.'
928;';
929  $result = pwg_query($query);
930  $cats = array();
931
932  while ($row = pwg_db_fetch_assoc($result))
933  {
934    $id = $row['id'];
935    $row['nb_images'] = isset($nb_images_of[$id]) ? $nb_images_of[$id] : 0;
936    $row['name'] = strip_tags(
937      trigger_event(
938        'render_category_name',
939        $row['name'],
940        'ws_categories_getAdminList'
941        )
942      );
943    $row['comment'] = strip_tags(
944      trigger_event(
945        'render_category_description',
946        $row['comment'],
947        'ws_categories_getAdminList'
948        )
949      );
950    array_push($cats, $row);
951  }
952
953  usort($cats, 'global_rank_compare');
954  return array(
955    'categories' => new PwgNamedArray(
956      $cats,
957      'category',
958      array(
959        'id',
960        'nb_images',
961        'name',
962        'uppercats',
963        'global_rank',
964        )
965      )
966    );
967}
968
969/**
970 * returns detailed information for an element (web service method)
971 */
972function ws_images_addComment($params, &$service)
973{
974  if (!$service->isPost())
975  {
976    return new PwgError(405, "This method requires HTTP POST");
977  }
978  $params['image_id'] = (int)$params['image_id'];
979  $query = '
980SELECT DISTINCT image_id
981  FROM '.IMAGE_CATEGORY_TABLE.' INNER JOIN '.CATEGORIES_TABLE.' ON category_id=id
982  WHERE commentable="true"
983    AND image_id='.$params['image_id'].
984    get_sql_condition_FandF(
985      array(
986        'forbidden_categories' => 'id',
987        'visible_categories' => 'id',
988        'visible_images' => 'image_id'
989      ),
990      ' AND'
991    );
992  if ( !pwg_db_num_rows( pwg_query( $query ) ) )
993  {
994    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
995  }
996
997  $comm = array(
998    'author' => trim( $params['author'] ),
999    'content' => trim( $params['content'] ),
1000    'image_id' => $params['image_id'],
1001   );
1002
1003  include_once(PHPWG_ROOT_PATH.'include/functions_comment.inc.php');
1004
1005  $comment_action = insert_user_comment(
1006      $comm, $params['key'], $infos
1007    );
1008
1009  switch ($comment_action)
1010  {
1011    case 'reject':
1012      array_push($infos, l10n('Your comment has NOT been registered because it did not pass the validation rules') );
1013      return new PwgError(403, implode("; ", $infos) );
1014    case 'validate':
1015    case 'moderate':
1016      $ret = array(
1017          'id' => $comm['id'],
1018          'validation' => $comment_action=='validate',
1019        );
1020      return new PwgNamedStruct(
1021          'comment',
1022          $ret,
1023          null, array()
1024        );
1025    default:
1026      return new PwgError(500, "Unknown comment action ".$comment_action );
1027  }
1028}
1029
1030/**
1031 * returns detailed information for an element (web service method)
1032 */
1033function ws_images_getInfo($params, &$service)
1034{
1035  global $user, $conf;
1036  $params['image_id'] = (int)$params['image_id'];
1037  if ( $params['image_id']<=0 )
1038  {
1039    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1040  }
1041
1042  $query='
1043SELECT * FROM '.IMAGES_TABLE.'
1044  WHERE id='.$params['image_id'].
1045    get_sql_condition_FandF(
1046      array('visible_images' => 'id'),
1047      ' AND'
1048    ).'
1049LIMIT 1';
1050
1051  $image_row = pwg_db_fetch_assoc(pwg_query($query));
1052  if ($image_row==null)
1053  {
1054    return new PwgError(404, "image_id not found");
1055  }
1056  $image_row = array_merge( $image_row, ws_std_get_urls($image_row) );
1057
1058  //-------------------------------------------------------- related categories
1059  $query = '
1060SELECT id, name, permalink, uppercats, global_rank, commentable
1061  FROM '.IMAGE_CATEGORY_TABLE.'
1062    INNER JOIN '.CATEGORIES_TABLE.' ON category_id = id
1063  WHERE image_id = '.$image_row['id'].
1064  get_sql_condition_FandF(
1065      array( 'forbidden_categories' => 'category_id' ),
1066      ' AND'
1067    ).'
1068;';
1069  $result = pwg_query($query);
1070  $is_commentable = false;
1071  $related_categories = array();
1072  while ($row = pwg_db_fetch_assoc($result))
1073  {
1074    if ($row['commentable']=='true')
1075    {
1076      $is_commentable = true;
1077    }
1078    unset($row['commentable']);
1079    $row['url'] = make_index_url(
1080        array(
1081          'category' => $row
1082          )
1083      );
1084
1085    $row['page_url'] = make_picture_url(
1086        array(
1087          'image_id' => $image_row['id'],
1088          'image_file' => $image_row['file'],
1089          'category' => $row
1090          )
1091      );
1092    $row['id']=(int)$row['id'];
1093    array_push($related_categories, $row);
1094  }
1095  usort($related_categories, 'global_rank_compare');
1096  if ( empty($related_categories) )
1097  {
1098    return new PwgError(401, 'Access denied');
1099  }
1100
1101  //-------------------------------------------------------------- related tags
1102  $related_tags = get_common_tags( array($image_row['id']), -1 );
1103  foreach( $related_tags as $i=>$tag)
1104  {
1105    $tag['url'] = make_index_url(
1106        array(
1107          'tags' => array($tag)
1108          )
1109      );
1110    $tag['page_url'] = make_picture_url(
1111        array(
1112          'image_id' => $image_row['id'],
1113          'image_file' => $image_row['file'],
1114          'tags' => array($tag),
1115          )
1116      );
1117    unset($tag['counter']);
1118    $tag['id']=(int)$tag['id'];
1119    $related_tags[$i]=$tag;
1120  }
1121  //------------------------------------------------------------- related rates
1122        $rating = array('score'=>$image_row['rating_score'], 'count'=>0, 'average'=>null);
1123        if (isset($rating['score']))
1124        {
1125                $query = '
1126SELECT COUNT(rate) AS count
1127     , ROUND(AVG(rate),2) AS average
1128  FROM '.RATE_TABLE.'
1129  WHERE element_id = '.$image_row['id'].'
1130;';
1131                $row = pwg_db_fetch_assoc(pwg_query($query));
1132                $rating['score'] = (float)$rating['score'];
1133                $rating['average'] = (float)$row['average'];
1134                $rating['count'] = (int)$row['count'];
1135        }
1136
1137  //---------------------------------------------------------- related comments
1138  $related_comments = array();
1139
1140  $where_comments = 'image_id = '.$image_row['id'];
1141  if ( !is_admin() )
1142  {
1143    $where_comments .= '
1144    AND validated="true"';
1145  }
1146
1147  $query = '
1148SELECT COUNT(id) AS nb_comments
1149  FROM '.COMMENTS_TABLE.'
1150  WHERE '.$where_comments;
1151  list($nb_comments) = array_from_query($query, 'nb_comments');
1152  $nb_comments = (int)$nb_comments;
1153
1154  if ( $nb_comments>0 and $params['comments_per_page']>0 )
1155  {
1156    $query = '
1157SELECT id, date, author, content
1158  FROM '.COMMENTS_TABLE.'
1159  WHERE '.$where_comments.'
1160  ORDER BY date
1161  LIMIT '.(int)$params['comments_per_page'].
1162    ' OFFSET '.(int)($params['comments_per_page']*$params['comments_page']);
1163
1164    $result = pwg_query($query);
1165    while ($row = pwg_db_fetch_assoc($result))
1166    {
1167      $row['id']=(int)$row['id'];
1168      array_push($related_comments, $row);
1169    }
1170  }
1171
1172  $comment_post_data = null;
1173  if ($is_commentable and
1174      (!is_a_guest()
1175        or (is_a_guest() and $conf['comments_forall'] )
1176      )
1177      )
1178  {
1179    $comment_post_data['author'] = stripslashes($user['username']);
1180    $comment_post_data['key'] = get_ephemeral_key(2, $params['image_id']);
1181  }
1182
1183  $ret = $image_row;
1184  foreach ( array('id','width','height','hit','filesize') as $k )
1185  {
1186    if (isset($ret[$k]))
1187    {
1188      $ret[$k] = (int)$ret[$k];
1189    }
1190  }
1191  foreach ( array('path', 'storage_category_id') as $k )
1192  {
1193    unset($ret[$k]);
1194  }
1195
1196  $ret['rates'] = array( WS_XML_ATTRIBUTES => $rating );
1197  $ret['categories'] = new PwgNamedArray($related_categories, 'category', array('id','url', 'page_url') );
1198  $ret['tags'] = new PwgNamedArray($related_tags, 'tag', array('id','url_name','url','name','page_url') );
1199  if ( isset($comment_post_data) )
1200  {
1201    $ret['comment_post'] = array( WS_XML_ATTRIBUTES => $comment_post_data );
1202  }
1203  $ret['comments'] = array(
1204     WS_XML_ATTRIBUTES =>
1205        array(
1206          'page' => $params['comments_page'],
1207          'per_page' => $params['comments_per_page'],
1208          'count' => count($related_comments),
1209          'nb_comments' => $nb_comments,
1210        ),
1211     WS_XML_CONTENT => new PwgNamedArray($related_comments, 'comment', array('id','date') )
1212      );
1213
1214  return new PwgNamedStruct('image',$ret, null, array('name','comment') );
1215}
1216
1217
1218/**
1219 * rates the image_id in the parameter
1220 */
1221function ws_images_Rate($params, &$service)
1222{
1223  $image_id = (int)$params['image_id'];
1224  $query = '
1225SELECT DISTINCT id FROM '.IMAGES_TABLE.'
1226  INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON id=image_id
1227  WHERE id='.$image_id
1228  .get_sql_condition_FandF(
1229    array(
1230        'forbidden_categories' => 'category_id',
1231        'forbidden_images' => 'id',
1232      ),
1233    '    AND'
1234    ).'
1235    LIMIT 1';
1236  if ( pwg_db_num_rows( pwg_query($query) )==0 )
1237  {
1238    return new PwgError(404, "Invalid image_id or access denied" );
1239  }
1240  $rate = (int)$params['rate'];
1241  include_once(PHPWG_ROOT_PATH.'include/functions_rate.inc.php');
1242  $res = rate_picture( $image_id, $rate );
1243  if ($res==false)
1244  {
1245    global $conf;
1246    return new PwgError( 403, "Forbidden or rate not in ". implode(',',$conf['rate_items']));
1247  }
1248  return $res;
1249}
1250
1251
1252/**
1253 * returns a list of elements corresponding to a query search
1254 */
1255function ws_images_search($params, &$service)
1256{
1257  global $page;
1258  $images = array();
1259  include_once( PHPWG_ROOT_PATH .'include/functions_search.inc.php' );
1260
1261  $where_clauses = ws_std_image_sql_filter( $params, 'i.' );
1262  $order_by = ws_std_image_sql_order($params, 'i.');
1263
1264  $super_order_by = false;
1265  if ( !empty($order_by) )
1266  {
1267    global $conf;
1268    $conf['order_by'] = 'ORDER BY '.$order_by;
1269    $super_order_by=true; // quick_search_result might be faster
1270  }
1271
1272  $search_result = get_quick_search_results($params['query'],
1273      $super_order_by,
1274      implode(',', $where_clauses)
1275    );
1276
1277  $image_ids = array_slice(
1278      $search_result['items'],
1279      $params['page']*$params['per_page'],
1280      $params['per_page']
1281    );
1282
1283  if ( count($image_ids) )
1284  {
1285    $query = '
1286SELECT * FROM '.IMAGES_TABLE.'
1287  WHERE id IN ('.implode(',', $image_ids).')';
1288
1289    $image_ids = array_flip($image_ids);
1290    $result = pwg_query($query);
1291    while ($row = pwg_db_fetch_assoc($result))
1292    {
1293      $image = array();
1294      foreach ( array('id', 'width', 'height', 'hit') as $k )
1295      {
1296        if (isset($row[$k]))
1297        {
1298          $image[$k] = (int)$row[$k];
1299        }
1300      }
1301      foreach ( array('file', 'name', 'comment', 'date_creation', 'date_available') as $k )
1302      {
1303        $image[$k] = $row[$k];
1304      }
1305      $image = array_merge( $image, ws_std_get_urls($row) );
1306      $images[$image_ids[$image['id']]] = $image;
1307    }
1308    ksort($images, SORT_NUMERIC);
1309    $images = array_values($images);
1310  }
1311
1312
1313  return array( 'images' =>
1314    array (
1315      WS_XML_ATTRIBUTES =>
1316        array(
1317            'page' => $params['page'],
1318            'per_page' => $params['per_page'],
1319            'count' => count($images)
1320          ),
1321       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
1322          ws_std_get_image_xml_attributes() )
1323      )
1324    );
1325}
1326
1327function ws_images_setPrivacyLevel($params, &$service)
1328{
1329  if (!is_admin())
1330  {
1331    return new PwgError(401, 'Access denied');
1332  }
1333  if (!$service->isPost())
1334  {
1335    return new PwgError(405, "This method requires HTTP POST");
1336  }
1337  $params['image_id'] = array_map( 'intval',$params['image_id'] );
1338  if ( empty($params['image_id']) )
1339  {
1340    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1341  }
1342  global $conf;
1343  if ( !in_array( (int)$params['level'], $conf['available_permission_levels']) )
1344  {
1345    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid level");
1346  }
1347
1348  $query = '
1349UPDATE '.IMAGES_TABLE.'
1350  SET level='.(int)$params['level'].'
1351  WHERE id IN ('.implode(',',$params['image_id']).')';
1352  $result = pwg_query($query);
1353  $affected_rows = pwg_db_changes($result);
1354  if ($affected_rows)
1355  {
1356    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1357    invalidate_user_cache();
1358  }
1359  return $affected_rows;
1360}
1361
1362function ws_images_setRank($params, &$service)
1363{
1364  if (!is_admin())
1365  {
1366    return new PwgError(401, 'Access denied');
1367  }
1368
1369  if (!$service->isPost())
1370  {
1371    return new PwgError(405, "This method requires HTTP POST");
1372  }
1373
1374  // is the image_id valid?
1375  $params['image_id'] = (int)$params['image_id'];
1376  if ($params['image_id'] <= 0)
1377  {
1378    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1379  }
1380
1381  // is the category valid?
1382  $params['category_id'] = (int)$params['category_id'];
1383  if ($params['category_id'] <= 0)
1384  {
1385    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1386  }
1387
1388  // is the rank valid?
1389  $params['rank'] = (int)$params['rank'];
1390  if ($params['rank'] <= 0)
1391  {
1392    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid rank");
1393  }
1394
1395  // does the image really exist?
1396  $query='
1397SELECT
1398    *
1399  FROM '.IMAGES_TABLE.'
1400  WHERE id = '.$params['image_id'].'
1401;';
1402
1403  $image_row = pwg_db_fetch_assoc(pwg_query($query));
1404  if ($image_row == null)
1405  {
1406    return new PwgError(404, "image_id not found");
1407  }
1408
1409  // is the image associated to this category?
1410  $query = '
1411SELECT
1412    image_id,
1413    category_id,
1414    rank
1415  FROM '.IMAGE_CATEGORY_TABLE.'
1416  WHERE image_id = '.$params['image_id'].'
1417    AND category_id = '.$params['category_id'].'
1418;';
1419  $category_row = pwg_db_fetch_assoc(pwg_query($query));
1420  if ($category_row == null)
1421  {
1422    return new PwgError(404, "This image is not associated to this category");
1423  }
1424
1425  // what is the current higher rank for this category?
1426  $query = '
1427SELECT
1428    MAX(rank) AS max_rank
1429  FROM '.IMAGE_CATEGORY_TABLE.'
1430  WHERE category_id = '.$params['category_id'].'
1431;';
1432  $result = pwg_query($query);
1433  $row = pwg_db_fetch_assoc($result);
1434
1435  if (is_numeric($row['max_rank']))
1436  {
1437    if ($params['rank'] > $row['max_rank'])
1438    {
1439      $params['rank'] = $row['max_rank'] + 1;
1440    }
1441  }
1442  else
1443  {
1444    $params['rank'] = 1;
1445  }
1446
1447  // update rank for all other photos in the same category
1448  $query = '
1449UPDATE '.IMAGE_CATEGORY_TABLE.'
1450  SET rank = rank + 1
1451  WHERE category_id = '.$params['category_id'].'
1452    AND rank IS NOT NULL
1453    AND rank >= '.$params['rank'].'
1454;';
1455  pwg_query($query);
1456
1457  // set the new rank for the photo
1458  $query = '
1459UPDATE '.IMAGE_CATEGORY_TABLE.'
1460  SET rank = '.$params['rank'].'
1461  WHERE image_id = '.$params['image_id'].'
1462    AND category_id = '.$params['category_id'].'
1463;';
1464  pwg_query($query);
1465
1466  // return data for client
1467  return array(
1468    'image_id' => $params['image_id'],
1469    'category_id' => $params['category_id'],
1470    'rank' => $params['rank'],
1471    );
1472}
1473
1474function ws_images_add_chunk($params, &$service)
1475{
1476  global $conf;
1477
1478  // data
1479  // original_sum
1480  // type {thumb, file, high}
1481  // position
1482
1483  if (!is_admin())
1484  {
1485    return new PwgError(401, 'Access denied');
1486  }
1487
1488  if (!$service->isPost())
1489  {
1490    return new PwgError(405, "This method requires HTTP POST");
1491  }
1492
1493  foreach ($params as $param_key => $param_value) {
1494    if ('data' == $param_key) {
1495      continue;
1496    }
1497
1498    ws_logfile(
1499      sprintf(
1500        '[ws_images_add_chunk] input param "%s" : "%s"',
1501        $param_key,
1502        is_null($param_value) ? 'NULL' : $param_value
1503        )
1504      );
1505  }
1506
1507  $upload_dir = $conf['upload_dir'].'/buffer';
1508
1509  // create the upload directory tree if not exists
1510  if (!is_dir($upload_dir)) {
1511    umask(0000);
1512    if (!@mkdir($upload_dir, 0777, true))
1513    {
1514      return new PwgError(500, 'error during buffer directory creation');
1515    }
1516  }
1517
1518  if (!is_writable($upload_dir))
1519  {
1520    // last chance to make the directory writable
1521    @chmod($upload_dir, 0777);
1522
1523    if (!is_writable($upload_dir))
1524    {
1525      return new PwgError(500, 'buffer directory has no write access');
1526    }
1527  }
1528
1529  secure_directory($upload_dir);
1530
1531  $filename = sprintf(
1532    '%s-%s-%05u.block',
1533    $params['original_sum'],
1534    $params['type'],
1535    $params['position']
1536    );
1537
1538  ws_logfile('[ws_images_add_chunk] data length : '.strlen($params['data']));
1539
1540  $bytes_written = file_put_contents(
1541    $upload_dir.'/'.$filename,
1542    base64_decode($params['data'])
1543    );
1544
1545  if (false === $bytes_written) {
1546    return new PwgError(
1547      500,
1548      'an error has occured while writting chunk '.$params['position'].' for '.$params['type']
1549      );
1550  }
1551}
1552
1553function merge_chunks($output_filepath, $original_sum, $type)
1554{
1555  global $conf;
1556
1557  ws_logfile('[merge_chunks] input parameter $output_filepath : '.$output_filepath);
1558
1559  if (is_file($output_filepath))
1560  {
1561    unlink($output_filepath);
1562
1563    if (is_file($output_filepath))
1564    {
1565      return new PwgError(500, '[merge_chunks] error while trying to remove existing '.$output_filepath);
1566    }
1567  }
1568
1569  $upload_dir = $conf['upload_dir'].'/buffer';
1570  $pattern = '/'.$original_sum.'-'.$type.'/';
1571  $chunks = array();
1572
1573  if ($handle = opendir($upload_dir))
1574  {
1575    while (false !== ($file = readdir($handle)))
1576    {
1577      if (preg_match($pattern, $file))
1578      {
1579        ws_logfile($file);
1580        array_push($chunks, $upload_dir.'/'.$file);
1581      }
1582    }
1583    closedir($handle);
1584  }
1585
1586  sort($chunks);
1587
1588  if (function_exists('memory_get_usage')) {
1589    ws_logfile('[merge_chunks] memory_get_usage before loading chunks: '.memory_get_usage());
1590  }
1591
1592  $i = 0;
1593
1594  foreach ($chunks as $chunk)
1595  {
1596    $string = file_get_contents($chunk);
1597
1598    if (function_exists('memory_get_usage')) {
1599      ws_logfile('[merge_chunks] memory_get_usage on chunk '.++$i.': '.memory_get_usage());
1600    }
1601
1602    if (!file_put_contents($output_filepath, $string, FILE_APPEND))
1603    {
1604      return new PwgError(500, '[merge_chunks] error while writting chunks for '.$output_filepath);
1605    }
1606
1607    unlink($chunk);
1608  }
1609
1610  if (function_exists('memory_get_usage')) {
1611    ws_logfile('[merge_chunks] memory_get_usage after loading chunks: '.memory_get_usage());
1612  }
1613}
1614
1615/**
1616 * Function introduced for Piwigo 2.4 and the new "multiple size"
1617 * (derivatives) feature. As we only need the biggest sent photo as
1618 * "original", we remove chunks for smaller sizes. We can't make it earlier
1619 * in ws_images_add_chunk because at this moment we don't know which $type
1620 * will be the biggest (we could remove the thumb, but let's use the same
1621 * algorithm)
1622 */
1623function remove_chunks($original_sum, $type)
1624{
1625  global $conf;
1626
1627  $upload_dir = $conf['upload_dir'].'/buffer';
1628  $pattern = '/'.$original_sum.'-'.$type.'/';
1629  $chunks = array();
1630
1631  if ($handle = opendir($upload_dir))
1632  {
1633    while (false !== ($file = readdir($handle)))
1634    {
1635      if (preg_match($pattern, $file))
1636      {
1637        array_push($chunks, $upload_dir.'/'.$file);
1638      }
1639    }
1640    closedir($handle);
1641  }
1642
1643  foreach ($chunks as $chunk)
1644  {
1645    unlink($chunk);
1646  }
1647}
1648
1649function ws_images_addFile($params, &$service)
1650{
1651  ws_logfile(__FUNCTION__.', input :  '.var_export($params, true));
1652  // image_id
1653  // type {thumb, file, high}
1654  // sum -> not used currently (Piwigo 2.4)
1655
1656  global $conf;
1657  if (!is_admin())
1658  {
1659    return new PwgError(401, 'Access denied');
1660  }
1661
1662  $params['image_id'] = (int)$params['image_id'];
1663  if ($params['image_id'] <= 0)
1664  {
1665    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1666  }
1667
1668  //
1669  // what is the path and other infos about the photo?
1670  //
1671  $query = '
1672SELECT
1673    path,
1674    file,
1675    md5sum,
1676    width,
1677    height,
1678    filesize
1679  FROM '.IMAGES_TABLE.'
1680  WHERE id = '.$params['image_id'].'
1681;';
1682  $image = pwg_db_fetch_assoc(pwg_query($query));
1683
1684  if ($image == null)
1685  {
1686    return new PwgError(404, "image_id not found");
1687  }
1688
1689  // since Piwigo 2.4 and derivatives, we do not take the imported "thumb"
1690  // into account
1691  if ('thumb' == $params['type'])
1692  {
1693    remove_chunks($image['md5sum'], $type);
1694    return true;
1695  }
1696
1697  // since Piwigo 2.4 and derivatives, we only care about the "original"
1698  $original_type = 'file';
1699  if ('high' == $params['type'])
1700  {
1701    $original_type = 'high';
1702  }
1703
1704  $file_path = $conf['upload_dir'].'/buffer/'.$image['md5sum'].'-original';
1705
1706  merge_chunks($file_path, $image['md5sum'], $original_type);
1707  chmod($file_path, 0644);
1708
1709  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
1710
1711  // if we receive the "file", we only update the original if the "file" is
1712  // bigger than current original
1713  if ('file' == $params['type'])
1714  {
1715    $do_update = false;
1716
1717    $infos = pwg_image_infos($file_path);
1718
1719    foreach (array('width', 'height', 'filesize') as $image_info)
1720    {
1721      if ($infos[$image_info] > $image[$image_info])
1722      {
1723        $do_update = true;
1724      }
1725    }
1726
1727    if (!$do_update)
1728    {
1729      unlink($file_path);
1730      return true;
1731    }
1732  }
1733
1734  $image_id = add_uploaded_file(
1735    $file_path,
1736    $image['file'],
1737    null,
1738    null,
1739    $params['image_id'],
1740    $image['md5sum'] // we force the md5sum to remain the same
1741    );
1742}
1743
1744function ws_images_add($params, &$service)
1745{
1746  global $conf, $user;
1747  if (!is_admin())
1748  {
1749    return new PwgError(401, 'Access denied');
1750  }
1751
1752  foreach ($params as $param_key => $param_value) {
1753    ws_logfile(
1754      sprintf(
1755        '[pwg.images.add] input param "%s" : "%s"',
1756        $param_key,
1757        is_null($param_value) ? 'NULL' : $param_value
1758        )
1759      );
1760  }
1761
1762  $params['image_id'] = (int)$params['image_id'];
1763  if ($params['image_id'] > 0)
1764  {
1765    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1766
1767    $query='
1768SELECT *
1769  FROM '.IMAGES_TABLE.'
1770  WHERE id = '.$params['image_id'].'
1771;';
1772
1773    $image_row = pwg_db_fetch_assoc(pwg_query($query));
1774    if ($image_row == null)
1775    {
1776      return new PwgError(404, "image_id not found");
1777    }
1778  }
1779
1780  // does the image already exists ?
1781  if ($params['check_uniqueness'])
1782  {
1783    if ('md5sum' == $conf['uniqueness_mode'])
1784    {
1785      $where_clause = "md5sum = '".$params['original_sum']."'";
1786    }
1787    if ('filename' == $conf['uniqueness_mode'])
1788    {
1789      $where_clause = "file = '".$params['original_filename']."'";
1790    }
1791
1792    $query = '
1793SELECT
1794    COUNT(*) AS counter
1795  FROM '.IMAGES_TABLE.'
1796  WHERE '.$where_clause.'
1797;';
1798    list($counter) = pwg_db_fetch_row(pwg_query($query));
1799    if ($counter != 0) {
1800      return new PwgError(500, 'file already exists');
1801    }
1802  }
1803
1804  // due to the new feature "derivatives" (multiple sizes) introduced for
1805  // Piwigo 2.4, we only take the biggest photos sent on
1806  // pwg.images.addChunk. If "high" is available we use it as "original"
1807  // else we use "file".
1808  remove_chunks($params['original_sum'], 'thumb');
1809
1810  if (isset($params['high_sum']))
1811  {
1812    $original_type = 'high';
1813    remove_chunks($params['original_sum'], 'file');
1814  }
1815  else
1816  {
1817    $original_type = 'file';
1818  }
1819
1820  $file_path = $conf['upload_dir'].'/buffer/'.$params['original_sum'].'-original';
1821
1822  merge_chunks($file_path, $params['original_sum'], $original_type);
1823  chmod($file_path, 0644);
1824
1825  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
1826
1827  $image_id = add_uploaded_file(
1828    $file_path,
1829    $params['original_filename'],
1830    null, // categories
1831    isset($params['level']) ? $params['level'] : null,
1832    $params['image_id'] > 0 ? $params['image_id'] : null,
1833    $params['original_sum']
1834    );
1835
1836  $info_columns = array(
1837    'name',
1838    'author',
1839    'comment',
1840    'date_creation',
1841    );
1842
1843  $update = array();
1844
1845  foreach ($info_columns as $key)
1846  {
1847    if (isset($params[$key]))
1848    {
1849      $update[$key] = $params[$key];
1850    }
1851  }
1852
1853  if (count(array_keys($update)) > 0)
1854  {
1855    single_update(
1856      IMAGES_TABLE,
1857      $update,
1858      array('id' => $image_id)
1859      );
1860  }
1861
1862  $url_params = array('image_id' => $image_id);
1863
1864  // let's add links between the image and the categories
1865  if (isset($params['categories']))
1866  {
1867    ws_add_image_category_relations($image_id, $params['categories']);
1868
1869    if (preg_match('/^\d+/', $params['categories'], $matches)) {
1870      $category_id = $matches[0];
1871
1872      $query = '
1873SELECT id, name, permalink
1874  FROM '.CATEGORIES_TABLE.'
1875  WHERE id = '.$category_id.'
1876;';
1877      $result = pwg_query($query);
1878      $category = pwg_db_fetch_assoc($result);
1879
1880      $url_params['section'] = 'categories';
1881      $url_params['category'] = $category;
1882    }
1883  }
1884
1885  // and now, let's create tag associations
1886  if (isset($params['tag_ids']) and !empty($params['tag_ids']))
1887  {
1888    set_tags(
1889      explode(',', $params['tag_ids']),
1890      $image_id
1891      );
1892  }
1893
1894  invalidate_user_cache();
1895
1896  return array(
1897    'image_id' => $image_id,
1898    'url' => make_picture_url($url_params),
1899    );
1900}
1901
1902function ws_images_addSimple($params, &$service)
1903{
1904  global $conf;
1905  if (!is_admin())
1906  {
1907    return new PwgError(401, 'Access denied');
1908  }
1909
1910  if (!$service->isPost())
1911  {
1912    return new PwgError(405, "This method requires HTTP POST");
1913  }
1914
1915  if (!isset($_FILES['image']))
1916  {
1917    return new PwgError(405, "The image (file) parameter is missing");
1918  }
1919
1920  $params['image_id'] = (int)$params['image_id'];
1921  if ($params['image_id'] > 0)
1922  {
1923    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1924
1925    $query='
1926SELECT *
1927  FROM '.IMAGES_TABLE.'
1928  WHERE id = '.$params['image_id'].'
1929;';
1930
1931    $image_row = pwg_db_fetch_assoc(pwg_query($query));
1932    if ($image_row == null)
1933    {
1934      return new PwgError(404, "image_id not found");
1935    }
1936  }
1937
1938  // category
1939  $params['category'] = (int)$params['category'];
1940  if ($params['category'] <= 0 and $params['image_id'] <= 0)
1941  {
1942    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1943  }
1944
1945  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
1946
1947  $image_id = add_uploaded_file(
1948    $_FILES['image']['tmp_name'],
1949    $_FILES['image']['name'],
1950    $params['category'] > 0 ? array($params['category']) : null,
1951    8,
1952    $params['image_id'] > 0 ? $params['image_id'] : null
1953    );
1954
1955  $info_columns = array(
1956    'name',
1957    'author',
1958    'comment',
1959    'level',
1960    'date_creation',
1961    );
1962
1963  foreach ($info_columns as $key)
1964  {
1965    if (isset($params[$key]))
1966    {
1967      $update[$key] = $params[$key];
1968    }
1969  }
1970
1971  if (count(array_keys($update)) > 0)
1972  {
1973    $update['id'] = $image_id;
1974
1975    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1976    mass_updates(
1977      IMAGES_TABLE,
1978      array(
1979        'primary' => array('id'),
1980        'update'  => array_diff(array_keys($update), array('id'))
1981        ),
1982      array($update)
1983      );
1984  }
1985
1986
1987  if (isset($params['tags']) and !empty($params['tags']))
1988  {
1989    $tag_ids = array();
1990    $tag_names = explode(',', $params['tags']);
1991    foreach ($tag_names as $tag_name)
1992    {
1993      $tag_id = tag_id_from_tag_name($tag_name);
1994      array_push($tag_ids, $tag_id);
1995    }
1996
1997    add_tags($tag_ids, array($image_id));
1998  }
1999
2000  $url_params = array('image_id' => $image_id);
2001
2002  if ($params['category'] > 0)
2003  {
2004    $query = '
2005SELECT id, name, permalink
2006  FROM '.CATEGORIES_TABLE.'
2007  WHERE id = '.$params['category'].'
2008;';
2009    $result = pwg_query($query);
2010    $category = pwg_db_fetch_assoc($result);
2011
2012    $url_params['section'] = 'categories';
2013    $url_params['category'] = $category;
2014  }
2015
2016  // update metadata from the uploaded file (exif/iptc), even if the sync
2017  // was already performed by add_uploaded_file().
2018
2019  require_once(PHPWG_ROOT_PATH.'admin/include/functions_metadata.php');
2020  sync_metadata(array($image_id));
2021
2022  return array(
2023    'image_id' => $image_id,
2024    'url' => make_picture_url($url_params),
2025    );
2026}
2027
2028function ws_rates_delete($params, &$service)
2029{
2030  global $conf;
2031
2032  if (!$service->isPost())
2033  {
2034    return new PwgError(405, 'This method requires HTTP POST');
2035  }
2036
2037  if (!is_admin())
2038  {
2039    return new PwgError(401, 'Access denied');
2040  }
2041
2042  $user_id = (int)$params['user_id'];
2043  if ($user_id<=0)
2044  {
2045    return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid user_id');
2046  }
2047
2048  $query = '
2049DELETE FROM '.RATE_TABLE.'
2050  WHERE user_id='.$user_id;
2051
2052  if (!empty($params['anonymous_id']))
2053  {
2054    $query .= ' AND anonymous_id=\''.$params['anonymous_id'].'\'';
2055  }
2056
2057  $changes = pwg_db_changes(pwg_query($query));
2058  if ($changes)
2059  {
2060    include_once(PHPWG_ROOT_PATH.'include/functions_rate.inc.php');
2061    update_rating_score();
2062  }
2063  return $changes;
2064}
2065
2066
2067/**
2068 * perform a login (web service method)
2069 */
2070function ws_session_login($params, &$service)
2071{
2072  global $conf;
2073
2074  if (!$service->isPost())
2075  {
2076    return new PwgError(405, "This method requires HTTP POST");
2077  }
2078  if (try_log_user($params['username'], $params['password'],false))
2079  {
2080    return true;
2081  }
2082  return new PwgError(999, 'Invalid username/password');
2083}
2084
2085
2086/**
2087 * performs a logout (web service method)
2088 */
2089function ws_session_logout($params, &$service)
2090{
2091  if (!is_a_guest())
2092  {
2093    logout_user();
2094  }
2095  return true;
2096}
2097
2098function ws_session_getStatus($params, &$service)
2099{
2100  global $user;
2101  $res = array();
2102  $res['username'] = is_a_guest() ? 'guest' : stripslashes($user['username']);
2103  foreach ( array('status', 'theme', 'language') as $k )
2104  {
2105    $res[$k] = $user[$k];
2106  }
2107  $res['pwg_token'] = get_pwg_token();
2108  $res['charset'] = get_pwg_charset();
2109
2110  list($dbnow) = pwg_db_fetch_row(pwg_query('SELECT NOW();'));
2111  $res['current_datetime'] = $dbnow;
2112
2113  return $res;
2114}
2115
2116
2117/**
2118 * returns a list of tags (web service method)
2119 */
2120function ws_tags_getList($params, &$service)
2121{
2122  $tags = get_available_tags();
2123  if ($params['sort_by_counter'])
2124  {
2125    usort($tags, create_function('$a,$b', 'return -$a["counter"]+$b["counter"];') );
2126  }
2127  else
2128  {
2129    usort($tags, 'tag_alpha_compare');
2130  }
2131  for ($i=0; $i<count($tags); $i++)
2132  {
2133    $tags[$i]['id'] = (int)$tags[$i]['id'];
2134    $tags[$i]['counter'] = (int)$tags[$i]['counter'];
2135    $tags[$i]['url'] = make_index_url(
2136        array(
2137          'section'=>'tags',
2138          'tags'=>array($tags[$i])
2139        )
2140      );
2141  }
2142  return array('tags' => new PwgNamedArray($tags, 'tag', array('id','url_name','url', 'name', 'counter' )) );
2143}
2144
2145/**
2146 * returns the list of tags as you can see them in administration (web
2147 * service method).
2148 *
2149 * Only admin can run this method and permissions are not taken into
2150 * account.
2151 */
2152function ws_tags_getAdminList($params, &$service)
2153{
2154  if (!is_admin())
2155  {
2156    return new PwgError(401, 'Access denied');
2157  }
2158
2159  $tags = get_all_tags();
2160  return array(
2161    'tags' => new PwgNamedArray(
2162      $tags,
2163      'tag',
2164      array(
2165        'name',
2166        'id',
2167        'url_name',
2168        )
2169      )
2170    );
2171}
2172
2173/**
2174 * returns a list of images for tags (web service method)
2175 */
2176function ws_tags_getImages($params, &$service)
2177{
2178  global $conf;
2179
2180  // first build all the tag_ids we are interested in
2181  $params['tag_id'] = array_map( 'intval',$params['tag_id'] );
2182  $tags = find_tags($params['tag_id'], $params['tag_url_name'], $params['tag_name']);
2183  $tags_by_id = array();
2184  foreach( $tags as $tag )
2185  {
2186    $tags['id'] = (int)$tag['id'];
2187    $tags_by_id[ $tag['id'] ] = $tag;
2188  }
2189  unset($tags);
2190  $tag_ids = array_keys($tags_by_id);
2191
2192
2193  $where_clauses = ws_std_image_sql_filter($params);
2194  if (!empty($where_clauses))
2195  {
2196    $where_clauses = implode( ' AND ', $where_clauses);
2197  }
2198  $image_ids = get_image_ids_for_tags(
2199    $tag_ids,
2200    $params['tag_mode_and'] ? 'AND' : 'OR',
2201    $where_clauses,
2202    ws_std_image_sql_order($params) );
2203
2204
2205  $image_ids = array_slice($image_ids, (int)($params['per_page']*$params['page']), (int)$params['per_page'] );
2206
2207  $image_tag_map = array();
2208  if ( !empty($image_ids) and !$params['tag_mode_and'] )
2209  { // build list of image ids with associated tags per image
2210    $query = '
2211SELECT image_id, GROUP_CONCAT(tag_id) AS tag_ids
2212  FROM '.IMAGE_TAG_TABLE.'
2213  WHERE tag_id IN ('.implode(',',$tag_ids).') AND image_id IN ('.implode(',',$image_ids).')
2214  GROUP BY image_id';
2215    $result = pwg_query($query);
2216    while ( $row=pwg_db_fetch_assoc($result) )
2217    {
2218      $row['image_id'] = (int)$row['image_id'];
2219      array_push( $image_ids, $row['image_id'] );
2220      $image_tag_map[ $row['image_id'] ] = explode(',', $row['tag_ids']);
2221    }
2222  }
2223
2224  $images = array();
2225  if (!empty($image_ids))
2226  {
2227    $rank_of = array_flip($image_ids);
2228    $result = pwg_query('
2229SELECT * FROM '.IMAGES_TABLE.'
2230  WHERE id IN ('.implode(',',$image_ids).')');
2231    while ($row = pwg_db_fetch_assoc($result))
2232    {
2233      $image = array();
2234      $image['rank'] = $rank_of[ $row['id'] ];
2235      foreach ( array('id', 'width', 'height', 'hit') as $k )
2236      {
2237        if (isset($row[$k]))
2238        {
2239          $image[$k] = (int)$row[$k];
2240        }
2241      }
2242      foreach ( array('file', 'name', 'comment', 'date_creation', 'date_available') as $k )
2243      {
2244        $image[$k] = $row[$k];
2245      }
2246      $image = array_merge( $image, ws_std_get_urls($row) );
2247
2248      $image_tag_ids = ($params['tag_mode_and']) ? $tag_ids : $image_tag_map[$image['id']];
2249      $image_tags = array();
2250      foreach ($image_tag_ids as $tag_id)
2251      {
2252        $url = make_index_url(
2253                 array(
2254                  'section'=>'tags',
2255                  'tags'=> array($tags_by_id[$tag_id])
2256                )
2257              );
2258        $page_url = make_picture_url(
2259                 array(
2260                  'section'=>'tags',
2261                  'tags'=> array($tags_by_id[$tag_id]),
2262                  'image_id' => $row['id'],
2263                  'image_file' => $row['file'],
2264                )
2265              );
2266        array_push($image_tags, array(
2267                'id' => (int)$tag_id,
2268                'url' => $url,
2269                'page_url' => $page_url,
2270              )
2271            );
2272      }
2273      $image['tags'] = new PwgNamedArray($image_tags, 'tag',
2274              array('id','url_name','url','page_url')
2275            );
2276      array_push($images, $image);
2277    }
2278    usort($images, 'rank_compare');
2279    unset($rank_of);
2280  }
2281
2282  return array( 'images' =>
2283    array (
2284      WS_XML_ATTRIBUTES =>
2285        array(
2286            'page' => $params['page'],
2287            'per_page' => $params['per_page'],
2288            'count' => count($images)
2289          ),
2290       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
2291          ws_std_get_image_xml_attributes() )
2292      )
2293    );
2294}
2295
2296function ws_categories_add($params, &$service)
2297{
2298  if (!is_admin())
2299  {
2300    return new PwgError(401, 'Access denied');
2301  }
2302
2303  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2304
2305  $options = array();
2306  if (!empty($params['status']) and in_array($params['status'], array('private','public')))
2307  {
2308    $options['status'] = $params['status'];
2309  }
2310 
2311  if (!empty($params['visible']) and in_array($params['visible'], array('true','false')))
2312  {
2313    $options['visible'] = get_boolean($params['visible']);
2314  }
2315 
2316  if (!empty($params['commentable']) and in_array($params['commentable'], array('true','false')) )
2317  {
2318    $options['commentable'] = get_boolean($params['commentable']);
2319  }
2320 
2321  if (!empty($params['comment']))
2322  {
2323    $options['comment'] = $params['comment'];
2324  }
2325 
2326
2327  $creation_output = create_virtual_category(
2328    $params['name'],
2329    $params['parent'],
2330    $options
2331    );
2332
2333  if (isset($creation_output['error']))
2334  {
2335    return new PwgError(500, $creation_output['error']);
2336  }
2337
2338  invalidate_user_cache();
2339
2340  return $creation_output;
2341}
2342
2343function ws_tags_add($params, &$service)
2344{
2345  if (!is_admin())
2346  {
2347    return new PwgError(401, 'Access denied');
2348  }
2349
2350  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2351
2352  $creation_output = create_tag($params['name']);
2353
2354  if (isset($creation_output['error']))
2355  {
2356    return new PwgError(500, $creation_output['error']);
2357  }
2358
2359  return $creation_output;
2360}
2361
2362function ws_images_exist($params, &$service)
2363{
2364  ws_logfile(__FUNCTION__.' '.var_export($params, true));
2365
2366  global $conf;
2367
2368  if (!is_admin())
2369  {
2370    return new PwgError(401, 'Access denied');
2371  }
2372
2373  $split_pattern = '/[\s,;\|]/';
2374
2375  if ('md5sum' == $conf['uniqueness_mode'])
2376  {
2377    // search among photos the list of photos already added, based on md5sum
2378    // list
2379    $md5sums = preg_split(
2380      $split_pattern,
2381      $params['md5sum_list'],
2382      -1,
2383      PREG_SPLIT_NO_EMPTY
2384    );
2385
2386    $query = '
2387SELECT
2388    id,
2389    md5sum
2390  FROM '.IMAGES_TABLE.'
2391  WHERE md5sum IN (\''.implode("','", $md5sums).'\')
2392;';
2393    $id_of_md5 = simple_hash_from_query($query, 'md5sum', 'id');
2394
2395    $result = array();
2396
2397    foreach ($md5sums as $md5sum)
2398    {
2399      $result[$md5sum] = null;
2400      if (isset($id_of_md5[$md5sum]))
2401      {
2402        $result[$md5sum] = $id_of_md5[$md5sum];
2403      }
2404    }
2405  }
2406
2407  if ('filename' == $conf['uniqueness_mode'])
2408  {
2409    // search among photos the list of photos already added, based on
2410    // filename list
2411    $filenames = preg_split(
2412      $split_pattern,
2413      $params['filename_list'],
2414      -1,
2415      PREG_SPLIT_NO_EMPTY
2416    );
2417
2418    $query = '
2419SELECT
2420    id,
2421    file
2422  FROM '.IMAGES_TABLE.'
2423  WHERE file IN (\''.implode("','", $filenames).'\')
2424;';
2425    $id_of_filename = simple_hash_from_query($query, 'file', 'id');
2426
2427    $result = array();
2428
2429    foreach ($filenames as $filename)
2430    {
2431      $result[$filename] = null;
2432      if (isset($id_of_filename[$filename]))
2433      {
2434        $result[$filename] = $id_of_filename[$filename];
2435      }
2436    }
2437  }
2438
2439  return $result;
2440}
2441
2442function ws_images_checkFiles($params, &$service)
2443{
2444  ws_logfile(__FUNCTION__.', input :  '.var_export($params, true));
2445
2446  if (!is_admin())
2447  {
2448    return new PwgError(401, 'Access denied');
2449  }
2450
2451  // input parameters
2452  //
2453  // image_id
2454  // thumbnail_sum
2455  // file_sum
2456  // high_sum
2457
2458  $params['image_id'] = (int)$params['image_id'];
2459  if ($params['image_id'] <= 0)
2460  {
2461    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
2462  }
2463
2464  $query = '
2465SELECT
2466    path
2467  FROM '.IMAGES_TABLE.'
2468  WHERE id = '.$params['image_id'].'
2469;';
2470  $result = pwg_query($query);
2471  if (pwg_db_num_rows($result) == 0)
2472  {
2473    return new PwgError(404, "image_id not found");
2474  }
2475  list($path) = pwg_db_fetch_row($result);
2476
2477  $ret = array();
2478
2479  if (isset($params['thumbnail_sum']))
2480  {
2481    // We always say the thumbnail is equal to create no reaction on the
2482    // other side. Since Piwigo 2.4 and derivatives, the thumbnails and web
2483    // sizes are always generated by Piwigo
2484    $ret['thumbnail'] = 'equals';
2485  }
2486
2487  if (isset($params['high_sum']))
2488  {
2489    $ret['file'] = 'equals';
2490    $compare_type = 'high';
2491  }
2492  elseif (isset($params['file_sum']))
2493  {
2494    $compare_type = 'file';
2495  }
2496
2497  if (isset($compare_type))
2498  {
2499    ws_logfile(__FUNCTION__.', md5_file($path) = '.md5_file($path));
2500    if (md5_file($path) != $params[$compare_type.'_sum'])
2501    {
2502      $ret[$compare_type] = 'differs';
2503    }
2504    else
2505    {
2506      $ret[$compare_type] = 'equals';
2507    }
2508  }
2509
2510  ws_logfile(__FUNCTION__.', output :  '.var_export($ret, true));
2511
2512  return $ret;
2513}
2514
2515function ws_images_setInfo($params, &$service)
2516{
2517  global $conf;
2518  if (!is_admin())
2519  {
2520    return new PwgError(401, 'Access denied');
2521  }
2522
2523  if (!$service->isPost())
2524  {
2525    return new PwgError(405, "This method requires HTTP POST");
2526  }
2527
2528  $params['image_id'] = (int)$params['image_id'];
2529  if ($params['image_id'] <= 0)
2530  {
2531    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
2532  }
2533
2534  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2535
2536  $query='
2537SELECT *
2538  FROM '.IMAGES_TABLE.'
2539  WHERE id = '.$params['image_id'].'
2540;';
2541
2542  $image_row = pwg_db_fetch_assoc(pwg_query($query));
2543  if ($image_row == null)
2544  {
2545    return new PwgError(404, "image_id not found");
2546  }
2547
2548  // database registration
2549  $update = array();
2550
2551  $info_columns = array(
2552    'name',
2553    'author',
2554    'comment',
2555    'level',
2556    'date_creation',
2557    );
2558
2559  foreach ($info_columns as $key)
2560  {
2561    if (isset($params[$key]))
2562    {
2563      if ('fill_if_empty' == $params['single_value_mode'])
2564      {
2565        if (empty($image_row[$key]))
2566        {
2567          $update[$key] = $params[$key];
2568        }
2569      }
2570      elseif ('replace' == $params['single_value_mode'])
2571      {
2572        $update[$key] = $params[$key];
2573      }
2574      else
2575      {
2576        return new PwgError(
2577          500,
2578          '[ws_images_setInfo]'
2579          .' invalid parameter single_value_mode "'.$params['single_value_mode'].'"'
2580          .', possible values are {fill_if_empty, replace}.'
2581          );
2582      }
2583    }
2584  }
2585
2586  if (isset($params['file']))
2587  {
2588    if (!empty($image_row['storage_category_id']))
2589    {
2590      return new PwgError(500, '[ws_images_setInfo] updating "file" is forbidden on photos added by synchronization');
2591    }
2592
2593    $update['file'] = $params['file'];
2594  }
2595
2596  if (count(array_keys($update)) > 0)
2597  {
2598    $update['id'] = $params['image_id'];
2599
2600    mass_updates(
2601      IMAGES_TABLE,
2602      array(
2603        'primary' => array('id'),
2604        'update'  => array_diff(array_keys($update), array('id'))
2605        ),
2606      array($update)
2607      );
2608  }
2609
2610  if (isset($params['categories']))
2611  {
2612    ws_add_image_category_relations(
2613      $params['image_id'],
2614      $params['categories'],
2615      ('replace' == $params['multiple_value_mode'] ? true : false)
2616      );
2617  }
2618
2619  // and now, let's create tag associations
2620  if (isset($params['tag_ids']))
2621  {
2622    $tag_ids = explode(',', $params['tag_ids']);
2623
2624    if ('replace' == $params['multiple_value_mode'])
2625    {
2626      set_tags(
2627        $tag_ids,
2628        $params['image_id']
2629        );
2630    }
2631    elseif ('append' == $params['multiple_value_mode'])
2632    {
2633      add_tags(
2634        $tag_ids,
2635        array($params['image_id'])
2636        );
2637    }
2638    else
2639    {
2640      return new PwgError(
2641        500,
2642        '[ws_images_setInfo]'
2643        .' invalid parameter multiple_value_mode "'.$params['multiple_value_mode'].'"'
2644        .', possible values are {replace, append}.'
2645        );
2646    }
2647  }
2648
2649  invalidate_user_cache();
2650}
2651
2652function ws_images_delete($params, &$service)
2653{
2654  global $conf;
2655  if (!is_admin())
2656  {
2657    return new PwgError(401, 'Access denied');
2658  }
2659
2660  if (!$service->isPost())
2661  {
2662    return new PwgError(405, "This method requires HTTP POST");
2663  }
2664
2665  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2666  {
2667    return new PwgError(403, 'Invalid security token');
2668  }
2669
2670  $params['image_id'] = preg_split(
2671    '/[\s,;\|]/',
2672    $params['image_id'],
2673    -1,
2674    PREG_SPLIT_NO_EMPTY
2675    );
2676  $params['image_id'] = array_map('intval', $params['image_id']);
2677
2678  $image_ids = array();
2679  foreach ($params['image_id'] as $image_id)
2680  {
2681    if ($image_id > 0)
2682    {
2683      array_push($image_ids, $image_id);
2684    }
2685  }
2686
2687  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2688  delete_elements($image_ids, true);
2689}
2690
2691function ws_add_image_category_relations($image_id, $categories_string, $replace_mode=false)
2692{
2693  // let's add links between the image and the categories
2694  //
2695  // $params['categories'] should look like 123,12;456,auto;789 which means:
2696  //
2697  // 1. associate with category 123 on rank 12
2698  // 2. associate with category 456 on automatic rank
2699  // 3. associate with category 789 on automatic rank
2700  $cat_ids = array();
2701  $rank_on_category = array();
2702  $search_current_ranks = false;
2703
2704  $tokens = explode(';', $categories_string);
2705  foreach ($tokens as $token)
2706  {
2707    @list($cat_id, $rank) = explode(',', $token);
2708
2709    if (!preg_match('/^\d+$/', $cat_id))
2710    {
2711      continue;
2712    }
2713
2714    array_push($cat_ids, $cat_id);
2715
2716    if (!isset($rank))
2717    {
2718      $rank = 'auto';
2719    }
2720    $rank_on_category[$cat_id] = $rank;
2721
2722    if ($rank == 'auto')
2723    {
2724      $search_current_ranks = true;
2725    }
2726  }
2727
2728  $cat_ids = array_unique($cat_ids);
2729
2730  if (count($cat_ids) == 0)
2731  {
2732    return new PwgError(
2733      500,
2734      '[ws_add_image_category_relations] there is no category defined in "'.$categories_string.'"'
2735      );
2736  }
2737
2738  $query = '
2739SELECT
2740    id
2741  FROM '.CATEGORIES_TABLE.'
2742  WHERE id IN ('.implode(',', $cat_ids).')
2743;';
2744  $db_cat_ids = array_from_query($query, 'id');
2745
2746  $unknown_cat_ids = array_diff($cat_ids, $db_cat_ids);
2747  if (count($unknown_cat_ids) != 0)
2748  {
2749    return new PwgError(
2750      500,
2751      '[ws_add_image_category_relations] the following categories are unknown: '.implode(', ', $unknown_cat_ids)
2752      );
2753  }
2754
2755  $to_update_cat_ids = array();
2756
2757  // in case of replace mode, we first check the existing associations
2758  $query = '
2759SELECT
2760    category_id
2761  FROM '.IMAGE_CATEGORY_TABLE.'
2762  WHERE image_id = '.$image_id.'
2763;';
2764  $existing_cat_ids = array_from_query($query, 'category_id');
2765
2766  if ($replace_mode)
2767  {
2768    $to_remove_cat_ids = array_diff($existing_cat_ids, $cat_ids);
2769    if (count($to_remove_cat_ids) > 0)
2770    {
2771      $query = '
2772DELETE
2773  FROM '.IMAGE_CATEGORY_TABLE.'
2774  WHERE image_id = '.$image_id.'
2775    AND category_id IN ('.implode(', ', $to_remove_cat_ids).')
2776;';
2777      pwg_query($query);
2778      update_category($to_remove_cat_ids);
2779    }
2780  }
2781
2782  $new_cat_ids = array_diff($cat_ids, $existing_cat_ids);
2783  if (count($new_cat_ids) == 0)
2784  {
2785    return true;
2786  }
2787
2788  if ($search_current_ranks)
2789  {
2790    $query = '
2791SELECT
2792    category_id,
2793    MAX(rank) AS max_rank
2794  FROM '.IMAGE_CATEGORY_TABLE.'
2795  WHERE rank IS NOT NULL
2796    AND category_id IN ('.implode(',', $new_cat_ids).')
2797  GROUP BY category_id
2798;';
2799    $current_rank_of = simple_hash_from_query(
2800      $query,
2801      'category_id',
2802      'max_rank'
2803      );
2804
2805    foreach ($new_cat_ids as $cat_id)
2806    {
2807      if (!isset($current_rank_of[$cat_id]))
2808      {
2809        $current_rank_of[$cat_id] = 0;
2810      }
2811
2812      if ('auto' == $rank_on_category[$cat_id])
2813      {
2814        $rank_on_category[$cat_id] = $current_rank_of[$cat_id] + 1;
2815      }
2816    }
2817  }
2818
2819  $inserts = array();
2820
2821  foreach ($new_cat_ids as $cat_id)
2822  {
2823    array_push(
2824      $inserts,
2825      array(
2826        'image_id' => $image_id,
2827        'category_id' => $cat_id,
2828        'rank' => $rank_on_category[$cat_id],
2829        )
2830      );
2831  }
2832
2833  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2834  mass_inserts(
2835    IMAGE_CATEGORY_TABLE,
2836    array_keys($inserts[0]),
2837    $inserts
2838    );
2839
2840  update_category($new_cat_ids);
2841}
2842
2843function ws_categories_setInfo($params, &$service)
2844{
2845  global $conf;
2846  if (!is_admin())
2847  {
2848    return new PwgError(401, 'Access denied');
2849  }
2850
2851  if (!$service->isPost())
2852  {
2853    return new PwgError(405, "This method requires HTTP POST");
2854  }
2855
2856  // category_id
2857  // name
2858  // comment
2859
2860  $params['category_id'] = (int)$params['category_id'];
2861  if ($params['category_id'] <= 0)
2862  {
2863    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
2864  }
2865
2866  // database registration
2867  $update = array(
2868    'id' => $params['category_id'],
2869    );
2870
2871  $info_columns = array(
2872    'name',
2873    'comment',
2874    );
2875
2876  $perform_update = false;
2877  foreach ($info_columns as $key)
2878  {
2879    if (isset($params[$key]))
2880    {
2881      $perform_update = true;
2882      $update[$key] = $params[$key];
2883    }
2884  }
2885
2886  if ($perform_update)
2887  {
2888    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2889    mass_updates(
2890      CATEGORIES_TABLE,
2891      array(
2892        'primary' => array('id'),
2893        'update'  => array_diff(array_keys($update), array('id'))
2894        ),
2895      array($update)
2896      );
2897  }
2898
2899}
2900
2901function ws_categories_setRepresentative($params, &$service)
2902{
2903  global $conf;
2904
2905  if (!is_admin())
2906  {
2907    return new PwgError(401, 'Access denied');
2908  }
2909
2910  if (!$service->isPost())
2911  {
2912    return new PwgError(405, "This method requires HTTP POST");
2913  }
2914
2915  // category_id
2916  // image_id
2917
2918  $params['category_id'] = (int)$params['category_id'];
2919  if ($params['category_id'] <= 0)
2920  {
2921    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
2922  }
2923
2924  // does the category really exist?
2925  $query='
2926SELECT
2927    *
2928  FROM '.CATEGORIES_TABLE.'
2929  WHERE id = '.$params['category_id'].'
2930;';
2931  $row = pwg_db_fetch_assoc(pwg_query($query));
2932  if ($row == null)
2933  {
2934    return new PwgError(404, "category_id not found");
2935  }
2936
2937  $params['image_id'] = (int)$params['image_id'];
2938  if ($params['image_id'] <= 0)
2939  {
2940    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
2941  }
2942
2943  // does the image really exist?
2944  $query='
2945SELECT
2946    *
2947  FROM '.IMAGES_TABLE.'
2948  WHERE id = '.$params['image_id'].'
2949;';
2950
2951  $row = pwg_db_fetch_assoc(pwg_query($query));
2952  if ($row == null)
2953  {
2954    return new PwgError(404, "image_id not found");
2955  }
2956
2957  // apply change
2958  $query = '
2959UPDATE '.CATEGORIES_TABLE.'
2960  SET representative_picture_id = '.$params['image_id'].'
2961  WHERE id = '.$params['category_id'].'
2962;';
2963  pwg_query($query);
2964
2965  $query = '
2966UPDATE '.USER_CACHE_CATEGORIES_TABLE.'
2967  SET user_representative_picture_id = NULL
2968  WHERE cat_id = '.$params['category_id'].'
2969;';
2970  pwg_query($query);
2971}
2972
2973function ws_categories_delete($params, &$service)
2974{
2975  global $conf;
2976  if (!is_admin())
2977  {
2978    return new PwgError(401, 'Access denied');
2979  }
2980
2981  if (!$service->isPost())
2982  {
2983    return new PwgError(405, "This method requires HTTP POST");
2984  }
2985
2986  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2987  {
2988    return new PwgError(403, 'Invalid security token');
2989  }
2990
2991  $modes = array('no_delete', 'delete_orphans', 'force_delete');
2992  if (!in_array($params['photo_deletion_mode'], $modes))
2993  {
2994    return new PwgError(
2995      500,
2996      '[ws_categories_delete]'
2997      .' invalid parameter photo_deletion_mode "'.$params['photo_deletion_mode'].'"'
2998      .', possible values are {'.implode(', ', $modes).'}.'
2999      );
3000  }
3001
3002  $params['category_id'] = preg_split(
3003    '/[\s,;\|]/',
3004    $params['category_id'],
3005    -1,
3006    PREG_SPLIT_NO_EMPTY
3007    );
3008  $params['category_id'] = array_map('intval', $params['category_id']);
3009
3010  $category_ids = array();
3011  foreach ($params['category_id'] as $category_id)
3012  {
3013    if ($category_id > 0)
3014    {
3015      array_push($category_ids, $category_id);
3016    }
3017  }
3018
3019  if (count($category_ids) == 0)
3020  {
3021    return;
3022  }
3023
3024  $query = '
3025SELECT id
3026  FROM '.CATEGORIES_TABLE.'
3027  WHERE id IN ('.implode(',', $category_ids).')
3028;';
3029  $category_ids = array_from_query($query, 'id');
3030
3031  if (count($category_ids) == 0)
3032  {
3033    return;
3034  }
3035
3036  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
3037  delete_categories($category_ids, $params['photo_deletion_mode']);
3038  update_global_rank();
3039}
3040
3041function ws_categories_move($params, &$service)
3042{
3043  global $conf, $page;
3044
3045  if (!is_admin())
3046  {
3047    return new PwgError(401, 'Access denied');
3048  }
3049
3050  if (!$service->isPost())
3051  {
3052    return new PwgError(405, "This method requires HTTP POST");
3053  }
3054
3055  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
3056  {
3057    return new PwgError(403, 'Invalid security token');
3058  }
3059
3060  $params['category_id'] = preg_split(
3061    '/[\s,;\|]/',
3062    $params['category_id'],
3063    -1,
3064    PREG_SPLIT_NO_EMPTY
3065    );
3066  $params['category_id'] = array_map('intval', $params['category_id']);
3067
3068  $category_ids = array();
3069  foreach ($params['category_id'] as $category_id)
3070  {
3071    if ($category_id > 0)
3072    {
3073      array_push($category_ids, $category_id);
3074    }
3075  }
3076
3077  if (count($category_ids) == 0)
3078  {
3079    return new PwgError(403, 'Invalid category_id input parameter, no category to move');
3080  }
3081
3082  // we can't move physical categories
3083  $categories_in_db = array();
3084
3085  $query = '
3086SELECT
3087    id,
3088    name,
3089    dir
3090  FROM '.CATEGORIES_TABLE.'
3091  WHERE id IN ('.implode(',', $category_ids).')
3092;';
3093  $result = pwg_query($query);
3094  while ($row = pwg_db_fetch_assoc($result))
3095  {
3096    $categories_in_db[$row['id']] = $row;
3097    // we break on error at first physical category detected
3098    if (!empty($row['dir']))
3099    {
3100      $row['name'] = strip_tags(
3101        trigger_event(
3102          'render_category_name',
3103          $row['name'],
3104          'ws_categories_move'
3105          )
3106        );
3107
3108      return new PwgError(
3109        403,
3110        sprintf(
3111          'Category %s (%u) is not a virtual category, you cannot move it',
3112          $row['name'],
3113          $row['id']
3114          )
3115        );
3116    }
3117  }
3118
3119  if (count($categories_in_db) != count($category_ids))
3120  {
3121    $unknown_category_ids = array_diff($category_ids, array_keys($categories_in_db));
3122
3123    return new PwgError(
3124      403,
3125      sprintf(
3126        'Category %u does not exist',
3127        $unknown_category_ids[0]
3128        )
3129      );
3130  }
3131
3132  // does this parent exists? This check should be made in the
3133  // move_categories function, not here
3134  //
3135  // 0 as parent means "move categories at gallery root"
3136  if (!is_numeric($params['parent']))
3137  {
3138    return new PwgError(403, 'Invalid parent input parameter');
3139  }
3140
3141  if (0 != $params['parent']) {
3142    $params['parent'] = intval($params['parent']);
3143    $subcat_ids = get_subcat_ids(array($params['parent']));
3144    if (count($subcat_ids) == 0)
3145    {
3146      return new PwgError(403, 'Unknown parent category id');
3147    }
3148  }
3149
3150  $page['infos'] = array();
3151  $page['errors'] = array();
3152  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
3153  move_categories($category_ids, $params['parent']);
3154  invalidate_user_cache();
3155
3156  if (count($page['errors']) != 0)
3157  {
3158    return new PwgError(403, implode('; ', $page['errors']));
3159  }
3160}
3161
3162function ws_logfile($string)
3163{
3164  global $conf;
3165
3166  if (!$conf['ws_enable_log']) {
3167    return true;
3168  }
3169
3170  file_put_contents(
3171    $conf['ws_log_filepath'],
3172    '['.date('c').'] '.$string."\n",
3173    FILE_APPEND
3174    );
3175}
3176
3177function ws_images_checkUpload($params, &$service)
3178{
3179  global $conf;
3180
3181  if (!is_admin())
3182  {
3183    return new PwgError(401, 'Access denied');
3184  }
3185
3186  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
3187  $ret['message'] = ready_for_upload_message();
3188  $ret['ready_for_upload'] = true;
3189
3190  if (!empty($ret['message']))
3191  {
3192    $ret['ready_for_upload'] = false;
3193  }
3194
3195  return $ret;
3196}
3197
3198function ws_plugins_getList($params, &$service)
3199{
3200  global $conf;
3201
3202  if (!is_admin())
3203  {
3204    return new PwgError(401, 'Access denied');
3205  }
3206
3207  include_once(PHPWG_ROOT_PATH.'admin/include/plugins.class.php');
3208  $plugins = new plugins();
3209  $plugins->sort_fs_plugins('name');
3210  $plugin_list = array();
3211
3212  foreach($plugins->fs_plugins as $plugin_id => $fs_plugin)
3213  {
3214    if (isset($plugins->db_plugins_by_id[$plugin_id]))
3215    {
3216      $state = $plugins->db_plugins_by_id[$plugin_id]['state'];
3217    }
3218    else
3219    {
3220      $state = 'uninstalled';
3221    }
3222
3223    array_push(
3224      $plugin_list,
3225      array(
3226        'id' => $plugin_id,
3227        'name' => $fs_plugin['name'],
3228        'version' => $fs_plugin['version'],
3229        'state' => $state,
3230        'description' => $fs_plugin['description'],
3231        )
3232      );
3233  }
3234
3235  return $plugin_list;
3236}
3237
3238function ws_plugins_performAction($params, &$service)
3239{
3240  global $template;
3241
3242  if (!is_admin())
3243  {
3244    return new PwgError(401, 'Access denied');
3245  }
3246
3247  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
3248  {
3249    return new PwgError(403, 'Invalid security token');
3250  }
3251
3252  define('IN_ADMIN', true);
3253  include_once(PHPWG_ROOT_PATH.'admin/include/plugins.class.php');
3254  $plugins = new plugins();
3255  $errors = $plugins->perform_action($params['action'], $params['plugin']);
3256
3257
3258  if (!empty($errors))
3259  {
3260    return new PwgError(500, $errors);
3261  }
3262  else
3263  {
3264    if (in_array($params['action'], array('activate', 'deactivate')))
3265    {
3266      $template->delete_compiled_templates();
3267    }
3268    return true;
3269  }
3270}
3271
3272function ws_themes_performAction($params, &$service)
3273{
3274  global $template;
3275
3276  if (!is_admin())
3277  {
3278    return new PwgError(401, 'Access denied');
3279  }
3280
3281  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
3282  {
3283    return new PwgError(403, 'Invalid security token');
3284  }
3285
3286  define('IN_ADMIN', true);
3287  include_once(PHPWG_ROOT_PATH.'admin/include/themes.class.php');
3288  $themes = new themes();
3289  $errors = $themes->perform_action($params['action'], $params['theme']);
3290
3291  if (!empty($errors))
3292  {
3293    return new PwgError(500, $errors);
3294  }
3295  else
3296  {
3297    if (in_array($params['action'], array('activate', 'deactivate')))
3298    {
3299      $template->delete_compiled_templates();
3300    }
3301    return true;
3302  }
3303}
3304
3305function ws_extensions_update($params, &$service)
3306{
3307  if (!is_webmaster())
3308  {
3309    return new PwgError(401, l10n('Webmaster status is required.'));
3310  }
3311
3312  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
3313  {
3314    return new PwgError(403, 'Invalid security token');
3315  }
3316
3317  if (empty($params['type']) or !in_array($params['type'], array('plugins', 'themes', 'languages')))
3318  {
3319    return new PwgError(403, "invalid extension type");
3320  }
3321
3322  if (empty($params['id']) or empty($params['revision']))
3323  {
3324    return new PwgError(null, 'Wrong parameters');
3325  }
3326
3327  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
3328  include_once(PHPWG_ROOT_PATH.'admin/include/'.$params['type'].'.class.php');
3329
3330  $type = $params['type'];
3331  $extension_id = $params['id'];
3332  $revision = $params['revision'];
3333
3334  $extension = new $type();
3335
3336  if ($type == 'plugins')
3337  {
3338    if (isset($extension->db_plugins_by_id[$extension_id]) and $extension->db_plugins_by_id[$extension_id]['state'] == 'active')
3339    {
3340      $extension->perform_action('deactivate', $extension_id);
3341
3342      redirect(PHPWG_ROOT_PATH
3343        . 'ws.php'
3344        . '?method=pwg.extensions.update'
3345        . '&type=plugins'
3346        . '&id=' . $extension_id
3347        . '&revision=' . $revision
3348        . '&reactivate=true'
3349        . '&pwg_token=' . get_pwg_token()
3350        . '&format=json'
3351      );
3352    }
3353
3354    $upgrade_status = $extension->extract_plugin_files('upgrade', $revision, $extension_id);
3355    $extension_name = $extension->fs_plugins[$extension_id]['name'];
3356
3357    if (isset($params['reactivate']))
3358    {
3359      $extension->perform_action('activate', $extension_id);
3360    }
3361  }
3362  elseif ($type == 'themes')
3363  {
3364    $upgrade_status = $extension->extract_theme_files('upgrade', $revision, $extension_id);
3365    $extension_name = $extension->fs_themes[$extension_id]['name'];
3366  }
3367  elseif ($type == 'languages')
3368  {
3369    $upgrade_status = $extension->extract_language_files('upgrade', $revision, $extension_id);
3370    $extension_name = $extension->fs_languages[$extension_id]['name'];
3371  }
3372
3373  global $template;
3374  $template->delete_compiled_templates();
3375
3376  switch ($upgrade_status)
3377  {
3378    case 'ok':
3379      return sprintf(l10n('%s has been successfully updated.'), $extension_name);
3380
3381    case 'temp_path_error':
3382      return new PwgError(null, l10n('Can\'t create temporary file.'));
3383
3384    case 'dl_archive_error':
3385      return new PwgError(null, l10n('Can\'t download archive.'));
3386
3387    case 'archive_error':
3388      return new PwgError(null, l10n('Can\'t read or extract archive.'));
3389
3390    default:
3391      return new PwgError(null, sprintf(l10n('An error occured during extraction (%s).'), $upgrade_status));
3392  }
3393}
3394
3395function ws_extensions_ignoreupdate($params, &$service)
3396{
3397  global $conf;
3398
3399  define('IN_ADMIN', true);
3400  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
3401
3402  if (!is_webmaster())
3403  {
3404    return new PwgError(401, 'Access denied');
3405  }
3406
3407  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
3408  {
3409    return new PwgError(403, 'Invalid security token');
3410  }
3411
3412  $conf['updates_ignored'] = unserialize($conf['updates_ignored']);
3413
3414  // Reset ignored extension
3415  if ($params['reset'])
3416  {
3417    if (!empty($params['type']) and isset($conf['updates_ignored'][$params['type']]))
3418    {
3419      $conf['updates_ignored'][$params['type']] = array();
3420    }
3421    else
3422    {
3423      $conf['updates_ignored'] = array(
3424        'plugins'=>array(),
3425        'themes'=>array(),
3426        'languages'=>array()
3427      );
3428    }
3429    conf_update_param('updates_ignored', pwg_db_real_escape_string(serialize($conf['updates_ignored'])));
3430    unset($_SESSION['extensions_need_update']);
3431    return true;
3432  }
3433
3434  if (empty($params['id']) or empty($params['type']) or !in_array($params['type'], array('plugins', 'themes', 'languages')))
3435  {
3436    return new PwgError(403, 'Invalid parameters');
3437  }
3438
3439  // Add or remove extension from ignore list
3440  if (!in_array($params['id'], $conf['updates_ignored'][$params['type']]))
3441  {
3442    array_push($conf['updates_ignored'][$params['type']], $params['id']);
3443  }
3444  conf_update_param('updates_ignored', pwg_db_real_escape_string(serialize($conf['updates_ignored'])));
3445  unset($_SESSION['extensions_need_update']);
3446  return true;
3447}
3448
3449function ws_extensions_checkupdates($params, &$service)
3450{
3451  global $conf;
3452
3453  define('IN_ADMIN', true);
3454  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
3455  include_once(PHPWG_ROOT_PATH.'admin/include/updates.class.php');
3456  $update = new updates();
3457
3458  if (!is_admin())
3459  {
3460    return new PwgError(401, 'Access denied');
3461  }
3462
3463  $result = array();
3464
3465  if (!isset($_SESSION['need_update']))
3466    $update->check_piwigo_upgrade();
3467
3468  $result['piwigo_need_update'] = $_SESSION['need_update'];
3469
3470  $conf['updates_ignored'] = unserialize($conf['updates_ignored']);
3471
3472  if (!isset($_SESSION['extensions_need_update']))
3473    $update->check_extensions();
3474  else
3475    $update->check_updated_extensions();
3476
3477  if (!is_array($_SESSION['extensions_need_update']))
3478    $result['ext_need_update'] = null;
3479  else
3480    $result['ext_need_update'] = !empty($_SESSION['extensions_need_update']);
3481
3482  return $result;
3483}
3484?>
Note: See TracBrowser for help on using the repository browser.