YetiForceCompany / YetiForceCRM

libraries/SabreDAV/HTTP/Auth/AbstractAuth.php

Indentation +44 added lines, -44 removed lines

@@ -16,58 +16,58 @@
  */
 abstract class AbstractAuth {
 
-    /**
-     * Authentication realm
-     *
-     * @var string
-     */
-    protected $realm;
+	/**
+	 * Authentication realm
+	 *
+	 * @var string
+	 */
+	protected $realm;
 
-    /**
-     * Request object
-     *
-     * @var RequestInterface
-     */
-    protected $request;
+	/**
+	 * Request object
+	 *
+	 * @var RequestInterface
+	 */
+	protected $request;
 
-    /**
-     * Response object
-     *
-     * @var ResponseInterface
-     */
-    protected $response;
+	/**
+	 * Response object
+	 *
+	 * @var ResponseInterface
+	 */
+	protected $response;
 
-    /**
-     * Creates the object
-     *
-     * @param string $realm
-     * @return void
-     */
-    public function __construct($realm = 'SabreTooth', RequestInterface $request, ResponseInterface $response) {
+	/**
+	 * Creates the object
+	 *
+	 * @param string $realm
+	 * @return void
+	 */
+	public function __construct($realm = 'SabreTooth', RequestInterface $request, ResponseInterface $response) {
 
-        $this->realm = $realm;
-        $this->request = $request;
-        $this->response = $response;
+		$this->realm = $realm;
+		$this->request = $request;
+		$this->response = $response;
 
-    }
+	}
 
-    /**
-     * This method sends the needed HTTP header and statuscode (401) to force
-     * the user to login.
-     *
-     * @return void
-     */
-    abstract function requireLogin();
+	/**
+	 * This method sends the needed HTTP header and statuscode (401) to force
+	 * the user to login.
+	 *
+	 * @return void
+	 */
+	abstract function requireLogin();
 
-    /**
-     * Returns the HTTP realm
-     *
-     * @return string
-     */
-    public function getRealm() {
+	/**
+	 * Returns the HTTP realm
+	 *
+	 * @return string
+	 */
+	public function getRealm() {
 
-        return $this->realm;
+		return $this->realm;
 
-    }
+	}
 
 }

libraries/SabreDAV/VObject/Component.php

Indentation +680 added lines, -680 removed lines

