from builtins import str from builtins import range from builtins import object import base64 import csv import requests from typing import TYPE_CHECKING # TODO: see https://github.com/EDCD/EDMarketConnector/issues/569 from http.cookiejar import LWPCookieJar # noqa: F401 - No longer needed but retained in case plugins use it from email.utils import parsedate import hashlib import numbers import os from os.path import join import random import time import urllib.parse import webbrowser from config import appname, appversion, config from protocol import protocolhandler import logging logger = logging.getLogger(appname) if TYPE_CHECKING: _ = lambda x: x # noqa # to make flake8 stop complaining that the hacked in _ method doesnt exist holdoff = 60 # be nice timeout = 10 # requests timeout auth_timeout = 30 # timeout for initial auth # Currently the "Elite Dangerous Market Connector (EDCD/Athanasius)" one in # Athanasius' Frontier account # Obtain from https://auth.frontierstore.net/client/signup CLIENT_ID = os.getenv('CLIENT_ID') or 'fb88d428-9110-475f-a3d2-dc151c2b9c7a' SERVER_AUTH = 'https://auth.frontierstore.net' URL_AUTH = '/auth' URL_TOKEN = '/token' USER_AGENT = 'EDCD-{}-{}'.format(appname, appversion) SERVER_LIVE = 'https://companion.orerve.net' SERVER_BETA = 'https://pts-companion.orerve.net' URL_QUERY = '/profile' URL_MARKET = '/market' URL_SHIPYARD= '/shipyard' # Map values reported by the Companion interface to names displayed in-game # May be imported by plugins category_map = { 'Narcotics' : 'Legal Drugs', 'Slaves' : 'Slavery', 'Waste ' : 'Waste', 'NonMarketable' : False, # Don't appear in the in-game market so don't report } commodity_map = {} ship_map = { 'adder' : 'Adder', 'anaconda' : 'Anaconda', 'asp' : 'Asp Explorer', 'asp_scout' : 'Asp Scout', 'belugaliner' : 'Beluga Liner', 'cobramkiii' : 'Cobra MkIII', 'cobramkiv' : 'Cobra MkIV', 'clipper' : 'Panther Clipper', 'cutter' : 'Imperial Cutter', 'diamondback' : 'Diamondback Scout', 'diamondbackxl' : 'Diamondback Explorer', 'dolphin' : 'Dolphin', 'eagle' : 'Eagle', 'empire_courier' : 'Imperial Courier', 'empire_eagle' : 'Imperial Eagle', 'empire_fighter' : 'Imperial Fighter', 'empire_trader' : 'Imperial Clipper', 'federation_corvette' : 'Federal Corvette', 'federation_dropship' : 'Federal Dropship', 'federation_dropship_mkii' : 'Federal Assault Ship', 'federation_gunship' : 'Federal Gunship', 'federation_fighter' : 'F63 Condor', 'ferdelance' : 'Fer-de-Lance', 'hauler' : 'Hauler', 'independant_trader' : 'Keelback', 'independent_fighter' : 'Taipan Fighter', 'krait_mkii' : 'Krait MkII', 'krait_light' : 'Krait Phantom', 'mamba' : 'Mamba', 'orca' : 'Orca', 'python' : 'Python', 'scout' : 'Taipan Fighter', 'sidewinder' : 'Sidewinder', 'testbuggy' : 'Scarab', 'type6' : 'Type-6 Transporter', 'type7' : 'Type-7 Transporter', 'type9' : 'Type-9 Heavy', 'type9_military' : 'Type-10 Defender', 'typex' : 'Alliance Chieftain', 'typex_2' : 'Alliance Crusader', 'typex_3' : 'Alliance Challenger', 'viper' : 'Viper MkIII', 'viper_mkiv' : 'Viper MkIV', 'vulture' : 'Vulture', } # Companion API sometimes returns an array as a json array, sometimes as a json object indexed by "int". # This seems to depend on whether the there are 'gaps' in the Cmdr's data - i.e. whether the array is sparse. # In practice these arrays aren't very sparse so just convert them to lists with any 'gaps' holding None. def listify(thing): if thing is None: return [] # data is not present elif isinstance(thing, list): return list(thing) # array is not sparse elif isinstance(thing, dict): retval = [] for k, v in thing.items(): idx = int(k) if idx >= len(retval): retval.extend([None] * (idx - len(retval))) retval.append(v) else: retval[idx] = v return retval else: raise ValueError("expected an array or sparse array, got {!r}".format(thing)) class ServerError(Exception): def __init__(self, *args): # Raised when cannot contact the Companion API server self.args = args if not args: self.args = (_('Error: Frontier server is down'),) class ServerLagging(Exception): def __init__(self, *args): # Raised when Companion API server is returning old data, e.g. when the servers are too busy self.args = args if not args: self.args = (_('Error: Frontier server is lagging'),) class SKUError(Exception): def __init__(self, *args): # Raised when the Companion API server thinks that the user has not purchased E:D # i.e. doesn't have the correct 'SKU' self.args = args if not args: self.args = (_('Error: Frontier server SKU problem'),) class CredentialsError(Exception): def __init__(self, *args): self.args = args if not args: self.args = (_('Error: Invalid Credentials'),) class CmdrError(Exception): def __init__(self, *args): # Raised when the user has multiple accounts and the username/password setting is not for # the account they're currently playing OR the user has reset their Cmdr and the Companion API # server is still returning data for the old Cmdr self.args = args if not args: self.args = (_('Error: Wrong Cmdr'),) class Auth(object): def __init__(self, cmdr): self.cmdr = cmdr self.session = requests.Session() self.session.headers['User-Agent'] = USER_AGENT self.verifier = self.state = None def refresh(self): # Try refresh token. Returns new refresh token if successful, otherwise makes new authorization request. logger.debug(f'Trying for "{self.cmdr}"') self.verifier = None cmdrs = config.get('cmdrs') logger.debug(f'Cmdrs: {cmdrs}') idx = cmdrs.index(self.cmdr) logger.debug(f'idx = {idx}') tokens = config.get('fdev_apikeys') or [] tokens = tokens + [''] * (len(cmdrs) - len(tokens)) if tokens[idx]: logger.debug('We have a refresh token for that idx') try: data = { 'grant_type': 'refresh_token', 'client_id': CLIENT_ID, 'refresh_token': tokens[idx], } logger.debug('Attempting refresh with Frontier...') r = self.session.post(SERVER_AUTH + URL_TOKEN, data=data, timeout=auth_timeout) if r.status_code == requests.codes.ok: data = r.json() tokens[idx] = data.get('refresh_token', '') config.set('fdev_apikeys', tokens) config.save() # Save settings now for use by command-line app return data.get('access_token') else: logger.error(f"Frontier CAPI Auth: Can't refresh token for \"{self.cmdr}\"") self.dump(r) except Exception as e: logger.exception(f"Frontier CAPI Auth: Can't refresh token for \"{self.cmdr}\"") else: logger.error(f"Frontier CAPI Auth: No token for \"{self.cmdr}\"") # New request logger.info('Frontier CAPI Auth: New authorization request') v = random.SystemRandom().getrandbits(8 * 32) self.verifier = self.base64_url_encode(v.to_bytes(32, byteorder='big')).encode('utf-8') s = random.SystemRandom().getrandbits(8 * 32) self.state = self.base64_url_encode(s.to_bytes(32, byteorder='big')) # Won't work under IE: https://blogs.msdn.microsoft.com/ieinternals/2011/07/13/understanding-protocols/ logger.debug(f'Trying auth from scratch for Commander "{self.cmdr}"') webbrowser.open( '{server_auth}{url_auth}?response_type=code&audience=frontier&scope=capi&client_id={client_id}&code_challenge={challenge}&code_challenge_method=S256&state={state}&redirect_uri={redirect}'.format( # noqa: E501 # I cant make this any shorter server_auth=SERVER_AUTH, url_auth=URL_AUTH, client_id=CLIENT_ID, challenge=self.base64_url_encode(hashlib.sha256(self.verifier).digest()), state=self.state, redirect=protocolhandler.redirect ) ) def authorize(self, payload): logger.debug('Checking oAuth authorization callback') # Handle OAuth authorization code callback. # Returns access token if successful, otherwise raises CredentialsError if '?' not in payload: logger.error(f'Frontier CAPI Auth: Malformed response (no "?" in payload)\n{payload}\n') raise CredentialsError('malformed payload') # Not well formed data = urllib.parse.parse_qs(payload[(payload.index('?') + 1):]) if not self.state or not data.get('state') or data['state'][0] != self.state: logger.error(f'Frontier CAPI Auth: Unexpected response\n{payload}\n') raise CredentialsError('Unexpected response from authorization {!r}'.format(payload)) # Unexpected reply if not data.get('code'): logger.error(f'Frontier CAPI Auth: Negative response (no "code" in returned data)\n{payload}\n') error = next( (data[k] for k in ('error_description', 'error', 'message') if k in data), ('',) ) raise CredentialsError('Error: {!r}'.format(error)[0]) try: logger.debug('Got code, posting it back...') r = None data = { 'grant_type': 'authorization_code', 'client_id': CLIENT_ID, 'code_verifier': self.verifier, 'code': data['code'][0], 'redirect_uri': protocolhandler.redirect, } r = self.session.post(SERVER_AUTH + URL_TOKEN, data=data, timeout=auth_timeout) data = r.json() if r.status_code == requests.codes.ok: logger.info(f'Frontier CAPI Auth: New token for \"{self.cmdr}\"') cmdrs = config.get('cmdrs') idx = cmdrs.index(self.cmdr) tokens = config.get('fdev_apikeys') or [] tokens = tokens + [''] * (len(cmdrs) - len(tokens)) tokens[idx] = data.get('refresh_token', '') config.set('fdev_apikeys', tokens) config.save() # Save settings now for use by command-line app return data.get('access_token') except Exception as e: logger.exception(f"Frontier CAPI Auth: Can't get token for \"{self.cmdr}\"") if r: self.dump(r) raise CredentialsError('unable to get token') from e logger.error(f"Frontier CAPI Auth: Can't get token for \"{self.cmdr}\"") self.dump(r) error = next((data[k] for k in ('error_description', 'error', 'message') if k in data), ('',)) raise CredentialsError('Error: {!r}'.format(error)[0]) @staticmethod def invalidate(cmdr): logger.info(f'Frontier CAPI Auth: Invalidated token for "{cmdr}"') cmdrs = config.get('cmdrs') idx = cmdrs.index(cmdr) tokens = config.get('fdev_apikeys') or [] tokens = tokens + [''] * (len(cmdrs) - len(tokens)) tokens[idx] = '' config.set('fdev_apikeys', tokens) config.save() # Save settings now for use by command-line app def dump(self, r): logger.debug(f'Frontier CAPI Auth: {r.url} {r.status_code} {r.reason if r.reason else "None"} {r.text}') def base64_url_encode(self, text): return base64.urlsafe_b64encode(text).decode().replace('=', '') class Session(object): STATE_INIT, STATE_AUTH, STATE_OK = list(range(3)) def __init__(self): self.state = Session.STATE_INIT self.credentials = None self.session = None self.auth = None self.retrying = False # Avoid infinite loop when successful auth / unsuccessful query def login(self, cmdr=None, is_beta=None): # Returns True if login succeeded, False if re-authorization initiated. if not CLIENT_ID: logger.error('CLIENT_ID is None') raise CredentialsError('cannot login without a valid Client ID') # TODO: WTF is the intent behind this logic ? if not cmdr or is_beta is None: # Use existing credentials if not self.credentials: logger.error('self.credentials is None') raise CredentialsError('Missing credentials') # Shouldn't happen elif self.state == Session.STATE_OK: logger.debug('already logged in') return True # already logged in else: credentials = {'cmdr': cmdr, 'beta': is_beta} if self.credentials == credentials and self.state == Session.STATE_OK: logger.debug('already logged in (is_beta)') return True # already logged in else: # changed account or retrying login during auth logger.debug('changed account or retrying login during auth') self.close() self.credentials = credentials self.server = self.credentials['beta'] and SERVER_BETA or SERVER_LIVE self.state = Session.STATE_INIT self.auth = Auth(self.credentials['cmdr']) access_token = self.auth.refresh() if access_token: logger.debug('We have an access_token') self.auth = None self.start(access_token) return True else: logger.debug('We do NOT have an access_token') self.state = Session.STATE_AUTH return False # Wait for callback # Callback from protocol handler def auth_callback(self): logger.debug('Handling callback from edmc:// handler') if self.state != Session.STATE_AUTH: # Shouldn't be getting a callback logger.debug('Got an auth callback while not doing auth') raise CredentialsError('Got an auth callback while not doing auth') try: logger.debug('Trying authorize with payload from handler') self.start(self.auth.authorize(protocolhandler.lastpayload)) self.auth = None except Exception: logger.exception('Failed, will try again next login or query') self.state = Session.STATE_INIT # Will try to authorize again on next login or query self.auth = None raise # Bad thing happened def start(self, access_token): logger.debug('Starting session') self.session = requests.Session() self.session.headers['Authorization'] = 'Bearer {}'.format(access_token) self.session.headers['User-Agent'] = USER_AGENT self.state = Session.STATE_OK def query(self, endpoint): logger.debug(f'Performing query for endpoint "{endpoint}"') if self.state == Session.STATE_INIT: if self.login(): return self.query(endpoint) elif self.state == Session.STATE_AUTH: logger.error('cannot make a query when unauthorized') raise CredentialsError('cannot make a query when unauthorized') try: logger.debug('Trying...') r = self.session.get(self.server + endpoint, timeout=timeout) except Exception as e: logger.debug('Attempting GET', exc_info=e) raise ServerError(f'unable to get endpoint {endpoint}') from e if r.url.startswith(SERVER_AUTH): logger.debug('Redirected back to Auth Server') # Redirected back to Auth server - force full re-authentication self.dump(r) self.invalidate() self.retrying = False self.login() raise CredentialsError() elif 500 <= r.status_code < 600: # Server error. Typically 500 "Internal Server Error" if server is down logger.debug('500 status back from CAPI') self.dump(r) raise ServerError('Received error {} from server'.format(r.status_code)) try: r.raise_for_status() # Typically 403 "Forbidden" on token expiry data = r.json() # May also fail here if token expired since response is empty except (requests.HTTPError, ValueError) as e: logger.exception('Frontier CAPI Auth: GET ') self.dump(r) self.close() if self.retrying: # Refresh just succeeded but this query failed! Force full re-authentication logger.error('Frontier CAPI Auth: query failed after refresh') self.invalidate() self.retrying = False self.login() raise CredentialsError('query failed after refresh') from e elif self.login(): # Maybe our token expired. Re-authorize in any case logger.debug('Maybe our token expired.') self.retrying = True return self.query(endpoint) else: self.retrying = False logger.error('Frontier CAPI Auth: HTTP error or invalid JSON') raise CredentialsError('HTTP error or invalid JSON') from e self.retrying = False if 'timestamp' not in data: logger.debug('timestamp not in data, adding from response headers') data['timestamp'] = time.strftime('%Y-%m-%dT%H:%M:%SZ', parsedate(r.headers['Date'])) return data def profile(self): return self.query(URL_QUERY) def station(self): data = self.query(URL_QUERY) if data['commander'].get('docked'): services = data['lastStarport'].get('services', {}) last_starport_name = data['lastStarport']['name'] last_starport_id = int(data['lastStarport']['id']) if services.get('commodities'): marketdata = self.query(URL_MARKET) if (last_starport_name != marketdata['name'] or last_starport_id != int(marketdata['id'])): raise ServerLagging() else: data['lastStarport'].update(marketdata) if services.get('outfitting') or services.get('shipyard'): shipdata = self.query(URL_SHIPYARD) if (last_starport_name != shipdata['name'] or last_starport_id != int(shipdata['id'])): raise ServerLagging() else: data['lastStarport'].update(shipdata) return data def close(self): self.state = Session.STATE_INIT if self.session: try: self.session.close() except Exception as e: logger.debug('Frontier CAPI Auth: closing', exc_info=e) self.session = None def invalidate(self): logger.debug('Forcing a full re-authentication') # Force a full re-authentication self.close() Auth.invalidate(self.credentials['cmdr']) def dump(self, r): logger.error(f'Frontier CAPI Auth: {r.url} {r.status_code} {r.reason and r.reason or "None"} {r.text}') # Returns a shallow copy of the received data suitable for export to older tools # English commodity names and anomalies fixed up def fixup(data): if not commodity_map: # Lazily populate for f in ('commodity.csv', 'rare_commodity.csv'): with open(join(config.respath, f), 'r') as csvfile: reader = csv.DictReader(csvfile) for row in reader: commodity_map[row['symbol']] = (row['category'], row['name']) commodities = [] for commodity in data['lastStarport'].get('commodities') or []: # Check all required numeric fields are present and are numeric # Catches "demandBracket": "" for some phantom commodites in # ED 1.3 - https://github.com/Marginal/EDMarketConnector/issues/2 # # But also see https://github.com/Marginal/EDMarketConnector/issues/32 for thing in ('buyPrice', 'sellPrice', 'demand', 'demandBracket', 'stock', 'stockBracket'): if not isinstance(commodity.get(thing), numbers.Number): logger.debug(f'Invalid {thing}:{commodity.get(thing)} ({type(commodity.get(thing))}) for {commodity.get("name", "")}') # noqa: E501 break else: # Check not marketable i.e. Limpets if not category_map.get(commodity['categoryname'], True): pass # Check not normally stocked e.g. Salvage elif commodity['demandBracket'] == 0 and commodity['stockBracket'] == 0: pass elif commodity.get('legality'): # Check not prohibited pass elif not commodity.get('categoryname'): logger.debug(f'Missing "categoryname" for {commodity.get("name", "")}') elif not commodity.get('name'): logger.debug(f'Missing "name" for a commodity in {commodity.get("categoryname", "")}') elif not commodity['demandBracket'] in range(4): logger.debug(f'Invalid "demandBracket":{commodity["demandBracket"]} for {commodity["name"]}') elif not commodity['stockBracket'] in range(4): logger.debug(f'Invalid "stockBracket":{commodity["stockBracket"]} for {commodity["name"]}') else: # Rewrite text fields new = dict(commodity) # shallow copy if commodity['name'] in commodity_map: (new['categoryname'], new['name']) = commodity_map[commodity['name']] elif commodity['categoryname'] in category_map: new['categoryname'] = category_map[commodity['categoryname']] # Force demand and stock to zero if their corresponding bracket is zero # Fixes spurious "demand": 1 in ED 1.3 if not commodity['demandBracket']: new['demand'] = 0 if not commodity['stockBracket']: new['stock'] = 0 # We're good commodities.append(new) # return a shallow copy datacopy = data.copy() datacopy['lastStarport'] = data['lastStarport'].copy() datacopy['lastStarport']['commodities'] = commodities return datacopy # Return a subset of the received data describing the current ship def ship(data): def filter_ship(d): filtered = {} for k, v in d.items(): if v == []: pass # just skip empty fields for brevity elif k in ('alive', 'cargo', 'cockpitBreached', 'health', 'oxygenRemaining', 'rebuilds', 'starsystem', 'station'): pass # noisy elif k in ('locDescription', 'locName') or k.endswith('LocDescription') or k.endswith('LocName'): pass # also noisy, and redundant elif k in ('dir', 'LessIsGood'): pass # dir is not ASCII - remove to simplify handling elif hasattr(v, 'items'): filtered[k] = filter_ship(v) else: filtered[k] = v return filtered # subset of "ship" that's not noisy return filter_ship(data['ship']) # Ship name suitable for writing to a file def ship_file_name(ship_name, ship_type): name = str(ship_name or ship_map.get(ship_type.lower(), ship_type)).strip() if name.endswith('.'): name = name[:-1] if name.lower() in ('con', 'prn', 'aux', 'nul', 'com1', 'com2', 'com3', 'com4', 'com5', 'com6', 'com7', 'com8', 'com9', 'lpt1', 'lpt2', 'lpt3', 'lpt4', 'lpt5', 'lpt6', 'lpt7', 'lpt8', 'lpt9'): name = name + '_' return name.translate({ord(x): u'_' for x in ('\0', '<', '>', ':', '"', '/', '\\', '|', '?', '*')}) # singleton session = Session()