Completed
Pull Request — master (#215)
by Morris
23:16
created

Settings   A

Complexity

Total Complexity 29

Size/Duplication

Total Lines 287
Duplicated Lines 21.6 %

Coupling/Cohesion

Components 1
Dependencies 2

Test Coverage

Coverage 34.16%

Importance

Changes 0
Metric Value
wmc 29
lcom 1
cbo 2
dl 62
loc 287
ccs 55
cts 161
cp 0.3416
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 18 1
B personal() 24 55 7
B admin() 24 55 7
C displayPanel() 14 69 11
B feed() 0 24 3

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * @copyright Copyright (c) 2016, ownCloud, Inc.
4
 *
5
 * @author Joas Schilling <[email protected]>
6
 * @author Lukas Reschke <[email protected]>
7
 *
8
 * @license AGPL-3.0
9
 *
10
 * This code is free software: you can redistribute it and/or modify
11
 * it under the terms of the GNU Affero General Public License, version 3,
12
 * as published by the Free Software Foundation.
13
 *
14
 * This program is distributed in the hope that it will be useful,
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
 * GNU Affero General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU Affero General Public License, version 3,
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
21
 *
22
 */
23
24
namespace OCA\Activity\Controller;
25
26
use OCA\Activity\CurrentUser;
27
use OCA\Activity\UserSettings;
28
use OCP\Activity\IExtension;
29
use OCP\Activity\IManager;
30
use OCP\Activity\ISetting;
31
use OCP\AppFramework\Controller;
32
use OCP\AppFramework\Http\DataResponse;
33
use OCP\AppFramework\Http\TemplateResponse;
34
use OCP\IConfig;
35
use OCP\IL10N;
36
use OCP\IRequest;
37
use OCP\IURLGenerator;
38
use OCP\Security\ISecureRandom;
39
40
class Settings extends Controller {
41
	/** @var \OCP\IConfig */
42
	protected $config;
43
44
	/** @var \OCP\Security\ISecureRandom */
45
	protected $random;
46
47
	/** @var \OCP\IURLGenerator */
48
	protected $urlGenerator;
49
50
	/** @var IManager */
51
	protected $manager;
52
53
	/** @var \OCA\Activity\UserSettings */
54
	protected $userSettings;
55
56
	/** @var \OCP\IL10N */
57
	protected $l10n;
58
59
	/** @var string */
60
	protected $user;
61
62
	/**
63
	 * constructor of the controller
64
	 *
65
	 * @param string $appName
66
	 * @param IRequest $request
67
	 * @param IConfig $config
68
	 * @param ISecureRandom $random
69
	 * @param IURLGenerator $urlGenerator
70
	 * @param IManager $manager
71
	 * @param UserSettings $userSettings
72
	 * @param IL10N $l10n
73
	 * @param CurrentUser $currentUser
74
	 */
75 3
	public function __construct($appName,
76
								IRequest $request,
77
								IConfig $config,
78
								ISecureRandom $random,
79
								IURLGenerator $urlGenerator,
80
								IManager $manager,
81
								UserSettings $userSettings,
82
								IL10N $l10n,
83
								CurrentUser $currentUser) {
84 3
		parent::__construct($appName, $request);
85 3
		$this->config = $config;
86 3
		$this->random = $random;
87 3
		$this->urlGenerator = $urlGenerator;
88 3
		$this->manager = $manager;
89 3
		$this->userSettings = $userSettings;
90 3
		$this->l10n = $l10n;
91 3
		$this->user = (string) $currentUser->getUID();
92 3
	}
93
94
	/**
95
	 * @NoAdminRequired
96
	 *
97
	 * @param int $notify_setting_batchtime
98
	 * @param bool $notify_setting_self
99
	 * @param bool $notify_setting_selfemail
100
	 * @return DataResponse
101
	 */
102
	public function personal(
103
			$notify_setting_batchtime = UserSettings::EMAIL_SEND_HOURLY,
104
			$notify_setting_self = false,
105
			$notify_setting_selfemail = false) {
106
107
		$settings = $this->manager->getSettings();
108 View Code Duplication
		foreach ($settings as $setting) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
109
			if ($setting->canChangeStream()) {
110
				$this->config->setUserValue(
111
					$this->user, 'activity',
112
					'notify_stream_' . $setting->getIdentifier(),
113
					(int) $this->request->getParam($setting->getIdentifier() . '_stream', false)
114
				);
115
			}
116
117
			if ($setting->canChangeMail()) {
118
				$this->config->setUserValue(
119
					$this->user, 'activity',
120
					'notify_email_' . $setting->getIdentifier(),
121
					(int) $this->request->getParam($setting->getIdentifier() . '_email', false)
122
				);
123
			}
124
		}
125
126
		$email_batch_time = 3600;
127 View Code Duplication
		if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_DAILY) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
128
			$email_batch_time = 3600 * 24;
129
		} else if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_WEEKLY) {
130
			$email_batch_time = 3600 * 24 * 7;
131
		} else if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_ASAP) {
132
			$email_batch_time = 0;
133
		}