@@ -16,685 +16,685 @@
  */
 class Component extends Node {
 
-    /**
-     * Component name.
-     *
-     * This will contain a string such as VEVENT, VTODO, VCALENDAR, VCARD.
-     *
-     * @var string
-     */
-    public $name;
-
-    /**
-     * A list of properties and/or sub-components.
-     *
-     * @var array
-     */
-    protected $children = [];
-
-    /**
-     * Creates a new component.
-     *
-     * You can specify the children either in key=>value syntax, in which case
-     * properties will automatically be created, or you can just pass a list of
-     * Component and Property object.
-     *
-     * By default, a set of sensible values will be added to the component. For
-     * an iCalendar object, this may be something like CALSCALE:GREGORIAN. To
-     * ensure that this does not happen, set $defaults to false.
-     *
-     * @param Document $root
-     * @param string $name such as VCALENDAR, VEVENT.
-     * @param array $children
-     * @param bool $defaults
-     *
-     * @return void
-     */
-    public function __construct(Document $root, $name, array $children = [], $defaults = true) {
-
-        $this->name = strtoupper($name);
-        $this->root = $root;
-
-        if ($defaults) {
-            // This is a terribly convoluted way to do this, but this ensures
-            // that the order of properties as they are specified in both
-            // defaults and the childrens list, are inserted in the object in a
-            // natural way.
-            $list = $this->getDefaults();
-            $nodes = [];
-            foreach ($children as $key => $value) {
-                if ($value instanceof Node) {
-                    if (isset($list[$value->name])) {
-                        unset($list[$value->name]);
-                    }
-                    $nodes[] = $value;
-                } else {
-                    $list[$key] = $value;
-                }
-            }
-            foreach ($list as $key => $value) {
-                $this->add($key, $value);
-            }
-            foreach ($nodes as $node) {
-                $this->add($node);
-            }
-        } else {
-            foreach ($children as $k => $child) {
-                if ($child instanceof Node) {
-                    // Component or Property
-                    $this->add($child);
-                } else {
-
-                    // Property key=>value
-                    $this->add($k, $child);
-                }
-            }
-        }
-
-    }
-
-    /**
-     * Adds a new property or component, and returns the new item.
-     *
-     * This method has 3 possible signatures:
-     *
-     * add(Component $comp) // Adds a new component
-     * add(Property $prop)  // Adds a new property
-     * add($name, $value, array $parameters = []) // Adds a new property
-     * add($name, array $children = []) // Adds a new component
-     * by name.
-     *
-     * @return Node
-     */
-    public function add() {
-
-        $arguments = func_get_args();
-
-        if ($arguments[0] instanceof Node) {
-            if (isset($arguments[1])) {
-                throw new \InvalidArgumentException('The second argument must not be specified, when passing a VObject Node');
-            }
-            $arguments[0]->parent = $this;
-            $newNode = $arguments[0];
-
-        } elseif (is_string($arguments[0])) {
-
-            $newNode = call_user_func_array([$this->root, 'create'], $arguments);
-
-        } else {
-
-            throw new \InvalidArgumentException('The first argument must either be a \\Sabre\\VObject\\Node or a string');
-
-        }
-
-        $name = $newNode->name;
-        if (isset($this->children[$name])) {
-            $this->children[$name][] = $newNode;
-        } else {
-            $this->children[$name] = [$newNode];
-        }
-        return $newNode;
-
-    }
-
-    /**
-     * This method removes a component or property from this component.
-     *
-     * You can either specify the item by name (like DTSTART), in which case
-     * all properties/components with that name will be removed, or you can
-     * pass an instance of a property or component, in which case only that
-     * exact item will be removed.
-     *
-     * @param string|Property|Component $item
-     * @return void
-     */
-    public function remove($item) {
-
-        if (is_string($item)) {
-            // If there's no dot in the name, it's an exact property name and
-            // we can just wipe out all those properties.
-            //
-            if (strpos($item, '.') === false) {
-                unset($this->children[strtoupper($item)]);
-                return;
-            }
-            // If there was a dot, we need to ask select() to help us out and
-            // then we just call remove recursively.
-            foreach ($this->select($item) as $child) {
-
-                $this->remove($child);
-
-            }
-        } else {
-            foreach ($this->select($item->name) as $k => $child) {
-                if ($child === $item) {
-                    unset($this->children[$item->name][$k]);
-                    return;
-                }
-            }
-        }
-
-        throw new \InvalidArgumentException('The item you passed to remove() was not a child of this component');
-
-    }
-
-    /**
-     * Returns a flat list of all the properties and components in this
-     * component.
-     *
-     * @return array
-     */
-    public function children() {
-
-        $result = [];
-        foreach ($this->children as $childGroup) {
-            $result = array_merge($result, $childGroup);
-        }
-        return $result;
-
-    }
-
-    /**
-     * This method only returns a list of sub-components. Properties are
-     * ignored.
-     *
-     * @return array
-     */
-    public function getComponents() {
-
-        $result = [];
-
-        foreach ($this->children as $childGroup) {
-            foreach ($childGroup as $child) {
-                if ($child instanceof self) {
-                    $result[] = $child;
-                }
-            }
-        }
-        return $result;
-
-    }
-
-    /**
-     * Returns an array with elements that match the specified name.
-     *
-     * This function is also aware of MIME-Directory groups (as they appear in
-     * vcards). This means that if a property is grouped as "HOME.EMAIL", it
-     * will also be returned when searching for just "EMAIL". If you want to
-     * search for a property in a specific group, you can select on the entire
-     * string ("HOME.EMAIL"). If you want to search on a specific property that
-     * has not been assigned a group, specify ".EMAIL".
-     *
-     * @param string $name
-     * @return array
-     */
-    public function select($name) {
-
-        $group = null;
-        $name = strtoupper($name);
-        if (strpos($name, '.') !== false) {
-            list($group, $name) = explode('.', $name, 2);
-        }
-        if ($name === '') $name = null;
-
-        if (!is_null($name)) {
-
-            $result = isset($this->children[$name]) ? $this->children[$name] : [];
-
-            if (is_null($group)) {
-                return $result;
-            } else {
-                // If we have a group filter as well, we need to narrow it down
-                // more.
-                return array_filter(
-                    $result,
-                    public function($child) use ($group) {
-
-                        return $child instanceof Property && strtoupper($child->group) === $group;
-
-                    }
-                );
-            }
-
-        }
-
-        // If we got to this point, it means there was no 'name' specified for
-        // searching, implying that this is a group-only search.
-        $result = [];
-        foreach ($this->children as $childGroup) {
-
-            foreach ($childGroup as $child) {
-
-                if ($child instanceof Property && strtoupper($child->group) === $group) {
-                    $result[] = $child;
-                }
-
-            }
-
-        }
-        return $result;
-
-    }
-
-    /**
-     * Turns the object back into a serialized blob.
-     *
-     * @return string
-     */
-    public function serialize() {
-
-        $str = "BEGIN:" . $this->name . "\r\n";
-
-        /**
-         * Gives a component a 'score' for sorting purposes.
-         *
-         * This is solely used by the childrenSort method.
-         *
-         * A higher score means the item will be lower in the list.
-         * To avoid score collisions, each "score category" has a reasonable
-         * space to accomodate elements. The $key is added to the $score to
-         * preserve the original relative order of elements.
-         *
-         * @param int $key
-         * @param array $array
-         *
-         * @return int
-         */
-        $sortScore = function($key, $array) {
-
-            if ($array[$key] instanceof Component) {
-
-                // We want to encode VTIMEZONE first, this is a personal
-                // preference.
-                if ($array[$key]->name === 'VTIMEZONE') {
-                    $score = 300000000;
-                    return $score + $key;
-                } else {
-                    $score = 400000000;
-                    return $score + $key;
-                }
-            } else {
-                // Properties get encoded first
-                // VCARD version 4.0 wants the VERSION property to appear first
-                if ($array[$key] instanceof Property) {
-                    if ($array[$key]->name === 'VERSION') {
-                        $score = 100000000;
-                        return $score + $key;
-                    } else {
-                        // All other properties
-                        $score = 200000000;
-                        return $score + $key;
-                    }
-                }
-            }
-
-        };
-
-        $children = $this->children();
-        $tmp = $children;
-        uksort(
-            $children,
-            public function($a, $b) use ($sortScore, $tmp) {
-
-                $sA = $sortScore($a, $tmp);
-                $sB = $sortScore($b, $tmp);
-
-                return $sA - $sB;
-
-            }
-        );
-
-        foreach ($children as $child) $str .= $child->serialize();
-        $str .= "END:" . $this->name . "\r\n";
-
-        return $str;
-
-    }
-
-    /**
-     * This method returns an array, with the representation as it should be
-     * encoded in JSON. This is used to create jCard or jCal documents.
-     *
-     * @return array
-     */
-    public function jsonSerialize() {
-
-        $components = [];
-        $properties = [];
-
-        foreach ($this->children as $childGroup) {
-            foreach ($childGroup as $child) {
-                if ($child instanceof self) {
-                    $components[] = $child->jsonSerialize();
-                } else {
-                    $properties[] = $child->jsonSerialize();
-                }
-            }
-        }
-
-        return [
-            strtolower($this->name),
-            $properties,
-            $components
-        ];
-
-    }
-
-    /**
-     * This method serializes the data into XML. This is used to create xCard or
-     * xCal documents.
-     *
-     * @param Xml\Writer $writer  XML writer.
-     *
-     * @return void
-     */
-    public function xmlSerialize(Xml\Writer $writer) {
-
-        $components = [];
-        $properties = [];
-
-        foreach ($this->children as $childGroup) {
-            foreach ($childGroup as $child) {
-                if ($child instanceof self) {
-                    $components[] = $child;
-                } else {
-                    $properties[] = $child;
-                }
-            }
-        }
-
-        $writer->startElement(strtolower($this->name));
-
-        if (!empty($properties)) {
-
-            $writer->startElement('properties');
-
-            foreach ($properties as $property) {
-                $property->xmlSerialize($writer);
-            }
-
-            $writer->endElement();
-
-        }
-
-        if (!empty($components)) {
-
-            $writer->startElement('components');
-
-            foreach ($components as $component) {
-                $component->xmlSerialize($writer);
-            }
-
-            $writer->endElement();
-        }
-
-        $writer->endElement();
-
-    }
-
-    /**
-     * This method should return a list of default property values.
-     *
-     * @return array
-     */
-    protected function getDefaults() {
-
-        return [];
-
-    }
-
-    /* Magic property accessors {{{ */
-
-    /**
-     * Using 'get' you will either get a property or component.
-     *
-     * If there were no child-elements found with the specified name,
-     * null is returned.
-     *
-     * To use this, this may look something like this:
-     *
-     * $event = $calendar->VEVENT;
-     *
-     * @param string $name
-     *
-     * @return Property
-     */
-    public function __get($name) {
-
-        if ($name === 'children') {
-
-            throw new \RuntimeException('Starting sabre/vobject 4.0 the children property is now protected. You should use the children() method instead');
-
-        }
-
-        $matches = $this->select($name);
-        if (count($matches) === 0) {
-            return;
-        } else {
-            $firstMatch = current($matches);
-            /** @var $firstMatch Property */
-            $firstMatch->setIterator(new ElementList(array_values($matches)));
-            return $firstMatch;
-        }
-
-    }
-
-    /**
-     * This method checks if a sub-element with the specified name exists.
-     *
-     * @param string $name
-     *
-     * @return bool
-     */
-    public function __isset($name) {
-
-        $matches = $this->select($name);
-        return count($matches) > 0;
-
-    }
-
-    /**
-     * Using the setter method you can add properties or subcomponents.
-     *
-     * You can either pass a Component, Property
-     * object, or a string to automatically create a Property.
-     *
-     * If the item already exists, it will be removed. If you want to add
-     * a new item with the same name, always use the add() method.
-     *
-     * @param string $name
-     * @param mixed $value
-     *
-     * @return void
-     */
-    public function __set($name, $value) {
-
-        $name = strtoupper($name);
-        $this->remove($name);
-        if ($value instanceof self || $value instanceof Property) {
-            $this->add($value);
-        } else {
-            $this->add($name, $value);
-        }
-    }
-
-    /**
-     * Removes all properties and components within this component with the
-     * specified name.
-     *
-     * @param string $name
-     *
-     * @return void
-     */
-    public function __unset($name) {
-
-        $this->remove($name);
-
-    }
-
-    /* }}} */
-
-    /**
-     * This method is automatically called when the object is cloned.
-     * Specifically, this will ensure all child elements are also cloned.
-     *
-     * @return void
-     */
-    public function __clone() {
-
-        foreach ($this->children as $childName => $childGroup) {
-            foreach ($childGroup as $key => $child) {
-                $clonedChild = clone $child;
-                $clonedChild->parent = $this;
-                $clonedChild->root = $this->root;
-                $this->children[$childName][$key] = $clonedChild;
-            }
-        }
-
-    }
-
-    /**
-     * A simple list of validation rules.
-     *
-     * This is simply a list of properties, and how many times they either
-     * must or must not appear.
-     *
-     * Possible values per property:
-     *   * 0 - Must not appear.
-     *   * 1 - Must appear exactly once.
-     *   * + - Must appear at least once.
-     *   * * - Can appear any number of times.
-     *   * ? - May appear, but not more than once.
-     *
-     * It is also possible to specify defaults and severity levels for
-     * violating the rule.
-     *
-     * See the VEVENT implementation for getValidationRules for a more complex
-     * example.
-     *
-     * @var array
-     */
-    public function getValidationRules() {
-
-        return [];
-
-    }
-
-    /**
-     * Validates the node for correctness.
-     *
-     * The following options are supported:
-     *   Node::REPAIR - May attempt to automatically repair the problem.
-     *   Node::PROFILE_CARDDAV - Validate the vCard for CardDAV purposes.
-     *   Node::PROFILE_CALDAV - Validate the iCalendar for CalDAV purposes.
-     *
-     * This method returns an array with detected problems.
-     * Every element has the following properties:
-     *
-     *  * level - problem level.
-     *  * message - A human-readable string describing the issue.
-     *  * node - A reference to the problematic node.
-     *
-     * The level means:
-     *   1 - The issue was repaired (only happens if REPAIR was turned on).
-     *   2 - A warning.
-     *   3 - An error.
-     *
-     * @param int $options
-     *
-     * @return array
-     */
-    public function validate($options = 0) {
-
-        $rules = $this->getValidationRules();
-        $defaults = $this->getDefaults();
-
-        $propertyCounters = [];
-
-        $messages = [];
-
-        foreach ($this->children() as $child) {
-            $name = strtoupper($child->name);
-            if (!isset($propertyCounters[$name])) {
-                $propertyCounters[$name] = 1;
-            } else {
-                $propertyCounters[$name]++;
-            }
-            $messages = array_merge($messages, $child->validate($options));
-        }
-
-        foreach ($rules as $propName => $rule) {
-
-            switch ($rule) {
-                case '0' :
-                    if (isset($propertyCounters[$propName])) {
-                        $messages[] = [
-                            'level'   => 3,
-                            'message' => $propName . ' MUST NOT appear in a ' . $this->name . ' component',
-                            'node'    => $this,
-                        ];
-                    }
-                    break;
-                case '1' :
-                    if (!isset($propertyCounters[$propName]) || $propertyCounters[$propName] !== 1) {
-                        $repaired = false;
-                        if ($options & self::REPAIR && isset($defaults[$propName])) {
-                            $this->add($propName, $defaults[$propName]);
-                            $repaired = true;
-                        }
-                        $messages[] = [
-                            'level'   => $repaired ? 1 : 3,
-                            'message' => $propName . ' MUST appear exactly once in a ' . $this->name . ' component',
-                            'node'    => $this,
-                        ];
-                    }
-                    break;
-                case '+' :
-                    if (!isset($propertyCounters[$propName]) || $propertyCounters[$propName] < 1) {
-                        $messages[] = [
-                            'level'   => 3,
-                            'message' => $propName . ' MUST appear at least once in a ' . $this->name . ' component',
-                            'node'    => $this,
-                        ];
-                    }
-                    break;
-                case '*' :
-                    break;
-                case '?' :
-                    if (isset($propertyCounters[$propName]) && $propertyCounters[$propName] > 1) {
-                        $messages[] = [
-                            'level'   => 3,
-                            'message' => $propName . ' MUST NOT appear more than once in a ' . $this->name . ' component',
-                            'node'    => $this,
-                        ];
-                    }
-                    break;
-
-            }
-
-        }
-        return $messages;
-
-    }
-
-    /**
-     * Call this method on a document if you're done using it.
-     *
-     * It's intended to remove all circular references, so PHP can easily clean
-     * it up.
-     *
-     * @return void
-     */
-    public function destroy() {
-
-        parent::destroy();
-        foreach ($this->children as $childGroup) {
-            foreach ($childGroup as $child) {
-                $child->destroy();
-            }
-        }
-        $this->children = [];
-
-    }
+	/**
+	 * Component name.
+	 *
+	 * This will contain a string such as VEVENT, VTODO, VCALENDAR, VCARD.
+	 *
+	 * @var string
+	 */
+	public $name;
+
+	/**
+	 * A list of properties and/or sub-components.
+	 *
+	 * @var array
+	 */
+	protected $children = [];
+
+	/**
+	 * Creates a new component.
+	 *
+	 * You can specify the children either in key=>value syntax, in which case
+	 * properties will automatically be created, or you can just pass a list of
+	 * Component and Property object.
+	 *
+	 * By default, a set of sensible values will be added to the component. For
+	 * an iCalendar object, this may be something like CALSCALE:GREGORIAN. To
+	 * ensure that this does not happen, set $defaults to false.
+	 *
+	 * @param Document $root
+	 * @param string $name such as VCALENDAR, VEVENT.
+	 * @param array $children
+	 * @param bool $defaults
+	 *
+	 * @return void
+	 */
+	public function __construct(Document $root, $name, array $children = [], $defaults = true) {
+
+		$this->name = strtoupper($name);
+		$this->root = $root;
+
+		if ($defaults) {
+			// This is a terribly convoluted way to do this, but this ensures
+			// that the order of properties as they are specified in both
+			// defaults and the childrens list, are inserted in the object in a
+			// natural way.
+			$list = $this->getDefaults();
+			$nodes = [];
+			foreach ($children as $key => $value) {
+				if ($value instanceof Node) {
+					if (isset($list[$value->name])) {
+						unset($list[$value->name]);
+					}
+					$nodes[] = $value;
+				} else {
+					$list[$key] = $value;
+				}
+			}
+			foreach ($list as $key => $value) {
+				$this->add($key, $value);
+			}
+			foreach ($nodes as $node) {
+				$this->add($node);
+			}
+		} else {
+			foreach ($children as $k => $child) {
+				if ($child instanceof Node) {
+					// Component or Property
+					$this->add($child);
+				} else {
+
+					// Property key=>value
+					$this->add($k, $child);
+				}
+			}
+		}
+
+	}
+
+	/**
+	 * Adds a new property or component, and returns the new item.
+	 *
+	 * This method has 3 possible signatures:
+	 *
+	 * add(Component $comp) // Adds a new component
+	 * add(Property $prop)  // Adds a new property
+	 * add($name, $value, array $parameters = []) // Adds a new property
+	 * add($name, array $children = []) // Adds a new component
+	 * by name.
+	 *
+	 * @return Node
+	 */
+	public function add() {
+
+		$arguments = func_get_args();
+
+		if ($arguments[0] instanceof Node) {
+			if (isset($arguments[1])) {
+				throw new \InvalidArgumentException('The second argument must not be specified, when passing a VObject Node');
+			}
+			$arguments[0]->parent = $this;
+			$newNode = $arguments[0];
+
+		} elseif (is_string($arguments[0])) {
+
+			$newNode = call_user_func_array([$this->root, 'create'], $arguments);
+
+		} else {
+
+			throw new \InvalidArgumentException('The first argument must either be a \\Sabre\\VObject\\Node or a string');
+
+		}
+
+		$name = $newNode->name;
+		if (isset($this->children[$name])) {
+			$this->children[$name][] = $newNode;
+		} else {
+			$this->children[$name] = [$newNode];
+		}
+		return $newNode;
+
+	}
+
+	/**
+	 * This method removes a component or property from this component.
+	 *
+	 * You can either specify the item by name (like DTSTART), in which case
+	 * all properties/components with that name will be removed, or you can
+	 * pass an instance of a property or component, in which case only that
+	 * exact item will be removed.
+	 *
+	 * @param string|Property|Component $item
+	 * @return void
+	 */
+	public function remove($item) {
+
+		if (is_string($item)) {
+			// If there's no dot in the name, it's an exact property name and
+			// we can just wipe out all those properties.
+			//
+			if (strpos($item, '.') === false) {
+				unset($this->children[strtoupper($item)]);
+				return;
+			}
+			// If there was a dot, we need to ask select() to help us out and
+			// then we just call remove recursively.
+			foreach ($this->select($item) as $child) {
+
+				$this->remove($child);
+
+			}
+		} else {
+			foreach ($this->select($item->name) as $k => $child) {
+				if ($child === $item) {
+					unset($this->children[$item->name][$k]);
+					return;
+				}
+			}
+		}
+
+		throw new \InvalidArgumentException('The item you passed to remove() was not a child of this component');
+
+	}
+
+	/**
+	 * Returns a flat list of all the properties and components in this
+	 * component.
+	 *
+	 * @return array
+	 */
+	public function children() {
+
+		$result = [];
+		foreach ($this->children as $childGroup) {
+			$result = array_merge($result, $childGroup);
+		}
+		return $result;
+
+	}
+
+	/**
+	 * This method only returns a list of sub-components. Properties are
+	 * ignored.
+	 *
+	 * @return array
+	 */
+	public function getComponents() {
+
+		$result = [];
+
+		foreach ($this->children as $childGroup) {
+			foreach ($childGroup as $child) {
+				if ($child instanceof self) {
+					$result[] = $child;
+				}
+			}
+		}
+		return $result;
+
+	}
+
+	/**
+	 * Returns an array with elements that match the specified name.
+	 *
+	 * This function is also aware of MIME-Directory groups (as they appear in
+	 * vcards). This means that if a property is grouped as "HOME.EMAIL", it
+	 * will also be returned when searching for just "EMAIL". If you want to
+	 * search for a property in a specific group, you can select on the entire
+	 * string ("HOME.EMAIL"). If you want to search on a specific property that
+	 * has not been assigned a group, specify ".EMAIL".
+	 *
+	 * @param string $name
+	 * @return array
+	 */
+	public function select($name) {
+
+		$group = null;
+		$name = strtoupper($name);
+		if (strpos($name, '.') !== false) {
+			list($group, $name) = explode('.', $name, 2);
+		}
+		if ($name === '') $name = null;
+
+		if (!is_null($name)) {
+
+			$result = isset($this->children[$name]) ? $this->children[$name] : [];
+
+			if (is_null($group)) {
+				return $result;
+			} else {
+				// If we have a group filter as well, we need to narrow it down
+				// more.
+				return array_filter(
+					$result,
+					public function($child) use ($group) {
+
+						return $child instanceof Property && strtoupper($child->group) === $group;
+
+					}
+				);
+			}
+
+		}
+
+		// If we got to this point, it means there was no 'name' specified for
+		// searching, implying that this is a group-only search.
+		$result = [];
+		foreach ($this->children as $childGroup) {
+
+			foreach ($childGroup as $child) {
+
+				if ($child instanceof Property && strtoupper($child->group) === $group) {
+					$result[] = $child;
+				}
+
+			}
+
+		}
+		return $result;
+
+	}
+
+	/**
+	 * Turns the object back into a serialized blob.
+	 *
+	 * @return string
+	 */
+	public function serialize() {
+
+		$str = "BEGIN:" . $this->name . "\r\n";
+
+		/**
+		 * Gives a component a 'score' for sorting purposes.
+		 *
+		 * This is solely used by the childrenSort method.
+		 *
+		 * A higher score means the item will be lower in the list.
+		 * To avoid score collisions, each "score category" has a reasonable
+		 * space to accomodate elements. The $key is added to the $score to
+		 * preserve the original relative order of elements.
+		 *
+		 * @param int $key
+		 * @param array $array
+		 *
+		 * @return int
+		 */
+		$sortScore = function($key, $array) {
+
+			if ($array[$key] instanceof Component) {
+
+				// We want to encode VTIMEZONE first, this is a personal
+				// preference.
+				if ($array[$key]->name === 'VTIMEZONE') {
+					$score = 300000000;
+					return $score + $key;
+				} else {
+					$score = 400000000;
+					return $score + $key;
+				}
+			} else {
+				// Properties get encoded first
+				// VCARD version 4.0 wants the VERSION property to appear first
+				if ($array[$key] instanceof Property) {
+					if ($array[$key]->name === 'VERSION') {
+						$score = 100000000;
+						return $score + $key;
+					} else {
+						// All other properties
+						$score = 200000000;
+						return $score + $key;
+					}
+				}
+			}
+
+		};
+
+		$children = $this->children();
+		$tmp = $children;
+		uksort(
+			$children,
+			public function($a, $b) use ($sortScore, $tmp) {
+
+				$sA = $sortScore($a, $tmp);
+				$sB = $sortScore($b, $tmp);
+
+				return $sA - $sB;
+
+			}
+		);
+
+		foreach ($children as $child) $str .= $child->serialize();
+		$str .= "END:" . $this->name . "\r\n";
+
+		return $str;
+
+	}
+
+	/**
+	 * This method returns an array, with the representation as it should be
+	 * encoded in JSON. This is used to create jCard or jCal documents.
+	 *
+	 * @return array
+	 */
+	public function jsonSerialize() {
+
+		$components = [];
+		$properties = [];
+
+		foreach ($this->children as $childGroup) {
+			foreach ($childGroup as $child) {
+				if ($child instanceof self) {
+					$components[] = $child->jsonSerialize();
+				} else {
+					$properties[] = $child->jsonSerialize();
+				}
+			}
+		}
+
+		return [
+			strtolower($this->name),
+			$properties,
+			$components
+		];
+
+	}
+
+	/**
+	 * This method serializes the data into XML. This is used to create xCard or
+	 * xCal documents.
+	 *
+	 * @param Xml\Writer $writer  XML writer.
+	 *
+	 * @return void
+	 */
+	public function xmlSerialize(Xml\Writer $writer) {
+
+		$components = [];
+		$properties = [];
+
+		foreach ($this->children as $childGroup) {
+			foreach ($childGroup as $child) {
+				if ($child instanceof self) {
+					$components[] = $child;
+				} else {
+					$properties[] = $child;
+				}
+			}
+		}
+
+		$writer->startElement(strtolower($this->name));
+
+		if (!empty($properties)) {
+
+			$writer->startElement('properties');
+
+			foreach ($properties as $property) {
+				$property->xmlSerialize($writer);
+			}
+
+			$writer->endElement();
+
+		}
+
+		if (!empty($components)) {
+
+			$writer->startElement('components');
+
+			foreach ($components as $component) {
+				$component->xmlSerialize($writer);
+			}
+
+			$writer->endElement();
+		}
+
+		$writer->endElement();
+
+	}
+
+	/**
+	 * This method should return a list of default property values.
+	 *
+	 * @return array
+	 */
+	protected function getDefaults() {
+
+		return [];
+
+	}
+
+	/* Magic property accessors {{{ */
+
+	/**
+	 * Using 'get' you will either get a property or component.
+	 *
+	 * If there were no child-elements found with the specified name,
+	 * null is returned.
+	 *
+	 * To use this, this may look something like this:
+	 *
+	 * $event = $calendar->VEVENT;
+	 *
+	 * @param string $name
+	 *
+	 * @return Property
+	 */
+	public function __get($name) {
+
+		if ($name === 'children') {
+
+			throw new \RuntimeException('Starting sabre/vobject 4.0 the children property is now protected. You should use the children() method instead');
+
+		}
+
+		$matches = $this->select($name);
+		if (count($matches) === 0) {
+			return;
+		} else {
+			$firstMatch = current($matches);
+			/** @var $firstMatch Property */
+			$firstMatch->setIterator(new ElementList(array_values($matches)));
+			return $firstMatch;
+		}
+
+	}
+
+	/**
+	 * This method checks if a sub-element with the specified name exists.
+	 *
+	 * @param string $name
+	 *
+	 * @return bool
+	 */
+	public function __isset($name) {
+
+		$matches = $this->select($name);
+		return count($matches) > 0;
+
+	}
+
+	/**
+	 * Using the setter method you can add properties or subcomponents.
+	 *
+	 * You can either pass a Component, Property
+	 * object, or a string to automatically create a Property.
+	 *
+	 * If the item already exists, it will be removed. If you want to add
+	 * a new item with the same name, always use the add() method.
+	 *
+	 * @param string $name
+	 * @param mixed $value
+	 *
+	 * @return void
+	 */
+	public function __set($name, $value) {
+
+		$name = strtoupper($name);
+		$this->remove($name);
+		if ($value instanceof self || $value instanceof Property) {
+			$this->add($value);
+		} else {
+			$this->add($name, $value);
+		}
+	}
+
+	/**
+	 * Removes all properties and components within this component with the
+	 * specified name.
+	 *
+	 * @param string $name
+	 *
+	 * @return void
+	 */
+	public function __unset($name) {
+
+		$this->remove($name);
+
+	}
+
+	/* }}} */
+
+	/**
+	 * This method is automatically called when the object is cloned.
+	 * Specifically, this will ensure all child elements are also cloned.
+	 *
+	 * @return void
+	 */
+	public function __clone() {
+
+		foreach ($this->children as $childName => $childGroup) {
+			foreach ($childGroup as $key => $child) {
+				$clonedChild = clone $child;
+				$clonedChild->parent = $this;
+				$clonedChild->root = $this->root;
+				$this->children[$childName][$key] = $clonedChild;
+			}
+		}
+
+	}
+
+	/**
+	 * A simple list of validation rules.
+	 *
+	 * This is simply a list of properties, and how many times they either
+	 * must or must not appear.
+	 *
+	 * Possible values per property:
+	 *   * 0 - Must not appear.
+	 *   * 1 - Must appear exactly once.
+	 *   * + - Must appear at least once.
+	 *   * * - Can appear any number of times.
+	 *   * ? - May appear, but not more than once.
+	 *
+	 * It is also possible to specify defaults and severity levels for
+	 * violating the rule.
+	 *
+	 * See the VEVENT implementation for getValidationRules for a more complex
+	 * example.
+	 *
+	 * @var array
+	 */
+	public function getValidationRules() {
+
+		return [];
+
+	}
+
+	/**
+	 * Validates the node for correctness.
+	 *
+	 * The following options are supported:
+	 *   Node::REPAIR - May attempt to automatically repair the problem.
+	 *   Node::PROFILE_CARDDAV - Validate the vCard for CardDAV purposes.
+	 *   Node::PROFILE_CALDAV - Validate the iCalendar for CalDAV purposes.
+	 *
+	 * This method returns an array with detected problems.
+	 * Every element has the following properties:
+	 *
+	 *  * level - problem level.
+	 *  * message - A human-readable string describing the issue.
+	 *  * node - A reference to the problematic node.
+	 *
+	 * The level means:
+	 *   1 - The issue was repaired (only happens if REPAIR was turned on).
+	 *   2 - A warning.
+	 *   3 - An error.
+	 *
+	 * @param int $options
+	 *
+	 * @return array
+	 */
+	public function validate($options = 0) {
+
+		$rules = $this->getValidationRules();
+		$defaults = $this->getDefaults();
+
+		$propertyCounters = [];
+
+		$messages = [];
+
+		foreach ($this->children() as $child) {
+			$name = strtoupper($child->name);
+			if (!isset($propertyCounters[$name])) {
+				$propertyCounters[$name] = 1;
+			} else {
+				$propertyCounters[$name]++;
+			}
+			$messages = array_merge($messages, $child->validate($options));
+		}
+
+		foreach ($rules as $propName => $rule) {
+
+			switch ($rule) {
+				case '0' :
+					if (isset($propertyCounters[$propName])) {
+						$messages[] = [
+							'level'   => 3,
+							'message' => $propName . ' MUST NOT appear in a ' . $this->name . ' component',
+							'node'    => $this,
+						];
+					}
+					break;
+				case '1' :
+					if (!isset($propertyCounters[$propName]) || $propertyCounters[$propName] !== 1) {
+						$repaired = false;
+						if ($options & self::REPAIR && isset($defaults[$propName])) {
+							$this->add($propName, $defaults[$propName]);
+							$repaired = true;
+						}
+						$messages[] = [
+							'level'   => $repaired ? 1 : 3,
+							'message' => $propName . ' MUST appear exactly once in a ' . $this->name . ' component',
+							'node'    => $this,
+						];
+					}
+					break;
+				case '+' :
+					if (!isset($propertyCounters[$propName]) || $propertyCounters[$propName] < 1) {
+						$messages[] = [
+							'level'   => 3,
+							'message' => $propName . ' MUST appear at least once in a ' . $this->name . ' component',
+							'node'    => $this,
+						];
+					}
+					break;
+				case '*' :
+					break;
+				case '?' :
+					if (isset($propertyCounters[$propName]) && $propertyCounters[$propName] > 1) {
+						$messages[] = [
+							'level'   => 3,
+							'message' => $propName . ' MUST NOT appear more than once in a ' . $this->name . ' component',
+							'node'    => $this,
+						];
+					}
+					break;
+
+			}
+
+		}
+		return $messages;
+
+	}
+
+	/**
+	 * Call this method on a document if you're done using it.
+	 *
+	 * It's intended to remove all circular references, so PHP can easily clean
+	 * it up.
+	 *
+	 * @return void
+	 */
+	public function destroy() {
+
+		parent::destroy();
+		foreach ($this->children as $childGroup) {
+			foreach ($childGroup as $child) {
+				$child->destroy();
+			}
+		}
+		$this->children = [];
+
+	}
 
 }

