diff --git a/src/main/java/org/qortal/controller/Controller.java b/src/main/java/org/qortal/controller/Controller.java index 17d63313..fd16cb42 100644 --- a/src/main/java/org/qortal/controller/Controller.java +++ b/src/main/java/org/qortal/controller/Controller.java @@ -13,6 +13,7 @@ import org.qortal.block.Block; import org.qortal.block.BlockChain; import org.qortal.block.BlockChain.BlockTimingByHeight; import org.qortal.controller.arbitrary.*; +import org.qortal.controller.hsqldb.HSQLDBDataCacheManager; import org.qortal.controller.repository.NamesDatabaseIntegrityCheck; import org.qortal.controller.repository.PruneManager; import org.qortal.controller.tradebot.TradeBot; @@ -34,6 +35,7 @@ import org.qortal.network.Network; import org.qortal.network.Peer; import org.qortal.network.message.*; import org.qortal.repository.*; +import org.qortal.repository.hsqldb.HSQLDBRepository; import org.qortal.repository.hsqldb.HSQLDBRepositoryFactory; import org.qortal.settings.Settings; import org.qortal.transaction.Transaction; @@ -404,6 +406,15 @@ public class Controller extends Thread { try (final Repository repository = RepositoryManager.getRepository()) { RepositoryManager.rebuildTransactionSequences(repository); ArbitraryDataCacheManager.getInstance().buildArbitraryResourcesCache(repository, false); + + if( Settings.getInstance().isDbCacheEnabled() ) { + LOGGER.info("Db Cache Starting ..."); + HSQLDBDataCacheManager hsqldbDataCacheManager = new HSQLDBDataCacheManager((HSQLDBRepository) repositoryFactory.getRepository()); + hsqldbDataCacheManager.start(); + } + else { + LOGGER.info("Db Cache Disabled"); + } } } catch (DataException e) { // If exception has no cause or message then repository is in use by some other process. diff --git a/src/main/java/org/qortal/controller/hsqldb/HSQLDBDataCacheManager.java b/src/main/java/org/qortal/controller/hsqldb/HSQLDBDataCacheManager.java new file mode 100644 index 00000000..33950a9c --- /dev/null +++ b/src/main/java/org/qortal/controller/hsqldb/HSQLDBDataCacheManager.java @@ -0,0 +1,29 @@ +package org.qortal.controller.hsqldb; + +import org.qortal.data.arbitrary.ArbitraryResourceCache; +import org.qortal.repository.RepositoryManager; +import org.qortal.repository.hsqldb.HSQLDBCacheUtils; +import org.qortal.repository.hsqldb.HSQLDBRepository; +import org.qortal.settings.Settings; + +public class HSQLDBDataCacheManager extends Thread{ + + private ArbitraryResourceCache cache = ArbitraryResourceCache.getInstance(); + private HSQLDBRepository respository; + + public HSQLDBDataCacheManager(HSQLDBRepository respository) { + this.respository = respository; + } + + @Override + public void run() { + Thread.currentThread().setName("HSQLDB Data Cache Manager"); + + this.cache + = HSQLDBCacheUtils.startCaching( + Settings.getInstance().getDbCacheThreadPriority(), + Settings.getInstance().getDbCacheFrequency(), + this.respository + ); + } +} diff --git a/src/main/java/org/qortal/data/arbitrary/ArbitraryResourceCache.java b/src/main/java/org/qortal/data/arbitrary/ArbitraryResourceCache.java new file mode 100644 index 00000000..f838cdd7 --- /dev/null +++ b/src/main/java/org/qortal/data/arbitrary/ArbitraryResourceCache.java @@ -0,0 +1,26 @@ +package org.qortal.data.arbitrary; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; + +public class ArbitraryResourceCache { + private ConcurrentHashMap> dataByService = new ConcurrentHashMap<>(); + private ConcurrentHashMap levelByName = new ConcurrentHashMap<>(); + + private ArbitraryResourceCache() {} + + private static ArbitraryResourceCache SINGLETON = new ArbitraryResourceCache(); + + public static ArbitraryResourceCache getInstance(){ + return SINGLETON; + } + + public ConcurrentHashMap getLevelByName() { + return levelByName; + } + + public ConcurrentHashMap> getDataByService() { + return this.dataByService; + } +} diff --git a/src/main/java/org/qortal/repository/hsqldb/HSQLDBArbitraryRepository.java b/src/main/java/org/qortal/repository/hsqldb/HSQLDBArbitraryRepository.java index e30d61bf..25d084ea 100644 --- a/src/main/java/org/qortal/repository/hsqldb/HSQLDBArbitraryRepository.java +++ b/src/main/java/org/qortal/repository/hsqldb/HSQLDBArbitraryRepository.java @@ -7,6 +7,8 @@ import org.qortal.arbitrary.ArbitraryDataFile; import org.qortal.arbitrary.metadata.ArbitraryDataTransactionMetadata; import org.qortal.arbitrary.misc.Category; import org.qortal.arbitrary.misc.Service; +import org.qortal.controller.arbitrary.ArbitraryDataManager; +import org.qortal.data.arbitrary.ArbitraryResourceCache; import org.qortal.data.arbitrary.ArbitraryResourceData; import org.qortal.data.arbitrary.ArbitraryResourceMetadata; import org.qortal.data.arbitrary.ArbitraryResourceStatus; @@ -18,6 +20,7 @@ import org.qortal.data.transaction.BaseTransactionData; import org.qortal.data.transaction.TransactionData; import org.qortal.repository.ArbitraryRepository; import org.qortal.repository.DataException; +import org.qortal.settings.Settings; import org.qortal.transaction.ArbitraryTransaction; import org.qortal.transaction.Transaction.ApprovalStatus; import org.qortal.utils.Base58; @@ -28,6 +31,7 @@ import java.sql.SQLException; import java.util.ArrayList; import java.util.List; import java.util.Objects; +import java.util.Optional; public class HSQLDBArbitraryRepository implements ArbitraryRepository { @@ -723,6 +727,53 @@ public class HSQLDBArbitraryRepository implements ArbitraryRepository { public List searchArbitraryResources(Service service, String query, String identifier, List names, String title, String description, boolean prefixOnly, List exactMatchNames, boolean defaultResource, SearchMode mode, Integer minLevel, Boolean followedOnly, Boolean excludeBlocked, Boolean includeMetadata, Boolean includeStatus, Long before, Long after, Integer limit, Integer offset, Boolean reverse) throws DataException { + + if(Settings.getInstance().isDbCacheEnabled()) { + + List list + = HSQLDBCacheUtils.callCache( + ArbitraryResourceCache.getInstance(), + service, query, identifier, names, title, description, prefixOnly, exactMatchNames, + defaultResource, mode, minLevel, followedOnly, excludeBlocked, includeMetadata, includeStatus, + before, after, limit, offset, reverse); + + if( !list.isEmpty() ) { + List results + = HSQLDBCacheUtils.filterList( + list, + ArbitraryResourceCache.getInstance().getLevelByName(), + Optional.ofNullable(mode), + Optional.ofNullable(service), + Optional.ofNullable(query), + Optional.ofNullable(identifier), + Optional.ofNullable(names), + Optional.ofNullable(title), + Optional.ofNullable(description), + prefixOnly, + Optional.ofNullable(exactMatchNames), + defaultResource, + Optional.ofNullable(minLevel), + Optional.ofNullable(() -> ListUtils.followedNames()), + Optional.ofNullable(ListUtils::blockedNames), + Optional.ofNullable(includeMetadata), + Optional.ofNullable(includeStatus), + Optional.ofNullable(before), + Optional.ofNullable(after), + Optional.ofNullable(limit), + Optional.ofNullable(offset), + Optional.ofNullable(reverse) + ); + + return results; + } + else { + LOGGER.info("Db Enabled Cache has zero candidates."); + } + } + else { + LOGGER.info("Db Cache Disabled."); + } + StringBuilder sql = new StringBuilder(512); List bindParams = new ArrayList<>(); diff --git a/src/main/java/org/qortal/repository/hsqldb/HSQLDBCacheUtils.java b/src/main/java/org/qortal/repository/hsqldb/HSQLDBCacheUtils.java new file mode 100644 index 00000000..f199d5d5 --- /dev/null +++ b/src/main/java/org/qortal/repository/hsqldb/HSQLDBCacheUtils.java @@ -0,0 +1,544 @@ +package org.qortal.repository.hsqldb; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.qortal.api.SearchMode; +import org.qortal.arbitrary.misc.Category; +import org.qortal.arbitrary.misc.Service; +import org.qortal.data.arbitrary.ArbitraryResourceCache; +import org.qortal.data.arbitrary.ArbitraryResourceData; +import org.qortal.data.arbitrary.ArbitraryResourceMetadata; +import org.qortal.data.arbitrary.ArbitraryResourceStatus; + +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.time.format.DateTimeFormatter; +import java.util.AbstractMap; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.Timer; +import java.util.TimerTask; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; +import java.util.function.Predicate; +import java.util.function.Supplier; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static org.qortal.api.SearchMode.LATEST; + +public class HSQLDBCacheUtils { + + private static final Logger LOGGER = LogManager.getLogger(HSQLDBCacheUtils.class); + private static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm"); + private static final Comparator CREATED_WHEN_COMPARATOR = new Comparator() { + @Override + public int compare(ArbitraryResourceData data1, ArbitraryResourceData data2) { + + Long a = data1.created; + Long b = data2.created; + + return Long.compare(a != null ? a : Long.MIN_VALUE, b != null ? b : Long.MIN_VALUE); + } + }; + private static final String DEFAULT_IDENTIFIER = "default"; + + /** + * + * @param cache + * @param service the service to filter + * @param query query for name, identifier, title or description match + * @param identifier the identifier to match + * @param names the names to match, ignored if there are exact names + * @param title the title to match for + * @param description the description to match for + * @param prefixOnly true to match on prefix only, false for match anywhere in string + * @param exactMatchNames names to match exactly, overrides names + * @param defaultResource true to query filter identifier on the default identifier and use the query terms to match candidates names only + * @param mode LATEST or ALL + * @param minLevel the minimum account level for resource creators + * @param includeOnly names to retain, exclude all others + * @param exclude names to exclude, retain all others + * @param includeMetadata true to include resource metadata in the results, false to exclude metadata + * @param includeStatus true to include resource status in the results, false to exclude status + * @param before the latest creation timestamp for any candidate + * @param after the earliest creation timestamp for any candidate + * @param limit the maximum number of resource results to return + * @param offset the number of resource results to skip after the results have been retained, filtered and sorted + * @param reverse true to reverse the sort order, false to order in chronological order + * + * @return the resource results + */ + public static List callCache( + ArbitraryResourceCache cache, + Service service, + String query, + String identifier, + List names, + String title, + String description, + boolean prefixOnly, + List exactMatchNames, + boolean defaultResource, + SearchMode mode, + Integer minLevel, + Boolean followedOnly, + Boolean excludeBlocked, + Boolean includeMetadata, + Boolean includeStatus, + Long before, + Long after, + Integer limit, + Integer offset, + Boolean reverse) { + + List candidates = new ArrayList<>(); + + // cache all results for requested service + if( service != null ) { + candidates.addAll(cache.getDataByService().getOrDefault(service.value, new ArrayList<>(0))); + } + // if no requested, then empty cache + + return candidates; + } + + /** + * Filter candidates + * + * @param candidates the candidates, they may be preprocessed + * @param levelByName name -> level map + * @param mode LATEST or ALL + * @param service the service to filter + * @param query query for name, identifier, title or description match + * @param identifier the identifier to match + * @param names the names to match, ignored if there are exact names + * @param title the title to match for + * @param description the description to match for + * @param prefixOnly true to match on prefix only, false for match anywhere in string + * @param exactMatchNames names to match exactly, overrides names + * @param defaultResource true to query filter identifier on the default identifier and use the query terms to match candidates names only + * @param minLevel the minimum account level for resource creators + * @param includeOnly names to retain, exclude all others + * @param exclude names to exclude, retain all others + * @param includeMetadata true to include resource metadata in the results, false to exclude metadata + * @param includeStatus true to include resource status in the results, false to exclude status + * @param before the latest creation timestamp for any candidate + * @param after the earliest creation timestamp for any candidate + * @param limit the maximum number of resource results to return + * @param offset the number of resource results to skip after the results have been retained, filtered and sorted + * @param reverse true to reverse the sort order, false to order in chronological order + * + * @return the resource results + */ + public static List filterList( + List candidates, + Map levelByName, + Optional mode, + Optional service, + Optional query, + Optional identifier, + Optional> names, + Optional title, + Optional description, + boolean prefixOnly, + Optional> exactMatchNames, + boolean defaultResource, + Optional minLevel, + Optional>> includeOnly, + Optional>> exclude, + Optional includeMetadata, + Optional includeStatus, + Optional before, + Optional after, + Optional limit, + Optional offset, + Optional reverse) { + + // retain only candidates with names + Stream stream = candidates.stream().filter(candidate -> candidate.name != null); + + // filter by service + if( service.isPresent() ) + stream = stream.filter(candidate -> candidate.service.equals(service.get())); + + // filter by query (either identifier, name, title or description) + if (query.isPresent()) { + + Predicate predicate + = prefixOnly ? getPrefixPredicate(query.get()) : getContainsPredicate(query.get()); + + if (defaultResource) { + stream = stream.filter( candidate -> DEFAULT_IDENTIFIER.equals( candidate.identifier ) && predicate.test(candidate.name)); + } else { + stream = stream.filter( candidate -> passQuery(predicate, candidate)); + } + } + + // filter for identifier, title and description + stream = filterTerm(identifier, data -> data.identifier, prefixOnly, stream); + stream = filterTerm(title, data -> data.metadata != null ? data.metadata.getTitle() : null, prefixOnly, stream); + stream = filterTerm(description, data -> data.metadata != null ? data.metadata.getDescription() : null, prefixOnly, stream); + + // if exact names is set, retain resources with exact names + if( exactMatchNames.isPresent() && !exactMatchNames.get().isEmpty()) { + + // key the data by lower case name + Map> dataByName + = stream.collect(Collectors.groupingBy(data -> data.name.toLowerCase())); + + // lower the case of the exact names + // retain the lower case names of the data above + List exactNamesToSearch + = exactMatchNames.get().stream() + .map(String::toLowerCase) + .collect(Collectors.toList()); + exactNamesToSearch.retainAll(dataByName.keySet()); + + // get the data for the names retained and + // set them to the stream + stream + = dataByName.entrySet().stream() + .filter(entry -> exactNamesToSearch.contains(entry.getKey())).flatMap(entry -> entry.getValue().stream()); + } + // if exact names is not set, retain resources that match + else if( names.isPresent() && !names.get().isEmpty() ) { + + stream = retainTerms(names.get(), data -> data.name, prefixOnly, stream); + } + + // filter for minimum account level + if(minLevel.isPresent()) + stream = stream.filter( candidate -> levelByName.getOrDefault(candidate.name, 0) >= minLevel.get() ); + + // if latest mode or empty + if( LATEST.equals( mode.orElse( LATEST ) ) ) { + + // Include latest item only for a name/service combination + stream + = stream.filter(candidate -> candidate.service != null && candidate.created != null ).collect( + Collectors.groupingBy( + data -> new AbstractMap.SimpleEntry<>(data.name, data.service), // name, service combination + Collectors.maxBy(Comparator.comparingLong(data -> data.created)) // latest data item + )).values().stream().filter(Optional::isPresent).map(Optional::get); // if there is a value for the group, then retain it + } + + // sort + if( reverse.isPresent() && reverse.get()) + stream = stream.sorted(CREATED_WHEN_COMPARATOR.reversed()); + else + stream = stream.sorted(CREATED_WHEN_COMPARATOR); + + // skip to offset + if( offset.isPresent() ) stream = stream.skip(offset.get()); + + // truncate to limit + if( limit.isPresent() ) stream = stream.limit(limit.get()); + + // include metadata + if( includeMetadata.isEmpty() || !includeMetadata.get() ) + stream = stream.peek( candidate -> candidate.metadata = null ); + + // include status + if( includeStatus.isEmpty() || !includeStatus.get() ) + stream = stream.peek( candidate -> candidate.status = null); + + return stream.collect(Collectors.toList()); + } + + /** + * Filter Terms + * + * @param term the term to filter + * @param stringSupplier the string of interest from the resource candidates + * @param prefixOnly true if prexif only, false for contains + * @param stream the stream of candidates + * + * @return the stream that filtered the term + */ + private static Stream filterTerm( + Optional term, + Function stringSupplier, + boolean prefixOnly, + Stream stream) { + + if(term.isPresent()){ + Predicate predicate + = prefixOnly ? getPrefixPredicate(term.get()): getContainsPredicate(term.get()); + stream = stream.filter(candidate -> predicate.test(stringSupplier.apply(candidate))); + } + + return stream; + } + + /** + * Retain Terms + * + * Retain resources that satisfy terms given. + * + * @param terms the terms to retain + * @param stringSupplier the string of interest from the resource candidates + * @param prefixOnly true if prexif only, false for contains + * @param stream the stream of candidates + * + * @return the stream that retained the terms + */ + private static Stream retainTerms( + List terms, + Function stringSupplier, + boolean prefixOnly, + Stream stream) { + + // collect the data to process, start the data to retain + List toProcess = stream.collect(Collectors.toList()); + List toRetain = new ArrayList<>(); + + // for each term, get the predicate, get a new stream process and + // apply the predicate to each data item in the stream + for( String term : terms ) { + Predicate predicate + = prefixOnly ? getPrefixPredicate(term) : getContainsPredicate(term); + toRetain.addAll( + toProcess.stream() + .filter(candidate -> predicate.test(stringSupplier.apply(candidate))) + .collect(Collectors.toList()) + ); + } + + return toRetain.stream(); + } + + private static Predicate getContainsPredicate(String term) { + return value -> value != null && value.toLowerCase().contains(term.toLowerCase()); + } + + private static Predicate getPrefixPredicate(String term) { + return value -> value != null && value.toLowerCase().startsWith(term.toLowerCase()); + } + + /** + * Pass Query + * + * Compare name, identifier, title and description + * + * @param predicate the string comparison predicate + * @param candidate the candiddte to compare + * + * @return true if there is a match, otherwise false + */ + private static boolean passQuery(Predicate predicate, ArbitraryResourceData candidate) { + + if( predicate.test(candidate.name) ) return true; + + if( predicate.test(candidate.identifier) ) return true; + + if( candidate.metadata != null ) { + + if( predicate.test(candidate.metadata.getTitle() )) return true; + if( predicate.test(candidate.metadata.getDescription())) return true; + } + + return false; + } + + /** + * Start Caching + * + * @param priorityRequested the thread priority to fill cache in + * @param frequency the frequency to fill the cache (in seconds) + * @param respository the data source + * + * @return the data cache + */ + public static ArbitraryResourceCache startCaching(int priorityRequested, int frequency, HSQLDBRepository respository) { + + final ArbitraryResourceCache cache = ArbitraryResourceCache.getInstance(); + + // ensure priority is in between 1-10 + final int priority = Math.max(0, Math.min(10, priorityRequested)); + + // Create a custom Timer with updated priority threads + Timer timer = new Timer(true) { // 'true' to make the Timer daemon + @Override + public void schedule(TimerTask task, long delay) { + Thread thread = new Thread(task) { + @Override + public void run() { + this.setPriority(priority); + super.run(); + } + }; + thread.setPriority(priority); + thread.start(); + } + }; + + TimerTask task = new TimerTask() { + @Override + public void run() { + + fillCache(ArbitraryResourceCache.getInstance(), respository); + } + }; + + // delay 1 second + timer.scheduleAtFixedRate(task, 1000, frequency * 1000); + + return cache; + } + + /** + * Fill Cache + * + * @param cache the cache to fill + * @param repository the data source to fill the cache with + */ + public static void fillCache(ArbitraryResourceCache cache, HSQLDBRepository repository) { + + try { + // ensure all data is committed in, before we query it + repository.saveChanges(); + + List resources = getResources(repository); + + Map> dataByService + = resources.stream() + .collect(Collectors.groupingBy(data -> data.service.value)); + + // lock, clear and refill + synchronized (cache.getDataByService()) { + cache.getDataByService().clear(); + cache.getDataByService().putAll(dataByService); + } + + fillNamepMap(cache.getLevelByName(), repository); + } + catch (Exception e) { + LOGGER.error(e.getMessage(), e); + } + } + + /** + * Fill Name Map + * + * Name -> Level + * + * @param levelByName the map to fill + * @param repository the data source + * + * @throws SQLException + */ + private static void fillNamepMap(ConcurrentHashMap levelByName, HSQLDBRepository repository ) throws SQLException { + + StringBuilder sql = new StringBuilder(512); + + sql.append("SELECT name, level "); + sql.append("FROM NAMES "); + sql.append("INNER JOIN ACCOUNTS on owner = account "); + + Statement statement = repository.connection.createStatement(); + + ResultSet resultSet = statement.executeQuery(sql.toString()); + + if (resultSet == null) + return; + + if (!resultSet.next()) + return; + + do { + levelByName.put(resultSet.getString(1), resultSet.getInt(2)); + } while(resultSet.next()); + } + + /** + * Get Resource + * + * @param repository source data + * + * @return the resources + * @throws SQLException + */ + private static List getResources( HSQLDBRepository repository) throws SQLException { + + List resources = new ArrayList<>(); + + StringBuilder sql = new StringBuilder(512); + + sql.append("SELECT name, service, identifier, size, status, created_when, updated_when, "); + sql.append("title, description, category, tag1, tag2, tag3, tag4, tag5 "); + sql.append("FROM ArbitraryResourcesCache "); + sql.append("LEFT JOIN ArbitraryMetadataCache USING (service, name, identifier) WHERE name IS NOT NULL"); + + List arbitraryResources = new ArrayList<>(); + Statement statement = repository.connection.createStatement(); + + ResultSet resultSet = statement.executeQuery(sql.toString()); + + if (resultSet == null) + return resources; + + if (!resultSet.next()) + return resources; + + do { + String nameResult = resultSet.getString(1); + int serviceResult = resultSet.getInt(2); + String identifierResult = resultSet.getString(3); + Integer sizeResult = resultSet.getInt(4); + Integer status = resultSet.getInt(5); + Long created = resultSet.getLong(6); + Long updated = resultSet.getLong(7); + + String titleResult = resultSet.getString(8); + String descriptionResult = resultSet.getString(9); + String category = resultSet.getString(10); + String tag1 = resultSet.getString(11); + String tag2 = resultSet.getString(12); + String tag3 = resultSet.getString(13); + String tag4 = resultSet.getString(14); + String tag5 = resultSet.getString(15); + + if (Objects.equals(identifierResult, "default")) { + // Map "default" back to null. This is optional but probably less confusing than returning "default". + identifierResult = null; + } + + ArbitraryResourceData arbitraryResourceData = new ArbitraryResourceData(); + arbitraryResourceData.name = nameResult; + arbitraryResourceData.service = Service.valueOf(serviceResult); + arbitraryResourceData.identifier = identifierResult; + arbitraryResourceData.size = sizeResult; + arbitraryResourceData.created = created; + arbitraryResourceData.updated = (updated == 0) ? null : updated; + + arbitraryResourceData.setStatus(ArbitraryResourceStatus.Status.valueOf(status)); + + ArbitraryResourceMetadata metadata = new ArbitraryResourceMetadata(); + metadata.setTitle(titleResult); + metadata.setDescription(descriptionResult); + metadata.setCategory(Category.uncategorizedValueOf(category)); + + List tags = new ArrayList<>(); + if (tag1 != null) tags.add(tag1); + if (tag2 != null) tags.add(tag2); + if (tag3 != null) tags.add(tag3); + if (tag4 != null) tags.add(tag4); + if (tag5 != null) tags.add(tag5); + metadata.setTags(!tags.isEmpty() ? tags : null); + + if (metadata.hasMetadata()) { + arbitraryResourceData.metadata = metadata; + } + + resources.add( arbitraryResourceData ); + } while (resultSet.next()); + + return resources; + } +} \ No newline at end of file diff --git a/src/main/java/org/qortal/settings/Settings.java b/src/main/java/org/qortal/settings/Settings.java index 14252840..24674735 100644 --- a/src/main/java/org/qortal/settings/Settings.java +++ b/src/main/java/org/qortal/settings/Settings.java @@ -378,6 +378,25 @@ public class Settings { * Exclude from settings.json to disable this warning. */ private Integer threadCountPerMessageTypeWarningThreshold = null; + /** + * DB Cache Enabled? + */ + private boolean dbCacheEnabled = false; + + /** + * DB Cache Thread Priority + * + * If DB Cache is disabled, then this is ignored. If value is lower then 1, than 1 is used. If value is higher + * than 10,, then 10 is used. + */ + private int dbCacheThreadPriority = 1; + + /** + * DB Cache Frequency + * + * The number of seconds in between DB cache updates. If DB Cache is disabled, then this is ignored. + */ + private int dbCacheFrequency = 120; // Domain mapping public static class ThreadLimit { @@ -1132,4 +1151,16 @@ public class Settings { public Integer getThreadCountPerMessageTypeWarningThreshold() { return this.threadCountPerMessageTypeWarningThreshold; } + + public boolean isDbCacheEnabled() { + return dbCacheEnabled; + } + + public int getDbCacheThreadPriority() { + return dbCacheThreadPriority; + } + + public int getDbCacheFrequency() { + return dbCacheFrequency; + } } diff --git a/src/test/java/org/qortal/test/repository/HSQLDBCacheUtilsTests.java b/src/test/java/org/qortal/test/repository/HSQLDBCacheUtilsTests.java new file mode 100644 index 00000000..b5dbba5d --- /dev/null +++ b/src/test/java/org/qortal/test/repository/HSQLDBCacheUtilsTests.java @@ -0,0 +1,631 @@ +package org.qortal.test.repository; + +import org.junit.Assert; +import org.junit.Test; +import org.qortal.api.SearchMode; +import org.qortal.arbitrary.misc.Service; +import org.qortal.data.arbitrary.ArbitraryResourceData; +import org.qortal.data.arbitrary.ArbitraryResourceMetadata; +import org.qortal.data.arbitrary.ArbitraryResourceStatus; +import org.qortal.repository.hsqldb.HSQLDBCacheUtils; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.function.Supplier; + +public class HSQLDBCacheUtilsTests { + + private static final Map NAME_LEVEL = Map.of("Joe", 4); + private static final String SERVICE = "service"; + private static final String QUERY = "query"; + private static final String IDENTIFIER = "identifier"; + private static final String NAMES = "names"; + private static final String TITLE = "title"; + private static final String DESCRIPTION = "description"; + private static final String PREFIX_ONLY = "prefixOnly"; + private static final String EXACT_MATCH_NAMES = "exactMatchNames"; + private static final String DEFAULT_RESOURCE = "defaultResource"; + private static final String MODE = "mode"; + private static final String MIN_LEVEL = "minLevel"; + private static final String FOLLOWED_ONLY = "followedOnly"; + private static final String EXCLUDE_BLOCKED = "excludeBlocked"; + private static final String INCLUDE_METADATA = "includeMetadata"; + private static final String INCLUDE_STATUS = "includeStatus"; + private static final String BEFORE = "before"; + private static final String AFTER = "after"; + private static final String LIMIT = "limit"; + private static final String OFFSET = "offset"; + private static final String REVERSE = "reverse"; + + @Test + public void test000EmptyQuery() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "joe"; + + List candidates = List.of(data); + + filterListByMap(candidates, NAME_LEVEL, new HashMap<>(Map.of()), 1); + } + + @Test + public void testLatestModeNoService() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(MODE, SearchMode.LATEST )), + 0); + } + + @Test + public void testLatestModeNoCreated() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "joe"; + data.service = Service.FILE; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(MODE, SearchMode.LATEST )), + 0); + } + + @Test + public void testLatestModeReturnFirst() { + ArbitraryResourceData first = new ArbitraryResourceData(); + first.name = "joe"; + first.service = Service.FILE; + first.created = 1L; + + ArbitraryResourceData last = new ArbitraryResourceData(); + last.name = "joe"; + last.service = Service.FILE; + last.created = 2L; + + List + results = filterListByMap( + List.of(first, last), + NAME_LEVEL, + new HashMap<>(Map.of(MODE, SearchMode.LATEST)), + 1 + ); + + ArbitraryResourceData singleResult = results.get(0); + Assert.assertTrue( singleResult.created == 2 ); + } + + @Test + public void testLatestModeReturn2From4() { + ArbitraryResourceData firstFile = new ArbitraryResourceData(); + firstFile.name = "joe"; + firstFile.service = Service.FILE; + firstFile.created = 1L; + + ArbitraryResourceData lastFile = new ArbitraryResourceData(); + lastFile.name = "joe"; + lastFile.service = Service.FILE; + lastFile.created = 2L; + + List + results = filterListByMap( + List.of(firstFile, lastFile), + NAME_LEVEL, + new HashMap<>(Map.of(MODE, SearchMode.LATEST)), + 1 + ); + + ArbitraryResourceData singleResult = results.get(0); + Assert.assertTrue( singleResult.created == 2 ); + } + + @Test + public void testServicePositive() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.service = Service.AUDIO; + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(SERVICE, Service.AUDIO)), + 1 + ); + } + + @Test + public void testQueryPositiveDescription() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.metadata.setDescription("has keyword"); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(QUERY, "keyword")), + 1 + ); + } + + @Test + public void testQueryNegativeDescriptionPrefix() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.metadata.setDescription("has keyword"); + data.name = "Joe"; + + filterListByMap(List.of(data), + NAME_LEVEL, new HashMap<>((Map.of(QUERY, "keyword", PREFIX_ONLY, true))), + 0); + } + + @Test + public void testQueryPositiveDescriptionPrefix() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.metadata.setDescription("keyword starts sentence"); + data.name = "Joe"; + + filterListByMap(List.of(data), + NAME_LEVEL, new HashMap<>((Map.of(QUERY, "keyword", PREFIX_ONLY, true))), + 1); + } + + @Test + public void testQueryNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + + data.name = "admin"; + data.identifier = "id-0"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(QUERY, "keyword")), + 0 + ); + } + + @Test + public void testExactNamePositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(EXACT_MATCH_NAMES,List.of("Joe"))), + 1 + ); + } + + @Test + public void testExactNameNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(EXACT_MATCH_NAMES,List.of("Joey"))), + 0 + ); + } + + @Test + public void testNamePositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Mr Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(NAMES,List.of("Joe"))), + 1 + ); + } + + @Test + public void testNameNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Jay"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(NAMES,List.of("Joe"))), + 0 + ); + } + + @Test + public void testNamePrefixOnlyPositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joey"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(NAMES,List.of("Joe"), PREFIX_ONLY, true)), + 1 + ); + } + + @Test + public void testNamePrefixOnlyNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(NAMES,List.of("Joey"), PREFIX_ONLY, true)), + 0 + ); + } + + @Test + public void testIdentifierPositive() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.identifier = "007"; + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(IDENTIFIER, "007")), + 1 + ); + } + + @Test + public void testAfterPositive() { + ArbitraryResourceData data = new ArbitraryResourceData(); + data.created = 10L; + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(AFTER, 9L)), + 1 + ); + } + + @Test + public void testBeforePositive(){ + ArbitraryResourceData data = new ArbitraryResourceData(); + data.created = 10L; + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(BEFORE, 11L)), + 1 + ); + } + + @Test + public void testTitlePositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.metadata.setTitle("Sunday"); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(TITLE, "Sunday")), + 1 + ); + } + + @Test + public void testDescriptionPositive(){ + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.metadata.setDescription("Once upon a time."); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(DESCRIPTION, "Once upon a time.")), + 1 + ); + } + + @Test + public void testMinLevelPositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(MIN_LEVEL, 4)), + 1 + ); + } + + @Test + public void testMinLevelNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, + new HashMap<>(Map.of(MIN_LEVEL, 5)), + 0 + ); + } + + @Test + public void testDefaultResourcePositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(DEFAULT_RESOURCE, true)), + 1 + ); + } + + @Test + public void testFollowedNamesPositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + Supplier> supplier = () -> List.of("admin"); + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(FOLLOWED_ONLY, supplier)), + 1 + ); + } + + @Test + public void testExcludeBlockedPositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.name = "Joe"; + + Supplier> supplier = () -> List.of("admin"); + + filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(EXCLUDE_BLOCKED, supplier)), + 1 + ); + } + + @Test + public void testIncludeMetadataPositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.name = "Joe"; + + ArbitraryResourceData result + = filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(INCLUDE_METADATA, true)), + 1 + ).get(0); + + Assert.assertNotNull(result); + Assert.assertNotNull(result.metadata); + } + + @Test + public void testIncludesMetadataNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.metadata = new ArbitraryResourceMetadata(); + data.name = "Joe"; + + ArbitraryResourceData result + = filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(INCLUDE_METADATA, false)), + 1 + ).get(0); + + Assert.assertNotNull(result); + Assert.assertNull(result.metadata); + } + + @Test + public void testIncludeStatusPositive() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.status = new ArbitraryResourceStatus(); + data.name = "Joe"; + + ArbitraryResourceData result + = filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(INCLUDE_STATUS, true)), + 1 + ).get(0); + + Assert.assertNotNull(result); + Assert.assertNotNull(result.status); + } + + @Test + public void testIncludeStatusNegative() { + + ArbitraryResourceData data = new ArbitraryResourceData(); + data.status = new ArbitraryResourceStatus(); + data.name = "Joe"; + + ArbitraryResourceData result + = filterListByMap( + List.of(data), + NAME_LEVEL, new HashMap<>(Map.of(INCLUDE_STATUS, false)), + 1 + ).get(0); + + Assert.assertNotNull(result); + Assert.assertNull(result.status); + } + + @Test + public void testLimit() { + + ArbitraryResourceData data1 = new ArbitraryResourceData(); + data1.name = "Joe"; + + ArbitraryResourceData data2 = new ArbitraryResourceData(); + data2.name = "Joe"; + + ArbitraryResourceData data3 = new ArbitraryResourceData(); + data3.name = "Joe"; + + filterListByMap( + List.of(data1, data2, data3), + NAME_LEVEL, new HashMap<>(Map.of(LIMIT, 2)), + 2 + ); + } + + @Test + public void testOffset() { + + ArbitraryResourceData data1 = new ArbitraryResourceData(); + data1.created = 1L; + data1.name = "Joe"; + + ArbitraryResourceData data2 = new ArbitraryResourceData(); + data2.created = 2L; + data2.name = "Joe"; + + ArbitraryResourceData data3 = new ArbitraryResourceData(); + data3.created = 3L; + data3.name = "Joe"; + + List result + = filterListByMap( + List.of(data1, data2, data3), + NAME_LEVEL, new HashMap<>(Map.of(OFFSET, 1)), + 2 + ); + + Assert.assertNotNull(result.get(0)); + Assert.assertTrue(2L == result.get(0).created); + } + + @Test + public void testOrder() { + + ArbitraryResourceData data2 = new ArbitraryResourceData(); + data2.created = 2L; + data2.name = "Joe"; + + ArbitraryResourceData data1 = new ArbitraryResourceData(); + data1.created = 1L; + data1.name = "Joe"; + + List result + = filterListByMap( + List.of(data2, data1), + NAME_LEVEL, new HashMap<>(), + 2 + ); + + Assert.assertNotNull(result.get(0)); + Assert.assertTrue( result.get(0).created == 1L ); + } + + @Test + public void testReverseOrder() { + ArbitraryResourceData data1 = new ArbitraryResourceData(); + data1.created = 1L; + data1.name = "Joe"; + + ArbitraryResourceData data2 = new ArbitraryResourceData(); + data2.created = 2L; + data2.name = "Joe"; + + List result + = filterListByMap( + List.of(data1, data2), + NAME_LEVEL, new HashMap<>(Map.of(REVERSE, true)), + 2); + + Assert.assertNotNull( result.get(0)); + Assert.assertTrue( result.get(0).created == 2L); + + } + public static List filterListByMap( + List candidates, + Map levelByName, + HashMap valueByKey, + int sizeToAssert) { + + Optional service = Optional.ofNullable((Service) valueByKey.get(SERVICE)); + Optional query = Optional.ofNullable( (String) valueByKey.get(QUERY)); + Optional identifier = Optional.ofNullable((String) valueByKey.get(IDENTIFIER)); + Optional> names = Optional.ofNullable((List) valueByKey.get(NAMES)); + Optional title = Optional.ofNullable((String) valueByKey.get(TITLE)); + Optional description = Optional.ofNullable((String) valueByKey.get(DESCRIPTION)); + boolean prefixOnly = valueByKey.containsKey(PREFIX_ONLY); + Optional> exactMatchNames = Optional.ofNullable((List) valueByKey.get(EXACT_MATCH_NAMES)); + boolean defaultResource = valueByKey.containsKey(DEFAULT_RESOURCE); + Optional mode = Optional.of((SearchMode) valueByKey.getOrDefault(MODE, SearchMode.ALL)); + Optional minLevel = Optional.ofNullable((Integer) valueByKey.get(MIN_LEVEL)); + Optional>> followedOnly = Optional.ofNullable((Supplier>) valueByKey.get(FOLLOWED_ONLY)); + Optional>> excludeBlocked = Optional.ofNullable((Supplier>) valueByKey.get(EXCLUDE_BLOCKED)); + Optional includeMetadata = Optional.ofNullable((Boolean) valueByKey.get(INCLUDE_METADATA)); + Optional includeStatus = Optional.ofNullable((Boolean) valueByKey.get(INCLUDE_STATUS)); + Optional before = Optional.ofNullable((Long) valueByKey.get(BEFORE)); + Optional after = Optional.ofNullable((Long) valueByKey.get(AFTER)); + Optional limit = Optional.ofNullable((Integer) valueByKey.get(LIMIT)); + Optional offset = Optional.ofNullable((Integer) valueByKey.get(OFFSET)); + Optional reverse = Optional.ofNullable((Boolean) valueByKey.get(REVERSE)); + + List filteredList + = HSQLDBCacheUtils.filterList( + candidates, + levelByName, + mode, + service, + query, + identifier, + names, + title, + description, + prefixOnly, + exactMatchNames, + defaultResource, + minLevel, + followedOnly, + excludeBlocked, + includeMetadata, + includeStatus, + before, + after, + limit, + offset, + reverse); + + Assert.assertEquals(sizeToAssert, filteredList.size()); + + return filteredList; + } +} \ No newline at end of file