Version 1.4 Add Table Of Contents and new property add_toc (default value : true)

Author: DABURON Vincent

README.md

@@ -8,25 +8,37 @@ The types of files searched are:
  * gz
  * zip
  * log
+ * xlsx
+ * xls
  * gif
  * png
  * bmp
  * jpg
  * jpeg
  * html
 
-The link is "<a ref=" relative for files of type: csv, jtl, xml, gz, zip, log (to download it)
+The link is "<a ref=" relative for files of type: csv, jtl, xml, gz, zip, log, xlsx, xls (to download it)
 
 The link is "<img src=" relative for files of type: gif, png, bmp, jpg, jpeg (to view it)
 
-For html files, the content is read and directly included in the generated html page (blocks of html tables created with the csv-report-to-html tool from csv file)
+For html files, the content is read and directly included in the generated html page (blocks of html tables created with the csv-report-to-html tool from csv file). This HTML include file must not have elements &lt;html&gt; and &lt;/html&gt;.
 
-sorting algorithm : Filenames with less directory deep are before file this directory
+Sorting algorithm : Ascending alphabetical sorting but filenames with less directory deep are before file this directory
 <pre>
 Example : z.img < dir/x.img < dir/y.img < aa/bb/c.img < aa/bb/d.img
 Deep    : no dir, dir 1 deep level,      dir 2 deep level
 </pre>
 
+## Default values 
+- image_width = 1024 (pixels)
+- add_toc = true (add Table Of Contents)
+
+And the charset to read could be set with -Dfile.encoding=&lt;charset encoding&gt; (e.g: UFT-8)
+
+Change this values with system properties :
+- -Dimage_width=new_int_value (e.g: 1280)
+- -Dadd_toc=false (e.g: true or false)
+
 ## License
 See the LICENSE file Apache 2 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
@@ -42,22 +54,23 @@ The maven groupId, artifactId and version, this plugin is in the **Maven Central
 ```xml
 <groupId>io.github.vdaburon</groupId>
 <artifactId>create-html-for-files-in-directory</artifactId>
-<version>1.2</version>
+<version>1.4</version>
 ```
 Just include the plugin in your `pom.xml` and execute `mvn verify` <br>
-or individual launch `mvn -Dgraph_width=950 exec:java@create_html_page_for_files_in_directory`
+or individual launch `mvn -Dimage_width=950 -Dadd_toc=false exec:java@create_html_page_for_files_in_directory`
 
 ```xml
 <project>
     <properties>
-        <graph_width>1024</graph_width>
+        <image_width>1024</image_width>
+        <add_toc>true</add_toc>
     </properties>
 
     <dependencies>
         <dependency>
             <groupId>io.github.vdaburon</groupId>
             <artifactId>create-html-for-files-in-directory</artifactId>
-            <version>1.2</version>
+            <version>1.4</version>
         </dependency>
     </dependencies>
 
@@ -83,7 +96,11 @@ or individual launch `mvn -Dgraph_width=950 exec:java@create_html_page_for_files
                             <systemProperties>
                                 <systemProperty>
                                     <key>image_width</key>
-                                    <value>${graph_width}</value>
+                                    <value>${image_width}</value>
+                                </systemProperty>
+                                <systemProperty>
+                                    <key>add_toc</key>
+                                    <value>${add_toc}</value>
                                 </systemProperty>
                             </systemProperties>
                         </configuration>
