src/hunks/ChangeSet.cpp

   1 /*
   2  * This file is part of the vng project
   3  * Copyright (C) 2008 Thomas Zander <tzander@trolltech.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "ChangeSet.h"
  20 #include "../GitRunner.h"
  21 #include "../Logger.h" // for debugging level only
  22 #include "../AbstractCommand.h"
  23 #include "../Vng.h"
  24
  25 #include <QProcess>
  26 #include <QThread>
  27 #include <QMutexLocker>
  28 #include <QMutex>
  29 #include <QWaitCondition>
  30 #include <QDebug>
  31
  32 class HunksFetcher : public QThread
  33 {
  34 public:
  35     HunksFetcher(const QList<File> &files, ChangeSet &changeSet, bool changeSetOnIndex)
  36         : m_files(files),
  37             m_changeSet(changeSet),
  38             m_changeSetOnIndex(changeSetOnIndex),
  39             m_interrupted(false)
  40     {
  41     }
  42
  43     void run()
  44     {
  45         setPriority(QThread::LowPriority);
  46         foreach(File file, m_files) {
  47             if (m_interrupted)
  48                 break;
  49             m_changeSet.lockFile(file);
  50
  51             file.fetchHunks(m_changeSetOnIndex);
  52
  53             if (!file.isBinary() && file.count() == 0 && !file.hasChanged()) { // No change in file at all.
  54                 Logger::debug() << "file: `" << QString::fromUtf8(file.oldFileName()) << "' => `" << QString::fromUtf8(file.fileName()) << "'\n";
  55                 Logger::debug() << "  +- Unchanged file, skipping\n";
  56                 m_changeSet.removeFile(file);
  57                 QProcess git;
  58                 QStringList arguments;
  59                 arguments << "update-index" << "-q" <<  "--refresh" << file.fileName();
  60                 GitRunner runner(git, arguments);
  61                 runner.start(GitRunner::WaitUntilFinished);
  62                 continue;
  63             }
  64             if (file.fileName().isEmpty() || file.oldFileName().isEmpty())
  65                 file.setProtectionAcceptance(Vng::Accepted);
  66
  67             int i=0;
  68             if (Logger::verbosity() >= Logger::Debug) {
  69                 Logger::debug() << "file: `" << QString::fromUtf8(file.oldFileName()) << "' => `" << QString::fromUtf8(file.fileName()) << "'\n";
  70                 if (file.isBinary())
  71                     Logger::debug() << "  +-  is a binary file" << endl;
  72                 Logger::debug() << "  +- " << file.oldProtection() << " => " << file.protection() << endl;
  73                 foreach(Hunk h, file.hunks()) {
  74                     Logger::debug() << "  +-(" << i++ << ") @" << h.lineNumber() << "; " << h.patch().size() << " bytes\n";
  75                     for(int i = 0; i < h.subHunkCount(); i++) {
  76                         Logger::debug() << "       " << i <<"/"<< h.subHunkCount() <<"; "<< h.subHunk(i).size() <<" bytes\n";
  77                     }
  78                 }
  79             }
  80         }
  81         m_changeSet.lockFile(File());
  82         m_changeSet.allHunksFetched();
  83     }
  84
  85     void interrupt()
  86     {
  87         m_interrupted = true;
  88     }
  89
  90 private:
  91     QList<File> m_files;
  92     ChangeSet &m_changeSet;
  93     bool m_changeSetOnIndex, m_interrupted;
  94 };
  95
  96 class ChangeSet::Private
  97 {
  98 public:
  99     Private() :
 100         changeSetOnIndex(false),
 101         hunksFetcher(0),
 102         ref(1),
 103         finishedOneHunk(true)
 104     {
 105     }
 106
 107     ~Private() {
 108         if (hunksFetcher) {
 109             hunksFetcher->interrupt();
 110             hunksFetcher->wait();
 111             delete hunksFetcher;
 112         }
 113     }
 114
 115     QList<File> files;
 116     bool changeSetOnIndex; // the changesSet shows the changes of the working dir
 117     QMutex fileAccessLock;
 118     QWaitCondition fileAccessWaiter;
 119     QWaitCondition cursorAccessWaiter;
 120     QMutex cursorAccessLock;
 121     File lockedFile;
 122     HunksFetcher *hunksFetcher;
 123 #if QT_VERSION >= 0x040400
 124     QAtomicInt ref;
 125 #else
 126     int ref;
 127 #endif
 128     bool finishedOneHunk;
 129 };
 130
 131 ChangeSet::ChangeSet()
 132     : d(new Private())
 133 {
 134 }
 135
 136 ChangeSet::~ChangeSet()
 137 {
 138 #if QT_VERSION >= 0x040400
 139     if (!d->ref.deref())
 140 #else
 141     if (--d->ref == 0)
 142 #endif
 143         delete d;
 144 }
 145
 146 ChangeSet::ChangeSet(const ChangeSet &other)
 147     : d(other.d)
 148 {
 149 #if QT_VERSION >= 0x040400
 150     d->ref.ref();
 151 #else
 152     d->ref++;
 153 #endif
 154 }
 155
 156 AbstractCommand::ReturnCodes ChangeSet::fillFromDiffFile(QIODevice &file)
 157 {
 158     file.open(QIODevice::ReadOnly);
 159
 160     foreach (File f, readGitDiff(file))
 161         addFile(f);
 162
 163     if (Logger::verbosity() >= Logger::Debug) {
 164         foreach(File f, d->files) {
 165             Logger::debug() << "changes in file: " << f.fileName() << endl;
 166             int i=0;
 167             foreach(Hunk h, f.hunks()) {
 168                 Logger::debug() << "  +-(" << i++ << ") @" << h.lineNumber() << "; " << h.patch().size() << " bytes\n";
 169                 for(int i = 0; i < h.subHunkCount(); i++) {
 170                     Logger::debug() << "       " << i <<"/"<< h.subHunkCount() <<"; "<< h.subHunk(i).size() <<" bytes\n";
 171                 }
 172             }
 173         }
 174         Logger::debug().flush();
 175     }
 176     return AbstractCommand::Ok;
 177 }
 178
 179 AbstractCommand::ReturnCodes ChangeSet::fillFromCurrentChanges(const QStringList &paths, bool doGenerateHunks )
 180 {
 181     d->changeSetOnIndex = true;
 182     QDir refs(".git/refs/heads");
 183     const bool emptyRepo = refs.count() == 2; // only '.' and '..'
 184     if (emptyRepo) { // all files added are new, just add all.
 185         QProcess git;
 186         QStringList arguments;
 187         arguments << "ls-files" << "-s";
 188         GitRunner runner(git, arguments);
 189         AbstractCommand::ReturnCodes rc = runner.start(GitRunner::WaitForStandardOutput);
 190         if (rc)
 191             return rc;
 192         char buf[1024];
 193         while(true) {
 194             qint64 lineLength = Vng::readLine(&git, buf, sizeof(buf));
 195             if (lineLength == -1)
 196                 break;
 197             File file;
 198             file.setProtection(QString::fromAscii(buf, 6));
 199             file.setSha1(QString::fromAscii(buf+7, 40));
 200             file.setFileName(File::escapeGitFilename(QByteArray(buf + 50, lineLength - 51)));
 201             d->files.append(file);
 202         }
 203         return AbstractCommand::Ok;
 204     }
 205
 206     // TODO the below misses the usecase of vng add and then a filesystem rm. Use diff-index --cached to show those.
 207     QProcess git;
 208     QStringList arguments;
 209     arguments << "diff-index" << "-M" << "HEAD";
 210     if (! paths.isEmpty())
 211         arguments << "--" << paths;
 212
 213     // for each line
 214     // new file:
 215     // :000000 100644 0000000000000000000000000000000000000000 8c3ae1d344f18b23c3bdde5d26658b70b03c65d9 A      bar
 216     // rename main.cpp => notmain.cpp
 217     // :100644 100644 e58cfe72cb7a9559a0090886bea5b0ce00db6b47 477c729e5abbd701eb708df563e7e4f749b50435 R074   main.cpp        notmain.cpp
 218     // normal change
 219     // :100644 100644 0bdd73e9ea0ba026f6796799946c4bfc9dd1b0b8 0000000000000000000000000000000000000000 M      test
 220
 221     GitRunner runner(git, arguments);
 222     AbstractCommand::ReturnCodes rc = runner.start(GitRunner::WaitForStandardOutput);
 223     if (rc)
 224         return rc;
 225     char buf[1024];
 226     while(true) {
 227         qint64 lineLength = Vng::readLine(&git, buf, sizeof(buf));
 228         if (lineLength == -1)
 229             break;
 230         if (lineLength > 0 && buf[0] != ':') // not a diff line, ignore.
 231             continue;
 232
 233         File file;
 234         file.setOldProtection(QString::fromAscii(buf+1, 6));
 235         file.setProtection(QString::fromAscii(buf+8, 6));
 236         file.setOldSha1(QString::fromAscii(buf+15, 40));
 237         file.setSha1(QString::fromAscii(buf+56, 40));
 238         int offset = 98;
 239         while (buf[offset] != '\t' && offset < lineLength)
 240             offset++;
 241         if (buf[97] == 'R') { // rename
 242             int tab = offset + 1;
 243             while (buf[tab] != '\t' && tab < lineLength)
 244                 tab++;
 245             file.setOldFileName(File::escapeGitFilename(QByteArray(buf + offset + 1, tab - offset - 1)));
 246             file.setFileName(File::escapeGitFilename(QByteArray(buf + tab + 1, lineLength - tab - 2)));
 247         }
 248         else if (buf[97] == 'C') { // Copied file
 249             int tab = offset + 1;
 250             while (buf[tab] != '\t' && tab < lineLength)
 251                 tab++;
 252             QByteArray filename(buf + offset + 1, tab - offset - 1);
 253             filename = File::escapeGitFilename(filename);
 254             file.setOldFileName(filename);
 255             file.setFileName(filename);
 256         }
 257         else {
 258             QByteArray filename(buf + offset + 1, lineLength - offset - 2);
 259             filename = File::escapeGitFilename(filename);
 260             if (buf[97] != 'A') // Add
 261                 file.setOldFileName(filename);
 262             if (buf[97] != 'D') // Delete
 263                 file.setFileName(filename);
 264         }
 265         d->files.append(file);
 266     }
 267     if (doGenerateHunks)
 268         generateHunks();
 269
 270     // call git-diff-files which will find all files that have been removed from the filesystem but are in the index.
 271     // Since we don't like the index we just remove them from the index here.
 272     arguments.clear();
 273     arguments << "diff-files";
 274     if (! paths.isEmpty())
 275         arguments << "--" << paths;
 276     runner.setArguments(arguments);
 277     rc = runner.start(GitRunner::WaitForStandardOutput);
 278     if (rc)
 279         return rc;
 280     arguments.clear();
 281     arguments << "update-index" << "--remove";
 282     while(true) {
 283         qint64 lineLength = Vng::readLine(&git, buf, sizeof(buf));
 284         if (lineLength == -1)
 285             break;
 286         if (lineLength > 0 && buf[0] != ':') // not a diff line, ignore.
 287             continue;
 288         if (lineLength < 97 ||buf[97] != 'D')
 289             continue;
 290
 291         int offset = 98;
 292         while (buf[offset] != '\t' && offset < lineLength)
 293             offset++;
 294         arguments.append(QString::fromUtf8(File::escapeGitFilename(QByteArray(buf + offset + 1, lineLength - offset - 2))));
 295     }
 296     if (arguments.count() > 2) {
 297         runner.setArguments(arguments);
 298         runner.start(GitRunner::WaitUntilFinished);
 299     }
 300
 301     return AbstractCommand::Ok;
 302 }
 303
 304 void ChangeSet::generateHunks()
 305 {
 306     Q_ASSERT(d->hunksFetcher == 0);
 307     d->hunksFetcher = new HunksFetcher(d->files, *this, d->changeSetOnIndex);
 308     d->finishedOneHunk = false;
 309     d->hunksFetcher->start();
 310 }
 311
 312 void ChangeSet::lockFile(const File &file)
 313 {
 314     // qDebug() << "ChangeSet::lockFile";
 315     QMutexLocker ml(&d->fileAccessLock);
 316     d->lockedFile = file;
 317     if (d->files.count() == 0 || d->files.at(0) != file) { // as soon as we have done a file, we can start the interaction
 318         // qDebug() << "  unlock cursorAccessWaiter";
 319         d->cursorAccessLock.lock();
 320         d->finishedOneHunk = true;
 321         d->cursorAccessWaiter.wakeAll();
 322         d->cursorAccessLock.unlock();
 323     }
 324
 325     d->fileAccessWaiter.wakeAll();
 326     // qDebug() << "~ChangeSet::lockFile";
 327 }
 328
 329 void ChangeSet::removeFile(const File &file)
 330 {
 331     QMutexLocker ml(&d->fileAccessLock);
 332     // TODO move the cursor if this file is the current file.
 333     d->files.removeAll(file);
 334     d->fileAccessWaiter.wakeAll();
 335 }
 336
 337 void ChangeSet::allHunksFetched()
 338 {
 339     // qDebug() << "ChangeSet::allHunksFetched";
 340     QMutexLocker ml(&d->fileAccessLock);
 341     d->lockedFile = File();
 342     d->fileAccessWaiter.wakeAll();
 343     // qDebug() << "~ChangeSet::allHunksFetched";
 344 }
 345
 346 bool ChangeSet::hasAllHunks() const
 347 {
 348     return d->hunksFetcher == 0 || d->hunksFetcher->isFinished();
 349 }
 350
 351 // static
 352 QList<File> ChangeSet::readGitDiff(QIODevice &git, File *fileToDiff)
 353 {
 354     QList<File> filesInDiff;
 355
 356     // parse the output and create objects for each hunk. (note how that can be made multi-threading)
 357     //  we have to have the filename in the hunk too to allow skipping a whole hunk
 358     char buf[10240];
 359     bool inPatch = false;
 360     // a diff can be multiple files, or just the one fileToDiff.  Lets keep one File object to point to the current file.
 361     File file;
 362     Hunk hunk;
 363     while(true) {
 364         qint64 lineLength = Vng::readLine(&git, buf, sizeof(buf));
 365         if (lineLength == -1)
 366             break;
 367         QString line = QString::fromLocal8Bit(buf, lineLength);
 368
 369         const bool newfile = line.startsWith("--- /dev/null");
 370         if (line.length() > 6 && (newfile || line.startsWith("--- a/"))) {
 371             file.addHunk(hunk);
 372             hunk = Hunk();
 373             if (file.isValid())
 374                 filesInDiff << file;
 375             if (fileToDiff)
 376                 file = File(*fileToDiff);
 377             else {
 378                 file = File();
 379                 if (!newfile) {
 380                     file.setOldFileName(File::escapeGitFilename(QByteArray(buf + 6, strlen(buf) - 7)));
 381                 }
 382             }
 383             inPatch = false;
 384         }
 385         else if (fileToDiff == 0 && line.length() > 6 && line.startsWith("+++ b/")) {
 386             QByteArray array(buf + 6, strlen(buf) - 7);
 387             file.setFileName(File::escapeGitFilename(array));
 388         }
 389         else if (line.length() > 5 && line.startsWith("@@ -")) {
 390             file.addHunk(hunk);
 391             hunk = Hunk();
 392             inPatch = true;
 393         }
 394         else if (inPatch && line.startsWith("diff --git "))
 395             inPatch = false;
 396         else if (line.startsWith("Binary files a/") && line.indexOf(" differ") > 0) { // TODO does git do translations?
 397             Q_ASSERT(fileToDiff);
 398             fileToDiff->setBinary(true);
 399             git.close();
 400             return filesInDiff;
 401         }
 402         if (inPatch) {
 403             QByteArray array(buf, lineLength);
 404             hunk.addLine(array);
 405         }
 406     }
 407     file.addHunk(hunk);
 408     if (fileToDiff == 0 && file.isValid())
 409         filesInDiff << file;
 410     git.close();
 411     return filesInDiff;
 412 }
 413
 414 void ChangeSet::addFile(const File &file)
 415 {
 416     if (file.isValid())
 417         d->files << file;
 418 }
 419
 420 int ChangeSet::count() const
 421 {
 422     return d->files.count();
 423 }
 424
 425 void ChangeSet::writeDiff(QIODevice &file, ChangeSet::Selection selection) const
 426 {
 427     waitFinishGenerateHunks();
 428     file.open(QIODevice::WriteOnly | QIODevice::Truncate);
 429     QDataStream diff(&file);
 430     foreach(File file, d->files) {
 431         bool fileHeaderWritten = false;
 432         foreach(Hunk hunk, file.hunks()) {
 433             if (selection == AllHunks
 434                 || (selection == UserSelection
 435                   && (hunk.acceptance() == Vng::Accepted || hunk.acceptance() == Vng::MixedAcceptance))
 436                 || (selection == InvertedUserSelection && hunk.acceptance() != Vng::Accepted)) {
 437                 if (!fileHeaderWritten) {
 438                     diff.writeRawData("--- a/", 6);
 439                     diff.writeRawData(file.oldFileName().data(), file.oldFileName().size());
 440                     diff.writeRawData("\n+++ b/", 7);
 441                     diff.writeRawData(file.fileName().data(), file.fileName().size());
 442                     diff.writeRawData("\n", 1);
 443                     fileHeaderWritten = true;
 444                 }
 445                 QByteArray acceptedPatch;
 446                 if (selection == InvertedUserSelection)
 447                     acceptedPatch =hunk.rejectedPatch();
 448                 else if (selection == AllHunks) {
 449                     acceptedPatch = hunk.header();
 450                     acceptedPatch.append(hunk.patch());
 451                 }
 452                 else
 453                     acceptedPatch = hunk.acceptedPatch();
 454                 diff.writeRawData(acceptedPatch.data(), acceptedPatch.size());
 455             }
 456         }
 457     }
 458     file.close();
 459 }
 460
 461 bool ChangeSet::hasAcceptedChanges() const
 462 {
 463     waitFinishGenerateHunks();
 464     foreach(File file, d->files) {
 465         if (file.renameAcceptance() == Vng::Accepted && file.fileName() != file.oldFileName())
 466             return true;
 467         if (file.protectionAcceptance() == Vng::Accepted && file.protection() != file.oldProtection())
 468             return true;
 469         if (file.isBinary() && file.binaryChangeAcceptance() == Vng::Accepted)
 470             return true;
 471         foreach(Hunk hunk, file.hunks()) {
 472             Vng::Acceptance a = hunk.acceptance();
 473             if (a == Vng::Accepted || a == Vng::MixedAcceptance)
 474                 return true;
 475         }
 476     }
 477     return false;
 478 }
 479
 480 File ChangeSet::file(int index) const
 481 {
 482     // qDebug() << "ChangeSet::file" << index << d->finishedOneHunk;
 483     waitForFinishFirstFile();
 484     QMutexLocker ml2(&d->fileAccessLock);
 485     while (d->files.count() > index && d->files[index] == d->lockedFile)
 486 // { qDebug() << "  waiting for file to be unlocked";
 487         d->fileAccessWaiter.wait(&d->fileAccessLock);
 488 // }
 489     if (d->files.count() <= index)
 490         return File();
 491
 492     // qDebug() << "ChangeSet::~file";
 493     return d->files[index];
 494 }
 495
 496 ChangeSet &ChangeSet::operator=(const ChangeSet &other)
 497 {
 498 #if QT_VERSION >= 0x040400
 499     other.d->ref.ref();
 500     if (!d->ref.deref())
 501 #else
 502     other.d->ref++;
 503     if (--d->ref == 0)
 504 #endif
 505         delete d;
 506     d = other.d;
 507     return *this;
 508 }
 509
 510 void ChangeSet::waitFinishGenerateHunks() const
 511 {
 512     if (d->hunksFetcher)
 513         d->hunksFetcher->wait();
 514 }
 515
 516 void ChangeSet::waitForFinishFirstFile() const
 517 {
 518     d->cursorAccessLock.lock();
 519     if (! d->finishedOneHunk)
 520         d->cursorAccessWaiter.wait(&d->cursorAccessLock);
 521     d->cursorAccessLock.unlock();
 522 }
 523