Skip to content

Remove bidirectional nature of related items #172

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+78 −41
Open

Remove bidirectional nature of related items #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 0 additions & 24 deletions model/Item.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5020,18 +5020,6 @@ protected function loadRelations($reload = false) {
return [$rel->predicate, $rel->object];
}, $relations);

// Related items are bidirectional, so include any with this item as the object
$reverseRelations = Zotero_Relations::getByURIs(
$this->libraryID, false, Zotero_Relations::$relatedItemPredicate, $itemURI
);
foreach ($reverseRelations as $rel) {
$r = [$rel->predicate, $rel->subject];
// Only add if not already added in other direction
if (!in_array($r, $relations)) {
$relations[] = $r;
}
}

// Also include any owl:sameAs relations with this item as the object
// (as sent by client via classic sync)
$reverseRelations = Zotero_Relations::getByURIs(
Expand All @@ -5055,18 +5043,6 @@ protected function loadRelations($reload = false) {
$relations[] = [$predicate, $prefix . $key];
}
}
// Reverse as well
$sql = "SELECT `key` FROM itemRelated IR JOIN items I USING (itemID) WHERE IR.linkedItemID=?";
$reverseRelatedItemKeys = Zotero_DB::columnQuery(
$sql, $this->id, Zotero_Shards::getByLibraryID($this->libraryID)
);
if ($reverseRelatedItemKeys) {
$prefix = Zotero_URI::getLibraryURI($this->libraryID) . "/items/";
$predicate = Zotero_Relations::$relatedItemPredicate;
foreach ($reverseRelatedItemKeys as $key) {
$relations[] = [$predicate, $prefix . $key];
}
}

$this->relations = $relations;
$this->loaded['relations'] = true;
Expand Down
23 changes: 15 additions & 8 deletions tests/remote/tests/API/2/RelationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,24 +102,30 @@ public function testRelatedItemRelations() {
$this->assertEquals($object, $json['relations'][$predicate]);
}

// And item 2, since related items are bidirectional
// It does not yet exist on item 2
$xml = API::getItemXML($item2JSON['itemKey']);
$data = API::parseDataFromAtomEntry($xml);
$item2JSON = json_decode($data['content'], true);
$this->assertCount(1, $item2JSON['relations']);
$this->assertEquals($item1URI, $item2JSON["relations"]["dc:relation"]);
$this->assertCount(0, $item2JSON['relations']);

// Sending item 2's unmodified JSON back up shouldn't cause the item to be updated.
// Even though we're sending a relation that's technically not part of the item,
// when it loads the item it will load the reverse relations too and therefore not
// add a relation that it thinks already exists.
// Update item 2
$relationsTwo["dc:relation"] = $item1URI;
$item2JSON["relations"] = $relationsTwo;
$response = API::userPut(
self::$config['userID'],
"items/{$item2JSON['itemKey']}?key=" . self::$config['apiKey'],
json_encode($item2JSON)
);
$this->assert204($response);
$this->assertEquals($item2JSON['itemVersion'], $response->getHeader("Last-Modified-Version"));

// It should now exist on item 2
$xml = API::getItemXML($item2JSON['itemKey']);
$data = API::parseDataFromAtomEntry($xml);
$json = json_decode($data['content'], true);
$this->assertCount(sizeOf($relationsTwo), $json['relations']);
foreach ($relationsTwo as $predicate => $object) {
$this->assertEquals($object, $json['relations'][$predicate]);
}
}


Expand All @@ -141,6 +147,7 @@ public function testRelatedItemRelationsSingleRequest() {
$item2JSON = API::getItemTemplate('book');
$item2JSON->itemKey = $item2Key;
$item2JSON->itemVersion = 0;
$item2JSON->relations->{'dc:relation'} = $item1URI;

$response = API::postItems([$item1JSON, $item2JSON]);
$this->assert200($response);
Expand Down
72 changes: 63 additions & 9 deletions tests/remote/tests/API/3/RelationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,22 +98,24 @@ public function testRelatedItemRelations() {
$this->assertEquals($object, $json['relations'][$predicate]);
}

// And item 2, since related items are bidirectional
// Relation does not yet exist on item 2
$item2JSON = API::getItem($item2JSON['key'], $this, 'json')['data'];
$this->assertCount(1, $item2JSON['relations']);
$this->assertEquals($item1URI, $item2JSON["relations"]["dc:relation"]);
$this->assertCount(0, $item2JSON['relations']);

// Sending item 2's unmodified JSON back up shouldn't cause the item to be updated.
// Even though we're sending a relation that's technically not part of the item,
// when it loads the item it will load the reverse relations too and therefore not
// add a relation that it thinks already exists.
// Update item 2
$relationsTwo["dc:relation"] = $item1URI;
$item2JSON["relations"] = $relationsTwo;
$response = API::userPut(
self::$config['userID'],
"items/{$item2JSON['key']}",
json_encode($item2JSON)
);
$this->assert204($response);
$this->assertEquals($item2JSON['version'], $response->getHeader("Last-Modified-Version"));

// Relation now exists on item 2
$item2JSON = API::getItem($item2JSON['key'], $this, 'json')['data'];
$this->assertCount(1, $item2JSON['relations']);
$this->assertEquals($item1URI, $item2JSON["relations"]["dc:relation"]);
}


Expand All @@ -134,6 +136,7 @@ public function testRelatedItemRelationsSingleRequest() {
$item2JSON = API::getItemTemplate('book');
$item2JSON->key = $item2Key;
$item2JSON->version = 0;
$item2JSON->relations->{'dc:relation'} = $item1URI;

$response = API::postItems([$item1JSON, $item2JSON]);
$this->assert200($response);
Expand All @@ -149,6 +152,57 @@ public function testRelatedItemRelationsSingleRequest() {
$this->assertCount(1, $json['relations']);
$this->assertEquals($item1URI, $json['relations']['dc:relation']);
}

public function testUnrelateTwoItems() {
$uriPrefix = "http://zotero.org/users/" . self::$config['userID'] . "/items/";

// Create two items related to one another
$item1JSON = API::createItem("book", null, $this, 'jsonData');
$item2JSON = API::createItem("book", null, $this, 'jsonData');

$item1JSON["relations"] = [
"dc:relation" => $uriPrefix . $item2JSON['key']
];
$item2JSON["relations"] = [
"dc:relation" => $uriPrefix . $item1JSON['key']
];
$response = API::userPut(
self::$config['userID'],
"items/{$item1JSON['key']}",
json_encode($item1JSON)
);
$this->assert204($response);

$item1JSON = API::getItem($item1JSON['key'], $this, 'json')['data'];
$item2JSON['version'] = $item1JSON['version'];
$response = API::userPut(
self::$config['userID'],
"items/{$item2JSON['key']}",
json_encode($item2JSON)
);
$t = $response->getBody();
$this->assert204($response);

// Remove relation from one of the items
$this->assertCount(1, $item1JSON['relations']);
$item1JSON['relations'] = [];
$item2JSON = API::getItem($item2JSON['key'], $this, 'json')['data'];
$item1JSON['version'] = $item2JSON['version'];
$response = API::userPut(
self::$config['userID'],
"items/{$item1JSON['key']}",
json_encode($item1JSON)
);

// Ensure it is gone from item 1
$this->assert204($response);
$item1JSON = API::getItem($item1JSON['key'], $this, 'json')['data'];
$this->assertCount(0, $item1JSON['relations']);

// But not yet removed from item 2
$item2JSON = API::getItem($item2JSON['key'], $this, 'json')['data'];
$this->assertCount(1, $item2JSON['relations']);
}


public function test_should_add_a_URL_to_a_relation_with_PATCH() {
Expand Down Expand Up @@ -254,7 +308,7 @@ public function testCircularItemRelations() {
];
$response = API::postItems([$item1Data, $item2Data]);
$this->assert200ForObject($response, false, 0);
$this->assertUnchangedForObject($response, 1);
$this->assert200ForObject($response, false, 1);
}


Expand Down