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