File: HttpRequest.js

package info (click to toggle)
gcontactsync 0.2.8-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 732 kB
  • ctags: 207
  • sloc: makefile: 2
file content (171 lines) | stat: -rw-r--r-- 6,563 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is gContactSync.
 *
 * The Initial Developer of the Original Code is
 * Josh Geenen <gcontactsync@pirules.net>.
 * Portions created by the Initial Developer are Copyright (C) 2008
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
/**
 * HttpRequest
 * Sets up an HTTP request.
 * @constructor
 * @class
 */
function HttpRequest() {
  if (window.XMLHttpRequest)
    this.mHttpRequest = new XMLHttpRequest();
  if (!this.mHttpRequest)
    throw "Error - could not create an XMLHttpRequest" +
          StringBundle.getStr("pleaseReport");
}

HttpRequest.prototype = {
  // content types
  CONTENT_TYPES: {
    URL_ENC: "application/x-www-form-urlencoded", 
    ATOM:    "application/atom+xml",
    XML:     "application/xml"
  },
  /**
   * HttpRequest.addContentOverride
   * Adds a content override to the header in case a firewall blocks DELETE or
   * PUT requests.
   * @param aType   The type of override.  Must be DELETE or PUT.
   */
  addContentOverride: function HttpRequest_addContentOverride(aType) {
    switch (aType) {
      case "delete":
      case "DELETE":
        this.addHeaderItem("X-HTTP-Method-Override", "DELETE");
        break;
      case "put":
      case "PUT":
        this.addHeaderItem("X-HTTP-Method-Override", "PUT");
        break;
      default:
        throw "Error - type sent to addContentOverride must be DELETE or PUT";
    }
  },
  /**
   * HttpRequest.addHeaderItem
   * Adds a header label/value pair to the arrays of header information
   * @param aLabel  The label for the header
   * @param aValue  The value for the header
   */
  addHeaderItem: function HttpRequest_addHeaderItem(aLabel, aValue) {
    if (!this.mHeaderLabels) {
      this.mHeaderLabels = [];
      this.mHeaderValues = [];
    }
    this.mHeaderLabels.push(aLabel);
    this.mHeaderValues.push(aValue);
  },
  /**
   * HttpRequest.send
   * Sends the HTTP Request with the information stored in the object.
   * Note: Setup everything, including the callbacks for different statuses
   *       including mOnSuccess, mOnError, mOnFail, and mOnCreated first.
   */
  send: function HttpRequest_send() {
    // log the basic info for debugging purposes
    LOGGER.VERBOSE_LOG("HTTP Request being formed");
    LOGGER.VERBOSE_LOG(" * Caller is: " + this.send.caller.name);
    LOGGER.VERBOSE_LOG(" * URL: " + this.mUrl);
    LOGGER.VERBOSE_LOG(" * Type: " + this.mType);
    LOGGER.VERBOSE_LOG(" * Content-Type: " + this.mContentType);
    
    this.mHttpRequest.open(this.mType, this.mUrl, true); // open the request

    // set the header
    this.addHeaderItem("Content-Type", this.mContentType);
    LOGGER.VERBOSE_LOG(" * Setting up the header: ");

    for (var i = 0; i < this.mHeaderLabels.length; i++) {
       LOGGER.VERBOSE_LOG("   o " + this.mHeaderLabels[i] + " " + this.mHeaderValues[i]);
       this.mHttpRequest.setRequestHeader(this.mHeaderLabels[i],
                                          this.mHeaderValues[i]);
    }
    this.mHttpRequest.send(this.mBody); // send the request
    LOGGER.VERBOSE_LOG(" * Request Sent");
    var httpReq   = this.mHttpRequest;
    var onSuccess = this.mOnSuccess ? this.mOnSuccess: [];
    var onOffline = this.mOnOffline ? this.mOnOffline: [];
    var onFail    = this.mOnError   ? this.mOnError:   [];
    var onCreated = this.mOnCreated ? this.mOnCreated: [];
    var on401     = this.mOn401     ? this.mOn401:     [];

    httpReq.onreadystatechange = function httpReq_readyState() {
      var commands = [];
      // if the request is done then check the status
      if (httpReq.readyState == 4) {
        // this may be called after the address book window is closed
        // if the window is closed there will be an exception thrown as
        // explained here - https://www.mozdev.org/bugs/show_bug.cgi?id=20527
        try {
          LOGGER.VERBOSE_LOG(" * The request has finished with status: " +
                             httpReq.status + "/" + httpReq.statusText);
          LOGGER.VERBOSE_LOG(" * Headers:\n" + httpReq.getAllResponseHeaders() + "\n");
          //if (confirm("Fake 401?")) {
          //  alert('Faking a 401');
          //  return handle401(httpReq);
          //}
          switch (httpReq.status) { 
            case 0: // the user is offline
              commands = onOffline;
              break;
            case 201: // 201 CREATED
              commands = onCreated;
              break;
            case 200: // 200 OK
              commands = onSuccess;
              break;
            case 401: // 401 Unauthorized (Token Expired in Gmail)
              commands = on401;
              break;
            default: // other status
              commands = onFail;
          }
          LOGGER.VERBOSE_LOG(" * Evaluating commands");
          for (var i in commands) {
            LOGGER.VERBOSE_LOG("   o " + commands[i]);
            try {
              eval(commands[i]);
            }
            catch (e) {
              LOGGER.LOG_WARNING("Couldn't evaluate command", e);
            }
          }
        }
        catch (e) {}
      } // end of readyState
    }
  }
};