8b87f5b0ceab3959baf5bf1032c844a0d4db348d
[blender.git] / source / blender / blenkernel / intern / blender.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/blender.c
29  *  \ingroup bke
30  */
31
32 #ifndef _GNU_SOURCE
33 /* Needed for O_NOFOLLOW on some platforms. */
34 #  define _GNU_SOURCE 1
35 #endif
36
37 #ifndef _WIN32 
38 #  include <unistd.h> // for read close
39 #else
40 #  include <io.h> // for open close read
41 #endif
42
43 #include <stdlib.h>
44 #include <stdio.h>
45 #include <stddef.h>
46 #include <string.h>
47 #include <fcntl.h>  /* for open */
48 #include <errno.h>
49
50 #include "MEM_guardedalloc.h"
51
52 #include "DNA_userdef_types.h"
53 #include "DNA_scene_types.h"
54 #include "DNA_screen_types.h"
55 #include "DNA_windowmanager_types.h"
56
57 #include "BLI_blenlib.h"
58 #include "BLI_utildefines.h"
59 #include "BLI_callbacks.h"
60
61 #include "IMB_imbuf.h"
62 #include "IMB_moviecache.h"
63
64 #include "BKE_blender.h"
65 #include "BKE_bpath.h"
66 #include "BKE_brush.h"
67 #include "BKE_context.h"
68 #include "BKE_depsgraph.h"
69 #include "BKE_global.h"
70 #include "BKE_idprop.h"
71 #include "BKE_image.h"
72 #include "BKE_ipo.h"
73 #include "BKE_library.h"
74 #include "BKE_main.h"
75 #include "BKE_node.h"
76 #include "BKE_report.h"
77 #include "BKE_scene.h"
78 #include "BKE_screen.h"
79 #include "BKE_sequencer.h"
80 #include "BKE_sound.h"
81
82 #include "RE_pipeline.h"
83
84 #include "BLF_api.h"
85
86 #include "BLO_undofile.h"
87 #include "BLO_readfile.h" 
88 #include "BLO_writefile.h" 
89
90 #include "RNA_access.h"
91
92 #include "WM_api.h" // XXXXX BAD, very BAD dependency (bad level call) - remove asap, elubie
93
94 #include "IMB_colormanagement.h"
95
96 #ifdef WITH_PYTHON
97 #  include "BPY_extern.h"
98 #endif
99
100 Global G;
101 UserDef U;
102 /* ListBase = {NULL, NULL}; */
103
104 char versionstr[48] = "";
105
106 /* ********** free ********** */
107
108 /* only to be called on exit blender */
109 void free_blender(void)
110 {
111         /* samples are in a global list..., also sets G.main->sound->sample NULL */
112         BKE_main_free(G.main);
113         G.main = NULL;
114
115         BKE_spacetypes_free();      /* after free main, it uses space callbacks */
116         
117         IMB_exit();
118         BKE_images_exit();
119         DAG_exit();
120
121         BKE_brush_system_exit();
122
123         BLI_callback_global_finalize();
124
125         BKE_sequencer_cache_destruct();
126         IMB_moviecache_destruct();
127         
128         free_nodesystem();
129 }
130
131 void initglobals(void)
132 {
133         memset(&G, 0, sizeof(Global));
134         
135         U.savetime = 1;
136
137         G.main = BKE_main_new();
138
139         strcpy(G.ima, "//");
140
141         if (BLENDER_SUBVERSION)
142                 BLI_snprintf(versionstr, sizeof(versionstr), "v%d.%02d.%d", BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION);
143         else
144                 BLI_snprintf(versionstr, sizeof(versionstr), "v%d.%02d", BLENDER_VERSION / 100, BLENDER_VERSION % 100);
145
146 #ifdef _WIN32
147         G.windowstate = 0;
148 #endif
149
150 #ifndef WITH_PYTHON_SECURITY /* default */
151         G.f |= G_SCRIPT_AUTOEXEC;
152 #else
153         G.f &= ~G_SCRIPT_AUTOEXEC;
154 #endif
155 }
156
157 /***/
158
159 static void clear_global(void) 
160 {
161 //      extern short winqueue_break;    /* screen.c */
162
163         BKE_main_free(G.main);          /* free all lib data */
164         
165 //      free_vertexpaint();
166
167         G.main = NULL;
168 }
169
170 static bool clean_paths_visit_cb(void *UNUSED(userdata), char *path_dst, const char *path_src)
171 {
172         strcpy(path_dst, path_src);
173         BLI_clean(path_dst);
174         return !STREQ(path_dst, path_src);
175 }
176
177 /* make sure path names are correct for OS */
178 static void clean_paths(Main *main)
179 {
180         Scene *scene;
181
182         BKE_bpath_traverse_main(main, clean_paths_visit_cb, BKE_BPATH_TRAVERSE_SKIP_MULTIFILE, NULL);
183
184         for (scene = main->scene.first; scene; scene = scene->id.next) {
185                 BLI_clean(scene->r.pic);
186         }
187 }
188
189 /* context matching */
190 /* handle no-ui case */
191
192 /* note, this is called on Undo so any slow conversion functions here
193  * should be avoided or check (mode!='u') */
194
195 static void setup_app_data(bContext *C, BlendFileData *bfd, const char *filepath)
196 {
197         bScreen *curscreen = NULL;
198         Scene *curscene = NULL;
199         int recover;
200         char mode;
201
202         /* 'u' = undo save, 'n' = no UI load */
203         if (BLI_listbase_is_empty(&bfd->main->screen)) mode = 'u';
204         else if (G.fileflags & G_FILE_NO_UI) mode = 'n';
205         else mode = 0;
206
207         recover = (G.fileflags & G_FILE_RECOVER);
208
209         /* Free all render results, without this stale data gets displayed after loading files */
210         if (mode != 'u') {
211                 RE_FreeAllRenderResults();
212         }
213
214         /* Only make filepaths compatible when loading for real (not undo) */
215         if (mode != 'u') {
216                 clean_paths(bfd->main);
217         }
218
219         /* XXX here the complex windowmanager matching */
220         
221         /* no load screens? */
222         if (mode) {
223                 /* comes from readfile.c */
224                 SWAP(ListBase, G.main->wm, bfd->main->wm);
225                 SWAP(ListBase, G.main->screen, bfd->main->screen);
226                 SWAP(ListBase, G.main->script, bfd->main->script);
227                 
228                 /* we re-use current screen */
229                 curscreen = CTX_wm_screen(C);
230                 /* but use new Scene pointer */
231                 curscene = bfd->curscene;
232                 if (curscene == NULL) curscene = bfd->main->scene.first;
233                 /* empty file, we add a scene to make Blender work */
234                 if (curscene == NULL) curscene = BKE_scene_add(bfd->main, "Empty");
235                 
236                 /* and we enforce curscene to be in current screen */
237                 if (curscreen) curscreen->scene = curscene;  /* can run in bgmode */
238
239                 /* clear_global will free G.main, here we can still restore pointers */
240                 blo_lib_link_screen_restore(bfd->main, curscreen, curscene);
241         }
242         
243         /* free G.main Main database */
244 //      CTX_wm_manager_set(C, NULL);
245         clear_global();
246         
247         /* clear old property update cache, in case some old references are left dangling */
248         RNA_property_update_cache_free();
249         
250         G.main = bfd->main;
251
252         CTX_data_main_set(C, G.main);
253
254         sound_init_main(G.main);
255         
256         if (bfd->user) {
257                 
258                 /* only here free userdef themes... */
259                 BKE_userdef_free();
260                 
261                 U = *bfd->user;
262                 MEM_freeN(bfd->user);
263         }
264         
265         /* case G_FILE_NO_UI or no screens in file */
266         if (mode) {
267                 /* leave entire context further unaltered? */
268                 CTX_data_scene_set(C, curscene);
269         }
270         else {
271                 G.winpos = bfd->winpos;
272                 G.displaymode = bfd->displaymode;
273                 G.fileflags = bfd->fileflags;
274                 CTX_wm_manager_set(C, G.main->wm.first);
275                 CTX_wm_screen_set(C, bfd->curscreen);
276                 CTX_data_scene_set(C, bfd->curscene);
277                 CTX_wm_area_set(C, NULL);
278                 CTX_wm_region_set(C, NULL);
279                 CTX_wm_menu_set(C, NULL);
280         }
281         
282         /* this can happen when active scene was lib-linked, and doesn't exist anymore */
283         if (CTX_data_scene(C) == NULL) {
284                 /* in case we don't even have a local scene, add one */
285                 if (!G.main->scene.first)
286                         BKE_scene_add(G.main, "Scene");
287
288                 CTX_data_scene_set(C, G.main->scene.first);
289                 CTX_wm_screen(C)->scene = CTX_data_scene(C);
290                 curscene = CTX_data_scene(C);
291         }
292
293         /* special cases, override loaded flags: */
294         if (G.f != bfd->globalf) {
295                 const int flags_keep = (G_SWAP_EXCHANGE | G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
296                 bfd->globalf = (bfd->globalf & ~flags_keep) | (G.f & flags_keep);
297         }
298
299
300         G.f = bfd->globalf;
301
302 #ifdef WITH_PYTHON
303         /* let python know about new main */
304         BPY_context_update(C);
305 #endif
306
307         if (!G.background) {
308                 //setscreen(G.curscreen);
309         }
310         
311         /* FIXME: this version patching should really be part of the file-reading code,
312          * but we still get too many unrelated data-corruption crashes otherwise... */
313         if (G.main->versionfile < 250)
314                 do_versions_ipos_to_animato(G.main);
315         
316         G.main->recovered = 0;
317         
318         /* startup.blend or recovered startup */
319         if (bfd->filename[0] == 0) {
320                 G.main->name[0] = 0;
321         }
322         else if (recover && G.relbase_valid) {
323                 /* in case of autosave or quit.blend, use original filename instead
324                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
325                 filepath = bfd->filename;
326                 G.main->recovered = 1;
327         
328                 /* these are the same at times, should never copy to the same location */
329                 if (G.main->name != filepath)
330                         BLI_strncpy(G.main->name, filepath, FILE_MAX);
331         }
332         
333         /* baseflags, groups, make depsgraph, etc */
334         /* first handle case if other windows have different scenes visible */
335         if (mode == 0) {
336                 wmWindowManager *wm = G.main->wm.first;
337                 
338                 if (wm) {
339                         wmWindow *win;
340                         
341                         for (win = wm->windows.first; win; win = win->next) {
342                                 if (win->screen && win->screen->scene) /* zealous check... */
343                                         if (win->screen->scene != CTX_data_scene(C))
344                                                 BKE_scene_set_background(G.main, win->screen->scene);
345                         }
346                 }
347         }
348         BKE_scene_set_background(G.main, CTX_data_scene(C));
349
350         if (mode != 'u') {
351                 IMB_colormanagement_check_file_config(G.main);
352         }
353
354         MEM_freeN(bfd);
355
356 }
357
358 static int handle_subversion_warning(Main *main, ReportList *reports)
359 {
360         if (main->minversionfile > BLENDER_VERSION ||
361             (main->minversionfile == BLENDER_VERSION &&
362              main->minsubversionfile > BLENDER_SUBVERSION))
363         {
364                 BKE_reportf(reports, RPT_ERROR, "File written by newer Blender binary (%d.%d), expect loss of data!",
365                             main->minversionfile, main->minsubversionfile);
366         }
367
368         return 1;
369 }
370
371 static void keymap_item_free(wmKeyMapItem *kmi)
372 {
373         if (kmi->properties) {
374                 IDP_FreeProperty(kmi->properties);
375                 MEM_freeN(kmi->properties);
376         }
377         if (kmi->ptr)
378                 MEM_freeN(kmi->ptr);
379 }
380
381 void BKE_userdef_free(void)
382 {
383         wmKeyMap *km;
384         wmKeyMapItem *kmi;
385         wmKeyMapDiffItem *kmdi;
386         bAddon *addon, *addon_next;
387
388         for (km = U.user_keymaps.first; km; km = km->next) {
389                 for (kmdi = km->diff_items.first; kmdi; kmdi = kmdi->next) {
390                         if (kmdi->add_item) {
391                                 keymap_item_free(kmdi->add_item);
392                                 MEM_freeN(kmdi->add_item);
393                         }
394                         if (kmdi->remove_item) {
395                                 keymap_item_free(kmdi->remove_item);
396                                 MEM_freeN(kmdi->remove_item);
397                         }
398                 }
399
400                 for (kmi = km->items.first; kmi; kmi = kmi->next)
401                         keymap_item_free(kmi);
402
403                 BLI_freelistN(&km->diff_items);
404                 BLI_freelistN(&km->items);
405         }
406         
407         for (addon = U.addons.first; addon; addon = addon_next) {
408                 addon_next = addon->next;
409                 if (addon->prop) {
410                         IDP_FreeProperty(addon->prop);
411                         MEM_freeN(addon->prop);
412                 }
413                 MEM_freeN(addon);
414         }
415
416         BLI_freelistN(&U.autoexec_paths);
417
418         BLI_freelistN(&U.uistyles);
419         BLI_freelistN(&U.uifonts);
420         BLI_freelistN(&U.themes);
421         BLI_freelistN(&U.user_keymaps);
422 }
423
424 /* handle changes in settings that need recalc */
425 void BKE_userdef_state(void)
426 {
427         /* prevent accidents */
428         if (U.pixelsize == 0) U.pixelsize = 1;
429         
430         BLF_default_dpi(U.pixelsize * U.dpi);
431         U.widget_unit = (U.pixelsize * U.dpi * 20 + 36) / 72;
432
433 }
434
435 int BKE_read_file(bContext *C, const char *filepath, ReportList *reports)
436 {
437         BlendFileData *bfd;
438         int retval = BKE_READ_FILE_OK;
439
440         if (strstr(filepath, BLENDER_STARTUP_FILE) == NULL) /* don't print user-pref loading */
441                 printf("read blend: %s\n", filepath);
442
443         bfd = BLO_read_from_file(filepath, reports);
444         if (bfd) {
445                 if (bfd->user) retval = BKE_READ_FILE_OK_USERPREFS;
446                 
447                 if (0 == handle_subversion_warning(bfd->main, reports)) {
448                         BKE_main_free(bfd->main);
449                         MEM_freeN(bfd);
450                         bfd = NULL;
451                         retval = BKE_READ_FILE_FAIL;
452                 }
453                 else
454                         setup_app_data(C, bfd, filepath);  // frees BFD
455         }
456         else
457                 BKE_reports_prependf(reports, "Loading '%s' failed: ", filepath);
458                 
459         return (bfd ? retval : BKE_READ_FILE_FAIL);
460 }
461
462 int BKE_read_file_from_memory(bContext *C, const void *filebuf, int filelength, ReportList *reports, int update_defaults)
463 {
464         BlendFileData *bfd;
465
466         bfd = BLO_read_from_memory(filebuf, filelength, reports);
467         if (bfd) {
468                 if (update_defaults)
469                         BLO_update_defaults_startup_blend(bfd->main);
470                 setup_app_data(C, bfd, "<memory2>");
471         }
472         else
473                 BKE_reports_prepend(reports, "Loading failed: ");
474
475         return (bfd ? 1 : 0);
476 }
477
478 /* memfile is the undo buffer */
479 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
480 {
481         BlendFileData *bfd;
482
483         bfd = BLO_read_from_memfile(CTX_data_main(C), G.main->name, memfile, reports);
484         if (bfd) {
485                 /* remove the unused screens and wm */
486                 while (bfd->main->wm.first)
487                         BKE_libblock_free_ex(bfd->main, bfd->main->wm.first, true);
488                 while (bfd->main->screen.first)
489                         BKE_libblock_free_ex(bfd->main, bfd->main->screen.first, true);
490                 
491                 setup_app_data(C, bfd, "<memory1>");
492         }
493         else
494                 BKE_reports_prepend(reports, "Loading failed: ");
495
496         return (bfd ? 1 : 0);
497 }
498
499 /* only read the userdef from a .blend */
500 int BKE_read_file_userdef(const char *filepath, ReportList *reports)
501 {
502         BlendFileData *bfd;
503         int retval = BKE_READ_FILE_FAIL;
504
505         bfd = BLO_read_from_file(filepath, reports);
506         if (bfd) {
507                 if (bfd->user) {
508                         retval = BKE_READ_FILE_OK_USERPREFS;
509
510                         /* only here free userdef themes... */
511                         BKE_userdef_free();
512
513                         U = *bfd->user;
514                         MEM_freeN(bfd->user);
515                 }
516                 BKE_main_free(bfd->main);
517                 MEM_freeN(bfd);
518         }
519         
520         return retval;
521 }
522
523 /* only write the userdef in a .blend */
524 int BKE_write_file_userdef(const char *filepath, ReportList *reports)
525 {
526         Main *mainb = MEM_callocN(sizeof(Main), "empty main");
527         int retval = 0;
528         
529         if (BLO_write_file(mainb, filepath, G_FILE_USERPREFS, reports, NULL)) {
530                 retval = 1;
531         }
532         
533         MEM_freeN(mainb);
534         
535         return retval;
536 }
537
538 /* *****************  testing for break ************* */
539
540 static void (*blender_test_break_cb)(void) = NULL;
541
542 void set_blender_test_break_cb(void (*func)(void) )
543 {
544         blender_test_break_cb = func;
545 }
546
547
548 int blender_test_break(void)
549 {
550         if (!G.background) {
551                 if (blender_test_break_cb)
552                         blender_test_break_cb();
553         }
554         
555         return (G.is_break == true);
556 }
557
558
559 /* ***************** GLOBAL UNDO *************** */
560
561 #define UNDO_DISK   0
562
563 typedef struct UndoElem {
564         struct UndoElem *next, *prev;
565         char str[FILE_MAX];
566         char name[BKE_UNDO_STR_MAX];
567         MemFile memfile;
568         uintptr_t undosize;
569 } UndoElem;
570
571 static ListBase undobase = {NULL, NULL};
572 static UndoElem *curundo = NULL;
573
574
575 static int read_undosave(bContext *C, UndoElem *uel)
576 {
577         char mainstr[sizeof(G.main->name)];
578         int success = 0, fileflags;
579         
580         /* This is needed so undoing/redoing doesn't crash with threaded previews going */
581         WM_jobs_kill_all_except(CTX_wm_manager(C), CTX_wm_screen(C));
582
583         BLI_strncpy(mainstr, G.main->name, sizeof(mainstr));    /* temporal store */
584
585         fileflags = G.fileflags;
586         G.fileflags |= G_FILE_NO_UI;
587
588         if (UNDO_DISK) 
589                 success = (BKE_read_file(C, uel->str, NULL) != BKE_READ_FILE_FAIL);
590         else
591                 success = BKE_read_file_from_memfile(C, &uel->memfile, NULL);
592
593         /* restore */
594         BLI_strncpy(G.main->name, mainstr, sizeof(G.main->name)); /* restore */
595         G.fileflags = fileflags;
596
597         if (success) {
598                 /* important not to update time here, else non keyed tranforms are lost */
599                 DAG_on_visible_update(G.main, false);
600         }
601
602         return success;
603 }
604
605 /* name can be a dynamic string */
606 void BKE_write_undo(bContext *C, const char *name)
607 {
608         uintptr_t maxmem, totmem, memused;
609         int nr /*, success */ /* UNUSED */;
610         UndoElem *uel;
611         
612         if ((U.uiflag & USER_GLOBALUNDO) == 0) {
613                 return;
614         }
615
616         if (U.undosteps == 0) {
617                 return;
618         }
619         
620         /* remove all undos after (also when curundo == NULL) */
621         while (undobase.last != curundo) {
622                 uel = undobase.last;
623                 BLI_remlink(&undobase, uel);
624                 BLO_free_memfile(&uel->memfile);
625                 MEM_freeN(uel);
626         }
627         
628         /* make new */
629         curundo = uel = MEM_callocN(sizeof(UndoElem), "undo file");
630         BLI_strncpy(uel->name, name, sizeof(uel->name));
631         BLI_addtail(&undobase, uel);
632         
633         /* and limit amount to the maximum */
634         nr = 0;
635         uel = undobase.last;
636         while (uel) {
637                 nr++;
638                 if (nr == U.undosteps) break;
639                 uel = uel->prev;
640         }
641         if (uel) {
642                 while (undobase.first != uel) {
643                         UndoElem *first = undobase.first;
644                         BLI_remlink(&undobase, first);
645                         /* the merge is because of compression */
646                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
647                         MEM_freeN(first);
648                 }
649         }
650
651
652         /* disk save version */
653         if (UNDO_DISK) {
654                 static int counter = 0;
655                 char filepath[FILE_MAX];
656                 char numstr[32];
657                 int fileflags = G.fileflags & ~(G_FILE_HISTORY); /* don't do file history on undo */
658
659                 /* calculate current filepath */
660                 counter++;
661                 counter = counter % U.undosteps;
662         
663                 BLI_snprintf(numstr, sizeof(numstr), "%d.blend", counter);
664                 BLI_make_file_string("/", filepath, BLI_temporary_dir(), numstr);
665         
666                 /* success = */ /* UNUSED */ BLO_write_file(CTX_data_main(C), filepath, fileflags, NULL, NULL);
667                 
668                 BLI_strncpy(curundo->str, filepath, sizeof(curundo->str));
669         }
670         else {
671                 MemFile *prevfile = NULL;
672                 
673                 if (curundo->prev) prevfile = &(curundo->prev->memfile);
674                 
675                 memused = MEM_get_memory_in_use();
676                 /* success = */ /* UNUSED */ BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags);
677                 curundo->undosize = MEM_get_memory_in_use() - memused;
678         }
679
680         if (U.undomemory != 0) {
681                 /* limit to maximum memory (afterwards, we can't know in advance) */
682                 totmem = 0;
683                 maxmem = ((uintptr_t)U.undomemory) * 1024 * 1024;
684
685                 /* keep at least two (original + other) */
686                 uel = undobase.last;
687                 while (uel && uel->prev) {
688                         totmem += uel->undosize;
689                         if (totmem > maxmem) break;
690                         uel = uel->prev;
691                 }
692
693                 if (uel) {
694                         if (uel->prev && uel->prev->prev)
695                                 uel = uel->prev;
696
697                         while (undobase.first != uel) {
698                                 UndoElem *first = undobase.first;
699                                 BLI_remlink(&undobase, first);
700                                 /* the merge is because of compression */
701                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
702                                 MEM_freeN(first);
703                         }
704                 }
705         }
706 }
707
708 /* 1 = an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
709 void BKE_undo_step(bContext *C, int step)
710 {
711         
712         if (step == 0) {
713                 read_undosave(C, curundo);
714         }
715         else if (step == 1) {
716                 /* curundo should never be NULL, after restart or load file it should call undo_save */
717                 if (curundo == NULL || curundo->prev == NULL) {
718                         // XXX error("No undo available");
719                 }
720                 else {
721                         if (G.debug & G_DEBUG) printf("undo %s\n", curundo->name);
722                         curundo = curundo->prev;
723                         read_undosave(C, curundo);
724                 }
725         }
726         else {
727                 /* curundo has to remain current situation! */
728                 
729                 if (curundo == NULL || curundo->next == NULL) {
730                         // XXX error("No redo available");
731                 }
732                 else {
733                         read_undosave(C, curundo->next);
734                         curundo = curundo->next;
735                         if (G.debug & G_DEBUG) printf("redo %s\n", curundo->name);
736                 }
737         }
738 }
739
740 void BKE_reset_undo(void)
741 {
742         UndoElem *uel;
743         
744         uel = undobase.first;
745         while (uel) {
746                 BLO_free_memfile(&uel->memfile);
747                 uel = uel->next;
748         }
749         
750         BLI_freelistN(&undobase);
751         curundo = NULL;
752 }
753
754 /* based on index nr it does a restore */
755 void BKE_undo_number(bContext *C, int nr)
756 {
757         curundo = BLI_findlink(&undobase, nr);
758         BKE_undo_step(C, 0);
759 }
760
761 /* go back to the last occurance of name in stack */
762 void BKE_undo_name(bContext *C, const char *name)
763 {
764         UndoElem *uel = BLI_rfindstring(&undobase, name, offsetof(UndoElem, name));
765
766         if (uel && uel->prev) {
767                 curundo = uel->prev;
768                 BKE_undo_step(C, 0);
769         }
770 }
771
772 /* name optional */
773 int BKE_undo_valid(const char *name)
774 {
775         if (name) {
776                 UndoElem *uel = BLI_rfindstring(&undobase, name, offsetof(UndoElem, name));
777                 return uel && uel->prev;
778         }
779         
780         return undobase.last != undobase.first;
781 }
782
783 /* get name of undo item, return null if no item with this index */
784 /* if active pointer, set it to 1 if true */
785 const char *BKE_undo_get_name(int nr, int *active)
786 {
787         UndoElem *uel = BLI_findlink(&undobase, nr);
788         
789         if (active) *active = 0;
790         
791         if (uel) {
792                 if (active && uel == curundo)
793                         *active = 1;
794                 return uel->name;
795         }
796         return NULL;
797 }
798
799 /**
800  * Saves .blend using undo buffer.
801  *
802  * \return success.
803  */
804 bool BKE_undo_save_file(const char *filename)
805 {
806         UndoElem *uel;
807         MemFileChunk *chunk;
808         int file, oflags;
809
810         if ((U.uiflag & USER_GLOBALUNDO) == 0) {
811                 return 0;
812         }
813
814         uel = curundo;
815         if (uel == NULL) {
816                 fprintf(stderr, "No undo buffer to save recovery file\n");
817                 return 0;
818         }
819
820         /* note: This is currently used for autosave and 'quit.blend', where _not_ following symlinks is OK,
821          * however if this is ever executed explicitly by the user, we may want to allow writing to symlinks.
822          */
823
824         oflags = O_BINARY | O_WRONLY | O_CREAT | O_TRUNC;
825 #ifdef O_NOFOLLOW
826         /* use O_NOFOLLOW to avoid writing to a symlink - use 'O_EXCL' (CVE-2008-1103) */
827         oflags |= O_NOFOLLOW;
828 #else
829         /* TODO(sergey): How to deal with symlinks on windows? */
830 #  ifndef _MSC_VER
831 #    warning "Symbolic links will be followed on undo save, possibly causing CVE-2008-1103"
832 #  endif
833 #endif
834         file = BLI_open(filename,  oflags, 0666);
835
836         if (file == -1) {
837                 fprintf(stderr, "Unable to save '%s': %s\n",
838                         filename, errno ? strerror(errno) : "Unknown error opening file");
839                 return 0;
840         }
841
842         for (chunk = uel->memfile.chunks.first; chunk; chunk = chunk->next) {
843                 if (write(file, chunk->buf, chunk->size) != chunk->size) {
844                         break;
845                 }
846         }
847         
848         close(file);
849         
850         if (chunk) {
851                 fprintf(stderr, "Unable to save '%s': %s\n",
852                         filename, errno ? strerror(errno) : "Unknown error writing file");
853                 return 0;
854         }
855         return 1;
856 }
857
858 /* sets curscene */
859 Main *BKE_undo_get_main(Scene **scene)
860 {
861         Main *mainp = NULL;
862         BlendFileData *bfd = BLO_read_from_memfile(G.main, G.main->name, &curundo->memfile, NULL);
863         
864         if (bfd) {
865                 mainp = bfd->main;
866                 if (scene)
867                         *scene = bfd->curscene;
868                 
869                 MEM_freeN(bfd);
870         }
871         
872         return mainp;
873 }
874
875 /* ************** copy paste .blend, partial saves ********** */
876
877 /* assumes data is in G.main */
878
879 void BKE_copybuffer_begin(Main *bmain)
880 {
881         /* set all id flags to zero; */
882         BKE_main_id_flag_all(bmain, LIB_NEED_EXPAND | LIB_DOIT, false);
883 }
884
885 void BKE_copybuffer_tag_ID(ID *id)
886 {
887         id->flag |= LIB_NEED_EXPAND | LIB_DOIT;
888 }
889
890 static void copybuffer_doit(void *UNUSED(handle), Main *UNUSED(bmain), void *vid)
891 {
892         if (vid) {
893                 ID *id = vid;
894                 /* only tag for need-expand if not done, prevents eternal loops */
895                 if ((id->flag & LIB_DOIT) == 0)
896                         id->flag |= LIB_NEED_EXPAND | LIB_DOIT;
897         }
898 }
899
900 /* frees main in end */
901 int BKE_copybuffer_save(const char *filename, ReportList *reports)
902 {
903         Main *mainb = MEM_callocN(sizeof(Main), "copybuffer");
904         ListBase *lbarray[MAX_LIBARRAY], *fromarray[MAX_LIBARRAY];
905         int a, retval;
906         
907         /* path backup/restore */
908         void     *path_list_backup;
909         const int path_list_flag = (BKE_BPATH_TRAVERSE_SKIP_LIBRARY | BKE_BPATH_TRAVERSE_SKIP_MULTIFILE);
910
911         path_list_backup = BKE_bpath_list_backup(G.main, path_list_flag);
912
913         BLO_main_expander(copybuffer_doit);
914         BLO_expand_main(NULL, G.main);
915         
916         /* move over all tagged blocks */
917         set_listbasepointers(G.main, fromarray);
918         a = set_listbasepointers(mainb, lbarray);
919         while (a--) {
920                 ID *id, *nextid;
921                 ListBase *lb1 = lbarray[a], *lb2 = fromarray[a];
922                 
923                 for (id = lb2->first; id; id = nextid) {
924                         nextid = id->next;
925                         if (id->flag & LIB_DOIT) {
926                                 BLI_remlink(lb2, id);
927                                 BLI_addtail(lb1, id);
928                         }
929                 }
930         }
931         
932         
933         /* save the buffer */
934         retval = BLO_write_file(mainb, filename, G_FILE_RELATIVE_REMAP, reports, NULL);
935         
936         /* move back the main, now sorted again */
937         set_listbasepointers(G.main, lbarray);
938         a = set_listbasepointers(mainb, fromarray);
939         while (a--) {
940                 ID *id;
941                 ListBase *lb1 = lbarray[a], *lb2 = fromarray[a];
942                 
943                 while ((id = BLI_pophead(lb2))) {
944                         BLI_addtail(lb1, id);
945                         id_sort_by_name(lb1, id);
946                 }
947         }
948         
949         MEM_freeN(mainb);
950         
951         /* set id flag to zero; */
952         BKE_main_id_flag_all(G.main, LIB_NEED_EXPAND | LIB_DOIT, false);
953         
954         if (path_list_backup) {
955                 BKE_bpath_list_restore(G.main, path_list_flag, path_list_backup);
956                 BKE_bpath_list_free(path_list_backup);
957         }
958
959         return retval;
960 }
961
962 /* return success (1) */
963 int BKE_copybuffer_paste(bContext *C, const char *libname, ReportList *reports)
964 {
965         Main *bmain = CTX_data_main(C);
966         Scene *scene = CTX_data_scene(C);
967         Main *mainl = NULL;
968         Library *lib;
969         BlendHandle *bh;
970                 
971         bh = BLO_blendhandle_from_file(libname, reports);
972         
973         if (bh == NULL) {
974                 /* error reports will have been made by BLO_blendhandle_from_file() */
975                 return 0;
976         }
977
978         BKE_scene_base_deselect_all(scene);
979         
980         /* tag everything, all untagged data can be made local
981          * its also generally useful to know what is new
982          *
983          * take extra care BKE_main_id_flag_all(bmain, LIB_LINK_TAG, false) is called after! */
984         BKE_main_id_flag_all(bmain, LIB_PRE_EXISTING, true);
985         
986         /* here appending/linking starts */
987         mainl = BLO_library_append_begin(bmain, &bh, libname);
988         
989         BLO_library_append_all(mainl, bh);
990
991         BLO_library_append_end(C, mainl, &bh, 0, 0);
992         
993         /* mark all library linked objects to be updated */
994         BKE_main_lib_objects_recalc_all(bmain);
995         IMB_colormanagement_check_file_config(bmain);
996         
997         /* append, rather than linking */
998         lib = BLI_findstring(&bmain->library, libname, offsetof(Library, filepath));
999         BKE_library_make_local(bmain, lib, true);
1000         
1001         /* important we unset, otherwise these object wont
1002          * link into other scenes from this blend file */
1003         BKE_main_id_flag_all(bmain, LIB_PRE_EXISTING, false);
1004         
1005         /* recreate dependency graph to include new objects */
1006         DAG_relations_tag_update(bmain);
1007         
1008         BLO_blendhandle_close(bh);
1009         /* remove library... */
1010         
1011         return 1;
1012 }