ASFConnector.py

import logger
import requests
import json
from IPCProtocol import IPCProtocolHandler

LOG = None


class ASFConnector:

    def __init__(self, host='127.0.0.1', port='1242', path='/Api', password=None):
        global LOG
        LOG = logger.get_logger(__name__)

        self.host = host
        self.port = port
        self.path = path

        LOG.debug(__name__ + " initialized. Host: '%s'. Port: '%s'", host, port)
        self.connection_handler = IPCProtocolHandler(host, port, path, password)

    def get_asf_info(self):
        """" Fetches common info related to ASF as a whole. """
        data = self.connection_handler.get('/ASF')
        LOG.debug(data)
        return data

    def get_bot_info(self, bot):
        """ Fetches common info related to given bots. """
        LOG.debug('get_bot_info: bot {}'.format(bot))
        resource = '/Bot/' + bot
        response = self.connection_handler.get(resource)
        if 'Result' in response:
            message = ""
            for bot_name in response['Result']:
                message += 'Bot {}: '.format(bot_name)
                bot = response['Result'][bot_name]
                if bot['IsConnectedAndLoggedOn']:
                    cards_farmer = bot['CardsFarmer']
                    farm_message = ""
                    if cards_farmer['Paused']:
                        farm_message += 'Farming paused.'
                    elif cards_farmer['CurrentGamesFarming']:
                        farm_message += 'Currently farming games:'
                    for current_games in cards_farmer['CurrentGamesFarming']:
                        appid = current_games['AppID']
                        appname = current_games['GameName']
                        cards_remaining = current_games['CardsRemaining']
                        farm_message += '\n\t[{}/{}] {} cards remaining.'.format(appid, appname, cards_remaining)
                    if len(cards_farmer['GamesToFarm']) > 0:
                        farm_message += ' {} game(s) to farm ('.format(len(cards_farmer['GamesToFarm']))
                        for games_to_farm in cards_farmer['GamesToFarm']:
                            appid = games_to_farm['AppID']
                            appname = games_to_farm['GameName']
                            farm_message += '[{}/{}] '.format(appid, appname)
                        farm_message = farm_message[:-1] + "). "
                    time_remaining = cards_farmer['TimeRemaining']
                    if time_remaining != '00:00:00':
                        farm_message += 'Time remaining: {}'.format(time_remaining)
                    if len(farm_message) == 0:
                        farm_message += 'Idle.'
                    message += farm_message + '\n'
                else:
                    if len(bot['BotConfig']) == 0:
                        message += 'Not configured.\n'
                    else:
                        message += 'Offline.\n'
        elif response['Success']:
            message = 'Bot {} not found.'.format(bot)
        else:
            message = 'Getting bot info failed: {}'.format(response['Message'])
        return message

    def bot_redeem(self, bot, keys):
        """ Redeems cd-keys on given bot. """
        LOG.debug('bot_redeem: bot {}, keys {}'.format(bot, keys))
        assert type(keys) is set or type(keys) is str
        resource = '/Bot/' + bot + '/Redeem'
        if type(keys) is str:
            payload_keys = [keys]
        else:
            payload_keys = []
            for key in keys:
                payload_keys.append(key)
        data = {'KeysToRedeem': payload_keys}
        response = self.connection_handler.post(resource, payload=data)
        if 'Result' in response:
            results = response['Result']
            message = ""
            for bot_name in results:
                bot = results[bot_name]
                for key in bot:
                    if bot[key]:
                        message += "Bot {}: \n".format(bot_name)
                        if 'purchase_receipt_info' in bot[key] and bot[key]['purchase_receipt_info']:
                            purchase_receipt_info = bot[key]['purchase_receipt_info']
                            items = ''
                            # Parse items in the key
                            for item in purchase_receipt_info['line_items']:
                                items += '[{}, {}] '.format(item['packageid'], item['line_item_description'])
                            # Build message with the receipt info and the items
                            message += "\t[{}] {}: {}/{}\n".format(
                                key, items, purchase_receipt_info['purchase_status']
                                if type(purchase_receipt_info['purchase_status']) is str
                                else Result[purchase_receipt_info['purchase_status']],
                                purchase_receipt_info['result_detail'] if type(purchase_receipt_info['result_detail']) is str
                                else PurchaseResultDetail[purchase_receipt_info['result_detail']])
                        else:
                            message += "\t[{}] {}/{}\n".format(
                                key, bot[key]['Result'] if type(bot[key]['Result']) is str
                                else Result[bot[key]['Result']],
                                bot[key]['PurchaseResultDetail'] if type(bot[key]['PurchaseResultDetail']) is str
                                else PurchaseResultDetail[bot[key]['PurchaseResultDetail']])

        elif response['Success']:
            message = 'Bot {} not found.'.format(bot)
        else:
            message = 'Redeem failed: {}'.format(response['Message'])
        return message

    def send_command(self, command):
        """
        This API endpoint is supposed to be entirely replaced by ASF actions available under /Api/ASF/{action} and /Api/Bot/{bot}/{action}.
        You should use “given bot” commands when executing this endpoint, omitting targets of the command will cause the command to be executed on first defined bot
        """
        LOG.debug("Send command: {}".format(command))
        resource = '/Command/'
        data = {"Command": command}
        response = self.connection_handler.post(resource, payload=data)
        message = ""
        if response['Success']:
            message += response['Result']
        else:
            message += 'Command unsuccessful: {}'.format(response['Message'])

        return message


