session.cpp 29.9 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
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
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
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
****************************************************************************/
hjk's avatar
hjk committed
29 30 31

#include "session.h"

con's avatar
con committed
32 33 34 35
#include "project.h"
#include "projectexplorer.h"
#include "nodesvisitor.h"
#include "editorconfiguration.h"
36
#include "projectnodes.h"
con's avatar
con committed
37 38 39 40

#include <coreplugin/icore.h>
#include <coreplugin/imode.h>
#include <coreplugin/editormanager/editormanager.h>
41
#include <coreplugin/coreconstants.h>
42
#include <coreplugin/progressmanager/progressmanager.h>
con's avatar
con committed
43 44 45 46
#include <coreplugin/modemanager.h>

#include <texteditor/itexteditor.h>

47
#include <utils/stylehelper.h>
hjk's avatar
hjk committed
48

49 50 51
#include <QDebug>
#include <QDir>
#include <QFileInfo>
hjk's avatar
hjk committed
52

53 54
#include <QMessageBox>
#include <QPushButton>
con's avatar
con committed
55 56 57 58 59

namespace {
    bool debug = false;
}

60
using namespace Core;
Jarek Kobus's avatar
Jarek Kobus committed
61 62
using Utils::PersistentSettingsReader;
using Utils::PersistentSettingsWriter;
63

con's avatar
con committed
64
using namespace ProjectExplorer;
65
using namespace ProjectExplorer::Internal;
con's avatar
con committed
66

67 68 69
/*!
     \class ProjectExplorer::SessionManager

70
     \brief The SessionManager class manages sessions.
71 72 73 74 75 76

     TODO the interface of this class is not really great.
     The implementation suffers that all the functions from the
     public interface just wrap around functions which do the actual work
     This could be improved.
*/
con's avatar
con committed
77

hjk's avatar
hjk committed
78 79
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
80
    m_sessionNode(new SessionNode(this)),
81
    m_sessionName(QLatin1String("default")),
82
    m_virginSession(true),
83
    m_loadingSession(false),
Tobias Hunger's avatar
Tobias Hunger committed
84 85
    m_startupProject(0),
    m_writer(0)
con's avatar
con committed
86
{
87
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
88
            this, SLOT(saveActiveMode(Core::IMode*)));
89

hjk's avatar
hjk committed
90
    EditorManager *em = ICore::editorManager();
91

Robert Loehning's avatar
Robert Loehning committed
92 93 94
    connect(em, SIGNAL(editorCreated(Core::IEditor*,QString)),
            this, SLOT(configureEditor(Core::IEditor*,QString)));
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project*)),
con's avatar
con committed
95
            this, SLOT(updateWindowTitle()));
96 97 98 99
    connect(em, SIGNAL(editorOpened(Core::IEditor*)),
            this, SLOT(markSessionFileDirty()));
    connect(em, SIGNAL(editorsClosed(QList<Core::IEditor*>)),
            this, SLOT(markSessionFileDirty()));
hjk's avatar
hjk committed
100
}
con's avatar
con committed
101 102 103

SessionManager::~SessionManager()
{
104
    emit aboutToUnloadSession(m_sessionName);
Tobias Hunger's avatar
Tobias Hunger committed
105
    delete m_writer;
con's avatar
con committed
106 107 108 109 110
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
111 112
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
113 114 115 116
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
117
    return session == QLatin1String("default");
con's avatar
con committed
118 119 120 121 122
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
123
    setValue(QLatin1String("ActiveMode"), mode->id().toString());
con's avatar
con committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
}

void SessionManager::clearProjectFileCache()
{
    // If triggered by the fileListChanged signal of one project
    // only invalidate cache for this project
    Project *pro = qobject_cast<Project*>(sender());
    if (pro)
        m_projectFileCache.remove(pro);
    else
        m_projectFileCache.clear();
}

bool SessionManager::recursiveDependencyCheck(const QString &newDep, const QString &checkDep) const
{
    if (newDep == checkDep)
        return false;

142
    foreach (const QString &dependency, m_depMap.value(checkDep)) {
con's avatar
con committed
143 144 145 146 147 148 149
        if (!recursiveDependencyCheck(newDep, dependency))
            return false;
    }

    return true;
}

150
/*
151
 * The dependency management exposes an interface based on projects, but
152 153 154 155 156 157 158
 * is internally purely string based. This is suboptimal. Probably it would be
 * nicer to map the filenames to projects on load and only map it back to
 * filenames when saving.
 */

