-
Notifications
You must be signed in to change notification settings - Fork 171
/
client.go
62 lines (56 loc) · 2.45 KB
/
client.go
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
/*
* Copyright (c) 2019-2021. Abstrium SAS <team (at) pydio.com>
* This file is part of Pydio Cells.
*
* Pydio Cells is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Pydio Cells 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>.
*
* The latest code can be found at <https://pydio.com>.
*/
// Package nodes provides high-level clients for talking to the main data tree in certain context.
//
// It follows the "wrapper" pattern of http handlers to filter all requests inputs and outputs. The "Router" is object
// is used by all services or gateways when accessing to data as a given user.
// Between others, it will
// - Load ACLs and perform checks to make sure user is allowed to read/write the data
// - Perform other meta-related or acl-related checks like Quota management, locks, etc.
// - Perform encryption/decryption of actual data on the fly
// - Compress / Decompress archives,
// - Add metadata collected from any services on the nodes outputted by the responses,
// - etc...
package nodes
import (
"context"
"github.com/pydio/cells/v4/common/proto/tree"
)
const (
ViewsLibraryName = "pydio.lib.views"
MetaAclCheckDownload = "acl-check-download"
MetaAclCheckSyncable = "acl-check-syncable"
)
// Client the main accessor to access nodes while going through a preset stack of Handler.
// Actual implementations are composed of a Core Handler (executor), a Pool and ordered middlewares.
// It implements all methods of a Handler
type Client interface {
Handler
WrapCallback(provider CallbackFunc) error
BranchInfoForNode(ctx context.Context, node *tree.Node) (branch BranchInfo, err error)
CanApply(ctx context.Context, operation *tree.NodeChangeEvent) (*tree.NodeChangeEvent, error)
GetClientsPool() SourcesPool
}
var (
// IsUnitTestEnv flag prevents among others the ClientPool to look for declared
// datasources in the registry. As none is present while running unit tests, it
// otherwise times out.
IsUnitTestEnv = false
)