1 // https://civicrm.org/licensing
3 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/AJAX+Interface
4 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Ajax+Pages+and+Forms
6 (function($, CRM
, undefined) {
9 * @param string|object query
10 * @param string mode - optionally specify "front" or "back"
13 CRM
.url = function (path
, query
, mode
) {
14 if (typeof path
=== 'object') {
19 CRM
.console('error', 'Error: CRM.url called before initialization');
22 mode
= CRM
.config
&& CRM
.config
.isFrontend
? 'front' : 'back';
25 var frag
= path
.split('?');
26 var url
= tplURL
[mode
].replace("*path*", frag
[0]);
29 url
= url
.replace(/[?&]\*query\*/, '');
32 url
= url
.replace("*query*", typeof query
=== 'string' ? query
: $.param(query
));
35 url
+= (url
.indexOf('?') < 0 ? '?' : '&') + frag
[1];
40 $.fn
.crmURL = function () {
41 return this.each(function() {
43 this.href
= CRM
.url(this.href
);
50 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/AJAX+Interface#AJAXInterface-CRM.api3
52 CRM
.api3 = function(entity
, action
, params
, status
) {
53 if (typeof(entity
) === 'string') {
56 action
: action
.toLowerCase(),
57 json
: JSON
.stringify(params
|| {})
63 json
: JSON
.stringify(entity
)
68 url
: CRM
.url('civicrm/ajax/rest'),
71 type
: params
.action
.indexOf('get') < 0 ? 'POST' : 'GET'
74 // Default status messages
75 if (status
=== true) {
76 status
= {success
: params
.action
=== 'delete' ? ts('Removed') : ts('Saved')};
77 if (params
.action
.indexOf('get') === 0) {
78 status
.start
= ts('Loading...');
79 status
.success
= null;
82 var messages
= status
=== true ? {} : status
;
83 CRM
.status(status
, ajax
);
92 CRM
.api = function(entity
, action
, params
, options
) {
96 success: function(result
, settings
) {
99 error: function(result
, settings
) {
100 $().crmError(result
.error_message
, ts('Error'));
103 callBack: function(result
, settings
) {
104 if (result
.is_error
== 1) {
105 return settings
.error
.call(this, result
, settings
);
107 return settings
.success
.call(this, result
, settings
);
109 ajaxURL
: 'civicrm/ajax/rest'
111 action
= action
.toLowerCase();
112 // Default success handler
118 settings
.success = function() {
119 CRM
.status(ts('Saved'));
124 settings
.success = function() {
125 CRM
.status(ts('Removed'));
132 json
: JSON
.stringify(params
)
134 // Pass copy of settings into closure to preserve its value during multiple requests
137 url
: stg
.ajaxURL
.indexOf('http') === 0 ? stg
.ajaxURL
: CRM
.url(stg
.ajaxURL
),
140 type
: action
.indexOf('get') < 0 ? 'POST' : 'GET',
141 success: function(result
) {
142 stg
.callBack
.call(stg
.context
, result
, stg
);
145 })($.extend({}, settings
, options
));
148 $.widget('civi.crmSnippet', {
154 _originalContent
: null,
156 isOriginalUrl: function() {
160 newUrl
= this._formatUrl(this.options
.url
),
161 oldUrl
= this._formatUrl(this._originalUrl
);
163 if (newUrl
.split('?')[0] !== oldUrl
.split('?')[0]) {
167 $.each(newUrl
.split('?')[1].split('&'), function(k
, v
) {
168 var arg
= v
.split('=');
169 args
[arg
[0]] = arg
[1];
171 $.each(oldUrl
.split('?')[1].split('&'), function(k
, v
) {
172 var arg
= v
.split('=');
173 if (args
[arg
[0]] !== undefined && arg
[1] !== args
[arg
[0]]) {
179 resetUrl: function() {
180 this.options
.url
= this._originalUrl
;
182 _create: function() {
183 this.element
.addClass('crm-ajax-container');
184 if (!this.element
.is('.crm-container *')) {
185 this.element
.addClass('crm-container');
187 this._handleOrderLinks();
188 // Set default if not supplied
189 this.options
.url
= this.options
.url
|| document
.location
.href
;
190 this._originalUrl
= this.options
.url
;
192 _onFailure: function(data
, status
) {
193 var msg
, title
= ts('Network Error');
194 if (this.options
.block
) this.element
.unblock();
195 this.element
.trigger('crmAjaxFail', data
);
198 title
= ts('Access Denied');
199 msg
= ts('Ensure you are still logged in and have permission to access this feature.');
202 msg
= ts('Unable to reach the server. Please refresh this page in your browser and try again.');
204 CRM
.alert(msg
, title
, 'error');
206 _onError: function(data
) {
207 this.element
.attr('data-unsaved-changes', 'false').trigger('crmAjaxError', data
);
208 if (this.options
.crmForm
&& this.options
.crmForm
.autoClose
&& this.element
.data('uiDialog')) {
209 this.element
.dialog('close');
212 _formatUrl: function(url
, snippetType
) {
214 url
= url
.split('#')[0];
215 // Add snippet argument to url
217 if (url
.search(/[&?]snippet=/) < 0) {
218 url
+= (url
.indexOf('?') < 0 ? '?' : '&') + 'snippet=' + snippetType
;
220 url
= url
.replace(/snippet=[^&]*/, 'snippet=' + snippetType
);
225 // Hack to deal with civicrm legacy sort functionality
226 _handleOrderLinks: function() {
228 $('a.crm-weight-arrow', that
.element
).click(function(e
) {
229 if (that
.options
.block
) that
.element
.block();
230 $.getJSON(that
._formatUrl(this.href
, 'json')).done(function() {
233 e
.stopImmediatePropagation();
237 refresh: function() {
239 var url
= this._formatUrl(this.options
.url
, 'json');
240 if (this.options
.crmForm
) $('form', this.element
).ajaxFormUnbind();
241 if (this.options
.block
) this.element
.block();
242 $.getJSON(url
, function(data
) {
243 if (data
.status
=== 'redirect') {
244 that
.options
.url
= data
.userContext
;
245 return that
.refresh();
247 if (that
.options
.block
) that
.element
.unblock();
248 if (!$.isPlainObject(data
)) {
249 that
._onFailure(data
);
252 if (data
.status
=== 'error') {
257 that
.element
.trigger('crmUnload').trigger('crmBeforeLoad', data
);
258 that
._beforeRemovingContent();
259 that
.element
.html(data
.content
);
260 that
._handleOrderLinks();
261 that
.element
.trigger('crmLoad', data
);
262 if (that
.options
.crmForm
) that
.element
.trigger('crmFormLoad', data
);
263 // This is only needed by forms that load via ajax but submit without ajax, e.g. configure contribution page tabs
264 // TODO: remove this when those forms have been converted to use ajax submit
265 if (data
.status
=== 'form_error' && $.isPlainObject(data
.errors
)) {
266 that
.element
.trigger('crmFormError', data
);
267 $.each(data
.errors
, function(formElement
, msg
) {
268 $('[name="'+formElement
+'"]', that
.element
).crmError(msg
);
271 }).fail(function(data
, msg
, status
) {
272 that
._onFailure(data
, status
);
275 // Perform any cleanup needed before removing/replacing content
276 _beforeRemovingContent: function() {
278 // Save original content to be restored if widget is destroyed
279 if (this._originalContent
=== null) {
280 $('.blockUI', this.element
).remove();
281 this._originalContent
= this.element
.contents().detach();
283 if (this.options
.crmForm
) $('form', this.element
).ajaxFormUnbind();
285 _destroy: function() {
286 this.element
.removeClass('crm-ajax-container').trigger('crmUnload');
287 this._beforeRemovingContent();
288 if (this._originalContent
!== null) {
289 this.element
.empty().append(this._originalContent
);
295 exclude
= '[href^=#], [href^=javascript], [onclick], .no-popup, .cancel';
297 CRM
.loadPage = function(url
, options
) {
299 target
: '#crm-ajax-dialog-' + (dialogCount
++),
300 dialog
: (options
&& options
.target
) ? false : {}
302 if (options
) $.extend(true, settings
, options
);
305 if (settings
.dialog
) {
306 settings
.dialog
= CRM
.utils
.adjustDialogDefaults(settings
.dialog
);
307 $('<div id="' + settings
.target
.substring(1) + '"></div>')
308 .dialog(settings
.dialog
)
309 .parent().find('.ui-dialog-titlebar')
310 .append($('<a class="crm-dialog-titlebar-print ui-dialog-titlebar-close" title="'+ts('Print window')+'" target="_blank" style="right:3.8em;"/>')
311 .button({icons
: {primary
: 'fa-print'}, text
: false}));
313 // Add handlers to new or existing dialog
314 if ($(settings
.target
).data('uiDialog')) {
316 .on('dialogclose', function() {
317 if (settings
.dialog
&& $(this).attr('data-unsaved-changes') !== 'true') {
318 $(this).crmSnippet('destroy').dialog('destroy').remove();
321 .on('crmLoad', function(e
, data
) {
323 if (e
.target
=== $(settings
.target
)[0] && data
&& !settings
.dialog
.title
&& data
.title
) {
324 $(this).dialog('option', 'title', data
.title
);
327 $(this).parent().find('a.crm-dialog-titlebar-print').attr('href', $(this).data('civiCrmSnippet')._formatUrl($(this).crmSnippet('option', 'url'), '2'));
330 $(settings
.target
).crmSnippet(settings
).crmSnippet('refresh');
331 return $(settings
.target
);
333 CRM
.loadForm = function(url
, options
) {
334 var formErrors
= [], settings
= {
339 refreshAction
: ['next_new', 'submit_savenext', 'upload_new'],
340 cancelButton
: '.cancel',
341 openInline
: 'a.open-inline, a.button, a.action-item, a.open-inline-noreturn',
342 onCancel: function(event
) {}
345 // Move options that belong to crmForm. Others will be passed through to crmSnippet
346 if (options
) $.each(options
, function(key
, value
) {
347 if (typeof(settings
.crmForm
[key
]) !== 'undefined') {
348 settings
.crmForm
[key
] = value
;
351 settings
[key
] = value
;
355 var widget
= CRM
.loadPage(url
, settings
).off('.crmForm');
357 // CRM-14353 - Warn of unsaved changes for all forms except those which have opted out
358 function cancelAction() {
359 var dirty
= CRM
.utils
.initialValueChanged($('form:not([data-warn-changes=false])', widget
));
360 widget
.attr('data-unsaved-changes', dirty
? 'true' : 'false');
362 var id
= widget
.attr('id') + '-unsaved-alert',
363 title
= widget
.dialog('option', 'title'),
364 alert
= CRM
.alert('<p>' + ts('%1 has not been saved.', {1: title
}) + '</p><p><a href="#" id="' + id
+ '">' + ts('Restore') + '</a></p>', ts('Unsaved Changes'), 'alert unsaved-dialog', {expires
: 60000});
365 $('#' + id
).button({icons
: {primary
: 'fa-undo'}}).click(function(e
) {
366 widget
.attr('data-unsaved-changes', 'false').dialog('open');
372 if (widget
.data('uiDialog')) widget
.on('dialogbeforeclose', function(e
) {
373 // CRM-14353 - Warn unsaved changes if user clicks close button or presses "esc"
374 if (e
.originalEvent
) {
379 widget
.on('crmFormLoad.crmForm', function(event
, data
) {
380 var $el
= $(this).attr('data-unsaved-changes', 'false'),
381 settings
= $el
.crmSnippet('option', 'crmForm');
382 if (settings
.cancelButton
) $(settings
.cancelButton
, this).click(function(e
) {
384 var returnVal
= settings
.onCancel
.call($el
, e
);
385 if (returnVal
!== false) {
386 $el
.trigger('crmFormCancel', e
);
387 if ($el
.data('uiDialog') && settings
.autoClose
) {
391 else if (!settings
.autoClose
) {
392 $el
.crmSnippet('resetUrl').crmSnippet('refresh');
396 if (settings
.validate
) {
397 $("form", this).crmValidate();
399 $("form:not('[data-no-ajax-submit=true]')", this).ajaxForm($.extend({
400 url
: data
.url
.replace(/reset=1[&]?/, ''),
402 success: function(response
) {
403 if (response
.content
=== undefined) {
404 $el
.trigger('crmFormSuccess', response
);
405 // Reset form for e.g. "save and new"
406 if (response
.userContext
&& (response
.status
=== 'redirect' || (settings
.refreshAction
&& $.inArray(response
.buttonName
, settings
.refreshAction
) >= 0))) {
407 // Force reset of original url
408 $el
.data('civiCrmSnippet')._originalUrl
= response
.userContext
;
409 $el
.crmSnippet('resetUrl').crmSnippet('refresh');
411 // Close if we are on the original url or the action was "delete" (in which case returning to view may be inappropriate)
412 else if ($el
.data('uiDialog') && (settings
.autoClose
|| response
.action
=== 8)) {
415 else if (settings
.autoClose
=== false) {
416 $el
.crmSnippet('resetUrl').crmSnippet('refresh');
420 if ($el
.crmSnippet('option', 'block')) $el
.unblock();
421 response
.url
= data
.url
;
422 $el
.html(response
.content
).trigger('crmLoad', response
).trigger('crmFormLoad', response
);
423 if (response
.status
=== 'form_error') {
425 $el
.trigger('crmFormError', response
);
426 $.each(response
.errors
|| [], function(formElement
, msg
) {
427 formErrors
.push($('[name="'+formElement
+'"]', $el
).crmError(msg
));
432 beforeSubmit: function(submission
) {
433 $.each(formErrors
, function() {
434 if (this && this.close
) this.close();
436 if ($el
.crmSnippet('option', 'block')) $el
.block();
437 $el
.trigger('crmFormSubmit', submission
);
439 }, settings
.ajaxForm
));
440 if (settings
.openInline
) {
441 settings
.autoClose
= $el
.crmSnippet('isOriginalUrl');
442 $(this).off('.openInline').on('click.openInline', settings
.openInline
, function(e
) {
443 if ($(this).is(exclude
+ ', .crm-popup')) {
446 if ($(this).hasClass('open-inline-noreturn')) {
447 // Force reset of original url
448 $el
.data('civiCrmSnippet')._originalUrl
= $(this).attr('href');
450 $el
.crmSnippet('option', 'url', $(this).attr('href')).crmSnippet('refresh');
454 if ($el
.data('uiDialog')) {
455 // Show form buttons as part of the dialog
456 var buttonContainers
= '.crm-submit-buttons, .action-link',
459 $(buttonContainers
, $el
).find('input.crm-form-submit, a.button').each(function() {
461 label
= $el
.is('input') ? $el
.attr('value') : $el
.text(),
462 identifier
= $el
.attr('name') || $el
.attr('href');
463 if (!identifier
|| identifier
=== '#' || $.inArray(identifier
, added
) < 0) {
464 var $icon
= $el
.find('.icon, .crm-i'),
465 button
= {'data-identifier': identifier
, text
: label
, click: function() {
469 button
.icons
= {primary
: $icon
.attr('class')};
471 var action
= $el
.attr('crm-icon') || ($el
.hasClass('cancel') ? 'fa-times' : 'fa-check');
472 button
.icons
= {primary
: action
};
474 buttons
.push(button
);
475 added
.push(identifier
);
477 // display:none causes the form to not submit when pressing "enter"
478 $el
.parents(buttonContainers
).css({height
: 0, padding
: 0, margin
: 0, overflow
: 'hidden'}).find('.crm-button-icon').hide();
480 $el
.dialog('option', 'buttons', buttons
);
482 // Allow a button to prevent ajax submit
483 $('input[data-no-ajax-submit=true]').click(function() {
484 $(this).closest('form').ajaxFormUnbind();
486 // For convenience, focus the first field
487 $('input[type=text], textarea, select', this).filter(':visible').first().not('.dateplugin').focus();
492 * Handler for jQuery click event e.g. $('a').click(CRM.popup);
494 CRM
.popup = function(e
) {
495 var $el
= $(this).first(),
496 url
= $el
.attr('href'),
497 popup
= $el
.data('popup-type') === 'page' ? CRM
.loadPage
: CRM
.loadForm
,
498 settings
= $el
.data('popup-settings') || {},
500 settings
.dialog
= settings
.dialog
|| {};
501 if (e
.isDefaultPrevented() || !CRM
.config
.ajaxPopupsEnabled
|| !url
|| $el
.is(exclude
+ ', .open-inline, .open-inline-noreturn')) {
504 // Sized based on css class
505 if ($el
.hasClass('small-popup')) {
506 settings
.dialog
.width
= 400;
507 settings
.dialog
.height
= 300;
509 else if ($el
.hasClass('medium-popup')) {
510 settings
.dialog
.width
= settings
.dialog
.height
= '50%';
512 var dialog
= popup(url
, settings
);
513 // Trigger events from the dialog on the original link element
514 $el
.trigger('crmPopupOpen', [dialog
]);
515 // Listen for success events and buffer them so we only trigger once
516 dialog
.on('crmFormSuccess.crmPopup crmPopupFormSuccess.crmPopup', function(e
, data
) {
519 dialog
.on('dialogclose.crmPopup', function(e
, data
) {
521 $el
.trigger('crmPopupFormSuccess', [dialog
, formData
]);
523 $el
.trigger('crmPopupClose', [dialog
, data
]);
528 * An event callback for CRM.popup or a standalone function to refresh the content around a given element
529 * @param e {event|selector}
531 CRM
.refreshParent = function(e
) {
532 // Use e.target if input smells like an event, otherwise assume it's a jQuery selector
533 var $el
= (e
.stopPropagation
&& e
.target
) ? $(e
.target
) : $(e
),
534 $table
= $el
.closest('.dataTable');
535 // Call native refresh method on ajax datatables
536 if ($table
.length
&& $.fn
.DataTable
.fnIsDataTable($table
[0]) && $table
.dataTable().fnSettings().sAjaxSource
) {
537 // Refresh ALL datatables - needed for contact relationship tab
538 $.each($.fn
.dataTable
.fnTables(), function() {
539 if ($(this).dataTable().fnSettings().sAjaxSource
) $(this).unblock().dataTable().fnDraw();
542 // Otherwise refresh the nearest crmSnippet
544 $el
.closest('.crm-ajax-container, #crm-main-content-wrapper').crmSnippet().crmSnippet('refresh');
550 .on('click', 'a.crm-popup', CRM
.popup
)
551 // Close unsaved dialog messages
552 .on('dialogopen', function(e
) {
553 $('.alert.unsaved-dialog .ui-notify-cross', '#crm-notification-container').click();
555 // Destroy old unsaved dialog
556 .on('dialogcreate', function(e
) {
557 $('.ui-dialog-content.crm-ajax-container:hidden[data-unsaved-changes=true]').crmSnippet('destroy').dialog('destroy').remove();
559 // Ensure wysiwyg content is updated prior to ajax submit
560 .on('form-pre-serialize', function(e
) {
561 $('.crm-wysiwyg-enabled', e
.target
).each(function() {
562 CRM
.wysiwyg
.updateElement(this);
565 // Auto-resize dialogs when loading content
566 .on('crmLoad dialogopen', 'div.ui-dialog.ui-resizable.crm-container', function(e
) {
569 $dialog
= $wrapper
.children('.ui-dialog-content');
570 // small delay to allow contents to render
571 window
.setTimeout(function() {
572 var currentHeight
= $wrapper
.outerHeight(),
573 padding
= currentHeight
- $dialog
.height(),
574 newHeight
= $dialog
.prop('scrollHeight') + padding
,
575 menuHeight
= $('#civicrm-menu').outerHeight(),
576 maxHeight
= $(window
).height() - menuHeight
;
577 newHeight
= newHeight
> maxHeight
? maxHeight
: newHeight
;
578 if (newHeight
> (currentHeight
+ 15)) {
579 $dialog
.dialog('option', {
580 position
: {my
: 'center', at
: 'center center+' + (menuHeight
/ 2), of: window
},