lluri.h

Go to the documentation of this file.

#ifndef LL_LLURI_H
#define LL_LLURI_H

#include <string>

class LLSD;
class LLUUID;
class LLApp;

class LLURI
{
public:
  LLURI();
  LLURI(const std::string& escaped_str);
  LLURI(const std::string& scheme,
                const std::string& userName,
                const std::string& password,
                const std::string& hostName,
                U16 hostPort,
                const std::string& escapedPath,
                const std::string& escapedQuery);
          
  // construct from escaped string, as would be transmitted on the net

        ~LLURI();

        static LLURI buildHTTP(
                const std::string& prefix,
                const LLSD& path);

        static LLURI buildHTTP(
                const std::string& prefix,
                const LLSD& path,
                const LLSD& query);

        static LLURI buildHTTP(
                const std::string& host,
                const U32& port,
                const LLSD& path);
        static LLURI buildHTTP(
                const std::string& host,
                const U32& port,
                const LLSD& path,
                const LLSD& query);

        std::string asString() const;
  
        // These functions return parts of the decoded URI.  The returned
        // strings are un-escaped as needed
  
        // for all schemes
        std::string scheme() const;             
        std::string opaque() const;             
  
  // for schemes that follow path like syntax (http, https, ftp)
  std::string authority() const;        // ex.: "host.com:80"
  std::string hostName() const; // ex.: "host.com"
  std::string userName() const;
  std::string password() const;
  U16 hostPort() const;                 // ex.: 80, will include implicit port
  BOOL defaultPort() const;             // true if port is default for scheme
  const std::string& escapedPath() const { return mEscapedPath; }
  std::string path() const;             // ex.: "/abc/def", includes leading slash
  LLSD pathArray() const;                       // above decoded into an array of strings
  std::string query() const;            // ex.: "x=34", section after "?"
  const std::string& escapedQuery() const { return mEscapedQuery; }
  LLSD queryMap() const;                        // above decoded into a map
  static LLSD queryMap(std::string escaped_query_string);

        static std::string mapToQueryString(const LLSD& query_map);

        static std::string escape(const std::string& str);

        static std::string escape(
                const std::string& str,
                const std::string& allowed,
                bool is_allowed_sorted = false);

        static std::string unescape(const std::string& str);

private:
         // only "http", "https", "ftp", and "secondlife" schemes are parsed
         // secondlife scheme parses authority as "" and includes it as part of
         // the path.  See lluri_tut.cpp
         // i.e. secondlife://app/login has mAuthority = "" and mPath = "/app/login"
        void parseAuthorityAndPathUsingOpaque();
        std::string mScheme;
        std::string mEscapedOpaque;
        std::string mEscapedAuthority;
        std::string mEscapedPath;
        std::string mEscapedQuery;
};

#endif // LL_LLURI_H

---