forked from qt-creator/qt-creator
Vcs: Add Fossil SCM integration plugin
* Qt Creator base-commit: f77af5e336
* Stand-alone plugin source tree for integration into qtc super-project
* Original release: https://github.com/nomadbyte/qtcreator-plugin-fossil
* Adapted from Bazaar plugin implementation
Configuring Fossil
------------------
1. Download the [Fossil SCM client](http://fossil-scm.org) and install `fossil`
executable file in your `PATH`.
2. Create or designate a directory to store local Fossil repositories and
remote clones. For example: `~/fossils/qt`.
3. Configure Version Control Options for the Fossil plugin to use
the designated directory as `Local Repositories Default path`.
Now Fossil should become available as a VCS choice to create new local
repositories, as well as a choice in `New File or Project` to clone a
remote Fossil repository.
Change-Id: I630184c1b344184d9e08ae2fc24a5e4766f834b9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Artur Shepilko
289
plugins/fossil/fossilcontrol.cpp
Normal file
289
plugins/fossil/fossilcontrol.cpp
Normal file
@@ -0,0 +1,289 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (c) 2016 Artur Shepilko
|
||||
** Contact: https://www.qt.io/licensing/
|
||||
**
|
||||
** This file is part of Qt Creator.
|
||||
**
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and The Qt Company. For licensing terms
|
||||
** and conditions see https://www.qt.io/terms-conditions. For further
|
||||
** information use the contact form at https://www.qt.io/contact-us.
|
||||
**
|
||||
** GNU General Public License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU
|
||||
** General Public License version 3 as published by the Free Software
|
||||
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
||||
** included in the packaging of this file. Please review the following
|
||||
** information to ensure the GNU General Public License requirements will
|
||||
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
#include "constants.h"
|
||||
#include "fossilcontrol.h"
|
||||
#include "fossilclient.h"
|
||||
#include "fossilplugin.h"
|
||||
#include "wizard/fossiljsextension.h"
|
||||
|
||||
#include <vcsbase/vcsbaseclientsettings.h>
|
||||
#include <vcsbase/vcsbaseconstants.h>
|
||||
#include <vcsbase/vcscommand.h>
|
||||
|
||||
#include <QFileInfo>
|
||||
#include <QProcessEnvironment>
|
||||
#include <QVariant>
|
||||
#include <QStringList>
|
||||
#include <QMap>
|
||||
#include <QDir>
|
||||
#include <QUrl>
|
||||
|
||||
using namespace Fossil::Internal;
|
||||
|
||||
FossilControl::FossilControl(FossilClient *client) :
|
||||
m_client(client)
|
||||
{ }
|
||||
|
||||
QString FossilControl::displayName() const
|
||||
{
|
||||
return tr("Fossil");
|
||||
}
|
||||
|
||||
Core::Id FossilControl::id() const
|
||||
{
|
||||
return Core::Id(Constants::VCS_ID_FOSSIL);
|
||||
}
|
||||
|
||||
bool FossilControl::isVcsFileOrDirectory(const Utils::FileName &fileName) const
|
||||
{
|
||||
return m_client->isVcsFileOrDirectory(fileName);
|
||||
}
|
||||
|
||||
bool FossilControl::managesDirectory(const QString &directory, QString *topLevel) const
|
||||
{
|
||||
QFileInfo dir(directory);
|
||||
const QString topLevelFound = m_client->findTopLevelForFile(dir);
|
||||
if (topLevel)
|
||||
*topLevel = topLevelFound;
|
||||
return !topLevelFound.isEmpty();
|
||||
}
|
||||
|
||||
bool FossilControl::managesFile(const QString &workingDirectory, const QString &fileName) const
|
||||
{
|
||||
return m_client->managesFile(workingDirectory, fileName);
|
||||
}
|
||||
|
||||
bool FossilControl::isConfigured() const
|
||||
{
|
||||
const Utils::FileName binary = m_client->vcsBinary();
|
||||
if (binary.isEmpty())
|
||||
return false;
|
||||
|
||||
const QFileInfo fi = binary.toFileInfo();
|
||||
if ( !(fi.exists() && fi.isFile() && fi.isExecutable()) )
|
||||
return false;
|
||||
|
||||
// Local repositories default path must be set and exist
|
||||
const QString repoPath = m_client->settings().stringValue(FossilSettings::defaultRepoPathKey);
|
||||
if (repoPath.isEmpty())
|
||||
return false;
|
||||
|
||||
const QDir dir(repoPath);
|
||||
if (!dir.exists())
|
||||
return false;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool FossilControl::supportsOperation(Operation operation) const
|
||||
{
|
||||
bool supported = isConfigured();
|
||||
|
||||
switch (operation) {
|
||||
case Core::IVersionControl::AddOperation:
|
||||
case Core::IVersionControl::DeleteOperation:
|
||||
case Core::IVersionControl::MoveOperation:
|
||||
case Core::IVersionControl::CreateRepositoryOperation:
|
||||
case Core::IVersionControl::AnnotateOperation:
|
||||
case Core::IVersionControl::InitialCheckoutOperation:
|
||||
break;
|
||||
case Core::IVersionControl::SnapshotOperations:
|
||||
supported = false;
|
||||
break;
|
||||
}
|
||||
return supported;
|
||||
}
|
||||
|
||||
bool FossilControl::vcsOpen(const QString &filename)
|
||||
{
|
||||
Q_UNUSED(filename)
|
||||
return true;
|
||||
}
|
||||
|
||||
bool FossilControl::vcsAdd(const QString &filename)
|
||||
{
|
||||
const QFileInfo fi(filename);
|
||||
return m_client->synchronousAdd(fi.absolutePath(), fi.fileName());
|
||||
}
|
||||
|
||||
bool FossilControl::vcsDelete(const QString &filename)
|
||||
{
|
||||
const QFileInfo fi(filename);
|
||||
return m_client->synchronousRemove(fi.absolutePath(), fi.fileName());
|
||||
}
|
||||
|
||||
bool FossilControl::vcsMove(const QString &from, const QString &to)
|
||||
{
|
||||
const QFileInfo fromInfo(from);
|
||||
const QFileInfo toInfo(to);
|
||||
return m_client->synchronousMove(fromInfo.absolutePath(),
|
||||
fromInfo.absoluteFilePath(),
|
||||
toInfo.absoluteFilePath());
|
||||
}
|
||||
|
||||
bool FossilControl::vcsCreateRepository(const QString &directory)
|
||||
{
|
||||
return m_client->synchronousCreateRepository(directory);
|
||||
}
|
||||
|
||||
bool FossilControl::vcsAnnotate(const QString &file, int line)
|
||||
{
|
||||
const QFileInfo fi(file);
|
||||
m_client->annotate(fi.absolutePath(), fi.fileName(), QString(), line);
|
||||
return true;
|
||||
}
|
||||
|
||||
QString FossilControl::vcsTopic(const QString &directory)
|
||||
{
|
||||
return m_client->synchronousTopic(directory);
|
||||
}
|
||||
|
||||
Core::ShellCommand *FossilControl::createInitialCheckoutCommand(const QString &sourceUrl,
|
||||
const Utils::FileName &baseDirectory,
|
||||
const QString &localName,
|
||||
const QStringList &extraArgs)
|
||||
{
|
||||
QMap<QString, QString> options;
|
||||
FossilJsExtension::parseArgOptions(extraArgs, options);
|
||||
|
||||
// Two operating modes:
|
||||
// 1) CloneCheckout:
|
||||
// -- clone from remote-URL or a local-fossil a repository into a local-clone fossil.
|
||||
// -- open/checkout the local-clone fossil
|
||||
// The local-clone fossil must not point to an existing repository.
|
||||
// Clone URL may be either schema-based (http, ssh, file) or an absolute local path.
|
||||
//
|
||||
// 2) LocalCheckout:
|
||||
// -- open/checkout an existing local fossil
|
||||
// Clone URL is an absolute local path and is the same as the local fossil.
|
||||
|
||||
const QString checkoutPath = Utils::FileName(baseDirectory).appendPath(localName).toString();
|
||||
const QString fossilFile = options.value("fossil-file");
|
||||
const Utils::FileName fossilFileName = Utils::FileName::fromUserInput(QDir::fromNativeSeparators(fossilFile));
|
||||
const QString fossilFileNative = fossilFileName.toUserOutput();
|
||||
const QFileInfo cloneRepository(fossilFileName.toString());
|
||||
|
||||
// Check when requested to clone a local repository and clone-into repository file is the same
|
||||
// or not specified.
|
||||
// In this case handle it as local fossil checkout request.
|
||||
const QUrl url(sourceUrl);
|
||||
bool isLocalRepository = (options.value("repository-type") == "localRepo");
|
||||
|
||||
if (url.isLocalFile() || url.isRelative()) {
|
||||
const QFileInfo sourcePath(url.path());
|
||||
isLocalRepository = (sourcePath.canonicalFilePath() == cloneRepository.canonicalFilePath());
|
||||
}
|
||||
|
||||
// set clone repository admin user to configured user name
|
||||
// OR override it with the specified user from clone panel
|
||||
const QString adminUser = options.value("admin-user");
|
||||
const bool disableAutosync = (options.value("settings-autosync") == "off");
|
||||
const QString checkoutBranch = options.value("branch-tag");
|
||||
|
||||
// first create the checkout directory,
|
||||
// as it needs to become a working directory for wizard command jobs
|
||||
|
||||
const QDir checkoutDir(checkoutPath);
|
||||
checkoutDir.mkpath(checkoutPath);
|
||||
|
||||
// Setup the wizard page command job
|
||||
auto command = new VcsBase::VcsCommand(checkoutDir.path(), m_client->processEnvironment());
|
||||
|
||||
if (!isLocalRepository
|
||||
&& !cloneRepository.exists()) {
|
||||
|
||||
const QString sslIdentityFile = options.value("ssl-identity");
|
||||
const Utils::FileName sslIdentityFileName = Utils::FileName::fromUserInput(QDir::fromNativeSeparators(sslIdentityFile));
|
||||
const bool includePrivate = (options.value("include-private") == "true");
|
||||
|
||||
QStringList extraOptions;
|
||||
if (includePrivate)
|
||||
extraOptions << "--private";
|
||||
if (!sslIdentityFile.isEmpty())
|
||||
extraOptions << "--ssl-identity" << sslIdentityFileName.toUserOutput();
|
||||
if (!adminUser.isEmpty())
|
||||
extraOptions << "--admin-user" << adminUser;
|
||||
|
||||
// Fossil allows saving the remote address and login. This is used to
|
||||
// facilitate autosync (commit/update) functionality.
|
||||
// When no password is given, it prompts for that.
|
||||
// When both username and password are specified, it prompts whether to
|
||||
// save them.
|
||||
// NOTE: In non-interactive context, these prompts won't work.
|
||||
// Fossil currently does not support SSH_ASKPASS way for login query.
|
||||
//
|
||||
// Alternatively, "--once" option does not save the remote details.
|
||||
// In such case remote details must be provided on the command-line every
|
||||
// time. This also precludes autosync.
|
||||
//
|
||||
// So here we want Fossil to save the remote details when specified.
|
||||
|
||||
QStringList args;
|
||||
args << m_client->vcsCommandString(FossilClient::CloneCommand)
|
||||
<< extraOptions
|
||||
<< sourceUrl
|
||||
<< fossilFileNative;
|
||||
command->addJob(m_client->vcsBinary(), args, -1);
|
||||
}
|
||||
|
||||
// check out the cloned repository file into the working copy directory;
|
||||
// by default the latest revision is checked out
|
||||
|
||||
QStringList args({"open", fossilFileNative});
|
||||
if (!checkoutBranch.isEmpty())
|
||||
args << checkoutBranch;
|
||||
command->addJob(m_client->vcsBinary(), args, -1);
|
||||
|
||||
// set user default to admin user if specified
|
||||
if (!isLocalRepository
|
||||
&& !adminUser.isEmpty()) {
|
||||
const QStringList args({ "user", "default", adminUser, "--user", adminUser});
|
||||
command->addJob(m_client->vcsBinary(), args, -1);
|
||||
}
|
||||
|
||||
// turn-off autosync if requested
|
||||
if (!isLocalRepository
|
||||
&& disableAutosync) {
|
||||
const QStringList args({"settings", "autosync", "off"});
|
||||
command->addJob(m_client->vcsBinary(), args, -1);
|
||||
}
|
||||
|
||||
return command;
|
||||
}
|
||||
|
||||
void FossilControl::changed(const QVariant &v)
|
||||
{
|
||||
switch (v.type()) {
|
||||
case QVariant::String:
|
||||
emit repositoryChanged(v.toString());
|
||||
break;
|
||||
case QVariant::StringList:
|
||||
emit filesChanged(v.toStringList());
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user