Chris@538
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
Chris@538
|
2
|
Chris@538
|
3 /*
|
Chris@538
|
4 EasyMercurial
|
Chris@538
|
5
|
Chris@538
|
6 Based on hgExplorer by Jari Korhonen
|
Chris@538
|
7 Copyright (c) 2010 Jari Korhonen
|
Chris@560
|
8 Copyright (c) 2012 Chris Cannam
|
Chris@560
|
9 Copyright (c) 2012 Queen Mary, University of London
|
Chris@538
|
10
|
Chris@538
|
11 This program is free software; you can redistribute it and/or
|
Chris@538
|
12 modify it under the terms of the GNU General Public License as
|
Chris@538
|
13 published by the Free Software Foundation; either version 2 of the
|
Chris@538
|
14 License, or (at your option) any later version. See the file
|
Chris@538
|
15 COPYING included with this distribution for more information.
|
Chris@538
|
16 */
|
Chris@538
|
17
|
Chris@584
|
18 #include <QMutexLocker>
|
Chris@584
|
19 #include <QDir>
|
Chris@584
|
20
|
Chris@584
|
21 #ifdef Q_OS_MAC
|
Chris@584
|
22 // Must include this before debug.h
|
Chris@584
|
23 #include <CoreServices/CoreServices.h>
|
Chris@584
|
24 #endif
|
Chris@584
|
25
|
Chris@538
|
26 #include "fswatcher.h"
|
Chris@540
|
27 #include "debug.h"
|
Chris@538
|
28
|
Chris@538
|
29 #include <deque>
|
Chris@538
|
30
|
Chris@585
|
31 #define DEBUG_FSWATCHER 1
|
Chris@540
|
32
|
Chris@539
|
33 /*
|
Chris@539
|
34 * Watching the filesystem is trickier than it seems at first glance.
|
Chris@539
|
35 *
|
Chris@539
|
36 * We ideally should watch every directory, and every file that is
|
Chris@539
|
37 * tracked by Hg. If a new file is created in a directory, then we
|
Chris@539
|
38 * need to respond in order to show it as a potential candidate to be
|
Chris@539
|
39 * added.
|
Chris@539
|
40 *
|
Chris@539
|
41 * Complicating matters though is that Hg itself might modify the
|
Chris@539
|
42 * filesystem. This can happen even in "read-only" operations: for
|
Chris@539
|
43 * example, hg stat creates files called hg-checklink and hg-checkexec
|
Chris@539
|
44 * to test properties of the filesystem. So we need to know to ignore
|
Chris@539
|
45 * those files; unfortunately, when watching a directory (which is how
|
Chris@539
|
46 * we find out about the creation of new files) we are notified only
|
Chris@540
|
47 * that the directory has changed -- we aren't told what changed.
|
Chris@540
|
48 *
|
Chris@540
|
49 * This means that, when a directory changes, we need to rescan the
|
Chris@540
|
50 * directory to learn whether the set of files in it _excluding_ files
|
Chris@540
|
51 * matching our ignore patterns differs from the previous scan, and
|
Chris@540
|
52 * ignore the change if it doesn't.
|
Chris@584
|
53 *
|
Chris@584
|
54 */
|
Chris@584
|
55
|
Chris@584
|
56 /*
|
Chris@584
|
57 * 20120312 -- Another complication. The documentation for
|
Chris@584
|
58 * QFileSystemWatcher says:
|
Chris@584
|
59 *
|
Chris@584
|
60 * On Mac OS X 10.4 [...] an open file descriptor is required for
|
Chris@584
|
61 * each monitored file. [...] This means that addPath() and
|
Chris@584
|
62 * addPaths() will fail if your process tries to add more than 256
|
Chris@584
|
63 * files or directories to the file system monitor [...] Mac OS X
|
Chris@584
|
64 * 10.5 and up use a different backend and do not suffer from this
|
Chris@584
|
65 * issue.
|
Chris@584
|
66 *
|
Chris@584
|
67 * Unfortunately, the last sentence above is not true:
|
Chris@584
|
68 * http://qt.gitorious.org/qt/qt/commit/6d1baf9979346d6f15da81a535becb4046278962
|
Chris@584
|
69 * ("Removing the usage of FSEvents-based backend for now as it has a
|
Chris@584
|
70 * few bugs..."). It can't be restored without hacking the Qt source,
|
Chris@584
|
71 * which we don't want to do in this context. The commit log doesn't
|
Chris@584
|
72 * make clear how serious the bugs were -- an example is given but it
|
Chris@584
|
73 * doesn't indicate whether it's an edge case or a common case and
|
Chris@584
|
74 * whether the result was a crash or failure to notify.
|
Chris@584
|
75 *
|
Chris@584
|
76 * This means the Qt class uses kqueue instead on OS/X, but that
|
Chris@584
|
77 * doesn't really work for us -- it can only monitor 256 files (or
|
Chris@584
|
78 * whatever the fd ulimit is set to, but that's the default) and it
|
Chris@584
|
79 * doesn't notify if a file within a directory is modified unless the
|
Chris@584
|
80 * metadata changes. The main limitation of FSEvents is that it only
|
Chris@584
|
81 * notifies with directory granularity, but that's OK for us so long
|
Chris@584
|
82 * as notifications are actually provoked by file changes as well.
|
Chris@584
|
83 *
|
Chris@584
|
84 * One other problem with FSEvents is that the API only exists on OS/X
|
Chris@584
|
85 * 10.5 or newer -- on older versions we would have no option but to
|
Chris@584
|
86 * use kqueue via QFileSystemWatcher. But we can't ship a binary
|
Chris@584
|
87 * linked with the FSEvents API to run on 10.4 without some fiddling,
|
Chris@584
|
88 * and I'm not really keen to do that either. That may be our cue to
|
Chris@584
|
89 * drop 10.4 support for EasyMercurial.
|
Chris@539
|
90 */
|
Chris@539
|
91
|
Chris@538
|
92 FsWatcher::FsWatcher() :
|
Chris@538
|
93 m_lastToken(0),
|
Chris@538
|
94 m_lastCounter(0)
|
Chris@538
|
95 {
|
Chris@584
|
96 #ifdef Q_OS_MAC
|
Chris@584
|
97 m_stream = 0; // create when we have a path
|
Chris@584
|
98 #else
|
Chris@538
|
99 connect(&m_watcher, SIGNAL(directoryChanged(QString)),
|
Chris@538
|
100 this, SLOT(fsDirectoryChanged(QString)));
|
Chris@538
|
101 connect(&m_watcher, SIGNAL(fileChanged(QString)),
|
Chris@538
|
102 this, SLOT(fsFileChanged(QString)));
|
Chris@584
|
103 #endif
|
Chris@538
|
104 }
|
Chris@538
|
105
|
Chris@538
|
106 FsWatcher::~FsWatcher()
|
Chris@538
|
107 {
|
Chris@538
|
108 }
|
Chris@538
|
109
|
Chris@538
|
110 void
|
Chris@538
|
111 FsWatcher::setWorkDirPath(QString path)
|
Chris@538
|
112 {
|
Chris@538
|
113 QMutexLocker locker(&m_mutex);
|
Chris@541
|
114 if (m_workDirPath == path) return;
|
Chris@584
|
115 clearWatchedPaths();
|
Chris@584
|
116 m_workDirPath = path;
|
Chris@584
|
117 addWorkDirectory(path);
|
Chris@584
|
118 debugPrint();
|
Chris@584
|
119 }
|
Chris@584
|
120
|
Chris@584
|
121 void
|
Chris@584
|
122 FsWatcher::clearWatchedPaths()
|
Chris@584
|
123 {
|
Chris@584
|
124 #ifdef Q_OS_MAC
|
Chris@584
|
125 FSEventStreamRef stream = (FSEventStreamRef)m_stream;
|
Chris@584
|
126 if (stream) {
|
Chris@584
|
127 FSEventStreamStop(stream);
|
Chris@584
|
128 FSEventStreamInvalidate(stream);
|
Chris@584
|
129 FSEventStreamRelease(stream);
|
Chris@584
|
130 }
|
Chris@584
|
131 m_stream = 0;
|
Chris@584
|
132 #else
|
Chris@562
|
133 // annoyingly, removePaths prints a warning if given an empty list
|
Chris@562
|
134 if (!m_watcher.directories().empty()) {
|
Chris@562
|
135 m_watcher.removePaths(m_watcher.directories());
|
Chris@562
|
136 }
|
Chris@562
|
137 if (!m_watcher.files().empty()) {
|
Chris@562
|
138 m_watcher.removePaths(m_watcher.files());
|
Chris@562
|
139 }
|
Chris@584
|
140 #endif
|
Chris@538
|
141 }
|
Chris@538
|
142
|
Chris@584
|
143 #ifdef Q_OS_MAC
|
Chris@584
|
144 static void
|
Chris@585
|
145 fsEventsCallback(ConstFSEventStreamRef streamRef,
|
Chris@584
|
146 void *clientCallBackInfo,
|
Chris@585
|
147 size_t numEvents,
|
Chris@585
|
148 void *paths,
|
Chris@585
|
149 const FSEventStreamEventFlags eventFlags[],
|
Chris@585
|
150 const FSEventStreamEventId eventIDs[])
|
Chris@539
|
151 {
|
Chris@585
|
152 FsWatcher *watcher = reinterpret_cast<FsWatcher *>(clientCallBackInfo);
|
Chris@585
|
153 const char *const *cpaths = reinterpret_cast<const char *const *>(paths);
|
Chris@585
|
154 for (size_t i = 0; i < numEvents; ++i) {
|
Chris@585
|
155 watcher->fsDirectoryChanged(QString::fromLocal8Bit(cpaths[i]));
|
Chris@585
|
156 }
|
Chris@539
|
157 }
|
Chris@584
|
158 #endif
|
Chris@539
|
159
|
Chris@539
|
160 void
|
Chris@538
|
161 FsWatcher::addWorkDirectory(QString path)
|
Chris@538
|
162 {
|
Chris@584
|
163 #ifdef Q_OS_MAC
|
Chris@585
|
164
|
Chris@585
|
165 CFStringRef cfPath = CFStringCreateWithCharacters
|
Chris@585
|
166 (0, reinterpret_cast<const UniChar *>(path.unicode()),
|
Chris@585
|
167 path.length());
|
Chris@585
|
168
|
Chris@585
|
169 CFArrayRef cfPaths = CFArrayCreate(0, (const void **)&cfPath, 1, 0);
|
Chris@585
|
170
|
Chris@585
|
171 FSEventStreamContext ctx = { 0, 0, 0, 0, 0 };
|
Chris@585
|
172 ctx.info = this;
|
Chris@585
|
173
|
Chris@584
|
174 FSEventStreamRef stream =
|
Chris@584
|
175 FSEventStreamCreate(kCFAllocatorDefault,
|
Chris@585
|
176 &fsEventsCallback,
|
Chris@585
|
177 &ctx,
|
Chris@584
|
178 cfPaths,
|
Chris@584
|
179 kFSEventStreamEventIdSinceNow,
|
Chris@584
|
180 1.0, // latency, seconds
|
Chris@584
|
181 kFSEventStreamCreateFlagNone);
|
Chris@584
|
182
|
Chris@584
|
183 m_stream = stream;
|
Chris@584
|
184
|
Chris@584
|
185 FSEventStreamScheduleWithRunLoop(stream,
|
Chris@584
|
186 CFRunLoopGetCurrent(),
|
Chris@584
|
187 kCFRunLoopDefaultMode);
|
Chris@584
|
188
|
Chris@584
|
189 if (!FSEventStreamStart(stream)) {
|
Chris@584
|
190 std::cerr << "ERROR: FsWatcher::addWorkDirectory: Failed to start FSEvent stream" << std::endl;
|
Chris@584
|
191 }
|
Chris@584
|
192 #else
|
Chris@538
|
193 // QFileSystemWatcher will refuse to add a file or directory to
|
Chris@538
|
194 // its watch list that it is already watching -- fine -- but it
|
Chris@538
|
195 // prints a warning when this happens, which we wouldn't want. So
|
Chris@538
|
196 // we'll check for duplicates ourselves.
|
Chris@538
|
197 QSet<QString> alreadyWatched =
|
Chris@538
|
198 QSet<QString>::fromList(m_watcher.directories());
|
Chris@538
|
199
|
Chris@538
|
200 std::deque<QString> pending;
|
Chris@538
|
201 pending.push_back(path);
|
Chris@538
|
202
|
Chris@538
|
203 while (!pending.empty()) {
|
Chris@538
|
204
|
Chris@538
|
205 QString path = pending.front();
|
Chris@538
|
206 pending.pop_front();
|
Chris@538
|
207 if (!alreadyWatched.contains(path)) {
|
Chris@538
|
208 m_watcher.addPath(path);
|
Chris@540
|
209 m_dirContents[path] = scanDirectory(path);
|
Chris@538
|
210 }
|
Chris@538
|
211
|
Chris@538
|
212 QDir d(path);
|
Chris@538
|
213 if (d.exists()) {
|
Chris@538
|
214 d.setFilter(QDir::Dirs | QDir::NoDotAndDotDot |
|
Chris@538
|
215 QDir::Readable | QDir::NoSymLinks);
|
Chris@538
|
216 foreach (QString entry, d.entryList()) {
|
Chris@538
|
217 if (entry.startsWith('.')) continue;
|
Chris@538
|
218 QString entryPath = d.absoluteFilePath(entry);
|
Chris@538
|
219 pending.push_back(entryPath);
|
Chris@538
|
220 }
|
Chris@538
|
221 }
|
Chris@538
|
222 }
|
Chris@584
|
223 #endif
|
Chris@584
|
224 }
|
Chris@584
|
225
|
Chris@584
|
226 void
|
Chris@584
|
227 FsWatcher::setTrackedFilePaths(QStringList paths)
|
Chris@584
|
228 {
|
Chris@584
|
229 #ifdef Q_OS_MAC
|
Chris@584
|
230 // We don't need to do anything here, so long as addWorkDirectory
|
Chris@584
|
231 // has been called -- FSEvents monitors files within directories
|
Chris@584
|
232 // as well as the directories themselves (even though it only
|
Chris@584
|
233 // notifies with directory granularity)
|
Chris@584
|
234 #else
|
Chris@584
|
235 QMutexLocker locker(&m_mutex);
|
Chris@584
|
236
|
Chris@584
|
237 QSet<QString> alreadyWatched =
|
Chris@584
|
238 QSet<QString>::fromList(m_watcher.files());
|
Chris@584
|
239
|
Chris@584
|
240 foreach (QString path, paths) {
|
Chris@584
|
241 path = m_workDirPath + QDir::separator() + path;
|
Chris@584
|
242 if (!alreadyWatched.contains(path)) {
|
Chris@584
|
243 m_watcher.addPath(path);
|
Chris@584
|
244 } else {
|
Chris@584
|
245 alreadyWatched.remove(path);
|
Chris@584
|
246 }
|
Chris@584
|
247 }
|
Chris@584
|
248
|
Chris@584
|
249 // Remove the remaining paths, those that were being watched
|
Chris@584
|
250 // before but that are not in the list we were given
|
Chris@584
|
251 foreach (QString path, alreadyWatched) {
|
Chris@584
|
252 m_watcher.removePath(path);
|
Chris@584
|
253 }
|
Chris@584
|
254
|
Chris@584
|
255 debugPrint();
|
Chris@584
|
256 #endif
|
Chris@538
|
257 }
|
Chris@538
|
258
|
Chris@538
|
259 void
|
Chris@538
|
260 FsWatcher::setIgnoredFilePrefixes(QStringList prefixes)
|
Chris@538
|
261 {
|
Chris@538
|
262 QMutexLocker locker(&m_mutex);
|
Chris@538
|
263 m_ignoredPrefixes = prefixes;
|
Chris@538
|
264 }
|
Chris@538
|
265
|
Chris@538
|
266 void
|
Chris@538
|
267 FsWatcher::setIgnoredFileSuffixes(QStringList suffixes)
|
Chris@538
|
268 {
|
Chris@538
|
269 QMutexLocker locker(&m_mutex);
|
Chris@538
|
270 m_ignoredSuffixes = suffixes;
|
Chris@538
|
271 }
|
Chris@538
|
272
|
Chris@538
|
273 int
|
Chris@538
|
274 FsWatcher::getNewToken()
|
Chris@538
|
275 {
|
Chris@538
|
276 QMutexLocker locker(&m_mutex);
|
Chris@538
|
277 int token = ++m_lastToken;
|
Chris@538
|
278 m_tokenMap[token] = m_lastCounter;
|
Chris@538
|
279 return token;
|
Chris@538
|
280 }
|
Chris@538
|
281
|
Chris@538
|
282 QSet<QString>
|
Chris@538
|
283 FsWatcher::getChangedPaths(int token)
|
Chris@538
|
284 {
|
Chris@538
|
285 QMutexLocker locker(&m_mutex);
|
Chris@538
|
286 size_t lastUpdatedAt = m_tokenMap[token];
|
Chris@538
|
287 QSet<QString> changed;
|
Chris@538
|
288 for (QHash<QString, size_t>::const_iterator i = m_changes.begin();
|
Chris@538
|
289 i != m_changes.end(); ++i) {
|
Chris@538
|
290 if (i.value() > lastUpdatedAt) {
|
Chris@538
|
291 changed.insert(i.key());
|
Chris@538
|
292 }
|
Chris@538
|
293 }
|
Chris@538
|
294 m_tokenMap[token] = m_lastCounter;
|
Chris@538
|
295 return changed;
|
Chris@538
|
296 }
|
Chris@538
|
297
|
Chris@538
|
298 void
|
Chris@538
|
299 FsWatcher::fsDirectoryChanged(QString path)
|
Chris@538
|
300 {
|
Chris@538
|
301 {
|
Chris@538
|
302 QMutexLocker locker(&m_mutex);
|
Chris@540
|
303
|
Chris@538
|
304 if (shouldIgnore(path)) return;
|
Chris@540
|
305
|
Chris@540
|
306 QSet<QString> files = scanDirectory(path);
|
Chris@540
|
307 if (files == m_dirContents[path]) {
|
Chris@540
|
308 #ifdef DEBUG_FSWATCHER
|
Chris@540
|
309 std::cerr << "FsWatcher: Directory " << path << " has changed, but not in a way that we are monitoring" << std::endl;
|
Chris@540
|
310 #endif
|
Chris@540
|
311 return;
|
Chris@541
|
312 } else {
|
Chris@541
|
313 #ifdef DEBUG_FSWATCHER
|
Chris@541
|
314 std::cerr << "FsWatcher: Directory " << path << " has changed" << std::endl;
|
Chris@541
|
315 #endif
|
Chris@541
|
316 m_dirContents[path] = files;
|
Chris@540
|
317 }
|
Chris@540
|
318
|
Chris@540
|
319 size_t counter = ++m_lastCounter;
|
Chris@540
|
320 m_changes[path] = counter;
|
Chris@538
|
321 }
|
Chris@540
|
322
|
Chris@538
|
323 emit changed();
|
Chris@538
|
324 }
|
Chris@538
|
325
|
Chris@538
|
326 void
|
Chris@538
|
327 FsWatcher::fsFileChanged(QString path)
|
Chris@538
|
328 {
|
Chris@540
|
329 {
|
Chris@540
|
330 QMutexLocker locker(&m_mutex);
|
Chris@540
|
331
|
Chris@540
|
332 // We don't check whether the file matches an ignore pattern,
|
Chris@540
|
333 // because we are only notified for file changes if we are
|
Chris@540
|
334 // watching the file explicitly, i.e. the file is in the
|
Chris@540
|
335 // tracked file paths list. So we never want to ignore them
|
Chris@540
|
336
|
Chris@563
|
337 #ifdef DEBUG_FSWATCHER
|
Chris@541
|
338 std::cerr << "FsWatcher: Tracked file " << path << " has changed" << std::endl;
|
Chris@563
|
339 #endif
|
Chris@541
|
340
|
Chris@540
|
341 size_t counter = ++m_lastCounter;
|
Chris@540
|
342 m_changes[path] = counter;
|
Chris@540
|
343 }
|
Chris@540
|
344
|
Chris@540
|
345 emit changed();
|
Chris@538
|
346 }
|
Chris@538
|
347
|
Chris@538
|
348 bool
|
Chris@538
|
349 FsWatcher::shouldIgnore(QString path)
|
Chris@538
|
350 {
|
Chris@540
|
351 QFileInfo fi(path);
|
Chris@540
|
352 QString fn(fi.fileName());
|
Chris@540
|
353 foreach (QString pfx, m_ignoredPrefixes) {
|
Chris@541
|
354 if (fn.startsWith(pfx)) {
|
Chris@563
|
355 #ifdef DEBUG_FSWATCHER
|
Chris@541
|
356 std::cerr << "(ignoring: " << path << ")" << std::endl;
|
Chris@563
|
357 #endif
|
Chris@541
|
358 return true;
|
Chris@541
|
359 }
|
Chris@540
|
360 }
|
Chris@540
|
361 foreach (QString sfx, m_ignoredSuffixes) {
|
Chris@541
|
362 if (fn.endsWith(sfx)) {
|
Chris@563
|
363 #ifdef DEBUG_FSWATCHER
|
Chris@541
|
364 std::cerr << "(ignoring: " << path << ")" << std::endl;
|
Chris@563
|
365 #endif
|
Chris@541
|
366 return true;
|
Chris@541
|
367 }
|
Chris@540
|
368 }
|
Chris@540
|
369 return false;
|
Chris@538
|
370 }
|
Chris@538
|
371
|
Chris@540
|
372 QSet<QString>
|
Chris@540
|
373 FsWatcher::scanDirectory(QString path)
|
Chris@540
|
374 {
|
Chris@540
|
375 QSet<QString> files;
|
Chris@540
|
376 QDir d(path);
|
Chris@540
|
377 if (d.exists()) {
|
Chris@540
|
378 d.setFilter(QDir::Files | QDir::NoDotAndDotDot |
|
Chris@540
|
379 QDir::Readable | QDir::NoSymLinks);
|
Chris@540
|
380 foreach (QString entry, d.entryList()) {
|
Chris@540
|
381 if (entry.startsWith('.')) continue;
|
Chris@540
|
382 if (shouldIgnore(entry)) continue;
|
Chris@540
|
383 files.insert(entry);
|
Chris@540
|
384 }
|
Chris@540
|
385 }
|
Chris@541
|
386 // std::cerr << "scanDirectory:" << std::endl;
|
Chris@541
|
387 // foreach (QString f, files) std::cerr << f << std::endl;
|
Chris@540
|
388 return files;
|
Chris@540
|
389 }
|
Chris@540
|
390
|
Chris@540
|
391 void
|
Chris@540
|
392 FsWatcher::debugPrint()
|
Chris@540
|
393 {
|
Chris@540
|
394 #ifdef DEBUG_FSWATCHER
|
Chris@585
|
395 #ifndef Q_OS_MAC
|
Chris@540
|
396 std::cerr << "FsWatcher: Now watching " << m_watcher.directories().size()
|
Chris@540
|
397 << " directories and " << m_watcher.files().size()
|
Chris@540
|
398 << " files" << std::endl;
|
Chris@540
|
399 #endif
|
Chris@585
|
400 #endif
|
Chris@540
|
401 }
|