1 /* <!-- copyright */
2 /*
3  * aria2 - The high speed download utility
4  *
5  * Copyright (C) 2006 Tatsuhiro Tsujikawa
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  * In addition, as a special exception, the copyright holders give
22  * permission to link the code of portions of this program with the
23  * OpenSSL library under certain conditions as described in each
24  * individual source file, and distribute linked combinations
25  * including the two.
26  * You must obey the GNU General Public License in all respects
27  * for all of the code used other than OpenSSL.  If you modify
28  * file(s) with this exception, you may extend this exception to your
29  * version of the file(s), but you are not obligated to do so.  If you
30  * do not wish to do so, delete this exception statement from your
31  * version.  If you delete this exception statement from all source
32  * files in the program, then also delete it here.
33  */
34 /* copyright --> */
35 #ifndef D_LOG_FACTORY_H
36 #define D_LOG_FACTORY_H
37 
38 #include "common.h"
39 
40 #include <string>
41 #include <memory>
42 
43 #include "Logger.h"
44 
45 namespace aria2 {
46 
47 class LogFactory {
48 private:
49   static std::string filename_;
50   static std::shared_ptr<Logger> logger_;
51   static bool consoleOutput_;
52   static Logger::LEVEL logLevel_;
53   static Logger::LEVEL consoleLogLevel_;
54   static bool colorOutput_;
55 
56   static void openLogger(const std::shared_ptr<Logger>& logger);
57 
58   static void adjustDependentLevels();
59 
60   LogFactory();
61 
62 public:
63   /**
64    * Get logger instance. Returned logger is singleton.
65    * This function is not thread-safe.
66    */
67   static const std::shared_ptr<Logger>& getInstance();
68 
69   /**
70    * Set a filename to write log. If name is "-", log is written to
71    * stdout. If name is "", log is not written to file.
72    */
73   static void setLogFile(const std::string& name);
74 
75   /**
76    * Set flag whether the log is printed in console.
77    * If f is false, log is not printed in console.
78    */
setConsoleOutput(bool f)79   static void setConsoleOutput(bool f) { consoleOutput_ = f; }
80 
81   /**
82    * Set log level to output to file.
83    */
84   static void setLogLevel(Logger::LEVEL level);
85 
86   /**
87    * Set log level to output to file by string represention of log
88    * level.  Possible values are: debug, info, notice, warn, error
89    */
90   static void setLogLevel(const std::string& level);
91 
92   /**
93    * Set log level to output to console.
94    */
95   static void setConsoleLogLevel(Logger::LEVEL level);
96 
97   /**
98    * Set log level to output to console by string represention of log
99    * level.  Possible values are: debug, info, notice, warn, error
100    */
101   static void setConsoleLogLevel(const std::string& level);
102 
103   /**
104    * Enable color output if |enabled| is true. By default, color
105    * output is enabled for terminal.
106    */
107   static void setColorOutput(bool enabled);
108 
109   /**
110    * Releases used resources
111    */
112   static void release();
113 
114   static void reconfigure();
115 };
116 
117 #define A2_LOG_DEBUG_ENABLED                                                   \
118   aria2::LogFactory::getInstance()->levelEnabled(Logger::A2_DEBUG)
119 
120 #define A2_LOG(level, msg)                                                     \
121   {                                                                            \
122     const std::shared_ptr<aria2::Logger>& logger =                             \
123         aria2::LogFactory::getInstance();                                      \
124     if (logger->levelEnabled(level))                                           \
125       logger->log(level, __FILE__, __LINE__, msg);                             \
126   }
127 #define A2_LOG_EX(level, msg, ex)                                              \
128   {                                                                            \
129     const std::shared_ptr<aria2::Logger>& logger =                             \
130         aria2::LogFactory::getInstance();                                      \
131     if (logger->levelEnabled(level))                                           \
132       logger->log(level, __FILE__, __LINE__, msg, ex);                         \
133   }
134 
135 #define A2_LOG_DEBUG(msg) A2_LOG(Logger::A2_DEBUG, msg)
136 #define A2_LOG_DEBUG_EX(msg, ex) A2_LOG_EX(Logger::A2_DEBUG, msg, ex)
137 
138 #define A2_LOG_INFO(msg) A2_LOG(Logger::A2_INFO, msg)
139 #define A2_LOG_INFO_EX(msg, ex) A2_LOG_EX(Logger::A2_INFO, msg, ex)
140 
141 #define A2_LOG_NOTICE(msg) A2_LOG(Logger::A2_NOTICE, msg)
142 #define A2_LOG_NOTICE_EX(msg, ex) A2_LOG_EX(Logger::A2_NOTICE, msg, ex)
143 
144 #define A2_LOG_WARN(msg) A2_LOG(Logger::A2_WARN, msg)
145 #define A2_LOG_WARN_EX(msg, ex) A2_LOG_EX(Logger::A2_WARN, msg, ex)
146 
147 #define A2_LOG_ERROR(msg) A2_LOG(Logger::A2_ERROR, msg)
148 #define A2_LOG_ERROR_EX(msg, ex) A2_LOG_EX(Logger::A2_ERROR, msg, ex)
149 
150 } // namespace aria2
151 
152 #endif // D_LOG_FACTORY_H
153