summaryrefslogtreecommitdiffstats
path: root/chrome/browser/net/url_fixer_upper.h
blob: 6113cf804b164867e00c08f8b14b45f5d347f3b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_URL_FIXER_UPPER_H__
#define CHROME_BROWSER_URL_FIXER_UPPER_H__

#include <string>

#include "googleurl/src/url_parse.h"

class FilePath;

// This object is designed to convert various types of input into URLs that we
// know are valid. For example, user typing in the URL bar or command line
// options. This is NOT the place for converting between different types of
// URLs or parsing them, see net_util.h for that.
namespace URLFixerUpper {

  // Segments the given text string into parts of a URL.  This is most useful
  // for schemes such as http, https, and ftp where |SegmentURL| will find many
  // segments.  Currently does not segment "file" schemes.
  std::string SegmentURL(const std::string& text, url_parse::Parsed* parts);
  // Deprecated temporary compatibility function.
  std::wstring SegmentURL(const std::wstring& text, url_parse::Parsed* parts);


  // Converts |text| to a fixed-up URL and returns it. Attempts to make
  // some "smart" adjustments to obviously-invalid input where possible.
  // |text| may be an absolute path to a file, which will get converted to a
  // "file:" URL.
  //
  // The result will be a "more" valid URL than the input. It may still not
  // be valid, convert to a GURL for that.
  //
  // If |desired_tld| is non-empty, it represents the TLD the user wishes to
  // append in the case of an incomplete domain.  We check that this is not a
  // file path and there does not appear to be a valid TLD already, then append
  // |desired_tld| to the domain and prepend "www." (unless it, or a scheme,
  // are already present.)  This TLD should not have a leading '.' (use "com"
  // instead of ".com").
  std::string FixupURL(const std::string& text,
                       const std::string& desired_tld);
  // Deprecated temporary compatibility function.
  std::wstring FixupURL(const std::wstring& text,
                        const std::wstring& desired_tld);

  // Converts |text| to a fixed-up URL, allowing it to be a relative path on
  // the local filesystem.  Begin searching in |base_dir|; if empty, use the
  // current working directory.  If this resolves to a file on disk, convert it
  // to a "file:" URL in |fixed_up_url|; otherwise, fall back to the behavior
  // of FixupURL().
  //
  // For "regular" input, even if it is possibly a file with a full path, you
  // should use FixupURL() directly.  This function should only be used when
  // relative path handling is desired, as for command line processing.
  std::string FixupRelativeFile(const FilePath& base_dir,
                                const FilePath& text);
  // Deprecated temporary compatibility function.
  std::wstring FixupRelativeFile(const std::wstring& base_dir,
                                 const std::wstring& text);

};

#endif  // #ifndef CHROME_BROWSER_URL_FIXER_UPPER_H__