Version 5.0.0 beta 1
This commit is contained in:
Neo committed
1 parent
25ddeb65d6
commit
15c7beabc5
6736 files changed
+627902
-497943
No files matched your search
@@ -11,30 +11,46 @@
|
||||
namespace IPS\Node\Api;
|
||||
|
||||
/* To prevent PHP errors (extending class does not exist) revealing path */
|
||||
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
||||
|
||||
use IPS\Api\Controller;
|
||||
use IPS\Api\Exception;
|
||||
use IPS\Api\PaginatedResponse;
|
||||
use IPS\Api\Response;
|
||||
use IPS\Db;
|
||||
use IPS\IPS;
|
||||
use IPS\Node\Model;
|
||||
use IPS\Node\Permissions;
|
||||
use IPS\Request;
|
||||
use OutOfRangeException;
|
||||
use function defined;
|
||||
use function in_array;
|
||||
use function is_array;
|
||||
|
||||
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 Base API endpoint for Nodes
|
||||
*/
|
||||
class _NodeController extends \IPS\Api\Controller
|
||||
class NodeController extends Controller
|
||||
{
|
||||
/**
|
||||
* List
|
||||
*
|
||||
* @param array $where Extra WHERE clause
|
||||
* @return \IPS\Api\PaginatedResponse
|
||||
* @return PaginatedResponse
|
||||
*/
|
||||
protected function _list( $where = array() )
|
||||
protected function _list( array $where = array() ) : PaginatedResponse
|
||||
{
|
||||
$class = $this->class;
|
||||
|
||||
if ( $this->member and \in_array( 'IPS\Node\Permissions', class_implements( $class ) ) )
|
||||
|
||||
/* @var array $permissionMap */
|
||||
if ( $this->member and in_array( 'IPS\Node\Permissions', class_implements( $class ) ) )
|
||||
{
|
||||
$where[] = array( '(' . \IPS\Db::i()->findInSet( 'core_permission_index.perm_' . $class::$permissionMap['view'], $this->member->permissionArray() ) . ' OR ' . 'core_permission_index.perm_' . $class::$permissionMap['view'] . '=? )', '*' );
|
||||
$where[] = array( '(' . Db::i()->findInSet( 'core_permission_index.perm_' . $class::$permissionMap['view'], $this->member->permissionArray() ) . ' OR ' . 'core_permission_index.perm_' . $class::$permissionMap['view'] . '=? )', '*' );
|
||||
if ( $class::$databaseColumnEnabledDisabled )
|
||||
{
|
||||
$where[] = array( $class::$databasePrefix . $class::$databaseColumnEnabledDisabled . '=1' );
|
||||
@@ -42,28 +58,28 @@ class _NodeController extends \IPS\Api\Controller
|
||||
}
|
||||
|
||||
/* Exclude clubs? */
|
||||
if ( \IPS\IPS::classUsesTrait( $class, 'IPS\Content\ClubContainer' ) AND isset( \IPS\Request::i()->clubs ) AND !\IPS\Request::i()->clubs )
|
||||
if ( IPS::classUsesTrait( $class, 'IPS\Content\ClubContainer' ) AND isset( Request::i()->clubs ) AND !Request::i()->clubs )
|
||||
{
|
||||
$where[] = array( $class::$databasePrefix . $class::clubIdColumn() . ' IS NULL' );
|
||||
}
|
||||
|
||||
$select = \IPS\Db::i()->select( '*', $class::$databaseTable, $where, $class::$databaseColumnOrder ? $class::$databasePrefix . $class::$databaseColumnOrder . " asc" : NULL );
|
||||
$select = Db::i()->select( '*', $class::$databaseTable, $where, $class::$databaseColumnOrder ? $class::$databasePrefix . $class::$databaseColumnOrder . " asc" : NULL );
|
||||
|
||||
/* Return permissions */
|
||||
if ( \in_array( 'IPS\Node\Permissions', class_implements( $class ) ) )
|
||||
if ( in_array( 'IPS\Node\Permissions', class_implements( $class ) ) )
|
||||
{
|
||||
$select->join( 'core_permission_index', array( "core_permission_index.app=? AND core_permission_index.perm_type=? AND core_permission_index.perm_type_id=" . $class::$databaseTable . "." . $class::$databasePrefix . $class::$databaseColumnId, $class::$permApp, $class::$permType ) );
|
||||
}
|
||||
|
||||
/* Return */
|
||||
return new \IPS\Api\PaginatedResponse(
|
||||
return new PaginatedResponse(
|
||||
200,
|
||||
$select,
|
||||
isset( \IPS\Request::i()->page ) ? \IPS\Request::i()->page : 1,
|
||||
isset( Request::i()->page ) ? Request::i()->page : 1,
|
||||
$class,
|
||||
NULL,
|
||||
$this->member,
|
||||
isset( \IPS\Request::i()->perPage ) ? \IPS\Request::i()->perPage : NULL
|
||||
isset( Request::i()->perPage ) ? Request::i()->perPage : NULL
|
||||
);
|
||||
}
|
||||
|
||||
@@ -71,19 +87,19 @@ class _NodeController extends \IPS\Api\Controller
|
||||
* View
|
||||
*
|
||||
* @param int $id ID Number
|
||||
* @return \IPS\Api\Response
|
||||
* @return Response
|
||||
*/
|
||||
protected function _view( $id )
|
||||
protected function _view( int $id ) : Response
|
||||
{
|
||||
$class = $this->class;
|
||||
|
||||
$node = $class::load( $id );
|
||||
if ( $this->member and !$node->can( 'view', $this->member ) )
|
||||
{
|
||||
throw new \OutOfRangeException;
|
||||
throw new OutOfRangeException;
|
||||
}
|
||||
|
||||
return new \IPS\Api\Response( 200, $node->apiOutput( $this->member ) );
|
||||
return new Response( 200, $node->apiOutput( $this->member ) );
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -94,9 +110,9 @@ class _NodeController extends \IPS\Api\Controller
|
||||
* @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 \IPS\Api\Response
|
||||
* @return Response
|
||||
*/
|
||||
protected function _delete( $id, $deleteChildrenOrMove = NULL )
|
||||
protected function _delete( int $id, ?int $deleteChildrenOrMove = NULL ) : Response
|
||||
{
|
||||
$class = $this->class;
|
||||
|
||||
@@ -118,15 +134,15 @@ class _NodeController extends \IPS\Api\Controller
|
||||
$target = $class::load( $deleteChildrenOrMove );
|
||||
$node->deleteOrMoveFormSubmit( array( 'node_move_children' => TRUE, 'node_destination' => $target->_id, 'node_move_content' => $target ) );
|
||||
}
|
||||
catch ( \OutOfRangeException $e )
|
||||
catch ( OutOfRangeException $e )
|
||||
{
|
||||
throw new \IPS\Api\Exception( 'INVALID_TARGET', '1S359/2', 404 );
|
||||
throw new Exception( 'INVALID_TARGET', '1S359/2', 404 );
|
||||
}
|
||||
}
|
||||
/* Or return an exception if no action was set */
|
||||
if ( !$deleteChildrenOrMove )
|
||||
{
|
||||
throw new \IPS\Api\Exception( 'HAS_CHILDREN', '1S359/3', 404 );
|
||||
throw new Exception( 'HAS_CHILDREN', '1S359/3', 404 );
|
||||
}
|
||||
}
|
||||
else
|
||||
@@ -134,25 +150,25 @@ class _NodeController extends \IPS\Api\Controller
|
||||
$node->delete();
|
||||
}
|
||||
|
||||
return new \IPS\Api\Response( 200, NULL );
|
||||
return new Response( 200, NULL );
|
||||
}
|
||||
catch ( \OutOfRangeException $e )
|
||||
catch ( OutOfRangeException $e )
|
||||
{
|
||||
throw new \IPS\Api\Exception( 'INVALID_ID', '1S359/1', 404 );
|
||||
throw new Exception( 'INVALID_ID', '1S359/1', 404 );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create or update node
|
||||
*
|
||||
* @param \IPS\node\Model $node The node
|
||||
* @return \IPS\node\Model
|
||||
* @param Model $node The node
|
||||
* @return Model
|
||||
*/
|
||||
protected function _createOrUpdate( \IPS\Node\Model $node )
|
||||
protected function _createOrUpdate( Model $node ): Model
|
||||
{
|
||||
$node->save();
|
||||
|
||||
if( $node instanceof \IPS\Node\Permissions AND isset( \IPS\Request::i()->permissions ) AND \IPS\Request::i()->permissions )
|
||||
if( $node instanceof Permissions AND isset( Request::i()->permissions ) AND Request::i()->permissions )
|
||||
{
|
||||
$insert = array(
|
||||
'app' => $node::$permApp,
|
||||
@@ -162,9 +178,9 @@ class _NodeController extends \IPS\Api\Controller
|
||||
|
||||
foreach( $node::$permissionMap as $key => $field )
|
||||
{
|
||||
if( isset( \IPS\Request::i()->permissions[ $key ] ) )
|
||||
if( isset( Request::i()->permissions[ $key ] ) )
|
||||
{
|
||||
$insert[ 'perm_' . $field ] = \is_array( \IPS\Request::i()->permissions[ $key ] ) ? implode( ',', \IPS\Request::i()->permissions[ $key ] ) : \IPS\Request::i()->permissions[ $key ];
|
||||
$insert[ 'perm_' . $field ] = is_array( Request::i()->permissions[ $key ] ) ? implode( ',', Request::i()->permissions[ $key ] ) : Request::i()->permissions[ $key ];
|
||||
}
|
||||
}
|
||||
|
||||
@@ -178,9 +194,9 @@ class _NodeController extends \IPS\Api\Controller
|
||||
/**
|
||||
* Create
|
||||
*
|
||||
* @return \IPS\Content\Node
|
||||
* @return Model
|
||||
*/
|
||||
protected function _create()
|
||||
protected function _create() : Model
|
||||
{
|
||||
$class = $this->class;
|
||||
|
||||
@@ -190,14 +206,13 @@ class _NodeController extends \IPS\Api\Controller
|
||||
if( isset( $node::$databaseColumnOrder ) AND $node::$automaticPositionDetermination === TRUE )
|
||||
{
|
||||
$orderColumn = $node::$databaseColumnOrder;
|
||||
$node->$orderColumn = \IPS\Db::i()->select( 'MAX(' . $node::$databasePrefix . $orderColumn . ')', $node::$databaseTable )->first() + 1;
|
||||
$node->$orderColumn = Db::i()->select( 'MAX(' . $node::$databasePrefix . $orderColumn . ')', $node::$databaseTable )->first() + 1;
|
||||
}
|
||||
|
||||
$node->save();
|
||||
$node = $this->_createOrUpdate( $node );
|
||||
|
||||
/* Output */
|
||||
return $node;
|
||||
return $this->_createOrUpdate( $node );
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -213,9 +228,9 @@ class _NodeController extends \IPS\Api\Controller
|
||||
$where = $where ?: [];
|
||||
$idField = $class::$databaseTable . '.' . $class::$databasePrefix . '.' . $class::$databaseColumnId;
|
||||
|
||||
if ( isset( \IPS\Request::i()->ids ) )
|
||||
if ( isset( Request::i()->ids ) )
|
||||
{
|
||||
$where[] = array( \IPS\Db::i()->in( $idField, array_map( 'intval', explode(',', \IPS\Request::i()->ids ) ) ) );
|
||||
$where[] = array( Db::i()->in( $idField, array_map( 'intval', explode(',', Request::i()->ids ) ) ) );
|
||||
}
|
||||
|
||||
return $where;
|
||||
|
||||
Reference in new issue
Block a user