org.graylog.plugins.views.search.db.SearchDbService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.plugins.views.search.db;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Streams;
import com.mongodb.BasicDBObject;
import org.bson.types.ObjectId;
import org.graylog.plugins.views.search.Query;
import org.graylog.plugins.views.search.Search;
import org.graylog.plugins.views.search.SearchRequirements;
import org.graylog.plugins.views.search.SearchSummary;
import org.graylog.plugins.views.search.searchfilters.db.SearchFiltersReFetcher;
import org.graylog2.bindings.providers.MongoJackObjectMapperProvider;
import org.graylog2.database.MongoConnection;
import org.graylog2.database.PaginatedList;
import org.joda.time.Instant;
import org.mongojack.DBCursor;
import org.mongojack.DBQuery;
import org.mongojack.DBSort;
import org.mongojack.JacksonDBCollection;
import org.mongojack.WriteResult;

import javax.inject.Inject;
import java.util.Collection;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * This class is a helper to implement a basic Mongojack-based database service that allows CRUD operations on a single DTO type.
 *
 * 
 * Subclasses can add more sophisticated search methods by access the protected "db" property.

 * Indices can be added in the constructor.
 * 
 */
public class SearchDbService {
    protected final JacksonDBCollection db;
    protected final JacksonDBCollection summarydb;
    private final SearchRequirements.Factory searchRequirementsFactory;
    private final SearchFiltersReFetcher searchFiltersRefetcher;

    @Inject
    protected SearchDbService(MongoConnection mongoConnection,
                              MongoJackObjectMapperProvider mapper,
                              SearchRequirements.Factory searchRequirementsFactory,
                              SearchFiltersReFetcher searchFiltersRefetcher) {
        this.searchRequirementsFactory = searchRequirementsFactory;
        db = JacksonDBCollection.wrap(mongoConnection.getDatabase().getCollection("searches"),
                Search.class,
                ObjectId.class,
                mapper.get());
        db.createIndex(new BasicDBObject("created_at", 1), new BasicDBObject("unique", false));
        summarydb = JacksonDBCollection.wrap(mongoConnection.getDatabase().getCollection("searches"),
                SearchSummary.class,
                ObjectId.class,
                mapper.get());
        this.searchFiltersRefetcher = searchFiltersRefetcher;
    }

    public Optional get(String id) {
        return Optional.ofNullable(db.findOneById(new ObjectId(id)))
                .map(this::getSearchWithRefetchedFilters)
                .map(this::requirementsForSearch);
    }

    private Search getSearchWithRefetchedFilters(final Search search) {
        if (searchFiltersRefetchNeeded(search)) {
            return search.toBuilder()
                    .queries(search.queries()
                            .stream()
                            .map(query -> query.toBuilder()
                                    .filters(searchFiltersRefetcher.reFetch(query.filters()))
                                    .build())
                            .collect(ImmutableSet.toImmutableSet())
                    )
                    .build();
        } else {
            return search;
        }
    }

    private boolean searchFiltersRefetchNeeded(Search search) {
        return searchFiltersRefetcher.turnedOn() &&
                search.queries()
                        .stream()
                        .anyMatch(Query::hasReferencedStreamFilters);
    }

    public Search save(Search search) {
        final Search searchToSave = requirementsForSearch(search);
        if (searchToSave.id() != null) {
            db.update(
                    DBQuery.is("_id", search.id()),
                    searchToSave,
                    true,
                    false
            );

            return searchToSave;
        }

        final WriteResult save = db.insert(searchToSave);

        return save.getSavedObject();
    }

    public PaginatedList findPaginated(DBQuery.Query search, DBSort.SortBuilder sort, int page, int perPage) {

        final DBCursor cursor = db.find(search)
                .sort(sort)
                .limit(perPage)
                .skip(perPage * Math.max(0, page - 1));

        return new PaginatedList<>(
                Streams.stream((Iterable) cursor)
                        .map(this::getSearchWithRefetchedFilters)
                        .map(this::requirementsForSearch)
                        .collect(Collectors.toList()),
                cursor.count(),
                page,
                perPage
        );
    }

    /**
     * Searches should only be deleted directly by {@link SearchesCleanUpJob} if they are no longer referenced
     * by any views. Do not directly delete searches when deleting views. The searches might still be referenced by
     * other view copies (until those copies are modified, at which time a new search would be created).
     * @param id A Search ID.
     */
    void delete(String id) {
        db.removeById(new ObjectId(id));
    }

    public Collection findByIds(Set idSet) {
        return Streams.stream((Iterable) db.find(DBQuery.in("_id", idSet.stream().map(ObjectId::new).collect(Collectors.toList()))))
                .map(this::getSearchWithRefetchedFilters)
                .map(this::requirementsForSearch)
                .collect(Collectors.toList());
    }

    public Stream streamAll() {
        return Streams.stream((Iterable) db.find())
                .map(this::getSearchWithRefetchedFilters)
                .map(this::requirementsForSearch);
    }

    private Search requirementsForSearch(Search search) {
        return searchRequirementsFactory.create(search)
                .rebuildRequirements(Search::requires, (s, newRequirements) -> s.toBuilder().requires(newRequirements).build());
    }

    Stream findSummaries() {
        return Streams.stream((Iterable) summarydb.find());
    }

    public Set getExpiredSearches(final Set neverDeleteIds, final Instant mustNotBeOlderThan) {
        return this.findSummaries()
                .filter(search -> !neverDeleteIds.contains(search.id()) && search.createdAt().isBefore(mustNotBeOlderThan))
                .map(search -> search.id())
                .collect(Collectors.toSet());
    }
}