/** * EGroupware clientside API: opening of windows, popups or application entries * * @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 (as AT stylite.de) * @author Ralf Becker * @version $Id$ */ "use strict"; /*egw:uses egw_core; egw_links; */ /** * @augments Class */ egw.extend('open', egw.MODULE_WND_LOCAL, function(_egw, _wnd) { /** * Store a window's name in egw.store so we can have a list of open windows * * @param {string} appname * @param {Window} popup */ function _storeWindow(appname, popup) { // Don't store if it has no name if(!popup.name || ['_blank'].indexOf(popup.name) >= 0) { return; } var _target_app = appname || this.appName || egw_appName || 'common'; var open_windows = JSON.parse(this.getSessionItem(_target_app, 'windows')) || []; if(open_windows.indexOf(popup.name) < 0) { open_windows.push(popup.name); this.setSessionItem(_target_app, 'windows', JSON.stringify(open_windows)); } // Forget window when it closes // Window should notify, but we'll poll too since onunload is not fully supported var _egw = this; (function() { var app = _target_app; var window_name = popup.name; var poll_timer = popup.setInterval(function() { if(popup.closed !== false) { this.clearInterval(poll_timer); egw.windowClosed(app, window_name); } },1000); })(); } /** * Magic handling for mailto: uris using mail application. * * We check for open compose windows and add the address in as specified in * the URL. If there are no open compose windows, a new one is opened. If * there are more than one open compose window, we prompt for which one to * use. * * The user must have set the 'Open EMail addresses in external mail program' preference * to No, otherwise the browser will handle it. * * @param {String} uri */ function mailto(uri) { // Parse uri into a map var match = uri.match(/^mailto:([^?]+)\??(([^=]+)([^&]+))*$/); var content = { to: match[1] } for(var i = 2; i < match.length; i+=2) { if(match[i+1]) { content[match[i]] = content[match[i+1]]; } } // Get open compose windows var compose = egw.getOpenWindows("mail", /^compose_/); if(compose.length == 0) { // No compose windows, might be no mail app.js // We really want to use mail_compose() here egw.open('','mail','add',{'preset[mailto]': uri},'compose__','mail') } if(compose.length == 1) { try { var popup = egw.open_link('',compose[0],'100x100','mail'); popup.app.mail.setCompose(compose[0], content); } catch(e) { // Looks like a leftover window that wasn't removed from the list egw.debug("warn", e.message); popup.close(); egw.windowClosed("mail",popup); window.setTimeout(function() { egw.open_link(uri); console.debug("Trying again with ", uri); }, 500); } } else if(compose.length > 1) { // Need to prompt var prompt = $j(document.createElement('ul')); for(var i = 0; i < compose.length; i++) { var w = window.open('',compose[i],'100x100'); if(w.closed) continue; var title = w.document.title || egw.lang("compose"); $j("
  • "+ title + "
  • ") .click(function() { var w = egw.open_link('',$j(this).attr("data-window"),'100x100','mail'); w.app.mail.setCompose(w.name, content); prompt.dialog("close"); }) .appendTo(prompt); } _wnd.setTimeout(function() { this.focus(); }, 200); var _buttons = {}; _buttons[egw.lang("cancel")] = function() { $j(this).dialog("close"); }; prompt.dialog({ buttons: _buttons }); } } return { /** * View an EGroupware entry: opens a popup of correct size or redirects window.location to requested url * * Examples: * - egw.open(123,'infolog') or egw.open('infolog:123') opens popup to edit or view (if no edit rights) infolog entry 123 * - egw.open('infolog:123','timesheet','add') opens popup to add new timesheet linked to infolog entry 123 * - egw.open(123,'addressbook','view') opens addressbook view for entry 123 (showing linked infologs) * - egw.open('','addressbook','view_list',{ search: 'Becker' }) opens list of addresses containing 'Becker' * * @param string|int|object id_data either just the id or if app=="" "app:id" or object with all data * to be able to open files you need to give: (mine-)type, path or id, app2 and id2 (path=/apps/app2/id2/id" * @param string app app-name or empty (app is part of id) * @param string type default "edit", possible "view", "view_list", "edit" (falls back to "view") and "add" * @param object|string extra extra url parameters to append as object or string * @param string target target of window to open * @param string target_app target application to open in that tab * @memberOf egw */ open: function(id_data, app, type, extra, target, target_app) { var id; if(typeof target === 'undefined') { target = '_blank'; } if (!app) { if (typeof id_data != 'object') { var app_id = id_data.split(':',2); app = app_id[0]; id = app_id[1]; } else { app = id_data.app; id = id_data.id; } } else if (app != 'file') { id = id_data; id_data = { 'id': id, 'app': app, 'extra': extra }; } var url; var popup; var params; if (app == 'file') { url = this.mime_open(id_data); if (typeof url == 'object') { if(typeof url.mime_popup != 'undefined') { popup = url.mime_popup; delete url.mime_popup; } if(typeof url.mime_target != 'undefined') { target = url.mime_target; delete url.mime_target; } params = url; url = '/index.php'; } } else { var app_registry = this.link_get_registry(app); if (!app || !app_registry) { alert('egw.open() app "'+app+'" NOT defined in link registry!'); return; } if (typeof type == 'undefined') type = 'edit'; if (type == 'edit' && typeof app_registry.edit == 'undefined') type = 'view'; if (typeof app_registry[type] == 'undefined') { alert('egw.open() type "'+type+'" is NOT defined in link registry for app "'+app+'"!'); return; } url = '/index.php'; params = app_registry[type]; if (type == 'view' || type == 'edit') // add id parameter for type view or edit { params[app_registry[type+'_id']] = id; } else if (type == 'add' && id) // add add_app and app_id parameters, if given for add { var app_id = id.split(':',2); params[app_registry.add_app] = app_id[0]; params[app_registry.add_id] = app_id[1]; } if (typeof extra == 'string') { url += '?'+extra; } else if (typeof extra == 'object') { $j.extend(params, extra); } popup = app_registry[type+'_popup']; } return this.open_link(this.link(url, params), target, popup, target_app); }, /** * Open a link, which can be either a menuaction, a EGroupware relative url or a full url * * @param string _link menuaction, EGroupware relative url or a full url (incl. "mailto:" or "javascript:") * @param string _target optional target / window name * @param string _popup widthxheight, if a popup should be used * @param string _target_app app-name for opener */ open_link: function(_link, _target, _popup, _target_app) { var url = _link; if (url.indexOf('javascript:') == 0) { eval(url.substr(11)); return; } if (url.indexOf('mailto:') == 0) { return mailto(url); } // link is not necessary an url, it can also be a menuaction! if (url.indexOf('/') == -1 && url.split('.').length >= 3 && !(url.indexOf('mailto:') == 0 || url.indexOf('/index.php') == 0 || url.indexOf('://') != -1)) { url = "/index.php?menuaction="+url; } // append the url to the webserver url, if not already contained or empty if (url[0] == '/' && this.webserverUrl && this.webserverUrl != '/' && url.indexOf(this.webserverUrl+'/') != 0) { url = this.webserverUrl + url; } if (_popup) { var w_h = _popup.split('x'); if (w_h[1] == 'egw_getWindowOuterHeight()') w_h[1] = egw_getWindowOuterHeight(); var popup_window = _wnd.egw_openWindowCentered2(url, _target, w_h[0], w_h[1], false, _target_app, true); // Remember which windows are open _storeWindow.call(this, _target_app, popup_window); return popup_window; } else if (typeof _wnd.egw_link_handler == 'function' && (typeof _target == 'undefined' || _target =='_self' || typeof this.link_app_list()[_target] != "undefined")) { if(_target == '_self') { // '_self' isn't allowed, but we can handle it _target = undefined; } // Use framework's link handler, if present return _wnd.egw_link_handler(url,_target); } else if (_target == '_self') { _wnd.location.href = url; } else { return _wnd.open(url, _target); } }, /** * Get a list of the names of open popups * * Using the name, you can get a reference to the popup using: * window.open('', name); * Popups that were not given a name when they were opened are not tracked. * * @param {string} appname Application that owns/opened the popup * @param {string} regex Optionally filter names by the given regular expression * * @returns {string[]} List of window names */ getOpenWindows: function(appname, regex) { var open_windows = JSON.parse(this.getSessionItem(appname, 'windows')) || []; if(typeof regex == 'undefined') { return open_windows; } var list = [] for(var i = 0; i < open_windows.length; i++) { if(open_windows[i].match(regex)) { list.push(open_windows[i]); } } return list; }, /** * Notify egw of closing a named window * * @param {String} appname * @param {Window|String} closed Window that was closed, or its name * @returns {undefined} */ windowClosed: function(appname, closed) { var closed_name = typeof closed == "string" ? closed : closed.name; var closed_window = typeof closed == "string" ? null : closed; window.setTimeout(function() { if(closed_window != null && !closed_window.closed) return; var open_windows = egw.getOpenWindows(appname, closed_name) var index = open_windows.indexOf(closed_name); if(index >= 0) { open_windows.splice(index,1); } egw.setSessionItem(appname, 'windows', JSON.stringify(open_windows)); }, 100); } }; }); // Add protocol handler as an option if mail handling is not forced so mail can handle mailto: /* Not working consistantly yet $j(function() { try { if(egw.user('apps').mail && (egw.preference('force_mailto','addressbook')||true) != '0') { var params = egw.link_get_registry('mail','add'); if(params) { params['preset[mailto]'] = ''; // %s, but egw.link will encode it navigator.registerProtocolHandler("mailto",egw.link('/index.php', params)+'%s', egw.lang('mail')); } } } catch (e) {} }); */