source: branches/2.2/include/ws_functions.inc.php @ 11371

Revision 11371, 66.8 KB checked in by plg, 9 years ago (diff)

bug 2345 fixed: ability to update the rank of a photo for an existing
category. I haven't modified pwg.images.setInfo, I've just added a new
method pwg.images.setRank which does this very specific job.

  • Property svn:eol-style set to LF
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2011 Piwigo Team                  http://piwigo.org |
6// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
7// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
8// +-----------------------------------------------------------------------+
9// | This program is free software; you can redistribute it and/or modify  |
10// | it under the terms of the GNU General Public License as published by  |
11// | the Free Software Foundation                                          |
12// |                                                                       |
13// | This program is distributed in the hope that it will be useful, but   |
14// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
15// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
16// | General Public License for more details.                              |
17// |                                                                       |
18// | You should have received a copy of the GNU General Public License     |
19// | along with this program; if not, write to the Free Software           |
20// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
21// | USA.                                                                  |
22// +-----------------------------------------------------------------------+
23
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.'average_rate>'.$params['f_min_rate'];
58  }
59  if ( is_numeric($params['f_max_rate']) )
60  {
61    $clauses[] = $tbl_name.'average_rate<='.$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 ( $params['f_with_thumbnail'] )
96  {
97    $clauses[] = $tbl_name.'tn_ext IS NOT NULL';
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', 'average_rate',
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    'tn_url' => get_thumbnail_url($image_row),
151    'element_url' => get_element_url($image_row)
152  );
153  global $user;
154  if ($user['enabled_high'] and $image_row['has_high'] )
155  {
156    $ret['high_url'] = get_high_url($image_row);
157  }
158  return $ret;
159}
160
161/**
162 * returns an array of image attributes that are to be encoded as xml attributes
163 * instead of xml elements
164 */
165function ws_std_get_image_xml_attributes()
166{
167  return array(
168    'id','tn_url','element_url','high_url', 'file','width','height','hit','date_available','date_creation'
169    );
170}
171
172/**
173 * returns PWG version (web service method)
174 */
175function ws_getVersion($params, &$service)
176{
177  global $conf;
178  if ($conf['show_version'] or is_admin() )
179    return PHPWG_VERSION;
180  else
181    return new PwgError(403, 'Forbidden');
182}
183
184/**
185 * returns general informations (web service method)
186 */
187function ws_getInfos($params, &$service)
188{
189  if (!is_admin())
190  {
191    return new PwgError(403, 'Forbidden');
192  }
193
194  $infos['version'] = PHPWG_VERSION;
195       
196  $query = 'SELECT COUNT(*) FROM '.IMAGES_TABLE.';';
197  list($infos['nb_elements']) = pwg_db_fetch_row(pwg_query($query));
198
199  $query = 'SELECT COUNT(*) FROM '.CATEGORIES_TABLE.';';
200  list($infos['nb_categories']) = pwg_db_fetch_row(pwg_query($query));
201
202  $query = 'SELECT COUNT(*) FROM '.CATEGORIES_TABLE.' WHERE dir IS NULL;';
203  list($infos['nb_virtual']) = pwg_db_fetch_row(pwg_query($query));
204
205  $query = 'SELECT COUNT(*) FROM '.CATEGORIES_TABLE.' WHERE dir IS NOT NULL;';
206  list($infos['nb_physical']) = pwg_db_fetch_row(pwg_query($query));
207
208  $query = 'SELECT COUNT(*) FROM '.IMAGE_CATEGORY_TABLE.';';
209  list($infos['nb_image_category']) = pwg_db_fetch_row(pwg_query($query));
210
211  $query = 'SELECT COUNT(*) FROM '.TAGS_TABLE.';';
212  list($infos['nb_tags']) = pwg_db_fetch_row(pwg_query($query));
213
214  $query = 'SELECT COUNT(*) FROM '.IMAGE_TAG_TABLE.';';
215  list($infos['nb_image_tag']) = pwg_db_fetch_row(pwg_query($query));
216
217  $query = 'SELECT COUNT(*) FROM '.USERS_TABLE.';';
218  list($infos['nb_users']) = pwg_db_fetch_row(pwg_query($query));
219
220  $query = 'SELECT COUNT(*) FROM '.GROUPS_TABLE.';';
221  list($infos['nb_groups']) = pwg_db_fetch_row(pwg_query($query));
222
223  $query = 'SELECT COUNT(*) FROM '.COMMENTS_TABLE.';';
224  list($infos['nb_comments']) = pwg_db_fetch_row(pwg_query($query));
225
226  // first element
227  if ($infos['nb_elements'] > 0)
228  {
229    $query = 'SELECT MIN(date_available) FROM '.IMAGES_TABLE.';';
230    list($infos['first_date']) = pwg_db_fetch_row(pwg_query($query));
231  }
232
233  // unvalidated comments
234  if ($infos['nb_comments'] > 0)
235  {
236    $query = 'SELECT COUNT(*) FROM '.COMMENTS_TABLE.' WHERE validated=\'false\';';
237    list($infos['nb_unvalidated_comments']) = pwg_db_fetch_row(pwg_query($query));
238  }
239
240  foreach ($infos as $name => $value)
241  {
242    $output[] = array(
243      'name' => $name,
244      'value' => $value,
245    );
246  }
247
248  return array('infos' => new PwgNamedArray($output, 'item'));
249}
250
251function ws_caddie_add($params, &$service)
252{
253  if (!is_admin())
254  {
255    return new PwgError(401, 'Access denied');
256  }
257  $params['image_id'] = array_map( 'intval',$params['image_id'] );
258  if ( empty($params['image_id']) )
259  {
260    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
261  }
262  global $user;
263  $query = '
264SELECT id
265  FROM '.IMAGES_TABLE.' LEFT JOIN '.CADDIE_TABLE.' ON id=element_id AND user_id='.$user['id'].'
266  WHERE id IN ('.implode(',',$params['image_id']).')
267    AND element_id IS NULL';
268  $datas = array();
269  foreach ( array_from_query($query, 'id') as $id )
270  {
271    array_push($datas, array('element_id'=>$id, 'user_id'=>$user['id']) );
272  }
273  if (count($datas))
274  {
275    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
276    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
277  }
278  return count($datas);
279}
280
281/**
282 * returns images per category (web service method)
283 */
284function ws_categories_getImages($params, &$service)
285{
286  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
287  global $user, $conf;
288
289  $images = array();
290
291  //------------------------------------------------- get the related categories
292  $where_clauses = array();
293  foreach($params['cat_id'] as $cat_id)
294  {
295    $cat_id = (int)$cat_id;
296    if ($cat_id<=0)
297      continue;
298    if ($params['recursive'])
299    {
300      $where_clauses[] = 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.$cat_id.'(,|$)\'';
301    }
302    else
303    {
304      $where_clauses[] = 'id='.$cat_id;
305    }
306  }
307  if (!empty($where_clauses))
308  {
309    $where_clauses = array( '('.
310    implode('
311    OR ', $where_clauses) . ')'
312      );
313  }
314  $where_clauses[] = get_sql_condition_FandF(
315        array('forbidden_categories' => 'id'),
316        NULL, true
317      );
318
319  $query = '
320SELECT id, name, permalink, image_order
321  FROM '.CATEGORIES_TABLE.'
322  WHERE '. implode('
323    AND ', $where_clauses);
324  $result = pwg_query($query);
325  $cats = array();
326  while ($row = pwg_db_fetch_assoc($result))
327  {
328    $row['id'] = (int)$row['id'];
329    $cats[ $row['id'] ] = $row;
330  }
331
332  //-------------------------------------------------------- get the images
333  if ( !empty($cats) )
334  {
335    $where_clauses = ws_std_image_sql_filter( $params, 'i.' );
336    $where_clauses[] = 'category_id IN ('
337      .implode(',', array_keys($cats) )
338      .')';
339    $where_clauses[] = get_sql_condition_FandF( array(
340          'visible_images' => 'i.id'
341        ), null, true
342      );
343
344    $order_by = ws_std_image_sql_order($params, 'i.');
345    if ( empty($order_by)
346          and count($params['cat_id'])==1
347          and isset($cats[ $params['cat_id'][0] ]['image_order'])
348        )
349    {
350      $order_by = $cats[ $params['cat_id'][0] ]['image_order'];
351    }
352    $order_by = empty($order_by) ? $conf['order_by'] : 'ORDER BY '.$order_by;
353
354    $query = '
355SELECT i.*, GROUP_CONCAT(category_id) AS cat_ids
356  FROM '.IMAGES_TABLE.' i
357    INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON i.id=image_id
358  WHERE '. implode('
359    AND ', $where_clauses).'
360GROUP BY i.id
361'.$order_by.'
362LIMIT '.(int)$params['per_page'].' OFFSET '.(int)($params['per_page']*$params['page']);
363
364    $result = pwg_query($query);
365    while ($row = pwg_db_fetch_assoc($result))
366    {
367      $image = array();
368      foreach ( array('id', 'width', 'height', 'hit') as $k )
369      {
370        if (isset($row[$k]))
371        {
372          $image[$k] = (int)$row[$k];
373        }
374      }
375      foreach ( array('file', 'name', 'comment', 'date_creation', 'date_available') as $k )
376      {
377        $image[$k] = $row[$k];
378      }
379      $image = array_merge( $image, ws_std_get_urls($row) );
380
381      $image_cats = array();
382      foreach ( explode(',', $row['cat_ids']) as $cat_id )
383      {
384        $url = make_index_url(
385                array(
386                  'category' => $cats[$cat_id],
387                  )
388                );
389        $page_url = make_picture_url(
390                array(
391                  'category' => $cats[$cat_id],
392                  'image_id' => $row['id'],
393                  'image_file' => $row['file'],
394                  )
395                );
396        array_push( $image_cats,  array(
397              WS_XML_ATTRIBUTES => array (
398                  'id' => (int)$cat_id,
399                  'url' => $url,
400                  'page_url' => $page_url,
401                )
402            )
403          );
404      }
405
406      $image['categories'] = new PwgNamedArray(
407            $image_cats,'category', array('id','url','page_url')
408          );
409      array_push($images, $image);
410    }
411  }
412
413  return array( 'images' =>
414    array (
415      WS_XML_ATTRIBUTES =>
416        array(
417            'page' => $params['page'],
418            'per_page' => $params['per_page'],
419            'count' => count($images)
420          ),
421       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
422          ws_std_get_image_xml_attributes() )
423      )
424    );
425}
426
427
428/**
429 * returns a list of categories (web service method)
430 */
431function ws_categories_getList($params, &$service)
432{
433  global $user,$conf;
434
435  if ($params['tree_output'])
436  {
437    if (!isset($_GET['format']) or !in_array($_GET['format'], array('php', 'json')))
438    {
439      // the algorithm used to build a tree from a flat list of categories
440      // keeps original array keys, which is not compatible with
441      // PwgNamedArray.
442      //
443      // PwgNamedArray is useful to define which data is an attribute and
444      // which is an element in the XML output. The "hierarchy" output is
445      // only compatible with json/php output.
446     
447      return new PwgError(405, "The tree_output option is only compatible with json/php output formats");
448    }
449  }
450
451  $where = array('1=1');
452  $join_type = 'INNER';
453  $join_user = $user['id'];
454
455  if (!$params['recursive'])
456  {
457    if ($params['cat_id']>0)
458      $where[] = '(id_uppercat='.(int)($params['cat_id']).'
459    OR id='.(int)($params['cat_id']).')';
460    else
461      $where[] = 'id_uppercat IS NULL';
462  }
463  else if ($params['cat_id']>0)
464  {
465    $where[] = 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.
466      (int)($params['cat_id'])
467      .'(,|$)\'';
468  }
469
470  if ($params['public'])
471  {
472    $where[] = 'status = "public"';
473    $where[] = 'visible = "true"';
474   
475    $join_user = $conf['guest_id'];
476  }
477  elseif (is_admin())
478  {
479    // in this very specific case, we don't want to hide empty
480    // categories. Function calculate_permissions will only return
481    // categories that are either locked or private and not permitted
482    //
483    // calculate_permissions does not consider empty categories as forbidden
484    $forbidden_categories = calculate_permissions($user['id'], $user['status']);
485    $where[]= 'id NOT IN ('.$forbidden_categories.')';
486    $join_type = 'LEFT';
487  }
488
489  $query = '
490SELECT id, name, permalink, uppercats, global_rank, id_uppercat,
491    comment,
492    nb_images, count_images AS total_nb_images,
493    date_last, max_date_last, count_categories AS nb_categories
494  FROM '.CATEGORIES_TABLE.'
495   '.$join_type.' JOIN '.USER_CACHE_CATEGORIES_TABLE.' ON id=cat_id AND user_id='.$join_user.'
496  WHERE '. implode('
497    AND ', $where);
498
499  $result = pwg_query($query);
500
501  $cats = array();
502  while ($row = pwg_db_fetch_assoc($result))
503  {
504    $row['url'] = make_index_url(
505        array(
506          'category' => $row
507          )
508      );
509    foreach( array('id','nb_images','total_nb_images','nb_categories') as $key)
510    {
511      $row[$key] = (int)$row[$key];
512    }
513
514    $row['name'] = strip_tags(
515      trigger_event(
516        'render_category_name',
517        $row['name'],
518        'ws_categories_getList'
519        )
520      );
521   
522    $row['comment'] = strip_tags(
523      trigger_event(
524        'render_category_description',
525        $row['comment'],
526        'ws_categories_getList'
527        )
528      );
529   
530    array_push($cats, $row);
531  }
532  usort($cats, 'global_rank_compare');
533
534  if ($params['tree_output'])
535  { 
536    return categories_flatlist_to_tree($cats);
537  }
538  else
539  {
540    return array(
541      'categories' => new PwgNamedArray(
542        $cats,
543        'category',
544        array(
545          'id',
546          'url',
547          'nb_images',
548          'total_nb_images',
549          'nb_categories',
550          'date_last',
551          'max_date_last',
552          )
553        )
554      );
555  }
556}
557
558/**
559 * returns the list of categories as you can see them in administration (web
560 * service method).
561 *
562 * Only admin can run this method and permissions are not taken into
563 * account.
564 */
565function ws_categories_getAdminList($params, &$service)
566{
567  if (!is_admin())
568  {
569    return new PwgError(401, 'Access denied');
570  }
571
572  $query = '
573SELECT
574    category_id,
575    COUNT(*) AS counter
576  FROM '.IMAGE_CATEGORY_TABLE.'
577  GROUP BY category_id
578;';
579  $nb_images_of = simple_hash_from_query($query, 'category_id', 'counter');
580
581  $query = '
582SELECT
583    id,
584    name,
585    comment,
586    uppercats,
587    global_rank
588  FROM '.CATEGORIES_TABLE.'
589;';
590  $result = pwg_query($query);
591  $cats = array();
592
593  while ($row = pwg_db_fetch_assoc($result))
594  {
595    $id = $row['id'];
596    $row['nb_images'] = isset($nb_images_of[$id]) ? $nb_images_of[$id] : 0;
597    $row['name'] = strip_tags(
598      trigger_event(
599        'render_category_name',
600        $row['name'],
601        'ws_categories_getAdminList'
602        )
603      );
604    $row['comment'] = strip_tags(
605      trigger_event(
606        'render_category_description',
607        $row['comment'],
608        'ws_categories_getAdminList'
609        )
610      );
611    array_push($cats, $row);
612  }
613
614  usort($cats, 'global_rank_compare');
615  return array(
616    'categories' => new PwgNamedArray(
617      $cats,
618      'category',
619      array(
620        'id',
621        'nb_images',
622        'name',
623        'uppercats',
624        'global_rank',
625        )
626      )
627    );
628}
629
630/**
631 * returns detailed information for an element (web service method)
632 */
633function ws_images_addComment($params, &$service)
634{
635  if (!$service->isPost())
636  {
637    return new PwgError(405, "This method requires HTTP POST");
638  }
639  $params['image_id'] = (int)$params['image_id'];
640  $query = '
641SELECT DISTINCT image_id
642  FROM '.IMAGE_CATEGORY_TABLE.' INNER JOIN '.CATEGORIES_TABLE.' ON category_id=id
643  WHERE commentable="true"
644    AND image_id='.$params['image_id'].
645    get_sql_condition_FandF(
646      array(
647        'forbidden_categories' => 'id',
648        'visible_categories' => 'id',
649        'visible_images' => 'image_id'
650      ),
651      ' AND'
652    );
653  if ( !pwg_db_num_rows( pwg_query( $query ) ) )
654  {
655    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
656  }
657
658  $comm = array(
659    'author' => trim( $params['author'] ),
660    'content' => trim( $params['content'] ),
661    'image_id' => $params['image_id'],
662   );
663
664  include_once(PHPWG_ROOT_PATH.'include/functions_comment.inc.php');
665
666  $comment_action = insert_user_comment(
667      $comm, $params['key'], $infos
668    );
669
670  switch ($comment_action)
671  {
672    case 'reject':
673      array_push($infos, l10n('Your comment has NOT been registered because it did not pass the validation rules') );
674      return new PwgError(403, implode("; ", $infos) );
675    case 'validate':
676    case 'moderate':
677      $ret = array(
678          'id' => $comm['id'],
679          'validation' => $comment_action=='validate',
680        );
681      return new PwgNamedStruct(
682          'comment',
683          $ret,
684          null, array()
685        );
686    default:
687      return new PwgError(500, "Unknown comment action ".$comment_action );
688  }
689}
690
691/**
692 * returns detailed information for an element (web service method)
693 */
694function ws_images_getInfo($params, &$service)
695{
696  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
697  global $user, $conf;
698  $params['image_id'] = (int)$params['image_id'];
699  if ( $params['image_id']<=0 )
700  {
701    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
702  }
703
704  $query='
705SELECT * FROM '.IMAGES_TABLE.'
706  WHERE id='.$params['image_id'].
707    get_sql_condition_FandF(
708      array('visible_images' => 'id'),
709      ' AND'
710    ).'
711LIMIT 1';
712
713  $image_row = pwg_db_fetch_assoc(pwg_query($query));
714  if ($image_row==null)
715  {
716    return new PwgError(404, "image_id not found");
717  }
718  $image_row = array_merge( $image_row, ws_std_get_urls($image_row) );
719
720  //-------------------------------------------------------- related categories
721  $query = '
722SELECT id, name, permalink, uppercats, global_rank, commentable
723  FROM '.IMAGE_CATEGORY_TABLE.'
724    INNER JOIN '.CATEGORIES_TABLE.' ON category_id = id
725  WHERE image_id = '.$image_row['id'].
726  get_sql_condition_FandF(
727      array( 'forbidden_categories' => 'category_id' ),
728      ' AND'
729    ).'
730;';
731  $result = pwg_query($query);
732  $is_commentable = false;
733  $related_categories = array();
734  while ($row = pwg_db_fetch_assoc($result))
735  {
736    if ($row['commentable']=='true')
737    {
738      $is_commentable = true;
739    }
740    unset($row['commentable']);
741    $row['url'] = make_index_url(
742        array(
743          'category' => $row
744          )
745      );
746
747    $row['page_url'] = make_picture_url(
748        array(
749          'image_id' => $image_row['id'],
750          'image_file' => $image_row['file'],
751          'category' => $row
752          )
753      );
754    $row['id']=(int)$row['id'];
755    array_push($related_categories, $row);
756  }
757  usort($related_categories, 'global_rank_compare');
758  if ( empty($related_categories) )
759  {
760    return new PwgError(401, 'Access denied');
761  }
762
763  //-------------------------------------------------------------- related tags
764  $related_tags = get_common_tags( array($image_row['id']), -1 );
765  foreach( $related_tags as $i=>$tag)
766  {
767    $tag['url'] = make_index_url(
768        array(
769          'tags' => array($tag)
770          )
771      );
772    $tag['page_url'] = make_picture_url(
773        array(
774          'image_id' => $image_row['id'],
775          'image_file' => $image_row['file'],
776          'tags' => array($tag),
777          )
778      );
779    unset($tag['counter']);
780    $tag['id']=(int)$tag['id'];
781    $related_tags[$i]=$tag;
782  }
783  //------------------------------------------------------------- related rates
784  $query = '
785SELECT COUNT(rate) AS count
786     , ROUND(AVG(rate),2) AS average
787  FROM '.RATE_TABLE.'
788  WHERE element_id = '.$image_row['id'].'
789;';
790  $rating = pwg_db_fetch_assoc(pwg_query($query));
791  $rating['count'] = (int)$rating['count'];
792
793  //---------------------------------------------------------- related comments
794  $related_comments = array();
795
796  $where_comments = 'image_id = '.$image_row['id'];
797  if ( !is_admin() )
798  {
799    $where_comments .= '
800    AND validated="true"';
801  }
802
803  $query = '
804SELECT COUNT(id) AS nb_comments
805  FROM '.COMMENTS_TABLE.'
806  WHERE '.$where_comments;
807  list($nb_comments) = array_from_query($query, 'nb_comments');
808  $nb_comments = (int)$nb_comments;
809
810  if ( $nb_comments>0 and $params['comments_per_page']>0 )
811  {
812    $query = '
813SELECT id, date, author, content
814  FROM '.COMMENTS_TABLE.'
815  WHERE '.$where_comments.'
816  ORDER BY date
817  LIMIT '.(int)$params['comments_per_page'].
818    ' OFFSET '.(int)($params['comments_per_page']*$params['comments_page']);
819
820    $result = pwg_query($query);
821    while ($row = pwg_db_fetch_assoc($result))
822    {
823      $row['id']=(int)$row['id'];
824      array_push($related_comments, $row);
825    }
826  }
827
828  $comment_post_data = null;
829  if ($is_commentable and
830      (!is_a_guest()
831        or (is_a_guest() and $conf['comments_forall'] )
832      )
833      )
834  {
835    $comment_post_data['author'] = stripslashes($user['username']);
836    $comment_post_data['key'] = get_ephemeral_key(2, $params['image_id']);
837  }
838
839  $ret = $image_row;
840  foreach ( array('id','width','height','hit','filesize') as $k )
841  {
842    if (isset($ret[$k]))
843    {
844      $ret[$k] = (int)$ret[$k];
845    }
846  }
847  foreach ( array('path', 'storage_category_id') as $k )
848  {
849    unset($ret[$k]);
850  }
851
852  $ret['rates'] = array( WS_XML_ATTRIBUTES => $rating );
853  $ret['categories'] = new PwgNamedArray($related_categories, 'category', array('id','url', 'page_url') );
854  $ret['tags'] = new PwgNamedArray($related_tags, 'tag', array('id','url_name','url','name','page_url') );
855  if ( isset($comment_post_data) )
856  {
857    $ret['comment_post'] = array( WS_XML_ATTRIBUTES => $comment_post_data );
858  }
859  $ret['comments'] = array(
860     WS_XML_ATTRIBUTES =>
861        array(
862          'page' => $params['comments_page'],
863          'per_page' => $params['comments_per_page'],
864          'count' => count($related_comments),
865          'nb_comments' => $nb_comments,
866        ),
867     WS_XML_CONTENT => new PwgNamedArray($related_comments, 'comment', array('id','date') )
868      );
869
870  return new PwgNamedStruct('image',$ret, null, array('name','comment') );
871}
872
873
874/**
875 * rates the image_id in the parameter
876 */
877function ws_images_Rate($params, &$service)
878{
879  $image_id = (int)$params['image_id'];
880  $query = '
881SELECT DISTINCT id FROM '.IMAGES_TABLE.'
882  INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON id=image_id
883  WHERE id='.$image_id
884  .get_sql_condition_FandF(
885    array(
886        'forbidden_categories' => 'category_id',
887        'forbidden_images' => 'id',
888      ),
889    '    AND'
890    ).'
891    LIMIT 1';
892  if ( pwg_db_num_rows( pwg_query($query) )==0 )
893  {
894    return new PwgError(404, "Invalid image_id or access denied" );
895  }
896  $rate = (int)$params['rate'];
897  include_once(PHPWG_ROOT_PATH.'include/functions_rate.inc.php');
898  $res = rate_picture( $image_id, $rate );
899  if ($res==false)
900  {
901    global $conf;
902    return new PwgError( 403, "Forbidden or rate not in ". implode(',',$conf['rate_items']));
903  }
904  return $res;
905}
906
907
908/**
909 * returns a list of elements corresponding to a query search
910 */
911function ws_images_search($params, &$service)
912{
913  global $page;
914  $images = array();
915  include_once( PHPWG_ROOT_PATH .'include/functions_search.inc.php' );
916  include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
917
918  $where_clauses = ws_std_image_sql_filter( $params, 'i.' );
919  $order_by = ws_std_image_sql_order($params, 'i.');
920
921  $super_order_by = false;
922  if ( !empty($order_by) )
923  {
924    global $conf;
925    $conf['order_by'] = 'ORDER BY '.$order_by;
926    $super_order_by=true; // quick_search_result might be faster
927  }
928
929  $search_result = get_quick_search_results($params['query'],
930      $super_order_by,
931      implode(',', $where_clauses)
932    );
933
934  $image_ids = array_slice(
935      $search_result['items'],
936      $params['page']*$params['per_page'],
937      $params['per_page']
938    );
939
940  if ( count($image_ids) )
941  {
942    $query = '
943SELECT * FROM '.IMAGES_TABLE.'
944  WHERE id IN ('.implode(',', $image_ids).')';
945
946    $image_ids = array_flip($image_ids);
947    $result = pwg_query($query);
948    while ($row = pwg_db_fetch_assoc($result))
949    {
950      $image = array();
951      foreach ( array('id', 'width', 'height', 'hit') as $k )
952      {
953        if (isset($row[$k]))
954        {
955          $image[$k] = (int)$row[$k];
956        }
957      }
958      foreach ( array('file', 'name', 'comment', 'date_creation', 'date_available') as $k )
959      {
960        $image[$k] = $row[$k];
961      }
962      $image = array_merge( $image, ws_std_get_urls($row) );
963      $images[$image_ids[$image['id']]] = $image;
964    }
965    ksort($images, SORT_NUMERIC);
966    $images = array_values($images);
967  }
968
969
970  return array( 'images' =>
971    array (
972      WS_XML_ATTRIBUTES =>
973        array(
974            'page' => $params['page'],
975            'per_page' => $params['per_page'],
976            'count' => count($images)
977          ),
978       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
979          ws_std_get_image_xml_attributes() )
980      )
981    );
982}
983
984function ws_images_setPrivacyLevel($params, &$service)
985{
986  if (!is_admin())
987  {
988    return new PwgError(401, 'Access denied');
989  }
990  if (!$service->isPost())
991  {
992    return new PwgError(405, "This method requires HTTP POST");
993  }
994  $params['image_id'] = array_map( 'intval',$params['image_id'] );
995  if ( empty($params['image_id']) )
996  {
997    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
998  }
999  global $conf;
1000  if ( !in_array( (int)$params['level'], $conf['available_permission_levels']) )
1001  {
1002    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid level");
1003  }
1004
1005  $query = '
1006UPDATE '.IMAGES_TABLE.'
1007  SET level='.(int)$params['level'].'
1008  WHERE id IN ('.implode(',',$params['image_id']).')';
1009  $result = pwg_query($query);
1010  $affected_rows = pwg_db_changes($result);
1011  if ($affected_rows)
1012  {
1013    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1014    invalidate_user_cache();
1015  }
1016  return $affected_rows;
1017}
1018
1019function ws_images_setRank($params, &$service)
1020{
1021  if (!is_admin())
1022  {
1023    return new PwgError(401, 'Access denied');
1024  }
1025 
1026  if (!$service->isPost())
1027  {
1028    return new PwgError(405, "This method requires HTTP POST");
1029  }
1030
1031  // is the image_id valid?
1032  $params['image_id'] = (int)$params['image_id'];
1033  if ($params['image_id'] <= 0)
1034  {
1035    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1036  }
1037
1038  // is the category valid?
1039  $params['category_id'] = (int)$params['category_id'];
1040  if ($params['category_id'] <= 0)
1041  {
1042    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1043  }
1044
1045  // is the rank valid?
1046  $params['rank'] = (int)$params['rank'];
1047  if ($params['rank'] <= 0)
1048  {
1049    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid rank");
1050  }
1051 
1052  // does the image really exist?
1053  $query='
1054SELECT
1055    *
1056  FROM '.IMAGES_TABLE.'
1057  WHERE id = '.$params['image_id'].'
1058;';
1059
1060  $image_row = pwg_db_fetch_assoc(pwg_query($query));
1061  if ($image_row == null)
1062  {
1063    return new PwgError(404, "image_id not found");
1064  }
1065 
1066  // is the image associated to this category?
1067  $query = '
1068SELECT
1069    image_id,
1070    category_id,
1071    rank
1072  FROM '.IMAGE_CATEGORY_TABLE.'
1073  WHERE image_id = '.$params['image_id'].'
1074    AND category_id = '.$params['category_id'].'
1075;';
1076  $category_row = pwg_db_fetch_assoc(pwg_query($query));
1077  if ($category_row == null)
1078  {
1079    return new PwgError(404, "This image is not associated to this category");
1080  }
1081
1082  // what is the current higher rank for this category?
1083  $query = '
1084SELECT
1085    MAX(rank) AS max_rank
1086  FROM '.IMAGE_CATEGORY_TABLE.'
1087  WHERE category_id = '.$params['category_id'].'
1088;';
1089  $result = pwg_query($query);
1090  $row = pwg_db_fetch_assoc($result);
1091
1092  if (is_numeric($row['max_rank']))
1093  {
1094    if ($params['rank'] > $row['max_rank'])
1095    {
1096      $params['rank'] = $row['max_rank'] + 1;
1097    }
1098  }
1099  else
1100  {
1101    $params['rank'] = 1;
1102  }
1103
1104  // update rank for all other photos in the same category
1105  $query = '
1106UPDATE '.IMAGE_CATEGORY_TABLE.'
1107  SET rank = rank + 1
1108  WHERE category_id = '.$params['category_id'].'
1109    AND rank IS NOT NULL
1110    AND rank >= '.$params['rank'].'
1111;';
1112  pwg_query($query);
1113
1114  // set the new rank for the photo
1115  $query = '
1116UPDATE '.IMAGE_CATEGORY_TABLE.'
1117  SET rank = '.$params['rank'].'
1118  WHERE image_id = '.$params['image_id'].'
1119    AND category_id = '.$params['category_id'].'
1120;';
1121  pwg_query($query);
1122
1123  // return data for client
1124  return array(
1125    'image_id' => $params['image_id'],
1126    'category_id' => $params['category_id'],
1127    'rank' => $params['rank'],
1128    );
1129}
1130
1131function ws_images_add_chunk($params, &$service)
1132{
1133  global $conf;
1134 
1135  ws_logfile('[ws_images_add_chunk] welcome');
1136  // data
1137  // original_sum
1138  // type {thumb, file, high}
1139  // position
1140
1141  if (!is_admin())
1142  {
1143    return new PwgError(401, 'Access denied');
1144  }
1145
1146  if (!$service->isPost())
1147  {
1148    return new PwgError(405, "This method requires HTTP POST");
1149  }
1150
1151  foreach ($params as $param_key => $param_value) {
1152    if ('data' == $param_key) {
1153      continue;
1154    }
1155   
1156    ws_logfile(
1157      sprintf(
1158        '[ws_images_add_chunk] input param "%s" : "%s"',
1159        $param_key,
1160        is_null($param_value) ? 'NULL' : $param_value
1161        )
1162      );
1163  }
1164
1165  $upload_dir = $conf['upload_dir'].'/buffer';
1166
1167  // create the upload directory tree if not exists
1168  if (!is_dir($upload_dir)) {
1169    umask(0000);
1170    $recursive = true;
1171    if (!@mkdir($upload_dir, 0777, $recursive))
1172    {
1173      return new PwgError(500, 'error during buffer directory creation');
1174    }
1175  }
1176
1177  if (!is_writable($upload_dir))
1178  {
1179    // last chance to make the directory writable
1180    @chmod($upload_dir, 0777);
1181
1182    if (!is_writable($upload_dir))
1183    {
1184      return new PwgError(500, 'buffer directory has no write access');
1185    }
1186  }
1187
1188  secure_directory($upload_dir);
1189
1190  $filename = sprintf(
1191    '%s-%s-%05u.block',
1192    $params['original_sum'],
1193    $params['type'],
1194    $params['position']
1195    );
1196
1197  ws_logfile('[ws_images_add_chunk] data length : '.strlen($params['data']));
1198
1199  $bytes_written = file_put_contents(
1200    $upload_dir.'/'.$filename,
1201    base64_decode($params['data'])
1202    );
1203
1204  if (false === $bytes_written) {
1205    return new PwgError(
1206      500,
1207      'an error has occured while writting chunk '.$params['position'].' for '.$params['type']
1208      );
1209  }
1210}
1211
1212function merge_chunks($output_filepath, $original_sum, $type)
1213{
1214  global $conf;
1215 
1216  ws_logfile('[merge_chunks] input parameter $output_filepath : '.$output_filepath);
1217
1218  if (is_file($output_filepath))
1219  {
1220    unlink($output_filepath);
1221
1222    if (is_file($output_filepath))
1223    {
1224      new PwgError(500, '[merge_chunks] error while trying to remove existing '.$output_filepath);
1225      exit();
1226    }
1227  }
1228
1229  $upload_dir = $conf['upload_dir'].'/buffer';
1230  $pattern = '/'.$original_sum.'-'.$type.'/';
1231  $chunks = array();
1232
1233  if ($handle = opendir($upload_dir))
1234  {
1235    while (false !== ($file = readdir($handle)))
1236    {
1237      if (preg_match($pattern, $file))
1238      {
1239        ws_logfile($file);
1240        array_push($chunks, $upload_dir.'/'.$file);
1241      }
1242    }
1243    closedir($handle);
1244  }
1245
1246  sort($chunks);
1247
1248  if (function_exists('memory_get_usage')) {
1249    ws_logfile('[merge_chunks] memory_get_usage before loading chunks: '.memory_get_usage());
1250  }
1251
1252  $i = 0;
1253
1254  foreach ($chunks as $chunk)
1255  {
1256    $string = file_get_contents($chunk);
1257
1258    if (function_exists('memory_get_usage')) {
1259      ws_logfile('[merge_chunks] memory_get_usage on chunk '.++$i.': '.memory_get_usage());
1260    }
1261
1262    if (!file_put_contents($output_filepath, $string, FILE_APPEND))
1263    {
1264      new PwgError(500, '[merge_chunks] error while writting chunks for '.$output_filepath);
1265      exit();
1266    }
1267
1268    unlink($chunk);
1269  }
1270
1271  if (function_exists('memory_get_usage')) {
1272    ws_logfile('[merge_chunks] memory_get_usage after loading chunks: '.memory_get_usage());
1273  }
1274}
1275
1276/*
1277 * The $file_path must be the path of the basic "web sized" photo
1278 * The $type value will automatically modify the $file_path to the corresponding file
1279 */
1280function add_file($file_path, $type, $original_sum, $file_sum)
1281{
1282  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
1283 
1284  $file_path = file_path_for_type($file_path, $type);
1285
1286  $upload_dir = dirname($file_path);
1287  if (substr(PHP_OS, 0, 3) == 'WIN')
1288  {
1289    $upload_dir = str_replace('/', DIRECTORY_SEPARATOR, $upload_dir);
1290  }
1291
1292  ws_logfile('[add_file] file_path  : '.$file_path);
1293  ws_logfile('[add_file] upload_dir : '.$upload_dir);
1294 
1295  if (!is_dir($upload_dir)) {
1296    umask(0000);
1297    $recursive = true;
1298    if (!@mkdir($upload_dir, 0777, $recursive))
1299    {
1300      new PwgError(500, '[add_file] error during '.$type.' directory creation');
1301      exit();
1302    }
1303  }
1304
1305  if (!is_writable($upload_dir))
1306  {
1307    // last chance to make the directory writable
1308    @chmod($upload_dir, 0777);
1309
1310    if (!is_writable($upload_dir))
1311    {
1312      new PwgError(500, '[add_file] '.$type.' directory has no write access');
1313      exit();
1314    }
1315  }
1316
1317  secure_directory($upload_dir);
1318
1319  // merge the thumbnail
1320  merge_chunks($file_path, $original_sum, $type);
1321  chmod($file_path, 0644);
1322
1323  // check dumped thumbnail md5
1324  $dumped_md5 = md5_file($file_path);
1325  if ($dumped_md5 != $file_sum) {
1326    new PwgError(500, '[add_file] '.$type.' transfer failed');
1327    exit();
1328  }
1329
1330  list($width, $height) = getimagesize($file_path);
1331  $filesize = floor(filesize($file_path)/1024);
1332
1333  return array(
1334    'width' => $width,
1335    'height' => $height,
1336    'filesize' => $filesize,
1337    );
1338}
1339
1340function ws_images_addFile($params, &$service)
1341{
1342  // image_id
1343  // type {thumb, file, high}
1344  // sum
1345
1346  global $conf;
1347  if (!is_admin())
1348  {
1349    return new PwgError(401, 'Access denied');
1350  }
1351
1352  $params['image_id'] = (int)$params['image_id'];
1353  if ($params['image_id'] <= 0)
1354  {
1355    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1356  }
1357
1358  //
1359  // what is the path?
1360  //
1361  $query = '
1362SELECT
1363    path,
1364    md5sum
1365  FROM '.IMAGES_TABLE.'
1366  WHERE id = '.$params['image_id'].'
1367;';
1368  list($file_path, $original_sum) = pwg_db_fetch_row(pwg_query($query));
1369
1370  // TODO only files added with web API can be updated with web API
1371
1372  //
1373  // makes sure directories are there and call the merge_chunks
1374  //
1375  $infos = add_file($file_path, $params['type'], $original_sum, $params['sum']);
1376
1377  //
1378  // update basic metadata from file
1379  //
1380  $update = array();
1381
1382  if ('high' == $params['type'])
1383  {
1384    $update['high_filesize'] = $infos['filesize'];
1385    $update['has_high'] = 'true';
1386  }
1387
1388  if ('file' == $params['type'])
1389  {
1390    $update['filesize'] = $infos['filesize'];
1391    $update['width'] = $infos['width'];
1392    $update['height'] = $infos['height'];
1393  }
1394
1395  // we may have nothing to update at database level, for example with a
1396  // thumbnail update
1397  if (count($update) > 0)
1398  {
1399    $update['id'] = $params['image_id'];
1400
1401    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1402    mass_updates(
1403      IMAGES_TABLE,
1404      array(
1405        'primary' => array('id'),
1406        'update'  => array_diff(array_keys($update), array('id'))
1407        ),
1408      array($update)
1409      );
1410  }
1411}
1412
1413function ws_images_add($params, &$service)
1414{
1415  global $conf, $user;
1416  if (!is_admin())
1417  {
1418    return new PwgError(401, 'Access denied');
1419  }
1420
1421  foreach ($params as $param_key => $param_value) {
1422    ws_logfile(
1423      sprintf(
1424        '[pwg.images.add] input param "%s" : "%s"',
1425        $param_key,
1426        is_null($param_value) ? 'NULL' : $param_value
1427        )
1428      );
1429  }
1430
1431  // does the image already exists ?
1432  if ('md5sum' == $conf['uniqueness_mode'])
1433  {
1434    $where_clause = "md5sum = '".$params['original_sum']."'";
1435  }
1436  if ('filename' == $conf['uniqueness_mode'])
1437  {
1438    $where_clause = "file = '".$params['original_filename']."'";
1439  }
1440 
1441  $query = '
1442SELECT
1443    COUNT(*) AS counter
1444  FROM '.IMAGES_TABLE.'
1445  WHERE '.$where_clause.'
1446;';
1447  list($counter) = pwg_db_fetch_row(pwg_query($query));
1448  if ($counter != 0) {
1449    return new PwgError(500, 'file already exists');
1450  }
1451
1452  // current date
1453  list($dbnow) = pwg_db_fetch_row(pwg_query('SELECT NOW();'));
1454  list($year, $month, $day) = preg_split('/[^\d]/', $dbnow, 4);
1455
1456  // upload directory hierarchy
1457  $upload_dir = sprintf(
1458    $conf['upload_dir'].'/%s/%s/%s',
1459    $year,
1460    $month,
1461    $day
1462    );
1463
1464  // compute file path
1465  $date_string = preg_replace('/[^\d]/', '', $dbnow);
1466  $random_string = substr($params['file_sum'], 0, 8);
1467  $filename_wo_ext = $date_string.'-'.$random_string;
1468  $file_path = $upload_dir.'/'.$filename_wo_ext.'.jpg';
1469
1470  // add files
1471  $file_infos  = add_file($file_path, 'file',  $params['original_sum'], $params['file_sum']);
1472  $thumb_infos = add_file($file_path, 'thumb', $params['original_sum'], $params['thumbnail_sum']);
1473
1474  if (isset($params['high_sum']))
1475  {
1476    $high_infos = add_file($file_path, 'high', $params['original_sum'], $params['high_sum']);
1477  }
1478
1479  // database registration
1480  $insert = array(
1481    'file' => !empty($params['original_filename']) ? $params['original_filename'] : $filename_wo_ext.'.jpg',
1482    'date_available' => $dbnow,
1483    'tn_ext' => 'jpg',
1484    'name' => $params['name'],
1485    'path' => $file_path,
1486    'filesize' => $file_infos['filesize'],
1487    'width' => $file_infos['width'],
1488    'height' => $file_infos['height'],
1489    'md5sum' => $params['original_sum'],
1490    'added_by' => $user['id'],
1491    );
1492
1493  $info_columns = array(
1494    'name',
1495    'author',
1496    'comment',
1497    'level',
1498    'date_creation',
1499    );
1500
1501  foreach ($info_columns as $key)
1502  {
1503    if (isset($params[$key]))
1504    {
1505      $insert[$key] = $params[$key];
1506    }
1507  }
1508
1509  if (isset($params['high_sum']))
1510  {
1511    $insert['has_high'] = 'true';
1512    $insert['high_filesize'] = $high_infos['filesize'];
1513  }
1514
1515  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1516  mass_inserts(
1517    IMAGES_TABLE,
1518    array_keys($insert),
1519    array($insert)
1520    );
1521
1522  $image_id = pwg_db_insert_id(IMAGES_TABLE);
1523
1524  // let's add links between the image and the categories
1525  if (isset($params['categories']))
1526  {
1527    ws_add_image_category_relations($image_id, $params['categories']);
1528  }
1529
1530  // and now, let's create tag associations
1531  if (isset($params['tag_ids']) and !empty($params['tag_ids']))
1532  {
1533    set_tags(
1534      explode(',', $params['tag_ids']),
1535      $image_id
1536      );
1537  }
1538
1539  // update metadata from the uploaded file (exif/iptc)
1540  require_once(PHPWG_ROOT_PATH.'admin/include/functions_metadata.php');
1541  update_metadata(array($image_id=>$file_path));
1542 
1543  invalidate_user_cache();
1544}
1545
1546function ws_images_addSimple($params, &$service)
1547{
1548  global $conf;
1549  if (!is_admin())
1550  {
1551    return new PwgError(401, 'Access denied');
1552  }
1553
1554  if (!$service->isPost())
1555  {
1556    return new PwgError(405, "This method requires HTTP POST");
1557  }
1558
1559  if (!isset($_FILES['image']))
1560  {
1561    return new PwgError(405, "The image (file) parameter is missing");
1562  }
1563 
1564  $params['image_id'] = (int)$params['image_id'];
1565  if ($params['image_id'] > 0)
1566  {
1567    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1568
1569    $query='
1570SELECT *
1571  FROM '.IMAGES_TABLE.'
1572  WHERE id = '.$params['image_id'].'
1573;';
1574
1575    $image_row = pwg_db_fetch_assoc(pwg_query($query));
1576    if ($image_row == null)
1577    {
1578      return new PwgError(404, "image_id not found");
1579    }
1580  }
1581
1582  // category
1583  $params['category'] = (int)$params['category'];
1584  if ($params['category'] <= 0 and $params['image_id'] <= 0)
1585  {
1586    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1587  }
1588
1589  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
1590  prepare_upload_configuration();
1591
1592  $image_id = add_uploaded_file(
1593    $_FILES['image']['tmp_name'],
1594    $_FILES['image']['name'],
1595    $params['category'] > 0 ? array($params['category']) : null,
1596    8,
1597    $params['image_id'] > 0 ? $params['image_id'] : null
1598    );
1599
1600  $info_columns = array(
1601    'name',
1602    'author',
1603    'comment',
1604    'level',
1605    'date_creation',
1606    );
1607
1608  foreach ($info_columns as $key)
1609  {
1610    if (isset($params[$key]))
1611    {
1612      $update[$key] = $params[$key];
1613    }
1614  }
1615
1616  if (count(array_keys($update)) > 0)
1617  {
1618    $update['id'] = $image_id;
1619
1620    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1621    mass_updates(
1622      IMAGES_TABLE,
1623      array(
1624        'primary' => array('id'),
1625        'update'  => array_diff(array_keys($update), array('id'))
1626        ),
1627      array($update)
1628      );
1629  }
1630
1631
1632  if (isset($params['tags']) and !empty($params['tags']))
1633  {
1634    $tag_ids = array();
1635    $tag_names = explode(',', $params['tags']);
1636    foreach ($tag_names as $tag_name)
1637    {
1638      $tag_id = tag_id_from_tag_name($tag_name);
1639      array_push($tag_ids, $tag_id);
1640    }
1641
1642    add_tags($tag_ids, array($image_id));
1643  }
1644
1645  $url_params = array('image_id' => $image_id);
1646
1647  if ($params['category'] > 0)
1648  {
1649    $query = '
1650SELECT id, name, permalink
1651  FROM '.CATEGORIES_TABLE.'
1652  WHERE id = '.$params['category'].'
1653;';
1654    $result = pwg_query($query);
1655    $category = pwg_db_fetch_assoc($result);
1656
1657    $url_params['section'] = 'categories';
1658    $url_params['category'] = $category;
1659  }
1660
1661  // update metadata from the uploaded file (exif/iptc), even if the sync
1662  // was already performed by add_uploaded_file().
1663  $query = '
1664SELECT
1665    path
1666  FROM '.IMAGES_TABLE.'
1667  WHERE id = '.$image_id.'
1668;';
1669  list($file_path) = pwg_db_fetch_row(pwg_query($query));
1670 
1671  require_once(PHPWG_ROOT_PATH.'admin/include/functions_metadata.php');
1672  update_metadata(array($image_id=>$file_path));
1673
1674  return array(
1675    'image_id' => $image_id,
1676    'url' => make_picture_url($url_params),
1677    );
1678}
1679
1680/**
1681 * perform a login (web service method)
1682 */
1683function ws_session_login($params, &$service)
1684{
1685  global $conf;
1686
1687  if (!$service->isPost())
1688  {
1689    return new PwgError(405, "This method requires HTTP POST");
1690  }
1691  if (try_log_user($params['username'], $params['password'],false))
1692  {
1693    return true;
1694  }
1695  return new PwgError(999, 'Invalid username/password');
1696}
1697
1698
1699/**
1700 * performs a logout (web service method)
1701 */
1702function ws_session_logout($params, &$service)
1703{
1704  if (!is_a_guest())
1705  {
1706    logout_user();
1707  }
1708  return true;
1709}
1710
1711function ws_session_getStatus($params, &$service)
1712{
1713  global $user;
1714  $res = array();
1715  $res['username'] = is_a_guest() ? 'guest' : stripslashes($user['username']);
1716  foreach ( array('status', 'theme', 'language') as $k )
1717  {
1718    $res[$k] = $user[$k];
1719  }
1720  $res['pwg_token'] = get_pwg_token();
1721  $res['charset'] = get_pwg_charset();
1722  return $res;
1723}
1724
1725
1726/**
1727 * returns a list of tags (web service method)
1728 */
1729function ws_tags_getList($params, &$service)
1730{
1731  $tags = get_available_tags();
1732  if ($params['sort_by_counter'])
1733  {
1734    usort($tags, create_function('$a,$b', 'return -$a["counter"]+$b["counter"];') );
1735  }
1736  else
1737  {
1738    usort($tags, 'tag_alpha_compare');
1739  }
1740  for ($i=0; $i<count($tags); $i++)
1741  {
1742    $tags[$i]['id'] = (int)$tags[$i]['id'];
1743    $tags[$i]['counter'] = (int)$tags[$i]['counter'];
1744    $tags[$i]['url'] = make_index_url(
1745        array(
1746          'section'=>'tags',
1747          'tags'=>array($tags[$i])
1748        )
1749      );
1750  }
1751  return array('tags' => new PwgNamedArray($tags, 'tag', array('id','url_name','url', 'name', 'counter' )) );
1752}
1753
1754/**
1755 * returns the list of tags as you can see them in administration (web
1756 * service method).
1757 *
1758 * Only admin can run this method and permissions are not taken into
1759 * account.
1760 */
1761function ws_tags_getAdminList($params, &$service)
1762{
1763  if (!is_admin())
1764  {
1765    return new PwgError(401, 'Access denied');
1766  }
1767
1768  $tags = get_all_tags();
1769  return array(
1770    'tags' => new PwgNamedArray(
1771      $tags,
1772      'tag',
1773      array(
1774        'name',
1775        'id',
1776        'url_name',
1777        )
1778      )
1779    );
1780}
1781
1782/**
1783 * returns a list of images for tags (web service method)
1784 */
1785function ws_tags_getImages($params, &$service)
1786{
1787  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1788  global $conf;
1789
1790  // first build all the tag_ids we are interested in
1791  $params['tag_id'] = array_map( 'intval',$params['tag_id'] );
1792  $tags = find_tags($params['tag_id'], $params['tag_url_name'], $params['tag_name']);
1793  $tags_by_id = array();
1794  foreach( $tags as $tag )
1795  {
1796    $tags['id'] = (int)$tag['id'];
1797    $tags_by_id[ $tag['id'] ] = $tag;
1798  }
1799  unset($tags);
1800  $tag_ids = array_keys($tags_by_id);
1801
1802
1803  $where_clauses = ws_std_image_sql_filter($params);
1804  if (!empty($where_clauses))
1805  {
1806    $where_clauses = implode( ' AND ', $where_clauses);
1807  }
1808  $image_ids = get_image_ids_for_tags(
1809    $tag_ids,
1810    $params['tag_mode_and'] ? 'AND' : 'OR',
1811    $where_clauses,
1812    ws_std_image_sql_order($params) );
1813
1814
1815  $image_ids = array_slice($image_ids, (int)($params['per_page']*$params['page']), (int)$params['per_page'] );
1816 
1817  $image_tag_map = array();
1818  if ( !empty($image_ids) and !$params['tag_mode_and'] )
1819  { // build list of image ids with associated tags per image
1820    $query = '
1821SELECT image_id, GROUP_CONCAT(tag_id) AS tag_ids
1822  FROM '.IMAGE_TAG_TABLE.'
1823  WHERE tag_id IN ('.implode(',',$tag_ids).') AND image_id IN ('.implode(',',$image_ids).')
1824  GROUP BY image_id';
1825    $result = pwg_query($query);
1826    while ( $row=pwg_db_fetch_assoc($result) )
1827    {
1828      $row['image_id'] = (int)$row['image_id'];
1829      array_push( $image_ids, $row['image_id'] );
1830      $image_tag_map[ $row['image_id'] ] = explode(',', $row['tag_ids']);
1831    }
1832  }
1833
1834  $images = array();
1835  if (!empty($image_ids))
1836  {
1837    $rank_of = array_flip($image_ids);
1838    $result = pwg_query('
1839SELECT * FROM '.IMAGES_TABLE.'
1840  WHERE id IN ('.implode(',',$image_ids).')');
1841    while ($row = pwg_db_fetch_assoc($result))
1842    {
1843      $image = array();
1844      $image['rank'] = $rank_of[ $row['id'] ];
1845      foreach ( array('id', 'width', 'height', 'hit') as $k )
1846      {
1847        if (isset($row[$k]))
1848        {
1849          $image[$k] = (int)$row[$k];
1850        }
1851      }
1852      foreach ( array('file', 'name', 'comment', 'date_creation', 'date_available') as $k )
1853      {
1854        $image[$k] = $row[$k];
1855      }
1856      $image = array_merge( $image, ws_std_get_urls($row) );
1857
1858      $image_tag_ids = ($params['tag_mode_and']) ? $tag_ids : $image_tag_map[$image['id']];
1859      $image_tags = array();
1860      foreach ($image_tag_ids as $tag_id)
1861      {
1862        $url = make_index_url(
1863                 array(
1864                  'section'=>'tags',
1865                  'tags'=> array($tags_by_id[$tag_id])
1866                )
1867              );
1868        $page_url = make_picture_url(
1869                 array(
1870                  'section'=>'tags',
1871                  'tags'=> array($tags_by_id[$tag_id]),
1872                  'image_id' => $row['id'],
1873                  'image_file' => $row['file'],
1874                )
1875              );
1876        array_push($image_tags, array(
1877                'id' => (int)$tag_id,
1878                'url' => $url,
1879                'page_url' => $page_url,
1880              )
1881            );
1882      }
1883      $image['tags'] = new PwgNamedArray($image_tags, 'tag',
1884              array('id','url_name','url','page_url')
1885            );
1886      array_push($images, $image);
1887    }
1888    usort($images, 'rank_compare');
1889    unset($rank_of);
1890  }
1891
1892  return array( 'images' =>
1893    array (
1894      WS_XML_ATTRIBUTES =>
1895        array(
1896            'page' => $params['page'],
1897            'per_page' => $params['per_page'],
1898            'count' => count($images)
1899          ),
1900       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
1901          ws_std_get_image_xml_attributes() )
1902      )
1903    );
1904}
1905
1906function ws_categories_add($params, &$service)
1907{
1908  if (!is_admin())
1909  {
1910    return new PwgError(401, 'Access denied');
1911  }
1912
1913  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1914
1915  $creation_output = create_virtual_category(
1916    $params['name'],
1917    $params['parent']
1918    );
1919
1920  if (isset($creation_output['error']))
1921  {
1922    return new PwgError(500, $creation_output['error']);
1923  }
1924
1925  invalidate_user_cache();
1926
1927  return $creation_output;
1928}
1929
1930function ws_tags_add($params, &$service)
1931{
1932  if (!is_admin())
1933  {
1934    return new PwgError(401, 'Access denied');
1935  }
1936
1937  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1938
1939  $creation_output = create_tag($params['name']);
1940
1941  if (isset($creation_output['error']))
1942  {
1943    return new PwgError(500, $creation_output['error']);
1944  }
1945
1946  return $creation_output;
1947}
1948
1949function ws_images_exist($params, &$service)
1950{
1951  global $conf;
1952 
1953  if (!is_admin())
1954  {
1955    return new PwgError(401, 'Access denied');
1956  }
1957
1958  $split_pattern = '/[\s,;\|]/';
1959
1960  if ('md5sum' == $conf['uniqueness_mode'])
1961  {
1962    // search among photos the list of photos already added, based on md5sum
1963    // list
1964    $md5sums = preg_split(
1965      $split_pattern,
1966      $params['md5sum_list'],
1967      -1,
1968      PREG_SPLIT_NO_EMPTY
1969    );
1970
1971    $query = '
1972SELECT
1973    id,
1974    md5sum
1975  FROM '.IMAGES_TABLE.'
1976  WHERE md5sum IN (\''.implode("','", $md5sums).'\')
1977;';
1978    $id_of_md5 = simple_hash_from_query($query, 'md5sum', 'id');
1979
1980    $result = array();
1981
1982    foreach ($md5sums as $md5sum)
1983    {
1984      $result[$md5sum] = null;
1985      if (isset($id_of_md5[$md5sum]))
1986      {
1987        $result[$md5sum] = $id_of_md5[$md5sum];
1988      }
1989    }
1990  }
1991 
1992  if ('filename' == $conf['uniqueness_mode'])
1993  {
1994    // search among photos the list of photos already added, based on
1995    // filename list
1996    $filenames = preg_split(
1997      $split_pattern,
1998      $params['filename_list'],
1999      -1,
2000      PREG_SPLIT_NO_EMPTY
2001    );
2002
2003    $query = '
2004SELECT
2005    id,
2006    file
2007  FROM '.IMAGES_TABLE.'
2008  WHERE file IN (\''.implode("','", $filenames).'\')
2009;';
2010    $id_of_filename = simple_hash_from_query($query, 'file', 'id');
2011
2012    $result = array();
2013
2014    foreach ($filenames as $filename)
2015    {
2016      $result[$filename] = null;
2017      if (isset($id_of_filename[$filename]))
2018      {
2019        $result[$filename] = $id_of_filename[$filename];
2020      }
2021    }
2022  }
2023
2024  return $result;
2025}
2026
2027function ws_images_checkFiles($params, &$service)
2028{
2029  if (!is_admin())
2030  {
2031    return new PwgError(401, 'Access denied');
2032  }
2033
2034  // input parameters
2035  //
2036  // image_id
2037  // thumbnail_sum
2038  // file_sum
2039  // high_sum
2040
2041  $params['image_id'] = (int)$params['image_id'];
2042  if ($params['image_id'] <= 0)
2043  {
2044    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
2045  }
2046
2047  $query = '
2048SELECT
2049    path
2050  FROM '.IMAGES_TABLE.'
2051  WHERE id = '.$params['image_id'].'
2052;';
2053  $result = pwg_query($query);
2054  if (pwg_db_num_rows($result) == 0) {
2055    return new PwgError(404, "image_id not found");
2056  }
2057  list($path) = pwg_db_fetch_row($result);
2058
2059  $ret = array();
2060
2061  foreach (array('thumb', 'file', 'high') as $type) {
2062    $param_name = $type;
2063    if ('thumb' == $type) {
2064      $param_name = 'thumbnail';
2065    }
2066
2067    if (isset($params[$param_name.'_sum'])) {
2068      include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
2069      $type_path = file_path_for_type($path, $type);
2070      if (!is_file($type_path)) {
2071        $ret[$param_name] = 'missing';
2072      }
2073      else {
2074        if (md5_file($type_path) != $params[$param_name.'_sum']) {
2075          $ret[$param_name] = 'differs';
2076        }
2077        else {
2078          $ret[$param_name] = 'equals';
2079        }
2080      }
2081    }
2082  }
2083
2084  return $ret;
2085}
2086
2087function ws_images_setInfo($params, &$service)
2088{
2089  global $conf;
2090  if (!is_admin())
2091  {
2092    return new PwgError(401, 'Access denied');
2093  }
2094
2095  if (!$service->isPost())
2096  {
2097    return new PwgError(405, "This method requires HTTP POST");
2098  }
2099
2100  $params['image_id'] = (int)$params['image_id'];
2101  if ($params['image_id'] <= 0)
2102  {
2103    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
2104  }
2105
2106  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2107
2108  $query='
2109SELECT *
2110  FROM '.IMAGES_TABLE.'
2111  WHERE id = '.$params['image_id'].'
2112;';
2113
2114  $image_row = pwg_db_fetch_assoc(pwg_query($query));
2115  if ($image_row == null)
2116  {
2117    return new PwgError(404, "image_id not found");
2118  }
2119
2120  // database registration
2121  $update = array();
2122
2123  $info_columns = array(
2124    'name',
2125    'author',
2126    'comment',
2127    'level',
2128    'date_creation',
2129    );
2130
2131  foreach ($info_columns as $key)
2132  {
2133    if (isset($params[$key]))
2134    {
2135      if ('fill_if_empty' == $params['single_value_mode'])
2136      {
2137        if (empty($image_row[$key]))
2138        {
2139          $update[$key] = $params[$key];
2140        }
2141      }
2142      elseif ('replace' == $params['single_value_mode'])
2143      {
2144        $update[$key] = $params[$key];
2145      }
2146      else
2147      {
2148        new PwgError(
2149          500,
2150          '[ws_images_setInfo]'
2151          .' invalid parameter single_value_mode "'.$params['single_value_mode'].'"'
2152          .', possible values are {fill_if_empty, replace}.'
2153          );
2154        exit();
2155      }
2156    }
2157  }
2158
2159  if (count(array_keys($update)) > 0)
2160  {
2161    $update['id'] = $params['image_id'];
2162
2163    mass_updates(
2164      IMAGES_TABLE,
2165      array(
2166        'primary' => array('id'),
2167        'update'  => array_diff(array_keys($update), array('id'))
2168        ),
2169      array($update)
2170      );
2171  }
2172
2173  if (isset($params['categories']))
2174  {
2175    ws_add_image_category_relations(
2176      $params['image_id'],
2177      $params['categories'],
2178      ('replace' == $params['multiple_value_mode'] ? true : false)
2179      );
2180  }
2181
2182  // and now, let's create tag associations
2183  if (isset($params['tag_ids']))
2184  {
2185    $tag_ids = explode(',', $params['tag_ids']);
2186
2187    if ('replace' == $params['multiple_value_mode'])
2188    {
2189      set_tags(
2190        $tag_ids,
2191        $params['image_id']
2192        );
2193    }
2194    elseif ('append' == $params['multiple_value_mode'])
2195    {
2196      add_tags(
2197        $tag_ids,
2198        array($params['image_id'])
2199        );
2200    }
2201    else
2202    {
2203      new PwgError(
2204        500,
2205        '[ws_images_setInfo]'
2206        .' invalid parameter multiple_value_mode "'.$params['multiple_value_mode'].'"'
2207        .', possible values are {replace, append}.'
2208        );
2209      exit();
2210    }
2211  }
2212
2213  invalidate_user_cache();
2214}
2215
2216function ws_images_delete($params, &$service)
2217{
2218  global $conf;
2219  if (!is_admin())
2220  {
2221    return new PwgError(401, 'Access denied');
2222  }
2223
2224  if (!$service->isPost())
2225  {
2226    return new PwgError(405, "This method requires HTTP POST");
2227  }
2228
2229  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2230  {
2231    return new PwgError(403, 'Invalid security token');
2232  }
2233
2234  $params['image_id'] = preg_split(
2235    '/[\s,;\|]/',
2236    $params['image_id'],
2237    -1,
2238    PREG_SPLIT_NO_EMPTY
2239    );
2240  $params['image_id'] = array_map('intval', $params['image_id']);
2241
2242  $image_ids = array();
2243  foreach ($params['image_id'] as $image_id)
2244  {
2245    if ($image_id > 0)
2246    {
2247      array_push($image_ids, $image_id);
2248    }
2249  }
2250
2251  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2252  delete_elements($image_ids, true);
2253}
2254
2255function ws_add_image_category_relations($image_id, $categories_string, $replace_mode=false)
2256{
2257  // let's add links between the image and the categories
2258  //
2259  // $params['categories'] should look like 123,12;456,auto;789 which means:
2260  //
2261  // 1. associate with category 123 on rank 12
2262  // 2. associate with category 456 on automatic rank
2263  // 3. associate with category 789 on automatic rank
2264  $cat_ids = array();
2265  $rank_on_category = array();
2266  $search_current_ranks = false;
2267
2268  $tokens = explode(';', $categories_string);
2269  foreach ($tokens as $token)
2270  {
2271    @list($cat_id, $rank) = explode(',', $token);
2272
2273    if (!preg_match('/^\d+$/', $cat_id))
2274    {
2275      continue;
2276    }
2277
2278    array_push($cat_ids, $cat_id);
2279
2280    if (!isset($rank))
2281    {
2282      $rank = 'auto';
2283    }
2284    $rank_on_category[$cat_id] = $rank;
2285
2286    if ($rank == 'auto')
2287    {
2288      $search_current_ranks = true;
2289    }
2290  }
2291
2292  $cat_ids = array_unique($cat_ids);
2293
2294  if (count($cat_ids) == 0)
2295  {
2296    new PwgError(
2297      500,
2298      '[ws_add_image_category_relations] there is no category defined in "'.$categories_string.'"'
2299      );
2300    exit();
2301  }
2302
2303  $query = '
2304SELECT
2305    id
2306  FROM '.CATEGORIES_TABLE.'
2307  WHERE id IN ('.implode(',', $cat_ids).')
2308;';
2309  $db_cat_ids = array_from_query($query, 'id');
2310
2311  $unknown_cat_ids = array_diff($cat_ids, $db_cat_ids);
2312  if (count($unknown_cat_ids) != 0)
2313  {
2314    new PwgError(
2315      500,
2316      '[ws_add_image_category_relations] the following categories are unknown: '.implode(', ', $unknown_cat_ids)
2317      );
2318    exit();
2319  }
2320
2321  $to_update_cat_ids = array();
2322
2323  // in case of replace mode, we first check the existing associations
2324  $query = '
2325SELECT
2326    category_id
2327  FROM '.IMAGE_CATEGORY_TABLE.'
2328  WHERE image_id = '.$image_id.'
2329;';
2330  $existing_cat_ids = array_from_query($query, 'category_id');
2331
2332  if ($replace_mode)
2333  {
2334    $to_remove_cat_ids = array_diff($existing_cat_ids, $cat_ids);
2335    if (count($to_remove_cat_ids) > 0)
2336    {
2337      $query = '
2338DELETE
2339  FROM '.IMAGE_CATEGORY_TABLE.'
2340  WHERE image_id = '.$image_id.'
2341    AND category_id IN ('.implode(', ', $to_remove_cat_ids).')
2342;';
2343      pwg_query($query);
2344      update_category($to_remove_cat_ids);
2345    }
2346  }
2347
2348  $new_cat_ids = array_diff($cat_ids, $existing_cat_ids);
2349  if (count($new_cat_ids) == 0)
2350  {
2351    return true;
2352  }
2353
2354  if ($search_current_ranks)
2355  {
2356    $query = '
2357SELECT
2358    category_id,
2359    MAX(rank) AS max_rank
2360  FROM '.IMAGE_CATEGORY_TABLE.'
2361  WHERE rank IS NOT NULL
2362    AND category_id IN ('.implode(',', $new_cat_ids).')
2363  GROUP BY category_id
2364;';
2365    $current_rank_of = simple_hash_from_query(
2366      $query,
2367      'category_id',
2368      'max_rank'
2369      );
2370
2371    foreach ($new_cat_ids as $cat_id)
2372    {
2373      if (!isset($current_rank_of[$cat_id]))
2374      {
2375        $current_rank_of[$cat_id] = 0;
2376      }
2377
2378      if ('auto' == $rank_on_category[$cat_id])
2379      {
2380        $rank_on_category[$cat_id] = $current_rank_of[$cat_id] + 1;
2381      }
2382    }
2383  }
2384
2385  $inserts = array();
2386
2387  foreach ($new_cat_ids as $cat_id)
2388  {
2389    array_push(
2390      $inserts,
2391      array(
2392        'image_id' => $image_id,
2393        'category_id' => $cat_id,
2394        'rank' => $rank_on_category[$cat_id],
2395        )
2396      );
2397  }
2398
2399  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2400  mass_inserts(
2401    IMAGE_CATEGORY_TABLE,
2402    array_keys($inserts[0]),
2403    $inserts
2404    );
2405
2406  update_category($new_cat_ids);
2407}
2408
2409function ws_categories_setInfo($params, &$service)
2410{
2411  global $conf;
2412  if (!is_admin())
2413  {
2414    return new PwgError(401, 'Access denied');
2415  }
2416
2417  if (!$service->isPost())
2418  {
2419    return new PwgError(405, "This method requires HTTP POST");
2420  }
2421
2422  // category_id
2423  // name
2424  // comment
2425
2426  $params['category_id'] = (int)$params['category_id'];
2427  if ($params['category_id'] <= 0)
2428  {
2429    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
2430  }
2431
2432  // database registration
2433  $update = array(
2434    'id' => $params['category_id'],
2435    );
2436
2437  $info_columns = array(
2438    'name',
2439    'comment',
2440    );
2441
2442  $perform_update = false;
2443  foreach ($info_columns as $key)
2444  {
2445    if (isset($params[$key]))
2446    {
2447      $perform_update = true;
2448      $update[$key] = $params[$key];
2449    }
2450  }
2451
2452  if ($perform_update)
2453  {
2454    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2455    mass_updates(
2456      CATEGORIES_TABLE,
2457      array(
2458        'primary' => array('id'),
2459        'update'  => array_diff(array_keys($update), array('id'))
2460        ),
2461      array($update)
2462      );
2463  }
2464
2465}
2466
2467function ws_categories_delete($params, &$service)
2468{
2469  global $conf;
2470  if (!is_admin())
2471  {
2472    return new PwgError(401, 'Access denied');
2473  }
2474
2475  if (!$service->isPost())
2476  {
2477    return new PwgError(405, "This method requires HTTP POST");
2478  }
2479
2480  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2481  {
2482    return new PwgError(403, 'Invalid security token');
2483  }
2484
2485  $modes = array('no_delete', 'delete_orphans', 'force_delete');
2486  if (!in_array($params['photo_deletion_mode'], $modes))
2487  {
2488    return new PwgError(
2489      500,
2490      '[ws_categories_delete]'
2491      .' invalid parameter photo_deletion_mode "'.$params['photo_deletion_mode'].'"'
2492      .', possible values are {'.implode(', ', $modes).'}.'
2493      );
2494  }
2495
2496  $params['category_id'] = preg_split(
2497    '/[\s,;\|]/',
2498    $params['category_id'],
2499    -1,
2500    PREG_SPLIT_NO_EMPTY
2501    );
2502  $params['category_id'] = array_map('intval', $params['category_id']);
2503
2504  $category_ids = array();
2505  foreach ($params['category_id'] as $category_id)
2506  {
2507    if ($category_id > 0)
2508    {
2509      array_push($category_ids, $category_id);
2510    }
2511  }
2512
2513  if (count($category_ids) == 0)
2514  {
2515    return;
2516  }
2517
2518  $query = '
2519SELECT id
2520  FROM '.CATEGORIES_TABLE.'
2521  WHERE id IN ('.implode(',', $category_ids).')
2522;';
2523  $category_ids = array_from_query($query, 'id');
2524
2525  if (count($category_ids) == 0)
2526  {
2527    return;
2528  }
2529 
2530  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2531  delete_categories($category_ids, $params['photo_deletion_mode']);
2532  update_global_rank();
2533}
2534
2535function ws_categories_move($params, &$service)
2536{
2537  global $conf, $page;
2538 
2539  if (!is_admin())
2540  {
2541    return new PwgError(401, 'Access denied');
2542  }
2543
2544  if (!$service->isPost())
2545  {
2546    return new PwgError(405, "This method requires HTTP POST");
2547  }
2548
2549  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2550  {
2551    return new PwgError(403, 'Invalid security token');
2552  }
2553
2554  $params['category_id'] = preg_split(
2555    '/[\s,;\|]/',
2556    $params['category_id'],
2557    -1,
2558    PREG_SPLIT_NO_EMPTY
2559    );
2560  $params['category_id'] = array_map('intval', $params['category_id']);
2561
2562  $category_ids = array();
2563  foreach ($params['category_id'] as $category_id)
2564  {
2565    if ($category_id > 0)
2566    {
2567      array_push($category_ids, $category_id);
2568    }
2569  }
2570
2571  if (count($category_ids) == 0)
2572  {
2573    return new PwgError(403, 'Invalid category_id input parameter, no category to move');
2574  }
2575
2576  // we can't move physical categories
2577  $categories_in_db = array();
2578 
2579  $query = '
2580SELECT
2581    id,
2582    name,
2583    dir
2584  FROM '.CATEGORIES_TABLE.'
2585  WHERE id IN ('.implode(',', $category_ids).')
2586;';
2587  $result = pwg_query($query);
2588  while ($row = pwg_db_fetch_assoc($result))
2589  {
2590    $categories_in_db[$row['id']] = $row;
2591    // we break on error at first physical category detected
2592    if (!empty($row['dir']))
2593    {
2594      $row['name'] = strip_tags(
2595        trigger_event(
2596          'render_category_name',
2597          $row['name'],
2598          'ws_categories_move'
2599          )
2600        );
2601     
2602      return new PwgError(
2603        403,
2604        sprintf(
2605          'Category %s (%u) is not a virtual category, you cannot move it',
2606          $row['name'],
2607          $row['id']
2608          )
2609        );
2610    }
2611  }
2612
2613  if (count($categories_in_db) != count($category_ids))
2614  {
2615    $unknown_category_ids = array_diff($category_ids, array_keys($categories_in_db));
2616   
2617    return new PwgError(
2618      403,
2619      sprintf(
2620        'Category %u does not exist',
2621        $unknown_category_ids[0]
2622        )
2623      );
2624  }
2625
2626  // does this parent exists? This check should be made in the
2627  // move_categories function, not here
2628  //
2629  // 0 as parent means "move categories at gallery root"
2630  if (!is_numeric($params['parent']))
2631  {
2632    return new PwgError(403, 'Invalid parent input parameter');
2633  }
2634 
2635  if (0 != $params['parent']) {
2636    $params['parent'] = intval($params['parent']);
2637    $subcat_ids = get_subcat_ids(array($params['parent']));
2638    if (count($subcat_ids) == 0)
2639    {
2640      return new PwgError(403, 'Unknown parent category id');
2641    }
2642  }
2643
2644  $page['infos'] = array();
2645  $page['errors'] = array();
2646  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2647  move_categories($category_ids, $params['parent']);
2648  invalidate_user_cache();
2649
2650  if (count($page['errors']) != 0)
2651  {
2652    return new PwgError(403, implode('; ', $page['errors']));
2653  }
2654}
2655
2656function ws_logfile($string)
2657{
2658  global $conf;
2659
2660  if (!$conf['ws_enable_log']) {
2661    return true;
2662  }
2663
2664  file_put_contents(
2665    $conf['ws_log_filepath'],
2666    '['.date('c').'] '.$string."\n",
2667    FILE_APPEND
2668    );
2669}
2670
2671function ws_images_checkUpload($params, &$service)
2672{
2673  global $conf;
2674
2675  if (!is_admin())
2676  {
2677    return new PwgError(401, 'Access denied');
2678  }
2679
2680  include_once(PHPWG_ROOT_PATH.'admin/include/functions_upload.inc.php');
2681  $ret['message'] = ready_for_upload_message();
2682  $ret['ready_for_upload'] = true;
2683 
2684  if (!empty($ret['message']))
2685  {
2686    $ret['ready_for_upload'] = false;
2687  }
2688 
2689  return $ret;
2690}
2691
2692function ws_plugins_getList($params, &$service)
2693{
2694  global $conf;
2695 
2696  if (!is_admin())
2697  {
2698    return new PwgError(401, 'Access denied');
2699  }
2700
2701  include_once(PHPWG_ROOT_PATH.'admin/include/plugins.class.php');
2702  $plugins = new plugins();
2703  $plugins->sort_fs_plugins('name');
2704  $plugin_list = array();
2705
2706  foreach($plugins->fs_plugins as $plugin_id => $fs_plugin)
2707  {
2708    if (isset($plugins->db_plugins_by_id[$plugin_id]))
2709    {
2710      $state = $plugins->db_plugins_by_id[$plugin_id]['state'];
2711    }
2712    else
2713    {
2714      $state = 'uninstalled';
2715    }
2716
2717    array_push(
2718      $plugin_list,
2719      array(
2720        'id' => $plugin_id,
2721        'name' => $fs_plugin['name'],
2722        'version' => $fs_plugin['version'],
2723        'state' => $state,
2724        'description' => $fs_plugin['description'],
2725        )
2726      );
2727  }
2728
2729  return $plugin_list;
2730}
2731
2732function ws_plugins_performAction($params, &$service)
2733{
2734  global $template;
2735 
2736  if (!is_admin())
2737  {
2738    return new PwgError(401, 'Access denied');
2739  }
2740
2741  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2742  {
2743    return new PwgError(403, 'Invalid security token');
2744  }
2745
2746  define('IN_ADMIN', true);
2747  include_once(PHPWG_ROOT_PATH.'admin/include/plugins.class.php');
2748  $plugins = new plugins();
2749  $errors = $plugins->perform_action($params['action'], $params['plugin']);
2750
2751 
2752  if (!empty($errors))
2753  {
2754    return new PwgError(500, $errors);
2755  }
2756  else
2757  {
2758    if (in_array($params['action'], array('activate', 'deactivate')))
2759    {
2760      $template->delete_compiled_templates();
2761    }
2762    return true;
2763  }
2764}
2765
2766function ws_themes_performAction($params, &$service)
2767{
2768  global $template;
2769 
2770  if (!is_admin())
2771  {
2772    return new PwgError(401, 'Access denied');
2773  }
2774
2775  if (empty($params['pwg_token']) or get_pwg_token() != $params['pwg_token'])
2776  {
2777    return new PwgError(403, 'Invalid security token');
2778  }
2779
2780  define('IN_ADMIN', true);
2781  include_once(PHPWG_ROOT_PATH.'admin/include/themes.class.php');
2782  $themes = new themes();
2783  $errors = $themes->perform_action($params['action'], $params['theme']);
2784 
2785  if (!empty($errors))
2786  {
2787    return new PwgError(500, $errors);
2788  }
2789  else
2790  {
2791    if (in_array($params['action'], array('activate', 'deactivate')))
2792    {
2793      $template->delete_compiled_templates();
2794    }
2795    return true;
2796  }
2797}
2798?>
Note: See TracBrowser for help on using the repository browser.