Blame fc-cache/fc-cache.c

Packit 352660
/*
Packit 352660
 * fontconfig/fc-cache/fc-cache.c
Packit 352660
 *
Packit 352660
 * Copyright © 2002 Keith Packard
Packit 352660
 *
Packit 352660
 * Permission to use, copy, modify, distribute, and sell this software and its
Packit 352660
 * documentation for any purpose is hereby granted without fee, provided that
Packit 352660
 * the above copyright notice appear in all copies and that both that
Packit 352660
 * copyright notice and this permission notice appear in supporting
Packit 352660
 * documentation, and that the name of the author(s) not be used in
Packit 352660
 * advertising or publicity pertaining to distribution of the software without
Packit 352660
 * specific, written prior permission.  The authors make no
Packit 352660
 * representations about the suitability of this software for any purpose.  It
Packit 352660
 * is provided "as is" without express or implied warranty.
Packit 352660
 *
Packit 352660
 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
Packit 352660
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
Packit 352660
 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
Packit 352660
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
Packit 352660
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
Packit 352660
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
Packit 352660
 * PERFORMANCE OF THIS SOFTWARE.
Packit 352660
 */
Packit 352660
Packit 352660
#ifdef HAVE_CONFIG_H
Packit 352660
#include <config.h>
Packit 352660
#else
Packit 352660
#ifdef linux
Packit 352660
#define HAVE_GETOPT_LONG 1
Packit 352660
#endif
Packit 352660
#define HAVE_GETOPT 1
Packit 352660
#endif
Packit 352660
Packit 352660
#include <fontconfig/fontconfig.h>
Packit 352660
#include <stdio.h>
Packit 352660
#include <stdlib.h>
Packit 352660
#include <unistd.h>
Packit 352660
#include <sys/types.h>
Packit 352660
#include <sys/stat.h>
Packit 352660
#include <errno.h>
Packit 352660
#include <fcntl.h>
Packit 352660
#include <dirent.h>
Packit 352660
#include <string.h>
Packit 352660
#include <locale.h>
Packit 352660
Packit 352660
#if defined (_WIN32)
Packit 352660
#define STRICT
Packit 352660
#include <windows.h>
Packit 352660
#define sleep(x) Sleep((x) * 1000)
Packit 352660
#undef STRICT
Packit 352660
#endif
Packit 352660
Packit 352660
#ifdef ENABLE_NLS
Packit 352660
#include <libintl.h>
Packit 352660
#define _(x)		(dgettext(GETTEXT_PACKAGE, x))
Packit 352660
#else
Packit 352660
#define dgettext(d, s)	(s)
Packit 352660
#define _(x)		(x)
Packit 352660
#endif
Packit 352660
Packit 352660
#ifndef O_BINARY
Packit 352660
#define O_BINARY 0
Packit 352660
#endif
Packit 352660
Packit 352660
#ifndef HAVE_GETOPT
Packit 352660
#define HAVE_GETOPT 0
Packit 352660
#endif
Packit 352660
#ifndef HAVE_GETOPT_LONG
Packit 352660
#define HAVE_GETOPT_LONG 0
Packit 352660
#endif
Packit 352660
Packit 352660
#if HAVE_GETOPT_LONG
Packit 352660
#undef  _GNU_SOURCE
Packit 352660
#define _GNU_SOURCE
Packit 352660
#include <getopt.h>
Packit 352660
const struct option longopts[] = {
Packit 352660
    {"error-on-no-fonts", 0, 0, 'E'},
Packit 352660
    {"force", 0, 0, 'f'},
Packit 352660
    {"really-force", 0, 0, 'r'},
Packit 352660
    {"sysroot", required_argument, 0, 'y'},
Packit 352660
    {"system-only", 0, 0, 's'},
Packit 352660
    {"version", 0, 0, 'V'},
Packit 352660
    {"verbose", 0, 0, 'v'},
Packit 352660
    {"help", 0, 0, 'h'},
Packit 352660
    {NULL,0,0,0},
Packit 352660
};
Packit 352660
#else
Packit 352660
#if HAVE_GETOPT
Packit 352660
extern char *optarg;
Packit 352660
extern int optind, opterr, optopt;
Packit 352660
#endif
Packit 352660
#endif
Packit 352660
Packit 352660
static void
Packit 352660
usage (char *program, int error)
Packit 352660
{
Packit 352660
    FILE *file = error ? stderr : stdout;
Packit 352660
#if HAVE_GETOPT_LONG
Packit 352660
    fprintf (file, _("usage: %s [-EfrsvVh] [-y SYSROOT] [--error-on-no-fonts] [--force|--really-force] [--sysroot=SYSROOT] [--system-only] [--verbose] [--version] [--help] [dirs]\n"),
Packit 352660
	     program);
Packit 352660
#else
Packit 352660
    fprintf (file, _("usage: %s [-EfrsvVh] [-y SYSROOT] [dirs]\n"),
Packit 352660
	     program);
Packit 352660
#endif
Packit 352660
    fprintf (file, _("Build font information caches in [dirs]\n"
Packit 352660
		     "(all directories in font configuration by default).\n"));
Packit 352660
    fprintf (file, "\n");
Packit 352660
#if HAVE_GETOPT_LONG
Packit 352660
    fprintf (file, _("  -E, --error-on-no-fonts  raise an error if no fonts in a directory\n"));
Packit 352660
    fprintf (file, _("  -f, --force              scan directories with apparently valid caches\n"));
Packit 352660
    fprintf (file, _("  -r, --really-force       erase all existing caches, then rescan\n"));
Packit 352660
    fprintf (file, _("  -s, --system-only        scan system-wide directories only\n"));
Packit 352660
    fprintf (file, _("  -y, --sysroot=SYSROOT    prepend SYSROOT to all paths for scanning\n"));
Packit 352660
    fprintf (file, _("  -v, --verbose            display status information while busy\n"));
Packit 352660
    fprintf (file, _("  -V, --version            display font config version and exit\n"));
Packit 352660
    fprintf (file, _("  -h, --help               display this help and exit\n"));
Packit 352660
#else
Packit 352660
    fprintf (file, _("  -E         (error-on-no-fonts)\n"));
Packit 352660
    fprintf (file, _("                       raise an error if no fonts in a directory\n"));
Packit 352660
    fprintf (file, _("  -f         (force)   scan directories with apparently valid caches\n"));
Packit 352660
    fprintf (file, _("  -r,   (really force) erase all existing caches, then rescan\n"));
Packit 352660
    fprintf (file, _("  -s         (system)  scan system-wide directories only\n"));
Packit 352660
    fprintf (file, _("  -y SYSROOT (sysroot) prepend SYSROOT to all paths for scanning\n"));
Packit 352660
    fprintf (file, _("  -v         (verbose) display status information while busy\n"));
Packit 352660
    fprintf (file, _("  -V         (version) display font config version and exit\n"));
Packit 352660
    fprintf (file, _("  -h         (help)    display this help and exit\n"));
Packit 352660
#endif
Packit 352660
    exit (error);
Packit 352660
}
Packit 352660
Packit 352660
static FcStrSet *processed_dirs;
Packit 352660
Packit 352660
static int
Packit 352660
scanDirs (FcStrList *list, FcConfig *config, FcBool force, FcBool really_force, FcBool verbose, FcBool error_on_no_fonts, int *changed)
Packit 352660
{
Packit 352660
    int		    ret = 0;
Packit 352660
    const FcChar8   *dir;
Packit 352660
    FcStrSet	    *subdirs;
Packit 352660
    FcStrList	    *sublist;
Packit 352660
    FcCache	    *cache;
Packit 352660
    struct stat	    statb;
Packit 352660
    FcBool	    was_valid, was_processed = FcFalse;
Packit 352660
    int		    i;
Packit 352660
    const FcChar8   *sysroot = FcConfigGetSysRoot (config);
Packit 352660
Packit 352660
    /*
Packit 352660
     * Now scan all of the directories into separate databases
Packit 352660
     * and write out the results
Packit 352660
     */
Packit 352660
    while ((dir = FcStrListNext (list)))
Packit 352660
    {
Packit 352660
	if (verbose)
Packit 352660
	{
Packit 352660
	    if (sysroot)
Packit 352660
		printf ("[%s]", sysroot);
Packit 352660
	    printf ("%s: ", dir);
Packit 352660
	    fflush (stdout);
Packit 352660
	}
Packit 352660
	
Packit 352660
	if (FcStrSetMember (processed_dirs, dir))
Packit 352660
	{
Packit 352660
	    if (verbose)
Packit 352660
		printf (_("skipping, looped directory detected\n"));
Packit 352660
	    continue;
Packit 352660
	}
Packit 352660
Packit 352660
	if (stat ((char *) dir, &statb) == -1)
Packit 352660
	{
Packit 352660
	    switch (errno) {
Packit 352660
	    case ENOENT:
Packit 352660
	    case ENOTDIR:
Packit 352660
		if (verbose)
Packit 352660
		    printf (_("skipping, no such directory\n"));
Packit 352660
		break;
Packit 352660
	    default:
Packit 352660
		fprintf (stderr, "\"%s\": ", dir);
Packit 352660
		perror ("");
Packit 352660
		ret++;
Packit 352660
		break;
Packit 352660
	    }
Packit 352660
	    continue;
Packit 352660
	}
Packit 352660
Packit 352660
	if (!S_ISDIR (statb.st_mode))
Packit 352660
	{
Packit 352660
	    fprintf (stderr, _("\"%s\": not a directory, skipping\n"), dir);
Packit 352660
	    continue;
Packit 352660
	}
Packit 352660
	was_processed = FcTrue;
Packit 352660
Packit 352660
	if (really_force)
Packit 352660
	{
Packit 352660
	    FcDirCacheUnlink (dir, config);
Packit 352660
	    FcDirCacheCreateUUID ((FcChar8 *) dir, FcTrue, config);
Packit 352660
	}
Packit 352660
Packit 352660
	cache = NULL;
Packit 352660
	was_valid = FcFalse;
Packit 352660
	if (!force) {
Packit 352660
	    cache = FcDirCacheLoad (dir, config, NULL);
Packit 352660
	    if (cache)
Packit 352660
		was_valid = FcTrue;
Packit 352660
	}
Packit 352660
	
Packit 352660
	if (!cache)
Packit 352660
	{
Packit 352660
	    (*changed)++;
Packit 352660
	    cache = FcDirCacheRead (dir, FcTrue, config);
Packit 352660
	    if (!cache)
Packit 352660
	    {
Packit 352660
		fprintf (stderr, _("\"%s\": scanning error\n"), dir);
Packit 352660
		ret++;
Packit 352660
		continue;
Packit 352660
	    }
Packit 352660
	}
Packit 352660
Packit 352660
	if (was_valid)
Packit 352660
	{
Packit 352660
	    if (verbose)
Packit 352660
		printf (_("skipping, existing cache is valid: %d fonts, %d dirs\n"),
Packit 352660
			FcCacheNumFont (cache), FcCacheNumSubdir (cache));
Packit 352660
	}
Packit 352660
	else
Packit 352660
	{
Packit 352660
	    if (verbose)
Packit 352660
		printf (_("caching, new cache contents: %d fonts, %d dirs\n"),
Packit 352660
			FcCacheNumFont (cache), FcCacheNumSubdir (cache));
Packit 352660
Packit 352660
	    if (!FcDirCacheValid (dir))
Packit 352660
	    {
Packit 352660
		fprintf (stderr, _("%s: failed to write cache\n"), dir);
Packit 352660
		(void) FcDirCacheUnlink (dir, config);
Packit 352660
		ret++;
Packit 352660
	    }
Packit 352660
	}
Packit 352660
Packit 352660
	subdirs = FcStrSetCreate ();
Packit 352660
	if (!subdirs)
Packit 352660
	{
Packit 352660
	    fprintf (stderr, _("%s: Can't create subdir set\n"), dir);
Packit 352660
	    ret++;
Packit 352660
	    FcDirCacheUnload (cache);
Packit 352660
	    continue;
Packit 352660
	}
Packit 352660
	for (i = 0; i < FcCacheNumSubdir (cache); i++)
Packit 352660
	    FcStrSetAdd (subdirs, FcCacheSubdir (cache, i));
Packit 352660
	
Packit 352660
	FcDirCacheUnload (cache);
Packit 352660
Packit 352660
	sublist = FcStrListCreate (subdirs);
Packit 352660
	FcStrSetDestroy (subdirs);
Packit 352660
	if (!sublist)
Packit 352660
	{
Packit 352660
	    fprintf (stderr, _("%s: Can't create subdir list\n"), dir);
Packit 352660
	    ret++;
Packit 352660
	    continue;
Packit 352660
	}
Packit 352660
	FcStrSetAdd (processed_dirs, dir);
Packit 352660
	ret += scanDirs (sublist, config, force, really_force, verbose, error_on_no_fonts, changed);
Packit 352660
	FcStrListDone (sublist);
Packit 352660
    }
Packit 352660
    if (error_on_no_fonts && !was_processed)
Packit 352660
	ret++;
Packit 352660
    return ret;
Packit 352660
}
Packit 352660
Packit 352660
static FcBool
Packit 352660
cleanCacheDirectories (FcConfig *config, FcBool verbose)
Packit 352660
{
Packit 352660
    FcStrList	*cache_dirs = FcConfigGetCacheDirs (config);
Packit 352660
    FcChar8	*cache_dir;
Packit 352660
    FcBool	ret = FcTrue;
Packit 352660
Packit 352660
    if (!cache_dirs)
Packit 352660
	return FcFalse;
Packit 352660
    while ((cache_dir = FcStrListNext (cache_dirs)))
Packit 352660
    {
Packit 352660
	if (!FcDirCacheClean (cache_dir, verbose))
Packit 352660
	{
Packit 352660
	    ret = FcFalse;
Packit 352660
	    break;
Packit 352660
	}
Packit 352660
    }
Packit 352660
    FcStrListDone (cache_dirs);
Packit 352660
    return ret;
Packit 352660
}
Packit 352660
Packit 352660
int
Packit 352660
main (int argc, char **argv)
Packit 352660
{
Packit 352660
    FcStrSet	*dirs;
Packit 352660
    FcStrList	*list;
Packit 352660
    FcBool    	verbose = FcFalse;
Packit 352660
    FcBool	force = FcFalse;
Packit 352660
    FcBool	really_force = FcFalse;
Packit 352660
    FcBool	systemOnly = FcFalse;
Packit 352660
    FcBool	error_on_no_fonts = FcFalse;
Packit 352660
    FcConfig	*config;
Packit 352660
    FcChar8     *sysroot = NULL;
Packit 352660
    int		i;
Packit 352660
    int		changed;
Packit 352660
    int		ret;
Packit 352660
#if HAVE_GETOPT_LONG || HAVE_GETOPT
Packit 352660
    int		c;
Packit 352660
Packit 352660
    setlocale (LC_ALL, "");
Packit 352660
#if HAVE_GETOPT_LONG
Packit 352660
    while ((c = getopt_long (argc, argv, "Efrsy:Vvh", longopts, NULL)) != -1)
Packit 352660
#else
Packit 352660
    while ((c = getopt (argc, argv, "Efrsy:Vvh")) != -1)
Packit 352660
#endif
Packit 352660
    {
Packit 352660
	switch (c) {
Packit 352660
	case 'E':
Packit 352660
	    error_on_no_fonts = FcTrue;
Packit 352660
	    break;
Packit 352660
	case 'r':
Packit 352660
	    really_force = FcTrue;
Packit 352660
	    /* fall through */
Packit 352660
	case 'f':
Packit 352660
	    force = FcTrue;
Packit 352660
	    break;
Packit 352660
	case 's':
Packit 352660
	    systemOnly = FcTrue;
Packit 352660
	    break;
Packit 352660
	case 'y':
Packit 352660
	    sysroot = FcStrCopy ((const FcChar8 *)optarg);
Packit 352660
	    break;
Packit 352660
	case 'V':
Packit 352660
	    fprintf (stderr, "fontconfig version %d.%d.%d\n",
Packit 352660
		     FC_MAJOR, FC_MINOR, FC_REVISION);
Packit 352660
	    exit (0);
Packit 352660
	case 'v':
Packit 352660
	    verbose = FcTrue;
Packit 352660
	    break;
Packit 352660
	case 'h':
Packit 352660
	    usage (argv[0], 0);
Packit 352660
	default:
Packit 352660
	    usage (argv[0], 1);
Packit 352660
	}
Packit 352660
    }
Packit 352660
    i = optind;
Packit 352660
#else
Packit 352660
    i = 1;
Packit 352660
#endif
Packit 352660
Packit 352660
    if (systemOnly)
Packit 352660
	FcConfigEnableHome (FcFalse);
Packit 352660
    if (sysroot)
Packit 352660
    {
Packit 352660
	FcConfigSetSysRoot (NULL, sysroot);
Packit 352660
	FcStrFree (sysroot);
Packit 352660
	config = FcConfigGetCurrent();
Packit 352660
    }
Packit 352660
    else
Packit 352660
    {
Packit 352660
	config = FcInitLoadConfig ();
Packit 352660
    }
Packit 352660
    if (!config)
Packit 352660
    {
Packit 352660
	fprintf (stderr, _("%s: Can't initialize font config library\n"), argv[0]);
Packit 352660
	return 1;
Packit 352660
    }
Packit 352660
    FcConfigSetCurrent (config);
Packit 352660
Packit 352660
    if (argv[i])
Packit 352660
    {
Packit 352660
	dirs = FcStrSetCreate ();
Packit 352660
	if (!dirs)
Packit 352660
	{
Packit 352660
	    fprintf (stderr, _("%s: Can't create list of directories\n"),
Packit 352660
		     argv[0]);
Packit 352660
	    return 1;
Packit 352660
	}
Packit 352660
	while (argv[i])
Packit 352660
	{
Packit 352660
	    if (!FcStrSetAddFilename (dirs, (FcChar8 *) argv[i]))
Packit 352660
	    {
Packit 352660
		fprintf (stderr, _("%s: Can't add directory\n"), argv[0]);
Packit 352660
		return 1;
Packit 352660
	    }
Packit 352660
	    i++;
Packit 352660
	}
Packit 352660
	list = FcStrListCreate (dirs);
Packit 352660
	FcStrSetDestroy (dirs);
Packit 352660
    }
Packit 352660
    else
Packit 352660
	list = FcConfigGetFontDirs (config);
Packit 352660
Packit 352660
    if ((processed_dirs = FcStrSetCreate()) == NULL) {
Packit 352660
	fprintf(stderr, _("Out of Memory\n"));
Packit 352660
	return 1;
Packit 352660
    }
Packit 352660
Packit 352660
    changed = 0;
Packit 352660
    ret = scanDirs (list, config, force, really_force, verbose, error_on_no_fonts, &changed);
Packit 352660
    FcStrListDone (list);
Packit 352660
Packit 352660
    /*
Packit 352660
     * Try to create CACHEDIR.TAG anyway.
Packit 352660
     * This expects the fontconfig cache directory already exists.
Packit 352660
     * If it doesn't, it won't be simply created.
Packit 352660
     */
Packit 352660
    FcCacheCreateTagFile (config);
Packit 352660
Packit 352660
    FcStrSetDestroy (processed_dirs);
Packit 352660
Packit 352660
    cleanCacheDirectories (config, verbose);
Packit 352660
Packit 352660
    FcConfigDestroy (config);
Packit 352660
    FcFini ();
Packit 352660
    /* 
Packit 352660
     * Now we need to sleep a second  (or two, to be extra sure), to make
Packit 352660
     * sure that timestamps for changes after this run of fc-cache are later
Packit 352660
     * then any timestamps we wrote.  We don't use gettimeofday() because
Packit 352660
     * sleep(3) can't be interrupted by a signal here -- this isn't in the
Packit 352660
     * library, and there aren't any signals flying around here.
Packit 352660
     */
Packit 352660
    /* the resolution of mtime on FAT is 2 seconds */
Packit 352660
    if (changed)
Packit 352660
	sleep (2);
Packit 352660
    if (verbose)
Packit 352660
	printf ("%s: %s\n", argv[0], ret ? _("failed") : _("succeeded"));
Packit 352660
    return ret;
Packit 352660
}