[civicrm-core.git] / ang / crmMailing / Recipients.js

(function(angular, $, _) {
  // example: <select multiple crm-mailing-recipients crm-mailing="mymailing" crm-avail-groups="myGroups" crm-avail-mailings="myMailings"></select>
  // FIXME: participate in ngModel's validation cycle
  angular.module('crmMailing').directive('crmMailingRecipients', function(crmUiAlert) {
    return {
      restrict: 'AE',
      require: 'ngModel',
      scope: {
        ngRequired: '@'
      },
      link: function(scope, element, attrs, ngModel) {
        scope.recips = ngModel.$viewValue;
        scope.groups = scope.$parent.$eval(attrs.crmAvailGroups);
        scope.mailings = scope.$parent.$eval(attrs.crmAvailMailings);
        refreshMandatory();

        var ts = scope.ts = CRM.ts(null);

        /// Convert MySQL date ("yyyy-mm-dd hh:mm:ss") to JS date object
        scope.parseDate = function(date) {
          if (!angular.isString(date)) {
            return date;
          }
          var p = date.split(/[\- :]/);
          return new Date(parseInt(p[0]), parseInt(p[1]) - 1, parseInt(p[2]), parseInt(p[3]), parseInt(p[4]), parseInt(p[5]));
        };

        /// Remove {value} from {array}
        function arrayRemove(array, value) {
          var idx = array.indexOf(value);
          if (idx >= 0) {
            array.splice(idx, 1);
          }
        }

        // @param string id an encoded string like "4 civicrm_mailing include"
        // @return Object keys: entity_id, entity_type, mode
        function convertValueToObj(id) {
          var a = id.split(" ");
          return {entity_id: parseInt(a[0]), entity_type: a[1], mode: a[2]};
        }

        // @param Object mailing
        // @return array list of values like "4 civicrm_mailing include"
        function convertMailingToValues(recipients) {
          var r = [];
          angular.forEach(recipients.groups.include, function(v) {
            r.push(v + " civicrm_group include");
          });
          angular.forEach(recipients.groups.exclude, function(v) {
            r.push(v + " civicrm_group exclude");
          });
          angular.forEach(recipients.mailings.include, function(v) {
            r.push(v + " civicrm_mailing include");
          });
          angular.forEach(recipients.mailings.exclude, function(v) {
            r.push(v + " civicrm_mailing exclude");
          });
          return r;
        }

        function refreshMandatory() {
          if (ngModel.$viewValue && ngModel.$viewValue.groups) {
            scope.mandatoryGroups = _.filter(scope.$parent.$eval(attrs.crmMandatoryGroups), function(grp) {
              return _.contains(ngModel.$viewValue.groups.include, parseInt(grp.id));
            });
            scope.mandatoryIds = _.map(_.pluck(scope.$parent.$eval(attrs.crmMandatoryGroups), 'id'), function(n) {
              return parseInt(n);
            });
          }
          else {
            scope.mandatoryGroups = [];
            scope.mandatoryIds = [];
          }
        }

        function isMandatory(grpId) {
          return _.contains(scope.mandatoryIds, parseInt(grpId));
        }

        var refreshUI = ngModel.$render = function refresuhUI() {
          scope.recips = ngModel.$viewValue;
          if (ngModel.$viewValue) {
            $(element).select2('val', convertMailingToValues(ngModel.$viewValue));
            validate();
            refreshMandatory();
          }
        };

        // @return string HTML representing an option
        function formatItem(item) {
          if (!item.id) {
            // return `text` for optgroup
            return item.text;
          }
          var option = convertValueToObj(item.id);
          var icon = (option.entity_type === 'civicrm_mailing') ? 'fa-envelope' : 'fa-users';
          var spanClass = (option.mode == 'exclude') ? 'crmMailing-exclude' : 'crmMailing-include';
          if (option.entity_type != 'civicrm_mailing' && isMandatory(option.entity_id)) {
            spanClass = 'crmMailing-mandatory';
          }
          return '<i class="crm-i '+icon+'"></i> <span class="' + spanClass + '">' + item.text + '</span>';
        }

        function validate() {
          if (scope.$parent.$eval(attrs.ngRequired)) {
            var empty = (_.isEmpty(ngModel.$viewValue.groups.include) && _.isEmpty(ngModel.$viewValue.mailings.include));
            ngModel.$setValidity('empty', !empty);
          }
          else {
            ngModel.$setValidity('empty', true);
          }
        }

        var rcpAjaxState = {
         input: '',
         entity: 'civicrm_group',
         type: 'include',
         page_n: 0,
         page_i: 0,
        };

        $(element).select2({
          width: '36em',
          dropdownAutoWidth: true,
          placeholder: "Groups or Past Recipients",
          formatResult: formatItem,
          formatSelection: formatItem,
          escapeMarkup: function(m) {
            return m;
          },
          multiple: true,
          initSelection: function(el, cb) {
            var values = el.val().split(',');

            var gids = [];
            var mids = [];

            for (var i in values) {
              var dv = convertValueToObj(values[i]);
              if (dv.entity_type == 'civicrm_group') {
                gids.push(dv.entity_id);
              }
              else if (dv.entity_type == 'civicrm_mailing') {
                mids.push(dv.entity_id);
              }
            }
            // push non existant 0 group/mailing id in order when no recipents group or prior mailing is selected
            //  this will allow to resuse the below code to handle datamap
            if (gids.length === 0) {
              gids.push(0);
            }
            if (mids.length === 0) {
              mids.push(0);
            }

            CRM.api3('Group', 'getlist', { params: { id: { IN: gids }, options: { limit: 0 } }, extra: ["is_hidden"] } ).then(
              function(glist) {
                CRM.api3('Mailing', 'getlist', { params: { id: { IN: mids }, options: { limit: 0 } } }).then(
                  function(mlist) {
                    var datamap = [];

                    var groupNames = [];
                    var civiMails = [];

                    $(glist.values).each(function (idx, group) {
                      var key = group.id + ' civicrm_group include';
                      groupNames.push({id: parseInt(group.id), title: group.label, is_hidden: group.extra.is_hidden});

                      if (values.indexOf(key) >= 0) {
                        datamap.push({id: key, text: group.label});
                      }

                      key = group.id + ' civicrm_group exclude';
                      if (values.indexOf(key) >= 0) {
                        datamap.push({id: key, text: group.label});
                      }
                    });

                    $(mlist.values).each(function (idx, group) {
                      var key = group.id + ' civicrm_mailing include';
                      civiMails.push({id: parseInt(group.id), name: group.label});

                      if (values.indexOf(key) >= 0) {
                        datamap.push({id: key, text: group.label});
                      }

                      key = group.id + ' civicrm_mailing exclude';
                      if (values.indexOf(key) >= 0) {
                        datamap.push({id: key, text: group.label});
                      }
                    });

                    scope.$parent.crmMailingConst.groupNames = groupNames;
                    scope.$parent.crmMailingConst.civiMails = civiMails;

                    refreshMandatory();

                    cb(datamap);
                  });
              });
          },
          ajax: {
            url: CRM.url('civicrm/ajax/rest'),
            quietMillis: 300,
            data: function(input, page_num) {
              if (page_num <= 1) {
                rcpAjaxState = {
                  input: input,
                  entity: 'civicrm_group',
                  type: 'include',
                  page_n: 0,
                };
              }

              rcpAjaxState.page_i = page_num - rcpAjaxState.page_n;
              var filterParams = {};
              switch(rcpAjaxState.entity) {
              case 'civicrm_group':
                filterParams = { is_hidden: 0, is_active: 1, group_type: {"LIKE": "%2%"} };
                break;

              case 'civicrm_mailing':
                filterParams = { is_hidden: 0, is_active: 1 };
                break;
              }
              var params = {
                input: input,
                page_num: rcpAjaxState.page_i,
                params: filterParams,
              };
              return params;
            },
            transport: function(params) {
              switch(rcpAjaxState.entity) {
              case 'civicrm_group':
                CRM.api3('Group', 'getlist', params.data).then(params.success, params.error);
                break;

              case 'civicrm_mailing':
                params.data.params.options = { sort: "is_archived asc, scheduled_date desc" };
                CRM.api3('Mailing', 'getlist', params.data).then(params.success, params.error);
                break;
              }
            },
            results: function(data) {
              results = {
                children: $.map(data.values, function(obj) {
                  return {   id: obj.id + ' ' + rcpAjaxState.entity + ' ' + rcpAjaxState.type,
                             text: obj.label };
                })
              };

              if (rcpAjaxState.page_i == 1 && data.count) {
                results.text = ts((rcpAjaxState.type == 'include'? 'Include ' : 'Exclude ') +
                  (rcpAjaxState.entity == 'civicrm_group'? 'Group' : 'Mailing'));
              }

              more = data.more_results || !(rcpAjaxState.entity == 'civicrm_mailing' && rcpAjaxState.type == 'exclude');

              if (more && !data.more_results) {
                if (rcpAjaxState.type == 'include') {
                  rcpAjaxState.type = 'exclude';
                } else {
                 rcpAjaxState.type = 'include';
                 rcpAjaxState.entity = 'civicrm_mailing';
                }
                rcpAjaxState.page_n += rcpAjaxState.page_i;
              }

              return { more: more, results: [ results ] };
            },
          },
        });

        $(element).on('select2-selecting', function(e) {
          var option = convertValueToObj(e.val);
          var typeKey = option.entity_type == 'civicrm_mailing' ? 'mailings' : 'groups';
          if (option.mode == 'exclude') {
            ngModel.$viewValue[typeKey].exclude.push(option.entity_id);
            arrayRemove(ngModel.$viewValue[typeKey].include, option.entity_id);
          }
          else {
            ngModel.$viewValue[typeKey].include.push(option.entity_id);
            arrayRemove(ngModel.$viewValue[typeKey].exclude, option.entity_id);
          }
          scope.$apply();
          $(element).select2('close');
          validate();
          e.preventDefault();
        });

        $(element).on("select2-removing", function(e) {
          var option = convertValueToObj(e.val);
          var typeKey = option.entity_type == 'civicrm_mailing' ? 'mailings' : 'groups';
          if (typeKey == 'groups' && isMandatory(option.entity_id)) {
            crmUiAlert({
              text: ts('This mailing was generated based on search results. The search results cannot be removed.'),
              title: ts('Required')
            });
            e.preventDefault();
            return;
          }
          scope.$parent.$apply(function() {
            arrayRemove(ngModel.$viewValue[typeKey][option.mode], option.entity_id);
          });
          validate();
          e.preventDefault();
        });

        scope.$watchCollection("recips.groups.include", refreshUI);
        scope.$watchCollection("recips.groups.exclude", refreshUI);
        scope.$watchCollection("recips.mailings.include", refreshUI);
        scope.$watchCollection("recips.mailings.exclude", refreshUI);
        setTimeout(refreshUI, 50);

        scope.$watchCollection(attrs.crmAvailGroups, function() {
          scope.groups = scope.$parent.$eval(attrs.crmAvailGroups);
        });
        scope.$watchCollection(attrs.crmAvailMailings, function() {
          scope.mailings = scope.$parent.$eval(attrs.crmAvailMailings);
        });
        scope.$watchCollection(attrs.crmMandatoryGroups, function() {
          refreshMandatory();
        });
      }
    };
  });

})(angular, CRM.$, CRM._);
Commit	Line	Data
b396fc59 TO	1	(function(angular, $, _) {
	2	// example: <select multiple crm-mailing-recipients crm-mailing="mymailing" crm-avail-groups="myGroups" crm-avail-mailings="myMailings"></select>
	3	// FIXME: participate in ngModel's validation cycle
	4	angular.module('crmMailing').directive('crmMailingRecipients', function(crmUiAlert) {
	5	return {
	6	restrict: 'AE',
	7	require: 'ngModel',
	8	scope: {
b396fc59 TO	9	ngRequired: '@'
b396fc59 TO	10	},
b396fc59 TO	11	link: function(scope, element, attrs, ngModel) {
	12	scope.recips = ngModel.$viewValue;
	13	scope.groups = scope.$parent.$eval(attrs.crmAvailGroups);
	14	scope.mailings = scope.$parent.$eval(attrs.crmAvailMailings);
	15	refreshMandatory();
	16
	17	var ts = scope.ts = CRM.ts(null);
	18
	19	/// Convert MySQL date ("yyyy-mm-dd hh:mm:ss") to JS date object
	20	scope.parseDate = function(date) {
	21	if (!angular.isString(date)) {
	22	return date;
	23	}
	24	var p = date.split(/[\- :]/);
	25	return new Date(parseInt(p[0]), parseInt(p[1]) - 1, parseInt(p[2]), parseInt(p[3]), parseInt(p[4]), parseInt(p[5]));
	26	};
	27
	28	/// Remove {value} from {array}
	29	function arrayRemove(array, value) {
	30	var idx = array.indexOf(value);
	31	if (idx >= 0) {
	32	array.splice(idx, 1);
	33	}
	34	}
	35
	36	// @param string id an encoded string like "4 civicrm_mailing include"
	37	// @return Object keys: entity_id, entity_type, mode
	38	function convertValueToObj(id) {
	39	var a = id.split(" ");
	40	return {entity_id: parseInt(a[0]), entity_type: a[1], mode: a[2]};
	41	}
	42
	43	// @param Object mailing
	44	// @return array list of values like "4 civicrm_mailing include"
	45	function convertMailingToValues(recipients) {
	46	var r = [];
	47	angular.forEach(recipients.groups.include, function(v) {
	48	r.push(v + " civicrm_group include");
	49	});
	50	angular.forEach(recipients.groups.exclude, function(v) {
	51	r.push(v + " civicrm_group exclude");
	52	});
	53	angular.forEach(recipients.mailings.include, function(v) {
	54	r.push(v + " civicrm_mailing include");
	55	});
	56	angular.forEach(recipients.mailings.exclude, function(v) {
	57	r.push(v + " civicrm_mailing exclude");
	58	});
	59	return r;
	60	}
	61
	62	function refreshMandatory() {
	63	if (ngModel.$viewValue && ngModel.$viewValue.groups) {
	64	scope.mandatoryGroups = _.filter(scope.$parent.$eval(attrs.crmMandatoryGroups), function(grp) {
	65	return _.contains(ngModel.$viewValue.groups.include, parseInt(grp.id));
	66	});
	67	scope.mandatoryIds = _.map(_.pluck(scope.$parent.$eval(attrs.crmMandatoryGroups), 'id'), function(n) {
	68	return parseInt(n);
	69	});
	70	}
	71	else {
	72	scope.mandatoryGroups = [];
	73	scope.mandatoryIds = [];
	74	}
75	}
76
77	function isMandatory(grpId) {
78	return _.contains(scope.mandatoryIds, parseInt(grpId));
79	}
80
81	var refreshUI = ngModel.$render = function refresuhUI() {
82	scope.recips = ngModel.$viewValue;
83	if (ngModel.$viewValue) {
84	$(element).select2('val', convertMailingToValues(ngModel.$viewValue));
85	validate();
86	refreshMandatory();
87	}
88	};
89
90	// @return string HTML representing an option
91	function formatItem(item) {
92	if (!item.id) {
93	// return `text` for optgroup
94	return item.text;
95	}
96	var option = convertValueToObj(item.id);
a9e74675	97	var icon = (option.entity_type === 'civicrm_mailing') ? 'fa-envelope' : 'fa-users';
b396fc59 TO	98	var spanClass = (option.mode == 'exclude') ? 'crmMailing-exclude' : 'crmMailing-include';
	99	if (option.entity_type != 'civicrm_mailing' && isMandatory(option.entity_id)) {
	100	spanClass = 'crmMailing-mandatory';
	101	}
a9e74675	102	return '<i class="crm-i '+icon+'"></i> <span class="' + spanClass + '">' + item.text + '</span>';
b396fc59 TO	103	}
	104
	105	function validate() {
	106	if (scope.$parent.$eval(attrs.ngRequired)) {
	107	var empty = (_.isEmpty(ngModel.$viewValue.groups.include) && _.isEmpty(ngModel.$viewValue.mailings.include));
	108	ngModel.$setValidity('empty', !empty);
	109	}
	110	else {
	111	ngModel.$setValidity('empty', true);
	112	}
	113	}
	114
836bf6b7 SL	115	var rcpAjaxState = {
	116	input: '',
	117	entity: 'civicrm_group',
	118	type: 'include',
	119	page_n: 0,
	120	page_i: 0,
	121	};
	122
b396fc59	123	$(element).select2({
836bf6b7	124	width: '36em',
b396fc59 TO	125	dropdownAutoWidth: true,
	126	placeholder: "Groups or Past Recipients",
	127	formatResult: formatItem,
	128	formatSelection: formatItem,
	129	escapeMarkup: function(m) {
	130	return m;
836bf6b7 SL	131	},
	132	multiple: true,
	133	initSelection: function(el, cb) {
	134	var values = el.val().split(',');
	135
	136	var gids = [];
	137	var mids = [];
	138
	139	for (var i in values) {
	140	var dv = convertValueToObj(values[i]);
	141	if (dv.entity_type == 'civicrm_group') {
	142	gids.push(dv.entity_id);
	143	}
	144	else if (dv.entity_type == 'civicrm_mailing') {
	145	mids.push(dv.entity_id);
	146	}
	147	}
6f3a35e0	148	// push non existant 0 group/mailing id in order when no recipents group or prior mailing is selected
6f3a35e0	149	// this will allow to resuse the below code to handle datamap
6dd717a6	150	if (gids.length === 0) {
6f3a35e0	151	gids.push(0);
	152	}
	153	if (mids.length === 0) {
	154	mids.push(0);
6dd717a6	155	}
836bf6b7	156
a5ac4db2	157	CRM.api3('Group', 'getlist', { params: { id: { IN: gids }, options: { limit: 0 } }, extra: ["is_hidden"] } ).then(
836bf6b7	158	function(glist) {
a5ac4db2	159	CRM.api3('Mailing', 'getlist', { params: { id: { IN: mids }, options: { limit: 0 } } }).then(
836bf6b7 SL	160	function(mlist) {
	161	var datamap = [];
	162
	163	var groupNames = [];
	164	var civiMails = [];
	165
	166	$(glist.values).each(function (idx, group) {
	167	var key = group.id + ' civicrm_group include';
	168	groupNames.push({id: parseInt(group.id), title: group.label, is_hidden: group.extra.is_hidden});
	169
	170	if (values.indexOf(key) >= 0) {
	171	datamap.push({id: key, text: group.label});
	172	}
	173
	174	key = group.id + ' civicrm_group exclude';
	175	if (values.indexOf(key) >= 0) {
	176	datamap.push({id: key, text: group.label});
	177	}
	178	});
	179
	180	$(mlist.values).each(function (idx, group) {
	181	var key = group.id + ' civicrm_mailing include';
	182	civiMails.push({id: parseInt(group.id), name: group.label});
	183
	184	if (values.indexOf(key) >= 0) {
	185	datamap.push({id: key, text: group.label});
	186	}
	187
	188	key = group.id + ' civicrm_mailing exclude';
	189	if (values.indexOf(key) >= 0) {
	190	datamap.push({id: key, text: group.label});
	191	}
	192	});
	193
	194	scope.$parent.crmMailingConst.groupNames = groupNames;
	195	scope.$parent.crmMailingConst.civiMails = civiMails;
	196
	197	refreshMandatory();
	198
	199	cb(datamap);
	200	});
	201	});
	202	},
	203	ajax: {
	204	url: CRM.url('civicrm/ajax/rest'),
	205	quietMillis: 300,
	206	data: function(input, page_num) {
	207	if (page_num <= 1) {
	208	rcpAjaxState = {
	209	input: input,
	210	entity: 'civicrm_group',
	211	type: 'include',
	212	page_n: 0,
	213	};
	214	}
	215
	216	rcpAjaxState.page_i = page_num - rcpAjaxState.page_n;
b704ec05 SL	217	var filterParams = {};
	218	switch(rcpAjaxState.entity) {
	219	case 'civicrm_group':
	220	filterParams = { is_hidden: 0, is_active: 1, group_type: {"LIKE": "%2%"} };
	221	break;
836bf6b7	222
b704ec05 SL	223	case 'civicrm_mailing':
	224	filterParams = { is_hidden: 0, is_active: 1 };
	225	break;
	226	}
836bf6b7 SL	227	var params = {
	228	input: input,
	229	page_num: rcpAjaxState.page_i,
b704ec05	230	params: filterParams,
836bf6b7 SL	231	};
	232	return params;
	233	},
	234	transport: function(params) {
	235	switch(rcpAjaxState.entity) {
	236	case 'civicrm_group':
	237	CRM.api3('Group', 'getlist', params.data).then(params.success, params.error);
	238	break;
	239
	240	case 'civicrm_mailing':
	241	params.data.params.options = { sort: "is_archived asc, scheduled_date desc" };
	242	CRM.api3('Mailing', 'getlist', params.data).then(params.success, params.error);
	243	break;
	244	}
	245	},
	246	results: function(data) {
	247	results = {
	248	children: $.map(data.values, function(obj) {
	249	return { id: obj.id + ' ' + rcpAjaxState.entity + ' ' + rcpAjaxState.type,
	250	text: obj.label };
	251	})
	252	};
	253
	254	if (rcpAjaxState.page_i == 1 && data.count) {
	255	results.text = ts((rcpAjaxState.type == 'include'? 'Include ' : 'Exclude ') +
	256	(rcpAjaxState.entity == 'civicrm_group'? 'Group' : 'Mailing'));
	257	}
	258
	259	more = data.more_results \|\| !(rcpAjaxState.entity == 'civicrm_mailing' && rcpAjaxState.type == 'exclude');
	260
	261	if (more && !data.more_results) {
	262	if (rcpAjaxState.type == 'include') {
	263	rcpAjaxState.type = 'exclude';
	264	} else {
	265	rcpAjaxState.type = 'include';
	266	rcpAjaxState.entity = 'civicrm_mailing';
	267	}
	268	rcpAjaxState.page_n += rcpAjaxState.page_i;
	269	}
	270
	271	return { more: more, results: [ results ] };
	272	},
	273	},
b396fc59 TO	274	});
	275
	276	$(element).on('select2-selecting', function(e) {
	277	var option = convertValueToObj(e.val);
	278	var typeKey = option.entity_type == 'civicrm_mailing' ? 'mailings' : 'groups';
	279	if (option.mode == 'exclude') {
	280	ngModel.$viewValue[typeKey].exclude.push(option.entity_id);
	281	arrayRemove(ngModel.$viewValue[typeKey].include, option.entity_id);
	282	}
	283	else {
	284	ngModel.$viewValue[typeKey].include.push(option.entity_id);
	285	arrayRemove(ngModel.$viewValue[typeKey].exclude, option.entity_id);
	286	}
	287	scope.$apply();
	288	$(element).select2('close');
	289	validate();
	290	e.preventDefault();
	291	});
	292
	293	$(element).on("select2-removing", function(e) {
	294	var option = convertValueToObj(e.val);
	295	var typeKey = option.entity_type == 'civicrm_mailing' ? 'mailings' : 'groups';
	296	if (typeKey == 'groups' && isMandatory(option.entity_id)) {
	297	crmUiAlert({
	298	text: ts('This mailing was generated based on search results. The search results cannot be removed.'),
	299	title: ts('Required')
	300	});
	301	e.preventDefault();
	302	return;
	303	}
	304	scope.$parent.$apply(function() {
	305	arrayRemove(ngModel.$viewValue[typeKey][option.mode], option.entity_id);
	306	});
	307	validate();
	308	e.preventDefault();
	309	});
	310
	311	scope.$watchCollection("recips.groups.include", refreshUI);
	312	scope.$watchCollection("recips.groups.exclude", refreshUI);
	313	scope.$watchCollection("recips.mailings.include", refreshUI);
	314	scope.$watchCollection("recips.mailings.exclude", refreshUI);
	315	setTimeout(refreshUI, 50);
	316
	317	scope.$watchCollection(attrs.crmAvailGroups, function() {
	318	scope.groups = scope.$parent.$eval(attrs.crmAvailGroups);
	319	});
	320	scope.$watchCollection(attrs.crmAvailMailings, function() {
	321	scope.mailings = scope.$parent.$eval(attrs.crmAvailMailings);
	322	});
	323	scope.$watchCollection(attrs.crmMandatoryGroups, function() {
	324	refreshMandatory();
	325	});
	326	}
	327	};
	328	});
	329
	330	})(angular, CRM.$, CRM._);