Context Navigation

pykoticon @ 172

Revision 172, 20.4 kB (checked in by jerome, 18 years ago)
Fixed focus problem.
Property svn:keywords set to `Id`

Rev	Line
[47]	1	#! /usr/bin/env python
	2	# -- coding: ISO-8859-15 --
	3
[119]	4	"""PyKotIcon is a generic, networked, cross-platform dialog box manager."""
	5
[138]	6	# PyKotIcon - Client side helper for PyKota and other applications
[47]	7	#
[89]	8	# (c) 2003, 2004, 2005, 2006 Jerome Alet <alet@librelogiciel.com>
[47]	9	# This program is free software; you can redistribute it and/or modify
	10	# it under the terms of the GNU General Public License as published by
	11	# the Free Software Foundation; either version 2 of the License, or
	12	# (at your option) any later version.
	13	#
	14	# This program is distributed in the hope that it will be useful,
	15	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	# GNU General Public License for more details.
	18	#
	19	# You should have received a copy of the GNU General Public License
	20	# along with this program; if not, write to the Free Software
	21	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
	22	#
	23	#
	24
[167]	25	__version__ = "1.03"
[119]	26	__author__ = "Jerome Alet"
	27	__author_email__ = "alet@librelogiciel.com"
	28	__license__ = "GNU GPL"
[137]	29	__url__ = "http://www.pykota.com/software/pykoticon"
[119]	30	__revision__ = "$Id$"
	31
[47]	32	import sys
[63]	33	import os
[119]	34	import time
[47]	35	import urllib
	36	import urllib2
[65]	37	import locale
	38	import gettext
[87]	39	import socket
	40	import threading
[88]	41	import xmlrpclib
[87]	42	import SimpleXMLRPCServer
[123]	43	try :
	44	import optparse
	45	except ImportError :
	46	sys.stderr.write("You need Python v2.3 or higher for PyKotIcon to work.\nAborted.\n")
	47	sys.exit(-1)
[47]	48
[65]	49	if sys.platform == "win32" :
[119]	50	isWindows = True
[65]	51	try :
	52	import win32api
	53	except ImportError :
	54	raise ImportError, "Mark Hammond's Win32 Extensions are missing. Please install them."
[76]	55	else :
[85]	56	iconsdir = os.path.split(sys.argv[0])[0]
[65]	57	else :
[119]	58	isWindows = False
[76]	59	iconsdir = "/usr/share/pykoticon" # TODO : change this
[65]	60	import pwd
[57]	61
[58]	62	try :
	63	import wx
[119]	64	hasWxPython = True
[58]	65	except ImportError :
[119]	66	hasWxPython = False
[75]	67	raise ImportError, "wxPython is missing. Please install it."
[58]	68
[119]	69	aboutbox = """PyKotIcon v%(__version__)s (c) 2003-2006 %(__author__)s - %(__author_email__)s
[111]	70
[119]	71	PyKotIcon is generic, networked, cross-platform dialog box manager.
	72
	73	It is often used as a client side companion for PyKota, but it
[111]	74	can be used from other applications if you want.
	75
	76	This program is free software; you can redistribute it and/or modify
	77	it under the terms of the GNU General Public License as published by
	78	the Free Software Foundation; either version 2 of the License, or
	79	(at your option) any later version.
	80
	81	This program is distributed in the hope that it will be useful,
	82	but WITHOUT ANY WARRANTY; without even the implied warranty of
	83	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	84	GNU General Public License for more details.
	85
	86	You should have received a copy of the GNU General Public License
	87	along with this program; if not, write to the Free Software
	88	Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA."""
	89
[65]	90
[87]	91	class MyXMLRPCServer(SimpleXMLRPCServer.SimpleXMLRPCServer) :
	92	"""My own server class."""
