@@ -27,173 +27,173 @@ |
||
27 | 27 | |
28 | 28 | class Expiration { |
29 | 29 | |
30 | - // how long do we keep files a version if no other value is defined in the config file (unit: days) |
|
31 | - const NO_OBLIGATION = -1; |
|
32 | - |
|
33 | - /** @var ITimeFactory */ |
|
34 | - private $timeFactory; |
|
35 | - |
|
36 | - /** @var string */ |
|
37 | - private $retentionObligation; |
|
38 | - |
|
39 | - /** @var int */ |
|
40 | - private $minAge; |
|
41 | - |
|
42 | - /** @var int */ |
|
43 | - private $maxAge; |
|
44 | - |
|
45 | - /** @var bool */ |
|
46 | - private $canPurgeToSaveSpace; |
|
47 | - |
|
48 | - public function __construct(IConfig $config,ITimeFactory $timeFactory){ |
|
49 | - $this->timeFactory = $timeFactory; |
|
50 | - $this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto'); |
|
51 | - |
|
52 | - if ($this->retentionObligation !== 'disabled') { |
|
53 | - $this->parseRetentionObligation(); |
|
54 | - } |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * Is versions expiration enabled |
|
59 | - * @return bool |
|
60 | - */ |
|
61 | - public function isEnabled(){ |
|
62 | - return $this->retentionObligation !== 'disabled'; |
|
63 | - } |
|
64 | - |
|
65 | - /** |
|
66 | - * Is default expiration active |
|
67 | - */ |
|
68 | - public function shouldAutoExpire(){ |
|
69 | - return $this->minAge === self::NO_OBLIGATION |
|
70 | - || $this->maxAge === self::NO_OBLIGATION; |
|
71 | - } |
|
72 | - |
|
73 | - /** |
|
74 | - * Check if given timestamp in expiration range |
|
75 | - * @param int $timestamp |
|
76 | - * @param bool $quotaExceeded |
|
77 | - * @return bool |
|
78 | - */ |
|
79 | - public function isExpired($timestamp, $quotaExceeded = false){ |
|
80 | - // No expiration if disabled |
|
81 | - if (!$this->isEnabled()) { |
|
82 | - return false; |
|
83 | - } |
|
84 | - |
|
85 | - // Purge to save space (if allowed) |
|
86 | - if ($quotaExceeded && $this->canPurgeToSaveSpace) { |
|
87 | - return true; |
|
88 | - } |
|
89 | - |
|
90 | - $time = $this->timeFactory->getTime(); |
|
91 | - // Never expire dates in future e.g. misconfiguration or negative time |
|
92 | - // adjustment |
|
93 | - if ($time<$timestamp) { |
|
94 | - return false; |
|
95 | - } |
|
96 | - |
|
97 | - // Purge as too old |
|
98 | - if ($this->maxAge !== self::NO_OBLIGATION) { |
|
99 | - $maxTimestamp = $time - ($this->maxAge * 86400); |
|
100 | - $isOlderThanMax = $timestamp < $maxTimestamp; |
|
101 | - } else { |
|
102 | - $isOlderThanMax = false; |
|
103 | - } |
|
104 | - |
|
105 | - if ($this->minAge !== self::NO_OBLIGATION) { |
|
106 | - // older than Min obligation and we are running out of quota? |
|
107 | - $minTimestamp = $time - ($this->minAge * 86400); |
|
108 | - $isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded; |
|
109 | - } else { |
|
110 | - $isMinReached = false; |
|
111 | - } |
|
112 | - |
|
113 | - return $isOlderThanMax || $isMinReached; |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Get maximal retention obligation as a timestamp |
|
118 | - * @return int |
|
119 | - */ |
|
120 | - public function getMaxAgeAsTimestamp(){ |
|
121 | - $maxAge = false; |
|
122 | - if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) { |
|
123 | - $time = $this->timeFactory->getTime(); |
|
124 | - $maxAge = $time - ($this->maxAge * 86400); |
|
125 | - } |
|
126 | - return $maxAge; |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Read versions_retention_obligation, validate it |
|
131 | - * and set private members accordingly |
|
132 | - */ |
|
133 | - private function parseRetentionObligation(){ |
|
134 | - $splitValues = explode(',', $this->retentionObligation); |
|
135 | - if (!isset($splitValues[0])) { |
|
136 | - $minValue = 'auto'; |
|
137 | - } else { |
|
138 | - $minValue = trim($splitValues[0]); |
|
139 | - } |
|
140 | - |
|
141 | - if (!isset($splitValues[1])) { |
|
142 | - $maxValue = 'auto'; |
|
143 | - } else { |
|
144 | - $maxValue = trim($splitValues[1]); |
|
145 | - } |
|
146 | - |
|
147 | - $isValid = true; |
|
148 | - // Validate |
|
149 | - if (!ctype_digit($minValue) && $minValue !== 'auto') { |
|
150 | - $isValid = false; |
|
151 | - \OC::$server->getLogger()->warning( |
|
152 | - $minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.', |
|
153 | - ['app'=>'files_versions'] |
|
154 | - ); |
|
155 | - } |
|
156 | - |
|
157 | - if (!ctype_digit($maxValue) && $maxValue !== 'auto') { |
|
158 | - $isValid = false; |
|
159 | - \OC::$server->getLogger()->warning( |
|
160 | - $maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.', |
|
161 | - ['app'=>'files_versions'] |
|
162 | - ); |
|
163 | - } |
|
164 | - |
|
165 | - if (!$isValid){ |
|
166 | - $minValue = 'auto'; |
|
167 | - $maxValue = 'auto'; |
|
168 | - } |
|
169 | - |
|
170 | - |
|
171 | - if ($minValue === 'auto' && $maxValue === 'auto') { |
|
172 | - // Default: Delete anytime if space needed |
|
173 | - $this->minAge = self::NO_OBLIGATION; |
|
174 | - $this->maxAge = self::NO_OBLIGATION; |
|
175 | - $this->canPurgeToSaveSpace = true; |
|
176 | - } elseif ($minValue !== 'auto' && $maxValue === 'auto') { |
|
177 | - // Keep for X days but delete anytime if space needed |
|
178 | - $this->minAge = intval($minValue); |
|
179 | - $this->maxAge = self::NO_OBLIGATION; |
|
180 | - $this->canPurgeToSaveSpace = true; |
|
181 | - } elseif ($minValue === 'auto' && $maxValue !== 'auto') { |
|
182 | - // Delete anytime if space needed, Delete all older than max automatically |
|
183 | - $this->minAge = self::NO_OBLIGATION; |
|
184 | - $this->maxAge = intval($maxValue); |
|
185 | - $this->canPurgeToSaveSpace = true; |
|
186 | - } elseif ($minValue !== 'auto' && $maxValue !== 'auto') { |
|
187 | - // Delete all older than max OR older than min if space needed |
|
188 | - |
|
189 | - // Max < Min as per https://github.com/owncloud/core/issues/16301 |
|
190 | - if ($maxValue < $minValue) { |
|
191 | - $maxValue = $minValue; |
|
192 | - } |
|
193 | - |
|
194 | - $this->minAge = intval($minValue); |
|
195 | - $this->maxAge = intval($maxValue); |
|
196 | - $this->canPurgeToSaveSpace = false; |
|
197 | - } |
|
198 | - } |
|
30 | + // how long do we keep files a version if no other value is defined in the config file (unit: days) |
|
31 | + const NO_OBLIGATION = -1; |
|
32 | + |
|
33 | + /** @var ITimeFactory */ |
|
34 | + private $timeFactory; |
|
35 | + |
|
36 | + /** @var string */ |
|
37 | + private $retentionObligation; |
|
38 | + |
|
39 | + /** @var int */ |
|
40 | + private $minAge; |
|
41 | + |
|
42 | + /** @var int */ |
|
43 | + private $maxAge; |
|
44 | + |
|
45 | + /** @var bool */ |
|
46 | + private $canPurgeToSaveSpace; |
|
47 | + |
|
48 | + public function __construct(IConfig $config,ITimeFactory $timeFactory){ |
|
49 | + $this->timeFactory = $timeFactory; |
|
50 | + $this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto'); |
|
51 | + |
|
52 | + if ($this->retentionObligation !== 'disabled') { |
|
53 | + $this->parseRetentionObligation(); |
|
54 | + } |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * Is versions expiration enabled |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | + public function isEnabled(){ |
|
62 | + return $this->retentionObligation !== 'disabled'; |
|
63 | + } |
|
64 | + |
|
65 | + /** |
|
66 | + * Is default expiration active |
|
67 | + */ |
|
68 | + public function shouldAutoExpire(){ |
|
69 | + return $this->minAge === self::NO_OBLIGATION |
|
70 | + || $this->maxAge === self::NO_OBLIGATION; |
|
71 | + } |
|
72 | + |
|
73 | + /** |
|
74 | + * Check if given timestamp in expiration range |
|
75 | + * @param int $timestamp |
|
76 | + * @param bool $quotaExceeded |
|
77 | + * @return bool |
|
78 | + */ |
|
79 | + public function isExpired($timestamp, $quotaExceeded = false){ |
|
80 | + // No expiration if disabled |
|
81 | + if (!$this->isEnabled()) { |
|
82 | + return false; |
|
83 | + } |
|
84 | + |
|
85 | + // Purge to save space (if allowed) |
|
86 | + if ($quotaExceeded && $this->canPurgeToSaveSpace) { |
|
87 | + return true; |
|
88 | + } |
|
89 | + |
|
90 | + $time = $this->timeFactory->getTime(); |
|
91 | + // Never expire dates in future e.g. misconfiguration or negative time |
|
92 | + // adjustment |
|
93 | + if ($time<$timestamp) { |
|
94 | + return false; |
|
95 | + } |
|
96 | + |
|
97 | + // Purge as too old |
|
98 | + if ($this->maxAge !== self::NO_OBLIGATION) { |
|
99 | + $maxTimestamp = $time - ($this->maxAge * 86400); |
|
100 | + $isOlderThanMax = $timestamp < $maxTimestamp; |
|
101 | + } else { |
|
102 | + $isOlderThanMax = false; |
|
103 | + } |
|
104 | + |
|
105 | + if ($this->minAge !== self::NO_OBLIGATION) { |
|
106 | + // older than Min obligation and we are running out of quota? |
|
107 | + $minTimestamp = $time - ($this->minAge * 86400); |
|
108 | + $isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded; |
|
109 | + } else { |
|
110 | + $isMinReached = false; |
|
111 | + } |
|
112 | + |
|
113 | + return $isOlderThanMax || $isMinReached; |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Get maximal retention obligation as a timestamp |
|
118 | + * @return int |
|
119 | + */ |
|
120 | + public function getMaxAgeAsTimestamp(){ |
|
121 | + $maxAge = false; |
|
122 | + if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) { |
|
123 | + $time = $this->timeFactory->getTime(); |
|
124 | + $maxAge = $time - ($this->maxAge * 86400); |
|
125 | + } |
|
126 | + return $maxAge; |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Read versions_retention_obligation, validate it |
|
131 | + * and set private members accordingly |
|
132 | + */ |
|
133 | + private function parseRetentionObligation(){ |
|
134 | + $splitValues = explode(',', $this->retentionObligation); |
|
135 | + if (!isset($splitValues[0])) { |
|
136 | + $minValue = 'auto'; |
|
137 | + } else { |
|
138 | + $minValue = trim($splitValues[0]); |
|
139 | + } |
|
140 | + |
|
141 | + if (!isset($splitValues[1])) { |
|
142 | + $maxValue = 'auto'; |
|
143 | + } else { |
|
144 | + $maxValue = trim($splitValues[1]); |
|
145 | + } |
|
146 | + |
|
147 | + $isValid = true; |
|
148 | + // Validate |
|
149 | + if (!ctype_digit($minValue) && $minValue !== 'auto') { |
|
150 | + $isValid = false; |
|
151 | + \OC::$server->getLogger()->warning( |
|
152 | + $minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.', |
|
153 | + ['app'=>'files_versions'] |
|
154 | + ); |
|
155 | + } |
|
156 | + |
|
157 | + if (!ctype_digit($maxValue) && $maxValue !== 'auto') { |
|
158 | + $isValid = false; |
|
159 | + \OC::$server->getLogger()->warning( |
|
160 | + $maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.', |
|
161 | + ['app'=>'files_versions'] |
|
162 | + ); |
|
163 | + } |
|
164 | + |
|
165 | + if (!$isValid){ |
|
166 | + $minValue = 'auto'; |
|
167 | + $maxValue = 'auto'; |
|
168 | + } |
|
169 | + |
|
170 | + |
|
171 | + if ($minValue === 'auto' && $maxValue === 'auto') { |
|
172 | + // Default: Delete anytime if space needed |
|
173 | + $this->minAge = self::NO_OBLIGATION; |
|
174 | + $this->maxAge = self::NO_OBLIGATION; |
|
175 | + $this->canPurgeToSaveSpace = true; |
|
176 | + } elseif ($minValue !== 'auto' && $maxValue === 'auto') { |
|
177 | + // Keep for X days but delete anytime if space needed |
|
178 | + $this->minAge = intval($minValue); |
|
179 | + $this->maxAge = self::NO_OBLIGATION; |
|
180 | + $this->canPurgeToSaveSpace = true; |
|
181 | + } elseif ($minValue === 'auto' && $maxValue !== 'auto') { |
|
182 | + // Delete anytime if space needed, Delete all older than max automatically |
|
183 | + $this->minAge = self::NO_OBLIGATION; |
|
184 | + $this->maxAge = intval($maxValue); |
|
185 | + $this->canPurgeToSaveSpace = true; |
|
186 | + } elseif ($minValue !== 'auto' && $maxValue !== 'auto') { |
|
187 | + // Delete all older than max OR older than min if space needed |
|
188 | + |
|
189 | + // Max < Min as per https://github.com/owncloud/core/issues/16301 |
|
190 | + if ($maxValue < $minValue) { |
|
191 | + $maxValue = $minValue; |
|
192 | + } |
|
193 | + |
|
194 | + $this->minAge = intval($minValue); |
|
195 | + $this->maxAge = intval($maxValue); |
|
196 | + $this->canPurgeToSaveSpace = false; |
|
197 | + } |
|
198 | + } |
|
199 | 199 | } |
@@ -32,13 +32,13 @@ |
||
32 | 32 | $revision=(int)$_GET['revision']; |
33 | 33 | |
34 | 34 | try { |
35 | - list($uid, $filename) = OCA\Files_Versions\Storage::getUidAndFilename($file); |
|
35 | + list($uid, $filename) = OCA\Files_Versions\Storage::getUidAndFilename($file); |
|
36 | 36 | } catch(\OCP\Files\NotFoundException $e) { |
37 | - header("HTTP/1.1 404 Not Found"); |
|
38 | - $tmpl = new OCP\Template('', '404', 'guest'); |
|
39 | - $tmpl->assign('file', ''); |
|
40 | - $tmpl->printPage(); |
|
41 | - exit(); |
|
37 | + header("HTTP/1.1 404 Not Found"); |
|
38 | + $tmpl = new OCP\Template('', '404', 'guest'); |
|
39 | + $tmpl->assign('file', ''); |
|
40 | + $tmpl->printPage(); |
|
41 | + exit(); |
|
42 | 42 | } |
43 | 43 | |
44 | 44 | $versionName = '/'.$uid.'/files_versions/'.$filename.'.v'.$revision; |
@@ -31,20 +31,20 @@ |
||
31 | 31 | |
32 | 32 | $application = new Application(); |
33 | 33 | $application->registerRoutes($this, [ |
34 | - 'routes' => [ |
|
35 | - [ |
|
36 | - 'name' => 'Preview#getPreview', |
|
37 | - 'url' => '/preview', |
|
38 | - 'verb' => 'GET', |
|
39 | - ], |
|
40 | - ], |
|
34 | + 'routes' => [ |
|
35 | + [ |
|
36 | + 'name' => 'Preview#getPreview', |
|
37 | + 'url' => '/preview', |
|
38 | + 'verb' => 'GET', |
|
39 | + ], |
|
40 | + ], |
|
41 | 41 | ]); |
42 | 42 | |
43 | 43 | /** @var $this \OCP\Route\IRouter */ |
44 | 44 | $this->create('files_versions_download', 'download.php') |
45 | - ->actionInclude('files_versions/download.php'); |
|
45 | + ->actionInclude('files_versions/download.php'); |
|
46 | 46 | $this->create('files_versions_ajax_getVersions', 'ajax/getVersions.php') |
47 | - ->actionInclude('files_versions/ajax/getVersions.php'); |
|
47 | + ->actionInclude('files_versions/ajax/getVersions.php'); |
|
48 | 48 | $this->create('files_versions_ajax_rollbackVersion', 'ajax/rollbackVersion.php') |
49 | - ->actionInclude('files_versions/ajax/rollbackVersion.php'); |
|
49 | + ->actionInclude('files_versions/ajax/rollbackVersion.php'); |
|
50 | 50 |
@@ -31,14 +31,14 @@ |
||
31 | 31 | */ |
32 | 32 | interface IStore { |
33 | 33 | |
34 | - /** |
|
35 | - * Get login credentials of the currently logged in user |
|
36 | - * |
|
37 | - * @since 12 |
|
38 | - * |
|
39 | - * @throws CredentialsUnavailableException |
|
40 | - * @return ICredentials the login credentials of the current user |
|
41 | - */ |
|
42 | - public function getLoginCredentials(); |
|
34 | + /** |
|
35 | + * Get login credentials of the currently logged in user |
|
36 | + * |
|
37 | + * @since 12 |
|
38 | + * |
|
39 | + * @throws CredentialsUnavailableException |
|
40 | + * @return ICredentials the login credentials of the current user |
|
41 | + */ |
|
42 | + public function getLoginCredentials(); |
|
43 | 43 | |
44 | 44 | } |
@@ -30,64 +30,64 @@ |
||
30 | 30 | */ |
31 | 31 | interface IProvider { |
32 | 32 | |
33 | - /** |
|
34 | - * Get unique identifier of this 2FA provider |
|
35 | - * |
|
36 | - * @since 9.1.0 |
|
37 | - * |
|
38 | - * @return string |
|
39 | - */ |
|
40 | - public function getId(); |
|
33 | + /** |
|
34 | + * Get unique identifier of this 2FA provider |
|
35 | + * |
|
36 | + * @since 9.1.0 |
|
37 | + * |
|
38 | + * @return string |
|
39 | + */ |
|
40 | + public function getId(); |
|
41 | 41 | |
42 | - /** |
|
43 | - * Get the display name for selecting the 2FA provider |
|
44 | - * |
|
45 | - * Example: "Email" |
|
46 | - * |
|
47 | - * @since 9.1.0 |
|
48 | - * |
|
49 | - * @return string |
|
50 | - */ |
|
51 | - public function getDisplayName(); |
|
42 | + /** |
|
43 | + * Get the display name for selecting the 2FA provider |
|
44 | + * |
|
45 | + * Example: "Email" |
|
46 | + * |
|
47 | + * @since 9.1.0 |
|
48 | + * |
|
49 | + * @return string |
|
50 | + */ |
|
51 | + public function getDisplayName(); |
|
52 | 52 | |
53 | - /** |
|
54 | - * Get the description for selecting the 2FA provider |
|
55 | - * |
|
56 | - * Example: "Get a token via e-mail" |
|
57 | - * |
|
58 | - * @since 9.1.0 |
|
59 | - * |
|
60 | - * @return string |
|
61 | - */ |
|
62 | - public function getDescription(); |
|
53 | + /** |
|
54 | + * Get the description for selecting the 2FA provider |
|
55 | + * |
|
56 | + * Example: "Get a token via e-mail" |
|
57 | + * |
|
58 | + * @since 9.1.0 |
|
59 | + * |
|
60 | + * @return string |
|
61 | + */ |
|
62 | + public function getDescription(); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Get the template for rending the 2FA provider view |
|
66 | - * |
|
67 | - * @since 9.1.0 |
|
68 | - * |
|
69 | - * @param IUser $user |
|
70 | - * @return Template |
|
71 | - */ |
|
72 | - public function getTemplate(IUser $user); |
|
64 | + /** |
|
65 | + * Get the template for rending the 2FA provider view |
|
66 | + * |
|
67 | + * @since 9.1.0 |
|
68 | + * |
|
69 | + * @param IUser $user |
|
70 | + * @return Template |
|
71 | + */ |
|
72 | + public function getTemplate(IUser $user); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Verify the given challenge |
|
76 | - * |
|
77 | - * @since 9.1.0 |
|
78 | - * |
|
79 | - * @param IUser $user |
|
80 | - * @param string $challenge |
|
81 | - */ |
|
82 | - public function verifyChallenge(IUser $user, $challenge); |
|
74 | + /** |
|
75 | + * Verify the given challenge |
|
76 | + * |
|
77 | + * @since 9.1.0 |
|
78 | + * |
|
79 | + * @param IUser $user |
|
80 | + * @param string $challenge |
|
81 | + */ |
|
82 | + public function verifyChallenge(IUser $user, $challenge); |
|
83 | 83 | |
84 | - /** |
|
85 | - * Decides whether 2FA is enabled for the given user |
|
86 | - * |
|
87 | - * @since 9.1.0 |
|
88 | - * |
|
89 | - * @param IUser $user |
|
90 | - * @return boolean |
|
91 | - */ |
|
92 | - public function isTwoFactorAuthEnabledForUser(IUser $user); |
|
84 | + /** |
|
85 | + * Decides whether 2FA is enabled for the given user |
|
86 | + * |
|
87 | + * @since 9.1.0 |
|
88 | + * |
|
89 | + * @param IUser $user |
|
90 | + * @return boolean |
|
91 | + */ |
|
92 | + public function isTwoFactorAuthEnabledForUser(IUser $user); |
|
93 | 93 | } |
@@ -38,13 +38,13 @@ |
||
38 | 38 | * @deprecated 8.1.0 |
39 | 39 | */ |
40 | 40 | interface IHelper { |
41 | - /** |
|
42 | - * Gets the content of an URL by using CURL or a fallback if it is not |
|
43 | - * installed |
|
44 | - * @param string $url the url that should be fetched |
|
45 | - * @return string the content of the webpage |
|
46 | - * @since 6.0.0 |
|
47 | - * @deprecated 8.1.0 Use \OCP\IServerContainer::getHTTPClientService |
|
48 | - */ |
|
49 | - public function getUrlContent($url); |
|
41 | + /** |
|
42 | + * Gets the content of an URL by using CURL or a fallback if it is not |
|
43 | + * installed |
|
44 | + * @param string $url the url that should be fetched |
|
45 | + * @return string the content of the webpage |
|
46 | + * @since 6.0.0 |
|
47 | + * @deprecated 8.1.0 Use \OCP\IServerContainer::getHTTPClientService |
|
48 | + */ |
|
49 | + public function getUrlContent($url); |
|
50 | 50 | } |
@@ -46,17 +46,17 @@ |
||
46 | 46 | */ |
47 | 47 | interface ITagManager { |
48 | 48 | |
49 | - /** |
|
50 | - * Create a new \OCP\ITags instance and load tags from db for the current user. |
|
51 | - * |
|
52 | - * @see \OCP\ITags |
|
53 | - * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
54 | - * @param array $defaultTags An array of default tags to be used if none are stored. |
|
55 | - * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
56 | - * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
57 | - * logged in user |
|
58 | - * @return \OCP\ITags |
|
59 | - * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0 |
|
60 | - */ |
|
61 | - public function load($type, $defaultTags = array(), $includeShared = false, $userId = null); |
|
49 | + /** |
|
50 | + * Create a new \OCP\ITags instance and load tags from db for the current user. |
|
51 | + * |
|
52 | + * @see \OCP\ITags |
|
53 | + * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
54 | + * @param array $defaultTags An array of default tags to be used if none are stored. |
|
55 | + * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
56 | + * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
57 | + * logged in user |
|
58 | + * @return \OCP\ITags |
|
59 | + * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0 |
|
60 | + */ |
|
61 | + public function load($type, $defaultTags = array(), $includeShared = false, $userId = null); |
|
62 | 62 | } |
@@ -32,39 +32,39 @@ |
||
32 | 32 | */ |
33 | 33 | class ConsoleEvent extends Event { |
34 | 34 | |
35 | - const EVENT_RUN = 'OC\Console\Application::run'; |
|
35 | + const EVENT_RUN = 'OC\Console\Application::run'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | 39 | |
40 | - /** @var string[] */ |
|
41 | - protected $arguments; |
|
40 | + /** @var string[] */ |
|
41 | + protected $arguments; |
|
42 | 42 | |
43 | - /** |
|
44 | - * DispatcherEvent constructor. |
|
45 | - * |
|
46 | - * @param string $event |
|
47 | - * @param string[] $arguments |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function __construct($event, array $arguments) { |
|
51 | - $this->event = $event; |
|
52 | - $this->arguments = $arguments; |
|
53 | - } |
|
43 | + /** |
|
44 | + * DispatcherEvent constructor. |
|
45 | + * |
|
46 | + * @param string $event |
|
47 | + * @param string[] $arguments |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function __construct($event, array $arguments) { |
|
51 | + $this->event = $event; |
|
52 | + $this->arguments = $arguments; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * @return string |
|
57 | - * @since 9.0.0 |
|
58 | - */ |
|
59 | - public function getEvent() { |
|
60 | - return $this->event; |
|
61 | - } |
|
55 | + /** |
|
56 | + * @return string |
|
57 | + * @since 9.0.0 |
|
58 | + */ |
|
59 | + public function getEvent() { |
|
60 | + return $this->event; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return string[] |
|
65 | - * @since 9.0.0 |
|
66 | - */ |
|
67 | - public function getArguments() { |
|
68 | - return $this->arguments; |
|
69 | - } |
|
63 | + /** |
|
64 | + * @return string[] |
|
65 | + * @since 9.0.0 |
|
66 | + */ |
|
67 | + public function getArguments() { |
|
68 | + return $this->arguments; |
|
69 | + } |
|
70 | 70 | } |
@@ -39,132 +39,132 @@ |
||
39 | 39 | * @since 8.0.0 |
40 | 40 | */ |
41 | 41 | interface IExtension { |
42 | - const METHOD_STREAM = 'stream'; |
|
43 | - const METHOD_MAIL = 'email'; |
|
42 | + const METHOD_STREAM = 'stream'; |
|
43 | + const METHOD_MAIL = 'email'; |
|
44 | 44 | |
45 | - const PRIORITY_VERYLOW = 10; |
|
46 | - const PRIORITY_LOW = 20; |
|
47 | - const PRIORITY_MEDIUM = 30; |
|
48 | - const PRIORITY_HIGH = 40; |
|
49 | - const PRIORITY_VERYHIGH = 50; |
|
45 | + const PRIORITY_VERYLOW = 10; |
|
46 | + const PRIORITY_LOW = 20; |
|
47 | + const PRIORITY_MEDIUM = 30; |
|
48 | + const PRIORITY_HIGH = 40; |
|
49 | + const PRIORITY_VERYHIGH = 50; |
|
50 | 50 | |
51 | - /** |
|
52 | - * The extension can return an array of additional notification types. |
|
53 | - * If no additional types are to be added false is to be returned |
|
54 | - * |
|
55 | - * @param string $languageCode |
|
56 | - * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
57 | - * or Array "stringID of the type" => [ |
|
58 | - * 'desc' => "translated string description for the setting" |
|
59 | - * 'methods' => [self::METHOD_*], |
|
60 | - * ] |
|
61 | - * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
62 | - */ |
|
63 | - public function getNotificationTypes($languageCode); |
|
51 | + /** |
|
52 | + * The extension can return an array of additional notification types. |
|
53 | + * If no additional types are to be added false is to be returned |
|
54 | + * |
|
55 | + * @param string $languageCode |
|
56 | + * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
57 | + * or Array "stringID of the type" => [ |
|
58 | + * 'desc' => "translated string description for the setting" |
|
59 | + * 'methods' => [self::METHOD_*], |
|
60 | + * ] |
|
61 | + * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
62 | + */ |
|
63 | + public function getNotificationTypes($languageCode); |
|
64 | 64 | |
65 | - /** |
|
66 | - * For a given method additional types to be displayed in the settings can be returned. |
|
67 | - * In case no additional types are to be added false is to be returned. |
|
68 | - * |
|
69 | - * @param string $method |
|
70 | - * @return array|false |
|
71 | - * @since 8.0.0 |
|
72 | - */ |
|
73 | - public function getDefaultTypes($method); |
|
65 | + /** |
|
66 | + * For a given method additional types to be displayed in the settings can be returned. |
|
67 | + * In case no additional types are to be added false is to be returned. |
|
68 | + * |
|
69 | + * @param string $method |
|
70 | + * @return array|false |
|
71 | + * @since 8.0.0 |
|
72 | + */ |
|
73 | + public function getDefaultTypes($method); |
|
74 | 74 | |
75 | - /** |
|
76 | - * A string naming the css class for the icon to be used can be returned. |
|
77 | - * If no icon is known for the given type false is to be returned. |
|
78 | - * |
|
79 | - * @param string $type |
|
80 | - * @return string|false |
|
81 | - * @since 8.0.0 |
|
82 | - */ |
|
83 | - public function getTypeIcon($type); |
|
75 | + /** |
|
76 | + * A string naming the css class for the icon to be used can be returned. |
|
77 | + * If no icon is known for the given type false is to be returned. |
|
78 | + * |
|
79 | + * @param string $type |
|
80 | + * @return string|false |
|
81 | + * @since 8.0.0 |
|
82 | + */ |
|
83 | + public function getTypeIcon($type); |
|
84 | 84 | |
85 | - /** |
|
86 | - * The extension can translate a given message to the requested languages. |
|
87 | - * If no translation is available false is to be returned. |
|
88 | - * |
|
89 | - * @param string $app |
|
90 | - * @param string $text |
|
91 | - * @param array $params |
|
92 | - * @param boolean $stripPath |
|
93 | - * @param boolean $highlightParams |
|
94 | - * @param string $languageCode |
|
95 | - * @return string|false |
|
96 | - * @since 8.0.0 |
|
97 | - */ |
|
98 | - public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
85 | + /** |
|
86 | + * The extension can translate a given message to the requested languages. |
|
87 | + * If no translation is available false is to be returned. |
|
88 | + * |
|
89 | + * @param string $app |
|
90 | + * @param string $text |
|
91 | + * @param array $params |
|
92 | + * @param boolean $stripPath |
|
93 | + * @param boolean $highlightParams |
|
94 | + * @param string $languageCode |
|
95 | + * @return string|false |
|
96 | + * @since 8.0.0 |
|
97 | + */ |
|
98 | + public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
99 | 99 | |
100 | - /** |
|
101 | - * The extension can define the type of parameters for translation |
|
102 | - * |
|
103 | - * Currently known types are: |
|
104 | - * * file => will strip away the path of the file and add a tooltip with it |
|
105 | - * * username => will add the avatar of the user |
|
106 | - * * email => will add a mailto link |
|
107 | - * |
|
108 | - * @param string $app |
|
109 | - * @param string $text |
|
110 | - * @return array|false |
|
111 | - * @since 8.0.0 |
|
112 | - */ |
|
113 | - public function getSpecialParameterList($app, $text); |
|
100 | + /** |
|
101 | + * The extension can define the type of parameters for translation |
|
102 | + * |
|
103 | + * Currently known types are: |
|
104 | + * * file => will strip away the path of the file and add a tooltip with it |
|
105 | + * * username => will add the avatar of the user |
|
106 | + * * email => will add a mailto link |
|
107 | + * |
|
108 | + * @param string $app |
|
109 | + * @param string $text |
|
110 | + * @return array|false |
|
111 | + * @since 8.0.0 |
|
112 | + */ |
|
113 | + public function getSpecialParameterList($app, $text); |
|
114 | 114 | |
115 | - /** |
|
116 | - * The extension can define the parameter grouping by returning the index as integer. |
|
117 | - * In case no grouping is required false is to be returned. |
|
118 | - * |
|
119 | - * @param array $activity |
|
120 | - * @return integer|false |
|
121 | - * @since 8.0.0 |
|
122 | - */ |
|
123 | - public function getGroupParameter($activity); |
|
115 | + /** |
|
116 | + * The extension can define the parameter grouping by returning the index as integer. |
|
117 | + * In case no grouping is required false is to be returned. |
|
118 | + * |
|
119 | + * @param array $activity |
|
120 | + * @return integer|false |
|
121 | + * @since 8.0.0 |
|
122 | + */ |
|
123 | + public function getGroupParameter($activity); |
|
124 | 124 | |
125 | - /** |
|
126 | - * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
127 | - * and 'apps' which hold arrays with the relevant entries. |
|
128 | - * If no further entries are to be added false is no be returned. |
|
129 | - * |
|
130 | - * @return array|false |
|
131 | - * @since 8.0.0 |
|
132 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
133 | - */ |
|
134 | - public function getNavigation(); |
|
125 | + /** |
|
126 | + * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
127 | + * and 'apps' which hold arrays with the relevant entries. |
|
128 | + * If no further entries are to be added false is no be returned. |
|
129 | + * |
|
130 | + * @return array|false |
|
131 | + * @since 8.0.0 |
|
132 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
133 | + */ |
|
134 | + public function getNavigation(); |
|
135 | 135 | |
136 | - /** |
|
137 | - * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
138 | - * |
|
139 | - * @param string $filterValue |
|
140 | - * @return boolean |
|
141 | - * @since 8.0.0 |
|
142 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
143 | - */ |
|
144 | - public function isFilterValid($filterValue); |
|
136 | + /** |
|
137 | + * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
138 | + * |
|
139 | + * @param string $filterValue |
|
140 | + * @return boolean |
|
141 | + * @since 8.0.0 |
|
142 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
143 | + */ |
|
144 | + public function isFilterValid($filterValue); |
|
145 | 145 | |
146 | - /** |
|
147 | - * The extension can filter the types based on the filter if required. |
|
148 | - * In case no filter is to be applied false is to be returned unchanged. |
|
149 | - * |
|
150 | - * @param array $types |
|
151 | - * @param string $filter |
|
152 | - * @return array|false |
|
153 | - * @since 8.0.0 |
|
154 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
155 | - */ |
|
156 | - public function filterNotificationTypes($types, $filter); |
|
146 | + /** |
|
147 | + * The extension can filter the types based on the filter if required. |
|
148 | + * In case no filter is to be applied false is to be returned unchanged. |
|
149 | + * |
|
150 | + * @param array $types |
|
151 | + * @param string $filter |
|
152 | + * @return array|false |
|
153 | + * @since 8.0.0 |
|
154 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
155 | + */ |
|
156 | + public function filterNotificationTypes($types, $filter); |
|
157 | 157 | |
158 | - /** |
|
159 | - * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
160 | - * In case the extension does not know the filter false is to be returned. |
|
161 | - * The query condition and the parameters are to be returned as array with two elements. |
|
162 | - * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
163 | - * |
|
164 | - * @param string $filter |
|
165 | - * @return array|false |
|
166 | - * @since 8.0.0 |
|
167 | - * @deprecated 11.0.0 - Register an IFilter instead |
|
168 | - */ |
|
169 | - public function getQueryForFilter($filter); |
|
158 | + /** |
|
159 | + * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
160 | + * In case the extension does not know the filter false is to be returned. |
|
161 | + * The query condition and the parameters are to be returned as array with two elements. |
|
162 | + * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
163 | + * |
|
164 | + * @param string $filter |
|
165 | + * @return array|false |
|
166 | + * @since 8.0.0 |
|
167 | + * @deprecated 11.0.0 - Register an IFilter instead |
|
168 | + */ |
|
169 | + public function getQueryForFilter($filter); |
|
170 | 170 | } |