filemanager.cpp 43.6 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
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
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
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

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

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

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

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

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

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

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

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

99 100 101
namespace Core {
namespace Internal {

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

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

dt's avatar
dt committed
114

115
struct FileManagerPrivate {
116
    explicit FileManagerPrivate(FileManager *q, QMainWindow *mw);
117

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

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

    QString m_currentFile;

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

144 145 146
FileManager *FileManagerPrivate::m_instance = 0;

FileManagerPrivate::FileManagerPrivate(FileManager *q, QMainWindow *mw) :
con's avatar
con committed
147
    m_mainWindow(mw),
148
    m_fileWatcher(new QFileSystemWatcher(q)),
149 150 151
    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
152
    m_useProjectsDirectory(true),
153
#else
dt's avatar
dt committed
154
    m_useProjectsDirectory(false),
155
#endif
dt's avatar
dt committed
156
    m_blockedIFile(0)
con's avatar
con committed
157
{
158
    m_instance = q;
159 160 161 162 163 164 165 166 167 168
    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
169 170 171 172 173 174 175 176 177 178
}

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

183
    readSettings();
con's avatar
con committed
184 185
}

186 187 188 189 190
FileManager::~FileManager()
{
    delete d;
}

191 192 193 194 195
FileManager *FileManager::instance()
{
    return Internal::FileManagerPrivate::m_instance;
}

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

con's avatar
con committed
199 200 201
    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
202
*/
con's avatar
con committed
203
void FileManager::addFiles(const QList<IFile *> &files, bool addWatcher)
con's avatar
con committed
204
{
dt's avatar
dt committed
205 206 207
    if (!addWatcher) {
        // We keep those in a separate list

208
        foreach (IFile *file, files) {
209 210 211 212 213
            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
214
        return;
dt's avatar
dt committed
215 216
    }

con's avatar
con committed
217
    foreach (IFile *file, files) {
218 219 220 221 222
        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
223 224 225
    }
}

226 227 228 229
/* 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
230
void FileManager::addFileInfo(IFile *file)
231
{
232 233 234 235 236 237
    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);
}
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
/* 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);
255
        }
256
        d->m_states[fileName].lastUpdatedState.insert(file, state);
257
    }
258
    d->m_filesWithWatch[file].append(fileName); // inserts a new QStringList if not already there
259 260
}

261 262
/* 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) */
263 264
void FileManager::updateFileInfo(IFile *file)
{
265 266 267 268 269 270 271 272 273 274 275 276
    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);
    }
277 278
}

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

        QMap<IFile *, Internal::FileStateItem>::const_iterator jt, jend;
        jt = it.value().lastUpdatedState.constBegin();
        jend = it.value().lastUpdatedState.constEnd();
        for (; jt != jend; ++jt) {
295
            qDebug() << "  " << jt.key()->fileName() << jt.value().modified;
dt's avatar
dt committed
296 297
        }
    }
298 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";
    qDebug() << d->m_fileWatcher->files();
    qDebug() << "------- dumping link watch list";
    qDebug() << d->m_linkWatcher->files();
dt's avatar
dt committed
306 307
}

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

323 324 325 326 327 328 329
    // 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());
330 331
    }

332 333 334 335 336 337 338 339
    // rename the IFiles
    foreach (IFile *file, filesToRename) {
        d->m_blockedIFile = file;
        removeFileInfo(file);
        file->rename(to);
        addFileInfo(file);
        d->m_blockedIFile = 0;
    }
340 341
}

342
/* Removes all occurrences of the IFile from m_filesWithWatch and m_states.
343 344 345 346
   If that results in a file no longer being referenced by any IFile, this
   also removes the file watcher.
*/
void FileManager::removeFileInfo(IFile *file)
347
{
348 349 350 351 352 353 354 355 356 357 358 359 360
    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);
        }
361
    }
362
    d->m_filesWithWatch.remove(file);
363 364
}

con's avatar
con committed
365
/*!
con's avatar
con committed
366
    \fn bool FileManager::addFile(IFile *files, bool addWatcher)
con's avatar
con committed
367

con's avatar
con committed
368 369 370
    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
371
*/
con's avatar
con committed
372
void FileManager::addFile(IFile *file, bool addWatcher)
con's avatar
con committed
373
{
con's avatar
con committed
374
    addFiles(QList<IFile *>() << file, addWatcher);
con's avatar
con committed
375 376 377 378 379
}

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

