chrome/common/net/url_fixer_upper.h

   1 // Copyright (c) 2011 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 CHROME_COMMON_NET_URL_FIXER_UPPER_H_
   6 #define CHROME_COMMON_NET_URL_FIXER_UPPER_H_
   7
   8 #include <string>
   9
  10 #include "base/strings/string16.h"
  11 #include "url/gurl.h"
  12
  13 namespace base {
  14 class FilePath;
  15 }
  16
  17 namespace url_parse {
  18 struct Component;
  19 struct Parsed;
  20 }
  21
  22 // This object is designed to convert various types of input into URLs that we
  23 // know are valid. For example, user typing in the URL bar or command line
  24 // options. This is NOT the place for converting between different types of
  25 // URLs or parsing them, see net_util.h for that.
  26 namespace URLFixerUpper {
  27
  28   // Segments the given text string into parts of a URL.  This is most useful
  29   // for schemes such as http, https, and ftp where |SegmentURL| will find many
  30   // segments.  Currently does not segment "file" schemes.
  31   // Returns the canonicalized scheme, or the empty string when |text| is only
  32   // whitespace.
  33   std::string SegmentURL(const std::string& text, url_parse::Parsed* parts);
  34   base::string16 SegmentURL(const base::string16& text,
  35                             url_parse::Parsed* parts);
  36
  37   // Converts |text| to a fixed-up URL and returns it. Attempts to make
  38   // some "smart" adjustments to obviously-invalid input where possible.
  39   // |text| may be an absolute path to a file, which will get converted to a
  40   // "file:" URL.
  41   //
  42   // The result will be a "more" valid URL than the input. It may still not
  43   // be valid, so check the return value's validity or use
  44   // possibly_invalid_spec().
  45   //
  46   // Schemes "about" and "chrome" are normalized to "chrome://", with slashes.
  47   // "about:blank" is unaltered, as Webkit allows frames to access about:blank.
  48   // Additionally, if a chrome URL does not have a valid host, as in "about:",
  49   // the returned URL will have the host "version", as in "chrome://version".
  50   //
  51   // If |desired_tld| is non-empty, it represents the TLD the user wishes to
  52   // append in the case of an incomplete domain.  We check that this is not a
  53   // file path and there does not appear to be a valid TLD already, then append
  54   // |desired_tld| to the domain and prepend "www." (unless it, or a scheme,
  55   // are already present.)  This TLD should not have a leading '.' (use "com"
  56   // instead of ".com").
  57   GURL FixupURL(const std::string& text, const std::string& desired_tld);
  58
  59   // Converts |text| to a fixed-up URL, allowing it to be a relative path on
  60   // the local filesystem.  Begin searching in |base_dir|; if empty, use the
  61   // current working directory.  If this resolves to a file on disk, convert it
  62   // to a "file:" URL in |fixed_up_url|; otherwise, fall back to the behavior
  63   // of FixupURL().
  64   //
  65   // For "regular" input, even if it is possibly a file with a full path, you
  66   // should use FixupURL() directly.  This function should only be used when
  67   // relative path handling is desired, as for command line processing.
  68   GURL FixupRelativeFile(const base::FilePath& base_dir,
  69                          const base::FilePath& text);
  70
  71   // Offsets the beginning index of |part| by |offset|, which is allowed to be
  72   // negative.  In some cases, the desired component does not exist at the given
  73   // offset.  For example, when converting from "http://foo" to "foo", the
  74   // scheme component no longer exists.  In such a case, the beginning index is
  75   // set to 0.
  76   // Does nothing if |part| is invalid.
  77   void OffsetComponent(int offset, url_parse::Component* part);
  78
  79   // For paths like ~, we use $HOME for the current user's home
  80   // directory.  For tests, we allow our idea of $HOME to be overriden
  81   // by this variable.
  82   extern const char* home_directory_override;
  83
  84 }  // namespace URLFixerUpper
  85
  86 #endif  // CHROME_COMMON_NET_URL_FIXER_UPPER_H_