extractor exporting. #726

Author: Lennart Koopmann

app/controllers/ExtractorsController.java

@@ -18,6 +18,9 @@
  */
 package controllers;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.collect.Lists;
 import com.google.inject.Inject;
 import lib.APIException;
 import lib.ApiClient;
@@ -27,6 +30,7 @@
 import play.mvc.Result;
 
 import java.io.IOException;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -162,6 +166,44 @@ public Result delete(String nodeId, String inputId, String extractorId) {
         }
     }
 
+    public Result export(String nodeId, String inputId) {
+        try {
+            Node node = nodeService.loadNode(nodeId);
+            Input input = node.getInput(inputId);
+
+            BreadcrumbList bc = standardBreadcrumbs(node, input);
+            bc.addCrumb("Export", routes.ExtractorsController.export(nodeId, inputId));
+
+            List<Map<String, Object>> exports = Lists.newArrayList();
+            for (Extractor extractor : extractorService.all(node, input)) {
+                exports.add(extractor.export());
+            }
+
+            String extractorExport = "[]";
+            try {
+                ObjectMapper om = new ObjectMapper();
+                extractorExport = om.writeValueAsString(exports);
+            } catch(JsonProcessingException e) {
+                Logger.error("Could not generate extractor export.", e);
+            }
+
+            return ok(views.html.system.inputs.extractors.export.render(
+                    currentUser(),
+                    bc,
+                    node,
+                    input,
+                    extractorExport)
+            );
+        } catch (IOException e) {
+            return status(500, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
+        } catch (APIException e) {
+            String message = "Could not fetch system information. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
+            return status(500, views.html.errors.error.render(message, e, request()));
+        } catch (NodeService.NodeNotFoundException e) {
+            return status(404, views.html.errors.error.render(ApiClient.ERROR_MSG_NODE_NOT_FOUND, e, request()));
+        }
+    }
+
     private static BreadcrumbList standardBreadcrumbs(Node node, Input input) {
         BreadcrumbList bc = new BreadcrumbList();
         bc.addCrumb("System", routes.SystemController.index(0));

app/models/Extractor.java

@@ -394,4 +394,26 @@ public int getOrder() {
         return order;
     }
 
+    public Map<String, Object> export() {
+        Map<String, Object> export = Maps.newTreeMap();
+
+        List<Map<String, Object>> converterConfigList = Lists.newArrayList();
+        for (Converter converter : converters) {
+            converterConfigList.add(converter.getConfig());
+        }
+
+        export.put("title", title);
+        export.put("order", order);
+        export.put("source_field", sourceField);
+        export.put("target_field", targetField);
+        export.put("cursor_strategy", cursorStrategy.toString().toLowerCase());
+        export.put("condition_type", conditionType.toString().toLowerCase());
+        export.put("condition_value", conditionValue);
+        export.put("extractor_type", extractorType.toString().toLowerCase());
+        export.put("extractor_config", extractorConfig);
+        export.put("converters", converterConfigList);
+
+        return export;
+    }
+
 }

app/views/system/inputs/extractors/export.scala.html

@@ -0,0 +1,21 @@
+@(currentUser: User, breadcrumbs: lib.BreadcrumbList, node: Node, input: Input, extractorExport: String)
+
+@main("Export extractors", views.html.system.sidebar(), "", currentUser) {
+
+    @views.html.partials.breadcrumbs(breadcrumbs)
+
+    <div class="row-fluid">
+        <h1>
+            <i class="icon icon-cloud-download"></i>
+            Export extractors of <em>@input.getTitle</em>
+        </h1>
+
+        The extractors of an input can be exported to JSON for importing into other setups
+        or sharing in the extractor directory on <a href="http://www.graylog2.org/">graylog2.org</a>.
+    </div>
+
+    <div class="row-fluid">
+<textarea id="extractor-export-json">@extractorExport</textarea>
+    </div>
+
+}

app/views/system/inputs/extractors/manage.scala.html

@@ -2,6 +2,19 @@
 
 @main("Extractors", views.html.system.sidebar(), "", currentUser) {
 
+    <div class="pull-right">
+        <div class="btn-group">
+            <a class="btn btn-info btn-small dropdown-toggle" data-toggle="dropdown" href="#">
+                Actions
+                <span class="caret"></span>
+            </a>
+            <ul class="dropdown-menu">
+                <li><a href="#">Import extractors</a></li>
+                <li><a href="@routes.ExtractorsController.export(node.getNodeId, input.getId)">Export extractors</a></li>
+            </ul>
+        </div>
+    </div>
+
     @views.html.partials.breadcrumbs(breadcrumbs)
 
     <div class="row-fluid">

conf/routes

@@ -99,6 +99,7 @@ GET         /system/inputs/:node_id/:input_id/extractors
 GET         /system/inputs/:node_id/:input_id/extractors/new                         @controllers.ExtractorsController.newExtractor(node_id: String, input_id: String, extractor_type ?= "", field ?= "", example ?= "")
 POST        /system/inputs/:node_id/:input_id/extractors                             @controllers.ExtractorsController.create(node_id: String, input_id: String)
 POST        /system/inputs/:node_id/:input_id/extractors/:extractor_id/delete        @controllers.ExtractorsController.delete(node_id: String, input_id: String, extractor_id: String)
+GET         /system/inputs/:node_id/:input_id/extractors/export                      @controllers.ExtractorsController.export(node_id: String, input_id: String)
 
 # Users
 GET         /system/users                                                            @controllers.UsersController.index()

public/javascripts/extractors.js

@@ -253,4 +253,10 @@ $(document).ready(function() {
         }
     });
 
+    // Extractor export formatting.
+    if($("#extractor-export-json").size() > 0) {
+        var formatted = JSON.stringify(JSON.parse($("#extractor-export-json").val()), null, 2);
+        $("#extractor-export-json").val(formatted);
+    }
+
 });

public/stylesheets/main.css

@@ -1960,4 +1960,11 @@ hr.search-result-head-separator {
 
 .xtrc-order-active {
     background-color: #00a5cf;
+}
+
+#extractor-export-json {
+    width: 90%;
+    height: 700px;
+    font-family: monospace;
+    font-size: 13px;
 }