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 "ui-fileops.h"
32 #include "filefilter.h"
35 #include "secure-save.h"
38 *-----------------------------------------------------------------------------
39 * generic file information and manipulation routines (public)
40 *-----------------------------------------------------------------------------
45 void print_term(gboolean err, const gchar *text_utf8)
49 text_l = g_locale_from_utf8(text_utf8, -1, nullptr, nullptr, nullptr);
52 fputs((text_l) ? text_l : text_utf8, stderr);
56 fputs((text_l) ? text_l : text_utf8, stdout);
58 if(command_line && command_line->ssi)
59 secure_fputs(command_line->ssi, (text_l) ? text_l : text_utf8);
63 static void encoding_dialog(const gchar *path)
65 static gboolean warned_user = FALSE;
71 if (warned_user) return;
75 bf = getenv("G_BROKEN_FILENAMES");
77 string = g_string_new("");
78 g_string_append(string, _("One or more filenames are not encoded with the preferred locale character set.\n"));
79 g_string_append_printf(string, _("Operations on, and display of these files with %s may not succeed.\n"), PACKAGE);
80 g_string_append(string, "\n");
81 g_string_append(string, _("If your filenames are not encoded in utf-8, try setting the environment variable G_BROKEN_FILENAMES=1\n"));
83 g_string_append_printf(string, _("It appears G_BROKEN_FILENAMES is set to %s\n"), bf);
85 g_string_append(string, _("It appears G_BROKEN_FILENAMES is not set\n"));
86 g_string_append(string, "\n");
87 g_string_append_printf(string, _("The locale appears to be set to \"%s\"\n(set by the LANG environment variable)\n"), (lc) ? lc : "undefined");
88 if (lc && (strstr(lc, "UTF-8") || strstr(lc, "utf-8")))
91 name = g_convert(path, -1, "UTF-8", "ISO-8859-1", nullptr, nullptr, nullptr);
92 string = g_string_append(string, _("\nPreferred encoding appears to be UTF-8, however the file:\n"));
93 g_string_append_printf(string, "\"%s\"\n", (name) ? name : _("[name not displayable]"));
95 if (g_utf8_validate(path, -1, nullptr))
96 g_string_append_printf(string, _("\"%s\" is encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
98 g_string_append_printf(string, _("\"%s\" is not encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
99 g_string_append(string, "\n");
103 gd = generic_dialog_new(_("Filename encoding locale mismatch"),
104 "locale warning", nullptr, TRUE, nullptr, nullptr);
105 generic_dialog_add_button(gd, GTK_STOCK_CLOSE, nullptr, nullptr, TRUE);
107 generic_dialog_add_message(gd, GTK_STOCK_DIALOG_WARNING,
108 _("Filename encoding locale mismatch"), string->str, TRUE);
110 gtk_widget_show(gd->dialog);
112 g_string_free(string, TRUE);
115 #if GQ_DEBUG_PATH_UTF8
116 gchar *path_to_utf8_debug(const gchar *path, const gchar *file, gint line)
118 gchar *path_to_utf8(const gchar *path)
122 GError *error = nullptr;
124 if (!path) return nullptr;
126 utf8 = g_filename_to_utf8(path, -1, nullptr, nullptr, &error);
129 #if GQ_DEBUG_PATH_UTF8
130 log_printf("%s:%d: Unable to convert filename to UTF-8:\n%s\n%s\n", file, line, path, error->message);
132 log_printf("Unable to convert filename to UTF-8:\n%s\n%s\n", path, error->message);
135 encoding_dialog(path);
139 /* just let it through, but bad things may happen */
140 utf8 = g_strdup(path);
146 #if GQ_DEBUG_PATH_UTF8
147 gchar *path_from_utf8_debug(const gchar *utf8, const gchar *file, gint line)
149 gchar *path_from_utf8(const gchar *utf8)
153 GError *error = nullptr;
155 if (!utf8) return nullptr;
157 path = g_filename_from_utf8(utf8, -1, nullptr, nullptr, &error);
160 #if GQ_DEBUG_PATH_UTF8
161 log_printf("%s:%d: Unable to convert filename to locale from UTF-8:\n%s\n%s\n", file, line, utf8, error->message);
163 log_printf("Unable to convert filename to locale from UTF-8:\n%s\n%s\n", utf8, error->message);
169 /* if invalid UTF-8, text probably still in original form, so just copy it */
170 path = g_strdup(utf8);
176 /* first we try the HOME environment var, if that doesn't work, we try g_get_homedir(). */
177 const gchar *homedir()
179 static gchar *home = nullptr;
182 home = path_to_utf8(getenv("HOME"));
185 home = path_to_utf8(g_get_home_dir());
187 DEBUG_1("Home directory: %s", home);
192 static gchar *xdg_dir_get(const gchar *key, const gchar *fallback)
194 gchar *dir = getenv(key);
196 if (!dir || dir[0] == '\0')
198 return g_build_filename(homedir(), fallback, NULL);
201 DEBUG_1("Got xdg %s: %s", key, dir);
203 return path_to_utf8(dir);
206 const gchar *xdg_data_home_get()
208 static const gchar *xdg_data_home = nullptr;
210 if (xdg_data_home) return xdg_data_home;
212 xdg_data_home = xdg_dir_get("XDG_DATA_HOME", ".local/share");
214 return xdg_data_home;
217 const gchar *xdg_config_home_get()
219 static const gchar *xdg_config_home = nullptr;
221 if (xdg_config_home) return xdg_config_home;
223 xdg_config_home = xdg_dir_get("XDG_CONFIG_HOME", ".config");
225 return xdg_config_home;
228 const gchar *xdg_cache_home_get()
230 static const gchar *xdg_cache_home = nullptr;
232 if (xdg_cache_home) return xdg_cache_home;
234 xdg_cache_home = xdg_dir_get("XDG_CACHE_HOME", ".cache");
236 return xdg_cache_home;
239 const gchar *get_rc_dir()
241 static gchar *rc_dir = nullptr;
243 if (rc_dir) return rc_dir;
247 rc_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, NULL);
251 rc_dir = g_build_filename(homedir(), GQ_RC_DIR, NULL);
257 const gchar *get_collections_dir()
259 static gchar *collections_dir = nullptr;
261 if (collections_dir) return collections_dir;
265 collections_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_COLLECTIONS_DIR, NULL);
269 collections_dir = g_build_filename(get_rc_dir(), GQ_COLLECTIONS_DIR, NULL);
272 return collections_dir;
275 const gchar *get_trash_dir()
277 static gchar *trash_dir = nullptr;
279 if (trash_dir) return trash_dir;
283 trash_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_TRASH_DIR, NULL);
287 trash_dir = g_build_filename(get_rc_dir(), GQ_TRASH_DIR, NULL);
293 const gchar *get_window_layouts_dir()
295 static gchar *window_layouts_dir = nullptr;
297 if (window_layouts_dir) return window_layouts_dir;
301 window_layouts_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, GQ_WINDOW_LAYOUTS_DIR, NULL);
305 window_layouts_dir = g_build_filename(get_rc_dir(), GQ_WINDOW_LAYOUTS_DIR, NULL);
308 return window_layouts_dir;
311 gboolean stat_utf8(const gchar *s, struct stat *st)
316 if (!s) return FALSE;
317 sl = path_from_utf8(s);
318 ret = (stat(sl, st) == 0);
324 gboolean lstat_utf8(const gchar *s, struct stat *st)
329 if (!s) return FALSE;
330 sl = path_from_utf8(s);
331 ret = (lstat(sl, st) == 0);
337 gboolean isname(const gchar *s)
341 return stat_utf8(s, &st);
344 gboolean isfile(const gchar *s)
348 return (stat_utf8(s, &st) && S_ISREG(st.st_mode));
351 gboolean isdir(const gchar *s)
355 return (stat_utf8(s, &st) && S_ISDIR(st.st_mode));
358 gboolean islink(const gchar *s)
362 return (lstat_utf8(s, &st) && S_ISLNK(st.st_mode));
365 gint64 filesize(const gchar *s)
369 if (!stat_utf8(s, &st)) return 0;
373 time_t filetime(const gchar *s)
377 if (!stat_utf8(s, &st)) return 0;
381 gboolean filetime_set(const gchar *s, time_t tval)
383 gboolean ret = FALSE;
390 ut.actime = ut.modtime = tval;
392 sl = path_from_utf8(s);
393 ret = (utime(sl, &ut) == 0);
400 gboolean is_readable_file(const gchar *s)
402 if (!s || !s[0] || !isfile(s)) return FALSE;
403 return access_file(s, R_OK);
406 gboolean access_file(const gchar *s, gint mode)
411 if (!s || !s[0]) return FALSE;
413 sl = path_from_utf8(s);
414 ret = (access(sl, mode) == 0);
420 gboolean unlink_file(const gchar *s)
425 if (!s) return FALSE;
427 sl = path_from_utf8(s);
428 ret = (unlink(sl) == 0);
434 #pragma GCC diagnostic push
435 #pragma GCC diagnostic ignored "-Wunused-function"
436 gboolean symlink_utf8_unused(const gchar *source, const gchar *target)
442 if (!source || !target) return FALSE;
444 sl = path_from_utf8(source);
445 tl = path_from_utf8(target);
447 ret = (symlink(sl, tl) == 0);
454 #pragma GCC diagnostic pop
456 gboolean mkdir_utf8(const gchar *s, gint mode)
461 if (!s) return FALSE;
463 sl = path_from_utf8(s);
464 ret = (mkdir(sl, mode) == 0);
469 gboolean rmdir_utf8(const gchar *s)
474 if (!s) return FALSE;
476 sl = path_from_utf8(s);
477 ret = (rmdir(sl) == 0);
483 gboolean copy_file_attributes(const gchar *s, const gchar *t, gint perms, gint mtime)
487 gboolean ret = FALSE;
489 if (!s || !t) return FALSE;
491 sl = path_from_utf8(s);
492 tl = path_from_utf8(t);
494 if (stat(sl, &st) == 0)
500 /* set the dest file attributes to that of source (ignoring errors) */
504 ret = chown(tl, st.st_uid, st.st_gid);
505 /* Ignores chown errors, while still doing chown
506 (so root still can copy files preserving ownership) */
508 if (chmod(tl, st.st_mode) < 0) {
510 if (stat(tl, &st2) != 0 || st2.st_mode != st.st_mode) {
516 tb.actime = st.st_atime;
517 tb.modtime = st.st_mtime;
518 if (mtime && utime(tl, &tb) < 0) ret = FALSE;
527 /* paths are in filesystem encoding */
528 static gboolean hard_linked(const gchar *a, const gchar *b)
533 if (stat(a, &sta) != 0 || stat(b, &stb) != 0) return FALSE;
535 return (sta.st_dev == stb.st_dev &&
536 sta.st_ino == stb.st_ino);
539 gboolean copy_file(const gchar *s, const gchar *t)
545 gchar *randname = nullptr;
551 sl = path_from_utf8(s);
552 tl = path_from_utf8(t);
554 if (hard_linked(sl, tl))
560 /* Do not dereference absolute symlinks, but copy them "as is".
561 * For a relative symlink, we don't know how to properly change it when
562 * copied/moved to another dir to keep pointing it to same target as
563 * a relative symlink, so we turn it into absolute symlink using
564 * realpath() instead. */
566 if (lstat_utf8(sl, &st) && S_ISLNK(st.st_mode))
571 link_target = static_cast<gchar *>(g_malloc(st.st_size + 1));
572 i = readlink(sl, link_target, st.st_size);
576 goto orig_copy; // try a "normal" copy
578 link_target[st.st_size] = '\0';
580 if (link_target[0] != G_DIR_SEPARATOR) // if it is a relative symlink
584 gchar *lastslash = strrchr(sl, G_DIR_SEPARATOR);
585 gint len = lastslash - sl + 1;
587 absolute = static_cast<gchar *>(g_malloc(len + st.st_size + 1));
588 strncpy(absolute, sl, len);
589 strcpy(absolute + len, link_target);
591 link_target = absolute;
594 realPath = realpath(link_target, nullptr);
596 if (realPath != nullptr) // successfully resolved into an absolute path
599 link_target = g_strdup(realPath);
602 else // could not get absolute path, got some error instead
605 goto orig_copy; // so try a "normal" copy
609 if (stat_utf8(tl, &st)) unlink(tl); // first try to remove directory entry in destination directory if such entry exists
611 gint success = (symlink(link_target, tl) == 0);
619 } // if symlink did not succeed, continue on to try a copy procedure
622 fi = fopen(sl, "rb");
625 /* First we write to a temporary file, then we rename it on success,
626 and attributes from original file are copied */
627 randname = g_strconcat(tl, ".tmp_XXXXXX", NULL);
628 if (!randname) goto end;
630 fd = g_mkstemp(randname);
631 if (fd == -1) goto end;
633 fo = fdopen(fd, "wb");
639 while ((b = fread(buf, sizeof(gchar), sizeof(buf), fi)) && b != 0)
641 if (fwrite(buf, sizeof(gchar), b, fo) != b)
648 fclose(fi); fi = nullptr;
649 fclose(fo); fo = nullptr;
651 if (rename(randname, tl) < 0) {
656 ret = copy_file_attributes(s, t, TRUE, TRUE);
663 if (randname) g_free(randname);
667 gboolean move_file(const gchar *s, const gchar *t)
672 if (!s || !t) return FALSE;
674 sl = path_from_utf8(s);
675 tl = path_from_utf8(t);
676 if (rename(sl, tl) < 0)
678 /* this may have failed because moving a file across filesystems
679 was attempted, so try copy and delete instead */
684 /* err, now we can't delete the source file so return FALSE */
699 gboolean rename_file(const gchar *s, const gchar *t)
704 if (!s || !t) return FALSE;
706 sl = path_from_utf8(s);
707 tl = path_from_utf8(t);
708 ret = (rename(sl, tl) == 0);
715 gchar *get_current_dir()
720 pathl = g_get_current_dir();
721 path8 = path_to_utf8(pathl);
727 void string_list_free(GList *list)
729 g_list_free_full(list, g_free);
732 GList *string_list_copy(const GList *list)
734 GList *new_list = nullptr;
735 auto work = const_cast<GList *>(list);
741 path = static_cast<gchar *>(work->data);
744 new_list = g_list_prepend(new_list, g_strdup(path));
747 return g_list_reverse(new_list);
750 gchar *unique_filename(const gchar *path, const gchar *ext, const gchar *divider, gboolean pad)
756 if (!divider) divider = "";
758 unique = g_strconcat(path, ext, NULL);
759 while (isname(unique))
764 unique = g_strdup_printf("%s%s%03d%s", path, divider, n, ext);
768 unique = g_strdup_printf("%s%s%d%s", path, divider, n, ext);
782 #pragma GCC diagnostic push
783 #pragma GCC diagnostic ignored "-Wunused-function"
784 gchar *unique_filename_simple_unused(const gchar *path)
790 if (!path) return NULL;
792 name = filename_from_path(path);
793 if (!name) return NULL;
795 ext = registered_extension_from_path(name);
799 unique = unique_filename(path, NULL, "_", TRUE);
805 base = remove_extension_from_path(path);
806 unique = unique_filename(base, ext, "_", TRUE);
812 #pragma GCC diagnostic pop
814 const gchar *filename_from_path(const gchar *path)
818 if (!path) return nullptr;
820 base = strrchr(path, G_DIR_SEPARATOR);
821 if (base) return base + 1;
826 gchar *remove_level_from_path(const gchar *path)
830 if (!path) return g_strdup("");
832 base = strrchr(path, G_DIR_SEPARATOR);
833 /* Take account of a file being in the root ( / ) folder - ensure the returned value
834 * is at least one character long */
835 if (base) return g_strndup(path, (strlen(path)-strlen(base)) == 0 ? 1 : (strlen(path)-strlen(base)));
840 gboolean file_extension_match(const gchar *path, const gchar *ext)
845 if (!path) return FALSE;
846 if (!ext) return TRUE;
852 return (p > e && g_ascii_strncasecmp(path + p - e, ext, e) == 0);
855 gchar *remove_extension_from_path(const gchar *path)
857 const gchar *reg_ext;
859 if (!path) return nullptr;
861 reg_ext = registered_extension_from_path(path);
863 return g_strndup(path, strlen(path) - (reg_ext == nullptr ? 0 : strlen(reg_ext)));
866 void parse_out_relatives(gchar *path)
874 while (path[s] != '\0')
876 if (path[s] == G_DIR_SEPARATOR && path[s+1] == '.')
878 /* /. occurrence, let's see more */
881 if (path[p] == G_DIR_SEPARATOR || path[p] == '\0')
883 /* /./ or /., just skip this part */
887 else if (path[p] == '.' && (path[p+1] == G_DIR_SEPARATOR || path[p+1] == '\0'))
889 /* /../ or /.., remove previous part, ie. /a/b/../ becomes /a/ */
892 while (path[t] != G_DIR_SEPARATOR && t > 0) t--;
897 if (s != t) path[t] = path[s];
902 if (t == 0 && path[t] == G_DIR_SEPARATOR) t++;
903 if (t > 1 && path[t-1] == G_DIR_SEPARATOR) t--;
907 gboolean file_in_path(const gchar *name)
912 gboolean ret = FALSE;
914 if (!name) return FALSE;
915 path = g_strdup(getenv("PATH"));
916 if (!path) return FALSE;
917 namel = path_from_utf8(name);
921 while (p < l && !ret)
925 while (path[e] != ':' && path[e] != '\0') e++;
928 f = g_build_filename(path + p, namel, NULL);
929 if (isfile(f)) ret = TRUE;
939 gboolean recursive_mkdir_if_not_exists(const gchar *path, mode_t mode)
941 if (!path) return FALSE;
945 gchar *npath = g_strdup(path);
951 if (p[0] == G_DIR_SEPARATOR || p[0] == '\0')
963 DEBUG_1("creating sub dir:%s", npath);
964 if (!mkdir_utf8(npath, mode))
966 log_printf("create dir failed: %s\n", npath);
972 if (!end) p[0] = G_DIR_SEPARATOR;
981 /* does filename utf8 to filesystem encoding first */
982 gboolean md5_get_digest_from_file_utf8(const gchar *path, guchar digest[16])
987 pathl = path_from_utf8(path);
988 success = md5_get_digest_from_file(pathl, digest);
995 gchar *md5_text_from_file_utf8(const gchar *path, const gchar *error_text)
999 if (!md5_get_digest_from_file_utf8(path, digest)) return g_strdup(error_text);
1001 return md5_digest_to_text(digest);
1004 /* Download web file
1009 GCancellable *cancellable;
1012 GtkWidget *progress;
1017 static void web_file_async_ready_cb(GObject *source_object, GAsyncResult *res, gpointer data)
1019 GError *error = nullptr;
1020 auto web = static_cast<WebData *>(data);
1021 gchar *tmp_filename;
1023 if (!g_cancellable_is_cancelled(web->cancellable))
1025 generic_dialog_close(web->gd);
1028 if (g_file_copy_finish(G_FILE(source_object), res, &error))
1030 tmp_filename = g_file_get_parse_name(web->tmp_g_file);
1031 g_free(tmp_filename);
1032 layout_set_path(web->lw, g_file_get_path(web->tmp_g_file));
1036 file_util_warning_dialog(_("Web file download failed"), error->message, GTK_STOCK_DIALOG_ERROR, nullptr);
1039 g_object_unref(web->tmp_g_file);
1040 web->tmp_g_file = nullptr;
1041 g_object_unref(web->cancellable);
1042 g_object_unref(web->web_file);
1045 static void web_file_progress_cb(goffset current_num_bytes, goffset total_num_bytes, gpointer data)
1047 auto web = static_cast<WebData *>(data);
1049 if (!g_cancellable_is_cancelled(web->cancellable))
1051 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(web->progress), static_cast<gdouble>(current_num_bytes) / total_num_bytes);
1055 static void download_web_file_cancel_button_cb(GenericDialog *, gpointer data)
1057 auto web = static_cast<WebData *>(data);
1059 g_cancellable_cancel(web->cancellable);
1062 gboolean download_web_file(const gchar *text, gboolean minimized, gpointer data)
1065 auto lw = static_cast<LayoutWindow *>(data);
1067 GError *error = nullptr;
1070 gboolean ret = FALSE;
1072 FileFormatClass format_class;
1074 scheme = g_uri_parse_scheme(text);
1075 if (g_strcmp0("http", scheme) == 0 || g_strcmp0("https", scheme) == 0)
1077 format_class = filter_file_get_class(text);
1079 if (format_class == FORMAT_CLASS_IMAGE || format_class == FORMAT_CLASS_RAWIMAGE || format_class == FORMAT_CLASS_VIDEO || format_class == FORMAT_CLASS_DOCUMENT)
1081 tmp_dir = g_dir_make_tmp("geeqie_XXXXXX", &error);
1084 log_printf("Error: could not create temporary file n%s\n", error->message);
1085 g_error_free(error);
1091 web = g_new0(WebData, 1);
1094 web->web_file = g_file_new_for_uri(text);
1096 base = g_strdup(g_file_get_basename(web->web_file));
1097 web->tmp_g_file = g_file_new_for_path(g_build_filename(tmp_dir, base, NULL));
1099 web->gd = generic_dialog_new(_("Download web file"), "download_web_file", nullptr, TRUE, download_web_file_cancel_button_cb, web);
1101 message = g_strconcat(_("Downloading "), base, NULL);
1102 generic_dialog_add_message(web->gd, GTK_STOCK_DIALOG_INFO, message, nullptr, FALSE);
1104 web->progress = gtk_progress_bar_new();
1105 gtk_box_pack_start(GTK_BOX(web->gd->vbox), web->progress, FALSE, FALSE, 0);
1106 gtk_widget_show(web->progress);
1109 gtk_window_iconify(GTK_WINDOW(web->gd->dialog));
1112 gtk_widget_show(web->gd->dialog);
1113 web->cancellable = g_cancellable_new();
1114 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);
1132 gboolean rmdir_recursive(GFile *file, GCancellable *cancellable, GError **error)
1134 g_autoptr(GFileEnumerator) enumerator = nullptr;
1136 enumerator = g_file_enumerate_children(file, G_FILE_ATTRIBUTE_STANDARD_NAME, G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, cancellable, nullptr);
1138 while (enumerator != nullptr)
1142 if (!g_file_enumerator_iterate(enumerator, nullptr, &child, cancellable, error))
1144 if (child == nullptr)
1146 if (!rmdir_recursive(child, cancellable, error))
1150 return g_file_delete(file, cancellable, error);
1154 * @brief Retrieves the internal scale factor that maps from window coordinates to the actual device pixels
1156 * @returns scale factor
1162 LayoutWindow *lw = nullptr;
1165 return gtk_widget_get_scale_factor(lw->window);
1167 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */