All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.graylog.plugins.views.search.rest.MessagesResource Maven / Gradle / Ivy
/**
* 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 >, ChunkedOutput> asyncRunner = ChunkedRunner::runAsync;
Function messagesExporterFactory;
@Inject
public MessagesResource(
MessagesExporter exporter,
CommandFactory commandFactory,
SearchDomain searchDomain,
SearchExecutionGuard executionGuard,
PermittedStreams permittedStreams,
ObjectMapper objectMapper,
@SuppressWarnings("UnstableApiUsage") EventBus eventBus) {
this.commandFactory = commandFactory;
this.searchDomain = searchDomain;
this.executionGuard = executionGuard;
this.permittedStreams = permittedStreams;
this.objectMapper = objectMapper;
this.messagesExporterFactory = context -> new AuditingMessagesExporter(context, eventBus, exporter);
}
@ApiOperation(
value = "Export messages as CSV",
notes = "Use this endpoint, if you want to configure export parameters freely instead of relying on an existing Search"
)
@POST
@Produces(MoreMediaTypes.TEXT_CSV)
@NoAuditEvent("Has custom audit events")
public ChunkedOutput retrieve(@ApiParam @Valid MessagesRequest rawrequest) {
final MessagesRequest request = fillInIfNecessary(rawrequest);
executionGuard.checkUserIsPermittedToSeeStreams(request.streams(), this::hasStreamReadPermission);
ExportMessagesCommand command = commandFactory.buildFromRequest(request);
return asyncRunner.apply(chunkConsumer -> exporter().export(command, chunkConsumer));
}
private MessagesRequest fillInIfNecessary(MessagesRequest requestFromClient) {
MessagesRequest request = requestFromClient != null ? requestFromClient : MessagesRequest.withDefaults();
if (request.streams().isEmpty()) {
request = request.toBuilder().streams(loadAllAllowedStreamsForUser()).build();
}
return request;
}
@ApiOperation(value = "Export a search result as CSV")
@POST
@Path("{searchId}")
@Produces(MoreMediaTypes.TEXT_CSV)
@NoAuditEvent("Has custom audit events")
public ChunkedOutput retrieveForSearch(
@ApiParam(value = "ID of an existing Search", name = "searchId") @PathParam("searchId") String searchId,
@ApiParam(value = "Optional overrides") @Valid ResultFormat formatFromClient) {
ResultFormat format = emptyIfNull(formatFromClient);
Search search = loadSearch(searchId, format.executionState());
ExportMessagesCommand command = commandFactory.buildWithSearchOnly(search, format);
return asyncRunner.apply(chunkConsumer -> exporter(searchId).export(command, chunkConsumer));
}
@ApiOperation(value = "Export a message table as CSV")
@POST
@Path("{searchId}/{searchTypeId}")
@Produces(MoreMediaTypes.TEXT_CSV)
@NoAuditEvent("Has custom audit events")
public ChunkedOutput retrieveForSearchType(
@ApiParam(value = "ID of an existing Search", name = "searchId") @PathParam("searchId") String searchId,
@ApiParam(value = "ID of a Message Table contained in the Search", name = "searchTypeId") @PathParam("searchTypeId") String searchTypeId,
@ApiParam(value = "Optional overrides") @Valid ResultFormat formatFromClient) {
ResultFormat format = emptyIfNull(formatFromClient);
Search search = loadSearch(searchId, format.executionState());
ExportMessagesCommand command = commandFactory.buildWithMessageList(search, searchTypeId, format);
return asyncRunner.apply(chunkConsumer -> exporter(searchId, searchTypeId).export(command, chunkConsumer));
}
private MessagesExporter exporter() {
return exporter(null, null);
}
private MessagesExporter exporter(String searchId) {
return exporter(searchId, null);
}
private MessagesExporter exporter(String searchId, String searchTypeId) {
return messagesExporterFactory.apply(new AuditContext(userName(), searchId, searchTypeId));
}
private String userName() {
return Objects.requireNonNull(getCurrentUser()).getName();
}
private ResultFormat emptyIfNull(ResultFormat format) {
return format == null ? ResultFormat.empty() : format;
}
private Search loadSearch(String searchId, Map executionState) {
Search search = searchDomain.getForUser(searchId, getCurrentUser(), this::hasViewReadPermission)
.orElseThrow(() -> new NotFoundException("Search with id " + searchId + " does not exist"));
search = search.addStreamsToQueriesWithoutStreams(this::loadAllAllowedStreamsForUser);
search = search.applyExecutionState(objectMapper, executionState);
executionGuard.check(search, this::hasStreamReadPermission);
return search;
}
private boolean hasViewReadPermission(ViewDTO view) {
return isPermitted(ViewsRestPermissions.VIEW_READ, view.id());
}
private ImmutableSet loadAllAllowedStreamsForUser() {
return permittedStreams.load(this::hasStreamReadPermission);
}
private boolean hasStreamReadPermission(String streamId) {
return isPermitted(RestPermissions.STREAMS_READ, streamId);
}
}
