- game engine checking for autoexec was using the wrong global flag.
[blender.git] / source / blender / windowmanager / intern / wm_files.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation 2007
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28         /* placed up here because of crappy
29          * winsock stuff.
30          */
31 #include <stdio.h>
32 #include <string.h>
33
34 #ifdef WIN32
35 #include <windows.h> /* need to include windows.h so _WIN32_IE is defined  */
36 #ifndef _WIN32_IE
37 #define _WIN32_IE 0x0400 /* minimal requirements for SHGetSpecialFolderPath on MINGW MSVC has this defined already */
38 #endif
39 #include <shlobj.h> /* for SHGetSpecialFolderPath, has to be done before BLI_winstuff because 'near' is disabled through BLI_windstuff */
40 #include <process.h> /* getpid */
41 #include "BLI_winstuff.h"
42 #else
43 #include <unistd.h> /* getpid */
44 #endif
45
46 #include "MEM_guardedalloc.h"
47 #include "MEM_CacheLimiterC-Api.h"
48
49 #include "BLI_blenlib.h"
50 #include "BLI_linklist.h"
51
52 #include "DNA_anim_types.h"
53 #include "DNA_ipo_types.h" // XXX old animation system
54 #include "DNA_object_types.h"
55 #include "DNA_space_types.h"
56 #include "DNA_userdef_types.h"
57 #include "DNA_scene_types.h"
58 #include "DNA_screen_types.h"
59 #include "DNA_windowmanager_types.h"
60
61 #include "BKE_blender.h"
62 #include "BKE_context.h"
63 #include "BKE_DerivedMesh.h"
64 #include "BKE_exotic.h"
65 #include "BKE_font.h"
66 #include "BKE_global.h"
67 #include "BKE_library.h"
68 #include "BKE_main.h"
69 #include "BKE_packedFile.h"
70 #include "BKE_report.h"
71 #include "BKE_sound.h"
72 #include "BKE_texture.h"
73 #include "BKE_utildefines.h"
74
75 #include "BLO_readfile.h"
76 #include "BLO_writefile.h"
77
78 #include "RNA_access.h"
79
80 #include "ED_datafiles.h"
81 #include "ED_object.h"
82 #include "ED_screen.h"
83 #include "ED_sculpt.h"
84 #include "ED_util.h"
85
86 #include "GHOST_C-api.h"
87
88 #include "UI_interface.h"
89
90 #include "GPU_draw.h"
91
92 #include "BPY_extern.h"
93
94 #include "WM_api.h"
95 #include "WM_types.h"
96 #include "wm.h"
97 #include "wm_window.h"
98 #include "wm_event_system.h"
99
100 static void writeBlog(void);
101
102 /* To be able to read files without windows closing, opening, moving 
103    we try to prepare for worst case:
104    - active window gets active screen from file 
105    - restoring the screens from non-active windows 
106    Best case is all screens match, in that case they get assigned to proper window  
107 */
108 static void wm_window_match_init(bContext *C, ListBase *wmlist)
109 {
110         wmWindowManager *wm= G.main->wm.first;
111         wmWindow *win, *active_win;
112         
113         *wmlist= G.main->wm;
114         G.main->wm.first= G.main->wm.last= NULL;
115         
116         active_win = CTX_wm_window(C);
117
118         /* first wrap up running stuff */
119         /* code copied from wm_init_exit.c */
120         for(wm= wmlist->first; wm; wm= wm->id.next) {
121                 
122                 WM_jobs_stop_all(wm);
123                 
124                 for(win= wm->windows.first; win; win= win->next) {
125                 
126                         CTX_wm_window_set(C, win);      /* needed by operator close callbacks */
127                         WM_event_remove_handlers(C, &win->handlers);
128                         WM_event_remove_handlers(C, &win->modalhandlers);
129                         ED_screen_exit(C, win, win->screen);
130                 }
131         }
132         
133         /* reset active window */
134         CTX_wm_window_set(C, active_win);
135
136         ED_editors_exit(C);
137         
138 return; 
139         if(wm==NULL) return;
140         if(G.fileflags & G_FILE_NO_UI) return;
141         
142         /* we take apart the used screens from non-active window */
143         for(win= wm->windows.first; win; win= win->next) {
144                 BLI_strncpy(win->screenname, win->screen->id.name, MAX_ID_NAME);
145                 if(win!=wm->winactive) {
146                         BLI_remlink(&G.main->screen, win->screen);
147                         //BLI_addtail(screenbase, win->screen);
148                 }
149         }
150 }
151
152 /* match old WM with new, 4 cases:
153   1- no current wm, no read wm: make new default
154   2- no current wm, but read wm: that's OK, do nothing
155   3- current wm, but not in file: try match screen names
156   4- current wm, and wm in file: try match ghostwin 
157 */
158
159 static void wm_window_match_do(bContext *C, ListBase *oldwmlist)
160 {
161         wmWindowManager *oldwm, *wm;
162         wmWindow *oldwin, *win;
163         
164         /* cases 1 and 2 */
165         if(oldwmlist->first==NULL) {
166                 if(G.main->wm.first); /* nothing todo */
167                 else
168                         wm_add_default(C);
169         }
170         else {
171                 /* cases 3 and 4 */
172                 
173                 /* we've read file without wm..., keep current one entirely alive */
174                 if(G.main->wm.first==NULL) {
175                         bScreen *screen= CTX_wm_screen(C);
176                         
177                         /* match oldwm to new dbase, only old files */
178                         
179                         for(wm= oldwmlist->first; wm; wm= wm->id.next) {
180                                 
181                                 for(win= wm->windows.first; win; win= win->next) {
182                                         /* all windows get active screen from file */
183                                         if(screen->winid==0)
184                                                 win->screen= screen;
185                                         else 
186                                                 win->screen= ED_screen_duplicate(win, screen);
187                                         
188                                         BLI_strncpy(win->screenname, win->screen->id.name+2, 21);
189                                         win->screen->winid= win->winid;
190                                 }
191                         }
192                         
193                         G.main->wm= *oldwmlist;
194                         
195                         /* screens were read from file! */
196                         ED_screens_initialize(G.main->wm.first);
197                 }
198                 else {
199                         /* what if old was 3, and loaded 1? */
200                         /* this code could move to setup_appdata */
201                         oldwm= oldwmlist->first;
202                         wm= G.main->wm.first;
203
204                         /* ensure making new keymaps and set space types */
205                         wm->initialized= 0;
206                         wm->winactive= NULL;
207                         
208                         /* only first wm in list has ghostwins */
209                         for(win= wm->windows.first; win; win= win->next) {
210                                 for(oldwin= oldwm->windows.first; oldwin; oldwin= oldwin->next) {
211                                         
212                                         if(oldwin->winid == win->winid ) {
213                                                 win->ghostwin= oldwin->ghostwin;
214                                                 win->active= oldwin->active;
215                                                 if(win->active)
216                                                         wm->winactive= win;
217
218                                                 GHOST_SetWindowUserData(win->ghostwin, win);    /* pointer back */
219                                                 oldwin->ghostwin= NULL;
220                                                 
221                                                 win->eventstate= oldwin->eventstate;
222                                                 oldwin->eventstate= NULL;
223                                                 
224                                                 /* ensure proper screen rescaling */
225                                                 win->sizex= oldwin->sizex;
226                                                 win->sizey= oldwin->sizey;
227                                                 win->posx= oldwin->posx;
228                                                 win->posy= oldwin->posy;
229                                         }
230                                 }
231                         }
232                         wm_close_and_free_all(C, oldwmlist);
233                 }
234         }
235 }
236
237 /* in case UserDef was read, we re-initialize all, and do versioning */
238 static void wm_init_userdef(bContext *C)
239 {
240         extern char btempdir[];
241
242         UI_init_userdef();
243         MEM_CacheLimiter_set_maximum(U.memcachelimit * 1024 * 1024);
244         sound_init(CTX_data_main(C));
245
246         /* set the python auto-execute setting from user prefs */
247         if (U.flag & USER_SCRIPT_AUTOEXEC_DISABLE)      G.f &= ~G_SCRIPT_AUTOEXEC;
248         else                                                                            G.f |=  G_SCRIPT_AUTOEXEC;
249
250         if(U.tempdir[0]) strncpy(btempdir, U.tempdir, FILE_MAXDIR+FILE_MAXFILE);
251 }
252
253 void WM_read_file(bContext *C, char *name, ReportList *reports)
254 {
255         int retval;
256
257         /* first try to append data from exotic file formats... */
258         /* it throws error box when file doesnt exist and returns -1 */
259         /* note; it should set some error message somewhere... (ton) */
260         retval= BKE_read_exotic(CTX_data_scene(C), name);
261         
262         /* we didn't succeed, now try to read Blender file */
263         if (retval== 0) {
264                 int G_f= G.f;
265                 ListBase wmbase;
266
267                 /* put aside screens to match with persistant windows later */
268                 /* also exit screens and editors */
269                 wm_window_match_init(C, &wmbase); 
270                 
271                 retval= BKE_read_file(C, name, NULL, reports);
272                 G.save_over = 1;
273
274                 /* this flag is initialized by the operator but overwritten on read.
275                  * need to re-enable it here else drivers + registered scripts wont work. */
276                 if(G_f & G_SCRIPT_AUTOEXEC) G.f |= G_SCRIPT_AUTOEXEC;
277                 else                                            G.f &= ~G_SCRIPT_AUTOEXEC;
278
279                 /* match the read WM with current WM */
280                 wm_window_match_do(C, &wmbase);
281                 WM_check(C); /* opens window(s), checks keymaps */
282                 
283 // XXX          mainwindow_set_filename_to_title(G.main->name);
284
285                 if(retval==2) wm_init_userdef(C);       // in case a userdef is read from regular .blend
286                 
287                 if (retval!=0) {
288                         G.relbase_valid = 1;
289                         writeBlog();
290                 }
291
292 // XXX          undo_editmode_clear();
293                 BKE_reset_undo();
294                 BKE_write_undo(C, "original");  /* save current state */
295
296                 WM_event_add_notifier(C, NC_WM|ND_FILEREAD, NULL);
297 //              refresh_interface_font();
298
299                 CTX_wm_window_set(C, NULL); /* exits queues */
300 #ifndef DISABLE_PYTHON
301                 /* run any texts that were loaded in and flagged as modules */
302                 BPY_load_user_modules(C);
303 #endif
304         }
305         else if(retval==1)
306                 BKE_write_undo(C, "Import file");
307         else if(retval == -1) {
308                 if(reports)
309                         BKE_reportf(reports, RPT_ERROR, "Can't read file \"%s\".", name);
310         }
311 }
312
313
314 /* called on startup,  (context entirely filled with NULLs) */
315 /* or called for 'New File' */
316 /* op can be NULL */
317 int WM_read_homefile(bContext *C, wmOperator *op)
318 {
319         ListBase wmbase;
320         char tstr[FILE_MAXDIR+FILE_MAXFILE], scestr[FILE_MAXDIR];
321         char *home= BLI_gethome();
322         int from_memory= op?RNA_boolean_get(op->ptr, "factory"):0;
323         int success;
324                 
325         BLI_clean(home);
326         
327         free_ttfont(); /* still weird... what does it here? */
328                 
329         G.relbase_valid = 0;
330         if (!from_memory) {
331                 BLI_make_file_string(G.sce, tstr, home, ".B25.blend");
332         }
333         strcpy(scestr, G.sce);  /* temporary store */
334         
335         /* prevent loading no UI */
336         G.fileflags &= ~G_FILE_NO_UI;
337         
338         /* put aside screens to match with persistant windows later */
339         wm_window_match_init(C, &wmbase); 
340         
341         if (!from_memory && BLI_exists(tstr)) {
342                 success = BKE_read_file(C, tstr, NULL, NULL);
343         } else {
344                 success = BKE_read_file_from_memory(C, datatoc_B_blend, datatoc_B_blend_size, NULL, NULL);
345                 if (wmbase.first == NULL) wm_clear_default_size(C);
346         }
347         
348         /* match the read WM with current WM */
349         wm_window_match_do(C, &wmbase); 
350         WM_check(C); /* opens window(s), checks keymaps */
351
352         strcpy(G.sce, scestr); /* restore */
353         
354         wm_init_userdef(C);
355         
356         /* When loading factory settings, the reset solid OpenGL lights need to be applied. */
357         if (!G.background) GPU_default_lights();
358         
359         /* XXX */
360         G.save_over = 0;        // start with save preference untitled.blend
361         G.fileflags &= ~G_FILE_AUTOPLAY;        /*  disable autoplay in .B.blend... */
362 //      mainwindow_set_filename_to_title("");   // empty string re-initializes title to "Blender"
363         
364 //      refresh_interface_font();
365         
366 //      undo_editmode_clear();
367         BKE_reset_undo();
368         BKE_write_undo(C, "original");  /* save current state */
369         
370         WM_event_add_notifier(C, NC_WM|ND_FILEREAD, NULL);
371         CTX_wm_window_set(C, NULL); /* exits queues */
372
373         return OPERATOR_FINISHED;
374 }
375
376
377 void read_Blog(void)
378 {
379         char name[FILE_MAX];
380         LinkNode *l, *lines;
381         struct RecentFile *recent;
382         char *line;
383         int num;
384
385         BLI_make_file_string("/", name, BLI_gethome(), ".Blog");
386         lines= BLI_read_file_as_lines(name);
387
388         G.recent_files.first = G.recent_files.last = NULL;
389
390         /* read list of recent opend files from .Blog to memory */
391         for (l= lines, num= 0; l && (num<U.recent_files); l= l->next) {
392                 line = l->link;
393                 if (line[0] && BLI_exists(line)) {
394                         if (num==0) 
395                                 strcpy(G.sce, line); /* note: this seems highly dodgy since the file isnt actually read. please explain. - campbell */
396                         
397                         recent = (RecentFile*)MEM_mallocN(sizeof(RecentFile),"RecentFile");
398                         BLI_addtail(&(G.recent_files), recent);
399                         recent->filename = (char*)MEM_mallocN(sizeof(char)*(strlen(line)+1), "name of file");
400                         recent->filename[0] = '\0';
401                         
402                         strcpy(recent->filename, line);
403                         num++;
404                 }
405         }
406
407         if(G.sce[0] == 0)
408                 BLI_make_file_string("/", G.sce, BLI_gethome(), "untitled.blend");
409         
410         BLI_free_file_lines(lines);
411
412 }
413
414 static void writeBlog(void)
415 {
416         struct RecentFile *recent, *next_recent;
417         char name[FILE_MAXDIR+FILE_MAXFILE];
418         FILE *fp;
419         int i;
420
421         BLI_make_file_string("/", name, BLI_gethome(), ".Blog");
422
423         recent = G.recent_files.first;
424         /* refresh .Blog of recent opened files, when current file was changed */
425         if(!(recent) || (strcmp(recent->filename, G.sce)!=0)) {
426                 fp= fopen(name, "w");
427                 if (fp) {
428                         /* add current file to the beginning of list */
429                         recent = (RecentFile*)MEM_mallocN(sizeof(RecentFile),"RecentFile");
430                         recent->filename = (char*)MEM_mallocN(sizeof(char)*(strlen(G.sce)+1), "name of file");
431                         recent->filename[0] = '\0';
432                         strcpy(recent->filename, G.sce);
433                         BLI_addhead(&(G.recent_files), recent);
434                         /* write current file to .Blog */
435                         fprintf(fp, "%s\n", recent->filename);
436                         recent = recent->next;
437                         i=1;
438                         /* write rest of recent opened files to .Blog */
439                         while((i<U.recent_files) && (recent)){
440                                 /* this prevents to have duplicities in list */
441                                 if (strcmp(recent->filename, G.sce)!=0) {
442                                         fprintf(fp, "%s\n", recent->filename);
443                                         recent = recent->next;
444                                 }
445                                 else {
446                                         next_recent = recent->next;
447                                         MEM_freeN(recent->filename);
448                                         BLI_freelinkN(&(G.recent_files), recent);
449                                         recent = next_recent;
450                                 }
451                                 i++;
452                         }
453                         fclose(fp);
454                 }
455         }
456 }
457
458 static void do_history(char *name, ReportList *reports)
459 {
460         char tempname1[FILE_MAXDIR+FILE_MAXFILE], tempname2[FILE_MAXDIR+FILE_MAXFILE];
461         int hisnr= U.versions;
462         
463         if(U.versions==0) return;
464         if(strlen(name)<2) return;
465                 
466         while(hisnr > 1) {
467                 sprintf(tempname1, "%s%d", name, hisnr-1);
468                 sprintf(tempname2, "%s%d", name, hisnr);
469         
470                 if(BLI_rename(tempname1, tempname2))
471                         BKE_report(reports, RPT_ERROR, "Unable to make version backup");
472                         
473                 hisnr--;
474         }
475                 
476         /* is needed when hisnr==1 */
477         sprintf(tempname1, "%s%d", name, hisnr);
478         
479         if(BLI_rename(name, tempname1))
480                 BKE_report(reports, RPT_ERROR, "Unable to make version backup");
481 }
482
483 void WM_write_file(bContext *C, char *target, int fileflags, ReportList *reports)
484 {
485         Library *li;
486         int len;
487         char di[FILE_MAX];
488         
489         len = strlen(target);
490         
491         if (len == 0) return;
492         if (len >= FILE_MAX) {
493                 BKE_report(reports, RPT_ERROR, "Path too long, cannot save");
494                 return;
495         }
496  
497         /* send the OnSave event */
498         for (li= G.main->library.first; li; li= li->id.next) {
499                 if (BLI_streq(li->name, target)) {
500                         BKE_report(reports, RPT_ERROR, "Cannot overwrite used library");
501                         return;
502                 }
503         }
504         
505         if (!BLO_has_bfile_extension(target) && (len+6 < FILE_MAX)) {
506                 sprintf(di, "%s.blend", target);
507         } else {
508                 strcpy(di, target);
509         }
510
511 //      if (BLI_exists(di)) {
512 // XXX          if(!saveover(di))
513 // XXX                  return; 
514 //      }
515         
516         if (G.fileflags & G_AUTOPACK) {
517                 packAll(G.main, reports);
518         }
519         
520         ED_object_exit_editmode(C, EM_DO_UNDO);
521         ED_sculpt_force_update(C);
522
523         do_history(di, reports);
524         
525         if (BLO_write_file(CTX_data_main(C), di, fileflags, reports)) {
526                 strcpy(G.sce, di);
527                 G.relbase_valid = 1;
528                 strcpy(G.main->name, di);       /* is guaranteed current file */
529
530                 G.save_over = 1; /* disable untitled.blend convention */
531
532                 if(fileflags & G_FILE_COMPRESS) G.fileflags |= G_FILE_COMPRESS;
533                 else G.fileflags &= ~G_FILE_COMPRESS;
534                 
535                 if(fileflags & G_FILE_AUTOPLAY) G.fileflags |= G_FILE_AUTOPLAY;
536                 else G.fileflags &= ~G_FILE_AUTOPLAY;
537
538                 writeBlog();
539         }
540
541 // XXX  waitcursor(0);
542 }
543
544 /* operator entry */
545 int WM_write_homefile(bContext *C, wmOperator *op)
546 {
547         wmWindowManager *wm= CTX_wm_manager(C);
548         wmWindow *win= CTX_wm_window(C);
549         char tstr[FILE_MAXDIR+FILE_MAXFILE];
550         int fileflags;
551         
552         /* check current window and close it if temp */
553         if(win->screen->full == SCREENTEMP)
554                 wm_window_close(C, wm, win);
555         
556         BLI_make_file_string("/", tstr, BLI_gethome(), ".B25.blend");
557         
558         /*  force save as regular blend file */
559         fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_AUTOPLAY | G_FILE_LOCK | G_FILE_SIGN);
560
561         BLO_write_file(CTX_data_main(C), tstr, fileflags, op->reports);
562         
563         G.save_over= 0;
564         
565         return OPERATOR_FINISHED;
566 }
567
568 /************************ autosave ****************************/
569
570 void wm_autosave_location(char *filename)
571 {
572         char pidstr[32];
573 #ifdef WIN32
574         char subdir[9];
575         char savedir[FILE_MAXDIR];
576 #endif
577
578         sprintf(pidstr, "%d.blend", abs(getpid()));
579         
580 #ifdef WIN32
581         if (!BLI_exists(U.tempdir)) {
582                 BLI_strncpy(subdir, "autosave", sizeof(subdir));
583                 BLI_make_file_string("/", savedir, BLI_gethome(), subdir);
584                 
585                 /* create a new autosave dir
586                  * function already checks for existence or not */
587                 BLI_recurdir_fileops(savedir);
588         
589                 BLI_make_file_string("/", filename, savedir, pidstr);
590                 return;
591         }
592 #endif
593         
594         BLI_make_file_string("/", filename, U.tempdir, pidstr);
595 }
596
597 void WM_autosave_init(wmWindowManager *wm)
598 {
599         wm_autosave_timer_ended(wm);
600
601         if(U.flag & USER_AUTOSAVE)
602                 wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime*60.0);
603 }
604
605 void wm_autosave_timer(const bContext *C, wmWindowManager *wm, wmTimer *wt)
606 {
607         wmWindow *win;
608         wmEventHandler *handler;
609         char filename[FILE_MAX];
610         int fileflags;
611
612         WM_event_remove_timer(wm, NULL, wm->autosavetimer);
613
614         /* if a modal operator is running, don't autosave, but try again in 10 seconds */
615         for(win=wm->windows.first; win; win=win->next) {
616                 for(handler=win->modalhandlers.first; handler; handler=handler->next) {
617                         if(handler->op) {
618                                 wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, 10.0);
619                                 return;
620                         }
621                 }
622         }
623         
624         wm_autosave_location(filename);
625
626         /*  force save as regular blend file */
627         fileflags = G.fileflags & ~(G_FILE_COMPRESS|G_FILE_AUTOPLAY |G_FILE_LOCK|G_FILE_SIGN);
628
629         /* no error reporting to console */
630         BLO_write_file(CTX_data_main(C), filename, fileflags, NULL);
631
632         /* do timer after file write, just in case file write takes a long time */
633         wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime*60.0);
634 }
635
636 void wm_autosave_timer_ended(wmWindowManager *wm)
637 {
638         if(wm->autosavetimer) {
639                 WM_event_remove_timer(wm, NULL, wm->autosavetimer);
640                 wm->autosavetimer= NULL;
641         }
642 }
643
644 void wm_autosave_delete(void)
645 {
646         char filename[FILE_MAX];
647         
648         wm_autosave_location(filename);
649
650         if(BLI_exists(filename)) {
651                 char str[FILE_MAXDIR+FILE_MAXFILE];
652                 BLI_make_file_string("/", str, U.tempdir, "quit.blend");
653
654                 /* if global undo; remove tempsave, otherwise rename */
655                 if(U.uiflag & USER_GLOBALUNDO) BLI_delete(filename, 0, 0);
656                 else BLI_rename(filename, str);
657         }
658 }
659
660 void wm_autosave_read(bContext *C, ReportList *reports)
661 {
662         char filename[FILE_MAX];
663
664         wm_autosave_location(filename);
665         WM_read_file(C, filename, reports);
666 }
667