Moved struct file_info_s to class file_info

etr · etr · Mar 3, 2022 · Feb 8, 2022 · Feb 9, 2022 · Feb 10, 2022
commit f329061531b80af37c515da85d7f0781a2e9dec1
diff --git a/examples/file_upload.cpp b/examples/file_upload.cpp
@@ -69,9 +69,9 @@ class file_upload_resource : public httpserver::http_resource {
                 post_response += "</td><td>";
                 post_response += files.first;
                 post_response += "</td><td>";
-                post_response += files.second.file_system_file_name;
+                post_response += files.second.get_file_system_file_name();
                 post_response += "</td><td>";
-                post_response += std::to_string(files.second.file_size);
+                post_response += std::to_string(files.second.get_file_size());
                 post_response += "</td></tr>\n";
             }
         }

diff --git a/src/Makefile.am b/src/Makefile.am
@@ -19,9 +19,9 @@
 AM_CPPFLAGS = -I../ -I$(srcdir)/httpserver/
 METASOURCES = AUTO
 lib_LTLIBRARIES = libhttpserver.la
-libhttpserver_la_SOURCES = string_utilities.cpp webserver.cpp http_utils.cpp http_request.cpp http_response.cpp string_response.cpp basic_auth_fail_response.cpp digest_auth_fail_response.cpp deferred_response.cpp file_response.cpp http_resource.cpp details/http_endpoint.cpp
+libhttpserver_la_SOURCES = string_utilities.cpp webserver.cpp http_utils.cpp file_info.cpp http_request.cpp http_response.cpp string_response.cpp basic_auth_fail_response.cpp digest_auth_fail_response.cpp deferred_response.cpp file_response.cpp http_resource.cpp details/http_endpoint.cpp
 noinst_HEADERS = httpserver/string_utilities.hpp httpserver/details/modded_request.hpp gettext.h
-nobase_include_HEADERS = httpserver.hpp httpserver/create_webserver.hpp httpserver/webserver.hpp httpserver/http_utils.hpp httpserver/details/http_endpoint.hpp httpserver/http_request.hpp httpserver/http_response.hpp httpserver/http_resource.hpp httpserver/string_response.hpp httpserver/basic_auth_fail_response.hpp httpserver/digest_auth_fail_response.hpp httpserver/deferred_response.hpp httpserver/file_response.hpp
+nobase_include_HEADERS = httpserver.hpp httpserver/create_webserver.hpp httpserver/webserver.hpp httpserver/http_utils.hpp httpserver/file_info.hpp httpserver/details/http_endpoint.hpp httpserver/http_request.hpp httpserver/http_response.hpp httpserver/http_resource.hpp httpserver/string_response.hpp httpserver/basic_auth_fail_response.hpp httpserver/digest_auth_fail_response.hpp httpserver/deferred_response.hpp httpserver/file_response.hpp
 
 AM_CXXFLAGS += -fPIC -Wall
 

diff --git a/src/file_info.cpp b/src/file_info.cpp
@@ -0,0 +1,43 @@
+/*
+     This file is part of libhttpserver
+     Copyright (C) 2011-2019 Sebastiano Merlino
+
+     This library is free software; you can redistribute it and/or
+     modify it under the terms of the GNU Lesser General Public
+     License as published by the Free Software Foundation; either
+     version 2.1 of the License, or (at your option) any later version.
+
+     This library 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
+     Lesser General Public License for more details.
+
+     You should have received a copy of the GNU Lesser General Public
+     License along with this library; if not, write to the Free Software
+     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+     USA
+*/
+
+#include <string.h>
+#include "httpserver/file_info.hpp"
+
+namespace httpserver {
+namespace http {
+
+void file_info::set_file_system_file_name(const std::string file_system_file_name) {
+    _file_system_file_name = file_system_file_name;
+}
+
+void file_info::grow_file_size(size_t additional_file_size) {
+    _file_size += additional_file_size;
+}
+size_t file_info::get_file_size() const {
+    return _file_size;
+}
+const std::string file_info::get_file_system_file_name() const {
+    return _file_system_file_name;
+}
+
+
+}  // namespace http
+}  // namespace httpserver
diff --git a/src/http_request.cpp b/src/http_request.cpp
@@ -127,7 +127,7 @@ const std::map<std::string, std::string, http::arg_comparator> http_request::get
     return arguments;
 }
 
