Version 4.1.19

This commit is contained in:
Neo committed 2025-12-19 05:38:56 -08:00
1 parent 28bd025b35
commit 2bd5025018
2674 files changed
+233518 -77766

No files matched your search

+104
View File
@@ -0,0 +1,104 @@
<?php
/**
* @brief Blog Blogs API
* @author <a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
* @copyright (c) 2001 - 2016 Invision Power Services, Inc.
* @license http://www.invisionpower.com/legal/standards/
* @package IPS Community Suite
* @subpackage Blog
* @since 9 Dec 2015
* @version SVN_VERSION_NUMBER
*/
namespace IPS\blog\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 Blog Blogs API
*/
class _blogs extends \IPS\Api\Controller
{
/**
* GET /blog/blogs
* Get list of blogs
*
* @apiparam string owners Comma-delimited list of member IDs - if provided, only blogs owned by those members are returned (can be used in conjection with groups or set to 0 to exclude member-created blogs)
* @apiparam string groups Comma-delimited list of group IDs - if provided, only blogs owned by those groups are returned (can be used in conjection with members or set to 0 to exclude group blogs)
* @apiparam int pinned If 1, only blogs which are pinned are returned, if 0 only not pinned
* @apiparam string sortBy What to sort by. Can be 'count_entries' for number of entries, 'last_edate' for last entry date or do not specify 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\blog\Entry>
*/
public function GETindex()
{
/* Where clause */
$where = array();
/* Owners */
if ( isset( \IPS\Request::i()->owners ) and isset( \IPS\Request::i()->groups ) )
{
$where[] = array( '( ' . \IPS\Db::i()->in( 'blog_member_id', array_filter( explode( ',', \IPS\Request::i()->owners ) ) ) . ' OR ' . \IPS\Db::i()->findInSet( 'blog_groupblog_ids', array_filter( explode( ',', \IPS\Request::i()->groups ) ) ) . ' )' );
}
elseif ( isset( \IPS\Request::i()->owners ) )
{
$where[] = array( '( ' . \IPS\Db::i()->in( 'blog_member_id', array_filter( explode( ',', \IPS\Request::i()->owners ) ) ) . ' OR blog_groupblog_ids<>? )', '' );
}
elseif ( isset( \IPS\Request::i()->groups ) )
{
$where[] = array( '( blog_member_id>0 OR ' . \IPS\Db::i()->findInSet( 'blog_groupblog_ids', array_filter( explode( ',', \IPS\Request::i()->groups ) ) ) . ' )' );
}
/* Pinned */
if ( isset( \IPS\Request::i()->pinned ) )
{
$where[] = array( 'blog_pinned=?', intval( \IPS\Request::i()->pinned ) );
}
/* Sort */
if ( isset( \IPS\Request::i()->sortBy ) and in_array( \IPS\Request::i()->sortBy, array( 'count_entries', 'last_edate' ) ) )
{
$sortBy = 'blog_' . \IPS\Request::i()->sortBy;
}
else
{
$sortBy = 'blog_id';
}
$sortDir = ( isset( \IPS\Request::i()->sortDir ) and in_array( mb_strtolower( \IPS\Request::i()->sortDir ), array( 'asc', 'desc' ) ) ) ? \IPS\Request::i()->sortDir : 'asc';
/* Return */
return new \IPS\Api\PaginatedResponse(
200,
\IPS\Db::i()->select( '*', 'blog_blogs', $where, "{$sortBy} {$sortDir}" ),
isset( \IPS\Request::i()->page ) ? \IPS\Request::i()->page : 1,
'IPS\blog\Blog',
\IPS\Db::i()->select( 'COUNT(*)', 'blog_blogs', $where )->first()
);
}
/**
* GET /blog/blogs/{id}
* Get information about a specific blog
*
* @param int $id ID Number
* @throws 2B302/1 INVALID_ID The blog ID does not exist
* @return \IPS\blog\Blog
*/
public function GETitem( $id )
{
try
{
return new \IPS\Api\Response( 200, \IPS\blog\Blog::load( $id )->apiOutput() );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B302/1', 404 );
}
}
}
+193
View File
@@ -0,0 +1,193 @@
<?php
/**
* @brief Blog Entry Comments API
* @author <a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
* @copyright (c) 2001 - 2016 Invision Power Services, Inc.
* @license http://www.invisionpower.com/legal/standards/
* @package IPS Community Suite
* @subpackage Blog
* @since 8 Dec 2015
* @version SVN_VERSION_NUMBER
*/
namespace IPS\blog\api;
/* To prentry 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 Blog Entry Comments API
*/
class _comments extends \IPS\Content\Api\CommentController
{
/**
* Class
*/
protected $class = 'IPS\blog\Entry\Comment';
/**
* GET /blog/comments
* Get list of comments
*
* @apiparam string blogs Comma-delimited list of calendar 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 comments from entries which are locked are returned, if 0 only unlocked
* @apiparam int hidden If 1, only comments which are hidden are returned, if 0 only not hidden
* @apiparam int pinned If 1, only posts from topics which are pinned are returned, if 0 only not pinned
* @apiparam int featured If 1, only comments from entries which are featured are returned, if 0 only not featured
* @apiparam int draft If 1, only draft entries are returned, if 0 only published
* @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\blog\Entry\Comment>
*/
public function GETindex()
{
/* Where clause */
$where = array();
/* Draft */
if ( isset( \IPS\Request::i()->draft ) )
{
$where[] = array( 'entry_status=?', \IPS\Request::i()->draft ? 'draft' : 'published' );
}
/* Return */
return $this->_list( $where, 'blogs' );
}
/**
* GET /blog/comments/{id}
* View information about a specific comment
*
* @param int $id ID Number
* @throws 2B301/1 INVALID_ID The comment ID does not exist
* @return \IPS\blog\Entry\Comment
*/
public function GETitem( $id )
{
try
{
return new \IPS\Api\Response( 200, \IPS\blog\Entry\Comment::load( $id )->apiOutput() );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B301/1', 404 );
}
}
/**
* POST /blog/comments
* Create a comment
*
* @reqapiparam int entry The ID number of the entry the comment is for
* @reqapiparam int author The ID number of the member making the comment (0 for guest)
* @apiparam string author_name If author is 0, the guest name that should be used
* @reqapiparam string content The comment content as HTML (e.g. "<p>This is a comment.</p>")
* @apiparam datetime date The date/time that should be used for the comment date. If not provided, will use the current date/time
* @apiparam string ip_address The IP address that should be stored for the comment. If not provided, will use the IP address from the API request
* @apiparam int hidden 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator)
* @throws 2B301/2 INVALID_ID The comment ID does not exist
* @throws 1B301/3 NO_AUTHOR The author ID does not exist
* @throws 1B301/4 NO_CONTENT No content was supplied
* @return \IPS\blog\Entry\Comment
*/
public function POSTindex()
{
/* Get topic */
try
{
$entry = \IPS\blog\Entry::load( \IPS\Request::i()->entry );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B301/2', 403 );
}
/* 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', '1B301/3', 404 );
}
}
else
{
$author = new \IPS\Member;
$author->name = \IPS\Request::i()->author_name;
}
/* Check we have a post */
if ( !\IPS\Request::i()->content )
{
throw new \IPS\Api\Exception( 'NO_CONTENT', '1B301/4', 403 );
}
/* Do it */
return $this->_create( $entry, $author );
}
/**
* POST /blog/comments/{id}
* Edit a comment
*
* @param int $id ID Number
* @apiparam int author The ID number of the member making the comment (0 for guest)
* @apiparam string author_name If author is 0, the guest name that should be used
* @apiparam string content The comment content as HTML (e.g. "<p>This is a comment.</p>")
* @apiparam int hidden 1/0 indicating if the topic should be hidden
* @throws 2B301/5 INVALID_ID The comment ID does not exist
* @throws 1B301/6 NO_AUTHOR The author ID does not exist
* @return \IPS\blog\Entry\Comment
*/
public function POSTitem( $id )
{
try
{
/* Load */
$comment = \IPS\blog\Entry\Comment::load( $id );
/* Do it */
try
{
return $this->_edit( $comment );
}
catch ( \InvalidArgumentException $e )
{
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1B301/6', 400 );
}
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B301/5', 404 );
}
}
/**
* DELETE /blog/comments/{id}
* Deletes a comment
*
* @param int $id ID Number
* @throws 2B301/7 INVALID_ID The comment ID does not exist
* @return void
*/
public function DELETEitem( $id )
{
try
{
\IPS\blog\Entry\Comment::load( $id )->delete();
return new \IPS\Api\Response( 200, NULL );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B301/7', 404 );
}
}
}
+266
View File
@@ -0,0 +1,266 @@
<?php
/**
* @brief Blog Entries API
* @author <a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
* @copyright (c) 2001 - 2016 Invision Power Services, Inc.
* @license http://www.invisionpower.com/legal/standards/
* @package IPS Community Suite
* @subpackage Blog
* @since 9 Dec 2015
* @version SVN_VERSION_NUMBER
*/
namespace IPS\blog\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 Blog Entries API
*/
class _entries extends \IPS\Content\Api\ItemController
{
/**
* Class
*/
protected $class = 'IPS\blog\Entry';
/**
* GET /blog/entries
* Get list of entries
*
* @apiparam string blogs Comma-delimited list of blog IDs
* @apiparam string authors Comma-delimited list of member IDs - if provided, only entries started by those members are returned
* @apiparam int locked If 1, only entries which are locked are returned, if 0 only unlocked
* @apiparam int hidden If 1, only entries which are hidden are returned, if 0 only not hidden
* @apiparam int pinned If 1, only entries which are pinned are returned, if 0 only not pinned
* @apiparam int featured If 1, only entries which are featured are returned, if 0 only not featured
* @apiparam int draft If 1, only draft entries are returned, if 0 only published
* @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\blog\Entry>
*/
public function GETindex()
{
/* Where clause */
$where = array();
/* Draft */
if ( isset( \IPS\Request::i()->draft ) )
{
$where[] = array( 'entry_status=?', \IPS\Request::i()->draft ? 'draft' : 'published' );
}
/* Return */
return $this->_list( $where, 'blogs' );
}
/**
* GET /blog/entries/{id}
* View comments on an entry
*
* @param int $id ID Number
* @apiparam int page Page number
* @throws 2B300/1 INVALID_ID The entry ID does not exist
* @return \IPS\Api\PaginatedResponse<IPS\blog\Entry\Comment>
*/
public function GETitem( $id )
{
try
{
return $this->_comments( $id, 'IPS\blog\Entry\Comment' );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B300/1', 404 );
}
}
/**
* POST /blog/entries
* Create an entry
*
* @reqapiparam int blog The ID number of the blog the entry should be created in
* @reqapiparam int author The ID number of the member creating the entry (0 for guest)
* @reqapiparam string title The entry title
* @reqapiparam string entry The entry content as HTML (e.g. "<p>This is a blog entry.</p>")
* @apiparam bool draft If this is a draft
* @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 entry date. If not provided, will use the current date/time
* @apiparam string ip_address The IP address that should be stored for the entry/post. If not provided, will use the IP address from the API request
* @apiparam int locked 1/0 indicating if the entry 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 entry should be pinned
* @apiparam int featured 1/0 indicating if the entry should be featured
* @throws 1B300/2 NO_BLOG The blog ID does not exist
* @throws 1B300/3 NO_AUTHOR The author ID does not exist
* @throws 1B300/4 NO_TITLE No title was supplied
* @throws 1B300/5 NO_CONTENT No content was supplied
* @return \IPS\blog\Entry
*/
public function POSTindex()
{
/* Get blog */
try
{
$blog = \IPS\blog\Blog::load( \IPS\Request::i()->blog );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'NO_BLOG', '1B300/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', '1B300/3', 400 );
}
}
else
{
$author = new \IPS\Member;
}
/* Check we have a title and a description */
if ( !\IPS\Request::i()->title )
{
throw new \IPS\Api\Exception( 'NO_TITLE', '1B300/4', 400 );
}
if ( !\IPS\Request::i()->entry )
{
throw new \IPS\Api\Exception( 'NO_CONTENT', '1B300/5', 400 );
}
/* Do it */
return new \IPS\Api\Response( 201, $this->_create( $blog, $author )->apiOutput() );
}
/**
* POST /blog/entries/{id}
* Edit a blog entry
*
* @reqapiparam int blog The ID number of the blog the entry should be created in
* @reqapiparam int author The ID number of the member creating the entry (0 for guest)
* @reqapiparam string title The entry title
* @reqapiparam string entry The entry content as HTML (e.g. "<p>This is a blog entry.</p>")
* @apiparam bool draft If this is a draft
* @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 entry date. If not provided, will use the current date/time
* @apiparam string ip_address The IP address that should be stored for the entry/post. If not provided, will use the IP address from the API request
* @apiparam int locked 1/0 indicating if the entry 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 entry should be pinned
* @apiparam int featured 1/0 indicating if the entry should be featured
* @throws 2B300/6 INVALID_ID The entry ID is invalid
* @throws 1B300/7 NO_BLOG The blog ID does not exist
* @throws 1B300/8 NO_AUTHOR The author ID does not exist
* @return \IPS\blog\Entry
*/
public function POSTitem( $id )
{
try
{
$entry = \IPS\blog\Entry::load( $id );
/* New blog */
if ( isset( \IPS\Request::i()->blog ) and \IPS\Request::i()->blog != $entry->forum_id )
{
try
{
$newBlog = \IPS\blog\Blog::load( \IPS\Request::i()->blog );
$entry->move( $newBlog );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'NO_BLOG', '1B300/7', 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;
}
$entry->changeAuthor( $member );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'NO_AUTHOR', '1B300/8', 400 );
}
}
/* Everything else */
$this->_createOrUpdate( $entry );
/* Save and return */
$entry->save();
return new \IPS\Api\Response( 200, $entry->apiOutput() );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B300/6', 404 );
}
}
/**
* Create or update entry
*
* @param \IPS\Content\Item $item The item
* @return \IPS\Content\Item
*/
protected function _createOrUpdate( \IPS\Content\Item $item )
{
/* Is draft */
if ( isset( \IPS\Request::i()->draft ) )
{
$item->status = \IPS\Request::i()->draft ? 'draft' : 'published';
}
/* Content */
if ( isset( \IPS\Request::i()->entry ) )
{
$item->content = \IPS\Request::i()->entry;
}
/* Pass up */
return parent::_createOrUpdate( $item );
}
/**
* DELETE /blog/entries/{id}
* Delete an entry
*
* @param int $id ID Number
* @throws 2B300/9 INVALID_ID The entry ID does not exist
* @return void
*/
public function DELETEitem( $id )
{
try
{
\IPS\blog\Entry::load( $id )->delete();
return new \IPS\Api\Response( 200, NULL );
}
catch ( \OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '2B300/9', 404 );
}
}
}