filemanager.cpp 44.3 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28 29
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33
#include "filemanager.h"
hjk's avatar
hjk committed
34

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

hjk's avatar
hjk committed
45
#include <utils/qtcassert.h>
46
#include <utils/pathchooser.h>
47
#include <utils/reloadpromptutils.h>
hjk's avatar
hjk committed
48

con's avatar
con committed
49 50 51 52 53 54
#include <QtCore/QSettings>
#include <QtCore/QFileInfo>
#include <QtCore/QFile>
#include <QtCore/QDir>
#include <QtCore/QTimer>
#include <QtCore/QFileSystemWatcher>
55
#include <QtCore/QDateTime>
con's avatar
con committed
56 57
#include <QtGui/QFileDialog>
#include <QtGui/QMessageBox>
58
#include <QtGui/QMainWindow>
59
#include <QtGui/QPushButton>
con's avatar
con committed
60 61

/*!
con's avatar
con committed
62
  \class Core::FileManager
con's avatar
con committed
63 64 65 66 67 68 69 70 71 72 73
  \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
74
  filesystem. The monitoring for a IFile can be blocked by blockFileChange(), and
con's avatar
con committed
75 76
  enabled again by unblockFileChange().

77 78 79 80
  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
81 82 83 84 85 86 87 88 89
  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()).
 */

90 91 92
static const char * const settingsGroupC = "RecentFiles";
static const char * const filesKeyC = "Files";
static const char * const editorsKeyC = "EditorIds";
93

94 95 96
static const char * const directoryGroupC = "Directories";
static const char * const projectDirectoryKeyC = "Projects";
static const char * const useProjectDirectoryKeyC = "UseProjectsDirectory";
con's avatar
con committed
97

98 99 100
namespace Core {
namespace Internal {

101
struct FileStateItem
102 103 104 105 106
{
    QDateTime modified;
    QFile::Permissions permissions;
};

107 108 109 110 111 112
struct FileState
{
    QMap<IFile *, FileStateItem> lastUpdatedState;
    FileStateItem expected;
};

dt's avatar
dt committed
113

114
struct FileManagerPrivate {
115
    explicit FileManagerPrivate(FileManager *q, QMainWindow *mw);
116 117
    QFileSystemWatcher *fileWatcher();
    QFileSystemWatcher *linkWatcher();
118

119
    static FileManager *m_instance;
dt's avatar
dt committed
120
    QMap<QString, FileState> m_states;
121
    QSet<QString> m_changedFiles;
dt's avatar
dt committed
122
    QList<IFile *> m_filesWithoutWatch;
123
    QMap<IFile *, QStringList> m_filesWithWatch;
124
    QSet<QString> m_expectedFileNames;
125

126
    QList<FileManager::RecentFile> m_recentFiles;
127 128 129 130 131
    static const int m_maxRecentFiles = 7;

    QString m_currentFile;

