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
|
/* This file is part of the KDE project
Copyright (C) 2005 Till Adam <adam@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
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.
*/
#ifndef __kacl_h__
#define __kacl_h__
#include <sys/types.h>
#include <kio/global.h>
typedef QPair<TQString, unsigned short> ACLUserPermissions;
typedef TQValueList<ACLUserPermissions> ACLUserPermissionsList;
typedef TQValueListIterator<ACLUserPermissions> ACLUserPermissionsIterator;
typedef TQValueListConstIterator<ACLUserPermissions> ACLUserPermissionsConstIterator;
typedef QPair<TQString, unsigned short> ACLGroupPermissions;
typedef TQValueList<ACLGroupPermissions> ACLGroupPermissionsList;
typedef TQValueListIterator<ACLGroupPermissions> ACLGroupPermissionsIterator;
typedef TQValueListConstIterator<ACLGroupPermissions> ACLGroupPermissionsConstIterator;
/**
* The KCAL class encapsulates a POSIX Access Control List. It follows the
* little standard that couldn't, 1003.1e/1003.2c, which died in draft status.
* @short a POSIX ACL encapsulation
* @author Till Adam <adam@kde.org>
*/
class KIO_EXPORT KACL
{
public:
/**
* Creates a new KACL from @p aclString. If the string is a valid acl
* string, isValid() will afterwards return true.
*/
KACL( const TQString & aclString );
/** Copy ctor */
KACL( const KACL& rhs );
/**
* Creates a new KACL from the basic permissions passed in @p basicPermissions.
* isValid() will return true, afterwards.
*/
KACL( mode_t basicPermissions );
/**
* Creates an empty KACL. Until a valid acl string is set via setACL,
* isValid() will return false.
*/
KACL();
virtual ~KACL();
KACL& operator=( const KACL& rhs ) {
if ( this != &rhs )
setACL( rhs.asString() );
return *this;
}
bool operator==( const KACL& rhs ) const;
bool operator!=( const KACL& rhs ) const {
return !operator==( rhs );
}
/**
* Returns whether the KACL object represents a valid acl.
* @return whether the KACL object represents a valid acl.
*/
bool isValid() const;
/** The standard (non-extended) part of an ACL. These map directly to
* standard unix file permissions. Setting them will never make a valid
* ACL invalid. */
/** @return the owner's premissions entry */
unsigned short ownerPermissions() const;
/** Set the owner's permissions entry.
* @return success or failure */
bool setOwnerPermissions( unsigned short );
/** @return the owning group's premissions entry */
unsigned short owningGroupPermissions() const;
/** Set the owning group's permissions entry.
* @return success or failure */
bool setOwningGroupPermissions( unsigned short );
/** @return the premissions entry for others */
unsigned short othersPermissions() const;
/** Set the permissions entry for others.
* @return success or failure */
bool setOthersPermissions( unsigned short );
/** @return the basic (owner/group/others) part of the ACL as a mode_t */
mode_t basePermissions() const;
/** The interface to the extended ACL. This is a tqmask, permissions for
* n named users and permissions for m named groups. */
/**
* Return whether the ACL tqcontains extended entries or can be expressed
* using only basic file permissions.
* @return whether the ACL tqcontains extended entries */
bool isExtended() const;
/**
* Return the entry for the permissions tqmask if there is one and sets
* @p exists to true. If there is no such entry, @p exists is set to false.
* @return the permissions tqmask entry */
unsigned short tqmaskPermissions( bool &exists ) const;
/** Set the permissions tqmask for the ACL. Permissions set for individual
* entries will be tqmasked with this, such that their effective permissions
* are the result of the logical and of their entry and the tqmask.
* @return success or failure */
bool setMaskPermissions( unsigned short );
/**
* Access to the permissions entry for a named user, if such an entry
* exists. @p exists is set to true if a matching entry exists and
* to false otherwise.
* @return the permissions for a user entry with the name in @p name */
unsigned short namedUserPermissions( const TQString& name, bool *exists ) const;
/** Set the permissions for a user with the name @p name. Will fail
* if the user doesn't exist, in which case the ACL will be unchanged.
* @return success or failure. */
bool setNamedUserPermissions( const TQString& name, unsigned short );
/** Returns the list of all group permission entries. Each entry consists
* of a name/permissions pair. This is a QPair, therefore access is provided
* via the .first and .next members.
* @return the list of all group permission entries. */
ACLUserPermissionsList allUserPermissions() const;
/** Replace the list of all user permissions with @p list. If one
* of the entries in the list does not exists, or setting of the ACL
* entry fails for any reason, the ACL will be left unchanged.
* @return success or failure */
bool setAllUserPermissions( const ACLUserPermissionsList &list );
/**
* Access to the permissions entry for a named group, if such an entry
* exists. @p exists is set to true if a matching entry exists and
* to false otherwise.
* @return the permissions for a group with the name in @p name */
unsigned short namedGroupPermissions( const TQString& name, bool *exists ) const;
/** Set the permissions for a group with the name @p name. Will fail
* if the group doesn't exist, in which case the ACL be unchanged.
* @return success or failure. */
bool setNamedGroupPermissions( const TQString& name, unsigned short );
/** Returns the list of all group permission entries. Each entry consists
* of a name/permissions pair. This is a QPair, therefor access is provided
* via the .first and .next members.
* @return the list of all group permission entries. */
ACLGroupPermissionsList allGroupPermissions() const;
/** Replace the list of all user permissions with @p list. If one
* of the entries in the list does not exists, or setting of the ACL
* entry fails for any reason, the ACL will be left unchanged.
* @return success or failure */
bool setAllGroupPermissions( const ACLGroupPermissionsList & );
/** Sets the whole list from a string. If the string in @p aclStr represents
* a valid ACL, it will be set, otherwise the ACL remains unchanged.
* @return whether setting the ACL was successful. */
bool setACL( const TQString &aclStr );
/** Return a string representation of the ACL.
* @return a string version of the ACL in the format compatible with libacl and
* POSIX 1003.1e. Implementations conforming to that standard should be able
* to take such strings as input. */
TQString asString() const;
protected:
virtual void virtual_hook( int id, void* data );
private:
class KACLPrivate;
KACLPrivate * d;
KIO_EXPORT friend TQDataStream & operator<< ( TQDataStream & s, const KACL & a );
KIO_EXPORT friend TQDataStream & operator>> ( TQDataStream & s, KACL & a );
};
KIO_EXPORT TQDataStream & operator<< ( TQDataStream & s, const KACL & a );
KIO_EXPORT TQDataStream & operator>> ( TQDataStream & s, KACL & a );
#endif
|
