Merge remote-tracking branch 'origin/master' into v3

Author: markus-wa

.github/workflows/ci.yml

@@ -37,14 +37,14 @@ jobs:
         sudo apt-get install -y p7zip-full
 
         # Install interface generator
-        GO111MODULE=off go get github.com/vburenin/ifacemaker
+        go install github.com/vburenin/ifacemaker@v1.1.0
 
         # Fetch refs for linter
         git config remote.origin.fetch +refs/heads/*:refs/remotes/origin/*
         git fetch
 
         # Install golangci-lint
-        curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sudo sh -s -- -b $(go env GOPATH)/bin v1.32.2
+        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.45.2
 
     - name: Build
       run: scripts/build.sh

.github/workflows/codeql-analysis.yml

@@ -2,10 +2,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [master, v0.5, v1]
+    branches: [master, v3]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [master]
+    branches: [master, v3]
   schedule:
     - cron: '0 1 * * 4'
 
@@ -22,33 +22,11 @@ jobs:
         # a pull request then we can checkout the head.
         fetch-depth: 2
 
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
-
-    # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
-      # Override language selection by uncommenting this and choosing your languages
-      # with:
-      #   languages: go, javascript, csharp, python, cpp, java
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
       uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v1

README.md

@@ -1,6 +1,6 @@
 # demoinfocs-golang - CS:GO Demo Parser
 
-A blazing fast, feature complete and production ready Go library for parsing and analysing of Counter Strike: Global Offensive (CS:GO) demos (aka replays). It is based on <a href="https://github.com/ValveSoftware/csgo-demoinfo" rel="external">Valve's demoinfogo</a> and <a href="https://github.com/StatsHelix/demoinfo" rel="external">SatsHelix's demoinfo</a> but provides many improvements.
+A blazing fast, feature complete and production ready Go library for parsing and analysing of Counter Strike: Global Offensive (CS:GO) demos (aka replays). 
 
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
 
@@ -85,6 +85,7 @@ package main
 
 import (
 	"fmt"
+	"log"
 	"os"
 
 	dem "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs"
@@ -94,7 +95,7 @@ import (
 func main() {
 	f, err := os.Open("/path/to/demo.dem")
 	if err != nil {
-		panic(err)
+		log.Panic("failed to open demo file: ", err)
 	}
 	defer f.Close()
 
@@ -117,7 +118,7 @@ func main() {
 	// Parse to end
 	err = p.ParseToEnd()
 	if err != nil {
-		panic(err)
+		log.Panic("failed to parse demo: ", err)
 	}
 }
 ```
@@ -219,7 +220,7 @@ There is one caveat however: Beta features - which are marked as such via commen
 - [megaclan3000](https://github.com/megaclan3000/megaclan3000) - A CS:GO stats page for clans with recent matches and player statistics
 - [csgo Python library](https://github.com/pnxenopoulos/csgo) - A wrapper for the Golang parser in Python
 
-If your project is using this library feel free to submit a PR or send a message in [Gitter](https://gitter.im/csgodemos/demoinfo-lib) to be included in the list.
+If your project is using this library feel free to submit a PR or send a message via [Discord](https://discord.gg/eTVBgKeHnh) to be included in the list.
 
 ## Development
 
@@ -304,6 +305,8 @@ To install some (optional, but quite handy) `pre-commit` and `pre-push` hooks, y
 
 ## Acknowledgements
 
+This library was originally based on <a href="https://github.com/ValveSoftware/csgo-demoinfo" rel="external">Valve's demoinfogo</a> and <a href="https://github.com/StatsHelix/demoinfo" rel="external">SatsHelix's demoinfo</a> (although today it shares little resemblence with these two).
+
 Thanks to [@JetBrains](https://github.com/JetBrains) for sponsoring a license of their awesome [GoLand](https://www.jetbrains.com/go/) IDE for this project - go check it out!
 
 And a very special thanks goes out to all the [⭐contributors⭐](https://github.com/markus-wa/demoinfocs-golang/graphs/contributors)️, be it in the form of PRs, issues or anything else.

examples/README.md

@@ -2,12 +2,15 @@
 
 Here you can find a overview of examples on how to use demoinfocs-golang.
 
+:information_source: Example code may not be production ready - specifically error handling and such is done in a simplified way and should not be used in critical systems as-is.
+
 |Example|Description
 |-|-|
 |[heatmap](heatmap)|Creating a heatmap from positions where players fired shots from|
 |[nade-trajectories](nade-trajectories)|Map overview with grenade trajectories|
 |[entities](entities)|Using unhandled data from entities (`Parser.ServerClasses()`)|
 |[net-messages](net-messages)|Parsing and handling custom net-messages|
+|[encrypted-net-messages](encrypted-net-messages)|Parsing and handling encrypted net-messages (e.g. text chat in MM demos)|
 |[print-events](print-events)|Printing kills, scores & chat messages|
 |[mocking](mocking)|Using the `fake` package to write unit tests for your code|
 |[web-assembly](web-assembly)|Using the library from JavaScript (browser/node) with [WebAssembly](https://webassembly.org/)|

examples/common.go

@@ -1,10 +1,17 @@
 package examples
 
 import (
+	"encoding/json"
 	"flag"
+	"fmt"
+	"image"
 	"io"
 	"io/ioutil"
+	"net/http"
 	"os"
+
+	"github.com/golang/geo/r2"
+	"github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/metadata"
 )
 
 // DemoPathFromArgs returns the value of the -demo command line flag.
@@ -24,15 +31,20 @@ func DemoPathFromArgs() string {
 	return demPath
 }
 
+func checkError(err error) {
+	if err != nil {
+		panic(err)
+	}
+}
+
 // RedirectStdout redirects standard output to dev null.
 // Panics if an error occurs.
 func RedirectStdout(f func()) {
 	// Redirect stdout, the resulting image is written to this
 	old := os.Stdout
+
 	r, w, err := os.Pipe()
-	if err != nil {
-		panic(err)
-	}
+	checkError(err)
 
 	os.Stdout = w
 
@@ -46,3 +58,57 @@ func RedirectStdout(f func()) {
 
 	os.Stdout = old
 }
+
+type mapMetadata struct {
+	PosX  float64 `json:"pos_x,string"`
+	PosY  float64 `json:"pos_y,string"`
+	Scale float64 `json:"scale,string"`
+}
+
+// GetMapMetadata fetches metadata for a specific map version from
+// `https://radar-overviews.csgo.saiko.tech/<map>/<crc>/info.json`.
+// Panics if any error occurs.
+func GetMapMetadata(name string, crc uint32) metadata.Map {
+	url := fmt.Sprintf("https://radar-overviews.csgo.saiko.tech/%s/%d/info.json", name, crc)
+
+	resp, err := http.Get(url)
+	checkError(err)
+
+	defer resp.Body.Close()
+
+	var data map[string]mapMetadata
+
+	err = json.NewDecoder(resp.Body).Decode(&data)
+	checkError(err)
+
+	mapInfo, ok := data[name]
+	if !ok {
+		panic(fmt.Sprintf("failed to get map info.json entry for %q", name))
+	}
+
+	return metadata.Map{
+		Name: name,
+		PZero: r2.Point{
+			X: mapInfo.PosX,
+			Y: mapInfo.PosY,
+		},
+		Scale: mapInfo.Scale,
+	}
+}
+
+// GetMapMetadata fetches metadata for a specific map version from
+// `https://radar-overviews.csgo.saiko.tech/<map>/<crc>/info.json`.
+// Panics if any error occurs.
+func GetMapRadar(name string, crc uint32) image.Image {
+	url := fmt.Sprintf("https://radar-overviews.csgo.saiko.tech/%s/%d/radar.png", name, crc)
+
+	resp, err := http.Get(url)
+	checkError(err)
+
+	defer resp.Body.Close()
+
+	img, _, err := image.Decode(resp.Body)
+	checkError(err)
+
+	return img
+}

examples/encrypted-net-messages/README.md

@@ -0,0 +1,14 @@
+# Parsing & handling encrypted net-messages
+
+See also [net-messages](../net-messages) for regular net-messages.
+
+This example shows how to have the parser deal with encrypted net-messages.
+
+For Valve MM games, the decryption key can be obtained from `.dem.info` files using `MatchInfoDecryptionKey()`.
+The key then needs to be passed to `ParserConfig.NetMessageDecryptionKey`.
+
+## Run
+
+    go run enc_net_nsg.go -demo path/to/demo.dem -info path/to/demo.dem.info
+
+This prints chat messages from the passed demo (assuming the `.dem.info` file contains the correct decryption key).

examples/encrypted-net-messages/enc_net_msg.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"flag"
+	"io/ioutil"
+	"log"
+	"os"
+
+	dem "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs"
+	"github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
+)
+
+func checkErr(err error) {
+	if err != nil {
+		panic(err)
+	}
+}
+
+func main() {
+	fl := new(flag.FlagSet)
+
+	demPathPtr := fl.String("demo", "", "Demo file `path`")
+	infoPathPtr := fl.String("info", "", "Info file `path`")
+
+	err := fl.Parse(os.Args[1:])
+	checkErr(err)
+
+	demPath := *demPathPtr
+	infoPath := *infoPathPtr
+
+	infoF, err := os.Open(infoPath)
+	checkErr(err)
+
+	b, err := ioutil.ReadAll(infoF)
+	checkErr(err)
+
+	k, err := dem.MatchInfoDecryptionKey(b)
+	checkErr(err)
+
+	f, err := os.Open(demPath)
+	checkErr(err)
+
+	defer f.Close()
+
+	cfg := dem.DefaultParserConfig
+	cfg.NetMessageDecryptionKey = k
+
+	p := dem.NewParserWithConfig(f, cfg)
+
+	p.RegisterEventHandler(func(warn events.ParserWarn) {
+		log.Println("WARNING:", warn.Message)
+	})
+
+	p.RegisterEventHandler(func(message events.ChatMessage) {
+		log.Println(message)
+	})
+
+	err = p.ParseToEnd()
+	checkErr(err)
+}

examples/encrypted-net-messages/enc_net_msg_test.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"os"
+	"testing"
+)
+
+// Just make sure the example runs
+func TestEncryptedNetMessages(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping test")
+	}
+
+	os.Args = []string{"cmd", "-demo", "../../test/cs-demos/match730_003528806449641685104_1453182610_271.dem", "-info", "../../test/cs-demos/match730_003528806449641685104_1453182610_271.dem.info"}
+
+	main()
+}
+
+// Make sure it doesn't error / crash
+func TestEncryptedNetMessages_BadKey(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping test")
+	}
+
+	os.Args = []string{"cmd", "-demo", "../../test/cs-demos/match730_003528806449641685104_1453182610_271.dem", "-info", "../../test/cs-demos/match730_003449478367177343081_1946274414_112.dem.info"}
+
+	main()
+}

examples/heatmap/README.md

@@ -2,6 +2,8 @@
 
 This example shows how to create a heatmap from positions where players fired their weapons from.
 
+:information_source: Uses radar images from `https://radar-overviews.csgo.saiko.tech/<map>/<crc>/radar.png` - see https://github.com/saiko-tech/csgo-centrifuge for more info.
+
 See `heatmap.go` for the source code.
 
 ## Running the example