PyOGP Client Library

== Intro ==
PyOGP is a young, open source, python client library which provides an interface to an agent (client) of a Second Life grid. The code aims to enable automated testing of Second Life grids, to encourage and enable exploration into the client/server relationship and related protocols of Second Life, and to make possible simple prototyping of various client applications.
Hosted on svn.secondlife.com, it does require a contributor's agreement for commit access, and currently has a few contributors from the Second Life open source community.
P.S. We'll likely be moving to hg relatively soon...
* mailing list: pyogp@lists.secondlife.com
* irc: irc://irc.freenode.com/#pyogp
* wiki: http://wiki.secondlife.com/wiki/Pyogp
* licensing: Apache 2.0 license, copyright Linden Lab
=== Goals ===
In the very near future, we can have tests available to be run as soon as a deploy is completed that exercise a simulator/grid in the same way we do a smoke test. We will use these as automated tests run at build time, post deploy validation, and regression testing of simulators and backend systems.
This provides early feedback on code quality. QA is then able to dive deeper in testing the changes specific to a branch. 
Having this library available also allows us to test potential changes before we have finalized design and are ready to submit to QA. Not sure how something will play out? Try it, and test it with PyOGP....
=== A Brief History ===
PyOGP was originally created as a tool for testing OGP related changes to the Second Life grid. By the end of the summer in 2008, the pyogp.lib.base package provided a skeleton messaging system and was able to test Linden Lab's first implementation of an agent domain and the related changes in an agent's region handoff and teleport. As the development effort around OGP waned, we started to extend pyogp by adding higher level client related functionality. Recently, this functionality was split out into a separate python package (pyogp.lib.client), and sample scripts (and future apps) were moved into pyogp.apps.
== Architecture Overview==
=== Structure ===
PyOGP is comprised of three python packages. The library consists of pyogp.lib.base and pyogp.lib.client, while sample scripts, and in time applications, live in pyogp.apps. 
:pyogp.lib.base - consists of basic networking, messaging systems (UDP and event queue) and capabilities, custom datatypes, and a low level message related event system
:pyogp.lib.client - consists of 'convenience' classes mapping methods and handlers to specific messages (e.g. Agent().say(msg) tells the client to send the ChatFromViewer message to the host region). Raises application oriented events based on processing of messages (these are currently sparsely implemented)
:pyogp.apps - sample scripts and works in progress, the scripts here generally illustrate simple usage of classes as related to in world interactions by an agent of a Second Life grid
=== Dependencies ===
==== Platform / Python version compatibility ====
PyOGP aims to be compatible across platforms, though there are known problems with various environments. We'll be focusing on ensuring better compatibility soon.
Known good configurations
:Windows XP + Python 2.5
:Mac + Python 2.5, 2.6
:Linux + Python 2.4, 2.5, 2.6 (Linden hosts fall into this group) 
Known bad configurations
:Windows Vista + Python 2.6
:Windows 7 + Python 2.6
There have been challenges in ensuring compatibility between the various dependencies, largely due to greenlet, eventlet, and pyopenssl. Please report bugs on pJira
==== Python module dependencies ====
The packages that make up PyOGP have some dependencies on python modules not included in a standard install, or sometimes not available on an older Python distribution.
pyogp.lib.base dependencies:
 #from setup.py
 
 install_requires=[
 'setuptools',
 # -*- Extra requirements: -*-
 'uuid',
 'elementtree',
 'llbase',
 'WebOb',
 'wsgiref',
 'eventlet==0.8.14',
 'pyOpenssl'
 ]
pyogp.lib.client dependencies:
 install_requires=[
 'setuptools',
 # -*- Extra requirements: -*-
 'pyogp.lib.base'
 ] 
pyogp.apps dependencies:
 install_requires=[
 'setuptools',
 'pyogp.lib.client'
 ]
=== How to install ===
Lindens can see internal documentation for more specific guidance. https://wiki.lindenlab.com/wiki/Pyogp#How_to_Install
==== Standalone dev environment using buildout ====
Buildout is a type of Python development environment, organizing and configuring various components and their dependencies. On a desktop, one may checkout such an environment for working with PyOGP. One may optionally use a virtualenv Python environment to isolate the development code and it's runtime environment on one's host.
Dependencies: buildout takes care of everything, grabbing needed modules etc.
Wiki instructions: https://wiki.secondlife.com/wiki/Pyogp/Client_Lib/The_Development_Sandbox
==== Installing the PyOGP packages ====
Each of the PyOGP package may be installed to one's Python install or to a virtualenv. Buyer beware if installing into your system's install: you'll want to be able to uninstall manually, as we haven't hooked up the uninstall. PyOGP is still coming up to speed with respect to distutils and pypi and the like, but it's relatively close now.
To install a package, simply run 'python setup.py install' in a package's root.
==== Referencing PyOGP packages via the PATH ====
Source code can be referenced directly if one simply ensures that a package, and it's dependencies, are available in the PYTHONPATH environmental variable.
== Current functional coverage ==
Anything not listed as covered is probably not yet covered.
pyogp.lib.base:
:* base udp messaging system (message.*)
:** UDP serialization/deserialization
:** message_template.msg parsing 
:* base event queue messaging system (event_queue.EventQueueClient())
:* capabilities and their methods. Seed capabilities are a special case. (caps.Capability())
:* Message-based events (message.message_handler)
pyogp.lib.client:
:* agents (agent.Agent())
:** L$ balance request, friending, and walk/fly/sit/stand actions...
:* OGP agentdomain (agentdomain.AgentDomain())
:* application level events (event_system.AppEventsHandler())
:* some object handling (objects.*)
:** edit name, description, next-owner permissions and more
:** object creation is possible
:* some inventory handling (inventory.*)
:** login inv skeletons
:** fetching inventory, including AIS (caps based Agent Inventory Services))
:** some creating of new inventory items (LSL scripts, notecards)
:* regions (region.Region())
:** host and neighboring regions are handled slightly differently
:** udp and event queue connections are optionally enabled for each case
:** currently only pulling caps available to the agent via the seed cap (plus using the inventory related caps in the AIS context)
:* some appearance handling (appearance.AppearanceManager), 
:* parcels
:* chat
:* some ImprovedInstantMessage handling
:** raises events on received instant messages
:** can deal with inventory offers/accepts/declines
:** other cases in this message are currently only logged
:* groups
:* group chat
:* LSL script uploading
=== Sample Scripts ===
There are a variety of scripted examples that have been used to exercise and test functionality as it is added to the library. These persist as coded documentation.
The source code is available in https://svn.secondlife.com/svn/linden/projects/2008/pyogp/pyogp.apps/trunk/pyogp/apps/examples/.
The following refers to a buildout context. If one installs pyogp.apps vi setup.py, these scripts will exist in the python environment's bin/ directory. In the buildout context, these scripts are available in {buildout root}/bin.
The scripts are derived from a package's 'setup.py' via the entry_points parameter, and essentially build executable Python scripts configured to run in the correct environment with the proper dependencies added the the path used by the script. These scripts are currently just simple illustrations of some uses of the PyOGP codebase.
 #the current entry_points in setup.py og pyogp.apps:
 
 entry_points={
 'console_scripts': [
 'AIS_inventory_handling = pyogp.apps.examples.AIS_inventory_handling:main',
 'agent_login = pyogp.apps.examples.agent_login:main',
 'agent_manager = pyogp.apps.examples.agent_manager:main',
 'appearance_management = pyogp.apps.examples.appearance_management:main',
 'chat_and_instant_messaging = pyogp.apps.examples.chat_and_instant_messaging:main',
 'group_chat = pyogp.apps.examples.group_chat:main',
 'group_creation = pyogp.apps.examples.group_creation:main',
 'inventory_handling = pyogp.apps.examples.inventory_handling:main',
 'inventory_transfer = pyogp.apps.examples.inventory_transfer:main',
 'inventory_transfer_specify_agent = pyogp.apps.examples.inventory_transfer_specify_agent:main',
 'login = pyogp.apps.examples.login:main',
 'multi_region_connect = pyogp.apps.examples.multi_region_connect:main',
 'object_create_edit = pyogp.apps.examples.object_create_edit:main',
 'object_create_permissions = pyogp.apps.examples.object_create_permissions:main',
 'object_create_rez_script = pyogp.apps.examples.object_create_rez_script:main',
 'object_creation = pyogp.apps.examples.object_creation:main',
 'object_properties = pyogp.apps.examples.object_properties:main',
 'object_tracking = pyogp.apps.examples.object_tracking:main',
 'parcel_management = pyogp.apps.examples.parcel_management:main',
 'parse_packets = pyogp.apps.examples.parse_packets:main',
 'region_connect = pyogp.apps.examples.region_connect:main',
 'smoke_test = pyogp.apps.examples.smoke_test:main',
 'chat = pyogp.apps.examples.chat_interface:main',
 ]
 }
