Something went wrong. Try again.
Self-hosted file management and sharing system, supports multiple storage providers. forked from tdvorak.tngl.sh/cloudreve
Something went wrong. Try again.
Boolset Encoding and Decoding {#boolset-encoding-and-decoding} #
Boolset is an encoding method used to represent a set of boolean values. It converts a set of boolean values into a string for easy storage and transmission. In Cloudreve's API, Boolset is typically used for permission settings, such as user group permissions and file permissions.
Internal Representation {#internal-representation} #
The BooleanSet type is essentially a byte slice ([]byte). In this slice, each bit represents a boolean value (permission switch).
- The
0th flag bit corresponds to the0th bit of the0th byte in the byte slice. - The
1st flag bit corresponds to the1st bit of the0th byte in the byte slice. - ...
- The
7th flag bit corresponds to the7th bit of the0th byte in the byte slice. - The
8th flag bit corresponds to the0th bit of the1st byte in the byte slice. - And so on...
A bit value of 1 indicates the corresponding flag is true (enabled), while 0 indicates false (disabled).
Encoding Process {#encoding-process} #
- Determine Maximum Index: Find the maximum index
max_namong all flags to be represented. - Calculate Byte Count: Determine the number of bytes required. At least
floor(max_n / 8) + 1bytes are needed to accommodate all flags. - Initialize Byte Sequence: Create a byte sequence with the required number of bytes, initializing all bytes to
0. - Set Flags: For each flag
nthat needs to be set totrue:- Locate the
byte_index = floor(n / 8)th byte in the byte sequence. - Calculate the bit index within that byte:
bit_index = n % 8. - Set the
bit_indexth bit of that byte to1. This is typically done using a Bitwise OR operation:byte[byte_index] = byte[byte_index] | (1 << bit_index).
- Locate the
- Base64 Encode: Encode the final byte sequence into a Base64 string.
Decoding Process {#decoding-process} #
- Base64 Decode: First, decode the Base64 string back into the original byte sequence.
- Check Flag: To check the status (
trueorfalse) of a specific flagn:- Calculate the byte index:
byte_index = floor(n / 8). - Boundary Check: Check if
byte_indexis within the valid range of the byte sequence. If it's out of range, the flag is implicitlyfalse(because it was never set). - If
byte_indexis valid, locate thebyte_indexth byte in the sequence. - Calculate the bit index:
bit_index = n % 8. - Check the value of the
bit_indexth bit of that byte. This is typically done using a Bitwise AND operation:is_set = (byte[byte_index] & (1 << bit_index)) != 0. - If the result is non-zero, flag
nistrue; otherwise, it isfalse.
- Calculate the byte index:
Programming Language Implementation {#programming-language-implementation} #
Golang #
// Load from string
bs, err := boolset.FromString("/f8B")
if err != nil {
return nil, err
}
// Read the 5th flag bit
fmt.Println(bs.Enabled(5))
// Set the 1st flag bit
boolset.Set(1, true, bs)
// Save to string
encoded, err := bs.String()
if err != nil {
return nil, err
}
TypeScript #
// Load from string
const bs = new Boolset("/f8B");
// Read the 5th flag bit
console.log(bs.enabled(5));
// Set the 1st flag bit
bs.set(1, true);
// Save to string
const encoded = bs.toString();
Flag Definition {#flag-definition} #
User Group Permissions {#group-permission} #
| Flag Bit | Description |
|---|---|
0 |
Is administrator |
1 |
Is anonymous user group |
2 |
Can share files |
3 |
Can access WebDAV |
4 |
Can perform server-side batch download |
5 |
Can execute archive compression tasks |
6 |
Can enable WebDAV proxy |
7 |
Can download shares from others |
8 |
Can download shares for free |
9 |
Can perform remote downloads |
10 |
Can relocate storage policy |
11 |
Use redirect direct link |
12 |
Can use advanced delete options |
13 |
Can select specific node to process tasks |
14 |
Can set higher share permissions for anonymous users |
17 |
Use unique direct link (only effective when redirect direct link is enabled) |
File System Capabilities {#file-system-capability} #
| Flag Bit | Description |
|---|---|
0 |
Create file |
1 |
Rename file or folder |
2 |
Set permissions |
3 |
Move to "My Files" |
4 |
Move to share directory |
5 |
Move to trash |
6 |
Upload file |
7 |
Download file |
8 |
Update metadata |
9 |
List sub-items |
10 |
Generate thumbnail |
11 |
Copy to "My Files" |
12 |
Copy to share directory |
13 |
Copy to trash |
14 |
Permanent delete |
15 |
Lock file or folder |
16 |
Soft delete (move to trash) |
17 |
Restore from trash bin |
18 |
Create share |
19 |
Get file or folder information |
20 |
Version control |
21 |
Mount storage policy |
22 |
Transfer storage policy |
23 |
Enter folder |
24 |
Modify attributes (e.g., view settings) |
File Permissions {#file-permission} #
| Flag Bit | Description |
|---|---|
0 |
Read |
1 |
Update |
2 |
Create |
3 |
Delete |
4 |
Share |
5 |
List |
Node Functions {#node-function} #
| Flag Bit | Description |
|---|---|
0 |
Reserved, do not use |
1 |
Create compressed file |
2 |
Decompress file |
3 |
Remote download |
4 |
Transfer storage policy |
WebDAV Account Settings {#webdav-account-settings} #
| Flag Bit | Description |
|---|---|
0 |
Read |
1 |
Reverse proxy |