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 GFileOutputStream *
 548 _g_local_file_output_stream_open  (const char        *filename,
 549                                    gboolean          readable,
 550                                    GCancellable      *cancellable,
 551                                    GError           **error)
 552 {
 553   GLocalFileOutputStream *stream;
 554   int fd;
 555   int open_flags;
 556
 557   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 558     return NULL;
 559
 560   open_flags = O_BINARY;
 561   if (readable)
 562     open_flags |= O_RDWR;
 563   else
 564     open_flags |= O_WRONLY;
 565
 566   fd = g_open (filename, open_flags, 0666);
 567   if (fd == -1)
 568     {
 569       int errsv = errno;
 570
 571       if (errsv == EINVAL)
 572         /* This must be an invalid filename, on e.g. FAT */
 573         g_set_error_literal (error, G_IO_ERROR,
 574                              G_IO_ERROR_INVALID_FILENAME,
 575                              _("Invalid filename"));
 576       else
 577         {
 578           char *display_name = g_filename_display_name (filename);
 579           g_set_error (error, G_IO_ERROR,
 580                        g_io_error_from_errno (errsv),
 581                        _("Error opening file '%s': %s"),
 582                        display_name, g_strerror (errsv));
 583           g_free (display_name);
 584         }
 585       return NULL;
 586     }
 587
 588   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
 589   stream->priv->fd = fd;
 590   return G_FILE_OUTPUT_STREAM (stream);
 591 }
 592
 593 GFileOutputStream *
 594 _g_local_file_output_stream_create  (const char        *filename,
 595                                      gboolean          readable,
 596                                      GFileCreateFlags   flags,
 597                                      GCancellable      *cancellable,
 598                                      GError           **error)
 599 {
 600   GLocalFileOutputStream *stream;
 601   int mode;
 602   int fd;
 603   int open_flags;
 604
 605   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 606     return NULL;
 607
 608   if (flags & G_FILE_CREATE_PRIVATE)
 609     mode = 0600;
 610   else
 611     mode = 0666;
 612
 613   open_flags = O_CREAT | O_EXCL | O_BINARY;
 614   if (readable)
 615     open_flags |= O_RDWR;
 616   else
 617     open_flags |= O_WRONLY;
 618
 619   fd = g_open (filename, open_flags, mode);
 620   if (fd == -1)
 621     {
 622       int errsv = errno;
 623
 624       if (errsv == EINVAL)
 625         /* This must be an invalid filename, on e.g. FAT */
 626         g_set_error_literal (error, G_IO_ERROR,
 627                              G_IO_ERROR_INVALID_FILENAME,
 628                              _("Invalid filename"));
 629       else
 630         {
 631           char *display_name = g_filename_display_name (filename);
 632           g_set_error (error, G_IO_ERROR,
 633                        g_io_error_from_errno (errsv),
 634                        _("Error opening file '%s': %s"),
 635                        display_name, g_strerror (errsv));
 636           g_free (display_name);
 637         }
 638       return NULL;
 639     }
 640
 641   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
 642   stream->priv->fd = fd;
 643   return G_FILE_OUTPUT_STREAM (stream);
 644 }
 645
 646 GFileOutputStream *
 647 _g_local_file_output_stream_append  (const char        *filename,
 648                                      GFileCreateFlags   flags,
 649                                      GCancellable      *cancellable,
 650                                      GError           **error)
 651 {
 652   GLocalFileOutputStream *stream;
 653   int mode;
 654   int fd;
 655
 656   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 657     return NULL;
 658
 659   if (flags & G_FILE_CREATE_PRIVATE)
 660     mode = 0600;
 661   else
 662     mode = 0666;
 663
 664   fd = g_open (filename, O_CREAT | O_APPEND | O_WRONLY | O_BINARY, mode);
 665   if (fd == -1)
 666     {
 667       int errsv = errno;
 668
 669       if (errsv == EINVAL)
 670         /* This must be an invalid filename, on e.g. FAT */
 671         g_set_error_literal (error, G_IO_ERROR,
 672                              G_IO_ERROR_INVALID_FILENAME,
 673                              _("Invalid filename"));
 674       else
 675         {
 676           char *display_name = g_filename_display_name (filename);
 677           g_set_error (error, G_IO_ERROR,
 678                        g_io_error_from_errno (errsv),
 679                        _("Error opening file '%s': %s"),
 680                        display_name, g_strerror (errsv));
 681           g_free (display_name);
 682         }
 683       return NULL;
 684     }
 685
 686   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
 687   stream->priv->fd = fd;
 688
 689   return G_FILE_OUTPUT_STREAM (stream);
 690 }
 691
 692 static char *
 693 create_backup_filename (const char *filename)
 694 {
 695   return g_strconcat (filename, BACKUP_EXTENSION, NULL);
 696 }
 697
 698 #define BUFSIZE 8192 /* size of normal write buffer */
 699
 700 static gboolean
 701 copy_file_data (gint     sfd,
 702                 gint     dfd,
 703                 GError **error)
 704 {
 705   gboolean ret = TRUE;
 706   gpointer buffer;
 707   const gchar *write_buffer;
 708   gssize bytes_read;
 709   gssize bytes_to_write;
 710   gssize bytes_written;
 711
 712   buffer = g_malloc (BUFSIZE);
 713
 714   do
 715     {
 716       bytes_read = read (sfd, buffer, BUFSIZE);
 717       if (bytes_read == -1)
 718         {
 719           int errsv = errno;
 720
 721           if (errsv == EINTR)
 722             continue;
 723
 724           g_set_error (error, G_IO_ERROR,
 725                        g_io_error_from_errno (errsv),
 726                        _("Error reading from file: %s"),
 727                        g_strerror (errsv));
 728           ret = FALSE;
 729           break;
 730         }
 731
 732       bytes_to_write = bytes_read;
 733       write_buffer = buffer;
 734
 735       do
 736         {
 737           bytes_written = write (dfd, write_buffer, bytes_to_write);
 738           if (bytes_written == -1)
 739             {
 740               int errsv = errno;
 741
 742               if (errsv == EINTR)
 743                 continue;
 744
 745               g_set_error (error, G_IO_ERROR,
 746                            g_io_error_from_errno (errsv),
 747                            _("Error writing to file: %s"),
 748                            g_strerror (errsv));
 749               ret = FALSE;
 750               break;
 751             }
 752
 753           bytes_to_write -= bytes_written;
 754           write_buffer += bytes_written;
 755         }
 756       while (bytes_to_write > 0);
 757
 758     } while ((bytes_read != 0) && (ret == TRUE));
 759
 760   g_free (buffer);
 761
 762   return ret;
 763 }
 764
 765 static int
 766 handle_overwrite_open (const char    *filename,
 767                        gboolean       readable,
 768                        const char    *etag,
 769                        gboolean       create_backup,
 770                        char         **temp_filename,
 771                        GFileCreateFlags flags,
 772                        GCancellable  *cancellable,
 773                        GError       **error)
 774 {
 775   int fd = -1;
 776   GLocalFileStat original_stat;
 777   char *current_etag;
 778   gboolean is_symlink;
 779   int open_flags;
 780   int res;
 781   int mode;
 782
 783   if (flags & G_FILE_CREATE_PRIVATE)
 784     mode = 0600;
 785   else
 786     mode = 0666;
 787
 788   /* We only need read access to the original file if we are creating a backup.
 789    * We also add O_CREATE to avoid a race if the file was just removed */
 790   if (create_backup || readable)
 791     open_flags = O_RDWR | O_CREAT | O_BINARY;
 792   else
 793     open_flags = O_WRONLY | O_CREAT | O_BINARY;
 794
 795   /* Some systems have O_NOFOLLOW, which lets us avoid some races
 796    * when finding out if the file we opened was a symlink */
 797 #ifdef O_NOFOLLOW
 798   is_symlink = FALSE;
 799   fd = g_open (filename, open_flags | O_NOFOLLOW, mode);
 800   if (fd == -1 && errno == ELOOP)
 801     {
 802       /* Could be a symlink, or it could be a regular ELOOP error,
 803        * but then the next open will fail too. */
 804       is_symlink = TRUE;
 805       fd = g_open (filename, open_flags, mode);
 806     }
 807 #else
 808   fd = g_open (filename, open_flags, mode);
 809   /* This is racy, but we do it as soon as possible to minimize the race */
 810   is_symlink = g_file_test (filename, G_FILE_TEST_IS_SYMLINK);
 811 #endif
 812
 813   if (fd == -1)
 814     {
 815       int errsv = errno;
 816       char *display_name = g_filename_display_name (filename);
 817       g_set_error (error, G_IO_ERROR,
 818                    g_io_error_from_errno (errsv),
 819                    _("Error opening file '%s': %s"),
 820                    display_name, g_strerror (errsv));
 821       g_free (display_name);
 822       return -1;
 823     }
 824
 825 #ifdef G_OS_WIN32
 826   res = _fstati64 (fd, &original_stat);
 827 #else
 828   res = fstat (fd, &original_stat);
 829 #endif
 830
 831   if (res != 0)
 832     {
 833       int errsv = errno;
 834       char *display_name = g_filename_display_name (filename);
 835       g_set_error (error, G_IO_ERROR,
 836                    g_io_error_from_errno (errsv),
 837                    _("Error when getting information for file '%s': %s"),
 838                    display_name, g_strerror (errsv));
 839       g_free (display_name);
 840       goto err_out;
 841     }
 842
 843   /* not a regular file */
 844   if (!S_ISREG (original_stat.st_mode))
 845     {
 846       if (S_ISDIR (original_stat.st_mode))
 847         g_set_error_literal (error,
 848                              G_IO_ERROR,
 849                              G_IO_ERROR_IS_DIRECTORY,
 850                              _("Target file is a directory"));
 851       else
 852         g_set_error_literal (error,
 853                              G_IO_ERROR,
 854                              G_IO_ERROR_NOT_REGULAR_FILE,
 855                              _("Target file is not a regular file"));
 856       goto err_out;
 857     }
 858
 859   if (etag != NULL)
 860     {
 861       current_etag = _g_local_file_info_create_etag (&original_stat);
 862       if (strcmp (etag, current_etag) != 0)
 863         {
 864           g_set_error_literal (error,
 865                                G_IO_ERROR,
 866                                G_IO_ERROR_WRONG_ETAG,
 867                                _("The file was externally modified"));
 868           g_free (current_etag);
 869           goto err_out;
 870         }
 871       g_free (current_etag);
 872     }
 873
 874   /* We use two backup strategies.
 875    * The first one (which is faster) consist in saving to a
 876    * tmp file then rename the original file to the backup and the
 877    * tmp file to the original name. This is fast but doesn't work
 878    * when the file is a link (hard or symbolic) or when we can't
 879    * write to the current dir or can't set the permissions on the
 880    * new file.
 881    * The second strategy consist simply in copying the old file
 882    * to a backup file and rewrite the contents of the file.
 883    */
 884
 885   if ((flags & G_FILE_CREATE_REPLACE_DESTINATION) ||
 886       (!(original_stat.st_nlink > 1) && !is_symlink))
 887     {
 888       char *dirname, *tmp_filename;
 889       int tmpfd;
 890
 891       dirname = g_path_get_dirname (filename);
 892       tmp_filename = g_build_filename (dirname, ".goutputstream-XXXXXX", NULL);
 893       g_free (dirname);
 894
 895       tmpfd = g_mkstemp_full (tmp_filename, (readable ? O_RDWR : O_WRONLY) | O_BINARY, mode);
 896       if (tmpfd == -1)
 897         {
 898           g_free (tmp_filename);
 899           goto fallback_strategy;
 900         }
 901
 902       /* try to keep permissions (unless replacing) */
 903
 904       if ( ! (flags & G_FILE_CREATE_REPLACE_DESTINATION) &&
 905            (
 906 #ifdef HAVE_FCHOWN
 907             fchown (tmpfd, original_stat.st_uid, original_stat.st_gid) == -1 ||
 908 #endif
 909 #ifdef HAVE_FCHMOD
 910             fchmod (tmpfd, original_stat.st_mode) == -1 ||
 911 #endif
 912             0
 913             )
 914           )
 915         {
 916           GLocalFileStat tmp_statbuf;
 917           int tres;
 918
 919 #ifdef G_OS_WIN32
 920           tres = _fstati64 (tmpfd, &tmp_statbuf);
 921 #else
 922           tres = fstat (tmpfd, &tmp_statbuf);
 923 #endif
 924           /* Check that we really needed to change something */
 925           if (tres != 0 ||
 926               original_stat.st_uid != tmp_statbuf.st_uid ||
 927               original_stat.st_gid != tmp_statbuf.st_gid ||
 928               original_stat.st_mode != tmp_statbuf.st_mode)
 929             {
 930               (void) g_close (tmpfd, NULL);
 931               g_unlink (tmp_filename);
 932               g_free (tmp_filename);
 933               goto fallback_strategy;
 934             }
 935         }
 936
 937       (void) g_close (fd, NULL);
 938       *temp_filename = tmp_filename;
 939       return tmpfd;
 940     }
 941
 942  fallback_strategy:
 943
 944   if (create_backup)
 945     {
 946 #if defined(HAVE_FCHOWN) && defined(HAVE_FCHMOD)
 947       struct stat tmp_statbuf;
 948 #endif
 949       char *backup_filename;
 950       int bfd;
 951
 952       backup_filename = create_backup_filename (filename);
 953
 954       if (g_unlink (backup_filename) == -1 && errno != ENOENT)
 955         {
 956           g_set_error_literal (error,
 957                                G_IO_ERROR,
 958                                G_IO_ERROR_CANT_CREATE_BACKUP,
 959                                _("Backup file creation failed"));
 960           g_free (backup_filename);
 961           goto err_out;
 962         }
 963
 964       bfd = g_open (backup_filename,
 965                     O_WRONLY | O_CREAT | O_EXCL | O_BINARY,
 966                     original_stat.st_mode & 0777);
 967
 968       if (bfd == -1)
 969         {
 970           g_set_error_literal (error,
 971                                G_IO_ERROR,
 972                                G_IO_ERROR_CANT_CREATE_BACKUP,
 973                                _("Backup file creation failed"));
 974           g_free (backup_filename);
 975           goto err_out;
 976         }
 977
 978       /* If needed, Try to set the group of the backup same as the
 979        * original file. If this fails, set the protection
 980        * bits for the group same as the protection bits for
 981        * others. */
 982 #if defined(HAVE_FCHOWN) && defined(HAVE_FCHMOD)
 983       if (fstat (bfd, &tmp_statbuf) != 0)
 984         {
 985           g_set_error_literal (error,
 986                                G_IO_ERROR,
 987                                G_IO_ERROR_CANT_CREATE_BACKUP,
 988                                _("Backup file creation failed"));
 989           g_unlink (backup_filename);
 990           g_free (backup_filename);
 991           goto err_out;
 992         }
 993
 994       if ((original_stat.st_gid != tmp_statbuf.st_gid)  &&
 995           fchown (bfd, (uid_t) -1, original_stat.st_gid) != 0)
 996         {
 997           if (fchmod (bfd,
 998                       (original_stat.st_mode & 0707) |
 999                       ((original_stat.st_mode & 07) << 3)) != 0)
1000             {
1001               g_set_error_literal (error,
1002                                    G_IO_ERROR,
1003                                    G_IO_ERROR_CANT_CREATE_BACKUP,
1004                                    _("Backup file creation failed"));
1005               g_unlink (backup_filename);
1006               (void) g_close (bfd, NULL);
1007               g_free (backup_filename);
1008               goto err_out;
1009             }
1010         }
1011 #endif
1012
1013       if (!copy_file_data (fd, bfd, NULL))
1014         {
1015           g_set_error_literal (error,
1016                                G_IO_ERROR,
1017                                G_IO_ERROR_CANT_CREATE_BACKUP,
1018                                _("Backup file creation failed"));
1019           g_unlink (backup_filename);
1020           (void) g_close (bfd, NULL);
1021           g_free (backup_filename);
1022
1023           goto err_out;
1024         }
1025
1026       (void) g_close (bfd, NULL);
1027       g_free (backup_filename);
1028
1029       /* Seek back to the start of the file after the backup copy */
1030       if (lseek (fd, 0, SEEK_SET) == -1)
1031         {
1032           int errsv = errno;
1033
1034           g_set_error (error, G_IO_ERROR,
1035                        g_io_error_from_errno (errsv),
1036                        _("Error seeking in file: %s"),
1037                        g_strerror (errsv));
1038           goto err_out;
1039         }
1040     }
1041
1042   if (flags & G_FILE_CREATE_REPLACE_DESTINATION)
1043     {
1044       (void) g_close (fd, NULL);
1045
1046       if (g_unlink (filename) != 0)
1047         {
1048           int errsv = errno;
1049
1050           g_set_error (error, G_IO_ERROR,
1051                        g_io_error_from_errno (errsv),
1052                        _("Error removing old file: %s"),
1053                        g_strerror (errsv));
1054           goto err_out2;
1055         }
1056
1057       if (readable)
1058         open_flags = O_RDWR | O_CREAT | O_BINARY;
1059       else
1060         open_flags = O_WRONLY | O_CREAT | O_BINARY;
1061       fd = g_open (filename, open_flags, mode);
1062       if (fd == -1)
1063         {
1064           int errsv = errno;
1065           char *display_name = g_filename_display_name (filename);
1066           g_set_error (error, G_IO_ERROR,
1067                        g_io_error_from_errno (errsv),
1068                        _("Error opening file '%s': %s"),
1069                        display_name, g_strerror (errsv));
1070           g_free (display_name);
1071           goto err_out2;
1072         }
1073     }
1074   else
1075     {
1076       /* Truncate the file at the start */
1077 #ifdef G_OS_WIN32
1078       if (g_win32_ftruncate (fd, 0) == -1)
1079 #else
1080         if (ftruncate (fd, 0) == -1)
1081 #endif
1082           {
1083             int errsv = errno;
1084
1085             g_set_error (error, G_IO_ERROR,
1086                          g_io_error_from_errno (errsv),
1087                          _("Error truncating file: %s"),
1088                          g_strerror (errsv));
1089             goto err_out;
1090           }
1091     }
1092
1093   return fd;
1094
1095  err_out:
1096   (void) g_close (fd, NULL);
1097  err_out2:
1098   return -1;
1099 }
1100
1101 GFileOutputStream *
1102 _g_local_file_output_stream_replace (const char        *filename,
1103                                      gboolean          readable,
1104                                      const char        *etag,
1105                                      gboolean           create_backup,
1106                                      GFileCreateFlags   flags,
1107                                      GCancellable      *cancellable,
1108                                      GError           **error)
1109 {
1110   GLocalFileOutputStream *stream;
1111   int mode;
1112   int fd;
1113   char *temp_file;
1114   gboolean sync_on_close;
1115   int open_flags;
1116
1117   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1118     return NULL;
1119
1120   temp_file = NULL;
1121
1122   if (flags & G_FILE_CREATE_PRIVATE)
1123     mode = 0600;
1124   else
1125     mode = 0666;
1126   sync_on_close = FALSE;
1127
1128   /* If the file doesn't exist, create it */
1129   open_flags = O_CREAT | O_EXCL | O_BINARY;
1130   if (readable)
1131     open_flags |= O_RDWR;
1132   else
1133     open_flags |= O_WRONLY;
1134   fd = g_open (filename, open_flags, mode);
1135
1136   if (fd == -1 && errno == EEXIST)
1137     {
1138       /* The file already exists */
1139       fd = handle_overwrite_open (filename, readable, etag,
1140                                   create_backup, &temp_file,
1141                                   flags, cancellable, error);
1142       if (fd == -1)
1143         return NULL;
1144
1145       /* If the final destination exists, we want to sync the newly written
1146        * file to ensure the data is on disk when we rename over the destination.
1147        * otherwise if we get a system crash we can lose both the new and the
1148        * old file on some filesystems. (I.E. those that don't guarantee the
1149        * data is written to the disk before the metadata.)
1150        */
1151       sync_on_close = TRUE;
1152     }
1153   else if (fd == -1)
1154     {
1155       int errsv = errno;
1156
1157       if (errsv == EINVAL)
1158         /* This must be an invalid filename, on e.g. FAT */
1159         g_set_error_literal (error, G_IO_ERROR,
1160                              G_IO_ERROR_INVALID_FILENAME,
1161                              _("Invalid filename"));
1162       else
1163         {
1164           char *display_name = g_filename_display_name (filename);
1165           g_set_error (error, G_IO_ERROR,
1166                        g_io_error_from_errno (errsv),
1167                        _("Error opening file '%s': %s"),
1168                        display_name, g_strerror (errsv));
1169           g_free (display_name);
1170         }
1171       return NULL;
1172     }
1173
1174
1175   stream = g_object_new (G_TYPE_LOCAL_FILE_OUTPUT_STREAM, NULL);
1176   stream->priv->fd = fd;
1177   stream->priv->sync_on_close = sync_on_close;
1178   stream->priv->tmp_filename = temp_file;
1179   if (create_backup)
1180     stream->priv->backup_filename = create_backup_filename (filename);
1181   stream->priv->original_filename =  g_strdup (filename);
1182
1183   return G_FILE_OUTPUT_STREAM (stream);
1184 }
1185
1186 gint
1187 _g_local_file_output_stream_get_fd (GLocalFileOutputStream *stream)
1188 {
1189   g_return_val_if_fail (G_IS_LOCAL_FILE_OUTPUT_STREAM (stream), -1);
1190   return stream->priv->fd;
1191 }
1192
1193 #ifdef G_OS_UNIX
1194 static int
1195 g_local_file_output_stream_get_fd (GFileDescriptorBased *fd_based)
1196 {
1197   GLocalFileOutputStream *stream = G_LOCAL_FILE_OUTPUT_STREAM (fd_based);
1198   return _g_local_file_output_stream_get_fd (stream);
1199 }
1200 #endif