2 * (SLIK) SimpLIstic sKin functions
4 * Copyright (C) 2008 - 2009 The Geeqie Team
8 * This software is released under the GNU General Public License (GNU GPL).
9 * Please read the included file COPYING for more information.
10 * This software comes with no warranty of any kind, use at your own risk!
22 #include <sys/param.h>
27 #include <gtk/gtk.h> /* for locale warning dialog */
30 #include "ui_fileops.h"
32 #include "ui_utildlg.h" /* for locale warning dialog */
35 *-----------------------------------------------------------------------------
36 * generic file information and manipulation routines (public)
37 *-----------------------------------------------------------------------------
42 void print_term(const gchar *text_utf8)
46 text_l = g_locale_from_utf8(text_utf8, -1, NULL, NULL, NULL);
47 fputs((text_l) ? text_l : text_utf8, stdout);
51 static void encoding_dialog(const gchar *path);
53 static gint encoding_dialog_idle(gpointer data)
57 encoding_dialog(path);
63 static gint encoding_dialog_delay(gpointer data)
65 g_idle_add(encoding_dialog_idle, data);
70 static void encoding_dialog(const gchar *path)
72 static gint warned_user = FALSE;
78 /* check that gtk is initialized (loop is level > 0) */
79 if (gtk_main_level() == 0)
81 /* gtk not initialized */
82 gtk_init_add(encoding_dialog_delay, g_strdup(path));
86 if (warned_user) return;
90 bf = getenv("G_BROKEN_FILENAMES");
92 string = g_string_new("");
93 g_string_append(string, _("One or more filenames are not encoded with the preferred locale character set.\n"));
94 g_string_append_printf(string, _("Operations on, and display of these files with %s may not succeed.\n"), PACKAGE);
95 g_string_append(string, "\n");
96 g_string_append(string, _("If your filenames are not encoded in utf-8, try setting the environment variable G_BROKEN_FILENAMES=1\n"));
98 g_string_append_printf(string, _("It appears G_BROKEN_FILENAMES is set to %s\n"), bf);
100 g_string_append(string, _("It appears G_BROKEN_FILENAMES is not set\n"));
101 g_string_append(string, "\n");
102 g_string_append_printf(string, _("The locale appears to be set to \"%s\"\n(set by the LANG environment variable)\n"), (lc) ? lc : "undefined");
103 if (lc && (strstr(lc, "UTF-8") || strstr(lc, "utf-8")))
106 name = g_convert(path, -1, "UTF-8", "ISO-8859-1", NULL, NULL, NULL);
107 string = g_string_append(string, _("\nPreferred encoding appears to be UTF-8, however the file:\n"));
108 g_string_append_printf(string, "\"%s\"\n", (name) ? name : _("[name not displayable]"));
110 if (g_utf8_validate(path, -1, NULL))
111 g_string_append_printf(string, _("\"%s\" is encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
113 g_string_append_printf(string, _("\"%s\" is not encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
114 g_string_append(string, "\n");
118 gd = generic_dialog_new(_("Filename encoding locale mismatch"),
119 "locale warning", NULL, TRUE, NULL, NULL);
120 generic_dialog_add_button(gd, GTK_STOCK_CLOSE, NULL, NULL, TRUE);
122 generic_dialog_add_message(gd, GTK_STOCK_DIALOG_WARNING,
123 _("Filename encoding locale mismatch"), string->str);
125 gtk_widget_show(gd->dialog);
127 g_string_free(string, TRUE);
130 gchar *path_to_utf8(const gchar *path)
133 GError *error = NULL;
135 if (!path) return NULL;
137 utf8 = g_filename_to_utf8(path, -1, NULL, NULL, &error);
140 log_printf("Unable to convert filename to UTF-8:\n%s\n%s\n", path, error->message);
142 encoding_dialog(path);
146 /* just let it through, but bad things may happen */
147 utf8 = g_strdup(path);
153 gchar *path_from_utf8(const gchar *utf8)
156 GError *error = NULL;
158 if (!utf8) return NULL;
160 path = g_filename_from_utf8(utf8, -1, NULL, NULL, &error);
163 log_printf("Unable to convert filename to locale from UTF-8:\n%s\n%s\n", utf8, error->message);
168 /* if invalid UTF-8, text probaby still in original form, so just copy it */
169 path = g_strdup(utf8);
175 /* first we try the HOME environment var, if that doesn't work, we try g_get_homedir(). */
176 const gchar *homedir(void)
178 static gchar *home = NULL;
181 home = path_to_utf8(getenv("HOME"));
184 home = path_to_utf8(g_get_home_dir());
189 static gchar *xdg_dir_get(const gchar *key, const gchar *fallback)
191 gchar *dir = getenv(key);
193 if (!dir || dir[0] == '\0')
195 return g_build_filename(homedir(), fallback, NULL);
198 return path_to_utf8(dir);
201 const gchar *xdg_data_home_get(void)
203 static const gchar *xdg_data_home = NULL;
205 if (xdg_data_home) return xdg_data_home;
207 xdg_data_home = xdg_dir_get("XDG_DATA_HOME", ".local/share");
209 return xdg_data_home;
212 const gchar *xdg_config_home_get(void)
214 static const gchar *xdg_config_home = NULL;
216 if (xdg_config_home) return xdg_config_home;
218 xdg_config_home = xdg_dir_get("XDG_CONFIG_HOME", ".config");
220 return xdg_config_home;
223 const gchar *xdg_cache_home_get(void)
225 static const gchar *xdg_cache_home = NULL;
227 if (xdg_cache_home) return xdg_cache_home;
229 xdg_cache_home = xdg_dir_get("XDG_CACHE_HOME", ".cache");
231 return xdg_cache_home;
234 const gchar *get_rc_dir(void)
236 static gchar *rc_dir = NULL;
238 if (rc_dir) return rc_dir;
242 rc_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, NULL);
246 rc_dir = g_build_filename(homedir(), GQ_RC_DIR, NULL);
252 const gchar *get_collections_dir(void)
254 static gchar *collections_dir = NULL;
256 if (collections_dir) return collections_dir;
260 collections_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_COLLECTIONS_DIR, NULL);
264 collections_dir = g_build_filename(get_rc_dir(), GQ_COLLECTIONS_DIR, NULL);
267 return collections_dir;
270 const gchar *get_trash_dir(void)
272 static gchar *trash_dir = NULL;
274 if (trash_dir) return trash_dir;
278 trash_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_TRASH_DIR, NULL);
282 trash_dir = g_build_filename(get_rc_dir(), GQ_TRASH_DIR, NULL);
288 gint stat_utf8(const gchar *s, struct stat *st)
293 if (!s) return FALSE;
294 sl = path_from_utf8(s);
295 ret = (stat(sl, st) == 0);
301 gint lstat_utf8(const gchar *s, struct stat *st)
306 if (!s) return FALSE;
307 sl = path_from_utf8(s);
308 ret = (lstat(sl, st) == 0);
314 /* extension must contain only ASCII characters */
315 gint stat_utf8_case_insensitive_ext(GString *base, const gchar *ext, struct stat *st)
321 gint base_len = strlen(base->str);
323 g_string_append(base, ext);
324 sl = path_from_utf8(base->str);
326 extl = strrchr(sl, '.');
330 extl++; /* the first char after . */
331 ext_len = strlen(extl);
333 for (i = 0; i < (1 << ext_len); i++)
335 for (j = 0; j < ext_len; j++)
338 extl[j] = g_ascii_toupper(extl[j]);
340 extl[j] = g_ascii_tolower(extl[j]);
342 ret = (stat(sl, st) == 0);
348 /* append the found extension to base */
349 base = g_string_truncate(base, base_len);
351 g_string_append(base, extl);
359 gint isname(const gchar *s)
363 return stat_utf8(s, &st);
366 gint isfile(const gchar *s)
370 return (stat_utf8(s, &st) && S_ISREG(st.st_mode));
373 gint isdir(const gchar *s)
377 return (stat_utf8(s, &st) && S_ISDIR(st.st_mode));
380 gint islink(const gchar *s)
384 return (lstat_utf8(s, &st) && S_ISLNK(st.st_mode));
387 gint64 filesize(const gchar *s)
391 if (!stat_utf8(s, &st)) return 0;
395 time_t filetime(const gchar *s)
399 if (!stat_utf8(s, &st)) return 0;
403 gint filetime_set(const gchar *s, time_t tval)
412 ut.actime = ut.modtime = tval;
414 sl = path_from_utf8(s);
415 ret = (utime(sl, &ut) == 0);
422 gboolean is_readable_file(const gchar *s)
424 if (!s || !s[0] || !isfile(s)) return FALSE;
425 return access_file(s, R_OK);
428 gint access_file(const gchar *s, gint mode)
433 if (!s || !s[0]) return FALSE;
435 sl = path_from_utf8(s);
436 ret = (access(sl, mode) == 0);
442 gint unlink_file(const gchar *s)
447 if (!s) return FALSE;
449 sl = path_from_utf8(s);
450 ret = (unlink(sl) == 0);
456 gint symlink_utf8(const gchar *source, const gchar *target)
462 if (!source || !target) return FALSE;
464 sl = path_from_utf8(source);
465 tl = path_from_utf8(target);
467 ret = (symlink(sl, tl) == 0);
475 gint mkdir_utf8(const gchar *s, gint mode)
480 if (!s) return FALSE;
482 sl = path_from_utf8(s);
483 ret = (mkdir(sl, mode) == 0);
488 gint rmdir_utf8(const gchar *s)
493 if (!s) return FALSE;
495 sl = path_from_utf8(s);
496 ret = (rmdir(sl) == 0);
502 gint copy_file_attributes(const gchar *s, const gchar *t, gint perms, gint mtime)
508 if (!s || !t) return FALSE;
510 sl = path_from_utf8(s);
511 tl = path_from_utf8(t);
513 if (stat(sl, &st) == 0)
519 /* set the dest file attributes to that of source (ignoring errors) */
521 if (perms && chown(tl, st.st_uid, st.st_gid) < 0) ret = FALSE;
522 if (perms && chmod(tl, st.st_mode) < 0) ret = FALSE;
524 tb.actime = st.st_atime;
525 tb.modtime = st.st_mtime;
526 if (mtime && utime(tl, &tb) < 0) ret = FALSE;
535 /* paths are in filesystem encoding */
536 static gint hard_linked(const gchar *a, const gchar *b)
541 if (stat(a, &sta) != 0 || stat(b, &stb) != 0) return FALSE;
543 return (sta.st_dev == stb.st_dev &&
544 sta.st_ino == stb.st_ino);
547 gint copy_file(const gchar *s, const gchar *t)
555 sl = path_from_utf8(s);
556 tl = path_from_utf8(t);
558 if (hard_linked(sl, tl))
565 fi = fopen(sl, "rb");
568 fo = fopen(tl, "wb");
579 if (!fi || !fo) return FALSE;
581 while ((b = fread(buf, sizeof(gchar), sizeof(buf), fi)) && b != 0)
583 if (fwrite(buf, sizeof(gchar), b, fo) != b)
594 copy_file_attributes(s, t, TRUE, TRUE);
599 gint move_file(const gchar *s, const gchar *t)
604 if (!s || !t) return FALSE;
606 sl = path_from_utf8(s);
607 tl = path_from_utf8(t);
608 if (rename(sl, tl) < 0)
610 /* this may have failed because moving a file across filesystems
611 was attempted, so try copy and delete instead */
616 /* err, now we can't delete the source file so return FALSE */
631 gint rename_file(const gchar *s, const gchar *t)
636 if (!s || !t) return FALSE;
638 sl = path_from_utf8(s);
639 tl = path_from_utf8(t);
640 ret = (rename(sl, tl) == 0);
647 gchar *get_current_dir(void)
652 pathl = g_get_current_dir();
653 path8 = path_to_utf8(pathl);
659 void string_list_free(GList *list)
661 g_list_foreach(list, (GFunc)g_free, NULL);
665 GList *string_list_copy(const GList *list)
667 GList *new_list = NULL;
668 GList *work = (GList *) list;
677 new_list = g_list_prepend(new_list, g_strdup(path));
680 return g_list_reverse(new_list);
683 gchar *unique_filename(const gchar *path, const gchar *ext, const gchar *divider, gint pad)
689 if (!divider) divider = "";
691 unique = g_strconcat(path, ext, NULL);
692 while (isname(unique))
697 unique = g_strdup_printf("%s%s%03d%s", path, divider, n, ext);
701 unique = g_strdup_printf("%s%s%d%s", path, divider, n, ext);
715 gchar *unique_filename_simple(const gchar *path)
721 if (!path) return NULL;
723 name = filename_from_path(path);
724 if (!name) return NULL;
726 ext = extension_from_path(name);
730 unique = unique_filename(path, NULL, "_", TRUE);
736 base = remove_extension_from_path(path);
737 unique = unique_filename(base, ext, "_", TRUE);
744 const gchar *filename_from_path(const gchar *path)
748 if (!path) return NULL;
750 base = strrchr(path, G_DIR_SEPARATOR);
751 if (base) return base + 1;
756 gchar *remove_level_from_path(const gchar *path)
760 if (!path) return NULL;
764 if (path[p] == G_DIR_SEPARATOR) n = p;
769 return g_strndup(path, (gsize) n);
772 const gchar *extension_from_path(const gchar *path)
774 if (!path) return NULL;
775 return strrchr(path, '.');
778 gint file_extension_match(const gchar *path, const gchar *ext)
783 if (!path) return FALSE;
784 if (!ext) return TRUE;
790 return (p > e && g_ascii_strncasecmp(path + p - e, ext, e) == 0);
793 gchar *remove_extension_from_path(const gchar *path)
797 if (!path) return NULL;
801 if (path[p] == '.') n = p;
806 return g_strndup(path, (gsize) n);
809 void parse_out_relatives(gchar *path)
817 while (path[s] != '\0')
819 if (path[s] == G_DIR_SEPARATOR && path[s+1] == '.')
821 /* /. occurence, let's see more */
824 if (path[p] == G_DIR_SEPARATOR || path[p] == '\0')
826 /* /./ or /., just skip this part */
830 else if (path[p] == '.' && (path[p+1] == G_DIR_SEPARATOR || path[p+1] == '\0'))
832 /* /../ or /.., remove previous part, ie. /a/b/../ becomes /a/ */
835 while (path[t] != G_DIR_SEPARATOR && t > 0) t--;
840 if (s != t) path[t] = path[s];
845 if (t == 0 && path[t] == G_DIR_SEPARATOR) t++;
846 if (t > 1 && path[t-1] == G_DIR_SEPARATOR) t--;
850 gint file_in_path(const gchar *name)
857 if (!name) return FALSE;
858 path = g_strdup(getenv("PATH"));
859 if (!path) return FALSE;
860 namel = path_from_utf8(name);
864 while (p < l && !ret)
868 while (path[e] != ':' && path[e] != '\0') e++;
871 f = g_build_filename(path + p, namel, NULL);
872 if (isfile(f)) ret = TRUE;
882 gboolean recursive_mkdir_if_not_exists(const gchar *path, mode_t mode)
884 if (!path) return FALSE;
888 gchar *npath = g_strdup(path);
894 if (p[0] == G_DIR_SEPARATOR || p[0] == '\0')
906 DEBUG_1("creating sub dir:%s", npath);
907 if (!mkdir_utf8(npath, mode))
909 log_printf("create dir failed: %s\n", npath);
915 if (!end) p[0] = G_DIR_SEPARATOR;
926 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */