CMake build option for security report: CVE-2009-3850
[blender-staging.git] / source / blender / blenkernel / intern / blender.c
1 /*  blender.c   jan 94     MIXED MODEL
2  * 
3  * common help functions and data
4  * 
5  * $Id$
6  *
7  * ***** BEGIN GPL LICENSE BLOCK *****
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 /** \file blender/blenkernel/intern/blender.c
34  *  \ingroup bke
35  */
36
37
38 #ifndef _WIN32 
39         #include <unistd.h> // for read close
40 #else
41         #include <io.h> // for open close read
42         #define open _open
43         #define read _read
44         #define close _close
45         #define write _write
46 #endif
47
48 #include <stdlib.h>
49 #include <stdio.h>
50 #include <stddef.h>
51 #include <string.h>
52 #include <fcntl.h> // for open
53
54 #include "MEM_guardedalloc.h"
55
56 #include "DNA_userdef_types.h"
57 #include "DNA_scene_types.h"
58 #include "DNA_screen_types.h"
59 #include "DNA_sequence_types.h"
60 #include "DNA_sound_types.h"
61
62 #include "BLI_blenlib.h"
63 #include "BLI_bpath.h"
64 #include "BLI_dynstr.h"
65 #include "BLI_path_util.h"
66 #include "BLI_utildefines.h"
67
68 #include "IMB_imbuf.h"
69
70 #include "BKE_blender.h"
71 #include "BKE_context.h"
72 #include "BKE_depsgraph.h"
73 #include "BKE_displist.h"
74 #include "BKE_global.h"
75 #include "BKE_idprop.h"
76 #include "BKE_ipo.h"
77 #include "BKE_library.h"
78 #include "BKE_main.h"
79 #include "BKE_node.h"
80 #include "BKE_report.h"
81 #include "BKE_scene.h"
82 #include "BKE_screen.h"
83 #include "BKE_sequencer.h"
84
85
86 #include "BLO_undofile.h"
87 #include "BLO_readfile.h" 
88 #include "BLO_writefile.h" 
89
90 #include "BKE_utildefines.h"
91
92 #include "WM_api.h" // XXXXX BAD, very BAD dependency (bad level call) - remove asap, elubie
93
94 Global G;
95 UserDef U;
96 /* ListBase = {NULL, NULL}; */
97 short ENDIAN_ORDER;
98
99 static char versionstr[48]= "";
100
101 /* ********** free ********** */
102
103 /* only to be called on exit blender */
104 void free_blender(void)
105 {
106         /* samples are in a global list..., also sets G.main->sound->sample NULL */
107         free_main(G.main);
108         G.main= NULL;
109
110         BKE_spacetypes_free();          /* after free main, it uses space callbacks */
111         
112         IMB_exit();
113         seq_stripelem_cache_destruct();
114         
115         free_nodesystem();      
116 }
117
118 void initglobals(void)
119 {
120         memset(&G, 0, sizeof(Global));
121         
122         U.savetime= 1;
123
124         G.main= MEM_callocN(sizeof(Main), "initglobals");
125
126         strcpy(G.ima, "//");
127
128         ENDIAN_ORDER= 1;
129         ENDIAN_ORDER= (((char*)&ENDIAN_ORDER)[0])? L_ENDIAN: B_ENDIAN;
130
131         if(BLENDER_SUBVERSION)
132                 BLI_snprintf(versionstr, sizeof(versionstr), "www.blender.org %d.%d", BLENDER_VERSION, BLENDER_SUBVERSION);
133         else
134                 BLI_snprintf(versionstr, sizeof(versionstr), "www.blender.org %d", BLENDER_VERSION);
135
136 #ifdef _WIN32   // FULLSCREEN
137         G.windowstate = G_WINDOWSTATE_USERDEF;
138 #endif
139
140         G.charstart = 0x0000;
141         G.charmin = 0x0000;
142         G.charmax = 0xffff;
143
144 #ifndef WITH_PYTHON_SECURITY /* default */
145         G.f |= G_SCRIPT_AUTOEXEC;
146 #else
147         G.f &= ~G_SCRIPT_AUTOEXEC;
148 #endif
149 }
150
151 /***/
152
153 static void clear_global(void) 
154 {
155 //      extern short winqueue_break;    /* screen.c */
156
157         fastshade_free_render();        /* lamps hang otherwise */
158         free_main(G.main);                      /* free all lib data */
159         
160 //      free_vertexpaint();
161
162         G.main= NULL;
163 }
164
165 /* make sure path names are correct for OS */
166 static void clean_paths(Main *main)
167 {
168         struct BPathIterator *bpi;
169         char filepath_expanded[1024];
170         Scene *scene;
171
172         for(BLI_bpathIterator_init(&bpi, main, main->name, BPATH_USE_PACKED); !BLI_bpathIterator_isDone(bpi); BLI_bpathIterator_step(bpi)) {
173                 BLI_bpathIterator_getPath(bpi, filepath_expanded);
174
175                 BLI_clean(filepath_expanded);
176
177                 BLI_bpathIterator_setPath(bpi, filepath_expanded);
178         }
179
180         BLI_bpathIterator_free(bpi);
181
182         for(scene= main->scene.first; scene; scene= scene->id.next) {
183                 BLI_clean(scene->r.backbuf);
184                 BLI_clean(scene->r.pic);
185         }
186 }
187
188 /* context matching */
189 /* handle no-ui case */
190
191 /* note, this is called on Undo so any slow conversion functions here
192  * should be avoided or check (mode!='u') */
193
194 static void setup_app_data(bContext *C, BlendFileData *bfd, const char *filename) 
195 {
196         bScreen *curscreen= NULL;
197         Scene *curscene= NULL;
198         int recover;
199         char mode;
200
201         /* 'u' = undo save, 'n' = no UI load */
202         if(bfd->main->screen.first==NULL) mode= 'u';
203         else if(G.fileflags & G_FILE_NO_UI) mode= 'n';
204         else mode= 0;
205
206         recover= (G.fileflags & G_FILE_RECOVER);
207
208         /* Only make filepaths compatible when loading for real (not undo) */
209         if(mode != 'u') {
210                 clean_paths(bfd->main);
211         }
212
213         /* XXX here the complex windowmanager matching */
214         
215         /* no load screens? */
216         if(mode) {
217                 /* comes from readfile.c */
218                 extern void lib_link_screen_restore(Main *, bScreen *, Scene *);
219                 
220                 SWAP(ListBase, G.main->wm, bfd->main->wm);
221                 SWAP(ListBase, G.main->screen, bfd->main->screen);
222                 SWAP(ListBase, G.main->script, bfd->main->script);
223                 
224                 /* we re-use current screen */
225                 curscreen= CTX_wm_screen(C);
226                 /* but use new Scene pointer */
227                 curscene= bfd->curscene;
228                 if(curscene==NULL) curscene= bfd->main->scene.first;
229                 /* and we enforce curscene to be in current screen */
230                 if(curscreen) curscreen->scene= curscene; /* can run in bgmode */
231
232                 /* clear_global will free G.main, here we can still restore pointers */
233                 lib_link_screen_restore(bfd->main, curscreen, curscene);
234         }
235         
236         /* free G.main Main database */
237 //      CTX_wm_manager_set(C, NULL);
238         clear_global(); 
239         
240         G.main= bfd->main;
241
242         CTX_data_main_set(C, G.main);
243         
244         if (bfd->user) {
245                 
246                 /* only here free userdef themes... */
247                 BKE_userdef_free();
248                 
249                 U= *bfd->user;
250                 MEM_freeN(bfd->user);
251         }
252         
253         /* case G_FILE_NO_UI or no screens in file */
254         if(mode) {
255                 /* leave entire context further unaltered? */
256                 CTX_data_scene_set(C, curscene);
257         }
258         else {
259                 G.winpos= bfd->winpos;
260                 G.displaymode= bfd->displaymode;
261                 G.fileflags= bfd->fileflags;
262                 CTX_wm_manager_set(C, bfd->main->wm.first);
263                 CTX_wm_screen_set(C, bfd->curscreen);
264                 CTX_data_scene_set(C, bfd->curscreen->scene);
265                 CTX_wm_area_set(C, NULL);
266                 CTX_wm_region_set(C, NULL);
267                 CTX_wm_menu_set(C, NULL);
268         }
269         
270         /* this can happen when active scene was lib-linked, and doesnt exist anymore */
271         if(CTX_data_scene(C)==NULL) {
272                 CTX_data_scene_set(C, bfd->main->scene.first);
273                 CTX_wm_screen(C)->scene= CTX_data_scene(C);
274                 curscene= CTX_data_scene(C);
275         }
276
277         /* special cases, override loaded flags: */
278         if(G.f != bfd->globalf) {
279                 const int flags_keep= (G_DEBUG | G_SWAP_EXCHANGE | G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
280                 bfd->globalf= (bfd->globalf & ~flags_keep) | (G.f & flags_keep);
281         }
282
283
284         G.f= bfd->globalf;
285
286         if (!G.background) {
287                 //setscreen(G.curscreen);
288         }
289         
290         // FIXME: this version patching should really be part of the file-reading code, 
291         // but we still get too many unrelated data-corruption crashes otherwise...
292         if (G.main->versionfile < 250)
293                 do_versions_ipos_to_animato(G.main);
294         
295         if(recover && bfd->filename[0] && G.relbase_valid) {
296                 /* in case of autosave or quit.blend, use original filename instead
297                  * use relbase_valid to make sure the file is saved, else we get <memory2> in the filename */
298                 filename= bfd->filename;
299         }
300 #if 0
301         else if (!G.relbase_valid) {
302                 /* otherwise, use an empty string as filename, rather than <memory2> */
303                 filename="";
304         }
305 #endif
306         
307         /* these are the same at times, should never copy to the same location */
308         if(G.main->name != filename)
309                 BLI_strncpy(G.main->name, filename, FILE_MAX);
310
311         /* baseflags, groups, make depsgraph, etc */
312         set_scene_bg(G.main, CTX_data_scene(C));
313         
314         MEM_freeN(bfd);
315 }
316
317 static int handle_subversion_warning(Main *main)
318 {
319         if(main->minversionfile > BLENDER_VERSION ||
320            (main->minversionfile == BLENDER_VERSION && 
321                  main->minsubversionfile > BLENDER_SUBVERSION)) {
322                 
323                 char str[128];
324                 
325                 BLI_snprintf(str, sizeof(str), "File written by newer Blender binary: %d.%d , expect loss of data!", main->minversionfile, main->minsubversionfile);
326 // XXX          error(str);
327         }
328         return 1;
329 }
330
331 void BKE_userdef_free(void)
332 {
333         wmKeyMap *km;
334         wmKeyMapItem *kmi;
335
336         for(km=U.keymaps.first; km; km=km->next) {
337                 for(kmi=km->items.first; kmi; kmi=kmi->next) {
338                         if(kmi->properties) {
339                                 IDP_FreeProperty(kmi->properties);
340                                 MEM_freeN(kmi->properties);
341                         }
342                         if(kmi->ptr)
343                                 MEM_freeN(kmi->ptr);
344                 }
345
346                 BLI_freelistN(&km->items);
347         }
348         
349         BLI_freelistN(&U.uistyles);
350         BLI_freelistN(&U.uifonts);
351         BLI_freelistN(&U.themes);
352         BLI_freelistN(&U.keymaps);
353         BLI_freelistN(&U.addons);
354 }
355
356 int BKE_read_file(bContext *C, const char *dir, ReportList *reports) 
357 {
358         BlendFileData *bfd;
359         int retval= BKE_READ_FILE_OK;
360
361         if(strstr(dir, BLENDER_STARTUP_FILE)==NULL) /* dont print user-pref loading */
362                 printf("read blend: %s\n", dir);
363
364         bfd= BLO_read_from_file(dir, reports);
365         if (bfd) {
366                 if(bfd->user) retval= BKE_READ_FILE_OK_USERPREFS;
367                 
368                 if(0==handle_subversion_warning(bfd->main)) {
369                         free_main(bfd->main);
370                         MEM_freeN(bfd);
371                         bfd= NULL;
372                         retval= BKE_READ_FILE_FAIL;
373                 }
374                 else
375                         setup_app_data(C, bfd, dir); // frees BFD
376         } 
377         else
378                 BKE_reports_prependf(reports, "Loading %s failed: ", dir);
379                 
380         return (bfd?retval:BKE_READ_FILE_FAIL);
381 }
382
383 int BKE_read_file_from_memory(bContext *C, char* filebuf, int filelength, ReportList *reports)
384 {
385         BlendFileData *bfd;
386
387         bfd= BLO_read_from_memory(filebuf, filelength, reports);
388         if (bfd)
389                 setup_app_data(C, bfd, "<memory2>");
390         else
391                 BKE_reports_prepend(reports, "Loading failed: ");
392
393         return (bfd?1:0);
394 }
395
396 /* memfile is the undo buffer */
397 int BKE_read_file_from_memfile(bContext *C, MemFile *memfile, ReportList *reports)
398 {
399         BlendFileData *bfd;
400
401         bfd= BLO_read_from_memfile(CTX_data_main(C), G.main->name, memfile, reports);
402         if (bfd)
403                 setup_app_data(C, bfd, "<memory1>");
404         else
405                 BKE_reports_prepend(reports, "Loading failed: ");
406
407         return (bfd?1:0);
408 }
409
410
411 /* *****************  testing for break ************* */
412
413 static void (*blender_test_break_cb)(void)= NULL;
414
415 void set_blender_test_break_cb(void (*func)(void) )
416 {
417         blender_test_break_cb= func;
418 }
419
420
421 int blender_test_break(void)
422 {
423         if (!G.background) {
424                 if (blender_test_break_cb)
425                         blender_test_break_cb();
426         }
427         
428         return (G.afbreek==1);
429 }
430
431
432 /* ***************** GLOBAL UNDO *************** */
433
434 #define UNDO_DISK       0
435
436 #define MAXUNDONAME     64
437 typedef struct UndoElem {
438         struct UndoElem *next, *prev;
439         char str[FILE_MAXDIR+FILE_MAXFILE];
440         char name[MAXUNDONAME];
441         MemFile memfile;
442         uintptr_t undosize;
443 } UndoElem;
444
445 static ListBase undobase={NULL, NULL};
446 static UndoElem *curundo= NULL;
447
448
449 static int read_undosave(bContext *C, UndoElem *uel)
450 {
451         char mainstr[sizeof(G.main->name)];
452         int success=0, fileflags;
453         
454         /* This is needed so undoing/redoing doesnt crash with threaded previews going */
455         WM_jobs_stop_all(CTX_wm_manager(C));
456
457         BLI_strncpy(mainstr, G.main->name, sizeof(mainstr));    /* temporal store */
458
459         fileflags= G.fileflags;
460         G.fileflags |= G_FILE_NO_UI;
461
462         if(UNDO_DISK) 
463                 success= (BKE_read_file(C, uel->str, NULL) != BKE_READ_FILE_FAIL);
464         else
465                 success= BKE_read_file_from_memfile(C, &uel->memfile, NULL);
466
467         /* restore */
468         BLI_strncpy(G.main->name, mainstr, sizeof(G.main->name)); /* restore */
469         G.fileflags= fileflags;
470
471         if(success) {
472                 /* important not to update time here, else non keyed tranforms are lost */
473                 DAG_on_visible_update(G.main, FALSE);
474         }
475
476         return success;
477 }
478
479 /* name can be a dynamic string */
480 void BKE_write_undo(bContext *C, const char *name)
481 {
482         uintptr_t maxmem, totmem, memused;
483         int nr, success;
484         UndoElem *uel;
485         
486         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
487         if( U.undosteps==0) return;
488         
489         /* remove all undos after (also when curundo==NULL) */
490         while(undobase.last != curundo) {
491                 uel= undobase.last;
492                 BLI_remlink(&undobase, uel);
493                 BLO_free_memfile(&uel->memfile);
494                 MEM_freeN(uel);
495         }
496         
497         /* make new */
498         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
499         strncpy(uel->name, name, MAXUNDONAME-1);
500         BLI_addtail(&undobase, uel);
501         
502         /* and limit amount to the maximum */
503         nr= 0;
504         uel= undobase.last;
505         while(uel) {
506                 nr++;
507                 if(nr==U.undosteps) break;
508                 uel= uel->prev;
509         }
510         if(uel) {
511                 while(undobase.first!=uel) {
512                         UndoElem *first= undobase.first;
513                         BLI_remlink(&undobase, first);
514                         /* the merge is because of compression */
515                         BLO_merge_memfile(&first->memfile, &first->next->memfile);
516                         MEM_freeN(first);
517                 }
518         }
519
520
521         /* disk save version */
522         if(UNDO_DISK) {
523                 static int counter= 0;
524                 char tstr[FILE_MAXDIR+FILE_MAXFILE];
525                 char numstr[32];
526                 
527                 /* calculate current filename */
528                 counter++;
529                 counter= counter % U.undosteps; 
530         
531                 BLI_snprintf(numstr, sizeof(numstr), "%d.blend", counter);
532                 BLI_make_file_string("/", tstr, btempdir, numstr);
533         
534                 success= BLO_write_file(CTX_data_main(C), tstr, G.fileflags, NULL, NULL);
535                 
536                 BLI_strncpy(curundo->str, tstr, sizeof(curundo->str));
537         }
538         else {
539                 MemFile *prevfile=NULL;
540                 
541                 if(curundo->prev) prevfile= &(curundo->prev->memfile);
542                 
543                 memused= MEM_get_memory_in_use();
544                 success= BLO_write_file_mem(CTX_data_main(C), prevfile, &curundo->memfile, G.fileflags);
545                 curundo->undosize= MEM_get_memory_in_use() - memused;
546         }
547
548         if(U.undomemory != 0) {
549                 /* limit to maximum memory (afterwards, we can't know in advance) */
550                 totmem= 0;
551                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
552
553                 /* keep at least two (original + other) */
554                 uel= undobase.last;
555                 while(uel && uel->prev) {
556                         totmem+= uel->undosize;
557                         if(totmem>maxmem) break;
558                         uel= uel->prev;
559                 }
560
561                 if(uel) {
562                         if(uel->prev && uel->prev->prev)
563                                 uel= uel->prev;
564
565                         while(undobase.first!=uel) {
566                                 UndoElem *first= undobase.first;
567                                 BLI_remlink(&undobase, first);
568                                 /* the merge is because of compression */
569                                 BLO_merge_memfile(&first->memfile, &first->next->memfile);
570                                 MEM_freeN(first);
571                         }
572                 }
573         }
574 }
575
576 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
577 void BKE_undo_step(bContext *C, int step)
578 {
579         
580         if(step==0) {
581                 read_undosave(C, curundo);
582         }
583         else if(step==1) {
584                 /* curundo should never be NULL, after restart or load file it should call undo_save */
585                 if(curundo==NULL || curundo->prev==NULL) ; // XXX error("No undo available");
586                 else {
587                         if(G.f & G_DEBUG) printf("undo %s\n", curundo->name);
588                         curundo= curundo->prev;
589                         read_undosave(C, curundo);
590                 }
591         }
592         else {
593                 
594                 /* curundo has to remain current situation! */
595                 
596                 if(curundo==NULL || curundo->next==NULL) ; // XXX error("No redo available");
597                 else {
598                         read_undosave(C, curundo->next);
599                         curundo= curundo->next;
600                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
601                 }
602         }
603 }
604
605 void BKE_reset_undo(void)
606 {
607         UndoElem *uel;
608         
609         uel= undobase.first;
610         while(uel) {
611                 BLO_free_memfile(&uel->memfile);
612                 uel= uel->next;
613         }
614         
615         BLI_freelistN(&undobase);
616         curundo= NULL;
617 }
618
619 /* based on index nr it does a restore */
620 void BKE_undo_number(bContext *C, int nr)
621 {
622         UndoElem *uel;
623         int a=1;
624         
625         for(uel= undobase.first; uel; uel= uel->next, a++) {
626                 if(a==nr) break;
627         }
628         curundo= uel;
629         BKE_undo_step(C, 0);
630 }
631
632 /* go back to the last occurance of name in stack */
633 void BKE_undo_name(bContext *C, const char *name)
634 {
635         UndoElem *uel;
636
637         for(uel= undobase.last; uel; uel= uel->prev)
638                 if(strcmp(name, uel->name)==0)
639                         break;
640
641         if(uel && uel->prev) {
642                 curundo= uel->prev;
643                 BKE_undo_step(C, 0);
644         }
645 }
646
647 /* name optional */
648 int BKE_undo_valid(const char *name)
649 {
650         if(name) {
651                 UndoElem *uel;
652                 
653                 for(uel= undobase.last; uel; uel= uel->prev)
654                         if(strcmp(name, uel->name)==0)
655                                 break;
656                 
657                 return uel && uel->prev;
658         }
659         
660         return undobase.last != undobase.first;
661 }
662
663
664 char *BKE_undo_menu_string(void)
665 {
666         UndoElem *uel;
667         DynStr *ds= BLI_dynstr_new();
668         char *menu;
669
670         BLI_dynstr_append(ds, "Global Undo History %t");
671         
672         for(uel= undobase.first; uel; uel= uel->next) {
673                 BLI_dynstr_append(ds, "|");
674                 BLI_dynstr_append(ds, uel->name);
675         }
676
677         menu= BLI_dynstr_get_cstring(ds);
678         BLI_dynstr_free(ds);
679
680         return menu;
681 }
682
683         /* saves quit.blend */
684 void BKE_undo_save_quit(void)
685 {
686         UndoElem *uel;
687         MemFileChunk *chunk;
688         int file;
689         char str[FILE_MAXDIR+FILE_MAXFILE];
690         
691         if( (U.uiflag & USER_GLOBALUNDO)==0) return;
692         
693         uel= curundo;
694         if(uel==NULL) {
695                 printf("No undo buffer to save recovery file\n");
696                 return;
697         }
698         
699         /* no undo state to save */
700         if(undobase.first==undobase.last) return;
701                 
702         BLI_make_file_string("/", str, btempdir, "quit.blend");
703
704         file = open(str,O_BINARY+O_WRONLY+O_CREAT+O_TRUNC, 0666);
705         if(file == -1) {
706                 //XXX error("Unable to save %s, check you have permissions", str);
707                 return;
708         }
709
710         chunk= uel->memfile.chunks.first;
711         while(chunk) {
712                 if( write(file, chunk->buf, chunk->size) != chunk->size) break;
713                 chunk= chunk->next;
714         }
715         
716         close(file);
717         
718         if(chunk) ; //XXX error("Unable to save %s, internal error", str);
719         else printf("Saved session recovery to %s\n", str);
720 }
721
722 /* sets curscene */
723 Main *BKE_undo_get_main(Scene **scene)
724 {
725         Main *mainp= NULL;
726         BlendFileData *bfd= BLO_read_from_memfile(G.main, G.main->name, &curundo->memfile, NULL);
727         
728         if(bfd) {
729                 mainp= bfd->main;
730                 if(scene)
731                         *scene= bfd->curscene;
732                 
733                 MEM_freeN(bfd);
734         }
735         
736         return mainp;
737 }
738