Commits December 2008

commits@gajim.org

5 participants
199 discussions

[commit-gajim] r10912 - trunk/src/common/xmpp
by steve-e＠gajim.org 26 Dec '08

26 Dec '08

Author: steve-e Date: 2008-12-26 14:24:37 +0100 (Fri, 26 Dec 2008) New Revision: 10912 Modified: trunk/src/common/xmpp/idlequeue.py Log: Coding standards and documentation improvements in idlequeue.py. Fix a potential bug of missing an alarm_callback. Separate public from internal API. Modified: trunk/src/common/xmpp/idlequeue.py =================================================================== --- trunk/src/common/xmpp/idlequeue.py 2008-12-24 15:00:38 UTC (rev 10911) +++ trunk/src/common/xmpp/idlequeue.py 2008-12-26 13:24:37 UTC (rev 10912) @@ -12,16 +12,32 @@ ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. +''' +Idlequeues are Gajim's network heartbeat. Transports can be plugged as +idle objects and be informed about possible IO. +''' + import select import logging import gobject log = logging.getLogger('gajim.c.x.idlequeue') +FLAG_WRITE = 20 # write only +FLAG_READ = 19 # read only +FLAG_READ_WRITE = 23 # read and write +FLAG_CLOSE = 16 # wait for close + +PENDING_READ = 3 # waiting read event +PENDING_WRITE = 4 # waiting write event +IS_CLOSED = 16 # channel closed + + class IdleObject: - ''' base class for all idle listeners, these are the methods, which are called from IdleQueue ''' + Idle listener interface. Listed methods are called by IdleQueue. + ''' def __init__(self): - self.fd = -1 + self.fd = -1 #: filedescriptor, must be unique for each IdleObject def pollend(self): ''' called on stream failure ''' @@ -39,7 +55,17 @@ ''' called when timeout happened ''' pass + class IdleQueue: + ''' + IdleQueue provide three distinct time based features. Uses select.poll() + + 1. Alarm timeout: Execute a callback after foo seconds + 2. Timeout event: Call read_timeout() of an plugged object if a timeout + has been set, but not removed in time. + 3. Check file descriptor of plugged objects for read, write and error + events + ''' def __init__(self): self.queue = {} @@ -49,18 +75,16 @@ # cb, which are executed after XX sec., alarms are removed automatically self.alarms = {} - self.init_idle() + self._init_idle() - def init_idle(self): + def _init_idle(self): + ''' Hook method for subclassed. Will be called by __init__. ''' self.selector = select.poll() - def remove_timeout(self, fd): - log.info('read timeout removed for fd %s' % fd) - if fd in self.read_timeouts: - del(self.read_timeouts[fd]) - def set_alarm(self, alarm_cb, seconds): - ''' set up a new alarm, to be called after alarm_cb sec. ''' + ''' + Sets up a new alarm. alarm_cb will be called after specified seconds. + ''' alarm_time = self.current_time() + seconds # almost impossible, but in case we have another alarm_cb at this time if alarm_time in self.alarms: @@ -70,30 +94,50 @@ return alarm_time def remove_alarm(self, alarm_cb, alarm_time): - ''' removes alarm callback alarm_cb scheduled on alarm_time''' - if not self.alarms.has_key(alarm_time): return False + ''' + Removes alarm callback alarm_cb scheduled on alarm_time. + Returns True if it was removed sucessfully, otherwise False + ''' + if not alarm_time in self.alarms: + return False i = -1 - for i in range(len(self.alarms[alarm_time])): + for i in range(len(self.alarms[alarm_time])): # let's not modify the list inside the loop - if self.alarms[alarm_time][i] is alarm_cb: break - if i != -1: + if self.alarms[alarm_time][i] is alarm_cb: + break + if i != -1: del self.alarms[alarm_time][i] - if self.alarms[alarm_time] == []: + if self.alarms[alarm_time] == []: del self.alarms[alarm_time] return True else: return False + def remove_timeout(self, fd): + ''' Removes the read timeout ''' + log.info('read timeout removed for fd %s' % fd) + if fd in self.read_timeouts: + del(self.read_timeouts[fd]) + def set_read_timeout(self, fd, seconds): - ''' set a new timeout, if it is not removed after 'seconds', - then obj.read_timeout() will be called ''' + ''' + Sets a new timeout. If it is not removed after specified seconds, + obj.read_timeout() will be called. + + A filedescriptor fd can have only one timeout. + ''' log.info('read timeout set for fd %s on %s seconds' % (fd, seconds)) timeout = self.current_time() + seconds self.read_timeouts[fd] = timeout - def check_time_events(self): + def _check_time_events(self): + ''' + Execute and remove alarm callbacks and execute read_timeout() for plugged + objects if specified time has ellapsed. + ''' log.info('check time evs') current_time = self.current_time() + for fd, timeout in self.read_timeouts.items(): if timeout > current_time: continue @@ -102,15 +146,25 @@ self.queue[fd].read_timeout() else: self.remove_timeout(fd) + times = self.alarms.keys() for alarm_time in times: if alarm_time > current_time: - break - if self.alarms.has_key(alarm_time): - for cb in self.alarms[alarm_time]: cb() - if self.alarms.has_key(alarm_time): del(self.alarms[alarm_time]) + continue + if alarm_time in self.alarms: + for callback in self.alarms[alarm_time]: + callback() + if alarm_time in self.alarms: + del(self.alarms[alarm_time]) - def plug_idle(self, obj, writable = True, readable = True): + def plug_idle(self, obj, writable=True, readable=True): + ''' + Plug an IdleObject into idlequeue. Filedescriptor fd must be set. + + :param obj: the IdleObject + :param writable: True if obj has data to sent + :param readable: True if obj expects data to be reiceived + ''' if obj.fd == -1: return if obj.fd in self.queue: @@ -118,48 +172,51 @@ self.queue[obj.fd] = obj if writable: if not readable: - flags = 20 # write only + flags = FLAG_WRITE else: - flags = 23 # both readable and writable + flags = FLAG_READ_WRITE else: if readable: - flags = 19 # read only + flags = FLAG_READ else: # when we paused a FT, we expect only a close event - flags = 16 - self.add_idle(obj.fd, flags) + flags = FLAG_CLOSE + self._add_idle(obj.fd, flags) - def add_idle(self, fd, flags): + def _add_idle(self, fd, flags): + ''' Hook method for subclasses, called by plug_idle ''' self.selector.register(fd, flags) def unplug_idle(self, fd): + ''' Removed plugged IdleObject, specified by filedescriptor fd. ''' if fd in self.queue: del(self.queue[fd]) - self.remove_idle(fd) + self._remove_idle(fd) def current_time(self): from time import time return time() - def remove_idle(self, fd): + def _remove_idle(self, fd): + ''' Hook method for subclassed, called by unplug_idle ''' self.selector.unregister(fd) - def process_events(self, fd, flags): + def _process_events(self, fd, flags): obj = self.queue.get(fd) if obj is None: self.unplug_idle(fd) return False - if flags & 3: # waiting read event + if flags & PENDING_READ: #print 'waiting read on %d, flags are %d' % (fd, flags) obj.pollin() return True - elif flags & 4: # waiting write event + elif flags & PENDING_WRITE: obj.pollout() return True - elif flags & 16: # closed channel + elif flags & IS_CLOSED: # io error, don't expect more events self.remove_timeout(obj.fd) self.unplug_idle(obj.fd) @@ -167,9 +224,16 @@ return False def process(self): + ''' + Process idlequeue. Check for any pending timeout or alarm events. + Call IdleObjects on possible and requested read, write and error events + on their file descriptors. + + Call this in regular intervals. + ''' if not self.queue: # check for timeouts/alert also when there are no active fds - self.check_time_events() + self._check_time_events() return True try: waiting_descriptors = self.selector.poll(0) @@ -178,25 +242,27 @@ if e[0] != 4: # interrupt raise for fd, flags in waiting_descriptors: - self.process_events(fd, flags) - self.check_time_events() + self._process_events(fd, flags) + self._check_time_events() return True + class SelectIdleQueue(IdleQueue): ''' Extends IdleQueue to use select.select() for polling + This class exisists for the sake of gtk2.8 on windows, which doesn't seem to support io_add_watch properly (yet) ''' - # TODO: remove this class and its reference gajim.py, when win-gtk2.8 is stable - def init_idle(self): - ''' this method is called at the end of class constructor. - Creates a dict, which maps file/pipe/sock descriptor to glib event id''' + def _init_idle(self): + ''' + Creates a dict, which maps file/pipe/sock descriptor to glib event id + ''' self.read_fds = {} self.write_fds = {} self.error_fds = {} - def add_idle(self, fd, flags): + def _add_idle(self, fd, flags): ''' this method is called when we plug a new idle object. Remove descriptor to read/write/error lists, according flags ''' @@ -206,7 +272,7 @@ self.write_fds[fd] = fd self.error_fds[fd] = fd - def remove_idle(self, fd): + def _remove_idle(self, fd): ''' this method is called when we unplug a new idle object. Remove descriptor from read/write/error lists ''' @@ -219,7 +285,7 @@ def process(self): if not self.write_fds and not self.read_fds: - self.check_time_events() + self._check_time_events() return True try: waiting_descriptors = select.select(self.read_fds.keys(), @@ -240,24 +306,26 @@ q = self.queue.get(fd) if q: q.pollend() - self.check_time_events() + self._check_time_events() return True class GlibIdleQueue(IdleQueue): ''' Extends IdleQueue to use glib io_add_wath, instead of select/poll - In another, `non gui' implementation of Gajim IdleQueue can be used safetly. + In another 'non gui' implementation of Gajim IdleQueue can be used safetly. ''' - def init_idle(self): - ''' this method is called at the end of class constructor. - Creates a dict, which maps file/pipe/sock descriptor to glib event id''' + + def _init_idle(self): + ''' + Creates a dict, which maps file/pipe/sock descriptor to glib event id + ''' self.events = {} # time() is already called in glib, we just get the last value # overrides IdleQueue.current_time() self.current_time = gobject.get_current_time - def add_idle(self, fd, flags): + def _add_idle(self, fd, flags): ''' this method is called when we plug a new idle object. Start listening for events from fd ''' @@ -268,13 +336,13 @@ def _process_events(self, fd, flags): try: - return self.process_events(fd, flags) + return IdleQueue._process_events(self, fd, flags) except Exception: - self.remove_idle(fd) - self.add_idle(fd, flags) + self._remove_idle(fd) + self._add_idle(fd, flags) raise - def remove_idle(self, fd): + def _remove_idle(self, fd): ''' this method is called when we unplug a new idle object. Stop listening for events from fd ''' @@ -284,7 +352,7 @@ del(self.events[fd]) def process(self): - self.check_time_events() + self._check_time_events() # vim: se ts=3:

1 0

[commit-gajim] r10911 - trunk/src/common
by asterix＠gajim.org 24 Dec '08

24 Dec '08

Author: asterix Date: 2008-12-24 16:00:38 +0100 (Wed, 24 Dec 2008) New Revision: 10911 Modified: trunk/src/common/gajim.py trunk/src/common/helpers.py Log: cache os information so it's requested to system only once Modified: trunk/src/common/gajim.py =================================================================== --- trunk/src/common/gajim.py 2008-12-24 14:53:00 UTC (rev 10910) +++ trunk/src/common/gajim.py 2008-12-24 15:00:38 UTC (rev 10911) @@ -105,6 +105,8 @@ else: LANG = LANG[:2] # en, fr, el etc.. +os_info = None # used to cache os information + gmail_domains = ['gmail.com', 'googlemail.com'] transport_type = {} # list the type of transport Modified: trunk/src/common/helpers.py =================================================================== --- trunk/src/common/helpers.py 2008-12-24 14:53:00 UTC (rev 10910) +++ trunk/src/common/helpers.py 2008-12-24 15:00:38 UTC (rev 10911) @@ -767,6 +767,8 @@ return ''.join(sample(char_sequence, 16)) def get_os_info(): + if gajim.os_info: + return gajim.os_info if os.name == 'nt': ver = os.sys.getwindowsversion() ver_format = ver[3], ver[0], ver[1] @@ -781,9 +783,11 @@ (2, 6, 0): 'Vista', } if ver_format in win_version: - return 'Windows' + ' ' + win_version[ver_format] + os_info = 'Windows' + ' ' + win_version[ver_format] else: - return 'Windows' + os_info = 'Windows' + gajim.os_info = os_info + return os_info elif os.name == 'posix': executable = 'lsb_release' params = ' --description --codename --release --short' @@ -796,6 +800,7 @@ output = temp_failure_retry(p.stdout.readline).strip() # some distros put n/a in places, so remove those output = output.replace('n/a', '').replace('N/A', '') + gajim.os_info = output return output # lsb_release executable not available, so parse files @@ -823,13 +828,19 @@ text = distro_name elif path_to_file.endswith('lfs-release'): # file just has version text = distro_name + ' ' + text - return text.replace('\n', '') + os_info = text.replace('\n', '') + gajim.os_info = os_info + return os_info # our last chance, ask uname and strip it uname_output = get_output_of_command('uname -sr') if uname_output is not None: - return uname_output[0] # only first line - return 'N/A' + os_info = uname_output[0] # only first line + gajim.os_info = os_info + return os_info + os_info = 'N/A' + gajim.os_info = os_info + return os_info def sanitize_filename(filename): '''makes sure the filename we will write does contain only acceptable and

1 0

