ViewController::getTimezoneWithSubRegion() - Code Metrics - Inspection of "Calendar public sharing" - owncloud/calendar - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#605)

by Thomas

created 2016-08-17 17:03 UTC

ViewController::getTimezoneWithSubRegion() A

↳ Parent: ViewController

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	3
dl	0
loc	3
ccs	0
cts	0
cp	0
crap	2
rs	10

<?php
/**
 * ownCloud - Calendar App
 *
 * @author Georg Ehrke
 * @copyright 2016 Georg Ehrke <[email protected]>
 * @author Raghu Nayyar
 * @copyright 2016 Raghu Nayyar <[email protected]>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library 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 library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\Calendar\Controller;

use OC\AppFramework\Http;
use OC\L10N\L10N;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\ContentSecurityPolicy;
use OCP\AppFramework\Http\DataDisplayResponse;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\NotFoundResponse;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\Defaults;
use OCP\IConfig;
use OCP\IRequest;
use OCP\IUserSession;
use OCP\Mail\IMailer;

class ViewController extends Controller {

	/**
	 * @var IConfig
	 */
	private $config;

	/**
	 * @var IUserSession
	 */
	private $userSession;

	/**
	 * @var IMailer
	 */
	private $mailer;

	/**
	 * @var L10N
	 */
	private $l10n;

	/**
	 * @var Defaults
	 */
	private $defaults;

	/**
	 * @param string $appName
	 * @param IRequest $request an instance of the request
	 * @param IUserSession $userSession
	 * @param IConfig $config
	 * @param IMailer $mailer
	 * @param L10N $l10N
	 */
	public function __construct($appName, IRequest $request,
								IUserSession $userSession, IConfig $config, IMailer $mailer, L10N $l10N, Defaults $defaults) {
		parent::__construct($appName, $request);
		$this->config = $config;
		$this->userSession = $userSession;
		$this->mailer = $mailer;
		$this->l10n = $l10N;
		$this->defaults = $defaults;
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 *
	 * @return TemplateResponse
	 */
	public function index() {
		$runningOn = $this->config->getSystemValue('version');
		$runningOnServer91OrLater = version_compare($runningOn, '9.1', '>=');

		$supportsClass = $runningOnServer91OrLater;
		$assetPipelineBroken = !$runningOnServer91OrLater;

		$isAssetPipelineEnabled = $this->config->getSystemValue('asset-pipeline.enabled', false);
		if ($isAssetPipelineEnabled && $assetPipelineBroken) {
			return new TemplateResponse('calendar', 'main-asset-pipeline-unsupported');
		}

		$user = $this->userSession->getUser();
		$userId = $user->getUID();
		$emailAddress = $user->getEMailAddress();

		$appVersion = $this->config->getAppValue($this->appName, 'installed_version');
		$defaultView = $this->config->getUserValue($userId, $this->appName, 'currentView', 'month');
		$skipPopover = $this->config->getUserValue($userId, $this->appName, 'skipPopover', 'no');
		
		return new TemplateResponse('calendar', 'main', [
			'appVersion' => $appVersion,
			'defaultView' => $defaultView,
			'emailAddress' => $emailAddress,
			'skipPopover' => $skipPopover,
			'supportsClass' => $supportsClass,
			'isPublic' => false,
		]);
	}

	/**
	 * @PublicPage
	 * @NoCSRFRequired
	 *
	 * @return TemplateResponse
	 */
	public function publicIndex() {
		$runningOn = $this->config->getSystemValue('version');
		$runningOnServer91OrLater = version_compare($runningOn, '9.1', '>=');

		$supportsClass = $runningOnServer91OrLater;
		$assetPipelineBroken = !$runningOnServer91OrLater;

		$isAssetPipelineEnabled = $this->config->getSystemValue('asset-pipeline.enabled', false);
		if ($isAssetPipelineEnabled && $assetPipelineBroken) {
			return new TemplateResponse('calendar', 'main-asset-pipeline-unsupported');
		}

		$appVersion = $this->config->getAppValue($this->appName, 'installed_version');

		$response = new TemplateResponse('calendar', 'main', [
			'appVersion' => $appVersion,
			'defaultView' => 'month',
			'emailAddress' => '',
			'supportsClass' => $supportsClass,
			'isPublic' => true,
		], 'public');
		$response->addHeader('X-Frame-Options', 'ALLOW');
		$csp = new ContentSecurityPolicy();
		$csp->addAllowedScriptDomain('*');
		$response->setContentSecurityPolicy($csp);

		return $response;
	}

	/**
	 * @NoAdminRequired
	 *
	 * @param string $id
	 * @return NotFoundResponse|DataDisplayResponse
	 */
	public function getTimezone($id) {
		if (!in_array($id, $this->getTimezoneList())) {
			return new NotFoundResponse();
		}

		$tzData = file_get_contents(__DIR__ . '/../timezones/' . $id);

		return new DataDisplayResponse($tzData, HTTP::STATUS_OK, [
			'content-type' => 'text/calendar',
		]);
	}


	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 * @PublicPage
	 *
	 * @param $region
	 * @param $city
	 * @return DataDisplayResponse
	 */
	public function getTimezoneWithRegion($region, $city) {
		return $this->getTimezone($region . '-' . $city);

	}


	/**
	 * @NoAdminRequired
	 * @PublicPage
	 * @NoCSRFRequired
	 *
	 * @param $region
	 * @param $subregion
	 * @param $city
	 * @return DataDisplayResponse
	 */
	public function getTimezoneWithSubRegion($region, $subregion, $city) {
		return $this->getTimezone($region . '-' . $subregion . '-' . $city);

	}


	/**
	 * get a list of default timezones
	 *
	 * @return array
	 */
	private function getTimezoneList() {
		$allFiles = scandir(__DIR__ . '/../timezones/');

		return array_values(array_filter($allFiles, function($file) {
			return (substr($file, -4) === '.ics');
		}));
	}

	/**
	 * @param string $to
	 * @param string $url
	 * @param string $name
	 * @return JSONResponse
	 * @NoAdminRequired
	 */
	public function sendEmailPublicLink($to, $url, $name) {

		$user = $this->userSession->getUser();
		$username = $user->getDisplayName();

		$subject = $this->l10n->t('%s has shared the calendar "%s" with you', [$username, $name]);

		$emailTemplate = new TemplateResponse('calendar', 'mail.publication', ['subject' => $subject, 'username' => $username, 'calendarname' => $name, 'calendarurl' => $url, 'defaults' => $this->defaults], 'public');
		$body = $emailTemplate->render();

		return $this->sendEmail($to, $subject, $body, true);
	}

	/**
	 * @param string $target
	 * @param string $subject
	 * @param string $body
	 * @param boolean $useHTML
	 * @return JSONResponse
	 *
	 * TODO : This should be moved to a Tools class
	 *
	 */
	private function sendEmail($target, $subject, $body, $useHTML = false) {
		if (!$this->mailer->validateMailAddress($target)) {
			return new JSONResponse([], Http::STATUS_BAD_REQUEST);
		}

		$sendFromDomain = $this->config->getSystemValue('mail_domain', 'domain.org');
		$sendFromAddress = $this->config->getSystemValue('mail_from_address', 'owncloud');
		$sendFrom = $sendFromAddress . '@' . $sendFromDomain;

		$message = $this->mailer->createMessage();
		$message->setSubject($subject);
		$message->setFrom([$sendFrom => 'ownCloud Notifier']);
		$message->setTo([$target => 'Recipient']);
		if ($useHTML) {
			$message->setHtmlBody($body);
		} else {
			$message->setPlainBody($body);
		}
		$this->mailer->send($message);

		return new JSONResponse([], Http::STATUS_OK);
	}
}


