from eveapi import eveapi
import fetchimg
import apicache
+import os.path
+import traceback
+import time
+
+#conic is used for connection handling
+import conic
+#import socket for handling socket exceptions
+import socket
# 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 gui
- is_fremantle = True
else:
from ui.diablo import gui
- is_fremantle = False
class mEveMon():
+ """
+ The controller class for mEvemon. The intent is to help
+ abstract the EVE API and settings code from the UI code.
+
+ """
+
+ about_name = 'mEveMon'
+ about_text = ('Mobile character monitor for EVE Online')
+ about_authors = ['Ryan Campbell <campbellr@gmail.com>',
+ 'Danny Campbell <danny.campbell@gmail.com>']
+
+ about_website = 'http://mevemon.garage.maemo.org'
+ app_version = '0.4'
+
+
+ GCONF_DIR = "/apps/maemo/mevemon"
+
def __init__(self):
self.program = hildon.Program()
self.program.__init__()
self.gconf = gnome.gconf.client_get_default()
- self.set_auth()
+ #NOTE: remove this after a few releases
+ self.update_settings()
+ self.connect_to_network()
+ self.cached_api = eveapi.EVEAPIConnection( cacheHandler = \
+ apicache.cache_handler(debug=False))
self.gui = gui.mEveMonUI(self)
+ self.gui.run()
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 update_settings(self):
+ """
+ Update from the old pre 0.3 settings to the new settings layout.
+ We should remove this eventually, once no one is using pre-0.3 mEveMon
+ """
+ uid = self.gconf.get_string("%s/eve_uid" % self.GCONF_DIR)
+
+ if uid:
+ key = self.gconf.get_string("%s/eve_api_key" % self.GCONF_DIR)
+ self.add_account(uid, key)
+ self.gconf.unset("%s/eve_uid" % self.GCONF_DIR)
+ self.gconf.unset("%s/eve_api_key" % self.GCONF_DIR)
+
- def get_uid(self):
- return self.gconf.get_string("/apps/maemo/mevemon/eve_uid") or ''
+ def get_accounts(self):
+ """
+ Returns a dictionary containing uid:api_key pairs gathered from gconf
+ """
+ accounts = {}
+ entries = self.gconf.all_entries("%s/accounts" % self.GCONF_DIR)
- def set_api_key(self, key):
- self.gconf.set_string("/apps/maemo/mevemon/eve_api_key", key)
+ for entry in entries:
+ key = os.path.basename(entry.get_key())
+ value = entry.get_value().to_string()
+ accounts[key] = value
- def set_uid(self, uid):
- self.gconf.set_string("/apps/maemo/mevemon/eve_uid", uid)
+ return accounts
+
+ def get_api_key(self, uid):
+ """
+ Returns the api key associated with the given uid.
+ """
+ return self.gconf.get_string("%s/accounts/%s" % (self.GCONF_DIR, uid)) or ''
+ def remove_account(self, uid):
+ """
+ Removes the provided uid key from gconf
+ """
+ self.gconf.unset("%s/accounts/%s" % (self.GCONF_DIR, uid))
- def set_auth(self):
+ def add_account(self, uid, api_key):
"""
- 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
+ Adds the provided uid:api_key pair to gconf.
"""
- uid = self.get_uid()
- api_key = self.get_api_key()
- self.cached_api = eveapi.EVEAPIConnection( cacheHandler = \
- apicache.cache_handler( debug = False ) )
+ self.gconf.set_string("%s/accounts/%s" % (self.GCONF_DIR, uid), api_key)
+
+ def get_auth(self, uid):
+ """
+ Returns an authentication object to be used for eveapi calls
+ that require authentication.
+ """
+ api_key = self.get_api_key(uid)
+
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
+ auth = self.cached_api.auth(userID=uid, apiKey=api_key)
+ except Exception, e:
+ self.gui.report_error(str(e))
+ traceback.print_exc()
+ return None
+
+ return auth
+
+ def get_char_sheet(self, uid, char_id):
+ """
+ Returns an object containing information about the character specified
+ by the provided character ID.
+ """
try:
- sheet = self.auth.character(charID).CharacterSheet()
- except eveapi.Error, e:
- # we should really have a logger that logs this error somewhere
+ sheet = self.get_auth(uid).character(char_id).CharacterSheet()
+ except Exception, e:
+ self.gui.report_error(str(e))
+ # TODO: we should really have a logger that logs this error somewhere
+ traceback.print_exc()
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
+ def charid2uid(self, char_id):
+ """
+ Takes a character ID and returns the user ID of the account containing
+ the character.
+
+ Returns None if the character isn't found in any of the registered accounts.
+
+ """
+ acct_dict = self.get_accounts()
+
+ for uid, api_key in acct_dict.items():
+ auth = self.cached_api.auth(userID=uid, apiKey=api_key)
+ try:
+ api_char_list = auth.account.Characters()
+ characters = api_char_list.characters
+ except:
+ characters = []
+
+ for character in characters:
+ if character.characterID == char_id:
+ return uid
+
+
+ return None
+
+ def char_id2name(self, char_id):
+ """
+ Takes a character ID and returns the character name associated with
+ that ID.
+ The EVE API accepts a comma-separated list of IDs, but for now we
+ will just handle a single ID.
+ """
try:
- chars = self.cached_api.eve.CharacterName(ids=charID).characters
+ chars = self.cached_api.eve.CharacterName(ids=char_id).characters
name = chars[0].characterName
- except eveapi.Error, e:
+ except Exception, e:
+ self.gui.report_error(str(e))
+ traceback.print_exc()
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
+ """
+ Takes the name of an EVE character and returns the characterID.
+
+ The EVE api accepts a comma separated list of names, but for now
+ we will just handle single names/
+ """
try:
chars = self.cached_api.eve.CharacterID(names=name).characters
char_id = chars[0].characterID
- except eveapi.Error, e:
+ char_name = chars[0].name
+ except Exception, e:
+ self.gui.report_error(str(e))
+ traceback.print_exc()
return None
return char_id
-
- def get_characters( self ):
+ def get_chars_from_acct(self, uid):
+ """
+ Returns a list of characters associated with the provided user ID.
"""
- returns a list containing a single character with an error message for a
- name, if there's a problem. FIXME --danny
+ auth = self.get_auth(uid)
+ if not auth:
+ return None
+ else:
+ try:
+ api_char_list = auth.account.Characters()
+ char_list = [char.name for char in api_char_list.characters]
+ except Exception, e:
+ self.gui.report_error(str(e))
+ traceback.print_exc()
+ return None
+
+ return char_list
+
+ def get_characters(self):
"""
+ Returns a list of (character_name, image_path, uid) tuples from all the
+ accounts that are registered to mEveMon.
+
+ If there is an authentication issue, then instead of adding a valid
+ pair to the list, it appends an 'error message'
+
+ """
+
ui_char_list = []
err_img = "/usr/share/mevemon/imgs/error.jpg"
+ err_txt = "Problem fetching info for account"
- placeholder_chars = [("Please check your API settings.", err_img)]
- 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
- return placeholder_chars
- #raise
+ placeholder_chars = (err_txt, err_img, None)
+
+ acct_dict = self.get_accounts()
+ if not acct_dict:
+ return [placeholder_chars]
+ for uid in acct_dict.keys():
+ char_names = self.get_chars_from_acct(uid)
+
+ if not char_names:
+ ui_char_list.append((err_txt + "\t(UID: %s)" % uid, err_img, None))
+ else:
+ # append each char we get to the list we'll return to the
+ # UI --danny
+ for char_name in char_names:
+ ui_char_list.append((char_name, self.get_portrait(char_name, 64) , uid) )
+
return ui_char_list
def get_portrait(self, char_name, size):
"""
- returns the relative path of the retrieved portrait
+ Returns the file path of the retrieved portrait
"""
- charID = self.char_name2id(char_name)
- return fetchimg.portrait_filename(charID, size)
+ char_id = self.char_name2id(char_name)
+
+ return fetchimg.portrait_filename(char_id, size)
def get_skill_tree(self):
+ """
+ Returns an object from eveapi containing skill tree info
+ """
try:
tree = self.cached_api.eve.SkillTree()
- except eveapi.Error, e:
- print e
+ except Exception, e:
+ self.gui.report_error(str(e))
+ traceback.print_exc()
return None
return tree
- def get_skill_in_training(self, charID):
+ def get_skill_in_training(self, uid, char_id):
+ """
+ Returns an object from eveapi containing information about the
+ current skill in training
+ """
try:
- skill = self.auth.character(charID).SkillInTraining()
- except:
- print e
+ skill = self.get_auth(uid).character(char_id).SkillInTraining()
+ except Exception, e:
+ self.gui.report_error(str(e))
+ traceback.print_exc()
return None
return skill
+ def connection_cb(self, connection, event, mgc):
+ """
+ I'm not sure why we need this, but connection.connect() won't work
+ without it, even empty.
+ """
+ pass
+
+
+ def connect_to_network(self):
+ """
+ This will connect to the default network if avaliable, or pop up the
+ connection dialog to select a connection.
+ Running this when we start the program ensures we are connected to a
+ network.
+ """
+ connection = conic.Connection()
+ #why 0xAA55?
+ connection.connect("connection-event", self.connection_cb, 0xAA55)
+ assert(connection.request_connection(conic.CONNECT_FLAG_NONE))
+
+
+ def get_sp(self, uid, char_id):
+ """
+ Adds up the SP for all known skills, then calculates the SP gained
+ from an in-training skill.
+ """
+ actual_sp = 0
+
+ sheet = self.get_char_sheet(uid, char_id)
+ for skill in sheet.skills:
+ actual_sp += skill.skillpoints
+
+ live_sp = actual_sp + self.get_training_sp(uid, char_id)
+
+ return live_sp
+
+ def get_spps(self, uid, char_id):
+ """
+ Calculate and returns the skill points per hour for the given character.
+ """
+ skill = self.get_skill_in_training(uid, char_id)
+
+ if not skill.skillInTraining:
+ return (0, 0)
+
+ total_sp = skill.trainingDestinationSP - skill.trainingStartSP
+ total_time = skill.trainingEndTime - skill.trainingStartTime
+
+ spps = float(total_sp) / total_time
+
+ return (spps, skill.trainingStartTime)
+
+ def get_training_sp(self, uid, char_id):
+ """
+ returns the additional SP that the in-training skill has acquired
+ """
+ spps_tuple = self.get_spps(uid, char_id)
+
+ if not spps_tuple:
+ return 0
+ spps, start_time = spps_tuple
+ eve_time = time.time() #evetime is utc, right?
+ time_diff = eve_time - start_time
+
+ return (spps * time_diff)
+
if __name__ == "__main__":
app = mEveMon()
projects / mevemon / blobdiff