Commit | Line | Data |
---|---|---|
53f2643c CW |
1 | // https://civicrm.org/licensing |
2 | /** | |
3 | * @see https://wiki.civicrm.org/confluence/display/CRMDOC/AJAX+Interface | |
4 | * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Ajax+Pages+and+Forms | |
5 | */ | |
6 | (function($, CRM) { | |
7 | /** | |
8 | * Almost like {crmURL} but on the client side | |
9 | * eg: var url = CRM.url('civicrm/contact/view', {reset:1,cid:42}); | |
10 | * or: $('a.my-link').crmURL(); | |
11 | */ | |
12 | var tplURL = '/civicrm/example?placeholder'; | |
13 | var urlInitted = false; | |
14 | CRM.url = function (p, params) { | |
15 | if (p == "init") { | |
16 | tplURL = params; | |
17 | urlInitted = true; | |
18 | return; | |
19 | } | |
20 | if (!urlInitted) { | |
21 | console && console.log && console.log('Warning: CRM.url called before initialization'); | |
22 | } | |
23 | params = params || ''; | |
24 | var frag = p.split ('?'); | |
25 | var url = tplURL.replace("civicrm/example", frag[0]); | |
26 | ||
27 | if (typeof(params) == 'string') { | |
28 | url = url.replace("placeholder", params); | |
29 | } | |
30 | else { | |
31 | url = url.replace("placeholder", $.param(params)); | |
32 | } | |
33 | if (frag[1]) { | |
34 | url += (url.indexOf('?') === (url.length - 1) ? '' : '&') + frag[1]; | |
35 | } | |
36 | // remove trailing "?" | |
37 | if (url.indexOf('?') === (url.length - 1)) { | |
38 | url = url.slice(0, (url.length - 1)); | |
39 | } | |
40 | return url; | |
41 | }; | |
42 | ||
43 | // Backwards compatible with jQuery fn | |
44 | $.extend ({'crmURL': | |
45 | function (p, params) { | |
46 | console && console.log && console.log('Calling crmURL from jQuery is deprecated. Please use CRM.url() instead.'); | |
47 | return CRM.url(p, params); | |
48 | } | |
49 | }); | |
50 | ||
51 | $.fn.crmURL = function () { | |
52 | return this.each(function() { | |
53 | if (this.href) { | |
54 | this.href = CRM.url(this.href); | |
55 | } | |
56 | }); | |
57 | }; | |
58 | ||
59 | /** | |
60 | * AJAX api | |
61 | */ | |
62 | CRM.api3 = function(entity, action, params, status) { | |
63 | if (typeof(entity) === 'string') { | |
64 | params = { | |
65 | entity: entity, | |
66 | action: action.toLowerCase(), | |
67 | json: JSON.stringify(params || {}) | |
68 | }; | |
69 | } else { | |
70 | params = { | |
71 | entity: 'api3', | |
72 | action: 'call', | |
73 | json: JSON.stringify(entity) | |
e4f4dc22 CW |
74 | }; |
75 | status = action; | |
53f2643c CW |
76 | } |
77 | var ajax = $.ajax({ | |
78 | url: CRM.url('civicrm/ajax/rest'), | |
79 | dataType: 'json', | |
80 | data: params, | |
81 | type: params.action.indexOf('get') < 0 ? 'POST' : 'GET' | |
82 | }); | |
83 | if (status) { | |
84 | // Default status messages | |
85 | if (status === true) { | |
86 | status = {success: params.action === 'delete' ? ts('Removed') : ts('Saved')}; | |
87 | if (params.action.indexOf('get') === 0) { | |
88 | status.start = ts('Loading...'); | |
89 | status.success = null; | |
90 | } | |
91 | } | |
92 | var messages = status === true ? {} : status; | |
93 | CRM.status(status, ajax); | |
94 | } | |
95 | return ajax; | |
96 | }; | |
97 | ||
98 | /** | |
99 | * @deprecated | |
100 | * AJAX api | |
101 | */ | |
102 | CRM.api = function(entity, action, params, options) { | |
103 | // Default settings | |
104 | var settings = { | |
105 | context: null, | |
106 | success: function(result, settings) { | |
107 | return true; | |
108 | }, | |
109 | error: function(result, settings) { | |
110 | $().crmError(result.error_message, ts('Error')); | |
111 | return false; | |
112 | }, | |
113 | callBack: function(result, settings) { | |
114 | if (result.is_error == 1) { | |
115 | return settings.error.call(this, result, settings); | |
116 | } | |
117 | return settings.success.call(this, result, settings); | |
118 | }, | |
119 | ajaxURL: 'civicrm/ajax/rest' | |
120 | }; | |
121 | action = action.toLowerCase(); | |
122 | // Default success handler | |
123 | switch (action) { | |
124 | case "update": | |
125 | case "create": | |
126 | case "setvalue": | |
127 | case "replace": | |
128 | settings.success = function() { | |
129 | CRM.status(ts('Saved')); | |
130 | return true; | |
131 | }; | |
132 | break; | |
133 | case "delete": | |
134 | settings.success = function() { | |
135 | CRM.status(ts('Removed')); | |
136 | return true; | |
137 | }; | |
138 | } | |
139 | params = { | |
140 | entity: entity, | |
141 | action: action, | |
142 | json: JSON.stringify(params) | |
143 | }; | |
144 | // Pass copy of settings into closure to preserve its value during multiple requests | |
145 | (function(stg) { | |
146 | $.ajax({ | |
147 | url: stg.ajaxURL.indexOf('http') === 0 ? stg.ajaxURL : CRM.url(stg.ajaxURL), | |
148 | dataType: 'json', | |
149 | data: params, | |
150 | type: action.indexOf('get') < 0 ? 'POST' : 'GET', | |
151 | success: function(result) { | |
152 | stg.callBack.call(stg.context, result, stg); | |
153 | } | |
154 | }); | |
155 | })($.extend({}, settings, options)); | |
156 | }; | |
157 | ||
158 | /** | |
159 | * Backwards compatible with jQuery fn | |
160 | * @deprecated | |
161 | */ | |
162 | $.fn.crmAPI = function(entity, action, params, options) { | |
163 | console && console.log && console.log('Calling crmAPI from jQuery is deprecated. Please use CRM.api() instead.'); | |
164 | return CRM.api.call(this, entity, action, params, options); | |
165 | }; | |
166 | ||
167 | $.widget('civi.crmSnippet', { | |
168 | options: { | |
169 | url: null, | |
170 | block: true, | |
171 | crmForm: null | |
172 | }, | |
173 | _originalContent: null, | |
174 | _originalUrl: null, | |
175 | isOriginalUrl: function() { | |
176 | var | |
177 | args = {}, | |
178 | same = true, | |
179 | newUrl = this._formatUrl(this.options.url), | |
180 | oldUrl = this._formatUrl(this._originalUrl); | |
181 | // Compare path | |
182 | if (newUrl.split('?')[0] !== oldUrl.split('?')[0]) { | |
183 | return false; | |
184 | } | |
185 | // Compare arguments | |
186 | $.each(newUrl.split('?')[1].split('&'), function(k, v) { | |
187 | var arg = v.split('='); | |
188 | args[arg[0]] = arg[1]; | |
189 | }); | |
190 | $.each(oldUrl.split('?')[1].split('&'), function(k, v) { | |
191 | var arg = v.split('='); | |
192 | if (args[arg[0]] !== undefined && arg[1] !== args[arg[0]]) { | |
193 | same = false; | |
194 | } | |
195 | }); | |
196 | return same; | |
197 | }, | |
198 | resetUrl: function() { | |
199 | this.options.url = this._originalUrl; | |
200 | }, | |
201 | _create: function() { | |
202 | this.element.addClass('crm-ajax-container'); | |
203 | if (!this.element.is('.crm-container *')) { | |
204 | this.element.addClass('crm-container'); | |
205 | } | |
206 | this._handleOrderLinks(); | |
207 | // Set default if not supplied | |
208 | this.options.url = this.options.url || document.location.href; | |
209 | this._originalUrl = this.options.url; | |
210 | }, | |
211 | _onFailure: function(data) { | |
212 | this.options.block && this.element.unblock(); | |
213 | this.element.trigger('crmAjaxFail', data); | |
214 | CRM.alert(ts('Unable to reach the server. Please refresh this page in your browser and try again.'), ts('Network Error'), 'error'); | |
215 | }, | |
216 | _formatUrl: function(url) { | |
217 | // Strip hash | |
218 | url = url.split('#')[0]; | |
219 | // Add snippet argument to url | |
220 | if (url.search(/[&?]snippet=/) < 0) { | |
221 | url += (url.indexOf('?') < 0 ? '?' : '&') + 'snippet=json'; | |
222 | } else { | |
223 | url = url.replace(/snippet=[^&]*/, 'snippet=json'); | |
224 | } | |
225 | return url; | |
226 | }, | |
227 | // Hack to deal with civicrm legacy sort functionality | |
228 | _handleOrderLinks: function() { | |
229 | var that = this; | |
230 | $('a.crm-weight-arrow', that.element).click(function(e) { | |
231 | that.options.block && that.element.block(); | |
232 | $.getJSON(that._formatUrl(this.href)).done(function() { | |
233 | that.refresh(); | |
234 | }); | |
235 | e.stopImmediatePropagation(); | |
236 | return false; | |
237 | }); | |
238 | }, | |
239 | refresh: function() { | |
240 | var that = this; | |
241 | var url = this._formatUrl(this.options.url); | |
242 | this.options.crmForm && $('form', this.element).ajaxFormUnbind(); | |
7e13d44e CW |
243 | if (this._originalContent === null) { |
244 | this._originalContent = this.element.contents().detach(); | |
245 | } | |
53f2643c CW |
246 | this.options.block && $('.blockOverlay', this.element).length < 1 && this.element.block(); |
247 | $.getJSON(url, function(data) { | |
248 | if (typeof(data) != 'object' || typeof(data.content) != 'string') { | |
249 | that._onFailure(data); | |
250 | return; | |
251 | } | |
252 | data.url = url; | |
7e13d44e | 253 | that.element.trigger('crmBeforeLoad', data).html(data.content); |
53f2643c CW |
254 | that._handleOrderLinks(); |
255 | that.element.trigger('crmLoad', data); | |
256 | that.options.crmForm && that.element.trigger('crmFormLoad', data); | |
257 | }).fail(function() { | |
258 | that._onFailure(); | |
259 | }); | |
260 | }, | |
261 | _destroy: function() { | |
262 | this.element.removeClass('crm-ajax-container'); | |
263 | this.options.crmForm && $('form', this.element).ajaxFormUnbind(); | |
264 | if (this._originalContent !== null) { | |
265 | this.element.empty().append(this._originalContent); | |
266 | } | |
267 | } | |
268 | }); | |
269 | ||
98465f9e CW |
270 | var dialogCount = 0, |
271 | exclude = '[href^=#], [href^=javascript], [onclick], .no-popup, .cancel'; | |
272 | ||
53f2643c CW |
273 | CRM.loadPage = function(url, options) { |
274 | var settings = { | |
275 | target: '#crm-ajax-dialog-' + (dialogCount++), | |
276 | dialog: false | |
277 | }; | |
278 | if (!options || !options.target) { | |
279 | settings.dialog = { | |
280 | modal: true, | |
281 | width: '65%', | |
282 | height: '75%' | |
283 | }; | |
284 | } | |
285 | options && $.extend(true, settings, options); | |
286 | settings.url = url; | |
287 | // Create new dialog | |
288 | if (settings.dialog) { | |
289 | // HACK: jQuery UI doesn't support relative height | |
a1c7d42f | 290 | if (typeof settings.dialog.height === 'string' && settings.dialog.height.indexOf('%') > 0) { |
53f2643c CW |
291 | settings.dialog.height = parseInt($(window).height() * (parseFloat(settings.dialog.height)/100), 10); |
292 | } | |
293 | $('<div id="'+ settings.target.substring(1) +'"><div class="crm-loading-element">' + ts('Loading') + '...</div></div>').dialog(settings.dialog); | |
294 | $(settings.target).on('dialogclose', function() { | |
15d60951 | 295 | if ($(this).attr('data-unsaved-changes') !== 'true') { |
7c2110fd CW |
296 | $(this).crmSnippet('destroy').dialog('destroy').remove(); |
297 | } | |
53f2643c CW |
298 | }); |
299 | } | |
300 | if (settings.dialog && !settings.dialog.title) { | |
301 | $(settings.target).on('crmLoad', function(e, data) { | |
302 | if (e.target === $(settings.target)[0] && data && data.title) { | |
303 | $(this).dialog('option', 'title', data.title); | |
304 | } | |
305 | }); | |
306 | } | |
307 | $(settings.target).crmSnippet(settings).crmSnippet('refresh'); | |
308 | return $(settings.target); | |
309 | }; | |
310 | CRM.loadForm = function(url, options) { | |
311 | var settings = { | |
312 | crmForm: { | |
313 | ajaxForm: {}, | |
314 | autoClose: true, | |
315 | validate: true, | |
02c82dda | 316 | refreshAction: ['next_new', 'submit_savenext', 'upload_new'], |
98465f9e CW |
317 | cancelButton: '.cancel', |
318 | openInline: 'a.open-inline, a.button, a.action-item', | |
53f2643c CW |
319 | onCancel: function(event) {}, |
320 | onError: function(data) { | |
321 | var $el = $(this); | |
322 | $el.html(data.content).trigger('crmLoad', data).trigger('crmFormLoad', data).trigger('crmFormError', data); | |
323 | if (typeof(data.errors) == 'object') { | |
324 | $.each(data.errors, function(formElement, msg) { | |
325 | $('[name="'+formElement+'"]', $el).crmError(msg); | |
326 | }); | |
327 | } | |
328 | } | |
329 | } | |
330 | }; | |
331 | // Move options that belong to crmForm. Others will be passed through to crmSnippet | |
332 | options && $.each(options, function(key, value) { | |
333 | if (typeof(settings.crmForm[key]) !== 'undefined') { | |
334 | settings.crmForm[key] = value; | |
335 | } | |
336 | else { | |
337 | settings[key] = value; | |
338 | } | |
339 | }); | |
340 | ||
341 | var widget = CRM.loadPage(url, settings).off('.crmForm'); | |
342 | ||
88e9380e | 343 | function cancelAction() { |
7c2110fd CW |
344 | var dirty = CRM.utils.initialValueChanged(widget), |
345 | title = widget.dialog('option', 'title'); | |
15d60951 | 346 | widget.attr('data-unsaved-changes', dirty ? 'true' : 'false').dialog('close'); |
7c2110fd CW |
347 | if (dirty) { |
348 | var id = widget.attr('id') + '-unsaved-alert', | |
15d60951 | 349 | 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}); |
8537b332 | 350 | $('#' + id).button({icons: {primary: 'ui-icon-arrowreturnthick-1-w'}}).click(function(e) { |
15d60951 | 351 | widget.attr('data-unsaved-changes', 'false').dialog('open'); |
8537b332 | 352 | e.preventDefault(); |
7c2110fd | 353 | }); |
88e9380e | 354 | } |
88e9380e CW |
355 | } |
356 | if (widget.data('uiDialog')) { | |
7c2110fd CW |
357 | // This is a bit harsh but we are removing jQuery UI's event handler from the close button and adding our own |
358 | $('.ui-dialog-titlebar-close').first().off().click(cancelAction); | |
88e9380e CW |
359 | } |
360 | ||
53f2643c | 361 | widget.on('crmFormLoad.crmForm', function(event, data) { |
7c2110fd | 362 | var $el = $(this) |
15d60951 | 363 | .attr('data-unsaved-changes', 'false'); |
53f2643c | 364 | var settings = $el.crmSnippet('option', 'crmForm'); |
7c2110fd CW |
365 | settings.cancelButton && $(settings.cancelButton, this).click(function(e) { |
366 | e.preventDefault(); | |
367 | var returnVal = settings.onCancel.call($el, e); | |
53f2643c | 368 | if (returnVal !== false) { |
7c2110fd | 369 | $el.trigger('crmFormCancel', e); |
53f2643c | 370 | if ($el.data('uiDialog') && settings.autoClose) { |
7c2110fd | 371 | cancelAction(); |
53f2643c CW |
372 | } |
373 | else if (!settings.autoClose) { | |
374 | $el.crmSnippet('resetUrl').crmSnippet('refresh'); | |
375 | } | |
376 | } | |
53f2643c CW |
377 | }); |
378 | if (settings.validate) { | |
379 | $("form", this).validate(typeof(settings.validate) == 'object' ? settings.validate : CRM.validate.params); | |
380 | } | |
cae80d9f | 381 | $("form:not('[data-no-ajax-submit=true]')", this).ajaxForm($.extend({ |
53f2643c CW |
382 | url: data.url.replace(/reset=1[&]?/, ''), |
383 | dataType: 'json', | |
384 | success: function(response) { | |
385 | if (response.status !== 'form_error') { | |
386 | $el.crmSnippet('option', 'block') && $el.unblock(); | |
387 | $el.trigger('crmFormSuccess', response); | |
388 | // Reset form for e.g. "save and new" | |
0a94ab7d | 389 | if (response.userContext && (response.status === 'redirect' || (settings.refreshAction && $.inArray(response.buttonName, settings.refreshAction) >= 0))) { |
b305fb88 CW |
390 | // Force reset of original url |
391 | $el.data('civiCrmSnippet')._originalUrl = response.userContext; | |
392 | $el.crmSnippet('resetUrl').crmSnippet('refresh'); | |
53f2643c CW |
393 | } |
394 | else if ($el.data('uiDialog') && settings.autoClose) { | |
395 | $el.dialog('close'); | |
396 | } | |
397 | else if (settings.autoClose === false) { | |
398 | $el.crmSnippet('resetUrl').crmSnippet('refresh'); | |
399 | } | |
400 | } | |
401 | else { | |
402 | response.url = data.url; | |
403 | settings.onError.call($el, response); | |
404 | } | |
405 | }, | |
406 | beforeSerialize: function(form, options) { | |
407 | if (window.CKEDITOR && window.CKEDITOR.instances) { | |
408 | $.each(CKEDITOR.instances, function() { | |
409 | this.updateElement && this.updateElement(); | |
410 | }); | |
411 | } | |
412 | }, | |
413 | beforeSubmit: function(submission) { | |
414 | $el.crmSnippet('option', 'block') && $el.block(); | |
415 | $el.trigger('crmFormSubmit', submission); | |
416 | } | |
417 | }, settings.ajaxForm)); | |
418 | if (settings.openInline) { | |
419 | settings.autoClose = $el.crmSnippet('isOriginalUrl'); | |
98465f9e | 420 | $(settings.openInline, this).not(exclude + ', .crm-popup').click(function(event) { |
53f2643c CW |
421 | $el.crmSnippet('option', 'url', $(this).attr('href')).crmSnippet('refresh'); |
422 | return false; | |
423 | }); | |
424 | } | |
425 | // For convenience, focus the first field | |
b18392cc | 426 | $('input[type=text], textarea, select', this).filter(':visible').first().not('.dateplugin').focus(); |
53f2643c CW |
427 | }); |
428 | return widget; | |
429 | }; | |
430 | /** | |
431 | * Handler for jQuery click event e.g. $('a').click(CRM.popup) | |
432 | * @returns {boolean} | |
433 | */ | |
35df910c | 434 | CRM.popup = function(e) { |
53f2643c CW |
435 | var $el = $(this).first(), |
436 | url = $el.attr('href'), | |
437 | popup = $el.data('popup-type') === 'page' ? CRM.loadPage : CRM.loadForm, | |
438 | settings = $el.data('popup-settings') || {}, | |
7fe745d1 | 439 | formSuccess = false; |
53f2643c | 440 | settings.dialog = settings.dialog || {}; |
35df910c | 441 | if (e.isDefaultPrevented() || !CRM.config.ajaxPopupsEnabled || !url || $el.is(exclude)) { |
53f2643c CW |
442 | return; |
443 | } | |
a1c7d42f CW |
444 | // Sized based on css class |
445 | if ($el.hasClass('small-popup')) { | |
53f2643c CW |
446 | settings.dialog.width = 400; |
447 | settings.dialog.height = 300; | |
448 | } | |
449 | else if ($el.hasClass('medium-popup')) { | |
450 | settings.dialog.width = settings.dialog.height = '50%'; | |
451 | } | |
452 | else if ($el.hasClass('huge-popup')) { | |
77042884 | 453 | settings.dialog.height = '90%'; |
53f2643c CW |
454 | } |
455 | var dialog = popup(url, settings); | |
456 | // Trigger events from the dialog on the original link element | |
457 | $el.trigger('crmPopupOpen', [dialog]); | |
4b472ff2 CW |
458 | // Listen for success events and buffer them so we only trigger once |
459 | dialog.on('crmFormSuccess.crmPopup crmPopupFormSuccess.crmPopup', function() { | |
7fe745d1 CW |
460 | formSuccess = true; |
461 | }); | |
462 | dialog.on('dialogclose.crmPopup', function(e, data) { | |
463 | if (formSuccess) { | |
464 | $el.trigger('crmPopupFormSuccess', [dialog, data]); | |
465 | } | |
466 | $el.trigger('crmPopupClose', [dialog, data]); | |
53f2643c | 467 | }); |
35df910c | 468 | e.preventDefault(); |
53f2643c | 469 | }; |
554b1768 CW |
470 | /** |
471 | * An event callback for CRM.popup or a standalone function to refresh the content around a popup link | |
472 | * @param e event|selector | |
473 | */ | |
474 | CRM.refreshParent = function(e) { | |
475 | // Use e.target if input smells like an event, otherwise assume it's a jQuery selector | |
476 | var $el = (e.stopPropagation && e.target) ? $(e.target) : $(e), | |
477 | $table = $el.closest('.dataTable'); | |
478 | // Call native refresh method on ajax datatables | |
479 | if ($table && $.fn.DataTable.fnIsDataTable($table[0]) && $table.dataTable().fnSettings().sAjaxSource) { | |
480 | // Refresh ALL datatables - needed for contact relationship tab | |
481 | $.each($.fn.dataTable.fnTables(), function() { | |
482 | $(this).dataTable().fnSettings().sAjaxSource && $(this).unblock().dataTable().fnDraw(); | |
483 | }); | |
484 | } | |
485 | // Otherwise refresh the nearest crmSnippet | |
486 | else { | |
487 | $el.closest('.crm-ajax-container, #crm-main-content-wrapper').crmSnippet().crmSnippet('refresh'); | |
488 | } | |
489 | }; | |
a1c7d42f CW |
490 | |
491 | $(function($) { | |
15d60951 CW |
492 | $('body') |
493 | .on('click', 'a.crm-popup', CRM.popup) | |
494 | // Close unsaved dialog messages | |
495 | .on('dialogopen', function(e) { | |
496 | $('.alert.unsaved-dialog .ui-notify-cross', '#crm-notification-container').click(); | |
497 | }) | |
498 | // Destroy old unsaved dialog | |
499 | .on('dialogcreate', function(e) { | |
500 | $('.ui-dialog-content.crm-ajax-container:hidden[data-unsaved-changes=true]').crmSnippet('destroy').dialog('destroy').remove(); | |
501 | }); | |
a1c7d42f CW |
502 | }); |
503 | ||
53f2643c | 504 | }(jQuery, CRM)); |