libraries/SabreDAV/VObject/Document.php

Indentation +248 added lines, -248 removed lines

@@ -18,253 +18,253 @@
  */
 abstract class Document extends Component {
 
-    /**
-     * Unknown document type.
-     */
-    const UNKNOWN = 1;
-
-    /**
-     * vCalendar 1.0.
-     */
-    const VCALENDAR10 = 2;
-
-    /**
-     * iCalendar 2.0.
-     */
-    const ICALENDAR20 = 3;
-
-    /**
-     * vCard 2.1.
-     */
-    const VCARD21 = 4;
-
-    /**
-     * vCard 3.0.
-     */
-    const VCARD30 = 5;
-
-    /**
-     * vCard 4.0.
-     */
-    const VCARD40 = 6;
-
-    /**
-     * The default name for this component.
-     *
-     * This should be 'VCALENDAR' or 'VCARD'.
-     *
-     * @var string
-     */
-    static $defaultName;
-
-    /**
-     * List of properties, and which classes they map to.
-     *
-     * @var array
-     */
-    static $propertyMap = [];
-
-    /**
-     * List of components, along with which classes they map to.
-     *
-     * @var array
-     */
-    static $componentMap = [];
-
-    /**
-     * List of value-types, and which classes they map to.
-     *
-     * @var array
-     */
-    static $valueMap = [];
-
-    /**
-     * Creates a new document.
-     *
-     * We're changing the default behavior slightly here. First, we don't want
-     * to have to specify a name (we already know it), and we want to allow
-     * children to be specified in the first argument.
-     *
-     * But, the default behavior also works.
-     *
-     * So the two sigs:
-     *
-     * new Document(array $children = [], $defaults = true);
-     * new Document(string $name, array $children = [], $defaults = true)
-     *
-     * @return void
-     */
-    public function __construct() {
-
-        $args = func_get_args();
-        if (count($args) === 0 || is_array($args[0])) {
-            array_unshift($args, $this, static::$defaultName);
-            call_user_func_array(['parent', '__construct'], $args);
-        } else {
-            array_unshift($args, $this);
-            call_user_func_array(['parent', '__construct'], $args);
-        }
-
-    }
-
-    /**
-     * Returns the current document type.
-     *
-     * @return int
-     */
-    public function getDocumentType() {
-
-        return self::UNKNOWN;
-
-    }
-
-    /**
-     * Creates a new component or property.
-     *
-     * If it's a known component, we will automatically call createComponent.
-     * otherwise, we'll assume it's a property and call createProperty instead.
-     *
-     * @param string $name
-     * @param string $arg1,... Unlimited number of args
-     *
-     * @return mixed
-     */
-    public function create($name) {
-
-        if (isset(static::$componentMap[strtoupper($name)])) {
-
-            return call_user_func_array([$this, 'createComponent'], func_get_args());
-
-        } else {
-
-            return call_user_func_array([$this, 'createProperty'], func_get_args());
-
-        }
-
-    }
-
-    /**
-     * Creates a new component.
-     *
-     * This method automatically searches for the correct component class, based
-     * on its name.
-     *
-     * You can specify the children either in key=>value syntax, in which case
-     * properties will automatically be created, or you can just pass a list of
-     * Component and Property object.
-     *
-     * By default, a set of sensible values will be added to the component. For
-     * an iCalendar object, this may be something like CALSCALE:GREGORIAN. To
-     * ensure that this does not happen, set $defaults to false.
-     *
-     * @param string $name
-     * @param array $children
-     * @param bool $defaults
-     *
-     * @return Component
-     */
-    public function createComponent($name, array $children = null, $defaults = true) {
-
-        $name = strtoupper($name);
-        $class = 'Sabre\\VObject\\Component';
-
-        if (isset(static::$componentMap[$name])) {
-            $class = static::$componentMap[$name];
-        }
-        if (is_null($children)) $children = [];
-        return new $class($this, $name, $children, $defaults);
-
-    }
-
-    /**
-     * Factory method for creating new properties.
-     *
-     * This method automatically searches for the correct property class, based
-     * on its name.
-     *
-     * You can specify the parameters either in key=>value syntax, in which case
-     * parameters will automatically be created, or you can just pass a list of
-     * Parameter objects.
-     *
-     * @param string $name
-     * @param mixed $value
-     * @param array $parameters
-     * @param string $valueType Force a specific valuetype, such as URI or TEXT
-     *
-     * @return Property
-     */
-    public function createProperty($name, $value = null, array $parameters = null, $valueType = null) {
-
-        // If there's a . in the name, it means it's prefixed by a groupname.
-        if (($i = strpos($name, '.')) !== false) {
-            $group = substr($name, 0, $i);
-            $name = strtoupper(substr($name, $i + 1));
-        } else {
-            $name = strtoupper($name);
-            $group = null;
-        }
-
-        $class = null;
-
-        if ($valueType) {
-            // The valueType argument comes first to figure out the correct
-            // class.
-            $class = $this->getClassNameForPropertyValue($valueType);
-        }
-
-        if (is_null($class)) {
-            // If a VALUE parameter is supplied, we should use that.
-            if (isset($parameters['VALUE'])) {
-                $class = $this->getClassNameForPropertyValue($parameters['VALUE']);
-                if (is_null($class)) {
-                    throw new InvalidDataException('Unsupported VALUE parameter for ' . $name . ' property. You supplied "' . $parameters['VALUE'] . '"');
-                }
-            }
-            else {
-                $class = $this->getClassNameForPropertyName($name);
-            }
-        }
-        if (is_null($parameters)) $parameters = [];
-
-        return new $class($this, $name, $value, $parameters, $group);
-
-    }
-
-    /**
-     * This method returns a full class-name for a value parameter.
-     *
-     * For instance, DTSTART may have VALUE=DATE. In that case we will look in
-     * our valueMap table and return the appropriate class name.
-     *
-     * This method returns null if we don't have a specialized class.
-     *
-     * @param string $valueParam
-     * @return string|null
-     */
-    public function getClassNameForPropertyValue($valueParam) {
-
-        $valueParam = strtoupper($valueParam);
-        if (isset(static::$valueMap[$valueParam])) {
-            return static::$valueMap[$valueParam];
-        }
-
-    }
-
-    /**
-     * Returns the default class for a property name.
-     *
-     * @param string $propertyName
-     *
-     * @return string
-     */
-    public function getClassNameForPropertyName($propertyName) {
-
-        if (isset(static::$propertyMap[$propertyName])) {
-            return static::$propertyMap[$propertyName];
-        } else {
-            return 'Sabre\\VObject\\Property\\Unknown';
-        }
-
-    }
+	/**
+	 * Unknown document type.
+	 */
+	const UNKNOWN = 1;
+
+	/**
+	 * vCalendar 1.0.
+	 */
+	const VCALENDAR10 = 2;
+
+	/**
+	 * iCalendar 2.0.
+	 */
+	const ICALENDAR20 = 3;
+
+	/**
+	 * vCard 2.1.
+	 */
+	const VCARD21 = 4;
+
+	/**
+	 * vCard 3.0.
+	 */
+	const VCARD30 = 5;
+
+	/**
+	 * vCard 4.0.
+	 */
+	const VCARD40 = 6;
+
+	/**
+	 * The default name for this component.
+	 *
+	 * This should be 'VCALENDAR' or 'VCARD'.
+	 *
+	 * @var string
+	 */
+	static $defaultName;
+
+	/**
+	 * List of properties, and which classes they map to.
+	 *
+	 * @var array
+	 */
+	static $propertyMap = [];
+
+	/**
+	 * List of components, along with which classes they map to.
+	 *
+	 * @var array
+	 */
+	static $componentMap = [];
+
+	/**
+	 * List of value-types, and which classes they map to.
+	 *
+	 * @var array
+	 */
+	static $valueMap = [];
+
+	/**
+	 * Creates a new document.
+	 *
+	 * We're changing the default behavior slightly here. First, we don't want
+	 * to have to specify a name (we already know it), and we want to allow
+	 * children to be specified in the first argument.
+	 *
+	 * But, the default behavior also works.
+	 *
+	 * So the two sigs:
+	 *
+	 * new Document(array $children = [], $defaults = true);
+	 * new Document(string $name, array $children = [], $defaults = true)
+	 *
+	 * @return void
+	 */
+	public function __construct() {
+
+		$args = func_get_args();
+		if (count($args) === 0 || is_array($args[0])) {
+			array_unshift($args, $this, static::$defaultName);
+			call_user_func_array(['parent', '__construct'], $args);
+		} else {
+			array_unshift($args, $this);
+			call_user_func_array(['parent', '__construct'], $args);
+		}
+
+	}
+
+	/**
+	 * Returns the current document type.
+	 *
+	 * @return int
+	 */
+	public function getDocumentType() {
+
+		return self::UNKNOWN;
+
+	}
+
+	/**
+	 * Creates a new component or property.
+	 *
+	 * If it's a known component, we will automatically call createComponent.
+	 * otherwise, we'll assume it's a property and call createProperty instead.
+	 *
+	 * @param string $name
+	 * @param string $arg1,... Unlimited number of args
+	 *
+	 * @return mixed
+	 */
+	public function create($name) {
+
+		if (isset(static::$componentMap[strtoupper($name)])) {
+
+			return call_user_func_array([$this, 'createComponent'], func_get_args());
+
+		} else {
+
+			return call_user_func_array([$this, 'createProperty'], func_get_args());
+
+		}
+
+	}
+
+	/**
+	 * Creates a new component.
+	 *
+	 * This method automatically searches for the correct component class, based
+	 * on its name.
+	 *
+	 * You can specify the children either in key=>value syntax, in which case
+	 * properties will automatically be created, or you can just pass a list of
+	 * Component and Property object.
+	 *
+	 * By default, a set of sensible values will be added to the component. For
+	 * an iCalendar object, this may be something like CALSCALE:GREGORIAN. To
+	 * ensure that this does not happen, set $defaults to false.
+	 *
+	 * @param string $name
+	 * @param array $children
+	 * @param bool $defaults
+	 *
+	 * @return Component
+	 */
+	public function createComponent($name, array $children = null, $defaults = true) {
+
+		$name = strtoupper($name);
+		$class = 'Sabre\\VObject\\Component';
+
+		if (isset(static::$componentMap[$name])) {
+			$class = static::$componentMap[$name];
+		}
+		if (is_null($children)) $children = [];
+		return new $class($this, $name, $children, $defaults);
+
+	}
+
+	/**
+	 * Factory method for creating new properties.
+	 *
+	 * This method automatically searches for the correct property class, based
+	 * on its name.
+	 *
+	 * You can specify the parameters either in key=>value syntax, in which case
+	 * parameters will automatically be created, or you can just pass a list of
+	 * Parameter objects.
+	 *
+	 * @param string $name
+	 * @param mixed $value
+	 * @param array $parameters
+	 * @param string $valueType Force a specific valuetype, such as URI or TEXT
+	 *
+	 * @return Property
+	 */
+	public function createProperty($name, $value = null, array $parameters = null, $valueType = null) {
+
+		// If there's a . in the name, it means it's prefixed by a groupname.
+		if (($i = strpos($name, '.')) !== false) {
+			$group = substr($name, 0, $i);
+			$name = strtoupper(substr($name, $i + 1));
+		} else {
+			$name = strtoupper($name);
+			$group = null;
+		}
+
+		$class = null;
+
+		if ($valueType) {
+			// The valueType argument comes first to figure out the correct
+			// class.
+			$class = $this->getClassNameForPropertyValue($valueType);
+		}
+
+		if (is_null($class)) {
+			// If a VALUE parameter is supplied, we should use that.
+			if (isset($parameters['VALUE'])) {
+				$class = $this->getClassNameForPropertyValue($parameters['VALUE']);
+				if (is_null($class)) {
+					throw new InvalidDataException('Unsupported VALUE parameter for ' . $name . ' property. You supplied "' . $parameters['VALUE'] . '"');
+				}
+			}
+			else {
+				$class = $this->getClassNameForPropertyName($name);
+			}
+		}
+		if (is_null($parameters)) $parameters = [];
+
+		return new $class($this, $name, $value, $parameters, $group);
+
+	}
+
+	/**
+	 * This method returns a full class-name for a value parameter.
+	 *
+	 * For instance, DTSTART may have VALUE=DATE. In that case we will look in
+	 * our valueMap table and return the appropriate class name.
+	 *
+	 * This method returns null if we don't have a specialized class.
+	 *
+	 * @param string $valueParam
+	 * @return string|null
+	 */
+	public function getClassNameForPropertyValue($valueParam) {
+
+		$valueParam = strtoupper($valueParam);
+		if (isset(static::$valueMap[$valueParam])) {
+			return static::$valueMap[$valueParam];
+		}
+
+	}
+
+	/**
+	 * Returns the default class for a property name.
+	 *
+	 * @param string $propertyName
+	 *
+	 * @return string
+	 */
+	public function getClassNameForPropertyName($propertyName) {
+
+		if (isset(static::$propertyMap[$propertyName])) {
+			return static::$propertyMap[$propertyName];
+		} else {
+			return 'Sabre\\VObject\\Property\\Unknown';
+		}
+
+	}
 
 }

libraries/SabreDAV/VObject/BirthdayCalendarGenerator.php

Indentation +168 added lines, -168 removed lines

