src/javascript/opensrf_xhr.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 var OSRF_HTTP_HEADER_TO = 'X-OpenSRF-to';
  17 var OSRF_HTTP_HEADER_XID = 'X-OpenSRF-xid';
  18 var OSRF_HTTP_HEADER_FROM = 'X-OpenSRF-from';
  19 var OSRF_HTTP_HEADER_THREAD = 'X-OpenSRF-thread';
  20 var OSRF_HTTP_HEADER_TIMEOUT = 'X-OpenSRF-timeout';
  21 var OSRF_HTTP_HEADER_SERVICE = 'X-OpenSRF-service';
  22 var OSRF_HTTP_HEADER_MULTIPART = 'X-OpenSRF-multipart';
  23 var OSRF_HTTP_TRANSLATOR = '/osrf-http-translator'; /* XXX config */
  24 var OSRF_POST_CONTENT_TYPE = 'application/x-www-form-urlencoded';
  25
  26
  27 OpenSRF.XHRequest = function(osrf_msg, args) {
  28     this.message = osrf_msg;
  29     this.args = args;
  30     this.xreq = new XMLHttpRequest(); /* XXX browser check */
  31 }
  32
  33 OpenSRF.XHRequest.prototype.send = function() {
  34     var xhr_req = this;
  35     var xreq = this.xreq
  36
  37     if(this.args.timeout) {
  38         /* this is a standard blocking (non-multipart) call */
  39         xreq.open('POST', OSRF_HTTP_TRANSLATOR, false);
  40
  41     } else {
  42
  43         if(!navigator.userAgent.match(/mozilla/i)) {
  44
  45             /* standard asynchronous call */
  46             xreq.onreadystatechange = function() {
  47                 if(xreq.readyState == 4)
  48                     xhr_req.core_handler();
  49             }
  50             xreq.open('POST', OSRF_HTTP_TRANSLATOR, true);
  51
  52         } else {
  53
  54             /* asynchronous multipart call */
  55             xreq.multipart = true;
  56             xreq.onload = function(evt) {xhr_req.core_handler();}
  57             xreq.open('POST', OSRF_HTTP_TRANSLATOR, true);
  58             xreq.setRequestHeader(OSRF_HTTP_HEADER_MULTIPART, 'true');
  59
  60             /* multipart requests do not pass the status info to the onload if there
  61                is no new data to load.  Capture the status on the readystate handler */
  62             xreq.onreadystatechange = function() {
  63                 if(xreq.readyState == 4 && xreq.status >= 400)
  64                     xhr_req.transport_error_handler();
  65             }
  66         }
  67     }
  68
  69     xreq.setRequestHeader('Content-Type', OSRF_POST_CONTENT_TYPE);
  70     xreq.setRequestHeader(OSRF_HTTP_HEADER_THREAD, this.args.thread);
  71     if(this.args.rcpt)
  72         xreq.setRequestHeader(OSRF_HTTP_HEADER_TO, this.args.rcpt);
  73     else
  74         xreq.setRequestHeader(OSRF_HTTP_HEADER_SERVICE, this.args.rcpt_service);
  75
  76     var post = 'osrf-msg=' + encodeURIComponent(js2JSON([this.message.serialize()]));
  77     xreq.send(post);
  78
  79     if(this.args.timeout) /* this was a blocking call, manually run the handler */
  80         this.core_handler()
  81
  82     return this;
  83 }
  84
  85 OpenSRF.XHRequest.prototype.core_handler = function() {
  86     sender = this.xreq.getResponseHeader(OSRF_HTTP_HEADER_FROM);
  87     thread = this.xreq.getResponseHeader(OSRF_HTTP_HEADER_THREAD);
  88     json = this.xreq.responseText;
  89     stat = this.xreq.status;
  90
  91     if(stat >= 400)
  92         return this.transport_error_handler();
  93
  94     OpenSRF.Stack.push(
  95         new OpenSRF.NetMessage(null, sender, thread, json),
  96         {
  97             onresponse : this.args.onresponse,
  98             oncomplete : this.args.oncomplete,
  99             onerror : this.args.onerror,
 100             onmethoderror : this.method_error_handler()
 101         }
 102     );
 103 }
 104
 105
 106 OpenSRF.XHRequest.prototype.method_error_handler = function() {
 107     var xhr = this;
 108     return function(req, status, status_text) {
 109         if(xhr.args.onmethoderror)
 110             xhr.args.onmethoderror(req, status, status_text);
 111         if(xhr.args.onerror)
 112             xhr.args.onerror(xhr.message, xhr.args.rcpt || xhr.args.rcpt_service, xhr.args.thread);
 113     }
 114 }
 115
 116 OpenSRF.XHRequest.prototype.transport_error_handler = function() {
 117     if(this.args.ontransporterror)
 118         this.args.ontransporterror(this.xreq);
 119     if(this.args.onerror)
 120         this.args.onerror(this.message, this.args.rcpt || this.args.rcpt_service, this.args.thread);
 121 }
 122
 123