Merge lp:~rye/ubuntuone-client/ignore-in-close-write-in-dirs into lp:ubuntuone-client

[Roman Yepishev]

Ignore IN_CLOSE_WRITE for directories

If you approve this then please also approve https://code.launchpad.net/~rye/ubuntuone-client/ignore-in-close-write-in-dirs-stable-3-0/+merge/106613 which is the same code but for stable-3-0 release (Precise)

This branch adds the same types of filters as are already in place to make sure that events IN_OPEN and IN_CLOSE_NOWRITE work only on files.

eCryptFS layer used in Ubuntu for Private directories can send IN_CLOSE_WRITE on directories breaking syncdaemon and preventing the users from running Ubuntu One with ~/.Private directory.

To test:
0. Before patching:
1. Create a private ecryptfs directory: ecryptfs-setup-private and follow all the prompts including relogin.
2. After relogin add underlying ~/.Private folder to Ubuntu One: u1sdtool --create-folder=~/.Private
3. Notice that files do upload
4. Open this directory and put another file in it.

At this point no files will be uploaded for any Ubuntu One directory due to the unexpected event from INotify subsystem. The log will show:
exceptions.KeyError: "Unhandled Event in INotify: <Event dir=True mask=0x40000008 maskname=IN_CLOSE_WRITE|IN_ISDIR name='' path=/home/rtg/.Private pathname=/home/rtg/.Private wd=8 >"

5. Apply the patch and restart syncdaemon.
6. Add another file to the directory. Notice that the amount of entries in https://one.ubuntu.com/files/ in ~/.Private UDF corresponds to the number of files locally (filenames are encrypted).

[dobey (dobey)]

review: Approve

[Manuel de la Peña (mandel)]

review: Approve

=== modified file 'tests/platform/filesystem_notifications/test_linux.py'
--- tests/platform/filesystem_notifications/test_linux.py	2012-04-30 15:19:03 +0000
+++ tests/platform/filesystem_notifications/test_linux.py	2012-05-23 13:09:19 +0000
@@ -34,6 +34,7 @@
 import os
 
 from twisted.internet import defer, reactor
+from twisted.trial.unittest import TestCase as PlainTestCase
 
 from ubuntuone.syncdaemon import (
     event_queue,
@@ -436,3 +437,43 @@
         self.monitor.rm_watch(path_ancestor)
         self.assertEqual(self.monitor._general_watchs, {})
         self.assertEqual(self.monitor._ancestors_watchs, {})
+
+
+class FakeEvent(object):
+    """A fake event."""
+
+    mask = 0
+    name = ""
+
+
+class ECryptFsTestCase(PlainTestCase):
+    """Tests for the eCryptFS weirdness."""
+
+    def test_close_write_on_folders_is_ignored(self):
+        """When eCryptFS sends CLOSE_WRITE on folders, ignore it"""
+        result = []
+        monitor = None
+        processor = filesystem_notifications._GeneralINotifyProcessor(monitor)
+        self.patch(processor.general_processor, "push_event", result.append)
+
+        fake_event = FakeEvent()
+        fake_event.mask = filesystem_notifications.pyinotify.IN_ISDIR
+        fake_event.name = "/fake/directory/path"
+        processor.process_IN_CLOSE_WRITE(fake_event)
+
+        self.assertNotIn(fake_event, result)
+
+
+    def test_close_write_on_files_is_handled(self):
+        """When anything sends CLOSE_WRITE on files, handle it."""
+        result = []
+        monitor = None
+        processor = filesystem_notifications._GeneralINotifyProcessor(monitor)
+        self.patch(processor.general_processor, "push_event", result.append)
+
+        fake_event = FakeEvent()
+        fake_event.mask = filesystem_notifications.pyinotify.IN_CLOSE_WRITE
+        fake_event.name = "/fake/directory/path"
+        processor.process_IN_CLOSE_WRITE(fake_event)
+
+        self.assertIn(fake_event, result)

=== modified file 'ubuntuone/platform/filesystem_notifications/linux.py'
--- ubuntuone/platform/filesystem_notifications/linux.py	2012-05-14 21:24:24 +0000
+++ ubuntuone/platform/filesystem_notifications/linux.py	2012-05-23 13:09:19 +0000
@@ -212,6 +212,16 @@
         if not (event.mask & pyinotify.IN_ISDIR):
             self.general_processor.push_event(event)
 
+    @validate_filename
+    def process_IN_CLOSE_WRITE(self, event):
+        """Filter IN_CLOSE_WRITE to make it happen only in files.
+
+        eCryptFS sends IN_CLOSE_WRITE event for lower directories.
+
+        """
+        if not (event.mask & pyinotify.IN_ISDIR):
+            self.general_processor.push_event(event)
+
     def process_IN_MOVE_SELF(self, event):
         """Don't do anything here.