Merge pull request #88 from Kaszanas/dev

[PR] Preparing 2.1.0

Author: Kaszanas

.github/PULL_REQUEST_TEMPLATE.MD

@@ -2,7 +2,7 @@
 ## Description
 <!--- Describe your changes in detail -->
 
-## Related IssueS
+## Related Issues
 <!--- This project only accepts pull requests related to open issues -->
 <!--- If suggesting a new feature or change, please discuss it in an issue first -->
 <!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->

.github/workflows/docker_images.yml

@@ -2,6 +2,10 @@ name: Publish Docker Image
 
 on:
   workflow_dispatch:
+  push:
+    branches:
+      - main
+      - dev
   release:
     types: [published]
 
@@ -25,11 +29,12 @@ jobs:
         uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81
         with:
           images: |
-                kaszanas/sc2infoextractorgo
+            kaszanas/sc2infoextractorgo
       - name: Build and Push Docker images
         uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0
         with:
           context: .
+          file: ./docker/Dockerfile
           push: true
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -75,57 +75,58 @@ The following flags are available:
 
 ```
   -help
-    Show command usage
+        Show command usage
   -game_mode_filter int
-    Specifies which game mode should be included from the processed files
-    in a format of a binary flag: AllGameModes: 0b11111111 (default 0b11111111) (default 255)
+        Specifies which game mode should be included from the processed files
+        in a format of a binary flag: AllGameModes: 0b11111111 (default 0b11111111) (default 255)
   -input string
-    Input directory where .SC2Replay files are held. (default "./replays/input")
+        Input directory where .SC2Replay files are held. (default "./replays/input")
   -log_dir string
-    Specifies directory which will hold the logging information. (default "./logs/")
+        Specifies directory which will hold the logging information. (default "./logs/")
   -log_level int
-    Specifies a log level from 1-7:
-    Panic - 1, Fatal - 2,
-    Error - 3, Warn - 4,
-    Info - 5, Debug - 6,
-    Trace - 7 (default 4)
+        Specifies a log level from 1-7:
+        Panic - 1, Fatal - 2,
+        Error - 3, Warn - 4,
+        Info - 5, Debug - 6,
+        Trace - 7 (default 4)
   -maps_directory string
-        Directory where the maps will be downloaded as a result of the
-        replay processing. (default "./maps/")
+        Directory where the maps will be downloaded as a result of the replay processing. (default "./maps/")
   -max_procs int
-    Specifies the number of logic cores of a processor that will be used for processing (default runtime.NumCPU()). (default 24)
+        Specifies the number of logic cores of a processor that will be used for processing (default runtime.NumCPU()). (default 24)
   -number_of_packages int
-    Provide a number of zip packages to be created and compressed
-    into a zip archive. Please remember that this number needs to be lower
-    than the number of processed files. If set to 0, will ommit the
-    zip packaging and output .json directly to drive. (default 1)
+        Provide a number of zip packages to be created and compressed
+        into a zip archive. Please remember that this number needs to be lower
+        than the number of processed files. If set to 0, will ommit the
+        zip packaging and output .json directly to drive. (default 1)
   -only_map_download
-    Flag specifying if the tool is supposed to only download
-    the maps and not process the replays.
+        Flag specifying if the tool is supposed to only download
+        the maps and not process the replays.
   -output string
-    Output directory where compressed zip packages will be saved. (default "./replays/output")
+        Output directory where compressed zip packages will be saved. (default "./replays/output")
   -perform_chat_anonymization
-    Flag, specifying if the chat anonymization should be performed.
+        Flag, specifying if the chat anonymization should be performed.
   -perform_cleanup
-    Flag specifying if the tool is supposed to perform the cleaning
-    functions within the processing pipeline.
+        Flag specifying if the tool is supposed to perform the cleaning
+                        functions within the processing pipeline.
   -perform_filtering
-    Flag, specifying if the pipeline ought to verify different hard coded game modes.
-    If set to false completely bypasses the filtering.
+        Flag, specifying if the pipeline ought to verify different hard coded game modes.
+        If set to false completely bypasses the filtering.
   -perform_integrity_checks
-    Flag specifying if the software is supposed to check the hardcoded
-    integrity checks for the provided replays
+        Flag specifying if the software is supposed to check the hardcoded
+        integrity checks for the provided replays
   -perform_player_anonymization
-    Flag specifying if the tool is supposed to perform player anonymization
-    functions within the processing pipeline.
-    If set to true please remember to download and run
-    an anonymization server: https://doi.org/10.5281/zenodo.5138313
+        Flag specifying if the tool is supposed to perform player anonymization
+        functions within the processing pipeline.
+        If set to true please remember to download and run
+        an anonymization server: https://doi.org/10.5281/zenodo.5138313
   -perform_validity_checks
-    Flag, specifying if the tool is supposed to use hardcoded validity checks
-    and verify if the replay file variables are within 'common sense' ranges.
+        Flag, specifying if the tool is supposed to use hardcoded validity checks
+        and verify if the replay file variables are within 'common sense' ranges.
+  -skip_map_download
+        Flag specifying if the tool is supposed to skip the map download
   -with_cpu_profiler string
-    Set path to the file where pprof cpu profiler will save its information.
-    If this is empty no profiling is performed.
+        Set path to the file where pprof cpu profiler will save its information.
+        If this is empty no profiling is performed.
 ```
 
 

