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 var OSRF_TRANSPORT_TYPE_WS = 3;
  25 var OSRF_TRANSPORT_TYPE_WS_SHARED = 4;
  26
  27 /* message types */
  28 var OSRF_MESSAGE_TYPE_REQUEST = 'REQUEST';
  29 var OSRF_MESSAGE_TYPE_STATUS = 'STATUS';
  30 var OSRF_MESSAGE_TYPE_RESULT = 'RESULT';
  31 var OSRF_MESSAGE_TYPE_CONNECT = 'CONNECT';
  32 var OSRF_MESSAGE_TYPE_DISCONNECT = 'DISCONNECT';
  33
  34 /* message statuses */
  35 var OSRF_STATUS_CONTINUE = 100;
  36 var OSRF_STATUS_OK = 200;
  37 var OSRF_STATUS_ACCEPTED = 202;
  38 var OSRF_STATUS_COMPLETE = 205;
  39 var OSRF_STATUS_REDIRECTED = 307;
  40 var OSRF_STATUS_BADREQUEST = 400;
  41 var OSRF_STATUS_UNAUTHORIZED = 401;
  42 var OSRF_STATUS_FORBIDDEN = 403;
  43 var OSRF_STATUS_NOTFOUND = 404;
  44 var OSRF_STATUS_NOTALLOWED = 405;
  45 var OSRF_STATUS_TIMEOUT = 408;
  46 var OSRF_STATUS_EXPFAILED = 417;
  47 var OSRF_STATUS_INTERNALSERVERERROR = 500;
  48 var OSRF_STATUS_NOTIMPLEMENTED = 501;
  49 var OSRF_STATUS_VERSIONNOTSUPPORTED = 505;
  50
  51 // TODO: get path from ./configure prefix
  52 var SHARED_WORKER_LIB = '/js/dojo/opensrf/opensrf_ws_shared.js';
  53
  54 /* The following classes map directly to network-serializable opensrf objects */
  55
  56 function osrfMessage(hash) {
  57     this.hash = hash;
  58     if(!this.hash.locale)
  59         this.hash.locale = OpenSRF.locale || 'en-US';
  60     this._encodehash = true;
  61 }
  62 osrfMessage.prototype.threadTrace = function(d) {
  63     if(arguments.length == 1)
  64         this.hash.threadTrace = d;
  65     return this.hash.threadTrace;
  66 };
  67 osrfMessage.prototype.type = function(d) {
  68     if(arguments.length == 1)
  69         this.hash.type = d;
  70     return this.hash.type;
  71 };
  72 osrfMessage.prototype.payload = function(d) {
  73     if(arguments.length == 1)
  74         this.hash.payload = d;
  75     return this.hash.payload;
  76 };
  77 osrfMessage.prototype.locale = function(d) {
  78     if(arguments.length == 1)
  79         this.hash.locale = d;
  80     return this.hash.locale;
  81 };
  82 osrfMessage.prototype.api_level = function(d) {
  83     if(arguments.length == 1)
  84         this.hash.api_level = d;
  85     return this.hash.api_level;
  86 };
  87 osrfMessage.prototype.serialize = function() {
  88     return {
  89         "__c":"osrfMessage",
  90         "__p": {
  91             'threadTrace' : this.hash.threadTrace,
  92             'type' : this.hash.type,
  93             'payload' : (this.hash.payload) ? this.hash.payload.serialize() : 'null',
  94             'locale' : this.hash.locale,
  95             'api_level' : this.hash.api_level
  96         }
  97     };
  98 };
  99
 100 function osrfMethod(hash) {
 101     this.hash = hash;
 102     this._encodehash = true;
 103 }
 104 osrfMethod.prototype.method = function(d) {
 105     if(arguments.length == 1)
 106         this.hash.method = d;
 107     return this.hash.method;
 108 };
 109 osrfMethod.prototype.params = function(d) {
 110     if(arguments.length == 1)
 111         this.hash.params = d;
 112     return this.hash.params;
 113 };
 114 osrfMethod.prototype.serialize = function() {
 115     return {
 116         "__c":"osrfMethod",
 117         "__p": {
 118             'method' : this.hash.method,
 119             'params' : this.hash.params
 120         }
 121     };
 122 };
 123
 124 function osrfMethodException(hash) {
 125     this.hash = hash;
 126     this._encodehash = true;
 127 }
 128 osrfMethodException.prototype.status = function(d) {
 129     if(arguments.length == 1)
 130         this.hash.status = d;
 131     return this.hash.status;
 132 };
 133 osrfMethodException.prototype.statusCode = function(d) {
 134     if(arguments.length == 1)
 135         this.hash.statusCode = d;
 136     return this.hash.statusCode;
 137 };
 138 function osrfConnectStatus(hash) {
 139     this.hash = hash;
 140     this._encodehash = true;
 141 }
 142 osrfConnectStatus.prototype.status = function(d) {
 143     if(arguments.length == 1)
 144         this.hash.status = d;
 145     return this.hash.status;
 146 };
 147 osrfConnectStatus.prototype.statusCode = function(d) {
 148     if(arguments.length == 1)
 149         this.hash.statusCode = d;
 150     return this.hash.statusCode;
 151 };
 152 function osrfResult(hash) {
 153     this.hash = hash;
 154     this._encodehash = true;
 155 }
 156 osrfResult.prototype.status = function(d) {
 157     if(arguments.length == 1)
 158         this.hash.status = d;
 159     return this.hash.status;
 160 };
 161 osrfResult.prototype.statusCode = function(d) {
 162     if(arguments.length == 1)
 163         this.hash.statusCode = d;
 164     return this.hash.statusCode;
 165 };
 166 osrfResult.prototype.content = function(d) {
 167     if(arguments.length == 1)
 168         this.hash.content = d;
 169     return this.hash.content;
 170 };
 171 function osrfServerError(hash) {
 172     this.hash = hash;
 173     this._encodehash = true;
 174 }
 175 osrfServerError.prototype.status = function(d) {
 176     if(arguments.length == 1)
 177         this.hash.status = d;
 178     return this.hash.status;
 179 };
 180 osrfServerError.prototype.statusCode = function(d) {
 181     if(arguments.length == 1)
 182         this.hash.statusCode = d;
 183     return this.hash.statusCode;
 184 };
 185 function osrfContinueStatus(hash) {
 186     this.hash = hash;
 187     this._encodehash = true;
 188 }
 189 osrfContinueStatus.prototype.status = function(d) {
 190     if(arguments.length == 1)
 191         this.hash.status = d;
 192     return this.hash.status;
 193 };
 194 osrfContinueStatus.prototype.statusCode = function(d) {
 195     if(arguments.length == 1)
 196         this.hash.statusCode = d;
 197     return this.hash.statusCode;
 198 };
 199
 200 OpenSRF = {};
 201 OpenSRF.locale = null;
 202 OpenSRF.api_level = 1;
 203
 204 /* makes cls a subclass of pcls */
 205 OpenSRF.set_subclass = function(cls, pcls) {
 206     var str = cls+'.prototype = new '+pcls+'();';
 207     str += cls+'.prototype.constructor = '+cls+';';
 208     str += cls+'.baseClass = '+pcls+'.prototype.constructor;';
 209     str += cls+'.prototype["super"] = '+pcls+'.prototype;';
 210     eval(str);
 211 };
 212
 213
 214 /* general session superclass */
 215 OpenSRF.Session = function() {
 216     this.remote_id = null;
 217     this.state = OSRF_APP_SESSION_DISCONNECTED;
 218 };
 219
 220 OpenSRF.Session.transport = OSRF_TRANSPORT_TYPE_XHR;
 221 OpenSRF.Session.cache = {};
 222
 223 OpenSRF.Session.find_session = function(thread_trace) {
 224     return OpenSRF.Session.cache[thread_trace];
 225 };
 226 OpenSRF.Session.prototype.cleanup = function() {
 227     delete OpenSRF.Session.cache[this.thread];
 228 };
 229
 230 OpenSRF.Session.prototype.send = function(osrf_msg, args) {
 231     args = (args) ? args : {};
 232     switch(OpenSRF.Session.transport) {
 233         case OSRF_TRANSPORT_TYPE_WS:
 234             return this.send_ws(osrf_msg);
 235         case OSRF_TRANSPORT_TYPE_WS_SHARED:
 236             return this.send_ws_shared(osrf_msg);
 237         case OSRF_TRANSPORT_TYPE_XHR:
 238             return this.send_xhr(osrf_msg, args);
 239         case OSRF_TRANSPORT_TYPE_XMPP:
 240             return this.send_xmpp(osrf_msg, args);
 241     }
 242 };
 243
 244 OpenSRF.Session.prototype.send_xhr = function(osrf_msg, args) {
 245     args.thread = this.thread;
 246     args.rcpt = this.remote_id;
 247     args.rcpt_service = this.service;
 248     new OpenSRF.XHRequest(osrf_msg, args).send();
 249 };
 250
 251 OpenSRF.Session.prototype.send_ws = function(osrf_msg) {
 252     new OpenSRF.WebSocketRequest(
 253         this,
 254         function(wsreq) {wsreq.send(osrf_msg)} // onopen
 255     );
 256 };
 257
 258 OpenSRF.Session.setup_shared_ws = function() {
 259     OpenSRF.sharedWSWorker = new SharedWorker(SHARED_WORKER_LIB);
 260
 261     OpenSRF.sharedWSWorker.port.addEventListener('message', function(e) {
 262         var data = e.data;
 263         console.debug('sharedWSWorker received message of type: ' + data.action);
 264
 265         if (data.action == 'message') {
 266             // pass all inbound message up the opensrf stack
 267
 268             var msg;
 269             try {
 270                 msg = JSON2js(data.message);
 271             } catch(E) {
 272                 console.error(
 273                     "Error parsing JSON in shared WS response: " + msg);
 274                 throw E;
 275             }
 276             OpenSRF.Stack.push(
 277                 new OpenSRF.NetMessage(
 278                    null, null, msg.thread, null, msg.osrf_msg)
 279             );
 280
 281             return;
 282         }
 283
 284         if (data.action == 'error') {
 285             throw new Error(data.message);
 286         }
 287     });
 288
 289     OpenSRF.sharedWSWorker.port.start();
 290 }
 291
 292 OpenSRF.Session.prototype.send_ws_shared = function(message) {
 293
 294     if (!OpenSRF.sharedWSWorker)
 295         OpenSRF.Session.setup_shared_ws();
 296
 297     var json = js2JSON({
 298         service : this.service,
 299         thread : this.thread,
 300         osrf_msg : [message.serialize()]
 301     });
 302
 303     OpenSRF.sharedWSWorker.port.postMessage({
 304         action : 'message',
 305         // pass the thread additionally as a stand-alone value so the
 306         // worker can more efficiently inspect it.
 307         thread : this.thread,
 308         message : json
 309     });
 310 }
 311
 312
 313 OpenSRF.Session.prototype.send_xmpp = function(osrf_msg, args) {
 314     alert('xmpp transport not implemented');
 315 };
 316
 317
 318 /* client sessions make requests */
 319 OpenSRF.ClientSession = function(service) {
 320     this.service = service;
 321     this.remote_id = null;
 322     this.locale = OpenSRF.locale || 'en-US';
 323     this.last_id = 0;
 324     this.requests = [];
 325     this.onconnect = null;
 326     this.thread = Math.random() + '' + new Date().getTime();
 327     OpenSRF.Session.cache[this.thread] = this;
 328 };
 329 OpenSRF.set_subclass('OpenSRF.ClientSession', 'OpenSRF.Session');
 330
 331
 332 OpenSRF.ClientSession.prototype.connect = function(args) {
 333     args = (args) ? args : {};
 334     this.remote_id = null;
 335
 336     if (this.state == OSRF_APP_SESSION_CONNECTED) {
 337         if (args.onconnect) args.onconnect();
 338         return true;
 339     }
 340
 341     if(args.onconnect) {
 342         this.onconnect = args.onconnect;
 343
 344     } else {
 345         /* if no handler is provided, make this a synchronous call */
 346         this.timeout = (args.timeout) ? args.timeout : 5;
 347     }
 348
 349     message = new osrfMessage({
 350         'threadTrace' : this.last_id++,
 351         'type' : OSRF_MESSAGE_TYPE_CONNECT
 352     });
 353
 354     this.send(message, {'timeout' : this.timeout});
 355
 356     if(this.onconnect || this.state == OSRF_APP_SESSION_CONNECTED)
 357         return true;
 358
 359     return false;
 360 };
 361
 362 OpenSRF.ClientSession.prototype.disconnect = function(args) {
 363
 364     if (this.state == OSRF_APP_SESSION_CONNECTED) {
 365         this.send(
 366             new osrfMessage({
 367                 'threadTrace' : this.last_id++,
 368                 'type' : OSRF_MESSAGE_TYPE_DISCONNECT
 369             })
 370         );
 371     }
 372
 373     this.remote_id = null;
 374     this.state = OSRF_APP_SESSION_DISCONNECTED;
 375 };
 376
 377
 378 OpenSRF.ClientSession.prototype.request = function(args) {
 379
 380     if(this.state != OSRF_APP_SESSION_CONNECTED)
 381         this.remote_id = null;
 382
 383     if(typeof args == 'string') {
 384         params = [];
 385         for(var i = 1; i < arguments.length; i++)
 386             params.push(arguments[i]);
 387
 388         args = {
 389             method : args,
 390             params : params
 391         };
 392     } else {
 393         if(typeof args == 'undefined')
 394             args = {};
 395     }
 396
 397     var req = new OpenSRF.Request(this, this.last_id++, args);
 398     this.requests.push(req);
 399     return req;
 400 };
 401
 402 OpenSRF.ClientSession.prototype.find_request = function(reqid) {
 403     for(var i = 0; i < this.requests.length; i++) {
 404         var req = this.requests[i];
 405         if(req.reqid == reqid)
 406             return req;
 407     }
 408     return null;
 409 };
 410
 411 OpenSRF.Request = function(session, reqid, args) {
 412     this.session = session;
 413     this.reqid = reqid;
 414
 415     /* callbacks */
 416     this.onresponse = args.onresponse;
 417     this.oncomplete = args.oncomplete;
 418     this.onerror = args.onerror;
 419     this.onmethoderror = args.onmethoderror;
 420     this.ontransporterror = args.ontransporterror;
 421
 422     this.method = args.method;
 423     this.params = args.params;
 424     this.timeout = args.timeout;
 425     this.api_level = args.api_level || OpenSRF.api_level;
 426     this.response_queue = [];
 427     this.complete = false;
 428 };
 429
 430 OpenSRF.Request.prototype.peek_last = function(timeout) {
 431     if(this.response_queue.length > 0) {
 432         var x = this.response_queue.pop();
 433         this.response_queue.push(x);
 434         return x;
 435     }
 436     return null;
 437 };
 438
 439 OpenSRF.Request.prototype.peek = function(timeout) {
 440     if(this.response_queue.length > 0)
 441         return this.response_queue[0];
 442     return null;
 443 };
 444
 445 OpenSRF.Request.prototype.recv = function(timeout) {
 446     if(this.response_queue.length > 0)
 447         return this.response_queue.shift();
 448     return null;
 449 };
 450
 451 OpenSRF.Request.prototype.send = function() {
 452     method = new osrfMethod({'method':this.method, 'params':this.params});
 453     message = new osrfMessage({
 454         'threadTrace' : this.reqid,
 455         'type' : OSRF_MESSAGE_TYPE_REQUEST,
 456         'payload' : method,
 457         'locale' : this.session.locale,
 458         'api_level' : this.api_level
 459     });
 460
 461     this.session.send(message, {
 462         'timeout' : this.timeout,
 463         'onresponse' : this.onresponse,
 464         'oncomplete' : this.oncomplete,
 465         'onerror' : this.onerror,
 466         'onmethoderror' : this.onmethoderror,
 467         'ontransporterror' : this.ontransporterror
 468     });
 469 };
 470
 471 OpenSRF.NetMessage = function(to, from, thread, body, osrf_msg) {
 472     this.to = to;
 473     this.from = from;
 474     this.thread = thread;
 475     this.body = body;
 476     this.osrf_msg = osrf_msg;
 477 };
 478
 479 OpenSRF.Stack = function() {
 480 };
 481
 482 // global inbound message queue
 483 OpenSRF.Stack.queue = [];
 484
 485 // XXX testing
 486 function log(msg) {
 487     try {
 488         dump(msg + '\n'); // xulrunner
 489     } catch(E) {
 490         console.log(msg);
 491     }
 492 }
 493
 494 // ses may be passed to us by the network handler
 495 OpenSRF.Stack.push = function(net_msg, callbacks) {
 496     var ses = OpenSRF.Session.find_session(net_msg.thread);
 497     if (!ses) return;
 498     ses.remote_id = net_msg.from;
 499
 500     // NetMessage's from websocket connections are parsed before they get here
 501     osrf_msgs = net_msg.osrf_msg;
 502
 503     if (!osrf_msgs) {
 504
 505         try {
 506             osrf_msgs = JSON2js(net_msg.body);
 507
 508             // TODO: pretty sure we don't need this..
 509             if (OpenSRF.Session.transport == OSRF_TRANSPORT_TYPE_WS) {
 510                 // WebSocketRequests wrap the content
 511                 osrf_msgs = osrf_msgs.osrf_msg;
 512             }
 513
 514         } catch(E) {
 515             log('Error parsing OpenSRF message body as JSON: ' + net_msg.body + '\n' + E);
 516
 517             /** UGH
 518               * For unknown reasons, the Content-Type header will occasionally
 519               * be included in the XHR.responseText for multipart/mixed messages.
 520               * When this happens, strip the header and newlines from the message
 521               * body and re-parse.
 522               */
 523             net_msg.body = net_msg.body.replace(/^.*\n\n/, '');
 524             log('Cleaning up and retrying...');
 525
 526             try {
 527                 osrf_msgs = JSON2js(net_msg.body);
 528             } catch(E2) {
 529                 log('Unable to clean up message, giving up: ' + net_msg.body);
 530                 return;
 531             }
 532         }
 533     }
 534
 535     // push the latest responses onto the end of the inbound message queue
 536     for(var i = 0; i < osrf_msgs.length; i++)
 537         OpenSRF.Stack.queue.push({msg : osrf_msgs[i], ses : ses});
 538
 539     // continue processing responses, oldest to newest
 540     while(OpenSRF.Stack.queue.length) {
 541         var data = OpenSRF.Stack.queue.shift();
 542         OpenSRF.Stack.handle_message(data.ses, data.msg);
 543     }
 544 };
 545
 546 OpenSRF.Stack.handle_message = function(ses, osrf_msg) {
 547
 548     var req = ses.find_request(osrf_msg.threadTrace());
 549
 550     if(osrf_msg.type() == OSRF_MESSAGE_TYPE_STATUS) {
 551
 552         var payload = osrf_msg.payload();
 553         var status = payload.statusCode();
 554         var status_text = payload.status();
 555
 556         if(status == OSRF_STATUS_COMPLETE) {
 557             if(req) {
 558                 req.complete = true;
 559                 if(req.oncomplete && !req.oncomplete_called) {
 560                     req.oncomplete_called = true;
 561                     return req.oncomplete(req);
 562                 }
 563             }
 564         }
 565
 566         if(status == OSRF_STATUS_OK) {
 567             ses.state = OSRF_APP_SESSION_CONNECTED;
 568
 569             /* call the connect callback */
 570             if(ses.onconnect && !ses.onconnect_called) {
 571                 ses.onconnect_called = true;
 572                 return ses.onconnect();
 573             }
 574         }
 575
 576         if(status == OSRF_STATUS_NOTFOUND || status == OSRF_STATUS_INTERNALSERVERERROR) {
 577             if(req && req.onmethoderror)
 578                 return req.onmethoderror(req, status, status_text);
 579         }
 580     }
 581
 582     if(osrf_msg.type() == OSRF_MESSAGE_TYPE_RESULT) {
 583         if(req) {
 584             req.response_queue.push(osrf_msg.payload());
 585             if(req.onresponse) {
 586                 return req.onresponse(req);
 587             }
 588         }
 589     }
 590 };
 591
 592