PurchaseResultDetail = {
    0: 'NoDetail',
    1: 'AVSFailure',
    2: 'InsufficientFunds',
    3: 'ContactSupport',
    4: 'Timeout',
    5: 'InvalidPackage',
    6: 'InvalidPaymentMethod',
    7: 'InvalidData',
    8: 'OthersInProgress',
    9: 'AlreadyPurchased',
    10: 'WrongPrice',
    11: 'FraudCheckFailed',
    12: 'CancelledByUser',
    13: 'RestrictedCountry',
    14: 'BadActivationCode',
    15: 'DuplicateActivationCode',
    16: 'UseOtherPaymentMethod',
    17: 'UseOtherFunctionSource',
    18: 'InvalidShippingAddress',
    19: 'RegionNotSupported',
    20: 'AcctIsBlocked',
    21: 'AcctNotVerified',
    22: 'InvalidAccount',
    23: 'StoreBillingCountryMismatch',
    24: 'DoesNotOwnRequiredApp',
    25: 'CanceledByNewTransaction',
    26: 'ForceCanceledPending',
    27: 'FailCurrencyTransProvider',
    28: 'FailedCyberCafe',
    29: 'NeedsPreApproval',
    30: 'PreApprovalDenied',
    31: 'WalletCurrencyMismatch',
    32: 'EmailNotValidated',
    33: 'ExpiredCard',
    34: 'TransactionExpired',
    35: 'WouldExceedMaxWallet',
    36: 'MustLoginPS3AppForPurchase',
    37: 'CannotShipToPOBox',
    38: 'InsufficientInventory',
    39: 'CannotGiftShippedGoods',
    40: 'CannotShipInternationally',
    41: 'BillingAgreementCancelled',
    42: 'InvalidCoupon',
    43: 'ExpiredCoupon',
    44: 'AccountLocked',
    45: 'OtherAbortableInProgress',
    46: 'ExceededSteamLimit',
    47: 'OverlappingPackagesInCart',
    48: 'NoWallet',
    49: 'NoCachedPaymentMethod',
    50: 'CannotRedeemCodeFromClient',
    51: 'PurchaseAmountNoSupportedByProvider',
    52: 'OverlappingPackagesInPendingTransaction',
    53: 'RateLimited',
    54: 'OwnsExcludedApp',
    55: 'CreditCardBinMismatchesType',
    56: 'CartValueTooHigh',
    57: 'BillingAgreementAlreadyExists',
    58: 'POSACodeNotActivated',
    59: 'CannotShipToCountry',
    60: 'HungTransactionCancelled',
    61: 'PaypalInternalError',
    62: 'UnknownGlobalCollectError',
    63: 'InvalidTaxAddress',
    64: 'PhysicalProductLimitExceeded',
    65: 'PurchaseCannotBeReplayed',
    66: 'DelayedCompletion',
    67: 'BundleTypeCannotBeGifted'
}