[commit-gajim] r10910 - trunk/test
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 15:53:00 +0100 (Wed, 24 Dec 2008) New Revision: 10910 Modified: trunk/test/test_client_nb.py Log: Remove duplicated coded in test_client_nb.py Modified: trunk/test/test_client_nb.py =================================================================== --- trunk/test/test_client_nb.py 2008-12-24 14:50:50 UTC (rev 10909) +++ trunk/test/test_client_nb.py 2008-12-24 14:53:00 UTC (rev 10910) @@ -1,236 +1,37 @@ -import unittest -from xmpp_mocks import * - -import sys, os.path - -gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') - -sys.path.append(gajim_root + '/src/common/xmpp') - -import client_nb - ''' Testing script for NonBlockingClient class (src/common/xmpp/client_nb.py) It actually connects to a xmpp server so the connection values have to be changed before running. ''' - -xmpp_server_port = ('gajim.org',5222) -''' -2-tuple - (XMPP server hostname, c2s port) -Script will connect to the machine. -''' - -credentials = ['loginn', 'passwo', 'testresour'] -''' -[username, password, passphrase] -Script will autheticate itself with this credentials on above mentioned server. -''' - -class TestNonBlockingClient(unittest.TestCase): - ''' - Test Cases class for NonBlockingClient. - ''' - - def setUp(self): - ''' - IdleQueue thread is run and dummy connection is created. - ''' - - self.idlequeue_thread = IdleQueueThread() - self.connection = MockConnectionClass() - - self.idlequeue_thread.start() - - def tearDown(self): - ''' - IdleQueue thread is stopped. - ''' - self.idlequeue_thread.stop_thread() - self.idlequeue_thread.join() - - def open_stream(self, server_port): - ''' - Method opening the XMPP connection. It returns when <stream:features> - is received from server. - - :param server_port: tuple of (hostname, port) for where the client should - connect. - - ''' - self.client = client_nb.NonBlockingClient( - domain=server_port[0], - idlequeue=self.idlequeue_thread.iq, - ) - ''' - NonBlockingClient instance with parameters from global variables and with - callbacks from dummy connection. - ''' - - self.client.connect( - on_connect=lambda *args: self.connection.on_connect(True, *args), - on_connect_failure=lambda *args: self.connection.on_connect(False, *args), - ) - - print 'waiting for callback from client constructor' - self.connection.wait() - - # if on_connect was called, client has to be connected and vice versa - if self.connection.connect_succeeded: - self.assert_(self.client.get_connect_type()) - else: - self.assert_(not self.client.get_connect_type()) - - def client_auth(self, username, password, resource, sasl): - ''' - Method authenticating connected client with supplied credentials. Returns - when authentication is over. - :param sasl: whether to use sasl (sasl=1) or old (sasl=0) authentication - - :todo: to check and be more specific about when it returns (bind, session..) - ''' - self.client.auth(username, password, resource, sasl, - on_auth=self.connection.on_auth) - - print 'waiting for authentication...' - self.connection.wait() - - def do_disconnect(self): - ''' - Does disconnecting of connected client. Returns when TCP connection is closed. - ''' - #self.client.start_disconnect(None, on_disconnect=self.connection.set_event) - self.client.RegisterDisconnectHandler(self.connection.set_event) - self.client.disconnect() - - print 'waiting for disconnecting...' - self.connection.wait() - - def test_proper_connect_sasl(self): - ''' - The ideal testcase - client is connected, authenticated with SASL and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - - # if client is not connected, lets raise the AssertionError - self.assert_(self.client.get_connect_type()) - # (client.disconnect() is already called from NBClient._on_connected_failure - # so there's need to call it in this case - - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=1) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='sasl') - - self.do_disconnect() - - - def test_proper_connect_oldauth(self): - ''' - The ideal testcase - client is connected, authenticated with old auth and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=0) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='old_auth') - self.do_disconnect() - - def test_connect_to_nonexisting_host(self): - ''' - Connect to nonexisting host. DNS request for A records should return nothing. - ''' - self.open_stream(('fdsfsdf.fdsf.fss', 5222)) - print 'nonexthost: %s' % self.client.get_connect_type() - self.assert_(not self.client.get_connect_type()) - - def test_connect_to_wrong_port(self): - ''' - Connect to nonexisting host. DNS request for A records should return some IP - but there shouldn't be XMPP server running on specified port. - ''' - self.open_stream((xmpp_server_port[0], 31337)) - self.assert_(not self.client.get_connect_type()) - - def test_connect_with_wrong_creds(self): - ''' - Connecting with invalid password. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], "wrong pass", credentials[2], sasl=1) - self.assert_(self.connection.auth is None) - self.do_disconnect() - - - - - - -if __name__ == '__main__': - - suite = unittest.TestLoader().loadTestsFromTestCase(TestNonBlockingClient) - #suite = unittest.TestSuite() - #suite.addTest(TestNonBlockingClient('test_proper_connect_oldauth')) - #suite.addTest(TestNonBlockingClient('test_connect_to_nonexisting_host')) - - unittest.TextTestRunner(verbosity=2).run(suite) - - - - - import unittest -from xmpp_mocks import * +from xmpp_mocks import MockConnectionClass, IdleQueueThread import sys, os.path gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') - sys.path.append(gajim_root + '/src/common/xmpp') import client_nb -''' -Testing script for NonBlockingClient class (src/common/xmpp/client_nb.py) -It actually connects to a xmpp server so the connection values have to be -changed before running. -''' +# (XMPP server hostname, c2s port). Script will connect to the machine. +xmpp_server_port = ('gajim.org', 5222) - -xmpp_server_port = ('xmpp.example.org',5222) -''' -2-tuple - (XMPP server hostname, c2s port) -Script will connect to the machine. -''' - +# [username, password, passphrase]. Script will authenticate to server above credentials = ['loginn', 'passwo', 'testresour'] -''' -[username, password, passphrase] -Script will autheticate itself with this credentials on above mentioned server. -''' class TestNonBlockingClient(unittest.TestCase): ''' Test Cases class for NonBlockingClient. ''' - def setUp(self): - ''' - IdleQueue thread is run and dummy connection is created. - ''' - + ''' IdleQueue thread is run and dummy connection is created. ''' self.idlequeue_thread = IdleQueueThread() self.connection = MockConnectionClass() - self.idlequeue_thread.start() def tearDown(self): - ''' - IdleQueue thread is stopped. - ''' + ''' IdleQueue thread is stopped. ''' self.idlequeue_thread.stop_thread() self.idlequeue_thread.join() @@ -241,24 +42,21 @@ :param server_port: tuple of (hostname, port) for where the client should connect. - ''' self.client = client_nb.NonBlockingClient( - hostname=server_port[0], - port=server_port[1], - caller=self.connection, - idlequeue=self.idlequeue_thread.iq, - ) + domain=server_port[0], + idlequeue=self.idlequeue_thread.iq) ''' NonBlockingClient instance with parameters from global variables and with callbacks from dummy connection. ''' self.client.connect( + hostname=server_port[0], + port=server_port[1], on_connect=lambda *args: self.connection.on_connect(True, *args), - on_connect_failure=lambda *args: self.connection.on_connect(False, *args), - secure=False - ) + on_connect_failure=lambda *args: self.connection.on_connect( + False, *args)) print 'waiting for callback from client constructor' self.connection.wait() @@ -352,581 +150,7 @@ self.do_disconnect() - - - - if __name__ == '__main__': + unittest.main() - suite = unittest.TestLoader().loadTestsFromTestCase(TestNonBlockingClient) - #suite = unittest.TestSuite() - #suite.addTest(TestNonBlockingClient('test_proper_connect_oldauth')) - #suite.addTest(TestNonBlockingClient('test_connect_to_nonexisting_host')) - - unittest.TextTestRunner(verbosity=2).run(suite) - - - - - -import unittest -from xmpp_mocks import * - -import sys, os.path - -gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') - -sys.path.append(gajim_root + '/src/common/xmpp') - -import client_nb - -''' -Testing script for NonBlockingClient class (src/common/xmpp/client_nb.py) -It actually connects to a xmpp server so the connection values have to be -changed before running. -''' - - -xmpp_server_port = ('xmpp.example.org',5222) -''' -2-tuple - (XMPP server hostname, c2s port) -Script will connect to the machine. -''' - -credentials = ['loginn', 'passwo', 'testresour'] -''' -[username, password, passphrase] -Script will autheticate itself with this credentials on above mentioned server. -''' - -class TestNonBlockingClient(unittest.TestCase): - ''' - Test Cases class for NonBlockingClient. - ''' - - def setUp(self): - ''' - IdleQueue thread is run and dummy connection is created. - ''' - - self.idlequeue_thread = IdleQueueThread() - self.connection = MockConnectionClass() - - self.idlequeue_thread.start() - - def tearDown(self): - ''' - IdleQueue thread is stopped. - ''' - self.idlequeue_thread.stop_thread() - self.idlequeue_thread.join() - - def open_stream(self, server_port): - ''' - Method opening the XMPP connection. It returns when <stream:features> - is received from server. - - :param server_port: tuple of (hostname, port) for where the client should - connect. - - ''' - self.client = client_nb.NonBlockingClient( - hostname=server_port[0], - port=server_port[1], - caller=self.connection, - idlequeue=self.idlequeue_thread.iq, - ) - ''' - NonBlockingClient instance with parameters from global variables and with - callbacks from dummy connection. - ''' - - self.client.connect( - on_connect=lambda *args: self.connection.on_connect(True, *args), - on_connect_failure=lambda *args: self.connection.on_connect(False, *args), - secure=False - ) - - print 'waiting for callback from client constructor' - self.connection.wait() - - # if on_connect was called, client has to be connected and vice versa - if self.connection.connect_succeeded: - self.assert_(self.client.get_connect_type()) - else: - self.assert_(not self.client.get_connect_type()) - - def client_auth(self, username, password, resource, sasl): - ''' - Method authenticating connected client with supplied credentials. Returns - when authentication is over. - :param sasl: whether to use sasl (sasl=1) or old (sasl=0) authentication - - :todo: to check and be more specific about when it returns (bind, session..) - ''' - self.client.auth(username, password, resource, sasl, - on_auth=self.connection.on_auth) - - print 'waiting for authentication...' - self.connection.wait() - - def do_disconnect(self): - ''' - Does disconnecting of connected client. Returns when TCP connection is closed. - ''' - #self.client.start_disconnect(None, on_disconnect=self.connection.set_event) - self.client.RegisterDisconnectHandler(self.connection.set_event) - self.client.disconnect() - - print 'waiting for disconnecting...' - self.connection.wait() - - def test_proper_connect_sasl(self): - ''' - The ideal testcase - client is connected, authenticated with SASL and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - - # if client is not connected, lets raise the AssertionError - self.assert_(self.client.get_connect_type()) - # (client.disconnect() is already called from NBClient._on_connected_failure - # so there's need to call it in this case - - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=1) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='sasl') - - self.do_disconnect() - - - def test_proper_connect_oldauth(self): - ''' - The ideal testcase - client is connected, authenticated with old auth and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=0) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='old_auth') - self.do_disconnect() - - def test_connect_to_nonexisting_host(self): - ''' - Connect to nonexisting host. DNS request for A records should return nothing. - ''' - self.open_stream(('fdsfsdf.fdsf.fss', 5222)) - print 'nonexthost: %s' % self.client.get_connect_type() - self.assert_(not self.client.get_connect_type()) - - def test_connect_to_wrong_port(self): - ''' - Connect to nonexisting host. DNS request for A records should return some IP - but there shouldn't be XMPP server running on specified port. - ''' - self.open_stream((xmpp_server_port[0], 31337)) - self.assert_(not self.client.get_connect_type()) - - def test_connect_with_wrong_creds(self): - ''' - Connecting with invalid password. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], "wrong pass", credentials[2], sasl=1) - self.assert_(self.connection.auth is None) - self.do_disconnect() - - - - - - -if __name__ == '__main__': - - suite = unittest.TestLoader().loadTestsFromTestCase(TestNonBlockingClient) - #suite = unittest.TestSuite() - #suite.addTest(TestNonBlockingClient('test_proper_connect_oldauth')) - #suite.addTest(TestNonBlockingClient('test_connect_to_nonexisting_host')) - - unittest.TextTestRunner(verbosity=2).run(suite) - - - - - -import unittest -from xmpp_mocks import * - -import sys, os.path - -gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') - -sys.path.append(gajim_root + '/src/common/xmpp') - -import client_nb - -''' -Testing script for NonBlockingClient class (src/common/xmpp/client_nb.py) -It actually connects to a xmpp server so the connection values have to be -changed before running. -''' - - -xmpp_server_port = ('xmpp.example.org',5222) -''' -2-tuple - (XMPP server hostname, c2s port) -Script will connect to the machine. -''' - -credentials = ['loginn', 'passwo', 'testresour'] -''' -[username, password, passphrase] -Script will autheticate itself with this credentials on above mentioned server. -''' - -class TestNonBlockingClient(unittest.TestCase): - ''' - Test Cases class for NonBlockingClient. - ''' - - def setUp(self): - ''' - IdleQueue thread is run and dummy connection is created. - ''' - - self.idlequeue_thread = IdleQueueThread() - self.connection = MockConnectionClass() - - self.idlequeue_thread.start() - - def tearDown(self): - ''' - IdleQueue thread is stopped. - ''' - self.idlequeue_thread.stop_thread() - self.idlequeue_thread.join() - - def open_stream(self, server_port): - ''' - Method opening the XMPP connection. It returns when <stream:features> - is received from server. - - :param server_port: tuple of (hostname, port) for where the client should - connect. - - ''' - self.client = client_nb.NonBlockingClient( - hostname=server_port[0], - port=server_port[1], - caller=self.connection, - idlequeue=self.idlequeue_thread.iq, - ) - ''' - NonBlockingClient instance with parameters from global variables and with - callbacks from dummy connection. - ''' - - self.client.connect( - on_connect=lambda *args: self.connection.on_connect(True, *args), - on_connect_failure=lambda *args: self.connection.on_connect(False, *args), - secure=False - ) - - print 'waiting for callback from client constructor' - self.connection.wait() - - # if on_connect was called, client has to be connected and vice versa - if self.connection.connect_succeeded: - self.assert_(self.client.get_connect_type()) - else: - self.assert_(not self.client.get_connect_type()) - - def client_auth(self, username, password, resource, sasl): - ''' - Method authenticating connected client with supplied credentials. Returns - when authentication is over. - :param sasl: whether to use sasl (sasl=1) or old (sasl=0) authentication - - :todo: to check and be more specific about when it returns (bind, session..) - ''' - self.client.auth(username, password, resource, sasl, - on_auth=self.connection.on_auth) - - print 'waiting for authentication...' - self.connection.wait() - - def do_disconnect(self): - ''' - Does disconnecting of connected client. Returns when TCP connection is closed. - ''' - #self.client.start_disconnect(None, on_disconnect=self.connection.set_event) - self.client.RegisterDisconnectHandler(self.connection.set_event) - self.client.disconnect() - - print 'waiting for disconnecting...' - self.connection.wait() - - def test_proper_connect_sasl(self): - ''' - The ideal testcase - client is connected, authenticated with SASL and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - - # if client is not connected, lets raise the AssertionError - self.assert_(self.client.get_connect_type()) - # (client.disconnect() is already called from NBClient._on_connected_failure - # so there's need to call it in this case - - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=1) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='sasl') - - self.do_disconnect() - - - def test_proper_connect_oldauth(self): - ''' - The ideal testcase - client is connected, authenticated with old auth and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=0) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='old_auth') - self.do_disconnect() - - def test_connect_to_nonexisting_host(self): - ''' - Connect to nonexisting host. DNS request for A records should return nothing. - ''' - self.open_stream(('fdsfsdf.fdsf.fss', 5222)) - print 'nonexthost: %s' % self.client.get_connect_type() - self.assert_(not self.client.get_connect_type()) - - def test_connect_to_wrong_port(self): - ''' - Connect to nonexisting host. DNS request for A records should return some IP - but there shouldn't be XMPP server running on specified port. - ''' - self.open_stream((xmpp_server_port[0], 31337)) - self.assert_(not self.client.get_connect_type()) - - def test_connect_with_wrong_creds(self): - ''' - Connecting with invalid password. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], "wrong pass", credentials[2], sasl=1) - self.assert_(self.connection.auth is None) - self.do_disconnect() - - - - - - -if __name__ == '__main__': - - suite = unittest.TestLoader().loadTestsFromTestCase(TestNonBlockingClient) - #suite = unittest.TestSuite() - #suite.addTest(TestNonBlockingClient('test_proper_connect_oldauth')) - #suite.addTest(TestNonBlockingClient('test_connect_to_nonexisting_host')) - - unittest.TextTestRunner(verbosity=2).run(suite) - - - - - -import unittest -from xmpp_mocks import * - -import sys, os.path - -gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') - -sys.path.append(gajim_root + '/src/common/xmpp') - -import client_nb - -''' -Testing script for NonBlockingClient class (src/common/xmpp/client_nb.py) -It actually connects to a xmpp server so the connection values have to be -changed before running. -''' - - -xmpp_server_port = ('xmpp.example.org',5222) -''' -2-tuple - (XMPP server hostname, c2s port) -Script will connect to the machine. -''' - -credentials = ['loginn', 'passwo', 'testresour'] -''' -[username, password, passphrase] -Script will autheticate itself with this credentials on above mentioned server. -''' - -class TestNonBlockingClient(unittest.TestCase): - ''' - Test Cases class for NonBlockingClient. - ''' - - def setUp(self): - ''' - IdleQueue thread is run and dummy connection is created. - ''' - - self.idlequeue_thread = IdleQueueThread() - self.connection = MockConnectionClass() - - self.idlequeue_thread.start() - - def tearDown(self): - ''' - IdleQueue thread is stopped. - ''' - self.idlequeue_thread.stop_thread() - self.idlequeue_thread.join() - - def open_stream(self, server_port): - ''' - Method opening the XMPP connection. It returns when <stream:features> - is received from server. - - :param server_port: tuple of (hostname, port) for where the client should - connect. - - ''' - self.client = client_nb.NonBlockingClient( - hostname=server_port[0], - port=server_port[1], - caller=self.connection, - idlequeue=self.idlequeue_thread.iq, - ) - ''' - NonBlockingClient instance with parameters from global variables and with - callbacks from dummy connection. - ''' - - self.client.connect( - on_connect=lambda *args: self.connection.on_connect(True, *args), - on_connect_failure=lambda *args: self.connection.on_connect(False, *args), - secure=False - ) - - print 'waiting for callback from client constructor' - self.connection.wait() - - # if on_connect was called, client has to be connected and vice versa - if self.connection.connect_succeeded: - self.assert_(self.client.get_connect_type()) - else: - self.assert_(not self.client.get_connect_type()) - - def client_auth(self, username, password, resource, sasl): - ''' - Method authenticating connected client with supplied credentials. Returns - when authentication is over. - :param sasl: whether to use sasl (sasl=1) or old (sasl=0) authentication - - :todo: to check and be more specific about when it returns (bind, session..) - ''' - self.client.auth(username, password, resource, sasl, - on_auth=self.connection.on_auth) - - print 'waiting for authentication...' - self.connection.wait() - - def do_disconnect(self): - ''' - Does disconnecting of connected client. Returns when TCP connection is closed. - ''' - #self.client.start_disconnect(None, on_disconnect=self.connection.set_event) - self.client.RegisterDisconnectHandler(self.connection.set_event) - self.client.disconnect() - - print 'waiting for disconnecting...' - self.connection.wait() - - def test_proper_connect_sasl(self): - ''' - The ideal testcase - client is connected, authenticated with SASL and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - - # if client is not connected, lets raise the AssertionError - self.assert_(self.client.get_connect_type()) - # (client.disconnect() is already called from NBClient._on_connected_failure - # so there's need to call it in this case - - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=1) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='sasl') - - self.do_disconnect() - - - def test_proper_connect_oldauth(self): - ''' - The ideal testcase - client is connected, authenticated with old auth and - then disconnected. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], credentials[1], credentials[2], sasl=0) - self.assert_(self.connection.con) - self.assert_(self.connection.auth=='old_auth') - self.do_disconnect() - - def test_connect_to_nonexisting_host(self): - ''' - Connect to nonexisting host. DNS request for A records should return nothing. - ''' - self.open_stream(('fdsfsdf.fdsf.fss', 5222)) - print 'nonexthost: %s' % self.client.get_connect_type() - self.assert_(not self.client.get_connect_type()) - - def test_connect_to_wrong_port(self): - ''' - Connect to nonexisting host. DNS request for A records should return some IP - but there shouldn't be XMPP server running on specified port. - ''' - self.open_stream((xmpp_server_port[0], 31337)) - self.assert_(not self.client.get_connect_type()) - - def test_connect_with_wrong_creds(self): - ''' - Connecting with invalid password. - ''' - self.open_stream(xmpp_server_port) - self.assert_(self.client.get_connect_type()) - self.client_auth(credentials[0], "wrong pass", credentials[2], sasl=1) - self.assert_(self.connection.auth is None) - self.do_disconnect() - - - - - - -if __name__ == '__main__': - - suite = unittest.TestLoader().loadTestsFromTestCase(TestNonBlockingClient) - #suite = unittest.TestSuite() - #suite.addTest(TestNonBlockingClient('test_proper_connect_oldauth')) - #suite.addTest(TestNonBlockingClient('test_connect_to_nonexisting_host')) - - unittest.TextTestRunner(verbosity=2).run(suite) - - - - - +# vim: se ts=3:

1 0

[commit-gajim] r10909 - trunk/test
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 15:50:50 +0100 (Wed, 24 Dec 2008) New Revision: 10909 Modified: trunk/test/xmpp_mocks.py Log: Comment some prints in xmpp_mocks.py. Should be merged with test/lib/mocks.py Modified: trunk/test/xmpp_mocks.py =================================================================== --- trunk/test/xmpp_mocks.py 2008-12-24 14:46:21 UTC (rev 10908) +++ trunk/test/xmpp_mocks.py 2008-12-24 14:50:50 UTC (rev 10909) @@ -1,31 +1,27 @@ ''' -Module with dummy classes for unit testing of xmpp code (src/common/xmpp/*). +Module with dummy classes for unit testing of XMPP and related code. ''' import threading, time, os.path, sys +gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') +sys.path.append(gajim_root + '/src/common/xmpp') +import idlequeue +from client import PlugIn + import lib lib.setup_env() + from mock import Mock -gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') -sys.path.append(gajim_root + '/src/common/xmpp') -''' -Module with classes usable for XMPP related testing. -''' - -import idlequeue -from client import PlugIn - idlequeue_interval = 0.2 ''' IdleQueue polling interval. 200ms is used in Gajim as default ''' - class IdleQueueThread(threading.Thread): ''' Thread for regular processing of idlequeue. @@ -48,8 +44,6 @@ def stop_thread(self): self.stop.set() - - class IdleMock: ''' @@ -63,10 +57,10 @@ ''' self.event.clear() - def wait(self): ''' - Waiting until some callback sets the event and clearing the event subsequently. + Waiting until some callback sets the event and clearing the event + subsequently. ''' self.event.wait() self.event.clear() @@ -75,7 +69,7 @@ self.event.set() -class MockConnectionClass(IdleMock,Mock): +class MockConnectionClass(IdleMock, Mock): ''' Class simulating Connection class from src/common/connection.py @@ -94,17 +88,16 @@ Method called after connecting - after receiving <stream:features> from server (NOT after TLS stream restart) or connect failure ''' - - print 'on_connect - args:' - print ' success - %s' % success - for i in args: - print ' %s' % i + #print 'on_connect - args:' + #print ' success - %s' % success + #for i in args: + # print ' %s' % i self.connect_succeeded = success self.set_event() def on_auth(self, con, auth): ''' - Method called after authentication is done regardless on the result. + Method called after authentication, regardless of the result. :Parameters: con : NonBlockingClient @@ -113,7 +106,6 @@ type of authetication in case of success ('old_auth', 'sasl') or None in case of auth failure ''' - #print 'on_auth - args:' #print ' con: %s' % con #print ' auth: %s' % auth @@ -121,3 +113,4 @@ self.auth = auth self.set_event() +# vim: se ts=3:

1 0

[commit-gajim] r10908 - trunk/test
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 15:46:21 +0100 (Wed, 24 Dec 2008) New Revision: 10908 Modified: trunk/test/test_nonblockingtcp.py Log: Small cleanups to test_nonblockingtcp.py without much value. Modified: trunk/test/test_nonblockingtcp.py =================================================================== --- trunk/test/test_nonblockingtcp.py 2008-12-24 14:44:07 UTC (rev 10907) +++ trunk/test/test_nonblockingtcp.py 2008-12-24 14:46:21 UTC (rev 10908) @@ -3,10 +3,9 @@ ''' import unittest -from xmpp_mocks import * +from xmpp_mocks import IdleQueueThread, IdleMock +import sys, os.path -import threading, sys, os.path, time - gajim_root = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..') sys.path.append(gajim_root + '/src/common/xmpp') @@ -15,25 +14,27 @@ import transports_nb from client import * -xmpp_server = ('gajim.org',5222) +xmpp_server = ('gajim.org', 5222) ''' 2-tuple - (XMPP server hostname, c2s port) Script will connect to the machine. ''' import socket -ips = socket.getaddrinfo(xmpp_server[0], xmpp_server[1], socket.AF_UNSPEC,socket.SOCK_STREAM) +ips = socket.getaddrinfo(xmpp_server[0], xmpp_server[1], + socket.AF_UNSPEC,socket.SOCK_STREAM) # change xmpp_server on real values ip = ips[0] class MockClient(IdleMock): + def __init__(self, idlequeue): - self.idlequeue=idlequeue + self.idlequeue = idlequeue IdleMock.__init__(self) def do_connect(self): - self.socket=transports_nb.NonBlockingTCP( + self.socket = transports_nb.NonBlockingTCP( lambda(event_type, data): sys.stdout.write('raising event %s: %s' % ( event_type, data)), lambda: self.on_success(mode='SocketDisconnect'), self.idlequeue, False, None) @@ -70,12 +71,14 @@ self.idlequeue_thread.stop_thread() self.idlequeue_thread.join() - def testSth(self): + def test_connect_disconnect(self): self.client.do_connect() self.assert_(self.client.socket.state == 'CONNECTED') self.client.do_disconnect() self.assert_(self.client.socket.state == 'DISCONNECTED') + if __name__ == '__main__': - suite = unittest.TestLoader().loadTestsFromTestCase(TestNonBlockingTCP) - unittest.TextTestRunner(verbosity=2).run(suite) + unittest.main() + +# vim: se ts=3:

1 0

[commit-gajim] r10907 - trunk/test
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 15:44:07 +0100 (Wed, 24 Dec 2008) New Revision: 10907 Modified: trunk/test/test_resolver.py Log: Make test_resolver work again after IdleQueue move. Modified: trunk/test/test_resolver.py =================================================================== --- trunk/test/test_resolver.py 2008-12-24 14:41:26 UTC (rev 10906) +++ trunk/test/test_resolver.py 2008-12-24 14:44:07 UTC (rev 10907) @@ -6,14 +6,13 @@ lib.setup_env() from common import resolver -from gajim import GlibIdleQueue +from common.xmpp.idlequeue import GlibIdleQueue from mock import Mock, expectParams from mocks import * import gtk - GMAIL_SRV_NAME = '_xmpp-client._tcp.gmail.com' NONSENSE_NAME = 'sfsdfsdfsdf.sdfs.fsd' JABBERCZ_TXT_NAME = '_xmppconnect.jabber.cz' @@ -24,6 +23,8 @@ (JABBERCZ_SRV_NAME, 'srv', True)] class TestResolver(unittest.TestCase): + ''' Test for LibAsyncNSResolver and NSLookupResolver ''' + def setUp(self): self.iq = GlibIdleQueue() self.reset() @@ -56,19 +57,18 @@ time.sleep(1) self.resolver.process() - def myonready(self, name, result_set): - print 'on_ready called ...' - print 'hostname: %s' % name - print 'result set: %s' % result_set - print 'res.resolved_hosts: %s' % self.resolver.resolved_hosts + if __name__ == '__main__': + print 'on_ready called ...' + print 'hostname: %s' % name + print 'result set: %s' % result_set + print 'res.resolved_hosts: %s' % self.resolver.resolved_hosts if self.expect_results: self.assert_(len(result_set) > 0) else: self.assert_(result_set == []) self.flag = True if self.nslookup: self._testNSLR() - def testNSLookupResolver(self): self.reset() @@ -93,3 +93,5 @@ if __name__ == '__main__': unittest.main() + +# vim: se ts=3:

1 0

[commit-gajim] r10906 - trunk/src/common/xmpp
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 15:41:26 +0100 (Wed, 24 Dec 2008) New Revision: 10906 Modified: trunk/src/common/xmpp/client_nb.py Log: Coding standards and documentation improvements in client_nb.py Modified: trunk/src/common/xmpp/client_nb.py =================================================================== --- trunk/src/common/xmpp/client_nb.py 2008-12-24 14:28:17 UTC (rev 10905) +++ trunk/src/common/xmpp/client_nb.py 2008-12-24 14:41:26 UTC (rev 10906) @@ -16,10 +16,13 @@ # $Id: client.py,v 1.52 2006/01/02 19:40:55 normanr Exp $ +''' +Client class establishs connection to XMPP Server and handles authentication +''' import socket import transports_nb, dispatcher_nb, auth_nb, roster_nb, protocol, bosh -from client import * +from client import PlugIn from protocol import NS_TLS @@ -37,10 +40,11 @@ def __init__(self, domain, idlequeue, caller=None): ''' Caches connection data: + :param domain: domain - for to: attribute (from account info) :param idlequeue: processing idlequeue - :param caller: calling object - it has to implement methods _event_dispatcher - which is called from dispatcher instance + :param caller: calling object - it has to implement methods + _event_dispatcher which is called from dispatcher instance ''' self.Namespace = protocol.NS_CLIENT self.defaultNamespace = self.Namespace @@ -51,7 +55,8 @@ self.Server = domain self.xmpp_hostname = None # FQDN hostname to connect to - # caller is who initiated this client, it is ineeded to register the EventDispatcher + # caller is who initiated this client, it is in needed to register + # the EventDispatcher self._caller = caller self._owner = self self._registered_name = None @@ -68,10 +73,9 @@ def disconnect(self, message=''): ''' - Called on disconnection - disconnect callback is picked based on state of the - client. + Called on disconnection - disconnect callback is picked based on state + of the client. ''' - # to avoid recursive calls if self.disconnecting: return @@ -102,8 +106,8 @@ log.debug('Client disconnected..') if connected == '': - # if we're disconnecting before connection to XMPP sever is opened, we don't - # call disconnect handlers but on_connect_failure callback + # if we're disconnecting before connection to XMPP sever is opened, + # we don't call disconnect handlers but on_connect_failure callback if self.proxy: # with proxy, we have different failure callback log.debug('calling on_proxy_failure cb') @@ -114,9 +118,10 @@ else: # we are connected to XMPP server if not stream_started: - # if error occur before XML stream was opened, e.g. no response on init - # request, we call the on_connect_failure callback because proper - # connection is not estabilished yet and it's not a proxy issue + # if error occur before XML stream was opened, e.g. no response on + # init request, we call the on_connect_failure callback because + # proper connection is not estabilished yet and it's not a proxy + # issue log.debug('calling on_connect_failure cb') self.on_connect_failure() else: @@ -126,26 +131,26 @@ i() self.disconnecting = False - def connect(self, on_connect, on_connect_failure, hostname=None, port=5222, on_proxy_failure=None, proxy=None, secure_tuple=(None, None, None)): ''' Open XMPP connection (open XML streams in both directions). + :param on_connect: called after stream is successfully opened :param on_connect_failure: called when error occures during connection :param hostname: hostname of XMPP server from SRV request :param port: port number of XMPP server :param on_proxy_failure: called if error occurres during TCP connection to proxy server or during proxy connecting process - :param proxy: dictionary with proxy data. It should contain at least values - for keys 'host' and 'port' - connection details for proxy server and - optionally keys 'user' and 'pass' as proxy credentials - :param secure_tuple: tuple of (desired connection type, cacerts and mycerts) + :param proxy: dictionary with proxy data. It should contain at least + values for keys 'host' and 'port' - connection details for proxy serve + and optionally keys 'user' and 'pass' as proxy credentials + :param secure_tuple: tuple of (desired connection type, cacerts, mycerts) connection type can be 'ssl' - TLS estabilished after TCP connection, 'tls' - TLS estabilished after negotiation with starttls, or 'plain'. - cacerts, mycerts - see tls_nb.NonBlockingTLS constructor for more details + cacerts, mycerts - see tls_nb.NonBlockingTLS constructor for more + details ''' - self.on_connect = on_connect self.on_connect_failure=on_connect_failure self.on_proxy_failure = on_proxy_failure @@ -173,9 +178,9 @@ # (DNS request will be done for proxy or BOSH CM hostname) tcp_host, tcp_port, proxy_user, proxy_pass = \ transports_nb.get_proxy_data_from_dict(proxy) - if proxy['type'] == 'bosh': + # Setup BOSH transport self.socket = bosh.NonBlockingBOSH( on_disconnect = self.disconnect, raise_event = self.raise_event, @@ -187,14 +192,16 @@ domain = self.Server, bosh_dict = proxy) self.protocol_type = 'BOSH' - self.wait_for_restart_response = proxy['bosh_wait_for_restart_response'] - + self.wait_for_restart_response = \ + proxy['bosh_wait_for_restart_response'] else: + # http proxy proxy_dict['type'] = proxy['type'] proxy_dict['xmpp_server'] = (self.xmpp_hostname, self.Port) proxy_dict['credentials'] = (proxy_user, proxy_pass) if not proxy or proxy['type'] != 'bosh': + # Setup ordinary TCP transport self.socket = transports_nb.NonBlockingTCP( on_disconnect = self.disconnect, raise_event = self.raise_event, @@ -203,6 +210,7 @@ certs = certs, proxy_dict = proxy_dict) + # plug transport into client as self.Connection self.socket.PlugIn(self) self._resolve_hostname( @@ -222,7 +230,7 @@ on_success() def _try_next_ip(self, err_message=None): - '''iterates over IP addresses from getaddrinfo''' + '''Iterates over IP addresses tries to connect to it''' if err_message: log.debug('While looping over DNS A records: %s' % err_message) if self.ip_addresses == []: @@ -236,10 +244,9 @@ on_connect=lambda: self._xmpp_connect(socket_type='plain'), on_connect_failure=self._try_next_ip) - def incoming_stream_version(self): ''' gets version of xml stream''' - if self.Dispatcher.Stream._document_attrs.has_key('version'): + if 'version' in self.Dispatcher.Stream._document_attrs: return self.Dispatcher.Stream._document_attrs['version'] else: return None @@ -255,19 +262,23 @@ self.connected = socket_type self._xmpp_connect_machine() - def _xmpp_connect_machine(self, mode=None, data=None): ''' Finite automaton taking care of stream opening and features tag handling. Calls _on_stream_start when stream is started, and disconnect() on failure. ''' - log.info('-------------xmpp_connect_machine() >> mode: %s, data: %s...' % (mode,str(data)[:20] )) + log.info('-------------xmpp_connect_machine() >> mode: %s, data: %s...' % + (mode, str(data)[:20])) def on_next_receive(mode): + ''' + Sets desired on_receive callback on transport based on the state of + connect_machine. + ''' log.info('setting %s on next receive' % mode) if mode is None: - self.onreceive(None) + self.onreceive(None) # switch to Dispatcher.ProcessNonBlocking else: self.onreceive(lambda _data:self._xmpp_connect_machine(mode, _data)) @@ -286,7 +297,7 @@ if data: self.Dispatcher.ProcessNonBlocking(data) if not hasattr(self, 'Dispatcher') or \ - self.Dispatcher.Stream._document_attrs is None: + self.Dispatcher.Stream._document_attrs is None: self._xmpp_connect_machine( mode='FAILURE', data='Error on stream open') @@ -320,7 +331,7 @@ def _on_stream_start(self): ''' Called after XMPP stream is opened. - TLS negotiation may follow after esabilishing a stream. + TLS negotiation may follow when stream is established. ''' self.stream_started = True self.onreceive(None) @@ -358,7 +369,7 @@ self.send('<starttls xmlns="%s"/>' % NS_TLS) else: # we got <proceed> or <failure> - if tag.getNamespace() <> NS_TLS: + if tag.getNamespace() != NS_TLS: self.disconnect('Unknown namespace: %s' % tag.getNamespace()) return tagname = tag.getName() @@ -379,15 +390,17 @@ def raise_event(self, event_type, data): ''' - raises event to connection instance - DATA_SENT and DATA_RECIVED events are - used in XML console to show XMPP traffic + Raises event to connection instance. DATA_SENT and DATA_RECIVED events + are used in XML console to show XMPP traffic ''' log.info('raising event from transport: :::::%s::::\n_____________\n%s\n_____________\n' % (event_type,data)) if hasattr(self, 'Dispatcher'): self.Dispatcher.Event('', event_type, data) - # follows code for authentication, resource bind, session and roster download - # +############################################################################### +### follows code for authentication, resource bind, session and roster download +############################################################################### + def auth(self, user, password, resource = '', sasl = 1, on_auth = None): ''' Authenticate connnection and bind resource. If resource is not provided @@ -450,13 +463,12 @@ else: self.on_auth(self, None) - def initRoster(self): ''' Plug in the roster. ''' if not self.__dict__.has_key('NonBlockingRoster'): roster_nb.NonBlockingRoster().PlugIn(self) - def getRoster(self, on_ready = None): + def getRoster(self, on_ready=None): ''' Return the Roster instance, previously plugging it in and requesting roster from server if needed. ''' if self.__dict__.has_key('NonBlockingRoster'): @@ -466,10 +478,15 @@ def sendPresence(self, jid=None, typ=None, requestRoster=0): ''' Send some specific presence state. Can also request roster from server if according agrument is set.''' - if requestRoster: roster_nb.NonBlockingRoster().PlugIn(self) + if requestRoster: + # FIXME: used somewhere? + roster_nb.NonBlockingRoster().PlugIn(self) self.send(dispatcher_nb.Presence(to=jid, typ=typ)) - # following methods are moved from blocking client class from xmpppy: +############################################################################### +### following methods are moved from blocking client class of xmpppy +############################################################################### + def RegisterDisconnectHandler(self,handler): ''' Register handler that will be called on disconnect.''' self.disconnect_handlers.append(handler) @@ -493,8 +510,8 @@ def get_peerhost(self): ''' Gets the ip address of the account, from which is made connection to the - server , (e.g. IP and port of gajim's socket. We will create listening socket - on the same ip + server (e.g. IP and port of gajim's socket). + We will create listening socket on the same ip ''' # FIXME: tuple (ip, port) is expected (and checked for) but port num is # useless