@@ -98,19 +115,23 @@ or individual launch `mvn -Dgraph_width=950 exec:java@create_html_page_for_files
 ## Simple jar tool
 This tool is a java jar, so it's could be use as simple jar (look at [Release](https://github.com/vdaburon/CreateHtmlForFilesInDirectory/releases) to download jar file)
 <pre>
-java -Dimage_width=900 -cp create-html-for-files-in-directory-&lt;version&gt;.jar io.github.vdaburon.jmeter.utils.HtmlGraphVisualizationGenerator jmeter/results index.html
+java -Dimage_width=900 -Dadd_toc=true -cp create-html-for-files-in-directory-&lt;version&gt;.jar io.github.vdaburon.jmeter.utils.HtmlGraphVisualizationGenerator jmeter/results index.html
 or
-java -Dimage_width=900 -jar create-html-for-files-in-directory-&lt;version&gt;-jar-with-dependencies.jar jmeter/results index.html
+java -Dimage_width=900 -Dadd_toc=true -jar create-html-for-files-in-directory-&lt;version&gt;-jar-with-dependencies.jar jmeter/results index.html
 </pre>
 
 ## Link to others projects
-Usally this plugin is use with [jmeter-graph-tool-maven-plugin](https://github.com/vdaburon/jmeter-graph-tool-maven-plugin)<br>
+Usually this plugin is use with [jmeter-graph-tool-maven-plugin](https://github.com/vdaburon/jmeter-graph-tool-maven-plugin)<br>
 and this plugin [csv-report-to-html](https://github.com/vdaburon/JMReportCsvToHtml)
 1) The **jmeter-graph-tool-maven-plugin** create the report csv files and graphs
 2) The **csv-report-to-html** create the **html table report** from the csv file
 3) The **create-html-for-files-in-directory** create a page html this links to images and files in a directory to show and add links
 
 ## Versions
+Version 1.4 date 2025-04-26, add Table Of Contents and new property add_toc (default value : true)
+
+Version 1.3 date 2023-05-10, Add extensions xlsx and xls (Excel file)
+
 Version 1.2 add the file size after the "&lt;a ref=" link
 
 Version 1.1 add link (a href) to jtl and xml files

doc/images/html_extract.png

@@ -6,7 +6,7 @@
 
     <groupId>io.github.vdaburon</groupId>
     <artifactId>create-html-for-files-in-directory</artifactId>
-    <version>1.2</version>
+    <version>1.4</version>
     <packaging>jar</packaging>
     <name>Create html page for files in directory</name>
     <description>A tool that creates an html page for files in the directory to display graphics and link files</description>
@@ -143,7 +143,7 @@
             <plugin>
                 <groupId>org.sonatype.plugins</groupId>
                 <artifactId>nexus-staging-maven-plugin</artifactId>
-                <version>1.6.13</version>
+                <version>1.7.0</version>
                 <extensions>true</extensions>
                 <configuration>
                     <serverId>ossrh</serverId>

pom.xml

@@ -1,7 +1,9 @@
 package io.github.vdaburon.jmeter.utils;
 
+import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.File;
+import java.io.FileReader;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.nio.file.Files;
@@ -22,12 +24,14 @@
 public class HtmlGraphVisualizationGenerator {
 	// CRLF ou LF ou CR
 	public static final String LINE_SEP = System.getProperty("line.separator");
+
+	public static final String K_TABLE_CONTENTS = "@@TABLE_OF_CONTENTS@@";
 
 	public static void main(String[] args) {
 
 		if (args.length != 2) {
 			System.err.println("Usage HtmlGraphVisualizationGenerator dirWithFiles fileOutHtml");
-			System.err.println("E.g. java -Dimage_width=1024 -jar create-html-for-files-in-directory-<version>.jar c:/jmeter/dir_results index.html");
+			System.err.println("E.g. java -Dimage_width=1024-Dadd_toc=true -jar create-html-for-files-in-directory-<version>.jar c:/jmeter/dir_results index.html");
 			System.exit(1);
 		}
 		String dirWithFiles = args[0];
@@ -44,6 +48,12 @@ public static void main(String[] args) {
 			}
 		}
 
+		String sIsAddToc = System.getProperty("add_toc");
+		boolean isAddToc = true;
+		if (sIsAddToc != null) {
+			isAddToc = Boolean.parseBoolean(sIsAddToc);
+		}
+
 		File fDirWithFiles = new File(dirWithFiles);
 		File fileIndex = new File(dirWithFiles + "/" + fileOutHtml);
 		if (fileIndex.exists()) {
@@ -52,6 +62,7 @@ public static void main(String[] args) {
 		}
 
 		Object[] tabFiles = listFileOrderByName(fDirWithFiles);
+		ArrayList listTitles = new ArrayList<>();
 
 		BufferedWriter out = null;
 		try {
@@ -78,21 +89,32 @@ public static void main(String[] args) {
 
 			out.write("<h1> Generated date " + sDate + "</h1><br/>");
 			out.write(LINE_SEP);
-			
+
+			if (isAddToc) {
+				out.write(K_TABLE_CONTENTS + "<br/>");
+				out.write(LINE_SEP);
+				System.out.println("With a Table Of Contents");
+			}
+
 			for (int i = 0; i < tabFiles.length; i++) {
 				File f = (File) tabFiles[i];
 
 				String name = f.getName().toLowerCase();
 				if (name.endsWith("csv") || name.endsWith("jtl") || name.endsWith("xml") ||name.endsWith("gz")  || name.endsWith("zip") || name.endsWith("log")
-						|| name.endsWith("gif") || name.endsWith("png") || name.endsWith("bmp") || name.endsWith("jpg") || name.endsWith("jpeg") || name.endsWith("html")) {
+						|| name.endsWith("xlsx") || name.endsWith("xls")
+						|| name.endsWith("gif") || name.endsWith("png") || name.endsWith("bmp") || name.endsWith("jpg") || name.endsWith("jpeg")
+						|| name.endsWith("html")) {
 
 					// folderRead = c:\dir1\dir2\dirIn, f =  c:\dir1\dir2\dirIn\logo.gif => nameRelative = logo.gif (remove the folderRead path)
 					String nameRelative = f.getCanonicalPath().substring(fDirWithFiles.getCanonicalPath().length() + 1);
-
+					out.write("<p><a name=\"" + i + "\"></a></p>");
+					out.write(LINE_SEP);
 					out.write("<h2>" + nameRelative + "</h2><br/>");
 					out.write(LINE_SEP);
+					listTitles.add(nameRelative);
 
-					if (name.endsWith("csv") || name.endsWith("jtl") || name.endsWith("xml") ||name.endsWith("gz") || name.endsWith("zip") || name.endsWith("log")) {
+					if (name.endsWith("csv") || name.endsWith("jtl") || name.endsWith("xml") ||name.endsWith("gz") || name.endsWith("zip") || name.endsWith("log") ||
+							name.endsWith("xlsx") || name.endsWith("xls")) {
 						long lengthBytes = f.length();
 						DecimalFormatSymbols symbols = DecimalFormatSymbols.getInstance();
 						symbols.setGroupingSeparator(' ');
@@ -136,7 +158,15 @@ public static void main(String[] args) {
 				}
 			}
 		}
-	}
+
+ 		if (isAddToc) {
+			try {
+				replaceTableOfContentsByTitle(fileIndex, listTitles);
+			} catch (IOException e) {
+				System.out.println(e.getMessage());
+			}
+		}
+    }
 
 	@SuppressWarnings("unchecked")
 	public static Object[] listFileOrderByName(File folderRead) {
@@ -174,5 +204,32 @@ public static void findAllFilesInDirectory(File directory, List<File> files) {
 	        }
 	    }
 	}
+
+	public static void replaceTableOfContentsByTitle(File fileIndex, ArrayList <String> listTitles) throws IOException {
+		String allIndex = readAllFileToString(fileIndex.getCanonicalPath());
+		StringBuffer sbTitles = new StringBuffer(2048);
+		sbTitles.append("<h2>Table Of Contents</h2>" + LINE_SEP);
+		sbTitles.append("<h4>" + LINE_SEP);
+		for (int i = 0; i < listTitles.size(); i++) {
+			sbTitles.append("<a href=\"#" + i + "\">");
+			sbTitles.append(listTitles.get(i));
+			sbTitles.append("</a></br>" + LINE_SEP);
+		}
+		int position = allIndex.indexOf(K_TABLE_CONTENTS);
+		StringBuffer sbNewIndex = new StringBuffer(128 * 1024);
+		if (position > 1) {
+			sbNewIndex.append(allIndex.substring(0,position));
+			sbNewIndex.append(sbTitles.toString());
+			sbNewIndex.append(allIndex.substring((position + K_TABLE_CONTENTS.length()), allIndex.length()));
+		}
+		sbTitles.append("</h4>" + LINE_SEP);
+
+		if (fileIndex.exists()) {
+			fileIndex.delete();
+		}
+		BufferedWriter out = new BufferedWriter(new FileWriter(fileIndex));
+		out.write(sbNewIndex.toString());
+		out.close();
+	}
 }