Thread: SF.net SVN: fclient: [538] trunk/fclient/src/fclient

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 538
          http://fclient.svn.sourceforge.net/fclient/?rev=538&view=rev
Author:   jUrner
Date:     2008-07-07 14:32:00 -0700 (Mon, 07 Jul 2008)

Log Message:
-----------
added lib

Added Paths:
-----------
    trunk/fclient/src/fclient/lib/
    trunk/fclient/src/fclient/lib/__init__.py
    trunk/fclient/src/fclient/lib/fcp2/
    trunk/fclient/src/fclient/lib/fcp2/LICENCE.MIT
    trunk/fclient/src/fclient/lib/fcp2/README
    trunk/fclient/src/fclient/lib/fcp2/__init__.py
    trunk/fclient/src/fclient/lib/fcp2/client.py
    trunk/fclient/src/fclient/lib/fcp2/config.py
    trunk/fclient/src/fclient/lib/fcp2/consts.py
    trunk/fclient/src/fclient/lib/fcp2/events.py
    trunk/fclient/src/fclient/lib/fcp2/iohandler.py
    trunk/fclient/src/fclient/lib/fcp2/key.py
    trunk/fclient/src/fclient/lib/fcp2/lib/
    trunk/fclient/src/fclient/lib/fcp2/lib/__init__.py
    trunk/fclient/src/fclient/lib/fcp2/lib/events.py
    trunk/fclient/src/fclient/lib/fcp2/lib/namespace.py
    trunk/fclient/src/fclient/lib/fcp2/lib/node.py
    trunk/fclient/src/fclient/lib/fcp2/lib/numbers.py
    trunk/fclient/src/fclient/lib/fcp2/lib/tools.py
    trunk/fclient/src/fclient/lib/fcp2/message.py
    trunk/fclient/src/fclient/lib/fcp2/scripts/
    trunk/fclient/src/fclient/lib/fcp2/scripts/__init__.py
    trunk/fclient/src/fclient/lib/fcp2/scripts/gen_docs.py
    trunk/fclient/src/fclient/lib/fcp2/scripts/gen_messagecheatsheet.py
    trunk/fclient/src/fclient/lib/fcp2/test/
    trunk/fclient/src/fclient/lib/fcp2/test/__init__.py
    trunk/fclient/src/fclient/lib/fcp2/test/dummy_io.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_all.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_client.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_config.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_iohandler.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_key.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_message.py
    trunk/fclient/src/fclient/lib/fcp2/test/test_types.py
    trunk/fclient/src/fclient/lib/fcp2/types.py
    trunk/fclient/src/fclient/lib/qt4ex/
    trunk/fclient/src/fclient/lib/qt4ex/LICENCE.MIT
    trunk/fclient/src/fclient/lib/qt4ex/README
    trunk/fclient/src/fclient/lib/qt4ex/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/assistant.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/areatips.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/checkarraywrap.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/colorbutton.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/compactpatwrap.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/dragtool.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/editboxwrap.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/labelwrap.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/mrumenu.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/tablewidget.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/toolbarwrap.py
    trunk/fclient/src/fclient/lib/qt4ex/ctrls/treewidgetwrap.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgabout/
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgabout/DlgAbout.ui
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgabout/Ui_DlgAbout.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgabout/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgfindreplace/
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgfindreplace/DlgFindReplace.ui
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgfindreplace/Ui_DlgFindReplace.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgfindreplace/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgpreferences/
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgpreferences/DlgPreferencesTree.ui
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgpreferences/Ui_DlgPreferencesTree.py
    trunk/fclient/src/fclient/lib/qt4ex/dlgs/dlgpreferences/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/lang/
    trunk/fclient/src/fclient/lib/qt4ex/lang/qt4ex_de.ts
    trunk/fclient/src/fclient/lib/qt4ex/lang/qt4ex_en.ts
    trunk/fclient/src/fclient/lib/qt4ex/language.py
    trunk/fclient/src/fclient/lib/qt4ex/qt4ex.pro
    trunk/fclient/src/fclient/lib/qt4ex/qtools.py
    trunk/fclient/src/fclient/lib/qt4ex/res/
    trunk/fclient/src/fclient/lib/qt4ex/res/language/
    trunk/fclient/src/fclient/lib/qt4ex/res/language/LangCodes-ISO 639-1.txt
    trunk/fclient/src/fclient/lib/qt4ex/resources.py
    trunk/fclient/src/fclient/lib/qt4ex/scripts/
    trunk/fclient/src/fclient/lib/qt4ex/scripts/__init__.py
    trunk/fclient/src/fclient/lib/qt4ex/scripts/manifest.py
    trunk/fclient/src/fclient/lib/qt4ex/scripts/pylupdate.py
    trunk/fclient/src/fclient/lib/qt4ex/scripts/qtpro.py
    trunk/fclient/src/fclient/lib/qt4ex/settingsbase.py