    QMainWindow *m_mainWindow;
132
    QFileSystemWatcher *m_fileWatcher; // Delayed creation.
133
    QFileSystemWatcher *m_linkWatcher; // Delayed creation (only UNIX/if a link is seen).
134
    bool m_blockActivated;
135 136 137
    QString m_lastVisitedDirectory;
    QString m_projectsDirectory;
    bool m_useProjectsDirectory;
dt's avatar
dt committed
138 139 140 141 142
    // When we are callling into a IFile
    // we don't want to receive a changed()
    // signal
    // That makes the code easier
    IFile *m_blockedIFile;
143 144
};

145
QFileSystemWatcher *FileManagerPrivate::fileWatcher()
146 147
{
    if (!m_fileWatcher) {
148
        m_fileWatcher= new QFileSystemWatcher(m_instance);
149 150 151
        QObject::connect(m_fileWatcher, SIGNAL(fileChanged(QString)),
                         m_instance, SLOT(changedFile(QString)));
    }
152
    return m_fileWatcher;
153 154
}

155
QFileSystemWatcher *FileManagerPrivate::linkWatcher()
156 157 158 159 160 161 162 163
{
#ifdef Q_OS_UNIX
    if (!m_linkWatcher) {
        m_linkWatcher = new QFileSystemWatcher(m_instance);
        m_linkWatcher->setObjectName(QLatin1String("_qt_autotest_force_engine_poller"));
        QObject::connect(m_linkWatcher, SIGNAL(fileChanged(QString)),
                         m_instance, SLOT(changedFile(QString)));
    }
164
    return m_linkWatcher;
165
#else
166
    return fileWatcher();
167 168 169
#endif
}

170 171 172
FileManager *FileManagerPrivate::m_instance = 0;

FileManagerPrivate::FileManagerPrivate(FileManager *q, QMainWindow *mw) :
con's avatar
con committed
173
    m_mainWindow(mw),
174 175
    m_fileWatcher(0),
    m_linkWatcher(0),
176 177 178
    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
179
    m_useProjectsDirectory(true),
180
#else
dt's avatar
dt committed
181
    m_useProjectsDirectory(false),
182
#endif
dt's avatar
dt committed
183
    m_blockedIFile(0)
con's avatar
con committed
184
{
185
    m_instance = q;
186 187 188 189 190 191 192 193 194 195
}

} // 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
196
        this, SLOT(mainWindowActivated()));
hjk's avatar
hjk committed
197
    connect(core, SIGNAL(contextChanged(Core::IContext*,Core::Context)),
con's avatar
con committed
198 199
        this, SLOT(syncWithEditor(Core::IContext*)));

200
    readSettings();
con's avatar
con committed
201 202
}

203 204 205 206 207
FileManager::~FileManager()
{
    delete d;
}

208 209 210 211 212
FileManager *FileManager::instance()
{
    return Internal::FileManagerPrivate::m_instance;
}

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

con's avatar
con committed
216 217 218
    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
219
*/
con's avatar
con committed
220
void FileManager::addFiles(const QList<IFile *> &files, bool addWatcher)
con's avatar
con committed
221
{
dt's avatar
dt committed
222 223 224
    if (!addWatcher) {
        // We keep those in a separate list

225
        foreach (IFile *file, files) {
226 227 228 229 230
            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
231
        return;
dt's avatar
dt committed
232 233
    }

con's avatar
con committed
234
    foreach (IFile *file, files) {
235 236 237 238 239
        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
240 241 242
    }
}

243 244 245 246
/* 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
247
void FileManager::addFileInfo(IFile *file)
248
{
249 250 251 252 253 254
    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);
}
255

256 257 258 259 260 261 262 263 264 265 266 267
/* 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());

268
        }
dt_'s avatar
dt_ committed
269 270 271 272 273 274 275 276
        QFileSystemWatcher *watcher = 0;
        if (isLink)
            watcher = d->linkWatcher();
        else
            watcher = d->fileWatcher();
        if (!watcher->files().contains(fileName))
            watcher->addPath(fileName);

277
        d->m_states[fileName].lastUpdatedState.insert(file, state);
278
    }
279
    d->m_filesWithWatch[file].append(fileName); // inserts a new QStringList if not already there
280 281
}

dt's avatar
dt committed
282 283 284 285
/// Dumps the state of the file manager's map
/// For debugging purposes
void FileManager::dump()
{
286
    qDebug() << "======== dumping state map";
dt's avatar
dt committed
287 288 289 290 291
    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();
292
        qDebug() << "   expected:" << it.value().expected.modified;
dt's avatar
dt committed
293 294 295 296 297

        QMap<IFile *, Internal::FileStateItem>::const_iterator jt, jend;
        jt = it.value().lastUpdatedState.constBegin();
        jend = it.value().lastUpdatedState.constEnd();
        for (; jt != jend; ++jt) {
298
            qDebug() << "  " << jt.key()->fileName() << jt.value().modified;
dt's avatar
dt committed
299 300
        }
    }
301 302 303 304 305
    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";
306 307
    if (d->m_fileWatcher)
        qDebug() << d->m_fileWatcher->files();
308
    qDebug() << "------- dumping link watch list";
309 310
    if (d->m_linkWatcher)
        qDebug() << d->m_linkWatcher->files();
dt's avatar
dt committed
311 312
}

313
/*!
314
    \fn void FileManager::renamedFile(const QString &from, const QString &to)
315 316 317 318 319 320 321 322 323
    \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.
*/
324
void FileManager::renamedFile(const QString &from, const QString &to)
dt's avatar
dt committed
325
{
326
    const QString &fixedFrom = fixFileName(from, KeepLinks);
dt's avatar
dt committed
327

328 329 330 331 332 333 334
    // 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());
335 336
    }

337 338 339 340 341 342 343 344
    // rename the IFiles
    foreach (IFile *file, filesToRename) {
        d->m_blockedIFile = file;
        removeFileInfo(file);
        file->rename(to);
        addFileInfo(file);
        d->m_blockedIFile = 0;
    }
345 346
}

