aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/api.php
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2009-11-10 01:50:19 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2009-11-10 01:50:19 +0000
commitfcaf7ad2e618deb50cbe48d2a4f8256e87878761 (patch)
treeff5d372c372d4cdd60bf9d061515ac3e12038032 /engine/lib/api.php
parent3cfefb38a8e73f3b712e462fe784782b80edd9f9 (diff)
downloadelgg-fcaf7ad2e618deb50cbe48d2a4f8256e87878761.tar.gz
elgg-fcaf7ad2e618deb50cbe48d2a4f8256e87878761.tar.bz2
introducing a new web services handler
git-svn-id: http://code.elgg.org/elgg/trunk@3651 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib/api.php')
-rw-r--r--engine/lib/api.php102
1 files changed, 87 insertions, 15 deletions
diff --git a/engine/lib/api.php b/engine/lib/api.php
index 92d68475b..91c3743a3 100644
--- a/engine/lib/api.php
+++ b/engine/lib/api.php
@@ -1349,31 +1349,103 @@ function __php_api_exception_handler($exception) {
page_draw($exception->getMessage(), elgg_view("api/output", array("result" => $result)));
}
-// Initialisation /////////////////////////////////////////////////////////////
+
+// Services handler ///////////////////////////////////////////
/**
- * Register a page handler for the various API endpoints.
- *
- * @param array $page
+ * Services handler - turns request over to the registered handler
+ *
+ * @param string $handler
+ * @param array $request
*/
-function api_endpoint_handler($page) {
+function service_handler($handler, $request) {
global $CONFIG;
+
+ // setup the input parameters since this comes through rewrite rule
+ $query = substr($_SERVER['REQUEST_URI'], strpos($_SERVER['REQUEST_URI'], '?')+1);
+ if (isset($query)) {
+ parse_str($query, $query_arr);
+ if (is_array($query_arr)) {
+ foreach($query_arr as $name => $val) {
+ set_input($name, $val);
+ }
+ }
+ }
- // Which view
- if ($page[1]) {
- elgg_set_viewtype($page[1]);
+ set_context('api');
+
+ $request = explode('/',$request);
+
+ // after the handler, the first identifier is response format
+ // ex) http://example.org/services/api/rest/xml/?method=test
+ $reponse_format = $request[0];
+ // Which view - xml, json, ...
+ if ($reponse_format) {
+ elgg_set_viewtype($reponse_format);
+ } else {
+ // default to xml
+ elgg_set_viewtype("xml");
+ }
+
+ if (!isset($CONFIG->servicehandler) || empty($handler)) {
+ // no handlers set or bad url
+ header("HTTP/1.0 404 Not Found");
+ exit;
+ } else if (isset($CONFIG->servicehandler[$handler]) && is_callable($CONFIG->servicehandler[$handler])) {
+ $function = $CONFIG->servicehandler[$handler];
+ $function($page, $handler);
+ } else {
+ // no handler for this web service
+ header("HTTP/1.0 404 Not Found");
+ exit;
}
+}
- // Which endpoint
- if ($page[0]) {
- switch ($page[0]) {
- case 'rest' :
- default : include($CONFIG->path . "services/api/rest.php");
- }
+/**
+ * Registers a web services handler
+ *
+ * @param string $handler web services type
+ * @param string $function Your function name
+ * @return true|false Depending on success
+ */
+function register_service_handler($handler, $function) {
+ global $CONFIG;
+ if (!isset($CONFIG->servicehandler)) {
+ $CONFIG->servicehandler = array();
+ }
+ if (is_callable($function)) {
+ $CONFIG->servicehandler[$handler] = $function;
+ return true;
}
+
+ return false;
}
/**
+ * Remove a web service
+ * To replace a web service handler, register the desired handler over the old on
+ * with register_service_handler().
+ *
+ * @param string $handler web services type
+ */
+function unregister_service_handler($handler) {
+ global $CONFIG;
+ if (isset($CONFIG->servicehandler) && isset($CONFIG->servicehandler[$handler])) {
+ unset($CONFIG->servicehandler[$handler]);
+ }
+}
+
+// REST handler //////////////////////////////////////////////////////////////
+
+function rest_handler() {
+ global $CONFIG;
+
+ require $CONFIG->path . "services/api/rest.php";
+}
+
+// Initialisation /////////////////////////////////////////////////////////////
+
+/**
* Unit tests for API
*/
function api_unit_test($hook, $type, $value, $params) {
@@ -1388,7 +1460,7 @@ function api_unit_test($hook, $type, $value, $params) {
*/
function api_init() {
// Register a page handler, so we can have nice URLs
- register_page_handler('api','api_endpoint_handler');
+ register_service_handler('rest','rest_handler');
register_plugin_hook('unit_test', 'system', 'api_unit_test');