add functions to handle pmdb paths

Author: striezel

code/CMakeLists.txt

@@ -27,6 +27,7 @@ set(pmdb_sources
     bbcode/TableBBCode.cpp
     bbcode/quotes.cpp
     filters/FilterUser.cpp
+    paths.cpp
     ../libstriezel/common/DirectoryFileList.cpp
     ../libstriezel/common/StringUtils.cpp
     ../libstriezel/filesystem/directory.cpp

code/FolderMap.cpp

@@ -1,7 +1,7 @@
 /*
  -------------------------------------------------------------------------------
     This file is part of the Private Message Database.
-    Copyright (C) 2014, 2016  Dirk Stolle
+    Copyright (C) 2014, 2016, 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
@@ -36,40 +36,39 @@ void FolderMap::add(const SHA256::MessageDigest& pm_digest, const std::string& f
 
 bool FolderMap::hasEntry(const SHA256::MessageDigest& pm_digest) const
 {
-  return (m_FolderMap.find(pm_digest)!=m_FolderMap.end());
+  return m_FolderMap.find(pm_digest) != m_FolderMap.end();
 }
 
 const std::string& FolderMap::getFolderName(const SHA256::MessageDigest& pm_digest) const
 {
   const std::map<SHA256::MessageDigest, std::string>::const_iterator iter = m_FolderMap.find(pm_digest);
-  if (iter!=m_FolderMap.end()) return iter->second;
-  throw std::runtime_error("The message database's folder map has no message entry for the given hash "+pm_digest.toHexString()+"!");
+  if (iter != m_FolderMap.end())
+    return iter->second;
+  throw std::runtime_error("The message database's folder map has no message entry for the given hash " + pm_digest.toHexString() + "!");
 }
 
 bool FolderMap::save(const std::string& directory) const
 {
   std::ofstream output;
-  output.open((directory+"foldermap").c_str(), std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
+  output.open(directory + "foldermap", std::ios_base::out | std::ios_base::binary | std::ios_base::trunc);
   if (!output)
   {
     return false;
   }
   const char space = ' ';
   const char end = '\n';
-  std::map<SHA256::MessageDigest, std::string>::const_iterator iter = m_FolderMap.begin();
-  while (iter!=m_FolderMap.end())
+  for (const auto& [digest, folder]: m_FolderMap)
   {
-    const std::string hexRepresentation = iter->first.toHexString();
-    //write hash
+    const std::string hexRepresentation = digest.toHexString();
+    // write hash
     output.write(hexRepresentation.c_str(), hexRepresentation.length());
-    //write space
+    // write space
     output.write(&space, 1);
-    //write folder name
-    output.write(iter->second.c_str(), iter->second.length());
-    //write end of line character
+    // write folder name
+    output.write(folder.c_str(), folder.length());
+    // write end of line character
     output.write(&end, 1);
-    ++iter;
-  }//while
+  }
   const bool well = output.good();
   output.close();
   return well;
@@ -88,25 +87,25 @@ bool FolderMap::load(const std::string& directory)
   const unsigned int cMaxLine = 1024;
   char buffer[cMaxLine];
   std::string line = "";
-  while (inFile.getline(buffer, cMaxLine-1))
+  while (inFile.getline(buffer, cMaxLine - 1))
   {
     buffer[cMaxLine-1] = '\0';
     line = std::string(buffer);
     if (!md.fromHexString(line.substr(0, 64)))
     {
       inFile.close();
-      std::cout << "Error: string \""<<line.substr(0,64)<<"\" is no valid hash!\n";
+      std::cout << "Error: String \"" << line.substr(0,64) << "\" is no valid hash!\n";
       return false;
     }
-    //remove hash
+    // remove hash
     line.erase(0, 64);
-    //remove leading spaces
+    // remove leading spaces
     trimLeft(line);
     if (!line.empty())
     {
       m_FolderMap[md] = line;
-    }//if
-  }//while
+    }
+  }
   inFile.close();
   return true;
 }
@@ -115,10 +114,10 @@ std::set<std::string> FolderMap::getPresentFolders() const
 {
   std::set<std::string> allFolders;
   std::map<SHA256::MessageDigest, std::string>::const_iterator iter = m_FolderMap.begin();
-  while (iter!=m_FolderMap.end())
+  while (iter != m_FolderMap.end())
   {
     allFolders.insert(iter->second);
     ++iter;
-  }//while
+  }
   return allFolders;
 }

code/main.cpp

@@ -29,6 +29,7 @@
 #include "Config.hpp"
 #include "ConsoleColours.hpp"
 #include "ColourMap.hpp"
+#include "paths.hpp"
 #include "Version.hpp"
 #include "bbcode/BBCodeParser.hpp"
 #include "bbcode/DefaultCodes.hpp"
@@ -120,20 +121,10 @@ int main(int argc, char **argv)
   std::set<std::string> loadDirs;
   bool doSave = true;
   bool saveModeSpecified = false;
-  std::string homeDirectory;
-  std::string defaultSaveDirectory;
   Compression compression = Compression::none;
 
-  if (libstriezel::filesystem::directory::getHome(homeDirectory))
-  {
-    homeDirectory = libstriezel::filesystem::slashify(homeDirectory);
-    defaultSaveDirectory = homeDirectory + std::string(".pmdb") + libstriezel::filesystem::pathDelimiter;
-  }
-  else
-  {
-    homeDirectory = std::string(".") + libstriezel::filesystem::pathDelimiter;
-    defaultSaveDirectory = std::string(".pmdb") + libstriezel::filesystem::pathDelimiter;
-  }
+  const std::string defaultSaveDirectory = pmdb::paths::main() + libstriezel::filesystem::pathDelimiter;
+
   bool doHTML = false;
   HTMLStandard standard = HTMLStandard::HTML4_01;
   bool nl2br = true;
@@ -449,7 +440,7 @@ int main(int argc, char **argv)
         if (!libstriezel::filesystem::directory::createRecursive(realDir))
         {
           std::cout << "failed!\nAborting.\n";
-          return 0;
+          return rcFileError;
         }
         std::cout << "success!\n";
       }
@@ -475,7 +466,7 @@ int main(int argc, char **argv)
     if (msgIter != mdb.getEnd())
     {
       // directory creation
-      std::string htmlDir = libstriezel::filesystem::slashify(defaultSaveDirectory) + "html";
+      std::string htmlDir = pmdb::paths::html();
       if (!libstriezel::filesystem::directory::exists(htmlDir))
       {
         std::cout << "Trying to create HTML directory \"" << htmlDir << "\"...";
@@ -493,9 +484,10 @@ int main(int argc, char **argv)
       conf.setForumURL("http://www.example.com/forum/");
       conf.setTPLFile("message.tpl");
       // try to load configuration file
-      if (libstriezel::filesystem::file::exists(defaultSaveDirectory + "pmdb.conf"))
+      const std::string conf_path = pmdb::paths::conf();
+      if (libstriezel::filesystem::file::exists(conf_path))
       {
-        if (!conf.loadFromFile(defaultSaveDirectory + "pmdb.conf"))
+        if (!conf.loadFromFile(conf_path))
         {
           std::cout << "Could not load pmdb.conf, using default/incomplete values instead.\n";
           conf.setTPLFile("message.tpl");
@@ -640,7 +632,7 @@ int main(int argc, char **argv)
   if (searchForSubsets)
   {
     ColourMap cMap;
-    const std::string pathToColourMap = defaultSaveDirectory + "pmdb.colourmap";
+    const std::string pathToColourMap = pmdb::paths::colourmap();
     if (libstriezel::filesystem::file::exists(pathToColourMap))
     {
       if (!cMap.loadFromFile(pathToColourMap))

code/paths.cpp

@@ -0,0 +1,53 @@
+/*
+ -------------------------------------------------------------------------------
+    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 "paths.hpp"
+#include "../libstriezel/filesystem/directory.hpp"
+
+namespace pmdb
+{
+
+std::string paths::main()
+{
+  std::string home;
+  if (!libstriezel::filesystem::directory::getHome(home))
+  {
+    home = std::string(".");
+  }
+
+  return libstriezel::filesystem::slashify(home) + std::string(".pmdb");
+}
+
+std::string paths::html()
+{
+  return main() + libstriezel::filesystem::pathDelimiter + "html";
+}
+
+std::string paths::conf()
+{
+  return main() + libstriezel::filesystem::pathDelimiter + "pmdb.conf";
+}
+
+std::string paths::colourmap()
+{
+  return main() + libstriezel::filesystem::pathDelimiter + "pmdb.colourmap";
+}
+
+} // namespace

code/paths.hpp

@@ -0,0 +1,64 @@
+/*
+ -------------------------------------------------------------------------------
+    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/>.
+ -------------------------------------------------------------------------------
+*/
+
+#ifndef PMDB_PATHS_HPP
+#define PMDB_PATHS_HPP
+
+#include <string>
+
+namespace pmdb
+{
+
+struct paths
+{
+  public:
+    /** \brief Gets the path to pmdb's main directory.
+     *
+     * \remarks This is usually ~/.pmdb or the equivalent.
+     * \return Returns the path to pmdb's main directory.
+     */
+    static std::string main();
+
+    /** \brief Gets the directory where HTML files are saved.
+     *
+     * \return Returns the directory where HTML files are saved.
+     * \remarks This is usually ~/.pmdb/html or the equivalent.
+     */
+    static std::string html();
+
+
+    /** \brief Gets the default path for the configuration file.
+     *
+     * \return Returns the default path for the configuration file.
+     * \remarks This is usually ~/.pmdb/pmdb.conf or the equivalent.
+     */
+    static std::string conf();
+
+    /** \brief Gets the path for the colour map.
+     *
+     * \return Returns the path for the colour map.
+     * \remarks This is usually ~/.pmdb/pmdb.colourmap or the equivalent.
+     */
+    static std::string colourmap();
+};
+
+} // namespace
+
+#endif // PMDB_PATHS_HPP

code/pmdb.cbp

@@ -142,6 +142,8 @@
 		<Unit filename="filters/FilterUser.cpp" />
 		<Unit filename="filters/FilterUser.hpp" />
 		<Unit filename="main.cpp" />
+		<Unit filename="paths.cpp" />
+		<Unit filename="paths.hpp" />
 		<Extensions>
 			<lib_finder disable_auto="1" />
 		</Extensions>

program-no-compression/CMakeLists.txt

@@ -33,6 +33,7 @@ set(pmdb_no_comp_sources
     ../code/bbcode/TableBBCode.cpp
     ../code/bbcode/quotes.cpp
     ../code/filters/FilterUser.cpp
+    ../code/paths.cpp
     ../libstriezel/common/DirectoryFileList.cpp
     ../libstriezel/common/StringUtils.cpp
     ../libstriezel/filesystem/directory.cpp

tests/components/CMakeLists.txt

@@ -19,7 +19,9 @@ set(component_tests_sources
     ../../code/bbcode/Smilie.cpp
     ../../code/bbcode/TableBBCode.cpp
     ../../code/filters/FilterUser.cpp
+    ../../code/paths.cpp
     ../../libstriezel/common/StringUtils.cpp
+    ../../libstriezel/filesystem/directory.cpp
     ../../libstriezel/hash/sha256/MessageSource.cpp
     ../../libstriezel/hash/sha256/sha256.cpp
     ../../libstriezel/zlib/CompressionFunctions.cpp
@@ -37,6 +39,7 @@ set(component_tests_sources
     bbcode/TableBBCode.cpp
     filter/FilterUser.cpp
     names_to_controlsequences.cpp
+    paths.cpp
     main.cpp)
 
 if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang")

tests/components/component_tests.cbp

@@ -65,8 +65,12 @@
 		<Unit filename="../../code/filters/Filter.hpp" />
 		<Unit filename="../../code/filters/FilterUser.cpp" />
 		<Unit filename="../../code/filters/FilterUser.hpp" />
+		<Unit filename="../../code/paths.cpp" />
+		<Unit filename="../../code/paths.hpp" />
 		<Unit filename="../../libstriezel/common/StringUtils.cpp" />
 		<Unit filename="../../libstriezel/common/StringUtils.hpp" />
+		<Unit filename="../../libstriezel/filesystem/directory.cpp" />
+		<Unit filename="../../libstriezel/filesystem/directory.hpp" />
 		<Unit filename="../../libstriezel/hash/sha256/MessageSource.cpp" />
 		<Unit filename="../../libstriezel/hash/sha256/MessageSource.hpp" />
 		<Unit filename="../../libstriezel/hash/sha256/sha256.cpp" />
@@ -89,6 +93,7 @@
 		<Unit filename="filter/FilterUser.cpp" />
 		<Unit filename="main.cpp" />
 		<Unit filename="names_to_controlsequences.cpp" />
+		<Unit filename="paths.cpp" />
 		<Extensions>
 			<lib_finder disable_auto="1" />
 		</Extensions>