134
135
		$this->config->setUserValue(
136
			$this->user, 'activity',
137
			'notify_setting_batchtime',
138
			$email_batch_time
139
		);
140
		$this->config->setUserValue(
141
			$this->user, 'activity',
142
			'notify_setting_self',
143
			(int) $notify_setting_self
144
		);
145
		$this->config->setUserValue(
146
			$this->user, 'activity',
147
			'notify_setting_selfemail',
148
			(int) $notify_setting_selfemail
149
		);
150
151
		return new DataResponse(array(
152
			'data'		=> array(
153
				'message'	=> (string) $this->l10n->t('Your settings have been updated.'),
154
			),
155
		));
156
	}
157
158
	/**
159
	 * @param int $notify_setting_batchtime
160
	 * @param bool $notify_setting_self
161
	 * @param bool $notify_setting_selfemail
162
	 * @return DataResponse
163
	 */
164
	public function admin(
165
			$notify_setting_batchtime = UserSettings::EMAIL_SEND_HOURLY,
166
			$notify_setting_self = false,
167
			$notify_setting_selfemail = false) {
168
169
		$settings = $this->manager->getSettings();
170 View Code Duplication
		foreach ($settings as $setting) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
171
			if ($setting->canChangeStream()) {
172
				$this->config->setAppValue(
173
					'activity',
174
					'notify_stream_' . $setting->getIdentifier(),
175
					(int) $this->request->getParam($setting->getIdentifier() . '_stream', false)
176
				);
177
			}
178
179
			if ($setting->canChangeMail()) {
180
				$this->config->setAppValue(
181
					'activity',
182
					'notify_email_' . $setting->getIdentifier(),
183
					(int) $this->request->getParam($setting->getIdentifier() . '_email', false)
184
				);
185
			}
186
		}
187
188
		$email_batch_time = 3600;
189 View Code Duplication
		if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_DAILY) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
190
			$email_batch_time = 3600 * 24;
191
		} else if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_WEEKLY) {
192
			$email_batch_time = 3600 * 24 * 7;
193
		} else if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_ASAP) {
194
			$email_batch_time = 0;
195
		}
196
197
		$this->config->setAppValue(
198
			'activity',
199
			'notify_setting_batchtime',
200
			$email_batch_time
201
		);
202
		$this->config->setAppValue(
203
			'activity',
204
			'notify_setting_self',
205
			(int) $notify_setting_self
206
		);
207
		$this->config->setAppValue(
208
			'activity',
209
			'notify_setting_selfemail',
210
			(int) $notify_setting_selfemail
211
		);
212
213
		return new DataResponse(array(
214
			'data'		=> array(
215
				'message'	=> (string) $this->l10n->t('Settings have been updated.'),
216
			),
217
		));
218
	}
219
220
	/**
221
	 * @NoAdminRequired
222
	 * @NoCSRFRequired
223
	 *
224
	 * @return TemplateResponse
225
	 */
226 1
	public function displayPanel() {
227 1
		$settings = $this->manager->getSettings();
228 1 View Code Duplication
		usort($settings, function(ISetting $a, ISetting $b) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
229 1
			if ($a->getPriority() === $b->getPriority()) {
230 1
				return $a->getIdentifier() > $b->getIdentifier();
231
			}
232
233 1
			return $a->getPriority() > $b->getPriority();
234 1
		});
