selector.go

/*
 * 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 jobs

import (
	"context"
	"strconv"
)

var (
	fieldEvaluators []FieldEvaluator
)

type FieldEvaluator interface {
	EvaluateField(ctx context.Context, input *ActionMessage, value string) string
}

type InputSelector interface {
	Select(ctx context.Context, input *ActionMessage, objects chan interface{}, done chan bool) error
	MultipleSelection() bool
	GetTimeout() string
	SelectorID() string
	SelectorLabel() string
	GetClearInput() bool
	ApplyClearInput(msg *ActionMessage) *ActionMessage
}

type InputFilter interface {
	Filter(ctx context.Context, input *ActionMessage) (*ActionMessage, *ActionMessage, bool)
	FilterID() string
}

// RegisterFieldEvaluator adds a new evaluator to internal registry
func RegisterFieldEvaluator(evaluator FieldEvaluator) {
	fieldEvaluators = append(fieldEvaluators, evaluator)
}

// GetFieldEvaluators lists all registered evaluators
func GetFieldEvaluators() []FieldEvaluator {
	return fieldEvaluators
}

// EvaluateFieldStr goes through all registered evaluators to modify string value on the fly
func EvaluateFieldStr(ctx context.Context, input *ActionMessage, value string) string {
	output := value
	for _, e := range fieldEvaluators {
		output = e.EvaluateField(ctx, input, output)
	}
	return output
}

// EvaluateFieldStrSlice goes through all registered evaluators to modify string value on the fly
func EvaluateFieldStrSlice(ctx context.Context, input *ActionMessage, values []string) []string {
	for i, v := range values {
		values[i] = EvaluateFieldStr(ctx, input, v)
	}
	return values
}

func EvaluateFieldBool(ctx context.Context, input *ActionMessage, value string) (bool, error) {
	strVal := EvaluateFieldStr(ctx, input, value)
	if strVal == "" { // consider empty string is false
		return false, nil
	}
	return strconv.ParseBool(strVal)
}

func EvaluateFieldInt(ctx context.Context, input *ActionMessage, value string) (int, error) {
	strVal := EvaluateFieldStr(ctx, input, value)
	if i, e := strconv.ParseInt(strVal, 10, 64); e == nil {
		return int(i), nil
	} else {
		return 0, e
	}
}

func EvaluateFieldInt64(ctx context.Context, input *ActionMessage, value string) (int64, error) {
	strVal := EvaluateFieldStr(ctx, input, value)
	return strconv.ParseInt(strVal, 10, 64)
}