@@ -13,179 +13,179 @@
  */
 class BirthdayCalendarGenerator {
 
-    /**
-     * Input objects.
-     *
-     * @var array
-     */
-    protected $objects = [];
+	/**
+	 * Input objects.
+	 *
+	 * @var array
+	 */
+	protected $objects = [];
 
-    /**
-     * Default year.
-     * Used for dates without a year.
-     */
-    const DEFAULT_YEAR = 2000;
-
-    /**
-     * Output format for the SUMMARY.
-     *
-     * @var string
-     */
-    protected $format = '%1$s\'s Birthday';
-
-    /**
-     * Creates the generator.
-     *
-     * Check the setTimeRange and setObjects methods for details about the
-     * arguments.
-     *
-     * @param mixed $objects
-     */
-    public function __construct($objects = null) {
-
-        if ($objects) {
-            $this->setObjects($objects);
-        }
-
-    }
-
-    /**
-     * Sets the input objects.
-     *
-     * You must either supply a vCard as a string or as a Component/VCard object.
-     * It's also possible to supply an array of strings or objects.
-     *
-     * @param mixed $objects
-     *
-     * @return void
-     */
-    public function setObjects($objects) {
-
-        if (!is_array($objects)) {
-            $objects = [$objects];
-        }
-
-        $this->objects = [];
-        foreach ($objects as $object) {
-
-            if (is_string($object)) {
-
-                $vObj = Reader::read($object);
-                if (!$vObj instanceof Component\VCard) {
-                    throw new \InvalidArgumentException('String could not be parsed as \\Sabre\\VObject\\Component\\VCard by setObjects');
-                }
-
-                $this->objects[] = $vObj;
-
-            } elseif ($object instanceof Component\VCard) {
-
-                $this->objects[] = $object;
-
-            } else {
-
-                throw new \InvalidArgumentException('You can only pass strings or \\Sabre\\VObject\\Component\\VCard arguments to setObjects');
-
-            }
-
-        }
-
-    }
-
-    /**
-     * Sets the output format for the SUMMARY
-     *
-     * @param string $format
-     *
-     * @return void
-     */
-    public function setFormat($format) {
-
-        $this->format = $format;
-
-    }
-
-    /**
-     * Parses the input data and returns a VCALENDAR.
-     *
-     * @return Component/VCalendar
-     */
-    public function getResult() {
-
-        $calendar = new VCalendar();
-
-        foreach ($this->objects as $object) {
-
-            // Skip if there is no BDAY property.
-            if (!$object->select('BDAY')) {
-                continue;
-            }
-
-            // We've seen clients (ez-vcard) putting "BDAY:" properties
-            // without a value into vCards. If we come across those, we'll
-            // skip them.
-            if (empty($object->BDAY->getValue())) {
-                continue;
-            }
-
-            // We're always converting to vCard 4.0 so we can rely on the
-            // VCardConverter handling the X-APPLE-OMIT-YEAR property for us.
-            $object = $object->convert(Document::VCARD40);
-
-            // Skip if the card has no FN property.
-            if (!isset($object->FN)) {
-                continue;
-            }
-
-            // Skip if the BDAY property is not of the right type.
-            if (!$object->BDAY instanceof Property\VCard\DateAndOrTime) {
-                continue;
-            }
+	/**
+	 * Default year.
+	 * Used for dates without a year.
+	 */
+	const DEFAULT_YEAR = 2000;
+
+	/**
+	 * Output format for the SUMMARY.
+	 *
+	 * @var string
+	 */
+	protected $format = '%1$s\'s Birthday';
+
+	/**
+	 * Creates the generator.
+	 *
+	 * Check the setTimeRange and setObjects methods for details about the
+	 * arguments.
+	 *
+	 * @param mixed $objects
+	 */
+	public function __construct($objects = null) {
+
+		if ($objects) {
+			$this->setObjects($objects);
+		}
+
+	}
+
+	/**
+	 * Sets the input objects.
+	 *
+	 * You must either supply a vCard as a string or as a Component/VCard object.
+	 * It's also possible to supply an array of strings or objects.
+	 *
+	 * @param mixed $objects
+	 *
+	 * @return void
+	 */
+	public function setObjects($objects) {
+
+		if (!is_array($objects)) {
+			$objects = [$objects];
+		}
+
+		$this->objects = [];
+		foreach ($objects as $object) {
+
+			if (is_string($object)) {
+
+				$vObj = Reader::read($object);
+				if (!$vObj instanceof Component\VCard) {
+					throw new \InvalidArgumentException('String could not be parsed as \\Sabre\\VObject\\Component\\VCard by setObjects');
+				}
+
+				$this->objects[] = $vObj;
+
+			} elseif ($object instanceof Component\VCard) {
+
+				$this->objects[] = $object;
+
+			} else {
+
+				throw new \InvalidArgumentException('You can only pass strings or \\Sabre\\VObject\\Component\\VCard arguments to setObjects');
+
+			}
+
+		}
+
+	}
+
+	/**
+	 * Sets the output format for the SUMMARY
+	 *
+	 * @param string $format
+	 *
+	 * @return void
+	 */
+	public function setFormat($format) {
+
+		$this->format = $format;
+
+	}
+
+	/**
+	 * Parses the input data and returns a VCALENDAR.
+	 *
+	 * @return Component/VCalendar
+	 */
+	public function getResult() {
+
+		$calendar = new VCalendar();
+
+		foreach ($this->objects as $object) {
+
+			// Skip if there is no BDAY property.
+			if (!$object->select('BDAY')) {
+				continue;
+			}
+
+			// We've seen clients (ez-vcard) putting "BDAY:" properties
+			// without a value into vCards. If we come across those, we'll
+			// skip them.
+			if (empty($object->BDAY->getValue())) {
+				continue;
+			}
+
+			// We're always converting to vCard 4.0 so we can rely on the
+			// VCardConverter handling the X-APPLE-OMIT-YEAR property for us.
+			$object = $object->convert(Document::VCARD40);
+
+			// Skip if the card has no FN property.
+			if (!isset($object->FN)) {
+				continue;
+			}
+
+			// Skip if the BDAY property is not of the right type.
+			if (!$object->BDAY instanceof Property\VCard\DateAndOrTime) {
+				continue;
+			}
 
-            // Skip if we can't parse the BDAY value.
-            try {
-                $dateParts = DateTimeParser::parseVCardDateTime($object->BDAY->getValue());
-            } catch (InvalidDataException $e) {
-                continue;
-            }
-
-            // Set a year if it's not set.
-            $unknownYear = false;
-
-            if (!$dateParts['year']) {
-                $object->BDAY = self::DEFAULT_YEAR . '-' . $dateParts['month'] . '-' . $dateParts['date'];
+			// Skip if we can't parse the BDAY value.
+			try {
+				$dateParts = DateTimeParser::parseVCardDateTime($object->BDAY->getValue());
+			} catch (InvalidDataException $e) {
+				continue;
+			}
+
+			// Set a year if it's not set.
+			$unknownYear = false;
+
+			if (!$dateParts['year']) {
+				$object->BDAY = self::DEFAULT_YEAR . '-' . $dateParts['month'] . '-' . $dateParts['date'];
 
-                $unknownYear = true;
-            }
+				$unknownYear = true;
+			}
 
-            // Create event.
-            $event = $calendar->add('VEVENT', [
-                'SUMMARY'      => sprintf($this->format, $object->FN->getValue()),
-                'DTSTART'      => new \DateTime($object->BDAY->getValue()),
-                'RRULE'        => 'FREQ=YEARLY',
-                'TRANSP'       => 'TRANSPARENT',
-            ]);
+			// Create event.
+			$event = $calendar->add('VEVENT', [
+				'SUMMARY'      => sprintf($this->format, $object->FN->getValue()),
+				'DTSTART'      => new \DateTime($object->BDAY->getValue()),
+				'RRULE'        => 'FREQ=YEARLY',
+				'TRANSP'       => 'TRANSPARENT',
+			]);
 
-            // add VALUE=date
-            $event->DTSTART['VALUE'] = 'DATE';
+			// add VALUE=date
+			$event->DTSTART['VALUE'] = 'DATE';
 
-            // Add X-SABRE-BDAY property.
-            if ($unknownYear) {
-                $event->add('X-SABRE-BDAY', 'BDAY', [
-                    'X-SABRE-VCARD-UID' => $object->UID->getValue(),
-                    'X-SABRE-VCARD-FN'  => $object->FN->getValue(),
-                    'X-SABRE-OMIT-YEAR' => self::DEFAULT_YEAR,
-                ]);
-            } else {
-                $event->add('X-SABRE-BDAY', 'BDAY', [
-                    'X-SABRE-VCARD-UID' => $object->UID->getValue(),
-                    'X-SABRE-VCARD-FN'  => $object->FN->getValue(),
-                ]);
-            }
-
-        }
-
-        return $calendar;
-
-    }
+			// Add X-SABRE-BDAY property.
+			if ($unknownYear) {
+				$event->add('X-SABRE-BDAY', 'BDAY', [
+					'X-SABRE-VCARD-UID' => $object->UID->getValue(),
+					'X-SABRE-VCARD-FN'  => $object->FN->getValue(),
+					'X-SABRE-OMIT-YEAR' => self::DEFAULT_YEAR,
+				]);
+			} else {
+				$event->add('X-SABRE-BDAY', 'BDAY', [
+					'X-SABRE-VCARD-UID' => $object->UID->getValue(),
+					'X-SABRE-VCARD-FN'  => $object->FN->getValue(),
+				]);
+			}
+
+		}
+
+		return $calendar;
+
+	}
 
 }

libraries/SabreDAV/VObject/ITip/Broker.php

Indentation +948 added lines, -948 removed lines