347
/* Removes all occurrences of the IFile from m_filesWithWatch and m_states.
348 349 350 351
   If that results in a file no longer being referenced by any IFile, this
   also removes the file watcher.
*/
void FileManager::removeFileInfo(IFile *file)
352
{
353 354 355 356 357 358 359
    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()) {
360 361
            if (d->m_fileWatcher && d->m_fileWatcher->files().contains(fileName))
                d->m_fileWatcher->removePath(fileName);
362
            if (d->m_linkWatcher && d->m_linkWatcher->files().contains(fileName))
363 364 365
                d->m_linkWatcher->removePath(fileName);
            d->m_states.remove(fileName);
        }
366
    }
367
    d->m_filesWithWatch.remove(file);
368 369
}

con's avatar
con committed
370
/*!
con's avatar
con committed
371
    \fn bool FileManager::addFile(IFile *files, bool addWatcher)
con's avatar
con committed
372

con's avatar
con committed
373 374 375
    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
376
*/
con's avatar
con committed
377
void FileManager::addFile(IFile *file, bool addWatcher)
con's avatar
con committed
378
{
con's avatar
con committed
379
    addFiles(QList<IFile *>() << file, addWatcher);
con's avatar
con committed
380 381 382 383 384
}

void FileManager::fileDestroyed(QObject *obj)
{
    IFile *file = static_cast<IFile*>(obj);
dt's avatar
dt committed
385
    // Check the special unwatched first:
386 387
    if (!d->m_filesWithoutWatch.removeOne(file))
        removeFileInfo(file);
con's avatar
con committed
388 389 390 391 392 393 394
}

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

    Removes a IFile object from the collection.

395
    Returns true if the file specified by \a file had the addWatcher argument to addFile() set.
con's avatar
con committed
396
*/
397
bool FileManager::removeFile(IFile *file)
con's avatar
con committed
398
{
399
    QTC_ASSERT(file, return false);
con's avatar
con committed
400

401
    bool addWatcher = false;
dt's avatar
dt committed
402
    // Special casing unwatched files
403
    if (!d->m_filesWithoutWatch.removeOne(file)) {
404
        addWatcher = true;
405 406
        removeFileInfo(file);
        disconnect(file, SIGNAL(changed()), this, SLOT(checkForNewFileName()));
dt's avatar
dt committed
407
    }
con's avatar
con committed
408
    disconnect(file, SIGNAL(destroyed(QObject *)), this, SLOT(fileDestroyed(QObject *)));
409
    return addWatcher;
con's avatar
con committed
410 411
}

