Files
cheesy-arena-lite/partner/tba.go
2018-09-17 20:56:24 -07:00

506 lines
16 KiB
Go

// Copyright 2014 Team 254. All Rights Reserved.
// Author: pat@patfairbank.com (Patrick Fairbank)
//
// Methods for publishing data to and retrieving data from The Blue Alliance.
package partner
import (
"bytes"
"crypto/md5"
"encoding/json"
"fmt"
"github.com/Team254/cheesy-arena/game"
"github.com/Team254/cheesy-arena/model"
"io/ioutil"
"net/http"
"strconv"
)
const (
tbaBaseUrl = "https://www.thebluealliance.com"
tbaAuthKey = "MAApv9MCuKY9MSFkXLuzTSYBCdosboxDq8Q3ujUE2Mn8PD3Nmv64uczu5Lvy0NQ3"
)
type TbaClient struct {
BaseUrl string
eventCode string
secretId string
secret string
eventNamesCache map[string]string
}
type TbaMatch struct {
CompLevel string `json:"comp_level"`
SetNumber int `json:"set_number"`
MatchNumber int `json:"match_number"`
Alliances map[string]*TbaAlliance `json:"alliances"`
ScoreBreakdown map[string]*TbaScoreBreakdown `json:"score_breakdown"`
TimeString string `json:"time_string"`
TimeUtc string `json:"time_utc"`
}
type TbaAlliance struct {
Teams []string `json:"teams"`
Surrogates []string `json:"surrogates"`
Dqs []string `json:"dqs"`
Score *int `json:"score"`
}
type TbaScoreBreakdown struct {
AutoRunPoints int `json:"autoRunPoints"`
AutoScaleOwnershipSec int `json:"autoScaleOwnershipSec"`
AutoSwitchOwnershipSec int `json:"autoSwitchOwnershipSec"`
AutoOwnershipPoints int `json:"autoOwnershipPoints"`
AutoPoints int `json:"autoPoints"`
TeleopScaleOwnershipSec int `json:"teleopScaleOwnershipSec"`
TeleopScaleBoostSec int `json:"teleopScaleBoostSec"`
TeleopSwitchOwnershipSec int `json:"teleopSwitchOwnershipSec"`
TeleopSwitchBoostSec int `json:"teleopSwitchBoostSec"`
TeleopOwnershipPoints int `json:"teleopOwnershipPoints"`
VaultForceTotal int `json:"vaultForceTotal"`
VaultForcePlayed int `json:"vaultForcePlayed"`
VaultLevitateTotal int `json:"vaultLevitateTotal"`
VaultLevitatePlayed int `json:"vaultLevitatePlayed"`
VaultBoostTotal int `json:"vaultBoostTotal"`
VaultBoostPlayed int `json:"vaultBoostPlayed"`
VaultPoints int `json:"vaultPoints"`
EndgamePoints int `json:"endgamePoints"`
TeleopPoints int `json:"teleopPoints"`
AutoQuestRankingPoint bool `json:"autoQuestRankingPoint"`
FaceTheBossRankingPoint bool `json:"faceTheBossRankingPoint"`
FoulPoints int `json:"foulPoints"`
TotalPoints int `json:"totalPoints"`
RP int `json:"rp"`
TbaGameData string `json:"tba_gameData"`
}
type TbaRanking struct {
TeamKey string `json:"team_key"`
Rank int `json:"rank"`
RP float32
ParkClimb int
Auto int
Ownership int
Vault int
WinLossTie string
Dqs int `json:"dqs"`
Played int `json:"played"`
}
type TbaRankings struct {
Breakdowns []string `json:"breakdowns"`
Rankings []TbaRanking `json:"rankings"`
}
type TbaTeam struct {
TeamNumber int `json:"team_number"`
Name string `json:"name"`
Nickname string `json:"nickname"`
City string `json:"city"`
StateProv string `json:"state_prov"`
Country string `json:"country"`
RookieYear int `json:"rookie_year"`
}
type TbaRobot struct {
RobotName string `json:"robot_name"`
Year int `json:"year"`
}
type TbaAward struct {
Name string `json:"name"`
EventKey string `json:"event_key"`
Year int `json:"year"`
EventName string
}
type TbaEvent struct {
Name string `json:"name"`
}
func NewTbaClient(eventCode, secretId, secret string) *TbaClient {
return &TbaClient{BaseUrl: tbaBaseUrl, eventCode: eventCode, secretId: secretId, secret: secret,
eventNamesCache: make(map[string]string)}
}
func (client *TbaClient) GetTeam(teamNumber int) (*TbaTeam, error) {
path := fmt.Sprintf("/api/v3/team/%s", getTbaTeam(teamNumber))
resp, err := client.getRequest(path)
if err != nil {
return nil, err
}
// Get the response and handle errors
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var teamData TbaTeam
err = json.Unmarshal(body, &teamData)
return &teamData, err
}
func (client *TbaClient) GetRobotName(teamNumber int, year int) (string, error) {
path := fmt.Sprintf("/api/v3/team/%s/robots", getTbaTeam(teamNumber))
resp, err := client.getRequest(path)
if err != nil {
return "", err
}
// Get the response and handle errors
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return "", err
}
var robots []*TbaRobot
err = json.Unmarshal(body, &robots)
if err != nil {
return "", err
}
for _, robot := range robots {
if robot.Year == year {
return robot.RobotName, nil
}
}
return "", nil
}
func (client *TbaClient) GetTeamAwards(teamNumber int) ([]*TbaAward, error) {
path := fmt.Sprintf("/api/v3/team/%s/awards", getTbaTeam(teamNumber))
resp, err := client.getRequest(path)
if err != nil {
return nil, err
}
// Get the response and handle errors
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var awards []*TbaAward
err = json.Unmarshal(body, &awards)
if err != nil {
return nil, err
}
for _, award := range awards {
if _, ok := client.eventNamesCache[award.EventKey]; !ok {
client.eventNamesCache[award.EventKey], err = client.getEventName(award.EventKey)
if err != nil {
return nil, err
}
}
award.EventName = client.eventNamesCache[award.EventKey]
}
return awards, nil
}
// Uploads the event team list to The Blue Alliance.
func (client *TbaClient) PublishTeams(database *model.Database) error {
teams, err := database.GetAllTeams()
if err != nil {
return err
}
// Build a JSON array of TBA-format team keys (e.g. "frc254").
teamKeys := make([]string, len(teams))
for i, team := range teams {
teamKeys[i] = getTbaTeam(team.Id)
}
jsonBody, err := json.Marshal(teamKeys)
if err != nil {
return err
}
resp, err := client.postRequest("team_list", "update", jsonBody)
if err != nil {
return err
}
if resp.StatusCode != 200 {
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
return fmt.Errorf("Got status code %d from TBA: %s", resp.StatusCode, body)
}
return nil
}
// Uploads the qualification and elimination match schedule and results to The Blue Alliance.
func (client *TbaClient) PublishMatches(database *model.Database) error {
qualMatches, err := database.GetMatchesByType("qualification")
if err != nil {
return err
}
elimMatches, err := database.GetMatchesByType("elimination")
if err != nil {
return err
}
matches := append(qualMatches, elimMatches...)
tbaMatches := make([]TbaMatch, len(matches))
// Build a JSON array of TBA-format matches.
for i, match := range matches {
matchNumber, _ := strconv.Atoi(match.DisplayName)
// Fill in scores if the match has been played.
var scoreBreakdown map[string]*TbaScoreBreakdown
var redScore, blueScore *int
var redCards, blueCards map[string]string
if match.Status == "complete" {
matchResult, err := database.GetMatchResultForMatch(match.Id)
if err != nil {
return err
}
if matchResult != nil {
scoreBreakdown = make(map[string]*TbaScoreBreakdown)
scoreBreakdown["red"] = createTbaScoringBreakdown(&match, matchResult, "red")
scoreBreakdown["blue"] = createTbaScoringBreakdown(&match, matchResult, "blue")
redScore = &scoreBreakdown["red"].TotalPoints
blueScore = &scoreBreakdown["blue"].TotalPoints
redCards = matchResult.RedCards
blueCards = matchResult.BlueCards
}
}
alliances := make(map[string]*TbaAlliance)
alliances["red"] = createTbaAlliance([3]int{match.Red1, match.Red2, match.Red3}, [3]bool{match.Red1IsSurrogate,
match.Red2IsSurrogate, match.Red3IsSurrogate}, redScore, redCards)
alliances["blue"] = createTbaAlliance([3]int{match.Blue1, match.Blue2, match.Blue3},
[3]bool{match.Blue1IsSurrogate, match.Blue2IsSurrogate, match.Blue3IsSurrogate}, blueScore, blueCards)
tbaMatches[i] = TbaMatch{"qm", 0, matchNumber, alliances, scoreBreakdown, match.Time.Local().Format("3:04 PM"),
match.Time.UTC().Format("2006-01-02T15:04:05")}
if match.Type == "elimination" {
tbaMatches[i].CompLevel = map[int]string{1: "f", 2: "sf", 4: "qf", 8: "ef"}[match.ElimRound]
tbaMatches[i].SetNumber = match.ElimGroup
tbaMatches[i].MatchNumber = match.ElimInstance
}
}
jsonBody, err := json.Marshal(tbaMatches)
if err != nil {
return err
}
resp, err := client.postRequest("matches", "update", jsonBody)
if err != nil {
return err
}
if resp.StatusCode != 200 {
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
return fmt.Errorf("Got status code %d from TBA: %s", resp.StatusCode, body)
}
return nil
}
// Uploads the team standings to The Blue Alliance.
func (client *TbaClient) PublishRankings(database *model.Database) error {
rankings, err := database.GetAllRankings()
if err != nil {
return err
}
// Build a JSON object of TBA-format rankings.
breakdowns := []string{"RP", "ParkClimb", "Auto", "Ownership", "Vault", "WinLossTie"}
tbaRankings := make([]TbaRanking, len(rankings))
for i, ranking := range rankings {
tbaRankings[i] = TbaRanking{getTbaTeam(ranking.TeamId), ranking.Rank,
float32(ranking.RankingPoints) / float32(ranking.Played), ranking.ParkClimbPoints, ranking.AutoPoints,
ranking.OwnershipPoints, ranking.VaultPoints,
fmt.Sprintf("%d-%d-%d", ranking.Wins, ranking.Losses, ranking.Ties), ranking.Disqualifications,
ranking.Played}
}
jsonBody, err := json.Marshal(TbaRankings{breakdowns, tbaRankings})
if err != nil {
return err
}
resp, err := client.postRequest("rankings", "update", jsonBody)
if err != nil {
return err
}
if resp.StatusCode != 200 {
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
return fmt.Errorf("Got status code %d from TBA: %s", resp.StatusCode, body)
}
return nil
}
// Uploads the alliances selection results to The Blue Alliance.
func (client *TbaClient) PublishAlliances(database *model.Database) error {
alliances, err := database.GetAllAlliances()
if err != nil {
return err
}
// Build a JSON object of TBA-format alliances.
tbaAlliances := make([][]string, len(alliances))
for i, alliance := range alliances {
for _, team := range alliance {
tbaAlliances[i] = append(tbaAlliances[i], getTbaTeam(team.TeamId))
}
}
jsonBody, err := json.Marshal(tbaAlliances)
if err != nil {
return err
}
resp, err := client.postRequest("alliance_selections", "update", jsonBody)
if err != nil {
return err
}
if resp.StatusCode != 200 {
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
return fmt.Errorf("Got status code %d from TBA: %s", resp.StatusCode, body)
}
return nil
}
// Clears out the existing match data on The Blue Alliance for the event.
func (client *TbaClient) DeletePublishedMatches() error {
resp, err := client.postRequest("matches", "delete_all", []byte(client.eventCode))
if err != nil {
return err
}
if resp.StatusCode != 200 {
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
return fmt.Errorf("Got status code %d from TBA: %s", resp.StatusCode, body)
}
return nil
}
func (client *TbaClient) getEventName(eventCode string) (string, error) {
path := fmt.Sprintf("/api/v3/event/%s", eventCode)
resp, err := client.getRequest(path)
if err != nil {
return "", err
}
// Get the response and handle errors
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return "", err
}
var event TbaEvent
err = json.Unmarshal(body, &event)
if err != nil {
return "", err
}
return event.Name, err
}
// Converts an integer team number into the "frcXXXX" format TBA expects.
func getTbaTeam(team int) string {
return fmt.Sprintf("frc%d", team)
}
// Sends a GET request to the TBA API.
func (client *TbaClient) getRequest(path string) (*http.Response, error) {
url := client.BaseUrl + path
// Make an HTTP GET request with the TBA auth headers.
httpClient := &http.Client{}
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return nil, err
}
req.Header.Set("X-TBA-Auth-Key", tbaAuthKey)
return httpClient.Do(req)
}
// Signs the request and sends it to the TBA API.
func (client *TbaClient) postRequest(resource string, action string, body []byte) (*http.Response, error) {
path := fmt.Sprintf("/api/trusted/v1/event/%s/%s/%s", client.eventCode, resource, action)
signature := fmt.Sprintf("%x", md5.Sum(append([]byte(client.secret+path), body...)))
httpClient := &http.Client{}
request, err := http.NewRequest("POST", client.BaseUrl+path, bytes.NewReader(body))
if err != nil {
return nil, err
}
request.Header.Add("X-TBA-Auth-Id", client.secretId)
request.Header.Add("X-TBA-Auth-Sig", signature)
return httpClient.Do(request)
}
func createTbaAlliance(teamIds [3]int, surrogates [3]bool, score *int, cards map[string]string) *TbaAlliance {
alliance := TbaAlliance{Surrogates: []string{}, Dqs: []string{}, Score: score}
for i, teamId := range teamIds {
teamKey := getTbaTeam(teamId)
alliance.Teams = append(alliance.Teams, teamKey)
if surrogates[i] {
alliance.Surrogates = append(alliance.Surrogates, teamKey)
}
if cards != nil {
if card, ok := cards[strconv.Itoa(teamId)]; ok && card == "red" {
alliance.Dqs = append(alliance.Dqs, teamKey)
}
}
}
return &alliance
}
func createTbaScoringBreakdown(match *model.Match, matchResult *model.MatchResult, alliance string) *TbaScoreBreakdown {
var breakdown TbaScoreBreakdown
var score *game.Score
var scoreSummary, opponentScoreSummary *game.ScoreSummary
if alliance == "red" {
score = matchResult.RedScore
scoreSummary = matchResult.RedScoreSummary()
opponentScoreSummary = matchResult.BlueScoreSummary()
} else {
score = matchResult.BlueScore
scoreSummary = matchResult.BlueScoreSummary()
opponentScoreSummary = matchResult.RedScoreSummary()
}
breakdown.AutoRunPoints = 5 * score.AutoRuns
breakdown.AutoScaleOwnershipSec = int(score.AutoScaleOwnershipSec)
breakdown.AutoSwitchOwnershipSec = int(score.AutoSwitchOwnershipSec)
breakdown.AutoOwnershipPoints = scoreSummary.AutoOwnershipPoints
breakdown.AutoPoints = scoreSummary.AutoPoints
breakdown.TeleopScaleOwnershipSec = int(score.TeleopScaleOwnershipSec)
breakdown.TeleopScaleBoostSec = int(score.TeleopScaleBoostSec)
breakdown.TeleopSwitchOwnershipSec = int(score.TeleopSwitchOwnershipSec)
breakdown.TeleopSwitchBoostSec = int(score.TeleopSwitchBoostSec)
breakdown.TeleopOwnershipPoints = scoreSummary.TeleopOwnershipPoints
breakdown.VaultForceTotal = score.ForceCubes
breakdown.VaultForcePlayed = score.ForceCubesPlayed
breakdown.VaultLevitateTotal = score.LevitateCubes
if score.LevitatePlayed {
breakdown.VaultLevitatePlayed = score.LevitateCubes
}
breakdown.VaultBoostTotal = score.BoostCubes
breakdown.VaultBoostPlayed = score.BoostCubesPlayed
breakdown.VaultPoints = scoreSummary.VaultPoints
breakdown.EndgamePoints = scoreSummary.ParkClimbPoints
breakdown.TeleopPoints = scoreSummary.Score - scoreSummary.AutoPoints - scoreSummary.FoulPoints
breakdown.AutoQuestRankingPoint = scoreSummary.AutoQuest
breakdown.FaceTheBossRankingPoint = scoreSummary.FaceTheBoss
breakdown.FoulPoints = scoreSummary.FoulPoints
breakdown.TotalPoints = scoreSummary.Score
if match.Type == "qualification" {
// Calculate and set the ranking points for the match.
var ranking game.Ranking
ranking.AddScoreSummary(scoreSummary, opponentScoreSummary, false)
breakdown.RP = ranking.RankingPoints
}
breakdown.TbaGameData = match.GameSpecificData
return &breakdown
}