aboutsummaryrefslogtreecommitdiffstats
path: root/apps/dav/lib/CalDAV/Activity/Extension.php
blob: b6d4e23b71dce2373ffd607697da5dc912903f3c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?php
/**
 * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\DAV\CalDAV\Activity;

use OCP\Activity\IExtension;
use OCP\IURLGenerator;
use OCP\L10N\IFactory;

class Extension implements IExtension {
	const APP = 'dav';
	/**
	 * Filter with all sharing related activities
	 */
	const CALENDAR = 'calendar';
	const CALENDAR_EVENT = 'calendar_event';
	const CALENDAR_TODO = 'calendar_todo';

	const SUBJECT_ADD = 'calendar_add';
	const SUBJECT_UPDATE = 'calendar_update';
	const SUBJECT_DELETE = 'calendar_delete';
	const SUBJECT_SHARE_USER = 'calendar_user_share';
	const SUBJECT_SHARE_GROUP = 'calendar_group_share';
	const SUBJECT_UNSHARE_USER = 'calendar_user_unshare';
	const SUBJECT_UNSHARE_GROUP = 'calendar_group_unshare';

	const SUBJECT_OBJECT_ADD = 'object_add';
	const SUBJECT_OBJECT_UPDATE = 'object_update';
	const SUBJECT_OBJECT_DELETE = 'object_delete';

	/** @var IFactory */
	protected $languageFactory;

	/** @var IURLGenerator */
	protected $URLGenerator;

	/**
	 * @param IFactory $languageFactory
	 * @param IURLGenerator $URLGenerator
	 */
	public function __construct(IFactory $languageFactory, IURLGenerator $URLGenerator) {
		$this->languageFactory = $languageFactory;
		$this->URLGenerator = $URLGenerator;
	}

	protected function getL10N($languageCode = null) {
		return $this->languageFactory->get(self::APP, $languageCode);
	}

	/**
	 * The extension can return an array of additional notification types.
	 * If no additional types are to be added false is to be returned
	 *
	 * @param string $languageCode
	 * @return array|false
	 */
	public function getNotificationTypes($languageCode) {
		return false;
	}

	/**
	 * For a given method additional types to be displayed in the settings can be returned.
	 * In case no additional types are to be added false is to be returned.
	 *
	 * @param string $method
	 * @return array|false
	 */
	public function getDefaultTypes($method) {
		return false;
	}

	/**
	 * A string naming the css class for the icon to be used can be returned.
	 * If no icon is known for the given type false is to be returned.
	 *
	 * @param string $type
	 * @return string|false
	 */
	public function getTypeIcon($type) {
		return false;
	}

	/**
	 * The extension can translate a given message to the requested languages.
	 * If no translation is available false is to be returned.
	 *
	 * @param string $app
	 * @param string $text
	 * @param array $params
	 * @param boolean $stripPath
	 * @param boolean $highlightParams
	 * @param string $languageCode
	 * @return string|false
	 */
	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode) {
		if ($app !== self::APP) {
			return false;
		}

		$l = $this->getL10N($languageCode);

		switch ($text) {
			case self::SUBJECT_OBJECT_ADD . '_event':
				return (string) $l->t('%1$s created event %3$s in calendar %2$s', $params);
			case self::SUBJECT_OBJECT_ADD . '_event_self':
				return (string) $l->t('You created event %3$s in calendar %2$s', $params);
			case self::SUBJECT_OBJECT_DELETE . '_event':
				return (string) $l->t('%1$s deleted event %3$s from calendar %2$s', $params);
			case self::SUBJECT_OBJECT_DELETE . '_event_self':
				return (string) $l->t('You deleted event %3$s from calendar %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_event':
				return (string) $l->t('%1$s updated event %3$s in calendar %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_event_self':
				return (string) $l->t('You updated event %3$s in calendar %2$s', $params);

			case self::SUBJECT_OBJECT_ADD . '_todo':
				return (string) $l->t('%1$s created todo %3$s in list %2$s', $params);
			case self::SUBJECT_OBJECT_ADD . '_todo_self':
				return (string) $l->t('You created todo %3$s in list %2$s', $params);
			case self::SUBJECT_OBJECT_DELETE . '_todo':
				return (string) $l->t('%1$s deleted todo %3$s from list %2$s', $params);
			case self::SUBJECT_OBJECT_DELETE . '_todo_self':
				return (string) $l->t('You deleted todo %3$s from list %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_todo':
				return (string) $l->t('%1$s updated todo %3$s in list %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_todo_self':
				return (string) $l->t('You updated todo %3$s in list %2$s', $params);

			case self::SUBJECT_OBJECT_UPDATE . '_todo_completed':
				return (string) $l->t('%1$s solved todo %3$s in list %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_todo_completed_self':
				return (string) $l->t('You solved todo %3$s in list %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_todo_needs_action':
				return (string) $l->t('%1$s reopened todo %3$s in list %2$s', $params);
			case self::SUBJECT_OBJECT_UPDATE . '_todo_needs_action_self':
				return (string) $l->t('You reopened todo %3$s in list %2$s', $params);

		}

		return false;
	}

	/**
	 * The extension can define the type of parameters for translation
	 *
	 * Currently known types are:
	 * * file		=> will strip away the path of the file and add a tooltip with it
	 * * username	=> will add the avatar of the user
	 *
	 * @param string $app
	 * @param string $text
	 * @return array|false
	 */
	public function getSpecialParameterList($app, $text) {
		if ($app === self::APP) {
			switch ($text) {
				case self::SUBJECT_OBJECT_ADD . '_event':
				case self::SUBJECT_OBJECT_ADD . '_event_self':
				case self::SUBJECT_OBJECT_DELETE . '_event':
				case self::SUBJECT_OBJECT_DELETE . '_event_self':
				case self::SUBJECT_OBJECT_UPDATE . '_event':
				case self::SUBJECT_OBJECT_UPDATE . '_event_self':

				case self::SUBJECT_OBJECT_ADD . '_todo':
				case self::SUBJECT_OBJECT_ADD . '_todo_self':
				case self::SUBJECT_OBJECT_DELETE . '_todo':
				case self::SUBJECT_OBJECT_DELETE . '_todo_self':
				case self::SUBJECT_OBJECT_UPDATE . '_todo':
				case self::SUBJECT_OBJECT_UPDATE . '_todo_self':

				case self::SUBJECT_OBJECT_UPDATE . '_todo_completed':
				case self::SUBJECT_OBJECT_UPDATE . '_todo_completed_self':
				case self::SUBJECT_OBJECT_UPDATE . '_todo_needs_action':
				case self::SUBJECT_OBJECT_UPDATE . '_todo_needs_action_self':
					return [
						0 => 'username',
						//1 => 'calendar',
						//2 => 'object',
					];
			}
		}

		return false;
	}

	/**
	 * The extension can define the parameter grouping by returning the index as integer.
	 * In case no grouping is required false is to be returned.
	 *
	 * @param array $activity
	 * @return integer|false
	 */
	public function getGroupParameter($activity) {
		return false;
	}

	/**
	 * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
	 * and 'apps' which hold arrays with the relevant entries.
	 * If no further entries are to be added false is no be returned.
	 *
	 * @return array|false
	 */
	public function getNavigation() {
		return false;
	}

	/**
	 * The extension can check if a custom filter (given by a query string like filter=abc) is valid or not.
	 *
	 * @param string $filterValue
	 * @return boolean
	 */
	public function isFilterValid($filterValue) {
		return false;
	}

	/**
	 * The extension can filter the types based on the filter if required.
	 * In case no filter is to be applied false is to be returned unchanged.
	 *
	 * @param array $types
	 * @param string $filter
	 * @return array|false
	 */
	public function filterNotificationTypes($types, $filter) {
		return false;
	}

	/**
	 * For a given filter the extension can specify the sql query conditions including parameters for that query.
	 * In case the extension does not know the filter false is to be returned.
	 * The query condition and the parameters are to be returned as array with two elements.
	 * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
	 *
	 * @param string $filter
	 * @return array|false
	 */
	public function getQueryForFilter($filter) {
		return false;
	}

}