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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
/*
SPDX-FileCopyrightText: 2008 Andreas Pakulat <apaku@gmx.de>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "openprojectdialog.h"
#include "openprojectpage.h"
#include "projectinfopage.h"
#include <QPushButton>
#include <QFileInfo>
#include <QFileDialog>
#include <KColorScheme>
#include <KIO/StatJob>
#include <KIO/ListJob>
#include <KJobWidgets>
#include <KLocalizedString>
#include "core.h"
#include "uicontroller.h"
#include "plugincontroller.h"
#include "mainwindow.h"
#include "shellextension.h"
#include "projectsourcepage.h"
#include <debug.h>
#include <interfaces/iprojectcontroller.h>
namespace
{
struct URLInfo
{
bool isValid;
bool isDir;
QString extension;
};
URLInfo urlInfo(const QUrl& url)
{
URLInfo ret;
ret.isValid = false;
if (url.isLocalFile()) {
QFileInfo info(url.toLocalFile());
ret.isValid = info.exists();
if (ret.isValid) {
ret.isDir = info.isDir();
ret.extension = info.suffix();
}
} else if (url.isValid()) {
KIO::StatJob* statJob = KIO::stat(url, KIO::HideProgressInfo);
KJobWidgets::setWindow(statJob, KDevelop::Core::self()->uiControllerInternal()->defaultMainWindow());
ret.isValid = statJob->exec(); // TODO: do this asynchronously so that the user isn't blocked while typing every letter of the hostname in sftp://hostname
if (ret.isValid) {
KIO::UDSEntry entry = statJob->statResult();
ret.isDir = entry.isDir();
ret.extension = QFileInfo(entry.stringValue(KIO::UDSEntry::UDS_NAME)).suffix();
}
}
return ret;
}
}
namespace KDevelop
{
OpenProjectDialog::OpenProjectDialog(bool fetch, const QUrl& startUrl,
const QUrl& repoUrl, IPlugin* vcsOrProviderPlugin,
QWidget* parent)
: KAssistantDialog( parent )
, m_urlIsDirectory(false)
, sourcePage(nullptr)
, openPage(nullptr)
, projectInfoPage(nullptr)
{
resize(QSize(700, 500));
// KAssistantDialog creates a help button by default, no option to prevent that
auto helpButton = button(QDialogButtonBox::Help);
if (helpButton) {
buttonBox()->removeButton(helpButton);
delete helpButton;
}
const bool useKdeFileDialog = qEnvironmentVariableIsSet("KDE_FULL_SESSION");
QStringList filters, allEntry;
QString filterFormat = useKdeFileDialog
? QStringLiteral("%1|%2 (%1)")
: QStringLiteral("%2 (%1)");
allEntry << QLatin1String("*.") + ShellExtension::getInstance()->projectFileExtension();
filters << filterFormat.arg(QLatin1String("*.") + ShellExtension::getInstance()->projectFileExtension(), ShellExtension::getInstance()->projectFileDescription());
const QVector<KPluginMetaData> plugins = ICore::self()->pluginController()->queryExtensionPlugins(QStringLiteral("org.kdevelop.IProjectFileManager"));
for (const KPluginMetaData& info : plugins) {
m_projectPlugins.insert(info.name(), info);
QStringList filter = KPluginMetaData::readStringList(info.rawData(), QStringLiteral("X-KDevelop-ProjectFilesFilter"));
// some project file manager plugins like KDevGenericManager have no file filter set
if (filter.isEmpty()) {
m_genericProjectPlugins << info.name();
continue;
}
QString desc = info.value(QStringLiteral("X-KDevelop-ProjectFilesFilterDescription"));
m_projectFilters.insert(info.name(), filter);
allEntry += filter;
filters << filterFormat.arg(filter.join(QLatin1Char(' ')), desc);
}
if (useKdeFileDialog)
filters.prepend(i18n("%1|All Project Files (%1)", allEntry.join(QLatin1Char(' '))));
QUrl start = startUrl.isValid() ? startUrl : Core::self()->projectController()->projectsBaseDirectory();
start = start.adjusted(QUrl::NormalizePathSegments);
KPageWidgetItem* currentPage = nullptr;
if( fetch ) {
sourcePageWidget = new ProjectSourcePage(start, repoUrl, vcsOrProviderPlugin, this);
connect( sourcePageWidget, &ProjectSourcePage::isCorrect, this, &OpenProjectDialog::validateSourcePage );
sourcePage = addPage( sourcePageWidget, i18nc("@title:tab", "Select Source") );
currentPage = sourcePage;
}
if (useKdeFileDialog) {
openPageWidget = new OpenProjectPage( start, filters, this );
connect( openPageWidget, &OpenProjectPage::urlSelected, this, &OpenProjectDialog::validateOpenUrl );
connect( openPageWidget, &OpenProjectPage::accepted, this, &OpenProjectDialog::openPageAccepted );
openPage = addPage( openPageWidget, i18n("Select a build system setup file, existing KDevelop project, "
"or any folder to open as a project") );
if (!currentPage) {
currentPage = openPage;
}
} else {
nativeDialog = new QFileDialog(this, i18nc("@title:window", "Open Project"));
nativeDialog->setDirectoryUrl(start);
nativeDialog->setFileMode(QFileDialog::Directory);
}
auto* page = new ProjectInfoPage( this );
connect( page, &ProjectInfoPage::projectNameChanged, this, &OpenProjectDialog::validateProjectName );
connect( page, &ProjectInfoPage::projectManagerChanged, this, &OpenProjectDialog::validateProjectManager );
projectInfoPage = addPage( page, i18nc("@title:tab", "Project Information") );
if (!currentPage) {
currentPage = projectInfoPage;
}
setValid( sourcePage, false );
setValid( openPage, false );
setValid( projectInfoPage, false);
setAppropriate( projectInfoPage, false );
setCurrentPage( currentPage );
setWindowTitle(i18nc("@title:window", "Open Project"));
}
bool OpenProjectDialog::execNativeDialog()
{
while (true)
{
if (nativeDialog->exec()) {
QUrl selectedUrl = nativeDialog->selectedUrls().at(0);
if (urlInfo(selectedUrl).isValid) {
// validate directory first to populate m_projectName and m_projectManager
validateOpenUrl(selectedUrl.adjusted(QUrl::RemoveFilename));
validateOpenUrl(selectedUrl);
return true;
}
}
else {
return false;
}
}
}
int OpenProjectDialog::exec()
{
if (nativeDialog && !execNativeDialog()) {
reject();
return QDialog::Rejected;
}
return KAssistantDialog::exec();
}
void OpenProjectDialog::validateSourcePage(bool valid)
{
setValid(sourcePage, valid);
if (!nativeDialog) {
openPageWidget->setUrl(sourcePageWidget->workingDir());
}
}
void OpenProjectDialog::validateOpenUrl( const QUrl& url_ )
{
URLInfo urlInfo = ::urlInfo(url_);
const QUrl url = url_.adjusted(QUrl::StripTrailingSlash);
// openPage is used only in KDE
if (openPage) {
if ( urlInfo.isValid ) {
// reset header
openPage->setHeader(i18n("Open \"%1\" as project", url.fileName()));
} else {
// report error
KColorScheme scheme(palette().currentColorGroup());
const QString errorMsg = i18n("Selected URL is invalid");
openPage->setHeader(QStringLiteral("<font color='%1'>%2</font>")
.arg(scheme.foreground(KColorScheme::NegativeText).color().name(), errorMsg)
);
setAppropriate( projectInfoPage, false );
setAppropriate( openPage, true );
setValid( openPage, false );
return;
}
}
m_selected = url;
if( urlInfo.isDir || urlInfo.extension != ShellExtension::getInstance()->projectFileExtension() )
{
m_urlIsDirectory = urlInfo.isDir;
setAppropriate( projectInfoPage, true );
m_url = url;
if( !urlInfo.isDir ) {
m_url = m_url.adjusted(QUrl::StripTrailingSlash | QUrl::RemoveFilename);
}
auto* page = qobject_cast<ProjectInfoPage*>( projectInfoPage->widget() );
if( page )
{
page->setProjectName( m_url.fileName() );
// clear the filelist
m_fileList.clear();
if( urlInfo.isDir ) {
// If a dir was selected fetch all files in it
KIO::ListJob* job = KIO::listDir( m_url );
connect( job, &KIO::ListJob::entries,
this, &OpenProjectDialog::storeFileList);
KJobWidgets::setWindow(job, Core::self()->uiController()->activeMainWindow());
job->exec();
} else {
// Else we'll just take the given file
m_fileList << url.fileName();
}
// Now find a manager for the file(s) in our filelist.
QVector<ProjectFileChoice> choices;
for (const auto& file : qAsConst(m_fileList)) {
auto plugins = projectManagerForFile(file);
if ( plugins.contains(QStringLiteral("<built-in>")) ) {
plugins.removeAll(QStringLiteral("<built-in>"));
choices.append({i18nc("@item:inlistbox", "Open existing file \"%1\"", file), QStringLiteral("<built-in>"), QString(), QString()});
}
choices.reserve(choices.size() + plugins.size());
for (const auto& plugin : qAsConst(plugins)) {
auto meta = m_projectPlugins.value(plugin);
choices.append({file + QLatin1String(" (") + plugin + QLatin1Char(')'), meta.pluginId(), meta.iconName(), file});
}
}
// add managers that work in any case (e.g. KDevGenericManager)
choices.reserve(choices.size() + m_genericProjectPlugins.size());
for (const auto& plugin : qAsConst(m_genericProjectPlugins)) {
qCDebug(SHELL) << plugin;
auto meta = m_projectPlugins.value(plugin);
choices.append({plugin, meta.pluginId(), meta.iconName(), QString()});
}
page->populateProjectFileCombo(choices);
}
m_url.setPath( m_url.path() + QLatin1Char('/') + m_url.fileName() + QLatin1Char('.') + ShellExtension::getInstance()->projectFileExtension() );
} else {
setAppropriate( projectInfoPage, false );
m_url = url;
m_urlIsDirectory = false;
}
validateProjectInfo();
setValid( openPage, true );
}
QStringList OpenProjectDialog::projectManagerForFile(const QString& file) const
{
QStringList ret;
for (auto it = m_projectFilters.begin(), end = m_projectFilters.end(); it != end; ++it) {
const QString& manager = it.key();
for (const QString& filterexp : it.value()) {
QRegExp exp( filterexp, Qt::CaseSensitive, QRegExp::Wildcard );
if ( exp.exactMatch(file) ) {
ret.append(manager);
}
}
}
if ( file.endsWith(ShellExtension::getInstance()->projectFileExtension()) ) {
ret.append(QStringLiteral("<built-in>"));
}
return ret;
}
void OpenProjectDialog::openPageAccepted()
{
if ( isValid( openPage ) ) {
next();
}
}
void OpenProjectDialog::validateProjectName( const QString& name )
{
m_projectName = name;
validateProjectInfo();
}
void OpenProjectDialog::validateProjectInfo()
{
setValid( projectInfoPage, (!projectName().isEmpty() && !projectManager().isEmpty()) );
}
void OpenProjectDialog::validateProjectManager( const QString& manager, const QString & fileName )
{
m_projectManager = manager;
if ( m_urlIsDirectory )
{
m_selected = m_url.resolved( QUrl(QLatin1String("./") + fileName) );
}
validateProjectInfo();
}
QUrl OpenProjectDialog::projectFileUrl() const
{
return m_url;
}
QUrl OpenProjectDialog::selectedUrl() const
{
return m_selected;
}
QString OpenProjectDialog::projectName() const
{
return m_projectName;
}
QString OpenProjectDialog::projectManager() const
{
return m_projectManager;
}
void OpenProjectDialog::storeFileList(KIO::Job*, const KIO::UDSEntryList& list)
{
for (const KIO::UDSEntry& entry : list) {
QString name = entry.stringValue( KIO::UDSEntry::UDS_NAME );
if( name != QLatin1String(".") && name != QLatin1String("..") && !entry.isDir() )
{
m_fileList << name;
}
}
}
}
|