game.py

""" This serves as a nice interface to the game documents stored in the db.  

Any information that can be derived from just the game state itself, and 
doesn't depend on foreign information, such as about the particular 
players in the game or other games in the collection belongs here.
"""

import collections
import itertools
import re

from dominioncards import index_to_card, EVERY_SET_CARDS
from keys import *
from primitive_util import ConvertibleDefaultDict
import dominioncards

WIN, LOSS, TIE = range(3)

# Array indexes for the return value from Game.cards_gained_per_player()
BOUGHT=0           # Player bought or gained in own turn
GAINED=1           # Player bought or gained in any turn


class PlayerDeckChange(object):
    " This represents a change to a players deck in response to a game event."
    CATEGORIES = ['buys', 'gains', 'receives', 'returns', 'trashes', 'passes']

    def __init__(self, name):
        self.name = name
        # should I change this to using a dictionary of counts 
        # rather than a list?  Right now all the consumers ignore order,
        # but there is a similiar function specialized for accum in the
        # game class that uses a frequency dict.
        for cat in self.CATEGORIES:
            setattr(self, cat, [])
        self.vp_tokens = 0

    def merge_changes(self, other_changes):
        assert self.name == other_changes.name
        for cat in self.CATEGORIES:
            getattr(self, cat).extend(getattr(other_changes, cat))
        self.vp_tokens += other_changes.vp_tokens

    def __repr__(self):
        return "{classname}(player={player}, changes={changes})".format( \
            classname=self.__class__.__name__,
            player=self.name,
            changes=", ".join(self.changes()))

    def changes(self):
        s = []
        for cat in self.CATEGORIES:
            j = getattr(self, cat)
            if len(j) > 0:
                s.append(cat + '(' + ','.join(map(str, j)) + ')')
        return s

    def accumulates(self):
        return self.buys + self.gains + self.receives


def turn_decode(turn_dict, field):
    return [index_to_card(i) for i in turn_dict.get(field, [])]

class Turn(object):
    def __init__(self, turn_dict, game_dict, player, turn_no, poss_no):
        self.game_dict = game_dict
        self.player = player
        self.plays   = turn_decode(turn_dict, PLAYS)
        self.gains   = turn_decode(turn_dict, GAINS)
        self.buys    = turn_decode(turn_dict, BUYS)
        self.returns = turn_decode(turn_dict, RETURNS)
        self.trashes = turn_decode(turn_dict, TRASHES)
        self.passes = turn_decode(turn_dict, PASSES)
        self.receives = turn_decode(turn_dict, RECEIVES)
        self.turn_no = turn_no
        self.poss_no = poss_no
        self.is_outpost = OUTPOST in turn_dict
        self.money = turn_dict.get(MONEY, 0)
        self.vp_tokens = turn_dict.get(VP_TOKENS, 0)

        self.opp_info = {}
        for opp_index, info_dict in turn_dict.get(OPP, {}).iteritems():
            opp_name = self.game_dict[PLAYERS][int(opp_index)]
            change = PlayerDeckChange(opp_name)
            getattr(change, 'gains' ).extend(turn_decode(info_dict, GAINS))
            getattr(change, 'trashes').extend(turn_decode(info_dict, TRASHES))
            getattr(change, 'returns').extend(turn_decode(info_dict, RETURNS))
            getattr(change, 'receives').extend(turn_decode(info_dict, RECEIVES))
            getattr(change, 'passes').extend(turn_decode(info_dict, PASSES))
            change.vp_tokens += info_dict.get(VP_TOKENS, 0)
            self.opp_info[opp_name] = change

    def __repr__(self):
        return "{classname}(player={player}, turn/pos={turn_no}/{poss_no}, plays={plays_list})".format( \
            classname=self.__class__.__name__,
            player=self.player.name(),
            turn_no=self.turn_no,
            poss_no=self.poss_no,
            plays_list=", ".join(self.plays_list()))


    def plays_list(self):
        """Provide a list of the deck changes from this turn"""
        played = []
        if self.plays:
            played.append('Plays: %s' % self.plays)
        if self.buys:
            played.append('Buys: %s' % self.buys)
        if self.gains:
            played.append('Gains: %s' % self.gains)
        if self.trashes:
            played.append('Trashes: %s' % self.trashes)
        if self.returns:
            played.append('Returns: %s' % self.returns)
        if self.passes:
            played.append('Passes: %s' % self.passes)
        if self.receives:
            played.append('Receives: %s' % self.receives)
        return played


    def get_player(self):
        return self.player

    def player_accumulates(self):
        return self.buys + self.gains + self.receives

    def player_accumulates_except_receives(self):
        return self.buys + self.gains

    def player_receives(self):
        return self.receives

    def get_turn_no(self):
        return self.turn_no

    def get_poss_no(self):
        return self.poss_no

    def get_opp_info(self):
        return self.opp_info

    def turn_label(self, for_anchor=False, for_display=False):
        if self.is_outpost:
            fmt = u'%(pname)s-%(show)soutpost-turn-%(turn_no)d'
        elif self.poss_no:
            fmt = u'%(pname)s-%(show)sposs-turn-%(turn_no)d-%(poss_no)d'
        else:
            fmt = u'%(pname)s-%(show)sturn-%(turn_no)d'
        show = u'show-' if for_anchor else ''

        if for_display:
            fmt = fmt.replace('-', ' ')

        ret = fmt % {
            u'pname': self.player.name(),
            u'turn_no': self.turn_no - int(not (for_anchor or for_display)),
            u'poss_no': self.poss_no,
            u'show': show}

        if for_anchor:
            ret = ret.replace(' ', '-')
        return ret

    def deck_changes(self):
        ret = []
        my_change = PlayerDeckChange(self.player.name())
        ret.append(my_change)
        setattr(my_change, 'gains', self.gains)
        setattr(my_change, 'buys' , self.buys)
        setattr(my_change, 'trashes', self.trashes)
        setattr(my_change, 'returns', self.returns)
        setattr(my_change, 'passes', self.passes)
        setattr(my_change, 'receives', self.receives)
        my_change.vp_tokens += self.vp_tokens

        for change in self.opp_info.itervalues():
            ret.append(change)

        return ret