[88]	93	allow_reuse_address = True
[123]	94	def __init__(self, frame, options, arguments) :
[122]	95	SimpleXMLRPCServer.SimpleXMLRPCServer.__init__(self, \
[123]	96	('0.0.0.0', options.port), \
[122]	97	SimpleXMLRPCServer.SimpleXMLRPCRequestHandler, \
[123]	98	options.debug)
[87]	99	self.frame = frame
[123]	100	self.debug = options.debug
[146]	101	self.cacheduration = options.cache
	102	self.cache = {}
[123]	103	self.printServers = [ socket.gethostbyname(arg) for arg in arguments ]
[124]	104	if "127.0.0.1" not in self.printServers :
	105	self.printServers.append("127.0.0.1") # to allow clean shutdown
[87]	106	loop = threading.Thread(target=self.mainloop)
	107	loop.start()
[56]	108
[88]	109	def logDebug(self, message) :
	110	"""Logs a debug message if debug mode is active."""
	111	if self.debug :
	112	sys.stderr.write("%s\n" % message)
	113
[146]	114	def getAnswerFromCache(self, key) :
	115	"""Tries to extract a value from the cache and returns it if still valid."""
	116	cacheentry = self.cache.get(key)
	117	if cacheentry is not None :
	118	(birth, value) = cacheentry
	119	if (time.time() - birth) < self.cacheduration :
[147]	120	self.logDebug("Cache hit for %s" % str(key))
[146]	121	return value # NB : we don't extend the life of this entry
	122	else :
	123	self.logDebug("Cache expired for %s" % str(key))
	124	else :
	125	self.logDebug("Cache miss for %s" % str(key))
	126	return None
[55]	127
[146]	128	def storeAnswerInCache(self, key, value) :
	129	"""Stores an entry in the cache."""
	130	self.cache[key] = (time.time(), value)
[147]	131	self.logDebug("Cache store for %s" % str(key))
[146]	132
[103]	133	def export_askDatas(self, labels, varnames, varvalues) :
	134	"""Asks some textual datas defined by a list of labels, a list of variables' names and a list of variables values in a mapping."""
[107]	135	values = {}
[119]	136	for (key, value) in varvalues.items() :
	137	values[key] = self.frame.UTF8ToUserCharset(value.data)
[146]	138	cachekey = tuple(values.items())
	139	retcode = self.getAnswerFromCache(cachekey)
[154]	140	if (retcode is None) or (not retcode["isValid"]) :
[146]	141	wx.CallAfter(self.frame.askDatas, [ self.frame.UTF8ToUserCharset(label.data) for label in labels ], \
	142	varnames, \
	143	values)
	144	# ugly, isn't it ?
	145	while self.frame.dialogAnswer is None :
	146	time.sleep(0.1)
	147	retcode = self.frame.dialogAnswer
	148	for (key, value) in retcode.items() :
	149	if key != "isValid" :
	150	retcode[key] = xmlrpclib.Binary(self.frame.userCharsetToUTF8(value))
	151	self.frame.dialogAnswer = None # prepare for next call, just in case
	152	self.storeAnswerInCache(cachekey, retcode)
[105]	153	return retcode
[102]	154
[146]	155	def export_quitApplication(self) :
	156	"""Makes the application quit."""
	157	self.frame.quitEvent.set()
	158	wx.CallAfter(self.frame.OnClose, None)
	159	return True
	160
[100]	161	def export_showDialog(self, message, yesno) :
	162	"""Opens a notification or confirmation dialog."""
[112]	163	wx.CallAfter(self.frame.showDialog, self.frame.UTF8ToUserCharset(message.data), yesno)
[92]	164	# ugly, isn't it ?
[100]	165	while self.frame.dialogAnswer is None :
[97]	166	time.sleep(0.1)
[100]	167	retcode = self.frame.dialogAnswer
	168	self.frame.dialogAnswer = None # prepare for next call, just in case
[91]	169	return retcode
	170
[88]	171	def export_nop(self) :
	172	"""Does nothing, but allows a clean shutdown from the frame itself."""
	173	return True
	174