Added: trunk/fclient/src/fclient/lib/__init__.py
===================================================================

--- trunk/fclient/src/fclient/lib/__init__.py	                        (rev 0)
+++ trunk/fclient/src/fclient/lib/__init__.py	2008-07-07 21:32:00 UTC (rev 538)
@@ -0,0 +1 @@
+ 

Added: trunk/fclient/src/fclient/lib/fcp2/LICENCE.MIT
===================================================================
--- trunk/fclient/src/fclient/lib/fcp2/LICENCE.MIT	                        (rev 0)
+++ trunk/fclient/src/fclient/lib/fcp2/LICENCE.MIT	2008-07-07 21:32:00 UTC (rev 538)
@@ -0,0 +1,20 @@
+ Fcp2 - a python wraper library for the freenet client protocol version 2. See: [http://www.freenetproject.org]
+
+Copyright (c) 2008 J\xFCrgen Urner
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
+and associated documentation files (the "Software"), to deal in the Software without restriction, 
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial 
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT 
+OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
+OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file

Added: trunk/fclient/src/fclient/lib/fcp2/README
===================================================================
--- trunk/fclient/src/fclient/lib/fcp2/README	                        (rev 0)
+++ trunk/fclient/src/fclient/lib/fcp2/README	2008-07-07 21:32:00 UTC (rev 538)
@@ -0,0 +1,30 @@
+Fcp - a python wraper library for the freenet client protocol version 2
+
+homepage: [http://fclient.sourceforge.net]
+freenet: [http://www.freenetproject.org]
+
+
+requirements: python >= 2.5
+
+note: for one or the other reason the package is designed to be dropped into 
+any project or to be used directly from the folder it resides in. no need to install it 
+to 'lib/site-packages'. if you want to do so, make shure to remove any prior
+fcp2 package and copy it to site-packages by hand.
+
+
+
+Version history:
+
+*******************************************************************
+0.0.1
+*******************************************************************
+(07.06.08) first alpha release for testing
+
+news:
+
+	x. 
+		
+bugfixes:
+	
+	x.
+

Added: trunk/fclient/src/fclient/lib/fcp2/__init__.py
===================================================================
--- trunk/fclient/src/fclient/lib/fcp2/__init__.py	                        (rev 0)
+++ trunk/fclient/src/fclient/lib/fcp2/__init__.py	2008-07-07 21:32:00 UTC (rev 538)
@@ -0,0 +1,50 @@
+"""Python wrapper for the freenet client protocol version-2
+
+See: [http://www.freenetproject.org] and [http://wiki.freenetproject.org/FreenetFCPSpec2Point0]
+
+@requires: python >= 2.5
+"""
+from __future__ import absolute_import
+if __name__ == '__main__':	# see --> http://bugs.python.org/issue1510172 . works only current dir and below
+	import os; __path__ = [os.path.dirname(__file__)]
+	
+__author__ = 'Juergen Urner'
+__copyright__ = '(c) 2008 - Juergen Urner'
+__email__ = 'jue...@ar...'
+__licence__ = 'Mit'
+__version__ = '0.0.1'
+
+from .client import Client
+from .config import (Config, ConfigDataType, ConfigItem, ConfigKeySep, ConfigValueClass)
+from .consts import (ConstByteAmountPostfix, ConstConnectReason, ConstDebugVerbosity, ConstDisconnectReason, 
+									ConstFetchError, ConstFilenameCollision, ConstInsertError, ConstKeyType, ConstLogMessages, 
+									ConstLogger, ConstMessage, ConstPeerNodeStatus, ConstPeerNoteType, ConstPersistence, 
+									ConstPriority, ConstProtocolError, ConstPutDirType, ConstRequestModified, ConstRequestStatus, 
+									ConstRequestType, ConstReturnType, ConstTimeDeltaPostfix, ConstUploadFrom, ConstVerbosity, 
+									Error, ErrorIOBroken, ErrorIOClosed, ErrorIOConnectFailed, ErrorIOTimeout, ErrorMessageParse, 
+									FcpFalse, FcpTrue)
+from .key import (Key, KeyCHK, KeyKSK, KeySSK, KeyTypesAll, KeyUSK, TypeKey, base64UrlsaveDecode, keyNormkey)
+from .message import (MessagesAll, MsgAddPeer, MsgAllData, MsgClientDisconnected, MsgClientGet, MsgClientHello, 
+										MsgClientPut, MsgClientPutComplexDir, MsgClientPutDiskDir, MsgClientSocketDied, 
+										MsgClientSocketTimeout, MsgCloseConnectionDuplicateClientName, MsgConfigData, MsgDataFound, 
+										MsgEndListPeerNotes, MsgEndListPeers, MsgEndListPersistentRequests, MsgFCPPluginMessage, 
+										MsgFCPPluginReply, MsgFinishedCompression, MsgGenerateSSK, MsgGetConfig, MsgGetFailed, 
+										MsgGetNode, MsgGetPluginInfo, MsgGetRequestStatus, MsgIdentifierCollision, MsgListPeer, 
+										MsgListPeerNotes, MsgListPeers, MsgListPersistentRequests, MsgModifyConfig, MsgModifyPeer, 
+										MsgModifyPeerNote, MsgModifyPersistentRequest, MsgNodeData, MsgNodeHello, MsgPeer, MsgPeerNote, 
+										MsgPeerRemoved, MsgPersistentGet, MsgPersistentPut, MsgPersistentPutDir, MsgPersistentRequestModified,
+										MsgPersistentRequestRemoved, MsgPluginInfo, MsgProtocolError, MsgPutFailed, MsgPutFetchable, 
+										MsgPutSuccessful, MsgRemovePeer, MsgRemoveRequest, MsgSSKKeypair, MsgShutdown, MsgSimpleProgress, 
+										MsgStartedCompression, MsgSubscribeUSK, MsgSubscribedUSK, MsgSubscribedUSKUpdate, 
+										MsgTestDDAComplete, MsgTestDDAReply, MsgTestDDARequest, MsgTestDDAResponse, MsgURIGenerated, 
+										MsgUnknownNodeIdentifier, MsgUnknownPeerNoteType, MsgWatchGlobal, PersistentParamsSep,
+										newMessageClass)
+from .types import (Type, TypeBase64EncodedString, TypeBool, TypeByteAmount, TypeChoiceFProxyCss, TypeChoiceLoggerPriority, 
+								TypeChoiceNodeDownloadAllowedDirs, TypeChoiceNodeUploadAllowedDirs, TypeChoicePriorityPolicy, 
+								TypeChoiceSSLVersion, TypeDirname, TypeFilename, TypeFloat, TypeIP, TypeIPList, TypeIPort, TypeInt, 
+								TypeIntWithBounds, TypeInt_GetFailed_ExpectedDataLenght, TypePercent, TypeString, TypeStringList, TypeTime, 
+								TypeTimeDelta, TypeUri)
+#****************************************************************************************
+#
+#****************************************************************************************
+

Added: trunk/fclient/src/fclient/lib/fcp2/client.py
===================================================================
--- trunk/fclient/src/fclient/lib/fcp2/client.py	                        (rev 0)
+++ trunk/fclient/src/fclient/lib/fcp2/client.py	2008-07-07 21:32:00 UTC (rev 538)
@@ -0,0 +1,2176 @@
+"""Fcp2 client implementation
+
+Compatibility: >= Freenet 0.7 Build #1107
+
+
+@newfield event: Event, Events
+@newfield requestparam: RequestParam, RequestParams
+
+@note: The client implementation never uses or watches the global queue. No implementation 
+should ever do so. Global is evil.
+@note: the client is not thread save.
+
+
+Sample code. Connect to the freenet node::
+    client = FcpClient()
+    nodeHello = client.connect()
+    if nodeHello is None:
+        pass
+        # something went wrong ..could not connect to the freenet node
+    else:
+        pass
+        # everything went well ..we are connected now
+
+Request data associated to a freenet key::
+	myKey = client.key.key('CHK@ABCDE.......')
+	myRequestIdentifier = client.getData(myKey)
+	myRequest = c.getRequest(myIdentifier)
+	client.run()
+	print myRequest.data
+
+Usually you would connect handlers to client events to do processing or handle errors::
+    def handleSuccess(event, request):
+        print 'Here is the data:', request.data
+
+    def handleFailure(event, request):
+        print 'Too bad, something went wrong'
+
+	client.events.RequestCompleted += handleSuccess
+	client.events.RequestFailed += handleFailure
+	myKey = client.key.key('CHK@ABCDE.......')
+	client.getData(myKey)
+	c.run()
+
+
+Instead of calling run() you may run the client step by step::
+    myKey = client.key.key('CHK@ABCDE.......')
+	client.getData(myKey)
+	for i in xrange(50):
+		client.next()
+
+	
+You may disconnect event handlers aswell::
+
+    client.events.RequestCompleted -= handleSuccess
+    client.events.RequestFailed -= handleFailure
+
+
+Multiple event handlers may be connected / disconnected at once::
+
+    client.events += (
+            (client.events.RequestCompleted, handleSuccess),
+            (client.events.RequestFailed, handleFailure)
+        )
+
+
+"""
+
+#Bug reports filed and open:
+#--------------------------------------------------------------------------------------------------------------------------------------------
+# [0001931: Send EndListPersistentRequests following client connect]
+#
+# PendingRequests currently get lost if a.) the node goes down b.) if the client goes down unexpectedly. 
+# This affects IdentifierCollision + FilenameCollision + ClientPut when a SSK needs to be created first
+# 
+# we can handle this case none short of maintaining a file keeping messages. But still there is the
+# problem of knowing when the node has actually registered a request. The node does not send
+# an EndListPersistentRequests on connect so it is impossible to tell when or if to restore one of
+# the pending requests we stored.
+#
+#FIX: None
+#---------------------------------------------------------------------------------------------------------------------------------------------
+# [0001893: CloseConnectionDuplicateClientName bug or feature?]
+#
+# CloseConnectionDuplicateClientName
+# currently fcp takes down a our connection if another client (...) uses the same connection name.
+#
+#FIX: None
+#----------------------------------------------------------------------------------------------------------------------------------------------
+# [0001888: explicite connection locale]
+#
+# Many strings are already translated by freenet, but there is no way to tell the node wich language
+# to use to talk to a client. Maybe a good idea, maybe not.
+#
+#FIX: None
+#-----------------------------------------------------------------------------------------------------------------------------------------------
+# [0001781: unregister directories registered via TestDDARequest]
+#
+# With current state of the art DDA handling it is not possiblr to unregister directories (may pile
+# up in memory over time).
+#
+#FIX: None
+#------------------------------------------------------------------------------------------------------------------------------------------------
+# [0002019: Socket dies if first message is not ClientHello]
+#
+# minor one
+#
+#FIX: None
+#-------------------------------------------------------------------------------------------------------------------------------------------------
+# [0002015: Drop the global queue]
+#
+# this one is somewhat related to [0001931: Send EndListPersistentRequests following client connect]
+#
+# We never use or watch the global queue. It is to dangerous. But problems remain when it comes 
+# to restoring persistent requests. Shure these are our requests? Worst case is a client with a colliding
+# connection name flooding our client with an unknown number of left overs.
+#
+#FIX: None (that is, this case is handled as savely as possible - except from possible slowdowns - but no 
+#                   guarantee that no unknown request may slip through)
+#-------------------------------------------------------------------------------------------------------------------------------------------------	
+# [0001894: HandleCollision field in ClientGet]
+#
+# minor one. When downloading a file, filename collisions may occur. Fcp does not handle these very well
+# It checks if the tempfile (filename ?) can be created newly when the request is started. IIRC In the final 
+# rename of the tempfile to filename no check is done and filename will get overwritten.
+#
+#FIX: we handle collisions in the client as savely as possible. But no guarantee either when a colliding file
+# (...) finds his way into the download directory while downloading another.
+#------------------------------------------------------------------------------------------------------------------------------------------------
+# [0002083: RemovePersistentRequest ignores unknown requests]
+#
+# minor one, but related to it a major one: you can not change the Priority of requests with 
+# Persistence=conncetion
+#
+#FIX: workaround for the "related" part 
+#------------------------------------------------------------------------------------------------------------------------------------------------ 
+ # [0002200 - handle persistent and non-peristent request uniformly]
+# 
+# removbe request is now handled uniformly in Fcp. modify request not yet.
+#
+#-------------------------------------------------------------------------------------------------------------------------------------------------
+# [0002202: drop global persistents ]
+#
+# suggested dropping of global persistents. pretty dangerous and unhandy imo. 
+#
+#FIX: at least some are implemented in the client
+#--------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+
+# Todos
+#------------------------------------------------------------------------------------------------------------------------------------------------
+# clean up
+#
+# x. move saveWriteFile and friends to a separate module
+#
+#------------------------------------------------------------------------------------------------------------------------------------------------ 
+# Fcp types vs. Python types
+#
+# x. Fcp seems to use kibibytes. Autoconvert to kilobytes?
+# x. time intervals
+#
+#------------------------------------------------------------------------------------------------------------------------------------------------ 
+# logging
+#
+# x. should uris (...) always be visible in log output? Certainly in memory. Maybe a specialized
+#     "save" logger could be useful (like for user feedback).
+#
+#------------------------------------------------------------------------------------------------------------------------------------------------ 
+# runtime
+#
+# x. if the socket dies the client disconnects automatically, clearing all requests.
+#     No idea how to handle this. Would require at least an EndListPersistentRequest
+#     from the node to check wich requests arrived at the node ..and an auto resend 
+#     requests the node does not know about.
+#
+#------------------------------------------------------------------------------------------------------------------------------------------------ 
+# request status
+#
+# x. have to set a dedicated flag when a request is about to be modified or removed
+#     Fcp gets confused if we disconnect emidiately after sending a modify or remove request 
+#     Curretnly the RequestStatus.Completed flag is removed and later set again to get some
+#     control over the process.
+#
+#     TODO: check if this is a bug in Fcp
+#     NOTE: seems to be fixed in [build 1112], fixes removed
+#-------------------------------------------------------------------------------------------------------------------------------------------------
+
+
+
+# reminders to self
+#------------------------------------------------------------------------------------------------------------------------------------------------
+# Key()
+#
+# we do not allow passing strings as uris. putting a CHK gets in the way here. would have to add another
+# special case to handle 'CHK@myfilename' on input. so for uniformity reasons keys are enforced.
+#------------------------------------------------------------------------------------------------------------------------------------------------ 
+# clientGet('USK@.../whatever/-1')
+#
+# will trigger a FetchError(PermanentRedirect) with the highest available version as RedirectURI
+# we don't handle this automatically, cos it could be the desired result. maybe implement a flag 
+# someday to handle this
+#
+#------------------------------------------------------------------------------------------------------------------------------------------------
+from __future__ import absolute_import
+if __name__ == '__main__':	# see --> http://bugs.python.org/issue1510172 . works only current dir and below
+	import os; __path__ = [os.path.dirname(__file__)]
+	
+	
+import os, sys
+
+import atexit
+import copy
+import logging
+import random
+import subprocess 
+import time
+
+
+from . import consts
+from . import config
+from . import events
+from . import message
+from . import iohandler
+from . import types
+from . import key
+
+from .lib import namespace
+from .lib import tools
+
+
+__all__ = ['Client', ]
+#*************************************************************************************************
+#
+#*************************************************************************************************
+class Client(object):
+	"""
+	@cvar ExpectedFcpVersion: (float) minimum expected Freenet client protocol version
+	@cvar ExpectedNodeBuild: (int) minimum expected node build
+	@cvar DefaultFcpHost: (str) default Fcp host
+	@cvar DefaultFcpPort: (int) default Fcp port
+	@cvar MaxSizeKeyInfo: (bytes) maximum request size for key info requests
+	@cvar inimumRunTime: (seconds) minimum runtime when the L{run} method is called.
+	Required to make shure persistent requests can be taken up from the node. 
+		
+	@ivar events: events the client supports
+	
+	
+	@todo: cvar MaxSizeKeyInfo. Check if required. 
+	suggested by Mathew Toseland to use about 32k for mimeType requests
+	basic sizes of keys are: 1k for SSks and 32k for CHKs without MaxSize 
+	DataFound will have DataLength set to 0 (?!) 
+	
+	"""
+	ExpectedFcpVersion = 2.0	
+	ExpectedNodeBuild = 1153
+	DefaultFcpHost = os.environ.get('FCP_HOST', '127.0.0.1')
+	DefaultFcpPort = int(os.environ.get('FCP_PORT', '9481'))
+	MaxSizeKeyInfo = 32768
+	MinimumRunTime = 1		# FIX: 0001931
+		
+	#consts = consts
+	#config = config
+	#message = message
+	#types = types
+	#key = key
+		
+	
+	def __init__(self, 
+			connectionName=None,
+			debugVerbosity=None, 
+			):
+		"""
+		@param connectionName: name of the connection or None to use an arbitrary connection name
+		@param debugVerbosity: verbosity level for debugging. Default is L{consts.ConstDebugVerbosity.Warning}
+				
+		"""
+		self._connectionName = self.setConnectionName(connectionName)
+		self._ddaTests = []				# currently running DDA tests (request0, ... requestN)
+		self._nodeHelloMessage = None
+		self._requests = {}			# currently running requests (requestIdentifier --> request)
+		
+		self.events = events.Events()
+		self.ioHandler = iohandler.IOHandler()
+				
+		for event in self.events:
+			event += self._captureEvent
+		self.setDebugVerbosity(consts.ConstDebugVerbosity.Warning if debugVerbosity is None else debugVerbosity)		
+		atexit.register(self.close)
+			
+	###############################################################
+	##
+	## private methods
+	##
+	###############################################################
+	def _captureEvent(self, event, request):
+		if event == self.events.Idle:
+			consts.ConstLogger.Event.log(consts.ConstDebugVerbosity.Chatty, consts.ConstLogMessages.EventTriggered + event.name)
+		else:
+			consts.ConstLogger.Event.info(consts.ConstLogMessages.EventTriggered + event.name)
+			
+		
+	def _close(self, msg):
+		"""Closes the client
+		@param msg: message to pass to the ClientDisconnected event or None to not inform listeners
+		
+		@todo: complain if the client is already closed?
+		@todo: trigger ClientDisconnected() if the client is already closed? should be yes. otherwise
+		we'd have to distinguish between intentional and unintentional closing like on a broken io
+		"""
+		consts.ConstLogger.Client.info(consts.ConstLogMessages.Closing)
+				
+		# clean left over DDA test tmp files
+		for initialRequest in self._ddaTests:
+			if initialRequest['TestDDA'].get('TmpFile', None) is not None:
+				tools.saveRemoveFile(initialRequest['TestDDA']['TmpFile'])
+		
+		self._ddaTests = []	
+		self._requests = {}
+		
+		if msg is not None:
+			self.events.ClientDisconnected(msg)
+		if self.ioHandler.isOpen():
+			self.ioHandler.close()
+					
+	
+	def _finalizeRequest(self, msg, request, event):
+		"""Finalzes a request
+		@param msg: message that is the reason for finalizing
+		@param request: request to finalize
+		@param event: event to trigger or None
+				
+		@note: this method sets the requests L{consts.ConstRequestStatus.RemovedFromQueue} and 
+		L{consts.ConstRequestStatus.Completed}	flags accordingly
+		@note: Fcp removes Get / Put requests with Persistence == connection emidiately
+		from its queue. Same goes all requests on ProtocolError. We inform the caller
+		that the request has been completed and remove it fom our queue if necessary.
+		Non Get / Put requests will be removed in any case.
+		"""
+		removeRequest = msg == message.MsgProtocolError or msg == message.MsgPersistentRequestRemoved	# TODO: PersistentRequestRemoved???
+		if not removeRequest:
+			#NOTE: non Get / Put related requests do not have a Persistence param
+			removeRequest = request.params.get('Persistence', consts.ConstPersistence.Connection) == consts.ConstPersistence.Connection
+		if removeRequest:
+			request['RequestStatus'] |= consts.ConstRequestStatus.RemovedFromQueue
+				
+		request['RequestStatus'] |= consts.ConstRequestStatus.Completed
+		if event is not None:
+			event(request)
+		
+		if removeRequest:
+			del self._requests[request['Identifier']]
+	
+	
+	def _registerRequest(self, 
+			msg, 
+			requestType, 
+			userData=None, 
+			identifier=None,
+			initTime=None, 
+			persistentUserData='', 
+			filenameCollision=consts.ConstFilenameCollision.HandleNever,
+			):
+		"""Registers a request
+		@param msg: message to register 
+		@param requestType: (L{consts.ConstRequestType}) type of request to register
+		@param filenameCollision: (L{consts.ConstFilenameCollision}) how to handle filename collisions. 
+		Default is L{consts.ConstFilenameCollision.HandleNever}
+		@param identifier: (str) identifier of the request or None to create a new one
+		@param initTime: (int) init time of the request or None to set it to now
+		@param persistentUserData: (str) anyuser defined persistent data
+		@param userData: (any) any user defined non persistent data
+		
+		@return: (str) identifer of therequest
+		@note: the identifier returned is unique to the client but may not be unique to the node
+		"""
+		identifier =  self.newIdentifier(identifiers=self._requests) if identifier is None else identifier
+						
+		# equip requests with some additional params
+		
+		#TODO: keep an eye on additional params, they may collide with Fcp parameters
+		msg['Identifier'] =  self.newIdentifier(identifiers=self._requests) if identifier is None else identifier
+		msg['RequestType'] = requestType
+		msg['InitTime'] = time.time() if initTime is None else initTime
+		if requestType & consts.ConstRequestType.MaskGet:
+			msg['FilenameCollision'] = filenameCollision
+			msg['UserData'] = userData
+			msg['PersistentUserData'] = persistentUserData
+			msg['ClientToken'] = ''
+			msg.updatePersistentParams()
+					
+		elif requestType & consts.ConstRequestType.MaskPut:
+			msg['UserData'] = userData
+			msg['PersistentUserData'] = persistentUserData
+			msg['ClientToken'] = ''
+			msg.updatePersistentParams()
+			
+		elif requestType & consts.ConstRequestType.MaskGenerateKeypair:
+			pass
+		elif requestType & consts.ConstRequestType.SubscribeUSK:
+			msg['UserData'] = userData
+		elif requestType & consts.ConstRequestType.PluginInfo:
+			pass
+		else:
+			raise ValueError('Can not register request: ' + msg.name)
+		
+		self._requests[identifier] = msg
+		
+	###############################################################
+	##
+	## connection related methods
+	##
+	###############################################################
+	def close(self):
+		"""Closes the client
+		@note: make shure to call close() when done with the client
+		"""
+		msg = message.MsgClientDisconnected(
+						DisconnectReason=consts.ConstDisconnectReason.Close,
+						)
+		self._close(msg)
+	
+	
+	def closeNode(self):
+		"""Shuts down the freenet node"""
+		self.sendMessage(message.MsgShutdown())
+	
+	
+	def connect(self, host=DefaultFcpHost, port=DefaultFcpPort, duration=20, timeout=0.5):
+		"""Connects to the freenet node
+		@param host: (str) host of th node
+		@param port: (int) port of the node
+		@param duration: (int) how many seconds try to connect before giving up
+		@param timeout: (int) how much time to wait before another attempt to connect
+		
+		@return: (L{message.MsgNodeHello}) or None if no connection could be established		
+		"""
+		nodeHello = None
+		for nodeHello in self.iterConnect(host=host, port=port, duration=duration, timeout=timeout):
+			pass
+		return nodeHello
+			
+	
+	def isO...
 
[truncated message content]

Thread: SF.net SVN: fclient: [538] trunk/fclient/src/fclient

fclient-commit