src/base/logger.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015  sledgehammer999 <hammered999@gmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #ifndef LOGGER_H
  30 #define LOGGER_H
  31
  32 #include <boost/circular_buffer.hpp>
  33
  34 #include <QObject>
  35 #include <QReadWriteLock>
  36 #include <QString>
  37 #include <QVector>
  38
  39 const int MAX_LOG_MESSAGES = 20000;
  40
  41 namespace Log
  42 {
  43     enum MsgType
  44     {
  45         ALL = -1,
  46         NORMAL = 0x1,
  47         INFO = 0x2,
  48         WARNING = 0x4,
  49         CRITICAL = 0x8 // ERROR is defined by libtorrent and results in compiler error
  50     };
  51     Q_DECLARE_FLAGS(MsgTypes, MsgType)
  52
  53     struct Msg
  54     {
  55         int id;
  56         MsgType type;
  57         qint64 timestamp;
  58         QString message;
  59     };
  60
  61     struct Peer
  62     {
  63         int id;
  64         bool blocked;
  65         qint64 timestamp;
  66         QString ip;
  67         QString reason;
  68     };
  69 }
  70
  71 Q_DECLARE_OPERATORS_FOR_FLAGS(Log::MsgTypes)
  72
  73 class Logger : public QObject
  74 {
  75     Q_OBJECT
  76     Q_DISABLE_COPY(Logger)
  77
  78 public:
  79     static void initInstance();
  80     static void freeInstance();
  81     static Logger *instance();
  82
  83     void addMessage(const QString &message, const Log::MsgType &type = Log::NORMAL);
  84     void addPeer(const QString &ip, bool blocked, const QString &reason = {});
  85     QVector<Log::Msg> getMessages(int lastKnownId = -1) const;
  86     QVector<Log::Peer> getPeers(int lastKnownId = -1) const;
  87
  88 signals:
  89     void newLogMessage(const Log::Msg &message);
  90     void newLogPeer(const Log::Peer &peer);
  91
  92 private:
  93     Logger();
  94     ~Logger() = default;
  95
  96     static Logger *m_instance;
  97     boost::circular_buffer_space_optimized<Log::Msg> m_messages;
  98     boost::circular_buffer_space_optimized<Log::Peer> m_peers;
  99     mutable QReadWriteLock m_lock;
 100     int m_msgCounter = 0;
 101     int m_peerCounter = 0;
 102 };
 103
 104 // Helper function
 105 void LogMsg(const QString &message, const Log::MsgType &type = Log::NORMAL);
 106
 107 #endif // LOGGER_H