Feature: opt-in survey when exiting a game

On first start-up, the game will ask if you want to participate
in our automated survey. You have to opt-in, and can easily opt-out
(via the Options) at any time.

When opt-in, whenever you exit a game, a JSON blob will be send
to the survey server hosted by OpenTTD. This JSON blob contains
information that gives a global picture of the game just played:
- What settings were used
- How many humans vs AIs
- How long the game has been played
- Basic information about the OS / CPU

All this information is kept very generic, so there is no
chance we send private information to our survey server.
Nothing in the JSON blob could identify you as a person; it
mostly tells about the game played. At any time you can see
what the JSON blob includes, by pressing the "Preview Survey
Results" button in-game.

.github/workflows/codeql.yml

@@ -37,10 +37,12 @@ jobs:
           liballegro4-dev \
           libcurl4-openssl-dev \
           libfontconfig-dev \
+          libharfbuzz-dev \
           libicu-dev \
           liblzma-dev \
           liblzo2-dev \
           libsdl2-dev \
+          nlohmann-json3-dev \
           zlib1g-dev \
           # EOF
         echo "::endgroup::"

.github/workflows/release-linux.yml

@@ -2,6 +2,11 @@ name: Release (Linux)
 
 on:
   workflow_call:
+    inputs:
+      survey_key:
+        required: false
+        type: string
+        default: ""
 
 jobs:
   linux:
@@ -119,6 +124,7 @@ jobs:
         cmake ${GITHUB_WORKSPACE} \
           -DCMAKE_TOOLCHAIN_FILE=/vcpkg/scripts/buildsystems/vcpkg.cmake \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
           -DOPTION_PACKAGE_DEPENDENCIES=ON \
           # EOF
         echo "::endgroup::"

.github/workflows/release-macos.yml

@@ -2,6 +2,11 @@ name: Release (MacOS)
 
 on:
   workflow_call:
+    inputs:
+      survey_key:
+        required: false
+        type: string
+        default: ""
 
 jobs:
   macos:
@@ -104,6 +109,7 @@ jobs:
           -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
           # EOF
         echo "::endgroup::"
 
@@ -124,6 +130,7 @@ jobs:
           -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
           -DCPACK_BUNDLE_APPLE_CERT_APP=${{ secrets.APPLE_DEVELOPER_CERTIFICATE_ID }} \
           "-DCPACK_BUNDLE_APPLE_CODESIGN_PARAMETER=--deep -f --options runtime" \
           -DAPPLE_UNIVERSAL_PACKAGE=1 \

.github/workflows/release-source.yml

@@ -11,6 +11,8 @@ on:
         value: ${{ jobs.source.outputs.trigger_type }}
       folder:
         value: ${{ jobs.source.outputs.folder }}
+      survey_key:
+        value: ${{ jobs.source.outputs.survey_key }}
 
 jobs:
   source:
@@ -23,6 +25,7 @@ jobs:
       is_tag: ${{ steps.metadata.outputs.is_tag }}
       trigger_type: ${{ steps.metadata.outputs.trigger_type }}
       folder: ${{ steps.metadata.outputs.folder }}
+      survey_key: ${{ steps.survey_key.outputs.survey_key }}
 
     steps:
     - name: Checkout (Release)
@@ -146,6 +149,19 @@ jobs:
         FOLDER_NIGHTLIES: openttd-nightlies
         FOLDER_BRANCHES: openttd-branches
 
+    - name: Generate survey key
+      id: survey_key
+      run: |
+        PAYLOAD='{"version":"${{ steps.metadata.outputs.version }}","type":"${{ vars.SURVEY_TYPE }}"}'
+
+        echo "${{ secrets.SURVEY_SIGNING_KEY }}" > survey_signing_key.pem
+        SIGNATURE=$(echo -n "${PAYLOAD}" | openssl dgst -sha256 -sign survey_signing_key.pem | base64 -w0)
+        rm -f survey_signing_key.pem
+
+        SURVEY_KEY=$(curl -f -s -X POST -d "${PAYLOAD}" -H "Content-Type: application/json" -H "X-Signature: ${SIGNATURE}" https://survey-participate.openttd.org/create-survey-key/${{ vars.SURVEY_TYPE }})
+
+        echo "survey_key=${SURVEY_KEY}" >> $GITHUB_OUTPUT
+
     - name: Remove VCS information
       run: |
         rm -rf .git

.github/workflows/release-windows.yml

@@ -3,6 +3,10 @@ name: Release (Windows)
 on:
   workflow_call:
     inputs:
+      survey_key:
+        required: false
+        type: string
+        default: ""
       is_tag:
         required: true
         type: string
@@ -129,6 +133,7 @@ jobs:
           -DOPTION_USE_NSIS=ON \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
           -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \
           # EOF
         echo "::endgroup::"
@@ -153,6 +158,7 @@ jobs:
           -DCMAKE_TOOLCHAIN_FILE="c:\vcpkg\scripts\buildsystems\vcpkg.cmake" \
           -DHOST_BINARY_DIR=${GITHUB_WORKSPACE}/build-host \
           -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+          -DOPTION_SURVEY_KEY=${{ inputs.survey_key }} \
           -DWINDOWS_CERTIFICATE_COMMON_NAME="${WINDOWS_CERTIFICATE_COMMON_NAME}" \
           # EOF
         echo "::endgroup::"

.github/workflows/release.yml

@@ -38,6 +38,9 @@ jobs:
     uses: ./.github/workflows/release-linux.yml
     secrets: inherit
 
+    with:
+      survey_key: ${{ needs.source.outputs.survey_key }}
+
   macos:
     name: MacOS
     needs: source
@@ -45,6 +48,9 @@ jobs:
     uses: ./.github/workflows/release-macos.yml
     secrets: inherit
 
+    with:
+      survey_key: ${{ needs.source.outputs.survey_key }}
+
   windows:
     name: Windows
     needs: source
@@ -54,6 +60,7 @@ jobs:
 
     with:
       is_tag: ${{ needs.source.outputs.is_tag }}
+      survey_key: ${{ needs.source.outputs.survey_key }}
 
   windows-store:
     name: Windows Store