updated api documentation
[urpo] / www / apidoc / html / urpoprocess_8cpp_source.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>Urpo: src/urpoprocess.cpp Source File</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
8 </head>
9 <body>
10 <!-- Generated by Doxygen 1.6.3 -->
11 <div class="navigation" id="top">
12   <div class="tabs">
13     <ul>
14       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
15       <li><a href="annotated.html"><span>Classes</span></a></li>
16       <li class="current"><a href="files.html"><span>Files</span></a></li>
17     </ul>
18   </div>
19   <div class="tabs">
20     <ul>
21       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
22     </ul>
23   </div>
24 <h1>src/urpoprocess.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**************************************************************************</span>
25 <a name="l00002"></a>00002 <span class="comment"></span>
26 <a name="l00003"></a>00003 <span class="comment">    URPO</span>
27 <a name="l00004"></a>00004 <span class="comment"></span>
28 <a name="l00005"></a>00005 <span class="comment">    Unix Remote Printing Operation</span>
29 <a name="l00006"></a>00006 <span class="comment">    Copyright (c) Arto Hyvättinen 2010</span>
30 <a name="l00007"></a>00007 <span class="comment"></span>
31 <a name="l00008"></a>00008 <span class="comment">    This file is part of URPO.</span>
32 <a name="l00009"></a>00009 <span class="comment"></span>
33 <a name="l00010"></a>00010 <span class="comment">    URPO is free software: you can redistribute it and/or modify</span>
34 <a name="l00011"></a>00011 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
35 <a name="l00012"></a>00012 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
36 <a name="l00013"></a>00013 <span class="comment">    (at your option) any later version.</span>
37 <a name="l00014"></a>00014 <span class="comment"></span>
38 <a name="l00015"></a>00015 <span class="comment">    URPO is distributed in the hope that it will be useful,</span>
39 <a name="l00016"></a>00016 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
40 <a name="l00017"></a>00017 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
41 <a name="l00018"></a>00018 <span class="comment">    GNU General Public License for more details.</span>
42 <a name="l00019"></a>00019 <span class="comment"></span>
43 <a name="l00020"></a>00020 <span class="comment"></span>
44 <a name="l00021"></a>00021 <span class="comment">**************************************************************************/</span>
45 <a name="l00022"></a>00022 
46 <a name="l00023"></a>00023 <span class="preprocessor">#include &quot;urpoprocess.h&quot;</span>
47 <a name="l00024"></a>00024 <span class="preprocessor">#include &quot;urpoconnection.h&quot;</span>
48 <a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QTimer&gt;</span>
49 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QInputDialog&gt;</span>
50 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QLineEdit&gt;</span>
51 <a name="l00028"></a>00028 
52 <a name="l00029"></a>00029 
53 <a name="l00030"></a>00030 <span class="keywordtype">int</span> <span class="keyword">const</span> UrpoProcess::DEFAULTTIMEOUT;
54 <a name="l00031"></a>00031 
55 <a name="l00032"></a><a class="code" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">00032</a> <a class="code" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">UrpoProcess::UrpoProcess</a>(QObject* parent) :
56 <a name="l00033"></a>00033     QObject(parent)
57 <a name="l00034"></a>00034 {
58 <a name="l00035"></a>00035     status_ = <a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d" title="Ready for connecting.">Ready</a>;
59 <a name="l00036"></a>00036     error_ = <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f" title="No errors happends.">NoError</a>;
60 <a name="l00037"></a>00037     <a class="code" href="class_urpo_process.html#af3cd19eb0af2b51d6740471a344cbb69" title="Set timeout.">setTimeout</a>( DEFAULTTIMEOUT );
61 <a name="l00038"></a>00038 }
62 <a name="l00039"></a>00039 
63 <a name="l00040"></a><a class="code" href="class_urpo_process.html#ac4381636ee9e977dfac4d8fe53ddfeaa">00040</a> <span class="keywordtype">void</span> <a class="code" href="class_urpo_process.html#ac4381636ee9e977dfac4d8fe53ddfeaa" title="Cancel process.">UrpoProcess::terminate</a>()
64 <a name="l00041"></a>00041 {
65 <a name="l00042"></a>00042     fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff" title="User cancelled operation.">Cancelled</a>);
66 <a name="l00043"></a>00043 }
67 <a name="l00044"></a>00044 
68 <a name="l00045"></a><a class="code" href="class_urpo_process.html#af1d8cbb3465d62ab7541aac2fef7f963">00045</a> QStringList <a class="code" href="class_urpo_process.html#af1d8cbb3465d62ab7541aac2fef7f963" title="Get output of command.">UrpoProcess::getOutput</a>()
69 <a name="l00046"></a>00046 {
70 <a name="l00047"></a>00047     <span class="keywordflow">return</span> output_;
71 <a name="l00048"></a>00048 }
72 <a name="l00049"></a>00049 
73 <a name="l00050"></a>00050 <span class="keywordtype">void</span> UrpoProcess::fail(UrpoError error)
74 <a name="l00051"></a>00051 {
75 <a name="l00052"></a>00052     status_=<a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2" title="Command failed.">Failed</a>;
76 <a name="l00053"></a>00053     error_=error;
77 <a name="l00054"></a>00054     qprocess_.terminate();
78 <a name="l00055"></a>00055     emit <a class="code" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished</a>(<span class="keyword">false</span>);
79 <a name="l00056"></a>00056     <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>() );
80 <a name="l00057"></a>00057 }
81 <a name="l00058"></a>00058 
82 <a name="l00059"></a>00059 
83 <a name="l00060"></a><a class="code" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da">00060</a> <span class="keywordtype">void</span> <a class="code" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da" title="Timeout during connecting.">UrpoProcess::timeout</a>()
84 <a name="l00061"></a>00061 {
85 <a name="l00062"></a>00062     <span class="comment">// If process is still running, it means timeout!</span>
86 <a name="l00063"></a>00063     <span class="keywordflow">if</span>( status_ == <a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d" title="Command running.">Running</a>)
87 <a name="l00064"></a>00064         fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce" title="Timed out.">Timeout</a>);  <span class="comment">// FAILS !!!</span>
88 <a name="l00065"></a>00065 }
89 <a name="l00066"></a>00066 
90 <a name="l00067"></a><a class="code" href="class_urpo_process.html#a1bf2519b81fe6d5074db04f9acd38cb0">00067</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)
91 <a name="l00068"></a>00068 {
92 <a name="l00069"></a>00069     <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));
93 <a name="l00070"></a>00070 
94 <a name="l00071"></a>00071     <span class="comment">// Process finished handling</span>
95 <a name="l00072"></a>00072     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)));
96 <a name="l00073"></a>00073 
97 <a name="l00074"></a>00074     <span class="comment">// Timer for timeout</span>
98 <a name="l00075"></a>00075     <span class="comment">// use UrpoConnection&#39;s default timeout settings</span>
99 <a name="l00076"></a>00076     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>()) );
100 <a name="l00077"></a>00077 
101 <a name="l00078"></a>00078     <span class="comment">// Start process</span>
102 <a name="l00079"></a>00079     status_ = <a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d" title="Command running.">Running</a>;
103 <a name="l00080"></a>00080 
104 <a name="l00081"></a>00081     qprocess_.start(command);
105 <a name="l00082"></a>00082 
106 <a name="l00083"></a>00083 }
107 <a name="l00084"></a>00084 
108 <a name="l00085"></a><a class="code" href="class_urpo_process.html#aba6e812efd10c7b466563c171baf7284">00085</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)
109 <a name="l00086"></a>00086 {
110 <a name="l00087"></a>00087     <span class="keywordflow">if</span>( exitCode)
111 <a name="l00088"></a>00088     {
112 <a name="l00089"></a>00089         <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));
113 <a name="l00090"></a>00090         <span class="comment">// Get data from ssh server</span>
114 <a name="l00091"></a>00091         QByteArray newData = qprocess_.readAllStandardError();
115 <a name="l00092"></a>00092         <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>( QString(newData) );
116 <a name="l00093"></a>00093 
117 <a name="l00094"></a>00094         fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa" title="Error connecting host.">ConnectionError</a>);
118 <a name="l00095"></a>00095     }
119 <a name="l00096"></a>00096     <span class="keywordflow">else</span> <span class="keywordflow">if</span>( exitStatus == QProcess::CrashExit)
120 <a name="l00097"></a>00097         <span class="comment">// Process failed</span>
121 <a name="l00098"></a>00098         fail(<a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6" title="Error running process.">ProcessError</a>);
122 <a name="l00099"></a>00099     <span class="keywordflow">else</span>
123 <a name="l00100"></a>00100     {
124 <a name="l00101"></a>00101         <span class="comment">// Read output</span>
125 <a name="l00102"></a>00102         QByteArray bytes = qprocess_.readAllStandardOutput();
126 <a name="l00103"></a>00103         QString string(bytes);
127 <a name="l00104"></a>00104         <a class="code" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e" title="Send debug message.">sendDebugMessage</a>(<span class="keywordtype">string</span>);
128 <a name="l00105"></a>00105         <span class="comment">// Split to lines and store to output_</span>
129 <a name="l00106"></a>00106         output_=<span class="keywordtype">string</span>.split(<span class="stringliteral">&quot;\n&quot;</span>);
130 <a name="l00107"></a>00107         status_=<a class="code" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9" title="Command successed.">Successed</a>;
131 <a name="l00108"></a>00108         emit <a class="code" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished</a>(<span class="keyword">true</span>);
132 <a name="l00109"></a>00109 
133 <a name="l00110"></a>00110 
134 <a name="l00111"></a>00111     }
135 <a name="l00112"></a>00112 }
136 <a name="l00113"></a>00113 
137 <a name="l00114"></a><a class="code" href="class_urpo_process.html#a5a400d2abb550076c778a6030293e764">00114</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>
138 <a name="l00115"></a>00115 <span class="keyword"></span>{
139 <a name="l00116"></a>00116     <span class="keywordflow">switch</span>( <a class="code" href="class_urpo_process.html#af71059723175a0ee9324a9794eff4cb1" title="Error of process.">getError</a>() )
140 <a name="l00117"></a>00117     {
141 <a name="l00118"></a>00118     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f" title="No errors happends.">NoError</a>:
142 <a name="l00119"></a>00119             <span class="keywordflow">return</span> QString();
143 <a name="l00120"></a>00120     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6" title="Error running process.">ProcessError</a>:
144 <a name="l00121"></a>00121             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;External program calling error&quot;</span>);
145 <a name="l00122"></a>00122     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa" title="Error connecting host.">ConnectionError</a>:
146 <a name="l00123"></a>00123             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;Connection error&quot;</span>);
147 <a name="l00124"></a>00124     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f" title="Authentication failed.">AuthError</a>:
148 <a name="l00125"></a>00125             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;Authentication error&quot;</span>);
149 <a name="l00126"></a>00126     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce" title="Timed out.">Timeout</a>:
150 <a name="l00127"></a>00127             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;Time out&quot;</span>);
151 <a name="l00128"></a>00128     <span class="keywordflow">case</span> <a class="code" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff" title="User cancelled operation.">Cancelled</a>:
152 <a name="l00129"></a>00129             <span class="keywordflow">return</span> tr(<span class="stringliteral">&quot;User cancelled&quot;</span>);
153 <a name="l00130"></a>00130     }
154 <a name="l00131"></a>00131     <span class="keywordflow">return</span> QString();
155 <a name="l00132"></a>00132 }
156 <a name="l00133"></a>00133 
157 <a name="l00134"></a>00134 
158 </pre></div></div>
159 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Sep 27 18:46:05 2010 for Urpo by&nbsp;
160 <a href="http://www.doxygen.org/index.html">
161 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
162 </body>
163 </html>