Change the way that we do RESTful routing.

1) We now use __call() in REST_Controller to handle any requests to a controller
   that were not already handled.  In the case of RESTful controllers, this should
   be the only entry point (although they're free to break the model and add other
   ones.. nothing stops them).

   This means that we can remove all the catch-all routes in
   routes.php which greatly simplifies it.

2) Move request_method() and output_format() out of REST_Controller and into the REST
   helper in core/helpers/rest.php

3) Experiment with letting the various subclasses check the output_format and deal with
   it themselves.  This simplifies the API, but it might be a bad idea in that it might
   push too much work to the individual controllers.  It's a balancing act, time will tell,
   I'm willing to change it back later.

1 files changed, 55 insertions, 0 deletions

diff --git a/core/helpers/rest.php b/core/helpers/rest.php
new file mode 100644
index 00000000..154ef6f6
--- /dev/null
+++ b/core/helpers/rest.php
@@ -0,0 +1,55 @@
+<?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.
+ */
+
+class REST_Core {
+  /**
+   * 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
+   */
+  public static function request_method() {
+    if (request::method() == "get") {
+      return "get";
+    } else {
+      $input = Input::instance();
+      switch ($input->post("_method", $input->get("_method"))) {
+      case "put":    return "put";
+      case "delete": return "delete";
+      default:       return "post";
+      }
+    }
+  }
+
+  /**
+   * Choose an output format based on what the client prefers to accept.
+   * @return string "html", "xml" or "json"
+   */
+  public static function output_format() {
+    // Pick a format, but let it be overridden.
+      $input = Input::instance();
+    return $input->get(
+      "_format", $input->post(
+        "_format", request::preferred_accept(
+          array("html", "xml", "json"))));
+  }
+}