1 0

[commit-gajim] r10905 - trunk/src/common/xmpp
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 15:28:17 +0100 (Wed, 24 Dec 2008) New Revision: 10905 Modified: trunk/src/common/xmpp/__init__.py trunk/src/common/xmpp/client.py Log: Add credits and remove outdated documentation from __init__.py Modified: trunk/src/common/xmpp/__init__.py =================================================================== --- trunk/src/common/xmpp/__init__.py 2008-12-24 13:56:02 UTC (rev 10904) +++ trunk/src/common/xmpp/__init__.py 2008-12-24 14:28:17 UTC (rev 10905) @@ -1,35 +1,19 @@ # $Id: __init__.py,v 1.9 2005/03/07 09:34:51 snakeru Exp $ """ -All features of xmpppy library contained within separate modules. -At present there are modules: -simplexml - XML handling routines -protocol - jabber-objects (I.e. JID and different stanzas and sub-stanzas) handling routines. -debug - Jacob Lundquist's debugging module. Very handy if you like colored debug. -auth - Non-SASL and SASL stuff. You will need it to auth as a client or transport. -transports - low level connection handling. TCP and TLS currently. HTTP support planned. -roster - simple roster for use in clients. -dispatcher - decision-making logic. Handles all hooks. The first who takes control over fresh stanzas. -features - different stuff that didn't worths separating into modules -browser - DISCO server framework. Allows to build dynamic disco tree. -filetransfer - Currently contains only IBB stuff. Can be used for bot-to-bot transfers. +Gajim maintains a fork of the xmpppy jabber python library. Most of the code is +inherited but has been extended by implementation of non-blocking transports +and new features like BOSH. -Most of the classes that is defined in all these modules is an ancestors of -class PlugIn so they share a single set of methods allowing you to compile -a featured XMPP client. For every instance of PlugIn class the 'owner' is the class -in what the plug was plugged. While plugging in such instance usually sets some -methods of owner to it's own ones for easy access. All session specific info stored -either in instance of PlugIn or in owner's instance. This is considered unhandy -and there are plans to port 'Session' class from xmppd.py project for storing all -session-related info. Though if you are not accessing instances variables directly -and use only methods for access all values you should not have any problems. +Most of the xmpp classes are ancestors of PlugIn class to share a single set of methods in order to compile a featured and extensible XMPP client. +Thanks and credits to the xmpppy developers. See: http://xmpppy.sourceforge.net/ """ import simplexml, protocol, auth_nb, transports_nb, roster_nb import dispatcher_nb, features_nb, idlequeue, bosh, tls_nb, proxy_connectors -from client_nb import * -from client import * +from client_nb import NonBlockingClient +from client import PlugIn from protocol import * -# vim: se ts=3: \ No newline at end of file +# vim: se ts=3: Modified: trunk/src/common/xmpp/client.py =================================================================== --- trunk/src/common/xmpp/client.py 2008-12-24 13:56:02 UTC (rev 10904) +++ trunk/src/common/xmpp/client.py 2008-12-24 14:28:17 UTC (rev 10905) @@ -28,6 +28,9 @@ Inherit to develop pluggable objects. No code change on the owner class required (the object where we plug into) + + For every instance of PlugIn class the 'owner' is the class in what the plug + was plugged. ''' def __init__(self): self._exported_methods=[]

