Merge branch 'master' of https://github.com/dom-mel/dokuwiki into pull-request-87

* 'master' of https://github.com/dom-mel/dokuwiki: (38 commits)
  removed requires, changed conf check in xmlrpc.php
  removed require_once for autoloaded fulltext.php
  updated comment
  added dokuwiki.getXMLRPCAPIVersion and wiki.getRPCVersionSupported
  added RPC_CALL_ADD event.
  replaced $HTTP_RAW_POST_DATA with http_get_raw_post_data function
  changed error code for unauthorized method calls.
  typo fixes
  moved plugin and core method calls to seperate function
  corrected comment
  added getapi methods to remote plugin
  removed unused class
  fixed testcase
  refactored RemoteAccessDenied to RemoteAccessDeniedException
  adjusted test cases
  delegate file and date transformation to remote library
  treat null as empty array
  added missing getTime
  added missing getVersion
  set login as public method
  ...

2 files changed, 325 insertions, 1 deletions

diff --git a/_test/cases/inc/remote.test.php b/_test/cases/inc/remote.test.php
new file mode 100644
index 000000000..f03d13ce1
--- /dev/null
+++ b/_test/cases/inc/remote.test.php
@@ -0,0 +1,324 @@
+<?php
+
+require_once DOKU_INC . 'inc/init.php';
+require_once DOKU_INC . 'inc/RemoteAPICore.php';
+require_once DOKU_INC . 'inc/auth/basic.class.php';
+
+Mock::generate('Doku_Plugin_Controller');
+
+class MockAuth extends auth_basic {
+    function isCaseSensitive() { return true; }
+}
+
+class RemoteAPICoreTest {
+
+    function __getRemoteInfo() {
+        return array(
+            'wiki.stringTestMethod' => array(
+                'args' => array(),
+                'return' => 'string',
+                'doc' => 'Test method',
+                'name' => 'stringTestMethod',
+            ), 'wiki.intTestMethod' => array(
+                'args' => array(),
+                'return' => 'int',
+                'doc' => 'Test method',
+                'name' => 'intTestMethod',
+            ), 'wiki.floatTestMethod' => array(
+                'args' => array(),
+                'return' => 'float',
+                'doc' => 'Test method',
+                'name' => 'floatTestMethod',
+            ), 'wiki.dateTestMethod' => array(
+                'args' => array(),
+                'return' => 'date',
+                'doc' => 'Test method',
+                'name' => 'dateTestMethod',
+            ), 'wiki.fileTestMethod' => array(
+                'args' => array(),
+                'return' => 'file',
+                'doc' => 'Test method',
+                'name' => 'fileTestMethod',
+            ), 'wiki.voidTestMethod' => array(
+                'args' => array(),
+                'return' => 'void',
+                'doc' => 'Test method',
+                'name' => 'voidTestMethod',
+            ),  'wiki.oneStringArgMethod' => array(
+                'args' => array('string'),
+                'return' => 'string',
+                'doc' => 'Test method',
+                'name' => 'oneStringArgMethod',
+            ), 'wiki.twoArgMethod' => array(
+                'args' => array('string', 'int'),
+                'return' => 'array',
+                'doc' => 'Test method',
+                'name' => 'twoArgMethod',
+            ), 'wiki.twoArgWithDefaultArg' => array(
+                'args' => array('string', 'string'),
+                'return' => 'string',
+                'doc' => 'Test method',
+                'name' => 'twoArgWithDefaultArg',
+            ), 'wiki.publicCall' => array(
+                'args' => array(),
+                'return' => 'boolean',
+                'doc' => 'testing for public access',
+                'name' => 'publicCall',
+                'public' => 1
+            )
+        );
+    }
+    function stringTestMethod() { return 'success'; }
+    function intTestMethod() { return 42; }
+    function floatTestMethod() { return 3.14159265; }
+    function dateTestMethod() { return 2623452346; }
+    function fileTestMethod() { return 'file content'; }
+    function voidTestMethod() { return null; }
+    function oneStringArgMethod($arg) {return $arg; }
+    function twoArgMethod($string, $int) { return array($string, $int); }
+    function twoArgWithDefaultArg($string1, $string2 = 'default') { return array($string1, $string2); }
+    function publicCall() {return true;}
+
+}
+
+class remote_plugin_testplugin extends DokuWiki_Remote_Plugin {
+    function _getMethods() {
+        return array(
+            'method1' => array(
+                'args' => array(),
+                'return' => 'void'
+            ), 'methodString' => array(
+                'args' => array(),
+                'return' => 'string'
+            ), 'method2' => array(
+                'args' => array('string', 'int'),
+                'return' => 'array',
+                'name' => 'method2',
+            ), 'method2ext' => array(
+                'args' => array('string', 'int', 'bool'),
+                'return' => 'array',
+                'name' => 'method2',
+            ), 'publicCall' => array(
+                'args' => array(),
+                'return' => 'boolean',
+                'doc' => 'testing for public access',
+                'name' => 'publicCall',
+                'public' => 1
+            )
+        );
+    }
+
+    function method1() { return null; }
+    function methodString() { return 'success'; }
+    function method2($str, $int, $bool = false) { return array($str, $int, $bool); }
+    function publicCall() {return true;}
+
+}
+
+
+class remote_test extends UnitTestCase {
+
+    var $originalConf;
+    var $userinfo;
+
+    var $remote;
+
+    function setUp() {
+        global $plugin_controller;
+        global $conf;
+        global $USERINFO;
+        global $auth;
+
+        parent::setUp();
+        $pluginManager = new MockDoku_Plugin_Controller();
+        $pluginManager->setReturnValue('getList', array('testplugin'));
+        $pluginManager->setReturnValue('load', new remote_plugin_testplugin());
+        $plugin_controller = $pluginManager;
+
+        $this->originalConf = $conf;
+        $conf['remote'] = 1;
+        $conf['remoteuser'] = '!!not set!!';
+        $conf['useacl'] = 0;
+
+        $this->userinfo = $USERINFO;
+        $this->remote = new RemoteAPI();
+
+        $auth = new MockAuth();
+    }
+
+    function tearDown() {
+        global $conf;
+        global $USERINFO;
+        $conf = $this->originalConf;
+        $USERINFO = $this->userinfo;
+
+    }
+
+    function test_pluginMethods() {
+        $methods = $this->remote->getPluginMethods();
+        $actual = array_keys($methods);
+        sort($actual);
+        $expect = array('plugin.testplugin.method1', 'plugin.testplugin.method2', 'plugin.testplugin.methodString', 'plugin.testplugin.method2ext', 'plugin.testplugin.publicCall');
+        sort($expect);
+        $this->assertEqual($expect,$actual);
+    }
+
+    function test_hasAccessSuccess() {
+        $this->assertTrue($this->remote->hasAccess());
+    }
+
+    function test_hasAccessFail() {
+        global $conf;
+        $conf['remote'] = 0;
+        $this->assertFalse($this->remote->hasAccess());
+    }
+
+    function test_hasAccessFailAcl() {
+        global $conf;
+        $conf['useacl'] = 1;
+        $this->assertFalse($this->remote->hasAccess());
+    }
+
+    function test_hasAccessSuccessAclEmptyRemoteUser() {
+        global $conf;
+        $conf['useacl'] = 1;
+        $conf['remoteuser'] = '';
+
+        $this->assertTrue($this->remote->hasAccess());
+    }
+
+    function test_hasAccessSuccessAcl() {
+        global $conf;
+        global $USERINFO;
+        $conf['useacl'] = 1;
+        $conf['remoteuser'] = '@grp,@grp2';
+        $USERINFO['grps'] = array('grp');
+        $this->assertTrue($this->remote->hasAccess());
+    }
+
+    function test_hasAccessFailAcl2() {
+        global $conf;
+        global $USERINFO;
+        $conf['useacl'] = 1;
+        $conf['remoteuser'] = '@grp';
+        $USERINFO['grps'] = array('grp1');
+
+        $this->assertFalse($this->remote->hasAccess());
+    }
+
+
+    function test_forceAccessSuccess() {
+        global $conf;
+        $conf['remote'] = 1;
+        $this->remote->forceAccess(); // no exception should occur
+    }
+
+    function test_forceAccessFail() {
+        global $conf;
+        $conf['remote'] = 0;
+        $this->expectException('RemoteException');
+        $this->remote->forceAccess();
+    }
+
+    function test_generalCoreFunctionWithoutArguments() {
+        global $conf;
+        $conf['remote'] = 1;
+        $remoteApi = new RemoteApi();
+        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
+
+        $this->assertEqual($remoteApi->call('wiki.stringTestMethod'), 'success');
+        $this->assertEqual($remoteApi->call('wiki.intTestMethod'), 42);
+        $this->assertEqual($remoteApi->call('wiki.floatTestMethod'), 3.14159265);
+        $this->assertEqual($remoteApi->call('wiki.dateTestMethod'), 2623452346);
+        $this->assertEqual($remoteApi->call('wiki.fileTestMethod'), 'file content');
+        $this->assertEqual($remoteApi->call('wiki.voidTestMethod'), null);
+    }
+
+    function test_generalCoreFunctionOnArgumentMismatch() {
+        global $conf;
+        $conf['remote'] = 1;
+        $remoteApi = new RemoteApi();
+        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
+
+        $this->expectException('RemoteException');
+        $remoteApi->call('wiki.voidTestMethod', array('something'));
+    }
+
+    function test_generalCoreFunctionWithArguments() {
+        global $conf;
+        $conf['remote'] = 1;
+
+        $remoteApi = new RemoteApi();
+        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
+
+        $this->assertEqual($remoteApi->call('wiki.oneStringArgMethod', array('string')), 'string');
+        $this->assertEqual($remoteApi->call('wiki.twoArgMethod', array('string', 1)), array('string' , 1));
+        $this->assertEqual($remoteApi->call('wiki.twoArgWithDefaultArg', array('string')), array('string', 'default'));
+        $this->assertEqual($remoteApi->call('wiki.twoArgWithDefaultArg', array('string', 'another')), array('string', 'another'));
+    }
+
+    function test_pluginCallMethods() {
+        global $conf;
+        $conf['remote'] = 1;
+
+        $remoteApi = new RemoteApi();
+        $this->assertEqual($remoteApi->call('plugin.testplugin.method1'), null);
+        $this->assertEqual($remoteApi->call('plugin.testplugin.method2', array('string', 7)), array('string', 7, false));
+        $this->assertEqual($remoteApi->call('plugin.testplugin.method2ext', array('string', 7, true)), array('string', 7, true));
+        $this->assertEqual($remoteApi->call('plugin.testplugin.methodString'), 'success');
+    }
+
+    function test_notExistingCall() {
+        global $conf;
+        $conf['remote'] = 1;
+
+        $remoteApi = new RemoteApi();
+        $this->expectException('RemoteException');
+        $remoteApi->call('dose not exist');
+    }
+
+    function test_publicCallCore() {
+        global $conf;
+        $conf['useacl'] = 1;
+        $remoteApi = new RemoteApi();
+        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
+        $this->assertTrue($remoteApi->call('wiki.publicCall'));
+    }
+
+    function test_publicCallPlugin() {
+        global $conf;
+        $conf['useacl'] = 1;
+        $remoteApi = new RemoteApi();
+        $this->assertTrue($remoteApi->call('plugin.testplugin.publicCall'));
+    }
+
+    function test_publicCallCoreDeny() {
+        global $conf;
+        $conf['useacl'] = 1;
+        $remoteApi = new RemoteApi();
+        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
+        $this->expectException('RemoteAccessDeniedException');
+        $remoteApi->call('wiki.stringTestMethod');
+    }
+
+    function test_publicCallPluginDeny() {
+        global $conf;
+        $conf['useacl'] = 1;
+        $remoteApi = new RemoteApi();
+        $this->expectException('RemoteAccessDeniedException');
+        $remoteApi->call('plugin.testplugin.methodString');
+    }
+
+    function test_pluginCallCustomPath() {
+        global $EVENT_HANDLER;
+        $EVENT_HANDLER->register_hook('RPC_CALL_ADD', 'BEFORE', &$this, 'pluginCallCustomPathRegister');
+
+        $remoteApi = new RemoteAPI();
+        $result = $remoteApi->call('custom.path');
+        $this->assertEqual($result, 'success');
+    }
+
+    function pluginCallCustomPathRegister(&$event, $param) {
+        $event->data['custom.path'] = array('testplugin', 'methodString');
+    }
+}
diff --git a/_test/index.php b/_test/index.php
index f59c44cf4..64ece4762 100644
--- a/_test/index.php
+++ b/_test/index.php
@@ -11,7 +11,7 @@ if(@file_exists(DOKU_CONF.'local.php')){ require_once(DOKU_CONF.'local.php'); }
 $conf['lang'] = 'en'; 
 define('TEST_ROOT', dirname(__FILE__));
 define('TMPL_FILESCHEME_PATH', TEST_ROOT . '/filescheme/');
-error_reporting(E_ALL);
+error_reporting(E_ALL & ~E_DEPRECATED);
 
 set_time_limit(600);
 ini_set('memory_limit','128M');