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

Last change on this file since 4513 was 4513, checked in by rvelices, 14 years ago

merge -r4512 from branch 2.0 to trunk
web method images.setPrivacyLevel (ws_images_setPrivacyLevel) is POST only

  • Property svn:eol-style set to LF
File size: 48.3 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based picture gallery                                  |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2009 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_posted']) )
72  {
73    $clauses[] = $tbl_name."date_available>='".$params['f_min_date_posted']."'";
74  }
75  if ( isset($params['f_max_date_posted']) )
76  {
77    $clauses[] = $tbl_name."date_available<'".$params['f_max_date_posted']."'";
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'])
179    return PHPWG_VERSION;
180  else
181    return new PwgError(403, 'Forbidden');
182}
183
184function ws_caddie_add($params, &$service)
185{
186  if (!is_admin())
187  {
188    return new PwgError(401, 'Access denied');
189  }
190  $params['image_id'] = array_map( 'intval',$params['image_id'] );
191  if ( empty($params['image_id']) )
192  {
193    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
194  }
195  global $user;
196  $query = '
197SELECT id
198  FROM '.IMAGES_TABLE.' LEFT JOIN '.CADDIE_TABLE.' ON id=element_id AND user_id='.$user['id'].'
199  WHERE id IN ('.implode(',',$params['image_id']).')
200    AND element_id IS NULL';
201  $datas = array();
202  foreach ( array_from_query($query, 'id') as $id )
203  {
204    array_push($datas, array('element_id'=>$id, 'user_id'=>$user['id']) );
205  }
206  if (count($datas))
207  {
208    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
209    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
210  }
211  return count($datas);
212}
213
214/**
215 * returns images per category (web service method)
216 */
217function ws_categories_getImages($params, &$service)
218{
219  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
220  global $user, $conf;
221
222  $images = array();
223
224  //------------------------------------------------- get the related categories
225  $where_clauses = array();
226  foreach($params['cat_id'] as $cat_id)
227  {
228    $cat_id = (int)$cat_id;
229    if ($cat_id<=0)
230      continue;
231    if ($params['recursive'])
232    {
233      $where_clauses[] = 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.$cat_id.'(,|$)\'';
234    }
235    else
236    {
237      $where_clauses[] = 'id='.$cat_id;
238    }
239  }
240  if (!empty($where_clauses))
241  {
242    $where_clauses = array( '('.
243    implode('
244    OR ', $where_clauses) . ')'
245      );
246  }
247  $where_clauses[] = get_sql_condition_FandF(
248        array('forbidden_categories' => 'id'),
249        NULL, true
250      );
251
252  $query = '
253SELECT id, name, permalink, image_order
254  FROM '.CATEGORIES_TABLE.'
255  WHERE '. implode('
256    AND ', $where_clauses);
257  $result = pwg_query($query);
258  $cats = array();
259  while ($row = pwg_db_fetch_assoc($result))
260  {
261    $row['id'] = (int)$row['id'];
262    $cats[ $row['id'] ] = $row;
263  }
264
265  //-------------------------------------------------------- get the images
266  if ( !empty($cats) )
267  {
268    $where_clauses = ws_std_image_sql_filter( $params, 'i.' );
269    $where_clauses[] = 'category_id IN ('
270      .implode(',', array_keys($cats) )
271      .')';
272    $where_clauses[] = get_sql_condition_FandF( array(
273          'visible_images' => 'i.id'
274        ), null, true
275      );
276
277    $order_by = ws_std_image_sql_order($params, 'i.');
278    if ( empty($order_by)
279          and count($params['cat_id'])==1
280          and isset($cats[ $params['cat_id'][0] ]['image_order'])
281        )
282    {
283      $order_by = $cats[ $params['cat_id'][0] ]['image_order'];
284    }
285    $order_by = empty($order_by) ? $conf['order_by'] : 'ORDER BY '.$order_by;
286
287    $query = '
288SELECT i.*, GROUP_CONCAT(category_id) cat_ids
289  FROM '.IMAGES_TABLE.' i
290    INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON i.id=image_id
291  WHERE '. implode('
292    AND ', $where_clauses).'
293GROUP BY i.id
294'.$order_by.'
295LIMIT '.(int)$params['per_page'].' OFFSET '.(int)($params['per_page']*$params['page']);
296
297    $result = pwg_query($query);
298    while ($row = pwg_db_fetch_assoc($result))
299    {
300      $image = array();
301      foreach ( array('id', 'width', 'height', 'hit') as $k )
302      {
303        if (isset($row[$k]))
304        {
305          $image[$k] = (int)$row[$k];
306        }
307      }
308      foreach ( array('file', 'name', 'comment') as $k )
309      {
310        $image[$k] = $row[$k];
311      }
312      $image = array_merge( $image, ws_std_get_urls($row) );
313
314      $image_cats = array();
315      foreach ( explode(',', $row['cat_ids']) as $cat_id )
316      {
317        $url = make_index_url(
318                array(
319                  'category' => $cats[$cat_id],
320                  )
321                );
322        $page_url = make_picture_url(
323                array(
324                  'category' => $cats[$cat_id],
325                  'image_id' => $row['id'],
326                  'image_file' => $row['file'],
327                  )
328                );
329        array_push( $image_cats,  array(
330              WS_XML_ATTRIBUTES => array (
331                  'id' => (int)$cat_id,
332                  'url' => $url,
333                  'page_url' => $page_url,
334                )
335            )
336          );
337      }
338
339      $image['categories'] = new PwgNamedArray(
340            $image_cats,'category', array('id','url','page_url')
341          );
342      array_push($images, $image);
343    }
344  }
345
346  return array( 'images' =>
347    array (
348      WS_XML_ATTRIBUTES =>
349        array(
350            'page' => $params['page'],
351            'per_page' => $params['per_page'],
352            'count' => count($images)
353          ),
354       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
355          ws_std_get_image_xml_attributes() )
356      )
357    );
358}
359
360
361/**
362 * returns a list of categories (web service method)
363 */
364function ws_categories_getList($params, &$service)
365{
366  global $user,$conf;
367
368  $where = array();
369
370  if (!$params['recursive'])
371  {
372    if ($params['cat_id']>0)
373      $where[] = '(id_uppercat='.(int)($params['cat_id']).'
374    OR id='.(int)($params['cat_id']).')';
375    else
376      $where[] = 'id_uppercat IS NULL';
377  }
378  else if ($params['cat_id']>0)
379  {
380    $where[] = 'uppercats '.DB_REGEX_OPERATOR.' \'(^|,)'.
381      (int)($params['cat_id'])
382      .'(,|$)\'';
383  }
384
385  if ($params['public'])
386  {
387    $where[] = 'status = "public"';
388    $where[] = 'visible = "true"';
389    $where[]= 'user_id='.$conf['guest_id'];
390  }
391  else
392  {
393    $where[]= 'user_id='.$user['id'];
394  }
395
396  $query = '
397SELECT id, name, permalink, uppercats, global_rank,
398    nb_images, count_images AS total_nb_images,
399    date_last, max_date_last, count_categories AS nb_categories
400  FROM '.CATEGORIES_TABLE.'
401   INNER JOIN '.USER_CACHE_CATEGORIES_TABLE.' ON id=cat_id
402  WHERE '. implode('
403    AND ', $where);
404
405  $result = pwg_query($query);
406
407  $cats = array();
408  while ($row = pwg_db_fetch_assoc($result))
409  {
410    $row['url'] = make_index_url(
411        array(
412          'category' => $row
413          )
414      );
415    foreach( array('id','nb_images','total_nb_images','nb_categories') as $key)
416    {
417      $row[$key] = (int)$row[$key];
418    }
419
420    array_push($cats, $row);
421  }
422  usort($cats, 'global_rank_compare');
423  return array(
424    'categories' => new PwgNamedArray(
425      $cats,
426      'category',
427      array(
428        'id',
429        'url',
430        'nb_images',
431        'total_nb_images',
432        'nb_categories',
433        'date_last',
434        'max_date_last',
435        )
436      )
437    );
438}
439
440/**
441 * returns the list of categories as you can see them in administration (web
442 * service method).
443 *
444 * Only admin can run this method and permissions are not taken into
445 * account.
446 */
447function ws_categories_getAdminList($params, &$service)
448{
449  if (!is_admin())
450  {
451    return new PwgError(401, 'Access denied');
452  }
453
454  $query = '
455SELECT
456    category_id,
457    COUNT(*) AS counter
458  FROM '.IMAGE_CATEGORY_TABLE.'
459  GROUP BY category_id
460;';
461  $nb_images_of = simple_hash_from_query($query, 'category_id', 'counter');
462
463  $query = '
464SELECT
465    id,
466    name,
467    uppercats,
468    global_rank
469  FROM '.CATEGORIES_TABLE.'
470;';
471  $result = pwg_query($query);
472  $cats = array();
473
474  while ($row = pwg_db_fetch_assoc($result))
475  {
476    $id = $row['id'];
477    $row['nb_images'] = isset($nb_images_of[$id]) ? $nb_images_of[$id] : 0;
478    array_push($cats, $row);
479  }
480
481  usort($cats, 'global_rank_compare');
482  return array(
483    'categories' => new PwgNamedArray(
484      $cats,
485      'category',
486      array(
487        'id',
488        'nb_images',
489        'name',
490        'uppercats',
491        'global_rank',
492        )
493      )
494    );
495}
496
497/**
498 * returns detailed information for an element (web service method)
499 */
500function ws_images_addComment($params, &$service)
501{
502  if (!$service->isPost())
503  {
504    return new PwgError(405, "This method requires HTTP POST");
505  }
506  $params['image_id'] = (int)$params['image_id'];
507  $query = '
508SELECT DISTINCT image_id
509  FROM '.IMAGE_CATEGORY_TABLE.' INNER JOIN '.CATEGORIES_TABLE.' ON category_id=id
510  WHERE commentable="true"
511    AND image_id='.$params['image_id'].
512    get_sql_condition_FandF(
513      array(
514        'forbidden_categories' => 'id',
515        'visible_categories' => 'id',
516        'visible_images' => 'image_id'
517      ),
518      ' AND'
519    );
520  if ( !pwg_db_num_rows( pwg_query( $query ) ) )
521  {
522    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
523  }
524
525  $comm = array(
526    'author' => trim( stripslashes($params['author']) ),
527    'content' => trim( stripslashes($params['content']) ),
528    'image_id' => $params['image_id'],
529   );
530
531  include_once(PHPWG_ROOT_PATH.'include/functions_comment.inc.php');
532
533  $comment_action = insert_user_comment(
534      $comm, $params['key'], $infos
535    );
536
537  switch ($comment_action)
538  {
539    case 'reject':
540      array_push($infos, l10n('comment_not_added') );
541      return new PwgError(403, implode("\n", $infos) );
542    case 'validate':
543    case 'moderate':
544      $ret = array(
545          'id' => $comm['id'],
546          'validation' => $comment_action=='validate',
547        );
548      return new PwgNamedStruct(
549          'comment',
550          $ret,
551          null, array()
552        );
553    default:
554      return new PwgError(500, "Unknown comment action ".$comment_action );
555  }
556}
557
558/**
559 * returns detailed information for an element (web service method)
560 */
561function ws_images_getInfo($params, &$service)
562{
563  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
564  global $user, $conf;
565  $params['image_id'] = (int)$params['image_id'];
566  if ( $params['image_id']<=0 )
567  {
568    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
569  }
570
571  $query='
572SELECT * FROM '.IMAGES_TABLE.'
573  WHERE id='.$params['image_id'].
574    get_sql_condition_FandF(
575      array('visible_images' => 'id'),
576      ' AND'
577    ).'
578LIMIT 1';
579
580  $image_row = pwg_db_fetch_assoc(pwg_query($query));
581  if ($image_row==null)
582  {
583    return new PwgError(404, "image_id not found");
584  }
585  $image_row = array_merge( $image_row, ws_std_get_urls($image_row) );
586
587  //-------------------------------------------------------- related categories
588  $query = '
589SELECT id, name, permalink, uppercats, global_rank, commentable
590  FROM '.IMAGE_CATEGORY_TABLE.'
591    INNER JOIN '.CATEGORIES_TABLE.' ON category_id = id
592  WHERE image_id = '.$image_row['id'].
593  get_sql_condition_FandF(
594      array( 'forbidden_categories' => 'category_id' ),
595      ' AND'
596    ).'
597;';
598  $result = pwg_query($query);
599  $is_commentable = false;
600  $related_categories = array();
601  while ($row = pwg_db_fetch_assoc($result))
602  {
603    if ($row['commentable']=='true')
604    {
605      $is_commentable = true;
606    }
607    unset($row['commentable']);
608    $row['url'] = make_index_url(
609        array(
610          'category' => $row
611          )
612      );
613
614    $row['page_url'] = make_picture_url(
615        array(
616          'image_id' => $image_row['id'],
617          'image_file' => $image_row['file'],
618          'category' => $row
619          )
620      );
621    $row['id']=(int)$row['id'];
622    array_push($related_categories, $row);
623  }
624  usort($related_categories, 'global_rank_compare');
625  if ( empty($related_categories) )
626  {
627    return new PwgError(401, 'Access denied');
628  }
629
630  //-------------------------------------------------------------- related tags
631  $related_tags = get_common_tags( array($image_row['id']), -1 );
632  foreach( $related_tags as $i=>$tag)
633  {
634    $tag['url'] = make_index_url(
635        array(
636          'tags' => array($tag)
637          )
638      );
639    $tag['page_url'] = make_picture_url(
640        array(
641          'image_id' => $image_row['id'],
642          'image_file' => $image_row['file'],
643          'tags' => array($tag),
644          )
645      );
646    unset($tag['counter']);
647    $tag['id']=(int)$tag['id'];
648    $related_tags[$i]=$tag;
649  }
650  //------------------------------------------------------------- related rates
651  $query = '
652SELECT COUNT(rate) AS count
653     , ROUND(AVG(rate),2) AS average
654     , ROUND(STD(rate),2) AS stdev
655  FROM '.RATE_TABLE.'
656  WHERE element_id = '.$image_row['id'].'
657;';
658  $rating = pwg_db_fetch_assoc(pwg_query($query));
659  $rating['count'] = (int)$rating['count'];
660
661  //---------------------------------------------------------- related comments
662  $related_comments = array();
663
664  $where_comments = 'image_id = '.$image_row['id'];
665  if ( !is_admin() )
666  {
667    $where_comments .= '
668    AND validated="true"';
669  }
670
671  $query = '
672SELECT COUNT(id) nb_comments
673  FROM '.COMMENTS_TABLE.'
674  WHERE '.$where_comments;
675  list($nb_comments) = array_from_query($query, 'nb_comments');
676  $nb_comments = (int)$nb_comments;
677
678  if ( $nb_comments>0 and $params['comments_per_page']>0 )
679  {
680    $query = '
681SELECT id, date, author, content
682  FROM '.COMMENTS_TABLE.'
683  WHERE '.$where_comments.'
684  ORDER BY date
685  LIMIT '.(int)$params['comments_per_page'].
686    ' OFFSET '.(int)($params['comments_per_page']*$params['comments_page']);
687
688    $result = pwg_query($query);
689    while ($row = pwg_db_fetch_assoc($result))
690    {
691      $row['id']=(int)$row['id'];
692      array_push($related_comments, $row);
693    }
694  }
695
696  $comment_post_data = null;
697  if ($is_commentable and
698      (!is_a_guest()
699        or (is_a_guest() and $conf['comments_forall'] )
700      )
701      )
702  {
703    $comment_post_data['author'] = stripslashes($user['username']);
704    $comment_post_data['key'] = get_comment_post_key($params['image_id']);
705  }
706
707  $ret = $image_row;
708  foreach ( array('id','width','height','hit','filesize') as $k )
709  {
710    if (isset($ret[$k]))
711    {
712      $ret[$k] = (int)$ret[$k];
713    }
714  }
715  foreach ( array('path', 'storage_category_id') as $k )
716  {
717    unset($ret[$k]);
718  }
719
720  $ret['rates'] = array( WS_XML_ATTRIBUTES => $rating );
721  $ret['categories'] = new PwgNamedArray($related_categories, 'category', array('id','url', 'page_url') );
722  $ret['tags'] = new PwgNamedArray($related_tags, 'tag', array('id','url_name','url','name','page_url') );
723  if ( isset($comment_post_data) )
724  {
725    $ret['comment_post'] = array( WS_XML_ATTRIBUTES => $comment_post_data );
726  }
727  $ret['comments'] = array(
728     WS_XML_ATTRIBUTES =>
729        array(
730          'page' => $params['comments_page'],
731          'per_page' => $params['comments_per_page'],
732          'count' => count($related_comments),
733          'nb_comments' => $nb_comments,
734        ),
735     WS_XML_CONTENT => new PwgNamedArray($related_comments, 'comment', array('id','date') )
736      );
737
738  return new PwgNamedStruct('image',$ret, null, array('name','comment') );
739}
740
741
742/**
743 * rates the image_id in the parameter
744 */
745function ws_images_Rate($params, &$service)
746{
747  $image_id = (int)$params['image_id'];
748  $query = '
749SELECT DISTINCT id FROM '.IMAGES_TABLE.'
750  INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON id=image_id
751  WHERE id='.$image_id
752  .get_sql_condition_FandF(
753    array(
754        'forbidden_categories' => 'category_id',
755        'forbidden_images' => 'id',
756      ),
757    '    AND'
758    ).'
759    LIMIT 1';
760  if ( pwg_db_num_rows( pwg_query($query) )==0 )
761  {
762    return new PwgError(404, "Invalid image_id or access denied" );
763  }
764  $rate = (int)$params['rate'];
765  include_once(PHPWG_ROOT_PATH.'include/functions_rate.inc.php');
766  $res = rate_picture( $image_id, $rate );
767  if ($res==false)
768  {
769    global $conf;
770    return new PwgError( 403, "Forbidden or rate not in ". implode(',',$conf['rate_items']));
771  }
772  return $res;
773}
774
775
776/**
777 * returns a list of elements corresponding to a query search
778 */
779function ws_images_search($params, &$service)
780{
781  global $page;
782  $images = array();
783  include_once( PHPWG_ROOT_PATH .'include/functions_search.inc.php' );
784  include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
785
786  $where_clauses = ws_std_image_sql_filter( $params, 'i.' );
787  $order_by = ws_std_image_sql_order($params, 'i.');
788
789  $super_order_by = false;
790  if ( !empty($order_by) )
791  {
792    global $conf;
793    $conf['order_by'] = 'ORDER BY '.$order_by;
794    $super_order_by=true; // quick_search_result might be faster
795  }
796
797  $search_result = get_quick_search_results($params['query'],
798      $super_order_by,
799      implode(',', $where_clauses)
800    );
801
802  $image_ids = array_slice(
803      $search_result['items'],
804      $params['page']*$params['per_page'],
805      $params['per_page']
806    );
807
808  if ( count($image_ids) )
809  {
810    $query = '
811SELECT * FROM '.IMAGES_TABLE.'
812  WHERE id IN ('.implode(',', $image_ids).')';
813
814    $image_ids = array_flip($image_ids);
815    $result = pwg_query($query);
816    while ($row = pwg_db_fetch_assoc($result))
817    {
818      $image = array();
819      foreach ( array('id', 'width', 'height', 'hit') as $k )
820      {
821        if (isset($row[$k]))
822        {
823          $image[$k] = (int)$row[$k];
824        }
825      }
826      foreach ( array('file', 'name', 'comment') as $k )
827      {
828        $image[$k] = $row[$k];
829      }
830      $image = array_merge( $image, ws_std_get_urls($row) );
831      $images[$image_ids[$image['id']]] = $image;
832    }
833    ksort($images, SORT_NUMERIC);
834    $images = array_values($images);
835  }
836
837
838  return array( 'images' =>
839    array (
840      WS_XML_ATTRIBUTES =>
841        array(
842            'page' => $params['page'],
843            'per_page' => $params['per_page'],
844            'count' => count($images)
845          ),
846       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
847          ws_std_get_image_xml_attributes() )
848      )
849    );
850}
851
852function ws_images_setPrivacyLevel($params, &$service)
853{
854  if (!is_admin() || is_adviser() )
855  {
856    return new PwgError(401, 'Access denied');
857  }
858  if (!$service->isPost())
859  {
860    return new PwgError(405, "This method requires HTTP POST");
861  }
862  $params['image_id'] = array_map( 'intval',$params['image_id'] );
863  if ( empty($params['image_id']) )
864  {
865    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
866  }
867  global $conf;
868  if ( !in_array( (int)$params['level'], $conf['available_permission_levels']) )
869  {
870    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid level");
871  }
872
873  $query = '
874UPDATE '.IMAGES_TABLE.'
875  SET level='.(int)$params['level'].'
876  WHERE id IN ('.implode(',',$params['image_id']).')';
877  $result = pwg_query($query);
878  $affected_rows = pwg_db_affected_rows();
879  if ($affected_rows)
880  {
881    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
882    invalidate_user_cache();
883  }
884  return $affected_rows;
885}
886
887function ws_images_add_chunk($params, &$service)
888{
889  // data
890  // original_sum
891  // type {thumb, file, high}
892  // position
893
894  if (!is_admin() || is_adviser() )
895  {
896    return new PwgError(401, 'Access denied');
897  }
898
899  if (!$service->isPost())
900  {
901    return new PwgError(405, "This method requires HTTP POST");
902  }
903
904  $upload_dir = PHPWG_ROOT_PATH.'upload/buffer';
905
906  // create the upload directory tree if not exists
907  if (!is_dir($upload_dir)) {
908    umask(0000);
909    $recursive = true;
910    if (!@mkdir($upload_dir, 0777, $recursive))
911    {
912      return new PwgError(500, 'error during buffer directory creation');
913    }
914  }
915
916  if (!is_writable($upload_dir))
917  {
918    // last chance to make the directory writable
919    @chmod($upload_dir, 0777);
920
921    if (!is_writable($upload_dir))
922    {
923      return new PwgError(500, 'buffer directory has no write access');
924    }
925  }
926
927  secure_directory($upload_dir);
928
929  $filename = sprintf(
930    '%s-%s-%05u.block',
931    $params['original_sum'],
932    $params['type'],
933    $params['position']
934    );
935
936  ws_logfile('[ws_images_add_chunk] data length : '.strlen($params['data']));
937
938  $bytes_written = file_put_contents(
939    $upload_dir.'/'.$filename,
940    base64_decode($params['data'])
941    );
942
943  if (false === $bytes_written) {
944    return new PwgError(
945      500,
946      'an error has occured while writting chunk '.$params['position'].' for '.$params['type']
947      );
948  }
949}
950
951function merge_chunks($output_filepath, $original_sum, $type)
952{
953  ws_logfile('[merge_chunks] input parameter $output_filepath : '.$output_filepath);
954
955  if (is_file($output_filepath))
956  {
957    unlink($output_filepath);
958
959    if (is_file($output_filepath))
960    {
961      new PwgError(500, '[merge_chunks] error while trying to remove existing '.$output_filepath);
962      exit();
963    }
964  }
965
966  $upload_dir = PHPWG_ROOT_PATH.'upload/buffer';
967  $pattern = '/'.$original_sum.'-'.$type.'/';
968  $chunks = array();
969
970  if ($handle = opendir($upload_dir))
971  {
972    while (false !== ($file = readdir($handle)))
973    {
974      if (preg_match($pattern, $file))
975      {
976        ws_logfile($file);
977        array_push($chunks, $upload_dir.'/'.$file);
978      }
979    }
980    closedir($handle);
981  }
982
983  sort($chunks);
984
985  if (function_exists('memory_get_usage')) {
986    ws_logfile('[merge_chunks] memory_get_usage before loading chunks: '.memory_get_usage());
987  }
988
989  $i = 0;
990
991  foreach ($chunks as $chunk)
992  {
993    $string = file_get_contents($chunk);
994
995    if (function_exists('memory_get_usage')) {
996      ws_logfile('[merge_chunks] memory_get_usage on chunk '.++$i.': '.memory_get_usage());
997    }
998
999    if (!file_put_contents($output_filepath, $string, FILE_APPEND))
1000    {
1001      new PwgError(500, '[merge_chunks] error while writting chunks for '.$output_filepath);
1002      exit();
1003    }
1004
1005    unlink($chunk);
1006  }
1007
1008  if (function_exists('memory_get_usage')) {
1009    ws_logfile('[merge_chunks] memory_get_usage after loading chunks: '.memory_get_usage());
1010  }
1011}
1012
1013/*
1014 * The $file_path must be the path of the basic "web sized" photo
1015 * The $type value will automatically modify the $file_path to the corresponding file
1016 */
1017function add_file($file_path, $type, $original_sum, $file_sum)
1018{
1019  $file_path = file_path_for_type($file_path, $type);
1020
1021  $upload_dir = dirname($file_path);
1022
1023  if (!is_dir($upload_dir)) {
1024    umask(0000);
1025    $recursive = true;
1026    if (!@mkdir($upload_dir, 0777, $recursive))
1027    {
1028      new PwgError(500, '[add_file] error during '.$type.' directory creation');
1029      exit();
1030    }
1031  }
1032
1033  if (!is_writable($upload_dir))
1034  {
1035    // last chance to make the directory writable
1036    @chmod($upload_dir, 0777);
1037
1038    if (!is_writable($upload_dir))
1039    {
1040      new PwgError(500, '[add_file] '.$type.' directory has no write access');
1041      exit();
1042    }
1043  }
1044
1045  secure_directory($upload_dir);
1046
1047  // merge the thumbnail
1048  merge_chunks($file_path, $original_sum, $type);
1049  chmod($file_path, 0644);
1050
1051  // check dumped thumbnail md5
1052  $dumped_md5 = md5_file($file_path);
1053  if ($dumped_md5 != $file_sum) {
1054    new PwgError(500, '[add_file] '.$type.' transfer failed');
1055    exit();
1056  }
1057
1058  list($width, $height) = getimagesize($file_path);
1059  $filesize = floor(filesize($file_path)/1024);
1060
1061  return array(
1062    'width' => $width,
1063    'height' => $height,
1064    'filesize' => $filesize,
1065    );
1066}
1067
1068function ws_images_addFile($params, &$service)
1069{
1070  // image_id
1071  // type {thumb, file, high}
1072  // sum
1073
1074  global $conf;
1075  if (!is_admin() || is_adviser() )
1076  {
1077    return new PwgError(401, 'Access denied');
1078  }
1079
1080  $params['image_id'] = (int)$params['image_id'];
1081  if ($params['image_id'] <= 0)
1082  {
1083    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1084  }
1085
1086  //
1087  // what is the path?
1088  //
1089  $query = '
1090SELECT
1091    path,
1092    md5sum
1093  FROM '.IMAGES_TABLE.'
1094  WHERE id = '.$params['image_id'].'
1095;';
1096  list($file_path, $original_sum) = mysql_fetch_row(pwg_query($query));
1097
1098  // TODO only files added with web API can be updated with web API
1099
1100  //
1101  // makes sure directories are there and call the merge_chunks
1102  //
1103  $infos = add_file($file_path, $params['type'], $original_sum, $params['sum']);
1104
1105  //
1106  // update basic metadata from file
1107  //
1108  $update = array();
1109
1110  if ('high' == $params['type'])
1111  {
1112    $update['high_filesize'] = $infos['filesize'];
1113    $update['has_high'] = 'true';
1114  }
1115
1116  if ('file' == $params['type'])
1117  {
1118    $update['filesize'] = $infos['filesize'];
1119    $update['width'] = $infos['width'];
1120    $update['height'] = $infos['height'];
1121  }
1122
1123  // we may have nothing to update at database level, for example with a
1124  // thumbnail update
1125  if (count($update) > 0)
1126  {
1127    $update['id'] = $params['image_id'];
1128
1129    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1130    mass_updates(
1131      IMAGES_TABLE,
1132      array(
1133        'primary' => array('id'),
1134        'update'  => array_diff(array_keys($update), array('id'))
1135        ),
1136      array($update)
1137      );
1138  }
1139}
1140
1141function ws_images_add($params, &$service)
1142{
1143  global $conf;
1144  if (!is_admin() || is_adviser() )
1145  {
1146    return new PwgError(401, 'Access denied');
1147  }
1148
1149  foreach ($params as $param_key => $param_value) {
1150    ws_logfile(
1151      sprintf(
1152        '[pwg.images.add] input param "%s" : "%s"',
1153        $param_key,
1154        is_null($param_value) ? 'NULL' : $param_value
1155        )
1156      );
1157  }
1158
1159  // does the image already exists ?
1160  $query = '
1161SELECT
1162    COUNT(*) AS counter
1163  FROM '.IMAGES_TABLE.'
1164  WHERE md5sum = \''.$params['original_sum'].'\'
1165;';
1166  list($counter) = pwg_db_fetch_row(pwg_query($query));
1167  if ($counter != 0) {
1168    return new PwgError(500, 'file already exists');
1169  }
1170
1171  // current date
1172  list($dbnow) = pwg_db_fetch_row(pwg_query('SELECT NOW();'));
1173  list($year, $month, $day) = preg_split('/[^\d]/', $dbnow, 4);
1174
1175  // upload directory hierarchy
1176  $upload_dir = sprintf(
1177    PHPWG_ROOT_PATH.'upload/%s/%s/%s',
1178    $year,
1179    $month,
1180    $day
1181    );
1182
1183  // compute file path
1184  $date_string = preg_replace('/[^\d]/', '', $dbnow);
1185  $random_string = substr($params['file_sum'], 0, 8);
1186  $filename_wo_ext = $date_string.'-'.$random_string;
1187  $file_path = $upload_dir.'/'.$filename_wo_ext.'.jpg';
1188
1189  // add files
1190  $file_infos  = add_file($file_path, 'file',  $params['original_sum'], $params['file_sum']);
1191  $thumb_infos = add_file($file_path, 'thumb', $params['original_sum'], $params['thumbnail_sum']);
1192
1193  if (isset($params['high_sum']))
1194  {
1195    $high_infos = add_file($file_path, 'high', $params['original_sum'], $params['high_sum']);
1196  }
1197
1198  // database registration
1199  $insert = array(
1200    'file' => $filename_wo_ext.'.jpg',
1201    'date_available' => $dbnow,
1202    'tn_ext' => 'jpg',
1203    'name' => $params['name'],
1204    'path' => $file_path,
1205    'filesize' => $file_infos['filesize'],
1206    'width' => $file_infos['width'],
1207    'height' => $file_infos['height'],
1208    'md5sum' => $params['original_sum'],
1209    );
1210
1211  $info_columns = array(
1212    'name',
1213    'author',
1214    'comment',
1215    'level',
1216    'date_creation',
1217    );
1218
1219  foreach ($info_columns as $key)
1220  {
1221    if (isset($params[$key]))
1222    {
1223      $insert[$key] = $params[$key];
1224    }
1225  }
1226
1227  if (isset($params['high_sum']))
1228  {
1229    $insert['has_high'] = 'true';
1230    $insert['high_filesize'] = $high_infos['filesize'];
1231  }
1232
1233  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1234  mass_inserts(
1235    IMAGES_TABLE,
1236    array_keys($insert),
1237    array($insert)
1238    );
1239
1240  $image_id = pwg_db_insert_id();
1241
1242  // let's add links between the image and the categories
1243  if (isset($params['categories']))
1244  {
1245    ws_add_image_category_relations($image_id, $params['categories']);
1246  }
1247
1248  // and now, let's create tag associations
1249  if (isset($params['tag_ids']) and !empty($params['tag_ids']))
1250  {
1251    set_tags(
1252      explode(',', $params['tag_ids']),
1253      $image_id
1254      );
1255  }
1256
1257  invalidate_user_cache();
1258}
1259
1260/**
1261 * perform a login (web service method)
1262 */
1263function ws_session_login($params, &$service)
1264{
1265  global $conf;
1266
1267  if (!$service->isPost())
1268  {
1269    return new PwgError(405, "This method requires HTTP POST");
1270  }
1271  if (try_log_user($params['username'], $params['password'],false))
1272  {
1273    return true;
1274  }
1275  return new PwgError(999, 'Invalid username/password');
1276}
1277
1278
1279/**
1280 * performs a logout (web service method)
1281 */
1282function ws_session_logout($params, &$service)
1283{
1284  if (!is_a_guest())
1285  {
1286    logout_user();
1287  }
1288  return true;
1289}
1290
1291function ws_session_getStatus($params, &$service)
1292{
1293  global $user;
1294  $res = array();
1295  $res['username'] = is_a_guest() ? 'guest' : stripslashes($user['username']);
1296  foreach ( array('status', 'template', 'theme', 'language') as $k )
1297  {
1298    $res[$k] = $user[$k];
1299  }
1300  $res['charset'] = get_pwg_charset();
1301  return $res;
1302}
1303
1304
1305/**
1306 * returns a list of tags (web service method)
1307 */
1308function ws_tags_getList($params, &$service)
1309{
1310  $tags = get_available_tags();
1311  if ($params['sort_by_counter'])
1312  {
1313    usort($tags, create_function('$a,$b', 'return -$a["counter"]+$b["counter"];') );
1314  }
1315  else
1316  {
1317    usort($tags, 'tag_alpha_compare');
1318  }
1319  for ($i=0; $i<count($tags); $i++)
1320  {
1321    $tags[$i]['id'] = (int)$tags[$i]['id'];
1322    $tags[$i]['counter'] = (int)$tags[$i]['counter'];
1323    $tags[$i]['url'] = make_index_url(
1324        array(
1325          'section'=>'tags',
1326          'tags'=>array($tags[$i])
1327        )
1328      );
1329  }
1330  return array('tags' => new PwgNamedArray($tags, 'tag', array('id','url_name','url', 'name', 'counter' )) );
1331}
1332
1333/**
1334 * returns the list of tags as you can see them in administration (web
1335 * service method).
1336 *
1337 * Only admin can run this method and permissions are not taken into
1338 * account.
1339 */
1340function ws_tags_getAdminList($params, &$service)
1341{
1342  if (!is_admin())
1343  {
1344    return new PwgError(401, 'Access denied');
1345  }
1346
1347  $tags = get_all_tags();
1348  return array(
1349    'tags' => new PwgNamedArray(
1350      $tags,
1351      'tag',
1352      array(
1353        'name',
1354        'id',
1355        'url_name',
1356        )
1357      )
1358    );
1359}
1360
1361/**
1362 * returns a list of images for tags (web service method)
1363 */
1364function ws_tags_getImages($params, &$service)
1365{
1366  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1367  global $conf;
1368
1369  // first build all the tag_ids we are interested in
1370  $params['tag_id'] = array_map( 'intval',$params['tag_id'] );
1371  $tags = find_tags($params['tag_id'], $params['tag_url_name'], $params['tag_name']);
1372  $tags_by_id = array();
1373  foreach( $tags as $tag )
1374  {
1375    $tags['id'] = (int)$tag['id'];
1376    $tags_by_id[ $tag['id'] ] = $tag;
1377  }
1378  unset($tags);
1379  $tag_ids = array_keys($tags_by_id);
1380
1381
1382  $image_ids = array();
1383  $image_tag_map = array();
1384
1385  if ( !empty($tag_ids) )
1386  { // build list of image ids with associated tags per image
1387    if ($params['tag_mode_and'])
1388    {
1389      $image_ids = get_image_ids_for_tags( $tag_ids );
1390    }
1391    else
1392    {
1393      $query = '
1394SELECT image_id, GROUP_CONCAT(tag_id) tag_ids
1395  FROM '.IMAGE_TAG_TABLE.'
1396  WHERE tag_id IN ('.implode(',',$tag_ids).')
1397  GROUP BY image_id';
1398      $result = pwg_query($query);
1399      while ( $row=pwg_db_fetch_assoc($result) )
1400      {
1401        $row['image_id'] = (int)$row['image_id'];
1402        array_push( $image_ids, $row['image_id'] );
1403        $image_tag_map[ $row['image_id'] ] = explode(',', $row['tag_ids']);
1404      }
1405    }
1406  }
1407
1408  $images = array();
1409  if ( !empty($image_ids))
1410  {
1411    $where_clauses = ws_std_image_sql_filter($params);
1412    $where_clauses[] = get_sql_condition_FandF(
1413        array
1414          (
1415            'forbidden_categories' => 'category_id',
1416            'visible_categories' => 'category_id',
1417            'visible_images' => 'i.id'
1418          ),
1419        '', true
1420      );
1421    $where_clauses[] = 'id IN ('.implode(',',$image_ids).')';
1422
1423    $order_by = ws_std_image_sql_order($params);
1424    if (empty($order_by))
1425    {
1426      $order_by = $conf['order_by'];
1427    }
1428    else
1429    {
1430      $order_by = 'ORDER BY '.$order_by;
1431    }
1432
1433    $query = '
1434SELECT DISTINCT i.* FROM '.IMAGES_TABLE.' i
1435  INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON i.id=image_id
1436  WHERE '. implode('
1437    AND ', $where_clauses).'
1438'.$order_by.'
1439LIMIT '.(int)$params['per_page'].' OFFSET '.(int)($params['per_page']*$params['page']);
1440
1441    $result = pwg_query($query);
1442    while ($row = pwg_db_fetch_assoc($result))
1443    {
1444      $image = array();
1445      foreach ( array('id', 'width', 'height', 'hit') as $k )
1446      {
1447        if (isset($row[$k]))
1448        {
1449          $image[$k] = (int)$row[$k];
1450        }
1451      }
1452      foreach ( array('file', 'name', 'comment') as $k )
1453      {
1454        $image[$k] = $row[$k];
1455      }
1456      $image = array_merge( $image, ws_std_get_urls($row) );
1457
1458      $image_tag_ids = ($params['tag_mode_and']) ? $tag_ids : $image_tag_map[$image['id']];
1459      $image_tags = array();
1460      foreach ($image_tag_ids as $tag_id)
1461      {
1462        $url = make_index_url(
1463                 array(
1464                  'section'=>'tags',
1465                  'tags'=> array($tags_by_id[$tag_id])
1466                )
1467              );
1468        $page_url = make_picture_url(
1469                 array(
1470                  'section'=>'tags',
1471                  'tags'=> array($tags_by_id[$tag_id]),
1472                  'image_id' => $row['id'],
1473                  'image_file' => $row['file'],
1474                )
1475              );
1476        array_push($image_tags, array(
1477                'id' => (int)$tag_id,
1478                'url' => $url,
1479                'page_url' => $page_url,
1480              )
1481            );
1482      }
1483      $image['tags'] = new PwgNamedArray($image_tags, 'tag',
1484              array('id','url_name','url','page_url')
1485            );
1486      array_push($images, $image);
1487    }
1488  }
1489
1490  return array( 'images' =>
1491    array (
1492      WS_XML_ATTRIBUTES =>
1493        array(
1494            'page' => $params['page'],
1495            'per_page' => $params['per_page'],
1496            'count' => count($images)
1497          ),
1498       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
1499          ws_std_get_image_xml_attributes() )
1500      )
1501    );
1502}
1503
1504function ws_categories_add($params, &$service)
1505{
1506  if (!is_admin() or is_adviser())
1507  {
1508    return new PwgError(401, 'Access denied');
1509  }
1510
1511  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1512
1513  $creation_output = create_virtual_category(
1514    $params['name'],
1515    $params['parent']
1516    );
1517
1518  if (isset($creation_output['error']))
1519  {
1520    return new PwgError(500, $creation_output['error']);
1521  }
1522
1523  invalidate_user_cache();
1524
1525  return $creation_output;
1526}
1527
1528function ws_tags_add($params, &$service)
1529{
1530  if (!is_admin() or is_adviser())
1531  {
1532    return new PwgError(401, 'Access denied');
1533  }
1534
1535  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1536
1537  $creation_output = create_tag($params['name']);
1538
1539  if (isset($creation_output['error']))
1540  {
1541    return new PwgError(500, $creation_output['error']);
1542  }
1543
1544  return $creation_output;
1545}
1546
1547function ws_images_exist($params, &$service)
1548{
1549  if (!is_admin() or is_adviser())
1550  {
1551    return new PwgError(401, 'Access denied');
1552  }
1553
1554  // search among photos the list of photos already added, based on md5sum
1555  // list
1556  $md5sums = preg_split(
1557    '/[\s,;\|]/',
1558    $params['md5sum_list'],
1559    -1,
1560    PREG_SPLIT_NO_EMPTY
1561    );
1562
1563  $query = '
1564SELECT
1565    id,
1566    md5sum
1567  FROM '.IMAGES_TABLE.'
1568  WHERE md5sum IN (\''.implode("','", $md5sums).'\')
1569;';
1570  $id_of_md5 = simple_hash_from_query($query, 'md5sum', 'id');
1571
1572  $result = array();
1573
1574  foreach ($md5sums as $md5sum)
1575  {
1576    $result[$md5sum] = null;
1577    if (isset($id_of_md5[$md5sum]))
1578    {
1579      $result[$md5sum] = $id_of_md5[$md5sum];
1580    }
1581  }
1582
1583  return $result;
1584}
1585
1586function ws_images_checkFiles($params, &$service)
1587{
1588  if (!is_admin() or is_adviser())
1589  {
1590    return new PwgError(401, 'Access denied');
1591  }
1592
1593  // input parameters
1594  //
1595  // image_id
1596  // thumbnail_sum
1597  // file_sum
1598  // high_sum
1599
1600  $params['image_id'] = (int)$params['image_id'];
1601  if ($params['image_id'] <= 0)
1602  {
1603    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1604  }
1605
1606  $query = '
1607SELECT
1608    path
1609  FROM '.IMAGES_TABLE.'
1610  WHERE id = '.$params['image_id'].'
1611;';
1612  $result = pwg_query($query);
1613  if (mysql_num_rows($result) == 0) {
1614    return new PwgError(404, "image_id not found");
1615  }
1616  list($path) = mysql_fetch_row($result);
1617
1618  $ret = array();
1619
1620  foreach (array('thumb', 'file', 'high') as $type) {
1621    $param_name = $type;
1622    if ('thumb' == $type) {
1623      $param_name = 'thumbnail';
1624    }
1625
1626    if (isset($params[$param_name.'_sum'])) {
1627      $type_path = file_path_for_type($path, $type);
1628      if (!is_file($type_path)) {
1629        $ret[$param_name] = 'missing';
1630      }
1631      else {
1632        if (md5_file($type_path) != $params[$param_name.'_sum']) {
1633          $ret[$param_name] = 'differs';
1634        }
1635        else {
1636          $ret[$param_name] = 'equals';
1637        }
1638      }
1639    }
1640  }
1641
1642  return $ret;
1643}
1644
1645function file_path_for_type($file_path, $type='thumb')
1646{
1647  // resolve the $file_path depending on the $type
1648  if ('thumb' == $type) {
1649    $file_path = get_thumbnail_location(
1650      array(
1651        'path' => $file_path,
1652        'tn_ext' => 'jpg',
1653        )
1654      );
1655  }
1656
1657  if ('high' == $type) {
1658    @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1659    $file_path = get_high_location(
1660      array(
1661        'path' => $file_path,
1662        'has_high' => 'true'
1663        )
1664      );
1665  }
1666
1667  return $file_path;
1668}
1669
1670function ws_images_setInfo($params, &$service)
1671{
1672  global $conf;
1673  if (!is_admin() || is_adviser() )
1674  {
1675    return new PwgError(401, 'Access denied');
1676  }
1677
1678  if (!$service->isPost())
1679  {
1680    return new PwgError(405, "This method requires HTTP POST");
1681  }
1682
1683  $params['image_id'] = (int)$params['image_id'];
1684  if ($params['image_id'] <= 0)
1685  {
1686    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1687  }
1688
1689  $query='
1690SELECT *
1691  FROM '.IMAGES_TABLE.'
1692  WHERE id = '.$params['image_id'].'
1693;';
1694
1695  $image_row = pwg_db_fetch_assoc(pwg_query($query));
1696  if ($image_row == null)
1697  {
1698    return new PwgError(404, "image_id not found");
1699  }
1700
1701  // database registration
1702  $update = array();
1703
1704  $info_columns = array(
1705    'name',
1706    'author',
1707    'comment',
1708    'level',
1709    'date_creation',
1710    );
1711
1712  foreach ($info_columns as $key)
1713  {
1714    if (isset($params[$key]))
1715    {
1716      if ('fill_if_empty' == $params['single_value_mode'])
1717      {
1718        if (empty($image_row[$key]))
1719        {
1720          $update[$key] = $params[$key];
1721        }
1722      }
1723      elseif ('replace' == $params['single_value_mode'])
1724      {
1725        $update[$key] = $params[$key];
1726      }
1727      else
1728      {
1729        new PwgError(
1730          500,
1731          '[ws_images_setInfo]'
1732          .' invalid parameter single_value_mode "'.$params['single_value_mode'].'"'
1733          .', possible values are {fill_if_empty, replace}.'
1734          );
1735        exit();
1736      }
1737    }
1738  }
1739
1740  if (count(array_keys($update)) > 0)
1741  {
1742    $update['id'] = $params['image_id'];
1743
1744    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1745    mass_updates(
1746      IMAGES_TABLE,
1747      array(
1748        'primary' => array('id'),
1749        'update'  => array_diff(array_keys($update), array('id'))
1750        ),
1751      array($update)
1752      );
1753  }
1754
1755  if (isset($params['categories']))
1756  {
1757    ws_add_image_category_relations(
1758      $params['image_id'],
1759      $params['categories'],
1760      ('replace' == $params['multiple_value_mode'] ? true : false)
1761      );
1762  }
1763
1764  // and now, let's create tag associations
1765  if (isset($params['tag_ids']))
1766  {
1767    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1768
1769    $tag_ids = explode(',', $params['tag_ids']);
1770
1771    if ('replace' == $params['multiple_value_mode'])
1772    {
1773      set_tags(
1774        $tag_ids,
1775        $params['image_id']
1776        );
1777    }
1778    elseif ('append' == $params['multiple_value_mode'])
1779    {
1780      add_tags(
1781        $tag_ids,
1782        array($params['image_id'])
1783        );
1784    }
1785    else
1786    {
1787      new PwgError(
1788        500,
1789        '[ws_images_setInfo]'
1790        .' invalid parameter multiple_value_mode "'.$params['multiple_value_mode'].'"'
1791        .', possible values are {replace, append}.'
1792        );
1793      exit();
1794    }
1795  }
1796
1797  invalidate_user_cache();
1798}
1799
1800function ws_add_image_category_relations($image_id, $categories_string, $replace_mode=false)
1801{
1802  // let's add links between the image and the categories
1803  //
1804  // $params['categories'] should look like 123,12;456,auto;789 which means:
1805  //
1806  // 1. associate with category 123 on rank 12
1807  // 2. associate with category 456 on automatic rank
1808  // 3. associate with category 789 on automatic rank
1809  $cat_ids = array();
1810  $rank_on_category = array();
1811  $search_current_ranks = false;
1812
1813  $tokens = explode(';', $categories_string);
1814  foreach ($tokens as $token)
1815  {
1816    @list($cat_id, $rank) = explode(',', $token);
1817
1818    if (!preg_match('/^\d+$/', $cat_id))
1819    {
1820      continue;
1821    }
1822
1823    array_push($cat_ids, $cat_id);
1824
1825    if (!isset($rank))
1826    {
1827      $rank = 'auto';
1828    }
1829    $rank_on_category[$cat_id] = $rank;
1830
1831    if ($rank == 'auto')
1832    {
1833      $search_current_ranks = true;
1834    }
1835  }
1836
1837  $cat_ids = array_unique($cat_ids);
1838
1839  if (count($cat_ids) == 0)
1840  {
1841    new PwgError(
1842      500,
1843      '[ws_add_image_category_relations] there is no category defined in "'.$categories_string.'"'
1844      );
1845    exit();
1846  }
1847
1848  $query = '
1849SELECT
1850    id
1851  FROM '.CATEGORIES_TABLE.'
1852  WHERE id IN ('.implode(',', $cat_ids).')
1853;';
1854  $db_cat_ids = array_from_query($query, 'id');
1855
1856  $unknown_cat_ids = array_diff($cat_ids, $db_cat_ids);
1857  if (count($unknown_cat_ids) != 0)
1858  {
1859    new PwgError(
1860      500,
1861      '[ws_add_image_category_relations] the following categories are unknown: '.implode(', ', $unknown_cat_ids)
1862      );
1863    exit();
1864  }
1865
1866  $to_update_cat_ids = array();
1867
1868  // in case of replace mode, we first check the existing associations
1869  $query = '
1870SELECT
1871    category_id
1872  FROM '.IMAGE_CATEGORY_TABLE.'
1873  WHERE image_id = '.$image_id.'
1874;';
1875  $existing_cat_ids = array_from_query($query, 'category_id');
1876
1877  if ($replace_mode)
1878  {
1879    $to_remove_cat_ids = array_diff($existing_cat_ids, $cat_ids);
1880    if (count($to_remove_cat_ids) > 0)
1881    {
1882      $query = '
1883DELETE
1884  FROM '.IMAGE_CATEGORY_TABLE.'
1885  WHERE image_id = '.$image_id.'
1886    AND category_id IN ('.implode(', ', $to_remove_cat_ids).')
1887;';
1888      pwg_query($query);
1889      update_category($to_remove_cat_ids);
1890    }
1891  }
1892
1893  $new_cat_ids = array_diff($cat_ids, $existing_cat_ids);
1894  if (count($new_cat_ids) == 0)
1895  {
1896    return true;
1897  }
1898
1899  if ($search_current_ranks)
1900  {
1901    $query = '
1902SELECT
1903    category_id,
1904    MAX(rank) AS max_rank
1905  FROM '.IMAGE_CATEGORY_TABLE.'
1906  WHERE rank IS NOT NULL
1907    AND category_id IN ('.implode(',', $new_cat_ids).')
1908  GROUP BY category_id
1909;';
1910    $current_rank_of = simple_hash_from_query(
1911      $query,
1912      'category_id',
1913      'max_rank'
1914      );
1915
1916    foreach ($new_cat_ids as $cat_id)
1917    {
1918      if (!isset($current_rank_of[$cat_id]))
1919      {
1920        $current_rank_of[$cat_id] = 0;
1921      }
1922
1923      if ('auto' == $rank_on_category[$cat_id])
1924      {
1925        $rank_on_category[$cat_id] = $current_rank_of[$cat_id] + 1;
1926      }
1927    }
1928  }
1929
1930  $inserts = array();
1931
1932  foreach ($new_cat_ids as $cat_id)
1933  {
1934    array_push(
1935      $inserts,
1936      array(
1937        'image_id' => $image_id,
1938        'category_id' => $cat_id,
1939        'rank' => $rank_on_category[$cat_id],
1940        )
1941      );
1942  }
1943
1944  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1945  mass_inserts(
1946    IMAGE_CATEGORY_TABLE,
1947    array_keys($inserts[0]),
1948    $inserts
1949    );
1950
1951  update_category($new_cat_ids);
1952}
1953
1954function ws_categories_setInfo($params, &$service)
1955{
1956  global $conf;
1957  if (!is_admin() || is_adviser() )
1958  {
1959    return new PwgError(401, 'Access denied');
1960  }
1961
1962  if (!$service->isPost())
1963  {
1964    return new PwgError(405, "This method requires HTTP POST");
1965  }
1966
1967  // category_id
1968  // name
1969  // comment
1970
1971  $params['category_id'] = (int)$params['category_id'];
1972  if ($params['category_id'] <= 0)
1973  {
1974    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1975  }
1976
1977  // database registration
1978  $update = array(
1979    'id' => $params['category_id'],
1980    );
1981
1982  $info_columns = array(
1983    'name',
1984    'comment',
1985    );
1986
1987  $perform_update = false;
1988  foreach ($info_columns as $key)
1989  {
1990    if (isset($params[$key]))
1991    {
1992      $perform_update = true;
1993      $update[$key] = $params[$key];
1994    }
1995  }
1996
1997  if ($perform_update)
1998  {
1999    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
2000    mass_updates(
2001      CATEGORIES_TABLE,
2002      array(
2003        'primary' => array('id'),
2004        'update'  => array_diff(array_keys($update), array('id'))
2005        ),
2006      array($update)
2007      );
2008  }
2009
2010}
2011
2012function ws_logfile($string)
2013{
2014  global $conf;
2015
2016  if (!$conf['ws_enable_log']) {
2017    return true;
2018  }
2019
2020  file_put_contents(
2021    $conf['ws_log_filepath'],
2022    '['.date('c').'] '.$string."\n",
2023    FILE_APPEND
2024    );
2025}
2026?>
Note: See TracBrowser for help on using the repository browser.