1 0

[commit-gajim] r10904 - trunk/src/common/xmpp
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 14:56:02 +0100 (Wed, 24 Dec 2008) New Revision: 10904 Modified: trunk/src/common/xmpp/transports_nb.py Log: Make three docstrings epydoc enabled. See http://epydoc.sourceforge.net/manual-docstring.html Modified: trunk/src/common/xmpp/transports_nb.py =================================================================== --- trunk/src/common/xmpp/transports_nb.py 2008-12-24 13:51:15 UTC (rev 10903) +++ trunk/src/common/xmpp/transports_nb.py 2008-12-24 13:56:02 UTC (rev 10904) @@ -65,13 +65,13 @@ proxy_user, proxy_pass = proxy['user'], proxy['pass'] return tcp_host, tcp_port, proxy_user, proxy_pass -# timeout to connect to the server socket, it doesn't include auth +#: timeout to connect to the server socket, it doesn't include auth CONNECT_TIMEOUT_SECONDS = 30 -# how long to wait for a disconnect to complete +#: how long to wait for a disconnect to complete DISCONNECT_TIMEOUT_SECONDS = 5 -# size of the buffer which reads data from server +#: size of the buffer which reads data from server # if lower, more stanzas will be fragmented and processed twice RECV_BUFSIZE = 32768 # 2x maximum size of ssl packet, should be plenty #RECV_BUFSIZE = 16 # FIXME: (#2634) gajim breaks with this setting: it's inefficient but should work.

