use proper doctype in HTML generation

striezel · striezel · commit 573fcda45b0f · 2025-09-02T05:46:49.000+02:00
Depending on the selected HTML standard the files will now have
the proper (X)HTML doctype declaration.
diff --git a/code/CMakeLists.txt b/code/CMakeLists.txt
@@ -9,6 +9,7 @@ set(pmdb_sources
     CompressionDetection.cpp
     ConsoleColours.cpp
     FolderMap.cpp
+    HTMLStandard.cpp
     MessageDatabase.cpp
     MsgTemplate.cpp
     PMSource.cpp
diff --git a/code/HTMLOptions.hpp b/code/HTMLOptions.hpp
@@ -22,7 +22,7 @@
 #define PMDB_HTMLOPTIONS_HPP
 
 #include <string>
-#include "bbcode/HTMLStandard.hpp"
+#include "HTMLStandard.hpp"
 #include "bbcode/TableClasses.hpp"
 
 struct HTMLOptions
diff --git a/code/HTMLStandard.cpp b/code/HTMLStandard.cpp
@@ -0,0 +1,34 @@
+/*
+ -------------------------------------------------------------------------------
+    This file is part of the Private Message Database.
+    Copyright (C) 2025  Dirk Stolle
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ -------------------------------------------------------------------------------
+*/
+
+#include "HTMLStandard.hpp"
+
+std::string doctype(const HTMLStandard standard)
+{
+  switch (standard)
+  {
+    case HTMLStandard::HTML4_01:
+         return R"(<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+   "http://www.w3.org/TR/html4/loose.dtd">)";
+    case HTMLStandard::XHTML:
+         return R"(<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">)";
+  }
+}
diff --git a/code/HTMLStandard.hpp b/code/HTMLStandard.hpp
@@ -21,6 +21,8 @@
 #ifndef BBCODE_HTMLSTANDARD_HPP
 #define BBCODE_HTMLSTANDARD_HPP
 
+#include <string>
+
 /** \brief Enumeration type to indicate an (X)HTML standard version.
  *
  * \brief Currently, it's only used to distinguish between HTML and XHTML.
@@ -34,4 +36,11 @@ enum class HTMLStandard: bool
   XHTML = true
 };
 
+/** \brief Gets the doctype for a given HTML standard.
+ *
+ * \param standard   the (X)HTML standard version
+ * \return Returns the corresponding doctype.
+ */
+std::string doctype(const HTMLStandard standard);
+
 #endif // BBCODE_HTMLSTANDARD_HPP
diff --git a/code/MessageDatabase.cpp b/code/MessageDatabase.cpp
@@ -396,7 +396,7 @@ std::string generateFolderList(MsgTemplate folderList, MsgTemplate folderEntry,
   return folderList.show();
 }
 
