qBittorrent/src/base/digest32.h

/*
 * Bittorrent Client using Qt and libtorrent.
 * Copyright (C) 2015, 2021  Vladimir Golovnev <glassez@yandex.ru>
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link this program with the OpenSSL project's "OpenSSL" library (or with
 * modified versions of it that use the same license as the "OpenSSL" library),
 * and distribute the linked executables. You must obey the GNU General Public
 * License in all respects for all of the code used other than "OpenSSL".  If you
 * modify file(s), you may extend this exception to your version of the file(s),
 * but you are not obligated to do so. If you do not wish to do so, delete this
 * exception statement from your version.
 */

#pragma once

#include <libtorrent/sha1_hash.hpp>

#include <QtGlobal>
#include <QByteArray>
#include <QHash>
#include <QSharedData>
#include <QSharedDataPointer>
#include <QString>

template <int N>
class Digest32
{
public:
    using UnderlyingType = lt::digest32<N>;

    Digest32() = default;
    Digest32(const Digest32 &other) = default;
    Digest32(Digest32 &&other) = default;

    Digest32(const UnderlyingType &nativeDigest)
        : m_dataPtr {new Data(nativeDigest)}
    {
    }

    static constexpr int length()
    {
        return UnderlyingType::size();
    }

    bool isValid() const
    {
        return m_dataPtr->isValid();
    }

    Digest32 &operator=(const Digest32 &other) = default;
    Digest32 &operator=(Digest32 &&other) = default;

    operator UnderlyingType() const
    {
        return m_dataPtr->nativeDigest();
    }

    QString toString() const
    {
        return m_dataPtr->hashString();
    }

    static Digest32 fromString(const QString &digestString)
    {
        return Digest32(QSharedDataPointer<Data>(new Data(digestString)));
    }

private:
    class Data;

    explicit Digest32(QSharedDataPointer<Data> dataPtr)
        : m_dataPtr {dataPtr}
    {
    }

    QSharedDataPointer<Data> m_dataPtr {new Data};
};

template <int N>
class Digest32<N>::Data : public QSharedData
{
public:
    Data() = default;

    explicit Data(UnderlyingType nativeDigest)
        : m_isValid {true}
        , m_nativeDigest {nativeDigest}
    {
    }

    explicit Data(const QString &digestString)
    {
        if (digestString.size() != (length() * 2))
            return;

        const QByteArray raw = QByteArray::fromHex(digestString.toLatin1());
        if (raw.size() != length())  // QByteArray::fromHex() will skip over invalid characters
            return;

        m_isValid = true;
        m_hashString = digestString;
        m_nativeDigest.assign(raw.constData());
    }

    bool isValid() const { return m_isValid; }
    UnderlyingType nativeDigest() const { return m_nativeDigest; }

    QString hashString() const
    {
        if (m_hashString.isEmpty() && isValid())
        {
            const QByteArray raw = QByteArray::fromRawData(m_nativeDigest.data(), length());
            m_hashString = QString::fromLatin1(raw.toHex());
        }

        return m_hashString;
    }

private:
    bool m_isValid = false;
    UnderlyingType m_nativeDigest;
    mutable QString m_hashString;
};

template <int N>
bool operator==(const Digest32<N> &left, const Digest32<N> &right)
{
    return (static_cast<typename Digest32<N>::UnderlyingType>(left)
            == static_cast<typename Digest32<N>::UnderlyingType>(right));
}

template <int N>
bool operator!=(const Digest32<N> &left, const Digest32<N> &right)
{
    return !(left == right);
}

template <int N>
bool operator<(const Digest32<N> &left, const Digest32<N> &right)
{
    return static_cast<typename Digest32<N>::UnderlyingType>(left)
            < static_cast<typename Digest32<N>::UnderlyingType>(right);
}

#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
template <int N>
std::size_t qHash(const Digest32<N> &key, const std::size_t seed = 0)
{
    return ::qHash(static_cast<typename Digest32<N>::UnderlyingType>(key), seed);
}
#else
template <int N>
uint qHash(const Digest32<N> &key, const uint seed = 0)
{
    return static_cast<uint>((std::hash<typename Digest32<N>::UnderlyingType> {})(key)) ^ seed;
}
#endif