summaryrefslogtreecommitdiff
path: root/core/helpers/rest.php
blob: a63b94c8a4ddf0b59411920be29be05dc49ec36b (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
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
<?php defined("SYSPATH") or die("No direct script access.");
/**
 * Gallery - a web based photo album viewer and editor
 * Copyright (C) 2000-2009 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 {
  const OK = "200 OK";
  const CREATED = "201 Created";
  const ACCEPTED = "202 Accepted";
  const NO_CONTENT = "204 No Content";
  const RESET_CONTENT = "205 Reset Content";
  const PARTIAL_CONTENT = "206 Partial Content";
  const MOVED_PERMANENTLY = "301 Moved Permanently";
  const FOUND = "302 Found";
  const SEE_OTHER = "303 See Other";
  const NOT_MODIFIED = "304 Not Modified";
  const TEMPORARY_REDIRECT = "307 Temporary Redirect";
  const BAD_REQUEST = "400 Bad Request";
  const UNAUTHORIZED = "401 Unauthorized";
  const FORBIDDEN = "403 Forbidden";
  const NOT_FOUND = "404 Not Found";
  const METHOD_NOT_ALLOWED = "405 Method Not Allowed";
  const NOT_ACCEPTABLE = "406 Not Acceptable";
  const CONFLICT = "409 Conflict";
  const GONE = "410 Gone";
  const LENGTH_REQUIRED = "411 Length Required";
  const PRECONDITION_FAILED = "412 Precondition Failed";
  const UNSUPPORTED_MEDIA_TYPE = "415 Unsupported Media Type";
  const EXPECTATION_FAILED = "417 Expectation Failed";
  const INTERNAL_SERVER_ERROR = "500 Internal Server Error";
  const SERVICE_UNAVAILABLE = "503 Service Unavailable";

  const XML = "application/xml";
  const ATOM = "application/atom+xml";
  const RSS = "application/rss+xml";
  const JSON = "application/json";
  const HTML = "text/html";

  /**
   * 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.
   * @return string HTTP request method
   */
  static function request_method() {
    if (request::method() == "get") {
      return "get";
    } else {
      $input = Input::instance();
      switch (strtolower($input->post("_method", $input->get("_method", request::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"
   */
  static function output_format() {
    // Pick a format, but let it be overridden.
    $input = Input::instance();
    $fmt = $input->get(
      "_format", $input->post(
        "_format", request::preferred_accept(
          array("xhtml", "html", "xml", "json"))));

    // Some browsers (Chrome!) prefer xhtml over html, but we'll normalize this to html for now.
    if ($fmt == "xhtml") {
      $fmt = "html";
    }
    return $fmt;
  }

  /**
   * Set HTTP response code.
   * @param string Use one of the status code constants defined in this class.
   */
  static function http_status($status_code) {
    header("HTTP/1.1 " . $status_code);
  }

  /**
   * Set HTTP Location header.
   * @param string URL
   */
  static function http_location($url) {
    header("Location: " . $url);
  }

  /**
   * Set HTTP Content-Type header.
   * @param string content type
   */
  static function http_content_type($type) {
    header("Content-Type: " . $type);
  }
}