Access denied exception using appropriate http status code (#13)

* AccessDenied exception implementation * code formatting * keep uniform
DocnetUK · Nov 29, 2018 · 93f5413 · 93f5413
1 parent 5fa812a
commit 93f5413
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 21 deletions.
diff --git a/composer.json b/composer.json
@@ -6,7 +6,8 @@
     "homepage": "https://github.com/DocnetUK/php-japi",
     "license": "Apache-2.0",
     "require": {
-        "php": ">=5.3.0"
+        "php": ">=5.3.0",
+        "ext-json": "*"
     },
     "autoload": {
         "classmap": [

diff --git a/src/Docnet/JAPI.php b/src/Docnet/JAPI.php
@@ -14,11 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 namespace Docnet;
 
 use \Docnet\JAPI\Exceptions\Routing as RoutingException;
 use \Docnet\JAPI\Exceptions\Auth as AuthException;
 use \Docnet\JAPI\Exceptions\Maintenance as MaintenanceException;
+use \Docnet\JAPI\Exceptions\AccessDenied as AccessDeniedException;
 
 /**
  * Front controller for our JSON APIs
@@ -35,35 +37,35 @@ class JAPI
     /**
      * @var JAPI\Config
      */
-    private static $obj_config = NULL;
+    private static $obj_config = null;
 
     /**
      * @var JAPI\Router
      */
-    private static $obj_router = NULL;
+    private static $obj_router = null;
 
     /**
      * @var JAPI\Logger
      */
-    private $obj_logger = NULL;
+    private $obj_logger = null;
 
     /**
      * @var null|float
      */
-    private static $flt_startup = NULL;
+    private static $flt_startup = null;
 
     /**
      * When creating a new JAPI, hook up the shutdown function and set Config
      *
      * @param null|JAPI\Config $obj_config
      */
-    public function __construct($obj_config = NULL)
+    public function __construct($obj_config = null)
     {
         register_shutdown_function(array($this, 'timeToDie'));
-        if(NULL !== $obj_config) {
+        if (null !== $obj_config) {
             self::$obj_config = $obj_config;
         }
-        self::$flt_startup = (isset($_SERVER['REQUEST_TIME_FLOAT']) ? $_SERVER['REQUEST_TIME_FLOAT'] : microtime(TRUE));
+        self::$flt_startup = (isset($_SERVER['REQUEST_TIME_FLOAT']) ? $_SERVER['REQUEST_TIME_FLOAT'] : microtime(true));
     }
 
     /**
@@ -85,6 +87,9 @@ public function run()
         } catch (AuthException $obj_ex) {
             $this->jsonError($obj_ex, 401);
 
+        } catch (AccessDeniedException $obj_ex) {
+            $this->jsonError($obj_ex, 403);
+
         } catch (\Exception $obj_ex) {
             $this->jsonError($obj_ex);
         }
@@ -107,26 +112,30 @@ public function timeToDie()
      * Whatever went wrong, let 'em have it in JSON
      *
      * One day...
+     *
      * @see http://www.php.net/manual/en/function.http-response-code.php
      *
      * @param string|\Exception $mix_message
      * @param int $int_code
      */
-    protected function jsonError($mix_message = NULL, $int_code = 500)
+    protected function jsonError($mix_message = null, $int_code = 500)
     {
         switch ($int_code) {
             case 401:
-                header($_SERVER["SERVER_PROTOCOL"] . " 401 Unauthorized", TRUE, 401);
+                header($_SERVER["SERVER_PROTOCOL"] . " 401 Unauthorized", true, 401);
+                break;
+            case 403:
+                header($_SERVER["SERVER_PROTOCOL"] . " 403 Forbidden", true, 401);
                 break;
             case 404:
-                header($_SERVER["SERVER_PROTOCOL"] . " 404 Not Found", TRUE, 404);
+                header($_SERVER["SERVER_PROTOCOL"] . " 404 Not Found", true, 404);
                 break;
             case 503:
-                header($_SERVER["SERVER_PROTOCOL"] . " 503 Service Unavailable", TRUE, 503);
+                header($_SERVER["SERVER_PROTOCOL"] . " 503 Service Unavailable", true, 503);
                 break;
             case 500:
             default:
-                header($_SERVER["SERVER_PROTOCOL"] . " 500 Internal Server Error", TRUE, 500);
+                header($_SERVER["SERVER_PROTOCOL"] . " 500 Internal Server Error", true, 500);
         }
         if ($mix_message instanceof \Exception) {
             $str_log = get_class($mix_message) . ': ' . $mix_message->getMessage();
@@ -137,10 +146,12 @@ protected function jsonError($mix_message = NULL, $int_code = 500)
             $str_log = $str_message = 'Unknown error';
         }
         header('Content-type: application/json');
-        echo json_encode(array(
-            'response' => (int)$int_code,
-            'msg' => $str_message
-        ));
+        echo json_encode(
+            array(
+                'response' => (int)$int_code,
+                'msg' => $str_message,
+            )
+        );
         $this->log(LOG_ERR, "[JAPI exiting with {$int_code}] " . $str_log);
         exit();
     }
@@ -152,7 +163,7 @@ protected function jsonError($mix_message = NULL, $int_code = 500)
      */
     public static function getRouter()
     {
-        if (NULL === self::$obj_router) {
+        if (null === self::$obj_router) {
             self::$obj_router = new JAPI\Router();
         }
         return self::$obj_router;
@@ -175,7 +186,7 @@ public function setRouter(JAPI\Interfaces\Router $obj_router)
      */
     public static function getConfig()
     {
-        if(NULL === self::$obj_config) {
+        if (null === self::$obj_config) {
             self::$obj_config = new JAPI\Config();
         }
         return self::$obj_config;
@@ -189,7 +200,7 @@ public static function getConfig()
      */
     public static function getDuration($int_dp = 4)
     {
-        return round(microtime(TRUE) - self::$flt_startup, $int_dp);
+        return round(microtime(true) - self::$flt_startup, $int_dp);
     }
 
     /**
@@ -200,7 +211,7 @@ public static function getDuration($int_dp = 4)
      */
     protected function log($int_level, $str_message)
     {
-        if(NULL === $this->obj_logger) {
+        if (null === $this->obj_logger) {
             $this->obj_logger = new JAPI\Logger();
         }
         $this->obj_logger->log($int_level, $str_message);

diff --git a/src/Docnet/JAPI/Exceptions/AccessDenied.php b/src/Docnet/JAPI/Exceptions/AccessDenied.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright 2018 Venditan Limited
+ *
+ * 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.
+ */
+namespace Docnet\JAPI\Exceptions;
+
+/**
+ * AccessDenied Exception
+ *
+ * @author Kamba Abudu <[email protected]>
+ */
+class AccessDenied extends \Exception
+{
+}