file_helper-inl.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. #pragma once
  4. #ifndef SPDLOG_HEADER_ONLY
  5. #include <spdlog/details/file_helper.h>
  6. #endif
  7. #include <spdlog/common.h>
  8. #include <spdlog/details/os.h>
  9. #include <cerrno>
  10. #include <chrono>
  11. #include <cstdio>
  12. #include <string>
  13. #include <thread>
  14. #include <tuple>
  15. namespace spdlog {
  16. namespace details {
  17. SPDLOG_INLINE file_helper::file_helper(const file_event_handlers &event_handlers)
  18. : event_handlers_(event_handlers) {}
  19. SPDLOG_INLINE file_helper::~file_helper() { close(); }
  20. SPDLOG_INLINE void file_helper::open(const filename_t &fname, bool truncate) {
  21. close();
  22. filename_ = fname;
  23. auto *mode = SPDLOG_FILENAME_T("ab");
  24. auto *trunc_mode = SPDLOG_FILENAME_T("wb");
  25. if (event_handlers_.before_open) {
  26. event_handlers_.before_open(filename_);
  27. }
  28. for (int tries = 0; tries < open_tries_; ++tries) {
  29. // create containing folder if not exists already.
  30. os::create_dir(os::dir_name(fname));
  31. if (truncate) {
  32. // Truncate by opening-and-closing a tmp file in "wb" mode, always
  33. // opening the actual log-we-write-to in "ab" mode, since that
  34. // interacts more politely with eternal processes that might
  35. // rotate/truncate the file underneath us.
  36. std::FILE *tmp;
  37. if (os::fopen_s(&tmp, fname, trunc_mode)) {
  38. continue;
  39. }
  40. std::fclose(tmp);
  41. }
  42. if (!os::fopen_s(&fd_, fname, mode)) {
  43. if (event_handlers_.after_open) {
  44. event_handlers_.after_open(filename_, fd_);
  45. }
  46. return;
  47. }
  48. details::os::sleep_for_millis(open_interval_);
  49. }
  50. throw_spdlog_ex("Failed opening file " + os::filename_to_str(filename_) + " for writing",
  51. errno);
  52. }
  53. SPDLOG_INLINE void file_helper::reopen(bool truncate) {
  54. if (filename_.empty()) {
  55. throw_spdlog_ex("Failed re opening file - was not opened before");
  56. }
  57. this->open(filename_, truncate);
  58. }
  59. SPDLOG_INLINE void file_helper::flush() {
  60. if (std::fflush(fd_) != 0) {
  61. throw_spdlog_ex("Failed flush to file " + os::filename_to_str(filename_), errno);
  62. }
  63. }
  64. SPDLOG_INLINE void file_helper::sync() {
  65. if (!os::fsync(fd_)) {
  66. throw_spdlog_ex("Failed to fsync file " + os::filename_to_str(filename_), errno);
  67. }
  68. }
  69. SPDLOG_INLINE void file_helper::close() {
  70. if (fd_ != nullptr) {
  71. if (event_handlers_.before_close) {
  72. event_handlers_.before_close(filename_, fd_);
  73. }
  74. std::fclose(fd_);
  75. fd_ = nullptr;
  76. if (event_handlers_.after_close) {
  77. event_handlers_.after_close(filename_);
  78. }
  79. }
  80. }
  81. SPDLOG_INLINE void file_helper::write(const memory_buf_t &buf) {
  82. if (fd_ == nullptr) return;
  83. size_t msg_size = buf.size();
  84. auto data = buf.data();
  85. if (std::fwrite(data, 1, msg_size, fd_) != msg_size) {
  86. throw_spdlog_ex("Failed writing to file " + os::filename_to_str(filename_), errno);
  87. }
  88. }
  89. SPDLOG_INLINE size_t file_helper::size() const {
  90. if (fd_ == nullptr) {
  91. throw_spdlog_ex("Cannot use size() on closed file " + os::filename_to_str(filename_));
  92. }
  93. return os::filesize(fd_);
  94. }
  95. SPDLOG_INLINE const filename_t &file_helper::filename() const { return filename_; }
  96. //
  97. // return file path and its extension:
  98. //
  99. // "mylog.txt" => ("mylog", ".txt")
  100. // "mylog" => ("mylog", "")
  101. // "mylog." => ("mylog.", "")
  102. // "/dir1/dir2/mylog.txt" => ("/dir1/dir2/mylog", ".txt")
  103. //
  104. // the starting dot in filenames is ignored (hidden files):
  105. //
  106. // ".mylog" => (".mylog". "")
  107. // "my_folder/.mylog" => ("my_folder/.mylog", "")
  108. // "my_folder/.mylog.txt" => ("my_folder/.mylog", ".txt")
  109. SPDLOG_INLINE std::tuple<filename_t, filename_t> file_helper::split_by_extension(
  110. const filename_t &fname) {
  111. auto ext_index = fname.rfind('.');
  112. // no valid extension found - return whole path and empty string as
  113. // extension
  114. if (ext_index == filename_t::npos || ext_index == 0 || ext_index == fname.size() - 1) {
  115. return std::make_tuple(fname, filename_t());
  116. }
  117. // treat cases like "/etc/rc.d/somelogfile or "/abc/.hiddenfile"
  118. auto folder_index = fname.find_last_of(details::os::folder_seps_filename);
  119. if (folder_index != filename_t::npos && folder_index >= ext_index - 1) {
  120. return std::make_tuple(fname, filename_t());
  121. }
  122. // finally - return a valid base and extension tuple
  123. return std::make_tuple(fname.substr(0, ext_index), fname.substr(ext_index));
  124. }
  125. } // namespace details
  126. } // namespace spdlog