-bool MessageDatabase::saveIndexFiles(const std::string& directory, MsgTemplate index, MsgTemplate entry, MsgTemplate folderList, MsgTemplate folderEntry, const FolderMap& fm) const
+bool MessageDatabase::saveIndexFiles(const std::string& directory, MsgTemplate index, MsgTemplate entry, MsgTemplate folderList, MsgTemplate folderEntry, const FolderMap& fm, const HTMLStandard standard) const
 {
   std::vector<SortType> sortedList;
   for (const auto& [digest, pm]: m_Messages)
@@ -432,6 +432,7 @@ bool MessageDatabase::saveIndexFiles(const std::string& directory, MsgTemplate i
     ++fcIter;
   }
 
+  index.addReplacement("doctype", doctype(standard), false);
   fcIter = folderContents.begin();
   while (fcIter != folderContents.end())
   {
diff --git a/code/MessageDatabase.hpp b/code/MessageDatabase.hpp
@@ -23,6 +23,7 @@
 
 #include <map>
 #include <vector>
+#include "HTMLStandard.hpp"
 #include "PrivateMessage.hpp"
 #include "MsgTemplate.hpp"
 #include "FolderMap.hpp"
@@ -127,7 +128,7 @@ class MessageDatabase
      * \param fm          the current folder map
      * \return Returns true, if file was created successfully.
      */
-    bool saveIndexFiles(const std::string& directory, MsgTemplate index, MsgTemplate entry, MsgTemplate folderList, MsgTemplate folderEntry, const FolderMap& fm) const;
+    bool saveIndexFiles(const std::string& directory, MsgTemplate index, MsgTemplate entry, MsgTemplate folderList, MsgTemplate folderEntry, const FolderMap& fm, const HTMLStandard standard) const;
 
 
     /** \brief finds messages whose texts "overlap"
diff --git a/code/bbcode/BBCodeParser.hpp b/code/bbcode/BBCodeParser.hpp
@@ -36,7 +36,7 @@
 #include <string>
 #include <vector>
 #include "BBCode.hpp"
-#include "HTMLStandard.hpp"
+#include "../HTMLStandard.hpp"
 #ifndef NO_SMILIES_IN_PARSER
   #include "Smilie.hpp"
 #endif
diff --git a/code/bbcode/HorizontalRuleBBCode.hpp b/code/bbcode/HorizontalRuleBBCode.hpp
@@ -23,7 +23,7 @@
 
 #include <string>
 #include "BBCode.hpp"
-#include "HTMLStandard.hpp"
+#include "../HTMLStandard.hpp"
 
 /** \brief HorizontalRuleBBCode:
        struct for hr BB code
diff --git a/code/bbcode/Smilie.hpp b/code/bbcode/Smilie.hpp
@@ -22,7 +22,7 @@
 #define SMILIE_HPP
 
 #include <string>
-#include "HTMLStandard.hpp"
+#include "../HTMLStandard.hpp"
 
 enum class UrlType: bool
 {
diff --git a/code/html_generation.cpp b/code/html_generation.cpp
@@ -154,6 +154,7 @@ int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTM
 
   // create HTML files
   std::cout << "Creating HTML files for message texts. This may take a while...\n";
+  theTemplate.addReplacement("doctype", doctype(htmlOptions.standard), false);
   theTemplate.addReplacement("forum_url", conf.getForumURL(), false);
   while (msgIter != mdb.getEnd())
   {
@@ -206,7 +207,7 @@ int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTM
   }
   tplIndex.addReplacement("forum_url", conf.getForumURL(), true);
   tplEntry.addReplacement("forum_url", conf.getForumURL(), true);
-  if (!mdb.saveIndexFiles(htmlDir, tplIndex, tplEntry, tplFolderList, tplFolderEntry, fm))
+  if (!mdb.saveIndexFiles(htmlDir, tplIndex, tplEntry, tplFolderList, tplFolderEntry, fm, htmlOptions.standard))
   {
     std::cerr << "Could not write index.html!\n";
     return rcFileError;
diff --git a/code/pmdb.cbp b/code/pmdb.cbp
@@ -99,6 +99,8 @@
 		<Unit filename="FolderMap.cpp" />
 		<Unit filename="FolderMap.hpp" />
 		<Unit filename="HTMLOptions.hpp" />
+		<Unit filename="HTMLStandard.cpp" />
+		<Unit filename="HTMLStandard.hpp" />
 		<Unit filename="MessageDatabase.cpp" />
 		<Unit filename="MessageDatabase.hpp" />
 		<Unit filename="MsgTemplate.cpp" />
@@ -125,7 +127,6 @@
 		<Unit filename="bbcode/CustomizedSimpleBBCode.cpp" />
 		<Unit filename="bbcode/CustomizedSimpleBBCode.hpp" />
 		<Unit filename="bbcode/DefaultCodes.hpp" />
-		<Unit filename="bbcode/HTMLStandard.hpp" />
 		<Unit filename="bbcode/HorizontalRuleBBCode.cpp" />
 		<Unit filename="bbcode/HorizontalRuleBBCode.hpp" />
 		<Unit filename="bbcode/ListBBCode.cpp" />
diff --git a/code/templates/folder.tpl b/code/templates/folder.tpl
@@ -1,5 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-   "http://www.w3.org/TR/html4/loose.dtd">
+{..doctype..}
 <html>
 <head>
   <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
diff --git a/code/templates/message.tpl b/code/templates/message.tpl
@@ -1,9 +1,8 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-   "http://www.w3.org/TR/html4/loose.dtd">
+{..doctype..}
 <html>
 <head>
   <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
-  <title>PM - {..title..}</title>
+  <title>Private Message - {..title..}</title>
 </head>
 <body>
   <strong>Datum:</strong> {..date..}<br>
diff --git a/program-no-compression/CMakeLists.txt b/program-no-compression/CMakeLists.txt
@@ -15,6 +15,7 @@ set(pmdb_no_comp_sources
     ../code/ConsoleColours.cpp
     ../code/CompressionDetection.cpp
     ../code/FolderMap.cpp
+    ../code/HTMLStandard.cpp
     ../code/MessageDatabase.cpp
     ../code/MsgTemplate.cpp
     ../code/PMSource.cpp
diff --git a/tests/components/CMakeLists.txt b/tests/components/CMakeLists.txt
@@ -9,6 +9,7 @@ set(component_tests_sources
     ../../code/Config.cpp
     ../../code/ConsoleColours.cpp
     ../../code/FolderMap.cpp
+    ../../code/HTMLStandard.cpp
     ../../code/MessageDatabase.cpp
     ../../code/MsgTemplate.cpp
     ../../code/PMSource.cpp
@@ -50,6 +51,7 @@ set(component_tests_sources
     CompressionDetections.cpp
     Config.cpp
     FolderMap.cpp
+    HTMLStandard.cpp
     MessageDatabase.cpp
     PrivateMessage.cpp
     SortType.cpp
diff --git a/tests/components/HTMLStandard.cpp b/tests/components/HTMLStandard.cpp
@@ -0,0 +1,44 @@
+/*
+ -------------------------------------------------------------------------------
+    This file is part of the Private Message Database.
+    Copyright (C) 2025  Dirk Stolle
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ -------------------------------------------------------------------------------
+*/
+
+#include "../locate_catch.hpp"
+#include "../../code/HTMLStandard.hpp"
+
+TEST_CASE("HTMLStandard")
+{
+  SECTION("doctype")
+  {
+    SECTION("HTML 4.01")
+    {
+      const auto doc = doctype(HTMLStandard::HTML4_01);
+      REQUIRE( doc.find("<!DOCTYPE HTML") != std::string::npos );
+      REQUIRE( doc.find("-//W3C//DTD HTML 4.01 Transitional//EN") != std::string::npos );
+      REQUIRE( doc.find("http://www.w3.org/TR/html4/loose.dtd") != std::string::npos );
+    }
+
+    SECTION("XHTML")
+    {
+      const auto doc = doctype(HTMLStandard::XHTML);
+      REQUIRE( doc.find("<!DOCTYPE ") != std::string::npos );
+      REQUIRE( doc.find("-//W3C//DTD XHTML 1.0 Transitional//EN") != std::string::npos );
+      REQUIRE( doc.find("http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd") != std::string::npos );
+    }
+  }
+}
diff --git a/tests/components/component_tests.cbp b/tests/components/component_tests.cbp
@@ -43,6 +43,8 @@
 		<Unit filename="../../code/ConsoleColours.hpp" />
 		<Unit filename="../../code/FolderMap.cpp" />
 		<Unit filename="../../code/FolderMap.hpp" />
+		<Unit filename="../../code/HTMLStandard.cpp" />
+		<Unit filename="../../code/HTMLStandard.hpp" />
 		<Unit filename="../../code/MessageDatabase.cpp" />
 		<Unit filename="../../code/MessageDatabase.hpp" />
 		<Unit filename="../../code/MsgTemplate.cpp" />
@@ -121,6 +123,7 @@
 		<Unit filename="CompressionDetections.cpp" />
 		<Unit filename="Config.cpp" />
 		<Unit filename="FolderMap.cpp" />
+		<Unit filename="HTMLStandard.cpp" />
 		<Unit filename="MessageDatabase.cpp" />
 		<Unit filename="PrivateMessage.cpp" />
 		<Unit filename="SortType.cpp" />
diff --git a/tests/messagedatabase/importFromFile/CMakeLists.txt b/tests/messagedatabase/importFromFile/CMakeLists.txt
@@ -5,6 +5,7 @@ project(importFromFile_test)
 
 set(importFromFile_test_src
     ../../../code/FolderMap.cpp
+    ../../../code/HTMLStandard.cpp
     ../../../code/MessageDatabase.cpp
     ../../../code/MsgTemplate.cpp
     ../../../code/PMSource.cpp
diff --git a/tests/messagedatabase/importFromFile/importFromFile_test.cbp b/tests/messagedatabase/importFromFile/importFromFile_test.cbp
@@ -36,6 +36,8 @@
 		</Linker>
 		<Unit filename="../../../code/FolderMap.cpp" />
 		<Unit filename="../../../code/FolderMap.hpp" />
+		<Unit filename="../../../code/HTMLStandard.cpp" />
+		<Unit filename="../../../code/HTMLStandard.hpp" />
 		<Unit filename="../../../code/MessageDatabase.cpp" />
 		<Unit filename="../../../code/MessageDatabase.hpp" />
 		<Unit filename="../../../code/MsgTemplate.cpp" />
diff --git a/tests/messagedatabase/save-load-compressed/CMakeLists.txt b/tests/messagedatabase/save-load-compressed/CMakeLists.txt
@@ -5,6 +5,7 @@ project(MessageDatabase_saveload_compressed_test)
 
 set(MessageDatabase_saveload_compressed_test_src
     ../../../code/FolderMap.cpp
+    ../../../code/HTMLStandard.cpp
     ../../../code/MessageDatabase.cpp
     ../../../code/MsgTemplate.cpp
     ../../../code/PMSource.cpp
diff --git a/tests/messagedatabase/save-load-compressed/save-load-compressed-test.cbp b/tests/messagedatabase/save-load-compressed/save-load-compressed-test.cbp
@@ -31,9 +31,12 @@
 		</Compiler>
 		<Linker>
 			<Add library="xml2" />
+			<Add library="z" />
 		</Linker>
 		<Unit filename="../../../code/FolderMap.cpp" />
 		<Unit filename="../../../code/FolderMap.hpp" />
+		<Unit filename="../../../code/HTMLStandard.cpp" />
+		<Unit filename="../../../code/HTMLStandard.hpp" />
 		<Unit filename="../../../code/MessageDatabase.cpp" />
 		<Unit filename="../../../code/MessageDatabase.hpp" />
 		<Unit filename="../../../code/MsgTemplate.cpp" />
diff --git a/tests/messagedatabase/save-load/CMakeLists.txt b/tests/messagedatabase/save-load/CMakeLists.txt
@@ -5,6 +5,7 @@ project(MessageDatabase_saveload_test)
 
 set(MessageDatabase_saveload_test_src
     ../../../code/FolderMap.cpp
+    ../../../code/HTMLStandard.cpp
     ../../../code/MessageDatabase.cpp
     ../../../code/MsgTemplate.cpp
     ../../../code/PMSource.cpp
diff --git a/tests/messagedatabase/save-load/save-load-test.cbp b/tests/messagedatabase/save-load/save-load-test.cbp
@@ -35,6 +35,8 @@
 		</Linker>
 		<Unit filename="../../../code/FolderMap.cpp" />
 		<Unit filename="../../../code/FolderMap.hpp" />
+		<Unit filename="../../../code/HTMLStandard.cpp" />
+		<Unit filename="../../../code/HTMLStandard.hpp" />
 		<Unit filename="../../../code/MessageDatabase.cpp" />
 		<Unit filename="../../../code/MessageDatabase.hpp" />
 		<Unit filename="../../../code/MsgTemplate.cpp" />

Original file line number	Diff line number	Diff line change
`@@ -396,7 +396,7 @@ std::string generateFolderList(MsgTemplate folderList, MsgTemplate folderEntry,`
`396`	`396`	`return folderList.show();`
`397`	`397`	`}`
`398`	`398`
`399`		`-bool MessageDatabase::saveIndexFiles(const std::string& directory, MsgTemplate index, MsgTemplate entry, MsgTemplate folderList, MsgTemplate folderEntry, const FolderMap& fm) const`
	`399`	`+bool MessageDatabase::saveIndexFiles(const std::string& directory, MsgTemplate index, MsgTemplate entry, MsgTemplate folderList, MsgTemplate folderEntry, const FolderMap& fm, const HTMLStandard standard) const`
`400`	`400`	`{`
`401`	`401`	`std::vector<SortType> sortedList;`
`402`	`402`	`for (const auto& [digest, pm]: m_Messages)`
`@@ -432,6 +432,7 @@ bool MessageDatabase::saveIndexFiles(const std::string& directory, MsgTemplate i`
`432`	`432`	`++fcIter;`
`433`	`433`	`}`
`434`	`434`
	`435`	`+ index.addReplacement("doctype", doctype(standard), false);`
`435`	`436`	`fcIter = folderContents.begin();`
`436`	`437`	`while (fcIter != folderContents.end())`
`437`	`438`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`#define SMILIE_HPP`
`23`	`23`
`24`	`24`	`#include <string>`
`25`		`-#include "HTMLStandard.hpp"`
	`25`	`+#include "../HTMLStandard.hpp"`
`26`	`26`
`27`	`27`	`enum class UrlType: bool`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -154,6 +154,7 @@ int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTM`
`154`	`154`
`155`	`155`	`// create HTML files`
`156`	`156`	`std::cout << "Creating HTML files for message texts. This may take a while...\n";`
	`157`	`+ theTemplate.addReplacement("doctype", doctype(htmlOptions.standard), false);`
`157`	`158`	`theTemplate.addReplacement("forum_url", conf.getForumURL(), false);`
`158`	`159`	`while (msgIter != mdb.getEnd())`
`159`	`160`	`{`
`@@ -206,7 +207,7 @@ int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTM`
`206`	`207`	`}`
`207`	`208`	`tplIndex.addReplacement("forum_url", conf.getForumURL(), true);`
`208`	`209`	`tplEntry.addReplacement("forum_url", conf.getForumURL(), true);`
`209`		`- if (!mdb.saveIndexFiles(htmlDir, tplIndex, tplEntry, tplFolderList, tplFolderEntry, fm))`
	`210`	`+ if (!mdb.saveIndexFiles(htmlDir, tplIndex, tplEntry, tplFolderList, tplFolderEntry, fm, htmlOptions.standard))`
`210`	`211`	`{`
`211`	`212`	`std::cerr << "Could not write index.html!\n";`
`212`	`213`	`return rcFileError;`