2 * Copyright (C) 2002 Jorn Baayen
3 * Copyright © 2009 Christian Persch
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <sys/types.h>
29 #include <glib/gstdio.h>
30 #include <glib/gi18n-lib.h>
32 #include "ev-file-helpers.h"
34 static gchar *tmp_dir = NULL;
37 * ev_dir_ensure_exists:
38 * @dir: the directory name
39 * @mode: permissions to use when creating the directory
40 * @error: a location to store a #GError
42 * Create @dir recursively with permissions @mode.
44 * Returns: %TRUE on success, or %FALSE on error with @error filled in
47 _ev_dir_ensure_exists (const gchar *dir,
54 g_return_val_if_fail (dir != NULL, FALSE);
57 if (g_mkdir_with_parents (dir, mode) == 0)
61 if (errsv == EEXIST && g_file_test (dir, G_FILE_TEST_IS_DIR))
64 display_name = g_filename_display_name (dir);
65 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
66 "Failed to create directory '%s': %s",
67 display_name, g_strerror (errsv));
68 g_free (display_name);
75 * @error: a location to store a #GError
77 * Returns the tmp directory.
79 * Returns: the tmp directory, or %NULL with @error filled in if the
80 * directory could not be created
83 _ev_tmp_dir (GError **error)
86 if (tmp_dir == NULL) {
87 gchar *dirname, *prgname;
89 prgname = g_get_prgname ();
90 dirname = g_strdup_printf ("%s-%u", prgname ? prgname : "unknown", getpid ());
91 tmp_dir = g_build_filename (g_get_tmp_dir (), dirname, NULL);
95 if (!_ev_dir_ensure_exists (tmp_dir, 0700, error))
102 _ev_file_helpers_init (void)
107 _ev_file_helpers_shutdown (void)
118 * @template: a template string; must contain 'XXXXXX', but not necessarily as a suffix
119 * @file_name: a location to store the filename of the temp file
120 * @error: a location to store a #GError
122 * Creates a temp file in the evince temp directory.
124 * Returns: a file descriptor to the newly created temp file name, or %-1
125 * on error with @error filled in
128 ev_mkstemp (const char *template,
136 if ((tmp = _ev_tmp_dir (error)) == NULL)
139 name = g_build_filename (tmp, template, NULL);
140 fd = g_mkstemp (name);
145 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
146 _("Failed to create a temporary file: %s"),
160 close_fd_cb (gpointer fdptr)
162 int fd = GPOINTER_TO_INT (fdptr);
169 * @template: a template string; must contain 'XXXXXX', but not necessarily as a suffix
170 * @error: a location to store a #GError
172 * Creates a temp #GFile in the evince temp directory. See ev_mkstemp() for more information.
174 * Returns: a newly allocated #GFile for the newly created temp file name, or %NULL
175 * on error with @error filled in
178 ev_mkstemp_file (const char *template,
185 fd = ev_mkstemp (template, &file_name, error);
189 file = g_file_new_for_path (file_name);
192 g_object_set_data_full (G_OBJECT (file), "ev-mkstemp-fd",
193 GINT_TO_POINTER (fd), (GDestroyNotify) close_fd_cb);
200 * @template: a template string; must end in 'XXXXXX'
201 * @error: a location to store a #GError
203 * Creates a temp directory in the evince temp directory.
205 * Returns: a newly allocated string with the temp directory name, or %NULL
206 * on error with @error filled in
209 ev_mkdtemp (const char *template,
215 if ((tmp = _ev_tmp_dir (error)) == NULL)
218 name = g_build_filename (tmp, template, NULL);
219 if (mkdtemp (name) == NULL) {
222 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
223 _("Failed to create a temporary directory: %s"),
233 /* Remove a local temp file created by evince */
235 ev_tmp_filename_unlink (const gchar *filename)
237 const gchar *tempdir;
242 tempdir = g_get_tmp_dir ();
243 if (g_str_has_prefix (filename, tempdir) == 0) {
249 ev_tmp_file_unlink (GFile *file)
252 GError *error = NULL;
257 res = g_file_delete (file, NULL, &error);
261 uri = g_file_get_uri (file);
262 g_warning ("Unable to delete temp file %s: %s\n", uri, error->message);
264 g_error_free (error);
269 ev_tmp_uri_unlink (const gchar *uri)
276 file = g_file_new_for_uri (uri);
277 if (!g_file_is_native (file)) {
278 g_warning ("Attempting to delete non native uri: %s\n", uri);
279 g_object_unref (file);
283 ev_tmp_file_unlink (file);
284 g_object_unref (file);
288 * ev_xfer_uri_simple:
289 * @from: the source URI
290 * @to: the target URI
291 * @error: a #GError location to store an error, or %NULL
293 * Performs a g_file_copy() from @from to @to.
295 * Returns: %TRUE on success, or %FALSE on error with @error filled in
298 ev_xfer_uri_simple (const char *from,
309 g_return_val_if_fail (to != NULL, TRUE);
311 source_file = g_file_new_for_uri (from);
312 target_file = g_file_new_for_uri (to);
314 result = g_file_copy (source_file, target_file,
315 #if GLIB_CHECK_VERSION(2,19,0)
316 G_FILE_COPY_TARGET_DEFAULT_PERMS |
318 G_FILE_COPY_OVERWRITE,
319 NULL, NULL, NULL, error);
321 g_object_unref (target_file);
322 g_object_unref (source_file);
328 get_mime_type_from_uri (const gchar *uri, GError **error)
331 GFileInfo *file_info;
332 const gchar *content_type;
333 gchar *mime_type = NULL;
335 file = g_file_new_for_uri (uri);
336 file_info = g_file_query_info (file,
337 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
339 g_object_unref (file);
341 if (file_info == NULL)
344 content_type = g_file_info_get_content_type (file_info);
346 mime_type = g_content_type_get_mime_type (content_type);
349 g_object_unref (file_info);
354 get_mime_type_from_data (const gchar *uri, GError **error)
357 GFileInputStream *input_stream;
361 gchar *content_type, *mime_type;
363 file = g_file_new_for_uri (uri);
365 input_stream = g_file_read (file, NULL, error);
367 g_object_unref (file);
371 size_read = g_input_stream_read (G_INPUT_STREAM (input_stream),
372 buffer, sizeof (buffer), NULL, error);
373 if (size_read == -1) {
374 g_object_unref (input_stream);
375 g_object_unref (file);
379 retval = g_input_stream_close (G_INPUT_STREAM (input_stream), NULL, error);
381 g_object_unref (input_stream);
382 g_object_unref (file);
386 content_type = g_content_type_guess (NULL, /* no filename */
392 mime_type = g_content_type_get_mime_type (content_type);
393 g_free (content_type);
398 * ev_file_get_mime_type:
400 * @fast: whether to use fast MIME type detection
401 * @error: a #GError location to store an error, or %NULL
403 * Note: on unknown MIME types, this may return NULL without @error
406 * Returns: a newly allocated string with the MIME type of the file at
407 * @uri, or %NULL on error or if the MIME type could not be determined
410 ev_file_get_mime_type (const gchar *uri,
414 return fast ? get_mime_type_from_uri (uri, error) : get_mime_type_from_data (uri, error);
417 /* Compressed files support */
418 #define BZIPCOMMAND "bzip2"
419 #define GZIPCOMMAND "gzip"
421 #define BUFFER_SIZE 1024
424 compression_run (const gchar *uri,
425 EvCompressionType type,
430 gchar *uri_dst = NULL;
431 gchar *filename, *filename_dst = NULL;
436 if (type == EV_COMPRESSION_NONE)
439 cmd = g_find_program_in_path ((type == EV_COMPRESSION_BZIP2) ? BZIPCOMMAND : GZIPCOMMAND);
441 /* FIXME: better error codes! */
442 /* FIXME: i18n later */
443 g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED,
444 "Failed to find the \"%s\" command in the search path.",
445 type == EV_COMPRESSION_BZIP2 ? BZIPCOMMAND : GZIPCOMMAND);
449 filename = g_filename_from_uri (uri, NULL, error);
455 fd = ev_mkstemp ("comp.XXXXXX", &filename_dst, error);
464 argv[1] = compress ? "-c" : "-cd";
468 if (g_spawn_async_with_pipes (NULL, argv, NULL,
469 G_SPAWN_STDERR_TO_DEV_NULL,
471 NULL, &pout, NULL, &err)) {
472 GIOChannel *in, *out;
473 gchar buf[BUFFER_SIZE];
474 GIOStatus read_st, write_st;
475 gsize bytes_read, bytes_written;
477 in = g_io_channel_unix_new (pout);
478 g_io_channel_set_encoding (in, NULL, NULL);
479 out = g_io_channel_unix_new (fd);
480 g_io_channel_set_encoding (out, NULL, NULL);
483 read_st = g_io_channel_read_chars (in, buf,
487 if (read_st == G_IO_STATUS_NORMAL) {
488 write_st = g_io_channel_write_chars (out, buf,
492 if (write_st == G_IO_STATUS_ERROR)
494 } else if (read_st == G_IO_STATUS_ERROR) {
497 } while (bytes_read > 0);
499 g_io_channel_unref (in);
500 g_io_channel_unref (out);
506 g_propagate_error (error, err);
508 uri_dst = g_filename_to_uri (filename_dst, NULL, error);
513 g_free (filename_dst);
519 * ev_file_uncompress:
521 * @type: the compression type
522 * @error: a #GError location to store an error, or %NULL
524 * Uncompresses the file at @uri.
526 * If @type is %EV_COMPRESSION_NONE, it does nothing and returns %NULL.
528 * Otherwise, it returns the filename of a
529 * temporary file containing the decompressed data from the file at @uri.
530 * On error it returns %NULL and fills in @error.
532 * It is the caller's responsibility to unlink the temp file after use.
534 * Returns: a newly allocated string URI, or %NULL on error
537 ev_file_uncompress (const gchar *uri,
538 EvCompressionType type,
541 g_return_val_if_fail (uri != NULL, NULL);
543 return compression_run (uri, type, FALSE, error);
549 * @type: the compression type
550 * @error: a #GError location to store an error, or %NULL
552 * Compresses the file at @uri.
554 * If @type is %EV_COMPRESSION_NONE, it does nothing and returns %NULL.
556 * Otherwise, it returns the filename of a
557 * temporary file containing the compressed data from the file at @uri.
559 * On error it returns %NULL and fills in @error.
561 * It is the caller's responsibility to unlink the temp file after use.
563 * Returns: a newly allocated string URI, or %NULL on error
566 ev_file_compress (const gchar *uri,
567 EvCompressionType type,
570 g_return_val_if_fail (uri != NULL, NULL);
572 return compression_run (uri, type, TRUE, error);