2 # ---------------------------------------------------------------------------
3 # Copyright (C) 2008 Georgia Public Library Service / Equinox Software, Inc
4 # Mike Rylander <miker@esilibrary.com>
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.
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 # ---------------------------------------------------------------------------
18 if(!dojo._hasResource["fieldmapper.Fieldmapper"]){
19 dojo._hasResource["fieldmapper.Fieldmapper"] = true;
21 dojo.provide("fieldmapper.Fieldmapper");
22 dojo.require("DojoSRF");
25 /* generate fieldmapper javascript classes. This expects a global variable
26 called 'fmclasses' to be fleshed with the classes we need to build */
28 function FMEX(message) { this.message = message; }
29 FMEX.toString = function() { return "FieldmapperException: " + this.message + "\n"; };
31 dojo.declare( "fieldmapper.Fieldmapper", null, {
33 constructor : function (initArray) {
35 if (dojo.isArray(initArray)) {
43 _isfieldmapper : true,
46 var obj = new this.constructor();
48 for( var i in this.a ) {
49 var thing = this.a[i];
50 if(thing === null) continue;
52 if( thing._isfieldmapper ) {
53 obj.a[i] = thing.clone();
56 if(dojo.isArray(thing)) {
59 for( var j in thing ) {
61 if( thing[j]._isfieldmapper )
62 obj.a[i][j] = thing[j].clone();
64 obj.a[i][j] = thing[j];
74 RequiredField : function (f) {
76 if (fieldmapper.IDL && fieldmapper.IDL.loaded)
77 return this.Structure.fields[f].required;
81 ValidateField : function (f) {
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]());
92 toString : function() {
93 /* ever so slightly aid debugging */
95 return "[object fieldmapper." + this.classname + "]";
97 return Object.prototype.toString();
103 fieldmapper.vivicateClass = function (cl) {
105 dojo.declare( cl , fieldmapper.Fieldmapper, {
106 constructor : function () {
107 if (!this.a) this.a = [];
108 this.classname = this.declaredClass;
112 if (fieldmapper.IDL && fieldmapper.IDL.loaded) {
113 this.Structure = fieldmapper.IDL.fmclasses[this.classname];
115 for (f in fieldmapper.IDL.fmclasses[this.classname].fields) {
116 var field = fieldmapper.IDL.fmclasses[this.classname].fields[f];
117 p = field.array_position;
118 this._fields.push( field.name );
119 this[field.name]=new Function('n', 'if(arguments.length==1)this.a['+p+']=n;return this.a['+p+'];');
122 this._fields = fmclasses[this.classname];
124 for( var pos = 0; pos < this._fields.length; pos++ ) {
125 p = parseInt(pos, 10);
126 f = this._fields[pos];
127 this[f]=new Function('n', 'if(arguments.length==1)this.a['+p+']=n;return this.a['+p+'];');
134 fieldmapper[cl] = window[cl]; // alias into place
136 if (fieldmapper.IDL && fieldmapper.IDL.loaded)
137 fieldmapper[cl].Identifier = fieldmapper.IDL.fmclasses[cl].pkey;
139 fieldmapper[cl].prototype.fromStoreItem = _fromStoreItem;
140 fieldmapper[cl].toStoreData = _toStoreData;
141 fieldmapper[cl].toStoreItem = _toStoreItem;
142 fieldmapper[cl].prototype.toStoreItem = function ( args ) { return _toStoreItem(this, args); };
143 fieldmapper[cl].initStoreData = _initStoreData;
144 fieldmapper[cl].prototype.toHash = _toHash;
145 fieldmapper[cl].toHash = _toHash;
146 fieldmapper[cl].prototype.fromHash = _fromHash;
147 fieldmapper[cl].fromHash = _fromHash;
150 fieldmapper._request = function ( meth, staff, params ) {
151 var ses = OpenSRF.CachedClientSession( meth[0] );
152 if (!ses) return null;
157 if (dojo.isArray(params)) {
158 args.params = params;
161 if (dojo.isObject(params)) {
164 args.params = [].splice.call(arguments, 2, arguments.length - 2);
169 if (!args.async && !args.timeout) args.timeout = 10;
171 if(!args.onmethoderror) {
172 args.onmethoderror = function(r, stat, stat_text) {
173 throw new Error('Method error: ' + r.stat + ' : ' + stat_text);
177 if(!args.ontransporterror) {
178 args.ontransporterror = function(xreq) {
179 throw new Error('Transport error method='+args.method+', status=' + xreq.status);
184 args.onerror = function (r) {
185 throw new Error('Request error encountered! ' + r);
189 if (!args.oncomplete) {
190 args.oncomplete = function (r) {
192 if (x) result = x.content();
196 args.method = meth[1];
197 if (staff && meth[2]) args.method += '.staff';
199 ses.request(args).send();
204 fieldmapper.standardRequest = function (meth, params) { return fieldmapper._request(meth, false, params); };
205 fieldmapper.Fieldmapper.prototype.standardRequest = fieldmapper.standardRequest;
207 fieldmapper.staffRequest = function (meth, params) { return fieldmapper._request(meth, true, params); };
208 fieldmapper.Fieldmapper.prototype.staffRequest = fieldmapper.staffRequest;
210 fieldmapper.OpenSRF = {};
212 /* Methods are defined as [ service, method, have_staff ]
213 An optional 3rd component is when a method is followed by true, such methods
214 have a staff counterpart and should have ".staff" appended to the method
215 before the method is called when in XUL mode */
216 fieldmapper.OpenSRF.methods = {
217 FETCH_ORG_BY_SHORTNAME : ['open-ils.actor','open-ils.actor.org_unit.retrieve_by_shortname'],
218 FETCH_ORG_SETTING : ['open-ils.actor','open-ils.actor.ou_setting.ancestor_default'],
219 FETCH_ORG_SETTING_BATCH : ['open-ils.actor','open-ils.actor.ou_setting.ancestor_default.batch']
224 function _fromHash (_hash) {
225 for ( var i=0; i < this._fields.length; i++) {
226 if (_hash[this._fields[i]] != null)
227 this[this._fields[i]]( _hash[this._fields[i]] );
232 function _toHash (includeNulls, virtFields) {
235 for (i=0; i < this._fields.length; i++) {
236 if (includeNulls || this[this._fields[i]]() != null) {
237 if (this[this._fields[i]]() == null)
238 _hash[this._fields[i]] = null;
240 _hash[this._fields[i]] = '' + this[this._fields[i]]();
244 if (virtFields && virtFields.length > 0) {
245 for (i = 0; i < virtFields.length; i++) {
246 if (!_hash[virtFields[i]])
247 _hash[virtFields[i]] = null;
256 /** FROM dojoData **/
257 function _fromStoreItem (data) {
261 for (i = 0; this._ignore_fields && i < this._ignore_fields.length; i++)
262 this[this._ignore_fields[i]](null);
264 for (i = 0; this._fields && i < this._fields.length; i++) {
265 if (dojo.isArray( this[this._fields[i]]() ))
266 this[this._fields[i]]( this[this._fields[i]]()[0] );
271 function _initStoreData(label, params) {
272 if (!params) params = {};
273 if (!params.identifier) params.identifier = this.Identifier;
274 if (!label) label = params.label;
275 if (!label) label = params.identifier;
276 return { label : label, identifier : params.identifier, items : [] };
279 function _toStoreItem(fmObj, params) {
280 if (!params) params = {};
281 return fmObj.toHash(true, params.virtualFields);
284 function _toStoreData (list, label, params) {
285 if (!params) params = {};
286 var data = this.initStoreData(label, params);
289 for (i = 0; list && i < list.length; i++) data.items.push( list[i].toHash(true, params.virtualFields) );
291 if (params.children && params.parent) {
292 var _hash_list = data.items;
295 for (i = 0; _hash_list && i < _hash_list.length; i++) {
296 _find_root[_hash_list[i][params.identifier]] = _hash_list[i];
300 for (i = 0; _hash_list && i < _hash_list.length; i++) {
301 var obj = _hash_list[i];
302 obj[params.children] = [];
304 for (j = 0; _hash_list && j < _hash_list.length; j++) {
305 var kid = _hash_list[j];
306 if (kid[params.parent] == obj[params.identifier]) {
307 obj[params.children].push( { _reference : kid[params.identifier] } );
309 if (_find_root[kid[params.identifier]]) delete _find_root[kid[params.identifier]];
313 item_data.push( obj );
316 for (j in _find_root) {
317 _find_root[j]['_top'] = 'true';
318 if (!_find_root[j][params.parent])
319 _find_root[j]['_trueRoot'] = 'true';
322 data.items = item_data;
327 /** FROM dojoData **/
331 /** ! Begin code that executes on page load */
333 if (!window.fmclasses) dojo.require("fieldmapper.fmall", true);
334 for( var cl in fmclasses ) {
335 fieldmapper.vivicateClass(cl);
338 // if we were NOT called by the IDL loader ...
339 // XXX This is now deprecated in preference to fieldmapper.AutoIDL
340 if ( !(fieldmapper.IDL && fieldmapper.IDL.loaded) ) {
342 fieldmapper.cmsa.Identifier = 'alias';
343 fieldmapper.cmc.Identifier = 'name';
344 fieldmapper.i18n_l.Identifier = 'code';
345 fieldmapper.ccpbt.Identifier = 'code';
346 fieldmapper.ccnbt.Identifier = 'code';
347 fieldmapper.cbrebt.Identifier = 'code';
348 fieldmapper.cubt.Identifier = 'code';
349 fieldmapper.ccm.Identifier = 'code';
350 fieldmapper.cvrfm.Identifier = 'code';
351 fieldmapper.clm.Identifier = 'code';
352 fieldmapper.cam.Identifier = 'code';
353 fieldmapper.cifm.Identifier = 'code';
354 fieldmapper.citm.Identifier = 'code';
355 fieldmapper.cblvl.Identifier = 'code';
356 fieldmapper.clfm.Identifier = 'code';
357 fieldmapper.mous.Identifier = 'usr';
358 fieldmapper.moucs.Identifier = 'usr';
359 fieldmapper.mucs.Identifier = 'usr';
360 fieldmapper.mus.Identifier = 'usr';
361 fieldmapper.rxbt.Identifier = 'xact';
362 fieldmapper.rxpt.Identifier = 'xact';
363 fieldmapper.cxt.Identifier = 'name';
364 fieldmapper.amtr.Identifier = 'matchpoint';
365 fieldmapper.coust.Identifier = 'name';
370 /** FROM dojoData **/
371 /* set up some known class attributes */
372 if (fieldmapper.aou) fieldmapper.aou.prototype._ignore_fields = ['children'];
373 if (fieldmapper.aout) fieldmapper.aout.prototype._ignore_fields = ['children'];
374 if (fieldmapper.pgt) fieldmapper.pgt.prototype._ignore_fields = ['children'];
376 fieldmapper.aou.toStoreData = function (list, label) {
377 if (!label) label = 'shortname';
378 return _toStoreData.call(this, list, label, { 'parent' : 'parent_ou', 'children' : 'children' });
381 fieldmapper.aout.toStoreData = function (list, label) {
382 if (!label) label = 'name';
383 return _toStoreData.call(this, list, label, { 'parent' : 'parent', 'children' : 'children' });
386 fieldmapper.pgt.toStoreData = function (list, label) {
387 if (!label) label = 'name';
388 return _toStoreData.call(this, list, label, { 'parent' : 'parent', 'children' : 'children' });
390 /** FROM dojoData **/