@@ -37,953 +37,953 @@
  */
 class Broker {
 
-    /**
-     * This setting determines whether the rules for the SCHEDULE-AGENT
-     * parameter should be followed.
-     *
-     * This is a parameter defined on ATTENDEE properties, introduced by RFC
-     * 6638. This parameter allows a caldav client to tell the server 'Don't do
-     * any scheduling operations'.
-     *
-     * If this setting is turned on, any attendees with SCHEDULE-AGENT set to
-     * CLIENT will be ignored. This is the desired behavior for a CalDAV
-     * server, but if you're writing an iTip application that doesn't deal with
-     * CalDAV, you may want to ignore this parameter.
-     *
-     * @var bool
-     */
-    public $scheduleAgentServerRules = true;
-
-    /**
-     * The broker will try during 'parseEvent' figure out whether the change
-     * was significant.
-     *
-     * It uses a few different ways to do this. One of these ways is seeing if
-     * certain properties changed values. This list of specified here.
-     *
-     * This list is taken from:
-     * * http://tools.ietf.org/html/rfc5546#section-2.1.4
-     *
-     * @var string[]
-     */
-    public $significantChangeProperties = [
-        'DTSTART',
-        'DTEND',
-        'DURATION',
-        'DUE',
-        'RRULE',
-        'RDATE',
-        'EXDATE',
-        'STATUS',
-    ];
-
-    /**
-     * This method is used to process an incoming itip message.
-     *
-     * Examples:
-     *
-     * 1. A user is an attendee to an event. The organizer sends an updated
-     * meeting using a new iTip message with METHOD:REQUEST. This function
-     * will process the message and update the attendee's event accordingly.
-     *
-     * 2. The organizer cancelled the event using METHOD:CANCEL. We will update
-     * the users event to state STATUS:CANCELLED.
-     *
-     * 3. An attendee sent a reply to an invite using METHOD:REPLY. We can
-     * update the organizers event to update the ATTENDEE with its correct
-     * PARTSTAT.
-     *
-     * The $existingObject is updated in-place. If there is no existing object
-     * (because it's a new invite for example) a new object will be created.
-     *
-     * If an existing object does not exist, and the method was CANCEL or
-     * REPLY, the message effectively gets ignored, and no 'existingObject'
-     * will be created.
-     *
-     * The updated $existingObject is also returned from this function.
-     *
-     * If the iTip message was not supported, we will always return false.
-     *
-     * @param Message $itipMessage
-     * @param VCalendar $existingObject
-     *
-     * @return VCalendar|null
-     */
-    public function processMessage(Message $itipMessage, VCalendar $existingObject = null) {
-
-        // We only support events at the moment.
-        if ($itipMessage->component !== 'VEVENT') {
-            return false;
-        }
-
-        switch ($itipMessage->method) {
-
-            case 'REQUEST' :
-                return $this->processMessageRequest($itipMessage, $existingObject);
-
-            case 'CANCEL' :
-                return $this->processMessageCancel($itipMessage, $existingObject);
-
-            case 'REPLY' :
-                return $this->processMessageReply($itipMessage, $existingObject);
-
-            default :
-                // Unsupported iTip message
-                return;
-
-        }
-
-        return $existingObject;
-
-    }
-
-    /**
-     * This function parses a VCALENDAR object and figure out if any messages
-     * need to be sent.
-     *
-     * A VCALENDAR object will be created from the perspective of either an
-     * attendee, or an organizer. You must pass a string identifying the
-     * current user, so we can figure out who in the list of attendees or the
-     * organizer we are sending this message on behalf of.
-     *
-     * It's possible to specify the current user as an array, in case the user
-     * has more than one identifying href (such as multiple emails).
-     *
-     * It $oldCalendar is specified, it is assumed that the operation is
-     * updating an existing event, which means that we need to look at the
-     * differences between events, and potentially send old attendees
-     * cancellations, and current attendees updates.
-     *
-     * If $calendar is null, but $oldCalendar is specified, we treat the
-     * operation as if the user has deleted an event. If the user was an
-     * organizer, this means that we need to send cancellation notices to
-     * people. If the user was an attendee, we need to make sure that the
-     * organizer gets the 'declined' message.
-     *
-     * @param VCalendar|string $calendar
-     * @param string|array $userHref
-     * @param VCalendar|string $oldCalendar
-     *
-     * @return array
-     */
-    public function parseEvent($calendar = null, $userHref, $oldCalendar = null) {
-
-        if ($oldCalendar) {
-            if (is_string($oldCalendar)) {
-                $oldCalendar = Reader::read($oldCalendar);
-            }
-            if (!isset($oldCalendar->VEVENT)) {
-                // We only support events at the moment
-                return [];
-            }
-
-            $oldEventInfo = $this->parseEventInfo($oldCalendar);
-        } else {
-            $oldEventInfo = [
-                'organizer'             => null,
-                'significantChangeHash' => '',
-                'attendees'             => [],
-            ];
-        }
-
-        $userHref = (array)$userHref;
-
-        if (!is_null($calendar)) {
-
-            if (is_string($calendar)) {
-                $calendar = Reader::read($calendar);
-            }
-            if (!isset($calendar->VEVENT)) {
-                // We only support events at the moment
-                return [];
-            }
-            $eventInfo = $this->parseEventInfo($calendar);
-            if (!$eventInfo['attendees'] && !$oldEventInfo['attendees']) {
-                // If there were no attendees on either side of the equation,
-                // we don't need to do anything.
-                return [];
-            }
-            if (!$eventInfo['organizer'] && !$oldEventInfo['organizer']) {
-                // There was no organizer before or after the change.
-                return [];
-            }
-
-            $baseCalendar = $calendar;
-
-            // If the new object didn't have an organizer, the organizer
-            // changed the object from a scheduling object to a non-scheduling
-            // object. We just copy the info from the old object.
-            if (!$eventInfo['organizer'] && $oldEventInfo['organizer']) {
-                $eventInfo['organizer'] = $oldEventInfo['organizer'];
-                $eventInfo['organizerName'] = $oldEventInfo['organizerName'];
-            }
-
-        } else {
-            // The calendar object got deleted, we need to process this as a
-            // cancellation / decline.
-            if (!$oldCalendar) {
-                // No old and no new calendar, there's no thing to do.
-                return [];
-            }
-
-            $eventInfo = $oldEventInfo;
-
-            if (in_array($eventInfo['organizer'], $userHref)) {
-                // This is an organizer deleting the event.
-                $eventInfo['attendees'] = [];
-                // Increasing the sequence, but only if the organizer deleted
-                // the event.
-                $eventInfo['sequence']++;
-            } else {
-                // This is an attendee deleting the event.
-                foreach ($eventInfo['attendees'] as $key => $attendee) {
-                    if (in_array($attendee['href'], $userHref)) {
-                        $eventInfo['attendees'][$key]['instances'] = ['master' =>
-                            ['id' => 'master', 'partstat' => 'DECLINED']
-                        ];
-                    }
-                }
-            }
-            $baseCalendar = $oldCalendar;
-
-        }
-
-        if (in_array($eventInfo['organizer'], $userHref)) {
-            return $this->parseEventForOrganizer($baseCalendar, $eventInfo, $oldEventInfo);
-        } elseif ($oldCalendar) {
-            // We need to figure out if the user is an attendee, but we're only
-            // doing so if there's an oldCalendar, because we only want to
-            // process updates, not creation of new events.
-            foreach ($eventInfo['attendees'] as $attendee) {
-                if (in_array($attendee['href'], $userHref)) {
-                    return $this->parseEventForAttendee($baseCalendar, $eventInfo, $oldEventInfo, $attendee['href']);
-                }
-            }
-        }
-        return [];
-
-    }
-
-    /**
-     * Processes incoming REQUEST messages.
-     *
-     * This is message from an organizer, and is either a new event
-     * invite, or an update to an existing one.
-     *
-     *
-     * @param Message $itipMessage
-     * @param VCalendar $existingObject
-     *
-     * @return VCalendar|null
-     */
-    protected function processMessageRequest(Message $itipMessage, VCalendar $existingObject = null) {
-
-        if (!$existingObject) {
-            // This is a new invite, and we're just going to copy over
-            // all the components from the invite.
-            $existingObject = new VCalendar();
-            foreach ($itipMessage->message->getComponents() as $component) {
-                $existingObject->add(clone $component);
-            }
-        } else {
-            // We need to update an existing object with all the new
-            // information. We can just remove all existing components
-            // and create new ones.
-            foreach ($existingObject->getComponents() as $component) {
-                $existingObject->remove($component);
-            }
-            foreach ($itipMessage->message->getComponents() as $component) {
-                $existingObject->add(clone $component);
-            }
-        }
-        return $existingObject;
-
-    }
-
-    /**
-     * Processes incoming CANCEL messages.
-     *
-     * This is a message from an organizer, and means that either an
-     * attendee got removed from an event, or an event got cancelled
-     * altogether.
-     *
-     * @param Message $itipMessage
-     * @param VCalendar $existingObject
-     *
-     * @return VCalendar|null
-     */
-    protected function processMessageCancel(Message $itipMessage, VCalendar $existingObject = null) {
-
-        if (!$existingObject) {
-            // The event didn't exist in the first place, so we're just
-            // ignoring this message.
-        } else {
-            foreach ($existingObject->VEVENT as $vevent) {
-                $vevent->STATUS = 'CANCELLED';
-                $vevent->SEQUENCE = $itipMessage->sequence;
-            }
-        }
-        return $existingObject;
-
-    }
-
-    /**
-     * Processes incoming REPLY messages.
-     *
-     * The message is a reply. This is for example an attendee telling
-     * an organizer he accepted the invite, or declined it.
-     *
-     * @param Message $itipMessage
-     * @param VCalendar $existingObject
-     *
-     * @return VCalendar|null
-     */
-    protected function processMessageReply(Message $itipMessage, VCalendar $existingObject = null) {
-
-        // A reply can only be processed based on an existing object.
-        // If the object is not available, the reply is ignored.
-        if (!$existingObject) {
-            return;
-        }
-        $instances = [];
-        $requestStatus = '2.0';
-
-        // Finding all the instances the attendee replied to.
-        foreach ($itipMessage->message->VEVENT as $vevent) {
-            $recurId = isset($vevent->{'RECURRENCE-ID'}) ? $vevent->{'RECURRENCE-ID'}->getValue() : 'master';
-            $attendee = $vevent->ATTENDEE;
-            $instances[$recurId] = $attendee['PARTSTAT']->getValue();
-            if (isset($vevent->{'REQUEST-STATUS'})) {
-                $requestStatus = $vevent->{'REQUEST-STATUS'}->getValue();
-                list($requestStatus) = explode(';', $requestStatus);
-            }
-        }
-
-        // Now we need to loop through the original organizer event, to find
-        // all the instances where we have a reply for.
-        $masterObject = null;
-        foreach ($existingObject->VEVENT as $vevent) {
-            $recurId = isset($vevent->{'RECURRENCE-ID'}) ? $vevent->{'RECURRENCE-ID'}->getValue() : 'master';
-            if ($recurId === 'master') {
-                $masterObject = $vevent;
-            }
-            if (isset($instances[$recurId])) {
-                $attendeeFound = false;
-                if (isset($vevent->ATTENDEE)) {
-                    foreach ($vevent->ATTENDEE as $attendee) {
-                        if ($attendee->getValue() === $itipMessage->sender) {
-                            $attendeeFound = true;
-                            $attendee['PARTSTAT'] = $instances[$recurId];
-                            $attendee['SCHEDULE-STATUS'] = $requestStatus;
-                            // Un-setting the RSVP status, because we now know
-                            // that the attendee already replied.
-                            unset($attendee['RSVP']);
-                            break;
-                        }
-                    }
-                }
-                if (!$attendeeFound) {
-                    // Adding a new attendee. The iTip documentation calls this
-                    // a party crasher.
-                    $attendee = $vevent->add('ATTENDEE', $itipMessage->sender, [
-                        'PARTSTAT' => $instances[$recurId]
-                    ]);
-                    if ($itipMessage->senderName) $attendee['CN'] = $itipMessage->senderName;
-                }
-                unset($instances[$recurId]);
-            }
-        }
-
-        if (!$masterObject) {
-            // No master object, we can't add new instances.
-            return;
-        }
-        // If we got replies to instances that did not exist in the
-        // original list, it means that new exceptions must be created.
-        foreach ($instances as $recurId => $partstat) {
-
-            $recurrenceIterator = new EventIterator($existingObject, $itipMessage->uid);
-            $found = false;
-            $iterations = 1000;
-            do {
-
-                $newObject = $recurrenceIterator->getEventObject();
-                $recurrenceIterator->next();
-
-                if (isset($newObject->{'RECURRENCE-ID'}) && $newObject->{'RECURRENCE-ID'}->getValue() === $recurId) {
-                    $found = true;
-                }
-                $iterations--;
-
-            } while ($recurrenceIterator->valid() && !$found && $iterations);
-
-            // Invalid recurrence id. Skipping this object.
-            if (!$found) continue;
-
-            unset(
-                $newObject->RRULE,
-                $newObject->EXDATE,
-                $newObject->RDATE
-            );
-            $attendeeFound = false;
-            if (isset($newObject->ATTENDEE)) {
-                foreach ($newObject->ATTENDEE as $attendee) {
-                    if ($attendee->getValue() === $itipMessage->sender) {
-                        $attendeeFound = true;
-                        $attendee['PARTSTAT'] = $partstat;
-                        break;
-                    }
-                }
-            }
-            if (!$attendeeFound) {
-                // Adding a new attendee
-                $attendee = $newObject->add('ATTENDEE', $itipMessage->sender, [
-                    'PARTSTAT' => $partstat
-                ]);
-                if ($itipMessage->senderName) {
-                    $attendee['CN'] = $itipMessage->senderName;
-                }
-            }
-            $existingObject->add($newObject);
-
-        }
-        return $existingObject;
-
-    }
-
-    /**
-     * This method is used in cases where an event got updated, and we
-     * potentially need to send emails to attendees to let them know of updates
-     * in the events.
-     *
-     * We will detect which attendees got added, which got removed and create
-     * specific messages for these situations.
-     *
-     * @param VCalendar $calendar
-     * @param array $eventInfo
-     * @param array $oldEventInfo
-     *
-     * @return array
-     */
-    protected function parseEventForOrganizer(VCalendar $calendar, array $eventInfo, array $oldEventInfo) {
-
-        // Merging attendee lists.
-        $attendees = [];
-        foreach ($oldEventInfo['attendees'] as $attendee) {
-            $attendees[$attendee['href']] = [
-                'href'         => $attendee['href'],
-                'oldInstances' => $attendee['instances'],
-                'newInstances' => [],
-                'name'         => $attendee['name'],
-                'forceSend'    => null,
-            ];
-        }
-        foreach ($eventInfo['attendees'] as $attendee) {
-            if (isset($attendees[$attendee['href']])) {
-                $attendees[$attendee['href']]['name'] = $attendee['name'];
-                $attendees[$attendee['href']]['newInstances'] = $attendee['instances'];
-                $attendees[$attendee['href']]['forceSend'] = $attendee['forceSend'];
-            } else {
-                $attendees[$attendee['href']] = [
-                    'href'         => $attendee['href'],
-                    'oldInstances' => [],
-                    'newInstances' => $attendee['instances'],
-                    'name'         => $attendee['name'],
-                    'forceSend'    => $attendee['forceSend'],
-                ];
-            }
-        }
-
-        $messages = [];
-
-        foreach ($attendees as $attendee) {
-
-            // An organizer can also be an attendee. We should not generate any
-            // messages for those.
-            if ($attendee['href'] === $eventInfo['organizer']) {
-                continue;
-            }
-
-            $message = new Message();
-            $message->uid = $eventInfo['uid'];
-            $message->component = 'VEVENT';
-            $message->sequence = $eventInfo['sequence'];
-            $message->sender = $eventInfo['organizer'];
-            $message->senderName = $eventInfo['organizerName'];
-            $message->recipient = $attendee['href'];
-            $message->recipientName = $attendee['name'];
-
-            if (!$attendee['newInstances']) {
-
-                // If there are no instances the attendee is a part of, it
-                // means the attendee was removed and we need to send him a
-                // CANCEL.
-                $message->method = 'CANCEL';
-
-                // Creating the new iCalendar body.
-                $icalMsg = new VCalendar();
-                $icalMsg->METHOD = $message->method;
-                $event = $icalMsg->add('VEVENT', [
-                    'UID'      => $message->uid,
-                    'SEQUENCE' => $message->sequence,
-                ]);
-                if (isset($calendar->VEVENT->SUMMARY)) {
-                    $event->add('SUMMARY', $calendar->VEVENT->SUMMARY->getValue());
-                }
-                $event->add(clone $calendar->VEVENT->DTSTART);
-                if (isset($calendar->VEVENT->DTEND)) {
-                    $event->add(clone $calendar->VEVENT->DTEND);
-                } elseif (isset($calendar->VEVENT->DURATION)) {
-                    $event->add(clone $calendar->VEVENT->DURATION);
-                }
-                $org = $event->add('ORGANIZER', $eventInfo['organizer']);
-                if ($eventInfo['organizerName']) $org['CN'] = $eventInfo['organizerName'];
-                $event->add('ATTENDEE', $attendee['href'], [
-                    'CN' => $attendee['name'],
-                ]);
-                $message->significantChange = true;
-
-            } else {
-
-                // The attendee gets the updated event body
-                $message->method = 'REQUEST';
-
-                // Creating the new iCalendar body.
-                $icalMsg = new VCalendar();
-                $icalMsg->METHOD = $message->method;
-
-                foreach ($calendar->select('VTIMEZONE') as $timezone) {
-                    $icalMsg->add(clone $timezone);
-                }
-
-                // We need to find out that this change is significant. If it's
-                // not, systems may opt to not send messages.
-                //
-                // We do this based on the 'significantChangeHash' which is
-                // some value that changes if there's a certain set of
-                // properties changed in the event, or simply if there's a
-                // difference in instances that the attendee is invited to.
-
-                $message->significantChange =
-                    $attendee['forceSend'] === 'REQUEST' ||
-                    array_keys($attendee['oldInstances']) != array_keys($attendee['newInstances']) ||
-                    $oldEventInfo['significantChangeHash'] !== $eventInfo['significantChangeHash'];
-
-                foreach ($attendee['newInstances'] as $instanceId => $instanceInfo) {
-
-                    $currentEvent = clone $eventInfo['instances'][$instanceId];
-                    if ($instanceId === 'master') {
-
-                        // We need to find a list of events that the attendee
-                        // is not a part of to add to the list of exceptions.
-                        $exceptions = [];
-                        foreach ($eventInfo['instances'] as $instanceId => $vevent) {
-                            if (!isset($attendee['newInstances'][$instanceId])) {
-                                $exceptions[] = $instanceId;
-                            }
-                        }
-
-                        // If there were exceptions, we need to add it to an
-                        // existing EXDATE property, if it exists.
-                        if ($exceptions) {
-                            if (isset($currentEvent->EXDATE)) {
-                                $currentEvent->EXDATE->setParts(array_merge(
-                                    $currentEvent->EXDATE->getParts(),
-                                    $exceptions
-                                ));
-                            } else {
-                                $currentEvent->EXDATE = $exceptions;
-                            }
-                        }
-
-                        // Cleaning up any scheduling information that
-                        // shouldn't be sent along.
-                        unset($currentEvent->ORGANIZER['SCHEDULE-FORCE-SEND']);
-                        unset($currentEvent->ORGANIZER['SCHEDULE-STATUS']);
-
-                        foreach ($currentEvent->ATTENDEE as $attendee) {
-                            unset($attendee['SCHEDULE-FORCE-SEND']);
-                            unset($attendee['SCHEDULE-STATUS']);
-
-                            // We're adding PARTSTAT=NEEDS-ACTION to ensure that
-                            // iOS shows an "Inbox Item"
-                            if (!isset($attendee['PARTSTAT'])) {
-                                $attendee['PARTSTAT'] = 'NEEDS-ACTION';
-                            }
-
-                        }
-
-                    }
-
-                    $icalMsg->add($currentEvent);
-
-                }
-
-            }
-
-            $message->message = $icalMsg;
-            $messages[] = $message;
-
-        }
-
-        return $messages;
-
-    }
-
-    /**
-     * Parse an event update for an attendee.
-     *
-     * This function figures out if we need to send a reply to an organizer.
-     *
-     * @param VCalendar $calendar
-     * @param array $eventInfo
-     * @param array $oldEventInfo
-     * @param string $attendee
-     *
-     * @return Message[]
-     */
-    protected function parseEventForAttendee(VCalendar $calendar, array $eventInfo, array $oldEventInfo, $attendee) {
-
-        if ($this->scheduleAgentServerRules && $eventInfo['organizerScheduleAgent'] === 'CLIENT') {
-            return [];
-        }
-
-        // Don't bother generating messages for events that have already been
-        // cancelled.
-        if ($eventInfo['status'] === 'CANCELLED') {
-            return [];
-        }
-
-        $oldInstances = !empty($oldEventInfo['attendees'][$attendee]['instances']) ?
-            $oldEventInfo['attendees'][$attendee]['instances'] :
-            [];
-
-        $instances = [];
-        foreach ($oldInstances as $instance) {
-
-            $instances[$instance['id']] = [
-                'id'        => $instance['id'],
-                'oldstatus' => $instance['partstat'],
-                'newstatus' => null,
-            ];
-
-        }
-        foreach ($eventInfo['attendees'][$attendee]['instances'] as $instance) {
-
-            if (isset($instances[$instance['id']])) {
-                $instances[$instance['id']]['newstatus'] = $instance['partstat'];
-            } else {
-                $instances[$instance['id']] = [
-                    'id'        => $instance['id'],
-                    'oldstatus' => null,
-                    'newstatus' => $instance['partstat'],
-                ];
-            }
-
-        }
-
-        // We need to also look for differences in EXDATE. If there are new
-        // items in EXDATE, it means that an attendee deleted instances of an
-        // event, which means we need to send DECLINED specifically for those
-        // instances.
-        // We only need to do that though, if the master event is not declined.
-        if (isset($instances['master']) && $instances['master']['newstatus'] !== 'DECLINED') {
-            foreach ($eventInfo['exdate'] as $exDate) {
-
-                if (!in_array($exDate, $oldEventInfo['exdate'])) {
-                    if (isset($instances[$exDate])) {
-                        $instances[$exDate]['newstatus'] = 'DECLINED';
-                    } else {
-                        $instances[$exDate] = [
-                            'id'        => $exDate,
-                            'oldstatus' => null,
-                            'newstatus' => 'DECLINED',
-                        ];
-                    }
-                }
-
-            }
-        }
-
-        // Gathering a few extra properties for each instance.
-        foreach ($instances as $recurId => $instanceInfo) {
-
-            if (isset($eventInfo['instances'][$recurId])) {
-                $instances[$recurId]['dtstart'] = clone $eventInfo['instances'][$recurId]->DTSTART;
-            } else {
-                $instances[$recurId]['dtstart'] = $recurId;
-            }
-
-        }
-
-        $message = new Message();
-        $message->uid = $eventInfo['uid'];
-        $message->method = 'REPLY';
-        $message->component = 'VEVENT';
-        $message->sequence = $eventInfo['sequence'];
-        $message->sender = $attendee;
-        $message->senderName = $eventInfo['attendees'][$attendee]['name'];
-        $message->recipient = $eventInfo['organizer'];
-        $message->recipientName = $eventInfo['organizerName'];
-
-        $icalMsg = new VCalendar();
-        $icalMsg->METHOD = 'REPLY';
-
-        $hasReply = false;
-
-        foreach ($instances as $instance) {
-
-            if ($instance['oldstatus'] == $instance['newstatus'] && $eventInfo['organizerForceSend'] !== 'REPLY') {
-                // Skip
-                continue;
-            }
-
-            $event = $icalMsg->add('VEVENT', [
-                'UID'      => $message->uid,
-                'SEQUENCE' => $message->sequence,
-            ]);
-            $summary = isset($calendar->VEVENT->SUMMARY) ? $calendar->VEVENT->SUMMARY->getValue() : '';
-            // Adding properties from the correct source instance
-            if (isset($eventInfo['instances'][$instance['id']])) {
-                $instanceObj = $eventInfo['instances'][$instance['id']];
-                $event->add(clone $instanceObj->DTSTART);
-                if (isset($instanceObj->DTEND)) {
-                    $event->add(clone $instanceObj->DTEND);
-                } elseif (isset($instanceObj->DURATION)) {
-                    $event->add(clone $instanceObj->DURATION);
-                }
-                if (isset($instanceObj->SUMMARY)) {
-                    $event->add('SUMMARY', $instanceObj->SUMMARY->getValue());
-                } elseif ($summary) {
-                    $event->add('SUMMARY', $summary);
-                }
-            } else {
-                // This branch of the code is reached, when a reply is
-                // generated for an instance of a recurring event, through the
-                // fact that the instance has disappeared by showing up in
-                // EXDATE
-                $dt = DateTimeParser::parse($instance['id'], $eventInfo['timezone']);
-                // Treat is as a DATE field
-                if (strlen($instance['id']) <= 8) {
-                    $event->add('DTSTART', $dt, ['VALUE' => 'DATE']);
-                } else {
-                    $event->add('DTSTART', $dt);
-                }
-                if ($summary) {
-                    $event->add('SUMMARY', $summary);
-                }
-            }
-            if ($instance['id'] !== 'master') {
-                $dt = DateTimeParser::parse($instance['id'], $eventInfo['timezone']);
-                // Treat is as a DATE field
-                if (strlen($instance['id']) <= 8) {
-                    $event->add('RECURRENCE-ID', $dt, ['VALUE' => 'DATE']);
-                } else {
-                    $event->add('RECURRENCE-ID', $dt);
-                }
-            }
-            $organizer = $event->add('ORGANIZER', $message->recipient);
-            if ($message->recipientName) {
-                $organizer['CN'] = $message->recipientName;
-            }
-            $attendee = $event->add('ATTENDEE', $message->sender, [
-                'PARTSTAT' => $instance['newstatus']
-            ]);
-            if ($message->senderName) {
-                $attendee['CN'] = $message->senderName;
-            }
-            $hasReply = true;
-
-        }
-
-        if ($hasReply) {
-            $message->message = $icalMsg;
-            return [$message];
-        } else {
-            return [];
-        }
-
-    }
-
-    /**
-     * Returns attendee information and information about instances of an
-     * event.
-     *
-     * Returns an array with the following keys:
-     *
-     * 1. uid
-     * 2. organizer
-     * 3. organizerName
-     * 4. organizerScheduleAgent
-     * 5. organizerForceSend
-     * 6. instances
-     * 7. attendees
-     * 8. sequence
-     * 9. exdate
-     * 10. timezone - strictly the timezone on which the recurrence rule is
-     *                based on.
-     * 11. significantChangeHash
-     * 12. status
-     * @param VCalendar $calendar
-     *
-     * @return array
-     */
-    protected function parseEventInfo(VCalendar $calendar = null) {
-
-        $uid = null;
-        $organizer = null;
-        $organizerName = null;
-        $organizerForceSend = null;
-        $sequence = null;
-        $timezone = null;
-        $status = null;
-        $organizerScheduleAgent = 'SERVER';
-
-        $significantChangeHash = '';
-
-        // Now we need to collect a list of attendees, and which instances they
-        // are a part of.
-        $attendees = [];
-
-        $instances = [];
-        $exdate = [];
-
-        foreach ($calendar->VEVENT as $vevent) {
-
-            if (is_null($uid)) {
-                $uid = $vevent->UID->getValue();
-            } else {
-                if ($uid !== $vevent->UID->getValue()) {
-                    throw new ITipException('If a calendar contained more than one event, they must have the same UID.');
-                }
-            }
-
-            if (!isset($vevent->DTSTART)) {
-                throw new ITipException('An event MUST have a DTSTART property.');
-            }
-
-            if (isset($vevent->ORGANIZER)) {
-                if (is_null($organizer)) {
-                    $organizer = $vevent->ORGANIZER->getNormalizedValue();
-                    $organizerName = isset($vevent->ORGANIZER['CN']) ? $vevent->ORGANIZER['CN'] : null;
-                } else {
-                    if ($organizer !== $vevent->ORGANIZER->getNormalizedValue()) {
-                        throw new SameOrganizerForAllComponentsException('Every instance of the event must have the same organizer.');
-                    }
-                }
-                $organizerForceSend =
-                    isset($vevent->ORGANIZER['SCHEDULE-FORCE-SEND']) ?
-                    strtoupper($vevent->ORGANIZER['SCHEDULE-FORCE-SEND']) :
-                    null;
-                $organizerScheduleAgent =
-                    isset($vevent->ORGANIZER['SCHEDULE-AGENT']) ?
-                    strtoupper((string)$vevent->ORGANIZER['SCHEDULE-AGENT']) :
-                    'SERVER';
-            }
-            if (is_null($sequence) && isset($vevent->SEQUENCE)) {
-                $sequence = $vevent->SEQUENCE->getValue();
-            }
-            if (isset($vevent->EXDATE)) {
-                foreach ($vevent->select('EXDATE') as $val) {
-                    $exdate = array_merge($exdate, $val->getParts());
-                }
-                sort($exdate);
-            }
-            if (isset($vevent->STATUS)) {
-                $status = strtoupper($vevent->STATUS->getValue());
-            }
-
-            $recurId = isset($vevent->{'RECURRENCE-ID'}) ? $vevent->{'RECURRENCE-ID'}->getValue() : 'master';
-            if (is_null($timezone)) {
-                if ($recurId === 'master') {
-                    $timezone = $vevent->DTSTART->getDateTime()->getTimeZone();
-                } else {
-                    $timezone = $vevent->{'RECURRENCE-ID'}->getDateTime()->getTimeZone();
-                }
-            }
-            if (isset($vevent->ATTENDEE)) {
-                foreach ($vevent->ATTENDEE as $attendee) {
-
-                    if ($this->scheduleAgentServerRules &&
-                        isset($attendee['SCHEDULE-AGENT']) &&
-                        strtoupper($attendee['SCHEDULE-AGENT']->getValue()) === 'CLIENT'
-                    ) {
-                        continue;
-                    }
-                    $partStat =
-                        isset($attendee['PARTSTAT']) ?
-                        strtoupper($attendee['PARTSTAT']) :
-                        'NEEDS-ACTION';
-
-                    $forceSend =
-                        isset($attendee['SCHEDULE-FORCE-SEND']) ?
-                        strtoupper($attendee['SCHEDULE-FORCE-SEND']) :
-                        null;
-
-
-                    if (isset($attendees[$attendee->getNormalizedValue()])) {
-                        $attendees[$attendee->getNormalizedValue()]['instances'][$recurId] = [
-                            'id'         => $recurId,
-                            'partstat'   => $partStat,
-                            'force-send' => $forceSend,
-                        ];
-                    } else {
-                        $attendees[$attendee->getNormalizedValue()] = [
-                            'href'      => $attendee->getNormalizedValue(),
-                            'instances' => [
-                                $recurId => [
-                                    'id'       => $recurId,
-                                    'partstat' => $partStat,
-                                ],
-                            ],
-                            'name'      => isset($attendee['CN']) ? (string)$attendee['CN'] : null,
-                            'forceSend' => $forceSend,
-                        ];
-                    }
-
-                }
-                $instances[$recurId] = $vevent;
-
-            }
-
-            foreach ($this->significantChangeProperties as $prop) {
-                if (isset($vevent->$prop)) {
-                    $propertyValues = $vevent->select($prop);
-
-                    $significantChangeHash .= $prop . ':';
-
-                    if ($prop === 'EXDATE') {
-
-                        $significantChangeHash .= implode(',', $exdate) . ';';
-
-                    } else {
-
-                        foreach ($propertyValues as $val) {
-                            $significantChangeHash .= $val->getValue() . ';';
-                        }
-
-                    }
-                }
-            }
-
-        }
-        $significantChangeHash = md5($significantChangeHash);
-
-        return compact(
-            'uid',
-            'organizer',
-            'organizerName',
-            'organizerScheduleAgent',
-            'organizerForceSend',
-            'instances',
-            'attendees',
-            'sequence',
-            'exdate',
-            'timezone',
-            'significantChangeHash',
-            'status'
-        );
-
-    }
+	/**
+	 * This setting determines whether the rules for the SCHEDULE-AGENT
+	 * parameter should be followed.
+	 *
+	 * This is a parameter defined on ATTENDEE properties, introduced by RFC
+	 * 6638. This parameter allows a caldav client to tell the server 'Don't do
+	 * any scheduling operations'.
+	 *
+	 * If this setting is turned on, any attendees with SCHEDULE-AGENT set to
+	 * CLIENT will be ignored. This is the desired behavior for a CalDAV
+	 * server, but if you're writing an iTip application that doesn't deal with
+	 * CalDAV, you may want to ignore this parameter.
+	 *
+	 * @var bool
+	 */
+	public $scheduleAgentServerRules = true;
+
+	/**
+	 * The broker will try during 'parseEvent' figure out whether the change
+	 * was significant.
+	 *
+	 * It uses a few different ways to do this. One of these ways is seeing if
+	 * certain properties changed values. This list of specified here.
+	 *
+	 * This list is taken from:
+	 * * http://tools.ietf.org/html/rfc5546#section-2.1.4
+	 *
+	 * @var string[]
+	 */
+	public $significantChangeProperties = [
+		'DTSTART',
+		'DTEND',
+		'DURATION',
+		'DUE',
+		'RRULE',
+		'RDATE',
+		'EXDATE',
+		'STATUS',
+	];
+
+	/**
+	 * This method is used to process an incoming itip message.
+	 *
+	 * Examples:
+	 *
+	 * 1. A user is an attendee to an event. The organizer sends an updated
+	 * meeting using a new iTip message with METHOD:REQUEST. This function
+	 * will process the message and update the attendee's event accordingly.
+	 *
+	 * 2. The organizer cancelled the event using METHOD:CANCEL. We will update
+	 * the users event to state STATUS:CANCELLED.
+	 *
+	 * 3. An attendee sent a reply to an invite using METHOD:REPLY. We can
+	 * update the organizers event to update the ATTENDEE with its correct
+	 * PARTSTAT.
+	 *
+	 * The $existingObject is updated in-place. If there is no existing object
+	 * (because it's a new invite for example) a new object will be created.
+	 *
+	 * If an existing object does not exist, and the method was CANCEL or
+	 * REPLY, the message effectively gets ignored, and no 'existingObject'
+	 * will be created.
+	 *
+	 * The updated $existingObject is also returned from this function.
+	 *
+	 * If the iTip message was not supported, we will always return false.
+	 *
+	 * @param Message $itipMessage
+	 * @param VCalendar $existingObject
+	 *
+	 * @return VCalendar|null
+	 */
+	public function processMessage(Message $itipMessage, VCalendar $existingObject = null) {
+
+		// We only support events at the moment.
+		if ($itipMessage->component !== 'VEVENT') {
+			return false;
+		}
+
+		switch ($itipMessage->method) {
+
+			case 'REQUEST' :
+				return $this->processMessageRequest($itipMessage, $existingObject);
+
+			case 'CANCEL' :
+				return $this->processMessageCancel($itipMessage, $existingObject);
+
+			case 'REPLY' :
+				return $this->processMessageReply($itipMessage, $existingObject);
+
+			default :
+				// Unsupported iTip message
+				return;
+
+		}
+
+		return $existingObject;
+
+	}
+
+	/**
+	 * This function parses a VCALENDAR object and figure out if any messages
+	 * need to be sent.
+	 *
+	 * A VCALENDAR object will be created from the perspective of either an
+	 * attendee, or an organizer. You must pass a string identifying the
+	 * current user, so we can figure out who in the list of attendees or the
+	 * organizer we are sending this message on behalf of.
+	 *
+	 * It's possible to specify the current user as an array, in case the user
+	 * has more than one identifying href (such as multiple emails).
+	 *
+	 * It $oldCalendar is specified, it is assumed that the operation is
+	 * updating an existing event, which means that we need to look at the
+	 * differences between events, and potentially send old attendees
+	 * cancellations, and current attendees updates.
+	 *
+	 * If $calendar is null, but $oldCalendar is specified, we treat the
+	 * operation as if the user has deleted an event. If the user was an
+	 * organizer, this means that we need to send cancellation notices to
+	 * people. If the user was an attendee, we need to make sure that the
+	 * organizer gets the 'declined' message.
+	 *
+	 * @param VCalendar|string $calendar
+	 * @param string|array $userHref
+	 * @param VCalendar|string $oldCalendar
+	 *
+	 * @return array
+	 */
+	public function parseEvent($calendar = null, $userHref, $oldCalendar = null) {
+
+		if ($oldCalendar) {
+			if (is_string($oldCalendar)) {
+				$oldCalendar = Reader::read($oldCalendar);
+			}
+			if (!isset($oldCalendar->VEVENT)) {
+				// We only support events at the moment
+				return [];
+			}
+
+			$oldEventInfo = $this->parseEventInfo($oldCalendar);
+		} else {
+			$oldEventInfo = [
+				'organizer'             => null,
+				'significantChangeHash' => '',
+				'attendees'             => [],
+			];
+		}
+
+		$userHref = (array)$userHref;
+
+		if (!is_null($calendar)) {
+
+			if (is_string($calendar)) {
+				$calendar = Reader::read($calendar);
+			}
+			if (!isset($calendar->VEVENT)) {
+				// We only support events at the moment
+				return [];
+			}
+			$eventInfo = $this->parseEventInfo($calendar);
+			if (!$eventInfo['attendees'] && !$oldEventInfo['attendees']) {
+				// If there were no attendees on either side of the equation,
+				// we don't need to do anything.
+				return [];
+			}
+			if (!$eventInfo['organizer'] && !$oldEventInfo['organizer']) {
+				// There was no organizer before or after the change.
+				return [];
+			}
+
+			$baseCalendar = $calendar;
+
+			// If the new object didn't have an organizer, the organizer
+			// changed the object from a scheduling object to a non-scheduling
+			// object. We just copy the info from the old object.
+			if (!$eventInfo['organizer'] && $oldEventInfo['organizer']) {
+				$eventInfo['organizer'] = $oldEventInfo['organizer'];
+				$eventInfo['organizerName'] = $oldEventInfo['organizerName'];
+			}
+
+		} else {
+			// The calendar object got deleted, we need to process this as a
+			// cancellation / decline.
+			if (!$oldCalendar) {
+				// No old and no new calendar, there's no thing to do.
+				return [];
+			}
+
+			$eventInfo = $oldEventInfo;
+
+			if (in_array($eventInfo['organizer'], $userHref)) {
+				// This is an organizer deleting the event.
+				$eventInfo['attendees'] = [];
+				// Increasing the sequence, but only if the organizer deleted
+				// the event.
+				$eventInfo['sequence']++;
+			} else {
+				// This is an attendee deleting the event.
+				foreach ($eventInfo['attendees'] as $key => $attendee) {
+					if (in_array($attendee['href'], $userHref)) {
+						$eventInfo['attendees'][$key]['instances'] = ['master' =>
+							['id' => 'master', 'partstat' => 'DECLINED']
+						];
+					}
+				}
+			}
+			$baseCalendar = $oldCalendar;
+
+		}
+
+		if (in_array($eventInfo['organizer'], $userHref)) {
+			return $this->parseEventForOrganizer($baseCalendar, $eventInfo, $oldEventInfo);
+		} elseif ($oldCalendar) {
+			// We need to figure out if the user is an attendee, but we're only
+			// doing so if there's an oldCalendar, because we only want to
+			// process updates, not creation of new events.
+			foreach ($eventInfo['attendees'] as $attendee) {
+				if (in_array($attendee['href'], $userHref)) {
+					return $this->parseEventForAttendee($baseCalendar, $eventInfo, $oldEventInfo, $attendee['href']);
+				}
+			}
+		}
+		return [];
+
+	}
+
+	/**
+	 * Processes incoming REQUEST messages.
+	 *
+	 * This is message from an organizer, and is either a new event
+	 * invite, or an update to an existing one.
+	 *
+	 *
+	 * @param Message $itipMessage
+	 * @param VCalendar $existingObject
+	 *
+	 * @return VCalendar|null
+	 */
+	protected function processMessageRequest(Message $itipMessage, VCalendar $existingObject = null) {
+
+		if (!$existingObject) {
+			// This is a new invite, and we're just going to copy over
+			// all the components from the invite.
+			$existingObject = new VCalendar();
+			foreach ($itipMessage->message->getComponents() as $component) {
+				$existingObject->add(clone $component);
+			}
+		} else {
+			// We need to update an existing object with all the new
+			// information. We can just remove all existing components
+			// and create new ones.
+			foreach ($existingObject->getComponents() as $component) {
+				$existingObject->remove($component);
+			}
+			foreach ($itipMessage->message->getComponents() as $component) {
+				$existingObject->add(clone $component);
+			}
+		}
+		return $existingObject;
+
+	}
+
+	/**
+	 * Processes incoming CANCEL messages.
+	 *
+	 * This is a message from an organizer, and means that either an
+	 * attendee got removed from an event, or an event got cancelled
+	 * altogether.
+	 *
+	 * @param Message $itipMessage
+	 * @param VCalendar $existingObject
+	 *
+	 * @return VCalendar|null
+	 */
+	protected function processMessageCancel(Message $itipMessage, VCalendar $existingObject = null) {
+
+		if (!$existingObject) {
+			// The event didn't exist in the first place, so we're just
+			// ignoring this message.
+		} else {
+			foreach ($existingObject->VEVENT as $vevent) {
+				$vevent->STATUS = 'CANCELLED';
+				$vevent->SEQUENCE = $itipMessage->sequence;
+			}
+		}
+		return $existingObject;
+
+	}
+
+	/**
+	 * Processes incoming REPLY messages.
+	 *
+	 * The message is a reply. This is for example an attendee telling
+	 * an organizer he accepted the invite, or declined it.
+	 *
+	 * @param Message $itipMessage
+	 * @param VCalendar $existingObject
+	 *
+	 * @return VCalendar|null
+	 */
+	protected function processMessageReply(Message $itipMessage, VCalendar $existingObject = null) {
+
+		// A reply can only be processed based on an existing object.
+		// If the object is not available, the reply is ignored.
+		if (!$existingObject) {
+			return;
+		}
+		$instances = [];
+		$requestStatus = '2.0';
+
+		// Finding all the instances the attendee replied to.
+		foreach ($itipMessage->message->VEVENT as $vevent) {
+			$recurId = isset($vevent->{'RECURRENCE-ID'}) ? $vevent->{'RECURRENCE-ID'}->getValue() : 'master';
+			$attendee = $vevent->ATTENDEE;
+			$instances[$recurId] = $attendee['PARTSTAT']->getValue();
+			if (isset($vevent->{'REQUEST-STATUS'})) {
+				$requestStatus = $vevent->{'REQUEST-STATUS'}->getValue();
+				list($requestStatus) = explode(';', $requestStatus);
+			}
+		}
+
+		// Now we need to loop through the original organizer event, to find
+		// all the instances where we have a reply for.
+		$masterObject = null;
+		foreach ($existingObject->VEVENT as $vevent) {
+			$recurId = isset($vevent->{'RECURRENCE-ID'}) ? $vevent->{'RECURRENCE-ID'}->getValue() : 'master';
+			if ($recurId === 'master') {
+				$masterObject = $vevent;
+			}
+			if (isset($instances[$recurId])) {
+				$attendeeFound = false;
+				if (isset($vevent->ATTENDEE)) {
+					foreach ($vevent->ATTENDEE as $attendee) {
+						if ($attendee->getValue() === $itipMessage->sender) {
+							$attendeeFound = true;
+							$attendee['PARTSTAT'] = $instances[$recurId];
+							$attendee['SCHEDULE-STATUS'] = $requestStatus;
+							// Un-setting the RSVP status, because we now know
+							// that the attendee already replied.
+							unset($attendee['RSVP']);
+							break;
+						}
+					}
+				}
+				if (!$attendeeFound) {
+					// Adding a new attendee. The iTip documentation calls this
+					// a party crasher.
+					$attendee = $vevent->add('ATTENDEE', $itipMessage->sender, [
+						'PARTSTAT' => $instances[$recurId]
+					]);
+					if ($itipMessage->senderName) $attendee['CN'] = $itipMessage->senderName;
+				}
+				unset($instances[$recurId]);
+			}
+		}
+
+		if (!$masterObject) {
+			// No master object, we can't add new instances.
+			return;
+		}
+		// If we got replies to instances that did not exist in the
+		// original list, it means that new exceptions must be created.
+		foreach ($instances as $recurId => $partstat) {
+
+			$recurrenceIterator = new EventIterator($existingObject, $itipMessage->uid);
+			$found = false;
+			$iterations = 1000;
+			do {
+
+				$newObject = $recurrenceIterator->getEventObject();
+				$recurrenceIterator->next();
+
+				if (isset($newObject->{'RECURRENCE-ID'}) && $newObject->{'RECURRENCE-ID'}->getValue() === $recurId) {
+					$found = true;
+				}
+				$iterations--;
+
+			} while ($recurrenceIterator->valid() && !$found && $iterations);
+
+			// Invalid recurrence id. Skipping this object.
+			if (!$found) continue;
+
+			unset(
+				$newObject->RRULE,
+				$newObject->EXDATE,
+				$newObject->RDATE
+			);
+			$attendeeFound = false;
+			if (isset($newObject->ATTENDEE)) {
+				foreach ($newObject->ATTENDEE as $attendee) {
+					if ($attendee->getValue() === $itipMessage->sender) {
+						$attendeeFound = true;
+						$attendee['PARTSTAT'] = $partstat;
+						break;
+					}
+				}
+			}
+			if (!$attendeeFound) {
+				// Adding a new attendee
+				$attendee = $newObject->add('ATTENDEE', $itipMessage->sender, [
+					'PARTSTAT' => $partstat
+				]);
+				if ($itipMessage->senderName) {
+					$attendee['CN'] = $itipMessage->senderName;
+				}
+			}
+			$existingObject->add($newObject);
+
+		}
+		return $existingObject;
+
+	}
+
+	/**
+	 * This method is used in cases where an event got updated, and we
+	 * potentially need to send emails to attendees to let them know of updates
+	 * in the events.
+	 *
+	 * We will detect which attendees got added, which got removed and create
+	 * specific messages for these situations.
+	 *
+	 * @param VCalendar $calendar
+	 * @param array $eventInfo
+	 * @param array $oldEventInfo
+	 *
+	 * @return array
+	 */
+	protected function parseEventForOrganizer(VCalendar $calendar, array $eventInfo, array $oldEventInfo) {
+
+		// Merging attendee lists.
+		$attendees = [];
+		foreach ($oldEventInfo['attendees'] as $attendee) {
+			$attendees[$attendee['href']] = [
+				'href'         => $attendee['href'],
+				'oldInstances' => $attendee['instances'],
+				'newInstances' => [],
+				'name'         => $attendee['name'],
+				'forceSend'    => null,
+			];
+		}
+		foreach ($eventInfo['attendees'] as $attendee) {
+			if (isset($attendees[$attendee['href']])) {
+				$attendees[$attendee['href']]['name'] = $attendee['name'];
+				$attendees[$attendee['href']]['newInstances'] = $attendee['instances'];
+				$attendees[$attendee['href']]['forceSend'] = $attendee['forceSend'];
+			} else {
+				$attendees[$attendee['href']] = [
+					'href'         => $attendee['href'],
+					'oldInstances' => [],
+					'newInstances' => $attendee['instances'],
+					'name'         => $attendee['name'],
+					'forceSend'    => $attendee['forceSend'],
+				];
+			}
+		}
+
+		$messages = [];
+
+		foreach ($attendees as $attendee) {
+
+			// An organizer can also be an attendee. We should not generate any
+			// messages for those.
+			if ($attendee['href'] === $eventInfo['organizer']) {
+				continue;
+			}
+
+			$message = new Message();
+			$message->uid = $eventInfo['uid'];
+			$message->component = 'VEVENT';
+			$message->sequence = $eventInfo['sequence'];
+			$message->sender = $eventInfo['organizer'];
+			$message->senderName = $eventInfo['organizerName'];
+			$message->recipient = $attendee['href'];
+			$message->recipientName = $attendee['name'];
+
+			if (!$attendee['newInstances']) {
+
+				// If there are no instances the attendee is a part of, it
+				// means the attendee was removed and we need to send him a
+				// CANCEL.
+				$message->method = 'CANCEL';
+
+				// Creating the new iCalendar body.
+				$icalMsg = new VCalendar();
+				$icalMsg->METHOD = $message->method;
+				$event = $icalMsg->add('VEVENT', [
+					'UID'      => $message->uid,
+					'SEQUENCE' => $message->sequence,
+				]);
+				if (isset($calendar->VEVENT->SUMMARY)) {
+					$event->add('SUMMARY', $calendar->VEVENT->SUMMARY->getValue());
+				}
+				$event->add(clone $calendar->VEVENT->DTSTART);
+				if (isset($calendar->VEVENT->DTEND)) {
+					$event->add(clone $calendar->VEVENT->DTEND);
+				} elseif (isset($calendar->VEVENT->DURATION)) {
+					$event->add(clone $calendar->VEVENT->DURATION);
+				}
+				$org = $event->add('ORGANIZER', $eventInfo['organizer']);
+				if ($eventInfo['organizerName']) $org['CN'] = $eventInfo['organizerName'];
+				$event->add('ATTENDEE', $attendee['href'], [
+					'CN' => $attendee['name'],
+				]);
+				$message->significantChange = true;
+
+			} else {
+
+				// The attendee gets the updated event body
+				$message->method = 'REQUEST';
+
+				// Creating the new iCalendar body.
+				$icalMsg = new VCalendar();
+				$icalMsg->METHOD = $message->method;
+
+				foreach ($calendar->select('VTIMEZONE') as $timezone) {
+					$icalMsg->add(clone $timezone);
+				}
+
+				// We need to find out that this change is significant. If it's
+				// not, systems may opt to not send messages.
+				//
+				// We do this based on the 'significantChangeHash' which is
+				// some value that changes if there's a certain set of
+				// properties changed in the event, or simply if there's a
+				// difference in instances that the attendee is invited to.
+
+				$message->significantChange =
+					$attendee['forceSend'] === 'REQUEST' ||
+					array_keys($attendee['oldInstances']) != array_keys($attendee['newInstances']) ||
+					$oldEventInfo['significantChangeHash'] !== $eventInfo['significantChangeHash'];
+
+				foreach ($attendee['newInstances'] as $instanceId => $instanceInfo) {
+
+					$currentEvent = clone $eventInfo['instances'][$instanceId];
+					if ($instanceId === 'master') {
+
+						// We need to find a list of events that the attendee
+						// is not a part of to add to the list of exceptions.
+						$exceptions = [];
+						foreach ($eventInfo['instances'] as $instanceId => $vevent) {
+							if (!isset($attendee['newInstances'][$instanceId])) {
+								$exceptions[] = $instanceId;
+							}
+						}
+
+						// If there were exceptions, we need to add it to an
+						// existing EXDATE property, if it exists.
+						if ($exceptions) {
+							if (isset($currentEvent->EXDATE)) {
+								$currentEvent->EXDATE->setParts(array_merge(
+									$currentEvent->EXDATE->getParts(),
+									$exceptions
+								));
+							} else {
+								$currentEvent->EXDATE = $exceptions;
+							}
+						}
+
+						// Cleaning up any scheduling information that
+						// shouldn't be sent along.
+						unset($currentEvent->ORGANIZER['SCHEDULE-FORCE-SEND']);
+						unset($currentEvent->ORGANIZER['SCHEDULE-STATUS']);
+
+						foreach ($currentEvent->ATTENDEE as $attendee) {
+							unset($attendee['SCHEDULE-FORCE-SEND']);
+							unset($attendee['SCHEDULE-STATUS']);
+
+							// We're adding PARTSTAT=NEEDS-ACTION to ensure that
+							// iOS shows an "Inbox Item"
+							if (!isset($attendee['PARTSTAT'])) {
+								$attendee['PARTSTAT'] = 'NEEDS-ACTION';
+							}
+
+						}
+
+					}
+
+					$icalMsg->add($currentEvent);
+
+				}
+
+			}
+
+			$message->message = $icalMsg;
+			$messages[] = $message;
+
+		}
+
+		return $messages;
+
+	}
+
+	/**
+	 * Parse an event update for an attendee.
+	 *
+	 * This function figures out if we need to send a reply to an organizer.
+	 *
+	 * @param VCalendar $calendar
+	 * @param array $eventInfo
+	 * @param array $oldEventInfo
+	 * @param string $attendee
+	 *
+	 * @return Message[]
+	 */
+	protected function parseEventForAttendee(VCalendar $calendar, array $eventInfo, array $oldEventInfo, $attendee) {
+
+		if ($this->scheduleAgentServerRules && $eventInfo['organizerScheduleAgent'] === 'CLIENT') {
+			return [];
+		}
+
+		// Don't bother generating messages for events that have already been
+		// cancelled.
+		if ($eventInfo['status'] === 'CANCELLED') {
+			return [];
+		}
+
+		$oldInstances = !empty($oldEventInfo['attendees'][$attendee]['instances']) ?
+			$oldEventInfo['attendees'][$attendee]['instances'] :
+			[];
+
+		$instances = [];
+		foreach ($oldInstances as $instance) {
+
+			$instances[$instance['id']] = [
+				'id'        => $instance['id'],
+				'oldstatus' => $instance['partstat'],
+				'newstatus' => null,
+			];
+
+		}
+		foreach ($eventInfo['attendees'][$attendee]['instances'] as $instance) {
+
+			if (isset($instances[$instance['id']])) {
+				$instances[$instance['id']]['newstatus'] = $instance['partstat'];
+			} else {
+				$instances[$instance['id']] = [
+					'id'        => $instance['id'],
+					'oldstatus' => null,
+					'newstatus' => $instance['partstat'],
+				];
+			}
+
+		}
+
+		// We need to also look for differences in EXDATE. If there are new
+		// items in EXDATE, it means that an attendee deleted instances of an
+		// event, which means we need to send DECLINED specifically for those
+		// instances.
+		// We only need to do that though, if the master event is not declined.
+		if (isset($instances['master']) && $instances['master']['newstatus'] !== 'DECLINED') {
+			foreach ($eventInfo['exdate'] as $exDate) {
+
+				if (!in_array($exDate, $oldEventInfo['exdate'])) {
+					if (isset($instances[$exDate])) {
+						$instances[$exDate]['newstatus'] = 'DECLINED';
+					} else {
+						$instances[$exDate] = [
+							'id'        => $exDate,
+							'oldstatus' => null,
+							'newstatus' => 'DECLINED',
+						];
+					}
+				}
+
+			}
+		}
+
+		// Gathering a few extra properties for each instance.
+		foreach ($instances as $recurId => $instanceInfo) {
+
+			if (isset($eventInfo['instances'][$recurId])) {
+				$instances[$recurId]['dtstart'] = clone $eventInfo['instances'][$recurId]->DTSTART;
+			} else {
+				$instances[$recurId]['dtstart'] = $recurId;
+			}
+
+		}
+
+		$message = new Message();
+		$message->uid = $eventInfo['uid'];
+		$message->method = 'REPLY';
+		$message->component = 'VEVENT';
+		$message->sequence = $eventInfo['sequence'];
+		$message->sender = $attendee;
+		$message->senderName = $eventInfo['attendees'][$attendee]['name'];
+		$message->recipient = $eventInfo['organizer'];
+		$message->recipientName = $eventInfo['organizerName'];
+
+		$icalMsg = new VCalendar();
+		$icalMsg->METHOD = 'REPLY';
+
+		$hasReply = false;
+
+		foreach ($instances as $instance) {
+
+			if ($instance['oldstatus'] == $instance['newstatus'] && $eventInfo['organizerForceSend'] !== 'REPLY') {
+				// Skip
+				continue;
+			}
+
+			$event = $icalMsg->add('VEVENT', [
+				'UID'      => $message->uid,
+				'SEQUENCE' => $message->sequence,
+			]);
+			$summary = isset($calendar->VEVENT->SUMMARY) ? $calendar->VEVENT->SUMMARY->getValue() : '';
+			// Adding properties from the correct source instance
+			if (isset($eventInfo['instances'][$instance['id']])) {
+				$instanceObj = $eventInfo['instances'][$instance['id']];
+				$event->add(clone $instanceObj->DTSTART);
+				if (isset($instanceObj->DTEND)) {
+					$event->add(clone $instanceObj->DTEND);
+				} elseif (isset($instanceObj->DURATION)) {
+					$event->add(clone $instanceObj->DURATION);
+				}
+				if (isset($instanceObj->SUMMARY)) {
+					$event->add('SUMMARY', $instanceObj->SUMMARY->getValue());
+				} elseif ($summary) {
+					$event->add('SUMMARY', $summary);
+				}
+			} else {
+				// This branch of the code is reached, when a reply is
+				// generated for an instance of a recurring event, through the
+				// fact that the instance has disappeared by showing up in
+				// EXDATE
+				$dt = DateTimeParser::parse($instance['id'], $eventInfo['timezone']);
+				// Treat is as a DATE field
+				if (strlen($instance['id']) <= 8) {
+					$event->add('DTSTART', $dt, ['VALUE' => 'DATE']);
+				} else {
+					$event->add('DTSTART', $dt);
+				}
+				if ($summary) {
+					$event->add('SUMMARY', $summary);
+				}
+			}
+			if ($instance['id'] !== 'master') {
+				$dt = DateTimeParser::parse($instance['id'], $eventInfo['timezone']);
+				// Treat is as a DATE field
+				if (strlen($instance['id']) <= 8) {
+					$event->add('RECURRENCE-ID', $dt, ['VALUE' => 'DATE']);
+				} else {
+					$event->add('RECURRENCE-ID', $dt);
+				}
+			}
+			$organizer = $event->add('ORGANIZER', $message->recipient);
+			if ($message->recipientName) {
+				$organizer['CN'] = $message->recipientName;
+			}
+			$attendee = $event->add('ATTENDEE', $message->sender, [
+				'PARTSTAT' => $instance['newstatus']
+			]);
+			if ($message->senderName) {
+				$attendee['CN'] = $message->senderName;
+			}
+			$hasReply = true;
+
+		}
+
+		if ($hasReply) {
+			$message->message = $icalMsg;
+			return [$message];
+		} else {
+			return [];
+		}
+
+	}
+
+	/**
+	 * Returns attendee information and information about instances of an
+	 * event.
+	 *
+	 * Returns an array with the following keys:
+	 *
+	 * 1. uid
+	 * 2. organizer
+	 * 3. organizerName
+	 * 4. organizerScheduleAgent
+	 * 5. organizerForceSend
+	 * 6. instances
+	 * 7. attendees
+	 * 8. sequence
+	 * 9. exdate
+	 * 10. timezone - strictly the timezone on which the recurrence rule is
+	 *                based on.
+	 * 11. significantChangeHash
+	 * 12. status
+	 * @param VCalendar $calendar
+	 *
+	 * @return array
+	 */
+	protected function parseEventInfo(VCalendar $calendar = null) {
+
+		$uid = null;
+		$organizer = null;
+		$organizerName = null;
+		$organizerForceSend = null;
+		$sequence = null;
+		$timezone = null;
+		$status = null;
+		$organizerScheduleAgent = 'SERVER';
+
+		$significantChangeHash = '';
+
+		// Now we need to collect a list of attendees, and which instances they
+		// are a part of.
+		$attendees = [];
+
+		$instances = [];
+		$exdate = [];
+
+		foreach ($calendar->VEVENT as $vevent) {
+
+			if (is_null($uid)) {
+				$uid = $vevent->UID->getValue();
+			} else {
+				if ($uid !== $vevent->UID->getValue()) {
+					throw new ITipException('If a calendar contained more than one event, they must have the same UID.');
+				}
+			}
+
+			if (!isset($vevent->DTSTART)) {
+				throw new ITipException('An event MUST have a DTSTART property.');
+			}
+
+			if (isset($vevent->ORGANIZER)) {
+				if (is_null($organizer)) {
+					$organizer = $vevent->ORGANIZER->getNormalizedValue();
+					$organizerName = isset($vevent->ORGANIZER['CN']) ? $vevent->ORGANIZER['CN'] : null;
+				} else {
+					if ($organizer !== $vevent->ORGANIZER->getNormalizedValue()) {
+						throw new SameOrganizerForAllComponentsException('Every instance of the event must have the same organizer.');
+					}
+				}
+				$organizerForceSend =
+					isset($vevent->ORGANIZER['SCHEDULE-FORCE-SEND']) ?
+					strtoupper($vevent->ORGANIZER['SCHEDULE-FORCE-SEND']) :
+					null;
+				$organizerScheduleAgent =
+					isset($vevent->ORGANIZER['SCHEDULE-AGENT']) ?
+					strtoupper((string)$vevent->ORGANIZER['SCHEDULE-AGENT']) :
+					'SERVER';
+			}
+			if (is_null($sequence) && isset($vevent->SEQUENCE)) {
+				$sequence = $vevent->SEQUENCE->getValue();
+			}
+			if (isset($vevent->EXDATE)) {
+				foreach ($vevent->select('EXDATE') as $val) {
+					$exdate = array_merge($exdate, $val->getParts());
+				}
+				sort($exdate);
+			}
+			if (isset($vevent->STATUS)) {
+				$status = strtoupper($vevent->STATUS->getValue());
+			}
+
+			$recurId = isset($vevent->{'RECURRENCE-ID'}) ? $vevent->{'RECURRENCE-ID'}->getValue() : 'master';
+			if (is_null($timezone)) {
+				if ($recurId === 'master') {
+					$timezone = $vevent->DTSTART->getDateTime()->getTimeZone();
+				} else {
+					$timezone = $vevent->{'RECURRENCE-ID'}->getDateTime()->getTimeZone();
+				}
+			}
+			if (isset($vevent->ATTENDEE)) {
+				foreach ($vevent->ATTENDEE as $attendee) {
+
+					if ($this->scheduleAgentServerRules &&
+						isset($attendee['SCHEDULE-AGENT']) &&
+						strtoupper($attendee['SCHEDULE-AGENT']->getValue()) === 'CLIENT'
+					) {
+						continue;
+					}
+					$partStat =
+						isset($attendee['PARTSTAT']) ?
+						strtoupper($attendee['PARTSTAT']) :
+						'NEEDS-ACTION';
+
+					$forceSend =
+						isset($attendee['SCHEDULE-FORCE-SEND']) ?
+						strtoupper($attendee['SCHEDULE-FORCE-SEND']) :
+						null;
+
+
+					if (isset($attendees[$attendee->getNormalizedValue()])) {
+						$attendees[$attendee->getNormalizedValue()]['instances'][$recurId] = [
+							'id'         => $recurId,
+							'partstat'   => $partStat,
+							'force-send' => $forceSend,
+						];
+					} else {
+						$attendees[$attendee->getNormalizedValue()] = [
+							'href'      => $attendee->getNormalizedValue(),
+							'instances' => [
+								$recurId => [
+									'id'       => $recurId,
+									'partstat' => $partStat,
+								],
+							],
+							'name'      => isset($attendee['CN']) ? (string)$attendee['CN'] : null,
+							'forceSend' => $forceSend,
+						];
+					}
+
+				}
+				$instances[$recurId] = $vevent;
+
+			}
+
+			foreach ($this->significantChangeProperties as $prop) {
+				if (isset($vevent->$prop)) {
+					$propertyValues = $vevent->select($prop);
+
+					$significantChangeHash .= $prop . ':';
+
+					if ($prop === 'EXDATE') {
+
+						$significantChangeHash .= implode(',', $exdate) . ';';
+
+					} else {
+
+						foreach ($propertyValues as $val) {
+							$significantChangeHash .= $val->getValue() . ';';
+						}
+
+					}
+				}
+			}
+
+		}
+		$significantChangeHash = md5($significantChangeHash);
+
+		return compact(
+			'uid',
+			'organizer',
+			'organizerName',
+			'organizerScheduleAgent',
+			'organizerForceSend',
+			'instances',
+			'attendees',
+			'sequence',
+			'exdate',
+			'timezone',
+			'significantChangeHash',
+			'status'
+		);
+
+	}
 
 }

