private static function validateJSONItem($json, $libraryID, Zotero_Item $item = null, $isChild, $requestParams, $partialUpdate = false)
{
$isNew = !$item || !$item->version;
if (!is_object($json)) {
throw new Exception("Invalid item object (found " . gettype($json) . " '" . $json . "')", Z_ERROR_INVALID_INPUT);
}
if (isset($json->items) && is_array($json->items)) {
throw new Exception("An 'items' array is not valid for single-item updates", Z_ERROR_INVALID_INPUT);
}
$apiVersion = $requestParams['v'];
if ($partialUpdate) {
$requiredProps = [];
} else {
if (isset($json->itemType) && $json->itemType == "attachment") {
$requiredProps = array('linkMode', 'tags');
} else {
if (isset($json->itemType) && $json->itemType == "attachment") {
$requiredProps = array('tags');
} else {
if ($isNew) {
$requiredProps = array('itemType');
} else {
if ($apiVersion < 2) {
$requiredProps = array('itemType', 'tags');
} else {
$requiredProps = array('itemType', 'tags', 'relations');
if (!$isChild) {
$requiredProps[] = 'collections';
}
}
}
}
}
}
foreach ($requiredProps as $prop) {
if (!isset($json->{$prop})) {
throw new Exception("'{$prop}' property not provided", Z_ERROR_INVALID_INPUT);
}
}
// For partial updates where item type isn't provided, use the existing item type
if (!isset($json->itemType) && $partialUpdate) {
$itemType = Zotero_ItemTypes::getName($item->itemTypeID);
} else {
$itemType = $json->itemType;
}
foreach ($json as $key => $val) {
switch ($key) {
// Handled by Zotero_API::checkJSONObjectVersion()
case 'key':
case 'version':
if ($apiVersion < 3) {
throw new Exception("Invalid property '{$key}'", Z_ERROR_INVALID_INPUT);
}
break;
case 'itemKey':
case 'itemVersion':
if ($apiVersion != 2) {
throw new Exception("Invalid property '{$key}'", Z_ERROR_INVALID_INPUT);
}
break;
case 'parentItem':
if ($apiVersion < 2) {
throw new Exception("Invalid property '{$key}'", Z_ERROR_INVALID_INPUT);
}
if (!Zotero_ID::isValidKey($val) && $val !== false) {
throw new Exception("'{$key}' must be a valid item key", Z_ERROR_INVALID_INPUT);
}
break;
case 'itemType':
if (!is_string($val)) {
throw new Exception("'itemType' must be a string", Z_ERROR_INVALID_INPUT);
}
if ($isChild || !empty($json->parentItem)) {
switch ($val) {
case 'note':
case 'attachment':
break;
default:
throw new Exception("Child item must be note or attachment", Z_ERROR_INVALID_INPUT);
}
} else {
if ($val == 'attachment' && (!$item || !$item->getSource())) {
if ($json->linkMode == 'linked_url' || $json->linkMode == 'imported_url' && (empty($json->contentType) || $json->contentType != 'application/pdf')) {
throw new Exception("Only file attachments and PDFs can be top-level items", Z_ERROR_INVALID_INPUT);
}
}
}
if (!Zotero_ItemTypes::getID($val)) {
throw new Exception("'{$val}' is not a valid itemType", Z_ERROR_INVALID_INPUT);
}
break;
case 'tags':
if (!is_array($val)) {
throw new Exception("'{$key}' property must be an array", Z_ERROR_INVALID_INPUT);
}
foreach ($val as $tag) {
$empty = true;
if (is_string($tag)) {
if ($tag === "") {
throw new Exception("Tag cannot be empty", Z_ERROR_INVALID_INPUT);
}
continue;
}
if (!is_object($tag)) {
throw new Exception("Tag must be an object", Z_ERROR_INVALID_INPUT);
}
foreach ($tag as $k => $v) {
switch ($k) {
case 'tag':
if (!is_scalar($v)) {
throw new Exception("Invalid tag name", Z_ERROR_INVALID_INPUT);
}
if ($v === "") {
throw new Exception("Tag cannot be empty", Z_ERROR_INVALID_INPUT);
}
break;
case 'type':
if (!is_numeric($v)) {
throw new Exception("Invalid tag type '{$v}'", Z_ERROR_INVALID_INPUT);
}
break;
default:
throw new Exception("Invalid tag property '{$k}'", Z_ERROR_INVALID_INPUT);
}
$empty = false;
}
if ($empty) {
throw new Exception("Tag object is empty", Z_ERROR_INVALID_INPUT);
}
}
break;
case 'collections':
if (!is_array($val)) {
throw new Exception("'{$key}' property must be an array", Z_ERROR_INVALID_INPUT);
}
if ($isChild && $val) {
throw new Exception("Child items cannot be assigned to collections", Z_ERROR_INVALID_INPUT);
}
foreach ($val as $k) {
if (!Zotero_ID::isValidKey($k)) {
throw new Exception("'{$k}' is not a valid collection key", Z_ERROR_INVALID_INPUT);
}
}
break;
case 'relations':
if ($apiVersion < 2) {
throw new Exception("Invalid property '{$key}'", Z_ERROR_INVALID_INPUT);
}
if (!is_object($val) && !(is_array($val) && empty($val))) {
throw new Exception("'{$key}' property must be an object", Z_ERROR_INVALID_INPUT);
}
foreach ($val as $predicate => $object) {
switch ($predicate) {
case 'owl:sameAs':
case 'dc:replaces':
case 'dc:relation':
break;
default:
throw new Exception("Unsupported predicate '{$predicate}'", Z_ERROR_INVALID_INPUT);
}
$arr = is_string($object) ? [$object] : $object;
foreach ($arr as $uri) {
if (!preg_match('/^http:\\/\\/zotero.org\\/(users|groups)\\/[0-9]+\\/(publications\\/)?items\\/[A-Z0-9]{8}$/', $uri)) {
throw new Exception("'{$key}' values currently must be Zotero item URIs", Z_ERROR_INVALID_INPUT);
}
}
}
break;
case 'creators':
if (!is_array($val)) {
throw new Exception("'{$key}' property must be an array", Z_ERROR_INVALID_INPUT);
}
foreach ($val as $creator) {
$empty = true;
if (!isset($creator->creatorType)) {
throw new Exception("creator object must contain 'creatorType'", Z_ERROR_INVALID_INPUT);
}
if ((!isset($creator->name) || trim($creator->name) == "") && (!isset($creator->firstName) || trim($creator->firstName) == "") && (!isset($creator->lastName) || trim($creator->lastName) == "")) {
// On item creation, ignore single nameless creator,
// because that's in the item template that the API returns
if (sizeOf($val) == 1 && $isNew) {
continue;
} else {
throw new Exception("creator object must contain 'firstName'/'lastName' or 'name'", Z_ERROR_INVALID_INPUT);
}
}
foreach ($creator as $k => $v) {
switch ($k) {
case 'creatorType':
$creatorTypeID = Zotero_CreatorTypes::getID($v);
if (!$creatorTypeID) {
throw new Exception("'{$v}' is not a valid creator type", Z_ERROR_INVALID_INPUT);
}
$itemTypeID = Zotero_ItemTypes::getID($itemType);
if (!Zotero_CreatorTypes::isValidForItemType($creatorTypeID, $itemTypeID)) {
// Allow 'author' in all item types, but reject other invalid creator types
if ($creatorTypeID != Zotero_CreatorTypes::getID('author')) {
throw new Exception("'{$v}' is not a valid creator type for item type '{$itemType}'", Z_ERROR_INVALID_INPUT);
}
}
break;
case 'firstName':
if (!isset($creator->lastName)) {
throw new Exception("'lastName' creator field must be set if 'firstName' is set", Z_ERROR_INVALID_INPUT);
}
if (isset($creator->name)) {
throw new Exception("'firstName' and 'name' creator fields are mutually exclusive", Z_ERROR_INVALID_INPUT);
}
break;
case 'lastName':
if (!isset($creator->firstName)) {
throw new Exception("'firstName' creator field must be set if 'lastName' is set", Z_ERROR_INVALID_INPUT);
}
if (isset($creator->name)) {
throw new Exception("'lastName' and 'name' creator fields are mutually exclusive", Z_ERROR_INVALID_INPUT);
}
break;
case 'name':
if (isset($creator->firstName)) {
throw new Exception("'firstName' and 'name' creator fields are mutually exclusive", Z_ERROR_INVALID_INPUT);
}
if (isset($creator->lastName)) {
throw new Exception("'lastName' and 'name' creator fields are mutually exclusive", Z_ERROR_INVALID_INPUT);
}
break;
default:
throw new Exception("Invalid creator property '{$k}'", Z_ERROR_INVALID_INPUT);
}
$empty = false;
}
if ($empty) {
throw new Exception("Creator object is empty", Z_ERROR_INVALID_INPUT);
}
}
break;
case 'note':
switch ($itemType) {
case 'note':
case 'attachment':
break;
default:
throw new Exception("'note' property is valid only for note and attachment items", Z_ERROR_INVALID_INPUT);
}
break;
case 'attachments':
case 'notes':
if ($apiVersion > 1) {
throw new Exception("'{$key}' property is no longer supported", Z_ERROR_INVALID_INPUT);
}
if (!$isNew) {
throw new Exception("'{$key}' property is valid only for new items", Z_ERROR_INVALID_INPUT);
}
if (!is_array($val)) {
throw new Exception("'{$key}' property must be an array", Z_ERROR_INVALID_INPUT);
}
foreach ($val as $child) {
// Check child item type ('attachment' or 'note')
$t = substr($key, 0, -1);
if (isset($child->itemType) && $child->itemType != $t) {
throw new Exception("Child {$t} must be of itemType '{$t}'", Z_ERROR_INVALID_INPUT);
}
if ($key == 'note') {
if (!isset($child->note)) {
throw new Exception("'note' property not provided for child note", Z_ERROR_INVALID_INPUT);
}
}
}
break;
case 'deleted':
break;
// Attachment properties
// Attachment properties
case 'linkMode':
try {
$linkMode = Zotero_Attachments::linkModeNameToNumber($val, true);
} catch (Exception $e) {
throw new Exception("'{$val}' is not a valid linkMode", Z_ERROR_INVALID_INPUT);
}
// Don't allow changing of linkMode
if (!$isNew && $linkMode != $item->attachmentLinkMode) {
throw new Exception("Cannot change attachment linkMode", Z_ERROR_INVALID_INPUT);
}
break;
case 'contentType':
case 'charset':
case 'filename':
case 'md5':
case 'mtime':
if ($itemType != 'attachment') {
throw new Exception("'{$key}' is valid only for attachment items", Z_ERROR_INVALID_INPUT);
}
switch ($key) {
case 'filename':
case 'md5':
case 'mtime':
$lm = isset($json->linkMode) ? $json->linkMode : Zotero_Attachments::linkModeNumberToName($item->attachmentLinkMode);
if (strpos(strtolower($lm), 'imported_') !== 0) {
throw new Exception("'{$key}' is valid only for imported attachment items", Z_ERROR_INVALID_INPUT);
}
break;
}
switch ($key) {
case 'contentType':
case 'charset':
case 'filename':
$propName = 'attachment' . ucwords($key);
break;
case 'md5':
$propName = 'attachmentStorageHash';
break;
case 'mtime':
$propName = 'attachmentStorageModTime';
break;
}
if (Zotero_Libraries::getType($libraryID) == 'group') {
if ($item && $item->{$propName} !== $val || !$item && $val !== null && $val !== "") {
throw new Exception("Cannot change '{$key}' directly in group library", Z_ERROR_INVALID_INPUT);
}
} else {
if ($key == 'md5') {
if ($val && !preg_match("/^[a-f0-9]{32}\$/", $val)) {
throw new Exception("'{$val}' is not a valid MD5 hash", Z_ERROR_INVALID_INPUT);
}
}
}
break;
case 'accessDate':
if ($apiVersion >= 3 && $val !== '' && $val != 'CURRENT_TIMESTAMP' && !Zotero_Date::isSQLDate($val) && !Zotero_Date::isSQLDateTime($val) && !Zotero_Date::isISO8601($val)) {
throw new Exception("'{$key}' must be in ISO 8601 or UTC 'YYYY-MM-DD[ hh-mm-dd]' format or 'CURRENT_TIMESTAMP' ({$val})", Z_ERROR_INVALID_INPUT);
}
break;
case 'dateAdded':
if (!Zotero_Date::isSQLDateTime($val) && !Zotero_Date::isISO8601($val)) {
throw new Exception("'{$key}' must be in ISO 8601 or UTC 'YYYY-MM-DD hh-mm-dd' format", Z_ERROR_INVALID_INPUT);
}
if (!$isNew) {
// Convert ISO date to SQL date for equality comparison
if (Zotero_Date::isISO8601($val)) {
$val = Zotero_Date::iso8601ToSQL($val);
}
if ($val != $item->{$key}) {
throw new Exception("'{$key}' cannot be modified for existing items", Z_ERROR_INVALID_INPUT);
}
}
break;
case 'dateModified':
if (!Zotero_Date::isSQLDateTime($val) && !Zotero_Date::isISO8601($val)) {
throw new Exception("'{$key}' must be in ISO 8601 or UTC 'YYYY-MM-DD hh-mm-dd' format ({$val})", Z_ERROR_INVALID_INPUT);
}
break;
default:
if (!Zotero_ItemFields::getID($key)) {
throw new Exception("Invalid property '{$key}'", Z_ERROR_INVALID_INPUT);
}
if (is_array($val)) {
throw new Exception("Unexpected array for property '{$key}'", Z_ERROR_INVALID_INPUT);
}
break;
}
}
// Publications libraries have additional restrictions
if (Zotero_Libraries::getType($libraryID) == 'publications') {
Zotero_Publications::validateJSONItem($json);
}
}
public function toJSON($asArray = false, $prettyPrint = false, $includeEmpty = false, $unformattedFields = false)
{
if ($this->id || $this->key) {
if (!$this->loaded['primaryData']) {
$this->loadPrimaryData(true);
}
if (!$this->loaded['itemData']) {
$this->loadItemData();
}
}
$regularItem = $this->isRegularItem();
$arr = array();
$arr['itemType'] = Zotero_ItemTypes::getName($this->itemTypeID);
if ($this->isAttachment()) {
$val = $this->attachmentLinkMode;
$arr['linkMode'] = strtolower(Zotero_Attachments::linkModeNumberToName($val));
}
// For regular items, show title and creators first
if ($regularItem) {
// Get 'title' or the equivalent base-mapped field
$titleFieldID = Zotero_ItemFields::getFieldIDFromTypeAndBase($this->itemTypeID, 'title');
$titleFieldName = Zotero_ItemFields::getName($titleFieldID);
if ($includeEmpty || $this->itemData[$titleFieldID] !== false) {
$arr[$titleFieldName] = $this->itemData[$titleFieldID] !== false ? $this->itemData[$titleFieldID] : "";
}
// Creators
$arr['creators'] = array();
$creators = $this->getCreators();
foreach ($creators as $creator) {
$c = array();
$c['creatorType'] = Zotero_CreatorTypes::getName($creator['creatorTypeID']);
// Single-field mode
if ($creator['ref']->fieldMode == 1) {
$c['name'] = $creator['ref']->lastName;
} else {
$c['firstName'] = $creator['ref']->firstName;
$c['lastName'] = $creator['ref']->lastName;
}
$arr['creators'][] = $c;
}
if (!$arr['creators'] && !$includeEmpty) {
unset($arr['creators']);
}
} else {
$titleFieldID = false;
}
// Item metadata
$fields = array_keys($this->itemData);
foreach ($fields as $field) {
if ($field == $titleFieldID) {
continue;
}
if ($unformattedFields) {
$value = $this->itemData[$field];
} else {
$value = $this->getField($field);
}
if (!$includeEmpty && ($value === false || $value === "")) {
continue;
}
$arr[Zotero_ItemFields::getName($field)] = $value ? $value : "";
}
// Embedded note for notes and attachments
if (!$regularItem) {
// Use sanitized version
$arr['note'] = $this->getNote(true);
}
if ($this->isAttachment()) {
$val = $this->attachmentLinkMode;
$arr['linkMode'] = strtolower(Zotero_Attachments::linkModeNumberToName($val));
$val = $this->attachmentMIMEType;
if ($includeEmpty || $val !== false && $val !== "") {
$arr['contentType'] = $val;
}
$val = $this->attachmentCharset;
if ($includeEmpty || $val !== false && $val !== "") {
$arr['charset'] = $val;
}
if ($this->isImportedAttachment()) {
$arr['filename'] = $this->attachmentFilename;
$val = $this->attachmentStorageHash;
if ($includeEmpty || $val) {
$arr['md5'] = $val;
}
$val = $this->attachmentStorageModTime;
if ($includeEmpty || $val) {
$arr['mtime'] = $val;
}
}
}
if ($this->getDeleted()) {
$arr['deleted'] = 1;
}
// Tags
$arr['tags'] = array();
$tags = $this->getTags();
if ($tags) {
foreach ($tags as $tag) {
$t = array('tag' => $tag->name);
if ($tag->type != 0) {
$t['type'] = $tag->type;
}
$arr['tags'][] = $t;
}
}
if ($asArray) {
return $arr;
}
$mask = JSON_HEX_TAG | JSON_HEX_AMP;
if ($prettyPrint) {
$json = Zotero_Utilities::json_encode_pretty($arr, $mask);
} else {
$json = json_encode($arr, $mask);
}
// Until JSON_UNESCAPED_SLASHES is available
$json = str_replace('\\/', '/', $json);
return $json;
}
public function toJSON($asArray=false, $requestParams=array(), $includeEmpty=false, $unformattedFields=false) {
if ($this->id || $this->key) {
if (!$this->loaded['primaryData']) {
$this->loadPrimaryData();
}
if (!$this->loaded['itemData']) {
$this->loadItemData();
}
}
if (!isset($requestParams['v'])) {
$requestParams['v'] = 3;
}
$regularItem = $this->isRegularItem();
$arr = array();
if ($requestParams['v'] >= 2) {
if ($requestParams['v'] >= 3) {
$arr['key'] = $this->key;
$arr['version'] = $this->version;
}
else {
$arr['itemKey'] = $this->key;
$arr['itemVersion'] = $this->version;
}
$key = $this->getSourceKey();
if ($key) {
$arr['parentItem'] = $key;
}
}
$arr['itemType'] = Zotero_ItemTypes::getName($this->itemTypeID);
if ($this->isAttachment()) {
$val = $this->attachmentLinkMode;
$arr['linkMode'] = strtolower(Zotero_Attachments::linkModeNumberToName($val));
}
// For regular items, show title and creators first
if ($regularItem) {
// Get 'title' or the equivalent base-mapped field
$titleFieldID = Zotero_ItemFields::getFieldIDFromTypeAndBase($this->itemTypeID, 'title');
$titleFieldName = Zotero_ItemFields::getName($titleFieldID);
if ($includeEmpty || $this->itemData[$titleFieldID] !== false) {
$arr[$titleFieldName] = $this->itemData[$titleFieldID] !== false ? $this->itemData[$titleFieldID] : "";
}
// Creators
$arr['creators'] = array();
$creators = $this->getCreators();
foreach ($creators as $creator) {
$c = array();
$c['creatorType'] = Zotero_CreatorTypes::getName($creator['creatorTypeID']);
// Single-field mode
if ($creator['ref']->fieldMode == 1) {
$c['name'] = $creator['ref']->lastName;
}
// Two-field mode
else {
$c['firstName'] = $creator['ref']->firstName;
$c['lastName'] = $creator['ref']->lastName;
}
$arr['creators'][] = $c;
}
if (!$arr['creators'] && !$includeEmpty) {
unset($arr['creators']);
}
}
else {
$titleFieldID = false;
}
// Item metadata
$fields = array_keys($this->itemData);
foreach ($fields as $field) {
if ($field == $titleFieldID) {
continue;
}
if ($unformattedFields) {
$value = $this->itemData[$field];
}
else {
$value = $this->getField($field);
}
if (!$includeEmpty && ($value === false || $value === "")) {
continue;
}
$fieldName = Zotero_ItemFields::getName($field);
// TEMP
if ($fieldName == 'versionNumber') {
if ($requestParams['v'] < 3) {
$fieldName = 'version';
}
}
else if ($fieldName == 'accessDate') {
if ($requestParams['v'] >= 3 && $value !== false && $value !== "") {
$value = Zotero_Date::sqlToISO8601($value);
}
}
$arr[$fieldName] = ($value !== false && $value !== "") ? $value : "";
}
if ($requestParams['v'] >= 3) {
$arr['dateAdded'] = Zotero_Date::sqlToISO8601($this->dateAdded);
$arr['dateModified'] = Zotero_Date::sqlToISO8601($this->dateModified);
}
// Embedded note for notes and attachments
if (!$regularItem) {
// Use sanitized version
$arr['note'] = $this->getNote(true);
}
if ($this->isAttachment()) {
$val = $this->attachmentLinkMode;
$arr['linkMode'] = strtolower(Zotero_Attachments::linkModeNumberToName($val));
$val = $this->attachmentMIMEType;
if ($includeEmpty || ($val !== false && $val !== "")) {
$arr['contentType'] = $val;
}
$val = $this->attachmentCharset;
if ($includeEmpty || ($val !== false && $val !== "")) {
$arr['charset'] = $val;
}
if ($this->isImportedAttachment()) {
$arr['filename'] = $this->attachmentFilename;
$val = $this->attachmentStorageHash;
if ($includeEmpty || $val) {
$arr['md5'] = $val;
}
$val = $this->attachmentStorageModTime;
if ($includeEmpty || $val) {
$arr['mtime'] = $val;
}
}
}
if ($this->getDeleted()) {
$arr['deleted'] = 1;
}
// Tags
$arr['tags'] = array();
$tags = $this->getTags();
if ($tags) {
foreach ($tags as $tag) {
$t = array(
'tag' => $tag->name
);
if ($tag->type != 0) {
$t['type'] = $tag->type;
}
$arr['tags'][] = $t;
}
}
if ($requestParams['v'] >= 2) {
if ($this->isTopLevelItem()) {
$collections = $this->getCollections(true);
$arr['collections'] = $collections;
}
$arr['relations'] = $this->getRelations();
}
if ($asArray) {
return $arr;
}
// Before v3, additional characters were escaped in the JSON, for unclear reasons
$escapeAll = $requestParams['v'] <= 2;
return Zotero_Utilities::formatJSON($arr, $escapeAll);
}
public function itemContent()
{
$this->allowMethods(array('GET', 'PUT'));
// Check for general library access
if (!$this->permissions->canAccess($this->objectLibraryID)) {
$this->e403();
}
if (!$this->singleObject) {
$this->e404();
}
if ($this->isWriteMethod()) {
// Check for library write access
if (!$this->permissions->canWrite($this->objectLibraryID)) {
$this->e403("Write access denied");
}
Zotero_Libraries::updateVersionAndTimestamp($this->objectLibraryID);
}
$item = Zotero_Items::getByLibraryAndKey($this->objectLibraryID, $this->objectKey);
if (!$item) {
$this->e404();
}
// If no access to the note, don't show that it exists
if ($item->isNote() && !$this->permissions->canAccess($this->objectLibraryID, 'notes')) {
$this->e404();
}
if (!$item->isAttachment() || Zotero_Attachments::linkModeNumberToName($item->attachmentLinkMode) == 'LINKED_URL') {
$this->e404();
}
if ($this->isWriteMethod()) {
$this->libraryVersion = Zotero_Libraries::getUpdatedVersion($this->objectLibraryID);
if ($this->method == 'PUT') {
$this->requireContentType("application/json");
$json = json_decode($this->body, true);
if (!$json) {
$this->e400("PUT data is not valid JSON");
}
$stats = [];
foreach (Zotero_FullText::$metadata as $prop) {
if (isset($json[$prop])) {
$stats[$prop] = $json[$prop];
}
}
Zotero_FullText::indexItem($item, $json['content'], $stats);
$this->e204();
} else {
$this->e405();
}
}
$data = Zotero_FullText::getItemData($item->libraryID, $item->key);
if (!$data) {
$this->e404();
}
$this->libraryVersion = $data['version'];
$json = ["content" => $data['content']];
foreach (Zotero_FullText::$metadata as $prop) {
if (!empty($data[$prop])) {
$json[$prop] = $data[$prop];
}
}
echo Zotero_Utilities::formatJSON($json);
$this->end();
}
