Version 4.1.19
This commit is contained in:
Neo committed
1 parent
28bd025b35
commit
2bd5025018
2674 files changed
+233518
-77766
No files matched your search
@@ -0,0 +1,227 @@
|
||||
<?php
|
||||
/**
|
||||
* @brief API Key
|
||||
* @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
|
||||
* @since 3 Dec 2015
|
||||
* @version SVN_VERSION_NUMBER
|
||||
*/
|
||||
|
||||
namespace IPS\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;
|
||||
}
|
||||
|
||||
/**
|
||||
* API Key
|
||||
*/
|
||||
class _Key extends \IPS\Node\Model
|
||||
{
|
||||
/**
|
||||
* @brief [ActiveRecord] Multiton Store
|
||||
*/
|
||||
protected static $multitons;
|
||||
|
||||
/**
|
||||
* @brief [ActiveRecord] Database Table
|
||||
*/
|
||||
public static $databaseTable = 'core_api_keys';
|
||||
|
||||
/**
|
||||
* @brief Database Prefix
|
||||
*/
|
||||
public static $databasePrefix = 'api_';
|
||||
|
||||
/**
|
||||
* @brief [Node] Node Title
|
||||
*/
|
||||
public static $nodeTitle = 'api_keys';
|
||||
|
||||
/**
|
||||
* @brief [Node] ACP Restrictions
|
||||
* @code
|
||||
array(
|
||||
'app' => 'core', // The application key which holds the restrictrions
|
||||
'module' => 'foo', // The module key which holds the restrictions
|
||||
'map' => array( // [Optional] The key for each restriction - can alternatively use "prefix"
|
||||
'add' => 'foo_add',
|
||||
'edit' => 'foo_edit',
|
||||
'permissions' => 'foo_perms',
|
||||
'delete' => 'foo_delete'
|
||||
),
|
||||
'all' => 'foo_manage', // [Optional] The key to use for any restriction not provided in the map (only needed if not providing all 4)
|
||||
'prefix' => 'foo_', // [Optional] Rather than specifying each key in the map, you can specify a prefix, and it will automatically look for restrictions with the key "[prefix]_add/edit/permissions/delete"
|
||||
* @endcode
|
||||
*/
|
||||
protected static $restrictions = array(
|
||||
'app' => 'core',
|
||||
'module' => 'applications',
|
||||
'prefix' => 'api_',
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief [Node] Title prefix. If specified, will look for a language key with "{$key}_title" as the key
|
||||
*/
|
||||
public static $titleLangPrefix = 'core_api_name_';
|
||||
|
||||
/**
|
||||
* Get description
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get__description()
|
||||
{
|
||||
return \IPS\Theme::i()->getTemplate('api')->apiKey( $this->id );
|
||||
}
|
||||
|
||||
/**
|
||||
* Check access
|
||||
*
|
||||
* @param string $app Application key
|
||||
* @param string $controller Controller
|
||||
* @param string $method Method
|
||||
* @return bool
|
||||
*/
|
||||
public function canAccess( $app, $controller, $method )
|
||||
{
|
||||
$permissions = json_decode( $this->permissions, TRUE );
|
||||
return isset( $permissions["{$app}/{$controller}/{$method}"] ) and $permissions["{$app}/{$controller}/{$method}"]['access'] == TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Should log?
|
||||
*
|
||||
* @param string $app Application key
|
||||
* @param string $controller Controller
|
||||
* @param string $method Method
|
||||
* @return bool
|
||||
*/
|
||||
public function shouldLog( $app, $controller, $method )
|
||||
{
|
||||
$permissions = json_decode( $this->permissions, TRUE );
|
||||
return isset( $permissions["{$app}/{$controller}/{$method}"] ) and isset( $permissions["{$app}/{$controller}/{$method}"]['log'] ) and $permissions["{$app}/{$controller}/{$method}"]['log'] == TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* [Node] Add/Edit Form
|
||||
*
|
||||
* @param \IPS\Helpers\Form $form The form
|
||||
* @return void
|
||||
*/
|
||||
public function form( &$form )
|
||||
{
|
||||
/* API Key */
|
||||
$form->add( new \IPS\Helpers\Form\Custom( 'api_id', $this->id ?: md5( uniqid() ), TRUE, array(
|
||||
'getHtml' => function( $field )
|
||||
{
|
||||
return \IPS\Theme::i()->getTemplate('api')->apiKeyField( $field->name, $field->value );
|
||||
},
|
||||
'disableCopy' => TRUE
|
||||
) ) );
|
||||
|
||||
/* Description */
|
||||
$form->add( new \IPS\Helpers\Form\Translatable( 'api_name', NULL, TRUE, array( 'app' => 'core', 'key' => ( $this->id ? "core_api_name_{$this->id}" : NULL ) ) ) );
|
||||
|
||||
/* Allowed IPs */
|
||||
$form->add( new \IPS\Helpers\Form\Radio( 'api_enable_ip_restriction', intval( $this->allowed_ips !== NULL ), FALSE, array(
|
||||
'options' => array(
|
||||
0 => 'api_enable_ip_restriction_off',
|
||||
1 => 'api_enable_ip_restriction_on',
|
||||
),
|
||||
'toggles' => array(
|
||||
1 => array( 'api_allowed_ips' )
|
||||
)
|
||||
) ) );
|
||||
|
||||
if ( \IPS\Request::i()->isCgi() )
|
||||
{
|
||||
\IPS\Member::loggedIn()->language()->words['api_enable_ip_restriction_warning'] = \IPS\Member::loggedIn()->language()->addToStack('api_enable_ip_restriction__warning');
|
||||
}
|
||||
|
||||
$form->add( new \IPS\Helpers\Form\Stack( 'api_allowed_ips', explode( ',', $this->allowed_ips ), NULL, array(), function( $val )
|
||||
{
|
||||
if ( $val )
|
||||
{
|
||||
foreach ( array_filter( is_array( $val ) ? $val : array( $val ) ) as $ip )
|
||||
{
|
||||
if ( filter_var( $ip, FILTER_VALIDATE_IP ) === FALSE )
|
||||
{
|
||||
throw new \DomainException( \IPS\Member::loggedIn()->language()->addToStack( 'api_allowed_ips_err', FALSE, array( 'sprintf' => array( $ip ) ) ) );
|
||||
}
|
||||
}
|
||||
}
|
||||
}, NULL, NULL, 'api_allowed_ips' ) );
|
||||
|
||||
/* Permissions */
|
||||
$form->add( new \IPS\Helpers\Form\Custom( 'api_permissions', $this->permissions ? json_decode( $this->permissions, TRUE ) : array(), FALSE, array(
|
||||
'rowHtml' => function( $field )
|
||||
{
|
||||
$endpoints = \IPS\Api\Controller::getAllEndpoints();
|
||||
foreach ( $endpoints as $key => $endpoint )
|
||||
{
|
||||
$pieces = explode('/', $key);
|
||||
$endpointTree[ $pieces[0] ][ $pieces[1] ][ $key ] = $endpoint;
|
||||
}
|
||||
|
||||
return \IPS\Theme::i()->getTemplate( 'api' )->permissionsField( $endpointTree, $field->name, $field->value );
|
||||
}
|
||||
) ) );
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* [Node] Format form values from add/edit form for save
|
||||
*
|
||||
* @param array $values Values from the form
|
||||
* @return array
|
||||
*/
|
||||
public function formatFormValues( $values )
|
||||
{
|
||||
$values['api_permissions'] = json_encode( $values['api_permissions'] );
|
||||
|
||||
if ( !$values['api_enable_ip_restriction'] )
|
||||
{
|
||||
$values['api_allowed_ips'] = NULL;
|
||||
}
|
||||
unset( $values['api_enable_ip_restriction'] );
|
||||
|
||||
if ( !$this->id )
|
||||
{
|
||||
$this->id = $values['api_id'];
|
||||
$this->save();
|
||||
}
|
||||
|
||||
\IPS\Lang::saveCustom( 'core', "core_api_name_{$this->id}", $values['api_name'] );
|
||||
unset( $values['api_name'] );
|
||||
|
||||
return $values;
|
||||
}
|
||||
|
||||
/**
|
||||
* [ActiveRecord] Duplicate
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function __clone()
|
||||
{
|
||||
if ( $this->skipCloneDuplication === TRUE )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
$oldId = $this->id;
|
||||
|
||||
$this->id = md5( uniqid() );
|
||||
$this->_new = TRUE;
|
||||
$this->save();
|
||||
|
||||
/* ...and language */
|
||||
\IPS\Lang::saveCustom( 'core', 'core_api_name_' . $this->id, iterator_to_array( \IPS\Db::i()->select( 'word_custom, lang_id', 'core_sys_lang_words', array( 'word_key=?', 'core_api_name_' . $oldId ) )->setKeyField( 'lang_id' )->setValueField( 'word_custom' ) ) );
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user