Object::generateEtag() - Code Metrics - Inspection of "fix calendarlistcontroller tests" - owncloud/calendar - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix_broken_js_unit_test-d6ae96... ( d6ae96 )

by Thomas

created 2016-07-26 14:47 UTC

Object::generateEtag() A

↳ Parent: Object

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php
/**
 * ownCloud - Calendar App
 *
 * @author Georg Ehrke
 * @copyright 2014 Georg Ehrke <[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\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 {


	/**
	 * @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;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

		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);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}


	/**
	 * 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)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				$msg = 'CalendarData is not actual calendar-data!';
				throw new CorruptDataException($msg);
			}
			return $this->setVObject($vobject);
		} catch(ParseException $ex) {

			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() {

		/** @var \Sabre\VObject\Component $object */
		$object = $this->vObject->{$this->getObjectName()};
		$realStart = SabreUtility::getDTStart($object);
		if ($realStart instanceof SDateTime || $realStart instanceof SDate) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return $realStart->getDateTime();
		} else {
			return null;
		}
	}


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

		/** @var \Sabre\VObject\Component $object */
		$object = $this->vObject->{$this->getObjectName()};
		$realEnd = SabreUtility::getDTEnd($object);
		if ($realEnd instanceof SDateTime || $realEnd instanceof SDate) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			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() {

		$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() {

		$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;
	}
}

Push — fix_broken_js_unit_test-d6ae96... ( d6ae96 )

Object::generateEtag() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2			/**
3			* ownCloud - Calendar App
4			*
5			* @author Georg Ehrke
6			* @copyright 2014 Georg Ehrke <[email protected]>
7			*
8			* This library is free software; you can redistribute it and/or
9			* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10			* License as published by the Free Software Foundation; either
11			* version 3 of the License, or any later version.
12			*
13			* This library is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public
19			* License along with this library. If not, see <http://www.gnu.org/licenses/>.
20			*
21			*/
22			namespace OCA\Calendar\Db;
23
24			use OCA\Calendar\CorruptDataException;
25			use OCA\Calendar\ICalendar;
26			use OCA\Calendar\IObject;
27			use Sabre\VObject\Component\VCalendar;
28			use Sabre\VObject\Reader;
29			use Sabre\VObject\ParseException;
30			use Sabre\VObject\Property\Text as TextProperty;
31			use Sabre\VObject\Property\Integer as IntegerProperty;
32			use Sabre\VObject\Property\ICalendar\DateTime as SDateTime;
33			use Sabre\VObject\Property\ICalendar\Date as SDate;
34			use OCA\Calendar\Utility\SabreUtility;
35			use DateTime;
36
37			class Object extends Entity implements IObject {
			0 ignored issues – show Bug introduced 2016-07-26 15:00 UTC by Report Bug Copy Issue Report 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 Loading history...
38
39			/**

owncloud / calendar

Push — fix_broken_js_unit_test-d6ae96... ( d6ae96 )

Object::generateEtag() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like