Request.php 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. <?php
  2. /**
  3. * MINZ - Copyright 2011 Marien Fressinaud
  4. * Sous licence AGPL3 <http://www.gnu.org/licenses/>
  5. */
  6. /**
  7. * Request représente la requête http
  8. */
  9. class Minz_Request {
  10. private static $controller_name = '';
  11. private static $action_name = '';
  12. private static $params = array();
  13. private static $default_controller_name = 'index';
  14. private static $default_action_name = 'index';
  15. /**
  16. * Getteurs
  17. */
  18. public static function controllerName() {
  19. return self::$controller_name;
  20. }
  21. public static function actionName() {
  22. return self::$action_name;
  23. }
  24. public static function params() {
  25. return self::$params;
  26. }
  27. public static function param($key, $default = false, $specialchars = false) {
  28. if (isset(self::$params[$key])) {
  29. $p = self::$params[$key];
  30. if (is_object($p) || $specialchars) {
  31. return $p;
  32. } else {
  33. return Minz_Helper::htmlspecialchars_utf8($p);
  34. }
  35. } else {
  36. return $default;
  37. }
  38. }
  39. public static function paramTernary($key) {
  40. if (isset(self::$params[$key])) {
  41. $p = self::$params[$key];
  42. $tp = trim($p);
  43. if ($p === null || $tp === '' || $tp === 'null') {
  44. return null;
  45. } elseif ($p == false || $tp == '0' || $tp === 'false' || $tp === 'no') {
  46. return false;
  47. }
  48. return true;
  49. }
  50. return null;
  51. }
  52. public static function defaultControllerName() {
  53. return self::$default_controller_name;
  54. }
  55. public static function defaultActionName() {
  56. return self::$default_action_name;
  57. }
  58. public static function currentRequest() {
  59. return array(
  60. 'c' => self::$controller_name,
  61. 'a' => self::$action_name,
  62. 'params' => self::$params,
  63. );
  64. }
  65. /**
  66. * Setteurs
  67. */
  68. public static function _controllerName($controller_name) {
  69. self::$controller_name = $controller_name;
  70. }
  71. public static function _actionName($action_name) {
  72. self::$action_name = $action_name;
  73. }
  74. public static function _params($params) {
  75. if (!is_array($params)) {
  76. $params = array($params);
  77. }
  78. self::$params = $params;
  79. }
  80. public static function _param($key, $value = false) {
  81. if ($value === false) {
  82. unset(self::$params[$key]);
  83. } else {
  84. self::$params[$key] = $value;
  85. }
  86. }
  87. /**
  88. * Initialise la Request
  89. */
  90. public static function init() {
  91. self::magicQuotesOff();
  92. self::initJSON();
  93. }
  94. public static function is($controller_name, $action_name) {
  95. return (
  96. self::$controller_name === $controller_name &&
  97. self::$action_name === $action_name
  98. );
  99. }
  100. /**
  101. * Return true if the request is over HTTPS, false otherwise (HTTP)
  102. */
  103. public static function isHttps() {
  104. if (isset($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
  105. return strtolower($_SERVER['HTTP_X_FORWARDED_PROTO']) === 'https';
  106. } else {
  107. return isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on';
  108. }
  109. }
  110. /**
  111. * Try to guess the base URL from $_SERVER information
  112. *
  113. * @return the base url (e.g. http://example.com/)
  114. */
  115. public static function guessBaseUrl() {
  116. $url = 'http';
  117. $https = self::isHttps();
  118. if (!empty($_SERVER['HTTP_X_FORWARDED_HOST'])) {
  119. $host = parse_url('http://' . $_SERVER['HTTP_X_FORWARDED_HOST'], PHP_URL_HOST);
  120. } elseif (!empty($_SERVER['HTTP_HOST'])) {
  121. //Might contain a port number, and mind IPv6 addresses
  122. $host = parse_url('http://' . $_SERVER['HTTP_HOST'], PHP_URL_HOST);
  123. } elseif (!empty($_SERVER['SERVER_NAME'])) {
  124. $host = $_SERVER['SERVER_NAME'];
  125. } else {
  126. $host = 'localhost';
  127. }
  128. if (!empty($_SERVER['HTTP_X_FORWARDED_PORT'])) {
  129. $port = intval($_SERVER['HTTP_X_FORWARDED_PORT']);
  130. } elseif (!empty($_SERVER['HTTP_X_FORWARDED_PROTO'])) {
  131. $port = strtolower($_SERVER['HTTP_X_FORWARDED_PROTO']) === 'https' ? 443 : 80;
  132. } elseif (!empty($_SERVER['SERVER_PORT'])) {
  133. $port = intval($_SERVER['SERVER_PORT']);
  134. } else {
  135. $port = $https ? 443 : 80;
  136. }
  137. if ($https) {
  138. $url .= 's://' . $host . ($port == 443 ? '' : ':' . $port);
  139. } else {
  140. $url .= '://' . $host . ($port == 80 ? '' : ':' . $port);
  141. }
  142. if (!empty($_SERVER['HTTP_X_FORWARDED_PREFIX'])) {
  143. $url .= rtrim($_SERVER['HTTP_X_FORWARDED_PREFIX'], '/ ');
  144. }
  145. if (isset($_SERVER['REQUEST_URI'])) {
  146. $path = $_SERVER['REQUEST_URI'];
  147. $url .= substr($path, -1) === '/' ? substr($path, 0, -1) : dirname($path);
  148. }
  149. return filter_var($url, FILTER_SANITIZE_URL);
  150. }
  151. /**
  152. * Return the base_url from configuration and add a suffix if given.
  153. *
  154. * @return the base_url with a suffix.
  155. */
  156. public static function getBaseUrl() {
  157. $conf = Minz_Configuration::get('system');
  158. $url = rtrim($conf->base_url, '/\\');
  159. return filter_var($url, FILTER_SANITIZE_URL);
  160. }
  161. /**
  162. * Relance une requête
  163. * @param $url l'url vers laquelle est relancée la requête
  164. * @param $redirect si vrai, force la redirection http
  165. * > sinon, le dispatcher recharge en interne
  166. */
  167. public static function forward($url = array(), $redirect = false) {
  168. if (!is_array($url)) {
  169. header('Location: ' . $url);
  170. exit();
  171. }
  172. $url = Minz_Url::checkUrl($url);
  173. if ($redirect) {
  174. header('Location: ' . Minz_Url::display($url, 'php'));
  175. exit();
  176. } else {
  177. self::_controllerName($url['c']);
  178. self::_actionName($url['a']);
  179. self::_params(array_merge(
  180. self::$params,
  181. $url['params']
  182. ));
  183. Minz_Dispatcher::reset();
  184. }
  185. }
  186. /**
  187. * Wrappers good notifications + redirection
  188. * @param $msg notification content
  189. * @param $url url array to where we should be forwarded
  190. */
  191. public static function good($msg, $url = array()) {
  192. Minz_Session::_param('notification', array(
  193. 'type' => 'good',
  194. 'content' => $msg
  195. ));
  196. Minz_Request::forward($url, true);
  197. }
  198. public static function bad($msg, $url = array()) {
  199. Minz_Session::_param('notification', array(
  200. 'type' => 'bad',
  201. 'content' => $msg
  202. ));
  203. Minz_Request::forward($url, true);
  204. }
  205. /**
  206. * Permet de récupérer une variable de type $_GET
  207. * @param $param nom de la variable
  208. * @param $default valeur par défaut à attribuer à la variable
  209. * @return $_GET[$param]
  210. * $_GET si $param = false
  211. * $default si $_GET[$param] n'existe pas
  212. */
  213. public static function fetchGET($param = false, $default = false) {
  214. if ($param === false) {
  215. return $_GET;
  216. } elseif (isset($_GET[$param])) {
  217. return $_GET[$param];
  218. } else {
  219. return $default;
  220. }
  221. }
  222. /**
  223. * Allows receiving POST data as application/json
  224. */
  225. private static function initJSON() {
  226. $contentType = isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '';
  227. if ($contentType == '') { //PHP < 5.3.16
  228. $contentType = isset($_SERVER['HTTP_CONTENT_TYPE']) ? $_SERVER['HTTP_CONTENT_TYPE'] : '';
  229. }
  230. $contentType = strtolower(trim($contentType));
  231. if ($contentType === 'application/json') {
  232. $ORIGINAL_INPUT = file_get_contents('php://input', false, null, 0, 1048576);
  233. if ($ORIGINAL_INPUT != '') {
  234. $json = json_decode($ORIGINAL_INPUT, true);
  235. if ($json != null) {
  236. foreach ($json as $k => $v) {
  237. if (!isset($_POST[$k])) {
  238. $_POST[$k] = $v;
  239. }
  240. }
  241. }
  242. }
  243. }
  244. }
  245. /**
  246. * Permet de récupérer une variable de type $_POST
  247. * @param $param nom de la variable
  248. * @param $default valeur par défaut à attribuer à la variable
  249. * @return $_POST[$param]
  250. * $_POST si $param = false
  251. * $default si $_POST[$param] n'existe pas
  252. */
  253. public static function fetchPOST($param = false, $default = false) {
  254. if ($param === false) {
  255. return $_POST;
  256. } elseif (isset($_POST[$param])) {
  257. return $_POST[$param];
  258. } else {
  259. return $default;
  260. }
  261. }
  262. /**
  263. * Méthode désactivant les magic_quotes pour les variables
  264. * $_GET
  265. * $_POST
  266. * $_COOKIE
  267. */
  268. private static function magicQuotesOff() {
  269. if (get_magic_quotes_gpc()) {
  270. $_GET = Minz_Helper::stripslashes_r($_GET);
  271. $_POST = Minz_Helper::stripslashes_r($_POST);
  272. $_COOKIE = Minz_Helper::stripslashes_r($_COOKIE);
  273. }
  274. }
  275. public static function isPost() {
  276. return isset($_SERVER['REQUEST_METHOD']) &&
  277. $_SERVER['REQUEST_METHOD'] === 'POST';
  278. }
  279. }