calamares/src/modules/plasmalnf/ThemeInfo.cpp

/* === This file is part of Calamares - <https://calamares.io> ===
 *
 *   SPDX-FileCopyrightText: 2020 Adriaan de Groot <groot@kde.org>
 *   SPDX-License-Identifier: GPL-3.0-or-later
 *
 *   Calamares is Free Software: see the License-Identifier above.
 *
 */
#include "ThemeInfo.h"

#include "Branding.h"
#include "utils/CalamaresUtilsGui.h"
#include "utils/Logger.h"

#include <KPackage/Package>
#include <KPackage/PackageLoader>

#include <QDir>
#include <QFileInfo>
#include <QPixmap>

/** @brief describes a single plasma LnF theme.
 *
 * A theme description has an id, which is really the name of the desktop
 * file (e.g. org.kde.breeze.desktop), a name which is human-readable and
 * translated, and an optional image Page, which points to a local screenshot
 * of that theme.
 */
struct ThemeInfo
{
    QString id;
    QString name;
    QString description;
    QString imagePath;
    mutable QPixmap pixmap;
    bool show = true;
    bool selected = false;

    ThemeInfo() {}

    explicit ThemeInfo( const QString& _id )
        : id( _id )
    {
    }

    explicit ThemeInfo( const QString& _id, const QString& image )
        : id( _id )
        , imagePath( image )
    {
    }

    explicit ThemeInfo( const KPluginMetaData& );

    bool isValid() const { return !id.isEmpty(); }

    /// @brief Fill in the pixmap member based on imagePath
    QPixmap loadImage() const;
};

class ThemeInfoList : public QList< ThemeInfo >
{
public:
    std::pair< int, const ThemeInfo* > indexById( const QString& id ) const
    {
        int index = 0;
        for ( const ThemeInfo& i : *this )
        {
            if ( i.id == id )
            {
                return { index, &i };
            }
        }
        return { -1, nullptr };
    }

    std::pair< int, ThemeInfo* > indexById( const QString& id )
    {
        // Call the const version and then munge the types
        auto [ i, p ] = const_cast< const ThemeInfoList* >( this )->indexById( id );
        return { i, const_cast< ThemeInfo* >( p ) };
    }


    /** @brief Looks for a given @p id in the list of themes, returns nullptr if not found. */
    ThemeInfo* findById( const QString& id )
    {
        auto [ i, p ] = indexById( id );
        return p;
    }

    /** @brief Looks for a given @p id in the list of themes, returns nullptr if not found. */
    const ThemeInfo* findById( const QString& id ) const
    {
        auto [ i, p ] = indexById( id );
        return p;
    }

    /** @brief Checks if a given @p id is in the list of themes. */
    bool contains( const QString& id ) const { return findById( id ) != nullptr; }
};

ThemesModel::ThemesModel( QObject* parent )
    : QAbstractListModel( parent )
    , m_themes( new ThemeInfoList )
{
    auto packages = KPackage::PackageLoader::self()->listPackages( "Plasma/LookAndFeel" );
    m_themes->reserve( packages.length() );

    for ( const auto& p : packages )
    {
        m_themes->append( ThemeInfo { p } );
    }
}

int
ThemesModel::rowCount( const QModelIndex& ) const
{
    return m_themes->count();
}

QVariant
ThemesModel::data( const QModelIndex& index, int role ) const
{
    if ( !index.isValid() )
    {
        return QVariant();
    }
    if ( index.row() < 0 || index.row() >= m_themes->count() )
    {
        return QVariant();
    }

    const auto& item = m_themes->at( index.row() );
    switch ( role )
    {
    case LabelRole:
        return item.name;
    case KeyRole:
        return item.id;
    case ShownRole:
        return item.show;
    case SelectedRole:
        return item.selected;
    case DescriptionRole:
        return item.description;
    case ImageRole:
        return item.loadImage();
    default:
        return QVariant();
    }
    __builtin_unreachable();
}

QHash< int, QByteArray >
ThemesModel::roleNames() const
{
    return { { LabelRole, "label" },
             { KeyRole, "key" },
             { SelectedRole, "selected" },
             { ShownRole, "show" },
             { ImageRole, "image" } };
}

