File indexing completed on 2024-05-05 04:39:01

 /*
     SPDX-FileCopyrightText: 2013-2014 Maciej Poleski
 
     SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */
 
 #include "bazaarplugin.h"
 
 #include <QDir>
 #include <QMenu>
 #include <QStandardPaths>
 
 #include <KLocalizedString>
 
 #include <vcs/widgets/standardvcslocationwidget.h>
 #include <vcs/dvcs/dvcsjob.h>
 #include <vcs/vcsstatusinfo.h>
 #include <vcs/vcslocation.h>
 #include <vcs/dvcs/ui/dvcsimportmetadatawidget.h>
 #include <interfaces/contextmenuextension.h>
 #include <interfaces/context.h>
 
 #include "bazaarutils.h"
 #include "bzrannotatejob.h"
 #include "copyjob.h"
 #include "diffjob.h"
 
 using namespace KDevelop;
 
 BazaarPlugin::BazaarPlugin(QObject* parent, const QVariantList& args) :
     IPlugin(QStringLiteral("kdevbazaar"), parent),
     m_vcsPluginHelper(new KDevelop::VcsPluginHelper(this, this))
 {
     Q_UNUSED(args); // What is this?
     if (QStandardPaths::findExecutable(QStringLiteral("bzr")).isEmpty()) {
         setErrorDescription(i18n("Unable to find Bazaar (bzr) executable. Is it installed on the system?"));
         return;
     }
 
     setObjectName(QStringLiteral("Bazaar"));
 }
 
 BazaarPlugin::~BazaarPlugin()
 {
 }
 
 QString BazaarPlugin::name() const
 {
     return QStringLiteral("Bazaar");
 }
 
 bool BazaarPlugin::isValidRemoteRepositoryUrl(const QUrl& remoteLocation)
 {
     const QString scheme = remoteLocation.scheme();
     if (scheme == QLatin1String("bzr") ||
         scheme == QLatin1String("bzr+ssh") ||
         scheme == QLatin1String("lp")) {
         return true;
     }
     return false;
 }
 
 VcsJob* BazaarPlugin::add(const QList<QUrl>& localLocations, IBasicVersionControl::RecursionMode recursion)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocations[0]), this);
     job->setType(VcsJob::Add);
     *job << "bzr" << "add";
     if(recursion == NonRecursive)
         *job << "--no-recurse";
     *job << localLocations;
     return job;
 }
 
 VcsJob* BazaarPlugin::annotate(const QUrl& localLocation, const VcsRevision& rev)
 {
     VcsJob* job = new BzrAnnotateJob(BazaarUtils::workingCopy(localLocation), BazaarUtils::getRevisionSpec(rev), localLocation, this, KDevelop::OutputJob::Silent);
     return job;
 }
 
 VcsJob* BazaarPlugin::commit(const QString& message, const QList<QUrl>& localLocations, IBasicVersionControl::RecursionMode recursion)
 {
     QDir dir = BazaarUtils::workingCopy(localLocations[0]);
     auto* job = new DVcsJob(dir, this);
     job->setType(VcsJob::Commit);
 
     *job << "bzr" << "commit" << BazaarUtils::handleRecursion(localLocations, recursion) << "-m" << message;
     return job;
 }
 
 VcsJob* BazaarPlugin::copy(const QUrl& localLocationSrc, const QUrl& localLocationDstn)
 {
     return new CopyJob(localLocationSrc, localLocationDstn, this);
 }
 
 VcsImportMetadataWidget* BazaarPlugin::createImportMetadataWidget(QWidget* parent)
 {
     return new DvcsImportMetadataWidget(parent);
 }
 
 VcsJob* BazaarPlugin::createWorkingCopy(const VcsLocation& sourceRepository, const QUrl& destinationDirectory, IBasicVersionControl::RecursionMode recursion)
 {
     Q_UNUSED(recursion);
     // What is the purpose of recursion parameter?
     auto* job = new DVcsJob(BazaarUtils::toQDir(sourceRepository.localUrl()), this);
     job->setType(VcsJob::Import);
     *job << "bzr" << "branch" << sourceRepository.localUrl().url() << destinationDirectory;
     return job;
 }
 
 VcsJob* BazaarPlugin::diff(const QUrl& fileOrDirectory, const VcsRevision& srcRevision, const VcsRevision& dstRevision, IBasicVersionControl::RecursionMode recursion)
 {
     Q_UNUSED(recursion);
     VcsJob* job = new DiffJob(BazaarUtils::workingCopy(fileOrDirectory), BazaarUtils::getRevisionSpecRange(srcRevision, dstRevision), fileOrDirectory, this);
     return job;
 }
 
 VcsJob* BazaarPlugin::init(const QUrl& localRepositoryRoot)
 {
     auto* job = new DVcsJob(BazaarUtils::toQDir(localRepositoryRoot), this);
     job->setType(VcsJob::Import);
     *job << "bzr" << "init";
     return job;
 }
 
 bool BazaarPlugin::isVersionControlled(const QUrl& localLocation)
 {
     QDir workCopy = BazaarUtils::workingCopy(localLocation);
     auto* job = new DVcsJob(workCopy, this, OutputJob::Silent);
     job->setType(VcsJob::Unknown);
     job->setIgnoreError(true);
     *job << "bzr" << "ls" << "--from-root" << "-R" << "-V";
     job->exec();
     if (job->status() == VcsJob::JobSucceeded) {
         QList<QFileInfo> filesAndDirectoriesList;
         const auto output = job->output().split(QLatin1Char('\n'));
         filesAndDirectoriesList.reserve(output.size());
         const QChar dirSeparator = QDir::separator();
         for (const auto& fod : output) {
             filesAndDirectoriesList.append(QFileInfo(workCopy.absolutePath() + dirSeparator + fod));
         }
         QFileInfo fi(localLocation.toLocalFile());
         if (fi.isDir() || fi.isFile()) {
             QFileInfo file(localLocation.toLocalFile());
             return filesAndDirectoriesList.contains(file);
         }
     }
     return false;
 }
 
 VcsJob* BazaarPlugin::log(const QUrl& localLocation, const VcsRevision& rev, long unsigned int limit)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocation), this);
     job->setType(VcsJob::Log);
     *job << "bzr" << "log" << "--long" << "-v" << localLocation << BazaarUtils::getRevisionSpecRange(rev) << "-l" << QString::number(limit);
     connect(job, &DVcsJob::readyForParsing, this, &BazaarPlugin::parseBzrLog);
     return job;
 }
 
 VcsJob* BazaarPlugin::log(const QUrl& localLocation, const VcsRevision& rev, const VcsRevision& limit)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocation), this);
     job->setType(VcsJob::Log);
     *job << "bzr" << "log" << "--long" << "-v" << localLocation << BazaarUtils::getRevisionSpecRange(limit, rev);
     connect(job, &DVcsJob::readyForParsing, this, &BazaarPlugin::parseBzrLog);
     return job;
 }
 
 void BazaarPlugin::parseBzrLog(DVcsJob* job)
 {
     QVariantList result;
     const auto parts = job->output().split(
         QStringLiteral("------------------------------------------------------------"), Qt::SkipEmptyParts);
     for (const QString& part : parts) {
         auto event = BazaarUtils::parseBzrLogPart(part);
         if (event.revision().revisionType() != VcsRevision::Invalid)
             result.append(QVariant::fromValue(event));
     }
     job->setResults(result);
 }
 
 VcsJob* BazaarPlugin::move(const QUrl& localLocationSrc, const QUrl& localLocationDst)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocationSrc), this);
     job->setType(VcsJob::JobType::Move);
     *job << "bzr" << "move" << localLocationSrc << localLocationDst;
     return job;
 }
 
 VcsJob* BazaarPlugin::pull(const VcsLocation& localOrRepoLocationSrc, const QUrl& localRepositoryLocation)
 {
     // API describes hg pull which is git fetch equivalent
     // bzr has pull, but it succeeds only if fast-forward is possible
     // in other cases bzr merge should be used instead (bzr pull would fail)
     // Information about repository must be provided at least once.
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localRepositoryLocation), this);
     job->setType(VcsJob::JobType::Pull);
     *job << "bzr" << "pull";
     if (!localOrRepoLocationSrc.localUrl().isEmpty()) {
         *job << localOrRepoLocationSrc.localUrl();
     }
     // localUrl always makes sense. Even on remote repositories which are handled
     // transparently.
     return job;
 }
 
 VcsJob* BazaarPlugin::push(const QUrl& localRepositoryLocation, const VcsLocation& localOrRepoLocationDst)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localRepositoryLocation), this);
     job->setType(VcsJob::JobType::Push);
     *job << "bzr" << "push" << localOrRepoLocationDst.localUrl();
     // localUrl always makes sense. Even on remote repositories which are handled
     // transparently.
     return job;
 }
 
 VcsJob* BazaarPlugin::remove(const QList<QUrl>& localLocations)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocations[0]), this);
     job->setType(VcsJob::JobType::Remove);
     *job << "bzr" << "remove" << localLocations;
     return job;
 }
 
 VcsJob* BazaarPlugin::repositoryLocation(const QUrl& localLocation)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocation), this);
     job->setType(VcsJob::JobType::Unknown);
     *job << "bzr" << "root" << localLocation;   // It is only to make sure
     connect(job, &DVcsJob::readyForParsing, this, &BazaarPlugin::parseBzrRoot);
     return job;
 }
 
 void BazaarPlugin::parseBzrRoot(DVcsJob* job)
 {
     QString filename = job->dvcsCommand().at(2);
     QString rootDirectory = job->output();
     QString localFilename = QFileInfo(QUrl::fromLocalFile(filename).toLocalFile()).absoluteFilePath();
     QString result = localFilename.mid(localFilename.indexOf(rootDirectory) + rootDirectory.length());
     job->setResults(QVariant::fromValue(result));
 }
 
 VcsJob* BazaarPlugin::resolve(const QList<QUrl>& localLocations, IBasicVersionControl::RecursionMode recursion)
 {
     return add(localLocations, recursion);
     // How to provide "a conflict solving dialog to the user"?
     // In any case this plugin is unable to make any conflict.
 }
 
 VcsJob* BazaarPlugin::revert(const QList<QUrl>& localLocations, IBasicVersionControl::RecursionMode recursion)
 {
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocations[0]), this);
     job->setType(VcsJob::JobType::Revert);
     *job << "bzr" << "revert" << BazaarUtils::handleRecursion(localLocations, recursion);
     return job;
 }
 
 VcsJob* BazaarPlugin::status(const QList<QUrl>& localLocations, IBasicVersionControl::RecursionMode recursion)
 {
     Q_UNUSED(recursion);
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocations[0]), this);
     job->setType(VcsJob::Status);
     *job << "bzr" << "status" << "--short" << "--no-pending" << "--no-classify" << localLocations;
     connect(job, &DVcsJob::readyForParsing, this, &BazaarPlugin::parseBzrStatus);
     return job;
 }
 
 void BazaarPlugin::parseBzrStatus(DVcsJob* job)
 {
     QVariantList result;
     QSet<QString> filesWithStatus;
     QDir workingCopy = job->directory();
     const auto output = job->output().split(QLatin1Char('\n'));
     result.reserve(output.size());
     for (const auto& line : output) {
         auto status = BazaarUtils::parseVcsStatusInfoLine(line);
         result.append(QVariant::fromValue(status));
         filesWithStatus.insert(BazaarUtils::concatenatePath(workingCopy, status.url()));
     }
 
     QStringList command = job->dvcsCommand();
     for (auto it = command.constBegin() + command.indexOf(QStringLiteral("--no-classify")) + 1, itEnd = command.constEnd(); it != itEnd; ++it) {
         QString path = QFileInfo(*it).absoluteFilePath();
         if (!filesWithStatus.contains(path)) {
             filesWithStatus.insert(path);
             KDevelop::VcsStatusInfo status;
             status.setState(VcsStatusInfo::ItemUpToDate);
             status.setUrl(QUrl::fromLocalFile(*it));
             result.append(QVariant::fromValue(status));
         }
     }
 
     job->setResults(result);
 }
 
 VcsJob* BazaarPlugin::update(const QList<QUrl>& localLocations, const VcsRevision& rev, IBasicVersionControl::RecursionMode recursion)
 {
     // bzr update is stronger than API (it's effectively merge)
     // the best approximation is bzr pull
     auto* job = new DVcsJob(BazaarUtils::workingCopy(localLocations[0]), this);
     Q_UNUSED(recursion);
     // recursion and file locations are ignored - we can update only whole
     // working copy
     job->setType(VcsJob::JobType::Update);
     *job << "bzr" << "pull" << BazaarUtils::getRevisionSpec(rev);
     return job;
 }
 
 VcsLocationWidget* BazaarPlugin::vcsLocation(QWidget* parent) const
 {
     return new KDevelop::StandardVcsLocationWidget(parent);
 }
 
 ContextMenuExtension BazaarPlugin::contextMenuExtension(Context* context, QWidget* parent)
 {
     m_vcsPluginHelper->setupFromContext(context);
     QList<QUrl> const& ctxUrlList = m_vcsPluginHelper->contextUrlList();
 
     bool isWorkingDirectory = false;
     for (const QUrl & url : ctxUrlList) {
         if (BazaarUtils::isValidDirectory(url)) {
             isWorkingDirectory = true;
             break;
         }
     }
 
     if (!isWorkingDirectory) { // Not part of a repository
         return ContextMenuExtension();
     }
 
     QMenu* menu = m_vcsPluginHelper->commonActions(parent);
 
     ContextMenuExtension menuExt;
     menuExt.addAction(ContextMenuExtension::VcsGroup, menu->menuAction());
 
     return menuExt;
 }
 
 #include "moc_bazaarplugin.cpp"