basecheckoutwizard.cpp 7.23 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32

#include "basecheckoutwizard.h"
#include "checkoutwizarddialog.h"

33 34
#include <coreplugin/featureprovider.h>

35 36
#include <projectexplorer/projectexplorer.h>

37 38 39
#include <QCoreApplication>
#include <QDir>
#include <QMessageBox>
40

41
/*!
hjk's avatar
hjk committed
42
    \class VcsBase::BaseCheckoutWizard
43

44 45
    \brief The BaseCheckoutWizard class implements a wizard for initially
    checking out a project using a version control system.
46 47 48 49 50 51 52 53 54 55 56 57 58

   Implements all of Core::IWizard with the exception of
   name()/description() and icon().

   Pops up a QWizard consisting of a Parameter Page which is created
   by a virtual factory function and a progress
   page containing a log text. The factory function createJob()
   creates a job with the output connected to the log window,
   returning the path to the checkout.

   On success, the wizard tries to locate a project file
   and open it.

hjk's avatar
hjk committed
59
   \sa VcsBase::BaseCheckoutWizardPage
60 61
*/

hjk's avatar
hjk committed
62
namespace VcsBase {
63
namespace Internal {
64

65 66 67
class BaseCheckoutWizardPrivate
{
public:
68
    BaseCheckoutWizardPrivate() : dialog(0) {}
69 70 71
    void clear();

