IMipPlugin::schedule() - Code Metrics - Inspection of "Merge pull request #6394 from nextcloud/navigation..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 485e22...5184f3 )

by Morris

created 2017-09-07 07:30 UTC

IMipPlugin::schedule() C

↳ Parent: IMipPlugin

Complexity

Conditions	13
Paths	69

Size

Total Lines	65
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	42
nc	69
nop	1
dl	0
loc	65
rs	5.9671
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 * @copyright Copyright (c) 2017, Georg Ehrke
 *
 * @author Thomas Müller <[email protected]>
 * @author Georg Ehrke <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */
namespace OCA\DAV\CalDAV\Schedule;

use OCP\AppFramework\Utility\ITimeFactory;
use OCP\ILogger;
use OCP\Mail\IMailer;
use Sabre\VObject\Component\VCalendar;
use Sabre\VObject\DateTimeParser;
use Sabre\VObject\ITip;
use Sabre\CalDAV\Schedule\IMipPlugin as SabreIMipPlugin;
use Sabre\VObject\Recur\EventIterator;

/**
 * iMIP handler.
 *
 * This class is responsible for sending out iMIP messages. iMIP is the
 * email-based transport for iTIP. iTIP deals with scheduling operations for
 * iCalendar objects.
 *
 * If you want to customize the email that gets sent out, you can do so by
 * extending this class and overriding the sendMessage method.
 *
 * @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
 * @author Evert Pot (http://evertpot.com/)
 * @license http://sabre.io/license/ Modified BSD License
 */
class IMipPlugin extends SabreIMipPlugin {

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

	/** @var ILogger */
	private $logger;

	/** @var ITimeFactory */
	private $timeFactory;

	const MAX_DATE = '2038-01-01';

	/**
	 * Creates the email handler.
	 *
	 * @param IMailer $mailer
	 * @param ILogger $logger
	 * @param ITimeFactory $timeFactory
	 */
	function __construct(IMailer $mailer, ILogger $logger, ITimeFactory $timeFactory) {

		parent::__construct('');
		$this->mailer = $mailer;
		$this->logger = $logger;
		$this->timeFactory = $timeFactory;
	}

	/**
	 * Event handler for the 'schedule' event.
	 *
	 * @param ITip\Message $iTipMessage
	 * @return void
	 */
	function schedule(ITip\Message $iTipMessage) {


		// Not sending any emails if the system considers the update
		// insignificant.
		if (!$iTipMessage->significantChange) {
			if (!$iTipMessage->scheduleStatus) {
				$iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
			}
			return;
		}

		$summary = $iTipMessage->message->VEVENT->SUMMARY;

		if (parse_url($iTipMessage->sender, PHP_URL_SCHEME) !== 'mailto') {
			return;
		}

		if (parse_url($iTipMessage->recipient, PHP_URL_SCHEME) !== 'mailto') {
			return;
		}

		// don't send out mails for events that already took place
		if ($this->isEventInThePast($iTipMessage->message)) {
			return;
		}

		$sender = substr($iTipMessage->sender, 7);
		$recipient = substr($iTipMessage->recipient, 7);

		$senderName = ($iTipMessage->senderName) ? $iTipMessage->senderName : null;
		$recipientName = ($iTipMessage->recipientName) ? $iTipMessage->recipientName : null;

		$subject = 'SabreDAV iTIP message';
		switch (strtoupper($iTipMessage->method)) {
			case 'REPLY' :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
				$subject = 'Re: ' . $summary;
				break;
			case 'REQUEST' :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
				$subject = $summary;
				break;
			case 'CANCEL' :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
				$subject = 'Cancelled: ' . $summary;
				break;
		}

		$contentType = 'text/calendar; charset=UTF-8; method=' . $iTipMessage->method;

		$message = $this->mailer->createMessage();

		$message->setReplyTo([$sender => $senderName])
			->setTo([$recipient => $recipientName])
			->setSubject($subject)
			->setBody($iTipMessage->message->serialize(), $contentType);
		try {
			$failed = $this->mailer->send($message);
			if ($failed) {

				$this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' =>  implode(', ', $failed)]);
				$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
			}
			$iTipMessage->scheduleStatus = '1.1; Scheduling message is sent via iMip';
		} catch(\Exception $ex) {
			$this->logger->logException($ex, ['app' => 'dav']);
			$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
		}
	}

	/**
	 * check if event took place in the past already
	 * @param VCalendar $vObject
	 * @return bool
	 */
	private function isEventInThePast(VCalendar $vObject) {
		$component = $vObject->VEVENT;

		$firstOccurrence = $component->DTSTART->getDateTime()->getTimeStamp();
		// Finding the last occurrence is a bit harder
		if (!isset($component->RRULE)) {
			if (isset($component->DTEND)) {
				$lastOccurrence = $component->DTEND->getDateTime()->getTimeStamp();
			} elseif (isset($component->DURATION)) {
				$endDate = clone $component->DTSTART->getDateTime();
				// $component->DTEND->getDateTime() returns DateTimeImmutable

				$endDate = $endDate->add(DateTimeParser::parse($component->DURATION->getValue()));
				$lastOccurrence = $endDate->getTimeStamp();
			} elseif (!$component->DTSTART->hasTime()) {
				$endDate = clone $component->DTSTART->getDateTime();
				// $component->DTSTART->getDateTime() returns DateTimeImmutable

				$endDate = $endDate->modify('+1 day');
				$lastOccurrence = $endDate->getTimeStamp();
			} else {
				$lastOccurrence = $firstOccurrence;
			}
		} else {
			$it = new EventIterator($vObject, (string)$component->UID);
			$maxDate = new \DateTime(self::MAX_DATE);
			if ($it->isInfinite()) {
				$lastOccurrence = $maxDate->getTimestamp();
			} else {
				$end = $it->getDtEnd();
				while($it->valid() && $end < $maxDate) {
					$end = $it->getDtEnd();
					$it->next();

				}
				$lastOccurrence = $end->getTimestamp();
			}
		}

		$currentTime = $this->timeFactory->getTime();
		return $lastOccurrence < $currentTime;
	}
}


