125 lines
3.4 KiB
C++
125 lines
3.4 KiB
C++
/* === This file is part of Calamares - <https://calamares.io> ===
|
|
*
|
|
* SPDX-FileCopyrightText: 2018-2019 Adriaan de Groot <groot@kde.org>
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* Calamares is Free Software: see the License-Identifier above.
|
|
*
|
|
*/
|
|
|
|
#ifndef GEOIP_INTERFACE_H
|
|
#define GEOIP_INTERFACE_H
|
|
|
|
#include "DllMacro.h"
|
|
|
|
#include <QDebug>
|
|
#include <QString>
|
|
#include <QUrl>
|
|
|
|
#include <tuple>
|
|
|
|
class QByteArray;
|
|
|
|
namespace Calamares
|
|
{
|
|
namespace GeoIP
|
|
{
|
|
/** @brief A Region, Zone pair of strings
|
|
*
|
|
* A GeoIP lookup returns a timezone, which is represented as a Region,
|
|
* Zone pair of strings (e.g. "Europe" and "Amsterdam"). Generally,
|
|
* pasting the strings back together with a "/" is the right thing to
|
|
* do. The Zone **may** contain a "/" (e.g. "Kentucky/Monticello").
|
|
*/
|
|
class DLLEXPORT RegionZonePair
|
|
{
|
|
public:
|
|
/** @brief Construct from two strings, like qMakePair(). */
|
|
RegionZonePair( const QString& region, const QString& zone )
|
|
: m_region( region )
|
|
, m_zone( zone )
|
|
{
|
|
}
|
|
|
|
/** @brief Construct from an existing pair. */
|
|
RegionZonePair( const RegionZonePair& p )
|
|
: RegionZonePair( p.m_region, p.m_zone )
|
|
{
|
|
}
|
|
|
|
/** @brief An invalid zone pair (empty strings). */
|
|
RegionZonePair() = default;
|
|
|
|
bool isValid() const { return !m_region.isEmpty(); }
|
|
|
|
QString region() const { return m_region; }
|
|
QString zone() const { return m_zone; }
|
|
|
|
friend bool operator==( const RegionZonePair& lhs, const RegionZonePair& rhs ) noexcept
|
|
{
|
|
return std::tie( lhs.m_region, lhs.m_zone ) == std::tie( rhs.m_region, rhs.m_zone );
|
|
}
|
|
|
|
private:
|
|
QString m_region;
|
|
QString m_zone;
|
|
};
|
|
|
|
inline QDebug&
|
|
operator<<( QDebug&& s, const RegionZonePair& tz )
|
|
{
|
|
return s << tz.region() << '/' << tz.zone();
|
|
}
|
|
|
|
inline QDebug&
|
|
operator<<( QDebug& s, const RegionZonePair& tz )
|
|
{
|
|
return s << tz.region() << '/' << tz.zone();
|
|
}
|
|
|
|
/** @brief Splits a region/zone string into a pair.
|
|
*
|
|
* Cleans up the string by removing backslashes (\\)
|
|
* since some providers return silly-escaped names. Replaces
|
|
* spaces with _ since some providers return human-readable names.
|
|
* Splits on the first / in the resulting string, or returns a
|
|
* pair of empty QStrings if it can't. (e.g. America/North Dakota/Beulah
|
|
* will return "America", "North_Dakota/Beulah").
|
|
*/
|
|
DLLEXPORT RegionZonePair splitTZString( const QString& s );
|
|
|
|
/**
|
|
* @brief Interface for GeoIP retrievers.
|
|
*
|
|
* A GeoIP retriever takes a configured URL (from the config file)
|
|
* and can handle the data returned from its interpretation of that
|
|
* configured URL, returning a region and zone.
|
|
*/
|
|
class DLLEXPORT Interface
|
|
{
|
|
public:
|
|
virtual ~Interface();
|
|
|
|
/** @brief Handle a (successful) request by interpreting the data.
|
|
*
|
|
* Should return a ( <zone>, <region> ) pair, e.g.
|
|
* ( "Europe", "Amsterdam" ). This is called **only** if the
|
|
* request to the fullUrl was successful; the handler
|
|
* is free to read as much, or as little, data as it
|
|
* likes. On error, returns a RegionZonePair with empty
|
|
* strings (e.g. ( "", "" ) ).
|
|
*/
|
|
virtual RegionZonePair processReply( const QByteArray& ) = 0;
|
|
|
|
/** @brief Get the raw reply data. */
|
|
virtual QString rawReply( const QByteArray& ) = 0;
|
|
|
|
protected:
|
|
Interface( const QString& element = QString() );
|
|
|
|
QString m_element; // string for selecting from data
|
|
};
|
|
|
|
} // namespace GeoIP
|
|
} // namespace Calamares
|
|
#endif
|