c80837a9e6
michelf/php-markdown (1.7.0 => 1.8.0) ezyang/htmlpurifier (v4.9.3 => v4.10.0) commerceguys/intl (v0.7.4 => v0.7.5) sabre/http (4.2.3 => v4.2.4) sabre/vobject (4.1.3 => 4.1.5)
664 lines
16 KiB
PHP
664 lines
16 KiB
PHP
<?php
|
|
|
|
namespace Sabre\VObject;
|
|
|
|
use Sabre\Xml;
|
|
|
|
/**
|
|
* Property.
|
|
*
|
|
* A property is always in a KEY:VALUE structure, and may optionally contain
|
|
* parameters.
|
|
*
|
|
* @copyright Copyright (C) fruux GmbH (https://fruux.com/)
|
|
* @author Evert Pot (http://evertpot.com/)
|
|
* @license http://sabre.io/license/ Modified BSD License
|
|
*/
|
|
abstract class Property extends Node {
|
|
|
|
/**
|
|
* Property name.
|
|
*
|
|
* This will contain a string such as DTSTART, SUMMARY, FN.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* Property group.
|
|
*
|
|
* This is only used in vcards
|
|
*
|
|
* @var string
|
|
*/
|
|
public $group;
|
|
|
|
/**
|
|
* List of parameters.
|
|
*
|
|
* @var array
|
|
*/
|
|
public $parameters = [];
|
|
|
|
/**
|
|
* Current value.
|
|
*
|
|
* @var mixed
|
|
*/
|
|
protected $value;
|
|
|
|
/**
|
|
* In case this is a multi-value property. This string will be used as a
|
|
* delimiter.
|
|
*
|
|
* @var string|null
|
|
*/
|
|
public $delimiter = ';';
|
|
|
|
/**
|
|
* Creates the generic property.
|
|
*
|
|
* Parameters must be specified in key=>value syntax.
|
|
*
|
|
* @param Component $root The root document
|
|
* @param string $name
|
|
* @param string|array|null $value
|
|
* @param array $parameters List of parameters
|
|
* @param string $group The vcard property group
|
|
*
|
|
* @return void
|
|
*/
|
|
function __construct(Component $root, $name, $value = null, array $parameters = [], $group = null) {
|
|
|
|
$this->name = $name;
|
|
$this->group = $group;
|
|
|
|
$this->root = $root;
|
|
|
|
foreach ($parameters as $k => $v) {
|
|
$this->add($k, $v);
|
|
}
|
|
|
|
if (!is_null($value)) {
|
|
$this->setValue($value);
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Updates the current value.
|
|
*
|
|
* This may be either a single, or multiple strings in an array.
|
|
*
|
|
* @param string|array $value
|
|
*
|
|
* @return void
|
|
*/
|
|
function setValue($value) {
|
|
|
|
$this->value = $value;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns the current value.
|
|
*
|
|
* This method will always return a singular value. If this was a
|
|
* multi-value object, some decision will be made first on how to represent
|
|
* it as a string.
|
|
*
|
|
* To get the correct multi-value version, use getParts.
|
|
*
|
|
* @return string
|
|
*/
|
|
function getValue() {
|
|
|
|
if (is_array($this->value)) {
|
|
if (count($this->value) == 0) {
|
|
return;
|
|
} elseif (count($this->value) === 1) {
|
|
return $this->value[0];
|
|
} else {
|
|
return $this->getRawMimeDirValue();
|
|
}
|
|
} else {
|
|
return $this->value;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Sets a multi-valued property.
|
|
*
|
|
* @param array $parts
|
|
*
|
|
* @return void
|
|
*/
|
|
function setParts(array $parts) {
|
|
|
|
$this->value = $parts;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns a multi-valued property.
|
|
*
|
|
* This method always returns an array, if there was only a single value,
|
|
* it will still be wrapped in an array.
|
|
*
|
|
* @return array
|
|
*/
|
|
function getParts() {
|
|
|
|
if (is_null($this->value)) {
|
|
return [];
|
|
} elseif (is_array($this->value)) {
|
|
return $this->value;
|
|
} else {
|
|
return [$this->value];
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Adds a new parameter.
|
|
*
|
|
* If a parameter with same name already existed, the values will be
|
|
* combined.
|
|
* If nameless parameter is added, we try to guess it's name.
|
|
*
|
|
* @param string $name
|
|
* @param string|null|array $value
|
|
*/
|
|
function add($name, $value = null) {
|
|
$noName = false;
|
|
if ($name === null) {
|
|
$name = Parameter::guessParameterNameByValue($value);
|
|
$noName = true;
|
|
}
|
|
|
|
if (isset($this->parameters[strtoupper($name)])) {
|
|
$this->parameters[strtoupper($name)]->addValue($value);
|
|
}
|
|
else {
|
|
$param = new Parameter($this->root, $name, $value);
|
|
$param->noName = $noName;
|
|
$this->parameters[$param->name] = $param;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns an iterable list of children.
|
|
*
|
|
* @return array
|
|
*/
|
|
function parameters() {
|
|
|
|
return $this->parameters;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns the type of value.
|
|
*
|
|
* This corresponds to the VALUE= parameter. Every property also has a
|
|
* 'default' valueType.
|
|
*
|
|
* @return string
|
|
*/
|
|
abstract function getValueType();
|
|
|
|
/**
|
|
* Sets a raw value coming from a mimedir (iCalendar/vCard) file.
|
|
*
|
|
* This has been 'unfolded', so only 1 line will be passed. Unescaping is
|
|
* not yet done, but parameters are not included.
|
|
*
|
|
* @param string $val
|
|
*
|
|
* @return void
|
|
*/
|
|
abstract function setRawMimeDirValue($val);
|
|
|
|
/**
|
|
* Returns a raw mime-dir representation of the value.
|
|
*
|
|
* @return string
|
|
*/
|
|
abstract function getRawMimeDirValue();
|
|
|
|
/**
|
|
* Turns the object back into a serialized blob.
|
|
*
|
|
* @return string
|
|
*/
|
|
function serialize() {
|
|
|
|
$str = $this->name;
|
|
if ($this->group) $str = $this->group . '.' . $this->name;
|
|
|
|
foreach ($this->parameters() as $param) {
|
|
|
|
$str .= ';' . $param->serialize();
|
|
|
|
}
|
|
|
|
$str .= ':' . $this->getRawMimeDirValue();
|
|
|
|
$out = '';
|
|
while (strlen($str) > 0) {
|
|
if (strlen($str) > 75) {
|
|
$part = mb_strcut($str, 0, 75, 'utf-8');
|
|
$out .= $part . "\r\n";
|
|
$str = ' ' . substr($str, strlen($part));
|
|
} else {
|
|
$out .= $str . "\r\n";
|
|
$str = '';
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $out;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns the value, in the format it should be encoded for JSON.
|
|
*
|
|
* This method must always return an array.
|
|
*
|
|
* @return array
|
|
*/
|
|
function getJsonValue() {
|
|
|
|
return $this->getParts();
|
|
|
|
}
|
|
|
|
/**
|
|
* Sets the JSON value, as it would appear in a jCard or jCal object.
|
|
*
|
|
* The value must always be an array.
|
|
*
|
|
* @param array $value
|
|
*
|
|
* @return void
|
|
*/
|
|
function setJsonValue(array $value) {
|
|
|
|
if (count($value) === 1) {
|
|
$this->setValue(reset($value));
|
|
} else {
|
|
$this->setValue($value);
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function jsonSerialize() {
|
|
|
|
$parameters = [];
|
|
|
|
foreach ($this->parameters as $parameter) {
|
|
if ($parameter->name === 'VALUE') {
|
|
continue;
|
|
}
|
|
$parameters[strtolower($parameter->name)] = $parameter->jsonSerialize();
|
|
}
|
|
// In jCard, we need to encode the property-group as a separate 'group'
|
|
// parameter.
|
|
if ($this->group) {
|
|
$parameters['group'] = $this->group;
|
|
}
|
|
|
|
return array_merge(
|
|
[
|
|
strtolower($this->name),
|
|
(object)$parameters,
|
|
strtolower($this->getValueType()),
|
|
],
|
|
$this->getJsonValue()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Hydrate data from a XML subtree, as it would appear in a xCard or xCal
|
|
* object.
|
|
*
|
|
* @param array $value
|
|
*
|
|
* @return void
|
|
*/
|
|
function setXmlValue(array $value) {
|
|
|
|
$this->setJsonValue($value);
|
|
|
|
}
|
|
|
|
/**
|
|
* This method serializes the data into XML. This is used to create xCard or
|
|
* xCal documents.
|
|
*
|
|
* @param Xml\Writer $writer XML writer.
|
|
*
|
|
* @return void
|
|
*/
|
|
function xmlSerialize(Xml\Writer $writer) {
|
|
|
|
$parameters = [];
|
|
|
|
foreach ($this->parameters as $parameter) {
|
|
|
|
if ($parameter->name === 'VALUE') {
|
|
continue;
|
|
}
|
|
|
|
$parameters[] = $parameter;
|
|
|
|
}
|
|
|
|
$writer->startElement(strtolower($this->name));
|
|
|
|
if (!empty($parameters)) {
|
|
|
|
$writer->startElement('parameters');
|
|
|
|
foreach ($parameters as $parameter) {
|
|
|
|
$writer->startElement(strtolower($parameter->name));
|
|
$writer->write($parameter);
|
|
$writer->endElement();
|
|
|
|
}
|
|
|
|
$writer->endElement();
|
|
|
|
}
|
|
|
|
$this->xmlSerializeValue($writer);
|
|
$writer->endElement();
|
|
|
|
}
|
|
|
|
/**
|
|
* This method serializes only the value of a property. This is used to
|
|
* create xCard or xCal documents.
|
|
*
|
|
* @param Xml\Writer $writer XML writer.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function xmlSerializeValue(Xml\Writer $writer) {
|
|
|
|
$valueType = strtolower($this->getValueType());
|
|
|
|
foreach ($this->getJsonValue() as $values) {
|
|
foreach ((array)$values as $value) {
|
|
$writer->writeElement($valueType, $value);
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Called when this object is being cast to a string.
|
|
*
|
|
* If the property only had a single value, you will get just that. In the
|
|
* case the property had multiple values, the contents will be escaped and
|
|
* combined with ,.
|
|
*
|
|
* @return string
|
|
*/
|
|
function __toString() {
|
|
|
|
return (string)$this->getValue();
|
|
|
|
}
|
|
|
|
/* ArrayAccess interface {{{ */
|
|
|
|
/**
|
|
* Checks if an array element exists.
|
|
*
|
|
* @param mixed $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
function offsetExists($name) {
|
|
|
|
if (is_int($name)) return parent::offsetExists($name);
|
|
|
|
$name = strtoupper($name);
|
|
|
|
foreach ($this->parameters as $parameter) {
|
|
if ($parameter->name == $name) return true;
|
|
}
|
|
return false;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns a parameter.
|
|
*
|
|
* If the parameter does not exist, null is returned.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return Node
|
|
*/
|
|
function offsetGet($name) {
|
|
|
|
if (is_int($name)) return parent::offsetGet($name);
|
|
$name = strtoupper($name);
|
|
|
|
if (!isset($this->parameters[$name])) {
|
|
return;
|
|
}
|
|
|
|
return $this->parameters[$name];
|
|
|
|
}
|
|
|
|
/**
|
|
* Creates a new parameter.
|
|
*
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*
|
|
* @return void
|
|
*/
|
|
function offsetSet($name, $value) {
|
|
|
|
if (is_int($name)) {
|
|
parent::offsetSet($name, $value);
|
|
// @codeCoverageIgnoreStart
|
|
// This will never be reached, because an exception is always
|
|
// thrown.
|
|
return;
|
|
// @codeCoverageIgnoreEnd
|
|
}
|
|
|
|
$param = new Parameter($this->root, $name, $value);
|
|
$this->parameters[$param->name] = $param;
|
|
|
|
}
|
|
|
|
/**
|
|
* Removes one or more parameters with the specified name.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return void
|
|
*/
|
|
function offsetUnset($name) {
|
|
|
|
if (is_int($name)) {
|
|
parent::offsetUnset($name);
|
|
// @codeCoverageIgnoreStart
|
|
// This will never be reached, because an exception is always
|
|
// thrown.
|
|
return;
|
|
// @codeCoverageIgnoreEnd
|
|
}
|
|
|
|
unset($this->parameters[strtoupper($name)]);
|
|
|
|
}
|
|
/* }}} */
|
|
|
|
/**
|
|
* This method is automatically called when the object is cloned.
|
|
* Specifically, this will ensure all child elements are also cloned.
|
|
*
|
|
* @return void
|
|
*/
|
|
function __clone() {
|
|
|
|
foreach ($this->parameters as $key => $child) {
|
|
$this->parameters[$key] = clone $child;
|
|
$this->parameters[$key]->parent = $this;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Validates the node for correctness.
|
|
*
|
|
* The following options are supported:
|
|
* - Node::REPAIR - If something is broken, and automatic repair may
|
|
* be attempted.
|
|
*
|
|
* An array is returned with warnings.
|
|
*
|
|
* Every item in the array has the following properties:
|
|
* * level - (number between 1 and 3 with severity information)
|
|
* * message - (human readable message)
|
|
* * node - (reference to the offending node)
|
|
*
|
|
* @param int $options
|
|
*
|
|
* @return array
|
|
*/
|
|
function validate($options = 0) {
|
|
|
|
$warnings = [];
|
|
|
|
// Checking if our value is UTF-8
|
|
if (!StringUtil::isUTF8($this->getRawMimeDirValue())) {
|
|
|
|
$oldValue = $this->getRawMimeDirValue();
|
|
$level = 3;
|
|
if ($options & self::REPAIR) {
|
|
$newValue = StringUtil::convertToUTF8($oldValue);
|
|
if (true || StringUtil::isUTF8($newValue)) {
|
|
$this->setRawMimeDirValue($newValue);
|
|
$level = 1;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
if (preg_match('%([\x00-\x08\x0B-\x0C\x0E-\x1F\x7F])%', $oldValue, $matches)) {
|
|
$message = 'Property contained a control character (0x' . bin2hex($matches[1]) . ')';
|
|
} else {
|
|
$message = 'Property is not valid UTF-8! ' . $oldValue;
|
|
}
|
|
|
|
$warnings[] = [
|
|
'level' => $level,
|
|
'message' => $message,
|
|
'node' => $this,
|
|
];
|
|
}
|
|
|
|
// Checking if the propertyname does not contain any invalid bytes.
|
|
if (!preg_match('/^([A-Z0-9-]+)$/', $this->name)) {
|
|
$warnings[] = [
|
|
'level' => $options & self::REPAIR ? 1 : 3,
|
|
'message' => 'The propertyname: ' . $this->name . ' contains invalid characters. Only A-Z, 0-9 and - are allowed',
|
|
'node' => $this,
|
|
];
|
|
if ($options & self::REPAIR) {
|
|
// Uppercasing and converting underscores to dashes.
|
|
$this->name = strtoupper(
|
|
str_replace('_', '-', $this->name)
|
|
);
|
|
// Removing every other invalid character
|
|
$this->name = preg_replace('/([^A-Z0-9-])/u', '', $this->name);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if ($encoding = $this->offsetGet('ENCODING')) {
|
|
|
|
if ($this->root->getDocumentType() === Document::VCARD40) {
|
|
$warnings[] = [
|
|
'level' => 3,
|
|
'message' => 'ENCODING parameter is not valid in vCard 4.',
|
|
'node' => $this
|
|
];
|
|
} else {
|
|
|
|
$encoding = (string)$encoding;
|
|
|
|
$allowedEncoding = [];
|
|
|
|
switch ($this->root->getDocumentType()) {
|
|
case Document::ICALENDAR20 :
|
|
$allowedEncoding = ['8BIT', 'BASE64'];
|
|
break;
|
|
case Document::VCARD21 :
|
|
$allowedEncoding = ['QUOTED-PRINTABLE', 'BASE64', '8BIT'];
|
|
break;
|
|
case Document::VCARD30 :
|
|
$allowedEncoding = ['B'];
|
|
break;
|
|
|
|
}
|
|
if ($allowedEncoding && !in_array(strtoupper($encoding), $allowedEncoding)) {
|
|
$warnings[] = [
|
|
'level' => 3,
|
|
'message' => 'ENCODING=' . strtoupper($encoding) . ' is not valid for this document type.',
|
|
'node' => $this
|
|
];
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
// Validating inner parameters
|
|
foreach ($this->parameters as $param) {
|
|
$warnings = array_merge($warnings, $param->validate($options));
|
|
}
|
|
|
|
return $warnings;
|
|
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function destroy() {
|
|
|
|
parent::destroy();
|
|
foreach ($this->parameters as $param) {
|
|
$param->destroy();
|
|
}
|
|
$this->parameters = [];
|
|
|
|
}
|
|
|
|
}
|