v1.21

Author: StupidRepo

.idea/inspectionProfiles/profiles_settings.xml

@@ -2,19 +2,20 @@
 All notable changes to this project will be documented in `CHANGELOG.md`.
 
 ## Added
-Nothing has been added.
+* A [LanguageHandler][langhand] for handling strings in different languages. If you want to add a new language, read [this][readme-lang]
 
 ## Modified
-* A few strings have been changed. I'm going to work on making language files so I can support multiple languages.
+Nothing has been modified.
 
 ## Removed
 Nothing has been removed.
 
 ## TODOs
-- [ ] Optimise IP generation and initial scanning code.[¹][1]
+- [ ] Optimise IP generation and initial scanning code.
 - [ ] Optimise code in general.
 - [ ] Separate tool for viewing servers in DB. (code is already here (`ServerList` class), just need to make it separate)
 - [x] ~~Make it save what IP it got to when quitting so that it can resume from that IP on next startup.~~
 - [x] ~~Add a GUI for viewing servers in a nice friendly grid.~~
 
-[1]: https://github.com/StupidRepo/MCScanner/blob/main/src/com/stupidrepo/mcscanner/MCScanner.java#L126
+[readme-lang]: https://github.com/StupidRepo/MCScanner/tree/main#languages
+[langhand]: https://github.com/StupidRepo/MCScanner/blob/main/src/com/stupidrepo/mcscanner/language/LanguageHandler.java

CHANGELOG.md

@@ -22,6 +22,13 @@ Now re-made in Java, and not Python!
 3. Build the project with `Build > Build Project`.
 4. Run the project with `Run > Run 'MCScanner [run]'`.
 
+## Contributing
+### General
+If you want to contribute to this project, you can fork this repository, make your changes, and then make a pull request!
+### Languages
+To contribute to the languages, fork the repository, analyse the `en-GB.json` file, make a new file with your language locale (see [this][lang]), translate the values (not the keys), and then make a pull request!
+Please don't use Google Translate :(
+
 ## Changelogs
 All notable changes to this project will be documented in [`CHANGELOG.md`][changes].
 
@@ -37,4 +44,6 @@ Oh, and **don't use this program for griefing**. Please.
 
 [changes]: https://github.com/StupidRepo/MCScanner/blob/main/CHANGELOG.md
 [latest]: https://github.com/StupidRepo/MCScanner/releases/latest/download/MCScanner.jar
-[latest-source]: https://github.com/StupidRepo/MCScanner/archive/refs/heads/main.zip
+[latest-source]: https://github.com/StupidRepo/MCScanner/archive/refs/heads/main.zip
+
+[lang]: https://www.oracle.com/java/technologies/javase/jdk17-suported-locales.html

README.md

@@ -15,9 +15,21 @@ sourceSets {
         java {
             srcDirs = ['src']
         }
+        resources {
+            srcDirs = ["src/main/resources"]
+        }
     }
 }
 
