airsonic-custom/airsonic-main/src/main/java/org/airsonic/player/service/search/SearchServiceImpl.java

/*
 This file is part of Airsonic.

 Airsonic 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.

 Airsonic 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 Airsonic.  If not, see <http://www.gnu.org/licenses/>.

 Copyright 2016 (C) Airsonic Authors
 Based upon Subsonic, Copyright 2009 (C) Sindre Mehus
 */

package org.airsonic.player.service.search;

import org.airsonic.player.domain.*;
import org.airsonic.player.service.SearchService;
import org.airsonic.player.util.FileUtil;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.search.*;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.util.*;
import java.util.function.BiConsumer;
import java.util.stream.Collectors;

import static org.airsonic.player.service.search.IndexType.*;
import static org.springframework.util.ObjectUtils.isEmpty;

@Service
public class SearchServiceImpl implements SearchService {

    private static final Logger LOG = LoggerFactory.getLogger(SearchServiceImpl.class);

    @Autowired
    private QueryFactory           queryFactory;
    @Autowired
    private IndexManager           indexManager;
    @Autowired
    private SearchServiceUtilities util;

    // TODO Should be changed to SecureRandom?
    private final Random random = new Random(System.currentTimeMillis());

    public SearchServiceImpl() {
        removeLocks();
    }

    @Override
    public void startIndexing() {
        indexManager.startIndexing();
    }

    @Override
    public void index(MediaFile mediaFile) {
        indexManager.index(mediaFile);
    }

    @Override
    public void index(Artist artist, MusicFolder musicFolder) {
        indexManager.index(artist, musicFolder);
    }

    @Override
    public void index(Album album) {
        indexManager.index(album);
    }

    @Override
    public void stopIndexing() {
        indexManager.stopIndexing();
    }

    @Override
    public SearchResult search(SearchCriteria criteria, List<MusicFolder> musicFolders,
            IndexType indexType) {

        SearchResult result = new SearchResult();
        int offset = criteria.getOffset();
        int count = criteria.getCount();
        result.setOffset(offset);

        if (count <= 0)
            return result;

        IndexReader reader = null;
        try {

            reader = indexManager.createIndexReader(indexType);
            Searcher searcher = new IndexSearcher(reader);
            Query query = queryFactory.search(criteria, musicFolders, indexType);

            TopDocs topDocs = searcher.search(query, null, offset + count);
            result.setTotalHits(topDocs.totalHits);
            int start = Math.min(offset, topDocs.totalHits);
            int end = Math.min(start + count, topDocs.totalHits);

            for (int i = start; i < end; i++) {
                util.addIfAnyMatch(result, indexType, searcher.doc(topDocs.scoreDocs[i].doc));
            }

        } catch (IOException | ParseException e) {
            LOG.error("Failed to execute Lucene search.", e);
        } finally {
            FileUtil.closeQuietly(reader);
        }
        return result;
    }

    /**
     * Common processing of random method.
     * 
     * @param count Number of albums to return.
     * @param searcher
     * @param query
     * @param id2ListCallBack Callback to get D from id and store it in List
     * @return result
     * @throws IOException
     */
    private final <D> List<D> createRandomDocsList(
            int count, Searcher searcher, Query query, BiConsumer<List<D>, Integer> id2ListCallBack)
            throws IOException {

        List<Integer> docs = Arrays
                .stream(searcher.search(query, Integer.MAX_VALUE).scoreDocs)
                .map(sd -> sd.doc)
                .collect(Collectors.toList());

        List<D> result = new ArrayList<>();
        while (!docs.isEmpty() && result.size() < count) {
            int randomPos = random.nextInt(docs.size());
            Document document = searcher.doc(docs.get(randomPos));
            id2ListCallBack.accept(result, util.getId.apply(document));
            docs.remove(randomPos);
        }

        return result;
    }

    @Override
    public List<MediaFile> getRandomSongs(RandomSearchCriteria criteria) {

        IndexReader reader = null;
        try {
            reader = indexManager.createIndexReader(SONG);
            Searcher searcher = new IndexSearcher(reader);
            if (isEmpty(searcher)) {
                // At first start
                return Collections.emptyList();
            }

            Query query = queryFactory.getRandomSongs(criteria);
            return createRandomDocsList(criteria.getCount(), searcher, query,
                (dist, id) -> util.addIgnoreNull(dist, SONG, id));

        } catch (IOException e) {
            LOG.error("Failed to search or random songs.", e);
        } finally {
            FileUtil.closeQuietly(reader);
        }
        return Collections.emptyList();
    }

