path: root/src/gui/core/theme.c

/* Chrysalide - Outil d'analyse de fichiers binaires
 * theme.c - prototypes pour l'ajout d'extensions au thème GTK
 *
 * Copyright (C) 2016-2017 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide 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.
 *
 *  Chrysalide 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "theme.h"


#include <assert.h>
#include <dirent.h>
#include <fcntl.h>
#include <malloc.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>


#include <config.h>
#include <i18n.h>


#include "../../common/extstr.h"
#include "../../common/xdg.h"
#include "../../core/logs.h"
#include "../../core/params.h"
#include "../../plugins/pglist.h"



/* Parcourt tous les répertoires connus pour trouver un thème. */
static bool browse_themes_directories(GdkScreen *, const char *, gboolean);

/* Parcourt un répertoire donné à la recherche d'un thème. */
static bool look_for_named_theme(GdkScreen *, const char *, const char *, gboolean);

/* Ajoute les définitions CSS à partir d'un chemin donné. */
static bool load_css_content(GdkScreen *, const char *, gboolean);

/* Parcourt tous les greffons à la recherche de définitions CSS. */
static bool extend_with_plugins_themes(GdkScreen *, gboolean);


/* Répertoires de recherche */
static const char *_themes_directories[] = {

    PACKAGE_SOURCE_DIR G_DIR_SEPARATOR_S "themes",
    THEMES_DIR,
    NULL

};



