test fixes, I feel it's caching issue
[civicrm-core.git] / js / Common.js
CommitLineData
353ea873 1// https://civicrm.org/licensing
6a488035
TO
2var CRM = CRM || {};
3var cj = jQuery;
4
5/**
6 * Short-named function for string translation, defined in global scope so it's available everywhere.
7 *
353ea873
CW
8 * @param text string for translating
9 * @param params object key:value of additional parameters
6a488035 10 *
353ea873 11 * @return string
6a488035
TO
12 */
13function ts(text, params) {
7553cf23 14 "use strict";
6a488035 15 text = CRM.strings[text] || text;
2788147f 16 if (typeof(params) === 'object') {
6a488035 17 for (var i in params) {
32155ad6 18 if (typeof(params[i]) === 'string' || typeof(params[i]) === 'number') {
2788147f 19 // sprintf emulation: escape % characters in the replacements to avoid conflicts
32155ad6 20 text = text.replace(new RegExp('%' + i, 'g'), String(params[i]).replace(/%/g, '%-crmescaped-'));
2788147f 21 }
6a488035
TO
22 }
23 return text.replace(/%-crmescaped-/g, '%');
24 }
25 return text;
26}
27
28/**
29 * This function is called by default at the bottom of template files which have forms that have
30 * conditionally displayed/hidden sections and elements. The PHP is responsible for generating
31 * a list of 'blocks to show' and 'blocks to hide' and the template passes these parameters to
32 * this function.
33 *
353ea873 34 * @deprecated
6a488035
TO
35 * @param showBlocks Array of element Id's to be displayed
36 * @param hideBlocks Array of element Id's to be hidden
37 * @param elementType Value to set display style to for showBlocks (e.g. 'block' or 'table-row' or ...)
6a488035 38 */
0f5816a6
KJ
39function on_load_init_blocks(showBlocks, hideBlocks, elementType) {
40 if (elementType == null) {
41 var elementType = 'block';
42 }
43
44 /* This loop is used to display the blocks whose IDs are present within the showBlocks array */
45 for (var i = 0; i < showBlocks.length; i++) {
46 var myElement = document.getElementById(showBlocks[i]);
47 /* getElementById returns null if element id doesn't exist in the document */
48 if (myElement != null) {
49 myElement.style.display = elementType;
6a488035 50 }
0f5816a6
KJ
51 else {
52 alert('showBlocks array item not in .tpl = ' + showBlocks[i]);
53 }
54 }
6a488035 55
0f5816a6
KJ
56 /* This loop is used to hide the blocks whose IDs are present within the hideBlocks array */
57 for (var i = 0; i < hideBlocks.length; i++) {
58 var myElement = document.getElementById(hideBlocks[i]);
59 /* getElementById returns null if element id doesn't exist in the document */
60 if (myElement != null) {
61 myElement.style.display = 'none';
62 }
63 else {
64 alert('showBlocks array item not in .tpl = ' + hideBlocks[i]);
6a488035 65 }
0f5816a6 66 }
6a488035
TO
67}
68
69/**
70 * This function is called when we need to show or hide a related form element (target_element)
71 * based on the value (trigger_value) of another form field (trigger_field).
72 *
353ea873 73 * @deprecated
6a488035
TO
74 * @param trigger_field_id HTML id of field whose onchange is the trigger
75 * @param trigger_value List of integers - option value(s) which trigger show-element action for target_field
76 * @param target_element_id HTML id of element to be shown or hidden
77 * @param target_element_type Type of element to be shown or hidden ('block' or 'table-row')
78 * @param field_type Type of element radio/select
79 * @param invert Boolean - if true, we HIDE target on value match; if false, we SHOW target on value match
0f5816a6
KJ
80 */
81function showHideByValue(trigger_field_id, trigger_value, target_element_id, target_element_type, field_type, invert) {
82 if (target_element_type == null) {
83 var target_element_type = 'block';
84 }
85 else {
86 if (target_element_type == 'table-row') {
87 var target_element_type = '';
88 }
89 }
90
91 if (field_type == 'select') {
92 var trigger = trigger_value.split("|");
24cc4545 93 var selectedOptionValue = cj('#' + trigger_field_id).val();
0f5816a6
KJ
94
95 var target = target_element_id.split("|");
96 for (var j = 0; j < target.length; j++) {
97 if (invert) {
98 cj('#' + target[j]).show();
99 }
100 else {
101 cj('#' + target[j]).hide();
102 }
103 for (var i = 0; i < trigger.length; i++) {
104 if (selectedOptionValue == trigger[i]) {
105 if (invert) {
106 cj('#' + target[j]).hide();
107 }
108 else {
109 cj('#' + target[j]).show();
110 }
6a488035 111 }
0f5816a6
KJ
112 }
113 }
6a488035 114
0f5816a6
KJ
115 }
116 else {
117 if (field_type == 'radio') {
118 var target = target_element_id.split("|");
119 for (var j = 0; j < target.length; j++) {
24cc4545 120 if (cj('[name="' + trigger_field_id + '"]').is(':checked')) {
0f5816a6
KJ
121 if (invert) {
122 cj('#' + target[j]).hide();
123 }
124 else {
125 cj('#' + target[j]).show();
126 }
6a488035 127 }
0f5816a6
KJ
128 else {
129 if (invert) {
130 cj('#' + target[j]).show();
131 }
132 else {
133 cj('#' + target[j]).hide();
134 }
135 }
136 }
6a488035 137 }
0f5816a6 138 }
6a488035
TO
139}
140
6a488035
TO
141/**
142 * Function to change button text and disable one it is clicked
353ea873 143 * @deprecated
6a488035
TO
144 * @param obj object - the button clicked
145 * @param formID string - the id of the form being submitted
146 * @param string procText - button text after user clicks it
353ea873 147 * @return bool
6a488035 148 */
0f5816a6 149var submitcount = 0;
c6edd786 150/* Changes button label on submit, and disables button after submit for newer browsers.
151 Puts up alert for older browsers. */
0f5816a6
KJ
152function submitOnce(obj, formId, procText) {
153 // if named button clicked, change text
154 if (obj.value != null) {
155 obj.value = procText + " ...";
156 }
157 if (document.getElementById) { // disable submit button for newer browsers
158 obj.disabled = true;
159 document.getElementById(formId).submit();
160 return true;
161 }
162 else { // for older browsers
163 if (submitcount == 0) {
164 submitcount++;
165 return true;
166 }
167 else {
168 alert("Your request is currently being processed ... Please wait.");
169 return false;
6a488035 170 }
0f5816a6 171 }
6a488035 172}
353ea873
CW
173/**
174 * @deprecated
175 */
6a488035
TO
176function popUp(URL) {
177 day = new Date();
0f5816a6 178 id = day.getTime();
6a488035
TO
179 eval("page" + id + " = window.open(URL, '" + id + "', 'toolbar=0,scrollbars=1,location=0,statusbar=0,menubar=0,resizable=0,width=640,height=420,left = 202,top = 184');");
180}
181
6a488035
TO
182/**
183 * Function to show / hide the row in optionFields
353ea873
CW
184 * @deprecated
185 * @param index string, element whose innerHTML is to hide else will show the hidden row.
6a488035 186 */
0f5816a6
KJ
187function showHideRow(index) {
188 if (index) {
189 cj('tr#optionField_' + index).hide();
190 if (cj('table#optionField tr:hidden:first').length) {
191 cj('div#optionFieldLink').show();
6a488035 192 }
0f5816a6
KJ
193 }
194 else {
195 cj('table#optionField tr:hidden:first').show();
196 if (!cj('table#optionField tr:hidden:last').length) {
197 cj('div#optionFieldLink').hide();
198 }
199 }
200 return false;
6a488035
TO
201}
202
475e9f44 203CRM.utils = CRM.utils || {};
6a488035
TO
204CRM.strings = CRM.strings || {};
205CRM.validate = CRM.validate || {
206 params: {},
207 functions: []
208};
209
0f5816a6 210(function ($, undefined) {
7553cf23 211 "use strict";
d664f648 212
23e8a31b 213 $.fn.select2.defaults.dropdownCssClass = 'crm-container';
47f21f3a
CW
214 // https://github.com/ivaynberg/select2/pull/2090
215 $.fn.select2.defaults.width = 'resolve';
216
e20523a8
CW
217 // Workaround for https://github.com/ivaynberg/select2/issues/1246
218 $.ui.dialog.prototype._allowInteraction = function(e) {
219 return !!$(e.target).closest('.ui-dialog, .ui-datepicker, .select2-drop').length;
220 };
221
475e9f44
CW
222 /**
223 * Populate a select list, overwriting the existing options except for the placeholder.
224 * @param $el jquery collection - 1 or more select elements
225 * @param options array in format returned by api.getoptions
23e8a31b 226 * @param removePlaceholder bool
475e9f44 227 */
23e8a31b 228 CRM.utils.setOptions = function($el, options, removePlaceholder) {
475e9f44
CW
229 $el.each(function() {
230 var
231 $elect = $(this),
23e8a31b
CW
232 val = $elect.val() || [],
233 opts = removePlaceholder ? '' : '[value!=""]';
475e9f44
CW
234 if (typeof(val) !== 'array') {
235 val = [val];
236 }
23e8a31b 237 $elect.find('option' + opts).remove();
e6f4ac36 238 _.each(options, function(option) {
475e9f44
CW
239 var selected = ($.inArray(''+option.key, val) > -1) ? 'selected="selected"' : '';
240 $elect.append('<option value="' + option.key + '"' + selected + '>' + option.value + '</option>');
241 });
e6f4ac36 242 $elect.trigger('crmOptionsUpdated', $.extend({}, options)).trigger('change');
475e9f44
CW
243 });
244 };
245
ba4fb2b2 246 /**
353ea873 247 * Wrapper for select2 initialization function; supplies defaults
a88cf11a 248 * @param options object
ba4fb2b2 249 */
a88cf11a
CW
250 $.fn.crmSelect2 = function(options) {
251 return $(this).each(function () {
252 var
253 $el = $(this),
254 defaults = {allowClear: !$el.hasClass('required')};
255 // quickform doesn't support optgroups so here's a hack :(
256 $('option[value^=crm_optgroup]', this).each(function () {
257 $(this).nextUntil('option[value^=crm_optgroup]').wrapAll('<optgroup label="' + $(this).text() + '" />');
258 $(this).remove();
259 });
260 // Defaults for single-selects
261 if ($el.is('select:not([multiple])')) {
262 defaults.minimumResultsForSearch = 10;
263 if ($('option:first', this).val() === '') {
264 defaults.placeholderOption = 'first';
265 }
ba4fb2b2 266 }
a88cf11a
CW
267 $el.select2($.extend(defaults, $el.data('select-params') || {}, options || {}));
268 });
269 };
270
271 /**
353ea873 272 * @see CRM_Core_Form::addEntityRef for docs
a88cf11a
CW
273 * @param options object
274 */
275 $.fn.crmEntityRef = function(options) {
276 options = options || {};
277 options.select = options.select || {};
278 return $(this).each(function() {
279 var
280 $el = $(this),
281 entity = options.entity || $el.data('api-entity') || 'contact',
282 selectParams = {};
283 $el.data('api-entity', entity);
284 $el.data('select-params', $.extend({}, $el.data('select-params') || {}, options.select));
285 $el.data('api-params', $.extend({}, $el.data('api-params') || {}, options.api));
a4799f04 286 $el.data('create-links', options.create || $el.data('create-links'));
a88cf11a 287 $el.addClass('crm-ajax-select crm-' + entity + '-ref');
ba4fb2b2
CW
288 var settings = {
289 // Use select2 ajax helper instead of CRM.api because it provides more value
290 ajax: {
291 url: CRM.url('civicrm/ajax/rest'),
292 data: function (input, page_num) {
293 var params = $el.data('api-params') || {};
294 params.input = input;
295 params.page_num = page_num;
296 return {
297 entity: $el.data('api-entity'),
298 action: 'getlist',
299 json: JSON.stringify(params)
300 };
301 },
302 results: function(data) {
303 return {more: data.more_results, results: data.values || []};
304 }
305 },
a88cf11a 306 minimumInputLength: 1,
a4799f04 307 formatResult: formatSelect2Result,
ba4fb2b2
CW
308 formatSelection: function(row) {
309 return row.label;
310 },
311 escapeMarkup: function (m) {return m;},
a88cf11a
CW
312 initSelection: function($el, callback) {
313 var
314 multiple = !!$el.data('select-params').multiple,
315 val = $el.val(),
316 stored = $el.data('entity-value') || [];
317 if (val === '') {
318 return;
319 }
320 // If we already have this data, just return it
321 if (!_.xor(val.split(','), _.pluck(stored, 'id')).length) {
322 callback(multiple ? stored : stored[0]);
323 } else {
78b203e5 324 var params = $.extend({}, $el.data('api-params') || {}, {id: val});
a88cf11a
CW
325 CRM.api3($el.data('api-entity'), 'getlist', params).done(function(result) {
326 callback(multiple ? result.values : result.values[0])
327 });
328 }
ba4fb2b2
CW
329 }
330 };
331 if ($el.data('create-links')) {
a88cf11a
CW
332 selectParams.formatInputTooShort = function() {
333 var txt = $el.data('select-params').formatInputTooShort || $.fn.select2.defaults.formatInputTooShort.call(this);
a4799f04
CW
334 if ($el.data('create-links')) {
335 txt += ' ' + ts('or') + '<br />' + formatSelect2CreateLinks($el);
ba4fb2b2
CW
336 }
337 return txt;
338 };
a88cf11a 339 selectParams.formatNoMatches = function() {
ba4fb2b2 340 var txt = $el.data('select-params').formatNoMatches || $.fn.select2.defaults.formatNoMatches;
a4799f04 341 return txt + '<br />' + formatSelect2CreateLinks($el);
ba4fb2b2 342 };
a88cf11a 343 $el.off('.createLinks').on('select2-open.createLinks', function() {
ba4fb2b2
CW
344 var $el = $(this);
345 $('#select2-drop').off('.crmEntity').on('click.crmEntity', 'a.crm-add-entity', function(e) {
346 $el.select2('close');
347 CRM.loadForm($(this).attr('href'), {
348 dialog: {width: 500, height: 'auto'}
349 }).on('crmFormSuccess', function(e, data) {
c92f6436
CW
350 if (data.status === 'success' && data.id) {
351 if ($el.select2('container').hasClass('select2-container-multi')) {
352 var selection = $el.select2('data');
353 selection.push(data);
354 $el.select2('data', selection, true);
355 } else {
356 $el.select2('data', data, true);
357 }
ba4fb2b2
CW
358 }
359 });
360 return false;
361 });
362 });
363 }
a88cf11a
CW
364 $el.crmSelect2($.extend(settings, $el.data('select-params'), selectParams));
365 });
ba4fb2b2
CW
366 };
367
a4799f04 368 function formatSelect2Result(row) {
88881f79 369 var markup = '<div class="crm-select2-row">';
ff88d165 370 if (row.image !== undefined) {
88881f79 371 markup += '<div class="crm-select2-image"><img src="' + row.image + '"/></div>';
ff88d165 372 }
54bee7df 373 else if (row.icon_class) {
88881f79 374 markup += '<div class="crm-select2-icon"><div class="crm-icon ' + row.icon_class + '-icon"></div></div>';
54bee7df 375 }
88881f79
CW
376 markup += '<div><div class="crm-select2-row-label">' + row.label + '</div>';
377 markup += '<div class="crm-select2-row-description">';
378 $.each(row.description || [], function(k, text) {
379 markup += '<p>' + text + '</p>';
380 });
381 markup += '</div></div></div>';
ff88d165 382 return markup;
a4799f04
CW
383 }
384
385 function formatSelect2CreateLinks($el) {
386 var
387 createLinks = $el.data('create-links'),
388 api = $el.data('api-params') || {},
389 type = api.params ? api.params.contact_type : null;
390 if (createLinks === true) {
391 createLinks = type ? _.where(CRM.profile.contactCreate, {type: type}) : CRM.profile.contactCreate;
392 }
79ae07d9 393 var markup = '';
a4799f04 394 _.each(createLinks, function(link) {
79ae07d9 395 markup += ' <a class="crm-add-entity crm-hover-button" href="' + link.url + '">';
a4799f04
CW
396 if (link.type) {
397 markup += '<span class="icon ' + link.type + '-profile-icon"></span> ';
79ae07d9
CW
398 }
399 markup += link.label + '</a>';
400 });
401 return markup;
a4799f04 402 }
ff88d165 403
f7b92fcd 404 // Initialize widgets
eb90857a
CW
405 $(document)
406 .on('crmLoad', function(e) {
407 $('table.row-highlight', e.target)
408 .off('.rowHighlight')
409 .on('change.rowHighlight', 'input.select-row, input.select-rows', function () {
410 var target, table = $(this).closest('table');
411 if ($(this).hasClass('select-rows')) {
412 target = $('tbody tr', table);
413 $('input.select-row', table).prop('checked', $(this).prop('checked'));
414 }
415 else {
416 target = $(this).closest('tr');
417 $('input.select-rows', table).prop('checked', $(".select-row:not(':checked')", table).length < 1);
418 }
419 target.toggleClass('crm-row-selected', $(this).is(':checked'));
420 })
421 .find('input.select-row:checked').parents('tr').addClass('crm-row-selected');
422 $('.crm-select2:not(.select2-offscreen)', e.target).crmSelect2();
423 $('.crm-form-entityref:not(.select2-offscreen)', e.target).crmEntityRef();
424 })
425 // Modal dialogs should disable scrollbars
426 .on('dialogopen', function(e) {
427 if ($(e.target).dialog('option', 'modal')) {
428 $(e.target).addClass('modal-dialog');
429 $('body').css({overflow: 'hidden'});
430 }
431 })
432 .on('dialogclose', function(e) {
e0fb89c1 433 if ($('.ui-dialog .modal-dialog').not(e.target).length < 1) {
eb90857a
CW
434 $('body').css({overflow: ''});
435 }
436 });
148c4e8d
CW
437
438 /**
439 * Function to make multiselect boxes behave as fields in small screens
440 */
441 function advmultiselectResize() {
442 var amswidth = $("#crm-container form:has(table.advmultiselect)").width();
443 if (amswidth < 700) {
444 $("form table.advmultiselect td").css('display', 'block');
0f5816a6
KJ
445 }
446 else {
148c4e8d
CW
447 $("form table.advmultiselect td").css('display', 'table-cell');
448 }
449 var contactwidth = $('#crm-container #mainTabContainer').width();
450 if (contactwidth < 600) {
451 $('#crm-container #mainTabContainer').addClass('narrowpage');
0f5816a6 452 $('#crm-container #mainTabContainer.narrowpage #contactTopBar td').each(function (index) {
148c4e8d 453 if (index > 1) {
0f5816a6 454 if (index % 2 == 0) {
148c4e8d
CW
455 $(this).parent().after('<tr class="narrowadded"></tr>');
456 }
457 var item = $(this);
458 $(this).parent().next().append(item);
459 }
460 });
0f5816a6
KJ
461 }
462 else {
148c4e8d 463 $('#crm-container #mainTabContainer.narrowpage').removeClass('narrowpage');
0f5816a6 464 $('#crm-container #mainTabContainer #contactTopBar tr.narrowadded td').each(function () {
148c4e8d
CW
465 var nitem = $(this);
466 var parent = $(this).parent();
467 $(this).parent().prev().append(nitem);
0f5816a6 468 if (parent.children().size() == 0) {
148c4e8d
CW
469 parent.remove();
470 }
471 });
472 $('#crm-container #mainTabContainer.narrowpage #contactTopBar tr.added').detach();
473 }
474 var cformwidth = $('#crm-container #Contact .contact_basic_information-section').width();
0f5816a6 475
148c4e8d
CW
476 if (cformwidth < 720) {
477 $('#crm-container .contact_basic_information-section').addClass('narrowform');
478 $('#crm-container .contact_basic_information-section table.form-layout-compressed td .helpicon').parent().addClass('hashelpicon');
479 if (cformwidth < 480) {
480 $('#crm-container .contact_basic_information-section').addClass('xnarrowform');
0f5816a6
KJ
481 }
482 else {
148c4e8d
CW
483 $('#crm-container .contact_basic_information-section.xnarrowform').removeClass('xnarrowform');
484 }
0f5816a6
KJ
485 }
486 else {
148c4e8d
CW
487 $('#crm-container .contact_basic_information-section.narrowform').removeClass('narrowform');
488 $('#crm-container .contact_basic_information-section.xnarrowform').removeClass('xnarrowform');
489 }
490 }
0f5816a6 491
148c4e8d 492 advmultiselectResize();
0f5816a6 493 $(window).resize(function () {
6a488035
TO
494 advmultiselectResize();
495 });
496
0f5816a6 497 $.fn.crmtooltip = function () {
2c29c2ac
RN
498 $(document)
499 .on('mouseover', 'a.crm-summary-link:not(.crm-processed)', function (e) {
500 $(this).addClass('crm-processed');
e24b17b9
CW
501 $(this).addClass('crm-tooltip-active');
502 var topDistance = e.pageY - $(window).scrollTop();
503 if (topDistance < 300 | topDistance < $(this).children('.crm-tooltip-wrapper').height()) {
504 $(this).addClass('crm-tooltip-down');
505 }
506 if (!$(this).children('.crm-tooltip-wrapper').length) {
6a488035
TO
507 $(this).append('<div class="crm-tooltip-wrapper"><div class="crm-tooltip"></div></div>');
508 $(this).children().children('.crm-tooltip')
509 .html('<div class="crm-loading-element"></div>')
510 .load(this.href);
511 }
512 })
2c29c2ac
RN
513 .on('mouseout', 'a.crm-summary-link', function () {
514 $(this).removeClass('crm-processed');
e24b17b9
CW
515 $(this).removeClass('crm-tooltip-active crm-tooltip-down');
516 })
2c29c2ac 517 .on('click', 'a.crm-summary-link', false);
6a488035
TO
518 };
519
b0ca6188 520 var helpDisplay, helpPrevious;
8e3272a1 521 CRM.help = function (title, params, url) {
55a93b02 522 if (helpDisplay && helpDisplay.close) {
b0ca6188 523 // If the same link is clicked twice, just close the display - todo use underscore method for this comparison
55a93b02
CW
524 if (helpDisplay.isOpen && helpPrevious === JSON.stringify(params)) {
525 helpDisplay.close();
b0ca6188
CW
526 return;
527 }
55a93b02 528 helpDisplay.close();
b0ca6188
CW
529 }
530 helpPrevious = JSON.stringify(params);
6a488035
TO
531 params.class_name = 'CRM_Core_Page_Inline_Help';
532 params.type = 'page';
b0ca6188 533 helpDisplay = CRM.alert('...', title, 'crm-help crm-msg-loading', {expires: 0});
8e3272a1 534 $.ajax(url || CRM.url('civicrm/ajax/inline'),
6a488035
TO
535 {
536 data: params,
537 dataType: 'html',
e24b17b9 538 success: function (data) {
6a488035
TO
539 $('#crm-notification-container .crm-help .notify-content:last').html(data);
540 $('#crm-notification-container .crm-help').removeClass('crm-msg-loading').addClass('info');
541 },
e24b17b9 542 error: function () {
6a488035
TO
543 $('#crm-notification-container .crm-help .notify-content:last').html('Unable to load help file.');
544 $('#crm-notification-container .crm-help').removeClass('crm-msg-loading').addClass('error');
545 }
546 }
547 );
548 };
8960d9b9
CW
549 /**
550 * @param startMsg string
551 * @param endMsg string|function
552 * @param deferred optional jQuery deferred object
553 * @return jQuery deferred object - if not supplied a new one will be created
554 */
555 var fadeOut;
556 CRM.status = function(startMsg, endMsg, deferred) {
557 var $bar = $('#civicrm-menu');
558 if (!$bar.length) {
559 console && console.log && console.log('CRM.status called on a page with no menubar');
560 return;
561 }
562 $('.crm-menubar-status-container', $bar).remove();
563 fadeOut && window.clearTimeout(fadeOut);
564 $bar.append('<li class="crm-menubar-status-container status-busy"><div class="crm-menubar-status-progressbar"><div class="crm-menubar-status-msg">' + startMsg + '</div></div></li>');
565 $('.crm-menubar-status-container', $bar).css('min-width', $('.crm-menubar-status-container', $bar).width());
566 deferred || (deferred = new $.Deferred());
567 deferred.done(function(data) {
568 var msg = typeof(endMsg) === 'function' ? endMsg(data) : endMsg;
4bad157e
CW
569 $('.crm-menubar-status-container', $bar).removeClass('status-busy').addClass('status-done').show().find('.crm-menubar-status-msg').html(msg);
570 if (msg) {
571 fadeOut = window.setTimeout(function() {
572 $('.crm-menubar-status-container', $bar).fadeOut('slow');
573 }, 2000);
574 } else {
575 $('.crm-menubar-status-container', $bar).hide();
576 }
8960d9b9
CW
577 });
578 return deferred;
579 };
6a488035
TO
580
581 /**
582 * @param string text Displayable message
583 * @param string title Displayable title
584 * @param string type 'alert'|'info'|'success'|'error' (default: 'alert')
585 * @param {object} options
586 * @return {*}
587 * @see http://wiki.civicrm.org/confluence/display/CRM/Notifications+in+CiviCRM
588 */
0f5816a6 589 CRM.alert = function (text, title, type, options) {
6a488035
TO
590 type = type || 'alert';
591 title = title || '';
592 options = options || {};
593 if ($('#crm-notification-container').length) {
594 var params = {
595 text: text,
596 title: title,
597 type: type
598 };
599 // By default, don't expire errors and messages containing links
600 var extra = {
601 expires: (type == 'error' || text.indexOf('<a ') > -1) ? 0 : (text ? 10000 : 5000),
602 unique: true
603 };
604 options = $.extend(extra, options);
e24b17b9 605 options.expires = options.expires === false ? 0 : parseInt(options.expires, 10);
6a488035 606 if (options.unique && options.unique !== '0') {
0f5816a6 607 $('#crm-notification-container .ui-notify-message').each(function () {
6a488035
TO
608 if (title === $('h1', this).html() && text === $('.notify-content', this).html()) {
609 $('.icon.ui-notify-close', this).click();
610 }
611 });
612 }
613 return $('#crm-notification-container').notify('create', params, options);
614 }
615 else {
616 if (title.length) {
617 text = title + "\n" + text;
618 }
619 alert(text);
620 return null;
621 }
e24b17b9 622 };
6a488035
TO
623
624 /**
625 * Close whichever alert contains the given node
626 *
627 * @param node
628 */
0f5816a6 629 CRM.closeAlertByChild = function (node) {
6a488035 630 $(node).closest('.ui-notify-message').find('.icon.ui-notify-close').click();
e24b17b9 631 };
6a488035
TO
632
633 /**
634 * Prompt the user for confirmation.
635 *
7553cf23
CW
636 * @param buttons {object|function} key|value pairs where key == button label and value == callback function
637 * passing in a function instead of an object is a shortcut for a sinlgle button labeled "Continue"
638 * @param options {object|void} Override defaults, keys include 'title', 'message',
639 * see jQuery.dialog for full list of available params
ebb5fc58 640 * @param cancelLabel {string}
6a488035 641 */
706cff6d 642 CRM.confirm = function (buttons, options, cancelLabel) {
7553cf23 643 var dialog, callbacks = {};
706cff6d 644 cancelLabel = cancelLabel || ts('Cancel');
7553cf23
CW
645 var settings = {
646 title: ts('Confirm Action'),
647 message: ts('Are you sure you want to continue?'),
6a488035
TO
648 resizable: false,
649 modal: true,
0d5f99d4 650 width: 'auto',
0f5816a6
KJ
651 close: function () {
652 $(dialog).remove();
653 },
7553cf23
CW
654 buttons: {}
655 };
706cff6d
KJ
656
657 settings.buttons[cancelLabel] = function () {
0f5816a6
KJ
658 dialog.dialog('close');
659 };
7553cf23
CW
660 options = options || {};
661 $.extend(settings, options);
662 if (typeof(buttons) === 'function') {
663 callbacks[ts('Continue')] = buttons;
0f5816a6
KJ
664 }
665 else {
7553cf23
CW
666 callbacks = buttons;
667 }
0f5816a6
KJ
668 $.each(callbacks, function (label, callback) {
669 settings.buttons[label] = function () {
ebb5fc58
CW
670 if (callback.call(dialog) !== false) {
671 dialog.dialog('close');
672 }
e24b17b9 673 };
6a488035 674 });
7553cf23
CW
675 dialog = $('<div class="crm-container crm-confirm-dialog"></div>')
676 .html(options.message)
677 .appendTo('body')
678 .dialog(settings);
679 return dialog;
e24b17b9 680 };
6a488035
TO
681
682 /**
683 * Sets an error message
684 * If called for a form item, title and removal condition will be handled automatically
685 */
0f5816a6 686 $.fn.crmError = function (text, title, options) {
6a488035
TO
687 title = title || '';
688 text = text || '';
689 options = options || {};
690
691 var extra = {
692 expires: 0
693 };
694 if ($(this).length) {
695 if (title == '') {
696 var label = $('label[for="' + $(this).attr('name') + '"], label[for="' + $(this).attr('id') + '"]').not('[generated=true]');
697 if (label.length) {
698 label.addClass('crm-error');
699 var $label = label.clone();
700 if (text == '' && $('.crm-marker', $label).length > 0) {
701 text = $('.crm-marker', $label).attr('title');
702 }
703 $('.crm-marker', $label).remove();
704 title = $label.text();
705 }
706 }
707 $(this).addClass('error');
708 }
709 var msg = CRM.alert(text, title, 'error', $.extend(extra, options));
710 if ($(this).length) {
711 var ele = $(this);
0f5816a6
KJ
712 setTimeout(function () {
713 ele.one('change', function () {
714 msg && msg.close && msg.close();
715 ele.removeClass('error');
716 label.removeClass('crm-error');
717 });
718 }, 1000);
6a488035
TO
719 }
720 return msg;
e24b17b9 721 };
6a488035
TO
722
723 // Display system alerts through js notifications
724 function messagesFromMarkup() {
0f5816a6 725 $('div.messages:visible', this).not('.help').not('.no-popup').each(function () {
e24b17b9 726 var text, title = '';
6a488035
TO
727 $(this).removeClass('status messages');
728 var type = $(this).attr('class').split(' ')[0] || 'alert';
729 type = type.replace('crm-', '');
730 $('.icon', this).remove();
6a488035 731 if ($('.msg-text', this).length > 0) {
e24b17b9 732 text = $('.msg-text', this).html();
6a488035
TO
733 title = $('.msg-title', this).html();
734 }
735 else {
e24b17b9 736 text = $(this).html();
6a488035
TO
737 }
738 var options = $(this).data('options') || {};
739 $(this).remove();
740 // Duplicates were already removed server-side
741 options.unique = false;
742 CRM.alert(text, title, type, options);
743 });
744 // Handle qf form errors
745 $('form :input.error', this).one('blur', function() {
ef04c554 746 // ignore autocomplete fields
23246a80 747 if ($(this).is('.ac_input')) {
748 return;
749 }
ef04c554 750
6a488035
TO
751 $('.ui-notify-message.error a.ui-notify-close').click();
752 $(this).removeClass('error');
753 $(this).next('span.crm-error').remove();
754 $('label[for="' + $(this).attr('name') + '"], label[for="' + $(this).attr('id') + '"]')
755 .removeClass('crm-error')
756 .find('.crm-error').removeClass('crm-error');
757 });
758 }
759
23223213 760 $.widget('civi.crmSnippet', {
205bb8ae 761 options: {
a73f25bb 762 url: null,
205bb8ae
CW
763 block: true,
764 crmForm: null
765 },
c02f8fc4 766 _originalContent: null,
fa3a5fe2
CW
767 _originalUrl: null,
768 isOriginalUrl: function() {
0906345e
CW
769 var
770 args = {},
771 same = true,
772 newUrl = this._formatUrl(this.options.url),
773 oldUrl = this._formatUrl(this._originalUrl);
fa3a5fe2 774 // Compare path
0906345e 775 if (newUrl.split('?')[0] !== oldUrl.split('?')[0]) {
fa3a5fe2
CW
776 return false;
777 }
778 // Compare arguments
0906345e 779 $.each(newUrl.split('?')[1].split('&'), function(k, v) {
fa3a5fe2
CW
780 var arg = v.split('=');
781 args[arg[0]] = arg[1];
782 });
0906345e 783 $.each(oldUrl.split('?')[1].split('&'), function(k, v) {
fa3a5fe2
CW
784 var arg = v.split('=');
785 if (args[arg[0]] !== undefined && arg[1] !== args[arg[0]]) {
786 same = false;
787 }
788 });
789 return same;
790 },
791 resetUrl: function() {
792 this.options.url = this._originalUrl;
793 },
205bb8ae 794 _create: function() {
205bb8ae
CW
795 this.element.addClass('crm-ajax-container');
796 if (!this.element.is('.crm-container *')) {
797 this.element.addClass('crm-container');
798 }
4a140040 799 this._handleOrderLinks();
5d92a7e7
CW
800 // Set default if not supplied
801 this.options.url = this.options.url || document.location.href;
fa3a5fe2 802 this._originalUrl = this.options.url;
205bb8ae
CW
803 },
804 _onFailure: function(data) {
805 this.options.block && this.element.unblock();
806 this.element.trigger('crmAjaxFail', data);
807 CRM.alert(ts('Unable to reach the server. Please refresh this page in your browser and try again.'), ts('Network Error'), 'error');
808 },
809 _formatUrl: function(url) {
0906345e
CW
810 // Strip hash
811 url = url.split('#')[0];
205bb8ae
CW
812 // Add snippet argument to url
813 if (url.search(/[&?]snippet=/) < 0) {
fc05b8da 814 url += (url.indexOf('?') < 0 ? '?' : '&') + 'snippet=json';
8547369d
CW
815 } else {
816 url = url.replace(/snippet=[^&]*/, 'snippet=json');
205bb8ae
CW
817 }
818 return url;
819 },
d6539f93 820 // Hack to deal with civicrm legacy sort functionality
4a140040
CW
821 _handleOrderLinks: function() {
822 var that = this;
823 $('a.crm-weight-arrow', that.element).click(function(e) {
824 that.options.block && that.element.block();
825 $.getJSON(that._formatUrl(this.href)).done(function() {
826 that.refresh();
827 });
828 e.stopImmediatePropagation();
829 return false;
830 });
831 },
205bb8ae
CW
832 refresh: function() {
833 var that = this;
834 var url = this._formatUrl(this.options.url);
4a140040 835 this.options.block && $('.blockOverlay', this.element).length < 1 && this.element.block();
205bb8ae
CW
836 $.getJSON(url, function(data) {
837 if (typeof(data) != 'object' || typeof(data.content) != 'string') {
838 that._onFailure(data);
839 return;
840 }
841 data.url = url;
c02f8fc4
CW
842 that.element.trigger('crmBeforeLoad', data);
843 if (that._originalContent === null) {
844 that._originalContent = that.element.contents().detach();
845 }
846 that.element.html(data.content);
4a140040
CW
847 that._handleOrderLinks();
848 that.element.trigger('crmLoad', data);
205bb8ae
CW
849 that.options.crmForm && that.element.trigger('crmFormLoad', data);
850 }).fail(function() {
851 that._onFailure();
852 });
4b628e67
CW
853 },
854 _destroy: function() {
855 this.element.removeClass('crm-ajax-container');
c02f8fc4
CW
856 if (this._originalContent !== null) {
857 this.element.empty().append(this._originalContent);
858 }
205bb8ae
CW
859 }
860 });
861
0e017a41 862 var dialogCount = 0;
d4e4e9df 863 CRM.loadPage = function(url, options) {
d4e4e9df 864 var settings = {
0e017a41 865 target: '#crm-ajax-dialog-' + (dialogCount++),
8547369d
CW
866 dialog: false
867 };
868 if (!options || !options.target) {
869 settings.dialog = {
d4e4e9df 870 modal: true,
f84151fd 871 width: '65%',
eb90857a 872 height: parseInt($(window).height() * .75)
8547369d
CW
873 };
874 }
205bb8ae 875 options && $.extend(true, settings, options);
0e017a41 876 settings.url = url;
83df6b4a 877 // Create new dialog
8547369d 878 if (settings.dialog) {
205bb8ae 879 $('<div id="'+ settings.target.substring(1) +'"><div class="crm-loading-element">' + ts('Loading') + '...</div></div>').dialog(settings.dialog);
eb90857a
CW
880 $(settings.target).on('dialogclose', function() {
881 $(this).dialog('destroy').remove();
882 });
d4e4e9df 883 }
205bb8ae 884 if (settings.dialog && !settings.dialog.title) {
cbc9c3b2
CW
885 $(settings.target).on('crmLoad', function(e, data) {
886 if (e.target === $(settings.target)[0] && data && data.title) {
887 $(this).dialog('option', 'title', data.title);
888 }
205bb8ae
CW
889 });
890 }
5d92a7e7
CW
891 $(settings.target).crmSnippet(settings).crmSnippet('refresh');
892 return $(settings.target);
d4e4e9df
CW
893 };
894
895 CRM.loadForm = function(url, options) {
d4e4e9df 896 var settings = {
205bb8ae
CW
897 crmForm: {
898 ajaxForm: {},
205bb8ae
CW
899 autoClose: true,
900 validate: true,
901 refreshAction: ['next_new', 'submit_savenext'],
902 cancelButton: '.cancel.form-submit',
23223213 903 openInline: 'a.button:not("[href=#], .no-popup")',
205bb8ae
CW
904 onCancel: function(event) {},
905 onError: function(data) {
906 var $el = $(this);
5d92a7e7 907 $el.html(data.content).trigger('crmLoad', data).trigger('crmFormLoad', data).trigger('crmFormError', data);
205bb8ae
CW
908 if (typeof(data.errors) == 'object') {
909 $.each(data.errors, function(formElement, msg) {
910 $('[name="'+formElement+'"]', $el).crmError(msg);
911 });
912 }
d4e4e9df 913 }
d4e4e9df
CW
914 }
915 };
a10432db
CW
916 // Hack to make delete dialogs smaller
917 if (url.indexOf('/delete') > 0 || url.indexOf('action=delete') > 0) {
918 settings.dialog = {
919 width: 400,
920 height: 300
921 };
922 }
205bb8ae
CW
923 // Move options that belong to crmForm. Others will be passed through to crmSnippet
924 options && $.each(options, function(key, value) {
925 if (typeof(settings.crmForm[key]) !== 'undefined') {
926 settings.crmForm[key] = value;
927 }
928 else {
929 settings[key] = value;
930 }
931 });
205bb8ae
CW
932
933 var widget = CRM.loadPage(url, settings);
934
935 widget.on('crmFormLoad', function(event, data) {
936 var $el = $(this);
660c46f3 937 var settings = $el.crmSnippet('option', 'crmForm');
205bb8ae
CW
938 settings.cancelButton && $(settings.cancelButton, this).click(function(event) {
939 var returnVal = settings.onCancel.call($el, event);
940 if (returnVal !== false) {
941 $el.trigger('crmFormCancel', event);
660c46f3 942 if ($el.data('uiDialog') && settings.autoClose) {
fa3a5fe2
CW
943 $el.dialog('close');
944 }
945 else if (!settings.autoClose) {
946 $el.crmSnippet('resetUrl').crmSnippet('refresh');
947 }
0e017a41 948 }
205bb8ae
CW
949 return returnVal === false;
950 });
d4e4e9df 951 if (settings.validate) {
0e017a41 952 $("form", this).validate(typeof(settings.validate) == 'object' ? settings.validate : CRM.validate.params);
d4e4e9df 953 }
205bb8ae 954 $("form", this).ajaxForm($.extend({
fa3a5fe2 955 url: data.url.replace(/reset=1[&]?/, ''),
d4e4e9df
CW
956 dataType: 'json',
957 success: function(response) {
34866662 958 if (response.status !== 'form_error') {
36876f55 959 $el.crmSnippet('option', 'block') && $el.unblock();
205bb8ae 960 $el.trigger('crmFormSuccess', response);
0e017a41 961 // Reset form for e.g. "save and new"
d6539f93 962 if (response.userContext && settings.refreshAction && $.inArray(response.buttonName, settings.refreshAction) >= 0) {
205bb8ae 963 $el.crmSnippet('option', 'url', response.userContext).crmSnippet('refresh');
0e017a41 964 }
660c46f3 965 else if ($el.data('uiDialog') && settings.autoClose) {
205bb8ae 966 $el.dialog('close');
83df6b4a 967 }
d6539f93
CW
968 else if (settings.autoClose === false) {
969 $el.crmSnippet('resetUrl').crmSnippet('refresh');
970 }
d4e4e9df
CW
971 }
972 else {
25bbc4c0 973 response.url = data.url;
205bb8ae 974 settings.onError.call($el, response);
d4e4e9df 975 }
23223213
CW
976 },
977 beforeSerialize: function(form, options) {
978 if (window.CKEDITOR && window.CKEDITOR.instances) {
a10432db
CW
979 $.each(CKEDITOR.instances, function() {
980 this.updateElement && this.updateElement();
981 });
23223213 982 }
83df6b4a 983 },
205bb8ae 984 beforeSubmit: function(submission) {
36876f55 985 $el.crmSnippet('option', 'block') && $el.block();
205bb8ae 986 $el.trigger('crmFormSubmit', submission);
d4e4e9df 987 }
205bb8ae 988 }, settings.ajaxForm));
fa3a5fe2
CW
989 if (settings.openInline) {
990 settings.autoClose = $el.crmSnippet('isOriginalUrl');
991 $(settings.openInline, this).click(function(event) {
992 $el.crmSnippet('option', 'url', $(this).attr('href')).crmSnippet('refresh');
993 return false;
994 });
995 }
81c81624
CW
996 // For convenience, focus the first field
997 $('input[type=text], textarea, select', this).filter(':visible').first().focus();
205bb8ae
CW
998 });
999 return widget;
d4e4e9df
CW
1000 };
1001
03a7ec8f
CW
1002 // Preprocess all cj ajax calls to display messages
1003 $(document).ajaxSuccess(function(event, xhr, settings) {
1004 try {
1005 if ((!settings.dataType || settings.dataType == 'json') && xhr.responseText) {
1006 var response = $.parseJSON(xhr.responseText);
1007 if (typeof(response.crmMessages) == 'object') {
1008 $.each(response.crmMessages, function(n, msg) {
1009 CRM.alert(msg.text, msg.title, msg.type, msg.options);
1010 })
1011 }
1012 }
1013 }
1014 // Suppress errors
1015 catch (e) {}
1016 });
1017
7cb72342
CW
1018 /**
1019 * Temporary stub to get around name conflict with legacy jQuery.autocomplete plugin
1020 */
1021 $.widget('civi.crmAutocomplete', $.ui.autocomplete, {});
1022
0f5816a6 1023 $(function () {
205bb8ae 1024 // Trigger crmLoad on initial content for consistency. It will also be triggered for ajax-loaded content.
8547369d 1025 $('.crm-container').trigger('crmLoad');
205bb8ae 1026
ef3309b6 1027 if ($('#crm-notification-container').length) {
6a488035
TO
1028 // Initialize notifications
1029 $('#crm-notification-container').notify();
1030 messagesFromMarkup.call($('#crm-container'));
6a488035 1031 }
ebb9197b
C
1032
1033 // bind the event for image popup
475e9f44
CW
1034 $('body')
1035 .on('click', 'a.crm-image-popup', function() {
1036 var o = $('<div class="crm-container crm-custom-image-popup"><img src=' + $(this).attr('href') + '></div>');
1037
1038 CRM.confirm('',
1039 {
1040 title: ts('Preview'),
1041 message: o
1042 },
1043 ts('Done')
1044 );
1045 return false;
1046 })
ebb9197b 1047
475e9f44
CW
1048 .on('click', function (event) {
1049 $('.btn-slide-active').removeClass('btn-slide-active').find('.panel').hide();
1050 if ($(event.target).is('.btn-slide')) {
1051 $(event.target).addClass('btn-slide-active').find('.panel').show();
1052 }
1053 })
d664f648 1054
87831073 1055 .on('click', 'a.crm-option-edit-link', function() {
78b203e5
CW
1056 var
1057 link = $(this),
1058 optionsChanged = false;
87831073 1059 CRM.loadForm(this.href, {openInline: 'a:not("[href=#], .no-popup")'})
78b203e5
CW
1060 .on('crmFormSuccess', function() {
1061 optionsChanged = true;
1062 })
475e9f44 1063 .on('dialogclose', function() {
78b203e5
CW
1064 if (optionsChanged) {
1065 link.trigger('crmOptionsEdited');
1066 var $elects = $('select[data-option-edit-path="' + link.data('option-edit-path') + '"]');
1067 if ($elects.data('api-entity') && $elects.data('api-field')) {
1068 CRM.api3($elects.data('api-entity'), 'getoptions', {sequential: 1, field: $elects.data('api-field')})
1069 .done(function (data) {
1070 CRM.utils.setOptions($elects, data.values);
1071 });
1072 }
87831073 1073 }
475e9f44
CW
1074 });
1075 return false;
4a143c04
CW
1076 })
1077 // Handle clear button for form elements
1078 .on('click', 'a.crm-clear-link', function() {
1079 $(this).css({visibility: 'hidden'}).siblings('.crm-form-radio:checked').prop('checked', false).change();
bcb4280c 1080 $(this).siblings('input:text').val('').change();
4a143c04
CW
1081 return false;
1082 })
1083 .on('change', 'input.crm-form-radio:checked', function() {
1084 $(this).siblings('.crm-clear-link').css({visibility: ''});
475e9f44 1085 });
d664f648 1086 $().crmtooltip();
6a488035
TO
1087 });
1088
0f5816a6 1089 $.fn.crmAccordions = function (speed) {
cf021bc5
CW
1090 var container = $(this).length > 0 ? $(this) : $('.crm-container');
1091 speed = speed === undefined ? 200 : speed;
1092 container
1093 .off('click.crmAccordions')
6a488035 1094 // Allow normal clicking of links
cf021bc5 1095 .on('click.crmAccordions', 'div.crm-accordion-header a', function (e) {
6a488035 1096 e.stopPropagation && e.stopPropagation();
cf021bc5
CW
1097 })
1098 .on('click.crmAccordions', '.crm-accordion-header, .crm-collapsible .collapsible-title', function () {
6a488035
TO
1099 if ($(this).parent().hasClass('collapsed')) {
1100 $(this).next().css('display', 'none').slideDown(speed);
1101 }
1102 else {
1103 $(this).next().css('display', 'block').slideUp(speed);
1104 }
1105 $(this).parent().toggleClass('collapsed');
1106 return false;
1107 });
6a488035 1108 };
0f5816a6
KJ
1109 $.fn.crmAccordionToggle = function (speed) {
1110 $(this).each(function () {
6a488035
TO
1111 if ($(this).hasClass('collapsed')) {
1112 $('.crm-accordion-body', this).first().css('display', 'none').slideDown(speed);
1113 }
1114 else {
1115 $('.crm-accordion-body', this).first().css('display', 'block').slideUp(speed);
1116 }
1117 $(this).toggleClass('collapsed');
1118 });
1119 };
5ec182d9
CW
1120
1121 /**
1122 * Clientside currency formatting
1123 * @param value
3bdb644f 1124 * @param format - currency representation of the number 1234.56
5ec182d9 1125 * @return string
3bdb644f 1126 * @see CRM_Core_Resources::addCoreResources
5ec182d9
CW
1127 */
1128 var currencyTemplate;
1129 CRM.formatMoney = function(value, format) {
1130 var decimal, separator, sign, i, j, result;
1131 if (value === 'init' && format) {
1132 currencyTemplate = format;
1133 return;
1134 }
1135 format = format || currencyTemplate;
1136 result = /1(.?)234(.?)56/.exec(format);
1137 if (result === null) {
1138 return 'Invalid format passed to CRM.formatMoney';
1139 }
1140 separator = result[1];
1141 decimal = result[2];
1142 sign = (value < 0) ? '-' : '';
1143 //extracting the absolute value of the integer part of the number and converting to string
1144 i = parseInt(value = Math.abs(value).toFixed(2)) + '';
5ec182d9
CW
1145 j = ((j = i.length) > 3) ? j % 3 : 0;
1146 result = sign + (j ? i.substr(0, j) + separator : '') + i.substr(j).replace(/(\d{3})(?=\d)/g, "$1" + separator) + (2 ? decimal + Math.abs(value - i).toFixed(2).slice(2) : '');
1147 return format.replace(/1.*234.*56/, result);
1148 };
6a488035 1149})(jQuery);