Merge pull request 'Add support for 'random' in Favicon option' (#376) from feature/add-random-favicon-option into master

Reviewed-on: https://codeberg.org/Andre601/AdvancedServerList/pulls/376

.forgejo/workflows/deploy_wiki.yml

@@ -0,0 +1,45 @@
+name: "Deploy Wiki"
+
+on:
+  push:
+    branches:
+      - master
+    tags-ignore:
+      - "**"
+    paths:
+      - ".forgejo/workflows/deploy_wiki.yml"
+      - "docs/**"
+      - "domains"
+      - "mkdocs.yml"
+      - "requirements.txt"
+
+jobs:
+  deployWiki:
+    runs-on: codeberg-tiny
+    container:
+      image: ghcr.io/catthehacker/ubuntu:act-latest
+    steps:
+      - name: "Checkout Source Repository"
+        uses: https://code.forgejo.org/actions/checkout@v4
+        with:
+          token: "${{ secrets.BOT_TOKEN }}"
+      - name: "Checkout Target Repository"
+        run: "git clone -b pages https://codeberg.org/Andre601/asl-docs site"
+      - name: "Setup Python 3.x"
+        uses: https://code.forgejo.org/actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: "Install Dependencies"
+        run: "pip install -r requirements.txt"
+      - name: "Build Website"
+        run: "mkdocs build"
+      - name: "Commit and Push"
+        run: |
+          git config --global user.email "andre_601-bot@noreply.codeberg.org"
+          git config --global user.name "ASL Wiki Builder"
+          mv domains site/.domains
+          cd site
+          git remote set-url origin https://${{ secrets.BOT_TOKEN }}@codeberg.org/Andre601/asl-docs
+          git add --all
+          git commit -m "Update Wiki ($( env TZ=Europe/Zurich date +"%d.%m.%Y %Z" ))"
+          git push

.forgejo/workflows/pr_preview.yml

@@ -0,0 +1,117 @@
+name: Pull Request Preview
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - synchronize
+    paths:
+      - ".forgejo/workflows/pr_preview.yml"
+      - "docs/**"
+      - "mkdocs.yml"
+      - "preview_domains"
+      - "requirements.txt"
+  workflow_dispatch:
+
+env:
+  BRANCH_NAME: "${{ github.event.repository.name }}/${{ github.event.pull_request.number }}"
+
+jobs:
+  createPreview:
+    runs-on: codeberg-tiny
+    container:
+      image: ghcr.io/catthehacker/ubuntu:act-latest
+    steps:
+      #
+      # Finding and updating comment in Pull request.
+      # If not found, have one created instead.
+      #
+      - name: "Find Comment"
+        id: find-comment
+        uses: https://github.com/peter-evans/find-comment@v3
+        with:
+          issue-number: "${{ github.event.pull_request.number }}"
+          comment-author: "Andre_601-Bot"
+      - name: "Create or update Comment"
+        id: comment
+        uses: https://github.com/peter-evans/create-or-update-comment@v4
+        with:
+          body: |-
+            ## Pull request Preview
+
+            Creating Preview for Pull request. Please wait...
+          comment-id: "${{ steps.find-comment.outputs.comment-id }}"
+          issue-number: "${{ github.event.pull_request.number }}"
+          token: "${{ secrets.BOT_TOKEN }}"
+          edit-mode: replace
+      #
+      # Setup source and target repository.
+      # Build website and push.
+      #
+      - name: "Checkout Source Repository"
+        uses: https://code.forgejo.org/actions/checkout@v4
+        with:
+          token: ${{ secrets.BOT_TOKEN }}
+          fetch-depth: 0
+          ref: "${{ github.event.pull_request.head.sha }}"
+      - name: "Checkout Target Repository"
+        run: |
+          git clone https://codeberg.org/Andre601/preview site
+          cd site
+          git switch ${{ env.BRANCH_NAME }} 2>/dev/null || git switch -c ${{ env.BRANCH_NAME }}
+      - name: "Setup Python 3.x"
+        uses: https://code.forgejo.org/actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: "Install Dependencies"
+        run: "pip install -r requirements.txt"
+      - name: "Build Website"
+        run: "mkdocs build"
+      - name: "Commit and Push"
+        run: |
+          git config --global user.email "andre_601-bot@noreply.codeberg.org"
+          git config --global user.name "PR Docs Preview Builder"
+          mv preview_domains site/.domains
+          cd site
+          git remote add upstream https://${{ secrets.BOT_TOKEN }}@codeberg.org/Andre601/preview.git
+          git add --all
+          git commit -m "Update Preview for ${{ env.BRANCH_NAME }} ($( env TZ=Europe/Zurich date +"%d.%m.%Y %Z" ))"
+          git push --set-upstream upstream ${{ env.BRANCH_NAME }} -f
+      #
+      # Update comment on success or failure.
+      #
+      - name: "Comment Success"
+        uses: https://github.com/peter-evans/create-or-update-comment@v4
+        with:
+          body: |-
+            ## Pull request Preview
+
+            Pull request Preview created successfully!
+
+            | Name    | Link                                                                                                     |
+            |---------|----------------------------------------------------------------------------------------------------------|
+            | Commit  | ${{ github.event.pull_request.head.sha }}                                                                |
+            | Preview | https://preview.andre601.ch/@${{ github.event.repository.name }}~${{ github.event.pull_request.number }} |
+            | Logs    | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}                      |
+          comment-id: "${{ steps.comment.outputs.comment-id }}"
+          issue-number: "${{ github.event.pull_request.number }}"
+          token: "${{ secrets.BOT_TOKEN }}"
+          edit-mode: replace
+      - name: "Comment Failure"
+        if: ${{ failure() }}
+        uses: https://github.com/peter-evans/create-or-update-comment@v4
+        with:
+          body: |-
+            ## Pull request Preview
+
+            Pull request Preview failed! Check the logs for details.
+
+            | Name    | Link                                                                                |
+            |---------|-------------------------------------------------------------------------------------|
+            | Commit  | ${{ github.event.pull_request.head.sha }}                                           |
+            | Logs    | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
+          comment-id: "${{ steps.comment.outputs.comment-id }}"
+          issue-number: "${{ github.event.pull_request.number }}"
+          token: "${{ secrets.BOT_TOKEN }}"
+          edit-mode: replace

