Moved files and added namespaces
This commit is contained in:
Josh Sherman
parent
8a1ac4fb47
commit
48c5289060
22 changed files with 46 additions and 66 deletions
423
src/Resource.php
Normal file
423
src/Resource.php
Normal file
|
|
@ -0,0 +1,423 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* Resource Class File for PICKLES
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* Redistribution of these files must retain the above copyright notice.
|
||||
*
|
||||
* @author Josh Sherman <josh@gravityblvd.com>
|
||||
* @copyright Copyright 2007-2014, Josh Sherman
|
||||
* @license http://www.opensource.org/licenses/mit-license.html
|
||||
* @package PICKLES
|
||||
* @link https://github.com/joshtronic/pickles
|
||||
*/
|
||||
|
||||
namespace Pickles;
|
||||
|
||||
/**
|
||||
* Resource Class
|
||||
*
|
||||
* This is a parent class that all PICKLES modules should be extending. Each
|
||||
* module can specify it's own meta data and whether or not a user must be
|
||||
* properly authenticated to view the page. Currently any pages without a
|
||||
* template are treated as pages being requested via AJAX and the return will
|
||||
* be JSON encoded. In the future this may need to be changed out for logic
|
||||
* that allows the requested module to specify what display type(s) it can use.
|
||||
*/
|
||||
class Resource extends Object
|
||||
{
|
||||
/**
|
||||
* HTTPS
|
||||
*
|
||||
* Whether or not the page should be loaded via HTTP Secure.
|
||||
*
|
||||
* @var boolean defaults to false
|
||||
*/
|
||||
public $https = false;
|
||||
|
||||
/**
|
||||
* Filter
|
||||
*
|
||||
* Variables to filter.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $filter = [];
|
||||
|
||||
/**
|
||||
* Validate
|
||||
*
|
||||
* Variables to validate.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $validate = [];
|
||||
|
||||
// @todo Document this
|
||||
public $description = [];
|
||||
public $auth = false;
|
||||
public $status = 200;
|
||||
public $message = 'OK';
|
||||
public $echo = false;
|
||||
public $limit = false;
|
||||
public $offset = false;
|
||||
public $errors = [];
|
||||
public $uids = [];
|
||||
public $response = false;
|
||||
public $profiler = false;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* The constructor does nothing by default but can be passed a boolean
|
||||
* variable to tell it to automatically run the __default() method. This is
|
||||
* typically used when a module is called outside of the scope of the
|
||||
* controller (the registration page calls the login page in this manner.
|
||||
*/
|
||||
public function __construct($uids = false)
|
||||
{
|
||||
parent::__construct();
|
||||
|
||||
$this->uids = $uids;
|
||||
$method = $_SERVER['REQUEST_METHOD'];
|
||||
|
||||
try
|
||||
{
|
||||
// Determines if we need to serve over HTTP or HTTPS
|
||||
if ($this->https === true
|
||||
|| (isset($this->https[$method]) && $this->https[$method]))
|
||||
{
|
||||
if (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == false)
|
||||
{
|
||||
throw new Exception('400 - SSL is required.');
|
||||
}
|
||||
}
|
||||
|
||||
// Check auth if flag is explicitly true or is true for the method
|
||||
if ($this->auth === true
|
||||
|| (isset($this->auth[$method]) && $this->auth[$method]))
|
||||
{
|
||||
if (!$this->config->pickles['auth'])
|
||||
{
|
||||
throw new Exception('401 - Authentication is not configured properly.');
|
||||
}
|
||||
|
||||
// This class should be in the classes directory of the service
|
||||
$auth = new Auth();
|
||||
|
||||
switch ($this->config->pickles['auth'])
|
||||
{
|
||||
case 'basic':
|
||||
$auth->basic();
|
||||
break;
|
||||
|
||||
case 'oauth2':
|
||||
$auth->oauth2();
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new Exception('401 - Invalid authentication scheme.');
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
$filter = isset($this->filter[$method]);
|
||||
$validate = isset($this->validate[$method]);
|
||||
|
||||
if ($filter || $validate)
|
||||
{
|
||||
// Hack together some new globals
|
||||
if (in_array($method, ['PUT', 'DELETE']))
|
||||
{
|
||||
$GLOBALS['_' . $method] = [];
|
||||
|
||||
// @todo Populate it
|
||||
}
|
||||
|
||||
$global =& $GLOBALS['_' . $method];
|
||||
|
||||
// Checks that the required parameters are present
|
||||
// @todo Add in support for uid:* variables
|
||||
if ($validate)
|
||||
{
|
||||
$variables = [];
|
||||
|
||||
foreach ($this->validate[$method] as $variable => $rules)
|
||||
{
|
||||
if (!is_array($rules))
|
||||
{
|
||||
$variable = $rules;
|
||||
}
|
||||
|
||||
$variables[] = $variable;
|
||||
}
|
||||
|
||||
$missing_variables = array_diff($variables, array_keys($global));
|
||||
|
||||
if ($missing_variables !== array())
|
||||
{
|
||||
foreach ($missing_variables as $variable)
|
||||
{
|
||||
$this->errors[$variable][] = 'The ' . $variable . ' parameter is required.';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($global as $variable => $value)
|
||||
{
|
||||
// Applies any filters
|
||||
if ($filter && isset($this->filter[$method][$variable]))
|
||||
{
|
||||
$function = $this->filter[$method][$variable];
|
||||
|
||||
if ($function == 'password_hash')
|
||||
{
|
||||
$global[$variable] = password_hash($value, PASSWORD_DEFAULT);
|
||||
}
|
||||
else
|
||||
{
|
||||
$global[$variable] = $function($value);
|
||||
}
|
||||
}
|
||||
|
||||
if ($validate && isset($this->validate[$method][$variable]))
|
||||
{
|
||||
$rules = $this->validate[$method][$variable];
|
||||
|
||||
if (is_array($rules))
|
||||
{
|
||||
if (isset($global[$variable]) && !String::isEmpty($global[$variable]))
|
||||
{
|
||||
if (is_array($rules))
|
||||
{
|
||||
foreach ($rules as $rule => $message)
|
||||
{
|
||||
$rule = explode(':', $rule);
|
||||
|
||||
switch (strtolower($rule[0]))
|
||||
{
|
||||
// {{{ Checks using filter_var()
|
||||
|
||||
case 'filter':
|
||||
if (count($rule) < 2)
|
||||
{
|
||||
throw new Exception('Invalid validation rule, expected: "validate:boolean|email|float|int|ip|url".');
|
||||
}
|
||||
else
|
||||
{
|
||||
switch (strtolower($rule[1]))
|
||||
{
|
||||
case 'boolean':
|
||||
case 'email':
|
||||
case 'float':
|
||||
case 'int':
|
||||
case 'ip':
|
||||
case 'url':
|
||||
$filter = constant('FILTER_VALIDATE_' . strtoupper($rule[1]));
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new Exception('Invalid filter, expecting boolean, email, float, int, ip or url.');
|
||||
break;
|
||||
}
|
||||
|
||||
if (!filter_var($value, $filter))
|
||||
{
|
||||
$this->errors[$variable][] = $message;
|
||||
}
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
// }}}
|
||||
// {{{ Checks using strlen()
|
||||
|
||||
case 'length':
|
||||
if (count($rule) < 3)
|
||||
{
|
||||
throw new Exception('Invalid validation rule, expected: "length:<|<=|==|!=|>=|>:integer".');
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!filter_var($rule[2], FILTER_VALIDATE_INT))
|
||||
{
|
||||
throw new Exception('Invalid length value, expecting an integer.');
|
||||
}
|
||||
else
|
||||
{
|
||||
$length = strlen($value);
|
||||
|
||||
switch ($rule[1])
|
||||
{
|
||||
case '<':
|
||||
$valid = $length < $rule[2];
|
||||
break;
|
||||
|
||||
case '<=':
|
||||
$valid = $length <= $rule[2];
|
||||
break;
|
||||
|
||||
case '==':
|
||||
$valid = $length == $rule[2];
|
||||
break;
|
||||
|
||||
case '!=':
|
||||
$valid = $length != $rule[2];
|
||||
break;
|
||||
|
||||
case '>=':
|
||||
$valid = $length >= $rule[2];
|
||||
break;
|
||||
|
||||
case '>':
|
||||
$valid = $length > $rule[2];
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new Exception('Invalid operator, expecting <, <=, ==, !=, >= or >.');
|
||||
break;
|
||||
}
|
||||
|
||||
if (!$valid)
|
||||
{
|
||||
$this->errors[$variable][] = $message;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
break;
|
||||
|
||||
// }}}
|
||||
// {{{ Checks using preg_match()
|
||||
|
||||
case 'regex':
|
||||
if (count($rule) < 3)
|
||||
{
|
||||
throw new Exception('Invalid validation rule, expected: "regex:is|not:string".');
|
||||
}
|
||||
else
|
||||
{
|
||||
$rule[1] = strtolower($rule[1]);
|
||||
|
||||
if (($rule[1] == 'is' && preg_match($rule[2], $value))
|
||||
|| ($rule[1] == 'not' && !preg_match($rule[2], $value)))
|
||||
{
|
||||
$this->errors[$variable][] = $message;
|
||||
}
|
||||
}
|
||||
break;
|
||||
|
||||
// }}}
|
||||
// @todo case 'alpha':
|
||||
// @todo case 'alphanumeric':
|
||||
// @todo case 'date':
|
||||
// @todo case 'range':
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// if PUT or DELETE, need to update the super globals directly as
|
||||
// they do not stay in sync. Probably need to make them global in
|
||||
// this class method
|
||||
//
|
||||
// $_PUT = $GLOBALS['_PUT'];
|
||||
}
|
||||
|
||||
if ($this->errors)
|
||||
{
|
||||
throw new Exception('400 - Missing or invalid parameters.');
|
||||
}
|
||||
|
||||
parent::__construct(['cache', 'db']);
|
||||
|
||||
// Checks if the request method has been implemented
|
||||
//if (get_class($this) != 'Resource')
|
||||
{
|
||||
if (!method_exists($this, $method))
|
||||
{
|
||||
throw new Exception('405 - Method not allowed.');
|
||||
}
|
||||
else
|
||||
{
|
||||
// Gets the profiler status
|
||||
// @todo Refactor out that stripos
|
||||
$profiler = $this->config->pickles['profiler'];
|
||||
$profiler = $profiler === true
|
||||
|| stripos($profiler, 'timers') !== false;
|
||||
|
||||
// Starts a timer before the resource is executed
|
||||
if ($profiler)
|
||||
{
|
||||
Profiler::timer('resource ' . $method);
|
||||
}
|
||||
|
||||
$this->response = $this->$method();
|
||||
|
||||
// Stops the resource timer
|
||||
if ($profiler)
|
||||
{
|
||||
Profiler::timer('resource ' . $method);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception $e)
|
||||
{
|
||||
$this->status = 400;
|
||||
$this->message = $e->getMessage();
|
||||
}
|
||||
}
|
||||
|
||||
public function respond()
|
||||
{
|
||||
header('Content-Type: application/json');
|
||||
header('X-Powered-By: Pickles v2 - https://github.com/joshtronic/pickles');
|
||||
|
||||
$meta = [
|
||||
'status' => $this->status,
|
||||
'message' => $this->message,
|
||||
];
|
||||
|
||||
// Forces errors to be an array of arrays
|
||||
if ($this->errors)
|
||||
{
|
||||
foreach ($this->errors as $key => $error)
|
||||
{
|
||||
if (!is_array($error))
|
||||
{
|
||||
$this->errors[$key] = [$error];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach (['echo', 'limit', 'offset', 'errors'] as $variable)
|
||||
{
|
||||
if ($this->$variable)
|
||||
{
|
||||
$meta[$variable] = $this->$variable;
|
||||
}
|
||||
}
|
||||
|
||||
$response = ['meta' => $meta];
|
||||
|
||||
foreach (['response', 'profiler'] as $variable)
|
||||
{
|
||||
if ($this->$variable)
|
||||
{
|
||||
$response[$variable] = $this->$variable;
|
||||
}
|
||||
}
|
||||
|
||||
$pretty = isset($_REQUEST['pretty']) ? JSON_PRETTY_PRINT : false;
|
||||
|
||||
echo json_encode($response, $pretty);
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue