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