1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library 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 GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
25 #include <sys/types.h>
35 #include <glib/gstdio.h>
38 #include "glocalfileoutputstream.h"
39 #include "glocalfileinfo.h"
44 #define S_ISDIR(m) (((m) & _S_IFMT) == _S_IFDIR)
47 #define S_ISREG(m) (((m) & _S_IFMT) == _S_IFREG)
53 #define g_local_file_output_stream_get_type _g_local_file_output_stream_get_type
54 G_DEFINE_TYPE (GLocalFileOutputStream, g_local_file_output_stream, G_TYPE_FILE_OUTPUT_STREAM);
56 /* Some of the file replacement code was based on the code from gedit,
57 * relicenced to LGPL with permissions from the authors.
60 #define BACKUP_EXTENSION "~"
62 struct _GLocalFileOutputStreamPrivate {
64 char *original_filename;
65 char *backup_filename;
70 static gssize g_local_file_output_stream_write (GOutputStream *stream,
73 GCancellable *cancellable,
75 static gboolean g_local_file_output_stream_close (GOutputStream *stream,
76 GCancellable *cancellable,
78 static GFileInfo *g_local_file_output_stream_query_info (GFileOutputStream *stream,
80 GCancellable *cancellable,
82 static char * g_local_file_output_stream_get_etag (GFileOutputStream *stream);
83 static goffset g_local_file_output_stream_tell (GFileOutputStream *stream);
84 static gboolean g_local_file_output_stream_can_seek (GFileOutputStream *stream);
85 static gboolean g_local_file_output_stream_seek (GFileOutputStream *stream,
88 GCancellable *cancellable,
90 static gboolean g_local_file_output_stream_can_truncate (GFileOutputStream *stream);
91 static gboolean g_local_file_output_stream_truncate (GFileOutputStream *stream,
93 GCancellable *cancellable,
97 g_local_file_output_stream_finalize (GObject *object)
99 GLocalFileOutputStream *file;
101 file = G_LOCAL_FILE_OUTPUT_STREAM (object);
103 g_free (file->priv->tmp_filename);
104 g_free (file->priv->original_filename);
105 g_free (file->priv->backup_filename);
106 g_free (file->priv->etag);
108 if (G_OBJECT_CLASS (g_local_file_output_stream_parent_class)->finalize)
109 (*G_OBJECT_CLASS (g_local_file_output_stream_parent_class)->finalize) (object);
113 g_local_file_output_stream_class_init (GLocalFileOutputStreamClass *klass)
115 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
116 GOutputStreamClass *stream_class = G_OUTPUT_STREAM_CLASS (klass);
117 GFileOutputStreamClass *file_stream_class = G_FILE_OUTPUT_STREAM_CLASS (klass);
119 g_type_class_add_private (klass, sizeof (GLocalFileOutputStreamPrivate));
121 gobject_class->finalize = g_local_file_output_stream_finalize;
123 stream_class->write_fn = g_local_file_output_stream_write;
124 stream_class->close_fn = g_local_file_output_stream_close;
125 file_stream_class->query_info = g_local_file_output_stream_query_info;
126 file_stream_class->get_etag = g_local_file_output_stream_get_etag;
127 file_stream_class->tell = g_local_file_output_stream_tell;
128 file_stream_class->can_seek = g_local_file_output_stream_can_seek;
129 file_stream_class->seek = g_local_file_output_stream_seek;
130 file_stream_class->can_truncate = g_local_file_output_stream_can_truncate;
131 file_stream_class->truncate_fn = g_local_file_output_stream_truncate;
135 g_local_file_output_stream_init (GLocalFileOutputStream *stream)
137 stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
138 G_TYPE_LOCAL_FILE_OUTPUT_STREAM,
139 GLocalFileOutputStreamPrivate);
143 g_local_file_output_stream_write (GOutputStream *stream,
146 GCancellable *cancellable,
149 GLocalFileOutputStream *file;
152 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
156 if (g_cancellable_set_error_if_cancelled (cancellable, error))
158 res = write (file->priv->fd, buffer, count);
164 g_set_error (error, G_IO_ERROR,
165 g_io_error_from_errno (errno),
166 _("Error writing to file: %s"),
177 g_local_file_output_stream_close (GOutputStream *stream,
178 GCancellable *cancellable,
181 GLocalFileOutputStream *file;
182 struct stat final_stat;
185 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
187 if (file->priv->tmp_filename)
189 /* We need to move the temp file to its final place,
190 * and possibly create the backup file
193 if (file->priv->backup_filename)
195 if (g_cancellable_set_error_if_cancelled (cancellable, error))
199 /* create original -> backup link, the original is then renamed over */
200 if (unlink (file->priv->backup_filename) != 0 &&
203 g_set_error (error, G_IO_ERROR,
204 G_IO_ERROR_CANT_CREATE_BACKUP,
205 _("Error removing old backup link: %s"),
210 if (link (file->priv->original_filename, file->priv->backup_filename) != 0)
212 g_set_error (error, G_IO_ERROR,
213 G_IO_ERROR_CANT_CREATE_BACKUP,
214 _("Error creating backup link: %s"),
219 /* If link not supported, just rename... */
220 if (!rename (file->priv->original_filename, file->priv->backup_filename) != 0)
222 g_set_error (error, G_IO_ERROR,
223 G_IO_ERROR_CANT_CREATE_BACKUP,
224 _("Error creating backup copy: %s"),
232 if (g_cancellable_set_error_if_cancelled (cancellable, error))
235 /* tmp -> original */
236 if (rename (file->priv->tmp_filename, file->priv->original_filename) != 0)
238 g_set_error (error, G_IO_ERROR,
239 g_io_error_from_errno (errno),
240 _("Error renaming temporary file: %s"),
246 if (g_cancellable_set_error_if_cancelled (cancellable, error))
249 if (fstat (file->priv->fd, &final_stat) == 0)
250 file->priv->etag = _g_local_file_info_create_etag (&final_stat);
254 res = close (file->priv->fd);
257 g_set_error (error, G_IO_ERROR,
258 g_io_error_from_errno (errno),
259 _("Error closing file: %s"),
268 /* A simple try to close the fd in case we fail before the actual close */
269 close (file->priv->fd);
274 g_local_file_output_stream_get_etag (GFileOutputStream *stream)
276 GLocalFileOutputStream *file;
278 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
280 return g_strdup (file->priv->etag);
284 g_local_file_output_stream_tell (GFileOutputStream *stream)
286 GLocalFileOutputStream *file;
289 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
291 pos = lseek (file->priv->fd, 0, SEEK_CUR);
293 if (pos == (off_t)-1)
300 g_local_file_output_stream_can_seek (GFileOutputStream *stream)
302 GLocalFileOutputStream *file;
305 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
307 pos = lseek (file->priv->fd, 0, SEEK_CUR);
309 if (pos == (off_t)-1 &&
317 seek_type_to_lseek (GSeekType type)
334 g_local_file_output_stream_seek (GFileOutputStream *stream,
337 GCancellable *cancellable,
340 GLocalFileOutputStream *file;
343 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
345 pos = lseek (file->priv->fd, offset, seek_type_to_lseek (type));
347 if (pos == (off_t)-1)
349 g_set_error (error, G_IO_ERROR,
350 g_io_error_from_errno (errno),
351 _("Error seeking in file: %s"),
360 g_local_file_output_stream_can_truncate (GFileOutputStream *stream)
362 /* We can't truncate pipes and stuff where we can't seek */
363 return g_local_file_output_stream_can_seek (stream);
367 g_local_file_output_stream_truncate (GFileOutputStream *stream,
369 GCancellable *cancellable,
372 GLocalFileOutputStream *file;
375 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
379 res = g_win32_ftruncate (file->priv->fd, size);
381 res = ftruncate (file->priv->fd, size);
388 if (g_cancellable_set_error_if_cancelled (cancellable, error))
393 g_set_error (error, G_IO_ERROR,
394 g_io_error_from_errno (errno),
395 _("Error truncating file: %s"),
405 g_local_file_output_stream_query_info (GFileOutputStream *stream,
407 GCancellable *cancellable,
410 GLocalFileOutputStream *file;
412 file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
414 if (g_cancellable_set_error_if_cancelled (cancellable, error))
417 return _g_local_file_info_get_from_fd (file->priv->fd,
423 _g_local_file_output_stream_create (const char *filename,
424 GFileCreateFlags flags,
425 GCancellable *cancellable,
428 GLocalFileOutputStream *stream;
432 if (g_cancellable_set_error_if_cancelled (cancellable, error))
435 if (flags & G_FILE_CREATE_PRIVATE)
440 fd = g_open (filename,
441 O_CREAT | O_EXCL | O_WRONLY,
448 /* This must be an invalid filename, on e.g. FAT */
449 g_set_error (error, G_IO_ERROR,
450 G_IO_ERROR_INVALID_FILENAME,
451 _("Invalid filename"));
453 g_set_error (error, G_IO_ERROR,
454 g_io_error_from_errno (errsv),
455 _("Error opening file '%s': %s"),
456 filename, g_strerror (errsv));
460 stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
461 stream->priv->fd = fd;
462 return G_FILE_OUTPUT_STREAM (stream);
466 _g_local_file_output_stream_append (const char *filename,
467 GFileCreateFlags flags,
468 GCancellable *cancellable,
471 GLocalFileOutputStream *stream;
475 if (g_cancellable_set_error_if_cancelled (cancellable, error))
478 if (flags & G_FILE_CREATE_PRIVATE)
483 fd = g_open (filename,
484 O_CREAT | O_APPEND | O_WRONLY,
491 /* This must be an invalid filename, on e.g. FAT */
492 g_set_error (error, G_IO_ERROR,
493 G_IO_ERROR_INVALID_FILENAME,
494 _("Invalid filename"));
496 g_set_error (error, G_IO_ERROR,
497 g_io_error_from_errno (errsv),
498 _("Error opening file '%s': %s"),
499 filename, g_strerror (errsv));
503 stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
504 stream->priv->fd = fd;
506 return G_FILE_OUTPUT_STREAM (stream);
510 create_backup_filename (const char *filename)
512 return g_strconcat (filename, BACKUP_EXTENSION, NULL);
515 #define BUFSIZE 8192 /* size of normal write buffer */
518 copy_file_data (gint sfd,
524 const gchar *write_buffer;
526 gssize bytes_to_write;
527 gssize bytes_written;
529 buffer = g_malloc (BUFSIZE);
533 bytes_read = read (sfd, buffer, BUFSIZE);
534 if (bytes_read == -1)
539 g_set_error (error, G_IO_ERROR,
540 g_io_error_from_errno (errno),
541 _("Error reading from file: %s"),
547 bytes_to_write = bytes_read;
548 write_buffer = buffer;
552 bytes_written = write (dfd, write_buffer, bytes_to_write);
553 if (bytes_written == -1)
558 g_set_error (error, G_IO_ERROR,
559 g_io_error_from_errno (errno),
560 _("Error writing to file: %s"),
566 bytes_to_write -= bytes_written;
567 write_buffer += bytes_written;
569 while (bytes_to_write > 0);
571 } while ((bytes_read != 0) && (ret == TRUE));
579 handle_overwrite_open (const char *filename,
581 gboolean create_backup,
582 char **temp_filename,
583 GCancellable *cancellable,
587 struct stat original_stat;
592 /* We only need read access to the original file if we are creating a backup.
593 * We also add O_CREATE to avoid a race if the file was just removed */
595 open_flags = O_RDWR | O_CREAT;
597 open_flags = O_WRONLY | O_CREAT;
599 /* Some systems have O_NOFOLLOW, which lets us avoid some races
600 * when finding out if the file we opened was a symlink */
603 fd = g_open (filename, open_flags | O_NOFOLLOW, 0666);
604 if (fd == -1 && errno == ELOOP)
606 /* Could be a symlink, or it could be a regular ELOOP error,
607 * but then the next open will fail too. */
609 fd = g_open (filename, open_flags, 0666);
612 fd = g_open (filename, open_flags, 0666);
613 /* This is racy, but we do it as soon as possible to minimize the race */
614 is_symlink = g_file_test (filename, G_FILE_TEST_IS_SYMLINK);
619 g_set_error (error, G_IO_ERROR,
620 g_io_error_from_errno (errno),
621 _("Error opening file '%s': %s"),
622 filename, g_strerror (errno));
626 if (fstat (fd, &original_stat) != 0)
628 g_set_error (error, G_IO_ERROR,
629 g_io_error_from_errno (errno),
630 _("Error stating file '%s': %s"),
631 filename, g_strerror (errno));
635 /* not a regular file */
636 if (!S_ISREG (original_stat.st_mode))
638 if (S_ISDIR (original_stat.st_mode))
641 G_IO_ERROR_IS_DIRECTORY,
642 _("Target file is a directory"));
646 G_IO_ERROR_NOT_REGULAR_FILE,
647 _("Target file is not a regular file"));
653 current_etag = _g_local_file_info_create_etag (&original_stat);
654 if (strcmp (etag, current_etag) != 0)
658 G_IO_ERROR_WRONG_ETAG,
659 _("The file was externally modified"));
660 g_free (current_etag);
663 g_free (current_etag);
666 /* We use two backup strategies.
667 * The first one (which is faster) consist in saving to a
668 * tmp file then rename the original file to the backup and the
669 * tmp file to the original name. This is fast but doesn't work
670 * when the file is a link (hard or symbolic) or when we can't
671 * write to the current dir or can't set the permissions on the
673 * The second strategy consist simply in copying the old file
674 * to a backup file and rewrite the contents of the file.
677 if (!(original_stat.st_nlink > 1) && !is_symlink)
679 char *dirname, *tmp_filename;
682 dirname = g_path_get_dirname (filename);
683 tmp_filename = g_build_filename (dirname, ".goutputstream-XXXXXX", NULL);
686 tmpfd = g_mkstemp (tmp_filename);
689 g_free (tmp_filename);
690 goto fallback_strategy;
693 /* try to keep permissions */
697 fchown (tmpfd, original_stat.st_uid, original_stat.st_gid) == -1 ||
700 fchmod (tmpfd, original_stat.st_mode) == -1 ||
705 struct stat tmp_statbuf;
707 /* Check that we really needed to change something */
708 if (fstat (tmpfd, &tmp_statbuf) != 0 ||
709 original_stat.st_uid != tmp_statbuf.st_uid ||
710 original_stat.st_gid != tmp_statbuf.st_gid ||
711 original_stat.st_mode != tmp_statbuf.st_mode)
714 unlink (tmp_filename);
715 g_free (tmp_filename);
716 goto fallback_strategy;
721 *temp_filename = tmp_filename;
729 struct stat tmp_statbuf;
730 char *backup_filename;
733 backup_filename = create_backup_filename (filename);
735 if (unlink (backup_filename) == -1 && errno != ENOENT)
739 G_IO_ERROR_CANT_CREATE_BACKUP,
740 _("Backup file creation failed"));
741 g_free (backup_filename);
745 bfd = g_open (backup_filename,
746 O_WRONLY | O_CREAT | O_EXCL,
747 original_stat.st_mode & 0777);
753 G_IO_ERROR_CANT_CREATE_BACKUP,
754 _("Backup file creation failed"));
755 g_free (backup_filename);
759 /* If needed, Try to set the group of the backup same as the
760 * original file. If this fails, set the protection
761 * bits for the group same as the protection bits for
764 if (fstat (bfd, &tmp_statbuf) != 0)
768 G_IO_ERROR_CANT_CREATE_BACKUP,
769 _("Backup file creation failed"));
770 unlink (backup_filename);
771 g_free (backup_filename);
775 if ((original_stat.st_gid != tmp_statbuf.st_gid) &&
776 fchown (bfd, (uid_t) -1, original_stat.st_gid) != 0)
779 (original_stat.st_mode & 0707) |
780 ((original_stat.st_mode & 07) << 3)) != 0)
784 G_IO_ERROR_CANT_CREATE_BACKUP,
785 _("Backup file creation failed"));
786 unlink (backup_filename);
788 g_free (backup_filename);
794 if (!copy_file_data (fd, bfd, NULL))
798 G_IO_ERROR_CANT_CREATE_BACKUP,
799 _("Backup file creation failed"));
800 unlink (backup_filename);
802 g_free (backup_filename);
808 g_free (backup_filename);
810 /* Seek back to the start of the file after the backup copy */
811 if (lseek (fd, 0, SEEK_SET) == -1)
813 g_set_error (error, G_IO_ERROR,
814 g_io_error_from_errno (errno),
815 _("Error seeking in file: %s"),
821 /* Truncate the file at the start */
823 if (g_win32_ftruncate (fd, 0) == -1)
825 if (ftruncate (fd, 0) == -1)
828 g_set_error (error, G_IO_ERROR,
829 g_io_error_from_errno (errno),
830 _("Error truncating file: %s"),
843 _g_local_file_output_stream_replace (const char *filename,
845 gboolean create_backup,
846 GFileCreateFlags flags,
847 GCancellable *cancellable,
850 GLocalFileOutputStream *stream;
855 if (g_cancellable_set_error_if_cancelled (cancellable, error))
860 if (flags & G_FILE_CREATE_PRIVATE)
865 /* If the file doesn't exist, create it */
866 fd = g_open (filename,
867 O_CREAT | O_EXCL | O_WRONLY,
870 if (fd == -1 && errno == EEXIST)
872 /* The file already exists */
873 fd = handle_overwrite_open (filename, etag, create_backup, &temp_file,
883 /* This must be an invalid filename, on e.g. FAT */
884 g_set_error (error, G_IO_ERROR,
885 G_IO_ERROR_INVALID_FILENAME,
886 _("Invalid filename"));
888 g_set_error (error, G_IO_ERROR,
889 g_io_error_from_errno (errsv),
890 _("Error opening file '%s': %s"),
891 filename, g_strerror (errsv));
896 stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
897 stream->priv->fd = fd;
898 stream->priv->tmp_filename = temp_file;
900 stream->priv->backup_filename = create_backup_filename (filename);
901 stream->priv->original_filename = g_strdup (filename);
903 return G_FILE_OUTPUT_STREAM (stream);