    @Override
    public List<MediaFile> getRandomAlbums(int count, List<MusicFolder> musicFolders) {

        IndexReader reader = null;
        try {
            reader = indexManager.createIndexReader(ALBUM);
            Searcher searcher = new IndexSearcher(reader);
            if (isEmpty(searcher)) {
                return Collections.emptyList();
            }

            Query query = queryFactory.getRandomAlbums(musicFolders);
            return createRandomDocsList(count, searcher, query,
                (dist, id) -> util.addIgnoreNull(dist, ALBUM, id));

        } catch (IOException e) {
            LOG.error("Failed to search for random albums.", e);
        } finally {
            FileUtil.closeQuietly(reader);
        }
        return Collections.emptyList();
    }

    @Override
    public List<Album> getRandomAlbumsId3(int count, List<MusicFolder> musicFolders) {

        IndexReader reader = null;
        try {
            reader = indexManager.createIndexReader(ALBUM_ID3);
            Searcher searcher = new IndexSearcher(reader);
            if (isEmpty(searcher)) {
                return Collections.emptyList();
            }

            Query query = queryFactory.getRandomAlbumsId3(musicFolders);
            return createRandomDocsList(count, searcher, query,
                (dist, id) -> util.addIgnoreNull(dist, ALBUM_ID3, id));

        } catch (IOException e) {
            LOG.error("Failed to search for random albums.", e);
        } finally {
            FileUtil.closeQuietly(reader);
        }
        return Collections.emptyList();
    }

    @Override
    public <T> ParamSearchResult<T> searchByName(String name, int offset, int count,
            List<MusicFolder> folderList, Class<T> assignableClass) {

        // we only support album, artist, and song for now
        @Nullable
        IndexType indexType = util.getIndexType.apply(assignableClass);
        @Nullable
        String fieldName = util.getFieldName.apply(assignableClass);

        ParamSearchResult<T> result = new ParamSearchResult<T>();
        result.setOffset(offset);

        if (isEmpty(indexType) || isEmpty(fieldName) || count <= 0) {
            return result;
        }

        IndexReader reader = null;

        try {
            reader = indexManager.createIndexReader(indexType);
            Searcher searcher = new IndexSearcher(reader);
            Query query = queryFactory.searchByName(fieldName, name);

            Sort sort = new Sort(new SortField(fieldName, SortField.STRING));
            TopDocs topDocs = searcher.search(query, null, offset + count, sort);

            result.setTotalHits(topDocs.totalHits);
            int start = Math.min(offset, topDocs.totalHits);
            int end = Math.min(start + count, topDocs.totalHits);

            for (int i = start; i < end; i++) {
                Document doc = searcher.doc(topDocs.scoreDocs[i].doc);
                util.addIgnoreNull(result, indexType, util.getId.apply(doc), assignableClass);
            }

        } catch (IOException | ParseException e) {
            LOG.error("Failed to execute Lucene search.", e);
        } finally {
            FileUtil.closeQuietly(reader);
        }
        return result;
    }

    /**
     * Locks are managed automatically by the framework.
     * 
     * @deprecated It becomes unnecessary at the time of version upgrade.
     */
    @Deprecated
    public void removeLocks() {
        for (IndexType indexType : IndexType.values()) {
            Directory dir = null;
            try {
                /*
                 * Static access to the accompanying method is performed as a transition period.
                 * (Unnecessary processing after updating Lucene.)
                 */
                dir = FSDirectory.open(IndexManager.getIndexDirectory(indexType));
                if (IndexWriter.isLocked(dir)) {
                    IndexWriter.unlock(dir);
                    LOG.info("Removed Lucene lock file in " + dir);
                }
            } catch (Exception x) {
                LOG.warn("Failed to remove Lucene lock file in " + dir, x);
            } finally {
                FileUtil.closeQuietly(dir);
            }
        }
    }

}