FileSystemWatcherWrapper Class Reference

Inheritance diagram for FileSystemWatcherWrapper:

Classes
struct	FileEntry

Signals
void	fileChanged (const QString &path)
void	fileExistsStateChanged (const QString &path, bool exists)

Public Member Functions
bool	addPath (const QString &file)
QStringList	files () const
	FileSystemWatcherWrapper ()
bool	removePath (const QString &file)

Static Public Member Functions
static QString	unifyFilePath (const QString &path)

Private Types
enum	FileState { Exists = 0 , Reattaching , Lost }

Private Slots
void	slotFileChanged (const QString &path)
void	slotFindLostFiles ()
void	slotReattachFiles ()

Private Attributes
QHash< QString, FileEntry >	m_fileEntries
KisSignalCompressor	m_lostCompressor
QHash< QString, int >	m_lostFilesAbsenceCounter
QHash< QString, int >	m_pathCount
KisSignalCompressor	m_reattachmentCompressor
QFileSystemWatcher	m_watcher

Detailed Description

Definition at line 30 of file kis_safe_document_loader.cpp.

Member Enumeration Documentation

FileState

enum FileSystemWatcherWrapper::FileState

private

Enumerator
Exists
Reattaching
Lost

Definition at line 35 of file kis_safe_document_loader.cpp.

                   {
        Exists = 0,
        Reattaching,
        Lost
    };

Constructor & Destructor Documentation

FileSystemWatcherWrapper()

FileSystemWatcherWrapper::FileSystemWatcherWrapper ( )

inline

Definition at line 49 of file kis_safe_document_loader.cpp.

        : m_reattachmentCompressor(100, KisSignalCompressor::FIRST_INACTIVE),
          m_lostCompressor(1000, KisSignalCompressor::FIRST_INACTIVE)
 
    {
        connect(&m_watcher, SIGNAL(fileChanged(QString)), SLOT(slotFileChanged(QString)));
        connect(&m_reattachmentCompressor, SIGNAL(timeout()), SLOT(slotReattachFiles()));
        connect(&m_lostCompressor, SIGNAL(timeout()), SLOT(slotFindLostFiles()));
    }

References connect(), fileChanged(), m_lostCompressor, m_reattachmentCompressor, m_watcher, slotFileChanged(), slotFindLostFiles(), and slotReattachFiles().

Member Function Documentation

addPath()

bool FileSystemWatcherWrapper::addPath ( const QString & file )

inline

Definition at line 59 of file kis_safe_document_loader.cpp.

                                      {
        bool result = true;
        const QString ufile = unifyFilePath(file);
 
        if (m_fileEntries.contains(ufile)) {
            m_fileEntries[ufile].numConnections++;
        } else {
            m_fileEntries.insert(ufile, {1, {}, Exists});
            result = m_watcher.addPath(ufile);
        }
 
        return result;
    }

References Exists, m_fileEntries, m_watcher, and unifyFilePath().

fileChanged

void FileSystemWatcherWrapper::fileChanged ( const QString & path )

signal

fileExistsStateChanged

void FileSystemWatcherWrapper::fileExistsStateChanged ( const QString & path, bool exists )

signal

files()

QStringList FileSystemWatcherWrapper::files ( ) const

inline

Definition at line 88 of file kis_safe_document_loader.cpp.

                              {
        return m_watcher.files();
    }

References m_watcher.

removePath()

bool FileSystemWatcherWrapper::removePath ( const QString & file )

inline

Definition at line 73 of file kis_safe_document_loader.cpp.

                                         {
        bool result = true;
        const QString ufile = unifyFilePath(file);
 
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(m_fileEntries.contains(ufile), false);
 
        if (m_fileEntries[ufile].numConnections == 1) {
            m_fileEntries.remove(ufile);
            result = m_watcher.removePath(ufile);
        } else {
            m_fileEntries[ufile].numConnections--;
        }
        return result;
    }

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_fileEntries, m_watcher, and unifyFilePath().

slotFileChanged

void FileSystemWatcherWrapper::slotFileChanged ( const QString & path )

inlineprivateslot