QList<Project *> SessionManager::dependencies(const Project *project) const
{
159
    const QString &proName = project->document()->fileName();
160
    const QStringList &proDeps = m_depMap.value(proName);
161 162 163 164 165 166 167 168 169 170 171

    QList<Project *> projects;
    foreach (const QString &dep, proDeps) {
        if (Project *pro = projectForFile(dep))
            projects += pro;
    }

    return projects;
}

bool SessionManager::hasDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
172
{
173 174
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
con's avatar
con committed
175

176
    const QStringList &proDeps = m_depMap.value(proName);
con's avatar
con committed
177 178 179
    return proDeps.contains(depName);
}

180
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
181
{
182 183
    const QString &newDep = project->document()->fileName();
    const QString &checkDep = depProject->document()->fileName();
con's avatar
con committed
184 185 186 187

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
188
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
189
{
190 191
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
con's avatar
con committed
192 193 194 195 196

    // check if this dependency is valid
    if (!recursiveDependencyCheck(proName, depName))
        return false;

197
    QStringList proDeps = m_depMap.value(proName);
con's avatar
con committed
198 199
    if (!proDeps.contains(depName)) {
        proDeps.append(depName);
200
        m_depMap[proName] = proDeps;
con's avatar
con committed
201
    }
dt's avatar
dt committed
202
    emit dependencyChanged(project, depProject);
con's avatar
con committed
203 204 205 206

    return true;
}

dt's avatar
dt committed
207
void SessionManager::removeDependency(Project *project, Project *depProject)
208
{
209 210
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
211

212
    QStringList proDeps = m_depMap.value(proName);
213
    proDeps.removeAll(depName);
214
    if (proDeps.isEmpty())
215
        m_depMap.remove(proName);
216
    else
217
        m_depMap[proName] = proDeps;
dt's avatar
dt committed
218
    emit dependencyChanged(project, depProject);
219 220
}

con's avatar
con committed
221 222 223
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
224
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : QLatin1String("0"));
con's avatar
con committed
225 226

    if (startupProject) {
227
        Q_ASSERT(m_projects.contains(startupProject));
con's avatar
con committed
228 229
    }

230
    if (m_startupProject == startupProject)
231 232
        return;

233
    m_startupProject = startupProject;
con's avatar
con committed
234 235 236 237 238
    emit startupProjectChanged(startupProject);
}

Project *SessionManager::startupProject() const
{
239
    return m_startupProject;
con's avatar
con committed
240 241 242 243 244 245 246 247 248
}

void SessionManager::addProject(Project *project)
{
    addProjects(QList<Project*>() << project);
}

void SessionManager::addProjects(const QList<Project*> &projects)
{
dt's avatar
dt committed
249
    m_virginSession = false;
con's avatar
con committed
250 251
    QList<Project*> clearedList;
    foreach (Project *pro, projects) {
252
        if (!m_projects.contains(pro)) {
con's avatar
con committed
253
            clearedList.append(pro);
254
            m_projects.append(pro);
255
            m_sessionNode->addProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
con's avatar
con committed
256 257 258 259

            connect(pro, SIGNAL(fileListChanged()),
                    this, SLOT(clearProjectFileCache()));

260 261 262
            connect(pro, SIGNAL(displayNameChanged()),
                    this, SLOT(projectDisplayNameChanged()));

con's avatar
con committed
263
            if (debug)
264
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
265 266 267 268 269 270 271 272 273 274 275 276 277
        }
    }

    foreach (Project *pro, clearedList) {
        emit projectAdded(pro);
    }

    if (clearedList.count() == 1)
        emit singleProjectAdded(clearedList.first());
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
278
    m_virginSession = false;
con's avatar
con committed
279 280 281 282 283 284 285
    if (project == 0) {
        qDebug() << "SessionManager::removeProject(0) ... THIS SHOULD NOT HAPPEN";
        return;
    }
    removeProjects(QList<Project*>() << project);
}

286 287 288 289 290
bool SessionManager::loadingSession()
{
    return m_loadingSession;
}

