juce/source/src/core/juce_FileLogger.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #include "juce_StandardHeader.h"
  27
  28 BEGIN_JUCE_NAMESPACE
  29
  30 #include "juce_FileLogger.h"
  31 #include "../io/files/juce_FileOutputStream.h"
  32 #include "../io/files/juce_FileInputStream.h"
  33 #include "../memory/juce_ScopedPointer.h"
  34 #include "juce_SystemStats.h"
  35
  36
  37 //==============================================================================
  38 FileLogger::FileLogger (const File& logFile_,
  39                         const String& welcomeMessage,
  40                         const int maxInitialFileSizeBytes)
  41     : logFile (logFile_)
  42 {
  43     if (maxInitialFileSizeBytes >= 0)
  44         trimFileSize (maxInitialFileSizeBytes);
  45
  46     if (! logFile_.exists())
  47     {
  48         // do this so that the parent directories get created..
  49         logFile_.create();
  50     }
  51
  52     String welcome;
  53     welcome << newLine
  54             << "**********************************************************" << newLine
  55             << welcomeMessage << newLine
  56             << "Log started: " << Time::getCurrentTime().toString (true, true) << newLine;
  57
  58     FileLogger::logMessage (welcome);
  59 }
  60
  61 FileLogger::~FileLogger()
  62 {
  63 }
  64
  65 //==============================================================================
  66 void FileLogger::logMessage (const String& message)
  67 {
  68     DBG (message);
  69
  70     const ScopedLock sl (logLock);
  71
  72     FileOutputStream out (logFile, 256);
  73     out << message << newLine;
  74 }
  75
  76
  77 void FileLogger::trimFileSize (int maxFileSizeBytes) const
  78 {
  79     if (maxFileSizeBytes <= 0)
  80     {
  81         logFile.deleteFile();
  82     }
  83     else
  84     {
  85         const int64 fileSize = logFile.getSize();
  86
  87         if (fileSize > maxFileSizeBytes)
  88         {
  89             ScopedPointer <FileInputStream> in (logFile.createInputStream());
  90             jassert (in != nullptr);
  91
  92             if (in != nullptr)
  93             {
  94                 in->setPosition (fileSize - maxFileSizeBytes);
  95                 String content;
  96
  97                 {
  98                     MemoryBlock contentToSave;
  99                     contentToSave.setSize (maxFileSizeBytes + 4);
 100                     contentToSave.fillWith (0);
 101
 102                     in->read (contentToSave.getData(), maxFileSizeBytes);
 103                     in = nullptr;
 104
 105                     content = contentToSave.toString();
 106                 }
 107
 108                 int newStart = 0;
 109
 110                 while (newStart < fileSize
 111                         && content[newStart] != '\n'
 112                         && content[newStart] != '\r')
 113                     ++newStart;
 114
 115                 logFile.deleteFile();
 116                 logFile.appendText (content.substring (newStart), false, false);
 117             }
 118         }
 119     }
 120 }
 121
 122 //==============================================================================
 123 FileLogger* FileLogger::createDefaultAppLogger (const String& logFileSubDirectoryName,
 124                                                 const String& logFileName,
 125                                                 const String& welcomeMessage,
 126                                                 const int maxInitialFileSizeBytes)
 127 {
 128 #if JUCE_MAC
 129     File logFile ("~/Library/Logs");
 130     logFile = logFile.getChildFile (logFileSubDirectoryName)
 131                      .getChildFile (logFileName);
 132
 133 #else
 134     File logFile (File::getSpecialLocation (File::userApplicationDataDirectory));
 135
 136     if (logFile.isDirectory())
 137     {
 138         logFile = logFile.getChildFile (logFileSubDirectoryName)
 139                          .getChildFile (logFileName);
 140     }
 141 #endif
 142
 143     return new FileLogger (logFile, welcomeMessage, maxInitialFileSizeBytes);
 144 }
 145
 146 END_JUCE_NAMESPACE