all methods in class GajimRemote, added unrepr

and cleaner output for vcards

scripts/gajim-remote.py

@@ -36,10 +36,7 @@ import i18n
 _ = i18n._
 i18n.init()
 
-def send_error(error_message):
+
-	sys.stderr.write(error_message + '\n')
-	sys.stderr.flush()
-	sys.exit(1)
 
 try:
 	import dbus
@@ -55,15 +52,20 @@ OBJ_PATH = '/org/gajim/dbus/RemoteObject'
 INTERFACE = 'org.gajim.dbus.RemoteInterface'
 SERVICE = 'org.gajim.dbus'
 BASENAME = 'gajim-remote'
-# define commands dict. Prototype :
+
-# {
+class GajimRemote:
-#	'command': [comment, [list of arguments] ]
+	
-# }
+	def __init__(self):
-#
+		self.argv_len = len(sys.argv) 
-# each argument is defined as a tuple:
+		# define commands dict. Prototype :
-#    (argument name, help on argument, is mandatory)
+		# {
-#
+		#	'command': [comment, [list of arguments] ]
-commands = {
+		# }
+		#
+		# each argument is defined as a tuple:
+		#    (argument name, help on argument, is mandatory)
+		#
+		self.commands = {
 			'help':[
 					_('show a help on specific command'),
 					[
@@ -82,8 +84,8 @@ commands = {
 					_('Print a list of all contacts in the roster. \
 Each contact appear on a separate line'),
 					[
-				(_('account'), _('show only contacts of the given account'),
+						(_('account'), _('show only contacts of the \
-					False)
+given account'), False)
 					]
 					
 				],	
@@ -92,33 +94,39 @@ Each contact appear on a separate line'),
 					[]
 				], 
 			'change_status': [
-			_('Change '),
+					_('Change the status of account or accounts'),
 					[
-				(_('status'), _('one of: offline, online, chat, \
+						(_('status'), _('one of: offline, online, chat, away, \
-away, xa, dnd, invisible '), True), 
+xa, dnd, invisible '), True), 
 						(_('message'), _('status message'), False), 
-				(_('account'), _('change status of the account "accounts". \
+						(_('account'), _('change status of account "account". \
 If not specified try to change status of all accounts that \
 have "sync with global status" option set'), False)
 					]
 				],
 			'open_chat': [ 
-			_('Show the chat dialog so that you can send message to a contact'), 
+					_('Show the chat dialog so that you can send message to a \
+contact'), 
 					[
-				('jid', _('jid of the contact that you want to chat with'),
+						('jid', _('jid of the contact that you want to chat \
+with'),
 							True), 
-				(_('account'), _('if specified contact is taken from the contact \
+						(_('account'), _('if specified contact is taken from \
-list of this account'), False)
+the contact list of this account'), False)
 					]
 				],
 			'send_message':[
-			_('Send new message to a contact in the roster. Both pgp key and account are optional. If you want to set only \'account\', whitout \'pgp key\', just set \'pgp key\' to \'\'.'), 
+					_('Send new message to a contact in the roster. Both pgp \
+key and account are optional. If you want to set only \'account\', whitout \
+\'pgp key\', just set \'pgp key\' to \'\'.'), 
 					[
-				('jid', _('jid of the contact that will receive the message'), True),
+						('jid', _('jid of the contact that will receive the \
+message'), True),
 						(_('message'), _('message contents'), True),
-				(_('pgp key'), _('if specified the message will be encrypted using \
+						(_('pgp key'), _('if specified the message will be \
-this pulic key'), False),
+encrypted using this pulic key'), False),
-				(_('account'), _('if specified the message will be sent using this account'), False),
+						(_('account'), _('if specified the message will be \
+sent using this account'), False),
 					]
 				], 
 			'contact_info': [
@@ -128,9 +136,68 @@ this pulic key'), False),
 					]
 				]
 			}
+		if self.argv_len  < 2 or \
+			sys.argv[1] not in self.commands.keys(): # no args or bad args
+			self.send_error(self.compose_help())
+		self.command = sys.argv[1]
 		
+		if self.command == 'help':
+			if self.argv_len == 3:
+				print self.help_on_command(sys.argv[2])
+			else:
+				print self.compose_help()
+			sys.exit()
 		
-def make_arguments_row(args):
+		try:
+			self.sbus = dbus.SessionBus()
+		except:
+			self.send_error(_('Session bus is not available.'))
+		
+		if _version[1] >= 30 and _version[1] <= 42:
+			self.object = self.sbus.get_object(SERVICE, OBJ_PATH)
+			self.interface = dbus.Interface(object, INTERFACE)
+		elif _version[1] < 30:
+			self.service = self.sbus.get_service(SERVICE)
+			self.interface = self.service.get_object(OBJ_PATH, INTERFACE)
+		else:
+			send_error(_('Unknow dbus version: %s') % _version)
+		# get the function asked
+		self.method = self.interface.__getattr__(self.command) 
+		
+		self.check_arguments()
+		if self.command == 'contact_info':
+			if self.argv_len < 3:
+				self.send_error(_('Missing argument "contact_jid"'))
+			try:
+				id = self.sbus.add_signal_receiver(self.show_vcard_info, 
+					'VcardInfo', INTERFACE, SERVICE, OBJ_PATH)
+			except:
+				self.send_error(_('Service not available'))
+		
+		res = self.call_remote_method()
+		
+		if res is not None:
+			if self.command in ['open_chat', 'send_message']:
+				if self.command == 'send_message':
+					self.argv_len -= 2
+				
+				if res == False:
+					if self.argv_len < 4:
+						self.send_error(_('\'%s\' is not in your roster.\n\
+Please specify account for sending the message.') % sys.argv[2])
+					else:
+						self.send_error(_('You have no active account'))
+			elif self.command == 'list_accounts':
+				if type(res) == list:
+					for account in res:
+						print account
+			elif res:
+				print res
+		if self.command == 'contact_info':
+			gobject.timeout_add(5000, self.gtk_quit) # wait 5 sec maximum
+			gtk.main()
+		
+	def make_arguments_row(self, args):
 		''' return arguments list. Mandatory arguments are enclosed with:
 		'<', '>', optional arguments - with '[', ']' '''
 		str = ''
@@ -147,23 +214,25 @@ def make_arguments_row(args):
 				str += ']'
 		return str
 		
-def help_on_command(command):
+	def help_on_command(self, command):
 		''' return help message for a given command '''
-	if command in commands:
+		if command in self.commands:
+			command_props = self.commands[command]
+			arguments_str = self.make_arguments_row(command_props[1])
 			str = _('Usage: %s %s %s \n\t') % (BASENAME, command, 
-			make_arguments_row(commands[command][1]))
+					arguments_str)
-		str += commands[command][0] + '\n\nArguments:\n'
+			str += command_props[0] + '\n\nArguments:\n'
-		for argument in commands[command][1]:
+			for argument in command_props[1]:
 				str += ' ' +  argument[0] + ' - ' + argument[1] + '\n'
 			return str
-	send_error(_(' %s not found') % command)
+		self.send_error(_(' %s not found') % command)
 			
-def compose_help():
+	def compose_help(self):
 		''' print usage, and list available commands '''
 		str = _('Usage: %s command [arguments]\nCommand is one of:\n' ) % BASENAME
-	for command in commands.keys():
+		for command in self.commands.keys():
 			str += '  ' + command 
-		for argument in commands[command][1]:
+			for argument in self.commands[command][1]:
 				str += ' '
 				if argument[2]:
 					str += '<'
@@ -177,115 +246,183 @@ def compose_help():
 			str += '\n'
 		return str
 		
-def show_vcard_info(*args, **keyword):
+	def print_info(self, level, prop_dict):
-	# FIXME: more cleaner output
+		''' return formated string from serialized vcard data '''
+		if prop_dict is None:
+			return ''
+		ret_str = ''
+		for key in prop_dict.keys():
+			val = prop_dict[key]
+			spacing = ' ' * level * 4
+			if type(val) == unicode or type(val) == int or \
+				type(val) == str:
+				if val is not None:
+					val = val.strip()
+					ret_str += '%s%-10s: %s\n' % (spacing, key, val)
+			elif type(val) == list or type(val) == tuple:
+				res = ''
+				for items in val:
+					res += self.print_info(level+1, items)
+				if res != '':
+					ret_str += '%s%s: \n%s' % (spacing, key, res)
+			elif type(val) == dict:
+				res = self.print_info(level+1, val)
+				if res != '':
+					ret_str += '%s%s: \n%s' % (spacing, key, res)
+			else:
+				self.send_warning(_('Unknown type %s ') % type(val))
+		return ret_str
+		
+	def unrepr(self, serialized_data):
+		''' works the same as eval, but only for structural values, 
+		not functions! e.g. dicts, lists, strings, tuples '''
+		if not serialized_data:
+			return (None, '') 
+		value = serialized_data.strip()
+		first_char = value[0]
+		is_unicode  = False
+		if first_char == 'u':
+			is_unicode = True
+			value = value[1:]
+			first_char = value[0]
+		if first_char == "'" or first_char == '"': # handle strings and unicode
+			if len(value) < 2:
+				return ('',value[1:])
+			_str = ''
+			previous_slash = False
+			for i in range(len(value) - 1):
+				chr = value[i+1]
+				if previous_slash:
+					previous_slash = False
+					if chr == '\\':
+						_str += '\\'
+					elif chr == 'n':
+						_str += '\n'
+					elif chr == 't':
+						_str += '\t'
+					elif chr == 'r':
+						_str += '\r'
+					elif chr == 'b':
+						_str += '\b'
+					elif chr == '\'':
+						_str += '\''
+					elif chr == '\"':
+						_str += '\"'
+					elif chr == 'u' and is_unicode:
+						_str += '\\u'
+				elif chr == first_char:
+					break
+				elif chr == '\\':
+					previous_slash = True
+				else:
+					_str += chr
+			substr_len = len(_str)+2
+			if is_unicode and _str:
+				_str = _str.decode('unicode-escape').encode('utf-8')
+			return (_str, value[substr_len :])
+		elif first_char == '{': # dict
+			_dict = {}
+			while True:
+				if value[1] == '}':
+					break
+				key, next = self.unrepr(value[1:])
+				if type(key) != str and type(key) != unicode:
+					send_error('Wrong string: %s' % value)
+				next = next.strip()
+				if not next or next[0] != ':':
+					send_error('Wrong string: %s' % (value))
+				val, next = self.unrepr(next[1:])
+				_dict[key] = val
+				next = next.strip()
+				if not next:
+					break
+				if next[0] == ',':
+					value = next
+				elif next[0] == '}':
+					break
+				else:
+					break
+			return (_dict, next[1:])
+		elif first_char in ['[', '(']: # return list 
+			_tuple = []
+			while True:
+				if value[1] == ']':
+					break
+				val, next = self.unrepr(value[1:])
+				next = next.strip()
+				if not next:
+					send_error('Wrong string: %s' % val)
+				_tuple.append(val)
+				next = next.strip()
+				if not next:
+					break
+				if next[0] == ',':
+					value = next
+				elif next[0] in [']', ')']:
+					break
+			return (_tuple, next[1:])
+		
+	def show_vcard_info(self, *args, **keyword):
+		''' write user vcart in a formated output '''
+		props_dict = None
 		if _version[1] >= 30:
-		print args[0]
+			props_dict = self.unrepr(args[0])
 		else:
 			if args and len(args) >= 5:
-			print args[4].get_args_list()
+				props_dict = self.unrepr(args[4].get_args_list()[0])
 
+		if props_dict:
+			print self.print_info(0,props_dict[0])
 		# remove_signal_receiver is broken in lower versions (< 0.35), 
 		# so we leave the leak - nothing can be done
 		if _version[1] >= 41:
-		sbus.remove_signal_receiver(show_vcard_info, 'VcardInfo', INTERFACE, 
+			self.sbus.remove_signal_receiver(show_vcard_info, 'VcardInfo', 
-			SERVICE, OBJ_PATH)
+				INTERFACE, SERVICE, OBJ_PATH)
 	
 		gtk.main_quit()
 		
-def check_arguments(command):
+	def check_arguments(self):
 		''' Make check if all necessary arguments are given '''
-	argv_len = len(sys.argv) - 2
+		argv_len = self.argv_len - 2
-	args = commands[command][1]
+		args = self.commands[self.command][1]
 		if len(args) > argv_len:
 			if args[argv_len][2]:
-			send_error(_('Argument "%s" is not specified. \n\
+				self.send_error(_('Argument "%s" is not specified. \n\
-Type "%s help %s" for more info') % \
+Type "%s help %s" for more info') % (args[argv_len][0], BASENAME, self.command))
-			(args[argv_len][0], BASENAME, command))
 
-def gtk_quit():
+	def gtk_quit(self):
 		if _version[1] >= 41:
-		sbus.remove_signal_receiver(show_vcard_info, 'VcardInfo', INTERFACE, 
+			self.sbus.remove_signal_receiver(show_vcard_info, 'VcardInfo', 
-			SERVICE, OBJ_PATH)
+				INTERFACE, SERVICE, OBJ_PATH)
 		gtk.main_quit()
 	
-#FIXME - didn't find more clever way for the below 8 lines of code.
+	# FIXME - didn't find more clever way for the below method.
-# method(sys.argv[2:]) doesn't work, cos sys.argv[2:] is a tuple
+	# method(sys.argv[2:]) doesn't work, cos sys.argv[2:] is a tuple
-def call_remote_method(method):
+	def call_remote_method(self):
-	argv_len = len(sys.argv)
+		''' calls self.method with arguments from sys.argv[2:] '''
 		try:
-		if argv_len == 2:
+			if self.argv_len == 2:
-			res = method()
+				res = self.method()
-		elif argv_len == 3:
+			elif self.argv_len == 3:
-			res = method(sys.argv[2])
+				res = self.method(sys.argv[2])
-		elif argv_len == 4:
+			elif self.argv_len == 4:
-			res = method(sys.argv[2], sys.argv[3])
+				res = self.method(sys.argv[2], sys.argv[3])
-		elif argv_len == 5:
+			elif self.argv_len == 5:
-			res = method(sys.argv[2], sys.argv[3], sys.argv[4])
+				res = self.method(sys.argv[2], sys.argv[3], sys.argv[4])
 			elif argv_len == 6:
-			res = method(sys.argv[2], sys.argv[3], sys.argv[4], sys.argv[5])
+				res = self.method(sys.argv[2], sys.argv[3], sys.argv[4], 
+					sys.argv[5])
 			return res
 		except:
-		send_error(_('Service not available'))
+			self.send_error(_('Service not available'))
 		return None
 
+	def send_error(self, error_message):
+		'''  Writes error message to stderr and exits '''
+		sys.stderr.write(error_message + '\n')
+		sys.stderr.flush()
+		sys.exit(1)
 
-argv_len = len(sys.argv) 
+if __name__ == '__main__':
-
+	GajimRemote()
-if argv_len  < 2 or sys.argv[1] not in commands.keys(): # no args or bad args
+	pass
-	send_error(compose_help())
-
-command = sys.argv[1]
-
-if command == 'help':
-	if argv_len == 3:
-		print help_on_command(sys.argv[2])
-	else:
-		print compose_help()
-	sys.exit()
-
-try:
-	sbus = dbus.SessionBus()
-except:
-	send_error(_('Session bus is not available.\n'))
-
-
-if _version[1] >= 30 and _version[1] <= 42:
-	object = sbus.get_object(SERVICE, OBJ_PATH)
-	interface = dbus.Interface(object, INTERFACE)
-elif _version[1] < 30:
-	service = sbus.get_service(SERVICE)
-	interface = service.get_object(OBJ_PATH, INTERFACE)
-else:
-	send_error(_('Unknow dbus version: %s') % _version)
-
-method = interface.__getattr__(sys.argv[1]) # get the function asked
-
-check_arguments(command)
-if command == 'contact_info':
-	if argv_len < 3:
-		send_error(_('Missing argument "contact_jid"'))
-	try:
-		id = sbus.add_signal_receiver(show_vcard_info, 'VcardInfo', 
-			INTERFACE, SERVICE, OBJ_PATH)
-	except:
-		send_error(_('Service not available'))
-
-res = call_remote_method(method)
-
-if res is not None:
-	if command in ['open_chat', 'send_message']:
-		if command == 'send_message':
-			argv_len -= 2
-		
-		if res == False:
-			if argv_len < 4:
-				send_error(_('\'%s\' is not in your roster.\n\
-Please specify account for sending the message.') % sys.argv[2])
-			else:
-				send_error(_('You have no active account'))
-	elif res:
-		print res
-if command == 'contact_info':
-	gobject.timeout_add(5000, gtk_quit) # wait 5 sec maximum
-	gtk.main()