Result = {
    0: 'Invalid',
    1: 'OK',
    2: 'Fail',
    3: 'NoConnection',
    4: 'InvalidPassword',
    5: 'LoggedInElsewhere',
    6: 'InvalidProtocolVer',
    7: 'InvalidParam',
    8: 'FileNotFound',
    9: 'Busy',
    10: 'InvalidState',
    11: 'InvalidName',
    12: 'InvalidEmail',
    13: 'DuplicateName',
    14: 'AccessDenied',
    15: 'Timeout',
    16: 'Banned',
    17: 'AccountNotFound',
    18: 'InvalidSteamID',
    19: 'ServiceUnavailable',
    20: 'NotLoggedOn',
    21: 'Pending',
    22: 'EncryptionFailure',
    23: 'InsufficientPrivilege',
    24: 'LimitExceeded',
    25: 'Revoked',
    26: 'Expired',
    27: 'AlreadyRedeemed',
    28: 'DuplicateRequest',
    29: 'AlreadyOwned',
    30: 'IPNotFound',
    31: 'PersistFailed',
    32: 'LockingFailed',
    33: 'LogonSessionReplaced',
    34: 'ConnectFailed',
    35: 'HandshakeFailed',
    36: 'IOFailure',
    37: 'RemoteDisconnect',
    38: 'ShoppingCartNotFound',
    39: 'Blocked',
    40: 'Ignored',
    41: 'NoMatch',
    42: 'AccountDisabled',
    43: 'ServiceReadOnly',
    44: 'AccountNotFeatured',
    45: 'AdministratorOK',
    46: 'ContentVersion',
    47: 'TryAnotherCM',
    48: 'PasswordRequiredToKickSession',
    49: 'AlreadyLoggedInElsewhere',
    50: 'Suspended',
    51: 'Cancelled',
    52: 'DataCorruption',
    53: 'DiskFull',
    54: 'RemoteCallFailed',
    55: 'PasswordUnset',
    56: 'ExternalAccountUnlinked',
    57: 'PSNTicketInvalid',
    58: 'ExternalAccountAlreadyLinked',
    59: 'RemoteFileConflict',
    60: 'IllegalPassword',
    61: 'SameAsPreviousValue',
    62: 'AccountLogonDenied',
    63: 'CannotUseOldPassword',
    64: 'InvalidLoginAuthCode',
    65: 'AccountLogonDeniedNoMail',
    66: 'HardwareNotCapableOfIPT',
    67: 'IPTInitError',
    68: 'ParentalControlRestricted',
    69: 'FacebookQueryError',
    70: 'ExpiredLoginAuthCode',
    71: 'IPLoginRestrictionFailed',
    72: 'AccountLockedDown',
    73: 'AccountLogonDeniedVerifiedEmailRequired',
    74: 'NoMatchingURL',
    75: 'BadResponse',
    76: 'RequirePasswordReEntry',
    77: 'ValueOutOfRange',
    78: 'UnexpectedError',
    79: 'Disabled',
    80: 'InvalidCEGSubmission',
    81: 'RestrictedDevice',
    82: 'RegionLocked',
    83: 'RateLimitExceeded',
    84: 'AccountLoginDeniedNeedTwoFactor',
    85: 'ItemDeleted',
    86: 'AccountLoginDeniedThrottle',
    87: 'TwoFactorCodeMismatch',
    88: 'TwoFactorActivationCodeMismatch',
    89: 'AccountAssociatedToMultiplePartners',
    90: 'NotModified',
    91: 'NoMobileDevice',
    92: 'TimeNotSynced',
    93: 'SMSCodeFailed',
    94: 'AccountLimitExceeded',
    95: 'AccountActivityLimitExceeded',
    96: 'PhoneActivityLimitExceeded',
    97: 'RefundToWallet',
    98: 'EmailSendFailure',
    99: 'NotSettled',
    100: 'NeedCaptcha',
    101: 'GSLTDenied',
    102: 'GSOwnerDenied',
    103: 'InvalidItemType',
    104: 'IPBanned',
    105: 'GSLTExpired',
    106: 'InsufficientFunds',
    107: 'TooManyPending',
    108: 'NoSiteLicensesFound',
    109: 'WGNetworkSendExceeded',
    110: 'AccountNotFriends',
    111: 'LimitedUserAccount'
}