Fix T53274: Saving template prefs overwrites default prefs
[blender.git] / source / blender / blenkernel / intern / blendfile.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/blenkernel/intern/blendfile.c
22  *  \ingroup bke
23  *
24  * High level `.blend` file read/write,
25  * and functions for writing *partial* files (only selected data-blocks).
26  */
27
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_scene_types.h"
34 #include "DNA_screen_types.h"
35
36 #include "BLI_listbase.h"
37 #include "BLI_string.h"
38 #include "BLI_path_util.h"
39 #include "BLI_utildefines.h"
40
41 #include "IMB_colormanagement.h"
42
43 #include "BKE_appdir.h"
44 #include "BKE_blender.h"
45 #include "BKE_blender_version.h"
46 #include "BKE_blendfile.h"
47 #include "BKE_bpath.h"
48 #include "BKE_context.h"
49 #include "BKE_global.h"
50 #include "BKE_ipo.h"
51 #include "BKE_library.h"
52 #include "BKE_main.h"
53 #include "BKE_report.h"
54 #include "BKE_scene.h"
55 #include "BKE_screen.h"
56
57 #include "BLO_readfile.h"
58 #include "BLO_writefile.h"
59
60 #include "RNA_access.h"
61
62 #include "RE_pipeline.h"
63
64 #ifdef WITH_PYTHON
65 #  include "BPY_extern.h"
66 #endif
67
68 /* -------------------------------------------------------------------- */
69
70 /** \name High Level `.blend` file read/write.
71  * \{ */
72
73 static bool clean_paths_visit_cb(void *UNUSED(userdata), char *path_dst, const char *path_src)
74 {
75         strcpy(path_dst, path_src);
76         BLI_path_native_slash(path_dst);
77         return !STREQ(path_dst, path_src);
78 }
79
80 /* make sure path names are correct for OS */
81 static void clean_paths(Main *main)
82 {
83         Scene *scene;
84
85         BKE_bpath_traverse_main(main, clean_paths_visit_cb, BKE_BPATH_TRAVERSE_SKIP_MULTIFILE, NULL);
86
87         for (scene = main->scene.first; scene; scene = scene->id.next) {
88                 BLI_path_native_slash(scene->r.pic);
89         }
90 }
91
92 static bool wm_scene_is_visible(wmWindowManager *wm, Scene *scene)
93 {
94         wmWindow *win;
95         for (win = wm->windows.first; win; win = win->next) {
96                 if (win->screen->scene == scene) {
97                         return true;
98                 }
99         }
100         return false;
101 }
102
103 /**
104  * Context matching, handle no-ui case
105  *
106  * \note this is called on Undo so any slow conversion functions here
107  * should be avoided or check (mode != LOAD_UNDO).
108  *
109  * \param bfd: Blend file data, freed by this function on exit.
110  * \param filepath: File path or identifier.
111  */
112 static void setup_app_data(
113         bContext *C, BlendFileData *bfd,
114         const char *filepath, ReportList *reports)
115 {
116         Scene *curscene = NULL;
117         const bool is_startup = (bfd->filename[0] == '\0');
118         const bool recover = (G.fileflags & G_FILE_RECOVER) != 0;
119         enum {
120                 LOAD_UI = 1,
121                 LOAD_UI_OFF,
122                 LOAD_UNDO,
123         } mode;
124
125         /* may happen with library files - UNDO file should never have NULL cursccene... */
126         if (ELEM(NULL, bfd->curscreen, bfd->curscene)) {
127                 BKE_report(reports, RPT_WARNING, "Library file, loading empty scene");
128                 mode = LOAD_UI_OFF;
129         }
130         else if (BLI_listbase_is_empty(&bfd->main->screen)) {
131                 mode = LOAD_UNDO;
132         }
133         else if ((G.fileflags & G_FILE_NO_UI) && (is_startup == false)) {
134                 mode = LOAD_UI_OFF;
135         }
136         else {
137                 mode = LOAD_UI;
138         }
139
140         /* Free all render results, without this stale data gets displayed after loading files */
141         if (mode != LOAD_UNDO) {
142                 RE_FreeAllRenderResults();
143         }
144
145         /* Only make filepaths compatible when loading for real (not undo) */
146         if (mode != LOAD_UNDO) {
147                 clean_paths(bfd->main);
148         }
149
150         /* XXX here the complex windowmanager matching */
151
152         /* no load screens? */
153         if (mode != LOAD_UI) {
154                 /* Logic for 'track_undo_scene' is to keep using the scene which the active screen has,
155                  * as long as the scene associated with the undo operation is visible in one of the open windows.
156                  *
157                  * - 'curscreen->scene' - scene the user is currently looking at.
158                  * - 'bfd->curscene' - scene undo-step was created in.
159                  *
160                  * This means users can have 2+ windows open and undo in both without screens switching.
161                  * But if they close one of the screens,
162                  * undo will ensure that the scene being operated on will be activated
163                  * (otherwise we'd be undoing on an off-screen scene which isn't acceptable).
164                  * see: T43424
165                  */
166                 bScreen *curscreen = NULL;
167                 bool track_undo_scene;
168
169                 /* comes from readfile.c */
170                 SWAP(ListBase, G.main->wm, bfd->main->wm);
171                 SWAP(ListBase, G.main->screen, bfd->main->screen);
172
173                 /* we re-use current screen */
174                 curscreen = CTX_wm_screen(C);
175                 /* but use new Scene pointer */
176                 curscene = bfd->curscene;
177
178                 track_undo_scene = (mode == LOAD_UNDO && curscreen && curscene && bfd->main->wm.first);
179
180                 if (curscene == NULL) {
181                         curscene = bfd->main->scene.first;
182                 }
183                 /* empty file, we add a scene to make Blender work */
184                 if (curscene == NULL) {
185                         curscene = BKE_scene_add(bfd->main, "Empty");
186                 }
187
188                 if (track_undo_scene) {
189                         /* keep the old (free'd) scene, let 'blo_lib_link_screen_restore'
190                          * replace it with 'curscene' if its needed */
191                 }
192                 else {
193                         /* and we enforce curscene to be in current screen */
194                         if (curscreen) {
195                                 /* can run in bgmode */
196                                 curscreen->scene = curscene;
197                         }
198                 }
199
200                 /* BKE_blender_globals_clear will free G.main, here we can still restore pointers */
201                 blo_lib_link_screen_restore(bfd->main, curscreen, curscene);
202                 /* curscreen might not be set when loading without ui (see T44217) so only re-assign if available */
203                 if (curscreen) {
204                         curscene = curscreen->scene;
205                 }
206
207                 if (track_undo_scene) {
208                         wmWindowManager *wm = bfd->main->wm.first;
209                         if (wm_scene_is_visible(wm, bfd->curscene) == false) {
210                                 curscene = bfd->curscene;
211                                 curscreen->scene = curscene;
212                                 BKE_screen_view3d_scene_sync(curscreen);
213                         }
214                 }
215         }
216
217         /* free G.main Main database */
218 //      CTX_wm_manager_set(C, NULL);
219         BKE_blender_globals_clear();
220
221         /* clear old property update cache, in case some old references are left dangling */
222         RNA_property_update_cache_free();
223
224         G.main = bfd->main;
225
226         CTX_data_main_set(C, G.main);
227
228         if (bfd->user) {
229                 /* only here free userdef themes... */
230                 BKE_blender_userdef_data_set_and_free(bfd->user);
231                 bfd->user = NULL;
232
233                 /* Security issue: any blend file could include a USER block.
234                  *
235                  * Currently we load prefs from BLENDER_STARTUP_FILE and later on load BLENDER_USERPREF_FILE,
236                  * to load the preferences defined in the users home dir.
237                  *
238                  * This means we will never accidentally (or maliciously)
239                  * enable scripts auto-execution by loading a '.blend' file.
240                  */
241                 U.flag |= USER_SCRIPT_AUTOEXEC_DISABLE;
242         }
243
244         /* case G_FILE_NO_UI or no screens in file */
245         if (mode != LOAD_UI) {
246                 /* leave entire context further unaltered? */
247                 CTX_data_scene_set(C, curscene);
248         }
249         else {
250                 /* Keep state from preferences. */
251                 const int fileflags_skip = G_FILE_FLAGS_RUNTIME;
252                 G.fileflags = (G.fileflags & fileflags_skip) | (bfd->fileflags & ~fileflags_skip);
253                 CTX_wm_manager_set(C, G.main->wm.first);
254                 CTX_wm_screen_set(C, bfd->curscreen);
255                 CTX_data_scene_set(C, bfd->curscene);
256                 CTX_wm_area_set(C, NULL);
257                 CTX_wm_region_set(C, NULL);
258                 CTX_wm_menu_set(C, NULL);
259                 curscene = bfd->curscene;
260         }
261
262         /* this can happen when active scene was lib-linked, and doesn't exist anymore */
263         if (CTX_data_scene(C) == NULL) {
264                 /* in case we don't even have a local scene, add one */
265                 if (!G.main->scene.first)
266                         BKE_scene_add(G.main, "Empty");
267
268                 CTX_data_scene_set(C, G.main->scene.first);
269                 CTX_wm_screen(C)->scene = CTX_data_scene(C);
270                 curscene = CTX_data_scene(C);
271         }
272
273         BLI_assert(curscene == CTX_data_scene(C));
274
275
276         /* special cases, override loaded flags: */
277         if (G.f != bfd->globalf) {
278                 const int flags_keep = (G_SWAP_EXCHANGE | G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
279                 bfd->globalf = (bfd->globalf & ~flags_keep) | (G.f & flags_keep);
280         }
281
282
283         G.f = bfd->globalf;
284
285 #ifdef WITH_PYTHON
286         /* let python know about new main */
287         BPY_context_update(C);
288 #endif
289
290         /* FIXME: this version patching should really be part of the file-reading code,
291          * but we still get too many unrelated data-corruption crashes otherwise... */
292         if (G.main->versionfile < 250)
293                 do_versions_ipos_to_animato(G.main);
294
295         G.main->recovered = 0;
296
297         /* startup.blend or recovered startup */
298         if (bfd->filename[0] == 0) {
299                 G.main->name[0] = 0;
300         }
301         else if (recover && G.relbase_valid) {
302                 /* in case of autosave or quit.blend, use original filename instead
303                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
304                 filepath = bfd->filename;
305                 G.main->recovered = 1;
306
307                 /* these are the same at times, should never copy to the same location */
308                 if (G.main->name != filepath)
309                         BLI_strncpy(G.main->name, filepath, FILE_MAX);
310         }
311
312         /* baseflags, groups, make depsgraph, etc */
313         /* first handle case if other windows have different scenes visible */
314         if (mode == LOAD_UI) {
315                 wmWindowManager *wm = G.main->wm.first;
316
317                 if (wm) {
318                         wmWindow *win;
319
320                         for (win = wm->windows.first; win; win = win->next) {
321                                 if (win->screen && win->screen->scene) /* zealous check... */
322                                         if (win->screen->scene != curscene)
323                                                 BKE_scene_set_background(G.main, win->screen->scene);
324                         }
325                 }
326         }
327         BKE_scene_set_background(G.main, curscene);
328
329         if (mode != LOAD_UNDO) {
330                 RE_FreeAllPersistentData();
331                 IMB_colormanagement_check_file_config(G.main);
332         }
333
334         MEM_freeN(bfd);
335
336 }
337
338 static int handle_subversion_warning(Main *main, ReportList *reports)
339 {
340         if (main->minversionfile > BLENDER_VERSION ||
341             (main->minversionfile == BLENDER_VERSION &&
342              main->minsubversionfile > BLENDER_SUBVERSION))
343         {
344                 BKE_reportf(reports, RPT_ERROR, "File written by newer Blender binary (%d.%d), expect loss of data!",
345                             main->minversionfile, main->minsubversionfile);
346         }
347
348         return 1;
349 }
350
351 int BKE_blendfile_read(
352         bContext *C, const char *filepath,
353         ReportList *reports, int skip_flags)
354 {
355         BlendFileData *bfd;
356         int retval = BKE_BLENDFILE_READ_OK;
357
358         /* don't print user-pref loading */
359         if (strstr(filepath, BLENDER_STARTUP_FILE) == NULL) {
360                 printf("Read blend: %s\n", filepath);
361         }
362
363         bfd = BLO_read_from_file(filepath, reports, skip_flags);
364         if (bfd) {
365                 if (bfd->user) {
366                         retval = BKE_BLENDFILE_READ_OK_USERPREFS;
367                 }
368
369                 if (0 == handle_subversion_warning(bfd->main, reports)) {
370                         BKE_main_free(bfd->main);
371                         MEM_freeN(bfd);
372                         bfd = NULL;
373                         retval = BKE_BLENDFILE_READ_FAIL;
374                 }
375                 else {
376                         setup_app_data(C, bfd, filepath, reports);
377                 }
378         }
379         else
380                 BKE_reports_prependf(reports, "Loading '%s' failed: ", filepath);
381
382         return (bfd ? retval : BKE_BLENDFILE_READ_FAIL);
383 }
384
385 bool BKE_blendfile_read_from_memory(
386         bContext *C, const void *filebuf, int filelength,
387         ReportList *reports, int skip_flags, bool update_defaults)
388 {
389         BlendFileData *bfd;
390
391         bfd = BLO_read_from_memory(filebuf, filelength, reports, skip_flags);
392         if (bfd) {
393                 if (update_defaults)
394                         BLO_update_defaults_startup_blend(bfd->main);
395                 setup_app_data(C, bfd, "<memory2>", reports);
396         }
397         else {
398                 BKE_reports_prepend(reports, "Loading failed: ");
399         }
400
401         return (bfd != NULL);
402 }
403
404 /* memfile is the undo buffer */
405 bool BKE_blendfile_read_from_memfile(
406         bContext *C, struct MemFile *memfile,
407         ReportList *reports, int skip_flags)
408 {
409         BlendFileData *bfd;
410
411         bfd = BLO_read_from_memfile(CTX_data_main(C), G.main->name, memfile, reports, skip_flags);
412         if (bfd) {
413                 /* remove the unused screens and wm */
414                 while (bfd->main->wm.first)
415                         BKE_libblock_free(bfd->main, bfd->main->wm.first);
416                 while (bfd->main->screen.first)
417                         BKE_libblock_free(bfd->main, bfd->main->screen.first);
418
419                 setup_app_data(C, bfd, "<memory1>", reports);
420         }
421         else {
422                 BKE_reports_prepend(reports, "Loading failed: ");
423         }
424
425         return (bfd != NULL);
426 }
427
428 /**
429  * Utility to make a file 'empty' used for startup to optionally give an empty file.
430  * Handy for tests.
431  */
432 void BKE_blendfile_read_make_empty(bContext *C)
433 {
434         Main *bmain = CTX_data_main(C);
435
436         ListBase *lbarray[MAX_LIBARRAY];
437         ID *id;
438         int a;
439
440         a = set_listbasepointers(bmain, lbarray);
441         while (a--) {
442                 id = lbarray[a]->first;
443                 if (id != NULL) {
444                         if (ELEM(GS(id->name), ID_SCE, ID_SCR, ID_WM)) {
445                                 continue;
446                         }
447                         while ((id = lbarray[a]->first)) {
448                                 BKE_libblock_delete(bmain, id);
449                         }
450                 }
451         }
452 }
453
454 /* only read the userdef from a .blend */
455 UserDef *BKE_blendfile_userdef_read(const char *filepath, ReportList *reports)
456 {
457         BlendFileData *bfd;
458         UserDef *userdef = NULL;
459
460         bfd = BLO_read_from_file(filepath, reports, BLO_READ_SKIP_ALL & ~BLO_READ_SKIP_USERDEF);
461         if (bfd) {
462                 if (bfd->user) {
463                         userdef = bfd->user;
464                 }
465                 BKE_main_free(bfd->main);
466                 MEM_freeN(bfd);
467         }
468
469         return userdef;
470 }
471
472
473 UserDef *BKE_blendfile_userdef_read_from_memory(
474         const void *filebuf, int filelength,
475         ReportList *reports)
476 {
477         BlendFileData *bfd;
478         UserDef *userdef = NULL;
479
480         bfd = BLO_read_from_memory(filebuf, filelength, reports, BLO_READ_SKIP_ALL & ~BLO_READ_SKIP_USERDEF);
481         if (bfd) {
482                 if (bfd->user) {
483                         userdef = bfd->user;
484                 }
485                 BKE_main_free(bfd->main);
486                 MEM_freeN(bfd);
487         }
488         else {
489                 BKE_reports_prepend(reports, "Loading failed: ");
490         }
491
492         return userdef;
493 }
494
495
496 /**
497  * Only write the userdef in a .blend
498  * \return success
499  */
500 bool BKE_blendfile_userdef_write(const char *filepath, ReportList *reports)
501 {
502         Main *mainb = MEM_callocN(sizeof(Main), "empty main");
503         bool ok = false;
504
505         if (BLO_write_file(mainb, filepath, G_FILE_USERPREFS, reports, NULL)) {
506                 ok = true;
507         }
508
509         MEM_freeN(mainb);
510
511         return ok;
512 }
513
514 /**
515  * Only write the userdef in a .blend, merging with the existing blend file.
516  * \return success
517  *
518  * \note In the future we should re-evaluate user preferences,
519  * possibly splitting out system/hardware specific prefs.
520  */
521 bool BKE_blendfile_userdef_write_app_template(const char *filepath, ReportList *reports)
522 {
523         /* if it fails, overwrite is OK. */
524         UserDef *userdef_default = BKE_blendfile_userdef_read(filepath, NULL);
525         if (userdef_default == NULL) {
526                 return BKE_blendfile_userdef_write(filepath, reports);
527         }
528
529         BKE_blender_userdef_app_template_data_swap(&U, userdef_default);
530         bool ok = BKE_blendfile_userdef_write(filepath, reports);
531         BKE_blender_userdef_app_template_data_swap(&U, userdef_default);
532         BKE_blender_userdef_data_free(userdef_default, false);
533         MEM_freeN(userdef_default);
534         return ok;
535 }
536
537
538 /** \} */
539
540
541 /* -------------------------------------------------------------------- */
542
543 /** \name Partial `.blend` file save.
544  * \{ */
545
546 void BKE_blendfile_write_partial_begin(Main *bmain_src)
547 {
548         BKE_main_id_tag_all(bmain_src, LIB_TAG_NEED_EXPAND | LIB_TAG_DOIT, false);
549 }
550
551 void BKE_blendfile_write_partial_tag_ID(ID *id, bool set)
552 {
553         if (set) {
554                 id->tag |= LIB_TAG_NEED_EXPAND | LIB_TAG_DOIT;
555         }
556         else {
557                 id->tag &= ~(LIB_TAG_NEED_EXPAND | LIB_TAG_DOIT);
558         }
559 }
560
561 static void blendfile_write_partial_cb(void *UNUSED(handle), Main *UNUSED(bmain), void *vid)
562 {
563         if (vid) {
564                 ID *id = vid;
565                 /* only tag for need-expand if not done, prevents eternal loops */
566                 if ((id->tag & LIB_TAG_DOIT) == 0)
567                         id->tag |= LIB_TAG_NEED_EXPAND | LIB_TAG_DOIT;
568
569                 if (id->lib && (id->lib->id.tag & LIB_TAG_DOIT) == 0)
570                         id->lib->id.tag |= LIB_TAG_DOIT;
571         }
572 }
573
574 /**
575  * \return Success.
576  */
577 bool BKE_blendfile_write_partial(
578         Main *bmain_src, const char *filepath, const int write_flags, ReportList *reports)
579 {
580         Main *bmain_dst = MEM_callocN(sizeof(Main), "copybuffer");
581         ListBase *lbarray_dst[MAX_LIBARRAY], *lbarray_src[MAX_LIBARRAY];
582         int a, retval;
583
584         void     *path_list_backup = NULL;
585         const int path_list_flag = (BKE_BPATH_TRAVERSE_SKIP_LIBRARY | BKE_BPATH_TRAVERSE_SKIP_MULTIFILE);
586
587         /* This is needed to be able to load that file as a real one later
588          * (otherwise main->name will not be set at read time). */
589         BLI_strncpy(bmain_dst->name, bmain_src->name, sizeof(bmain_dst->name));
590
591         if (write_flags & G_FILE_RELATIVE_REMAP) {
592                 path_list_backup = BKE_bpath_list_backup(bmain_src, path_list_flag);
593         }
594
595         BLO_main_expander(blendfile_write_partial_cb);
596         BLO_expand_main(NULL, bmain_src);
597
598         /* move over all tagged blocks */
599         set_listbasepointers(bmain_src, lbarray_src);
600         a = set_listbasepointers(bmain_dst, lbarray_dst);
601         while (a--) {
602                 ID *id, *nextid;
603                 ListBase *lb_dst = lbarray_dst[a], *lb_src = lbarray_src[a];
604
605                 for (id = lb_src->first; id; id = nextid) {
606                         nextid = id->next;
607                         if (id->tag & LIB_TAG_DOIT) {
608                                 BLI_remlink(lb_src, id);
609                                 BLI_addtail(lb_dst, id);
610                         }
611                 }
612         }
613
614
615         /* save the buffer */
616         retval = BLO_write_file(bmain_dst, filepath, write_flags, reports, NULL);
617
618         /* move back the main, now sorted again */
619         set_listbasepointers(bmain_src, lbarray_dst);
620         a = set_listbasepointers(bmain_dst, lbarray_src);
621         while (a--) {
622                 ID *id;
623                 ListBase *lb_dst = lbarray_dst[a], *lb_src = lbarray_src[a];
624
625                 while ((id = BLI_pophead(lb_src))) {
626                         BLI_addtail(lb_dst, id);
627                         id_sort_by_name(lb_dst, id);
628                 }
629         }
630
631         MEM_freeN(bmain_dst);
632
633         if (path_list_backup) {
634                 BKE_bpath_list_restore(bmain_src, path_list_flag, path_list_backup);
635                 BKE_bpath_list_free(path_list_backup);
636         }
637
638         return retval;
639 }
640
641 void BKE_blendfile_write_partial_end(Main *bmain_src)
642 {
643         BKE_main_id_tag_all(bmain_src, LIB_TAG_NEED_EXPAND | LIB_TAG_DOIT, false);
644 }
645
646 /** \} */