CHANGELOG.md

@@ -1,13 +0,0 @@
-# Changelog
-
-## [5.0.5](https://codeberg.org/Andre601/AdvancedServerList/releases/tag/v5.0.5) - 2024-10-10
-
-### ❤️ Thanks to all contributors! ❤️
-
-@Andre601, @Andre_601-Bot
-
-### Misc
-
-- Update dependency ch.qos.logback:logback-classic to v1.5.9 [[#354](https://codeberg.org/Andre601/AdvancedServerList/pulls/354)]
-- Improve PAPIProxyBridge support [[#353](https://codeberg.org/Andre601/AdvancedServerList/pulls/353)]
-- Add automatic release action [[#351](https://codeberg.org/Andre601/AdvancedServerList/pulls/351)]

SECURITY.md

@@ -6,12 +6,14 @@ To ensure proper safety and support are only certain versions and Platforms of A
 
 | Major Version | Supported |
 |---------------|-----------|
-| v4            | Yes       |
-| v3            | Yes*      |
+| v5            | Yes       |
+| v4            | Yes*      |
+| v3            | Yes**     |
 | v2            | No        |
 | v1            | No        |
 
-\*Only receives support but no updates or bug fixes.
+\*Only receives support but no updates or bug fixes.  
+\*\*Support ends at the end of 2024.
 
 ## Supported Server/Proxy Versions
 

addons/banplugins/src/main/java/ch/andre601/advancedserverlist/banplugins/providers/AdvancedBanProvider.java

@@ -35,26 +35,6 @@ import java.util.UUID;
 
 public class AdvancedBanProvider implements PunishmentProvider{
     
-    private static PunishmentManager getAPI(){
-        return PunishmentManager.get();
-    }
-    
-    private static String noDashesUUID(UUID uuid){
-        return hexString(uuid.getMostSignificantBits()) + hexString(uuid.getLeastSignificantBits());
-    }
-    
-    private static Punishment mute(GenericPlayer player){
-        return getAPI().getMute(noDashesUUID(player.getUUID()));
-    }
-    
-    private static Punishment ban(GenericPlayer player){
-        return getAPI().getBan(noDashesUUID(player.getUUID()));
-    }
-    
-    private static String hexString(long unsigned){
-        return Strings.padStart(UnsignedLongs.toString(unsigned, 16), 16, '0');
-    }
-    
     @Override
     public String muted(GenericPlayer player){
         return String.valueOf(getAPI().isMuted(noDashesUUID(player.getUUID())));
@@ -134,4 +114,24 @@ public class AdvancedBanProvider implements PunishmentProvider{
         
         return ban.getDuration(fromStart);
     }
+    
+    private PunishmentManager getAPI(){
+        return PunishmentManager.get();
+    }
+    
+    private String noDashesUUID(UUID uuid){
+        return hexString(uuid.getMostSignificantBits()) + hexString(uuid.getLeastSignificantBits());
+    }
+    
+    private Punishment mute(GenericPlayer player){
+        return getAPI().getMute(noDashesUUID(player.getUUID()));
+    }
+    
+    private Punishment ban(GenericPlayer player){
+        return getAPI().getBan(noDashesUUID(player.getUUID()));
+    }
+    
+    private String hexString(long unsigned){
+        return Strings.padStart(UnsignedLongs.toString(unsigned, 16), 16, '0');
+    }
 }

core/pom.xml

@@ -137,7 +137,7 @@
         <dependency>
             <groupId>net.william278</groupId>
             <artifactId>papiproxybridge</artifactId>
-            <version>1.6.2</version>
+            <version>1.7.1</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -157,7 +157,7 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <version>5.11.2</version>
+            <version>5.11.3</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/handlers/FaviconHandler.java

@@ -42,9 +42,8 @@ import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.HashMap;
-import java.util.Locale;
-import java.util.Map;
+import java.util.List;
+import java.util.*;
 import java.util.concurrent.*;
 import java.util.stream.Stream;
 
@@ -57,6 +56,7 @@ public class FaviconHandler<F>{
     
     private final Map<String, F> localFavicons = new HashMap<>();
     private final HttpClient client = HttpClient.newHttpClient();
+    private final Random random = new Random();
     
     public FaviconHandler(AdvancedServerList<F> core){
         this.core = core;
@@ -77,6 +77,11 @@ public class FaviconHandler<F>{
             }
         }
         
+        if(input.equalsIgnoreCase("random")){
+            logger.debug(FaviconHandler.class, "Input matches 'random'. Returning random Favicon...");
+            return getRandomized();
+        }
+        
         if(localFavicons.containsKey(input.toLowerCase(Locale.ROOT))){
             logger.debug(FaviconHandler.class, "Input matches local favicon Image. Returning it...");
             return localFavicons.get(input.toLowerCase(Locale.ROOT));
@@ -101,6 +106,9 @@ public class FaviconHandler<F>{
             logger.debug(FaviconHandler.class, "Resolving URL '%s'...", input);
             return CompletableFuture.supplyAsync(() -> fromURL(core, input), this.faviconThreadPool);
         }else
+        if(input.equalsIgnoreCase("random")){
+            return CompletableFuture.completedFuture(getRandomized());
+        }else
         if(input.toLowerCase(Locale.ROOT).endsWith(".png")){
             logger.debug(FaviconHandler.class, "Resolving image file '%s'...", input);
             return CompletableFuture.completedFuture(localFavicons.get(input.toLowerCase(Locale.ROOT)));
@@ -110,6 +118,22 @@ public class FaviconHandler<F>{
         }
     }
     
+    private F getRandomized(){
+        logger.debug(FaviconHandler.class, "Obtaining random Favicon...");
+        if(localFavicons.isEmpty())
+            return null;
+        
+        List<F> faviconList = List.copyOf(localFavicons.values());
+        
+        // Don't use Random for just one entry.
+        if(faviconList.size() == 1)
+            return faviconList.get(0);
+        
+        synchronized(random){
+            return faviconList.get(random.nextInt(faviconList.size()));
+        }
+    }
+    
     private void loadLocalFavicons(){
         this.localFavicons.clear();
         

docs/addons/banplugins.md

@@ -2,6 +2,10 @@
 
 The BanPlugins Addon was made to provide placeholders for different punishment plugins to use in AdvancedServerList.
 
+/// info
+The BanPlugins Addon is available in downloads of AdvancedServerList on [:simple-modrinth: Modrinth](https://modrinth.com/plugin/advancedserverlist) and on [Releases on :simple-codeberg: Codeberg](https://codeberg.org/Andre601/AdvancedServerList/releases).
+///
+
 ## Placeholders
 
 /// tab | AdvancedBan

docs/migration/minimotd.md

@@ -18,7 +18,7 @@ Execute the command [`/asl migrate minimotd`](../commands/index.md#migrate) to s
 Below can you find a full example of a `main.conf` file and the corresponding migrated files from AdvancedServerList:
 
 /// tab | :octicons-file-code-24: main.conf
-```conf
+```lighty
 icon-enabled=true
 motd-enabled=true
 motds=[

docs/profiles/index.md

@@ -122,7 +122,8 @@ The `favicon` option can be used to define an image to display in the server lis
 The Value can be one of three possible options, each being checked for in order:
 
 - A URL pointing to an image file. The URL needs to start with `https://` to work.
-- A PNG filename, including `.png` file extension, matching a PNG file in the `favicons` folder.
+- The keyword `random`. Setting this will have the plugin randomly select an existing PNG file from its `favicons` folder.
+- A filename matching an existing PNG file in the plugin's `favicons` folder. The `.png` extension needs to be included.
 - A player name or UUID, or a [placeholder](placeholders.md) that resolves into one.
 
 Note that for the name/UUID, the site https://mc-heads.net is being used.  
@@ -356,7 +357,7 @@ You can use placeholders that resolve into numbers for this option.
 /// details | Example
     type: example
 
-```yaml title="YAML file
+```yaml title="YAML file"
 priority: 0
 
 # Hides the MOTD for demonstration purposes

paper/pom.xml

@@ -99,7 +99,7 @@
         <dependency>
             <groupId>com.viaversion</groupId>
             <artifactId>viaversion-api</artifactId>
-            <version>5.0.3</version>
+            <version>5.1.1</version>
             <scope>provided</scope>
         </dependency>
 

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>5.0.5</plugin.version>
+        <plugin.version>5.1.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>4.0.0</api.version>

requirements.txt

@@ -1,3 +1,3 @@
-mkdocs-material==9.5.40
+mkdocs-material==9.5.47
 mkdocs-glightbox==0.4.0
 git+https://github.com/Andre601/mkdocs-pagenav-generator

version-uploader/pom.xml

@@ -52,13 +52,13 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.5.9</version>
+            <version>1.5.12</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
-            <version>5.4</version>
+            <version>5.4.1</version>
             <scope>compile</scope>
         </dependency>
         <dependency>