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
  20 /* generate fieldmapper javascript classes.  This expects a global variable
  21         called 'fmclasses' to be fleshed with the classes we need to build */
  22
  23         function FMEX(message) { this.message = message; }
  24         FMEX.toString = function() { return "FieldmapperException: " + this.message + "\n"; }
  25
  26
  27         dojo._hasResource["fieldmapper.Fieldmapper"] = true;
  28         dojo.provide("fieldmapper.Fieldmapper");
  29         dojo.require("DojoSRF");
  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                 fm_classes : fmclasses,
  45
  46                 clone : function() {
  47                         var obj = new this.constructor();
  48
  49                         for( var i in this.a ) {
  50                                 var thing = this.a[i];
  51                                 if(thing == null) continue;
  52
  53                                 if( thing._isfieldmapper ) {
  54                                         obj.a[i] = thing.clone();
  55                                 } else {
  56
  57                                         if(instanceOf(thing, Array)) {
  58                                                 obj.a[i] = new Array();
  59
  60                                                 for( var j in thing ) {
  61
  62                                                         if( thing[j]._isfieldmapper )
  63                                                                 obj.a[i][j] = thing[j].clone();
  64                                                         else
  65                                                                 obj.a[i][j] = thing[j];
  66                                                 }
  67                                         } else {
  68                                                 obj.a[i] = thing;
  69                                         }
  70                                 }
  71                         }
  72                         return obj;
  73                 },
  74
  75                 isnew : function(n) { if(arguments.length == 1) this.a[0] =n; return this.a[0]; },
  76                 ischanged : function(n) { if(arguments.length == 1) this.a[1] =n; return this.a[1]; },
  77                 isdeleted : function(n) { if(arguments.length == 1) this.a[2] =n; return this.a[2]; }
  78         });
  79
  80         fieldmapper._request = function ( meth, staff, params ) {
  81                 var ses = OpenSRF.CachedClientSession( meth[0] );
  82                 if (!ses) return null;
  83
  84                 var result = null;
  85                 var args = {};
  86
  87                 if (dojo.isArray(params)) {
  88                         args.params = params;
  89                 } else {
  90
  91                         if (dojo.isObject(params)) {
  92                                 args = params;
  93                         } else {
  94                 args.params = [].splice.call(arguments, 1, arguments.length - 1);
  95                         }
  96
  97                 }
  98
  99         if (!args.async && !args.timeout) args.timeout = 10;
 100
 101         if(!args.onmethoderror) {
 102             args.onmethoderror = function(r, stat, stat_text) {
 103                 throw new Error('Method error: ' + r.stat + ' : ' + stat_text);
 104             }
 105         }
 106
 107         if(!args.ontransporterror) {
 108             args.ontransporterror = function(xreq) {
 109                 throw new Error('Transport error method='+args.method+', status=' + xreq.status);
 110             }
 111         }
 112
 113                 if (!args.onerror) {
 114                         args.onerror = function (r) {
 115                                 throw new Error('Request error encountered! ' + r);
 116                         }
 117                 }
 118
 119                 if (!args.oncomplete) {
 120                         args.oncomplete = function (r) {
 121                                 var x = r.recv();
 122                                 if (x) result = x.content();
 123                         }
 124                 }
 125
 126                 args.method = meth[1];
 127                 if (staff && meth[2]) args.method += '.staff';
 128
 129                 ses.request(args).send();
 130
 131                 return result;
 132         };
 133
 134         fieldmapper.standardRequest = function (meth, params) { return fieldmapper._request(meth, false, params) };
 135         fieldmapper.Fieldmapper.prototype.standardRequest = fieldmapper.standardRequest;
 136
 137         fieldmapper.staffRequest = function (meth, params) { return fieldmapper._request(meth, true, params) };
 138         fieldmapper.Fieldmapper.prototype.staffRequest = fieldmapper.staffRequest;
 139
 140     // if we were called by the IDL loader ...
 141     if ( fieldmapper.IDL && fieldmapper.IDL.loaded ) {
 142         for( var cl in fieldmapper.IDL.fmclasses ) {
 143                 dojo.provide( cl );
 144                 dojo.declare( cl , fieldmapper.Fieldmapper, {
 145                         constructor : function () {
 146                                 if (!this.a) this.a = [];
 147                                 this.classname = this.declaredClass;
 148                     this._fields = [];
 149                     this.structure = fieldmapper.IDL.fmclasses[this.classname]
 150
 151                     for (var f in fieldmapper.IDL.fmclasses[this.classname].fields) {
 152                         var field = fieldmapper.IDL.fmclasses[this.classname].fields[f];
 153                         var p = field.array_position;
 154                         if (p > 2) continue;
 155
 156                                         this._fields.push( field.name );
 157                                         this[field.name]=new Function('n', 'if(arguments.length==1)this.a['+p+']=n;return this.a['+p+'];');
 158                     }
 159                         }
 160                 });
 161                 fieldmapper[cl] = window[cl]; // alias into place
 162                 fieldmapper[cl].Identifier = fieldmapper.IDL.fmclasses[cl].pkey;
 163         }
 164
 165     // ... otherwise we need to get the oldschool fmall.js stuff, which will lack .structure
 166     } else {
 167         if (!fmclasses)
 168             dojo.require("fieldmapper.fmall", true);
 169
 170         for( var cl in fmclasses ) {
 171                 dojo.provide( cl );
 172                 dojo.declare( cl , fieldmapper.Fieldmapper, {
 173                         constructor : function () {
 174                                 if (!this.a) this.a = [];
 175                                 this.classname = this.declaredClass;
 176                                 this._fields = fmclasses[this.classname];
 177                                 for( var pos = 0; pos <  this._fields.length; pos++ ) {
 178                                         var p = parseInt(pos) + 3;
 179                                         var f = this._fields[pos];
 180                                         this[f]=new Function('n', 'if(arguments.length==1)this.a['+p+']=n;return this.a['+p+'];');
 181                                 }
 182                         }
 183                 });
 184                 fieldmapper[cl] = window[cl]; // alias into place
 185                 fieldmapper[cl].Identifier = 'id'; // alias into place
 186         }
 187
 188         fieldmapper.i18n_l.Identifier = 'code';
 189         fieldmapper.ccpbt.Identifier = 'code';
 190         fieldmapper.ccnbt.Identifier = 'code';
 191         fieldmapper.cbrebt.Identifier = 'code';
 192         fieldmapper.cubt.Identifier = 'code';
 193         fieldmapper.ccm.Identifier = 'code';
 194         fieldmapper.cvrfm.Identifier = 'code';
 195         fieldmapper.clm.Identifier = 'code';
 196         fieldmapper.cam.Identifier = 'code';
 197         fieldmapper.cifm.Identifier = 'code';
 198         fieldmapper.citm.Identifier = 'code';
 199         fieldmapper.cblvl.Identifier = 'code';
 200         fieldmapper.clfm.Identifier = 'code';
 201         fieldmapper.mous.Identifier = 'usr';
 202         fieldmapper.moucs.Identifier = 'usr';
 203         fieldmapper.mucs.Identifier = 'usr';
 204         fieldmapper.mus.Identifier = 'usr';
 205         fieldmapper.rxbt.Identifier = 'xact';
 206         fieldmapper.rxpt.Identifier = 'xact';
 207         fieldmapper.cxt.Identifier = 'name';
 208         fieldmapper.amtr.Identifier = 'matchpoint';
 209
 210     }
 211
 212         fieldmapper.OpenSRF = {};
 213
 214         /*      Methods are defined as [ service, method, have_staff ]
 215                 An optional 3rd component is when a method is followed by true, such methods
 216                 have a staff counterpart and should have ".staff" appended to the method
 217                 before the method is called when in XUL mode */
 218         fieldmapper.OpenSRF.methods = {
 219                 SEARCH_MRS : ['open-ils.search','open-ils.search.metabib.multiclass',true],
 220                 SEARCH_RS : ['open-ils.search','open-ils.search.biblio.multiclass',true],
 221                 SEARCH_MRS_QUERY : ['open-ils.search','open-ils.search.metabib.multiclass.query',true],
 222                 SEARCH_RS_QUERY : ['open-ils.search','open-ils.search.biblio.multiclass.query',true],
 223                 FETCH_SEARCH_RIDS : ['open-ils.search','open-ils.search.biblio.record.class.search',true],
 224                 FETCH_MRMODS : ['open-ils.search','open-ils.search.biblio.metarecord.mods_slim.retrieve'],
 225                 FETCH_MODS_FROM_COPY : ['open-ils.search','open-ils.search.biblio.mods_from_copy'],
 226                 FETCH_MR_COPY_COUNTS : ['open-ils.search','open-ils.search.biblio.metarecord.copy_count',true],
 227                 FETCH_RIDS : ['open-ils.search','open-ils.search.biblio.metarecord_to_records',true],
 228                 FETCH_RMODS : ['open-ils.search','open-ils.search.biblio.record.mods_slim.retrieve'],
 229                 FETCH_R_COPY_COUNTS : ['open-ils.search','open-ils.search.biblio.record.copy_count',true],
 230                 FETCH_FLESHED_USER : ['open-ils.actor','open-ils.actor.user.fleshed.retrieve'],
 231                 FETCH_SESSION : ['open-ils.auth','open-ils.auth.session.retrieve'],
 232                 LOGIN_INIT : ['open-ils.auth','open-ils.auth.authenticate.init'],
 233                 LOGIN_COMPLETE : ['open-ils.auth','open-ils.auth.authenticate.complete'],
 234                 LOGIN_DELETE : ['open-ils.auth','open-ils.auth.session.delete'],
 235                 FETCH_USER_PREFS : ['open-ils.actor','open-ils.actor.patron.settings.retrieve'],
 236                 UPDATE_USER_PREFS : ['open-ils.actor','open-ils.actor.patron.settings.update'],
 237                 FETCH_COPY_STATUSES : ['open-ils.search','open-ils.search.config.copy_status.retrieve.all'],
 238                 FETCH_COPY_COUNTS_SUMMARY : ['open-ils.search','open-ils.search.biblio.copy_counts.summary.retrieve'],
 239                 FETCH_MARC_HTML : ['open-ils.search','open-ils.search.biblio.record.html'],
 240                 FETCH_CHECKED_OUT_SUM : ['open-ils.actor','open-ils.actor.user.checked_out'],
 241                 FETCH_HOLDS : ['open-ils.circ','open-ils.circ.holds.retrieve'],
 242                 FETCH_FINES_SUMMARY : ['open-ils.actor','open-ils.actor.user.fines.summary'],
 243                 FETCH_TRANSACTIONS : ['open-ils.actor','open-ils.actor.user.transactions.have_charge.fleshed'],
 244                 FETCH_MONEY_BILLING : ['open-ils.circ','open-ils.circ.money.billing.retrieve.all'],
 245                 FETCH_CROSSREF : ['open-ils.search','open-ils.search.authority.crossref'],
 246                 FETCH_CROSSREF_BATCH : ['open-ils.search','open-ils.search.authority.crossref.batch'],
 247                 CREATE_HOLD : ['open-ils.circ','open-ils.circ.holds.create'],
 248                 CREATE_HOLD_OVERRIDE : ['open-ils.circ','open-ils.circ.holds.create.override'],
 249                 CANCEL_HOLD : ['open-ils.circ','open-ils.circ.hold.cancel'],
 250                 UPDATE_USERNAME : ['open-ils.actor','open-ils.actor.user.username.update'],
 251                 UPDATE_PASSWORD : ['open-ils.actor','open-ils.actor.user.password.update'],
 252                 UPDATE_EMAIL : ['open-ils.actor','open-ils.actor.user.email.update'],
 253                 RENEW_CIRC : ['open-ils.circ','open-ils.circ.renew'],
 254                 CHECK_SPELL : ['open-ils.search','open-ils.search.spellcheck'],
 255                 FETCH_REVIEWS : ['open-ils.search','open-ils.search.added_content.review.retrieve.all'],
 256                 FETCH_TOC : ['open-ils.search','open-ils.search.added_content.toc.retrieve'],
 257                 FETCH_ACONT_SUMMARY : ['open-ils.search','open-ils.search.added_content.summary.retrieve'],
 258                 FETCH_USER_BYBARCODE : ['open-ils.actor','open-ils.actor.user.fleshed.retrieve_by_barcode'],
 259                 FETCH_ADV_MARC_MRIDS : ['open-ils.search','open-ils.search.biblio.marc',true],
 260                 FETCH_ADV_ISBN_RIDS : ['open-ils.search','open-ils.search.biblio.isbn'],
 261                 FETCH_ADV_ISSN_RIDS : ['open-ils.search','open-ils.search.biblio.issn'],
 262                 FETCH_ADV_TCN_RIDS : ['open-ils.search','open-ils.search.biblio.tcn'],
 263                 FETCH_CNBROWSE : ['open-ils.search','open-ils.search.callnumber.browse'],
 264                 FETCH_CONTAINERS : ['open-ils.actor','open-ils.actor.container.retrieve_by_class'],
 265                 FETCH_CONTAINERS : ['open-ils.actor','open-ils.actor.container.retrieve_by_class'],
 266                 CREATE_CONTAINER : ['open-ils.actor','open-ils.actor.container.create'],
 267                 DELETE_CONTAINER : ['open-ils.actor','open-ils.actor.container.full_delete'],
 268                 CREATE_CONTAINER_ITEM : ['open-ils.actor','open-ils.actor.container.item.create'],
 269                 DELETE_CONTAINER_ITEM : ['open-ils.actor','open-ils.actor.container.item.delete'],
 270                 FLESH_CONTAINER : ['open-ils.actor','open-ils.actor.container.flesh'],
 271                 FLESH_PUBLIC_CONTAINER : ['open-ils.actor','open-ils.actor.container.public.flesh'],
 272                 UPDATE_CONTAINER : ['open-ils.actor','open-ils.actor.container.update'],
 273                 FETCH_COPY : ['open-ils.search','open-ils.search.asset.copy.retrieve'],
 274                 FETCH_FLESHED_COPY : ['open-ils.search','open-ils.search.asset.copy.fleshed2.retrieve'],
 275                 CHECK_HOLD_POSSIBLE : ['open-ils.circ','open-ils.circ.title_hold.is_possible'],
 276                 UPDATE_HOLD : ['open-ils.circ','open-ils.circ.hold.update'],
 277                 FETCH_COPIES_FROM_VOLUME : ['open-ils.search','open-ils.search.asset.copy.retrieve_by_cn_label',true],
 278                 FETCH_VOLUME_BY_INFO : ['open-ils.search','open-ils.search.call_number.retrieve_by_info'], /* XXX staff method? */
 279                 FETCH_VOLUME : ['open-ils.search','open-ils.search.asset.call_number.retrieve'],
 280                 FETCH_COPY_LOCATIONS : ['open-ils.circ','open-ils.circ.copy_location.retrieve.all'],
 281                 FETCH_COPY_NOTES : ['open-ils.circ','open-ils.circ.copy_note.retrieve.all'],
 282                 FETCH_COPY_STAT_CATS : ['open-ils.circ','open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy'],
 283                 FETCH_LIT_FORMS : ['open-ils.search','open-ils.search.biblio.lit_form_map.retrieve.all'],
 284                 FETCH_ITEM_FORMS : ['open-ils.search','open-ils.search.biblio.item_form_map.retrieve.all'],
 285                 FETCH_ITEM_TYPES : ['open-ils.search','open-ils.search.biblio.item_type_map.retrieve.all'],
 286                 FETCH_AUDIENCES : ['open-ils.search','open-ils.search.biblio.audience_map.retrieve.all'],
 287                 FETCH_HOLD_STATUS : ['open-ils.circ','open-ils.circ.hold.status.retrieve'],
 288                 FETCH_NON_CAT_CIRCS : ['open-ils.circ','open-ils.circ.open_non_cataloged_circulation.user'],
 289                 FETCH_NON_CAT_CIRC : ['open-ils.circ','open-ils.circ.non_cataloged_circulation.retrieve'],
 290                 FETCH_NON_CAT_TYPES : ['open-ils.circ','open-ils.circ.non_cat_types.retrieve.all'],
 291                 FETCH_BRE : ['open-ils.search','open-ils.search.biblio.record_entry.slim.retrieve'],
 292                 CHECK_USERNAME : ['open-ils.actor','open-ils.actor.username.exists'],
 293                 FETCH_CIRC_BY_ID : ['open-ils.circ','open-ils.circ.retrieve'],
 294                 FETCH_MR_DESCRIPTORS : ['open-ils.search','open-ils.search.metabib.record_to_descriptors'],
 295                 FETCH_HIGHEST_PERM_ORG : ['open-ils.actor','open-ils.actor.user.perm.highest_org.batch'],
 296                 FETCH_USER_NOTES : ['open-ils.actor','open-ils.actor.note.retrieve.all'],
 297                 FETCH_ORG_BY_SHORTNAME : ['open-ils.actor','open-ils.actor.org_unit.retrieve_by_shorname'],
 298                 FETCH_BIB_ID_BY_BARCODE : ['open-ils.search','open-ils.search.bib_id.by_barcode'],
 299                 FETCH_ORG_SETTING : ['open-ils.actor','open-ils.actor.ou_setting.ancestor_default']
 300         };
 301
 302 }
 303
 304
 305