libraries/SabreDAV/VObject/ITip/Message.php

Indentation +121 added lines, -121 removed lines

@@ -16,126 +16,126 @@
  */
 class Message {
 
-    /**
-     * The object's UID.
-     *
-     * @var string
-     */
-    public $uid;
-
-    /**
-     * The component type, such as VEVENT.
-     *
-     * @var string
-     */
-    public $component;
-
-    /**
-     * Contains the ITip method, which is something like REQUEST, REPLY or
-     * CANCEL.
-     *
-     * @var string
-     */
-    public $method;
-
-    /**
-     * The current sequence number for the event.
-     *
-     * @var int
-     */
-    public $sequence;
-
-    /**
-     * The senders' email address.
-     *
-     * Note that this does not imply that this has to be used in a From: field
-     * if the message is sent by email. It may also be populated in Reply-To:
-     * or not at all.
-     *
-     * @var string
-     */
-    public $sender;
-
-    /**
-     * The name of the sender. This is often populated from a CN parameter from
-     * either the ORGANIZER or ATTENDEE, depending on the message.
-     *
-     * @var string|null
-     */
-    public $senderName;
-
-    /**
-     * The recipient's email address.
-     *
-     * @var string
-     */
-    public $recipient;
-
-    /**
-     * The name of the recipient. This is usually populated with the CN
-     * parameter from the ATTENDEE or ORGANIZER property, if it's available.
-     *
-     * @var string|null
-     */
-    public $recipientName;
-
-    /**
-     * After the message has been delivered, this should contain a string such
-     * as : 1.1;Sent or 1.2;Delivered.
-     *
-     * In case of a failure, this will hold the error status code.
-     *
-     * See:
-     * http://tools.ietf.org/html/rfc6638#section-7.3
-     *
-     * @var string
-     */
-    public $scheduleStatus;
-
-    /**
-     * The iCalendar / iTip body.
-     *
-     * @var \Sabre\VObject\Component\VCalendar
-     */
-    public $message;
-
-    /**
-     * This will be set to true, if the iTip broker considers the change
-     * 'significant'.
-     *
-     * In practice, this means that we'll only mark it true, if for instance
-     * DTSTART changed. This allows systems to only send iTip messages when
-     * significant changes happened. This is especially useful for iMip, as
-     * normally a ton of messages may be generated for normal calendar use.
-     *
-     * To see the list of properties that are considered 'significant', check
-     * out Sabre\VObject\ITip\Broker::$significantChangeProperties.
-     *
-     * @var bool
-     */
-    public $significantChange = true;
-
-    /**
-     * Returns the schedule status as a string.
-     *
-     * For example:
-     * 1.2
-     *
-     * @return mixed bool|string
-     */
-    public function getScheduleStatus() {
-
-        if (!$this->scheduleStatus) {
-
-            return false;
-
-        } else {
-
-            list($scheduleStatus) = explode(';', $this->scheduleStatus);
-            return $scheduleStatus;
-
-        }
-
-    }
+	/**
+	 * The object's UID.
+	 *
+	 * @var string
+	 */
+	public $uid;
+
+	/**
+	 * The component type, such as VEVENT.
+	 *
+	 * @var string
+	 */
+	public $component;
+
+	/**
+	 * Contains the ITip method, which is something like REQUEST, REPLY or
+	 * CANCEL.
+	 *
+	 * @var string
+	 */
+	public $method;
+
+	/**
+	 * The current sequence number for the event.
+	 *
+	 * @var int
+	 */
+	public $sequence;
+
+	/**
+	 * The senders' email address.
+	 *
+	 * Note that this does not imply that this has to be used in a From: field
+	 * if the message is sent by email. It may also be populated in Reply-To:
+	 * or not at all.
+	 *
+	 * @var string
+	 */
+	public $sender;
+
+	/**
+	 * The name of the sender. This is often populated from a CN parameter from
+	 * either the ORGANIZER or ATTENDEE, depending on the message.
+	 *
+	 * @var string|null
+	 */
+	public $senderName;
+
+	/**
+	 * The recipient's email address.
+	 *
+	 * @var string
+	 */
+	public $recipient;
+
+	/**
+	 * The name of the recipient. This is usually populated with the CN
+	 * parameter from the ATTENDEE or ORGANIZER property, if it's available.
+	 *
+	 * @var string|null
+	 */
+	public $recipientName;
+
+	/**
+	 * After the message has been delivered, this should contain a string such
+	 * as : 1.1;Sent or 1.2;Delivered.
+	 *
+	 * In case of a failure, this will hold the error status code.
+	 *
+	 * See:
+	 * http://tools.ietf.org/html/rfc6638#section-7.3
+	 *
+	 * @var string
+	 */
+	public $scheduleStatus;
+
+	/**
+	 * The iCalendar / iTip body.
+	 *
+	 * @var \Sabre\VObject\Component\VCalendar
+	 */
+	public $message;
+
+	/**
+	 * This will be set to true, if the iTip broker considers the change
+	 * 'significant'.
+	 *
+	 * In practice, this means that we'll only mark it true, if for instance
+	 * DTSTART changed. This allows systems to only send iTip messages when
+	 * significant changes happened. This is especially useful for iMip, as
+	 * normally a ton of messages may be generated for normal calendar use.
+	 *
+	 * To see the list of properties that are considered 'significant', check
+	 * out Sabre\VObject\ITip\Broker::$significantChangeProperties.
+	 *
+	 * @var bool
+	 */
+	public $significantChange = true;
+
+	/**
+	 * Returns the schedule status as a string.
+	 *
+	 * For example:
+	 * 1.2
+	 *
+	 * @return mixed bool|string
+	 */
+	public function getScheduleStatus() {
+
+		if (!$this->scheduleStatus) {
+
+			return false;
+
+		} else {
+
+			list($scheduleStatus) = explode(';', $this->scheduleStatus);
+			return $scheduleStatus;
+
+		}
+
+	}
 
 }