== How it Works (High Level) ==
=== Eventlet ===
PyOGP use Eventlet to run coroutines to handle multiple 'concurrent' processes, rather than threads or multiple processes. Each client agent instance will spawn a handful of coroutines to handles e.g. the UDP pipe, the Event Queue, various monitors, while yielding time to the parent process which should ensure it yields to the other routines as well.
PyOGP uses eventlet in very elementary ways at this point, but will perhaps start to use blocking queues in some cases, so that the coroutine only is allocated processing time if there is work for it to do.
=== pyogp.lib.base ===
This package handles the protocols used when communicating with a Second Life grid. A high level perspective on the package reveals a MessageManager() (still in development) which provides an interface to the UDP and Event Queue connections, as well as basic networking with enables login and capabilities interactions. The base package also has a low level even system through which all messages are passed and sent to subscribers.
Any subcomponent is available for direct interaction at any time, the MessageManager() and the MessageHandler() are the simple access points.
==== Events & Callbacks ====
The event implementation in pyogp follows the observer pattern, where observers subscribe to and are notified when an event occurs. Data is passed throughout the client instance via events. 
* MessageManager - is an attribute of a Region and every packet received/sent is filtered through here. subscriptions are by message name
** MessageHandler - is an attribute of MessageManager, and every categorized message received from the event queue or udp dispatcher is filtered through here. (message as defined in message_template.msg, or one of ['ChatterBoxInvitation', 'ChatterBoxSessionEventReply', 'ChatterBoxSessionAgentListUpdates', 'ChatterBoxSessionStartReply', 'EstablishAgentCommunication']. There may be unhandled messages, I just haven't seen em yet :))
===== Message Events =====
In the most fundamental implementation of event usage, all packets are passed through a MessageManager() instance for evaluation. Observers may register to receive udp packets serialized into the form of Message() instances. The MessageHandler() is a consolidation point for subscribing to messages keyed by message name, and created on demand via subscription.
See pyogp.lib.base.message.message_handler.MessageHandler() for more details.
The pyogp agent's Region() instances each monitor their stream of packets (e.g. the host region: agent.region.message_manager.message_handler). (Perhaps this should be changed to a generalized Network() class where all packets (coupled to their originating regions) are evaluated.
Event firing passes data on to a callback handler defined in the subscription, in the form of (handler, *args, **kwargs).
The Agent class monitors the ImprovedInstantMessage packet:
 onImprovedInstantMessage_received = self.region.message_handler.register('ImprovedInstantMessage')
 onImprovedInstantMessage_received.subscribe(self.onImprovedInstantMessage)
 def onImprovedInstantMessage(self, packet):
 """ handles the many cases of data being passed in this message """
 {code} # parse and handle the data...
The messaging system then fires the event when an ImprovedInstantMessage message is received, which calls onImprovedInstantMessage method above to handle the message contents. Multiple subscribers may be listening for any message related event, and each would be notified of the same Message() instance.
Unsubscribing from an event:
 onImprovedInstantMessage_received.unsubscribe(self.onImprovedInstantMessage)
There are various event and callback implementations viewable in pyogp, poke around and help consolidate things if you like.
=== pyogp.lib.client ===
The client package generally provides a convenient interface to initiate or interpret interactions with host region (or neighboring regions). By listening to the messaging related event system in pyogp.lib.base, the client package interprets the messages that come in off the wire, and executes business logic in building responses. pyogp.lib.client also provides simple methods to enable the ending of messages to a grid.
==== Events ====
* EventsHandler - an attribute of an Agent, also able to be passed in, that is intended as the primary interface of a pyogp application into the internal state and data events within the lib. This system uses the same base classes as used by the MessageHandler() in the base package, and the descriptions about events and callbacks above apply here as well. The api for subscribing to these events is similar to the MessageHandler(), with an additional timeout parameter passed in the _register() method. When the specified timeout expires, the subscription returns None and expires the subscription.
==== Agent Login (examples) ====
===== Single Agent Login & Chat=====
Spawn a client in a co-routine, allowing persistent presence until forcefully terminated.
from eventlet import api
from pyogp.lib.client.agent import Agent
from pyogp.lib.client.settings import Settings
settings = Settings()
settings.ENABLE_INVENTORY_MANAGEMENT = True
settings.MULTIPLE_SIM_CONNECTIONS = False
client = Agent(settings = settings)
api.spawn(client.login, options.loginuri, 'first', 'last', 'password', start_location = options.region)
# wait for the agent to connect to it's region
while client.connected == False:
 api.sleep(0)
while client.region.connected == False:
 api.sleep(0)
client.say("Hello World!")
# once connected, live until someone kills me
while client.running:
 api.sleep(0)
===== Multiple Agent Login =====
Each agent instance in logged in in a separate coroutine.
from pyogp.lib.client.agent import Agent
from pyogp.lib.client.agentmanager import AgentManager
credentials= [('agent1', 'lastname', 'password'), ('agent2', 'lastname', 'password')]
# prime the Agent instances
agents = [Agent(settings, firstname, lastname, password)
 for firstname, lastname, password in credentials]
agentmanager = AgentManager()
agentmanager.initialize(agents)
# log them in
for key in agentmanager.agents:
 agentmanager.login(key, options.loginuri, options.region)
# while they are connected, stay alive
while agentmanager.has_agents_running():
 api.sleep(0)
== Extending Functionality ==
While the implementations and structures in pyogp.lib.base can (and are in the process of) being refactored to improve performance or usability, it is a fairly complete package. 
The functional coverage PyOGP provides on the other hand is not complete, and there are a variety of needs to complete the implementation in pyogp.lib.base. We need to improve coverage of message handling (dealing with messages sent to the client), add more wrappers for sending various messages and performing multistep tasks (to simplify the initiation of interactions with the region), and we need to raise more application level events in the client package so that applications have easy access to incoming data. 
=== Sending Messages ===
PyOGP, like the Viewer, communicates with the Second Life simulator by sending messages over UDP. 
In order to extend PyOGP, you'll build a representation of a new UDP message, and send it through the pyogp.lib.base modules for serialization and wire handling.
=== Example: Sending an IM ===
To send an IM to the simulator, send an ImprovedInstantMessage packet. The base class for message packets is defined in base/message/message.py
Packets are assembled using a Message() instance which has the message name and Block() instances passed in through its constructor. Similarly, Blocks are assembled by passing in the Block name and the value name and values for each of the Block values. (The ability to build Message() instances via an llsd payload is expected to be introduced soon.)
Note: It is important that the message name, block name, and value names and types should match what is specified in the message template. (It is also possible to manipulate the representation of the stored template, or to use a custom message template.)
 
Example:
 def send_ImprovedInstantMessage(self, AgentID = None, SessionID = None, 
 FromGroup = None, ToAgentID = None, 
 ParentEstateID = None, RegionID = None, 
 Position = None, Offline = None, 
 Dialog = None, _ID = None, Timestamp = None, 
 FromAgentName = None, _Message = None, 
 BinaryBucket = None):
 """ 
 sends an instant message packet to ToAgentID. this is a 
 multi-purpose message for inventory offer handling, im, group chat, 
 and more 
 """
 packet = Message('ImprovedInstantMessage', 
 Block('AgentData', 
 AgentID = AgentID, 
 SessionID = SessionID), 
 Block('MessageBlock', 
 FromGroup = FromGroup, 
 ToAgentID = ToAgentID, 
 ParentEstateID = ParentEstateID, 
 RegionID = RegionID, 
 Position = Position, 
 Offline = Offline, 
 Dialog = Dialog, 
 ID = UUID(str(_ID)), 
 Timestamp = Timestamp, 
 FromAgentName = FromAgentName, 
 Message = _Message, 
 BinaryBucket = BinaryBucket))
 # Send the message:
 self.region.enqueue_message(packet, True)
=== Handling Incoming Messages and Raising an Event ===
To listen for when messages of a particular type are sent to the client instance, subscribe to the MessageHandler() on the host region's MessageManager(), like the example that follows:
 onImprovedInstantMessage_received = self.region.message_handler.register('ImprovedInstantMessage')
 onImprovedInstantMessage_received.subscribe(self.onImprovedInstantMessage)
When the event is fired upon receipt of the message matching the name, the specified callback handles the data passed along, and in this case raises an event notifying observers of the 'InstantMessageReceived' event in pyogp.lib.client of the important data.
 def onImprovedInstantMessage(self, packet):
 """ callback handler for received ImprovedInstantMessage messages. much is passed in this message, and handling the data is only partially implemented """
 Dialog = packet.blocks['MessageBlock'][0].get_variable('Dialog').data
 FromAgentID = packet.blocks['AgentData'][0].get_variable('AgentID').data
 if Dialog == ImprovedIMDialogue.InventoryOffered:
 self.inventory.handle_inventory_offer(packet)
 # ...
 # some of the Dialogue types this message can contain are handled, we are showing 2
 # ...
 elif Dialog == ImprovedIMDialogue.FromAgent:
 # ... code parses the data from the Message() instance ...
 message = AppEvent('InstantMessageReceived', FromAgentID = FromAgentID, RegionID = RegionID, Position = Position, ID = ID, FromAgentName = FromAgentName, Message = _Message)
 logger.info("Received instant message from %s: %s" % (FromAgentName, _Message))
 self.events_handler.handle(message)
== Logging ==
Uses python's standard logging module (http://docs.python.org/library/logging.html). The library defines logging events throughout, it is up to the application/script to determine the output.
Hooking logging into a new module:
from logging import getLogger
# initialize logging
logger = getLogger('pyogp.lib.client.agent')
class Agent(object):
 """ our agent class """
 def __init__(self, params):
 self.params = params
 logger.debug("Initializing agent with params: %s" % (params))
An application can then set up the logging output as follows (or any other way it pleases):
console = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)-30s%(name)-30s: %(levelname)-8s %(message)s')
console.setFormatter(formatter)
logging.getLogger().addHandler(console)
logging.getLogger().setLevel(logging.DEBUG)
The output to console is then:
2009-04-21 22:08:58,681 pyogp.lib.base.agent : DEBUG agent with params: params
== Pyogp Unit Tests ==
See PyOGP_Package_Unittests.
== Sphinx (api docs) ==
Api documentation is now available for PyOGP packages (well, not for apps yet, but someday....)!
 
In pyogp/docs in each of the pyogp.lib.base and pyogp.lib.client packages, one will find source, last revision, and build files for sphinx based documents. Output is available at {package root}/docs/html/index.html.
We plan on sharing the api documentation on the web soon, and will work to make simple build wrappers work on various platforms, though this is a low priority.
Ask Enus for updated documentation to be checked in, or, build a better refresh.py.
== Roadmap ==
See Pyogp/Roadmap for details, or ask in irc or on the mailing list. Here's what's up in the near term for pyogp:
* better packaging and platform compatibility
* more functional coverage of message. We are covering 32% of the messages the viewers sends or handles when received (though it's estimated at more like 50% of normal use cases.
* permissions system testing to save QA from 3-5 day regression passes on perms
* appearance - this will require enabling upload and download, plus baking. Anyone have some spare time? :)
Category: Pyogp_Client_Lib
Category: Pyogp
Category:Architecture Working Group
Category:Grid_Interoperability
Category:AW Groupies
Category:MMOX