1 (function(angular
, $, _
) {
3 var crmCaseType
= angular
.module('crmCaseType', CRM
.angRequires('crmCaseType'));
5 // Note: This template will be passed to cloneDeep(), so don't put any funny stuff in here!
6 var newCaseTypeTemplate
= {
13 {name
: 'Open Case', max_instances
: 1},
21 name
: 'standard_timeline',
22 label
: 'Standard Timeline',
23 timeline
: '1', // Angular won't bind checkbox correctly with numeric 1
25 {name
: 'Open Case', status
: 'Completed' }
30 { name
: 'Case Coordinator', creator
: '1', manager
: '1'}
35 crmCaseType
.config(['$routeProvider',
36 function($routeProvider
) {
37 $routeProvider
.when('/caseType', {
38 templateUrl
: '~/crmCaseType/list.html',
39 controller
: 'CaseTypeListCtrl',
41 caseTypes: function($route
, crmApi
) {
42 return crmApi('CaseType', 'get', {options
: {limit
: 0}});
46 $routeProvider
.when('/caseType/:id', {
47 templateUrl
: '~/crmCaseType/edit.html',
48 controller
: 'CaseTypeCtrl',
50 apiCalls: function($route
, crmApi
) {
52 reqs
.actStatuses
= ['OptionValue', 'get', {
53 option_group_id
: 'activity_status',
57 reqs
.caseStatuses
= ['OptionValue', 'get', {
58 option_group_id
: 'case_status',
62 reqs
.actTypes
= ['OptionValue', 'get', {
63 option_group_id
: 'activity_type',
70 reqs
.defaultAssigneeTypes
= ['OptionValue', 'get', {
71 option_group_id
: 'activity_default_assignee',
77 reqs
.relTypes
= ['RelationshipType', 'get', {
85 if ($route
.current
.params
.id
!== 'new') {
86 reqs
.caseType
= ['CaseType', 'getsingle', {
87 id
: $route
.current
.params
.id
97 // Add a new record by name.
98 // Ex: <crmAddName crm-options="['Alpha','Beta','Gamma']" crm-var="newItem" crm-on-add="callMyCreateFunction(newItem)" />
99 crmCaseType
.directive('crmAddName', function() {
102 template
: '<input class="add-activity crm-action-menu fa-plus" type="hidden" />',
103 link: function(scope
, element
, attrs
) {
105 var input
= $('input', element
);
107 scope
._resetSelection = function() {
108 $(input
).select2('close');
109 $(input
).select2('val', '');
110 scope
[attrs
.crmVar
] = '';
113 $(input
).crmSelect2({
115 return { results
: scope
[attrs
.crmOptions
] };
117 createSearchChoice: function(term
) {
118 return {id
: term
, text
: term
+ ' (' + ts('new') + ')'};
120 createSearchChoicePosition
: 'bottom',
121 placeholder
: attrs
.placeholder
123 $(input
).on('select2-selecting', function(e
) {
124 scope
[attrs
.crmVar
] = e
.val
;
125 scope
.$evalAsync(attrs
.crmOnAdd
);
126 scope
.$evalAsync('_resetSelection()');
133 crmCaseType
.directive('crmEditableTabTitle', function($timeout
) {
136 link: function(scope
, element
, attrs
) {
137 element
.addClass('crm-editable crm-editable-enabled');
138 var titleLabel
= $(element
).find('span');
139 var penIcon
= $('<i class="crm-i fa-pencil crm-editable-placeholder"></i>').prependTo(element
);
140 var saveButton
= $('<button type="button"><i class="crm-i fa-check"></i></button>').appendTo(element
);
141 var cancelButton
= $('<button type="cancel"><i class="crm-i fa-times"></i></button>').appendTo(element
);
142 $('button', element
).wrapAll('<div class="crm-editable-form" style="display:none" />');
143 var buttons
= $('.crm-editable-form', element
);
144 titleLabel
.on('click', startEditMode
);
145 penIcon
.on('click', startEditMode
);
147 function detectEscapeKeyPress (event
) {
148 var isEscape
= false;
150 if ("key" in event
) {
151 isEscape
= (event
.key
== "Escape" || event
.key
== "Esc");
153 isEscape
= (event
.keyCode
== 27);
159 function detectEnterKeyPress (event
) {
162 if ("key" in event
) {
163 isEnter
= (event
.key
== "Enter");
165 isEnter
= (event
.keyCode
== 13);
171 function startEditMode () {
172 if (titleLabel
.is(":focus")) {
179 saveButton
.click(function () {
184 cancelButton
.click(function () {
189 $(element
).addClass('crm-editable-editing');
192 .attr("contenteditable", "true")
194 .focusout(function (event
) {
195 $timeout(function () {
200 .keydown(function(event
) {
201 event
.stopImmediatePropagation();
203 if(detectEscapeKeyPress(event
)) {
206 } else if(detectEnterKeyPress(event
)) {
207 event
.preventDefault();
214 function stopEditMode () {
215 titleLabel
.removeAttr("contenteditable").off("focusout");
216 titleLabel
.off("keydown");
217 saveButton
.off("click");
218 cancelButton
.off("click");
219 $(element
).removeClass('crm-editable-editing');
225 function revertTextValue () {
226 titleLabel
.text(scope
.activitySet
.label
);
229 function updateTextValue () {
230 var updatedTitle
= titleLabel
.text();
232 scope
.$evalAsync(function () {
233 scope
.activitySet
.label
= updatedTitle
;
240 crmCaseType
.controller('CaseTypeCtrl', function($scope
, crmApi
, apiCalls
, crmUiHelp
) {
241 var defaultAssigneeDefaultValue
, ts
;
245 ts
= $scope
.ts
= CRM
.ts(null);
246 $scope
.hs
= crmUiHelp({file
: 'CRM/Case/CaseType'});
247 $scope
.locks
= { caseTypeName
: true, activitySetName
: true };
248 $scope
.workflows
= { timeline
: 'Timeline', sequence
: 'Sequence' };
249 defaultAssigneeDefaultValue
= _
.find(apiCalls
.defaultAssigneeTypes
.values
, { is_default
: '1' }) || {};
251 storeApiCallsResults();
253 initCaseTypeDefinition();
254 initSelectedStatuses();
257 /// Stores the api calls results in the $scope object
258 function storeApiCallsResults() {
259 $scope
.activityStatuses
= apiCalls
.actStatuses
.values
;
260 $scope
.caseStatuses
= _
.indexBy(apiCalls
.caseStatuses
.values
, 'name');
261 $scope
.activityTypes
= _
.indexBy(apiCalls
.actTypes
.values
, 'name');
262 $scope
.activityTypeOptions
= _
.map(apiCalls
.actTypes
.values
, formatActivityTypeOption
);
263 $scope
.defaultAssigneeTypes
= apiCalls
.defaultAssigneeTypes
.values
;
264 $scope
.relationshipTypeOptions
= getRelationshipTypeOptions(false);
265 $scope
.defaultRelationshipTypeOptions
= getRelationshipTypeOptions(true);
266 // stores the default assignee values indexed by their option name:
267 $scope
.defaultAssigneeTypeValues
= _
.chain($scope
.defaultAssigneeTypes
)
268 .indexBy('name').mapValues('value').value();
271 // Returns the relationship type options. If the relationship is
272 // bidirectional (Ex: Spouse of) it adds a single option otherwise it adds
273 // two options representing the relationship type directions (Ex: Employee
276 // The default relationship field needs values that are IDs with direction,
277 // while the role field needs values that are names (with implicit
280 // At any rate, the labels should follow the convention in the UI of
281 // describing case roles from the perspective of the client, while the
282 // values must follow the convention in the XML of describing case roles
283 // from the perspective of the non-client.
284 function getRelationshipTypeOptions($isDefault
) {
285 return _
.transform(apiCalls
.relTypes
.values
, function(result
, relType
) {
286 var isBidirectionalRelationship
= relType
.label_a_b
=== relType
.label_b_a
;
289 label
: relType
.label_b_a
,
290 value
: relType
.id
+ '_a_b'
293 if (!isBidirectionalRelationship
) {
295 label
: relType
.label_a_b
,
296 value
: relType
.id
+ '_b_a'
300 // TODO The ids below really should use names not labels see
301 // https://lab.civicrm.org/dev/core/issues/774
304 text
: relType
.label_b_a
,
305 id
: relType
.label_a_b
308 if (!isBidirectionalRelationship
) {
310 text
: relType
.label_a_b
,
311 id
: relType
.label_b_a
318 /// initializes the case type object
319 function initCaseType() {
320 var isNewCaseType
= !apiCalls
.caseType
;
323 $scope
.caseType
= _
.cloneDeep(newCaseTypeTemplate
);
325 $scope
.caseType
= apiCalls
.caseType
;
329 /// initializes the case type definition object
330 function initCaseTypeDefinition() {
331 $scope
.caseType
.definition
= $scope
.caseType
.definition
|| [];
332 $scope
.caseType
.definition
.activityTypes
= $scope
.caseType
.definition
.activityTypes
|| [];
333 $scope
.caseType
.definition
.activitySets
= $scope
.caseType
.definition
.activitySets
|| [];
334 $scope
.caseType
.definition
.caseRoles
= $scope
.caseType
.definition
.caseRoles
|| [];
335 $scope
.caseType
.definition
.statuses
= $scope
.caseType
.definition
.statuses
|| [];
336 $scope
.caseType
.definition
.timelineActivityTypes
= $scope
.caseType
.definition
.timelineActivityTypes
|| [];
337 $scope
.caseType
.definition
.restrictActivityAsgmtToCmsUser
= $scope
.caseType
.definition
.restrictActivityAsgmtToCmsUser
|| 0;
338 $scope
.caseType
.definition
.activityAsgmtGrps
= $scope
.caseType
.definition
.activityAsgmtGrps
|| [];
340 _
.each($scope
.caseType
.definition
.activitySets
, function (set) {
341 _
.each(set.activityTypes
, function (type
, name
) {
342 var isDefaultAssigneeTypeUndefined
= _
.isUndefined(type
.default_assignee_type
);
343 var typeDefinition
= $scope
.activityTypes
[type
.name
];
344 type
.label
= (typeDefinition
&& typeDefinition
.label
) || type
.name
;
346 if (isDefaultAssigneeTypeUndefined
) {
347 type
.default_assignee_type
= defaultAssigneeDefaultValue
.value
;
352 // go lookup and add client-perspective labels for $scope.caseType.definition.caseRoles
353 _
.each($scope
.caseType
.definition
.caseRoles
, function (set) {
354 _
.each($scope
.relationshipTypeOptions
, function (relTypes
) {
355 if (relTypes
.text
== set.name
) {
356 set.displaylabel
= relTypes
.id
;
362 /// initializes the selected statuses
363 function initSelectedStatuses() {
364 $scope
.selectedStatuses
= {};
366 _
.each(apiCalls
.caseStatuses
.values
, function (status
) {
367 $scope
.selectedStatuses
[status
.name
] = !$scope
.caseType
.definition
.statuses
.length
|| $scope
.caseType
.definition
.statuses
.indexOf(status
.name
) > -1;
371 $scope
.addActivitySet = function(workflow
) {
372 var activitySet
= {};
373 activitySet
[workflow
] = '1';
374 activitySet
.activityTypes
= [];
377 var names
= _
.pluck($scope
.caseType
.definition
.activitySets
, 'name');
378 while (_
.contains(names
, workflow
+ '_' + offset
)) offset
++;
379 activitySet
.name
= workflow
+ '_' + offset
;
380 activitySet
.label
= (offset
== 1 ) ? $scope
.workflows
[workflow
] : ($scope
.workflows
[workflow
] + ' #' + offset
);
382 $scope
.caseType
.definition
.activitySets
.push(activitySet
);
384 $('.crmCaseType-acttab').tabs('refresh').tabs({active
: -1});
388 function formatActivityTypeOption(type
) {
389 return {id
: type
.name
, text
: type
.label
, icon
: type
.icon
};
392 function addActivityToSet(activitySet
, activityTypeName
) {
393 activitySet
.activityTypes
= activitySet
.activityTypes
|| [];
395 name
: activityTypeName
,
396 label
: $scope
.activityTypes
[activityTypeName
].label
,
398 reference_activity
: 'Open Case',
399 reference_offset
: '1',
400 reference_select
: 'newest',
401 default_assignee_type
: $scope
.defaultAssigneeTypeValues
.NONE
403 activitySet
.activityTypes
.push(activity
);
404 if(typeof activitySet
.timeline
!== "undefined" && activitySet
.timeline
== "1") {
405 $scope
.caseType
.definition
.timelineActivityTypes
.push(activity
);
409 function resetTimelineActivityTypes() {
410 $scope
.caseType
.definition
.timelineActivityTypes
= [];
411 angular
.forEach($scope
.caseType
.definition
.activitySets
, function(activitySet
) {
412 angular
.forEach(activitySet
.activityTypes
, function(activityType
) {
413 $scope
.caseType
.definition
.timelineActivityTypes
.push(activityType
);
418 function createActivity(name
, callback
) {
419 CRM
.loadForm(CRM
.url('civicrm/admin/options/activity_type', {action
: 'add', reset
: 1, label
: name
, component_id
: 7}))
420 .on('crmFormSuccess', function(e
, data
) {
421 $scope
.activityTypes
[data
.optionValue
.name
] = data
.optionValue
;
422 $scope
.activityTypeOptions
.push(formatActivityTypeOption(data
.optionValue
));
423 callback(data
.optionValue
);
428 // Add a new activity entry to an activity-set
429 $scope
.addActivity = function(activitySet
, activityType
) {
430 if ($scope
.activityTypes
[activityType
]) {
431 addActivityToSet(activitySet
, activityType
);
433 createActivity(activityType
, function(newActivity
) {
434 addActivityToSet(activitySet
, newActivity
.name
);
439 /// Add a new top-level activity-type entry
440 $scope
.addActivityType = function(activityType
) {
441 var names
= _
.pluck($scope
.caseType
.definition
.activityTypes
, 'name');
442 if (!_
.contains(names
, activityType
)) {
443 // Add an activity type that exists
444 if ($scope
.activityTypes
[activityType
]) {
445 $scope
.caseType
.definition
.activityTypes
.push({name
: activityType
});
447 createActivity(activityType
, function(newActivity
) {
448 $scope
.caseType
.definition
.activityTypes
.push({name
: newActivity
.name
});
454 /// Clears the activity's default assignee values for relationship and contact
455 $scope
.clearActivityDefaultAssigneeValues = function(activity
) {
456 activity
.default_assignee_relationship
= null;
457 activity
.default_assignee_contact
= null;
460 // TODO roleName passed to addRole is a misnomer, its passed as the
461 // label HOWEVER it should be saved to xml as the name see
462 // https://lab.civicrm.org/dev/core/issues/774
465 $scope
.addRole = function(roles
, roleName
) {
466 var names
= _
.pluck($scope
.caseType
.definition
.caseRoles
, 'name');
467 if (!_
.contains(names
, roleName
)) {
468 var matchingRoles
= _
.filter($scope
.relationshipTypeOptions
, {id
: roleName
});
469 if (matchingRoles
.length
) {
470 var matchingRole
= matchingRoles
.shift();
471 roles
.push({name
: roleName
, displaylabel
: matchingRole
.text
});
473 CRM
.loadForm(CRM
.url('civicrm/admin/reltype', {action
: 'add', reset
: 1, label_a_b
: roleName
}))
474 .on('crmFormSuccess', function(e
, data
) {
475 var newType
= _
.values(data
.relationshipType
)[0];
476 roles
.push({name
: newType
.label_b_a
, displaylabel
: newType
.label_a_b
});
477 // Assume that the case role should be A-B but add both directions as options.
478 $scope
.relationshipTypeOptions
.push({id
: newType
.label_a_b
, text
: newType
.label_a_b
});
479 if (newType
.label_a_b
!= newType
.label_b_a
) {
480 $scope
.relationshipTypeOptions
.push({id
: newType
.label_b_a
, text
: newType
.label_b_a
});
488 $scope
.onManagerChange = function(managerRole
) {
489 angular
.forEach($scope
.caseType
.definition
.caseRoles
, function(caseRole
) {
490 if (caseRole
!= managerRole
) {
491 caseRole
.manager
= '0';
496 $scope
.removeItem = function(array
, item
) {
497 var idx
= _
.indexOf(array
, item
);
499 array
.splice(idx
, 1);
500 resetTimelineActivityTypes();
504 $scope
.isForkable = function() {
505 return !$scope
.caseType
.id
|| $scope
.caseType
.is_forkable
;
508 $scope
.newStatus = function() {
509 CRM
.loadForm(CRM
.url('civicrm/admin/options/case_status', {action
: 'add', reset
: 1}))
510 .on('crmFormSuccess', function(e
, data
) {
511 $scope
.caseStatuses
[data
.optionValue
.name
] = data
.optionValue
;
512 $scope
.selectedStatuses
[data
.optionValue
.name
] = true;
517 $scope
.isNewActivitySetAllowed = function(workflow
) {
522 return 0 === _
.where($scope
.caseType
.definition
.activitySets
, {sequence
: '1'}).length
;
524 CRM
.console('warn', 'Denied access to unrecognized workflow: (' + workflow
+ ')');
529 $scope
.isActivityRemovable = function(activitySet
, activity
) {
533 $scope
.isValidName = function(name
) {
534 return !name
|| name
.match(/^[a-zA-Z0-9_]+$/);
537 $scope
.getWorkflowName = function(activitySet
) {
538 var result
= 'Unknown';
539 _
.each($scope
.workflows
, function(value
, key
) {
540 if (activitySet
[key
]) result
= value
;
546 * Determine which HTML partial to use for a particular
548 * @return string URL of the HTML partial
550 $scope
.activityTableTemplate = function(activitySet
) {
551 if (activitySet
.timeline
) {
552 return '~/crmCaseType/timelineTable.html';
553 } else if (activitySet
.sequence
) {
554 return '~/crmCaseType/sequenceTable.html';
560 $scope
.dump = function() {
561 console
.log($scope
.caseType
);
564 $scope
.save = function() {
565 // Add selected statuses
566 var selectedStatuses
= [];
567 _
.each($scope
.selectedStatuses
, function(v
, k
) {
568 if (v
) selectedStatuses
.push(k
);
570 // Ignore if ALL or NONE selected
571 $scope
.caseType
.definition
.statuses
= selectedStatuses
.length
== _
.size($scope
.selectedStatuses
) ? [] : selectedStatuses
;
573 if ($scope
.caseType
.definition
.activityAsgmtGrps
) {
574 $scope
.caseType
.definition
.activityAsgmtGrps
= $scope
.caseType
.definition
.activityAsgmtGrps
.toString().split(",");
577 function dropDisplaylabel (v
) {
578 delete v
.displaylabel
;
581 // strip out labels from $scope.caseType.definition.caseRoles
582 _
.map($scope
.caseType
.definition
.caseRoles
, dropDisplaylabel
);
584 var result
= crmApi('CaseType', 'create', $scope
.caseType
, true);
585 result
.then(function(data
) {
586 if (data
.is_error
=== 0 || data
.is_error
== '0') {
587 $scope
.caseType
.id
= data
.id
;
588 window
.location
.href
= '#/caseType';
593 $scope
.$watchCollection('caseType.definition.activitySets', function() {
595 $('.crmCaseType-acttab').tabs('refresh');
599 var updateCaseTypeName = function () {
600 if (!$scope
.caseType
.id
&& $scope
.locks
.caseTypeName
) {
601 // Should we do some filtering? Lowercase? Strip whitespace?
602 var t
= $scope
.caseType
.title
? $scope
.caseType
.title
: '';
603 $scope
.caseType
.name
= t
.replace(/ /g, '_').replace(/[^a
-zA
-Z0
-9_
]/g
, '').toLowerCase();
606 $scope
.$watch('locks.caseTypeName', updateCaseTypeName
);
607 $scope
.$watch('caseType.title', updateCaseTypeName
);
609 if (!$scope
.isForkable()) {
610 CRM
.alert(ts('The CiviCase XML file for this case-type prohibits editing the definition.'));
615 crmCaseType
.controller('CaseTypeListCtrl', function($scope
, crmApi
, caseTypes
) {
616 var ts
= $scope
.ts
= CRM
.ts(null);
618 $scope
.caseTypes
= caseTypes
.values
;
619 $scope
.toggleCaseType = function (caseType
) {
620 caseType
.is_active
= (caseType
.is_active
== '1') ? '0' : '1';
621 crmApi('CaseType', 'create', caseType
, true)
622 .catch(function (data
) {
623 caseType
.is_active
= (caseType
.is_active
== '1') ? '0' : '1'; // revert
627 $scope
.deleteCaseType = function (caseType
) {
628 crmApi('CaseType', 'delete', {id
: caseType
.id
}, {
629 error: function (data
) {
630 CRM
.alert(data
.error_message
, ts('Error'), 'error');
633 .then(function (data
) {
634 delete caseTypes
.values
[caseType
.id
];
637 $scope
.revertCaseType = function (caseType
) {
638 caseType
.definition
= 'null';
639 caseType
.is_forked
= '0';
640 crmApi('CaseType', 'create', caseType
, true)
641 .catch(function (data
) {
642 caseType
.is_forked
= '1'; // restore
648 })(angular
, CRM
.$, CRM
._
);