/** * @param object $object Zotero object (Zotero_Item, Zotero_Collection, Zotero_Search, Zotero_Setting) * @param object $json JSON object to check * @param array $requestParams * @param int $requireVersion If 0, don't require; if 1, require if there's * an object key property in the JSON; if 2, * always require */ public static function checkJSONObjectVersion($object, $json, $requestParams, $requireVersion) { $objectType = \Zotero\DataObjectUtilities::getTypeFromObject($object); if (!in_array($objectType, array('item', 'collection', 'search', 'setting'))) { throw new Exception("Invalid object type"); } $oldKeyProp = $objectType . "Key"; $oldVersionProp = $objectType == 'setting' ? 'version' : $objectType . "Version"; $newKeyProp = 'key'; $newVersionProp = 'version'; if ($requestParams['v'] >= 3) { $keyProp = $newKeyProp; $versionProp = $newVersionProp; // Disallow old properties if (isset($json->{$oldKeyProp})) { throw new Exception("'{$oldKeyProp}' property is now '" . $newKeyProp . "'", Z_ERROR_INVALID_INPUT); } else { if (isset($json->{$oldVersionProp}) && $oldVersionProp != $newVersionProp) { throw new Exception("'{$oldVersionProp}' property is now '" . $newVersionProp . "'", Z_ERROR_INVALID_INPUT); } } } else { $keyProp = $oldKeyProp; $versionProp = $oldVersionProp; // Disallow new properties if (isset($json->{$newKeyProp})) { throw new Exception("Invalid property '{$newKeyProp}'", Z_ERROR_INVALID_INPUT); } else { if (isset($json->{$newVersionProp}) && $oldVersionProp != $newVersionProp) { throw new Exception("Invalid property '{$newVersionProp}'", Z_ERROR_INVALID_INPUT); } } } if (isset($json->{$versionProp})) { if ($requestParams['v'] < 2) { throw new Exception("Invalid property '{$versionProp}'", Z_ERROR_INVALID_INPUT); } if (!is_numeric($json->{$versionProp})) { throw new Exception("'{$versionProp}' must be an integer", Z_ERROR_INVALID_INPUT); } if (!isset($json->{$keyProp}) && $objectType != 'setting' && !$object->key) { throw new Exception("'{$versionProp}' is valid only if {$objectType} key is provided", Z_ERROR_INVALID_INPUT); } $originalVersion = Zotero_Libraries::getOriginalVersion($object->libraryID); $updatedVersion = Zotero_Libraries::getUpdatedVersion($object->libraryID); // Make sure the object hasn't been modified since the specified version if ($object->version > $json->{$versionProp}) { // Unless it was modified in this request if ($updatedVersion != $originalVersion && $object->version == $updatedVersion) { return; } throw new HTTPException(ucwords($objectType) . " has been modified since specified version " . "(expected {$json->{$versionProp}}, found {$object->version})", 412); } else { if ($json->{$versionProp} > 0 && !$object->version) { throw new HTTPException(ucwords($objectType) . " doesn't exist (expected version {$json->{$versionProp}}; use 0 instead)", 404); } } } else { if ($requireVersion == 1 && isset($json->{$keyProp})) { if ($objectType == 'setting') { throw new HTTPException("Either If-Unmodified-Since-Version or " . "'{$versionProp}' property must be provided", 428); } else { throw new HTTPException("Either If-Unmodified-Since-Version or " . "'{$versionProp}' property must be provided for " . "'{$keyProp}'-based writes", 428); } } else { if ($requireVersion == 2) { throw new HTTPException("Either If-Unmodified-Since-Version or " . "'{$versionProp}' property must be provided for " . "single-{$objectType} writes", 428); } } } }