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
|
/*
* Copyright (C) by Olivier Goffart <ogoffart@woboq.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include <QString>
#include <QMetaType>
#include "ocsynclib.h"
#include <QDebug>
namespace OCC {
/**
* Class that store in a memory efficient way the remote permission
*/
class OCSYNC_EXPORT RemotePermissions
{
private:
// The first bit tells if the value is set or not
// The remaining bits correspond to know if the value is set
quint16 _value = 0;
static constexpr int notNullMask = 0x1;
template <typename Char> // can be 'char' or 'ushort' if conversion from QString
void fromArray(const Char *p);
public:
enum Permissions {
CanWrite = 1, // W
CanDelete = 2, // D
CanRename = 3, // N
CanMove = 4, // V
CanAddFile = 5, // C
CanAddSubDirectories = 6, // K
CanReshare = 7, // R
// Note: on the server, this means SharedWithMe, but in discoveryphase.cpp we also set
// this permission when the server reports the any "share-types"
IsShared = 8, // S
IsMounted = 9, // M
IsMountedSub = 10, // m (internal: set if the parent dir has IsMounted)
// Note: when adding support for more permissions, we need to invalid the cache in the database.
// (by setting forceRemoteDiscovery in SyncJournalDb::checkConnect)
PermissionsCount = IsMountedSub
};
/// null permissions
RemotePermissions() = default;
/// array with one character per permission, "" is null, " " is non-null but empty
QByteArray toDbValue() const;
/// output for display purposes, no defined format (same as toDbValue in practice)
QString toString() const;
/// read value that was written with toDbValue()
static RemotePermissions fromDbValue(const QByteArray &);
/// read a permissions string received from the server, never null
static RemotePermissions fromServerString(const QString &);
bool hasPermission(Permissions p) const
{
return _value & (1 << static_cast<int>(p));
}
void setPermission(Permissions p)
{
_value |= (1 << static_cast<int>(p)) | notNullMask;
}
void unsetPermission(Permissions p)
{
_value &= ~(1 << static_cast<int>(p));
}
bool isNull() const { return !(_value & notNullMask); }
friend bool operator==(RemotePermissions a, RemotePermissions b)
{
return a._value == b._value;
}
friend bool operator!=(RemotePermissions a, RemotePermissions b)
{
return !(a == b);
}
friend QDebug operator<<(QDebug &dbg, RemotePermissions p)
{
return dbg << p.toString();
}
};
} // namespace OCC
Q_DECLARE_METATYPE(OCC::RemotePermissions)
|
