/**
* This file is part of Graylog2.
*
* Graylog2 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.
*
* Graylog2 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 Graylog2. If not, see <http://www.gnu.org/licenses/>.
*/
package org.graylog2.inputs.converters;
import au.com.bytecode.opencsv.CSVParser;
import com.google.common.base.Objects;
import com.google.common.collect.Maps;
import org.graylog2.ConfigurationException;
import org.graylog2.plugin.inputs.Converter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.util.Map;
public class CsvConverter extends Converter {
private static final Logger LOG = LoggerFactory.getLogger(CsvConverter.class);
private final String[] fieldNames;
private final char separator;
private final char quoteChar;
private final char escapeChar;
private final boolean strictQuotes;
private final boolean trimLeadingWhiteSpace;
public CsvConverter(Map<String, Object> config) throws ConfigurationException {
super(Type.CSV, config);
try {
String columnHeader = (String) config.get("column_header");
if (columnHeader == null || columnHeader.isEmpty()) {
throw new ConfigurationException("Missing column headers.");
}
separator = firstCharOrDefault(config.get("separator"), CSVParser.DEFAULT_SEPARATOR);
quoteChar = firstCharOrDefault(config.get("quote_char"), CSVParser.DEFAULT_QUOTE_CHARACTER);
escapeChar = firstCharOrDefault(config.get("escape_char"), CSVParser.DEFAULT_ESCAPE_CHARACTER);
strictQuotes = Objects.firstNonNull((Boolean) config.get("strict_quotes"), false);
trimLeadingWhiteSpace = Objects.firstNonNull((Boolean) config.get("trim_leading_whitespace"), true);
final CSVParser parser = getCsvParser();
fieldNames = parser.parseLine(columnHeader);
if (fieldNames.length == 0) {
throw new ConfigurationException("No field names found.");
}
} catch (Exception e) {
throw new ConfigurationException("Invalid configuration for CsvConverter");
}
}
@Override
public Object convert(String value) {
if (value == null || value.isEmpty()) {
return value;
}
final CSVParser parser = getCsvParser();
final Map<String, String> fields = Maps.newHashMap();
try {
final String[] strings = parser.parseLine(value);
if (strings.length != fieldNames.length) {
LOG.error("Different number of columns in CSV data ({}) and configured field names ({}). Discarding input.",
strings.length, fieldNames.length);
return null;
}
for (int i = 0; i < strings.length; i++) {
fields.put(fieldNames[i], strings[i]);
}
} catch (IOException e) {
LOG.error("Invalid CSV input, discarding input", e);
return null;
}
return fields;
}
private char firstCharOrDefault(Object configValue, char defaultValue) {
if (configValue != null) {
final String s = String.valueOf(configValue);
if (s.length() > 0) {
return s.charAt(0);
}
}
return defaultValue;
}
private CSVParser getCsvParser() {
// unfortunately CSVParser has state, so we have to re-create it every time :(
return new CSVParser(separator,
quoteChar,
escapeChar,
strictQuotes,
trimLeadingWhiteSpace);
}
@Override
public boolean buildsMultipleFields() {
return true;
}
}