335 lines
12 KiB
PHP
335 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* @brief Gallery Reviews 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 */
|
|
|
|
use InvalidArgumentException;
|
|
use IPS\Api\Exception;
|
|
use IPS\Api\PaginatedResponse;
|
|
use IPS\Api\Response;
|
|
use IPS\Content\Api\CommentController;
|
|
use IPS\Db;
|
|
use IPS\gallery\Image;
|
|
use IPS\gallery\Image\Review;
|
|
use IPS\Member;
|
|
use IPS\Request;
|
|
use IPS\Settings;
|
|
use OutOfRangeException;
|
|
use function defined;
|
|
use function in_array;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* @brief Gallery Reviews API
|
|
*/
|
|
class reviews extends CommentController
|
|
{
|
|
/**
|
|
* Class
|
|
*/
|
|
protected string $class = 'IPS\gallery\Image\Review';
|
|
|
|
/**
|
|
* GET /gallery/reviews
|
|
* Get list of reviews
|
|
*
|
|
* @note For requests using an OAuth Access Token for a particular member, only reviews the authorized user can view will be included
|
|
* @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 topics started by those members are returned
|
|
* @apiparam int locked If 1, only reviews from images which are locked are returned, if 0 only unlocked
|
|
* @apiparam int hidden If 1, only reviews which are hidden are returned, if 0 only not hidden
|
|
* @apiparam int featured If 1, only reviews from images which are featured are returned, if 0 only not featured
|
|
* @apiparam string sortBy What to sort by. Can be '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
|
|
* @apiparam int perPage Number of results per page - defaults to 25
|
|
* @apireturn PaginatedResponse<IPS\gallery\Image\Review>
|
|
* @return PaginatedResponse<Review>
|
|
*/
|
|
public function GETindex(): PaginatedResponse
|
|
{
|
|
/* Where clause */
|
|
$where = array();
|
|
|
|
/* Albums */
|
|
if ( isset( Request::i()->albums ) )
|
|
{
|
|
$where[] = array( Db::i()->in( 'image_album_id', array_filter( explode( ',', Request::i()->albums ) ) ) );
|
|
}
|
|
|
|
return $this->_list( $where );
|
|
}
|
|
|
|
/**
|
|
* GET /gallery/reviews/{id}
|
|
* View information about a specific review
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 2G318/1 INVALID_ID The review ID does not exist or the authorized user does not have permission to view it
|
|
* @apireturn \IPS\gallery\Image\Review
|
|
* @return Response
|
|
*/
|
|
public function GETitem( int $id ): Response
|
|
{
|
|
try
|
|
{
|
|
/* @var Review $class */
|
|
$class = $this->class;
|
|
if ( $this->member )
|
|
{
|
|
$object = $class::loadAndCheckPerms( $id, $this->member );
|
|
}
|
|
else
|
|
{
|
|
$object = $class::load( $id );
|
|
}
|
|
|
|
return new Response( 200, $object->apiOutput( $this->member ) );
|
|
}
|
|
catch ( OutOfRangeException $e )
|
|
{
|
|
throw new Exception( 'INVALID_ID', '2G318/1', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* POST /gallery/reviews
|
|
* Create a review
|
|
*
|
|
* @note For requests using an OAuth Access Token for a particular member, any parameters the user doesn't have permission to use are ignored (for example, hidden will only be honoured if the authenticated user has permission to hide content).
|
|
* @reqapiparam int image The ID number of the image the review is for
|
|
* @reqapiparam int author The ID number of the member making the review (0 for guest). Required for requests made using an API Key or the Client Credentials Grant Type. For requests using an OAuth Access Token for a particular member, that member will always be the author
|
|
* @apiparam string author_name If author is 0, the guest name that should be used
|
|
* @reqapiparam string content The review content as HTML (e.g. "<p>This is a review.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type.
|
|
* @apiparam datetime date The date/time that should be used for the review date. If not provided, will use the current date/time. Ignored for requests using an OAuth Access Token for a particular member
|
|
* @apiparam string ip_address The IP address that should be stored for the review. If not provided, will use the IP address from the API request. Ignored for requests using an OAuth Access Token for a particular member
|
|
* @apiparam int hidden 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)
|
|
* @apiparam bool anonymous If 1, the item will be posted anonymously.
|
|
* @reqapiparam int rating Star rating
|
|
* @throws 2G318/8 INVALID_ID The forum ID does not exist
|
|
* @throws 1G318/3 NO_AUTHOR The author ID does not exist
|
|
* @throws 1L298/4 NO_CONTENT No content was supplied
|
|
* @throws 1G318/5 INVALID_RATING The rating is not a valid number up to the maximum rating
|
|
* @throws 2G318/D NO_PERMISSION The authorized user does not have permission to review that image
|
|
* @apireturn \IPS\gallery\Image\Review
|
|
* @return Response
|
|
*/
|
|
public function POSTindex(): Response
|
|
{
|
|
/* Get image */
|
|
try
|
|
{
|
|
$image = Image::load( Request::i()->image );
|
|
}
|
|
catch ( OutOfRangeException $e )
|
|
{
|
|
throw new Exception( 'INVALID_ID', '2G318/2', 403 );
|
|
}
|
|
|
|
/* Get author */
|
|
if ( $this->member )
|
|
{
|
|
if ( !$image->canReview( $this->member ) )
|
|
{
|
|
throw new Exception( 'NO_PERMISSION', '2G318/D', 403 );
|
|
}
|
|
$author = $this->member;
|
|
}
|
|
else
|
|
{
|
|
if ( Request::i()->author )
|
|
{
|
|
$author = Member::load( Request::i()->author );
|
|
if ( !$author->member_id )
|
|
{
|
|
throw new Exception( 'NO_AUTHOR', '1G318/3', 404 );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if ( (int) Request::i()->author === 0 )
|
|
{
|
|
$author = new Member;
|
|
$author->name = Request::i()->author_name;
|
|
}
|
|
else
|
|
{
|
|
throw new Exception( 'NO_AUTHOR', '1G318/3', 400 );
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Check we have a post */
|
|
if ( !Request::i()->content )
|
|
{
|
|
throw new Exception( 'NO_CONTENT', '1G318/4', 403 );
|
|
}
|
|
|
|
/* Check we have a rating */
|
|
if ( !Request::i()->rating or !in_array( (int) Request::i()->rating, range( 1, Settings::i()->reviews_rating_out_of ) ) )
|
|
{
|
|
throw new Exception( 'INVALID_RATING', '2G318/8', 403 );
|
|
}
|
|
|
|
/* Do it */
|
|
return $this->_create( $image, $author );
|
|
}
|
|
|
|
/**
|
|
* POST /gallery/reviews/{id}
|
|
* Edit a review
|
|
*
|
|
* @note For requests using an OAuth Access Token for a particular member, any parameters the user doesn't have permission to use are ignored (for example, hidden will only be honoured if the authenticated user has permission to hide content).
|
|
* @param int $id ID Number
|
|
* @apiparam int author The ID number of the member making the review (0 for guest). Ignored for requests using an OAuth Access Token for a particular member.
|
|
* @apiparam string author_name If author is 0, the guest name that should be used
|
|
* @apiparam string content The review content as HTML (e.g. "<p>This is a review.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type.
|
|
* @apiparam int hidden 1/0 indicating if the topic should be hidden
|
|
* @apiparam int rating Star rating
|
|
* @apiparam bool anonymous If 1, the item will be posted anonymously.
|
|
* @throws 2L298/5 INVALID_ID The review ID does not exist or the authorized user does not have permission to view it
|
|
* @throws 1G318/B NO_AUTHOR The author ID does not exist
|
|
* @throws 1G318/A INVALID_RATING The rating is not a valid number up to the maximum rating
|
|
* @throws 2G318/E NO_PERMISSION The authorized user does not have permission to edit the review
|
|
* @apireturn \IPS\gallery\Image\Review
|
|
* @return Response
|
|
*/
|
|
public function POSTitem( int $id ): Response
|
|
{
|
|
try
|
|
{
|
|
/* Load */
|
|
$comment = Review::load( $id );
|
|
if ( $this->member and !$comment->canView( $this->member ) )
|
|
{
|
|
throw new OutOfRangeException;
|
|
}
|
|
if ( $this->member and !$comment->canEdit( $this->member ) )
|
|
{
|
|
throw new Exception( 'NO_PERMISSION', '2G318/E', 403 );
|
|
}
|
|
|
|
/* Check */
|
|
if ( isset( Request::i()->rating ) and !in_array( (int) Request::i()->rating, range( 1, Settings::i()->reviews_rating_out_of ) ) )
|
|
{
|
|
throw new Exception( 'INVALID_RATING', '1G318/A', 403 );
|
|
}
|
|
/* Do it */
|
|
try
|
|
{
|
|
return $this->_edit( $comment );
|
|
}
|
|
catch ( InvalidArgumentException $e )
|
|
{
|
|
throw new Exception( 'NO_AUTHOR', '1G318/B', 400 );
|
|
}
|
|
}
|
|
catch ( OutOfRangeException $e )
|
|
{
|
|
throw new Exception( 'INVALID_ID', '2G318/9', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* DELETE /gallery/reviews/{id}
|
|
* Deletes a review
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 2G318/C INVALID_ID The review ID does not exist
|
|
* @throws 2G318/F NO_PERMISSION The authorized user does not have permission to delete the review
|
|
* @apireturn void
|
|
* @return Response
|
|
*/
|
|
public function DELETEitem( int $id ): Response
|
|
{
|
|
try
|
|
{
|
|
/* @var Review $class */
|
|
$class = $this->class;
|
|
$object = $class::load( $id );
|
|
if ( $this->member and !$object->canDelete( $this->member ) )
|
|
{
|
|
throw new Exception( 'NO_PERMISSION', '2G318/F', 403 );
|
|
}
|
|
$object->delete();
|
|
|
|
return new Response( 200, NULL );
|
|
}
|
|
catch ( OutOfRangeException $e )
|
|
{
|
|
throw new Exception( 'INVALID_ID', '2G318/C', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* POST /gallery/reviews/{id}/react
|
|
* Add a reaction
|
|
*
|
|
* @param int $id ID Number
|
|
* @apiparam int id ID of the reaction to add
|
|
* @apiparam int author ID of the member reacting
|
|
* @apireturn \IPS\gallery\Image\Review
|
|
* @throws 1S425/2 NO_REACTION The reaction ID does not exist
|
|
* @throws 1S425/3 NO_AUTHOR The author ID does not exist
|
|
* @throws 1S425/4 REACT_ERROR Error adding the reaction
|
|
* @throws 1S425/5 INVALID_ID Object ID does not exist
|
|
* @note If the author has already reacted to this content, any existing reaction will be removed first
|
|
* @return Response
|
|
*/
|
|
public function POSTitem_react( int $id ): Response
|
|
{
|
|
return $this->_reactAdd( $id );
|
|
}
|
|
|
|
/**
|
|
* DELETE /gallery/reviews/{id}/react
|
|
* Delete a reaction
|
|
*
|
|
* @param int $id ID Number
|
|
* @apiparam int author ID of the member who reacted
|
|
* @apireturn Review
|
|
* @throws 1S425/6 NO_AUTHOR The author ID does not exist
|
|
* @throws 1S425/7 REACT_ERROR Error adding the reaction
|
|
* @throws 1S425/8 INVALID_ID Object ID does not exist
|
|
* @note If the author has already reacted to this content, any existing reaction will be removed first
|
|
* @return Response
|
|
*/
|
|
public function DELETEitem_react( int $id ): Response
|
|
{
|
|
return $this->_reactRemove( $id );
|
|
}
|
|
|
|
/**
|
|
* POST /gallery/reviews/{id}/report
|
|
* Reports a review
|
|
*
|
|
* @param int $id ID Number
|
|
* @apiparam int author ID of the member reporting
|
|
* @apiparam int report_type Report type (0 is default and is for letting CMGR team know, more options via core_automatic_moderation_types)
|
|
* @apiparam string message Optional message
|
|
* @throws 1S425/B NO_AUTHOR The author ID does not exist
|
|
* @throws 1S425/C REPORTED_ALREADY The member has reported this item in the past 24 hours
|
|
* @apireturn \IPS\gallery\Image\Review
|
|
* @return Response
|
|
*/
|
|
public function POSTitem_report( int $id ): Response
|
|
{
|
|
return $this->_report( $id );
|
|
}
|
|
} |