diff options
Diffstat (limited to 'vendor/sabre/vobject/lib/VCardConverter.php')
| -rw-r--r-- | vendor/sabre/vobject/lib/VCardConverter.php | 184 |
1 files changed, 113 insertions, 71 deletions
diff --git a/vendor/sabre/vobject/lib/VCardConverter.php b/vendor/sabre/vobject/lib/VCardConverter.php index 156b83b4e..1f6d016f1 100644 --- a/vendor/sabre/vobject/lib/VCardConverter.php +++ b/vendor/sabre/vobject/lib/VCardConverter.php @@ -9,8 +9,8 @@ namespace Sabre\VObject; * @author Evert Pot (http://evertpot.com/) * @license http://sabre.io/license/ Modified BSD License */ -class VCardConverter -{ +class VCardConverter { + /** * Converts a vCard object to a new version. * @@ -27,10 +27,10 @@ class VCardConverter * If input and output version are identical, a clone is returned. * * @param Component\VCard $input - * @param int $targetVersion + * @param int $targetVersion */ - public function convert(Component\VCard $input, $targetVersion) - { + function convert(Component\VCard $input, $targetVersion) { + $inputVersion = $input->getDocumentType(); if ($inputVersion === $targetVersion) { return clone $input; @@ -43,7 +43,7 @@ class VCardConverter throw new \InvalidArgumentException('You can only use vCard 3.0 or 4.0 for the target version'); } - $newVersion = Document::VCARD40 === $targetVersion ? '4.0' : '3.0'; + $newVersion = $targetVersion === Document::VCARD40 ? '4.0' : '3.0'; $output = new Component\VCard([ 'VERSION' => $newVersion, @@ -53,10 +53,13 @@ class VCardConverter unset($output->UID); foreach ($input->children() as $property) { + $this->convertProperty($input, $output, $property, $targetVersion); + } return $output; + } /** @@ -64,11 +67,13 @@ class VCardConverter * * @param Component\VCard $input * @param Component\VCard $output - * @param Property $property - * @param int $targetVersion + * @param Property $property + * @param int $targetVersion + * + * @return void */ - protected function convertProperty(Component\VCard $input, Component\VCard $output, Property $property, $targetVersion) - { + protected function convertProperty(Component\VCard $input, Component\VCard $output, Property $property, $targetVersion) { + // Skipping these, those are automatically added. if (in_array($property->name, ['VERSION', 'PRODID'])) { return; @@ -90,10 +95,15 @@ class VCardConverter $valueType ); - if (Document::VCARD30 === $targetVersion) { + + if ($targetVersion === Document::VCARD30) { + if ($property instanceof Property\Uri && in_array($property->name, ['PHOTO', 'LOGO', 'SOUND'])) { + $newProperty = $this->convertUriToBinary($output, $newProperty); + } elseif ($property instanceof Property\VCard\DateAndOrTime) { + // In vCard 4, the birth year may be optional. This is not the // case for vCard 3. Apple has a workaround for this that // allows applications that support Apple's extension still @@ -103,12 +113,12 @@ class VCardConverter // uses. $parts = DateTimeParser::parseVCardDateTime($property->getValue()); if (is_null($parts['year'])) { - $newValue = '1604-'.$parts['month'].'-'.$parts['date']; + $newValue = '1604-' . $parts['month'] . '-' . $parts['date']; $newProperty->setValue($newValue); $newProperty['X-APPLE-OMIT-YEAR'] = '1604'; } - if ('ANNIVERSARY' == $newProperty->name) { + if ($newProperty->name == 'ANNIVERSARY') { // Microsoft non-standard anniversary $newProperty->name = 'X-ANNIVERSARY'; @@ -117,64 +127,74 @@ class VCardConverter // group, so we first need to find a groupname that doesn't // exist yet. $x = 1; - while ($output->select('ITEM'.$x.'.')) { - ++$x; + while ($output->select('ITEM' . $x . '.')) { + $x++; } - $output->add('ITEM'.$x.'.X-ABDATE', $newProperty->getValue(), ['VALUE' => 'DATE-AND-OR-TIME']); - $output->add('ITEM'.$x.'.X-ABLABEL', '_$!<Anniversary>!$_'); + $output->add('ITEM' . $x . '.X-ABDATE', $newProperty->getValue(), ['VALUE' => 'DATE-AND-OR-TIME']); + $output->add('ITEM' . $x . '.X-ABLABEL', '_$!<Anniversary>!$_'); } - } elseif ('KIND' === $property->name) { + + } elseif ($property->name === 'KIND') { + switch (strtolower($property->getValue())) { - case 'org': + case 'org' : // vCard 3.0 does not have an equivalent to KIND:ORG, // but apple has an extension that means the same // thing. $newProperty = $output->createProperty('X-ABSHOWAS', 'COMPANY'); break; - case 'individual': + case 'individual' : // Individual is implicit, so we skip it. return; - case 'group': + case 'group' : // OS X addressbook property $newProperty = $output->createProperty('X-ADDRESSBOOKSERVER-KIND', 'GROUP'); break; } + + } - } elseif (Document::VCARD40 === $targetVersion) { + + } elseif ($targetVersion === Document::VCARD40) { + // These properties were removed in vCard 4.0 if (in_array($property->name, ['NAME', 'MAILER', 'LABEL', 'CLASS'])) { return; } if ($property instanceof Property\Binary) { + $newProperty = $this->convertBinaryToUri($output, $newProperty, $parameters); + } elseif ($property instanceof Property\VCard\DateAndOrTime && isset($parameters['X-APPLE-OMIT-YEAR'])) { + // If a property such as BDAY contained 'X-APPLE-OMIT-YEAR', // then we're stripping the year from the vcard 4 value. $parts = DateTimeParser::parseVCardDateTime($property->getValue()); if ($parts['year'] === $property['X-APPLE-OMIT-YEAR']->getValue()) { - $newValue = '--'.$parts['month'].'-'.$parts['date']; + $newValue = '--' . $parts['month'] . '-' . $parts['date']; $newProperty->setValue($newValue); } // Regardless if the year matched or not, we do need to strip // X-APPLE-OMIT-YEAR. unset($parameters['X-APPLE-OMIT-YEAR']); + } switch ($property->name) { - case 'X-ABSHOWAS': - if ('COMPANY' === strtoupper($property->getValue())) { + case 'X-ABSHOWAS' : + if (strtoupper($property->getValue()) === 'COMPANY') { $newProperty = $output->createProperty('KIND', 'ORG'); } break; - case 'X-ADDRESSBOOKSERVER-KIND': - if ('GROUP' === strtoupper($property->getValue())) { + case 'X-ADDRESSBOOKSERVER-KIND' : + if (strtoupper($property->getValue()) === 'GROUP') { $newProperty = $output->createProperty('KIND', 'GROUP'); } break; - case 'X-ANNIVERSARY': + case 'X-ANNIVERSARY' : $newProperty->name = 'ANNIVERSARY'; // If we already have an anniversary property with the same // value, ignore. @@ -184,15 +204,15 @@ class VCardConverter } } break; - case 'X-ABDATE': + case 'X-ABDATE' : // Find out what the label was, if it exists. if (!$property->group) { break; } - $label = $input->{$property->group.'.X-ABLABEL'}; + $label = $input->{$property->group . '.X-ABLABEL'}; // We only support converting anniversaries. - if (!$label || '_$!<Anniversary>!$_' !== $label->getValue()) { + if (!$label || $label->getValue() !== '_$!<Anniversary>!$_') { break; } @@ -206,20 +226,22 @@ class VCardConverter $newProperty->name = 'ANNIVERSARY'; break; // Apple's per-property label system. - case 'X-ABLABEL': - if ('_$!<Anniversary>!$_' === $newProperty->getValue()) { + case 'X-ABLABEL' : + if ($newProperty->getValue() === '_$!<Anniversary>!$_') { // We can safely remove these, as they are converted to // ANNIVERSARY properties. return; } break; + } + } // set property group $newProperty->group = $property->group; - if (Document::VCARD40 === $targetVersion) { + if ($targetVersion === Document::VCARD40) { $this->convertParameters40($newProperty, $parameters); } else { $this->convertParameters30($newProperty, $parameters); @@ -235,6 +257,8 @@ class VCardConverter } $output->add($newProperty); + + } /** @@ -243,14 +267,14 @@ class VCardConverter * vCard 4.0 no longer supports BINARY properties. * * @param Component\VCard $output - * @param Property\Uri $property the input property - * @param $parameters list of parameters that will eventually be added to - * the new property + * @param Property\Uri $property The input property. + * @param $parameters List of parameters that will eventually be added to + * the new property. * * @return Property\Uri */ - protected function convertBinaryToUri(Component\VCard $output, Property\Binary $newProperty, array &$parameters) - { + protected function convertBinaryToUri(Component\VCard $output, Property\Binary $newProperty, array &$parameters) { + $value = $newProperty->getValue(); $newProperty = $output->createProperty( $newProperty->name, @@ -263,13 +287,14 @@ class VCardConverter // See if we can find a better mimetype. if (isset($parameters['TYPE'])) { + $newTypes = []; foreach ($parameters['TYPE']->getParts() as $typePart) { if (in_array( strtoupper($typePart), ['JPEG', 'PNG', 'GIF'] )) { - $mimeType = 'image/'.strtolower($typePart); + $mimeType = 'image/' . strtolower($typePart); } else { $newTypes[] = $typePart; } @@ -282,11 +307,12 @@ class VCardConverter } else { unset($parameters['TYPE']); } - } - $newProperty->setValue('data:'.$mimeType.';base64,'.base64_encode($value)); + } + $newProperty->setValue('data:' . $mimeType . ';base64,' . base64_encode($value)); return $newProperty; + } /** @@ -297,16 +323,16 @@ class VCardConverter * possible, to improve compatibility. * * @param Component\VCard $output - * @param Property\Uri $property the input property + * @param Property\Uri $property The input property. * * @return Property\Binary|null */ - protected function convertUriToBinary(Component\VCard $output, Property\Uri $newProperty) - { + protected function convertUriToBinary(Component\VCard $output, Property\Uri $newProperty) { + $value = $newProperty->getValue(); // Only converting data: uris - if ('data:' !== substr($value, 0, 5)) { + if (substr($value, 0, 5) !== 'data:') { return $newProperty; } @@ -328,79 +354,92 @@ class VCardConverter $newProperty['ENCODING'] = 'b'; switch ($mimeType) { - case 'image/jpeg': + + case 'image/jpeg' : $newProperty['TYPE'] = 'JPEG'; break; - case 'image/png': + case 'image/png' : $newProperty['TYPE'] = 'PNG'; break; - case 'image/gif': + case 'image/gif' : $newProperty['TYPE'] = 'GIF'; break; + } + return $newProperty; + } /** * Adds parameters to a new property for vCard 4.0. * * @param Property $newProperty - * @param array $parameters + * @param array $parameters + * + * @return void */ - protected function convertParameters40(Property $newProperty, array $parameters) - { + protected function convertParameters40(Property $newProperty, array $parameters) { + // Adding all parameters. foreach ($parameters as $param) { + // vCard 2.1 allowed parameters with no name - if ($param->noName) { - $param->noName = false; - } + if ($param->noName) $param->noName = false; switch ($param->name) { + // We need to see if there's any TYPE=PREF, because in vCard 4 // that's now PREF=1. - case 'TYPE': + case 'TYPE' : foreach ($param->getParts() as $paramPart) { - if ('PREF' === strtoupper($paramPart)) { + + if (strtoupper($paramPart) === 'PREF') { $newProperty->add('PREF', '1'); } else { $newProperty->add($param->name, $paramPart); } + } break; // These no longer exist in vCard 4 - case 'ENCODING': - case 'CHARSET': + case 'ENCODING' : + case 'CHARSET' : break; - default: + default : $newProperty->add($param->name, $param->getParts()); break; + } + } + } /** * Adds parameters to a new property for vCard 3.0. * * @param Property $newProperty - * @param array $parameters + * @param array $parameters + * + * @return void */ - protected function convertParameters30(Property $newProperty, array $parameters) - { + protected function convertParameters30(Property $newProperty, array $parameters) { + // Adding all parameters. foreach ($parameters as $param) { + // vCard 2.1 allowed parameters with no name - if ($param->noName) { - $param->noName = false; - } + if ($param->noName) $param->noName = false; switch ($param->name) { - case 'ENCODING': + + case 'ENCODING' : // This value only existed in vCard 2.1, and should be // removed for anything else. - if ('QUOTED-PRINTABLE' !== strtoupper($param->getValue())) { + if (strtoupper($param->getValue()) !== 'QUOTED-PRINTABLE') { $newProperty->add($param->name, $param->getParts()); } break; @@ -410,16 +449,19 @@ class VCardConverter * * Any other PREF numbers we'll drop. */ - case 'PREF': - if ('1' == $param->getValue()) { + case 'PREF' : + if ($param->getValue() == '1') { $newProperty->add('TYPE', 'PREF'); } break; - default: + default : $newProperty->add($param->name, $param->getParts()); break; + } + } + } } |