class PlayerDeck(object):
    def __init__(self, player_deck_dict, game):
        self.raw_player = player_deck_dict
        self.game = game
        self.player_name = player_deck_dict[NAME]
        self.win_points = player_deck_dict[WIN_POINTS]
        self.points = player_deck_dict[POINTS]
        self.deck = dict()
        for (index, count) in player_deck_dict[DECK].iteritems():
            self.deck[ index_to_card(int(index)) ] = count
        self.turn_order = player_deck_dict[ORDER]
        self.num_real_turns = 0

    def name(self):
        return self.player_name

    def Points(self):
        return self.points

    def ShortRenderLine(self):
        return '%s %d<br>' % (self.name(), self.Points())

    def WinPoints(self):
        return self.win_points

    def TurnOrder(self):
        return self.turn_order

    def Resigned(self):
        return self.raw_player[RESIGNED]

    def Deck(self):
        return self.deck

    def set_num_turns(self, t):
        self.num_real_turns = t

    def num_turns(self):
        return self.num_real_turns

    @staticmethod
    def PlayerLink(player_name, anchor_text=None):
        if anchor_text is None:
            anchor_text = player_name
        return '<a href="/player?player=%s">%s</a>' % (player_name,
                                                       anchor_text)

    def GameResultColor(self, opp=None):
        # this should be implemented in turns of GameResult.WinLossTie()
        if self.WinPoints() > 1:
            return 'green'
        if (opp and opp.WinPoints() == self.WinPoints()) or (
            self.WinPoints() == 1.0):
            return '#555555'
        return 'red'

    def __repr__(self):
        return "%s(win_points: %f, points: %d, turn_order: %d, deck: %s)" \
            % (self.__class__, self.win_points, self.points, self.turn_order, self.deck)


