Skip to content

Commit

Permalink
Add Checkstyle to project and fix most of its violations.
Browse files Browse the repository at this point in the history
  • Loading branch information
TDF-PL-038 committed Sep 24, 2023
1 parent 3840f6c commit aa64915
Show file tree
Hide file tree
Showing 22 changed files with 523 additions and 211 deletions.
5 changes: 3 additions & 2 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea/
.idlea/
target/
tak.iml
*.iml
.idea/
184 changes: 184 additions & 0 deletions checkstyle.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
https://checkstyle.org/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->
<property name="severity" value="error"/>

<property name="fileExtensions" value="java, properties, xml"/>

<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/filefilters/index.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>

<!-- https://checkstyle.org/filters/suppressionfilter.html -->
<module name="SuppressionFilter">
<property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
default="checkstyle-suppressions.xml" />
<property name="optional" value="true"/>
</module>

<!-- Checks that a package-info.java file exists for each package. -->
<!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage -->
<!-- <module name="JavadocPackage"/>-->

<!-- Checks whether files end with a new line. -->
<!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html -->
<module name="NewlineAtEndOfFile"/>

<!-- Checks that property files contain the same keys. -->
<!-- See https://checkstyle.org/checks/misc/translation.html -->
<module name="Translation"/>

<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/checks/sizes/index.html -->
<module name="FileLength"/>
<module name="LineLength">
<property name="fileExtensions" value="java"/>
<property name="max" value="120" />
</module>

<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<module name="FileTabCharacter"/>

<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/checks/misc/index.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>

<!-- Checks for Headers -->
<!-- See https://checkstyle.org/checks/header/index.html -->
<!-- <module name="Header"> -->
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
<!-- <property name="fileExtensions" value="java"/> -->
<!-- </module> -->

<module name="TreeWalker">

<!-- Checks for Javadoc comments. -->
<!-- See https://checkstyle.org/checks/javadoc/index.html -->
<module name="InvalidJavadocPosition"/>

<module name="JavadocMethod">
<property name="accessModifiers" value="public"/>
</module>

<module name="JavadocType">
<property name="scope" value="protected"/>
</module>

<module name="JavadocVariable">
<property name="scope" value="protected"/>
</module>

<module name="JavadocStyle"/>

<module name="MissingJavadocMethod">
<property name="scope" value="protected"/>
</module>

<!-- Checks for Naming Conventions. -->
<!-- See https://checkstyle.org/checks/naming/index.html -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>

<!-- Checks for imports -->
<!-- See https://checkstyle.org/checks/imports/index.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports">
<property name="processJavadoc" value="false"/>
</module>

<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/checks/sizes/index.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>

<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>

<!-- Modifier Checks -->
<!-- See https://checkstyle.org/checks/modifier/index.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>

<!-- Checks for blocks. You know, those {}'s -->
<!-- See https://checkstyle.org/checks/blocks/index.html -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>

<!-- Checks for common coding problems -->
<!-- See https://checkstyle.org/checks/coding/index.html -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<!-- <module name="HiddenField"/>-->
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<!-- <module name="MagicNumber"/>-->
<module name="MissingSwitchDefault"/>
<module name="MultipleVariableDeclarations"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Checks for class design -->
<!-- See https://checkstyle.org/checks/design/index.html -->
<module name="DesignForExtension"/>
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier"/>

<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/checks/misc/index.html -->
<module name="ArrayTypeStyle"/>
<!-- <module name="FinalParameters"/>-->
<module name="TodoComment"/>
<module name="UpperEll"/>

<!-- https://checkstyle.org/filters/suppressionxpathfilter.html -->
<module name="SuppressionXpathFilter">
<property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
default="checkstyle-xpath-suppressions.xml" />
<property name="optional" value="true"/>
</module>

</module>

</module>
84 changes: 52 additions & 32 deletions client/src/main/java/org/wot/tak/client/App.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,54 +11,66 @@
import org.wot.tak.validator.MessageValidator;
import org.xml.sax.InputSource;

import javax.swing.*;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.SwingUtilities;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.Color;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.*;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.io.StringWriter;
import java.nio.file.Files;
import java.time.Instant;
import java.util.Properties;
import java.util.Random;
import java.util.UUID;

