Completed
Pull Request — master (#120)
by Morris
08:46
created

Settings::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 18
Code Lines 17

Duplication

Lines 18
Ratio 100 %

Code Coverage

Tests 10
CRAP Score 1

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 18
loc 18
ccs 10
cts 10
cp 1
rs 9.4285
cc 1
eloc 17
nc 1
nop 9
crap 1

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

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 View Code Duplication
	public function __construct($appName,
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
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
		foreach ($settings as $setting) {
109 View Code Duplication
			if ($setting->canChangeStream()) {
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...
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 View Code Duplication
			if ($setting->canChangeMail()) {
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...
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
		if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_DAILY) {
128
			$email_batch_time = 3600 * 24;
129
		} else if ($notify_setting_batchtime === UserSettings::EMAIL_SEND_WEEKLY) {
130
			$email_batch_time = 3600 * 24 * 7;
131
		}
132
133
		$this->config->setUserValue(
134
			$this->user, 'activity',
135
			'notify_setting_batchtime',
136
			$email_batch_time
137
		);
138
		$this->config->setUserValue(
139
			$this->user, 'activity',
140
			'notify_setting_self',
141
			(int) $notify_setting_self
142
		);
143
		$this->config->setUserValue(
144
			$this->user, 'activity',
145
			'notify_setting_selfemail',
146
			(int) $notify_setting_selfemail
147
		);
148
149
		return new DataResponse(array(
150
			'data'		=> array(
151
				'message'	=> (string) $this->l10n->t('Your settings have been updated.'),
152
			),
153
		));
154
	}
155
156
	/**
157
	 * @NoAdminRequired
158
	 * @NoCSRFRequired
159
	 *
160
	 * @return TemplateResponse
161
	 */
162 1
	public function displayPanel() {
163 1
		$settings = $this->manager->getSettings();
164 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...
165 1
			if ($a->getPriority() === $b->getPriority()) {
166 1
				return $a->getIdentifier() > $b->getIdentifier();
167
			}
168
169 1
			return $a->getPriority() > $b->getPriority();
170 1
		});
171
172 1
		$activities = [];
173 1
		foreach ($settings as $setting) {
174 1
			if (!$setting->canChangeStream() && !$setting->canChangeMail()) {
175
				// No setting can be changed => don't display
176
				continue;
177
			}
178
179 1
			$methods = [];
180 1
			if ($setting->canChangeStream()) {
181 1
				$methods[] = IExtension::METHOD_STREAM;
182 1
			}
183 1
			if ($setting->canChangeMail()) {
184 1
				$methods[] = IExtension::METHOD_MAIL;
185 1
			}
186
187 1
			$activities[$setting->getIdentifier()] = array(
188 1
				'desc'		=> $setting->getName(),
189 1
				IExtension::METHOD_MAIL		=> $this->userSettings->getUserSetting($this->user, 'email', $setting->getIdentifier()),
190 1
				IExtension::METHOD_STREAM	=> $this->userSettings->getUserSetting($this->user, 'stream', $setting->getIdentifier()),
191 1
				'methods'	=> $methods,
192
			);
193 1
		}
194
195 1
		$settingBatchTime = UserSettings::EMAIL_SEND_HOURLY;
196 1
		$currentSetting = (int) $this->userSettings->getUserSetting($this->user, 'setting', 'batchtime');
197 1
		if ($currentSetting === 3600 * 24 * 7) {
198
			$settingBatchTime = UserSettings::EMAIL_SEND_WEEKLY;
199 1
		} else if ($currentSetting === 3600 * 24) {
200
			$settingBatchTime = UserSettings::EMAIL_SEND_DAILY;
201
		}
202
203 1
		return new TemplateResponse('activity', 'personal', [
204 1
			'activities'		=> $activities,
205 1
			'activity_email'	=> $this->config->getUserValue($this->user, 'settings', 'email', ''),
206
207 1
			'setting_batchtime'	=> $settingBatchTime,
208
209 1
			'notify_self'		=> $this->userSettings->getUserSetting($this->user, 'setting', 'self'),
210 1
			'notify_selfemail'	=> $this->userSettings->getUserSetting($this->user, 'setting', 'selfemail'),
211
212
			'methods'			=> [
213 1
				IExtension::METHOD_MAIL => $this->l10n->t('Mail'),
214 1
				IExtension::METHOD_STREAM => $this->l10n->t('Stream'),
215 1
			],
216 1
		], '');
217
	}
218
219
	/**
220
	 * @NoAdminRequired
221
	 *
222
	 * @param string $enable	'true' if the feed is enabled
223
	 * @return DataResponse
224
	 */
225
	public function feed($enable) {
226
		$token = $tokenUrl = '';
227
228
		if ($enable === 'true') {
229
			$conflicts = true;
230
231
			// Check for collisions
232
			while (!empty($conflicts)) {
233
				$token = $this->random->generate(30, ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
234
				$conflicts = $this->config->getUsersForUserValue('activity', 'rsstoken', $token);
235
			}
236
237
			$tokenUrl = $this->urlGenerator->linkToRouteAbsolute('activity.Feed.show', ['token' => $token]);
238
		}
239
240
		$this->config->setUserValue($this->user, 'activity', 'rsstoken', $token);
241
242
		return new DataResponse(array(
243
			'data'		=> array(
244
				'message'	=> (string) $this->l10n->t('Your settings have been updated.'),
245
				'rsslink'	=> $tokenUrl,
246
			),
247
		));
248
	}
249
}
250