/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Charge le thème GTK pour les composants spécifiques.         *
*                                                                             *
*  Retour      : true ou false selon le bilan de l'opération.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool load_extra_gtk_theme(void)
{
    bool result;                            /* Bilan à faire remonter      */
    const char *name;                       /* Nom du thème recherché      */
    GdkScreen *screen;                      /* Ecran(s) concerné(s)        */
    GtkSettings *settings;                  /* Propriétés du système       */
    gboolean dark;                          /* Envie d'un thème sombre ?   */

    result = false;

    if (!g_generic_config_get_value(get_main_configuration(), MPK_INTERNAL_THEME, &name))
        goto legt_done;

    screen = gdk_screen_get_default();

    settings = gtk_settings_get_for_screen(screen);

    g_object_get(settings, "gtk-application-prefer-dark-theme", &dark, NULL);

    result = browse_themes_directories(screen, name, dark);

    if (result)
        result = extend_with_plugins_themes(screen, dark);

 legt_done:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : screen = écran visé par le chargement d'un thème.            *
*                name   = nom du thème recherché, et donc de son répertoire.  *
*                dark   = indique une préférence pour la variante foncée.     *
*                                                                             *
*  Description : Parcourt tous les répertoires connus pour trouver un thème.  *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool browse_themes_directories(GdkScreen *screen, const char *name, gboolean dark)
{
    bool result;                            /* Bilan à renvoyer            */
    char *suffix;                           /* Fin du répertoire personnel */
    char *owndir;                           /* Thèmes personnels ?         */
    const char **iter;                      /* Boucle de parcours          */

    result = false;

    /* Répertoire de l'utilisateur en premier ! */

    suffix = strdup("chrysalide");
    suffix = stradd(suffix, G_DIR_SEPARATOR_S);
    suffix = stradd(suffix, "themes");

    owndir = get_xdg_config_dir(suffix);

    free(suffix);

    if (owndir != NULL)
    {
        result = look_for_named_theme(screen, owndir, name, dark);

        free(owndir);

    }

    /* Parcours des autres répertoires classiques au besoin */

    for (iter = _themes_directories; *iter != NULL && !result; iter++)
        result = look_for_named_theme(screen, *iter, name, dark);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : screen  = écran visé par le chargement d'un thème.           *
*                dirname = chemin du répertoire où effectuer des recherches.  *
*                name    = nom du thème recherché, et donc de son répertoire. *
*                dark    = indique une préférence pour la variante foncée.    *
*                                                                             *
*  Description : Parcourt un répertoire donné à la recherche d'un thème.      *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool look_for_named_theme(GdkScreen *screen, const char *dirname, const char *name, gboolean dark)
{
    bool result;                            /* Bilan à renvoyer            */
    char *path;                             /* Chemin d'accès à essayer    */
    int ret;                                /* Bilan d'un appel            */
    int dirfd;                              /* Canal de lecture            */
    struct dirent **namelist;               /* Liste des trouvailles       */
    int count;                              /* Nombre de fichiers trouvés  */
    int i;                                  /* Boucle de parcours          */
    char *filename;                         /* Chemin d'accès constitué    */

    result = false;

    ret = asprintf(&path, "%s" G_DIR_SEPARATOR_S "%s", dirname, name);
    if (ret == -1) goto lfnt_done;

    dirfd = open(path, O_RDONLY | O_DIRECTORY);
    if (dirfd == -1) goto lfnt_not_found;

    int keep_css_only(const struct dirent *entry)
    {
        return (entry->d_type == DT_REG
                && endswith(entry->d_name, ".css")
                && !endswith(entry->d_name, "-dark.css") ? 1 : 0);

    }

    count = scandirat(dirfd, ".", &namelist, keep_css_only, alphasort);

    result = (count > 0);

    for (i = 0; i < count && result; i++)
    {
        ret = asprintf(&filename, "%s%s%s", path, G_DIR_SEPARATOR_S, namelist[i]->d_name);
        if (ret == -1) continue;

        result = load_css_content(screen, filename, dark);

        free(filename);

    }

    if (count > 0)
        free(namelist);

    close(dirfd);

 lfnt_not_found:

    free(path);

 lfnt_done:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : screen = écran visé par le chargement d'un thème.            *
*                path   = chemin vers la nouvelle définition à ajouter.       *
*                dark   = indique une préférence pour la variante foncée.     *
*                                                                             *
*  Description : Ajoute les définitions CSS à partir d'un chemin donné.       *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool load_css_content(GdkScreen *screen, const char *path, gboolean dark)
{
    bool result;                            /* Bilan à renvoyer            */
    GtkCssProvider *provider;               /* Nouveau fournisseur CSS     */
    char *dark_path;                        /* Version sombre du chemin    */
    GFile *file;                            /* Fichier à charger           */
    GError *error;                          /* Relevé d'éventuelles erreurs*/

    result = false;

    /**
     * Comme GTK exporte les images sous forme de données encodées en base 64
     * (cf. gtk_css_image_surface_print()) et ne sait pas recharger ensuite
     * ces mêmes données (cf. gtk_css_image_url_load_image()), on ne peut pas
     * collecter les images des ressources via gtk_css_provider_to_string()
     * pour constituer un contenu CSS global...
     *
     * On intègre ainsi les contenus CSS un par un, sans pouvoir déterminer
     * si l'ensemble est complètement intégré sans erreur.
     *
     * Ce constat est valable pour la version 3.22.11-1 de Debian, au moins.
     */

    if (dark)
    {
        provider = gtk_css_provider_new();

        error = NULL;

        dark_path = strdup(path);
        dark_path = strrpl(dark_path, ".css", "-dark.css");

        if (strstr(path, "://") != NULL)
            file = g_file_new_for_uri(dark_path);
        else
            file = g_file_new_for_path(dark_path);

        gtk_css_provider_load_from_file(provider, file, &error);

        g_object_unref(G_OBJECT(file));

        if (error == NULL)
        {
            log_variadic_message(LMT_INFO, _("Loaded CSS definitions from '%s'"), dark_path);

            gtk_style_context_add_provider_for_screen(screen, GTK_STYLE_PROVIDER(provider),
                                                      GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);

            result = true;

        }
        else
            g_error_free(error);

        free(dark_path);

        g_object_unref(G_OBJECT(provider));

    }

    if (!result)
    {
        provider = gtk_css_provider_new();

        error = NULL;

        if (strstr(path, "://") != NULL)
            file = g_file_new_for_uri(path);
        else
            file = g_file_new_for_path(path);

        gtk_css_provider_load_from_file(provider, file, &error);

        g_object_unref(G_OBJECT(file));

        if (error == NULL)
        {
            log_variadic_message(LMT_INFO, _("Loaded CSS definitions from '%s'"), path);

            gtk_style_context_add_provider_for_screen(screen, GTK_STYLE_PROVIDER(provider),
                                                      GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);

            result = true;

        }
        else
        {
            log_variadic_message(LMT_ERROR, _("Failed to load CSS definitions from '%s'"), path);
            g_error_free(error);
        }

        g_object_unref(G_OBJECT(provider));

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : screen = écran visé par le chargement d'un thème.            *
*                dark   = indique une préférence pour la variante foncée.     *
*                                                                             *
*  Description : Parcourt tous les greffons à la recherche de définitions CSS.*
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool extend_with_plugins_themes(GdkScreen *screen, gboolean dark)
{
    bool result;                            /* Bilan à renvoyer            */
    char **resources;                       /* Fichiers supplémentaires    */
    size_t count;                           /* Nombre de ces fichiers      */
    size_t i;                               /* Boucle de parcours          */

    result = true;

    resources = NULL;
    count = 0;

    include_plugin_theme(&resources, &count);

    for (i = 0; i < count && result; i++)
    {
        result = load_css_content(screen, resources[i], dark);
        free(resources[i]);
    }

    if (resources != NULL)
        free(resources);

    return result;

}