[138]	175	def _dispatch(self, method, params) :
	176	"""Ensure that only export_* methods are available."""
	177	return getattr(self, "export_%s" % method)(*params)
	178
	179	def handle_error(self, request, client_address) :
	180	"""Doesn't display an ugly traceback in case an error occurs."""
	181	self.logDebug("An exception occured while handling an incoming request from %s:%s" % (client_address[0], client_address[1]))
	182
[87]	183	def verify_request(self, request, client_address) :
	184	"""Ensures that requests which don't come from the print server are rejected."""
	185	(client, port) = client_address
[123]	186	if client in self.printServers :
[88]	187	self.logDebug("%s accepted." % client)
[87]	188	return True
	189	else :
	190	# Unauthorized access !
[88]	191	self.logDebug("%s rejected." % client)
[87]	192	return False
[55]	193
[87]	194	def mainloop(self) :
	195	"""XML-RPC Server's main loop."""
[102]	196	self.register_function(self.export_askDatas)
[100]	197	self.register_function(self.export_showDialog)
[87]	198	self.register_function(self.export_quitApplication)
[88]	199	self.register_function(self.export_nop)
[87]	200	while not self.frame.quitEvent.isSet() :
	201	self.handle_request()
[88]	202	self.server_close()
[87]	203	sys.exit(0)
[47]	204
[119]	205
[105]	206	class GenericInputDialog(wx.Dialog) :
[104]	207	"""Generic input dialog box."""
	208	def __init__(self, parent, id, labels, varnames, varvalues):
[105]	209	wx.Dialog.__init__(self, parent, id, \
[104]	210	_("PyKotIcon data input"), \
[105]	211	style = wx.CAPTION \
	212	\| wx.THICK_FRAME \
[104]	213	\| wx.STAY_ON_TOP \
[105]	214	\| wx.DIALOG_MODAL)
	215
[106]	216	self.variables = []
[104]	217	vsizer = wx.BoxSizer(wx.VERTICAL)
	218	for i in range(len(varnames)) :
	219	varname = varnames[i]
	220	try :
	221	label = labels[i]
	222	except IndexError :
	223	label = ""
	224	labelid = wx.NewId()
	225	varid = wx.NewId()
[136]	226	labelst = wx.StaticText(self, labelid, label)
[106]	227	if varname.lower().find("password") != -1 :
	228	variable = wx.TextCtrl(self, varid, varvalues.get(varname, ""), style=wx.TE_PASSWORD)
	229	else :
	230	variable = wx.TextCtrl(self, varid, varvalues.get(varname, ""))
	231	self.variables.append(variable)
[104]	232	hsizer = wx.BoxSizer(wx.HORIZONTAL)
[136]	233	hsizer.Add(labelst, 0, wx.ALIGN_CENTER \| wx.ALIGN_RIGHT \| wx.ALL, 5)
[104]	234	hsizer.Add(variable, 0, wx.ALIGN_CENTER \| wx.ALIGN_LEFT \| wx.ALL, 5)
	235	vsizer.Add(hsizer, 0, wx.ALIGN_CENTER \| wx.ALL, 5)
	236
[105]	237	okbutton = wx.Button(self, wx.ID_OK, "OK")
[104]	238	vsizer.Add(okbutton, 0, wx.ALIGN_CENTER \| wx.ALL, 5)
[172]	239	if self.variables :
	240	self.variables[0].SetFocus()
[104]	241	self.SetAutoLayout(True)
	242	self.SetSizerAndFit(vsizer)
	243	self.Layout()
[172]	244	self.Show(True)
	245	self.Raise()
[104]	246
[119]	247
[87]	248	class PyKotIcon(wx.Frame):
[63]	249	"""Main class."""
	250	def __init__(self, parent, id):