libraries/SabreDAV/VObject/Splitter/ICalendar.php

Indentation +88 added lines, -88 removed lines

@@ -21,93 +21,93 @@
  */
 class ICalendar implements SplitterInterface {
 
-    /**
-     * Timezones.
-     *
-     * @var array
-     */
-    protected $vtimezones = [];
-
-    /**
-     * iCalendar objects.
-     *
-     * @var array
-     */
-    protected $objects = [];
-
-    /**
-     * Constructor.
-     *
-     * The splitter should receive an readable file stream as it's input.
-     *
-     * @param resource $input
-     * @param int $options Parser options, see the OPTIONS constants.
-     */
-    public function __construct($input, $options = 0) {
-
-        $data = VObject\Reader::read($input, $options);
-
-        if (!$data instanceof VObject\Component\VCalendar) {
-            throw new VObject\ParseException('Supplied input could not be parsed as VCALENDAR.');
-        }
-
-        foreach ($data->children() as $component) {
-            if (!$component instanceof VObject\Component) {
-                continue;
-            }
-
-            // Get all timezones
-            if ($component->name === 'VTIMEZONE') {
-                $this->vtimezones[(string)$component->TZID] = $component;
-                continue;
-            }
-
-            // Get component UID for recurring Events search
-            if (!$component->UID) {
-                $component->UID = sha1(microtime()) . '-vobjectimport';
-            }
-            $uid = (string)$component->UID;
-
-            // Take care of recurring events
-            if (!array_key_exists($uid, $this->objects)) {
-                $this->objects[$uid] = new VCalendar();
-            }
-
-            $this->objects[$uid]->add(clone $component);
-        }
-
-    }
-
-    /**
-     * Every time getNext() is called, a new object will be parsed, until we
-     * hit the end of the stream.
-     *
-     * When the end is reached, null will be returned.
-     *
-     * @return Sabre\VObject\Component|null
-     */
-    public function getNext() {
-
-        if ($object = array_shift($this->objects)) {
-
-            // create our baseobject
-            $object->version = '2.0';
-            $object->prodid = '-//Sabre//Sabre VObject ' . VObject\Version::VERSION . '//EN';
-            $object->calscale = 'GREGORIAN';
-
-            // add vtimezone information to obj (if we have it)
-            foreach ($this->vtimezones as $vtimezone) {
-                $object->add($vtimezone);
-            }
-
-            return $object;
-
-        } else {
-
-            return;
-
-        }
-
-    }
+	/**
+	 * Timezones.
+	 *
+	 * @var array
+	 */
+	protected $vtimezones = [];
+
+	/**
+	 * iCalendar objects.
+	 *
+	 * @var array
+	 */
+	protected $objects = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * The splitter should receive an readable file stream as it's input.
+	 *
+	 * @param resource $input
+	 * @param int $options Parser options, see the OPTIONS constants.
+	 */
+	public function __construct($input, $options = 0) {
+
+		$data = VObject\Reader::read($input, $options);
+
+		if (!$data instanceof VObject\Component\VCalendar) {
+			throw new VObject\ParseException('Supplied input could not be parsed as VCALENDAR.');
+		}
+
+		foreach ($data->children() as $component) {
+			if (!$component instanceof VObject\Component) {
+				continue;
+			}
+
+			// Get all timezones
+			if ($component->name === 'VTIMEZONE') {
+				$this->vtimezones[(string)$component->TZID] = $component;
+				continue;
+			}
+
+			// Get component UID for recurring Events search
+			if (!$component->UID) {
+				$component->UID = sha1(microtime()) . '-vobjectimport';
+			}
+			$uid = (string)$component->UID;
+
+			// Take care of recurring events
+			if (!array_key_exists($uid, $this->objects)) {
+				$this->objects[$uid] = new VCalendar();
+			}
+
+			$this->objects[$uid]->add(clone $component);
+		}
+
+	}
+
+	/**
+	 * Every time getNext() is called, a new object will be parsed, until we
+	 * hit the end of the stream.
+	 *
+	 * When the end is reached, null will be returned.
+	 *
+	 * @return Sabre\VObject\Component|null
+	 */
+	public function getNext() {
+
+		if ($object = array_shift($this->objects)) {
+
+			// create our baseobject
+			$object->version = '2.0';
+			$object->prodid = '-//Sabre//Sabre VObject ' . VObject\Version::VERSION . '//EN';
+			$object->calscale = 'GREGORIAN';
+
+			// add vtimezone information to obj (if we have it)
+			foreach ($this->vtimezones as $vtimezone) {
+				$object->add($vtimezone);
+			}
+
+			return $object;
+
+		} else {
+
+			return;
+
+		}
+
+	}
 
 }

