283 lines
7.8 KiB
PHP
283 lines
7.8 KiB
PHP
<?php
|
|
/**
|
|
* @brief Members 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
|
|
* @since 3 Dec 2015
|
|
*/
|
|
|
|
namespace IPS\core\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 Members API
|
|
*/
|
|
class _members extends \IPS\Api\Controller
|
|
{
|
|
/**
|
|
* GET /core/members
|
|
* Get list of members
|
|
*
|
|
* @apiparam string sortBy What to sort by. Can be 'joined', 'name' 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\Member>
|
|
*/
|
|
public function GETindex()
|
|
{
|
|
/* Where clause */
|
|
$where = array();
|
|
|
|
/* Sort */
|
|
$sortBy = ( isset( \IPS\Request::i()->sortBy ) and in_array( \IPS\Request::i()->sortBy, array( 'name', 'joined' ) ) ) ? \IPS\Request::i()->sortBy : 'member_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( '*', 'core_members', $where, "{$sortBy} {$sortDir}", NULL, NULL, NULL, \IPS\Db::SELECT_SQL_CALC_FOUND_ROWS ),
|
|
isset( \IPS\Request::i()->page ) ? \IPS\Request::i()->page : 1,
|
|
'IPS\Member',
|
|
\IPS\Db::i()->select( 'COUNT(*)', 'core_members', $where )->first()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* GET /core/members/{id}
|
|
* Get information about a specific member
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 1C292/2 INVALID_ID The member ID does not exist
|
|
* @return \IPS\Member
|
|
*/
|
|
public function GETitem( $id )
|
|
{
|
|
try
|
|
{
|
|
$member = \IPS\Member::load( $id );
|
|
if ( !$member->member_id )
|
|
{
|
|
throw new \OutOfRangeException;
|
|
}
|
|
|
|
return new \IPS\Api\Response( 200, $member->apiOutput() );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '1C292/2', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create or update member
|
|
*
|
|
* @param \IPS\Member $member The member
|
|
* @apiparam int group Group ID number
|
|
* @throws 1C292/4 USERNAME_EXISTS The username provided is already in use
|
|
* @throws 1C292/5 EMAIL_EXISTS The email address provided is already in use
|
|
* @throws 1C292/6 INVALID_GROUP The group ID provided is not valid
|
|
* @return \IPS\Member
|
|
*/
|
|
protected function _createOrUpdate( $member )
|
|
{
|
|
if ( isset( \IPS\Request::i()->name ) and \IPS\Request::i()->name != $member->name )
|
|
{
|
|
$existingUsername = \IPS\Member::load( \IPS\Request::i()->name, 'name' );
|
|
if ( !$existingUsername->member_id )
|
|
{
|
|
$member->name = \IPS\Request::i()->name;
|
|
}
|
|
else
|
|
{
|
|
throw new \IPS\Api\Exception( 'USERNAME_EXISTS', '1C292/4', 403 );
|
|
}
|
|
}
|
|
|
|
if ( isset( \IPS\Request::i()->email ) and \IPS\Request::i()->email != $member->email )
|
|
{
|
|
$existingEmail = \IPS\Member::load( \IPS\Request::i()->email, 'email' );
|
|
if ( !$existingEmail->member_id )
|
|
{
|
|
$member->email = \IPS\Request::i()->email;
|
|
$member->invalidateSessionsAndLogins();
|
|
}
|
|
else
|
|
{
|
|
throw new \IPS\Api\Exception( 'EMAIL_EXISTS', '1C292/5', 403 );
|
|
}
|
|
}
|
|
|
|
if ( isset( \IPS\Request::i()->group ) )
|
|
{
|
|
try
|
|
{
|
|
$group = \IPS\Member\Group::load( \IPS\Request::i()->group );
|
|
$member->member_group_id = $group->g_id;
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_GROUP', '1C292/6', 403 );
|
|
}
|
|
}
|
|
|
|
if ( isset( \IPS\Request::i()->password ) )
|
|
{
|
|
foreach ( \IPS\Login::handlers( TRUE ) as $handler )
|
|
{
|
|
try
|
|
{
|
|
$handler->changePassword( $member, \IPS\Request::i()->password );
|
|
}
|
|
catch( \BadMethodCallException $e ){}
|
|
}
|
|
$member->invalidateSessionsAndLogins();
|
|
}
|
|
else
|
|
{
|
|
$member->save();
|
|
}
|
|
|
|
/* Any custom fields? */
|
|
if( isset( \IPS\Request::i()->customFields ) )
|
|
{
|
|
/* Profile Fields */
|
|
try
|
|
{
|
|
$profileFields = \IPS\Db::i()->select( '*', 'core_pfields_content', array( 'member_id=?', $member->member_id ) )->first();
|
|
}
|
|
catch( \UnderflowException $e )
|
|
{
|
|
$profileFields = array();
|
|
}
|
|
|
|
/* If \IPS\Db::i()->select()->first() has only one column, then the contents of that column is returned. We do not want this here. */
|
|
if ( !is_array( $profileFields ) )
|
|
{
|
|
$profileFields = array();
|
|
}
|
|
|
|
$profileFields['member_id'] = $member->member_id;
|
|
|
|
foreach ( \IPS\Request::i()->customFields as $k => $v )
|
|
{
|
|
$profileFields[ 'field_' . $k ] = $v;
|
|
}
|
|
|
|
\IPS\Db::i()->replace( 'core_pfields_content', $profileFields );
|
|
|
|
$member->changedCustomFields = $profileFields;
|
|
$member->save();
|
|
}
|
|
|
|
return $member;
|
|
}
|
|
|
|
/**
|
|
* POST /core/members
|
|
* Create a member
|
|
*
|
|
* @apiparam string name Username
|
|
* @apiparam string email Email address
|
|
* @apiparam string password Password
|
|
* @apiparam int group Group ID number
|
|
* @apiparam object customFields Array of custom fields as fieldId => fieldValue
|
|
* @throws 1C292/4 USERNAME_EXISTS The username provided is already in use
|
|
* @throws 1C292/5 EMAIL_EXISTS The email address provided is already in use
|
|
* @throws 1C292/6 INVALID_GROUP The group ID provided is not valid
|
|
* @throws 1C292/8 NO_USERNAME_OR_EMAIL No Username or Email Address was provided for the account
|
|
* @throws 1C292/9 NO_PASSWORD No password was provided for the account
|
|
* @return \IPS\Member
|
|
*/
|
|
public function POSTindex()
|
|
{
|
|
/* One of these must be provided to ensure user can log in. */
|
|
if ( !isset( \IPS\Request::i()->name ) AND !isset( \IPS\Request::i()->email ) )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_USERNAME_OR_EMAIL', '1C292/8', 403 );
|
|
}
|
|
|
|
/* This is required as there is no other way to allow the account to be authenticated when it is created via the API */
|
|
if ( !isset( \IPS\Request::i()->password ) )
|
|
{
|
|
throw new \IPS\Api\Exception( 'NO_PASSWORD', '1C292/9', 403 );
|
|
}
|
|
|
|
$member = new \IPS\Member;
|
|
$member->member_group_id = \IPS\Settings::i()->member_group;
|
|
|
|
$member = $this->_createOrUpdate( $member );
|
|
|
|
return new \IPS\Api\Response( 201, $member->apiOutput() );
|
|
}
|
|
|
|
/**
|
|
* POST /core/members/{id}
|
|
* Edit a member
|
|
*
|
|
* @apiparam string name Username
|
|
* @apiparam string email Email address
|
|
* @apiparam string password Password
|
|
* @apiparam int group Group ID number
|
|
* @apiparam object customFields Array of custom fields as fieldId => fieldValue
|
|
* @param int $id ID Number
|
|
* @throws 2C292/7 INVALID_ID The member ID does not exist
|
|
* @throws 1C292/4 USERNAME_EXISTS The username provided is already in use
|
|
* @throws 1C292/5 EMAIL_EXISTS The email address provided is already in use
|
|
* @return \IPS\Member
|
|
*/
|
|
public function POSTitem( $id )
|
|
{
|
|
try
|
|
{
|
|
$member = \IPS\Member::load( $id );
|
|
if ( !$member->member_id )
|
|
{
|
|
throw new \OutOfRangeException;
|
|
}
|
|
|
|
$member = $this->_createOrUpdate( $member );
|
|
|
|
return new \IPS\Api\Response( 200, $member->apiOutput() );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '2C292/7', 404 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* DELETE /core/members/{id}
|
|
* Deletes a member
|
|
*
|
|
* @param int $id ID Number
|
|
* @throws 1C292/2 INVALID_ID The member ID does not exist
|
|
* @return void
|
|
*/
|
|
public function DELETEitem( $id )
|
|
{
|
|
try
|
|
{
|
|
$member = \IPS\Member::load( $id );
|
|
if ( !$member->member_id )
|
|
{
|
|
throw new \OutOfRangeException;
|
|
}
|
|
|
|
$member->delete();
|
|
|
|
return new \IPS\Api\Response( 200, NULL );
|
|
}
|
|
catch ( \OutOfRangeException $e )
|
|
{
|
|
throw new \IPS\Api\Exception( 'INVALID_ID', '1C292/2', 404 );
|
|
}
|
|
}
|
|
} |