-const file_info_s& http_request::get_or_create_file_info(const std::string& key, const std::string& upload_file_name) {
+http::file_info& http_request::get_or_create_file_info(const std::string& key, const std::string& upload_file_name) {
     return files[key][upload_file_name];
 }
 

diff --git a/src/httpserver.hpp b/src/httpserver.hpp
@@ -31,6 +31,7 @@
 #include "httpserver/http_resource.hpp"
 #include "httpserver/http_response.hpp"
 #include "httpserver/http_utils.hpp"
+#include "httpserver/file_info.hpp"
 #include "httpserver/string_response.hpp"
 #include "httpserver/webserver.hpp"
 

diff --git a/src/httpserver/file_info.hpp b/src/httpserver/file_info.hpp
@@ -0,0 +1,49 @@
+/*
+     This file is part of libhttpserver
+     Copyright (C) 2011-2019 Sebastiano Merlino
+
+     This library is free software; you can redistribute it and/or
+     modify it under the terms of the GNU Lesser General Public
+     License as published by the Free Software Foundation; either
+     version 2.1 of the License, or (at your option) any later version.
+
+     This library 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
+     Lesser General Public License for more details.
+
+     You should have received a copy of the GNU Lesser General Public
+     License along with this library; if not, write to the Free Software
+     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+     USA
+*/
+
+#if !defined (_HTTPSERVER_HPP_INSIDE_) && !defined (HTTPSERVER_COMPILATION)
+#error "Only <httpserver.hpp> or <httpserverpp> can be included directly."
+#endif
+
+#ifndef SRC_HTTPSERVER_FILE_INFO_HPP_
+#define SRC_HTTPSERVER_FILE_INFO_HPP_
+
+#include <string>
+
+namespace httpserver {
+
+namespace http {
+
+class file_info {
+ public:
+     void set_file_system_file_name(const std::string file_system_file_name);
+     void grow_file_size(size_t additional_file_size);
+     size_t get_file_size() const;
+     const std::string get_file_system_file_name() const;
+
+ private:
+     size_t _file_size;
+     std::string _file_system_file_name;
+};
+
+}  // namespace http
+}  // namespace httpserver
+#endif  // SRC_HTTPSERVER_FILE_INFO_HPP_
+
diff --git a/src/httpserver/http_request.hpp b/src/httpserver/http_request.hpp
@@ -40,6 +40,7 @@
 #include <vector>
 
 #include "httpserver/http_utils.hpp"
+#include "httpserver/file_info.hpp"
 
 struct MHD_Connection;
 
@@ -141,13 +142,13 @@ class http_request {
       * @param upload_file_name the file name the user uploaded (this is the identifier for the map entry)
       * @result a file info struct file_info_s
      **/
-     const file_info_s& get_or_create_file_info(const std::string &key, const std::string& upload_file_name);
+     http::file_info& get_or_create_file_info(const std::string &key, const std::string& upload_file_name);
 
      /**
       * Method used to get all files passed with the request.
       * @result result a map<string, file_info_s> > that will be filled with all files
      **/
-     const std::map<std::string, std::map<std::string, file_info_s>> get_files() const {
+     const std::map<std::string, std::map<std::string, http::file_info>> get_files() const {
           return files;
      }
 
@@ -256,7 +257,7 @@ class http_request {
      std::string path;
      std::string method;
      std::map<std::string, std::string, http::arg_comparator> args;
-     std::map<std::string, std::map<std::string, file_info_s>> files;
+     std::map<std::string, std::map<std::string, http::file_info>> files;
      std::string content = "";
      size_t content_size_limit = static_cast<size_t>(-1);
      std::string version;
@@ -318,24 +319,6 @@ class http_request {
          }
      }
 
-     /**
-      * Method used to set the file system file name into the map by key.
-      * @param upload_file_name The file name the user uploaded (identifying the map entry)
-      * @param file_system_file_name The path to the file in the file system (the name may not be the original name depending on configuration of the webserver)
-     **/
-     void set_file_system_file_name(const std::string& key, const std::string& upload_file_name, const std::string& file_system_file_name) {
-         files[key][upload_file_name].file_system_file_name = file_system_file_name;
-     }
-
-     /**
-      * Method used grow the filesize of an entry in the map by key.
-      * @param upload_file_name The file name the user uploaded (identifying the map entry)
-      * @param additional_file_size The additional size as a number to be added to the entry.
-     **/
-     void grow_file_size(const std::string& key, const std::string& upload_file_name, size_t additional_file_size) {
-         files[key][upload_file_name].file_size += additional_file_size;
-     }
-
      /**
       * Method used to set the path requested.
       * @param path The path searched by the request.

diff --git a/src/httpserver/http_utils.hpp b/src/httpserver/http_utils.hpp
@@ -70,11 +70,6 @@ enum file_upload_target_T {
      FILE_UPLOAD_MEMORY_AND_DISK,
 };
 
-struct file_info_s {
-    size_t file_size;
-    std::string file_system_file_name;
-};
-
 typedef void(*unescaper_ptr)(std::string&);
 
 namespace http {

diff --git a/src/webserver.cpp b/src/webserver.cpp
@@ -471,17 +471,17 @@ MHD_Result webserver::post_iterator(void *cls, enum MHD_ValueKind kind,
 
         if (filename && mr->ws->file_upload_target != FILE_UPLOAD_MEMORY_ONLY) {
             // either get the existing file info struct or create a new one in the file map
-            const file_info_s &file_info = mr->dhr->get_or_create_file_info(key, filename);
+            http::file_info &file = mr->dhr->get_or_create_file_info(key, filename);
             // if the file_system_file_name is not filled yet, this is a new entry and the name has to be set
             // (either random or copy of the original filename)
-            if (file_info.file_system_file_name.empty()) {
+            if (file.get_file_system_file_name().empty()) {
                 if (mr->ws->generate_random_filename_on_upload) {
-                    mr->dhr->set_file_system_file_name(key, filename, http_utils::generate_random_upload_filename(mr->ws->post_upload_dir));
+                    file.set_file_system_file_name(http_utils::generate_random_upload_filename(mr->ws->post_upload_dir));
                 } else {
-                    mr->dhr->set_file_system_file_name(key, filename, mr->ws->post_upload_dir + "/" + std::string(filename));
+                    file.set_file_system_file_name(mr->ws->post_upload_dir + "/" + std::string(filename));
                 }
                 // to not append to an already existing file, delete an already existing file
-                unlink(file_info.file_system_file_name.c_str());
+                unlink(file.get_file_system_file_name().c_str());
             }
 
             // if multiple files are uploaded, a different filename indicates the start of a new file, so close the previous one
@@ -495,15 +495,15 @@ MHD_Result webserver::post_iterator(void *cls, enum MHD_ValueKind kind,
                 mr->upload_key = key;
                 mr->upload_filename = filename;
                 mr->upload_ostrm = new std::ofstream();
-                mr->upload_ostrm->open(file_info.file_system_file_name, std::ios::binary | std::ios::app);
+                mr->upload_ostrm->open(file.get_file_system_file_name(), std::ios::binary | std::ios::app);
             }
 
             if (size > 0) {
                 mr->upload_ostrm->write(data, size);
             }
 
             // update the file size in the map
-            mr->dhr->grow_file_size(key, filename, size);
+            file.grow_file_size(size);
         }
         return MHD_YES;
     } catch(const std::exception& e) {