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