lyx_mirror/src/VCBackend.cpp
Jürgen Spitzmüller 44e35d1cd4 * VCBackend.cpp:
- some spelling and grammar fixes (a native EN speaker will have to double-check).

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@28837 a592a061-630c-0410-9148-cb99ea01b6c8
2009-03-17 11:06:28 +00:00

688 lines
16 KiB
C++

/**
* \file VCBackend.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "VCBackend.h"
#include "Buffer.h"
#include "frontends/alert.h"
#include "support/debug.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/Path.h"
#include "support/Systemcall.h"
#include <boost/regex.hpp>
#include <fstream>
using namespace std;
using namespace lyx::support;
using boost::regex;
using boost::regex_match;
using boost::smatch;
namespace lyx {
int VCS::doVCCommandCall(string const & cmd, FileName const & path){
LYXERR(Debug::LYXVC, "doVCCommandCall: " << cmd);
Systemcall one;
support::PathChanger p(path);
return one.startscript(Systemcall::Wait, cmd);
}
int VCS::doVCCommand(string const & cmd, FileName const & path)
{
if (owner_)
owner_->setBusy(true);
int const ret = doVCCommandCall(cmd, path);
if (owner_)
owner_->setBusy(false);
if (ret)
frontend::Alert::error(_("Revision control error."),
bformat(_("Some problem occured while running the command:\n"
"'%1$s'."),
from_utf8(cmd)));
return ret;
}
/////////////////////////////////////////////////////////////////////
//
// RCS
//
/////////////////////////////////////////////////////////////////////
RCS::RCS(FileName const & m)
{
master_ = m;
scanMaster();
}
FileName const RCS::findFile(FileName const & file)
{
// Check if *,v exists.
FileName tmp(file.absFilename() + ",v");
LYXERR(Debug::LYXVC, "LyXVC: Checking if file is under rcs: " << tmp);
if (tmp.isReadableFile()) {
LYXERR(Debug::LYXVC, "Yes, " << file << " is under rcs.");
return tmp;
}
// Check if RCS/*,v exists.
tmp = FileName(addName(addPath(onlyPath(file.absFilename()), "RCS"), file.absFilename()) + ",v");
LYXERR(Debug::LYXVC, "LyXVC: Checking if file is under rcs: " << tmp);
if (tmp.isReadableFile()) {
LYXERR(Debug::LYXVC, "Yes, " << file << " is under rcs.");
return tmp;
}
return FileName();
}
void RCS::retrieve(FileName const & file)
{
LYXERR(Debug::LYXVC, "LyXVC::RCS: retrieve.\n\t" << file);
doVCCommandCall("co -q -r " + quoteName(file.toFilesystemEncoding()),
FileName());
}
void RCS::scanMaster()
{
if (master_.empty())
return;
LYXERR(Debug::LYXVC, "LyXVC::RCS: scanMaster: " << master_);
ifstream ifs(master_.toFilesystemEncoding().c_str());
string token;
bool read_enough = false;
while (!read_enough && ifs >> token) {
LYXERR(Debug::LYXVC, "LyXVC::scanMaster: current lex text: `"
<< token << '\'');
if (token.empty())
continue;
else if (token == "head") {
// get version here
string tmv;
ifs >> tmv;
tmv = rtrim(tmv, ";");
version_ = tmv;
LYXERR(Debug::LYXVC, "LyXVC: version found to be " << tmv);
} else if (contains(token, "access")
|| contains(token, "symbols")
|| contains(token, "strict")) {
// nothing
} else if (contains(token, "locks")) {
// get locker here
if (contains(token, ';')) {
locker_ = "Unlocked";
vcstatus = UNLOCKED;
continue;
}
string tmpt;
string s1;
string s2;
do {
ifs >> tmpt;
s1 = rtrim(tmpt, ";");
// tmp is now in the format <user>:<version>
s1 = split(s1, s2, ':');
// s2 is user, and s1 is version
if (s1 == version_) {
locker_ = s2;
vcstatus = LOCKED;
break;
}
} while (!contains(tmpt, ';'));
} else if (token == "comment") {
// we don't need to read any further than this.
read_enough = true;
} else {
// unexpected
LYXERR(Debug::LYXVC, "LyXVC::scanMaster(): unexpected token");
}
}
}
void RCS::registrer(string const & msg)
{
string cmd = "ci -q -u -i -t-\"";
cmd += msg;
cmd += "\" ";
cmd += quoteName(onlyFilename(owner_->absFileName()));
doVCCommand(cmd, FileName(owner_->filePath()));
}
string RCS::checkIn(string const & msg)
{
int ret = doVCCommand("ci -q -u -m\"" + msg + "\" "
+ quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
return ret ? string() : "RCS: Proceeded";
}
bool RCS::checkInEnabled()
{
return owner_ && !owner_->isReadonly();
}
string RCS::checkOut()
{
owner_->markClean();
int ret = doVCCommand("co -q -l " + quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
return ret ? string() : "RCS: Proceeded";
}
bool RCS::checkOutEnabled()
{
return owner_ && owner_->isReadonly();
}
void RCS::revert()
{
doVCCommand("co -f -u" + version() + " "
+ quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
// We ignore changes and just reload!
owner_->markClean();
}
void RCS::undoLast()
{
LYXERR(Debug::LYXVC, "LyXVC: undoLast");
doVCCommand("rcs -o" + version() + " "
+ quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
}
bool RCS::undoLastEnabled()
{
return true;
}
void RCS::getLog(FileName const & tmpf)
{
doVCCommand("rlog " + quoteName(onlyFilename(owner_->absFileName()))
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
FileName(owner_->filePath()));
}
bool RCS::toggleReadOnlyEnabled()
{
return true;
}
/////////////////////////////////////////////////////////////////////
//
// CVS
//
/////////////////////////////////////////////////////////////////////
CVS::CVS(FileName const & m, FileName const & f)
{
master_ = m;
file_ = f;
scanMaster();
}
FileName const CVS::findFile(FileName const & file)
{
// First we look for the CVS/Entries in the same dir
// where we have file.
FileName const entries(onlyPath(file.absFilename()) + "/CVS/Entries");
string const tmpf = '/' + onlyFilename(file.absFilename()) + '/';
LYXERR(Debug::LYXVC, "LyXVC: Checking if file is under cvs in `" << entries
<< "' for `" << tmpf << '\'');
if (entries.isReadableFile()) {
// Ok we are at least in a CVS dir. Parse the CVS/Entries
// and see if we can find this file. We do a fast and
// dirty parse here.
ifstream ifs(entries.toFilesystemEncoding().c_str());
string line;
while (getline(ifs, line)) {
LYXERR(Debug::LYXVC, "\tEntries: " << line);
if (contains(line, tmpf))
return entries;
}
}
return FileName();
}
void CVS::scanMaster()
{
LYXERR(Debug::LYXVC, "LyXVC::CVS: scanMaster. \n Checking: " << master_);
// Ok now we do the real scan...
ifstream ifs(master_.toFilesystemEncoding().c_str());
string tmpf = '/' + onlyFilename(file_.absFilename()) + '/';
LYXERR(Debug::LYXVC, "\tlooking for `" << tmpf << '\'');
string line;
static regex const reg("/(.*)/(.*)/(.*)/(.*)/(.*)");
while (getline(ifs, line)) {
LYXERR(Debug::LYXVC, "\t line: " << line);
if (contains(line, tmpf)) {
// Ok extract the fields.
smatch sm;
regex_match(line, sm, reg);
//sm[0]; // whole matched string
//sm[1]; // filename
version_ = sm.str(2);
string const file_date = sm.str(3);
//sm[4]; // options
//sm[5]; // tag or tagdate
// FIXME: must double check file is stattable/existing
time_t mod = file_.lastModified();
string mod_date = rtrim(asctime(gmtime(&mod)), "\n");
LYXERR(Debug::LYXVC, "Date in Entries: `" << file_date
<< "'\nModification date of file: `" << mod_date << '\'');
//FIXME this whole locking bussiness is not working under cvs and the machinery
// conforms to the ci usage, not cvs.
if (file_date == mod_date) {
locker_ = "Unlocked";
vcstatus = UNLOCKED;
} else {
// Here we should also to some more checking
// to see if there are conflicts or not.
locker_ = "Locked";
vcstatus = LOCKED;
}
break;
}
}
}
void CVS::registrer(string const & msg)
{
doVCCommand("cvs -q add -m \"" + msg + "\" "
+ quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
}
string CVS::checkIn(string const & msg)
{
int ret = doVCCommand("cvs -q commit -m \"" + msg + "\" "
+ quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
return ret ? string() : "CVS: Proceeded";
}
bool CVS::checkInEnabled()
{
return true;
}
string CVS::checkOut()
{
// cvs update or perhaps for cvs this should be a noop
// we need to detect conflict (eg "C" in output)
// before we can do this.
lyxerr << "Sorry, not implemented." << endl;
return string();
}
bool CVS::checkOutEnabled()
{
return false;
}
void CVS::revert()
{
// Reverts to the version in CVS repository and
// gets the updated version from the repository.
string const fil = quoteName(onlyFilename(owner_->absFileName()));
// This is sensitive operation, so at lest some check about
// existence of cvs program and its file
if (doVCCommand("cvs log "+ fil, FileName(owner_->filePath())))
return;
FileName f(owner_->absFileName());
f.removeFile();
doVCCommand("cvs update " + fil,
FileName(owner_->filePath()));
owner_->markClean();
}
void CVS::undoLast()
{
// merge the current with the previous version
// in a reverse patch kind of way, so that the
// result is to revert the last changes.
lyxerr << "Sorry, not implemented." << endl;
}
bool CVS::undoLastEnabled()
{
return false;
}
void CVS::getLog(FileName const & tmpf)
{
doVCCommand("cvs log " + quoteName(onlyFilename(owner_->absFileName()))
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
FileName(owner_->filePath()));
}
bool CVS::toggleReadOnlyEnabled()
{
return false;
}
/////////////////////////////////////////////////////////////////////
//
// SVN
//
/////////////////////////////////////////////////////////////////////
SVN::SVN(FileName const & m, FileName const & f)
{
owner_ = 0;
master_ = m;
file_ = f;
locked_mode_ = 0;
scanMaster();
}
FileName const SVN::findFile(FileName const & file)
{
// First we look for the .svn/entries in the same dir
// where we have file.
FileName const entries(onlyPath(file.absFilename()) + "/.svn/entries");
string const tmpf = onlyFilename(file.absFilename());
LYXERR(Debug::LYXVC, "LyXVC: Checking if file is under svn in `" << entries
<< "' for `" << tmpf << '\'');
if (entries.isReadableFile()) {
// Ok we are at least in a SVN dir. Parse the .svn/entries
// and see if we can find this file. We do a fast and
// dirty parse here.
ifstream ifs(entries.toFilesystemEncoding().c_str());
string line, oldline;
while (getline(ifs, line)) {
if (line == "dir" || line == "file")
LYXERR(Debug::LYXVC, "\tEntries: " << oldline);
if (oldline == tmpf && line == "file")
return entries;
oldline = line;
}
}
return FileName();
}
void SVN::scanMaster()
{
locker_.clear();
vcstatus = NOLOCKING;
if (checkLockMode()) {
if (isLocked()) {
locker_ = "Locked";
vcstatus = LOCKED;
} else {
locker_ = "Unlocked";
vcstatus = LOCKED;
}
}
}
bool SVN::checkLockMode()
{
FileName tmpf = FileName::tempName("lyxvcout");
if (tmpf.empty()){
LYXERR(Debug::LYXVC, "Could not generate logfile " << tmpf);
return N_("Error: Could not generate logfile.");
}
LYXERR(Debug::LYXVC, "Detecting locking mode...");
if (doVCCommandCall("svn proplist " + quoteName(file_.onlyFileName())
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
file_.onlyPath()))
return false;
ifstream ifs(tmpf.toFilesystemEncoding().c_str());
string line;
bool ret = false;
while (ifs) {
getline(ifs, line);
LYXERR(Debug::LYXVC, line);
if (contains(line, "svn:needs-lock"))
ret = true;
}
LYXERR(Debug::LYXVC, "Locking enabled: " << ret);
ifs.close();
locked_mode_ = ret;
return ret;
}
bool SVN::isLocked() const
{
//refresh file info
FileName file(file_.absFilename());
return !file.isReadOnly();
}
void SVN::registrer(string const & /*msg*/)
{
doVCCommand("svn add -q " + quoteName(onlyFilename(owner_->absFileName())),
FileName(owner_->filePath()));
}
string SVN::checkIn(string const & msg)
{
FileName tmpf = FileName::tempName("lyxvcout");
if (tmpf.empty()){
LYXERR(Debug::LYXVC, "Could not generate logfile " << tmpf);
return N_("Error: Could not generate logfile.");
}
doVCCommand("svn commit -m \"" + msg + "\" "
+ quoteName(onlyFilename(owner_->absFileName()))
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
FileName(owner_->filePath()));
string log;
string res = scanLogFile(tmpf, log);
if (!res.empty())
frontend::Alert::error(_("Revision control error."),
_("Error when committing to repository.\n"
"You have to manually resolve the problem.\n"
"After pressing OK, LyX will reopen the document."));
else
fileLock(false, tmpf, log);
tmpf.erase();
return "SVN: " + log;
}
bool SVN::checkInEnabled()
{
if (locked_mode_)
return isLocked();
else
return true;
}
// FIXME Correctly return code should be checked instead of this.
// This would need another solution than just plain startscript.
// Hint from Andre': QProcess::readAllStandardError()...
string SVN::scanLogFile(FileName const & f, string & status)
{
ifstream ifs(f.toFilesystemEncoding().c_str());
string line;
while (ifs) {
getline(ifs, line);
lyxerr << line << "\n";
if (!line.empty()) status += line + "; ";
if (prefixIs(line, "C ") || contains(line, "Commit failed")) {
ifs.close();
return line;
}
}
ifs.close();
return string();
}
void SVN::fileLock(bool lock, FileName const & tmpf, string &status)
{
if (!locked_mode_ || (isLocked() == lock))
return;
string arg = lock ? "lock " : "unlock ";
doVCCommand("svn "+ arg + quoteName(onlyFilename(owner_->absFileName()))
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
FileName(owner_->filePath()));
ifstream ifs(tmpf.toFilesystemEncoding().c_str());
string line;
while (ifs) {
getline(ifs, line);
if (!line.empty()) status += line + "; ";
}
ifs.close();
if (!isLocked() && lock)
frontend::Alert::error(_("Revision control error."),
_("Error when acquiring write lock.\n"
"Most probably another user is editing\n"
"the current document now!\n"
"Also check the access to the repository."));
if (isLocked() && !lock)
frontend::Alert::error(_("Revision control error."),
_("Error when releasing write lock.\n"
"Check the access to the repository."));
}
string SVN::checkOut()
{
FileName tmpf = FileName::tempName("lyxvcout");
if (tmpf.empty()) {
LYXERR(Debug::LYXVC, "Could not generate logfile " << tmpf);
return N_("Error: Could not generate logfile.");
}
doVCCommand("svn update " + quoteName(onlyFilename(owner_->absFileName()))
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
FileName(owner_->filePath()));
string log;
string res = scanLogFile(tmpf, log);
if (!res.empty())
frontend::Alert::error(_("Revision control error."),
bformat(_("Error when updating from repository.\n"
"You have to manually resolve the conflicts NOW!\n'%1$s'.\n\n"
"After pressing OK, LyX will try to reopen resolved document."),
from_local8bit(res)));
fileLock(true, tmpf, log);
tmpf.erase();
return "SVN: " + log;
}
bool SVN::checkOutEnabled()
{
if (locked_mode_)
return !isLocked();
else
return true;
}
void SVN::revert()
{
// Reverts to the version in CVS repository and
// gets the updated version from the repository.
string const fil = quoteName(onlyFilename(owner_->absFileName()));
doVCCommand("svn revert -q " + fil,
FileName(owner_->filePath()));
owner_->markClean();
}
void SVN::undoLast()
{
// merge the current with the previous version
// in a reverse patch kind of way, so that the
// result is to revert the last changes.
lyxerr << "Sorry, not implemented." << endl;
}
bool SVN::undoLastEnabled()
{
return false;
}
void SVN::getLog(FileName const & tmpf)
{
doVCCommand("svn log " + quoteName(onlyFilename(owner_->absFileName()))
+ " > " + quoteName(tmpf.toFilesystemEncoding()),
FileName(owner_->filePath()));
}
bool SVN::toggleReadOnlyEnabled()
{
return false;
}
} // namespace lyx