Cleanup: remove redundant, invalid info from headers
[blender.git] / source / blender / blenloader / intern / undofile.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2004 Blender Foundation
17  * All rights reserved.
18  * .blend file reading entry point
19  */
20
21 /** \file blender/blenloader/intern/undofile.c
22  *  \ingroup blenloader
23  */
24
25 #include <stdlib.h>
26 #include <string.h>
27 #include <stdio.h>
28 #include <math.h>
29 #include <fcntl.h>
30 #include <errno.h>
31
32 /* open/close */
33 #ifndef _WIN32
34 #  include <unistd.h>
35 #else
36 #  include <io.h>
37 #endif
38
39 #include "MEM_guardedalloc.h"
40
41 #include "DNA_listBase.h"
42
43 #include "BLI_blenlib.h"
44
45 #include "BLO_undofile.h"
46 #include "BLO_readfile.h"
47
48 #include "BKE_main.h"
49
50 /* keep last */
51 #include "BLI_strict_flags.h"
52
53 /* **************** support for memory-write, for undo buffers *************** */
54
55 /* not memfile itself */
56 void BLO_memfile_free(MemFile *memfile)
57 {
58         MemFileChunk *chunk;
59
60         while ((chunk = BLI_pophead(&memfile->chunks))) {
61                 if (chunk->is_identical == false) {
62                         MEM_freeN((void *)chunk->buf);
63                 }
64                 MEM_freeN(chunk);
65         }
66         memfile->size = 0;
67 }
68
69 /* to keep list of memfiles consistent, 'first' is always first in list */
70 /* result is that 'first' is being freed */
71 void BLO_memfile_merge(MemFile *first, MemFile *second)
72 {
73         MemFileChunk *fc, *sc;
74
75         fc = first->chunks.first;
76         sc = second->chunks.first;
77         while (fc || sc) {
78                 if (fc && sc) {
79                         if (sc->is_identical) {
80                                 sc->is_identical = false;
81                                 fc->is_identical = true;
82                         }
83                 }
84                 if (fc) fc = fc->next;
85                 if (sc) sc = sc->next;
86         }
87
88         BLO_memfile_free(first);
89 }
90
91 void memfile_chunk_add(
92         MemFile *memfile, const char *buf, uint size,
93         MemFileChunk **compchunk_step)
94 {
95         MemFileChunk *curchunk = MEM_mallocN(sizeof(MemFileChunk), "MemFileChunk");
96         curchunk->size = size;
97         curchunk->buf = NULL;
98         curchunk->is_identical = false;
99         BLI_addtail(&memfile->chunks, curchunk);
100
101         /* we compare compchunk with buf */
102         if (*compchunk_step != NULL) {
103                 MemFileChunk *compchunk = *compchunk_step;
104                 if (compchunk->size == curchunk->size) {
105                         if (memcmp(compchunk->buf, buf, size) == 0) {
106                                 curchunk->buf = compchunk->buf;
107                                 curchunk->is_identical = true;
108                         }
109                 }
110                 *compchunk_step = compchunk->next;
111         }
112
113         /* not equal... */
114         if (curchunk->buf == NULL) {
115                 char *buf_new = MEM_mallocN(size, "Chunk buffer");
116                 memcpy(buf_new, buf, size);
117                 curchunk->buf = buf_new;
118                 memfile->size += size;
119         }
120 }
121
122 struct Main *BLO_memfile_main_get(struct MemFile *memfile, struct Main *oldmain, struct Scene **r_scene)
123 {
124         struct Main *bmain_undo = NULL;
125         BlendFileData *bfd = BLO_read_from_memfile(oldmain, BKE_main_blendfile_path(oldmain), memfile, BLO_READ_SKIP_NONE, NULL);
126
127         if (bfd) {
128                 bmain_undo = bfd->main;
129                 if (r_scene) {
130                         *r_scene = bfd->curscene;
131                 }
132
133                 MEM_freeN(bfd);
134         }
135
136         return bmain_undo;
137 }
138
139
140 /**
141  * Saves .blend using undo buffer.
142  *
143  * \return success.
144  */
145 bool BLO_memfile_write_file(struct MemFile *memfile, const char *filename)
146 {
147         MemFileChunk *chunk;
148         int file, oflags;
149
150         /* note: This is currently used for autosave and 'quit.blend', where _not_ following symlinks is OK,
151          * however if this is ever executed explicitly by the user, we may want to allow writing to symlinks.
152          */
153
154         oflags = O_BINARY | O_WRONLY | O_CREAT | O_TRUNC;
155 #ifdef O_NOFOLLOW
156         /* use O_NOFOLLOW to avoid writing to a symlink - use 'O_EXCL' (CVE-2008-1103) */
157         oflags |= O_NOFOLLOW;
158 #else
159         /* TODO(sergey): How to deal with symlinks on windows? */
160 #  ifndef _MSC_VER
161 #    warning "Symbolic links will be followed on undo save, possibly causing CVE-2008-1103"
162 #  endif
163 #endif
164         file = BLI_open(filename,  oflags, 0666);
165
166         if (file == -1) {
167                 fprintf(stderr, "Unable to save '%s': %s\n",
168                         filename, errno ? strerror(errno) : "Unknown error opening file");
169                 return false;
170         }
171
172         for (chunk = memfile->chunks.first; chunk; chunk = chunk->next) {
173                 if ((size_t)write(file, chunk->buf, chunk->size) != chunk->size) {
174                         break;
175                 }
176         }
177
178         close(file);
179
180         if (chunk) {
181                 fprintf(stderr, "Unable to save '%s': %s\n",
182                         filename, errno ? strerror(errno) : "Unknown error writing file");
183                 return false;
184         }
185         return true;
186 }