283 lines
7.6 KiB
PHP
283 lines
7.6 KiB
PHP
<?php
|
|
/**
|
|
* Copyright 2014 Openstack Foundation
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
**/
|
|
/**
|
|
* Class AbstractRestfulJsonApi
|
|
*/
|
|
abstract class AbstractRestfulJsonApi extends Controller {
|
|
|
|
protected $before_filters = array();
|
|
private $json;
|
|
protected $current_user;
|
|
|
|
public function __construct(){
|
|
parent::__construct();
|
|
$this->current_user = Member::currentUser();
|
|
register_shutdown_function(array($this,'shutdown_function'));
|
|
}
|
|
|
|
abstract protected function isApiCall();
|
|
|
|
|
|
protected function unauthorizedHttpBasicAuth($realm){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(401);
|
|
$response->addHeader('WWW-Authenticate', 'Basic realm="'.$realm.'"');
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* @return array|bool
|
|
*/
|
|
protected function isHttpBasicAuthPresent(){
|
|
$username = null;
|
|
$password = null;
|
|
// mod_php
|
|
if (isset($_SERVER['PHP_AUTH_USER'])) {
|
|
$username = $_SERVER['PHP_AUTH_USER'];
|
|
$password = $_SERVER['PHP_AUTH_PW'];
|
|
// most other servers
|
|
} elseif (isset($_SERVER['HTTP_AUTHENTICATION'])) {
|
|
|
|
if (strpos(strtolower($_SERVER['HTTP_AUTHENTICATION']),'basic')===0)
|
|
list($username,$password) = explode(':',base64_decode(substr($_SERVER['HTTP_AUTHORIZATION'], 6)));
|
|
|
|
}
|
|
if(is_null($username) && is_null($password))
|
|
return false;
|
|
return array($username,$password);
|
|
}
|
|
|
|
/**
|
|
* @return bool|Member
|
|
*/
|
|
protected function authenticate() {
|
|
if($this->current_user) return $this->current_user;
|
|
return false;
|
|
}
|
|
|
|
private function doBeforeFilter($action,$params){
|
|
if(array_key_exists($action,$this->before_filters)){
|
|
$filters = $this->before_filters[$action];
|
|
foreach($filters as $filter_name => $callback){
|
|
if($callback instanceof Closure){
|
|
$parameters = array($this->getRequest(),$action);
|
|
$res = call_user_func_array($callback, $parameters);
|
|
if($res) return $res;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determine if the request is sending JSON.
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function isJson()
|
|
{
|
|
$content_type_header = $this->request->getHeader('Content-Type');
|
|
if(empty($content_type_header)) return false;
|
|
return strpos($content_type_header, '/json')!==false;
|
|
}
|
|
|
|
/**
|
|
* Determine if the current request is asking for JSON in return.
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function wantsJson()
|
|
{
|
|
$accept_header = $this->request->getHeader('Accept');
|
|
if(empty($accept_header)) return false;
|
|
return strpos($accept_header,'/json')!==false;
|
|
}
|
|
|
|
/**
|
|
* @return bool|mixed
|
|
*/
|
|
public function getJsonRequest(){
|
|
if(!$this->json){
|
|
|
|
if(is_null($this->request)) return false;
|
|
if(!$this->isJson()) return false;
|
|
|
|
$body = $this->request->getBody();
|
|
$this->json= json_decode($body,true);
|
|
}
|
|
return $this->json;
|
|
}
|
|
|
|
protected function addBeforeFilter($action, $name,Closure $callback){
|
|
if(!array_key_exists($action, $this->before_filters)){
|
|
$this->before_filters[$action] = array();
|
|
}
|
|
$filters = $this->before_filters[$action];
|
|
if(!array_key_exists($name, $filters)){
|
|
$filters[$name] = $callback;
|
|
}
|
|
$this->before_filters[$action] = $filters;
|
|
}
|
|
|
|
public function handleRequest(SS_HTTPRequest $request, DataModel $model) {
|
|
|
|
$this->request = $request;
|
|
|
|
if(!$this->authenticate()){
|
|
return $this->permissionFailure();
|
|
}
|
|
if(!$this->authorize()){
|
|
return $this->permissionFailure();
|
|
}
|
|
|
|
$controller_class = ($this->class) ? $this->class : get_class($this);
|
|
$url_handlers = Config::inst()->get($controller_class, 'url_handlers', Config::FIRST_SET);
|
|
|
|
if($url_handlers){
|
|
foreach($url_handlers as $rule => $action) {
|
|
if($params = $request->match($rule)) {
|
|
$res = $this->doBeforeFilter($action,$params);
|
|
if($res) return $res;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
return parent::handleRequest($request, $model);
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
protected abstract function authorize();
|
|
|
|
protected function notFound($msg = null) {
|
|
$msg = is_null($msg)?"object wasn't found!.":$msg;
|
|
// return a 404
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(404);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody(json_encode($msg));
|
|
return $response;
|
|
}
|
|
|
|
protected function ok(array $res = null){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(200);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
if(is_null($res))
|
|
$response->setBody(json_encode(array()));
|
|
else
|
|
$response->setBody(json_encode($res));
|
|
return $response;
|
|
}
|
|
|
|
protected function deleted(){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(204);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody('');
|
|
return $response;
|
|
}
|
|
|
|
protected function updated(){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(204);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody('');
|
|
return $response;
|
|
}
|
|
|
|
protected function published(){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(204);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody('');
|
|
return $response;
|
|
}
|
|
|
|
public function serverError(){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(500);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody(json_encode("Server Error"));
|
|
return $response;
|
|
}
|
|
|
|
public function validationError($messages){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(412);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
if(!is_array($messages))
|
|
$messages = array(array('message'=> $messages));
|
|
$response->setBody(json_encode(
|
|
array('error' => 'validation','messages' => $messages)
|
|
));
|
|
return $response;
|
|
}
|
|
|
|
protected function created($id){
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(201);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody(json_encode($id));
|
|
return $response;
|
|
}
|
|
|
|
|
|
protected function methodNotAllowed() {
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(405);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody(json_encode("Method Not Allowed"));
|
|
return $response;
|
|
}
|
|
|
|
public function permissionFailure() {
|
|
// return a 401
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(401);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody(json_encode("You don't have access to this item through the API."));
|
|
return $response;
|
|
}
|
|
|
|
protected function addingDuplicate($msg) {
|
|
// return a 401
|
|
$response = new SS_HTTPResponse();
|
|
$response->setStatusCode(409);
|
|
$response->addHeader('Content-Type', 'application/json');
|
|
$response->setBody(json_encode($msg));
|
|
return $response;
|
|
}
|
|
|
|
public function shutdown_function() {
|
|
if($this->isApiCall()){
|
|
$error = error_get_last();
|
|
if($error['type']==1){
|
|
ob_end_clean();
|
|
header('HTTP/1.1 500 Internal Server Error');
|
|
// Send out the error details to the logger for writing
|
|
SS_Log::log(
|
|
array(
|
|
'errno' => $error['type'],
|
|
'errstr' => $error['message'],
|
|
'errfile' => $error['file'],
|
|
'errline' => $error['line'],
|
|
'errcontext' => ''
|
|
),
|
|
SS_Log::ERR
|
|
);
|
|
}
|
|
}
|
|
}
|
|
} |