lightcontainer/FileFrontEnd
2
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Regex : Client to FileFrontEnd

Browse Source
This commit is contained in:
Maximilien LEDOUX 2022-02-22 09:30:33 +01:00
parent 09b90e6067
commit 56d3468df8
3 changed files with 63 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
app/src/main/java/lightcontainer/protocol/Protocol.java
View File

@ -7,15 +7,14 @@ import java.util.regex.Pattern;
/** /**
* Protocol * Protocol
* * <p>
* Class allowing to define new rules for the LightContainer protocol, * Class allowing to define new rules for the LightContainer protocol,
* also provides utility functions to work with regexes and the command to compare. * also provides utility functions to work with regexes and the command to compare.
* *
* @version 1.0 * @author Jérémi NIHART <j.nihart@student.helmo.be>
* @since 1.0 * @version 1.0
* * @see Pattern
* @see Pattern * @since 1.0
* @author Jérémi NIHART <j.nihart@student.helmo.be>
*/ */
public abstract class Protocol { public abstract class Protocol {
// Variables // Variables
@ -25,9 +24,10 @@ public abstract class Protocol {
/** /**
* Protocol constructor * Protocol constructor
* @param rule Command (e.g: LOGIN). *
* @param regex Regex to compile and use for this command (e.g: LOGIN ([A-Z0-9a-z]{1,20})). * @param rule Command (e.g: LOGIN).
* Do not forget to define the groups in the regex. * @param regex Regex to compile and use for this command (e.g: LOGIN ([A-Z0-9a-z]{1,20})).
* Do not forget to define the groups in the regex.
*/ */
protected Protocol(String rule, String regex) { protected Protocol(String rule, String regex) {
this.rule = rule; this.rule = rule;
@ -37,9 +37,8 @@ public abstract class Protocol {
/** /**
* Retrieve, the name of the Rule. * Retrieve, the name of the Rule.
* *
* @return Name of this rule. * @return Name of this rule.
* * @since 1.0
* @since 1.0
*/ */
public String getRule() { public String getRule() {
return this.rule; return this.rule;
@ -48,17 +47,16 @@ public abstract class Protocol {
/** /**
* Check if a command matches the rule with the rule matcher. * Check if a command matches the rule with the rule matcher.
* *
* @return True : if the command match with the rule. * @param cmd Command to verify with the rule matcher.
* False though. * @return True : if the command match with the rule.
* @param cmd Command to verify with the rule matcher. * False though.
* * @since 1.0
* @since 1.0
*/ */
protected boolean matcherCheck(String cmd) { protected boolean matcherCheck(String cmd) {
Matcher ruleMatcher = this.rulePattern.matcher(cmd); Matcher ruleMatcher = this.rulePattern.matcher(cmd);
if (ruleMatcher.matches()) { if (ruleMatcher.matches()) {
this.groups = new ArrayList<>(); this.groups = new ArrayList<>();
for (int i=1; i <= ruleMatcher.groupCount(); i++) this.groups.add(ruleMatcher.group(i)); for (int i = 1; i <= ruleMatcher.groupCount(); i++) this.groups.add(ruleMatcher.group(i));
return true; return true;
} }
return false; return false;
@ -66,14 +64,12 @@ public abstract class Protocol {
/** /**
* Get a list of all the groups extracted from the previously matched command with {@link #matcherCheck(String)}. * Get a list of all the groups extracted from the previously matched command with {@link #matcherCheck(String)}.
* *
* <b>Requires to have run {@link #matcherCheck(String)}</b> * <b>Requires to have run {@link #matcherCheck(String)}</b>
* *
* @return String list containing all the groups extrapolated from the command. * @return String list containing all the groups extrapolated from the command.
* * @see Protocol#matcherCheck(String)
* @since 1.0 * @since 1.0
*
* @see Protocol#matcherCheck(String)
*/ */
protected List<String> matcherGetGroups() { protected List<String> matcherGetGroups() {
return this.groups; return this.groups;
@ -81,26 +77,23 @@ public abstract class Protocol {
/** /**
* Execute the rule on a command. * Execute the rule on a command.
* * <p>
* This function allows you to check a command and process those groups (parameters) * This function allows you to check a command and process those groups (parameters)
* use the utility functions of {@link Protocol} to facilitate processing, see @see. * use the utility functions of {@link Protocol} to facilitate processing, see @see.
* *
* @param cmd Command on which to execute the rule. * @param cmd Command on which to execute the rule.
* * @see Protocol#execute(String)
* @since 1.0 * @see #matcherCheck(String)
* * @see #matcherGetGroups()
* @see Protocol#execute(String) * @since 1.0
* @see #matcherCheck(String)
* @see #matcherGetGroups()
*/ */
public abstract void execute(String cmd); public abstract void execute(String cmd);
/** /**
* Retrieve, the hashcode of the rule. * Retrieve, the hashcode of the rule.
* *
* @return Rule hashcode. * @return Rule hashcode.
* * @since 1.0
* @since 1.0
*/ */
@Override @Override
public int hashCode() { public int hashCode() {
@ -110,10 +103,9 @@ public abstract class Protocol {
/** /**
* Compare the equality of two rules. * Compare the equality of two rules.
* *
* @return True : if the rules are equals * @return True : if the rules are equals
* False if not. * False if not.
* * @since 1.0
* @since 1.0
*/ */
@Override @Override
public boolean equals(final Object obj) { public boolean equals(final Object obj) {

16
app/src/main/java/lightcontainer/protocol/SbeHello.java Normal file
View File

@ -0,0 +1,16 @@
package lightcontainer.protocol;
public class SbeHello extends Protocol {
protected SbeHello() {
super("HELLO", "^(HELLO)\\s([A-Za-z0-9.]{5,20})\\s((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([0-5][0-9]{4})|([0-9]{1,4}))\\r\\n$");
}
@Override
public void execute(String cmd) {
if (matcherCheck(cmd)) {
}
}
}

18
app/src/main/resources/rules.txt
View File

@ -21,9 +21,23 @@ login = [A-Za-z0-9]{2,20}
sbe_hello = ^(HELLO)\s([A-Za-z0-9.]{5,20})\s((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([0-5][0-9]{4})|([0-9]{1,4}))\r\n$ //TODO \r\n -> à tester pour voir si déjà dans le flux ou doit être construit sbe_hello = ^(HELLO)\s([A-Za-z0-9.]{5,20})\s((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([0-5][0-9]{4})|([0-9]{1,4}))\r\n$ //TODO \r\n -> à tester pour voir si déjà dans le flux ou doit être construit
//FileFrontEnd to StorBackEnd //FileFrontEnd to StorBackEnd
ffe_sendfile = ^(SENDFILE)\s([A-Za-z0-9.]{50,200}\s[0-9]{1,10}\s[A-Za-z0-9.]{50,200})\r\n(.*)$ ffe_sendfile = ^(SENDFILE)\s([A-Za-z0-9.]{50,200}\s[0-9]{1,10}\s[A-Za-z0-9.]{50,200})\r\n$
sbe_sendresult = ^(SEND_OK|SEND_ERROR)\r\n$ sbe_sendresult = ^(SEND_OK|SEND_ERROR)\r\n$
ffe_erasefile = ^(ERASEFILE)\s([A-Za-z0-9.]{50,200})\r\n$ ffe_erasefile = ^(ERASEFILE)\s([A-Za-z0-9.]{50,200})\r\n$
sbe_eraseresult = ^(ERASE_OK|ERASE_ERROR)\r\n$ sbe_eraseresult = ^(ERASE_OK|ERASE_ERROR)\r\n$
ffe_retrievefile = ^(RETRIEVEFILE)\s([A-Za-z0-9.]{50,200})\r\n$ ffe_retrievefile = ^(RETRIEVEFILE)\s([A-Za-z0-9.]{50,200})\r\n$
sbe_retrieveresult = ^(RETRIEVE_OK)\s([A-Za-z0-9.]{50,200}\s[0-9]{1,10}\s[A-Za-z0-9.]{50,200})\r\n(.*)|(RETRIEVE_ERROR)$ sbe_retrieveresult = ^((RETRIEVE_OK)\s([A-Za-z0-9.]{50,200}\s[0-9]{1,10}\s[A-Za-z0-9.]{50,200})\r\n)|((RETRIEVE_ERROR)\r\n)$
//Client to FileFrontEnd
client_signin = ^(SIGNIN)\s([A-Za-z0-9]{2,20})\s([^\s!]{5,50})\r\n$
client_signup = ^(SIGNUP)\s([A-Za-z0-9]{2,20})\s([^\s!]{5,50})\r\n$
ffe_signresult = ^(SIGN_OK|SIGN_ERROR)\r\n$
client_filelist = ^(FILELIST)\r\n$
ffe_filelistresult = ^(FILES)\s(([^\s!]{1,20}![0-9]{1,10}){0,50})\r\n$
client_savefile = ^(SAVE_FILE)\s([^\s!]{1,20})\s([0-9]{1,10})\r\n$
ffe_savefileresult = ^(SAVEFILE_OK|SAVEFILE_ERROR)\r\n$
client_getfile = ^(GETFILE)\s([^\s!]{1,20})\r\n$
ffe_getfileresult = ^((GETFILE_OK)\s(^\s!]{1,20})\s([0-9]{1,10})\r\n)|((GETFILE_ERROR)\r\n)$
client_removefile = ^(REMOVEFILE)\s([^\s!]{1,20})\r\n$
ffe_removefileresult = ^(REMOVEFILE_OK|REMOVEFILE_ERROR)\r\n$
client_signout = ^(SIGNOUT)\r\n$