chrome/nsChromeProtocolHandler.cpp

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=4 sw=2 sts=2 et cin: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /*
   8
   9   A protocol handler for ``chrome:''
  10
  11 */
  12
  13 #include "nsChromeProtocolHandler.h"
  14 #include "nsChromeRegistry.h"
  15 #include "nsCOMPtr.h"
  16 #include "nsContentUtils.h"
  17 #include "nsThreadUtils.h"
  18 #include "nsIChannel.h"
  19 #include "nsIChromeRegistry.h"
  20 #include "nsIFile.h"
  21 #include "nsIFileChannel.h"
  22 #include "nsIStandardURL.h"
  23 #include "nsNetUtil.h"
  24 #include "nsNetCID.h"
  25 #include "nsIURL.h"
  26 #include "nsString.h"
  27 #include "nsStandardURL.h"
  28
  29 ////////////////////////////////////////////////////////////////////////////////
  30
  31 NS_IMPL_ISUPPORTS(nsChromeProtocolHandler, nsIProtocolHandler,
  32                   nsISupportsWeakReference)
  33
  34 ////////////////////////////////////////////////////////////////////////////////
  35 // nsIProtocolHandler methods:
  36
  37 NS_IMETHODIMP
  38 nsChromeProtocolHandler::GetScheme(nsACString& result) {
  39   result.AssignLiteral("chrome");
  40   return NS_OK;
  41 }
  42
  43 NS_IMETHODIMP
  44 nsChromeProtocolHandler::GetDefaultPort(int32_t* result) {
  45   *result = -1;  // no port for chrome: URLs
  46   return NS_OK;
  47 }
  48
  49 NS_IMETHODIMP
  50 nsChromeProtocolHandler::AllowPort(int32_t port, const char* scheme,
  51                                    bool* _retval) {
  52   // don't override anything.
  53   *_retval = false;
  54   return NS_OK;
  55 }
  56
  57 NS_IMETHODIMP
  58 nsChromeProtocolHandler::GetProtocolFlags(uint32_t* result) {
  59   *result = URI_STD | URI_IS_UI_RESOURCE | URI_IS_LOCAL_RESOURCE;
  60   return NS_OK;
  61 }
  62
  63 /* static */ nsresult nsChromeProtocolHandler::CreateNewURI(
  64     const nsACString& aSpec, const char* aCharset, nsIURI* aBaseURI,
  65     nsIURI** result) {
  66   // Chrome: URLs (currently) have no additional structure beyond that provided
  67   // by standard URLs, so there is no "outer" given to CreateInstance
  68   nsresult rv;
  69   nsCOMPtr<nsIURI> surl;
  70   nsCOMPtr<nsIURI> base(aBaseURI);
  71   rv = NS_MutateURI(new mozilla::net::nsStandardURL::Mutator())
  72            .Apply(NS_MutatorMethod(&nsIStandardURLMutator::Init,
  73                                    nsIStandardURL::URLTYPE_STANDARD, -1,
  74                                    nsCString(aSpec), aCharset, base, nullptr))
  75            .Finalize(surl);
  76   if (NS_FAILED(rv)) {
  77     return rv;
  78   }
  79
  80   // Canonify the "chrome:" URL; e.g., so that we collapse
  81   // "chrome://navigator/content/" and "chrome://navigator/content"
  82   // and "chrome://navigator/content/navigator.xul".
  83
  84   rv = nsChromeRegistry::Canonify(surl);
  85   if (NS_FAILED(rv)) return rv;
  86
  87   surl.forget(result);
  88   return NS_OK;
  89 }
  90
  91 NS_IMETHODIMP
  92 nsChromeProtocolHandler::NewChannel(nsIURI* aURI, nsILoadInfo* aLoadInfo,
  93                                     nsIChannel** aResult) {
  94   nsresult rv;
  95
  96   NS_ENSURE_ARG_POINTER(aURI);
  97   NS_ENSURE_ARG_POINTER(aLoadInfo);
  98
  99   MOZ_ASSERT(aResult, "Null out param");
 100
 101 #ifdef DEBUG
 102   // Check that the uri we got is already canonified
 103   nsresult debug_rv;
 104   nsCOMPtr<nsIURI> debugURL = aURI;
 105   debug_rv = nsChromeRegistry::Canonify(debugURL);
 106   if (NS_SUCCEEDED(debug_rv)) {
 107     bool same;
 108     debug_rv = aURI->Equals(debugURL, &same);
 109     if (NS_SUCCEEDED(debug_rv)) {
 110       NS_ASSERTION(same,
 111                    "Non-canonified chrome uri passed to "
 112                    "nsChromeProtocolHandler::NewChannel!");
 113     }
 114   }
 115 #endif
 116
 117   nsCOMPtr<nsIChannel> result;
 118
 119   if (!nsChromeRegistry::gChromeRegistry) {
 120     // We don't actually want this ref, we just want the service to
 121     // initialize if it hasn't already.
 122     nsCOMPtr<nsIChromeRegistry> reg = mozilla::services::GetChromeRegistry();
 123     NS_ENSURE_TRUE(nsChromeRegistry::gChromeRegistry, NS_ERROR_FAILURE);
 124   }
 125
 126   nsCOMPtr<nsIURI> resolvedURI;
 127   rv = nsChromeRegistry::gChromeRegistry->ConvertChromeURL(
 128       aURI, getter_AddRefs(resolvedURI));
 129   if (NS_FAILED(rv)) {
 130 #ifdef DEBUG
 131     printf("Couldn't convert chrome URL: %s\n", aURI->GetSpecOrDefault().get());
 132 #endif
 133     return rv;
 134   }
 135
 136   // We don't want to allow the inner protocol handler modify the result
 137   // principal URI since we want either |aURI| or anything pre-set by upper
 138   // layers to prevail.
 139   nsCOMPtr<nsIURI> savedResultPrincipalURI;
 140   rv =
 141       aLoadInfo->GetResultPrincipalURI(getter_AddRefs(savedResultPrincipalURI));
 142   NS_ENSURE_SUCCESS(rv, rv);
 143
 144   rv = NS_NewChannelInternal(getter_AddRefs(result), resolvedURI, aLoadInfo);
 145   NS_ENSURE_SUCCESS(rv, rv);
 146
 147 #ifdef DEBUG
 148   nsCOMPtr<nsIFileChannel> fileChan(do_QueryInterface(result));
 149   if (fileChan) {
 150     nsCOMPtr<nsIFile> file;
 151     fileChan->GetFile(getter_AddRefs(file));
 152
 153     bool exists = false;
 154     file->Exists(&exists);
 155     if (!exists) {
 156       printf("Chrome file doesn't exist: %s\n",
 157              file->HumanReadablePath().get());
 158     }
 159   }
 160 #endif
 161
 162   // Make sure that the channel remembers where it was
 163   // originally loaded from.
 164   rv = aLoadInfo->SetResultPrincipalURI(savedResultPrincipalURI);
 165   NS_ENSURE_SUCCESS(rv, rv);
 166   rv = result->SetOriginalURI(aURI);
 167   if (NS_FAILED(rv)) return rv;
 168
 169   // Get a system principal for content files and set the owner
 170   // property of the result
 171   nsCOMPtr<nsIURL> url = do_QueryInterface(aURI);
 172   nsAutoCString path;
 173   rv = url->GetPathQueryRef(path);
 174   if (StringBeginsWith(path, "/content/"_ns)) {
 175     result->SetOwner(nsContentUtils::GetSystemPrincipal());
 176   }
 177
 178   // XXX Removed dependency-tracking code from here, because we're not
 179   // tracking them anyways (with fastload we checked only in DEBUG
 180   // and with startupcache not at all), but this is where we would start
 181   // if we need to re-add.
 182   // See bug 531886, bug 533038.
 183   result->SetContentCharset("UTF-8"_ns);
 184
 185   *aResult = result;
 186   NS_ADDREF(*aResult);
 187   return NS_OK;
 188 }
 189
 190 ////////////////////////////////////////////////////////////////////////////////