Add www pages
[urpo] / www / apidoc / html / urpoprocess_8cpp_source.html
diff --git a/www/apidoc/html/urpoprocess_8cpp_source.html b/www/apidoc/html/urpoprocess_8cpp_source.html
new file mode 100644 (file)
index 0000000..7681447
--- /dev/null
@@ -0,0 +1,192 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!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>Urpo: /holvi/arto/ohjelmointi/urpo-0.0/urpo/urpoprocess.cpp Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</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>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <img id="MSearchSelect" src="search/search.png"
+             onmouseover="return searchBox.OnSearchSelectShow()"
+             onmouseout="return searchBox.OnSearchSelectHide()"
+             alt=""/>
+        <input type="text" id="MSearchField" value="Search" accesskey="S"
+             onfocus="searchBox.OnSearchFieldFocus(true)" 
+             onblur="searchBox.OnSearchFieldFocus(false)" 
+             onkeyup="searchBox.OnSearchFieldChange(event)"/>
+        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>/holvi/arto/ohjelmointi/urpo-0.0/urpo/urpoprocess.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**************************************************************************</span>
+<a name="l00002"></a>00002 <span class="comment"></span>
+<a name="l00003"></a>00003 <span class="comment">    URPO</span>
+<a name="l00004"></a>00004 <span class="comment"></span>
+<a name="l00005"></a>00005 <span class="comment">    Unix Remote Printing Operation</span>
+<a name="l00006"></a>00006 <span class="comment">    Copyright (c) Arto Hyvättinen 2010</span>
+<a name="l00007"></a>00007 <span class="comment"></span>
+<a name="l00008"></a>00008 <span class="comment">    This file is part of URPO.</span>
+<a name="l00009"></a>00009 <span class="comment"></span>
+<a name="l00010"></a>00010 <span class="comment">    URPO is free software: you can redistribute it and/or modify</span>
+<a name="l00011"></a>00011 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
+<a name="l00012"></a>00012 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
+<a name="l00013"></a>00013 <span class="comment">    (at your option) any later version.</span>
+<a name="l00014"></a>00014 <span class="comment"></span>
+<a name="l00015"></a>00015 <span class="comment">    URPO is distributed in the hope that it will be useful,</span>
+<a name="l00016"></a>00016 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<a name="l00017"></a>00017 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<a name="l00018"></a>00018 <span class="comment">    GNU General Public License for more details.</span>
+<a name="l00019"></a>00019 <span class="comment"></span>
+<a name="l00020"></a>00020 <span class="comment"></span>
+<a name="l00021"></a>00021 <span class="comment">**************************************************************************/</span>
+<a name="l00022"></a>00022 
+<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;urpoprocess.h&quot;</span>
+<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;urpoconnection.h&quot;</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QTimer&gt;</span>
+<a name="l00026"></a>00026 
+<a name="l00027"></a>00027 
+<a name="l00028"></a>00028 <span class="keywordtype">int</span> <span class="keyword">const</span> UrpoProcess::DEFAULTTIMEOUT;
+<a name="l00029"></a>00029 
+<a name="l00030"></a><a class="code" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">00030</a> <a class="code" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">UrpoProcess::UrpoProcess</a>(QObject* parent) :
+<a name="l00031"></a>00031     QObject(parent)
+<a name="l00032"></a>00032 {
+<a name="l00033"></a>00033     status_ = <a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d" title="Ready for connecting.">Ready</a>;
+<a name="l00034"></a>00034     error_ = <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f" title="No errors happends.">NoError</a>;
+<a name="l00035"></a>00035     <a class="code" href="class_urpo_process.html#af3cd19eb0af2b51d6740471a344cbb69" title="Set timeout.">setTimeout</a>( DEFAULTTIMEOUT );
+<a name="l00036"></a>00036 }
+<a name="l00037"></a>00037 
+<a name="l00038"></a><a class="code" href="class_urpo_process.html#ac4381636ee9e977dfac4d8fe53ddfeaa">00038</a> <span class="keywordtype">void</span> <a class="code" href="class_urpo_process.html#ac4381636ee9e977dfac4d8fe53ddfeaa" title="Cancel process.">UrpoProcess::terminate</a>()
+<a name="l00039"></a>00039 {
+<a name="l00040"></a>00040     fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff" title="User cancelled operation.">Cancelled</a>);
+<a name="l00041"></a>00041 }
+<a name="l00042"></a>00042 
+<a name="l00043"></a><a class="code" href="class_urpo_process.html#af1d8cbb3465d62ab7541aac2fef7f963">00043</a> QStringList <a class="code" href="class_urpo_process.html#af1d8cbb3465d62ab7541aac2fef7f963" title="Get output of command.">UrpoProcess::getOutput</a>()
+<a name="l00044"></a>00044 {
+<a name="l00045"></a>00045     <span class="keywordflow">return</span> output_;
+<a name="l00046"></a>00046 }
+<a name="l00047"></a>00047 
+<a name="l00048"></a>00048 <span class="keywordtype">void</span> UrpoProcess::fail(UrpoError error)
+<a name="l00049"></a>00049 {
+<a name="l00050"></a>00050     status_=<a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2" title="Command failed.">Failed</a>;
+<a name="l00051"></a>00051     error_=error;
+<a name="l00052"></a>00052     qprocess_.terminate();
+<a name="l00053"></a>00053     emit <a class="code" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished</a>(<span class="keyword">false</span>);
+<a name="l00054"></a>00054     <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>( <a class="code" href="class_urpo_process.html#a5a400d2abb550076c778a6030293e764" title="Error of process (in string).">getErrorString</a>() );
+<a name="l00055"></a>00055 }
+<a name="l00056"></a>00056 
+<a name="l00057"></a>00057 
+<a name="l00058"></a><a class="code" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da">00058</a> <span class="keywordtype">void</span> <a class="code" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da" title="Timeout during connecting.">UrpoProcess::timeout</a>()
+<a name="l00059"></a>00059 {
+<a name="l00060"></a>00060     <span class="comment">// If process is still running, it means timeout!</span>
+<a name="l00061"></a>00061     <span class="keywordflow">if</span>( status_ == <a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d" title="Command running.">Running</a>)
+<a name="l00062"></a>00062         fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce" title="Timed out.">Timeout</a>);
+<a name="l00063"></a>00063 }
+<a name="l00064"></a>00064 
+<a name="l00065"></a><a class="code" href="class_urpo_process.html#a1bf2519b81fe6d5074db04f9acd38cb0">00065</a> <span class="keywordtype">void</span> <a class="code" href="class_urpo_process.html#a1bf2519b81fe6d5074db04f9acd38cb0" title="Run command.">UrpoProcess::start</a>(<span class="keyword">const</span> QString &amp;command)
+<a name="l00066"></a>00066 {
+<a name="l00067"></a>00067     <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>(QString(<span class="stringliteral">&quot;[Running command %1 ]&quot;</span>).arg(command));
+<a name="l00068"></a>00068 
+<a name="l00069"></a>00069     <span class="comment">// Process finished handling</span>
+<a name="l00070"></a>00070     connect( &amp;qprocess_, SIGNAL(<a class="code" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished</a>(<span class="keywordtype">int</span>,QProcess::ExitStatus)), <span class="keyword">this</span>, SLOT(<a class="code" href="class_urpo_process.html#aba6e812efd10c7b466563c171baf7284" title="SSH client has finished.">processFinished</a>(<span class="keywordtype">int</span>,QProcess::ExitStatus)));
+<a name="l00071"></a>00071 
+<a name="l00072"></a>00072     <span class="comment">// Timer for timeout</span>
+<a name="l00073"></a>00073     <span class="comment">// use UrpoConnection&#39;s default timeout settings</span>
+<a name="l00074"></a>00074     QTimer::singleShot( <a class="code" href="class_urpo_process.html#aaa8de6c9a6635cf2433958a60e4cf87f" title="Return timeout.">getTimeout</a>(), <span class="keyword">this</span>, SLOT(<a class="code" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da" title="Timeout during connecting.">timeout</a>()) );
+<a name="l00075"></a>00075 
+<a name="l00076"></a>00076     <span class="comment">// Start process</span>
+<a name="l00077"></a>00077     status_ = <a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d" title="Command running.">Running</a>;
+<a name="l00078"></a>00078 
+<a name="l00079"></a>00079     qprocess_.start(command);
+<a name="l00080"></a>00080 
+<a name="l00081"></a>00081 }
+<a name="l00082"></a>00082 
+<a name="l00083"></a><a class="code" href="class_urpo_process.html#aba6e812efd10c7b466563c171baf7284">00083</a> <span class="keywordtype">void</span> <a class="code" href="class_urpo_process.html#aba6e812efd10c7b466563c171baf7284" title="SSH client has finished.">UrpoProcess::processFinished</a>(<span class="keywordtype">int</span> exitCode,QProcess::ExitStatus exitStatus)
+<a name="l00084"></a>00084 {
+<a name="l00085"></a>00085     <span class="keywordflow">if</span>( exitCode)
+<a name="l00086"></a>00086     {
+<a name="l00087"></a>00087         <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>( QString( tr(<span class="stringliteral">&quot;Process exited with code %1&quot;</span>) ).arg(exitCode));
+<a name="l00088"></a>00088         <span class="comment">// Get data from ssh server</span>
+<a name="l00089"></a>00089         QByteArray newData = qprocess_.readAllStandardError();
+<a name="l00090"></a>00090         <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>( QString(newData) );
+<a name="l00091"></a>00091 
+<a name="l00092"></a>00092         fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa" title="Error connecting host.">ConnectionError</a>);
+<a name="l00093"></a>00093     }
+<a name="l00094"></a>00094     <span class="keywordflow">else</span> <span class="keywordflow">if</span>( exitStatus == QProcess::CrashExit)
+<a name="l00095"></a>00095         <span class="comment">// Process failed</span>
+<a name="l00096"></a>00096         fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6" title="Error running process.">ProcessError</a>);
+<a name="l00097"></a>00097     <span class="keywordflow">else</span>
+<a name="l00098"></a>00098     {
+<a name="l00099"></a>00099         <span class="comment">// Read output</span>
+<a name="l00100"></a>00100         QByteArray bytes = qprocess_.readAllStandardOutput();
+<a name="l00101"></a>00101         QString string(bytes);
+<a name="l00102"></a>00102         <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>(<span class="keywordtype">string</span>);
+<a name="l00103"></a>00103         <span class="comment">// Split to lines and store to output_</span>
+<a name="l00104"></a>00104         output_=<span class="keywordtype">string</span>.split(<span class="stringliteral">&quot;\n&quot;</span>);
+<a name="l00105"></a>00105         status_=<a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9" title="Command successed.">Successed</a>;
+<a name="l00106"></a>00106         emit <a class="code" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished</a>(<span class="keyword">true</span>);
+<a name="l00107"></a>00107     }
+<a name="l00108"></a>00108 }
+<a name="l00109"></a>00109 
+<a name="l00110"></a><a class="code" href="class_urpo_process.html#a5a400d2abb550076c778a6030293e764">00110</a> QString <a class="code" href="class_urpo_process.html#a5a400d2abb550076c778a6030293e764" title="Error of process (in string).">UrpoProcess::getErrorString</a>()<span class="keyword"> const</span>
+<a name="l00111"></a>00111 <span class="keyword"></span>{
+<a name="l00112"></a>00112     <span class="keywordflow">switch</span>( <a class="code" href="class_urpo_process.html#af71059723175a0ee9324a9794eff4cb1" title="Error of process.">getError</a>() )
+<a name="l00113"></a>00113     {
+<a name="l00114"></a>00114     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f" title="No errors happends.">NoError</a>:
+<a name="l00115"></a>00115             <span class="keywordflow">return</span> QString();
+<a name="l00116"></a>00116     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6" title="Error running process.">ProcessError</a>:
+<a name="l00117"></a>00117             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;External program calling error&quot;</span>);
+<a name="l00118"></a>00118     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa" title="Error connecting host.">ConnectionError</a>:
+<a name="l00119"></a>00119             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;Connection error&quot;</span>);
+<a name="l00120"></a>00120     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f" title="Authentication failed.">AuthError</a>:
+<a name="l00121"></a>00121             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;Authentication error&quot;</span>);
+<a name="l00122"></a>00122     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce" title="Timed out.">Timeout</a>:
+<a name="l00123"></a>00123             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;Time out&quot;</span>);
+<a name="l00124"></a>00124     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff" title="User cancelled operation.">Cancelled</a>:
+<a name="l00125"></a>00125             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;User cancelled&quot;</span>);
+<a name="l00126"></a>00126     }
+<a name="l00127"></a>00127     <span class="keywordflow">return</span> QString();
+<a name="l00128"></a>00128 }
+<a name="l00129"></a>00129 
+<a name="l00130"></a>00130 
+</pre></div></div>
+<!--- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>