From 4d082388a549c7997e918aa09d8f5148b66d7c1c Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sat, 5 Dec 2015 20:53:44 +0100 Subject: [PATCH] Create tag template / auto-generate page for all permissions incl. description --- src/tools/docs/permission_nodes.md | 41 +++++++++ .../PermissionNodesGatherer.java | 2 +- .../permissions/PermissionsListWriter.java | 86 +++++++++++++++++++ src/tools/permissions/README.md | 2 + .../permissions/permission_node_entry.tpl.md | 1 + src/tools/permissions/permission_nodes.tpl.md | 7 ++ .../PermissionsListWriter.java | 62 ------------- src/tools/permissionstree/README.md | 2 - src/tools/utils/ANewMap.java | 36 ++++++++ src/tools/utils/CommentType.java | 11 --- src/tools/utils/GeneratedFileWriter.java | 62 ++++++------- src/tools/utils/TagReplacer.java | 46 ++++++++++ src/tools/utils/ToolsConstants.java | 17 ++++ 13 files changed, 261 insertions(+), 114 deletions(-) create mode 100644 src/tools/docs/permission_nodes.md rename src/tools/{permissionstree => permissions}/PermissionNodesGatherer.java (99%) create mode 100644 src/tools/permissions/PermissionsListWriter.java create mode 100644 src/tools/permissions/README.md create mode 100644 src/tools/permissions/permission_node_entry.tpl.md create mode 100644 src/tools/permissions/permission_nodes.tpl.md delete mode 100644 src/tools/permissionstree/PermissionsListWriter.java delete mode 100644 src/tools/permissionstree/README.md create mode 100644 src/tools/utils/ANewMap.java delete mode 100644 src/tools/utils/CommentType.java create mode 100644 src/tools/utils/TagReplacer.java create mode 100644 src/tools/utils/ToolsConstants.java diff --git a/src/tools/docs/permission_nodes.md b/src/tools/docs/permission_nodes.md new file mode 100644 index 000000000..309584e44 --- /dev/null +++ b/src/tools/docs/permission_nodes.md @@ -0,0 +1,41 @@ + + + +## AuthMe Permission Nodes +The following are the permission nodes that are currently supported by the latest dev builds. + +- **authme.command.admin.accounts** – Administrator command to see all accounts associated with an user. +- **authme.command.admin.changemail** – Administrator command to set or change the email adress of an user. +- **authme.command.admin.changepassword** – Administrator command to change the password of a user. +- **authme.command.admin.converter** – Administrator command to convert old or other data to AuthMe data. +- **authme.command.admin.firstspawn** – Administrator command to teleport to the first AuthMe spawn. +- **authme.command.admin.forcelogin** – Administrator command to force-login an existing user. +- **authme.command.admin.getemail** – Administrator command to get the email address of an user, if set. +- **authme.command.admin.getip** – Administrator command to get the last known IP of an user. +- **authme.command.admin.lastlogin** – Administrator command to see the last login date and time of an user. +- **authme.command.admin.purge** – Administrator command to purge old user data. +- **authme.command.admin.purgebannedplayers** – Administrator command to purge all data associated with banned players. +- **authme.command.admin.purgelastpos** – Administrator command to purge the last position of an user. +- **authme.command.admin.register** – Administrator command to register a new user. +- **authme.command.admin.reload** – Administrator command to reload the plugin configuration. +- **authme.command.admin.setfirstspawn** – Administrator command to set the first AuthMe spawn. +- **authme.command.admin.setspawn** – Administrator command to set the AuthMe spawn. +- **authme.command.admin.spawn** – Administrator command to teleport to the AuthMe spawn. +- **authme.command.admin.switchantibot** – Administrator command to toggle the AntiBot protection status. +- **authme.command.admin.unregister** – Administrator command to unregister an existing user. +- **authme.command.player.allow2accounts** – Permission for users to allow two accounts. +- **authme.command.player.bypassforcesurvival** – Permission for users to bypass force-survival mode. +- **authme.command.player.captcha** – Command permission to use captcha. +- **authme.command.player.changepassword** – Command permission to change the password. +- **authme.command.player.email.add** – Command permission to add an email address. +- **authme.command.player.email.change** – Command permission to change the email address. +- **authme.command.player.email.recover** – Command permission to recover an account using it's email address. +- **authme.command.player.login** – Command permission to login. +- **authme.command.player.logout** – Command permission to logout. +- **authme.command.player.register** – Command permission to register. +- **authme.command.player.seeotheraccounts** – Permission for user to see other accounts. +- **authme.command.player.unregister** – Command permission to unregister. +- **authme.player.bypassantibot** – Permission node to bypass AntiBot protection. +- **authme.player.canbeforced** – Permission for users a login can be forced to. +- **authme.player.vip** – Permission node to identify VIP users. + diff --git a/src/tools/permissionstree/PermissionNodesGatherer.java b/src/tools/permissions/PermissionNodesGatherer.java similarity index 99% rename from src/tools/permissionstree/PermissionNodesGatherer.java rename to src/tools/permissions/PermissionNodesGatherer.java index 5da8841c9..5b61adbef 100644 --- a/src/tools/permissionstree/PermissionNodesGatherer.java +++ b/src/tools/permissions/PermissionNodesGatherer.java @@ -1,4 +1,4 @@ -package permissionstree; +package permissions; import fr.xephi.authme.permission.AdminPermission; import fr.xephi.authme.permission.PermissionNode; diff --git a/src/tools/permissions/PermissionsListWriter.java b/src/tools/permissions/PermissionsListWriter.java new file mode 100644 index 000000000..7d361b1c5 --- /dev/null +++ b/src/tools/permissions/PermissionsListWriter.java @@ -0,0 +1,86 @@ +package permissions; + +import utils.ANewMap; +import utils.GeneratedFileWriter; +import utils.TagReplacer; +import utils.ToolsConstants; + +import java.util.Map; +import java.util.Scanner; +import java.util.Set; + +/** + * Class responsible for formatting a permissions node list and + * for writing it to a file if desired. + */ +public class PermissionsListWriter { + + private static final String PERMISSIONS_OUTPUT_FILE = ToolsConstants.DOCS_FOLDER + "permission_nodes.md"; + + public static void main(String[] args) { + // Ask if result should be written to file + Scanner scanner = new Scanner(System.in); + System.out.println("Include description? [Enter 'n' for no]"); + boolean includeDescription = !matches("n", scanner); + + if (!includeDescription) { + outputSimpleList(); + return; + } + + System.out.println("Write to file? [Enter 'n' for console output]"); + boolean writeToFile = !matches("n", scanner); + scanner.close(); + + + if (writeToFile) { + generateAndWriteFile(); + } else { + System.out.println(generatePermissionsList()); + } + } + + + private static void generateAndWriteFile() { + final String permissionsTagValue = generatePermissionsList(); + + Map tags = ANewMap.with("permissions", permissionsTagValue).build(); + GeneratedFileWriter.generateFileFromTemplate( + ToolsConstants.TOOLS_SOURCE_ROOT + "permissions/permission_nodes.tpl.md", PERMISSIONS_OUTPUT_FILE, tags); + System.out.println("Wrote to '" + PERMISSIONS_OUTPUT_FILE + "'"); + System.out.println("Before committing, please verify the output!"); + } + + private static String generatePermissionsList() { + PermissionNodesGatherer gatherer = new PermissionNodesGatherer(); + Map permissions = gatherer.gatherNodesWithJavaDoc(); + + final String template = GeneratedFileWriter.readFromToolsFile("permissions/permission_node_entry.tpl.md"); + StringBuilder sb = new StringBuilder(); + + for (Map.Entry entry : permissions.entrySet()) { + Map tags = ANewMap. + with("node", entry.getKey()) + .and("description", entry.getValue()) + .build(); + sb.append(TagReplacer.applyReplacements(template, tags)); + } + return sb.toString(); + } + + private static void outputSimpleList() { + PermissionNodesGatherer gatherer = new PermissionNodesGatherer(); + Set nodes = gatherer.gatherNodes(); + for (String node : nodes) { + System.out.println(node); + } + System.out.println(); + System.out.println("Total: " + nodes.size()); + } + + private static boolean matches(String answer, Scanner sc) { + String userInput = sc.nextLine(); + return answer.equalsIgnoreCase(userInput); + } + +} diff --git a/src/tools/permissions/README.md b/src/tools/permissions/README.md new file mode 100644 index 000000000..9603cd386 --- /dev/null +++ b/src/tools/permissions/README.md @@ -0,0 +1,2 @@ +# About +Helper script to generate a page with an up-to-date list of permission nodes. diff --git a/src/tools/permissions/permission_node_entry.tpl.md b/src/tools/permissions/permission_node_entry.tpl.md new file mode 100644 index 000000000..ab7f06872 --- /dev/null +++ b/src/tools/permissions/permission_node_entry.tpl.md @@ -0,0 +1 @@ +- **{node}** – {description} diff --git a/src/tools/permissions/permission_nodes.tpl.md b/src/tools/permissions/permission_nodes.tpl.md new file mode 100644 index 000000000..641d28dfa --- /dev/null +++ b/src/tools/permissions/permission_nodes.tpl.md @@ -0,0 +1,7 @@ + + + +## AuthMe Permission Nodes +The following are the permission nodes that are currently supported by the latest dev builds. + +{permissions} diff --git a/src/tools/permissionstree/PermissionsListWriter.java b/src/tools/permissionstree/PermissionsListWriter.java deleted file mode 100644 index 7d1cd1c26..000000000 --- a/src/tools/permissionstree/PermissionsListWriter.java +++ /dev/null @@ -1,62 +0,0 @@ -package permissionstree; - -import fr.xephi.authme.util.StringUtils; -import utils.CommentType; -import utils.GeneratedFileWriter; - -import java.util.Map; -import java.util.Scanner; -import java.util.Set; - -/** - * Class responsible for formatting a permissions node list and - * for writing it to a file if desired. - */ -public class PermissionsListWriter { - - private static final String PERMISSIONS_TREE_FILE = "gen_permtree.txt"; - - public static void main(String[] args) { - // Ask if result should be written to file - Scanner scanner = new Scanner(System.in); - System.out.println("Include description? [Enter 'n' for no]"); - boolean includeDescription = !matches("n", scanner); - - System.out.println("Write to file? [Enter 'y' for yes]"); - boolean writeToFile = matches("y", scanner); - scanner.close(); - - // Generate connections and output or write - String output = generatedOutput(includeDescription); - - if (writeToFile) { - GeneratedFileWriter.createGeneratedFile(PERMISSIONS_TREE_FILE, output, CommentType.YML); - } else { - System.out.println(output); - } - } - - private static String generatedOutput(boolean includeDescription) { - PermissionNodesGatherer creater = new PermissionNodesGatherer(); - if (!includeDescription) { - Set nodes = creater.gatherNodes(); - return StringUtils.join("\n", nodes); - } - - Map permissions = creater.gatherNodesWithJavaDoc(); - StringBuilder sb = new StringBuilder(); - for (Map.Entry entry : permissions.entrySet()) { - sb.append(entry.getKey()) - .append(": ") - .append(entry.getValue()) - .append("\n"); - } - return sb.toString(); - } - - private static boolean matches(String answer, Scanner sc) { - String userInput = sc.nextLine(); - return answer.equalsIgnoreCase(userInput); - } - -} diff --git a/src/tools/permissionstree/README.md b/src/tools/permissionstree/README.md deleted file mode 100644 index 5364c8469..000000000 --- a/src/tools/permissionstree/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# About -Helper script to generate a list of all permission nodes. diff --git a/src/tools/utils/ANewMap.java b/src/tools/utils/ANewMap.java new file mode 100644 index 000000000..de37bd746 --- /dev/null +++ b/src/tools/utils/ANewMap.java @@ -0,0 +1,36 @@ +package utils; + +import java.util.HashMap; +import java.util.Map; + +/** + * A map builder for the lazy. + *

