OCA\Calendar\Cache\Object\Scanner

Complexity

Total Complexity

25

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	21	3
B	scanObject()	0	25	5
B	getRemoteAndDeleteIfNecessary()	0	24	5
A	getCached()	0	11	3
A	addToCache()	0	3	1
A	updateCache()	0	3	1
A	removeFromCache()	0	3	1
A	scan()	0	18	4
A	isCalendarsBackendValid()	0	3	2

<?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\Cache\Object;

use OCA\Calendar\Backend\DoesNotExistException;
use OCA\Calendar\Backend\MultipleObjectsReturnedException;
use OCA\Calendar\Backend\TemporarilyNotAvailableException;
use OCA\Calendar\CorruptDataException;
use OCA\Calendar\IBackend;
use OCA\Calendar\ICalendar;
use OCA\Calendar\IObject;

use OCA\Calendar\Backend\IObjectAPI;
use OCA\Calendar\Backend as BackendUtils;
use OCP\ILogger;

use OCP\AppFramework\Db\DoesNotExistException as DoesNotExistMapperException;
use OCP\AppFramework\Db\MultipleObjectsReturnedException as MultipleObjectsReturnedMapperException;

class Scanner {

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


	/**
	 * @var \OCA\Calendar\Cache\Object\Cache
	 */
	protected $cache;


	/**
	 * @var \OCA\Calendar\Backend\IObjectAPI
	 */
	protected $objectAPI;


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


	/**
	 * @param ICalendar $calendar
	 */
	public function __construct(ICalendar $calendar) {
		$this->calendar = $calendar;

		$backend = $this->calendar->getBackend();
		if (!($backend instanceof IBackend)) {
			$identifier = implode('::', [
				$this->calendar->getUserId(),
				'?',
				$this->calendar->getPrivateUri(),
			]);

			$this->logger->error('Backend of calendar \'' . $identifier . '\' not found');
		} else {
			$this->cache = $backend->getObjectCache($calendar);
			try {
				$this->objectAPI = $backend->getObjectAPI($calendar);
		 	} catch (BackendUtils\Exception $ex) {
				//TODO
			}
		}
	}


	/**
	 * @param $objectUri
	 */
	public function scanObject($objectUri) {
		if (!$this->isCalendarsBackendValid()) {
			return;
		}

		$object = $this->getRemoteAndDeleteIfNecessary($objectUri);
		if (!$object) {
			return;
		}

		try {
			$cached = $this->getCached($objectUri);
		} catch (CorruptDataException $ex) {
			//TODO log $ex->getMessage();

			return;
		}

		if ($cached) {
			$object->setId($cached->getId());
			$this->updateCache($object);
		} else {
			$this->addToCache($object);
		}
	}


	/**
	 * @param $objectUri
	 * @return null|IObject
	 */
	protected function getRemoteAndDeleteIfNecessary($objectUri) {
		try {
			return $this->objectAPI->find($objectUri);
		} catch(DoesNotExistException $ex) {
			//$this->logger->debug($msg);

			$this->removeFromCache($objectUri);
			return null;
		} catch(MultipleObjectsReturnedException $ex) {
			//$this->logger->warn($msg);

			$this->removeFromCache($objectUri);
			return null;
		} catch(TemporarilyNotAvailableException $ex) {
			//$this->logger->debug($msg);

			return null;
		} catch(CorruptDataException $ex) {
			//$this->logger->debug($msg);

			$this->removeFromCache($objectUri);
			return null;
		}
	}


	/**
	 * @param $objectUri
	 * @return null|IObject
	 */
	protected function getCached($objectUri) {
		try {
			return $this->cache->find($objectUri);
		} catch(DoesNotExistMapperException $ex) {

The class OCP\AppFramework\Db\DoesNotExistException does not exist. Did you forget a USE statement, or did you not list all dependencies?

			return null;
		} catch(MultipleObjectsReturnedMapperException $ex) {

The class OCP\AppFramework\Db\MultipleObjectsReturnedException does not exist. Did you forget a USE statement, or did you not list all dependencies?

			//$this->logger->warn($msg);

			return null;
		}
	}


	/**
	 * @param IObject $object
	 */
	protected function addToCache(IObject $object) {
		$this->cache->insert($object);
	}


	/**
	 * @param IObject $object
	 */
	protected function updateCache(IObject $object) {
		$this->cache->update($object);
	}


	/**
	 * @param string $objectUri
	 */
	protected function removeFromCache($objectUri) {
		$this->cache->deleteList([$objectUri]);
	}


	/**
	 * scan calendar for changed objects
	 */
	public function scan() {
		if (!$this->isCalendarsBackendValid()) {
			return;
		}

		$cachedList = $this->cache->listAll();
		try {
			$remoteList = $this->objectAPI->listAll();
		} catch(BackendUtils\Exception $ex) {
			return;
		}

		$list = array_merge($cachedList, $remoteList);

		foreach($list as $l) {
			$this->scanObject($l);
		}
	}


	/**
	 * @return boolean
	 */
	private function isCalendarsBackendValid() {
		return ($this->objectAPI instanceof IObjectAPI && $this->cache instanceof Cache);
	}


}