class Game(object):
    def __init__(self, game_dict):
        self.turns = []
        self.supply = [index_to_card(i) for i in game_dict[SUPPLY]]
        self.vetoes = game_dict.get(VETO, {})
        # pprint.pprint(game_dict)

        self.player_decks = [PlayerDeck(pd, self) for pd in game_dict[DECKS]]
        if START_DECKS in game_dict:
            self.player_start_decks = game_dict[START_DECKS]
        else:
            self.player_start_decks = None

        self.id = game_dict.get('_id', '')

        for raw_pd, pd in zip(game_dict[DECKS], self.player_decks):
            turn_ct = 0
            poss_ct = 0
            out_ct = 0
            for turn in raw_pd[TURNS]:
                if POSSESSION in turn:
                    poss_ct += 1
                elif OUTPOST in turn:
                    out_ct = 1
                else:
                    turn_ct += 1
                    poss_ct, out_ct = 0, 0
                self.turns.append(Turn(turn, game_dict, pd, turn_ct, poss_ct))
            pd.set_num_turns(turn_ct)

        self.turns.sort(key=lambda x: (x.get_turn_no(),
                                       x.get_player().TurnOrder(),
                                       x.get_poss_no()))


    def get_player_start_deck(self, player_name):
        """ Return the initial deck for the named player. """
        for p in self.player_start_decks:
            if p[NAME] == player_name:
                return p[START_DECK]
        assert ValueError, "%s not in players" % player_name

    def get_player_deck(self, player_name):
        """ Return the deck for the named player. """
        for p in self.player_decks:
            if p.name() == player_name:
                return p
        assert ValueError, "%s not in players" % player_name

    #TODO: this could be made into a property
    def get_turns(self):
        return self.turns

    def get_supply(self):
        return self.supply

    def get_player_decks(self, sort_by_turn_order=False):
        if sort_by_turn_order:
            return sorted(self.player_decks, key=PlayerDeck.TurnOrder)
        else:
            return self.player_decks

    def all_player_names(self):
        return [pd.name() for pd in self.player_decks]

    @staticmethod
    def get_date_from_id(game_id):
        GOKO_ID_RE = re.compile('([\d]{4}[\d]{2}[\d]{2})/log.*')
        match = GOKO_ID_RE.match(game_id)
        if match:
            return match.group(1)
        else:
            yyyymmdd_date = game_id.split('-')[1]
            return yyyymmdd_date

    @staticmethod
    def get_datetime_from_id(game_id):
        from datetime import datetime

        return datetime.strptime(Game.get_date_from_id(game_id), "%Y%m%d")

    def date(self):
        return Game.get_datetime_from_id(self.id)

    def get_id(self):
        return self.id

    def goko_url(self):
        return 'http://archive-dominionlogs.goko.com/%s' % self.id

    def isotropic_url(self):
        yyyymmdd_date = Game.get_date_from_id(self.id)
        path = '%s/%s/%s.gz' % (yyyymmdd_date[:6], yyyymmdd_date[-2:], self.id)
        return 'http://dominion.isotropic.org/gamelog/%s' % path

    @staticmethod
    def get_councilroom_link_from_id(game_id, extra=''):
        return '<a href="/game?game_id=%s"%s>' % (game_id, extra)

    def get_councilroom_open_link(self):
        return self.get_councilroom_link_from_id(self.id)

    def dubious_quality(self):
        num_players = len(set(pd.name() for pd in self.get_player_decks()))
        if num_players < len(self.get_player_decks()): return True

        total_accumed_by_players = self.cards_gained_per_player()[BOUGHT]
        for accumed_dict in total_accumed_by_players.itervalues():
            if sum(accumed_dict.itervalues()) < 5:
                return True

        return False

    def win_loss_tie(self, targ, other=None):
        targ_deck = self.get_player_deck(targ)

        if other is None:
            other_win_points = 2 if targ_deck.WinPoints() == 0 else 0
        else:
            other_win_points = self.get_player_deck(other).WinPoints()

        if targ_deck.WinPoints() == other_win_points:
            if targ_deck.WinPoints() > 0:
                return TIE
            return LOSS

        if targ_deck.WinPoints() > 1:
            return WIN
        if other_win_points > 1:
            return LOSS
        return TIE

    def total_cards_accumulated(self):
        ret = collections.defaultdict(int)
        for turn in self.get_turns():
            for accumed_card in turn.player_accumulates():
                ret[accumed_card] += 1
        return ret

    def cards_gained_per_player(self):
        """Returns a summary of the final cards held by players.

        Structure is an array of dict of dicts, containing how the
        cards were acquired (game.BOUGHT and game.GAINED), then player
        name and card. Lump in Masq receiving with gains.

        This keeps track of cards accumulated on a player's turn and
        those gained during the turns of other players.
        """
        if 'card_gained_cache' in self.__dict__:
            return self.card_gained_cache
        ret = [None] * 2
        ret[BOUGHT] = dict((pd.name(), collections.defaultdict(int)) for
                           pd in self.get_player_decks())
        ret[GAINED] = dict((pd.name(), collections.defaultdict(int)) for
                           pd in self.get_player_decks())

        for turn in self.get_turns():
            for accumed_card in turn.player_accumulates_except_receives():
                ret[BOUGHT][turn.get_player().name()][accumed_card] += 1
                ret[GAINED][turn.get_player().name()][accumed_card] += 1
            for accumed_card in turn.player_receives():
                ret[GAINED][turn.get_player().name()][accumed_card] += 1
            for name, change in turn.get_opp_info().iteritems():
                for card in change.accumulates():
                    ret[GAINED][name][card] += 1
        self.card_gained_cache = ret
        return ret

    def deck_changes_per_player(self):
        changes = {}
        for pd in self.get_player_decks():
            changes[pd.name()] = PlayerDeckChange(pd.name())
        for turn in self.get_turns():
            for change in turn.deck_changes():
                changes[change.name].merge_changes(change)
        return changes.values()

    def any_resigned(self):
        return any(pd.Resigned() for pd in self.get_player_decks())

    def short_render_cell_with_perspective(self, target_player,
                                           opp_player=None):
        target_deck = self.get_player_deck(target_player)
        opp_deck = None
        if opp_player is not None:
            opp_deck = self.get_player_deck(opp_player)
        color = target_deck.GameResultColor(opp_deck)

        ret = '<td>'
        ret += self.get_councilroom_open_link()
        ret += '<font color=%s>' % color
        ret += target_deck.ShortRenderLine()
        for player_deck in self.get_player_decks():
            if player_deck != target_deck:
                ret += player_deck.ShortRenderLine()
        ret += '</font></a></td>'
        return ret

    def game_state_iterator(self):
        return GameState(self)

    def get_opening(self, player):
        opening = []
        count = 0
        for turn in self.get_turns():
            if turn.player != player:
                continue
            count += 1
            opening += turn.buys

            if count >= 2:
                break
        return sorted(opening)
        

    def __repr__(self, print_turns=False):
        s = '== %s ==\n\tSupply: %s\n'%(self.id, self.supply)
        for pd in self.player_decks:
            s += '%s\n'%str(pd)
        if print_turns:
            for turn in self.turns:
                s += '%s\n'%str(turn)
        return s


