Merge branch 'master' into blender2.8
[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  * User level access for blend file read/write, file-history and userprefs (including relevant operators).
30  */
31
32
33 /* placed up here because of crappy
34  * winsock stuff.
35  */
36 #include <stddef.h>
37 #include <string.h>
38 #include <errno.h>
39
40 #include "zlib.h" /* wm_read_exotic() */
41
42 #ifdef WIN32
43 #  include <windows.h> /* need to include windows.h so _WIN32_IE is defined  */
44 #  ifndef _WIN32_IE
45 #    define _WIN32_IE 0x0400 /* minimal requirements for SHGetSpecialFolderPath on MINGW MSVC has this defined already */
46 #  endif
47 #  include <shlobj.h>  /* for SHGetSpecialFolderPath, has to be done before BLI_winstuff
48                         * because 'near' is disabled through BLI_windstuff */
49 #  include "BLI_winstuff.h"
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_threads.h"
59 #include "BLI_callbacks.h"
60 #include "BLI_system.h"
61 #include BLI_SYSTEM_PID_H
62
63 #include "BLT_translation.h"
64
65 #include "BLF_api.h"
66
67 #include "DNA_object_types.h"
68 #include "DNA_space_types.h"
69 #include "DNA_userdef_types.h"
70 #include "DNA_scene_types.h"
71 #include "DNA_screen_types.h"
72 #include "DNA_windowmanager_types.h"
73 #include "DNA_workspace_types.h"
74
75 #include "BKE_appdir.h"
76 #include "BKE_autoexec.h"
77 #include "BKE_blender.h"
78 #include "BKE_blendfile.h"
79 #include "BKE_blender_undo.h"
80 #include "BKE_context.h"
81 #include "BKE_global.h"
82 #include "BKE_main.h"
83 #include "BKE_packedFile.h"
84 #include "BKE_report.h"
85 #include "BKE_sound.h"
86 #include "BKE_scene.h"
87 #include "BKE_screen.h"
88 #include "BKE_undo_system.h"
89 #include "BKE_workspace.h"
90
91 #include "BLO_readfile.h"
92 #include "BLO_writefile.h"
93 #include "BLO_undofile.h"  /* to save from an undo memfile */
94
95 #include "RNA_access.h"
96 #include "RNA_define.h"
97
98 #include "IMB_imbuf.h"
99 #include "IMB_imbuf_types.h"
100 #include "IMB_thumbs.h"
101
102 #include "ED_datafiles.h"
103 #include "ED_fileselect.h"
104 #include "ED_screen.h"
105 #include "ED_view3d.h"
106 #include "ED_util.h"
107 #include "ED_undo.h"
108
109 #include "GHOST_C-api.h"
110 #include "GHOST_Path-api.h"
111
112 #include "UI_interface.h"
113 #include "UI_resources.h"
114 #include "UI_view2d.h"
115
116 #include "GPU_draw.h"
117
118 /* only to report a missing engine */
119 #include "RE_engine.h"
120
121 #ifdef WITH_PYTHON
122 #include "BPY_extern.h"
123 #endif
124
125 #include "DEG_depsgraph.h"
126
127 #include "WM_api.h"
128 #include "WM_types.h"
129 #include "WM_message.h"
130 #include "WM_toolsystem.h"
131
132 #include "wm.h"
133 #include "wm_files.h"
134 #include "wm_window.h"
135 #include "wm_event_system.h"
136
137 static RecentFile *wm_file_history_find(const char *filepath);
138 static void wm_history_file_free(RecentFile *recent);
139 static void wm_history_file_update(void);
140 static void wm_history_file_write(void);
141
142
143 /* To be able to read files without windows closing, opening, moving
144  * we try to prepare for worst case:
145  * - active window gets active screen from file
146  * - restoring the screens from non-active windows
147  * Best case is all screens match, in that case they get assigned to proper window
148  */
149 static void wm_window_match_init(bContext *C, ListBase *wmlist)
150 {
151         wmWindowManager *wm;
152         wmWindow *win, *active_win;
153
154         *wmlist = G_MAIN->wm;
155         BLI_listbase_clear(&G_MAIN->wm);
156
157         active_win = CTX_wm_window(C);
158
159         /* first wrap up running stuff */
160         /* code copied from wm_init_exit.c */
161         for (wm = wmlist->first; wm; wm = wm->id.next) {
162
163                 WM_jobs_kill_all(wm);
164
165                 for (win = wm->windows.first; win; win = win->next) {
166
167                         CTX_wm_window_set(C, win);  /* needed by operator close callbacks */
168                         WM_event_remove_handlers(C, &win->handlers);
169                         WM_event_remove_handlers(C, &win->modalhandlers);
170                         ED_screen_exit(C, win, WM_window_get_active_screen(win));
171                 }
172         }
173
174         /* reset active window */
175         CTX_wm_window_set(C, active_win);
176
177         /* XXX Hack! We have to clear context menu here, because removing all modalhandlers above frees the active menu
178          *     (at least, in the 'startup splash' case), causing use-after-free error in later handling of the button
179          *     callbacks in UI code (see ui_apply_but_funcs_after()).
180          *     Tried solving this by always NULL-ing context's menu when setting wm/win/etc., but it broke popups refreshing
181          *     (see T47632), so for now just handling this specific case here. */
182         CTX_wm_menu_set(C, NULL);
183
184         ED_editors_exit(C);
185 }
186
187 static void wm_window_substitute_old(wmWindowManager *oldwm, wmWindowManager *wm, wmWindow *oldwin, wmWindow *win)
188 {
189         win->ghostwin = oldwin->ghostwin;
190         win->gpuctx = oldwin->gpuctx;
191         win->active = oldwin->active;
192         if (win->active) {
193                 wm->winactive = win;
194         }
195         if (oldwm->windrawable == oldwin) {
196                 oldwm->windrawable = NULL;
197                 wm->windrawable = win;
198         }
199
200         if (!G.background) /* file loading in background mode still calls this */
201                 GHOST_SetWindowUserData(win->ghostwin, win);    /* pointer back */
202
203         oldwin->ghostwin = NULL;
204         oldwin->gpuctx = NULL;
205
206         win->eventstate = oldwin->eventstate;
207         oldwin->eventstate = NULL;
208
209         /* ensure proper screen rescaling */
210         win->sizex = oldwin->sizex;
211         win->sizey = oldwin->sizey;
212         win->posx = oldwin->posx;
213         win->posy = oldwin->posy;
214 }
215
216 static void wm_window_match_keep_current_wm(
217         const bContext *C, ListBase *current_wm_list,
218         const bool load_ui,
219         ListBase *r_new_wm_list)
220 {
221         Main *bmain = CTX_data_main(C);
222         wmWindowManager *wm = current_wm_list->first;
223         bScreen *screen = NULL;
224
225         /* match oldwm to new dbase, only old files */
226         wm->initialized &= ~WM_WINDOW_IS_INITIALIZED;
227
228         /* when loading without UI, no matching needed */
229         if (load_ui && (screen = CTX_wm_screen(C))) {
230                 for (wmWindow *win = wm->windows.first; win; win = win->next) {
231                         WorkSpace *workspace;
232
233                         BKE_workspace_layout_find_global(bmain, screen, &workspace);
234                         BKE_workspace_active_set(win->workspace_hook, workspace);
235                         win->scene = CTX_data_scene(C);
236
237                         /* all windows get active screen from file */
238                         if (screen->winid == 0) {
239                                 WM_window_set_active_screen(win, workspace, screen);
240                         }
241                         else {
242                                 WorkSpaceLayout *layout_old = WM_window_get_active_layout(win);
243                                 WorkSpaceLayout *layout_new = ED_workspace_layout_duplicate(bmain, workspace, layout_old, win);
244
245                                 WM_window_set_active_layout(win, workspace, layout_new);
246                         }
247
248                         bScreen *win_screen = WM_window_get_active_screen(win);
249                         win_screen->winid = win->winid;
250                 }
251         }
252
253         *r_new_wm_list = *current_wm_list;
254 }
255
256 static void wm_window_match_replace_by_file_wm(
257         bContext *C, ListBase *current_wm_list, ListBase *readfile_wm_list,
258         ListBase *r_new_wm_list)
259 {
260         wmWindowManager *oldwm = current_wm_list->first;
261         wmWindowManager *wm = readfile_wm_list->first; /* will become our new WM */
262         bool has_match = false;
263
264         /* this code could move to setup_appdata */
265
266         /* preserve key configurations in new wm, to preserve their keymaps */
267         wm->keyconfigs = oldwm->keyconfigs;
268         wm->addonconf = oldwm->addonconf;
269         wm->defaultconf = oldwm->defaultconf;
270         wm->userconf = oldwm->userconf;
271
272         BLI_listbase_clear(&oldwm->keyconfigs);
273         oldwm->addonconf = NULL;
274         oldwm->defaultconf = NULL;
275         oldwm->userconf = NULL;
276
277         /* ensure making new keymaps and set space types */
278         wm->initialized = 0;
279         wm->winactive = NULL;
280
281         /* Clearing drawable of before deleting any context
282          * to avoid clearing the wrong wm. */
283         wm_window_clear_drawable(oldwm);
284
285         /* only first wm in list has ghostwins */
286         for (wmWindow *win = wm->windows.first; win; win = win->next) {
287                 for (wmWindow *oldwin = oldwm->windows.first; oldwin; oldwin = oldwin->next) {
288                         if (oldwin->winid == win->winid) {
289                                 has_match = true;
290
291                                 wm_window_substitute_old(oldwm, wm, oldwin, win);
292                         }
293                 }
294         }
295         /* make sure at least one window is kept open so we don't lose the context, check T42303 */
296         if (!has_match) {
297                 wm_window_substitute_old(oldwm, wm, oldwm->windows.first, wm->windows.first);
298         }
299
300         wm_close_and_free_all(C, current_wm_list);
301
302         *r_new_wm_list = *readfile_wm_list;
303 }
304
305 /**
306  * Match old WM with new, 4 cases:
307  * 1) No current WM, no WM in file: Make new default.
308  * 2) No current WM, but WM in file: Keep current WM, do nothing else.
309  * 3) Current WM, but not in file: Keep current WM, update windows with screens from file.
310  * 4) Current WM, and WM in file: Try to keep current GHOST windows, use WM from file.
311  *
312  * \param r_new_wm_list: Return argument for the wm list to be used from now on.
313  */
314 static void wm_window_match_do(
315         bContext *C,
316         ListBase *current_wm_list, ListBase *readfile_wm_list,
317         ListBase *r_new_wm_list)
318 {
319         if (BLI_listbase_is_empty(current_wm_list)) {
320                 /* case 1 */
321                 if (BLI_listbase_is_empty(readfile_wm_list)) {
322                         Main *bmain = CTX_data_main(C);
323                         /* Neither current, no newly read file have a WM -> add the default one. */
324                         wm_add_default(bmain, C);
325                         *r_new_wm_list = bmain->wm;
326                 }
327                 /* case 2 */
328                 else {
329                         *r_new_wm_list = *readfile_wm_list;
330                 }
331         }
332         else {
333                 /* case 3 */
334                 if (BLI_listbase_is_empty(readfile_wm_list)) {
335                         /* We've read file without wm, keep current one entirely alive.
336                          * Happens when reading pre 2.5 files (no WM back then) */
337                         wm_window_match_keep_current_wm(C, current_wm_list, (G.fileflags & G_FILE_NO_UI) == 0, r_new_wm_list);
338                 }
339                 /* case 4 */
340                 else {
341                         wm_window_match_replace_by_file_wm(C, current_wm_list, readfile_wm_list, r_new_wm_list);
342                 }
343         }
344 }
345
346 /* in case UserDef was read, we re-initialize all, and do versioning */
347 static void wm_init_userdef(Main *bmain, const bool read_userdef_from_memory)
348 {
349         /* versioning is here */
350         UI_init_userdef(bmain);
351
352         MEM_CacheLimiter_set_maximum(((size_t)U.memcachelimit) * 1024 * 1024);
353         BKE_sound_init(bmain);
354
355         /* needed so loading a file from the command line respects user-pref [#26156] */
356         SET_FLAG_FROM_TEST(G.fileflags, U.flag & USER_FILENOUI, G_FILE_NO_UI);
357
358         /* set the python auto-execute setting from user prefs */
359         /* enabled by default, unless explicitly enabled in the command line which overrides */
360         if ((G.f & G_SCRIPT_OVERRIDE_PREF) == 0) {
361                 SET_FLAG_FROM_TEST(G.f, (U.flag & USER_SCRIPT_AUTOEXEC_DISABLE) == 0, G_SCRIPT_AUTOEXEC);
362         }
363
364         /* avoid re-saving for every small change to our prefs, allow overrides */
365         if (read_userdef_from_memory) {
366                 BLO_update_defaults_userpref_blend();
367         }
368
369         /* update tempdir from user preferences */
370         BKE_tempdir_init(U.tempdir);
371 }
372
373
374
375 /* return codes */
376 #define BKE_READ_EXOTIC_FAIL_PATH       -3 /* file format is not supported */
377 #define BKE_READ_EXOTIC_FAIL_FORMAT     -2 /* file format is not supported */
378 #define BKE_READ_EXOTIC_FAIL_OPEN       -1 /* Can't open the file */
379 #define BKE_READ_EXOTIC_OK_BLEND         0 /* .blend file */
380 #if 0
381 #define BKE_READ_EXOTIC_OK_OTHER         1 /* other supported formats */
382 #endif
383
384
385 /* intended to check for non-blender formats but for now it only reads blends */
386 static int wm_read_exotic(const char *name)
387 {
388         int len;
389         gzFile gzfile;
390         char header[7];
391         int retval;
392
393         /* make sure we're not trying to read a directory.... */
394
395         len = strlen(name);
396         if (len > 0 && ELEM(name[len - 1], '/', '\\')) {
397                 retval = BKE_READ_EXOTIC_FAIL_PATH;
398         }
399         else {
400                 gzfile = BLI_gzopen(name, "rb");
401                 if (gzfile == NULL) {
402                         retval = BKE_READ_EXOTIC_FAIL_OPEN;
403                 }
404                 else {
405                         len = gzread(gzfile, header, sizeof(header));
406                         gzclose(gzfile);
407                         if (len == sizeof(header) && STREQLEN(header, "BLENDER", 7)) {
408                                 retval = BKE_READ_EXOTIC_OK_BLEND;
409                         }
410                         else {
411 #if 0           /* historic stuff - no longer used */
412                                 WM_cursor_wait(true);
413
414                                 if (is_foo_format(name)) {
415                                         read_foo(name);
416                                         retval = BKE_READ_EXOTIC_OK_OTHER;
417                                 }
418                                 else
419 #endif
420                                 {
421                                         retval = BKE_READ_EXOTIC_FAIL_FORMAT;
422                                 }
423 #if 0
424                                 WM_cursor_wait(false);
425 #endif
426                         }
427                 }
428         }
429
430         return retval;
431 }
432
433 void WM_file_autoexec_init(const char *filepath)
434 {
435         if (G.f & G_SCRIPT_OVERRIDE_PREF) {
436                 return;
437         }
438
439         if (G.f & G_SCRIPT_AUTOEXEC) {
440                 char path[FILE_MAX];
441                 BLI_split_dir_part(filepath, path, sizeof(path));
442                 if (BKE_autoexec_match(path)) {
443                         G.f &= ~G_SCRIPT_AUTOEXEC;
444                 }
445         }
446 }
447
448 void wm_file_read_report(bContext *C, Main *bmain)
449 {
450         ReportList *reports = NULL;
451         Scene *sce;
452
453         for (sce = bmain->scene.first; sce; sce = sce->id.next) {
454                 if (sce->r.engine[0] &&
455                     BLI_findstring(&R_engines, sce->r.engine, offsetof(RenderEngineType, idname)) == NULL)
456                 {
457                         if (reports == NULL) {
458                                 reports = CTX_wm_reports(C);
459                         }
460
461                         BKE_reportf(reports, RPT_ERROR,
462                                     "Engine '%s' not available for scene '%s' (an add-on may need to be installed or enabled)",
463                                     sce->r.engine, sce->id.name + 2);
464                 }
465         }
466
467         if (reports) {
468                 if (!G.background) {
469                         WM_report_banner_show();
470                 }
471         }
472 }
473
474 /**
475  * Logic shared between #WM_file_read & #wm_homefile_read,
476  * updates to make after reading a file.
477  */
478 static void wm_file_read_post(bContext *C, const bool is_startup_file, const bool reset_app_template)
479 {
480         bool addons_loaded = false;
481         wmWindowManager *wm = CTX_wm_manager(C);
482
483         if (!G.background) {
484                 /* remove windows which failed to be added via WM_check */
485                 wm_window_ghostwindows_remove_invalid(C, wm);
486         }
487
488         CTX_wm_window_set(C, wm->windows.first);
489
490         Main *bmain = CTX_data_main(C);
491         DEG_on_visible_update(bmain, true);
492         wm_event_do_depsgraph(C);
493
494         ED_editors_init(C);
495
496 #ifdef WITH_PYTHON
497         if (is_startup_file) {
498                 /* possible python hasn't been initialized */
499                 if (CTX_py_init_get(C)) {
500                         if (reset_app_template) {
501                                 /* Only run when we have a template path found. */
502                                 if (BKE_appdir_app_template_any()) {
503                                         BPY_execute_string(
504                                                 C, (const char *[]){"bl_app_template_utils", NULL},
505                                                 "bl_app_template_utils.reset()");
506                                 }
507                                 /* sync addons, these may have changed from the defaults */
508                                 BPY_execute_string(
509                                         C, (const char *[]){"addon_utils", NULL},
510                                         "addon_utils.reset_all()");
511                         }
512                         BPY_python_reset(C);
513                         addons_loaded = true;
514                 }
515         }
516         else {
517                 /* run any texts that were loaded in and flagged as modules */
518                 BPY_python_reset(C);
519                 addons_loaded = true;
520         }
521 #else
522         UNUSED_VARS(is_startup_file, reset_app_template);
523 #endif  /* WITH_PYTHON */
524
525         WM_operatortype_last_properties_clear_all();
526
527         /* important to do before NULL'ing the context */
528         BLI_callback_exec(bmain, NULL, BLI_CB_EVT_VERSION_UPDATE);
529         BLI_callback_exec(bmain, NULL, BLI_CB_EVT_LOAD_POST);
530
531 #if 1
532         WM_event_add_notifier(C, NC_WM | ND_FILEREAD, NULL);
533 #else
534         WM_msg_publish_static(CTX_wm_message_bus(C), WM_MSG_STATICTYPE_FILE_READ);
535 #endif
536
537         /* report any errors.
538          * currently disabled if addons aren't yet loaded */
539         if (addons_loaded) {
540                 wm_file_read_report(C, bmain);
541         }
542
543         if (!G.background) {
544                 if (wm->undo_stack == NULL) {
545                         wm->undo_stack = BKE_undosys_stack_create();
546                 }
547                 else {
548                         BKE_undosys_stack_clear(wm->undo_stack);
549                 }
550                 BKE_undosys_stack_init_from_main(wm->undo_stack, bmain);
551                 BKE_undosys_stack_init_from_context(wm->undo_stack, C);
552         }
553
554         if (!G.background) {
555                 /* in background mode this makes it hard to load
556                  * a blend file and do anything since the screen
557                  * won't be set to a valid value again */
558                 CTX_wm_window_set(C, NULL); /* exits queues */
559
560                 /* Ensure tools are registered. */
561                 WM_toolsystem_init(C);
562         }
563 }
564
565 bool WM_file_read(bContext *C, const char *filepath, ReportList *reports)
566 {
567         /* assume automated tasks with background, don't write recent file list */
568         const bool do_history = (G.background == false) && (CTX_wm_manager(C)->op_undo_depth == 0);
569         bool success = false;
570         int retval;
571
572         /* so we can get the error message */
573         errno = 0;
574
575         WM_cursor_wait(1);
576
577         BLI_callback_exec(CTX_data_main(C), NULL, BLI_CB_EVT_LOAD_PRE);
578
579         UI_view2d_zoom_cache_reset();
580
581         /* first try to append data from exotic file formats... */
582         /* it throws error box when file doesn't exist and returns -1 */
583         /* note; it should set some error message somewhere... (ton) */
584         retval = wm_read_exotic(filepath);
585
586         /* we didn't succeed, now try to read Blender file */
587         if (retval == BKE_READ_EXOTIC_OK_BLEND) {
588                 int G_f = G.f;
589                 ListBase wmbase;
590
591                 /* put aside screens to match with persistent windows later */
592                 /* also exit screens and editors */
593                 wm_window_match_init(C, &wmbase);
594
595                 /* confusing this global... */
596                 G.relbase_valid = 1;
597                 retval = BKE_blendfile_read(
598                         C, filepath,
599                         &(const struct BlendFileReadParams){0},
600                         reports);
601
602                 /* BKE_file_read sets new Main into context. */
603                 Main *bmain = CTX_data_main(C);
604
605                 /* when loading startup.blend's, we can be left with a blank path */
606                 if (BKE_main_blendfile_path(bmain)) {
607                         G.save_over = 1;
608                 }
609                 else {
610                         G.save_over = 0;
611                         G.relbase_valid = 0;
612                 }
613
614                 /* this flag is initialized by the operator but overwritten on read.
615                  * need to re-enable it here else drivers + registered scripts wont work. */
616                 if (G.f != G_f) {
617                         const int flags_keep = (G_SCRIPT_AUTOEXEC | G_SCRIPT_OVERRIDE_PREF);
618                         G.f = (G.f & ~flags_keep) | (G_f & flags_keep);
619                 }
620
621                 /* match the read WM with current WM */
622                 wm_window_match_do(C, &wmbase, &bmain->wm, &bmain->wm);
623                 WM_check(C); /* opens window(s), checks keymaps */
624
625                 if (retval == BKE_BLENDFILE_READ_OK_USERPREFS) {
626                         /* in case a userdef is read from regular .blend */
627                         wm_init_userdef(bmain, false);
628                 }
629
630                 if (retval != BKE_BLENDFILE_READ_FAIL) {
631                         if (do_history) {
632                                 wm_history_file_update();
633                         }
634                 }
635
636                 wm_file_read_post(C, false, false);
637
638                 success = true;
639         }
640 #if 0
641         else if (retval == BKE_READ_EXOTIC_OK_OTHER)
642                 BKE_undo_write(C, "Import file");
643 #endif
644         else if (retval == BKE_READ_EXOTIC_FAIL_OPEN) {
645                 BKE_reportf(reports, RPT_ERROR, "Cannot read file '%s': %s", filepath,
646                             errno ? strerror(errno) : TIP_("unable to open the file"));
647         }
648         else if (retval == BKE_READ_EXOTIC_FAIL_FORMAT) {
649                 BKE_reportf(reports, RPT_ERROR, "File format is not supported in file '%s'", filepath);
650         }
651         else if (retval == BKE_READ_EXOTIC_FAIL_PATH) {
652                 BKE_reportf(reports, RPT_ERROR, "File path '%s' invalid", filepath);
653         }
654         else {
655                 BKE_reportf(reports, RPT_ERROR, "Unknown error loading '%s'", filepath);
656                 BLI_assert(!"invalid 'retval'");
657         }
658
659
660         if (success == false) {
661                 /* remove from recent files list */
662                 if (do_history) {
663                         RecentFile *recent = wm_file_history_find(filepath);
664                         if (recent) {
665                                 wm_history_file_free(recent);
666                                 wm_history_file_write();
667                         }
668                 }
669         }
670
671         WM_cursor_wait(0);
672
673         return success;
674
675 }
676
677 struct {
678         char app_template[64];
679         bool override;
680 } wm_init_state_app_template = {{0}};
681
682 /**
683  * Used for setting app-template from the command line:
684  * - non-empty string: overrides.
685  * - empty string: override, using no app template.
686  * - NULL: clears override.
687  */
688 void WM_init_state_app_template_set(const char *app_template)
689 {
690         if (app_template) {
691                 STRNCPY(wm_init_state_app_template.app_template, app_template);
692                 wm_init_state_app_template.override = true;
693         }
694         else {
695                 wm_init_state_app_template.app_template[0] = '\0';
696                 wm_init_state_app_template.override = false;
697         }
698 }
699
700 const char *WM_init_state_app_template_get(void)
701 {
702         return wm_init_state_app_template.override ? wm_init_state_app_template.app_template : NULL;
703 }
704
705
706 static bool wm_app_template_has_userpref(const char *app_template)
707 {
708         /* Test if app template provides a userpref.blend. If not, we will
709          * share user preferences with the rest of Blender. */
710         if (!app_template && app_template[0]) {
711                 return false;
712         }
713
714         char app_template_path[FILE_MAX];
715         if (!BKE_appdir_app_template_id_search(app_template, app_template_path, sizeof(app_template_path))) {
716                 return false;
717         }
718
719         char userpref_path[FILE_MAX];
720         BLI_path_join(userpref_path, sizeof(userpref_path), app_template_path, BLENDER_USERPREF_FILE, NULL);
721         return BLI_exists(userpref_path);
722 }
723
724 /**
725  * Called on startup, (context entirely filled with NULLs)
726  * or called for 'New File' both startup.blend and userpref.blend are checked.
727  *
728  * \param use_factory_settings: Ignore on-disk startup file, use bundled ``datatoc_startup_blend`` instead.
729  * Used for "Restore Factory Settings".
730  * \param use_userdef: Load factory settings as well as startup file.
731  * Disabled for "File New" we don't want to reload preferences.
732  * \param filepath_startup_override: Optional path pointing to an alternative blend file (may be NULL).
733  * \param app_template_override: Template to use instead of the template defined in user-preferences.
734  * When not-null, this is written into the user preferences.
735  */
736 void wm_homefile_read(
737         bContext *C, ReportList *reports,
738         bool use_factory_settings, bool use_empty_data, bool use_userdef,
739         const char *filepath_startup_override, const char *app_template_override)
740 {
741         Main *bmain = G_MAIN;  /* Context does not always have valid main pointer here... */
742         ListBase wmbase;
743         bool success = false;
744
745         char filepath_startup[FILE_MAX];
746         char filepath_userdef[FILE_MAX];
747
748         /* When 'app_template' is set: '{BLENDER_USER_CONFIG}/{app_template}' */
749         char app_template_system[FILE_MAX];
750         /* When 'app_template' is set: '{BLENDER_SYSTEM_SCRIPTS}/startup/bl_app_templates_system/{app_template}' */
751         char app_template_config[FILE_MAX];
752
753         /* Indicates whether user preferences were really load from memory.
754          *
755          * This is used for versioning code, and for this we can not rely on use_factory_settings
756          * passed via argument. This is because there might be configuration folder
757          * exists but it might not have userpref.blend and in this case we fallback to
758          * reading home file from memory.
759          *
760          * And in this case versioning code is to be run.
761          */
762         bool read_userdef_from_memory = false;
763         eBLOReadSkip skip_flags = use_userdef ? 0 : BLO_READ_SKIP_USERDEF;
764
765         /* options exclude eachother */
766         BLI_assert((use_factory_settings && filepath_startup_override) == 0);
767
768         if ((G.f & G_SCRIPT_OVERRIDE_PREF) == 0) {
769                 SET_FLAG_FROM_TEST(G.f, (U.flag & USER_SCRIPT_AUTOEXEC_DISABLE) == 0, G_SCRIPT_AUTOEXEC);
770         }
771
772         BLI_callback_exec(CTX_data_main(C), NULL, BLI_CB_EVT_LOAD_PRE);
773
774         UI_view2d_zoom_cache_reset();
775
776         G.relbase_valid = 0;
777
778         /* put aside screens to match with persistent windows later */
779         wm_window_match_init(C, &wmbase);
780
781         filepath_startup[0] = '\0';
782         filepath_userdef[0] = '\0';
783         app_template_system[0] = '\0';
784         app_template_config[0] = '\0';
785
786         const char * const cfgdir = BKE_appdir_folder_id(BLENDER_USER_CONFIG, NULL);
787         if (!use_factory_settings) {
788                 if (cfgdir) {
789                         BLI_path_join(filepath_startup, sizeof(filepath_startup), cfgdir, BLENDER_STARTUP_FILE, NULL);
790                         if (use_userdef) {
791                                 BLI_path_join(filepath_userdef, sizeof(filepath_startup), cfgdir, BLENDER_USERPREF_FILE, NULL);
792                         }
793                 }
794                 else {
795                         use_factory_settings = true;
796                 }
797
798                 if (filepath_startup_override) {
799                         BLI_strncpy(filepath_startup, filepath_startup_override, FILE_MAX);
800                 }
801         }
802
803         /* load preferences before startup.blend */
804         if (use_userdef) {
805                 if (!use_factory_settings && BLI_exists(filepath_userdef)) {
806                         UserDef *userdef = BKE_blendfile_userdef_read(filepath_userdef, NULL);
807                         if (userdef != NULL) {
808                                 BKE_blender_userdef_data_set_and_free(userdef);
809                                 userdef = NULL;
810
811                                 skip_flags |= BLO_READ_SKIP_USERDEF;
812                                 printf("Read prefs: %s\n", filepath_userdef);
813                         }
814                 }
815         }
816
817         const char *app_template = NULL;
818         bool update_defaults = false;
819         bool reset_app_template = false;
820
821         if (filepath_startup_override != NULL) {
822                 /* pass */
823         }
824         else if (app_template_override) {
825                 /* This may be clearing the current template by setting to an empty string. */
826                 app_template = app_template_override;
827         }
828         else if (!use_factory_settings && U.app_template[0]) {
829                 app_template = U.app_template;
830         }
831
832         if ((!app_template && U.app_template[0]) ||
833             (app_template && !STREQ(app_template, U.app_template)))
834         {
835                 /* Always load UI when switching to another template. */
836                 G.fileflags &= ~G_FILE_NO_UI;
837                 reset_app_template = true;
838         }
839
840         if ((app_template != NULL) && (app_template[0] != '\0')) {
841                 if (!BKE_appdir_app_template_id_search(app_template, app_template_system, sizeof(app_template_system))) {
842                         /* Can safely continue with code below, just warn it's not found. */
843                         BKE_reportf(reports, RPT_WARNING, "Application Template '%s' not found.", app_template);
844                 }
845
846                 /* Insert template name into startup file. */
847
848                 /* note that the path is being set even when 'use_factory_settings == true'
849                  * this is done so we can load a templates factory-settings */
850                 if (!use_factory_settings) {
851                         BLI_path_join(app_template_config, sizeof(app_template_config), cfgdir, app_template, NULL);
852                         BLI_path_join(filepath_startup, sizeof(filepath_startup), app_template_config, BLENDER_STARTUP_FILE, NULL);
853                         if (BLI_access(filepath_startup, R_OK) != 0) {
854                                 filepath_startup[0] = '\0';
855                         }
856                 }
857                 else {
858                         filepath_startup[0] = '\0';
859                 }
860
861                 if (filepath_startup[0] == '\0') {
862                         BLI_path_join(filepath_startup, sizeof(filepath_startup), app_template_system, BLENDER_STARTUP_FILE, NULL);
863
864                         /* Update defaults only for system templates. */
865                         update_defaults = true;
866                 }
867         }
868
869         if (!use_factory_settings || (filepath_startup[0] != '\0')) {
870                 if (BLI_access(filepath_startup, R_OK) == 0) {
871                         success = BKE_blendfile_read(
872                                 C, filepath_startup,
873                                 &(const struct BlendFileReadParams){
874                                     .is_startup = true,
875                                     .skip_flags = skip_flags,
876                                 },
877                                 NULL) != BKE_BLENDFILE_READ_FAIL;
878                 }
879                 if (BLI_listbase_is_empty(&U.themes)) {
880                         if (G.debug & G_DEBUG)
881                                 printf("\nNote: No (valid) '%s' found, fall back to built-in default.\n\n", filepath_startup);
882                         success = false;
883                 }
884                 if (success && update_defaults) {
885                         BLO_update_defaults_startup_blend(CTX_data_main(C), app_template);
886                 }
887         }
888
889         if (success == false && filepath_startup_override && reports) {
890                 /* We can not return from here because wm is already reset */
891                 BKE_reportf(reports, RPT_ERROR, "Could not read '%s'", filepath_startup_override);
892         }
893
894         if (success == false) {
895                 success = BKE_blendfile_read_from_memory(
896                         C, datatoc_startup_blend, datatoc_startup_blend_size, true,
897                         &(const struct BlendFileReadParams){
898                             .is_startup = true,
899                             .skip_flags = skip_flags,
900                         },
901                         NULL);
902                 if (success) {
903                         if (use_userdef) {
904                                 if ((skip_flags & BLO_READ_SKIP_USERDEF) == 0) {
905                                         read_userdef_from_memory = true;
906                                 }
907                         }
908                 }
909                 if (BLI_listbase_is_empty(&wmbase)) {
910                         wm_clear_default_size(C);
911                 }
912         }
913
914         if (use_empty_data) {
915                 BKE_blendfile_read_make_empty(C);
916         }
917
918         /* Load template preferences,
919          * unlike regular preferences we only use some of the settings,
920          * see: BKE_blender_userdef_set_app_template */
921         if (app_template_system[0] != '\0') {
922                 char temp_path[FILE_MAX];
923                 temp_path[0] = '\0';
924                 if (!use_factory_settings) {
925                         BLI_path_join(temp_path, sizeof(temp_path), app_template_config, BLENDER_USERPREF_FILE, NULL);
926                         if (BLI_access(temp_path, R_OK) != 0) {
927                                 temp_path[0] = '\0';
928                         }
929                 }
930
931                 if (temp_path[0] == '\0') {
932                         BLI_path_join(temp_path, sizeof(temp_path), app_template_system, BLENDER_USERPREF_FILE, NULL);
933                 }
934
935                 if (use_userdef) {
936                         UserDef *userdef_template = NULL;
937                         /* just avoids missing file warning */
938                         if (BLI_exists(temp_path)) {
939                                 userdef_template = BKE_blendfile_userdef_read(temp_path, NULL);
940                         }
941                         if (userdef_template == NULL) {
942                                 /* we need to have preferences load to overwrite preferences from previous template */
943                                 userdef_template = BKE_blendfile_userdef_read_from_memory(
944                                         datatoc_startup_blend, datatoc_startup_blend_size, NULL);
945                                 read_userdef_from_memory = true;
946                         }
947                         if (userdef_template) {
948                                 BKE_blender_userdef_app_template_data_set_and_free(userdef_template);
949                                 userdef_template = NULL;
950                         }
951                 }
952         }
953
954         if (app_template_override) {
955                 BLI_strncpy(U.app_template, app_template_override, sizeof(U.app_template));
956         }
957
958         /* prevent buggy files that had G_FILE_RELATIVE_REMAP written out by mistake. Screws up autosaves otherwise
959          * can remove this eventually, only in a 2.53 and older, now its not written */
960         G.fileflags &= ~G_FILE_RELATIVE_REMAP;
961
962         bmain = CTX_data_main(C);
963
964         if (use_userdef) {
965                 /* check userdef before open window, keymaps etc */
966                 wm_init_userdef(bmain, read_userdef_from_memory);
967                 reset_app_template = true;
968         }
969
970         /* match the read WM with current WM */
971         wm_window_match_do(C, &wmbase, &bmain->wm, &bmain->wm);
972
973         if (use_factory_settings) {
974                 /*  Clear keymaps because the current default keymap may have been initialized from user preferences,
975                  *  which have been reset. */
976                 for (wmWindowManager *wm = bmain->wm.first; wm; wm = wm->id.next) {
977                         if (wm->defaultconf) {
978                                 wm->defaultconf->flag &= ~KEYCONF_INIT_DEFAULT;
979                         }
980                 }
981         }
982
983         WM_check(C); /* opens window(s), checks keymaps */
984
985         bmain->name[0] = '\0';
986
987         /* start with save preference untitled.blend */
988         G.save_over = 0;
989
990         wm_file_read_post(C, true, reset_app_template);
991 }
992
993 /** \name WM History File API
994  * \{ */
995
996 void wm_history_file_read(void)
997 {
998         char name[FILE_MAX];
999         LinkNode *l, *lines;
1000         struct RecentFile *recent;
1001         const char *line;
1002         int num;
1003         const char * const cfgdir = BKE_appdir_folder_id(BLENDER_USER_CONFIG, NULL);
1004
1005         if (!cfgdir) return;
1006
1007         BLI_make_file_string("/", name, cfgdir, BLENDER_HISTORY_FILE);
1008
1009         lines = BLI_file_read_as_lines(name);
1010
1011         BLI_listbase_clear(&G.recent_files);
1012
1013         /* read list of recent opened files from recent-files.txt to memory */
1014         for (l = lines, num = 0; l && (num < U.recent_files); l = l->next) {
1015                 line = l->link;
1016                 /* don't check if files exist, causes slow startup for remote/external drives */
1017                 if (line[0]) {
1018                         recent = (RecentFile *)MEM_mallocN(sizeof(RecentFile), "RecentFile");
1019                         BLI_addtail(&(G.recent_files), recent);
1020                         recent->filepath = BLI_strdup(line);
1021                         num++;
1022                 }
1023         }
1024
1025         BLI_file_free_lines(lines);
1026 }
1027
1028 static RecentFile *wm_history_file_new(const char *filepath)
1029 {
1030         RecentFile *recent = MEM_mallocN(sizeof(RecentFile), "RecentFile");
1031         recent->filepath = BLI_strdup(filepath);
1032         return recent;
1033 }
1034
1035 static void wm_history_file_free(RecentFile *recent)
1036 {
1037         BLI_assert(BLI_findindex(&G.recent_files, recent) != -1);
1038         MEM_freeN(recent->filepath);
1039         BLI_freelinkN(&G.recent_files, recent);
1040 }
1041
1042 static RecentFile *wm_file_history_find(const char *filepath)
1043 {
1044         return BLI_findstring_ptr(&G.recent_files, filepath, offsetof(RecentFile, filepath));
1045 }
1046
1047 /**
1048  * Write #BLENDER_HISTORY_FILE as-is, without checking the environment
1049  * (that's handled by #wm_history_file_update).
1050  */
1051 static void wm_history_file_write(void)
1052 {
1053         const char *user_config_dir;
1054         char name[FILE_MAX];
1055         FILE *fp;
1056
1057         /* will be NULL in background mode */
1058         user_config_dir = BKE_appdir_folder_id_create(BLENDER_USER_CONFIG, NULL);
1059         if (!user_config_dir)
1060                 return;
1061
1062         BLI_make_file_string("/", name, user_config_dir, BLENDER_HISTORY_FILE);
1063
1064         fp = BLI_fopen(name, "w");
1065         if (fp) {
1066                 struct RecentFile *recent;
1067                 for (recent = G.recent_files.first; recent; recent = recent->next) {
1068                         fprintf(fp, "%s\n", recent->filepath);
1069                 }
1070                 fclose(fp);
1071         }
1072 }
1073
1074 /**
1075  * Run after saving a file to refresh the #BLENDER_HISTORY_FILE list.
1076  */
1077 static void wm_history_file_update(void)
1078 {
1079         RecentFile *recent;
1080         const char *blendfile_name = BKE_main_blendfile_path_from_global();
1081
1082         /* no write history for recovered startup files */
1083         if (blendfile_name[0] == '\0') {
1084                 return;
1085         }
1086
1087         recent = G.recent_files.first;
1088         /* refresh recent-files.txt of recent opened files, when current file was changed */
1089         if (!(recent) || (BLI_path_cmp(recent->filepath, blendfile_name) != 0)) {
1090
1091                 recent = wm_file_history_find(blendfile_name);
1092                 if (recent) {
1093                         BLI_remlink(&G.recent_files, recent);
1094                 }
1095                 else {
1096                         RecentFile *recent_next;
1097                         for (recent = BLI_findlink(&G.recent_files, U.recent_files - 1); recent; recent = recent_next) {
1098                                 recent_next = recent->next;
1099                                 wm_history_file_free(recent);
1100                         }
1101                         recent = wm_history_file_new(blendfile_name);
1102                 }
1103
1104                 /* add current file to the beginning of list */
1105                 BLI_addhead(&(G.recent_files), recent);
1106
1107                 /* write current file to recent-files.txt */
1108                 wm_history_file_write();
1109
1110                 /* also update most recent files on System */
1111                 GHOST_addToSystemRecentFiles(blendfile_name);
1112         }
1113 }
1114
1115 /** \} */
1116
1117
1118 /* screen can be NULL */
1119 static ImBuf *blend_file_thumb(const bContext *C, Scene *scene, bScreen *screen, BlendThumbnail **thumb_pt)
1120 {
1121         /* will be scaled down, but gives some nice oversampling */
1122         ImBuf *ibuf;
1123         BlendThumbnail *thumb;
1124         char err_out[256] = "unknown";
1125
1126         /* screen if no camera found */
1127         ScrArea *sa = NULL;
1128         ARegion *ar = NULL;
1129         View3D *v3d = NULL;
1130
1131         /* In case we are given a valid thumbnail data, just generate image from it. */
1132         if (*thumb_pt) {
1133                 thumb = *thumb_pt;
1134                 return BKE_main_thumbnail_to_imbuf(NULL, thumb);
1135         }
1136
1137         /* scene can be NULL if running a script at startup and calling the save operator */
1138         if (G.background || scene == NULL)
1139                 return NULL;
1140
1141         if ((scene->camera == NULL) && (screen != NULL)) {
1142                 sa = BKE_screen_find_big_area(screen, SPACE_VIEW3D, 0);
1143                 ar = BKE_area_find_region_type(sa, RGN_TYPE_WINDOW);
1144                 if (ar) {
1145                         v3d = sa->spacedata.first;
1146                 }
1147         }
1148
1149         if (scene->camera == NULL && v3d == NULL) {
1150                 return NULL;
1151         }
1152
1153         /* gets scaled to BLEN_THUMB_SIZE */
1154         Depsgraph *depsgraph = CTX_data_depsgraph(C);
1155
1156         if (scene->camera) {
1157                 ibuf = ED_view3d_draw_offscreen_imbuf_simple(
1158                         depsgraph, scene, OB_SOLID, scene->camera,
1159                         BLEN_THUMB_SIZE * 2, BLEN_THUMB_SIZE * 2,
1160                         IB_rect, V3D_OFSDRAW_NONE, R_ALPHAPREMUL, 0, NULL,
1161                         NULL, err_out);
1162         }
1163         else {
1164                 ibuf = ED_view3d_draw_offscreen_imbuf(
1165                         depsgraph, scene, OB_SOLID, v3d, ar,
1166                         BLEN_THUMB_SIZE * 2, BLEN_THUMB_SIZE * 2,
1167                         IB_rect, V3D_OFSDRAW_NONE, R_ALPHAPREMUL, 0, NULL,
1168                         NULL, err_out);
1169         }
1170
1171         if (ibuf) {
1172                 float aspect = (scene->r.xsch * scene->r.xasp) / (scene->r.ysch * scene->r.yasp);
1173
1174                 /* dirty oversampling */
1175                 IMB_scaleImBuf(ibuf, BLEN_THUMB_SIZE, BLEN_THUMB_SIZE);
1176
1177                 /* add pretty overlay */
1178                 IMB_thumb_overlay_blend(ibuf->rect, ibuf->x, ibuf->y, aspect);
1179
1180                 thumb = BKE_main_thumbnail_from_imbuf(NULL, ibuf);
1181         }
1182         else {
1183                 /* '*thumb_pt' needs to stay NULL to prevent a bad thumbnail from being handled */
1184                 fprintf(stderr, "blend_file_thumb failed to create thumbnail: %s\n", err_out);
1185                 thumb = NULL;
1186         }
1187
1188         /* must be freed by caller */
1189         *thumb_pt = thumb;
1190
1191         return ibuf;
1192 }
1193
1194 /* easy access from gdb */
1195 bool write_crash_blend(void)
1196 {
1197         char path[FILE_MAX];
1198         int fileflags = G.fileflags & ~(G_FILE_HISTORY); /* don't do file history on crash file */
1199
1200         BLI_strncpy(path, BKE_main_blendfile_path_from_global(), sizeof(path));
1201         BLI_path_extension_replace(path, sizeof(path), "_crash.blend");
1202         if (BLO_write_file(G_MAIN, path, fileflags, NULL, NULL)) {
1203                 printf("written: %s\n", path);
1204                 return 1;
1205         }
1206         else {
1207                 printf("failed: %s\n", path);
1208                 return 0;
1209         }
1210 }
1211
1212 /**
1213  * \see #wm_homefile_write_exec wraps #BLO_write_file in a similar way.
1214  */
1215 static bool wm_file_write(bContext *C, const char *filepath, int fileflags, ReportList *reports)
1216 {
1217         Main *bmain = CTX_data_main(C);
1218         Library *li;
1219         int len;
1220         int ok = false;
1221         BlendThumbnail *thumb, *main_thumb;
1222         ImBuf *ibuf_thumb = NULL;
1223
1224         len = strlen(filepath);
1225
1226         if (len == 0) {
1227                 BKE_report(reports, RPT_ERROR, "Path is empty, cannot save");
1228                 return ok;
1229         }
1230
1231         if (len >= FILE_MAX) {
1232                 BKE_report(reports, RPT_ERROR, "Path too long, cannot save");
1233                 return ok;
1234         }
1235
1236         /* Check if file write permission is ok */
1237         if (BLI_exists(filepath) && !BLI_file_is_writable(filepath)) {
1238                 BKE_reportf(reports, RPT_ERROR, "Cannot save blend file, path '%s' is not writable", filepath);
1239                 return ok;
1240         }
1241
1242         /* note: used to replace the file extension (to ensure '.blend'),
1243          * no need to now because the operator ensures,
1244          * its handy for scripts to save to a predefined name without blender editing it */
1245
1246         /* send the OnSave event */
1247         for (li = bmain->library.first; li; li = li->id.next) {
1248                 if (BLI_path_cmp(li->filepath, filepath) == 0) {
1249                         BKE_reportf(reports, RPT_ERROR, "Cannot overwrite used library '%.240s'", filepath);
1250                         return ok;
1251                 }
1252         }
1253
1254         /* Call pre-save callbacks befores writing preview, that way you can generate custom file thumbnail... */
1255         BLI_callback_exec(bmain, NULL, BLI_CB_EVT_SAVE_PRE);
1256
1257         /* blend file thumbnail */
1258         /* save before exit_editmode, otherwise derivedmeshes for shared data corrupt #27765) */
1259         /* Main now can store a .blend thumbnail, useful for background mode or thumbnail customization. */
1260         main_thumb = thumb = bmain->blen_thumb;
1261         if ((U.flag & USER_SAVE_PREVIEWS) && BLI_thread_is_main()) {
1262                 ibuf_thumb = blend_file_thumb(C, CTX_data_scene(C), CTX_wm_screen(C), &thumb);
1263         }
1264
1265         /* operator now handles overwrite checks */
1266
1267         if (G.fileflags & G_AUTOPACK) {
1268                 packAll(bmain, reports, false);
1269         }
1270
1271         /* don't forget not to return without! */
1272         WM_cursor_wait(1);
1273
1274         ED_editors_flush_edits(C, false);
1275
1276         fileflags |= G_FILE_HISTORY; /* write file history */
1277
1278         /* first time saving */
1279         /* XXX temp solution to solve bug, real fix coming (ton) */
1280         if ((BKE_main_blendfile_path(bmain)[0] == '\0') && !(fileflags & G_FILE_SAVE_COPY)) {
1281                 BLI_strncpy(bmain->name, filepath, sizeof(bmain->name));
1282         }
1283
1284         /* XXX temp solution to solve bug, real fix coming (ton) */
1285         bmain->recovered = 0;
1286
1287         if (BLO_write_file(CTX_data_main(C), filepath, fileflags, reports, thumb)) {
1288                 const bool do_history = (G.background == false) && (CTX_wm_manager(C)->op_undo_depth == 0);
1289
1290                 if (!(fileflags & G_FILE_SAVE_COPY)) {
1291                         G.relbase_valid = 1;
1292                         BLI_strncpy(bmain->name, filepath, sizeof(bmain->name));  /* is guaranteed current file */
1293
1294                         G.save_over = 1; /* disable untitled.blend convention */
1295                 }
1296
1297                 SET_FLAG_FROM_TEST(G.fileflags, fileflags & G_FILE_COMPRESS, G_FILE_COMPRESS);
1298
1299                 /* prevent background mode scripts from clobbering history */
1300                 if (do_history) {
1301                         wm_history_file_update();
1302                 }
1303
1304                 BLI_callback_exec(bmain, NULL, BLI_CB_EVT_SAVE_POST);
1305
1306                 /* run this function after because the file cant be written before the blend is */
1307                 if (ibuf_thumb) {
1308                         IMB_thumb_delete(filepath, THB_FAIL); /* without this a failed thumb overrides */
1309                         ibuf_thumb = IMB_thumb_create(filepath, THB_LARGE, THB_SOURCE_BLEND, ibuf_thumb);
1310                 }
1311
1312                 /* Success. */
1313                 ok = true;
1314         }
1315
1316         if (ibuf_thumb) {
1317                 IMB_freeImBuf(ibuf_thumb);
1318         }
1319         if (thumb && thumb != main_thumb) {
1320                 MEM_freeN(thumb);
1321         }
1322
1323         WM_cursor_wait(0);
1324
1325         return ok;
1326 }
1327
1328 /************************ autosave ****************************/
1329
1330 void wm_autosave_location(char *filepath)
1331 {
1332         const int pid = abs(getpid());
1333         char path[1024];
1334 #ifdef WIN32
1335         const char *savedir;
1336 #endif
1337
1338         if (G_MAIN && G.relbase_valid) {
1339                 const char *basename = BLI_path_basename(BKE_main_blendfile_path_from_global());
1340                 int len = strlen(basename) - 6;
1341                 BLI_snprintf(path, sizeof(path), "%.*s.blend", len, basename);
1342         }
1343         else {
1344                 BLI_snprintf(path, sizeof(path), "%d.blend", pid);
1345         }
1346
1347 #ifdef WIN32
1348         /* XXX Need to investigate how to handle default location of '/tmp/'
1349          * This is a relative directory on Windows, and it may be
1350          * found. Example:
1351          * Blender installed on D:\ drive, D:\ drive has D:\tmp\
1352          * Now, BLI_exists() will find '/tmp/' exists, but
1353          * BLI_make_file_string will create string that has it most likely on C:\
1354          * through get_default_root().
1355          * If there is no C:\tmp autosave fails. */
1356         if (!BLI_exists(BKE_tempdir_base())) {
1357                 savedir = BKE_appdir_folder_id_create(BLENDER_USER_AUTOSAVE, NULL);
1358                 BLI_make_file_string("/", filepath, savedir, path);
1359                 return;
1360         }
1361 #endif
1362
1363         BLI_make_file_string("/", filepath, BKE_tempdir_base(), path);
1364 }
1365
1366 void WM_autosave_init(wmWindowManager *wm)
1367 {
1368         wm_autosave_timer_ended(wm);
1369
1370         if (U.flag & USER_AUTOSAVE)
1371                 wm->autosavetimer = WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime * 60.0);
1372 }
1373
1374 void wm_autosave_timer(const bContext *C, wmWindowManager *wm, wmTimer *UNUSED(wt))
1375 {
1376         wmWindow *win;
1377         wmEventHandler *handler;
1378         char filepath[FILE_MAX];
1379
1380         WM_event_remove_timer(wm, NULL, wm->autosavetimer);
1381
1382         /* if a modal operator is running, don't autosave, but try again in 10 seconds */
1383         for (win = wm->windows.first; win; win = win->next) {
1384                 for (handler = win->modalhandlers.first; handler; handler = handler->next) {
1385                         if (handler->op) {
1386                                 wm->autosavetimer = WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, 10.0);
1387                                 if (G.debug) {
1388                                         printf("Skipping auto-save, modal operator running, retrying in ten seconds...\n");
1389                                 }
1390                                 return;
1391                         }
1392                 }
1393         }
1394
1395         wm_autosave_location(filepath);
1396
1397         if (U.uiflag & USER_GLOBALUNDO) {
1398                 /* fast save of last undobuffer, now with UI */
1399                 struct MemFile *memfile = ED_undosys_stack_memfile_get_active(wm->undo_stack);
1400                 if (memfile) {
1401                         BLO_memfile_write_file(memfile, filepath);
1402                 }
1403         }
1404         else {
1405                 /*  save as regular blend file */
1406                 int fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_HISTORY);
1407
1408                 ED_editors_flush_edits(C, false);
1409
1410                 /* Error reporting into console */
1411                 BLO_write_file(CTX_data_main(C), filepath, fileflags, NULL, NULL);
1412         }
1413         /* do timer after file write, just in case file write takes a long time */
1414         wm->autosavetimer = WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime * 60.0);
1415 }
1416
1417 void wm_autosave_timer_ended(wmWindowManager *wm)
1418 {
1419         if (wm->autosavetimer) {
1420                 WM_event_remove_timer(wm, NULL, wm->autosavetimer);
1421                 wm->autosavetimer = NULL;
1422         }
1423 }
1424
1425 void wm_autosave_delete(void)
1426 {
1427         char filename[FILE_MAX];
1428
1429         wm_autosave_location(filename);
1430
1431         if (BLI_exists(filename)) {
1432                 char str[FILE_MAX];
1433                 BLI_make_file_string("/", str, BKE_tempdir_base(), BLENDER_QUIT_FILE);
1434
1435                 /* if global undo; remove tempsave, otherwise rename */
1436                 if (U.uiflag & USER_GLOBALUNDO) BLI_delete(filename, false, false);
1437                 else BLI_rename(filename, str);
1438         }
1439 }
1440
1441 void wm_autosave_read(bContext *C, ReportList *reports)
1442 {
1443         char filename[FILE_MAX];
1444
1445         wm_autosave_location(filename);
1446         WM_file_read(C, filename, reports);
1447 }
1448
1449
1450 /** \name Initialize WM_OT_open_xxx properties
1451  *
1452  * Check if load_ui was set by the caller.
1453  * Fall back to user preference when file flags not specified.
1454  *
1455  * \{ */
1456
1457 void wm_open_init_load_ui(wmOperator *op, bool use_prefs)
1458 {
1459         PropertyRNA *prop = RNA_struct_find_property(op->ptr, "load_ui");
1460         if (!RNA_property_is_set(op->ptr, prop)) {
1461                 bool value = use_prefs ?
1462                              ((U.flag & USER_FILENOUI) == 0) :
1463                              ((G.fileflags & G_FILE_NO_UI) == 0);
1464
1465                 RNA_property_boolean_set(op->ptr, prop, value);
1466         }
1467 }
1468
1469 void wm_open_init_use_scripts(wmOperator *op, bool use_prefs)
1470 {
1471         PropertyRNA *prop = RNA_struct_find_property(op->ptr, "use_scripts");
1472         if (!RNA_property_is_set(op->ptr, prop)) {
1473                 /* use G_SCRIPT_AUTOEXEC rather than the userpref because this means if
1474                  * the flag has been disabled from the command line, then opening
1475                  * from the menu wont enable this setting. */
1476                 bool value = use_prefs ?
1477                              ((U.flag & USER_SCRIPT_AUTOEXEC_DISABLE) == 0) :
1478                              ((G.f & G_SCRIPT_AUTOEXEC) != 0);
1479
1480                 RNA_property_boolean_set(op->ptr, prop, value);
1481         }
1482 }
1483
1484 /** \} */
1485
1486 void WM_file_tag_modified(void)
1487 {
1488         wmWindowManager *wm = G_MAIN->wm.first;
1489         if (wm->file_saved) {
1490                 wm->file_saved = 0;
1491                 /* notifier that data changed, for save-over warning or header */
1492                 WM_main_add_notifier(NC_WM | ND_DATACHANGED, NULL);
1493         }
1494 }
1495
1496 /** \name Preferences/startup save & load.
1497  *
1498  * \{ */
1499
1500 /**
1501  * \see #wm_file_write wraps #BLO_write_file in a similar way.
1502  * \return success.
1503  */
1504 static int wm_homefile_write_exec(bContext *C, wmOperator *op)
1505 {
1506         Main *bmain = CTX_data_main(C);
1507         wmWindowManager *wm = CTX_wm_manager(C);
1508         wmWindow *win = CTX_wm_window(C);
1509         char filepath[FILE_MAX];
1510         int fileflags;
1511
1512         const char *app_template = U.app_template[0] ? U.app_template : NULL;
1513         const char * const cfgdir = BKE_appdir_folder_id_create(BLENDER_USER_CONFIG, app_template);
1514         if (cfgdir == NULL) {
1515                 BKE_report(op->reports, RPT_ERROR, "Unable to create user config path");
1516                 return OPERATOR_CANCELLED;
1517         }
1518
1519         BLI_callback_exec(bmain, NULL, BLI_CB_EVT_SAVE_PRE);
1520
1521         /* check current window and close it if temp */
1522         if (win && WM_window_is_temp_screen(win))
1523                 wm_window_close(C, wm, win);
1524
1525         /* update keymaps in user preferences */
1526         WM_keyconfig_update(wm);
1527
1528         BLI_path_join(filepath, sizeof(filepath), cfgdir, BLENDER_STARTUP_FILE, NULL);
1529
1530         printf("Writing homefile: '%s' ", filepath);
1531
1532         ED_editors_flush_edits(C, false);
1533
1534         /*  force save as regular blend file */
1535         fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_HISTORY);
1536
1537         if (BLO_write_file(bmain, filepath, fileflags | G_FILE_USERPREFS, op->reports, NULL) == 0) {
1538                 printf("fail\n");
1539                 return OPERATOR_CANCELLED;
1540         }
1541
1542         printf("ok\n");
1543
1544         G.save_over = 0;
1545
1546         BLI_callback_exec(bmain, NULL, BLI_CB_EVT_SAVE_POST);
1547
1548         return OPERATOR_FINISHED;
1549 }
1550
1551 void WM_OT_save_homefile(wmOperatorType *ot)
1552 {
1553         ot->name = "Save Startup File";
1554         ot->idname = "WM_OT_save_homefile";
1555         ot->description = "Make the current file the default .blend file";
1556
1557         ot->invoke = WM_operator_confirm;
1558         ot->exec = wm_homefile_write_exec;
1559 }
1560
1561 static int wm_userpref_autoexec_add_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
1562 {
1563         bPathCompare *path_cmp = MEM_callocN(sizeof(bPathCompare), "bPathCompare");
1564         BLI_addtail(&U.autoexec_paths, path_cmp);
1565         return OPERATOR_FINISHED;
1566 }
1567
1568 void WM_OT_userpref_autoexec_path_add(wmOperatorType *ot)
1569 {
1570         ot->name = "Add Autoexec Path";
1571         ot->idname = "WM_OT_userpref_autoexec_path_add";
1572         ot->description = "Add path to exclude from autoexecution";
1573
1574         ot->exec = wm_userpref_autoexec_add_exec;
1575
1576         ot->flag = OPTYPE_INTERNAL;
1577 }
1578
1579 static int wm_userpref_autoexec_remove_exec(bContext *UNUSED(C), wmOperator *op)
1580 {
1581         const int index = RNA_int_get(op->ptr, "index");
1582         bPathCompare *path_cmp = BLI_findlink(&U.autoexec_paths, index);
1583         if (path_cmp) {
1584                 BLI_freelinkN(&U.autoexec_paths, path_cmp);
1585         }
1586         return OPERATOR_FINISHED;
1587 }
1588
1589 void WM_OT_userpref_autoexec_path_remove(wmOperatorType *ot)
1590 {
1591         ot->name = "Remove Autoexec Path";
1592         ot->idname = "WM_OT_userpref_autoexec_path_remove";
1593         ot->description = "Remove path to exclude from autoexecution";
1594
1595         ot->exec = wm_userpref_autoexec_remove_exec;
1596
1597         ot->flag = OPTYPE_INTERNAL;
1598
1599         RNA_def_int(ot->srna, "index", 0, 0, INT_MAX, "Index", "", 0, 1000);
1600 }
1601
1602 /* Only save the prefs block. operator entry */
1603 static int wm_userpref_write_exec(bContext *C, wmOperator *op)
1604 {
1605         wmWindowManager *wm = CTX_wm_manager(C);
1606         char filepath[FILE_MAX];
1607         const char *cfgdir;
1608         bool ok = true;
1609         bool use_template_userpref = wm_app_template_has_userpref(U.app_template);
1610
1611         /* update keymaps in user preferences */
1612         WM_keyconfig_update(wm);
1613
1614         if ((cfgdir = BKE_appdir_folder_id_create(BLENDER_USER_CONFIG, NULL))) {
1615                 bool ok_write;
1616                 BLI_path_join(filepath, sizeof(filepath), cfgdir, BLENDER_USERPREF_FILE, NULL);
1617
1618                 printf("Writing userprefs: '%s' ", filepath);
1619                 if (use_template_userpref) {
1620                         ok_write = BKE_blendfile_userdef_write_app_template(filepath, op->reports);
1621                 }
1622                 else {
1623                         ok_write = BKE_blendfile_userdef_write(filepath, op->reports);
1624                 }
1625
1626                 if (ok_write) {
1627                         printf("ok\n");
1628                 }
1629                 else {
1630                         printf("fail\n");
1631                         ok = false;
1632                 }
1633         }
1634         else {
1635                 BKE_report(op->reports, RPT_ERROR, "Unable to create userpref path");
1636         }
1637
1638         if (use_template_userpref) {
1639                 if ((cfgdir = BKE_appdir_folder_id_create(BLENDER_USER_CONFIG, U.app_template))) {
1640                         /* Also save app-template prefs */
1641                         BLI_path_join(filepath, sizeof(filepath), cfgdir, BLENDER_USERPREF_FILE, NULL);
1642
1643                         printf("Writing userprefs app-template: '%s' ", filepath);
1644                         if (BKE_blendfile_userdef_write(filepath, op->reports) != 0) {
1645                                 printf("ok\n");
1646                         }
1647                         else {
1648                                 printf("fail\n");
1649                                 ok = false;
1650                         }
1651                 }
1652                 else {
1653                         BKE_report(op->reports, RPT_ERROR, "Unable to create app-template userpref path");
1654                         ok = false;
1655                 }
1656         }
1657
1658         return ok ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
1659 }
1660
1661 void WM_OT_save_userpref(wmOperatorType *ot)
1662 {
1663         ot->name = "Save Preferences";
1664         ot->idname = "WM_OT_save_userpref";
1665         ot->description = "Save user preferences separately, overrides startup file preferences";
1666
1667         ot->invoke = WM_operator_confirm;
1668         ot->exec = wm_userpref_write_exec;
1669 }
1670
1671 static int wm_history_file_read_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
1672 {
1673         ED_file_read_bookmarks();
1674         wm_history_file_read();
1675         return OPERATOR_FINISHED;
1676 }
1677
1678 void WM_OT_read_history(wmOperatorType *ot)
1679 {
1680         ot->name = "Reload History File";
1681         ot->idname = "WM_OT_read_history";
1682         ot->description = "Reloads history and bookmarks";
1683
1684         ot->invoke = WM_operator_confirm;
1685         ot->exec = wm_history_file_read_exec;
1686
1687         /* this operator is only used for loading settings from a previous blender install */
1688         ot->flag = OPTYPE_INTERNAL;
1689 }
1690
1691 static int wm_homefile_read_exec(bContext *C, wmOperator *op)
1692 {
1693         const bool use_factory_settings = (STREQ(op->type->idname, "WM_OT_read_factory_settings"));
1694         bool use_userdef = false;
1695         char filepath_buf[FILE_MAX];
1696         const char *filepath = NULL;
1697
1698         if (!use_factory_settings) {
1699                 PropertyRNA *prop = RNA_struct_find_property(op->ptr, "filepath");
1700
1701                 /* This can be used when loading of a start-up file should only change
1702                  * the scene content but keep the blender UI as it is. */
1703                 wm_open_init_load_ui(op, true);
1704                 SET_FLAG_FROM_TEST(G.fileflags, !RNA_boolean_get(op->ptr, "load_ui"), G_FILE_NO_UI);
1705
1706                 if (RNA_property_is_set(op->ptr, prop)) {
1707                         RNA_property_string_get(op->ptr, prop, filepath_buf);
1708                         filepath = filepath_buf;
1709                         if (BLI_access(filepath, R_OK)) {
1710                                 BKE_reportf(op->reports, RPT_ERROR, "Can't read alternative start-up file: '%s'", filepath);
1711                                 return OPERATOR_CANCELLED;
1712                         }
1713                 }
1714         }
1715         else {
1716                 /* always load UI for factory settings (prefs will re-init) */
1717                 G.fileflags &= ~G_FILE_NO_UI;
1718                 /* Always load preferences with factory settings. */
1719                 use_userdef = true;
1720         }
1721
1722         char app_template_buf[sizeof(U.app_template)];
1723         const char *app_template;
1724         PropertyRNA *prop_app_template = RNA_struct_find_property(op->ptr, "app_template");
1725         const bool use_splash = !use_factory_settings && RNA_boolean_get(op->ptr, "use_splash");
1726         const bool use_empty_data = RNA_boolean_get(op->ptr, "use_empty");
1727
1728         if (prop_app_template && RNA_property_is_set(op->ptr, prop_app_template)) {
1729                 RNA_property_string_get(op->ptr, prop_app_template, app_template_buf);
1730                 app_template = app_template_buf;
1731
1732                 /* Always load preferences when switching templates with own preferences. */
1733                 use_userdef = wm_app_template_has_userpref(app_template) ||
1734                               wm_app_template_has_userpref(U.app_template);
1735
1736                 /* Turn override off, since we're explicitly loading a different app-template. */
1737                 WM_init_state_app_template_set(NULL);
1738         }
1739         else {
1740                 /* Normally NULL, only set when overriding from the command-line. */
1741                 app_template = WM_init_state_app_template_get();
1742         }
1743
1744         wm_homefile_read(C, op->reports, use_factory_settings, use_empty_data, use_userdef, filepath, app_template);
1745         if (use_splash) {
1746                 WM_init_splash(C);
1747         }
1748         return OPERATOR_FINISHED;
1749 }
1750
1751 static int wm_homefile_read_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *UNUSED(event))
1752 {
1753         /* Draw menu which includes default startup and application templates. */
1754         uiPopupMenu *pup = UI_popup_menu_begin(C, IFACE_("New File"), ICON_FILE_NEW);
1755         uiLayout *layout = UI_popup_menu_layout(pup);
1756
1757         MenuType *mt = WM_menutype_find("TOPBAR_MT_file_new", false);
1758         if (mt) {
1759                 UI_menutype_draw(C, mt, layout);
1760         }
1761
1762         UI_popup_menu_end(C, pup);
1763
1764         return OPERATOR_INTERFACE;
1765 }
1766
1767 void WM_OT_read_homefile(wmOperatorType *ot)
1768 {
1769         PropertyRNA *prop;
1770         ot->name = "Reload Start-Up File";
1771         ot->idname = "WM_OT_read_homefile";
1772         ot->description = "Open the default file (doesn't save the current file)";
1773
1774         ot->invoke = wm_homefile_read_invoke;
1775         ot->exec = wm_homefile_read_exec;
1776
1777         prop = RNA_def_string_file_path(ot->srna, "filepath", NULL,
1778                                         FILE_MAX, "File Path",
1779                                         "Path to an alternative start-up file");
1780         RNA_def_property_flag(prop, PROP_HIDDEN);
1781
1782         /* So scripts can use an alternative start-up file without the UI */
1783         prop = RNA_def_boolean(ot->srna, "load_ui", true, "Load UI",
1784                                "Load user interface setup from the .blend file");
1785         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1786
1787         prop = RNA_def_boolean(ot->srna, "use_empty", false, "Empty", "");
1788         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1789
1790         /* So the splash can be kept open after loading a file (for templates). */
1791         prop = RNA_def_boolean(ot->srna, "use_splash", false, "Splash", "");
1792         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1793
1794         prop = RNA_def_string(ot->srna, "app_template", "Template", sizeof(U.app_template), "", "");
1795         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1796
1797         /* omit poll to run in background mode */
1798 }
1799
1800 void WM_OT_read_factory_settings(wmOperatorType *ot)
1801 {
1802         PropertyRNA *prop;
1803
1804         ot->name = "Load Factory Settings";
1805         ot->idname = "WM_OT_read_factory_settings";
1806         ot->description = "Load default file and user preferences";
1807
1808         ot->invoke = WM_operator_confirm;
1809         ot->exec = wm_homefile_read_exec;
1810
1811         prop = RNA_def_string(ot->srna, "app_template", "Template", sizeof(U.app_template), "", "");
1812         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1813
1814         prop = RNA_def_boolean(ot->srna, "use_empty", false, "Empty", "");
1815         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1816
1817         /* omit poll to run in background mode */
1818 }
1819
1820 /** \} */
1821
1822 /** \name Open main .blend file.
1823  *
1824  * \{ */
1825
1826 /**
1827  * Wrap #WM_file_read, shared by file reading operators.
1828  */
1829 static bool wm_file_read_opwrap(bContext *C, const char *filepath, ReportList *reports,
1830                                 const bool autoexec_init)
1831 {
1832         bool success;
1833
1834         /* XXX wm in context is not set correctly after WM_file_read -> crash */
1835         /* do it before for now, but is this correct with multiple windows? */
1836         WM_event_add_notifier(C, NC_WINDOW, NULL);
1837
1838         if (autoexec_init) {
1839                 WM_file_autoexec_init(filepath);
1840         }
1841
1842         success = WM_file_read(C, filepath, reports);
1843
1844         return success;
1845 }
1846
1847 /* currently fits in a pointer */
1848 struct FileRuntime {
1849         bool is_untrusted;
1850 };
1851
1852 static int wm_open_mainfile_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1853 {
1854         Main *bmain = CTX_data_main(C);
1855         const char *openname = BKE_main_blendfile_path(bmain);
1856
1857         if (CTX_wm_window(C) == NULL) {
1858                 /* in rare cases this could happen, when trying to invoke in background
1859                  * mode on load for example. Don't use poll for this because exec()
1860                  * can still run without a window */
1861                 BKE_report(op->reports, RPT_ERROR, "Context window not set");
1862                 return OPERATOR_CANCELLED;
1863         }
1864
1865         /* if possible, get the name of the most recently used .blend file */
1866         if (G.recent_files.first) {
1867                 struct RecentFile *recent = G.recent_files.first;
1868                 openname = recent->filepath;
1869         }
1870
1871         RNA_string_set(op->ptr, "filepath", openname);
1872         wm_open_init_load_ui(op, true);
1873         wm_open_init_use_scripts(op, true);
1874         op->customdata = NULL;
1875
1876         WM_event_add_fileselect(C, op);
1877
1878         return OPERATOR_RUNNING_MODAL;
1879 }
1880
1881 static int wm_open_mainfile_exec(bContext *C, wmOperator *op)
1882 {
1883         char filepath[FILE_MAX];
1884         bool success;
1885
1886         RNA_string_get(op->ptr, "filepath", filepath);
1887
1888         /* re-use last loaded setting so we can reload a file without changing */
1889         wm_open_init_load_ui(op, false);
1890         wm_open_init_use_scripts(op, false);
1891
1892         if (RNA_boolean_get(op->ptr, "load_ui"))
1893                 G.fileflags &= ~G_FILE_NO_UI;
1894         else
1895                 G.fileflags |= G_FILE_NO_UI;
1896
1897         if (RNA_boolean_get(op->ptr, "use_scripts"))
1898                 G.f |= G_SCRIPT_AUTOEXEC;
1899         else
1900                 G.f &= ~G_SCRIPT_AUTOEXEC;
1901
1902         success = wm_file_read_opwrap(C, filepath, op->reports, !(G.f & G_SCRIPT_AUTOEXEC));
1903
1904         /* for file open also popup for warnings, not only errors */
1905         BKE_report_print_level_set(op->reports, RPT_WARNING);
1906
1907         if (success) {
1908                 return OPERATOR_FINISHED;
1909         }
1910         else {
1911                 return OPERATOR_CANCELLED;
1912         }
1913 }
1914
1915 static bool wm_open_mainfile_check(bContext *UNUSED(C), wmOperator *op)
1916 {
1917         struct FileRuntime *file_info = (struct FileRuntime *)&op->customdata;
1918         PropertyRNA *prop = RNA_struct_find_property(op->ptr, "use_scripts");
1919         bool is_untrusted = false;
1920         char path[FILE_MAX];
1921         char *lslash;
1922
1923         RNA_string_get(op->ptr, "filepath", path);
1924
1925         /* get the dir */
1926         lslash = (char *)BLI_last_slash(path);
1927         if (lslash) *(lslash + 1) = '\0';
1928
1929         if ((U.flag & USER_SCRIPT_AUTOEXEC_DISABLE) == 0) {
1930                 if (BKE_autoexec_match(path) == true) {
1931                         RNA_property_boolean_set(op->ptr, prop, false);
1932                         is_untrusted = true;
1933                 }
1934         }
1935
1936         if (file_info) {
1937                 file_info->is_untrusted = is_untrusted;
1938         }
1939
1940         return is_untrusted;
1941 }
1942
1943 static void wm_open_mainfile_ui(bContext *UNUSED(C), wmOperator *op)
1944 {
1945         struct FileRuntime *file_info = (struct FileRuntime *)&op->customdata;
1946         uiLayout *layout = op->layout;
1947         uiLayout *col = op->layout;
1948         const char *autoexec_text;
1949
1950         uiItemR(layout, op->ptr, "load_ui", 0, NULL, ICON_NONE);
1951
1952         col = uiLayoutColumn(layout, false);
1953         if (file_info->is_untrusted) {
1954                 autoexec_text = IFACE_("Trusted Source [Untrusted Path]");
1955                 uiLayoutSetActive(col, false);
1956                 uiLayoutSetEnabled(col, false);
1957         }
1958         else {
1959                 autoexec_text = IFACE_("Trusted Source");
1960         }
1961
1962         uiItemR(col, op->ptr, "use_scripts", 0, autoexec_text, ICON_NONE);
1963 }
1964
1965 void WM_OT_open_mainfile(wmOperatorType *ot)
1966 {
1967         ot->name = "Open Blender File";
1968         ot->idname = "WM_OT_open_mainfile";
1969         ot->description = "Open a Blender file";
1970
1971         ot->invoke = wm_open_mainfile_invoke;
1972         ot->exec = wm_open_mainfile_exec;
1973         ot->check = wm_open_mainfile_check;
1974         ot->ui = wm_open_mainfile_ui;
1975         /* omit window poll so this can work in background mode */
1976
1977         WM_operator_properties_filesel(
1978                 ot, FILE_TYPE_FOLDER | FILE_TYPE_BLENDER, FILE_BLENDER, FILE_OPENFILE,
1979                 WM_FILESEL_FILEPATH, FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
1980
1981         RNA_def_boolean(ot->srna, "load_ui", true, "Load UI", "Load user interface setup in the .blend file");
1982         RNA_def_boolean(ot->srna, "use_scripts", true, "Trusted Source",
1983                         "Allow .blend file to execute scripts automatically, default available from system preferences");
1984 }
1985
1986 /** \} */
1987
1988 /** \name Reload (revert) main .blend file.
1989  *
1990  * \{ */
1991
1992 static int wm_revert_mainfile_exec(bContext *C, wmOperator *op)
1993 {
1994         Main *bmain = CTX_data_main(C);
1995         bool success;
1996         char filepath[FILE_MAX];
1997
1998         wm_open_init_use_scripts(op, false);
1999
2000         if (RNA_boolean_get(op->ptr, "use_scripts"))
2001                 G.f |= G_SCRIPT_AUTOEXEC;
2002         else
2003                 G.f &= ~G_SCRIPT_AUTOEXEC;
2004
2005         BLI_strncpy(filepath, BKE_main_blendfile_path(bmain), sizeof(filepath));
2006         success = wm_file_read_opwrap(C, filepath, op->reports, !(G.f & G_SCRIPT_AUTOEXEC));
2007
2008         if (success) {
2009                 return OPERATOR_FINISHED;
2010         }
2011         else {
2012                 return OPERATOR_CANCELLED;
2013         }
2014 }
2015
2016 static bool wm_revert_mainfile_poll(bContext *UNUSED(C))
2017 {
2018         return G.relbase_valid;
2019 }
2020
2021 void WM_OT_revert_mainfile(wmOperatorType *ot)
2022 {
2023         ot->name = "Revert";
2024         ot->idname = "WM_OT_revert_mainfile";
2025         ot->description = "Reload the saved file";
2026         ot->invoke = WM_operator_confirm;
2027
2028         RNA_def_boolean(ot->srna, "use_scripts", true, "Trusted Source",
2029                         "Allow .blend file to execute scripts automatically, default available from system preferences");
2030
2031         ot->exec = wm_revert_mainfile_exec;
2032         ot->poll = wm_revert_mainfile_poll;
2033 }
2034
2035 /** \} */
2036
2037 /** \name Recover last session & auto-save.
2038  *
2039  * \{ */
2040
2041 void WM_recover_last_session(bContext *C, ReportList *reports)
2042 {
2043         Main *bmain = CTX_data_main(C);
2044         char filepath[FILE_MAX];
2045
2046         BLI_make_file_string("/", filepath, BKE_tempdir_base(), BLENDER_QUIT_FILE);
2047         /* if reports==NULL, it's called directly without operator, we add a quick check here */
2048         if (reports || BLI_exists(filepath)) {
2049                 G.fileflags |= G_FILE_RECOVER;
2050
2051                 wm_file_read_opwrap(C, filepath, reports, true);
2052
2053                 G.fileflags &= ~G_FILE_RECOVER;
2054
2055                 /* XXX bad global... fixme */
2056                 if (BKE_main_blendfile_path(bmain)[0] != '\0') {
2057                         G.file_loaded = 1;      /* prevents splash to show */
2058                 }
2059                 else {
2060                         G.relbase_valid = 0;
2061                         G.save_over = 0;    /* start with save preference untitled.blend */
2062                 }
2063
2064         }
2065 }
2066
2067 static int wm_recover_last_session_exec(bContext *C, wmOperator *op)
2068 {
2069         WM_recover_last_session(C, op->reports);
2070         return OPERATOR_FINISHED;
2071 }
2072
2073 void WM_OT_recover_last_session(wmOperatorType *ot)
2074 {
2075         ot->name = "Recover Last Session";
2076         ot->idname = "WM_OT_recover_last_session";
2077         ot->description = "Open the last closed file (\"" BLENDER_QUIT_FILE "\")";
2078         ot->invoke = WM_operator_confirm;
2079
2080         ot->exec = wm_recover_last_session_exec;
2081 }
2082
2083 static int wm_recover_auto_save_exec(bContext *C, wmOperator *op)
2084 {
2085         char filepath[FILE_MAX];
2086         bool success;
2087
2088         RNA_string_get(op->ptr, "filepath", filepath);
2089
2090         G.fileflags |= G_FILE_RECOVER;
2091
2092         success = wm_file_read_opwrap(C, filepath, op->reports, true);
2093
2094         G.fileflags &= ~G_FILE_RECOVER;
2095
2096         if (success) {
2097                 return OPERATOR_FINISHED;
2098         }
2099         else {
2100                 return OPERATOR_CANCELLED;
2101         }
2102 }
2103
2104 static int wm_recover_auto_save_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2105 {
2106         char filename[FILE_MAX];
2107
2108         wm_autosave_location(filename);
2109         RNA_string_set(op->ptr, "filepath", filename);
2110         WM_event_add_fileselect(C, op);
2111
2112         return OPERATOR_RUNNING_MODAL;
2113 }
2114
2115 void WM_OT_recover_auto_save(wmOperatorType *ot)
2116 {
2117         ot->name = "Recover Auto Save";
2118         ot->idname = "WM_OT_recover_auto_save";
2119         ot->description = "Open an automatically saved file to recover it";
2120
2121         ot->exec = wm_recover_auto_save_exec;
2122         ot->invoke = wm_recover_auto_save_invoke;
2123
2124         WM_operator_properties_filesel(
2125                 ot, FILE_TYPE_BLENDER, FILE_BLENDER, FILE_OPENFILE,
2126                 WM_FILESEL_FILEPATH, FILE_LONGDISPLAY, FILE_SORT_TIME);
2127 }
2128
2129 /** \} */
2130
2131 /** \name Save main .blend file.
2132  *
2133  * \{ */
2134
2135 static void wm_filepath_default(char *filepath)
2136 {
2137         if (G.save_over == false) {
2138                 BLI_ensure_filename(filepath, FILE_MAX, "untitled.blend");
2139         }
2140 }
2141
2142 static void save_set_compress(wmOperator *op)
2143 {
2144         PropertyRNA *prop;
2145
2146         prop = RNA_struct_find_property(op->ptr, "compress");
2147         if (!RNA_property_is_set(op->ptr, prop)) {
2148                 if (G.save_over) {  /* keep flag for existing file */
2149                         RNA_property_boolean_set(op->ptr, prop, (G.fileflags & G_FILE_COMPRESS) != 0);
2150                 }
2151                 else {  /* use userdef for new file */
2152                         RNA_property_boolean_set(op->ptr, prop, (U.flag & USER_FILECOMPRESS) != 0);
2153                 }
2154         }
2155 }
2156
2157 static void save_set_filepath(bContext *C, wmOperator *op)
2158 {
2159         Main *bmain = CTX_data_main(C);
2160         PropertyRNA *prop;
2161         char name[FILE_MAX];
2162
2163         prop = RNA_struct_find_property(op->ptr, "filepath");
2164         if (!RNA_property_is_set(op->ptr, prop)) {
2165                 /* if not saved before, get the name of the most recently used .blend file */
2166                 if (BKE_main_blendfile_path(bmain)[0] == '\0' && G.recent_files.first) {
2167                         struct RecentFile *recent = G.recent_files.first;
2168                         BLI_strncpy(name, recent->filepath, FILE_MAX);
2169                 }
2170                 else {
2171                         BLI_strncpy(name, bmain->name, FILE_MAX);
2172                 }
2173
2174                 wm_filepath_default(name);
2175                 RNA_property_string_set(op->ptr, prop, name);
2176         }
2177 }
2178
2179 static int wm_save_as_mainfile_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2180 {
2181
2182         save_set_compress(op);
2183         save_set_filepath(C, op);
2184
2185         WM_event_add_fileselect(C, op);
2186
2187         return OPERATOR_RUNNING_MODAL;
2188 }
2189
2190 /* function used for WM_OT_save_mainfile too */
2191 static int wm_save_as_mainfile_exec(bContext *C, wmOperator *op)
2192 {
2193         Main *bmain = CTX_data_main(C);
2194         char path[FILE_MAX];
2195         const bool is_save_as = (op->type->invoke == wm_save_as_mainfile_invoke);
2196
2197         save_set_compress(op);
2198
2199         if (RNA_struct_property_is_set(op->ptr, "filepath")) {
2200                 RNA_string_get(op->ptr, "filepath", path);
2201         }
2202         else {
2203                 BLI_strncpy(path, BKE_main_blendfile_path(bmain), FILE_MAX);
2204                 wm_filepath_default(path);
2205         }
2206
2207         const int fileflags_orig = G.fileflags;
2208         int fileflags = G.fileflags & ~G_FILE_USERPREFS;
2209
2210         /* set compression flag */
2211         SET_FLAG_FROM_TEST(
2212                 fileflags, RNA_boolean_get(op->ptr, "compress"),
2213                 G_FILE_COMPRESS);
2214         SET_FLAG_FROM_TEST(
2215                 fileflags, RNA_boolean_get(op->ptr, "relative_remap"),
2216                 G_FILE_RELATIVE_REMAP);
2217         SET_FLAG_FROM_TEST(
2218                 fileflags,
2219                 (RNA_struct_property_is_set(op->ptr, "copy") &&
2220                  RNA_boolean_get(op->ptr, "copy")),
2221                 G_FILE_SAVE_COPY);
2222
2223         const bool ok = wm_file_write(C, path, fileflags, op->reports);
2224
2225         if ((op->flag & OP_IS_INVOKE) == 0) {
2226                 /* OP_IS_INVOKE is set when the operator is called from the GUI.
2227                  * If it is not set, the operator is called from a script and
2228                  * shouldn't influence G.fileflags. */
2229                 G.fileflags = fileflags_orig;
2230         }
2231
2232         if (ok == false) {
2233                 return OPERATOR_CANCELLED;
2234         }
2235
2236         WM_event_add_notifier(C, NC_WM | ND_FILESAVE, NULL);
2237
2238         if (!is_save_as && RNA_boolean_get(op->ptr, "exit")) {
2239                 wm_exit_schedule_delayed(C);
2240         }
2241
2242         return OPERATOR_FINISHED;
2243 }
2244
2245 /* function used for WM_OT_save_mainfile too */
2246 static bool blend_save_check(bContext *UNUSED(C), wmOperator *op)
2247 {
2248         char filepath[FILE_MAX];
2249         RNA_string_get(op->ptr, "filepath", filepath);
2250         if (!BLO_has_bfile_extension(filepath)) {
2251                 /* some users would prefer BLI_path_extension_replace(),
2252                  * we keep getting nitpicking bug reports about this - campbell */
2253                 BLI_path_extension_ensure(filepath, FILE_MAX, ".blend");
2254                 RNA_string_set(op->ptr, "filepath", filepath);
2255                 return true;
2256         }
2257         return false;
2258 }
2259
2260 void WM_OT_save_as_mainfile(wmOperatorType *ot)
2261 {
2262         PropertyRNA *prop;
2263
2264         ot->name = "Save As Blender File";
2265         ot->idname = "WM_OT_save_as_mainfile";
2266         ot->description = "Save the current file in the desired location";
2267
2268         ot->invoke = wm_save_as_mainfile_invoke;
2269         ot->exec = wm_save_as_mainfile_exec;
2270         ot->check = blend_save_check;
2271         /* omit window poll so this can work in background mode */
2272
2273         WM_operator_properties_filesel(
2274                 ot, FILE_TYPE_FOLDER | FILE_TYPE_BLENDER, FILE_BLENDER, FILE_SAVE,
2275                 WM_FILESEL_FILEPATH, FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
2276         RNA_def_boolean(ot->srna, "compress", false, "Compress", "Write compressed .blend file");
2277         RNA_def_boolean(ot->srna, "relative_remap", true, "Remap Relative",
2278                         "Remap relative paths when saving in a different directory");
2279         prop = RNA_def_boolean(ot->srna, "copy", false, "Save Copy",
2280                         "Save a copy of the actual working state but does not make saved file active");
2281         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2282 }
2283
2284 static int wm_save_mainfile_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2285 {
2286         int ret;
2287
2288         /* cancel if no active window */
2289         if (CTX_wm_window(C) == NULL)
2290                 return OPERATOR_CANCELLED;
2291
2292         save_set_compress(op);
2293         save_set_filepath(C, op);
2294
2295         /* if we're saving for the first time and prefer relative paths - any existing paths will be absolute,
2296          * enable the option to remap paths to avoid confusion [#37240] */
2297         if ((G.relbase_valid == false) && (U.flag & USER_RELPATHS)) {
2298                 PropertyRNA *prop = RNA_struct_find_property(op->ptr, "relative_remap");
2299                 if (!RNA_property_is_set(op->ptr, prop)) {
2300                         RNA_property_boolean_set(op->ptr, prop, true);
2301                 }
2302         }
2303
2304         if (G.save_over) {
2305                 char path[FILE_MAX];
2306
2307                 RNA_string_get(op->ptr, "filepath", path);
2308                 if (RNA_boolean_get(op->ptr, "check_existing") && BLI_exists(path)) {
2309                         ret = WM_operator_confirm_message_ex(C, op, IFACE_("Save Over?"), ICON_QUESTION, path);
2310                 }
2311                 else {
2312                         ret = wm_save_as_mainfile_exec(C, op);
2313                         /* Without this there is no feedback the file was saved. */
2314                         BKE_reportf(op->reports, RPT_INFO, "Saved \"%s\"", BLI_path_basename(path));
2315                 }
2316         }
2317         else {
2318                 WM_event_add_fileselect(C, op);
2319                 ret = OPERATOR_RUNNING_MODAL;
2320         }
2321
2322         return ret;
2323 }
2324
2325 void WM_OT_save_mainfile(wmOperatorType *ot)
2326 {
2327         ot->name = "Save Blender File";
2328         ot->idname = "WM_OT_save_mainfile";
2329         ot->description = "Save the current Blender file";
2330
2331         ot->invoke = wm_save_mainfile_invoke;
2332         ot->exec = wm_save_as_mainfile_exec;
2333         ot->check = blend_save_check;
2334         /* omit window poll so this can work in background mode */
2335
2336         PropertyRNA *prop;
2337         WM_operator_properties_filesel(
2338                 ot, FILE_TYPE_FOLDER | FILE_TYPE_BLENDER, FILE_BLENDER, FILE_SAVE,
2339                 WM_FILESEL_FILEPATH, FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
2340         RNA_def_boolean(ot->srna, "compress", false, "Compress", "Write compressed .blend file");
2341         RNA_def_boolean(ot->srna, "relative_remap", false, "Remap Relative",
2342                         "Remap relative paths when saving in a different directory");
2343
2344         prop = RNA_def_boolean(ot->srna, "exit", false, "Exit", "Exit Blender after saving");
2345         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
2346 }
2347
2348 /** \} */
2349
2350 /** \name Auto-execution of scripts warning popup
2351  *
2352  * \{ */
2353
2354 static void wm_block_autorun_warning_ignore(bContext *C, void *arg_block, void *UNUSED(arg))
2355 {
2356         wmWindow *win = CTX_wm_window(C);
2357         UI_popup_block_close(C, win, arg_block);
2358 }
2359
2360 static void wm_block_autorun_warning_allow(bContext *C, void *arg_block, void *UNUSED(arg))
2361 {
2362         PointerRNA props_ptr;
2363         wmWindow *win = CTX_wm_window(C);
2364
2365         UI_popup_block_close(C, win, arg_block);
2366
2367         /* Save user preferences for permanent execution. */
2368         if ((U.flag & USER_SCRIPT_AUTOEXEC_DISABLE) == 0) {
2369                 WM_operator_name_call(C, "WM_OT_save_userpref", WM_OP_EXEC_DEFAULT, NULL);
2370         }
2371
2372         /* Load file again with scripts enabled. */
2373         wmOperatorType *ot = WM_operatortype_find("WM_OT_revert_mainfile", false);
2374
2375         WM_operator_properties_create_ptr(&props_ptr, ot);
2376         RNA_boolean_set(&props_ptr, "use_scripts", true);
2377         WM_operator_name_call_ptr(C, ot, WM_OP_EXEC_DEFAULT, &props_ptr);
2378         WM_operator_properties_free(&props_ptr);
2379 }
2380
2381 /* Build the autorun warning dialog UI */
2382 static uiBlock *block_create_autorun_warning(struct bContext *C, struct ARegion *ar, void *UNUSED(arg1))
2383 {
2384         uiStyle *style = UI_style_get();
2385         uiBlock *block = UI_block_begin(C, ar, "autorun_warning_popup", UI_EMBOSS);
2386
2387         UI_block_flag_enable(block, UI_BLOCK_KEEP_OPEN | UI_BLOCK_LOOP | UI_BLOCK_NO_WIN_CLIP | UI_BLOCK_NUMSELECT);
2388         UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_POPUP);
2389         UI_block_emboss_set(block, UI_EMBOSS);
2390
2391         uiLayout *layout = UI_block_layout(
2392                 block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 10, 2, U.widget_unit * 24, U.widget_unit * 6, 0, style);
2393
2394         /* Text and some vertical space */
2395         uiLayout *col = uiLayoutColumn(layout, true);
2396         uiItemL(col, IFACE_("For security reasons, automatic execution of Python scripts in this file was disabled:"), ICON_ERROR);
2397         uiLayout *sub = uiLayoutRow(col, true);
2398         uiLayoutSetRedAlert(sub, true);
2399         uiItemL(sub, G.autoexec_fail, ICON_BLANK1);
2400         uiItemL(col, IFACE_("This may lead to unexpected behavior."), ICON_BLANK1);
2401
2402         uiItemS(layout);
2403
2404         PointerRNA userpref_ptr;
2405         RNA_pointer_create(NULL, &RNA_UserPreferencesSystem, &U, &userpref_ptr);
2406         uiItemR(layout, &userpref_ptr, "use_scripts_auto_execute", 0, IFACE_("Permanently allow execution of scripts"), ICON_NONE);
2407
2408         uiItemS(layout);
2409
2410         /* Buttons */
2411         uiBut *but;
2412         uiLayout *split = uiLayoutSplit(layout, 0.0f, true);
2413         col = uiLayoutColumn(split, false);
2414
2415         /* Allow reload if we have a saved file. */
2416         if (G.relbase_valid) {
2417                 but = uiDefIconTextBut(
2418                         block, UI_BTYPE_BUT, 0, ICON_NONE, IFACE_("Allow Execution"), 0, 0, 50, UI_UNIT_Y,
2419                         NULL, 0, 0, 0, 0, TIP_("Reload file with execution of Python scripts enabled"));
2420                 UI_but_func_set(but, wm_block_autorun_warning_allow, block, NULL);
2421         }
2422         else {
2423                 uiItemS(col);
2424         }
2425
2426         /* empty space between buttons */
2427         col = uiLayoutColumn(split, false);
2428         uiItemS(col);
2429
2430         col = uiLayoutColumn(split, 1);
2431         but = uiDefIconTextBut(
2432                 block, UI_BTYPE_BUT, 0, ICON_NONE, IFACE_("Ignore"), 0, 0, 50, UI_UNIT_Y,
2433                 NULL, 0, 0, 0, 0, TIP_("Continue using file without Python scripts"));
2434         UI_but_func_set(but, wm_block_autorun_warning_ignore, block, NULL);
2435
2436         UI_block_bounds_set_centered(block, 10);
2437
2438         return block;
2439 }
2440
2441 void wm_test_autorun_warning(bContext *C)
2442 {
2443         /* Test if any auto-execution of scripts failed. */
2444         if ((G.f & G_SCRIPT_AUTOEXEC_FAIL) == 0) {
2445                 return;
2446         }
2447
2448         /* Only show the warning once. */
2449         if (G.f & G_SCRIPT_AUTOEXEC_FAIL_QUIET) {
2450                 return;
2451         }
2452
2453         G.f |= G_SCRIPT_AUTOEXEC_FAIL_QUIET;
2454
2455         wmWindowManager *wm = CTX_wm_manager(C);
2456         wmWindow *win = (wm->winactive) ? wm->winactive : wm->windows.first;
2457
2458         if (win) {
2459                 wmWindow *prevwin = CTX_wm_window(C);
2460                 CTX_wm_window_set(C, win);
2461                 UI_popup_block_invoke(C, block_create_autorun_warning, NULL);
2462                 CTX_wm_window_set(C, prevwin);
2463         }
2464 }
2465
2466 /** \} */