IRequest.php 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2016, ownCloud, Inc.
  5. *
  6. * @author Bart Visscher <bartv@thisnet.nl>
  7. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  8. * @author Joas Schilling <coding@schilljs.com>
  9. * @author Jörn Friedrich Dreyer <jfd@butonic.de>
  10. * @author Lukas Reschke <lukas@statuscode.ch>
  11. * @author Morris Jobke <hey@morrisjobke.de>
  12. * @author Roeland Jago Douma <roeland@famdouma.nl>
  13. * @author Thomas Müller <thomas.mueller@tmit.eu>
  14. * @author Thomas Tanghus <thomas@tanghus.net>
  15. *
  16. * @license AGPL-3.0
  17. *
  18. * This code is free software: you can redistribute it and/or modify
  19. * it under the terms of the GNU Affero General Public License, version 3,
  20. * as published by the Free Software Foundation.
  21. *
  22. * This program is distributed in the hope that it will be useful,
  23. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  25. * GNU Affero General Public License for more details.
  26. *
  27. * You should have received a copy of the GNU Affero General Public License, version 3,
  28. * along with this program. If not, see <http://www.gnu.org/licenses/>
  29. *
  30. */
  31. // use OCP namespace for all classes that are considered public.
  32. // This means that they should be used by apps instead of the internal ownCloud classes
  33. namespace OCP;
  34. /**
  35. * This interface provides an immutable object with with accessors to
  36. * request variables and headers.
  37. *
  38. * Access request variables by method and name.
  39. *
  40. * Examples:
  41. *
  42. * $request->post['myvar']; // Only look for POST variables
  43. * $request->myvar; or $request->{'myvar'}; or $request->{$myvar}
  44. * Looks in the combined GET, POST and urlParams array.
  45. *
  46. * If you access e.g. ->post but the current HTTP request method
  47. * is GET a \LogicException will be thrown.
  48. *
  49. * NOTE:
  50. * - When accessing ->put a stream resource is returned and the accessor
  51. * will return false on subsequent access to ->put or ->patch.
  52. * - When accessing ->patch and the Content-Type is either application/json
  53. * or application/x-www-form-urlencoded (most cases) it will act like ->get
  54. * and ->post and return an array. Otherwise the raw data will be returned.
  55. *
  56. * @property-read string[] $server
  57. * @property-read string[] $urlParams
  58. * @since 6.0.0
  59. */
  60. interface IRequest {
  61. /**
  62. * @since 9.1.0
  63. */
  64. public const USER_AGENT_CLIENT_ANDROID = '/^Mozilla\/5\.0 \(Android\) (ownCloud|Nextcloud)\-android.*$/';
  65. /**
  66. * @since 13.0.0
  67. */
  68. public const USER_AGENT_TALK_ANDROID = '/^Mozilla\/5\.0 \(Android\) Nextcloud\-Talk v.*$/';
  69. /**
  70. * @since 9.1.0
  71. */
  72. public const USER_AGENT_CLIENT_DESKTOP = '/^Mozilla\/5\.0 \([A-Za-z ]+\) (mirall|csyncoC)\/.*$/';
  73. /**
  74. * @since 9.1.0
  75. */
  76. public const USER_AGENT_CLIENT_IOS = '/^Mozilla\/5\.0 \(iOS\) (ownCloud|Nextcloud)\-iOS.*$/';
  77. /**
  78. * @since 13.0.0
  79. */
  80. public const USER_AGENT_TALK_IOS = '/^Mozilla\/5\.0 \(iOS\) Nextcloud\-Talk v.*$/';
  81. /**
  82. * @since 13.0.1
  83. */
  84. public const USER_AGENT_OUTLOOK_ADDON = '/^Mozilla\/5\.0 \([A-Za-z ]+\) Nextcloud\-Outlook v.*$/';
  85. /**
  86. * @since 13.0.1
  87. */
  88. public const USER_AGENT_THUNDERBIRD_ADDON = '/^Mozilla\/5\.0 \([A-Za-z ]+\) Nextcloud\-Thunderbird v.*$/';
  89. /**
  90. * @param string $name
  91. *
  92. * @psalm-taint-source input
  93. *
  94. * @return string
  95. * @since 6.0.0
  96. */
  97. public function getHeader(string $name): string;
  98. /**
  99. * Lets you access post and get parameters by the index
  100. * In case of json requests the encoded json body is accessed
  101. *
  102. * @psalm-taint-source input
  103. *
  104. * @param string $key the key which you want to access in the URL Parameter
  105. * placeholder, $_POST or $_GET array.
  106. * The priority how they're returned is the following:
  107. * 1. URL parameters
  108. * 2. POST parameters
  109. * 3. GET parameters
  110. * @param mixed $default If the key is not found, this value will be returned
  111. * @return mixed the content of the array
  112. * @since 6.0.0
  113. */
  114. public function getParam(string $key, $default = null);
  115. /**
  116. * Returns all params that were received, be it from the request
  117. *
  118. * (as GET or POST) or through the URL by the route
  119. *
  120. * @psalm-taint-source input
  121. *
  122. * @return array the array with all parameters
  123. * @since 6.0.0
  124. */
  125. public function getParams(): array;
  126. /**
  127. * Returns the method of the request
  128. *
  129. * @return string the method of the request (POST, GET, etc)
  130. * @since 6.0.0
  131. */
  132. public function getMethod(): string;
  133. /**
  134. * Shortcut for accessing an uploaded file through the $_FILES array
  135. *
  136. * @param string $key the key that will be taken from the $_FILES array
  137. * @return array the file in the $_FILES element
  138. * @since 6.0.0
  139. */
  140. public function getUploadedFile(string $key);
  141. /**
  142. * Shortcut for getting env variables
  143. *
  144. * @param string $key the key that will be taken from the $_ENV array
  145. * @return array the value in the $_ENV element
  146. * @since 6.0.0
  147. */
  148. public function getEnv(string $key);
  149. /**
  150. * Shortcut for getting cookie variables
  151. *
  152. * @psalm-taint-source input
  153. *
  154. * @param string $key the key that will be taken from the $_COOKIE array
  155. * @return string|null the value in the $_COOKIE element
  156. * @since 6.0.0
  157. */
  158. public function getCookie(string $key);
  159. /**
  160. * Checks if the CSRF check was correct
  161. *
  162. * @return bool true if CSRF check passed
  163. * @since 6.0.0
  164. */
  165. public function passesCSRFCheck(): bool;
  166. /**
  167. * Checks if the strict cookie has been sent with the request if the request
  168. * is including any cookies.
  169. *
  170. * @return bool
  171. * @since 9.0.0
  172. */
  173. public function passesStrictCookieCheck(): bool;
  174. /**
  175. * Checks if the lax cookie has been sent with the request if the request
  176. * is including any cookies.
  177. *
  178. * @return bool
  179. * @since 9.0.0
  180. */
  181. public function passesLaxCookieCheck(): bool;
  182. /**
  183. * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
  184. * If `mod_unique_id` is installed this value will be taken.
  185. *
  186. * @return string
  187. * @since 8.1.0
  188. */
  189. public function getId(): string;
  190. /**
  191. * Returns the remote address, if the connection came from a trusted proxy
  192. * and `forwarded_for_headers` has been configured then the IP address
  193. * specified in this header will be returned instead.
  194. * Do always use this instead of $_SERVER['REMOTE_ADDR']
  195. *
  196. * @return string IP address
  197. * @since 8.1.0
  198. */
  199. public function getRemoteAddress(): string;
  200. /**
  201. * Returns the server protocol. It respects reverse proxy servers and load
  202. * balancers.
  203. *
  204. * @return string Server protocol (http or https)
  205. * @since 8.1.0
  206. */
  207. public function getServerProtocol(): string;
  208. /**
  209. * Returns the used HTTP protocol.
  210. *
  211. * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0.
  212. * @since 8.2.0
  213. */
  214. public function getHttpProtocol(): string;
  215. /**
  216. * Returns the request uri, even if the website uses one or more
  217. * reverse proxies
  218. *
  219. * @psalm-taint-source input
  220. *
  221. * @return string
  222. * @since 8.1.0
  223. */
  224. public function getRequestUri(): string;
  225. /**
  226. * Get raw PathInfo from request (not urldecoded)
  227. *
  228. * @psalm-taint-source input
  229. *
  230. * @throws \Exception
  231. * @return string Path info
  232. * @since 8.1.0
  233. */
  234. public function getRawPathInfo(): string;
  235. /**
  236. * Get PathInfo from request
  237. *
  238. * @psalm-taint-source input
  239. *
  240. * @throws \Exception
  241. * @return string|false Path info or false when not found
  242. * @since 8.1.0
  243. */
  244. public function getPathInfo();
  245. /**
  246. * Returns the script name, even if the website uses one or more
  247. * reverse proxies
  248. *
  249. * @return string the script name
  250. * @since 8.1.0
  251. */
  252. public function getScriptName(): string;
  253. /**
  254. * Checks whether the user agent matches a given regex
  255. *
  256. * @param array $agent array of agent names
  257. * @return bool true if at least one of the given agent matches, false otherwise
  258. * @since 8.1.0
  259. */
  260. public function isUserAgent(array $agent): bool;
  261. /**
  262. * Returns the unverified server host from the headers without checking
  263. * whether it is a trusted domain
  264. *
  265. * @psalm-taint-source input
  266. *
  267. * @return string Server host
  268. * @since 8.1.0
  269. */
  270. public function getInsecureServerHost(): string;
  271. /**
  272. * Returns the server host from the headers, or the first configured
  273. * trusted domain if the host isn't in the trusted list
  274. *
  275. * @return string Server host
  276. * @since 8.1.0
  277. */
  278. public function getServerHost(): string;
  279. }