Skip to content

[stable9] Correctly handle multi-values when converting VCards to array #1208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rullzer merged 2 commits into from
Aug 31, 2016
Merged

[stable9] Correctly handle multi-values when converting VCards to array #1208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8adb48
Correctly handle multi-values when converting VCards to array
nickvergessen Aug 31, 2016
4bb1e42
Add a unit test for all the magic
nickvergessen Aug 31, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion apps/dav/lib/carddav/addressbookimpl.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use OCP\Constants;
use OCP\IAddressBook;
use Sabre\VObject\Component\VCard;
use Sabre\VObject\Property;
use Sabre\VObject\Property\Text;
use Sabre\VObject\Reader;
use Sabre\VObject\UUIDUtil;
Expand Down Expand Up @@ -214,12 +215,53 @@ protected function createEmptyVCard($uid) {
protected function vCard2Array(VCard $vCard) {
$result = [];
foreach ($vCard->children as $property) {
$result[$property->name] = $property->getValue();
/** @var \Sabre\VObject\Property\Unknown $property */
if ($property->name === 'X-SOCIALPROFILE') {
$type = $this->getTypeFromProperty($property);

// Type is the social network, when it's empty we don't need this.
if ($type !== null) {
if (!isset($result[$property->name])) {
$result[$property->name] = [];
}
$result[$property->name][$type] = $property->getValue();
}

// The following properties can be set multiple times
} else if (in_array($property->name, ['CLOUD', 'EMAIL', 'IMPP', 'TEL', 'URL'])) {
if (!isset($result[$property->name])) {
$result[$property->name] = [];
}

$result[$property->name][] = $property->getValue();

} else {
$result[$property->name] = $property->getValue();
}
}

if ($this->addressBookInfo['principaluri'] === 'principals/system/system' &&
$this->addressBookInfo['uri'] === 'system') {
$result['isLocalSystemBook'] = true;
}
return $result;
}

/**
* Get the type of the current property
*
* @param Property $property
* @return null|string
*/
protected function getTypeFromProperty(Property $property) {
$parameters = $property->parameters();
// Type is the social network, when it's empty we don't need this.
if (isset($parameters['TYPE'])) {
/** @var \Sabre\VObject\Parameter $type */
$type = $parameters['TYPE'];
return $type->getValue();
}

return null;
}
}
65 changes: 64 additions & 1 deletion apps/dav/tests/unit/carddav/addressbookimpltest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ public function setUp() {

$this->addressBookInfo = [
'id' => 42,
'{DAV:}displayname' => 'display name'
'uri' => 'system',
'principaluri' => 'principals/system/system',
'{DAV:}displayname' => 'display name',
];
$this->addressBook = $this->getMockBuilder('OCA\DAV\CardDAV\AddressBook')
->disableOriginalConstructor()->getMock();
Expand Down Expand Up @@ -286,4 +288,65 @@ public function testCreateEmptyVCard() {
$this->assertSame($expectedVCardSerialized, $resultSerialized);
}


public function testVCard2Array() {
$vCard = new VCard();

$vCard->add($vCard->createProperty('FN', 'Full Name'));

// Multi-value properties
$vCard->add($vCard->createProperty('CLOUD', 'cloud-user1@localhost'));
$vCard->add($vCard->createProperty('CLOUD', '[email protected]'));
$vCard->add($vCard->createProperty('EMAIL', 'email-user1@localhost'));
$vCard->add($vCard->createProperty('EMAIL', '[email protected]'));
$vCard->add($vCard->createProperty('IMPP', 'impp-user1@localhost'));
$vCard->add($vCard->createProperty('IMPP', '[email protected]'));
$vCard->add($vCard->createProperty('TEL', '+49 123456789'));
$vCard->add($vCard->createProperty('TEL', '+1 555 123456789'));
$vCard->add($vCard->createProperty('URL', 'https://localhost'));
$vCard->add($vCard->createProperty('URL', 'https://example.tld'));

// Type depending properties
$property = $vCard->createProperty('X-SOCIALPROFILE', 'tw-example');
$property->add('TYPE', 'twitter');
$vCard->add($property);
$property = $vCard->createProperty('X-SOCIALPROFILE', 'fb-example');
$property->add('TYPE', 'facebook');
$vCard->add($property);

$array = $this->invokePrivate($this->addressBookImpl, 'vCard2Array', [$vCard]);
unset($array['PRODID']);

$this->assertEquals([
'VERSION' => '3.0',
'FN' => 'Full Name',
'CLOUD' => [
'cloud-user1@localhost',
'[email protected]',
],
'EMAIL' => [
'email-user1@localhost',
'[email protected]',
],
'IMPP' => [
'impp-user1@localhost',
'[email protected]',
],
'TEL' => [
'+49 123456789',
'+1 555 123456789',
],
'URL' => [
'https://localhost',
'https://example.tld',
],

'X-SOCIALPROFILE' => [
'twitter'=> 'tw-example',
'facebook'=> 'fb-example',
],

'isLocalSystemBook' => true,
], $array);
}
}