gio/glocalfileoutputstream.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <sys/types.h>
  26 #include <sys/stat.h>
  27 #include <fcntl.h>
  28 #ifdef HAVE_UNISTD_H
  29 #include <unistd.h>
  30 #endif
  31 #include <errno.h>
  32 #include <string.h>
  33
  34 #include <glib.h>
  35 #include <glib/gstdio.h>
  36 #include "glibintl.h"
  37 #include "gioerror.h"
  38 #include "gcancellable.h"
  39 #include "glocalfileoutputstream.h"
  40 #include "glocalfileinfo.h"
  41
  42 #ifdef G_OS_UNIX
  43 #include "gfiledescriptorbased.h"
  44 #endif
  45
  46 #ifdef G_OS_WIN32
  47 #include <io.h>
  48 #ifndef S_ISDIR
  49 #define S_ISDIR(m) (((m) & _S_IFMT) == _S_IFDIR)
  50 #endif
  51 #ifndef S_ISREG
  52 #define S_ISREG(m) (((m) & _S_IFMT) == _S_IFREG)
  53 #endif
  54 #endif
  55
  56 #ifndef O_BINARY
  57 #define O_BINARY 0
  58 #endif
  59
  60
  61 #ifdef G_OS_UNIX
  62 static void       g_file_descriptor_based_iface_init   (GFileDescriptorBasedIface *iface);
  63 #endif
  64
  65 #define g_local_file_output_stream_get_type _g_local_file_output_stream_get_type
  66 #ifdef G_OS_UNIX
  67 G_DEFINE_TYPE_WITH_CODE (GLocalFileOutputStream, g_local_file_output_stream, G_TYPE_FILE_OUTPUT_STREAM,
  68                          G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED,
  69                                                 g_file_descriptor_based_iface_init)
  70                            );
  71 #else
  72 G_DEFINE_TYPE_WITH_CODE (GLocalFileOutputStream, g_local_file_output_stream, G_TYPE_FILE_OUTPUT_STREAM,);
  73 #endif
  74
  75
  76 /* Some of the file replacement code was based on the code from gedit,
  77  * relicenced to LGPL with permissions from the authors.
  78  */
  79
  80 #define BACKUP_EXTENSION "~"
  81
  82 struct _GLocalFileOutputStreamPrivate {
  83   char *tmp_filename;
  84   char *original_filename;
  85   char *backup_filename;
  86   char *etag;
  87   guint sync_on_close : 1;
  88   guint do_close : 1;
  89   int fd;
  90 };
  91
  92 static gssize     g_local_file_output_stream_write        (GOutputStream      *stream,
  93                                                            const void         *buffer,
  94                                                            gsize               count,
  95                                                            GCancellable       *cancellable,
  96                                                            GError            **error);
  97 static gboolean   g_local_file_output_stream_close        (GOutputStream      *stream,
  98                                                            GCancellable       *cancellable,
  99                                                            GError            **error);
 100 static GFileInfo *g_local_file_output_stream_query_info   (GFileOutputStream  *stream,
 101                                                            const char         *attributes,
 102                                                            GCancellable       *cancellable,
 103                                                            GError            **error);
 104 static char *     g_local_file_output_stream_get_etag     (GFileOutputStream  *stream);
 105 static goffset    g_local_file_output_stream_tell         (GFileOutputStream  *stream);
 106 static gboolean   g_local_file_output_stream_can_seek     (GFileOutputStream  *stream);
 107 static gboolean   g_local_file_output_stream_seek         (GFileOutputStream  *stream,
 108                                                            goffset             offset,
 109                                                            GSeekType           type,
 110                                                            GCancellable       *cancellable,
 111                                                            GError            **error);
 112 static gboolean   g_local_file_output_stream_can_truncate (GFileOutputStream  *stream);
 113 static gboolean   g_local_file_output_stream_truncate     (GFileOutputStream  *stream,
 114                                                            goffset             size,
 115                                                            GCancellable       *cancellable,
 116                                                            GError            **error);
 117 #ifdef G_OS_UNIX
 118 static int        g_local_file_output_stream_get_fd       (GFileDescriptorBased *stream);
 119 #endif
 120
 121 static void
 122 g_local_file_output_stream_finalize (GObject *object)
 123 {
 124   GLocalFileOutputStream *file;
 125
 126   file = G_LOCAL_FILE_OUTPUT_STREAM (object);
 127
 128   g_free (file->priv->tmp_filename);
 129   g_free (file->priv->original_filename);
 130   g_free (file->priv->backup_filename);
 131   g_free (file->priv->etag);
 132
 133   G_OBJECT_CLASS (g_local_file_output_stream_parent_class)->finalize (object);
 134 }
 135
 136
 137 static void
 138 g_local_file_output_stream_class_init (GLocalFileOutputStreamClass *klass)
 139 {
 140   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 141   GOutputStreamClass *stream_class = G_OUTPUT_STREAM_CLASS (klass);
 142   GFileOutputStreamClass *file_stream_class = G_FILE_OUTPUT_STREAM_CLASS (klass);
 143
 144   g_type_class_add_private (klass, sizeof (GLocalFileOutputStreamPrivate));
 145
 146   gobject_class->finalize = g_local_file_output_stream_finalize;
 147
 148   stream_class->write_fn = g_local_file_output_stream_write;
 149   stream_class->close_fn = g_local_file_output_stream_close;
 150   file_stream_class->query_info = g_local_file_output_stream_query_info;
 151   file_stream_class->get_etag = g_local_file_output_stream_get_etag;
 152   file_stream_class->tell = g_local_file_output_stream_tell;
 153   file_stream_class->can_seek = g_local_file_output_stream_can_seek;
 154   file_stream_class->seek = g_local_file_output_stream_seek;
 155   file_stream_class->can_truncate = g_local_file_output_stream_can_truncate;
 156   file_stream_class->truncate_fn = g_local_file_output_stream_truncate;
 157 }
 158
 159 #ifdef G_OS_UNIX
 160 static void
 161 g_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface)
 162 {
 163   iface->get_fd = g_local_file_output_stream_get_fd;
 164 }
 165 #endif
 166
 167 static void
 168 g_local_file_output_stream_init (GLocalFileOutputStream *stream)
 169 {
 170   stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream,
 171                                               G_TYPE_LOCAL_FILE_OUTPUT_STREAM,
 172                                               GLocalFileOutputStreamPrivate);
 173   stream->priv->do_close = TRUE;
 174 }
 175
 176 static gssize
 177 g_local_file_output_stream_write (GOutputStream  *stream,
 178                                   const void     *buffer,
 179                                   gsize           count,
 180                                   GCancellable   *cancellable,
 181                                   GError        **error)
 182 {
 183   GLocalFileOutputStream *file;
 184   gssize res;
 185
 186   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 187
 188   while (1)
 189     {
 190       if (g_cancellable_set_error_if_cancelled (cancellable, error))
 191         return -1;
 192       res = write (file->priv->fd, buffer, count);
 193       if (res == -1)
 194         {
 195           int errsv = errno;
 196
 197           if (errsv == EINTR)
 198             continue;
 199
 200           g_set_error (error, G_IO_ERROR,
 201                        g_io_error_from_errno (errsv),
 202                        _("Error writing to file: %s"),
 203                        g_strerror (errsv));
 204         }
 205
 206       break;
 207     }
 208
 209   return res;
 210 }
 211
 212 void
 213 _g_local_file_output_stream_set_do_close (GLocalFileOutputStream *out,
 214                                           gboolean do_close)
 215 {
 216   out->priv->do_close = do_close;
 217 }
 218
 219 gboolean
 220 _g_local_file_output_stream_really_close (GLocalFileOutputStream *file,
 221                                           GCancellable   *cancellable,
 222                                           GError        **error)
 223 {
 224   GLocalFileStat final_stat;
 225
 226 #ifdef HAVE_FSYNC
 227   if (file->priv->sync_on_close &&
 228       fsync (file->priv->fd) != 0)
 229     {
 230       int errsv = errno;
 231
 232       g_set_error (error, G_IO_ERROR,
 233                    g_io_error_from_errno (errsv),
 234                    _("Error writing to file: %s"),
 235                    g_strerror (errsv));
 236       goto err_out;
 237     }
 238 #endif
 239
 240 #ifdef G_OS_WIN32
 241
 242   /* Must close before renaming on Windows, so just do the close first
 243    * in all cases for now.
 244    */
 245   if (_fstati64 (file->priv->fd, &final_stat) == 0)
 246     file->priv->etag = _g_local_file_info_create_etag (&final_stat);
 247
 248   if (!g_close (file->priv->fd, NULL))
 249     {
 250       int errsv = errno;
 251
 252       g_set_error (error, G_IO_ERROR,
 253                    g_io_error_from_errno (errsv),
 254                    _("Error closing file: %s"),
 255                    g_strerror (errsv));
 256       return FALSE;
 257     }
 258
 259 #endif
 260
 261   if (file->priv->tmp_filename)
 262     {
 263       /* We need to move the temp file to its final place,
 264        * and possibly create the backup file
 265        */
 266
 267       if (file->priv->backup_filename)
 268         {
 269           if (g_cancellable_set_error_if_cancelled (cancellable, error))
 270             goto err_out;
 271
 272 #ifdef HAVE_LINK
 273           /* create original -> backup link, the original is then renamed over */
 274           if (g_unlink (file->priv->backup_filename) != 0 &&
 275               errno != ENOENT)
 276             {
 277               int errsv = errno;
 278
 279               g_set_error (error, G_IO_ERROR,
 280                            G_IO_ERROR_CANT_CREATE_BACKUP,
 281                            _("Error removing old backup link: %s"),
 282                            g_strerror (errsv));
 283               goto err_out;
 284             }
 285
 286           if (link (file->priv->original_filename, file->priv->backup_filename) != 0)
 287             {
 288               /*  link failed or is not supported, try rename  */
 289               if (g_rename (file->priv->original_filename, file->priv->backup_filename) != 0)
 290                 {
 291                   int errsv = errno;
 292
 293                   g_set_error (error, G_IO_ERROR,
 294                                G_IO_ERROR_CANT_CREATE_BACKUP,
 295                                _("Error creating backup copy: %s"),
 296                                g_strerror (errsv));
 297                   goto err_out;
 298                 }
 299             }
 300 #else
 301             /* If link not supported, just rename... */
 302           if (g_rename (file->priv->original_filename, file->priv->backup_filename) != 0)
 303             {
 304               int errsv = errno;
 305
 306               g_set_error (error, G_IO_ERROR,
 307                            G_IO_ERROR_CANT_CREATE_BACKUP,
 308                            _("Error creating backup copy: %s"),
 309                            g_strerror (errsv));
 310               goto err_out;
 311             }
 312 #endif
 313         }
 314
 315
 316       if (g_cancellable_set_error_if_cancelled (cancellable, error))
 317         goto err_out;
 318
 319       /* tmp -> original */
 320       if (g_rename (file->priv->tmp_filename, file->priv->original_filename) != 0)
 321         {
 322           int errsv = errno;
 323
 324           g_set_error (error, G_IO_ERROR,
 325                        g_io_error_from_errno (errsv),
 326                        _("Error renaming temporary file: %s"),
 327                        g_strerror (errsv));
 328           goto err_out;
 329         }
 330
 331       g_clear_pointer (&file->priv->tmp_filename, g_free);
 332     }
 333
 334   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 335     goto err_out;
 336
 337 #ifndef G_OS_WIN32              /* Already did the fstat() and close() above on Win32 */
 338
 339   if (fstat (file->priv->fd, &final_stat) == 0)
 340     file->priv->etag = _g_local_file_info_create_etag (&final_stat);
 341
 342   if (!g_close (file->priv->fd, NULL))
 343     {
 344       int errsv = errno;
 345
 346       g_set_error (error, G_IO_ERROR,
 347                    g_io_error_from_errno (errsv),
 348                    _("Error closing file: %s"),
 349                    g_strerror (errsv));
 350       goto err_out;
 351     }
 352
 353 #endif
 354
 355   return TRUE;
 356  err_out:
 357
 358 #ifndef G_OS_WIN32
 359   /* A simple try to close the fd in case we fail before the actual close */
 360   (void) g_close (file->priv->fd, NULL);
 361 #endif
 362   if (file->priv->tmp_filename)
 363     g_unlink (file->priv->tmp_filename);
 364
 365   return FALSE;
 366 }
 367
 368
 369 static gboolean
 370 g_local_file_output_stream_close (GOutputStream  *stream,
 371                                   GCancellable   *cancellable,
 372                                   GError        **error)
 373 {
 374   GLocalFileOutputStream *file;
 375
 376   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 377
 378   if (file->priv->do_close)
 379     return _g_local_file_output_stream_really_close (file,
 380                                                      cancellable,
 381                                                      error);
 382   return TRUE;
 383 }
 384
 385 static char *
 386 g_local_file_output_stream_get_etag (GFileOutputStream *stream)
 387 {
 388   GLocalFileOutputStream *file;
 389
 390   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 391
 392   return g_strdup (file->priv->etag);
 393 }
 394
 395 static goffset
 396 g_local_file_output_stream_tell (GFileOutputStream *stream)
 397 {
 398   GLocalFileOutputStream *file;
 399   off_t pos;
 400
 401   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 402
 403   pos = lseek (file->priv->fd, 0, SEEK_CUR);
 404
 405   if (pos == (off_t)-1)
 406     return 0;
 407
 408   return pos;
 409 }
 410
 411 static gboolean
 412 g_local_file_output_stream_can_seek (GFileOutputStream *stream)
 413 {
 414   GLocalFileOutputStream *file;
 415   off_t pos;
 416
 417   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 418
 419   pos = lseek (file->priv->fd, 0, SEEK_CUR);
 420
 421   if (pos == (off_t)-1 && errno == ESPIPE)
 422     return FALSE;
 423
 424   return TRUE;
 425 }
 426
 427 static int
 428 seek_type_to_lseek (GSeekType type)
 429 {
 430   switch (type)
 431     {
 432     default:
 433     case G_SEEK_CUR:
 434       return SEEK_CUR;
 435
 436     case G_SEEK_SET:
 437       return SEEK_SET;
 438
 439     case G_SEEK_END:
 440       return SEEK_END;
 441     }
 442 }
 443
 444 static gboolean
 445 g_local_file_output_stream_seek (GFileOutputStream  *stream,
 446                                  goffset             offset,
 447                                  GSeekType           type,
 448                                  GCancellable       *cancellable,
 449                                  GError            **error)
 450 {
 451   GLocalFileOutputStream *file;
 452   off_t pos;
 453
 454   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 455
 456   pos = lseek (file->priv->fd, offset, seek_type_to_lseek (type));
 457
 458   if (pos == (off_t)-1)
 459     {
 460       int errsv = errno;
 461
 462       g_set_error (error, G_IO_ERROR,
 463                    g_io_error_from_errno (errsv),
 464                    _("Error seeking in file: %s"),
 465                    g_strerror (errsv));
 466       return FALSE;
 467     }
 468
 469   return TRUE;
 470 }
 471
 472 static gboolean
 473 g_local_file_output_stream_can_truncate (GFileOutputStream *stream)
 474 {
 475   /* We can't truncate pipes and stuff where we can't seek */
 476   return g_local_file_output_stream_can_seek (stream);
 477 }
 478
 479 static gboolean
 480 g_local_file_output_stream_truncate (GFileOutputStream  *stream,
 481                                      goffset             size,
 482                                      GCancellable       *cancellable,
 483                                      GError            **error)
 484 {
 485   GLocalFileOutputStream *file;
 486   int res;
 487
 488   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 489
 490  restart:
 491 #ifdef G_OS_WIN32
 492   res = g_win32_ftruncate (file->priv->fd, size);
 493 #else
 494   res = ftruncate (file->priv->fd, size);
 495 #endif
 496
 497   if (res == -1)
 498     {
 499       int errsv = errno;
 500
 501       if (errsv == EINTR)
 502         {
 503           if (g_cancellable_set_error_if_cancelled (cancellable, error))
 504             return FALSE;
 505           goto restart;
 506         }
 507
 508       g_set_error (error, G_IO_ERROR,
 509                    g_io_error_from_errno (errsv),
 510                    _("Error truncating file: %s"),
 511                    g_strerror (errsv));
 512       return FALSE;
 513     }
 514
 515   return TRUE;
 516 }
 517
 518
 519 static GFileInfo *
 520 g_local_file_output_stream_query_info (GFileOutputStream  *stream,
 521                                        const char         *attributes,
 522                                        GCancellable       *cancellable,
 523                                        GError            **error)
 524 {
 525   GLocalFileOutputStream *file;
 526
 527   file = G_LOCAL_FILE_OUTPUT_STREAM (stream);
 528
 529   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 530     return NULL;
 531
 532   return _g_local_file_info_get_from_fd (file->priv->fd,
 533                                          attributes,
 534                                          error);
 535 }
 536
 537 GFileOutputStream *
 538 _g_local_file_output_stream_new (int fd)
 539 {
 540   GLocalFileOutputStream *stream;
 541
 542   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
 543   stream->priv->fd = fd;
 544   return G_FILE_OUTPUT_STREAM (stream);
 545 }
 546
 547 static void
 548 set_error_from_open_errno (const char *filename,
 549                            GError    **error)
 550 {
 551   int errsv = errno;
 552
 553   if (errsv == EINVAL)
 554     /* This must be an invalid filename, on e.g. FAT */
 555     g_set_error_literal (error, G_IO_ERROR,
 556                          G_IO_ERROR_INVALID_FILENAME,
 557                          _("Invalid filename"));
 558   else
 559     {
 560       char *display_name = g_filename_display_name (filename);
 561       g_set_error (error, G_IO_ERROR,
 562                    g_io_error_from_errno (errsv),
 563                    _("Error opening file '%s': %s"),
 564                        display_name, g_strerror (errsv));
 565       g_free (display_name);
 566     }
 567 }
 568
 569 static GFileOutputStream *
 570 output_stream_open (const char    *filename,
 571                     gint           open_flags,
 572                     guint          mode,
 573                     GCancellable  *cancellable,
 574                     GError       **error)
 575 {
 576   GLocalFileOutputStream *stream;
 577   gint fd;
 578
 579   fd = g_open (filename, open_flags, mode);
 580   if (fd == -1)
 581     {
 582       set_error_from_open_errno (filename, error);
 583       return NULL;
 584     }
 585
 586   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
 587   stream->priv->fd = fd;
 588   return G_FILE_OUTPUT_STREAM (stream);
 589 }
 590
 591 GFileOutputStream *
 592 _g_local_file_output_stream_open  (const char        *filename,
 593                                    gboolean          readable,
 594                                    GCancellable      *cancellable,
 595                                    GError           **error)
 596 {
 597   int open_flags;
 598
 599   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 600     return NULL;
 601
 602   open_flags = O_BINARY;
 603   if (readable)
 604     open_flags |= O_RDWR;
 605   else
 606     open_flags |= O_WRONLY;
 607
 608   return output_stream_open (filename, open_flags, 0666, cancellable, error);
 609 }
 610
 611 GFileOutputStream *
 612 _g_local_file_output_stream_create  (const char        *filename,
 613                                      gboolean          readable,
 614                                      GFileCreateFlags   flags,
 615                                      GCancellable      *cancellable,
 616                                      GError           **error)
 617 {
 618   int mode;
 619   int open_flags;
 620
 621   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 622     return NULL;
 623
 624   if (flags & G_FILE_CREATE_PRIVATE)
 625     mode = 0600;
 626   else
 627     mode = 0666;
 628
 629   open_flags = O_CREAT | O_EXCL | O_BINARY;
 630   if (readable)
 631     open_flags |= O_RDWR;
 632   else
 633     open_flags |= O_WRONLY;
 634
 635   return output_stream_open (filename, open_flags, mode, cancellable, error);
 636 }
 637
 638 GFileOutputStream *
 639 _g_local_file_output_stream_append  (const char        *filename,
 640                                      GFileCreateFlags   flags,
 641                                      GCancellable      *cancellable,
 642                                      GError           **error)
 643 {
 644   int mode;
 645
 646   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 647     return NULL;
 648
 649   if (flags & G_FILE_CREATE_PRIVATE)
 650     mode = 0600;
 651   else
 652     mode = 0666;
 653
 654   return output_stream_open (filename, O_CREAT | O_APPEND | O_WRONLY | O_BINARY, mode,
 655                              cancellable, error);
 656 }
 657
 658 static char *
 659 create_backup_filename (const char *filename)
 660 {
 661   return g_strconcat (filename, BACKUP_EXTENSION, NULL);
 662 }
 663
 664 #define BUFSIZE 8192 /* size of normal write buffer */
 665
 666 static gboolean
 667 copy_file_data (gint     sfd,
 668                 gint     dfd,
 669                 GError **error)
 670 {
 671   gboolean ret = TRUE;
 672   gpointer buffer;
 673   const gchar *write_buffer;
 674   gssize bytes_read;
 675   gssize bytes_to_write;
 676   gssize bytes_written;
 677
 678   buffer = g_malloc (BUFSIZE);
 679
 680   do
 681     {
 682       bytes_read = read (sfd, buffer, BUFSIZE);
 683       if (bytes_read == -1)
 684         {
 685           int errsv = errno;
 686
 687           if (errsv == EINTR)
 688             continue;
 689
 690           g_set_error (error, G_IO_ERROR,
 691                        g_io_error_from_errno (errsv),
 692                        _("Error reading from file: %s"),
 693                        g_strerror (errsv));
 694           ret = FALSE;
 695           break;
 696         }
 697
 698       bytes_to_write = bytes_read;
 699       write_buffer = buffer;
 700
 701       do
 702         {
 703           bytes_written = write (dfd, write_buffer, bytes_to_write);
 704           if (bytes_written == -1)
 705             {
 706               int errsv = errno;
 707
 708               if (errsv == EINTR)
 709                 continue;
 710
 711               g_set_error (error, G_IO_ERROR,
 712                            g_io_error_from_errno (errsv),
 713                            _("Error writing to file: %s"),
 714                            g_strerror (errsv));
 715               ret = FALSE;
 716               break;
 717             }
 718
 719           bytes_to_write -= bytes_written;
 720           write_buffer += bytes_written;
 721         }
 722       while (bytes_to_write > 0);
 723
 724     } while ((bytes_read != 0) && (ret == TRUE));
 725
 726   g_free (buffer);
 727
 728   return ret;
 729 }
 730
 731 static int
 732 handle_overwrite_open (const char    *filename,
 733                        gboolean       readable,
 734                        const char    *etag,
 735                        gboolean       create_backup,
 736                        char         **temp_filename,
 737                        GFileCreateFlags flags,
 738                        GCancellable  *cancellable,
 739                        GError       **error)
 740 {
 741   int fd = -1;
 742   GLocalFileStat original_stat;
 743   char *current_etag;
 744   gboolean is_symlink;
 745   int open_flags;
 746   int res;
 747   int mode;
 748
 749   if (flags & G_FILE_CREATE_PRIVATE)
 750     mode = 0600;
 751   else
 752     mode = 0666;
 753
 754   /* We only need read access to the original file if we are creating a backup.
 755    * We also add O_CREATE to avoid a race if the file was just removed */
 756   if (create_backup || readable)
 757     open_flags = O_RDWR | O_CREAT | O_BINARY;
 758   else
 759     open_flags = O_WRONLY | O_CREAT | O_BINARY;
 760
 761   /* Some systems have O_NOFOLLOW, which lets us avoid some races
 762    * when finding out if the file we opened was a symlink */
 763 #ifdef O_NOFOLLOW
 764   is_symlink = FALSE;
 765   fd = g_open (filename, open_flags | O_NOFOLLOW, mode);
 766   if (fd == -1 && errno == ELOOP)
 767     {
 768       /* Could be a symlink, or it could be a regular ELOOP error,
 769        * but then the next open will fail too. */
 770       is_symlink = TRUE;
 771       fd = g_open (filename, open_flags, mode);
 772     }
 773 #else
 774   fd = g_open (filename, open_flags, mode);
 775   /* This is racy, but we do it as soon as possible to minimize the race */
 776   is_symlink = g_file_test (filename, G_FILE_TEST_IS_SYMLINK);
 777 #endif
 778
 779   if (fd == -1)
 780     {
 781       int errsv = errno;
 782       char *display_name = g_filename_display_name (filename);
 783       g_set_error (error, G_IO_ERROR,
 784                    g_io_error_from_errno (errsv),
 785                    _("Error opening file '%s': %s"),
 786                    display_name, g_strerror (errsv));
 787       g_free (display_name);
 788       return -1;
 789     }
 790
 791 #ifdef G_OS_WIN32
 792   res = _fstati64 (fd, &original_stat);
 793 #else
 794   res = fstat (fd, &original_stat);
 795 #endif
 796
 797   if (res != 0)
 798     {
 799       int errsv = errno;
 800       char *display_name = g_filename_display_name (filename);
 801       g_set_error (error, G_IO_ERROR,
 802                    g_io_error_from_errno (errsv),
 803                    _("Error when getting information for file '%s': %s"),
 804                    display_name, g_strerror (errsv));
 805       g_free (display_name);
 806       goto err_out;
 807     }
 808
 809   /* not a regular file */
 810   if (!S_ISREG (original_stat.st_mode))
 811     {
 812       if (S_ISDIR (original_stat.st_mode))
 813         g_set_error_literal (error,
 814                              G_IO_ERROR,
 815                              G_IO_ERROR_IS_DIRECTORY,
 816                              _("Target file is a directory"));
 817       else
 818         g_set_error_literal (error,
 819                              G_IO_ERROR,
 820                              G_IO_ERROR_NOT_REGULAR_FILE,
 821                              _("Target file is not a regular file"));
 822       goto err_out;
 823     }
 824
 825   if (etag != NULL)
 826     {
 827       current_etag = _g_local_file_info_create_etag (&original_stat);
 828       if (strcmp (etag, current_etag) != 0)
 829         {
 830           g_set_error_literal (error,
 831                                G_IO_ERROR,
 832                                G_IO_ERROR_WRONG_ETAG,
 833                                _("The file was externally modified"));
 834           g_free (current_etag);
 835           goto err_out;
 836         }
 837       g_free (current_etag);
 838     }
 839
 840   /* We use two backup strategies.
 841    * The first one (which is faster) consist in saving to a
 842    * tmp file then rename the original file to the backup and the
 843    * tmp file to the original name. This is fast but doesn't work
 844    * when the file is a link (hard or symbolic) or when we can't
 845    * write to the current dir or can't set the permissions on the
 846    * new file.
 847    * The second strategy consist simply in copying the old file
 848    * to a backup file and rewrite the contents of the file.
 849    */
 850
 851   if ((flags & G_FILE_CREATE_REPLACE_DESTINATION) ||
 852       (!(original_stat.st_nlink > 1) && !is_symlink))
 853     {
 854       char *dirname, *tmp_filename;
 855       int tmpfd;
 856
 857       dirname = g_path_get_dirname (filename);
 858       tmp_filename = g_build_filename (dirname, ".goutputstream-XXXXXX", NULL);
 859       g_free (dirname);
 860
 861       tmpfd = g_mkstemp_full (tmp_filename, (readable ? O_RDWR : O_WRONLY) | O_BINARY, mode);
 862       if (tmpfd == -1)
 863         {
 864           g_free (tmp_filename);
 865           goto fallback_strategy;
 866         }
 867
 868       /* try to keep permissions (unless replacing) */
 869
 870       if ( ! (flags & G_FILE_CREATE_REPLACE_DESTINATION) &&
 871            (
 872 #ifdef HAVE_FCHOWN
 873             fchown (tmpfd, original_stat.st_uid, original_stat.st_gid) == -1 ||
 874 #endif
 875 #ifdef HAVE_FCHMOD
 876             fchmod (tmpfd, original_stat.st_mode) == -1 ||
 877 #endif
 878             0
 879             )
 880           )
 881         {
 882           GLocalFileStat tmp_statbuf;
 883           int tres;
 884
 885 #ifdef G_OS_WIN32
 886           tres = _fstati64 (tmpfd, &tmp_statbuf);
 887 #else
 888           tres = fstat (tmpfd, &tmp_statbuf);
 889 #endif
 890           /* Check that we really needed to change something */
 891           if (tres != 0 ||
 892               original_stat.st_uid != tmp_statbuf.st_uid ||
 893               original_stat.st_gid != tmp_statbuf.st_gid ||
 894               original_stat.st_mode != tmp_statbuf.st_mode)
 895             {
 896               (void) g_close (tmpfd, NULL);
 897               g_unlink (tmp_filename);
 898               g_free (tmp_filename);
 899               goto fallback_strategy;
 900             }
 901         }
 902
 903       (void) g_close (fd, NULL);
 904       *temp_filename = tmp_filename;
 905       return tmpfd;
 906     }
 907
 908  fallback_strategy:
 909
 910   if (create_backup)
 911     {
 912 #if defined(HAVE_FCHOWN) && defined(HAVE_FCHMOD)
 913       struct stat tmp_statbuf;
 914 #endif
 915       char *backup_filename;
 916       int bfd;
 917
 918       backup_filename = create_backup_filename (filename);
 919
 920       if (g_unlink (backup_filename) == -1 && errno != ENOENT)
 921         {
 922           g_set_error_literal (error,
 923                                G_IO_ERROR,
 924                                G_IO_ERROR_CANT_CREATE_BACKUP,
 925                                _("Backup file creation failed"));
 926           g_free (backup_filename);
 927           goto err_out;
 928         }
 929
 930       bfd = g_open (backup_filename,
 931                     O_WRONLY | O_CREAT | O_EXCL | O_BINARY,
 932                     original_stat.st_mode & 0777);
 933
 934       if (bfd == -1)
 935         {
 936           g_set_error_literal (error,
 937                                G_IO_ERROR,
 938                                G_IO_ERROR_CANT_CREATE_BACKUP,
 939                                _("Backup file creation failed"));
 940           g_free (backup_filename);
 941           goto err_out;
 942         }
 943
 944       /* If needed, Try to set the group of the backup same as the
 945        * original file. If this fails, set the protection
 946        * bits for the group same as the protection bits for
 947        * others. */
 948 #if defined(HAVE_FCHOWN) && defined(HAVE_FCHMOD)
 949       if (fstat (bfd, &tmp_statbuf) != 0)
 950         {
 951           g_set_error_literal (error,
 952                                G_IO_ERROR,
 953                                G_IO_ERROR_CANT_CREATE_BACKUP,
 954                                _("Backup file creation failed"));
 955           g_unlink (backup_filename);
 956           g_free (backup_filename);
 957           goto err_out;
 958         }
 959
 960       if ((original_stat.st_gid != tmp_statbuf.st_gid)  &&
 961           fchown (bfd, (uid_t) -1, original_stat.st_gid) != 0)
 962         {
 963           if (fchmod (bfd,
 964                       (original_stat.st_mode & 0707) |
 965                       ((original_stat.st_mode & 07) << 3)) != 0)
 966             {
 967               g_set_error_literal (error,
 968                                    G_IO_ERROR,
 969                                    G_IO_ERROR_CANT_CREATE_BACKUP,
 970                                    _("Backup file creation failed"));
 971               g_unlink (backup_filename);
 972               (void) g_close (bfd, NULL);
 973               g_free (backup_filename);
 974               goto err_out;
 975             }
 976         }
 977 #endif
 978
 979       if (!copy_file_data (fd, bfd, NULL))
 980         {
 981           g_set_error_literal (error,
 982                                G_IO_ERROR,
 983                                G_IO_ERROR_CANT_CREATE_BACKUP,
 984                                _("Backup file creation failed"));
 985           g_unlink (backup_filename);
 986           (void) g_close (bfd, NULL);
 987           g_free (backup_filename);
 988
 989           goto err_out;
 990         }
 991
 992       (void) g_close (bfd, NULL);
 993       g_free (backup_filename);
 994
 995       /* Seek back to the start of the file after the backup copy */
 996       if (lseek (fd, 0, SEEK_SET) == -1)
 997         {
 998           int errsv = errno;
 999
1000           g_set_error (error, G_IO_ERROR,
1001                        g_io_error_from_errno (errsv),
1002                        _("Error seeking in file: %s"),
1003                        g_strerror (errsv));
1004           goto err_out;
1005         }
1006     }
1007
1008   if (flags & G_FILE_CREATE_REPLACE_DESTINATION)
1009     {
1010       (void) g_close (fd, NULL);
1011
1012       if (g_unlink (filename) != 0)
1013         {
1014           int errsv = errno;
1015
1016           g_set_error (error, G_IO_ERROR,
1017                        g_io_error_from_errno (errsv),
1018                        _("Error removing old file: %s"),
1019                        g_strerror (errsv));
1020           goto err_out2;
1021         }
1022
1023       if (readable)
1024         open_flags = O_RDWR | O_CREAT | O_BINARY;
1025       else
1026         open_flags = O_WRONLY | O_CREAT | O_BINARY;
1027       fd = g_open (filename, open_flags, mode);
1028       if (fd == -1)
1029         {
1030           int errsv = errno;
1031           char *display_name = g_filename_display_name (filename);
1032           g_set_error (error, G_IO_ERROR,
1033                        g_io_error_from_errno (errsv),
1034                        _("Error opening file '%s': %s"),
1035                        display_name, g_strerror (errsv));
1036           g_free (display_name);
1037           goto err_out2;
1038         }
1039     }
1040   else
1041     {
1042       /* Truncate the file at the start */
1043 #ifdef G_OS_WIN32
1044       if (g_win32_ftruncate (fd, 0) == -1)
1045 #else
1046         if (ftruncate (fd, 0) == -1)
1047 #endif
1048           {
1049             int errsv = errno;
1050
1051             g_set_error (error, G_IO_ERROR,
1052                          g_io_error_from_errno (errsv),
1053                          _("Error truncating file: %s"),
1054                          g_strerror (errsv));
1055             goto err_out;
1056           }
1057     }
1058
1059   return fd;
1060
1061  err_out:
1062   (void) g_close (fd, NULL);
1063  err_out2:
1064   return -1;
1065 }
1066
1067 GFileOutputStream *
1068 _g_local_file_output_stream_replace (const char        *filename,
1069                                      gboolean          readable,
1070                                      const char        *etag,
1071                                      gboolean           create_backup,
1072                                      GFileCreateFlags   flags,
1073                                      GCancellable      *cancellable,
1074                                      GError           **error)
1075 {
1076   GLocalFileOutputStream *stream;
1077   int mode;
1078   int fd;
1079   char *temp_file;
1080   gboolean sync_on_close;
1081   int open_flags;
1082
1083   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1084     return NULL;
1085
1086   temp_file = NULL;
1087
1088   if (flags & G_FILE_CREATE_PRIVATE)
1089     mode = 0600;
1090   else
1091     mode = 0666;
1092   sync_on_close = FALSE;
1093
1094   /* If the file doesn't exist, create it */
1095   open_flags = O_CREAT | O_EXCL | O_BINARY;
1096   if (readable)
1097     open_flags |= O_RDWR;
1098   else
1099     open_flags |= O_WRONLY;
1100   fd = g_open (filename, open_flags, mode);
1101
1102   if (fd == -1 && errno == EEXIST)
1103     {
1104       /* The file already exists */
1105       fd = handle_overwrite_open (filename, readable, etag,
1106                                   create_backup, &temp_file,
1107                                   flags, cancellable, error);
1108       if (fd == -1)
1109         return NULL;
1110
1111       /* If the final destination exists, we want to sync the newly written
1112        * file to ensure the data is on disk when we rename over the destination.
1113        * otherwise if we get a system crash we can lose both the new and the
1114        * old file on some filesystems. (I.E. those that don't guarantee the
1115        * data is written to the disk before the metadata.)
1116        */
1117       sync_on_close = TRUE;
1118     }
1119   else if (fd == -1)
1120     {
1121       set_error_from_open_errno (filename, error);
1122       return NULL;
1123     }
1124
1125
1126   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
1127   stream->priv->fd = fd;
1128   stream->priv->sync_on_close = sync_on_close;
1129   stream->priv->tmp_filename = temp_file;
1130   if (create_backup)
1131     stream->priv->backup_filename = create_backup_filename (filename);
1132   stream->priv->original_filename =  g_strdup (filename);
1133
1134   return G_FILE_OUTPUT_STREAM (stream);
1135 }
1136
1137 gint
1138 _g_local_file_output_stream_get_fd (GLocalFileOutputStream *stream)
1139 {
1140   g_return_val_if_fail (G_IS_LOCAL_FILE_OUTPUT_STREAM (stream), -1);
1141   return stream->priv->fd;
1142 }
1143
1144 #ifdef G_OS_UNIX
1145 static int
1146 g_local_file_output_stream_get_fd (GFileDescriptorBased *fd_based)
1147 {
1148   GLocalFileOutputStream *stream = G_LOCAL_FILE_OUTPUT_STREAM (fd_based);
1149   return _g_local_file_output_stream_get_fd (stream);
1150 }
1151 #endif