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