[100]	251	self.dialogAnswer = None
[104]	252	wx.Frame.__init__(self, parent, id, \
[119]	253	_("PyKotIcon info for %s") % self.getCurrentUserName(), \
[124]	254	size = (0, 0), \
[111]	255	style = wx.FRAME_NO_TASKBAR \| wx.NO_FULL_REPAINT_ON_RESIZE)
[114]	256
[119]	257	def getCurrentUserName(self) :
	258	"""Retrieves the current user's name."""
	259	if isWindows :
	260	return win32api.GetUserName()
	261	else :
	262	try :
	263	return pwd.getpwuid(os.geteuid())[0]
	264	except :
	265	return " Unknown "
	266
[59]	267	def OnIconify(self, event) :
[124]	268	"""Iconify/De-iconify the application."""
[104]	269	if not self.IsIconized() :
	270	self.Iconize(True)
[111]	271	self.Hide()
[58]	272
[59]	273	def OnTaskBarActivate(self, event) :
[124]	274	"""Show the application if it is minimized."""
[104]	275	if self.IsIconized() :
	276	self.Iconize(False)
[59]	277	if not self.IsShown() :
[58]	278	self.Show(True)
	279	self.Raise()
	280
[64]	281	def OnClose(self, event) :
[124]	282	"""Cleanly quit the application."""
[160]	283	if (event is None) \
	284	or self.options.allowquit :
[138]	285	self.closeServer()
	286	self.menu.Destroy()
	287	self.tbicon.Destroy()
	288	self.Destroy()
[160]	289	return True
[138]	290	else :
[160]	291	# self.quitIsForbidden()
	292	return False
[58]	293
[91]	294	def OnTaskBarMenu(self, event) :
[124]	295	"""Open the taskbar menu."""
[114]	296	self.tbicon.PopupMenu(self.menu)
[58]	297
[91]	298	def OnTaskBarClose(self, event) :
[124]	299	"""React to close from the taskbar."""
[160]	300	self.Close()
[124]	301
[127]	302	def quitIsForbidden(self) :
[124]	303	"""Displays a message indicating that quitting the application is not allowed."""
[138]	304	message = _("Sorry, this was forbidden by your system administrator.")
	305	caption = _("Information")
	306	style = wx.OK \| wx.ICON_INFORMATION \| wx.STAY_ON_TOP
	307	dialog = wx.MessageDialog(self, message, caption, style)
	308	dialog.ShowModal()
	309	dialog.Destroy()
[91]	310
[111]	311	def OnAbout(self, event) :
	312	"""Displays the about box."""
[128]	313	dialog = wx.MessageDialog(self, aboutbox % globals(), \
	314	_("About"), \
	315	wx.OK \| wx.ICON_INFORMATION)
[111]	316	dialog.ShowModal()
	317	dialog.Destroy()
	318
[100]	319	def showDialog(self, message, yesno) :
	320	"""Opens a notification dialog."""
	321	self.dialogAnswer = None
	322	if yesno :
	323	caption = _("Confirmation")
	324	style = wx.YES_NO \| wx.YES_DEFAULT \| wx.ICON_QUESTION
	325	else :
	326	caption = _("Information")
	327	style = wx.OK \| wx.ICON_INFORMATION
	328	style \|= wx.STAY_ON_TOP
	329	dialog = wx.MessageDialog(self, message, caption, style)
	330	self.dialogAnswer = ((dialog.ShowModal() == wx.ID_NO) and "CANCEL") or "OK"
	331	dialog.Destroy()
[91]	332
[103]	333	def askDatas(self, labels, varnames, varvalues) :
[102]	334	"""Opens a dialog box asking for data entry."""
[105]	335	self.dialogAnswer = None
	336	dialog = GenericInputDialog(self, wx.ID_ANY, labels, varnames, varvalues)
[106]	337	retvalues = {}
	338	if dialog.ShowModal() == wx.ID_OK :
	339	retvalues["isValid"] = True
	340	for i in range(len(varnames)) :
	341	retvalues[varnames[i]] = dialog.variables[i].GetValue()
	342	else :
	343	retvalues["isValid"] = False
	344	for k in varvalues.keys() :
	345	retvalues[k] = ""
	346	self.dialogAnswer = retvalues
