params[0]) == 'Root Folder') { $folderId = CMISUtil::encodeObjectId(FOLDER, 1); $folderName = urldecode($this->params[0]); } else if ($this->params[0] == 'path') { $ktapi =& KT_cmis_atom_service_helper::getKt(); $folderId = KT_cmis_atom_service_helper::getFolderId($this->params, $ktapi); } else if (($this->params[1] == 'children') || ($this->params[1] == 'descendants')) { $folderId = $this->params[0]; $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); $response = $ObjectService->getProperties($repositoryId, $folderId, false, false); if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, KT_cmis_atom_service::STATUS_SERVER_ERROR, $response->getMessage()); $this->responseFeed = $feed; return null; } $folderName = $response['properties']['Name']['value']; } // NOTE parent changes to parents in later specification // TODO update when updating to later specification // TODO this only returns one parent, need to implement returnToRoot also else if ($this->params[1] == 'parent') { // abstract this to be used also by the document service (and the PWC service?) ??? // alternatively use getFolderParent here makes sense and use getObjectParents when document service? $folderId = $this->params[0]; $NavigationService = new NavigationService(KT_cmis_atom_service_helper::getKt()); $response = $NavigationService->getFolderParent($repositoryId, $folderId, false, false, false); if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, KT_cmis_atom_service::STATUS_SERVER_ERROR, $response->getMessage()); $this->responseFeed = $feed; return null; } // we know that a folder will only have one parent, so we can assume element 0 $folderId = $response[0]['properties']['ObjectId']['value']; $folderName = $response[0]['properties']['Name']['value']; } else { $folderId = $this->params[0]; } if (!empty($this->params[1]) && (($this->params[1] == 'children') || ($this->params[1] == 'descendants'))) { $NavigationService = new NavigationService(KT_cmis_atom_service_helper::getKt()); $feed = $this->getFolderChildrenFeed($NavigationService, $repositoryId, $folderId, $folderName, $this->params[1]); } else { $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); $feed = KT_cmis_atom_service_helper::getObjectFeed($this, $ObjectService, $repositoryId, $folderId); } // Expose the responseFeed $this->responseFeed = $feed; } /** * Deals with folder service POST actions. * This includes creation/moving of both folders and documents. */ public function POST_action() { $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); // set default action, objectId and typeId $action = 'create'; $objectId = null; $typeId = null; $folderId = $this->params[0]; $title = KT_cmis_atom_service_helper::getAtomValues($this->parsedXMLContent['@children'], 'title'); $summary = KT_cmis_atom_service_helper::getAtomValues($this->parsedXMLContent['@children'], 'summary'); $properties = array('name' => $title, 'summary' => $summary); // determine whether this is a folder or a document action // document action create will have a content tag or containing base64 encoding of the document // move action will have an existing id supplied as a parameter - not sure how this works yet as the CMIS clients we are // testing don't support move functionality at this time (2009/07/23) and so we are presuming the following format: // /folder//children/ // also possible that there will be an existing ObjectId property, try to cater for both until we know how it really works // check for existing object id as parameter in url if (isset($this->params[2])) { $action = 'move'; $objectId = $this->params[2]; } $cmisObjectProperties = KT_cmis_atom_service_helper::getCmisProperties($this->parsedXMLContent['@children']); // check for existing object id as property of submitted object data if (!empty($cmisObjectProperties['ObjectId'])) { $action = 'move'; $objectId = $cmisObjectProperties['ObjectId']; } // TODO there may be more to do for the checking of an existing object. // e.g. verifying that it does indeed exist, and throwing an exception if it does not: // "If the objected property is present but not valid an exception will be thrown" (from CMIS specification) // NOTE this exception should be thrown in the service API code and not here. // determine type if object is being moved if (!is_null($objectId)) { CMISUtil::decodeObjectId($objectId, $typeId); } // check for content stream $content = KT_cmis_atom_service_helper::getAtomValues($this->parsedXMLContent['@children'], 'content'); // TODO this will possibly need to change somewhat once Relationship Objects come into play. if ((($action == 'create') && (is_null($content))) || ($typeId == 'Folder')) { $type = 'folder'; } else { $type = 'document'; } $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); $success = false; $error = null; if ($action == 'create') { if ($type == 'folder') $newObjectId = $ObjectService->createFolder($repositoryId, ucwords($cmisObjectProperties['ObjectTypeId']), $properties, $folderId); else $newObjectId = $ObjectService->createDocument($repositoryId, ucwords($cmisObjectProperties['ObjectTypeId']), $properties, $folderId, $content); // check if returned Object Id is a valid CMIS Object Id CMISUtil::decodeObjectId($newObjectId, $typeId); if ($typeId != 'Unknown') $success = true; else $error = $newObjectId['message']; } else if ($action == 'move') { $response = $ObjectService->moveObject($repositoryId, $objectId, '', $folderId); if (!PEAR::isError($response)) $success = true; else $error = $response->getMessage(); // same object as before $newObjectId = $objectId; $typeId = ucwords($type); } if ($success) { $this->setStatus(($action == 'create') ? self::STATUS_CREATED : self::STATUS_UPDATED); $feed = KT_cmis_atom_service_helper::getObjectFeed($this, $ObjectService, $repositoryId, $newObjectId, 'POST'); } else { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, $error); } // Expose the responseFeed $this->responseFeed = $feed; } /** * Deals with DELETE actions for folders. * This includes deleting a single folder (with no content) and deleting an entire folder tree * * @return 204 on success, 500 on error */ public function DELETE_action() { // NOTE due to the way KnowledgeTree works with folders this is always going to call deleteTree. // we COULD call deleteObject but when we delete a folder we expect to be trying to delete // the folder and all content. $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); // attempt delete $response = $ObjectService->deleteTree($repositoryId, $this->params[0]); // error? if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, $response->getMessage()); // Expose the responseFeed $this->responseFeed = $feed; return null; } // list of failed objects? if (is_array($response)) { $this->setStatus(self::STATUS_SERVER_ERROR); $feed = new KT_cmis_atom_responseFeed_GET(CMIS_APP_BASE_URI); $feed->newField('title', 'Error: Failed to delete all objects in tree: ' . self::STATUS_SERVER_ERROR, $feed); foreach($response as $failed) { $entry = $feed->newEntry(); $objectElement = $feed->newElement('cmis:object'); $propertiesElement = $feed->newElement('cmis:properties'); $propElement = $feed->newElement('cmis:propertyId'); $propElement->appendChild($feed->newAttr('cmis:name', 'ObjectId')); $feed->newField('cmis:value', $failed, $propElement); $propertiesElement->appendChild($propElement); $objectElement->appendChild($propertiesElement); $entry->appendChild($objectElement); $entry->appendChild($feed->newElement('cmis:terminator')); } $this->responseFeed = $feed; return null; } // success $this->setStatus(self::STATUS_NO_CONTENT); } /** * Retrieves children/descendants of the specified folder * TODO this currently only works in children mode, add descendants * * @param string $repositoryId * @param string $folderId folder id for which children/descendants are requested * @param string $feedType children or descendants * @return string CMIS AtomPub feed */ private function getFolderChildrenFeed($NavigationService, $repositoryId, $folderId, $folderName, $feedType = 'children') { if ($feedType == 'children') { $entries = $NavigationService->getChildren($repositoryId, $folderId, false, false); } else if ($feedType == 'descendants') { $entries = $NavigationService->getDescendants($repositoryId, $folderId, false, false); } else { // error, we shouldn't be here, if we are then the wrong service/function was called } // $baseURI=NULL,$title=NULL,$link=NULL,$updated=NULL,$author=NULL,$id=NULL $feed = new KT_cmis_atom_responseFeed_GET(CMIS_APP_BASE_URI); $workspace = $feed->getWorkspace(); $feed->newField('title', $folderName . ' ' . ucwords($feedType), $feed); // TODO dynamic? $feedElement = $feed->newField('author'); $element = $feed->newField('name', 'System', $feedElement); $feed->appendChild($feedElement); // id $feed->newField('id', 'urn:uuid:' . $folderId . '-' . $feedType, $feed); // TODO get actual most recent update time, only use current if no other available $feed->newField('updated', KT_cmis_atom_service_helper::formatDatestamp(), $feed); $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel', 'self')); $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . $workspace . '/folder/' . $folderId . '/' . $feedType)); $feed->appendChild($link); $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel', 'source')); $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . $workspace . '/folder/' . $folderId)); $feed->appendChild($link); foreach($entries as $cmisEntry) { KT_cmis_atom_service_helper::createObjectEntry($feed, $cmisEntry, $folderName); // after each entry, add app:edited tag $feed->newField('app:edited', KT_cmis_atom_service_helper::formatDatestamp(), $feed); } $feed->newField('cmis:hasMoreItems', 'false', $feed); return $feed; } } /** * AtomPub Service: document */ // TODO confirm that an error response is sent when a document has status "deleted" class KT_cmis_atom_service_document extends KT_cmis_atom_service { /** * Deals with GET actions for documents. * This includes individual document retrieval */ public function GET_action() { $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); $objectId = $this->params[0]; // TODO this is "parents" in later versions of the specification // update accordingly when updating to newer specification if ($this->params[1] == 'parent') { // abstract this to be used also by the document service (and the PWC service?) ??? // alternatively use getFolderParent here makes sense and use getObjectParents when document service? $NavigationService = new NavigationService(KT_cmis_atom_service_helper::getKt()); $response = $NavigationService->getObjectParents($repositoryId, $objectId, false, false); if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, KT_cmis_atom_service::STATUS_SERVER_ERROR, $response->getMessage()); $this->responseFeed = $feed; return null; } // for now a document will only have one parent as KnowledgeTree does not support multi-filing // TODO update this code if/when multi-filing support is added $objectId = $response[0]['properties']['ObjectId']['value']; } // determine whether we want the document entry feed or the actual physical document content. // this depends on $this->params[1] else if (!empty($this->params[1])) { KT_cmis_atom_service_helper::downloadContentStream($this, $ObjectService, $repositoryId); return null; } $feed = KT_cmis_atom_service_helper::getObjectFeed($this, $ObjectService, $repositoryId, $objectId); // Expose the responseFeed $this->responseFeed = $feed; } /** * Deals with DELETE actions for documents. * This includes deletion of a specific version of a document (latest version) via deleteObject * as well as deleteAllVersions * * @return 204 on success, 500 on error */ public function DELETE_action() { // NOTE due to the way KnowledgeTree works with documents this is always going to call deleteAllVersions. // we do not have support for deleting only specific versions (this may be added in the future.) $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $VersioningService = new VersioningService(KT_cmis_atom_service_helper::getKt()); // attempt delete $response = $VersioningService->deleteAllVersions($repositoryId, $this->params[0]); // error? if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, $response->getMessage()); // Expose the responseFeed $this->responseFeed = $feed; return null; } // success $this->setStatus(self::STATUS_NO_CONTENT); } } class KT_cmis_atom_service_pwc extends KT_cmis_atom_service { protected $serviceType = 'PWC'; /** * Deals with GET actions for Private Working Copies. * This includes individual Private Working Copy retrieval */ public function GET_action() { $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); // determine whether we want the Private Working Copy entry feed or the actual physical Private Working Copy content. // this depends on $this->params[1] if (!empty($this->params[1])) { KT_cmis_atom_service_helper::downloadContentStream($this, $ObjectService, $repositoryId); return null; } $feed = KT_cmis_atom_service_helper::getObjectFeed($this, $ObjectService, $repositoryId, $this->params[0]); // Expose the responseFeed $this->responseFeed = $feed; } /** * Deals with DELETE actions for Private Working Copies. * This includes deletion of a specific version of a document (latest version) via deleteObject * as well as deleteAllVersions * * @return 204 on success, 500 on error */ public function DELETE_action() { // call the cancel checkout function $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $VersioningService = new VersioningService(KT_cmis_atom_service_helper::getKt()); $response = $VersioningService->cancelCheckout($repositoryId, $this->params[0]); if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, $response->getMessage()); // Expose the responseFeed $this->responseFeed = $feed; return null; } $this->setStatus(self::STATUS_NO_CONTENT); $this->responseFeed = null; } public function PUT_action() { $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $VersioningService = new VersioningService(KT_cmis_atom_service_helper::getKt()); $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); // check for content stream // NOTE this is a hack! will not work with CMISSpaces at least, probably not with any client except RestTest and similar // where we can manually modify the input // first we try for an atom content tag $content = KT_cmis_atom_service_helper::getAtomValues($this->parsedXMLContent['@children'], 'content'); if (!empty($content)) { $contentStream = $content; } // not found? try for a regular content tag else { $content = KT_cmis_atom_service_helper::findTag('content', $this->parsedXMLContent['@children'], null, false); $contentStream = $content['@value']; } // if we haven't found it now, the real hack begins - retrieve the EXISTING content and submit this as the contentStream // this is needed because KnowledgeTree will not accept a checkin without a content stream but CMISSpaces (and possibly // other CMIS clients are the same, does not send a content stream on checkin nor does it offer the user a method to choose one) // NOTE that if the content is INTENDED to be empty this and all the above checks will FAIL! // FIXME this is horrible, terrible, ugly and bad! if (empty($contentStream)) { $contentStream = base64_encode(KT_cmis_atom_service_helper::getContentStream($this, $ObjectService, $repositoryId)); } // and if we don't have it by now, we give up...but leave the error to be generated by the underlying KnowledgeTree code // checkin function call // TODO dynamically detect version change type - leaving this for now as the CMIS clients tested do not appear to // offer the choice to the user - perhaps it will turn out that this will come from somewhere else but for now // we assume minor version updates only $major = false; $response = $VersioningService->checkIn($repositoryId, $this->params[0], $major, $contentStream); if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, $response->getMessage()); // Expose the responseFeed $this->responseFeed = $feed; return null; } $feed = KT_cmis_atom_service_helper::getObjectFeed($this, $ObjectService, $repositoryId, $this->params[0]); // Expose the responseFeed $this->responseFeed = $feed; } } /** * AtomPub Service: checkedout */ class KT_cmis_atom_service_checkedout extends KT_cmis_atom_service { /** * Deals with GET actions for checkedout documents. */ public function GET_action() { $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $NavigationService = new NavigationService(KT_cmis_atom_service_helper::getKt()); $checkedout = $NavigationService->getCheckedOutDocs($repositoryId); //Create a new response feed $feed = new KT_cmis_atom_responseFeed_GET(CMIS_APP_BASE_URI); $workspace = $feed->getWorkspace(); $feed->newField('title', 'Checked out Documents', $feed); // TODO dynamic? $feedElement = $feed->newField('author'); $element = $feed->newField('name', 'admin', $feedElement); $feed->appendChild($feedElement); $feed->appendChild($feed->newElement('id', 'urn:uuid:checkedout')); // TODO get actual most recent update time, only use current if no other available $feed->appendChild($feed->newElement('updated', KT_cmis_atom_service_helper::formatDatestamp())); $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel', 'self')); $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . $workspace . '/checkedout')); $feed->appendChild($link); $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel','first')); $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . $workspace . '/checkedout/pageNo=1&pageSize=0')); $link->appendChild($feed->newAttr('type', 'application/atom+xml;type=feed')); $feed->appendChild($link); $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel','last')); // TODO set page number correctly - to be done when we support paging the the API $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . $workspace . '/checkedout/pageNo=1&pageSize=0')); $link->appendChild($feed->newAttr('type', 'application/atom+xml;type=feed')); $feed->appendChild($link); foreach($checkedout as $cmisEntry) { KT_cmis_atom_service_helper::createObjectEntry($feed, $cmisEntry, $folderName, true); // // after each entry, add app:edited tag // $feed->newField('app:edited', KT_cmis_atom_service_helper::formatDatestamp(), $feed); } $feed->newField('cmis:hasMoreItems', 'false', $feed); // Expose the responseFeed $this->responseFeed = $feed; } public function POST_action() { $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $VersioningService = new VersioningService(KT_cmis_atom_service_helper::getKt()); $ObjectService = new ObjectService(KT_cmis_atom_service_helper::getKt()); $cmisObjectProperties = KT_cmis_atom_service_helper::getCmisProperties($this->parsedXMLContent['@children']); // check for existing object id as property of submitted object data if (empty($cmisObjectProperties['ObjectId'])) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, 'No object was specified for checkout'); // Expose the responseFeed $this->responseFeed = $feed; return null; } $response = $VersioningService->checkOut($repositoryId, $cmisObjectProperties['ObjectId']); if (PEAR::isError($response)) { $feed = KT_cmis_atom_service_helper::getErrorFeed($this, self::STATUS_SERVER_ERROR, 'No object was specified for checkout'); // Expose the responseFeed $this->responseFeed = $feed; return null; } $this->setStatus(self::STATUS_CREATED); $feed = KT_cmis_atom_service_helper::getObjectFeed($this, $ObjectService, $repositoryId, $cmisObjectProperties['ObjectId'], 'POST'); // Expose the responseFeed $this->responseFeed = $feed; } } /** * AtomPub Service: types */ class KT_cmis_atom_service_types extends KT_cmis_atom_service { public function GET_action() { $RepositoryService = new RepositoryService(); $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); $types = $RepositoryService->getTypes($repositoryId); $type = ((empty($this->params[0])) ? 'all' : $this->params[0]); $feed = KT_cmis_atom_service_helper::getTypeFeed($type, $types); // Expose the responseFeed $this->responseFeed = $feed; } } /** * AtomPub Service: type */ class KT_cmis_atom_service_type extends KT_cmis_atom_service { public function GET_action() { $RepositoryService = new RepositoryService(); $repositoryId = KT_cmis_atom_service_helper::getRepositoryId($RepositoryService); if (!isset($this->params[1])) { // For easier return in the wanted format, we call getTypes instead of getTypeDefinition. // Calling this with a single type specified returns an array containing the definition of // just the requested type. // NOTE could maybe be more efficient to call getTypeDefinition direct and then place in // an array on this side? or directly expose the individual entry response code and // call directly from here rather than via getTypeFeed. $type = ucwords($this->params[0]); $types = $RepositoryService->getTypes($repositoryId, $type); $feed = KT_cmis_atom_service_helper::getTypeFeed($type, $types); } else { // TODO dynamic dates, as needed everywhere // NOTE children of types not yet implemented and we don't support any non-basic types at this time $feed = $this->getTypeChildrenFeed($this->params[1]); } // Expose the responseFeed $this->responseFeed=$feed; } /** * Retrieves a list of child types for the supplied type * * NOTE this currently returns a hard coded empty list, since we do not currently support child types * TODO make dynamic if/when we support checking for child types (we don't actually need to support child types themselves) * * @param string $type * @return string CMIS AtomPub feed */ private function getTypeChildrenFeed() { //Create a new response feed // $baseURI=NULL,$title=NULL,$link=NULL,$updated=NULL,$author=NULL,$id=NULL $feed = new KT_cmis_atom_responseFeed_GET(CMIS_APP_BASE_URI); $feed->newField('title', 'Child Types of ' . ucwords($this->params[0]), $feed); $feed->newField('id', $this->params[0] . '-children', $feed); // TODO fetch child types - to be implemented when we support child types in the API // links $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel','first')); $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . 'type/' . $this->params[0] . '/' . $this->params[1] . '?pageNo=1&pageSize=0')); $link->appendChild($feed->newAttr('type', 'application/atom+xml;type=feed')); $link = $feed->newElement('link'); $link->appendChild($feed->newAttr('rel','last')); // TODO set page number correctly - to be done when we support paging the the API $link->appendChild($feed->newAttr('href', CMIS_APP_BASE_URI . 'type/' . $this->params[0] . '/' . $this->params[1] . '?pageNo=1&pageSize=0')); $link->appendChild($feed->newAttr('type', 'application/atom+xml;type=feed')); $feed->newField('updated', KT_cmis_atom_service_helper::formatDatestamp(), $feed); $feed->newField('cmis:hasMoreItems', 'false', $feed); return $feed; } } ?>