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

   1 if(!dojo._hasResource["fieldmapper.IDL"]) {
   2     dojo.require("DojoSRF");
   3     dojo.provide("fieldmapper.IDL");
   4     dojo.declare('fieldmapper.IDL', null, {
   5
   6         _URL_PATH : '/reports/fm_IDL.xml', // XXX locale?
   7         // -- just need to set up xmlent and use '/reports/'+OpenSRF.locale+'/fm_IDL.xml'
   8         NS_REPORTS : 'http://open-ils.org/spec/opensrf/IDL/reporter/v1',
   9         NS_PERSIST : 'http://open-ils.org/spec/opensrf/IDL/persistence/v1',
  10         NS_OBJ : 'http://open-ils.org/spec/opensrf/IDL/objects/v1',
  11
  12         constructor : function(classlist) {
  13
  14             if(!fieldmapper.IDL.fmclasses || (classlist && classlist.length)) {
  15                 var idl_url = this._URL_PATH;
  16
  17                 if (classlist.length) {
  18                     idl_url += '?';
  19
  20                     for (var i = 0; i < classlist.length; i++) {
  21                         var trim_class = classlist[i];
  22                         if (!trim_class) continue;
  23
  24                         if (i > 0) idl_url += '&';
  25                         idl_url += 'class=' + trim_class;
  26                     }
  27
  28                     JSON2js.fallbackObjectifier = function (arg, key_name, val_name) {
  29                         fieldmapper.IDL.load([arg[key_name]]);
  30                         return decodeJS(arg);
  31                     }
  32
  33                 }
  34
  35                 var self = this;
  36                 dojo.xhrGet({
  37                     url : idl_url,
  38                     handleAs : 'xml',
  39                     sync : true,
  40                     timeout : 10000,
  41                     load : function (response) {
  42                         self._parse(response);
  43                         fieldmapper.IDL.loaded = true;
  44                     },
  45                     error : function (response) {
  46                         fieldmapper.IDL.loaded = false;
  47                         dojo.require('fieldmapper.fmall', true);
  48                     }
  49                 });
  50             }
  51
  52             dojo.require('fieldmapper.Fieldmapper');
  53
  54             if (classlist && classlist.length)
  55                 dojo.forEach( classlist, function (c) { fieldmapper.vivicateClass(c); } );
  56         },
  57
  58         _parse : function(xmlNode) {
  59             var classes = xmlNode.getElementsByTagName('class');
  60             if (!fieldmapper.IDL || !fieldmapper.IDL.fmclasses)
  61                 fieldmapper.IDL.fmclasses = {};
  62
  63             for(var i = 0; i < classes.length; i++) {
  64                 var node = classes[i];
  65                 var id = node.getAttribute('id');
  66                 var fields = node.getElementsByTagName('fields')[0];
  67                 window.fmclasses[id] = [];
  68
  69                 var fieldData = this._parseFields(node, id);
  70
  71                 var obj = {
  72                     fields  : fieldData.list,
  73                     field_map : fieldData.map,
  74                     name    : node.getAttribute('id'),
  75                     //table   : node.getAttributeNS(this.NS_PERSIST, 'tablename'),
  76                     //core    : node.getAttributeNS(this.NS_REPORTS, 'core'),
  77                     label   : node.getAttributeNS(this.NS_REPORTS, 'label'),
  78                     restrict_primary   : node.getAttributeNS(this.NS_PERSIST, 'restrict_primary'),
  79                     virtual : (node.getAttributeNS(this.NS_PERSIST, 'virtual') == 'true'),
  80                     pkey    : fields.getAttributeNS(this.NS_PERSIST, 'primary'),
  81                     pkey_sequence : fields.getAttributeNS(this.NS_PERSIST, 'sequence')
  82                 };
  83
  84                 var permacrud = node.getElementsByTagName('permacrud')[0];
  85                 if(permacrud) {
  86                     var actions = ['create', 'retrieve', 'update', 'delete'];
  87                     obj.permacrud = {};
  88                     for(var idx in actions) {
  89                         var action = actions[idx];
  90                         var pnode = permacrud.getElementsByTagName(action)[0];
  91                         if(pnode) {
  92                             var permString = pnode.getAttribute('permission');
  93                             var permList = null;
  94                             if(permString)
  95                                 permList = (permString.match(/ /)) ? permString.split(' ') : [permString];
  96
  97                             var contextString = pnode.getAttribute('context_field');
  98                             var contextList = null;
  99                             if(contextString)
 100                                 contextList = (contextString.match(/ /)) ? contextString.split(' ') : [contextString];
 101
 102                             obj.permacrud[action] = {
 103                                 perms : permList,
 104                                 localContextFields : contextList // need to add foreign context fields
 105                             }; // add more details as necessary
 106                         }
 107                     }
 108                 }
 109
 110                 obj.core = (obj.core == 'true');
 111                 obj.label = (obj.label) ? obj.label : obj.name;
 112                 fieldmapper.IDL.fmclasses[id] = obj;
 113             }
 114
 115         },
 116
 117         /* parses the links and fields portion of the IDL */
 118         _parseFields : function(node, classname) {
 119             var data = [];
 120             var map = {};
 121
 122             var fields = node.getElementsByTagName('fields')[0];
 123             fields = fields.getElementsByTagName('field');
 124
 125             var links = node.getElementsByTagName('links')[0];
 126             if( links ) links = links.getElementsByTagName('link');
 127             else links = [];
 128
 129
 130             var position = 0;
 131             for(var i = 0; i < fields.length; i++) {
 132                 var field = fields[i];
 133                 var name = field.getAttribute('name');
 134
 135                 if(name == 'isnew' || name == 'ischanged' || name == 'isdeleted')
 136                     continue;
 137
 138                 var obj = {
 139                     field : field,
 140                     name        : name,
 141                     label : field.getAttributeNS(this.NS_REPORTS,'label'),
 142                     datatype : field.getAttributeNS(this.NS_REPORTS,'datatype'),
 143                     primitive : field.getAttributeNS(this.NS_PERSIST,'primitive'),
 144                     selector : field.getAttributeNS(this.NS_REPORTS,'selector'),
 145                     array_position : position++,
 146                     type        : 'field',
 147                     virtual : (fields[i].getAttributeNS(this.NS_PERSIST, 'virtual') == 'true')
 148                 };
 149
 150                 obj.label = obj.label || obj.name;
 151                 obj.datatype = obj.datatype || 'text';
 152
 153                 window.fmclasses[classname].push(obj.name);
 154
 155                 var link = null;
 156                 for(var l = 0; l < links.length; l++) {
 157                     if(links[l].getAttribute('field') == name) {
 158                         link = links[l];
 159                         break;
 160                     }
 161                 }
 162
 163                 if(link) {
 164                     obj.type = 'link';
 165                     obj.key = link.getAttribute('key');
 166                     obj['class'] = link.getAttribute('class');
 167                     obj.reltype = link.getAttribute('reltype');
 168                 }
 169
 170                 data.push(obj);
 171                 map[obj.name] = obj;
 172             }
 173
 174             dojo.forEach(['isnew', 'ischanged', 'isdeleted'],
 175                 function(name) {
 176                     var obj = {
 177                         name : name,
 178                         array_position : position++,
 179                         type : 'field',
 180                         virtual : true
 181                     };
 182                     data.push(obj);
 183                     map[obj.name] = obj;
 184                 }
 185             );
 186
 187             return { list : data, map : map };
 188         }
 189
 190     });
 191
 192     window.fmclasses = {};
 193     fieldmapper.IDL.load = function (list) { if (!list) list = []; return new fieldmapper.IDL(list); };
 194     fieldmapper.IDL.loaded = false;
 195
 196 }
 197