/*!
    \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
395
void FileManager::removeFile(IFile *file)
con's avatar
con committed
396
{
397
    QTC_ASSERT(file, return);
con's avatar
con committed
398

dt's avatar
dt committed
399 400 401 402
    // 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
403
        return;
dt's avatar
dt committed
404 405
    }

406
    removeFileInfo(file);
con's avatar
con committed
407 408 409 410
    disconnect(file, SIGNAL(changed()), this, SLOT(checkForNewFileName()));
    disconnect(file, SIGNAL(destroyed(QObject *)), this, SLOT(fileDestroyed(QObject *)));
}

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

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

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

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

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

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

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

con's avatar
con committed
473 474 475 476 477 478 479 480 481 482
    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)
{
483 484
    // Nothing to do
    Q_UNUSED(file);
con's avatar
con committed
485 486 487 488 489 490 491 492 493
}

/*!
    \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)
{
494 495 496 497 498 499 500 501 502 503 504
    // 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);
505 506
    foreach (const QString &fileName, d->m_filesWithWatch.value(file))
        updateExpectedState(fileName);
con's avatar
con committed
507 508
}

509 510 511 512 513 514 515 516
/*!
    \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
517
{
518 519 520
    if (fileName.isEmpty())
        return;
    d->m_expectedFileNames.insert(fileName);
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
}

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

537 538
    if (fileName.isEmpty())
        return;
539
    d->m_expectedFileNames.remove(fileName);
540 541 542 543 544
    const QString fixedName = fixFileName(fileName, KeepLinks);
    updateExpectedState(fixedName);
    const QString fixedResolvedName = fixFileName(fileName, ResolveLinks);
    if (fixedName != fixedResolvedName)
        updateExpectedState(fixedResolvedName);
545 546
}

547
/* only called from unblock and unexpect file change methods */
548 549
void FileManager::updateExpectedState(const QString &fileName)
{
550
    if (fileName.isEmpty())
551
        return;
552 553 554 555
    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
556
    }
con's avatar
con committed
557 558 559 560 561 562 563 564 565 566 567 568 569
}

/*!
    \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
570 571 572 573 574 575 576 577 578 579
    \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
580 581
*/
QList<IFile *> FileManager::saveModifiedFiles(const QList<IFile *> &files,
582 583 584
                                              bool *cancelled, const QString &message,
                                              const QString &alwaysSaveMessage,
                                              bool *alwaysSave)
con's avatar
con committed
585
{
586
    return saveModifiedFiles(files, cancelled, false, message, alwaysSaveMessage, alwaysSave);
con's avatar
con committed
587 588 589
}

QList<IFile *> FileManager::saveModifiedFiles(const QList<IFile *> &files,
590 591 592 593 594
                                              bool *cancelled,
                                              bool silently,
                                              const QString &message,
                                              const QString &alwaysSaveMessage,
                                              bool *alwaysSave)
con's avatar
con committed
595 596 597 598 599
{
    if (cancelled)
        (*cancelled) = false;

    QList<IFile *> notSaved;
600 601
    QMap<IFile *, QString> modifiedFilesMap;
    QList<IFile *> modifiedFiles;
con's avatar
con committed
602 603 604 605 606 607 608 609 610

    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
611 612
            if (!(modifiedFilesMap.key(name, 0)
                    && file->isReadOnly()))
613
                modifiedFilesMap.insert(file, name);
con's avatar
con committed
614 615
        }
    }
616
    modifiedFiles = modifiedFilesMap.keys();
con's avatar
con committed
617 618 619
    if (!modifiedFiles.isEmpty()) {
        QList<IFile *> filesToSave;
        if (silently) {
620
            filesToSave = modifiedFiles;
con's avatar
con committed
621
        } else {
622
            Internal::SaveItemsDialog dia(d->m_mainWindow, modifiedFiles);
con's avatar
con committed
623 624
            if (!message.isEmpty())
                dia.setMessage(message);
625 626
            if (!alwaysSaveMessage.isNull())
                dia.setAlwaysSaveMessage(alwaysSaveMessage);
con's avatar
con committed
627 628 629
            if (dia.exec() != QDialog::Accepted) {
                if (cancelled)
                    (*cancelled) = true;
630 631
                if (alwaysSave)
                    *alwaysSave = dia.alwaysSaveChecked();
632
                notSaved = modifiedFiles;
con's avatar
con committed
633 634
                return notSaved;
            }
635 636
            if (alwaysSave)
                *alwaysSave = dia.alwaysSaveChecked();
con's avatar
con committed
637 638 639 640
            filesToSave = dia.itemsToSave();
        }

        foreach (IFile *file, filesToSave) {
641 642 643 644
            if (!EditorManager::instance()->saveFile(file)) {
                if (cancelled)
                    *cancelled = true;
                notSaved.append(file);
con's avatar
con committed
645 646 647 648 649 650
            }
        }
    }
    return notSaved;
}

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

