fix: Argument #2 () cannot be null

composer.json

@@ -27,7 +27,6 @@
     },
     "require-dev": {
         "bsr/utils" : "dev-master",
-        "pds/skeleton": "^1.0",
-        "phpunit/phpunit": "^6"
+        "phpunit/phpunit": "^8"
     }
 }

config/configuration.local.php

@@ -3,18 +3,18 @@
  * 'odbc:Driver=FreeTDS;
  * Server=192.168.0.8;
  * Port=1218;
- * Database=netbiblio;
+ * Database=dbname;
  * TDS_Version=7.4;
- * ClientCharset=UTF-8'* 'alcoda', 'alcodaonly'
+ * ClientCharset=UTF-8'* 'user', 'password'
  */
 return array(
         'db' => array(
             'driver' => 'FreeTDS',
             'server' => '192.168.0.8',
             'port' => '1218',
-            'username' => 'alcoda',
-            'password' => 'alcodaonly',
-            'name' => 'netbiblio',
+            'username' => 'user',
+            'password' => 'password',
+            'name' => 'dbname',
         ),
         'solr' => array(
             'server' => '212.147.56.162',
@@ -42,4 +42,4 @@ return array(
         'netbiblio_worker_id' => 45,
         'www_employee_id' => 45,
         'www_library_id' => 2,
-    );;
+    );

log/log.txt

@@ -1,16 +1,16 @@
-(n-a) - [14.10.2018 12:35:19] - 400 NoArguments - 2.01ms - (none)
-(n-a) - [14.10.2018 12:35:19] - 400 NoArguments - 0.73ms - (none)
-(n-a) - [14.10.2018 12:35:19] - 400 MissingMethod - 1.23ms - (none)
-(n-a) - [14.10.2018 12:35:19] - 400 MissingMethod - 0.04ms - (none)
-(n-a) - [14.10.2018 12:35:19] - 400 MissingMethod - 0.06ms - (none)
-(n-a) - [14.10.2018 12:35:19] - 400 BadMethod - 0.06ms - someNonExistentMockFunction()
-(n-a) - [14.10.2018 12:35:19] - 400 BadMethod - 0.05ms - someNonExistentMockFunction()
-(n-a) - [14.10.2018 12:35:19] - 400 TooFewArgs - 0.85ms - someMockFunction()
-(n-a) - [14.10.2018 12:35:19] - 400 TooFewArgs - 0.18ms - someMockFunction(val)
-(n-a) - [14.10.2018 12:35:19] - 400 TooManyArgs - 0.15ms - someMockFunction(val, val, val, val)
-(n-a) - [14.10.2018 12:35:19] - 200  - 0.03ms - someMockFunction(val, val)
-(n-a) - [14.10.2018 12:35:19] - 200  - 0.03ms - someMockFunction(val, val, val)
-(n-a) - [14.10.2018 12:35:19] - 200  - 0.03ms - someMockFunction(val, val, val)
-(n-a) - [14.10.2018 12:35:19] - 200  - 0.03ms - someOtherMockFunction(one, two, threeOpt)
-(n-a) - [14.10.2018 12:35:19] - 200  - 0.03ms - someOtherMockFunction(two, threeOpt, one)
-(n-a) - [14.10.2018 12:35:19] - 200  - 0.03ms - someOtherMockFunction(two, threeOpt, one)
+(n-a) - [04.12.2018 23:25:12] - 400 NoArguments - 1.29ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 NoArguments - 1.13ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 MissingMethod - 0.91ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 MissingMethod - 0.07ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 MissingMethod - 0.05ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 BadMethod - 0.06ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 BadMethod - 0.06ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 TooFewArgs - 0.91ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 TooFewArgs - 0.23ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 400 TooManyArgs - 0.28ms - (none)
+(n-a) - [04.12.2018 23:25:12] - 200  - 0.05ms - someMockFunction(val, val)
+(n-a) - [04.12.2018 23:25:12] - 200  - 0.05ms - someMockFunction(val, val, val)
+(n-a) - [04.12.2018 23:25:12] - 200  - 0.04ms - someMockFunction(val, val, val)
+(n-a) - [04.12.2018 23:25:12] - 200  - 0.04ms - someOtherMockFunction(one, two, threeOpt)
+(n-a) - [04.12.2018 23:25:12] - 200  - 0.05ms - someOtherMockFunction(two, threeOpt, one)
+(n-a) - [04.12.2018 23:25:12] - 200  - 0.06ms - someOtherMockFunction(two, threeOpt, one)

src/Webservice/Exception/ConfigException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Bsr\Webservice\Exception;
+
+/**
+ * This exception should be raised by the WebService engine when
+ * there is an error in the provided configuration information.
+ *
+ * @package Bsr\Webservice\Exception
+ */
+class ConfigException extends \Exception {
+}

src/Webservice/Help.php

@@ -1,6 +1,7 @@
 <?php
 namespace Bsr\Webservice;
 
+use Bsr\Webservice\Exception\BugException;
 use Bsr\Webservice\Exception\WebException;
 use Bsr\Webservice\Formatter\Html;
 
@@ -16,7 +17,7 @@ class Help
      * @param mixed $ws
      * @param sting $func the function to be presented
      */
-    private static function func($ws, $func)
+    private static function func($ws, string $func)
     {
         try {
             $rm = new \ReflectionMethod($ws, $func);

src/Webservice/WebService.php

@@ -3,6 +3,7 @@
 namespace Bsr\Webservice;
 
 use Bsr\Webservice\Exception\UsageException;
+use Bsr\Webservice\Exception\ConfigException;
 use Bsr\Webservice\Exception\WebException;
 use Bsr\Utils\Configuration\Configuration;
 use Bsr\Utils\Logger\Logger;
@@ -15,6 +16,8 @@ abstract class WebService
 
     private $version = null;
 
+    private $sessionStarted = false;
+
     public function __construct($version) {
         $this->version = $version;
     }
@@ -29,22 +32,28 @@ abstract class WebService
         Logger::start(array('version' => $this->version));
 
         $rendererClass = Configuration::get('renderer.class', __NAMESPACE__ . '\Renderer');
-        $renderer = new  $rendererClass;
+        $renderer = new $rendererClass;
 
         $data = array();
 
         try {
 
             $result = $this->call($sendSession);
+
+            $data['result'] = array();
             $data["result"][$this->func] = $result;
 
+            $data = $this->filterOutput($data);
+
         } catch (WebException $e) {
 
             $data["error"]["code"] = $e->getCode();
             $data["error"]["reason"] = $e->getMessage();
             $data["error"]["name"] = $e->getName();
 
-            $data['extra'] = Help::exception($e, $this, $this->func);
+            if ($this->func !== null) {
+                $data['extra'] = Help::exception($e, $this, $this->func);
+            }
 
             $this->status = 400;
 
@@ -64,6 +73,15 @@ abstract class WebService
         $renderer->render($this->status, $data);
     }
 
+    protected function startSession()
+    {
+        if (!$this->sessionStarted) {
+            session_save_path(Configuration::get('session.save_path'));
+            session_start();
+            $this->sessionStarted = true;
+        }
+    }
+
     /**
      * Determines which method to call based on GET or POST parameters and
      * call it before returning the result.
@@ -75,8 +93,7 @@ abstract class WebService
     private function call($sendSession = true)
     {
         if ($sendSession) {
-            session_save_path(Configuration::get('session.save_path'));
-            session_start();
+            $this->startSession();
         }
 
         $params = empty($_GET) ? $_POST : $_GET;
@@ -91,19 +108,33 @@ abstract class WebService
 
         $params = $this->filterParams($params);
 
+        $this->isAllowedMethodNameOrThrow($params["func"]);
+
         $this->func = $params["func"];
         unset($params['func']);
 
+        $this->paramsMatchMethodDeclarationOrThrow($params);
+
         Logger::info(array(
             'func' => $this->func.'('.implode(', ', $params).')',
         ));
 
+        return call_user_func_array(array($this, $this->func), array_values($params));
+    }
+
+    /**
+     * Verify that the provided params match the declaration of the requested method
+     * @param array $params
+     * @throws UsageException
+     */
+    protected function paramsMatchMethodDeclarationOrThrow($params)
+    {
         if (!is_callable(array($this, $this->func))) {
-            throw new UsageException("BadMethod", "Method {$this->func} does not exists.", UsageException::BAD_METHOD);
+            throw new UsageException("BadMethod", "Method {$this->func} does not exist.", UsageException::BAD_METHOD);
         }
 
-        $rm = new \ReflectionMethod($this, $this->func);
         $nbParams = count($params);
+        $rm = new \ReflectionMethod($this, $this->func);
         $nbArgsFix = $rm->getNumberOfRequiredParameters();
         $nbArgs = $rm->getNumberOfParameters();
 
@@ -114,16 +145,44 @@ abstract class WebService
         if ($nbParams > $nbArgs) {
             throw new UsageException("TooManyArgs", "You must provide at most $nbArgs arguments.", UsageException::TOO_MANY_ARGS);
         }
+    }
 
-        return call_user_func_array(array($this, $this->func), $params);
+    /**
+     * If no configuration is available assumes that all public methods are allowed
+     * @param string the requested method name from api param func
+     */
+    protected function isAllowedMethodNameOrThrow($requestedMethodName)
+    {
+        $allowedMethodNames = Configuration::get('webservice.api_method_names', null);
+        if (null === $allowedMethodNames) {
+            return;
+        }
+        if (!is_array($allowedMethodNames)) {
+            throw new ConfigException('Bad config. You should pass an array of method names as strings, in "webservice" key and "api_method_names" subkey');
+        }
+        if (!in_array($requestedMethodName, $allowedMethodNames)) {
+            throw new UsageException("BadMethod", "Method {$requestedMethodName} is not whitelisted. Pick one of :" . implode(', ', $allowedMethodNames), UsageException::BAD_METHOD);
+        }
     }
 
     /**
      * Allow subclasses to filter params by overriding this
      * @param $params
+     * @param array
      */
     protected function filterParams($params)
     {
         return $params;
     }
+
+    /**
+     * Allow subclasses to filter the output before it is sent
+     * by overriding this method
+     * @param $params
+     * @return array
+     */
+    protected function filterOutput(array $data)
+    {
+        return $data;
+    }
 }