third_party/WebKit/Source/platform/weborigin/KURL.h

/*
 * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2011, 2012 Apple Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef KURL_h
#define KURL_h

#include "platform/PlatformExport.h"
#include "url/third_party/mozilla/url_parse.h"
#include "url/url_canon.h"
#include "wtf/Allocator.h"
#include "wtf/Forward.h"
#include "wtf/HashTableDeletedValueType.h"
#include "wtf/text/WTFString.h"
#include <memory>

namespace WTF {
class TextEncoding;
}

namespace blink {

struct KURLHash;

enum ParsedURLStringTag { ParsedURLString };

class PLATFORM_EXPORT KURL {
  USING_FAST_MALLOC(KURL);

 public:
  // This must be called during initialization (before we create
  // other threads).
  static void initialize();

  KURL();
  KURL(const KURL&);
  KURL& operator=(const KURL&);

  // The argument is an absolute URL string. The string is assumed to be
  // output of KURL::string() called on a valid KURL object, or indiscernible
  // from such. It is usually best to avoid repeatedly parsing a string,
  // unless memory saving outweigh the possible slow-downs.
  KURL(ParsedURLStringTag, const String&);
  explicit KURL(WTF::HashTableDeletedValueType);

  // Creates an isolated URL object suitable for sending to another thread.
  static KURL createIsolated(ParsedURLStringTag, const String&);

  bool isHashTableDeletedValue() const {
    return getString().isHashTableDeletedValue();
  }

  // Resolves the relative URL with the given base URL. If provided, the
  // TextEncoding is used to encode non-ASCII characers. The base URL can be
  // null or empty, in which case the relative URL will be interpreted as
  // absolute.
  // FIXME: If the base URL is invalid, this always creates an invalid
  // URL. Instead I think it would be better to treat all invalid base URLs
  // the same way we treate null and empty base URLs.
  KURL(const KURL& base, const String& relative);
  KURL(const KURL& base, const String& relative, const WTF::TextEncoding&);

  // For conversions from other structures that have already parsed and
  // canonicalized the URL. The input must be exactly what KURL would have
  // done with the same input.
  KURL(const AtomicString& canonicalString, const url::Parsed&, bool isValid);

  ~KURL();

  String strippedForUseAsReferrer() const;
  String strippedForUseAsHref() const;

  // FIXME: The above functions should be harmonized so that passing a
  // base of null or the empty string gives the same result as the
  // standard String constructor.

  // Makes a deep copy. Helpful only if you need to use a KURL on another
  // thread. Since the underlying StringImpl objects are immutable, there's
  // no other reason to ever prefer copy() over plain old assignment.
  KURL copy() const;

  bool isNull() const;
  bool isEmpty() const;
  bool isValid() const;

  // Returns true if this URL has a path. Note that "http://foo.com/" has a
  // path of "/", so this function will return true. Only invalid or
  // non-hierarchical (like "javascript:") URLs will have no path.
  bool hasPath() const;

  // Returns true if you can set the host and port for the URL.
  // Non-hierarchical URLs don't have a host and port.
  bool canSetHostOrPort() const { return isHierarchical(); }

  bool canSetPathname() const { return isHierarchical(); }
  bool isHierarchical() const;

  const String& getString() const { return m_string; }

  String elidedString() const;

  String protocol() const;
  String host() const;
  unsigned short port() const;
  bool hasPort() const;
  String user() const;
  String pass() const;
  String path() const;
  // This method handles "parameters" separated by a semicolon.
  String lastPathComponent() const;
  String query() const;
  String fragmentIdentifier() const;
  bool hasFragmentIdentifier() const;

  String baseAsString() const;

  // Returns true if the current URL's protocol is the same as the null-
  // terminated ASCII argument. The argument must be lower-case.
  bool protocolIs(const char*) const;
  bool protocolIsData() const { return protocolIs("data"); }
  // This includes at least about:blank and about:srcdoc.
  bool protocolIsAbout() const { return protocolIs("about"); }
  bool protocolIsInHTTPFamily() const;
  bool isLocalFile() const;
  bool isAboutBlankURL() const;   // Is exactly about:blank.
  bool isAboutSrcdocURL() const;  // Is exactly about:srcdoc.

  bool setProtocol(const String&);
  void setHost(const String&);

  void removePort();
  void setPort(unsigned short);
  void setPort(const String&);

  // Input is like "foo.com" or "foo.com:8000".
  void setHostAndPort(const String&);

  void setUser(const String&);
  void setPass(const String&);

  // If you pass an empty path for HTTP or HTTPS URLs, the resulting path
  // will be "/".
  void setPath(const String&);

  // The query may begin with a question mark, or, if not, one will be added
  // for you. Setting the query to the empty string will leave a "?" in the
  // URL (with nothing after it). To clear the query, pass a null string.
  void setQuery(const String&);

  void setFragmentIdentifier(const String&);
  void removeFragmentIdentifier();

  PLATFORM_EXPORT friend bool equalIgnoringFragmentIdentifier(const KURL&,
                                                              const KURL&);

  unsigned hostStart() const;
  unsigned hostEnd() const;

  unsigned pathStart() const;
  unsigned pathEnd() const;
  unsigned pathAfterLastSlash() const;

  operator const String&() const { return getString(); }
  operator StringView() const { return StringView(getString()); }

  const url::Parsed& parsed() const { return m_parsed; }

  const KURL* innerURL() const { return m_innerURL.get(); }

  bool isSafeToSendToAnotherThread() const;

 private:
  void init(const KURL& base,
            const String& relative,
            const WTF::TextEncoding* queryEncoding);

  String componentString(const url::Component&) const;
  String stringForInvalidComponent() const;

  template <typename CHAR>
  void replaceComponents(const url::Replacements<CHAR>&);

  template <typename CHAR>
  void init(const KURL& base,
            const CHAR* relative,
            int relativeLength,
            const WTF::TextEncoding* queryEncoding);
  void initInnerURL();
  void initProtocolIsInHTTPFamily();

  bool m_isValid;
  bool m_protocolIsInHTTPFamily;
  url::Parsed m_parsed;
  String m_string;
  std::unique_ptr<KURL> m_innerURL;
};

PLATFORM_EXPORT bool operator==(const KURL&, const KURL&);
PLATFORM_EXPORT bool operator==(const KURL&, const String&);
PLATFORM_EXPORT bool operator==(const String&, const KURL&);
PLATFORM_EXPORT bool operator!=(const KURL&, const KURL&);
PLATFORM_EXPORT bool operator!=(const KURL&, const String&);
PLATFORM_EXPORT bool operator!=(const String&, const KURL&);

PLATFORM_EXPORT bool equalIgnoringFragmentIdentifier(const KURL&, const KURL&);

PLATFORM_EXPORT const KURL& blankURL();
PLATFORM_EXPORT const KURL& srcdocURL();

// Functions to do URL operations on strings.
// These are operations that aren't faster on a parsed URL.
// These are also different from the KURL functions in that they don't require
// the string to be a valid and parsable URL.  This is especially important
// because valid javascript URLs are not necessarily considered valid by KURL.

PLATFORM_EXPORT bool protocolIs(const String& url, const char* protocol);
PLATFORM_EXPORT bool protocolIsJavaScript(const String& url);

PLATFORM_EXPORT bool isValidProtocol(const String&);

// Unescapes the given string using URL escaping rules, given an optional
// encoding (defaulting to UTF-8 otherwise).
//
// DANGER: If the URL has "%00" in it, the resulting string will have embedded
// null characters!
//
// This function is also used to decode javascript: URLs and as a general
// purpose unescaping function.
PLATFORM_EXPORT String decodeURLEscapeSequences(const String&);
PLATFORM_EXPORT String decodeURLEscapeSequences(const String&,
                                                const WTF::TextEncoding&);

PLATFORM_EXPORT String encodeWithURLEscapeSequences(const String&);

// Inlines.

inline bool operator==(const KURL& a, const KURL& b) {
  return a.getString() == b.getString();
}

inline bool operator==(const KURL& a, const String& b) {
  return a.getString() == b;
}

inline bool operator==(const String& a, const KURL& b) {
  return a == b.getString();
}

inline bool operator!=(const KURL& a, const KURL& b) {
  return a.getString() != b.getString();
}

inline bool operator!=(const KURL& a, const String& b) {
  return a.getString() != b;
}

inline bool operator!=(const String& a, const KURL& b) {
  return a != b.getString();
}

}  // namespace blink

namespace WTF {

// KURLHash is the default hash for String
template <>
struct DefaultHash<blink::KURL> {
  typedef blink::KURLHash Hash;
};

}  // namespace WTF

#endif  // KURL_h