Merge pull request #197 from Salanto/area_sorted_logging

Implement Area-Sorted Logging

bin/config_sample/config.ini

@@ -39,9 +39,10 @@ modpass=changeme
 ; This is only used for modcall logging, or if the webhook_sendfile is enabled.
 logbuffer=500
 
-; The server logging type. Valid values here are "modcall" and "full". 
+; The server logging type. Valid values here are "modcall","full" and "fullarea". 
 ; Modcall logging will only save an area log file if a modcall is sent. 
 ; Full logging will log every event in every area, and will output to a new file every day.
+; FullArea logging will log every event in every area, seperating them into individual files and output to a new one every day.
 logging=modcall
 
 ; The maximum number of statements that can be recorded in the testimony recorder.

core/include/area_data.h

@@ -766,62 +766,6 @@ class AreaData : public QObject {
      */
     void toggleMusic();
 
-    /**
-     * @brief Logs a packet in the area's logger.
-     *
-     * @details Logs IC, OOC and modcall packets. Anything else is discarded.
-     *
-     * This function is a convenience function over the Logger's log functions.
-     *
-     * If you wish to log a login attempt, use logLogin() instead.
-     *
-     * @param f_clientName_r The showname of the packet sender's character.
-     * @param f_clientIpid_r The IPID of the packet sender.
-     * @param f_packet_r The packet that was sent.
-     */
-    void log(const QString& f_clientName_r, const QString& f_clientIpid_r, const AOPacket& f_packet_r) const;
-
-    /**
-     * @brief Logs a moderator login attempt.
-     *
-     * @details This is not a duplicated function! When a client uses the `/login` command to log in, the command call
-     * itself is logged with logCmd(), but the outcome of that call is logged here.
-     *
-     * If there was a way to login *without* the command, only this would be logged.
-     *
-     * @param f_clientName_r The showname of the login attempt sender's character.
-     * @param f_clientIpid_r The IPID of the client attempting login.
-     * @param f_success The outcome of the login attempt.
-     * @param f_modname_r The moderator name the client attempted to log in with.
-     */
-    void logLogin(const QString &f_clientName_r, const QString &f_clientIpid_r, bool f_success, const QString& f_modname_r) const;
-
-    /**
-     * @brief Logs a command in the area logger.
-     *
-     * @details When a client sends any packet containing `/`, it is sent to this function instead of log().
-     *
-     * @param f_clientName_r The showname of the command sender's character.
-     * @param f_clientIpid_r The IPID of the command sender.
-     * @param f_command_r The command that was sent.
-     * @param f_cmdArgs_r The arguments of the command
-     */
-    void logCmd(const QString& f_clientName_r, const QString& f_clientIpid_r, const QString& f_command_r, const QStringList& f_cmdArgs_r) const;
-
-    /**
-     * @brief Convenience function over Logger::flush().
-     */
-    void flushLogs() const;
-
-    /**
-     * @brief Returns a copy of the underlying logger's buffer.
-     *
-     * @return See short description.
-     *
-     * @see #m_ignoreBgList
-     */
-    QQueue<QString> buffer() const;
-
     /**
      * @brief Returns whether the BG list is ignored in this araa.
      *

core/include/data_types.h

@@ -42,6 +42,7 @@ public:
     enum class LogType {
         MODCALL,
         FULL,
+        FULLAREA
     };
     Q_ENUM(LogType)
 };

core/include/logger/writer_full.h

@@ -50,6 +50,13 @@ public:
      */
     void flush(const QString f_entry);
 
+    /**
+     * @brief Writes log entry into area seperated logfiles.
+     * @param Preformatted QString which will be written into the logfile
+     * @param Area name of the target logfile.
+     */
+    void flush(const QString f_entry, const QString f_areaName);
+
 private:
     /**
      * @brief Filename of the logfile used. This will always be the time the server starts up.

core/src/logger/u_logger.cpp

@@ -25,6 +25,7 @@ ULogger::ULogger(QObject* parent) :
             writerModcall = new WriterModcall;
             break;
         case DataTypes::LogType::FULL :
+        case DataTypes::LogType::FULLAREA :
             writerFull = new WriterFull;
             break;
     }
@@ -37,6 +38,7 @@ ULogger::~ULogger()
             writerModcall->deleteLater();
             break;
         case DataTypes::LogType::FULL :
+        case DataTypes::LogType::FULLAREA :
             writerFull->deleteLater();
             break;
     }
@@ -148,6 +150,9 @@ void ULogger::updateAreaBuffer(const QString& f_areaName, const QString& f_logEn
     if (ConfigManager::loggingType() == DataTypes::LogType::FULL){
         writerFull->flush(f_logEntry);
     }
+    if (ConfigManager::loggingType() == DataTypes::LogType::FULLAREA) {
+        writerFull->flush(f_logEntry, f_areaName);
+    }
 }
 
 QQueue<QString> ULogger::buffer(const QString& f_areaName)

core/src/logger/writer_full.cpp

@@ -30,6 +30,17 @@ void WriterFull::flush(const QString f_entry)
 {
     l_logfile.setFileName(QString("logs/%1.log").arg(QDate::currentDate().toString("yyyy-MM-dd")));
 
+    if (l_logfile.open(QIODevice::WriteOnly | QIODevice::Append)) {
+        QTextStream file_stream(&l_logfile);
+        file_stream << f_entry;
+    }
+    l_logfile.close();
+}
+
+void WriterFull::flush(const QString f_entry, const QString f_areaName)
+{
+    l_logfile.setFileName(QString("logs/%1_%2.log").arg(f_areaName, QDate::currentDate().toString("yyyy-MM-dd")));
+
     if (l_logfile.open(QIODevice::WriteOnly | QIODevice::Append)) {
         QTextStream file_stream(&l_logfile);
         file_stream << f_entry;