<!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: ControlCommand.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_67a2ce25601334632bdc5ef4a72c0f17.html">torcontrol</a>
</div>
</div>
<div class="contents">
<h1>ControlCommand.cpp</h1><a href="_control_command_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 </span>
<a name="l00004"></a>00004 <span class="comment">** you did not receive the LICENSE file with this file, you may obtain it</span>
<a name="l00005"></a>00005 <span class="comment">** from the 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</span>
<a name="l00008"></a>00008 <span class="comment">** the 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 ControlCommand.cpp</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: ControlCommand.cpp 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief A command sent to Tor's control interface</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="_control_command_8h.html">ControlCommand.h</a>"</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/** Default constructor. */</span>
<a name="l00021"></a><a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">00021</a> <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand::ControlCommand</a>()
<a name="l00022"></a>00022 {
<a name="l00023"></a>00023 }
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">/** Creates a command using the specified keyword. */</span>
<a name="l00026"></a><a class="code" href="class_control_command.html#aa40ce5460544613ea23b6f1e9e0c5011">00026</a> <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand::ControlCommand</a>(<span class="keyword">const</span> QString &keyword)
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a> = keyword;
<a name="l00029"></a>00029 }
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">/** Creates a control command using the specified keyword and argument. */</span>
<a name="l00032"></a><a class="code" href="class_control_command.html#a10418997d1632eeaf094ad8b5abc1e6c">00032</a> <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand::ControlCommand</a>(<span class="keyword">const</span> QString &keyword, <span class="keyword">const</span> QString &arg)
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a> = keyword;
<a name="l00035"></a>00035 <a class="code" href="class_control_command.html#a4f8c58a007da880191178044ae569ec0">addArgument</a>(arg);
<a name="l00036"></a>00036 }
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/** Creates a control command using the specified keyword and list of</span>
<a name="l00039"></a>00039 <span class="comment"> * arguments. */</span>
<a name="l00040"></a><a class="code" href="class_control_command.html#adbaaef02b26ac3218722895ff79f0af8">00040</a> <a class="code" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand::ControlCommand</a>(<span class="keyword">const</span> QString &keyword, <span class="keyword">const</span> QStringList &args)
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a> = keyword;
<a name="l00043"></a>00043 <a class="code" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">_arguments</a> = args;
<a name="l00044"></a>00044 }
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment">/** Sets the keyword for this command. */</span>
<a name="l00047"></a>00047 <span class="keywordtype">void</span>
<a name="l00048"></a><a class="code" href="class_control_command.html#af0e7535f3bfa9c85d5b4d853ddfca2b4">00048</a> <a class="code" href="class_control_command.html#af0e7535f3bfa9c85d5b4d853ddfca2b4">ControlCommand::setKeyword</a>(<span class="keyword">const</span> QString &keyword)
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a> = keyword;
<a name="l00051"></a>00051 }
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">/** Adds an argument to this command's argument list. */</span>
<a name="l00054"></a>00054 <span class="keywordtype">void</span>
<a name="l00055"></a><a class="code" href="class_control_command.html#a4f8c58a007da880191178044ae569ec0">00055</a> <a class="code" href="class_control_command.html#a4f8c58a007da880191178044ae569ec0">ControlCommand::addArgument</a>(<span class="keyword">const</span> QString &arg)
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <a class="code" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">_arguments</a> << arg;
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">/** Adds all arguments in <b>args</b> to this control command. */</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span>
<a name="l00062"></a><a class="code" href="class_control_command.html#ab5981c4f2760b6f23797ab23b7dc491b">00062</a> <a class="code" href="class_control_command.html#ab5981c4f2760b6f23797ab23b7dc491b">ControlCommand::addArguments</a>(<span class="keyword">const</span> QStringList &args)
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 <span class="keywordflow">foreach</span> (QString arg, args) {
<a name="l00065"></a>00065 <a class="code" href="class_control_command.html#a4f8c58a007da880191178044ae569ec0">addArgument</a>(arg);
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">/** Adds data to the end of this command. */</span>
<a name="l00070"></a>00070 <span class="keywordtype">void</span>
<a name="l00071"></a><a class="code" href="class_control_command.html#a3d8dab8080ef3956ae70a06a7d11fe8e">00071</a> <a class="code" href="class_control_command.html#a3d8dab8080ef3956ae70a06a7d11fe8e">ControlCommand::appendData</a>(<span class="keyword">const</span> QString &data)
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 <a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a> << data;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">/** Escapes any special characters in this command. */</span>
<a name="l00077"></a>00077 QString
<a name="l00078"></a><a class="code" href="class_control_command.html#a38cdbeddf0e8e6b88f4fc474bf2c4a62">00078</a> <a class="code" href="class_control_command.html#a38cdbeddf0e8e6b88f4fc474bf2c4a62">ControlCommand::escape</a>(<span class="keyword">const</span> QString &unescaped)<span class="keyword"> const</span>
<a name="l00079"></a>00079 <span class="keyword"></span>{
<a name="l00080"></a>00080 QString str = unescaped;
<a name="l00081"></a>00081 <span class="keywordflow">if</span> (str.startsWith(<span class="stringliteral">"."</span>)) {
<a name="l00082"></a>00082 str.prepend(<span class="stringliteral">"."</span>);
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (str.endsWith(<span class="stringliteral">"\r"</span>)) {
<a name="l00085"></a>00085 str.append(<span class="stringliteral">"\n"</span>);
<a name="l00086"></a>00086 } <span class="keywordflow">else</span> {
<a name="l00087"></a>00087 str.append(<span class="stringliteral">"\r\n"</span>);
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 <span class="keywordflow">return</span> str;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment">/** Formats a command according to Tor's Control Protocol V1. The proper</span>
<a name="l00093"></a>00093 <span class="comment"> * format of a command is as follows:</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data</span>
<a name="l00096"></a>00096 <span class="comment"> * Keyword = 1*ALPHA</span>
<a name="l00097"></a>00097 <span class="comment"> * Arguments = *(SP / VCHAR)</span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a>00099 QString
<a name="l00100"></a><a class="code" href="class_control_command.html#a57c94909a90bc9ecb301ff3ef3beeb45">00100</a> <a class="code" href="class_control_command.html#a57c94909a90bc9ecb301ff3ef3beeb45">ControlCommand::toString</a>()<span class="keyword"> const</span>
<a name="l00101"></a>00101 <span class="keyword"></span>{
<a name="l00102"></a>00102 <span class="keywordtype">int</span> <a class="code" href="html_8cpp.html#a4a5dba6492ea149585950c59c210ff47">i</a>;
<a name="l00103"></a>00103 QString str;
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="comment">/* If this command contains data, then a "+" is prepended to the keyword */</span>
<a name="l00106"></a>00106 <span class="keywordflow">if</span> (<a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a>.size() > 0) {
<a name="l00107"></a>00107 str = <span class="stringliteral">"+"</span>;
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109 str += <a class="code" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a> + <span class="stringliteral">" "</span>;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="comment">/* Append all specified arguments separated by a space */</span>
<a name="l00112"></a>00112 str += <a class="code" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">_arguments</a>.join(<span class="stringliteral">" "</span>);
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">/* Append whatever data lines have been specified */</span>
<a name="l00115"></a>00115 <span class="keywordflow">if</span> (<a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a>.size() > 0) {
<a name="l00116"></a>00116 str += <span class="stringliteral">"\r\n"</span>;
<a name="l00117"></a>00117 <span class="keywordflow">for</span> (i = 0; i < <a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a>.size(); i++) {
<a name="l00118"></a>00118 str += <a class="code" href="class_control_command.html#a38cdbeddf0e8e6b88f4fc474bf2c4a62">escape</a>(<a class="code" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a>.at(i));
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120 str += <span class="stringliteral">"."</span>;
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122 <span class="keywordflow">return</span> str.append(<span class="stringliteral">"\r\n"</span>);
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
</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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
75
