ability to have permanent callbacks that stay active when new blend files are loaded.
[blender.git] / source / blender / windowmanager / intern / wm_files.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  * Contributor(s): Blender Foundation 2007
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/windowmanager/intern/wm_files.c
27  *  \ingroup wm
28  */
29
30
31         /* placed up here because of crappy
32          * winsock stuff.
33          */
34 #include <stddef.h>
35 #include <string.h>
36 #include <errno.h>
37
38 #include "zlib.h" /* wm_read_exotic() */
39
40 #ifdef WIN32
41 #include <windows.h> /* need to include windows.h so _WIN32_IE is defined  */
42 #ifndef _WIN32_IE
43 #define _WIN32_IE 0x0400 /* minimal requirements for SHGetSpecialFolderPath on MINGW MSVC has this defined already */
44 #endif
45 #include <shlobj.h> /* for SHGetSpecialFolderPath, has to be done before BLI_winstuff because 'near' is disabled through BLI_windstuff */
46 #include <process.h> /* getpid */
47 #include "BLI_winstuff.h"
48 #else
49 #include <unistd.h> /* getpid */
50 #endif
51
52 #include "MEM_guardedalloc.h"
53 #include "MEM_CacheLimiterC-Api.h"
54
55 #include "BLI_blenlib.h"
56 #include "BLI_linklist.h"
57 #include "BLI_utildefines.h"
58 #include "BLI_callbacks.h"
59
60 #include "BLF_translation.h"
61
62 #include "DNA_anim_types.h"
63 #include "DNA_ipo_types.h" // XXX old animation system
64 #include "DNA_object_types.h"
65 #include "DNA_space_types.h"
66 #include "DNA_userdef_types.h"
67 #include "DNA_scene_types.h"
68 #include "DNA_screen_types.h"
69 #include "DNA_windowmanager_types.h"
70
71 #include "BKE_blender.h"
72 #include "BKE_context.h"
73 #include "BKE_depsgraph.h"
74 #include "BKE_DerivedMesh.h"
75 #include "BKE_font.h"
76 #include "BKE_global.h"
77 #include "BKE_library.h"
78 #include "BKE_main.h"
79 #include "BKE_packedFile.h"
80 #include "BKE_report.h"
81 #include "BKE_sound.h"
82 #include "BKE_texture.h"
83
84
85 #include "BLO_readfile.h"
86 #include "BLO_writefile.h"
87
88 #include "RNA_access.h"
89
90 #include "IMB_imbuf.h"
91 #include "IMB_imbuf_types.h"
92 #include "IMB_thumbs.h"
93
94 #include "ED_datafiles.h"
95 #include "ED_object.h"
96 #include "ED_screen.h"
97 #include "ED_sculpt.h"
98 #include "ED_view3d.h"
99 #include "ED_util.h"
100
101 #include "RE_pipeline.h" /* only to report missing engine */
102
103 #include "GHOST_C-api.h"
104 #include "GHOST_Path-api.h"
105
106 #include "UI_interface.h"
107
108 #include "GPU_draw.h"
109
110 #ifdef WITH_PYTHON
111 #include "BPY_extern.h"
112 #endif
113
114 #include "WM_api.h"
115 #include "WM_types.h"
116 #include "wm.h"
117 #include "wm_files.h"
118 #include "wm_window.h"
119 #include "wm_event_system.h"
120
121 static void write_history(void);
122
123 /* To be able to read files without windows closing, opening, moving 
124    we try to prepare for worst case:
125    - active window gets active screen from file 
126    - restoring the screens from non-active windows 
127    Best case is all screens match, in that case they get assigned to proper window  
128 */
129 static void wm_window_match_init(bContext *C, ListBase *wmlist)
130 {
131         wmWindowManager *wm;
132         wmWindow *win, *active_win;
133         
134         *wmlist= G.main->wm;
135         G.main->wm.first= G.main->wm.last= NULL;
136         
137         active_win = CTX_wm_window(C);
138
139         /* first wrap up running stuff */
140         /* code copied from wm_init_exit.c */
141         for(wm= wmlist->first; wm; wm= wm->id.next) {
142                 
143                 WM_jobs_stop_all(wm);
144                 
145                 for(win= wm->windows.first; win; win= win->next) {
146                 
147                         CTX_wm_window_set(C, win);      /* needed by operator close callbacks */
148                         WM_event_remove_handlers(C, &win->handlers);
149                         WM_event_remove_handlers(C, &win->modalhandlers);
150                         ED_screen_exit(C, win, win->screen);
151                 }
152         }
153         
154         /* reset active window */
155         CTX_wm_window_set(C, active_win);
156
157         ED_editors_exit(C);
158         
159 return; 
160         if(wm==NULL) return;
161         if(G.fileflags & G_FILE_NO_UI) return;
162         
163         /* we take apart the used screens from non-active window */
164         for(win= wm->windows.first; win; win= win->next) {
165                 BLI_strncpy(win->screenname, win->screen->id.name, MAX_ID_NAME);
166                 if(win!=wm->winactive) {
167                         BLI_remlink(&G.main->screen, win->screen);
168                         //BLI_addtail(screenbase, win->screen);
169                 }
170         }
171 }
172
173 /* match old WM with new, 4 cases:
174   1- no current wm, no read wm: make new default
175   2- no current wm, but read wm: that's OK, do nothing
176   3- current wm, but not in file: try match screen names
177   4- current wm, and wm in file: try match ghostwin 
178 */
179
180 static void wm_window_match_do(bContext *C, ListBase *oldwmlist)
181 {
182         wmWindowManager *oldwm, *wm;
183         wmWindow *oldwin, *win;
184         
185         /* cases 1 and 2 */
186         if(oldwmlist->first==NULL) {
187                 if(G.main->wm.first); /* nothing todo */
188                 else
189                         wm_add_default(C);
190         }
191         else {
192                 /* cases 3 and 4 */
193                 
194                 /* we've read file without wm..., keep current one entirely alive */
195                 if(G.main->wm.first==NULL) {
196                         /* when loading without UI, no matching needed */
197                         if(!(G.fileflags & G_FILE_NO_UI)) {
198                                 bScreen *screen= CTX_wm_screen(C);
199
200                                 /* match oldwm to new dbase, only old files */
201                                 for(wm= oldwmlist->first; wm; wm= wm->id.next) {
202                                         
203                                         for(win= wm->windows.first; win; win= win->next) {
204                                                 /* all windows get active screen from file */
205                                                 if(screen->winid==0)
206                                                         win->screen= screen;
207                                                 else 
208                                                         win->screen= ED_screen_duplicate(win, screen);
209                                                 
210                                                 BLI_strncpy(win->screenname, win->screen->id.name+2, sizeof(win->screenname));
211                                                 win->screen->winid= win->winid;
212                                         }
213                                 }
214                         }
215                         
216                         G.main->wm= *oldwmlist;
217                         
218                         /* screens were read from file! */
219                         ED_screens_initialize(G.main->wm.first);
220                 }
221                 else {
222                         /* what if old was 3, and loaded 1? */
223                         /* this code could move to setup_appdata */
224                         oldwm= oldwmlist->first;
225                         wm= G.main->wm.first;
226
227                         /* preserve key configurations in new wm, to preserve their keymaps */
228                         wm->keyconfigs= oldwm->keyconfigs;
229                         wm->addonconf= oldwm->addonconf;
230                         wm->defaultconf= oldwm->defaultconf;
231                         wm->userconf= oldwm->userconf;
232
233                         oldwm->keyconfigs.first= oldwm->keyconfigs.last= NULL;
234                         oldwm->addonconf= NULL;
235                         oldwm->defaultconf= NULL;
236                         oldwm->userconf= NULL;
237
238                         /* ensure making new keymaps and set space types */
239                         wm->initialized= 0;
240                         wm->winactive= NULL;
241                         
242                         /* only first wm in list has ghostwins */
243                         for(win= wm->windows.first; win; win= win->next) {
244                                 for(oldwin= oldwm->windows.first; oldwin; oldwin= oldwin->next) {
245                                         
246                                         if(oldwin->winid == win->winid ) {
247                                                 win->ghostwin= oldwin->ghostwin;
248                                                 win->active= oldwin->active;
249                                                 if(win->active)
250                                                         wm->winactive= win;
251
252                                                 if(!G.background) /* file loading in background mode still calls this */
253                                                         GHOST_SetWindowUserData(win->ghostwin, win);    /* pointer back */
254
255                                                 oldwin->ghostwin= NULL;
256                                                 
257                                                 win->eventstate= oldwin->eventstate;
258                                                 oldwin->eventstate= NULL;
259                                                 
260                                                 /* ensure proper screen rescaling */
261                                                 win->sizex= oldwin->sizex;
262                                                 win->sizey= oldwin->sizey;
263                                                 win->posx= oldwin->posx;
264                                                 win->posy= oldwin->posy;
265                                         }
266                                 }
267                         }
268                         wm_close_and_free_all(C, oldwmlist);
269                 }
270         }
271 }
272
273 /* in case UserDef was read, we re-initialize all, and do versioning */
274 static void wm_init_userdef(bContext *C)
275 {
276         UI_init_userdef();
277         MEM_CacheLimiter_set_maximum(U.memcachelimit * 1024 * 1024);
278         sound_init(CTX_data_main(C));
279
280         /* needed so loading a file from the command line respects user-pref [#26156] */
281         if(U.flag & USER_FILENOUI)      G.fileflags |= G_FILE_NO_UI;
282         else                                            G.fileflags &= ~G_FILE_NO_UI;
283
284         /* set the python auto-execute setting from user prefs */
285         /* enabled by default, unless explicitly enabled in the command line which overrides */
286         if((G.f & G_SCRIPT_OVERRIDE_PREF) == 0) {
287                 if ((U.flag & USER_SCRIPT_AUTOEXEC_DISABLE) == 0) G.f |=  G_SCRIPT_AUTOEXEC;
288                 else                                                                                      G.f &= ~G_SCRIPT_AUTOEXEC;
289         }
290
291         /* update tempdir from user preferences */
292         BLI_init_temporary_dir(U.tempdir);
293 }
294
295
296
297 /* return codes */
298 #define BKE_READ_EXOTIC_FAIL_PATH               -3 /* file format is not supported */
299 #define BKE_READ_EXOTIC_FAIL_FORMAT             -2 /* file format is not supported */
300 #define BKE_READ_EXOTIC_FAIL_OPEN               -1 /* Can't open the file */
301 #define BKE_READ_EXOTIC_OK_BLEND                 0 /* .blend file */
302 #define BKE_READ_EXOTIC_OK_OTHER                 1 /* other supported formats */
303
304 /* intended to check for non-blender formats but for now it only reads blends */
305 static int wm_read_exotic(Scene *UNUSED(scene), const char *name)
306 {
307         int len;
308         gzFile gzfile;
309         char header[7];
310         int retval;
311
312         // make sure we're not trying to read a directory....
313
314         len= strlen(name);
315         if (ELEM(name[len-1], '/', '\\')) {
316                 retval= BKE_READ_EXOTIC_FAIL_PATH;
317         }
318         else {
319                 gzfile = gzopen(name,"rb");
320
321                 if (gzfile == NULL) {
322                         retval= BKE_READ_EXOTIC_FAIL_OPEN;
323                 }
324                 else {
325                         len= gzread(gzfile, header, sizeof(header));
326                         gzclose(gzfile);
327                         if (len == sizeof(header) && strncmp(header, "BLENDER", 7) == 0) {
328                                 retval= BKE_READ_EXOTIC_OK_BLEND;
329                         }
330                         else {
331                                 //XXX waitcursor(1);
332                                 /*
333                                 if(is_foo_format(name)) {
334                                         read_foo(name);
335                                         retval= BKE_READ_EXOTIC_OK_OTHER;
336                                 }
337                                 else
338                                  */
339                                 {
340                                         retval= BKE_READ_EXOTIC_FAIL_FORMAT;
341                                 }
342                                 //XXX waitcursor(0);
343                         }
344                 }
345         }
346
347         return retval;
348 }
349
350 void WM_read_file(bContext *C, const char *filepath, ReportList *reports)
351 {
352         int retval;
353
354         /* so we can get the error message */
355         errno = 0;
356
357         WM_cursor_wait(1);
358
359         BLI_exec_cb(CTX_data_main(C), NULL, BLI_CB_EVT_LOAD_PRE);
360
361         /* first try to append data from exotic file formats... */
362         /* it throws error box when file doesn't exist and returns -1 */
363         /* note; it should set some error message somewhere... (ton) */
364         retval= wm_read_exotic(CTX_data_scene(C), filepath);
365         
366         /* we didn't succeed, now try to read Blender file */
367         if (retval == BKE_READ_EXOTIC_OK_BLEND) {
368                 int G_f= G.f;
369                 ListBase wmbase;
370
371                 /* put aside screens to match with persistent windows later */
372                 /* also exit screens and editors */
373                 wm_window_match_init(C, &wmbase); 
374                 
375                 retval= BKE_read_file(C, filepath, reports);
376                 G.save_over = 1;
377
378                 /* this flag is initialized by the operator but overwritten on read.
379                  * need to re-enable it here else drivers + registered scripts wont work. */
380                 if(G.f != G_f) {
381                         const int flags_keep= (G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
382                         G.f= (G.f & ~flags_keep) | (G_f & flags_keep);
383                 }
384
385                 /* match the read WM with current WM */
386                 wm_window_match_do(C, &wmbase);
387                 WM_check(C); /* opens window(s), checks keymaps */
388                 
389 // XXX          mainwindow_set_filename_to_title(G.main->name);
390
391                 if(retval == BKE_READ_FILE_OK_USERPREFS) wm_init_userdef(C);    // in case a userdef is read from regular .blend
392                 
393                 if (retval != BKE_READ_FILE_FAIL) {
394                         G.relbase_valid = 1;
395                         if(!G.background) /* assume automated tasks with background, dont write recent file list */
396                                 write_history();
397                 }
398
399
400                 WM_event_add_notifier(C, NC_WM|ND_FILEREAD, NULL);
401 //              refresh_interface_font();
402
403                 CTX_wm_window_set(C, CTX_wm_manager(C)->windows.first);
404
405                 ED_editors_init(C);
406                 DAG_on_visible_update(CTX_data_main(C), TRUE);
407
408 #ifdef WITH_PYTHON
409                 /* run any texts that were loaded in and flagged as modules */
410                 BPY_driver_reset();
411                 BPY_app_handlers_reset(FALSE);
412                 BPY_modules_load_user(C);
413 #endif
414
415                 /* important to do before NULL'ing the context */
416                 BLI_exec_cb(CTX_data_main(C), NULL, BLI_CB_EVT_LOAD_POST);
417
418                 CTX_wm_window_set(C, NULL); /* exits queues */
419
420 #if 0   /* gives popups on windows but not linux, bug in report API but disable for now to stop users getting annoyed  */
421                 /* TODO, make this show in header info window */
422                 {
423                         Scene *sce;
424                         for(sce= G.main->scene.first; sce; sce= sce->id.next) {
425                                 if(sce->r.engine[0] && BLI_findstring(&R_engines, sce->r.engine, offsetof(RenderEngineType, idname)) == NULL) {
426                                         BKE_reportf(reports, RPT_WARNING, "Engine not available: '%s' for scene: %s, an addon may need to be installed or enabled", sce->r.engine, sce->id.name+2);
427                                 }
428                         }
429                 }
430 #endif
431
432                 // XXX          undo_editmode_clear();
433                 BKE_reset_undo();
434                 BKE_write_undo(C, "original");  /* save current state */
435         }
436         else if(retval == BKE_READ_EXOTIC_OK_OTHER)
437                 BKE_write_undo(C, "Import file");
438         else if(retval == BKE_READ_EXOTIC_FAIL_OPEN) {
439                 BKE_reportf(reports, RPT_ERROR, IFACE_("Can't read file: \"%s\", %s."), filepath,
440                                 errno ? strerror(errno) : IFACE_("Unable to open the file"));
441         }
442         else if(retval == BKE_READ_EXOTIC_FAIL_FORMAT) {
443                 BKE_reportf(reports, RPT_ERROR, IFACE_("File format is not supported in file: \"%s\"."), filepath);
444         }
445         else if(retval == BKE_READ_EXOTIC_FAIL_PATH) {
446                 BKE_reportf(reports, RPT_ERROR, IFACE_("File path invalid: \"%s\"."), filepath);
447         }
448         else {
449                 BKE_reportf(reports, RPT_ERROR, IFACE_("Unknown error loading: \"%s\"."), filepath);
450                 BLI_assert(!"invalid 'retval'");
451         }
452
453         WM_cursor_wait(0);
454
455 }
456
457
458 /* called on startup,  (context entirely filled with NULLs) */
459 /* or called for 'New File' */
460 /* op can be NULL */
461 int WM_read_homefile(bContext *C, ReportList *UNUSED(reports), short from_memory)
462 {
463         ListBase wmbase;
464         char tstr[FILE_MAXDIR+FILE_MAXFILE];
465         int success= 0;
466         
467         free_ttfont(); /* still weird... what does it here? */
468                 
469         G.relbase_valid = 0;
470         if (!from_memory) {
471                 char *cfgdir = BLI_get_folder(BLENDER_USER_CONFIG, NULL);
472                 if (cfgdir) {
473                         BLI_make_file_string(G.main->name, tstr, cfgdir, BLENDER_STARTUP_FILE);
474                 } else {
475                         tstr[0] = '\0';
476                         from_memory = 1;
477                 }
478         }
479         
480         /* prevent loading no UI */
481         G.fileflags &= ~G_FILE_NO_UI;
482         
483         /* put aside screens to match with persistent windows later */
484         wm_window_match_init(C, &wmbase); 
485         
486         if (!from_memory && BLI_exists(tstr)) {
487                 success = (BKE_read_file(C, tstr, NULL) != BKE_READ_FILE_FAIL);
488                 
489                 if(U.themes.first==NULL) {
490                         printf("\nError: No valid "STRINGIFY(BLENDER_STARTUP_FILE)", fall back to built-in default.\n\n");
491                         success = 0;
492                 }
493         }
494         if(success==0) {
495                 success = BKE_read_file_from_memory(C, datatoc_startup_blend, datatoc_startup_blend_size, NULL);
496                 if (wmbase.first == NULL) wm_clear_default_size(C);
497
498 #ifdef WITH_PYTHON_SECURITY /* not default */
499                 /* use alternative setting for security nuts
500                  * otherwise we'd need to patch the binary blob - startup.blend.c */
501                 U.flag |= USER_SCRIPT_AUTOEXEC_DISABLE;
502 #endif
503         }
504         
505         /* prevent buggy files that had G_FILE_RELATIVE_REMAP written out by mistake. Screws up autosaves otherwise
506          * can remove this eventually, only in a 2.53 and older, now its not written */
507         G.fileflags &= ~G_FILE_RELATIVE_REMAP;
508         
509         /* check userdef before open window, keymaps etc */
510         wm_init_userdef(C);
511         
512         /* match the read WM with current WM */
513         wm_window_match_do(C, &wmbase); 
514         WM_check(C); /* opens window(s), checks keymaps */
515
516         G.main->name[0]= '\0';
517
518         /* When loading factory settings, the reset solid OpenGL lights need to be applied. */
519         if (!G.background) GPU_default_lights();
520         
521         /* XXX */
522         G.save_over = 0;        // start with save preference untitled.blend
523         G.fileflags &= ~G_FILE_AUTOPLAY;        /*  disable autoplay in startup.blend... */
524 //      mainwindow_set_filename_to_title("");   // empty string re-initializes title to "Blender"
525         
526 //      refresh_interface_font();
527         
528 //      undo_editmode_clear();
529         BKE_reset_undo();
530         BKE_write_undo(C, "original");  /* save current state */
531
532         ED_editors_init(C);
533         DAG_on_visible_update(CTX_data_main(C), TRUE);
534
535 #ifdef WITH_PYTHON
536         if(CTX_py_init_get(C)) {
537                 /* sync addons, these may have changed from the defaults */
538                 BPY_string_exec(C, "__import__('addon_utils').reset_all()");
539
540                 BPY_driver_reset();
541                 BPY_app_handlers_reset(FALSE);
542                 BPY_modules_load_user(C);
543         }
544 #endif
545
546         WM_event_add_notifier(C, NC_WM|ND_FILEREAD, NULL);
547
548         /* in background mode the scene will stay NULL */
549         if(!G.background) {
550                 CTX_wm_window_set(C, NULL); /* exits queues */
551         }
552
553         return TRUE;
554 }
555
556 int WM_read_homefile_exec(bContext *C, wmOperator *op)
557 {
558         int from_memory= strcmp(op->type->idname, "WM_OT_read_factory_settings") == 0;
559         return WM_read_homefile(C, op->reports, from_memory) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
560 }
561
562 void WM_read_history(void)
563 {
564         char name[FILE_MAX];
565         LinkNode *l, *lines;
566         struct RecentFile *recent;
567         char *line;
568         int num;
569         char *cfgdir = BLI_get_folder(BLENDER_USER_CONFIG, NULL);
570
571         if (!cfgdir) return;
572
573         BLI_make_file_string("/", name, cfgdir, BLENDER_HISTORY_FILE);
574
575         lines= BLI_file_read_as_lines(name);
576
577         G.recent_files.first = G.recent_files.last = NULL;
578
579         /* read list of recent opened files from recent-files.txt to memory */
580         for (l= lines, num= 0; l && (num<U.recent_files); l= l->next) {
581                 line = l->link;
582                 if (line[0] && BLI_exists(line)) {
583                         recent = (RecentFile*)MEM_mallocN(sizeof(RecentFile),"RecentFile");
584                         BLI_addtail(&(G.recent_files), recent);
585                         recent->filepath = BLI_strdup(line);
586                         num++;
587                 }
588         }
589         
590         BLI_file_free_lines(lines);
591
592 }
593
594 static void write_history(void)
595 {
596         struct RecentFile *recent, *next_recent;
597         char name[FILE_MAXDIR+FILE_MAXFILE];
598         char *user_config_dir;
599         FILE *fp;
600         int i;
601
602         /* will be NULL in background mode */
603         user_config_dir = BLI_get_folder_create(BLENDER_USER_CONFIG, NULL);
604         if(!user_config_dir)
605                 return;
606
607         BLI_make_file_string("/", name, user_config_dir, BLENDER_HISTORY_FILE);
608
609         recent = G.recent_files.first;
610         /* refresh recent-files.txt of recent opened files, when current file was changed */
611         if(!(recent) || (BLI_path_cmp(recent->filepath, G.main->name)!=0)) {
612                 fp= fopen(name, "w");
613                 if (fp) {
614                         /* add current file to the beginning of list */
615                         recent = (RecentFile*)MEM_mallocN(sizeof(RecentFile),"RecentFile");
616                         recent->filepath = BLI_strdup(G.main->name);
617                         BLI_addhead(&(G.recent_files), recent);
618                         /* write current file to recent-files.txt */
619                         fprintf(fp, "%s\n", recent->filepath);
620                         recent = recent->next;
621                         i=1;
622                         /* write rest of recent opened files to recent-files.txt */
623                         while((i<U.recent_files) && (recent)){
624                                 /* this prevents to have duplicities in list */
625                                 if (BLI_path_cmp(recent->filepath, G.main->name)!=0) {
626                                         fprintf(fp, "%s\n", recent->filepath);
627                                         recent = recent->next;
628                                 }
629                                 else {
630                                         next_recent = recent->next;
631                                         MEM_freeN(recent->filepath);
632                                         BLI_freelinkN(&(G.recent_files), recent);
633                                         recent = next_recent;
634                                 }
635                                 i++;
636                         }
637                         fclose(fp);
638                 }
639
640                 /* also update most recent files on System */
641                 GHOST_addToSystemRecentFiles(G.main->name);
642         }
643 }
644
645 static ImBuf *blend_file_thumb(Scene *scene, int **thumb_pt)
646 {
647         /* will be scaled down, but gives some nice oversampling */
648         ImBuf *ibuf;
649         int *thumb;
650         char err_out[256]= "unknown";
651
652         *thumb_pt= NULL;
653
654         /* scene can be NULL if running a script at startup and calling the save operator */
655         if(G.background || scene==NULL || scene->camera==NULL)
656                 return NULL;
657
658         /* gets scaled to BLEN_THUMB_SIZE */
659         ibuf= ED_view3d_draw_offscreen_imbuf_simple(scene, scene->camera, BLEN_THUMB_SIZE * 2, BLEN_THUMB_SIZE * 2, IB_rect, OB_SOLID, err_out);
660         
661         if(ibuf) {              
662                 float aspect= (scene->r.xsch*scene->r.xasp) / (scene->r.ysch*scene->r.yasp);
663
664                 /* dirty oversampling */
665                 IMB_scaleImBuf(ibuf, BLEN_THUMB_SIZE, BLEN_THUMB_SIZE);
666
667                 /* add pretty overlay */
668                 IMB_overlayblend_thumb(ibuf->rect, ibuf->x, ibuf->y, aspect);
669                 
670                 /* first write into thumb buffer */
671                 thumb= MEM_mallocN(((2 + (BLEN_THUMB_SIZE * BLEN_THUMB_SIZE))) * sizeof(int), "write_file thumb");
672
673                 thumb[0] = BLEN_THUMB_SIZE;
674                 thumb[1] = BLEN_THUMB_SIZE;
675
676                 memcpy(thumb + 2, ibuf->rect, BLEN_THUMB_SIZE * BLEN_THUMB_SIZE * sizeof(int));
677         }
678         else {
679                 /* '*thumb_pt' needs to stay NULL to prevent a bad thumbnail from being handled */
680                 fprintf(stderr, "blend_file_thumb failed to create thumbnail: %s\n", err_out);
681                 thumb= NULL;
682         }
683         
684         /* must be freed by caller */
685         *thumb_pt= thumb;
686         
687         return ibuf;
688 }
689
690 /* easy access from gdb */
691 int write_crash_blend(void)
692 {
693         char path[FILE_MAX];
694         int fileflags = G.fileflags & ~(G_FILE_HISTORY); /* don't do file history on crash file */
695
696         BLI_strncpy(path, G.main->name, sizeof(path));
697         BLI_replace_extension(path, sizeof(path), "_crash.blend");
698         if(BLO_write_file(G.main, path, fileflags, NULL, NULL)) {
699                 printf("written: %s\n", path);
700                 return 1;
701         }
702         else {
703                 printf("failed: %s\n", path);
704                 return 0;
705         }
706 }
707
708 int WM_write_file(bContext *C, const char *target, int fileflags, ReportList *reports, int copy)
709 {
710         Library *li;
711         int len;
712         char filepath[FILE_MAX];
713
714         int *thumb= NULL;
715         ImBuf *ibuf_thumb= NULL;
716
717         len = strlen(target);
718         
719         if (len == 0) {
720                 BKE_report(reports, RPT_ERROR, "Path is empty, cannot save");
721                 return -1;
722         }
723
724         if (len >= FILE_MAX) {
725                 BKE_report(reports, RPT_ERROR, "Path too long, cannot save");
726                 return -1;
727         }
728  
729         BLI_strncpy(filepath, target, FILE_MAX);
730         BLI_replace_extension(filepath, FILE_MAX, ".blend");
731         /* dont use 'target' anymore */
732         
733         /* send the OnSave event */
734         for (li= G.main->library.first; li; li= li->id.next) {
735                 if (BLI_path_cmp(li->filepath, filepath) == 0) {
736                         BKE_reportf(reports, RPT_ERROR, "Can't overwrite used library '%.200s'", filepath);
737                         return -1;
738                 }
739         }
740
741         /* blend file thumbnail */
742         /* save before exit_editmode, otherwise derivedmeshes for shared data corrupt #27765) */
743         if(U.flag & USER_SAVE_PREVIEWS) {
744                 ibuf_thumb= blend_file_thumb(CTX_data_scene(C), &thumb);
745         }
746
747         BLI_exec_cb(G.main, NULL, BLI_CB_EVT_SAVE_PRE);
748
749         /* operator now handles overwrite checks */
750
751         if (G.fileflags & G_AUTOPACK) {
752                 packAll(G.main, reports);
753         }
754         
755         ED_object_exit_editmode(C, EM_DO_UNDO);
756         ED_sculpt_force_update(C);
757
758         /* don't forget not to return without! */
759         WM_cursor_wait(1);
760         
761         fileflags |= G_FILE_HISTORY; /* write file history */
762
763         if (BLO_write_file(CTX_data_main(C), filepath, fileflags, reports, thumb)) {
764                 if(!copy) {
765                         G.relbase_valid = 1;
766                         BLI_strncpy(G.main->name, filepath, sizeof(G.main->name));      /* is guaranteed current file */
767         
768                         G.save_over = 1; /* disable untitled.blend convention */
769                 }
770
771                 if(fileflags & G_FILE_COMPRESS) G.fileflags |= G_FILE_COMPRESS;
772                 else G.fileflags &= ~G_FILE_COMPRESS;
773                 
774                 if(fileflags & G_FILE_AUTOPLAY) G.fileflags |= G_FILE_AUTOPLAY;
775                 else G.fileflags &= ~G_FILE_AUTOPLAY;
776
777                 /* prevent background mode scripts from clobbering history */
778                 if(!G.background) {
779                         write_history();
780                 }
781
782                 BLI_exec_cb(G.main, NULL, BLI_CB_EVT_SAVE_POST);
783
784                 /* run this function after because the file cant be written before the blend is */
785                 if (ibuf_thumb) {
786                         ibuf_thumb= IMB_thumb_create(filepath, THB_NORMAL, THB_SOURCE_BLEND, ibuf_thumb);
787                         IMB_freeImBuf(ibuf_thumb);
788                 }
789
790                 if(thumb) MEM_freeN(thumb);
791         }
792         else {
793                 if(ibuf_thumb) IMB_freeImBuf(ibuf_thumb);
794                 if(thumb) MEM_freeN(thumb);
795                 
796                 WM_cursor_wait(0);
797                 return -1;
798         }
799
800         WM_cursor_wait(0);
801         
802         return 0;
803 }
804
805 /* operator entry */
806 int WM_write_homefile(bContext *C, wmOperator *op)
807 {
808         wmWindowManager *wm= CTX_wm_manager(C);
809         wmWindow *win= CTX_wm_window(C);
810         char filepath[FILE_MAXDIR+FILE_MAXFILE];
811         int fileflags;
812
813         /* check current window and close it if temp */
814         if(win->screen->temp)
815                 wm_window_close(C, wm, win);
816         
817         /* update keymaps in user preferences */
818         WM_keyconfig_update(wm);
819         
820         BLI_make_file_string("/", filepath, BLI_get_folder_create(BLENDER_USER_CONFIG, NULL), BLENDER_STARTUP_FILE);
821         printf("trying to save homefile at %s ", filepath);
822         
823         /*  force save as regular blend file */
824         fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_AUTOPLAY | G_FILE_LOCK | G_FILE_SIGN | G_FILE_HISTORY);
825
826         if(BLO_write_file(CTX_data_main(C), filepath, fileflags, op->reports, NULL) == 0) {
827                 printf("fail\n");
828                 return OPERATOR_CANCELLED;
829         }
830         
831         printf("ok\n");
832
833         G.save_over= 0;
834
835         return OPERATOR_FINISHED;
836 }
837
838 /************************ autosave ****************************/
839
840 void wm_autosave_location(char *filepath)
841 {
842         char pidstr[32];
843 #ifdef WIN32
844         char *savedir;
845 #endif
846
847         BLI_snprintf(pidstr, sizeof(pidstr), "%d.blend", abs(getpid()));
848
849 #ifdef WIN32
850         /* XXX Need to investigate how to handle default location of '/tmp/'
851          * This is a relative directory on Windows, and it may be
852          * found. Example:
853          * Blender installed on D:\ drive, D:\ drive has D:\tmp\
854          * Now, BLI_exists() will find '/tmp/' exists, but
855          * BLI_make_file_string will create string that has it most likely on C:\
856          * through get_default_root().
857          * If there is no C:\tmp autosave fails. */
858         if (!BLI_exists(BLI_temporary_dir())) {
859                 savedir = BLI_get_folder_create(BLENDER_USER_AUTOSAVE, NULL);
860                 BLI_make_file_string("/", filepath, savedir, pidstr);
861                 return;
862         }
863 #endif
864
865         BLI_make_file_string("/", filepath, BLI_temporary_dir(), pidstr);
866 }
867
868 void WM_autosave_init(wmWindowManager *wm)
869 {
870         wm_autosave_timer_ended(wm);
871
872         if(U.flag & USER_AUTOSAVE)
873                 wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime*60.0);
874 }
875
876 void wm_autosave_timer(const bContext *C, wmWindowManager *wm, wmTimer *UNUSED(wt))
877 {
878         wmWindow *win;
879         wmEventHandler *handler;
880         char filepath[FILE_MAX];
881         int fileflags;
882
883         WM_event_remove_timer(wm, NULL, wm->autosavetimer);
884
885         /* if a modal operator is running, don't autosave, but try again in 10 seconds */
886         for(win=wm->windows.first; win; win=win->next) {
887                 for(handler=win->modalhandlers.first; handler; handler=handler->next) {
888                         if(handler->op) {
889                                 wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, 10.0);
890                                 return;
891                         }
892                 }
893         }
894         
895         wm_autosave_location(filepath);
896
897         /*  force save as regular blend file */
898         fileflags = G.fileflags & ~(G_FILE_COMPRESS|G_FILE_AUTOPLAY |G_FILE_LOCK|G_FILE_SIGN|G_FILE_HISTORY);
899
900         /* no error reporting to console */
901         BLO_write_file(CTX_data_main(C), filepath, fileflags, NULL, NULL);
902
903         /* do timer after file write, just in case file write takes a long time */
904         wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime*60.0);
905 }
906
907 void wm_autosave_timer_ended(wmWindowManager *wm)
908 {
909         if(wm->autosavetimer) {
910                 WM_event_remove_timer(wm, NULL, wm->autosavetimer);
911                 wm->autosavetimer= NULL;
912         }
913 }
914
915 void wm_autosave_delete(void)
916 {
917         char filename[FILE_MAX];
918         
919         wm_autosave_location(filename);
920
921         if(BLI_exists(filename)) {
922                 char str[FILE_MAXDIR+FILE_MAXFILE];
923                 BLI_make_file_string("/", str, BLI_temporary_dir(), "quit.blend");
924
925                 /* if global undo; remove tempsave, otherwise rename */
926                 if(U.uiflag & USER_GLOBALUNDO) BLI_delete(filename, 0, 0);
927                 else BLI_rename(filename, str);
928         }
929 }
930
931 void wm_autosave_read(bContext *C, ReportList *reports)
932 {
933         char filename[FILE_MAX];
934
935         wm_autosave_location(filename);
936         WM_read_file(C, filename, reports);
937 }
938