    Internal::CheckoutWizardDialog *dialog;
72
    QList<QWizardPage *> parameterPages;
73
    QString checkoutPath;
Friedemann Kleint's avatar
Friedemann Kleint committed
74
    QString id;
75 76 77 78
};

void BaseCheckoutWizardPrivate::clear()
{
79
    parameterPages.clear();
80 81 82 83
    dialog = 0;
    checkoutPath.clear();
}

84 85
} // namespace Internal

86 87
BaseCheckoutWizard::BaseCheckoutWizard(QObject *parent) :
    Core::IWizard(parent),
88
    d(new Internal::BaseCheckoutWizardPrivate)
89 90 91 92 93 94 95 96
{
}

BaseCheckoutWizard::~BaseCheckoutWizard()
{
    delete d;
}

97
Core::IWizard::WizardKind BaseCheckoutWizard::kind() const
98
{
Friedemann Kleint's avatar
Friedemann Kleint committed
99
    return Core::IWizard::ProjectWizard;
100 101 102 103
}

QString BaseCheckoutWizard::category() const
{
104
    return QLatin1String(ProjectExplorer::Constants::IMPORT_WIZARD_CATEGORY);
105 106
}

107
QString BaseCheckoutWizard::displayCategory() const
108
{
109
    return QCoreApplication::translate("ProjectExplorer", ProjectExplorer::Constants::IMPORT_WIZARD_CATEGORY_DISPLAY);
Friedemann Kleint's avatar
Friedemann Kleint committed
110 111 112 113 114 115 116
}

QString BaseCheckoutWizard::id() const
{
    return d->id;
}

117 118 119 120 121
QString BaseCheckoutWizard::descriptionImage() const
{
    return QString();
}

Friedemann Kleint's avatar
Friedemann Kleint committed
122 123 124
void BaseCheckoutWizard::setId(const QString &id)
{
    d->id = id;
125 126
}

127
void BaseCheckoutWizard::runWizard(const QString &path, QWidget *parent, const QString & /*platform*/, const QVariantMap &extraValues)
128
{
129
    Q_UNUSED(extraValues)
130
    // Create dialog and launch
131 132
    d->parameterPages = createParameterPages(path);
    Internal::CheckoutWizardDialog dialog(d->parameterPages, parent);
133 134
    d->dialog = &dialog;
    connect(&dialog, SIGNAL(progressPageShown()), this, SLOT(slotProgressPageShown()));
135
    dialog.setWindowTitle(displayName());
136
    if (dialog.exec() != QDialog::Accepted)
137
        return;
138 139 140 141 142 143 144
    // Now try to find the project file and open
    const QString checkoutPath = d->checkoutPath;
    d->clear();
    QString errorMessage;
    const QString projectFile = openProject(checkoutPath, &errorMessage);
    if (projectFile.isEmpty()) {
        QMessageBox msgBox(QMessageBox::Warning, tr("Cannot Open Project"),
145
                           tr("Failed to open project in '%1'.").arg(QDir::toNativeSeparators(checkoutPath)));
146 147 148 149 150
        msgBox.setDetailedText(errorMessage);
        msgBox.exec();
    }
}

151 152 153 154 155
Core::FeatureSet BaseCheckoutWizard::requiredFeatures() const
{
    return Core::FeatureSet();
}

156 157 158 159 160
Core::IWizard::WizardFlags BaseCheckoutWizard::flags() const
{
    return Core::IWizard::PlatformIndependent;
}

161 162
static inline QString msgNoProjectFiles(const QDir &dir, const QStringList &patterns)
{
163
    return BaseCheckoutWizard::tr("Could not find any project files matching (%1) in the directory '%2'.").arg(patterns.join(QLatin1String(", ")), QDir::toNativeSeparators(dir.absolutePath()));
164 165 166 167 168
}

// Try to find the project files in a project directory with some smartness
static QFileInfoList findProjectFiles(const QDir &projectDir, QString *errorMessage)
{
169
    const QStringList projectFilePatterns = ProjectExplorer::ProjectExplorerPlugin::projectFilePatterns();
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    // Project directory
    QFileInfoList projectFiles = projectDir.entryInfoList(projectFilePatterns, QDir::Files|QDir::NoDotAndDotDot|QDir::Readable);
    if (!projectFiles.empty())
        return projectFiles;
    // Try a 'src' directory
    QFileInfoList srcDirs = projectDir.entryInfoList(QStringList(QLatin1String("src")), QDir::Dirs|QDir::NoDotAndDotDot|QDir::Readable);
    if (srcDirs.empty()) {
        *errorMessage = msgNoProjectFiles(projectDir, projectFilePatterns);
        return QFileInfoList();
    }
    const QDir srcDir = QDir(srcDirs.front().absoluteFilePath());
    projectFiles = srcDir.entryInfoList(projectFilePatterns, QDir::Files|QDir::NoDotAndDotDot|QDir::Readable);
    if (projectFiles.empty()) {
        *errorMessage = msgNoProjectFiles(srcDir, projectFilePatterns);
        return QFileInfoList();
    }
    return projectFiles;;
}

189 190 191 192 193 194 195 196 197 198 199
QString BaseCheckoutWizard::openProject(const QString &path, QString *errorMessage)
{
    ProjectExplorer::ProjectExplorerPlugin *pe  = ProjectExplorer::ProjectExplorerPlugin::instance();
    if (!pe) {
        *errorMessage = tr("The Project Explorer is not available.");
        return QString();
    }

    // Search the directory for project files
    const QDir dir(path);
    if (!dir.exists()) {
200 201
        *errorMessage = tr("'%1' does not exist.").
                        arg(QDir::toNativeSeparators(path)); // Should not happen
202 203
        return QString();
    }
204 205
    QFileInfoList projectFiles = findProjectFiles(dir, errorMessage);
    if (projectFiles.empty())
206
        return QString();
207
    // Open. Do not use a busy cursor here as additional wizards might pop up
208
    const QString projectFile = projectFiles.front().absoluteFilePath();
hjk's avatar
hjk committed
209
    if (!pe->openProject(projectFile, errorMessage))
210
        return QString();
hjk's avatar
hjk committed
211

212 213 214 215 216
    return projectFile;
}

void BaseCheckoutWizard::slotProgressPageShown()
{
217 218
    Command *command = createCommand(d->parameterPages, &(d->checkoutPath));
    d->dialog->start(command);
219 220
}

hjk's avatar
hjk committed
221
} // namespace VcsBase