def score_deck(deck_comp):
    """ Given a dict of cards (as card.Card) and frequency, return the score. """
    ret = 0
    if dominioncards.Feodum in deck_comp:
        ret += score_feodum(deck_comp)
    if dominioncards.Gardens in deck_comp:
        ret += score_gardens(deck_comp)
    if dominioncards.Duke in deck_comp:
        ret += score_duke(deck_comp)
    if dominioncards.Fairgrounds in deck_comp:
        ret += score_fairgrounds(deck_comp)
    if dominioncards.Vineyard in deck_comp:
        ret += score_vineyard(deck_comp)
    if dominioncards.SilkRoad in deck_comp:
        ret += score_silk_road(deck_comp)

    for cardinst in deck_comp:
        ret += cardinst.vp * deck_comp[cardinst]

    return ret

def score_feodum(deck_comp):
    return deck_comp[dominioncards.Feodum] * (deck_comp.get(dominioncards.Silver, 0)/3)

def score_gardens(deck_comp):
    deck_size = sum(deck_comp.itervalues())
    return deck_size / 10 * deck_comp[dominioncards.Gardens]

def score_duke(deck_comp):
    return deck_comp[dominioncards.Duke] * deck_comp.get(dominioncards.Duchy, 0)

def score_fairgrounds(deck_comp):
    return  2 * (len([count for count in deck_comp.values() if count>0] ) / 5) * deck_comp[dominioncards.Fairgrounds]

def score_vineyard(deck_comp):
    return sum(deck_comp[cardinst] if cardinst.is_action() else 0
               for cardinst in deck_comp) / 3 * deck_comp[dominioncards.Vineyard]