235
236 1
		$activities = [];
237 1
		foreach ($settings as $setting) {
238 1
			if (!$setting->canChangeStream() && !$setting->canChangeMail()) {
239
				// No setting can be changed => don't display
240 1
				continue;
241
			}
242
243 1
			$methods = [];
244 1
			if ($setting->canChangeStream()) {
245 1
				$methods[] = IExtension::METHOD_STREAM;
246 1
			}
247 1
			if ($setting->canChangeMail()) {
248 1
				$methods[] = IExtension::METHOD_MAIL;
249 1
			}
250
251 1
			$activities[$setting->getIdentifier()] = array(
252 1
				'desc'		=> $setting->getName(),
253 1
				IExtension::METHOD_MAIL		=> $this->userSettings->getUserSetting($this->user, 'email', $setting->getIdentifier()),
254 1
				IExtension::METHOD_STREAM	=> $this->userSettings->getUserSetting($this->user, 'stream', $setting->getIdentifier()),
255 1
				'methods'	=> $methods,
256
			);
257 1
		}
258
259 1
		$settingBatchTime = UserSettings::EMAIL_SEND_HOURLY;
260 1
		$currentSetting = (int) $this->userSettings->getUserSetting($this->user, 'setting', 'batchtime');
261 1 View Code Duplication
		if ($currentSetting === 3600 * 24 * 7) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
262
			$settingBatchTime = UserSettings::EMAIL_SEND_WEEKLY;
263 1
		} else if ($currentSetting === 3600 * 24) {
264
			$settingBatchTime = UserSettings::EMAIL_SEND_DAILY;
265 1
		} else if ($currentSetting === 0) {
266
			$settingBatchTime = UserSettings::EMAIL_SEND_ASAP;
267
		}
268
269 1
		$emailEnabled = $this->config->getAppValue('activity', 'enable_email', 'yes') === 'yes';
270 1
		if ($emailEnabled) {
271
			$methods = [
272 1
				IExtension::METHOD_MAIL => $this->l10n->t('Mail'),
273 1
				IExtension::METHOD_STREAM => $this->l10n->t('Stream'),
274 1
			];
275 1
		} else {
276
			$methods = [
277
				IExtension::METHOD_STREAM => $this->l10n->t('Stream'),
278
			];
279
		}
280
281 1
		return new TemplateResponse('activity', 'settings/personal', [
282 1
			'setting'			=> 'personal',
283 1
			'activities'		=> $activities,
284 1
			'is_email_set'		=> !empty($this->config->getUserValue($this->user, 'settings', 'email', '')),
285 1
			'email_enabled'		=> $emailEnabled,
286
287 1
			'setting_batchtime'	=> $settingBatchTime,
288
289 1
			'notify_self'		=> $this->userSettings->getUserSetting($this->user, 'setting', 'self'),
290 1
			'notify_selfemail'	=> $this->userSettings->getUserSetting($this->user, 'setting', 'selfemail'),
291
292 1
			'methods'			=> $methods,
293 1
		], '');
294
	}
295
296
	/**
297
	 * @NoAdminRequired
298
	 *
299
	 * @param string $enable	'true' if the feed is enabled
300
	 * @return DataResponse
301
	 */
302
	public function feed($enable) {
303
		$token = $tokenUrl = '';
304
305
		if ($enable === 'true') {
306
			$conflicts = true;
307
308
			// Check for collisions
309
			while (!empty($conflicts)) {
310
				$token = $this->random->generate(30, ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
311
				$conflicts = $this->config->getUsersForUserValue('activity', 'rsstoken', $token);
312
			}
313
314
			$tokenUrl = $this->urlGenerator->linkToRouteAbsolute('activity.Feed.show', ['token' => $token]);
315
		}
316
317
		$this->config->setUserValue($this->user, 'activity', 'rsstoken', $token);
318
319
		return new DataResponse(array(
320
			'data'		=> array(
321
				'message'	=> (string) $this->l10n->t('Your settings have been updated.'),
322
				'rsslink'	=> $tokenUrl,
323
			),
324
		));
325
	}
326
}
327