src/javascript/opensrf.js

   1 /* -----------------------------------------------------------------------
   2  * Copyright (C) 2008  Georgia Public Library Service
   3  * Bill Erickson <erickson@esilibrary.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  * ----------------------------------------------------------------------- */
  15
  16 /* session states */
  17 var OSRF_APP_SESSION_CONNECTED = 0;
  18 var OSRF_APP_SESSION_CONNECTING = 1;
  19 var OSRF_APP_SESSION_DISCONNECTED = 2;
  20
  21 /* types of transport layers */
  22 var OSRF_TRANSPORT_TYPE_XHR = 1;
  23 var OSRF_TRANSPORT_TYPE_XMPP = 2;
  24
  25 /* message types */
  26 var OSRF_MESSAGE_TYPE_REQUEST = 'REQUEST';
  27 var OSRF_MESSAGE_TYPE_STATUS = 'STATUS';
  28 var OSRF_MESSAGE_TYPE_RESULT = 'RESULT';
  29 var OSRF_MESSAGE_TYPE_CONNECT = 'CONNECT';
  30 var OSRF_MESSAGE_TYPE_DISCONNECT = 'DISCONNECT';
  31
  32 /* message statuses */
  33 var OSRF_STATUS_CONTINUE = 100;
  34 var OSRF_STATUS_OK = 200;
  35 var OSRF_STATUS_ACCEPTED = 202;
  36 var OSRF_STATUS_COMPLETE = 205;
  37 var OSRF_STATUS_REDIRECTED = 307;
  38 var OSRF_STATUS_BADREQUEST = 400;
  39 var OSRF_STATUS_UNAUTHORIZED = 401;
  40 var OSRF_STATUS_FORBIDDEN = 403;
  41 var OSRF_STATUS_NOTFOUND = 404;
  42 var OSRF_STATUS_NOTALLOWED = 405;
  43 var OSRF_STATUS_TIMEOUT = 408;
  44 var OSRF_STATUS_EXPFAILED = 417;
  45 var OSRF_STATUS_INTERNALSERVERERROR = 500;
  46 var OSRF_STATUS_NOTIMPLEMENTED = 501;
  47 var OSRF_STATUS_VERSIONNOTSUPPORTED = 505;
  48
  49 var OpenSRF = {};
  50 OpenSRF.locale = null;
  51
  52 /* makes cls a subclass of pcls */
  53 OpenSRF.set_subclass = function(cls, pcls) {
  54     var str = cls+'.prototype = new '+pcls+'();';
  55     str += cls+'.prototype.constructor = '+cls+';';
  56     str += cls+'.baseClass = '+pcls+'.prototype.constructor;';
  57     str += cls+'.prototype.super = '+pcls+'.prototype;';
  58     eval(str);
  59 }
  60
  61
  62 /* general session superclass */
  63 OpenSRF.Session = function() {
  64     this.remote_id = null;
  65     this.state = OSRF_APP_SESSION_DISCONNECTED;
  66 }
  67
  68 OpenSRF.Session.transport = OSRF_TRANSPORT_TYPE_XHR; /* default to XHR */
  69 OpenSRF.Session.cache = {};
  70 OpenSRF.Session.find_session = function(thread_trace) {
  71     return OpenSRF.Session.cache[thread_trace];
  72 }
  73 OpenSRF.Session.prototype.cleanup = function() {
  74     delete OpenSRF.Session.cache[this.thread];
  75 }
  76
  77 OpenSRF.Session.prototype.send = function(osrf_msg, args) {
  78     args = (args) ? args : {};
  79     switch(OpenSRF.Session.transport) {
  80         case OSRF_TRANSPORT_TYPE_XHR:
  81             return this.send_xhr(osrf_msg, args);
  82         case OSRF_TRANSPORT_TYPE_XMPP:
  83             return this.send_xmpp(osrf_msg, args);
  84     }
  85 }
  86
  87 OpenSRF.Session.prototype.send_xhr = function(osrf_msg, args) {
  88     args.thread = this.thread;
  89     args.rcpt = this.remote_id;
  90     args.rcpt_service = this.service;
  91     new OpenSRF.XHRequest(osrf_msg, args).send();
  92 }
  93
  94 OpenSRF.Session.prototype.send_xmpp = function(osrf_msg, args) {
  95     alert('xmpp transport not yet implemented');
  96 }
  97
  98
  99 /* client sessions make requests */
 100 OpenSRF.ClientSession = function(service) {
 101     this.service = service
 102     this.remote_id = null;
 103     this.locale = OpenSRF.locale || 'en-US';
 104     this.last_id = 0;
 105     this.thread = Math.random() + '' + new Date().getTime();
 106     this.requests = [];
 107     this.onconnect = null;
 108     OpenSRF.Session.cache[this.thread] = this;
 109 }
 110 OpenSRF.set_subclass('OpenSRF.ClientSession', 'OpenSRF.Session');
 111
 112
 113 OpenSRF.ClientSession.prototype.connect = function(args) {
 114     args = (args) ? args : {};
 115
 116     if(args.onconnect)
 117         this.onconnect = args.onconnect;
 118
 119     /* if no handler is provided, make this a synchronous call */
 120     if(!this.onconnect)
 121         this.timeout = (args.timeout) ? args.timeout : 5;
 122
 123     message = new osrfMessage({
 124         'threadTrace' : this.reqid,
 125         'type' : OSRF_MESSAGE_TYPE_CONNECT,
 126     });
 127
 128     this.send(message, {'timeout' : this.timeout});
 129
 130     if(this.onconnect || this.state == OSRF_APP_SESSION_CONNECTED)
 131         return true;
 132     return false;
 133 }
 134
 135 OpenSRF.ClientSession.prototype.disconnect = function(args) {
 136     this.send(
 137         new osrfMessage({
 138             'threadTrace' : this.reqid,
 139             'type' : OSRF_MESSAGE_TYPE_DISCONNECT,
 140         })
 141     );
 142 }
 143
 144
 145 OpenSRF.ClientSession.prototype.request = function(args) {
 146
 147     if(typeof args == 'string') {
 148         params = [];
 149         for(var i = 1; i < arguments.length; i++)
 150             params.push(arguments[i]);
 151
 152         args = {
 153             method : args,
 154             params : params
 155         };
 156     } else {
 157         if(typeof args == 'undefined')
 158             args = {};
 159     }
 160
 161     var req = new OpenSRF.Request(this, this.last_id++, args);
 162     this.requests.push(req);
 163     return req;
 164 }
 165
 166 OpenSRF.ClientSession.prototype.find_request = function(reqid) {
 167     for(var i = 0; i < this.requests.length; i++) {
 168         var req = this.requests[i];
 169         if(req.reqid == reqid)
 170             return req;
 171     }
 172     return null;
 173 }
 174
 175 OpenSRF.Request = function(session, reqid, args) {
 176     this.session = session;
 177     this.reqid = reqid;
 178
 179     /* callbacks */
 180     this.onresponse = args.onresponse;
 181     this.oncomplete = args.oncomplete;
 182     this.onerror = args.onerror;
 183     this.onmethoderror = args.onmethoderror;
 184     this.ontransporterror = args.ontransporterror;
 185
 186     this.method = args.method;
 187     this.params = args.params;
 188     this.timeout = args.timeout;
 189     this.response_queue = [];
 190     this.complete = false;
 191 }
 192
 193 OpenSRF.Request.prototype.recv = function(timeout) {
 194     if(this.response_queue.length > 0)
 195         return this.response_queue.shift();
 196     return null;
 197 }
 198
 199 OpenSRF.Request.prototype.send = function() {
 200     method = new osrfMethod({'method':this.method, 'params':this.params});
 201     message = new osrfMessage({
 202         'threadTrace' : this.reqid,
 203         'type' : OSRF_MESSAGE_TYPE_REQUEST,
 204         'payload' : method,
 205         'locale' : this.session.locale
 206     });
 207
 208     this.session.send(message, {
 209         'timeout' : this.timeout,
 210         'onresponse' : this.onresponse,
 211         'oncomplete' : this.oncomplete,
 212         'onerror' : this.onerror,
 213         'onmethoderror' : this.onmethoderror,
 214         'ontransporterror' : this.ontransporterror
 215     });
 216 }
 217
 218 OpenSRF.NetMessage = function(to, from, thread, body) {
 219     this.to = to;
 220     this.from = from;
 221     this.thread = thread;
 222     this.body = body;
 223 }
 224
 225 OpenSRF.Stack = function() {
 226 }
 227
 228 OpenSRF.Stack.push = function(net_msg, callbacks) {
 229     var ses = OpenSRF.Session.find_session(net_msg.thread);
 230     if(!ses) return;
 231     ses.remote_id = net_msg.sender;
 232     osrf_msgs = JSON2js(net_msg.body);
 233     for(var i = 0; i < osrf_msgs.length; i++)
 234         OpenSRF.Stack.handle_message(ses, osrf_msgs[i], callbacks);
 235 }
 236
 237 OpenSRF.Stack.handle_message = function(ses, osrf_msg, callbacks) {
 238
 239     var req = null;
 240
 241     if(osrf_msg.type() == OSRF_MESSAGE_TYPE_STATUS) {
 242
 243         var payload = osrf_msg.payload();
 244         var status = payload.statusCode();
 245         var status_text = payload.status();
 246
 247         if(status == OSRF_STATUS_COMPLETE) {
 248             req = ses.find_request(osrf_msg.threadTrace());
 249             if(req) {
 250                 req.complete = true;
 251                 if(callbacks.oncomplete && !req.oncomplete_called) {
 252                     req.oncomplete_called = true;
 253                     return callbacks.oncomplete(req);
 254                 }
 255             }
 256         }
 257
 258         if(status == OSRF_STATUS_OK) {
 259             ses.state = OSRF_APP_SESSION_CONNECTED;
 260
 261             /* call the connect callback */
 262             if(ses.onconnect && !ses.onconnect_called) {
 263                 ses.onconnect_called = true;
 264                 return ses.onconnect();
 265             }
 266         }
 267
 268         if(status == OSRF_STATUS_NOTFOUND) {
 269             req = ses.find_request(osrf_msg.threadTrace());
 270             if(callbacks.onmethoderror)
 271                 return callbacks.onmethoderror(req, status, status_text);
 272         }
 273     }
 274
 275     if(osrf_msg.type() == OSRF_MESSAGE_TYPE_RESULT) {
 276         req = ses.find_request(osrf_msg.threadTrace());
 277         if(req) {
 278             req.response_queue.push(osrf_msg.payload());
 279             if(callbacks.onresponse)
 280                 return callbacks.onresponse(req);
 281         }
 282     }
 283 }
 284
 285 /* The following classes map directly to network-serializable opensrf objects */
 286
 287 function osrfMessage(hash) {
 288     this.hash = hash;
 289     this._encodehash = true;
 290 }
 291 osrfMessage.prototype.threadTrace = function(d) {
 292     if(arguments.length == 1)
 293         this.hash.threadTrace = d;
 294     return this.hash.threadTrace;
 295 }
 296 osrfMessage.prototype.type = function(d) {
 297     if(arguments.length == 1)
 298         this.hash.type = d;
 299     return this.hash.type;
 300 }
 301 osrfMessage.prototype.payload = function(d) {
 302     if(arguments.length == 1)
 303         this.hash.payload = d;
 304     return this.hash.payload;
 305 }
 306 osrfMessage.prototype.locale = function(d) {
 307     if(arguments.length == 1)
 308         this.hash.locale = d;
 309     return this.hash.locale;
 310 }
 311 osrfMessage.prototype.serialize = function() {
 312     return {
 313         "__c":"osrfMessage",
 314         "__p": {
 315             'threadTrace' : this.hash.threadTrace,
 316             'type' : this.hash.type,
 317             'payload' : (this.hash.payload) ? this.hash.payload.serialize() : 'null',
 318             'locale' : this.hash.locale
 319         }
 320     };
 321 }
 322
 323 function osrfMethod(hash) {
 324     this.hash = hash;
 325     this._encodehash = true;
 326 }
 327 osrfMethod.prototype.method = function() {
 328     if(arguments.length == 1)
 329         this.hash.method = d;
 330     return this.hash.method;
 331 }
 332 osrfMethod.prototype.params = function() {
 333     if(arguments.length == 1)
 334         this.hash.params = d;
 335     return this.hash.params;
 336 }
 337 osrfMethod.prototype.serialize = function() {
 338     return {
 339         "__c":"osrfMethod",
 340         "__p": {
 341             'method' : this.hash.method,
 342             'params' : this.hash.params
 343         }
 344     };
 345 }
 346
 347 function osrfMethodException(hash) {
 348     this.hash = hash;
 349     this._encodehash = true;
 350 }
 351 osrfMethodException.prototype.status = function() {
 352     if(arguments.length == 1)
 353         this.hash.status = d;
 354     return this.hash.status;
 355 }
 356 osrfMethodException.prototype.statusCode = function() {
 357     if(arguments.length == 1)
 358         this.hash.statusCode = d;
 359     return this.hash.statusCode;
 360 }
 361 function osrfConnectStatus(hash) {
 362     this.hash = hash;
 363     this._encodehash = true;
 364 }
 365 osrfConnectStatus.prototype.status = function() {
 366     if(arguments.length == 1)
 367         this.hash.status = d;
 368     return this.hash.status;
 369 }
 370 osrfConnectStatus.prototype.statusCode = function() {
 371     if(arguments.length == 1)
 372         this.hash.statusCode = d;
 373     return this.hash.statusCode;
 374 }
 375 function osrfResult(hash) {
 376     this.hash = hash;
 377     this._encodehash = true;
 378 }
 379 osrfResult.prototype.status = function() {
 380     if(arguments.length == 1)
 381         this.hash.status = d;
 382     return this.hash.status;
 383 }
 384 osrfResult.prototype.statusCode = function() {
 385     if(arguments.length == 1)
 386         this.hash.statusCode = d;
 387     return this.hash.statusCode;
 388 }
 389 osrfResult.prototype.content = function() {
 390     if(arguments.length == 1)
 391         this.hash.content = d;
 392     return this.hash.content;
 393 }
 394
 395
 396