+++ /dev/null
-import time
-import tempfile
-import cPickle
-import zlib
-import os
-from os.path import join, exists
-
-class cache_handler( object ):
- # adapted from http://home.wanadoo.nl/ntt/eve/library/files/api/apitest.py (does this satisfy the terms of the license?), will need work, but we need basic cache functionality... I feel guilty for abusing the server. FIXME --danny
-
- def __init__( self, debug = False ):
- self.debug = debug
- self.count = 0
- self.cache = {}
- self.tempdir = join( tempfile.gettempdir(), "eveapi" )
- if not exists( self.tempdir ):
- os.makedirs( self.tempdir )
-
- # remove this later --danny
- def log( self, what ):
- if self.debug:
- print "[%d] %s" % ( self.count, what )
-
- def retrieve( self, host, path, params ):
- # eveapi asks if we have this request cached
- key = hash( ( host, path, frozenset( params.items() ) ) )
-
- # for logging
- self.count += 1
-
- # see if we have the requested page cached...
- cached = self.cache.get( key, None )
- if cached:
- cacheFile = None
- else:
- # not in memory, maybe on disk --danny
- cacheFile = join( self.tempdir, str( key ) + ".cache" )
- if exists( cacheFile ):
- self.log( "%s: retreiving from disk." % path )
- f = open( cacheFile, "rb" )
- cached = self.cache[key] = cPickle.loads( zlib.decompress( f.read() ) )
- f.close()
-
- if cached:
- # check if the cached doc is fresh enough
- if time.time() < cached[0]:
- self.log( "%s: returning cached document." % path )
- # return the cached XML doc
- return cached[1]
-
- # if it's stale, purge it --danny
- self.log( "%s: cache expired, purging!" % path )
- del self.cache[key]
- if cacheFile:
- os.remove( cacheFile )
-
- self.log( "%s: not cached, fetching from server..." % path )
- # We didn't get a cache hit so return None to indicate that the data should be requested from server
- return None
-
- def store( self, host, path, params, doc, obj ):
- # eveapi is asking us to cache an item
- key = hash( ( host, path, frozenset( params.items() ) ) )
-
- cachedFor = obj.cachedUntil - obj.currentTime
- if cachedFor:
- self.log( "%s: cached (%d seconds)." % ( path, cachedFor ) )
-
- cachedUntil = time.time() + cachedFor
-
- # store in memory
- cached = self.cache[key] = ( cachedUntil, doc )
-
- # store in cache folder
- cacheFile = join( self.tempdir, str( key ) + ".cache" )
- f = open( cacheFile, "wb" )
- f.write( zlib.compress( cPickle.dumps( cached, -1 ) ) )
- f.close
-
-
+++ /dev/null
-#=============================================================================\r
-# eveapi module demonstration script - Jamie van den Berge\r
-#=============================================================================\r
-#\r
-# This file is in the Public Domain - Do with it as you please.\r
-# \r
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\r
-# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\r
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\r
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\r
-# OTHER DEALINGS IN THE SOFTWARE\r
-#\r
-#----------------------------------------------------------------------------\r
-# Put your userID and apiKey (full access) here before running this script.\r
-YOUR_USERID = 123456\r
-YOUR_APIKEY = "hPx6rxdYfVNeGcuOgPKRL-ohhithere-aUg6OfxCtMH4FUn5GUzf8YqIQDdc5gF7"\r
-\r
-import time\r
-import tempfile\r
-import cPickle\r
-import zlib\r
-import os\r
-from os.path import join, exists\r
-from httplib import HTTPException\r
-\r
-import eveapi\r
-\r
-api = eveapi.EVEAPIConnection()\r
-\r
-#----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 1: GETTING THE ALLIANCE LIST"\r
-print " (and showing alliances with 1000 or more members)"\r
-print\r
-\r
-# Let's get the list of alliances.\r
-# The API function we need to get the list is:\r
-#\r
-# /eve/AllianceList.xml.aspx\r
-#\r
-# There is a 1:1 correspondence between folders/files and attributes on api\r
-# objects, so to call this particular function, we simply do this:\r
-result1 = api.eve.AllianceList()\r
-\r
-# This result contains a rowset object called "alliances". Rowsets are like\r
-# database tables and you can do various useful things with them. For now\r
-# we'll just iterate over it and display all alliances with more than 1000\r
-# members:\r
-for alliance in result1.alliances:\r
- if alliance.memberCount >= 1000:\r
- print "%s <%s> has %d members" %\\r
- (alliance.name, alliance.shortName, alliance.memberCount)\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 2: GETTING WALLET BALANCE OF ALL YOUR CHARACTERS"\r
-print\r
-\r
-# To get any info on character/corporation related stuff, we need to acquire\r
-# an authentication context. All API requests that require authentication need\r
-# to be called through this object. While it is possible to call such API\r
-# functions directly through the api object, you would have to specify the\r
-# userID and apiKey on every call. If you are iterating over many accounts,\r
-# that may actually be the better option. However, for these examples we only\r
-# use one account, so this is more convenient.\r
-auth = api.auth(userID=YOUR_USERID, apiKey=YOUR_APIKEY)\r
-\r
-# Now let's say you want to the wallet balance of all your characters.\r
-# The API function we need to get the characters on your account is:\r
-#\r
-# /account/Characters.xml.aspx\r
-#\r
-# As in example 1, this simply means adding folder names as attributes\r
-# and calling the function named after the base page name:\r
-result2 = auth.account.Characters()\r
-\r
-# Some tracking for later examples.\r
-rich = 0\r
-rich_charID = 0\r
-\r
-# Now the best way to iterate over the characters on your account and show\r
-# the isk balance is probably this way:\r
-for character in result2.characters:\r
- wallet = auth.char.AccountBalance(characterID=character.characterID)\r
- isk = wallet.accounts[0].balance\r
- print character.name, "has", isk, "ISK."\r
-\r
- if isk > rich:\r
- rich = isk\r
- rich_charID = character.characterID\r
-\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 3: WHEN STUFF GOES WRONG"\r
-print\r
-\r
-# Obviously you cannot assume an API call to succeed. There's a myriad of\r
-# things that can go wrong:\r
-#\r
-# - Connection error\r
-# - Server error\r
-# - Invalid parameters passed\r
-# - Hamsters died\r
-#\r
-# Therefor it is important to handle errors properly. eveapi will raise\r
-# an AttributeError if the requested function does not exist on the server\r
-# (ie. when it returns a 404), a RuntimeError on any other webserver error\r
-# (such as 500 Internal Server error).\r
-# On top of this, you can get any of the httplib (which eveapi uses) and\r
-# socket (which httplib uses) exceptions so you might want to catch those\r
-# as well.\r
-#\r
-\r
-try:\r
- # Try calling account/Characters without authentication context\r
- api.account.Characters()\r
-except eveapi.Error, e:\r
- print "Oops! eveapi returned the following error:"\r
- print "code:", e.code\r
- print "message:", e.message\r
-except Exception, e:\r
- print "Something went horribly wrong:", str(e)\r
- raise\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 4: GETTING CHARACTER SHEET INFORMATION"\r
-print\r
-\r
-# We grab ourselves a character context object.\r
-# Note that this is a convenience function that takes care of passing the\r
-# characterID=x parameter to every API call much like auth() does (in fact\r
-# it's exactly like that, apart from the fact it also automatically adds the\r
-# "/char" folder). Again, it is possible to use the API functions directly\r
-# from the api or auth context, but then you have to provide the missing\r
-# keywords on every call (characterID in this case).\r
-#\r
-# The victim we'll use is the last character on the account we used in\r
-# example 1.\r
-me = auth.character(result2.characters[-1].characterID)\r
-\r
-# Now that we have a character context, we can display skills trained on\r
-# a character. First we have to get the skill tree. A real application\r
-# would cache this data; all objects returned by the api interface can be\r
-# pickled.\r
-skilltree = api.eve.SkillTree()\r
-\r
-# Now we have to fetch the charactersheet.\r
-# Note that the call below is identical to:\r
-#\r
-# acc.char.CharacterSheet(characterID=your_character_id)\r
-#\r
-# But, as explained above, the context ("me") we created automatically takes\r
-# care of adding the characterID parameter and /char folder attribute.\r
-sheet = me.CharacterSheet()\r
-\r
-# This list should look familiar. They're the skillpoints at each level for\r
-# a rank 1 skill. We could use the formula, but this is much simpler :)\r
-sp = [0, 250, 1414, 8000, 45255, 256000]\r
-\r
-total_sp = 0\r
-total_skills = 0\r
-\r
-# Now the fun bit starts. We walk the skill tree, and for every group in the\r
-# tree...\r
-for g in skilltree.skillGroups:\r
-\r
- skills_trained_in_this_group = False\r
-\r
- # ... iterate over the skills in this group...\r
- for skill in g.skills:\r
-\r
- # see if we trained this skill by checking the character sheet object\r
- trained = sheet.skills.Get(skill.typeID, False)\r
- if trained:\r
- # yep, we trained this skill.\r
-\r
- # print the group name if we haven't done so already\r
- if not skills_trained_in_this_group:\r
- print g.groupName\r
- skills_trained_in_this_group = True\r
-\r
- # and display some info about the skill!\r
- print "- %s Rank(%d) - SP: %d/%d - Level: %d" %\\r
- (skill.typeName, skill.rank, trained.skillpoints, (skill.rank * sp[trained.level]), trained.level)\r
- total_skills += 1\r
- total_sp += trained.skillpoints\r
-\r
-\r
-# And to top it off, display totals.\r
-print "You currently have %d skills and %d skill points" % (total_skills, total_sp)\r
-\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 5: USING ROWSETS"\r
-print\r
-\r
-# For this one we will use the result1 that contains the alliance list from\r
-# the first example.\r
-rowset = result1.alliances\r
-\r
-# Now, what if we want to sort the alliances by ticker name. We could unpack\r
-# all alliances into a list and then use python's sort(key=...) on that list,\r
-# but that's not efficient. The rowset objects support sorting on columns\r
-# directly:\r
-rowset.SortBy("shortName")\r
-\r
-# Note the use of Select() here. The Select method speeds up iterating over\r
-# large rowsets considerably as no temporary row instances are created.\r
-for ticker in rowset.Select("shortName"):\r
- print ticker,\r
-print\r
-\r
-# The sort above modified the result inplace. There is another method, called\r
-# SortedBy, which returns a new rowset. \r
-\r
-print\r
-\r
-# Another useful method of rowsets is IndexBy, which enables you to do direct\r
-# key lookups on columns. We already used this feature in example 3. Indeed\r
-# most rowsets returned are IndexRowsets already if the data has a primary\r
-# key attribute defined in the <rowset> tag in the XML data.\r
-#\r
-# IndexRowsets are efficient, they reference the data from the rowset they\r
-# were created from, and create an index mapping on top of it.\r
-#\r
-# Anyway, to create an index:\r
-alliances_by_ticker = rowset.IndexedBy("shortName")\r
-\r
-# Now use the Get() method to get a row directly.\r
-# Assumes ISD alliance exists. If it doesn't, we probably have bigger\r
-# problems than the unhandled exception here -_-\r
-try:\r
- print alliances_by_ticker.Get("ISD")\r
-except :\r
- print "Blimey! CCP let the ISD alliance expire -AGAIN-. How inconvenient!"\r
-\r
-# You may specify a default to return in case the row wasn't found:\r
-print alliances_by_ticker.Get("123456", 42)\r
-\r
-# If no default was specified and you try to look up a key that does not\r
-# exist, an appropriate exception will be raised:\r
-try:\r
- print alliances_by_ticker.Get("123456")\r
-except KeyError:\r
- print "This concludes example 5"\r
-\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 6: CACHING DATA"\r
-print\r
-\r
-# For some calls you will want caching. To facilitate this, a customized\r
-# cache handler can be attached. Below is an example of a simple cache\r
-# handler. \r
-\r
-class MyCacheHandler(object):\r
- # Note: this is an example handler to demonstrate how to use them.\r
- # a -real- handler should probably be thread-safe and handle errors\r
- # properly (and perhaps use a better hashing scheme).\r
-\r
- def __init__(self, debug=False):\r
- self.debug = debug\r
- self.count = 0\r
- self.cache = {}\r
- self.tempdir = join(tempfile.gettempdir(), "eveapi")\r
- if not exists(self.tempdir):\r
- os.makedirs(self.tempdir)\r
-\r
- def log(self, what):\r
- if self.debug:\r
- print "[%d] %s" % (self.count, what)\r
-\r
- def retrieve(self, host, path, params):\r
- # eveapi asks if we have this request cached\r
- key = hash((host, path, frozenset(params.items())))\r
-\r
- self.count += 1 # for logging\r
-\r
- # see if we have the requested page cached...\r
- cached = self.cache.get(key, None)\r
- if cached:\r
- cacheFile = None\r
- #print "'%s': retrieving from memory" % path\r
- else:\r
- # it wasn't cached in memory, but it might be on disk.\r
- cacheFile = join(self.tempdir, str(key) + ".cache")\r
- if exists(cacheFile):\r
- self.log("%s: retrieving from disk" % path)\r
- f = open(cacheFile, "rb")\r
- cached = self.cache[key] = cPickle.loads(zlib.decompress(f.read()))\r
- f.close()\r
-\r
- if cached:\r
- # check if the cached doc is fresh enough\r
- if time.time() < cached[0]:\r
- self.log("%s: returning cached document" % path)\r
- return cached[1] # return the cached XML doc\r
-\r
- # it's stale. purge it.\r
- self.log("%s: cache expired, purging!" % path)\r
- del self.cache[key]\r
- if cacheFile:\r
- os.remove(cacheFile)\r
-\r
- self.log("%s: not cached, fetching from server..." % path)\r
- # we didn't get a cache hit so return None to indicate that the data\r
- # should be requested from the server.\r
- return None\r
-\r
- def store(self, host, path, params, doc, obj):\r
- # eveapi is asking us to cache an item\r
- key = hash((host, path, frozenset(params.items())))\r
-\r
- cachedFor = obj.cachedUntil - obj.currentTime\r
- if cachedFor:\r
- self.log("%s: cached (%d seconds)" % (path, cachedFor))\r
-\r
- cachedUntil = time.time() + cachedFor\r
-\r
- # store in memory\r
- cached = self.cache[key] = (cachedUntil, doc)\r
-\r
- # store in cache folder\r
- cacheFile = join(self.tempdir, str(key) + ".cache")\r
- f = open(cacheFile, "wb")\r
- f.write(zlib.compress(cPickle.dumps(cached, -1)))\r
- f.close()\r
-\r
-\r
-# Now try out the handler! Even though were initializing a new api object\r
-# here, a handler can be attached or removed from an existing one at any\r
-# time with its setcachehandler() method.\r
-cachedApi = eveapi.EVEAPIConnection(cacheHandler=MyCacheHandler(debug=True))\r
-\r
-# First time around this will fetch the document from the server. That is,\r
-# if this demo is run for the first time, otherwise it will attempt to load\r
-# the cache written to disk on the previous run.\r
-result = cachedApi.eve.SkillTree()\r
-\r
-# But the second time it should be returning the cached version\r
-result = cachedApi.eve.SkillTree()\r
-\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-print\r
-print "EXAMPLE 7: TRANSACTION DATA"\r
-print "(and doing more nifty stuff with rowsets)"\r
-print\r
-\r
-# okay since we have a caching api object now it is fairly safe to do this\r
-# example repeatedly without server locking you out for an hour every time!\r
-\r
-# Let's use the first character on the account (using the richest character\r
-# found in example 2). Note how we are chaining the various contexts here to\r
-# arrive directly at a character context. If you're not using any intermediate\r
-# contexts in the chain anyway, this is okay.\r
-me = cachedApi.auth(YOUR_USERID, YOUR_APIKEY).character(rich_charID)\r
-\r
-# Now fetch the journal. Since this character context was created through \r
-# the cachedApi object, it will still use the cachehandler from example 5.\r
-journal = me.WalletJournal()\r
-\r
-# Let's see how much we paid SCC in transaction tax in the first page\r
-# of data!\r
-\r
-# Righto, now we -could- sift through the rows and extract what we want,\r
-# but we can do it in a much more clever way using the GroupedBy method\r
-# of the rowset in the result. This creates a mapping that maps keys\r
-# to Rowsets of all rows with that key value in specified column.\r
-# These data structures are also quite efficient as the only extra data\r
-# created is the index and grouping.\r
-entriesByRefType = journal.entries.GroupedBy("refTypeID")\r
-\r
-# Also note that we're using a hardcoded refTypeID of 54 here. You're\r
-# supposed to use .eve.RefTypes() though (however they are not likely\r
-# to be changed anyway so we can get away with it)\r
-# Note the use of Select() to speed things up here.\r
-amount = 0.0\r
-date = 0\r
-for taxAmount, date in entriesByRefType[54].Select("amount", "date"):\r
- amount += -taxAmount\r
-\r
-print "You paid a %.2f ISK transaction tax since %s" %\\r
- (amount, time.asctime(time.gmtime(date)))\r
-\r
-\r
-# You might also want to see how much a certain item yielded you recently.\r
-typeName = "Expanded Cargohold II"\r
-amount = 0.0\r
-\r
-wallet = me.WalletTransactions()\r
-soldTx = wallet.transactions.GroupedBy("transactionType")["sell"]\r
-for row in soldTx.GroupedBy("typeName")[typeName]:\r
- amount += (row.quantity * row.price)\r
-\r
-print "%s sales yielded %.2f ISK since %s" %\\r
- (typeName, amount, time.asctime(time.gmtime(row.transactionDateTime)))\r
-\r
-# I'll leave walking the transaction pages as an excercise to the reader ;)\r
-# Please also see the eveapi module itself for more documentation.\r
-\r
-# That's all folks!\r
-\r
+++ /dev/null
-#-----------------------------------------------------------------------------\r
-# eveapi - EVE Online API access\r
-#\r
-# Copyright (c)2007 Jamie "Entity" van den Berge <entity@vapor.com>\r
-# \r
-# Permission is hereby granted, free of charge, to any person\r
-# obtaining a copy of this software and associated documentation\r
-# files (the "Software"), to deal in the Software without\r
-# restriction, including without limitation the rights to use,\r
-# copy, modify, merge, publish, distribute, sublicense, and/or sell\r
-# copies of the Software, and to permit persons to whom the\r
-# Software is furnished to do so, subject to the following\r
-# conditions:\r
-# \r
-# The above copyright notice and this permission notice shall be\r
-# included in all copies or substantial portions of the Software.\r
-#\r
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\r
-# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\r
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\r
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\r
-# OTHER DEALINGS IN THE SOFTWARE\r
-#\r
-#-----------------------------------------------------------------------------\r
-# Version: 1.1.1 - 10 Januari 2010\r
-# - Fixed bug that causes nested tags to not appear in rows of rowsets created\r
-# from normal Elements. This should fix the corp.MemberSecurity method,\r
-# which now returns all data for members. [jehed]\r
-#\r
-# Version: 1.1.0 - 15 Januari 2009\r
-# - Added Select() method to Rowset class. Using it avoids the creation of\r
-# temporary row instances, speeding up iteration considerably.\r
-# - Added ParseXML() function, which can be passed arbitrary API XML file or\r
-# string objects.\r
-# - Added support for proxy servers. A proxy can be specified globally or\r
-# per api connection instance. [suggestion by graalman]\r
-# - Some minor refactoring.\r
-# - Fixed deprecation warning when using Python 2.6.\r
-#\r
-# Version: 1.0.7 - 14 November 2008\r
-# - Added workaround for rowsets that are missing the (required!) columns\r
-# attribute. If missing, it will use the columns found in the first row.\r
-# Note that this is will still break when expecting columns, if the rowset\r
-# is empty. [Flux/Entity]\r
-#\r
-# Version: 1.0.6 - 18 July 2008\r
-# - Enabled expat text buffering to avoid content breaking up. [BigWhale]\r
-#\r
-# Version: 1.0.5 - 03 February 2008\r
-# - Added workaround to make broken XML responses (like the "row:name" bug in\r
-# eve/CharacterID) work as intended.\r
-# - Bogus datestamps before the epoch in XML responses are now set to 0 to\r
-# avoid breaking certain date/time functions. [Anathema Matou]\r
-#\r
-# Version: 1.0.4 - 23 December 2007\r
-# - Changed _autocast() to use timegm() instead of mktime(). [Invisible Hand]\r
-# - Fixed missing attributes of elements inside rows. [Elandra Tenari]\r
-#\r
-# Version: 1.0.3 - 13 December 2007\r
-# - Fixed keyless columns bugging out the parser (in CorporationSheet for ex.)\r
-#\r
-# Version: 1.0.2 - 12 December 2007\r
-# - Fixed parser not working with indented XML.\r
-#\r
-# Version: 1.0.1\r
-# - Some micro optimizations\r
-#\r
-# Version: 1.0\r
-# - Initial release\r
-#\r
-# Requirements:\r
-# Python 2.4+\r
-#\r
-#-----------------------------------------------------------------------------\r
-\r
-import httplib\r
-import urllib\r
-import copy\r
-\r
-from xml.parsers import expat\r
-from time import strptime\r
-from calendar import timegm\r
-\r
-proxy = None\r
-\r
-#-----------------------------------------------------------------------------\r
-\r
-class Error(StandardError):\r
- def __init__(self, code, message):\r
- self.code = code\r
- self.args = (message.rstrip("."),)\r
-\r
-\r
-def EVEAPIConnection(url="api.eve-online.com", cacheHandler=None, proxy=None):\r
- # Creates an API object through which you can call remote functions.\r
- #\r
- # The following optional arguments may be provided:\r
- #\r
- # url - root location of the EVEAPI server\r
- #\r
- # proxy - (host,port) specifying a proxy server through which to request\r
- # the API pages. Specifying a proxy overrides default proxy.\r
- #\r
- # cacheHandler - an object which must support the following interface:\r
- #\r
- # retrieve(host, path, params)\r
- #\r
- # Called when eveapi wants to fetch a document.\r
- # host is the address of the server, path is the full path to\r
- # the requested document, and params is a dict containing the\r
- # parameters passed to this api call (userID, apiKey etc).\r
- # The method MUST return one of the following types:\r
- #\r
- # None - if your cache did not contain this entry\r
- # str/unicode - eveapi will parse this as XML\r
- # Element - previously stored object as provided to store()\r
- # file-like object - eveapi will read() XML from the stream.\r
- #\r
- # store(host, path, params, doc, obj)\r
- #\r
- # Called when eveapi wants you to cache this item.\r
- # You can use obj to get the info about the object (cachedUntil\r
- # and currentTime, etc) doc is the XML document the object\r
- # was generated from. It's generally best to cache the XML, not\r
- # the object, unless you pickle the object. Note that this method\r
- # will only be called if you returned None in the retrieve() for\r
- # this object.\r
- #\r
-\r
- if url.lower().startswith("http://"):\r
- url = url[7:]\r
-\r
- if "/" in url:\r
- url, path = url.split("/", 1)\r
- else:\r
- path = ""\r
-\r
- ctx = _RootContext(None, path, {}, {})\r
- ctx._handler = cacheHandler\r
- ctx._host = url\r
- ctx._proxy = proxy or globals()["proxy"]\r
- return ctx\r
-\r
-\r
-def ParseXML(file_or_string):\r
- try:\r
- return _ParseXML(file_or_string, False, None)\r
- except TypeError:\r
- raise TypeError("XML data must be provided as string or file-like object")\r
-\r
-\r
-def _ParseXML(response, fromContext, storeFunc):\r
- # pre/post-process XML or Element data\r
-\r
- if fromContext and isinstance(response, Element):\r
- obj = response\r
- elif type(response) in (str, unicode):\r
- obj = _Parser().Parse(response, False)\r
- elif hasattr(response, "read"):\r
- obj = _Parser().Parse(response, True)\r
- else:\r
- raise TypeError("retrieve method must return None, string, file-like object or an Element instance")\r
-\r
- error = getattr(obj, "error", False)\r
- if error:\r
- raise Error(error.code, error.data)\r
-\r
- result = getattr(obj, "result", False)\r
- if not result:\r
- raise RuntimeError("API object does not contain result")\r
-\r
- if fromContext and storeFunc:\r
- # call the cache handler to store this object\r
- storeFunc(obj)\r
-\r
- # make metadata available to caller somehow\r
- result._meta = obj\r
-\r
- return result\r
-\r
-\r
- \r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-# API Classes\r
-#-----------------------------------------------------------------------------\r
-\r
-_listtypes = (list, tuple, dict)\r
-_unspecified = []\r
-\r
-class _Context(object):\r
-\r
- def __init__(self, root, path, parentDict, newKeywords=None):\r
- self._root = root or self\r
- self._path = path\r
- if newKeywords:\r
- if parentDict:\r
- self.parameters = parentDict.copy()\r
- else:\r
- self.parameters = {}\r
- self.parameters.update(newKeywords)\r
- else:\r
- self.parameters = parentDict or {}\r
-\r
- def context(self, *args, **kw):\r
- if kw or args:\r
- path = self._path\r
- if args:\r
- path += "/" + "/".join(args)\r
- return self.__class__(self._root, path, self.parameters, kw)\r
- else:\r
- return self\r
-\r
- def __getattr__(self, this):\r
- # perform arcane attribute majick trick\r
- return _Context(self._root, self._path + "/" + this, self.parameters)\r
-\r
- def __call__(self, **kw):\r
- if kw:\r
- # specified keywords override contextual ones\r
- for k, v in self.parameters.iteritems():\r
- if k not in kw:\r
- kw[k] = v\r
- else:\r
- # no keywords provided, just update with contextual ones.\r
- kw.update(self.parameters)\r
-\r
- # now let the root context handle it further\r
- return self._root(self._path, **kw)\r
-\r
-\r
-class _AuthContext(_Context):\r
-\r
- def character(self, characterID):\r
- # returns a copy of this connection object but for every call made\r
- # through it, it will add the folder "/char" to the url, and the\r
- # characterID to the parameters passed.\r
- return _Context(self._root, self._path + "/char", self.parameters, {"characterID":characterID})\r
-\r
- def corporation(self, characterID):\r
- # same as character except for the folder "/corp"\r
- return _Context(self._root, self._path + "/corp", self.parameters, {"characterID":characterID})\r
-\r
-\r
-class _RootContext(_Context):\r
-\r
- def auth(self, userID=None, apiKey=None):\r
- # returns a copy of this object but for every call made through it, the\r
- # userID and apiKey will be added to the API request.\r
- if userID and apiKey:\r
- return _AuthContext(self._root, self._path, self.parameters, {"userID":userID, "apiKey":apiKey})\r
- raise ValueError("Must specify userID and apiKey")\r
-\r
- def setcachehandler(self, handler):\r
- self._root._handler = handler\r
-\r
- def __call__(self, path, **kw):\r
- # convert list type arguments to something the API likes\r
- for k, v in kw.iteritems():\r
- if isinstance(v, _listtypes):\r
- kw[k] = ','.join(map(str, list(v)))\r
-\r
- cache = self._root._handler\r
-\r
- # now send the request\r
- path += ".xml.aspx"\r
-\r
- if cache:\r
- response = cache.retrieve(self._host, path, kw)\r
- else:\r
- response = None\r
-\r
- if response is None:\r
- if self._proxy is None:\r
- http = httplib.HTTPConnection(self._host)\r
- if kw:\r
- http.request("POST", path, urllib.urlencode(kw), {"Content-type": "application/x-www-form-urlencoded"})\r
- else:\r
- http.request("GET", path)\r
- else:\r
- http = httplib.HTTPConnection(*self._proxy)\r
- if kw:\r
- http.request("POST", 'http://'+self._host+path, urllib.urlencode(kw), {"Content-type": "application/x-www-form-urlencoded"})\r
- else:\r
- http.request("GET", 'http://'+self._host+path)\r
-\r
- response = http.getresponse()\r
- if response.status != 200:\r
- if response.status == httplib.NOT_FOUND:\r
- raise AttributeError("'%s' not available on API server (404 Not Found)" % path)\r
- else:\r
- raise RuntimeError("'%s' request failed (%d %s)" % (path, response.status, response.reason))\r
-\r
- if cache:\r
- store = True\r
- response = response.read()\r
- else:\r
- store = False\r
- else:\r
- store = False\r
-\r
- return _ParseXML(response, True, store and (lambda obj: cache.store(self._host, path, kw, response, obj)))\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-# XML Parser\r
-#-----------------------------------------------------------------------------\r
-\r
-def _autocast(s):\r
- # attempts to cast an XML string to the most probable type.\r
- try:\r
- if s.strip("-").isdigit():\r
- return int(s)\r
- except ValueError:\r
- pass\r
-\r
- try:\r
- return float(s)\r
- except ValueError:\r
- pass\r
-\r
- if len(s) == 19 and s[10] == ' ':\r
- # it could be a date string\r
- try:\r
- return max(0, int(timegm(strptime(s, "%Y-%m-%d %H:%M:%S"))))\r
- except OverflowError:\r
- pass\r
- except ValueError:\r
- pass\r
-\r
- # couldn't cast. return string unchanged.\r
- return s\r
-\r
-\r
-class _Parser(object):\r
-\r
- def Parse(self, data, isStream=False):\r
- self.container = self.root = None\r
- p = expat.ParserCreate()\r
- p.StartElementHandler = self.tag_start\r
- p.CharacterDataHandler = self.tag_cdata\r
- p.EndElementHandler = self.tag_end\r
- p.ordered_attributes = True\r
- p.buffer_text = True\r
-\r
- if isStream:\r
- p.ParseFile(data)\r
- else:\r
- p.Parse(data, True)\r
- return self.root\r
- \r
-\r
- def tag_start(self, name, attributes):\r
- # <hack>\r
- # If there's a colon in the tag name, cut off the name from the colon\r
- # onward. This is a workaround to make certain bugged XML responses\r
- # (such as eve/CharacterID.xml.aspx) work.\r
- if ":" in name:\r
- name = name[:name.index(":")]\r
- # </hack>\r
-\r
- if name == "rowset":\r
- # for rowsets, use the given name\r
- try:\r
- columns = attributes[attributes.index('columns')+1].split(",")\r
- except ValueError:\r
- # rowset did not have columns tag set (this is a bug in API)\r
- # columns will be extracted from first row instead.\r
- columns = []\r
-\r
- try:\r
- priKey = attributes[attributes.index('key')+1]\r
- this = IndexRowset(cols=columns, key=priKey)\r
- except ValueError:\r
- this = Rowset(cols=columns)\r
-\r
-\r
- this._name = attributes[attributes.index('name')+1]\r
- this.__catch = "row" # tag to auto-add to rowset.\r
- else:\r
- this = Element()\r
- this._name = name\r
-\r
- this.__parent = self.container\r
-\r
- if self.root is None:\r
- # We're at the root. The first tag has to be "eveapi" or we can't\r
- # really assume the rest of the xml is going to be what we expect.\r
- if name != "eveapi":\r
- raise RuntimeError("Invalid API response")\r
- self.root = this\r
-\r
- if isinstance(self.container, Rowset) and (self.container.__catch == this._name):\r
- # check for missing columns attribute (see above)\r
- if not self.container._cols:\r
- self.container._cols = attributes[0::2]\r
-\r
- self.container.append([_autocast(attributes[i]) for i in range(1, len(attributes), 2)])\r
- this._isrow = True\r
- this._attributes = this._attributes2 = None\r
- else:\r
- this._isrow = False\r
- this._attributes = attributes\r
- this._attributes2 = []\r
- \r
- self.container = this\r
-\r
-\r
- def tag_cdata(self, data):\r
- if data == "\r\n" or data.strip() != data:\r
- return\r
-\r
- this = self.container\r
- data = _autocast(data)\r
-\r
- if this._attributes:\r
- # this tag has attributes, so we can't simply assign the cdata\r
- # as an attribute to the parent tag, as we'll lose the current\r
- # tag's attributes then. instead, we'll assign the data as\r
- # attribute of this tag.\r
- this.data = data\r
- else:\r
- # this was a simple <tag>data</tag> without attributes.\r
- # we won't be doing anything with this actual tag so we can just\r
- # bind it to its parent (done by __tag_end)\r
- setattr(this.__parent, this._name, data)\r
-\r
-\r
- def tag_end(self, name):\r
- this = self.container\r
- if this is self.root:\r
- del this._attributes\r
- #this.__dict__.pop("_attributes", None)\r
- return\r
-\r
- # we're done with current tag, so we can pop it off. This means that\r
- # self.container will now point to the container of element 'this'.\r
- self.container = this.__parent\r
- del this.__parent\r
-\r
- attributes = this.__dict__.pop("_attributes")\r
- attributes2 = this.__dict__.pop("_attributes2")\r
- if attributes is None:\r
- # already processed this tag's closure early, in tag_start()\r
- return\r
-\r
- if self.container._isrow:\r
- # Special case here. tags inside a row! Such tags have to be\r
- # added as attributes of the row.\r
- parent = self.container.__parent\r
-\r
- # get the row line for this element from its parent rowset\r
- _row = parent._rows[-1]\r
-\r
- # add this tag's value to the end of the row\r
- _row.append(getattr(self.container, this._name, this))\r
-\r
- # fix columns if neccessary.\r
- if len(parent._cols) < len(_row):\r
- parent._cols.append(this._name)\r
- else:\r
- # see if there's already an attribute with this name (this shouldn't\r
- # really happen, but it doesn't hurt to handle this case!\r
- sibling = getattr(self.container, this._name, None)\r
- if sibling is None:\r
- self.container._attributes2.append(this._name)\r
- setattr(self.container, this._name, this)\r
- # Note: there aren't supposed to be any NON-rowset tags containing\r
- # multiples of some tag or attribute. Code below handles this case.\r
- elif isinstance(sibling, Rowset):\r
- # its doppelganger is a rowset, append this as a row to that.\r
- row = [_autocast(attributes[i]) for i in range(1, len(attributes), 2)]\r
- row.extend([getattr(this, col) for col in attributes2])\r
- sibling.append(row)\r
- elif isinstance(sibling, Element):\r
- # parent attribute is an element. This means we're dealing\r
- # with multiple of the same sub-tag. Change the attribute\r
- # into a Rowset, adding the sibling element and this one.\r
- rs = Rowset()\r
- rs.__catch = rs._name = this._name\r
- row = [_autocast(attributes[i]) for i in range(1, len(attributes), 2)]+[getattr(this, col) for col in attributes2]\r
- rs.append(row)\r
- row = [getattr(sibling, attributes[i]) for i in range(0, len(attributes), 2)]+[getattr(sibling, col) for col in attributes2]\r
- rs.append(row)\r
- rs._cols = [attributes[i] for i in range(0, len(attributes), 2)]+[col for col in attributes2]\r
- setattr(self.container, this._name, rs)\r
- else:\r
- # something else must have set this attribute already.\r
- # (typically the <tag>data</tag> case in tag_data())\r
- pass\r
-\r
- # Now fix up the attributes and be done with it.\r
- for i in range(1, len(attributes), 2):\r
- this.__dict__[attributes[i-1]] = _autocast(attributes[i])\r
-\r
- return\r
-\r
-\r
-\r
-\r
-#-----------------------------------------------------------------------------\r
-# XML Data Containers\r
-#-----------------------------------------------------------------------------\r
-# The following classes are the various container types the XML data is\r
-# unpacked into.\r
-#\r
-# Note that objects returned by API calls are to be treated as read-only. This\r
-# is not enforced, but you have been warned.\r
-#-----------------------------------------------------------------------------\r
-\r
-class Element(object):\r
- # Element is a namespace for attributes and nested tags\r
- def __str__(self):\r
- return "<Element '%s'>" % self._name\r
-\r
-\r
-class Row(object):\r
- # A Row is a single database record associated with a Rowset.\r
- # The fields in the record are accessed as attributes by their respective\r
- # column name.\r
- #\r
- # To conserve resources, Row objects are only created on-demand. This is\r
- # typically done by Rowsets (e.g. when iterating over the rowset).\r
- \r
- def __init__(self, cols=None, row=None):\r
- self._cols = cols or []\r
- self._row = row or []\r
-\r
- def __nonzero__(self):\r
- return True\r
-\r
- def __ne__(self, other):\r
- return self.__cmp__(other)\r
-\r
- def __eq__(self, other):\r
- return self.__cmp__(other) == 0\r
-\r
- def __cmp__(self, other):\r
- if type(other) != type(self):\r
- raise TypeError("Incompatible comparison type")\r
- return cmp(self._cols, other._cols) or cmp(self._row, other._row)\r
-\r
- def __getattr__(self, this):\r
- try:\r
- return self._row[self._cols.index(this)]\r
- except:\r
- raise AttributeError, this\r
-\r
- def __getitem__(self, this):\r
- return self._row[self._cols.index(this)]\r
-\r
- def __str__(self):\r
- return "Row(" + ','.join(map(lambda k, v: "%s:%s" % (str(k), str(v)), self._cols, self._row)) + ")"\r
-\r
-\r
-class Rowset(object):\r
- # Rowsets are collections of Row objects.\r
- #\r
- # Rowsets support most of the list interface:\r
- # iteration, indexing and slicing\r
- #\r
- # As well as the following methods: \r
- #\r
- # IndexedBy(column)\r
- # Returns an IndexRowset keyed on given column. Requires the column to\r
- # be usable as primary key.\r
- #\r
- # GroupedBy(column)\r
- # Returns a FilterRowset keyed on given column. FilterRowset objects\r
- # can be accessed like dicts. See FilterRowset class below.\r
- #\r
- # SortBy(column, reverse=True)\r
- # Sorts rowset in-place on given column. for a descending sort,\r
- # specify reversed=True.\r
- #\r
- # SortedBy(column, reverse=True)\r
- # Same as SortBy, except this retuens a new rowset object instead of\r
- # sorting in-place.\r
- #\r
- # Select(columns, row=False)\r
- # Yields a column values tuple (value, ...) for each row in the rowset.\r
- # If only one column is requested, then just the column value is\r
- # provided instead of the values tuple.\r
- # When row=True, each result will be decorated with the entire row.\r
- #\r
-\r
- def IndexedBy(self, column):\r
- return IndexRowset(self._cols, self._rows, column)\r
-\r
- def GroupedBy(self, column):\r
- return FilterRowset(self._cols, self._rows, column)\r
-\r
- def SortBy(self, column, reverse=False):\r
- ix = self._cols.index(column)\r
- self.sort(key=lambda e: e[ix], reverse=reverse)\r
-\r
- def SortedBy(self, column, reverse=False):\r
- rs = self[:]\r
- rs.SortBy(column, reverse)\r
- return rs\r
-\r
- def Select(self, *columns, **options):\r
- if len(columns) == 1:\r
- i = self._cols.index(columns[0])\r
- if options.get("row", False):\r
- for line in self._rows:\r
- yield (line, line[i])\r
- else:\r
- for line in self._rows:\r
- yield line[i]\r
- else:\r
- i = map(self._cols.index, columns)\r
- if options.get("row", False):\r
- for line in self._rows:\r
- yield line, [line[x] for x in i]\r
- else:\r
- for line in self._rows:\r
- yield [line[x] for x in i]\r
-\r
-\r
- # -------------\r
-\r
- def __init__(self, cols=None, rows=None):\r
- self._cols = cols or []\r
- self._rows = rows or []\r
-\r
- def append(self, row):\r
- if isinstance(row, list):\r
- self._rows.append(row)\r
- elif isinstance(row, Row) and len(row._cols) == len(self._cols):\r
- self._rows.append(row._row)\r
- else:\r
- raise TypeError("incompatible row type")\r
-\r
- def __add__(self, other):\r
- if isinstance(other, Rowset):\r
- if len(other._cols) == len(self._cols):\r
- self._rows += other._rows\r
- raise TypeError("rowset instance expected")\r
-\r
- def __nonzero__(self):\r
- return not not self._rows\r
-\r
- def __len__(self):\r
- return len(self._rows)\r
-\r
- def copy(self):\r
- return self[:]\r
-\r
- def __getitem__(self, ix):\r
- if type(ix) is slice:\r
- return Rowset(self._cols, self._rows[ix])\r
- return Row(self._cols, self._rows[ix])\r
-\r
- def sort(self, *args, **kw):\r
- self._rows.sort(*args, **kw)\r
-\r
- def __str__(self):\r
- return ("Rowset(columns=[%s], rows=%d)" % (','.join(self._cols), len(self)))\r
-\r
- def __getstate__(self):\r
- return (self._cols, self._rows)\r
-\r
- def __setstate__(self, state):\r
- self._cols, self._rows = state\r
-\r
-\r
-\r
-class IndexRowset(Rowset):\r
- # An IndexRowset is a Rowset that keeps an index on a column.\r
- #\r
- # The interface is the same as Rowset, but provides an additional method:\r
- #\r
- # Get(key [, default])\r
- # Returns the Row mapped to provided key in the index. If there is no\r
- # such key in the index, KeyError is raised unless a default value was\r
- # specified.\r
- #\r
-\r
- def Get(self, key, *default):\r
- row = self._items.get(key, None)\r
- if row is None:\r
- if default:\r
- return default[0]\r
- raise KeyError, key\r
- return Row(self._cols, row)\r
-\r
- # -------------\r
-\r
- def __init__(self, cols=None, rows=None, key=None):\r
- try:\r
- self._ki = ki = cols.index(key)\r
- except IndexError:\r
- raise ValueError("Rowset has no column %s" % key)\r
-\r
- Rowset.__init__(self, cols, rows)\r
- self._key = key\r
- self._items = dict((row[ki], row) for row in self._rows)\r
-\r
- def __getitem__(self, ix):\r
- if type(ix) is slice:\r
- return IndexRowset(self._cols, self._rows[ix], self._key)\r
- return Rowset.__getitem__(self, ix)\r
-\r
- def append(self, row):\r
- Rowset.append(self, row)\r
- self._items[row[self._ki]] = row\r
-\r
- def __getstate__(self):\r
- return (Rowset.__getstate__(self), self._items, self._ki)\r
-\r
- def __setstate__(self, state):\r
- state, self._items, self._ki = state\r
- Rowset.__setstate__(self, state)\r
-\r
-\r
-class FilterRowset(object):\r
- # A FilterRowset works much like an IndexRowset, with the following\r
- # differences:\r
- # - FilterRowsets are accessed much like dicts\r
- # - Each key maps to a Rowset, containing only the rows where the value\r
- # of the column this FilterRowset was made on matches the key.\r
-\r
- def __init__(self, cols=None, rows=None, key=None, key2=None, dict=None):\r
- if dict is not None:\r
- self._items = items = dict\r
- elif cols is not None:\r
- self._items = items = {}\r
-\r
- idfield = cols.index(key)\r
- if not key2:\r
- for row in rows:\r
- id = row[idfield]\r
- if id in items:\r
- items[id].append(row)\r
- else:\r
- items[id] = [row]\r
- else:\r
- idfield2 = cols.index(key2)\r
- for row in rows:\r
- id = row[idfield]\r
- if id in items:\r
- items[id][row[idfield2]] = row\r
- else:\r
- items[id] = {row[idfield2]:row}\r
-\r
- self._cols = cols\r
- self.key = key\r
- self.key2 = key2\r
- self._bind()\r
-\r
- def _bind(self):\r
- items = self._items\r
- self.keys = items.keys\r
- self.iterkeys = items.iterkeys\r
- self.__contains__ = items.__contains__\r
- self.has_key = items.has_key\r
- self.__len__ = items.__len__\r
- self.__iter__ = items.__iter__\r
-\r
- def copy(self):\r
- return FilterRowset(self._cols[:], None, self.key, self.key2, dict=copy.deepcopy(self._items))\r
-\r
- def get(self, key, default=_unspecified):\r
- try:\r
- return self[key]\r
- except KeyError:\r
- if default is _unspecified:\r
- raise\r
- return default\r
-\r
- def __getitem__(self, i):\r
- if self.key2:\r
- return IndexRowset(self._cols, None, self.key2, self._items.get(i, {}))\r
- return Rowset(self._cols, self._items[i])\r
-\r
- def __getstate__(self):\r
- return (self._cols, self._rows, self._items, self.key, self.key2)\r
-\r
- def __setstate__(self, state):\r
- self._cols, self._rows, self._items, self.key, self.key2 = state\r
- self._bind()\r
-\r
+++ /dev/null
-import urllib
-import os.path
-
-def portrait_filename( char_id, img_size ):
-
- err_img = 'imgs/error.jpg'
-
- # we can only accept 64 or 256... I know an exclamation point is not an error message, but I'll come back to this. FIXME --danny
- if not ( img_size == 64 or img_size == 256 ):
- return err_img
-
- # if asked for the large version, save it under a diff name --danny
- if img_size == 64:
- filename = "imgs/%s.jpg" % char_id
- elif img_size == 256:
- filename = "imgs/%s_lg.jpg" % char_id
-
- if os.path.isfile( filename ):
- return filename
-
- # specify size and cid --danny
- img_url = "http://img.eve.is/serv.asp?s=%s&c=%s" % ( str( img_size ), char_id )
-
- # fetch it, and hit the road. --danny
- try:
- urllib.urlretrieve( img_url, filename, report_handler )
- except ContentTooShortError:
- filename = err_img
- return filename
-
-def report_handler( *a ):
- ( blocks_transferred, block_size, total_size ) = a
+++ /dev/null
-#
-# mEveMon - A character monitor for EVE Online
-# Copyright (c) 2010 Ryan and Danny Campbell, and the mEveMon Team
-#
-# mEveMon is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3 of the License, or
-# (at your option) any later version.
-#
-# mEveMon 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-
-import hildon
-import gtk
-from eveapi import eveapi
-import fetchimg
-import apicache
-
-# we will store our preferences in gconf
-import gnome.gconf
-
-#ugly hack to check maemo version. any better way?
-if hasattr(hildon, "StackableWindow"):
- from ui.fremantle import ui
-else:
- from ui.diablo import ui
-
-class mEveMon():
- def __init__(self):
- self.program = hildon.Program()
- self.program.__init__()
- self.gconf = gnome.gconf.client_get_default()
- self.set_auth()
- self.ui = ui.mEveMonUI(self)
-
- def run(self):
- gtk.main()
-
- def quit(self, *args):
- gtk.main_quit()
-
- def get_api_key(self):
- return self.gconf.get_string("/apps/maemo/mevemon/eve_api_key") or ''
-
- def get_uid(self):
- return self.gconf.get_string("/apps/maemo/mevemon/eve_uid") or ''
-
- def set_api_key(self, key):
- self.gconf.set_string("/apps/maemo/mevemon/eve_api_key", key)
-
- def set_uid(self, uid):
- self.gconf.set_string("/apps/maemo/mevemon/eve_uid", uid)
-
-
- def set_auth(self):
- """
- set self.auth to None if there was a problem. somehow later on we'll
- have to pass the error to the UI, but for now I just want the program
- to not be broken. --danny
- """
- uid = self.get_uid()
- api_key = self.get_api_key()
- self.cached_api = eveapi.EVEAPIConnection( cacheHandler = \
- apicache.cache_handler( debug = False ) )
- try:
- self.auth = self.cached_api.auth( userID = uid, apiKey = api_key )
- except eveapi.Error, e:
- # we need to deal with this, so raise --danny
- raise
- except ValueError, e:
- self.auth = None
- #raise
-
- def get_auth(self):
- return self.auth
-
- def get_char_sheet(self, charID):
- if not self.auth: return None
- try:
- sheet = self.auth.character(charID).CharacterSheet()
- except eveapi.Error, e:
- # we should really have a logger that logs this error somewhere
- return None
-
- return sheet
-
- def char_id2name(self, charID):
- # the api can take a comma-seperated list of ids, but we'll just take
- # a single id for now
- try:
- chars = self.cached_api.eve.CharacterName(ids=charID).characters
- name = chars[0].characterName
- except eveapi.Error, e:
- return None
-
- return name
-
- def char_name2id(self, name):
- # the api can take a comma-seperated list of names, but we'll just take
- # a single name for now
- try:
- chars = self.cached_api.eve.CharacterID(names=name).characters
- char_id = chars[0].characterID
- except eveapi.Error, e:
- return None
-
- return char_id
-
-
- def get_characters( self ):
- """
- returns a list containing a single character with an error message for a
- name, if there's a problem. FIXME --danny
- """
- ui_char_list = []
- placeholder_chars = [("Please check your API settings.", "imgs/error.jpg")]
- if not self.auth: return placeholder_chars
- try:
- api_char_list = self.auth.account.Characters()
- # append each char we get to the list we'll return to the
- # UI --danny
- for character in api_char_list.characters:
- ui_char_list.append( ( character.name, fetchimg.portrait_filename( character.characterID, 64 ) ) )
- except eveapi.Error, e:
- # again, we need to handle this... --danny
- raise
-
- return ui_char_list
-
- def get_portrait(self, char_name, size):
- """
- returns the relative path of the retrieved portrait
- """
- charID = self.char_name2id(char_name)
- return fetchimg.portrait_filename(charID, size)
-
-if __name__ == "__main__":
- app = mEveMon()
- app.run()
--- /dev/null
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
--- /dev/null
+import time
+import tempfile
+import cPickle
+import zlib
+import os
+from os.path import join, exists
+
+class cache_handler( object ):
+ # adapted from http://home.wanadoo.nl/ntt/eve/library/files/api/apitest.py (does this satisfy the terms of the license?), will need work, but we need basic cache functionality... I feel guilty for abusing the server. FIXME --danny
+
+ def __init__( self, debug = False ):
+ self.debug = debug
+ self.count = 0
+ self.cache = {}
+ self.tempdir = join( tempfile.gettempdir(), "eveapi" )
+ if not exists( self.tempdir ):
+ os.makedirs( self.tempdir )
+
+ # remove this later --danny
+ def log( self, what ):
+ if self.debug:
+ print "[%d] %s" % ( self.count, what )
+
+ def retrieve( self, host, path, params ):
+ # eveapi asks if we have this request cached
+ key = hash( ( host, path, frozenset( params.items() ) ) )
+
+ # for logging
+ self.count += 1
+
+ # see if we have the requested page cached...
+ cached = self.cache.get( key, None )
+ if cached:
+ cacheFile = None
+ else:
+ # not in memory, maybe on disk --danny
+ cacheFile = join( self.tempdir, str( key ) + ".cache" )
+ if exists( cacheFile ):
+ self.log( "%s: retreiving from disk." % path )
+ f = open( cacheFile, "rb" )
+ cached = self.cache[key] = cPickle.loads( zlib.decompress( f.read() ) )
+ f.close()
+
+ if cached:
+ # check if the cached doc is fresh enough
+ if time.time() < cached[0]:
+ self.log( "%s: returning cached document." % path )
+ # return the cached XML doc
+ return cached[1]
+
+ # if it's stale, purge it --danny
+ self.log( "%s: cache expired, purging!" % path )
+ del self.cache[key]
+ if cacheFile:
+ os.remove( cacheFile )
+
+ self.log( "%s: not cached, fetching from server..." % path )
+ # We didn't get a cache hit so return None to indicate that the data should be requested from server
+ return None
+
+ def store( self, host, path, params, doc, obj ):
+ # eveapi is asking us to cache an item
+ key = hash( ( host, path, frozenset( params.items() ) ) )
+
+ cachedFor = obj.cachedUntil - obj.currentTime
+ if cachedFor:
+ self.log( "%s: cached (%d seconds)." % ( path, cachedFor ) )
+
+ cachedUntil = time.time() + cachedFor
+
+ # store in memory
+ cached = self.cache[key] = ( cachedUntil, doc )
+
+ # store in cache folder
+ cacheFile = join( self.tempdir, str( key ) + ".cache" )
+ f = open( cacheFile, "wb" )
+ f.write( zlib.compress( cPickle.dumps( cached, -1 ) ) )
+ f.close
+
+
--- /dev/null
+#=============================================================================\r
+# eveapi module demonstration script - Jamie van den Berge\r
+#=============================================================================\r
+#\r
+# This file is in the Public Domain - Do with it as you please.\r
+# \r
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\r
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\r
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\r
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\r
+# OTHER DEALINGS IN THE SOFTWARE\r
+#\r
+#----------------------------------------------------------------------------\r
+# Put your userID and apiKey (full access) here before running this script.\r
+YOUR_USERID = 123456\r
+YOUR_APIKEY = "hPx6rxdYfVNeGcuOgPKRL-ohhithere-aUg6OfxCtMH4FUn5GUzf8YqIQDdc5gF7"\r
+\r
+import time\r
+import tempfile\r
+import cPickle\r
+import zlib\r
+import os\r
+from os.path import join, exists\r
+from httplib import HTTPException\r
+\r
+import eveapi\r
+\r
+api = eveapi.EVEAPIConnection()\r
+\r
+#----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 1: GETTING THE ALLIANCE LIST"\r
+print " (and showing alliances with 1000 or more members)"\r
+print\r
+\r
+# Let's get the list of alliances.\r
+# The API function we need to get the list is:\r
+#\r
+# /eve/AllianceList.xml.aspx\r
+#\r
+# There is a 1:1 correspondence between folders/files and attributes on api\r
+# objects, so to call this particular function, we simply do this:\r
+result1 = api.eve.AllianceList()\r
+\r
+# This result contains a rowset object called "alliances". Rowsets are like\r
+# database tables and you can do various useful things with them. For now\r
+# we'll just iterate over it and display all alliances with more than 1000\r
+# members:\r
+for alliance in result1.alliances:\r
+ if alliance.memberCount >= 1000:\r
+ print "%s <%s> has %d members" %\\r
+ (alliance.name, alliance.shortName, alliance.memberCount)\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 2: GETTING WALLET BALANCE OF ALL YOUR CHARACTERS"\r
+print\r
+\r
+# To get any info on character/corporation related stuff, we need to acquire\r
+# an authentication context. All API requests that require authentication need\r
+# to be called through this object. While it is possible to call such API\r
+# functions directly through the api object, you would have to specify the\r
+# userID and apiKey on every call. If you are iterating over many accounts,\r
+# that may actually be the better option. However, for these examples we only\r
+# use one account, so this is more convenient.\r
+auth = api.auth(userID=YOUR_USERID, apiKey=YOUR_APIKEY)\r
+\r
+# Now let's say you want to the wallet balance of all your characters.\r
+# The API function we need to get the characters on your account is:\r
+#\r
+# /account/Characters.xml.aspx\r
+#\r
+# As in example 1, this simply means adding folder names as attributes\r
+# and calling the function named after the base page name:\r
+result2 = auth.account.Characters()\r
+\r
+# Some tracking for later examples.\r
+rich = 0\r
+rich_charID = 0\r
+\r
+# Now the best way to iterate over the characters on your account and show\r
+# the isk balance is probably this way:\r
+for character in result2.characters:\r
+ wallet = auth.char.AccountBalance(characterID=character.characterID)\r
+ isk = wallet.accounts[0].balance\r
+ print character.name, "has", isk, "ISK."\r
+\r
+ if isk > rich:\r
+ rich = isk\r
+ rich_charID = character.characterID\r
+\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 3: WHEN STUFF GOES WRONG"\r
+print\r
+\r
+# Obviously you cannot assume an API call to succeed. There's a myriad of\r
+# things that can go wrong:\r
+#\r
+# - Connection error\r
+# - Server error\r
+# - Invalid parameters passed\r
+# - Hamsters died\r
+#\r
+# Therefor it is important to handle errors properly. eveapi will raise\r
+# an AttributeError if the requested function does not exist on the server\r
+# (ie. when it returns a 404), a RuntimeError on any other webserver error\r
+# (such as 500 Internal Server error).\r
+# On top of this, you can get any of the httplib (which eveapi uses) and\r
+# socket (which httplib uses) exceptions so you might want to catch those\r
+# as well.\r
+#\r
+\r
+try:\r
+ # Try calling account/Characters without authentication context\r
+ api.account.Characters()\r
+except eveapi.Error, e:\r
+ print "Oops! eveapi returned the following error:"\r
+ print "code:", e.code\r
+ print "message:", e.message\r
+except Exception, e:\r
+ print "Something went horribly wrong:", str(e)\r
+ raise\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 4: GETTING CHARACTER SHEET INFORMATION"\r
+print\r
+\r
+# We grab ourselves a character context object.\r
+# Note that this is a convenience function that takes care of passing the\r
+# characterID=x parameter to every API call much like auth() does (in fact\r
+# it's exactly like that, apart from the fact it also automatically adds the\r
+# "/char" folder). Again, it is possible to use the API functions directly\r
+# from the api or auth context, but then you have to provide the missing\r
+# keywords on every call (characterID in this case).\r
+#\r
+# The victim we'll use is the last character on the account we used in\r
+# example 1.\r
+me = auth.character(result2.characters[-1].characterID)\r
+\r
+# Now that we have a character context, we can display skills trained on\r
+# a character. First we have to get the skill tree. A real application\r
+# would cache this data; all objects returned by the api interface can be\r
+# pickled.\r
+skilltree = api.eve.SkillTree()\r
+\r
+# Now we have to fetch the charactersheet.\r
+# Note that the call below is identical to:\r
+#\r
+# acc.char.CharacterSheet(characterID=your_character_id)\r
+#\r
+# But, as explained above, the context ("me") we created automatically takes\r
+# care of adding the characterID parameter and /char folder attribute.\r
+sheet = me.CharacterSheet()\r
+\r
+# This list should look familiar. They're the skillpoints at each level for\r
+# a rank 1 skill. We could use the formula, but this is much simpler :)\r
+sp = [0, 250, 1414, 8000, 45255, 256000]\r
+\r
+total_sp = 0\r
+total_skills = 0\r
+\r
+# Now the fun bit starts. We walk the skill tree, and for every group in the\r
+# tree...\r
+for g in skilltree.skillGroups:\r
+\r
+ skills_trained_in_this_group = False\r
+\r
+ # ... iterate over the skills in this group...\r
+ for skill in g.skills:\r
+\r
+ # see if we trained this skill by checking the character sheet object\r
+ trained = sheet.skills.Get(skill.typeID, False)\r
+ if trained:\r
+ # yep, we trained this skill.\r
+\r
+ # print the group name if we haven't done so already\r
+ if not skills_trained_in_this_group:\r
+ print g.groupName\r
+ skills_trained_in_this_group = True\r
+\r
+ # and display some info about the skill!\r
+ print "- %s Rank(%d) - SP: %d/%d - Level: %d" %\\r
+ (skill.typeName, skill.rank, trained.skillpoints, (skill.rank * sp[trained.level]), trained.level)\r
+ total_skills += 1\r
+ total_sp += trained.skillpoints\r
+\r
+\r
+# And to top it off, display totals.\r
+print "You currently have %d skills and %d skill points" % (total_skills, total_sp)\r
+\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 5: USING ROWSETS"\r
+print\r
+\r
+# For this one we will use the result1 that contains the alliance list from\r
+# the first example.\r
+rowset = result1.alliances\r
+\r
+# Now, what if we want to sort the alliances by ticker name. We could unpack\r
+# all alliances into a list and then use python's sort(key=...) on that list,\r
+# but that's not efficient. The rowset objects support sorting on columns\r
+# directly:\r
+rowset.SortBy("shortName")\r
+\r
+# Note the use of Select() here. The Select method speeds up iterating over\r
+# large rowsets considerably as no temporary row instances are created.\r
+for ticker in rowset.Select("shortName"):\r
+ print ticker,\r
+print\r
+\r
+# The sort above modified the result inplace. There is another method, called\r
+# SortedBy, which returns a new rowset. \r
+\r
+print\r
+\r
+# Another useful method of rowsets is IndexBy, which enables you to do direct\r
+# key lookups on columns. We already used this feature in example 3. Indeed\r
+# most rowsets returned are IndexRowsets already if the data has a primary\r
+# key attribute defined in the <rowset> tag in the XML data.\r
+#\r
+# IndexRowsets are efficient, they reference the data from the rowset they\r
+# were created from, and create an index mapping on top of it.\r
+#\r
+# Anyway, to create an index:\r
+alliances_by_ticker = rowset.IndexedBy("shortName")\r
+\r
+# Now use the Get() method to get a row directly.\r
+# Assumes ISD alliance exists. If it doesn't, we probably have bigger\r
+# problems than the unhandled exception here -_-\r
+try:\r
+ print alliances_by_ticker.Get("ISD")\r
+except :\r
+ print "Blimey! CCP let the ISD alliance expire -AGAIN-. How inconvenient!"\r
+\r
+# You may specify a default to return in case the row wasn't found:\r
+print alliances_by_ticker.Get("123456", 42)\r
+\r
+# If no default was specified and you try to look up a key that does not\r
+# exist, an appropriate exception will be raised:\r
+try:\r
+ print alliances_by_ticker.Get("123456")\r
+except KeyError:\r
+ print "This concludes example 5"\r
+\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 6: CACHING DATA"\r
+print\r
+\r
+# For some calls you will want caching. To facilitate this, a customized\r
+# cache handler can be attached. Below is an example of a simple cache\r
+# handler. \r
+\r
+class MyCacheHandler(object):\r
+ # Note: this is an example handler to demonstrate how to use them.\r
+ # a -real- handler should probably be thread-safe and handle errors\r
+ # properly (and perhaps use a better hashing scheme).\r
+\r
+ def __init__(self, debug=False):\r
+ self.debug = debug\r
+ self.count = 0\r
+ self.cache = {}\r
+ self.tempdir = join(tempfile.gettempdir(), "eveapi")\r
+ if not exists(self.tempdir):\r
+ os.makedirs(self.tempdir)\r
+\r
+ def log(self, what):\r
+ if self.debug:\r
+ print "[%d] %s" % (self.count, what)\r
+\r
+ def retrieve(self, host, path, params):\r
+ # eveapi asks if we have this request cached\r
+ key = hash((host, path, frozenset(params.items())))\r
+\r
+ self.count += 1 # for logging\r
+\r
+ # see if we have the requested page cached...\r
+ cached = self.cache.get(key, None)\r
+ if cached:\r
+ cacheFile = None\r
+ #print "'%s': retrieving from memory" % path\r
+ else:\r
+ # it wasn't cached in memory, but it might be on disk.\r
+ cacheFile = join(self.tempdir, str(key) + ".cache")\r
+ if exists(cacheFile):\r
+ self.log("%s: retrieving from disk" % path)\r
+ f = open(cacheFile, "rb")\r
+ cached = self.cache[key] = cPickle.loads(zlib.decompress(f.read()))\r
+ f.close()\r
+\r
+ if cached:\r
+ # check if the cached doc is fresh enough\r
+ if time.time() < cached[0]:\r
+ self.log("%s: returning cached document" % path)\r
+ return cached[1] # return the cached XML doc\r
+\r
+ # it's stale. purge it.\r
+ self.log("%s: cache expired, purging!" % path)\r
+ del self.cache[key]\r
+ if cacheFile:\r
+ os.remove(cacheFile)\r
+\r
+ self.log("%s: not cached, fetching from server..." % path)\r
+ # we didn't get a cache hit so return None to indicate that the data\r
+ # should be requested from the server.\r
+ return None\r
+\r
+ def store(self, host, path, params, doc, obj):\r
+ # eveapi is asking us to cache an item\r
+ key = hash((host, path, frozenset(params.items())))\r
+\r
+ cachedFor = obj.cachedUntil - obj.currentTime\r
+ if cachedFor:\r
+ self.log("%s: cached (%d seconds)" % (path, cachedFor))\r
+\r
+ cachedUntil = time.time() + cachedFor\r
+\r
+ # store in memory\r
+ cached = self.cache[key] = (cachedUntil, doc)\r
+\r
+ # store in cache folder\r
+ cacheFile = join(self.tempdir, str(key) + ".cache")\r
+ f = open(cacheFile, "wb")\r
+ f.write(zlib.compress(cPickle.dumps(cached, -1)))\r
+ f.close()\r
+\r
+\r
+# Now try out the handler! Even though were initializing a new api object\r
+# here, a handler can be attached or removed from an existing one at any\r
+# time with its setcachehandler() method.\r
+cachedApi = eveapi.EVEAPIConnection(cacheHandler=MyCacheHandler(debug=True))\r
+\r
+# First time around this will fetch the document from the server. That is,\r
+# if this demo is run for the first time, otherwise it will attempt to load\r
+# the cache written to disk on the previous run.\r
+result = cachedApi.eve.SkillTree()\r
+\r
+# But the second time it should be returning the cached version\r
+result = cachedApi.eve.SkillTree()\r
+\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+print\r
+print "EXAMPLE 7: TRANSACTION DATA"\r
+print "(and doing more nifty stuff with rowsets)"\r
+print\r
+\r
+# okay since we have a caching api object now it is fairly safe to do this\r
+# example repeatedly without server locking you out for an hour every time!\r
+\r
+# Let's use the first character on the account (using the richest character\r
+# found in example 2). Note how we are chaining the various contexts here to\r
+# arrive directly at a character context. If you're not using any intermediate\r
+# contexts in the chain anyway, this is okay.\r
+me = cachedApi.auth(YOUR_USERID, YOUR_APIKEY).character(rich_charID)\r
+\r
+# Now fetch the journal. Since this character context was created through \r
+# the cachedApi object, it will still use the cachehandler from example 5.\r
+journal = me.WalletJournal()\r
+\r
+# Let's see how much we paid SCC in transaction tax in the first page\r
+# of data!\r
+\r
+# Righto, now we -could- sift through the rows and extract what we want,\r
+# but we can do it in a much more clever way using the GroupedBy method\r
+# of the rowset in the result. This creates a mapping that maps keys\r
+# to Rowsets of all rows with that key value in specified column.\r
+# These data structures are also quite efficient as the only extra data\r
+# created is the index and grouping.\r
+entriesByRefType = journal.entries.GroupedBy("refTypeID")\r
+\r
+# Also note that we're using a hardcoded refTypeID of 54 here. You're\r
+# supposed to use .eve.RefTypes() though (however they are not likely\r
+# to be changed anyway so we can get away with it)\r
+# Note the use of Select() to speed things up here.\r
+amount = 0.0\r
+date = 0\r
+for taxAmount, date in entriesByRefType[54].Select("amount", "date"):\r
+ amount += -taxAmount\r
+\r
+print "You paid a %.2f ISK transaction tax since %s" %\\r
+ (amount, time.asctime(time.gmtime(date)))\r
+\r
+\r
+# You might also want to see how much a certain item yielded you recently.\r
+typeName = "Expanded Cargohold II"\r
+amount = 0.0\r
+\r
+wallet = me.WalletTransactions()\r
+soldTx = wallet.transactions.GroupedBy("transactionType")["sell"]\r
+for row in soldTx.GroupedBy("typeName")[typeName]:\r
+ amount += (row.quantity * row.price)\r
+\r
+print "%s sales yielded %.2f ISK since %s" %\\r
+ (typeName, amount, time.asctime(time.gmtime(row.transactionDateTime)))\r
+\r
+# I'll leave walking the transaction pages as an excercise to the reader ;)\r
+# Please also see the eveapi module itself for more documentation.\r
+\r
+# That's all folks!\r
+\r
--- /dev/null
+#-----------------------------------------------------------------------------\r
+# eveapi - EVE Online API access\r
+#\r
+# Copyright (c)2007 Jamie "Entity" van den Berge <entity@vapor.com>\r
+# \r
+# Permission is hereby granted, free of charge, to any person\r
+# obtaining a copy of this software and associated documentation\r
+# files (the "Software"), to deal in the Software without\r
+# restriction, including without limitation the rights to use,\r
+# copy, modify, merge, publish, distribute, sublicense, and/or sell\r
+# copies of the Software, and to permit persons to whom the\r
+# Software is furnished to do so, subject to the following\r
+# conditions:\r
+# \r
+# The above copyright notice and this permission notice shall be\r
+# included in all copies or substantial portions of the Software.\r
+#\r
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\r
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\r
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\r
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\r
+# OTHER DEALINGS IN THE SOFTWARE\r
+#\r
+#-----------------------------------------------------------------------------\r
+# Version: 1.1.1 - 10 Januari 2010\r
+# - Fixed bug that causes nested tags to not appear in rows of rowsets created\r
+# from normal Elements. This should fix the corp.MemberSecurity method,\r
+# which now returns all data for members. [jehed]\r
+#\r
+# Version: 1.1.0 - 15 Januari 2009\r
+# - Added Select() method to Rowset class. Using it avoids the creation of\r
+# temporary row instances, speeding up iteration considerably.\r
+# - Added ParseXML() function, which can be passed arbitrary API XML file or\r
+# string objects.\r
+# - Added support for proxy servers. A proxy can be specified globally or\r
+# per api connection instance. [suggestion by graalman]\r
+# - Some minor refactoring.\r
+# - Fixed deprecation warning when using Python 2.6.\r
+#\r
+# Version: 1.0.7 - 14 November 2008\r
+# - Added workaround for rowsets that are missing the (required!) columns\r
+# attribute. If missing, it will use the columns found in the first row.\r
+# Note that this is will still break when expecting columns, if the rowset\r
+# is empty. [Flux/Entity]\r
+#\r
+# Version: 1.0.6 - 18 July 2008\r
+# - Enabled expat text buffering to avoid content breaking up. [BigWhale]\r
+#\r
+# Version: 1.0.5 - 03 February 2008\r
+# - Added workaround to make broken XML responses (like the "row:name" bug in\r
+# eve/CharacterID) work as intended.\r
+# - Bogus datestamps before the epoch in XML responses are now set to 0 to\r
+# avoid breaking certain date/time functions. [Anathema Matou]\r
+#\r
+# Version: 1.0.4 - 23 December 2007\r
+# - Changed _autocast() to use timegm() instead of mktime(). [Invisible Hand]\r
+# - Fixed missing attributes of elements inside rows. [Elandra Tenari]\r
+#\r
+# Version: 1.0.3 - 13 December 2007\r
+# - Fixed keyless columns bugging out the parser (in CorporationSheet for ex.)\r
+#\r
+# Version: 1.0.2 - 12 December 2007\r
+# - Fixed parser not working with indented XML.\r
+#\r
+# Version: 1.0.1\r
+# - Some micro optimizations\r
+#\r
+# Version: 1.0\r
+# - Initial release\r
+#\r
+# Requirements:\r
+# Python 2.4+\r
+#\r
+#-----------------------------------------------------------------------------\r
+\r
+import httplib\r
+import urllib\r
+import copy\r
+\r
+from xml.parsers import expat\r
+from time import strptime\r
+from calendar import timegm\r
+\r
+proxy = None\r
+\r
+#-----------------------------------------------------------------------------\r
+\r
+class Error(StandardError):\r
+ def __init__(self, code, message):\r
+ self.code = code\r
+ self.args = (message.rstrip("."),)\r
+\r
+\r
+def EVEAPIConnection(url="api.eve-online.com", cacheHandler=None, proxy=None):\r
+ # Creates an API object through which you can call remote functions.\r
+ #\r
+ # The following optional arguments may be provided:\r
+ #\r
+ # url - root location of the EVEAPI server\r
+ #\r
+ # proxy - (host,port) specifying a proxy server through which to request\r
+ # the API pages. Specifying a proxy overrides default proxy.\r
+ #\r
+ # cacheHandler - an object which must support the following interface:\r
+ #\r
+ # retrieve(host, path, params)\r
+ #\r
+ # Called when eveapi wants to fetch a document.\r
+ # host is the address of the server, path is the full path to\r
+ # the requested document, and params is a dict containing the\r
+ # parameters passed to this api call (userID, apiKey etc).\r
+ # The method MUST return one of the following types:\r
+ #\r
+ # None - if your cache did not contain this entry\r
+ # str/unicode - eveapi will parse this as XML\r
+ # Element - previously stored object as provided to store()\r
+ # file-like object - eveapi will read() XML from the stream.\r
+ #\r
+ # store(host, path, params, doc, obj)\r
+ #\r
+ # Called when eveapi wants you to cache this item.\r
+ # You can use obj to get the info about the object (cachedUntil\r
+ # and currentTime, etc) doc is the XML document the object\r
+ # was generated from. It's generally best to cache the XML, not\r
+ # the object, unless you pickle the object. Note that this method\r
+ # will only be called if you returned None in the retrieve() for\r
+ # this object.\r
+ #\r
+\r
+ if url.lower().startswith("http://"):\r
+ url = url[7:]\r
+\r
+ if "/" in url:\r
+ url, path = url.split("/", 1)\r
+ else:\r
+ path = ""\r
+\r
+ ctx = _RootContext(None, path, {}, {})\r
+ ctx._handler = cacheHandler\r
+ ctx._host = url\r
+ ctx._proxy = proxy or globals()["proxy"]\r
+ return ctx\r
+\r
+\r
+def ParseXML(file_or_string):\r
+ try:\r
+ return _ParseXML(file_or_string, False, None)\r
+ except TypeError:\r
+ raise TypeError("XML data must be provided as string or file-like object")\r
+\r
+\r
+def _ParseXML(response, fromContext, storeFunc):\r
+ # pre/post-process XML or Element data\r
+\r
+ if fromContext and isinstance(response, Element):\r
+ obj = response\r
+ elif type(response) in (str, unicode):\r
+ obj = _Parser().Parse(response, False)\r
+ elif hasattr(response, "read"):\r
+ obj = _Parser().Parse(response, True)\r
+ else:\r
+ raise TypeError("retrieve method must return None, string, file-like object or an Element instance")\r
+\r
+ error = getattr(obj, "error", False)\r
+ if error:\r
+ raise Error(error.code, error.data)\r
+\r
+ result = getattr(obj, "result", False)\r
+ if not result:\r
+ raise RuntimeError("API object does not contain result")\r
+\r
+ if fromContext and storeFunc:\r
+ # call the cache handler to store this object\r
+ storeFunc(obj)\r
+\r
+ # make metadata available to caller somehow\r
+ result._meta = obj\r
+\r
+ return result\r
+\r
+\r
+ \r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+# API Classes\r
+#-----------------------------------------------------------------------------\r
+\r
+_listtypes = (list, tuple, dict)\r
+_unspecified = []\r
+\r
+class _Context(object):\r
+\r
+ def __init__(self, root, path, parentDict, newKeywords=None):\r
+ self._root = root or self\r
+ self._path = path\r
+ if newKeywords:\r
+ if parentDict:\r
+ self.parameters = parentDict.copy()\r
+ else:\r
+ self.parameters = {}\r
+ self.parameters.update(newKeywords)\r
+ else:\r
+ self.parameters = parentDict or {}\r
+\r
+ def context(self, *args, **kw):\r
+ if kw or args:\r
+ path = self._path\r
+ if args:\r
+ path += "/" + "/".join(args)\r
+ return self.__class__(self._root, path, self.parameters, kw)\r
+ else:\r
+ return self\r
+\r
+ def __getattr__(self, this):\r
+ # perform arcane attribute majick trick\r
+ return _Context(self._root, self._path + "/" + this, self.parameters)\r
+\r
+ def __call__(self, **kw):\r
+ if kw:\r
+ # specified keywords override contextual ones\r
+ for k, v in self.parameters.iteritems():\r
+ if k not in kw:\r
+ kw[k] = v\r
+ else:\r
+ # no keywords provided, just update with contextual ones.\r
+ kw.update(self.parameters)\r
+\r
+ # now let the root context handle it further\r
+ return self._root(self._path, **kw)\r
+\r
+\r
+class _AuthContext(_Context):\r
+\r
+ def character(self, characterID):\r
+ # returns a copy of this connection object but for every call made\r
+ # through it, it will add the folder "/char" to the url, and the\r
+ # characterID to the parameters passed.\r
+ return _Context(self._root, self._path + "/char", self.parameters, {"characterID":characterID})\r
+\r
+ def corporation(self, characterID):\r
+ # same as character except for the folder "/corp"\r
+ return _Context(self._root, self._path + "/corp", self.parameters, {"characterID":characterID})\r
+\r
+\r
+class _RootContext(_Context):\r
+\r
+ def auth(self, userID=None, apiKey=None):\r
+ # returns a copy of this object but for every call made through it, the\r
+ # userID and apiKey will be added to the API request.\r
+ if userID and apiKey:\r
+ return _AuthContext(self._root, self._path, self.parameters, {"userID":userID, "apiKey":apiKey})\r
+ raise ValueError("Must specify userID and apiKey")\r
+\r
+ def setcachehandler(self, handler):\r
+ self._root._handler = handler\r
+\r
+ def __call__(self, path, **kw):\r
+ # convert list type arguments to something the API likes\r
+ for k, v in kw.iteritems():\r
+ if isinstance(v, _listtypes):\r
+ kw[k] = ','.join(map(str, list(v)))\r
+\r
+ cache = self._root._handler\r
+\r
+ # now send the request\r
+ path += ".xml.aspx"\r
+\r
+ if cache:\r
+ response = cache.retrieve(self._host, path, kw)\r
+ else:\r
+ response = None\r
+\r
+ if response is None:\r
+ if self._proxy is None:\r
+ http = httplib.HTTPConnection(self._host)\r
+ if kw:\r
+ http.request("POST", path, urllib.urlencode(kw), {"Content-type": "application/x-www-form-urlencoded"})\r
+ else:\r
+ http.request("GET", path)\r
+ else:\r
+ http = httplib.HTTPConnection(*self._proxy)\r
+ if kw:\r
+ http.request("POST", 'http://'+self._host+path, urllib.urlencode(kw), {"Content-type": "application/x-www-form-urlencoded"})\r
+ else:\r
+ http.request("GET", 'http://'+self._host+path)\r
+\r
+ response = http.getresponse()\r
+ if response.status != 200:\r
+ if response.status == httplib.NOT_FOUND:\r
+ raise AttributeError("'%s' not available on API server (404 Not Found)" % path)\r
+ else:\r
+ raise RuntimeError("'%s' request failed (%d %s)" % (path, response.status, response.reason))\r
+\r
+ if cache:\r
+ store = True\r
+ response = response.read()\r
+ else:\r
+ store = False\r
+ else:\r
+ store = False\r
+\r
+ return _ParseXML(response, True, store and (lambda obj: cache.store(self._host, path, kw, response, obj)))\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+# XML Parser\r
+#-----------------------------------------------------------------------------\r
+\r
+def _autocast(s):\r
+ # attempts to cast an XML string to the most probable type.\r
+ try:\r
+ if s.strip("-").isdigit():\r
+ return int(s)\r
+ except ValueError:\r
+ pass\r
+\r
+ try:\r
+ return float(s)\r
+ except ValueError:\r
+ pass\r
+\r
+ if len(s) == 19 and s[10] == ' ':\r
+ # it could be a date string\r
+ try:\r
+ return max(0, int(timegm(strptime(s, "%Y-%m-%d %H:%M:%S"))))\r
+ except OverflowError:\r
+ pass\r
+ except ValueError:\r
+ pass\r
+\r
+ # couldn't cast. return string unchanged.\r
+ return s\r
+\r
+\r
+class _Parser(object):\r
+\r
+ def Parse(self, data, isStream=False):\r
+ self.container = self.root = None\r
+ p = expat.ParserCreate()\r
+ p.StartElementHandler = self.tag_start\r
+ p.CharacterDataHandler = self.tag_cdata\r
+ p.EndElementHandler = self.tag_end\r
+ p.ordered_attributes = True\r
+ p.buffer_text = True\r
+\r
+ if isStream:\r
+ p.ParseFile(data)\r
+ else:\r
+ p.Parse(data, True)\r
+ return self.root\r
+ \r
+\r
+ def tag_start(self, name, attributes):\r
+ # <hack>\r
+ # If there's a colon in the tag name, cut off the name from the colon\r
+ # onward. This is a workaround to make certain bugged XML responses\r
+ # (such as eve/CharacterID.xml.aspx) work.\r
+ if ":" in name:\r
+ name = name[:name.index(":")]\r
+ # </hack>\r
+\r
+ if name == "rowset":\r
+ # for rowsets, use the given name\r
+ try:\r
+ columns = attributes[attributes.index('columns')+1].split(",")\r
+ except ValueError:\r
+ # rowset did not have columns tag set (this is a bug in API)\r
+ # columns will be extracted from first row instead.\r
+ columns = []\r
+\r
+ try:\r
+ priKey = attributes[attributes.index('key')+1]\r
+ this = IndexRowset(cols=columns, key=priKey)\r
+ except ValueError:\r
+ this = Rowset(cols=columns)\r
+\r
+\r
+ this._name = attributes[attributes.index('name')+1]\r
+ this.__catch = "row" # tag to auto-add to rowset.\r
+ else:\r
+ this = Element()\r
+ this._name = name\r
+\r
+ this.__parent = self.container\r
+\r
+ if self.root is None:\r
+ # We're at the root. The first tag has to be "eveapi" or we can't\r
+ # really assume the rest of the xml is going to be what we expect.\r
+ if name != "eveapi":\r
+ raise RuntimeError("Invalid API response")\r
+ self.root = this\r
+\r
+ if isinstance(self.container, Rowset) and (self.container.__catch == this._name):\r
+ # check for missing columns attribute (see above)\r
+ if not self.container._cols:\r
+ self.container._cols = attributes[0::2]\r
+\r
+ self.container.append([_autocast(attributes[i]) for i in range(1, len(attributes), 2)])\r
+ this._isrow = True\r
+ this._attributes = this._attributes2 = None\r
+ else:\r
+ this._isrow = False\r
+ this._attributes = attributes\r
+ this._attributes2 = []\r
+ \r
+ self.container = this\r
+\r
+\r
+ def tag_cdata(self, data):\r
+ if data == "\r\n" or data.strip() != data:\r
+ return\r
+\r
+ this = self.container\r
+ data = _autocast(data)\r
+\r
+ if this._attributes:\r
+ # this tag has attributes, so we can't simply assign the cdata\r
+ # as an attribute to the parent tag, as we'll lose the current\r
+ # tag's attributes then. instead, we'll assign the data as\r
+ # attribute of this tag.\r
+ this.data = data\r
+ else:\r
+ # this was a simple <tag>data</tag> without attributes.\r
+ # we won't be doing anything with this actual tag so we can just\r
+ # bind it to its parent (done by __tag_end)\r
+ setattr(this.__parent, this._name, data)\r
+\r
+\r
+ def tag_end(self, name):\r
+ this = self.container\r
+ if this is self.root:\r
+ del this._attributes\r
+ #this.__dict__.pop("_attributes", None)\r
+ return\r
+\r
+ # we're done with current tag, so we can pop it off. This means that\r
+ # self.container will now point to the container of element 'this'.\r
+ self.container = this.__parent\r
+ del this.__parent\r
+\r
+ attributes = this.__dict__.pop("_attributes")\r
+ attributes2 = this.__dict__.pop("_attributes2")\r
+ if attributes is None:\r
+ # already processed this tag's closure early, in tag_start()\r
+ return\r
+\r
+ if self.container._isrow:\r
+ # Special case here. tags inside a row! Such tags have to be\r
+ # added as attributes of the row.\r
+ parent = self.container.__parent\r
+\r
+ # get the row line for this element from its parent rowset\r
+ _row = parent._rows[-1]\r
+\r
+ # add this tag's value to the end of the row\r
+ _row.append(getattr(self.container, this._name, this))\r
+\r
+ # fix columns if neccessary.\r
+ if len(parent._cols) < len(_row):\r
+ parent._cols.append(this._name)\r
+ else:\r
+ # see if there's already an attribute with this name (this shouldn't\r
+ # really happen, but it doesn't hurt to handle this case!\r
+ sibling = getattr(self.container, this._name, None)\r
+ if sibling is None:\r
+ self.container._attributes2.append(this._name)\r
+ setattr(self.container, this._name, this)\r
+ # Note: there aren't supposed to be any NON-rowset tags containing\r
+ # multiples of some tag or attribute. Code below handles this case.\r
+ elif isinstance(sibling, Rowset):\r
+ # its doppelganger is a rowset, append this as a row to that.\r
+ row = [_autocast(attributes[i]) for i in range(1, len(attributes), 2)]\r
+ row.extend([getattr(this, col) for col in attributes2])\r
+ sibling.append(row)\r
+ elif isinstance(sibling, Element):\r
+ # parent attribute is an element. This means we're dealing\r
+ # with multiple of the same sub-tag. Change the attribute\r
+ # into a Rowset, adding the sibling element and this one.\r
+ rs = Rowset()\r
+ rs.__catch = rs._name = this._name\r
+ row = [_autocast(attributes[i]) for i in range(1, len(attributes), 2)]+[getattr(this, col) for col in attributes2]\r
+ rs.append(row)\r
+ row = [getattr(sibling, attributes[i]) for i in range(0, len(attributes), 2)]+[getattr(sibling, col) for col in attributes2]\r
+ rs.append(row)\r
+ rs._cols = [attributes[i] for i in range(0, len(attributes), 2)]+[col for col in attributes2]\r
+ setattr(self.container, this._name, rs)\r
+ else:\r
+ # something else must have set this attribute already.\r
+ # (typically the <tag>data</tag> case in tag_data())\r
+ pass\r
+\r
+ # Now fix up the attributes and be done with it.\r
+ for i in range(1, len(attributes), 2):\r
+ this.__dict__[attributes[i-1]] = _autocast(attributes[i])\r
+\r
+ return\r
+\r
+\r
+\r
+\r
+#-----------------------------------------------------------------------------\r
+# XML Data Containers\r
+#-----------------------------------------------------------------------------\r
+# The following classes are the various container types the XML data is\r
+# unpacked into.\r
+#\r
+# Note that objects returned by API calls are to be treated as read-only. This\r
+# is not enforced, but you have been warned.\r
+#-----------------------------------------------------------------------------\r
+\r
+class Element(object):\r
+ # Element is a namespace for attributes and nested tags\r
+ def __str__(self):\r
+ return "<Element '%s'>" % self._name\r
+\r
+\r
+class Row(object):\r
+ # A Row is a single database record associated with a Rowset.\r
+ # The fields in the record are accessed as attributes by their respective\r
+ # column name.\r
+ #\r
+ # To conserve resources, Row objects are only created on-demand. This is\r
+ # typically done by Rowsets (e.g. when iterating over the rowset).\r
+ \r
+ def __init__(self, cols=None, row=None):\r
+ self._cols = cols or []\r
+ self._row = row or []\r
+\r
+ def __nonzero__(self):\r
+ return True\r
+\r
+ def __ne__(self, other):\r
+ return self.__cmp__(other)\r
+\r
+ def __eq__(self, other):\r
+ return self.__cmp__(other) == 0\r
+\r
+ def __cmp__(self, other):\r
+ if type(other) != type(self):\r
+ raise TypeError("Incompatible comparison type")\r
+ return cmp(self._cols, other._cols) or cmp(self._row, other._row)\r
+\r
+ def __getattr__(self, this):\r
+ try:\r
+ return self._row[self._cols.index(this)]\r
+ except:\r
+ raise AttributeError, this\r
+\r
+ def __getitem__(self, this):\r
+ return self._row[self._cols.index(this)]\r
+\r
+ def __str__(self):\r
+ return "Row(" + ','.join(map(lambda k, v: "%s:%s" % (str(k), str(v)), self._cols, self._row)) + ")"\r
+\r
+\r
+class Rowset(object):\r
+ # Rowsets are collections of Row objects.\r
+ #\r
+ # Rowsets support most of the list interface:\r
+ # iteration, indexing and slicing\r
+ #\r
+ # As well as the following methods: \r
+ #\r
+ # IndexedBy(column)\r
+ # Returns an IndexRowset keyed on given column. Requires the column to\r
+ # be usable as primary key.\r
+ #\r
+ # GroupedBy(column)\r
+ # Returns a FilterRowset keyed on given column. FilterRowset objects\r
+ # can be accessed like dicts. See FilterRowset class below.\r
+ #\r
+ # SortBy(column, reverse=True)\r
+ # Sorts rowset in-place on given column. for a descending sort,\r
+ # specify reversed=True.\r
+ #\r
+ # SortedBy(column, reverse=True)\r
+ # Same as SortBy, except this retuens a new rowset object instead of\r
+ # sorting in-place.\r
+ #\r
+ # Select(columns, row=False)\r
+ # Yields a column values tuple (value, ...) for each row in the rowset.\r
+ # If only one column is requested, then just the column value is\r
+ # provided instead of the values tuple.\r
+ # When row=True, each result will be decorated with the entire row.\r
+ #\r
+\r
+ def IndexedBy(self, column):\r
+ return IndexRowset(self._cols, self._rows, column)\r
+\r
+ def GroupedBy(self, column):\r
+ return FilterRowset(self._cols, self._rows, column)\r
+\r
+ def SortBy(self, column, reverse=False):\r
+ ix = self._cols.index(column)\r
+ self.sort(key=lambda e: e[ix], reverse=reverse)\r
+\r
+ def SortedBy(self, column, reverse=False):\r
+ rs = self[:]\r
+ rs.SortBy(column, reverse)\r
+ return rs\r
+\r
+ def Select(self, *columns, **options):\r
+ if len(columns) == 1:\r
+ i = self._cols.index(columns[0])\r
+ if options.get("row", False):\r
+ for line in self._rows:\r
+ yield (line, line[i])\r
+ else:\r
+ for line in self._rows:\r
+ yield line[i]\r
+ else:\r
+ i = map(self._cols.index, columns)\r
+ if options.get("row", False):\r
+ for line in self._rows:\r
+ yield line, [line[x] for x in i]\r
+ else:\r
+ for line in self._rows:\r
+ yield [line[x] for x in i]\r
+\r
+\r
+ # -------------\r
+\r
+ def __init__(self, cols=None, rows=None):\r
+ self._cols = cols or []\r
+ self._rows = rows or []\r
+\r
+ def append(self, row):\r
+ if isinstance(row, list):\r
+ self._rows.append(row)\r
+ elif isinstance(row, Row) and len(row._cols) == len(self._cols):\r
+ self._rows.append(row._row)\r
+ else:\r
+ raise TypeError("incompatible row type")\r
+\r
+ def __add__(self, other):\r
+ if isinstance(other, Rowset):\r
+ if len(other._cols) == len(self._cols):\r
+ self._rows += other._rows\r
+ raise TypeError("rowset instance expected")\r
+\r
+ def __nonzero__(self):\r
+ return not not self._rows\r
+\r
+ def __len__(self):\r
+ return len(self._rows)\r
+\r
+ def copy(self):\r
+ return self[:]\r
+\r
+ def __getitem__(self, ix):\r
+ if type(ix) is slice:\r
+ return Rowset(self._cols, self._rows[ix])\r
+ return Row(self._cols, self._rows[ix])\r
+\r
+ def sort(self, *args, **kw):\r
+ self._rows.sort(*args, **kw)\r
+\r
+ def __str__(self):\r
+ return ("Rowset(columns=[%s], rows=%d)" % (','.join(self._cols), len(self)))\r
+\r
+ def __getstate__(self):\r
+ return (self._cols, self._rows)\r
+\r
+ def __setstate__(self, state):\r
+ self._cols, self._rows = state\r
+\r
+\r
+\r
+class IndexRowset(Rowset):\r
+ # An IndexRowset is a Rowset that keeps an index on a column.\r
+ #\r
+ # The interface is the same as Rowset, but provides an additional method:\r
+ #\r
+ # Get(key [, default])\r
+ # Returns the Row mapped to provided key in the index. If there is no\r
+ # such key in the index, KeyError is raised unless a default value was\r
+ # specified.\r
+ #\r
+\r
+ def Get(self, key, *default):\r
+ row = self._items.get(key, None)\r
+ if row is None:\r
+ if default:\r
+ return default[0]\r
+ raise KeyError, key\r
+ return Row(self._cols, row)\r
+\r
+ # -------------\r
+\r
+ def __init__(self, cols=None, rows=None, key=None):\r
+ try:\r
+ self._ki = ki = cols.index(key)\r
+ except IndexError:\r
+ raise ValueError("Rowset has no column %s" % key)\r
+\r
+ Rowset.__init__(self, cols, rows)\r
+ self._key = key\r
+ self._items = dict((row[ki], row) for row in self._rows)\r
+\r
+ def __getitem__(self, ix):\r
+ if type(ix) is slice:\r
+ return IndexRowset(self._cols, self._rows[ix], self._key)\r
+ return Rowset.__getitem__(self, ix)\r
+\r
+ def append(self, row):\r
+ Rowset.append(self, row)\r
+ self._items[row[self._ki]] = row\r
+\r
+ def __getstate__(self):\r
+ return (Rowset.__getstate__(self), self._items, self._ki)\r
+\r
+ def __setstate__(self, state):\r
+ state, self._items, self._ki = state\r
+ Rowset.__setstate__(self, state)\r
+\r
+\r
+class FilterRowset(object):\r
+ # A FilterRowset works much like an IndexRowset, with the following\r
+ # differences:\r
+ # - FilterRowsets are accessed much like dicts\r
+ # - Each key maps to a Rowset, containing only the rows where the value\r
+ # of the column this FilterRowset was made on matches the key.\r
+\r
+ def __init__(self, cols=None, rows=None, key=None, key2=None, dict=None):\r
+ if dict is not None:\r
+ self._items = items = dict\r
+ elif cols is not None:\r
+ self._items = items = {}\r
+\r
+ idfield = cols.index(key)\r
+ if not key2:\r
+ for row in rows:\r
+ id = row[idfield]\r
+ if id in items:\r
+ items[id].append(row)\r
+ else:\r
+ items[id] = [row]\r
+ else:\r
+ idfield2 = cols.index(key2)\r
+ for row in rows:\r
+ id = row[idfield]\r
+ if id in items:\r
+ items[id][row[idfield2]] = row\r
+ else:\r
+ items[id] = {row[idfield2]:row}\r
+\r
+ self._cols = cols\r
+ self.key = key\r
+ self.key2 = key2\r
+ self._bind()\r
+\r
+ def _bind(self):\r
+ items = self._items\r
+ self.keys = items.keys\r
+ self.iterkeys = items.iterkeys\r
+ self.__contains__ = items.__contains__\r
+ self.has_key = items.has_key\r
+ self.__len__ = items.__len__\r
+ self.__iter__ = items.__iter__\r
+\r
+ def copy(self):\r
+ return FilterRowset(self._cols[:], None, self.key, self.key2, dict=copy.deepcopy(self._items))\r
+\r
+ def get(self, key, default=_unspecified):\r
+ try:\r
+ return self[key]\r
+ except KeyError:\r
+ if default is _unspecified:\r
+ raise\r
+ return default\r
+\r
+ def __getitem__(self, i):\r
+ if self.key2:\r
+ return IndexRowset(self._cols, None, self.key2, self._items.get(i, {}))\r
+ return Rowset(self._cols, self._items[i])\r
+\r
+ def __getstate__(self):\r
+ return (self._cols, self._rows, self._items, self.key, self.key2)\r
+\r
+ def __setstate__(self, state):\r
+ self._cols, self._rows, self._items, self.key, self.key2 = state\r
+ self._bind()\r
+\r
--- /dev/null
+import urllib
+import os.path
+
+def portrait_filename( char_id, img_size ):
+
+ err_img = 'imgs/error.jpg'
+
+ # we can only accept 64 or 256... I know an exclamation point is not an error message, but I'll come back to this. FIXME --danny
+ if not ( img_size == 64 or img_size == 256 ):
+ return err_img
+
+ # if asked for the large version, save it under a diff name --danny
+ if img_size == 64:
+ filename = "imgs/%s.jpg" % char_id
+ elif img_size == 256:
+ filename = "imgs/%s_lg.jpg" % char_id
+
+ if os.path.isfile( filename ):
+ return filename
+
+ # specify size and cid --danny
+ img_url = "http://img.eve.is/serv.asp?s=%s&c=%s" % ( str( img_size ), char_id )
+
+ # fetch it, and hit the road. --danny
+ try:
+ urllib.urlretrieve( img_url, filename, report_handler )
+ except ContentTooShortError:
+ filename = err_img
+ return filename
+
+def report_handler( *a ):
+ ( blocks_transferred, block_size, total_size ) = a
--- /dev/null
+#
+# mEveMon - A character monitor for EVE Online
+# Copyright (c) 2010 Ryan and Danny Campbell, and the mEveMon Team
+#
+# mEveMon is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# mEveMon 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+
+import hildon
+import gtk
+from eveapi import eveapi
+import fetchimg
+import apicache
+
+# we will store our preferences in gconf
+import gnome.gconf
+
+#ugly hack to check maemo version. any better way?
+if hasattr(hildon, "StackableWindow"):
+ from ui.fremantle import ui
+else:
+ from ui.diablo import ui
+
+class mEveMon():
+ def __init__(self):
+ self.program = hildon.Program()
+ self.program.__init__()
+ self.gconf = gnome.gconf.client_get_default()
+ self.set_auth()
+ self.ui = ui.mEveMonUI(self)
+
+ def run(self):
+ gtk.main()
+
+ def quit(self, *args):
+ gtk.main_quit()
+
+ def get_api_key(self):
+ return self.gconf.get_string("/apps/maemo/mevemon/eve_api_key") or ''
+
+ def get_uid(self):
+ return self.gconf.get_string("/apps/maemo/mevemon/eve_uid") or ''
+
+ def set_api_key(self, key):
+ self.gconf.set_string("/apps/maemo/mevemon/eve_api_key", key)
+
+ def set_uid(self, uid):
+ self.gconf.set_string("/apps/maemo/mevemon/eve_uid", uid)
+
+
+ def set_auth(self):
+ """
+ set self.auth to None if there was a problem. somehow later on we'll
+ have to pass the error to the UI, but for now I just want the program
+ to not be broken. --danny
+ """
+ uid = self.get_uid()
+ api_key = self.get_api_key()
+ self.cached_api = eveapi.EVEAPIConnection( cacheHandler = \
+ apicache.cache_handler( debug = False ) )
+ try:
+ self.auth = self.cached_api.auth( userID = uid, apiKey = api_key )
+ except eveapi.Error, e:
+ # we need to deal with this, so raise --danny
+ raise
+ except ValueError, e:
+ self.auth = None
+ #raise
+
+ def get_auth(self):
+ return self.auth
+
+ def get_char_sheet(self, charID):
+ if not self.auth: return None
+ try:
+ sheet = self.auth.character(charID).CharacterSheet()
+ except eveapi.Error, e:
+ # we should really have a logger that logs this error somewhere
+ return None
+
+ return sheet
+
+ def char_id2name(self, charID):
+ # the api can take a comma-seperated list of ids, but we'll just take
+ # a single id for now
+ try:
+ chars = self.cached_api.eve.CharacterName(ids=charID).characters
+ name = chars[0].characterName
+ except eveapi.Error, e:
+ return None
+
+ return name
+
+ def char_name2id(self, name):
+ # the api can take a comma-seperated list of names, but we'll just take
+ # a single name for now
+ try:
+ chars = self.cached_api.eve.CharacterID(names=name).characters
+ char_id = chars[0].characterID
+ except eveapi.Error, e:
+ return None
+
+ return char_id
+
+
+ def get_characters( self ):
+ """
+ returns a list containing a single character with an error message for a
+ name, if there's a problem. FIXME --danny
+ """
+ ui_char_list = []
+ placeholder_chars = [("Please check your API settings.", "imgs/error.jpg")]
+ if not self.auth: return placeholder_chars
+ try:
+ api_char_list = self.auth.account.Characters()
+ # append each char we get to the list we'll return to the
+ # UI --danny
+ for character in api_char_list.characters:
+ ui_char_list.append( ( character.name, fetchimg.portrait_filename( character.characterID, 64 ) ) )
+ except eveapi.Error, e:
+ # again, we need to handle this... --danny
+ raise
+
+ return ui_char_list
+
+ def get_portrait(self, char_name, size):
+ """
+ returns the relative path of the retrieved portrait
+ """
+ charID = self.char_name2id(char_name)
+ return fetchimg.portrait_filename(charID, size)
+
+if __name__ == "__main__":
+ app = mEveMon()
+ app.run()
--- /dev/null
+#
+# mEveMon - A character monitor for EVE Online
+# Copyright (c) 2010 Ryan and Danny Campbell, and the mEveMon Team
+#
+# mEveMon is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# mEveMon 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+# Based on Ry's Fremantle Python code. --danny
+
+import sys
+
+import gtk
+import hildon
+import gobject
+
+class mEveMonUI():
+
+ about_name = 'mEveMon'
+ about_text = ('Mobile character monitor for EVE Online')
+ about_authors = ['Ryan Campbell','Danny Campbell']
+ about_website = 'http://example.site.org'
+ app_version = '0.1'
+
+ menu_items = ("Settings", "About", "Refresh")
+
+ def __init__(self, controller):
+ self.controller = controller
+
+ gtk.set_application_name("mEveMon")
+
+ # create the main window
+ win = hildon.Window()
+ win.connect("destroy", self.controller.quit)
+ win.show_all()
+ progress_bar = hildon.hildon_banner_show_progress(win, None, "Loading overview...")
+ progress_bar.set_fraction( 0.4 )
+
+ # Create menu
+ menu = self.create_menu(win)
+ # Attach menu to the window
+ win.set_menu(menu)
+
+ # will probably need to refer to http://maemo.org/community/maemo-developers/gtktreeview_issue/ for sample code again when we make these clickable --danny
+ self.char_model = self.create_char_model()
+ treeview = gtk.TreeView( model = self.char_model )
+ treeview.connect( 'row-activated', self.build_window )
+ treeview.set_model(self.char_model)
+ self.add_columns_to_treeview(treeview)
+
+ win.add(treeview)
+ win.show_all()
+
+ progress_bar.set_fraction( 1 )
+ progress_bar.destroy()
+
+ def build_window(self, treeview, path, view_column):
+ win = hildon.Window()
+ win.show_all()
+
+ progress_bar = hildon.hildon_banner_show_progress(win, None, "Loading character sheet...")
+ progress_bar.set_fraction( 0.4 )
+
+ # Create menu
+ # NOTE: we probably want a window-specific menu for this page, but the
+ # main appmenu works for now
+ menu = self.create_menu(win)
+ # Attach menu to the window
+ win.set_menu(menu)
+
+ #pannable_area = hildon.PannableArea()
+
+ model = treeview.get_model()
+ miter = model.get_iter(path)
+
+ # column 0 is the portrait, column 1 is name
+
+ char_name = model.get_value(miter, 1)
+ char_id = self.controller.char_name2id(char_name)
+
+ win.set_title(char_name)
+
+ skillLabel = gtk.Label("Skills")
+
+ # TODO: replace these with api calls
+ corp_name = ""
+ skill_points = 0
+
+ name = gtk.Label("Name: %s" % char_name)
+ name.set_alignment(0, 0.5)
+
+ corp = gtk.Label("Corp: %s" % corp_name)
+ corp.set_alignment(0, 0.5)
+
+ balance = gtk.Label("Balance: %s ISK" %
+ self.controller.get_account_balance(char_id))
+ balance.set_alignment(0, 0.5)
+
+ sp = gtk.Label("Skill points: %s" % skill_points)
+ sp.set_alignment(0, 0.5)
+
+ portrait = gtk.Image()
+ portrait.set_from_file(self.controller.get_portrait(char_name, 256))
+ portrait.show()
+
+ hbox = gtk.HBox(False, 0)
+
+ info_vbox = gtk.VBox(False, 0)
+ info_vbox.pack_start(name, False, False, 1)
+ info_vbox.pack_start(corp, False, False, 1)
+ info_vbox.pack_start(balance, False, False, 1)
+ info_vbox.pack_start(sp, False, False, 1)
+
+ hbox.pack_start(portrait, False, False, 10)
+ hbox.pack_start(info_vbox, False, False, 5)
+ #hbox.pack_start(stats_vbox, False, False, 5)
+
+ vbox = gtk.VBox(False, 0)
+ #pannable_area.add(vbox)
+
+ vbox.pack_start(hbox, False, False, 0)
+ vbox.pack_start(skillLabel, False, False, 5)
+
+ win.add(vbox)
+ win.show_all()
+
+ progress_bar.set_fraction( 1 )
+ progress_bar.destroy()
+
+ def create_char_model(self):
+ lstore = gtk.ListStore(gtk.gdk.Pixbuf, gobject.TYPE_STRING)
+ #get icon and name and put in a liststore
+ self.fill_char_model(lstore)
+ return lstore
+
+ def fill_char_model(self, lstore):
+ char_list = self.controller.get_characters()
+ for name, icon in char_list:
+ liter = lstore.append()
+ lstore.set(liter, 1, name, 0, self.set_pix(icon))
+
+ def update_model(self, lstore):
+ lstore.clear()
+ self.fill_char_model(lstore)
+
+ def set_pix(self, filename):
+ pixbuf = gtk.gdk.pixbuf_new_from_file(filename)
+ return pixbuf
+
+ def add_columns_to_treeview(self, treeview):
+ #Column 0 for the treeview
+ renderer = gtk.CellRendererPixbuf()
+ column = gtk.TreeViewColumn()
+ column.pack_start(renderer, True)
+ column.add_attribute(renderer, "pixbuf", 0)
+ treeview.append_column(column)
+
+ #Column 1 for the treeview
+ renderer = gtk.CellRendererText()
+ column = gtk.TreeViewColumn('title', renderer, text=1)
+ column.set_property("expand", True)
+ treeview.append_column(column)
+
+
+ def settings_clicked(self, button, window):
+
+ dialog = gtk.Dialog()
+
+ #get the vbox to pack all the settings into
+ vbox = dialog.vbox
+
+ dialog.set_transient_for(window)
+ dialog.set_title("Settings")
+
+ uidLabel = gtk.Label("User ID:")
+ uidLabel.set_justify(gtk.JUSTIFY_LEFT)
+ vbox.add(uidLabel)
+
+ uidEntry = gtk.Entry()
+ uidEntry.set_text(self.controller.get_uid())
+ uidEntry.set_property('is_focus', False)
+
+ vbox.add(uidEntry)
+
+ apiLabel = gtk.Label("API key:")
+ apiLabel.set_justify(gtk.JUSTIFY_LEFT)
+ vbox.add(apiLabel)
+
+ apiEntry = gtk.Entry()
+ apiEntry.set_text(self.controller.get_api_key())
+ apiEntry.set_property('is_focus', False)
+
+ vbox.add(apiEntry)
+
+ ok_button = dialog.add_button(gtk.STOCK_OK, gtk.RESPONSE_OK)
+ help_button = dialog.add_button(gtk.STOCK_HELP, gtk.RESPONSE_HELP)
+
+
+ dialog.show_all()
+ result = dialog.run()
+
+ if result == gtk.RESPONSE_OK:
+ self.controller.set_api_key(apiEntry.get_text())
+ self.controller.set_uid(uidEntry.get_text())
+ self.update_model(self.char_model)
+
+ dialog.destroy()
+
+ return result
+
+ def about_clicked(self, button):
+
+ dialog = gtk.AboutDialog()
+ dialog.set_website(self.about_website)
+ dialog.set_website_label(self.about_website)
+ dialog.set_name(self.about_name)
+ dialog.set_authors(self.about_authors)
+ dialog.set_comments(self.about_text)
+ dialog.set_version(self.app_version)
+ dialog.run()
+ dialog.destroy()
+
+ def refresh_clicked(self, button, window):
+ self.update_model(self.char_model)
+
+ def create_menu(self, window):
+ menu = gtk.Menu()
+ for command in self.menu_items:
+ button = gtk.MenuItem( command )
+ if command == "About":
+ button.connect("activate", self.about_clicked)
+ elif command == "Settings":
+ button.connect("activate", self.settings_clicked, window)
+ elif command == "Refresh":
+ button.connect("activate", self.refresh_clicked, window)
+ else:
+ assert False, command
+ # Add entry to the view menu
+ menu.append(button)
+ menu.show_all()
+ return menu
+
+if __name__ == "__main__":
+ main()
+
--- /dev/null
+#
+# mEveMon - A character monitor for EVE Online
+# Copyright (c) 2010 Ryan and Danny Campbell, and the mEveMon Team
+#
+# mEveMon is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# mEveMon 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+import sys
+
+import gtk
+import hildon
+import gobject
+
+class mEveMonUI():
+
+ about_name = 'mEveMon'
+ about_text = ('Mobile character monitor for EVE Online')
+ about_authors = ['Ryan Campbell', 'Danny Campbell']
+ about_website = 'http://example.site.org'
+ app_version = '0.1'
+
+ menu_items = ("Settings", "About", "Refresh")
+
+ def __init__(self, controller):
+ self.controller = controller
+ gtk.set_application_name("mEveMon")
+
+ #create the main window
+ win = hildon.StackableWindow()
+ win.connect("destroy", self.controller.quit)
+ win.show_all()
+ hildon.hildon_gtk_window_set_progress_indicator(win, 1)
+
+ # Create menu
+ menu = self.create_menu(win)
+ # Attach menu to the window
+ win.set_app_menu(menu)
+
+ pannable_area = hildon.PannableArea()
+
+ # gtk.HILDON_UI_MODE_NORMAL -> not selection in the treeview
+ # gtk.HILDON_UI_MODE_EDIT -> selection in the treeview
+ treeview = hildon.GtkTreeView(gtk.HILDON_UI_MODE_NORMAL)
+ treeview.connect('row-activated', self.build_window)
+
+ self.char_model = self.create_char_model()
+ treeview.set_model(self.char_model)
+
+ self.add_columns_to_treeview(treeview)
+
+ pannable_area.add(treeview)
+
+ win.add(pannable_area);
+
+ win.show_all()
+
+ hildon.hildon_gtk_window_set_progress_indicator(win, 0)
+
+ def build_window(self, treeview, path, view_column):
+ win = hildon.StackableWindow()
+ win.show_all()
+ hildon.hildon_gtk_window_set_progress_indicator(win, 1)
+
+ # Create menu
+ # NOTE: we probably want a window-specific menu for this page, but the
+ # main appmenu works for now
+ menu = self.create_menu(win)
+ # Attach menu to the window
+ win.set_app_menu(menu)
+
+ pannable_area = hildon.PannableArea()
+
+ model = treeview.get_model()
+ miter = model.get_iter(path)
+
+ # column 0 is the portrait, column 1 is name
+
+ char_name = model.get_value(miter, 1)
+ char_id = self.controller.char_name2id(char_name)
+ sheet = self.controller.get_char_sheet(char_id)
+
+ win.set_title(char_name)
+
+ skillLabel = gtk.Label("Skills")
+
+ name = gtk.Label("%s" % char_name)
+ name.set_alignment(0, 0.5)
+
+ race = gtk.Label("%s %s %s" % (sheet.gender, sheet.race,
+ sheet.bloodLine))
+ race.set_alignment(0, 0.5)
+
+ corp = gtk.Label("Corp: %s" % sheet.corporationName)
+ corp.set_alignment(0, 0.5)
+
+ balance = gtk.Label("Balance: %s ISK" % sheet.balance)
+ balance.set_alignment(0, 0.5)
+
+ portrait = gtk.Image()
+ portrait.set_from_file(self.controller.get_portrait(char_name, 256))
+ portrait.show()
+
+ hbox = gtk.HBox(False, 0)
+
+ info_vbox = gtk.VBox(False, 0)
+ info_vbox.pack_start(name, False, False, 1)
+ info_vbox.pack_start(race, False, False, 1)
+ info_vbox.pack_start(corp, False, False, 1)
+ info_vbox.pack_start(balance, False, False, 1)
+
+ hbox.pack_start(portrait, False, False, 10)
+ hbox.pack_start(info_vbox, False, False, 5)
+ #hbox.pack_start(stats_vbox, False, False, 5)
+
+ vbox = gtk.VBox(False, 0)
+ pannable_area.add_with_viewport(vbox)
+
+ vbox.pack_start(hbox, False, False, 0)
+ vbox.pack_start(skillLabel, False, False, 5)
+
+ win.add(pannable_area)
+ win.show_all()
+
+ hildon.hildon_gtk_window_set_progress_indicator(win, 0)
+
+ def create_char_model(self):
+ lstore = gtk.ListStore(gtk.gdk.Pixbuf, gobject.TYPE_STRING)
+
+ #get icon and name and put in a liststore
+ self.fill_char_model(lstore)
+
+ return lstore
+
+
+ def fill_char_model(self, lstore):
+ char_list = self.controller.get_characters()
+
+ for name, icon in char_list:
+ liter = lstore.append()
+ lstore.set(liter, 1, name, 0, self.set_pix(icon))
+
+
+ def update_model(self, lstore):
+ lstore.clear()
+ self.fill_char_model(lstore)
+
+
+ def set_pix(self, filename):
+ pixbuf = gtk.gdk.pixbuf_new_from_file(filename)
+ return pixbuf
+
+
+ def add_columns_to_treeview(self, treeview):
+ #Column 0 for the treeview
+ renderer = gtk.CellRendererPixbuf()
+ column = gtk.TreeViewColumn()
+ column.pack_start(renderer, True)
+ column.add_attribute(renderer, "pixbuf", 0)
+ treeview.append_column(column)
+
+ #Column 1 for the treeview
+ renderer = gtk.CellRendererText()
+ column = gtk.TreeViewColumn('title', renderer, text=1)
+ column.set_property("expand", True)
+ treeview.append_column(column)
+
+
+ def settings_clicked(self, button, window):
+ dialog = gtk.Dialog()
+
+ #get the vbox to pack all the settings into
+ vbox = dialog.vbox
+
+ dialog.set_transient_for(window)
+ dialog.set_title("Settings")
+
+ uidLabel = gtk.Label("User ID:")
+ uidLabel.set_justify(gtk.JUSTIFY_LEFT)
+ vbox.add(uidLabel)
+
+ uidEntry = hildon.Entry(gtk.HILDON_SIZE_FINGER_HEIGHT)
+ uidEntry.set_placeholder("User ID")
+ uidEntry.set_text(self.controller.get_uid())
+ uidEntry.set_property('is_focus', False)
+
+ vbox.add(uidEntry)
+
+ apiLabel = gtk.Label("API key:")
+ apiLabel.set_justify(gtk.JUSTIFY_LEFT)
+ vbox.add(apiLabel)
+
+ apiEntry = hildon.Entry(gtk.HILDON_SIZE_FINGER_HEIGHT)
+ apiEntry.set_placeholder("API Key")
+ apiEntry.set_text(self.controller.get_api_key())
+ apiEntry.set_property('is_focus', False)
+
+ vbox.add(apiEntry)
+
+ ok_button = dialog.add_button(gtk.STOCK_OK, gtk.RESPONSE_OK)
+ help_button = dialog.add_button(gtk.STOCK_HELP, gtk.RESPONSE_HELP)
+
+ dialog.show_all()
+ result = dialog.run()
+ if result == gtk.RESPONSE_OK:
+ self.controller.set_api_key(apiEntry.get_text())
+ self.controller.set_uid(uidEntry.get_text())
+ self.controller.set_auth()
+ self.update_model(self.char_model)
+
+
+ dialog.destroy()
+
+ return result
+
+
+ def about_clicked(self, button):
+ dialog = gtk.AboutDialog()
+ dialog.set_website(self.about_website)
+ dialog.set_website_label(self.about_website)
+ dialog.set_name(self.about_name)
+ dialog.set_authors(self.about_authors)
+ dialog.set_comments(self.about_text)
+ dialog.set_version(self.app_version)
+ dialog.run()
+ dialog.destroy()
+
+
+ def refresh_clicked(self, button, window):
+ self.update_model(self.char_model)
+
+
+ def create_menu(self, window):
+ menu = hildon.AppMenu()
+
+ for command in self.menu_items:
+ # Create menu entries
+ button = hildon.GtkButton(gtk.HILDON_SIZE_AUTO)
+ button.set_label(command)
+
+ if command == "About":
+ button.connect("clicked", self.about_clicked)
+ elif command == "Settings":
+ button.connect("clicked", self.settings_clicked, window)
+ elif command == "Refresh":
+ button.connect("clicked", self.refresh_clicked, window)
+ else:
+ assert False, command
+
+ # Add entry to the view menu
+ menu.append(button)
+
+ menu.show_all()
+
+ return menu
+
+
+if __name__ == "__main__":
+ main()
+
+++ /dev/null
-#
-# mEveMon - A character monitor for EVE Online
-# Copyright (c) 2010 Ryan and Danny Campbell, and the mEveMon Team
-#
-# mEveMon is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3 of the License, or
-# (at your option) any later version.
-#
-# mEveMon 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-# Based on Ry's Fremantle Python code. --danny
-
-import sys
-
-import gtk
-import hildon
-import gobject
-
-class mEveMonUI():
-
- about_name = 'mEveMon'
- about_text = ('Mobile character monitor for EVE Online')
- about_authors = ['Ryan Campbell','Danny Campbell']
- about_website = 'http://example.site.org'
- app_version = '0.1'
-
- menu_items = ("Settings", "About", "Refresh")
-
- def __init__(self, controller):
- self.controller = controller
-
- gtk.set_application_name("mEveMon")
-
- # create the main window
- win = hildon.Window()
- win.connect("destroy", self.controller.quit)
- win.show_all()
- progress_bar = hildon.hildon_banner_show_progress(win, None, "Loading overview...")
- progress_bar.set_fraction( 0.4 )
-
- # Create menu
- menu = self.create_menu(win)
- # Attach menu to the window
- win.set_menu(menu)
-
- # will probably need to refer to http://maemo.org/community/maemo-developers/gtktreeview_issue/ for sample code again when we make these clickable --danny
- self.char_model = self.create_char_model()
- treeview = gtk.TreeView( model = self.char_model )
- treeview.connect( 'row-activated', self.build_window )
- treeview.set_model(self.char_model)
- self.add_columns_to_treeview(treeview)
-
- win.add(treeview)
- win.show_all()
-
- progress_bar.set_fraction( 1 )
- progress_bar.destroy()
-
- def build_window(self, treeview, path, view_column):
- win = hildon.Window()
- win.show_all()
-
- progress_bar = hildon.hildon_banner_show_progress(win, None, "Loading character sheet...")
- progress_bar.set_fraction( 0.4 )
-
- # Create menu
- # NOTE: we probably want a window-specific menu for this page, but the
- # main appmenu works for now
- menu = self.create_menu(win)
- # Attach menu to the window
- win.set_menu(menu)
-
- #pannable_area = hildon.PannableArea()
-
- model = treeview.get_model()
- miter = model.get_iter(path)
-
- # column 0 is the portrait, column 1 is name
-
- char_name = model.get_value(miter, 1)
- char_id = self.controller.char_name2id(char_name)
-
- win.set_title(char_name)
-
- skillLabel = gtk.Label("Skills")
-
- # TODO: replace these with api calls
- corp_name = ""
- skill_points = 0
-
- name = gtk.Label("Name: %s" % char_name)
- name.set_alignment(0, 0.5)
-
- corp = gtk.Label("Corp: %s" % corp_name)
- corp.set_alignment(0, 0.5)
-
- balance = gtk.Label("Balance: %s ISK" %
- self.controller.get_account_balance(char_id))
- balance.set_alignment(0, 0.5)
-
- sp = gtk.Label("Skill points: %s" % skill_points)
- sp.set_alignment(0, 0.5)
-
- portrait = gtk.Image()
- portrait.set_from_file(self.controller.get_portrait(char_name, 256))
- portrait.show()
-
- hbox = gtk.HBox(False, 0)
-
- info_vbox = gtk.VBox(False, 0)
- info_vbox.pack_start(name, False, False, 1)
- info_vbox.pack_start(corp, False, False, 1)
- info_vbox.pack_start(balance, False, False, 1)
- info_vbox.pack_start(sp, False, False, 1)
-
- hbox.pack_start(portrait, False, False, 10)
- hbox.pack_start(info_vbox, False, False, 5)
- #hbox.pack_start(stats_vbox, False, False, 5)
-
- vbox = gtk.VBox(False, 0)
- #pannable_area.add(vbox)
-
- vbox.pack_start(hbox, False, False, 0)
- vbox.pack_start(skillLabel, False, False, 5)
-
- win.add(vbox)
- win.show_all()
-
- progress_bar.set_fraction( 1 )
- progress_bar.destroy()
-
- def create_char_model(self):
- lstore = gtk.ListStore(gtk.gdk.Pixbuf, gobject.TYPE_STRING)
- #get icon and name and put in a liststore
- self.fill_char_model(lstore)
- return lstore
-
- def fill_char_model(self, lstore):
- char_list = self.controller.get_characters()
- for name, icon in char_list:
- liter = lstore.append()
- lstore.set(liter, 1, name, 0, self.set_pix(icon))
-
- def update_model(self, lstore):
- lstore.clear()
- self.fill_char_model(lstore)
-
- def set_pix(self, filename):
- pixbuf = gtk.gdk.pixbuf_new_from_file(filename)
- return pixbuf
-
- def add_columns_to_treeview(self, treeview):
- #Column 0 for the treeview
- renderer = gtk.CellRendererPixbuf()
- column = gtk.TreeViewColumn()
- column.pack_start(renderer, True)
- column.add_attribute(renderer, "pixbuf", 0)
- treeview.append_column(column)
-
- #Column 1 for the treeview
- renderer = gtk.CellRendererText()
- column = gtk.TreeViewColumn('title', renderer, text=1)
- column.set_property("expand", True)
- treeview.append_column(column)
-
-
- def settings_clicked(self, button, window):
-
- dialog = gtk.Dialog()
-
- #get the vbox to pack all the settings into
- vbox = dialog.vbox
-
- dialog.set_transient_for(window)
- dialog.set_title("Settings")
-
- uidLabel = gtk.Label("User ID:")
- uidLabel.set_justify(gtk.JUSTIFY_LEFT)
- vbox.add(uidLabel)
-
- uidEntry = gtk.Entry()
- uidEntry.set_text(self.controller.get_uid())
- uidEntry.set_property('is_focus', False)
-
- vbox.add(uidEntry)
-
- apiLabel = gtk.Label("API key:")
- apiLabel.set_justify(gtk.JUSTIFY_LEFT)
- vbox.add(apiLabel)
-
- apiEntry = gtk.Entry()
- apiEntry.set_text(self.controller.get_api_key())
- apiEntry.set_property('is_focus', False)
-
- vbox.add(apiEntry)
-
- ok_button = dialog.add_button(gtk.STOCK_OK, gtk.RESPONSE_OK)
- help_button = dialog.add_button(gtk.STOCK_HELP, gtk.RESPONSE_HELP)
-
-
- dialog.show_all()
- result = dialog.run()
-
- if result == gtk.RESPONSE_OK:
- self.controller.set_api_key(apiEntry.get_text())
- self.controller.set_uid(uidEntry.get_text())
- self.update_model(self.char_model)
-
- dialog.destroy()
-
- return result
-
- def about_clicked(self, button):
-
- dialog = gtk.AboutDialog()
- dialog.set_website(self.about_website)
- dialog.set_website_label(self.about_website)
- dialog.set_name(self.about_name)
- dialog.set_authors(self.about_authors)
- dialog.set_comments(self.about_text)
- dialog.set_version(self.app_version)
- dialog.run()
- dialog.destroy()
-
- def refresh_clicked(self, button, window):
- self.update_model(self.char_model)
-
- def create_menu(self, window):
- menu = gtk.Menu()
- for command in self.menu_items:
- button = gtk.MenuItem( command )
- if command == "About":
- button.connect("activate", self.about_clicked)
- elif command == "Settings":
- button.connect("activate", self.settings_clicked, window)
- elif command == "Refresh":
- button.connect("activate", self.refresh_clicked, window)
- else:
- assert False, command
- # Add entry to the view menu
- menu.append(button)
- menu.show_all()
- return menu
-
-if __name__ == "__main__":
- main()
-
+++ /dev/null
-#
-# mEveMon - A character monitor for EVE Online
-# Copyright (c) 2010 Ryan and Danny Campbell, and the mEveMon Team
-#
-# mEveMon is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3 of the License, or
-# (at your option) any later version.
-#
-# mEveMon 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-import sys
-
-import gtk
-import hildon
-import gobject
-
-class mEveMonUI():
-
- about_name = 'mEveMon'
- about_text = ('Mobile character monitor for EVE Online')
- about_authors = ['Ryan Campbell', 'Danny Campbell']
- about_website = 'http://example.site.org'
- app_version = '0.1'
-
- menu_items = ("Settings", "About", "Refresh")
-
- def __init__(self, controller):
- self.controller = controller
- gtk.set_application_name("mEveMon")
-
- #create the main window
- win = hildon.StackableWindow()
- win.connect("destroy", self.controller.quit)
- win.show_all()
- hildon.hildon_gtk_window_set_progress_indicator(win, 1)
-
- # Create menu
- menu = self.create_menu(win)
- # Attach menu to the window
- win.set_app_menu(menu)
-
- pannable_area = hildon.PannableArea()
-
- # gtk.HILDON_UI_MODE_NORMAL -> not selection in the treeview
- # gtk.HILDON_UI_MODE_EDIT -> selection in the treeview
- treeview = hildon.GtkTreeView(gtk.HILDON_UI_MODE_NORMAL)
- treeview.connect('row-activated', self.build_window)
-
- self.char_model = self.create_char_model()
- treeview.set_model(self.char_model)
-
- self.add_columns_to_treeview(treeview)
-
- pannable_area.add(treeview)
-
- win.add(pannable_area);
-
- win.show_all()
-
- hildon.hildon_gtk_window_set_progress_indicator(win, 0)
-
- def build_window(self, treeview, path, view_column):
- win = hildon.StackableWindow()
- win.show_all()
- hildon.hildon_gtk_window_set_progress_indicator(win, 1)
-
- # Create menu
- # NOTE: we probably want a window-specific menu for this page, but the
- # main appmenu works for now
- menu = self.create_menu(win)
- # Attach menu to the window
- win.set_app_menu(menu)
-
- pannable_area = hildon.PannableArea()
-
- model = treeview.get_model()
- miter = model.get_iter(path)
-
- # column 0 is the portrait, column 1 is name
-
- char_name = model.get_value(miter, 1)
- char_id = self.controller.char_name2id(char_name)
- sheet = self.controller.get_char_sheet(char_id)
-
- win.set_title(char_name)
-
- skillLabel = gtk.Label("Skills")
-
- name = gtk.Label("%s" % char_name)
- name.set_alignment(0, 0.5)
-
- race = gtk.Label("%s %s %s" % (sheet.gender, sheet.race,
- sheet.bloodLine))
- race.set_alignment(0, 0.5)
-
- corp = gtk.Label("Corp: %s" % sheet.corporationName)
- corp.set_alignment(0, 0.5)
-
- balance = gtk.Label("Balance: %s ISK" % sheet.balance)
- balance.set_alignment(0, 0.5)
-
- portrait = gtk.Image()
- portrait.set_from_file(self.controller.get_portrait(char_name, 256))
- portrait.show()
-
- hbox = gtk.HBox(False, 0)
-
- info_vbox = gtk.VBox(False, 0)
- info_vbox.pack_start(name, False, False, 1)
- info_vbox.pack_start(race, False, False, 1)
- info_vbox.pack_start(corp, False, False, 1)
- info_vbox.pack_start(balance, False, False, 1)
-
- hbox.pack_start(portrait, False, False, 10)
- hbox.pack_start(info_vbox, False, False, 5)
- #hbox.pack_start(stats_vbox, False, False, 5)
-
- vbox = gtk.VBox(False, 0)
- pannable_area.add_with_viewport(vbox)
-
- vbox.pack_start(hbox, False, False, 0)
- vbox.pack_start(skillLabel, False, False, 5)
-
- win.add(pannable_area)
- win.show_all()
-
- hildon.hildon_gtk_window_set_progress_indicator(win, 0)
-
- def create_char_model(self):
- lstore = gtk.ListStore(gtk.gdk.Pixbuf, gobject.TYPE_STRING)
-
- #get icon and name and put in a liststore
- self.fill_char_model(lstore)
-
- return lstore
-
-
- def fill_char_model(self, lstore):
- char_list = self.controller.get_characters()
-
- for name, icon in char_list:
- liter = lstore.append()
- lstore.set(liter, 1, name, 0, self.set_pix(icon))
-
-
- def update_model(self, lstore):
- lstore.clear()
- self.fill_char_model(lstore)
-
-
- def set_pix(self, filename):
- pixbuf = gtk.gdk.pixbuf_new_from_file(filename)
- return pixbuf
-
-
- def add_columns_to_treeview(self, treeview):
- #Column 0 for the treeview
- renderer = gtk.CellRendererPixbuf()
- column = gtk.TreeViewColumn()
- column.pack_start(renderer, True)
- column.add_attribute(renderer, "pixbuf", 0)
- treeview.append_column(column)
-
- #Column 1 for the treeview
- renderer = gtk.CellRendererText()
- column = gtk.TreeViewColumn('title', renderer, text=1)
- column.set_property("expand", True)
- treeview.append_column(column)
-
-
- def settings_clicked(self, button, window):
- dialog = gtk.Dialog()
-
- #get the vbox to pack all the settings into
- vbox = dialog.vbox
-
- dialog.set_transient_for(window)
- dialog.set_title("Settings")
-
- uidLabel = gtk.Label("User ID:")
- uidLabel.set_justify(gtk.JUSTIFY_LEFT)
- vbox.add(uidLabel)
-
- uidEntry = hildon.Entry(gtk.HILDON_SIZE_FINGER_HEIGHT)
- uidEntry.set_placeholder("User ID")
- uidEntry.set_text(self.controller.get_uid())
- uidEntry.set_property('is_focus', False)
-
- vbox.add(uidEntry)
-
- apiLabel = gtk.Label("API key:")
- apiLabel.set_justify(gtk.JUSTIFY_LEFT)
- vbox.add(apiLabel)
-
- apiEntry = hildon.Entry(gtk.HILDON_SIZE_FINGER_HEIGHT)
- apiEntry.set_placeholder("API Key")
- apiEntry.set_text(self.controller.get_api_key())
- apiEntry.set_property('is_focus', False)
-
- vbox.add(apiEntry)
-
- ok_button = dialog.add_button(gtk.STOCK_OK, gtk.RESPONSE_OK)
- help_button = dialog.add_button(gtk.STOCK_HELP, gtk.RESPONSE_HELP)
-
- dialog.show_all()
- result = dialog.run()
- if result == gtk.RESPONSE_OK:
- self.controller.set_api_key(apiEntry.get_text())
- self.controller.set_uid(uidEntry.get_text())
- self.controller.set_auth()
- self.update_model(self.char_model)
-
-
- dialog.destroy()
-
- return result
-
-
- def about_clicked(self, button):
- dialog = gtk.AboutDialog()
- dialog.set_website(self.about_website)
- dialog.set_website_label(self.about_website)
- dialog.set_name(self.about_name)
- dialog.set_authors(self.about_authors)
- dialog.set_comments(self.about_text)
- dialog.set_version(self.app_version)
- dialog.run()
- dialog.destroy()
-
-
- def refresh_clicked(self, button, window):
- self.update_model(self.char_model)
-
-
- def create_menu(self, window):
- menu = hildon.AppMenu()
-
- for command in self.menu_items:
- # Create menu entries
- button = hildon.GtkButton(gtk.HILDON_SIZE_AUTO)
- button.set_label(command)
-
- if command == "About":
- button.connect("clicked", self.about_clicked)
- elif command == "Settings":
- button.connect("clicked", self.settings_clicked, window)
- elif command == "Refresh":
- button.connect("clicked", self.refresh_clicked, window)
- else:
- assert False, command
-
- # Add entry to the view menu
- menu.append(button)
-
- menu.show_all()
-
- return menu
-
-
-if __name__ == "__main__":
- main()
-
projects / mevemon / commitdiff
