1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39
40 #ifndef QFILESYSTEMWATCHER_WIN_P_H
41 #define QFILESYSTEMWATCHER_WIN_P_H
42
43 //
44 // W A R N I N G
45 // -------------
46 //
47 // This file is not part of the Qt API. It exists purely as an
48 // implementation detail. This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53
54 #include "qfilesystemwatcher_p.h"
55
56 #include <QtCore/qdatetime.h>
57 #include <QtCore/qthread.h>
58 #include <QtCore/qfile.h>
59 #include <QtCore/qfileinfo.h>
60 #include <QtCore/qhash.h>
61 #include <QtCore/qmutex.h>
62 #include <QtCore/qvector.h>
63
64 QT_BEGIN_NAMESPACE
65
66 class QWindowsFileSystemWatcherEngineThread;
67 class QWindowsRemovableDriveListener;
68
69 // Even though QWindowsFileSystemWatcherEngine is derived of QThread
70 // via QFileSystemWatcher, it does not start a thread.
71 // Instead QWindowsFileSystemWatcher creates QWindowsFileSystemWatcherEngineThreads
72 // to do the actually watching.
73 class QWindowsFileSystemWatcherEngine : public QFileSystemWatcherEngine
74 {
75 Q_OBJECT
76 public:
77 explicit QWindowsFileSystemWatcherEngine(QObject *parent);
78 ~QWindowsFileSystemWatcherEngine();
79
80 QStringList addPaths(const QStringList &paths, QStringList *files, QStringList *directories) override;
81 QStringList removePaths(const QStringList &paths, QStringList *files, QStringList *directories) override;
82
83 class Handle
84 {
85 public:
86 Qt::HANDLE handle;
87 uint flags;
88
89 Handle();
90 };
91
92 class PathInfo {
93 public:
94 QString absolutePath;
95 QString path;
96 bool isDir;
97
98 // fileinfo bits
99 uint ownerId;
100 uint groupId;
101 QFile::Permissions permissions;
102 QDateTime lastModified;
103
104 PathInfo &operator=(const QFileInfo &fileInfo)
105 {
106 ownerId = fileInfo.ownerId();
107 groupId = fileInfo.groupId();
108 permissions = fileInfo.permissions();
109 lastModified = fileInfo.lastModified();
110 return *this;
111 }
112
113 bool operator!=(const QFileInfo &fileInfo) const
114 {
115 return (ownerId != fileInfo.ownerId()
116 || groupId != fileInfo.groupId()
117 || permissions != fileInfo.permissions()
118 || lastModified != fileInfo.lastModified());
119 }
120 };
121
122 signals:
123 void driveLockForRemoval(const QString &);
124 void driveLockForRemovalFailed(const QString &);
125 void driveRemoved(const QString &);
126
127 private:
128 QList<QWindowsFileSystemWatcherEngineThread *> threads;
129 #ifndef Q_OS_WINRT
130 QWindowsRemovableDriveListener *m_driveListener = nullptr;
131 #endif
132 };
133
134 class QFileSystemWatcherPathKey : public QString
135 {
136 public:
QFileSystemWatcherPathKey()137 QFileSystemWatcherPathKey() {}
QFileSystemWatcherPathKey(const QString & other)138 explicit QFileSystemWatcherPathKey(const QString &other) : QString(other) {}
QFileSystemWatcherPathKey(const QFileSystemWatcherPathKey & other)139 QFileSystemWatcherPathKey(const QFileSystemWatcherPathKey &other) : QString(other) {}
140 bool operator==(const QFileSystemWatcherPathKey &other) const { return !compare(other, Qt::CaseInsensitive); }
141 };
142
143 Q_DECLARE_TYPEINFO(QFileSystemWatcherPathKey, Q_MOVABLE_TYPE);
144
qHash(const QFileSystemWatcherPathKey & key)145 inline uint qHash(const QFileSystemWatcherPathKey &key) { return qHash(key.toCaseFolded()); }
146
147 class QWindowsFileSystemWatcherEngineThread : public QThread
148 {
149 Q_OBJECT
150
151 public:
152 typedef QHash<QFileSystemWatcherPathKey, QWindowsFileSystemWatcherEngine::Handle> HandleForDirHash;
153 typedef QHash<QFileSystemWatcherPathKey, QWindowsFileSystemWatcherEngine::PathInfo> PathInfoHash;
154
155 QWindowsFileSystemWatcherEngineThread();
156 ~QWindowsFileSystemWatcherEngineThread();
157 void run() override;
158 void stop();
159 void wakeup();
160
161 QMutex mutex;
162 QVector<Qt::HANDLE> handles;
163 int msg;
164
165 HandleForDirHash handleForDir;
166
167 QHash<Qt::HANDLE, PathInfoHash> pathInfoForHandle;
168
169 Q_SIGNALS:
170 void fileChanged(const QString &path, bool removed);
171 void directoryChanged(const QString &path, bool removed);
172 };
173
174 QT_END_NAMESPACE
175
176 #endif // QFILESYSTEMWATCHER_WIN_P_H
177