/**************************************************************************** ** ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** 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 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. ** ** GNU Lesser General Public License Usage ** 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 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ****************************************************************************/ #include "vcsbaseplugin.h" #include "vcsbasesubmiteditor.h" #include "vcsplugin.h" #include "commonvcssettings.h" #include "vcsbaseoutputwindow.h" #include "corelistener.h" #include "command.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace Utils; enum { debug = 0, debugRepositorySearch = 0 }; /*! \namespace VcsBase \brief The VcsBase namespace contains classes for the VcsBase plugin. */ /*! \namespace VcsBase::Internal \brief The Internal namespace contains internal classes for the VcsBase plugin. \internal */ namespace VcsBase { namespace Internal { /*! \class VcsBase::Internal::State \brief The State class provides the internal state created by the state listener and VcsBasePluginState. Aggregated in the QSharedData of VcsBase::VcsBasePluginState. */ struct State { void clearFile(); void clearPatchFile(); void clearProject(); inline void clear(); bool equals(const State &rhs) const; inline bool hasFile() const { return !currentFileTopLevel.isEmpty(); } inline bool hasProject() const { return !currentProjectTopLevel.isEmpty(); } inline bool isEmpty() const { return !hasFile() && !hasProject(); } QString currentFile; QString currentFileName; QString currentPatchFile; QString currentPatchFileDisplayName; QString currentFileDirectory; QString currentFileTopLevel; QString currentProjectPath; QString currentProjectName; QString currentProjectTopLevel; }; void State::clearFile() { currentFile.clear(); currentFileName.clear(); currentFileDirectory.clear(); currentFileTopLevel.clear(); } void State::clearPatchFile() { currentPatchFile.clear(); currentPatchFileDisplayName.clear(); } void State::clearProject() { currentProjectPath.clear(); currentProjectName.clear(); currentProjectTopLevel.clear(); } void State::clear() { clearFile(); clearPatchFile(); clearProject(); } bool State::equals(const State &rhs) const { return currentFile == rhs.currentFile && currentFileName == rhs.currentFileName && currentPatchFile == rhs.currentPatchFile && currentPatchFileDisplayName == rhs.currentPatchFileDisplayName && currentFileTopLevel == rhs.currentFileTopLevel && currentProjectPath == rhs.currentProjectPath && currentProjectName == rhs.currentProjectName && currentProjectTopLevel == rhs.currentProjectTopLevel; } QDebug operator<<(QDebug in, const State &state) { QDebug nospace = in.nospace(); nospace << "State: "; if (state.isEmpty()) { nospace << ""; } else { if (state.hasFile()) { nospace << "File=" << state.currentFile << ',' << state.currentFileTopLevel; } else { nospace << ""; } nospace << '\n'; if (state.hasProject()) { nospace << " Project=" << state.currentProjectName << ',' << state.currentProjectPath << ',' << state.currentProjectTopLevel; } else { nospace << ""; } nospace << '\n'; } return in; } /*! \class VcsBase::Internal::StateListener \brief The StateListener class connects to the relevant signals of \QC, tries to find version controls and emits signals to the plugin instances. Singleton (as not to do checks multiple times). */ class StateListener : public QObject { Q_OBJECT public: explicit StateListener(QObject *parent); signals: void stateChanged(const VcsBase::Internal::State &s, Core::IVersionControl *vc); public slots: void slotStateChanged(); }; StateListener::StateListener(QObject *parent) : QObject(parent) { connect(Core::EditorManager::instance(), SIGNAL(currentEditorChanged(Core::IEditor*)), this, SLOT(slotStateChanged())); connect(Core::EditorManager::instance(), SIGNAL(currentDocumentStateChanged()), this, SLOT(slotStateChanged())); connect(Core::VcsManager::instance(), SIGNAL(repositoryChanged(QString)), this, SLOT(slotStateChanged())); connect(ProjectExplorer::ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project*)), this, SLOT(slotStateChanged())); } static inline QString displayNameOfEditor(const QString &fileName) { Core::IDocument *document = Core::DocumentModel::documentForFilePath(fileName); if (document) return document->displayName(); return QString(); } void StateListener::slotStateChanged() { // Get the current file. Are we on a temporary submit editor indicated by // temporary path prefix or does the file contains a hash, indicating a project // folder? State state; Core::IDocument *currentDocument = Core::EditorManager::currentDocument(); if (!currentDocument) { state.currentFile.clear(); } else { state.currentFile = currentDocument->filePath(); if (state.currentFile.isEmpty() || currentDocument->isTemporary()) state.currentFile = VcsBasePlugin::source(currentDocument); } QScopedPointer currentFileInfo; // Instantiate QFileInfo only once if required. if (!state.currentFile.isEmpty()) { const bool isTempFile = state.currentFile.startsWith(QDir::tempPath()); // Quick check: Does it look like a patch? const bool isPatch = state.currentFile.endsWith(QLatin1String(".patch")) || state.currentFile.endsWith(QLatin1String(".diff")); if (isPatch) { // Patch: Figure out a name to display. If it is a temp file, it could be // Codepaster. Use the display name of the editor. state.currentPatchFile = state.currentFile; if (isTempFile) state.currentPatchFileDisplayName = displayNameOfEditor(state.currentPatchFile); if (state.currentPatchFileDisplayName.isEmpty()) { currentFileInfo.reset(new QFileInfo(state.currentFile)); state.currentPatchFileDisplayName = currentFileInfo->fileName(); } } // For actual version control operations on it: // Do not show temporary files and project folders ('#') if (isTempFile || state.currentFile.contains(QLatin1Char('#'))) state.currentFile.clear(); } // Get the file and its control. Do not use the file unless we find one Core::IVersionControl *fileControl = 0; if (!state.currentFile.isEmpty()) { if (currentFileInfo.isNull()) currentFileInfo.reset(new QFileInfo(state.currentFile)); if (currentFileInfo->isDir()) { state.currentFile.clear(); state.currentFileDirectory = currentFileInfo->absoluteFilePath(); } else { state.currentFileDirectory = currentFileInfo->absolutePath(); state.currentFileName = currentFileInfo->fileName(); } fileControl = Core::VcsManager::findVersionControlForDirectory( state.currentFileDirectory, &state.currentFileTopLevel); if (!fileControl) state.clearFile(); } // Check for project, find the control Core::IVersionControl *projectControl = 0; if (const ProjectExplorer::Project *currentProject = ProjectExplorer::ProjectExplorerPlugin::currentProject()) { state.currentProjectPath = currentProject->projectDirectory().toString(); state.currentProjectName = currentProject->displayName(); projectControl = Core::VcsManager::findVersionControlForDirectory(state.currentProjectPath, &state.currentProjectTopLevel); if (projectControl) { // If we have both, let the file's one take preference if (fileControl && projectControl != fileControl) state.clearProject(); } else { state.clearProject(); // No control found } } // Assemble state and emit signal. Core::IVersionControl *vc = fileControl; if (!vc) vc = projectControl; if (!vc) { state.clearPatchFile(); // Need a repository to patch Core::EditorManager::setWindowTitleVcsTopic(QString()); } if (debug) qDebug() << state << (vc ? vc->displayName() : QLatin1String("No version control")); emit stateChanged(state, vc); } } // namespace Internal class VcsBasePluginStateData : public QSharedData { public: Internal::State m_state; }; /*! \class VcsBase::VcsBasePluginState \brief The VcsBasePluginState class provides relevant state information about the VCS plugins. Qt Creator's state relevant to VCS plugins is a tuple of \list \li Current file and it's version system control/top level \li Current project and it's version system control/top level \endlist \sa VcsBase::VcsBasePlugin */ VcsBasePluginState::VcsBasePluginState() : data(new VcsBasePluginStateData) { } VcsBasePluginState::VcsBasePluginState(const VcsBasePluginState &rhs) : data(rhs.data) { } VcsBasePluginState &VcsBasePluginState::operator=(const VcsBasePluginState &rhs) { if (this != &rhs) data.operator=(rhs.data); return *this; } VcsBasePluginState::~VcsBasePluginState() { } QString VcsBasePluginState::currentFile() const { return data->m_state.currentFile; } QString VcsBasePluginState::currentFileName() const { return data->m_state.currentFileName; } QString VcsBasePluginState::currentFileTopLevel() const { return data->m_state.currentFileTopLevel; } QString VcsBasePluginState::currentFileDirectory() const { return data->m_state.currentFileDirectory; } QString VcsBasePluginState::relativeCurrentFile() const { QTC_ASSERT(hasFile(), return QString()); return QDir(data->m_state.currentFileTopLevel).relativeFilePath(data->m_state.currentFile); } QString VcsBasePluginState::currentPatchFile() const { return data->m_state.currentPatchFile; } QString VcsBasePluginState::currentPatchFileDisplayName() const { return data->m_state.currentPatchFileDisplayName; } QString VcsBasePluginState::currentProjectPath() const { return data->m_state.currentProjectPath; } QString VcsBasePluginState::currentProjectName() const { return data->m_state.currentProjectName; } QString VcsBasePluginState::currentProjectTopLevel() const { return data->m_state.currentProjectTopLevel; } QString VcsBasePluginState::relativeCurrentProject() const { QTC_ASSERT(hasProject(), return QString()); if (data->m_state.currentProjectTopLevel != data->m_state.currentProjectPath) return QDir(data->m_state.currentProjectTopLevel).relativeFilePath(data->m_state.currentProjectPath); return QString(); } bool VcsBasePluginState::hasTopLevel() const { return data->m_state.hasFile() || data->m_state.hasProject(); } QString VcsBasePluginState::topLevel() const { return hasFile() ? data->m_state.currentFileTopLevel : data->m_state.currentProjectTopLevel; } bool VcsBasePluginState::equals(const Internal::State &rhs) const { return data->m_state.equals(rhs); } bool VcsBasePluginState::equals(const VcsBasePluginState &rhs) const { return equals(rhs.data->m_state); } void VcsBasePluginState::clear() { data->m_state.clear(); } void VcsBasePluginState::setState(const Internal::State &s) { data->m_state = s; } bool VcsBasePluginState::isEmpty() const { return data->m_state.isEmpty(); } bool VcsBasePluginState::hasFile() const { return data->m_state.hasFile(); } bool VcsBasePluginState::hasPatchFile() const { return !data->m_state.currentPatchFile.isEmpty(); } bool VcsBasePluginState::hasProject() const { return data->m_state.hasProject(); } VCSBASE_EXPORT QDebug operator<<(QDebug in, const VcsBasePluginState &state) { in << state.data->m_state; return in; } /*! \class VcsBase::VcsBasePlugin \brief The VcsBasePlugin class is the base class for all version control plugins. The plugin connects to the relevant change signals in Qt Creator and calls the virtual updateActions() for the plugins to update their menu actions according to the new state. This is done centrally to avoid single plugins repeatedly invoking searches/QFileInfo on files, etc. Independently, there are accessors for current patch files, which return a file name if the current file could be a patch file which could be applied and a repository exists. If current file/project are managed by different version controls, the project is discarded and only the current file is taken into account, allowing to do a diff also when the project of a file is not opened. When triggering an action, a copy of the state should be made to keep it, as it may rapidly change due to context changes, etc. The class also detects the VCS plugin submit editor closing and calls the virtual submitEditorAboutToClose() to trigger the submit process. */ class VcsBasePluginPrivate { public: explicit VcsBasePluginPrivate(); inline bool supportsRepositoryCreation() const; QPointer m_submitEditor; Core::IVersionControl *m_versionControl; VcsBasePluginState m_state; int m_actionState; static Internal::StateListener *m_listener; }; VcsBasePluginPrivate::VcsBasePluginPrivate() : m_versionControl(0), m_actionState(-1) { } bool VcsBasePluginPrivate::supportsRepositoryCreation() const { return m_versionControl && m_versionControl->supportsOperation(Core::IVersionControl::CreateRepositoryOperation); } Internal::StateListener *VcsBasePluginPrivate::m_listener = 0; VcsBasePlugin::VcsBasePlugin() : d(new VcsBasePluginPrivate()) { } VcsBasePlugin::~VcsBasePlugin() { delete d; } void VcsBasePlugin::initializeVcs(Core::IVersionControl *vc) { d->m_versionControl = vc; addAutoReleasedObject(vc); Internal::VcsPlugin *plugin = Internal::VcsPlugin::instance(); connect(plugin->coreListener(), SIGNAL(submitEditorAboutToClose(VcsBaseSubmitEditor*,bool*)), this, SLOT(slotSubmitEditorAboutToClose(VcsBaseSubmitEditor*,bool*))); // First time: create new listener if (!VcsBasePluginPrivate::m_listener) VcsBasePluginPrivate::m_listener = new Internal::StateListener(plugin); connect(VcsBasePluginPrivate::m_listener, SIGNAL(stateChanged(VcsBase::Internal::State,Core::IVersionControl*)), this, SLOT(slotStateChanged(VcsBase::Internal::State,Core::IVersionControl*))); // VCSes might have become (un-)available, so clear the VCS directory cache connect(vc, SIGNAL(configurationChanged()), Core::VcsManager::instance(), SLOT(clearVersionControlCache())); connect(vc, SIGNAL(configurationChanged()), VcsBasePluginPrivate::m_listener, SLOT(slotStateChanged())); } void VcsBasePlugin::extensionsInitialized() { // Initialize enable menus. VcsBasePluginPrivate::m_listener->slotStateChanged(); } void VcsBasePlugin::slotSubmitEditorAboutToClose(VcsBaseSubmitEditor *submitEditor, bool *result) { if (debug) qDebug() << this << "plugin's submit editor" << d->m_submitEditor << (d->m_submitEditor ? d->m_submitEditor->document()->id().name() : "") << "closing submit editor" << submitEditor << (submitEditor ? submitEditor->document()->id().name() : ""); if (submitEditor == d->m_submitEditor) *result = submitEditorAboutToClose(); } Core::IVersionControl *VcsBasePlugin::versionControl() const { return d->m_versionControl; } void VcsBasePlugin::slotStateChanged(const VcsBase::Internal::State &newInternalState, Core::IVersionControl *vc) { if (vc == d->m_versionControl) { // We are directly affected: Change state if (!d->m_state.equals(newInternalState)) { d->m_state.setState(newInternalState); updateActions(VcsEnabled); } Core::EditorManager::setWindowTitleVcsTopic(vc->vcsTopic(d->m_state.topLevel())); } else { // Some other VCS plugin or state changed: Reset us to empty state. const ActionState newActionState = vc ? OtherVcsEnabled : NoVcsEnabled; if (d->m_actionState != newActionState || !d->m_state.isEmpty()) { d->m_actionState = newActionState; const VcsBasePluginState emptyState; d->m_state = emptyState; updateActions(newActionState); } } } const VcsBasePluginState &VcsBasePlugin::currentState() const { return d->m_state; } bool VcsBasePlugin::enableMenuAction(ActionState as, QAction *menuAction) const { if (debug) qDebug() << "enableMenuAction" << menuAction->text() << as; switch (as) { case VcsBase::VcsBasePlugin::NoVcsEnabled: { const bool supportsCreation = d->supportsRepositoryCreation(); menuAction->setVisible(supportsCreation); menuAction->setEnabled(supportsCreation); return supportsCreation; } case VcsBase::VcsBasePlugin::OtherVcsEnabled: menuAction->setVisible(false); return false; case VcsBase::VcsBasePlugin::VcsEnabled: menuAction->setVisible(true); menuAction->setEnabled(true); break; } return true; } void VcsBasePlugin::promptToDeleteCurrentFile() { const VcsBasePluginState state = currentState(); QTC_ASSERT(state.hasFile(), return); const bool rc = Core::VcsManager::promptToDelete(versionControl(), state.currentFile()); if (!rc) QMessageBox::warning(Core::ICore::dialogParent(), tr("Version Control"), tr("The file \"%1\" could not be deleted."). arg(QDir::toNativeSeparators(state.currentFile())), QMessageBox::Ok); } static inline bool ask(QWidget *parent, const QString &title, const QString &question, bool defaultValue = true) { const QMessageBox::StandardButton defaultButton = defaultValue ? QMessageBox::Yes : QMessageBox::No; return QMessageBox::question(parent, title, question, QMessageBox::Yes|QMessageBox::No, defaultButton) == QMessageBox::Yes; } void VcsBasePlugin::createRepository() { QTC_ASSERT(d->m_versionControl->supportsOperation(Core::IVersionControl::CreateRepositoryOperation), return); // Find current starting directory QString directory; if (const ProjectExplorer::Project *currentProject = ProjectExplorer::ProjectExplorerPlugin::currentProject()) directory = QFileInfo(currentProject->document()->filePath()).absolutePath(); // Prompt for a directory that is not under version control yet QWidget *mw = Core::ICore::mainWindow(); do { directory = QFileDialog::getExistingDirectory(mw, tr("Choose Repository Directory"), directory); if (directory.isEmpty()) return; const Core::IVersionControl *managingControl = Core::VcsManager::findVersionControlForDirectory(directory); if (managingControl == 0) break; const QString question = tr("The directory \"%1\" is already managed by a version control system (%2)." " Would you like to specify another directory?").arg(directory, managingControl->displayName()); if (!ask(mw, tr("Repository already under version control"), question)) return; } while (true); // Create const bool rc = d->m_versionControl->vcsCreateRepository(directory); const QString nativeDir = QDir::toNativeSeparators(directory); if (rc) { QMessageBox::information(mw, tr("Repository Created"), tr("A version control repository has been created in %1."). arg(nativeDir)); } else { QMessageBox::warning(mw, tr("Repository Creation Failed"), tr("A version control repository could not be created in %1."). arg(nativeDir)); } } void VcsBasePlugin::setSubmitEditor(VcsBaseSubmitEditor *submitEditor) { d->m_submitEditor = submitEditor; } VcsBaseSubmitEditor *VcsBasePlugin::submitEditor() const { return d->m_submitEditor; } bool VcsBasePlugin::raiseSubmitEditor() const { if (!d->m_submitEditor) return false; Core::EditorManager::activateEditor(d->m_submitEditor, Core::EditorManager::IgnoreNavigationHistory); return true; } // Find top level for version controls like git/Mercurial that have // a directory at the top of the repository. // Note that checking for the existence of files is preferred over directories // since checking for directories can cause them to be created when // AutoFS is used (due its automatically creating mountpoints when querying // a directory). In addition, bail out when reaching the home directory // of the user or root (generally avoid '/', where mountpoints are created). QString VcsBasePlugin::findRepositoryForDirectory(const QString &dirS, const QString &checkFile) { if (debugRepositorySearch) qDebug() << ">VcsBasePlugin::findRepositoryForDirectory" << dirS << checkFile; QTC_ASSERT(!dirS.isEmpty() && !checkFile.isEmpty(), return QString()); const QString root = QDir::rootPath(); const QString home = QDir::homePath(); QDir directory(dirS); do { const QString absDirPath = directory.absolutePath(); if (absDirPath == root || absDirPath == home) break; if (QFileInfo(directory, checkFile).isFile()) { if (debugRepositorySearch) qDebug() << " " << absDirPath; return absDirPath; } } while (!directory.isRoot() && directory.cdUp()); if (debugRepositorySearch) qDebug() << "settings().sshPasswordPrompt; } bool VcsBasePlugin::isSshPromptConfigured() { return !sshPrompt().isEmpty(); } static const char SOURCE_PROPERTY[] = "qtcreator_source"; void VcsBasePlugin::setSource(Core::IDocument *document, const QString &source) { document->setProperty(SOURCE_PROPERTY, source); VcsBasePluginPrivate::m_listener->slotStateChanged(); } QString VcsBasePlugin::source(Core::IDocument *document) { return document->property(SOURCE_PROPERTY).toString(); } void VcsBasePlugin::setProcessEnvironment(QProcessEnvironment *e, bool forceCLocale, const QString &sshPromptBinary) { if (forceCLocale) e->insert(QLatin1String("LANG"), QString(QLatin1Char('C'))); if (!sshPromptBinary.isEmpty()) e->insert(QLatin1String("SSH_ASKPASS"), sshPromptBinary); } // Run a process synchronously, returning Utils::SynchronousProcessResponse // response struct and using the VcsBasePlugin flags as applicable SynchronousProcessResponse VcsBasePlugin::runVcs(const QString &workingDir, const QString &binary, const QStringList &arguments, int timeOutMS, unsigned flags, QTextCodec *outputCodec, const QProcessEnvironment &env) { Command command(binary, workingDir, env.isEmpty() ? QProcessEnvironment::systemEnvironment() : env); command.addFlags(flags); command.setCodec(outputCodec); return command.runVcs(arguments, timeOutMS); } } // namespace VcsBase #include "vcsbaseplugin.moc"