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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
<?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 _index() {
* // Handle GET request to controller root
* }
*
* public function _show(ORM $comment, $output_format) {
* // Handle GET request
* }
*
* public function _update(ORM $comment, $output_format) {
* // Handle PUT request
* }
*
* public function _create(ORM $comment, $output_format) {
* // Handle POST request to controller root
* }
*
* public function _delete(ORM $comment, $output_format) {
* // Handle DELETE request
* }
*
* public function form(ORM $comment) {
* // Show a form for creating a new comment
* }
* }
*
* A request to http://example.com/gallery3/comments/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, $id);
if (!$resource->loaded && !$this->request_method() == "post") {
return Kohana::show_404();
}
if ($this->request_method() == "get") {
$this->_show($resource, $this->get_output_format());
if (Session::instance()->get("use_profiler", false)) {
$profiler = new Profiler();
$profiler->render();
}
return;
}
switch ($this->request_method()) {
case "put":
return $this->_update($resource);
case "delete":
return $this->_delete($resource);
case "post":
return $this->_create($resource);
}
}
// @todo Get rid of $form_type, move to add_form() and edit_form().
public function form($data, $form_type) {
if ($this->resource_type == null) {
throw new Exception("@todo ERROR_MISSING_RESOURCE_TYPE");
}
// @todo this needs security checks
if ($form_type == "edit") {
/* We're editing an existing item, load it from the database. */
$resource = ORM::factory($this->resource_type, $data);
if (!$resource->loaded) {
return Kohana::show_404();
}
return $this->_form($resource, $form_type);
} else {
/* We're adding a new item, pass along any additional parameters. */
return $this->_form($data, $form_type);
}
}
public function index() {
if (request::method() == "post") {
return $this->dispatch(null);
}
return $this->_index();
}
/**
* We're expecting to run in an environment that only supports GET/POST, so expect to tunnel
* PUT and DELETE through POST.
*
* Returns the HTTP request method taking into consideration PUT/DELETE tunneling.
* @todo Move this to a MY_request helper?
* @return string HTTP request method
*/
protected function request_method() {
if (request::method() == "get") {
return "get";
} else {
switch ($this->input->post("_method", $this->input->get("_method"))) {
case "put": return "put";
case "delete": return "delete";
default: return "post";
}
}
}
// @todo Figure out a good consistent method of passing the output format to controller methods.
protected function get_output_format() {
return $this->input->get("_format", $this->input->post("_format", "html"));
}
/**
* Perform a GET request on the controller root
* (e.g. http://www.example.com/gallery3/comments)
*/
abstract public function _index();
/**
* Perform a POST request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _create($resource);
/**
* Perform a GET request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _show($resource, $output_format);
/**
* Perform a PUT request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _update($resource);
/**
* Perform a DELETE request on this resource
* @param ORM $resource the instance of this resource type
*/
abstract public function _delete($resource);
/**
* Present a form for adding a new resource
* @param ORM $resource the resource container for instances of this resource type
*/
abstract public function _form($resource, $form_type);
}
|
