aboutsummaryrefslogtreecommitdiffstats
path: root/lib/api.php
blob: 767f1d30b7dd0525ea35de6a22d3b8bc5050ed10 (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
<?php
/**
 * ownCloud
 *
 * @author Tom Needham
 * @author Michael Gapczynski
 * @author Bart Visscher
 * @copyright 2012 Tom Needham tom@owncloud.com
 * @copyright 2012 Michael Gapczynski mtgap@owncloud.com
 * @copyright 2012 Bart Visscher bartv@thisnet.nl
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
 class OC_API {
	 
	 /**
	  * api actions
	  */
	 protected $actions = array();
	 
	 /**
	  * registers an api call
	  * @param string $method the http method
	  * @param string $url the url to match
	  * @param callable $action the function to run
	  */
	 public function register($method, $url, $action){
	 	$name = strtolower($method).$url;
	 	if(!isset(self::$actions[$name])){
		 	OC_Router::create($name, $url)
		 		->action('OC_API', 'call');
		 	self::$actions[$name] = array();
	 	}
	 	self::$actions[$name][] = $action;
	 }
	 
	 /**
	  * handles an api call
	  * @param array $parameters
	  */
	 public function call($parameters){
	 	// TODO load the routes.php from apps
		 $name = $parameters['_name'];
		 $response = array();
		 // Loop through registered actions
		 foreach(self::$actions[$name] as $action){
		 	if(is_callable($action)){
		 		$action_response = call_user_func($action, $parameters);
		 		if(is_array($action_response)){
		 			// Merge with previous
			 		$response = array_merge($response, $action_response);
		 		} else {
			 		// TODO - Something failed, do we return an error code, depends on other action responses
		 		}
		 	} else {
			 	// Action not callable
			 	// log
			 	// TODO - Depending on other action responses, do we return a 501?
		 	}
		 }
		 // Send the response
		 if(isset($parameters['_format'])){
			 self::respond($response, $parameters['_format']);
		 } else {
			 self::respond($response);
		 }
	 }
	 
	 /**
	  * respond to a call
	  * @param int|array $response the response
	  * @param string $format the format xml|json
	  */
	 private function respond($response, $format='json'){
		 // TODO respond in the correct format
	 }
	 
 }