+ * Sample usage: + * + * Map<String, Integer> map = ANewMap + * .with("test", 123) + * .and("text", 938) + * .and("abc", 456) + * .build(); + * + */ +public class ANewMap { + + private Map map = new HashMap<>(); + + public static ANewMap with(K key, V value) { + ANewMap instance = new ANewMap<>(); + return instance.and(key, value); + } + + public ANewMap and(K key, V value) { + map.put(key, value); + return this; + } + + public Map build() { + return map; + } + +} diff --git a/src/tools/utils/CommentType.java b/src/tools/utils/CommentType.java deleted file mode 100644 index fbc4c9b89..000000000 --- a/src/tools/utils/CommentType.java +++ /dev/null @@ -1,11 +0,0 @@ -package utils; - -/** - * Enum for different comment formats. - */ -public enum CommentType { - - JAVA, - YML - -} diff --git a/src/tools/utils/GeneratedFileWriter.java b/src/tools/utils/GeneratedFileWriter.java index 07f87c43d..06cbcaf3d 100644 --- a/src/tools/utils/GeneratedFileWriter.java +++ b/src/tools/utils/GeneratedFileWriter.java @@ -1,61 +1,47 @@ package utils; -import java.io.File; -import java.io.FileOutputStream; import java.io.IOException; -import java.io.OutputStreamWriter; -import java.util.Date; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Map; /** * Utility class for writing a generated file with a timestamp. */ public final class GeneratedFileWriter { + private final static Charset CHARSET = Charset.forName("utf-8"); + private GeneratedFileWriter() { } - public static void createGeneratedFile(File file, String contents, CommentType commentFormat) { - validateFile(file); + public static void generateFileFromTemplate(String templateFile, String destinationFile, Map tags) { + String template = readFromFile(templateFile); + String result = TagReplacer.applyReplacements(template, tags); - try (OutputStreamWriter osw = new OutputStreamWriter(new FileOutputStream(file))) { - osw.write(generateComment(commentFormat)); - osw.write(contents); + writeToFile(destinationFile, result); + } + + private static void writeToFile(String outputFile, String contents) { + try { + Files.write(Paths.get(outputFile), contents.getBytes()); } catch (IOException e) { - throw new RuntimeException("Could not write to file '" + file.getName() + "'", e); + throw new RuntimeException("Failed to write to file '" + outputFile + "'", e); } } - public static void createGeneratedFile(String fileName, String contents, CommentType commentFormat) { - createGeneratedFile(new File(fileName), contents, commentFormat); - } - - private static String generateComment(CommentType commentFormat) { - String comment = "Auto-generated file, generated on " + new Date() + "\n\n"; - switch (commentFormat) { - case JAVA: - return "// " + comment; - case YML: - return "# " + comment; - default: - throw new RuntimeException("Unknown comment format '" + commentFormat + "'"); + public static String readFromFile(String file) { + try { + return new String(Files.readAllBytes(Paths.get(file)), CHARSET); + } catch (IOException e) { + throw new RuntimeException("Could not read from file '" + file + "'", e); } } - private static void validateFile(File file) { - if (!file.exists()) { - System.out.println("File '" + file.getName() + "' doesn't exist; attempting to create it"); - try { - boolean success = file.createNewFile(); - if (!success) { - throw new RuntimeException("Failed to create file '" + file.getName() + "'"); - } - } catch (IOException e) { - throw new RuntimeException("Could not create file '" + file.getName() + "'", e); - } - } - if (!file.canWrite()) { - throw new RuntimeException("File '" + file.getName() + "' is not writable"); - } + public static String readFromToolsFile(String file) { + return readFromFile(ToolsConstants.TOOLS_SOURCE_ROOT + file); } + } diff --git a/src/tools/utils/TagReplacer.java b/src/tools/utils/TagReplacer.java new file mode 100644 index 000000000..404857b7f --- /dev/null +++ b/src/tools/utils/TagReplacer.java @@ -0,0 +1,46 @@ +package utils; + +import java.util.Date; +import java.util.Map; + +/** + * Class responsible for replacing template tags to actual content. + * For all files, the following tags are defined: + *

    + *
  • {gen_date} – the generation date
    • + *
  • {gen_warning} - warning not to edit the generated file directly
    • + *
+ */ +public class TagReplacer { + + /** + * Replace a template with default tags and custom ones supplied by a map. + * + * @param template The template to process + * @param tags Map with additional tags, e.g. a map entry with key "foo" and value "bar" will replace + * any occurrences of "{foo}" to "bar". + * @return The filled template + */ + public static String applyReplacements(String template, Map tags) { + String result = template; + for (Map.Entry tagRule : tags.entrySet()) { + result = result.replace("{" + tagRule.getKey() + "}", tagRule.getValue().toString()); + } + + return applyReplacements(result); + } + + /** + * Apply the default tag replacements. + * + * @param template The template to process + * @return The filled template + */ + public static String applyReplacements(String template) { + return template + .replace("{gen_date}", new Date().toString()) + .replace("{gen_warning}", "AUTO-GENERATED FILE! Do not edit this directly"); + } + + +} diff --git a/src/tools/utils/ToolsConstants.java b/src/tools/utils/ToolsConstants.java new file mode 100644 index 000000000..30cb0f413 --- /dev/null +++ b/src/tools/utils/ToolsConstants.java @@ -0,0 +1,17 @@ +package utils; + +/** + * Constants for the src/tools folder. + */ +public final class ToolsConstants { + + private ToolsConstants() { + } + + public static final String MAIN_SOURCE_ROOT = "src/main/java/"; + + public static final String TOOLS_SOURCE_ROOT = "src/tools/"; + + public static final String DOCS_FOLDER = TOOLS_SOURCE_ROOT + "docs/"; + +}