def score_silk_road(deck_comp):
    return sum(deck_comp[cardinst] if cardinst.is_victory() else 0
               for cardinst in deck_comp) / 4 * deck_comp[dominioncards.SilkRoad]

class GameState(object):
    def __init__(self, game):
        self.game = game
        self.turn_ordered_players = game.get_player_decks(
            sort_by_turn_order=True)
        self.supply = ConvertibleDefaultDict(value_type=int)
        num_players = len(game.get_player_decks())
        for cardinst in set(EVERY_SET_CARDS + game.get_supply()):
            self.supply[cardinst] = cardinst.num_copies_per_game(num_players)

        self.player_decks = ConvertibleDefaultDict(
            value_type=lambda: ConvertibleDefaultDict(int))
        self.player_start_decks = ConvertibleDefaultDict(
            value_type=lambda: ConvertibleDefaultDict(int))
        self.player_vp_tokens = collections.defaultdict(int)

        if game.player_start_decks is None:
            self.supply[dominioncards.Copper] = self.supply[dominioncards.Copper] - (len(self.turn_ordered_players) * 7)

            for player in self.turn_ordered_players:
                self.player_decks[player.name()][dominioncards.Copper] = 7
                self.player_decks[player.name()][dominioncards.Estate] = 3
        else:
            for start_deck in game.player_start_decks:
                for card in start_deck[START_DECK]:
                    self.supply[dominioncards.index_to_card(card)] -= 1
                    self.player_decks[start_deck[NAME]][dominioncards.index_to_card(card)] += 1

        self.turn_ind = 0

    def get_deck_composition(self, player):
        return self.player_decks[player]

    def player_score(self, player_name):
        return (score_deck(self.player_decks[player_name]) +
                self.player_vp_tokens[player_name])

    def encode_game_state(self):
        scores = {}
        for name in self.player_decks:
            scores[name] = self.player_score(name)

        ret = {
            'supply': self.supply.to_primitive_object(),
            'player_decks': self.player_decks.to_primitive_object(),
            'scores': scores,
            'label': self.turn_label(),
            'display_label': self.turn_label(for_display=True),
            'player': self.cur_turn.player.name() if self.cur_turn else '',
            'money': self.cur_turn.money if self.cur_turn else 0,
            'turn_no': self.cur_turn.turn_no if self.cur_turn else
              self.game.get_turns()[-1].turn_no + 1
            }
        return ret

    def _player_at_turn_ind(self, given_turn_ind):
        return self.game.get_turns()[given_turn_ind].get_player()

    def player_turn_order(self):
        ret = []
        l = len(self.turn_ordered_players)
        offset = self.turn_ind % l
        for i in range(l):
            ret.append(self.turn_ordered_players[(i + offset) % l].name())
        return ret

    def turn_index(self):
        return self.turn_ind

    def _take_turn(self, turn):
        def apply_diff(cards, name, supply_dir, deck_dir):
            for cardinst in cards:
                self.supply[cardinst] += supply_dir
                self.player_decks[name][cardinst] += deck_dir

        for deck_change in turn.deck_changes():
            apply_diff(getattr(deck_change, 'buys') + getattr(deck_change, 'gains') + getattr(deck_change, 'receives'),
                      deck_change.name, 0, 1)
            apply_diff(getattr(deck_change, 'trashes'), deck_change.name, 0, -1)
            apply_diff(getattr(deck_change, 'returns'), deck_change.name, 1, -1)
            apply_diff(getattr(deck_change, 'passes'), deck_change.name, 0, -1)
            self.player_vp_tokens[deck_change.name] += deck_change.vp_tokens

    def turn_label(self, for_anchor=False, for_display=False):
        if not self.cur_turn:
            return 'end-game'
        return self.cur_turn.turn_label(for_anchor, for_display)

    def __iter__(self):
        self.turn_ind = 0
        self.cur_turn = self.game.get_turns()[self.turn_ind]
        yield self  # this yield self crap is ugly, leads to bugs :(
        for turn_ind, turn in enumerate(self.game.get_turns()):
            self.turn_ind = turn_ind + 1
            if self.turn_ind < len(self.game.get_turns()):
                self.cur_turn = self.game.get_turns()[self.turn_ind]
            else:
                self.cur_turn = None
            self._take_turn(turn)
            yield self

            