dataproc/anonymize.go

@@ -41,7 +41,7 @@ func anonymizeReplay(
 	grpcAnonymizer *GRPCAnonymizer,
 	performChatAnonymizationBool bool) bool {
 
-	log.Info("Entered anonymizeReplay()")
+	log.Debug("Entered anonymizeReplay()")
 
 	// Anonymization of Chat events that might
 	// contain sensitive information for research purposes:
@@ -59,7 +59,7 @@ func anonymizeReplay(
 		return false
 	}
 
-	log.Info("Finished anonymizeReplay()")
+	log.Debug("Finished anonymizeReplay()")
 	return true
 }
 
@@ -82,7 +82,7 @@ type GRPCAnonymizer struct {
 // grpcConnect initializes a connection to a specified in settings grpc server.
 func (anonymizer *GRPCAnonymizer) grpcDialConnect() bool {
 
-	log.Info("Entered GRPCAnonymizer.grpcDialConnect()")
+	log.Debug("Entered GRPCAnonymizer.grpcDialConnect()")
 
 	// Set up a connection to the server:
 	conn, err := grpc.NewClient(settings.GrpcServerAddress,
@@ -97,7 +97,7 @@ func (anonymizer *GRPCAnonymizer) grpcDialConnect() bool {
 
 	anonymizer.Connection = conn
 
-	log.Info("Finished GRPCAnonymizer.grpcDialConnect()")
+	log.Debug("Finished GRPCAnonymizer.grpcDialConnect()")
 	return true
 
 }
@@ -112,7 +112,7 @@ func (anonymizer *GRPCAnonymizer) grpcInitializeClient() {
 // in the cache and if it is not it calls grpcAnonymizeID.
 func (anonymizer *GRPCAnonymizer) anonymizeToon(toonString string) (string, bool) {
 
-	log.Info("Entered GRPCAnonymizer.anonymizeToon()")
+	log.Debug("Entered GRPCAnonymizer.anonymizeToon()")
 
 	// Check if the toon is already in cache not to spam the connection with requests:
 	val, ok := anonymizer.Cache[toonString]
@@ -130,7 +130,7 @@ func (anonymizer *GRPCAnonymizer) anonymizeToon(toonString string) (string, bool
 		return "", false
 	}
 	anonymizer.Cache[toonString] = anonymizedID
-	log.Info("Finished GRPCAnonymizer.anonymizeToon()")
+	log.Debug("Finished GRPCAnonymizer.anonymizeToon()")
 
 	return anonymizedID, true
 }
@@ -143,7 +143,7 @@ func grpcGetAnonymizeID(
 	grpcConnection *grpc.ClientConn,
 ) (string, bool) {
 
-	log.Info("Entered grpcAnonymize()")
+	log.Debug("Entered grpcAnonymize()")
 
 	// Contact the server and print out its response:
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
@@ -159,7 +159,7 @@ func grpcGetAnonymizeID(
 	log.WithField("gRPC_response", result.AnonymizedID).
 		Debug("Received anonymized ID for a player.")
 
-	log.Info("Finished grpcAnonymize()")
+	log.Debug("Finished grpcAnonymize()")
 	return result.AnonymizedID, true
 }
 
@@ -198,15 +198,15 @@ func anonymizePlayers(
 	log.WithField("toonDescMapAnonymized", replayData.ToonPlayerDescMap).
 		Debug("Replaced toonDescMap with anonymized version")
 
-	log.Info("Finished anonymizePlayers()")
+	log.Debug("Finished anonymizePlayers()")
 	return true
 }
 
 // anonymizeMessageEvents checks against settings.UnusedMessageEvents
 // and creates a new clean version without specified events.
 func anonimizeMessageEvents(replayData *replay_data.CleanedReplay) bool {
 
-	log.Info("Entered anonimizeMessageEvents().")
+	log.Debug("Entered anonimizeMessageEvents().")
 	var anonymizedMessageEvents []s2prot.Struct
 	for _, event := range replayData.MessageEvents {
 		eventType := event["evtTypeName"].(string)
@@ -217,6 +217,6 @@ func anonimizeMessageEvents(replayData *replay_data.CleanedReplay) bool {
 
 	replayData.MessageEvents = anonymizedMessageEvents
 
-	log.Info("Finished anonymizeMessageEvents()")
+	log.Debug("Finished anonymizeMessageEvents()")
 	return true
 }

dataproc/checks_filtering.go

@@ -9,7 +9,7 @@ import (
 // filterGameModes performs the check against a binary 0b1111111 getGameModeFlag
 // to verify if the currently processed replay game mode is correct.
 func filterGameModes(replayData *rep.Rep, getGameModeFlag int) bool {
-	log.Info("Entered filterGameModes()")
+	log.Debug("Entered filterGameModes()")
 
 	for _, value := range gameModeList {
 		// If we want to include games with game mode `value`,
@@ -21,7 +21,7 @@ func filterGameModes(replayData *rep.Rep, getGameModeFlag int) bool {
 		}
 	}
 
-	log.Info("Finished filterGameModes()")
+	log.Debug("Finished filterGameModes()")
 
 	// The game did not match any active filters, return false.
 	return false
@@ -34,7 +34,7 @@ func checkGameParameters(
 	replayData *rep.Rep,
 	gameInfoFilter VerifyGameInfo) bool {
 
-	log.Info("Entered checkGameParameters()")
+	log.Debug("Entered checkGameParameters()")
 
 	// Verifying if the number of players matches:
 	if !checkNumberOfPlayers(replayData, gameInfoFilter.maxPlayers) {
@@ -72,7 +72,7 @@ func checkGameParameters(
 		return false
 	}
 
-	log.Info("Finished checkGameParameters()")
+	log.Debug("Finished checkGameParameters()")
 	return true
 
 }
@@ -91,3 +91,12 @@ func checkNumberOfPlayers(replayData *rep.Rep, requiredNumber int) bool {
 	return numberOfPlayers == requiredNumber
 
 }
+
+// gameis1v1Ranked checks if the replay is a 1v1 ranked game.
+func gameIs1v1Ranked(replayData *rep.Rep) bool {
+
+	isAmm := replayData.InitData.GameDescription.GameOptions.Amm()
+	isCompetitive := replayData.InitData.GameDescription.GameOptions.CompetitiveOrRanked()
+	isTwoPlayers := len(replayData.Metadata.Players()) == 2
+	return isAmm && isCompetitive && isTwoPlayers
+}

dataproc/checks_integrity.go

@@ -10,7 +10,7 @@ import (
 // matches against structures with redundant information.
 func checkIntegrity(replayData *rep.Rep) (bool, string) {
 
-	log.Info("Entered checkIntegrity()")
+	log.Debug("Entered checkIntegrity()")
 	maxPlayers := replayData.InitData.GameDescription.MaxPlayers()
 	replayDetails := replayData.Details
 

dataproc/checks_validity.go

@@ -59,7 +59,7 @@ type VerifyGameInfo struct {
 // in order to verify if the file is within "common sense" values.
 func validate1v1Replay(replayData *rep.Rep) bool {
 
-	log.Info("Entered validateData()")
+	log.Debug("Entered validateData()")
 	playerList := replayData.Metadata.Players()
 
 	if len(playerList) == 2 {
@@ -94,15 +94,15 @@ func validate1v1Replay(replayData *rep.Rep) bool {
 		return false
 	}
 
-	log.Info("Finished validateData(), returning")
+	log.Debug("Finished validateData(), returning")
 	return true
 }
 
 // checkBlizzardMap verifies if the currently processed
 // replay was played using a Blizzard official map.
 func checkBlizzardMap(replayData *rep.Rep) bool {
 
-	log.Info("Entered checkBlizzardMap()")
+	log.Debug("Entered checkBlizzardMap()")
 
 	gameDescIsBlizzardMap := replayData.InitData.GameDescription.IsBlizzardMap()
 	detailsIsBlizzardMap := replayData.Details.IsBlizzardMap()
@@ -114,6 +114,6 @@ func checkBlizzardMap(replayData *rep.Rep) bool {
 		return false
 	}
 
-	log.Info("Finished checkBlizzardMap(), returning")
+	log.Debug("Finished checkBlizzardMap(), returning")
 	return true
 }