Merge lp:~dobey/ubuntuone-client/update-from-trunk into lp:ubuntuone-client/stable-3-0

[dobey]

[Natalia Bidart]

    Do not log calls to current_{uploads,downloads}.
    Use latest SSO interface.

[Diego Sarmentero]

    Provide a get_home_dir() method to get a proper home dir in unicode environments (LP: #898640).
    Handle link creation with unicode paths (LP: #891173).

[Alejandro J. Cura]

    Provide a --debug-manhole option to use twisted's manhole for debugging the syncdaemon.

[Natalia Bidart (nataliabidart)]

Looks good!

review: Approve

[Manuel de la Peña (mandel)]

Seems ok.

review: Approve

[lp:~dobey/ubuntuone-client/update-from-trunk]

1167. By Diego Sarmentero on 2012-01-18

[Natalia Bidart]

    Do not log calls to current_{uploads,downloads}.
    Use latest SSO interface.

[Diego Sarmentero]

    Provide a get_home_dir() method to get a proper home dir in unicode environments (LP: #898640).
    Handle link creation with unicode paths (LP: #891173).

[Alejandro J. Cura]

    Provide a --debug-manhole option to use twisted's manhole for debugging the syncdaemon.

=== modified file 'bin/ubuntuone-syncdaemon'
--- bin/ubuntuone-syncdaemon	2011-10-21 13:40:09 +0000
+++ bin/ubuntuone-syncdaemon	2012-01-18 16:15:47 +0000
@@ -85,6 +85,12 @@
     d = async_main(parser, options, argv)
     d.addErrback(check_death)
 
+    # check if we should start a twisted manhole
+    if options.debug_manhole:
+        startManhole()
+    else:
+        logger.root_logger.info('not starting twisted.manhole')
+
     if options.debug_lsprof_file:
         try:
             from bzrlib.lsprof import profile
@@ -97,6 +103,26 @@
         reactor.run()
 
 
+def startManhole():
+    try:
+        from twisted.conch import manhole, manhole_ssh
+        from twisted.cred.portal import Portal
+        from twisted.cred.checkers import InMemoryUsernamePasswordDatabaseDontUse
+    except ImportError:
+        logger.root_logger.warning('twisted.manhole not available')
+    else:
+        logger.root_logger.info('starting twisted.manhole')
+        realm = manhole_ssh.TerminalRealm()
+        getManhole = lambda _: manhole.Manhole(globals())
+        realm.chainedProtocolFactory.protocolFactory = getManhole
+        portal = Portal(realm)
+        checker = InMemoryUsernamePasswordDatabaseDontUse(debug="debug")
+        portal.registerChecker(checker)
+        manholeFactory = manhole_ssh.ConchFactory(portal)
+        reactor.listenTCP(2222, manholeFactory)
+        logger.root_logger.info('twisted.manhole started')
+
+
 @defer.inlineCallbacks
 def async_main(parser, options, argv):
     """The client entry point that can yield."""

=== modified file 'data/syncdaemon.conf'
--- data/syncdaemon.conf	2011-04-26 18:53:19 +0000
+++ data/syncdaemon.conf	2012-01-18 16:15:47 +0000
@@ -132,6 +132,11 @@
     with ".callgrind", the output will be formatted for use with KCacheGrind. 
     Otherwise, the output will be a pickle. *WARNING*: bzr must be installed.
 
+manhole.default = False
+manhole.parser = bool
+manhole.action = store_true
+manhole.help = Start a twisted manhole on port 2222
+
 heapy_monitor.default = False
 heapy_monitor.parser = bool
 heapy_monitor.action = store_true

=== modified file 'tests/platform/test_external_interface.py'
--- tests/platform/test_external_interface.py	2011-10-26 20:20:37 +0000
+++ tests/platform/test_external_interface.py	2012-01-18 16:15:47 +0000
@@ -165,6 +165,14 @@
         self.assert_remote_method('disconnect')
 
     @defer.inlineCallbacks
+    def test_get_homedir(self):
+        """Test get_homedir."""
+        result = self.root_dir
+        yield self.assert_method_called(self.service.sync,
+                                        'get_homedir', result)
+        self.assert_remote_method('get_homedir', out_signature='s')
+
+    @defer.inlineCallbacks
     def test_get_rootdir(self):
         """Test get_rootdir."""
         result = self.root_dir

=== modified file 'tests/platform/test_os_helper.py'
--- tests/platform/test_os_helper.py	2011-11-17 19:24:31 +0000
+++ tests/platform/test_os_helper.py	2012-01-18 16:15:47 +0000
@@ -311,6 +311,12 @@
         """The dir is not there."""
         self.assertFalse(path_exists(os.path.join(self.basedir, 'subdir')))
 
+    def test_path_exist_for_link_without_lnk_extension(self):
+        """Test if the path of a link exist without the lnk extension."""
+        destination = os.path.join(self.basedir, 'destination')
+        make_link(self.testfile, destination)
+        self.assertTrue(path_exists(destination))
+
     def test_make_link(self):
         """The link is properly made."""
         destination = os.path.join(self.basedir, 'destination')
@@ -320,6 +326,27 @@
         self.assertEqual(os.path.normcase(self.testfile),
                          os.path.normcase(read_link(destination)))
 
+    def _assert_read_link(self, target):
+        """Assert if the target path of the link is correct."""
+        destination = os.path.join(self.basedir, target)
+        make_link(self.testfile, destination)
+
+        target = read_link(destination)
+        self.assertEqual(self.testfile, target)
+
+    def test_links_target_without_lnk_extension(self):
+        """Create a link to self.testfile and then retrieve the link target."""
+        # In windows the .lnk extension should be added automatically
+        # if the extension is not added by make_link, read_link will fail
+        # because Windows is not going to recognize the file as a link
+        target = 'target'
+        self._assert_read_link(target)
+
+    def test_links_target_with_lnk_extension(self):
+        """Create a link to self.testfile and then retrieve the link target."""
+        target = 'target.lnk'
+        self._assert_read_link(target)
+
     def test_movetotrash_file_ok(self):
         """Move a file to trash ok.
 

=== modified file 'tests/platform/test_tools.py'
--- tests/platform/test_tools.py	2011-11-17 18:38:41 +0000
+++ tests/platform/test_tools.py	2012-01-18 16:15:47 +0000
@@ -958,6 +958,12 @@
                          repr(dirty_mdids[mdid2]['path'].encode('utf-8')))
 
     @defer.inlineCallbacks
+    def test_get_home_dir(self):
+        """Test the get_home_dir method."""
+        result = yield self.tool.get_home_dir()
+        self.assertEqual(self.main.get_homedir().decode('utf-8'), result)
+
+    @defer.inlineCallbacks
     def test_get_root_dir(self):
         """Test the get_root_dir method."""
         result = yield self.tool.get_root_dir()

=== modified file 'tests/platform/test_u1sdtool.py'
--- tests/platform/test_u1sdtool.py	2011-11-02 16:51:32 +0000
+++ tests/platform/test_u1sdtool.py	2012-01-18 16:15:47 +0000
@@ -28,6 +28,7 @@
     FakeDownload,
     FakeUpload,
 )
+from ubuntuone.syncdaemon.vm_helper import get_udf_path
 from ubuntuone.syncdaemon.volume_manager import (
     ACCESS_LEVEL_RO,
     Share,
@@ -58,6 +59,7 @@
         out = StringIO()
         d = self.tool.get_shares()
         d.addCallback(lambda result: show_shares(result, out))
+
         def check(result):
             """check the output"""
             self.assertEqual('No shares\n', out.getvalue())
@@ -86,6 +88,7 @@
         out = StringIO()
         d = self.tool.list_shared()
         d.addCallback(lambda result: show_shared(result, out))
+
         def check(result):
             """check the output"""
             self.assertEqual('No shared\n', out.getvalue())
@@ -98,6 +101,7 @@
         self.fs.create(path, "")
         self.fs.set_node_id(path, "node_id")
         # helper function, pylint: disable-msg=C0111
+
         def fake_create_share(node_id, user, name, access_level, marker, path):
             self.main.vm.handle_AQ_CREATE_SHARE_OK(share_id='share_id',
                                               marker=marker)
@@ -110,6 +114,7 @@
                 "path=%s\n" % path.decode('utf-8')
         d = self.tool.list_shared()
         d.addCallback(lambda result: show_shared(result, out))
+
         def check(result):
             """check the output"""
             self.assertEqual(out.getvalue(), expected)
@@ -166,6 +171,7 @@
   stat: %(stat)s
 """
         # the callback, pylint: disable-msg=C0111
+
         def callback(result):
             if encoding is not None:
                 result.update(dict(path_info=path))
@@ -176,6 +182,7 @@
             value = expected % result
             self.assertEqual(out.getvalue(), value)
         # helper callback, pylint: disable-msg=C0111
+
         def show(result):
             show_path_info(result, path, out)
             return result
@@ -191,6 +198,7 @@
         d.addCallback(lambda _: self.tool.get_current_downloads())
         d.addCallback(lambda result: show_downloads(result, out))
         expected = u'Current uploads: 0\nCurrent downloads: 0\n'
+
         def check(result):
             """check the output"""
             self.assertEqual(out.getvalue(), expected)
@@ -241,6 +249,7 @@
         ]
         d = self.tool.get_status()
         d.addCallback(lambda result: show_state(result, out))
+
         def check(result):
             """check the output"""
             info = [x.strip() for x in out.getvalue().split("\n") if x.strip()]
@@ -274,7 +283,7 @@
         self.action_q.queue.waiting.extend([cmd1, cmd2])
 
         out = StringIO()
-        expected =  (
+        expected = (
             "  FakeCommand(running=True, share_id='', "
                                     "node_id='node1', path='foo', other='')\n"
             "  FakeCommand(running=False, share_id='', "
@@ -294,7 +303,7 @@
         self.action_q.queue.waiting.extend([cmd1, cmd2])
 
         out = StringIO()
-        expected =  (
+        expected = (
             "Warning: this option is deprecated! Use '--waiting' instead\n"
             "  FakeCommand(running=True, share_id='', node_id='node1', "
                            "path='p', other='')\n"
@@ -344,6 +353,7 @@
         out = StringIO()
         d = self.tool.get_folders()
         d.addCallback(lambda result: show_folders(result, out))
+
         def check(result):
             """check the output"""
             self.assertEqual('No folders\n', out.getvalue())
@@ -354,14 +364,14 @@
     def test_show_folders_subscribed(self):
         """Test the output of --list-folders."""
         out = StringIO()
-        path = u'ñoño'.encode('utf-8')
-        suggested_path = os.path.join("~", u'ñoño')
+        suggested_path = u"~/ñoño"
+        path = get_udf_path(suggested_path)
 
         udf = UDF("folder_id", "node_id", suggested_path, path,
                   subscribed=True)
         yield self.main.vm.add_udf(udf)
         expected = u"Folder list:\n  id=folder_id subscribed=True " + \
-                   u"path=\xf1o\xf1o\n"
+                   u"path=%s\n" % path.decode('utf-8')
         result = yield self.tool.get_folders()
         show_folders(result, out)
         self.assertEqual(out.getvalue(), expected)

=== modified file 'tests/syncdaemon/test_interaction_interfaces.py'
--- tests/syncdaemon/test_interaction_interfaces.py	2011-12-12 19:32:25 +0000
+++ tests/syncdaemon/test_interaction_interfaces.py	2012-01-18 16:15:47 +0000
@@ -2158,6 +2158,11 @@
 
         self.assertEqual(self.events, [('SYS_USER_DISCONNECT', {})])
 
+    def test_get_homedir(self):
+        """Test the get_homedir method."""
+        result = self.sd_obj.get_homedir()
+        self.assertEqual(self.main.get_homedir().decode('utf-8'), result)
+
     def test_get_rootdir(self):
         """Test the get_rootdir method."""
         result = self.sd_obj.get_rootdir()

=== modified file 'tests/syncdaemon/test_main.py'
--- tests/syncdaemon/test_main.py	2011-11-09 20:03:15 +0000
+++ tests/syncdaemon/test_main.py	2012-01-18 16:15:47 +0000
@@ -262,6 +262,12 @@
         main = self.build_main()
         self.assertNotIn(main.status_listener, self._get_listeners(main))
 
+    def test_get_homedir(self):
+        """The get_homedir returns the root dir."""
+        expected = expand_user('~')
+        main = self.build_main()
+        self.assertEqual(main.get_homedir(), expected)
+
     def test_get_rootdir(self):
         """The get_rootdir returns the root dir."""
         expected = expand_user(os.path.join('~', 'Ubuntu Test One'))

=== modified file 'tests/syncdaemon/test_vm_helper.py'
--- tests/syncdaemon/test_vm_helper.py	2011-11-09 20:03:15 +0000
+++ tests/syncdaemon/test_vm_helper.py	2012-01-18 16:15:47 +0000
@@ -93,6 +93,14 @@
         os_helper.make_dir(dest_path)
         self.assertFalse(create_shares_link(source_path, dest_path))
 
+    def test_create_shares_link_existing_destiny_with_lnk_extension(self):
+        """Add the lnk extension to the end of the file like windows needs."""
+        base = self.mktemp("test_create_shares_link_exists")
+        source_path = os.path.join(base, "source")
+        dest_path = os.path.join(base, "dest.lnk")
+        os_helper.make_dir(dest_path)
+        self.assertFalse(create_shares_link(source_path, dest_path))
+
     def test_create_shares_link_makes_the_link(self):
         """create_shares_link makes the link as expected."""
         base = self.mktemp("test_create_shares_link_makes_the_link")
@@ -111,6 +119,15 @@
         self.assertTrue(create_shares_link(source_path, dest_path))
         self.assertFalse(create_shares_link(source_path, dest_path))
 
+    def test_create_shares_link_existing_source_with_lnk_extension(self):
+        """Add the lnk extension to the end of the file like windows needs."""
+        base = self.mktemp("test_create_shares_link_makes_the_link")
+        source_path = os.path.join(base, "source")
+        dest_path = os.path.join(base, "dest.lnk")
+        os_helper.make_dir(source_path)
+        self.assertTrue(create_shares_link(source_path, dest_path))
+        self.assertFalse(create_shares_link(source_path, dest_path))
+
 
 class GetShareDirNameTests(BaseVolumeManagerTests):
 

=== modified file 'ubuntuone/platform/credentials/windows.py'
--- ubuntuone/platform/credentials/windows.py	2011-09-13 19:31:23 +0000
+++ ubuntuone/platform/credentials/windows.py	2012-01-18 16:15:47 +0000
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
 #
-# Authors: Manuel de la Pena <[e-mail]>
-#          Alejandro J. Cura <[e-mail]>
-#
 # Copyright 2011 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
@@ -19,7 +16,7 @@
 """Ubuntu One credentials management IPC service."""
 
 
-from ubuntu_sso.main.windows import UbuntuSSOClient
+from ubuntu_sso.main import get_sso_client
 from twisted.internet import defer
 
 from ubuntu_sso.credentials import (
@@ -168,8 +165,6 @@
 @defer.inlineCallbacks
 def get_creds_proxy():
     """Get the CredentialsManagement proxy."""
-    client = UbuntuSSOClient()
-    yield client.connect()
-    yield client.cred_management.register_to_signals()
-    result = CredentialsManagement(client.cred_management)
+    client = yield get_sso_client()
+    result = CredentialsManagement(client.cred_manager)
     defer.returnValue(result)

=== modified file 'ubuntuone/platform/linux/dbus_interface.py'
--- ubuntuone/platform/linux/dbus_interface.py	2011-10-21 21:01:56 +0000
+++ ubuntuone/platform/linux/dbus_interface.py	2012-01-18 16:15:47 +0000
@@ -287,6 +287,12 @@
 
     @dbus.service.method(DBUS_IFACE_SYNC_NAME,
                          in_signature='', out_signature='s')
+    def get_homedir(self):
+        """Return the home dir."""
+        return self.service.sync.get_homedir()
+
+    @dbus.service.method(DBUS_IFACE_SYNC_NAME,
+                         in_signature='', out_signature='s')
     def get_rootdir(self):
         """Return the root dir/mount point."""
         return self.service.sync.get_rootdir()

=== modified file 'ubuntuone/platform/tools/__init__.py'
--- ubuntuone/platform/tools/__init__.py	2011-11-12 17:09:09 +0000
+++ ubuntuone/platform/tools/__init__.py	2012-01-18 16:15:47 +0000
@@ -651,6 +651,11 @@
         return self.proxy.call_method('file_system', 'get_dirty_nodes')
 
     @log_call(logger.debug)
+    def get_home_dir(self):
+        """Return the home directory."""
+        return self.proxy.call_method('sync_daemon', 'get_homedir')
+
+    @log_call(logger.debug)
     def get_root_dir(self):
         """Return the root directory."""
         return self.proxy.call_method('sync_daemon', 'get_rootdir')

=== modified file 'ubuntuone/platform/windows/ipc.py'
--- ubuntuone/platform/windows/ipc.py	2011-10-25 02:24:29 +0000
+++ ubuntuone/platform/windows/ipc.py	2012-01-18 16:15:47 +0000
@@ -372,6 +372,7 @@
     remote_calls = [
         'connect',
         'disconnect',
+        'get_homedir',
         'get_rootdir',
         'get_sharesdir',
         'get_sharesdir_link',
@@ -393,6 +394,10 @@
         """Disconnect from the server."""
         self.service.sync.disconnect()
 
+    def get_homedir(self):
+        """Return the home dir/mount point."""
+        return self.service.sync.get_homedir()
+
     def get_rootdir(self):
         """Return the root dir/mount point."""
         return self.service.sync.get_rootdir()
@@ -647,7 +652,6 @@
 
     signal_mapping = {}
 
-
     def get_throttling_limits(self):
         """Get the read/write limit from AQ and return a dict.
 

=== modified file 'ubuntuone/platform/windows/ipc_client.py'
--- ubuntuone/platform/windows/ipc_client.py	2011-11-02 16:37:55 +0000
+++ ubuntuone/platform/windows/ipc_client.py	2012-01-18 16:15:47 +0000
@@ -264,6 +264,10 @@
         """Disconnect from the server."""
 
     @remote
+    def get_homedir(self):
+        """Return the home dir/mount point."""
+
+    @remote
     def get_rootdir(self):
         """Return the root dir/mount point."""
 

=== modified file 'ubuntuone/platform/windows/os_helper.py'
--- ubuntuone/platform/windows/os_helper.py	2011-12-29 12:16:21 +0000
+++ ubuntuone/platform/windows/os_helper.py	2012-01-18 16:15:47 +0000
@@ -60,6 +60,10 @@
     WinWorldSid,
 )
 
+from comtypes import shelllink
+from comtypes.client import CreateObject
+from comtypes.persist import IPersistFile
+
 # ugly trick to stop pylint for complaining about
 # WindowsError on Linux
 if sys.platform != 'win32':
@@ -564,7 +568,7 @@
 @windowspath()
 def path_exists(path):
     """Return if the path exists."""
-    return os.path.exists(path)
+    return os.path.exists(path) or native_is_link(path)
 
 
 @windowspath()
@@ -638,16 +642,12 @@
     destination = destination.replace(LONG_PATH_PREFIX, u'')
     target = target.replace(LONG_PATH_PREFIX, u'')
 
-    shell_script = Dispatch('WScript.Shell')
     try:
-        shortcut = shell_script.CreateShortCut(destination)
-        shortcut.Targetpath = target
-        shortcut.save()
-    except AttributeError:
-        # This try-except is required at least for the current implementation
-        # to allow the application to run even when the paths has unicode chars
-        logger.exception('Link couldn\'t be created for '
-                'destination %r:', destination)
+        shortcut = CreateObject(shelllink.ShellLink)
+        shortcut.SetPath(target)
+        shortcut.SetWorkingDirectory(target)
+        pf = shortcut.QueryInterface(IPersistFile)
+        pf.Save(destination, True)
     except:
         logger.exception('make_link could not be completed for target %r, '
                          'destination %r:', target, destination)
@@ -658,17 +658,30 @@
 @windowspath()
 def read_link(path):
     """Read the destination of a link."""
+    # THIS SHOULD BE FIXED IN ORDER TO SUPPORT THE PROPER API
+    # The workaround to support unicode paths was to use: WorkingDirectory,
+    # because TargetPath or anything related was returning malformed paths.
+    # The bug associated to this issue is: #907336
+    # https://bugs.launchpad.net/ubuntuone-client/+bug/907336
     if not path.endswith(u'.lnk'):
         path += u'.lnk'
-    shell_script = Dispatch('WScript.Shell')
-    shortcut = shell_script.CreateShortCut(path)
-    result = get_syncdaemon_valid_path(LONG_PATH_PREFIX + shortcut.Targetpath)
+    shortcut = CreateObject(shelllink.ShellLink)
+    pf = shortcut.QueryInterface(IPersistFile)
+    pf.Load(path, True)
+    target_path = shortcut.GetWorkingDirectory().encode('utf-8')
+    target_path = target_path.decode('utf-8')
+    result = get_syncdaemon_valid_path(LONG_PATH_PREFIX + target_path)
     return result
 
 
 @windowspath()
 def is_link(path):
     """Returns if a path is a link or not."""
+    return native_is_link(path)
+
+
+def native_is_link(path):
+    """Check if a file is a link, using native paths."""
     if not path.endswith('.lnk'):
         path += '.lnk'
     return os.path.exists(path)

=== modified file 'ubuntuone/syncdaemon/interaction_interfaces.py'
--- ubuntuone/syncdaemon/interaction_interfaces.py	2011-12-06 20:23:14 +0000
+++ ubuntuone/syncdaemon/interaction_interfaces.py	2012-01-18 16:15:47 +0000
@@ -211,7 +211,6 @@
         """
         return self._get_current_state()
 
-    @log_call(logger.debug)
     def current_uploads(self):
         """Return a list of files with a upload in progress."""
         current_uploads = []
@@ -228,7 +227,6 @@
                 current_uploads.append(entry)
         return current_uploads
 
-    @log_call(logger.debug)
     def current_downloads(self):
         """Return a list of files with a download in progress."""
         current_downloads = []
@@ -1243,6 +1241,11 @@
         self.main.event_q.push('SYS_USER_DISCONNECT')
 
     @log_call(logger.debug)
+    def get_homedir(self):
+        """Return the home dir point."""
+        return self.main.get_homedir().decode('utf-8')
+
+    @log_call(logger.debug)
     def get_rootdir(self):
         """Return the root dir/mount point."""
         return self.main.get_rootdir().decode('utf-8')

=== modified file 'ubuntuone/syncdaemon/main.py'
--- ubuntuone/syncdaemon/main.py	2011-10-21 13:40:09 +0000
+++ ubuntuone/syncdaemon/main.py	2012-01-18 16:15:47 +0000
@@ -21,7 +21,7 @@
 
 from twisted.internet import defer, reactor, task
 
-from ubuntu_sso.xdg_base_directory import native_path
+from ubuntu_sso.xdg_base_directory import native_path, xdg_home
 from ubuntuone.syncdaemon import (
     action_queue,
     config,
@@ -249,6 +249,10 @@
         """Do the server rescan."""
         return self.vm.server_rescan()
 
+    def get_homedir(self):
+        """Return the home dir point."""
+        return xdg_home
+
     def get_rootdir(self):
         """Return the base dir/mount point."""
         return self.root_dir