[105]	347	dialog.Destroy()
[104]	348
	349	def closeServer(self) :
	350	"""Tells the xml-rpc server to exit."""
	351	if not self.quitEvent.isSet() :
	352	self.quitEvent.set()
[124]	353	server = xmlrpclib.ServerProxy("http://localhost:%s" % self.options.port)
[104]	354	try :
	355	# wake the server with an empty request
	356	# for it to see the event object
	357	# which has just been set
	358	server.nop()
	359	except :
	360	# Probably already stopped
	361	pass
	362
[123]	363	def postInit(self, charset, options, arguments) :
[104]	364	"""Starts the XML-RPC server."""
[112]	365	self.charset = charset
[124]	366	self.options = options
[160]	367
	368	self.tbicon = wx.TaskBarIcon()
	369	self.greenicon = wx.Icon(os.path.join(iconsdir, "pykoticon-green.ico"), \
	370	wx.BITMAP_TYPE_ICO)
	371	self.redicon = wx.Icon(os.path.join(iconsdir, "pykoticon-red.ico"), \
	372	wx.BITMAP_TYPE_ICO)
	373	self.tbicon.SetIcon(self.greenicon, "PyKotIcon")
	374
	375	wx.EVT_TASKBAR_LEFT_DCLICK(self.tbicon, self.OnTaskBarActivate)
	376	wx.EVT_TASKBAR_RIGHT_UP(self.tbicon, self.OnTaskBarMenu)
	377
	378	self.TBMENU_ABOUT = wx.NewId()
	379	self.TBMENU_RESTORE = wx.NewId()
	380	self.TBMENU_CLOSE = wx.NewId()
	381	wx.EVT_MENU(self.tbicon, self.TBMENU_ABOUT, \
	382	self.OnAbout)
	383	wx.EVT_MENU(self.tbicon, self.TBMENU_RESTORE, \
	384	self.OnTaskBarActivate)
	385	wx.EVT_MENU(self.tbicon, self.TBMENU_CLOSE, \
	386	self.OnTaskBarClose)
	387	self.menu = wx.Menu()
	388	self.menu.Append(self.TBMENU_ABOUT, _("About"), _("About this software"))
	389	if options.allowquit :
	390	self.menu.Append(self.TBMENU_CLOSE, _("Quit"), \
	391	_("Exit the application"))
	392	wx.EVT_ICONIZE(self, self.OnIconify)
	393	wx.EVT_CLOSE(self, self.OnClose)
	394	self.Show(True)
	395	self.Hide()
	396
	397	self.quitEvent = threading.Event()
[123]	398	self.server = MyXMLRPCServer(self, options, arguments)
[112]	399
	400	def UTF8ToUserCharset(self, text) :
	401	"""Converts from UTF-8 to user's charset."""
	402	if text is not None :
	403	try :
[119]	404	return text.decode("UTF-8").encode(self.charset, "replace")
	405	except (UnicodeError, AttributeError) :
[112]	406	try :
[119]	407	# Maybe already in Unicode
	408	return text.encode(self.charset, "replace")
	409	except (UnicodeError, AttributeError) :
	410	pass # Don't know what to do
[112]	411	return text
	412
	413	def userCharsetToUTF8(self, text) :
	414	"""Converts from user's charset to UTF-8."""
	415	if text is not None :
	416	try :
[119]	417	# We don't necessarily trust the default charset, because
	418	# xprint sends us titles in UTF-8 but CUPS gives us an ISO-8859-1 charset !
	419	# So we first try to see if the text is already in UTF-8 or not, and
	420	# if it is, we delete characters which can't be converted to the user's charset,
	421	# then convert back to UTF-8. PostgreSQL 7.3.x used to reject some unicode characters,
	422	# this is fixed by the ugly line below :
	423	return text.decode("UTF-8").encode(self.charset, "replace").decode(self.charset).encode("UTF-8", "replace")
	424	except (UnicodeError, AttributeError) :
