smtech / canvas-ics-sync

src/SyncIntoCanvas/Syncable.php

Doc Comments -1 removed lines

@@ -53,7 +53,6 @@
     /**
      * Update the MySQL connection
      *
-     * @param PDO $db
      * @throws Exception If `$db` is null
      */
     public static function setDatabase(PDO $database)

Indentation +97 added lines, -97 removed lines

@@ -12,110 +12,110 @@
  */
 abstract class Syncable
 {
-    /**
-     * Database connection
-     *
-     * @var PDO|null
-     */
-    protected static $database;
+	/**
+	 * Database connection
+	 *
+	 * @var PDO|null
+	 */
+	protected static $database;
 
-    /**
-     * Canvas API connection
-     *
-     * @var CanvasPest|null
-     */
-    protected static $api;
+	/**
+	 * Canvas API connection
+	 *
+	 * @var CanvasPest|null
+	 */
+	protected static $api;
 
-    /**
-     * Unique timestamp for the current sync
-     * @var string
-     */
-    protected static $syncTimestamp;
+	/**
+	 * Unique timestamp for the current sync
+	 * @var string
+	 */
+	protected static $syncTimestamp;
 
-    /**
-     * Generate a unique identifier for this synchronization pass
-     **/
-    public static function getSyncTimestamp()
-    {
-        if (empty(static::$syncTimestamp)) {
-            $timestamp = new DateTime();
-            static::$syncTimestamp =
-                $timestamp->format(Constants::SYNC_TIMESTAMP_FORMAT) .
-                Constants::SEPARATOR . md5(
-                    (php_sapi_name() == 'cli' ?
-                        'cli' : $_SERVER['REMOTE_ADDR']
-                    ) . time()
-                );
-        }
-        return static::$syncTimestamp;
-    }
+	/**
+	 * Generate a unique identifier for this synchronization pass
+	 **/
+	public static function getSyncTimestamp()
+	{
+		if (empty(static::$syncTimestamp)) {
+			$timestamp = new DateTime();
+			static::$syncTimestamp =
+				$timestamp->format(Constants::SYNC_TIMESTAMP_FORMAT) .
+				Constants::SEPARATOR . md5(
+					(php_sapi_name() == 'cli' ?
+						'cli' : $_SERVER['REMOTE_ADDR']
+					) . time()
+				);
+		}
+		return static::$syncTimestamp;
+	}
 
-    /**
-     * Update the MySQL connection
-     *
-     * @param PDO $db
-     * @throws Exception If `$db` is null
-     */
-    public static function setDatabase(PDO $database)
-    {
-        if (empty($database)) {
-            throw new Exception(
-                'A non-null database connection is required'
-            );
-        } else {
-            static::$database = $database;
-        }
-    }
+	/**
+	 * Update the MySQL connection
+	 *
+	 * @param PDO $db
+	 * @throws Exception If `$db` is null
+	 */
+	public static function setDatabase(PDO $database)
+	{
+		if (empty($database)) {
+			throw new Exception(
+				'A non-null database connection is required'
+			);
+		} else {
+			static::$database = $database;
+		}
+	}
 
-    /**
-     * Get the MySQL connection
-     *
-     * @return mysqli
-     */
-    public static function getDatabase()
-    {
-        return static::$db;
-    }
+	/**
+	 * Get the MySQL connection
+	 *
+	 * @return mysqli
+	 */
+	public static function getDatabase()
+	{
+		return static::$db;
+	}
 
-    /**
-     * Update the API connection
-     *
-     * @param CanvasPest $api
-     * @throws Exception if `$api` is null
-     */
-    public static function setApi(CanvasPest $api)
-    {
-        if (empty($api)) {
-            throw new Exception(
-                'A non-null API connection is required'
-            );
-        } else {
-            static::$api = $api;
-        }
-    }
+	/**
+	 * Update the API connection
+	 *
+	 * @param CanvasPest $api
+	 * @throws Exception if `$api` is null
+	 */
+	public static function setApi(CanvasPest $api)
+	{
+		if (empty($api)) {
+			throw new Exception(
+				'A non-null API connection is required'
+			);
+		} else {
+			static::$api = $api;
+		}
+	}
 
-    /**
-     * Get the API connection
-     *
-     * @return CanvasPest|null
-     */
-    public static function getApi()
-    {
-        return static::$api;
-    }
+	/**
+	 * Get the API connection
+	 *
+	 * @return CanvasPest|null
+	 */
+	public static function getApi()
+	{
+		return static::$api;
+	}
 
-    /**
-     * Save the syncable object to the MySQL database
-     *
-     * @return [type] [description]
-     */
-    abstract public function save();
+	/**
+	 * Save the syncable object to the MySQL database
+	 *
+	 * @return [type] [description]
+	 */
+	abstract public function save();
 
-    /**
-     * Load a syncable object from the MySQL database
-     *
-     * @param int $id
-     * @return Syncable|null
-     */
-    abstract public static function load($id);
+	/**
+	 * Load a syncable object from the MySQL database
+	 *
+	 * @param int $id
+	 * @return Syncable|null
+	 */
+	abstract public static function load($id);
 }

src/SyncIntoCanvas/CalendarContext.php

Indentation +84 added lines, -84 removed lines