+//sourceSets {
+//    main {
+//        resources {
+//            srcDirs "src/main/resources"
+//        }
+//    }
+//}
+
+
 mainClassName = 'com.stupidrepo.mcscanner.MCScanner'
 
 jar {

build.gradle

@@ -17,6 +17,11 @@ public class DatabaseHandler {
 
     private final Logger logger = Logger.getLogger("com.stupidrepo.mcscanner");
 
+    /**
+     * Initiates a new DatabaseHandler.
+     *
+     * @param uri The URI to the MongoDB Database
+     */
     public DatabaseHandler(String uri) {
         try {
             mainMongoClient = MongoClients.create(uri);
@@ -28,6 +33,9 @@ public DatabaseHandler(String uri) {
         }
     }
 
+    /**
+     * Gets all the servers in the database.
+     */
     public ArrayList<Document> getServers() {
         ArrayList<Document> servers = new ArrayList<>();
         try {
@@ -41,6 +49,9 @@ public ArrayList<Document> getServers() {
         return servers;
     }
 
+    /**
+     * Gets the server count from the database.
+     */
     public Long getServerCount() {
         try {
             return mainCollection.countDocuments();
@@ -50,6 +61,14 @@ public Long getServerCount() {
         }
     }
 
+    /**
+     * Writes an entry to the database.
+     *
+     * @param ip The IP of the server (<code>192.168.0.1</code>)
+     * @param version The version of the server (<code>1.20.1</code>)
+     * @param motd The MOTD of the server (<code>A Minecraft Server</code>)
+     * @param maxPlayers The max players of the server (<code>20</code>)
+     */
     public void writeDetailsToDB(String ip, String version, String motd, int maxPlayers) {
         try {
             mainCollection
@@ -65,6 +84,14 @@ public void writeDetailsToDB(String ip, String version, String motd, int maxPlay
         }
     }
 
+    /**
+     * Updates a server in the database.
+     *
+     * @param ip The IP of the server
+     * @param version The version of the server
+     * @param motd The MOTD of the server
+     * @param maxPlayers The max players of the server
+     */
     public void updateServerByIPInDB(String ip, String version, String motd, int maxPlayers) {
         try {
             mainCollection.updateOne(
@@ -79,6 +106,11 @@ public void updateServerByIPInDB(String ip, String version, String motd, int max
         }
     }
 
+    /**
+     * Checks if a server is in the database.
+     *
+     * @param ip The IP of the server
+     */
     public boolean isIPInDB(String ip) {
         try {
             Document myDoc = mainCollection.find(new Document("ip", ip)).first();

src/com/stupidrepo/mcscanner/DatabaseHandler.java

@@ -1,5 +1,6 @@
 package com.stupidrepo.mcscanner;
 
+import com.stupidrepo.mcscanner.language.LanguageHandler;
 import org.bson.Document;
 
 import javax.swing.*;
@@ -14,6 +15,7 @@
 import java.net.Socket;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
+import java.util.Locale;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Level;
@@ -27,20 +29,23 @@ public class MCScanner {
     private static int offsetL = 0;
     private static boolean stopping = false;
 
-    public static void main(String[] var0) {
+    public static LanguageHandler lang;
+
+    public static void main(String[] args) {
         AtomicInteger threads = new AtomicInteger(1024);
         int timeout = 1000;
-        int minimumRange = 1;
         int maxRange = 255;
         int port = 25565;
 
         Logger logger = Logger.getLogger("com.stupidrepo.mcscanner");
 
-        float version = 1.20f;
+        float version = 1.21f;
 
         AtomicReference<String> uri = new AtomicReference<>("mongodb://localhost:27017");
 
-        PopupHandler threadsPopup = new PopupHandler("How many threads would you like to use?", "1024", "OK");
+        lang = new LanguageHandler(Locale.forLanguageTag("en-gb"));
+
+        PopupHandler threadsPopup = new PopupHandler(lang.get("question.THREADS"), "1024", "OK");
         threadsPopup.showAndWait();
 
         try {
@@ -49,7 +54,7 @@ public static void main(String[] var0) {
             logger.log(Level.SEVERE, "Invalid thread count.");
         }
 
-        PopupHandler mongoDBURIPopup = new PopupHandler("Enter the URI to the MongoDB database:", "mongodb://localhost:27017", "Done");
+        PopupHandler mongoDBURIPopup = new PopupHandler(lang.get("question.MONGO"), "mongodb://localhost:27017", "Done");
         mongoDBURIPopup.showAndWait();
 
         uri.set(mongoDBURIPopup.responseText);
@@ -58,14 +63,14 @@ public static void main(String[] var0) {
 
         logger.log(Level.INFO, "Scanning IPs...");
 
-        JFrame frame = new JFrame("MCScanner v" + version);
+        JFrame frame = new JFrame(lang.get("text.TITLE").formatted(version));
         frame.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);
         frame.setSize(300, 100);
         frame.setLayout(new BorderLayout());
 
         ArrayList < Thread > threadList = new ArrayList < Thread > ();
 
-        JLabel scannedLabel = new JLabel("Scanned: 0");
+        JLabel scannedLabel = new JLabel(lang.get("text.SCANNED").formatted(0));
         scannedLabel.setHorizontalAlignment(0);
 
         frame.add(scannedLabel, "Center");
@@ -97,16 +102,12 @@ public void windowClosing(java.awt.event.WindowEvent windowEvent) {
             }
         });
 
-        ServerList serverList = new ServerList(databaseHandler);
+        ServerList serverList = new ServerList(databaseHandler, lang);
 
-        JButton viewServersButton = new JButton("Show Server List");
+        JButton viewServersButton = new JButton(lang.get("button.SERVERLIST"));
 
         viewServersButton.addActionListener(e -> {
-            if(serverList.toggleGUI()) {
-                viewServersButton.setText("Hide Server List");
-            } else {
-                viewServersButton.setText("Show Server List");
-            }
+            serverList.toggleGUI();
         });
 
         frame.add(viewServersButton, "North");
@@ -170,7 +171,7 @@ public void windowClosing(java.awt.event.WindowEvent windowEvent) {
                                 try {
                                     nextThread.join();
                                     ++scanned;
-                                    scannedLabel.setText("Scanned: " + scanned + " (" + ip + ")");
+                                    scannedLabel.setText(lang.get("text.SCANNED").formatted(scanned));
                                 } catch (InterruptedException timeout2) {
                                     // Timed out or smth
                                 }
@@ -189,7 +190,7 @@ public void windowClosing(java.awt.event.WindowEvent windowEvent) {
             try {
                 nextThreadAgain.join();
                 ++scanned;
-                scannedLabel.setText("Scanned: " + scanned);
+                scannedLabel.setText(lang.get("text.SCANNED").formatted(scanned));
             } catch (InterruptedException timeout1) {
                 // Timeout, again!
             }
@@ -287,11 +288,13 @@ public void run() {
 
 class ServerList {
     private final DatabaseHandler dbHandler;
+    private final LanguageHandler lang;
     private final JFrame frame;
 
-    public ServerList(DatabaseHandler dbHandler) {
+    public ServerList(DatabaseHandler dbHandler, LanguageHandler lang) {
+        this.lang = lang;
         this.dbHandler = dbHandler;
-        this.frame = new JFrame("MCScanner - Servers (" + this.dbHandler.getServerCount() + ")");
+        this.frame = new JFrame(lang.get("text.SERVERLIST.TITLE").formatted(0));
         this.frame.setDefaultCloseOperation(WindowConstants.HIDE_ON_CLOSE);
         this.frame.setSize(720, 500);
         this.frame.setLayout(new BorderLayout());
@@ -301,7 +304,7 @@ public ServerList(DatabaseHandler dbHandler) {
             new Object[][] {
             },
             new String[] {
-                "IP", "MOTD", "Version", "Max Players"
+                lang.get(this.lang.get("text.SERVERLIST.IP")), this.lang.get("text.SERVERLIST.MOTD"), this.lang.get("text.SERVERLIST.VERSION"), this.lang.get("text.SERVERLIST.MAX_PLAYERS")
             }
         ));
         table.getColumnModel().getColumn(0).setPreferredWidth(100);
@@ -328,10 +331,10 @@ public ServerList(DatabaseHandler dbHandler) {
         searchBar.addFocusListener(new PlaceholderText("Search", searchBar).getFocusAdapter());
 
         JComboBox<String> searchBy = new JComboBox<String>();
-        searchBy.addItem("Sort By: IP");
-        searchBy.addItem("Sort By: MOTD");
-        searchBy.addItem("Sort By: Version");
-        searchBy.addItem("Sort By: Max Players");
+        searchBy.addItem(lang.get("dropdown.SERVERLIST.IP"));
+        searchBy.addItem(lang.get("dropdown.SERVERLIST.MOTD"));
+        searchBy.addItem(lang.get("dropdown.SERVERLIST.VERSION"));
+        searchBy.addItem(lang.get("dropdown.SERVERLIST.MAX_PLAYERS"));
         searchBy.setSelectedIndex(2);
 
         searchBar.addActionListener(e -> {
@@ -350,7 +353,7 @@ public ServerList(DatabaseHandler dbHandler) {
         Timer timer = new Timer(10000, e -> {
             ((DefaultTableModel) table.getModel()).setRowCount(0);
             ArrayList < Document > documents1 = this.dbHandler.getServers();
-            this.frame.setTitle("MCScanner - Servers (" + documents1.size() + ")");
+            this.frame.setTitle(lang.get("text.SERVERLIST.TITLE").formatted(documents1.size()));
             for (Document document: documents1) {
                 String ip = document.getString("ip");
                 String motd = document.getString("motd");

src/com/stupidrepo/mcscanner/MCScanner.java

@@ -0,0 +1,64 @@
+package com.stupidrepo.mcscanner.language;
+
+import org.bson.BsonString;
+import org.bson.json.JsonObject;
+
+import java.io.*;
+import java.util.*;
+import java.util.logging.Logger;
+
+import java.util.logging.Level;
+
+public class LanguageHandler {
+    private final Hashtable<Object, Object> strings = new Hashtable<>();
+
+    private Locale language;
+    private final Locale fallbackLocale;
+
+    private final Logger logger = Logger.getLogger("com.stupidrepo.mcscanner");
+
+    public LanguageHandler(Locale fallback) {
+        this.fallbackLocale = fallback;
+        this.language = Locale.getDefault();
+        this.loadStringsToDictionary();
+    }
+
+    public String get(String key) {
+        if(this.strings.containsKey(key)) {
+            return ((BsonString) this.strings.get(key)).getValue();
+        } else {
+            logger.log(Level.SEVERE, "No string found for key '%s'.".formatted(key));
+            return key;
+        }
+    }
+
+    public Locale getLanguage() {
+        return this.language;
+    }
+
+    public Locale setLanguage(String language) {
+        this.language = Locale.forLanguageTag(language);
+        this.loadStringsToDictionary();
+        return this.language;
+    }
+
+    public void loadStringsToDictionary() {
+        ClassLoader classLoader = getClass().getClassLoader();
+        InputStream is = classLoader.getResourceAsStream("lang/%s.json".formatted(this.language.toLanguageTag()));
+
+        if (is == null) { is = classLoader.getResourceAsStream("lang/%s.json".formatted(this.fallbackLocale.toLanguageTag())); }
+        if (is == null) { logger.log(Level.SEVERE, "No language file found for %s or %s!".formatted(this.language.toLanguageTag(), this.fallbackLocale.toLanguageTag())); } else {
+            try {
+                BufferedReader reader = new BufferedReader(new InputStreamReader(is));
+                StringBuilder sb = new StringBuilder();
+                String line;
+                while ((line = reader.readLine()) != null) { sb.append(line); }
+                JsonObject json = new JsonObject(sb.toString());
+                this.strings.putAll(json.toBsonDocument());
+                logger.log(Level.INFO, "Loaded language file for %s!".formatted(this.language.toLanguageTag()));
+            } catch (IOException e) {
+                e.printStackTrace();
+            }
+        }
+    }
+}

src/com/stupidrepo/mcscanner/language/LanguageHandler.java

@@ -0,0 +1,20 @@
+{
+  "text.TITLE": "MCScanner v%s",
+  "text.SCANNED": "Scanned: %s",
+
+  "text.SERVERLIST.TITLE": "MCScanner - Servers (%s)",
+  "text.SERVERLIST.IP": "IP",
+  "text.SERVERLIST.VERSION": "Version",
+  "text.SERVERLIST.MOTD": "MOTD",
+  "text.SERVERLIST.MAX_PLAYERS": "Max Players",
+
+  "question.THREADS": "How many threads would you like to use?",
+  "question.MONGO": "What's the URI to your MongoDB database?",
+
+  "button.SERVERLIST": "Toggle Server List",
+
+  "dropdown.SERVERLIST.IP": "Sort By: IP",
+  "dropdown.SERVERLIST.VERSION": "Sort By: Version",
+  "dropdown.SERVERLIST.MOTD": "Sort By: MOTD",
+  "dropdown.SERVERLIST.MAX_PLAYERS": "Sort By: Max Players"
+}