org.graylog.plugins.pipelineprocessor.functions.FromInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.plugins.pipelineprocessor.functions;

import org.graylog.plugins.pipelineprocessor.EvaluationContext;
import org.graylog.plugins.pipelineprocessor.ast.functions.AbstractFunction;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionArgs;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionDescriptor;
import org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor;
import org.graylog.plugins.pipelineprocessor.rulebuilder.RuleBuilderFunctionGroup;
import org.graylog2.plugin.IOState;
import org.graylog2.plugin.inputs.MessageInput;
import org.graylog2.shared.inputs.InputRegistry;

import jakarta.inject.Inject;

import static com.google.common.collect.ImmutableList.of;
import static org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor.string;

public class FromInput extends AbstractFunction {

    public static final String NAME = "from_input";
    public static final String ID_ARG = "id";
    public static final String NAME_ARG = "name";

    private final InputRegistry inputRegistry;
    private final ParameterDescriptor idParam;
    private final ParameterDescriptor nameParam;

    @Inject
    public FromInput(InputRegistry inputRegistry) {
        this.inputRegistry = inputRegistry;
        idParam = string(ID_ARG).optional().description("The input's ID, this is much faster than 'name'").build();
        nameParam = string(NAME_ARG).optional().description("The input's name").build();
    }

    @Override
    public Boolean evaluate(FunctionArgs args, EvaluationContext context) {
        String id = idParam.optional(args, context).orElse("");

        MessageInput input = null;
        if ("".equals(id)) {
            final String name = nameParam.optional(args, context).orElse("");
            for (IOState messageInputIOState : inputRegistry.getInputStates()) {
                final MessageInput messageInput = messageInputIOState.getStoppable();
                if (messageInput.getTitle().equalsIgnoreCase(name)) {
                    input = messageInput;
                    break;
                }
            }
            if ("".equals(name)) {
                return null;
            }
        } else {
            final IOState inputState = inputRegistry.getInputState(id);
            if (inputState != null) {
                input = inputState.getStoppable();
            }

        }
        return input != null
                && input.getId().equals(context.currentMessage().getSourceInputId());
    }

    @Override
    public FunctionDescriptor descriptor() {
        return FunctionDescriptor.builder()
                .name(NAME)
                .returnType(Boolean.class)
                .params(of(
                        idParam,
                        nameParam))
                .description("Checks if a message arrived on a given input")
                .ruleBuilderEnabled()
                .ruleBuilderName("Check source input")
                .ruleBuilderTitle("Check if message arrived on input<#if name??> '${name}'<#if id??> '${id}'")
                .ruleBuilderFunctionGroup(RuleBuilderFunctionGroup.BOOLEAN)
                .build();
    }
}