// https://civicrm.org/licensing
/* global CRM, ts */
+/*jshint loopfunc: true */
(function($) {
'use strict';
// Constructor for dashboard object.
dashboard.element = this.empty();
dashboard.ready = false;
dashboard.columns = [];
- dashboard.widgets = [];
- // End of public properties of dashboard.
+ dashboard.widgets = {};
/**
* Public methods of dashboard.
// Saves the order of widgets for all columns including the widget.minimized status to options.ajaxCallbacks.saveColumns.
dashboard.saveColumns = function(showStatus) {
// Update the display status of the empty placeholders.
- for (var c in dashboard.columns) {
- var col = dashboard.columns[c];
- if ( typeof col == 'object' ) {
- // Are there any visible children of the column (excluding the empty placeholder)?
- if (col.element.children(':visible').not(col.emptyPlaceholder).length > 0) {
- col.emptyPlaceholder.hide();
- }
- else {
- col.emptyPlaceholder.show();
- }
- }
- }
+ $.each(dashboard.columns, function(c, col) {
+ if ( typeof col == 'object' ) {
+ // Are there any visible children of the column (excluding the empty placeholder)?
+ if (col.element.children(':visible').not(col.emptyPlaceholder).length > 0) {
+ col.emptyPlaceholder.hide();
+ }
+ else {
+ col.emptyPlaceholder.show();
+ }
+ }
+ });
// Don't save any changes to the server unless the dashboard has finished initiating.
if (!dashboard.ready) {
var params = {};
// For each column...
- for (var c2 in dashboard.columns) {
+ $.each(dashboard.columns, function(c, col) {
// IDs of the sortable elements in this column.
- var ids = (typeof dashboard.columns[c2] == 'object') ? dashboard.columns[c2].element.sortable('toArray') : undefined;
+ var ids = (typeof col == 'object') ? col.element.sortable('toArray') : [];
// For each id...
- for (var w in ids) {
- // Chop 'widget-' off of the front so that we have the real widget id.
- var id = (typeof ids[w] == 'string') ? ids[w].substring('widget-'.length) : undefined;
-
- // Add one flat property to the params object that will look like an array element to the PHP server.
- // Unfortunately jQuery doesn't do this for us.
- if ( typeof dashboard.widgets[id] == 'object' ) params['columns[' + c2 + '][' + id + ']'] = (dashboard.widgets[id].minimized ? '1' : '0');
- }
- }
+ $.each(ids, function(w, id) {
+ if (typeof id == 'string') {
+ // Chop 'widget-' off of the front so that we have the real widget id.
+ id = id.substring('widget-'.length);
+ // Add one flat property to the params object that will look like an array element to the PHP server.
+ // Unfortunately jQuery doesn't do this for us.
+ if (typeof dashboard.widgets[id] == 'object') params['columns[' + c + '][' + id + ']'] = (dashboard.widgets[id].minimized ? '1' : '0');
+ }
+ });
+ });
// The ajaxCallback settings overwrite any duplicate properties.
$.extend(params, opts.ajaxCallbacks.saveColumns.data);
- var post = $.post(opts.ajaxCallbacks.saveColumns.url, params, function(response, status) {
+ var post = $.post(opts.ajaxCallbacks.saveColumns.url, params, function() {
invokeCallback(opts.callbacks.saveColumns, dashboard);
});
if (showStatus !== false) {
CRM.status({}, post);
}
};
- // End of public methods of dashboard.
/**
* Private properties of dashboard.
*/
- // Used to determine whether there are any incomplete ajax requests pending initialization of the dashboard.
- var asynchronousRequestCounter = 0;
-
// Used to determine whether two resort events are resulting from the same UI event.
var currentReSortEvent = null;
// Merge in the caller's options with the defaults.
var opts = $.extend({}, $.fn.dashboard.defaults, options);
+ var localCache = window.localStorage && localStorage.dashboard ? JSON.parse(localStorage.dashboard) : {};
+
init(opts.widgetsByColumn);
return dashboard;
- // End of constructor and private properties for dashboard object.
/**
* Private methods of dashboard.
$("#empty-message").show( );
}
+ // Cache dashlet info in localStorage
+ function saveLocalCache() {
+ localCache = {};
+ $.each(dashboard.widgets, function(id, widget) {
+ localCache[id] = {
+ content: widget.content,
+ lastLoaded: widget.lastLoaded,
+ minimized: widget.minimized
+ };
+ });
+ if (window.localStorage) {
+ localStorage.dashboard = JSON.stringify(localCache);
+ }
+ }
+
// Contructors for each widget call this when initialization has finished so that dashboard can complete it's intitialization.
function completeInit() {
- // Don't do anything if any widgets are waiting for ajax requests to complete in order to finish initialization.
- if (asynchronousRequestCounter > 0 || dashboard.ready) {
+ // Only do this once.
+ if (dashboard.ready) {
return;
}
dashboard.saveColumns();
dashboard.ready = true;
invokeCallback(opts.callbacks.ready, dashboard);
+
+ // Auto-refresh widgets when content is stale
+ window.setInterval(function() {
+ if (!document.hasFocus || document.hasFocus()) {
+ $.each(dashboard.widgets, function (i, widget) {
+ if (!widget.cacheIsFresh()) {
+ widget.reloadContent();
+ }
+ });
+ }
+ }, 5000);
}
// Callback for when any list has changed (and the user has finished resorting).
*/
function widget(widget) {
// Merge default options with the options defined for this widget.
- widget = $.extend({}, $.fn.dashboard.widget.defaults, widget);
+ widget = $.extend({}, $.fn.dashboard.widget.defaults, localCache[widget.id] || {}, widget);
/**
* Public methods of widget.
}
widget.hideSettings();
- dashboard.saveColumns();
};
widget.minimize = function() {
$('.widget-content', widget.element).slideUp(opts.animationSpeed);
.removeClass('fa-caret-down')
.attr('title', ts('Expand'));
widget.minimized = true;
+ saveLocalCache();
};
widget.maximize = function() {
- $('.widget-content', widget.element).slideDown(opts.animationSpeed);
$(widget.controls.minimize.element)
.removeClass( 'fa-caret-right' )
.addClass( 'fa-caret-down' )
.attr('title', ts('Collapse'));
widget.minimized = false;
+ saveLocalCache();
if (!widget.contentLoaded) {
loadContent();
}
+ $('.widget-content', widget.element).slideDown(opts.animationSpeed);
};
// Toggles whether the widget is in settings-display mode or not.
var params = {};
// serializeArray() returns an array of objects. Process it.
var fields = widget.settings.element.serializeArray();
- for (var i in fields) {
- var field = fields[i];
+ $.each(fields, function(i, field) {
// Put the values into flat object properties that PHP will parse into an array server-side.
// (Unfortunately jQuery doesn't do this)
params['settings[' + field.name + ']'] = field.value;
- }
+ });
// Things get messy here.
// @todo Refactor to use currentState and targetedState properties to determine what needs
control.element = $(markup).prependTo($('.widget-controls', widget.element)).click(control.callback);
};
- // An external method used only by and from external scripts to reload content. Not invoked or used internally.
- // The widget must provide the script that executes this, as well as the script that invokes it.
+ // Fetch remote content.
widget.reloadContent = function() {
- getJavascript(widget.reloadContentScript);
- invokeCallback(opts.widgetCallbacks.reloadContent, widget);
+ // If minimized, we'll reload later
+ if (widget.minimized) {
+ widget.contentLoaded = false;
+ widget.lastLoaded = 0;
+ } else {
+ CRM.loadPage(widget.url, {target: widget.contentElement});
+ }
};
// Removes the widget from the dashboard, and saves columns.
invokeCallback(opts.widgetCallbacks.remove, widget);
widget.element.fadeOut(opts.animationSpeed, function() {
$(this).remove();
+ delete(dashboard.widgets[widget.id]);
+ dashboard.saveColumns(false);
});
- dashboard.saveColumns(false);
CRM.alert(
ts('You can re-add it by clicking the "Configure Your Dashboard" button.'),
- ts('"%1" Removed', {1: widget.title}),
+ ts('"%1" Removed', {1: CRM.utils.escapeHtml(widget.title)}),
'success'
);
};
- // End public methods of widget.
+
+ widget.cacheIsFresh = function() {
+ return (((widget.cacheMinutes * 60000 + widget.lastLoaded) > $.now()) && widget.content);
+ };
/**
* Public properties of widget.
};
widget.contentLoaded = false;
- // End public properties of widget.
-
init();
return widget;
*/
function loadContent() {
- asynchronousRequestCounter++;
- widget.contentLoaded = true;
- CRM.loadPage(widget.url, {target: widget.contentElement})
- .one('crmLoad', function() {
- asynchronousRequestCounter--;
+ var loadFromCache = widget.cacheIsFresh();
+ if (loadFromCache) {
+ widget.contentElement.html(widget.content).trigger('crmLoad', widget);
+ }
+ widget.contentElement.off('crmLoad').on('crmLoad', function(event, data) {
+ if ($(event.target).is(widget.contentElement)) {
+ widget.content = data.content;
+ // Cache for one day
+ widget.lastLoaded = $.now();
+ saveLocalCache();
invokeCallback(opts.widgetCallbacks.get, widget);
- completeInit();
- });
+ }
+ });
+ if (!loadFromCache) {
+ widget.reloadContent();
+ }
+ widget.contentLoaded = true;
}
// Build widget & load content.
function widgetHTML() {
var html = '';
html += '<div class="widget-wrapper">';
- html += ' <div class="widget-controls"><h3 class="widget-header">' + widget.title + '</h3></div>';
+ html += ' <div class="widget-controls"><h3 class="widget-header">' + CRM.utils.escapeHtml(widget.title) + '</h3></div>';
html += ' <div class="widget-content"></div>';
html += '</div>';
return html;
// Public static properties of dashboard. Default settings.
$.fn.dashboard.defaults = {
columns: 2,
- emptyPlaceholderInner: ts('There are no dashlets in this column of your dashboard.'),
+ emptyPlaceholderInner: '',
throbberMarkup: '',
animationSpeed: 200,
callbacks: {},
$.fn.dashboard.widget = {
defaults: {
minimized: false,
+ content: null,
+ lastLoaded: 0,
settings: false
- // url, fullscreenUrl, content, title, name
+ // id, url, fullscreenUrl, title, name, cacheMinutes
}
};
})(jQuery);
projects / civicrm-core.git / blobdiff