filemanager.cpp 41.7 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
#include "filemanager.h"
hjk's avatar
hjk committed
31

32
#include "editormanager.h"
33
#include "ieditor.h"
34
#include "icore.h"
con's avatar
con committed
35
#include "ifile.h"
36 37
#include "iversioncontrol.h"
#include "mimedatabase.h"
con's avatar
con committed
38 39
#include "saveitemsdialog.h"
#include "vcsmanager.h"
40
#include "coreconstants.h"
con's avatar
con committed
41

hjk's avatar
hjk committed
42
#include <utils/qtcassert.h>
43
#include <utils/pathchooser.h>
44
#include <utils/reloadpromptutils.h>
hjk's avatar
hjk committed
45

con's avatar
con committed
46 47 48 49 50 51
#include <QtCore/QSettings>
#include <QtCore/QFileInfo>
#include <QtCore/QFile>
#include <QtCore/QDir>
#include <QtCore/QTimer>
#include <QtCore/QFileSystemWatcher>
52
#include <QtCore/QDateTime>
con's avatar
con committed
53 54
#include <QtGui/QFileDialog>
#include <QtGui/QMessageBox>
55
#include <QtGui/QMainWindow>
con's avatar
con committed
56 57

/*!
con's avatar
con committed
58
  \class Core::FileManager
con's avatar
con committed
59 60 61 62 63 64 65 66 67 68 69
  \mainclass
  \inheaderfile filemanager.h
  \brief Manages a set of IFile objects.

  The FileManager service monitors a set of IFile's. Plugins should register
  files they work with at the service. The files the IFile's point to will be
  monitored at filesystem level. If a file changes, the status of the IFile's
  will be adjusted accordingly. Furthermore, on application exit the user will
  be asked to save all modified files.

  Different IFile objects in the set can point to the same file in the
70
  filesystem. The monitoring for a IFile can be blocked by blockFileChange(), and
con's avatar
con committed
71 72
  enabled again by unblockFileChange().

73 74 75 76
  The functions expectFileChange() and unexpectFileChange() mark a file change
  as expected. On expected file changes all IFile objects are notified to reload
  themselves.

con's avatar
con committed
77 78 79 80 81 82 83 84 85
  The FileManager service also provides two convenience methods for saving
  files: saveModifiedFiles() and saveModifiedFilesSilently(). Both take a list
  of FileInterfaces as an argument, and return the list of files which were
  _not_ saved.

  The service also manages the list of recent files to be shown to the user
  (see addToRecentFiles() and recentFiles()).
 */

86 87 88 89 90 91
static const char settingsGroupC[] = "RecentFiles";
static const char filesKeyC[] = "Files";

static const char directoryGroupC[] = "Directories";
static const char projectDirectoryKeyC[] = "Projects";
static const char useProjectDirectoryKeyC[] = "UseProjectsDirectory";
con's avatar
con committed
92

93 94 95
namespace Core {
namespace Internal {

96
struct FileStateItem
97 98 99 100 101
{
    QDateTime modified;
    QFile::Permissions permissions;
};

102 103 104 105 106 107
struct FileState
{
    QMap<IFile *, FileStateItem> lastUpdatedState;
    FileStateItem expected;
};

dt's avatar
dt committed
108

109 110 111
struct FileManagerPrivate {
    explicit FileManagerPrivate(QObject *q, QMainWindow *mw);

dt's avatar
dt committed
112
    QMap<QString, FileState> m_states;
113
    QStringList m_changedFiles;
dt's avatar
dt committed
114
    QList<IFile *> m_filesWithoutWatch;
115
    QMap<IFile *, QStringList> m_filesWithWatch;
116 117 118 119 120 121 122 123

    QStringList m_recentFiles;
    static const int m_maxRecentFiles = 7;

    QString m_currentFile;

