File indexing completed on 2024-05-19 05:38:07

 /*
     main.cpp
 
     SPDX-FileCopyrightText: 1999 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
     SPDX-FileCopyrightText: 2000 Antonio Larrosa <larrosa@kde.org>
     SPDX-FileCopyrightText: 2000 Geert Jansen <jansen@kde.org>
     SPDX-FileCopyrightText: 2018 Kai Uwe Broulik <kde@privat.broulik.de>
     SPDX-FileCopyrightText: 2019 Benjamin Port <benjamin.port@enioka.com>
 
     KDE Frameworks 5 port:
     SPDX-FileCopyrightText: 2013 Jonathan Riddell <jr@jriddell.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #include "main.h"
 #include "../kcms-common_p.h"
 
 #include <QDBusConnection>
 #include <QDBusMessage>
 #include <QGuiApplication>
 #include <QPainter>
 #include <QPixmapCache>
 #include <QProcess>
 #include <QQuickItem>
 #include <QQuickWindow>
 #include <QStringList>
 #include <QSvgRenderer>
 
 #include <KConfigGroup>
 #include <KIconLoader>
 #include <KIconTheme>
 #include <KJobUiDelegate>
 #include <KLocalizedString>
 #include <KPluginFactory>
 #include <KSharedConfig>
 #include <KTar>
 
 #include <KIO/DeleteJob>
 #include <KIO/FileCopyJob>
 
 #include <algorithm>
 #include <unistd.h> // for unlink
 
 #include "iconsdata.h"
 #include "iconsmodel.h"
 #include "iconssettings.h"
 
 #include "config.h" // for CMAKE_INSTALL_FULL_LIBEXECDIR
 
 K_PLUGIN_FACTORY_WITH_JSON(IconsFactory, "kcm_icons.json", registerPlugin<IconModule>(); registerPlugin<IconsData>();)
 
 IconModule::IconModule(QObject *parent, const KPluginMetaData &data)
     : KQuickManagedConfigModule(parent, data)
     , m_data(new IconsData(this))
     , m_model(new IconsModel(m_data->settings(), this))
 {
     auto uri = "org.kde.private.kcms.icons";
     qmlRegisterAnonymousType<IconsSettings>(uri, 1);
     qmlRegisterAnonymousType<IconsModel>(uri, 1);
 
     // to be able to access its enums
     qmlRegisterUncreatableType<KIconLoader>(uri, 1, 0, "KIconLoader", QString());
 
     setButtons(Apply | Default | Help);
 
     connect(m_model, &IconsModel::pendingDeletionsChanged, this, &IconModule::settingsChanged);
 
     // When user has a lot of themes installed, preview pixmaps might get evicted prematurely
     QPixmapCache::setCacheLimit(50 * 1024); // 50 MiB
 }
 
 IconModule::~IconModule()
 {
 }
 
 IconsSettings *IconModule::iconsSettings() const
 {
     return m_data->settings();
 }
 
 IconsModel *IconModule::iconsModel() const
 {
     return m_model;
 }
 
 bool IconModule::downloadingFile() const
 {
     return m_tempCopyJob;
 }
 
 void IconModule::load()
 {
     KQuickManagedConfigModule::load();
     m_model->load();
     // Model has been cleared so pretend the theme name changed to force view update
     Q_EMIT iconsSettings()->ThemeChanged();
 }
 
 void IconModule::save()
 {
     KQuickManagedConfigModule::save();
 
     processPendingDeletions();
 }
 
 bool IconModule::isSaveNeeded() const
 {
     return !m_model->pendingDeletions().isEmpty();
 }
 
 void IconModule::processPendingDeletions()
 {
     const QStringList pendingDeletions = m_model->pendingDeletions();
 
     for (const QString &themeName : pendingDeletions) {
         Q_ASSERT(themeName != iconsSettings()->theme());
 
         KIconTheme theme(themeName);
         auto *job = KIO::del(QUrl::fromLocalFile(theme.dir()), KIO::HideProgressInfo);
         // needs to block for it to work on "OK" where the dialog (kcmshell) closes
         job->exec();
     }
 
     m_model->removeItemsPendingDeletion();
 }
 
 void IconModule::ghnsEntriesChanged()
 {
     // reload the display icontheme items
     KIconTheme::reconfigure();
     KIconLoader::global()->newIconLoader();
     load();
     QPixmapCache::clear();
 }
 
 void IconModule::installThemeFromFile(const QUrl &url)
 {
     if (url.isLocalFile()) {
         installThemeFile(url.toLocalFile());
         return;
     }
 
     if (m_tempCopyJob) {
         return;
     }
 
     m_tempInstallFile.reset(new QTemporaryFile());
     if (!m_tempInstallFile->open()) {
         Q_EMIT showErrorMessage(i18n("Unable to create a temporary file."));
         m_tempInstallFile.reset();
         return;
     }
 
     m_tempCopyJob = KIO::file_copy(url, QUrl::fromLocalFile(m_tempInstallFile->fileName()), -1, KIO::Overwrite);
     m_tempCopyJob->uiDelegate()->setAutoErrorHandlingEnabled(true);
     Q_EMIT downloadingFileChanged();
 
     connect(m_tempCopyJob, &KIO::FileCopyJob::result, this, [this, url](KJob *job) {
         if (job->error() != KJob::NoError) {
             Q_EMIT showErrorMessage(i18n("Unable to download the icon theme archive: %1", job->errorText()));
             return;
         }
 
         installThemeFile(m_tempInstallFile->fileName());
         m_tempInstallFile.reset();
     });
     connect(m_tempCopyJob, &QObject::destroyed, this, &IconModule::downloadingFileChanged);
 }
 
 void IconModule::installThemeFile(const QString &path)
 {
     const QStringList themesNames = findThemeDirs(path);
     if (themesNames.isEmpty()) {
         Q_EMIT showErrorMessage(i18n("The file is not a valid icon theme archive."));
         return;
     }
 
     if (!installThemes(themesNames, path)) {
         Q_EMIT showErrorMessage(i18n("A problem occurred during the installation process; however, most of the themes in the archive have been installed"));
         return;
     }
 
     Q_EMIT showSuccessMessage(i18n("Theme installed successfully."));
 
     KIconLoader::global()->newIconLoader();
     m_model->load();
 }
 
 QStringList IconModule::findThemeDirs(const QString &archiveName)
 {
     QStringList foundThemes;
 
     KTar archive(archiveName);
     archive.open(QIODevice::ReadOnly);
     const KArchiveDirectory *themeDir = archive.directory();
 
     KArchiveEntry *possibleDir = nullptr;
     KArchiveDirectory *subDir = nullptr;
 
     // iterate all the dirs looking for an index.theme or index.desktop file
     const QStringList entries = themeDir->entries();
     for (const QString &entry : entries) {
         possibleDir = const_cast<KArchiveEntry *>(themeDir->entry(entry));
         if (!possibleDir->isDirectory()) {
             continue;
         }
 
         subDir = dynamic_cast<KArchiveDirectory *>(possibleDir);
         if (!subDir) {
             continue;
         }
 
         if (subDir->entry(QStringLiteral("index.theme")) || subDir->entry(QStringLiteral("index.desktop"))) {
             foundThemes.append(subDir->name());
         }
     }
 
     archive.close();
     return foundThemes;
 }
 
 bool IconModule::installThemes(const QStringList &themes, const QString &archiveName)
 {
     bool everythingOk = true;
     const QString localThemesDir(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + QLatin1String("/icons/./"));
 
     Q_EMIT showProgress(i18n("Installing icon themes…"));
 
     KTar archive(archiveName);
     archive.open(QIODevice::ReadOnly);
     qApp->processEvents(QEventLoop::ExcludeUserInputEvents);
 
     const KArchiveDirectory *rootDir = archive.directory();
 
     KArchiveDirectory *currentTheme = nullptr;
     for (const QString &theme : themes) {
         Q_EMIT showProgress(i18n("Installing %1 theme…", theme));
 
         qApp->processEvents(QEventLoop::ExcludeUserInputEvents);
 
         currentTheme = dynamic_cast<KArchiveDirectory *>(const_cast<KArchiveEntry *>(rootDir->entry(theme)));
         if (!currentTheme) {
             // we tell back that something went wrong, but try to install as much
             // as possible
             everythingOk = false;
             continue;
         }
 
         currentTheme->copyTo(localThemesDir + theme);
     }
 
     archive.close();
 
     Q_EMIT hideProgress();
     return everythingOk;
 }
 
 QVariantList IconModule::previewIcons(const QString &themeName, int size, qreal dpr, int limit)
 {
     static QList<QStringList> s_previewIcons{
         {QStringLiteral("system-run"), QStringLiteral("exec")},
         {QStringLiteral("folder")},
         {QStringLiteral("document"), QStringLiteral("text-x-generic")},
         {QStringLiteral("user-trash"), QStringLiteral("user-trash-empty")},
         {QStringLiteral("help-browser"), QStringLiteral("system-help"), QStringLiteral("help-about"), QStringLiteral("help-contents")},
         {QStringLiteral("preferences-system"), QStringLiteral("systemsettings"), QStringLiteral("configure")},
 
         {QStringLiteral("text-html")},
         {QStringLiteral("image-x-generic"), QStringLiteral("image-png"), QStringLiteral("image-jpeg")},
         {QStringLiteral("video-x-generic"), QStringLiteral("video-x-theora+ogg"), QStringLiteral("video-mp4")},
         {QStringLiteral("x-office-document")},
         {QStringLiteral("x-office-spreadsheet")},
         {QStringLiteral("x-office-presentation"), QStringLiteral("application-presentation")},
 
         {QStringLiteral("user-home")},
         {QStringLiteral("user-desktop"), QStringLiteral("desktop")},
         {QStringLiteral("folder-image"), QStringLiteral("folder-images"), QStringLiteral("folder-pictures"), QStringLiteral("folder-picture")},
         {QStringLiteral("folder-documents")},
         {QStringLiteral("folder-download"), QStringLiteral("folder-downloads")},
         {QStringLiteral("folder-video"), QStringLiteral("folder-videos")}};
 
     // created on-demand as it is quite expensive to do and we don't want to do it every loop iteration either
     std::unique_ptr<KIconTheme> theme;
 
     QVariantList pixmaps;
 
     for (const QStringList &iconNames : s_previewIcons) {
         const QString cacheKey = themeName + QLatin1Char('@') + QString::number(size) + QLatin1Char('@') + QString::number(dpr, 'f', 1) + QLatin1Char('@')
             + iconNames.join(QLatin1Char(','));
 
         QPixmap pix;
         if (!QPixmapCache::find(cacheKey, &pix)) {
             if (!theme) {
                 theme.reset(new KIconTheme(themeName));
             }
 
             pix = getBestIcon(*theme.get(), iconNames, size, dpr);
 
             // Inserting a pixmap even if null so we know whether we searched for it already
             QPixmapCache::insert(cacheKey, pix);
         }
 
         if (pix.isNull()) {
             continue;
         }
 
         pixmaps.append(pix);
 
         if (limit > -1 && pixmaps.count() >= limit) {
             break;
         }
     }
 
     return pixmaps;
 }
 
 QPixmap IconModule::getBestIcon(KIconTheme &theme, const QStringList &iconNames, int size, qreal dpr)
 {
     QSvgRenderer renderer;
 
     const int iconSize = size * dpr;
 
     // not using initializer list as we want to unwrap inherits()
     const QStringList themes = QStringList() << theme.internalName() << theme.inherits();
     for (const QString &themeName : themes) {
         KIconTheme theme(themeName);
 
         for (const QString &iconName : iconNames) {
             const QString pixmapPath = theme.iconPath(QStringLiteral("%1.png").arg(iconName), iconSize, KIconLoader::MatchBest);
             QPixmap pixmap(pixmapPath);
             if (!pixmap.isNull()) {
                 pixmap.setDevicePixelRatio(dpr);
                 if (pixmap.width() >= iconSize && pixmap.height() >= iconSize) {
                     return pixmap;
                 }
             }
 
             // could not find the .png, try loading the .svg or .svgz
             QString scalablePath = theme.iconPath(QStringLiteral("%1.svg").arg(iconName), iconSize, KIconLoader::MatchBest);
             if (scalablePath.isEmpty()) {
                 scalablePath = theme.iconPath(QStringLiteral("%1.svgz").arg(iconName), iconSize, KIconLoader::MatchBest);
             }
 
             if (scalablePath.isEmpty()) {
                 if (!pixmap.isNull()) {
                     return pixmap;
                 }
 
                 continue;
             }
 
             if (!renderer.load(scalablePath)) {
                 continue;
             }
 
             QPixmap svgPixmap(iconSize, iconSize);
             svgPixmap.setDevicePixelRatio(dpr);
             svgPixmap.fill(QColor(Qt::transparent));
             QPainter p(&svgPixmap);
             p.setViewport(0, 0, size, size);
             renderer.render(&p);
             return svgPixmap;
         }
     }
 
     return QPixmap();
 }
 
 int IconModule::pluginIndex(const QString &themeName) const
 {
     const auto results = m_model->match(m_model->index(0, 0), ThemeNameRole, themeName, 1, Qt::MatchExactly);
     if (results.count() == 1) {
         return results.first().row();
     }
     return -1;
 }
 
 void IconModule::defaults()
 {
     for (int i = 0, count = m_model->rowCount(QModelIndex()); i < count; ++i) {
         m_model->setData(m_model->index(i), false, IconsModel::Roles::PendingDeletionRole);
     }
     KQuickManagedConfigModule::defaults();
 }
 
 #include "main.moc"