@@ -33,26 +33,26 @@ |
||
33 | 33 | * @package OC\Security\RateLimiting\Backend |
34 | 34 | */ |
35 | 35 | interface IBackend { |
36 | - /** |
|
37 | - * Gets the amount of attempts within the last specified seconds |
|
38 | - * |
|
39 | - * @param string $methodIdentifier Identifier for the method |
|
40 | - * @param string $userIdentifier Identifier for the user |
|
41 | - * @param int $seconds Seconds to look back at |
|
42 | - * @return int |
|
43 | - */ |
|
44 | - public function getAttempts(string $methodIdentifier, |
|
45 | - string $userIdentifier, |
|
46 | - int $seconds): int; |
|
36 | + /** |
|
37 | + * Gets the amount of attempts within the last specified seconds |
|
38 | + * |
|
39 | + * @param string $methodIdentifier Identifier for the method |
|
40 | + * @param string $userIdentifier Identifier for the user |
|
41 | + * @param int $seconds Seconds to look back at |
|
42 | + * @return int |
|
43 | + */ |
|
44 | + public function getAttempts(string $methodIdentifier, |
|
45 | + string $userIdentifier, |
|
46 | + int $seconds): int; |
|
47 | 47 | |
48 | - /** |
|
49 | - * Registers an attempt |
|
50 | - * |
|
51 | - * @param string $methodIdentifier Identifier for the method |
|
52 | - * @param string $userIdentifier Identifier for the user |
|
53 | - * @param int $period Period in seconds how long this attempt should be stored |
|
54 | - */ |
|
55 | - public function registerAttempt(string $methodIdentifier, |
|
56 | - string $userIdentifier, |
|
57 | - int $period); |
|
48 | + /** |
|
49 | + * Registers an attempt |
|
50 | + * |
|
51 | + * @param string $methodIdentifier Identifier for the method |
|
52 | + * @param string $userIdentifier Identifier for the user |
|
53 | + * @param int $period Period in seconds how long this attempt should be stored |
|
54 | + */ |
|
55 | + public function registerAttempt(string $methodIdentifier, |
|
56 | + string $userIdentifier, |
|
57 | + int $period); |
|
58 | 58 | } |
@@ -23,19 +23,19 @@ |
||
23 | 23 | // WARNING: this should be moved to proper AppFramework handling |
24 | 24 | // Check if we are a user |
25 | 25 | if (!\OC::$server->getUserSession()->isLoggedIn()) { |
26 | - header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute( |
|
27 | - 'core.login.showLoginForm', |
|
28 | - [ |
|
29 | - 'redirect_url' => \OC::$server->getRequest()->getRequestUri(), |
|
30 | - ] |
|
31 | - ) |
|
32 | - ); |
|
33 | - exit(); |
|
26 | + header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute( |
|
27 | + 'core.login.showLoginForm', |
|
28 | + [ |
|
29 | + 'redirect_url' => \OC::$server->getRequest()->getRequestUri(), |
|
30 | + ] |
|
31 | + ) |
|
32 | + ); |
|
33 | + exit(); |
|
34 | 34 | } |
35 | 35 | // Redirect to 2FA challenge selection if 2FA challenge was not solved yet |
36 | 36 | if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) { |
37 | - header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge')); |
|
38 | - exit(); |
|
37 | + header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge')); |
|
38 | + exit(); |
|
39 | 39 | } |
40 | 40 | |
41 | 41 | $tmpl = new OCP\Template('systemtags', 'list', ''); |
@@ -23,7 +23,7 @@ discard block |
||
23 | 23 | // WARNING: this should be moved to proper AppFramework handling |
24 | 24 | // Check if we are a user |
25 | 25 | if (!\OC::$server->getUserSession()->isLoggedIn()) { |
26 | - header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute( |
|
26 | + header('Location: '.\OC::$server->getURLGenerator()->linkToRoute( |
|
27 | 27 | 'core.login.showLoginForm', |
28 | 28 | [ |
29 | 29 | 'redirect_url' => \OC::$server->getRequest()->getRequestUri(), |
@@ -34,7 +34,7 @@ discard block |
||
34 | 34 | } |
35 | 35 | // Redirect to 2FA challenge selection if 2FA challenge was not solved yet |
36 | 36 | if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) { |
37 | - header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge')); |
|
37 | + header('Location: '.\OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge')); |
|
38 | 38 | exit(); |
39 | 39 | } |
40 | 40 |
@@ -30,35 +30,35 @@ |
||
30 | 30 | * @since 12.0.0 |
31 | 31 | */ |
32 | 32 | interface ICloudId { |
33 | - /** |
|
34 | - * The remote cloud id |
|
35 | - * |
|
36 | - * @return string |
|
37 | - * @since 12.0.0 |
|
38 | - */ |
|
39 | - public function getId(): string; |
|
33 | + /** |
|
34 | + * The remote cloud id |
|
35 | + * |
|
36 | + * @return string |
|
37 | + * @since 12.0.0 |
|
38 | + */ |
|
39 | + public function getId(): string; |
|
40 | 40 | |
41 | - /** |
|
42 | - * Get a clean representation of the cloud id for display |
|
43 | - * |
|
44 | - * @return string |
|
45 | - * @since 12.0.0 |
|
46 | - */ |
|
47 | - public function getDisplayId(): string; |
|
41 | + /** |
|
42 | + * Get a clean representation of the cloud id for display |
|
43 | + * |
|
44 | + * @return string |
|
45 | + * @since 12.0.0 |
|
46 | + */ |
|
47 | + public function getDisplayId(): string; |
|
48 | 48 | |
49 | - /** |
|
50 | - * The username on the remote server |
|
51 | - * |
|
52 | - * @return string |
|
53 | - * @since 12.0.0 |
|
54 | - */ |
|
55 | - public function getUser(): string; |
|
49 | + /** |
|
50 | + * The username on the remote server |
|
51 | + * |
|
52 | + * @return string |
|
53 | + * @since 12.0.0 |
|
54 | + */ |
|
55 | + public function getUser(): string; |
|
56 | 56 | |
57 | - /** |
|
58 | - * The base address of the remote server |
|
59 | - * |
|
60 | - * @return string |
|
61 | - * @since 12.0.0 |
|
62 | - */ |
|
63 | - public function getRemote(): string; |
|
57 | + /** |
|
58 | + * The base address of the remote server |
|
59 | + * |
|
60 | + * @return string |
|
61 | + * @since 12.0.0 |
|
62 | + */ |
|
63 | + public function getRemote(): string; |
|
64 | 64 | } |
@@ -31,33 +31,33 @@ |
||
31 | 31 | * @since 12.0.0 |
32 | 32 | */ |
33 | 33 | interface ICloudIdManager { |
34 | - /** |
|
35 | - * @param string $cloudId |
|
36 | - * @return ICloudId |
|
37 | - * @throws \InvalidArgumentException |
|
38 | - * |
|
39 | - * @since 12.0.0 |
|
40 | - */ |
|
41 | - public function resolveCloudId(string $cloudId): ICloudId; |
|
34 | + /** |
|
35 | + * @param string $cloudId |
|
36 | + * @return ICloudId |
|
37 | + * @throws \InvalidArgumentException |
|
38 | + * |
|
39 | + * @since 12.0.0 |
|
40 | + */ |
|
41 | + public function resolveCloudId(string $cloudId): ICloudId; |
|
42 | 42 | |
43 | - /** |
|
44 | - * Get the cloud id for a remote user |
|
45 | - * |
|
46 | - * @param string $user |
|
47 | - * @param string $remote |
|
48 | - * @return ICloudId |
|
49 | - * |
|
50 | - * @since 12.0.0 |
|
51 | - */ |
|
52 | - public function getCloudId(string $user, string $remote): ICloudId; |
|
43 | + /** |
|
44 | + * Get the cloud id for a remote user |
|
45 | + * |
|
46 | + * @param string $user |
|
47 | + * @param string $remote |
|
48 | + * @return ICloudId |
|
49 | + * |
|
50 | + * @since 12.0.0 |
|
51 | + */ |
|
52 | + public function getCloudId(string $user, string $remote): ICloudId; |
|
53 | 53 | |
54 | - /** |
|
55 | - * Check if the input is a correctly formatted cloud id |
|
56 | - * |
|
57 | - * @param string $cloudId |
|
58 | - * @return bool |
|
59 | - * |
|
60 | - * @since 12.0.0 |
|
61 | - */ |
|
62 | - public function isValidCloudId(string $cloudId): bool; |
|
54 | + /** |
|
55 | + * Check if the input is a correctly formatted cloud id |
|
56 | + * |
|
57 | + * @param string $cloudId |
|
58 | + * @return bool |
|
59 | + * |
|
60 | + * @since 12.0.0 |
|
61 | + */ |
|
62 | + public function isValidCloudId(string $cloudId): bool; |
|
63 | 63 | } |
@@ -32,178 +32,178 @@ |
||
32 | 32 | */ |
33 | 33 | interface IClient { |
34 | 34 | |
35 | - /** |
|
36 | - * Sends a GET request |
|
37 | - * @param string $uri |
|
38 | - * @param array $options Array such as |
|
39 | - * 'query' => [ |
|
40 | - * 'field' => 'abc', |
|
41 | - * 'other_field' => '123', |
|
42 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
43 | - * ], |
|
44 | - * 'headers' => [ |
|
45 | - * 'foo' => 'bar', |
|
46 | - * ], |
|
47 | - * 'cookies' => [' |
|
48 | - * 'foo' => 'bar', |
|
49 | - * ], |
|
50 | - * 'allow_redirects' => [ |
|
51 | - * 'max' => 10, // allow at most 10 redirects. |
|
52 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
53 | - * 'referer' => true, // add a Referer header |
|
54 | - * 'protocols' => ['https'] // only allow https URLs |
|
55 | - * ], |
|
56 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
57 | - * 'verify' => true, // bool or string to CA file |
|
58 | - * 'debug' => true, |
|
59 | - * @return IResponse |
|
60 | - * @throws \Exception If the request could not get completed |
|
61 | - * @since 8.1.0 |
|
62 | - */ |
|
63 | - public function get(string $uri, array $options = []): IResponse; |
|
35 | + /** |
|
36 | + * Sends a GET request |
|
37 | + * @param string $uri |
|
38 | + * @param array $options Array such as |
|
39 | + * 'query' => [ |
|
40 | + * 'field' => 'abc', |
|
41 | + * 'other_field' => '123', |
|
42 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
43 | + * ], |
|
44 | + * 'headers' => [ |
|
45 | + * 'foo' => 'bar', |
|
46 | + * ], |
|
47 | + * 'cookies' => [' |
|
48 | + * 'foo' => 'bar', |
|
49 | + * ], |
|
50 | + * 'allow_redirects' => [ |
|
51 | + * 'max' => 10, // allow at most 10 redirects. |
|
52 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
53 | + * 'referer' => true, // add a Referer header |
|
54 | + * 'protocols' => ['https'] // only allow https URLs |
|
55 | + * ], |
|
56 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
57 | + * 'verify' => true, // bool or string to CA file |
|
58 | + * 'debug' => true, |
|
59 | + * @return IResponse |
|
60 | + * @throws \Exception If the request could not get completed |
|
61 | + * @since 8.1.0 |
|
62 | + */ |
|
63 | + public function get(string $uri, array $options = []): IResponse; |
|
64 | 64 | |
65 | - /** |
|
66 | - * Sends a HEAD request |
|
67 | - * @param string $uri |
|
68 | - * @param array $options Array such as |
|
69 | - * 'headers' => [ |
|
70 | - * 'foo' => 'bar', |
|
71 | - * ], |
|
72 | - * 'cookies' => [' |
|
73 | - * 'foo' => 'bar', |
|
74 | - * ], |
|
75 | - * 'allow_redirects' => [ |
|
76 | - * 'max' => 10, // allow at most 10 redirects. |
|
77 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
78 | - * 'referer' => true, // add a Referer header |
|
79 | - * 'protocols' => ['https'] // only allow https URLs |
|
80 | - * ], |
|
81 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
82 | - * 'verify' => true, // bool or string to CA file |
|
83 | - * 'debug' => true, |
|
84 | - * @return IResponse |
|
85 | - * @throws \Exception If the request could not get completed |
|
86 | - * @since 8.1.0 |
|
87 | - */ |
|
88 | - public function head(string $uri, array $options = []): IResponse; |
|
65 | + /** |
|
66 | + * Sends a HEAD request |
|
67 | + * @param string $uri |
|
68 | + * @param array $options Array such as |
|
69 | + * 'headers' => [ |
|
70 | + * 'foo' => 'bar', |
|
71 | + * ], |
|
72 | + * 'cookies' => [' |
|
73 | + * 'foo' => 'bar', |
|
74 | + * ], |
|
75 | + * 'allow_redirects' => [ |
|
76 | + * 'max' => 10, // allow at most 10 redirects. |
|
77 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
78 | + * 'referer' => true, // add a Referer header |
|
79 | + * 'protocols' => ['https'] // only allow https URLs |
|
80 | + * ], |
|
81 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
82 | + * 'verify' => true, // bool or string to CA file |
|
83 | + * 'debug' => true, |
|
84 | + * @return IResponse |
|
85 | + * @throws \Exception If the request could not get completed |
|
86 | + * @since 8.1.0 |
|
87 | + */ |
|
88 | + public function head(string $uri, array $options = []): IResponse; |
|
89 | 89 | |
90 | - /** |
|
91 | - * Sends a POST request |
|
92 | - * @param string $uri |
|
93 | - * @param array $options Array such as |
|
94 | - * 'body' => [ |
|
95 | - * 'field' => 'abc', |
|
96 | - * 'other_field' => '123', |
|
97 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
98 | - * ], |
|
99 | - * 'headers' => [ |
|
100 | - * 'foo' => 'bar', |
|
101 | - * ], |
|
102 | - * 'cookies' => [' |
|
103 | - * 'foo' => 'bar', |
|
104 | - * ], |
|
105 | - * 'allow_redirects' => [ |
|
106 | - * 'max' => 10, // allow at most 10 redirects. |
|
107 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
108 | - * 'referer' => true, // add a Referer header |
|
109 | - * 'protocols' => ['https'] // only allow https URLs |
|
110 | - * ], |
|
111 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
112 | - * 'verify' => true, // bool or string to CA file |
|
113 | - * 'debug' => true, |
|
114 | - * @return IResponse |
|
115 | - * @throws \Exception If the request could not get completed |
|
116 | - * @since 8.1.0 |
|
117 | - */ |
|
118 | - public function post(string $uri, array $options = []): IResponse; |
|
90 | + /** |
|
91 | + * Sends a POST request |
|
92 | + * @param string $uri |
|
93 | + * @param array $options Array such as |
|
94 | + * 'body' => [ |
|
95 | + * 'field' => 'abc', |
|
96 | + * 'other_field' => '123', |
|
97 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
98 | + * ], |
|
99 | + * 'headers' => [ |
|
100 | + * 'foo' => 'bar', |
|
101 | + * ], |
|
102 | + * 'cookies' => [' |
|
103 | + * 'foo' => 'bar', |
|
104 | + * ], |
|
105 | + * 'allow_redirects' => [ |
|
106 | + * 'max' => 10, // allow at most 10 redirects. |
|
107 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
108 | + * 'referer' => true, // add a Referer header |
|
109 | + * 'protocols' => ['https'] // only allow https URLs |
|
110 | + * ], |
|
111 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
112 | + * 'verify' => true, // bool or string to CA file |
|
113 | + * 'debug' => true, |
|
114 | + * @return IResponse |
|
115 | + * @throws \Exception If the request could not get completed |
|
116 | + * @since 8.1.0 |
|
117 | + */ |
|
118 | + public function post(string $uri, array $options = []): IResponse; |
|
119 | 119 | |
120 | - /** |
|
121 | - * Sends a PUT request |
|
122 | - * @param string $uri |
|
123 | - * @param array $options Array such as |
|
124 | - * 'body' => [ |
|
125 | - * 'field' => 'abc', |
|
126 | - * 'other_field' => '123', |
|
127 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
128 | - * ], |
|
129 | - * 'headers' => [ |
|
130 | - * 'foo' => 'bar', |
|
131 | - * ], |
|
132 | - * 'cookies' => [' |
|
133 | - * 'foo' => 'bar', |
|
134 | - * ], |
|
135 | - * 'allow_redirects' => [ |
|
136 | - * 'max' => 10, // allow at most 10 redirects. |
|
137 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
138 | - * 'referer' => true, // add a Referer header |
|
139 | - * 'protocols' => ['https'] // only allow https URLs |
|
140 | - * ], |
|
141 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
142 | - * 'verify' => true, // bool or string to CA file |
|
143 | - * 'debug' => true, |
|
144 | - * @return IResponse |
|
145 | - * @throws \Exception If the request could not get completed |
|
146 | - * @since 8.1.0 |
|
147 | - */ |
|
148 | - public function put(string $uri, array $options = []): IResponse; |
|
120 | + /** |
|
121 | + * Sends a PUT request |
|
122 | + * @param string $uri |
|
123 | + * @param array $options Array such as |
|
124 | + * 'body' => [ |
|
125 | + * 'field' => 'abc', |
|
126 | + * 'other_field' => '123', |
|
127 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
128 | + * ], |
|
129 | + * 'headers' => [ |
|
130 | + * 'foo' => 'bar', |
|
131 | + * ], |
|
132 | + * 'cookies' => [' |
|
133 | + * 'foo' => 'bar', |
|
134 | + * ], |
|
135 | + * 'allow_redirects' => [ |
|
136 | + * 'max' => 10, // allow at most 10 redirects. |
|
137 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
138 | + * 'referer' => true, // add a Referer header |
|
139 | + * 'protocols' => ['https'] // only allow https URLs |
|
140 | + * ], |
|
141 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
142 | + * 'verify' => true, // bool or string to CA file |
|
143 | + * 'debug' => true, |
|
144 | + * @return IResponse |
|
145 | + * @throws \Exception If the request could not get completed |
|
146 | + * @since 8.1.0 |
|
147 | + */ |
|
148 | + public function put(string $uri, array $options = []): IResponse; |
|
149 | 149 | |
150 | - /** |
|
151 | - * Sends a DELETE request |
|
152 | - * @param string $uri |
|
153 | - * @param array $options Array such as |
|
154 | - * 'body' => [ |
|
155 | - * 'field' => 'abc', |
|
156 | - * 'other_field' => '123', |
|
157 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
158 | - * ], |
|
159 | - * 'headers' => [ |
|
160 | - * 'foo' => 'bar', |
|
161 | - * ], |
|
162 | - * 'cookies' => [' |
|
163 | - * 'foo' => 'bar', |
|
164 | - * ], |
|
165 | - * 'allow_redirects' => [ |
|
166 | - * 'max' => 10, // allow at most 10 redirects. |
|
167 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
168 | - * 'referer' => true, // add a Referer header |
|
169 | - * 'protocols' => ['https'] // only allow https URLs |
|
170 | - * ], |
|
171 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
172 | - * 'verify' => true, // bool or string to CA file |
|
173 | - * 'debug' => true, |
|
174 | - * @return IResponse |
|
175 | - * @throws \Exception If the request could not get completed |
|
176 | - * @since 8.1.0 |
|
177 | - */ |
|
178 | - public function delete(string $uri, array $options = []): IResponse; |
|
150 | + /** |
|
151 | + * Sends a DELETE request |
|
152 | + * @param string $uri |
|
153 | + * @param array $options Array such as |
|
154 | + * 'body' => [ |
|
155 | + * 'field' => 'abc', |
|
156 | + * 'other_field' => '123', |
|
157 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
158 | + * ], |
|
159 | + * 'headers' => [ |
|
160 | + * 'foo' => 'bar', |
|
161 | + * ], |
|
162 | + * 'cookies' => [' |
|
163 | + * 'foo' => 'bar', |
|
164 | + * ], |
|
165 | + * 'allow_redirects' => [ |
|
166 | + * 'max' => 10, // allow at most 10 redirects. |
|
167 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
168 | + * 'referer' => true, // add a Referer header |
|
169 | + * 'protocols' => ['https'] // only allow https URLs |
|
170 | + * ], |
|
171 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
172 | + * 'verify' => true, // bool or string to CA file |
|
173 | + * 'debug' => true, |
|
174 | + * @return IResponse |
|
175 | + * @throws \Exception If the request could not get completed |
|
176 | + * @since 8.1.0 |
|
177 | + */ |
|
178 | + public function delete(string $uri, array $options = []): IResponse; |
|
179 | 179 | |
180 | - /** |
|
181 | - * Sends a options request |
|
182 | - * @param string $uri |
|
183 | - * @param array $options Array such as |
|
184 | - * 'body' => [ |
|
185 | - * 'field' => 'abc', |
|
186 | - * 'other_field' => '123', |
|
187 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
188 | - * ], |
|
189 | - * 'headers' => [ |
|
190 | - * 'foo' => 'bar', |
|
191 | - * ], |
|
192 | - * 'cookies' => [' |
|
193 | - * 'foo' => 'bar', |
|
194 | - * ], |
|
195 | - * 'allow_redirects' => [ |
|
196 | - * 'max' => 10, // allow at most 10 redirects. |
|
197 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
198 | - * 'referer' => true, // add a Referer header |
|
199 | - * 'protocols' => ['https'] // only allow https URLs |
|
200 | - * ], |
|
201 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
202 | - * 'verify' => true, // bool or string to CA file |
|
203 | - * 'debug' => true, |
|
204 | - * @return IResponse |
|
205 | - * @throws \Exception If the request could not get completed |
|
206 | - * @since 8.1.0 |
|
207 | - */ |
|
208 | - public function options(string $uri, array $options = []): IResponse; |
|
180 | + /** |
|
181 | + * Sends a options request |
|
182 | + * @param string $uri |
|
183 | + * @param array $options Array such as |
|
184 | + * 'body' => [ |
|
185 | + * 'field' => 'abc', |
|
186 | + * 'other_field' => '123', |
|
187 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
188 | + * ], |
|
189 | + * 'headers' => [ |
|
190 | + * 'foo' => 'bar', |
|
191 | + * ], |
|
192 | + * 'cookies' => [' |
|
193 | + * 'foo' => 'bar', |
|
194 | + * ], |
|
195 | + * 'allow_redirects' => [ |
|
196 | + * 'max' => 10, // allow at most 10 redirects. |
|
197 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
198 | + * 'referer' => true, // add a Referer header |
|
199 | + * 'protocols' => ['https'] // only allow https URLs |
|
200 | + * ], |
|
201 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
202 | + * 'verify' => true, // bool or string to CA file |
|
203 | + * 'debug' => true, |
|
204 | + * @return IResponse |
|
205 | + * @throws \Exception If the request could not get completed |
|
206 | + * @since 8.1.0 |
|
207 | + */ |
|
208 | + public function options(string $uri, array $options = []): IResponse; |
|
209 | 209 | } |
@@ -31,9 +31,9 @@ |
||
31 | 31 | * @since 8.1.0 |
32 | 32 | */ |
33 | 33 | interface IClientService { |
34 | - /** |
|
35 | - * @return IClient |
|
36 | - * @since 8.1.0 |
|
37 | - */ |
|
38 | - public function newClient(): IClient; |
|
34 | + /** |
|
35 | + * @return IClient |
|
36 | + * @since 8.1.0 |
|
37 | + */ |
|
38 | + public function newClient(): IClient; |
|
39 | 39 | } |
@@ -32,28 +32,28 @@ |
||
32 | 32 | * @since 8.1.0 |
33 | 33 | */ |
34 | 34 | interface IResponse { |
35 | - /** |
|
36 | - * @return string|resource |
|
37 | - * @since 8.1.0 |
|
38 | - */ |
|
39 | - public function getBody(); |
|
35 | + /** |
|
36 | + * @return string|resource |
|
37 | + * @since 8.1.0 |
|
38 | + */ |
|
39 | + public function getBody(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @return int |
|
43 | - * @since 8.1.0 |
|
44 | - */ |
|
45 | - public function getStatusCode(): int; |
|
41 | + /** |
|
42 | + * @return int |
|
43 | + * @since 8.1.0 |
|
44 | + */ |
|
45 | + public function getStatusCode(): int; |
|
46 | 46 | |
47 | - /** |
|
48 | - * @param string $key |
|
49 | - * @return string |
|
50 | - * @since 8.1.0 |
|
51 | - */ |
|
52 | - public function getHeader(string $key): string; |
|
47 | + /** |
|
48 | + * @param string $key |
|
49 | + * @return string |
|
50 | + * @since 8.1.0 |
|
51 | + */ |
|
52 | + public function getHeader(string $key): string; |
|
53 | 53 | |
54 | - /** |
|
55 | - * @return array |
|
56 | - * @since 8.1.0 |
|
57 | - */ |
|
58 | - public function getHeaders(): array; |
|
54 | + /** |
|
55 | + * @return array |
|
56 | + * @since 8.1.0 |
|
57 | + */ |
|
58 | + public function getHeaders(): array; |
|
59 | 59 | } |
@@ -45,23 +45,23 @@ |
||
45 | 45 | * @since 8.0.0 |
46 | 46 | */ |
47 | 47 | interface IHasher { |
48 | - /** |
|
49 | - * Hashes a message using PHP's `password_hash` functionality. |
|
50 | - * Please note that the size of the returned string is not guaranteed |
|
51 | - * and can be up to 255 characters. |
|
52 | - * |
|
53 | - * @param string $message Message to generate hash from |
|
54 | - * @return string Hash of the message with appended version parameter |
|
55 | - * @since 8.0.0 |
|
56 | - */ |
|
57 | - public function hash(string $message): string; |
|
48 | + /** |
|
49 | + * Hashes a message using PHP's `password_hash` functionality. |
|
50 | + * Please note that the size of the returned string is not guaranteed |
|
51 | + * and can be up to 255 characters. |
|
52 | + * |
|
53 | + * @param string $message Message to generate hash from |
|
54 | + * @return string Hash of the message with appended version parameter |
|
55 | + * @since 8.0.0 |
|
56 | + */ |
|
57 | + public function hash(string $message): string; |
|
58 | 58 | |
59 | - /** |
|
60 | - * @param string $message Message to verify |
|
61 | - * @param string $hash Assumed hash of the message |
|
62 | - * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
63 | - * @return bool Whether $hash is a valid hash of $message |
|
64 | - * @since 8.0.0 |
|
65 | - */ |
|
66 | - public function verify(string $message, string $hash, &$newHash = null): bool ; |
|
59 | + /** |
|
60 | + * @param string $message Message to verify |
|
61 | + * @param string $hash Assumed hash of the message |
|
62 | + * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
63 | + * @return bool Whether $hash is a valid hash of $message |
|
64 | + * @since 8.0.0 |
|
65 | + */ |
|
66 | + public function verify(string $message, string $hash, &$newHash = null): bool ; |
|
67 | 67 | } |
@@ -63,5 +63,5 @@ |
||
63 | 63 | * @return bool Whether $hash is a valid hash of $message |
64 | 64 | * @since 8.0.0 |
65 | 65 | */ |
66 | - public function verify(string $message, string $hash, &$newHash = null): bool ; |
|
66 | + public function verify(string $message, string $hash, &$newHash = null): bool; |
|
67 | 67 | } |
@@ -133,7 +133,7 @@ discard block |
||
133 | 133 | * @return IMemcache |
134 | 134 | */ |
135 | 135 | public function createLocking(string $prefix = ''): IMemcache { |
136 | - return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix); |
|
136 | + return new $this->lockingCacheClass($this->globalPrefix.'/'.$prefix); |
|
137 | 137 | } |
138 | 138 | |
139 | 139 | /** |
@@ -143,7 +143,7 @@ discard block |
||
143 | 143 | * @return ICache |
144 | 144 | */ |
145 | 145 | public function createDistributed(string $prefix = ''): ICache { |
146 | - return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix); |
|
146 | + return new $this->distributedCacheClass($this->globalPrefix.'/'.$prefix); |
|
147 | 147 | } |
148 | 148 | |
149 | 149 | /** |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | * @return ICache |
154 | 154 | */ |
155 | 155 | public function createLocal(string $prefix = ''): ICache { |
156 | - return new $this->localCacheClass($this->globalPrefix . '/' . $prefix); |
|
156 | + return new $this->localCacheClass($this->globalPrefix.'/'.$prefix); |
|
157 | 157 | } |
158 | 158 | |
159 | 159 | /** |
@@ -36,158 +36,158 @@ |
||
36 | 36 | use OCP\IMemcache; |
37 | 37 | |
38 | 38 | class Factory implements ICacheFactory { |
39 | - public const NULL_CACHE = NullCache::class; |
|
40 | - |
|
41 | - /** |
|
42 | - * @var string $globalPrefix |
|
43 | - */ |
|
44 | - private $globalPrefix; |
|
45 | - |
|
46 | - /** |
|
47 | - * @var ILogger $logger |
|
48 | - */ |
|
49 | - private $logger; |
|
50 | - |
|
51 | - /** |
|
52 | - * @var string $localCacheClass |
|
53 | - */ |
|
54 | - private $localCacheClass; |
|
55 | - |
|
56 | - /** |
|
57 | - * @var string $distributedCacheClass |
|
58 | - */ |
|
59 | - private $distributedCacheClass; |
|
60 | - |
|
61 | - /** |
|
62 | - * @var string $lockingCacheClass |
|
63 | - */ |
|
64 | - private $lockingCacheClass; |
|
65 | - |
|
66 | - /** |
|
67 | - * @param string $globalPrefix |
|
68 | - * @param ILogger $logger |
|
69 | - * @param string|null $localCacheClass |
|
70 | - * @param string|null $distributedCacheClass |
|
71 | - * @param string|null $lockingCacheClass |
|
72 | - */ |
|
73 | - public function __construct(string $globalPrefix, ILogger $logger, |
|
74 | - $localCacheClass = null, $distributedCacheClass = null, $lockingCacheClass = null) { |
|
75 | - $this->logger = $logger; |
|
76 | - $this->globalPrefix = $globalPrefix; |
|
77 | - |
|
78 | - if (!$localCacheClass) { |
|
79 | - $localCacheClass = self::NULL_CACHE; |
|
80 | - } |
|
81 | - if (!$distributedCacheClass) { |
|
82 | - $distributedCacheClass = $localCacheClass; |
|
83 | - } |
|
84 | - |
|
85 | - $missingCacheMessage = 'Memcache {class} not available for {use} cache'; |
|
86 | - $missingCacheHint = 'Is the matching PHP module installed and enabled?'; |
|
87 | - if (!class_exists($localCacheClass) || !$localCacheClass::isAvailable()) { |
|
88 | - if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
89 | - // CLI should not hard-fail on broken memcache |
|
90 | - $this->logger->info($missingCacheMessage, [ |
|
91 | - 'class' => $localCacheClass, |
|
92 | - 'use' => 'local', |
|
93 | - 'app' => 'cli' |
|
94 | - ]); |
|
95 | - $localCacheClass = self::NULL_CACHE; |
|
96 | - } else { |
|
97 | - throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
98 | - '{class}' => $localCacheClass, '{use}' => 'local' |
|
99 | - ]), $missingCacheHint); |
|
100 | - } |
|
101 | - } |
|
102 | - if (!class_exists($distributedCacheClass) || !$distributedCacheClass::isAvailable()) { |
|
103 | - if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
104 | - // CLI should not hard-fail on broken memcache |
|
105 | - $this->logger->info($missingCacheMessage, [ |
|
106 | - 'class' => $distributedCacheClass, |
|
107 | - 'use' => 'distributed', |
|
108 | - 'app' => 'cli' |
|
109 | - ]); |
|
110 | - $distributedCacheClass = self::NULL_CACHE; |
|
111 | - } else { |
|
112 | - throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
113 | - '{class}' => $distributedCacheClass, '{use}' => 'distributed' |
|
114 | - ]), $missingCacheHint); |
|
115 | - } |
|
116 | - } |
|
117 | - if (!($lockingCacheClass && class_exists($distributedCacheClass) && $lockingCacheClass::isAvailable())) { |
|
118 | - // don't fallback since the fallback might not be suitable for storing lock |
|
119 | - $lockingCacheClass = self::NULL_CACHE; |
|
120 | - } |
|
121 | - |
|
122 | - $this->localCacheClass = $localCacheClass; |
|
123 | - $this->distributedCacheClass = $distributedCacheClass; |
|
124 | - $this->lockingCacheClass = $lockingCacheClass; |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * create a cache instance for storing locks |
|
129 | - * |
|
130 | - * @param string $prefix |
|
131 | - * @return IMemcache |
|
132 | - */ |
|
133 | - public function createLocking(string $prefix = ''): IMemcache { |
|
134 | - return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix); |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * create a distributed cache instance |
|
139 | - * |
|
140 | - * @param string $prefix |
|
141 | - * @return ICache |
|
142 | - */ |
|
143 | - public function createDistributed(string $prefix = ''): ICache { |
|
144 | - return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix); |
|
145 | - } |
|
146 | - |
|
147 | - /** |
|
148 | - * create a local cache instance |
|
149 | - * |
|
150 | - * @param string $prefix |
|
151 | - * @return ICache |
|
152 | - */ |
|
153 | - public function createLocal(string $prefix = ''): ICache { |
|
154 | - return new $this->localCacheClass($this->globalPrefix . '/' . $prefix); |
|
155 | - } |
|
156 | - |
|
157 | - /** |
|
158 | - * @see \OC\Memcache\Factory::createDistributed() |
|
159 | - * @param string $prefix |
|
160 | - * @return ICache |
|
161 | - * @deprecated 13.0.0 Use either createLocking, createDistributed or createLocal |
|
162 | - */ |
|
163 | - public function create(string $prefix = ''): ICache { |
|
164 | - return $this->createDistributed($prefix); |
|
165 | - } |
|
166 | - |
|
167 | - /** |
|
168 | - * check memcache availability |
|
169 | - * |
|
170 | - * @return bool |
|
171 | - */ |
|
172 | - public function isAvailable(): bool { |
|
173 | - return ($this->distributedCacheClass !== self::NULL_CACHE); |
|
174 | - } |
|
175 | - |
|
176 | - /** |
|
177 | - * @see \OC\Memcache\Factory::createLocal() |
|
178 | - * @param string $prefix |
|
179 | - * @return ICache |
|
180 | - */ |
|
181 | - public function createLowLatency(string $prefix = ''): ICache { |
|
182 | - return $this->createLocal($prefix); |
|
183 | - } |
|
184 | - |
|
185 | - /** |
|
186 | - * Check if a local memory cache backend is available |
|
187 | - * |
|
188 | - * @return bool |
|
189 | - */ |
|
190 | - public function isLocalCacheAvailable(): bool { |
|
191 | - return ($this->localCacheClass !== self::NULL_CACHE); |
|
192 | - } |
|
39 | + public const NULL_CACHE = NullCache::class; |
|
40 | + |
|
41 | + /** |
|
42 | + * @var string $globalPrefix |
|
43 | + */ |
|
44 | + private $globalPrefix; |
|
45 | + |
|
46 | + /** |
|
47 | + * @var ILogger $logger |
|
48 | + */ |
|
49 | + private $logger; |
|
50 | + |
|
51 | + /** |
|
52 | + * @var string $localCacheClass |
|
53 | + */ |
|
54 | + private $localCacheClass; |
|
55 | + |
|
56 | + /** |
|
57 | + * @var string $distributedCacheClass |
|
58 | + */ |
|
59 | + private $distributedCacheClass; |
|
60 | + |
|
61 | + /** |
|
62 | + * @var string $lockingCacheClass |
|
63 | + */ |
|
64 | + private $lockingCacheClass; |
|
65 | + |
|
66 | + /** |
|
67 | + * @param string $globalPrefix |
|
68 | + * @param ILogger $logger |
|
69 | + * @param string|null $localCacheClass |
|
70 | + * @param string|null $distributedCacheClass |
|
71 | + * @param string|null $lockingCacheClass |
|
72 | + */ |
|
73 | + public function __construct(string $globalPrefix, ILogger $logger, |
|
74 | + $localCacheClass = null, $distributedCacheClass = null, $lockingCacheClass = null) { |
|
75 | + $this->logger = $logger; |
|
76 | + $this->globalPrefix = $globalPrefix; |
|
77 | + |
|
78 | + if (!$localCacheClass) { |
|
79 | + $localCacheClass = self::NULL_CACHE; |
|
80 | + } |
|
81 | + if (!$distributedCacheClass) { |
|
82 | + $distributedCacheClass = $localCacheClass; |
|
83 | + } |
|
84 | + |
|
85 | + $missingCacheMessage = 'Memcache {class} not available for {use} cache'; |
|
86 | + $missingCacheHint = 'Is the matching PHP module installed and enabled?'; |
|
87 | + if (!class_exists($localCacheClass) || !$localCacheClass::isAvailable()) { |
|
88 | + if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
89 | + // CLI should not hard-fail on broken memcache |
|
90 | + $this->logger->info($missingCacheMessage, [ |
|
91 | + 'class' => $localCacheClass, |
|
92 | + 'use' => 'local', |
|
93 | + 'app' => 'cli' |
|
94 | + ]); |
|
95 | + $localCacheClass = self::NULL_CACHE; |
|
96 | + } else { |
|
97 | + throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
98 | + '{class}' => $localCacheClass, '{use}' => 'local' |
|
99 | + ]), $missingCacheHint); |
|
100 | + } |
|
101 | + } |
|
102 | + if (!class_exists($distributedCacheClass) || !$distributedCacheClass::isAvailable()) { |
|
103 | + if (\OC::$CLI && !defined('PHPUNIT_RUN')) { |
|
104 | + // CLI should not hard-fail on broken memcache |
|
105 | + $this->logger->info($missingCacheMessage, [ |
|
106 | + 'class' => $distributedCacheClass, |
|
107 | + 'use' => 'distributed', |
|
108 | + 'app' => 'cli' |
|
109 | + ]); |
|
110 | + $distributedCacheClass = self::NULL_CACHE; |
|
111 | + } else { |
|
112 | + throw new \OC\HintException(strtr($missingCacheMessage, [ |
|
113 | + '{class}' => $distributedCacheClass, '{use}' => 'distributed' |
|
114 | + ]), $missingCacheHint); |
|
115 | + } |
|
116 | + } |
|
117 | + if (!($lockingCacheClass && class_exists($distributedCacheClass) && $lockingCacheClass::isAvailable())) { |
|
118 | + // don't fallback since the fallback might not be suitable for storing lock |
|
119 | + $lockingCacheClass = self::NULL_CACHE; |
|
120 | + } |
|
121 | + |
|
122 | + $this->localCacheClass = $localCacheClass; |
|
123 | + $this->distributedCacheClass = $distributedCacheClass; |
|
124 | + $this->lockingCacheClass = $lockingCacheClass; |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * create a cache instance for storing locks |
|
129 | + * |
|
130 | + * @param string $prefix |
|
131 | + * @return IMemcache |
|
132 | + */ |
|
133 | + public function createLocking(string $prefix = ''): IMemcache { |
|
134 | + return new $this->lockingCacheClass($this->globalPrefix . '/' . $prefix); |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * create a distributed cache instance |
|
139 | + * |
|
140 | + * @param string $prefix |
|
141 | + * @return ICache |
|
142 | + */ |
|
143 | + public function createDistributed(string $prefix = ''): ICache { |
|
144 | + return new $this->distributedCacheClass($this->globalPrefix . '/' . $prefix); |
|
145 | + } |
|
146 | + |
|
147 | + /** |
|
148 | + * create a local cache instance |
|
149 | + * |
|
150 | + * @param string $prefix |
|
151 | + * @return ICache |
|
152 | + */ |
|
153 | + public function createLocal(string $prefix = ''): ICache { |
|
154 | + return new $this->localCacheClass($this->globalPrefix . '/' . $prefix); |
|
155 | + } |
|
156 | + |
|
157 | + /** |
|
158 | + * @see \OC\Memcache\Factory::createDistributed() |
|
159 | + * @param string $prefix |
|
160 | + * @return ICache |
|
161 | + * @deprecated 13.0.0 Use either createLocking, createDistributed or createLocal |
|
162 | + */ |
|
163 | + public function create(string $prefix = ''): ICache { |
|
164 | + return $this->createDistributed($prefix); |
|
165 | + } |
|
166 | + |
|
167 | + /** |
|
168 | + * check memcache availability |
|
169 | + * |
|
170 | + * @return bool |
|
171 | + */ |
|
172 | + public function isAvailable(): bool { |
|
173 | + return ($this->distributedCacheClass !== self::NULL_CACHE); |
|
174 | + } |
|
175 | + |
|
176 | + /** |
|
177 | + * @see \OC\Memcache\Factory::createLocal() |
|
178 | + * @param string $prefix |
|
179 | + * @return ICache |
|
180 | + */ |
|
181 | + public function createLowLatency(string $prefix = ''): ICache { |
|
182 | + return $this->createLocal($prefix); |
|
183 | + } |
|
184 | + |
|
185 | + /** |
|
186 | + * Check if a local memory cache backend is available |
|
187 | + * |
|
188 | + * @return bool |
|
189 | + */ |
|
190 | + public function isLocalCacheAvailable(): bool { |
|
191 | + return ($this->localCacheClass !== self::NULL_CACHE); |
|
192 | + } |
|
193 | 193 | } |