Open-ILS/web/js/dojo/openils/widget/AutoFieldWidget.js

   1 if(!dojo._hasResource['openils.widget.AutoFieldWidget']) {
   2     dojo.provide('openils.widget.AutoFieldWidget');
   3     dojo.require('openils.Util');
   4     dojo.require('openils.User');
   5     dojo.require('fieldmapper.IDL');
   6
   7     dojo.declare('openils.widget.AutoFieldWidget', null, {
   8
   9         async : false,
  10         cache : {},
  11         cacheSingle : {},
  12
  13         /**
  14          * args:
  15          *  idlField -- Field description object from fieldmapper.IDL.fmclasses
  16          *  fmObject -- If available, the object being edited.  This will be used
  17          *      to set the value of the widget.
  18          *  fmClass -- Class name (not required if idlField or fmObject is set)
  19          *  fmField -- Field name (not required if idlField)
  20          *  parentNode -- If defined, the widget will be appended to this DOM node
  21          *  dijitArgs -- Optional parameters object, passed directly to the dojo widget
  22          *  orgLimitPerms -- If this field defines a set of org units and an orgLimitPerms
  23          *      is defined, the code will limit the org units in the set to those
  24          *      allowed by the permission
  25          */
  26         constructor : function(args) {
  27             for(var k in args)
  28                 this[k] = args[k];
  29
  30             // find the field description in the IDL if not provided
  31             if(this.fmObject)
  32                 this.fmClass = this.fmObject.classname;
  33             this.fmIDL = fieldmapper.IDL.fmclasses[this.fmClass];
  34
  35             if(!this.idlField) {
  36                 this.fmIDL = fieldmapper.IDL.fmclasses[this.fmClass];
  37                 var fields = this.fmIDL.fields;
  38                 for(var f in fields)
  39                     if(fields[f].name == this.fmField)
  40                         this.idlField = fields[f];
  41             }
  42
  43             if(!this.idlField)
  44                 throw new Error("AutoFieldWidget could not determine which field to render.  We need more information.");
  45
  46             this.auth = openils.User.authtoken;
  47             if(!this.cache[this.auth]) {
  48                 this.cache[this.auth] = {};
  49             }
  50         },
  51
  52         /**
  53          * Turn the widget-stored value into a value oils understands
  54          */
  55         getFormattedValue : function() {
  56             var value = this.baseWidgetValue();
  57             switch(this.idlField.datatype) {
  58                 case 'bool':
  59                     return (value) ? 't' : 'f'
  60                 case 'timestamp':
  61                     return dojo.date.stamp.toISOString(value);
  62                 case 'int':
  63                 case 'float':
  64                     if(isNaN(value)) value = 0;
  65                 default:
  66                     return (value === '') ? null : value;
  67             }
  68         },
  69
  70         baseWidgetValue : function(value) {
  71             var attr = (this.readOnly) ? 'content' : 'value';
  72             if(arguments.length) this.widget.attr(attr, value);
  73             return this.widget.attr(attr);
  74         },
  75
  76         /**
  77          * Turn the widget-stored value into something visually suitable
  78          */
  79         getDisplayString : function() {
  80             var value = this.widgetValue;
  81             switch(this.idlField.datatype) {
  82                 case 'bool':
  83                     return (value) ? 'True' : 'False'; // XXX i18n!
  84                 case 'timestamp':
  85                     dojo.require('dojo.date.locale');
  86                     dojo.require('dojo.date.stamp');
  87                     var date = dojo.date.stamp.fromISOString(value);
  88                     return dojo.date.locale.format(date, {formatLength:'short'});
  89                 case 'org_unit':
  90                     if(value === null || value === undefined) return '';
  91                     return fieldmapper.aou.findOrgUnit(value).shortname();
  92                 case 'int':
  93                 case 'float':
  94                     if(isNaN(value)) value = 0;
  95                 default:
  96                     if(value === undefined || value === null)
  97                         value = '';
  98                     return value+'';
  99             }
 100         },
 101
 102         build : function(onload) {
 103
 104             if(this.widget) {
 105                 // core widget provided for us, attach and move on
 106                 if(this.parentNode) // may already be in the "right" place
 107                     this.parentNode.appendChild(this.widget.domNode);
 108                 return;
 109             }
 110
 111             if(!this.parentNode) // give it somewhere to live so that dojo won't complain
 112                 this.parentNode = document.createElement('div');
 113
 114             this.onload = onload;
 115             if(this.widgetValue == null)
 116                 this.widgetValue = (this.fmObject) ? this.fmObject[this.idlField.name]() : null;
 117
 118             if(this.readOnly) {
 119                 dojo.require('dijit.layout.ContentPane');
 120                 this.widget = new dijit.layout.ContentPane(this.dijitArgs, this.parentNode);
 121                 if(this.widgetValue !== null)
 122                     this._tryLinkedDisplayField();
 123
 124             } else if(this.widgetClass) {
 125                 dojo.require(this.widgetClass);
 126                 eval('this.widget = new ' + this.widgetClass + '(this.dijitArgs, this.parentNode);');
 127
 128             } else {
 129
 130                 switch(this.idlField.datatype) {
 131
 132                     case 'id':
 133                         dojo.require('dijit.form.TextBox');
 134                         this.widget = new dijit.form.TextBox(this.dijitArgs, this.parentNode);
 135                         break;
 136
 137                     case 'org_unit':
 138                         this._buildOrgSelector();
 139                         break;
 140
 141                     case 'money':
 142                         dojo.require('dijit.form.CurrencyTextBox');
 143                         this.widget = new dijit.form.CurrencyTextBox(this.dijitArgs, this.parentNode);
 144                         break;
 145
 146                     case 'int':
 147                         dojo.require('dijit.form.NumberTextBox');
 148                         this.dijitArgs = dojo.mixin(this.dijitArgs || {}, {constraints:{places:0}});
 149                         this.widget = new dijit.form.NumberTextBox(this.dijitArgs, this.parentNode);
 150                         break;
 151
 152                     case 'float':
 153                         dojo.require('dijit.form.NumberTextBox');
 154                         this.widget = new dijit.form.NumberTextBox(this.dijitArgs, this.parentNode);
 155                         break;
 156
 157                     case 'timestamp':
 158                         dojo.require('dijit.form.DateTextBox');
 159                         dojo.require('dojo.date.stamp');
 160                         this.widget = new dijit.form.DateTextBox(this.dijitArgs, this.parentNode);
 161                         if(this.widgetValue != null)
 162                             this.widgetValue = dojo.date.stamp.fromISOString(this.widgetValue);
 163                         break;
 164
 165                     case 'bool':
 166                         dojo.require('dijit.form.CheckBox');
 167                         this.widget = new dijit.form.CheckBox(this.dijitArgs, this.parentNode);
 168                         this.widgetValue = openils.Util.isTrue(this.widgetValue);
 169                         break;
 170
 171                     case 'link':
 172                         if(this._buildLinkSelector()) break;
 173
 174                     default:
 175                         dojo.require('dijit.form.TextBox');
 176                         this.widget = new dijit.form.TextBox(this.dijitArgs, this.parentNode);
 177                 }
 178             }
 179
 180             if(!this.async) this._widgetLoaded();
 181             return this.widget;
 182         },
 183
 184         // we want to display the value for our widget.  However, instead of displaying
 185         // an ID, for exmaple, display the value for the 'selector' field on the object
 186         // the ID points to
 187         _tryLinkedDisplayField : function(noAsync) {
 188
 189             if(this.idlField.datatype == 'org_unit')
 190                 return false; // we already handle org_units, no need to re-fetch
 191
 192             var linkInfo = this._getLinkSelector();
 193             if(!(linkInfo && linkInfo.vfield && linkInfo.vfield.selector))
 194                 return false;
 195             var lclass = linkInfo.linkClass;
 196
 197             if(lclass == 'aou') {
 198                 this.widgetValue = fieldmapper.aou.findOrgUnit(this.widgetValue).shortname();
 199                 return;
 200             }
 201
 202             // first try the store cache
 203             var self = this;
 204             if(this.cache[this.auth][lclass]) {
 205                 var store = this.cache[this.auth][lclass];
 206                 var query = {};
 207                 query[linkInfo.vfield.name] = ''+this.widgetValue;
 208                 store.fetch({query:query, onComplete:
 209                     function(list) {
 210                         self.widgetValue = store.getValue(list[0], linkInfo.vfield.selector);
 211                     }
 212                 });
 213                 return;
 214             }
 215
 216             // then try the single object cache
 217             if(this.cacheSingle[lclass] && this.cacheSingle[lclass][this.widgetValue]) {
 218                 this.widgetValue = this.cacheSingle[lclass][this.widgetValue];
 219                 return;
 220             }
 221
 222             // if those fail, fetch the linked object
 223             dojo.require('openils.PermaCrud');
 224             this.async = true;
 225             var self = this;
 226             new openils.PermaCrud().retrieve(lclass, this.widgetValue, {
 227                 async : !this.forceSync,
 228                 oncomplete : function(r) {
 229                     var item = openils.Util.readResponse(r);
 230                     if(!self.cacheSingle[lclass])
 231                         self.cacheSingle[lclass] = {};
 232                     self.widgetValue = item[linkInfo.vfield.selector]();
 233                     self.cacheSingle[lclass][self.widgetValue] = item;
 234                     self.widget.startup();
 235                     self._widgetLoaded();
 236                 }
 237             });
 238         },
 239
 240         _getLinkSelector : function() {
 241             var linkClass = this.idlField['class'];
 242             if(this.idlField.reltype != 'has_a')  return false;
 243             if(!fieldmapper.IDL.fmclasses[linkClass].permacrud) return false;
 244             if(!fieldmapper.IDL.fmclasses[linkClass].permacrud.retrieve) return false;
 245
 246             var vfield;
 247             var rclassIdl = fieldmapper.IDL.fmclasses[linkClass];
 248
 249             for(var f in rclassIdl.fields) {
 250                 if(this.idlField.key == rclassIdl.fields[f].name) {
 251                     vfield = rclassIdl.fields[f];
 252                     break;
 253                 }
 254             }
 255
 256             if(!vfield)
 257                 throw new Error("'" + linkClass + "' has no '" + this.idlField.key + "' field!");
 258
 259             return {
 260                 linkClass : linkClass,
 261                 vfield : vfield
 262             };
 263         },
 264
 265         _buildLinkSelector : function() {
 266             var selectorInfo = this._getLinkSelector();
 267             if(!selectorInfo) return false;
 268
 269             var linkClass = selectorInfo.linkClass;
 270             var vfield = selectorInfo.vfield;
 271
 272             this.async = true;
 273
 274             if(linkClass == 'pgt')
 275                 return this._buildPermGrpSelector();
 276             if(linkClass == 'aou')
 277                 return this._buildOrgSelector();
 278             if(linkClass == 'acpl')
 279                 return this._buildCopyLocSelector();
 280
 281
 282             dojo.require('openils.PermaCrud');
 283             dojo.require('dojo.data.ItemFileReadStore');
 284             dojo.require('dijit.form.FilteringSelect');
 285
 286             this.widget = new dijit.form.FilteringSelect(this.dijitArgs, this.parentNode);
 287             this.widget.searchAttr = this.widget.labelAttr = vfield.selector || vfield.name;
 288             this.widget.valueAttr = vfield.name;
 289
 290             var self = this;
 291             var oncomplete = function(list) {
 292                 if(list) {
 293                     self.widget.store =
 294                         new dojo.data.ItemFileReadStore({data:fieldmapper[linkClass].toStoreData(list)});
 295                     self.cache[self.auth][linkClass] = self.widget.store;
 296                 } else {
 297                     self.widget.store = self.cache[self.auth][linkClass];
 298                 }
 299                 self.widget.startup();
 300                 self._widgetLoaded();
 301             };
 302
 303             if(this.cache[self.auth][linkClass]) {
 304                 oncomplete();
 305
 306             } else {
 307                 new openils.PermaCrud().retrieveAll(linkClass, {
 308                     async : !this.forceSync,
 309                     oncomplete : function(r) {
 310                         var list = openils.Util.readResponse(r, false, true);
 311                         oncomplete(list);
 312                     }
 313                 });
 314             }
 315
 316             return true;
 317         },
 318
 319         /**
 320          * For widgets that run asynchronously, provide a callback for finishing up
 321          */
 322         _widgetLoaded : function(value) {
 323             if(this.readOnly) {
 324                 this.baseWidgetValue(this.getDisplayString());
 325             } else {
 326                 this.baseWidgetValue(this.widgetValue);
 327                 if(this.idlField.name == this.fmIDL.pkey && this.fmIDL.pkey_sequence)
 328                     this.widget.attr('disabled', true);
 329                 if(this.disableWidgetTest && this.disableWidgetTest(this.idlField.name, this.fmObject))
 330                     this.widget.attr('disabled', true);
 331             }
 332             if(this.onload)
 333                 this.onload(this.widget, this);
 334         },
 335
 336         _buildOrgSelector : function() {
 337             dojo.require('fieldmapper.OrgUtils');
 338             dojo.require('openils.widget.FilteringTreeSelect');
 339             this.widget = new openils.widget.FilteringTreeSelect(this.dijitArgs, this.parentNode);
 340             this.widget.searchAttr = 'shortname';
 341             this.widget.labelAttr = 'shortname';
 342             this.widget.parentField = 'parent_ou';
 343             var user = new openils.User();
 344
 345             if(this.widgetValue == null)
 346                 this.widgetValue = user.user.ws_ou();
 347
 348             // if we have a limit perm, find the relevent orgs (async)
 349             if(this.orgLimitPerms && this.orgLimitPerms.length > 0) {
 350                 this.async = true;
 351                 var self = this;
 352                 user.getPermOrgList(this.orgLimitPerms,
 353                     function(orgList) {
 354                         self.widget.tree = orgList;
 355                         self.widget.startup();
 356                         self._widgetLoaded();
 357                     }
 358                 );
 359
 360             } else {
 361                 this.widget.tree = fieldmapper.aou.globalOrgTree;
 362                 this.widget.startup();
 363             }
 364         },
 365
 366         _buildPermGrpSelector : function() {
 367             dojo.require('openils.widget.FilteringTreeSelect');
 368             this.widget = new openils.widget.FilteringTreeSelect(this.dijitArgs, this.parentNode);
 369             this.widget.searchAttr = 'name';
 370
 371             if(this.cache.permGrpTree) {
 372                 this.widget.tree = this.cache.permGrpTree;
 373                 this.widget.startup();
 374                 return true;
 375             }
 376
 377             var self = this;
 378             this.async = true;
 379             new openils.PermaCrud().retrieveAll('pgt', {
 380                 async : !this.forceSync,
 381                 oncomplete : function(r) {
 382                     var list = openils.Util.readResponse(r, false, true);
 383                     if(!list) return;
 384                     var map = {};
 385                     var root = null;
 386                     for(var l in list)
 387                         map[list[l].id()] = list[l];
 388                     for(var l in list) {
 389                         var node = list[l];
 390                         var pnode = map[node.parent()];
 391                         if(!pnode) {root = node; continue;}
 392                         if(!pnode.children()) pnode.children([]);
 393                         pnode.children().push(node);
 394                     }
 395                     self.widget.tree = self.cache.permGrpTree = root;
 396                     self.widget.startup();
 397                     self._widgetLoaded();
 398                 }
 399             });
 400
 401             return true;
 402         },
 403
 404         _buildCopyLocSelector : function() {
 405             dojo.require('dijit.form.FilteringSelect');
 406             this.widget = new dijit.form.FilteringSelect(this.dijitArgs, this.parentNode);
 407             this.widget.searchAttr = this.widget.labalAttr = 'name';
 408             this.widget.valueAttr = 'id';
 409
 410             if(this.cache.copyLocStore) {
 411                 this.widget.store = this.cache.copyLocStore;
 412                 this.widget.startup();
 413                 this.async = false;
 414                 return true;
 415             }
 416
 417             // my orgs
 418             var ws_ou = openils.User.user.ws_ou();
 419             var orgs = fieldmapper.aou.findOrgUnit(ws_ou).orgNodeTrail().map(function (i) { return i.id() });
 420             orgs = orgs.concat(fieldmapper.aou.descendantNodeList(ws_ou).map(function (i) { return i.id() }));
 421
 422             var self = this;
 423             new openils.PermaCrud().search('acpl', {owning_lib : orgs}, {
 424                 async : !this.forceSync,
 425                 oncomplete : function(r) {
 426                     var list = openils.Util.readResponse(r, false, true);
 427                     if(!list) return;
 428                     self.widget.store =
 429                         new dojo.data.ItemFileReadStore({data:fieldmapper.acpl.toStoreData(list)});
 430                     self.cache.copyLocStore = self.widget.store;
 431                     self.widget.startup();
 432                     self._widgetLoaded();
 433                 }
 434             });
 435
 436             return true;
 437         }
 438     });
 439 }
 440