1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/***************************************************************************
smb4ksearch - This class searches for custom search strings.
-------------------
begin : So Apr 27 2008
copyright : (C) 2008 by Alexander Reinholdt
email : dustpuppy@users.berlios.de
***************************************************************************/
/***************************************************************************
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
* MA 02111-1307 USA *
***************************************************************************/
#ifndef SMB4KSEARCH_H
#define SMB4KSEARCH_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
// Qt includes
#include <QObject>
#include <QTimerEvent>
#include <QStringList>
#include <QPair>
// KDE includes
#include <kdemacros.h>
#include <kprocess.h>
// application specific includes
#include <smb4kworkgroup.h>
#include <smb4khost.h>
#include <smb4kshare.h>
/**
* This class searches for network items (hosts and shares) and returns them.
* Depending on the settings, it uses nmblookup, smbclient or smbtree.
*
* This class belongs to the core of Smb4K.
*
* @author Alexander Reinholdt <dustpuppy@users.berlios.de>
*/
typedef QPair<Smb4KHost, bool> HostEntry;
class KDE_EXPORT Smb4KSearch : public QObject
{
Q_OBJECT
public:
/**
* The constructor.
*
* @param parent The parent of this class
*/
Smb4KSearch( QObject *parent = 0 );
/**
* The destructor.
*/
~Smb4KSearch();
/**
* Search for a given search item. This can either be a share or a host.
* The search will be done by default by using Samba's smbtree program.
* If you provided an IP address, nmblookup will be used automatically.
*
* @param string The search item
*/
void search( const QString &string );
/**
* Abort the search process.
*/
void abort();
/**
* This function reports if the search is running or not.
*
* @returns TRUE if the search is running and FALSE otherwise.
*/
bool isRunning() { return m_working; }
signals:
/**
* This signal emits an Smb4KHost item that matches the search
* criterion.
*
* @param host The Smb4KHost object
*
* @param known TRUE if the host is known to the application
* and FALSE otherwise
*/
void result( Smb4KHost *host,
bool known );
/**
* This signal emits an Smb4KShare item that matches the search
* criterion.
*
* @param share The Smb4KShare object
*
* @param mounted TRUE if the share is already mounted and FALSE
* otherwise.
*/
void result( Smb4KShare *share,
bool mounted );
/**
* This signal emits the run state.
*
* @param state The so-called run state. There are several defined
* in the smb4kdefs.h header file.
*/
void state( int state );
/**
* This signal is emitted when the process finished.
*/
void finished();
protected:
/**
* Reimplemented from QObject
*/
void timerEvent( QTimerEvent *e );
protected slots:
/**
* This slot is called when output was received on stderr.
*/
void slotReadyReadStandardError();
/**
* This slot is called when output was received on stdout. It is
* used to process the search results.
*/
void slotReadyReadStandardOutput();
/**
* This slot is called, when the process exited.
*
* @param exitCode The exit code of the process
*
* @param exitStatus The exit status of the process (@see QProcess::ExitStatus)
*/
void slotProcessFinished( int exitCode, QProcess::ExitStatus exitStatus );
/**
* This slot is invoked when an error occurred with the process.
*
* @param errorCode The error code returned by the process
*/
void slotProcessError( QProcess::ProcessError errorCode );
/**
* Receive the IP address of a host (or for a share) from the IP
* address scanner.
*
* @param host The Smb4KHost item that carries the IP address.
*/
void slotReceiveIPAddress( Smb4KHost *host );
private:
/**
* The timer id
*/
int m_timer_id;
/**
* Carries a list of search items that need to be processed
*/
QStringList m_list;
/**
* Already working
*/
bool m_working;
/**
* The process object
*/
KProcess *m_proc;
/**
* Process error
*/
QProcess::ProcessError m_process_error;
/**
* The master browser as reported by smbtree
*/
Smb4KHost m_master_browser;
/**
* The workgroup string
*/
QString m_workgroup_string;
/**
* Was the process aborted?
*/
bool m_aborted;
/**
* Do we need to retry?
*/
bool m_retry;
/**
* The state enumeration
*/
enum State{ FullSearch,
IPSearch,
Idle };
/**
* The state
*/
State m_state;
/**
* The list of hosts, that are discovered during one one.
*/
QList<HostEntry> m_hosts_list;
};
#endif
|