sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 beta 1

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

applications/forums/api/forums.php
+103 -56
View File
@@ -12,21 +12,35 @@
namespace IPS\forums\api;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use IPS\Api\Exception;
use IPS\Api\PaginatedResponse;
use IPS\Api\Response;
use IPS\Data\Store;
use IPS\forums\Forum;
use IPS\Http\Url\Friendly;
use IPS\Lang;
use IPS\Node\Api\NodeController;
use IPS\Node\Model;
use IPS\Request;
use OutOfRangeException;
use function defined;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* @brief Forums API
*/
class _forums extends \IPS\Node\Api\NodeController
class forums extends NodeController
{
/**
* Class
*/
protected $class = 'IPS\forums\Forum';
protected string $class = 'IPS\forums\Forum';
/**
* GET /forums/forums
@@ -36,9 +50,10 @@ class _forums extends \IPS\Node\Api\NodeController
* @apiparam int page Page number
* @apiparam int perPage Number of results per page - defaults to 25
* @note For requests using an OAuth Access Token for a particular member, only forums the authorized user can view will be included
* @return \IPS\Api\PaginatedResponse<IPS\forums\Forum>
* @apireturn PaginatedResponse<IPS\forums\Forum>
* @return PaginatedResponse<Forum>
*/
public function GETindex()
public function GETindex(): PaginatedResponse
{
/* Return */
return $this->_list();
@@ -50,17 +65,18 @@ class _forums extends \IPS\Node\Api\NodeController
*
* @param int $id ID Number
* @throws 1F363/1 INVALID_ID The forum does not exist or the authorized user does not have permission to view it
* @return \IPS\forums\Forum
* @apireturn \IPS\forums\Forum
* @return Response
*/
public function GETitem( $id )
public function GETitem( int $id ): Response
{
try
{
return $this->_view( $id );
}
catch ( \OutOfRangeException $e )
catch ( OutOfRangeException $e )
{
throw new \IPS\Api\Exception( 'INVALID_ID', '1F363/1', 404 );
throw new Exception( 'INVALID_ID', '1F363/1', 404 );
}
}
@@ -71,7 +87,7 @@ class _forums extends \IPS\Node\Api\NodeController
* @apiclientonly
* @reqapiparam string title The forum title
* @apiparam string description The forum description
* @apiparam string type normal|qa|redirect|category
* @apiparam string type normal|redirect|category
* @apiparam int|null parent The ID number of the parent the forum should be created in. NULL for root.
* @apiparam string password Forum password
* @apiparam int theme Theme to use as an override
@@ -80,19 +96,25 @@ class _forums extends \IPS\Node\Api\NodeController
* @apiparam int can_see_others 0|1 Users can see topics posted by other users?
* @apiparam object permissions An object with the keys as permission options (view, read, add, reply, attachments) and values as permissions to use (which may be * to grant access to all groups, or an array of group IDs to permit access to)
* @apiparam string redirect_url If creating a redirect forum, the URL to redirect to.
* @return \IPS\forums\Forum
* @apireturn \IPS\forums\Forum
* @throws 1F363/2 NO_TITLE A title for the forum must be supplied
* @throws 1F363/3 NO_REDIRECT_URL No redirect URL supplied.
* @throws 1F363/4 INVALID_TYPE Invalid type of forum.
* @return Response
*/
public function POSTindex()
public function POSTindex(): Response
{
if ( !\IPS\Request::i()->title )
if ( !Request::i()->title )
{
throw new \IPS\Api\Exception( 'NO_TITLE', '1F363/2', 400 );
throw new Exception( 'NO_TITLE', '1F363/2', 400 );
}
return new \IPS\Api\Response( 201, $this->_create()->apiOutput( $this->member ) );
if ( !Request::i()->parent )
{
Request::i()->parent = -1;
}
return new Response( 201, $this->_create()->apiOutput( $this->member ) );
}
/**
@@ -102,7 +124,7 @@ class _forums extends \IPS\Node\Api\NodeController
* @apiclientonly
* @reqapiparam string title The forum title
* @apiparam string description The forum description
* @apiparam string type normal|qa|redirect|category
* @apiparam string type normal|redirect|category
* @apiparam int|null parent The ID number of the parent the forum should be created in. NULL for root.
* @apiparam string password Forum password
* @apiparam int theme Theme to use as an override
@@ -112,16 +134,18 @@ class _forums extends \IPS\Node\Api\NodeController
* @apiparam object permissions An object with the keys as permission options (view, read, add, reply, attachments) and values as permissions to use (which may be * to grant access to all groups, or an array of group IDs to permit access to)
* @apiparam string redirect_url If editing a redirect forum, the URL to redirect too.
* @param int $id ID Number
* @return \IPS\forums\Forum
* @apireturn \IPS\forums\Forum
* @throws 1F363/3 NO_REDIRECT_URL No redirect URL supplied.
* @throws 1F363/4 INVALID_TYPE Invalid type of forum.
* @return Response
*/
public function POSTitem( $id )
public function POSTitem( int $id ): Response
{
/* @var Forum $class */
$class = $this->class;
$forum = $class::load( $id );
return new \IPS\Api\Response( 200, $this->_createOrUpdate( $forum )->apiOutput( $this->member ) );
return new Response( 200, $this->_createOrUpdate( $forum )->apiOutput( $this->member ) );
}
/**
@@ -131,54 +155,82 @@ class _forums extends \IPS\Node\Api\NodeController
* @apiclientonly
* @param int $id ID Number
* @apiparam int deleteChildrenOrMove The ID number of the new parent or -1 to delete all child nodes.
* @return void
* @apireturn void
* @throws 1S359/1 INVALID_ID The node ID does not exist
* @throws 1S359/2 INVALID_TARGET The target node cannot be deleted because the new parent node does not exist
* @throws 1S359/3 HAS_CHILDREN The target node cannot be deleted because it has children (pass deleteChildrenOrMove in the request to specify how to handle the children)
* @return Response
*/
public function DELETEitem( $id )
public function DELETEitem( int $id ): Response
{
return $this->_delete( $id, \IPS\Request::i()->deleteChildrenOrMove ?? NULL );
/* Load forum and verify that it is not used for comments */
/* @var Forum $nodeClass */
$nodeClass = $this->class;
if ( Request::i()->subnode )
{
$nodeClass = $nodeClass::$subnodeClass;
}
try
{
$node = $nodeClass::load( $id );
}
catch (OutOfRangeException $e )
{
throw new Exception( 'INVALID_ID', '2F363/8', 404 );
}
if ( $dbCategory = $node->isUsedByADownloadsCategory() )
{
throw new Exception( 'FORUM_USED_BY_DOWNLOADS', '2F363/9', 403 );
}
if ( $db = $node->isUsedByCms() )
{
throw new Exception( 'FORUM_USED_BY_DATABASE', '2F363/6', 403 );
}
return $this->_delete( $id, Request::i()->deleteChildrenOrMove ?? NULL );
}
/**
* Create or update node
*
* @param \IPS\Node\Model $forum The node
* @return \IPS\Node\Model
* @param Model $forum The node
* @return Model
*/
protected function _createOrUpdate( \IPS\Node\Model $forum )
protected function _createOrUpdate( Model $forum ): Model
{
foreach ( array( 'title' => "forums_forum_{$forum->id}", 'description' => "forums_forum_{$forum->id}_desc" ) as $fieldKey => $langKey )
{
if ( isset( \IPS\Request::i()->$fieldKey ) )
if ( isset( Request::i()->$fieldKey ) )
{
\IPS\Lang::saveCustom( 'forums', $langKey, \IPS\Request::i()->$fieldKey );
Lang::saveCustom( 'forums', $langKey, Request::i()->$fieldKey );
if ( $fieldKey === 'title' )
{
$forum->name_seo = \IPS\Http\Url\Friendly::seoTitle( \IPS\Request::i()->$fieldKey );
$forum->name_seo = Friendly::seoTitle( Request::i()->$fieldKey );
}
}
}
if( isset( \IPS\Request::i()->parent ) )
if( isset( Request::i()->parent ) )
{
$forum->parent_id = (int) \IPS\Request::i()->parent ?: -1;
$forum->parent_id = (int) Request::i()->parent ?: -1;
if ( !isset( \IPS\Request::i()->type ) )
if ( !isset( Request::i()->type ) )
{
if ( $forum->parent_id === -1 )
{
\IPS\Request::i()->type = 'category';
Request::i()->type = 'category';
}
else
{
\IPS\Request::i()->type = 'normal';
Request::i()->type = 'normal';
}
}
switch ( \IPS\Request::i()->type )
switch ( Request::i()->type )
{
case 'category':
$forum->sub_can_post = 0;
@@ -189,54 +241,49 @@ class _forums extends \IPS\Node\Api\NodeController
$forum->sub_can_post = 1;
break;
case 'qa':
case 'questions':
$forum->forums_bitoptions['bw_enable_answers'] = TRUE;
break;
case 'redirect':
if ( !isset( \IPS\Request::i()->redirect_url ) )
if ( !isset( Request::i()->redirect_url ) )
{
throw new \IPS\Api\Exception( 'NO_REDIRECT_URL', '1F363/3', 400 );
throw new Exception( 'NO_REDIRECT_URL', '1F363/3', 400 );
}
$forum->redirect_on = 1;
$forum->redirect_url = \IPS\Request::i()->redirect_url;
$forum->redirect_url = Request::i()->redirect_url;
break;
default:
throw new \IPS\Api\Exception( 'INVALID_TYPE', '1F363/4', 400 );
throw new Exception( 'INVALID_TYPE', '1F363/4', 400 );
}
}
if ( isset( \IPS\Request::i()->password ) )
if ( isset( Request::i()->password ) )
{
$forum->password = \IPS\Request::i()->password;
$forum->password = Request::i()->password;
}
if ( isset( \IPS\Request::i()->theme ) )
if ( isset( Request::i()->theme ) )
{
$forum->skin_id = \IPS\Request::i()->theme;
$forum->skin_id = Request::i()->theme;
}
if ( isset( \IPS\Request::i()->sitemap_priority ) )
if ( isset( Request::i()->sitemap_priority ) )
{
$forum->ipseo_priority = \IPS\Request::i()->sitemap_priority;
$forum->ipseo_priority = Request::i()->sitemap_priority;
}
if ( isset( \IPS\Request::i()->min_content ) )
if ( isset( Request::i()->min_content ) )
{
$forum->min_content = \IPS\Request::i()->min_content;
$forum->min_content = Request::i()->min_content;
}
if ( isset( \IPS\Request::i()->can_see_others ) )
if ( isset( Request::i()->can_see_others ) )
{
$forum->can_view_others = \IPS\Request::i()->can_see_others;
$forum->can_view_others = Request::i()->can_see_others;
}
$forum = parent::_createOrUpdate( $forum );
unset( \IPS\Data\Store::i()->forumsCustomNodes );
unset( Store::i()->forumsCustomNodes );
return $forum;
}