412 413
/* 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
414 415 416
void FileManager::checkForNewFileName()
{
    IFile *file = qobject_cast<IFile *>(sender());
dt's avatar
dt committed
417 418 419 420
    // 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
421
    QTC_ASSERT(file, return);
422
    QTC_ASSERT(d->m_filesWithWatch.contains(file), return);
423

424
    // Maybe the name has changed or file has been deleted and created again ...
425 426
    // This also updates the state to the on disk state
    removeFileInfo(file);
dt's avatar
dt committed
427
    addFileInfo(file);
con's avatar
con committed
428 429
}

430 431 432 433 434 435 436
/*!
    \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
437 438
{
    QString s = fileName;
439
    QFileInfo fi(s);
440 441 442 443 444 445 446 447 448
    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
449 450 451
#ifdef Q_OS_WIN
    s = s.toLower();
#endif
452
    return s;
con's avatar
con committed
453 454 455 456 457 458 459 460 461 462 463
}

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

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

464 465 466
    foreach (IFile *file, d->m_filesWithWatch.keys()) {
        if (file->isModified())
            modifiedFiles << file;
con's avatar
con committed
467
    }
468

dt's avatar
dt committed
469 470 471 472 473
    foreach(IFile *file, d->m_filesWithoutWatch) {
        if (file->isModified())
            modifiedFiles << file;
    }

con's avatar
con committed
474 475 476
    return modifiedFiles;
}

477 478 479 480 481 482 483 484
/*!
    \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
485
{
486 487 488
    if (fileName.isEmpty())
        return;
    d->m_expectedFileNames.insert(fileName);
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
}

/*!
    \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

505 506
    if (fileName.isEmpty())
        return;
507
    d->m_expectedFileNames.remove(fileName);
508 509 510 511 512
    const QString fixedName = fixFileName(fileName, KeepLinks);
    updateExpectedState(fixedName);
    const QString fixedResolvedName = fixFileName(fileName, ResolveLinks);
    if (fixedName != fixedResolvedName)
        updateExpectedState(fixedResolvedName);
513 514
}

515
/* only called from unblock and unexpect file change methods */
516 517
void FileManager::updateExpectedState(const QString &fileName)
{
518
    if (fileName.isEmpty())
519
        return;
520 521 522 523
    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
524
    }
con's avatar
con committed
525 526 527 528 529 530 531 532 533 534 535 536 537
}

/*!
    \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
538 539 540 541 542 543 544 545 546 547
    \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
548 549
*/
QList<IFile *> FileManager::saveModifiedFiles(const QList<IFile *> &files,
550 551 552
                                              bool *cancelled, const QString &message,
                                              const QString &alwaysSaveMessage,
                                              bool *alwaysSave)
con's avatar
con committed
553
{
554
    return saveModifiedFiles(files, cancelled, false, message, alwaysSaveMessage, alwaysSave);
con's avatar
con committed
555 556 557
}

QList<IFile *> FileManager::saveModifiedFiles(const QList<IFile *> &files,
558 559 560 561 562
                                              bool *cancelled,
                                              bool silently,
                                              const QString &message,
                                              const QString &alwaysSaveMessage,
                                              bool *alwaysSave)
con's avatar
con committed
563 564 565 566 567
{
    if (cancelled)
        (*cancelled) = false;

    QList<IFile *> notSaved;
568 569
    QMap<IFile *, QString> modifiedFilesMap;
    QList<IFile *> modifiedFiles;
con's avatar
con committed
570 571 572 573 574 575 576 577 578

    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
579 580
            if (!(modifiedFilesMap.key(name, 0)
                    && file->isReadOnly()))
581
                modifiedFilesMap.insert(file, name);
con's avatar
con committed
582 583
        }
    }
584
    modifiedFiles = modifiedFilesMap.keys();
