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.
31 #include "ui-fileops.h"
34 #include "filefilter.h"
37 #include "secure-save.h"
40 *-----------------------------------------------------------------------------
41 * generic file information and manipulation routines (public)
42 *-----------------------------------------------------------------------------
47 void print_term(gboolean err, const gchar *text_utf8)
51 text_l = g_locale_from_utf8(text_utf8, -1, nullptr, nullptr, nullptr);
54 fputs((text_l) ? text_l : text_utf8, stderr);
58 fputs((text_l) ? text_l : text_utf8, stdout);
60 if(command_line && command_line->ssi)
61 secure_fputs(command_line->ssi, (text_l) ? text_l : text_utf8);
65 static void encoding_dialog(const gchar *path)
67 static gboolean warned_user = FALSE;
73 if (warned_user) return;
77 bf = getenv("G_BROKEN_FILENAMES");
79 string = g_string_new(_("One or more filenames are not encoded with the preferred locale character set.\n"));
80 g_string_append_printf(string, _("Operations on, and display of these files with %s may not succeed.\n"), PACKAGE);
81 g_string_append(string, "\n");
82 g_string_append(string, _("If your filenames are not encoded in utf-8, try setting the environment variable G_BROKEN_FILENAMES=1\n"));
84 g_string_append_printf(string, _("It appears G_BROKEN_FILENAMES is set to %s\n"), bf);
86 g_string_append(string, _("It appears G_BROKEN_FILENAMES is not set\n"));
87 g_string_append(string, "\n");
88 g_string_append_printf(string, _("The locale appears to be set to \"%s\"\n(set by the LANG environment variable)\n"), (lc) ? lc : "undefined");
89 if (lc && (strstr(lc, "UTF-8") || strstr(lc, "utf-8")))
92 name = g_convert(path, -1, "UTF-8", "ISO-8859-1", nullptr, nullptr, nullptr);
93 string = g_string_append(string, _("\nPreferred encoding appears to be UTF-8, however the file:\n"));
94 g_string_append_printf(string, "\"%s\"\n", (name) ? name : _("[name not displayable]"));
96 if (g_utf8_validate(path, -1, nullptr))
97 g_string_append_printf(string, _("\"%s\" is encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
99 g_string_append_printf(string, _("\"%s\" is not encoded in valid UTF-8."), (name) ? name : _("[name not displayable]"));
100 g_string_append(string, "\n");
104 gd = generic_dialog_new(_("Filename encoding locale mismatch"),
105 "locale warning", nullptr, TRUE, nullptr, nullptr);
106 generic_dialog_add_button(gd, GQ_ICON_CLOSE, _("Close"), nullptr, TRUE);
108 generic_dialog_add_message(gd, GQ_ICON_DIALOG_WARNING,
109 _("Filename encoding locale mismatch"), string->str, TRUE);
111 gtk_widget_show(gd->dialog);
113 g_string_free(string, TRUE);
116 #if GQ_DEBUG_PATH_UTF8
117 gchar *path_to_utf8_debug(const gchar *path, const gchar *file, gint line)
119 gchar *path_to_utf8(const gchar *path)
123 GError *error = nullptr;
125 if (!path) return nullptr;
127 utf8 = g_filename_to_utf8(path, -1, nullptr, nullptr, &error);
130 #if GQ_DEBUG_PATH_UTF8
131 log_printf("%s:%d: Unable to convert filename to UTF-8:\n%s\n%s\n", file, line, path, error->message);
133 log_printf("Unable to convert filename to UTF-8:\n%s\n%s\n", path, error->message);
136 encoding_dialog(path);
140 /* just let it through, but bad things may happen */
141 utf8 = g_strdup(path);
147 #if GQ_DEBUG_PATH_UTF8
148 gchar *path_from_utf8_debug(const gchar *utf8, const gchar *file, gint line)
150 gchar *path_from_utf8(const gchar *utf8)
154 GError *error = nullptr;
156 if (!utf8) return nullptr;
158 path = g_filename_from_utf8(utf8, -1, nullptr, nullptr, &error);
161 #if GQ_DEBUG_PATH_UTF8
162 log_printf("%s:%d: Unable to convert filename to locale from UTF-8:\n%s\n%s\n", file, line, utf8, error->message);
164 log_printf("Unable to convert filename to locale from UTF-8:\n%s\n%s\n", utf8, error->message);
170 /* if invalid UTF-8, text probably still in original form, so just copy it */
171 path = g_strdup(utf8);
177 /* first we try the HOME environment var, if that doesn't work, we try g_get_homedir(). */
178 const gchar *homedir()
180 static gchar *home = nullptr;
183 home = path_to_utf8(getenv("HOME"));
186 home = path_to_utf8(g_get_home_dir());
188 DEBUG_1("Home directory: %s", home);
193 static gchar *xdg_dir_get(const gchar *key, const gchar *fallback)
195 gchar *dir = getenv(key);
197 if (!dir || dir[0] == '\0')
199 return g_build_filename(homedir(), fallback, NULL);
202 DEBUG_1("Got xdg %s: %s", key, dir);
204 return path_to_utf8(dir);
207 const gchar *xdg_data_home_get()
209 static const gchar *xdg_data_home = nullptr;
211 if (xdg_data_home) return xdg_data_home;
213 xdg_data_home = xdg_dir_get("XDG_DATA_HOME", ".local/share");
215 return xdg_data_home;
218 const gchar *xdg_config_home_get()
220 static const gchar *xdg_config_home = nullptr;
222 if (xdg_config_home) return xdg_config_home;
224 xdg_config_home = xdg_dir_get("XDG_CONFIG_HOME", ".config");
226 return xdg_config_home;
229 const gchar *xdg_cache_home_get()
231 static const gchar *xdg_cache_home = nullptr;
233 if (xdg_cache_home) return xdg_cache_home;
235 xdg_cache_home = xdg_dir_get("XDG_CACHE_HOME", ".cache");
237 return xdg_cache_home;
240 const gchar *get_rc_dir()
242 static gchar *rc_dir = nullptr;
244 if (rc_dir) return rc_dir;
248 rc_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, NULL);
252 rc_dir = g_build_filename(homedir(), GQ_RC_DIR, NULL);
258 const gchar *get_collections_dir()
260 static gchar *collections_dir = nullptr;
262 if (collections_dir) return collections_dir;
266 collections_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_COLLECTIONS_DIR, NULL);
270 collections_dir = g_build_filename(get_rc_dir(), GQ_COLLECTIONS_DIR, NULL);
273 return collections_dir;
276 const gchar *get_trash_dir()
278 static gchar *trash_dir = nullptr;
280 if (trash_dir) return trash_dir;
284 trash_dir = g_build_filename(xdg_data_home_get(), GQ_APPNAME_LC, GQ_TRASH_DIR, NULL);
288 trash_dir = g_build_filename(get_rc_dir(), GQ_TRASH_DIR, NULL);
294 const gchar *get_window_layouts_dir()
296 static gchar *window_layouts_dir = nullptr;
298 if (window_layouts_dir) return window_layouts_dir;
302 window_layouts_dir = g_build_filename(xdg_config_home_get(), GQ_APPNAME_LC, GQ_WINDOW_LAYOUTS_DIR, NULL);
306 window_layouts_dir = g_build_filename(get_rc_dir(), GQ_WINDOW_LAYOUTS_DIR, NULL);
309 return window_layouts_dir;
312 gboolean stat_utf8(const gchar *s, struct stat *st)
317 if (!s) return FALSE;
318 sl = path_from_utf8(s);
319 ret = (stat(sl, st) == 0);
325 gboolean lstat_utf8(const gchar *s, struct stat *st)
330 if (!s) return FALSE;
331 sl = path_from_utf8(s);
332 ret = (lstat(sl, st) == 0);
338 gboolean isname(const gchar *s)
342 return stat_utf8(s, &st);
345 gboolean isfile(const gchar *s)
349 return (stat_utf8(s, &st) && S_ISREG(st.st_mode));
352 gboolean isdir(const gchar *s)
356 return (stat_utf8(s, &st) && S_ISDIR(st.st_mode));
359 gboolean islink(const gchar *s)
363 return (lstat_utf8(s, &st) && S_ISLNK(st.st_mode));
366 gint64 filesize(const gchar *s)
370 if (!stat_utf8(s, &st)) return 0;
374 time_t filetime(const gchar *s)
378 if (!stat_utf8(s, &st)) return 0;
382 gboolean filetime_set(const gchar *s, time_t tval)
384 gboolean ret = FALSE;
391 ut.actime = ut.modtime = tval;
393 sl = path_from_utf8(s);
394 ret = (utime(sl, &ut) == 0);
401 gboolean is_readable_file(const gchar *s)
403 if (!s || !s[0] || !isfile(s)) return FALSE;
404 return access_file(s, R_OK);
407 gboolean access_file(const gchar *s, gint mode)
412 if (!s || !s[0]) return FALSE;
414 sl = path_from_utf8(s);
415 ret = (access(sl, mode) == 0);
421 gboolean unlink_file(const gchar *s)
426 if (!s) return FALSE;
428 sl = path_from_utf8(s);
429 ret = (unlink(sl) == 0);
435 #pragma GCC diagnostic push
436 #pragma GCC diagnostic ignored "-Wunused-function"
437 gboolean symlink_utf8_unused(const gchar *source, const gchar *target)
443 if (!source || !target) return FALSE;
445 sl = path_from_utf8(source);
446 tl = path_from_utf8(target);
448 ret = (symlink(sl, tl) == 0);
455 #pragma GCC diagnostic pop
457 gboolean mkdir_utf8(const gchar *s, gint mode)
462 if (!s) return FALSE;
464 sl = path_from_utf8(s);
465 ret = (mkdir(sl, mode) == 0);
470 gboolean rmdir_utf8(const gchar *s)
475 if (!s) return FALSE;
477 sl = path_from_utf8(s);
478 ret = (rmdir(sl) == 0);
484 gboolean copy_file_attributes(const gchar *s, const gchar *t, gint perms, gint mtime)
488 gboolean ret = FALSE;
490 if (!s || !t) return FALSE;
492 sl = path_from_utf8(s);
493 tl = path_from_utf8(t);
495 if (stat(sl, &st) == 0)
501 /* set the dest file attributes to that of source (ignoring errors) */
505 ret = chown(tl, st.st_uid, st.st_gid);
506 /* Ignores chown errors, while still doing chown
507 (so root still can copy files preserving ownership) */
509 if (chmod(tl, st.st_mode) < 0) {
511 if (stat(tl, &st2) != 0 || st2.st_mode != st.st_mode) {
517 tb.actime = st.st_atime;
518 tb.modtime = st.st_mtime;
519 if (mtime && utime(tl, &tb) < 0) ret = FALSE;
528 /* paths are in filesystem encoding */
529 static gboolean hard_linked(const gchar *a, const gchar *b)
534 if (stat(a, &sta) != 0 || stat(b, &stb) != 0) return FALSE;
536 return (sta.st_dev == stb.st_dev &&
537 sta.st_ino == stb.st_ino);
540 static void fclose_safe(FILE *fp)
545 gboolean copy_file(const gchar *s, const gchar *t)
551 std::unique_ptr<gchar, decltype(&g_free)> sl{path_from_utf8(s), g_free};
552 std::unique_ptr<gchar, decltype(&g_free)> tl{path_from_utf8(t), g_free};
554 if (hard_linked(sl.get(), tl.get()))
559 /* Do not dereference absolute symlinks, but copy them "as is".
560 * For a relative symlink, we don't know how to properly change it when
561 * copied/moved to another dir to keep pointing it to same target as
562 * a relative symlink, so we turn it into absolute symlink using
563 * realpath() instead. */
564 auto copy_symlink = [](const gchar *sl, const gchar *tl) -> gboolean
567 if (!lstat_utf8(sl, &st) && S_ISLNK(st.st_mode))
575 link_target = static_cast<gchar *>(g_malloc(st.st_size + 1));
576 i = readlink(sl, link_target, st.st_size);
580 return FALSE; // try a "normal" copy
582 link_target[st.st_size] = '\0';
584 if (link_target[0] != G_DIR_SEPARATOR) // if it is a relative symlink
588 const gchar *lastslash = strrchr(sl, G_DIR_SEPARATOR);
589 gint len = lastslash - sl + 1;
591 absolute = static_cast<gchar *>(g_malloc(len + st.st_size + 1));
592 strncpy(absolute, sl, len);
593 strcpy(absolute + len, link_target);
595 link_target = absolute;
598 realPath = realpath(link_target, nullptr);
600 if (realPath != nullptr) // successfully resolved into an absolute path
603 link_target = g_strdup(realPath);
606 else // could not get absolute path, got some error instead
609 return FALSE; // so try a "normal" copy
613 if (stat_utf8(tl, &st)) unlink(tl); // first try to remove directory entry in destination directory if such entry exists
615 gint success = (symlink(link_target, tl) == 0);
621 if (copy_symlink(sl.get(), tl.get()))
626 // if symlink did not succeed, continue on to try a copy procedure
627 std::unique_ptr<FILE, decltype(&fclose_safe)> fi{fopen(sl.get(), "rb"), fclose_safe};
633 /* First we write to a temporary file, then we rename it on success,
634 and attributes from original file are copied */
635 std::unique_ptr<gchar, decltype(&g_free)> randname{g_strconcat(tl.get(), ".tmp_XXXXXX", NULL), g_free};
641 fd = g_mkstemp(randname.get());
647 std::unique_ptr<FILE, decltype(&fclose_safe)> fo{fdopen(fd, "wb"), fclose_safe};
653 while ((b = fread(buf, sizeof(gchar), sizeof(buf), fi.get())) && b != 0)
655 if (fwrite(buf, sizeof(gchar), b, fo.get()) != b)
657 unlink(randname.get());
662 if (rename(randname.get(), tl.get()) < 0) {
663 unlink(randname.get());
667 return copy_file_attributes(s, t, TRUE, TRUE);
670 gboolean move_file(const gchar *s, const gchar *t)
675 if (!s || !t) return FALSE;
677 sl = path_from_utf8(s);
678 tl = path_from_utf8(t);
679 if (rename(sl, tl) < 0)
681 /* this may have failed because moving a file across filesystems
682 was attempted, so try copy and delete instead */
687 /* err, now we can't delete the source file so return FALSE */
702 gboolean rename_file(const gchar *s, const gchar *t)
707 if (!s || !t) return FALSE;
709 sl = path_from_utf8(s);
710 tl = path_from_utf8(t);
711 ret = (rename(sl, tl) == 0);
718 gchar *get_current_dir()
723 pathl = g_get_current_dir();
724 path8 = path_to_utf8(pathl);
730 void string_list_free(GList *list)
732 g_list_free_full(list, g_free);
735 GList *string_list_copy(const GList *list)
737 GList *new_list = nullptr;
738 auto work = const_cast<GList *>(list);
744 path = static_cast<gchar *>(work->data);
747 new_list = g_list_prepend(new_list, g_strdup(path));
750 return g_list_reverse(new_list);
753 gchar *unique_filename(const gchar *path, const gchar *ext, const gchar *divider, gboolean pad)
759 if (!divider) divider = "";
761 unique = g_strconcat(path, ext, NULL);
762 while (isname(unique))
767 unique = g_strdup_printf("%s%s%03d%s", path, divider, n, ext);
771 unique = g_strdup_printf("%s%s%d%s", path, divider, n, ext);
785 #pragma GCC diagnostic push
786 #pragma GCC diagnostic ignored "-Wunused-function"
787 gchar *unique_filename_simple_unused(const gchar *path)
793 if (!path) return NULL;
795 name = filename_from_path(path);
796 if (!name) return NULL;
798 ext = registered_extension_from_path(name);
802 unique = unique_filename(path, NULL, "_", TRUE);
808 base = remove_extension_from_path(path);
809 unique = unique_filename(base, ext, "_", TRUE);
815 #pragma GCC diagnostic pop
817 const gchar *filename_from_path(const gchar *path)
821 if (!path) return nullptr;
823 base = strrchr(path, G_DIR_SEPARATOR);
824 if (base) return base + 1;
829 gchar *remove_level_from_path(const gchar *path)
833 if (!path) return g_strdup("");
835 base = strrchr(path, G_DIR_SEPARATOR);
836 /* Take account of a file being in the root ( / ) folder - ensure the returned value
837 * is at least one character long */
838 if (base) return g_strndup(path, (strlen(path)-strlen(base)) == 0 ? 1 : (strlen(path)-strlen(base)));
843 gboolean file_extension_match(const gchar *path, const gchar *ext)
848 if (!path) return FALSE;
849 if (!ext) return TRUE;
855 return (p > e && g_ascii_strncasecmp(path + p - e, ext, e) == 0);
858 gchar *remove_extension_from_path(const gchar *path)
860 const gchar *reg_ext;
862 if (!path) return nullptr;
864 reg_ext = registered_extension_from_path(path);
866 return g_strndup(path, strlen(path) - (reg_ext == nullptr ? 0 : strlen(reg_ext)));
869 void parse_out_relatives(gchar *path)
877 while (path[s] != '\0')
879 if (path[s] == G_DIR_SEPARATOR && path[s+1] == '.')
881 /* /. occurrence, let's see more */
884 if (path[p] == G_DIR_SEPARATOR || path[p] == '\0')
886 /* /./ or /., just skip this part */
890 else if (path[p] == '.' && (path[p+1] == G_DIR_SEPARATOR || path[p+1] == '\0'))
892 /* /../ or /.., remove previous part, ie. /a/b/../ becomes /a/ */
895 while (path[t] != G_DIR_SEPARATOR && t > 0) t--;
900 if (s != t) path[t] = path[s];
905 if (t == 0 && path[t] == G_DIR_SEPARATOR) t++;
906 if (t > 1 && path[t-1] == G_DIR_SEPARATOR) t--;
910 gboolean file_in_path(const gchar *name)
915 gboolean ret = FALSE;
917 if (!name) return FALSE;
918 path = g_strdup(getenv("PATH"));
919 if (!path) return FALSE;
920 namel = path_from_utf8(name);
924 while (p < l && !ret)
928 while (path[e] != ':' && path[e] != '\0') e++;
931 f = g_build_filename(path + p, namel, NULL);
932 if (isfile(f)) ret = TRUE;
942 gboolean recursive_mkdir_if_not_exists(const gchar *path, mode_t mode)
944 if (!path) return FALSE;
948 gchar *npath = g_strdup(path);
954 if (p[0] == G_DIR_SEPARATOR || p[0] == '\0')
966 DEBUG_1("creating sub dir:%s", npath);
967 if (!mkdir_utf8(npath, mode))
969 log_printf("create dir failed: %s\n", npath);
975 if (!end) p[0] = G_DIR_SEPARATOR;
984 /* does filename utf8 to filesystem encoding first */
985 gboolean md5_get_digest_from_file_utf8(const gchar *path, guchar digest[16])
990 pathl = path_from_utf8(path);
991 success = md5_get_digest_from_file(pathl, digest);
998 gchar *md5_text_from_file_utf8(const gchar *path, const gchar *error_text)
1000 std::unique_ptr<gchar, decltype(&g_free)> pathl{path_from_utf8(path), g_free};
1002 auto md5_text = md5_get_string_from_file(pathl.get());
1004 return md5_text ? md5_text : g_strdup(error_text);
1007 /* Download web file
1012 GCancellable *cancellable;
1015 GtkWidget *progress;
1020 static void web_file_async_ready_cb(GObject *source_object, GAsyncResult *res, gpointer data)
1022 GError *error = nullptr;
1023 auto web = static_cast<WebData *>(data);
1024 gchar *tmp_filename;
1026 if (!g_cancellable_is_cancelled(web->cancellable))
1028 generic_dialog_close(web->gd);
1031 if (g_file_copy_finish(G_FILE(source_object), res, &error))
1033 tmp_filename = g_file_get_parse_name(web->tmp_g_file);
1034 g_free(tmp_filename);
1035 layout_set_path(web->lw, g_file_get_path(web->tmp_g_file));
1039 file_util_warning_dialog(_("Web file download failed"), error->message, GQ_ICON_DIALOG_ERROR, nullptr);
1042 g_object_unref(web->tmp_g_file);
1043 web->tmp_g_file = nullptr;
1044 g_object_unref(web->cancellable);
1045 g_object_unref(web->web_file);
1048 static void web_file_progress_cb(goffset current_num_bytes, goffset total_num_bytes, gpointer data)
1050 auto web = static_cast<WebData *>(data);
1052 if (!g_cancellable_is_cancelled(web->cancellable))
1054 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(web->progress), static_cast<gdouble>(current_num_bytes) / total_num_bytes);
1058 static void download_web_file_cancel_button_cb(GenericDialog *, gpointer data)
1060 auto web = static_cast<WebData *>(data);
1062 g_cancellable_cancel(web->cancellable);
1065 gboolean download_web_file(const gchar *text, gboolean minimized, gpointer data)
1068 auto lw = static_cast<LayoutWindow *>(data);
1070 GError *error = nullptr;
1073 gboolean ret = FALSE;
1075 FileFormatClass format_class;
1077 scheme = g_uri_parse_scheme(text);
1078 if (g_strcmp0("http", scheme) == 0 || g_strcmp0("https", scheme) == 0)
1080 format_class = filter_file_get_class(text);
1082 if (format_class == FORMAT_CLASS_IMAGE || format_class == FORMAT_CLASS_RAWIMAGE || format_class == FORMAT_CLASS_VIDEO || format_class == FORMAT_CLASS_DOCUMENT)
1084 tmp_dir = g_dir_make_tmp("geeqie_XXXXXX", &error);
1087 log_printf("Error: could not create temporary file n%s\n", error->message);
1088 g_error_free(error);
1094 web = g_new0(WebData, 1);
1097 web->web_file = g_file_new_for_uri(text);
1099 base = g_strdup(g_file_get_basename(web->web_file));
1100 web->tmp_g_file = g_file_new_for_path(g_build_filename(tmp_dir, base, NULL));
1102 web->gd = generic_dialog_new(_("Download web file"), "download_web_file", nullptr, TRUE, download_web_file_cancel_button_cb, web);
1104 message = g_strconcat(_("Downloading "), base, NULL);
1105 generic_dialog_add_message(web->gd, GQ_ICON_DIALOG_INFO, message, nullptr, FALSE);
1107 web->progress = gtk_progress_bar_new();
1108 gq_gtk_box_pack_start(GTK_BOX(web->gd->vbox), web->progress, FALSE, FALSE, 0);
1109 gtk_widget_show(web->progress);
1112 gtk_window_iconify(GTK_WINDOW(web->gd->dialog));
1115 gtk_widget_show(web->gd->dialog);
1116 web->cancellable = g_cancellable_new();
1117 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);
1135 gboolean rmdir_recursive(GFile *file, GCancellable *cancellable, GError **error)
1137 g_autoptr(GFileEnumerator) enumerator = nullptr;
1139 enumerator = g_file_enumerate_children(file, G_FILE_ATTRIBUTE_STANDARD_NAME, G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, cancellable, nullptr);
1141 while (enumerator != nullptr)
1145 if (!g_file_enumerator_iterate(enumerator, nullptr, &child, cancellable, error))
1147 if (child == nullptr)
1149 if (!rmdir_recursive(child, cancellable, error))
1153 return g_file_delete(file, cancellable, error);
1157 * @brief Retrieves the internal scale factor that maps from window coordinates to the actual device pixels
1159 * @returns scale factor
1165 LayoutWindow *lw = nullptr;
1168 return gtk_widget_get_scale_factor(lw->window);
1170 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */