/**
* Copyright 2013 Lennart Koopmann <lennart@torch.sh>
*
* 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 controllers.api;
import com.fasterxml.jackson.databind.JsonNode;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import controllers.AuthenticatedController;
import lib.security.RestPermissions;
import org.graylog2.restclient.lib.APIException;
import org.graylog2.restclient.lib.ApiClient;
import org.graylog2.restclient.lib.timeranges.InvalidRangeParametersException;
import org.graylog2.restclient.lib.timeranges.TimeRange;
import org.graylog2.restclient.models.User;
import org.graylog2.restclient.models.api.requests.dashboards.UserSetWidgetPositionsRequest;
import org.graylog2.restclient.models.api.responses.dashboards.DashboardWidgetValueResponse;
import org.graylog2.restclient.models.dashboards.Dashboard;
import org.graylog2.restclient.models.dashboards.DashboardService;
import org.graylog2.restclient.models.dashboards.widgets.DashboardWidget;
import org.graylog2.restclient.models.dashboards.widgets.FieldChartWidget;
import org.graylog2.restclient.models.dashboards.widgets.QuickvaluesWidget;
import org.graylog2.restclient.models.dashboards.widgets.SearchResultChartWidget;
import org.graylog2.restclient.models.dashboards.widgets.SearchResultCountWidget;
import org.graylog2.restclient.models.dashboards.widgets.StreamSearchResultCountWidget;
import play.Logger;
import play.libs.Json;
import play.mvc.BodyParser;
import play.mvc.Http;
import play.mvc.Result;
import views.helpers.Permissions;
import javax.inject.Inject;
import java.io.IOException;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
public class DashboardsApiController extends AuthenticatedController {
private final DashboardService dashboardService;
@Inject
public DashboardsApiController(DashboardService dashboardService) {
this.dashboardService = dashboardService;
}
public Result index() {
try {
Map<String, Object> result = Maps.newHashMap();
for (Dashboard d : dashboardService.getAll()) {
Map<String, String> dashboard = Maps.newHashMap();
dashboard.put("title", d.getTitle());
dashboard.put("description", d.getDescription());
dashboard.put("created_by", (d.getCreatorUser() == null) ? null : d.getCreatorUser().getName());
result.put(d.getId(), dashboard);
}
return ok(Json.toJson(result));
} catch (APIException e) {
String message = "Could not get dashboards. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
public Result listWritable() {
try {
Map<String, Object> result = Maps.newHashMap();
for (Dashboard d : getAllWritable(currentUser())) {
Map<String, String> dashboard = Maps.newHashMap();
dashboard.put("title", d.getTitle());
dashboard.put("description", d.getDescription());
dashboard.put("created_by", (d.getCreatorUser() == null) ? null : d.getCreatorUser().getName());
result.put(d.getId(), dashboard);
}
return ok(Json.toJson(result));
} catch (APIException e) {
String message = "Could not get dashboards. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
private Iterable<? extends Dashboard> getAllWritable(User user) throws IOException, APIException {
List<Dashboard> writable = Lists.newArrayList();
for (Dashboard dashboard : dashboardService.getAll()) {
if (Permissions.isPermitted(user, RestPermissions.DASHBOARDS_EDIT, dashboard.getId())) {
writable.add(dashboard);
}
}
return writable;
}
@BodyParser.Of(BodyParser.Json.class)
public Result setWidgetPositions(String dashboardId) {
try {
Dashboard dashboard = dashboardService.get(dashboardId);
UserSetWidgetPositionsRequest positions = Json.fromJson(request().body().asJson(), UserSetWidgetPositionsRequest.class);
dashboard.setWidgetPositions(positions.positions);
} catch (APIException e) {
String message = "Could not update positions. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
return ok();
}
public Result widgetValue(String dashboardId, String widgetId, int resolution) {
try {
Dashboard dashboard = dashboardService.get(dashboardId);
DashboardWidget widget = dashboard.getWidget(widgetId);
DashboardWidgetValueResponse widgetValue = widget.getValue(api());
Object resultValue = (widget instanceof SearchResultChartWidget) ? filterValuesByResolution(resolution, widgetValue.result) : widgetValue.result;
Map<String, Object> result = Maps.newHashMap();
result.put("result", resultValue);
result.put("took_ms", widgetValue.tookMs);
result.put("calculated_at", widgetValue.calculatedAt);
result.put("time_range", widgetValue.computationTimeRange);
return ok(Json.toJson(result));
} catch (APIException e) {
String message = "Could not get dashboard. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
// in case the widget submitted its resolution, make sure we do not deliver more result values than the widget can display for performance reasons
private Object filterValuesByResolution(final int resolution, final Object resultValue) {
if (resultValue instanceof Map && resolution != -1) {
final Map<?, ?> resultMap = (Map) resultValue;
final int size = resultMap.size();
if (size > resolution) {
// using the absolute value guarantees, that there will always be enough values for the given resolution
final int factor = size / resolution;
// shortcut, no need to copy verbatim
if (factor != 1) {
final Map<Object, Object> filteredResults = new LinkedHashMap<>(resolution);
int index = 0;
for (Map.Entry entry : resultMap.entrySet()) {
// TODO: instead of sampling we might consider interpolation (compare SearchController)
if (index % factor == 0) {
filteredResults.put(entry.getKey(), entry.getValue());
}
index++;
}
return filteredResults;
}
}
}
return resultValue;
}
@BodyParser.Of(BodyParser.FormUrlEncoded.class)
public Result addWidget(String dashboardId) {
try {
final Map<String, String> params = flattenFormUrlEncoded(request().body().asFormUrlEncoded());
String query = params.get("query");
String rangeType = params.get("rangeType");
String description = params.get("description");
Dashboard dashboard = dashboardService.get(dashboardId);
// Determine timerange type.
TimeRange timerange;
try {
int relative = 0;
if (params.get("relative") != null) {
relative = Integer.parseInt(params.get("relative"));
}
timerange = TimeRange.factory(rangeType, relative, params.get("from"), params.get("to"), params.get("keyword"));
} catch (InvalidRangeParametersException e2) {
return status(400, views.html.errors.error.render("Invalid range parameters provided.", e2, request()));
} catch (IllegalArgumentException e1) {
return status(400, views.html.errors.error.render("Invalid range type provided.", e1, request()));
}
String streamId;
if (params.containsKey("streamId")) {
streamId = params.get("streamId");
} else {
streamId = params.get("streamid");
}
DashboardWidget widget;
try {
switch (DashboardWidget.Type.valueOf(params.get("widgetType"))) {
case SEARCH_RESULT_COUNT:
widget = new SearchResultCountWidget(dashboard, query, timerange, description);
break;
case STREAM_SEARCH_RESULT_COUNT:
if (!canReadStream(streamId)) return unauthorized();
widget = new StreamSearchResultCountWidget(dashboard, query, timerange, description, streamId);
break;
case FIELD_CHART:
Map<String, Object> config = new HashMap<String, Object>() {{
put("field", params.get("field"));
put("valuetype", params.get("valuetype"));
put("renderer", params.get("renderer"));
put("interpolation", params.get("interpolation"));
put("interval", params.get("interval"));
}};
if (!canReadStream(streamId)) return unauthorized();
widget = new FieldChartWidget(dashboard, query, timerange, description, streamId, config);
break;
case QUICKVALUES:
if (!canReadStream(streamId)) return unauthorized();
widget = new QuickvaluesWidget(dashboard, query, timerange, params.get("field"), description, streamId);
break;
case SEARCH_RESULT_CHART:
if (!canReadStream(streamId)) return unauthorized();
widget = new SearchResultChartWidget(dashboard, query, timerange, description, streamId, params.get("interval"));
break;
default:
throw new IllegalArgumentException();
}
} catch (IllegalArgumentException e) {
Logger.error("No such widget type: " + params.get("widgetType"));
return badRequest();
}
dashboard.addWidget(widget);
return created();
} catch (APIException e) {
String message = "Could not add widget. We got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
private boolean canReadStream(String streamId) {
if (streamId == null) return true;
return Permissions.isPermitted(RestPermissions.STREAMS_READ, streamId);
}
public Result removeWidget(String dashboardId, String widgetId) {
try {
Dashboard dashboard = dashboardService.get(dashboardId);
dashboard.removeWidget(widgetId);
return noContent();
} catch (APIException e) {
String message = "Could not get dashboard. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
@BodyParser.Of(BodyParser.FormUrlEncoded.class)
public Result updateWidgetDescription(String dashboardId, String widgetId) {
String newDescription = flattenFormUrlEncoded(request().body().asFormUrlEncoded()).get("description");
if (newDescription == null || newDescription.trim().isEmpty()) {
return badRequest();
}
try {
Dashboard dashboard = dashboardService.get(dashboardId);
DashboardWidget widget = dashboard.getWidget(widgetId);
widget.updateDescription(api(), newDescription.trim());
return ok().as(Http.MimeTypes.JSON);
} catch (APIException e) {
String message = "Could not get widget. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
@BodyParser.Of(BodyParser.FormUrlEncoded.class)
public Result updateWidgetCacheTime(String dashboardId, String widgetId) {
String newCacheTimeS = flattenFormUrlEncoded(request().body().asFormUrlEncoded()).get("cacheTime");
if (newCacheTimeS == null) {
return badRequest();
}
int newCacheTime;
try {
newCacheTime = Integer.parseInt(newCacheTimeS);
} catch (NumberFormatException e) {
return badRequest();
}
try {
Dashboard dashboard = dashboardService.get(dashboardId);
DashboardWidget widget = dashboard.getWidget(widgetId);
widget.updateCacheTime(api(), newCacheTime);
return ok().as(Http.MimeTypes.JSON);
} catch (APIException e) {
String message = "Could not get widget. We expected HTTP 200, but got a HTTP " + e.getHttpCode() + ".";
return status(504, views.html.errors.error.render(message, e, request()));
} catch (IOException e) {
return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
}
}
}