Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php

/**
 *  BENNU - PHP iCalendar library
 *  (c) 2005-2006 Ioannis Papaioannou (pj@moodle.org). All rights reserved.
 *
 *  Released under the LGPL.
 *
 *  See http://bennu.sourceforge.net/ for more information and downloads.
 *
 * @author Ioannis Papaioannou 
 * @version $Id$
 * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
 */

class iCalendar_property {
    // Properties can have parameters, but cannot have other properties or components

    var $parent_component = NULL;
    var $value            = NULL;
    var $parameters       = NULL;
    var $valid_parameters = NULL;

    // These are common for 95% of properties, so define them here and override as necessary
    var $val_multi        = false;
    var $val_default      = NULL;

> /** @var int|null RFC2445_TYPE value. */ function __construct() { > protected $val_type; $this->parameters = array(); > } > /** @var string property name. */ > protected $name; // If some property needs extra care with its parameters, override this >
// IMPORTANT: the parameter name MUST BE CAPITALIZED! function is_valid_parameter($parameter, $value) { if(is_array($value)) { if(!iCalendar_parameter::multiple_values_allowed($parameter)) { return false; } foreach($value as $item) { if(!iCalendar_parameter::is_valid_value($this, $parameter, $item)) { return false; } } return true; } return iCalendar_parameter::is_valid_value($this, $parameter, $value); } function invariant_holds() { return true; } // If some property is very picky about its values, it should do the work itself // Only data type validation is done here function is_valid_value($value) { if(is_array($value)) { if(!$this->val_multi) { return false; } else { foreach($value as $oneval) { if(!rfc2445_is_valid_value($oneval, $this->val_type)) { return false; } } } return true; } return rfc2445_is_valid_value($value, $this->val_type); } function default_value() { return $this->val_default; } function set_parent_component($componentname) { if(class_exists('iCalendar_'.strtolower(substr($componentname, 1)))) { $this->parent_component = strtoupper($componentname); return true; } return false; } function set_value($value) { if($this->is_valid_value($value)) { // This transparently formats any value type according to the iCalendar specs if(is_array($value)) { foreach($value as $key => $item) { $value[$key] = rfc2445_do_value_formatting($item, $this->val_type); } $this->value = implode(',', $value); } else { $this->value = rfc2445_do_value_formatting($value, $this->val_type); } return true; } return false; } function get_value() { // First of all, assume that we have multiple values $valarray = explode('\\,', $this->value); // Undo transparent formatting $valtype = $this->val_type; $replace_function = function($a) use ($valtype) { return rfc2445_undo_value_formatting($a, $valtype); }; $valarray = array_map($replace_function, $valarray); // Now, if this property cannot have multiple values, don't return as an array if(!$this->val_multi) { return $valarray[0]; } // Otherwise return an array even if it has one element, for uniformity return $valarray; } function set_parameter($name, $value) { // Uppercase $name = strtoupper($name); // Are we trying to add a valid parameter? $xname = false; if(!isset($this->valid_parameters[$name])) { // If not, is it an x-name as per RFC 2445? if(!rfc2445_is_xname($name)) { return false; } // No more checks -- all components are supposed to allow x-name parameters $xname = true; } if(!$this->is_valid_parameter($name, $value)) { return false; } if(is_array($value)) { foreach($value as $key => $element) { $value[$key] = iCalendar_parameter::do_value_formatting($name, $element); } } else { $value = iCalendar_parameter::do_value_formatting($name, $value); } $this->parameters[$name] = $value; // Special case: if we just changed the VALUE parameter, reflect this // in the object's status so that it only accepts correct type values if($name == 'VALUE') { // TODO: what if this invalidates an already-set value? $this->val_type = constant('RFC2445_TYPE_'.str_replace('-', '_', $value)); } return true; } function get_parameter($name) { // Uppercase $name = strtoupper($name); if(isset($this->parameters[$name])) { // If there are any double quotes in the value, invisibly strip them if(is_array($this->parameters[$name])) { foreach($this->parameters[$name] as $key => $value) { if(substr($value, 0, 1) == '"') { $this->parameters[$name][$key] = substr($value, 1, strlen($value) - 2); } } return $this->parameters[$name]; } else { if(substr($this->parameters[$name], 0, 1) == '"') { return substr($this->parameters[$name], 1, strlen($this->parameters[$name]) - 2); } } } return NULL; } function serialize() { $string = $this->name; if(!empty($this->parameters)) { foreach($this->parameters as $name => $value) { $string .= ';'.$name.'='; if(is_array($value)) { $string .= implode(',', $value); } else { $string .= $value; } } } $string .= ':'.$this->value; return rfc2445_fold($string) . RFC2445_CRLF; } } // 4.7 Calendar Properties // ----------------------- class iCalendar_property_calscale extends iCalendar_property { var $name = 'CALSCALE'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // This is case-sensitive return ($value === 'GREGORIAN'); } } class iCalendar_property_method extends iCalendar_property { var $name = 'METHOD'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // This is case-sensitive // Methods from RFC 2446 $methods = array('PUBLISH', 'REQUEST', 'REPLY', 'ADD', 'CANCEL', 'REFRESH', 'COUNTER', 'DECLINECOUNTER'); return in_array($value, $methods); } } class iCalendar_property_prodid extends iCalendar_property { var $name = 'PRODID'; var $val_type = RFC2445_TYPE_TEXT; var $val_default = NULL; function __construct() { parent::__construct(); $this->val_default = '-//John Papaioannou/NONSGML Bennu '._BENNU_VERSION.'//EN'; $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_version extends iCalendar_property { var $name = 'VERSION'; var $val_type = RFC2445_TYPE_TEXT; var $val_default = '2.0'; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { return($value === '2.0' || $value === 2.0); } } // 4.8.1 Descriptive Component Properties // -------------------------------------- class iCalendar_property_attach extends iCalendar_property { var $name = 'ATTACH'; var $val_type = RFC2445_TYPE_URI; function __construct() { parent::__construct(); $this->valid_parameters = array( 'FMTTYPE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'ENCODING' => RFC2445_OPTIONAL | RFC2445_ONCE, 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function invariant_holds() { if(isset($this->parameters['ENCODING']) && !isset($this->parameters['VALUE'])) { return false; } if(isset($this->parameters['VALUE']) && !isset($this->parameters['ENCODING'])) { return false; } return true; } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter === 'ENCODING' && strtoupper($value) != 'BASE64') { return false; } if($parameter === 'VALUE' && strtoupper($value) != 'BINARY') { return false; } return true; } } class iCalendar_property_categories extends iCalendar_property { var $name = 'CATEGORIES'; var $val_type = RFC2445_TYPE_TEXT; var $val_multi = true; function __construct() { parent::__construct(); $this->valid_parameters = array( 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_class extends iCalendar_property { var $name = 'CLASS'; var $val_type = RFC2445_TYPE_TEXT; var $val_default = 'PUBLIC'; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // If this is not an xname, it is case-sensitive return ($value === 'PUBLIC' || $value === 'PRIVATE' || $value === 'CONFIDENTIAL' || rfc2445_is_xname(strtoupper($value))); } } class iCalendar_property_comment extends iCalendar_property { var $name = 'COMMENT'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_description extends iCalendar_property { var $name = 'DESCRIPTION'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_geo extends iCalendar_property { var $name = 'GEO'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // This MUST be two floats separated by a semicolon if(!is_string($value)) { return false; } $floats = explode(';', $value); if(count($floats) != 2) { return false; } return rfc2445_is_valid_value($floats[0], RFC2445_TYPE_FLOAT) && rfc2445_is_valid_value($floats[1], RFC2445_TYPE_FLOAT); } function set_value($value) { // Must override this, otherwise the semicolon separating // the two floats would get auto-quoted, which is illegal if($this->is_valid_value($value)) { $this->value = $value; return true; } return false; } } class iCalendar_property_location extends iCalendar_property { var $name = 'LOCATION'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_percent_complete extends iCalendar_property { var $name = 'PERCENT-COMPLETE'; var $val_type = RFC2445_TYPE_INTEGER; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // Only integers between 0 and 100 inclusive allowed if(!parent::is_valid_value($value)) { return false; } $value = intval($value); return ($value >= 0 && $value <= 100); } } class iCalendar_property_priority extends iCalendar_property { var $name = 'PRIORITY'; var $val_type = RFC2445_TYPE_INTEGER; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // Only integers between 0 and 9 inclusive allowed if(!parent::is_valid_value($value)) { return false; } $value = intval($value); return ($value >= 0 && $value <= 9); } } class iCalendar_property_resources extends iCalendar_property { var $name = 'RESOURCES'; var $val_type = RFC2445_TYPE_TEXT; var $val_multi = true; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_status extends iCalendar_property { var $name = 'STATUS'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { // This is case-sensitive switch ($this->parent_component) { case 'VEVENT': $allowed = array('TENTATIVE', 'CONFIRMED', 'CANCELLED'); break; case 'VTODO': $allowed = array('NEEDS-ACTION', 'COMPLETED', 'IN-PROCESS', 'CANCELLED'); break; case 'VJOURNAL': $allowed = array('DRAFT', 'FINAL', 'CANCELLED'); break; } return in_array($value, $allowed); } } class iCalendar_property_summary extends iCalendar_property { var $name = 'SUMMARY'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } // 4.8.2 Date and Time Component Properties // ---------------------------------------- class iCalendar_property_completed extends iCalendar_property { var $name = 'COMPLETED'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Time MUST be in UTC format return(substr($value, -1) == 'Z'); } } class iCalendar_property_dtend extends iCalendar_property { var $name = 'DTEND'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'TZID' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // If present in a FREEBUSY component, must be in UTC format if($this->parent_component == 'VFREEBUSY' && substr($value, -1) != 'Z') { return false; } return true; } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter == 'VALUE' && !($value == 'DATE' || $value == 'DATE-TIME')) { return false; } return true; } } class iCalendar_property_due extends iCalendar_property { var $name = 'DUE'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'TZID' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // If present in a FREEBUSY component, must be in UTC format if($this->parent_component == 'VFREEBUSY' && substr($value, -1) != 'Z') { return false; } return true; } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter == 'VALUE' && !($value == 'DATE' || $value == 'DATE-TIME')) { return false; } return true; } } class iCalendar_property_dtstart extends iCalendar_property { var $name = 'DTSTART'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'TZID' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } // TODO: unimplemented stuff when parent is a VTIMEZONE component function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // If present in a FREEBUSY component, must be in UTC format if($this->parent_component == 'VFREEBUSY' && substr($value, -1) != 'Z') { return false; } return true; } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter == 'VALUE' && !($value == 'DATE' || $value == 'DATE-TIME')) { return false; } return true; } } class iCalendar_property_duration extends iCalendar_property { var $name = 'DURATION'; var $val_type = RFC2445_TYPE_DURATION; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Value must be positive return ($value[0] != '-'); } } class iCalendar_property_freebusy extends iCalendar_property { var $name = 'FREEBUSY'; var $val_type = RFC2445_TYPE_PERIOD; var $val_multi = true; function __construct() { parent::__construct(); $this->valid_parameters = array( 'FBTYPE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } $pos = strpos($value, '/'); // We know there's only one / in there if($value[$pos - 1] != 'Z') { // Start time MUST be in UTC return false; } if($value[$pos + 1] != 'P' && substr($value, -1) != 'Z') { // If the second part is not a period, it MUST be in UTC return false; } return true; } // TODO: these properties SHOULD be shorted in ascending order (by start time and end time as tiebreak) } class iCalendar_property_transp extends iCalendar_property { var $name = 'TRANSP'; var $val_type = RFC2445_TYPE_TEXT; var $val_default = 'OPAQUE'; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { return ($value === 'TRANSPARENT' || $value === 'OPAQUE'); } } // TODO: 4.8.3 timezone component properties // 4.8.4 Relationship Component Properties // --------------------------------------- class iCalendar_property_attendee extends iCalendar_property { var $name = 'ATTENDEE'; var $val_type = RFC2445_TYPE_CAL_ADDRESS; // TODO: MUST NOT be specified when the calendar object has METHOD=PUBLISH // TODO: standard has lots of detail here, make triple sure that we eventually conform function __construct() { parent::__construct(); $this->valid_parameters = array( 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'CN' => RFC2445_OPTIONAL | RFC2445_ONCE, 'ROLE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'PARTSTAT' => RFC2445_OPTIONAL | RFC2445_ONCE, 'RSVP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'CUTYPE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'MEMBER' => RFC2445_OPTIONAL | RFC2445_ONCE, 'DELEGATED-TO' => RFC2445_OPTIONAL | RFC2445_ONCE, 'DELEGATED-FROM' => RFC2445_OPTIONAL | RFC2445_ONCE, 'SENT-BY' => RFC2445_OPTIONAL | RFC2445_ONCE, 'DIR' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function set_parent_component($componentname) { if(!parent::set_parent_component($componentname)) { return false; } if($this->parent_component == 'VFREEBUSY' || $this->parent_component == 'VALARM') { // Most parameters become invalid in this case, the full allowed set is now: $this->valid_parameters = array( 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } return false; } } class iCalendar_property_contact extends iCalendar_property { var $name = 'CONTACT'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'ALTREP' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_organizer extends iCalendar_property { var $name = 'ORGANIZER'; var $val_type = RFC2445_TYPE_CAL_ADDRESS; function __construct() { parent::__construct(); $this->valid_parameters = array( 'CN' => RFC2445_OPTIONAL | RFC2445_ONCE, 'DIR' => RFC2445_OPTIONAL | RFC2445_ONCE, 'SENT-BY' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } // TODO: /* Conformance: This property MUST be specified in an iCalendar object that specifies a group scheduled calendar entity. This property MUST be specified in an iCalendar object that specifies the publication of a calendar user's busy time. This property MUST NOT be specified in an iCalendar object that specifies only a time zone definition or that defines calendar entities that are not group scheduled entities, but are entities only on a single user's calendar. */ } class iCalendar_property_recurrence_id extends iCalendar_property { // TODO: can only be specified when defining recurring components in the calendar /* Conformance: This property can be specified in an iCalendar object containing a recurring calendar component. Description: The full range of calendar components specified by a recurrence set is referenced by referring to just the "UID" property value corresponding to the calendar component. The "RECURRENCE-ID" property allows the reference to an individual instance within the recurrence set. */ var $name = 'RECURRENCE-ID'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( 'RANGE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'TZID' => RFC2445_OPTIONAL | RFC2445_ONCE, 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter == 'VALUE' && !($value == 'DATE' || $value == 'DATE-TIME')) { return false; } return true; } } class iCalendar_property_related_to extends iCalendar_property { var $name = 'RELATED-TO'; var $val_type = RFC2445_TYPE_TEXT; // TODO: the value of this property must reference another component's UID function __construct() { parent::__construct(); $this->valid_parameters = array( 'RELTYPE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_url extends iCalendar_property { var $name = 'URL'; var $val_type = RFC2445_TYPE_URI; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_uid extends iCalendar_property { var $name = 'UID'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); // The exception to the rule: this is not a static value, so we // generate it on-the-fly here. Guaranteed to be different for // each instance of this property, too. Nice. $this->val_default = Bennu::generate_guid(); } } // 4.8.5 Recurrence Component Properties // ------------------------------------- class iCalendar_property_exdate extends iCalendar_property { var $name = 'EXDATE'; var $val_type = RFC2445_TYPE_DATE_TIME; var $val_multi = true; function __construct() { parent::__construct(); $this->valid_parameters = array( 'TZID' => RFC2445_OPTIONAL | RFC2445_ONCE, 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter == 'VALUE' && !($value == 'DATE' || $value == 'DATE-TIME')) { return false; } return true; } } class iCalendar_property_exrule extends iCalendar_property { var $name = 'EXRULE'; var $val_type = RFC2445_TYPE_RECUR; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_rdate extends iCalendar_property { var $name = 'RDATE'; var $val_type = RFC2445_TYPE_DATE_TIME; var $val_multi = true; function __construct() { parent::__construct(); $this->valid_parameters = array( 'TZID' => RFC2445_OPTIONAL | RFC2445_ONCE, 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_parameter($parameter, $value) { $parameter = strtoupper($parameter); if(!parent::is_valid_parameter($parameter, $value)) { return false; } if($parameter == 'VALUE' && !($value == 'DATE' || $value == 'DATE-TIME' || $value == 'PERIOD')) { return false; } return true; } } class iCalendar_property_rrule extends iCalendar_property { var $name = 'RRULE'; var $val_type = RFC2445_TYPE_RECUR; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } // 4.8.6 Alarm Component Properties // ------------------------------------------- class iCalendar_property_action extends iCalendar_property { var $name = 'ACTION'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Value must be one of the following, or an x-name. $valid_values = array('ACTION', 'DISPLAY', 'EMAIL', 'PROCEDURE'); return(in_array($value, $valid_values) || rfc2445_is_xname($value)); } } class iCalendar_property_repeat extends iCalendar_property { var $name = 'REPEAT'; var $val_type = RFC2445_TYPE_INTEGER; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } class iCalendar_property_trigger extends iCalendar_property { var $name = 'TRIGGER'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'VALUE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'RELATED' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Must either be DURATION or DATE_TIME type return(rfc2445_is_valid_value($value, RFC2445_TYPE_DURATION) || rfc2445_is_valid_value($value, RFC2445_TYPE_DATE_TIME)); } } // 4.8.7 Change Management Component Properties // -------------------------------------------- class iCalendar_property_created extends iCalendar_property { var $name = 'CREATED'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Time MUST be in UTC format return(substr($value, -1) == 'Z'); } } class iCalendar_property_dtstamp extends iCalendar_property { var $name = 'DTSTAMP'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Time MUST be in UTC format return(substr($value, -1) == 'Z'); } } class iCalendar_property_last_modified extends iCalendar_property { var $name = 'LAST-MODIFIED'; var $val_type = RFC2445_TYPE_DATE_TIME; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } // Time MUST be in UTC format return(substr($value, -1) == 'Z'); } } class iCalendar_property_sequence extends iCalendar_property { var $name = 'SEQUENCE'; var $val_type = RFC2445_TYPE_INTEGER; var $val_default = 0; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } $value = intval($value); return ($value >= 0); } } // 4.8.8 Miscellaneous Component Properties // ---------------------------------------- class iCalendar_property_x extends iCalendar_property { var $name = RFC2445_XNAME; var $val_type = NULL; function __construct() { parent::__construct(); $this->valid_parameters = array( // X-ALT-DESC (Description) can have FMTTYPE declaration of text/html is a property for HTML content. 'FMTTYPE' => RFC2445_OPTIONAL | RFC2445_ONCE, 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function set_name($name) { $name = strtoupper($name); if(rfc2445_is_xname($name)) { $this->name = $name; return true; } return false; } } class iCalendar_property_request_status extends iCalendar_property { // IMPORTANT NOTE: This property value includes TEXT fields // separated by semicolons. Unfortunately, auto-value-formatting // cannot be used in this case. As an exception, the value passed // to this property MUST be already escaped. var $name = 'REQUEST-STATUS'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!is_string($value) || empty($value)) { return false; } $len = strlen($value); $parts = array(); $from = 0; $escch = false; for($i = 0; $i < $len; ++$i) { if($value[$i] == ';' && !$escch) { // Token completed $parts[] = substr($value, $from, $i - $from); $from = $i + 1; continue; } $escch = ($value[$i] == '\\'); } // Add one last token with the remaining text; if the value // ended with a ';' it was illegal, so check that this token // is not the empty string. $parts[] = substr($value, $from); $count = count($parts); // May have 2 or 3 tokens (last one is optional) if($count != 2 && $count != 3) { return false; } // REMEMBER: if ANY part is empty, we have an illegal value // First token must be hierarchical numeric status (3 levels max) if(strlen($parts[0]) == 0) { return false; } if($parts[0][0] < '1' || $parts[0][0] > '4') { return false; } $len = strlen($parts[0]); // Max 3 levels, and can't end with a period if($len > 5 || $parts[0][$len - 1] == '.') { return false; } for($i = 1; $i < $len; ++$i) { if(($i & 1) == 1 && $parts[0][$i] != '.') { // Even-indexed chars must be periods return false; } else if(($i & 1) == 0 && ($parts[0][$i] < '0' || $parts[0][$i] > '9')) { // Odd-indexed chars must be numbers return false; } } // Second and third tokens must be TEXT, and already escaped, so // they are not allowed to have UNESCAPED semicolons, commas, slashes, // or any newlines at all for($i = 1; $i < $count; ++$i) { if(strpos($parts[$i], "\n") !== false) { return false; } $len = strlen($parts[$i]); if($len == 0) { // Cannot be empty return false; } $parts[$i] .= '#'; // This guard token saves some conditionals in the loop for($j = 0; $j < $len; ++$j) { $thischar = $parts[$i][$j]; $nextchar = $parts[$i][$j + 1]; if($thischar == '\\') { // Next char must now be one of ";,\nN" if($nextchar != ';' && $nextchar != ',' && $nextchar != '\\' && $nextchar != 'n' && $nextchar != 'N') { return false; } // OK, this escaped sequence is correct, bypass next char ++$j; continue; } if($thischar == ';' || $thischar == ',' || $thischar == '\\') { // This wasn't escaped as it should return false; } } } return true; } function set_value($value) { // Must override this, otherwise the value would be quoted again if($this->is_valid_value($value)) { $this->value = $value; return true; } return false; } } class iCalendar_property_tzid extends iCalendar_property { var $name = 'TZID'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } else { return true; } } } class iCalendar_property_tzname extends iCalendar_property { var $name = 'TZNAME'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( 'LANGUAGE' => RFC2445_OPTIONAL | RFC2445_ONCE, RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } else { return true; } } } class iCalendar_property_tzoffsetfrom extends iCalendar_property { var $name = 'TZOFFSETFROM'; var $val_type = RFC2445_TYPE_UTC_OFFSET; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } else { return true; } } } class iCalendar_property_tzoffsetto extends iCalendar_property { var $name = 'TZOFFSETTO'; var $val_type = RFC2445_TYPE_UTC_OFFSET; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } function is_valid_value($value) { if(!parent::is_valid_value($value)) { return false; } else { return true; } } } class iCalendar_property_tzurl extends iCalendar_property { var $name = 'TZURL'; var $val_type = RFC2445_TYPE_URI; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } ####################### /* class iCalendar_property_class extends iCalendar_property { var $name = 'CLASS'; var $val_type = RFC2445_TYPE_TEXT; function __construct() { parent::__construct(); $this->valid_parameters = array( RFC2445_XNAME => RFC2445_OPTIONAL ); } } */