[112]	425	try :
[119]	426	return text.decode(self.charset).encode("UTF-8", "replace")
	427	except (UnicodeError, AttributeError) :
[113]	428	try :
[119]	429	# Maybe already in Unicode
	430	return text.encode("UTF-8", "replace")
	431	except (UnicodeError, AttributeError) :
	432	pass # Don't know what to do
[112]	433	return text
[119]	434
[92]	435
[111]	436	class PyKotIconApp(wx.App):
[58]	437	def OnInit(self) :
[104]	438	self.frame = PyKotIcon(None, wx.ID_ANY)
[111]	439	self.frame.Show(False)
[114]	440	self.SetTopWindow(self.frame)
[58]	441	return True
	442
[123]	443	def postInit(self, charset, options, arguments) :
[81]	444	"""Continues processing."""
[123]	445	self.frame.postInit(charset, options, arguments)
[81]	446
[119]	447
[123]	448	def main() :
[63]	449	"""Program's entry point."""
[65]	450	try :
	451	locale.setlocale(locale.LC_ALL, "")
	452	except (locale.Error, IOError) :
	453	sys.stderr.write("Problem while setting locale.\n")
	454	try :
	455	gettext.install("pykoticon")
	456	except :
	457	gettext.NullTranslations().install()
[112]	458
	459	localecharset = None
	460	try :
	461	try :
	462	localecharset = locale.nl_langinfo(locale.CODESET)
	463	except AttributeError :
	464	try :
	465	localecharset = locale.getpreferredencoding()
	466	except AttributeError :
	467	try :
	468	localecharset = locale.getlocale()[1]
	469	localecharset = localecharset or locale.getdefaultlocale()[1]
	470	except ValueError :
	471	pass # Unknown locale, strange...
	472	except locale.Error :
	473	pass
	474	charset = os.environ.get("CHARSET") or localecharset or "ISO-8859-15"
	475
[170]	476	parser = optparse.OptionParser(usage="pykoticon [options] server1 [server2 ...]")
[123]	477	parser.add_option("-v", "--version",
	478	action="store_true",
	479	dest="version",
[146]	480	help=_("show PyKotIcon's version number and exit."))
	481	parser.add_option("-c", "--cache",
	482	type="int",
	483	default=0,
	484	dest="cache",
	485	help=_("the duration of the cache in seconds to keep input forms' datas in memory. Defaults to 0 second, meaning no cache."))
[123]	486	parser.add_option("-d", "--debug",
	487	action="store_true",
	488	dest="debug",
[146]	489	help=_("activate debug mode."))
[123]	490	parser.add_option("-p", "--port",
	491	type="int",
	492	default=7654,
	493	dest="port",
[146]	494	help=_("the TCP port PyKotIcon will listen to, default is 7654."))
[123]	495	parser.add_option("-q", "--allowquit",
	496	action="store_true",
	497	dest="allowquit",
[146]	498	help=_("allow the end user to close the application."))
[123]	499	(options, arguments) = parser.parse_args()
	500	if options.version :
	501	print "PyKotIcon v%(__version__)s" % globals()
	502	else :
[146]	503	if not (1024 <= options.port <= 65535) :
	504	sys.stderr.write(_("The TCP port number specified for --port must be between 1024 and 65535.\n"))
	505	elif not (0 <= options.cache <= 86400) :
	506	sys.stderr.write(_("The duration specified for --cache must be between 0 and 86400 seconds.\n"))
	507	else :
	508	app = PyKotIconApp()
	509	app.postInit(charset, options, arguments)
	510	app.MainLoop()
[63]	511
[119]	512
[58]	513	if __name__ == '__main__':
[123]	514	main()
	515

Note: See TracBrowser for help on using the browser.

Context Navigation

root / pykoticon / trunk / bin / pykoticon @ 172

Download in other formats: