ext/search/ang/crmSearchAdmin.module.js

   1 (function(angular, $, _) {
   2   "use strict";
   3
   4   // Shared between router and searchMeta service
   5   var searchEntity,
   6     joinIndex,
   7     undefined;
   8
   9   // Declare module and route/controller/services
  10   angular.module('crmSearchAdmin', CRM.angRequires('crmSearchAdmin'))
  11
  12     .config(function($routeProvider) {
  13       $routeProvider.when('/list', {
  14         controller: 'searchList',
  15         templateUrl: '~/crmSearchAdmin/searchList.html',
  16         resolve: {
  17           // Load data for lists
  18           savedSearches: function(crmApi4) {
  19             return crmApi4('SavedSearch', 'get', {
  20               select: [
  21                 'id',
  22                 'name',
  23                 'label',
  24                 'api_entity',
  25                 'api_params',
  26                 'GROUP_CONCAT(display.name ORDER BY display.id) AS display_name',
  27                 'GROUP_CONCAT(display.label ORDER BY display.id) AS display_label',
  28                 'GROUP_CONCAT(display.type:icon ORDER BY display.id) AS display_icon',
  29                 'GROUP_CONCAT(DISTINCT group.title) AS groups'
  30               ],
  31               join: [['SearchDisplay AS display'], ['Group AS group']],
  32               where: [['api_entity', 'IS NOT NULL']],
  33               groupBy: ['id']
  34             });
  35           }
  36         }
  37       });
  38       $routeProvider.when('/create/:entity', {
  39         controller: 'searchCreate',
  40         reloadOnSearch: false,
  41         template: '<crm-search-admin saved-search="$ctrl.savedSearch"></crm-search-admin>',
  42       });
  43       $routeProvider.when('/edit/:id', {
  44         controller: 'searchEdit',
  45         template: '<crm-search-admin saved-search="$ctrl.savedSearch"></crm-search-admin>',
  46         resolve: {
  47           // Load saved search
  48           savedSearch: function($route, crmApi4) {
  49             var params = $route.current.params;
  50             return crmApi4('SavedSearch', 'get', {
  51               where: [['id', '=', params.id]],
  52               chain: {
  53                 groups: ['Group', 'get', {select: ['id', 'title', 'description', 'visibility', 'group_type'], where: [['saved_search_id', '=', '$id']]}],
  54                 displays: ['SearchDisplay', 'get', {where: [['saved_search_id', '=', '$id']]}]
  55               }
  56             }, 0);
  57           }
  58         }
  59       });
  60     })
  61
  62     // Controller for creating a new search
  63     .controller('searchCreate', function($scope, $routeParams, $location) {
  64       searchEntity = $routeParams.entity;
  65       $scope.$ctrl = this;
  66       this.savedSearch = {
  67         api_entity: searchEntity,
  68       };
  69       // Changing entity will refresh the angular page
  70       $scope.$watch('$ctrl.savedSearch.api_entity', function(newEntity, oldEntity) {
  71         if (newEntity && oldEntity && newEntity !== oldEntity) {
  72           $location.url('/create/' + newEntity);
  73         }
  74       });
  75     })
  76
  77     // Controller for editing a SavedSearch
  78     .controller('searchEdit', function($scope, savedSearch) {
  79       searchEntity = savedSearch.api_entity;
  80       this.savedSearch = savedSearch;
  81       $scope.$ctrl = this;
  82     })
  83
  84     .factory('searchMeta', function() {
  85       function getEntity(entityName) {
  86         if (entityName) {
  87           return _.find(CRM.crmSearchAdmin.schema, {name: entityName});
  88         }
  89       }
  90       // Get join metadata matching a given expression like "Email AS Contact_Email_contact_id_01"
  91       function getJoin(fullNameOrAlias) {
  92         var alias = _.last(fullNameOrAlias.split(' AS ')),
  93           path = alias,
  94           baseEntity = searchEntity,
  95           label = [],
  96           join,
  97           result;
  98         while (path.length) {
  99           /* jshint -W083 */
 100           join = _.find(CRM.crmSearchAdmin.joins[baseEntity], function(join) {
 101             return new RegExp('^' + join.alias + '_\\d\\d').test(path);
 102           });
 103           if (!join) {
 104             console.warn( 'Join ' + fullNameOrAlias + ' not found.');
 105             return;
 106           }
 107           path = path.replace(join.alias + '_', '');
 108           var num = parseInt(path.substr(0, 2), 10);
 109           label.push(join.label + (num > 1 ? ' ' + num : ''));
 110           path = path.replace(/^\d\d_?/, '');
 111           if (path.length) {
 112             baseEntity = join.entity;
 113           }
 114         }
 115         result = _.assign(_.cloneDeep(join), {label: label.join(' - '), alias: alias, baseEntity: baseEntity});
 116         // Add the numbered suffix to the join conditions
 117         // If this is a deep join, also add the base entity prefix
 118         var prefix = alias.replace(new RegExp('_?' + join.alias + '_?\\d?\\d?$'), '');
 119         _.each(result.conditions, function(condition) {
 120           if (_.isArray(condition)) {
 121             _.each(condition, function(ref, side) {
 122               if (side !== 1 && _.includes(ref, '.')) {
 123                 condition[side] = ref.replace(join.alias + '.', alias + '.');
 124               } else if (side !== 1 && prefix.length && !_.includes(ref, '"') && !_.includes(ref, "'")) {
 125                 condition[side] = prefix + '.' + ref;
 126               }
 127             });
 128           }
 129         });
 130         return result;
 131       }
 132       function getFieldAndJoin(fieldName, entityName) {
 133         var dotSplit = fieldName.split('.'),
 134           joinEntity = dotSplit.length > 1 ? dotSplit[0] : null,
 135           name = _.last(dotSplit).split(':')[0],
 136           join,
 137           field;
 138         // Custom fields contain a dot in their fieldname
 139         // If 3 segments, the first is the joinEntity and the last 2 are the custom field
 140         if (dotSplit.length === 3) {
 141           name = dotSplit[1] + '.' + name;
 142         }
 143         // If 2 segments, it's ambiguous whether this is a custom field or joined field. Search the main entity first.
 144         if (dotSplit.length === 2) {
 145           field = _.find(getEntity(entityName).fields, {name: dotSplit[0] + '.' + name});
 146           if (field) {
 147             field.entity = entityName;
 148             return {field: field};
 149           }
 150         }
 151         if (joinEntity) {
 152           join = getJoin(joinEntity);
 153           entityName = getJoin(joinEntity).entity;
 154         }
 155         field = _.find(getEntity(entityName).fields, {name: name});
 156         if (!field && join && join.bridge) {
 157           field = _.find(getEntity(join.bridge).fields, {name: name});
 158         }
 159         if (field) {
 160           field.entity = entityName;
 161           return {field: field, join: join};
 162         }
 163       }
 164       function parseExpr(expr) {
 165         if (!expr) {
 166           return;
 167         }
 168         var splitAs = expr.split(' AS '),
 169           info = {fn: null, modifier: ''},
 170           fieldName = splitAs[0],
 171           bracketPos = splitAs[0].indexOf('(');
 172         if (bracketPos >= 0) {
 173           var parsed = splitAs[0].substr(bracketPos).match(/[ ]?([A-Z]+[ ]+)?([\w.:]+)/);
 174           fieldName = parsed[2];
 175           info.fn = _.find(CRM.crmSearchAdmin.functions, {name: expr.substring(0, bracketPos)});
 176           info.modifier = _.trim(parsed[1]);
 177         }
 178         var fieldAndJoin = getFieldAndJoin(fieldName, searchEntity);
 179         if (fieldAndJoin) {
 180           var split = fieldName.split(':'),
 181             prefixPos = split[0].lastIndexOf(fieldAndJoin.field.name);
 182           info.path = split[0];
 183           info.prefix = prefixPos > 0 ? info.path.substring(0, prefixPos) : '';
 184           info.suffix = !split[1] ? '' : ':' + split[1];
 185           info.field = fieldAndJoin.field;
 186           info.join = fieldAndJoin.join;
 187           info.alias = splitAs[1] || (info.fn ? info.fn.name + ':' + info.path + info.suffix : split[0]);
 188         }
 189         return info;
 190       }
 191       return {
 192         getEntity: getEntity,
 193         getField: function(fieldName, entityName) {
 194           return getFieldAndJoin(fieldName, entityName).field;
 195         },
 196         getJoin: getJoin,
 197         parseExpr: parseExpr,
 198         getDefaultLabel: function(col) {
 199           var info = parseExpr(col),
 200             label = info.field.label;
 201           if (info.fn) {
 202             label = '(' + info.fn.title + ') ' + label;
 203           }
 204           if (info.join) {
 205             label = info.join.label + ': ' + label;
 206           }
 207           return label;
 208         },
 209         // Find all possible search columns that could serve as contact_id for a smart group
 210         getSmartGroupColumns: function(api_entity, api_params) {
 211           var joins = _.pluck((api_params.join || []), 0);
 212           return _.transform([api_entity].concat(joins), function(columns, joinExpr) {
 213             var joinName = joinExpr.split(' AS '),
 214               joinInfo = joinName[1] ? getJoin(joinName[1]) : {entity: joinName[0]},
 215               entity = getEntity(joinInfo.entity),
 216               prefix = joinInfo.alias ? joinInfo.alias + '.' : '';
 217             _.each(entity.fields, function(field) {
 218               if ((entity.name === 'Contact' && field.name === 'id') || (field.fk_entity === 'Contact' && joinInfo.baseEntity !== 'Contact')) {
 219                 columns.push({
 220                   id: prefix + field.name,
 221                   text: (joinInfo.label ? joinInfo.label + ': ' : '') + field.label,
 222                   icon: entity.icon
 223                 });
 224               }
 225             });
 226           });
 227         }
 228       };
 229     });
 230
 231 })(angular, CRM.$, CRM._);