Always cleanup stale contribution-related page caches
[civicrm-core.git] / js / Common.js
1 // https://civicrm.org/licensing
2 /* global CRM:true */
3 var CRM = CRM || {};
4 var cj = CRM.$ = jQuery;
5 CRM._ = _;
6
7 /**
8 * Short-named function for string translation, defined in global scope so it's available everywhere.
9 *
10 * @param text string for translating
11 * @param params object key:value of additional parameters
12 *
13 * @return string
14 */
15 function ts(text, params) {
16 "use strict";
17 var d = (params && params.domain) ? ('strings::' + params.domain) : null;
18 if (d && CRM[d] && CRM[d][text]) {
19 text = CRM[d][text];
20 }
21 else if (CRM.strings[text]) {
22 text = CRM.strings[text];
23 }
24 if (typeof(params) === 'object') {
25 for (var i in params) {
26 if (typeof(params[i]) === 'string' || typeof(params[i]) === 'number') {
27 // sprintf emulation: escape % characters in the replacements to avoid conflicts
28 text = text.replace(new RegExp('%' + i, 'g'), String(params[i]).replace(/%/g, '%-crmescaped-'));
29 }
30 }
31 return text.replace(/%-crmescaped-/g, '%');
32 }
33 return text;
34 }
35
36 // Legacy code - ignore warnings
37 /* jshint ignore:start */
38
39 /**
40 * This function is called by default at the bottom of template files which have forms that have
41 * conditionally displayed/hidden sections and elements. The PHP is responsible for generating
42 * a list of 'blocks to show' and 'blocks to hide' and the template passes these parameters to
43 * this function.
44 *
45 * @deprecated
46 * @param showBlocks Array of element Id's to be displayed
47 * @param hideBlocks Array of element Id's to be hidden
48 * @param elementType Value to set display style to for showBlocks (e.g. 'block' or 'table-row' or ...)
49 */
50 function on_load_init_blocks(showBlocks, hideBlocks, elementType) {
51 if (elementType == null) {
52 elementType = 'block';
53 }
54
55 var myElement, i;
56
57 /* This loop is used to display the blocks whose IDs are present within the showBlocks array */
58 for (i = 0; i < showBlocks.length; i++) {
59 myElement = document.getElementById(showBlocks[i]);
60 /* getElementById returns null if element id doesn't exist in the document */
61 if (myElement != null) {
62 myElement.style.display = elementType;
63 }
64 else {
65 alert('showBlocks array item not in .tpl = ' + showBlocks[i]);
66 }
67 }
68
69 /* This loop is used to hide the blocks whose IDs are present within the hideBlocks array */
70 for (i = 0; i < hideBlocks.length; i++) {
71 myElement = document.getElementById(hideBlocks[i]);
72 /* getElementById returns null if element id doesn't exist in the document */
73 if (myElement != null) {
74 myElement.style.display = 'none';
75 }
76 else {
77 alert('showBlocks array item not in .tpl = ' + hideBlocks[i]);
78 }
79 }
80 }
81
82 /**
83 * This function is called when we need to show or hide a related form element (target_element)
84 * based on the value (trigger_value) of another form field (trigger_field).
85 *
86 * @deprecated
87 * @param trigger_field_id HTML id of field whose onchange is the trigger
88 * @param trigger_value List of integers - option value(s) which trigger show-element action for target_field
89 * @param target_element_id HTML id of element to be shown or hidden
90 * @param target_element_type Type of element to be shown or hidden ('block' or 'table-row')
91 * @param field_type Type of element radio/select
92 * @param invert Boolean - if true, we HIDE target on value match; if false, we SHOW target on value match
93 */
94 function showHideByValue(trigger_field_id, trigger_value, target_element_id, target_element_type, field_type, invert) {
95 var target, j;
96
97 if (field_type == 'select') {
98 var trigger = trigger_value.split("|");
99 var selectedOptionValue = cj('#' + trigger_field_id).val();
100
101 target = target_element_id.split("|");
102 for (j = 0; j < target.length; j++) {
103 if (invert) {
104 cj('#' + target[j]).show();
105 }
106 else {
107 cj('#' + target[j]).hide();
108 }
109 for (var i = 0; i < trigger.length; i++) {
110 if (selectedOptionValue == trigger[i]) {
111 if (invert) {
112 cj('#' + target[j]).hide();
113 }
114 else {
115 cj('#' + target[j]).show();
116 }
117 }
118 }
119 }
120
121 }
122 else {
123 if (field_type == 'radio') {
124 target = target_element_id.split("|");
125 for (j = 0; j < target.length; j++) {
126 if (cj('[name="' + trigger_field_id + '"]:first').is(':checked')) {
127 if (invert) {
128 cj('#' + target[j]).hide();
129 }
130 else {
131 cj('#' + target[j]).show();
132 }
133 }
134 else {
135 if (invert) {
136 cj('#' + target[j]).show();
137 }
138 else {
139 cj('#' + target[j]).hide();
140 }
141 }
142 }
143 }
144 }
145 }
146
147 /**
148 * Function to change button text and disable one it is clicked
149 * @deprecated
150 * @param obj object - the button clicked
151 * @param formID string - the id of the form being submitted
152 * @param string procText - button text after user clicks it
153 * @return bool
154 */
155 var submitcount = 0;
156 /* Changes button label on submit, and disables button after submit for newer browsers.
157 Puts up alert for older browsers. */
158 function submitOnce(obj, formId, procText) {
159 // if named button clicked, change text
160 if (obj.value != null) {
161 cj('input[name=' + obj.name + ']').val(procText + " ...");
162 }
163 cj(obj).closest('form').attr('data-warn-changes', 'false');
164 if (document.getElementById) { // disable submit button for newer browsers
165 cj('input[name=' + obj.name + ']').attr("disabled", true);
166 document.getElementById(formId).submit();
167 return true;
168 }
169 else { // for older browsers
170 if (submitcount == 0) {
171 submitcount++;
172 return true;
173 }
174 else {
175 alert("Your request is currently being processed ... Please wait.");
176 return false;
177 }
178 }
179 }
180
181 /**
182 * Function to show / hide the row in optionFields
183 * @deprecated
184 * @param index string, element whose innerHTML is to hide else will show the hidden row.
185 */
186 function showHideRow(index) {
187 if (index) {
188 cj('tr#optionField_' + index).hide();
189 if (cj('table#optionField tr:hidden:first').length) {
190 cj('div#optionFieldLink').show();
191 }
192 }
193 else {
194 cj('table#optionField tr:hidden:first').show();
195 if (!cj('table#optionField tr:hidden:last').length) {
196 cj('div#optionFieldLink').hide();
197 }
198 }
199 return false;
200 }
201
202 /* jshint ignore:end */
203
204 if (!CRM.utils) CRM.utils = {};
205 if (!CRM.strings) CRM.strings = {};
206 if (!CRM.vars) CRM.vars = {};
207
208 (function ($, _, undefined) {
209 "use strict";
210 /* jshint validthis: true */
211
212 // Theme classes for unattached elements
213 $.fn.select2.defaults.dropdownCssClass = $.ui.dialog.prototype.options.dialogClass = 'crm-container';
214
215 // https://github.com/ivaynberg/select2/pull/2090
216 $.fn.select2.defaults.width = 'resolve';
217
218 // Workaround for https://github.com/ivaynberg/select2/issues/1246
219 $.ui.dialog.prototype._allowInteraction = function(e) {
220 return !!$(e.target).closest('.ui-dialog, .ui-datepicker, .select2-drop, .cke_dialog, #civicrm-menu').length;
221 };
222
223 // Implements jQuery hook.prop
224 $.propHooks.disabled = {
225 set: function (el, value, name) {
226 // Sync button enabled status with wrapper css
227 if ($(el).is('span.crm-button > input.crm-form-submit')) {
228 $(el).parent().toggleClass('crm-button-disabled', !!value);
229 }
230 // Sync button enabled status with dialog button
231 if ($(el).is('.ui-dialog input.crm-form-submit')) {
232 $(el).closest('.ui-dialog').find('.ui-dialog-buttonset button[data-identifier='+ $(el).attr('name') +']').prop('disabled', value);
233 }
234 if ($(el).is('.crm-form-date-wrapper .crm-hidden-date')) {
235 $(el).siblings().prop('disabled', value);
236 }
237 }
238 };
239
240 /**
241 * Populate a select list, overwriting the existing options except for the placeholder.
242 * @param select jquery selector - 1 or more select elements
243 * @param options array in format returned by api.getoptions
244 * @param placeholder string|bool - new placeholder or false (default) to keep the old one
245 * @param value string|array - will silently update the element with new value without triggering change
246 */
247 CRM.utils.setOptions = function(select, options, placeholder, value) {
248 $(select).each(function() {
249 var
250 $elect = $(this),
251 val = value || $elect.val() || [],
252 opts = placeholder || placeholder === '' ? '' : '[value!=""]';
253 $elect.find('option' + opts).remove();
254 var newOptions = CRM.utils.renderOptions(options, val);
255 if (typeof placeholder === 'string') {
256 if ($elect.is('[multiple]')) {
257 select.attr('placeholder', placeholder);
258 } else {
259 newOptions = '<option value="">' + placeholder + '</option>' + newOptions;
260 }
261 }
262 $elect.append(newOptions);
263 if (!value) {
264 $elect.trigger('crmOptionsUpdated', $.extend({}, options)).trigger('change');
265 }
266 });
267 };
268
269 /**
270 * Render an option list
271 * @param options {array}
272 * @param val {string} default value
273 * @param escapeHtml {bool}
274 * @return string
275 */
276 CRM.utils.renderOptions = function(options, val, escapeHtml) {
277 var rendered = '',
278 esc = escapeHtml === false ? _.identity : _.escape;
279 if (!$.isArray(val)) {
280 val = [val];
281 }
282 _.each(options, function(option) {
283 if (option.children) {
284 rendered += '<optgroup label="' + esc(option.value) + '">' +
285 CRM.utils.renderOptions(option.children, val) +
286 '</optgroup>';
287 } else {
288 var selected = ($.inArray('' + option.key, val) > -1) ? 'selected="selected"' : '';
289 rendered += '<option value="' + esc(option.key) + '"' + selected + '>' + esc(option.value) + '</option>';
290 }
291 });
292 return rendered;
293 };
294
295 function chainSelect() {
296 var $form = $(this).closest('form'),
297 $target = $('select[data-name="' + $(this).data('target') + '"]', $form),
298 data = $target.data(),
299 val = $(this).val();
300 $target.prop('disabled', true);
301 if ($target.is('select.crm-chain-select-control')) {
302 $('select[data-name="' + $target.data('target') + '"]', $form).prop('disabled', true).blur();
303 }
304 if (!(val && val.length)) {
305 CRM.utils.setOptions($target.blur(), [], data.emptyPrompt);
306 } else {
307 $target.addClass('loading');
308 $.getJSON(CRM.url(data.callback), {_value: val}, function(vals) {
309 $target.prop('disabled', false).removeClass('loading');
310 CRM.utils.setOptions($target, vals || [], (vals && vals.length ? data.selectPrompt : data.nonePrompt));
311 });
312 }
313 }
314
315 /**
316 * Compare Form Input values against cached initial value.
317 *
318 * @return {Boolean} true if changes have been made.
319 */
320 CRM.utils.initialValueChanged = function(el) {
321 var isDirty = false;
322 $(':input:visible, .select2-container:visible+:input:hidden', el).not('[type=submit], [type=button], .crm-action-menu, :disabled').each(function () {
323 var
324 initialValue = $(this).data('crm-initial-value'),
325 currentValue = $(this).is(':checkbox, :radio') ? $(this).prop('checked') : $(this).val();
326 // skip change of value for submit buttons
327 if (initialValue !== undefined && !_.isEqual(initialValue, currentValue)) {
328 isDirty = true;
329 }
330 });
331 return isDirty;
332 };
333
334 /**
335 * This provides defaults for ui.dialog which either need to be calculated or are different from global defaults
336 *
337 * @param settings
338 * @returns {*}
339 */
340 CRM.utils.adjustDialogDefaults = function(settings) {
341 settings = $.extend({width: '65%', height: '65%', modal: true}, settings || {});
342 // Support relative height
343 if (typeof settings.height === 'string' && settings.height.indexOf('%') > 0) {
344 settings.height = parseInt($(window).height() * (parseFloat(settings.height)/100), 10);
345 }
346 // Responsive adjustment - increase percent width on small screens
347 if (typeof settings.width === 'string' && settings.width.indexOf('%') > 0) {
348 var screenWidth = $(window).width(),
349 percentage = parseInt(settings.width.replace('%', ''), 10),
350 gap = 100-percentage;
351 if (screenWidth < 701) {
352 settings.width = '100%';
353 }
354 else if (screenWidth < 1400) {
355 settings.width = '' + parseInt(percentage+gap-((screenWidth - 700)/7*(gap)/100), 10) + '%';
356 }
357 }
358 return settings;
359 };
360
361 /**
362 * Wrapper for select2 initialization function; supplies defaults
363 * @param options object
364 */
365 $.fn.crmSelect2 = function(options) {
366 if (options === 'destroy') {
367 return $(this).each(function() {
368 $(this)
369 .removeClass('crm-ajax-select')
370 .select2('destroy');
371 });
372 }
373 return $(this).each(function () {
374 var
375 $el = $(this),
376 iconClass,
377 settings = {allowClear: !$el.hasClass('required')};
378 // quickform doesn't support optgroups so here's a hack :(
379 $('option[value^=crm_optgroup]', this).each(function () {
380 $(this).nextUntil('option[value^=crm_optgroup]').wrapAll('<optgroup label="' + $(this).text() + '" />');
381 $(this).remove();
382 });
383
384 // quickform does not support disabled option, so yet another hack to
385 // add disabled property for option values
386 $('option[value^=crm_disabled_opt]', this).attr('disabled', 'disabled');
387
388 // Placeholder icon - total hack hikacking the escapeMarkup function but select2 3.5 dosn't have any other callbacks for this :(
389 if ($el.is('[class*=fa-]')) {
390 settings.escapeMarkup = function (m) {
391 var out = _.escape(m),
392 placeholder = settings.placeholder || $el.data('placeholder') || $el.attr('placeholder') || $('option[value=""]', $el).text();
393 if (m.length && placeholder === m) {
394 iconClass = $el.attr('class').match(/(fa-\S*)/)[1];
395 out = '<i class="crm-i ' + iconClass + '"></i> ' + out;
396 }
397 return out;
398 };
399 }
400
401 // Defaults for single-selects
402 if ($el.is('select:not([multiple])')) {
403 settings.minimumResultsForSearch = 10;
404 if ($('option:first', this).val() === '') {
405 settings.placeholderOption = 'first';
406 }
407 }
408 $.extend(settings, $el.data('select-params') || {}, options || {});
409 if (settings.ajax) {
410 $el.addClass('crm-ajax-select');
411 }
412 $el.select2(settings);
413 });
414 };
415
416 /**
417 * @see CRM_Core_Form::addEntityRef for docs
418 * @param options object
419 */
420 $.fn.crmEntityRef = function(options) {
421 if (options === 'destroy') {
422 return $(this).each(function() {
423 var entity = $(this).data('api-entity') || '';
424 $(this)
425 .off('.crmEntity')
426 .removeClass('crm-form-entityref crm-' + entity.toLowerCase() + '-ref')
427 .crmSelect2('destroy');
428 });
429 }
430 options = options || {};
431 options.select = options.select || {};
432 return $(this).each(function() {
433 var
434 $el = $(this).off('.crmEntity'),
435 entity = options.entity || $el.data('api-entity') || 'contact',
436 selectParams = {};
437 $el.data('api-entity', entity);
438 $el.data('select-params', $.extend({}, $el.data('select-params') || {}, options.select));
439 $el.data('api-params', $.extend(true, {}, $el.data('api-params') || {}, options.api));
440 $el.data('create-links', options.create || $el.data('create-links'));
441 $el.addClass('crm-form-entityref crm-' + entity.toLowerCase() + '-ref');
442 var settings = {
443 // Use select2 ajax helper instead of CRM.api3 because it provides more value
444 ajax: {
445 url: CRM.url('civicrm/ajax/rest'),
446 data: function (input, page_num) {
447 var params = getEntityRefApiParams($el);
448 params.input = input;
449 params.page_num = page_num;
450 return {
451 entity: $el.data('api-entity'),
452 action: 'getlist',
453 json: JSON.stringify(params)
454 };
455 },
456 results: function(data) {
457 return {more: data.more_results, results: data.values || []};
458 }
459 },
460 minimumInputLength: 1,
461 formatResult: CRM.utils.formatSelect2Result,
462 formatSelection: function(row) {
463 return (row.prefix !== undefined ? row.prefix + ' ' : '') + row.label + (row.suffix !== undefined ? ' ' + row.suffix : '');
464 },
465 escapeMarkup: function (m) {return m;},
466 initSelection: function($el, callback) {
467 var
468 multiple = !!$el.data('select-params').multiple,
469 val = $el.val(),
470 stored = $el.data('entity-value') || [];
471 if (val === '') {
472 return;
473 }
474 // If we already have this data, just return it
475 if (!_.xor(val.split(','), _.pluck(stored, 'id')).length) {
476 callback(multiple ? stored : stored[0]);
477 } else {
478 var params = $.extend({}, $el.data('api-params') || {}, {id: val});
479 CRM.api3($el.data('api-entity'), 'getlist', params).done(function(result) {
480 callback(multiple ? result.values : result.values[0]);
481 // Trigger change (store data to avoid an infinite loop of lookups)
482 $el.data('entity-value', result.values).trigger('change');
483 });
484 }
485 }
486 };
487 // Create new items inline - works for tags
488 if ($el.data('create-links') && entity.toLowerCase() === 'tag') {
489 selectParams.createSearchChoice = function(term, data) {
490 if (!_.findKey(data, {label: term})) {
491 return {id: "0", term: term, label: term + ' (' + ts('new tag') + ')'};
492 }
493 };
494 selectParams.tokenSeparators = [','];
495 selectParams.createSearchChoicePosition = 'bottom';
496 $el.on('select2-selecting.crmEntity', function(e) {
497 if (e.val === "0") {
498 // Create a new term
499 e.object.label = e.object.term;
500 CRM.api3(entity, 'create', $.extend({name: e.object.term}, $el.data('api-params').params || {}))
501 .done(function(created) {
502 var
503 val = $el.select2('val'),
504 data = $el.select2('data'),
505 item = {id: created.id, label: e.object.term};
506 if (val === "0") {
507 $el.select2('data', item, true);
508 }
509 else if ($.isArray(val) && $.inArray("0", val) > -1) {
510 _.remove(data, {id: "0"});
511 data.push(item);
512 $el.select2('data', data, true);
513 }
514 });
515 }
516 });
517 }
518 else {
519 selectParams.formatInputTooShort = function() {
520 var txt = $el.data('select-params').formatInputTooShort || $.fn.select2.defaults.formatInputTooShort.call(this);
521 txt += entityRefFiltersMarkup($el) + renderEntityRefCreateLinks($el);
522 return txt;
523 };
524 selectParams.formatNoMatches = function() {
525 var txt = $el.data('select-params').formatNoMatches || $.fn.select2.defaults.formatNoMatches;
526 txt += entityRefFiltersMarkup($el) + renderEntityRefCreateLinks($el);
527 return txt;
528 };
529 $el.on('select2-open.crmEntity', function() {
530 var $el = $(this);
531 renderEntityRefFilterValue($el);
532 $('#select2-drop')
533 .off('.crmEntity')
534 .on('click.crmEntity', 'a.crm-add-entity', function(e) {
535 $el.select2('close');
536 CRM.loadForm($(this).attr('href'), {
537 dialog: {width: 500, height: 220}
538 }).on('crmFormSuccess', function(e, data) {
539 if (data.status === 'success' && data.id) {
540 CRM.status(ts('%1 Created', {1: data.label}));
541 if ($el.select2('container').hasClass('select2-container-multi')) {
542 var selection = $el.select2('data');
543 selection.push(data);
544 $el.select2('data', selection, true);
545 } else {
546 $el.select2('data', data, true);
547 }
548 }
549 });
550 return false;
551 })
552 .on('change.crmEntity', '.crm-entityref-filter-value', function() {
553 var filter = $el.data('user-filter') || {};
554 filter.value = $(this).val();
555 $(this).toggleClass('active', !!filter.value);
556 $el.data('user-filter', filter);
557 if (filter.value) {
558 // Once a filter has been chosen, rerender create links and refocus the search box
559 $el.select2('close');
560 $el.select2('open');
561 } else {
562 $('.crm-entityref-links', '#select2-drop').replaceWith(renderEntityRefCreateLinks($el));
563 }
564 })
565 .on('change.crmEntity', 'select.crm-entityref-filter-key', function() {
566 var filter = {key: $(this).val()};
567 $(this).toggleClass('active', !!filter.key);
568 $el.data('user-filter', filter);
569 renderEntityRefFilterValue($el);
570 $('.crm-entityref-filter-key', '#select2-drop').focus();
571 });
572 });
573 }
574 $el.crmSelect2($.extend(settings, $el.data('select-params'), selectParams));
575 });
576 };
577
578 /**
579 * Combine api-params with user-filter
580 * @param $el
581 * @returns {*}
582 */
583 function getEntityRefApiParams($el) {
584 var
585 params = $.extend({params: {}}, $el.data('api-params') || {}),
586 // Prevent original data from being modified - $.extend and _.clone don't cut it, they pass nested objects by reference!
587 combined = _.cloneDeep(params),
588 filter = $.extend({}, $el.data('user-filter') || {});
589 if (filter.key && filter.value) {
590 // Fieldname may be prefixed with joins
591 var fieldName = _.last(filter.key.split('.'));
592 // Special case for contact type/sub-type combo
593 if (fieldName === 'contact_type' && (filter.value.indexOf('__') > 0)) {
594 combined.params[filter.key] = filter.value.split('__')[0];
595 combined.params[filter.key.replace('contact_type', 'contact_sub_type')] = filter.value.split('__')[1];
596 } else {
597 // Allow json-encoded api filters e.g. {"BETWEEN":[123,456]}
598 combined.params[filter.key] = filter.value.charAt(0) === '{' ? $.parseJSON(filter.value) : filter.value;
599 }
600 }
601 return combined;
602 }
603
604 function copyAttributes($source, $target, attributes) {
605 _.each(attributes, function(name) {
606 if ($source.attr(name) !== undefined) {
607 $target.attr(name, $source.attr(name));
608 }
609 });
610 }
611
612 /**
613 * @see http://wiki.civicrm.org/confluence/display/CRMDOC/crmDatepicker
614 */
615 $.fn.crmDatepicker = function(options) {
616 return $(this).each(function() {
617 if ($(this).is('.crm-form-date-wrapper .crm-hidden-date')) {
618 // Already initialized - destroy
619 $(this)
620 .off('.crmDatepicker')
621 .css('display', '')
622 .removeClass('crm-hidden-date')
623 .siblings().remove();
624 $(this).unwrap();
625 }
626 if (options === 'destroy') {
627 return;
628 }
629 var
630 $dataField = $(this).wrap('<span class="crm-form-date-wrapper" />'),
631 settings = _.cloneDeep(options || {}),
632 $dateField = $(),
633 $timeField = $(),
634 $clearLink = $(),
635 hasDatepicker = settings.date !== false && settings.date !== 'yy',
636 type = hasDatepicker ? 'text' : 'number';
637
638 if (settings.allowClear !== undefined ? settings.allowClear : !$dataField.is('.required, [required]')) {
639 $clearLink = $('<a class="crm-hover-button crm-clear-link" title="'+ ts('Clear') +'"><i class="crm-i fa-times"></i></a>')
640 .insertAfter($dataField);
641 }
642 if (settings.time !== false) {
643 $timeField = $('<input>').insertAfter($dataField);
644 copyAttributes($dataField, $timeField, ['class', 'disabled']);
645 $timeField
646 .addClass('crm-form-text crm-form-time')
647 .attr('placeholder', $dataField.attr('time-placeholder') === undefined ? ts('Time') : $dataField.attr('time-placeholder'))
648 .change(updateDataField)
649 .timeEntry({
650 spinnerImage: '',
651 show24Hours: settings.time === true || settings.time === undefined ? CRM.config.timeIs24Hr : settings.time == '24'
652 });
653 }
654 if (settings.date !== false) {
655 // Render "number" field for year-only format, calendar popup for all other formats
656 $dateField = $('<input type="' + type + '">').insertAfter($dataField);
657 copyAttributes($dataField, $dateField, ['placeholder', 'style', 'class', 'disabled']);
658 $dateField.addClass('crm-form-' + type);
659 if (hasDatepicker) {
660 settings.minDate = settings.minDate ? CRM.utils.makeDate(settings.minDate) : null;
661 settings.maxDate = settings.maxDate ? CRM.utils.makeDate(settings.maxDate) : null;
662 settings.dateFormat = typeof settings.date === 'string' ? settings.date : CRM.config.dateInputFormat;
663 settings.changeMonth = _.includes(settings.dateFormat, 'm');
664 settings.changeYear = _.includes(settings.dateFormat, 'y');
665 if (!settings.yearRange && settings.minDate !== null && settings.maxDate !== null) {
666 settings.yearRange = '' + CRM.utils.formatDate(settings.minDate, 'yy') + ':' + CRM.utils.formatDate(settings.maxDate, 'yy');
667 }
668 $dateField.addClass('crm-form-date').datepicker(settings);
669 } else {
670 $dateField.attr('min', settings.minDate ? CRM.utils.formatDate(settings.minDate, 'yy') : '1000');
671 $dateField.attr('max', settings.maxDate ? CRM.utils.formatDate(settings.maxDate, 'yy') : '4000');
672 }
673 $dateField.change(updateDataField);
674 }
675 // Rudimentary validation. TODO: Roll into use of jQUery validate and ui.datepicker.validation
676 function isValidDate() {
677 // FIXME: parseDate doesn't work with incomplete date formats; skip validation if no month, day or year in format
678 var lowerFormat = settings.dateFormat.toLowerCase();
679 if (lowerFormat.indexOf('y') < 0 || lowerFormat.indexOf('m') < 0 || lowerFormat.indexOf('d') < 0) {
680 return true;
681 }
682 try {
683 $.datepicker.parseDate(settings.dateFormat, $dateField.val());
684 return true;
685 } catch (e) {
686 return false;
687 }
688 }
689 function updateInputFields(e, context) {
690 var val = $dataField.val(),
691 time = null;
692 if (context !== 'userInput' && context !== 'crmClear') {
693 if (hasDatepicker) {
694 $dateField.datepicker('setDate', _.includes(val, '-') ? $.datepicker.parseDate('yy-mm-dd', val) : null);
695 } else if ($dateField.length) {
696 $dateField.val(val.slice(0, 4));
697 }
698 if ($timeField.length) {
699 if (val.length === 8) {
700 time = val;
701 } else if (val.length === 19) {
702 time = val.split(' ')[1];
703 }
704 $timeField.timeEntry('setTime', time);
705 }
706 }
707 $clearLink.css('visibility', val ? 'visible' : 'hidden');
708 }
709 function updateDataField(e, context) {
710 // The crmClear event wipes all the field values anyway, so no need to respond
711 if (context !== 'crmClear') {
712 var val = '';
713 if ($dateField.val()) {
714 if (hasDatepicker && isValidDate()) {
715 val = $.datepicker.formatDate('yy-mm-dd', $dateField.datepicker('getDate'));
716 $dateField.removeClass('crm-error');
717 } else if (!hasDatepicker) {
718 val = $dateField.val() + '-01-01';
719 } else {
720 $dateField.addClass('crm-error');
721 }
722 }
723 if ($timeField.val()) {
724 val += (val ? ' ' : '') + $timeField.timeEntry('getTime').toTimeString().substr(0, 8);
725 }
726 $dataField.val(val).trigger('change', ['userInput']);
727 }
728 }
729 $dataField.hide().addClass('crm-hidden-date').on('change.crmDatepicker', updateInputFields);
730 updateInputFields();
731 });
732 };
733
734 $.fn.crmAjaxTable = function() {
735 // Strip the ids from ajax urls to make pageLength storage more generic
736 function simplifyUrl(ajax) {
737 // Datatables ajax prop could be a url string or an object containing the url
738 var url = typeof ajax === 'object' ? ajax.url : ajax;
739 return typeof url === 'string' ? url.replace(/[&?]\w*id=\d+/g, '') : null;
740 }
741
742 return $(this).each(function() {
743 // Recall pageLength for this table
744 var url = simplifyUrl($(this).data('ajax'));
745 if (url && window.localStorage && localStorage['dataTablePageLength:' + url]) {
746 $(this).data('pageLength', localStorage['dataTablePageLength:' + url]);
747 }
748 // Declare the defaults for DataTables
749 var defaults = {
750 "processing": true,
751 "serverSide": true,
752 "aaSorting": [],
753 "dom": '<"crm-datatable-pager-top"lfp>rt<"crm-datatable-pager-bottom"ip>',
754 "pageLength": 25,
755 "drawCallback": function(settings) {
756 //Add data attributes to cells
757 $('thead th', settings.nTable).each( function( index ) {
758 $.each(this.attributes, function() {
759 if(this.name.match("^cell-")) {
760 var cellAttr = this.name.substring(5);
761 var cellValue = this.value;
762 $('tbody tr', settings.nTable).each( function() {
763 $('td:eq('+ index +')', this).attr( cellAttr, cellValue );
764 });
765 }
766 });
767 });
768 //Reload table after draw
769 $(settings.nTable).trigger('crmLoad');
770 }
771 };
772 //Include any table specific data
773 var settings = $.extend(true, defaults, $(this).data('table'));
774 // Remember pageLength
775 $(this).on('length.dt', function(e, settings, len) {
776 if (settings.ajax && window.localStorage) {
777 localStorage['dataTablePageLength:' + simplifyUrl(settings.ajax)] = len;
778 }
779 });
780 //Make the DataTables call
781 $(this).DataTable(settings);
782 });
783 };
784
785 CRM.utils.formatSelect2Result = function (row) {
786 var markup = '<div class="crm-select2-row">';
787 if (row.image !== undefined) {
788 markup += '<div class="crm-select2-image"><img src="' + row.image + '"/></div>';
789 }
790 else if (row.icon_class) {
791 markup += '<div class="crm-select2-icon"><div class="crm-icon ' + row.icon_class + '-icon"></div></div>';
792 }
793 markup += '<div><div class="crm-select2-row-label '+(row.label_class || '')+'">' +
794 (row.prefix !== undefined ? row.prefix + ' ' : '') + row.label + (row.suffix !== undefined ? ' ' + row.suffix : '') +
795 '</div>' +
796 '<div class="crm-select2-row-description">';
797 $.each(row.description || [], function(k, text) {
798 markup += '<p>' + text + '</p>';
799 });
800 markup += '</div></div></div>';
801 return markup;
802 };
803
804 function renderEntityRefCreateLinks($el) {
805 var
806 createLinks = $el.data('create-links'),
807 params = getEntityRefApiParams($el).params,
808 markup = '<div class="crm-entityref-links">';
809 if (!createLinks || $el.data('api-entity').toLowerCase() !== 'contact') {
810 return '';
811 }
812 if (createLinks === true) {
813 createLinks = params.contact_type ? _.where(CRM.config.entityRef.contactCreate, {type: params.contact_type}) : CRM.config.entityRef.contactCreate;
814 }
815 _.each(createLinks, function(link) {
816 var icon;
817 switch (link.type) {
818 case 'Individual':
819 icon = 'fa-user';
820 break;
821
822 case 'Organization':
823 icon = 'fa-building';
824 break;
825
826 case 'Household':
827 icon = 'fa-home';
828 break;
829 }
830 markup += ' <a class="crm-add-entity crm-hover-button" href="' + link.url + '">';
831 if (icon) {
832 markup += '<i class="crm-i ' + icon + '"></i> ';
833 }
834 markup += link.label + '</a>';
835 });
836 markup += '</div>';
837 return markup;
838 }
839
840 function getEntityRefFilters($el) {
841 var
842 entity = $el.data('api-entity').toLowerCase(),
843 filters = $.extend([], CRM.config.entityRef.filters[entity] || []),
844 params = $.extend({params: {}}, $el.data('api-params') || {}).params,
845 result = [];
846 $.each(filters, function() {
847 var filter = $.extend({type: 'select', 'attributes': {}, entity: entity}, this);
848 if (typeof params[filter.key] === 'undefined') {
849 result.push(filter);
850 }
851 else if (filter.key == 'contact_type' && typeof params.contact_sub_type === 'undefined') {
852 filter.options = _.remove(filter.options, function(option) {
853 return option.key.indexOf(params.contact_type + '__') === 0;
854 });
855 result.push(filter);
856 }
857 });
858 return result;
859 }
860
861 /**
862 * Provide markup for entity ref filters
863 */
864 function entityRefFiltersMarkup($el) {
865 var
866 filters = getEntityRefFilters($el),
867 filter = $el.data('user-filter') || {},
868 filterSpec = filter.key ? _.find(filters, {key: filter.key}) : null;
869 if (!filters.length) {
870 return '';
871 }
872 var markup = '<div class="crm-entityref-filters">' +
873 '<select class="crm-entityref-filter-key' + (filter.key ? ' active' : '') + '">' +
874 '<option value="">' + ts('Refine search...') + '</option>' +
875 CRM.utils.renderOptions(filters, filter.key) +
876 '</select>' + entityRefFilterValueMarkup(filter, filterSpec) + '</div>';
877 return markup;
878 }
879
880 /**
881 * Provide markup for entity ref filter value field
882 */
883 function entityRefFilterValueMarkup(filter, filterSpec) {
884 var markup = '';
885 if (filterSpec) {
886 var attrs = '',
887 attributes = _.cloneDeep(filterSpec.attributes);
888 if (filterSpec.type !== 'select') {
889 attributes.type = filterSpec.type;
890 attributes.value = typeof filter.value !== 'undefined' ? filter.value : '';
891 }
892 attributes.class = 'crm-entityref-filter-value' + (filter.value ? ' active' : '');
893 $.each(attributes, function (attr, val) {
894 attrs += ' ' + attr + '="' + val + '"';
895 });
896 if (filterSpec.type === 'select') {
897 markup = '<select' + attrs + '><option value="">' + ts('- select -') + '</option>';
898 if (filterSpec.options) {
899 markup += CRM.utils.renderOptions(filterSpec.options, filter.value);
900 }
901 markup += '</select>';
902 } else {
903 markup = '<input' + attrs + '/>';
904 }
905 }
906 return markup;
907 }
908
909 /**
910 * Render the entity ref filter value field
911 */
912 function renderEntityRefFilterValue($el) {
913 var
914 filter = $el.data('user-filter') || {},
915 filterSpec = filter.key ? _.find(getEntityRefFilters($el), {key: filter.key}) : null,
916 $keyField = $('.crm-entityref-filter-key', '#select2-drop'),
917 $valField = null;
918 if (filterSpec) {
919 $('.crm-entityref-filter-value', '#select2-drop').remove();
920 $valField = $(entityRefFilterValueMarkup(filter, filterSpec));
921 $keyField.after($valField);
922 if (filterSpec.type === 'select' && !filterSpec.options) {
923 loadEntityRefFilterOptions(filter, filterSpec, $valField, $el);
924 }
925 } else {
926 $('.crm-entityref-filter-value', '#select2-drop').hide().val('').change();
927 }
928 }
929
930 /**
931 * Fetch options for a filter via ajax api
932 */
933 function loadEntityRefFilterOptions(filter, filterSpec, $valField, $el) {
934 $valField.prop('disabled', true);
935 // Fieldname may be prefixed with joins - strip those out
936 var fieldName = _.last(filter.key.split('.'));
937 CRM.api3(filterSpec.entity, 'getoptions', {field: fieldName, context: 'search', sequential: 1})
938 .done(function(result) {
939 var entity = $el.data('api-entity').toLowerCase(),
940 globalFilterSpec = _.find(CRM.config.entityRef.filters[entity], {key: filter.key}) || {};
941 // Store options globally so we don't have to look them up again
942 globalFilterSpec.options = result.values;
943 $valField.prop('disabled', false);
944 CRM.utils.setOptions($valField, result.values);
945 $valField.val(filter.value || '');
946 });
947 }
948
949 //CRM-15598 - Override url validator method to allow relative url's (e.g. /index.htm)
950 $.validator.addMethod("url", function(value, element) {
951 if (/^\//.test(value)) {
952 // Relative url: prepend dummy path for validation.
953 value = 'http://domain.tld' + value;
954 }
955 // From jQuery Validation Plugin v1.12.0
956 return this.optional(element) || /^(https?|s?ftp):\/\/(((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:)*@)?(((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]))|((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?)(:\d*)?)(\/((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)+(\/(([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)*)*)?)?(\?((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|[\uE000-\uF8FF]|\/|\?)*)?(#((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|\/|\?)*)?$/i.test(value);
957 });
958
959 /**
960 * Wrapper for jQuery validate initialization function; supplies defaults
961 */
962 $.fn.crmValidate = function(params) {
963 return $(this).each(function () {
964 var that = this,
965 settings = $.extend({}, CRM.validate._defaults, CRM.validate.params);
966 $(this).validate(settings);
967 // Call any post-initialization callbacks
968 if (CRM.validate.functions && CRM.validate.functions.length) {
969 $.each(CRM.validate.functions, function(i, func) {
970 func.call(that);
971 });
972 }
973 });
974 };
975
976 // Initialize widgets
977 $(document)
978 .on('crmLoad', function(e) {
979 $('table.row-highlight', e.target)
980 .off('.rowHighlight')
981 .on('change.rowHighlight', 'input.select-row, input.select-rows', function (e, data) {
982 var filter, $table = $(this).closest('table');
983 if ($(this).hasClass('select-rows')) {
984 filter = $(this).prop('checked') ? ':not(:checked)' : ':checked';
985 $('input.select-row' + filter, $table).prop('checked', $(this).prop('checked')).trigger('change', 'master-selected');
986 }
987 else {
988 $(this).closest('tr').toggleClass('crm-row-selected', $(this).prop('checked'));
989 if (data !== 'master-selected') {
990 $('input.select-rows', $table).prop('checked', $(".select-row:not(':checked')", $table).length < 1);
991 }
992 }
993 })
994 .find('input.select-row:checked').parents('tr').addClass('crm-row-selected');
995 $('table.crm-sortable', e.target).DataTable();
996 $('table.crm-ajax-table', e.target).each(function() {
997 var
998 $table = $(this),
999 $accordion = $table.closest('.crm-accordion-wrapper.collapsed, .crm-collapsible.collapsed');
1000 // For tables hidden by collapsed accordions, wait.
1001 if ($accordion.length) {
1002 $accordion.one('crmAccordion:open', function() {
1003 $table.crmAjaxTable();
1004 });
1005 } else {
1006 $table.crmAjaxTable();
1007 }
1008 });
1009 if ($("input:radio[name=radio_ts]").size() == 1) {
1010 $("input:radio[name=radio_ts]").prop("checked", true);
1011 }
1012 $('.crm-select2:not(.select2-offscreen, .select2-container)', e.target).crmSelect2();
1013 $('.crm-form-entityref:not(.select2-offscreen, .select2-container)', e.target).crmEntityRef();
1014 $('select.crm-chain-select-control', e.target).off('.chainSelect').on('change.chainSelect', chainSelect);
1015 $('.crm-form-text[data-crm-datepicker]', e.target).each(function() {
1016 $(this).crmDatepicker($(this).data('crmDatepicker'));
1017 });
1018 // Cache Form Input initial values
1019 $('form[data-warn-changes] :input', e.target).each(function() {
1020 $(this).data('crm-initial-value', $(this).is(':checkbox, :radio') ? $(this).prop('checked') : $(this).val());
1021 });
1022 $('textarea.crm-form-wysiwyg', e.target).each(function() {
1023 if ($(this).hasClass("collapsed")) {
1024 CRM.wysiwyg.createCollapsed(this);
1025 } else {
1026 CRM.wysiwyg.create(this);
1027 }
1028 });
1029 })
1030 .on('dialogopen', function(e) {
1031 var $el = $(e.target);
1032 // Modal dialogs should disable scrollbars
1033 if ($el.dialog('option', 'modal')) {
1034 $el.addClass('modal-dialog');
1035 $('body').css({overflow: 'hidden'});
1036 }
1037 $el.parent().find('.ui-dialog-titlebar .ui-icon-closethick').removeClass('ui-icon-closethick').addClass('fa-times');
1038 // Add resize button
1039 if ($el.parent().hasClass('crm-container') && $el.dialog('option', 'resizable')) {
1040 $el.parent().find('.ui-dialog-titlebar').append($('<button class="crm-dialog-titlebar-resize ui-dialog-titlebar-close" title="'+ts('Toggle fullscreen')+'" style="right:2em;"/>').button({icons: {primary: 'fa-expand'}, text: false}));
1041 $('.crm-dialog-titlebar-resize', $el.parent()).click(function(e) {
1042 if ($el.data('origSize')) {
1043 $el.dialog('option', $el.data('origSize'));
1044 $el.data('origSize', null);
1045 } else {
1046 var menuHeight = $('#civicrm-menu').outerHeight();
1047 $el.data('origSize', {
1048 position: {my: 'center', at: 'center center+' + (menuHeight / 2), of: window},
1049 width: $el.dialog('option', 'width'),
1050 height: $el.dialog('option', 'height')
1051 });
1052 $el.dialog('option', {width: '100%', height: ($(window).height() - menuHeight), position: {my: "top", at: "top+"+menuHeight, of: window}});
1053 }
1054 $el.trigger('dialogresize');
1055 e.preventDefault();
1056 });
1057 }
1058 })
1059 .on('dialogclose', function(e) {
1060 // Restore scrollbars when closing modal
1061 if ($('.ui-dialog .modal-dialog:visible').not(e.target).length < 1) {
1062 $('body').css({overflow: ''});
1063 }
1064 })
1065 .on('submit', function(e) {
1066 // CRM-14353 - disable changes warn when submitting a form
1067 $('[data-warn-changes]').attr('data-warn-changes', 'false');
1068 });
1069
1070 // CRM-14353 - Warn of unsaved changes for forms which have opted in
1071 window.onbeforeunload = function() {
1072 if (CRM.utils.initialValueChanged($('form[data-warn-changes=true]:visible'))) {
1073 return ts('You have unsaved changes.');
1074 }
1075 };
1076
1077 $.fn.crmtooltip = function () {
1078 $(document)
1079 .on('mouseover', 'a.crm-summary-link:not(.crm-processed)', function (e) {
1080 $(this).addClass('crm-processed crm-tooltip-active');
1081 var topDistance = e.pageY - $(window).scrollTop();
1082 if (topDistance < 300 || topDistance < $(this).children('.crm-tooltip-wrapper').height()) {
1083 $(this).addClass('crm-tooltip-down');
1084 }
1085 if (!$(this).children('.crm-tooltip-wrapper').length) {
1086 $(this).append('<div class="crm-tooltip-wrapper"><div class="crm-tooltip"></div></div>');
1087 $(this).children().children('.crm-tooltip')
1088 .html('<div class="crm-loading-element"></div>')
1089 .load(this.href);
1090 }
1091 })
1092 .on('mouseout', 'a.crm-summary-link', function () {
1093 $(this).removeClass('crm-processed crm-tooltip-active crm-tooltip-down');
1094 })
1095 .on('click', 'a.crm-summary-link', false);
1096 };
1097
1098 var helpDisplay, helpPrevious;
1099 // Non-ajax example:
1100 // CRM.help('Example title', 'Here is some text to describe this example');
1101 // Ajax example (will load help id "foo" from templates/CRM/bar.tpl):
1102 // CRM.help('Example title', {id: 'foo', file: 'CRM/bar'});
1103 CRM.help = function (title, params, url) {
1104 var ajax = typeof params !== 'string';
1105 if (helpDisplay && helpDisplay.close) {
1106 // If the same link is clicked twice, just close the display
1107 if (helpDisplay.isOpen && _.isEqual(helpPrevious, params)) {
1108 helpDisplay.close();
1109 return;
1110 }
1111 helpDisplay.close();
1112 }
1113 helpPrevious = _.cloneDeep(params);
1114 helpDisplay = CRM.alert(ajax ? '...' : params, title, 'crm-help ' + (ajax ? 'crm-msg-loading' : 'info'), {expires: 0});
1115 if (ajax) {
1116 if (!url) {
1117 url = CRM.url('civicrm/ajax/inline');
1118 params.class_name = 'CRM_Core_Page_Inline_Help';
1119 params.type = 'page';
1120 }
1121 $.ajax(url, {
1122 data: params,
1123 dataType: 'html',
1124 success: function (data) {
1125 $('#crm-notification-container .crm-help .notify-content:last').html(data);
1126 $('#crm-notification-container .crm-help').removeClass('crm-msg-loading').addClass('info');
1127 },
1128 error: function () {
1129 $('#crm-notification-container .crm-help .notify-content:last').html('Unable to load help file.');
1130 $('#crm-notification-container .crm-help').removeClass('crm-msg-loading').addClass('error');
1131 }
1132 });
1133 }
1134 };
1135 /**
1136 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1137 */
1138 CRM.status = function(options, deferred) {
1139 // For simple usage without async operations you can pass in a string. 2nd param is optional string 'error' if this is not a success msg.
1140 if (typeof options === 'string') {
1141 return CRM.status({start: options, success: options, error: options})[deferred === 'error' ? 'reject' : 'resolve']();
1142 }
1143 var opts = $.extend({
1144 start: ts('Saving...'),
1145 success: ts('Saved'),
1146 error: function(data) {
1147 var msg = $.isPlainObject(data) && data.error_message;
1148 CRM.alert(msg || ts('Sorry an error occurred and your information was not saved'), ts('Error'), 'error');
1149 }
1150 }, options || {});
1151 var $msg = $('<div class="crm-status-box-outer status-start"><div class="crm-status-box-inner"><div class="crm-status-box-msg">' + opts.start + '</div></div></div>')
1152 .appendTo('body');
1153 $msg.css('min-width', $msg.width());
1154 function handle(status, data) {
1155 var endMsg = typeof(opts[status]) === 'function' ? opts[status](data) : opts[status];
1156 if (endMsg) {
1157 $msg.removeClass('status-start').addClass('status-' + status).find('.crm-status-box-msg').html(endMsg);
1158 window.setTimeout(function() {
1159 $msg.fadeOut('slow', function() {
1160 $msg.remove();
1161 });
1162 }, 2000);
1163 } else {
1164 $msg.remove();
1165 }
1166 }
1167 return (deferred || new $.Deferred())
1168 .done(function(data) {
1169 // If the server returns an error msg call the error handler
1170 var status = $.isPlainObject(data) && (data.is_error || data.status === 'error') ? 'error' : 'success';
1171 handle(status, data);
1172 })
1173 .fail(function(data) {
1174 handle('error', data);
1175 });
1176 };
1177
1178 // Convert an Angular promise to a jQuery promise
1179 CRM.toJqPromise = function(aPromise) {
1180 var jqDeferred = $.Deferred();
1181 aPromise.then(
1182 function(data) { jqDeferred.resolve(data); },
1183 function(data) { jqDeferred.reject(data); }
1184 // should we also handle progress events?
1185 );
1186 return jqDeferred.promise();
1187 };
1188
1189 CRM.toAPromise = function($q, jqPromise) {
1190 var aDeferred = $q.defer();
1191 jqPromise.then(
1192 function(data) { aDeferred.resolve(data); },
1193 function(data) { aDeferred.reject(data); }
1194 // should we also handle progress events?
1195 );
1196 return aDeferred.promise;
1197 };
1198
1199 /**
1200 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1201 */
1202 CRM.alert = function (text, title, type, options) {
1203 type = type || 'alert';
1204 title = title || '';
1205 options = options || {};
1206 if ($('#crm-notification-container').length) {
1207 var params = {
1208 text: text,
1209 title: title,
1210 type: type
1211 };
1212 // By default, don't expire errors and messages containing links
1213 var extra = {
1214 expires: (type == 'error' || text.indexOf('<a ') > -1) ? 0 : (text ? 10000 : 5000),
1215 unique: true
1216 };
1217 options = $.extend(extra, options);
1218 options.expires = options.expires === false ? 0 : parseInt(options.expires, 10);
1219 if (options.unique && options.unique !== '0') {
1220 $('#crm-notification-container .ui-notify-message').each(function () {
1221 if (title === $('h1', this).html() && text === $('.notify-content', this).html()) {
1222 $('.icon.ui-notify-close', this).click();
1223 }
1224 });
1225 }
1226 return $('#crm-notification-container').notify('create', params, options);
1227 }
1228 else {
1229 if (title.length) {
1230 text = title + "\n" + text;
1231 }
1232 alert(text);
1233 return null;
1234 }
1235 };
1236
1237 /**
1238 * Close whichever alert contains the given node
1239 *
1240 * @param node
1241 */
1242 CRM.closeAlertByChild = function (node) {
1243 $(node).closest('.ui-notify-message').find('.icon.ui-notify-close').click();
1244 };
1245
1246 /**
1247 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1248 */
1249 CRM.confirm = function (options) {
1250 var dialog, url, msg, buttons = [], settings = {
1251 title: ts('Confirm'),
1252 message: ts('Are you sure you want to continue?'),
1253 url: null,
1254 width: 'auto',
1255 height: 'auto',
1256 resizable: false,
1257 dialogClass: 'crm-container crm-confirm',
1258 close: function () {
1259 $(this).dialog('destroy').remove();
1260 },
1261 options: {
1262 no: ts('Cancel'),
1263 yes: ts('Continue')
1264 }
1265 };
1266 if (options && options.url) {
1267 settings.resizable = true;
1268 settings.height = '50%';
1269 }
1270 $.extend(settings, ($.isFunction(options) ? arguments[1] : options) || {});
1271 settings = CRM.utils.adjustDialogDefaults(settings);
1272 if (!settings.buttons && $.isPlainObject(settings.options)) {
1273 $.each(settings.options, function(op, label) {
1274 buttons.push({
1275 text: label,
1276 'data-op': op,
1277 icons: {primary: op === 'no' ? 'fa-times' : 'fa-check'},
1278 click: function() {
1279 var event = $.Event('crmConfirm:' + op);
1280 $(this).trigger(event);
1281 if (!event.isDefaultPrevented()) {
1282 dialog.dialog('close');
1283 }
1284 }
1285 });
1286 });
1287 // Order buttons so that "no" goes on the right-hand side
1288 settings.buttons = _.sortBy(buttons, 'data-op').reverse();
1289 }
1290 url = settings.url;
1291 msg = url ? '' : settings.message;
1292 delete settings.options;
1293 delete settings.message;
1294 delete settings.url;
1295 dialog = $('<div class="crm-confirm-dialog"></div>').html(msg || '').dialog(settings);
1296 if ($.isFunction(options)) {
1297 dialog.on('crmConfirm:yes', options);
1298 }
1299 if (url) {
1300 CRM.loadPage(url, {target: dialog});
1301 }
1302 else {
1303 dialog.trigger('crmLoad');
1304 }
1305 return dialog;
1306 };
1307
1308 /** provides a local copy of ts for a domain */
1309 CRM.ts = function(domain) {
1310 return function(message, options) {
1311 if (domain) {
1312 options = $.extend(options || {}, {domain: domain});
1313 }
1314 return ts(message, options);
1315 };
1316 };
1317
1318 CRM.addStrings = function(domain, strings) {
1319 var bucket = (domain == 'civicrm' ? 'strings' : 'strings::' + domain);
1320 CRM[bucket] = CRM[bucket] || {};
1321 _.extend(CRM[bucket], strings);
1322 };
1323
1324 /**
1325 * @see https://wiki.civicrm.org/confluence/display/CRMDOC/Notification+Reference
1326 */
1327 $.fn.crmError = function (text, title, options) {
1328 title = title || '';
1329 text = text || '';
1330 options = options || {};
1331
1332 var extra = {
1333 expires: 0
1334 };
1335 if ($(this).length) {
1336 if (title === '') {
1337 var label = $('label[for="' + $(this).attr('name') + '"], label[for="' + $(this).attr('id') + '"]').not('[generated=true]');
1338 if (label.length) {
1339 label.addClass('crm-error');
1340 var $label = label.clone();
1341 if (text === '' && $('.crm-marker', $label).length > 0) {
1342 text = $('.crm-marker', $label).attr('title');
1343 }
1344 $('.crm-marker', $label).remove();
1345 title = $label.text();
1346 }
1347 }
1348 $(this).addClass('crm-error');
1349 }
1350 var msg = CRM.alert(text, title, 'error', $.extend(extra, options));
1351 if ($(this).length) {
1352 var ele = $(this);
1353 setTimeout(function () {
1354 ele.one('change', function () {
1355 if (msg && msg.close) msg.close();
1356 ele.removeClass('error');
1357 label.removeClass('crm-error');
1358 });
1359 }, 1000);
1360 }
1361 return msg;
1362 };
1363
1364 // Display system alerts through js notifications
1365 function messagesFromMarkup() {
1366 $('div.messages:visible', this).not('.help').not('.no-popup').each(function () {
1367 var text, title = '';
1368 $(this).removeClass('status messages');
1369 var type = $(this).attr('class').split(' ')[0] || 'alert';
1370 type = type.replace('crm-', '');
1371 $('.icon', this).remove();
1372 if ($('.msg-text', this).length > 0) {
1373 text = $('.msg-text', this).html();
1374 title = $('.msg-title', this).html();
1375 }
1376 else {
1377 text = $(this).html();
1378 }
1379 var options = $(this).data('options') || {};
1380 $(this).remove();
1381 // Duplicates were already removed server-side
1382 options.unique = false;
1383 CRM.alert(text, title, type, options);
1384 });
1385 // Handle qf form errors
1386 $('form :input.error', this).one('blur', function() {
1387 $('.ui-notify-message.error a.ui-notify-close').click();
1388 $(this).removeClass('error');
1389 $(this).next('span.crm-error').remove();
1390 $('label[for="' + $(this).attr('name') + '"], label[for="' + $(this).attr('id') + '"]')
1391 .removeClass('crm-error')
1392 .find('.crm-error').removeClass('crm-error');
1393 });
1394 }
1395
1396 /**
1397 * Improve blockUI when used with jQuery dialog
1398 */
1399 var originalBlock = $.fn.block,
1400 originalUnblock = $.fn.unblock;
1401
1402 $.fn.block = function(opts) {
1403 if ($(this).is('.ui-dialog-content')) {
1404 originalBlock.call($(this).parents('.ui-dialog'), opts);
1405 return $(this);
1406 }
1407 return originalBlock.call(this, opts);
1408 };
1409 $.fn.unblock = function(opts) {
1410 if ($(this).is('.ui-dialog-content')) {
1411 originalUnblock.call($(this).parents('.ui-dialog'), opts);
1412 return $(this);
1413 }
1414 return originalUnblock.call(this, opts);
1415 };
1416
1417 // Preprocess all CRM ajax calls to display messages
1418 $(document).ajaxSuccess(function(event, xhr, settings) {
1419 try {
1420 if ((!settings.dataType || settings.dataType == 'json') && xhr.responseText) {
1421 var response = $.parseJSON(xhr.responseText);
1422 if (typeof(response.crmMessages) == 'object') {
1423 $.each(response.crmMessages, function(n, msg) {
1424 CRM.alert(msg.text, msg.title, msg.type, msg.options);
1425 });
1426 }
1427 if (response.backtrace) {
1428 CRM.console('log', response.backtrace);
1429 }
1430 if (typeof response.deprecated === 'string') {
1431 CRM.console('warn', response.deprecated);
1432 }
1433 }
1434 }
1435 // Ignore errors thrown by parseJSON
1436 catch (e) {}
1437 });
1438
1439 $(function () {
1440 $.blockUI.defaults.message = null;
1441 $.blockUI.defaults.ignoreIfBlocked = true;
1442
1443 if ($('#crm-container').hasClass('crm-public')) {
1444 $.fn.select2.defaults.dropdownCssClass = $.ui.dialog.prototype.options.dialogClass = 'crm-container crm-public';
1445 }
1446
1447 // Trigger crmLoad on initial content for consistency. It will also be triggered for ajax-loaded content.
1448 $('.crm-container').trigger('crmLoad');
1449
1450 if ($('#crm-notification-container').length) {
1451 // Initialize notifications
1452 $('#crm-notification-container').notify();
1453 messagesFromMarkup.call($('#crm-container'));
1454 }
1455
1456 $('body')
1457 // bind the event for image popup
1458 .on('click', 'a.crm-image-popup', function(e) {
1459 CRM.confirm({
1460 title: ts('Preview'),
1461 resizable: true,
1462 // Prevent overlap with the menubar
1463 maxHeight: $(window).height() - 30,
1464 position: {my: 'center', at: 'center center+15', of: window},
1465 message: '<div class="crm-custom-image-popup"><img style="max-width: 100%" src="' + $(this).attr('href') + '"></div>',
1466 options: null
1467 });
1468 e.preventDefault();
1469 })
1470
1471 .on('click', function (event) {
1472 $('.btn-slide-active').removeClass('btn-slide-active').find('.panel').hide();
1473 if ($(event.target).is('.btn-slide')) {
1474 $(event.target).addClass('btn-slide-active').find('.panel').show();
1475 }
1476 })
1477
1478 // Handle clear button for form elements
1479 .on('click', 'a.crm-clear-link', function() {
1480 $(this).css({visibility: 'hidden'}).siblings('.crm-form-radio:checked').prop('checked', false).trigger('change', ['crmClear']);
1481 $(this).siblings('input:text').val('').trigger('change', ['crmClear']);
1482 return false;
1483 })
1484 .on('change', 'input.crm-form-radio:checked', function() {
1485 $(this).siblings('.crm-clear-link').css({visibility: ''});
1486 })
1487
1488 // Allow normal clicking of links within accordions
1489 .on('click.crmAccordions', 'div.crm-accordion-header a, .collapsible-title a', function (e) {
1490 e.stopPropagation();
1491 })
1492 // Handle accordions
1493 .on('click.crmAccordions', '.crm-accordion-header, .crm-collapsible .collapsible-title', function (e) {
1494 var action = 'open';
1495 if ($(this).parent().hasClass('collapsed')) {
1496 $(this).next().css('display', 'none').slideDown(200);
1497 }
1498 else {
1499 $(this).next().css('display', 'block').slideUp(200);
1500 action = 'close';
1501 }
1502 $(this).parent().toggleClass('collapsed').trigger('crmAccordion:' + action);
1503 e.preventDefault();
1504 });
1505
1506 $().crmtooltip();
1507 });
1508
1509 /**
1510 * Collapse or expand an accordion
1511 * @param speed
1512 */
1513 $.fn.crmAccordionToggle = function (speed) {
1514 $(this).each(function () {
1515 var action = 'open';
1516 if ($(this).hasClass('collapsed')) {
1517 $('.crm-accordion-body', this).first().css('display', 'none').slideDown(speed);
1518 }
1519 else {
1520 $('.crm-accordion-body', this).first().css('display', 'block').slideUp(speed);
1521 action = 'close';
1522 }
1523 $(this).toggleClass('collapsed').trigger('crmAccordion:' + action);
1524 });
1525 };
1526
1527 /**
1528 * Clientside currency formatting
1529 * @param number value
1530 * @param [optional] boolean onlyNumber - if true, we return formatted amount without currency sign
1531 * @param [optional] string format - currency representation of the number 1234.56
1532 * @return string
1533 */
1534 var currencyTemplate;
1535 CRM.formatMoney = function(value, onlyNumber, format) {
1536 var decimal, separator, sign, i, j, result;
1537 if (value === 'init' && format) {
1538 currencyTemplate = format;
1539 return;
1540 }
1541 format = format || currencyTemplate;
1542 result = /1(.?)234(.?)56/.exec(format);
1543 if (result === null) {
1544 return 'Invalid format passed to CRM.formatMoney';
1545 }
1546 separator = result[1];
1547 decimal = result[2];
1548 sign = (value < 0) ? '-' : '';
1549 //extracting the absolute value of the integer part of the number and converting to string
1550 i = parseInt(value = Math.abs(value).toFixed(2)) + '';
1551 j = ((j = i.length) > 3) ? j % 3 : 0;
1552 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) : '');
1553 if ( onlyNumber ) {
1554 return result;
1555 }
1556 return format.replace(/1.*234.*56/, result);
1557 };
1558
1559 CRM.console = function(method, title, msg) {
1560 if (window.console) {
1561 method = $.isFunction(console[method]) ? method : 'log';
1562 if (msg === undefined) {
1563 return console[method](title);
1564 } else {
1565 return console[method](title, msg);
1566 }
1567 }
1568 };
1569
1570 // Determine if a user has a given permission.
1571 // @see CRM_Core_Resources::addPermissions
1572 CRM.checkPerm = function(perm) {
1573 return CRM.permissions[perm];
1574 };
1575
1576 // Round while preserving sigfigs
1577 CRM.utils.sigfig = function(n, digits) {
1578 var len = ("" + n).length;
1579 var scale = Math.pow(10.0, len-digits);
1580 return Math.round(n / scale) * scale;
1581 };
1582
1583 // Create a js Date object from a unix timestamp or a yyyy-mm-dd string
1584 CRM.utils.makeDate = function(input) {
1585 switch (typeof input) {
1586 case 'object':
1587 // already a date object
1588 return input;
1589
1590 case 'string':
1591 // convert iso format
1592 return $.datepicker.parseDate('yy-mm-dd', input.substr(0, 10));
1593
1594 case 'number':
1595 // convert unix timestamp
1596 return new Date(input * 1000);
1597 }
1598 throw 'Invalid input passed to CRM.utils.makeDate';
1599 };
1600
1601 // Format a date for output to the user
1602 // Input may be a js Date object, a unix timestamp or a yyyy-mm-dd string
1603 CRM.utils.formatDate = function(input, outputFormat) {
1604 return input ? $.datepicker.formatDate(outputFormat || CRM.config.dateInputFormat, CRM.utils.makeDate(input)) : '';
1605 };
1606 })(jQuery, _);