1 (function (GCN) {
  2 
  3 	'use strict';
  4 
  5 	/**
  6 	 * Updates the internal data of the given content object.
  7 	 *
  8 	 * This function extends and overwrites properties of the instances's
  9 	 * internal data structure.  No property is deleted on account of being
 10 	 * absent from the given `props' object.
 11 	 *
 12 	 * @param {ContentObjectAPI} obj An instance whose internal data is to be
 13 	 *                               reset.
 14 	 * @param {object} props The properties with which to replace the internal
 15 	 *                       data of the given chainback instance.
 16 	 */
 17 	function update(obj, props) {
 18 		jQuery.extend(obj._data, props);
 19 	}
 20 
 21 	/**
 22 	 * The prefix that will be temporarily applied to block tags during an
 23 	 * encode() process.
 24 	 *
 25 	 * @type {string}
 26 	 * @const
 27 	 */
 28 	var BLOCK_ENCODING_PREFIX = 'GCN_BLOCK_TMP__';
 29 
 30 	/**
 31 	 * Will match <span id="GENTICS_block_123"></span>" but not "<node abc123>"
 32 	 * tags.  The first backreference contains the tagname of the tag
 33 	 * corresponding to this block.
 34 	 *
 35 	 * Limitation: Will not work with unicode characters.
 36 	 *
 37 	 * @type {RexExp}
 38 	 * @const
 39 	 */
 40     var CONTENT_BLOCK = new RegExp(
 41 			// "<span" or "<div" but not "<node"
 42 			'<(?!node)[a-z]+'            +
 43 				// "class=... data-*..."
 44 				'(?:\\s+[^/<>\\s=]+(?:=(?:"[^"]*"|\'[^\']*\'|[^>/\\s]+))?)*?' +
 45 				// " id = "
 46 				'\\s+id\\s*=\\s*["\']?'  +
 47 				// "GCN_BLOCK_TMP__"
 48 				BLOCK_ENCODING_PREFIX    +
 49 				// "_abc-123"
 50 				'([^"\'/<>\\s=]*)["\']?' +
 51 				// class=... data-*...
 52 				'(?:\\s+[^/<>\\s=]+(?:=(?:"[^"]*"|\'[^\']*\'|[^>/\\s]+))?)*' +
 53 				// "' ...></span>" or "</div>"
 54 				'\\s*></[a-z]+>',
 55 			'gi'
 56 		);
 57 
 58 	/**
 59 	 * Will match <node foo> or <node bar_123> or <node foo-bar> but not
 60 	 * <node "blah">.
 61 	 *
 62 	 * @type {RegExp}
 63 	 * @const
 64 	 */
 65 	var NODE_NOTATION = /<node ([a-z0-9_\-]+?)>/gim;
 66 
 67 	/**
 68 	 * Examines a string for "<node>" tags, and for each occurance of this
 69 	 * notation, the given callback will be invoked to manipulate the string.
 70 	 *
 71 	 * @private
 72 	 * @static
 73 	 * @param {string} str The string that will be examined for "<node>" tags.
 74 	 * @param {function} onMatchFound Callback function that should receive the
 75 	 *                                following three parameters:
 76 	 *
 77 	 *                    name:string The name of the tag being notated by the
 78 	 *                                node substring.  If the `str' arguments
 79 	 *                                is "<node myTag>", then the `name' value
 80 	 *                                will be "myTag".
 81 	 *                  offset:number The offset where the node substring was
 82 	 *                                found within the examined string.
 83 	 *                     str:string The string in which the "<node *>"
 84 	 *                                substring occured.
 85 	 *
 86 	 *                                The return value of the function will
 87 	 *                                replace the entire "<node>" substring
 88 	 *                                that was passed to it within the examined
 89 	 *                                string.
 90 	 */
 91 	function replaceNodeTags(str, onMatchFound) {
 92 		var parsed = str.replace(NODE_NOTATION, function (substr, tagname,
 93 		                                                  offset, examined) {
 94 				return onMatchFound(tagname, offset, examined);
 95 			});
 96 		return parsed;
 97 	}
 98 
 99 	/*
100 	 * have a look at _init 
101 	 */
102 	GCN.ContentObjectAPI = GCN.defineChainback({
103 		/** @lends ContentObjectAPI */
104 
105 		/**
106 		 * @private
107 		 * @type {string} A string denoting a content node type.  This value is
108 		 *                used to compose the correct REST API ajax urls.  The
109 		 *                following are valid values: "node", "folder",
110 		 *                "template", "page", "file", "image".
111 		 */
112 		_type: null,
113 
114 		/**
115 		 * @private
116 		 * @type {object<string,*>} An internal object to store data that we
117 		 *                          get from the server.
118 		 */
119 		_data: {},
120 
121 		/**
122 		 * @private
123 		 * @type {object<string,*>} An internal object to store updates to
124 		 *                          the content object.  Should reflect the
125 		 *                          structural typography of the `_data'
126 		 *                          object.
127 		 */
128 		_shadow: {},
129 
130 		/**
131 		 * @type {boolean} Flags whether or not data for this content object have
132 		 *                 been fetched from the server.
133 		 */
134 		_fetched: false,
135 
136 		/**
137 		 * @private
138 		 * @type {object} will contain an objects internal settings
139 		 */
140 		_settings: null,
141 
142 		/**
143 		 * An array of all properties of an object that can be changed by the
144 		 * user. Writeable properties for all content objects.
145 		 * 
146 		 * @public
147 		 * @type {Array.string}
148 		 */
149 		WRITEABLE_PROPS: [],
150 
151 		/**
152 		 * <p>This object can contain various contrains for writeable props. 
153 		 * Those contrains will be checked when the user tries to set/save a
154 		 * property. Currently only maxLength is beeing handled.</p>
155 		 *
156 		 * <p>Example:</p>
157 		 * <pre>WRITEABLE_PROPS_CONSTRAINTS: {
158 		 *    'name': {
159 		 *        maxLength: 255
160 		 *     } 
161 		 * }</pre>
162 		 * @type {object}
163 		 * @const
164 		 *
165 		 */
166 		WRITEABLE_PROPS_CONSTRAINTS: {},
167 
168 		/**
169 		 * Fetches this content object's data from the backend.
170 		 *
171 		 * @ignore
172 		 * @param {function(object)} success A function to receive the server
173 		 *                                   response.
174 		 * @param {function(GCNError):boolean} error Optional custrom error
175 		 *                                           handler.
176 		 */
177 		'!fetch': function (success, error, stack) {
178 			var obj = this;
179 			var ajax = function () {
180 				obj._authAjax({
181 					url: GCN.settings.BACKEND_PATH + '/rest/' + obj._type +
182 					     '/load/' + obj.id() + GCN._getChannelParameter(obj),
183 					data: obj._loadParams(),
184 					error: error,
185 					success: success
186 				});
187 			};
188 
189 			// If this chainback object has an ancestor, then invoke that
190 			// parent's `_read()' method before fetching the data for this
191 			// chainback object.
192 			if (obj._chain) {
193 				var circularReference =
194 						stack && -1 < jQuery.inArray(obj._chain, stack);
195 				if (!circularReference) {
196 					stack = stack || [];
197 					stack.push(obj._chain);
198 					obj._chain._read(ajax, error, stack);
199 					return;
200 				}
201 			}
202 
203 			ajax();
204 		},
205 
206 		/**
207 		 * Internal method, to fetch this object's data from the server.
208 		 *
209 		 * @ignore
210 		 * @private
211 		 * @param {function(ContentObjectAPI)=} success Optional callback that
212 		 *                                              receives this object as
213 		 *                                              its only argument.
214 		 * @param {function(GCNError):boolean=} error Optional customer error
215 		 *                                            handler.
216 		 */
217 		'!_read': function (success, error, stack) {
218 			var obj = this;
219 			if (obj._fetched) {
220 				if (success) {
221 					obj._invoke(success, [obj]);
222 				}
223 				return;
224 			}
225 
226 			if (obj.multichannelling) {
227 				obj.multichannelling.read(obj, success, error);
228 				return;
229 			}
230 
231 			var id = obj.id();
232 
233 			if (null === id || undefined === id) {
234 				obj._getIdFromParent(function () {
235 					obj._read(success, error, stack);
236 				}, error, stack);
237 				return;
238 			}
239 
240 			obj.fetch(function (response) {
241 				obj._processResponse(response);
242 				obj._fetched = true;
243 				if (success) {
244 					obj._invoke(success, [obj]);
245 				}
246 			}, error, stack);
247 		},
248 
249 		/**
250 		 * Retrieves this object's id from its parent.  This function is used
251 		 * in order for this object to be able to fetch its data from the
252 		 * backend.
253 		 *
254 		 * FIXME: If the id that `obj` aquires results in it having a hash that
255 		 * is found in the cache, then `obj` should not replace the object that
256 		 * was in the cache, rather, `obj` should be masked by the object in the
257 		 * cache.  This scenario will arise in the following scenario:
258 		 *
259 		 * page.node().constructs();
260 		 * page.node().folders();
261 		 *
262 		 * The above will cause the same node to be fetched from the server
263 		 * twice, each time, clobbering the previosly loaded data in the cache.
264 		 *
265 		 * @ignore
266 		 * @private
267 		 * @param {function(ContentObjectAPI)=} success Optional callback that
268 		 *                                              receives this object as
269 		 *                                              its only argument.
270 		 * @param {function(GCNError):boolean=} error Optional customer error
271 		 *                                            handler.
272 		 * @throws CANNOT_GET_OBJECT_ID
273 		 */
274 		'!_getIdFromParent': function (success, error, stack) {
275 			var parent = this._ancestor();
276 
277 			if (!parent) {
278 				var err = GCN.createError('CANNOT_GET_OBJECT_ID',
279 					'Cannot get an id for object', this);
280 				GCN.handleError(err, error);
281 				return;
282 			}
283 
284 			var that = this;
285 
286 			parent._read(function () {
287 				if ('folder' === that._type) {
288 					// There are 3 possible property names that an object can
289 					// use to hold the id of the folder that it is related to:
290 					//
291 					// "folderId": for pages, templates, files, and images.
292 					// "motherId": for folders
293 					// "nodeId":   for nodes
294 					//
295 					// We need to see which of this properties is set, the
296 					// first one we find will be our folder's id.
297 					var props = ['folderId', 'motherId', 'nodeId'];
298 					var prop = props.pop();
299 					var id;
300 
301 					while (prop) {
302 						id = parent.prop(prop);
303 						if (typeof id !== 'undefined') {
304 							break;
305 						}
306 						prop = props.pop();
307 					}
308 
309 					that._data.id = id;
310 				} else {
311 					that._data.id = parent.prop(that._type + 'Id');
312 				}
313 
314 				if (that._data.id === null || typeof that._data.id === 'undefined') {
315 					var err = GCN.createError('CANNOT_GET_OBJECT_ID',
316 						'Cannot get an id for object', this);
317 					GCN.handleError(err, error);
318 					return;
319 				}
320 
321 				that._setHash(that._data.id)._addToCache();
322 
323 				if (success) {
324 					success();
325 				}
326 			}, error, stack);
327 		},
328 
329 		/**
330 		 * Gets this object's node id. If used in a multichannelling is enabled
331 		 * it will return the channel id or 0 if no channel was set.
332 		 * 
333 		 * @public
334 		 * @function
335 		 * @name nodeId
336 		 * @memberOf ContentObjectAPI
337 		 * @return {number} The channel to which this object is set. 0 if no
338 		 *         channel is set.
339 		 */
340 		'!nodeId': function () {
341 			return this._channel || 0;
342 		},
343 
344 		/**
345 		 * Gets this object's id. We'll return the id of the object when it has
346 		 * been loaded - this can only be a localid. Otherwise we'll return the
347 		 * id which was provided by the user. This can either be a localid or a
348 		 * globalid.
349 		 *
350 		 * @name id
351 		 * @function
352 		 * @memberOf ContentObjectAPI
353 		 * @public
354 		 * @return {number}
355 		 */
356 		'!id': function () {
357 			return this._data.id;
358 		},
359 
360 		/**
361 		 * Alias for {@link ContentObjectAPI#id}
362 		 *
363 		 * @name localId
364 		 * @function
365 		 * @memberOf ContentObjectAPI
366 		 * @private
367 		 * @return {number}
368 		 * @decprecated
369 		 */
370 		'!localId': function () {
371 			return this.id();
372 		},
373 
374 		/**
375 		 * Update the `_shadow' object that maintains changes to properties
376 		 * that reflected the internal `_data' object.  This shadow object is
377 		 * used to persist differential changes to a REST API object.
378 		 *
379 		 * @ignore
380 		 * @private
381 		 * @param {string} path The path through the object to the property we
382 		 *                      want to modify if a node in the path contains
383 		 *                      dots, then these dots should be escaped.  This
384 		 *                      can be done using the GCN.escapePropertyName()
385 		 *                      convenience function.
386 		 * @param {*} value The value we wish to set the property to.
387 		 * @param {function=} error Custom error handler.
388 		 * @param {boolean=} force If true, no error will be thrown if `path'
389 		 *                         cannot be fully resolved against the
390 		 *                         internal `_data' object, instead, the path
391 		 *                         will be created on the shadow object.
392 		 */
393 		'!_update': function (pathStr, value, error, force) {
394 			var boundary = Math.random().toString(8).substring(2);
395 			var path = pathStr.replace(/\./g, boundary)
396 			                  .replace(new RegExp('\\\\' + boundary, 'g'), '.')
397 			                  .split(boundary);
398 			var shadow = this._shadow;
399 			var actual = this._data;
400 			var i = 0;
401 			var numPathNodes = path.length;
402 			var pathNode;
403 			// Whether or not the traversal path in `_data' and `_shadow' are
404 			// at the same position in the respective objects.
405 			var areMirrored = true;
406 
407 			while (true) {
408 				pathNode = path[i++];
409 
410 				if (areMirrored) {
411 					actual = actual[pathNode];
412 					areMirrored = jQuery.type(actual) !== 'undefined';
413 				}
414 
415 				if (i === numPathNodes) {
416 					break;
417 				}
418 
419 				if (shadow[pathNode]) {
420 					shadow = shadow[pathNode];
421 				} else if (areMirrored || force) {
422 					shadow = (shadow[pathNode] = {});
423 				} else {
424 					break; // goto error
425 				}
426 			}
427 
428 			if (i === numPathNodes && (areMirrored || force)) {
429 				shadow[pathNode] = value;
430 			} else {
431 				var err = GCN.createError('TYPE_ERROR', 'Object "' +
432 					path.slice(0, i).join('.') + '" does not exist',
433 					actual);
434 				GCN.handleError(err, error);
435 			}
436 		},
437 
438 		/**
439 		 * Receives the response from a REST API request, and stores it in the
440 		 * internal `_data' object.
441 		 *
442 		 * @private
443 		 * @param {object} data Parsed JSON response data.
444 		 */
445 		'!_processResponse': function (data) {
446 			jQuery.extend(this._data, data[this._type]);
447 		},
448 
449 		/**
450 		 * Specifies a list of parameters that will be added to the url when
451 		 * loading the content object from the server.
452 		 *
453 		 * @private
454 		 * @return {object} object With parameters to be appended to the load
455 		 *                         request
456 		 */
457 		'!_loadParams': function () {},
458 
459 		/**
460 		 * Reads the property `property' of this content object if this
461 		 * property is among those in the WRITEABLE_PROPS array. If a second
462 		 * argument is provided, them the property is updated with that value.
463 		 *
464 		 * @name prop
465 		 * @function
466 		 * @memberOf ContentObjectAPI
467 		 * @param {String} property Name of the property to be read or updated.
468 		 * @param {String} value Optional value to set property to. If omitted the property will just be read.
469 		 * @param {function(GCNError):boolean=} error Custom error handler to 
470 		 *                                      stop error propagation for this
471 		 *                                      synchronous call. 
472 		 * @return {?*} Meta attribute.
473 		 * @throws UNFETCHED_OBJECT_ACCESS if the object has not been fetched from the server yet
474 		 * @throws READONLY_ATTRIBUTE whenever trying to write to an attribute that's readonly
475 		 */
476 		'!prop': function (property, value, error) {
477 			if (!this._fetched) {
478 				GCN.handleError(GCN.createError(
479 					'UNFETCHED_OBJECT_ACCESS',
480 					'Object not fetched yet.'
481 				), error);
482 				return;
483 			}
484 
485 			if (typeof value !== 'undefined') {
486 				// Check whether the property is writable
487 				if (jQuery.inArray(property, this.WRITEABLE_PROPS) >= 0) {
488 					// Check wether the property has a constraint and verify it
489 					var constraint = this.WRITEABLE_PROPS_CONSTRAINTS[property];
490 					if (constraint) {
491 						// verify maxLength
492 						if (constraint.maxLength && value.length >= constraint.maxLength) {
493 							var data = { name: property, value: value, maxLength: constraint.maxLength };
494 							var constraintError = GCN.createError('ATTRIBUTE_CONSTRAINT_VIOLATION',
495 								'Attribute "' + property + '" of ' + this._type +
496 								' is too long. The \'maxLength\' was set to {' + constraint.maxLength + '} ', data);
497 							GCN.handleError(constraintError, error);
498 							return;
499 						}
500 					}
501 					this._update(GCN.escapePropertyName(property), value);
502 				} else {
503 					GCN.handleError(GCN.createError('READONLY_ATTRIBUTE',
504 						'Attribute "' + property + '" of ' + this._type +
505 						' is read-only. Writeable properties are: ' +
506 						this.WRITEABLE_PROPS, this.WRITEABLE_PROPS), error);
507 					return;
508 				}
509 			}
510 
511 			return (
512 				(jQuery.type(this._shadow[property]) !== 'undefined'
513 					? this._shadow
514 					: this._data)[property]
515 			);
516 		},
517 
518 		/**
519 		 * Sends the a template string to the Aloha Servlet for rendering.
520 		 *
521 		 * @ignore
522 		 * @TODO: Consider making this function public.  At least one developer
523 		 *        has had need to render a custom template for a content
524 		 *        object.
525 		 *
526 		 * @private
527 		 * @param {string} template Template which will be rendered.
528 		 * @param {string} mode The rendering mode.  Valid values are "view",
529 		 *                      "edit", "pub."
530 		 * @param {function(object)} success A callback the receives the render
531 		 *                                   response.
532 		 * @param {function(GCNError):boolean} error Error handler.
533 		 */
534 		'!_renderTemplate' : function (template, mode, success, error) {
535 			var channelParam = GCN._getChannelParameter(this);
536 			var url = GCN.settings.BACKEND_PATH +
537 			        '/rest/' + this._type +
538 			        '/render/' + this.id() +
539 			        channelParam +
540 			        (channelParam ? '&' : '?') +
541 			        'edit=' + ('edit' === mode) +
542 			        '&template=' + encodeURIComponent(template);
543 			if (mode === 'edit') {
544 				url += '&links=' + encodeURIComponent(GCN.settings.linksRenderMode);
545 			}
546 			this._authAjax({
547 				url: url,
548 				error: error,
549 				success: success
550 			});
551 		},
552 
553 		/**
554 		 * Wrapper for internal chainback _ajax method.
555 		 * 
556 		 * @ignore
557 		 * @private
558 		 * @param {object<string, *>} settings Settings for the ajax request.
559 		 *                                     The settings object is identical
560 		 *                                     to that of the `GCN.ajax'
561 		 *                                     method, which handles the actual
562 		 *                                     ajax transportation.
563 		 * @throws AJAX_ERROR
564 		 */
565 		'!_ajax': function (settings) {
566 			var that = this;
567 
568 			// force no cache for all API calls
569 			settings.cache = false;
570 			settings.success = (function (onSuccess, onError) {
571 				return function (data) {
572 					// Ajax calls that do not target the REST API servlet do
573 					// not response data with a `responseInfo' object.
574 					// "/CNPortletapp/alohatag" is an example.  So we cannot
575 					// just assume that it exists.
576 					if (data.responseInfo) {
577 						switch (data.responseInfo.responseCode) {
578 						case 'OK':
579 							break;
580 						case 'AUTHREQUIRED':
581 							GCN.clearSession();
582 							that._authAjax(settings);
583 							return;
584 						default:
585 							GCN.handleResponseError(data, onError);
586 							return;
587 						}
588 					}
589 
590 					if (onSuccess) {
591 						onSuccess(data);
592 					}
593 				};
594 			}(settings.success, settings.error, settings.url));
595 
596 			this._queueAjax(settings);
597 		},
598 
599 		/**
600 		 * Concrete implementatation of _fulfill().
601 		 *
602 		 * Resolves all promises made by this content object while ensuring
603 		 * that circularReferences, (which are completely possible, and valid)
604 		 * do not result in infinit recursion.
605 		 *
606 		 * @override
607 		 */
608 		'!_fulfill': function (success, error, stack) {
609 			var obj = this;
610 			if (obj._chain) {
611 				var circularReference =
612 						stack && -1 < jQuery.inArray(obj._chain, stack);
613 				if (!circularReference) {
614 					stack = stack || [];
615 					stack.push(obj._chain);
616 					obj._fulfill(function () {
617 						obj._read(success, error);
618 					}, error, stack);
619 					return;
620 				}
621 			}
622 			obj._read(success, error);
623 		},
624 
625 		/**
626 		 * Similar to `_ajax', except that it prefixes the ajax url with the
627 		 * current session's `sid', and will trigger an
628 		 * `authentication-required' event if the session is not authenticated.
629 		 *
630 		 * @ignore
631 		 * @TODO(petro): Consider simplifiying this function signature to read:
632 		 *               `_auth( url, success, error )'
633 		 *
634 		 * @private
635 		 * @param {object<string, *>} settings Settings for the ajax request.
636 		 * @throws AUTHENTICATION_FAILED
637 		 */
638 		_authAjax: function (settings) {
639 			var that = this;
640 
641 			if (GCN.isAuthenticating) {
642 				GCN.afterNextAuthentication(function () {
643 					that._authAjax(settings);
644 				});
645 				return;
646 			}
647 
648 			if (!GCN.sid) {
649 				var cancel;
650 
651 				if (settings.error) {
652 					/**
653 					 * @ignore
654 					 */
655 					cancel = function (error) {
656 						GCN.handleError(
657 							error || GCN.createError('AUTHENTICATION_FAILED'),
658 							settings.error
659 						);
660 					};
661 				} else {
662 					/**
663 					 * @ignore
664 					 */
665 					cancel = function (error) {
666 						if (error) {
667 							GCN.error(error.code, error.message, error.data);
668 						} else {
669 							GCN.error('AUTHENTICATION_FAILED');
670 						}
671 					};
672 				}
673 
674 				GCN.afterNextAuthentication(function () {
675 					that._authAjax(settings);
676 				});
677 
678 				if (GCN.usingSSO) {
679 					// First, try to automatically authenticate via
680 					// Single-SignOn
681 					GCN.loginWithSSO(GCN.onAuthenticated, function () {
682 						// ... if SSO fails, then fallback to requesting user
683 						// credentials: broadcast `authentication-required'
684 						// message.
685 						GCN.authenticate(cancel);
686 					});
687 				} else {
688 					// Trigger the `authentication-required' event to request
689 					// user credentials.
690 					GCN.authenticate(cancel);
691 				}
692 
693 				return;
694 			}
695 
696 			// Append "?sid=..." or "&sid=..." if needed.
697 
698 			var urlFragment = settings.url.substr(
699 				GCN.settings.BACKEND_PATH.length
700 			);
701 			var isSidInUrl = /[\?\&]sid=/.test(urlFragment);
702 			if (!isSidInUrl) {
703 				var isFirstParam = (jQuery.inArray('?',
704 					urlFragment.split('')) === -1);
705 				settings.url += (isFirstParam ? '?' : '&') + 'sid='
706 				             +  (GCN.sid || '');
707 			}
708 
709 			this._ajax(settings);
710 		},
711 
712 		/**
713 		 * Recursively call `_continueWith()'.
714 		 *
715 		 * @ignore
716 		 * @private
717 		 * @override
718 		 */
719 		'!_onContinue': function (success, error) {
720 			var that = this;
721 			this._continueWith(function () {
722 				that._read(success, error);
723 			}, error);
724 		},
725 
726 		/**
727 		 * Initializes this content object.  If a `success' callback is
728 		 * provided, it will cause this object's data to be fetched and passed
729 		 * to the callback.  This object's data will be fetched from the cache
730 		 * if is available, otherwise it will be fetched from the server.  If
731 		 * this content object API contains parent chainbacks, it will get its
732 		 * parent to fetch its own data first.
733 		 *
734 		 * <p>
735 		 * Basic content object implementation which all other content objects
736 		 * will inherit from.
737 		 * </p>
738 		 * 
739 		 * <p>
740 		 * If a `success' callback is provided,
741 		 * it will cause this object's data to be fetched and passed to the
742 		 * callback. This object's data will be fetched from the cache if is
743 		 * available, otherwise it will be fetched from the server. If this
744 		 * content object API contains parent chainbacks, it will get its parent
745 		 * to fetch its own data first.
746 		 * </p>
747 		 * 
748 		 * <p>
749 		 * You might also provide an object for initialization, to directly
750 		 * instantiate the object's data without loading it from the server. To
751 		 * do so just pass in a data object as received from the server instead
752 		 * of an id--just make sure this object has an `id' property.
753 		 * </p>
754 		 * 
755 		 * <p>
756 		 * If an `error' handler is provided, as the third parameter, it will
757 		 * catch any errors that have occured since the invocation of this call.
758 		 * It allows the global error handler to be intercepted before stopping
759 		 * the error or allowing it to propagate on to the global handler.
760 		 * </p>
761 		 * 
762 		 * @class
763 		 * @name ContentObjectAPI
764 		 * @param {number|string|object}
765 		 *            id
766 		 * @param {function(ContentObjectAPI))=}
767 		 *            success Optional success callback that will receive this
768 		 *            object as its only argument.
769 		 * @param {function(GCNError):boolean=}
770 		 *            error Optional custom error handler.
771 		 * @param {object}
772 		 *            settings Basic settings for this object - depends on the
773 		 *            ContentObjetAPI Object used.
774 		 * @throws INVALID_DATA
775 		 *             If no id is found when providing an object for
776 		 *             initialization.
777 		 */
778 		_init: function (data, success, error, settings) {
779 			this._settings = settings;
780 			var id;
781 
782 			if (jQuery.type(data) === 'object') {
783 				if (data.multichannelling) {
784 					this.multichannelling = data;
785 					// Remove the inherited object from the chain.
786 					if (this._chain) {
787 						this._chain = this._chain._chain;
788 					}
789 					id = this.multichannelling.derivedFrom.id();
790 				} else {
791 					if (!data.id) {
792 						var err = GCN.createError(
793 							'INVALID_DATA',
794 							'Data not sufficient for initalization: id is missing',
795 							data
796 						);
797 						GCN.handleError(err, error);
798 						return;
799 					}
800 					this._data = data;
801 					this._fetched = true;
802 					if (success) {
803 						this._invoke(success, [this]);
804 					}
805 					return;
806 				}
807 			} else {
808 				id = data;
809 			}
810 
811 			// Ensure that each object has its very own `_data' and `_shadow'
812 			// objects.
813 			if (!this._fetched) {
814 				this._data = {};
815 				this._shadow = {};
816 				this._data.id = id;
817 			}
818 			if (success) {
819 				this._read(success, error);
820 			}
821 		},
822 
823 		/**
824 		 * <p>
825 		 * Replaces tag blocks and editables with appropriate "<node *>"
826 		 * notation in a given string. Given an element whose innerHTML is:
827 		 *
828 		 * <pre>
829 		 *		<span id="GENTICS_BLOCK_123">My Tag</span>
830 		 * </pre>
831 		 *
832 		 * <p>
833 		 * encode() will return:
834 		 *
835 		 * <pre>
836 		 *		<node 123>
837 		 * </pre>
838 		 *
839 		 * @name encode
840 		 * @function
841 		 * @memberOf ContentObjectAPI
842 		 * @param {!jQuery} $element
843 		 *       An element whose contents are to be encoded.
844 		 * @param {?function(!Element): string} serializeFn
845 		 *       A function that returns the serialized contents of the
846 		 *       given element as a HTML string, excluding the start and end
847 		 *       tag of the element. If not provided, jQuery.html() will
848 		 *       be used.
849 		 * @return {string} The encoded HTML string.
850 		 */
851 		'!encode': function ($element, serializeFn) {
852 			var $clone = $element.clone();
853 			var id;
854 			var $block;
855 			var tags = jQuery.extend({}, this._blocks, this._editables);
856 			for (id in tags) {
857 				if (tags.hasOwnProperty(id)) {
858 					$block = $clone.find('#' + tags[id].element);
859 					if ($block.length) {
860 						// Empty all content blocks of their innerHTML.
861 						$block.html('').attr('id', BLOCK_ENCODING_PREFIX +
862 							tags[id].tagname);
863 					}
864 				}
865 			}
866 			serializeFn = serializeFn || function ($element) {
867 				return jQuery($element).html();
868 			};
869 			var html = serializeFn($clone[0]);
870 			return html.replace(CONTENT_BLOCK, function (substr, match) {
871 				return '<node ' + match + '>';
872 			});
873 		},
874 
875 		/**
876 		 * For a given string, replace all occurances of "<node>" with
877 		 * appropriate HTML markup, allowing notated tags to be rendered within
878 		 * the surrounding HTML content.
879 		 *
880 		 * The success() handler will receives a string containing the contents
881 		 * of the `str' string with references to "<node>" having been inflated
882 		 * into their appropriate tag rendering.
883 		 *
884 		 * @name decode
885 		 * @function
886 		 * @memberOf ContentObjectAPI
887 		 * @param {string} str The content string, in which  "<node *>" tags
888 		 *                     will be inflated with their HTML rendering.
889 		 * @param {function(ContentObjectAPI))} success Success callback that
890 		 *                                              will receive the
891 		 *                                              decoded string.
892 		 * @param {function(GCNError):boolean=} error Optional custom error
893 		 *                                            handler.
894 		 */
895 		'!decode': function (str, success, error) {
896 			if (!success) {
897 				return;
898 			}
899 
900 			var prefix = 'gcn-tag-placeholder-';
901 			var toRender = [];
902 			var html = replaceNodeTags(str, function (name, offset, str) {
903 				toRender.push('<node ', name, '>');
904 				return '<div id="' + prefix + name + '"></div>';
905 			});
906 
907 			if (!toRender.length) {
908 				success(html);
909 				return;
910 			}
911 
912 			// Instead of rendering each tag individually, we render them
913 			// together in one string, and map the results back into our
914 			// original html string.  This allows us to perform one request to
915 			// the server for any number of node tags found.
916 
917 			var parsed = jQuery('<div>' + html + '</div>');
918 			var template = toRender.join('');
919 			var that = this;
920 
921 			this._renderTemplate(template, 'edit', function (data) {
922 				var content = data.content;
923 				var tag;
924 				var tags = data.tags;
925 				var j = tags.length;
926 				var rendered = jQuery('<div>' + content + '</div>');
927 
928 				var replaceTag = (function (numTags) {
929 					return function (tag) {
930 						parsed.find('#' + prefix + tag.prop('name'))
931 							.replaceWith(
932 								rendered.find('#' + tag.prop('id'))
933 							);
934 
935 						if (0 === --numTags) {
936 							success(parsed.html());
937 						}
938 					};
939 				}(j));
940 
941 				while (j) {
942 					that.tag(tags[--j], replaceTag);
943 				}
944 			}, error);
945 		},
946 
947 		/**
948 		 * Clears this object from its constructor's cache so that the next
949 		 * attempt to access this object will result in a brand new instance
950 		 * being initialized and placed in the cache.
951 		 *
952 		 * @name clear
953 		 * @function
954 		 * @memberOf ContentObjectAPI
955 		 */
956 		'!clear': function () {
957 			// Do not clear the id from the _data.
958 			var id = this._data.id;
959 			this._data = {};
960 			this._data.id = id;
961 			this._shadow = {};
962 			this._fetched = false;
963 			this._clearCache();
964 		},
965 
966 		/**
967 		 * Retrieves this objects parent folder.
968 		 * 
969 		 * @name folder
970 		 * @function
971 		 * @memberOf ContentObjectAPI
972 		 * @param {function(FolderAPI)=}
973 		 *            success Callback that will receive the requested object.
974 		 * @param {function(GCNError):boolean=}
975 		 *            error Custom error handler.
976 		 * @return {FolderAPI} API object for the retrieved GCN folder.
977 		 */
978 		'!folder': function (success, error) {
979 			return this._continue(GCN.FolderAPI, this._data.folderId, success,
980 				error);
981 		},
982 
983 		/**
984 		 * Saves changes made to this content object to the backend.
985 		 * 
986 		 * @param {object=}
987 		 *            settings Optional settings to pass on to the ajax
988 		 *            function.
989 		 * @param {function(ContentObjectAPI)=}
990 		 *            success Optional callback that receives this object as its
991 		 *            only argument.
992 		 * @param {function(GCNError):boolean=}
993 		 *            error Optional customer error handler.
994 		 */
995 		save: function () {
996 			var settings;
997 			var success;
998 			var error;
999 			var args = Array.prototype.slice.call(arguments);
1000 			var len = args.length;
1001 			var i;
1002 
1003 			for (i = 0; i < len; ++i) {
1004 				switch (jQuery.type(args[i])) {
1005 				case 'object':
1006 					if (!settings) {
1007 						settings = args[i];
1008 					}
1009 					break;
1010 				case 'function':
1011 					if (!success) {
1012 						success = args[i];
1013 					} else {
1014 						error = args[i];
1015 					}
1016 					break;
1017 				case 'undefined':
1018 					break;
1019 				default:
1020 					var err = GCN.createError('UNKNOWN_ARGUMENT',
1021 						'Don\'t know what to do with arguments[' + i + '] ' +
1022 						'value: "' + args[i] + '"', args);
1023 					GCN.handleError(err, error);
1024 					return;
1025 				}
1026 			}
1027 
1028 			this._save(settings, success, error);
1029 		},
1030 
1031 		/**
1032 		 * Persists this object's local data onto the server.  If the object
1033 		 * has not yet been fetched we need to get it first so we can update
1034 		 * its internals properly...
1035 		 *
1036 		 * @private
1037 		 * @param {object} settings Object which will extend the basic
1038 		 *                          settings of the ajax call
1039 		 * @param {function(ContentObjectAPI)=} success Optional callback that
1040 		 *                                              receives this object as
1041 		 *                                              its only argument.
1042 		 * @param {function(GCNError):boolean=} error Optional customer error
1043 		 *                                            handler.
1044 		 */
1045 		'!_save': function (settings, success, error) {
1046 			var obj = this;
1047 			this._fulfill(function () {
1048 				GCN.pub(obj._type + '.before-save');
1049 				obj._persist(settings, success, error);
1050 			}, error);
1051 		},
1052 
1053 		/**
1054 		 * Returns the bare data structure of this content object.
1055 		 * To be used for creating the save POST body data.
1056 		 *
1057 		 * @param {object<string, *>} Plain old object representation of this
1058 		 *                            content object.
1059 		 */
1060 		'!json': function () {
1061 			var json = {};
1062 
1063 			if (this._deletedTags.length) {
1064 				json['delete'] = this._deletedTags;
1065 			}
1066 
1067 			if (this._deletedBlocks.length) {
1068 				json['delete'] = json['delete']
1069 				               ? json['delete'].concat(this._deletedBlocks)
1070 				               : this._deletedBlocks;
1071 			}
1072 
1073 			json[this._type] = jQuery.extend(true, {}, this._shadow);
1074 			json[this._type].id = this._data.id;
1075 			return json;
1076 		},
1077 
1078 		/**
1079 		 * Sends the current state of this content object to be stored on the
1080 		 * server.
1081 		 *
1082 		 * @private
1083 		 * @param {function(ContentObjectAPI)=} success Optional callback that
1084 		 *                                              receives this object as
1085 		 *                                              its only argument.
1086 		 * @param {function(GCNError):boolean=} error Optional customer error
1087 		 *                                            handler.
1088 		 * @throws HTTP_ERROR
1089 		 */
1090 		_persist: function (settings, success, error) {
1091 			var that = this;
1092 
1093 			if (!this._fetched) {
1094 				this._read(function () {
1095 					that._persist(settings, success, error);
1096 				}, error);
1097 				return;
1098 			}
1099 
1100 			this._authAjax({
1101 				url   : GCN.settings.BACKEND_PATH + '/rest/'
1102 				        + this._type + '/save/' + this.id()
1103 				        + GCN._getChannelParameter(this),
1104 				type  : 'POST',
1105 				error : error,
1106 				json  : jQuery.extend(this.json(), settings),
1107 				success : function (response) {
1108 					// We must not overwrite the `_data.tags' object with this
1109 					// one.
1110 					delete that._shadow.tags;
1111 
1112 					// Everything else in `_shadow' should be written over to
1113 					// `_data' before resetting the `_shadow' object.
1114 					jQuery.extend(that._data, that._shadow);
1115 					that._shadow = {};
1116 					that._deletedTags = [];
1117 					that._deletedBlocks = [];
1118 
1119 					if (success) {
1120 						that._invoke(success, [that]);
1121 					}
1122 				}
1123 			});
1124 		},
1125 
1126 		/**
1127 		 * Deletes this content object from its containing parent.
1128 		 * 
1129 		 * @param {function(ContentObjectAPI)=}
1130 		 *            success Optional callback that receives this object as its
1131 		 *            only argument.
1132 		 * @param {function(GCNError):boolean=}
1133 		 *            error Optional customer error handler.
1134 		 */
1135 		remove: function (success, error) {
1136 			this._remove(success, error);
1137 		},
1138 
1139 		/**
1140 		 * Get a channel-local copy of this content object.
1141 		 *
1142 		 * @public
1143 		 * @function
1144 		 * @name localize
1145 		 * @memberOf ContentObjectAPI
1146 		 * @param {funtion(ContentObjectAPI)=} success Optional callback to
1147 		 *                                             receive this content
1148 		 *                                             object as the only
1149 		 *                                             argument.
1150 		 * @param {function(GCNError):boolean=} error Optional custom error
1151 		 *                                            handler.
1152 		 */
1153 		'!localize': function (success, error) {
1154 			if (!this._channel && !GCN.channel()) {
1155 				var err = GCN.createError(
1156 					'NO_CHANNEL_ID_SET',
1157 					'No channel is set in which to get the localized object',
1158 					GCN
1159 				);
1160 				GCN.handleError(err, error);
1161 				return false;
1162 			}
1163 			var local = this._continue(
1164 				this._constructor,
1165 				{
1166 					derivedFrom: this,
1167 					multichannelling: true,
1168 					read: GCN.multichannelling.localize
1169 				},
1170 				success,
1171 				error
1172 			);
1173 			return local;
1174 		},
1175 
1176 		/**
1177 		 * Remove this channel-local object, and delete its local copy in the
1178 		 * backend.
1179 		 *
1180 		 * @public
1181 		 * @function
1182 		 * @name unlocalize
1183 		 * @memberOf ContentObjectAPI
1184 		 * @param {funtion(ContentObjectAPI)=} success Optional callback to
1185 		 *                                             receive this content
1186 		 *                                             object as the only
1187 		 *                                             argument.
1188 		 * @param {function(GCNError):boolean=} error Optional custom error
1189 		 *                                            handler.
1190 		 */
1191 		'!unlocalize': function (success, error) {
1192 			if (!this._channel && !GCN.channel()) {
1193 				var err = GCN.createError(
1194 					'NO_CHANNEL_ID_SET',
1195 					'No channel is set in which to get the unlocalized object',
1196 					GCN
1197 				);
1198 				GCN.handleError(err, error);
1199 				return false;
1200 			}
1201 			var placeholder = {
1202 				multichannelling: {
1203 					derivedFrom: this
1204 				}
1205 			};
1206 			var that = this;
1207 			GCN.multichannelling.unlocalize(placeholder, function () {
1208 				// TODO: This should be done inside of
1209 				// multichannelling.unlocalize() and not in this callback.
1210 				// Clean cache & reset object to make sure it can't be used
1211 				// properly any more.
1212 				that._clearCache();
1213 				that._data = {};
1214 				that._shadow = {};
1215 				if (success) {
1216 					success();
1217 				}
1218 			}, error);
1219 		},
1220 
1221 		/**
1222 		 * Performs a REST API request to delete this object from the server.
1223 		 *
1224 		 * @private
1225 		 * @param {function()=} success Optional callback that
1226 		 *                                              will be invoked once
1227 		 *                                              this object has been
1228 		 *                                              removed.
1229 		 * @param {function(GCNError):boolean=} error Optional customer error
1230 		 *                                            handler.
1231 		 */
1232 		'!_remove': function (success, error) {
1233 			var that = this;
1234 			this._authAjax({
1235 				url     : GCN.settings.BACKEND_PATH + '/rest/'
1236 				          + this._type + '/delete/' + this.id()
1237 				          + GCN._getChannelParameter(that),
1238 				type    : 'POST',
1239 				error   : error,
1240 				success : function (response) {
1241 					// Clean cache & reset object to make sure it can't be used
1242 					// properly any more.
1243 					that._clearCache();
1244 					that._data = {};
1245 					that._shadow = {};
1246 
1247 					// Don't forward the object to the success handler since
1248 					// it's been deleted.
1249 					if (success) {
1250 						that._invoke(success);
1251 					}
1252 				}
1253 			});
1254 		},
1255 
1256 		/**
1257 		 * Removes any additionaly data stored on this objec which pertains to
1258 		 * a tag matching the given tagname.  This function will be called when
1259 		 * a tag is being removed in order to bring the content object to a
1260 		 * consistant state.
1261 		 * Should be overriden by subclasses.
1262 		 *
1263 		 * @param {string} tagid The Id of the tag whose associated data we
1264 		 *                       want we want to remove.
1265 		 */
1266 		'!_removeAssociatedTagData': function (tagname) {}
1267 
1268 	});
1269 
1270 	GCN.ContentObjectAPI.update = update;
1271 
1272 	/**
1273 	 * Generates a factory method for chainback classes.  The method signature
1274 	 * used with this factory function will match that of the target class'
1275 	 * constructor.  Therefore this function is expected to be invoked with the
1276 	 * follow combination of arguments ...
1277 	 *
1278 	 * Examples for GCN.pages api:
1279 	 *
1280 	 * To get an array containing 1 page:
1281 	 * pages(1)
1282 	 * pages(1, function () {})
1283 	 *
1284 	 * To get an array containing 2 pages:
1285 	 * pages([1, 2])
1286 	 * pages([1, 2], function () {})
1287 	 *
1288 	 * To get an array containing any and all pages:
1289 	 * pages()
1290 	 * pages(function () {})
1291 	 *
1292 	 * To get an array containing no pages:
1293 	 * pages([])
1294 	 * pages([], function () {});
1295 	 *
1296 	 * @param {Chainback} ctor The Chainback constructor we want to expose.
1297 	 * @throws UNKNOWN_ARGUMENT
1298 	 */
1299 	GCN.exposeAPI = function (ctor) {
1300 		return function () {
1301 			// Convert arguments into an array
1302 			// https://developer.mozilla.org/en/JavaScript/Reference/...
1303 			// ...Functions_and_function_scope/arguments
1304 			var args = Array.prototype.slice.call(arguments);
1305 			var id;
1306 			var ids;
1307 			var success;
1308 			var error;
1309 			var settings;
1310 
1311 			// iterate over arguments to find id || ids, succes, error and
1312 			// settings
1313 			jQuery.each(args, function (i, arg) {
1314 				switch (jQuery.type(arg)) {
1315 				// set id
1316 				case 'string':
1317 				case 'number':
1318 					if (!id && !ids) {
1319 						id = arg;
1320 					} else {
1321 						GCN.error('UNKNOWN_ARGUMENT',
1322 							'id is already set. Don\'t know what to do with ' +
1323 							'arguments[' + i + '] value: "' + arg + '"');
1324 					}
1325 					break;
1326 				// set ids
1327 				case 'array':
1328 					if (!id && !ids) {
1329 						ids = args[0];
1330 					} else {
1331 						GCN.error('UNKNOWN_ARGUMENT',
1332 							'ids is already set. Don\'t know what to do with' +
1333 							' arguments[' + i + '] value: "' + arg + '"');
1334 					}
1335 					break;
1336 				// success and error handlers
1337 				case 'function':
1338 					if (!success) {
1339 						success = arg;
1340 					} else if (success && !error) {
1341 						error = arg;
1342 					} else {
1343 						GCN.error('UNKNOWN_ARGUMENT',
1344 							'success and error handler already set. Don\'t ' +
1345 							'know what to do with arguments[' + i + ']');
1346 					}
1347 					break;
1348 				// settings
1349 				case 'object':
1350 					if (!id && !ids) {
1351 						id = arg;
1352 					} else if (!settings) {
1353 						settings = arg;
1354 					} else {
1355 						GCN.error('UNKNOWN_ARGUMENT',
1356 							'settings are already present. Don\'t know what ' +
1357 							'to do with arguments[' + i + '] value:' + ' "' +
1358 							arg + '"');
1359 					}
1360 					break;
1361 				default:
1362 					GCN.error('UNKNOWN_ARGUMENT',
1363 						'Don\'t know what to do with arguments[' + i +
1364 						'] value: "' + arg + '"');
1365 				}
1366 			});
1367 
1368 			// Prepare a new set of arguments to pass on during initialzation
1369 			// of callee object.
1370 			args = [];
1371 
1372 			// settings should always be an object, even if it's just empty
1373 			if (!settings) {
1374 				settings = {};
1375 			}
1376 
1377 			args[0] = (typeof id !== 'undefined') ? id : ids;
1378 			args[1] = success || settings.success || null;
1379 			args[2] = error || settings.error || null;
1380 			args[3] = settings;
1381 
1382 			// We either add 0 (no channel) or the channelid to the hash
1383 			var channel = GCN.settings.channel;
1384 
1385 			// Check if the value is false, and set it to 0 in this case
1386 			if (!channel) {
1387 				channel = 0;
1388 			}
1389 
1390 			var hash = (id || ids)
1391 			         ? ctor._makeHash(channel + '/' + (ids ? ids.sort().join(',') : id))
1392 			         : null;
1393 
1394 			return GCN.getChainback(ctor, hash, null, args);
1395 		};
1396 
1397 	};
1398 
1399 }(GCN));
1400