con's avatar
con committed
291 292 293 294 295 296 297
bool SessionManager::save()
{
    if (debug)
        qDebug() << "SessionManager - saving session" << m_sessionName;

    emit aboutToSaveSession();

Tobias Hunger's avatar
Tobias Hunger committed
298 299 300 301 302
    if (!m_writer || m_writer->fileName() != sessionNameToFileName(m_sessionName)) {
        delete m_writer;
        m_writer = new Utils::PersistentSettingsWriter(sessionNameToFileName(m_sessionName),
                                                       QLatin1String("QtCreatorSession"));
    }
303

304
    QVariantMap data;
305
    // save the startup project
Tobias Hunger's avatar
Tobias Hunger committed
306
    if (m_startupProject)
307
        data.insert(QLatin1String("StartupProject"), m_startupProject->document()->fileName());
308

309 310 311 312 313 314
    QColor c = Utils::StyleHelper::requestedBaseColor();
    if (c.isValid()) {
        QString tmp = QString::fromLatin1("#%1%2%3")
                .arg(c.red(), 2, 16, QLatin1Char('0'))
                .arg(c.green(), 2, 16, QLatin1Char('0'))
                .arg(c.blue(), 2, 16, QLatin1Char('0'));
315
        data.insert(QLatin1String("Color"), tmp);
316 317
    }

318
    QStringList projectFiles;
319
    foreach (Project *pro, m_projects)
320
        projectFiles << pro->document()->fileName();
321 322

    // Restore infromation on projects that failed to load:
323 324 325 326
    // don't readd projects to the list, which the user loaded
    foreach (const QString &failed, m_failedProjects)
        if (!projectFiles.contains(failed))
            projectFiles << failed;
327

328
    data.insert(QLatin1String("ProjectList"), projectFiles);
329 330

    QMap<QString, QVariant> depMap;
331 332
    QMap<QString, QStringList>::const_iterator i = m_depMap.constBegin();
    while (i != m_depMap.constEnd()) {
333 334 335 336 337 338 339 340
        QString key = i.key();
        QStringList values;
        foreach (const QString &value, i.value()) {
            values << value;
        }
        depMap.insert(key, values);
        ++i;
    }
341
    data.insert(QLatin1String("ProjectDependencies"), QVariant(depMap));
con's avatar
con committed
342

343 344 345 346 347 348 349
    int editorCount = 0;
    QList<Core::IEditor *> editors = ICore::editorManager()->openedEditors();
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
350 351
    data.insert(QLatin1String("OpenEditors"), editorCount);
    data.insert(QLatin1String("EditorSettings"), ICore::editorManager()->saveState().toBase64());
352 353

    QMap<QString, QVariant>::const_iterator it, end;
354
    end = m_values.constEnd();
355
    QStringList keys;
356
    for (it = m_values.constBegin(); it != end; ++it) {
357
        data.insert(QLatin1String("value-") + it.key(), it.value());
358 359 360
        keys << it.key();
    }

361
    data.insert(QLatin1String("valueKeys"), keys);
362

363
    bool result = m_writer->save(data, Core::ICore::mainWindow());
con's avatar
con committed
364 365
    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
Tobias Hunger's avatar
Tobias Hunger committed
366
                                tr("Could not save session to file %1").arg(m_writer->fileName().toUserOutput()));
con's avatar
con committed
367 368 369 370 371 372 373 374 375
    }

    if (debug)
        qDebug() << "SessionManager - saving session returned " << result;

    return result;
}

/*!
376
  Closes all projects
con's avatar
con committed
377
  */
378
void SessionManager::closeAllProjects()
con's avatar
con committed
379
{
380 381
    setStartupProject(0);
    removeProjects(projects());
con's avatar
con committed
382 383
}

384
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
385
{
386
    return m_projects;
con's avatar
con committed
387 388 389 390 391
}

QStringList SessionManager::dependencies(const QString &proName) const
{
    QStringList result;
392
    foreach (const QString &dep, m_depMap.value(proName))
con's avatar
con committed
393 394 395 396 397 398 399 400 401 402 403 404 405
        result += dependencies(dep);

    result << proName;
    return result;
}

QStringList SessionManager::dependenciesOrder() const
{
    QList<QPair<QString, QStringList> > unordered;
    QStringList ordered;

    // copy the map to a temporary list
    foreach (Project *pro, projects()) {
406
        const QString &proName = pro->document()->fileName();
con's avatar
con committed
407
        unordered << QPair<QString, QStringList>
408
            (proName, m_depMap.value(proName));
con's avatar
con committed
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
    }

    while (!unordered.isEmpty()) {
        for (int i=(unordered.count()-1); i>=0; --i) {
            if (unordered.at(i).second.isEmpty()) {
                ordered << unordered.at(i).first;
                unordered.removeAt(i);
            }
        }

        // remove the handled projects from the dependency lists
        // of the remaining unordered projects
        for (int i = 0; i < unordered.count(); ++i) {
            foreach (const QString &pro, ordered) {
                QStringList depList = unordered.at(i).second;
                depList.removeAll(pro);
                unordered[i].second = depList;
            }
        }
    }

    return ordered;
}

