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
|
<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2008 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* This abstract controller makes it easy to create a RESTful controller. To use it, create a
* subclass which defines the resource type and implements get/post/put/delete methods, like this:
*
* class Comment_Controller extends REST_Controller {
* protected $resource_type = "comment"; // this tells REST which model to use
*
* public function _get(ORM $comment) {
* // Handle GET request
* }
*
* public function _put(ORM $comment) {
* // Handle PUT request
* }
*
* public function _post(ORM $comment) {
* // Handle POST request
* }
*
* public function _delete(ORM $comment) {
* // Handle DELETE request
* }
* }
*
* A request to http://example.com/gallery3/comment/3 will result in a call to
* REST_Controller::dispatch(3) which will load up the comment associated with id 3. If there's
* no such comment, it returns a 404. Otherwise, it will then delegate to
* Comment_Controller::get() with the ORM instance as an argument.
*/
abstract class REST_Controller extends Controller {
protected $resource_type = null;
public function dispatch($id) {
if ($this->resource_type == null) {
throw new Exception("@todo ERROR_MISSING_RESOURCE_TYPE");
}
// @todo this needs security checks
$resource = ORM::factory($this->resource_type)->where("id", $id)->find();
if (!$resource->loaded) {
return Kohana::show_404();
}
/**
* We're expecting to run in an environment that only supports GET/POST, so expect to tunnel
* PUT/DELETE through POST.
*/
if (request::method() == "get") {
$this->_get($resource);
if (Session::instance()->get("use_profiler", false)) {
$profiler = new Profiler();
print $profiler->render();
}
return;
}
switch ($this->input->post("__action")) {
case "put":
return $this->_put($resource);
case "delete":
return $this->_delete($resource);
default:
return $this->_post($resource);
}
}
/**
* Perform a GET request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _get($resource);
/**
* Perform a PUT request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _put($resource);
/**
* Perform a POST request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _post($resource);
/**
* Perform a DELETE request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _delete($resource);
}
|
