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