con's avatar
con committed
585 586 587
    if (!modifiedFiles.isEmpty()) {
        QList<IFile *> filesToSave;
        if (silently) {
588
            filesToSave = modifiedFiles;
con's avatar
con committed
589
        } else {
590
            Internal::SaveItemsDialog dia(d->m_mainWindow, modifiedFiles);
con's avatar
con committed
591 592
            if (!message.isEmpty())
                dia.setMessage(message);
593 594
            if (!alwaysSaveMessage.isNull())
                dia.setAlwaysSaveMessage(alwaysSaveMessage);
con's avatar
con committed
595 596 597
            if (dia.exec() != QDialog::Accepted) {
                if (cancelled)
                    (*cancelled) = true;
598 599
                if (alwaysSave)
                    *alwaysSave = dia.alwaysSaveChecked();
600
                notSaved = modifiedFiles;
con's avatar
con committed
601 602
                return notSaved;
            }
603 604
            if (alwaysSave)
                *alwaysSave = dia.alwaysSaveChecked();
con's avatar
con committed
605 606 607 608
            filesToSave = dia.itemsToSave();
        }

        foreach (IFile *file, filesToSave) {
609 610 611 612
            if (!EditorManager::instance()->saveFile(file)) {
                if (cancelled)
                    *cancelled = true;
                notSaved.append(file);
con's avatar
con committed
613 614 615 616 617 618
            }
        }
    }
    return notSaved;
}

619
bool FileManager::saveFile(IFile *file, const QString &fileName, bool *isReadOnly)
620
{
621
    bool ret = true;
622
    QString effName = fileName.isEmpty() ? file->fileName() : fileName;
623 624 625
    expectFileChange(effName); // This only matters to other IFiles which refer to this file
    bool addWatcher = removeFile(file); // So that our own IFile gets no notification at all

626 627 628 629 630 631 632 633
    QString errorString;
    if (!file->save(&errorString, fileName)) {
        if (isReadOnly) {
            QFile ofi(effName);
            // Check whether the existing file is writable
            if (ofi.exists() && !ofi.open(QIODevice::ReadWrite)
                && ofi.error() == QFile::PermissionsError) {
                *isReadOnly = true;
634
                goto out;
635 636 637 638
            }
            *isReadOnly = false;
        }
        QMessageBox::critical(d->m_mainWindow, tr("File Error"), errorString);
639 640
      out:
        ret = false;
641
    }
642

643 644 645
    addFile(file, addWatcher);
    unexpectFileChange(effName);
    return ret;
646 647
}

648 649
QString FileManager::getSaveFileName(const QString &title, const QString &pathIn,
                                     const QString &filter, QString *selectedFilter)
con's avatar
con committed
650
{
651
    const QString &path = pathIn.isEmpty() ? fileDialogInitialDirectory() : pathIn;
con's avatar
con committed
652 653 654 655
    QString fileName;
    bool repeat;
    do {
        repeat = false;
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
        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
680
            if (QFile::exists(fileName)) {
681
                if (QMessageBox::warning(d->m_mainWindow, tr("Overwrite?"),
682 683 684
                    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
685
                    repeat = true;
686
                }
con's avatar
con committed
687 688 689
            }
        }
    } while (repeat);
690 691
    if (!fileName.isEmpty())
        setFileDialogLastVisitedDirectory(QFileInfo(fileName).absolutePath());
con's avatar
con committed
692 693 694
    return fileName;
}

695 696 697 698 699 700 701
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
702
/*!
703
    \fn QString FileManager::getSaveAsFileName(IFile *file, const QString &filter, QString *selectedFilter)
con's avatar
con committed
704 705 706

    Asks the user for a new file name (Save File As) for /arg file.
*/
707
QString FileManager::getSaveAsFileName(IFile *file, const QString &filter, QString *selectedFilter)
con's avatar
con committed
708 709 710 711 712 713 714 715 716 717 718 719 720
{
    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;
    }
721

con's avatar
con committed
722
    QString filterString;
723 724 725 726 727 728
    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
729 730
    }

