<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Vidalia: LogFile.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_695ba8f8357372e02d38c40b3c6dbe81.html">vidalia</a> » <a class="el" href="dir_b5419f0f3b920f7a66865768144dfe22.html">log</a>
</div>
</div>
<div class="contents">
<h1>LogFile.cpp</h1><a href="_log_file_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">** This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">** LICENSE file, found in the top level directory of this distribution. If you</span>
<a name="l00004"></a>00004 <span class="comment">** did not receive the LICENSE file with this file, you may obtain it from the</span>
<a name="l00005"></a>00005 <span class="comment">** Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">** http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">** may be copied, modified, propagated, or distributed except according to the</span>
<a name="l00008"></a>00008 <span class="comment">** terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** \file LogFile.cpp</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: LogFile.cpp 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Logs messages from Tor to a file</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#include "<a class="code" href="_log_file_8h.html">LogFile.h</a>"</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#include "<a class="code" href="stringutil_8h.html">stringutil.h</a>"</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#include <QDir></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="comment"></span>
<a name="l00024"></a>00024 <span class="comment">/** Default constructor. */</span>
<a name="l00025"></a><a class="code" href="class_log_file.html#ad11b3baf5602575c1396f726d3598188">00025</a> <a class="code" href="class_log_file.html#ad11b3baf5602575c1396f726d3598188">LogFile::LogFile</a>()
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a> = 0;
<a name="l00028"></a>00028 }
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/** Destructor. */</span>
<a name="l00031"></a><a class="code" href="class_log_file.html#a440a7de2dcbb9facb68e56dc47cb9dea">00031</a> <a class="code" href="class_log_file.html#a440a7de2dcbb9facb68e56dc47cb9dea">LogFile::~LogFile</a>()
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keywordflow">if</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>) {
<a name="l00034"></a>00034 <span class="keyword">delete</span> <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>;
<a name="l00035"></a>00035 }
<a name="l00036"></a>00036 }
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/** Creates a path to the given log file. */</span>
<a name="l00039"></a>00039 <span class="keywordtype">bool</span>
<a name="l00040"></a><a class="code" href="class_log_file.html#a6bbdf61903aeeceb913ee3b6b8a3993c">00040</a> <a class="code" href="class_log_file.html#a6bbdf61903aeeceb913ee3b6b8a3993c">LogFile::createPathToFile</a>(QString filename)
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 QDir dir = QFileInfo(filename).absoluteDir();
<a name="l00043"></a>00043 <span class="keywordflow">if</span> (!dir.exists()) {
<a name="l00044"></a>00044 <span class="keywordflow">return</span> dir.mkpath(dir.absolutePath());
<a name="l00045"></a>00045 }
<a name="l00046"></a>00046 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/** Opens a log file for writing. */</span>
<a name="l00050"></a>00050 <span class="keywordtype">bool</span>
<a name="l00051"></a><a class="code" href="class_log_file.html#a19a83e176027822fe5894a297d2d62be">00051</a> <a class="code" href="class_log_file.html#a19a83e176027822fe5894a297d2d62be">LogFile::open</a>(QString filename, QString *errmsg)
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 QFile *newLogFile;
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">/* If the file is already open, then no need to open it again */</span>
<a name="l00056"></a>00056 <span class="keywordflow">if</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a> && <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>->isOpen()) {
<a name="l00057"></a>00057 <span class="keywordflow">if</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>->fileName() == filename) {
<a name="l00058"></a>00058 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">/* Create the path to the log file, if necessary */</span>
<a name="l00063"></a>00063 <span class="keywordflow">if</span> (!<a class="code" href="class_log_file.html#a6bbdf61903aeeceb913ee3b6b8a3993c">createPathToFile</a>(filename)) {
<a name="l00064"></a>00064 <span class="keywordflow">return</span> <a class="code" href="stringutil_8cpp.html#a6e3f242b28c9165146182aec25e351a3">err</a>(errmsg, <span class="stringliteral">"Unable to create path to log file."</span>);
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">/* Try to open the new log file */</span>
<a name="l00068"></a>00068 newLogFile = <span class="keyword">new</span> QFile(filename);
<a name="l00069"></a>00069 <span class="keywordflow">if</span> (!newLogFile->open(QFile::WriteOnly|QIODevice::Append|QIODevice::Text)) {
<a name="l00070"></a>00070 <span class="keyword">delete</span> newLogFile;
<a name="l00071"></a>00071 <span class="keywordflow">return</span> <a class="code" href="stringutil_8cpp.html#a6e3f242b28c9165146182aec25e351a3">err</a>(errmsg, newLogFile->errorString());
<a name="l00072"></a>00072 }
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">/* Rotate the new log file in place of the old one */</span>
<a name="l00075"></a>00075 <span class="keywordflow">if</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>) {
<a name="l00076"></a>00076 <span class="keyword">delete</span> <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>;
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078 <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a> = newLogFile;
<a name="l00079"></a>00079 <a class="code" href="class_log_file.html#a6031a020fb0f98711c1d816a1d89f395">_stream</a>.setDevice(<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>);
<a name="l00080"></a>00080 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">/** Closes an open log file. */</span>
<a name="l00084"></a>00084 <span class="keywordtype">void</span>
<a name="l00085"></a><a class="code" href="class_log_file.html#a562305d5cd6f15bbebf4c0ad29fb553c">00085</a> <a class="code" href="class_log_file.html#a562305d5cd6f15bbebf4c0ad29fb553c">LogFile::close</a>()
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087 <span class="keywordflow">if</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>) {
<a name="l00088"></a>00088 <span class="keyword">delete</span> <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>;
<a name="l00089"></a>00089 <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a> = 0;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">/** Returns true if the logfile is currently open. */</span>
<a name="l00094"></a>00094 <span class="keywordtype">bool</span>
<a name="l00095"></a><a class="code" href="class_log_file.html#ab199c46cddccc5a83aadbb2b666ea9a5">00095</a> <a class="code" href="class_log_file.html#ab199c46cddccc5a83aadbb2b666ea9a5">LogFile::isOpen</a>()
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 <span class="keywordflow">return</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a> && <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>->isOpen());
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment">/** Returns the filename of the current log file. */</span>
<a name="l00101"></a>00101 QString
<a name="l00102"></a><a class="code" href="class_log_file.html#a0a8ba2def8b0702c2459a8061e36a603">00102</a> <a class="code" href="class_log_file.html#a0a8ba2def8b0702c2459a8061e36a603">LogFile::filename</a>()
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104 <span class="keywordflow">return</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a> ? <a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>->fileName() : QString());;
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/** Overloaded ostream operator. */</span>
<a name="l00108"></a>00108 <a class="code" href="class_log_file.html">LogFile</a>&
<a name="l00109"></a><a class="code" href="class_log_file.html#a8f7a90f794f6f36e004b79d98d797930">00109</a> <a class="code" href="class_log_file.html#a8f7a90f794f6f36e004b79d98d797930">LogFile::operator<<</a>(<span class="keyword">const</span> QString &s)
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 <span class="keywordflow">if</span> (<a class="code" href="class_log_file.html#a2c890e00010ab93021e3e2691333d2c5">_file</a>) {
<a name="l00112"></a>00112 <a class="code" href="class_log_file.html#a6031a020fb0f98711c1d816a1d89f395">_stream</a> << s;
<a name="l00113"></a>00113 <a class="code" href="class_log_file.html#a6031a020fb0f98711c1d816a1d89f395">_stream</a>.flush();
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00116"></a>00116 }
<a name="l00117"></a>00117
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:54 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
