Merge lp:~mandel/ubuntuone-client/add_windows_network_manager into lp:ubuntuone-client

[Manuel de la Peña]

Implements the network manager that will execute callbacks when the status of the network changes.

Implements the network manager that will execute callbacks when the status of the network changes. To test the code on windows execute 'u1trial tests/platform/windows/test_network_manager.py'. On linux all tests should run correctly.

[Roberto Alsina (ralsina)]

+1 pass on windows

review: Approve

[Facundo Batista (facundo)]

Like it!

review: Approve

[lp:~mandel/ubuntuone-client/add_windows_network_manager]

888. By Manuel de la Peña on 2011-02-28

Removed unused import. Added clarifications to the code.

=== added file 'tests/platform/windows/test_network_manager.py'
--- tests/platform/windows/test_network_manager.py	1970-01-01 00:00:00 +0000
+++ tests/platform/windows/test_network_manager.py	2011-02-28 14:34:34 +0000
@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Manuel de la Pena<[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Tests for the network manager."""
+from mocker import MockerTestCase
+from ubuntuone.platform.windows.network_manager import NetworkManager
+
+class TestNetworkManager(MockerTestCase):
+    """Test he Network Manager."""
+
+    def setUp(self):
+        super(TestNetworkManager, self).setUp()
+        self.connection_info = self.mocker.mock()
+        self.connection_no_info = self.mocker.mock()
+        self.disconnected = self.mocker.mock()
+        self.manager = NetworkManager(self.connection_no_info,
+                                      self.connection_info, self.disconnected)
+
+    def test_connection_made(self):
+        """Ensure db is called."""
+        self.connection_info()
+        self.mocker.replay()
+        self.manager.ConnectionMade()
+
+    def test_connection_made_no_cb(self):
+        """Ensure db is called."""
+        self.manager.connected_cb_info = None
+        self.mocker.replay()
+        self.manager.ConnectionMade()
+
+    def test_connection_made_no_info(self):
+        """Ensure db is called."""
+        self.connection_no_info()
+        self.mocker.replay()
+        self.manager.ConnectionMadeNoQOCInfo()
+
+    def test_connection_made_no_info_no_cb(self):
+        """Ensure db is called."""
+        self.manager.connected_cb = None
+        self.mocker.replay()
+        self.manager.ConnectionMadeNoQOCInfo()
+
+    def test_disconnection(self):
+        """Ensure db is called."""
+        self.disconnected()
+        self.mocker.replay()
+        self.manager.ConnectionLost()
+
+    def test_disconnection_no_cb(self):
+        """Ensure db is called."""
+        self.manager.disconnected_cb = None
+        self.mocker.replay()
+        self.manager.ConnectionLost()

=== added file 'ubuntuone/platform/windows/network_manager.py'
--- ubuntuone/platform/windows/network_manager.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/windows/network_manager.py	2011-02-28 14:34:34 +0000
@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Manuel de la Pena<[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Implementation of a Network Mnager using ISesNework in Python."""
+import logging
+ 
+import pythoncom
+ 
+from win32com.server.policy import DesignatedWrapPolicy
+from win32com.client import Dispatch
+ 
+# set te logging to store the data in the ubuntuone folder
+logger = logging.getLogger('ubuntuone.platform.windows.NetworkManager')
+ 
+## from EventSys.h
+PROGID_EventSystem = "EventSystem.EventSystem"
+PROGID_EventSubscription = "EventSystem.EventSubscription"
+ 
+# SENS (System Event Notification Service) values for the events,
+# this events contain the uuid of the event, the name of the event to be used
+# as well as the method name of the method in the ISesNetwork interface that
+# will be executed for the event.
+# For more ingo look at:
+# http://msdn.microsoft.com/en-us/library/aa377384(v=vs.85).aspx
+ 
+SUBSCRIPTION_NETALIVE = ('{cd1dcbd6-a14d-4823-a0d2-8473afde360f}',
+                         'UbuntuOne Network Alive',
+                         'ConnectionMade')
+ 
+SUBSCRIPTION_NETALIVE_NOQOC = ('{a82f0e80-1305-400c-ba56-375ae04264a1}',
+                               'UbuntuOne Net Alive No Info',
+                               'ConnectionMadeNoQOCInfo')
+ 
+SUBSCRIPTION_NETLOST = ('{45233130-b6c3-44fb-a6af-487c47cee611}',
+                        'UbuntuOne Network Lost',
+                        'ConnectionLost')
+ 
+SUBSCRIPTION_REACH = ('{4c6b2afa-3235-4185-8558-57a7a922ac7b}',
+                       'UbuntuOne Network Reach',
+                       'ConnectionMade')
+ 
+SUBSCRIPTION_REACH_NOQOC = ('{db62fa23-4c3e-47a3-aef2-b843016177cf}',
+                            'UbuntuOne Network Reach No Info',
+                            'ConnectionMadeNoQOCInfo')
+ 
+SUBSCRIPTION_REACH_NOQOC2 = ('{d4d8097a-60c6-440d-a6da-918b619ae4b7}',
+                             'UbuntuOne Network Reach No Info 2',
+                             'ConnectionMadeNoQOCInfo')
+ 
+SUBSCRIPTIONS = [SUBSCRIPTION_NETALIVE,
+                 SUBSCRIPTION_NETALIVE_NOQOC,
+                 SUBSCRIPTION_NETLOST,
+                 SUBSCRIPTION_REACH,
+                 SUBSCRIPTION_REACH_NOQOC,
+                 SUBSCRIPTION_REACH_NOQOC2 ]
+ 
+SENSGUID_EVENTCLASS_NETWORK = '{d5978620-5b9f-11d1-8dd2-00aa004abd5e}'
+SENSGUID_PUBLISHER = "{5fee1bd6-5b9b-11d1-8dd2-00aa004abd5e}"
+ 
+# uuid of the implemented com interface
+IID_ISesNetwork = '{d597bab1-5b9f-11d1-8dd2-00aa004abd5e}'
+ 
+class NetworkManager(DesignatedWrapPolicy):
+    """Implement ISesNetwork to know about the network status."""
+ 
+    _com_interfaces_ = [IID_ISesNetwork]
+    _public_methods_ = ['ConnectionMade',
+                        'ConnectionMadeNoQOCInfo', 
+                        'ConnectionLost']
+    _reg_clsid_ = '{41B032DA-86B5-4907-A7F7-958E59333010}' 
+    _reg_progid_ = "UbuntuOne.NetworkManager"
+ 
+    def __init__(self, connected_cb=None, connected_cb_info=None,
+                 disconnected_cb=None):
+        self._wrap_(self)
+        self.connected_cb = connected_cb
+        self.connected_cb_info = connected_cb_info
+        self.disconnected_cb = disconnected_cb
+ 
+    def ConnectionMade(self, *args):
+        """Tell that the connection is up again."""
+        logger.info('Connection was made.')
+        if self.connected_cb_info:
+            self.connected_cb_info()
+ 
+    def ConnectionMadeNoQOCInfo(self, *args):
+        """Tell that the connection is up again."""
+        logger.info('Connection was made no info.')
+        if self.connected_cb:
+            self.connected_cb()
+ 
+    def ConnectionLost(self, *args):
+        """Tell the connection was lost."""
+        logger.info('Connection was lost.')
+        if self.disconnected_cb:
+            self.disconnected_cb() 
+ 
+    def register(self):
+        """Register to listen to network events."""
+        # call the CoInitialize to allow the registration to run in an other
+        # thread
+        pythoncom.CoInitialize()
+        # interface to be used by com
+        manager_interface = pythoncom.WrapObject(self)
+        event_system = Dispatch(PROGID_EventSystem)
+        # register to listent to each of the events to make sure that
+        # the code will work on all platforms.
+        for current_event in SUBSCRIPTIONS:
+            # create an event subscription and add it to the event
+            # service
+            event_subscription = Dispatch(PROGID_EventSubscription)
+            event_subscription.EventClassId = SENSGUID_EVENTCLASS_NETWORK
+            event_subscription.PublisherID = SENSGUID_PUBLISHER
+            event_subscription.SubscriptionID = current_event[0]
+            event_subscription.SubscriptionName = current_event[1]
+            event_subscription.MethodName = current_event[2]
+            event_subscription.SubscriberInterface = manager_interface
+            event_subscription.PerUser = True
+            # store the event
+            try:
+                event_system.Store(PROGID_EventSubscription, 
+                                   event_subscription)
+            except pythoncom.com_error as e:
+                logger.error(
+                    'Error registering %s to event %s', e, current_event[1])
+ 
+        pythoncom.PumpMessages()
+ 
+if __name__ == '__main__':
+    # Run an expample of the code so that the user can test the code in
+    # real life.
+    from threading import Thread
+    def connected():
+        print 'Connected'
+
+    def connected_info():
+        print 'Connected'
+        
+    def disconnected():
+        print 'Disconnected'
+ 
+    manager = NetworkManager(connected, connected_info, disconnected)
+    p = Thread(target=manager.register)
+    p.start()
+