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.SearchResource 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 previous = searchDbService.get(search.id());
if (!isAdmin && !previous.map(existingSearch -> isOwnerOfSearch(existingSearch, username)).orElse(true)) {
throw new ForbiddenException("Unable to update search with id <" + search.id() + ">, already exists and user is not permitted to overwrite it.");
}
guard(search);
final Search saved = searchDbService.save(search.toBuilder().owner(username).build());
if (saved == null || saved.id() == null) {
return Response.serverError().build();
}
LOG.debug("Created new search object {}", saved.id());
return Response.created(URI.create(Objects.requireNonNull(saved.id()))).entity(saved).build();
}
private String username() {
return getCurrentUser() != null ? getCurrentUser().getName() : null;
}
@GET
@ApiOperation(value = "Retrieve a search query")
@Path("{id}")
public Search getSearch(@ApiParam(name = "id") @PathParam("id") String searchId) {
return searchDomain.getForUser(searchId, getCurrentUser(), this::hasViewReadPermission)
.orElseThrow(() -> new NotFoundException("Search with id " + searchId + " does not exist"));
}
private boolean hasViewReadPermission(ViewDTO view) {
final String viewId = view.id();
return isPermitted(ViewsRestPermissions.VIEW_READ, viewId)
|| (view.type().equals(ViewDTO.Type.DASHBOARD) && isPermitted(RestPermissions.DASHBOARDS_READ, viewId));
}
@GET
@ApiOperation(value = "Get all searches which the user may see")
public List getAllSearches() {
// TODO should be paginated
return searchDomain.getAllForUser(getCurrentUser(), this::hasViewReadPermission);
}
@POST
@ApiOperation(value = "Execute the referenced search query asynchronously",
notes = "Starts a new search, irrespective whether or not another is already running")
@Path("{id}/execute")
@NoAuditEvent("Creating audit event manually in method body.")
public Response executeQuery(@ApiParam(name = "id") @PathParam("id") String id,
@ApiParam Map executionState) {
Search search = getSearch(id);
search = search.addStreamsToQueriesWithoutStreams(this::loadAllAllowedStreamsForUser);
guard(search);
search = search.applyExecutionState(objectMapper, firstNonNull(executionState, Collections.emptyMap()));
final SearchJob searchJob = searchJobService.create(search, username());
postAuditEvent(searchJob);
final SearchJob runningSearchJob = queryEngine.execute(searchJob);
return Response.created(URI.create(BASE_PATH + "/status/" + runningSearchJob.getId()))
.entity(runningSearchJob)
.build();
}
private void postAuditEvent(SearchJob searchJob) {
final SearchJobExecutionEvent searchJobExecutionEvent = SearchJobExecutionEvent.create(getCurrentUser(), searchJob, DateTime.now(DateTimeZone.UTC));
this.serverEventBus.post(searchJobExecutionEvent);
}
private ImmutableSet loadAllAllowedStreamsForUser() {
return permittedStreams.load(this::hasStreamReadPermission);
}
private boolean hasStreamReadPermission(String streamId) {
return isPermitted(RestPermissions.STREAMS_READ, streamId);
}
private void guard(Search search) {
this.executionGuard.check(search, this::hasStreamReadPermission);
}
@POST
@ApiOperation(value = "Execute a new synchronous search", notes = "Executes a new search and waits for its result")
@Path("sync")
@NoAuditEvent("Creating audit event manually in method body.")
public Response executeSyncJob(@ApiParam Search search,
@ApiParam(name = "timeout", defaultValue = "60000")
@QueryParam("timeout") @DefaultValue("60000") long timeout) {
final String username = username();
search = search.addStreamsToQueriesWithoutStreams(this::loadAllAllowedStreamsForUser);
guard(search);
final SearchJob searchJob = queryEngine.execute(searchJobService.create(search, username));
postAuditEvent(searchJob);
try {
//noinspection UnstableApiUsage
Uninterruptibles.getUninterruptibly(searchJob.getResultFuture(), timeout, TimeUnit.MILLISECONDS);
} catch (ExecutionException e) {
LOG.error("Error executing search job <{}>", searchJob.getId(), e);
throw new InternalServerErrorException("Error executing search job: " + e.getMessage());
} catch (TimeoutException e) {
throw new InternalServerErrorException("Timeout while executing search job");
} catch (Exception e) {
LOG.error("Other error", e);
throw e;
}
return Response.ok(searchJob).build();
}
@GET
@ApiOperation(value = "Retrieve the status of an executed query")
@Path("status/{jobId}")
public SearchJob jobStatus(@ApiParam(name = "jobId") @PathParam("jobId") String jobId) {
final SearchJob searchJob = searchJobService.load(jobId, username()).orElseThrow(NotFoundException::new);
try {
// force a "conditional join", to catch fast responses without having to poll
//noinspection UnstableApiUsage
Uninterruptibles.getUninterruptibly(searchJob.getResultFuture(), 5, TimeUnit.MILLISECONDS);
} catch (ExecutionException | TimeoutException ignore) {
}
return searchJob;
}
@GET
@ApiOperation(value = "Metadata for the given Search object", notes = "Used for already persisted search objects")
@Path("metadata/{searchId}")
public SearchMetadata metadata(@ApiParam("searchId") @PathParam("searchId") String searchId) {
final Search search = getSearch(searchId);
return metadataForObject(search);
}
@POST
@ApiOperation(value = "Metadata for the posted Search object", notes = "Intended for search objects that aren't yet persisted (e.g. for validation or interactive purposes)")
@Path("metadata")
@NoAuditEvent("Only returning metadata for given search, not changing any data")
public SearchMetadata metadataForObject(@ApiParam @NotNull Search search) {
if (search == null) {
throw new IllegalArgumentException("Search must not be null.");
}
final Map queryMetadatas = StreamEx.of(search.queries()).toMap(Query::id, query -> queryEngine.parse(search, query));
return SearchMetadata.create(queryMetadatas, Maps.uniqueIndex(search.parameters(), Parameter::name));
}
}
