-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1199 from briehl/copy-sharing-problem
TASK-1229 - UPA handler API
- Loading branch information
Showing
11 changed files
with
542 additions
and
535 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| define([ | ||
| 'common/runtime' | ||
| ], function(Runtime) { | ||
| 'use strict'; | ||
|
|
||
| var UpaApi = function() { | ||
| var externalTag = '&'; | ||
|
|
||
| /** | ||
| * Runs a regex that tests the given string to see if it's a valid upa. | ||
| * valid upas are of the form: | ||
| * ws/obj/ver or ws1/obj1/ver1;ws2/obj2/ver2;... | ||
| */ | ||
| var isUpa = function(upa) { | ||
| return RegExp(/^\d+(\/\d+){2}(;\d+(\/\d+){2})*$/).test(upa); | ||
| }; | ||
|
|
||
| var prepareUpaSerialization = function(upa) { | ||
| if (typeof upa !== 'string') { | ||
| // stringify the array version of an UPA, if that's what we have. | ||
| if (Array.isArray(upa)) { | ||
| upa = upa.join(';'); | ||
| } | ||
| else { | ||
| throw {error: 'Can only serialize UPA strings or Arrays of UPA paths'}; | ||
| } | ||
| } | ||
| if (!isUpa(upa)) { | ||
| throw {error: '"' + upa + '" is not a valid UPA. It may already have been serialized.'}; | ||
| } | ||
| return upa; | ||
| }; | ||
|
|
||
| /** | ||
| * @method | ||
| * @public | ||
| * Serializes an UPA - prepares it for storage as a part of Narrative cell metadata. | ||
| * This means a bit of a tweak to the UPA itself. Currently, we want to store it in a way | ||
| * that designates it as a serialized string, and gives an easy path to substitute the | ||
| * initial workspace part of the UPA with a different workspace. | ||
| * So it gets transformed from: | ||
| * ws1/obj1/ver1;ws2/obj2/ver2;... | ||
| * to | ||
| * [ws1]/obj1/ver1;ws2/obj2/ver2;... | ||
| * | ||
| * If the passed upa is not properly formatted, this will throw an Error. | ||
| */ | ||
| var serialize = function(upa) { | ||
| upa = prepareUpaSerialization(upa); | ||
| return upa.replace(/^(\d+)\//, '[$1]/'); | ||
| }; | ||
|
|
||
| /** | ||
| * @public | ||
| * @method | ||
| * | ||
| * In the case of UPAs representing objects that are located in a different workspace all | ||
| * together (e.g. set items that aren't copied into the Narrative with the set container | ||
| * object), they get flagged with a special character. In that case, the UPA is maintained, | ||
| * but transformed into: | ||
| * &ws1/obj1/ver1;ws2/obj2/ver2;... | ||
| * | ||
| * This is an explicit method for handling that serialization. Deserialization of both is handled | ||
| * by the deserialize function. | ||
| * | ||
| * If the passed upa is not properly formatted, this will throw an Error. | ||
| */ | ||
| var serializeExternal = function(upa) { | ||
| upa = prepareUpaSerialization(upa); | ||
| return externalTag + upa; | ||
| }; | ||
|
|
||
| /** | ||
| * @public | ||
| * @method | ||
| * Deserializes a serialized UPA to one that is valid for use with the Workspace (or other | ||
| * services that consume Workspace objects). | ||
| * A serialized UPA is either of the form: | ||
| * [ws]/obj/ver;ws/obj/ver;... | ||
| * or | ||
| * &ws/obj/ver;ws/obj/ver | ||
| * In the [ws] case, the current workspace id replaces that whole token. In the &ws case, | ||
| * the & tag is removed. | ||
| */ | ||
| var deserialize = function(serial) { | ||
| if (typeof serial !== 'string') { | ||
| throw { | ||
| error: 'Can only deserialize UPAs from strings.' | ||
| }; | ||
| } | ||
| var deserial; | ||
| if (serial[0] === externalTag) { | ||
| deserial = serial.substring(externalTag.length); | ||
| } else { | ||
| var wsId = Runtime.make().workspaceId(); | ||
| if (!wsId) { | ||
| throw { | ||
| error: 'Currently loaded workspace is unknown! Unable to deserialize UPA.' | ||
| }; | ||
| } | ||
| deserial = serial.replace(/^\[\d+\]\//, Runtime.make().workspaceId() + '/'); | ||
| } | ||
| if (!isUpa(deserial)) { | ||
| throw { | ||
| error: 'Deserialized UPA: ' + deserial + ' is invalid!' | ||
| }; | ||
| } | ||
| return deserial; | ||
| }; | ||
|
|
||
|
|
||
| return { | ||
| serialize: serialize, | ||
| deserialize: deserialize, | ||
| serializeExternal: serializeExternal, | ||
| externalTag: externalTag, | ||
| isUpa: isUpa | ||
| }; | ||
| }; | ||
|
|
||
| return UpaApi; | ||
|
|
||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.