summaryrefslogtreecommitdiff
path: root/libopie2
authormickeyl <mickeyl>2005-05-06 20:18:58 (UTC)
committer mickeyl <mickeyl>2005-05-06 20:18:58 (UTC)
commite8bb0ef7701e6bb565dc178424687e82b12bd8ec (patch) (unidiff)
treedb22a14ae11f6ec2b942b51af6def4e03d3a8f50 /libopie2
parent8b1a64ffe497f5395544c6702225003aca293f80 (diff)
downloadopie-e8bb0ef7701e6bb565dc178424687e82b12bd8ec.zip
opie-e8bb0ef7701e6bb565dc178424687e82b12bd8ec.tar.gz
opie-e8bb0ef7701e6bb565dc178424687e82b12bd8ec.tar.bz2
first sketch at ODirNotification class
Diffstat (limited to 'libopie2') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiecore/ofilenotify.cpp31
-rw-r--r--libopie2/opiecore/ofilenotify.h10
2 files changed, 31 insertions, 10 deletions
diff --git a/libopie2/opiecore/ofilenotify.cpp b/libopie2/opiecore/ofilenotify.cpp
index efd041a..11d4f87 100644
--- a/libopie2/opiecore/ofilenotify.cpp
+++ b/libopie2/opiecore/ofilenotify.cpp
@@ -32,139 +32,139 @@ using namespace Opie::Core;
32/* OPIE */ 32/* OPIE */
33 33
34/* QT */ 34/* QT */
35#include <qobject.h> 35#include <qobject.h>
36#include <qsocketnotifier.h> 36#include <qsocketnotifier.h>
37#include <qsignal.h> 37#include <qsignal.h>
38#include <qintdict.h> 38#include <qintdict.h>
39#include <qdir.h> 39#include <qdir.h>
40 40
41/* STD */ 41/* STD */
42#include <sys/types.h> 42#include <sys/types.h>
43#include <sys/stat.h> 43#include <sys/stat.h>
44#include <sys/ioctl.h> 44#include <sys/ioctl.h>
45#include <fcntl.h> 45#include <fcntl.h>
46#include <assert.h> 46#include <assert.h>
47#include <string.h> 47#include <string.h>
48#include <errno.h> 48#include <errno.h>
49#include <unistd.h> 49#include <unistd.h>
50 50
51static QIntDict<OFileNotification> notification_list; 51static QIntDict<OFileNotification> notification_list;
52 52
53QSocketNotifier* OFileNotification::_sn; 53QSocketNotifier* OFileNotification::_sn;
54int OFileNotification::_fd = -1; 54int OFileNotification::_fd = -1;
55 55
56#define INOTIFY_DEVICE "/dev/inotify" 56#define INOTIFY_DEVICE "/dev/inotify"
57 57
58namespace Opie { 58namespace Opie {
59namespace Core { 59namespace Core {
60 60
61OFileNotification::OFileNotification( QObject* parent, const char* name ) 61OFileNotification::OFileNotification( QObject* parent, const char* name )
62 :QObject( parent, name ), _active( false ), _multi( true ) 62 :QObject( parent, name ), _active( false ), _multi( true )
63{ 63{
64 qDebug( "OFileNotification::OFileNotification()" ); 64 qDebug( "OFileNotification::OFileNotification()" );
65} 65}
66 66
67 67
68OFileNotification::~OFileNotification() 68OFileNotification::~OFileNotification()
69{ 69{
70 stop(); 70 stop();
71 qDebug( "OFileNotification::~OFileNotification()" ); 71 qDebug( "OFileNotification::~OFileNotification()" );
72} 72}
73 73
74 74
75bool OFileNotification::isActive() const 75bool OFileNotification::isActive() const
76{ 76{
77 return _active; 77 return _active;
78} 78}
79 79
80 80
81int OFileNotification::watch( const QString& path, bool sshot, OFileNotificationType type ) 81int OFileNotification::watch( const QString& path, bool sshot, OFileNotificationType type )
82{ 82{
83 // check if path exists and is a regular file 83 // check if path exists and is a regular file
84 struct stat s; 84 struct stat s;
85 if ( ::stat( (const char*) path, &s ) == -1 ) 85 if ( ::stat( (const char*) path, &s ) == -1 )
86 { 86 {
87 qWarning( "OFileNotification::watch(): Can't watch '%s': %s.", (const char*) path, strerror( errno ) ); 87 qWarning( "OFileNotification::watch(): Can't watch '%s': %s.", (const char*) path, strerror( errno ) );
88 return -1; 88 return -1;
89 } 89 }
90 if ( !S_ISREG( s.st_mode ) ) 90 if ( !S_ISREG( s.st_mode ) )
91 { 91 {
92 qWarning( "OFileNotification::watch(): Can't watch '%s': %s.", (const char*) path, "not a regular file" ); 92 qWarning( "OFileNotification::watch(): Can't watch '%s': %s.", (const char*) path, "not a regular file" );
93 return -1; 93 return -1;
94 } 94 }
95 95
96 if ( notification_list.isEmpty() )
97 {
98 OFileNotification::registerEventHandler();
99 }
100
101 return startWatching( path, sshot, type ); 96 return startWatching( path, sshot, type );
102} 97}
103 98
104 99
105int OFileNotification::startWatching( const QString& path, bool sshot, OFileNotificationType type ) 100int OFileNotification::startWatching( const QString& path, bool sshot, OFileNotificationType type )
106{ 101{
102 if ( notification_list.isEmpty() )
103 {
104 OFileNotification::registerEventHandler();
105 }
106
107 struct inotify_watch_request iwr; 107 struct inotify_watch_request iwr;
108 ::memset( &iwr, 0, sizeof iwr ); 108 ::memset( &iwr, 0, sizeof iwr );
109 iwr.name = const_cast<char*>( (const char*) path ); 109 iwr.name = const_cast<char*>( (const char*) path );
110 iwr.mask = type; 110 iwr.mask = type;
111 111
112 _wd = ::ioctl( OFileNotification::_fd, INOTIFY_WATCH, &iwr ); 112 _wd = ::ioctl( OFileNotification::_fd, INOTIFY_WATCH, &iwr );
113 113
114 if ( _wd < 0 ) 114 if ( _wd < 0 )
115 { 115 {
116 qWarning( "OFileNotification::watch(): inotify can't watch '%s': %s.", (const char*) path, strerror( errno ) ); 116 qWarning( "OFileNotification::watch(): inotify can't watch '%s': %s.", (const char*) path, strerror( errno ) );
117 return -1; 117 return -1;
118 } 118 }
119 119
120 notification_list.insert( _wd, this ); 120 notification_list.insert( _wd, this );
121 _path = path; 121 _path = path;
122 _multi = !sshot; 122 _multi = !sshot;
123 _type = type; 123 _type = type;
124 _active = true; 124 _active = true;
125 qDebug( "OFileNotification::watch(): watching '%s' [wd=%d].", (const char*) path, _wd ); 125 qDebug( "OFileNotification::watch(): watching '%s' [wd=%d].", (const char*) path, _wd );
126 return _wd; 126 return _wd;
127} 127}
128 128
129 129
130void OFileNotification::stop() 130void OFileNotification::stop()
131{ 131{
132 notification_list.remove( _wd ); 132 notification_list.remove( _wd );
133 _path = QString::null; 133 _path = QString::null;
134 _wd = 0; 134 _wd = 0;
135 _active = false; 135 _active = false;
136 if ( notification_list.isEmpty() ) 136 if ( notification_list.isEmpty() )
137 { 137 {
138 OFileNotification::unregisterEventHandler(); 138 OFileNotification::unregisterEventHandler();
139 } 139 }
140} 140}
141 141
142 142
143OFileNotificationType OFileNotification::type() const 143OFileNotificationType OFileNotification::type() const
144{ 144{
145 return _type; 145 return _type;
146} 146}
147 147
148 148
149QString OFileNotification::path() const 149QString OFileNotification::path() const
150{ 150{
151 return _path; 151 return _path;
152} 152}
153 153
154 154
155bool OFileNotification::activate() 155bool OFileNotification::activate()
156{ 156{
157 emit triggered( _path ); 157 emit triggered( _path );
158 _signal.activate(); 158 _signal.activate();
159 if ( !_multi ) stop(); 159 if ( !_multi ) stop();
160 return true; 160 return true;
161} 161}
162 162
163 163
164bool OFileNotification::singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type ) 164bool OFileNotification::singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type )
165{ 165{
166 OFileNotification* ofn = new OFileNotification(); 166 OFileNotification* ofn = new OFileNotification();
167 ofn->_signal.connect( receiver, member ); 167 ofn->_signal.connect( receiver, member );
168 return ofn->watch( path, true, type ) != -1; 168 return ofn->watch( path, true, type ) != -1;
169} 169}
170 170
@@ -194,70 +194,85 @@ void OFileNotification::inotifyEventHandler()
194 qDebug( "pevent->len = %d\n", pevent->len); 194 qDebug( "pevent->len = %d\n", pevent->len);
195 195
196 OFileNotification* fn = notification_list[ pevent->wd ]; 196 OFileNotification* fn = notification_list[ pevent->wd ];
197 if ( fn ) 197 if ( fn )
198 fn->activate(); 198 fn->activate();
199 else 199 else
200 assert( false ); 200 assert( false );
201 201
202 //event = malloc(event_size); 202 //event = malloc(event_size);
203 //memmove(event, pevent, event_size); 203 //memmove(event, pevent, event_size);
204 //queue_enqueue(event, q); 204 //queue_enqueue(event, q);
205 buffer_i += event_size; 205 buffer_i += event_size;
206 count++; 206 count++;
207 } 207 }
208 208
209 qDebug( "received %d events...", count ); 209 qDebug( "received %d events...", count );
210 return; 210 return;
211} 211}
212 212
213 213
214bool OFileNotification::registerEventHandler() 214bool OFileNotification::registerEventHandler()
215{ 215{
216 OFileNotification::_fd = ::open( INOTIFY_DEVICE, O_RDONLY ); 216 OFileNotification::_fd = ::open( INOTIFY_DEVICE, O_RDONLY );
217 if ( OFileNotification::_fd < 0 ) 217 if ( OFileNotification::_fd < 0 )
218 { 218 {
219 qWarning( "OFileNotification::registerEventHandler(): couldn't register event handler: %s", strerror( errno ) ); 219 qWarning( "OFileNotification::registerEventHandler(): couldn't register event handler: %s", strerror( errno ) );
220 return false; 220 return false;
221 } 221 }
222 222
223 OFileNotification::_sn = new QSocketNotifier( _fd, QSocketNotifier::Read, this, "inotify event" ); 223 OFileNotification::_sn = new QSocketNotifier( _fd, QSocketNotifier::Read, this, "inotify event" );
224 connect( OFileNotification::_sn, SIGNAL( activated(int) ), this, SLOT( inotifyEventHandler() ) ); 224 connect( OFileNotification::_sn, SIGNAL( activated(int) ), this, SLOT( inotifyEventHandler() ) );
225 225
226 qDebug( "OFileNotification::registerEventHandler(): done" ); 226 qDebug( "OFileNotification::registerEventHandler(): done" );
227 return true; 227 return true;
228} 228}
229 229
230 230
231void OFileNotification::unregisterEventHandler() 231void OFileNotification::unregisterEventHandler()
232{ 232{
233 if ( _sn ) delete _sn; 233 if ( _sn ) delete _sn;
234 if ( OFileNotification::_fd ) 234 if ( OFileNotification::_fd )
235 ::close( OFileNotification::_fd ); 235 ::close( OFileNotification::_fd );
236 qDebug( "OFileNotification::unregisterEventHandler(): done" ); 236 qDebug( "OFileNotification::unregisterEventHandler(): done" );
237} 237}
238 238
239//================================================================================================= 239//=================================================================================================
240// ODirNotification 240// ODirNotification
241//================================================================================================= 241//=================================================================================================
242ODirNotification::ODirNotification( QObject* parent, const char* name ) 242ODirNotification::ODirNotification( QObject* parent, const char* name )
243 :QObject( parent, name ) 243 :QObject( parent, name )
244{ 244{
245 qDebug( "ODirNotification::ODirNotification()" ); 245 qDebug( "ODirNotification::ODirNotification()" );
246} 246}
247 247
248 248
249ODirNotification::~ODirNotification() 249ODirNotification::~ODirNotification()
250{ 250{
251 qDebug( "ODirNotification::~ODirNotification()" ); 251 qDebug( "ODirNotification::~ODirNotification()" );
252} 252}
253 253
254 254
255int ODirNotification::watch( const QString& path, bool sshot, OFileNotificationType type, int recurse ) 255int ODirNotification::watch( const QString& path, bool sshot, OFileNotificationType type, int recurse )
256{ 256{
257 qDebug( "ODirNotification::watch( %s, %d, 0x%08x, %d )", (const char*) path, sshot, type, recurse ); 257 qDebug( "ODirNotification::watch( %s, %d, 0x%08x, %d )", (const char*) path, sshot, type, recurse );
258 return 0;
259}
260 258
259 if ( recurse == 0 )
260 {
261 OFileNotification* fn = new OFileNotification( this, "ODirNotification delegate" );
262 int result = fn->startWatching( path, sshot, type );
263 if ( result != -1 )
264 {
265 connect( fn, SIGNAL( triggered( const QString& ) ), this, SIGNAL( triggered( const QString& ) ) );
266 return result;
267 }
268 }
269 else
270 {
271 qDebug( "ODirNotification::watch(), recursion not yet implemented... :)" );
272 return -1;
273 }
261} 274}
262 275
263} \ No newline at end of file 276} // namespace Ui
277
278} // namespace Opie
diff --git a/libopie2/opiecore/ofilenotify.h b/libopie2/opiecore/ofilenotify.h
index 41ba84d..3eb917e 100644
--- a/libopie2/opiecore/ofilenotify.h
+++ b/libopie2/opiecore/ofilenotify.h
@@ -68,165 +68,171 @@ namespace Core {
68 * <li>Unmount = The backing filesystem was unmounted 68 * <li>Unmount = The backing filesystem was unmounted
69 * </ul> 69 * </ul>
70 * 70 *
71 **/ 71 **/
72 72
73enum OFileNotificationType 73enum OFileNotificationType
74{ 74{
75 Access = IN_ACCESS, 75 Access = IN_ACCESS,
76 Modify = IN_MODIFY, 76 Modify = IN_MODIFY,
77 Attrib = IN_ATTRIB, 77 Attrib = IN_ATTRIB,
78 CloseWrite = IN_CLOSE_WRITE, 78 CloseWrite = IN_CLOSE_WRITE,
79 CloseNoWrite = IN_CLOSE_NOWRITE, 79 CloseNoWrite = IN_CLOSE_NOWRITE,
80 Open = IN_OPEN, 80 Open = IN_OPEN,
81 MovedFrom = IN_MOVED_FROM, 81 MovedFrom = IN_MOVED_FROM,
82 MovedTo = IN_MOVED_TO, 82 MovedTo = IN_MOVED_TO,
83 DeleteSubdir = IN_DELETE_SUBDIR, 83 DeleteSubdir = IN_DELETE_SUBDIR,
84 DeleteFile = IN_DELETE_FILE, 84 DeleteFile = IN_DELETE_FILE,
85 CreateSubdir = IN_CREATE_SUBDIR, 85 CreateSubdir = IN_CREATE_SUBDIR,
86 CreateFile = IN_CREATE_FILE, 86 CreateFile = IN_CREATE_FILE,
87 DeleteSelf = IN_DELETE_SELF, 87 DeleteSelf = IN_DELETE_SELF,
88 Unmount = IN_UNMOUNT, 88 Unmount = IN_UNMOUNT,
89 _QueueOverflow = IN_Q_OVERFLOW, /* Internal, don't use this in client code */ 89 _QueueOverflow = IN_Q_OVERFLOW, /* Internal, don't use this in client code */
90 _Ignored = IN_IGNORED, /* Internal, don't use this in client code */ 90 _Ignored = IN_IGNORED, /* Internal, don't use this in client code */
91}; 91};
92 92
93/*====================================================================================== 93/*======================================================================================
94 * OFileNotification 94 * OFileNotification
95 *======================================================================================*/ 95 *======================================================================================*/
96 96
97/** 97/**
98 * @brief Represents a file notification 98 * @brief Represents a file notification
99 * 99 *
100 * This class allows to watch for events happening to files. 100 * This class allows to watch for events happening to files.
101 * It uses the inotify linux (2.6.x) kernel interface. 101 * It uses the inotify linux (2.6.x) kernel interface.
102 * 102 *
103 * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/ 103 * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/
104 * 104 *
105 * @author Michael 'Mickey' Lauer <mickey@vanille.de> 105 * @author Michael 'Mickey' Lauer <mickey@vanille.de>
106 * 106 *
107 **/ 107 **/
108 108
109class OFileNotification : public QObject 109class OFileNotification : public QObject
110{ 110{
111 Q_OBJECT 111 Q_OBJECT
112 112
113 public: 113 public:
114 OFileNotification( QObject* parent = 0, const char* name = 0 ); 114 OFileNotification( QObject* parent = 0, const char* name = 0 );
115 ~OFileNotification(); 115 ~OFileNotification();
116 /** 116 /**
117 * This static function calls a slot when an event with @a type happens to file @a path. 117 * This static function calls a slot when an event with @a type happens to file @a path.
118 * 118 *
119 * It is very convenient to use this function because you do not need to 119 * It is very convenient to use this function because you do not need to
120 * bother with a timerEvent or to create a local QTimer object. 120 * bother with a timerEvent or to create a local QTimer object.
121 * 121 *
122 * Example: 122 * Example:
123 * <pre> 123 * <pre>
124 * 124 *
125 * #include <opie2/oapplication.h> 125 * #include <opie2/oapplication.h>
126 * #include <opie2/ofilenotify.h> 126 * #include <opie2/ofilenotify.h>
127 * using namespace Opie::Core; 127 * using namespace Opie::Core;
128 * 128 *
129 * int main( int argc, char **argv ) 129 * int main( int argc, char **argv )
130 * { 130 * {
131 * OApplication a( argc, argv, "File Notification Example" ); 131 * OApplication a( argc, argv, "File Notification Example" );
132 * OFileNotification::singleShot( "/tmp/quit", &a, SLOT(quit()), Create ); 132 * OFileNotification::singleShot( "/tmp/quit", &a, SLOT(quit()), Access );
133 * ... // create and show your widgets 133 * ... // create and show your widgets
134 * return a.exec(); 134 * return a.exec();
135 * } 135 * }
136 * </pre> 136 * </pre>
137 * 137 *
138 * This sample program automatically terminates when the file "/tmp/quit" has been created. 138 * This sample program automatically terminates when the file "/tmp/quit" has been accessed.
139 * 139 *
140 * 140 *
141 * The @a receiver is the receiving object and the @a member is the slot. 141 * The @a receiver is the receiving object and the @a member is the slot.
142 **/ 142 **/
143 static bool singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type = Modify ); 143 static bool singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type = Modify );
144 /** 144 /**
145 * Starts to watch for @a type changes to @a path. Set @a sshot to True if you want to be notified only once. 145 * Starts to watch for @a type changes to @a path. Set @a sshot to True if you want to be notified only once.
146 * Note that in that case it may be more convenient to use @ref OFileNotification::singleShot() then. 146 * Note that in that case it may be more convenient to use @ref OFileNotification::singleShot() then.
147 **/ 147 **/
148 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify ); 148 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify );
149 /** 149 /**
150 * Stop watching for file events. 150 * Stop watching for file events.
151 **/ 151 **/
152 void stop(); 152 void stop();
153 /** 153 /**
154 * @returns the notification type as set by @ref start(). 154 * @returns the notification type as set by @ref start().
155 **/ 155 **/
156 OFileNotificationType type() const; 156 OFileNotificationType type() const;
157 /** 157 /**
158 * @returns the path to the file being watched by this instance. 158 * @returns the path to the file being watched by this instance.
159 **/ 159 **/
160 QString path() const; 160 QString path() const;
161 /** 161 /**
162 * @returns if a file is currently being watched. 162 * @returns if a file is currently being watched.
163 **/ 163 **/
164 bool isActive() const; 164 bool isActive() const;
165 /** 165 /**
166 * @internal 166 * @internal
167 */ 167 */
168 int startWatching( const QString& path, bool sshot = false, OFileNotificationType type = Modify ); 168 int startWatching( const QString& path, bool sshot = false, OFileNotificationType type = Modify );
169 169
170 signals: 170 signals:
171 /** 171 /**
172 * This signal is emitted if an event happens of the specified type happens to the file being watched. 172 * This signal is emitted if an event happens of the specified type happens to the file being watched.
173 **/ 173 **/
174 void triggered( const QString& name ); 174 void triggered( const QString& name );
175 175
176 protected: 176 protected:
177 bool activate(); 177 bool activate();
178 178
179 private slots: 179 private slots:
180 void inotifyEventHandler(); 180 void inotifyEventHandler();
181 181
182 private: 182 private:
183 bool registerEventHandler(); 183 bool registerEventHandler();
184 void unregisterEventHandler(); 184 void unregisterEventHandler();
185 185
186 QString _path; 186 QString _path;
187 OFileNotificationType _type; 187 OFileNotificationType _type;
188 QSignal _signal; 188 QSignal _signal;
189 bool _active; 189 bool _active;
190 bool _multi; 190 bool _multi;
191 static QSocketNotifier* _sn; 191 static QSocketNotifier* _sn;
192 int _wd; // inotify watch descriptor 192 int _wd; // inotify watch descriptor
193 static int _fd; // inotify device descriptor 193 static int _fd; // inotify device descriptor
194}; 194};
195 195
196/*====================================================================================== 196/*======================================================================================
197 * ODirNotification 197 * ODirNotification
198 *======================================================================================*/ 198 *======================================================================================*/
199 199
200/** 200/**
201 * @brief Represents a directory notification 201 * @brief Represents a directory notification
202 * 202 *
203 * This class allows to watch for events happening to directories 203 * This class allows to watch for events happening to directories
204 * It uses the OFileNotification class 204 * It uses the OFileNotification class
205 * 205 *
206 * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/ 206 * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/
207 * 207 *
208 * @author Michael 'Mickey' Lauer <mickey@vanille.de> 208 * @author Michael 'Mickey' Lauer <mickey@vanille.de>
209 * 209 *
210 **/ 210 **/
211 211
212class ODirNotification : public QObject 212class ODirNotification : public QObject
213{ 213{
214 Q_OBJECT 214 Q_OBJECT
215 215
216 public: 216 public:
217 ODirNotification( QObject* parent = 0, const char* name = 0 ); 217 ODirNotification( QObject* parent = 0, const char* name = 0 );
218 ~ODirNotification(); 218 ~ODirNotification();
219 /** 219 /**
220 * Starts to watch for @a type changes to @a path. Recurse @a recurse levels down the filesystem tree, 220 * Starts to watch for @a type changes to @a path. Recurse @a recurse levels down the filesystem tree,
221 * use 0 for no recursion and -1 for unlimited recursion. 221 * use 0 for no recursion and -1 for unlimited recursion.
222 * Set @a sshot to True if you want to be notified only once. 222 * Set @a sshot to True if you want to be notified only once.
223 **/ 223 **/
224 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify, int recurse = 0 ); 224 int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify, int recurse = 0 );
225
226 signals:
227 /**
228 * This signal is emitted if an event happens of the specified type happens to the directory being watched.
229 **/
230 void triggered( const QString& name );
225}; 231};
226 232
227 233
228} 234}
229} 235}
230 236
231#endif 237#endif
232 238