Url.h

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/anakod/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Url.h
 *
 * @author Feb 2019 mikee47 <mike@sillyhouse.net>
 *
 * Support added for escaped URLs and standard schemes.
 *
 * @see https://en.m.wikipedia.org/wiki/URL
 * @see https://en.m.wikipedia.org/wiki/URL_normalization
 *
 ****/

#ifndef _SMING_CORE_NETWORK_URL_H_
#define _SMING_CORE_NETWORK_URL_H_

#include "WString.h"
#include "Http/HttpParams.h"

/*
 * Common URL schemes (name, scheme, port)
 *  name:   Used for string identifier
 *  scheme: String to be used in a URL, normalised (i.e. lower case)
 *  port:   Offical default port definition for the scheme, 0 if not applicable
 */
#define URI_SCHEME_MAP(XX)                                                                                             \
    XX(HTTP, http, 80)                                                                                                 \
    XX(HTTP_SECURE, https, 443)                                                                                        \
    XX(WEBSOCKET, ws, 80)                                                                                              \
    XX(WEBSOCKET_SECURE, wss, 443)                                                                                     \
    XX(MQTT, mqtt, 1883)                                                                                               \
    XX(MQTT_SECURE, mqtts, 8883)                                                                                       \
    XX(SMTP, smtp, 25)                                                                                                 \
    XX(SMTP_SECURE, smtps, 465)                                                                                        \
    XX(FTP, ftp, 21)                                                                                                   \
    XX(MAIL_TO, mailto, 0)                                                                                             \
    XX(FILE, file, 0)                                                                                                  \
    XX(DATA, data, 0)

#define XX(name, str, port) DECLARE_FSTR(URI_SCHEME_##name)
URI_SCHEME_MAP(XX)
#undef XX

class Print;

class Url
{
public:
    Url() = default;

    Url(const Url& url) = default;

    Url(const String& urlString)
    {
        *this = urlString;
    }

    Url(const char* urlString) : Url(String(urlString))
    {
    }

    Url(const String& scheme, const String& user, const String& password, const String& host, int port = 0,
        const String& path = nullptr, const String& query = nullptr, const String& fragment = nullptr)
        : Scheme(scheme), User(user), Password(password), Host(host), Port(port), Path(path), Query(query),
          Fragment(fragment)
    {
        Scheme.toLowerCase();
        if(Port == 0) {
            Port = getDefaultPort(Scheme);
        }
    }

    Url& operator=(String urlString);

    Url& operator=(const char* urlString)
    {
        *this = String(urlString);
        return *this;
    }

    String toString() const;

    operator String() const
    {
        return toString();
    }

    static int getDefaultPort(const String& scheme);

    int getPort() const
    {
        return Port ?: getDefaultPort(Scheme);
    }

    String getHostWithPort() const;

    String getRelativePath() const
    {
        return (Path[0] == '/') ? Path.substring(1) : Path;
    }

    String getPathWithQuery() const;

    String getFileName() const;

    void debugPrintTo(Print& p) const;

public:
    String Scheme; 
    String User;
    String Password;
    String Host;  
    int Port = 0; 
    String Path;  
    HttpParams Query;
    String Fragment; 
};

typedef Url URL SMING_DEPRECATED; 

#endif /* _SMING_CORE_NETWORK_URL_H_ */