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
|
/* devices.h */
/*
Copyright (C) 2005 Jean-Baptiste jb_dul@yahoo.com
Copyright (C) 2007 , 2008Fabian Nowak <timystery@arcor.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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef _DEVICES_H_
# define _DEVICES_H_
#include <glib.h>
#include "helpers.h"
/* #include "mount-plugin.h" */
/* extern t_disk_display ; */
/* People, learn to program in an object-oriented way! */
/**
* An enum.
* NONE and ERROR as aliases.
*/
enum {
NONE = 0,
ERROR
};
/**
* Device class.
* Used for classification of devices discovered in the system into CDs,
* removable media etc.
*/
typedef enum {
HARDDISK = 0,
REMOTE,
CD_DVD,
REMOVABLE,
UNKNOWN
} t_deviceclass;
/**
* Mount information.
* Additional info when a t_disk is mounted.
*/
typedef struct s_mount_info {
float size; /**< Total size of device */
float used; /**< Used size of device */
float avail; /**< Available size of device */
unsigned int percent; /**< Percentage used */
char *type; /**< Unused? Distinguish remote file systems? */
char *mounted_on; /**< Current mount point */
} t_mount_info;
/**
* Disk information.
*/
typedef struct s_disk {
char *device; /**< Device name, e.g. /dev/cdrom */
char *device_short; /**< Abbreviated name for display only */
char *mount_point; /**< Device mount point, e.g. /mnt/cdrom */
t_mount_info * mount_info; /**< NULL if not mounted */
/*`t_disk_display *disk_display; */ /* People, learn to program in an object-oriented way! */
t_deviceclass dc; /**< Device classification */
} t_disk;
/**
* Return a string containing a size expressed in KB, MB or GB and the unit it
* is expressed in.
* @param size Disk size in Bytes
* @return Disk size in MBytes or GBytes
*/
char * get_size_human_readable(float size);
/**
* Mount a t_disk.
* @param pdisk Disk to mount
* @param on_mount_cmd Command to execute after successfully mounting the device
* @param mount_command Command to use for mounting the device, still containing placeholders like \%d and \%m.
* @param eject Whether to inject the device before mounting.
*/
void disk_mount (t_disk *pdisk, char *on_mount_cmd, char* mount_command, gboolean eject);
/**
* Unmount a t_disk.
* @param pdisk Disk to umount
* @param umount_command Command to use for unmounting the device, still containing placeholders like \%d and \%m.
* @param show_message_dialog Whether to show a dialog upon successful umount for device removal
* @param eject Whether to eject the device after unmounting.
*/
void disk_umount (t_disk *pdisk, char* umount_command, gboolean show_message_dialog, gboolean eject);
gboolean device_or_mountpoint_exists (GPtrArray * pdisks, t_disk * pdisk);
/**
* Fill a GPtrArray with pointers on struct t_disk containing infos on devices
* and theoretical mount point. Uses setfsent() and getfsent().
* @param include_NFSs TRUE if remote file systems should also be displayed.
* @param showed_fstab_dialog Pointer to whether dialog has already been shown before
* @param length Length of the mount point names to display when shortened
* @return GPtrArray with t_disks
*/
GPtrArray * disks_new (gboolean include_NFSs, gboolean *showed_fstab_dialog, gint length);
/**
* Free a GPtrArray containing pointer on struct t_disk elements.
* @param pdisks Pointer array of t_disk
*/
void disks_free (GPtrArray * * pdisks);
/**
* Print a GPtrArray containing pointer on struct t_disk elements.
* @param pdisks Pointer array of t_disk
*/
void disks_print (GPtrArray * pdisks);
/**
* Removes specfied device from array.
* @param pdisks Pointer array of t_disk
* @param device Device to remove from list
* @return TRUE on success.
*/
gboolean disks_remove_device (GPtrArray * pdisks, char *device);
/**
* Removes specfied mountpoint from array.
* @param pdisks Pointer array of t_disk
* @param device Mountpoint to remove from list
* @return TRUE on success.
*/
gboolean disks_remove_mountpoint (GPtrArray * pdisks, char *mountpoint);
/**
* Search for device in pointer array of t_disks.
* @param pdisks Pointer array of t_disk
* @param device Device to search for
* @return pointer to t_disk if found, NULL else.
*/
t_disk * disks_search (GPtrArray * pdisks, char * device);
/**
* Lookup given mountpoint and device for exclusion
* @param excluded_FSs Pointer to array of excluded filesystems
* @param mountpoint Mountpoint of device to search for
* @param device Original device path to search for
* @return TRUE, if device is to be excluded
*/
gboolean exclude_filesystem (GPtrArray *excluded_FSs, gchar *mountpoint, gchar *device);
/**
* Refresh t_mount_info infos in a GPtrArray containing struct t_disk *
* elements.
* @param pdisks Pointer array of t_disk
*/
void disks_refresh (GPtrArray * pdisks, GPtrArray *excluded_FSs, gint length);
/**
* Returns classification for given information
* @param device Device to get class for
* @param mountpoint Mountpoint used as additional information for classfication
* @return Device class
*/
t_deviceclass disk_classify (char* device, char *mountpoint);
/**
* Checks, if disk is still mounted
* @param disk device name or mountpoint to check
* @return true, if mounted, else false.
*/
gboolean disk_check_mounted (const char *disk);
void mount_info_print(t_mount_info * mount_info);
t_mount_info * mount_info_new (float size, float used, float avail, unsigned int percent, char * type, char * mounted_on);
void mount_info_free(t_mount_info * * mount_info);
void disk_print (t_disk * pdisk);
char * shorten_disk_name (const char *dev, guint length);
t_disk * disk_new (const char * dev, const char * mountpoint, gint length);
void disk_free(t_disk **pdisk);
void disks_free_mount_info(GPtrArray * pdisks);
#endif /* _DEVICES_H_ */
|
