-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
replace() function to replace occurrences of a string (#4718)
Closes #4705 Refs Graylog2/graylog-plugin-pipeline-processor#171
- Loading branch information
Showing
4 changed files
with
79 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
...server/src/main/java/org/graylog/plugins/pipelineprocessor/functions/strings/Replace.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /** | ||
| * This file is part of Graylog. | ||
| * | ||
| * Graylog 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. | ||
| * | ||
| * Graylog 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 Graylog. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package org.graylog.plugins.pipelineprocessor.functions.strings; | ||
|
|
||
| import com.google.common.primitives.Ints; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| 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 static com.google.common.collect.ImmutableList.of; | ||
|
|
||
| public class Replace extends AbstractFunction<String> { | ||
| public static final String NAME = "replace"; | ||
| private final ParameterDescriptor<String, String> valueParam; | ||
| private final ParameterDescriptor<String, String> searchParam; | ||
| private final ParameterDescriptor<String, String> replacementParam; | ||
| private final ParameterDescriptor<Long, Integer> maxParam; | ||
|
|
||
| public Replace() { | ||
| valueParam = ParameterDescriptor.string("value").description("The text to search and replace in").build(); | ||
| searchParam = ParameterDescriptor.string("search").description("The string to search for").build(); | ||
| replacementParam = ParameterDescriptor.string("replacement").optional() | ||
| .description("The string to replace it with. Default: \"\"").build(); | ||
| maxParam = ParameterDescriptor.integer("max", Integer.class).optional() | ||
| .transform(Ints::saturatedCast) | ||
| .description("Maximum number of occurrences to replace, or -1 if no maximum. Default: -1").build(); | ||
| } | ||
|
|
||
| @Override | ||
| public String evaluate(FunctionArgs args, EvaluationContext context) { | ||
| final String text = valueParam.required(args, context); | ||
| final String searchString = searchParam.required(args, context); | ||
| final String replacement = replacementParam.optional(args, context).orElse(""); | ||
| final int max = maxParam.optional(args, context).orElse(-1); | ||
|
|
||
| return StringUtils.replace(text, searchString, replacement, max); | ||
| } | ||
|
|
||
| @Override | ||
| public FunctionDescriptor<String> descriptor() { | ||
| return FunctionDescriptor.<String>builder() | ||
| .name(NAME) | ||
| .returnType(String.class) | ||
| .params(of(valueParam, searchParam, replacementParam, maxParam)) | ||
| .description("Replaces the first \"max\" or all occurrences of a string within another string") | ||
| .build(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters