OCA\Calendar\Db\Object

Complexity

Total Complexity

56

Size/Duplication

Total Lines	457
Duplicated Lines	8.53 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	6
Bugs	1	Features	0

29 Methods

Rating	Name	Duplication	Size	Complexity
A	fromVObject()	0	5	1
A	setCalendar()	0	3	1
A	getCalendar()	0	3	1
A	getCalendarid()	0	3	1
A	setUri()	0	3	1
A	getUri()	0	3	1
A	setEtag()	0	3	1
A	getEtag()	0	7	3
A	setRuds()	0	7	2
B	getRuds()	0	14	5
B	setVObject()	0	25	4
B	getVObject()	0	29	4
A	getUpdatedFields()	0	19	2
A	touch()	0	7	1
A	doesAllow()	0	3	1
A	getCalendarData()	0	3	1
A	setCalendarData()	0	12	3
A	generateEtag()	0	6	1
A	getType()	0	5	1
A	getStartDate()	10	10	3
A	getEndDate()	10	10	3
A	getRepeating()	0	7	2
A	getSummary()	9	9	2
A	getLastModified()	10	10	2
A	isInTimeRange()	0	4	1
A	getObjectName()	0	3	1
A	registerTypes()	0	10	1
A	registerMandatory()	0	5	1
B	isValid()	0	15	5

<?php
/**
 * ownCloud - Calendar App
 *
 * @author Georg Ehrke
 * @copyright 2014 Georg Ehrke <oc.list@georgehrke.com>
 *
 * 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\Db;

use OCA\Calendar\CorruptDataException;
use OCA\Calendar\ICalendar;
use OCA\Calendar\IObject;
use Sabre\VObject\Component\VCalendar;
use Sabre\VObject\Reader;
use Sabre\VObject\ParseException;
use Sabre\VObject\Property\Text as TextProperty;
use Sabre\VObject\Property\Integer as IntegerProperty;
use Sabre\VObject\Property\ICalendar\DateTime as SDateTime;
use Sabre\VObject\Property\ICalendar\Date as SDate;
use OCA\Calendar\Utility\SabreUtility;
use DateTime;

class Object extends Entity implements IObject {

There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: columnToProperty, fromParams, fromRow, propertyToColumn, resetUpdatedFields, slugify

	/**
	 * @var integer
	 */
	public $id;


	/**
	 * @var ICalendar
	 */
	public $calendar;


	/**
	 * @var string
	 */
	public $uri;


	/**
	 * @var string
	 */
	public $etag;


	/**
	 * @var integer
	 */
	public $ruds;


	/**
	 * @var VCalendar
	 */
	public $vObject;


	/**
	 * @var string
	 */
	private $objectName;


	/**
	 * take data from vobject and put into this Object object
	 * @param VCalendar $vcalendar
	 * @throws CorruptDataException
	 * @return $this
	 */
	public static function fromVObject(VCalendar $vcalendar) {
		/** @var Object $instance */
		$instance = new static();
		return $instance->setVObject($vcalendar, true);
	}


	/**
	 * @param ICalendar $calendar
	 * @return $this
	 */
	public function setCalendar(ICalendar $calendar) {
		return $this->setter('calendar', [$calendar]);
	}


	/**
	 * @return ICalendar
	 */
	public function getCalendar() {
		return $this->getter('calendar');
	}

	public function getCalendarid() {
		return $this->getCalendar()->getId();
	}


	/**
	 * @param string $uri
	 * @return $this
	 */
	public function setUri($uri) {
		return $this->setter('uri', [$uri]);
	}


	/**
	 * @return string
	 */
	public function getUri() {
		return $this->getter('uri');
	}


	/**
	 * @param string $etag
	 * @return $this
	 */
	public function setEtag($etag) {
		return $this->setter('etag', [$etag]);
	}


	/**
	 * @param bool $force generate etag if none stored
	 * @return mixed (string|null)
	 */
	public function getEtag($force=false) {
		if ($force && $this->etag === null) {
			$this->generateEtag();
		}

		return $this->getter('etag');
	}


	/**
	 * @param integer $ruds
	 * @return $this
	 */
	public function setRuds($ruds) {
		if ($ruds & Permissions::CREATE) {
			$ruds -= Permissions::CREATE;
		}

		$this->setter('ruds', [$ruds]);
	}


	/**
	 * @param boolean $force return value all the time
	 * @return mixed (integer|null)
	 */
	public function getRuds($force=false) {
		if ($force && $this->ruds === null) {
			if ($this->calendar instanceof ICalendar) {
				$cruds = $this->calendar->getCruds();
				if ($cruds & Permissions::CREATE) {
					return $cruds - Permissions::CREATE;
				} else {
					return $cruds;
				}
			}
		}

		return $this->getter('ruds');
	}


	/**
	 * @param VCalendar $vobject
	 * @param boolean $autoAssignUri
	 * @throws CorruptDataException
	 * @return $this
	 */
	public function setVObject(VCalendar $vobject, $autoAssignUri=false) {
		$uidCount = SabreUtility::countUniqueUIDs($vobject);
		$objectName = SabreUtility::getObjectName($vobject);

		if ($uidCount === 0) {
			throw new CorruptDataException(
				'Object may not be empty!'
			);
		}
		if ($uidCount > 1) {
			throw new CorruptDataException(
				'Resource can\'t store multiple objects'
			);
		}

		$this->setter('vObject', [$vobject]);
		$this->objectName = $objectName;

It seems like $objectName can also be of type boolean. However, the property $objectName is declared as type string. Maybe add an additional type check?

		if ($autoAssignUri) {
			$uid = $this->vObject->{$this->getObjectName()}->{'UID'}->getValue();
			$this->setUri($uid . '.ics');
		}

		return $this;
	}


	/**
	 * @return VCalendar
	 */
	public function getVObject() {
		$vobject =  $this->getter('vObject');
		$objectName = $this->getObjectName();

		$props = [
			new TextProperty($vobject, 'X-OC-URI', $this->getUri()),
			new TextProperty($vobject, 'X-OC-ETAG', $this->getEtag(true)),
			new IntegerProperty($vobject, 'X-OC-RUDS', $this->getRuds())
		];

		/** @var \Sabre\vobject\Component\VCalendar $vobject */
		$_objects = $vobject->select($objectName);
		$vobject->remove($objectName);
		foreach($_objects as &$_object) {
			/** @var \Sabre\VObject\Component $_object */
			foreach ($props as $prop) {
				/** @var \Sabre\VObject\Property $prop */
				if ($prop->getValue() === null) {
					continue;
				} else {
					$_object->remove($prop->name);
					$_object->add($prop);
				}
			}
			$vobject->add($_object);
		}

		return $vobject;
	}


	/**
	 * @return array array of updated fields for update query
	 */
	public function getUpdatedFields() {
		$updatedFields = parent::getUpdatedFields();

		$properties = [
			'uri', 'type', 'startDate',
			'endDate', 'calendarid', 'repeating',
			'summary', 'calendarData', 'lastModified',
		];

		foreach($properties as $property) {
			$updatedFields[$property] = true;
		}

		unset($updatedFields['calendar']);
		unset($updatedFields['vobject']);
		unset($updatedFields['objectName']);

		return $updatedFields;
	}


	/**
	 * set lastModified to now and update ETag
	 * @return $this
	 */
	public function touch() {
		$now = new DateTime();
		//TODO - fix for multiple objects
		$this->vObject->{$this->getObjectName()}->{'LAST-MODIFIED'}->setDateTime($now);
		$this->generateEtag();
		return $this;
	}


	/**
	 * does an object allow
	 * @param integer $cruds
	 * @return integer
	 */
	public function doesAllow($cruds) {
		return ($this->ruds & $cruds);

The return type of return $this->ruds & $cruds; (integer) is incompatible with the return type declared by the interface OCA\Calendar\IObject::doesAllow of type boolean.

	}


	/**
	 * get text/calendar representation of stored object
	 * @return integer
	 */
	public function getCalendarData() {
		return $this->vObject->serialize();
	}


	/**
	 * set the calendarData
	 * @param string $data CalendarData
	 * @throws CorruptDataException
	 * @return $this
	 */
	public function setCalendarData($data) {
		try {
			$vobject = Reader::read($data);
			if (!($vobject instanceof VCalendar)) {

The class Sabre\VObject\Component\VCalendar does not exist. Did you forget a USE statement, or did you not list all dependencies?

				$msg = 'CalendarData is not actual calendar-data!';
				throw new CorruptDataException($msg);
			}
			return $this->setVObject($vobject);
		} catch(ParseException $ex) {

The class Sabre\VObject\ParseException does not exist. Did you forget a USE statement, or did you not list all dependencies?

			throw new CorruptDataException($ex->getMessage(), $ex->getCode(), $ex);
		}
	}


	/**
	 * update Etag
	 * @return $this
	 */
	public function generateEtag() {
		$etag  = $this->getUri();
		$etag .= $this->getCalendarData();

		return $this->setter('etag', [md5($etag)]);
	}


	/**
	 * get type of stored object
	 * @return integer
	 */
	public function getType() {
		return ObjectType::getTypeByString(
			$this->getObjectName()
		);
	}


	/**
	 * get startDate
	 * @return DateTime
	 */
	public function getStartDate() {

This method seems to be duplicated in your project.

		/** @var \Sabre\VObject\Component $object */
		$object = $this->vObject->{$this->getObjectName()};
		$realStart = SabreUtility::getDTStart($object);
		if ($realStart instanceof SDateTime || $realStart instanceof SDate) {

The class Sabre\VObject\Property\ICalendar\DateTime does not exist. Did you forget a USE statement, or did you not list all dependencies?

The class Sabre\VObject\Property\ICalendar\Date does not exist. Did you forget a USE statement, or did you not list all dependencies?

			return $realStart->getDateTime();
		} else {
			return null;
		}
	}


	/**
	 * get endDate
	 * @return DateTime
	 */
	public function getEndDate() {

This method seems to be duplicated in your project.

		/** @var \Sabre\VObject\Component $object */
		$object = $this->vObject->{$this->getObjectName()};
		$realEnd = SabreUtility::getDTEnd($object);
		if ($realEnd instanceof SDateTime || $realEnd instanceof SDate) {

The class Sabre\VObject\Property\ICalendar\DateTime does not exist. Did you forget a USE statement, or did you not list all dependencies?

The class Sabre\VObject\Property\ICalendar\Date does not exist. Did you forget a USE statement, or did you not list all dependencies?

			return $realEnd->getDateTime();
		} else {
			return null;
		}
	}


	/**
	 * get whether or not object is repeating
	 * @return boolean
	 */
	public function getRepeating() {
		$objectName = $this->getObjectName();

		//TODO - fix for multiple objects
		return (isset($this->vObject->{$objectName}->{'RRULE'}) ||
				isset($this->vObject->{$objectName}->{'RDATE'}));
	}


	/**
	 * get summary of object
	 * @return mixed (string|null)
	 */
	public function getSummary() {

This method seems to be duplicated in your project.

		$objectName = $this->getObjectName();

		if (isset($this->vObject->{$objectName}->{'SUMMARY'})) {
			return $this->vObject->{$objectName}->{'SUMMARY'}->getValue();
		}

		return null;
	}


	/**
	 * get last modified of object
	 * @return mixed (DateTime|null)
	 */
	public function getLastModified() {

This method seems to be duplicated in your project.

		$objectName = $this->getObjectName();

		//TODO - fix for multiple objects
		if (isset($this->vObject->{$objectName}->{'LAST-MODIFIED'})) {
			return $this->vObject->{$objectName}->{'LAST-MODIFIED'}->getDateTime();
		}

		return null;
	}


	/**
	 * @param DateTime $start
	 * @param DateTime $end
	 * @return boolean
	 */
	public function isInTimeRange(DateTime $start, DateTime $end) {
		$objectName = $this->getObjectName();
		return $this->vObject->{$objectName}->isInTimeRange($start, $end);
	}


	/**
	 * get name of property inside $this->vobject
	 * @return string
	 */
	private function getObjectName() {
		return $this->objectName;
	}


	/**
	 * register field types
	 */
	protected function registerTypes() {
		$this->addType('uri', 'string');
		$this->addType('etag', 'string');
		$this->addType('ruds', 'integer');

		$this->addAdvancedFieldType('calendar',
			'OCA\\Calendar\\ICalendar');
		$this->addAdvancedFieldType('vObject',
			'Sabre\\VObject\\Component\\VCalendar');
	}


	/**
	 * register mandatory fields
	 */
	protected function registerMandatory() {
		$this->addMandatory('calendar');
		$this->addMandatory('uri');
		$this->addMandatory('vObject');
	}


	/**
	 * check if object is valid
	 * @return bool
	 */
	public function isValid() {
		$typeChecker = parent::isValid();
		if (!$typeChecker) {
			return false;
		}

		$validate = $this->vObject->validate();
		foreach ($validate as $item) {
			if (isset($item['level']) && intval($item['level']) === 3) {
				return false;
			}
		}

		return true;
	}
}