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

Revision 10022, 63.3 KB checked in by mistic100, 9 years ago (diff)

merge r10017 from trunk to 2.2 (bug:1023)

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