forked from pydio/cells
-
Notifications
You must be signed in to change notification settings - Fork 0
/
interfaces.go
160 lines (143 loc) · 4.99 KB
/
interfaces.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
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
/*
* Copyright (c) 2018. 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 actions provides interfaces to manage tasks and provides default implementation for common actions.
//
// Action are registered by ID during the init phase of each actions' subfolder
package actions
import (
"context"
"time"
"github.com/micro/go-micro/client"
"github.com/pydio/cells/common/forms"
"github.com/pydio/cells/common/proto/jobs"
)
type Concrete func() ConcreteAction
const (
ActionCategoryTree = "01 - Files/Folders Operations"
ActionCategoryArchives = "02 - Archives Operations"
ActionCategoryScheduler = "03 - Scheduler Tools / Internals"
ActionCategoryPutGet = "04 - Upload/Download to External Servers"
ActionCategoryCmd = "05 - Atomic Commands and Scripts"
ActionCategoryContents = "06 - Contents Processing"
ActionCategoryIDM = "07 - Identity Management"
ActionCategoryNotify = "08 - Notifications and Emails"
ActionCategoryETL = "09 - Extract/Load/Transform"
)
var CategoryTints = map[string]string{
ActionCategoryTree: "#03a9f4",
ActionCategoryArchives: "#fbc02d",
ActionCategoryScheduler: "#009688",
ActionCategoryPutGet: "#4caf50",
ActionCategoryCmd: "#795548",
ActionCategoryContents: "#f44336",
ActionCategoryIDM: "#438db3",
ActionCategoryNotify: "#ff9800",
ActionCategoryETL: "#009688",
}
type ActionDescription struct {
ID string
Label string
Icon string
IsInternal bool
Description string
Category string
Tint string
InputDescription string
OutputDescription string
SummaryTemplate string
HasForm bool
FormModule string
FormModuleProps string
}
// ConcreteAction is the base interface for pydio actions. All actions must implement this interface.
type ConcreteAction interface {
// GetName returns a unique identifier
GetName() string
// Init initialize parameters
Init(job *jobs.Job, cl client.Client, action *jobs.Action) error
// Run performs the actual action code
Run(ctx context.Context, channels *RunnableChannels, input jobs.ActionMessage) (jobs.ActionMessage, error)
}
// TaskUpdaterDelegateAction Actions that implement this interface can send their status updates to a parent task
type TaskUpdaterDelegateAction interface {
SetTask(task *jobs.Task)
}
// ProgressProviderAction Actions that implement this interface will publish progress updates on the progress channel.
type ProgressProviderAction interface {
ProvidesProgress() bool
}
// DescriptionProviderAction has a human-readable label
type DescriptionProviderAction interface {
GetDescription(lang ...string) ActionDescription
GetParametersForm() *forms.Form
}
// ControllableAction Actions that implement this interface can eventually be stopped and/or paused+resumed
type ControllableAction interface {
CanPause() bool
CanStop() bool
}
// RecursiveNodeWalkerAction Actions that implement this interface may perform some recursive nodes listing internally.
// If the action definition has a NodeFilter set, pass this along to the running instance to
// filter nodes on the go.
type RecursiveNodeWalkerAction interface {
SetNodeFilterAsWalkFilter(*jobs.NodesSelector)
}
// RunnableChannels defines the API to communicate with a Runnable via Channels
type RunnableChannels struct {
// Input Channels
Pause chan interface{}
Resume chan interface{}
Stop chan interface{}
// Output Channels
Status chan jobs.TaskStatus
StatusMsg chan string
Progress chan float32
}
// BlockUntilResume returns a blocking channel that can be inserted anywhere to block execution
func (r *RunnableChannels) BlockUntilResume(maxPauseTime ...time.Duration) chan interface{} {
blocker := make(chan interface{})
var unlockTime time.Duration
if len(maxPauseTime) > 0 {
unlockTime = maxPauseTime[0]
} else {
unlockTime = time.Minute * 30
}
unlockCh := time.After(unlockTime)
r.Status <- jobs.TaskStatus_Paused
go func() {
for {
select {
case <-r.Resume:
r.Status <- jobs.TaskStatus_Running
blocker <- true
return
case <-r.Stop:
r.Status <- jobs.TaskStatus_Interrupted
blocker <- true
return
case <-unlockCh:
r.Status <- jobs.TaskStatus_Running
blocker <- true
return
}
}
}()
return blocker
}