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
|
/* This file is part of the KDE Project
Copyright (c) 2004-2005 Jérôme Lodewyck <jerome dot lodewyck at normalesup dot org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* This is a media:/ backend for the freedesktop Hardware Abstraction Layer
* Usage : create an instance of HALBackend, then call InitHal(). A false
* result from the later function means that something went wrong and that
* the backend shall not be used.
*
* @author Jérôme Lodewyck <jerome dot lodewyck at normalesup dot org>
* @short media:/ backend for the HAL
*/
#ifndef _HALBACKEND_H_
#define _HALBACKEND_H_
#include "backendbase.h"
#include <qobject.h>
#include <qstringlist.h>
#include <qstring.h>
#include <config.h>
/* We acknowledge the the dbus API is unstable */
#define DBUS_API_SUBJECT_TO_CHANGE
/* DBus-Qt bindings */
#include <dbus/connection.h>
/* HAL libraries */
#include <libhal.h>
#include <libhal-storage.h>
namespace KIO {
class Job;
}
class HALBackend : public QObject, public BackendBase
{
Q_OBJECT
public:
/**
* Constructor
*/
HALBackend(MediaList &list, QObject* parent);
/**
* Destructor
*/
~HALBackend();
/**
* Perform HAL initialization.
*
* @return true if succeded. If not, rely on some other backend
*/
bool InitHal();
/**
* List all devices and append them to the media device list (called only once, at startup).
*
* @return true if succeded, false otherwise
*/
bool ListDevices();
QStringList mountoptions(const QString &id);
bool setMountoptions(const QString &id, const QStringList &options);
QString mount(const QString &id);
QString mount(const Medium *medium);
QString unmount(const QString &id);
QString decrypt(const QString &id, const QString &password);
QString undecrypt(const QString &id);
private:
/**
* Append a device in the media list. This function will check if the device
* is worth listing.
*
* @param udi Universal Device Id
* @param allowNotification Indicates if this event will be notified to the user
*/
void AddDevice(const char* udi, bool allowNotification=true);
/**
* Remove a device from the device list
*
* @param udi Universal Device Id
*/
void RemoveDevice(const char* udi);
/**
* A device has changed, update it
*
* @param udi Universal Device Id
*/
void ModifyDevice(const char *udi, const char* key);
/**
* HAL informed that a special action has occured
* (e.g. device unplugged without unmounting)
*
* @param udi Universal Device Id
*/
void DeviceCondition(const char *udi, const char *condition);
/**
* Integrate the DBus connection within qt main loop
*/
void MainLoopIntegration(DBusConnection *dbusConnection);
/* Set media properties */
private:
/**
* Reset properties for the given medium
*/
void ResetProperties(const char* MediumUdi, bool allowNotification=false);
/**
* Find the medium that is concerned with device udi
*/
const char* findMediumUdiFromUdi(const char* udi);
void setVolumeProperties(Medium* medium);
bool setFloppyProperties(Medium* medium);
void setFloppyMountState( Medium* medium );
bool setFstabProperties(Medium* medium);
void setCameraProperties(Medium* medium);
QString generateName(const QString &devNode);
static QString isInFstab(const Medium *medium);
static QString listUsingProcesses(const Medium *medium);
static QString killUsingProcesses(const Medium *medium);
private slots:
void slotResult(KIO::Job *job);
/* Hal call-backs -- from gvm*/
public:
/** Invoked when a device is added to the Global Device List.
*
* @param ctx LibHal context
* @param udi Universal Device Id
*/
static void hal_device_added(LibHalContext *ctx, const char *udi);
/** Invoked when a device is removed from the Global Device List.
*
* @param ctx LibHal context
* @param udi Universal Device Id
*/
static void hal_device_removed(LibHalContext *ctx, const char *udi);
/** Invoked when a property of a device in the Global Device List is
* changed, and we have we have subscribed to changes for that device.
*
* @param ctx LibHal context
* @param udi Univerisal Device Id
* @param key Key of property
*/
static void hal_device_property_modified(LibHalContext *ctx, const char *udi, const char *key,
dbus_bool_t is_removed, dbus_bool_t is_added);
/** Type for callback when a non-continuos condition occurs on a device
*
* @param udi Univerisal Device Id
* @param condition_name Name of the condition
* @param message D-BUS message with variable parameters depending on condition
*/
static void hal_device_condition(LibHalContext *ctx, const char *udi,
const char *condition_name,
const char* message
);
/* HAL and DBus structures */
private:
/**
* The HAL context connecting the whole application to the HAL
*/
LibHalContext* m_halContext;
/**
* libhal-storage HAL policy, e.g. for icon names
*/
LibHalStoragePolicy* m_halStoragePolicy;
/**
* The DBus-Qt bindings connection for mainloop integration
*/
DBusQt::Connection* m_dBusQtConnection;
/**
* Object for the kded module
*/
QObject* m_parent;
DBusConnection *dbus_connection;
/**
* Data structure for fstab mount/unmount jobs
*/
struct mount_job_data {
// [in] Medium, which is being mounted/unmounted by the job
const Medium* medium;
// [in,out] Should be set to true when the job completes
bool completed;
// [out] KIO::Error if an error occured during operation. Otherwise, 0
int error;
// [out] Error message to be displayed to the user
QString errorMessage;
};
QMap<KIO::Job *, struct mount_job_data*> mount_jobs;
};
#endif /* _HALBACKEND_H_ */
|