731
    absoluteFilePath = getSaveFileName(tr("Save File As"),
con's avatar
con committed
732 733
        path + QDir::separator() + fileName,
        filterString,
734
        selectedFilter);
con's avatar
con committed
735 736 737
    return absoluteFilePath;
}

738
/*!
739 740 741
    \fn QStringList FileManager::getOpenFileNames(const QString &filters,
                                                  const QString pathIn,
                                                  QString *selectedFilter)
742

con's avatar
con committed
743 744 745 746
    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.
747 748 749 750 751 752
*/

QStringList FileManager::getOpenFileNames(const QString &filters,
                                          const QString pathIn,
                                          QString *selectedFilter)
{
753 754 755 756
    QString path = pathIn;
    if (path.isEmpty()) {
        if (!d->m_currentFile.isEmpty())
            path = QFileInfo(d->m_currentFile).absoluteFilePath();
757 758
        if (path.isEmpty() && useProjectsDirectory())
            path = projectsDirectory();
759
    }
760 761 762 763 764 765 766 767 768
    const QStringList files = QFileDialog::getOpenFileNames(d->m_mainWindow,
                                                      tr("Open File"),
                                                      path, filters,
                                                      selectedFilter);
    if (!files.isEmpty())
        setFileDialogLastVisitedDirectory(QFileInfo(files.front()).absolutePath());
    return files;
}

769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
FileManager::ReadOnlyAction
    FileManager::promptReadOnlyFile(const QString &fileName,
                                      const IVersionControl *versionControl,
                                      QWidget *parent,
                                      bool displaySaveAsButton)
{
    // Version Control: If automatic open is desired, open right away.
    bool promptVCS = false;
    if (versionControl && versionControl->supportsOperation(IVersionControl::OpenOperation)) {
        if (versionControl->settingsFlags() & IVersionControl::AutoOpen)
            return RO_OpenVCS;
        promptVCS = true;
    }

    // Create message box.
    QMessageBox msgBox(QMessageBox::Question, tr("File is Read Only"),
                       tr("The file <i>%1</i> is read only.").arg(QDir::toNativeSeparators(fileName)),
                       QMessageBox::Cancel, parent);

    QPushButton *vcsButton = 0;
    if (promptVCS)
        vcsButton = msgBox.addButton(tr("Open with VCS (%1)").arg(versionControl->displayName()), QMessageBox::AcceptRole);

    QPushButton *makeWritableButton =  msgBox.addButton(tr("Make writable"), QMessageBox::AcceptRole);

    QPushButton *saveAsButton = 0;
    if (displaySaveAsButton)
796
        saveAsButton = msgBox.addButton(tr("Save as..."), QMessageBox::ActionRole);
797 798 799 800 801 802 803 804 805

    msgBox.setDefaultButton(vcsButton ? vcsButton : makeWritableButton);
    msgBox.exec();

    QAbstractButton *clickedButton = msgBox.clickedButton();
    if (clickedButton == vcsButton)
        return RO_OpenVCS;
    if (clickedButton == makeWritableButton)
        return RO_MakeWriteable;
806
    if (displaySaveAsButton && clickedButton == saveAsButton)
807 808 809
        return RO_SaveAs;
    return  RO_Cancel;
}
810

811
void FileManager::changedFile(const QString &fileName)
con's avatar
con committed
812
{
813
    const bool wasempty = d->m_changedFiles.isEmpty();
814

815 816
    if (d->m_states.contains(fileName))
        d->m_changedFiles.insert(fileName);
817

818
    if (wasempty && !d->m_changedFiles.isEmpty()) {
819
        QTimer::singleShot(200, this, SLOT(checkForReload()));
con's avatar
con committed
820 821 822 823 824
    }
}

void FileManager::mainWindowActivated()
{
825 826 827 828
    //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
829 830 831 832
}