@@ -4,107 +4,107 @@
 
 class CalendarContext
 {
-    /**
-     * The canonical URL for this context in Canvas
-     * @var string
-     */
-    protected $canonicalUrl;
+	/**
+	 * The canonical URL for this context in Canvas
+	 * @var string
+	 */
+	protected $canonicalUrl;
 
-    /**
-     * The context for this calendar in Canvas (user, group, course)
-     * @var CanvasContext
-     */
-    protected $context;
+	/**
+	 * The context for this calendar in Canvas (user, group, course)
+	 * @var CanvasContext
+	 */
+	protected $context;
 
-    /**
-     * Unique ID for this Canvas context
-     * @var int
-     */
-    protected $id;
+	/**
+	 * Unique ID for this Canvas context
+	 * @var int
+	 */
+	protected $id;
 
-    /**
-     * URL to verify this context against API
-     * @var string
-     */
-    protected $verificationUrl;
+	/**
+	 * URL to verify this context against API
+	 * @var string
+	 */
+	protected $verificationUrl;
 
-    /**
-     * Compute the calendar context for the canvas object based on its URL
-     *
-     * @param string $canvasUrl URL to the context for a calendar on this
-     *     Canvas instance
-     * @throws Exception If `$canvasInstance` is not a URL on this Canvas
-     *     instance
-     * @throws Exception if `$canvasInstance` is not a URL to a recognizable
-     *     calendar context
-     */
-    public function __construct($canvasUrl)
-    {
-        /*
+	/**
+	 * Compute the calendar context for the canvas object based on its URL
+	 *
+	 * @param string $canvasUrl URL to the context for a calendar on this
+	 *     Canvas instance
+	 * @throws Exception If `$canvasInstance` is not a URL on this Canvas
+	 *     instance
+	 * @throws Exception if `$canvasInstance` is not a URL to a recognizable
+	 *     calendar context
+	 */
+	public function __construct($canvasUrl)
+	{
+		/*
          * TODO: accept calendar2?contexts links too (they would be an intuitively obvious link to use, after all)
          */
-        /*
+		/*
          * FIXME: users aren't working
          */
-        /*
+		/*
          * TODO: it would probably be better to look up users by email address than URL
          */
-        /* get the context (user, course or group) for the canvas URL */
-        if (preg_match('%(https?://)?(' . parse_url($_SESSION[Constants::CANVAS_INSTANCE_URL], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
-            $this->canonicalUrl = "https://{$match[2]}"; // https://stmarksschool.instructure.com/courses/953
+		/* get the context (user, course or group) for the canvas URL */
+		if (preg_match('%(https?://)?(' . parse_url($_SESSION[Constants::CANVAS_INSTANCE_URL], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
+			$this->canonicalUrl = "https://{$match[2]}"; // https://stmarksschool.instructure.com/courses/953
 
-            // course or account groups
-            if (isset($match[9]) || isset($match[11])) {
-                $this->context = CanvasContext::GROUP(); // used for context_code in events
-                $this->id = ($match[9] > $match[11] ? $match[9] : $match[11]);
-                $this->verificationUrl = "groups/{$this->id}"; // used once to look up the object to be sure it really exists
+			// course or account groups
+			if (isset($match[9]) || isset($match[11])) {
+				$this->context = CanvasContext::GROUP(); // used for context_code in events
+				$this->id = ($match[9] > $match[11] ? $match[9] : $match[11]);
+				$this->verificationUrl = "groups/{$this->id}"; // used once to look up the object to be sure it really exists
 
-            // courses
-            } elseif (isset($match[7])) {
-                $this->context = CanvasContext::COURSE();
-                $this->id = $match[7];
-                $this->verificationUrl = "courses/{$this->id}";
+			// courses
+			} elseif (isset($match[7])) {
+				$this->context = CanvasContext::COURSE();
+				$this->id = $match[7];
+				$this->verificationUrl = "courses/{$this->id}";
 
-            // users
-            } elseif (isset($match[5])) {
-                $this->context = CanvasContext::USER();
-                $this->id = $match[5];
-                $this->verificationUrl = "users/{$this->id}/profile";
+			// users
+			} elseif (isset($match[5])) {
+				$this->context = CanvasContext::USER();
+				$this->id = $match[5];
+				$this->verificationUrl = "users/{$this->id}/profile";
 
-            // we're somewhere where we don't know where we are
-            } else {
-                throw new Exception(
-                    "'$canvasUrl' is not a recognizable calendar context"
-                );
-            }
-        }
-        throw new Exception(
-            "'$canvasUrl' is not recognized as a URL to a calendar context on this Canvas instance"
-        );
-    }
+			// we're somewhere where we don't know where we are
+			} else {
+				throw new Exception(
+					"'$canvasUrl' is not a recognizable calendar context"
+				);
+			}
+		}
+		throw new Exception(
+			"'$canvasUrl' is not recognized as a URL to a calendar context on this Canvas instance"
+		);
+	}
 
-    public function getCanonicalUrl()
-    {
-        return $this->canonicalUrl;
-    }
+	public function getCanonicalUrl()
+	{
+		return $this->canonicalUrl;
+	}
 
-    public function getContext()
-    {
-        return $this->context;
-    }
+	public function getContext()
+	{
+		return $this->context;
+	}
 
-    public function getId()
-    {
-        return $this->id;
-    }
+	public function getId()
+	{
+		return $this->id;
+	}
 
-    public function getVerificationUrl()
-    {
-        return $this->verificationUrl;
-    }
+	public function getVerificationUrl()
+	{
+		return $this->verificationUrl;
+	}
 
-    public function __toString()
-    {
-        return $this->getContext();
-    }
+	public function __toString()
+	{
+		return $this->getContext();
+	}
 }

src/SyncIntoCanvas/Calendar.php

Indentation +330 added lines, -330 removed lines

@@ -10,166 +10,166 @@ 
 
 class Calendar
 {
-    /**
-     * Canvas calendar context
-     * @var CalendarContext
-     */
-    protected $context;
+	/**
+	 * Canvas calendar context
+	 * @var CalendarContext
+	 */
+	protected $context;
 
-    /**
-     * ICS or webcal feed URL
-     * @var string
-     */
-    protected $feedUrl;
+	/**
+	 * ICS or webcal feed URL
+	 * @var string
+	 */
+	protected $feedUrl;
 
-    /**
-     * Name of this calendar (extracted from feed)
-     * @var string
-     */
-    protected $name;
+	/**
+	 * Name of this calendar (extracted from feed)
+	 * @var string
+	 */
+	protected $name;
 
-    /**
-     * Filter for events in this calendar
-     * @var Filter
-     */
-    protected $filter;
+	/**
+	 * Filter for events in this calendar
+	 * @var Filter
+	 */
+	protected $filter;
 
-    /**
-     * Construct a Calendar object
-     *
-     * @param string $canvasUrl URL of a Canvas calendar context
-     * @param string $feedUrl URL of a webcal or ICS calendar feed
-     * @param boolean $enableFilter (Optional, default `false`)
-     * @param string $include (Optional) Regular expression to select events
-     *     for inclusion in the calendar sync
-     * @param string $exclude (Optional) Regular expression to select events
-     *     for exclusion from the calendar sync
-     */
-    public function __construct($canvasUrl, $feedUrl, $enableFilter = false, $include = null, $exclude = null)
-    {
-        $this->setContext(new CalendarContext($canvasUrl));
-        $this->setFeed($feedUrl);
-        $this->setFilter(new Filter(
-            $enableFilter,
-            $include,
-            $exclude
-        ));
-    }
+	/**
+	 * Construct a Calendar object
+	 *
+	 * @param string $canvasUrl URL of a Canvas calendar context
+	 * @param string $feedUrl URL of a webcal or ICS calendar feed
+	 * @param boolean $enableFilter (Optional, default `false`)
+	 * @param string $include (Optional) Regular expression to select events
+	 *     for inclusion in the calendar sync
+	 * @param string $exclude (Optional) Regular expression to select events
+	 *     for exclusion from the calendar sync
+	 */
+	public function __construct($canvasUrl, $feedUrl, $enableFilter = false, $include = null, $exclude = null)
+	{
+		$this->setContext(new CalendarContext($canvasUrl));
+		$this->setFeed($feedUrl);
+		$this->setFilter(new Filter(
+			$enableFilter,
+			$include,
+			$exclude
+		));
+	}
 
-    /**
-     * Set the Canvas calendar context
-     *
-     * @param CalendarContext $context
-     * @throws Exception If `$context` is null
-     */
-    public function setContext(CalendarContext $context)
-    {
-        if (!empty($context)) {
-            $this->context = $context;
-        } else {
-            throw new Exception(
-                'Context cannot be null'
-            );
-        }
-    }
+	/**
+	 * Set the Canvas calendar context
+	 *
+	 * @param CalendarContext $context
+	 * @throws Exception If `$context` is null
+	 */
+	public function setContext(CalendarContext $context)
+	{
+		if (!empty($context)) {
+			$this->context = $context;
+		} else {
+			throw new Exception(
+				'Context cannot be null'
+			);
+		}
+	}
 
-    /**
-     * Get the Canvas calendar context
-     *
-     * @return CalendarContext
-     */
-    public function getContext()
-    {
-        return $this->context;
-    }
+	/**
+	 * Get the Canvas calendar context
+	 *
+	 * @return CalendarContext
+	 */
+	public function getContext()
+	{
+		return $this->context;
+	}
 
-    /**
-     * Set the webcal or ICS feed URl for this calendar
-     *
-     * @param string $feedUrl
-     * @throws Exception If `$feedUrl` is not a valid URL
-     */
-    public function setFeedUrl($feedUrl)
-    {
-        if (!empty($feedUrl)) {
-            /* crude test to see if the feed is a valid URL */
-            $handle = fopen($feedUrl, 'r');
-            if ($handle !== false) {
-                $this->feedUrl = $feedUrl;
-            }
-        }
-        throw new Exception(
-            'Feed must be a valid URL'
-        );
-    }
+	/**
+	 * Set the webcal or ICS feed URl for this calendar
+	 *
+	 * @param string $feedUrl
+	 * @throws Exception If `$feedUrl` is not a valid URL
+	 */
+	public function setFeedUrl($feedUrl)
+	{
+		if (!empty($feedUrl)) {
+			/* crude test to see if the feed is a valid URL */
+			$handle = fopen($feedUrl, 'r');
+			if ($handle !== false) {
+				$this->feedUrl = $feedUrl;
+			}
+		}
+		throw new Exception(
+			'Feed must be a valid URL'
+		);
+	}
 
-    /**
-     * Get the feed URL for this calendar
-     *
-     * @return string
-     */
-    public function getFeedUrl()
-    {
-        return $this->feedUrl;
-    }
+	/**
+	 * Get the feed URL for this calendar
+	 *
+	 * @return string
+	 */
+	public function getFeedUrl()
+	{
+		return $this->feedUrl;
+	}
 
-    /**
-     * Set the name of the calendar
-     *
-     * @param string $name
-     */
-    public function setName($name)
-    {
-        $this->name = (string) $name;
-    }
+	/**
+	 * Set the name of the calendar
+	 *
+	 * @param string $name
+	 */
+	public function setName($name)
+	{
+		$this->name = (string) $name;
+	}
 
-    /**
-     * Get the name of the calendar
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
+	/**
+	 * Get the name of the calendar
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
 
-    /**
-     * Set the regular expression filter for this calendar
-     *
-     * @param Filter $filter
-     */
-    public function setFilter(Filter $filter)
-    {
-        $this->filter = $filter;
-    }
+	/**
+	 * Set the regular expression filter for this calendar
+	 *
+	 * @param Filter $filter
+	 */
+	public function setFilter(Filter $filter)
+	{
+		$this->filter = $filter;
+	}
 
-    /**
-     * Get the regular expression filter for this calendar
-     *
-     * @return Filter
-     */
-    public function getFilter()
-    {
-        return $this->filter;
-    }
+	/**
+	 * Get the regular expression filter for this calendar
+	 *
+	 * @return Filter
+	 */
+	public function getFilter()
+	{
+		return $this->filter;
+	}
 
-    /**
-     * Generate a unique ID to identify this particular pairing of ICS feed and
-     * Canvas calendar
-     **/
-    protected function getPairingHash()
-    {
-        return md5($this->getContext()->getCanonicalUrl() . $this->getFeedUrl());
-    }
+	/**
+	 * Generate a unique ID to identify this particular pairing of ICS feed and
+	 * Canvas calendar
+	 **/
+	protected function getPairingHash()
+	{
+		return md5($this->getContext()->getCanonicalUrl() . $this->getFeedUrl());
+	}
 
-    public function save()
-    {
-        $db = static::getDatabase();
-        $find = $db->prepare(
-            "SELECT * FROM `calendars` WHERE `id` = :id"
-        );
-        $update = $db->prepare(
-            "UPDATE `calendars`
+	public function save()
+	{
+		$db = static::getDatabase();
+		$find = $db->prepare(
+			"SELECT * FROM `calendars` WHERE `id` = :id"
+		);
+		$update = $db->prepare(
+			"UPDATE `calendars`
                 SET
                     `name` = :name,
                     `canvas_url` = :canvas_url,
@@ -180,9 +180,9 @@ 
                     `exclude_regexp` = :exclude_regexp
                 WHERE
                 `id` = :id"
-        );
-        $insert = $db->prepare(
-            "INSERT INTO `calendars`
+		);
+		$insert = $db->prepare(
+			"INSERT INTO `calendars`
                 (
                     `id`,
                     `name`,
@@ -202,217 +202,217 @@ 
                     :include_regexp,
                     :exclude_regexp
                 )"
-        );
-        $params = [
-            'id' => $this->getPairingHash(),
-            'name' => $this->getName(),
-            'canvas_url' => $this->getContext()->getCanonicalUrl(),
-            'ics_url' => $this->getFeedUrl(),
-            'synced' => static::getSyncTimestamp(),
-            'enable_regex_filter' => $this->getFilter()->isEnabled(),
-            'include_regexp' => $this->getFilter()->getIncludeExpression(),
-            'exclude_regexp' => $this->getFilter()->getExcludeExpression()
-        ];
+		);
+		$params = [
+			'id' => $this->getPairingHash(),
+			'name' => $this->getName(),
+			'canvas_url' => $this->getContext()->getCanonicalUrl(),
+			'ics_url' => $this->getFeedUrl(),
+			'synced' => static::getSyncTimestamp(),
+			'enable_regex_filter' => $this->getFilter()->isEnabled(),
+			'include_regexp' => $this->getFilter()->getIncludeExpression(),
+			'exclude_regexp' => $this->getFilter()->getExcludeExpression()
+		];
 
-        $find->execute($params);
-        if ($find->fetch() !== false) {
-            $update->execute($params);
-        } else {
-            $insert->execute($params);
-        }
-    }
+		$find->execute($params);
+		if ($find->fetch() !== false) {
+			$update->execute($params);
+		} else {
+			$insert->execute($params);
+		}
+	}
 
-    /**
-     * Load a Calendar from the database
-     *
-     * @param int $id
-     * @return Calendar
-     */
-    public static function load($id)
-    {
-        $find = static::getDatabase()->prepare(
-            "SELECT * FROM `calendars` WHERE `id` = :id"
-        );
-        $find->execute($id);
-        if (($calendar = $find->fetch()) !== false) {
-            return new Calendar(
-                $calendar['canvas_url'],
-                $calendar['ics_url'],
-                $calendar['enable_regex_filter'],
-                $calendar['include_regexp'],
-                $calendar['exclude_regexp']
-            );
-        }
-        return null;
-    }
+	/**
+	 * Load a Calendar from the database
+	 *
+	 * @param int $id
+	 * @return Calendar
+	 */
+	public static function load($id)
+	{
+		$find = static::getDatabase()->prepare(
+			"SELECT * FROM `calendars` WHERE `id` = :id"
+		);
+		$find->execute($id);
+		if (($calendar = $find->fetch()) !== false) {
+			return new Calendar(
+				$calendar['canvas_url'],
+				$calendar['ics_url'],
+				$calendar['enable_regex_filter'],
+				$calendar['include_regexp'],
+				$calendar['exclude_regexp']
+			);
+		}
+		return null;
+	}
 
-    public function import(Log $log)
-    {
-        $db = static::getDatabase();
-        $api = static::getApi();
+	public function import(Log $log)
+	{
+		$db = static::getDatabase();
+		$api = static::getApi();
 
-        /*
+		/*
          * This will throw an exception if it's not found
          */
-        $canvasObject = $api->get($this->getContext()->getVerificationUrl());
+		$canvasObject = $api->get($this->getContext()->getVerificationUrl());
 
-        if (!DataUtilities::URLexists($this>getFeedUrl())) {
-            throw new Exception(
-                "Cannot sync calendars with a valid calendar feed"
-            );
-        }
+		if (!DataUtilities::URLexists($this>getFeedUrl())) {
+			throw new Exception(
+				"Cannot sync calendars with a valid calendar feed"
+			);
+		}
 
-        if ($log) {
-            $log->log(static::getSyncTimestamp() . ' sync started', PEAR_LOG_INFO);
-        }
-        $this->save();
+		if ($log) {
+			$log->log(static::getSyncTimestamp() . ' sync started', PEAR_LOG_INFO);
+		}
+		$this->save();
 
-        $ics = new vcalendar([
-            'unique_id' => __FILE__,
-            'url' => $this->getFeedUrl()
-        ]);
-        $ics->parse();
+		$ics = new vcalendar([
+			'unique_id' => __FILE__,
+			'url' => $this->getFeedUrl()
+		]);
+		$ics->parse();
 
-        /*
+		/*
          * TODO: would it be worth the performance improvement to just process
          *     things from today's date forward? (i.e. ignore old items, even
          *     if they've changed...)
          */
-        /*
+		/*
          * TODO:0 the best window for syncing would be the term of the course
          *     in question, right? issue:12
          */
-        /*
+		/*
          * TODO:0 Arbitrarily selecting events in for a year on either side of
          *     today's date, probably a better system? issue:12
          */
-        foreach ($ics->selectComponents(
-            date('Y')-1, // startYear
-            date('m'), // startMonth
-            date('d'), // startDay
-            date('Y')+1, // endYEar
-            date('m'), // endMonth
-            date('d'), // endDay
-            'vevent', // cType
-            false, // flat
-            true, // any
-            true // split
-        ) as $year) {
-            foreach ($year as $month => $days) {
-                foreach ($days as $day => $events) {
-                    foreach ($events as $i => $_event) {
-                        $event = new Event($_event, $this->getPairingHash());
-                        if ($this->getFilter()->filterEvent($event)) {
-                            $eventCache = Event::load($this->getPairingHash(), $eventHash);
-                            if (empty($eventCache)) {
-                                /* multi-day event instance start times need to be changed to _this_ date */
-                                $start = new DateTime(
-                                    iCalUtilityFunctions::_date2strdate(
-                                        $event->getProperty('DTSTART')
-                                    )
-                                );
-                                $end = new DateTime(
-                                    iCalUtilityFunctions::_date2strdate(
-                                        $event->getProperty('DTEND')
-                                    )
-                                );
-                                if ($event->getProperty('X-RECURRENCE')) {
-                                    $start = new DateTime($event->getProperty('X-CURRENT-DTSTART')[1]);
-                                    $end = new DateTime($event->getProperty('X-CURRENT-DTEND')[1]);
-                                }
-                                $start->setTimeZone(new DateTimeZone(Constants::LOCAL_TIMEZONE));
-                                $end->setTimeZone(new DateTimeZone(Constants::LOCAL_TIMEZONE));
+		foreach ($ics->selectComponents(
+			date('Y')-1, // startYear
+			date('m'), // startMonth
+			date('d'), // startDay
+			date('Y')+1, // endYEar
+			date('m'), // endMonth
+			date('d'), // endDay
+			'vevent', // cType
+			false, // flat
+			true, // any
+			true // split
+		) as $year) {
+			foreach ($year as $month => $days) {
+				foreach ($days as $day => $events) {
+					foreach ($events as $i => $_event) {
+						$event = new Event($_event, $this->getPairingHash());
+						if ($this->getFilter()->filterEvent($event)) {
+							$eventCache = Event::load($this->getPairingHash(), $eventHash);
+							if (empty($eventCache)) {
+								/* multi-day event instance start times need to be changed to _this_ date */
+								$start = new DateTime(
+									iCalUtilityFunctions::_date2strdate(
+										$event->getProperty('DTSTART')
+									)
+								);
+								$end = new DateTime(
+									iCalUtilityFunctions::_date2strdate(
+										$event->getProperty('DTEND')
+									)
+								);
+								if ($event->getProperty('X-RECURRENCE')) {
+									$start = new DateTime($event->getProperty('X-CURRENT-DTSTART')[1]);
+									$end = new DateTime($event->getProperty('X-CURRENT-DTEND')[1]);
+								}
+								$start->setTimeZone(new DateTimeZone(Constants::LOCAL_TIMEZONE));
+								$end->setTimeZone(new DateTimeZone(Constants::LOCAL_TIMEZONE));
 
-                                try {
-                                    $calendarEvent = $api->post(
-                                        "/calendar_events",
-                                        [
-                                            'calendar_event' => [
-                                                'context_code' => $this->getContext() . "_{$canvasObject['id']}",
-                                                'title' => preg_replace(
-                                                    '%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%',
-                                                    '\\1',
-                                                    strip_tags($event->getProperty('SUMMARY'))
-                                                ),
-                                                'description' => Markdown::defaultTransform(str_replace(
-                                                    '\n',
-                                                    "\n\n",
-                                                    $event->getProperty('DESCRIPTION', 1)
-                                                )),
-                                                'start_at' => $start->format(Constants::CANVAS_TIMESTAMP_FORMAT),
-                                                'end_at' => $end->format(Constants::CANVAS_TIMESTAMP_FORMAT),
-                                                'location_name' => $event->getProperty('LOCATION')
-                                            ]
-                                        ]
-                                    );
-                                } catch (Exception $e) {
-                                    if ($log) {
-                                        $log->log($e->getMessage(), PEAR_LOG_ERR);
-                                    } else {
-                                        throw $e;
-                                    }
-                                }
+								try {
+									$calendarEvent = $api->post(
+										"/calendar_events",
+										[
+											'calendar_event' => [
+												'context_code' => $this->getContext() . "_{$canvasObject['id']}",
+												'title' => preg_replace(
+													'%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%',
+													'\\1',
+													strip_tags($event->getProperty('SUMMARY'))
+												),
+												'description' => Markdown::defaultTransform(str_replace(
+													'\n',
+													"\n\n",
+													$event->getProperty('DESCRIPTION', 1)
+												)),
+												'start_at' => $start->format(Constants::CANVAS_TIMESTAMP_FORMAT),
+												'end_at' => $end->format(Constants::CANVAS_TIMESTAMP_FORMAT),
+												'location_name' => $event->getProperty('LOCATION')
+											]
+										]
+									);
+								} catch (Exception $e) {
+									if ($log) {
+										$log->log($e->getMessage(), PEAR_LOG_ERR);
+									} else {
+										throw $e;
+									}
+								}
 
-                                $eventCache = new Event($this->getPairingHash(), $canvasObject['id'], $eventHash);
-                            }
-                            $eventCache->save();
-                        }
-                    }
-                }
-            }
-        }
+								$eventCache = new Event($this->getPairingHash(), $canvasObject['id'], $eventHash);
+							}
+							$eventCache->save();
+						}
+					}
+				}
+			}
+		}
 
-        $findDeletedEvents = $db->prepare(
-            "SELECT *
+		$findDeletedEvents = $db->prepare(
+			"SELECT *
                 FROM `events`
                 WHERE
                     `calendar` = :calendar AND
                     `synced` != :synced
             "
-        );
-        $deleteCachedEvent = $db->prepare(
-            "DELETE FROM `events` WHERE `id` = :id"
-        );
-        $findDeletedEvents->execute([
-            'calendar' => $this->getPairingHash(),
-            'synced' => static::getSyncTimestamp()
-        ]);
-        if (($deletedEvents = $findDeletedEvents->fetchAll()) !== false) {
-            foreach ($deletedEvents as $eventCache) {
-                try {
-                    $api->delete(
-                        "/calendar_events/{$eventCache['calendar_event[id]']}",
-                        [
-                            'cancel_reason' => getSyncTimestamp(),
-                            /*
+		);
+		$deleteCachedEvent = $db->prepare(
+			"DELETE FROM `events` WHERE `id` = :id"
+		);
+		$findDeletedEvents->execute([
+			'calendar' => $this->getPairingHash(),
+			'synced' => static::getSyncTimestamp()
+		]);
+		if (($deletedEvents = $findDeletedEvents->fetchAll()) !== false) {
+			foreach ($deletedEvents as $eventCache) {
+				try {
+					$api->delete(
+						"/calendar_events/{$eventCache['calendar_event[id]']}",
+						[
+							'cancel_reason' => getSyncTimestamp(),
+							/*
                              * TODO: this feels skeevy -- like the empty string
                              *     will break
                              */
-                            'as_user_id' => ($this->getContext()->getContext() == 'user' ? $canvasObject['id'] : '')
-                        ]
-                    );
-                    $deleteCachedEvent->execute($eventCache['id']);
-                } catch (Pest_Unauthorized $e) {
-                    if ($log) {
-                        $log->log(
-                            "calendar_event[{$eventCache['calendar_event[id]']}] no longer exists and will be purged from cache.",
-                            PEAR_LOG_WARN
-                        );
-                    } else {
-                        throw $e;
-                    }
-                } catch (Exception $e) {
-                    if ($log) {
-                        $log->log($e->getMessage(), PEAR_LOG_ERR);
-                    } else {
-                        throw $e;
-                    }
-                }
-            }
-        }
+							'as_user_id' => ($this->getContext()->getContext() == 'user' ? $canvasObject['id'] : '')
+						]
+					);
+					$deleteCachedEvent->execute($eventCache['id']);
+				} catch (Pest_Unauthorized $e) {
+					if ($log) {
+						$log->log(
+							"calendar_event[{$eventCache['calendar_event[id]']}] no longer exists and will be purged from cache.",
+							PEAR_LOG_WARN
+						);
+					} else {
+						throw $e;
+					}
+				} catch (Exception $e) {
+					if ($log) {
+						$log->log($e->getMessage(), PEAR_LOG_ERR);
+					} else {
+						throw $e;
+					}
+				}
+			}
+		}
 
-        if ($log) {
-            $log->log(static::getSyncTimestamp() . ' sync finished', PEAR_LOG_INFO);
-        }
-    }
+		if ($log) {
+			$log->log(static::getSyncTimestamp() . ' sync finished', PEAR_LOG_INFO);
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -120,7 +120,7 @@ 
      */
     public function setName($name)
     {
-        $this->name = (string) $name;
+        $this->name = (string)$name;
     }
 
     /**
@@ -159,7 +159,7 @@ 
      **/
     protected function getPairingHash()
     {
-        return md5($this->getContext()->getCanonicalUrl() . $this->getFeedUrl());
+        return md5($this->getContext()->getCanonicalUrl().$this->getFeedUrl());
     }
 
     public function save()
@@ -256,14 +256,14 @@ 
          */
         $canvasObject = $api->get($this->getContext()->getVerificationUrl());
 
-        if (!DataUtilities::URLexists($this>getFeedUrl())) {
+        if (!DataUtilities::URLexists($this > getFeedUrl())) {
             throw new Exception(
                 "Cannot sync calendars with a valid calendar feed"
             );
         }
 
         if ($log) {
-            $log->log(static::getSyncTimestamp() . ' sync started', PEAR_LOG_INFO);
+            $log->log(static::getSyncTimestamp().' sync started', PEAR_LOG_INFO);
         }
         $this->save();
 
@@ -287,10 +287,10 @@ 
          *     today's date, probably a better system? issue:12
          */
         foreach ($ics->selectComponents(
-            date('Y')-1, // startYear
+            date('Y') - 1, // startYear
             date('m'), // startMonth
             date('d'), // startDay
-            date('Y')+1, // endYEar
+            date('Y') + 1, // endYEar
             date('m'), // endMonth
             date('d'), // endDay
             'vevent', // cType
@@ -328,7 +328,7 @@ 
                                         "/calendar_events",
                                         [
                                             'calendar_event' => [
-                                                'context_code' => $this->getContext() . "_{$canvasObject['id']}",
+                                                'context_code' => $this->getContext()."_{$canvasObject['id']}",
                                                 'title' => preg_replace(
                                                     '%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%',
                                                     '\\1',
@@ -412,7 +412,7 @@ 
         }
 
         if ($log) {
-            $log->log(static::getSyncTimestamp() . ' sync finished', PEAR_LOG_INFO);
+            $log->log(static::getSyncTimestamp().' sync finished', PEAR_LOG_INFO);
         }
     }
 }

src/SyncIntoCanvas/Event.php

Indentation +114 added lines, -114 removed lines

@@ -6,130 +6,130 @@
 
 class Event extends Syncable
 {
-    /**
-     * Wrapped VEVENT
-     * @var vevent
-     */
-    protected $vevent;
-
-    /**
-     * Calendar ID
-     * @var string
-     */
-    protected $calendar;
-
-    /**
-     * Unique hash identifying this event
-     * @var string
-     */
-    protected $hash;
-
-    protected $canvasId;
-
-    public function __construct($veventOrHash, $calendar, $calendarEventId = null)
-    {
-        if (empty($veventOrHash)) {
-            throw new Exception("Valid VEVENT or hash required");
-        }
-        if (is_a($veventOrHash, vevent::class)) {
-            $this->vevent = $veventOrHash;
-        } else {
-            $this->hash = (string) $veventOrHash;
-        }
-
-        if (empty($calendar)) {
-            throw new Exception("Calendar ID required");
-        }
-        $this->calendar = (string) $calendar;
-
-        $this->getHash();
-    }
-
-    public function getProperty($property)
-    {
-        return (empty($this->vevent) ? false : $this->vevent->getProperty($property));
-    }
-
-    const FIELD_MAP = [
-        'calendar_event[title]' => 'SUMMARY',
-        'calendar_event[description]' => 'DESCRIPTION',
-        'calendar_event[start_at]' => [
-            0 => 'X-CURRENT-DTSTART',
-            1 => 'DTSTART'
-        ],
-        'calendar_event[end_at]' => [
-            0 => 'X-CURRENT-DTEND',
-            1 => 'DTEND'
-        ],
-        'calendar_event[location_name]' => 'LOCATION'
-    ];
-
-    /**
-     * Generate a hash of this version of an event to cache in the database
-     **/
-    public function getHash($algorithm = 'md5')
-    {
-        if (empty($this->hash)) {
-            $blob = '';
-            foreach (static::$FIELD_MAP as $field) {
-                if (is_array($field)) {
-                    foreach ($field as $option) {
-                        if (!empty($property = $this->getProperty($option))) {
-                            $blob .= serialize($property);
-                            break;
-                        }
-                    }
-                } else {
-                    if (!empty($property = $this->getProperty($field))) {
-                        $blob .= serialize($property);
-                    }
-                }
-            }
-            $this->hash = hash($algorithm, $blob);
-        }
-        return $this->hash;
-    }
-
-    public function isCached()
-    {
-        return !empty(static::load($this->getHash(), $this->calendar));
-    }
-
-    public function save()
-    {
-        $db = static::getDatabase();
-
-        $find = $db->prepare(
-            "SELECT *
+	/**
+	 * Wrapped VEVENT
+	 * @var vevent
+	 */
+	protected $vevent;
+
+	/**
+	 * Calendar ID
+	 * @var string
+	 */
+	protected $calendar;
+
+	/**
+	 * Unique hash identifying this event
+	 * @var string
+	 */
+	protected $hash;
+
+	protected $canvasId;
+
+	public function __construct($veventOrHash, $calendar, $calendarEventId = null)
+	{
+		if (empty($veventOrHash)) {
+			throw new Exception("Valid VEVENT or hash required");
+		}
+		if (is_a($veventOrHash, vevent::class)) {
+			$this->vevent = $veventOrHash;
+		} else {
+			$this->hash = (string) $veventOrHash;
+		}
+
+		if (empty($calendar)) {
+			throw new Exception("Calendar ID required");
+		}
+		$this->calendar = (string) $calendar;
+
+		$this->getHash();
+	}
+
+	public function getProperty($property)
+	{
+		return (empty($this->vevent) ? false : $this->vevent->getProperty($property));
+	}
+
+	const FIELD_MAP = [
+		'calendar_event[title]' => 'SUMMARY',
+		'calendar_event[description]' => 'DESCRIPTION',
+		'calendar_event[start_at]' => [
+			0 => 'X-CURRENT-DTSTART',
+			1 => 'DTSTART'
+		],
+		'calendar_event[end_at]' => [
+			0 => 'X-CURRENT-DTEND',
+			1 => 'DTEND'
+		],
+		'calendar_event[location_name]' => 'LOCATION'
+	];
+
+	/**
+	 * Generate a hash of this version of an event to cache in the database
+	 **/
+	public function getHash($algorithm = 'md5')
+	{
+		if (empty($this->hash)) {
+			$blob = '';
+			foreach (static::$FIELD_MAP as $field) {
+				if (is_array($field)) {
+					foreach ($field as $option) {
+						if (!empty($property = $this->getProperty($option))) {
+							$blob .= serialize($property);
+							break;
+						}
+					}
+				} else {
+					if (!empty($property = $this->getProperty($field))) {
+						$blob .= serialize($property);
+					}
+				}
+			}
+			$this->hash = hash($algorithm, $blob);
+		}
+		return $this->hash;
+	}
+
+	public function isCached()
+	{
+		return !empty(static::load($this->getHash(), $this->calendar));
+	}
+
+	public function save()
+	{
+		$db = static::getDatabase();
+
+		$find = $db->prepare(
+			"SELECT *
                 FROM `events`
                 WHERE
                     `event_hash` = :event_hash AND
                     `calendar` = :calendar"
-        );
-        $update = $db->prepare(
-            "UPDATE `events`
+		);
+		$update = $db->prepare(
+			"UPDATE `events`
                 SET
                     `calendar` = :calendar,
                     `calendar_event[id]` = :calendar_event_id"
-        )
-    }
+		)
+	}
 
-    public static function load($id, $calendar)
-    {
-        $find = static::getDatabase()->prepare(
-            "SELECT *
+	public static function load($id, $calendar)
+	{
+		$find = static::getDatabase()->prepare(
+			"SELECT *
                 FROM `events`
                 WHERE
                     `event_hash` = :event_hash AND
                     `calendar` = :calendar"
-        );
-        $find->execute([
-            'event_hash' => $id,
-            'calendar' => $calendar
-        ]);
-        if (($cache = $find->fetch()) !== false) {
-            return new Event($cache['event_hash'], $cache['calendar']);
-        }
-        return null;
-    }
+		);
+		$find->execute([
+			'event_hash' => $id,
+			'calendar' => $calendar
+		]);
+		if (($cache = $find->fetch()) !== false) {
+			return new Event($cache['event_hash'], $cache['calendar']);
+		}
+		return null;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -34,13 +34,13 @@
         if (is_a($veventOrHash, vevent::class)) {
             $this->vevent = $veventOrHash;
         } else {
-            $this->hash = (string) $veventOrHash;
+            $this->hash = (string)$veventOrHash;
         }
 
         if (empty($calendar)) {
             throw new Exception("Calendar ID required");
         }
-        $this->calendar = (string) $calendar;
+        $this->calendar = (string)$calendar;
 
         $this->getHash();
     }