r1996: Cope slightly better with invalid filenames in various places (reported by

[rox-filer.git] / ROX-Filer / src / pixmaps.c

/*
 * $Id$
 *
 * ROX-Filer, filer for the ROX desktop project
 * Copyright (C) 2002, the ROX-Filer team.
 *
 * 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., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

/* pixmaps.c - code for handling pixbufs (despite the name!) */

#include "config.h"
#define PIXMAPS_C

/* Remove pixmaps from the cache when they haven't been accessed for
 * this period of time (seconds).
 */

#define PIXMAP_PURGE_TIME 1200

/* Image files smaller than this are loaded in the main process.
 * Larger images are sent to a sub-process.
 * If this is too small, then looking inside ~/.thumbnails will
 * cause nasty effects ;-)
 */
#define SMALL_IMAGE_THRESHOLD 50000

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>

#include <gtk/gtk.h>

#include "global.h"

#include "fscache.h"
#include "support.h"
#include "gui_support.h"
#include "pixmaps.h"
#include "main.h"
#include "filer.h"
#include "dir.h"

GFSCache *pixmap_cache = NULL;

static const char * bad_xpm[] = {
"12 12 3 1",
"       c #000000000000",
".      c #FFFF00000000",
"x      c #FFFFFFFFFFFF",
"            ",
" ..xxxxxx.. ",
" ...xxxx... ",
" x...xx...x ",
" xx......xx ",
" xxx....xxx ",
" xxx....xxx ",
" xx......xx ",
" x...xx...x ",
" ...xxxx... ",
" ..xxxxxx.. ",
"            "};

MaskedPixmap *im_error;
MaskedPixmap *im_unknown;
MaskedPixmap *im_symlink;

MaskedPixmap *im_unmounted;
MaskedPixmap *im_mounted;
MaskedPixmap *im_appdir;

MaskedPixmap *im_dirs;

typedef struct _ChildThumbnail ChildThumbnail;

/* There is one of these for each active child process */
struct _ChildThumbnail {
        gchar    *path;
        GFunc    callback;
        gpointer data;
};

/* Static prototypes */

static void load_default_pixmaps(void);
static gint purge(gpointer data);
static MaskedPixmap *image_from_file(const char *path);
static MaskedPixmap *get_bad_image(void);
static GdkPixbuf *scale_pixbuf(GdkPixbuf *src, int max_w, int max_h);
static GdkPixbuf *scale_pixbuf_up(GdkPixbuf *src, int max_w, int max_h);
static GdkPixbuf *get_thumbnail_for(const char *path);
static void thumbnail_child_done(ChildThumbnail *info);
static void child_create_thumbnail(const gchar *path);
static GdkPixbuf *create_spotlight_pixbuf(GdkPixbuf *src, guint32 color,
                                          guchar alpha);

/****************************************************************
 *                      EXTERNAL INTERFACE                      *
 ****************************************************************/

void pixmaps_init(void)
{
        gtk_widget_push_colormap(gdk_rgb_get_colormap());

        pixmap_cache = g_fscache_new((GFSLoadFunc) image_from_file, NULL, NULL);

        gtk_timeout_add(10000, purge, NULL);

        load_default_pixmaps();
}

/* Load image <appdir>/images/name.png.
 * Always returns with a valid image.
 */
MaskedPixmap *load_pixmap(const char *name)
{
        guchar *path;
        MaskedPixmap *retval;
        
        path = g_strconcat(app_dir, "/images/", name, ".png", NULL);
        retval = image_from_file(path);
        g_free(path);

        if (!retval)
                retval = get_bad_image();

        return retval;
}

/* Create a MaskedPixmap from a GTK stock ID. Always returns
 * a valid image.
 */
static MaskedPixmap *mp_from_stock(const char *stock_id)
{
        GtkIconSet *icon_set;
        GdkPixbuf  *pixbuf;
        MaskedPixmap *retval;

        icon_set = gtk_icon_factory_lookup_default(stock_id);
        if (!icon_set)
                return get_bad_image();
        
        pixbuf = gtk_icon_set_render_icon(icon_set,
                                     gtk_widget_get_default_style(), /* Gtk bug */
                                     GTK_TEXT_DIR_LTR,
                                     GTK_STATE_NORMAL,
                                     GTK_ICON_SIZE_DIALOG,
                                     NULL,
                                     NULL);
        retval = masked_pixmap_new(pixbuf);
        gdk_pixbuf_unref(pixbuf);

        return retval;
}

void pixmap_make_huge(MaskedPixmap *mp)
{
        if (mp->huge_pixbuf)
                return;

        g_return_if_fail(mp->src_pixbuf != NULL);

        mp->huge_pixbuf = scale_pixbuf_up(mp->src_pixbuf,
                                          HUGE_WIDTH * 0.7,
                                          HUGE_HEIGHT * 0.7);

        if (!mp->huge_pixbuf)
        {
                mp->huge_pixbuf = mp->src_pixbuf;
                g_object_ref(mp->huge_pixbuf);
        }

        mp->huge_pixbuf_lit = create_spotlight_pixbuf(mp->huge_pixbuf,
                                                      0x000099, 128);
        mp->huge_width = gdk_pixbuf_get_width(mp->huge_pixbuf);
        mp->huge_height = gdk_pixbuf_get_height(mp->huge_pixbuf);
}

void pixmap_make_small(MaskedPixmap *mp)
{
        if (mp->sm_pixbuf)
                return;

        g_return_if_fail(mp->src_pixbuf != NULL);

        mp->sm_pixbuf = scale_pixbuf(mp->src_pixbuf, SMALL_WIDTH, SMALL_HEIGHT);

        if (!mp->sm_pixbuf)
        {
                mp->sm_pixbuf = mp->src_pixbuf;
                g_object_ref(mp->sm_pixbuf);
        }

        mp->sm_pixbuf_lit = create_spotlight_pixbuf(mp->sm_pixbuf,
                                                      0x000099, 128);

        mp->sm_width = gdk_pixbuf_get_width(mp->sm_pixbuf);
        mp->sm_height = gdk_pixbuf_get_height(mp->sm_pixbuf);
}

/* Load image 'path' in the background and insert into pixmap_cache.
 * Call callback(data, path) when done (path is NULL => error).
 * If the image is already uptodate, or being created already, calls the
 * callback right away.
 */
void pixmap_background_thumb(const gchar *path, GFunc callback, gpointer data)
{
        gboolean        found;
        MaskedPixmap    *image;
        GdkPixbuf       *pixbuf;
        pid_t           child;
        ChildThumbnail  *info;

        image = g_fscache_lookup_full(pixmap_cache, path,
                                        FSCACHE_LOOKUP_ONLY_NEW, &found);

        if (found)
        {
                /* Thumbnail is known, or being created */
                g_object_unref(image);
                callback(data, NULL);
                return;
        }

        g_return_if_fail(image == NULL);

        pixbuf = get_thumbnail_for(path);
        
        if (!pixbuf)
        {
                struct stat finfo;

                /* If the image is small, load it now */
                if (mc_stat(path, &finfo) != 0)
                {
                        callback(data, NULL);
                        return;
                }

                if (finfo.st_size < SMALL_IMAGE_THRESHOLD)
                {
                        pixbuf = gdk_pixbuf_new_from_file(path, NULL);
                        if (!pixbuf)
                        {
                                g_fscache_insert(pixmap_cache,
                                                 path, NULL, TRUE);
                                callback(data, NULL);
                                return;
                        }
                }
        }
                
        if (pixbuf)
        {
                MaskedPixmap *image;

                image = masked_pixmap_new(pixbuf);
                gdk_pixbuf_unref(pixbuf);
                g_fscache_insert(pixmap_cache, path, image, TRUE);
                callback(data, (gchar *) path);
                return;
        }

        /* Add an entry, set to NULL, so no-one else tries to load this
         * image.
         */
        g_fscache_insert(pixmap_cache, path, NULL, TRUE);

        child = fork();

        if (child == -1)
        {
                delayed_error("fork(): %s", g_strerror(errno));
                callback(data, NULL);
                return;
        }

        if (child == 0)
        {
                /* We are the child process */
                child_create_thumbnail(path);
                _exit(0);
        }

        info = g_new(ChildThumbnail, 1);
        info->path = g_strdup(path);
        info->callback = callback;
        info->data = data;
        on_child_death(child, (CallbackFn) thumbnail_child_done, info);
}

/****************************************************************
 *                      INTERNAL FUNCTIONS                      *
 ****************************************************************/

/* Create a thumbnail file for this image.
 * XXX: Thumbnails should be deleted somewhere!
 */
static void save_thumbnail(const char *pathname, GdkPixbuf *full)
{
        struct stat info;
        gchar *path;
        int original_width, original_height;
        GString *to;
        char *md5, *swidth, *sheight, *ssize, *smtime, *uri;
        mode_t old_mask;
        int name_len;
        GdkPixbuf *thumb;

        thumb = scale_pixbuf(full, HUGE_WIDTH, HUGE_HEIGHT);

        original_width = gdk_pixbuf_get_width(full);
        original_height = gdk_pixbuf_get_height(full);

        if (mc_stat(pathname, &info) != 0)
                return;

        swidth = g_strdup_printf("%d", original_width);
        sheight = g_strdup_printf("%d", original_height);
        ssize = g_strdup_printf("%" SIZE_FMT, info.st_size);
        smtime = g_strdup_printf("%ld", info.st_mtime);

        path = pathdup(pathname);
        uri = g_strconcat("file://", path, NULL);
        md5 = md5_hash(uri);
        g_free(path);
                
        to = g_string_new(home_dir);
        g_string_append(to, "/.thumbnails");
        mkdir(to->str, 0700);
        g_string_append(to, "/normal/");
        mkdir(to->str, 0700);
        g_string_append(to, md5);
        name_len = to->len + 4; /* Truncate to this length when renaming */
        g_string_sprintfa(to, ".png.ROX-Filer-%ld", (long) getpid());

        g_free(md5);

        old_mask = umask(0077);
        gdk_pixbuf_save(thumb, to->str, "png", NULL,
                        "tEXt::Thumb::Image::Width", swidth,
                        "tEXt::Thumb::Image::Height", sheight,
                        "tEXt::Thumb::Size", ssize,
                        "tEXt::Thumb::MTime", smtime,
                        "tEXt::Thumb::URI", uri,
                        "tEXt::Software", PROJECT,
                        NULL);
        umask(old_mask);

        /* We create the file ###.png.ROX-Filer-PID and rename it to avoid
         * a race condition if two programs create the same thumb at
         * once.
         */
        {
                gchar *final;

                final = g_strndup(to->str, name_len);
                if (rename(to->str, final))
                        g_warning("Failed to rename '%s' to '%s': %s",
                                  to->str, final, g_strerror(errno));
                g_free(final);
        }

        g_string_free(to, TRUE);
        g_free(swidth);
        g_free(sheight);
        g_free(ssize);
        g_free(smtime);
        g_free(uri);
}

/* Called in a subprocess. Load path and create the thumbnail
 * file. Parent will notice when we die.
 */
static void child_create_thumbnail(const gchar *path)
{
        GdkPixbuf *image;

        image = gdk_pixbuf_new_from_file(path, NULL);

        if (image)
                save_thumbnail(path, image);

        /* (no need to unref, as we're about to exit) */
}

/* Called when the child process exits */
static void thumbnail_child_done(ChildThumbnail *info)
{
        GdkPixbuf *thumb;

        thumb = get_thumbnail_for(info->path);

        if (thumb)
        {
                MaskedPixmap *image;

                image = masked_pixmap_new(thumb);
                g_object_unref(thumb);

                g_fscache_insert(pixmap_cache, info->path, image, FALSE);
                g_object_unref(image);

                info->callback(info->data, info->path);
        }
        else
                info->callback(info->data, NULL);

        g_free(info->path);
        g_free(info);
}

/* Check if we have an up-to-date thumbnail for this image.
 * If so, return it. Otherwise, returns NULL.
 */
static GdkPixbuf *get_thumbnail_for(const char *pathname)
{
        GdkPixbuf *thumb = NULL;
        char *thumb_path, *md5, *uri, *path;
        const char *ssize, *smtime;
        struct stat info;

        path = pathdup(pathname);
        uri = g_strconcat("file://", path, NULL);
        md5 = md5_hash(uri);
        g_free(uri);
        
        thumb_path = g_strdup_printf("%s/.thumbnails/normal/%s.png",
                                        home_dir, md5);
        g_free(md5);

        thumb = gdk_pixbuf_new_from_file(thumb_path, NULL);
        if (!thumb)
                goto err;

        /* Note that these don't need freeing... */
        ssize = gdk_pixbuf_get_option(thumb, "tEXt::Thumb::Size");
        if (!ssize)
                goto err;

        smtime = gdk_pixbuf_get_option(thumb, "tEXt::Thumb::MTime");
        if (!smtime)
                goto err;
        
        if (mc_stat(path, &info) != 0)
                goto err;
        
        if (info.st_mtime != atol(smtime) || info.st_size != atol(ssize))
                goto err;

        goto out;
err:
        if (thumb)
                gdk_pixbuf_unref(thumb);
        thumb = NULL;
out:
        g_free(path);
        g_free(thumb_path);
        return thumb;
}

/* Load the image 'path' and return a pointer to the resulting
 * MaskedPixmap. NULL on failure.
 * Doesn't check for thumbnails (this is for small icons).
 */
static MaskedPixmap *image_from_file(const char *path)
{
        GdkPixbuf       *pixbuf;
        MaskedPixmap    *image;
        GError          *error = NULL;
        
        pixbuf = gdk_pixbuf_new_from_file(path, &error);
        if (!pixbuf)
        {
                g_print("%s\n", error ? error->message : _("Unknown error"));
                g_error_free(error);
                return NULL;
        }

        image = masked_pixmap_new(pixbuf);

        gdk_pixbuf_unref(pixbuf);

        return image;
}

/* Scale src down to fit in max_w, max_h and return the new pixbuf.
 * If src is small enough, then ref it and return that.
 */
static GdkPixbuf *scale_pixbuf(GdkPixbuf *src, int max_w, int max_h)
{
        int     w, h;

        w = gdk_pixbuf_get_width(src);
        h = gdk_pixbuf_get_height(src);

        if (w <= max_w && h <= max_h)
        {
                gdk_pixbuf_ref(src);
                return src;
        }
        else
        {
                float scale_x = ((float) w) / max_w;
                float scale_y = ((float) h) / max_h;
                float scale = MAX(scale_x, scale_y);
                int dest_w = w / scale;
                int dest_h = h / scale;
                
                return gdk_pixbuf_scale_simple(src,
                                                MAX(dest_w, 1),
                                                MAX(dest_h, 1),
                                                GDK_INTERP_BILINEAR);
        }
}

/* Scale src up to fit in max_w, max_h and return the new pixbuf.
 * If src is that size or bigger, then ref it and return that.
 */
static GdkPixbuf *scale_pixbuf_up(GdkPixbuf *src, int max_w, int max_h)
{
        int     w, h;

        w = gdk_pixbuf_get_width(src);
        h = gdk_pixbuf_get_height(src);

        if (w == 0 || h == 0 || (w >= max_w && h >= max_h))
        {
                gdk_pixbuf_ref(src);
                return src;
        }
        else
        {
                float scale_x = max_w / ((float) w);
                float scale_y = max_h / ((float) h);
                float scale = MIN(scale_x, scale_y);
                
                return gdk_pixbuf_scale_simple(src,
                                                w * scale,
                                                h * scale,
                                                GDK_INTERP_BILINEAR);
        }
}

/* Return a pointer to the (static) bad image. The ref counter will ensure
 * that the image is never freed.
 */
static MaskedPixmap *get_bad_image(void)
{
        GdkPixbuf *bad;
        MaskedPixmap *mp;
        
        bad = gdk_pixbuf_new_from_xpm_data(bad_xpm);
        mp = masked_pixmap_new(bad);
        gdk_pixbuf_unref(bad);

        return mp;
}

/* Called now and then to clear out old pixmaps */
static gint purge(gpointer data)
{
        g_fscache_purge(pixmap_cache, PIXMAP_PURGE_TIME);

        return TRUE;
}

static gpointer parent_class;

static void masked_pixmap_finialize(GObject *object)
{
        MaskedPixmap *mp = (MaskedPixmap *) object;

        if (mp->src_pixbuf)
        {
                g_object_unref(mp->src_pixbuf);
                mp->src_pixbuf = NULL;
        }

        if (mp->huge_pixbuf)
        {
                g_object_unref(mp->huge_pixbuf);
                mp->huge_pixbuf = NULL;
        }
        if (mp->huge_pixbuf_lit)
        {
                g_object_unref(mp->huge_pixbuf_lit);
                mp->huge_pixbuf_lit = NULL;
        }

        if (mp->pixbuf)
        {
                g_object_unref(mp->pixbuf);
                mp->pixbuf = NULL;
        }
        if (mp->pixbuf_lit)
        {
                g_object_unref(mp->pixbuf_lit);
                mp->pixbuf_lit = NULL;
        }

        if (mp->sm_pixbuf)
        {
                g_object_unref(mp->sm_pixbuf);
                mp->sm_pixbuf = NULL;
        }
        if (mp->sm_pixbuf_lit)
        {
                g_object_unref(mp->sm_pixbuf_lit);
                mp->sm_pixbuf_lit = NULL;
        }

        G_OBJECT_CLASS(parent_class)->finalize(object);
}

static void masked_pixmap_class_init(gpointer gclass, gpointer data)
{
        GObjectClass *object = (GObjectClass *) gclass;

        parent_class = g_type_class_peek_parent(gclass);

        object->finalize = masked_pixmap_finialize;
}

static void masked_pixmap_init(GTypeInstance *object, gpointer gclass)
{
        MaskedPixmap *mp = (MaskedPixmap *) object;

        mp->src_pixbuf = NULL;

        mp->huge_pixbuf = NULL;
        mp->huge_pixbuf_lit = NULL;
        mp->huge_width = -1;
        mp->huge_height = -1;

        mp->pixbuf = NULL;
        mp->pixbuf_lit = NULL;
        mp->width = -1;
        mp->height = -1;

        mp->sm_pixbuf = NULL;
        mp->sm_pixbuf_lit = NULL;
        mp->sm_width = -1;
        mp->sm_height = -1;
}

static GType masked_pixmap_get_type(void)
{
        static GType type = 0;

        if (!type)
        {
                static const GTypeInfo info =
                {
                        sizeof (MaskedPixmapClass),
                        NULL,                   /* base_init */
                        NULL,                   /* base_finalise */
                        masked_pixmap_class_init,
                        NULL,                   /* class_finalise */
                        NULL,                   /* class_data */
                        sizeof(MaskedPixmap),
                        0,                      /* n_preallocs */
                        masked_pixmap_init
                };

                type = g_type_register_static(G_TYPE_OBJECT, "MaskedPixmap",
                                              &info, 0);
        }

        return type;
}

MaskedPixmap *masked_pixmap_new(GdkPixbuf *full_size)
{
        MaskedPixmap *mp;
        GdkPixbuf       *src_pixbuf, *normal_pixbuf;

        g_return_val_if_fail(full_size != NULL, NULL);

        src_pixbuf = scale_pixbuf(full_size, HUGE_WIDTH, HUGE_HEIGHT);
        g_return_val_if_fail(src_pixbuf != NULL, NULL);

        normal_pixbuf = scale_pixbuf(src_pixbuf, ICON_WIDTH, ICON_HEIGHT);
        g_return_val_if_fail(normal_pixbuf != NULL, NULL);

        mp = g_object_new(masked_pixmap_get_type(), NULL);

        mp->src_pixbuf = src_pixbuf;

        mp->pixbuf = normal_pixbuf;
        mp->pixbuf_lit = create_spotlight_pixbuf(normal_pixbuf, 0x000099, 128);
        mp->width = gdk_pixbuf_get_width(normal_pixbuf);
        mp->height = gdk_pixbuf_get_height(normal_pixbuf);

        return mp;
}

/* Stolen from eel...and modified to colourize the pixbuf.
 * 'alpha' is the transparency of 'color' (0xRRGGBB):
 * 0 = fully opaque, 255 = fully transparent.
 */
static GdkPixbuf *create_spotlight_pixbuf(GdkPixbuf *src,
                                          guint32 color,
                                          guchar alpha)
{
        GdkPixbuf *dest;
        int i, j;
        int width, height, has_alpha, src_row_stride, dst_row_stride;
        guchar *target_pixels, *original_pixels;
        guchar *pixsrc, *pixdest;
        guchar r, g, b;
        gint n_channels;

        n_channels = gdk_pixbuf_get_n_channels(src);
        has_alpha = gdk_pixbuf_get_has_alpha(src);
        width = gdk_pixbuf_get_width(src);
        height = gdk_pixbuf_get_height(src);

        g_return_val_if_fail(gdk_pixbuf_get_colorspace(src) ==
                             GDK_COLORSPACE_RGB, NULL);
        g_return_val_if_fail((!has_alpha && n_channels == 3) ||
                             (has_alpha && n_channels == 4), NULL);
        g_return_val_if_fail(gdk_pixbuf_get_bits_per_sample(src) == 8, NULL);

        dest = gdk_pixbuf_new(gdk_pixbuf_get_colorspace(src), has_alpha,
                               gdk_pixbuf_get_bits_per_sample(src),
                               width, height);
        
        dst_row_stride = gdk_pixbuf_get_rowstride(dest);
        src_row_stride = gdk_pixbuf_get_rowstride(src);
        target_pixels = gdk_pixbuf_get_pixels(dest);
        original_pixels = gdk_pixbuf_get_pixels(src);

        r = (color & 0xff0000) >> 16;
        g = (color & 0xff00) >> 8;
        b = color & 0xff;

        for (i = 0; i < height; i++)
        {
                gint tmp;

                pixdest = target_pixels + i * dst_row_stride;
                pixsrc = original_pixels + i * src_row_stride;
                for (j = 0; j < width; j++)
                {
                        tmp = (*pixsrc++ * alpha + r * (255 - alpha)) / 255;
                        *pixdest++ = (guchar) MIN(255, tmp);
                        tmp = (*pixsrc++ * alpha + g * (255 - alpha)) / 255;
                        *pixdest++ = (guchar) MIN(255, tmp);
                        tmp = (*pixsrc++ * alpha + b * (255 - alpha)) / 255;
                        *pixdest++ = (guchar) MIN(255, tmp);
                        if (has_alpha)
                                *pixdest++ = *pixsrc++;
                }
        }

        return dest;
}

/* Load all the standard pixmaps. Also sets the default window icon. */
static void load_default_pixmaps(void)
{
        GdkPixbuf *pixbuf;
        GError *error = NULL;

        im_error = mp_from_stock(GTK_STOCK_DIALOG_WARNING);
        im_unknown = mp_from_stock(GTK_STOCK_DIALOG_QUESTION);
        im_symlink = load_pixmap("symlink");

        im_unmounted = load_pixmap("mount");
        im_mounted = load_pixmap("mounted");
        im_appdir = load_pixmap("application");

        im_dirs = load_pixmap("dirs");

        pixbuf = gdk_pixbuf_new_from_file(
                        make_path(app_dir, ".DirIcon")->str, &error);
        if (pixbuf)
        {
                GList *icon_list;

                icon_list = g_list_append(NULL, pixbuf);
                gtk_window_set_default_icon_list(icon_list);
                g_list_free(icon_list);

                g_object_unref(G_OBJECT(pixbuf));
        }
        else
        {
                g_print("%s\n", error ? error->message : _("Unknown error"));
                g_error_free(error);
        }
}