327 lines
10 KiB
PHP
327 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* @brief Topics 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 Forums
|
|
* @since 4 Dec 2015
|
|
*/
|
|
|
|
namespace IPS\forums\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 Topics API
|
|
*/
|
|
class _topics extends \IPS\Content\Api\ItemController
|
|
{
|
|
/**
|
|
* Class
|
|
*/
|
|
protected $class = 'IPS\forums\Topic';
|
|
|
|
/**
|
|
* GET /forums/topics
|
|
* Get list of topics
|
|
*
|
|
* @apiparam string forums Comma-delimited list of forum IDs
|
|
* @apiparam string authors Comma-delimited list of member IDs - if provided, only topics started by those members are returned
|
|
* @apiparam int hasBestAnswer If 1, only topics with a best answer are returned, if 0 only without
|
|
* @apiparam int hasPoll If 1, only topics with a poll are returned, if 0 only without
|
|
* @apiparam int locked If 1, only topics which are locked are returned, if 0 only unlocked
|
|
* @apiparam int hidden If 1, only topics which are hidden are returned, if 0 only not hidden
|
|
* @apiparam int pinned If 1, only topics which are pinned are returned, if 0 only not pinned
|
|
* @apiparam int featured If 1, only topics which are featured are returned, if 0 only not featured
|
|
* @apiparam int archived If 1, only topics which are archived are returned, if 0 only not archived
|
|
* @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
|
|
* @return \IPS\Api\PaginatedResponse<IPS\forums\Topic>
|
|
*/
|
|
public function GETindex()
|
|
{
|
|
/* Init */
|
|
$where = array();
|
|
|
|
/* Has best answer */
|
|
if ( isset( \IPS\Request::i()->hasBestAnswer ) )
|
|
{
|
|
if ( \IPS\Request::i()->hasBestAnswer )
|
|
{
|
|
$where[] = array( "topic_answered_pid>0" );
|
|
}
|
|
else
|
|
{
|
|
$where[] = array( "topic_answered_pid=0" );
|
|
}
|
|
}
|
|
|
|
/* Archived */
|
|
if ( isset( \IPS\Request::i()->archived ) )
|
|
{
|
|
if ( \IPS\Request::i()->archived )
|
|
{
|
|
$where[] = array( \IPS\Db::i()->in( 'topic_archive_status', array( \IPS\forums\Topic::ARCHIVE_DONE, \IPS\forums\Topic::ARCHIVE_WORKING, \IPS\forums\Topic::ARCHIVE_RESTORE ) ) );
|
|
}
|
|
else
|
|
{
|
|
$where[] = array( \IPS\Db::i()->in( 'topic_archive_status', array( \IPS\forums\Topic::ARCHIVE_NOT, \IPS\forums\Topic::ARCHIVE_EXCLUDE ) ) );
|
|
}
|
|
}
|
|
|
|
/* Return */
|
|
return $this->_list( $where, 'forums' );
|
|
}
|
|
|
|
/**
|
|
* GET /forums/topics/{id}
|
|
* View information about a specific topic
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 2F294/9 INVALID_ID The topic ID does not exist
|
|
* @return \IPS\forums\Topic
|
|
*/
|
|
public function GETitem( $id )
|
|
{
|
|
try
|
|
{
|
|
return $this->_view( $id );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2F294/9', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* GET /forums/topics/{id}/posts
|
|
* Get posts in a topic
|
|
*
|
|
* @param int $id ID Number
|
|
* @apiparam int hidden If 1, only posts 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 1F294/1 INVALID_ID The topic ID does not exist
|
|
* @return \IPS\Api\PaginatedResponse<IPS\forums\Topic\Post>
|
|
*/
|
|
public function GETitem_posts( $id )
|
|
{
|
|
try
|
|
{
|
|
return $this->_comments( $id, 'IPS\forums\Topic\Post' );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '1F294/1', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create or update topic
|
|
*
|
|
* @param \IPS\Content\Item $item The item
|
|
* @return \IPS\Content\Item
|
|
*/
|
|
protected function _createOrUpdate( \IPS\Content\Item $item )
|
|
{
|
|
/* Open/Close time */
|
|
if ( \IPS\Request::i()->open_time )
|
|
{
|
|
$item->topic_open_time = ( new \DateTime( \IPS\Request::i()->open_time ) )->getTimestamp();
|
|
}
|
|
if ( \IPS\Request::i()->close_time )
|
|
{
|
|
$item->topic_close_time = ( new \DateTime( \IPS\Request::i()->close_time ) )->getTimestamp();
|
|
}
|
|
|
|
/* Pass up */
|
|
return parent::_createOrUpdate( $item );
|
|
}
|
|
|
|
/**
|
|
* POST /forums/topics
|
|
* Create a topic
|
|
*
|
|
* @reqapiparam int forum The ID number of the forum the topic should be created in
|
|
* @reqapiparam int author The ID number of the member creating the topic (0 for guest)
|
|
* @apiparam string author_name If author is 0, the guest name that should be used
|
|
* @reqapiparam string title The topic title
|
|
* @reqapiparam string post The post content as HTML (e.g. "<p>This is a post.</p>")
|
|
* @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 topic/post post date. If not provided, will use the current date/time
|
|
* @apiparam string ip_address The IP address that should be stored for the topic/post. If not provided, will use the IP address from the API request
|
|
* @apiparam int locked 1/0 indicating if the topic should be locked
|
|
* @apiparam datetime open_time When the topic should be unlocked from
|
|
* @apiparam datetime close_time When the topic should be locked from
|
|
* @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 topic should be pinned
|
|
* @apiparam int featured 1/0 indicating if the topic should be featured
|
|
* @throws 1F294/2 NO_FORUM The forum ID does not exist
|
|
* @throws 1F294/3 NO_AUTHOR The author ID does not exist
|
|
* @throws 1F294/5 NO_TITLE No title was supplied
|
|
* @throws 1F294/4 NO_POST No post was supplied
|
|
* @return \IPS\forums\Topic
|
|
*/
|
|
public function POSTindex()
|
|
{
|
|
/* Get forum */
|
|
try
|
|
{
|
|
$forum = \IPS\forums\Forum::load( \IPS\Request::i()->forum );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_FORUM', '1F294/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', '1F294/3', 400 );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$author = new \IPS\Member;
|
|
$author->name = \IPS\Request::i()->author_name;
|
|
}
|
|
|
|
/* Check we have a title and a post */
|
|
if ( !\IPS\Request::i()->title )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_TITLE', '1F294/5', 400 );
|
|
}
|
|
if ( !\IPS\Request::i()->post )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_POST', '1F294/4', 400 );
|
|
}
|
|
|
|
/* Do it */
|
|
return new \IPS\Api\Response( 201, $this->_create( $forum, $author )->apiOutput() );
|
|
}
|
|
|
|
/**
|
|
* POST /forums/topics/{id}
|
|
* Edit a topic
|
|
*
|
|
* @apiparam int forum The ID number of the forum the topic should be created in
|
|
* @apiparam int author The ID number of the member creating the topic (0 for guest)
|
|
* @apiparam string author_name If author is 0, the guest name that should be used
|
|
* @apiparam string title The topic title
|
|
* @apiparam string post The post content as HTML (e.g. "<p>This is a post.</p>")
|
|
* @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 topic/post post date. If not provided, will use the current date/time
|
|
* @apiparam string ip_address The IP address that should be stored for the topic/post. If not provided, will use the IP address from the API request
|
|
* @apiparam int locked 1/0 indicating if the topic should be locked
|
|
* @apiparam datetime open_time When the topic should be unlocked from
|
|
* @apiparam datetime close_time When the topic should be locked from
|
|
* @apiparam int hidden 1/0 indicating if the topic should be hidden
|
|
* @apiparam int pinned 1/0 indicating if the topic should be pinned
|
|
* @apiparam int featured 1/0 indicating if the topic should be featured
|
|
* @throws 2F294/6 INVALID_ID The topic ID does not exist
|
|
* @throws 1F294/7 NO_FORUM The forum ID does not exist
|
|
* @throws 1F294/8 NO_AUTHOR The author ID does not exist
|
|
* @return \IPS\forums\Topic
|
|
*/
|
|
public function POSTitem( $id )
|
|
{
|
|
try
|
|
{
|
|
$topic = \IPS\forums\Topic::load( $id );
|
|
|
|
/* New forum */
|
|
if ( isset( \IPS\Request::i()->forum ) and \IPS\Request::i()->forum != $topic->forum_id )
|
|
{
|
|
try
|
|
{
|
|
$newForum = \IPS\forums\Forum::load( \IPS\Request::i()->forum );
|
|
$topic->move( $newForum );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_FORUM', '1F294/7', 400 );
|
|
}
|
|
}
|
|
|
|
/* New author */
|
|
if ( isset( \IPS\Request::i()->author ) )
|
|
{
|
|
/* Just renaming the guest */
|
|
if ( !$topic->starter_id and ( !isset( \IPS\Request::i()->author ) or !\IPS\Request::i()->author ) and isset( \IPS\Request::i()->author_name ) )
|
|
{
|
|
$topic->starter_name = \IPS\Request::i()->author_name;
|
|
|
|
if ( $firstPost = $this->comments( 1, 0, 'date', 'asc' ) )
|
|
{
|
|
$firstPost->author_name = \IPS\Request::i()->author_name;
|
|
}
|
|
}
|
|
|
|
/* Actually changing the author */
|
|
else
|
|
{
|
|
try
|
|
{
|
|
$member = \IPS\Member::load( \IPS\Request::i()->author );
|
|
if ( !$member->member_id )
|
|
{
|
|
throw new \OutOfRangeException;
|
|
}
|
|
|
|
$topic->changeAuthor( $member );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1F294/8', 400 );
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Everything else */
|
|
$this->_createOrUpdate( $topic );
|
|
|
|
/* Save and return */
|
|
$topic->save();
|
|
return new \IPS\Api\Response( 200, $topic->apiOutput() );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2F294/6', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* DELETE /forums/topics/{id}
|
|
* Delete a topic
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 1F294/5 INVALID_ID The topic ID does not exist
|
|
* @return void
|
|
*/
|
|
public function DELETEitem( $id )
|
|
{
|
|
try
|
|
{
|
|
\IPS\forums\Topic::load( $id )->delete();
|
|
|
|
return new \IPS\Api\Response( 200, NULL );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '1F294/5', 404 );
|
|
}
|
|
}
|
|
} |