src/bufferlist.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Word Processor
   5  *
   6  *          Copyright 1995 Matthias Ettrich
   7  *          Copyright 1995-1999 The LyX Team.
   8  *
   9  *           This file is Copyright 1996-1999
  10  *           Lars Gullik Bjønnes
  11  *
  12  * ======================================================
  13  */
  14
  15 #ifdef __GNUG__
  16 #pragma implementation
  17 #endif
  18
  19 #include <config.h>
  20
  21 #include <fstream>
  22 #include <sys/types.h>
  23 #include <utime.h>
  24
  25 #include "bufferlist.h"
  26 #include "lyx_main.h"
  27 #include "minibuffer.h"
  28 #include "support/FileInfo.h"
  29 #include "support/filetools.h"
  30 #include "lyx_gui_misc.h"
  31 #include "lastfiles.h"
  32 #include "debug.h"
  33 #include "lyxrc.h"
  34 #include "lyxscreen.h"
  35 #include "lyxtext.h"
  36 #include "lyx_cb.h"
  37 #include "gettext.h"
  38 #include "LyXView.h"
  39 #include "vc-backend.h"
  40
  41 extern BufferView * current_view;
  42 extern int RunLinuxDoc(int, string const &);
  43
  44 using std::ifstream;
  45 using std::ofstream;
  46 using std::ios;
  47
  48 //
  49 // Class BufferStorage
  50 //
  51
  52 void BufferStorage::release(Buffer * buf)
  53 {
  54         for(Container::iterator it = container.begin();
  55             it != container.end(); ++it) {
  56                 if ((*it) == buf) {
  57                         Buffer * tmpbuf = (*it);
  58                         container.erase(it);
  59                         delete tmpbuf;
  60                         break;
  61                 }
  62         }
  63 }
  64
  65
  66 Buffer * BufferStorage::newBuffer(string const & s,
  67                                   LyXRC * lyxrc,
  68                                   bool ronly)
  69 {
  70         Buffer * tmpbuf = new Buffer(s, lyxrc, ronly);
  71         tmpbuf->params.useClassDefaults();
  72         lyxerr.debug() << "Assigning to buffer "
  73                        << container.size() << endl;
  74         container.push_back(tmpbuf);
  75         return tmpbuf;
  76 }
  77
  78
  79 //
  80 // Class BufferList
  81 //
  82
  83 BufferList::BufferList()
  84         : state_(BufferList::OK)
  85 {}
  86
  87
  88 bool BufferList::empty()
  89 {
  90         return bstore.empty();
  91 }
  92
  93
  94 extern void MenuWrite(Buffer *);
  95
  96 bool BufferList::QwriteAll()
  97 {
  98         bool askMoreConfirmation = false;
  99         string unsaved;
 100         for(BufferStorage::iterator it = bstore.begin();
 101             it != bstore.end(); ++it) {
 102                 if (!(*it)->isLyxClean()) {
 103                         switch(AskConfirmation(_("Changes in document:"),
 104                                                MakeDisplayPath((*it)->fileName(),
 105                                                                50),
 106                                                _("Save document?"))) {
 107                         case 1: // Yes
 108                                 MenuWrite((*it));
 109                                 break;
 110                         case 2: // No
 111                                 askMoreConfirmation = true;
 112                                 unsaved += MakeDisplayPath((*it)->fileName(),
 113                                                            50);
 114                                 unsaved += "\n";
 115                                 break;
 116                         case 3: // Cancel
 117                                 return false;
 118                         }
 119                 }
 120         }
 121         if (askMoreConfirmation &&
 122             lyxrc->exit_confirmation &&
 123             !AskQuestion(_("Some documents were not saved:"),
 124                          unsaved, _("Exit anyway?"))) {
 125                 return false;
 126         }
 127
 128         return true;
 129 }
 130
 131
 132 // Should probably be moved to somewhere else: BufferView? LyXView?
 133 bool BufferList::write(Buffer * buf, bool makeBackup)
 134 {
 135         if (buf->getUser())
 136                 buf->getUser()
 137                         ->owner()
 138                         ->getMiniBuffer()
 139                         ->Set(_("Saving document"),
 140                               MakeDisplayPath(buf->fileName()), "...");
 141
 142         // We don't need autosaves in the immediate future. (Asger)
 143         buf->resetAutosaveTimers();
 144
 145         // make a backup
 146         if (makeBackup) {
 147                 string s = buf->fileName() + '~';
 148                 // Rename is the wrong way of making a backup,
 149                 // this is the correct way.
 150                 /* truss cp fil fil2:
 151                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
 152                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
 153                    open("LyXVC.lyx", O_RDONLY)                     = 3
 154                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
 155                    fstat(4, 0xEFFFF508)                            = 0
 156                    fstat(3, 0xEFFFF508)                            = 0
 157                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
 158                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
 159                    read(3, 0xEFFFD4A0, 8192)                       = 0
 160                    close(4)                                        = 0
 161                    close(3)                                        = 0
 162                    chmod("LyXVC3.lyx", 0100644)                    = 0
 163                    lseek(0, 0, SEEK_CUR)                           = 46440
 164                    _exit(0)
 165                 */
 166
 167                 // Should proabaly have some more error checking here.
 168                 // Should be cleaned up in 0.13, at least a bit.
 169                 // Doing it this way, also makes the inodes stay the same.
 170                 // This is still not a very good solution, in particular we
 171                 // might loose the owner of the backup.
 172                 FileInfo finfo(buf->fileName());
 173                 if (finfo.exist()) {
 174                         mode_t fmode = finfo.getMode();
 175                         struct utimbuf * times = new struct utimbuf;
 176
 177                         times->actime = finfo.getAccessTime();
 178                         times->modtime = finfo.getModificationTime();
 179                         ifstream ifs(buf->fileName().c_str());
 180                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
 181                         if (ifs && ofs) {
 182 #if 1
 183                                 ofs << ifs.rdbuf();
 184 #else
 185                                 char c = 0;
 186                                 while (ifs.get(c)) {
 187                                         ofs.put(c);
 188                                 }
 189 #endif
 190                                 ifs.close();
 191                                 ofs.close();
 192                                 chmod(s.c_str(), fmode);
 193
 194                                 if (utime(s.c_str(), times)) {
 195                                         lyxerr << "utime error." << endl;
 196                                 }
 197                         } else {
 198                                 lyxerr << "LyX was not able to make "
 199                                         "backupcopy. Beware." << endl;
 200                         }
 201                         delete times;
 202                 }
 203         }
 204
 205         if (buf->writeFile(buf->fileName(), false)) {
 206                 buf->markLyxClean();
 207
 208                 current_view->owner()->getMiniBuffer()->
 209                         Set(_("Document saved as"),
 210                         MakeDisplayPath(buf->fileName()));
 211
 212                 // now delete the autosavefile
 213                 string a = OnlyPath(buf->fileName());
 214                 a += '#';
 215                 a += OnlyFilename(buf->fileName());
 216                 a += '#';
 217                 FileInfo fileinfo(a);
 218                 if (fileinfo.exist()) {
 219                         if (remove(a.c_str()) != 0) {
 220                                 WriteFSAlert(_("Could not delete "
 221                                                "auto-save file!"), a);
 222                         }
 223                 }
 224         } else {
 225                 // Saving failed, so backup is not backup
 226                 if (makeBackup) {
 227                         string s = buf->fileName() + '~';
 228                         rename(s.c_str(), buf->fileName().c_str());
 229                 }
 230                 current_view->owner()->getMiniBuffer()->Set(_("Save failed!"));
 231                 return false;
 232         }
 233
 234         return true;
 235 }
 236
 237
 238 void BufferList::closeAll()
 239 {
 240         state_ = BufferList::CLOSING;
 241         while (!bstore.empty()) {
 242                 close(bstore.front());
 243         }
 244         state_ = BufferList::OK;
 245 }
 246
 247
 248 void BufferList::resize()
 249 {
 250         for(BufferStorage::iterator it = bstore.begin();
 251             it != bstore.end(); ++it) {
 252                 (*it)->resize();
 253         }
 254 }
 255
 256
 257 bool BufferList::close(Buffer * buf)
 258 {
 259         if (buf->getUser()) buf->getUser()->insetUnlock();
 260
 261         if (buf->paragraph && !buf->isLyxClean() && !quitting) {
 262                 ProhibitInput();
 263                 switch(AskConfirmation(_("Changes in document:"),
 264                                        MakeDisplayPath(buf->fileName(), 50),
 265                                        _("Save document?"))){
 266                 case 1: // Yes
 267                         if (write(buf, lyxrc->make_backup)) {
 268                                 lastfiles->newFile(buf->fileName());
 269                         } else {
 270                                 AllowInput();
 271                                 return false;
 272                         }
 273                         break;
 274                 case 3: // Cancel
 275                         AllowInput();
 276                         return false;
 277                 }
 278                 AllowInput();
 279         }
 280
 281         bstore.release(buf);
 282         return true;
 283 }
 284
 285
 286 vector<string> BufferList::getFileNames() const
 287 {
 288         vector<string> nvec;
 289         for(BufferStorage::const_iterator cit = bstore.begin();
 290             cit != bstore.end(); ++cit) {
 291                 nvec.push_back((*cit)->fileName());
 292         }
 293         return nvec;
 294 }
 295
 296
 297 Buffer * BufferList::first()
 298 {
 299         if (bstore.empty()) return 0;
 300         return bstore.front();
 301 }
 302
 303
 304 Buffer * BufferList::getBuffer(int choice)
 305 {
 306         if (choice >= bstore.size()) return 0;
 307         return bstore[choice];
 308 }
 309
 310
 311 void BufferList::updateInset(Inset * inset, bool mark_dirty)
 312 {
 313         for (BufferStorage::iterator it = bstore.begin();
 314              it != bstore.end(); ++it) {
 315                 if ((*it)->getUser()
 316                     && (*it)->getUser()->text->UpdateInset(inset)) {
 317                         if (mark_dirty)
 318                                 (*it)->markDirty();
 319                         break;
 320                 }
 321         }
 322 }
 323
 324
 325 int BufferList::unlockInset(UpdatableInset * inset)
 326 {
 327         if (!inset) return 1;
 328         for(BufferStorage::iterator it = bstore.begin();
 329             it != bstore.end(); ++it) {
 330                 if ((*it)->getUser()
 331                     && (*it)->getUser()->the_locking_inset == inset) {
 332                         (*it)->getUser()->insetUnlock();
 333                         return 0;
 334                 }
 335         }
 336         return 1;
 337 }
 338
 339
 340 void BufferList::updateIncludedTeXfiles(string const & mastertmpdir)
 341 {
 342         for(BufferStorage::iterator it = bstore.begin();
 343             it != bstore.end(); ++it) {
 344                 if (!(*it)->isDepClean(mastertmpdir)) {
 345                         string writefile = mastertmpdir;
 346                         writefile += '/';
 347                         writefile += ChangeExtension((*it)->fileName(),
 348                                                      ".tex", true);
 349                         (*it)->makeLaTeXFile(writefile, mastertmpdir,
 350                                              false, true);
 351                         (*it)->markDepClean(mastertmpdir);
 352                 }
 353         }
 354 }
 355
 356
 357 void BufferList::emergencyWriteAll()
 358 {
 359         for (BufferStorage::iterator it = bstore.begin();
 360              it != bstore.end(); ++it) {
 361                 if (!(*it)->isLyxClean()) {
 362                         bool madeit = false;
 363
 364                         lyxerr <<_("lyx: Attempting to save"
 365                                    " document ")
 366                                << (*it)->fileName()
 367                                << _(" as...") << endl;
 368
 369                         for (int i = 0; i < 3 && !madeit; ++i) {
 370                                 string s;
 371
 372                                 // We try to save three places:
 373                                 // 1) Same place as document.
 374                                 // 2) In HOME directory.
 375                                 // 3) In "/tmp" directory.
 376                                 if (i == 0) {
 377                                         s = (*it)->fileName();
 378                                 } else if (i == 1) {
 379                                         s = AddName(GetEnvPath("HOME"),
 380                                                     (*it)->fileName());
 381                                 } else {
 382                                         // MakeAbsPath to prepend the current
 383                                         // drive letter on OS/2
 384                                         s = AddName(MakeAbsPath("/tmp/"),
 385                                                     (*it)->fileName());
 386                                 }
 387                                 s += ".emergency";
 388
 389                                 lyxerr << "  " << i + 1 << ") " << s << endl;
 390
 391                                 if ((*it)->writeFile(s, true)) {
 392                                         (*it)->markLyxClean();
 393                                         lyxerr << _("  Save seems successful. "
 394                                                     "Phew.") << endl;
 395                                         madeit = true;
 396                                 } else if (i != 2) {
 397                                         lyxerr << _("  Save failed! Trying...")
 398                                                << endl;
 399                                 } else {
 400                                         lyxerr << _("  Save failed! Bummer. "
 401                                                     "Document is lost.")
 402                                                << endl;
 403                                 }
 404                         }
 405                 }
 406         }
 407 }
 408
 409
 410 Buffer * BufferList::readFile(string const & s, bool ronly)
 411 {
 412         Buffer * b = bstore.newBuffer(s, lyxrc, ronly);
 413
 414         string ts = s;
 415         string e = OnlyPath(s);
 416         string a = e;
 417         // File information about normal file
 418         FileInfo fileInfo2(s);
 419
 420         // Check if emergency save file exists and is newer.
 421         e += OnlyFilename(s) + ".emergency";
 422         FileInfo fileInfoE(e);
 423
 424         bool use_emergency = false;
 425
 426         if (fileInfoE.exist() && fileInfo2.exist()) {
 427                 if (fileInfoE.getModificationTime()
 428                     > fileInfo2.getModificationTime()) {
 429                         if (AskQuestion(_("An emergency save of this document exists!"),
 430                                         MakeDisplayPath(s, 50),
 431                                         _("Try to load that instead?"))) {
 432                                 ts = e;
 433                                 // the file is not saved if we load the
 434                                 // emergency file.
 435                                 b->markDirty();
 436                                 use_emergency = true;
 437                         } else {
 438                                 // Here, we should delete the emergency save
 439                                 unlink(e.c_str());
 440                         }
 441                 }
 442         }
 443
 444         if (!use_emergency) {
 445                 // Now check if autosave file is newer.
 446                 a += '#';
 447                 a += OnlyFilename(s);
 448                 a += '#';
 449                 FileInfo fileInfoA(a);
 450                 if (fileInfoA.exist() && fileInfo2.exist()) {
 451                         if (fileInfoA.getModificationTime()
 452                             > fileInfo2.getModificationTime()) {
 453                                 if (AskQuestion(_("Autosave file is newer."),
 454                                                 MakeDisplayPath(s, 50),
 455                                                 _("Load that one instead?"))) {
 456                                         ts = a;
 457                                         // the file is not saved if we load the
 458                                         // autosave file.
 459                                         b->markDirty();
 460                                 } else {
 461                                         // Here, we should delete the autosave
 462                                         unlink(a.c_str());
 463                                 }
 464                         }
 465                 }
 466         }
 467         // not sure if this is the correct place to begin LyXLex
 468         LyXLex lex(0, 0);
 469         lex.setFile(ts);
 470         if (b->readFile(lex))
 471                 return b;
 472         else {
 473                 bstore.release(b);
 474                 return 0;
 475         }
 476 }
 477
 478
 479 bool BufferList::exists(string const & s)
 480 {
 481         for (BufferStorage::iterator it = bstore.begin();
 482              it != bstore.end(); ++it) {
 483                 if ((*it)->fileName() == s)
 484                         return true;
 485         }
 486         return false;
 487 }
 488
 489
 490 Buffer * BufferList::getBuffer(string const & s)
 491 {
 492         for(BufferStorage::iterator it = bstore.begin();
 493             it != bstore.end(); ++it) {
 494                 if ((*it)->fileName() == s)
 495                         return (*it);
 496         }
 497         return 0;
 498 }
 499
 500
 501 Buffer * BufferList::newFile(string const & name, string tname)
 502 {
 503         /* get a free buffer */
 504         Buffer * b = bstore.newBuffer(name, lyxrc);
 505
 506         // use defaults.lyx as a default template if it exists.
 507         if (tname.empty()) {
 508                 tname = LibFileSearch("templates", "defaults.lyx");
 509         }
 510         if (!tname.empty() && IsLyXFilename(tname)){
 511                 bool templateok = false;
 512                 LyXLex lex(0, 0);
 513                 lex.setFile(tname);
 514                 if (lex.IsOK()) {
 515                         if (b->readFile(lex)) {
 516                                 templateok = true;
 517                         }
 518                 }
 519                 if (!templateok) {
 520                         WriteAlert(_("Error!"), _("Unable to open template"),
 521                                    MakeDisplayPath(tname));
 522                         // no template, start with empty buffer
 523                         b->paragraph = new LyXParagraph;
 524                 }
 525         }
 526         else {  // start with empty buffer
 527                 b->paragraph = new LyXParagraph;
 528         }
 529
 530         b->markDirty();
 531         b->setReadonly(false);
 532
 533         return b;
 534 }
 535
 536
 537 Buffer * BufferList::loadLyXFile(string const & filename, bool tolastfiles)
 538 {
 539         // make sure our path is absolute
 540         string s = MakeAbsPath(filename);
 541
 542         // Is this done too early?
 543         // Is it LinuxDoc?
 544         if (IsSGMLFilename(s)) {
 545                 FileInfo fi(s);
 546                 if (fi.exist() && fi.readable()) {
 547                         if (!RunLinuxDoc(-1, s)) {
 548                                 s = ChangeExtension (s, ".lyx", false);
 549                         } else { // sgml2lyx failed
 550                                 WriteAlert(_("Error!"),
 551                                            _("Could not convert file"), s);
 552                                 return 0;
 553                         }
 554                 } else {
 555                         // just change the extension and it will be
 556                         // handled like a regular lyx file that does
 557                         // not exist.
 558                         s = ChangeExtension(s, ".lyx", false);
 559                 }
 560         }
 561
 562         // file already open?
 563         if (exists(s)) {
 564                 if (AskQuestion(_("Document is already open:"),
 565                                 MakeDisplayPath(s, 50),
 566                                 _("Do you want to reload that document?"))) {
 567                         // Reload is accomplished by closing and then loading
 568                         if (!close(getBuffer(s))) {
 569                                 return 0;
 570                         }
 571                         // Fall through to new load. (Asger)
 572                 } else {
 573                         // Here, we pretend that we just loaded the
 574                         // open document
 575                         return getBuffer(s);
 576                 }
 577         }
 578         Buffer * b = 0;
 579         bool ro = false;
 580         switch (IsFileWriteable(s)) {
 581         case 0:
 582                 current_view->owner()->getMiniBuffer()->
 583                         Set(_("File `")+MakeDisplayPath(s, 50)+
 584                         _("' is read-only."));
 585                 ro = true;
 586                 // Fall through
 587         case 1:
 588                 b = readFile(s, ro);
 589                 if (b) {
 590                         b->lyxvc.file_found_hook(s);
 591                 }
 592                 break; //fine- it's r/w
 593         case -1:
 594                 // Here we probably should run
 595                 if (LyXVC::file_not_found_hook(s)) {
 596                         // Ask if the file should be checked out for
 597                         // viewing/editing, if so: load it.
 598                         if (AskQuestion(_("Do you want to retrive file under version control?"))) {
 599                                 // How can we know _how_ to do the checkout?
 600                                 // With the current VC support it has to be,
 601                                 // a RCS file since CVS do not have special ,v files.
 602                                 RCS::retrive(s);
 603                                 return loadLyXFile(filename, tolastfiles);
 604                         }
 605                 }
 606                 if (AskQuestion(_("Cannot open specified file:"),
 607                                 MakeDisplayPath(s, 50),
 608                                 _("Create new document with this name?")))
 609                         {
 610                                 // Find a free buffer
 611                                 b = newFile(s, string());
 612                         }
 613                 break;
 614         }
 615
 616         if (b && tolastfiles)
 617                 lastfiles->newFile(b->fileName());
 618
 619         return b;
 620 }