@@ -29,10 +29,10 @@ |
||
29 | 29 | */ |
30 | 30 | interface IProvider { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 12.0 |
|
34 | - * @param IEntry $entry |
|
35 | - * @return void |
|
36 | - */ |
|
37 | - public function process(IEntry $entry); |
|
32 | + /** |
|
33 | + * @since 12.0 |
|
34 | + * @param IEntry $entry |
|
35 | + * @return void |
|
36 | + */ |
|
37 | + public function process(IEntry $entry); |
|
38 | 38 | } |
@@ -32,10 +32,10 @@ |
||
32 | 32 | */ |
33 | 33 | interface IShareHelper { |
34 | 34 | |
35 | - /** |
|
36 | - * @param Node $node |
|
37 | - * @return array [ users => [Mapping $uid => $pathForUser], remotes => [Mapping $cloudId => $pathToMountRoot]] |
|
38 | - * @since 12 |
|
39 | - */ |
|
40 | - public function getPathsForAccessList(Node $node); |
|
35 | + /** |
|
36 | + * @param Node $node |
|
37 | + * @return array [ users => [Mapping $uid => $pathForUser], remotes => [Mapping $cloudId => $pathToMountRoot]] |
|
38 | + * @since 12 |
|
39 | + */ |
|
40 | + public function getPathsForAccessList(Node $node); |
|
41 | 41 | } |
@@ -31,187 +31,187 @@ |
||
31 | 31 | |
32 | 32 | class ShareHelper implements IShareHelper { |
33 | 33 | |
34 | - /** @var IManager */ |
|
35 | - private $shareManager; |
|
36 | - |
|
37 | - public function __construct(IManager $shareManager) { |
|
38 | - $this->shareManager = $shareManager; |
|
39 | - } |
|
40 | - |
|
41 | - /** |
|
42 | - * @param Node $node |
|
43 | - * @return array [ users => [Mapping $uid => $pathForUser], remotes => [Mapping $cloudId => $pathToMountRoot]] |
|
44 | - */ |
|
45 | - public function getPathsForAccessList(Node $node) { |
|
46 | - $result = [ |
|
47 | - 'users' => [], |
|
48 | - 'remotes' => [], |
|
49 | - ]; |
|
50 | - |
|
51 | - $accessList = $this->shareManager->getAccessList($node, true, true); |
|
52 | - if (!empty($accessList['users'])) { |
|
53 | - $result['users'] = $this->getPathsForUsers($node, $accessList['users']); |
|
54 | - } |
|
55 | - if (!empty($accessList['remote'])) { |
|
56 | - $result['remotes'] = $this->getPathsForRemotes($node, $accessList['remote']); |
|
57 | - } |
|
58 | - |
|
59 | - return $result; |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Sample: |
|
64 | - * $users = [ |
|
65 | - * 'test1' => ['node_id' => 16, 'node_path' => '/foo'], |
|
66 | - * 'test2' => ['node_id' => 23, 'node_path' => '/bar'], |
|
67 | - * 'test3' => ['node_id' => 42, 'node_path' => '/cat'], |
|
68 | - * 'test4' => ['node_id' => 48, 'node_path' => '/dog'], |
|
69 | - * ]; |
|
70 | - * |
|
71 | - * Node tree: |
|
72 | - * - SixTeen is the parent of TwentyThree |
|
73 | - * - TwentyThree is the parent of FortyTwo |
|
74 | - * - FortyEight does not exist |
|
75 | - * |
|
76 | - * $return = [ |
|
77 | - * 'test1' => '/foo/TwentyThree/FortyTwo', |
|
78 | - * 'test2' => '/bar/FortyTwo', |
|
79 | - * 'test3' => '/cat', |
|
80 | - * ], |
|
81 | - * |
|
82 | - * @param Node $node |
|
83 | - * @param array[] $users |
|
84 | - * @return array |
|
85 | - */ |
|
86 | - protected function getPathsForUsers(Node $node, array $users) { |
|
87 | - /** @var array[] $byId */ |
|
88 | - $byId = []; |
|
89 | - /** @var array[] $results */ |
|
90 | - $results = []; |
|
91 | - |
|
92 | - foreach ($users as $uid => $info) { |
|
93 | - if (!isset($byId[$info['node_id']])) { |
|
94 | - $byId[$info['node_id']] = []; |
|
95 | - } |
|
96 | - $byId[$info['node_id']][$uid] = $info['node_path']; |
|
97 | - } |
|
98 | - |
|
99 | - try { |
|
100 | - if (isset($byId[$node->getId()])) { |
|
101 | - foreach ($byId[$node->getId()] as $uid => $path) { |
|
102 | - $results[$uid] = $path; |
|
103 | - } |
|
104 | - unset($byId[$node->getId()]); |
|
105 | - } |
|
106 | - } catch (NotFoundException $e) { |
|
107 | - return $results; |
|
108 | - } catch (InvalidPathException $e) { |
|
109 | - return $results; |
|
110 | - } |
|
111 | - |
|
112 | - if (empty($byId)) { |
|
113 | - return $results; |
|
114 | - } |
|
115 | - |
|
116 | - $item = $node; |
|
117 | - $appendix = '/' . $node->getName(); |
|
118 | - while (!empty($byId)) { |
|
119 | - try { |
|
120 | - /** @var Node $item */ |
|
121 | - $item = $item->getParent(); |
|
122 | - |
|
123 | - if (!empty($byId[$item->getId()])) { |
|
124 | - foreach ($byId[$item->getId()] as $uid => $path) { |
|
125 | - $results[$uid] = $path . $appendix; |
|
126 | - } |
|
127 | - unset($byId[$item->getId()]); |
|
128 | - } |
|
129 | - |
|
130 | - $appendix = '/' . $item->getName() . $appendix; |
|
131 | - } catch (NotFoundException $e) { |
|
132 | - return $results; |
|
133 | - } catch (InvalidPathException $e) { |
|
134 | - return $results; |
|
135 | - } catch (NotPermittedException $e) { |
|
136 | - return $results; |
|
137 | - } |
|
138 | - } |
|
139 | - |
|
140 | - return $results; |
|
141 | - } |
|
142 | - |
|
143 | - /** |
|
144 | - * Sample: |
|
145 | - * $remotes = [ |
|
146 | - * 'test1' => ['node_id' => 16, 'token' => 't1'], |
|
147 | - * 'test2' => ['node_id' => 23, 'token' => 't2'], |
|
148 | - * 'test3' => ['node_id' => 42, 'token' => 't3'], |
|
149 | - * 'test4' => ['node_id' => 48, 'token' => 't4'], |
|
150 | - * ]; |
|
151 | - * |
|
152 | - * Node tree: |
|
153 | - * - SixTeen is the parent of TwentyThree |
|
154 | - * - TwentyThree is the parent of FortyTwo |
|
155 | - * - FortyEight does not exist |
|
156 | - * |
|
157 | - * $return = [ |
|
158 | - * 'test1' => ['token' => 't1', 'node_path' => '/SixTeen'], |
|
159 | - * 'test2' => ['token' => 't2', 'node_path' => '/SixTeen/TwentyThree'], |
|
160 | - * 'test3' => ['token' => 't3', 'node_path' => '/SixTeen/TwentyThree/FortyTwo'], |
|
161 | - * ], |
|
162 | - * |
|
163 | - * @param Node $node |
|
164 | - * @param array[] $remotes |
|
165 | - * @return array |
|
166 | - */ |
|
167 | - protected function getPathsForRemotes(Node $node, array $remotes) { |
|
168 | - /** @var array[] $byId */ |
|
169 | - $byId = []; |
|
170 | - /** @var array[] $results */ |
|
171 | - $results = []; |
|
172 | - |
|
173 | - foreach ($remotes as $cloudId => $info) { |
|
174 | - if (!isset($byId[$info['node_id']])) { |
|
175 | - $byId[$info['node_id']] = []; |
|
176 | - } |
|
177 | - $byId[$info['node_id']][$cloudId] = $info['token']; |
|
178 | - } |
|
179 | - |
|
180 | - $item = $node; |
|
181 | - while (!empty($byId)) { |
|
182 | - try { |
|
183 | - if (!empty($byId[$item->getId()])) { |
|
184 | - $path = $this->getMountedPath($item); |
|
185 | - foreach ($byId[$item->getId()] as $uid => $token) { |
|
186 | - $results[$uid] = [ |
|
187 | - 'node_path' => $path, |
|
188 | - 'token' => $token, |
|
189 | - ]; |
|
190 | - } |
|
191 | - unset($byId[$item->getId()]); |
|
192 | - } |
|
193 | - |
|
194 | - /** @var Node $item */ |
|
195 | - $item = $item->getParent(); |
|
196 | - } catch (NotFoundException $e) { |
|
197 | - return $results; |
|
198 | - } catch (InvalidPathException $e) { |
|
199 | - return $results; |
|
200 | - } catch (NotPermittedException $e) { |
|
201 | - return $results; |
|
202 | - } |
|
203 | - } |
|
204 | - |
|
205 | - return $results; |
|
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * @param Node $node |
|
210 | - * @return string |
|
211 | - */ |
|
212 | - protected function getMountedPath(Node $node) { |
|
213 | - $path = $node->getPath(); |
|
214 | - $sections = explode('/', $path, 4); |
|
215 | - return '/' . $sections[3]; |
|
216 | - } |
|
34 | + /** @var IManager */ |
|
35 | + private $shareManager; |
|
36 | + |
|
37 | + public function __construct(IManager $shareManager) { |
|
38 | + $this->shareManager = $shareManager; |
|
39 | + } |
|
40 | + |
|
41 | + /** |
|
42 | + * @param Node $node |
|
43 | + * @return array [ users => [Mapping $uid => $pathForUser], remotes => [Mapping $cloudId => $pathToMountRoot]] |
|
44 | + */ |
|
45 | + public function getPathsForAccessList(Node $node) { |
|
46 | + $result = [ |
|
47 | + 'users' => [], |
|
48 | + 'remotes' => [], |
|
49 | + ]; |
|
50 | + |
|
51 | + $accessList = $this->shareManager->getAccessList($node, true, true); |
|
52 | + if (!empty($accessList['users'])) { |
|
53 | + $result['users'] = $this->getPathsForUsers($node, $accessList['users']); |
|
54 | + } |
|
55 | + if (!empty($accessList['remote'])) { |
|
56 | + $result['remotes'] = $this->getPathsForRemotes($node, $accessList['remote']); |
|
57 | + } |
|
58 | + |
|
59 | + return $result; |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Sample: |
|
64 | + * $users = [ |
|
65 | + * 'test1' => ['node_id' => 16, 'node_path' => '/foo'], |
|
66 | + * 'test2' => ['node_id' => 23, 'node_path' => '/bar'], |
|
67 | + * 'test3' => ['node_id' => 42, 'node_path' => '/cat'], |
|
68 | + * 'test4' => ['node_id' => 48, 'node_path' => '/dog'], |
|
69 | + * ]; |
|
70 | + * |
|
71 | + * Node tree: |
|
72 | + * - SixTeen is the parent of TwentyThree |
|
73 | + * - TwentyThree is the parent of FortyTwo |
|
74 | + * - FortyEight does not exist |
|
75 | + * |
|
76 | + * $return = [ |
|
77 | + * 'test1' => '/foo/TwentyThree/FortyTwo', |
|
78 | + * 'test2' => '/bar/FortyTwo', |
|
79 | + * 'test3' => '/cat', |
|
80 | + * ], |
|
81 | + * |
|
82 | + * @param Node $node |
|
83 | + * @param array[] $users |
|
84 | + * @return array |
|
85 | + */ |
|
86 | + protected function getPathsForUsers(Node $node, array $users) { |
|
87 | + /** @var array[] $byId */ |
|
88 | + $byId = []; |
|
89 | + /** @var array[] $results */ |
|
90 | + $results = []; |
|
91 | + |
|
92 | + foreach ($users as $uid => $info) { |
|
93 | + if (!isset($byId[$info['node_id']])) { |
|
94 | + $byId[$info['node_id']] = []; |
|
95 | + } |
|
96 | + $byId[$info['node_id']][$uid] = $info['node_path']; |
|
97 | + } |
|
98 | + |
|
99 | + try { |
|
100 | + if (isset($byId[$node->getId()])) { |
|
101 | + foreach ($byId[$node->getId()] as $uid => $path) { |
|
102 | + $results[$uid] = $path; |
|
103 | + } |
|
104 | + unset($byId[$node->getId()]); |
|
105 | + } |
|
106 | + } catch (NotFoundException $e) { |
|
107 | + return $results; |
|
108 | + } catch (InvalidPathException $e) { |
|
109 | + return $results; |
|
110 | + } |
|
111 | + |
|
112 | + if (empty($byId)) { |
|
113 | + return $results; |
|
114 | + } |
|
115 | + |
|
116 | + $item = $node; |
|
117 | + $appendix = '/' . $node->getName(); |
|
118 | + while (!empty($byId)) { |
|
119 | + try { |
|
120 | + /** @var Node $item */ |
|
121 | + $item = $item->getParent(); |
|
122 | + |
|
123 | + if (!empty($byId[$item->getId()])) { |
|
124 | + foreach ($byId[$item->getId()] as $uid => $path) { |
|
125 | + $results[$uid] = $path . $appendix; |
|
126 | + } |
|
127 | + unset($byId[$item->getId()]); |
|
128 | + } |
|
129 | + |
|
130 | + $appendix = '/' . $item->getName() . $appendix; |
|
131 | + } catch (NotFoundException $e) { |
|
132 | + return $results; |
|
133 | + } catch (InvalidPathException $e) { |
|
134 | + return $results; |
|
135 | + } catch (NotPermittedException $e) { |
|
136 | + return $results; |
|
137 | + } |
|
138 | + } |
|
139 | + |
|
140 | + return $results; |
|
141 | + } |
|
142 | + |
|
143 | + /** |
|
144 | + * Sample: |
|
145 | + * $remotes = [ |
|
146 | + * 'test1' => ['node_id' => 16, 'token' => 't1'], |
|
147 | + * 'test2' => ['node_id' => 23, 'token' => 't2'], |
|
148 | + * 'test3' => ['node_id' => 42, 'token' => 't3'], |
|
149 | + * 'test4' => ['node_id' => 48, 'token' => 't4'], |
|
150 | + * ]; |
|
151 | + * |
|
152 | + * Node tree: |
|
153 | + * - SixTeen is the parent of TwentyThree |
|
154 | + * - TwentyThree is the parent of FortyTwo |
|
155 | + * - FortyEight does not exist |
|
156 | + * |
|
157 | + * $return = [ |
|
158 | + * 'test1' => ['token' => 't1', 'node_path' => '/SixTeen'], |
|
159 | + * 'test2' => ['token' => 't2', 'node_path' => '/SixTeen/TwentyThree'], |
|
160 | + * 'test3' => ['token' => 't3', 'node_path' => '/SixTeen/TwentyThree/FortyTwo'], |
|
161 | + * ], |
|
162 | + * |
|
163 | + * @param Node $node |
|
164 | + * @param array[] $remotes |
|
165 | + * @return array |
|
166 | + */ |
|
167 | + protected function getPathsForRemotes(Node $node, array $remotes) { |
|
168 | + /** @var array[] $byId */ |
|
169 | + $byId = []; |
|
170 | + /** @var array[] $results */ |
|
171 | + $results = []; |
|
172 | + |
|
173 | + foreach ($remotes as $cloudId => $info) { |
|
174 | + if (!isset($byId[$info['node_id']])) { |
|
175 | + $byId[$info['node_id']] = []; |
|
176 | + } |
|
177 | + $byId[$info['node_id']][$cloudId] = $info['token']; |
|
178 | + } |
|
179 | + |
|
180 | + $item = $node; |
|
181 | + while (!empty($byId)) { |
|
182 | + try { |
|
183 | + if (!empty($byId[$item->getId()])) { |
|
184 | + $path = $this->getMountedPath($item); |
|
185 | + foreach ($byId[$item->getId()] as $uid => $token) { |
|
186 | + $results[$uid] = [ |
|
187 | + 'node_path' => $path, |
|
188 | + 'token' => $token, |
|
189 | + ]; |
|
190 | + } |
|
191 | + unset($byId[$item->getId()]); |
|
192 | + } |
|
193 | + |
|
194 | + /** @var Node $item */ |
|
195 | + $item = $item->getParent(); |
|
196 | + } catch (NotFoundException $e) { |
|
197 | + return $results; |
|
198 | + } catch (InvalidPathException $e) { |
|
199 | + return $results; |
|
200 | + } catch (NotPermittedException $e) { |
|
201 | + return $results; |
|
202 | + } |
|
203 | + } |
|
204 | + |
|
205 | + return $results; |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * @param Node $node |
|
210 | + * @return string |
|
211 | + */ |
|
212 | + protected function getMountedPath(Node $node) { |
|
213 | + $path = $node->getPath(); |
|
214 | + $sections = explode('/', $path, 4); |
|
215 | + return '/' . $sections[3]; |
|
216 | + } |
|
217 | 217 | } |
@@ -29,19 +29,19 @@ |
||
29 | 29 | */ |
30 | 30 | class FilesystemHelper { |
31 | 31 | |
32 | - /** |
|
33 | - * @brief states whether the filesystem was loaded |
|
34 | - * @return bool |
|
35 | - */ |
|
36 | - public function isLoaded() { |
|
37 | - return \OC\Files\Filesystem::$loaded; |
|
38 | - } |
|
32 | + /** |
|
33 | + * @brief states whether the filesystem was loaded |
|
34 | + * @return bool |
|
35 | + */ |
|
36 | + public function isLoaded() { |
|
37 | + return \OC\Files\Filesystem::$loaded; |
|
38 | + } |
|
39 | 39 | |
40 | - /** |
|
41 | - * @brief initializes the filesystem for the given user |
|
42 | - * @param string $uid the Nextcloud username of the user |
|
43 | - */ |
|
44 | - public function setup($uid) { |
|
45 | - \OC_Util::setupFS($uid); |
|
46 | - } |
|
40 | + /** |
|
41 | + * @brief initializes the filesystem for the given user |
|
42 | + * @param string $uid the Nextcloud username of the user |
|
43 | + */ |
|
44 | + public function setup($uid) { |
|
45 | + \OC_Util::setupFS($uid); |
|
46 | + } |
|
47 | 47 | } |
@@ -25,28 +25,28 @@ |
||
25 | 25 | use OCP\AppFramework\Http\JSONResponse; |
26 | 26 | |
27 | 27 | class RateLimitTestController extends Controller { |
28 | - /** |
|
29 | - * @PublicPage |
|
30 | - * @NoCSRFRequired |
|
31 | - * |
|
32 | - * @UserRateThrottle(limit=5, period=100) |
|
33 | - * @AnonRateThrottle(limit=1, period=100) |
|
34 | - * |
|
35 | - * @return JSONResponse |
|
36 | - */ |
|
37 | - public function userAndAnonProtected() { |
|
38 | - return new JSONResponse(); |
|
39 | - } |
|
28 | + /** |
|
29 | + * @PublicPage |
|
30 | + * @NoCSRFRequired |
|
31 | + * |
|
32 | + * @UserRateThrottle(limit=5, period=100) |
|
33 | + * @AnonRateThrottle(limit=1, period=100) |
|
34 | + * |
|
35 | + * @return JSONResponse |
|
36 | + */ |
|
37 | + public function userAndAnonProtected() { |
|
38 | + return new JSONResponse(); |
|
39 | + } |
|
40 | 40 | |
41 | - /** |
|
42 | - * @PublicPage |
|
43 | - * @NoCSRFRequired |
|
44 | - * |
|
45 | - * @AnonRateThrottle(limit=1, period=10) |
|
46 | - * |
|
47 | - * @return JSONResponse |
|
48 | - */ |
|
49 | - public function onlyAnonProtected() { |
|
50 | - return new JSONResponse(); |
|
51 | - } |
|
41 | + /** |
|
42 | + * @PublicPage |
|
43 | + * @NoCSRFRequired |
|
44 | + * |
|
45 | + * @AnonRateThrottle(limit=1, period=10) |
|
46 | + * |
|
47 | + * @return JSONResponse |
|
48 | + */ |
|
49 | + public function onlyAnonProtected() { |
|
50 | + return new JSONResponse(); |
|
51 | + } |
|
52 | 52 | } |
@@ -25,7 +25,7 @@ |
||
25 | 25 | use OCP\AppFramework\Http; |
26 | 26 | |
27 | 27 | class RateLimitExceededException extends SecurityException { |
28 | - public function __construct() { |
|
29 | - parent::__construct('Rate limit exceeded', Http::STATUS_TOO_MANY_REQUESTS); |
|
30 | - } |
|
28 | + public function __construct() { |
|
29 | + parent::__construct('Rate limit exceeded', Http::STATUS_TOO_MANY_REQUESTS); |
|
30 | + } |
|
31 | 31 | } |
@@ -35,55 +35,55 @@ |
||
35 | 35 | * @since 8.0.0 |
36 | 36 | */ |
37 | 37 | interface IEventLogger { |
38 | - /** |
|
39 | - * Mark the start of an event setting its ID $id and providing event description $description. |
|
40 | - * |
|
41 | - * @param string $id |
|
42 | - * @param string $description |
|
43 | - * @since 8.0.0 |
|
44 | - */ |
|
45 | - public function start($id, $description); |
|
38 | + /** |
|
39 | + * Mark the start of an event setting its ID $id and providing event description $description. |
|
40 | + * |
|
41 | + * @param string $id |
|
42 | + * @param string $description |
|
43 | + * @since 8.0.0 |
|
44 | + */ |
|
45 | + public function start($id, $description); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Mark the end of an event with specific ID $id, marked by start() method. |
|
49 | - * Ending event should store \OCP\Diagnostics\IEvent to |
|
50 | - * be returned with getEvents() method. |
|
51 | - * |
|
52 | - * @param string $id |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function end($id); |
|
47 | + /** |
|
48 | + * Mark the end of an event with specific ID $id, marked by start() method. |
|
49 | + * Ending event should store \OCP\Diagnostics\IEvent to |
|
50 | + * be returned with getEvents() method. |
|
51 | + * |
|
52 | + * @param string $id |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function end($id); |
|
56 | 56 | |
57 | - /** |
|
58 | - * Mark the start and the end of an event with specific ID $id and description $description, |
|
59 | - * explicitly marking start and end of the event, represented by $start and $end timestamps. |
|
60 | - * Logging event should store \OCP\Diagnostics\IEvent to |
|
61 | - * be returned with getEvents() method. |
|
62 | - * |
|
63 | - * @param string $id |
|
64 | - * @param string $description |
|
65 | - * @param float $start |
|
66 | - * @param float $end |
|
67 | - * @since 8.0.0 |
|
68 | - */ |
|
69 | - public function log($id, $description, $start, $end); |
|
57 | + /** |
|
58 | + * Mark the start and the end of an event with specific ID $id and description $description, |
|
59 | + * explicitly marking start and end of the event, represented by $start and $end timestamps. |
|
60 | + * Logging event should store \OCP\Diagnostics\IEvent to |
|
61 | + * be returned with getEvents() method. |
|
62 | + * |
|
63 | + * @param string $id |
|
64 | + * @param string $description |
|
65 | + * @param float $start |
|
66 | + * @param float $end |
|
67 | + * @since 8.0.0 |
|
68 | + */ |
|
69 | + public function log($id, $description, $start, $end); |
|
70 | 70 | |
71 | - /** |
|
72 | - * This method should return all \OCP\Diagnostics\IEvent objects stored using |
|
73 | - * start()/end() or log() methods |
|
74 | - * |
|
75 | - * @return \OCP\Diagnostics\IEvent[] |
|
76 | - * @since 8.0.0 |
|
77 | - */ |
|
78 | - public function getEvents(); |
|
71 | + /** |
|
72 | + * This method should return all \OCP\Diagnostics\IEvent objects stored using |
|
73 | + * start()/end() or log() methods |
|
74 | + * |
|
75 | + * @return \OCP\Diagnostics\IEvent[] |
|
76 | + * @since 8.0.0 |
|
77 | + */ |
|
78 | + public function getEvents(); |
|
79 | 79 | |
80 | - /** |
|
81 | - * Activate the module for the duration of the request. Deactivated module |
|
82 | - * does not create and store \OCP\Diagnostics\IEvent objects. |
|
83 | - * Only activated module should create and store objects to be |
|
84 | - * returned with getEvents() call. |
|
85 | - * |
|
86 | - * @since 12.0.0 |
|
87 | - */ |
|
88 | - public function activate(); |
|
80 | + /** |
|
81 | + * Activate the module for the duration of the request. Deactivated module |
|
82 | + * does not create and store \OCP\Diagnostics\IEvent objects. |
|
83 | + * Only activated module should create and store objects to be |
|
84 | + * returned with getEvents() call. |
|
85 | + * |
|
86 | + * @since 12.0.0 |
|
87 | + */ |
|
88 | + public function activate(); |
|
89 | 89 | } |
@@ -30,38 +30,38 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IQuery { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getSql(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getSql(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return array |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getParams(); |
|
39 | + /** |
|
40 | + * @return array |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getParams(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return float |
|
47 | - * @since 8.0.0 |
|
48 | - */ |
|
49 | - public function getDuration(); |
|
45 | + /** |
|
46 | + * @return float |
|
47 | + * @since 8.0.0 |
|
48 | + */ |
|
49 | + public function getDuration(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return float |
|
53 | - * @since 11.0.0 |
|
54 | - */ |
|
55 | - public function getStartTime(); |
|
51 | + /** |
|
52 | + * @return float |
|
53 | + * @since 11.0.0 |
|
54 | + */ |
|
55 | + public function getStartTime(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return array |
|
59 | - * @since 11.0.0 |
|
60 | - */ |
|
61 | - public function getStacktrace(); |
|
62 | - /** |
|
63 | - * @return array |
|
64 | - * @since 12.0.0 |
|
65 | - */ |
|
66 | - public function getStart(); |
|
57 | + /** |
|
58 | + * @return array |
|
59 | + * @since 11.0.0 |
|
60 | + */ |
|
61 | + public function getStacktrace(); |
|
62 | + /** |
|
63 | + * @return array |
|
64 | + * @since 12.0.0 |
|
65 | + */ |
|
66 | + public function getStart(); |
|
67 | 67 | } |
@@ -26,65 +26,65 @@ |
||
26 | 26 | use OCP\Diagnostics\IQuery; |
27 | 27 | |
28 | 28 | class Query implements IQuery { |
29 | - private $sql; |
|
29 | + private $sql; |
|
30 | 30 | |
31 | - private $params; |
|
31 | + private $params; |
|
32 | 32 | |
33 | - private $start; |
|
33 | + private $start; |
|
34 | 34 | |
35 | - private $end; |
|
35 | + private $end; |
|
36 | 36 | |
37 | - private $stack; |
|
37 | + private $stack; |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param string $sql |
|
41 | - * @param array $params |
|
42 | - * @param int $start |
|
43 | - */ |
|
44 | - public function __construct($sql, $params, $start, array $stack) { |
|
45 | - $this->sql = $sql; |
|
46 | - $this->params = $params; |
|
47 | - $this->start = $start; |
|
48 | - $this->stack = $stack; |
|
49 | - } |
|
39 | + /** |
|
40 | + * @param string $sql |
|
41 | + * @param array $params |
|
42 | + * @param int $start |
|
43 | + */ |
|
44 | + public function __construct($sql, $params, $start, array $stack) { |
|
45 | + $this->sql = $sql; |
|
46 | + $this->params = $params; |
|
47 | + $this->start = $start; |
|
48 | + $this->stack = $stack; |
|
49 | + } |
|
50 | 50 | |
51 | - public function end($time) { |
|
52 | - $this->end = $time; |
|
53 | - } |
|
51 | + public function end($time) { |
|
52 | + $this->end = $time; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * @return array |
|
57 | - */ |
|
58 | - public function getParams() { |
|
59 | - return $this->params; |
|
60 | - } |
|
55 | + /** |
|
56 | + * @return array |
|
57 | + */ |
|
58 | + public function getParams() { |
|
59 | + return $this->params; |
|
60 | + } |
|
61 | 61 | |
62 | - /** |
|
63 | - * @return string |
|
64 | - */ |
|
65 | - public function getSql() { |
|
66 | - return $this->sql; |
|
67 | - } |
|
62 | + /** |
|
63 | + * @return string |
|
64 | + */ |
|
65 | + public function getSql() { |
|
66 | + return $this->sql; |
|
67 | + } |
|
68 | 68 | |
69 | - /** |
|
70 | - * @return float |
|
71 | - */ |
|
72 | - public function getStart() { |
|
73 | - return $this->start; |
|
74 | - } |
|
69 | + /** |
|
70 | + * @return float |
|
71 | + */ |
|
72 | + public function getStart() { |
|
73 | + return $this->start; |
|
74 | + } |
|
75 | 75 | |
76 | - /** |
|
77 | - * @return float |
|
78 | - */ |
|
79 | - public function getDuration() { |
|
80 | - return $this->end - $this->start; |
|
81 | - } |
|
76 | + /** |
|
77 | + * @return float |
|
78 | + */ |
|
79 | + public function getDuration() { |
|
80 | + return $this->end - $this->start; |
|
81 | + } |
|
82 | 82 | |
83 | - public function getStartTime() { |
|
84 | - return $this->start; |
|
85 | - } |
|
83 | + public function getStartTime() { |
|
84 | + return $this->start; |
|
85 | + } |
|
86 | 86 | |
87 | - public function getStacktrace() { |
|
88 | - return $this->stack; |
|
89 | - } |
|
87 | + public function getStacktrace() { |
|
88 | + return $this->stack; |
|
89 | + } |
|
90 | 90 | } |