Sybren A. Stüvel 7728c072ae Add copyright notices
No functional changes.
2022-01-10 17:45:13 +01:00

102 lines
2.5 KiB
Go

package job_compilers
/* ***** BEGIN GPL LICENSE BLOCK *****
*
* Original Code Copyright (C) 2022 Blender Foundation.
*
* This file is part of Flamenco.
*
* Flamenco is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* Flamenco 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* Flamenco. If not, see <https://www.gnu.org/licenses/>.
*
* ***** END GPL LICENSE BLOCK ***** */
import (
"time"
"github.com/dop251/goja"
"github.com/rs/zerolog/log"
)
// Author allows scripts to author tasks and commands.
type Author struct {
runtime *goja.Runtime
}
type AuthoredJob struct {
JobID string
Name string
JobType string
Priority int8
Created time.Time
Settings JobSettings
Metadata JobMetadata
Tasks []AuthoredTask
}
type JobSettings map[string]interface{}
type JobMetadata map[string]string
type AuthoredTask struct {
Name string
Commands []AuthoredCommand
// Dependencies are tasks that need to be completed before this one can run.
Dependencies []*AuthoredTask
}
type AuthoredCommand struct {
Type string
Parameters map[string]string
}
func (a *Author) Task(name string) (*AuthoredTask, error) {
at := AuthoredTask{
name,
make([]AuthoredCommand, 0),
make([]*AuthoredTask, 0),
}
return &at, nil
}
func (a *Author) Command(cmdType string, parameters map[string]string) (*AuthoredCommand, error) {
ac := AuthoredCommand{cmdType, parameters}
return &ac, nil
}
func AuthorModule(r *goja.Runtime, module *goja.Object) {
a := &Author{
runtime: r,
}
obj := module.Get("exports").(*goja.Object)
obj.Set("Task", a.Task)
obj.Set("Command", a.Command)
}
func (aj *AuthoredJob) AddTask(at *AuthoredTask) {
log.Debug().Str("job", at.Name).Interface("task", at).Msg("add task")
aj.Tasks = append(aj.Tasks, *at)
}
func (at *AuthoredTask) AddCommand(ac *AuthoredCommand) {
at.Commands = append(at.Commands, *ac)
}
func (at *AuthoredTask) AddDependency(dep *AuthoredTask) error {
// TODO: check for dependency cycles, return error if there.
at.Dependencies = append(at.Dependencies, dep)
return nil
}