1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
|
/*
SPDX-FileCopyrightText: 2010 Aleix Pol Gonzalez <aleixpol@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "projectsourcepage.h"
#include "ui_projectsourcepage.h"
#include <interfaces/iplugin.h>
#include <interfaces/icore.h>
#include <interfaces/iplugincontroller.h>
#include <interfaces/iruncontroller.h>
#include <vcs/interfaces/ibasicversioncontrol.h>
#include <vcs/widgets/vcslocationwidget.h>
#include <vcs/vcsjob.h>
#include <vcs/vcslocation.h>
#include <QVBoxLayout>
#include <kcoreaddons_version.h>
#include <KSharedConfig>
#include <KConfigGroup>
#include <KLocalizedString>
#include <KMessageBox>
#include <interfaces/iprojectprovider.h>
using namespace KDevelop;
static const int FROM_FILESYSTEM_SOURCE_INDEX = 0;
ProjectSourcePage::ProjectSourcePage(const QUrl& initial, const QUrl& repoUrl, IPlugin* preSelectPlugin,
QWidget* parent)
: QWidget(parent)
{
m_ui = new Ui::ProjectSourcePage;
m_ui->setupUi(this);
m_ui->status->setCloseButtonVisible(false);
m_ui->status->setMessageType(KMessageWidget::Error);
m_ui->workingDir->setUrl(initial);
m_ui->workingDir->setMode(KFile::Directory);
m_ui->sources->addItem(QIcon::fromTheme(QStringLiteral("folder")), i18nc("@item:inlistbox", "From File System"));
m_plugins.append(nullptr);
int preselectIndex = -1;
IPluginController* pluginManager = ICore::self()->pluginController();
const QList<IPlugin*> vcsPlugins = pluginManager->allPluginsForExtension( QStringLiteral("org.kdevelop.IBasicVersionControl") );
m_plugins.reserve(m_plugins.size() + vcsPlugins.size());
for (IPlugin* p : vcsPlugins) {
if (p == preSelectPlugin) {
preselectIndex = m_plugins.count();
}
m_plugins.append(p);
m_ui->sources->addItem(QIcon::fromTheme(pluginManager->pluginInfo(p).iconName()), p->extension<IBasicVersionControl>()->name());
}
const QList<IPlugin*> projectPlugins = pluginManager->allPluginsForExtension( QStringLiteral("org.kdevelop.IProjectProvider") );
m_plugins.reserve(m_plugins.size() + projectPlugins.size());
for (IPlugin* p : projectPlugins) {
if (p == preSelectPlugin) {
preselectIndex = m_plugins.count();
}
m_plugins.append(p);
m_ui->sources->addItem(QIcon::fromTheme(pluginManager->pluginInfo(p).iconName()), p->extension<IProjectProvider>()->name());
}
if (preselectIndex == -1) {
// "From File System" is quite unlikely to be what the user wants, so default to first real plugin...
const int defaultIndex = (m_plugins.count() > 1) ? 1 : 0;
KConfigGroup configGroup = KSharedConfig::openConfig()->group("Providers");
preselectIndex = configGroup.readEntry("LastProviderIndex", defaultIndex);
}
preselectIndex = qBound(0, preselectIndex, m_ui->sources->count() - 1);
m_ui->sources->setCurrentIndex(preselectIndex);
setSourceWidget(preselectIndex, repoUrl);
// connect as last step, otherwise KMessageWidget could get both animatedHide() and animatedShow()
// during setup and due to a bug will ignore any but the first call
// Only fixed for KF5 5.32
connect(m_ui->workingDir, &KUrlRequester::textChanged, this, &ProjectSourcePage::reevaluateCorrection);
connect(m_ui->sources, QOverload<int>::of(&QComboBox::currentIndexChanged),
this, &ProjectSourcePage::setSourceIndex);
connect(m_ui->get, &QPushButton::clicked, this, &ProjectSourcePage::checkoutVcsProject);
}
ProjectSourcePage::~ProjectSourcePage()
{
KConfigGroup configGroup = KSharedConfig::openConfig()->group("Providers");
configGroup.writeEntry("LastProviderIndex", m_ui->sources->currentIndex());
delete m_ui;
}
void ProjectSourcePage::setSourceIndex(int index)
{
setSourceWidget(index, QUrl());
}
void ProjectSourcePage::setSourceWidget(int index, const QUrl& repoUrl)
{
m_locationWidget = nullptr;
m_providerWidget = nullptr;
QLayoutItem *child;
while ((child = m_ui->remoteWidgetLayout->takeAt(0)) != nullptr) {
delete child->widget();
delete child;
}
IBasicVersionControl* vcIface = vcsPerIndex(index);
IProjectProvider* providerIface;
bool found=false;
if(vcIface) {
found=true;
m_locationWidget=vcIface->vcsLocation(m_ui->sourceBox);
connect(m_locationWidget, &VcsLocationWidget::changed, this, &ProjectSourcePage::locationChanged);
// set after connect, to trigger handler
if (!repoUrl.isEmpty()) {
m_locationWidget->setLocation(repoUrl);
}
m_ui->remoteWidgetLayout->addWidget(m_locationWidget);
} else {
providerIface = providerPerIndex(index);
if(providerIface) {
found=true;
m_providerWidget=providerIface->providerWidget(m_ui->sourceBox);
connect(m_providerWidget, &IProjectProviderWidget::changed, this, &ProjectSourcePage::projectChanged);
m_ui->remoteWidgetLayout->addWidget(m_providerWidget);
}
}
reevaluateCorrection();
m_ui->sourceBox->setVisible(found);
}
IBasicVersionControl* ProjectSourcePage::vcsPerIndex(int index)
{
IPlugin* p = m_plugins.value(index);
if(!p)
return nullptr;
else
return p->extension<KDevelop::IBasicVersionControl>();
}
IProjectProvider* ProjectSourcePage::providerPerIndex(int index)
{
IPlugin* p = m_plugins.value(index);
if(!p)
return nullptr;
else
return p->extension<KDevelop::IProjectProvider>();
}
VcsJob* ProjectSourcePage::jobPerCurrent()
{
QUrl url=m_ui->workingDir->url();
IPlugin* p=m_plugins[m_ui->sources->currentIndex()];
VcsJob* job=nullptr;
if(auto* iface=p->extension<IBasicVersionControl>()) {
Q_ASSERT(iface && m_locationWidget);
job=iface->createWorkingCopy(m_locationWidget->location(), url);
} else if(m_providerWidget) {
job=m_providerWidget->createWorkingCopy(url);
}
return job;
}
void ProjectSourcePage::checkoutVcsProject()
{
QUrl url=m_ui->workingDir->url();
QDir d(url.toLocalFile());
if(!url.isLocalFile() && !d.exists()) {
bool corr = d.mkpath(d.path());
if(!corr) {
KMessageBox::error(nullptr, i18n("Could not create the directory: %1", d.path()));
return;
}
}
VcsJob* job=jobPerCurrent();
if (!job) {
return;
}
m_ui->sources->setEnabled(false);
m_ui->sourceBox->setEnabled(false);
m_ui->workingDir->setEnabled(false);
m_ui->get->setEnabled(false);
m_ui->creationProgress->setValue(m_ui->creationProgress->minimum());
connect(job, &VcsJob::result, this, &ProjectSourcePage::projectReceived);
#if KCOREADDONS_VERSION < QT_VERSION_CHECK(5, 80, 0)
connect(job, QOverload<KJob*, unsigned long>::of(&KJob::percent), this, &ProjectSourcePage::progressChanged);
#else
connect(job, &KJob::percentChanged, this, &ProjectSourcePage::progressChanged);
#endif
connect(job, &VcsJob::infoMessage, this, &ProjectSourcePage::infoMessage);
ICore::self()->runController()->registerJob(job);
}
void ProjectSourcePage::progressChanged(KJob*, unsigned long value)
{
m_ui->creationProgress->setValue(value);
}
void ProjectSourcePage::infoMessage(KJob* , const QString& text, const QString& /*rich*/)
{
m_ui->creationProgress->setFormat(i18nc("Format of the progress bar text. progress and info",
"%1 : %p%", text));
}
void ProjectSourcePage::projectReceived(KJob* job)
{
if (job->error()) {
m_ui->creationProgress->setValue(0);
} else {
m_ui->creationProgress->setValue(m_ui->creationProgress->maximum());
}
reevaluateCorrection();
m_ui->creationProgress->setFormat(QStringLiteral("%p%"));
}
void ProjectSourcePage::reevaluateCorrection()
{
//TODO: Probably we should just ignore remote URL's, I don't think we're ever going
//to support checking out to remote directories
const QUrl cwd = m_ui->workingDir->url();
const QDir dir = cwd.toLocalFile();
// case where we import a project from local file system
if (m_ui->sources->currentIndex() == FROM_FILESYSTEM_SOURCE_INDEX) {
emit isCorrect(dir.exists());
return;
}
// all other cases where remote locations need to be specified
bool correct=!cwd.isRelative() && (!cwd.isLocalFile() || QDir(cwd.adjusted(QUrl::RemoveFilename).toLocalFile()).exists());
emit isCorrect(correct && m_ui->creationProgress->value() == m_ui->creationProgress->maximum());
const bool validWidget = ((m_locationWidget && m_locationWidget->isCorrect()) ||
(m_providerWidget && m_providerWidget->isCorrect()));
const bool isFolderEmpty = (correct && cwd.isLocalFile() && dir.exists() && dir.entryList(QDir::AllEntries | QDir::NoDotAndDotDot).isEmpty());
const bool validToCheckout = correct && validWidget && (!dir.exists() || isFolderEmpty);
m_ui->get->setEnabled(validToCheckout);
m_ui->creationProgress->setEnabled(validToCheckout);
if(!correct)
setStatus(i18n("You need to specify a valid or nonexistent directory to check out a project"));
else if(!m_ui->get->isEnabled() && m_ui->workingDir->isEnabled() && !validWidget)
setStatus(i18n("You need to specify the source for your remote project"));
else if(!m_ui->get->isEnabled() && m_ui->workingDir->isEnabled() && !isFolderEmpty)
setStatus(i18n("You need to specify an empty folder as your project destination"));
else
clearStatus();
}
void ProjectSourcePage::locationChanged()
{
Q_ASSERT(m_locationWidget);
if(m_locationWidget->isCorrect()) {
QString currentUrl = m_ui->workingDir->text();
currentUrl.truncate(currentUrl.lastIndexOf(QLatin1Char('/'))+1);
QUrl current = QUrl::fromUserInput(currentUrl + m_locationWidget->projectName());
m_ui->workingDir->setUrl(current);
}
else
reevaluateCorrection();
}
void ProjectSourcePage::projectChanged(const QString& name)
{
Q_ASSERT(m_providerWidget);
QString currentUrl = m_ui->workingDir->text();
currentUrl.truncate(currentUrl.lastIndexOf(QLatin1Char('/'))+1);
QUrl current = QUrl::fromUserInput(currentUrl + name);
m_ui->workingDir->setUrl(current);
}
void ProjectSourcePage::setStatus(const QString& message)
{
m_ui->status->setText(message);
m_ui->status->animatedShow();
}
void ProjectSourcePage::clearStatus()
{
m_ui->status->animatedHide();
}
QUrl ProjectSourcePage::workingDir() const
{
return m_ui->workingDir->url();
}
|