git.sesse.net Git - casparcg/blob - common/log.cpp

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG is free software: you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation, either version 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #include "stdafx.h"
  23
  24 #include "log.h"
  25
  26 #include "os/threading.h"
  27 #include "except.h"
  28 #include "utf.h"
  29
  30 #include <ios>
  31 #include <iomanip>
  32 #include <string>
  33 #include <ostream>
  34
  35 #include <boost/shared_ptr.hpp>
  36 #include <boost/make_shared.hpp>
  37 #include <boost/filesystem/convenience.hpp>
  38 #include <boost/date_time/posix_time/posix_time.hpp>
  39 #include <boost/algorithm/string.hpp>
  40
  41 #include <boost/log/core.hpp>
  42 #include <boost/log/trivial.hpp>
  43 #include <boost/log/expressions.hpp>
  44
  45 #include <boost/log/sinks/text_file_backend.hpp>
  46 #include <boost/log/sinks/text_ostream_backend.hpp>
  47 #include <boost/log/sinks/sync_frontend.hpp>
  48 #include <boost/log/sinks/async_frontend.hpp>
  49 #include <boost/log/core/record.hpp>
  50 #include <boost/log/attributes/attribute_value.hpp>
  51 #include <boost/log/attributes/function.hpp>
  52 #include <boost/log/utility/setup/common_attributes.hpp>
  53
  54 #include <boost/core/null_deleter.hpp>
  55 #include <boost/lambda/lambda.hpp>
  56 #include <boost/bind.hpp>
  57 #include <boost/lexical_cast.hpp>
  58 #include <boost/property_tree/ptree.hpp>
  59 #include <boost/thread/mutex.hpp>
  60
  61 #include <tbb/atomic.h>
  62
  63 namespace caspar { namespace log {
  64
  65 using namespace boost;
  66
  67 template<typename Stream>
  68 void append_timestamp(Stream& stream, boost::posix_time::ptime timestamp)
  69 {
  70         auto date = timestamp.date();
  71         auto time = timestamp.time_of_day();
  72         auto milliseconds = time.fractional_seconds() / 1000; // microseconds to milliseconds
  73
  74         std::wstringstream buffer;
  75
  76         buffer
  77                 << std::setfill(L'0')
  78                 << L"["
  79                 << std::setw(4) << date.year() << L"-" << std::setw(2) << date.month().as_number() << "-" << std::setw(2) << date.day().as_number()
  80                 << L" "
  81                 << std::setw(2) << time.hours() << L":" << std::setw(2) << time.minutes() << L":" << std::setw(2) << time.seconds()
  82                 << L"."
  83                 << std::setw(3) << milliseconds
  84                 << L"] ";
  85
  86         stream << buffer.str();
  87 }
  88
  89 class column_writer
  90 {
  91         tbb::atomic<int> column_width_;
  92 public:
  93         column_writer(int initial_width = 0)
  94         {
  95                 column_width_ = initial_width;
  96         }
  97
  98         template<typename Stream, typename Val>
  99         void write(Stream& out, const Val& value)
 100         {
 101                 std::wstring to_string = boost::lexical_cast<std::wstring>(value);
 102                 int length = static_cast<int>(to_string.size());
 103                 int read_width;
 104
 105                 while ((read_width = column_width_) < length && column_width_.compare_and_swap(length, read_width) != read_width);
 106                 read_width = column_width_;
 107
 108                 out << L"[" << to_string << L"] ";
 109
 110                 for (int n = 0; n < read_width - length; ++n)
 111                         out << L" ";
 112         }
 113 };
 114
 115 template<typename Stream>
 116 void my_formatter(bool print_all_characters, const boost::log::record_view& rec, Stream& strm)
 117 {
 118         static column_writer thread_id_column;
 119         static column_writer severity_column(7);
 120         namespace expr = boost::log::expressions;
 121
 122         std::wstringstream pre_message_stream;
 123         append_timestamp(pre_message_stream, boost::log::extract<boost::posix_time::ptime>("TimestampMillis", rec).get());
 124         thread_id_column.write(pre_message_stream, boost::log::extract<std::int64_t>("NativeThreadId", rec));
 125         severity_column.write(pre_message_stream, boost::log::extract<boost::log::trivial::severity_level>("Severity", rec));
 126
 127         auto pre_message = pre_message_stream.str();
 128
 129         strm << pre_message;
 130
 131         auto line_break_replacement = L"\n" + pre_message;
 132
 133         if (print_all_characters)
 134         {
 135                 strm << boost::replace_all_copy(rec[expr::message].get<std::wstring>(), "\n", line_break_replacement);
 136         }
 137         else
 138         {
 139                 strm << boost::replace_all_copy(replace_nonprintable_copy(rec[expr::message].get<std::wstring>(), L'?'), L"\n", line_break_replacement);
 140         }
 141 }
 142
 143 namespace internal{
 144
 145 void init()
 146 {
 147         boost::log::add_common_attributes();
 148         boost::log::core::get()->add_global_attribute("NativeThreadId", boost::log::attributes::make_function(&get_current_thread_id));
 149         boost::log::core::get()->add_global_attribute("TimestampMillis", boost::log::attributes::make_function([]
 150         {
 151                 return boost::posix_time::microsec_clock::local_time();
 152         }));
 153         typedef boost::log::sinks::asynchronous_sink<boost::log::sinks::wtext_ostream_backend> stream_sink_type;
 154
 155         auto stream_backend = boost::make_shared<boost::log::sinks::wtext_ostream_backend>();
 156         stream_backend->add_stream(boost::shared_ptr<std::wostream>(&std::wcout, boost::null_deleter()));
 157         stream_backend->auto_flush(true);
 158
 159         auto stream_sink = boost::make_shared<stream_sink_type>(stream_backend);
 160         // Never log calltrace to console. The terminal is too slow, so the log queue will build up faster than consumed.
 161         stream_sink->set_filter(category != log_category::calltrace);
 162
 163         bool print_all_characters = false;
 164         stream_sink->set_formatter(boost::bind(&my_formatter<boost::log::wformatting_ostream>, print_all_characters, _1, _2));
 165
 166         boost::log::core::get()->add_sink(stream_sink);
 167 }
 168
 169 std::string current_exception_diagnostic_information()
 170 {
 171         auto e = boost::current_exception_cast<const char*>();
 172
 173         if (e)
 174                 return std::string("[char *] = ") + *e + "\n";
 175         else
 176                 return boost::current_exception_diagnostic_information();
 177 }
 178
 179 }
 180
 181 void add_file_sink(const std::wstring& file, const boost::log::filter& filter)
 182 {
 183         typedef boost::log::sinks::synchronous_sink<boost::log::sinks::text_file_backend> file_sink_type;
 184
 185         try
 186         {
 187                 if (!boost::filesystem::is_directory(boost::filesystem::path(file).parent_path()))
 188                         CASPAR_THROW_EXCEPTION(directory_not_found());
 189
 190                 auto file_sink = boost::make_shared<file_sink_type>(
 191                         boost::log::keywords::file_name = (file + L"_%Y-%m-%d.log"),
 192                         boost::log::keywords::time_based_rotation = boost::log::sinks::file::rotation_at_time_point(0, 0, 0),
 193                         boost::log::keywords::auto_flush = true,
 194                         boost::log::keywords::open_mode = std::ios::app
 195                         );
 196
 197                 bool print_all_characters = true;
 198
 199                 file_sink->set_formatter(boost::bind(&my_formatter<boost::log::formatting_ostream>, print_all_characters, _1, _2));
 200                 file_sink->set_filter(filter);
 201                 boost::log::core::get()->add_sink(file_sink);
 202         }
 203         catch (...)
 204         {
 205                 std::wcerr << L"Failed to Setup File Logging Sink" << std::endl << std::endl;
 206         }
 207 }
 208
 209 std::shared_ptr<void> add_preformatted_line_sink(std::function<void(std::string line)> formatted_line_sink)
 210 {
 211         class sink_backend : public boost::log::sinks::basic_formatted_sink_backend<char>
 212         {
 213                 std::function<void(std::string line)> formatted_line_sink_;
 214         public:
 215                 sink_backend(std::function<void(std::string line)> formatted_line_sink)
 216                         : formatted_line_sink_(std::move(formatted_line_sink))
 217                 {
 218                 }
 219
 220                 void consume(const boost::log::record_view& rec, const std::string& formatted_message)
 221                 {
 222                         try
 223                         {
 224                                 formatted_line_sink_(formatted_message);
 225                         }
 226                         catch (...)
 227                         {
 228                                 std::cerr << "[sink_backend] Error while consuming formatted message: " << formatted_message << std::endl << std::endl;
 229                         }
 230                 }
 231         };
 232
 233         typedef boost::log::sinks::synchronous_sink<sink_backend> sink_type;
 234
 235         auto sink = boost::make_shared<sink_type>(std::move(formatted_line_sink));
 236         bool print_all_characters = true;
 237
 238         sink->set_formatter(boost::bind(&my_formatter<boost::log::formatting_ostream>, print_all_characters, _1, _2));
 239         sink->set_filter(category != log_category::calltrace);
 240
 241         boost::log::core::get()->add_sink(sink);
 242
 243         return std::shared_ptr<void>(nullptr, [=](void*)
 244         {
 245                 boost::log::core::get()->remove_sink(sink);
 246         });
 247 }
 248
 249 boost::mutex& get_filter_mutex()
 250 {
 251         static boost::mutex instance;
 252
 253         return instance;
 254 }
 255
 256 boost::log::trivial::severity_level& get_level()
 257 {
 258         static boost::log::trivial::severity_level instance;
 259
 260         return instance;
 261 }
 262
 263 log_category& get_disabled_categories()
 264 {
 265         static log_category instance = log_category::calltrace;
 266
 267         return instance;
 268 }
 269
 270 void set_log_filter()
 271 {
 272         auto severity_filter            = boost::log::trivial::severity >= get_level();
 273         auto disabled_categories        = get_disabled_categories();
 274
 275         boost::log::core::get()->set_filter([=](const boost::log::attribute_value_set& attributes)
 276         {
 277                 return severity_filter(attributes)
 278                         && static_cast<int>(disabled_categories & attributes["Channel"].extract<log_category>().get()) == 0;
 279         });
 280 }
 281
 282 void set_log_level(const std::wstring& lvl)
 283 {
 284         boost::lock_guard<boost::mutex> lock(get_filter_mutex());
 285
 286         if (boost::iequals(lvl, L"trace"))
 287                 get_level() = boost::log::trivial::trace;
 288         else if (boost::iequals(lvl, L"debug"))
 289                 get_level() = boost::log::trivial::debug;
 290         else if (boost::iequals(lvl, L"info"))
 291                 get_level() = boost::log::trivial::info;
 292         else if (boost::iequals(lvl, L"warning"))
 293                 get_level() = boost::log::trivial::warning;
 294         else if (boost::iequals(lvl, L"error"))
 295                 get_level() = boost::log::trivial::error;
 296         else if (boost::iequals(lvl, L"fatal"))
 297                 get_level() = boost::log::trivial::fatal;
 298
 299         set_log_filter();
 300 }
 301
 302 void set_log_category(const std::wstring& cat, bool enabled)
 303 {
 304         log_category category_to_set;
 305
 306         if (boost::iequals(cat, L"calltrace"))
 307                 category_to_set = log_category::calltrace;
 308         else if (boost::iequals(cat, L"communication"))
 309                 category_to_set = log_category::communication;
 310         else
 311                 return; // Ignore
 312
 313         boost::lock_guard<boost::mutex> lock(get_filter_mutex());
 314         auto& disabled_categories = get_disabled_categories();
 315
 316         if (enabled)
 317                 disabled_categories &= ~category_to_set;
 318         else
 319                 disabled_categories |= category_to_set;
 320
 321         set_log_filter();
 322 }
 323
 324 void print_child(
 325                 boost::log::trivial::severity_level level,
 326                 const std::wstring& indent,
 327                 const std::wstring& elem,
 328                 const boost::property_tree::wptree& tree)
 329 {
 330         auto& data = tree.data();
 331
 332         if (!data.empty())
 333                 BOOST_LOG_STREAM_WITH_PARAMS(log::logger::get(), (boost::log::keywords::severity = level)) << indent << elem << L" " << replace_nonprintable_copy(data, L'?');
 334         else if (tree.size() == 0)
 335                 BOOST_LOG_STREAM_WITH_PARAMS(log::logger::get(), (boost::log::keywords::severity = level)) << indent << elem;
 336
 337         for (auto& child : tree)
 338                 print_child(level, indent + (elem.empty() ? L"" : elem + L"."), child.first, child.second);
 339 }
 340
 341 const char* remove_source_prefix(const char* file)
 342 {
 343         auto found = boost::ifind_first(file, get_source_prefix().c_str());
 344
 345         if (found)
 346                 return found.end();
 347         else
 348                 return file;
 349 }
 350
 351 }}