    QMainWindow *m_mainWindow;
    QFileSystemWatcher *m_fileWatcher;
124
    QFileSystemWatcher *m_linkWatcher;
125
    bool m_blockActivated;
126 127 128
    QString m_lastVisitedDirectory;
    QString m_projectsDirectory;
    bool m_useProjectsDirectory;
dt's avatar
dt committed
129 130 131 132 133
    // When we are callling into a IFile
    // we don't want to receive a changed()
    // signal
    // That makes the code easier
    IFile *m_blockedIFile;
134 135 136
};

FileManagerPrivate::FileManagerPrivate(QObject *q, QMainWindow *mw) :
con's avatar
con committed
137
    m_mainWindow(mw),
138
    m_fileWatcher(new QFileSystemWatcher(q)),
139 140 141
    m_blockActivated(false),
    m_lastVisitedDirectory(QDir::currentPath()),
#ifdef Q_OS_MAC  // Creator is in bizarre places when launched via finder.
dt's avatar
dt committed
142
    m_useProjectsDirectory(true),
143
#else
dt's avatar
dt committed
144
    m_useProjectsDirectory(false),
145
#endif
dt's avatar
dt committed
146
    m_blockedIFile(0)
con's avatar
con committed
147
{
148 149 150 151 152 153 154 155 156 157
    q->connect(m_fileWatcher, SIGNAL(fileChanged(QString)),
        q, SLOT(changedFile(QString)));
#ifdef Q_OS_UNIX
    m_linkWatcher = new QFileSystemWatcher(q);
    m_linkWatcher->setObjectName(QLatin1String("_qt_autotest_force_engine_poller"));
    q->connect(m_linkWatcher, SIGNAL(fileChanged(QString)),
        q, SLOT(changedFile(QString)));
#else
    m_linkWatcher = m_fileWatcher;
#endif
158 159 160 161 162 163 164 165 166 167
}

} // namespace Internal

FileManager::FileManager(QMainWindow *mw)
  : QObject(mw),
    d(new Internal::FileManagerPrivate(this, mw))
{
    Core::ICore *core = Core::ICore::instance();
    connect(d->m_mainWindow, SIGNAL(windowActivated()),
con's avatar
con committed
168
        this, SLOT(mainWindowActivated()));
hjk's avatar
hjk committed
169
    connect(core, SIGNAL(contextChanged(Core::IContext*,Core::Context)),
con's avatar
con committed
170 171
        this, SLOT(syncWithEditor(Core::IContext*)));

172
    readSettings();
con's avatar
con committed
173 174
}

175 176 177 178 179
FileManager::~FileManager()
{
    delete d;
}

con's avatar
con committed
180
/*!
con's avatar
con committed
181
    \fn bool FileManager::addFiles(const QList<IFile *> &files, bool addWatcher)
con's avatar
con committed
182

con's avatar
con committed
183 184 185
    Adds a list of IFile's to the collection. If \a addWatcher is true (the default),
    the files are added to a file system watcher that notifies the file manager
    about file changes.
con's avatar
con committed
186
*/
con's avatar
con committed
187
void FileManager::addFiles(const QList<IFile *> &files, bool addWatcher)
con's avatar
con committed
188
{
dt's avatar
dt committed
189 190 191
    if (!addWatcher) {
        // We keep those in a separate list

192 193 194 195 196 197
        foreach(IFile *file, files) {
            if (file && !d->m_filesWithoutWatch.contains(file)) {
                connect(file, SIGNAL(destroyed(QObject *)), this, SLOT(fileDestroyed(QObject *)));
                d->m_filesWithoutWatch.append(file);
            }
        }
con's avatar
con committed
198
        return;
dt's avatar
dt committed
199 200
    }

con's avatar
con committed
201
    foreach (IFile *file, files) {
202 203 204 205 206
        if (file && !d->m_filesWithWatch.contains(file)) {
            connect(file, SIGNAL(changed()), this, SLOT(checkForNewFileName()));
            connect(file, SIGNAL(destroyed(QObject *)), this, SLOT(fileDestroyed(QObject *)));
            addFileInfo(file);
        }
con's avatar
con committed
207 208 209
    }
}

210 211 212 213
/* Adds the IFile's file and possibly it's final link target to both m_states
   (if it's file name is not empty), and the m_filesWithWatch list,
   and adds a file watcher for each if not already done.
   (The added file names are guaranteed to be absolute and cleaned.) */
dt's avatar
dt committed
214
void FileManager::addFileInfo(IFile *file)
215
{
216 217 218 219 220 221
    const QString fixedName = fixFileName(file->fileName(), KeepLinks);
    const QString fixedResolvedName = fixFileName(file->fileName(), ResolveLinks);
    addFileInfo(fixedResolvedName, file, false);
    if (fixedName != fixedResolvedName)
        addFileInfo(fixedName, file, true);
}
222

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
/* only called from addFileInfo(IFile *) */
void FileManager::addFileInfo(const QString &fileName, IFile *file, bool isLink)
{
    Internal::FileStateItem state;
    if (!fileName.isEmpty()) {
        const QFileInfo fi(fileName);
        state.modified = fi.lastModified();
        state.permissions = fi.permissions();
        // Add watcher if we don't have that already
        if (!d->m_states.contains(fileName)) {
            d->m_states.insert(fileName, Internal::FileState());

            if (isLink)
                d->m_linkWatcher->addPath(fileName);
            else
                d->m_fileWatcher->addPath(fileName);
239
        }
240
        d->m_states[fileName].lastUpdatedState.insert(file, state);
241
    }
242
    d->m_filesWithWatch[file].append(fileName); // inserts a new QStringList if not already there
243 244
}

245 246
/* Updates the time stamp and permission information of the files
   registered for this IFile (in m_filesWithWatch; can be the IFile's file + final link target) */
247 248
void FileManager::updateFileInfo(IFile *file)
{
249 250 251 252 253 254 255 256 257 258 259 260
    foreach (const QString &fileName, d->m_filesWithWatch.value(file)) {
        // If the filename is empty there's nothing to do
        if (fileName.isEmpty())
            continue;
        const QFileInfo fi(fileName);
        Internal::FileStateItem item;
        item.modified = fi.lastModified();
        item.permissions = fi.permissions();
        QTC_ASSERT(d->m_states.contains(fileName), continue);
        QTC_ASSERT(d->m_states.value(fileName).lastUpdatedState.contains(file), continue);
        d->m_states[fileName].lastUpdatedState.insert(file, item);
    }
261 262
}

dt's avatar
dt committed
263 264 265 266
/// Dumps the state of the file manager's map
/// For debugging purposes
void FileManager::dump()
{
267
    qDebug() << "======== dumping state map";
dt's avatar
dt committed
268 269 270 271 272
    QMap<QString, Internal::FileState>::const_iterator it, end;
    it = d->m_states.constBegin();
    end = d->m_states.constEnd();
    for (; it != end; ++it) {
        qDebug() << it.key();
273
        qDebug() << "   expected:" << it.value().expected.modified;
dt's avatar
dt committed
274 275 276 277 278

        QMap<IFile *, Internal::FileStateItem>::const_iterator jt, jend;
        jt = it.value().lastUpdatedState.constBegin();
        jend = it.value().lastUpdatedState.constEnd();
        for (; jt != jend; ++jt) {
279
            qDebug() << "  " << jt.key()->fileName() << jt.value().modified;
dt's avatar
dt committed
280 281
        }
    }
282 283 284 285 286 287 288 289
    qDebug() << "------- dumping files with watch list";
    foreach (IFile *key, d->m_filesWithWatch.keys()) {
        qDebug() << key->fileName() << d->m_filesWithWatch.value(key);
    }
    qDebug() << "------- dumping watch list";
    qDebug() << d->m_fileWatcher->files();
    qDebug() << "------- dumping link watch list";
    qDebug() << d->m_linkWatcher->files();
dt's avatar
dt committed
290 291
}

292 293 294 295 296 297 298 299 300 301 302
/*!
    \fn void FileManager::renamedFile(const QString &from, QString &to)
    \brief Tells the file manager that a file has been renamed on disk from within Qt Creator.

    Needs to be called right after the actual renaming on disk (i.e. before the file system
    watcher can report the event during the next event loop run). \a from needs to be an absolute file path.
    This will notify all IFile objects pointing to that file of the rename
    by calling IFile::rename, and update the cached time and permission
    information to avoid annoying the user with "file has been removed"
    popups.
*/
dt's avatar
dt committed
303 304
void FileManager::renamedFile(const QString &from, QString &to)
{
305
    const QString &fixedFrom = fixFileName(from, KeepLinks);
dt's avatar
dt committed
306

307 308 309 310 311 312 313
    // gather the list of IFiles
    QList<IFile *> filesToRename;
    QMapIterator<IFile *, QStringList> it(d->m_filesWithWatch);
    while (it.hasNext()) {
        it.next();
        if (it.value().contains(fixedFrom))
            filesToRename.append(it.key());
314 315
    }

316 317 318 319 320 321 322 323
    // rename the IFiles
    foreach (IFile *file, filesToRename) {
        d->m_blockedIFile = file;
        removeFileInfo(file);
        file->rename(to);
        addFileInfo(file);
        d->m_blockedIFile = 0;
    }
324 325
}

326 327 328 329 330
/* Removes all occurrances of the IFile from m_filesWithWatch and m_states.
   If that results in a file no longer being referenced by any IFile, this
   also removes the file watcher.
*/
void FileManager::removeFileInfo(IFile *file)
331
{
332 333 334 335 336 337 338 339 340 341 342 343 344
    if (!d->m_filesWithWatch.contains(file))
        return;
    foreach (const QString &fileName, d->m_filesWithWatch.value(file)) {
        if (!d->m_states.contains(fileName))
            continue;
        d->m_states[fileName].lastUpdatedState.remove(file);
        if (d->m_states.value(fileName).lastUpdatedState.isEmpty()) {
            if (d->m_fileWatcher->files().contains(fileName))
                d->m_fileWatcher->removePath(fileName);
            if (d->m_linkWatcher->files().contains(fileName))
                d->m_linkWatcher->removePath(fileName);
            d->m_states.remove(fileName);
        }
345
    }
346
    d->m_filesWithWatch.remove(file);
347 348
}

con's avatar
con committed
349
/*!
con's avatar
con committed
350
    \fn bool FileManager::addFile(IFile *files, bool addWatcher)
con's avatar
con committed
351

con's avatar
con committed
352 353 354
    Adds a IFile object to the collection. If \a addWatcher is true (the default),
    the file is added to a file system watcher that notifies the file manager
    about file changes.
con's avatar
con committed
355
*/
con's avatar
con committed
356
void FileManager::addFile(IFile *file, bool addWatcher)
con's avatar
con committed
357
{
con's avatar
con committed
358
    addFiles(QList<IFile *>() << file, addWatcher);
con's avatar
con committed
359 360 361 362 363
}

void FileManager::fileDestroyed(QObject *obj)
{
    IFile *file = static_cast<IFile*>(obj);
dt's avatar
dt committed
364 365 366 367 368
    // Check the special unwatched first:
    if (d->m_filesWithoutWatch.contains(file)) {
        d->m_filesWithoutWatch.removeOne(file);
        return;
    }
369
    removeFileInfo(file);
con's avatar
con committed
370 371 372 373 374 375 376 377 378
}

/*!
    \fn bool FileManager::removeFile(IFile *file)

    Removes a IFile object from the collection.

    Returns true if the file specified by \a file has been part of the file list.
*/
con's avatar
con committed
379
void FileManager::removeFile(IFile *file)
con's avatar
con committed
380
{
381
    QTC_ASSERT(file, return);
con's avatar
con committed
382

dt's avatar
dt committed
383 384 385 386
    // Special casing unwatched files
    if (d->m_filesWithoutWatch.contains(file)) {
        disconnect(file, SIGNAL(destroyed(QObject *)), this, SLOT(fileDestroyed(QObject *)));
        d->m_filesWithoutWatch.removeOne(file);
con's avatar
con committed
387
        return;
dt's avatar
dt committed
388 389
    }

390
    removeFileInfo(file);
con's avatar
con committed
391 392 393 394
    disconnect(file, SIGNAL(changed()), this, SLOT(checkForNewFileName()));
    disconnect(file, SIGNAL(destroyed(QObject *)), this, SLOT(fileDestroyed(QObject *)));
}

395 396
/* Slot reacting on IFile::changed. We need to check if the signal was sent
   because the file was saved under different name. */
con's avatar
con committed
397 398 399
void FileManager::checkForNewFileName()
{
    IFile *file = qobject_cast<IFile *>(sender());
dt's avatar
dt committed
400 401 402 403
    // We modified the IFile
    // Trust the other code to also update the m_states map
    if (file == d->m_blockedIFile)
        return;
hjk's avatar
hjk committed
404
    QTC_ASSERT(file, return);
405
    QTC_ASSERT(d->m_filesWithWatch.contains(file), return);
406

407
    // Maybe the name has changed or file has been deleted and created again ...
408 409
    // This also updates the state to the on disk state
    removeFileInfo(file);
dt's avatar
dt committed
410
    addFileInfo(file);
con's avatar
con committed
411 412
}

413 414 415 416 417 418 419
/*!
    \fn QString FileManager::fixFileName(const QString &fileName, FixMode fixmode)
    Returns a guaranteed cleaned path in native form. If the file exists,
    it will either be a cleaned absolute file path (fixmode == KeepLinks), or
    a cleaned canonical file path (fixmode == ResolveLinks).
*/
QString FileManager::fixFileName(const QString &fileName, FixMode fixmode)
con's avatar
con committed
420 421
{
    QString s = fileName;
422
    QFileInfo fi(s);
423 424 425 426 427 428 429 430 431
    if (fi.exists()) {
        if (fixmode == ResolveLinks)
            s = fi.canonicalFilePath();
        else
            s = QDir::cleanPath(fi.absoluteFilePath());
    } else {
        s = QDir::cleanPath(s);
    }
    s = QDir::toNativeSeparators(s);
con's avatar
con committed
432 433 434
#ifdef Q_OS_WIN
    s = s.toLower();
#endif
435
    return s;
con's avatar
con committed
436 437 438 439 440 441 442 443 444 445 446
}

/*!
    \fn QList<IFile*> FileManager::modifiedFiles() const

    Returns the list of IFile's that have been modified.
*/
QList<IFile *> FileManager::modifiedFiles() const
{
    QList<IFile *> modifiedFiles;

447 448 449
    foreach (IFile *file, d->m_filesWithWatch.keys()) {
        if (file->isModified())
            modifiedFiles << file;
con's avatar
con committed
450
    }
451

dt's avatar
dt committed
452 453 454 455 456
    foreach(IFile *file, d->m_filesWithoutWatch) {
        if (file->isModified())
            modifiedFiles << file;
    }

con's avatar
con committed
457 458 459 460 461 462 463 464 465 466
    return modifiedFiles;
}

/*!
    \fn void FileManager::blockFileChange(IFile *file)

    Blocks the monitoring of the file the \a file argument points to.
*/
void FileManager::blockFileChange(IFile *file)
{
467 468
    // Nothing to do
    Q_UNUSED(file);
con's avatar
con committed
469 470 471 472 473 474 475 476 477
}

/*!
    \fn void FileManager::unblockFileChange(IFile *file)

    Enables the monitoring of the file the \a file argument points to, and update the status of the corresponding IFile's.
*/
void FileManager::unblockFileChange(IFile *file)
{
478 479 480 481 482 483 484 485 486 487 488
    // We are updating the lastUpdated time to the current modification time
    // in changedFile we'll compare the modification time with the last updated
    // time, and if they are the same, then we don't deliver that notification
    // to corresponding IFile
    //
    // Also we are updating the expected time of the file
    // in changedFile we'll check if the modification time
    // is the same as the saved one here
    // If so then it's a expected change

    updateFileInfo(file);
489 490
    foreach (const QString &fileName, d->m_filesWithWatch.value(file))
        updateExpectedState(fileName);
con's avatar
con committed
491 492
}

493 494 495 496 497 498 499 500
/*!
    \fn void FileManager::expectFileChange(const QString &fileName)

    Any subsequent change to \a fileName is treated as a expected file change.

    \see FileManager::unexpectFileChange(const QString &fileName)
*/
void FileManager::expectFileChange(const QString &fileName)
con's avatar
con committed
501
{
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
    // Nothing to do
    Q_UNUSED(fileName);
}

/*!
    \fn void FileManager::unexpectFileChange(const QString &fileName)

    Any change to \a fileName are unexpected again.

    \see FileManager::expectFileChange(const QString &fileName)
*/
void FileManager::unexpectFileChange(const QString &fileName)
{
    // We are updating the expected time of the file
    // And in changedFile we'll check if the modification time
    // is the same as the saved one here
    // If so then it's a expected change

520 521 522 523 524 525 526
    if (fileName.isEmpty())
        return;
    const QString fixedName = fixFileName(fileName, KeepLinks);
    updateExpectedState(fixedName);
    const QString fixedResolvedName = fixFileName(fileName, ResolveLinks);
    if (fixedName != fixedResolvedName)
        updateExpectedState(fixedResolvedName);
527 528
}

529
/* only called from unblock and unexpect file change methods */
530 531
void FileManager::updateExpectedState(const QString &fileName)
{
532
    if (fileName.isEmpty())
533
        return;
534 535 536 537
    if (d->m_states.contains(fileName)) {
        QFileInfo fi(fileName);
        d->m_states[fileName].expected.modified = fi.lastModified();
        d->m_states[fileName].expected.permissions = fi.permissions();
dt's avatar
dt committed
538
    }
con's avatar
con committed
539 540 541 542 543 544 545 546 547 548 549 550 551
}

/*!
    \fn QList<IFile*> FileManager::saveModifiedFilesSilently(const QList<IFile*> &files)

    Tries to save the files listed in \a files . Returns the files that could not be saved.
*/
QList<IFile *> FileManager::saveModifiedFilesSilently(const QList<IFile *> &files)
{
    return saveModifiedFiles(files, 0, true, QString());
}

/*!
con's avatar
con committed
552 553 554 555 556 557 558 559 560 561
    \fn QList<IFile*> FileManager::saveModifiedFiles(const QList<IFile *> &files, bool *cancelled, const QString &message, const QString &alwaysSaveMessage, bool *alwaysSave)

    Asks the user whether to save the files listed in \a files .
    Opens a dialog with the given \a message, and a additional
    text that should be used to ask if the user wants to enabled automatic save
    of modified files (in this context).
    The \a cancelled argument is set to true if the user cancelled the dialog,
    \a alwaysSave is set to match the selection of the user, if files should
    always automatically be saved.
    Returns the files that have not been saved.
con's avatar
con committed
562 563
*/
QList<IFile *> FileManager::saveModifiedFiles(const QList<IFile *> &files,
564 565 566
                                              bool *cancelled, const QString &message,
                                              const QString &alwaysSaveMessage,
                                              bool *alwaysSave)
con's avatar
con committed
567
{
568
    return saveModifiedFiles(files, cancelled, false, message, alwaysSaveMessage, alwaysSave);
con's avatar
con committed
569 570 571 572 573
}

static QMessageBox::StandardButton skipFailedPrompt(QWidget *parent, const QString &fileName)
{
    return QMessageBox::question(parent,
574 575
                                 FileManager::tr("Cannot save file"),
                                 FileManager::tr("Cannot save changes to '%1'. Do you want to continue and lose your changes?").arg(fileName),
con's avatar
con committed
576 577 578 579 580
                                 QMessageBox::YesToAll| QMessageBox::Yes|QMessageBox::No,
                                 QMessageBox::No);
}

QList<IFile *> FileManager::saveModifiedFiles(const QList<IFile *> &files,
581 582 583 584 585
                                              bool *cancelled,
                                              bool silently,
                                              const QString &message,
                                              const QString &alwaysSaveMessage,
                                              bool *alwaysSave)
con's avatar
con committed
586 587 588 589 590
{
    if (cancelled)
        (*cancelled) = false;

    QList<IFile *> notSaved;
591 592
    QMap<IFile *, QString> modifiedFilesMap;
    QList<IFile *> modifiedFiles;
con's avatar
con committed
593 594 595 596 597 598 599 600 601

    foreach (IFile *file, files) {
        if (file->isModified()) {
            QString name = file->fileName();
            if (name.isEmpty())
                name = file->suggestedFileName();

            // There can be several FileInterfaces pointing to the same file
            // Select one that is not readonly.
con's avatar
con committed
602 603
            if (!(modifiedFilesMap.key(name, 0)
                    && file->isReadOnly()))
604
                modifiedFilesMap.insert(file, name);
con's avatar
con committed
605 606
        }
    }
607
    modifiedFiles = modifiedFilesMap.keys();
con's avatar
con committed
608 609 610
    if (!modifiedFiles.isEmpty()) {
        QList<IFile *> filesToSave;
        if (silently) {
611
            filesToSave = modifiedFiles;
con's avatar
con committed
612
        } else {
613
            Internal::SaveItemsDialog dia(d->m_mainWindow, modifiedFiles);
con's avatar
con committed
614 615
            if (!message.isEmpty())
                dia.setMessage(message);
616 617
            if (!alwaysSaveMessage.isNull())
                dia.setAlwaysSaveMessage(alwaysSaveMessage);
con's avatar
con committed
618 619 620
            if (dia.exec() != QDialog::Accepted) {
                if (cancelled)
                    (*cancelled) = true;
621 622
                if (alwaysSave)
                    *alwaysSave = dia.alwaysSaveChecked();
623
                notSaved = modifiedFiles;
con's avatar
con committed
624 625
                return notSaved;
            }
626 627
            if (alwaysSave)
                *alwaysSave = dia.alwaysSaveChecked();
con's avatar
con committed
628 629 630 631
            filesToSave = dia.itemsToSave();
        }

        bool yestoall = false;
632
        Core::VCSManager *vcsManager = Core::ICore::instance()->vcsManager();
con's avatar
con committed
633
        foreach (IFile *file, filesToSave) {
634
            if (file->isReadOnly()) {
635 636
                const QString directory = QFileInfo(file->fileName()).absolutePath();
                if (IVersionControl *versionControl = vcsManager->findVersionControlForDirectory(directory))
con's avatar
con committed
637 638 639 640 641 642 643 644 645 646 647 648
                    versionControl->vcsOpen(file->fileName());
            }
            if (!file->isReadOnly() && !file->fileName().isEmpty()) {
                blockFileChange(file);
                const bool ok = file->save();
                unblockFileChange(file);
                if (!ok)
                    notSaved.append(file);
            } else if (QFile::exists(file->fileName()) && !file->isSaveAsAllowed()) {
                if (yestoall)
                    continue;
                const QFileInfo fi(file->fileName());
649
                switch (skipFailedPrompt(d->m_mainWindow, fi.fileName())) {
con's avatar
con committed
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
                case QMessageBox::YesToAll:
                    yestoall = true;
                    break;
                case QMessageBox::No:
                    if (cancelled)
                        *cancelled = true;
                    return filesToSave;
                default:
                    break;
                }
            } else {
                QString fileName = getSaveAsFileName(file);
                bool ok = false;
                if (!fileName.isEmpty()) {
                    blockFileChange(file);
                    ok = file->save(fileName);
666
                    file->checkPermissions();
con's avatar
con committed
667 668 669 670 671 672 673 674 675 676
                    unblockFileChange(file);
                }
                if (!ok)
                    notSaved.append(file);
            }
        }
    }
    return notSaved;
}

677 678
QString FileManager::getSaveFileName(const QString &title, const QString &pathIn,
                                     const QString &filter, QString *selectedFilter)
con's avatar
con committed
679
{
680
    const QString &path = pathIn.isEmpty() ? fileDialogInitialDirectory() : pathIn;
con's avatar
con committed
681 682 683 684
    QString fileName;
    bool repeat;
    do {
        repeat = false;
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
        fileName = QFileDialog::getSaveFileName(
            d->m_mainWindow, title, path, filter, selectedFilter, QFileDialog::DontConfirmOverwrite);
        if (!fileName.isEmpty()) {
            // If the selected filter is All Files (*) we leave the name exactly as the user
            // specified. Otherwise the suffix must be one available in the selected filter. If
            // the name already ends with such suffix nothing needs to be done. But if not, the
            // first one from the filter is appended.
            if (selectedFilter && *selectedFilter != QCoreApplication::translate(
                    "Core", Constants::ALL_FILES_FILTER)) {
                // Mime database creates filter strings like this: Anything here (*.foo *.bar)
                QRegExp regExp(".*\\s+\\((.*)\\)$");
                const int index = regExp.lastIndexIn(*selectedFilter);
                bool suffixOk = false;
                if (index != -1) {
                    const QStringList &suffixes = regExp.cap(1).remove('*').split(' ');
                    foreach (const QString &suffix, suffixes)
                        if (fileName.endsWith(suffix)) {
                            suffixOk = true;
                            break;
                        }
                    if (!suffixOk && !suffixes.isEmpty())
                        fileName.append(suffixes.at(0));
                }
            }
con's avatar
con committed
709
            if (QFile::exists(fileName)) {
710
                if (QMessageBox::warning(d->m_mainWindow, tr("Overwrite?"),
711 712 713
                    tr("An item named '%1' already exists at this location. "
                       "Do you want to overwrite it?").arg(fileName),
                    QMessageBox::Yes | QMessageBox::No) == QMessageBox::No) {
con's avatar
con committed
714
                    repeat = true;
715
                }
con's avatar
con committed
716 717 718
            }
        }
    } while (repeat);
719 720
    if (!fileName.isEmpty())
        setFileDialogLastVisitedDirectory(QFileInfo(fileName).absolutePath());
con's avatar
con committed
721 722 723
    return fileName;
}

724 725 726 727 728 729 730
QString FileManager::getSaveFileNameWithExtension(const QString &title, const QString &pathIn,
                                                  const QString &filter)
{
    QString selected = filter;
    return getSaveFileName(title, pathIn, filter, &selected);
}

con's avatar
con committed
731 732 733 734 735
/*!
    \fn QString FileManager::getSaveAsFileName(IFile *file)

    Asks the user for a new file name (Save File As) for /arg file.
*/
736
QString FileManager::getSaveAsFileName(IFile *file, const QString &filter, QString *selectedFilter)
con's avatar
con committed
737 738 739 740 741 742 743 744 745 746 747 748 749
{
    if (!file)
        return QLatin1String("");
    QString absoluteFilePath = file->fileName();
    const QFileInfo fi(absoluteFilePath);
    QString fileName = fi.fileName();
    QString path = fi.absolutePath();
    if (absoluteFilePath.isEmpty()) {
        fileName = file->suggestedFileName();
        const QString defaultPath = file->defaultPath();
        if (!defaultPath.isEmpty())
            path = defaultPath;
    }
750

con's avatar
con committed
751
    QString filterString;
752 753 754 755 756 757
    if (filter.isEmpty()) {
        if (const MimeType &mt = Core::ICore::instance()->mimeDatabase()->findByFile(fi))
            filterString = mt.filterString();
        selectedFilter = &filterString;
    } else {
        filterString = filter;
con's avatar
con committed
758 759
    }

760
    absoluteFilePath = getSaveFileName(tr("Save File As"),
con's avatar
con committed
761 762
        path + QDir::separator() + fileName,
        filterString,
763
        selectedFilter);
con's avatar
con committed
764 765 766
    return absoluteFilePath;
}

767
/*!
con's avatar
con committed
768
    \fn QString FileManager::getOpenFileNames(const QString &filters, const QString &pathIn, QString *selectedFilter) const
769

con's avatar
con committed
770 771 772 773
    Asks the user for a set of file names to be opened. The \a filters
    and \a selectedFilter parameters is interpreted like in
    QFileDialog::getOpenFileNames(), \a pathIn specifies a path to open the dialog
    in, if that is not overridden by the users policy.
774 775 776 777 778 779
*/

QStringList FileManager::getOpenFileNames(const QString &filters,
                                          const QString pathIn,
                                          QString *selectedFilter)
{
780 781 782 783
    QString path = pathIn;
    if (path.isEmpty()) {
        if (!d->m_currentFile.isEmpty())
            path = QFileInfo(d->m_currentFile).absoluteFilePath();
784 785
        if (path.isEmpty() && useProjectsDirectory())
            path = projectsDirectory();
786
    }
787 788 789 790 791 792 793 794 795 796
    const QStringList files = QFileDialog::getOpenFileNames(d->m_mainWindow,
                                                      tr("Open File"),
                                                      path, filters,
                                                      selectedFilter);
    if (!files.isEmpty())
        setFileDialogLastVisitedDirectory(QFileInfo(files.front()).absolutePath());
    return files;
}


797
void FileManager::changedFile(const QString &fileName)
con's avatar
con committed
798
{
799
    const bool wasempty = d->m_changedFiles.isEmpty();
800

801 802
    if (!d->m_changedFiles.contains(fileName) && d->m_states.contains(fileName))
        d->m_changedFiles.append(fileName);
803

804
    if (wasempty && !d->m_changedFiles.isEmpty()) {
805
        QTimer::singleShot(200, this, SLOT(checkForReload()));
con's avatar
con committed
806 807 808 809 810
    }
}

void FileManager::mainWindowActivated()
{
811 812 813 814
    //we need to do this asynchronously because
    //opening a dialog ("Reload?") in a windowactivated event
    //freezes on Mac
    QTimer::singleShot(0, this, SLOT(checkForReload()));
con's avatar
con committed
815 816 817 818
}

void FileManager::checkForReload()
{
819 820
    if (d->m_changedFiles.isEmpty())
        return;
821 822
    if (QApplication::activeWindow() != d->m_mainWindow)
        return;
con's avatar
con committed
823

824 825 826 827 828
    if (d->m_blockActivated)
        return;

    d->m_blockActivated = true;

829 830
    IFile::ReloadSetting defaultBehavior = EditorManager::instance()->reloadSetting();
    Utils::ReloadPromptAnswer previousAnswer = Utils::ReloadCurrent;
831

832 833
    QList<IEditor*> editorsToClose;
    QMap<IFile*, QString> filesToSave;
834 835 836 837 838

    // collect file information
    QMap<QString, Internal::FileStateItem> currentStates;
    QMap<QString, IFile::ChangeType> changeTypes;
    QSet<IFile *> changedIFiles;
839 840
    foreach (const QString &fileName, d->m_changedFiles) {
        IFile::ChangeType type = IFile::TypeContents;
841
        Internal::FileStateItem state;
842
        QFileInfo fi(fileName);
843 844 845
        if (!fi.exists()) {
            type = IFile::TypeRemoved;
        } else {
846 847
            state.modified = fi.lastModified();
            state.permissions = fi.permissions();
848
        }
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
        currentStates.insert(fileName, state);
        changeTypes.insert(fileName, type);
        foreach (IFile *file, d->m_states.value(fileName).lastUpdatedState.keys())
            changedIFiles.insert(file);
    }

    // handle the IFiles
    foreach (IFile *file, changedIFiles) {
        IFile::ChangeTrigger behavior = IFile::TriggerInternal;
        IFile::ChangeType type = IFile::TypePermissions;
        bool changed = false;
        // find out the type & behavior from the two possible files
        // behavior is internal if all changes are expected (and none removed)
        // type is "max" of both types (remove > contents > permissions)
        foreach (const QString & fileName, d->m_filesWithWatch.value(file)) {
            // was the file reported?
            if (!currentStates.contains(fileName))
                continue;
867

868 869 870 871 872
            Internal::FileStateItem currentState = currentStates.value(fileName);
            Internal::FileStateItem expectedState = d->m_states.value(fileName).expected;
            Internal::FileStateItem lastState = d->m_states.value(fileName).lastUpdatedState.value(file);
            // did the file actually change?
            if (lastState.modified == currentState.modified && lastState.permissions == currentState.permissions)
873
                continue;
874 875 876 877 878 879 880 881 882
            changed = true;

            // was it only a permission change?
            if (lastState.modified == currentState.modified)
                continue;

            // was the change unexpected?
            if (currentState.modified != expectedState.modified || currentState.permissions != expectedState.permissions) {
                behavior = IFile::TriggerExternal;
883
            }
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922

            // find out the type
            IFile::ChangeType fileChange = changeTypes.value(fileName);
            if (fileChange == IFile::TypeRemoved) {
                type = IFile::TypeRemoved;
                behavior = IFile::TriggerExternal; // removed files always trigger externally
            } else if (fileChange == IFile::TypeContents && type == IFile::TypePermissions) {
                type = IFile::TypeContents;
            }
        }

        if (!changed) // probably because the change was blocked with (un)blockFileChange
            continue;

        // handle it!
        d->m_blockedIFile = file;

        // we've got some modification
        // check if it's contents or permissions:
        if (type == IFile::TypePermissions) {
            // Only permission change
            file->reload(IFile::FlagReload, IFile::TypePermissions);
        // now we know it's a content change or file was removed
        } else if (defaultBehavior == IFile::ReloadUnmodified
                   && type == IFile::TypeContents && !file->isModified()) {
            // content change, but unmodified (and settings say to reload in this case)
            file->reload(IFile::FlagReload, type);
        // file was removed or it's a content change and the default behavior for
        // unmodified files didn't kick in
        } else if (defaultBehavior == IFile::IgnoreAll) {
            // content change or removed, but settings say ignore
            file->reload(IFile::FlagIgnore, type);
        // either the default behavior is to always ask,
        // or the ReloadUnmodified default behavior didn't kick in,
        // so do whatever the IFile wants us to do
        } else {
            // check if IFile wants us to ask
            if (file->reloadBehavior(behavior, type) == IFile::BehaviorSilent) {
                // content change or removed, IFile wants silent handling
923
                file->reload(IFile::FlagReload, type);
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
            // IFile wants us to ask
            } else if (type == IFile::TypeContents) {
                // content change, IFile wants to ask user
                if (previousAnswer == Utils::ReloadNone) {
                    // answer already given, ignore
                    file->reload(IFile::FlagIgnore, IFile::TypeContents);
                } else if (previousAnswer == Utils::ReloadAll) {
                    // answer already given, reload
                    file->reload(IFile::FlagReload, IFile::TypeContents);
                } else {
                    // Ask about content change
                    previousAnswer = Utils::reloadPrompt(file->fileName(), file->isModified(), QApplication::activeWindow());
                    switch (previousAnswer) {
                    case Utils::ReloadAll:
                    case Utils::ReloadCurrent:
939
                        file->reload(IFile::FlagReload, IFile::TypeContents);
940 941 942 943 944
                        break;
                    case Utils::ReloadSkipCurrent:
                    case Utils::ReloadNone:
                        file->reload(IFile::FlagIgnore, IFile::TypeContents);
                        break;
945
                    }
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
                }
            // IFile wants us to ask, and it's the TypeRemoved case
            } else {
                // Ask about removed file
                bool unhandled = true;
                while (unhandled) {
                    switch (Utils::fileDeletedPrompt(file->fileName(), QApplication::activeWindow())) {
                    case Utils::FileDeletedSave:
                        filesToSave.insert(file, file->fileName());
                        unhandled = false;
                        break;
                    case Utils::FileDeletedSaveAs:
                    {
                        const QString &saveFileName = getSaveAsFileName(file);
                        if (!saveFileName.isEmpty()) {
                            filesToSave.insert(file, saveFileName);
962 963
                            unhandled = false;
                        }
964 965 966 967 968 969
                        break;
                    }
                    case Utils::FileDeletedClose:
                        editorsToClose << EditorManager::instance()->editorsForFile(file);
                        unhandled = false;
                        break;
970 971
                    }
                }
con's avatar
con committed
972 973
            }
        }
974

975 976 977 978
        // update file info, also handling if e.g. link target has changed
        removeFileInfo(file);
        addFileInfo(file);
        d->m_blockedIFile = 0;
979
    }
980 981

    // clean up
982
    d->m_changedFiles.clear();
983 984 985 986 987 988 989 990 991

    // handle deleted files
    EditorManager::instance()->closeEditors(editorsToClose, false);
    QMapIterator<IFile *, QString> it(filesToSave);
    while (it.hasNext()) {
        it.next();
        blockFileChange(it.key());
        it.key()->save(it.value());
        unblockFileChange(it.key());
992
        it.key()->checkPermissions();
993 994
    }

995
    d->m_blockActivated = false;
996 997

//    dump();
con's avatar
con committed
998 999 1000 1001 1002 1003 1004
}

void FileManager::syncWithEditor(Core::IContext *context)
{
    if (!context)
        return;

1005
    Core::IEditor *editor = Core::EditorManager::instance()->currentEditor();
1006 1007
    if (editor && (editor->widget() == context->widget()) &&
        !editor->isTemporary())
con's avatar
con committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
        setCurrentFile(editor->file()->fileName());
}

/*!
    \fn void FileManager::addToRecentFiles(const QString &fileName)

    Adds the \a fileName to the list of recent files.
*/
void FileManager::addToRecentFiles(const QString &fileName)
{
    if (fileName.isEmpty())
        return;
1020
    QString unifiedForm(fixFileName(fileName, KeepLinks));
1021 1022
    QMutableStringListIterator it(d->m_recentFiles);
    while (it.hasNext()) {
1023
        QString recentUnifiedForm(fixFileName(it.next(), KeepLinks));
1024 1025 1026
        if (unifiedForm == recentUnifiedForm)
            it.remove();
    }
1027 1028
    if (d->m_recentFiles.count() > d->m_maxRecentFiles)
        d->m_recentFiles.removeLast();
1029
    d->m_recentFiles.prepend(fileName);
con's avatar
con committed
1030 1031 1032 1033 1034 1035 1036 1037 1038
}

/*!
    \fn QStringList FileManager::recentFiles() const

    Returns the list of recent files.
*/
QStringList FileManager::recentFiles() const
{
1039
    return d->m_recentFiles;
con's avatar
con committed
1040 1041
}

1042
void FileManager::saveSettings()
con's avatar
con committed
1043
{
1044
    QSettings *s = Core::ICore::instance()->settings();
1045 1046 1047 1048 1049 1050
    s->beginGroup(QLatin1String(settingsGroupC));
    s->setValue(QLatin1String(filesKeyC), d->m_recentFiles);
    s->endGroup();
    s->beginGroup(QLatin1String(directoryGroupC));
    s->setValue(QLatin1String(projectDirectoryKeyC), d->m_projectsDirectory);
    s->setValue(QLatin1String(useProjectDirectoryKeyC), d->m_useProjectsDirectory);
con's avatar
con committed
1051 1052 1053
    s->endGroup();
}

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
void FileManager::readSettings()
{
    const QSettings *s = Core::ICore::instance()->settings();
    d->m_recentFiles.clear();
    QStringList recentFiles = s->value(QLatin1String(settingsGroupC) + QLatin1Char('/') + QLatin1String(filesKeyC), QStringList()).toStringList();
    // clean non-existing files
    foreach (const QString &file, recentFiles) {
        if (QFileInfo(file).isFile())
            d->m_recentFiles.append(QDir::fromNativeSeparators(file)); // from native to guard against old settings
    }

    const QString directoryGroup = QLatin1String(directoryGroupC) + QLatin1Char('/');
    const QString settingsProjectDir = s->value(directoryGroup + QLatin1String(projectDirectoryKeyC),
                                       QString()).toString();
    if (!settingsProjectDir.isEmpty() && QFileInfo(settingsProjectDir).isDir()) {
        d->m_projectsDirectory = settingsProjectDir;
    } else {
        d->m_projectsDirectory = Utils::PathChooser::homePath();
    }
    d->m_useProjectsDirectory = s->value(directoryGroup + QLatin1String(useProjectDirectoryKeyC),
                                         d->m_useProjectsDirectory).toBool();
}

con's avatar
con committed
1077 1078 1079 1080 1081
/*!

  The current file is e.g. the file currently opened when an editor is active,
  or the selected file in case a Project Explorer is active ...

con's avatar
con committed
1082
  \sa currentFile
con's avatar
con committed
1083 1084 1085
  */
void FileManager::setCurrentFile(const QString &filePath)
{
1086
    if (d->m_currentFile == filePath)
con's avatar
con committed
1087
        return;
1088 1089
    d->m_currentFile = filePath;
    emit currentFileChanged(d->m_currentFile);
con's avatar
con committed