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 adds any new data 440 * in the internal `_data' object. 441 * 442 * Note that data already present in `_data' will not be removed or 443 * overwritten. 444 * 445 * @private 446 * @param {object} data Parsed JSON response data. 447 */ 448 '!_processResponse': function (data) { 449 this._data = jQuery.extend(true, {}, data[this._type], this._data); 450 }, 451 452 /** 453 * Specifies a list of parameters that will be added to the url when 454 * loading the content object from the server. 455 * 456 * @private 457 * @return {object} object With parameters to be appended to the load 458 * request 459 */ 460 '!_loadParams': function () {}, 461 462 /** 463 * Reads the property `property' of this content object if this 464 * property is among those in the WRITEABLE_PROPS array. If a second 465 * argument is provided, them the property is updated with that value. 466 * 467 * @name prop 468 * @function 469 * @memberOf ContentObjectAPI 470 * @param {String} property Name of the property to be read or updated. 471 * @param {String} value Optional value to set property to. If omitted the property will just be read. 472 * @param {function(GCNError):boolean=} error Custom error handler to 473 * stop error propagation for this 474 * synchronous call. 475 * @return {?*} Meta attribute. 476 * @throws UNFETCHED_OBJECT_ACCESS if the object has not been fetched from the server yet 477 * @throws READONLY_ATTRIBUTE whenever trying to write to an attribute that's readonly 478 */ 479 '!prop': function (property, value, error) { 480 if (!this._fetched) { 481 GCN.handleError(GCN.createError( 482 'UNFETCHED_OBJECT_ACCESS', 483 'Object not fetched yet.' 484 ), error); 485 return; 486 } 487 488 if (typeof value !== 'undefined') { 489 // Check whether the property is writable 490 if (jQuery.inArray(property, this.WRITEABLE_PROPS) >= 0) { 491 // Check wether the property has a constraint and verify it 492 var constraint = this.WRITEABLE_PROPS_CONSTRAINTS[property]; 493 if (constraint) { 494 // verify maxLength 495 if (constraint.maxLength && value.length >= constraint.maxLength) { 496 var data = { name: property, value: value, maxLength: constraint.maxLength }; 497 var constraintError = GCN.createError('ATTRIBUTE_CONSTRAINT_VIOLATION', 498 'Attribute "' + property + '" of ' + this._type + 499 ' is too long. The \'maxLength\' was set to {' + constraint.maxLength + '} ', data); 500 GCN.handleError(constraintError, error); 501 return; 502 } 503 } 504 this._update(GCN.escapePropertyName(property), value); 505 } else { 506 GCN.handleError(GCN.createError('READONLY_ATTRIBUTE', 507 'Attribute "' + property + '" of ' + this._type + 508 ' is read-only. Writeable properties are: ' + 509 this.WRITEABLE_PROPS, this.WRITEABLE_PROPS), error); 510 return; 511 } 512 } 513 514 return ( 515 (jQuery.type(this._shadow[property]) !== 'undefined' 516 ? this._shadow 517 : this._data)[property] 518 ); 519 }, 520 521 /** 522 * Sends the a template string to the Aloha Servlet for rendering. 523 * 524 * @ignore 525 * @TODO: Consider making this function public. At least one developer 526 * has had need to render a custom template for a content 527 * object. 528 * 529 * @private 530 * @param {string} template Template which will be rendered. 531 * @param {string} mode The rendering mode. Valid values are "view", 532 * "edit", "pub." 533 * @param {function(object)} success A callback the receives the render 534 * response. 535 * @param {function(GCNError):boolean} error Error handler. 536 */ 537 '!_renderTemplate' : function (template, mode, success, error) { 538 var channelParam = GCN._getChannelParameter(this); 539 var url = GCN.settings.BACKEND_PATH + 540 '/rest/' + this._type + 541 '/render' + 542 channelParam + 543 (channelParam ? '&' : '?') + 544 'edit=' + ('edit' === mode) + 545 '&template=' + encodeURIComponent(template); 546 if (mode === 'edit') { 547 url += '&links=' + encodeURIComponent(GCN.settings.linksRenderMode); 548 } 549 var jsonData = jQuery.extend({}, this._data); 550 // remove some data, we don't want to serialize and POST to the server 551 jsonData.pageVariants = null; 552 jsonData.languageVariants = null; 553 this._authAjax({ 554 type: 'POST', 555 json: jsonData, 556 url: url, 557 error: error, 558 success: success 559 }); 560 }, 561 562 /** 563 * Wrapper for internal chainback _ajax method. 564 * 565 * @ignore 566 * @private 567 * @param {object<string, *>} settings Settings for the ajax request. 568 * The settings object is identical 569 * to that of the `GCN.ajax' 570 * method, which handles the actual 571 * ajax transportation. 572 * @throws AJAX_ERROR 573 */ 574 '!_ajax': function (settings) { 575 var that = this; 576 577 // force no cache for all API calls 578 settings.cache = false; 579 settings.success = (function (onSuccess, onError) { 580 return function (data) { 581 // Ajax calls that do not target the REST API servlet do 582 // not response data with a `responseInfo' object. 583 // "/CNPortletapp/alohatag" is an example. So we cannot 584 // just assume that it exists. 585 if (data.responseInfo) { 586 switch (data.responseInfo.responseCode) { 587 case 'OK': 588 break; 589 case 'AUTHREQUIRED': 590 GCN.clearSession(); 591 that._authAjax(settings); 592 return; 593 default: 594 // Since GCN.handleResponseError can throw an error, 595 // we pass this function to _invoke, so the error is caught, 596 // remembered and thrown in the end. 597 that._invoke(GCN.handleResponseError, [data, onError]); 598 return; 599 } 600 } 601 602 if (onSuccess) { 603 onSuccess(data); 604 } 605 }; 606 }(settings.success, settings.error, settings.url)); 607 608 this._queueAjax(settings); 609 }, 610 611 /** 612 * Concrete implementatation of _fulfill(). 613 * 614 * Resolves all promises made by this content object while ensuring 615 * that circularReferences, (which are completely possible, and valid) 616 * do not result in infinit recursion. 617 * 618 * @override 619 */ 620 '!_fulfill': function (success, error, stack) { 621 var obj = this; 622 if (obj._chain) { 623 var circularReference = 624 stack && -1 < jQuery.inArray(obj._chain, stack); 625 if (!circularReference) { 626 stack = stack || []; 627 stack.push(obj._chain); 628 obj._fulfill(function () { 629 obj._read(success, error); 630 }, error, stack); 631 return; 632 } 633 } 634 obj._read(success, error); 635 }, 636 637 /** 638 * Similar to `_ajax', except that it prefixes the ajax url with the 639 * current session's `sid', and will trigger an 640 * `authentication-required' event if the session is not authenticated. 641 * 642 * @ignore 643 * @TODO(petro): Consider simplifiying this function signature to read: 644 * `_auth( url, success, error )' 645 * 646 * @private 647 * @param {object<string, *>} settings Settings for the ajax request. 648 * @throws AUTHENTICATION_FAILED 649 */ 650 _authAjax: function (settings) { 651 var that = this; 652 653 if (GCN.isAuthenticating) { 654 GCN.afterNextAuthentication(function () { 655 that._authAjax(settings); 656 }); 657 return; 658 } 659 660 if (!GCN.sid) { 661 var cancel; 662 663 if (settings.error) { 664 /** 665 * @ignore 666 */ 667 cancel = function (error) { 668 GCN.handleError( 669 error || GCN.createError('AUTHENTICATION_FAILED'), 670 settings.error 671 ); 672 }; 673 } else { 674 /** 675 * @ignore 676 */ 677 cancel = function (error) { 678 if (error) { 679 GCN.error(error.code, error.message, error.data); 680 } else { 681 GCN.error('AUTHENTICATION_FAILED'); 682 } 683 }; 684 } 685 686 GCN.afterNextAuthentication(function () { 687 that._authAjax(settings); 688 }); 689 690 if (GCN.usingSSO) { 691 // First, try to automatically authenticate via 692 // Single-SignOn 693 GCN.loginWithSSO(GCN.onAuthenticated, function () { 694 // ... if SSO fails, then fallback to requesting user 695 // credentials: broadcast `authentication-required' 696 // message. 697 GCN.authenticate(cancel); 698 }); 699 } else { 700 // Trigger the `authentication-required' event to request 701 // user credentials. 702 GCN.authenticate(cancel); 703 } 704 705 return; 706 } 707 708 // Append "?sid=..." or "&sid=..." if needed. 709 710 var urlFragment = settings.url.substr( 711 GCN.settings.BACKEND_PATH.length 712 ); 713 var isSidInUrl = /[\?\&]sid=/.test(urlFragment); 714 if (!isSidInUrl) { 715 var isFirstParam = (jQuery.inArray('?', 716 urlFragment.split('')) === -1); 717 settings.url += (isFirstParam ? '?' : '&') + 'sid=' 718 + (GCN.sid || ''); 719 } 720 721 this._ajax(settings); 722 }, 723 724 /** 725 * Recursively call `_continueWith()'. 726 * 727 * @ignore 728 * @private 729 * @override 730 */ 731 '!_onContinue': function (success, error) { 732 var that = this; 733 this._continueWith(function () { 734 that._read(success, error); 735 }, error); 736 }, 737 738 /** 739 * Initializes this content object. If a `success' callback is 740 * provided, it will cause this object's data to be fetched and passed 741 * to the callback. This object's data will be fetched from the cache 742 * if is available, otherwise it will be fetched from the server. If 743 * this content object API contains parent chainbacks, it will get its 744 * parent to fetch its own data first. 745 * 746 * <p> 747 * Basic content object implementation which all other content objects 748 * will inherit from. 749 * </p> 750 * 751 * <p> 752 * If a `success' callback is provided, 753 * it will cause this object's data to be fetched and passed to the 754 * callback. This object's data will be fetched from the cache if is 755 * available, otherwise it will be fetched from the server. If this 756 * content object API contains parent chainbacks, it will get its parent 757 * to fetch its own data first. 758 * </p> 759 * 760 * <p> 761 * You might also provide an object for initialization, to directly 762 * instantiate the object's data without loading it from the server. To 763 * do so just pass in a data object as received from the server instead 764 * of an id--just make sure this object has an `id' property. 765 * </p> 766 * 767 * <p> 768 * If an `error' handler is provided, as the third parameter, it will 769 * catch any errors that have occured since the invocation of this call. 770 * It allows the global error handler to be intercepted before stopping 771 * the error or allowing it to propagate on to the global handler. 772 * </p> 773 * 774 * @class 775 * @name ContentObjectAPI 776 * @param {number|string|object} 777 * id 778 * @param {function(ContentObjectAPI))=} 779 * success Optional success callback that will receive this 780 * object as its only argument. 781 * @param {function(GCNError):boolean=} 782 * error Optional custom error handler. 783 * @param {object} 784 * settings Basic settings for this object - depends on the 785 * ContentObjetAPI Object used. 786 * @throws INVALID_DATA 787 * If no id is found when providing an object for 788 * initialization. 789 */ 790 _init: function (data, success, error, settings) { 791 this._settings = settings; 792 var id; 793 794 if (jQuery.type(data) === 'object') { 795 if (data.multichannelling) { 796 this.multichannelling = data; 797 // Remove the inherited object from the chain. 798 if (this._chain) { 799 this._chain = this._chain._chain; 800 } 801 id = this.multichannelling.derivedFrom.id(); 802 } else { 803 if (!data.id) { 804 var err = GCN.createError( 805 'INVALID_DATA', 806 'Data not sufficient for initalization: id is missing', 807 data 808 ); 809 GCN.handleError(err, error); 810 return; 811 } 812 this._data = data; 813 this._fetched = true; 814 if (success) { 815 this._invoke(success, [this]); 816 } 817 return; 818 } 819 } else { 820 id = data; 821 } 822 823 // Ensure that each object has its very own `_data' and `_shadow' 824 // objects. 825 if (!this._fetched) { 826 this._data = {}; 827 this._shadow = {}; 828 this._data.id = id; 829 } 830 if (success) { 831 this._read(success, error); 832 } 833 }, 834 835 /** 836 * <p> 837 * Replaces tag blocks and editables with appropriate "<node *>" 838 * notation in a given string. Given an element whose innerHTML is: 839 * 840 * <pre> 841 * <span id="GENTICS_BLOCK_123">My Tag</span> 842 * </pre> 843 * 844 * <p> 845 * encode() will return: 846 * 847 * <pre> 848 * <node 123> 849 * </pre> 850 * 851 * @name encode 852 * @function 853 * @memberOf ContentObjectAPI 854 * @param {!jQuery} $element 855 * An element whose contents are to be encoded. 856 * @param {?function(!Element): string} serializeFn 857 * A function that returns the serialized contents of the 858 * given element as a HTML string, excluding the start and end 859 * tag of the element. If not provided, jQuery.html() will 860 * be used. 861 * @return {string} The encoded HTML string. 862 */ 863 '!encode': function ($element, serializeFn) { 864 var $clone = $element.clone(); 865 var id; 866 var $block; 867 var tags = jQuery.extend({}, this._blocks, this._editables); 868 for (id in tags) { 869 if (tags.hasOwnProperty(id)) { 870 $block = $clone.find('#' + tags[id].element); 871 if ($block.length) { 872 // Empty all content blocks of their innerHTML. 873 $block.html('').attr('id', BLOCK_ENCODING_PREFIX + 874 tags[id].tagname); 875 } 876 } 877 } 878 serializeFn = serializeFn || function ($element) { 879 return jQuery($element).html(); 880 }; 881 var html = serializeFn($clone[0]); 882 return html.replace(CONTENT_BLOCK, function (substr, match) { 883 return '<node ' + match + '>'; 884 }); 885 }, 886 887 /** 888 * For a given string, replace all occurances of "<node>" with 889 * appropriate HTML markup, allowing notated tags to be rendered within 890 * the surrounding HTML content. 891 * 892 * The success() handler will receives a string containing the contents 893 * of the `str' string with references to "<node>" having been inflated 894 * into their appropriate tag rendering. 895 * 896 * @name decode 897 * @function 898 * @memberOf ContentObjectAPI 899 * @param {string} str The content string, in which "<node *>" tags 900 * will be inflated with their HTML rendering. 901 * @param {function(ContentObjectAPI))} success Success callback that 902 * will receive the 903 * decoded string. 904 * @param {function(GCNError):boolean=} error Optional custom error 905 * handler. 906 */ 907 '!decode': function (str, success, error) { 908 if (!success) { 909 return; 910 } 911 912 var prefix = 'gcn-tag-placeholder-'; 913 var toRender = []; 914 var html = replaceNodeTags(str, function (name, offset, str) { 915 toRender.push('<node ', name, '>'); 916 return '<div id="' + prefix + name + '"></div>'; 917 }); 918 919 if (!toRender.length) { 920 success(html); 921 return; 922 } 923 924 // Instead of rendering each tag individually, we render them 925 // together in one string, and map the results back into our 926 // original html string. This allows us to perform one request to 927 // the server for any number of node tags found. 928 929 var parsed = jQuery('<div>' + html + '</div>'); 930 var template = toRender.join(''); 931 var that = this; 932 933 this._renderTemplate(template, 'edit', function (data) { 934 var content = data.content; 935 var tag; 936 var tags = data.tags; 937 var j = tags.length; 938 var rendered = jQuery('<div>' + content + '</div>'); 939 940 var replaceTag = (function (numTags) { 941 return function (tag) { 942 parsed.find('#' + prefix + tag.prop('name')) 943 .replaceWith( 944 rendered.find('#' + tag.prop('id')) 945 ); 946 947 if (0 === --numTags) { 948 success(parsed.html()); 949 } 950 }; 951 }(j)); 952 953 while (j) { 954 that.tag(tags[--j], replaceTag); 955 } 956 }, error); 957 }, 958 959 /** 960 * Clears this object from its constructor's cache so that the next 961 * attempt to access this object will result in a brand new instance 962 * being initialized and placed in the cache. 963 * 964 * @name clear 965 * @function 966 * @memberOf ContentObjectAPI 967 */ 968 '!clear': function () { 969 // Do not clear the id from the _data. 970 var id = this._data.id; 971 this._data = {}; 972 this._data.id = id; 973 this._shadow = {}; 974 this._fetched = false; 975 this._clearCache(); 976 }, 977 978 /** 979 * Retrieves this objects parent folder. 980 * 981 * @name folder 982 * @function 983 * @memberOf ContentObjectAPI 984 * @param {function(FolderAPI)=} 985 * success Callback that will receive the requested object. 986 * @param {function(GCNError):boolean=} 987 * error Custom error handler. 988 * @return {FolderAPI} API object for the retrieved GCN folder. 989 */ 990 '!folder': function (success, error) { 991 return this._continue(GCN.FolderAPI, this._data.folderId, success, 992 error); 993 }, 994 995 /** 996 * Saves changes made to this content object to the backend. 997 * 998 * @param {object=} 999 * settings Optional settings to pass on to the ajax 1000 * function. 1001 * @param {function(ContentObjectAPI)=} 1002 * success Optional callback that receives this object as its 1003 * only argument. 1004 * @param {function(GCNError):boolean=} 1005 * error Optional customer error handler. 1006 */ 1007 save: function () { 1008 var settings; 1009 var success; 1010 var error; 1011 var args = Array.prototype.slice.call(arguments); 1012 var len = args.length; 1013 var i; 1014 1015 for (i = 0; i < len; ++i) { 1016 switch (jQuery.type(args[i])) { 1017 case 'object': 1018 if (!settings) { 1019 settings = args[i]; 1020 } 1021 break; 1022 case 'function': 1023 if (!success) { 1024 success = args[i]; 1025 } else { 1026 error = args[i]; 1027 } 1028 break; 1029 case 'undefined': 1030 break; 1031 default: 1032 var err = GCN.createError('UNKNOWN_ARGUMENT', 1033 'Don\'t know what to do with arguments[' + i + '] ' + 1034 'value: "' + args[i] + '"', args); 1035 GCN.handleError(err, error); 1036 return; 1037 } 1038 } 1039 1040 this._save(settings, success, error); 1041 }, 1042 1043 /** 1044 * Persists this object's local data onto the server. If the object 1045 * has not yet been fetched we need to get it first so we can update 1046 * its internals properly... 1047 * 1048 * @private 1049 * @param {object} settings Object which will extend the basic 1050 * settings of the ajax call 1051 * @param {function(ContentObjectAPI)=} success Optional callback that 1052 * receives this object as 1053 * its only argument. 1054 * @param {function(GCNError):boolean=} error Optional customer error 1055 * handler. 1056 */ 1057 '!_save': function (settings, success, error) { 1058 var obj = this; 1059 this._fulfill(function () { 1060 GCN.pub(obj._type + '.before-save'); 1061 obj._persist(settings, success, error); 1062 }, error); 1063 }, 1064 1065 /** 1066 * Returns the bare data structure of this content object. 1067 * To be used for creating the save POST body data. 1068 * 1069 * @param {object<string, *>} Plain old object representation of this 1070 * content object. 1071 */ 1072 '!json': function () { 1073 var json = {}; 1074 1075 if (this._deletedTags.length) { 1076 json['delete'] = this._deletedTags; 1077 } 1078 1079 if (this._deletedBlocks.length) { 1080 json['delete'] = json['delete'] 1081 ? json['delete'].concat(this._deletedBlocks) 1082 : this._deletedBlocks; 1083 } 1084 1085 json[this._type] = jQuery.extend(true, {}, this._shadow); 1086 json[this._type].id = this._data.id; 1087 return json; 1088 }, 1089 1090 /** 1091 * Sends the current state of this content object to be stored on the 1092 * server. 1093 * 1094 * @private 1095 * @param {function(ContentObjectAPI)=} success Optional callback that 1096 * receives this object as 1097 * its only argument. 1098 * @param {function(GCNError):boolean=} error Optional customer error 1099 * handler. 1100 * @throws HTTP_ERROR 1101 */ 1102 _persist: function (settings, success, error) { 1103 var that = this; 1104 1105 if (!this._fetched) { 1106 this._read(function () { 1107 that._persist(settings, success, error); 1108 }, error); 1109 return; 1110 } 1111 1112 this._authAjax({ 1113 url : GCN.settings.BACKEND_PATH + '/rest/' 1114 + this._type + '/save/' + this.id() 1115 + GCN._getChannelParameter(this), 1116 type : 'POST', 1117 error : error, 1118 json : jQuery.extend(this.json(), settings), 1119 success : function (response) { 1120 // We must not overwrite the `_data.tags' object with this 1121 // one. 1122 delete that._shadow.tags; 1123 1124 // Everything else in `_shadow' should be written over to 1125 // `_data' before resetting the `_shadow' object. 1126 jQuery.extend(that._data, that._shadow); 1127 that._shadow = {}; 1128 that._deletedTags = []; 1129 that._deletedBlocks = []; 1130 1131 if (success) { 1132 that._invoke(success, [that]); 1133 } 1134 } 1135 }); 1136 }, 1137 1138 /** 1139 * Deletes this content object from its containing parent. 1140 * 1141 * @param {function(ContentObjectAPI)=} 1142 * success Optional callback that receives this object as its 1143 * only argument. 1144 * @param {function(GCNError):boolean=} 1145 * error Optional customer error handler. 1146 */ 1147 remove: function (success, error) { 1148 this._remove(success, error); 1149 }, 1150 1151 /** 1152 * Get a channel-local copy of this content object. 1153 * 1154 * @public 1155 * @function 1156 * @name localize 1157 * @memberOf ContentObjectAPI 1158 * @param {funtion(ContentObjectAPI)=} success Optional callback to 1159 * receive this content 1160 * object as the only 1161 * argument. 1162 * @param {function(GCNError):boolean=} error Optional custom error 1163 * handler. 1164 */ 1165 '!localize': function (success, error) { 1166 if (!this._channel && !GCN.channel()) { 1167 var err = GCN.createError( 1168 'NO_CHANNEL_ID_SET', 1169 'No channel is set in which to get the localized object', 1170 GCN 1171 ); 1172 GCN.handleError(err, error); 1173 return false; 1174 } 1175 var local = this._continue( 1176 this._constructor, 1177 { 1178 derivedFrom: this, 1179 multichannelling: true, 1180 read: GCN.multichannelling.localize 1181 }, 1182 success, 1183 error 1184 ); 1185 return local; 1186 }, 1187 1188 /** 1189 * Remove this channel-local object, and delete its local copy in the 1190 * backend. 1191 * 1192 * @public 1193 * @function 1194 * @name unlocalize 1195 * @memberOf ContentObjectAPI 1196 * @param {funtion(ContentObjectAPI)=} success Optional callback to 1197 * receive this content 1198 * object as the only 1199 * argument. 1200 * @param {function(GCNError):boolean=} error Optional custom error 1201 * handler. 1202 */ 1203 '!unlocalize': function (success, error) { 1204 if (!this._channel && !GCN.channel()) { 1205 var err = GCN.createError( 1206 'NO_CHANNEL_ID_SET', 1207 'No channel is set in which to get the unlocalized object', 1208 GCN 1209 ); 1210 GCN.handleError(err, error); 1211 return false; 1212 } 1213 var placeholder = { 1214 multichannelling: { 1215 derivedFrom: this 1216 } 1217 }; 1218 var that = this; 1219 GCN.multichannelling.unlocalize(placeholder, function () { 1220 // TODO: This should be done inside of 1221 // multichannelling.unlocalize() and not in this callback. 1222 // Clean cache & reset object to make sure it can't be used 1223 // properly any more. 1224 that._clearCache(); 1225 that._data = {}; 1226 that._shadow = {}; 1227 if (success) { 1228 success(); 1229 } 1230 }, error); 1231 }, 1232 1233 /** 1234 * Performs a REST API request to delete this object from the server. 1235 * 1236 * @private 1237 * @param {function()=} success Optional callback that 1238 * will be invoked once 1239 * this object has been 1240 * removed. 1241 * @param {function(GCNError):boolean=} error Optional customer error 1242 * handler. 1243 */ 1244 '!_remove': function (success, error) { 1245 var that = this; 1246 this._authAjax({ 1247 url : GCN.settings.BACKEND_PATH + '/rest/' 1248 + this._type + '/delete/' + this.id() 1249 + GCN._getChannelParameter(that), 1250 type : 'POST', 1251 error : error, 1252 success : function (response) { 1253 // Clean cache & reset object to make sure it can't be used 1254 // properly any more. 1255 that._clearCache(); 1256 that._data = {}; 1257 that._shadow = {}; 1258 1259 // Don't forward the object to the success handler since 1260 // it's been deleted. 1261 if (success) { 1262 that._invoke(success); 1263 } 1264 } 1265 }); 1266 }, 1267 1268 /** 1269 * Removes any additionaly data stored on this objec which pertains to 1270 * a tag matching the given tagname. This function will be called when 1271 * a tag is being removed in order to bring the content object to a 1272 * consistant state. 1273 * Should be overriden by subclasses. 1274 * 1275 * @param {string} tagid The Id of the tag whose associated data we 1276 * want we want to remove. 1277 */ 1278 '!_removeAssociatedTagData': function (tagname) {}, 1279 1280 /** 1281 * Return the replacement value, when this object is transformed to stringified JSON. 1282 * This is necessary to avoid endless loops, because objects may have chainback objects 1283 * stored in their _data. 1284 * 1285 * @private 1286 * @param {string} key 1287 * @return {object} _data 1288 */ 1289 '!toJSON': function (key) { 1290 return this._data; 1291 } 1292 }); 1293 1294 GCN.ContentObjectAPI.update = update; 1295 1296 /** 1297 * Generates a factory method for chainback classes. The method signature 1298 * used with this factory function will match that of the target class' 1299 * constructor. Therefore this function is expected to be invoked with the 1300 * follow combination of arguments ... 1301 * 1302 * Examples for GCN.pages api: 1303 * 1304 * To get an array containing 1 page: 1305 * pages(1) 1306 * pages(1, function () {}) 1307 * 1308 * To get an array containing 2 pages: 1309 * pages([1, 2]) 1310 * pages([1, 2], function () {}) 1311 * 1312 * To get an array containing any and all pages: 1313 * pages() 1314 * pages(function () {}) 1315 * 1316 * To get an array containing no pages: 1317 * pages([]) 1318 * pages([], function () {}); 1319 * 1320 * @param {Chainback} ctor The Chainback constructor we want to expose. 1321 * @throws UNKNOWN_ARGUMENT 1322 */ 1323 GCN.exposeAPI = function (ctor) { 1324 return function () { 1325 // Convert arguments into an array 1326 // https://developer.mozilla.org/en/JavaScript/Reference/... 1327 // ...Functions_and_function_scope/arguments 1328 var args = Array.prototype.slice.call(arguments); 1329 var id; 1330 var ids; 1331 var success; 1332 var error; 1333 var settings; 1334 1335 // iterate over arguments to find id || ids, succes, error and 1336 // settings 1337 jQuery.each(args, function (i, arg) { 1338 switch (jQuery.type(arg)) { 1339 // set id 1340 case 'string': 1341 case 'number': 1342 if (!id && !ids) { 1343 id = arg; 1344 } else { 1345 GCN.error('UNKNOWN_ARGUMENT', 1346 'id is already set. Don\'t know what to do with ' + 1347 'arguments[' + i + '] value: "' + arg + '"'); 1348 } 1349 break; 1350 // set ids 1351 case 'array': 1352 if (!id && !ids) { 1353 ids = args[0]; 1354 } else { 1355 GCN.error('UNKNOWN_ARGUMENT', 1356 'ids is already set. Don\'t know what to do with' + 1357 ' arguments[' + i + '] value: "' + arg + '"'); 1358 } 1359 break; 1360 // success and error handlers 1361 case 'function': 1362 if (!success) { 1363 success = arg; 1364 } else if (success && !error) { 1365 error = arg; 1366 } else { 1367 GCN.error('UNKNOWN_ARGUMENT', 1368 'success and error handler already set. Don\'t ' + 1369 'know what to do with arguments[' + i + ']'); 1370 } 1371 break; 1372 // settings 1373 case 'object': 1374 if (!id && !ids) { 1375 id = arg; 1376 } else if (!settings) { 1377 settings = arg; 1378 } else { 1379 GCN.error('UNKNOWN_ARGUMENT', 1380 'settings are already present. Don\'t know what ' + 1381 'to do with arguments[' + i + '] value:' + ' "' + 1382 arg + '"'); 1383 } 1384 break; 1385 default: 1386 GCN.error('UNKNOWN_ARGUMENT', 1387 'Don\'t know what to do with arguments[' + i + 1388 '] value: "' + arg + '"'); 1389 } 1390 }); 1391 1392 // Prepare a new set of arguments to pass on during initialzation 1393 // of callee object. 1394 args = []; 1395 1396 // settings should always be an object, even if it's just empty 1397 if (!settings) { 1398 settings = {}; 1399 } 1400 1401 args[0] = (typeof id !== 'undefined') ? id : ids; 1402 args[1] = success || settings.success || null; 1403 args[2] = error || settings.error || null; 1404 args[3] = settings; 1405 1406 // We either add 0 (no channel) or the channelid to the hash 1407 var channel = GCN.settings.channel; 1408 1409 // Check if the value is false, and set it to 0 in this case 1410 if (!channel) { 1411 channel = 0; 1412 } 1413 1414 var hash = (id || ids) 1415 ? ctor._makeHash(channel + '/' + (ids ? ids.sort().join(',') : id)) 1416 : null; 1417 1418 return GCN.getChainback(ctor, hash, null, args); 1419 }; 1420 1421 }; 1422 1423 }(GCN)); 1424