Timothy Pearson
12 years ago
parent
8f76b98ccc
commit
81dacc29a4
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,293 @@
|
||||
/* This file is part of the KDE libraries
|
||||
Copyright (C) 1998 Sven Radej <sven@lisa.exp.univie.ac.at>
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Library General Public
|
||||
License version 2 as published by the Free Software Foundation.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Library General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Library General Public License
|
||||
along with this library; see the file COPYING.LIB. If not, write to
|
||||
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
||||
Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
#ifndef _KSIMPLEDIRWATCH_H
|
||||
#define _KSIMPLEDIRWATCH_H
|
||||
|
||||
#include <tqtimer.h>
|
||||
#include <tqdatetime.h>
|
||||
#include <tqmap.h>
|
||||
|
||||
#include <tdelibs_export.h>
|
||||
|
||||
#define kdirwatch KSimpleDirWatch::self()
|
||||
|
||||
class KSimpleDirWatchPrivate;
|
||||
|
||||
/**
|
||||
* KSimpleDirWatch is a basic copy of KDirWatch
|
||||
* but with the KIO linking requirement removed
|
||||
*
|
||||
* Watch directories and files for changes.
|
||||
* The watched directories or files don't have to exist yet.
|
||||
*
|
||||
* When a watched directory is changed, i.e. when files therein are
|
||||
* created or deleted, KSimpleDirWatch will emit the signal dirty().
|
||||
*
|
||||
* When a watched, but previously not existing directory gets created,
|
||||
* KSimpleDirWatch will emit the signal created().
|
||||
*
|
||||
* When a watched directory gets deleted, KSimpleDirWatch will emit the
|
||||
* signal deleted(). The directory is still watched for new
|
||||
* creation.
|
||||
*
|
||||
* When a watched file is changed, i.e. attributes changed or written
|
||||
* to, KSimpleDirWatch will emit the signal dirty().
|
||||
*
|
||||
* Scanning of particular directories or files can be stopped temporarily
|
||||
* and restarted. The whole class can be stopped and restarted.
|
||||
* Directories and files can be added/removed from the list in any state.
|
||||
*
|
||||
* The implementation uses the FAM service when available;
|
||||
* if FAM is not available, the DNOTIFY functionality is used on LINUX.
|
||||
* As a last resort, a regular polling for change of modification times
|
||||
* is done; the polling interval is a global config option:
|
||||
* DirWatch/PollInterval and DirWatch/NFSPollInterval for NFS mounted
|
||||
* directories.
|
||||
*
|
||||
* @see self()
|
||||
* @short Class for watching directory and file changes.
|
||||
* @author Sven Radej <sven@lisa.exp.univie.ac.at>
|
||||
*/
|
||||
class KIO_EXPORT KSimpleDirWatch : public TQObject
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* Scanning begins immediately when a dir/file watch
|
||||
* is added.
|
||||
* @param parent the parent of the TQObject (or 0 for parent-less KDataTools)
|
||||
* @param name the name of the TQObject, can be 0
|
||||
*/
|
||||
KSimpleDirWatch (TQObject* parent = 0, const char* name = 0);
|
||||
|
||||
/**
|
||||
* Destructor.
|
||||
*
|
||||
* Stops scanning and cleans up.
|
||||
*/
|
||||
~KSimpleDirWatch();
|
||||
|
||||
/**
|
||||
* Adds a directory to be watched.
|
||||
*
|
||||
* The directory does not have to exist. When @p watchFiles is
|
||||
* false (the default), the signals dirty(), created(), deleted()
|
||||
* can be emitted, all for the watched directory.
|
||||
* When @p watchFiles is true, all files in the watched directory
|
||||
* are watched for changes, too. Thus, the signals dirty(),
|
||||
* created(), deleted() can be emitted.
|
||||
*
|
||||
* @param path the path to watch
|
||||
* @param watchFiles if true, the KSimpleDirWatch will also watch files - NOT IMPLEMENTED YET
|
||||
* @param recursive if true, all sub directories are also watched - NOT IMPLEMENTED YET
|
||||
*/
|
||||
void addDir(const TQString& path,
|
||||
bool watchFiles = false, bool recursive = false);
|
||||
|
||||
/**
|
||||
* Adds a file to be watched.
|
||||
* @param file the file to watch
|
||||
*/
|
||||
void addFile(const TQString& file);
|
||||
|
||||
/**
|
||||
* Returns the time the directory/file was last changed.
|
||||
* @param path the file to check
|
||||
* @return the date of the last modification
|
||||
*/
|
||||
TQDateTime ctime(const TQString& path);
|
||||
|
||||
/**
|
||||
* Removes a directory from the list of scanned directories.
|
||||
*
|
||||
* If specified path is not in the list this does nothing.
|
||||
* @param path the path of the dir to be removed from the list
|
||||
*/
|
||||
void removeDir(const TQString& path);
|
||||
|
||||
/**
|
||||
* Removes a file from the list of watched files.
|
||||
*
|
||||
* If specified path is not in the list this does nothing.
|
||||
* @param file the file to be removed from the list
|
||||
*/
|
||||
void removeFile(const TQString& file);
|
||||
|
||||
/**
|
||||
* Stops scanning the specified path.
|
||||
*
|
||||
* The @p path is not deleted from the interal just, it is just skipped.
|
||||
* Call this function when you perform an huge operation
|
||||
* on this directory (copy/move big files or many files). When finished,
|
||||
* call restartDirScan(path).
|
||||
*
|
||||
* @param path the path to skip
|
||||
* @return true if the @p path is being watched, otherwise false
|
||||
* @see restartDirScanning()
|
||||
*/
|
||||
bool stopDirScan(const TQString& path);
|
||||
|
||||
/**
|
||||
* Restarts scanning for specified path.
|
||||
*
|
||||
* Resets ctime. It doesn't notify
|
||||
* the change (by emitted a signal), since the ctime value is reset.
|
||||
*
|
||||
* Call it when you are finished with big operations on that path,
|
||||
* @em and when @em you have refreshed that path.
|
||||
*
|
||||
* @param path the path to restart scanning
|
||||
* @return true if the @p path is being watched, otherwise false
|
||||
* @see stopDirScanning()
|
||||
*/
|
||||
bool restartDirScan(const TQString& path);
|
||||
|
||||
/**
|
||||
* Starts scanning of all dirs in list.
|
||||
*
|
||||
* @param notify If true, all changed directories (since
|
||||
* stopScan() call) will be notified for refresh. If notify is
|
||||
* false, all ctimes will be reset (except those who are stopped,
|
||||
* but only if @p skippedToo is false) and changed dirs won't be
|
||||
* notified. You can start scanning even if the list is
|
||||
* empty. First call should be called with @p false or else all
|
||||
* directories
|
||||
* in list will be notified.
|
||||
* @param skippedToo if true, the skipped directoris (scanning of which was
|
||||
* stopped with stopDirScan() ) will be reset and notified
|
||||
* for change. Otherwise, stopped directories will continue to be
|
||||
* unnotified.
|
||||
*/
|
||||
void startScan( bool notify=false, bool skippedToo=false );
|
||||
|
||||
/**
|
||||
* Stops scanning of all directories in internal list.
|
||||
*
|
||||
* The timer is stopped, but the list is not cleared.
|
||||
*/
|
||||
void stopScan();
|
||||
|
||||
/**
|
||||
* Is scanning stopped?
|
||||
* After creation of a KSimpleDirWatch instance, this is false.
|
||||
* @return true when scanning stopped
|
||||
*/
|
||||
bool isStopped() { return _isStopped; }
|
||||
|
||||
/**
|
||||
* Check if a directory is being watched by this KSimpleDirWatch instance
|
||||
* @param path the directory to check
|
||||
* @return true if the directory is being watched
|
||||
*/
|
||||
bool contains( const TQString& path ) const;
|
||||
|
||||
/**
|
||||
* Dump statistic information about all KSimpleDirWatch instances.
|
||||
* This checks for consistency, too.
|
||||
*/
|
||||
static void statistics();
|
||||
|
||||
/**
|
||||
* Emits created().
|
||||
* @param path the path of the file or directory
|
||||
*/
|
||||
void setCreated( const TQString &path );
|
||||
/**
|
||||
* Emits dirty().
|
||||
* @param path the path of the file or directory
|
||||
*/
|
||||
void setDirty( const TQString &path );
|
||||
/**
|
||||
* Emits deleted().
|
||||
* @param path the path of the file or directory
|
||||
*/
|
||||
void setDeleted( const TQString &path );
|
||||
|
||||
enum Method { FAM, DNotify, Stat, INotify };
|
||||
/**
|
||||
* Returns the preferred internal method to
|
||||
* watch for changes.
|
||||
* @since 3.2
|
||||
*/
|
||||
Method internalMethod();
|
||||
|
||||
/**
|
||||
* The KSimpleDirWatch instance usually globally used in an application.
|
||||
* It is automatically deleted when the application exits.
|
||||
*
|
||||
* However, you can create an arbitrary number of KSimpleDirWatch instances
|
||||
* aside from this one - for those you have to take care of memory management.
|
||||
*
|
||||
* This function returns an instance of KSimpleDirWatch. If there is none, it
|
||||
* will be created.
|
||||
*
|
||||
* @return a KSimpleDirWatch instance
|
||||
*/
|
||||
static KSimpleDirWatch* self();
|
||||
/**
|
||||
* Returns true if there is an instance of KSimpleDirWatch.
|
||||
* @return true if there is an instance of KSimpleDirWatch.
|
||||
* @see KSimpleDirWatch::self()
|
||||
* @since 3.1
|
||||
*/
|
||||
static bool exists();
|
||||
|
||||
signals:
|
||||
|
||||
/**
|
||||
* Emitted when a watched object is changed.
|
||||
* For a directory this signal is emitted when files
|
||||
* therein are created or deleted.
|
||||
* For a file this signal is emitted when its size or attributes change.
|
||||
*
|
||||
* When you watch a directory, changes in the size or attributes of
|
||||
* contained files may or may not trigger this signal to be emitted
|
||||
* depending on which backend is used by KSimpleDirWatch.
|
||||
*
|
||||
* The new ctime is set before the signal is emitted.
|
||||
* @param path the path of the file or directory
|
||||
*/
|
||||
void dirty (const TQString &path);
|
||||
|
||||
/**
|
||||
* Emitted when a file or directory is created.
|
||||
* @param path the path of the file or directory
|
||||
*/
|
||||
void created (const TQString &path );
|
||||
|
||||
/**
|
||||
* Emitted when a file or directory is deleted.
|
||||
*
|
||||
* The object is still watched for new creation.
|
||||
* @param path the path of the file or directory
|
||||
*/
|
||||
void deleted (const TQString &path );
|
||||
|
||||
private:
|
||||
bool _isStopped;
|
||||
|
||||
KSimpleDirWatchPrivate *d;
|
||||
static KSimpleDirWatch* s_pSelf;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
// vim: sw=3 et
|
||||
@ -0,0 +1,161 @@
|
||||
/* Private Header for class of KSimpleDirWatchPrivate
|
||||
*
|
||||
* this separate header file is needed for TQMOC processing
|
||||
* because KSimpleDirWatchPrivate has signals and slots
|
||||
*
|
||||
* KSimpleDirWatch is a basic copy of KDirWatch
|
||||
* but with the KIO linking requirement removed
|
||||
*/
|
||||
|
||||
#ifndef _KSIMPLEDIRWATCH_P_H
|
||||
#define _KSIMPLEDIRWATCH_P_H
|
||||
|
||||
#ifdef HAVE_FAM
|
||||
#include <fam.h>
|
||||
#endif
|
||||
|
||||
#include <ctime>
|
||||
|
||||
#define invalid_ctime ((time_t)-1)
|
||||
|
||||
/* KSimpleDirWatchPrivate is a singleton and does the watching
|
||||
* for every KSimpleDirWatch instance in the application.
|
||||
*/
|
||||
class KSimpleDirWatchPrivate : public TQObject
|
||||
{
|
||||
Q_OBJECT
|
||||
public:
|
||||
|
||||
enum entryStatus { Normal = 0, NonExistent };
|
||||
enum entryMode { UnknownMode = 0, StatMode, DNotifyMode, INotifyMode, FAMMode };
|
||||
enum { NoChange=0, Changed=1, Created=2, Deleted=4 };
|
||||
|
||||
struct Client {
|
||||
KSimpleDirWatch* instance;
|
||||
int count;
|
||||
// did the instance stop watching
|
||||
bool watchingStopped;
|
||||
// events blocked when stopped
|
||||
int pending;
|
||||
};
|
||||
|
||||
class Entry
|
||||
{
|
||||
public:
|
||||
// the last observed modification time
|
||||
time_t m_ctime;
|
||||
// the last observed link count
|
||||
int m_nlink;
|
||||
entryStatus m_status;
|
||||
entryMode m_mode;
|
||||
bool isDir;
|
||||
// instances interested in events
|
||||
TQPtrList<Client> m_clients;
|
||||
// nonexistent entries of this directory
|
||||
TQPtrList<Entry> m_entries;
|
||||
TQString path;
|
||||
|
||||
int msecLeft, freq;
|
||||
|
||||
void addClient(KSimpleDirWatch*);
|
||||
void removeClient(KSimpleDirWatch*);
|
||||
int clients();
|
||||
bool isValid() { return m_clients.count() || m_entries.count(); }
|
||||
|
||||
bool dirty;
|
||||
void propagate_dirty();
|
||||
|
||||
#ifdef HAVE_FAM
|
||||
FAMRequest fr;
|
||||
#endif
|
||||
|
||||
#ifdef HAVE_DNOTIFY
|
||||
int dn_fd;
|
||||
#endif
|
||||
#ifdef HAVE_INOTIFY
|
||||
int wd;
|
||||
#endif
|
||||
};
|
||||
|
||||
typedef TQMap<TQString,Entry> EntryMap;
|
||||
|
||||
KSimpleDirWatchPrivate();
|
||||
~KSimpleDirWatchPrivate();
|
||||
|
||||
void resetList (KSimpleDirWatch*,bool);
|
||||
void useFreq(Entry* e, int newFreq);
|
||||
void addEntry(KSimpleDirWatch*,const TQString&, Entry*, bool);
|
||||
void removeEntry(KSimpleDirWatch*,const TQString&, Entry*);
|
||||
bool stopEntryScan(KSimpleDirWatch*, Entry*);
|
||||
bool restartEntryScan(KSimpleDirWatch*, Entry*, bool );
|
||||
void stopScan(KSimpleDirWatch*);
|
||||
void startScan(KSimpleDirWatch*, bool, bool);
|
||||
|
||||
void removeEntries(KSimpleDirWatch*);
|
||||
void statistics();
|
||||
|
||||
Entry* entry(const TQString&);
|
||||
int scanEntry(Entry* e);
|
||||
void emitEvent(Entry* e, int event, const TQString &fileName = TQString::null);
|
||||
|
||||
// Memory management - delete when last KSimpleDirWatch gets deleted
|
||||
void ref() { m_ref++; }
|
||||
bool deref() { return ( --m_ref == 0 ); }
|
||||
|
||||
static bool isNoisyFile( const char *filename );
|
||||
|
||||
public slots:
|
||||
void slotRescan();
|
||||
void famEventReceived(); // for FAM
|
||||
void slotActivated(); // for DNOTIFY
|
||||
void slotRemoveDelayed();
|
||||
|
||||
public:
|
||||
TQTimer *timer;
|
||||
EntryMap m_mapEntries;
|
||||
|
||||
int freq;
|
||||
int statEntries;
|
||||
int m_nfsPollInterval, m_PollInterval;
|
||||
int m_ref;
|
||||
bool useStat(Entry*);
|
||||
|
||||
bool delayRemove;
|
||||
TQPtrList<Entry> removeList;
|
||||
|
||||
bool rescan_all;
|
||||
TQTimer rescan_timer;
|
||||
|
||||
#ifdef HAVE_FAM
|
||||
TQSocketNotifier *sn;
|
||||
FAMConnection fc;
|
||||
bool use_fam;
|
||||
|
||||
void checkFAMEvent(FAMEvent*);
|
||||
bool useFAM(Entry*);
|
||||
#endif
|
||||
|
||||
#if defined(HAVE_DNOTIFY) || defined(HAVE_INOTIFY)
|
||||
TQSocketNotifier *mSn;
|
||||
#endif
|
||||
|
||||
#ifdef HAVE_DNOTIFY
|
||||
bool supports_dnotify;
|
||||
int mPipe[2];
|
||||
TQIntDict<Entry> fd_Entry;
|
||||
|
||||
static void dnotify_handler(int, siginfo_t *si, void *);
|
||||
static void dnotify_sigio_handler(int, siginfo_t *si, void *);
|
||||
bool useDNotify(Entry*);
|
||||
#endif
|
||||
|
||||
#ifdef HAVE_INOTIFY
|
||||
bool supports_inotify;
|
||||
int m_inotify_fd;
|
||||
|
||||
bool useINotify(Entry*);
|
||||
#endif
|
||||
};
|
||||
|
||||
#endif // KSIMPLEDIRWATCH_P_H
|
||||
|
||||
Loading…
Reference in new issue