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