1 0

[commit-gajim] r10903 - trunk/src/common/xmpp
by steve-e＠gajim.org 24 Dec '08

24 Dec '08

Author: steve-e Date: 2008-12-24 14:51:15 +0100 (Wed, 24 Dec 2008) New Revision: 10903 Removed: trunk/src/common/xmpp/debug.py Log: Remove Jacob Lundqvist's xmpp/debug.py module. We have switched to builtin python logging. Deleted: trunk/src/common/xmpp/debug.py =================================================================== --- trunk/src/common/xmpp/debug.py 2008-12-24 13:44:23 UTC (rev 10902) +++ trunk/src/common/xmpp/debug.py 2008-12-24 13:51:15 UTC (rev 10903) @@ -1,394 +0,0 @@ -## debug.py -## -## Copyright (C) 2003 Jacob Lundqvist -## -## This program is free software; you can redistribute it and/or modify -## it under the terms of the GNU Lesser General Public License as published -## by the Free Software Foundation; either version 2, or (at your option) -## any later version. -## -## This program is distributed in the hope that it will be useful, -## but WITHOUT ANY WARRANTY; without even the implied warranty of -## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -## GNU Lesser General Public License for more details. - -''' -Generic debug class - -Other modules can always define extra debug flags for local usage, as long as -they make sure they append them to debug_flags - -Also its always a good thing to prefix local flags with something, to reduce risk -of coliding flags. Nothing breaks if two flags would be identical, but it might -activate unintended debugging. - -flags can be numeric, but that makes analysing harder, on creation its -not obvious what is activated, and when flag_show is given, output isnt -really meaningfull. - -This Debug class can either be initialized and used on app level, or used independantly -by the individual classes. - -For samples of usage, see samples subdir in distro source, and selftest -in this code -''' - -_version_ = '1.4.0' - - -import sys -import traceback -import time -import os - -if 'TERM' in os.environ: - colors_enabled=True -else: - colors_enabled=False - -color_none = chr(27) + "[0m" -color_black = chr(27) + "[30m" -color_red = chr(27) + "[31m" -color_green = chr(27) + "[32m" -color_brown = chr(27) + "[33m" -color_blue = chr(27) + "[34m" -color_magenta = chr(27) + "[35m" -color_cyan = chr(27) + "[36m" -color_light_gray = chr(27) + "[37m" -color_dark_gray = chr(27) + "[30;1m" -color_bright_red = chr(27) + "[31;1m" -color_bright_green = chr(27) + "[32;1m" -color_yellow = chr(27) + "[33;1m" -color_bright_blue = chr(27) + "[34;1m" -color_purple = chr(27) + "[35;1m" -color_bright_cyan = chr(27) + "[36;1m" -color_white = chr(27) + "[37;1m" - - -# Define your flags in yor modules like this: -# -# from debug import * -# -# DBG_INIT = 'init' ; debug_flags.append( DBG_INIT ) -# DBG_CONNECTION = 'connection' ; debug_flags.append( DBG_CONNECTION ) -# -# The reason for having a double statement wis so we can validate params -# and catch all undefined debug flags -# -# This gives us control over all used flags, and makes it easier to allow -# global debugging in your code, just do something like -# -# foo = Debug( debug_flags ) -# -# group flags, that is a flag in it self containing multiple flags should be -# defined without the debug_flags.append() sequence, since the parts are already -# in the list, also they must of course be defined after the flags they depend on ;) -# example: -# -# DBG_MULTI = [ DBG_INIT, DBG_CONNECTION ] -# -# -# -# NoDebug -# ------- -# To speed code up, typically for product releases or such -# use this class instead if you globaly want to disable debugging - - -class NoDebug: - def __init__( self, *args, **kwargs ): - pass - def show( self, *args, **kwargs): - pass - def is_active( self, flag ): - pass - def active_set( self, active_flags = None ): - return 0 - - -LINE_FEED = '\n' - - -class Debug: - def __init__( self, - # - # active_flags are those that will trigger output - # - active_flags = None, - # - # Log file should be file object or file namne - # - log_file = sys.stderr, - # - # prefix and sufix can either be set globaly or per call. - # personally I use this to color code debug statements - # with prefix = chr(27) + '[34m' - # sufix = chr(27) + '[37;1m\n' - # - prefix = 'DEBUG: ', - sufix = '\n', - # - # If you want unix style timestamps, - # 0 disables timestamps - # 1 before prefix, good when prefix is a string - # 2 after prefix, good when prefix is a color - # - time_stamp = 0, - # - # flag_show should normaly be of, but can be turned on to get a - # good view of what flags are actually used for calls, - # if it is not None, it should be a string - # flags for current call will be displayed - # with flag_show as separator - # recomended values vould be '-' or ':', but any string goes - # - flag_show = None, - # - # If you dont want to validate flags on each call to - # show(), set this to 0 - # - validate_flags = 0, - # - # If you dont want the welcome message, set to 0 - # default is to show welcome if any flags are active - welcome = -1 - ): - - self.debug_flags = [] - if welcome == -1: - if active_flags and len(active_flags): - welcome = 1 - else: - welcome = 0 - - self._remove_dupe_flags() - if log_file: - if isinstance(log_file, str): - try: - self._fh = open(log_file,'w') - except Exception: - print 'ERROR: can open %s for writing' - sys.exit(0) - else: ## assume its a stream type object - self._fh = log_file - else: - self._fh = sys.stdout - - if time_stamp not in (0,1,2): - raise Exception('Invalid time_stamp param "%s"' % str(time_stamp)) - self.prefix = prefix - self.sufix = sufix - self.time_stamp = time_stamp - self.flag_show = None # must be initialised after possible welcome - self.validate_flags = validate_flags - - self.active_set( active_flags ) - if welcome: - self.show('') - caller = sys._getframe(1) # used to get name of caller - try: - mod_name= ":%s" % caller.f_locals['__name__'] - except Exception: - mod_name = "" - self.show('Debug created for %s%s' % (caller.f_code.co_filename, - mod_name )) - self.show(' flags defined: %s' % ','.join( self.active )) - - if type(flag_show) in (str, type(None)): - self.flag_show = flag_show - else: - raise Exception('Invalid type "%s" for flag_show!' % \ - type(flag_show)) - - def show( self, msg, flag = None, prefix = None, sufix = None, - lf = 0 ): - ''' - flag can be of folowing types: - None - this msg will always be shown if any debugging is on - flag - will be shown if flag is active - (flag1,flag2,,,) - will be shown if any of the given flags - are active - - if prefix / sufix are not given, default ones from init will be used - - lf = -1 means strip linefeed if pressent - lf = 1 means add linefeed if not pressent - ''' - - if self.validate_flags: - self._validate_flag( flag ) - - if not self.is_active(flag): - return - if prefix: - pre = prefix - else: - pre = self.prefix - if sufix: - suf = sufix - else: - suf = self.sufix - - if self.time_stamp == 2: - output = '%s%s ' % ( pre, - time.strftime('%b %d %H:%M:%S', - time.localtime(time.time() )), - ) - elif self.time_stamp == 1: - output = '%s %s' % ( time.strftime('%b %d %H:%M:%S', - time.localtime(time.time() )), - pre, - ) - else: - output = pre - - if self.flag_show: - if flag: - output = '%s%s%s' % ( output, flag, self.flag_show ) - else: - # this call uses the global default, - # dont print "None", just show the separator - output = '%s %s' % ( output, self.flag_show ) - - output = '%s%s%s' % ( output, msg, suf ) - if lf: - # strip/add lf if needed - last_char = output[-1] - if lf == 1 and last_char != LINE_FEED: - output = output + LINE_FEED - elif lf == -1 and last_char == LINE_FEED: - output = output[:-1] - try: - self._fh.write( output ) - except Exception: - # unicode strikes again ;) - s=u'' - for i in range(len(output)): - if ord(output[i]) < 128: - c = output[i] - else: - c = '?' - s=s+c - self._fh.write( '%s%s%s' % ( pre, s, suf )) - self._fh.flush() - - def active_set( self, active_flags = None ): - "returns 1 if any flags where actually set, otherwise 0." - r = 0 - ok_flags = [] - if not active_flags: - #no debuging at all - self.active = [] - elif isinstance(active_flags, (tuple, list)): - flags = self._as_one_list( active_flags ) - for t in flags: - if t not in self.debug_flags: - print 'Invalid debugflag given', t - ok_flags.append( t ) - - self.active = ok_flags - r = 1 - else: - # assume comma string - try: - flags = active_flags.split(',') - except Exception: - self.show( '***' ) - self.show( '*** Invalid debug param given: %s' % active_flags ) - self.show( '*** please correct your param!' ) - self.show( '*** due to this, full debuging is enabled' ) - self.active = self.debug_flags - - for f in flags: - s = f.strip() - ok_flags.append( s ) - self.active = ok_flags - - self._remove_dupe_flags() - return r - - def active_get( self ): - "returns currently active flags." - return self.active - - - def _as_one_list( self, items ): - ''' init param might contain nested lists, typically from group flags. - - This code organises lst and remves dupes - ''' - if not isinstance(items, (list, tuple)): - return [ items ] - r = [] - for l in items: - if isinstance(l, list): - lst2 = self._as_one_list( l ) - for l2 in lst2: - self._append_unique_str(r, l2 ) - elif l is None: - continue - else: - self._append_unique_str(r, l ) - return r - - - def _append_unique_str( self, lst, item ): - '''filter out any dupes.''' - if not isinstance(item, str): - msg2 = '%s' % item - raise Exception('Invalid item type "%s", should be string' % \ - type(item)) - if item not in lst: - lst.append( item ) - return lst - - - def _validate_flag( self, flags ): - 'verify that flag is defined.' - if flags: - for f in self._as_one_list( flags ): - if not f in self.debug_flags: - msg2 = '%s' % f - raise Exception('Invalid debugflag "%s" given' % f) - - def _remove_dupe_flags( self ): - ''' - if multiple instances of Debug is used in same app, - some flags might be created multiple time, filter out dupes - ''' - unique_flags = [] - for f in self.debug_flags: - if f not in unique_flags: - unique_flags.append(f) - self.debug_flags = unique_flags - - colors={} - def Show(self, flag, msg, prefix=''): - msg=str(msg) - msg=msg.replace('\r','\\r').replace('\n','\\n').replace('><','>\n <') - if not colors_enabled: pass - elif prefix in self.colors: msg=self.colors[prefix]+msg+color_none - else: msg=color_none+msg - if not colors_enabled: prefixcolor='' - elif flag in self.colors: prefixcolor=self.colors[flag] - else: prefixcolor=color_none - - if prefix=='error': - _exception = sys.exc_info() - if _exception[0]: - msg=msg+'\n'+''.join(traceback.format_exception(_exception[0], _exception[1], _exception[2])).rstrip() - - prefix= self.prefix+prefixcolor+(flag+' '*12)[:12]+' '+(prefix+' '*6)[:6] - self.show(msg, flag, prefix) - - def is_active( self, flag ): - if not self.active: return 0 - if not flag or ((flag in self.active) ^ (DBG_ALWAYS in self.active)) : return 1 - return 0 - -DBG_ALWAYS='always' - -##Uncomment this to effectively disable all debugging and all debugging overhead. -#Debug=NoDebug - -# vim: se ts=3:

1 0

Jump to page:

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Commits December 2008