QList<Project *> SessionManager::projectOrder(Project *project) const
{
    QList<Project *> result;

    QStringList pros;
438
    if (project)
439
        pros = dependencies(project->document()->fileName());
440
    else
con's avatar
con committed
441 442 443 444
        pros = dependenciesOrder();

    foreach (const QString &proFile, pros) {
        foreach (Project *pro, projects()) {
445
            if (pro->document()->fileName() == proFile) {
con's avatar
con committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
                result << pro;
                break;
            }
        }
    }

    return result;
}

Project *SessionManager::projectForNode(Node *node) const
{
    if (!node)
        return 0;

    Project *project = 0;

    FolderNode *rootProjectNode = qobject_cast<FolderNode*>(node);
    if (!rootProjectNode)
        rootProjectNode = node->parentFolderNode();
    while (rootProjectNode && rootProjectNode->parentFolderNode() != m_sessionNode)
        rootProjectNode = rootProjectNode->parentFolderNode();

dt's avatar
dt committed
468
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
469 470 471 472 473 474 475 476 477 478 479 480

    QList<Project *> projectList = projects();
    foreach (Project *p, projectList) {
        if (p->rootProjectNode() == rootProjectNode) {
            project = p;
            break;
        }
    }

    return project;
}

dt's avatar
dt committed
481
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
482 483
{
    Node *node = 0;
dt's avatar
dt committed
484 485 486
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
        FindNodesForFileVisitor findNodes(fileName);
        project->rootProjectNode()->accept(&findNodes);

        foreach (Node *n, findNodes.nodes()) {
            // prefer file nodes
            if (!node || (node->nodeType() != FileNodeType && n->nodeType() == FileNodeType))
                node = n;
        }
    }

    return node;
}

Project *SessionManager::projectForFile(const QString &fileName) const
{
    if (debug)
        qDebug() << "SessionManager::projectForFile(" << fileName << ")";

505
    const QList<Project *> &projectList = projects();
con's avatar
con committed
506

507
    // Check current project first
508
    Project *currentProject = ProjectExplorerPlugin::currentProject();
509 510
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
511

512 513 514 515 516 517 518 519 520 521 522 523
    foreach (Project *p, projectList)
        if (p != currentProject && projectContainsFile(p, fileName))
            return p;
    return 0;
}

bool SessionManager::projectContainsFile(Project *p, const QString &fileName) const
{
    if (!m_projectFileCache.contains(p))
        m_projectFileCache.insert(p, p->files(Project::AllFiles));

    return m_projectFileCache.value(p).contains(fileName);
con's avatar
con committed
524 525
}

526
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
527
{
528 529 530
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
531 532
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
533
    }
con's avatar
con committed
534 535 536 537
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
538
    if (isDefaultSession(m_sessionName)) {
539
        if (Project *currentProject = ProjectExplorerPlugin::currentProject())
hjk's avatar
hjk committed
540
            ICore::editorManager()->setWindowTitleAddition(currentProject->displayName());
541
        else
hjk's avatar
hjk committed
542
            ICore::editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
543
    } else {
con's avatar
con committed
544 545 546
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
hjk's avatar
hjk committed
547
        ICore::editorManager()->setWindowTitleAddition(sessionName);
548
    }
con's avatar
con committed
549 550 551 552 553 554 555 556
}

void SessionManager::removeProjects(QList<Project *> remove)
{
    QMap<QString, QStringList> resMap;

    foreach (Project *pro, remove) {
        if (debug)
557
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
558 559 560 561 562 563 564 565
        emit aboutToRemoveProject(pro);
    }


    // Refresh dependencies
    QSet<QString> projectFiles;
    foreach (Project *pro, projects()) {
        if (!remove.contains(pro))
566
            projectFiles.insert(pro->document()->fileName());
con's avatar
con committed
567 568 569 570 571
    }

    QSet<QString>::const_iterator i = projectFiles.begin();
    while (i != projectFiles.end()) {
        QStringList dependencies;
572
        foreach (const QString &dependency, m_depMap.value(*i)) {
con's avatar
con committed
573 574 575 576 577 578 579 580
            if (projectFiles.contains(dependency))
                dependencies << dependency;
        }
        if (!dependencies.isEmpty())
            resMap.insert(*i, dependencies);
        ++i;
    }

581
    m_depMap = resMap;
con's avatar
con committed
582

583 584 585 586 587
    // TODO: Clear m_modelProjectHash

    // Delete projects
    foreach (Project *pro, remove) {
        pro->saveSettings();
588
        m_projects.removeOne(pro);
589

590
        if (pro == m_startupProject)
591 592 593 594 595 596 597 598
            setStartupProject(0);

        disconnect(pro, SIGNAL(fileListChanged()),
                this, SLOT(clearProjectFileCache()));
        m_projectFileCache.remove(pro);

        if (debug)
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
599
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
600 601 602 603
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
604
    if (startupProject() == 0)
605 606
        if (!m_projects.isEmpty())
            setStartupProject(m_projects.first());
con's avatar
con committed
607 608
}

609 610 611 612
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
613 614
void SessionManager::setValue(const QString &name, const QVariant &value)
{
615
    if (m_values.value(name) == value)
616
        return;
617
    m_values.insert(name, value);
618
    markSessionFileDirty(false);
con's avatar
con committed
619 620 621 622
}

QVariant SessionManager::value(const QString &name)
{
623 624
    QMap<QString, QVariant>::const_iterator it = m_values.find(name);
    return (it == m_values.constEnd()) ? QVariant() : *it;
con's avatar
con committed
625 626 627 628 629 630 631 632 633
}

QString SessionManager::activeSession() const
{
    return m_sessionName;
}

QStringList SessionManager::sessions() const
{
634
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
635
        // We are not initialized yet, so do that now
hjk's avatar
hjk committed
636
        QDir sessionDir(Core::ICore::userResourcePath());
637 638
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
639
            if (fileInfo.completeBaseName() != QLatin1String("default"))
640 641
                m_sessions << fileInfo.completeBaseName();
        }
642
        m_sessions.prepend(QLatin1String("default"));
643 644
    }
    return m_sessions;
con's avatar
con committed
645 646
}

647
Utils::FileName SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
648
{
649
    return Utils::FileName::fromString(ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws"));
con's avatar
con committed
650 651
}

652 653 654 655
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
656 657 658 659
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
660 661
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
662 663 664
    return true;
}

665 666 667 668 669 670 671 672 673
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

674 675 676 677 678 679 680 681 682 683 684 685

/*!
    \brief Shows a dialog asking the user to confirm deleting the session \p session
*/
bool SessionManager::confirmSessionDelete(const QString &session)
{
    return QMessageBox::question(Core::ICore::mainWindow(),
                                 tr("Delete Session"),
                                 tr("Delete session %1?").arg(session),
                                 QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes;
}

686 687 688
/*!
     \brief Deletes session name from session list and file from disk.
*/
con's avatar
con committed
689 690
bool SessionManager::deleteSession(const QString &session)
{
691
    if (!m_sessions.contains(session))
con's avatar
con committed
692
        return false;
693
    m_sessions.removeOne(session);
694
    QFile fi(sessionNameToFileName(session).toString());
con's avatar
con committed
695 696 697 698 699 700 701
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
702
    if (!m_sessions.contains(original))
con's avatar
con committed
703 704
        return false;

705
    QFile fi(sessionNameToFileName(original).toString());
con's avatar
con committed
706
    // If the file does not exist, we can still clone
707
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone).toString())) {
708 709
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
710 711 712 713 714
        return true;
    }
    return false;
}

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
void SessionManager::restoreValues(const Utils::PersistentSettingsReader &reader)
{
    const QStringList &keys = reader.restoreValue(QLatin1String("valueKeys")).toStringList();
    foreach (const QString &key, keys) {
        QVariant value = reader.restoreValue(QLatin1String("value-") + key);
        m_values.insert(key, value);
    }
}

void SessionManager::restoreDependencies(const Utils::PersistentSettingsReader &reader)
{
    QMap<QString, QVariant> depMap = reader.restoreValue(QLatin1String("ProjectDependencies")).toMap();
    QMap<QString, QVariant>::const_iterator i = depMap.constBegin();
    while (i != depMap.constEnd()) {
        const QString &key = i.key();
730 731 732 733 734 735 736
        if (!m_failedProjects.contains(key)) {
            QStringList values;
            foreach (const QString &value, i.value().toStringList()) {
                if (!m_failedProjects.contains(value))
                    values << value;
            }
            m_depMap.insert(key, values);
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
        }
        ++i;
    }
}

void SessionManager::askUserAboutFailedProjects()
{
    QStringList failedProjects = m_failedProjects;
    if (!failedProjects.isEmpty()) {
        QString fileList =
            QDir::toNativeSeparators(failedProjects.join(QLatin1String("<br>")));
        QMessageBox * box = new QMessageBox(QMessageBox::Warning,
                                            tr("Failed to restore project files"),
                                            tr("Could not restore the following project files:<br><b>%1</b>").
                                            arg(fileList));
        QPushButton * keepButton = new QPushButton(tr("Keep projects in Session"), box);
        QPushButton * removeButton = new QPushButton(tr("Remove projects from Session"), box);
        box->addButton(keepButton, QMessageBox::AcceptRole);
        box->addButton(removeButton, QMessageBox::DestructiveRole);

        box->exec();

        if (box->clickedButton() == removeButton)
            m_failedProjects.clear();
    }
}

void SessionManager::restoreStartupProject(const Utils::PersistentSettingsReader &reader)
{
    const QString startupProject = reader.restoreValue(QLatin1String("StartupProject")).toString();
    if (!startupProject.isEmpty()) {
        foreach (Project *pro, m_projects) {
769
            if (QDir::cleanPath(pro->document()->fileName()) == startupProject) {
770
                setStartupProject(pro);
771 772 773
                break;
            }
        }
774 775 776 777 778
    }
    if (!m_startupProject) {
        qWarning() << "Could not find startup project" << startupProject;
        if (!projects().isEmpty())
            setStartupProject(projects().first());
779 780 781 782 783 784 785
    }
}

void SessionManager::restoreEditors(const Utils::PersistentSettingsReader &reader)
{
    const QVariant &editorsettings = reader.restoreValue(QLatin1String("EditorSettings"));
    if (editorsettings.isValid()) {
Robert Loehning's avatar
Robert Loehning committed
786
        connect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
787 788 789
                this, SLOT(sessionLoadingProgress()));
        ICore::editorManager()->restoreState(
            QByteArray::fromBase64(editorsettings.toByteArray()));
Robert Loehning's avatar
Robert Loehning committed
790
        disconnect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
791 792 793 794
                   this, SLOT(sessionLoadingProgress()));
    }
}

795 796 797
/*!
     \brief Loads a session, takes a session name (not filename).
*/
798 799 800 801 802 803 804 805 806 807 808
void SessionManager::restoreProjects(const QStringList &fileList)
{
    // indirectly adds projects to session
    // Keep projects that failed to load in the session!
    m_failedProjects = fileList;
    if (!fileList.isEmpty()) {
        QString errors;
        QList<Project *> projects = ProjectExplorerPlugin::instance()->openProjects(fileList, &errors);
        if (!errors.isEmpty())
            QMessageBox::critical(Core::ICore::mainWindow(), tr("Failed to open project"), errors);
        foreach (Project *p, projects)
809
            m_failedProjects.removeAll(p->document()->fileName());
810 811
    }
}
812

con's avatar
con committed
813 814 815 816 817 818 819 820 821 822
bool SessionManager::loadSession(const QString &session)
{
    // Do nothing if we have that session already loaded,
    // exception if the session is the default virgin session
    // we still want to be able to load the default session
    if (session == m_sessionName && !isDefaultVirgin())
        return true;

    if (!sessions().contains(session))
        return false;
823

824
    // Try loading the file
825
    Utils::FileName fileName = sessionNameToFileName(session);
826
    PersistentSettingsReader reader;
827
    if (fileName.toFileInfo().exists()) {
828 829
        if (!reader.load(fileName)) {
            QMessageBox::warning(0, tr("Error while restoring session"),
830
                                 tr("Could not restore session %1").arg(fileName.toUserOutput()));
831 832 833 834
            return false;
        }
    }

835 836
    m_loadingSession = true;

837 838 839 840
    // Allow everyone to set something in the session and before saving
    emit aboutToUnloadSession(m_sessionName);

    if (!isDefaultVirgin()) {
841 842
        if (!save()) {
            m_loadingSession = false;
843
            return false;
844
        }
845 846 847
    }

    // Clean up
848 849
    if (!ICore::editorManager()->closeAllEditors()) {
        m_loadingSession = false;
850
        return false;
851
    }
852 853 854 855 856 857 858

    setStartupProject(0);
    removeProjects(projects());

    m_failedProjects.clear();
    m_depMap.clear();
    m_values.clear();
859

860 861 862
    m_sessionName = session;
    updateWindowTitle();

863
    if (fileName.toFileInfo().exists()) {
864 865 866 867 868 869 870 871
        m_virginSession = false;

        ICore::progressManager()->addTask(m_future.future(), tr("Session"),
           QLatin1String("ProjectExplorer.SessionFile.Load"));

        restoreValues(reader);
        emit aboutToLoadSession(session);

872 873 874 875
        QColor c = QColor(reader.restoreValue(QLatin1String("Color")).toString());
        if (c.isValid())
            Utils::StyleHelper::setBaseColor(c);

876 877 878 879 880 881 882
        QStringList fileList =
            reader.restoreValue(QLatin1String("ProjectList")).toStringList();
        int openEditorsCount = reader.restoreValue(QLatin1String("OpenEditors")).toInt();

        m_future.setProgressRange(0, fileList.count() + openEditorsCount + 2);
        m_future.setProgressValue(1);

883 884 885 886
        // if one processEvents doesn't get the job done
        // just use two!
        QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
        QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
887 888 889 890 891 892 893 894 895 896
        restoreProjects(fileList);
        sessionLoadingProgress();
        restoreDependencies(reader);
        restoreStartupProject(reader);
        restoreEditors(reader);

        m_future.reportFinished();
        m_future = QFutureInterface<void>();

        // restore the active mode
897 898
        Id modeId = Id::fromSetting(value(QLatin1String("ActiveMode")));
        if (!modeId.isValid())
899
            modeId = Id(Core::Constants::MODE_EDIT);
900

901
        ModeManager::activateMode(modeId);
902 903
        ModeManager::setFocusToCurrentMode();
    } else {
904
        ModeManager::activateMode(Id(Core::Constants::MODE_EDIT));
905 906 907 908 909 910
        ModeManager::setFocusToCurrentMode();
    }
    emit sessionLoaded(session);

    // Starts a event loop, better do that at the very end
    askUserAboutFailedProjects();
911
    m_loadingSession = false;
912
    return true;
con's avatar
con committed
913 914 915 916
}

QString SessionManager::lastSession() const
{
917
    return ICore::settings()->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
con's avatar
con committed
918 919 920 921 922 923 924 925 926
}

SessionNode *SessionManager::sessionNode() const
{
    return m_sessionNode;
}

void SessionManager::reportProjectLoadingProgress()
{
927
    sessionLoadingProgress();
con's avatar
con committed
928 929
}

930
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
931
{
932
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
933
        m_virginSession = false;
934
}
con's avatar
con committed
935

936 937
void SessionManager::sessionLoadingProgress()
{
938
    m_future.setProgressValue(m_future.progressValue() + 1);
939 940
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
}
941

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
void SessionManager::projectDisplayNameChanged()
{
    Project *pro = qobject_cast<Project*>(sender());
    if (pro) {
        Node *currentNode = 0;
        if (ProjectExplorerPlugin::currentProject() == pro)
            currentNode = ProjectExplorerPlugin::instance()->currentNode();

        // Fix node sorting
        QList<ProjectNode *> nodes;
        nodes << pro->rootProjectNode();
        m_sessionNode->removeProjectNodes(nodes);
        m_sessionNode->addProjectNodes(nodes);

        if (currentNode)
            ProjectExplorerPlugin::instance()->setCurrentNode(currentNode);

        emit projectDisplayNameChanged(pro);
    }
}

963 964
QStringList ProjectExplorer::SessionManager::projectsForSessionName(const QString &session) const
{
965
    const Utils::FileName fileName = sessionNameToFileName(session);
966
    PersistentSettingsReader reader;
967
    if (fileName.toFileInfo().exists()) {
968
        if (!reader.load(fileName)) {
969
            qWarning() << "Could not restore session" << fileName.toUserOutput();
970 971 972 973 974
            return QStringList();
        }
    }
    return reader.restoreValue(QLatin1String("ProjectList")).toStringList();
}