diff --git a/src/main/java/projekt/enigma/database/DatenbankSqlite.java b/src/main/java/projekt/enigma/database/DatenbankSqlite.java index 21a20a22c96642c0d7b9dd2e89b1e4efc1c16dec..464558fba275d4b8375cc196115b78f81f2529bd 100644 --- a/src/main/java/projekt/enigma/database/DatenbankSqlite.java +++ b/src/main/java/projekt/enigma/database/DatenbankSqlite.java @@ -3,25 +3,24 @@ package projekt.enigma.database; import java.sql.*; /** - * Dies ist die SQLite Datenbank Klasse - * In der SQLite Datei im Resources Ordner liegt das Codebuch welches benötigt wird um die - * Nachrichten mit der Enigma zu ver/entschlüsseln. + * Dies ist die SQLite Datenbank Klasse. + * In der SQLite Datei im Resources Ordner liegt das Codebuch welches benoetigt wird um die + * Nachrichten mit der Enigma zu ver/entschluesseln. * Die Datenbank ist statisch und deshalb konnte sie im Resources Ordner hinterlegt werden. - * Für jeden Tag des Monats (1-31) ist ein eigener Eintrag enthalten welcher über die Funktion + * Für jeden Tag des Monats (1-31) ist ein eigener Eintrag enthalten welcher ueber die Funktion * getCodebuch abgerufen werden kann. - * Zurückgegeben wird ein Array welcher in der getCodebuch Funktion genauer dokumentiert ist. + * Zurueckgegeben wird ein Array welcher in der getCodebuch Funktion genauer dokumentiert ist. */ public class DatenbankSqlite { /** * Verbindung zur SQLite Datenbank aufbauen. - * Die Datei liegt in den Resources und ändert sich nicht, + * Die Datei liegt in den Resources und aendert sich nicht, * weshalb der Pfad zu derselben fest hinterlegt ist. * - * @return conn : Connection + * @return conn : Connection: statische Datenbankverbindung. */ private Connection connect() { - String url = "jdbc:sqlite::resource:projekt/enigma/codebuch.sqlite"; Connection conn = null; @@ -35,15 +34,15 @@ public class DatenbankSqlite { } /** - * Liest das Codebuch aus der SQLite Datenbank aus - * Dieser Funktion muss ein tag als int Wert übergeben werden. - * Anschließend wir eine Verbindung zur SQLite Datenbank aufgebaut und das Codebuch angefragt. - * Dieses wird in ein Object vom Type Codebuch gepackt und zurück gegeben. + * Liest das Codebuch aus der SQLite Datenbank aus. + * Dieser Funktion muss ein tag als int Wert uebergeben werden. + * Anschließend wird eine Verbindung zur SQLite Datenbank aufgebaut und das Codebuch angefragt. + * Dieses wird in ein Objekt vom Typ Codebuch gepackt und zurueckgegeben. * - * Hole den heutigen Eintrag aus der SQLite Datenbank und erstelle daraus ein Codebuch Objekt + * Holt den heutigen Eintrag aus der SQLite Datenbank und erstellt daraus ein Codebuch Objekt. * - * @param tag : int : Tag für welchen ein Codebuch benötigt wird. - * @return String : Die Einstellungen des angefragten Tages + * @param tag : int : Tag fuer welchen ein Codebuch benoetigt wird. + * @return String : Die Einstellungen des angefragten Tages. * <p> * String[0] : Tag * String[1] : Walzenlage @@ -52,12 +51,11 @@ public class DatenbankSqlite { * </p> */ public String[] getCodebuch(int tag) { - String[] codebuch = new String[4]; try { Connection conn = this.connect(); - PreparedStatement pstm = conn.prepareStatement("SELECT * FROM table_codebuch WHERE Tag=? LIMIT 1"); + PreparedStatement pstm = conn.prepareStatement("SELECT * FROM table_codebuch WHERE Tag = ? LIMIT 1"); pstm.setInt(1, tag); ResultSet rs = pstm.executeQuery(); @@ -67,8 +65,7 @@ public class DatenbankSqlite { codebuch[2] = rs.getString("Ringstellung"); codebuch[3] = rs.getString("Steckverbindung"); } - } catch (SQLException ignored) { - } + } catch (SQLException ignored) {} return codebuch; } diff --git a/src/main/java/projekt/enigma/model/Codebuch.java b/src/main/java/projekt/enigma/model/Codebuch.java index b710a0a6ec7e524cbfc9df59adec6f1ea2eb1dfd..c3331216dfb4c711047f6dd005184b0ffb207d78 100644 --- a/src/main/java/projekt/enigma/model/Codebuch.java +++ b/src/main/java/projekt/enigma/model/Codebuch.java @@ -6,41 +6,41 @@ import java.time.LocalDate; import java.time.ZoneId; /** - * Das Codebuch war eines der essentiel wichtigen Sachen bei der Enigma. + * Das Codebuch war eines der essentiell wichtigen Sachen bei der Enigma. * Jeder Enigma gehoerte auch ein Codebuch bei, welches notwendig war um die Nachrichten zu ver/entschluesseln. * Im Codebuch standen für jeden Tag des Monats die notwendigen Einstellungen welche vorgenommen werden - * mussten um die Texte zu ver/entschluesseln. + * mussten, um die Texte zu ver/entschluesseln. * Hiernach wurden die Walzen eingesetzt, die Ringe für den Ruecksprung der Walze gesetzt und deren Grundeinstellung * vorgenommen. - * Bei der Enigma um welche es hier geht (Enigma I) gab es zusaetzlich ein Steckbrett, welches ebenfalls im Codebuch + * Bei der Enigma I, um welche es hier geht, gab es zusaetzlich ein Steckbrett, welches ebenfalls im Codebuch * festgelegt war. * <p> - * Dieses Codebuch Objekt enthaelt die Einstellungen eines Tages, welche mittels Getter und Setter + * Dieses Codebuch enthaelt die Einstellungen eines Tages, welche mittels Getter und Setter * verarbeitet werden koennen. * <p> - * Zusaetzlich gibt es zu Debug Zwecken eine ueberschriebene toString Funktion welche das Objekt als String zurueck - * geben kann. + * Zusaetzlich gibt es zu Debug-Zwecken eine ueberschriebene toString Funktion, welche das Objekt als String + * zurueckgeben kann. */ public class Codebuch { //region Variablen /** - * tag : int : gibt den Tag eines Monats an + * tag : int : gibt den Tag eines Monats an. */ private int tag; /** - * walzenlage : int[] : legt die Positionen der drei Walzen fest + * walzenlage : int[] : legt die Positionen der drei Walzen fest. */ private int[] walzenlage; /** - * ringstellung : int[] : legt die Ringstellungen der drei Walzen fest + * ringstellung : int[] : legt die Ringstellungen der drei Walzen fest. */ private int[] ringstellung; /** - * steckverbindung : char[][] : stellt die Steckverbindungen im Steckbrett dar + * steckverbindung : char[][] : legt die Steckverbindungen im Steckbrett fest. */ private char[][] steckverbindung; @@ -48,12 +48,12 @@ public class Codebuch { //region Konstruktor /** - * Im Konstruktor werden die Standardwerte gesetzt + * Im Konstruktor werden die Standardwerte gesetzt. * <p> * walzenlage : int[3] : Hier wird die Position der drei Walzen festgelegt. - * ringstellung : char[3] : Jede Walze hat einen Ring. Der Index steht für die Walze und der Value für - * die Position des Ringes. - * steckverbindung : char[10][] : Zehn Kabel können in das Steckbrett gesteckt werden. In diesem Array werden + * ringstellung : char[3] : Jede Walze hat einen Ring. Der Index steht fuer die Walze und der Value fuer + * die Position des Ringes. + * steckverbindung : char[10][] : Zehn Kabel koennen in das Steckbrett gesteckt werden. In diesem Array werden * die Kabel mit ihren jeweiligen Buchsen hinterlegt. */ public Codebuch() { @@ -76,7 +76,7 @@ public class Codebuch { * Aus dem Tagesschluessel werden die Werte fuer die Walzenlage, Ringstellung und Steckverbindung * gesetzt. * - * @param tag : int[] : gibt keinen, einen Tag oder mehrere Tage mit + * @param tag : int[] : gibt keinen, einen Tag oder mehrere Tage mit. */ public void fetchTagesschluessel(int... tag) { String[] walzenlage, ringstellung, db; @@ -105,9 +105,9 @@ public class Codebuch { /** * Gibt die aktuelle Instanz des Codebuches als String zurueck. - * Hierbei werden der Tag die Walzenlagen, Ring-/Grundstellung sowie die Steckverbindungen zurueck gegeben. + * Hierbei werden der Tag die Walzenlagen, Ring-/Grundstellung sowie die Steckverbindungen zurueckgegeben. * - * @return String : String des gesamten Objektes + * @return String : String des gesamten Objektes. */ @Override public String toString() { @@ -153,7 +153,7 @@ public class Codebuch { //region Setter /** - * Setzt die Steckverbindung dieser Instanz + * Setzt die Steckverbindung dieser Instanz. * * @param kabel : String[] : Die Steckverbindungen die gesteckt werden sollen. * Jeder Eintrag im Array ist ein String mit zwei Zeichen. @@ -171,17 +171,17 @@ public class Codebuch { } /** - * Setzt die Walzenlage dieser Instanz + * Setzt die Walzenlage dieser Instanz. * - * @param position : int : Position der Walze - * @param walzenlage : int : Welche Walze wurde eingesetzt + * @param position : int : Position der Walze. + * @param walzenlage : int : Welche Walze wurde eingesetzt. */ private void setWalzenlage(int position, int walzenlage) { this.walzenlage[position] = walzenlage; } /** - * Setzt die Ringstellung dieser Instanz + * Setzt die Ringstellung dieser Instanz. * * @param position : int : Auf welche Walze wird der Ring aufgesetzt? * @param ringstellung : int : An dieser Position soll die nächste Walze weiter gedreht werden. @@ -191,9 +191,9 @@ public class Codebuch { } /** - * Setzt den Tag dieser Instanz + * Setzt den Tag dieser Instanz. * - * @param tag : int : Tag + * @param tag : int : Tag. */ void setTag(int tag) { this.tag = tag; @@ -203,36 +203,36 @@ public class Codebuch { //region Getter /** - * Gibt den Tag dieser Instanz zurueck + * Gibt den Tag dieser Instanz zurueck. * - * @return int : Tag + * @return int : Tag. */ public int getTag() { return tag; } /** - * Gibt die Walzenlage dieser Instanz zurueck + * Gibt die Walzenlage dieser Instanz zurueck. * - * @return walzenlage : int[] : Walzenlage + * @return walzenlage : int[] : Walzenlage. */ public int[] getWalzenlage() { return walzenlage; } /** - * Gibt die Ringstellung dieser Instanz zurueck + * Gibt die Ringstellung dieser Instanz zurueck. * - * @return ringstellung : int : Ringstellung + * @return ringstellung : int : Ringstellung. */ public int[] getRingstellung() { return ringstellung; } /** - * Gibt die Steckverbindungen dieser Instanz zurueck + * Gibt die Steckverbindungen dieser Instanz zurueck. * - * @return steckerverbindung : char[][] : Steckverbindung + * @return steckerverbindung : char[][] : Steckverbindung. */ public char[][] getSteckverbindung() { return this.steckverbindung; diff --git a/src/main/java/projekt/enigma/model/Codierer.java b/src/main/java/projekt/enigma/model/Codierer.java index 19211116ce17de7f8f90cc31a03b42c69a02cd5b..28907b55f1975bb9aeaf4e171ad45c51c2bf4bcf 100644 --- a/src/main/java/projekt/enigma/model/Codierer.java +++ b/src/main/java/projekt/enigma/model/Codierer.java @@ -1,526 +1,516 @@ package projekt.enigma.model; +import org.apache.http.HttpException; + import java.io.IOException; import java.util.Calendar; import java.util.Random; /** - * Die Codierer Klasse beschreibt den Benutzer welcher die Enigma benutzt. - * Alle Vorgänge wie z.B. das zusammenbauen der Hardware, auslesen des Codebuches und das anschließende codieren, - * finden hier statt. Dieser ist quasi die Schnittstelle zwischen der GUI (Hauptmann welcher ihm sagt was er zu - * verschlüsseln hat), der Enigma und dem Funker im Funkraum, welcher die Nachricht im Anschluß versendet. + * Die Codierer-Klasse beschreibt den Benutzer, welcher die Enigma benutzt. + * Alle Vorgaenge, wie z.B. das zusammenbauen der Hardware, auslesen des Codebuches und das anschließende codieren, + * finden hier statt. Dieser ist quasi die Schnittstelle zwischen der GUI (Hauptmann, welcher ihm sagt was er zu + * verschluesseln hat), der Enigma und dem Funker im Funkraum, welcher die Nachricht im Anschluss versendet. */ public class Codierer { - //region Variablen - /** - * Der Klartext Spruchschlüssel zur codierung der Nachricht - */ - private String spruchschluessel; - - /** - * Der Spruchschlüssel, mit den Tageswerten aus dem Codebuch, codiert - */ - private String spruchschluesselCodiert; - - /** - * Die Kenngruppe für die versendeten Nachrichten gedacht sind. Diese ist relevant für den Webservice (Funkraum) - */ - private String kenngruppe; - - /** - * Die Nachricht, welche der Benutzer eingibt, wird als String nachricht gespeichert - * und im laufe der Benutzung ergänzt - */ - private String nachricht; - - /** - * Das Hardware Objekt. Hier werden alle Hardware relevanten Baugruppen gespeichert und verarbeitet. - */ - private Hardware hardware; - - /** - * Im Codebuch sind die Tageswerte zu finden. Über dieses Objekt kann darauf zugegriffen werden. - */ - private Codebuch codebuch; - //endregion + //region Variablen + /** + * Der Spruchschluessel als Klartext zur Codierung der Nachricht. + */ + private String spruchschluessel; - //region Konstruktor + /** + * Der Spruchschluessel, mit den Tageswerten aus dem Codebuch, codiert. + */ + private String spruchschluesselCodiert; - /** - * Der Konstruktor des Codierers - * Hier werden die globalen Variablen auf ihre Standart Werte gesetzt sowie die Objekte Initialisiert. - */ - public Codierer(String kenngruppe) { + /** + * Die Kenngruppe fuer die die versendeten Nachrichten gedacht sind. + * Diese ist relevant fuer den Webservice (Funkraum). + */ + private String kenngruppe; - this.nachricht = ""; - this.spruchschluessel = ""; - this.spruchschluesselCodiert = ""; - this.kenngruppe = kenngruppe; + /** + * Die Nachricht, welche der Benutzer eingibt, wird als String "nachricht" gespeichert + * und im Laufe der Benutzung ergaenzt. + */ + private String nachricht; - this.codebuch = new Codebuch(); - this.codebuch.fetchTagesschluessel(); - } - //endregion + /** + * Das Hardware-Objekt. Hier werden alle hardwarerelevanten Baugruppen gespeichert und verarbeitet. + */ + private Hardware hardware; - //region Funktionen & Methoden - //region Reset & Initialisieren - - /** - * Hier lesen wir den heutigen Eintrag aus dem Codebuch aus und erstellen ein Codebuch Objekt - * Nach dem Codebuch werden dann die Ringe auf die Walzen gesteckt und die Walzen anschließend - * in die Hardware gebaut. - * <br> - * Ein Reflektor wird definiert, jedoch keine Werte zugewisen, da wir nur einen besitzen und - * deshalb alle Einstellungen hierfür Statisch im Reflektor definiert haben. - * <br> - * Das Steck wird ebenfalls definiert und die notwendigen Kabel eingesteckt laut dem heutigen - * Codebuch Eintrag. - */ - private void initialisiereHardware() { - - this.nachricht = ""; - - // Das Steckbrett initialisieren - Steckbrett sb = new Steckbrett(); - char[][] verbinder = this.codebuch.getSteckverbindung(); - - // Für jedes Kabel eine Verbindung auf dem Steckbrett setzen - for (char[] kabel : verbinder) { - sb.setzeVertauschung(kabel[0], kabel[1]); - } - - // Die Hardware aus dem Koffer holen (initialisieren) - this.hardware = new Hardware(); - - // Den Ring an der Walze anbringen und die Walze dann in die Hardware einsetzen - this.hardware.setWalzen(0, this.codebuch.getWalzenlage()[0], this.codebuch.getRingstellung()[0]); - this.hardware.setWalzen(1, this.codebuch.getWalzenlage()[1], this.codebuch.getRingstellung()[1]); - this.hardware.setWalzen(2, this.codebuch.getWalzenlage()[2], this.codebuch.getRingstellung()[2]); - - // Der Hardware das gesetzte Steckbrett zuweisen - this.hardware.setSteckbrett(sb); - - // Ein Reflektor Objekt erstellen und der Hardware bekannt geben - this.hardware.setReflektor(new Reflektor()); - } - - /** - * Setzt die Enigma auf die Einstellungen des aktuellen Tages, aus dem Codebuch zurück. - */ - public void resetHardware() { - this.initialisiereHardware(); - } - - /** - * Leer das Nachrichten Objekt um eine neue Nachricht aufnehmen zu können - */ - private void resetNachricht() { - this.nachricht = ""; - } - //endregion + /** + * Im Codebuch sind die Tageswerte zu finden. Ueber dieses Objekt kann darauf zugegriffen werden. + */ + private Codebuch codebuch; + //endregion - //region Nachrichten handler - - /** - * Befehl die Nachricht an den Funker zu übergeben - * - * @throws IOException : Die Antwort konnte nicht gelesen werden - */ - public void sendeNachricht() throws IOException { - String kopf = this.generateKopf(); - new Funkraum().sendeFunkspruch(new Morsecode().convertBuchstabeToMorsecode(kopf + this.nachricht), this.kenngruppe); - this.nachricht = ""; - this.resetHardware(); - } - - /** - * Gibt die letzte empfangene Nachricht zurück - * <br> - * String[0] Tag wann die Nachricht gesendet wurde - * String[1] = Die verschlüsselte Nachricht - * String[2] = Nachricht im Klartext - */ - public String[] empfangeNachricht() { - - // Alte Nachrichten Variable erstmal leeren - this.nachricht = ""; - // Morsecode Objekt initialisieren - Morsecode mc = new Morsecode(); - // Unser Nachrichten Array soll drei Einträge erhalten - String[] nachricht = new String[3]; - // Abrufen der letzten Nachricht, für unsere Kenngruppe, aus dem Funkraum - String[] codierteNachricht = new Funkraum().empfangeFunkspruch(this.kenngruppe); - - // Prüfen ob Nachrichtenlänge > 1 und die codierte Nachricht mehr als drei Felder (" ") hat - if (codierteNachricht[1] != null && codierteNachricht[1].split(" ").length > 3) { - // Den Tag der Nachricht speichern - nachricht[0] = codierteNachricht[0]; - // Die Nachricht von Morsecode in Buchstaben konvertieren - nachricht[1] = mc.convertMorsecodeToBuchstabe(codierteNachricht[1]); - // Die Enigma Nachricht (nachricht[1]) mittels der Tageseinstellungen (nachricht[0]) decodieren - nachricht[2] = this.decodiere(nachricht[1], Integer.parseInt(nachricht[0])); - // StringBuilder initialisieren - StringBuilder sb = new StringBuilder(); - - sb.append(nachricht[1], 0, 16); - for (int i = 17; i <= nachricht[1].length(); ) { - if ((i + 5) < nachricht[1].length()) { - sb.append(nachricht[1], i, i + 5).append(" "); - i += 5; - } else { - sb.append(nachricht[1].substring(i)); - break; - } - } - nachricht[1] = sb.toString(); - } - - return nachricht; - } - //endregion + //region Konstruktor - //region Generatoren - - /** - * Hier wird ein neuer Spruchschlüssel generiert. - * <p> - * Mit diesem werden die Walzen auf eine neue Startposition gestellt und dem Kopf, mit dem - * Tagesschlüssel codiert, hinzugefügt. - * <br> - * Hierfür wird mittels der Funktion "randomBuchstabe" ein zufälliger Buchstabe generiert, - * und geschaut ob dieser bereits in der globalen Variable (this.spruchschluessel) vorhanden ist. - * Wenn nicht, wird der Buchstabe dem Spruchschlüssel hinzugefügt. - * <br> - * Dies wir nun so lange gemacht bis der Spruchschlüssel eine länge von drei Zeichen hat. - */ - public void generateSpruchschluessel() { - - String klartext = ""; - - while (klartext.length() < 3) { - String temp = this.randomBuchstabe(); - if (!klartext.contains(temp)) { - klartext += temp; - } - } - - this.spruchschluessel = klartext; - this.spruchschluesselCodiert = this.codiere(klartext + klartext, false); - - // Walzen auf den Spruchschlüssel stellen - this.hardware.setzePosition(0, this.spruchschluessel.charAt(0)); - this.hardware.setzePosition(1, this.spruchschluessel.charAt(1)); - this.hardware.setzePosition(2, this.spruchschluessel.charAt(2)); - - // Die Kenngruppe codieren und in der Nachricht speichern - this.codiere(this.kenngruppe, true); - } - - /** - * Erstellen des Nachrichten Kopfes. - * Hierfür wird die aktuelle Uhrzeit ausgelesen, die Länge der Nachricht sowie der, mit den - * Tagescodes codierte, Spruchschlüssel. - */ - private String generateKopf() { - Calendar cal = Calendar.getInstance(); - - // Uhrzeit an den Kopf hängen - return String.format("%02d%02d", cal.get(Calendar.HOUR), cal.get(Calendar.MINUTE)) + " " + - // Zeichen Anzahl der Nachricht - this.nachricht.length() + " " + - // Spruchschlüssel anhängen - this.spruchschluesselCodiert.substring(0, 3) + " " + this.spruchschluesselCodiert.substring(3, 6) + " "; - } - - /** - * Einen zufälligen Buchstaben aus dem Alphabet generieren. - * In der Funktion gibt es den String Alphabet, in welchem alle zulässigen Zeichen eingetragen sind. - * Aus diesem String wird nun zufällig ein Zeichen ausgewählt und zurück gegeben. - * - * @return String : ein zufällig generierter Buchstabe - */ - private String randomBuchstabe() { - return String.valueOf((char) ('A' + new Random().nextInt(26))); - } - //endregion + /** + * Der Konstruktor des Codierers. + * Hier werden die globalen Variablen auf ihre Standardwerte gesetzt sowie die Objekte initialisiert. + */ + public Codierer(String kenngruppe) { + this.nachricht = ""; + this.spruchschluessel = ""; + this.spruchschluesselCodiert = ""; + this.kenngruppe = kenngruppe; + this.codebuch = new Codebuch(); + + this.codebuch.fetchTagesschluessel(); + } + //endregion - //region setzte Funktionen - - /** - * Setzt den Ring auf der Walze auf einen neuen Umstprungwert. - * - * @param walzenPosition : int : Walze auf die der Ring gesteckt wird - * @param umsprungPunkt : int : Buchstabe auf dem der Notch sitzt - */ - public void setzeRing(int walzenPosition, int umsprungPunkt) { - this.resetNachricht(); - this.hardware.setzeRing(walzenPosition, umsprungPunkt); - } - - /** - * Setzt die Walze (walzeNr) in die Position (walzenPosition) der Enigma ein. - * Mit (ringstellung) gibt man die Position des Umsprungpunktes an. - * - * @param walzenPosition : int : Position der Walze in der Enigma (1-2-3) - * @param walzeNr : int : Nummer der Walze die eingesetzt wird - * @param ringstellung : int : Stellung des Ringes - */ - public void setzeWalzeNr(int walzenPosition, int walzeNr, int ringstellung) { - this.resetNachricht(); - this.hardware.setzeWalzenNr(walzenPosition, walzeNr, ringstellung); - } - - /** - * Setzt das Kabel in beide Ports ein und fügt es dem Steckbrett Array hinzu. - * - * @param port : int : Kabel Nummer welches am Steckbrett eingesteckt wird - * @param verbindung : String : Verbindung welche die vertauschten Buchstaben angibt - * @return boolean : Wenn true, darf das Kabel gesteckt werden, wenn nicht, steckt da bereits schon eines - */ - public boolean setzeSteckbrett(int port, String verbindung) { - this.resetNachricht(); - return this.hardware.getSteckbrett().setzeVertauschung(port, verbindung.charAt(0), verbindung.charAt(1)); - } - - /** - * Setzt den anzuzeigenden Buchstaben (buchstabe) auf der Walze (walzenPosition) und resetet das - * Nachrichten Objekt - * - * @param walze : int : Nummer der Walze - * @param buchstabe : char : Buchstabe der zugewiesen soll - */ - public void setzeWalzenPosition(int walze, char buchstabe) { - this.resetNachricht(); - this.hardware.setzePosition(walze, buchstabe); - } - //endregion + //region Funktionen & Methoden + //region Reset & Initialisieren + + /** + * Hier lesen wir den heutigen Eintrag aus dem Codebuch aus und erstellen ein Codebuch-Objekt. + * Nach dem Codebuch werden dann die Ringe auf die Walzen gesteckt und die Walzen anschließend + * in die Hardware gebaut. + * <br> + * Ein Reflektor wird definiert, jedoch keine Werte zugewiesen, da wir nur einen besitzen und + * deshalb alle Einstellungen hierfuer statisch im Reflektor definiert haben. + * <br> + * Das Steckbrett wird ebenfalls definiert und die notwendigen Kabel eingesteckt nach dem heutigen + * Codebucheintrag. + */ + private void initialisiereHardware() { + this.nachricht = ""; + + // Das Steckbrett initialisieren + Steckbrett sb = new Steckbrett(); + char[][] verbinder = this.codebuch.getSteckverbindung(); + + // Für jedes Kabel eine Verbindung auf dem Steckbrett setzen + for (char[] kabel : verbinder) { + sb.setzeVertauschung(kabel[0], kabel[1]); + } + + // Die Hardware aus dem Koffer holen (initialisieren) + this.hardware = new Hardware(); + + // Den Ring an der Walze anbringen und die Walze dann in die Hardware einsetzen + this.hardware.setWalzen(0, this.codebuch.getWalzenlage()[0], this.codebuch.getRingstellung()[0]); + this.hardware.setWalzen(1, this.codebuch.getWalzenlage()[1], this.codebuch.getRingstellung()[1]); + this.hardware.setWalzen(2, this.codebuch.getWalzenlage()[2], this.codebuch.getRingstellung()[2]); + + // Der Hardware das gesetzte Steckbrett zuweisen + this.hardware.setSteckbrett(sb); + + // Ein Reflektor-Objekt erstellen und der Hardware bekanntgeben + this.hardware.setReflektor(new Reflektor()); + } + + /** + * Setzt die Enigma auf die Einstellungen des aktuellen Tages, aus dem Codebuch zurueck. + */ + public void resetHardware() { + this.initialisiereHardware(); + } + + /** + * Leert das Nachrichten-Objekt um eine neue Nachricht aufnehmen zu koennen. + */ + public void resetNachricht() { + this.nachricht = ""; + } + //endregion + + //region Nachrichten handler + + /** + * Befehl, die Nachricht an den Funker zu uebergeben. + * + * @throws IOException : Die Antwort konnte nicht gelesen werden. + * @throws HttpException : Die Nachricht konnte nicht abgesendet werden. + */ + public void sendeNachricht() throws IOException, HttpException { + String kopf = this.generateKopf(); + new Funkraum().sendeFunkspruch(new Morsecode().convertBuchstabeToMorsecode(kopf + this.nachricht), + this.kenngruppe); + this.nachricht = ""; + this.resetHardware(); + } + + /** + * Gibt die letzte empfangene Nachricht zurueck. + * <br> + * nachricht[0]: String[]: Tag, an dem die Nachricht gesendet wurde. + * nachricht[1]: String[]: Die verschluesselte Nachricht von Morsecode in Buchstaben konvertiert. + * nachricht[2]: String[]: Nachricht im Klartext. Die Enigma Nachricht (nachricht[1]) mittels der + * Tageseinstellungen (nachricht[0]) decodiert. + */ + public String[] empfangeNachricht() { + StringBuilder sb = new StringBuilder(); + Morsecode mc = new Morsecode(); + String[] nachricht = new String[3]; + + // Alte Nachrichten-Variable erstmal leeren + this.nachricht = ""; + + // Abrufen der letzten Nachricht, für unsere Kenngruppe, aus dem Funkraum + String[] codierteNachricht = new Funkraum().empfangeFunkspruch(this.kenngruppe); + + // Prüfen ob Nachrichtenlänge > 1 und die codierte Nachricht mehr als drei Felder (" ") hat + if ((codierteNachricht[1] != null) && (codierteNachricht[1].split(" ").length > 3)) { + nachricht[0] = codierteNachricht[0]; + nachricht[1] = mc.convertMorsecodeToBuchstabe(codierteNachricht[1]); + nachricht[2] = this.decodiere(nachricht[1], Integer.parseInt(nachricht[0])); + + sb.append(nachricht[1], 0, 16); + + for (int i = 17; i <= nachricht[1].length(); ) { + if ((i + 5) < nachricht[1].length()) { + sb.append(nachricht[1], i, i + 5).append(" "); + i += 5; + } else { + sb.append(nachricht[1].substring(i)); + break; + } + } + nachricht[1] = sb.toString(); + } + + return nachricht; + } + //endregion + + //region Generatoren + + /** + * Hier wird ein neuer Spruchschluessel generiert. + * <p> + * Mit diesem werden die Walzen auf eine neue Startposition gestellt und dem Kopf, mit dem + * Tagesschluessel codiert, hinzugefuegt. + * <br> + * Hierfuer wird mittels der Funktion "randomBuchstabe" ein zufaelliger Buchstabe generiert, + * und ueberprueft, ob dieser bereits in der globalen Variable (this.spruchschluessel) vorhanden ist. + * Wenn nicht, wird der Buchstabe dem Spruchschluessel hinzugefügt. + * <br> + * Dies wir nun so lange gemacht bis der Spruchschluessel eine Laenge von drei Zeichen hat. + * Die Walzen werden anhand des Spruchschluessels automatisch gestellt. + */ + public void generateSpruchschluessel() { + String klartext = ""; + + while (klartext.length() < 3) { + String temp = this.randomBuchstabe(); + if (!klartext.contains(temp)) { + klartext += temp; + } + } + + this.spruchschluessel = klartext; + this.spruchschluesselCodiert = this.codiere(klartext + klartext, false); + + // Walzen auf den Spruchschlüssel stellen + this.hardware.setzePosition(0, this.spruchschluessel.charAt(0)); + this.hardware.setzePosition(1, this.spruchschluessel.charAt(1)); + this.hardware.setzePosition(2, this.spruchschluessel.charAt(2)); + + // Die Kenngruppe codieren und in der Nachricht speichern + this.codiere(this.kenngruppe, true); + } + + /** + * Erstellen des Nachrichten-Kopfes. + * Hierfuer wird die aktuelle Uhrzeit ausgelesen, die Laenge der Nachricht, sowie der, mit dem + * Tagescode codierte, Spruchschluessel. + * + * @return String: Enthaelt die Uhrzeit, die Anzahl der Buchstaben der Nachricht und den Spruchschluessel. + */ + private String generateKopf() { + Calendar cal = Calendar.getInstance(); + + return String.format("%02d%02d", cal.get(Calendar.HOUR), cal.get(Calendar.MINUTE)) + " " + + this.nachricht.length() + " " + this.spruchschluesselCodiert.substring(0, 3) + " " + + this.spruchschluesselCodiert.substring(3, 6) + " "; + } + + /** + * Generiert einen zufaelligen Buchstaben aus dem Alphabet. + * In der Funktion gibt es den String "Alphabet", in welchem alle zulaessigen Zeichen eingetragen sind. + * Aus diesem String wird nun zufaellig ein Zeichen ausgewaehlt und zurueckgegeben. + * + * @return String : ein zufaellig generierter Buchstabe. + */ + private String randomBuchstabe() { + return String.valueOf((char) ('A' + new Random().nextInt(26))); + } + //endregion + + //region setze Funktionen + + /**TODO: Wird nicht benutzt + * Setzt den anzuzeigenden Buchstaben (buchstabe) auf der Walze (walzenPosition) und setzt anschliessend das + * Nachrichten-Objekt zurueck. + * + * @param walzenPosition : int : Nummer der Walze. + * @param buchstabe : char : Buchstabe der zugewiesen werden soll. + */ + public void setzeWalze(int walzenPosition, char buchstabe) { + this.resetNachricht(); + this.hardware.setzePosition(walzenPosition, buchstabe); + } + + /**TODO: Wird nicht benutzt + * Setzt den Ring auf der Walze auf einen neuen Umsprungwert. + * + * @param walzenPosition : int : Walze auf die der Ring gesteckt wird. + * @param umsprungPunkt : int : Umspringpunkt (Signal an linke Walze zum Drehen). + */ + public void setzeRing(int walzenPosition, int umsprungPunkt) { + this.hardware.setzeRing(walzenPosition, umsprungPunkt); + } + + /**TODO: Wird nicht benutzt + * Setzt die Walze (walzeNr) in die Position (walzenPosition) der Enigma ein. + * Mit Ringstellung(ringstellung) gibt man die Position des Umsprungpunktes an. + * + * @param walzenPosition : int : Position der Walze in der Enigma (1-2-3). + * @param walzeNr : int : Nummer der Walze die eingesetzt wird. + * @param ringstellung : int : Stellung des Ringes. + */ + public void setzeWalzeNr(int walzenPosition, int walzeNr, int ringstellung) { + this.hardware.setzeWalzenNr(walzenPosition, walzeNr, ringstellung); + } + + /**TODO: Wird nicht benutzt + * Setzt das Kabel in beide Ports ein und fuegt es dem Steckbrett-Array hinzu. + * + * @param port : int : Kabel Nummer, welches am Steckbrett eingesteckt wird. + * @param verbindung : String : Verbindung, welche die vertauschten Buchstaben angibt. + * @return boolean : Wenn true, darf das Kabel gesteckt werden, wenn false, steckt da bereits schon eines. + */ + public boolean setzeSteckbrett(int port, String verbindung) { + return this.hardware.getSteckbrett().setzeVertauschung(port, verbindung.charAt(0), verbindung.charAt(1)); + } + //endregion + + //region fetch Funktionen - //region fetch Funktionen - - /** - * Gibt die Ringstellungen aus dem Codebuch zurück - * - * @return int[] : Array mit den Ringstellungen der drei eingesetzten Walzen - */ - public int[] fetchRingstellung() { - return this.codebuch.getRingstellung(); - } - - /** - * Gibt die Walzennummer aus dem Codebuch zurück - * - * @return int[] : Array mit den Nummern der drei eingesetzten Walzen - */ - public int[] fetchWalzenNr() { - return this.codebuch.getWalzenlage(); - } - - /** - * Gibt die Steckverbindungen aus dem Codebuch zurück - * - * @return char[][] : Array mit den gesteckten Verbindungen im Steckbrett - */ - public char[][] fetchSteckverbindungen() { - return this.codebuch.getSteckverbindung(); - } - - /** - * Gibt die aktuellen Buchstaben auf den Walzen zurück - * - * @return char[] : Walzen Array mit der aktuellen Position - */ - public char[] fetchWalzen() { - char[] walzen = new char[3]; - walzen[0] = this.hardware.getWalzen()[0].getPosition(); - walzen[1] = this.hardware.getWalzen()[1].getPosition(); - walzen[2] = this.hardware.getWalzen()[2].getPosition(); - - return walzen; - } + /** + * Gibt die Ringstellungen aus dem Codebuch zurueck. + * + * @return int[] : Array mit den Ringstellungen der drei eingesetzten Walzen. + */ + public int[] fetchRingstellung() { + return this.codebuch.getRingstellung(); + } /** - * Gibt die Walzennummer einer Walze auf Position (walzePos) zurück + * Gibt die Walzennummer aus dem Codebuch zurueck. * - * @param walzePos : int : Position der Walze - * @return int : Nummer der eingesetzten Walze + * @return int[] : Array mit den Nummern der drei eingesetzten Walzen. */ + public int[] fetchWalzenNr() { + return this.codebuch.getWalzenlage(); + } + + /** + * Gibt die Steckverbindungen aus dem Codebuch zurueck. + * + * @return char[][] : Array mit den gesteckten Verbindungen im Steckbrett. + */ + public char[][] fetchSteckverbindungen() { + return this.codebuch.getSteckverbindung(); + } + + /** + * Gibt die aktuellen Buchstaben auf den Walzen zurueck. + * + * @return char[] : Walzen Array mit der aktuellen Positionen. + */ + public char[] fetchWalzen() { + char[] walzen = new char[3]; + walzen[0] = this.hardware.getWalzen()[0].getPosition(); + walzen[1] = this.hardware.getWalzen()[1].getPosition(); + walzen[2] = this.hardware.getWalzen()[2].getPosition(); + + return walzen; + } + + /** + * Ueberprueft welche Buchstaben noch zur Vertauschung verfuegbar sind. + * + * @param port: Zahl zwischen 0-9: entspricht der Kabelnummer. + * @return String: liefert einen String mit den verfuegbaren Buchstaben zurueck. + */ + public String fetchVerfuegbareBuchstaben(int port) { + return this.hardware.getSteckbrett().fetchVerfuegbareBuchstaben(port); + } + //endregion + /** Gibt die Walzennummer einer Walze auf Position (walzePos) zurück + * + * @param walzePos : int : Position der Walze + * @return int : Nummer der eingesetzten Walze + */ public int fetchWalzenNr(int walzePos) { return this.hardware.getWalzen()[walzePos].getWalzenNr(); } - - /** - * Ueberprueft welche Buchstaben noch zur Vertauschung verfügbar sind - * - * @param port: Zahl zwischen 0-9: entspricht der Kabelnummer. - * @return String: liefert einen String mit den verfuegbaren Buchstaben zurueck. - */ - public String fetchVerfuegbareBuchstaben(int port) { - return this.hardware.getSteckbrett().fetchVerfuegbareBuchstaben(port); - } //endregion - //region codierer - - /** - * Hier wird ein einzelner Buchstabe verschlüsselt. - * Man muss hier ebenfalls mitgeben ob der codierte String in Codierer.nachricht gespeichert werden soll oder nicht. - * In der Regel ist dies der Fall. - * - * @param buchstabe : char : Der zu codierende Buchstabe - * @param save : boolean : Nachricht speichern oder nicht - * @return char : Der codierte Buchstabe - */ - public char codiere(char buchstabe, boolean save) { - - char codiert = this.hardware.codiere(buchstabe); - - if (save) { - this.nachricht += codiert; - } - - return codiert; - } - - /** - * Codiert den Übergebenen String. - * Man muss hier ebenfalls mitgeben ob der codierte String in Codierer.nachricht gespeichert werden soll oder nicht. - * In der Regel ist dies der Fall. - * - * @param klartext : String : Der zu codierende Text - * @param save : boolean : Nachricht speichern oder nicht - * @return String : Der codierte Text zusätzlich als Rückgabe - */ - public String codiere(String klartext, boolean save) { - - StringBuilder sb = new StringBuilder(); - - for (char buchstabe : klartext.toCharArray()) { - sb.append(this.codiere(buchstabe, save)); - } - - return sb.toString(); - } - - /** - * Diese Funktion erwartet als (codierteNachricht) eine korrekte Enigma Nachricht. - * Ihr muss auch der Tag der codierung mitgegeben werden. Dieser weiß dein Funker im Funkraum. - * In der Regel ist dies der Tag des Nachrichten empfangs. - * - * @param codierteNachricht : String : Enigma codierte Nachricht - * @param tag : int : Tag der Nachricht - * @return String : decodierte Nachricht - */ - private String decodiere(String codierteNachricht, int tag) { - - // Hardware reseten und Tageseinstellungen aus dem Codebuch laden - this.codebuch.fetchTagesschluessel(tag); - this.initialisiereHardware(); - - // Nachricht splitten mit whitespace als delimiter - String[] nachricht = codierteNachricht.split(" "); - StringBuilder sb = new StringBuilder(); - - // Uhrzeit - sb.append(nachricht[0]).append(" "); - - // Zeichen Anzahl der Nachricht - sb.append(nachricht[1]).append(" "); - - // Spruchschlüssel - String spruchschluessel = this.decodiereString(nachricht[2]); - - sb.append(spruchschluessel).append(" "); - sb.append(this.decodiereString(nachricht[3])).append(" "); - - // Walzen neu einstellen mit dem Spruchschlüssel - this.hardware.setzePosition(0, spruchschluessel.charAt(0)); - this.hardware.setzePosition(1, spruchschluessel.charAt(1)); - this.hardware.setzePosition(2, spruchschluessel.charAt(2)); - - // Nachricht decodieren - sb.append(this.decodiereString(nachricht[4])); - - return sb.toString(); - } - - /** - * Zerlegt den übergebenen String in einen char Array und decodiert jedes Zeichen. - * Der String wird dann decodiert zurück gegeben. - * - * @param nachricht : String : Der zu decodierende Text - * @return String : Der decodierte Text - */ - private String decodiereString(String nachricht) { - - StringBuilder sb = new StringBuilder(); - - for (char buchstabe : nachricht.toCharArray()) { - if (buchstabe > 0) { - sb.append(this.hardware.codiere(buchstabe)); - } - } - - return sb.toString(); - } - //endregion + //region codierer - //region Sonstige - - /** - * Prüft ob der Port auf den das Kabel gesteckt werden soll, noch frei ist. - * <p> - * setSteckbrett ausführen mit beiden Buchstaben als String - * - * @param buchstabe : char : Der zuletzt eingegebene Buchstabe - * @return boolean : Wenn der Buchstabe nicht vorhanden ist, wird true zurückgegeben, ansonsten false - */ - public boolean pruefeSteckbrettPort(char buchstabe) { - return this.hardware.getSteckbrett().ueberpruefeVertauschungen(buchstabe); - } - - /** - * Ließt aus der empfangenen Nachricht den Spruchschlüssel aus und gibt ihn zurück. - * - * @param empfangeneNachricht : String : Die empfangene Nachricht als String - * @return String : Der Spruchschlüssel mit welcher die Nachricht codiert wurde. - */ - public String empfangenerSpruchschluessel(String empfangeneNachricht) { - String[] nachricht = empfangeneNachricht.split(" "); - - return nachricht[2]; - } - - /** - * Löscht das letzte Zeichen aus der Nachricht und dreht die Walzen eine Position zurück. - */ - public void letztesZeichenLoeschen() { - this.hardware.dreheWalzen(-1); - this.nachricht = this.nachricht.substring(0, this.nachricht.length() - 1); - } - //endregion - //endregion + /** + * Hier wird ein einzelner Buchstabe verschluesselt. + * Man muss hier ebenfalls mitgeben, ob der codierte String in "nachricht" gespeichert werden soll oder nicht. + * In der Regel ist dies der Fall. + * + * @param buchstabe : char : Der zu codierende Buchstabe. + * @param save : boolean : Nachricht speichern oder nicht. + * @return char : Der codierte Buchstabe. + */ + public char codiere(char buchstabe, boolean save) { + char codiert = this.hardware.codiere(buchstabe); - //region Getter - - /** - * Liest die Kenngruppe aus welche die Maschine gerade besitzt. Früher war dies eine eindeutige Nummer - * die einer Einheit zugewiesen war. Wir hinterlegen hier einen Benutzernamen. - * - * @return String : Kenngruppe - */ - public String getKenngruppe() { - return kenngruppe; - } - - /** - * Der Spruchschlüssel wird, zur internen Verwendung, auch im Klartext gespeichert. - * Wir brauchen diesen dann zum codieren der eigentlichen Nachricht. - * - * @return String : Der klartext Spruchschlüssel - */ - public String getSpruchschluessel() { - return this.spruchschluessel; - } - //endregion + if (save) { + this.nachricht += codiert; + } + + return codiert; + } + + /** + * Codiert den uebergebenen String. + * Man muss hier ebenfalls mitgeben, ob der codierte String in "nachricht" gespeichert werden soll oder nicht. + * In der Regel ist dies der Fall. + * + * @param klartext : String : Der zu codierende Text. + * @param save : boolean : Nachricht speichern oder nicht. + * @return String : Der codierte Text zusaetzlich als Rueckgabe. + */ + public String codiere(String klartext, boolean save) { + StringBuilder sb = new StringBuilder(); + + for (char buchstabe : klartext.toCharArray()) { + sb.append(this.codiere(buchstabe, save)); + } + + return sb.toString(); + } + + /** + * Diese Funktion erwartet als (codierteNachricht) eine korrekte Enigma-Nachricht. + * Ihr muss auch der Tag der Codierung mitgegeben werden. Dieser weiss dein Funker im Funkraum. + * In der Regel ist dies der Tag des Nachrichtenempfangs. + * + * @param codierteNachricht : String : Enigma-codierte Nachricht. + * @param tag : int : Tag der Nachricht. + * @return String : decodierte Nachricht. + */ + private String decodiere(String codierteNachricht, int tag) { + + // Hardware reseten und Tageseinstellungen aus dem Codebuch laden + this.codebuch.fetchTagesschluessel(tag); + this.initialisiereHardware(); + + // Nachricht splitten mit whitespace als delimiter + String[] nachricht = codierteNachricht.split(" "); + StringBuilder sb = new StringBuilder(); + + // Uhrzeit und Zeichenanzahl der Nachricht + sb.append(nachricht[0]).append(" "); + sb.append(nachricht[1]).append(" "); + + // Spruchschluessel + String spruchschluessel = this.decodiereString(nachricht[2]); + + sb.append(spruchschluessel).append(" "); + sb.append(this.decodiereString(nachricht[3])).append(" "); + + // Walzen neu einstellen mit dem Spruchschluessel + this.hardware.setzePosition(0, spruchschluessel.charAt(0)); + this.hardware.setzePosition(1, spruchschluessel.charAt(1)); + this.hardware.setzePosition(2, spruchschluessel.charAt(2)); + + // Nachricht decodieren + sb.append(this.decodiereString(nachricht[4])); + + return sb.toString(); + } + + /** + * Zerlegt den uebergebenen String in einen char-Array und decodiert jedes Zeichen. + * Der String wird dann decodiert zurueckgegeben. + * + * @param nachricht : String : Der zu decodierende Text. + * @return String : Der decodierte Text. + */ + private String decodiereString(String nachricht) { + StringBuilder sb = new StringBuilder(); + + for (char buchstabe : nachricht.toCharArray()) { + if (buchstabe > 0) { + sb.append(this.hardware.codiere(buchstabe)); + } + } + + return sb.toString(); + } + //endregion + + //region Sonstige + + /**TODO: Wird nicht benutzt + * Prueft ob der Port auf dem das Kabel gesteckt werden soll, noch frei ist. + * <p> + * setSteckbrett ausfuehren mit beiden Buchstaben als String. + * + * @param buchstabe : char : Der zuletzt eingegebene Buchstabe. + * @return boolean : Wenn der Buchstabe nicht vorhanden ist, wird true zurueckgegeben, ansonsten false. + */ + public boolean pruefeSteckbrettPort(char buchstabe) { + return this.hardware.getSteckbrett().ueberpruefeVertauschungen(buchstabe); + } + + /** + * Liest aus der empfangenen Nachricht den Spruchschluessel aus und gibt ihn zurueck. + * + * @param empfangeneNachricht : String : Die empfangene Nachricht als String. + * @return String : Der Spruchschluessel, mit welcher die Nachricht codiert wurde. + */ + public String empfangenerSpruchschluessel(String empfangeneNachricht) { + String[] nachricht = empfangeneNachricht.split(" "); + + return nachricht[2]; + } + + /** + * Loescht das letzte Zeichen aus der Nachricht und dreht die Walzen eine Position zurueck. + */ + public void letztesZeichenLoeschen() { + this.hardware.dreheWalzen(-1); + this.nachricht = this.nachricht.substring(0, this.nachricht.length() - 1); + } + //endregion + //endregion + + //region Getter + + /** + * Liest die Kenngruppe aus, welche die Maschine gerade besitzt. Frueher war dies eine eindeutige Nummer, + * die einer Einheit zugewiesen war. Wir hinterlegen hier einen Benutzernamen. + * + * @return String : Kenngruppe + */ + public String getKenngruppe() { + return kenngruppe; + } + + /** + * Der Spruchschluessel wird, zur internen Verwendung, auch im Klartext gespeichert. + * Wir brauchen diesen dann zum Codieren der eigentlichen Nachricht. + * + * @return String : Der Klartext des Spruchschluessels + */ + public String getSpruchschluessel() { + return this.spruchschluessel; + } + //endregion }