/** * EGroupware eTemplate2 - JS file which contains the complete et2 module * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @package etemplate * @subpackage api * @link http://www.egroupware.org * @author Andreas Stöckel * @copyright Stylite 2011 * @version $Id$ */ /*egw:uses // Include all widget classes here et2_widget_template; et2_widget_grid; et2_widget_box; et2_widget_hbox; et2_widget_groupbox; et2_widget_split; et2_widget_button; et2_widget_color; et2_widget_description; et2_widget_entry; et2_widget_textbox; et2_widget_number; et2_widget_url; et2_widget_selectbox; et2_widget_checkbox; et2_widget_radiobox; et2_widget_date; et2_widget_dialog; et2_widget_diff; et2_widget_dropdown_button; et2_widget_styles; et2_widget_favorites; et2_widget_html; et2_widget_htmlarea; et2_widget_tabs; et2_widget_taglist; et2_widget_toolbar; et2_widget_tree; et2_widget_historylog; et2_widget_hrule; et2_widget_image; et2_widget_iframe; et2_widget_file; et2_widget_link; et2_widget_progress; et2_widget_portlet; et2_widget_selectAccount; et2_widget_ajaxSelect; et2_widget_vfs; et2_widget_video; et2_widget_barcode; et2_widget_itempicker; et2_widget_script; et2_extension_nextmatch; et2_extension_customfields; // Requirements for the etemplate2 object et2_core_common; et2_core_xml; et2_core_arrayMgr; et2_core_interfaces; et2_core_legacyJSFunctions; // Include the client side api core jsapi.egw_core; jsapi.egw_json; */ /** * The etemplate2 class manages a certain etemplate2 instance. * * @param _container is the DOM-Node into which the DOM-Nodes of this instance * should be inserted * @param _menuaction is the URL to which the form data should be submitted. */ function etemplate2(_container, _menuaction) { if (typeof _menuaction == "undefined") { _menuaction = "home.etemplate_new.ajax_process_content.etemplate"; } // Copy the given parameters this.DOMContainer = _container; this.menuaction = _menuaction; // Unique ID to prevent DOM collisions across multiple templates this.uniqueId = _container.getAttribute("id") ? _container.getAttribute("id").replace('.','-') : ''; /** * Preset the object variable * @type {et2_container} */ this.widgetContainer = null; } // List of templates (XML) that are known, not always used. Indexed by id. // We share list of templates with iframes and popups try { if (opener && opener.etemplate2) { etemplate2.prototype.templates = opener.etemplate2.prototype.templates; } else if (top.etemplate2) { etemplate2.prototype.templates = top.etemplate2.prototype.templates; } } catch (e) { // catch security exception if opener is from a different domain console.log('Security exception accessing etemplate2.prototype of opener or top!'); } if (typeof etemplate2.prototype.templates == "undefined") { etemplate2.prototype.templates = {}; } /** * Calls the resize event of all widgets * * @param {jQuery.event} e */ etemplate2.prototype.resize = function(e) { var event = e; var self = this; var excess_height = false; // Check if the framework has an specific excess height calculation if (typeof window.framework != 'undefined' && typeof window.framework.get_wExcessHeight != 'undefined') { excess_height = window.framework.get_wExcessHeight(window); } //@TODO implement getaccess height for other framework and remove if (typeof event != 'undefined' && event.type == 'resize') { if(this.resize_timeout) { clearTimeout(this.resize_timeout); } this.resize_timeout = setTimeout(function(){ self.resize_timeout = false; if (self.widgetContainer) { var appHeader = $j('#divAppboxHeader'); //Calculate the excess height excess_height = egw(window).is_popup()? $j(window).height() - $j(self.DOMContainer).height() - appHeader.outerHeight()+11: false; // Recalculate excess height if the appheader is shown if (appHeader.length > 0 && appHeader.is(':visible')) excess_height -= appHeader.outerHeight()-9; // Do not resize if the template height is bigger than screen available height // For templates which have sub templates and they are bigger than screenHeight if(screen.availHeight < $j(self.DOMContainer).height()) excess_height = 0; // Call the "resize" event of all functions which implement the // "IResizeable" interface self.widgetContainer.iterateOver(function(_widget) { _widget.resize(excess_height); }, self, et2_IResizeable); } },100); } // Initial resize needs to be resized immediately (for instance for nextmatch resize) else if(this.widgetContainer) { // Call the "resize" event of all functions which implement the // "IResizeable" interface this.widgetContainer.iterateOver(function(_widget) { _widget.resize(excess_height); }, this, et2_IResizeable); } }; /** * Clears the current instance. */ etemplate2.prototype.clear = function() { $j(this.DOMContainer).trigger('clear'); // Remove any handlers on window (resize) if(this.uniqueId) { $j(window).off("."+this.uniqueId); } // call our destroy_session handler, if it is not already unbind, and unbind it after if (this.destroy_session) { this.destroy_session(); this.unbind_unload(); } if (this.widgetContainer != null) { // Un-register handler this.widgetContainer.egw().unregisterJSONPlugin(etemplate2_handle_assign, this, 'assign'); this.widgetContainer.free(); this.widgetContainer = null; } $j(this.DOMContainer).empty(); // Remove self from the index for(name in this.templates) { if(typeof etemplate2._byTemplate[name] == "undefined") continue; for(var i = 0; i < etemplate2._byTemplate[name].length; i++) { if(etemplate2._byTemplate[name][i] == this) { etemplate2._byTemplate[name].splice(i,1); } } } }; /** * Creates an associative array containing the data array managers for each part * of the associative data array. A part is something like "content", "readonlys" * or "sel_options". * * @param {object} _data object with values for attributes content, sel_options, readonlys, modifications */ etemplate2.prototype._createArrayManagers = function(_data) { if (typeof _data == "undefined") { _data = {}; } // Create all neccessary _data entries var neededEntries = ["content", "sel_options", "readonlys", "modifications", "validation_errors"]; for (var i = 0; i < neededEntries.length; i++) { if (typeof _data[neededEntries[i]] == "undefined" || !_data[neededEntries[i]]) { egw.debug("log", "Created not passed entry '" + neededEntries[i] + "' in data array."); _data[neededEntries[i]] = {}; } } var result = {}; // Create an array manager object for each part of the _data array. for (var key in _data) { switch (key) { case "etemplate_exec_id": // already processed case "app_header": break; case "readonlys": result[key] = new et2_readonlysArrayMgr(_data[key]); result[key].perspectiveData.owner = this.widgetContainer; break; default: result[key] = new et2_arrayMgr(_data[key]); result[key].perspectiveData.owner = this.widgetContainer; } } return result; }; /** * Bind our unload handler to notify server that eT session/request no longer needed * * We only bind, if we have an etemplate_exec_id: not the case for pure client-side * calls, eg. via et2_dialog. */ etemplate2.prototype.bind_unload = function() { if (this.etemplate_exec_id) { this.destroy_session = jQuery.proxy(function(ev) { var request = egw.json(this.app+".etemplate_new.ajax_destroy_session.etemplate", [this.etemplate_exec_id], null, null, false); request.sendRequest(); }, this); if (!window.onbeforeunload) { window.onbeforeunload = this.destroy_session; } } }; /** * Unbind our unload handler */ etemplate2.prototype.unbind_unload = function() { if (window.onbeforeunload === this.destroy_session) { window.onbeforeunload = null; } delete this.destroy_session; }; /** * Download a URL not triggering our unload handler and therefore destroying our et2 request * * @param {string} _url */ etemplate2.prototype.download = function(_url) { // need to unbind unload handler to NOT destroy et2 session this.unbind_unload(); document.location = _url; // bind unload handler again (can NOT do it direct, as this would be quick enough to be still triggered!) window.setTimeout(jQuery.proxy(this.bind_unload, this), 100); }; /** * Loads the template from the given URL and sets the data object * * @param {string} _name name of template * @param {string} _url url to load template * @param {object} _data object with attributes content, langRequire, etemplate_exec_id, ... * @param {function} _callback called after tempalte is loaded * @param {object} _app local app object * @param {boolean} _no_et2_ready true: do not send et2_ready, used by et2_dialog to not overwrite app.js et2 object */ etemplate2.prototype.load = function(_name, _url, _data, _callback, _app, _no_et2_ready) { var app = _app || window.app; this.name = _name; // store top-level template name to have it available in widgets // store template base url, in case initial template is loaded via webdav, to use that for further loads too // need to split off domain first, as it could contain app-name part of template eg. stylite.report.xet and https://my.stylite.de/egw/... if (_url && _url[0] != '/') { this.template_base_url = _url.match(/https?:\/\/[^/]+/).shift(); _url = _url.split(this.template_base_url)[1]; } else { this.template_base_url = ''; } this.template_base_url += _url.split(_name.split('.').shift())[0]; egw().debug("info", "Loaded data", _data); var currentapp = this.app = _data.currentapp || egw().app_name(); var appname = _name.split('.')[0]; // if no app object provided and template app is not currentapp (eg. infolog CRM view) // create private app object / closure with just classes / prototypes if (!_app && appname && appname != currentapp && currentapp != 'home' && appname != 'home') app = { classes: window.app.classes }; // remember used app object, to eg. use: onchange="widget.getInstanceMgr().app_object[app].callback()" this.app_obj = app; // extract $content['msg'] and call egw.message() with it var msg = _data.content.msg; if (typeof msg != 'undefined') { egw(window).message(msg); delete _data.content.msg; } // Register a handler for AJAX responses egw(currentapp, window).registerJSONPlugin(etemplate2_handle_assign, this, 'assign'); if(egw.debug_level() >= 3) { if(console.groupCollapsed) { egw.window.console.groupCollapsed("Loading %s into ", _name, '#'+this.DOMContainer.id); } } // Timing & profiling on debug level 'log' (4) if(egw.debug_level() >= 4) { if(console.time) { console.time(_name); } if(console.profile) { console.profile(_name); } var start_time = (new Date).getTime(); } // require necessary translations from server, if not already loaded if (!$j.isArray(_data.langRequire)) _data.langRequire = []; egw(currentapp, window).langRequire(window, _data.langRequire, function() { // Initialize application js var app_callback = null; // Only initialize once // new app class with constructor function in app.classes[appname] if (typeof app[appname] !== 'object' && typeof app.classes[appname] == 'function') { app[appname] = new app.classes[appname](); } // old app class with constructor function in app[appname] (deprecated) else if(typeof app[appname] == "function") { (function() { new app[appname]();}).call(); } else if (appname && typeof app[appname] !== "object") { egw.debug("warn", "Did not load '%s' JS object",appname); } // If etemplate current app does not match app owning the template, // initialize the current app too if (typeof app[this.app] !== 'object' && typeof app.classes[this.app] == 'function') { app[this.app] = new app.classes[this.app](); } if(typeof app[appname] == "object") { app_callback = function(_et2, _name) { app[appname].et2_ready(_et2, _name); }; } // Create the document fragment into which the HTML will be injected var frag = document.createDocumentFragment(); // Clear any existing instance this.clear(); // Create the basic widget container and attach it to the DOM this.widgetContainer = new et2_container(null); this.widgetContainer.setApiInstance(egw(currentapp, egw.elemWindow(this.DOMContainer))); this.widgetContainer.setInstanceManager(this); this.widgetContainer.setParentDOMNode(this.DOMContainer); // store the id to submit it back to server if(_data) { this.etemplate_exec_id = _data.etemplate_exec_id; // set app_header if (typeof _data.app_header == 'string') { window.egw_app_header(_data.app_header); } // bind our unload handler this.bind_unload(); } var _load = function() { egw.debug("log", "Loading template..."); if(egw.debug_level() >= 4 && console.timeStamp) { console.timeStamp("Begin rendering template"); } // Add into indexed list - do this before, so anything looking can find it, // even if it's not loaded if(typeof etemplate2._byTemplate[_name] == "undefined") { etemplate2._byTemplate[_name] = []; } etemplate2._byTemplate[_name].push(this); // Read the XML structure of the requested template this.widgetContainer.loadFromXML(this.templates[this.name]); // List of Promises from widgets that are not quite fully loaded var deferred = []; // Inform the widget tree that it has been successfully loaded. this.widgetContainer.loadingFinished(deferred); // Connect to the window resize event $j(window).on("resize."+this.uniqueId, this, function(e) {e.data.resize(e);}); // Insert the document fragment to the DOM Container this.DOMContainer.appendChild(frag); if(egw.debug_level() >= 3 && console.groupEnd) { egw.window.console.groupEnd(); } if(deferred.length > 0) { var still_deferred = 0; $j(deferred).each(function() {if(this.state() == "pending") still_deferred++;}); if(still_deferred > 0) { egw.debug("log", "Template loaded, waiting for %d/%d deferred to finish...",still_deferred, deferred.length); } } // Wait for everything to be loaded, then finish it up jQuery.when.apply(jQuery, deferred).done(jQuery.proxy(function() { egw.debug("log", "Finished loading %s, triggering load event", _name); if (typeof window.framework != 'undefined' && typeof window.framework.et2_loadingFinished != 'undefined') { //Call loading finished method of the framework with local window window.framework.et2_loadingFinished(egw(window).window); } // Trigger the "resize" event this.resize(); // Automatically set focus to first visible input for popups if(this.widgetContainer._egw.is_popup() && $j('[autofocus]',this.DOMContainer).focus().length == 0) { var $input = $j('input:visible',this.DOMContainer) // Date fields open the calendar popup on focus .not('.et2_date') .filter(function() { // Skip inputs that are out of tab ordering var $this = $j(this); return !$this.attr('tabindex') || $this.attr('tabIndex')>=0; }).first(); // mobile device, focus only if the field is empty (usually means new entry) // should focus always for non-mobile one if (egwIsMobile() && $input.val() == "" || !egwIsMobile()) $input.focus(); } // Tell others about it if(typeof _callback == "function") { _callback.call(window,this,_name); } if(app_callback && _callback != app_callback && !_no_et2_ready) { app_callback.call(window,this,_name); } if(appname && appname != this.app && typeof app[this.app] == "object" && !_no_et2_ready) { // Loaded a template from a different application? // Let the application that loaded it know too app[this.app].et2_ready(this, this.name); } $j(this.DOMContainer).trigger('load', this); // Profiling if(egw.debug_level() >= 4) { if(console.timeEnd) { console.timeEnd(_name); } if(console.profileEnd) { console.profileEnd(_name); } var end_time = (new Date).getTime(); var gen_time_div = $j('#divGenTime_'+appname); if (!gen_time_div.length) gen_time_div = $j('.pageGenTime'); gen_time_div.find('.et2RenderTime').remove(); gen_time_div.append(''+egw.lang('eT2 rendering took %1s', (end_time-start_time)/1000)+''); } },this)); }; // Load & process try { if (this.templates[_name]) { // Set array managers first, or errors will happen this.widgetContainer.setArrayMgrs(this._createArrayManagers(_data)); // Already have it _load.apply(this,[]); return; } } catch (e) { // wired security exception in IE denying access to template cache in opener if (e.message == 'Permission denied') { etemplate2.prototype.templates = {}; } // other error eg. in app.js et2_ready or event handlers --> rethrow it else { throw e; } } // Asynchronously load the XET file et2_loadXMLFromURL(_url, function(_xmldoc) { // Scan for templates and store them for(var i = 0; i < _xmldoc.childNodes.length; i++) { var template = _xmldoc.childNodes[i]; if(template.nodeName.toLowerCase() != "template") continue; this.templates[template.getAttribute("id")] = template; if(!_name) this.name = template.getAttribute("id"); } _load.apply(this,[]); }, this); // Split the given data into array manager objects and pass those to the // widget container - do this here because file is loaded async this.widgetContainer.setArrayMgrs(this._createArrayManagers(_data)); }, this); }; /** * Check if template contains any dirty (unsaved) content * * @returns {Boolean} */ etemplate2.prototype.isDirty = function() { var dirty = false; this.widgetContainer.iterateOver(function(_widget) { if (_widget.isDirty && _widget.isDirty()) { dirty = true; } }); return dirty; }; /** * Submit the et2_container form to a blank iframe in order to activate browser autocomplete */ etemplate2.prototype.autocomplete_fixer = function () { var self = this; var form = self.DOMContainer; // Safari always do the autofill for password field regardless of autocomplete = off // and since there's no other way to switch the autocomplete of, we should switch the // form autocomplete off (e.g. compose dialog, attachment password field) if (navigator.userAgent.match(/safari/i) && !navigator.userAgent.match(/chrome/i) && jQuery('input[type="password"]').length > 0) { return; } if (form) { // Stop submit propagation in order to not fire other possible submit events // for instance, CKEditor has its own submit event handler which we do not want to // fire that on submit form.onsubmit = function(e){e.stopPropagation();}; // Firefox give a security warning when transmitting to "about:blank" from a https site // we work around that by giving existing etemplate/empty.html url // Safari shows same warning, thought Chrome userAgent also includes Safari if (navigator.userAgent.match(/(firefox|safari|iceweasel)/i) && !navigator.userAgent.match(/chrome/i)) { jQuery(form).attr({action: egw.webserverUrl+'/etemplate/empty.html',method:'post'}); } // need to trigger submit because submit() would not trigger onsubmit event // since the submit does not get fired directly via user interaction. jQuery(form).trigger('submit'); } }; /** * Submit form via ajax * * @param {(et2_button|string)} button button widget or string with id * @param {boolean} async true: do an asynchronious submit, default is synchronious * @param {boolean} no_validation - Do not do individual widget validation, just submit their current values * @param {et2_widget|undefined} _container container to submit, default whole template * @return {boolean} true if submit was send, false if eg. validation stoped submit */ etemplate2.prototype.submit = function(button, async, no_validation, _container) { if(typeof no_validation == 'undefined') { no_validation = false; } var container = _container || this.widgetContainer; // Get the form values var values = this.getValues(container); // Trigger the submit event var canSubmit = true; if(!no_validation) { container.iterateOver(function(_widget) { if (_widget.submit(values) === false) { canSubmit = false; } }, this, et2_ISubmitListener); } if (canSubmit) { if (typeof button == 'string') { button = this.widgetContainer.getWidgetById(button); } // Button parameter used for submit buttons in datagrid // TODO: This should probably go in nextmatch's getValues(), along with selected rows somehow. // I'm just not sure how. if(button && !values.button) { values.button = {}; var path = button.getPath(); var target = values; for(var i = 0; i < path.length; i++) { if(!values[path[i]]) values[path[i]] = {}; target = values[path[i]]; } if(target != values || button.id.indexOf('[') != -1 && path.length == 0) { var indexes = button.id.split('['); if (indexes.length > 1) { indexes = [indexes.shift(), indexes.join('[')]; indexes[1] = indexes[1].substring(0,indexes[1].length-1); var children = indexes[1].split(']['); if(children.length) { indexes = jQuery.merge([indexes[0]], children); } } var idx = ''; for(var i = 0; i < indexes.length; i++) { idx = indexes[i]; if(!target[idx] || target[idx]['$row_cont']) target[idx] = i < indexes.length -1 ? {} : true; target = target[idx]; } } else if (typeof values.button == 'undefined' || jQuery.isEmptyObject(values.button)) { delete values.button; values[button.id] = true; } } // Create the request object if (this.menuaction) { //Autocomplete this.autocomplete_fixer(); // unbind our session-destroy handler, as we are submitting this.unbind_unload(); var api = this.widgetContainer.egw(); var request = api.json(this.menuaction, [this.etemplate_exec_id, values, no_validation], null, this, async); request.sendRequest(); } else { this.widgetContainer.egw().debug("warn", "Missing menuaction for submit. Values: ", values); } } return canSubmit; }; /** * Does a full form post submit. * Only use this one if you need it, use the ajax submit() instead */ etemplate2.prototype.postSubmit = function() { // Get the form values var values = this.getValues(this.widgetContainer); // Trigger the submit event var canSubmit = true; this.widgetContainer.iterateOver(function(_widget) { if (_widget.submit(values) === false) { canSubmit = false; } }, this, et2_ISubmitListener); if (canSubmit) { // unbind our session-destroy handler, as we are submitting this.unbind_unload(); var form = jQuery("