Open-ILS/web/js/dojo/fieldmapper/Fieldmapper.js

   1 /*
   2 # ---------------------------------------------------------------------------
   3 # Copyright (C) 2008  Georgia Public Library Service / Equinox Software, Inc
   4 # Mike Rylander <miker@esilibrary.com>
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 # ---------------------------------------------------------------------------
  16 */
  17
  18 if(!dojo._hasResource["fieldmapper.Fieldmapper"]){
  19     dojo._hasResource["fieldmapper.Fieldmapper"] = true;
  20
  21     dojo.provide("fieldmapper.Fieldmapper");
  22     dojo.require("DojoSRF");
  23
  24
  25 /* generate fieldmapper javascript classes.  This expects a global variable
  26     called 'fmclasses' to be fleshed with the classes we need to build */
  27
  28     function FMEX(message) { this.message = message; }
  29     FMEX.toString = function() { return "FieldmapperException: " + this.message + "\n"; };
  30
  31     dojo.declare( "fieldmapper.Fieldmapper", null, {
  32
  33         constructor : function (initArray) {
  34             if (initArray) {
  35                 if (dojo.isArray(initArray)) {
  36                     this.a = initArray;
  37                 } else {
  38                     this.a = [];
  39                 }
  40             }
  41         },
  42
  43         _isfieldmapper : true,
  44
  45         clone : function() {
  46             var obj = new this.constructor();
  47
  48             for( var i in this.a ) {
  49                 var thing = this.a[i];
  50                 if(thing === null) continue;
  51
  52                 if( thing._isfieldmapper ) {
  53                     obj.a[i] = thing.clone();
  54                 } else {
  55
  56                     if(dojo.isArray(thing)) {
  57                         obj.a[i] = [];
  58
  59                         for( var j in thing ) {
  60
  61                             if( thing[j]._isfieldmapper )
  62                                 obj.a[i][j] = thing[j].clone();
  63                             else
  64                                 obj.a[i][j] = thing[j];
  65                         }
  66                     } else {
  67                         obj.a[i] = thing;
  68                     }
  69                 }
  70             }
  71             return obj;
  72         },
  73
  74         RequiredField : function (f) {
  75             if (!f) return;
  76             if (fieldmapper.IDL && fieldmapper.IDL.loaded)
  77                 return this.Structure.fields[f].required;
  78             return;
  79         },
  80
  81         ValidateField : function (f) {
  82             if (!f) return;
  83             if (fieldmapper.IDL && fieldmapper.IDL.loaded) {
  84                 if (this.Structure.fields[f] && this.Structure.fields[f].validate) {
  85                     return this.Structure.fields[f].validate.test(this[f]());
  86                 }
  87                 return true;
  88             }
  89             return;
  90         }
  91
  92     });
  93
  94
  95     fieldmapper.vivicateClass = function (cl) {
  96         dojo.provide( cl );
  97         dojo.declare( cl , fieldmapper.Fieldmapper, {
  98             constructor : function () {
  99                 if (!this.a) this.a = [];
 100                 this.classname = this.declaredClass;
 101                 this._fields = [];
 102
 103                 var p, f;
 104                 if (fieldmapper.IDL && fieldmapper.IDL.loaded) {
 105                     this.Structure = fieldmapper.IDL.fmclasses[this.classname];
 106
 107                     for (f in fieldmapper.IDL.fmclasses[this.classname].fields) {
 108                         var field = fieldmapper.IDL.fmclasses[this.classname].fields[f];
 109                         p = field.array_position;
 110                         this._fields.push( field.name );
 111                         this[field.name]=new Function('n', 'if(arguments.length==1)this.a['+p+']=n;return this.a['+p+'];');
 112                     }
 113                 } else {
 114                     this._fields = fmclasses[this.classname];
 115
 116                     for( var pos = 0; pos <  this._fields.length; pos++ ) {
 117                         p = parseInt(pos, 10);
 118                         f = this._fields[pos];
 119                         this[f]=new Function('n', 'if(arguments.length==1)this.a['+p+']=n;return this.a['+p+'];');
 120                     }
 121                 }
 122
 123             }
 124         });
 125
 126         fieldmapper[cl] = window[cl]; // alias into place
 127
 128         if (fieldmapper.IDL && fieldmapper.IDL.loaded)
 129             fieldmapper[cl].Identifier = fieldmapper.IDL.fmclasses[cl].pkey;
 130
 131         fieldmapper[cl].prototype.fromStoreItem = _fromStoreItem;
 132         fieldmapper[cl].toStoreData = _toStoreData;
 133         fieldmapper[cl].toStoreItem = _toStoreItem;
 134         fieldmapper[cl].prototype.toStoreItem = function ( args ) { return _toStoreItem(this, args); };
 135         fieldmapper[cl].initStoreData = _initStoreData;
 136         fieldmapper[cl].prototype.toHash = _toHash;
 137         fieldmapper[cl].toHash = _toHash;
 138         fieldmapper[cl].prototype.fromHash = _fromHash;
 139         fieldmapper[cl].fromHash = _fromHash;
 140     };
 141
 142     fieldmapper._request = function ( meth, staff, params ) {
 143         var ses = OpenSRF.CachedClientSession( meth[0] );
 144         if (!ses) return null;
 145
 146         var result = null;
 147         var args = {};
 148
 149         if (dojo.isArray(params)) {
 150             args.params = params;
 151         } else {
 152
 153             if (dojo.isObject(params)) {
 154                 args = params;
 155             } else {
 156                 args.params = [].splice.call(arguments, 2, arguments.length - 2);
 157             }
 158
 159         }
 160
 161         if (!args.async && !args.timeout) args.timeout = 10;
 162
 163         if(!args.onmethoderror) {
 164             args.onmethoderror = function(r, stat, stat_text) {
 165                 throw new Error('Method error: ' + r.stat + ' : ' + stat_text);
 166             };
 167             }
 168
 169         if(!args.ontransporterror) {
 170             args.ontransporterror = function(xreq) {
 171                 throw new Error('Transport error method='+args.method+', status=' + xreq.status);
 172             };
 173             }
 174
 175         if (!args.onerror) {
 176             args.onerror = function (r) {
 177                 throw new Error('Request error encountered! ' + r);
 178             };
 179             }
 180
 181         if (!args.oncomplete) {
 182             args.oncomplete = function (r) {
 183                 var x = r.recv();
 184                 if (x) result = x.content();
 185             };
 186             }
 187
 188         args.method = meth[1];
 189         if (staff && meth[2]) args.method += '.staff';
 190
 191         ses.request(args).send();
 192
 193         return result;
 194     };
 195
 196     fieldmapper.standardRequest = function (meth, params) { return fieldmapper._request(meth, false, params); };
 197     fieldmapper.Fieldmapper.prototype.standardRequest = fieldmapper.standardRequest;
 198
 199     fieldmapper.staffRequest = function (meth, params) { return fieldmapper._request(meth, true, params); };
 200     fieldmapper.Fieldmapper.prototype.staffRequest = fieldmapper.staffRequest;
 201
 202     fieldmapper.OpenSRF = {};
 203
 204     /*    Methods are defined as [ service, method, have_staff ]
 205         An optional 3rd component is when a method is followed by true, such methods
 206         have a staff counterpart and should have ".staff" appended to the method
 207         before the method is called when in XUL mode */
 208     fieldmapper.OpenSRF.methods = {
 209         FETCH_ORG_BY_SHORTNAME : ['open-ils.actor','open-ils.actor.org_unit.retrieve_by_shortname'],
 210         FETCH_ORG_SETTING : ['open-ils.actor','open-ils.actor.ou_setting.ancestor_default'],
 211         FETCH_ORG_SETTING_BATCH : ['open-ils.actor','open-ils.actor.ou_setting.ancestor_default.batch']
 212     };
 213
 214
 215     //** FROM HASH **/
 216     function _fromHash (_hash) {
 217         for ( var i=0; i < this._fields.length; i++) {
 218             if (_hash[this._fields[i]] !== null)
 219                 this[this._fields[i]]( _hash[this._fields[i]] );
 220         }
 221         return this;
 222     }
 223
 224     function _toHash (includeNulls, virtFields) {
 225         var _hash = {};
 226         var i;
 227         for (i=0; i < this._fields.length; i++) {
 228             if (includeNulls || this[this._fields[i]]() !== null) {
 229                 if (this[this._fields[i]]() === null)
 230                     _hash[this._fields[i]] = null;
 231                 else
 232                     _hash[this._fields[i]] = '' + this[this._fields[i]]();
 233             }
 234         }
 235
 236         if (virtFields && virtFields.length > 0) {
 237             for (i = 0; i < virtFields.length; i++) {
 238                 if (!_hash[virtFields[i]])
 239                     _hash[virtFields[i]] = null;
 240             }
 241         }
 242
 243         return _hash;
 244     }
 245     //** FROM HASH **/
 246
 247
 248     /** FROM dojoData **/
 249     function _fromStoreItem (data) {
 250         this.fromHash(data);
 251
 252         var i;
 253         for (i = 0; this._ignore_fields && i < this._ignore_fields.length; i++)
 254             this[this._ignore_fields[i]](null);
 255
 256         for (i = 0; this._fields && i < this._fields.length; i++) {
 257             if (dojo.isArray( this[this._fields[i]]() ))
 258                 this[this._fields[i]]( this[this._fields[i]]()[0] );
 259         }
 260         return this;
 261     }
 262
 263     function _initStoreData(label, params) {
 264         if (!params) params = {};
 265         if (!params.identifier) params.identifier = this.Identifier;
 266         if (!label) label = params.label;
 267         if (!label) label = params.identifier;
 268         return { label : label, identifier : params.identifier, items : [] };
 269     }
 270
 271     function _toStoreItem(fmObj, params) {
 272         if (!params) params = {};
 273         return fmObj.toHash(true, params.virtualFields);
 274     }
 275
 276     function _toStoreData (list, label, params) {
 277         if (!params) params = {};
 278         var data = this.initStoreData(label, params);
 279
 280         var i, j;
 281         for (i = 0; list && i < list.length; i++) data.items.push( list[i].toHash(true, params.virtualFields) );
 282
 283         if (params.children && params.parent) {
 284             var _hash_list = data.items;
 285
 286             var _find_root = {};
 287             for (i = 0; _hash_list && i < _hash_list.length; i++) {
 288                 _find_root[_hash_list[i][params.identifier]] = _hash_list[i];
 289             }
 290
 291             var item_data = [];
 292             for (i = 0; _hash_list && i < _hash_list.length; i++) {
 293                 var obj = _hash_list[i];
 294                 obj[params.children] = [];
 295
 296                 for (j = 0; _hash_list && j < _hash_list.length; j++) {
 297                     var kid = _hash_list[j];
 298                     if (kid[params.parent] == obj[params.identifier]) {
 299                         obj[params.children].push( { _reference : kid[params.identifier] } );
 300                         kid._iskid = true;
 301                         if (_find_root[kid[params.identifier]]) delete _find_root[kid[params.identifier]];
 302                     }
 303                 }
 304
 305                 item_data.push( obj );
 306             }
 307
 308             for (j in _find_root) {
 309                 _find_root[j]['_top'] = 'true';
 310                 if (!_find_root[j][params.parent])
 311                     _find_root[j]['_trueRoot'] = 'true';
 312             }
 313
 314             data.items = item_data;
 315         }
 316
 317         return data;
 318     }
 319     /** FROM dojoData **/
 320
 321
 322
 323     /** ! Begin code that executes on page load */
 324
 325     if (!window.fmclasses) dojo.require("fieldmapper.fmall", true);
 326     for( var cl in fmclasses ) {
 327         fieldmapper.vivicateClass(cl);
 328     }
 329
 330     // if we were NOT called by the IDL loader ...
 331     // XXX This is now deprecated in preference to fieldmapper.AutoIDL
 332     if ( !(fieldmapper.IDL && fieldmapper.IDL.loaded) ) {
 333
 334         fieldmapper.cmsa.Identifier = 'alias';
 335         fieldmapper.cmc.Identifier = 'name';
 336         fieldmapper.i18n_l.Identifier = 'code';
 337         fieldmapper.ccpbt.Identifier = 'code';
 338         fieldmapper.ccnbt.Identifier = 'code';
 339         fieldmapper.cbrebt.Identifier = 'code';
 340         fieldmapper.cubt.Identifier = 'code';
 341         fieldmapper.ccm.Identifier = 'code';
 342         fieldmapper.cvrfm.Identifier = 'code';
 343         fieldmapper.clm.Identifier = 'code';
 344         fieldmapper.cam.Identifier = 'code';
 345         fieldmapper.cifm.Identifier = 'code';
 346         fieldmapper.citm.Identifier = 'code';
 347         fieldmapper.cblvl.Identifier = 'code';
 348         fieldmapper.clfm.Identifier = 'code';
 349         fieldmapper.mous.Identifier = 'usr';
 350         fieldmapper.moucs.Identifier = 'usr';
 351         fieldmapper.mucs.Identifier = 'usr';
 352         fieldmapper.mus.Identifier = 'usr';
 353         fieldmapper.rxbt.Identifier = 'xact';
 354         fieldmapper.rxpt.Identifier = 'xact';
 355         fieldmapper.cxt.Identifier = 'name';
 356         fieldmapper.amtr.Identifier = 'matchpoint';
 357         fieldmapper.coust.Identifier = 'name';
 358
 359     }
 360
 361
 362     /** FROM dojoData **/
 363     /* set up some known class attributes */
 364     if (fieldmapper.aou) fieldmapper.aou.prototype._ignore_fields = ['children'];
 365     if (fieldmapper.aout) fieldmapper.aout.prototype._ignore_fields = ['children'];
 366     if (fieldmapper.pgt) fieldmapper.pgt.prototype._ignore_fields = ['children'];
 367
 368     fieldmapper.aou.toStoreData = function (list, label) {
 369         if (!label) label = 'shortname';
 370         return _toStoreData.call(this, list, label, { 'parent' : 'parent_ou', 'children' : 'children' });
 371     };
 372
 373     fieldmapper.aout.toStoreData = function (list, label) {
 374         if (!label) label = 'name';
 375         return _toStoreData.call(this, list, label, { 'parent' : 'parent', 'children' : 'children' });
 376     };
 377
 378     fieldmapper.pgt.toStoreData = function (list, label) {
 379         if (!label) label = 'name';
 380         return _toStoreData.call(this, list, label, { 'parent' : 'parent', 'children' : 'children' });
 381     };
 382     /** FROM dojoData **/
 383
 384
 385 }
 386
 387
 388