chrome/nsChromeProtocolHandler.cpp

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* vim:set ts=4 sw=4 sts=4 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 "nsThreadUtils.h"
  17 #include "nsIChannel.h"
  18 #include "nsIChromeRegistry.h"
  19 #include "nsIFile.h"
  20 #include "nsIFileChannel.h"
  21 #include "nsIIOService.h"
  22 #include "nsILoadGroup.h"
  23 #include "nsIScriptSecurityManager.h"
  24 #include "nsIStandardURL.h"
  25 #include "nsNetUtil.h"
  26 #include "nsString.h"
  27
  28 ////////////////////////////////////////////////////////////////////////////////
  29
  30 NS_IMPL_ISUPPORTS(nsChromeProtocolHandler,
  31                   nsIProtocolHandler,
  32                   nsISupportsWeakReference)
  33
  34 ////////////////////////////////////////////////////////////////////////////////
  35 // nsIProtocolHandler methods:
  36
  37 NS_IMETHODIMP
  38 nsChromeProtocolHandler::GetScheme(nsACString &result)
  39 {
  40     result.AssignLiteral("chrome");
  41     return NS_OK;
  42 }
  43
  44 NS_IMETHODIMP
  45 nsChromeProtocolHandler::GetDefaultPort(int32_t *result)
  46 {
  47     *result = -1;        // no port for chrome: URLs
  48     return NS_OK;
  49 }
  50
  51 NS_IMETHODIMP
  52 nsChromeProtocolHandler::AllowPort(int32_t port, const char *scheme, bool *_retval)
  53 {
  54     // don't override anything.
  55     *_retval = false;
  56     return NS_OK;
  57 }
  58
  59 NS_IMETHODIMP
  60 nsChromeProtocolHandler::GetProtocolFlags(uint32_t *result)
  61 {
  62     *result = URI_STD | URI_IS_UI_RESOURCE | URI_IS_LOCAL_RESOURCE;
  63     return NS_OK;
  64 }
  65
  66 NS_IMETHODIMP
  67 nsChromeProtocolHandler::NewURI(const nsACString &aSpec,
  68                                 const char *aCharset,
  69                                 nsIURI *aBaseURI,
  70                                 nsIURI **result)
  71 {
  72     nsresult rv;
  73
  74     // Chrome: URLs (currently) have no additional structure beyond that provided
  75     // by standard URLs, so there is no "outer" given to CreateInstance
  76
  77     nsCOMPtr<nsIStandardURL> surl(do_CreateInstance(NS_STANDARDURL_CONTRACTID, &rv));
  78     NS_ENSURE_SUCCESS(rv, rv);
  79
  80     rv = surl->Init(nsIStandardURL::URLTYPE_STANDARD, -1, aSpec, aCharset, aBaseURI);
  81     if (NS_FAILED(rv))
  82         return rv;
  83
  84     nsCOMPtr<nsIURL> url(do_QueryInterface(surl, &rv));
  85     NS_ENSURE_SUCCESS(rv, rv);
  86
  87     // Canonify the "chrome:" URL; e.g., so that we collapse
  88     // "chrome://navigator/content/" and "chrome://navigator/content"
  89     // and "chrome://navigator/content/navigator.xul".
  90
  91     rv = nsChromeRegistry::Canonify(url);
  92     if (NS_FAILED(rv))
  93         return rv;
  94
  95     surl->SetMutable(false);
  96
  97     NS_ADDREF(*result = url);
  98     return NS_OK;
  99 }
 100
 101 NS_IMETHODIMP
 102 nsChromeProtocolHandler::NewChannel2(nsIURI* aURI,
 103                                      nsILoadInfo* aLoadInfo,
 104                                      nsIChannel** aResult)
 105 {
 106     nsresult rv;
 107
 108     NS_ENSURE_ARG_POINTER(aURI);
 109     NS_PRECONDITION(aResult, "Null out param");
 110
 111 #ifdef DEBUG
 112     // Check that the uri we got is already canonified
 113     nsresult debug_rv;
 114     nsCOMPtr<nsIURI> debugClone;
 115     debug_rv = aURI->Clone(getter_AddRefs(debugClone));
 116     if (NS_SUCCEEDED(debug_rv)) {
 117         nsCOMPtr<nsIURL> debugURL (do_QueryInterface(debugClone));
 118         debug_rv = nsChromeRegistry::Canonify(debugURL);
 119         if (NS_SUCCEEDED(debug_rv)) {
 120             bool same;
 121             debug_rv = aURI->Equals(debugURL, &same);
 122             if (NS_SUCCEEDED(debug_rv)) {
 123                 NS_ASSERTION(same, "Non-canonified chrome uri passed to nsChromeProtocolHandler::NewChannel!");
 124             }
 125         }
 126     }
 127 #endif
 128
 129     nsCOMPtr<nsIChannel> result;
 130
 131     if (!nsChromeRegistry::gChromeRegistry) {
 132         // We don't actually want this ref, we just want the service to
 133         // initialize if it hasn't already.
 134         nsCOMPtr<nsIChromeRegistry> reg =
 135             mozilla::services::GetChromeRegistryService();
 136         NS_ENSURE_TRUE(nsChromeRegistry::gChromeRegistry, NS_ERROR_FAILURE);
 137     }
 138
 139     nsCOMPtr<nsIURI> resolvedURI;
 140     rv = nsChromeRegistry::gChromeRegistry->ConvertChromeURL(aURI, getter_AddRefs(resolvedURI));
 141     if (NS_FAILED(rv)) {
 142 #ifdef DEBUG
 143         nsAutoCString spec;
 144         aURI->GetSpec(spec);
 145         printf("Couldn't convert chrome URL: %s\n", spec.get());
 146 #endif
 147         return rv;
 148     }
 149
 150     // Bug 1087720 (and Bug 1099296):
 151     // Once all callsites have been updated to call NewChannel2() instead of NewChannel()
 152     // we should have a non-null loadInfo consistently. Until then we have to branch on the
 153     // loadInfo.
 154     if (aLoadInfo) {
 155         rv = NS_NewChannelInternal(getter_AddRefs(result),
 156                                    resolvedURI,
 157                                    aLoadInfo);
 158     }
 159     else {
 160         nsCOMPtr<nsIIOService> ioServ(do_GetIOService(&rv));
 161         NS_ENSURE_SUCCESS(rv, rv);
 162         rv = ioServ->NewChannelFromURI(resolvedURI, getter_AddRefs(result));
 163     }
 164     NS_ENSURE_SUCCESS(rv, rv);
 165
 166 #ifdef DEBUG
 167     nsCOMPtr<nsIFileChannel> fileChan(do_QueryInterface(result));
 168     if (fileChan) {
 169         nsCOMPtr<nsIFile> file;
 170         fileChan->GetFile(getter_AddRefs(file));
 171
 172         bool exists = false;
 173         file->Exists(&exists);
 174         if (!exists) {
 175             nsAutoCString path;
 176             file->GetNativePath(path);
 177             printf("Chrome file doesn't exist: %s\n", path.get());
 178         }
 179     }
 180 #endif
 181
 182     // Make sure that the channel remembers where it was
 183     // originally loaded from.
 184     nsLoadFlags loadFlags = 0;
 185     result->GetLoadFlags(&loadFlags);
 186     result->SetLoadFlags(loadFlags & ~nsIChannel::LOAD_REPLACE);
 187     rv = result->SetOriginalURI(aURI);
 188     if (NS_FAILED(rv)) return rv;
 189
 190     // Get a system principal for content files and set the owner
 191     // property of the result
 192     nsCOMPtr<nsIURL> url = do_QueryInterface(aURI);
 193     nsAutoCString path;
 194     rv = url->GetPath(path);
 195     if (StringBeginsWith(path, NS_LITERAL_CSTRING("/content/")))
 196     {
 197         nsCOMPtr<nsIScriptSecurityManager> securityManager =
 198                  do_GetService(NS_SCRIPTSECURITYMANAGER_CONTRACTID, &rv);
 199         if (NS_FAILED(rv)) return rv;
 200
 201         nsCOMPtr<nsIPrincipal> principal;
 202         rv = securityManager->GetSystemPrincipal(getter_AddRefs(principal));
 203         if (NS_FAILED(rv)) return rv;
 204
 205         nsCOMPtr<nsISupports> owner = do_QueryInterface(principal);
 206         result->SetOwner(owner);
 207     }
 208
 209     // XXX Removed dependency-tracking code from here, because we're not
 210     // tracking them anyways (with fastload we checked only in DEBUG
 211     // and with startupcache not at all), but this is where we would start
 212     // if we need to re-add.
 213     // See bug 531886, bug 533038.
 214     result->SetContentCharset(NS_LITERAL_CSTRING("UTF-8"));
 215
 216     *aResult = result;
 217     NS_ADDREF(*aResult);
 218     return NS_OK;
 219 }
 220
 221 NS_IMETHODIMP
 222 nsChromeProtocolHandler::NewChannel(nsIURI* aURI,
 223                                     nsIChannel* *aResult)
 224 {
 225   return NewChannel2(aURI, nullptr, aResult);
 226 }
 227
 228 ////////////////////////////////////////////////////////////////////////////////