mojo/runner/url_resolver.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef MOJO_RUNNER_URL_RESOLVER_H_
   6 #define MOJO_RUNNER_URL_RESOLVER_H_
   7
   8 #include <map>
   9 #include <set>
  10
  11 #include "base/basictypes.h"
  12 #include "base/command_line.h"
  13 #include "base/files/file_path.h"
  14 #include "url/gurl.h"
  15
  16 namespace mojo {
  17 namespace runner {
  18
  19 // This class supports the mapping of URLs to other URLs.
  20 // It's commonly used with mojo: URL, to provide a physical location (i.e.
  21 // file: or https:) but works with any URL.
  22 // By default, "mojo:" URLs resolve to a file location, with ".mojo" appended,
  23 // but that resolution can be customized via the AddCustomMapping method.
  24 class URLResolver {
  25  public:
  26   URLResolver();
  27   ~URLResolver();
  28
  29   // Used for the return value of GetOriginMappings().
  30   struct OriginMapping {
  31     OriginMapping(const std::string& origin, const std::string& base_url)
  32         : origin(origin), base_url(base_url) {}
  33
  34     std::string origin;
  35     std::string base_url;
  36   };
  37
  38   // Returns a list of origin mappings based on command line args.
  39   // The switch --map-origin can be specified multiple times. Each occurance
  40   // has the format of --map-origin={origin}={base_url}
  41   // For example:
  42   //   --map-origin=http://domokit.org=file:///source/out
  43   static std::vector<OriginMapping> GetOriginMappings(
  44       const base::CommandLine::StringVector& argv);
  45
  46   // Add a custom mapping for a particular URL. If |mapped_url| is
  47   // itself a mojo url normal resolution rules apply.
  48   void AddURLMapping(const GURL& url, const GURL& mapped_url);
  49
  50   // Add a custom mapping for all urls rooted at |origin|.
  51   void AddOriginMapping(const GURL& origin, const GURL& base_url);
  52
  53   // Applies all custom mappings for |url|, returning the last non-mapped url.
  54   // For example, if 'a' maps to 'b' and 'b' maps to 'c' calling this with 'a'
  55   // returns 'c'.
  56   GURL ApplyMappings(const GURL& url) const;
  57
  58   // If specified, then "mojo:" URLs will be resolved relative to this
  59   // URL. That is, the portion after the colon will be appeneded to
  60   // |mojo_base_url| with .mojo appended.
  61   void SetMojoBaseURL(const GURL& mojo_base_url);
  62
  63   // Resolve the given "mojo:" URL to the URL that should be used to fetch the
  64   // code for the corresponding Mojo App.
  65   GURL ResolveMojoURL(const GURL& mojo_url) const;
  66
  67  private:
  68   using GURLToGURLMap = std::map<GURL, GURL>;
  69   GURLToGURLMap url_map_;
  70   GURLToGURLMap origin_map_;
  71   GURL mojo_base_url_;
  72
  73   DISALLOW_COPY_AND_ASSIGN(URLResolver);
  74 };
  75
  76 }  // namespace runner
  77 }  // namespace mojo
  78
  79 #endif  // MOJO_RUNNER_URL_RESOLVER_H_