1		<?php
2		/**
3		* ownCloud - Calendar App
4		*
5		* @author Georg Ehrke
6		* @copyright 2016 Georg Ehrke <[email protected]>
7		* @author Raghu Nayyar
8		* @copyright 2016 Raghu Nayyar <[email protected]>
9		*
10		* This library is free software; you can redistribute it and/or
11		* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
12		* License as published by the Free Software Foundation; either
13		* version 3 of the License, or any later version.
14		*
15		* This library is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
19		*
20		* You should have received a copy of the GNU Affero General Public
21		* License along with this library. If not, see <http://www.gnu.org/licenses/>.
22		*
23		*/
24		namespace OCA\Calendar\Controller;
25
26		use OC\AppFramework\Http;
27		use OC\L10N\L10N;
28		use OCP\AppFramework\Controller;
29		use OCP\AppFramework\Http\ContentSecurityPolicy;
30		use OCP\AppFramework\Http\DataDisplayResponse;
31		use OCP\AppFramework\Http\JSONResponse;
32		use OCP\AppFramework\Http\NotFoundResponse;
33		use OCP\AppFramework\Http\TemplateResponse;
34		use OCP\Defaults;
35		use OCP\IConfig;
36		use OCP\IRequest;
37		use OCP\IUserSession;
38		use OCP\Mail\IMailer;
39
40		class ViewController extends Controller {
41
42		/**
43		* @var IConfig
44		*/
45		private $config;
46
47		/**
48		* @var IUserSession
49		*/
50		private $userSession;
51
52		/**
53	8	* @var IMailer
54		*/
55	8	private $mailer;
56	8
57	8	/**
58	8	* @var L10N
59		*/
60		private $l10n;
61
62		/**
63		* @var Defaults
64		*/
65		private $defaults;
66	4
67	4	/**
68		* @param string $appName
69	4	* @param IRequest $request an instance of the request
70	4	* @param IUserSession $userSession
71	2	* @param IConfig $config
72		* @param IMailer $mailer
73		* @param L10N $l10N
74	2	*/
75	2	public function __construct($appName, IRequest $request,
76	2	IUserSession $userSession, IConfig $config, IMailer $mailer, L10N $l10N, Defaults $defaults) {
77		parent::__construct($appName, $request);
78	2	$this->config = $config;
79	2	$this->userSession = $userSession;
80		$this->mailer = $mailer;
81	2	$this->l10n = $l10N;
82		$this->defaults = $defaults;
83	2	}
84	2
85	2	/**
86	2	* @NoAdminRequired
87		* @NoCSRFRequired
88	2	*
89		* @return TemplateResponse
90		*/
91		public function index() {
92		$runningOn = $this->config->getSystemValue('version');
93		$runningOnServer91OrLater = version_compare($runningOn, '9.1', '>=');
94
95		$supportsClass = $runningOnServer91OrLater;
96		$assetPipelineBroken = !$runningOnServer91OrLater;
97	4
98	4	$isAssetPipelineEnabled = $this->config->getSystemValue('asset-pipeline.enabled', false);
99	2	if ($isAssetPipelineEnabled && $assetPipelineBroken) {
100		return new TemplateResponse('calendar', 'main-asset-pipeline-unsupported');
101		}
102	2
103		$user = $this->userSession->getUser();
104	2	$userId = $user->getUID();
105	2	$emailAddress = $user->getEMailAddress();
106	2
107		$appVersion = $this->config->getAppValue($this->appName, 'installed_version');
108		$defaultView = $this->config->getUserValue($userId, $this->appName, 'currentView', 'month');
109		$skipPopover = $this->config->getUserValue($userId, $this->appName, 'skipPopover', 'no');
110
111		return new TemplateResponse('calendar', 'main', [
112		'appVersion' => $appVersion,
113		'defaultView' => $defaultView,
114		'emailAddress' => $emailAddress,
115		'skipPopover' => $skipPopover,
116		'supportsClass' => $supportsClass,
117	2	'isPublic' => false,
118	2	]);
119		}
120
121		/**
122		* @PublicPage
123		* @NoCSRFRequired
124		*
125		* @return TemplateResponse
126		*/
127		public function publicIndex() {
128		$runningOn = $this->config->getSystemValue('version');
129		$runningOnServer91OrLater = version_compare($runningOn, '9.1', '>=');
130
131		$supportsClass = $runningOnServer91OrLater;
132		$assetPipelineBroken = !$runningOnServer91OrLater;
133
134		$isAssetPipelineEnabled = $this->config->getSystemValue('asset-pipeline.enabled', false);
135		if ($isAssetPipelineEnabled && $assetPipelineBroken) {
136		return new TemplateResponse('calendar', 'main-asset-pipeline-unsupported');
137		}
138
139		$appVersion = $this->config->getAppValue($this->appName, 'installed_version');
140	4
141	4	$response = new TemplateResponse('calendar', 'main', [
142		'appVersion' => $appVersion,
143	4	'defaultView' => 'month',
144	4	'emailAddress' => '',
145	4	'supportsClass' => $supportsClass,
146		'isPublic' => true,
147		], 'public');
148		$response->addHeader('X-Frame-Options', 'ALLOW');
149		$csp = new ContentSecurityPolicy();
150		$csp->addAllowedScriptDomain('*');
151		$response->setContentSecurityPolicy($csp);
152
153		return $response;
154		}
155
156		/**
157		* @NoAdminRequired
158		*
159		* @param string $id
160		* @return NotFoundResponse\|DataDisplayResponse
161		*/
162		public function getTimezone($id) {
163		if (!in_array($id, $this->getTimezoneList())) {
164		return new NotFoundResponse();
165		}
166
167		$tzData = file_get_contents(__DIR__ . '/../timezones/' . $id);
168
169		return new DataDisplayResponse($tzData, HTTP::STATUS_OK, [
170		'content-type' => 'text/calendar',
171		]);
172		}
173
174
175		/**
176		* @NoAdminRequired
177		* @NoCSRFRequired
178		* @PublicPage
179		*
180		* @param $region
181		* @param $city
182		* @return DataDisplayResponse
183		*/
184		public function getTimezoneWithRegion($region, $city) {
185		return $this->getTimezone($region . '-' . $city);
		0 ignored issues – show Bug Compatibility introduced 2016-07-22 14:35 UTC by Report Bug Copy Issue Report The expression `$this->getTimezone($region . '-' . $city);` of type `OCP\AppFramework\Http\No...ttp\DataDisplayResponse` adds the type `OCP\AppFramework\Http\NotFoundResponse` to the return on line 185 which is incompatible with the return type documented by `OCA\Calendar\Controller\...::getTimezoneWithRegion` of type `OCP\AppFramework\Http\DataDisplayResponse`. Loading history...
186		}
187
188
189		/**
190		* @NoAdminRequired
191		* @PublicPage
192		* @NoCSRFRequired
193		*
194		* @param $region
195		* @param $subregion
196		* @param $city
197		* @return DataDisplayResponse
198		*/
199		public function getTimezoneWithSubRegion($region, $subregion, $city) {
200		return $this->getTimezone($region . '-' . $subregion . '-' . $city);
		0 ignored issues – show Bug Compatibility introduced 2016-07-22 14:35 UTC by Report Bug Copy Issue Report The expression `$this->getTimezone($regi...bregion . '-' . $city);` of type `OCP\AppFramework\Http\No...ttp\DataDisplayResponse` adds the type `OCP\AppFramework\Http\NotFoundResponse` to the return on line 200 which is incompatible with the return type documented by `OCA\Calendar\Controller\...etTimezoneWithSubRegion` of type `OCP\AppFramework\Http\DataDisplayResponse`. Loading history...
201		}
202
203
204		/**
205		* get a list of default timezones
206		*
207		* @return array
208		*/
209		private function getTimezoneList() {
210		$allFiles = scandir(__DIR__ . '/../timezones/');
211
212		return array_values(array_filter($allFiles, function($file) {
213		return (substr($file, -4) === '.ics');
214		}));
215		}
216
217		/**
218		* @param string $to
219		* @param string $url
220		* @param string $name
221		* @return JSONResponse
222		* @NoAdminRequired
223		*/
224		public function sendEmailPublicLink($to, $url, $name) {
225
226		$user = $this->userSession->getUser();
227		$username = $user->getDisplayName();
228
229		$subject = $this->l10n->t('%s has shared the calendar "%s" with you', [$username, $name]);
230
231		$emailTemplate = new TemplateResponse('calendar', 'mail.publication', ['subject' => $subject, 'username' => $username, 'calendarname' => $name, 'calendarurl' => $url, 'defaults' => $this->defaults], 'public');
232		$body = $emailTemplate->render();
233
234		return $this->sendEmail($to, $subject, $body, true);
235		}
236
237		/**
238		* @param string $target
239		* @param string $subject
240		* @param string $body
241		* @param boolean $useHTML
242		* @return JSONResponse
243		*
244		* TODO : This should be moved to a Tools class
245		*
246		*/
247		private function sendEmail($target, $subject, $body, $useHTML = false) {
248		if (!$this->mailer->validateMailAddress($target)) {
249		return new JSONResponse([], Http::STATUS_BAD_REQUEST);
250		}
251
252		$sendFromDomain = $this->config->getSystemValue('mail_domain', 'domain.org');
253		$sendFromAddress = $this->config->getSystemValue('mail_from_address', 'owncloud');
254		$sendFrom = $sendFromAddress . '@' . $sendFromDomain;
255
256		$message = $this->mailer->createMessage();
257		$message->setSubject($subject);
258		$message->setFrom([$sendFrom => 'ownCloud Notifier']);
259		$message->setTo([$target => 'Recipient']);
260		if ($useHTML) {
261		$message->setHtmlBody($body);
262		} else {
263		$message->setPlainBody($body);
264		}
265		$this->mailer->send($message);
266
267		return new JSONResponse([], Http::STATUS_OK);
268		}
269		}
270

owncloud / calendar

Pull Request — master (#605)

ViewController::getTimezoneWithSubRegion() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like