xonstat/views/helpers.py

   1 import logging
   2 import sqlalchemy.sql.expression as expr
   3 from datetime import datetime
   4 from sqlalchemy.orm import aliased
   5 from xonstat.models import *
   6 from xonstat.util import *
   7
   8 log = logging.getLogger(__name__)
   9
  10 class RecentGame(object):
  11     '''
  12     This is a helper class to facilitate showing recent games
  13     data within mako. The idea is to take the results of a query
  14     and transform it into class members easily accessible later.
  15     It is like a namedtuple but a little easier to form.
  16
  17     The constructor takes a query row that has been fetched, and
  18     it requires the following columns to be present in the row:
  19
  20         game_id, game_type_cd, game_type_descr, winner, start_dt,
  21         server_id, server_name, map_id, map_name, player_id, nick,
  22         rank, team
  23
  24     The following columns are optional:
  25
  26         elo_delta
  27
  28     This class is meant to be used in conjunction with recent_games_q,
  29     which will return rows matching this specification.
  30     '''
  31     def __init__(self, row):
  32         self.game_id = row.game_id
  33         self.game_type_cd = row.game_type_cd
  34         self.game_type_descr = row.game_type_descr
  35         self.winner = row.winner
  36         self.start_dt = row.start_dt
  37         self.fuzzy_date = pretty_date(row.start_dt)
  38         self.epoch = timegm(row.start_dt.timetuple())
  39         self.server_id = row.server_id
  40         self.server_name = row.server_name
  41         self.map_id = row.map_id
  42         self.map_name = row.map_name
  43         self.player_id = row.player_id
  44         self.nick = row.nick
  45         self.nick_html_colors = html_colors(row.nick)
  46         self.rank = row.rank
  47         self.team = row.team
  48
  49         try:
  50             self.elo_delta = row.elo_delta
  51         except:
  52             self.elo_delta = None
  53
  54     def _asdict(self):
  55         return {
  56             "game_id": self.game_id,
  57             "game_type_cd": self.game_type_cd,
  58             "game_type_descr": self.game_type_descr,
  59             "winner": self.winner,
  60             "start_dt": self.start_dt,
  61             "fuzzy_dt": self.fuzzy_date,
  62             "epoch": self.epoch,
  63             "server_id": self.server_id,
  64             "server_name": self.server_name,
  65             "map_id": self.map_id,
  66             "map_name": self.map_name,
  67             "player_id": self.player_id,
  68             "nick": self.nick,
  69             "nick_html_colors": self.nick_html_colors,
  70             "rank": self.rank,
  71             "team": self.team,
  72             "elo_delta": self.elo_delta,
  73             }
  74
  75     def __repr__(self):
  76         return "<RecentGame(id=%s, gametype=%s, server=%s, map=%s)>" % (self.game_id, self.game_type_cd, self.server_name, self.map_name)
  77
  78
  79 def recent_games_q(server_id=None, map_id=None, player_id=None,
  80         game_type_cd=None, cutoff=None, force_player_id=False):
  81     '''
  82     Returns a SQLA query of recent game data. Parameters filter
  83     the results returned if they are provided. If not, it is
  84     assumed that results from all servers and maps is desired.
  85
  86     The cutoff parameter provides a way to limit how far back to
  87     look when querying. Only games that happened on or after the
  88     cutoff (which is a datetime object) will be returned.
  89     '''
  90     pgstat_alias = aliased(PlayerGameStat, name='pgstat_alias')
  91
  92     recent_games_q = DBSession.query(Game.game_id, GameType.game_type_cd,
  93             Game.winner, Game.start_dt, GameType.descr.label('game_type_descr'),
  94             Server.server_id, Server.name.label('server_name'), Map.map_id,
  95             Map.name.label('map_name'), PlayerGameStat.player_id,
  96             PlayerGameStat.nick, PlayerGameStat.rank, PlayerGameStat.team,
  97             PlayerGameStat.elo_delta).\
  98             filter(Game.server_id==Server.server_id).\
  99             filter(Game.map_id==Map.map_id).\
 100             filter(Game.game_id==PlayerGameStat.game_id).\
 101             filter(Game.game_type_cd==GameType.game_type_cd).\
 102             order_by(expr.desc(Game.game_id))
 103
 104     # the various filters provided get tacked on to the query
 105     if server_id is not None:
 106         recent_games_q = recent_games_q.\
 107             filter(Server.server_id==server_id)
 108
 109     if map_id is not None:
 110         recent_games_q = recent_games_q.\
 111             filter(Map.map_id==map_id)
 112
 113     # Note: force_player_id makes the pgstat row returned be from the
 114     # specified player_id. Otherwise it will just look for a game
 115     # *having* that player_id, but returning the #1 player's pgstat row
 116     if player_id is not None:
 117         if force_player_id:
 118             recent_games_q = recent_games_q.\
 119                 filter(PlayerGameStat.player_id==player_id).\
 120                 filter(Game.players.contains([player_id]))
 121         else:
 122             recent_games_q = recent_games_q.\
 123                 filter(PlayerGameStat.scoreboardpos==1).\
 124                 filter(Game.game_id==pgstat_alias.game_id).\
 125                 filter(Game.players.contains([player_id])).\
 126                 filter(pgstat_alias.player_id==player_id)
 127     else:
 128         recent_games_q = recent_games_q.\
 129             filter(PlayerGameStat.scoreboardpos==1)
 130
 131     if game_type_cd is not None:
 132         recent_games_q = recent_games_q.\
 133             filter(Game.game_type_cd==game_type_cd.lower())
 134
 135     if cutoff is not None:
 136         right_now = datetime.utcnow()
 137         recent_games_q = recent_games_q.\
 138             filter(expr.between(Game.create_dt, cutoff, right_now))
 139
 140     return recent_games_q