2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <sys/param.h>
34 #include <gtk/gtk.h> /* for locale warning dialog */
37 #include "ui_fileops.h"
39 #include "ui_utildlg.h" /* for locale warning dialog */
42 #include "filefilter.h"
45 #include "secure_save.h"
48 *-----------------------------------------------------------------------------
49 * generic file information and manipulation routines (public)
50 *-----------------------------------------------------------------------------
55 void print_term(gboolean err, const gchar *text_utf8)
59 text_l = g_locale_from_utf8(text_utf8, -1, NULL, NULL, NULL);
62 fputs((text_l) ? text_l : text_utf8, stderr);
66 fputs((text_l) ? text_l : text_utf8, stdout);
68 if(command_line && command_line->ssi)
69 secure_fputs(command_line->ssi, (text_l) ? text_l : text_utf8);
73 static void encoding_dialog(const gchar *path)
75 static gboolean warned_user = FALSE;
81 if (warned_user) return;
85 bf = getenv("G_BROKEN_FILENAMES");
87 string = g_string_new("");
88 g_string_append(string, _("One or more filenames are not encoded with the preferred locale character set.\n"));
89 g_string_append_printf(string, _("Operations on, and display of these files with %s may not succeed.\n"), PACKAGE);
90 g_string_append(string, "\n");
91 g_string_append(string, _("If your filenames are not encoded in utf-8, try setting the environment variable G_BROKEN_FILENAMES=1\n"));
93 g_string_append_printf(string, _("It appears G_BROKEN_FILENAMES is set to %s\n"), bf);
95 g_string_append(string, _("It appears G_BROKEN_FILENAMES is not set\n"));
96 g_string_append(string, "\n");
97 g_string_append_printf(string, _("The locale appears to be set to \"%s\"\n(set by the LANG environment variable)\n"), (lc) ? lc : "undefined");
98 if (lc && (strstr(lc, "UTF-8") || strstr(lc, "utf-8")))
101 name = g_convert(path, -1, "UTF-8", "ISO-8859-1", NULL, NULL, NULL);
102 string = g_string_append(string, _("\nPreferred encoding appears to be UTF-8, however the file:\n"));
103 g_string_append_printf(string, "\"%s\"\n", (name) ? name : _("[name not displayable]"));
105 if (g_utf8_validate(path, -1, NULL))
106 g_string_append_printf(string, _("\"%s\" is encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
108 g_string_append_printf(string, _("\"%s\" is not encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
109 g_string_append(string, "\n");
113 gd = generic_dialog_new(_("Filename encoding locale mismatch"),
114 "locale warning", NULL, TRUE, NULL, NULL);
115 generic_dialog_add_button(gd, GTK_STOCK_CLOSE, NULL, NULL, TRUE);
117 generic_dialog_add_message(gd, GTK_STOCK_DIALOG_WARNING,
118 _("Filename encoding locale mismatch"), string->str, TRUE);
120 gtk_widget_show(gd->dialog);
122 g_string_free(string, TRUE);
125 #if GQ_DEBUG_PATH_UTF8
126 gchar *path_to_utf8_debug(const gchar *path, const gchar *file, gint line)
128 gchar *path_to_utf8(const gchar *path)
132 GError *error = NULL;
134 if (!path) return NULL;
136 utf8 = g_filename_to_utf8(path, -1, NULL, NULL, &error);
139 #if GQ_DEBUG_PATH_UTF8
140 log_printf("%s:%d: Unable to convert filename to UTF-8:\n%s\n%s\n", file, line, path, error->message);
142 log_printf("Unable to convert filename to UTF-8:\n%s\n%s\n", path, error->message);
145 encoding_dialog(path);
149 /* just let it through, but bad things may happen */
150 utf8 = g_strdup(path);
156 #if GQ_DEBUG_PATH_UTF8
157 gchar *path_from_utf8_debug(const gchar *utf8, const gchar *file, gint line)
159 gchar *path_from_utf8(const gchar *utf8)
163 GError *error = NULL;
165 if (!utf8) return NULL;
167 path = g_filename_from_utf8(utf8, -1, NULL, NULL, &error);
170 #if GQ_DEBUG_PATH_UTF8
171 log_printf("%s:%d: Unable to convert filename to locale from UTF-8:\n%s\n%s\n", file, line, utf8, error->message);
173 log_printf("Unable to convert filename to locale from UTF-8:\n%s\n%s\n", utf8, error->message);
179 /* if invalid UTF-8, text probably still in original form, so just copy it */
180 path = g_strdup(utf8);
186 /* first we try the HOME environment var, if that doesn't work, we try g_get_homedir(). */
187 const gchar *homedir(void)
189 static gchar *home = NULL;
192 home = path_to_utf8(getenv("HOME"));
195 home = path_to_utf8(g_get_home_dir());
197 DEBUG_1("Home directory: %s", home);
202 static gchar *xdg_dir_get(const gchar *key, const gchar *fallback)
204 gchar *dir = getenv(key);
206 if (!dir || dir[0] == '\0')
208 return g_build_filename(homedir(), fallback, NULL);
211 DEBUG_1("Got xdg %s: %s", key, dir);
213 return path_to_utf8(dir);
216 const gchar *xdg_data_home_get(void)
218 static const gchar *xdg_data_home = NULL;
220 if (xdg_data_home) return xdg_data_home;
222 xdg_data_home = xdg_dir_get("XDG_DATA_HOME", ".local/share");
224 return xdg_data_home;
227 const gchar *xdg_config_home_get(void)
229 static const gchar *xdg_config_home = NULL;
231 if (xdg_config_home) return xdg_config_home;
233 xdg_config_home = xdg_dir_get("XDG_CONFIG_HOME", ".config");
235 return xdg_config_home;
238 const gchar *xdg_cache_home_get(void)
240 static const gchar *xdg_cache_home = NULL;
242 if (xdg_cache_home) return xdg_cache_home;
244 xdg_cache_home = xdg_dir_get("XDG_CACHE_HOME", ".cache");
246 return xdg_cache_home;
249 const gchar *get_rc_dir(void)
251 static gchar *rc_dir = NULL;
253 if (rc_dir) return rc_dir;
257 rc_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, NULL);
261 rc_dir = g_build_filename(homedir(), GQ_RC_DIR, NULL);
267 const gchar *get_collections_dir(void)
269 static gchar *collections_dir = NULL;
271 if (collections_dir) return collections_dir;
275 collections_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_COLLECTIONS_DIR, NULL);
279 collections_dir = g_build_filename(get_rc_dir(), GQ_COLLECTIONS_DIR, NULL);
282 return collections_dir;
285 const gchar *get_trash_dir(void)
287 static gchar *trash_dir = NULL;
289 if (trash_dir) return trash_dir;
293 trash_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_TRASH_DIR, NULL);
297 trash_dir = g_build_filename(get_rc_dir(), GQ_TRASH_DIR, NULL);
303 const gchar *get_window_layouts_dir(void)
305 static gchar *window_layouts_dir = NULL;
307 if (window_layouts_dir) return window_layouts_dir;
311 window_layouts_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, GQ_WINDOW_LAYOUTS_DIR, NULL);
315 window_layouts_dir = g_build_filename(get_rc_dir(), GQ_WINDOW_LAYOUTS_DIR, NULL);
318 return window_layouts_dir;
321 gboolean stat_utf8(const gchar *s, struct stat *st)
326 if (!s) return FALSE;
327 sl = path_from_utf8(s);
328 ret = (stat(sl, st) == 0);
334 gboolean lstat_utf8(const gchar *s, struct stat *st)
339 if (!s) return FALSE;
340 sl = path_from_utf8(s);
341 ret = (lstat(sl, st) == 0);
347 gboolean isname(const gchar *s)
351 return stat_utf8(s, &st);
354 gboolean isfile(const gchar *s)
358 return (stat_utf8(s, &st) && S_ISREG(st.st_mode));
361 gboolean isdir(const gchar *s)
365 return (stat_utf8(s, &st) && S_ISDIR(st.st_mode));
368 gboolean islink(const gchar *s)
372 return (lstat_utf8(s, &st) && S_ISLNK(st.st_mode));
375 gint64 filesize(const gchar *s)
379 if (!stat_utf8(s, &st)) return 0;
383 time_t filetime(const gchar *s)
387 if (!stat_utf8(s, &st)) return 0;
391 gboolean filetime_set(const gchar *s, time_t tval)
393 gboolean ret = FALSE;
400 ut.actime = ut.modtime = tval;
402 sl = path_from_utf8(s);
403 ret = (utime(sl, &ut) == 0);
410 gboolean is_readable_file(const gchar *s)
412 if (!s || !s[0] || !isfile(s)) return FALSE;
413 return access_file(s, R_OK);
416 gboolean access_file(const gchar *s, gint mode)
421 if (!s || !s[0]) return FALSE;
423 sl = path_from_utf8(s);
424 ret = (access(sl, mode) == 0);
430 gboolean unlink_file(const gchar *s)
435 if (!s) return FALSE;
437 sl = path_from_utf8(s);
438 ret = (unlink(sl) == 0);
444 gboolean symlink_utf8(const gchar *source, const gchar *target)
450 if (!source || !target) return FALSE;
452 sl = path_from_utf8(source);
453 tl = path_from_utf8(target);
455 ret = (symlink(sl, tl) == 0);
463 gboolean mkdir_utf8(const gchar *s, gint mode)
468 if (!s) return FALSE;
470 sl = path_from_utf8(s);
471 ret = (mkdir(sl, mode) == 0);
476 gboolean rmdir_utf8(const gchar *s)
481 if (!s) return FALSE;
483 sl = path_from_utf8(s);
484 ret = (rmdir(sl) == 0);
490 gboolean copy_file_attributes(const gchar *s, const gchar *t, gint perms, gint mtime)
494 gboolean ret = FALSE;
496 if (!s || !t) return FALSE;
498 sl = path_from_utf8(s);
499 tl = path_from_utf8(t);
501 if (stat(sl, &st) == 0)
507 /* set the dest file attributes to that of source (ignoring errors) */
511 ret = chown(tl, st.st_uid, st.st_gid);
512 /* Ignores chown errors, while still doing chown
513 (so root still can copy files preserving ownership) */
515 if (chmod(tl, st.st_mode) < 0) {
517 if (stat(tl, &st2) != 0 || st2.st_mode != st.st_mode) {
523 tb.actime = st.st_atime;
524 tb.modtime = st.st_mtime;
525 if (mtime && utime(tl, &tb) < 0) ret = FALSE;
534 /* paths are in filesystem encoding */
535 static gboolean hard_linked(const gchar *a, const gchar *b)
540 if (stat(a, &sta) != 0 || stat(b, &stb) != 0) return FALSE;
542 return (sta.st_dev == stb.st_dev &&
543 sta.st_ino == stb.st_ino);
546 gboolean copy_file(const gchar *s, const gchar *t)
552 gchar *randname = NULL;
558 sl = path_from_utf8(s);
559 tl = path_from_utf8(t);
561 if (hard_linked(sl, tl))
567 /* Do not dereference absolute symlinks, but copy them "as is".
568 * For a relative symlink, we don't know how to properly change it when
569 * copied/moved to another dir to keep pointing it to same target as
570 * a relative symlink, so we turn it into absolute symlink using
571 * realpath() instead. */
573 if (lstat_utf8(sl, &st) && S_ISLNK(st.st_mode))
578 link_target = g_malloc(st.st_size + 1);
579 i = readlink(sl, link_target, st.st_size);
583 goto orig_copy; // try a "normal" copy
585 link_target[st.st_size] = '\0';
587 if (link_target[0] != G_DIR_SEPARATOR) // if it is a relative symlink
591 gchar *lastslash = strrchr(sl, G_DIR_SEPARATOR);
592 gint len = lastslash - sl + 1;
594 absolute = g_malloc(len + st.st_size + 1);
595 strncpy(absolute, sl, len);
596 strcpy(absolute + len, link_target);
598 link_target = absolute;
601 realPath = realpath(link_target, NULL);
603 if (realPath != NULL) // successfully resolved into an absolute path
606 link_target = g_strdup(realPath);
609 else // could not get absolute path, got some error instead
612 goto orig_copy; // so try a "normal" copy
616 if (stat_utf8(tl, &st)) unlink(tl); // first try to remove directory entry in destination directory if such entry exists
618 gint success = (symlink(link_target, tl) == 0);
626 } // if symlink did not succeed, continue on to try a copy procedure
629 fi = fopen(sl, "rb");
632 /* First we write to a temporary file, then we rename it on success,
633 and attributes from original file are copied */
634 randname = g_strconcat(tl, ".tmp_XXXXXX", NULL);
635 if (!randname) goto end;
637 fd = g_mkstemp(randname);
638 if (fd == -1) goto end;
640 fo = fdopen(fd, "wb");
646 while ((b = fread(buf, sizeof(gchar), sizeof(buf), fi)) && b != 0)
648 if (fwrite(buf, sizeof(gchar), b, fo) != b)
655 fclose(fi); fi = NULL;
656 fclose(fo); fo = NULL;
658 if (rename(randname, tl) < 0) {
663 ret = copy_file_attributes(s, t, TRUE, TRUE);
670 if (randname) g_free(randname);
674 gboolean move_file(const gchar *s, const gchar *t)
679 if (!s || !t) return FALSE;
681 sl = path_from_utf8(s);
682 tl = path_from_utf8(t);
683 if (rename(sl, tl) < 0)
685 /* this may have failed because moving a file across filesystems
686 was attempted, so try copy and delete instead */
691 /* err, now we can't delete the source file so return FALSE */
706 gboolean rename_file(const gchar *s, const gchar *t)
711 if (!s || !t) return FALSE;
713 sl = path_from_utf8(s);
714 tl = path_from_utf8(t);
715 ret = (rename(sl, tl) == 0);
722 gchar *get_current_dir(void)
727 pathl = g_get_current_dir();
728 path8 = path_to_utf8(pathl);
734 void list_free_wrapper(void *data, void *UNUSED(userdata))
739 void string_list_free(GList *list)
741 g_list_foreach(list, (GFunc)list_free_wrapper, NULL);
745 GList *string_list_copy(const GList *list)
747 GList *new_list = NULL;
748 GList *work = (GList *) list;
757 new_list = g_list_prepend(new_list, g_strdup(path));
760 return g_list_reverse(new_list);
763 gchar *unique_filename(const gchar *path, const gchar *ext, const gchar *divider, gboolean pad)
769 if (!divider) divider = "";
771 unique = g_strconcat(path, ext, NULL);
772 while (isname(unique))
777 unique = g_strdup_printf("%s%s%03d%s", path, divider, n, ext);
781 unique = g_strdup_printf("%s%s%d%s", path, divider, n, ext);
795 gchar *unique_filename_simple(const gchar *path)
801 if (!path) return NULL;
803 name = filename_from_path(path);
804 if (!name) return NULL;
806 ext = registered_extension_from_path(name);
810 unique = unique_filename(path, NULL, "_", TRUE);
816 base = remove_extension_from_path(path);
817 unique = unique_filename(base, ext, "_", TRUE);
824 const gchar *filename_from_path(const gchar *path)
828 if (!path) return NULL;
830 base = strrchr(path, G_DIR_SEPARATOR);
831 if (base) return base + 1;
836 gchar *remove_level_from_path(const gchar *path)
840 if (!path) return g_strdup("");
842 base = strrchr(path, G_DIR_SEPARATOR);
843 /* Take account of a file being in the root ( / ) folder - ensure the returned value
844 * is at least one character long */
845 if (base) return g_strndup(path, (strlen(path)-strlen(base)) == 0 ? 1 : (strlen(path)-strlen(base)));
850 gboolean file_extension_match(const gchar *path, const gchar *ext)
855 if (!path) return FALSE;
856 if (!ext) return TRUE;
862 return (p > e && g_ascii_strncasecmp(path + p - e, ext, e) == 0);
865 gchar *remove_extension_from_path(const gchar *path)
867 const gchar *reg_ext;
869 if (!path) return NULL;
871 reg_ext = registered_extension_from_path(path);
873 return g_strndup(path, strlen(path) - (reg_ext == NULL ? 0 : strlen(reg_ext)));
876 void parse_out_relatives(gchar *path)
884 while (path[s] != '\0')
886 if (path[s] == G_DIR_SEPARATOR && path[s+1] == '.')
888 /* /. occurrence, let's see more */
891 if (path[p] == G_DIR_SEPARATOR || path[p] == '\0')
893 /* /./ or /., just skip this part */
897 else if (path[p] == '.' && (path[p+1] == G_DIR_SEPARATOR || path[p+1] == '\0'))
899 /* /../ or /.., remove previous part, ie. /a/b/../ becomes /a/ */
902 while (path[t] != G_DIR_SEPARATOR && t > 0) t--;
907 if (s != t) path[t] = path[s];
912 if (t == 0 && path[t] == G_DIR_SEPARATOR) t++;
913 if (t > 1 && path[t-1] == G_DIR_SEPARATOR) t--;
917 gboolean file_in_path(const gchar *name)
922 gboolean ret = FALSE;
924 if (!name) return FALSE;
925 path = g_strdup(getenv("PATH"));
926 if (!path) return FALSE;
927 namel = path_from_utf8(name);
931 while (p < l && !ret)
935 while (path[e] != ':' && path[e] != '\0') e++;
938 f = g_build_filename(path + p, namel, NULL);
939 if (isfile(f)) ret = TRUE;
949 gboolean recursive_mkdir_if_not_exists(const gchar *path, mode_t mode)
951 if (!path) return FALSE;
955 gchar *npath = g_strdup(path);
961 if (p[0] == G_DIR_SEPARATOR || p[0] == '\0')
973 DEBUG_1("creating sub dir:%s", npath);
974 if (!mkdir_utf8(npath, mode))
976 log_printf("create dir failed: %s\n", npath);
982 if (!end) p[0] = G_DIR_SEPARATOR;
991 /* does filename utf8 to filesystem encoding first */
992 gboolean md5_get_digest_from_file_utf8(const gchar *path, guchar digest[16])
997 pathl = path_from_utf8(path);
998 success = md5_get_digest_from_file(pathl, digest);
1005 gchar *md5_text_from_file_utf8(const gchar *path, const gchar *error_text)
1009 if (!md5_get_digest_from_file_utf8(path, digest)) return g_strdup(error_text);
1011 return md5_digest_to_text(digest);
1014 /* Download web file
1016 typedef struct _WebData WebData;
1020 GCancellable *cancellable;
1023 GtkWidget *progress;
1028 static void web_file_async_ready_cb(GObject *source_object, GAsyncResult *res, gpointer data)
1030 GError *error = NULL;
1031 WebData* web = data;
1032 gchar *tmp_filename;
1034 if (!g_cancellable_is_cancelled(web->cancellable))
1036 generic_dialog_close(web->gd);
1039 if (g_file_copy_finish(G_FILE(source_object), res, &error))
1041 tmp_filename = g_file_get_parse_name(web->tmp_g_file);
1042 g_free(tmp_filename);
1043 layout_set_path(web->lw, g_file_get_path(web->tmp_g_file));
1047 file_util_warning_dialog(_("Web file download failed"), error->message, GTK_STOCK_DIALOG_ERROR, NULL);
1050 g_object_unref(web->tmp_g_file);
1051 web->tmp_g_file = NULL;
1052 g_object_unref(web->cancellable);
1053 g_object_unref(web->web_file);
1056 static void web_file_progress_cb(goffset current_num_bytes, goffset total_num_bytes, gpointer data)
1058 WebData* web = data;
1060 if (!g_cancellable_is_cancelled(web->cancellable))
1062 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(web->progress), (gdouble)current_num_bytes / total_num_bytes);
1066 static void download_web_file_cancel_button_cb(GenericDialog *UNUSED(gd), gpointer data)
1068 WebData* web = data;
1070 g_cancellable_cancel(web->cancellable);
1073 gboolean download_web_file(const gchar *text, gboolean minimized, gpointer data)
1076 LayoutWindow *lw = data;
1078 GError *error = NULL;
1081 gboolean ret = FALSE;
1083 FileFormatClass format_class;
1085 scheme = g_uri_parse_scheme(text);
1086 if (g_strcmp0("http", scheme) == 0 || g_strcmp0("https", scheme) == 0)
1088 format_class = filter_file_get_class(text);
1090 if (format_class == FORMAT_CLASS_IMAGE || format_class == FORMAT_CLASS_RAWIMAGE || format_class == FORMAT_CLASS_VIDEO || format_class == FORMAT_CLASS_DOCUMENT)
1092 tmp_dir = g_dir_make_tmp("geeqie_XXXXXX", &error);
1095 log_printf("Error: could not create temporary file n%s\n", error->message);
1096 g_error_free(error);
1102 web = g_new0(WebData, 1);
1105 web->web_file = g_file_new_for_uri(text);
1107 base = g_strdup(g_file_get_basename(web->web_file));
1108 web->tmp_g_file = g_file_new_for_path(g_build_filename(tmp_dir, base, NULL));
1110 web->gd = generic_dialog_new(_("Download web file"), "download_web_file", NULL, TRUE, download_web_file_cancel_button_cb, web);
1112 message = g_strconcat(_("Downloading "), base, NULL);
1113 generic_dialog_add_message(web->gd, GTK_STOCK_DIALOG_INFO, message, NULL, FALSE);
1115 web->progress = gtk_progress_bar_new();
1116 gtk_box_pack_start(GTK_BOX(web->gd->vbox), web->progress, FALSE, FALSE, 0);
1117 gtk_widget_show(web->progress);
1120 gtk_window_iconify(GTK_WINDOW(web->gd->dialog));
1123 gtk_widget_show(web->gd->dialog);
1124 web->cancellable = g_cancellable_new();
1125 g_file_copy_async(web->web_file, web->tmp_g_file, G_FILE_COPY_OVERWRITE, G_PRIORITY_LOW, web->cancellable, web_file_progress_cb, web, web_file_async_ready_cb, web);
1143 gboolean rmdir_recursive(GFile *file, GCancellable *cancellable, GError **error)
1145 g_autoptr(GFileEnumerator) enumerator = NULL;
1147 enumerator = g_file_enumerate_children(file, G_FILE_ATTRIBUTE_STANDARD_NAME, G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, cancellable, NULL);
1149 while (enumerator != NULL)
1153 if (!g_file_enumerator_iterate(enumerator, NULL, &child, cancellable, error))
1157 if (!rmdir_recursive(child, cancellable, error))
1161 return g_file_delete(file, cancellable, error);
1165 * @brief Retrieves the internal scale factor that maps from window coordinates to the actual device pixels
1167 * @returns scale factor
1173 LayoutWindow *lw = NULL;
1176 return gtk_widget_get_scale_factor(lw->window);
1178 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */