source: trunk/ws.php @ 2429

Last change on this file since 2429 was 2429, checked in by rvelices, 16 years ago
  • add to caddie on picture page done through ajax
  • Property svn:eol-style set to LF
  • Property svn:keywords set to Author Date Id Revision
File size: 9.2 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based picture gallery                                  |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008      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
24define ('PHPWG_ROOT_PATH', './');
25
26include_once(PHPWG_ROOT_PATH.'include/common.inc.php');
27check_status(ACCESS_FREE);
28include_once(PHPWG_ROOT_PATH.'include/ws_core.inc.php');
29
30if ( !$conf['allow_web_services'] )
31{
32  page_forbidden('Web services are disabled');
33}
34
35/**
36 * event handler that registers standard methods with the web service
37 */
38function ws_addDefaultMethods( $arr )
39{
40  include_once(PHPWG_ROOT_PATH.'include/ws_functions.inc.php');
41  global $conf, $user;
42  $service = &$arr[0];
43  $service->addMethod('pwg.getVersion', 'ws_getVersion', null,
44      'retrieves the PWG version');
45
46  $service->addMethod('pwg.caddie.add', 'ws_caddie_add', 
47      array(
48        'image_id'=> array( 'flags'=>WS_PARAM_FORCE_ARRAY ),
49      ),
50      'adds the elements to the caddie');
51
52  $service->addMethod('pwg.categories.getImages', 'ws_categories_getImages',
53      array(
54        'cat_id'=>array('default'=>0, 'flags'=>WS_PARAM_FORCE_ARRAY),
55        'recursive'=>array('default'=>false),
56        'per_page' => array('default'=>100, 'maxValue'=>$conf['ws_max_images_per_page']),
57        'page' => array('default'=>0),
58        'order' => array('default'=>null),
59        'f_min_rate' => array( 'default'=> null ),
60        'f_max_rate' => array( 'default'=> null ),
61        'f_min_hit' => array( 'default'=> null ),
62        'f_max_hit' => array( 'default'=> null ),
63        'f_min_date_available' => array( 'default'=> null ),
64        'f_max_date_available' => array( 'default'=> null ),
65        'f_min_date_created' => array( 'default'=> null ),
66        'f_max_date_created' => array( 'default'=> null ),
67        'f_min_ratio' => array( 'default'=> null ),
68        'f_max_ratio' => array( 'default'=> null ),
69        'f_with_thumbnail' => array( 'default'=> false ),
70      ),
71      'Returns elements for the corresponding categories.
72<br/><b>cat_id</b> can be empty if <b>recursive</b> is true. Can be sent as an array.
73<br/><b>order</b> comma separated fields for sorting (file,id, average_rate,...)'
74    );
75
76  $service->addMethod('pwg.categories.getList', 'ws_categories_getList',
77      array(
78        'cat_id' => array('default'=>0),
79        'recursive' => array('default'=>false),
80        'public' => array('default'=>false),
81      ),
82      'retrieves a list of categories' );
83
84  $service->addMethod('pwg.images.addComment', 'ws_images_addComment',
85      array(
86        'image_id' => array(),
87        'author' => array( 'default' => is_a_guest()? 'guest':$user['username']),
88        'content' => array(),
89        'key' => array(),
90      ),
91      'add a comment to an image' );
92
93  $service->addMethod('pwg.images.getInfo', 'ws_images_getInfo',
94      array(
95        'image_id' => array(),
96        'comments_page' => array('default'=>0 ),
97        'comments_per_page' => array( 
98              'default' => $conf['nb_comment_page'], 
99              'maxValue' => 2*$conf['nb_comment_page'],
100            ),
101      ),
102      'retrieves information about the given photo' );
103
104  $service->addMethod('pwg.images.search', 'ws_images_search',
105      array(
106        'query'=>array(),
107        'per_page' => array('default'=>100, 'maxValue'=>$conf['ws_max_images_per_page']),
108        'page' => array('default'=>0),
109        'order' => array('default'=>null),
110        'f_min_rate' => array( 'default'=> null ),
111        'f_max_rate' => array( 'default'=> null ),
112        'f_min_hit' => array( 'default'=> null ),
113        'f_max_hit' => array( 'default'=> null ),
114        'f_min_date_available' => array( 'default'=> null ),
115        'f_max_date_available' => array( 'default'=> null ),
116        'f_min_date_created' => array( 'default'=> null ),
117        'f_max_date_created' => array( 'default'=> null ),
118        'f_min_ratio' => array( 'default'=> null ),
119        'f_max_ratio' => array( 'default'=> null ),
120        'f_with_thumbnail' => array( 'default'=> false ),
121      ),
122      'Returns elements for the corresponding query search.'
123    );
124  $service->addMethod('pwg.images.setPrivacyLevel', 'ws_images_setPrivacyLevel',
125      array(
126        'image_id' => array('flags'=>WS_PARAM_FORCE_ARRAY),
127        'level' => array('maxValue'=>$conf['available_permission_levels']),
128      ),
129      'sets the privacy levels for the images' );
130
131  $service->addMethod('pwg.session.getStatus', 'ws_session_getStatus', null, '' );
132  $service->addMethod('pwg.session.login', 'ws_session_login',
133    array('username', 'password'),
134    'POST method only' );
135  $service->addMethod('pwg.session.logout', 'ws_session_logout', null, '');
136
137  $service->addMethod('pwg.tags.getList', 'ws_tags_getList',
138    array('sort_by_counter' => array('default' =>false) ),
139    'retrieves a list of available tags');
140  $service->addMethod('pwg.tags.getImages', 'ws_tags_getImages',
141      array(
142        'tag_id'=>array('default'=>null, 'flags'=>WS_PARAM_FORCE_ARRAY ),
143        'tag_url_name'=>array('default'=>null, 'flags'=>WS_PARAM_FORCE_ARRAY ),
144        'tag_name'=>array('default'=>null, 'flags'=>WS_PARAM_FORCE_ARRAY ),
145        'tag_mode_and'=>array('default'=>false),
146        'per_page' => array('default'=>100, 'maxValue'=>$conf['ws_max_images_per_page']),
147        'page' => array('default'=>0),
148        'order' => array('default'=>null),
149        'f_min_rate' => array( 'default'=> null ),
150        'f_max_rate' => array( 'default'=> null ),
151        'f_min_hit' => array( 'default'=> null ),
152        'f_max_hit' => array( 'default'=> null ),
153        'f_min_date_available' => array( 'default'=> null ),
154        'f_max_date_available' => array( 'default'=> null ),
155        'f_min_date_created' => array( 'default'=> null ),
156        'f_max_date_created' => array( 'default'=> null ),
157        'f_min_ratio' => array( 'default'=> null ),
158        'f_max_ratio' => array( 'default'=> null ),
159        'f_with_thumbnail' => array( 'default'=> false ),
160      ),
161      'Returns elements for the corresponding tags. Note that tag_id, tag_url_name, tag_name an be arrays. Fill at least one of them. '
162    );
163}
164
165add_event_handler('ws_add_methods', 'ws_addDefaultMethods');
166
167
168add_event_handler('ws_invoke_allowed', 'ws_isInvokeAllowed', EVENT_HANDLER_PRIORITY_NEUTRAL, 3);
169
170$calling_partner_id = '';
171$requestFormat = null;
172$responseFormat = null;
173
174if ( isset($_GET['partner']) )
175{
176  $calling_partner_id = $_GET['partner'];
177}
178if ( isset($_GET['format']) )
179{
180  $responseFormat = $_GET['format'];
181}
182
183if ( isset($HTTP_RAW_POST_DATA) )
184{
185  $HTTP_RAW_POST_DATA = trim($HTTP_RAW_POST_DATA);
186  if ( strncmp($HTTP_RAW_POST_DATA, '<?xml', 5) == 0 )
187  {
188  }
189  else
190  {
191    $requestFormat = "json";
192  }
193}
194else
195{
196  $requestFormat = "rest";
197}
198
199if ( !isset($responseFormat) and isset($requestFormat) )
200{
201  $responseFormat = $requestFormat;
202}
203
204$service = new PwgServer();
205
206if (!is_null($requestFormat))
207{
208  $handler = null;
209  switch ($requestFormat)
210  {
211    case 'rest':
212      include_once(PHPWG_ROOT_PATH.'include/ws_protocols/rest_handler.php');
213      $handler = new PwgRestRequestHandler();
214      break;
215  }
216  $service->setHandler($requestFormat, $handler);
217}
218
219if (!is_null($responseFormat))
220{
221  $encoder = null;
222  switch ($responseFormat)
223  {
224    case 'rest':
225      include_once(PHPWG_ROOT_PATH.'include/ws_protocols/rest_encoder.php');
226      $encoder = new PwgRestEncoder();
227      break;
228    case 'php':
229      include_once(PHPWG_ROOT_PATH.'include/ws_protocols/php_encoder.php');
230      $encoder = new PwgSerialPhpEncoder();
231      break;
232    case 'json':
233      include_once(PHPWG_ROOT_PATH.'include/ws_protocols/json_encoder.php');
234      $encoder = new PwgJsonEncoder();
235      break;
236    case 'xmlrpc':
237      include_once(PHPWG_ROOT_PATH.'include/ws_protocols/xmlrpc_encoder.php');
238      $encoder = new PwgXmlRpcEncoder();
239      break;
240  }
241  $service->setEncoder($responseFormat, $encoder);
242}
243
244set_make_full_url();
245$service->run();
246
247?>
Note: See TracBrowser for help on using the repository browser.