PoolURI.h

/*
    This file is part of ethminer.

    ethminer is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    ethminer is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with ethminer.  If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include <string>
#include <regex>

#include <boost/asio.hpp>

// A simple URI parser specifically for mining pool endpoints
namespace dev
{
enum class SecureLevel
{
    NONE = 0,
    TLS12,
    TLS
};
enum class ProtocolFamily
{
    GETWORK = 0,
    STRATUM
};

enum class UriHostNameType
{
    Unknown = 0,
    Basic = 1,
    Dns = 2,
    IPV4 = 3,
    IPV6 = 4
};

class URI
{
public:
    URI() = delete;
    URI(const std::string uri);

    std::string Scheme() const { return m_scheme; }
    std::string Host() const { return m_host; }
    std::string Path() const { return m_path; }
    unsigned short Port() const { return m_port; }
    std::string User() const { return m_username; }
    std::string Pass() const { return m_password; }
    std::string Workername() const { return m_workername; }
    SecureLevel SecLevel() const;
    ProtocolFamily Family() const;
    UriHostNameType HostNameType() const;
    unsigned Version() const;
    std::string str() const { return m_uri; }
    bool Valid() const { return m_valid; }

    bool KnownScheme();

    static std::string KnownSchemes(ProtocolFamily family);

    void SetStratumMode(unsigned mode, bool confirmed)
    {
        m_stratumMode = mode;
        m_stratumModeConfirmed = confirmed;
    }
    void SetStratumMode(unsigned mode) { m_stratumMode = mode; }
    unsigned StratumMode() { return m_stratumMode; }
    bool StratumModeConfirmed() { return m_stratumModeConfirmed; }
    bool IsUnrecoverable() { return m_unrecoverable; }
    void MarkUnrecoverable() { m_unrecoverable = true; }

private:
    std::string m_scheme;
    std::string m_host;
    std::string m_path;
    std::string m_query;
    std::string m_fragment;
    std::string m_username;
    std::string m_password;
    std::string m_workername;
    std::string m_uri;
    unsigned short m_stratumMode = 999;  // Initial value 999 means not tested yet
    unsigned short m_port = 0;
    bool m_valid = false;
    bool m_stratumModeConfirmed = false;
    bool m_unrecoverable = false;

    UriHostNameType m_hostType = UriHostNameType::Unknown;
};
}  // namespace dev