698 699 700 701 702 703 704
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
705 706 707 708 709
/*!
    \fn QString FileManager::getSaveAsFileName(IFile *file)

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

con's avatar
con committed
725
    QString filterString;
726 727 728 729 730 731
    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
732 733
    }

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

741
/*!
con's avatar
con committed
742
    \fn QString FileManager::getOpenFileNames(const QString &filters, const QString &pathIn, QString *selectedFilter) const
743

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

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

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 796 797 798 799 800 801 802 803 804 805 806
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)
        saveAsButton = msgBox.addButton(tr("Save as ..."), QMessageBox::ActionRole);

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

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

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

816 817
    if (!d->m_changedFiles.contains(fileName) && d->m_states.contains(fileName))
        d->m_changedFiles.append(fileName);
818

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

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

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

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

    d->m_blockActivated = true;

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

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

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

870 871 872 873 874 875 876 877 878 879 880 881 882
    // 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);
    }

883 884 885 886 887 888 889 890 891 892 893 894
    // 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;
895

896 897 898 899 900
            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)
901
                continue;
902 903 904 905 906 907 908
            changed = true;

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

            // was the change unexpected?
909 910
            if ((currentState.modified != expectedState.modified || currentState.permissions != expectedState.permissions)
                    && !expectedFileNames.contains(fileName)) {
911
                behavior = IFile::TriggerExternal;
912
            }
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951

            // 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
952
                file->reload(IFile::FlagReload, type);
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
            // 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:
968
                        file->reload(IFile::FlagReload, IFile::TypeContents);
969 970 971 972 973
                        break;
                    case Utils::ReloadSkipCurrent:
                    case Utils::ReloadNone:
                        file->reload(IFile::FlagIgnore, IFile::TypeContents);
                        break;
974
                    }
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
                }
            // 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);
991 992
                            unhandled = false;
                        }
993 994 995 996 997 998
                        break;
                    }
                    case Utils::FileDeletedClose:
                        editorsToClose << EditorManager::instance()->editorsForFile(file);
                        unhandled = false;
                        break;
999 1000
                    }
                }
con's avatar
con committed
1001 1002
            }
        }
1003

1004 1005 1006 1007
        // update file info, also handling if e.g. link target has changed
        removeFileInfo(file);
        addFileInfo(file);
        d->m_blockedIFile = 0;
1008
    }
1009 1010

    // clean up
1011
    d->m_changedFiles.clear();
1012 1013 1014 1015 1016 1017 1018 1019 1020

    // 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());
1021
        it.key()->checkPermissions();
1022 1023
    }

1024
    d->m_blockActivated = false;
1025 1026

//    dump();
con's avatar
con committed
1027 1028 1029 1030 1031 1032 1033
}

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

1034
    Core::IEditor *editor = Core::EditorManager::instance()->currentEditor();
1035 1036
    if (editor && (editor->widget() == context->widget()) &&
        !editor->isTemporary())
con's avatar
con committed
1037 1038 1039 1040
        setCurrentFile(editor->file()->fileName());
}

/*!
1041
    \fn void FileManager::addToRecentFiles(const QString &fileName, , const QString &editorId)
con's avatar
con committed
1042

1043 1044 1045 1046
    Adds the \a fileName to the list of recent files. Associates the file to
    be reopened with an editor of the given \a editorId, if possible.
    \a editorId defaults to the empty id, which means to let the system figure out
    the best editor itself.
con's avatar
con committed
1047
*/
1048
void FileManager::addToRecentFiles(const QString &fileName, const QString &editorId)
con's avatar
con committed
1049 1050 1051
{
    if (fileName.isEmpty())
        return;
1052
    QString unifiedForm(fixFileName(fileName, KeepLinks));
1053
    QMutableListIterator<RecentFile > it(d->m_recentFiles);
1054
    while (it.hasNext()) {
1055 1056
        RecentFile file = it.next();
        QString recentUnifiedForm(fixFileName(file.first, KeepLinks));
1057 1058 1059
        if (unifiedForm == recentUnifiedForm)
            it.remove();
    }
1060 1061
    if (d->m_recentFiles.count() > d->m_maxRecentFiles)
        d->m_recentFiles.removeLast();
con's avatar