source: branches/2.0/include/ws_functions.inc.php @ 4344

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

feature 1051: new API method pwg.images.checkFiles. This method will be useful
before asking for an update on photo files.

Enhancement in code factorization.

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Author Date Id Revision
File size: 43.7 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] = 'RAND()'; break;
125    }
126    $sortable_fields = array('id', 'file', 'name', 'hit', 'average_rate',
127      'date_creation', 'date_available', 'RAND()' );
128    if ( in_array($matches[1][$i], $sortable_fields) )
129    {
130      if (!empty($ret))
131        $ret .= ', ';
132      if ($matches[1][$i] != 'RAND()' )
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 REGEXP \'(^|,)'.$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 = mysql_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']*$params['page']).','.(int)$params['per_page'];
296
297    $result = pwg_query($query);
298    while ($row = mysql_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 REGEXP \'(^|,)'.
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 = mysql_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 = mysql_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 ( !mysql_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 = mysql_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 = mysql_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 = mysql_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']*$params['comments_page']).
686    ','.(int)$params['comments_per_page'];
687
688    $result = pwg_query($query);
689    while ($row = mysql_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'] = $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 ( mysql_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 = mysql_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 = mysql_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  $upload_dir = PHPWG_ROOT_PATH.'upload/buffer';
946  $pattern = '/'.$original_sum.'-'.$type.'/';
947  $chunks = array();
948 
949  if ($handle = opendir($upload_dir))
950  {
951    while (false !== ($file = readdir($handle)))
952    {
953      if (preg_match($pattern, $file))
954      {
955        ws_logfile($file);
956        array_push($chunks, $upload_dir.'/'.$file);
957      }
958    }
959    closedir($handle);
960  }
961
962  sort($chunks);
963
964  ws_logfile('[merge_chunks] memory_get_usage before loading chunks: '.memory_get_usage());
965
966  $i = 0;
967 
968  foreach ($chunks as $chunk)
969  {
970    $string = file_get_contents($chunk);
971   
972    ws_logfile('[merge_chunks] memory_get_usage on chunk '.++$i.': '.memory_get_usage());
973   
974    if (!file_put_contents($output_filepath, $string, FILE_APPEND))
975    {
976      new PwgError(500, '[merge_chunks] error while writting chunks for '.$output_filepath);
977      exit();
978    }
979   
980    unlink($chunk);
981  }
982
983  ws_logfile('[merge_chunks] memory_get_usage after loading chunks: '.memory_get_usage());
984}
985
986/*
987 * The $file_path must be the path of the basic "web sized" photo
988 * The $type value will automatically modify the $file_path to the corresponding file
989 */
990function add_file($file_path, $type, $original_sum, $file_sum)
991{
992  $file_path = file_path_for_type($file_path, $type);
993
994  $upload_dir = dirname($file_path);
995 
996  if (!is_dir($upload_dir)) {
997    umask(0000);
998    $recursive = true;
999    if (!@mkdir($upload_dir, 0777, $recursive))
1000    {
1001      new PwgError(500, '[add_file] error during '.$type.' directory creation');
1002      exit();
1003    }
1004  }
1005
1006  if (!is_writable($upload_dir))
1007  {
1008    // last chance to make the directory writable
1009    @chmod($upload_dir, 0777);
1010
1011    if (!is_writable($upload_dir))
1012    {
1013      new PwgError(500, '[add_file] '.$type.' directory has no write access');
1014      exit();
1015    }
1016  }
1017
1018  secure_directory($upload_dir);
1019
1020  // merge the thumbnail
1021  merge_chunks($file_path, $original_sum, $type);
1022  chmod($file_path, 0644);
1023
1024  // check dumped thumbnail md5
1025  $dumped_md5 = md5_file($file_path);
1026  if ($dumped_md5 != $file_sum) {
1027    new PwgError(500, '[add_file] '.$type.' transfer failed');
1028    exit();
1029  }
1030
1031  list($width, $height) = getimagesize($file_path);
1032  $filesize = floor(filesize($file_path)/1024);
1033
1034  return array(
1035    'width' => $width,
1036    'height' => $height,
1037    'filesize' => $filesize,
1038    );
1039}
1040
1041function ws_images_add($params, &$service)
1042{
1043  global $conf;
1044  if (!is_admin() || is_adviser() )
1045  {
1046    return new PwgError(401, 'Access denied');
1047  }
1048
1049  foreach ($params as $param_key => $param_value) {
1050    ws_logfile(
1051      sprintf(
1052        '[pwg.images.add] input param "%s" : "%s"',
1053        $param_key,
1054        is_null($param_value) ? 'NULL' : $param_value
1055        )
1056      );
1057  }
1058
1059  // does the image already exists ?
1060  $query = '
1061SELECT
1062    COUNT(*) AS counter
1063  FROM '.IMAGES_TABLE.'
1064  WHERE md5sum = \''.$params['original_sum'].'\'
1065;';
1066  list($counter) = mysql_fetch_row(pwg_query($query));
1067  if ($counter != 0) {
1068    return new PwgError(500, 'file already exists');
1069  }
1070
1071  // current date
1072  list($dbnow) = mysql_fetch_row(pwg_query('SELECT NOW();'));
1073  list($year, $month, $day) = preg_split('/[^\d]/', $dbnow, 4);
1074
1075  // upload directory hierarchy
1076  $upload_dir = sprintf(
1077    PHPWG_ROOT_PATH.'upload/%s/%s/%s',
1078    $year,
1079    $month,
1080    $day
1081    );
1082
1083  // compute file path
1084  $date_string = preg_replace('/[^\d]/', '', $dbnow);
1085  $random_string = substr($params['file_sum'], 0, 8);
1086  $filename_wo_ext = $date_string.'-'.$random_string;
1087  $file_path = $upload_dir.'/'.$filename_wo_ext.'.jpg';
1088
1089  // add files
1090  $file_infos  = add_file($file_path, 'file',  $params['original_sum'], $params['file_sum']);
1091  $thumb_infos = add_file($file_path, 'thumb', $params['original_sum'], $params['thumbnail_sum']);
1092
1093  if (isset($params['high_sum']))
1094  {
1095    $high_infos = add_file($file_path, 'high', $params['original_sum'], $params['high_sum']);
1096  }
1097
1098  // database registration
1099  $insert = array(
1100    'file' => $filename_wo_ext.'.jpg',
1101    'date_available' => $dbnow,
1102    'tn_ext' => 'jpg',
1103    'name' => $params['name'],
1104    'path' => $file_path,
1105    'filesize' => $file_infos['filesize'],
1106    'width' => $file_infos['width'],
1107    'height' => $file_infos['height'],
1108    'md5sum' => $params['original_sum'],
1109    );
1110
1111  $info_columns = array(
1112    'name',
1113    'author',
1114    'comment',
1115    'level',
1116    'date_creation',
1117    );
1118
1119  foreach ($info_columns as $key)
1120  {
1121    if (isset($params[$key]))
1122    {
1123      $insert[$key] = $params[$key];
1124    }
1125  }
1126
1127  if (isset($params['high_sum']))
1128  {
1129    $insert['has_high'] = 'true';
1130    $insert['high_filesize'] = $high_infos['filesize'];
1131  }
1132
1133  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1134  mass_inserts(
1135    IMAGES_TABLE,
1136    array_keys($insert),
1137    array($insert)
1138    );
1139
1140  $image_id = mysql_insert_id();
1141
1142  // let's add links between the image and the categories
1143  if (isset($params['categories']))
1144  {
1145    ws_add_image_category_relations($image_id, $params['categories']);
1146  }
1147
1148  // and now, let's create tag associations
1149  if (isset($params['tag_ids']) and !empty($params['tag_ids']))
1150  {
1151    set_tags(
1152      explode(',', $params['tag_ids']),
1153      $image_id
1154      );
1155  }
1156
1157  invalidate_user_cache();
1158}
1159
1160/**
1161 * perform a login (web service method)
1162 */
1163function ws_session_login($params, &$service)
1164{
1165  global $conf;
1166
1167  if (!$service->isPost())
1168  {
1169    return new PwgError(405, "This method requires HTTP POST");
1170  }
1171  if (try_log_user($params['username'], $params['password'],false))
1172  {
1173    return true;
1174  }
1175  return new PwgError(999, 'Invalid username/password');
1176}
1177
1178
1179/**
1180 * performs a logout (web service method)
1181 */
1182function ws_session_logout($params, &$service)
1183{
1184  if (!is_a_guest())
1185  {
1186    logout_user();
1187  }
1188  return true;
1189}
1190
1191function ws_session_getStatus($params, &$service)
1192{
1193  global $user;
1194  $res = array();
1195  $res['username'] = is_a_guest() ? 'guest' : $user['username'];
1196  foreach ( array('status', 'template', 'theme', 'language') as $k )
1197  {
1198    $res[$k] = $user[$k];
1199  }
1200  $res['charset'] = get_pwg_charset();
1201  return $res;
1202}
1203
1204
1205/**
1206 * returns a list of tags (web service method)
1207 */
1208function ws_tags_getList($params, &$service)
1209{
1210  $tags = get_available_tags();
1211  if ($params['sort_by_counter'])
1212  {
1213    usort($tags, create_function('$a,$b', 'return -$a["counter"]+$b["counter"];') );
1214  }
1215  else
1216  {
1217    usort($tags, 'tag_alpha_compare');
1218  }
1219  for ($i=0; $i<count($tags); $i++)
1220  {
1221    $tags[$i]['id'] = (int)$tags[$i]['id'];
1222    $tags[$i]['counter'] = (int)$tags[$i]['counter'];
1223    $tags[$i]['url'] = make_index_url(
1224        array(
1225          'section'=>'tags',
1226          'tags'=>array($tags[$i])
1227        )
1228      );
1229  }
1230  return array('tags' => new PwgNamedArray($tags, 'tag', array('id','url_name','url', 'name', 'counter' )) );
1231}
1232
1233/**
1234 * returns the list of tags as you can see them in administration (web
1235 * service method).
1236 *
1237 * Only admin can run this method and permissions are not taken into
1238 * account.
1239 */
1240function ws_tags_getAdminList($params, &$service)
1241{
1242  if (!is_admin())
1243  {
1244    return new PwgError(401, 'Access denied');
1245  }
1246
1247  $tags = get_all_tags();
1248  return array(
1249    'tags' => new PwgNamedArray(
1250      $tags,
1251      'tag',
1252      array(
1253        'name',
1254        'id',
1255        'url_name',
1256        )
1257      )
1258    );
1259}
1260
1261/**
1262 * returns a list of images for tags (web service method)
1263 */
1264function ws_tags_getImages($params, &$service)
1265{
1266  @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1267  global $conf;
1268
1269  // first build all the tag_ids we are interested in
1270  $params['tag_id'] = array_map( 'intval',$params['tag_id'] );
1271  $tags = find_tags($params['tag_id'], $params['tag_url_name'], $params['tag_name']);
1272  $tags_by_id = array();
1273  foreach( $tags as $tag )
1274  {
1275    $tags['id'] = (int)$tag['id'];
1276    $tags_by_id[ $tag['id'] ] = $tag;
1277  }
1278  unset($tags);
1279  $tag_ids = array_keys($tags_by_id);
1280
1281
1282  $image_ids = array();
1283  $image_tag_map = array();
1284
1285  if ( !empty($tag_ids) )
1286  { // build list of image ids with associated tags per image
1287    if ($params['tag_mode_and'])
1288    {
1289      $image_ids = get_image_ids_for_tags( $tag_ids );
1290    }
1291    else
1292    {
1293      $query = '
1294SELECT image_id, GROUP_CONCAT(tag_id) tag_ids
1295  FROM '.IMAGE_TAG_TABLE.'
1296  WHERE tag_id IN ('.implode(',',$tag_ids).')
1297  GROUP BY image_id';
1298      $result = pwg_query($query);
1299      while ( $row=mysql_fetch_assoc($result) )
1300      {
1301        $row['image_id'] = (int)$row['image_id'];
1302        array_push( $image_ids, $row['image_id'] );
1303        $image_tag_map[ $row['image_id'] ] = explode(',', $row['tag_ids']);
1304      }
1305    }
1306  }
1307
1308  $images = array();
1309  if ( !empty($image_ids))
1310  {
1311    $where_clauses = ws_std_image_sql_filter($params);
1312    $where_clauses[] = get_sql_condition_FandF(
1313        array
1314          (
1315            'forbidden_categories' => 'category_id',
1316            'visible_categories' => 'category_id',
1317            'visible_images' => 'i.id'
1318          ),
1319        '', true
1320      );
1321    $where_clauses[] = 'id IN ('.implode(',',$image_ids).')';
1322
1323    $order_by = ws_std_image_sql_order($params);
1324    if (empty($order_by))
1325    {
1326      $order_by = $conf['order_by'];
1327    }
1328    else
1329    {
1330      $order_by = 'ORDER BY '.$order_by;
1331    }
1332
1333    $query = '
1334SELECT DISTINCT i.* FROM '.IMAGES_TABLE.' i
1335  INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON i.id=image_id
1336  WHERE '. implode('
1337    AND ', $where_clauses).'
1338'.$order_by.'
1339LIMIT '.(int)($params['per_page']*$params['page']).','.(int)$params['per_page'];
1340
1341    $result = pwg_query($query);
1342    while ($row = mysql_fetch_assoc($result))
1343    {
1344      $image = array();
1345      foreach ( array('id', 'width', 'height', 'hit') as $k )
1346      {
1347        if (isset($row[$k]))
1348        {
1349          $image[$k] = (int)$row[$k];
1350        }
1351      }
1352      foreach ( array('file', 'name', 'comment') as $k )
1353      {
1354        $image[$k] = $row[$k];
1355      }
1356      $image = array_merge( $image, ws_std_get_urls($row) );
1357
1358      $image_tag_ids = ($params['tag_mode_and']) ? $tag_ids : $image_tag_map[$image['id']];
1359      $image_tags = array();
1360      foreach ($image_tag_ids as $tag_id)
1361      {
1362        $url = make_index_url(
1363                 array(
1364                  'section'=>'tags',
1365                  'tags'=> array($tags_by_id[$tag_id])
1366                )
1367              );
1368        $page_url = make_picture_url(
1369                 array(
1370                  'section'=>'tags',
1371                  'tags'=> array($tags_by_id[$tag_id]),
1372                  'image_id' => $row['id'],
1373                  'image_file' => $row['file'],
1374                )
1375              );
1376        array_push($image_tags, array(
1377                'id' => (int)$tag_id,
1378                'url' => $url,
1379                'page_url' => $page_url,
1380              )
1381            );
1382      }
1383      $image['tags'] = new PwgNamedArray($image_tags, 'tag',
1384              array('id','url_name','url','page_url')
1385            );
1386      array_push($images, $image);
1387    }
1388  }
1389
1390  return array( 'images' =>
1391    array (
1392      WS_XML_ATTRIBUTES =>
1393        array(
1394            'page' => $params['page'],
1395            'per_page' => $params['per_page'],
1396            'count' => count($images)
1397          ),
1398       WS_XML_CONTENT => new PwgNamedArray($images, 'image',
1399          ws_std_get_image_xml_attributes() )
1400      )
1401    );
1402}
1403
1404function ws_categories_add($params, &$service)
1405{
1406  if (!is_admin() or is_adviser())
1407  {
1408    return new PwgError(401, 'Access denied');
1409  }
1410
1411  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1412
1413  $creation_output = create_virtual_category(
1414    $params['name'],
1415    $params['parent']
1416    );
1417
1418  if (isset($creation_output['error']))
1419  {
1420    return new PwgError(500, $creation_output['error']);
1421  }
1422
1423  invalidate_user_cache();
1424
1425  return $creation_output;
1426}
1427
1428function ws_tags_add($params, &$service)
1429{
1430  if (!is_admin() or is_adviser())
1431  {
1432    return new PwgError(401, 'Access denied');
1433  }
1434
1435  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1436
1437  $creation_output = create_tag($params['name']);
1438
1439  if (isset($creation_output['error']))
1440  {
1441    return new PwgError(500, $creation_output['error']);
1442  }
1443
1444  return $creation_output;
1445}
1446
1447function ws_images_exist($params, &$service)
1448{
1449  if (!is_admin() or is_adviser())
1450  {
1451    return new PwgError(401, 'Access denied');
1452  }
1453
1454  // search among photos the list of photos already added, based on md5sum
1455  // list
1456  $md5sums = preg_split(
1457    '/[\s,;\|]/',
1458    $params['md5sum_list'],
1459    -1,
1460    PREG_SPLIT_NO_EMPTY
1461    );
1462
1463  $query = '
1464SELECT
1465    id,
1466    md5sum
1467  FROM '.IMAGES_TABLE.'
1468  WHERE md5sum IN (\''.implode("','", $md5sums).'\')
1469;';
1470  $id_of_md5 = simple_hash_from_query($query, 'md5sum', 'id');
1471
1472  $result = array();
1473
1474  foreach ($md5sums as $md5sum)
1475  {
1476    $result[$md5sum] = null;
1477    if (isset($id_of_md5[$md5sum]))
1478    {
1479      $result[$md5sum] = $id_of_md5[$md5sum];
1480    }
1481  }
1482
1483  return $result;
1484}
1485
1486function ws_images_checkFiles($params, &$service)
1487{
1488  if (!is_admin() or is_adviser())
1489  {
1490    return new PwgError(401, 'Access denied');
1491  }
1492
1493  // input parameters
1494  //
1495  // image_id
1496  // thumbnail_sum
1497  // file_sum
1498  // high_sum
1499
1500  $params['image_id'] = (int)$params['image_id'];
1501  if ($params['image_id'] <= 0)
1502  {
1503    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1504  }
1505
1506  $query = '
1507SELECT
1508    path
1509  FROM '.IMAGES_TABLE.'
1510  WHERE id = '.$params['image_id'].'
1511;';
1512  $result = pwg_query($query);
1513  if (mysql_num_rows($result) == 0) {
1514    return new PwgError(404, "image_id not found");
1515  }
1516  list($path) = mysql_fetch_row($result);
1517
1518  $ret = array();
1519
1520  foreach (array('thumb', 'file', 'high') as $type) {
1521    $param_name = $type;
1522    if ('thumb' == $type) {
1523      $param_name = 'thumbnail';
1524    }
1525
1526    if (isset($params[$param_name.'_sum'])) {
1527      $type_path = file_path_for_type($path, $type);
1528      if (!is_file($type_path)) {
1529        $ret[$param_name] = 'missing';
1530      }
1531      else {
1532        if (md5_file($type_path) != $params[$param_name.'_sum']) {
1533          $ret[$param_name] = 'differs';
1534        }
1535        else {
1536          $ret[$param_name] = 'equals';
1537        }
1538      }
1539    }
1540  }
1541
1542  return $ret;
1543}
1544
1545function file_path_for_type($file_path, $type='thumb')
1546{
1547  // resolve the $file_path depending on the $type
1548  if ('thumb' == $type) {
1549    $file_path = get_thumbnail_location(
1550      array(
1551        'path' => $file_path,
1552        'tn_ext' => 'jpg',
1553        )
1554      );
1555  }
1556
1557  if ('high' == $type) {
1558    @include_once(PHPWG_ROOT_PATH.'include/functions_picture.inc.php');
1559    $file_path = get_high_location(
1560      array(
1561        'path' => $file_path,
1562        'has_high' => 'true'
1563        )
1564      );
1565  }
1566
1567  return $file_path;
1568}
1569
1570function ws_images_setInfo($params, &$service)
1571{
1572  global $conf;
1573  if (!is_admin() || is_adviser() )
1574  {
1575    return new PwgError(401, 'Access denied');
1576  }
1577
1578  // name
1579  // category_id
1580  // file_content
1581  // file_sum
1582  // thumbnail_content
1583  // thumbnail_sum
1584
1585  $params['image_id'] = (int)$params['image_id'];
1586  if ($params['image_id'] <= 0)
1587  {
1588    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid image_id");
1589  }
1590
1591  $query='
1592SELECT *
1593  FROM '.IMAGES_TABLE.'
1594  WHERE id = '.$params['image_id'].'
1595;';
1596
1597  $image_row = mysql_fetch_assoc(pwg_query($query));
1598  if ($image_row == null)
1599  {
1600    return new PwgError(404, "image_id not found");
1601  }
1602
1603  // database registration
1604  $update = array(
1605    'id' => $params['image_id'],
1606    );
1607
1608  $info_columns = array(
1609    'name',
1610    'author',
1611    'comment',
1612    'level',
1613    'date_creation',
1614    );
1615
1616  $perform_update = false;
1617  foreach ($info_columns as $key)
1618  {
1619    if (isset($params[$key]))
1620    {
1621      $perform_update = true;
1622      $update[$key] = $params[$key];
1623    }
1624  }
1625
1626  if ($perform_update)
1627  {
1628    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1629    mass_updates(
1630      IMAGES_TABLE,
1631      array(
1632        'primary' => array('id'),
1633        'update'  => array_diff(array_keys($update), array('id'))
1634        ),
1635      array($update)
1636      );
1637  }
1638
1639  if (isset($params['categories']))
1640  {
1641    ws_add_image_category_relations(
1642      $params['image_id'],
1643      $params['categories']
1644      );
1645  }
1646
1647  // and now, let's create tag associations
1648  if (isset($params['tag_ids']))
1649  {
1650    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1651    add_tags(
1652      explode(',', $params['tag_ids']),
1653      array($params['image_id'])
1654      );
1655  }
1656
1657  invalidate_user_cache();
1658}
1659
1660function ws_add_image_category_relations($image_id, $categories_string)
1661{
1662  // let's add links between the image and the categories
1663  //
1664  // $params['categories'] should look like 123,12;456,auto;789 which means:
1665  //
1666  // 1. associate with category 123 on rank 12
1667  // 2. associate with category 456 on automatic rank
1668  // 3. associate with category 789 on automatic rank
1669  $cat_ids = array();
1670  $rank_on_category = array();
1671  $search_current_ranks = false;
1672
1673  $tokens = explode(';', $categories_string);
1674  foreach ($tokens as $token)
1675  {
1676    @list($cat_id, $rank) = explode(',', $token);
1677
1678    array_push($cat_ids, $cat_id);
1679
1680    if (!isset($rank))
1681    {
1682      $rank = 'auto';
1683    }
1684    $rank_on_category[$cat_id] = $rank;
1685
1686    if ($rank == 'auto')
1687    {
1688      $search_current_ranks = true;
1689    }
1690  }
1691
1692  $cat_ids = array_unique($cat_ids);
1693
1694  if (count($cat_ids) > 0)
1695  {
1696    if ($search_current_ranks)
1697    {
1698      $query = '
1699SELECT
1700    category_id,
1701    MAX(rank) AS max_rank
1702  FROM '.IMAGE_CATEGORY_TABLE.'
1703  WHERE rank IS NOT NULL
1704    AND category_id IN ('.implode(',', $cat_ids).')
1705  GROUP BY category_id
1706;';
1707      $current_rank_of = simple_hash_from_query(
1708        $query,
1709        'category_id',
1710        'max_rank'
1711        );
1712
1713      foreach ($cat_ids as $cat_id)
1714      {
1715        if (!isset($current_rank_of[$cat_id]))
1716        {
1717          $current_rank_of[$cat_id] = 0;
1718        }
1719
1720        if ('auto' == $rank_on_category[$cat_id])
1721        {
1722          $rank_on_category[$cat_id] = $current_rank_of[$cat_id] + 1;
1723        }
1724      }
1725    }
1726
1727    $inserts = array();
1728
1729    foreach ($cat_ids as $cat_id)
1730    {
1731      array_push(
1732        $inserts,
1733        array(
1734          'image_id' => $image_id,
1735          'category_id' => $cat_id,
1736          'rank' => $rank_on_category[$cat_id],
1737          )
1738        );
1739    }
1740
1741    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1742    mass_inserts(
1743      IMAGE_CATEGORY_TABLE,
1744      array_keys($inserts[0]),
1745      $inserts
1746      );
1747
1748    update_category($cat_ids);
1749  }
1750}
1751
1752function ws_categories_setInfo($params, &$service)
1753{
1754  global $conf;
1755  if (!is_admin() || is_adviser() )
1756  {
1757    return new PwgError(401, 'Access denied');
1758  }
1759
1760  // category_id
1761  // name
1762  // comment
1763
1764  $params['category_id'] = (int)$params['category_id'];
1765  if ($params['category_id'] <= 0)
1766  {
1767    return new PwgError(WS_ERR_INVALID_PARAM, "Invalid category_id");
1768  }
1769
1770  // database registration
1771  $update = array(
1772    'id' => $params['category_id'],
1773    );
1774
1775  $info_columns = array(
1776    'name',
1777    'comment',
1778    );
1779
1780  $perform_update = false;
1781  foreach ($info_columns as $key)
1782  {
1783    if (isset($params[$key]))
1784    {
1785      $perform_update = true;
1786      $update[$key] = $params[$key];
1787    }
1788  }
1789
1790  if ($perform_update)
1791  {
1792    include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
1793    mass_updates(
1794      CATEGORIES_TABLE,
1795      array(
1796        'primary' => array('id'),
1797        'update'  => array_diff(array_keys($update), array('id'))
1798        ),
1799      array($update)
1800      );
1801  }
1802 
1803}
1804
1805function ws_logfile($string)
1806{
1807  global $conf;
1808
1809  if (!$conf['ws_enable_log']) {
1810    return true;
1811  }
1812 
1813  file_put_contents(
1814    $conf['ws_log_filepath'],
1815    '['.date('c').'] '.$string."\n",
1816    FILE_APPEND
1817    );
1818}
1819?>
Note: See TracBrowser for help on using the repository browser.