Merge branch 'open-eid:master' into master

Author: lauris71

cdoc/CDoc.cpp

@@ -21,9 +21,13 @@
 #include "CDoc2Writer.h"
 #include "CDoc2Reader.h"
 #include "Configuration.h"
-#include "ILogger.h"
 #include "Io.h"
 #include "NetworkBackend.h"
+#include "Utils.h"
+#include "Logger.h"
+
+#include <iostream>
+#include <filesystem>
 
 namespace libcdoc {
 
@@ -71,6 +75,58 @@ getVersion()
     return VERSION_STR;
 }
 
+/**
+ * @brief Console logger
+ *
+ * An ILogger subclass that logs text to console.
+ *
+ * Info messages are logged to cout, all others to cerr.
+ */
+
+class ConsoleLogger : public Logger
+{
+public:
+    virtual void logMessage(LogLevel level, std::string_view file, int line, std::string_view message) override
+    {
+        // We ignore by default the file name and line number, and call LogMessage with the level and message.
+        std::ostream& ofs = (level == LEVEL_INFO) ? std::cout : std::cerr;
+        if (!file.empty()) {
+            ofs << std::filesystem::path(file).filename().string() << ':' << line << " " << message << '\n';
+        } else {
+            ofs << message << '\n';
+        }
+    }
+};
+
+static Logger *
+getDefaultLogger()
+{
+    static ConsoleLogger clogger;
+    return &clogger;
+}
+
+static Logger *sys_logger = nullptr;
+
+void
+setLogger(Logger *logger)
+{
+    sys_logger = logger;
+}
+
+void
+setLogLevel(LogLevel level)
+{
+    Logger *logger = (sys_logger) ? sys_logger : getDefaultLogger();
+    logger->setMinLogLevel(level);
+}
+
+void
+log(LogLevel level, std::string_view file, int line, std::string_view msg)
+{
+    Logger *logger = (sys_logger) ? sys_logger : getDefaultLogger();
+    logger->log(level, file, line, msg);
+}
+
 int
 libcdoc::CDocReader::getCDocFileVersion(DataSource *src)
 {
@@ -139,31 +195,6 @@ libcdoc::CDocReader::createReader(std::istream& ifs, Configuration *conf, Crypto
     return createReader(isrc.release(), true, conf, crypto, network);
 }
 
-#if LIBCDOC_TESTING
-int64_t
-libcdoc::CDocReader::testConfig(std::vector<uint8_t>& dst)
-{
-    LOG_TRACE("CDocReader::testConfig::Native superclass");
-    if (conf) {
-        LOG_DBG("CDocReader::testConfig this={} conf={}", reinterpret_cast<void*>(this), reinterpret_cast<void*>(conf));
-    }
-    LOG_ERROR("CDocReader::testConfig::conf is null");
-    return WORKFLOW_ERROR;
-}
-
-int64_t
-libcdoc::CDocReader::testNetwork(std::vector<std::vector<uint8_t>>& dst)
-{
-    LOG_TRACE("CDocReader::testNetwork::Native superclass");
-    if (network) {
-        LOG_DBG("CDocReader::testNetwork this={} network={}", reinterpret_cast<void*>(this), reinterpret_cast<void*>(network));
-        return network->test(dst);
-    }
-    LOG_ERROR("CDocReader::testNetwork::network is null");
-    return WORKFLOW_ERROR;
-}
-#endif
-
 libcdoc::CDocWriter::CDocWriter(int _version, DataConsumer *_dst, bool take_ownership)
 	: version(_version), dst(_dst), owned(take_ownership)
 {

cdoc/CDoc.h

@@ -24,11 +24,6 @@
 #include <string>
 #include <vector>
 
-#ifndef LIBCDOC_TESTING
-// Remove this in production code
-#define LIBCDOC_TESTING 1
-#endif
-
 namespace libcdoc {
 
 /**
@@ -134,6 +129,50 @@ CDOC_EXPORT std::string getErrorStr(int64_t code);
 
 CDOC_EXPORT std::string getVersion();
 
+// Logging interface
+
+/**
+ * @brief Log-level enumeration to indicate severity of the log message.
+ */
+enum LogLevel
+{
+    /**
+     * @brief Most critical level. Application is about to abort.
+     */
+    LEVEL_FATAL,
+
+    /**
+     * @brief Errors where functionality has failed or an exception have been caught.
+     */
+    LEVEL_ERROR,
+
+    /**
+     * @brief Warnings about validation issues or temporary failures that can be recovered.
+     */
+    LEVEL_WARNING,
+
+    /**
+     * @brief Information that highlights progress or application lifetime events.
+     */
+    LEVEL_INFO,
+
+    /**
+     * @brief Debugging the application behavior from internal events of interest.
+     */
+    LEVEL_DEBUG,
+
+    /**
+     * @brief Most verbose level. Used for development, NOP in production code.
+     */
+    LEVEL_TRACE
+};
+
+class Logger;
+
+CDOC_EXPORT void setLogger(Logger *logger);
+CDOC_EXPORT void setLogLevel(LogLevel level);
+CDOC_EXPORT void log(LogLevel level, std::string_view file, int line, std::string_view msg);
+
 /**
  * @brief A simple container of file name and size
  *

cdoc/CDoc1Reader.cpp

@@ -23,7 +23,6 @@
 #include "Crypto.h"
 #include "CryptoBackend.h"
 #include "DDocReader.h"
-#include "ILogger.h"
 #include "Lock.h"
 #include "Utils.h"
 #include "XmlReader.h"

cdoc/CDoc1Writer.cpp

@@ -20,7 +20,6 @@
 
 #include "Crypto.h"
 #include "DDocWriter.h"
-#include "ILogger.h"
 #include "Recipient.h"
 #include "Utils.h"
 #include "XmlWriter.h"

cdoc/CDoc2Reader.cpp

@@ -22,7 +22,6 @@
 #include "Configuration.h"
 #include "CryptoBackend.h"
 #include "CDoc2.h"
-#include "ILogger.h"
 #include "KeyShares.h"
 #include "Lock.h"
 #include "NetworkBackend.h"

cdoc/CDoc2Writer.cpp

@@ -21,7 +21,6 @@
 #include "Configuration.h"
 #include "Crypto.h"
 #include "CDoc2.h"
-#include "ILogger.h"
 #include "NetworkBackend.h"
 #include "Recipient.h"
 #include "Tar.h"

cdoc/CDocCipher.cpp

@@ -19,7 +19,6 @@
 #include "CDocCipher.h"
 #include "CDocReader.h"
 #include "CDoc2.h"
-#include "ILogger.h"
 #include "Lock.h"
 #include "NetworkBackend.h"
 #include "PKCS11Backend.h"

cdoc/CDocReader.h

@@ -200,10 +200,6 @@ class CDOC_EXPORT CDocReader {
      */
     static CDocReader *createReader(std::istream& ifs, Configuration *conf, CryptoBackend *crypto, NetworkBackend *network);
 
-#if LIBCDOC_TESTING
-    virtual int64_t testConfig(std::vector<uint8_t>& dst);
-    virtual int64_t testNetwork(std::vector<std::vector<uint8_t>>& dst);
-#endif
 protected:
 	explicit CDocReader(int _version) : version(_version) {};
 

cdoc/CMakeLists.txt

@@ -15,8 +15,7 @@ set(PUBLIC_HEADERS
     CryptoBackend.h
     NetworkBackend.h
     PKCS11Backend.h
-    ILogger.h
-    ConsoleLogger.h
+    Logger.h
 )
 
 add_library(cdoc_ver INTERFACE)
@@ -38,7 +37,6 @@ add_library(cdoc
     CryptoBackend.cpp
     NetworkBackend.cpp
     PKCS11Backend.cpp
-    LogEngine.cpp
     $<$<PLATFORM_ID:Windows>:WinBackend.cpp>
     Certificate.cpp Certificate.h
     Crypto.cpp Crypto.h

cdoc/Configuration.cpp

@@ -20,7 +20,6 @@
 
 #include "Configuration.h"
 
-#include "ILogger.h"
 #include "Utils.h"
 
 #include "json/picojson/picojson.h"