void FileManager::checkForReload()
{
833 834
    if (d->m_changedFiles.isEmpty())
        return;
835 836
    if (QApplication::activeWindow() != d->m_mainWindow)
        return;
con's avatar
con committed
837

838 839 840 841 842
    if (d->m_blockActivated)
        return;

    d->m_blockActivated = true;

843 844
    IFile::ReloadSetting defaultBehavior = EditorManager::instance()->reloadSetting();
    Utils::ReloadPromptAnswer previousAnswer = Utils::ReloadCurrent;
845

846 847
    QList<IEditor*> editorsToClose;
    QMap<IFile*, QString> filesToSave;
848 849 850 851 852

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

869 870 871 872
    // clean up. do this before we may enter the main loop, otherwise we would
    // lose consecutive notifications.
    d->m_changedFiles.clear();

873 874 875 876 877 878 879 880 881 882 883 884 885
    // collect information about "expected" file names
    // we can't do the "resolving" already in expectFileChange, because
    // if the resolved names are different when unexpectFileChange is called
    // we would end up with never-unexpected file names
    QSet<QString> expectedFileNames;
    foreach (const QString &fileName, d->m_expectedFileNames) {
        const QString fixedName = fixFileName(fileName, KeepLinks);
        expectedFileNames.insert(fixedName);
        const QString fixedResolvedName = fixFileName(fileName, ResolveLinks);
        if (fixedName != fixedResolvedName)
            expectedFileNames.insert(fixedResolvedName);
    }

886
    // handle the IFiles
887
    QStringList errorStrings;
888
    foreach (IFile *file, changedIFiles) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
889
        IFile::ChangeTrigger trigger = IFile::TriggerInternal;
890 891 892 893 894 895 896 897 898
        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;
899

900 901 902
            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);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
903

904 905
            // did the file actually change?
            if (lastState.modified == currentState.modified && lastState.permissions == currentState.permissions)
906
                continue;
907 908 909 910 911 912 913
            changed = true;

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

            // was the change unexpected?
914 915
            if ((currentState.modified != expectedState.modified || currentState.permissions != expectedState.permissions)
                    && !expectedFileNames.contains(fileName)) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
916
                trigger = IFile::TriggerExternal;
917
            }
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933

            // find out the type
            IFile::ChangeType fileChange = changeTypes.value(fileName);
            if (fileChange == IFile::TypeRemoved) {
                type = IFile::TypeRemoved;
            } 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;

934 935
        bool success = true;
        QString errorString;
936 937 938 939
        // we've got some modification
        // check if it's contents or permissions:
        if (type == IFile::TypePermissions) {
            // Only permission change
940
            success = file->reload(&errorString, IFile::FlagReload, IFile::TypePermissions);
941 942 943 944
        // 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)
945
            success = file->reload(&errorString, IFile::FlagReload, type);
946 947
        // file was removed or it's a content change and the default behavior for
        // unmodified files didn't kick in
948 949 950 951 952
        } else if (defaultBehavior == IFile::ReloadUnmodified
                   && type == IFile::TypeRemoved && !file->isModified()) {
            // file removed, but unmodified files should be reloaded
            // so we close the file
            editorsToClose << EditorManager::instance()->editorsForFile(file);
953 954
        } else if (defaultBehavior == IFile::IgnoreAll) {
            // content change or removed, but settings say ignore
955
            success = file->reload(&errorString, IFile::FlagIgnore, type);
956 957 958 959 960
        // 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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
961
            if (file->reloadBehavior(trigger, type) == IFile::BehaviorSilent) {
962
                // content change or removed, IFile wants silent handling
963
                success = file->reload(&errorString, IFile::FlagReload, type);
964 965 966 967 968
            // 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
969
                    success = file->reload(&errorString, IFile::FlagIgnore, IFile::TypeContents);
970 971
                } else if (previousAnswer == Utils::ReloadAll) {
                    // answer already given, reload
Oswald Buddenhagen's avatar