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