void
ThemesModel::setThemeImage( const QString& id, const QString& imagePath )
{
    auto [ i, theme ] = m_themes->indexById( id );
    if ( theme )
    {
        theme->imagePath = imagePath;
        emit dataChanged( index( i, 0 ), index( i, 0 ), { ImageRole } );
    }
}

void
ThemesModel::setThemeImage( const QMap< QString, QString >& images )
{
    if ( m_themes->isEmpty() )
    {
        return;
    }

    // Don't emit signals from each call, aggregate to one call (below this block)
    {
        QSignalBlocker b( this );
        for ( auto k = images.constKeyValueBegin(); k != images.constKeyValueEnd(); ++k )
        {
            setThemeImage( ( *k ).first, ( *k ).second );
        }
    }
    emit dataChanged( index( 0, 0 ), index( m_themes->count() - 1 ), { ImageRole } );
}

void
ThemesModel::showTheme( const QString& id, bool show )
{
    auto [ i, theme ] = m_themes->indexById( id );
    if ( theme )
    {
        theme->show = show;
        emit dataChanged( index( i, 0 ), index( i, 0 ), { ShownRole } );
    }
}

void
ThemesModel::showOnlyThemes( const QMap< QString, QString >& onlyThese )
{
    if ( m_themes->isEmpty() )
    {
        return;
    }

    // No signal blocker block needed here because we're not calling showTheme()
    // QSignalBlocker b( this );
    for ( auto& t : *m_themes )
    {
        t.show = onlyThese.contains( t.id );
    }
    emit dataChanged( index( 0, 0 ), index( m_themes->count() - 1 ), { ShownRole } );
}

QSize
ThemesModel::imageSize()
{
    return { qMax( 12 * CalamaresUtils::defaultFontHeight(), 120 ),
             qMax( 8 * CalamaresUtils::defaultFontHeight(), 80 ) };
}

void
ThemesModel::select( const QString& themeId )
{
    int i = 0;
    for ( auto& t : *m_themes )
    {
        if ( t.selected && t.id != themeId )
        {
            t.selected = false;
            emit dataChanged( index( i, 0 ), index( i, 0 ), { SelectedRole } );
        }
        if ( !t.selected && t.id == themeId )
        {
            t.selected = true;
            emit dataChanged( index( i, 0 ), index( i, 0 ), { SelectedRole } );
        }
        ++i;
    }
}


/**
 * Massage the given @p path to the most-likely
 * path that actually contains a screenshot. For
 * empty image paths, returns the QRC path for an
 * empty screenshot. Returns blank if the path
 * doesn't exist anywhere in the search paths.
 */
static QString
munge_imagepath( const QString& path )
{
    if ( path.isEmpty() )
    {
        return ":/view-preview.png";
    }

    if ( path.startsWith( '/' ) )
    {
        return path;
    }

    if ( QFileInfo::exists( path ) )
    {
        return path;
    }

    QFileInfo fi( QDir( Calamares::Branding::instance()->componentDirectory() ), path );
    if ( fi.exists() )
    {
        return fi.absoluteFilePath();
    }

    return QString();
}

ThemeInfo::ThemeInfo( const KPluginMetaData& data )
    : id( data.pluginId() )
    , name( data.name() )
    , description( data.description() )
{
}

QPixmap
ThemeInfo::loadImage() const
{
    if ( pixmap.isNull() )
    {

        const QSize image_size( ThemesModel::imageSize() );

        const QString path = munge_imagepath( imagePath );
        cDebug() << "Loading initial image for" << id << imagePath << "->" << path;
        QPixmap image( path );
        if ( image.isNull() )
        {
            // Not found or not specified, so convert the name into some (horrible, likely)
            // color instead.
            image = QPixmap( image_size );
            auto hash_color = qHash( imagePath.isEmpty() ? id : imagePath );
            cDebug() << Logger::SubEntry << "Theme image" << imagePath << "not found, hash" << hash_color;
            image.fill( QColor( QRgb( hash_color ) ) );
        }
        else
        {
            cDebug() << Logger::SubEntry << "Theme image" << image.size();
        }

        pixmap = image.scaled( image_size, Qt::IgnoreAspectRatio, Qt::SmoothTransformation );
    }
    return pixmap;
}