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.websocketConnected = function() {
 252     return OpenSRF.sharedWebsocketConnected || (
 253         OpenSRF.websocketConnection &&
 254         OpenSRF.websocketConnection.connected()
 255     );
 256 }
 257
 258 OpenSRF.Session.prototype.send_ws = function(osrf_msg) {
 259
 260     if (typeof SharedWorker == 'function') {
 261         // vanilla websockets requested, but this browser supports
 262         // shared workers, so use those instead.
 263         return this.send_ws_shared(osrf_msg);
 264     }
 265
 266     // otherwise, use a per-tab connection
 267
 268     if (!OpenSRF.websocketConnection) {
 269         this.setup_single_ws();
 270     }
 271
 272     var json = js2JSON({
 273         service : this.service,
 274         thread : this.thread,
 275         osrf_msg : [message.serialize()]
 276     });
 277
 278     OpenSRF.websocketConnection.send(json);
 279 };
 280
 281 OpenSRF.Session.prototype.setup_single_ws = function() {
 282     OpenSRF.websocketConnection = new OpenSRF.WebSocket();
 283
 284     OpenSRF.websocketConnection.onmessage = function(msg) {
 285         try {
 286             var msg = JSON2js(msg);
 287         } catch(E) {
 288             console.error(
 289                 "Error parsing JSON in shared WS response: " + msg);
 290             throw E;
 291         }
 292         OpenSRF.Stack.push(
 293             new OpenSRF.NetMessage(
 294                null, null, msg.thread, null, msg.osrf_msg)
 295         );
 296
 297         return;
 298     }
 299 }
 300
 301 OpenSRF.Session.setup_shared_ws = function() {
 302     OpenSRF.Session.transport = OSRF_TRANSPORT_TYPE_WS_SHARED;
 303
 304     OpenSRF.sharedWSWorker = new SharedWorker(SHARED_WORKER_LIB);
 305
 306     OpenSRF.sharedWSWorker.port.addEventListener('message', function(e) {
 307         var data = e.data;
 308         console.debug('sharedWSWorker received message of type: ' + data.action);
 309
 310         if (data.action == 'message') {
 311             // pass all inbound message up the opensrf stack
 312
 313             OpenSRF.sharedWebsocketConnected = true;
 314             var msg;
 315             try {
 316                 msg = JSON2js(data.message);
 317             } catch(E) {
 318                 console.error(
 319                     "Error parsing JSON in shared WS response: " + msg);
 320                 throw E;
 321             }
 322             OpenSRF.Stack.push(
 323                 new OpenSRF.NetMessage(
 324                    null, null, msg.thread, null, msg.osrf_msg)
 325             );
 326
 327             return;
 328         }
 329
 330
 331         if (data.action == 'event') {
 332             console.debug('event type is ' + data.type);
 333             if (data.type.match(/onclose|onerror/)) {
 334                 OpenSRF.sharedWebsocketConnected = false;
 335                 if (OpenSRF.onWebSocketClosed)
 336                     OpenSRF.onWebSocketClosed();
 337                 if (data.type.match(/onerror/))
 338                     throw new Error(data.message);
 339             }
 340         }
 341     });
 342
 343     OpenSRF.sharedWSWorker.port.start();
 344 }
 345
 346 OpenSRF.Session.prototype.send_ws_shared = function(message) {
 347
 348     if (!OpenSRF.sharedWSWorker)
 349         OpenSRF.Session.setup_shared_ws();
 350
 351     var json = js2JSON({
 352         service : this.service,
 353         thread : this.thread,
 354         osrf_msg : [message.serialize()]
 355     });
 356
 357     OpenSRF.sharedWSWorker.port.postMessage({
 358         action : 'message',
 359         // pass the thread additionally as a stand-alone value so the
 360         // worker can more efficiently inspect it.
 361         thread : this.thread,
 362         message : json
 363     });
 364 }
 365
 366
 367 OpenSRF.Session.prototype.send_xmpp = function(osrf_msg, args) {
 368     alert('xmpp transport not implemented');
 369 };
 370
 371
 372 /* client sessions make requests */
 373 OpenSRF.ClientSession = function(service) {
 374     this.service = service;
 375     this.remote_id = null;
 376     this.locale = OpenSRF.locale || 'en-US';
 377     this.last_id = 0;
 378     this.requests = [];
 379     this.onconnect = null;
 380     this.thread = Math.random() + '' + new Date().getTime();
 381     OpenSRF.Session.cache[this.thread] = this;
 382 };
 383 OpenSRF.set_subclass('OpenSRF.ClientSession', 'OpenSRF.Session');
 384
 385
 386 OpenSRF.ClientSession.prototype.connect = function(args) {
 387     args = (args) ? args : {};
 388     this.remote_id = null;
 389
 390     if (this.state == OSRF_APP_SESSION_CONNECTED) {
 391         if (args.onconnect) args.onconnect();
 392         return true;
 393     }
 394
 395     if(args.onconnect) {
 396         this.onconnect = args.onconnect;
 397
 398     } else {
 399         /* if no handler is provided, make this a synchronous call */
 400         this.timeout = (args.timeout) ? args.timeout : 5;
 401     }
 402
 403     message = new osrfMessage({
 404         'threadTrace' : this.last_id++,
 405         'type' : OSRF_MESSAGE_TYPE_CONNECT
 406     });
 407
 408     this.send(message, {'timeout' : this.timeout});
 409
 410     if(this.onconnect || this.state == OSRF_APP_SESSION_CONNECTED)
 411         return true;
 412
 413     return false;
 414 };
 415
 416 OpenSRF.ClientSession.prototype.disconnect = function(args) {
 417
 418     if (this.state == OSRF_APP_SESSION_CONNECTED) {
 419         this.send(
 420             new osrfMessage({
 421                 'threadTrace' : this.last_id++,
 422                 'type' : OSRF_MESSAGE_TYPE_DISCONNECT
 423             })
 424         );
 425     }
 426
 427     this.remote_id = null;
 428     this.state = OSRF_APP_SESSION_DISCONNECTED;
 429 };
 430
 431
 432 OpenSRF.ClientSession.prototype.request = function(args) {
 433
 434     if(this.state != OSRF_APP_SESSION_CONNECTED)
 435         this.remote_id = null;
 436
 437     if(typeof args == 'string') {
 438         params = [];
 439         for(var i = 1; i < arguments.length; i++)
 440             params.push(arguments[i]);
 441
 442         args = {
 443             method : args,
 444             params : params
 445         };
 446     } else {
 447         if(typeof args == 'undefined')
 448             args = {};
 449     }
 450
 451     var req = new OpenSRF.Request(this, this.last_id++, args);
 452     this.requests.push(req);
 453     return req;
 454 };
 455
 456 OpenSRF.ClientSession.prototype.find_request = function(reqid) {
 457     for(var i = 0; i < this.requests.length; i++) {
 458         var req = this.requests[i];
 459         if(req.reqid == reqid)
 460             return req;
 461     }
 462     return null;
 463 };
 464
 465 OpenSRF.Request = function(session, reqid, args) {
 466     this.session = session;
 467     this.reqid = reqid;
 468
 469     /* callbacks */
 470     this.onresponse = args.onresponse;
 471     this.oncomplete = args.oncomplete;
 472     this.onerror = args.onerror;
 473     this.onmethoderror = args.onmethoderror;
 474     this.ontransporterror = args.ontransporterror;
 475
 476     this.method = args.method;
 477     this.params = args.params;
 478     this.timeout = args.timeout;
 479     this.api_level = args.api_level || OpenSRF.api_level;
 480     this.response_queue = [];
 481     this.complete = false;
 482 };
 483
 484 OpenSRF.Request.prototype.peek_last = function(timeout) {
 485     if(this.response_queue.length > 0) {
 486         var x = this.response_queue.pop();
 487         this.response_queue.push(x);
 488         return x;
 489     }
 490     return null;
 491 };
 492
 493 OpenSRF.Request.prototype.peek = function(timeout) {
 494     if(this.response_queue.length > 0)
 495         return this.response_queue[0];
 496     return null;
 497 };
 498
 499 OpenSRF.Request.prototype.recv = function(timeout) {
 500     if(this.response_queue.length > 0)
 501         return this.response_queue.shift();
 502     return null;
 503 };
 504
 505 OpenSRF.Request.prototype.send = function() {
 506     method = new osrfMethod({'method':this.method, 'params':this.params});
 507     message = new osrfMessage({
 508         'threadTrace' : this.reqid,
 509         'type' : OSRF_MESSAGE_TYPE_REQUEST,
 510         'payload' : method,
 511         'locale' : this.session.locale,
 512         'api_level' : this.api_level
 513     });
 514
 515     this.session.send(message, {
 516         'timeout' : this.timeout,
 517         'onresponse' : this.onresponse,
 518         'oncomplete' : this.oncomplete,
 519         'onerror' : this.onerror,
 520         'onmethoderror' : this.onmethoderror,
 521         'ontransporterror' : this.ontransporterror
 522     });
 523 };
 524
 525 OpenSRF.NetMessage = function(to, from, thread, body, osrf_msg) {
 526     this.to = to;
 527     this.from = from;
 528     this.thread = thread;
 529     this.body = body;
 530     this.osrf_msg = osrf_msg;
 531 };
 532
 533 OpenSRF.Stack = function() {
 534 };
 535
 536 // global inbound message queue
 537 OpenSRF.Stack.queue = [];
 538
 539 // XXX testing
 540 function log(msg) {
 541     try {
 542         dump(msg + '\n'); // xulrunner
 543     } catch(E) {
 544         console.log(msg);
 545     }
 546 }
 547
 548 // ses may be passed to us by the network handler
 549 OpenSRF.Stack.push = function(net_msg, callbacks) {
 550     var ses = OpenSRF.Session.find_session(net_msg.thread);
 551     if (!ses) return;
 552     ses.remote_id = net_msg.from;
 553
 554     // NetMessage's from websocket connections are parsed before they get here
 555     osrf_msgs = net_msg.osrf_msg;
 556
 557     if (!osrf_msgs) {
 558
 559         try {
 560             osrf_msgs = JSON2js(net_msg.body);
 561
 562             // TODO: pretty sure we don't need this..
 563             if (OpenSRF.Session.transport == OSRF_TRANSPORT_TYPE_WS) {
 564                 // WebSocketRequests wrap the content
 565                 osrf_msgs = osrf_msgs.osrf_msg;
 566             }
 567
 568         } catch(E) {
 569             log('Error parsing OpenSRF message body as JSON: ' + net_msg.body + '\n' + E);
 570
 571             /** UGH
 572               * For unknown reasons, the Content-Type header will occasionally
 573               * be included in the XHR.responseText for multipart/mixed messages.
 574               * When this happens, strip the header and newlines from the message
 575               * body and re-parse.
 576               */
 577             net_msg.body = net_msg.body.replace(/^.*\n\n/, '');
 578             log('Cleaning up and retrying...');
 579
 580             try {
 581                 osrf_msgs = JSON2js(net_msg.body);
 582             } catch(E2) {
 583                 log('Unable to clean up message, giving up: ' + net_msg.body);
 584                 return;
 585             }
 586         }
 587     }
 588
 589     // push the latest responses onto the end of the inbound message queue
 590     for(var i = 0; i < osrf_msgs.length; i++)
 591         OpenSRF.Stack.queue.push({msg : osrf_msgs[i], ses : ses});
 592
 593     // continue processing responses, oldest to newest
 594     while(OpenSRF.Stack.queue.length) {
 595         var data = OpenSRF.Stack.queue.shift();
 596         OpenSRF.Stack.handle_message(data.ses, data.msg);
 597     }
 598 };
 599
 600 OpenSRF.Stack.handle_message = function(ses, osrf_msg) {
 601
 602     var req = ses.find_request(osrf_msg.threadTrace());
 603
 604     if(osrf_msg.type() == OSRF_MESSAGE_TYPE_STATUS) {
 605
 606         var payload = osrf_msg.payload();
 607         var status = payload.statusCode();
 608         var status_text = payload.status();
 609
 610         if(status == OSRF_STATUS_COMPLETE) {
 611             if(req) {
 612                 req.complete = true;
 613                 if(req.oncomplete && !req.oncomplete_called) {
 614                     req.oncomplete_called = true;
 615                     return req.oncomplete(req);
 616                 }
 617             }
 618         }
 619
 620         if(status == OSRF_STATUS_OK) {
 621             ses.state = OSRF_APP_SESSION_CONNECTED;
 622
 623             /* call the connect callback */
 624             if(ses.onconnect && !ses.onconnect_called) {
 625                 ses.onconnect_called = true;
 626                 return ses.onconnect();
 627             }
 628         }
 629
 630         if(status == OSRF_STATUS_NOTFOUND || status == OSRF_STATUS_INTERNALSERVERERROR) {
 631             if(req && req.onmethoderror)
 632                 return req.onmethoderror(req, status, status_text);
 633         }
 634     }
 635
 636     if(osrf_msg.type() == OSRF_MESSAGE_TYPE_RESULT) {
 637         if(req) {
 638             req.response_queue.push(osrf_msg.payload());
 639             if(req.onresponse) {
 640                 return req.onresponse(req);
 641             }
 642         }
 643     }
 644 };
 645
 646