addMethod('pwg.getVersion', 'ws_getVersion', null, 'retrieves the PWG version'); $service->addMethod('pwg.getInfos', 'ws_getInfos', null, 'retrieves general informations'); $service->addMethod('pwg.caddie.add', 'ws_caddie_add', array( 'image_id'=> array( 'flags'=>WS_PARAM_FORCE_ARRAY ), ), 'adds the elements to the caddie'); $service->addMethod('pwg.categories.getImages', 'ws_categories_getImages', array( 'cat_id'=>array('default'=>0, 'flags'=>WS_PARAM_FORCE_ARRAY), 'recursive'=>array('default'=>false), 'per_page' => array('default'=>100, 'maxValue'=>$conf['ws_max_images_per_page']), 'page' => array('default'=>0), 'order' => array('default'=>null), 'f_min_rate' => array( 'default'=> null ), 'f_max_rate' => array( 'default'=> null ), 'f_min_hit' => array( 'default'=> null ), 'f_max_hit' => array( 'default'=> null ), 'f_min_date_available' => array( 'default'=> null ), 'f_max_date_available' => array( 'default'=> null ), 'f_min_date_created' => array( 'default'=> null ), 'f_max_date_created' => array( 'default'=> null ), 'f_min_ratio' => array( 'default'=> null ), 'f_max_ratio' => array( 'default'=> null ), 'f_with_thumbnail' => array( 'default'=> false ), ), 'Returns elements for the corresponding categories.
cat_id can be empty if recursive is true. Can be sent as an array.
order comma separated fields for sorting (file,id, average_rate,...)' ); $service->addMethod('pwg.categories.getList', 'ws_categories_getList', array( 'cat_id' => array('default'=>0), 'recursive' => array('default'=>false), 'public' => array('default'=>false), ), 'retrieves a list of categories' ); $service->addMethod('pwg.images.addComment', 'ws_images_addComment', array( 'image_id' => array(), 'author' => array( 'default' => is_a_guest()? 'guest':$user['username']), 'content' => array(), 'key' => array(), ), 'add a comment to an image' ); $service->addMethod('pwg.images.getInfo', 'ws_images_getInfo', array( 'image_id' => array(), 'comments_page' => array('default'=>0 ), 'comments_per_page' => array( 'default' => $conf['nb_comment_page'], 'maxValue' => 2*$conf['nb_comment_page'], ), ), 'retrieves information about the given photo' ); $service->addMethod('pwg.images.rate', 'ws_images_rate', array( 'image_id' => array(), 'rate' => array(), ), 'rate the image' ); $service->addMethod('pwg.images.search', 'ws_images_search', array( 'query'=>array(), 'per_page' => array('default'=>100, 'maxValue'=>$conf['ws_max_images_per_page']), 'page' => array('default'=>0), 'order' => array('default'=>null), 'f_min_rate' => array( 'default'=> null ), 'f_max_rate' => array( 'default'=> null ), 'f_min_hit' => array( 'default'=> null ), 'f_max_hit' => array( 'default'=> null ), 'f_min_date_available' => array( 'default'=> null ), 'f_max_date_available' => array( 'default'=> null ), 'f_min_date_created' => array( 'default'=> null ), 'f_max_date_created' => array( 'default'=> null ), 'f_min_ratio' => array( 'default'=> null ), 'f_max_ratio' => array( 'default'=> null ), 'f_with_thumbnail' => array( 'default'=> false ), ), 'Returns elements for the corresponding query search.' ); $service->addMethod( 'pwg.images.setPrivacyLevel', 'ws_images_setPrivacyLevel', array( 'image_id' => array('flags'=>WS_PARAM_FORCE_ARRAY), 'level' => array('maxValue'=>$conf['available_permission_levels']), ), 'sets the privacy levels for the images (POST method only)' ); $service->addMethod('pwg.session.getStatus', 'ws_session_getStatus', null, '' ); $service->addMethod('pwg.session.login', 'ws_session_login', array('username', 'password'), 'POST method only' ); $service->addMethod('pwg.session.logout', 'ws_session_logout', null, ''); $service->addMethod('pwg.tags.getList', 'ws_tags_getList', array('sort_by_counter' => array('default' =>false) ), 'retrieves a list of available tags'); $service->addMethod('pwg.tags.getImages', 'ws_tags_getImages', array( 'tag_id'=>array('default'=>null, 'flags'=>WS_PARAM_FORCE_ARRAY ), 'tag_url_name'=>array('default'=>null, 'flags'=>WS_PARAM_FORCE_ARRAY ), 'tag_name'=>array('default'=>null, 'flags'=>WS_PARAM_FORCE_ARRAY ), 'tag_mode_and'=>array('default'=>false), 'per_page' => array('default'=>100, 'maxValue'=>$conf['ws_max_images_per_page']), 'page' => array('default'=>0), 'order' => array('default'=>null), 'f_min_rate' => array( 'default'=> null ), 'f_max_rate' => array( 'default'=> null ), 'f_min_hit' => array( 'default'=> null ), 'f_max_hit' => array( 'default'=> null ), 'f_min_date_available' => array( 'default'=> null ), 'f_max_date_available' => array( 'default'=> null ), 'f_min_date_created' => array( 'default'=> null ), 'f_max_date_created' => array( 'default'=> null ), 'f_min_ratio' => array( 'default'=> null ), 'f_max_ratio' => array( 'default'=> null ), 'f_with_thumbnail' => array( 'default'=> false ), ), 'Returns elements for the corresponding tags. Note that tag_id, tag_url_name, tag_name an be arrays. Fill at least one of them. ' ); $service->addMethod( 'pwg.images.addChunk', 'ws_images_add_chunk', array( 'data' => array(), 'original_sum' => array(), 'type' => array(), 'position' => array(), ), 'POST method only. For admin only.' ); $service->addMethod( 'pwg.images.addFile', 'ws_images_addFile', array( 'image_id' => array(), 'type' => array(), 'sum' => array(), ), 'Add or update a file for an existing photo. pwg.images.addChunk must have been called before (maybe several times)' ); $service->addMethod( 'pwg.images.add', 'ws_images_add', array( 'file_sum' => array(), 'thumbnail_sum' => array(), 'high_sum' => array('default' => null), 'original_sum' => array(), 'original_filename' => array('default' => null), 'name' => array('default' => null), 'author' => array('default' => null), 'date_creation' => array('default' => null), 'comment' => array('default' => null), 'categories' => array('default' => null), 'tag_ids' => array('default' => null), 'level' => array( 'default' => 0, 'maxValue' => $conf['available_permission_levels'] ), ), 'POST method only.
categories is a string list "category_id[,rank];category_id[,rank]" The rank is optional and is equivalent to "auto" if not given.' ); $service->addMethod( 'pwg.images.addSimple', 'ws_images_addSimple', array( 'category' => array('default' => null), 'name' => array('default' => null), 'author' => array('default' => null), 'comment' => array('default' => null), 'level' => array( 'default' => 0, 'maxValue' => $conf['available_permission_levels'] ), 'tags' => array('default' => null), 'image_id' => array('default' => null), ), 'POST method only.
Use the image field for uploading file.
Set the form encoding to "form-data"
category is the numeric identifier of the destination category.
You can update an existing photo if you define an existing image_id.' ); $service->addMethod( 'pwg.images.delete', 'ws_images_delete', array( 'image_id'=>array('default'=>0), 'pwg_token' => array('default' => null), ), 'Delete photos. You can give several image_ids, comma separated' ); $service->addMethod( 'pwg.categories.getAdminList', 'ws_categories_getAdminList', array(), 'administration method only' ); $service->addMethod( 'pwg.categories.add', 'ws_categories_add', array( 'name' => array(), 'parent' => array('default' => null), ), 'administration method only' ); $service->addMethod( 'pwg.categories.delete', 'ws_categories_delete', array( 'category_id'=>array('default'=>0), 'pwg_token' => array('default' => null), 'photo_deletion_mode' => array('default' => 'delete_orphans'), ), 'Delete categories. You can give several category_ids, comma separated.
photo_deletion_mode can be "no_delete" (may create orphan photos), "delete_orphans" (default mode, only deletes photos linked to no other album) or "force_delete" (delete all photos, even those linked to other albums)' ); $service->addMethod( 'pwg.categories.move', 'ws_categories_move', array( 'category_id'=>array('default'=>0), 'parent'=>array('default'=>0), 'pwg_token' => array('default' => null), ), 'Move categories. You can give several category_ids, comma separated. Set parent as 0 to move to gallery root. Only virtual categories can be moved.' ); $service->addMethod( 'pwg.tags.getAdminList', 'ws_tags_getAdminList', array(), 'administration method only' ); $service->addMethod( 'pwg.tags.add', 'ws_tags_add', array( 'name' => array(), ), 'administration method only' ); $service->addMethod( 'pwg.images.exist', 'ws_images_exist', array( 'md5sum_list'=> array('default' => null), 'filename_list' => array('default' => null), ), 'check existence of a photo list' ); $service->addMethod( 'pwg.images.checkFiles', 'ws_images_checkFiles', array( 'image_id' => array(), 'thumbnail_sum' => array('default' => null), 'file_sum' => array('default' => null), 'high_sum' => array('default' => null), ), 'check if you have updated version of your files for a given photo, for each requested file type, the answer can be "missing", "equals" or "differs"' ); $service->addMethod( 'pwg.images.checkUpload', 'ws_images_checkUpload', null, 'check if Piwigo is ready for upload' ); $service->addMethod( 'pwg.images.setInfo', 'ws_images_setInfo', array( 'image_id' => array(), 'name' => array('default' => null), 'author' => array('default' => null), 'date_creation' => array('default' => null), 'comment' => array('default' => null), 'categories' => array('default' => null), 'tag_ids' => array('default' => null), 'level' => array( 'default' => 0, 'maxValue' => $conf['available_permission_levels'] ), 'single_value_mode' => array('default' => 'fill_if_empty'), 'multiple_value_mode' => array('default' => 'append'), ), 'POST method only. Admin only
categories is a string list "category_id[,rank];category_id[,rank]" The rank is optional and is equivalent to "auto" if not given.
single_value_mode can be "fill_if_empty" (only use the input value if the corresponding values is currently empty) or "replace" (overwrite any existing value) and applies to single values properties like name/author/date_creation/comment
multiple_value_mode can be "append" (no change on existing values, add the new values) or "replace" and applies to multiple values properties like tag_ids/categories' ); $service->addMethod( 'pwg.categories.setInfo', 'ws_categories_setInfo', array( 'category_id' => array(), 'name' => array('default' => null), 'comment' => array('default' => null), ), 'POST method only.' ); $service->addMethod( 'pwg.plugins.getList', 'ws_plugins_getList', array(), 'get the list of plugin with id, name, version, state and description
administration status required' ); $service->addMethod( 'pwg.plugins.performAction', 'ws_plugins_performAction', array( 'action' => array('default' => null), 'plugin' => array('default' => null), 'pwg_token' => array('default' => null), ), 'install/activate/deactivate/uninstall/delete a plugin
administration status required' ); $service->addMethod( 'pwg.themes.performAction', 'ws_themes_performAction', array( 'action' => array('default' => null), 'themes' => array('default' => null), 'pwg_token' => array('default' => null), ), 'activate/deactivate/delete/set_default a theme
administration status required' ); $service->addMethod( 'pwg.images.resize', 'ws_images_resize', array( 'image_id' => array(), 'type' => array('default' => 'thumbnail'), 'maxwidth' => array('default' => null), 'maxheight' => array('default' => null), 'quality' => array('default' => null), ), 'Regenerate thumbnails or websize photo with given arguments.
Argument "type" can be "thumbnail" or "websize". Default is "thumbnail".
If maxwidth, maxheight or quality are missing, default parameters of upload will be used.' ); } add_event_handler('ws_add_methods', 'ws_addDefaultMethods'); add_event_handler('ws_invoke_allowed', 'ws_isInvokeAllowed', EVENT_HANDLER_PRIORITY_NEUTRAL, 3); $requestFormat = null; $responseFormat = null; if ( isset($_GET['format']) ) { $responseFormat = $_GET['format']; } if ( isset($HTTP_RAW_POST_DATA) ) { $HTTP_RAW_POST_DATA = trim($HTTP_RAW_POST_DATA); if ( strncmp($HTTP_RAW_POST_DATA, 'setHandler($requestFormat, $handler); } if (!is_null($responseFormat)) { $encoder = null; switch ($responseFormat) { case 'rest': include_once(PHPWG_ROOT_PATH.'include/ws_protocols/rest_encoder.php'); $encoder = new PwgRestEncoder(); break; case 'php': include_once(PHPWG_ROOT_PATH.'include/ws_protocols/php_encoder.php'); $encoder = new PwgSerialPhpEncoder(); break; case 'json': include_once(PHPWG_ROOT_PATH.'include/ws_protocols/json_encoder.php'); $encoder = new PwgJsonEncoder(); break; case 'xmlrpc': include_once(PHPWG_ROOT_PATH.'include/ws_protocols/xmlrpc_encoder.php'); $encoder = new PwgXmlRpcEncoder(); break; } $service->setEncoder($responseFormat, $encoder); } set_make_full_url(); $service->run(); ?>