public class App extends JFrame implements TAKHandler {
public final class App extends JFrame implements TAKHandler {

private static final String propertiesPath = "config-dev.properties";
private static final String uid = UUID.randomUUID().toString();
private static final String PROPERTIES_PATH = "config-dev.properties";
private static final String UID = UUID.randomUUID().toString();

private static ConnectorFactory cFactory;
private static MessageValidator messageValidator;
TAKServerConnector connector;
private TAKServerConnector connector;
private JPanel contentPane;
private JButton send;
private JTextField input;
private JTextArea output;


/**
* Main method.
*
* @param args Command line arguments.
* @throws Exception Exception.
*/
public static void main(String[] args) throws Exception {
SwingUtilities.invokeAndWait(App::new);
}

public App() {
App() {
super("TAK Demo connection");
setDefaultCloseOperation(EXIT_ON_CLOSE);
setContentPane(contentPane);
getRootPane().setDefaultButton(send);

send.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
onSend();
}
});
send.addActionListener(e -> onSend());

addWindowListener(new WindowAdapter() {
public void windowClosing(WindowEvent e) {
Expand Down Expand Up @@ -106,7 +118,7 @@ public void windowClosing(WindowEvent e) {

private static Properties initializeProperties() throws IOException {
Properties prop = new Properties();
InputStream fis = App.class.getClassLoader().getResourceAsStream(propertiesPath);
InputStream fis = App.class.getClassLoader().getResourceAsStream(PROPERTIES_PATH);
prop.load(fis);
return prop;
}
Expand All @@ -121,7 +133,7 @@ private static TAKServerConnector createConnector(String connectionMode) throws
case "tls":
return cFactory.getSSLConnector();
case "tlsCred":
return cFactory.getSSLCredConnector();
return cFactory.getSSLWithCredentialsConnector();
case "credentials":
return cFactory.getCredentialsConnector();
case "udp":
Expand All @@ -147,7 +159,8 @@ private static void validateCOTMessages(String cotDirectoryPath) throws Exceptio
}
}

private void sendFilesFromDirectoryUsingConnector(TAKServerConnector connector, String cotDirectoryPath) throws Exception {
private void sendFilesFromDirectoryUsingConnector(TAKServerConnector connector, String cotDirectoryPath)
throws Exception {
connector.connect(this);
File dir = new File(cotDirectoryPath);
File[] files = dir.listFiles();
Expand All @@ -165,12 +178,12 @@ private void onSend() {
String callsign = input.getText();
input.setText("");
try {
String xml = "<event how=\"m-g\" type=\"a-f-G-U-C-I\" version=\"2.0\">\n" +
" <point />\n" +
" <detail>\n" +
" <contact />\n" +
" </detail>\n" +
"</event>\n";
String xml = "<event how=\"m-g\" type=\"a-f-G-U-C-I\" version=\"2.0\">\n"
+ " <point />\n"
+ " <detail>\n"
+ " <contact />\n"
+ " </detail>\n"
+ "</event>\n";
Document document = parse(xml);
var now = Instant.now();
now = now.minusNanos(now.getNano());
Expand All @@ -179,10 +192,16 @@ private void onSend() {
document.getDocumentElement().setAttribute("start", start);
document.getDocumentElement().setAttribute("time", start);
document.getDocumentElement().setAttribute("stale", stop);
document.getDocumentElement().setAttribute("uid", uid);
((Element) document.getElementsByTagName("point").item(0)).setAttribute("lat", Double.toString(52.2312 + (0.5 - new Random().nextFloat()) / 10));
((Element) document.getElementsByTagName("point").item(0)).setAttribute("lon", Double.toString(21.016 + (0.5 - new Random().nextFloat()) / 10));
((Element) ((((Element) document.getElementsByTagName("detail").item(0)).getElementsByTagName("contact").item(0)))).setAttribute("callsign", callsign.isEmpty() ? "UNKNOWN" : callsign);
document.getDocumentElement().setAttribute("uid", UID);
((Element) document.getElementsByTagName("point")
.item(0))
.setAttribute("lat", Double.toString(52.2312 + (0.5 - new Random().nextFloat()) / 10));
((Element) document.getElementsByTagName("point")
.item(0))
.setAttribute("lon", Double.toString(21.016 + (0.5 - new Random().nextFloat()) / 10));
((Element) ((((Element) document.getElementsByTagName("detail")
.item(0)).getElementsByTagName("contact").item(0))))
.setAttribute("callsign", callsign.isEmpty() ? "UNKNOWN" : callsign);
String pretty = format(document);
connector.send(pretty);
output.setText(pretty);
Expand All @@ -199,7 +218,7 @@ public void receive(String xml) {
output.setBackground(Color.green);
}

public static String format(Document doc) {
static String format(Document doc) {
StringWriter out = new StringWriter();
TransformerFactory factory = TransformerFactory.newInstance();
try {
Expand All @@ -211,7 +230,7 @@ public static String format(Document doc) {
return out.toString();
}

public static Node stripEmptyElements(Node node) {
static Node stripEmptyElements(Node node) {
NodeList children = node.getChildNodes();
for (int i = 0; i < children.getLength(); ++i) {
Node child = children.item(i);
Expand All @@ -229,7 +248,8 @@ public static Node stripEmptyElements(Node node) {
private static Document parse(String xml) {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try {
return (Document) stripEmptyElements(factory.newDocumentBuilder().parse(new InputSource(new StringReader(xml))));
return (Document) stripEmptyElements(
factory.newDocumentBuilder().parse(new InputSource(new StringReader(xml))));
} catch (Exception ignored) {
}
return null;
Expand Down
Loading

0 comments on commit aa64915

Please sign in to comment.