Definition at line 93 of file kis_safe_document_loader.cpp.

                                              {
 
        KIS_SAFE_ASSERT_RECOVER_RETURN(m_fileEntries.contains(path));
 
        FileEntry &entry = m_fileEntries[path];
 
        // re-add the file after QSaveFile optimization
        if (!m_watcher.files().contains(path)) {
 
            if (QFileInfo(path).exists()) {
                const FileState oldState = entry.state;
 
                m_watcher.addPath(path);
                entry.state = Exists;
 
                if (oldState == Lost) {
                    Q_EMIT fileExistsStateChanged(path, true);
                } else {
                    Q_EMIT fileChanged(path);
                }
 
            } else {
 
                if (entry.state == Exists) {
                    entry.state = Reattaching;
                    entry.lostTimer.start();
                    m_reattachmentCompressor.start();
 
                } else if (entry.state == Reattaching) {
                    if (entry.lostTimer.elapsed() > 10000) {
                        entry.state = Lost;
                        m_lostCompressor.start();
                        Q_EMIT fileExistsStateChanged(path, false);
                    } else {
                        m_reattachmentCompressor.start();
                    }
 
                } else if (entry.state == Lost) {
                    m_lostCompressor.start();
                }
 
 
#if 0
                const bool shouldSpitWarning =
                    absenceTimeMSec <= 600000 &&
                        ((absenceTimeMSec >= 60000 && (absenceTimeMSec % 60000 == 0)) ||
                         (absenceTimeMSec >= 10000 && (absenceTimeMSec % 10000 == 0)));
 
                if (shouldSpitWarning) {
                    QString message;
                    QTextStream log(&message);
                    KisPortingUtils::setUtf8OnStream(log);
 
                    log << "WARNING: couldn't reconnect to a removed file layer's file (" << path << "). File is not available for " << absenceTimeMSec / 1000 << " seconds";
 
                    qWarning() << message;
                    KisUsageLogger::log(message);
 
                    if (absenceTimeMSec == 600000) {
                        message.clear();
                        log.reset();
 
                        log << "Giving up... :( No more reports about " << path;
 
                        qWarning() << message;
                        KisUsageLogger::log(message);
                    }
                }
#endif
            }
        } else {
            Q_EMIT fileChanged(path);
        }
    }

References Exists, fileChanged(), fileExistsStateChanged(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisUsageLogger::log(), Lost, FileSystemWatcherWrapper::FileEntry::lostTimer, m_fileEntries, m_lostCompressor, m_reattachmentCompressor, m_watcher, Reattaching, KisPortingUtils::setUtf8OnStream(), KisSignalCompressor::start(), and FileSystemWatcherWrapper::FileEntry::state.

slotFindLostFiles

void FileSystemWatcherWrapper::slotFindLostFiles ( )

inlineprivateslot

Definition at line 168 of file kis_safe_document_loader.cpp.

                             {
        for (auto it = m_fileEntries.constBegin(); it != m_fileEntries.constEnd(); ++it) {
            if (it.value().state == Lost)
            slotFileChanged(it.key());
        }
    }

References Lost, m_fileEntries, and slotFileChanged().

slotReattachFiles

void FileSystemWatcherWrapper::slotReattachFiles ( )

inlineprivateslot

Definition at line 175 of file kis_safe_document_loader.cpp.

                             {
        for (auto it = m_fileEntries.constBegin(); it != m_fileEntries.constEnd(); ++it) {
            if (it.value().state == Reattaching)
            slotFileChanged(it.key());
        }
    }

References m_fileEntries, Reattaching, and slotFileChanged().

unifyFilePath()

static QString FileSystemWatcherWrapper::unifyFilePath ( const QString & path )

inlinestatic

Definition at line 188 of file kis_safe_document_loader.cpp.

                                                      {
        return QFileInfo(path).absoluteFilePath();
    }

Member Data Documentation

m_fileEntries

QHash<QString, FileEntry> FileSystemWatcherWrapper::m_fileEntries

private

Definition at line 198 of file kis_safe_document_loader.cpp.

m_lostCompressor

KisSignalCompressor FileSystemWatcherWrapper::m_lostCompressor

private

Definition at line 196 of file kis_safe_document_loader.cpp.

m_lostFilesAbsenceCounter

QHash<QString, int> FileSystemWatcherWrapper::m_lostFilesAbsenceCounter

private

Definition at line 197 of file kis_safe_document_loader.cpp.

m_pathCount

QHash<QString, int> FileSystemWatcherWrapper::m_pathCount

private

Definition at line 194 of file kis_safe_document_loader.cpp.

m_reattachmentCompressor

KisSignalCompressor FileSystemWatcherWrapper::m_reattachmentCompressor

private

Definition at line 195 of file kis_safe_document_loader.cpp.

m_watcher

QFileSystemWatcher FileSystemWatcherWrapper::m_watcher

private

Definition at line 193 of file kis_safe_document_loader.cpp.

---

The documentation for this class was generated from the following file:

• libs/ui/kis_safe_document_loader.cpp