qBittorrent
logger.h
Go to the documentation of this file.
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 #pragma once
30 
31 #include <boost/circular_buffer.hpp>
32 
33 #include <QObject>
34 #include <QReadWriteLock>
35 #include <QString>
36 #include <QtContainerFwd>
37 
38 const int MAX_LOG_MESSAGES = 20000;
39 
40 namespace Log
41 {
42  enum MsgType
43  {
44  ALL = -1,
45  NORMAL = 0x1,
46  INFO = 0x2,
47  WARNING = 0x4,
48  CRITICAL = 0x8 // ERROR is defined by libtorrent and results in compiler error
49  };
50  Q_DECLARE_FLAGS(MsgTypes, MsgType)
51 
52  struct Msg
53  {
54  int id;
56  qint64 timestamp;
57  QString message;
58  };
59 
60  struct Peer
61  {
62  int id;
63  bool blocked;
64  qint64 timestamp;
65  QString ip;
66  QString reason;
67  };
68 }
69 
70 Q_DECLARE_OPERATORS_FOR_FLAGS(Log::MsgTypes)
71 
72 class Logger : public QObject
73 {
74  Q_OBJECT
75  Q_DISABLE_COPY_MOVE(Logger)
76 
77 public:
78  static void initInstance();
79  static void freeInstance();
80  static Logger *instance();
81 
82  void addMessage(const QString &message, const Log::MsgType &type = Log::NORMAL);
83  void addPeer(const QString &ip, bool blocked, const QString &reason = {});
84  QVector<Log::Msg> getMessages(int lastKnownId = -1) const;
85  QVector<Log::Peer> getPeers(int lastKnownId = -1) const;
86 
87 signals:
88  void newLogMessage(const Log::Msg &message);
89  void newLogPeer(const Log::Peer &peer);
90 
91 private:
92  Logger();
93  ~Logger() = default;
94 
95  static Logger *m_instance;
96  boost::circular_buffer_space_optimized<Log::Msg> m_messages;
97  boost::circular_buffer_space_optimized<Log::Peer> m_peers;
98  mutable QReadWriteLock m_lock;
99  int m_msgCounter = 0;
100  int m_peerCounter = 0;
101 };
102 
103 // Helper function
104 void LogMsg(const QString &message, const Log::MsgType &type = Log::NORMAL);
Definition: logger.h:73
boost::circular_buffer_space_optimized< Log::Peer > m_peers
Definition: logger.h:97
static Logger * m_instance
Definition: logger.h:95
QReadWriteLock m_lock
Definition: logger.h:98
void newLogMessage(const Log::Msg &message)
boost::circular_buffer_space_optimized< Log::Msg > m_messages
Definition: logger.h:96
~Logger()=default
void newLogPeer(const Log::Peer &peer)
void LogMsg(const QString &message, const Log::MsgType &type=Log::NORMAL)
Definition: logger.cpp:125
const int MAX_LOG_MESSAGES
Definition: logger.h:38
Definition: filelogger.h:36
MsgType
Definition: logger.h:43
@ WARNING
Definition: logger.h:47
@ NORMAL
Definition: logger.h:45
@ CRITICAL
Definition: logger.h:48
@ INFO
Definition: logger.h:46
@ ALL
Definition: logger.h:44
QString message
Definition: logger.h:57
MsgType type
Definition: logger.h:55
qint64 timestamp
Definition: logger.h:56
int id
Definition: logger.h:54
QString ip
Definition: logger.h:65
QString reason
Definition: logger.h:66
qint64 timestamp
Definition: logger.h:64
int id
Definition: logger.h:62
bool blocked
Definition: logger.h:63