fab8679d69a7f544b6c995895a5e212d8f19b582
[working/Evergreen.git] / Open-ILS / web / js / ui / default / staff / services / grid.js
1 angular.module('egGridMod', 
2     ['egCoreMod', 'egUiMod', 'ui.bootstrap'])
3
4 .directive('egGrid', function() {
5     return {
6         restrict : 'AE',
7         transclude : true,
8         scope : {
9
10             // IDL class hint (e.g. "aou")
11             idlClass : '@',
12
13             // default page size
14             pageSize : '@',
15
16             // if true, grid columns are derived from all non-virtual
17             // fields on the base idlClass
18             autoFields : '@',
19
20             // grid preferences will be stored / retrieved with this key
21             persistKey : '@',
22
23             // field whose value is unique and may be used for item
24             // reference / lookup.  This will usually be someting like
25             // "id".  This is not needed when using autoFields, since we
26             // can determine the primary key directly from the IDL.
27             idField : '@',
28
29             // Reference to externally provided egGridDataProvider
30             itemsProvider : '=',
31
32             // Reference to externally provided item-selection handler
33             onSelect : '=',
34
35             // Reference to externally provided after-item-selection handler
36             afterSelect : '=',
37
38             // comma-separated list of supported or disabled grid features
39             // supported features:
40             //  startSelected : init the grid with all rows selected by default
41             //  allowAll : add an "All" option to row count (really 10000)
42             //  -menu : don't show any menu buttons (or use space for them)
43             //  -picker : don't show the column picker
44             //  -pagination : don't show any pagination elements, and set
45             //                the limit to 10000
46             //  -actions : don't show the actions dropdown
47             //  -index : don't show the row index column (can't use "index"
48             //           as the idField in this case)
49             //  -display : columns are hidden by default
50             //  -sort    : columns are unsortable by default 
51             //  -multisort : sort priorities config disabled by default
52             //  -multiselect : only one row at a time can be selected;
53             //                 choosing this also disables the checkbox
54             //                 column
55             features : '@',
56
57             // optional primary grid label
58             mainLabel : '@',
59
60             // if true, use the IDL class label as the mainLabel
61             autoLabel : '=', 
62
63             // optional context menu label
64             menuLabel : '@',
65
66             dateformat : '@', // optional: passed down to egGridValueFilter
67             datecontext: '@', // optional: passed down to egGridValueFilter to choose TZ
68             datefilter: '@', // optional: passed down to egGridValueFilter to choose specialized date filters
69             dateonlyinterval: '@', // optional: passed down to egGridValueFilter to choose a "better" format
70
71             // Hash of control functions.
72             //
73             //  These functions are defined by the calling scope and 
74             //  invoked as-is by the grid w/ the specified parameters.
75             //
76             //  collectStarted    : function() {}
77             //  itemRetrieved     : function(item) {}
78             //  allItemsRetrieved : function() {}
79             //
80             //  ---
81             //  If defined, the grid will watch the return value from
82             //  the function defined at watchQuery on each digest and 
83             //  re-draw the grid when query changes occur.
84             //
85             //  watchQuery : function() { /* return grid query */ }
86             //
87             //  ---------------
88             //  These functions are defined by the grid and thus
89             //  replace any values defined for these attributes from the
90             //  calling scope.
91             //
92             //  activateItem  : function(item) {}
93             //  allItems      : function(allItems) {}
94             //  selectedItems : function(selected) {}
95             //  selectItems   : function(ids) {}
96             //  setQuery      : function(queryStruct) {} // causes reload
97             //  setSort       : function(sortSturct) {} // causes reload
98             gridControls : '=',
99         },
100
101         // TODO: avoid hard-coded url
102         templateUrl : '/eg/staff/share/t_autogrid', 
103
104         link : function(scope, element, attrs) {     
105             // link() is called after page compilation, which means our
106             // eg-grid-field's have been parsed and loaded.  Now it's 
107             // safe to perform our initial page load.
108
109             // load auto fields after eg-grid-field's so they are not clobbered
110             scope.handleAutoFields();
111             scope.collect();
112
113             scope.grid_element = element;
114             $(element)
115                 .find('.eg-grid-content-body')
116                 .bind('contextmenu', scope.showActionContextMenu);
117         },
118
119         controller : [
120                     '$scope','$q','egCore','egGridFlatDataProvider','$location',
121                     'egGridColumnsProvider','$filter','$window','$sce','$timeout',
122                     'egProgressDialog',
123             function($scope,  $q , egCore,  egGridFlatDataProvider , $location,
124                      egGridColumnsProvider , $filter , $window , $sce , $timeout,
125                      egProgressDialog) {
126
127             var grid = this;
128
129             grid.init = function() {
130                 grid.offset = 0;
131                 $scope.items = [];
132                 $scope.showGridConf = false;
133                 grid.totalCount = -1;
134                 $scope.selected = {};
135                 $scope.actionGroups = [{actions:[]}]; // Grouped actions for selected items
136                 $scope.menuItems = []; // global actions
137
138                 // returns true if any rows are selected.
139                 $scope.hasSelected = function() {
140                     return grid.getSelectedItems().length > 0 };
141
142                 var features = ($scope.features) ? 
143                     $scope.features.split(',') : [];
144                 delete $scope.features;
145
146                 $scope.showIndex = (features.indexOf('-index') == -1);
147
148                 $scope.allowAll = (features.indexOf('allowAll') > -1);
149                 $scope.startSelected = $scope.selectAll = (features.indexOf('startSelected') > -1);
150                 $scope.showActions = (features.indexOf('-actions') == -1);
151                 $scope.showPagination = (features.indexOf('-pagination') == -1);
152                 $scope.showPicker = (features.indexOf('-picker') == -1);
153
154                 $scope.showMenu = (features.indexOf('-menu') == -1);
155
156                 // remove some unneeded values from the scope to reduce bloat
157
158                 grid.idlClass = $scope.idlClass;
159                 delete $scope.idlClass;
160
161                 grid.persistKey = $scope.persistKey;
162                 delete $scope.persistKey;
163
164                 var stored_limit = 0;
165                 if ($scope.showPagination) {
166                     if (grid.persistKey) {
167                         var stored_limit = Number(
168                             egCore.hatch.getLocalItem('eg.grid.' + grid.persistKey + '.limit')
169                         );
170                     }
171                 } else {
172                     stored_limit = 10000; // maybe support "Inf"?
173                 }
174
175                 grid.limit = Number(stored_limit) || Number($scope.pageSize) || 25;
176
177                 grid.indexField = $scope.idField;
178                 delete $scope.idField;
179
180                 grid.dataProvider = $scope.itemsProvider;
181
182                 if (!grid.indexField && grid.idlClass)
183                     grid.indexField = egCore.idl.classes[grid.idlClass].pkey;
184
185                 grid.columnsProvider = egGridColumnsProvider.instance({
186                     idlClass : grid.idlClass,
187                     clientSort : (features.indexOf('clientsort') > -1 && features.indexOf('-clientsort') == -1),
188                     defaultToHidden : (features.indexOf('-display') > -1),
189                     defaultToNoSort : (features.indexOf('-sort') > -1),
190                     defaultToNoMultiSort : (features.indexOf('-multisort') > -1),
191                     defaultDateFormat : $scope.dateformat,
192                     defaultDateContext : $scope.datecontext,
193                     defaultDateFilter : $scope.datefilter,
194                     defaultDateOnlyInterval : $scope.dateonlyinterval
195                 });
196                 $scope.canMultiSelect = (features.indexOf('-multiselect') == -1);
197
198                 $scope.handleAutoFields = function() {
199                     if ($scope.autoFields) {
200                         if (grid.autoLabel) {
201                             $scope.mainLabel = 
202                                 egCore.idl.classes[grid.idlClass].label;
203                         }
204                         grid.columnsProvider.compileAutoColumns();
205                         delete $scope.autoFields;
206                     }
207                 }
208    
209                 if (!grid.dataProvider) {
210                     // no provider, um, provided.
211                     // Use a flat data provider
212
213                     grid.selfManagedData = true;
214                     grid.dataProvider = egGridFlatDataProvider.instance({
215                         indexField : grid.indexField,
216                         idlClass : grid.idlClass,
217                         columnsProvider : grid.columnsProvider,
218                         query : $scope.query
219                     });
220                 }
221
222                 grid.dataProvider.columnsProvider = grid.columnsProvider;
223
224                 $scope.itemFieldValue = grid.dataProvider.itemFieldValue;
225                 $scope.indexValue = function(item) {
226                     return grid.indexValue(item)
227                 };
228
229                 grid.applyControlFunctions();
230
231                 grid.loadConfig().then(function() { 
232                     // link columns to scope after loadConfig(), since it
233                     // replaces the columns array.
234                     $scope.columns = grid.columnsProvider.columns;
235                 });
236
237                 // NOTE: grid.collect() is first called from link(), not here.
238             }
239
240             // link our control functions into the gridControls 
241             // scope object so the caller can access them.
242             grid.applyControlFunctions = function() {
243
244                 // we use some of these controls internally, so sett
245                 // them up even if the caller doesn't request them.
246                 var controls = $scope.gridControls || {};
247
248                 controls.columnMap = function() {
249                     var m = {};
250                     angular.forEach(grid.columnsProvider.columns, function (c) {
251                         m[c.name] = c;
252                     });
253                     return m;
254                 }
255
256                 controls.columnsProvider = function() {
257                     return grid.columnsProvider;
258                 }
259
260                 // link in the control functions
261                 controls.selectedItems = function() {
262                     return grid.getSelectedItems()
263                 }
264
265                 controls.allItems = function() {
266                     return $scope.items;
267                 }
268
269                 controls.selectItems = function(ids) {
270                     if (!ids) return;
271                     $scope.selected = {};
272                     angular.forEach(ids, function(i) {
273                         $scope.selected[''+i] = true;
274                     });
275                 }
276
277                 // if the caller provided a functional setQuery,
278                 // extract the value before replacing it
279                 if (controls.setQuery) {
280                     grid.dataProvider.query = 
281                         controls.setQuery();
282                 }
283
284                 controls.setQuery = function(query) {
285                     grid.dataProvider.query = query;
286                     controls.refresh();
287                 }
288
289                 if (controls.watchQuery) {
290                     // capture the initial query value
291                     grid.dataProvider.query = controls.watchQuery();
292
293                     // watch for changes
294                     $scope.gridWatchQuery = controls.watchQuery;
295                     $scope.$watch('gridWatchQuery()', function(newv) {
296                         controls.setQuery(newv);
297                     }, true);
298                 }
299
300                 // if the caller provided a functional setSort
301                 // extract the value before replacing it
302                 grid.dataProvider.sort = 
303                     controls.setSort ?  controls.setSort() : [];
304
305                 controls.setSort = function(sort) {
306                     controls.refresh();
307                 }
308
309                 controls.refresh = function(noReset) {
310                     if (!noReset) grid.offset = 0;
311                     grid.collect();
312                 }
313
314                 controls.setLimit = function(limit,forget) {
315                     if (!forget && grid.persistKey)
316                         egCore.hatch.setLocalItem('eg.grid.' + grid.persistKey + '.limit', limit);
317                     grid.limit = limit;
318                 }
319                 controls.getLimit = function() {
320                     return grid.limit;
321                 }
322                 controls.setOffset = function(offset) {
323                     grid.offset = offset;
324                 }
325                 controls.getOffset = function() {
326                     return grid.offset;
327                 }
328
329                 controls.saveConfig = function () {
330                     return $scope.saveConfig();
331                 }
332
333                 grid.dataProvider.refresh = controls.refresh;
334                 grid.controls = controls;
335             }
336
337             // If a menu item provides its own HTML template, translate it,
338             // using the menu item for the template scope.
339             // note: $sce is required to avoid security restrictions and
340             // is OK here, since the template comes directly from a
341             // local HTML template (not user input).
342             $scope.translateMenuItemTemplate = function(item) {
343                 var html = egCore.strings.$replace(item.template, {item : item});
344                 return $sce.trustAsHtml(html);
345             }
346
347             // add a new (global) grid menu item
348             grid.addMenuItem = function(item) {
349                 $scope.menuItems.push(item);
350                 var handler = item.handler;
351                 item.handler = function() {
352                     $scope.gridMenuIsOpen = false; // close menu
353                     if (handler) {
354                         handler(item, 
355                             item.handlerData, grid.getSelectedItems());
356                     }
357                 }
358             }
359
360             // add a selected-items action
361             grid.addAction = function(act) {
362                 var done = false;
363                 $scope.actionGroups.forEach(function(g){
364                     if (g.label === act.group) {
365                         g.actions.push(act);
366                         done = true;
367                     }
368                 });
369                 if (!done) {
370                     $scope.actionGroups.push({
371                         label : act.group,
372                         actions : [ act ]
373                     });
374                 }
375             }
376
377             // remove the stored column configuration preferenc, then recover 
378             // the column visibility information from the initial page load.
379             $scope.resetColumns = function() {
380                 $scope.gridColumnPickerIsOpen = false;
381                 egCore.hatch.removeItem('eg.grid.' + grid.persistKey)
382                 .then(function() {
383                     grid.columnsProvider.reset(); 
384                     if (grid.selfManagedData) grid.collect();
385                 });
386             }
387
388             $scope.showAllColumns = function() {
389                 $scope.gridColumnPickerIsOpen = false;
390                 grid.columnsProvider.showAllColumns();
391                 if (grid.selfManagedData) grid.collect();
392             }
393
394             $scope.hideAllColumns = function() {
395                 $scope.gridColumnPickerIsOpen = false;
396                 grid.columnsProvider.hideAllColumns();
397                 // note: no need to fetch new data if no columns are visible
398             }
399
400             $scope.toggleColumnVisibility = function(col) {
401                 $scope.gridColumnPickerIsOpen = false;
402                 col.visible = !col.visible;
403
404                 // egGridFlatDataProvider only retrieves data to be
405                 // displayed.  When column visibility changes, it's
406                 // necessary to fetch the newly visible column data.
407                 if (grid.selfManagedData) grid.collect();
408             }
409
410             // save the columns configuration (position, sort, width) to
411             // eg.grid.<persist-key>
412             $scope.saveConfig = function() {
413                 $scope.gridColumnPickerIsOpen = false;
414
415                 if (!grid.persistKey) {
416                     console.warn(
417                         "Cannot save settings without a grid persist-key");
418                     return;
419                 }
420
421                 // only store information about visible columns.
422                 var conf = grid.columnsProvider.columns.filter(
423                     function(col) {return Boolean(col.visible) });
424
425                 // now scrunch the data down to just the needed info
426                 conf = conf.map(function(col) {
427                     var c = {name : col.name}
428                     // Apart from the name, only store non-default values.
429                     // No need to store col.visible, since that's implicit
430                     if (col.align != 'left') c.align = col.align;
431                     if (col.flex != 2) c.flex = col.flex;
432                     if (Number(col.sort)) c.sort = Number(c.sort);
433                     return c;
434                 });
435
436                 egCore.hatch.setItem('eg.grid.' + grid.persistKey, conf)
437                 .then(function() { 
438                     // Save operation performed from the grid configuration UI.
439                     // Hide the configuration UI and re-draw w/ sort applied
440                     if ($scope.showGridConf) 
441                         $scope.toggleConfDisplay();
442                 });
443             }
444
445
446             // load the columns configuration (position, sort, width) from
447             // eg.grid.<persist-key> and apply the loaded settings to the
448             // columns on our columnsProvider
449             grid.loadConfig = function() {
450                 if (!grid.persistKey) return $q.when();
451
452                 return egCore.hatch.getItem('eg.grid.' + grid.persistKey)
453                 .then(function(conf) {
454                     if (!conf) return;
455
456                     var columns = grid.columnsProvider.columns;
457                     var new_cols = [];
458
459                     angular.forEach(conf, function(col) {
460                         var grid_col = columns.filter(
461                             function(c) {return c.name == col.name})[0];
462
463                         if (!grid_col) {
464                             // saved column does not match a column in the 
465                             // current grid.  skip it.
466                             return;
467                         }
468
469                         grid_col.align = col.align || 'left';
470                         grid_col.flex = col.flex || 2;
471                         grid_col.sort = col.sort || 0;
472                         // all saved columns are assumed to be true
473                         grid_col.visible = true;
474                         if (new_cols
475                                 .filter(function (c) {
476                                     return c.name == grid_col.name;
477                                 }).length == 0
478                         )
479                             new_cols.push(grid_col);
480                     });
481
482                     // columns which are not expressed within the saved 
483                     // configuration are marked as non-visible and 
484                     // appended to the end of the new list of columns.
485                     angular.forEach(columns, function(col) {
486                         var found = conf.filter(
487                             function(c) {return (c.name == col.name)})[0];
488                         if (!found) {
489                             col.visible = false;
490                             new_cols.push(col);
491                         }
492                     });
493
494                     grid.columnsProvider.columns = new_cols;
495                     grid.compileSort();
496
497                 });
498             }
499
500             $scope.onContextMenu = function($event) {
501                 var col = angular.element($event.target).attr('column');
502                 console.log('selected column ' + col);
503             }
504
505             $scope.page = function() {
506                 return (grid.offset / grid.limit) + 1;
507             }
508
509             $scope.goToPage = function(page) {
510                 page = Number(page);
511                 if (angular.isNumber(page) && page > 0) {
512                     grid.offset = (page - 1) * grid.limit;
513                     grid.collect();
514                 }
515             }
516
517             $scope.offset = function(o) {
518                 if (angular.isNumber(o))
519                     grid.offset = o;
520                 return grid.offset 
521             }
522
523             $scope.limit = function(l) { 
524                 if (angular.isNumber(l)) {
525                     if (grid.persistKey)
526                         egCore.hatch.setLocalItem('eg.grid.' + grid.persistKey + '.limit', l);
527                     grid.limit = l;
528                 }
529                 return grid.limit 
530             }
531
532             $scope.onFirstPage = function() {
533                 return grid.offset == 0;
534             }
535
536             $scope.hasNextPage = function() {
537                 // we have less data than requested, there must
538                 // not be any more pages
539                 if (grid.count() < grid.limit) return false;
540
541                 // if the total count is not known, assume that a full
542                 // page of data implies more pages are available.
543                 if (grid.totalCount == -1) return true;
544
545                 // we have a full page of data, but is there more?
546                 return grid.totalCount > (grid.offset + grid.count());
547             }
548
549             $scope.incrementPage = function() {
550                 grid.offset += grid.limit;
551                 grid.collect();
552             }
553
554             $scope.decrementPage = function() {
555                 if (grid.offset < grid.limit) {
556                     grid.offset = 0;
557                 } else {
558                     grid.offset -= grid.limit;
559                 }
560                 grid.collect();
561             }
562
563             // number of items loaded for the current page of results
564             grid.count = function() {
565                 return $scope.items.length;
566             }
567
568             // returns the unique identifier value for the provided item
569             // for internal consistency, indexValue is always coerced 
570             // into a string.
571             grid.indexValue = function(item) {
572                 if (angular.isObject(item)) {
573                     if (item !== null) {
574                         if (angular.isFunction(item[grid.indexField]))
575                             return ''+item[grid.indexField]();
576                         return ''+item[grid.indexField]; // flat data
577                     }
578                 }
579                 // passed a non-object; assume it's an index
580                 return ''+item; 
581             }
582
583             // fires the hide handler function for a context action
584             $scope.actionHide = function(action) {
585                 if (typeof action.hide == 'undefined') {
586                     return false;
587                 }
588                 if (angular.isFunction(action.hide))
589                     return action.hide(action);
590                 return action.hide;
591             }
592
593             // fires the disable handler function for a context action
594             $scope.actionDisable = function(action) {
595                 if (typeof action.disabled == 'undefined') {
596                     return false;
597                 }
598                 if (angular.isFunction(action.disabled))
599                     return action.disabled(action);
600                 return action.disabled;
601             }
602
603             // fires the action handler function for a context action
604             $scope.actionLauncher = function(action) {
605                 if (!action.handler) {
606                     console.error(
607                         'No handler specified for "' + action.label + '"');
608                 } else {
609
610                     try {
611                         action.handler(grid.getSelectedItems());
612                     } catch(E) {
613                         console.error('Error executing handler for "' 
614                             + action.label + '" => ' + E + "\n" + E.stack);
615                     }
616
617                     if ($scope.action_context_showing) $scope.hideActionContextMenu();
618                 }
619
620             }
621
622             $scope.hideActionContextMenu = function () {
623                 $($scope.menu_dom).css({
624                     display: '',
625                     width: $scope.action_context_width,
626                     top: $scope.action_context_y,
627                     left: $scope.action_context_x
628                 });
629                 $($scope.action_context_parent).append($scope.menu_dom);
630                 $scope.action_context_oldy = $scope.action_context_oldx = 0;
631                 $('body').unbind('click.remove_context_menu_'+$scope.action_context_index);
632                 $scope.action_context_showing = false;
633             }
634
635             $scope.action_context_showing = false;
636             $scope.showActionContextMenu = function ($event) {
637
638                 // Have to gather these here, instead of inside link()
639                 if (!$scope.menu_dom) $scope.menu_dom = $($scope.grid_element).find('.grid-action-dropdown')[0];
640                 if (!$scope.action_context_parent) $scope.action_context_parent = $($scope.menu_dom).parent();
641
642                 if (!grid.getSelectedItems().length) // Nothing selected, fire the click event
643                     $event.target.click();
644
645                 if (!$scope.action_context_showing) {
646                     $scope.action_context_width = $($scope.menu_dom).css('width');
647                     $scope.action_context_y = $($scope.menu_dom).css('top');
648                     $scope.action_context_x = $($scope.menu_dom).css('left');
649                     $scope.action_context_showing = true;
650                     $scope.action_context_index = Math.floor((Math.random() * 1000) + 1);
651
652                     $('body').append($($scope.menu_dom));
653                     $('body').bind('click.remove_context_menu_'+$scope.action_context_index, $scope.hideActionContextMenu);
654                 }
655
656                 $($scope.menu_dom).css({
657                     display: 'block',
658                     width: $scope.action_context_width,
659                     top: $event.pageY,
660                     left: $event.pageX
661                 });
662
663                 return false;
664             }
665
666             // returns the list of selected item objects
667             grid.getSelectedItems = function() {
668                 return $scope.items.filter(
669                     function(item) {
670                         return Boolean($scope.selected[grid.indexValue(item)]);
671                     }
672                 );
673             }
674
675             grid.getItemByIndex = function(index) {
676                 for (var i = 0; i < $scope.items.length; i++) {
677                     var item = $scope.items[i];
678                     if (grid.indexValue(item) == index) 
679                         return item;
680                 }
681             }
682
683             // selects one row after deselecting all of the others
684             grid.selectOneItem = function(index) {
685                 $scope.selected = {};
686                 $scope.selected[index] = true;
687             }
688
689             // selects or deselects an item, without affecting the others.
690             // returns true if the item is selected; false if de-selected.
691             // we overwrite the object so that we can watch $scope.selected
692             grid.toggleSelectOneItem = function(index) {
693                 if ($scope.selected[index]) {
694                     delete $scope.selected[index];
695                     $scope.selected = angular.copy($scope.selected);
696                     return false;
697                 } else {
698                     $scope.selected[index] = true;
699                     $scope.selected = angular.copy($scope.selected);
700                     return true;
701                 }
702             }
703
704             $scope.updateSelected = function () { 
705                     return $scope.selected = angular.copy($scope.selected);
706             };
707
708             grid.selectAllItems = function() {
709                 angular.forEach($scope.items, function(item) {
710                     $scope.selected[grid.indexValue(item)] = true
711                 }); 
712                 $scope.selected = angular.copy($scope.selected);
713             }
714
715             $scope.$watch('selectAll', function(newVal) {
716                 if (newVal) {
717                     grid.selectAllItems();
718                 } else {
719                     $scope.selected = {};
720                 }
721             });
722
723             if ($scope.onSelect) {
724                 $scope.$watch('selected', function(newVal) {
725                     $scope.onSelect(grid.getSelectedItems());
726                     if ($scope.afterSelect) $scope.afterSelect();
727                 });
728             }
729
730             // returns true if item1 appears in the list before item2;
731             // false otherwise.  this is slightly more efficient that
732             // finding the position of each then comparing them.
733             // item1 / item2 may be an item or an item index
734             grid.itemComesBefore = function(itemOrIndex1, itemOrIndex2) {
735                 var idx1 = grid.indexValue(itemOrIndex1);
736                 var idx2 = grid.indexValue(itemOrIndex2);
737
738                 // use for() for early exit
739                 for (var i = 0; i < $scope.items.length; i++) {
740                     var idx = grid.indexValue($scope.items[i]);
741                     if (idx == idx1) return true;
742                     if (idx == idx2) return false;
743                 }
744                 return false;
745             }
746
747             // 0-based position of item in the current data set
748             grid.indexOf = function(item) {
749                 var idx = grid.indexValue(item);
750                 for (var i = 0; i < $scope.items.length; i++) {
751                     if (grid.indexValue($scope.items[i]) == idx)
752                         return i;
753                 }
754                 return -1;
755             }
756
757             grid.modifyColumnFlex = function(column, val) {
758                 column.flex += val;
759                 // prevent flex:0;  use hiding instead
760                 if (column.flex < 1)
761                     column.flex = 1;
762             }
763             $scope.modifyColumnFlex = function(col, val) {
764                 $scope.lastModColumn = col.name;
765                 grid.modifyColumnFlex(col, val);
766             }
767
768             grid.modifyColumnPos = function(col, diff) {
769                 var srcIdx, targetIdx;
770                 angular.forEach(grid.columnsProvider.columns,
771                     function(c, i) { if (c.name == col.name) srcIdx = i });
772
773                 targetIdx = srcIdx + diff;
774                 if (targetIdx < 0) {
775                     targetIdx = 0;
776                 } else if (targetIdx >= grid.columnsProvider.columns.length) {
777                     // Target index follows the last visible column.
778                     var lastVisible = 0;
779                     angular.forEach(grid.columnsProvider.columns, 
780                         function(column, idx) {
781                             if (column.visible) lastVisible = idx;
782                         }
783                     );
784                     targetIdx = lastVisible + 1;
785                 }
786
787                 // Splice column out of old position, insert at new position.
788                 grid.columnsProvider.columns.splice(srcIdx, 1);
789                 grid.columnsProvider.columns.splice(targetIdx, 0, col);
790             }
791
792             $scope.modifyColumnPos = function(col, diff) {
793                 $scope.lastModColumn = col.name;
794                 return grid.modifyColumnPos(col, diff);
795             }
796
797
798             // handles click, control-click, and shift-click
799             $scope.handleRowClick = function($event, item) {
800                 var index = grid.indexValue(item);
801
802                 var origSelected = Object.keys($scope.selected);
803
804                 if (!$scope.canMultiSelect) {
805                     grid.selectOneItem(index);
806                     grid.lastSelectedItemIndex = index;
807                     return;
808                 }
809
810                 if ($event.ctrlKey || $event.metaKey /* mac command */) {
811                     // control-click
812                     if (grid.toggleSelectOneItem(index)) 
813                         grid.lastSelectedItemIndex = index;
814
815                 } else if ($event.shiftKey) { 
816                     // shift-click
817
818                     if (!grid.lastSelectedItemIndex || 
819                             index == grid.lastSelectedItemIndex) {
820                         grid.selectOneItem(index);
821                         grid.lastSelectedItemIndex = index;
822
823                     } else {
824
825                         var selecting = false;
826                         var ascending = grid.itemComesBefore(
827                             grid.lastSelectedItemIndex, item);
828                         var startPos = 
829                             grid.indexOf(grid.lastSelectedItemIndex);
830
831                         // update to new last-selected
832                         grid.lastSelectedItemIndex = index;
833
834                         // select each row between the last selected and 
835                         // currently selected items
836                         while (true) {
837                             startPos += ascending ? 1 : -1;
838                             var curItem = $scope.items[startPos];
839                             if (!curItem) break;
840                             var curIdx = grid.indexValue(curItem);
841                             $scope.selected[curIdx] = true;
842                             if (curIdx == index) break; // all done
843                         }
844                         $scope.selected = angular.copy($scope.selected);
845                     }
846                         
847                 } else {
848                     grid.selectOneItem(index);
849                     grid.lastSelectedItemIndex = index;
850                 }
851             }
852
853             // Builds a sort expression from column sort priorities.
854             // called on page load and any time the priorities are modified.
855             grid.compileSort = function() {
856                 var sortList = grid.columnsProvider.columns.filter(
857                     function(col) { return Number(col.sort) != 0 }
858                 ).sort( 
859                     function(a, b) { 
860                         if (Math.abs(a.sort) < Math.abs(b.sort))
861                             return -1;
862                         return 1;
863                     }
864                 );
865
866                 if (sortList.length) {
867                     grid.dataProvider.sort = sortList.map(function(col) {
868                         var blob = {};
869                         blob[col.name] = col.sort < 0 ? 'desc' : 'asc';
870                         return blob;
871                     });
872                 }
873             }
874
875             // builds a sort expression using a single column, 
876             // toggling between ascending and descending sort.
877             $scope.quickSort = function(col_name) {
878                 var sort = grid.dataProvider.sort;
879                 if (sort && sort.length &&
880                     sort[0] == col_name) {
881                     var blob = {};
882                     blob[col_name] = 'desc';
883                     grid.dataProvider.sort = [blob];
884                 } else {
885                     grid.dataProvider.sort = [col_name];
886                 }
887
888                 grid.offset = 0;
889                 grid.collect();
890             }
891
892             // show / hide the grid configuration row
893             $scope.toggleConfDisplay = function() {
894                 if ($scope.showGridConf) {
895                     $scope.showGridConf = false;
896                     if (grid.columnsProvider.hasSortableColumn()) {
897                         // only refresh the grid if the user has the
898                         // ability to modify the sort priorities.
899                         grid.compileSort();
900                         grid.offset = 0;
901                         grid.collect();
902                     }
903                 } else {
904                     $scope.showGridConf = true;
905                 }
906
907                 delete $scope.lastModColumn;
908                 $scope.gridColumnPickerIsOpen = false;
909             }
910
911             // called when a dragged column is dropped onto itself
912             // or any other column
913             grid.onColumnDrop = function(target) {
914                 if (angular.isUndefined(target)) return;
915                 if (target == grid.dragColumn) return;
916                 var srcIdx, targetIdx, srcCol;
917                 angular.forEach(grid.columnsProvider.columns,
918                     function(col, idx) {
919                         if (col.name == grid.dragColumn) {
920                             srcIdx = idx;
921                             srcCol = col;
922                         } else if (col.name == target) {
923                             targetIdx = idx;
924                         }
925                     }
926                 );
927
928                 if (srcIdx < targetIdx) targetIdx--;
929
930                 // move src column from old location to new location in 
931                 // the columns array, then force a page refresh
932                 grid.columnsProvider.columns.splice(srcIdx, 1);
933                 grid.columnsProvider.columns.splice(targetIdx, 0, srcCol);
934                 $scope.$apply(); 
935             }
936
937             // prepares a string for inclusion within a CSV document
938             // by escaping commas and quotes and removing newlines.
939             grid.csvDatum = function(str) {
940                 str = ''+str;
941                 if (!str) return '';
942                 str = str.replace(/\n/g, '');
943                 if (str.match(/\,/) || str.match(/"/)) {                                     
944                     str = str.replace(/"/g, '""');
945                     str = '"' + str + '"';                                           
946                 } 
947                 return str;
948             }
949
950             /** Export the full data set as CSV.
951              *  Flow of events:
952              *  1. User clicks the 'download csv' link
953              *  2. All grid data is retrieved asychronously
954              *  3. Once all data is all present and CSV-ized, the download 
955              *     attributes are linked to the href.
956              *  4. The href .click() action is prgrammatically fired again,
957              *     telling the browser to download the data, now that the
958              *     data is available for download.
959              *  5 Once downloaded, the href attributes are reset.
960              */
961             grid.csvExportInProgress = false;
962             $scope.generateCSVExportURL = function($event) {
963
964                 if (grid.csvExportInProgress) {
965                     // This is secondary href click handler.  Give the
966                     // browser a moment to start the download, then reset
967                     // the CSV download attributes / state.
968                     $timeout(
969                         function() {
970                             $scope.csvExportURL = '';
971                             $scope.csvExportFileName = ''; 
972                             grid.csvExportInProgress = false;
973                         }, 500
974                     );
975                     return;
976                 } 
977
978                 grid.csvExportInProgress = true;
979                 $scope.gridColumnPickerIsOpen = false;
980
981                 // let the file name describe the grid
982                 $scope.csvExportFileName = 
983                     ($scope.mainLabel || grid.persistKey || 'eg_grid_data')
984                     .replace(/\s+/g, '_') + '_' + $scope.page();
985
986                 // toss the CSV into a Blob and update the export URL
987                 grid.generateCSV().then(function(csv) {
988                     var blob = new Blob([csv], {type : 'text/plain'});
989                     $scope.csvExportURL = 
990                         ($window.URL || $window.webkitURL).createObjectURL(blob);
991
992                     // Fire the 2nd click event now that the browser has
993                     // information on how to download the CSV file.
994                     $timeout(function() {$event.target.click()});
995                 });
996             }
997
998             /*
999              * TODO: does this serve any purpose given we can 
1000              * print formatted HTML?  If so, generateCSV() now
1001              * returns a promise, needs light refactoring...
1002             $scope.printCSV = function() {
1003                 $scope.gridColumnPickerIsOpen = false;
1004                 egCore.print.print({
1005                     context : 'default', 
1006                     content : grid.generateCSV(),
1007                     content_type : 'text/plain'
1008                 });
1009             }
1010             */
1011
1012             // Given a row item and column definition, extract the
1013             // text content for printing.  Templated columns must be
1014             // processed and parsed as HTML, then boiled down to their 
1015             // text content.
1016             grid.getItemTextContent = function(item, col) {
1017                 var val;
1018                 if (col.template) {
1019                     val = $scope.translateCellTemplate(col, item);
1020                     if (val) {
1021                         var node = new DOMParser()
1022                             .parseFromString(val, 'text/html');
1023                         val = $(node).text();
1024                     }
1025                 } else {
1026                     val = grid.dataProvider.itemFieldValue(item, col);
1027                     val = $filter('egGridValueFilter')(val, col, item);
1028                 }
1029                 return val;
1030             }
1031
1032             /**
1033              * Fetches all grid data and transates each item into a simple
1034              * key-value pair of column name => text-value.
1035              * Included in the response for convenience is the list of 
1036              * currently visible column definitions.
1037              * TODO: currently fetches a maximum of 10k rows.  Does this
1038              * need to be configurable?
1039              */
1040             grid.getAllItemsAsText = function() {
1041                 var text_items = [];
1042
1043                 // we don't know the total number of rows we're about
1044                 // to retrieve, but we can indicate the number retrieved
1045                 // so far as each item arrives.
1046                 egProgressDialog.open({value : 0});
1047
1048                 var visible_cols = grid.columnsProvider.columns.filter(
1049                     function(c) { return c.visible });
1050
1051                 return grid.dataProvider.get(0, 10000).then(
1052                     function() { 
1053                         return {items : text_items, columns : visible_cols};
1054                     }, 
1055                     null,
1056                     function(item) { 
1057                         egProgressDialog.increment();
1058                         var text_item = {};
1059                         angular.forEach(visible_cols, function(col) {
1060                             text_item[col.name] = 
1061                                 grid.getItemTextContent(item, col);
1062                         });
1063                         text_items.push(text_item);
1064                     }
1065                 ).finally(egProgressDialog.close);
1066             }
1067
1068             // Fetch "all" of the grid data, translate it into print-friendly 
1069             // text, and send it to the printer service.
1070             $scope.printHTML = function() {
1071                 $scope.gridColumnPickerIsOpen = false;
1072                 return grid.getAllItemsAsText().then(function(text_items) {
1073                     return egCore.print.print({
1074                         template : 'grid_html',
1075                         scope : text_items
1076                     });
1077                 });
1078             }
1079
1080             // generates CSV for the currently visible grid contents
1081             grid.generateCSV = function() {
1082                 return grid.getAllItemsAsText().then(function(text_items) {
1083                     var columns = text_items.columns;
1084                     var items = text_items.items;
1085                     var csvStr = '';
1086
1087                     // column headers
1088                     angular.forEach(columns, function(col) {
1089                         csvStr += grid.csvDatum(col.label);
1090                         csvStr += ',';
1091                     });
1092
1093                     csvStr = csvStr.replace(/,$/,'\n');
1094
1095                     // items
1096                     angular.forEach(items, function(item) {
1097                         angular.forEach(columns, function(col) {
1098                             csvStr += grid.csvDatum(item[col.name]);
1099                             csvStr += ',';
1100                         });
1101                         csvStr = csvStr.replace(/,$/,'\n');
1102                     });
1103
1104                     return csvStr;
1105                 });
1106             }
1107
1108             // Interpolate the value for column.linkpath within the context
1109             // of the row item to generate the final link URL.
1110             $scope.generateLinkPath = function(col, item) {
1111                 return egCore.strings.$replace(col.linkpath, {item : item});
1112             }
1113
1114             // If a column provides its own HTML template, translate it,
1115             // using the current item for the template scope.
1116             // note: $sce is required to avoid security restrictions and
1117             // is OK here, since the template comes directly from a
1118             // local HTML template (not user input).
1119             $scope.translateCellTemplate = function(col, item) {
1120                 var html = egCore.strings.$replace(col.template, {item : item});
1121                 return $sce.trustAsHtml(html);
1122             }
1123
1124             $scope.collect = function() { grid.collect() }
1125
1126             // asks the dataProvider for a page of data
1127             grid.collect = function() {
1128
1129                 // avoid firing the collect if there is nothing to collect.
1130                 if (grid.selfManagedData && !grid.dataProvider.query) return;
1131
1132                 if (grid.collecting) return; // avoid parallel collect()
1133                 grid.collecting = true;
1134
1135                 console.debug('egGrid.collect() offset=' 
1136                     + grid.offset + '; limit=' + grid.limit);
1137
1138                 // ensure all of our dropdowns are closed
1139                 // TODO: git rid of these and just use dropdown-toggle, 
1140                 // which is more reliable.
1141                 $scope.gridColumnPickerIsOpen = false;
1142                 $scope.gridRowCountIsOpen = false;
1143                 $scope.gridPageSelectIsOpen = false;
1144
1145                 $scope.items = [];
1146                 $scope.selected = {};
1147
1148                 // Inform the caller we've asked the data provider
1149                 // for data.  This is useful for knowing when collection
1150                 // has started (e.g. to display a progress dialg) when 
1151                 // using the stock (flattener) data provider, where the 
1152                 // user is not directly defining a get() handler.
1153                 if (grid.controls.collectStarted)
1154                     grid.controls.collectStarted(grid.offset, grid.limit);
1155
1156                 grid.dataProvider.get(grid.offset, grid.limit).then(
1157                 function() {
1158                     if (grid.controls.allItemsRetrieved)
1159                         grid.controls.allItemsRetrieved();
1160                 },
1161                 null, 
1162                 function(item) {
1163                     if (item) {
1164                         $scope.items.push(item)
1165                         if (grid.controls.itemRetrieved)
1166                             grid.controls.itemRetrieved(item);
1167                         if ($scope.selectAll)
1168                             $scope.selected[grid.indexValue(item)] = true
1169                     }
1170                 }).finally(function() { 
1171                     console.debug('egGrid.collect() complete');
1172                     grid.collecting = false 
1173                     $scope.selected = angular.copy($scope.selected);
1174                 });
1175             }
1176
1177             grid.init();
1178         }]
1179     };
1180 })
1181
1182 /**
1183  * eg-grid-field : used for collecting custom field data from the templates.
1184  * This directive does not direct display, it just passes data up to the 
1185  * parent grid.
1186  */
1187 .directive('egGridField', function() {
1188     return {
1189         require : '^egGrid',
1190         restrict : 'AE',
1191         scope : {
1192             flesher: '=', // optional; function that can flesh a linked field, given the value
1193             comparator: '=', // optional; function that can sort the thing at the end of 'path' 
1194             name  : '@', // required; unique name
1195             path  : '@', // optional; flesh path
1196             ignore: '@', // optional; fields to ignore when path is a wildcard
1197             label : '@', // optional; display label
1198             flex  : '@',  // optional; default flex width
1199             align  : '@',  // optional; default alignment, left/center/right
1200             dateformat : '@', // optional: passed down to egGridValueFilter
1201             datecontext: '@', // optional: passed down to egGridValueFilter to choose TZ
1202             datefilter: '@', // optional: passed down to egGridValueFilter to choose specialized date filters
1203             dateonlyinterval: '@', // optional: passed down to egGridValueFilter to choose a "better" format
1204
1205             // if a field is part of an IDL object, but we are unable to
1206             // determine the class, because it's nested within a hash
1207             // (i.e. we can't navigate directly to the object via the IDL),
1208             // idlClass lets us specify the class.  This is particularly
1209             // useful for nested wildcard fields.
1210             parentIdlClass : '@', 
1211
1212             // optional: for non-IDL columns, specifying a datatype
1213             // lets the caller control which display filter is used.
1214             // datatype should match the standard IDL datatypes.
1215             datatype : '@'
1216         },
1217         link : function(scope, element, attrs, egGridCtrl) {
1218
1219             // boolean fields are presented as value-less attributes
1220             angular.forEach(
1221                 [
1222                     'visible', 
1223                     'hidden', 
1224                     'sortable', 
1225                     'nonsortable',
1226                     'multisortable',
1227                     'nonmultisortable',
1228                     'required' // if set, always fetch data for this column
1229                 ],
1230                 function(field) {
1231                     if (angular.isDefined(attrs[field]))
1232                         scope[field] = true;
1233                 }
1234             );
1235
1236             // any HTML content within the field is its custom template
1237             var tmpl = element.html();
1238             if (tmpl && !tmpl.match(/^\s*$/))
1239                 scope.template = tmpl
1240
1241             egGridCtrl.columnsProvider.add(scope);
1242             scope.$destroy();
1243         }
1244     };
1245 })
1246
1247 /**
1248  * eg-grid-action : used for specifying actions which may be applied
1249  * to items within the grid.
1250  */
1251 .directive('egGridAction', function() {
1252     return {
1253         require : '^egGrid',
1254         restrict : 'AE',
1255         transclude : true,
1256         scope : {
1257             group   : '@', // Action group, ungrouped if not set
1258             label   : '@', // Action label
1259             handler : '=',  // Action function handler
1260             hide    : '=',
1261             disabled : '=', // function
1262             divider : '='
1263         },
1264         link : function(scope, element, attrs, egGridCtrl) {
1265             egGridCtrl.addAction({
1266                 hide  : scope.hide,
1267                 group : scope.group,
1268                 label : scope.label,
1269                 divider : scope.divider,
1270                 handler : scope.handler,
1271                 disabled : scope.disabled,
1272             });
1273             scope.$destroy();
1274         }
1275     };
1276 })
1277
1278 .factory('egGridColumnsProvider', ['egCore', function(egCore) {
1279
1280     function ColumnsProvider(args) {
1281         var cols = this;
1282         cols.columns = [];
1283         cols.stockVisible = [];
1284         cols.idlClass = args.idlClass;
1285         cols.clientSort = args.clientSort;
1286         cols.defaultToHidden = args.defaultToHidden;
1287         cols.defaultToNoSort = args.defaultToNoSort;
1288         cols.defaultToNoMultiSort = args.defaultToNoMultiSort;
1289         cols.defaultDateFormat = args.defaultDateFormat;
1290         cols.defaultDateContext = args.defaultDateContext;
1291
1292         // resets column width, visibility, and sort behavior
1293         // Visibility resets to the visibility settings defined in the 
1294         // template (i.e. the original egGridField values).
1295         cols.reset = function() {
1296             angular.forEach(cols.columns, function(col) {
1297                 col.align = 'left';
1298                 col.flex = 2;
1299                 col.sort = 0;
1300                 if (cols.stockVisible.indexOf(col.name) > -1) {
1301                     col.visible = true;
1302                 } else {
1303                     col.visible = false;
1304                 }
1305             });
1306         }
1307
1308         // returns true if any columns are sortable
1309         cols.hasSortableColumn = function() {
1310             return cols.columns.filter(
1311                 function(col) {
1312                     return col.sortable || col.multisortable;
1313                 }
1314             ).length > 0;
1315         }
1316
1317         cols.showAllColumns = function() {
1318             angular.forEach(cols.columns, function(column) {
1319                 column.visible = true;
1320             });
1321         }
1322
1323         cols.hideAllColumns = function() {
1324             angular.forEach(cols.columns, function(col) {
1325                 delete col.visible;
1326             });
1327         }
1328
1329         cols.indexOf = function(name) {
1330             for (var i = 0; i < cols.columns.length; i++) {
1331                 if (cols.columns[i].name == name) 
1332                     return i;
1333             }
1334             return -1;
1335         }
1336
1337         cols.findColumn = function(name) {
1338             return cols.columns[cols.indexOf(name)];
1339         }
1340
1341         cols.compileAutoColumns = function() {
1342             var idl_class = egCore.idl.classes[cols.idlClass];
1343
1344             angular.forEach(
1345                 idl_class.fields,
1346                 function(field) {
1347                     if (field.virtual) return;
1348                     if (field.datatype == 'link' || field.datatype == 'org_unit') {
1349                         // if the field is a link and the linked class has a
1350                         // "selector" field specified, use the selector field
1351                         // as the display field for the columns.
1352                         // flattener will take care of the fleshing.
1353                         if (field['class']) {
1354                             var selector_field = egCore.idl.classes[field['class']].fields
1355                                 .filter(function(f) { return Boolean(f.selector) })[0];
1356                             if (selector_field) {
1357                                 field.path = field.name + '.' + selector_field.selector;
1358                             }
1359                         }
1360                     }
1361                     cols.add(field, true);
1362                 }
1363             );
1364         }
1365
1366         // if a column definition has a path with a wildcard, create
1367         // columns for all non-virtual fields at the specified 
1368         // position in the path.
1369         cols.expandPath = function(colSpec) {
1370
1371             var ignoreList = [];
1372             if (colSpec.ignore)
1373                 ignoreList = colSpec.ignore.split(' ');
1374
1375             var dotpath = colSpec.path.replace(/\.?\*$/,'');
1376             var class_obj;
1377             var idl_field;
1378
1379             if (colSpec.parentIdlClass) {
1380                 class_obj = egCore.idl.classes[colSpec.parentIdlClass];
1381             } else {
1382                 class_obj = egCore.idl.classes[cols.idlClass];
1383             }
1384             var idl_parent = class_obj;
1385             var old_field_label = '';
1386
1387             if (!class_obj) return;
1388
1389             console.debug('egGrid: auto dotpath is: ' + dotpath);
1390             var path_parts = dotpath.split(/\./);
1391
1392             // find the IDL class definition for the last element in the
1393             // path before the .*
1394             // an empty path_parts means expand the root class
1395             if (path_parts) {
1396                 var old_field;
1397                 for (var path_idx in path_parts) {
1398                     old_field = idl_field;
1399
1400                     var part = path_parts[path_idx];
1401                     idl_field = class_obj.field_map[part];
1402
1403                     // unless we're at the end of the list, this field should
1404                     // link to another class.
1405                     if (idl_field && idl_field['class'] && (
1406                         idl_field.datatype == 'link' || 
1407                         idl_field.datatype == 'org_unit')) {
1408                         if (old_field_label) old_field_label += ' : ';
1409                         old_field_label += idl_field.label;
1410                         class_obj = egCore.idl.classes[idl_field['class']];
1411                         if (old_field) idl_parent = old_field;
1412                     } else {
1413                         if (path_idx < (path_parts.length - 1)) {
1414                             // we ran out of classes to hop through before
1415                             // we ran out of path components
1416                             console.error("egGrid: invalid IDL path: " + dotpath);
1417                         }
1418                     }
1419                 }
1420             }
1421
1422             if (class_obj) {
1423                 angular.forEach(class_obj.fields, function(field) {
1424
1425                     // Only show wildcard fields where we have data to show
1426                     // Virtual and un-fleshed links will not have any data.
1427                     if (field.virtual ||
1428                         (field.datatype == 'link' || field.datatype == 'org_unit') ||
1429                         ignoreList.indexOf(field.name) > -1
1430                     )
1431                         return;
1432
1433                     var col = cols.cloneFromScope(colSpec);
1434                     col.path = (dotpath ? dotpath + '.' + field.name : field.name);
1435
1436                     // log line below is very chatty.  disable until needed.
1437                     // console.debug('egGrid: field: ' +field.name + '; parent field: ' + js2JSON(idl_parent));
1438                     cols.add(col, false, true, 
1439                         {idl_parent : idl_parent, idl_field : field, idl_class : class_obj, field_parent_label : old_field_label });
1440                 });
1441
1442                 cols.columns = cols.columns.sort(
1443                     function(a, b) {
1444                         if (a.explicit) return -1;
1445                         if (b.explicit) return 1;
1446
1447                         if (a.idlclass && b.idlclass) {
1448                             if (a.idlclass < b.idlclass) return -1;
1449                             if (b.idlclass < a.idlclass) return 1;
1450                         }
1451
1452                         if (a.path && b.path && a.path.lastIndexOf('.') && b.path.lastIndexOf('.')) {
1453                             if (a.path.substring(0, a.path.lastIndexOf('.')) < b.path.substring(0, b.path.lastIndexOf('.'))) return -1;
1454                             if (b.path.substring(0, b.path.lastIndexOf('.')) < a.path.substring(0, a.path.lastIndexOf('.'))) return 1;
1455                         }
1456
1457                         if (a.label && b.label) {
1458                             if (a.label < b.label) return -1;
1459                             if (b.label < a.label) return 1;
1460                         }
1461
1462                         return a.name < b.name ? -1 : 1;
1463                     }
1464                 );
1465
1466
1467             } else {
1468                 console.error(
1469                     "egGrid: wildcard path does not resolve to an object: "
1470                     + dotpath);
1471             }
1472         }
1473
1474         // angular.clone(scopeObject) is not permittable.  Manually copy
1475         // the fields over that we need (so the scope object can go away).
1476         cols.cloneFromScope = function(colSpec) {
1477             return {
1478                 flesher  : colSpec.flesher,
1479                 comparator  : colSpec.comparator,
1480                 name  : colSpec.name,
1481                 label : colSpec.label,
1482                 path  : colSpec.path,
1483                 align  : colSpec.align || 'left',
1484                 flex  : Number(colSpec.flex) || 2,
1485                 sort  : Number(colSpec.sort) || 0,
1486                 required : colSpec.required,
1487                 linkpath : colSpec.linkpath,
1488                 template : colSpec.template,
1489                 visible  : colSpec.visible,
1490                 hidden   : colSpec.hidden,
1491                 datatype : colSpec.datatype,
1492                 sortable : colSpec.sortable,
1493                 nonsortable      : colSpec.nonsortable,
1494                 multisortable    : colSpec.multisortable,
1495                 nonmultisortable : colSpec.nonmultisortable,
1496                 dateformat       : colSpec.dateformat,
1497                 datecontext      : colSpec.datecontext,
1498                 datefilter      : colSpec.datefilter,
1499                 dateonlyinterval : colSpec.dateonlyinterval,
1500                 parentIdlClass   : colSpec.parentIdlClass
1501             };
1502         }
1503
1504
1505         // Add a column to the columns collection.
1506         // Columns may come from a slim eg-columns-field or 
1507         // directly from the IDL.
1508         cols.add = function(colSpec, fromIDL, fromExpand, idl_info) {
1509
1510             // First added column with the specified path takes precedence.
1511             // This allows for specific definitions followed by wildcard
1512             // definitions.  If a match is found, back out.
1513             if (cols.columns.filter(function(c) {
1514                 return (c.path == colSpec.path) })[0]) {
1515                 console.debug('skipping pre-existing column ' + colSpec.path);
1516                 return;
1517             }
1518
1519             var column = fromExpand ? colSpec : cols.cloneFromScope(colSpec);
1520
1521             if (column.path && column.path.match(/\*$/)) 
1522                 return cols.expandPath(colSpec);
1523
1524             if (!fromExpand) column.explicit = true;
1525
1526             if (!column.name) column.name = column.path;
1527             if (!column.path) column.path = column.name;
1528
1529             if (column.visible || (!cols.defaultToHidden && !column.hidden))
1530                 column.visible = true;
1531
1532             if (column.sortable || (!cols.defaultToNoSort && !column.nonsortable))
1533                 column.sortable = true;
1534
1535             if (column.multisortable || 
1536                 (!cols.defaultToNoMultiSort && !column.nonmultisortable))
1537                 column.multisortable = true;
1538
1539             if (cols.defaultDateFormat && ! column.dateformat) {
1540                 column.dateformat = cols.defaultDateFormat;
1541             }
1542
1543             if (cols.defaultDateOnlyInterval && ! column.dateonlyinterval) {
1544                 column.dateonlyinterval = cols.defaultDateOnlyInterval;
1545             }
1546
1547             if (cols.defaultDateContext && ! column.datecontext) {
1548                 column.datecontext = cols.defaultDateContext;
1549             }
1550
1551             if (cols.defaultDateFilter && ! column.datefilter) {
1552                 column.datefilter = cols.defaultDateFilter;
1553             }
1554
1555             cols.columns.push(column);
1556
1557             // Track which columns are visible by default in case we
1558             // need to reset column visibility
1559             if (column.visible) 
1560                 cols.stockVisible.push(column.name);
1561
1562             if (fromIDL) return; // directly from egIDL.  nothing left to do.
1563
1564             // lookup the matching IDL field
1565             if (!idl_info && cols.idlClass) 
1566                 idl_info = cols.idlFieldFromPath(column.path);
1567
1568             if (!idl_info) {
1569                 // column is not represented within the IDL
1570                 column.adhoc = true; 
1571                 return; 
1572             }
1573
1574             column.datatype = idl_info.idl_field.datatype;
1575             
1576             if (!column.label) {
1577                 column.label = idl_info.idl_field.label || column.name;
1578             }
1579
1580             if (fromExpand && idl_info.idl_class) {
1581                 column.idlclass = '';
1582                 if (idl_info.field_parent_label && idl_info.idl_parent.label != idl_info.idl_class.label) {
1583                     column.idlclass = (idl_info.field_parent_label || idl_info.idl_parent.label || idl_info.idl_parent.name);
1584                 } else {
1585                     column.idlclass += idl_info.idl_class.label || idl_info.idl_class.name;
1586                 }
1587             }
1588         },
1589
1590         // finds the IDL field from the dotpath, using the columns
1591         // idlClass as the base.
1592         cols.idlFieldFromPath = function(dotpath) {
1593             var class_obj = egCore.idl.classes[cols.idlClass];
1594             var path_parts = dotpath.split(/\./);
1595
1596             var idl_parent;
1597             var idl_field;
1598             for (var path_idx in path_parts) {
1599                 var part = path_parts[path_idx];
1600                 idl_parent = idl_field;
1601                 idl_field = class_obj.field_map[part];
1602
1603                 if (idl_field) {
1604                     if (idl_field['class'] && (
1605                         idl_field.datatype == 'link' || 
1606                         idl_field.datatype == 'org_unit')) {
1607                         class_obj = egCore.idl.classes[idl_field['class']];
1608                     }
1609                 } else {
1610                     return null;
1611                 }
1612             }
1613
1614             return {
1615                 idl_parent: idl_parent,
1616                 idl_field : idl_field,
1617                 idl_class : class_obj
1618             };
1619         }
1620     }
1621
1622     return {
1623         instance : function(args) { return new ColumnsProvider(args) }
1624     }
1625 }])
1626
1627
1628 /*
1629  * Generic data provider template class.  This is basically an abstract
1630  * class factory service whose instances can be locally modified to 
1631  * meet the needs of each individual grid.
1632  */
1633 .factory('egGridDataProvider', 
1634            ['$q','$timeout','$filter','egCore',
1635     function($q , $timeout , $filter , egCore) {
1636
1637         function GridDataProvider(args) {
1638             var gridData = this;
1639             if (!args) args = {};
1640
1641             gridData.sort = [];
1642             gridData.get = args.get;
1643             gridData.query = args.query;
1644             gridData.idlClass = args.idlClass;
1645             gridData.columnsProvider = args.columnsProvider;
1646
1647             // Delivers a stream of array data via promise.notify()
1648             // Useful for passing an array of data to egGrid.get()
1649             // If a count is provided, the array will be trimmed to
1650             // the range defined by count and offset
1651             gridData.arrayNotifier = function(arr, offset, count) {
1652                 if (!arr || arr.length == 0) return $q.when();
1653
1654                 if (gridData.columnsProvider.clientSort
1655                     && gridData.sort
1656                     && gridData.sort.length > 0
1657                 ) {
1658                     var sorter_cache = [];
1659                     arr.sort(function(a,b) {
1660                         for (var si = 0; si < gridData.sort.length; si++) {
1661                             if (!sorter_cache[si]) { // Build sort structure on first comparison, reuse thereafter
1662                                 var field = gridData.sort[si];
1663                                 var dir = 'asc';
1664
1665                                 if (angular.isObject(field)) {
1666                                     dir = Object.values(field)[0];
1667                                     field = Object.keys(field)[0];
1668                                 }
1669
1670                                 var path = gridData.columnsProvider.findColumn(field).path || field;
1671                                 var comparator = gridData.columnsProvider.findColumn(field).comparator ||
1672                                     function (x,y) { if (x < y) return -1; if (x > y) return 1; return 0 };
1673
1674                                 sorter_cache[si] = {
1675                                     field       : path,
1676                                     dir         : dir,
1677                                     comparator  : comparator
1678                                 };
1679                             }
1680
1681                             var sc = sorter_cache[si];
1682
1683                             var af,bf;
1684
1685                             if (a._isfieldmapper || angular.isFunction(a[sc.field])) {
1686                                 try {af = a[sc.field](); bf = b[sc.field]() } catch (e) {};
1687                             } else {
1688                                 af = a[sc.field]; bf = b[sc.field];
1689                             }
1690                             if (af === undefined && sc.field.indexOf('.') > -1) { // assume an object, not flat path
1691                                 var parts = sc.field.split('.');
1692                                 af = a;
1693                                 bf = b;
1694                                 angular.forEach(parts, function (p) {
1695                                     if (af) {
1696                                         if (af._isfieldmapper || angular.isFunction(af[p])) af = af[p]();
1697                                         else af = af[p];
1698                                     }
1699                                     if (bf) {
1700                                         if (bf._isfieldmapper || angular.isFunction(bf[p])) bf = bf[p]();
1701                                         else bf = bf[p];
1702                                     }
1703                                 });
1704                             }
1705
1706                             if (af === undefined) af = null;
1707                             if (bf === undefined) bf = null;
1708
1709                             if (af === null && bf !== null) return 1;
1710                             if (bf === null && af !== null) return -1;
1711
1712                             if (!(bf === null && af === null)) {
1713                                 var partial = sc.comparator(af,bf);
1714                                 if (partial) {
1715                                     if (sc.dir == 'desc') {
1716                                         if (partial > 0) return -1;
1717                                         return 1;
1718                                     }
1719                                     return partial;
1720                                 }
1721                             }
1722                         }
1723
1724                         return 0;
1725                     });
1726                 }
1727
1728                 if (count) arr = arr.slice(offset, offset + count);
1729                 var def = $q.defer();
1730                 // promise notifications are only witnessed when delivered
1731                 // after the caller has his hands on the promise object
1732                 $timeout(function() {
1733                     angular.forEach(arr, def.notify);
1734                     def.resolve();
1735                 });
1736                 return def.promise;
1737             }
1738
1739             // Calls the grid refresh function.  Once instantiated, the
1740             // grid will replace this function with it's own refresh()
1741             gridData.refresh = function(noReset) { }
1742
1743             if (!gridData.get) {
1744                 // returns a promise whose notify() delivers items
1745                 gridData.get = function(index, count) {
1746                     console.error("egGridDataProvider.get() not implemented");
1747                 }
1748             }
1749
1750             // attempts a flat field lookup first.  If the column is not
1751             // found on the top-level object, attempts a nested lookup
1752             // TODO: consider a caching layer to speed up template 
1753             // rendering, particularly for nested objects?
1754             gridData.itemFieldValue = function(item, column) {
1755                 var val;
1756                 if (column.name in item) {
1757                     if (typeof item[column.name] == 'function') {
1758                         val = item[column.name]();
1759                     } else {
1760                         val = item[column.name];
1761                     }
1762                 } else {
1763                     val = gridData.nestedItemFieldValue(item, column);
1764                 }
1765
1766                 return val;
1767             }
1768
1769             // TODO: deprecate me
1770             gridData.flatItemFieldValue = function(item, column) {
1771                 console.warn('gridData.flatItemFieldValue deprecated; '
1772                     + 'leave provider.itemFieldValue unset');
1773                 return item[column.name];
1774             }
1775
1776             // given an object and a dot-separated path to a field,
1777             // extract the value of the field.  The path can refer
1778             // to function names or object attributes.  If the final
1779             // value is an IDL field, run the value through its
1780             // corresponding output filter.
1781             gridData.nestedItemFieldValue = function(obj, column) {
1782                 item = obj; // keep a copy around
1783
1784                 if (obj === null || obj === undefined || obj === '') return '';
1785                 if (!column.path) return obj;
1786
1787                 var idl_field;
1788                 var parts = column.path.split('.');
1789
1790                 angular.forEach(parts, function(step, idx) {
1791                     // object is not fleshed to the expected extent
1792                     if (typeof obj != 'object') {
1793                         if (typeof obj != 'undefined' && column.flesher) {
1794                             obj = column.flesher(obj, column, item);
1795                         } else {
1796                             obj = '';
1797                             return;
1798                         }
1799                     }
1800
1801                     if (!obj) return '';
1802
1803                     var cls = obj.classname;
1804                     if (cls && (class_obj = egCore.idl.classes[cls])) {
1805                         idl_field = class_obj.field_map[step];
1806                         obj = obj[step] ? obj[step]() : '';
1807                     } else {
1808                         if (angular.isFunction(obj[step])) {
1809                             obj = obj[step]();
1810                         } else {
1811                             obj = obj[step];
1812                         }
1813                     }
1814                 });
1815
1816                 // We found a nested IDL object which may or may not have 
1817                 // been configured as a top-level column.  Grab the datatype.
1818                 if (idl_field && !column.datatype) 
1819                     column.datatype = idl_field.datatype;
1820
1821                 if (obj === null || obj === undefined || obj === '') return '';
1822                 return obj;
1823             }
1824         }
1825
1826         return {
1827             instance : function(args) {
1828                 return new GridDataProvider(args);
1829             }
1830         };
1831     }
1832 ])
1833
1834
1835 // Factory service for egGridDataManager instances, which are
1836 // responsible for collecting flattened grid data.
1837 .factory('egGridFlatDataProvider', 
1838            ['$q','egCore','egGridDataProvider',
1839     function($q , egCore , egGridDataProvider) {
1840
1841         return {
1842             instance : function(args) {
1843                 var provider = egGridDataProvider.instance(args);
1844
1845                 provider.get = function(offset, count) {
1846
1847                     // no query means no call
1848                     if (!provider.query || 
1849                             angular.equals(provider.query, {})) 
1850                         return $q.when();
1851
1852                     // find all of the currently visible columns
1853                     var queryFields = {}
1854                     angular.forEach(provider.columnsProvider.columns, 
1855                         function(col) {
1856                             // only query IDL-tracked columns
1857                             if (!col.adhoc && (col.required || col.visible))
1858                                 queryFields[col.name] = col.path;
1859                         }
1860                     );
1861
1862                     return egCore.net.request(
1863                         'open-ils.fielder',
1864                         'open-ils.fielder.flattened_search',
1865                         egCore.auth.token(), provider.idlClass, 
1866                         queryFields, provider.query,
1867                         {   sort : provider.sort,
1868                             limit : count,
1869                             offset : offset
1870                         }
1871                     );
1872                 }
1873                 //provider.itemFieldValue = provider.flatItemFieldValue;
1874                 return provider;
1875             }
1876         };
1877     }
1878 ])
1879
1880 .directive('egGridColumnDragSource', function() {
1881     return {
1882         restrict : 'A',
1883         require : '^egGrid',
1884         link : function(scope, element, attrs, egGridCtrl) {
1885             angular.element(element).attr('draggable', 'true');
1886
1887             element.bind('dragstart', function(e) {
1888                 egGridCtrl.dragColumn = attrs.column;
1889                 egGridCtrl.dragType = attrs.dragType || 'move'; // or resize
1890                 egGridCtrl.colResizeDir = 0;
1891
1892                 if (egGridCtrl.dragType == 'move') {
1893                     // style the column getting moved
1894                     angular.element(e.target).addClass(
1895                         'eg-grid-column-move-handle-active');
1896                 }
1897             });
1898
1899             element.bind('dragend', function(e) {
1900                 if (egGridCtrl.dragType == 'move') {
1901                     angular.element(e.target).removeClass(
1902                         'eg-grid-column-move-handle-active');
1903                 }
1904             });
1905         }
1906     };
1907 })
1908
1909 .directive('egGridColumnDragDest', function() {
1910     return {
1911         restrict : 'A',
1912         require : '^egGrid',
1913         link : function(scope, element, attrs, egGridCtrl) {
1914
1915             element.bind('dragover', function(e) { // required for drop
1916                 e.stopPropagation();
1917                 e.preventDefault();
1918                 e.dataTransfer.dropEffect = 'move';
1919
1920                 if (egGridCtrl.colResizeDir == 0) return; // move
1921
1922                 var cols = egGridCtrl.columnsProvider;
1923                 var srcCol = egGridCtrl.dragColumn;
1924                 var srcColIdx = cols.indexOf(srcCol);
1925
1926                 if (egGridCtrl.colResizeDir == -1) {
1927                     if (cols.indexOf(attrs.column) <= srcColIdx) {
1928                         egGridCtrl.modifyColumnFlex(
1929                             egGridCtrl.columnsProvider.findColumn(
1930                                 egGridCtrl.dragColumn), -1);
1931                         if (cols.columns[srcColIdx+1]) {
1932                             // source column shrinks by one, column to the
1933                             // right grows by one.
1934                             egGridCtrl.modifyColumnFlex(
1935                                 cols.columns[srcColIdx+1], 1);
1936                         }
1937                         scope.$apply();
1938                     }
1939                 } else {
1940                     if (cols.indexOf(attrs.column) > srcColIdx) {
1941                         egGridCtrl.modifyColumnFlex( 
1942                             egGridCtrl.columnsProvider.findColumn(
1943                                 egGridCtrl.dragColumn), 1);
1944                         if (cols.columns[srcColIdx+1]) {
1945                             // source column grows by one, column to the 
1946                             // right grows by one.
1947                             egGridCtrl.modifyColumnFlex(
1948                                 cols.columns[srcColIdx+1], -1);
1949                         }
1950
1951                         scope.$apply();
1952                     }
1953                 }
1954             });
1955
1956             element.bind('dragenter', function(e) {
1957                 e.stopPropagation();
1958                 e.preventDefault();
1959                 if (egGridCtrl.dragType == 'move') {
1960                     angular.element(e.target).addClass('eg-grid-col-hover');
1961                 } else {
1962                     // resize grips are on the right side of each column.
1963                     // dragenter will either occur on the source column 
1964                     // (dragging left) or the column to the right.
1965                     if (egGridCtrl.colResizeDir == 0) {
1966                         if (egGridCtrl.dragColumn == attrs.column) {
1967                             egGridCtrl.colResizeDir = -1; // west
1968                         } else {
1969                             egGridCtrl.colResizeDir = 1; // east
1970                         }
1971                     }
1972                 }
1973             });
1974
1975             element.bind('dragleave', function(e) {
1976                 e.stopPropagation();
1977                 e.preventDefault();
1978                 if (egGridCtrl.dragType == 'move') {
1979                     angular.element(e.target).removeClass('eg-grid-col-hover');
1980                 }
1981             });
1982
1983             element.bind('drop', function(e) {
1984                 e.stopPropagation();
1985                 e.preventDefault();
1986                 egGridCtrl.colResizeDir = 0;
1987                 if (egGridCtrl.dragType == 'move') {
1988                     angular.element(e.target).removeClass('eg-grid-col-hover');
1989                     egGridCtrl.onColumnDrop(attrs.column); // move the column
1990                 }
1991             });
1992         }
1993     };
1994 })
1995  
1996 .directive('egGridMenuItem', function() {
1997     return {
1998         restrict : 'AE',
1999         require : '^egGrid',
2000         scope : {
2001             label : '@',  
2002             checkbox : '@',  
2003             checked : '=',  
2004             standalone : '=',  
2005             handler : '=', // onclick handler function
2006             divider : '=', // if true, show a divider only
2007             handlerData : '=', // if set, passed as second argument to handler
2008             disabled : '=', // function
2009             hidden : '=' // function
2010         },
2011         link : function(scope, element, attrs, egGridCtrl) {
2012             egGridCtrl.addMenuItem({
2013                 checkbox : scope.checkbox,
2014                 checked : scope.checked ? true : false,
2015                 label : scope.label,
2016                 standalone : scope.standalone ? true : false,
2017                 handler : scope.handler,
2018                 divider : scope.divider,
2019                 disabled : scope.disabled,
2020                 hidden : scope.hidden,
2021                 handlerData : scope.handlerData
2022             });
2023             scope.$destroy();
2024         }
2025     };
2026 })
2027
2028
2029
2030 /**
2031  * Translates bare IDL object values into display values.
2032  * 1. Passes dates through the angular date filter
2033  * 2. Translates bools to Booleans so the browser can display translated 
2034  *    value.  (Though we could manually translate instead..)
2035  * Others likely to follow...
2036  */
2037 .filter('egGridValueFilter', ['$filter','egCore', function($filter,egCore) {
2038     function traversePath(obj,path) {
2039         var list = path.split('.');
2040         for (var part in path) {
2041             if (obj[path]) obj = obj[path]
2042             else return null;
2043         }
2044         return obj;
2045     }
2046
2047     var GVF = function(value, column, item) {
2048         switch(column.datatype) {
2049             case 'bool':
2050                 switch(value) {
2051                     // Browser will translate true/false for us
2052                     case 't' : 
2053                     case '1' :  // legacy
2054                     case true:
2055                         return ''+true;
2056                     case 'f' : 
2057                     case '0' :  // legacy
2058                     case false:
2059                         return ''+false;
2060                     // value may be null,  '', etc.
2061                     default : return '';
2062                 }
2063             case 'timestamp':
2064                 var interval = angular.isFunction(item[column.dateonlyinterval])
2065                     ? item[column.dateonlyinterval]()
2066                     : item[column.dateonlyinterval];
2067
2068                 if (column.dateonlyinterval && !interval) // try it as a dotted path
2069                     interval = traversePath(item, column.dateonlyinterval);
2070
2071                 var context = angular.isFunction(item[column.datecontext])
2072                     ? item[column.datecontext]()
2073                     : item[column.datecontext];
2074
2075                 if (column.datecontext && !context) // try it as a dotted path
2076                     context = traversePath(item, column.datecontext);
2077
2078                 var date_filter = column.datefilter || 'egOrgDateInContext';
2079
2080                 return $filter(date_filter)(value, column.dateformat, context, interval);
2081             case 'money':
2082                 return $filter('currency')(value);
2083             default:
2084                 return value;
2085         }
2086     };
2087
2088     GVF.$stateful = true;
2089     return GVF;
2090 }]);
2091