From 2d4e158198fbf783a8d441d79d8af689e8822657 Mon Sep 17 00:00:00 2001
From: Jonah Lawrence <jonah@freshidea.com>
Date: Mon, 13 Feb 2023 23:38:59 -0700
Subject: [PATCH 1/2] feat: Add `disable_animations` parameter

---
 README.md             | 41 +++++++++++++++++++++--------------------
 src/card.php          | 35 +++++++++++++++++++++++++++--------
 src/demo/index.php    |  6 ++++++
 src/demo/js/script.js |  1 +
 tests/RenderTest.php  | 16 ++++++++++++++++
 5 files changed, 71 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 49541a46..762cf678 100644
--- a/README.md
+++ b/README.md
@@ -43,26 +43,27 @@ The `user` field is the only required option. All other fields are optional.
 
 If the `theme` parameter is specified, any color customizations specified will be applied on top of the theme, overriding the theme's values.
 
-|     Parameter     |                     Details                     |                                  Example                                  |
-| :---------------: | :---------------------------------------------: | :-----------------------------------------------------------------------: |
-|      `user`       |        GitHub username to show stats for        |                              `DenverCoder1`                               |
-|      `theme`      |     The theme to apply (Default: `default`)     |              `dark`, `radical`, etc. [🎨➜](./docs/themes.md)              |
-|   `hide_border`   | Make the border transparent (Default: `false`)  |                             `true` or `false`                             |
-|  `border_radius`  | Set the roundness of the edges (Default: `4.5`) |               Number `0` (sharp corners) to `248` (ellipse)               |
-|   `background`    |                Background color                 |                 **hex code** without `#` or **css color**                 |
-|     `border`      |                  Border color                   |                 **hex code** without `#` or **css color**                 |
-|     `stroke`      |       Stroke line color between sections        |                 **hex code** without `#` or **css color**                 |
-|      `ring`       |   Color of the ring around the current streak   |                 **hex code** without `#` or **css color**                 |
-|      `fire`       |          Color of the fire in the ring          |                 **hex code** without `#` or **css color**                 |
-|  `currStreakNum`  |              Current streak number              |                 **hex code** without `#` or **css color**                 |
-|    `sideNums`     |        Total and longest streak numbers         |                 **hex code** without `#` or **css color**                 |
-| `currStreakLabel` |              Current streak label               |                 **hex code** without `#` or **css color**                 |
-|   `sideLabels`    |         Total and longest streak labels         |                 **hex code** without `#` or **css color**                 |
-|      `dates`      |              Date range text color              |                 **hex code** without `#` or **css color**                 |
-|   `date_format`   | Date format pattern or empty for locale format  |            See note below on [📅 Date Formats](#-date-formats)            |
-|     `locale`      |  Locale for labels and numbers (Default: `en`)  |                ISO 639-1 code - See [🗪 Locales](#-locales)                |
-|      `type`       |         Output format (Default: `svg`)          |                  Current options: `svg`, `png` or `json`                  |
-|      `mode`       |         Streak mode (Default: `daily`)          | `daily` (contribute daily) or `weekly` (contribute once per Sun-Sat week) |
+|      Parameter       |                     Details                     |                                  Example                                  |
+| :------------------: | :---------------------------------------------: | :-----------------------------------------------------------------------: |
+|        `user`        |        GitHub username to show stats for        |                              `DenverCoder1`                               |
+|       `theme`        |     The theme to apply (Default: `default`)     |              `dark`, `radical`, etc. [🎨➜](./docs/themes.md)              |
+|    `hide_border`     | Make the border transparent (Default: `false`)  |                             `true` or `false`                             |
+|   `border_radius`    | Set the roundness of the edges (Default: `4.5`) |               Number `0` (sharp corners) to `248` (ellipse)               |
+|     `background`     |                Background color                 |                 **hex code** without `#` or **css color**                 |
+|       `border`       |                  Border color                   |                 **hex code** without `#` or **css color**                 |
+|       `stroke`       |       Stroke line color between sections        |                 **hex code** without `#` or **css color**                 |
+|        `ring`        |   Color of the ring around the current streak   |                 **hex code** without `#` or **css color**                 |
+|        `fire`        |          Color of the fire in the ring          |                 **hex code** without `#` or **css color**                 |
+|   `currStreakNum`    |              Current streak number              |                 **hex code** without `#` or **css color**                 |
+|      `sideNums`      |        Total and longest streak numbers         |                 **hex code** without `#` or **css color**                 |
+|  `currStreakLabel`   |              Current streak label               |                 **hex code** without `#` or **css color**                 |
+|     `sideLabels`     |         Total and longest streak labels         |                 **hex code** without `#` or **css color**                 |
+|       `dates`        |              Date range text color              |                 **hex code** without `#` or **css color**                 |
+|    `date_format`     | Date format pattern or empty for locale format  |            See note below on [📅 Date Formats](#-date-formats)            |
+|       `locale`       |  Locale for labels and numbers (Default: `en`)  |                ISO 639-1 code - See [🗪 Locales](#-locales)                |
+|        `type`        |         Output format (Default: `svg`)          |                  Current options: `svg`, `png` or `json`                  |
+|        `mode`        |         Streak mode (Default: `daily`)          | `daily` (contribute daily) or `weekly` (contribute once per Sun-Sat week) |
+| `disable_animations` |    Disable SVG animations (Default: `false`)    |                             `true` or `false`                             |
 
 ### 🖌 Themes
 
diff --git a/src/card.php b/src/card.php
index 52d52fd1..d4740cf5 100644
--- a/src/card.php
+++ b/src/card.php
@@ -103,7 +103,7 @@ function getRequestedTheme(array $params): array
     }
 
     // hide borders
-    if (isset($params["hide_border"]) && $params["hide_border"] == "true") {
+    if (strtolower($params["hide_border"] ?? "") === "true") {
         $theme["border"] = "#0000"; // transparent
     }
 
@@ -476,6 +476,22 @@ function generateErrorCard(string $message, array $params = null): string
 ";
 }
 
+/**
+ * Remove animations from SVG
+ *
+ * @param string $svg The SVG for the card as a string
+ * @return string The SVG without animations
+ */
+function removeAnimations(string $svg): string
+{
+    $svg = preg_replace("/(<style>\X*?<\/style>)/m", "", $svg);
+    $svg = preg_replace("/(opacity: 0;)/m", "opacity: 1;", $svg);
+    $svg = preg_replace("/(animation: fadein[^;'\"]+)/m", "opacity: 1;", $svg);
+    $svg = preg_replace("/(animation: currstreak[^;'\"]+)/m", "font-size: 28px;", $svg);
+    $svg = preg_replace("/<a \X*?>(\X*?)<\/a>/m", '\1', $svg);
+    return $svg;
+}
+
 /**
  * Converts an SVG card to a PNG image
  *
@@ -488,11 +504,7 @@ function convertSvgToPng(string $svg): string
     $svg = trim($svg);
 
     // remove style and animations
-    $svg = preg_replace("/(<style>\X*?<\/style>)/m", "", $svg);
-    $svg = preg_replace("/(opacity: 0;)/m", "opacity: 1;", $svg);
-    $svg = preg_replace("/(animation: fadein[^;'\"]+)/m", "opacity: 1;", $svg);
-    $svg = preg_replace("/(animation: currstreak[^;'\"]+)/m", "font-size: 28px;", $svg);
-    $svg = preg_replace("/<a \X*?>(\X*?)<\/a>/m", '\1', $svg);
+    $svg = removeAnimations($svg);
 
     // escape svg for shell
     $svg = escapeshellarg($svg);
@@ -521,11 +533,14 @@ function convertSvgToPng(string $svg): string
  * Return headers and response based on type
  *
  * @param string|array $output The stats (array) or error message (string) to display
+ * @param array<string,string>|NULL $params Request parameters
  * @return array The Content-Type header and the response body, and status code in case of an error
  */
-function generateOutput(string|array $output): array
+function generateOutput(string|array $output, array $params = null): array
 {
-    $requestedType = $_REQUEST["type"] ?? "svg";
+    $params = $params ?? $_REQUEST;
+
+    $requestedType = $params["type"] ?? "svg";
 
     // output JSON data
     if ($requestedType === "json") {
@@ -554,6 +569,10 @@ function generateOutput(string|array $output): array
             ];
         }
     }
+    // remove animations if disable_animations is set
+    if (strtolower($params["disable_animations"] ?? "") === "true") {
+        $svg = removeAnimations($svg);
+    }
     // output SVG card
     return [
         "contentType" => "image/svg+xml",
diff --git a/src/demo/index.php b/src/demo/index.php
index 3726a478..8542be76 100644
--- a/src/demo/index.php
+++ b/src/demo/index.php
@@ -137,6 +137,12 @@ function gtag() {
                     <option value="weekly">Weekly</option>
                 </select>
 
+                <label for="disable_animations">Disable Animations</label>
+                <select class="param" id="hide-border" name="disable_animations">
+                    <option>false</option>
+                    <option>true</option>
+                </select>
+
                 <details class="advanced">
                     <summary>⚙ Advanced Options</summary>
                     <div class="content parameters">
diff --git a/src/demo/js/script.js b/src/demo/js/script.js
index f9d49e89..e29c46cc 100644
--- a/src/demo/js/script.js
+++ b/src/demo/js/script.js
@@ -12,6 +12,7 @@ const preview = {
     locale: "en",
     border_radius: "4.5",
     mode: "daily",
+    disable_animations: "false",
   },
 
   /**
diff --git a/tests/RenderTest.php b/tests/RenderTest.php
index c939981d..f91b0da2 100644
--- a/tests/RenderTest.php
+++ b/tests/RenderTest.php
@@ -134,4 +134,20 @@ public function testSplitLines(): void
             splitLines("19 de dez. de 2021 - 14 de mar.", 24, 0)
         );
     }
+
+    /**
+     * Test disable_animations parameter
+     */
+    public function testDisableAnimations(): void
+    {
+        $this->testParams["disable_animations"] = "true";
+        // Check that the card is rendered as expected
+        $response = generateOutput($this->testStats, $this->testParams);
+        $render = $response["body"];
+        $this->assertStringNotContainsString("opacity: 0;", $render);
+        $this->assertStringContainsString("opacity: 1;", $render);
+        $this->assertStringContainsString("font-size: 28px;", $render);
+        $this->assertStringNotContainsString("animation:", $render);
+        $this->assertStringNotContainsString("<style>", $render);
+    }
 }

From ed5c747fdfc2fce322d0b9af23e01cd2e85a5945 Mon Sep 17 00:00:00 2001
From: Jonah Lawrence <jonah@freshidea.com>
Date: Mon, 13 Feb 2023 23:47:29 -0700
Subject: [PATCH 2/2] refactor, remove unrelated changes

---
 src/card.php | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/card.php b/src/card.php
index d4740cf5..8cc1322a 100644
--- a/src/card.php
+++ b/src/card.php
@@ -103,7 +103,7 @@ function getRequestedTheme(array $params): array
     }
 
     // hide borders
-    if (strtolower($params["hide_border"] ?? "") === "true") {
+    if (isset($params["hide_border"]) && $params["hide_border"] == "true") {
         $theme["border"] = "#0000"; // transparent
     }
 
@@ -570,7 +570,7 @@ function generateOutput(string|array $output, array $params = null): array
         }
     }
     // remove animations if disable_animations is set
-    if (strtolower($params["disable_animations"] ?? "") === "true") {
+    if (isset($params["disable_animations"]) && $params["disable_animations"] == "true") {
         $svg = removeAnimations($svg);
     }
     // output SVG card