1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		* @copyright Copyright (c) 2017, Georg Ehrke
5		*
6		* @author Thomas Müller <[email protected]>
7		* @author Georg Ehrke <[email protected]>
8		*
9		* @license AGPL-3.0
10		*
11		* This code is free software: you can redistribute it and/or modify
12		* it under the terms of the GNU Affero General Public License, version 3,
13		* as published by the Free Software Foundation.
14		*
15		* This program 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 License, version 3,
21		* along with this program. If not, see <http://www.gnu.org/licenses/>
22		*
23		*/
24		namespace OCA\DAV\CalDAV\Schedule;
25
26		use OCP\AppFramework\Utility\ITimeFactory;
27		use OCP\ILogger;
28		use OCP\Mail\IMailer;
29		use Sabre\VObject\Component\VCalendar;
30		use Sabre\VObject\DateTimeParser;
31		use Sabre\VObject\ITip;
32		use Sabre\CalDAV\Schedule\IMipPlugin as SabreIMipPlugin;
33		use Sabre\VObject\Recur\EventIterator;
34
35		/**
36		* iMIP handler.
37		*
38		* This class is responsible for sending out iMIP messages. iMIP is the
39		* email-based transport for iTIP. iTIP deals with scheduling operations for
40		* iCalendar objects.
41		*
42		* If you want to customize the email that gets sent out, you can do so by
43		* extending this class and overriding the sendMessage method.
44		*
45		* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
46		* @author Evert Pot (http://evertpot.com/)
47		* @license http://sabre.io/license/ Modified BSD License
48		*/
49		class IMipPlugin extends SabreIMipPlugin {
50
51		/** @var IMailer */
52		private $mailer;
53
54		/** @var ILogger */
55		private $logger;
56
57		/** @var ITimeFactory */
58		private $timeFactory;
59
60		const MAX_DATE = '2038-01-01';
61
62		/**
63		* Creates the email handler.
64		*
65		* @param IMailer $mailer
66		* @param ILogger $logger
67		* @param ITimeFactory $timeFactory
68		*/
69		function __construct(IMailer $mailer, ILogger $logger, ITimeFactory $timeFactory) {
		0 ignored issues – show Best Practice introduced 2017-06-08 10:20 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
70		parent::__construct('');
71		$this->mailer = $mailer;
72		$this->logger = $logger;
73		$this->timeFactory = $timeFactory;
74		}
75
76		/**
77		* Event handler for the 'schedule' event.
78		*
79		* @param ITip\Message $iTipMessage
80		* @return void
81		*/
82		function schedule(ITip\Message $iTipMessage) {
		0 ignored issues – show Best Practice introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
83
84		// Not sending any emails if the system considers the update
85		// insignificant.
86		if (!$iTipMessage->significantChange) {
87		if (!$iTipMessage->scheduleStatus) {
88		$iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
89		}
90		return;
91		}
92
93		$summary = $iTipMessage->message->VEVENT->SUMMARY;
94
95		if (parse_url($iTipMessage->sender, PHP_URL_SCHEME) !== 'mailto') {
96		return;
97		}
98
99		if (parse_url($iTipMessage->recipient, PHP_URL_SCHEME) !== 'mailto') {
100		return;
101		}
102
103		// don't send out mails for events that already took place
104		if ($this->isEventInThePast($iTipMessage->message)) {
105		return;
106		}
107
108		$sender = substr($iTipMessage->sender, 7);
109		$recipient = substr($iTipMessage->recipient, 7);
110
111		$senderName = ($iTipMessage->senderName) ? $iTipMessage->senderName : null;
112		$recipientName = ($iTipMessage->recipientName) ? $iTipMessage->recipientName : null;
113
114		$subject = 'SabreDAV iTIP message';
115		switch (strtoupper($iTipMessage->method)) {
116		case 'REPLY' :
		0 ignored issues – show Coding Style introduced 2017-07-18 19:18 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
117		$subject = 'Re: ' . $summary;
118		break;
119		case 'REQUEST' :
		0 ignored issues – show Coding Style introduced 2017-07-18 19:18 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
120		$subject = $summary;
121		break;
122		case 'CANCEL' :
		0 ignored issues – show Coding Style introduced 2017-07-18 19:18 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
123		$subject = 'Cancelled: ' . $summary;
124		break;
125		}
126
127		$contentType = 'text/calendar; charset=UTF-8; method=' . $iTipMessage->method;
128
129		$message = $this->mailer->createMessage();
130
131		$message->setReplyTo([$sender => $senderName])
132		->setTo([$recipient => $recipientName])
133		->setSubject($subject)
134		->setBody($iTipMessage->message->serialize(), $contentType);
135		try {
136		$failed = $this->mailer->send($message);
137		if ($failed) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-13 14:40 UTC by Report Bug Copy Issue Report The expression `$failed` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
138		$this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
139		$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
140		}
141		$iTipMessage->scheduleStatus = '1.1; Scheduling message is sent via iMip';
142		} catch(\Exception $ex) {
143		$this->logger->logException($ex, ['app' => 'dav']);
144		$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
145		}
146		}
147
148		/**
149		* check if event took place in the past already
150		* @param VCalendar $vObject
151		* @return bool
152		*/
153		private function isEventInThePast(VCalendar $vObject) {
154		$component = $vObject->VEVENT;
155
156		$firstOccurrence = $component->DTSTART->getDateTime()->getTimeStamp();
157		// Finding the last occurrence is a bit harder
158	View Code Duplication	if (!isset($component->RRULE)) {
159		if (isset($component->DTEND)) {
160		$lastOccurrence = $component->DTEND->getDateTime()->getTimeStamp();
161		} elseif (isset($component->DURATION)) {
162		$endDate = clone $component->DTSTART->getDateTime();
163		// $component->DTEND->getDateTime() returns DateTimeImmutable
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-09 10:27 UTC by Report Bug Copy Issue Report `42%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
164		$endDate = $endDate->add(DateTimeParser::parse($component->DURATION->getValue()));
165		$lastOccurrence = $endDate->getTimeStamp();
166		} elseif (!$component->DTSTART->hasTime()) {
167		$endDate = clone $component->DTSTART->getDateTime();
168		// $component->DTSTART->getDateTime() returns DateTimeImmutable
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-09 10:27 UTC by Report Bug Copy Issue Report `42%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
169		$endDate = $endDate->modify('+1 day');
170		$lastOccurrence = $endDate->getTimeStamp();
171		} else {
172		$lastOccurrence = $firstOccurrence;
173		}
174		} else {
175		$it = new EventIterator($vObject, (string)$component->UID);
176		$maxDate = new \DateTime(self::MAX_DATE);
177		if ($it->isInfinite()) {
178		$lastOccurrence = $maxDate->getTimestamp();
179		} else {
180		$end = $it->getDtEnd();
181		while($it->valid() && $end < $maxDate) {
182		$end = $it->getDtEnd();
183		$it->next();
184
185		}
186		$lastOccurrence = $end->getTimestamp();
187		}
188		}
189
190		$currentTime = $this->timeFactory->getTime();
191		return $lastOccurrence < $currentTime;
192		}
193		}
194

nextcloud / server

Push — master ( 485e22...5184f3 )

IMipPlugin::schedule() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like