libraries/SabreDAV/VObject/Splitter/VCard.php

Indentation +43 added lines, -43 removed lines

@@ -21,58 +21,58 @@
  */
 class VCard implements SplitterInterface {
 
-    /**
-     * File handle.
-     *
-     * @var resource
-     */
-    protected $input;
+	/**
+	 * File handle.
+	 *
+	 * @var resource
+	 */
+	protected $input;
 
-    /**
-     * Persistent parser.
-     *
-     * @var MimeDir
-     */
-    protected $parser;
+	/**
+	 * Persistent parser.
+	 *
+	 * @var MimeDir
+	 */
+	protected $parser;
 
-    /**
-     * Constructor.
-     *
-     * The splitter should receive an readable file stream as it's input.
-     *
-     * @param resource $input
-     * @param int $options Parser options, see the OPTIONS constants.
-     */
-    public function __construct($input, $options = 0) {
+	/**
+	 * Constructor.
+	 *
+	 * The splitter should receive an readable file stream as it's input.
+	 *
+	 * @param resource $input
+	 * @param int $options Parser options, see the OPTIONS constants.
+	 */
+	public function __construct($input, $options = 0) {
 
-        $this->input = $input;
-        $this->parser = new MimeDir($input, $options);
+		$this->input = $input;
+		$this->parser = new MimeDir($input, $options);
 
-    }
+	}
 
-    /**
-     * Every time getNext() is called, a new object will be parsed, until we
-     * hit the end of the stream.
-     *
-     * When the end is reached, null will be returned.
-     *
-     * @return Sabre\VObject\Component|null
-     */
-    public function getNext() {
+	/**
+	 * Every time getNext() is called, a new object will be parsed, until we
+	 * hit the end of the stream.
+	 *
+	 * When the end is reached, null will be returned.
+	 *
+	 * @return Sabre\VObject\Component|null
+	 */
+	public function getNext() {
 
-        try {
-            $object = $this->parser->parse();
+		try {
+			$object = $this->parser->parse();
 
-            if (!$object instanceof VObject\Component\VCard) {
-                throw new VObject\ParseException('The supplied input contained non-VCARD data.');
-            }
+			if (!$object instanceof VObject\Component\VCard) {
+				throw new VObject\ParseException('The supplied input contained non-VCARD data.');
+			}
 
-        } catch (VObject\EofException $e) {
-            return;
-        }
+		} catch (VObject\EofException $e) {
+			return;
+		}
 
-        return $object;
+		return $object;
 
-    }
+	}
 
 }

libraries/SabreDAV/VObject/Splitter/SplitterInterface.php

Indentation +17 added lines, -17 removed lines

@@ -17,23 +17,23 @@
  */
 interface SplitterInterface {
 
-    /**
-     * Constructor.
-     *
-     * The splitter should receive an readable file stream as it's input.
-     *
-     * @param resource $input
-     */
-    public function __construct($input);
+	/**
+	 * Constructor.
+	 *
+	 * The splitter should receive an readable file stream as it's input.
+	 *
+	 * @param resource $input
+	 */
+	public function __construct($input);
 
-    /**
-     * Every time getNext() is called, a new object will be parsed, until we
-     * hit the end of the stream.
-     *
-     * When the end is reached, null will be returned.
-     *
-     * @return Sabre\VObject\Component|null
-     */
-    public function getNext();
+	/**
+	 * Every time getNext() is called, a new object will be parsed, until we
+	 * hit the end of the stream.
+	 *
+	 * When the end is reached, null will be returned.
+	 *
+	 * @return Sabre\VObject\Component|null
+	 */
+	public function getNext();
 
 }