introduce OFileNotifyEvent and add more signals

2 files changed, 154 insertions, 31 deletions

diff --git a/libopie2/opiecore/ofilenotify.cpp b/libopie2/opiecore/ofilenotify.cpp
index 11d4f87..4264327 100644
--- a/libopie2/opiecore/ofilenotify.cpp
+++ b/libopie2/opiecore/ofilenotify.cpp
@@ -55,12 +55,30 @@ int OFileNotification::_fd = -1;
 
 #define INOTIFY_DEVICE "/dev/inotify"
 
 namespace Opie {
 namespace Core {
 
+//=================================================================================================
+// OFileNotificationEvent
+//=================================================================================================
+OFileNotificationEvent::OFileNotificationEvent( OFileNotification* parent, int wd, unsigned int mask, unsigned int cookie, const QString& name )
+                       :_parent( parent ), _wd( wd ), _mask( mask ), _cookie( cookie ), _name( name )
+{
+    qDebug( "OFileNotificationEvent()" );
+}
+
+
+OFileNotificationEvent::~OFileNotificationEvent()
+{
+    qDebug( "~OFileNotificationEvent()" );
+}
+
+//=================================================================================================
+// OFileNotification
+//=================================================================================================
 OFileNotification::OFileNotification( QObject* parent, const char* name )
                   :QObject( parent, name ), _active( false ), _multi( true )
 {
     qDebug( "OFileNotification::OFileNotification()" );
 }
 
@@ -149,17 +167,44 @@ OFileNotificationType OFileNotification::type() const
 QString OFileNotification::path() const
 {
     return _path;
 }
 
 
-bool OFileNotification::activate()
+bool OFileNotification::activate( const OFileNotificationEvent* e )
 {
-    emit triggered( _path );
+    qDebug( "OFileNotification::activate(): e = ( %s, %d, 0x%08x, %d, %s )", (const char*) _path, e->descriptor(), e->mask(), e->cookie(), (const char*) e->name() );
+
+    // dumb signal
     _signal.activate();
+
+    // generic signal
+    emit triggered( _path, e->mask(), e->name() );
+
+    // specialized signals
+    switch ( e->mask() )
+    {
+        case Access:        emit accessed( _path );                 break;
+        case Modify:        emit modified( _path );                 break;
+        case Attrib:        emit attributed( _path);                break;
+        case CloseWrite:    emit closed( _path, true );             break;
+        case CloseNoWrite:  emit closed( _path, false );            break;
+        case Open:          emit opened( _path );                   break;
+        case MovedFrom:     emit movedFrom( _path, e->name() );     break;
+        case MovedTo:       emit movedTo( _path, e->name() );       break;
+        case DeleteSubdir:  emit deletedSubdir( _path, e->name() ); break;
+        case DeleteFile:    emit deletedFile( _path, e->name() );   break;
+        case CreateSubdir:  emit createdSubdir( _path, e->name() ); break;
+        case CreateFile:    emit createdFile( _path, e->name() );   break;
+        case DeleteSelf:    emit deleted( _path );                  break;
+        case Unmount:       emit unmounted( _path );                break;
+        default: assert( 0 );
+    }
+
     if ( !_multi ) stop();
+
     return true;
 }
 
 
 bool OFileNotification::singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type )
 {
@@ -168,13 +213,13 @@ bool OFileNotification::singleShot( const QString& path, QObject* receiver, cons
     return ofn->watch( path, true, type ) != -1;
 }
 
 
 void OFileNotification::inotifyEventHandler()
 {
-    qWarning( "OFileNotification::__eventHandler(): reached." );
+    qDebug( "OFileNotification::inotifyEventHandler(): reached." );
 
     char buffer[16384];
     size_t buffer_i;
     struct inotify_event *pevent, *event;
     ssize_t r;
     size_t event_size;
@@ -185,32 +230,22 @@ void OFileNotification::inotifyEventHandler()
     if ( r <= 0 )
         return;
 
     buffer_i = 0;
     while ( buffer_i < r )
     {
-            /* Parse events and queue them ! */
-            pevent = (struct inotify_event *)&buffer[buffer_i];
-            event_size = sizeof(struct inotify_event) + pevent->len;
-            qDebug( "pevent->len = %d\n", pevent->len);
-
-            OFileNotification* fn = notification_list[ pevent->wd ];
-            if ( fn )
-                fn->activate();
-            else
-                assert( false );
-
-            //event = malloc(event_size);
-            //memmove(event, pevent, event_size);
-            //queue_enqueue(event, q);
-            buffer_i += event_size;
-            count++;
+        pevent = (struct inotify_event *)&buffer[buffer_i];
+        event_size = sizeof(struct inotify_event) + pevent->len;
+        OFileNotificationEvent* e = new OFileNotificationEvent( notification_list[ pevent->wd ], pevent->wd, pevent->mask,
+                                                                pevent->cookie, pevent->len ? pevent->name : 0 );
+        e->activate();
+        buffer_i += event_size;
+        count++;
     }
 
-    qDebug( "received %d events...", count );
-    return;
+    qDebug( "OFileNotification::inotifyEventHandler(): processed %d events", count );
 }
 
 
 bool OFileNotification::registerEventHandler()
 {
     OFileNotification::_fd = ::open( INOTIFY_DEVICE, O_RDONLY );
@@ -259,20 +294,57 @@ int ODirNotification::watch( const QString& path, bool sshot, OFileNotificationT
     if ( recurse == 0 )
     {
         OFileNotification* fn = new OFileNotification( this, "ODirNotification delegate" );
         int result = fn->startWatching( path, sshot, type );
         if ( result != -1 )
         {
-            connect( fn, SIGNAL( triggered( const QString& ) ), this, SIGNAL( triggered( const QString& ) ) );
-            return result;
+            connect( fn, SIGNAL( triggered( const QString&, unsigned int, const QString& ) ), this, SIGNAL( triggered( const QString&, unsigned int, const QString& ) ) );
+            connect( fn, SIGNAL( accessed( const QString& ) ), this, SIGNAL( accessed( const QString& ) ) );
+            connect( fn, SIGNAL( modified( const QString& ) ), this, SIGNAL( modified( const QString& ) ) );
+            connect( fn, SIGNAL( attributed( const QString& ) ), this, SIGNAL( attributed( const QString& ) ) );
+            connect( fn, SIGNAL( closed( const QString&, bool ) ), this, SIGNAL( closed( const QString&, bool ) ) );
+            connect( fn, SIGNAL( opened( const QString& ) ), this, SIGNAL( opened( const QString& ) ) );
+            connect( fn, SIGNAL( movedTo( const QString&, const QString& ) ), this, SIGNAL( movedTo( const QString&, const QString& ) ) );
+            connect( fn, SIGNAL( movedFrom( const QString&, const QString& ) ), this, SIGNAL( movedFrom( const QString&, const QString& ) ) );
+            connect( fn, SIGNAL( deletedSubdir( const QString&, const QString& ) ), this, SIGNAL( deletedSubdir( const QString&, const QString& ) ) );
+            connect( fn, SIGNAL( deletedFile( const QString&, const QString& ) ), this, SIGNAL( deletedFile( const QString&, const QString& ) ) );;
+            connect( fn, SIGNAL( createdSubdir( const QString&, const QString& ) ), this, SIGNAL( createdSubdir( const QString&, const QString& ) ) );
+            connect( fn, SIGNAL( createdFile( const QString&, const QString& ) ), this, SIGNAL( createdFile( const QString&, const QString& ) ) );
+            connect( fn, SIGNAL( deleted( const QString& ) ), this, SIGNAL( deleted( const QString& ) ) );
+            connect( fn, SIGNAL( unmounted( const QString& ) ), this, SIGNAL( unmounted( const QString& ) ) );
         }
+        return result;
     }
     else
     {
-        qDebug( "ODirNotification::watch(), recursion not yet implemented... :)" );
-        return -1;
+
+        return 1;
     }
 }
 
+
+// void ODirNotification::subdirCreated( const QString& name )
+
+
+/*
+  Love-Trowbridge recursive directory scanning algorithm:
+
+        Step 1.  Start at initial directory foo.  Add watch.
+
+        Step 2.  Setup handlers for watch created in Step 1.
+                 Specifically, ensure that a directory created
+                 in foo will result in a handled CREATE_SUBDIR
+                 event.
+
+        Step 3.  Read the contents of foo.
+
+        Step 4.  For each subdirectory of foo read in step 3, repeat
+                 step 1.
+
+        Step 5.  For any CREATE_SUBDIR event on bar, if a watch is
+                 not yet created on bar, repeat step 1 on bar.
+*/
+
+
 } // namespace Ui
 
 } // namespace Opie
diff --git a/libopie2/opiecore/ofilenotify.h b/libopie2/opiecore/ofilenotify.h
index 3eb917e..5bbf421 100644
--- a/libopie2/opiecore/ofilenotify.h
+++ b/libopie2/opiecore/ofilenotify.h
@@ -39,12 +39,14 @@ _;:,     .>    :=|.         This program is free software; you can
 #include <qsignal.h>
 #include <qstring.h>
 
 namespace Opie {
 namespace Core {
 
+class OFileNotificationEvent;
+
 /*======================================================================================
  * OFileNotificationType
  *======================================================================================*/
 
 /**
  * @brief An enumerate for the different types of file notifications
@@ -165,19 +167,29 @@ class OFileNotification : public QObject
     /**
       * @internal
       */
     int startWatching( const QString& path, bool sshot = false, OFileNotificationType type = Modify );
 
   signals:
-    /**
-     * This signal is emitted if an event happens of the specified type happens to the file being watched.
-     **/
-    void triggered( const QString& name );
+    void triggered( const QString&, unsigned int, const QString& );
+    void accessed( const QString& );
+    void modified( const QString& );
+    void attributed( const QString& );
+    void closed( const QString&, bool );
+    void opened( const QString& );
+    void movedTo( const QString&, const QString& );
+    void movedFrom( const QString&, const QString& );
+    void deletedSubdir( const QString&, const QString& );
+    void deletedFile( const QString&, const QString& );
+    void createdSubdir( const QString&, const QString& );
+    void createdFile( const QString&, const QString& );
+    void deleted( const QString& );
+    void unmounted( const QString& );
 
   protected:
-    bool activate();
+    bool activate( const OFileNotificationEvent* e );
 
   private slots:
     void inotifyEventHandler();
 
   private:
     bool registerEventHandler();
@@ -188,12 +200,14 @@ class OFileNotification : public QObject
     QSignal _signal;
     bool _active;
     bool _multi;
     static QSocketNotifier* _sn;
     int _wd; // inotify watch descriptor
     static int _fd; // inotify device descriptor
+
+    friend class OFileNotificationEvent;
 };
 
 /*======================================================================================
  * ODirNotification
  *======================================================================================*/
 
@@ -224,13 +238,50 @@ class ODirNotification : public QObject
     int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify, int recurse = 0 );
 
   signals:
     /**
      * This signal is emitted if an event happens of the specified type happens to the directory being watched.
      **/
-    void triggered( const QString& name );
+    void triggered( const QString&, unsigned int, const QString& );
+    void accessed( const QString& );
+    void modified( const QString& );
+    void attributed( const QString& );
+    void closed( const QString&, bool );
+    void opened( const QString& );
+    void movedTo( const QString&, const QString& );
+    void movedFrom( const QString&, const QString& );
+    void deletedSubdir( const QString&, const QString& );
+    void deletedFile( const QString&, const QString& );
+    void createdSubdir( const QString&, const QString& );
+    void createdFile( const QString&, const QString& );
+    void deleted( const QString& );
+    void unmounted( const QString& );
+};
+
+/*======================================================================================
+ * OFileNotificationEvent
+ *======================================================================================*/
+
+class OFileNotificationEvent
+{
+  public:
+    OFileNotificationEvent( OFileNotification* parent, int wd, unsigned int mask, unsigned int cookie, const QString& name );
+    ~OFileNotificationEvent();
+    OFileNotification* parent() const { return _parent; };
+    int descriptor() const            { return _wd; };
+    unsigned int mask() const         { return _mask; };
+    unsigned int cookie() const       { return _cookie; };
+    QString name() const              { return _name; };
+    void activate()                   { _parent->activate( this ); };
+
+  private:
+    OFileNotification* _parent;
+    int _wd;
+    unsigned int _mask;
+    unsigned int _cookie;
+    QString _name;
 };
 
 
 }
 }