The Tor Browser: toolkit/mozapps/update/tests/chrome/update.sjs@6474c204b198 (annotated)

toolkit/mozapps/update/tests/chrome/update.sjs@6474c204b198 (annotated)

toolkit/mozapps/update/tests/chrome/update.sjs

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/
  */
 /**
  * Server side http server script for application update tests.
  *
  * !IMPORTANT - Since xpcshell used by the http server is launched with -v 170
  * this file must not use features greater than JavaScript 1.7.
  */
 const AUS_Cc = Components.classes;
 const AUS_Ci = Components.interfaces;
 #include ../sharedUpdateXML.js
 const URL_HOST = "http://example.com";
 const URL_PATH_UPDATE_XML = "/chrome/toolkit/mozapps/update/tests/chrome/update.sjs";
 const URL_HTTP_UPDATE_SJS = URL_HOST + URL_PATH_UPDATE_XML;
 const REL_PATH_DATA = "chrome/toolkit/mozapps/update/tests/data/";
 const SERVICE_URL = URL_HOST + "/" + REL_PATH_DATA + FILE_SIMPLE_MAR;
 const SLOW_MAR_DOWNLOAD_INTERVAL = 100;
 var gTimer;
 function handleRequest(aRequest, aResponse) {
   var params = { };
   if (aRequest.queryString)
     params = parseQueryString(aRequest.queryString);
   var statusCode = params.statusCode ? parseInt(params.statusCode) : 200;
   var statusReason = params.statusReason ? params.statusReason : "OK";
   aResponse.setStatusLine(aRequest.httpVersion, statusCode, statusReason);
   aResponse.setHeader("Cache-Control", "no-cache", false);
   if (params.addonID) {
     aResponse.write(getUpdateRDF(params));
     return;
   }
   // When a mar download is started by the update service it can finish
   // downloading before the ui has loaded. By specifying a serviceURL for the
   // update patch that points to this file and has a slowDownloadMar param the
   // mar will be downloaded asynchronously which will allow the ui to load
   // before the download completes.
   if (params.slowDownloadMar) {
     aResponse.processAsync();
     aResponse.setHeader("Content-Type", "binary/octet-stream");
     aResponse.setHeader("Content-Length", SIZE_SIMPLE_MAR);
     var marFile = AUS_Cc["@mozilla.org/file/directory_service;1"].
                   getService(AUS_Ci.nsIProperties).
                   get("CurWorkD", AUS_Ci.nsILocalFile);
     var path = REL_PATH_DATA + FILE_SIMPLE_MAR;
     var pathParts = path.split("/");
     for(var i = 0; i < pathParts.length; ++i)
       marFile.append(pathParts[i]);
     var contents = readFileBytes(marFile);
     gTimer = AUS_Cc["@mozilla.org/timer;1"].
              createInstance(AUS_Ci.nsITimer);
     gTimer.initWithCallback(function(aTimer) {
       aResponse.write(contents);
       aResponse.finish();
     }, SLOW_MAR_DOWNLOAD_INTERVAL, AUS_Ci.nsITimer.TYPE_ONE_SHOT);
     return;
   }
   if (params.uiURL) {
     var remoteType = "";
     if (!params.remoteNoTypeAttr &&
         (params.uiURL == "BILLBOARD" || params.uiURL == "LICENSE")) {
       remoteType = " " + params.uiURL.toLowerCase() + "=\"1\"";
     }
     aResponse.write("<html><head><meta http-equiv=\"content-type\" content=" +
                     "\"text/html; charset=utf-8\"></head><body" +
                     remoteType + ">" + params.uiURL +
                     "<br><br>this is a test mar that will not affect your " +
                     "build.</body></html>");
     return;
   }
   if (params.xmlMalformed) {
     aResponse.write("xml error");
     return;
   }
   if (params.noUpdates) {
     aResponse.write(getRemoteUpdatesXMLString(""));
     return;
   }
   if (params.unsupported) {
     aResponse.write(getRemoteUpdatesXMLString("  <update type=\"major\" " +
                                               "unsupported=\"true\" " +
                                               "detailsURL=\"" + URL_HOST +
                                               "\"></update>\n"));
     return;
   }
   var hash;
   var patches = "";
   if (!params.partialPatchOnly) {
     hash = SHA512_HASH_SIMPLE_MAR + (params.invalidCompleteHash ? "e" : "");
     patches += getRemotePatchString("complete", SERVICE_URL, "SHA512",
                                     hash, SIZE_SIMPLE_MAR);
   }
   if (!params.completePatchOnly) {
     hash = SHA512_HASH_SIMPLE_MAR + (params.invalidPartialHash ? "e" : "");
     patches += getRemotePatchString("partial", SERVICE_URL, "SHA512",
                                     hash, SIZE_SIMPLE_MAR);
   }
   var type = params.type ? params.type : "major";
   var name = params.name ? params.name : "App Update Test";
   var appVersion = params.appVersion ? params.appVersion : "99.9";
   var displayVersion = params.displayVersion ? params.displayVersion
                                              : "version " + appVersion;
   var platformVersion = params.platformVersion ? params.platformVersion : "99.8";
   var buildID = params.buildID ? params.buildID : "01234567890123";
   // XXXrstrong - not specifying a detailsURL will cause a leak due to bug 470244
 //  var detailsURL = params.showDetails ? URL_HTTP_UPDATE_SJS + "?uiURL=DETAILS" : null;
   var detailsURL = URL_HTTP_UPDATE_SJS + "?uiURL=DETAILS";
   var billboardURL = params.showBillboard ? URL_HTTP_UPDATE_SJS + "?uiURL=BILLBOARD" : null;
   if (billboardURL && params.remoteNoTypeAttr)
     billboardURL += "&amp;remoteNoTypeAttr=1";
   if (params.billboard404)
     billboardURL = URL_HOST + "/missing.html";
   var licenseURL = params.showLicense ? URL_HTTP_UPDATE_SJS + "?uiURL=LICENSE" : null;
   if (licenseURL && params.remoteNoTypeAttr)
     licenseURL += "&amp;remoteNoTypeAttr=1";
   if (params.license404)
     licenseURL = URL_HOST + "/missing.html";
   var showPrompt = params.showPrompt ? "true" : null;
   var showNever = params.showNever ? "true" : null;
   var promptWaitTime = params.promptWaitTime ? params.promptWaitTime : null;
   var showSurvey = params.showSurvey ? "true" : null;
   // For testing the deprecated update xml format
   if (params.oldFormat) {
     appVersion = null;
     displayVersion = null;
     billboardURL = null;
     showPrompt = null;
     showNever = null;
     showSurvey = null;
     detailsURL = URL_HTTP_UPDATE_SJS + "?uiURL=BILLBOARD";
     if (params.remoteNoTypeAttr)
       detailsURL += "&amp;remoteNoTypeAttr=1";
     var extensionVersion = params.appVersion ? params.appVersion : "99.9";
     var version = params.displayVersion ? params.displayVersion
                                         : "version " + extensionVersion;
   }
   var updates = getRemoteUpdateString(patches, type, "App Update Test",
                                       displayVersion, appVersion,
                                       platformVersion, buildID, detailsURL,
                                       billboardURL, licenseURL, showPrompt,
                                       showNever, promptWaitTime, showSurvey,
                                       version, extensionVersion);
   aResponse.write(getRemoteUpdatesXMLString(updates));
 }
 /**
  * Helper function to create a JS object representing the url parameters from
  * the request's queryString.
  *
  * @param  aQueryString
  *         The request's query string.
  * @return A JS object representing the url parameters from the request's
  *         queryString.
  */
 function parseQueryString(aQueryString) {
   var paramArray = aQueryString.split("&");
   var regex = /^([^=]+)=(.*)$/;
   var params = {};
   for (var i = 0, sz = paramArray.length; i < sz; i++) {
     var match = regex.exec(paramArray[i]);
     if (!match)
       throw "Bad parameter in queryString!  '" + paramArray[i] + "'";
     params[decodeURIComponent(match[1])] = decodeURIComponent(match[2]);
   }
   return params;
 }
 /**
  * Helper function to gets the string representation of the contents of the
  * add-on's update manifest file.
  *
  * @param  aParams
  *         A JS object representing the url parameters from the request's
  *         queryString.
  * @return A string representation of the contents of the add-on's update
  *         manifest file.
  */
 function getUpdateRDF(aParams) {
   var addonVersion;
   var addonID = aParams.addonID;
   var addonUpdateType = addonID.split("_")[0];
   var maxVersion = aParams.platformVersion;
   switch (addonUpdateType) {
     case "updatecompatibility":
       // Use "1.0" for the add-on version for the compatibility update case since
       // the tests create all add-ons with "1.0" for the version.
       addonVersion = "1.0";
       break;
     case "updateversion":
       // Use "2.0" for the add-on version for the version update case since the
       // tests create all add-ons with "1.0" for the version.
       addonVersion = "2.0";
       break;
     default:
       return "<?xml version=\"1.0\"?>\n" +
              "<RDF:RDF xmlns:RDF=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\" " +
              "         xmlns:em=\"http://www.mozilla.org/2004/em-rdf#\">\n" +
              "</RDF:RDF>\n";
   }
   return "<?xml version=\"1.0\"?>\n" +
          "<RDF:RDF xmlns:RDF=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\" " +
          "         xmlns:em=\"http://www.mozilla.org/2004/em-rdf#\">\n" +
          "  <RDF:Description about=\"urn:mozilla:extension:" + addonID + "\">\n" +
          "    <em:updates>\n" +
          "      <RDF:Seq>\n" +
          "        <RDF:li resource=\"urn:mozilla:extension:" + addonID + ":" + addonVersion + "\"/>\n" +
          "      </RDF:Seq>\n" +
          "    </em:updates>\n" +
          "  </RDF:Description>\n" +
          "  <RDF:Description about=\"urn:mozilla:extension:" + addonID + ":" + addonVersion + "\">\n" +
          "    <em:version>" + addonVersion + "</em:version>\n" +
          "    <em:targetApplication>\n" +
          "      <RDF:Description>\n" +
          "        <em:id>toolkit@mozilla.org</em:id>\n" +
          "        <em:minVersion>0</em:minVersion>\n" +
          "        <em:maxVersion>" + maxVersion + "</em:maxVersion>\n" +
          "        <em:updateLink>" + URL_HTTP_UPDATE_SJS + "</em:updateLink>\n" +
          "        <em:updateHash>sha256:0</em:updateHash>\n" +
          "      </RDF:Description>\n" +
          "    </em:targetApplication>\n" +
          "  </RDF:Description>\n" +
          "</RDF:RDF>\n";
 }
 /**
  * Reads the binary contents of a file and returns it as a string.
  *
  * @param  aFile
  *         The file to read from.
  * @return The contents of the file as a string.
  */
 function readFileBytes(aFile) {
   var fis = AUS_Cc["@mozilla.org/network/file-input-stream;1"].
             createInstance(AUS_Ci.nsIFileInputStream);
   fis.init(aFile, -1, -1, false);
   var bis = AUS_Cc["@mozilla.org/binaryinputstream;1"].
             createInstance(AUS_Ci.nsIBinaryInputStream);
   bis.setInputStream(fis);
   var data = [];
   var count = fis.available();
   while (count > 0) {
     var bytes = bis.readByteArray(Math.min(65535, count));
     data.push(String.fromCharCode.apply(null, bytes));
     count -= bytes.length;
     if (bytes.length == 0)
       throw "Nothing read from input stream!";
   }
   data.join('');
   fis.close();
   return data.toString();
 }

The Tor Browser / annotate

toolkit/mozapps/update/tests/chrome/update.sjs@6474c204b198 (annotated)

toolkit/mozapps/update/tests/chrome/update.sjs