modules/mime-type-override.js

   1 /**
   2  * (C) Copyright 2008 Jeremy Maitin-Shepard
   3  *
   4  * Portions of this file are derived from the "Open in Browser" extension,
   5  * (C) Copyright 2006 Sylvain Pasche.
   6  *
   7  * Use, modification, and distribution are subject to the terms specified in the
   8  * COPYING file.
   9  **/
  10
  11 /**
  12  * This module was inspired by the "Open in Browser" extension by Sylvain
  13  * Pasche, available at <http://www.spasche.net/openinbrowser/>.
  14  *
  15  * This module implements (in a somewhat hacky way) overriding of the
  16  * server-specified mime type for specified URLs. It works by registering an
  17  * observer for the "http-on-examine-response" and
  18  * "http-on-examine-merged-response" topics and changes the response MIME type
  19  * of the nsIHTTPChannel object passed as the subject, as well as clearing any
  20  * "Content-disposition" header.
  21  *
  22  * Unfortunately, due to the design, this hack does not work for FTP.
  23  *
  24  **/
  25
  26 let EXAMINE_TOPIC = "http-on-examine-response";
  27 let EXAMINE_MERGED_TOPIC = "http-on-examine-merged-response";
  28
  29 let table = {};
  30
  31 let timeout = 10000; // 10000 milliseconds = 10 seconds
  32
  33 let table_size = 0;
  34
  35 // uri must be an instance of nsIURI
  36 function can_override_mime_type_for_uri(uri) {
  37     return uri.schemeIs("http") || uri.schemeIs("https");
  38 }
  39
  40 let clear_override = function(uri_string) {
  41     delete table[uri_string];
  42     table_size--;
  43
  44     if (table_size == 0) {
  45         observer_service.removeObserver(observer, EXAMINE_TOPIC);
  46         observer_service.removeObserver(observer, EXAMINE_MERGED_TOPIC);
  47     }
  48 }
  49
  50 let observer = {
  51     observe: function (subject, topic, data) {
  52         if (topic != EXAMINE_TOPIC && topic != EXAMINE_MERGED_TOPIC)
  53             return;
  54
  55         subject.QueryInterface(Ci.nsIHttpChannel);
  56
  57         var uri_string = subject.originalURI.spec;
  58         var obj = table[uri_string];
  59         if (!obj)
  60             return;
  61
  62         obj.timer.cancel();
  63
  64         subject.contentType = obj.mime_type;
  65
  66         // drop content-disposition header
  67         subject.setResponseHeader("Content-Disposition", "", false);
  68
  69         clear_override(uri_string);
  70     }
  71 };
  72
  73
  74
  75 // uri must be an instance of nsIURI and can_override_mime_type_for_uri must
  76 // return true for the passed uri.
  77
  78 // mime_type must be a string
  79 function override_mime_type_for_next_load(uri, mime_type) {
  80     cache_entry_clear(CACHE_ALL, CACHE_SESSION_HTTP, uri);
  81
  82     var obj = table[uri.spec];
  83     if (obj)
  84         obj.timer.cancel();
  85     else
  86         table_size++;
  87
  88     obj = { mime_type: mime_type };
  89
  90     obj.timer = call_after_timeout(function () {
  91                                        clear_override(uri.spec);
  92                                    }, timeout);
  93
  94     if (table_size == 1) {
  95         observer_service.addObserver(observer, EXAMINE_TOPIC, false);
  96         observer_service.addObserver(observer, EXAMINE_MERGED_TOPIC, false);
  97     }
  98     table[uri.spec] = obj;
  99 }
 100
 101 provide("mime-type-override");