basecheckoutwizard.cpp 6.79 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
30 31 32 33 34 35 36 37 38
**
**************************************************************************/

#include "basecheckoutwizard.h"
#include "vcsbaseconstants.h"
#include "checkoutwizarddialog.h"
#include "checkoutjobs.h"

#include <projectexplorer/projectexplorer.h>
39
#include <projectexplorer/projectexplorerconstants.h>
40 41 42 43 44 45

#include <QtCore/QCoreApplication>
#include <QtCore/QFileInfo>
#include <QtCore/QDir>
#include <QtGui/QMessageBox>

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/*!
    \class VCSBase::BaseCheckoutWizard

    \brief A Core::IWizard implementing a wizard for initially checking out a project using
    a version control system.

   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.

   \sa VCSBase::BaseCheckoutWizardPage
*/

67 68 69
namespace VCSBase {

struct BaseCheckoutWizardPrivate {
70
    BaseCheckoutWizardPrivate() : dialog(0) {}
71 72 73
    void clear();

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

void BaseCheckoutWizardPrivate::clear()
{
81
    parameterPages.clear();
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
    dialog = 0;
    checkoutPath.clear();
}

BaseCheckoutWizard::BaseCheckoutWizard(QObject *parent) :
    Core::IWizard(parent),
    d(new BaseCheckoutWizardPrivate)
{
}

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 117 118 119
}

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

void BaseCheckoutWizard::setId(const QString &id)
{
    d->id = id;
120 121
}

122
void BaseCheckoutWizard::runWizard(const QString &path, QWidget *parent)
123 124
{
    // Create dialog and launch
125 126
    d->parameterPages = createParameterPages(path);
    Internal::CheckoutWizardDialog dialog(d->parameterPages, parent);
127 128
    d->dialog = &dialog;
    connect(&dialog, SIGNAL(progressPageShown()), this, SLOT(slotProgressPageShown()));
129
    dialog.setWindowTitle(displayName());
130
    if (dialog.exec() != QDialog::Accepted)
131
        return;
132 133 134 135 136 137 138
    // 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"),
139
                           tr("Failed to open project in '%1'.").arg(QDir::toNativeSeparators(checkoutPath)));
140 141 142 143 144
        msgBox.setDetailedText(errorMessage);
        msgBox.exec();
    }
}

145 146
static inline QString msgNoProjectFiles(const QDir &dir, const QStringList &patterns)
{
147
    return BaseCheckoutWizard::tr("Could not find any project files matching (%1) in the directory '%2'.").arg(patterns.join(QLatin1String(", ")), QDir::toNativeSeparators(dir.absolutePath()));
148 149 150 151 152
}

// Try to find the project files in a project directory with some smartness
static QFileInfoList findProjectFiles(const QDir &projectDir, QString *errorMessage)
{
153
    const QStringList projectFilePatterns = ProjectExplorer::ProjectExplorerPlugin::projectFilePatterns();
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
    // 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;;
}

173 174 175 176 177 178 179 180 181 182 183
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()) {
184 185
        *errorMessage = tr("'%1' does not exist.").
                        arg(QDir::toNativeSeparators(path)); // Should not happen
186 187
        return QString();
    }
188 189
    QFileInfoList projectFiles = findProjectFiles(dir, errorMessage);
    if (projectFiles.empty())
190
        return QString();
191
    // Open. Do not use a busy cursor here as additional wizards might pop up
192
    const QString projectFile = projectFiles.front().absoluteFilePath();
193
    if (!pe->openProject(projectFile, errorMessage)) {
194 195 196 197 198 199 200
        return QString();
    }
    return projectFile;
}

void BaseCheckoutWizard::slotProgressPageShown()
{
201
    const QSharedPointer<AbstractCheckoutJob> job = createJob(d->parameterPages, &(d->checkoutPath));
202 203 204 205 206
    if (!job.isNull())
        d->dialog->start(job);
}

} // namespace VCSBase