?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Updated Spanish translation
[anjuta-git-plugin.git] / plugins / sourceview / anjuta-document-saver.c
blob53305373ad12d18c41acbcfb2f07766221f2ad5f
1 /*
2 * anjuta-document-saver.c
3 * This file is part of anjuta
4 *
5 * Copyright (C) 2005 - Paolo Borelli and Paolo Maggi
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
21 */
22
23 /*
24 * Modified by the anjuta Team, 2005. See the AUTHORS file for a
25 * list of people on the anjuta Team.
26 * See the ChangeLog files for a list of changes.
27 *
28 * $Id$
29 */
30
31 #ifdef HAVE_CONFIG_H
32 #include <config.h>
33 #endif
34
35 #include <sys/mman.h>
36 #include <sys/types.h>
37 #include <sys/stat.h>
38 #include <fcntl.h>
39 #include <string.h>
40 #include <errno.h>
41
42 #include <glib/gi18n.h>
43 #include <glib/gfileutils.h>
44 #include <libgnomevfs/gnome-vfs.h>
45
46 #include "anjuta-encodings.h"
47 #include "anjuta-document-saver.h"
48 #include "anjuta-marshal.h"
49 #include "anjuta-convert.h"
50
51 #define ANJUTA_DOCUMENT_SAVER_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), ANJUTA_TYPE_DOCUMENT_SAVER, AnjutaDocumentSaverPrivate))
52
53 struct _AnjutaDocumentSaverPrivate
54 {
55 AnjutaDocument *document;
56
57 gchar *uri;
58 const AnjutaEncoding *encoding;
59
60 AnjutaDocumentSaveFlags flags;
61
62 gboolean keep_backup;
63 gchar *backup_ext;
64 gboolean backups_in_curr_dir;
65
66 time_t doc_mtime;
67 gchar *mime_type; //CHECK use FileInfo instead?
68
69 GnomeVFSFileSize size;
70 GnomeVFSFileSize bytes_written;
71
72 /* temp data for local files */
73 gint fd;
74 gchar *local_path;
75
76 /* temp data for remote files */
77 GnomeVFSURI *vfs_uri;
78 GnomeVFSAsyncHandle *handle;
79 GnomeVFSAsyncHandle *info_handle;
80 gint tmpfd;
81 gchar *tmp_fname;
82 GnomeVFSFileInfo *orig_info; /* used to restore permissions */
83
84 GError *error;
85 };
86
87 G_DEFINE_TYPE(AnjutaDocumentSaver, anjuta_document_saver, G_TYPE_OBJECT)
88
89 /* Signals */
90
91 enum {
92 SAVING,
93 LAST_SIGNAL
94 };
95
96 static guint signals[LAST_SIGNAL] = { 0 };
97
98 static void
99 anjuta_document_saver_finalize (GObject *object)
100 {
101 AnjutaDocumentSaverPrivate *priv = ANJUTA_DOCUMENT_SAVER (object)->priv;
102
103 g_free (priv->uri);
104
105 if (priv->vfs_uri)
106 gnome_vfs_uri_unref (priv->vfs_uri);
107
108 g_free (priv->backup_ext);
109
110 g_free (priv->local_path);
111 g_free (priv->mime_type);
112 g_free (priv->tmp_fname);
113
114 if (priv->orig_info)
115 gnome_vfs_file_info_unref (priv->orig_info);
116
117 if (priv->error)
118 g_error_free (priv->error);
119
120 G_OBJECT_CLASS (anjuta_document_saver_parent_class)->finalize (object);
121 }
122
123 static void
124 anjuta_document_saver_class_init (AnjutaDocumentSaverClass *klass)
125 {
126 GObjectClass *object_class = G_OBJECT_CLASS (klass);
127
128 object_class->finalize = anjuta_document_saver_finalize;
129
130 signals[SAVING] =
131 g_signal_new ("saving",
132 G_OBJECT_CLASS_TYPE (object_class),
133 G_SIGNAL_RUN_LAST,
134 G_STRUCT_OFFSET (AnjutaDocumentSaverClass, saving),
135 NULL, NULL,
136 anjuta_marshal_VOID__BOOLEAN_POINTER,
137 G_TYPE_NONE,
138 2,
139 G_TYPE_BOOLEAN,
140 G_TYPE_POINTER);
141
142 g_type_class_add_private (object_class, sizeof(AnjutaDocumentSaverPrivate));
143 }
144
145 static void
146 anjuta_document_saver_init (AnjutaDocumentSaver *saver)
147 {
148 saver->priv = ANJUTA_DOCUMENT_SAVER_GET_PRIVATE (saver);
149
150 saver->priv->fd = -1;
151
152 saver->priv->tmpfd = -1;
153
154 saver->priv->error = NULL;
155 }
156
157 AnjutaDocumentSaver *
158 anjuta_document_saver_new (AnjutaDocument *doc)
159 {
160 AnjutaDocumentSaver *saver;
161
162 g_return_val_if_fail (ANJUTA_IS_DOCUMENT (doc), NULL);
163
164 saver = ANJUTA_DOCUMENT_SAVER (g_object_new (ANJUTA_TYPE_DOCUMENT_SAVER, NULL));
165
166 saver->priv->document = doc;
167
168 return saver;
169 }
170
171 /*
172 * Write the document contents in fd.
173 */
174 static gboolean
175 write_document_contents (gint fd,
176 GtkTextBuffer *doc,
177 const AnjutaEncoding *encoding,
178 GError **error)
179 {
180 GtkTextIter start_iter;
181 GtkTextIter end_iter;
182 gchar *contents;
183 gsize len;
184 gboolean add_cr;
185 ssize_t written;
186 gboolean res;
187
188 gtk_text_buffer_get_bounds (doc, &start_iter, &end_iter);
189 contents = gtk_text_buffer_get_slice (doc, &start_iter, &end_iter, TRUE);
190
191 len = strlen (contents);
192
193 if (len >= 1)
194 add_cr = (*(contents + len - 1) != '\n');
195 else
196 add_cr = FALSE;
197
198 if (encoding != anjuta_encoding_get_utf8 ())
199 {
200 gchar *converted_contents;
201 gsize new_len;
202
203 converted_contents = anjuta_convert_from_utf8 (contents,
204 len,
205 encoding,
206 &new_len,
207 error);
208 g_free (contents);
209
210 if (*error != NULL)
211 {
212 /* Conversion error */
213 return FALSE;
214 }
215 else
216 {
217 contents = converted_contents;
218 len = new_len;
219 }
220 }
221
222 /* make sure we are at the start */
223 res = (lseek (fd, 0, SEEK_SET) != -1);
224
225 /* Truncate the file to 0, in case it was not empty */
226 if (res)
227 res = (ftruncate (fd, 0) == 0);
228
229 /* Save the file content */
230 if (res)
231 {
232 written = write (fd, contents, len);
233 res = ((written != -1) && ((gsize) written == len));
234 }
235
236 /* Add \n at the end if needed */
237 if (res && add_cr)
238 {
239 if (encoding != anjuta_encoding_get_utf8 ())
240 {
241 gchar *converted_n = NULL;
242 gsize n_len;
243
244 converted_n = anjuta_convert_from_utf8 ("\n",
245 -1,
246 encoding,
247 &n_len,
248 NULL);
249
250 if (converted_n == NULL)
251 {
252 /* we do not error out for this */
253 g_warning ("Cannot add '\\n' at the end of the file.");
254 }
255 else
256 {
257 written = write (fd, converted_n, n_len);
258 res = ((written != -1) && ((gsize) written == n_len));
259 g_free (converted_n);
260 }
261 }
262 else
263 {
264 res = (write (fd, "\n", 1) == 1);
265 }
266 }
267
268 g_free (contents);
269
270 if (!res)
271 {
272 GnomeVFSResult result = gnome_vfs_result_from_errno ();
273
274 g_set_error (error,
275 ANJUTA_DOCUMENT_ERROR,
276 result,
277 "%s", gnome_vfs_result_to_string (result));
278 }
279
280 return res;
281 }
282
283 static void
284 save_completed_or_failed (AnjutaDocumentSaver *saver)
285 {
286 /* the object will be unrefed in the callback of the saving
287 * signal, so we need to prevent finalization.
288 */
289 g_object_ref (saver);
290
291 g_signal_emit (saver,
292 signals[SAVING],
293 0,
294 TRUE, /* completed */
295 saver->priv->error);
296
297 g_object_unref (saver);
298 }
299
300 static gchar *
301 get_backup_filename (AnjutaDocumentSaver *saver)
302 {
303 gchar *fname;
304 gchar *bak_ext = NULL;
305
306 if ((saver->priv->backup_ext != NULL) &&
307 (strlen (saver->priv->backup_ext) > 0))
308 bak_ext = saver->priv->backup_ext;
309 else
310 bak_ext = g_strdup("~");
311
312 fname = g_strconcat (saver->priv->local_path, bak_ext, NULL);
313
314 /* If we are not going to keep the backup file and fname
315 * already exists, try to use another name.
316 * Change one character, just before the extension.
317 */
318 if (!saver->priv->keep_backup &&
319 g_file_test (fname, G_FILE_TEST_EXISTS))
320 {
321 gchar *wp;
322
323 wp = fname + strlen (fname) - 1 - strlen (bak_ext);
324 g_return_val_if_fail (wp > fname, NULL);
325
326 *wp = 'z';
327 while ((*wp > 'a') && g_file_test (fname, G_FILE_TEST_EXISTS))
328 --*wp;
329
330 /* They all exist??? Must be something wrong. */
331 if (*wp == 'a')
332 {
333 g_free (fname);
334 fname = NULL;
335 }
336 }
337
338 return fname;
339 }
340
341 /* like unlink, but doesn't fail if the file wasn't there at all */
342 static gboolean
343 remove_file (const gchar *name)
344 {
345 gint res;
346
347 res = unlink (name);
348
349 return (res == 0) || ((res == -1) && (errno == ENOENT));
350 }
351
352 #define BUFSIZE 8192 /* size of normal write buffer */
353
354 static gboolean
355 copy_file_data (gint sfd,
356 gint dfd,
357 GError **error)
358 {
359 gboolean ret = TRUE;
360 GError *err = NULL;
361 gpointer buffer;
362 const gchar *write_buffer;
363 ssize_t bytes_read;
364 ssize_t bytes_to_write;
365 ssize_t bytes_written;
366
367 buffer = g_malloc (BUFSIZE);
368
369 do
370 {
371 bytes_read = read (sfd, buffer, BUFSIZE);
372 if (bytes_read == -1)
373 {
374 GnomeVFSResult result = gnome_vfs_result_from_errno ();
375
376 g_set_error (&err,
377 ANJUTA_DOCUMENT_ERROR,
378 result,
379 "%s", gnome_vfs_result_to_string (result));
380
381 ret = FALSE;
382
383 break;
384 }
385
386 bytes_to_write = bytes_read;
387 write_buffer = buffer;
388
389 do
390 {
391 bytes_written = write (dfd, write_buffer, bytes_to_write);
392 if (bytes_written == -1)
393 {
394 GnomeVFSResult result = gnome_vfs_result_from_errno ();
395
396 g_set_error (&err,
397 ANJUTA_DOCUMENT_ERROR,
398 result,
399 "%s", gnome_vfs_result_to_string (result));
400
401 ret = FALSE;
402
403 break;
404 }
405
406 bytes_to_write -= bytes_written;
407 write_buffer += bytes_written;
408 }
409 while (bytes_to_write > 0);
410
411 } while ((bytes_read != 0) && (ret == TRUE));
412
413 if (error)
414 *error = err;
415
416 return ret;
417 }
418
419 /* FIXME: this is ugly for multple reasons: it refetches all the info,
420 * it doesn't use fd etc... we need something better, possibly in gnome-vfs
421 * public api.
422 */
423 static gchar *
424 get_slow_mime_type (const char *text_uri)
425 {
426 GnomeVFSFileInfo *info;
427 char *mime_type;
428 GnomeVFSResult result;
429
430 info = gnome_vfs_file_info_new ();
431 result = gnome_vfs_get_file_info (text_uri, info,
432 GNOME_VFS_FILE_INFO_GET_MIME_TYPE |
433 GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE |
434 GNOME_VFS_FILE_INFO_FOLLOW_LINKS);
435 if (info->mime_type == NULL || result != GNOME_VFS_OK) {
436 mime_type = NULL;
437 } else {
438 mime_type = g_strdup (info->mime_type);
439 }
440 gnome_vfs_file_info_unref (info);
441
442 return mime_type;
443 }
444
445 /* ----------- local files ----------- */
446
447 static gboolean
448 save_existing_local_file (AnjutaDocumentSaver *saver)
449 {
450 mode_t saved_umask;
451 struct stat statbuf;
452 struct stat new_statbuf;
453 gchar *backup_filename = NULL;
454 gboolean backup_created = FALSE;
455
456 if (fstat (saver->priv->fd, &statbuf) != 0)
457 {
458 GnomeVFSResult result = gnome_vfs_result_from_errno ();
459
460 g_set_error (&saver->priv->error,
461 ANJUTA_DOCUMENT_ERROR,
462 result,
463 "%s", gnome_vfs_result_to_string (result));
464
465 goto out;
466 }
467
468 /* not a regular file */
469 if (!S_ISREG (statbuf.st_mode))
470 {
471 if (S_ISDIR (statbuf.st_mode))
472 {
473 g_set_error (&saver->priv->error,
474 ANJUTA_DOCUMENT_ERROR,
475 GNOME_VFS_ERROR_IS_DIRECTORY,
476 "%s", gnome_vfs_result_to_string (GNOME_VFS_ERROR_IS_DIRECTORY));
477 }
478 else
479 {
480 g_set_error (&saver->priv->error,
481 ANJUTA_DOCUMENT_ERROR,
482 ANJUTA_DOCUMENT_ERROR_NOT_REGULAR_FILE,
483 "Not a regular file");
484 }
485
486 goto out;
487 }
488
489 /* check if the file is actually writable */
490 if ((statbuf.st_mode & 0222) == 0) //FIXME... check better what else vim does
491 {
492 g_set_error (&saver->priv->error,
493 ANJUTA_DOCUMENT_ERROR,
494 GNOME_VFS_ERROR_READ_ONLY,
495 "%s", gnome_vfs_result_to_string (GNOME_VFS_ERROR_READ_ONLY));
496
497 goto out;
498 }
499
500 /* check if someone else modified the file externally,
501 * except when "saving as", when saving a new doc (mtime = 0)
502 * or when the mtime check is explicitely disabled
503 */
504 if (saver->priv->doc_mtime > 0 &&
505 statbuf.st_mtime != saver->priv->doc_mtime &&
506 ((saver->priv->flags & ANJUTA_DOCUMENT_SAVE_IGNORE_MTIME) == 0))
507 {
508 g_set_error (&saver->priv->error,
509 ANJUTA_DOCUMENT_ERROR,
510 ANJUTA_DOCUMENT_ERROR_EXTERNALLY_MODIFIED,
511 "Externally modified");
512
513 goto out;
514 }
515
516 /* prepare the backup name */
517 backup_filename = get_backup_filename (saver);
518 if (backup_filename == NULL)
519 {
520 /* bad bad luck... */
521 g_warning (_("Could not obtain backup filename"));
522
523 g_set_error (&saver->priv->error,
524 ANJUTA_DOCUMENT_ERROR,
525 GNOME_VFS_ERROR_GENERIC,
526 "%s", gnome_vfs_result_to_string (GNOME_VFS_ERROR_GENERIC));
527
528 goto out;
529 }
530
531 /* We now use two backup strategies.
532 * The first one (which is faster) consist in saving to a
533 * tmp file then rename the original file to the backup and the
534 * tmp file to the original name. This is fast but doesn't work
535 * when the file is a link (hard or symbolic) or when we can't
536 * write to the current dir or can't set the permissions on the
537 * new file. We also do not use it when the backup is not in the
538 * current dir, since if it isn't on the same FS rename wont work.
539 * The second strategy consist simply in copying the old file
540 * to a backup file and rewrite the contents of the file.
541 */
542
543 if (saver->priv->backups_in_curr_dir &&
544 !(statbuf.st_nlink > 1) &&
545 !g_file_test (saver->priv->local_path, G_FILE_TEST_IS_SYMLINK))
546 {
547 gchar *dirname;
548 gchar *tmp_filename;
549 gint tmpfd;
550
551 dirname = g_path_get_dirname (saver->priv->local_path);
552 tmp_filename = g_build_filename (dirname, ".anjuta-save-XXXXXX", NULL);
553 g_free (dirname);
554
555 /* We set the umask because some (buggy) implementations
556 * of mkstemp() use permissions 0666 and we want 0600.
557 */
558 saved_umask = umask (0077);
559 tmpfd = g_mkstemp (tmp_filename);
560 umask (saved_umask);
561
562 if (tmpfd == -1)
563 {
564 g_free (tmp_filename);
565 goto fallback_strategy;
566 }
567
568 /* try to set permissions */
569 if (fchown (tmpfd, statbuf.st_uid, statbuf.st_gid) == -1 ||
570 fchmod (tmpfd, statbuf.st_mode) == -1)
571 {
572 close (tmpfd);
573 unlink (tmp_filename);
574 g_free (tmp_filename);
575 goto fallback_strategy;
576 }
577
578 if (!write_document_contents (tmpfd,
579 GTK_TEXT_BUFFER (saver->priv->document),
580 saver->priv->encoding,
581 &saver->priv->error))
582 {
583 close (tmpfd);
584 unlink (tmp_filename);
585 g_free (tmp_filename);
586 goto out;
587 }
588
589 /* original -> backup */
590 if (rename (saver->priv->local_path, backup_filename) != 0)
591 {
592 GnomeVFSResult result = gnome_vfs_result_from_errno ();
593
594 g_set_error (&saver->priv->error,
595 ANJUTA_DOCUMENT_ERROR,
596 result,
597 "%s", gnome_vfs_result_to_string (result));
598
599 close (tmpfd);
600 unlink (tmp_filename);
601 g_free (tmp_filename);
602 goto out;
603 }
604
605 /* tmp -> original */
606 if (rename (tmp_filename, saver->priv->local_path) != 0)
607 {
608 GnomeVFSResult result = gnome_vfs_result_from_errno ();
609
610 g_set_error (&saver->priv->error,
611 ANJUTA_DOCUMENT_ERROR,
612 result,
613 "%s", gnome_vfs_result_to_string (result));
614
615 /* try to restore... no error checking */
616 rename (backup_filename, saver->priv->local_path);
617
618 close (tmpfd);
619 unlink (tmp_filename);
620 g_free (tmp_filename);
621 goto out;
622 }
623
624 g_free (tmp_filename);
625
626 /* restat and get the mime type */
627 if (fstat (tmpfd, &new_statbuf) != 0)
628 {
629 GnomeVFSResult result = gnome_vfs_result_from_errno ();
630
631 g_set_error (&saver->priv->error,
632 ANJUTA_DOCUMENT_ERROR,
633 result,
634 "%s", gnome_vfs_result_to_string (result));
635
636 close (tmpfd);
637 goto out;
638 }
639
640 saver->priv->doc_mtime = new_statbuf.st_mtime;
641
642 saver->priv->mime_type = get_slow_mime_type (saver->priv->uri);
643
644 if (!saver->priv->keep_backup)
645 unlink (backup_filename);
646
647 close (tmpfd);
648
649 goto out;
650 }
651
652 fallback_strategy:
653
654 /* try to copy the old contents in a backup for safety
655 * unless we are explicetely told not to.
656 */
657 if ((saver->priv->flags & ANJUTA_DOCUMENT_SAVE_IGNORE_BACKUP) == 0)
658 {
659 gint bfd;
660
661 /* move away old backups */
662 if (!remove_file (backup_filename))
663 {
664 /* we don't care about which was the problem, just
665 * that a backup was not possible.
666 */
667 g_set_error (&saver->priv->error,
668 ANJUTA_DOCUMENT_ERROR,
669 ANJUTA_DOCUMENT_ERROR_CANT_CREATE_BACKUP,
670 "No backup created");
671
672 goto out;
673 }
674
675 bfd = open (backup_filename,
676 O_WRONLY | O_CREAT | O_EXCL,
677 statbuf.st_mode & 0777);
678
679 if (bfd == -1)
680 {
681 g_set_error (&saver->priv->error,
682 ANJUTA_DOCUMENT_ERROR,
683 ANJUTA_DOCUMENT_ERROR_CANT_CREATE_BACKUP,
684 "No backup created");
685
686 goto out;
687 }
688
689 /* Try to set the group of the backup same as the
690 * original file. If this fails, set the protection
691 * bits for the group same as the protection bits for
692 * others. */
693 if (fchown (bfd, (uid_t) -1, statbuf.st_gid) != 0)
694 {
695 if (fchmod (bfd,
696 (statbuf.st_mode& 0707) |
697 ((statbuf.st_mode & 07) << 3)) != 0)
698 {
699 g_set_error (&saver->priv->error,
700 ANJUTA_DOCUMENT_ERROR,
701 ANJUTA_DOCUMENT_ERROR_CANT_CREATE_BACKUP,
702 "No backup created");
703
704 unlink (backup_filename);
705 close (bfd);
706
707 goto out;
708 }
709 }
710
711 if (!copy_file_data (saver->priv->fd, bfd, NULL))
712 {
713 g_set_error (&saver->priv->error,
714 ANJUTA_DOCUMENT_ERROR,
715 ANJUTA_DOCUMENT_ERROR_CANT_CREATE_BACKUP,
716 "No backup created");
717
718 unlink (backup_filename);
719 close (bfd);
720
721 goto out;
722 }
723
724 backup_created = TRUE;
725 close (bfd);
726 }
727
728 /* finally overwrite the original */
729 if (!write_document_contents (saver->priv->fd,
730 GTK_TEXT_BUFFER (saver->priv->document),
731 saver->priv->encoding,
732 &saver->priv->error))
733 {
734 goto out;
735 }
736
737 /* remove the backup if we don't want to keep it */
738 if (backup_created && !saver->priv->keep_backup)
739 {
740 unlink (backup_filename);
741 }
742
743 /* re stat the file and refetch the mime type */
744 if (fstat (saver->priv->fd, &new_statbuf) != 0)
745 {
746 GnomeVFSResult result = gnome_vfs_result_from_errno ();
747
748 g_set_error (&saver->priv->error,
749 ANJUTA_DOCUMENT_ERROR,
750 result,
751 "%s", gnome_vfs_result_to_string (result));
752
753 goto out;
754 }
755
756 saver->priv->doc_mtime = new_statbuf.st_mtime;
757
758 g_free (saver->priv->mime_type);
759 saver->priv->mime_type = get_slow_mime_type (saver->priv->uri);
760
761 out:
762 if (close (saver->priv->fd))
763 g_warning ("File '%s' has not been correctly closed: %s",
764 saver->priv->uri,
765 strerror (errno));
766 saver->priv->fd = -1;
767
768 g_free (backup_filename);
769
770 save_completed_or_failed (saver);
771
772 /* stop the timeout */
773 return FALSE;
774 }
775
776 static gboolean
777 save_new_local_file (AnjutaDocumentSaver *saver)
778 {
779 struct stat statbuf;
780
781 if (!write_document_contents (saver->priv->fd,
782 GTK_TEXT_BUFFER (saver->priv->document),
783 saver->priv->encoding,
784 &saver->priv->error))
785 {
786 goto out;
787 }
788
789 /* stat the file and fetch the mime type */
790 if (fstat (saver->priv->fd, &statbuf) != 0)
791 {
792 GnomeVFSResult result = gnome_vfs_result_from_errno ();
793
794 g_set_error (&saver->priv->error,
795 ANJUTA_DOCUMENT_ERROR,
796 result,
797 "%s", gnome_vfs_result_to_string (result));
798
799 goto out;
800 }
801
802 saver->priv->doc_mtime = statbuf.st_mtime;
803
804 g_free (saver->priv->mime_type);
805 saver->priv->mime_type = get_slow_mime_type (saver->priv->uri);
806
807 out:
808 if (close (saver->priv->fd))
809 g_warning ("File '%s' has not been correctly closed: %s",
810 saver->priv->uri,
811 strerror (errno));
812
813 saver->priv->fd = -1;
814
815 save_completed_or_failed (saver);
816
817 /* stop the timeout */
818 return FALSE;
819 }
820
821 static gboolean
822 open_local_failed (AnjutaDocumentSaver *saver)
823 {
824 save_completed_or_failed (saver);
825
826 /* stop the timeout */
827 return FALSE;
828 }
829
830 static void
831 save_local_file (AnjutaDocumentSaver *saver)
832 {
833 GSourceFunc next_phase;
834 GnomeVFSResult result;
835
836 /* saving start */
837 g_signal_emit (saver,
838 signals[SAVING],
839 0,
840 FALSE,
841 NULL);
842
843 /* the file doesn't exist, create it */
844 saver->priv->fd = open (saver->priv->local_path,
845 O_CREAT | O_EXCL | O_WRONLY,
846 0666);
847 if (saver->priv->fd != -1)
848 {
849 next_phase = (GSourceFunc) save_new_local_file;
850 goto out;
851 }
852
853 /* the file already exist */
854 else if (errno == EEXIST)
855 {
856 saver->priv->fd = open (saver->priv->local_path, O_RDWR);
857 if (saver->priv->fd != -1)
858 {
859 next_phase = (GSourceFunc) save_existing_local_file;
860 goto out;
861 }
862 }
863
864 /* else error */
865 result = gnome_vfs_result_from_errno (); //may it happen that no errno?
866
867 g_set_error (&saver->priv->error,
868 ANJUTA_DOCUMENT_ERROR,
869 result,
870 "%s", gnome_vfs_result_to_string (result));
871
872 next_phase = (GSourceFunc) open_local_failed;
873
874 out:
875 g_timeout_add_full (G_PRIORITY_HIGH,
876 0,
877 next_phase,
878 saver,
879 NULL);
880 }
881
882 /* ----------- remote files ----------- */
883
884 static void
885 remote_save_completed_or_failed (AnjutaDocumentSaver *saver)
886 {
887 /* we can now close and unlink the tmp file */
888 close (saver->priv->tmpfd);
889 unlink (saver->priv->tmp_fname);
890
891 save_completed_or_failed (saver);
892 }
893
894 static void
895 remote_get_info_cb (GnomeVFSAsyncHandle *handle,
896 GList *results,
897 gpointer data)
898 {
899 AnjutaDocumentSaver *saver = ANJUTA_DOCUMENT_SAVER (data);
900 GnomeVFSGetFileInfoResult *info_result;
901
902 /* assert that the list has one and only one item */
903 g_return_if_fail (results != NULL && results->next == NULL);
904
905 info_result = (GnomeVFSGetFileInfoResult *) results->data;
906 g_return_if_fail (info_result != NULL);
907
908 if (info_result->result != GNOME_VFS_OK)
909 {
910 g_set_error (&saver->priv->error,
911 ANJUTA_DOCUMENT_ERROR,
912 info_result->result,
913 "%s", gnome_vfs_result_to_string (info_result->result));
914
915 remote_save_completed_or_failed (saver);
916
917 return;
918 }
919
920 if (info_result->file_info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_MTIME)
921 saver->priv->doc_mtime = info_result->file_info->mtime;
922
923 if (info_result->file_info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_MIME_TYPE)
924 {
925 g_free (saver->priv->mime_type);
926 saver->priv->mime_type = g_strdup (info_result->file_info->mime_type);
927 }
928
929 remote_save_completed_or_failed (saver);
930 }
931
932 static gint
933 async_xfer_ok (GnomeVFSXferProgressInfo *progress_info,
934 AnjutaDocumentSaver *saver)
935 {
936 switch (progress_info->phase)
937 {
938 case GNOME_VFS_XFER_PHASE_INITIAL:
939 break;
940 case GNOME_VFS_XFER_CHECKING_DESTINATION:
941 {
942 GnomeVFSFileInfo *orig_info;
943 GnomeVFSResult res;
944
945 /* we need to retrieve info ourselves too, since xfer
946 * doesn't allow to access it :(
947 * If that was not enough we need to do it sync or we are going
948 * to mess everything up
949 */
950 orig_info = gnome_vfs_file_info_new ();
951 res = gnome_vfs_get_file_info_uri (saver->priv->vfs_uri,
952 orig_info,
953 GNOME_VFS_FILE_INFO_DEFAULT |
954 GNOME_VFS_FILE_INFO_FOLLOW_LINKS);
955
956 if (res == GNOME_VFS_ERROR_NOT_FOUND)
957 {
958 /* ok, we are not overwriting, go on with the xfer */
959 break;
960 }
961
962 if (res != GNOME_VFS_OK)
963 {
964 // CHECK: do we want to ignore the error and try to go on anyway?
965 g_set_error (&saver->priv->error,
966 ANJUTA_DOCUMENT_ERROR,
967 res,
968 "%s", gnome_vfs_result_to_string (res));
969
970 /* abort xfer */
971 return 0;
972 }
973
974
975 /* check if someone else modified the file externally,
976 * except when "saving as", when saving a new doc (mtime = 0)
977 * or when the mtime check is explicitely disabled
978 */
979 if (orig_info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_MTIME)
980 {
981 if (saver->priv->doc_mtime > 0 &&
982 orig_info->mtime != saver->priv->doc_mtime &&
983 ((saver->priv->flags & ANJUTA_DOCUMENT_SAVE_IGNORE_MTIME) == 0))
984 {
985 g_set_error (&saver->priv->error,
986 ANJUTA_DOCUMENT_ERROR,
987 ANJUTA_DOCUMENT_ERROR_EXTERNALLY_MODIFIED,
988 "Externally modified");
989
990 /* abort xfer */
991 return 0;
992 }
993 }
994
995 /* store the original file info, so that we can restore permissions */
996 // FIXME: what about the case where we are usin "Save as" but overwriting a file... we don't want to restore perms
997 if (orig_info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS)
998 saver->priv->orig_info = orig_info;
999 }
1000 break;
1001 case GNOME_VFS_XFER_PHASE_COLLECTING:
1002 case GNOME_VFS_XFER_PHASE_DELETESOURCE: // why do we get this phase??
1003 break;
1004 case GNOME_VFS_XFER_PHASE_READYTOGO:
1005 saver->priv->size = progress_info->bytes_total;
1006 break;
1007 case GNOME_VFS_XFER_PHASE_OPENSOURCE:
1008 case GNOME_VFS_XFER_PHASE_OPENTARGET:
1009 case GNOME_VFS_XFER_PHASE_COPYING:
1010 case GNOME_VFS_XFER_PHASE_WRITETARGET:
1011 case GNOME_VFS_XFER_PHASE_CLOSETARGET:
1012 if (progress_info->bytes_copied > 0)
1013 saver->priv->bytes_written = MIN (progress_info->total_bytes_copied,
1014 progress_info->bytes_total);
1015 break;
1016 case GNOME_VFS_XFER_PHASE_FILECOMPLETED:
1017 case GNOME_VFS_XFER_PHASE_CLEANUP:
1018 break;
1019 case GNOME_VFS_XFER_PHASE_COMPLETED:
1020 /* Transfer done!
1021 * Restore the permissions if needed and then refetch
1022 * info on our newly written file to get the mime etc */
1023 {
1024 GList *uri_list = NULL;
1025
1026 /* Try is not as paranoid as the local version (GID)... it would take
1027 * yet another stat to do it...
1028 */
1029 if (saver->priv->orig_info != NULL &&
1030 (saver->priv->orig_info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS))
1031 {
1032 gnome_vfs_set_file_info_uri (saver->priv->vfs_uri,
1033 saver->priv->orig_info,
1034 GNOME_VFS_SET_FILE_INFO_PERMISSIONS);
1035
1036 // FIXME: for now is a blind try... do we want to error check?
1037 }
1038
1039 uri_list = g_list_prepend (uri_list, saver->priv->vfs_uri);
1040
1041 gnome_vfs_async_get_file_info (&saver->priv->info_handle,
1042 uri_list,
1043 GNOME_VFS_FILE_INFO_DEFAULT |
1044 GNOME_VFS_FILE_INFO_GET_MIME_TYPE |
1045 GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE |
1046 GNOME_VFS_FILE_INFO_FOLLOW_LINKS,
1047 GNOME_VFS_PRIORITY_MAX,
1048 remote_get_info_cb,
1049 saver);
1050 g_list_free (uri_list);
1051 }
1052 break;
1053 /* Phases we don't expect to see */
1054 case GNOME_VFS_XFER_PHASE_SETATTRIBUTES:
1055 case GNOME_VFS_XFER_PHASE_CLOSESOURCE:
1056 case GNOME_VFS_XFER_PHASE_MOVING:
1057 case GNOME_VFS_XFER_PHASE_READSOURCE:
1058 default:
1059 g_return_val_if_reached (0);
1060 }
1061
1062 /* signal the progress */
1063 g_signal_emit (saver,
1064 signals[SAVING],
1065 0,
1066 FALSE,
1067 NULL);
1068
1069 return 1;
1070 }
1071
1072 static gint
1073 async_xfer_error (GnomeVFSXferProgressInfo *progress_info,
1074 AnjutaDocumentSaver *saver)
1075 {
1076 g_set_error (&saver->priv->error,
1077 ANJUTA_DOCUMENT_ERROR,
1078 progress_info->vfs_status,
1079 "%s", gnome_vfs_result_to_string (progress_info->vfs_status));
1080
1081 remote_save_completed_or_failed (saver);
1082
1083 return GNOME_VFS_XFER_ERROR_ACTION_ABORT;
1084 }
1085
1086 static gint
1087 async_xfer_progress (GnomeVFSAsyncHandle *handle,
1088 GnomeVFSXferProgressInfo *progress_info,
1089 gpointer data)
1090 {
1091 AnjutaDocumentSaver *saver = ANJUTA_DOCUMENT_SAVER (data);
1092
1093 switch (progress_info->status)
1094 {
1095 case GNOME_VFS_XFER_PROGRESS_STATUS_OK:
1096 return async_xfer_ok (progress_info, saver);
1097 case GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR:
1098 return async_xfer_error (progress_info, saver);
1099
1100 /* we should never go in these */
1101 case GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE:
1102 case GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE:
1103 default:
1104 g_return_val_if_reached (0);
1105 }
1106 }
1107
1108 static gboolean
1109 save_remote_file_real (AnjutaDocumentSaver *saver)
1110 {
1111 mode_t saved_umask;
1112 gchar *tmp_uri;
1113 GnomeVFSURI *tmp_vfs_uri;
1114 GList *source_uri_list = NULL;
1115 GList *dest_uri_list = NULL;
1116 GnomeVFSResult result;
1117
1118 /* For remote files we use the following strategy:
1119 * we save to a local temp file and then transfer it
1120 * over to the requested location asyncronously.
1121 * There is no backup of the original remote file.
1122 */
1123
1124 /* We set the umask because some (buggy) implementations
1125 * of mkstemp() use permissions 0666 and we want 0600.
1126 */
1127 saved_umask = umask (0077);
1128 saver->priv->tmpfd = g_file_open_tmp (".anjuta-save-XXXXXX",
1129 &saver->priv->tmp_fname,
1130 &saver->priv->error);
1131 umask (saved_umask);
1132
1133 if (saver->priv->tmpfd == -1)
1134 {
1135 GnomeVFSResult result = gnome_vfs_result_from_errno ();
1136
1137 g_set_error (&saver->priv->error,
1138 ANJUTA_DOCUMENT_ERROR,
1139 result,
1140 "%s", gnome_vfs_result_to_string (result));
1141
1142 /* in this case no need to close the tmp file */
1143 save_completed_or_failed (saver);
1144
1145 return FALSE;
1146 }
1147
1148 tmp_uri = g_filename_to_uri (saver->priv->tmp_fname,
1149 NULL,
1150 &saver->priv->error);
1151 if (tmp_uri == NULL)
1152 {
1153 goto error;
1154 }
1155
1156 tmp_vfs_uri = gnome_vfs_uri_new (tmp_uri);
1157 //needs error checking?
1158
1159 g_free (tmp_uri);
1160
1161 source_uri_list = g_list_prepend (source_uri_list, tmp_vfs_uri);
1162 dest_uri_list = g_list_prepend (dest_uri_list, saver->priv->vfs_uri);
1163
1164 if (!write_document_contents (saver->priv->tmpfd,
1165 GTK_TEXT_BUFFER (saver->priv->document),
1166 saver->priv->encoding,
1167 &saver->priv->error))
1168 {
1169 goto error;
1170 }
1171
1172 result = gnome_vfs_async_xfer (&saver->priv->handle,
1173 source_uri_list,
1174 dest_uri_list,
1175 GNOME_VFS_XFER_DEFAULT | GNOME_VFS_XFER_TARGET_DEFAULT_PERMS, // CHECK needs more thinking, follow symlinks etc... options are undocumented :(
1176 GNOME_VFS_XFER_ERROR_MODE_ABORT, /* keep it simple, abort on any error */
1177 GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE, /* We have already asked confirm (even if it is racy) */
1178 GNOME_VFS_PRIORITY_DEFAULT,
1179 async_xfer_progress, saver,
1180 NULL, NULL);
1181
1182 gnome_vfs_uri_unref (tmp_vfs_uri);
1183 g_list_free (source_uri_list);
1184 g_list_free (dest_uri_list);
1185
1186 if (result != GNOME_VFS_OK)
1187 {
1188 g_set_error (&saver->priv->error,
1189 ANJUTA_DOCUMENT_ERROR,
1190 result,
1191 "%s", gnome_vfs_result_to_string (result));
1192
1193 goto error;
1194 }
1195
1196 /* No errors: stop the timeout */
1197 return FALSE;
1198
1199 error:
1200 remote_save_completed_or_failed (saver);
1201
1202 /* stop the timeout */
1203 return FALSE;
1204 }
1205
1206 static void
1207 save_remote_file (AnjutaDocumentSaver *saver)
1208 {
1209 /* saving start */
1210 g_signal_emit (saver,
1211 signals[SAVING],
1212 0,
1213 FALSE,
1214 NULL);
1215
1216 g_timeout_add_full (G_PRIORITY_HIGH,
1217 0,
1218 (GSourceFunc) save_remote_file_real,
1219 saver,
1220 NULL);
1221 }
1222
1223 /* ---------- public api ---------- */
1224
1225 void
1226 anjuta_document_saver_save (AnjutaDocumentSaver *saver,
1227 const gchar *uri,
1228 const AnjutaEncoding *encoding,
1229 time_t oldmtime,
1230 AnjutaDocumentSaveFlags flags)
1231 {
1232 gchar *local_path;
1233
1234 g_return_if_fail (ANJUTA_IS_DOCUMENT_SAVER (saver));
1235 g_return_if_fail ((uri != NULL) && (strlen (uri) > 0));
1236
1237 // CHECK:
1238 // - sanity check a max len for the uri?
1239 // report async (in an idle handler) or sync (bool ret)
1240 // async is extra work here, sync is special casing in the caller
1241
1242 saver->priv->uri = g_strdup (uri);
1243
1244 /* fetch saving options */
1245 saver->priv->backup_ext = g_strdup("~");
1246
1247 /* never keep backup of autosaves */
1248 if ((flags & ANJUTA_DOCUMENT_SAVE_PRESERVE_BACKUP) != 0)
1249 saver->priv->keep_backup = FALSE;
1250 else
1251 /* FIXME: This should be configurable */
1252 saver->priv->keep_backup =TRUE;
1253
1254 /* TODO: add support for configurable backup dir */
1255 saver->priv->backups_in_curr_dir = TRUE;
1256
1257 if (encoding != NULL)
1258 saver->priv->encoding = encoding;
1259 else
1260 saver->priv->encoding = anjuta_encoding_get_utf8 ();
1261
1262 saver->priv->doc_mtime = oldmtime;
1263
1264 saver->priv->flags = flags;
1265
1266 local_path = gnome_vfs_get_local_path_from_uri (uri);
1267 if (local_path != NULL)
1268 {
1269 saver->priv->local_path = local_path;
1270 save_local_file (saver);
1271 }
1272 else
1273 {
1274 saver->priv->vfs_uri = gnome_vfs_uri_new (uri);
1275 save_remote_file (saver);
1276 }
1277 }
1278
1279 const gchar *
1280 anjuta_document_saver_get_uri (AnjutaDocumentSaver *saver)
1281 {
1282 g_return_val_if_fail (ANJUTA_IS_DOCUMENT_SAVER (saver), NULL);
1283
1284 return saver->priv->uri;
1285 }
1286
1287 const gchar *
1288 anjuta_document_saver_get_mime_type (AnjutaDocumentSaver *saver)
1289 {
1290 g_return_val_if_fail (ANJUTA_IS_DOCUMENT_SAVER (saver), NULL);
1291
1292 return saver->priv->mime_type;
1293 }
1294
1295 time_t
1296 anjuta_document_saver_get_mtime (AnjutaDocumentSaver *saver)
1297 {
1298 g_return_val_if_fail (ANJUTA_IS_DOCUMENT_SAVER (saver), 0);
1299
1300 return saver->priv->doc_mtime;
1301 }
1302
1303 /* Returns 0 if file size is unknown */
1304 GnomeVFSFileSize
1305 anjuta_document_saver_get_file_size (AnjutaDocumentSaver *saver)
1306 {
1307 g_return_val_if_fail (ANJUTA_IS_DOCUMENT_SAVER (saver), 0);
1308
1309 return saver->priv->size;
1310 }
1311
1312 GnomeVFSFileSize
1313 anjuta_document_saver_get_bytes_written (AnjutaDocumentSaver *saver)
1314 {
1315 g_return_val_if_fail (ANJUTA_IS_DOCUMENT_SAVER (saver), 0);
1316
1317 return saver->priv->bytes_written;
1318 }
Anjuta IDE Git Plugin Development Tree