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