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

Last change on this file since 4460 was 4460, checked in by plg, 14 years ago

merge r4459 from branch 2.0 to trunk

feature 1316 added: we now have the ability to only fill the single value
properties that are currently empty in the database instead of automatically
replacing.

feature 1312: as a matter of consistency, I have changed the replace_mode
(that was only for multiple values properties) into multiple_value_mode +
single_value_mode.

  • Property svn:eol-style set to LF
File size: 48.0 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  $params['image_id'] = array_map( 'intval',$params['image_id'] );
859  if ( empty($params['image_id']) )
860  {
861    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
862  }
863  global $conf;
864  if ( !in_array( (int)$params['level'], $conf['available_permission_levels']) )
865  {
866    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid level");
867  }
868  $query = '
869UPDATE '.IMAGES_TABLE.'
870  SET level='.(int)$params['level'].'
871  WHERE id IN ('.implode(',',$params['image_id']).')';
872  $result = pwg_query($query);
873  $affected_rows = pwg_db_affected_rows();
874  if ($affected_rows)
875  {
876    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
877    invalidate_user_cache();
878  }
879  return $affected_rows;
880}
881
882function ws_images_add_chunk($params, &$service)
883{
884  // data
885  // original_sum
886  // type {thumb, file, high}
887  // position
888
889  if (!is_admin() || is_adviser() )
890  {
891    return new PwgError(401, 'Access denied');
892  }
893
894  $upload_dir = PHPWG_ROOT_PATH.'upload/buffer';
895
896  // create the upload directory tree if not exists
897  if (!is_dir($upload_dir)) {
898    umask(0000);
899    $recursive = true;
900    if (!@mkdir($upload_dir, 0777, $recursive))
901    {
902      return new PwgError(500, 'error during buffer directory creation');
903    }
904  }
905
906  if (!is_writable($upload_dir))
907  {
908    // last chance to make the directory writable
909    @chmod($upload_dir, 0777);
910
911    if (!is_writable($upload_dir))
912    {
913      return new PwgError(500, 'buffer directory has no write access');
914    }
915  }
916
917  secure_directory($upload_dir);
918
919  $filename = sprintf(
920    '%s-%s-%05u.block',
921    $params['original_sum'],
922    $params['type'],
923    $params['position']
924    );
925
926  ws_logfile('[ws_images_add_chunk] data length : '.strlen($params['data']));
927
928  $bytes_written = file_put_contents(
929    $upload_dir.'/'.$filename,
930    base64_decode($params['data'])
931    );
932
933  if (false === $bytes_written) {
934    return new PwgError(
935      500,
936      'an error has occured while writting chunk '.$params['position'].' for '.$params['type']
937      );
938  }
939}
940
941function merge_chunks($output_filepath, $original_sum, $type)
942{
943  ws_logfile('[merge_chunks] input parameter $output_filepath : '.$output_filepath);
944
945  if (is_file($output_filepath))
946  {
947    unlink($output_filepath);
948   
949    if (is_file($output_filepath))
950    {
951      new PwgError(500, '[merge_chunks] error while trying to remove existing '.$output_filepath);
952      exit();
953    }
954  }
955 
956  $upload_dir = PHPWG_ROOT_PATH.'upload/buffer';
957  $pattern = '/'.$original_sum.'-'.$type.'/';
958  $chunks = array();
959
960  if ($handle = opendir($upload_dir))
961  {
962    while (false !== ($file = readdir($handle)))
963    {
964      if (preg_match($pattern, $file))
965      {
966        ws_logfile($file);
967        array_push($chunks, $upload_dir.'/'.$file);
968      }
969    }
970    closedir($handle);
971  }
972
973  sort($chunks);
974
975  if (function_exists('memory_get_usage')) {
976    ws_logfile('[merge_chunks] memory_get_usage before loading chunks: '.memory_get_usage());
977  }
978
979  $i = 0;
980 
981  foreach ($chunks as $chunk)
982  {
983    $string = file_get_contents($chunk);
984
985    if (function_exists('memory_get_usage')) {
986      ws_logfile('[merge_chunks] memory_get_usage on chunk '.++$i.': '.memory_get_usage());
987    }
988
989    if (!file_put_contents($output_filepath, $string, FILE_APPEND))
990    {
991      new PwgError(500, '[merge_chunks] error while writting chunks for '.$output_filepath);
992      exit();
993    }
994
995    unlink($chunk);
996  }
997
998  if (function_exists('memory_get_usage')) {
999    ws_logfile('[merge_chunks] memory_get_usage after loading chunks: '.memory_get_usage());
1000  }
1001}
1002
1003/*
1004 * The $file_path must be the path of the basic "web sized" photo
1005 * The $type value will automatically modify the $file_path to the corresponding file
1006 */
1007function add_file($file_path, $type, $original_sum, $file_sum)
1008{
1009  $file_path = file_path_for_type($file_path, $type);
1010
1011  $upload_dir = dirname($file_path);
1012 
1013  if (!is_dir($upload_dir)) {
1014    umask(0000);
1015    $recursive = true;
1016    if (!@mkdir($upload_dir, 0777, $recursive))
1017    {
1018      new PwgError(500, '[add_file] error during '.$type.' directory creation');
1019      exit();
1020    }
1021  }
1022
1023  if (!is_writable($upload_dir))
1024  {
1025    // last chance to make the directory writable
1026    @chmod($upload_dir, 0777);
1027
1028    if (!is_writable($upload_dir))
1029    {
1030      new PwgError(500, '[add_file] '.$type.' directory has no write access');
1031      exit();
1032    }
1033  }
1034
1035  secure_directory($upload_dir);
1036
1037  // merge the thumbnail
1038  merge_chunks($file_path, $original_sum, $type);
1039  chmod($file_path, 0644);
1040
1041  // check dumped thumbnail md5
1042  $dumped_md5 = md5_file($file_path);
1043  if ($dumped_md5 != $file_sum) {
1044    new PwgError(500, '[add_file] '.$type.' transfer failed');
1045    exit();
1046  }
1047
1048  list($width, $height) = getimagesize($file_path);
1049  $filesize = floor(filesize($file_path)/1024);
1050
1051  return array(
1052    'width' => $width,
1053    'height' => $height,
1054    'filesize' => $filesize,
1055    );
1056}
1057
1058function ws_images_addFile($params, &$service)
1059{
1060  // image_id
1061  // type {thumb, file, high}
1062  // sum
1063
1064  global $conf;
1065  if (!is_admin() || is_adviser() )
1066  {
1067    return new PwgError(401, 'Access denied');
1068  }
1069
1070  $params['image_id'] = (int)$params['image_id'];
1071  if ($params['image_id'] <= 0)
1072  {
1073    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1074  }
1075
1076  //
1077  // what is the path?
1078  //
1079  $query = '
1080SELECT
1081    path,
1082    md5sum
1083  FROM '.IMAGES_TABLE.'
1084  WHERE id = '.$params['image_id'].'
1085;';
1086  list($file_path, $original_sum) = mysql_fetch_row(pwg_query($query));
1087
1088  // TODO only files added with web API can be updated with web API
1089
1090  //
1091  // makes sure directories are there and call the merge_chunks
1092  //
1093  $infos = add_file($file_path, $params['type'], $original_sum, $params['sum']);
1094
1095  //
1096  // update basic metadata from file
1097  //
1098  $update = array();
1099 
1100  if ('high' == $params['type'])
1101  {
1102    $update['high_filesize'] = $infos['filesize'];
1103    $update['has_high'] = 'true';
1104  }
1105
1106  if ('file' == $params['type'])
1107  {
1108    $update['filesize'] = $infos['filesize'];
1109    $update['width'] = $infos['width'];
1110    $update['height'] = $infos['height'];
1111  }
1112
1113  // we may have nothing to update at database level, for example with a
1114  // thumbnail update
1115  if (count($update) > 0)
1116  {
1117    $update['id'] = $params['image_id'];
1118   
1119    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1120    mass_updates(
1121      IMAGES_TABLE,
1122      array(
1123        'primary' => array('id'),
1124        'update'  => array_diff(array_keys($update), array('id'))
1125        ),
1126      array($update)
1127      );
1128  }
1129}
1130
1131function ws_images_add($params, &$service)
1132{
1133  global $conf;
1134  if (!is_admin() || is_adviser() )
1135  {
1136    return new PwgError(401, 'Access denied');
1137  }
1138
1139  foreach ($params as $param_key => $param_value) {
1140    ws_logfile(
1141      sprintf(
1142        '[pwg.images.add] input param "%s" : "%s"',
1143        $param_key,
1144        is_null($param_value) ? 'NULL' : $param_value
1145        )
1146      );
1147  }
1148
1149  // does the image already exists ?
1150  $query = '
1151SELECT
1152    COUNT(*) AS counter
1153  FROM '.IMAGES_TABLE.'
1154  WHERE md5sum = \''.$params['original_sum'].'\'
1155;';
1156  list($counter) = pwg_db_fetch_row(pwg_query($query));
1157  if ($counter != 0) {
1158    return new PwgError(500, 'file already exists');
1159  }
1160
1161  // current date
1162  list($dbnow) = pwg_db_fetch_row(pwg_query('SELECT NOW();'));
1163  list($year, $month, $day) = preg_split('/[^\d]/', $dbnow, 4);
1164
1165  // upload directory hierarchy
1166  $upload_dir = sprintf(
1167    PHPWG_ROOT_PATH.'upload/%s/%s/%s',
1168    $year,
1169    $month,
1170    $day
1171    );
1172
1173  // compute file path
1174  $date_string = preg_replace('/[^\d]/', '', $dbnow);
1175  $random_string = substr($params['file_sum'], 0, 8);
1176  $filename_wo_ext = $date_string.'-'.$random_string;
1177  $file_path = $upload_dir.'/'.$filename_wo_ext.'.jpg';
1178
1179  // add files
1180  $file_infos  = add_file($file_path, 'file',  $params['original_sum'], $params['file_sum']);
1181  $thumb_infos = add_file($file_path, 'thumb', $params['original_sum'], $params['thumbnail_sum']);
1182
1183  if (isset($params['high_sum']))
1184  {
1185    $high_infos = add_file($file_path, 'high', $params['original_sum'], $params['high_sum']);
1186  }
1187
1188  // database registration
1189  $insert = array(
1190    'file' => $filename_wo_ext.'.jpg',
1191    'date_available' => $dbnow,
1192    'tn_ext' => 'jpg',
1193    'name' => $params['name'],
1194    'path' => $file_path,
1195    'filesize' => $file_infos['filesize'],
1196    'width' => $file_infos['width'],
1197    'height' => $file_infos['height'],
1198    'md5sum' => $params['original_sum'],
1199    );
1200
1201  $info_columns = array(
1202    'name',
1203    'author',
1204    'comment',
1205    'level',
1206    'date_creation',
1207    );
1208
1209  foreach ($info_columns as $key)
1210  {
1211    if (isset($params[$key]))
1212    {
1213      $insert[$key] = $params[$key];
1214    }
1215  }
1216
1217  if (isset($params['high_sum']))
1218  {
1219    $insert['has_high'] = 'true';
1220    $insert['high_filesize'] = $high_infos['filesize'];
1221  }
1222
1223  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1224  mass_inserts(
1225    IMAGES_TABLE,
1226    array_keys($insert),
1227    array($insert)
1228    );
1229
1230  $image_id = pwg_db_insert_id();
1231
1232  // let's add links between the image and the categories
1233  if (isset($params['categories']))
1234  {
1235    ws_add_image_category_relations($image_id, $params['categories']);
1236  }
1237
1238  // and now, let's create tag associations
1239  if (isset($params['tag_ids']) and !empty($params['tag_ids']))
1240  {
1241    set_tags(
1242      explode(',', $params['tag_ids']),
1243      $image_id
1244      );
1245  }
1246
1247  invalidate_user_cache();
1248}
1249
1250/**
1251 * perform a login (web service method)
1252 */
1253function ws_session_login($params, &$service)
1254{
1255  global $conf;
1256
1257  if (!$service->isPost())
1258  {
1259    return new PwgError(405, "This method requires HTTP POST");
1260  }
1261  if (try_log_user($params['username'], $params['password'],false))
1262  {
1263    return true;
1264  }
1265  return new PwgError(999, 'Invalid username/password');
1266}
1267
1268
1269/**
1270 * performs a logout (web service method)
1271 */
1272function ws_session_logout($params, &$service)
1273{
1274  if (!is_a_guest())
1275  {
1276    logout_user();
1277  }
1278  return true;
1279}
1280
1281function ws_session_getStatus($params, &$service)
1282{
1283  global $user;
1284  $res = array();
1285  $res['username'] = is_a_guest() ? 'guest' : stripslashes($user['username']);
1286  foreach ( array('status', 'template', 'theme', 'language') as $k )
1287  {
1288    $res[$k] = $user[$k];
1289  }
1290  $res['charset'] = get_pwg_charset();
1291  return $res;
1292}
1293
1294
1295/**
1296 * returns a list of tags (web service method)
1297 */
1298function ws_tags_getList($params, &$service)
1299{
1300  $tags = get_available_tags();
1301  if ($params['sort_by_counter'])
1302  {
1303    usort($tags, create_function('$a,$b', 'return -$a["counter"]+$b["counter"];') );
1304  }
1305  else
1306  {
1307    usort($tags, 'tag_alpha_compare');
1308  }
1309  for ($i=0; $i<count($tags); $i++)
1310  {
1311    $tags[$i]['id'] = (int)$tags[$i]['id'];
1312    $tags[$i]['counter'] = (int)$tags[$i]['counter'];
1313    $tags[$i]['url'] = make_index_url(
1314        array(
1315          'section'=>'tags',
1316          'tags'=>array($tags[$i])
1317        )
1318      );
1319  }
1320  return array('tags' => new PwgNamedArray($tags, 'tag', array('id','url_name','url', 'name', 'counter' )) );
1321}
1322
1323/**
1324 * returns the list of tags as you can see them in administration (web
1325 * service method).
1326 *
1327 * Only admin can run this method and permissions are not taken into
1328 * account.
1329 */
1330function ws_tags_getAdminList($params, &$service)
1331{
1332  if (!is_admin())
1333  {
1334    return new PwgError(401, 'Access denied');
1335  }
1336
1337  $tags = get_all_tags();
1338  return array(
1339    'tags' => new PwgNamedArray(
1340      $tags,
1341      'tag',
1342      array(
1343        'name',
1344        'id',
1345        'url_name',
1346        )
1347      )
1348    );
1349}
1350
1351/**
1352 * returns a list of images for tags (web service method)
1353 */
1354function ws_tags_getImages($params, &$service)
1355{
1356  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1357  global $conf;
1358
1359  // first build all the tag_ids we are interested in
1360  $params['tag_id'] = array_map( 'intval',$params['tag_id'] );
1361  $tags = find_tags($params['tag_id'], $params['tag_url_name'], $params['tag_name']);
1362  $tags_by_id = array();
1363  foreach( $tags as $tag )
1364  {
1365    $tags['id'] = (int)$tag['id'];
1366    $tags_by_id[ $tag['id'] ] = $tag;
1367  }
1368  unset($tags);
1369  $tag_ids = array_keys($tags_by_id);
1370
1371
1372  $image_ids = array();
1373  $image_tag_map = array();
1374
1375  if ( !empty($tag_ids) )
1376  { // build list of image ids with associated tags per image
1377    if ($params['tag_mode_and'])
1378    {
1379      $image_ids = get_image_ids_for_tags( $tag_ids );
1380    }
1381    else
1382    {
1383      $query = '
1384SELECT image_id, GROUP_CONCAT(tag_id) tag_ids
1385  FROM '.IMAGE_TAG_TABLE.'
1386  WHERE tag_id IN ('.implode(',',$tag_ids).')
1387  GROUP BY image_id';
1388      $result = pwg_query($query);
1389      while ( $row=pwg_db_fetch_assoc($result) )
1390      {
1391        $row['image_id'] = (int)$row['image_id'];
1392        array_push( $image_ids, $row['image_id'] );
1393        $image_tag_map[ $row['image_id'] ] = explode(',', $row['tag_ids']);
1394      }
1395    }
1396  }
1397
1398  $images = array();
1399  if ( !empty($image_ids))
1400  {
1401    $where_clauses = ws_std_image_sql_filter($params);
1402    $where_clauses[] = get_sql_condition_FandF(
1403        array
1404          (
1405            'forbidden_categories' => 'category_id',
1406            'visible_categories' => 'category_id',
1407            'visible_images' => 'i.id'
1408          ),
1409        '', true
1410      );
1411    $where_clauses[] = 'id IN ('.implode(',',$image_ids).')';
1412
1413    $order_by = ws_std_image_sql_order($params);
1414    if (empty($order_by))
1415    {
1416      $order_by = $conf['order_by'];
1417    }
1418    else
1419    {
1420      $order_by = 'ORDER BY '.$order_by;
1421    }
1422
1423    $query = '
1424SELECT DISTINCT i.* FROM '.IMAGES_TABLE.' i
1425  INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON i.id=image_id
1426  WHERE '. implode('
1427    AND ', $where_clauses).'
1428'.$order_by.'
1429LIMIT '.(int)$params['per_page'].' OFFSET '.(int)($params['per_page']*$params['page']);
1430
1431    $result = pwg_query($query);
1432    while ($row = pwg_db_fetch_assoc($result))
1433    {
1434      $image = array();
1435      foreach ( array('id', 'width', 'height', 'hit') as $k )
1436      {
1437        if (isset($row[$k]))
1438        {
1439          $image[$k] = (int)$row[$k];
1440        }
1441      }
1442      foreach ( array('file', 'name', 'comment') as $k )
1443      {
1444        $image[$k] = $row[$k];
1445      }
1446      $image = array_merge( $image, ws_std_get_urls($row) );
1447
1448      $image_tag_ids = ($params['tag_mode_and']) ? $tag_ids : $image_tag_map[$image['id']];
1449      $image_tags = array();
1450      foreach ($image_tag_ids as $tag_id)
1451      {
1452        $url = make_index_url(
1453                 array(
1454                  'section'=>'tags',
1455                  'tags'=> array($tags_by_id[$tag_id])
1456                )
1457              );
1458        $page_url = make_picture_url(
1459                 array(
1460                  'section'=>'tags',
1461                  'tags'=> array($tags_by_id[$tag_id]),
1462                  'image_id' => $row['id'],
1463                  'image_file' => $row['file'],
1464                )
1465              );
1466        array_push($image_tags, array(
1467                'id' => (int)$tag_id,
1468                'url' => $url,
1469                'page_url' => $page_url,
1470              )
1471            );
1472      }
1473      $image['tags'] = new PwgNamedArray($image_tags, 'tag',
1474              array('id','url_name','url','page_url')
1475            );
1476      array_push($images, $image);
1477    }
1478  }
1479
1480  return array( 'images' =>
1481    array (
1482      WS_XML_ATTRIBUTES =>
1483        array(
1484            'page' => $params['page'],
1485            'per_page' => $params['per_page'],
1486            'count' => count($images)
1487          ),
1488       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
1489          ws_std_get_image_xml_attributes() )
1490      )
1491    );
1492}
1493
1494function ws_categories_add($params, &$service)
1495{
1496  if (!is_admin() or is_adviser())
1497  {
1498    return new PwgError(401, 'Access denied');
1499  }
1500
1501  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1502
1503  $creation_output = create_virtual_category(
1504    $params['name'],
1505    $params['parent']
1506    );
1507
1508  if (isset($creation_output['error']))
1509  {
1510    return new PwgError(500, $creation_output['error']);
1511  }
1512
1513  invalidate_user_cache();
1514
1515  return $creation_output;
1516}
1517
1518function ws_tags_add($params, &$service)
1519{
1520  if (!is_admin() or is_adviser())
1521  {
1522    return new PwgError(401, 'Access denied');
1523  }
1524
1525  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1526
1527  $creation_output = create_tag($params['name']);
1528
1529  if (isset($creation_output['error']))
1530  {
1531    return new PwgError(500, $creation_output['error']);
1532  }
1533
1534  return $creation_output;
1535}
1536
1537function ws_images_exist($params, &$service)
1538{
1539  if (!is_admin() or is_adviser())
1540  {
1541    return new PwgError(401, 'Access denied');
1542  }
1543
1544  // search among photos the list of photos already added, based on md5sum
1545  // list
1546  $md5sums = preg_split(
1547    '/[\s,;\|]/',
1548    $params['md5sum_list'],
1549    -1,
1550    PREG_SPLIT_NO_EMPTY
1551    );
1552
1553  $query = '
1554SELECT
1555    id,
1556    md5sum
1557  FROM '.IMAGES_TABLE.'
1558  WHERE md5sum IN (\''.implode("','", $md5sums).'\')
1559;';
1560  $id_of_md5 = simple_hash_from_query($query, 'md5sum', 'id');
1561
1562  $result = array();
1563
1564  foreach ($md5sums as $md5sum)
1565  {
1566    $result[$md5sum] = null;
1567    if (isset($id_of_md5[$md5sum]))
1568    {
1569      $result[$md5sum] = $id_of_md5[$md5sum];
1570    }
1571  }
1572
1573  return $result;
1574}
1575
1576function ws_images_checkFiles($params, &$service)
1577{
1578  if (!is_admin() or is_adviser())
1579  {
1580    return new PwgError(401, 'Access denied');
1581  }
1582
1583  // input parameters
1584  //
1585  // image_id
1586  // thumbnail_sum
1587  // file_sum
1588  // high_sum
1589
1590  $params['image_id'] = (int)$params['image_id'];
1591  if ($params['image_id'] <= 0)
1592  {
1593    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1594  }
1595
1596  $query = '
1597SELECT
1598    path
1599  FROM '.IMAGES_TABLE.'
1600  WHERE id = '.$params['image_id'].'
1601;';
1602  $result = pwg_query($query);
1603  if (mysql_num_rows($result) == 0) {
1604    return new PwgError(404, "image_id not found");
1605  }
1606  list($path) = mysql_fetch_row($result);
1607
1608  $ret = array();
1609
1610  foreach (array('thumb', 'file', 'high') as $type) {
1611    $param_name = $type;
1612    if ('thumb' == $type) {
1613      $param_name = 'thumbnail';
1614    }
1615
1616    if (isset($params[$param_name.'_sum'])) {
1617      $type_path = file_path_for_type($path, $type);
1618      if (!is_file($type_path)) {
1619        $ret[$param_name] = 'missing';
1620      }
1621      else {
1622        if (md5_file($type_path) != $params[$param_name.'_sum']) {
1623          $ret[$param_name] = 'differs';
1624        }
1625        else {
1626          $ret[$param_name] = 'equals';
1627        }
1628      }
1629    }
1630  }
1631
1632  return $ret;
1633}
1634
1635function file_path_for_type($file_path, $type='thumb')
1636{
1637  // resolve the $file_path depending on the $type
1638  if ('thumb' == $type) {
1639    $file_path = get_thumbnail_location(
1640      array(
1641        'path' => $file_path,
1642        'tn_ext' => 'jpg',
1643        )
1644      );
1645  }
1646
1647  if ('high' == $type) {
1648    @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1649    $file_path = get_high_location(
1650      array(
1651        'path' => $file_path,
1652        'has_high' => 'true'
1653        )
1654      );
1655  }
1656
1657  return $file_path;
1658}
1659
1660function ws_images_setInfo($params, &$service)
1661{
1662  global $conf;
1663  if (!is_admin() || is_adviser() )
1664  {
1665    return new PwgError(401, 'Access denied');
1666  }
1667
1668  $params['image_id'] = (int)$params['image_id'];
1669  if ($params['image_id'] <= 0)
1670  {
1671    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1672  }
1673
1674  $query='
1675SELECT *
1676  FROM '.IMAGES_TABLE.'
1677  WHERE id = '.$params['image_id'].'
1678;';
1679
1680  $image_row = pwg_db_fetch_assoc(pwg_query($query));
1681  if ($image_row == null)
1682  {
1683    return new PwgError(404, "image_id not found");
1684  }
1685
1686  // database registration
1687  $update = array();
1688
1689  $info_columns = array(
1690    'name',
1691    'author',
1692    'comment',
1693    'level',
1694    'date_creation',
1695    );
1696
1697  foreach ($info_columns as $key)
1698  {
1699    if (isset($params[$key]))
1700    {
1701      if ('fill_if_empty' == $params['single_value_mode'])
1702      {
1703        if (empty($image_row[$key]))
1704        {
1705          $update[$key] = $params[$key];
1706        }
1707      }
1708      elseif ('replace' == $params['single_value_mode'])
1709      {
1710        $update[$key] = $params[$key];
1711      }
1712      else
1713      {
1714        new PwgError(
1715          500,
1716          '[ws_images_setInfo]'
1717          .' invalid parameter single_value_mode "'.$params['single_value_mode'].'"'
1718          .', possible values are {fill_if_empty, replace}.'
1719          );
1720        exit();
1721      }
1722    }
1723  }
1724
1725  if (count(array_keys($update)) > 0)
1726  {
1727    $update['id'] = $params['image_id'];
1728
1729    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1730    mass_updates(
1731      IMAGES_TABLE,
1732      array(
1733        'primary' => array('id'),
1734        'update'  => array_diff(array_keys($update), array('id'))
1735        ),
1736      array($update)
1737      );
1738  }
1739
1740  if (isset($params['categories']))
1741  {
1742    ws_add_image_category_relations(
1743      $params['image_id'],
1744      $params['categories'],
1745      ('replace' == $params['multiple_value_mode'] ? true : false)
1746      );
1747  }
1748
1749  // and now, let's create tag associations
1750  if (isset($params['tag_ids']))
1751  {
1752    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1753
1754    $tag_ids = explode(',', $params['tag_ids']);
1755
1756    if ('replace' == $params['multiple_value_mode'])
1757    {
1758      set_tags(
1759        $tag_ids,
1760        $params['image_id']
1761        );
1762    }
1763    elseif ('append' == $params['multiple_value_mode'])
1764    {
1765      add_tags(
1766        $tag_ids,
1767        array($params['image_id'])
1768        );
1769    }
1770    else
1771    {
1772      new PwgError(
1773        500,
1774        '[ws_images_setInfo]'
1775        .' invalid parameter multiple_value_mode "'.$params['multiple_value_mode'].'"'
1776        .', possible values are {replace, append}.'
1777        );
1778      exit();
1779    }
1780  }
1781
1782  invalidate_user_cache();
1783}
1784
1785function ws_add_image_category_relations($image_id, $categories_string, $replace_mode=false)
1786{
1787  // let's add links between the image and the categories
1788  //
1789  // $params['categories'] should look like 123,12;456,auto;789 which means:
1790  //
1791  // 1. associate with category 123 on rank 12
1792  // 2. associate with category 456 on automatic rank
1793  // 3. associate with category 789 on automatic rank
1794  $cat_ids = array();
1795  $rank_on_category = array();
1796  $search_current_ranks = false;
1797
1798  $tokens = explode(';', $categories_string);
1799  foreach ($tokens as $token)
1800  {
1801    @list($cat_id, $rank) = explode(',', $token);
1802
1803    if (!preg_match('/^\d+$/', $cat_id))
1804    {
1805      continue;
1806    }
1807
1808    array_push($cat_ids, $cat_id);
1809
1810    if (!isset($rank))
1811    {
1812      $rank = 'auto';
1813    }
1814    $rank_on_category[$cat_id] = $rank;
1815
1816    if ($rank == 'auto')
1817    {
1818      $search_current_ranks = true;
1819    }
1820  }
1821
1822  $cat_ids = array_unique($cat_ids);
1823
1824  if (count($cat_ids) == 0)
1825  {
1826    new PwgError(
1827      500,
1828      '[ws_add_image_category_relations] there is no category defined in "'.$categories_string.'"'
1829      );
1830    exit();
1831  }
1832 
1833  $query = '
1834SELECT
1835    id
1836  FROM '.CATEGORIES_TABLE.'
1837  WHERE id IN ('.implode(',', $cat_ids).')
1838;';
1839  $db_cat_ids = array_from_query($query, 'id');
1840
1841  $unknown_cat_ids = array_diff($cat_ids, $db_cat_ids);
1842  if (count($unknown_cat_ids) != 0)
1843  {
1844    new PwgError(
1845      500,
1846      '[ws_add_image_category_relations] the following categories are unknown: '.implode(', ', $unknown_cat_ids)
1847      );
1848    exit();
1849  }
1850 
1851  $to_update_cat_ids = array();
1852   
1853  // in case of replace mode, we first check the existing associations
1854  $query = '
1855SELECT
1856    category_id
1857  FROM '.IMAGE_CATEGORY_TABLE.'
1858  WHERE image_id = '.$image_id.'
1859;';
1860  $existing_cat_ids = array_from_query($query, 'category_id');
1861
1862  if ($replace_mode)
1863  {
1864    $to_remove_cat_ids = array_diff($existing_cat_ids, $cat_ids);
1865    if (count($to_remove_cat_ids) > 0)
1866    {
1867      $query = '
1868DELETE
1869  FROM '.IMAGE_CATEGORY_TABLE.'
1870  WHERE image_id = '.$image_id.'
1871    AND category_id IN ('.implode(', ', $to_remove_cat_ids).')
1872;';
1873      pwg_query($query);
1874      update_category($to_remove_cat_ids);
1875    }
1876  }
1877 
1878  $new_cat_ids = array_diff($cat_ids, $existing_cat_ids);
1879  if (count($new_cat_ids) == 0)
1880  {
1881    return true;
1882  }
1883   
1884  if ($search_current_ranks)
1885  {
1886    $query = '
1887SELECT
1888    category_id,
1889    MAX(rank) AS max_rank
1890  FROM '.IMAGE_CATEGORY_TABLE.'
1891  WHERE rank IS NOT NULL
1892    AND category_id IN ('.implode(',', $new_cat_ids).')
1893  GROUP BY category_id
1894;';
1895    $current_rank_of = simple_hash_from_query(
1896      $query,
1897      'category_id',
1898      'max_rank'
1899      );
1900
1901    foreach ($new_cat_ids as $cat_id)
1902    {
1903      if (!isset($current_rank_of[$cat_id]))
1904      {
1905        $current_rank_of[$cat_id] = 0;
1906      }
1907     
1908      if ('auto' == $rank_on_category[$cat_id])
1909      {
1910        $rank_on_category[$cat_id] = $current_rank_of[$cat_id] + 1;
1911      }
1912    }
1913  }
1914 
1915  $inserts = array();
1916 
1917  foreach ($new_cat_ids as $cat_id)
1918  {
1919    array_push(
1920      $inserts,
1921      array(
1922        'image_id' => $image_id,
1923        'category_id' => $cat_id,
1924        'rank' => $rank_on_category[$cat_id],
1925        )
1926      );
1927  }
1928 
1929  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1930  mass_inserts(
1931    IMAGE_CATEGORY_TABLE,
1932    array_keys($inserts[0]),
1933    $inserts
1934    );
1935 
1936  update_category($new_cat_ids);
1937}
1938
1939function ws_categories_setInfo($params, &$service)
1940{
1941  global $conf;
1942  if (!is_admin() || is_adviser() )
1943  {
1944    return new PwgError(401, 'Access denied');
1945  }
1946
1947  // category_id
1948  // name
1949  // comment
1950
1951  $params['category_id'] = (int)$params['category_id'];
1952  if ($params['category_id'] <= 0)
1953  {
1954    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1955  }
1956
1957  // database registration
1958  $update = array(
1959    'id' => $params['category_id'],
1960    );
1961
1962  $info_columns = array(
1963    'name',
1964    'comment',
1965    );
1966
1967  $perform_update = false;
1968  foreach ($info_columns as $key)
1969  {
1970    if (isset($params[$key]))
1971    {
1972      $perform_update = true;
1973      $update[$key] = $params[$key];
1974    }
1975  }
1976
1977  if ($perform_update)
1978  {
1979    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1980    mass_updates(
1981      CATEGORIES_TABLE,
1982      array(
1983        'primary' => array('id'),
1984        'update'  => array_diff(array_keys($update), array('id'))
1985        ),
1986      array($update)
1987      );
1988  }
1989
1990}
1991
1992function ws_logfile($string)
1993{
1994  global $conf;
1995
1996  if (!$conf['ws_enable_log']) {
1997    return true;
1998  }
1999
2000  file_put_contents(
2001    $conf['ws_log_filepath'],
2002    '['.date('c').'] '.$string."\n",
2003    FILE_APPEND
2004    );
2005}
2006?>
Note: See TracBrowser for help on using the repository browser.