blob: 13a38aa1767d7023d52832956a1f4a843bd14501 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
<?php
if (!defined('DOKU_INC')) die();
/**
* This class provides information about remote access to the wiki.
*
* == Types of methods ==
* There are two types of remote methods. The first is the core methods.
* These are always available and provided by dokuwiki.
* The other is plugin methods. These are provided by remote plugins.
*
* == Information structure ==
* The information about methods will be given in an array with the following structure:
* array(
* 'method.name' => array(
* 'args' => array(
* 'type' => 'string|int|...',
* )
* 'return' => 'type'
* )
* )
*
* plugin names are formed the following:
* core methods begin by a 'dokuwiki' or 'wiki' followed by a . and the method name itself.
* i.e.: dokuwiki.version or wiki.getPage
*
* plugin methods are formed like 'plugin.<plugin name>.<method name>'.
* i.e.: plugin.clock.getTime or plugin.clock_gmt.getTime
*
*
*
* @throws RemoteException
*/
class RemoteAPI {
/**
* @var array remote methods provided by dokuwiki.
*/
private $coreMethods = array();
/**
* @var array remote methods provided by dokuwiki plugins - will be filled lazy via
* {@see RemoteAPI#getPluginMethods}
*/
private $pluginMethods = null;
/**
* Get all available methods with remote access.
*
* @return array with information to all available methods
*/
public function getMethods() {
$this->forceAccess();
return array_merge($this->getCoreMethods(), $this->getPluginMethods());
}
/**
* call a method via remote api.
*
* @param string $method name of the method to call.
* @param array $args arguments to pass to the given method
* @return mixed result of method call, must be a primitive type.
*/
public function call($method, $args) {
$this->forceAccess();
$method = explode('.', $method);
if ($method[0] === 'plugin') {
$plugin = plugin_load('remote', $method[1]);
if (!$plugin) {
throw new RemoteException('Method unavailable');
}
return call_user_func_array(array($plugin, $method[2]), $args);
} else {
// TODO call core method
}
}
/**
* @return bool true if the current user has access to remote api.
*/
public function hasAccess() {
global $conf;
if (!isset($conf['remote'])) {
return false;
}
return $conf['remote'];
}
/**
* @throws RemoteException On denied access.
* @return void
*/
private function forceAccess() {
if (!$this->hasAccess()) {
throw new RemoteException('Access denied');
}
}
/**
* @return array all plugin methods.
*/
public function getPluginMethods() {
if ($this->pluginMethods === null) {
$this->pluginMethods = array();
$plugins = plugin_list('remote');
foreach ($plugins as $pluginName) {
$plugin = plugin_load('remote', $pluginName);
if (!is_subclass_of($plugin, 'DokuWiki_Remote_Plugin')) {
throw new RemoteException("Plugin $pluginName dose not implement DokuWiki_Remote_Plugin");
}
$methods = $plugin->_getMethods();
foreach ($methods as $method => $meta) {
$this->pluginMethods["plugin.$pluginName.$method"] = $meta;
}
}
}
return $this->pluginMethods;
}
/**
* @return array all core methods.
*/
public function getCoreMethods() {
return $this->coreMethods;
}
}
class RemoteException extends Exception {}
|
