source/blender/windowmanager/intern/wm_files.c

   1 /**
   2  * $Id: wm_files.c
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19  *
  20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  21  * All rights reserved.
  22  *
  23  * Contributor(s): Blender Foundation 2007
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28         /* placed up here because of crappy
  29          * winsock stuff.
  30          */
  31 #include <stdio.h>
  32 #include <string.h>
  33
  34 #ifdef WIN32
  35 #include <windows.h> /* need to include windows.h so _WIN32_IE is defined  */
  36 #ifndef _WIN32_IE
  37 #define _WIN32_IE 0x0400 /* minimal requirements for SHGetSpecialFolderPath on MINGW MSVC has this defined already */
  38 #endif
  39 #include <shlobj.h> /* for SHGetSpecialFolderPath, has to be done before BLI_winstuff because 'near' is disabled through BLI_windstuff */
  40 #include <process.h> /* getpid */
  41 #include "BLI_winstuff.h"
  42 #else
  43 #include <unistd.h> /* getpid */
  44 #endif
  45
  46 #include "MEM_guardedalloc.h"
  47 #include "MEM_CacheLimiterC-Api.h"
  48
  49 #include "BLI_blenlib.h"
  50 #include "BLI_linklist.h"
  51
  52 #include "DNA_anim_types.h"
  53 #include "DNA_ipo_types.h" // XXX old animation system
  54 #include "DNA_object_types.h"
  55 #include "DNA_space_types.h"
  56 #include "DNA_userdef_types.h"
  57 #include "DNA_scene_types.h"
  58 #include "DNA_screen_types.h"
  59 #include "DNA_windowmanager_types.h"
  60
  61 #include "BKE_blender.h"
  62 #include "BKE_context.h"
  63 #include "BKE_DerivedMesh.h"
  64 #include "BKE_exotic.h"
  65 #include "BKE_font.h"
  66 #include "BKE_global.h"
  67 #include "BKE_library.h"
  68 #include "BKE_main.h"
  69 #include "BKE_packedFile.h"
  70 #include "BKE_report.h"
  71 #include "BKE_sound.h"
  72 #include "BKE_texture.h"
  73 #include "BKE_utildefines.h"
  74
  75 #include "BLO_readfile.h"
  76 #include "BLO_writefile.h"
  77
  78 #include "RNA_access.h"
  79 #include "RNA_define.h"
  80
  81 #include "ED_datafiles.h"
  82 #include "ED_object.h"
  83 #include "ED_screen.h"
  84 #include "ED_util.h"
  85
  86 #include "GHOST_C-api.h"
  87
  88 #include "UI_interface.h"
  89
  90 #include "GPU_draw.h"
  91
  92 #include "FRS_freestyle.h"
  93
  94 // XXX #include "BPY_extern.h"
  95
  96 #include "WM_api.h"
  97 #include "WM_types.h"
  98 #include "wm.h"
  99 #include "wm_window.h"
 100 #include "wm_event_system.h"
 101
 102 static void writeBlog(void);
 103
 104 /* To be able to read files without windows closing, opening, moving
 105    we try to prepare for worst case:
 106    - active window gets active screen from file
 107    - restoring the screens from non-active windows
 108    Best case is all screens match, in that case they get assigned to proper window
 109 */
 110 static void wm_window_match_init(bContext *C, ListBase *wmlist)
 111 {
 112         wmWindowManager *wm= G.main->wm.first;
 113         wmWindow *win;
 114
 115         *wmlist= G.main->wm;
 116         G.main->wm.first= G.main->wm.last= NULL;
 117
 118         /* first wrap up running stuff */
 119         /* code copied from wm_init_exit.c */
 120         for(wm= wmlist->first; wm; wm= wm->id.next) {
 121
 122                 WM_jobs_stop_all(wm);
 123
 124                 for(win= wm->windows.first; win; win= win->next) {
 125
 126                         CTX_wm_window_set(C, win);      /* needed by operator close callbacks */
 127                         ED_screen_exit(C, win, win->screen);
 128                 }
 129         }
 130
 131         ED_editors_exit(C);
 132
 133 return;
 134         if(wm==NULL) return;
 135         if(G.fileflags & G_FILE_NO_UI) return;
 136
 137         /* we take apart the used screens from non-active window */
 138         for(win= wm->windows.first; win; win= win->next) {
 139                 BLI_strncpy(win->screenname, win->screen->id.name, MAX_ID_NAME);
 140                 if(win!=wm->winactive) {
 141                         BLI_remlink(&G.main->screen, win->screen);
 142                         //BLI_addtail(screenbase, win->screen);
 143                 }
 144         }
 145 }
 146
 147 /* match old WM with new, 4 cases:
 148   1- no current wm, no read wm: make new default
 149   2- no current wm, but read wm: that's OK, do nothing
 150   3- current wm, but not in file: try match screen names
 151   4- current wm, and wm in file: try match ghostwin
 152 */
 153
 154 static void wm_window_match_do(bContext *C, ListBase *oldwmlist)
 155 {
 156         wmWindowManager *oldwm, *wm;
 157         wmWindow *oldwin, *win;
 158
 159         /* cases 1 and 2 */
 160         if(oldwmlist->first==NULL) {
 161                 if(G.main->wm.first); /* nothing todo */
 162                 else
 163                         wm_add_default(C);
 164         }
 165         else {
 166                 /* cases 3 and 4 */
 167
 168                 /* we've read file without wm..., keep current one entirely alive */
 169                 if(G.main->wm.first==NULL) {
 170                         bScreen *screen= CTX_wm_screen(C);
 171
 172                         /* match oldwm to new dbase, only old files */
 173
 174                         for(wm= oldwmlist->first; wm; wm= wm->id.next) {
 175
 176                                 for(win= wm->windows.first; win; win= win->next) {
 177                                         /* all windows get active screen from file */
 178                                         if(screen->winid==0)
 179                                                 win->screen= screen;
 180                                         else
 181                                                 win->screen= ED_screen_duplicate(win, screen);
 182
 183                                         BLI_strncpy(win->screenname, win->screen->id.name+2, 21);
 184                                         win->screen->winid= win->winid;
 185                                 }
 186                         }
 187
 188                         G.main->wm= *oldwmlist;
 189
 190                         /* screens were read from file! */
 191                         ED_screens_initialize(G.main->wm.first);
 192                 }
 193                 else {
 194                         /* what if old was 3, and loaded 1? */
 195                         /* this code could move to setup_appdata */
 196                         oldwm= oldwmlist->first;
 197                         wm= G.main->wm.first;
 198
 199                         /* ensure making new keymaps and set space types */
 200                         wm->initialized= 0;
 201                         wm->winactive= NULL;
 202
 203                         /* only first wm in list has ghostwins */
 204                         for(win= wm->windows.first; win; win= win->next) {
 205                                 for(oldwin= oldwm->windows.first; oldwin; oldwin= oldwin->next) {
 206
 207                                         if(oldwin->winid == win->winid ) {
 208                                                 win->ghostwin= oldwin->ghostwin;
 209                                                 win->active= oldwin->active;
 210                                                 if(win->active)
 211                                                         wm->winactive= win;
 212
 213                                                 GHOST_SetWindowUserData(win->ghostwin, win);    /* pointer back */
 214                                                 oldwin->ghostwin= NULL;
 215
 216                                                 win->eventstate= oldwin->eventstate;
 217                                                 oldwin->eventstate= NULL;
 218
 219                                                 /* ensure proper screen rescaling */
 220                                                 win->sizex= oldwin->sizex;
 221                                                 win->sizey= oldwin->sizey;
 222                                                 win->posx= oldwin->posx;
 223                                                 win->posy= oldwin->posy;
 224                                         }
 225                                 }
 226                         }
 227                         wm_close_and_free_all(C, oldwmlist);
 228                 }
 229         }
 230 }
 231
 232 /* in case UserDef was read, we re-initialize all, and do versioning */
 233 static void wm_init_userdef()
 234 {
 235         UI_init_userdef();
 236         MEM_CacheLimiter_set_maximum(U.memcachelimit * 1024 * 1024);
 237         sound_init();
 238 }
 239
 240 void WM_read_file(bContext *C, char *name, ReportList *reports)
 241 {
 242         int retval;
 243
 244         /* first try to append data from exotic file formats... */
 245         /* it throws error box when file doesnt exist and returns -1 */
 246         /* note; it should set some error message somewhere... (ton) */
 247         retval= BKE_read_exotic(CTX_data_scene(C), name);
 248
 249         /* we didn't succeed, now try to read Blender file */
 250         if (retval== 0) {
 251                 ListBase wmbase;
 252
 253                 /* put aside screens to match with persistant windows later */
 254                 /* also exit screens and editors */
 255                 wm_window_match_init(C, &wmbase);
 256
 257                 retval= BKE_read_file(C, name, NULL, reports);
 258                 G.save_over = 1;
 259
 260                 /* match the read WM with current WM */
 261                 wm_window_match_do(C, &wmbase);
 262                 wm_check(C); /* opens window(s), checks keymaps */
 263
 264 // XXX          mainwindow_set_filename_to_title(G.main->name);
 265
 266                 if(retval==2) wm_init_userdef();        // in case a userdef is read from regular .blend
 267
 268                 if (retval!=0) {
 269                         G.relbase_valid = 1;
 270                         writeBlog();
 271                 }
 272
 273                 FRS_initialize(C);
 274
 275 // XXX          undo_editmode_clear();
 276                 BKE_reset_undo();
 277                 BKE_write_undo(C, "original");  /* save current state */
 278
 279                 WM_event_add_notifier(C, NC_WM|ND_FILEREAD, NULL);
 280 //              refresh_interface_font();
 281
 282                 CTX_wm_window_set(C, NULL); /* exits queues */
 283         }
 284         else if(retval==1)
 285                 BKE_write_undo(C, "Import file");
 286         else if(retval == -1) {
 287                 if(reports && reports->list.first == NULL)
 288                         BKE_report(reports, RPT_ERROR, "Cannot read file.");
 289         }
 290 }
 291
 292
 293 /* called on startup,  (context entirely filled with NULLs) */
 294 /* or called for 'New File' */
 295 /* op can be NULL */
 296 int WM_read_homefile(bContext *C, wmOperator *op)
 297 {
 298         ListBase wmbase;
 299         char tstr[FILE_MAXDIR+FILE_MAXFILE], scestr[FILE_MAXDIR];
 300         char *home= BLI_gethome();
 301         int from_memory= op?RNA_boolean_get(op->ptr, "factory"):0;
 302         int success;
 303
 304         BLI_clean(home);
 305
 306         free_ttfont(); /* still weird... what does it here? */
 307
 308         G.relbase_valid = 0;
 309         if (!from_memory) {
 310                 BLI_make_file_string(G.sce, tstr, home, ".B25.blend");
 311         }
 312         strcpy(scestr, G.sce);  /* temporary store */
 313
 314         /* prevent loading no UI */
 315         G.fileflags &= ~G_FILE_NO_UI;
 316
 317         /* put aside screens to match with persistant windows later */
 318         wm_window_match_init(C, &wmbase);
 319
 320         if (!from_memory && BLI_exists(tstr)) {
 321                 success = BKE_read_file(C, tstr, NULL, NULL);
 322         } else {
 323                 success = BKE_read_file_from_memory(C, datatoc_B_blend, datatoc_B_blend_size, NULL, NULL);
 324                 if (wmbase.first == NULL) wm_clear_default_size(C);
 325         }
 326
 327         /* match the read WM with current WM */
 328         wm_window_match_do(C, &wmbase);
 329         wm_check(C); /* opens window(s), checks keymaps */
 330
 331         strcpy(G.sce, scestr); /* restore */
 332
 333         wm_init_userdef();
 334         FRS_initialize(C);
 335
 336
 337         /* When loading factory settings, the reset solid OpenGL lights need to be applied. */
 338         GPU_default_lights();
 339
 340         /* XXX */
 341         G.save_over = 0;        // start with save preference untitled.blend
 342         G.fileflags &= ~G_FILE_AUTOPLAY;        /*  disable autoplay in .B.blend... */
 343 //      mainwindow_set_filename_to_title("");   // empty string re-initializes title to "Blender"
 344
 345 //      refresh_interface_font();
 346
 347 //      undo_editmode_clear();
 348         BKE_reset_undo();
 349         BKE_write_undo(C, "original");  /* save current state */
 350
 351         WM_event_add_notifier(C, NC_WM|ND_FILEREAD, NULL);
 352         CTX_wm_window_set(C, NULL); /* exits queues */
 353
 354         return OPERATOR_FINISHED;
 355 }
 356
 357
 358 void read_Blog(void)
 359 {
 360         char name[FILE_MAX];
 361         LinkNode *l, *lines;
 362         struct RecentFile *recent;
 363         char *line;
 364         int num;
 365
 366         BLI_make_file_string("/", name, BLI_gethome(), ".Blog");
 367         lines= BLI_read_file_as_lines(name);
 368
 369         G.recent_files.first = G.recent_files.last = NULL;
 370
 371         /* read list of recent opend files from .Blog to memory */
 372         for (l= lines, num= 0; l && (num<U.recent_files); l= l->next, num++) {
 373                 line = l->link;
 374                 if (!BLI_streq(line, "")) {
 375                         if (num==0)
 376                                 strcpy(G.sce, line);
 377
 378                         recent = (RecentFile*)MEM_mallocN(sizeof(RecentFile),"RecentFile");
 379                         BLI_addtail(&(G.recent_files), recent);
 380                         recent->filename = (char*)MEM_mallocN(sizeof(char)*(strlen(line)+1), "name of file");
 381                         recent->filename[0] = '\0';
 382
 383                         strcpy(recent->filename, line);
 384                 }
 385         }
 386
 387         if(G.sce[0] == 0)
 388                 BLI_make_file_string("/", G.sce, BLI_gethome(), "untitled.blend");
 389
 390         BLI_free_file_lines(lines);
 391
 392 }
 393
 394 static void writeBlog(void)
 395 {
 396         struct RecentFile *recent, *next_recent;
 397         char name[FILE_MAXDIR+FILE_MAXFILE];
 398         FILE *fp;
 399         int i;
 400
 401         BLI_make_file_string("/", name, BLI_gethome(), ".Blog");
 402
 403         recent = G.recent_files.first;
 404         /* refresh .Blog of recent opened files, when current file was changed */
 405         if(!(recent) || (strcmp(recent->filename, G.sce)!=0)) {
 406                 fp= fopen(name, "w");
 407                 if (fp) {
 408                         /* add current file to the beginning of list */
 409                         recent = (RecentFile*)MEM_mallocN(sizeof(RecentFile),"RecentFile");
 410                         recent->filename = (char*)MEM_mallocN(sizeof(char)*(strlen(G.sce)+1), "name of file");
 411                         recent->filename[0] = '\0';
 412                         strcpy(recent->filename, G.sce);
 413                         BLI_addhead(&(G.recent_files), recent);
 414                         /* write current file to .Blog */
 415                         fprintf(fp, "%s\n", recent->filename);
 416                         recent = recent->next;
 417                         i=1;
 418                         /* write rest of recent opened files to .Blog */
 419                         while((i<U.recent_files) && (recent)){
 420                                 /* this prevents to have duplicities in list */
 421                                 if (strcmp(recent->filename, G.sce)!=0) {
 422                                         fprintf(fp, "%s\n", recent->filename);
 423                                         recent = recent->next;
 424                                 }
 425                                 else {
 426                                         next_recent = recent->next;
 427                                         MEM_freeN(recent->filename);
 428                                         BLI_freelinkN(&(G.recent_files), recent);
 429                                         recent = next_recent;
 430                                 }
 431                                 i++;
 432                         }
 433                         fclose(fp);
 434                 }
 435         }
 436 }
 437
 438 static void do_history(char *name, ReportList *reports)
 439 {
 440         char tempname1[FILE_MAXDIR+FILE_MAXFILE], tempname2[FILE_MAXDIR+FILE_MAXFILE];
 441         int hisnr= U.versions;
 442
 443         if(U.versions==0) return;
 444         if(strlen(name)<2) return;
 445
 446         while(hisnr > 1) {
 447                 sprintf(tempname1, "%s%d", name, hisnr-1);
 448                 sprintf(tempname2, "%s%d", name, hisnr);
 449
 450                 if(BLI_rename(tempname1, tempname2))
 451                         BKE_report(reports, RPT_ERROR, "Unable to make version backup");
 452
 453                 hisnr--;
 454         }
 455
 456         /* is needed when hisnr==1 */
 457         sprintf(tempname1, "%s%d", name, hisnr);
 458
 459         if(BLI_rename(name, tempname1))
 460                 BKE_report(reports, RPT_ERROR, "Unable to make version backup");
 461 }
 462
 463 void WM_write_file(bContext *C, char *target, int fileflags, ReportList *reports)
 464 {
 465         Library *li;
 466         int len;
 467         char di[FILE_MAX];
 468
 469         len = strlen(target);
 470
 471         if (len == 0) return;
 472         if (len >= FILE_MAX) {
 473                 BKE_report(reports, RPT_ERROR, "Path too long, cannot save");
 474                 return;
 475         }
 476
 477         /* send the OnSave event */
 478         for (li= G.main->library.first; li; li= li->id.next) {
 479                 if (BLI_streq(li->name, target)) {
 480                         BKE_report(reports, RPT_ERROR, "Cannot overwrite used library");
 481                         return;
 482                 }
 483         }
 484
 485         if (!BLO_has_bfile_extension(target) && (len+6 < FILE_MAX)) {
 486                 sprintf(di, "%s.blend", target);
 487         } else {
 488                 strcpy(di, target);
 489         }
 490
 491 //      if (BLI_exists(di)) {
 492 // XXX          if(!saveover(di))
 493 // XXX                  return;
 494 //      }
 495
 496         if (G.fileflags & G_AUTOPACK) {
 497                 packAll(G.main, reports);
 498         }
 499
 500         ED_object_exit_editmode(C, EM_DO_UNDO);
 501
 502         do_history(di, reports);
 503
 504         if (BLO_write_file(CTX_data_main(C), di, fileflags, reports)) {
 505                 strcpy(G.sce, di);
 506                 G.relbase_valid = 1;
 507                 strcpy(G.main->name, di);       /* is guaranteed current file */
 508
 509                 G.save_over = 1; /* disable untitled.blend convention */
 510
 511                 if(fileflags & G_FILE_COMPRESS) G.fileflags |= G_FILE_COMPRESS;
 512                 else G.fileflags &= ~G_FILE_COMPRESS;
 513
 514                 writeBlog();
 515         }
 516
 517 // XXX  waitcursor(0);
 518 }
 519
 520 /* operator entry */
 521 int WM_write_homefile(bContext *C, wmOperator *op)
 522 {
 523         wmWindowManager *wm= CTX_wm_manager(C);
 524         wmWindow *win= CTX_wm_window(C);
 525         char tstr[FILE_MAXDIR+FILE_MAXFILE];
 526         int fileflags;
 527
 528         /* check current window and close it if temp */
 529         if(win->screen->full == SCREENTEMP)
 530                 wm_window_close(C, wm, win);
 531
 532         BLI_make_file_string("/", tstr, BLI_gethome(), ".B25.blend");
 533
 534         /*  force save as regular blend file */
 535         fileflags = G.fileflags & ~(G_FILE_COMPRESS | G_FILE_LOCK | G_FILE_SIGN);
 536
 537         BLO_write_file(CTX_data_main(C), tstr, fileflags, op->reports);
 538
 539         G.save_over= 0;
 540
 541         return OPERATOR_FINISHED;
 542 }
 543
 544 /************************ autosave ****************************/
 545
 546 void wm_autosave_location(char *filename)
 547 {
 548         char pidstr[32];
 549 #ifdef WIN32
 550         char subdir[9];
 551         char savedir[FILE_MAXDIR];
 552 #endif
 553
 554         sprintf(pidstr, "%d.blend", abs(getpid()));
 555
 556 #ifdef WIN32
 557         if (!BLI_exists(U.tempdir)) {
 558                 BLI_strncpy(subdir, "autosave", sizeof(subdir));
 559                 BLI_make_file_string("/", savedir, BLI_gethome(), subdir);
 560
 561                 /* create a new autosave dir
 562                  * function already checks for existence or not */
 563                 BLI_recurdir_fileops(savedir);
 564
 565                 BLI_make_file_string("/", filename, savedir, pidstr);
 566                 return;
 567         }
 568 #endif
 569
 570         BLI_make_file_string("/", filename, U.tempdir, pidstr);
 571 }
 572
 573 void WM_autosave_init(bContext *C)
 574 {
 575         wmWindowManager *wm= CTX_wm_manager(C);
 576         wm_autosave_timer_ended(wm);
 577
 578         if(U.flag & USER_AUTOSAVE)
 579                 wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime*60.0);
 580 }
 581
 582 void wm_autosave_timer(const bContext *C, wmWindowManager *wm, wmTimer *wt)
 583 {
 584         wmWindow *win;
 585         wmEventHandler *handler;
 586         char filename[FILE_MAX];
 587         int fileflags;
 588
 589         WM_event_remove_timer(wm, NULL, wm->autosavetimer);
 590
 591         /* if a modal operator is running, don't autosave, but try again in 10 seconds */
 592         for(win=wm->windows.first; win; win=win->next) {
 593                 for(handler=win->modalhandlers.first; handler; handler=handler->next) {
 594                         if(handler->op) {
 595                                 wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, 10.0);
 596                                 return;
 597                         }
 598                 }
 599         }
 600
 601         wm_autosave_location(filename);
 602
 603         /*  force save as regular blend file */
 604         fileflags = G.fileflags & ~(G_FILE_COMPRESS|G_FILE_LOCK|G_FILE_SIGN);
 605
 606         /* no error reporting to console */
 607         BLO_write_file(CTX_data_main(C), filename, fileflags, NULL);
 608
 609         /* do timer after file write, just in case file write takes a long time */
 610         wm->autosavetimer= WM_event_add_timer(wm, NULL, TIMERAUTOSAVE, U.savetime*60.0);
 611 }
 612
 613 void wm_autosave_timer_ended(wmWindowManager *wm)
 614 {
 615         if(wm->autosavetimer) {
 616                 WM_event_remove_timer(wm, NULL, wm->autosavetimer);
 617                 wm->autosavetimer= NULL;
 618         }
 619 }
 620
 621 void wm_autosave_delete(void)
 622 {
 623         char filename[FILE_MAX];
 624
 625         wm_autosave_location(filename);
 626
 627         if(BLI_exists(filename)) {
 628                 char str[FILE_MAXDIR+FILE_MAXFILE];
 629                 BLI_make_file_string("/", str, U.tempdir, "quit.blend");
 630
 631                 /* if global undo; remove tempsave, otherwise rename */
 632                 if(U.uiflag & USER_GLOBALUNDO) BLI_delete(filename, 0, 0);
 633                 else BLI_rename(filename, str);
 634         }
 635 }
 636
 637 void wm_autosave_read(bContext *C, ReportList *reports)
 638 {
 639         char filename[FILE_MAX];
 640
 641         wm_autosave_location(filename);
 642         WM_read_file(C, filename, reports);
 643 }
 644