402 lines
13 KiB
PHP
402 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* @brief Gallery Images API
|
|
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
|
|
* @copyright (c) Invision Power Services, Inc.
|
|
* @license https://www.invisioncommunity.com/legal/standards/
|
|
* @package Invision Community
|
|
* @subpackage Gallery
|
|
* @since 8 Dec 2015
|
|
*/
|
|
|
|
namespace IPS\gallery\api;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* @brief Gallery Images API
|
|
*/
|
|
class _images extends \IPS\Content\Api\ItemController
|
|
{
|
|
/**
|
|
* Class
|
|
*/
|
|
protected $class = 'IPS\gallery\Image';
|
|
|
|
/**
|
|
* GET /gallery/images
|
|
* Get list of images
|
|
*
|
|
* @apiparam string categories Comma-delimited list of category IDs (will also include images in albums in those categories)
|
|
* @apiparam string albums Comma-delimited list of album IDs
|
|
* @apiparam string authors Comma-delimited list of member IDs - if provided, only images started by those members are returned
|
|
* @apiparam int locked If 1, only images which are locked are returned, if 0 only unlocked
|
|
* @apiparam int hidden If 1, only images which are hidden are returned, if 0 only not hidden
|
|
* @apiparam int featured If 1, only images which are featured are returned, if 0 only not featured
|
|
* @apiparam string sortBy What to sort by. Can be 'date' for creation date, 'title' or leave unspecified for ID
|
|
* @apiparam string sortDir Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
|
|
* @apiparam int page Page number
|
|
* @return \IPS\Api\PaginatedResponse<IPS\gallery\Image>
|
|
*/
|
|
public function GETindex()
|
|
{
|
|
/* Where clause */
|
|
$where = array();
|
|
|
|
/* Albums */
|
|
if ( isset( \IPS\Request::i()->albums ) )
|
|
{
|
|
$where[] = array( \IPS\Db::i()->in( 'image_album_id', array_filter( explode( ',', \IPS\Request::i()->albums ) ) ) );
|
|
}
|
|
|
|
/* Return */
|
|
return $this->_list( $where, 'categories' );
|
|
}
|
|
|
|
/**
|
|
* GET /gallery/images/{id}
|
|
* View information about a specific image
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 2G316/1 INVALID_ID The image ID does not exist
|
|
* @return \IPS\gallery\Image
|
|
*/
|
|
public function GETitem( $id )
|
|
{
|
|
try
|
|
{
|
|
return $this->_view( $id );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2G316/1', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* POST /gallery/images
|
|
* Upload an image
|
|
*
|
|
* @reqapiparam int album The ID number of the album the image should be created in - not required if category is provided (only provide one or the other)
|
|
* @reqapiparam int category The ID number of the category the image should be created in - not required if album is provided (only provide one or the other)
|
|
* @reqapiparam int author The ID number of the member uploading the image (0 for guest)
|
|
* @reqapiparam string caption The image caption
|
|
* @reqapiparam string filename The image filename (e.g. 'image.png')
|
|
* @reqapiparam string image The base64 encoded image contents
|
|
* @apiparam string description The description as HTML (e.g. "<p>This is an image.</p>")
|
|
* @apiparam string copyright The copyright
|
|
* @apiparam string credit The credit information
|
|
* @apiparam int gpsShow If the image contains the location in it's EXIF data, 1/0 indicating if a map should be shown (defaults to 1)
|
|
* @apiparam string prefix Prefix tag
|
|
* @apiparam string tags Comma-separated list of tags (do not include prefix)
|
|
* @apiparam datetime date The date/time that should be used for the image post date. If not provided, will use the current date/time
|
|
* @apiparam string ip_address The IP address that should be stored for the image. If not provided, will use the IP address from the API request
|
|
* @apiparam int locked 1/0 indicating if the image should be locked
|
|
* @apiparam int hidden 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)
|
|
* @apiparam int pinned 1/0 indicating if the image should be locked
|
|
* @apiparam int featured 1/0 indicating if the image should be featured
|
|
* @throws 1G316/2 NO_CATEGORY_OR_ALBUM The category or album does not exist
|
|
* @throws 1G316/3 NO_AUTHOR The author ID does not exist
|
|
* @throws 1G316/4 NO_CAPTION No caption was supplied
|
|
* @throws 1G316/5 NO_FILENAME No filename was supplied
|
|
* @throws 1G316/6 NO_IMAGE The image was invalid
|
|
* @return \IPS\gallery\Image
|
|
*/
|
|
public function POSTindex()
|
|
{
|
|
/* Get category or album */
|
|
if ( isset( \IPS\Request::i()->album ) )
|
|
{
|
|
try
|
|
{
|
|
$album = \IPS\gallery\Album::load( \IPS\Request::i()->album );
|
|
$category = $album->category();
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_CATEGORY_OR_ALBUM', '1G316/2', 400 );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
$category = \IPS\gallery\Category::load( \IPS\Request::i()->category );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_CATEGORY_OR_ALBUM', '1G316/2', 400 );
|
|
}
|
|
}
|
|
|
|
/* Get author */
|
|
if ( \IPS\Request::i()->author )
|
|
{
|
|
$author = \IPS\Member::load( \IPS\Request::i()->author );
|
|
if ( !$author->member_id )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1G316/3', 400 );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$author = new \IPS\Member;
|
|
}
|
|
|
|
/* Check we have a caption and a filename */
|
|
if ( !\IPS\Request::i()->caption )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_CAPTION', '1G316/4', 400 );
|
|
}
|
|
if ( !\IPS\Request::i()->filename )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_FILENAME', '1G316/5', 400 );
|
|
}
|
|
|
|
/* Check it's a valid image */
|
|
$imageContents = base64_decode( \IPS\Request::i()->image );
|
|
try
|
|
{
|
|
$imageObject = \IPS\Image::create( $imageContents );
|
|
}
|
|
catch ( \Exception $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_IMAGE', '1G316/6', 400 );
|
|
}
|
|
|
|
/* Create the file */
|
|
$file = \IPS\File::create( 'gallery_Images', \IPS\Request::i()->filename, $imageContents );
|
|
|
|
/* Create the object */
|
|
$image = $this->_create( $category, $author );
|
|
|
|
/* Set properties */
|
|
$image->original_file_name = (string) $file;
|
|
$image->file_size = $file->filesize();
|
|
$image->file_name = $file->originalFilename;
|
|
$image->file_type = \IPS\File::getMimeType( $file->filename );
|
|
if( \IPS\Image::exifSupported() )
|
|
{
|
|
$image->metadata = $imageObject->parseExif();
|
|
if( count( $image->metadata ) )
|
|
{
|
|
$image->parseGeolocation();
|
|
$image->gps_show = isset( \IPS\Request::i()->gpsShow ) ? \IPS\Request::i()->gpsShow : 1;
|
|
}
|
|
$metadata = $image->metadata;
|
|
array_walk_recursive( $metadata, function( &$val, $key )
|
|
{
|
|
$val = utf8_encode( $val );
|
|
} );
|
|
$image->metadata = json_encode( $metadata );
|
|
}
|
|
$image->buildThumbnails( $file );
|
|
$image->save();
|
|
|
|
/* Output */
|
|
return new \IPS\Api\Response( 201, $image->apiOutput() );
|
|
}
|
|
|
|
/**
|
|
* POST /gallery/images/{id}
|
|
* Edit an image
|
|
*
|
|
* @apiparam int album The ID number of the album (only provide this or category to move image)
|
|
* @apiparam int category The ID number of the category (only provide this or category to move image)
|
|
* @apiparam int author The ID number of the member uploading the image (0 for guest)
|
|
* @apiparam string caption The image caption
|
|
* @apiparam string description The description as HTML (e.g. "<p>This is an image.</p>")
|
|
* @apiparam string copyright The copyright
|
|
* @apiparam string credit The credit information
|
|
* @apiparam int gpsShow If the image contains the location in it's EXIF data, 1/0 indicating if a map should be shown (defaults to 1)
|
|
* @apiparam string prefix Prefix tag
|
|
* @apiparam string tags Comma-separated list of tags (do not include prefix)
|
|
* @apiparam datetime date The date/time that should be used for the image post date. If not provided, will use the current date/time
|
|
* @apiparam string ip_address The IP address that should be stored for the image. If not provided, will use the IP address from the API request
|
|
* @apiparam int locked 1/0 indicating if the image should be locked
|
|
* @apiparam int hidden 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)
|
|
* @apiparam int pinned 1/0 indicating if the image should be locked
|
|
* @apiparam int featured 1/0 indicating if the image should be featured
|
|
* @throws 2G316/7 INVALID_ID The image ID is invalid
|
|
* @throws 1G316/8 NO_CATEGORY_OR_ALBUM The category or album does not exist
|
|
* @throws 1G316/9 NO_AUTHOR The author ID does not exist
|
|
* @return \IPS\gallery\Image
|
|
*/
|
|
public function POSTitem( $id )
|
|
{
|
|
try
|
|
{
|
|
$image = \IPS\gallery\Image::load( $id );
|
|
|
|
/* New category or album */
|
|
try
|
|
{
|
|
if ( isset( \IPS\Request::i()->album ) and \IPS\Request::i()->album != $image->album_id )
|
|
{
|
|
$newAlbum = \IPS\gallery\Album::load( \IPS\Request::i()->album );
|
|
$image->move( $newAlbum );
|
|
}
|
|
elseif ( isset( \IPS\Request::i()->category ) and \IPS\Request::i()->category != $image->category_id )
|
|
{
|
|
$newCategory = \IPS\gallery\Category::load( \IPS\Request::i()->category );
|
|
$image->move( $newCategory );
|
|
}
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_CATEGORY_OR_ALBUM', '1G316/8', 400 );
|
|
}
|
|
|
|
/* New author */
|
|
if ( isset( \IPS\Request::i()->author ) )
|
|
{
|
|
try
|
|
{
|
|
$member = \IPS\Member::load( \IPS\Request::i()->author );
|
|
if ( !$member->member_id )
|
|
{
|
|
throw new \OutOfRangeException;
|
|
}
|
|
|
|
$image->changeAuthor( $member );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1G316/9', 400 );
|
|
}
|
|
}
|
|
|
|
/* Everything else */
|
|
$this->_createOrUpdate( $image );
|
|
|
|
/* Save and return */
|
|
$image->save();
|
|
return new \IPS\Api\Response( 200, $image->apiOutput() );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2G316/7', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* GET /gallery/images/{id}/comments
|
|
* Get comments on an image
|
|
*
|
|
* @param int $id ID Number
|
|
* @apiparam int hidden If 1, only comments which are hidden are returned, if 0 only not hidden
|
|
* @apiparam string sortDir Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
|
|
* @apiparam int page Page number
|
|
* @throws 2G316/A INVALID_ID The image ID does not exist
|
|
* @return \IPS\Api\PaginatedResponse<IPS\gallery\Image\Comment>
|
|
*/
|
|
public function GETitem_comments( $id )
|
|
{
|
|
try
|
|
{
|
|
return $this->_comments( $id, 'IPS\gallery\Image\Comment' );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2G316/A', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* GET /gallery/images/{id}/reviews
|
|
* Get reviews on an image
|
|
*
|
|
* @param int $id ID Number
|
|
* @apiparam int hidden If 1, only comments which are hidden are returned, if 0 only not hidden
|
|
* @apiparam string sortDir Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
|
|
* @apiparam int page Page number
|
|
* @throws 2G316/B INVALID_ID The image ID does not exist
|
|
* @return \IPS\Api\PaginatedResponse<IPS\gallery\Image\Review>
|
|
*/
|
|
public function GETitem_reviews( $id )
|
|
{
|
|
try
|
|
{
|
|
return $this->_comments( $id, 'IPS\gallery\Image\Review' );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2G316/B', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create or update image
|
|
*
|
|
* @param \IPS\Content\Item $item The item
|
|
* @return \IPS\Content\Item
|
|
*/
|
|
protected function _createOrUpdate( \IPS\Content\Item $item )
|
|
{
|
|
/* Album */
|
|
if ( isset( \IPS\Request::i()->album ) and !$item->id )
|
|
{
|
|
$item->album_id = \IPS\Request::i()->album;
|
|
}
|
|
|
|
/* Caption */
|
|
if ( isset( \IPS\Request::i()->caption ) )
|
|
{
|
|
$item->caption = \IPS\Request::i()->caption;
|
|
}
|
|
|
|
/* Description */
|
|
if ( isset( \IPS\Request::i()->description ) )
|
|
{
|
|
$item->description = \IPS\Request::i()->description;
|
|
}
|
|
|
|
/* Copyright */
|
|
if ( isset( \IPS\Request::i()->copyright ) )
|
|
{
|
|
$item->copyright = \IPS\Request::i()->copyright;
|
|
}
|
|
|
|
/* Credit */
|
|
if ( isset( \IPS\Request::i()->credit ) )
|
|
{
|
|
$item->credit_info = \IPS\Request::i()->credit;
|
|
}
|
|
|
|
/* GPS Show */
|
|
if ( isset( \IPS\Request::i()->gpsShow ) )
|
|
{
|
|
$item->gps_show = \IPS\Request::i()->gpsShow;
|
|
}
|
|
|
|
/* Pass up */
|
|
return parent::_createOrUpdate( $item );
|
|
}
|
|
|
|
/**
|
|
* DELETE /gallery/images/{id}
|
|
* Delete an image
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 2G316/C INVALID_ID The image ID does not exist
|
|
* @return void
|
|
*/
|
|
public function DELETEitem( $id )
|
|
{
|
|
try
|
|
{
|
|
\IPS\gallery\Image::load( $id )->delete();
|
|
|
|
return new \IPS\Api\Response( 200, NULL );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2G316/C', 404 );
|
|
}
|
|
}
|
|
} |