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