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