Browse Source

add released_inthelast queries (#357)

pull/358/head
Jason Dove 4 years ago committed by GitHub
parent
commit
ad2685fb2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 3
      CHANGELOG.md
  2. 40
      ErsatzTV.Infrastructure/Search/RelativeDateMultiFieldQueryParser.cs
  3. 77
      ErsatzTV.Infrastructure/Search/RelativeDateQueryParser.cs
  4. 4
      ErsatzTV.Infrastructure/Search/SearchIndex.cs
  5. 9
      docs/user-guide/search.md

3
CHANGELOG.md

@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file. @@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Added
- Add `released_inthelast` search field for relative release date queries
- Syntax is a number and a unit (days, weeks, months, years) like `1 week` or `2 years`
## [0.0.56-alpha] - 2021-09-10
### Added

40
ErsatzTV.Infrastructure/Search/RelativeDateMultiFieldQueryParser.cs

@ -0,0 +1,40 @@ @@ -0,0 +1,40 @@
using System;
using System.Collections.Generic;
using Lucene.Net.Analysis;
using Lucene.Net.QueryParsers.Classic;
using Lucene.Net.Search;
using Lucene.Net.Util;
namespace ErsatzTV.Infrastructure.Search
{
public class RelativeDateMultiFieldQueryParser : MultiFieldQueryParser
{
public RelativeDateMultiFieldQueryParser(
LuceneVersion matchVersion,
string[] fields,
Analyzer analyzer,
IDictionary<string, float> boosts) : base(matchVersion, fields, analyzer, boosts)
{
}
public RelativeDateMultiFieldQueryParser(LuceneVersion matchVersion, string[] fields, Analyzer analyzer) : base(
matchVersion,
fields,
analyzer)
{
}
protected override Query GetFieldQuery(string field, string queryText, int slop)
{
if (field == "released_inthelast" && RelativeDateQueryParser.ParseStart(queryText, out DateTime start))
{
var todayString = DateTime.Today.ToString("yyyyMMdd");
var dateString = start.ToString("yyyyMMdd");
return base.GetRangeQuery("release_date", dateString, todayString, true, true);
}
return base.GetFieldQuery(field, queryText, slop);
}
}
}

77
ErsatzTV.Infrastructure/Search/RelativeDateQueryParser.cs

@ -0,0 +1,77 @@ @@ -0,0 +1,77 @@
using System;
using Lucene.Net.Analysis;
using Lucene.Net.QueryParsers.Classic;
using Lucene.Net.Search;
using Lucene.Net.Util;
namespace ErsatzTV.Infrastructure.Search
{
public class RelativeDateQueryParser : QueryParser
{
public RelativeDateQueryParser(LuceneVersion matchVersion, string f, Analyzer a) : base(matchVersion, f, a)
{
}
protected internal RelativeDateQueryParser(ICharStream stream) : base(stream)
{
}
protected RelativeDateQueryParser(QueryParserTokenManager tm) : base(tm)
{
}
protected override Query GetFieldQuery(string field, string queryText, int slop)
{
if (field == "released_inthelast" && ParseStart(queryText, out DateTime start))
{
var todayString = DateTime.Today.ToString("yyyyMMdd");
var dateString = start.ToString("yyyyMMdd");
return base.GetRangeQuery("release_date", dateString, todayString, true, true);
}
return base.GetFieldQuery(field, queryText, slop);
}
internal static bool ParseStart(string text, out DateTime start)
{
start = DateTime.MinValue;
try
{
if (int.TryParse(text.Split(" ")[0], out int number))
{
if (text.Contains("day"))
{
start = DateTime.Today.AddDays(number * -1);
return true;
}
if (text.Contains("week"))
{
start = DateTime.Today.AddDays(number * -7);
return true;
}
if (text.Contains("month"))
{
start = DateTime.Today.AddMonths(number * -1);
return true;
}
if (text.Contains("year"))
{
start = DateTime.Today.AddYears(number * -1);
return true;
}
}
}
catch
{
// do nothing
}
return false;
}
}
}

4
ErsatzTV.Infrastructure/Search/SearchIndex.cs

@ -148,8 +148,8 @@ namespace ErsatzTV.Infrastructure.Search @@ -148,8 +148,8 @@ namespace ErsatzTV.Infrastructure.Search
};
using var analyzerWrapper = new PerFieldAnalyzerWrapper(analyzer, customAnalyzers);
QueryParser parser = !string.IsNullOrWhiteSpace(searchField)
? new QueryParser(AppLuceneVersion, searchField, analyzerWrapper)
: new MultiFieldQueryParser(AppLuceneVersion, new[] { TitleField }, analyzerWrapper);
? new RelativeDateQueryParser(AppLuceneVersion, searchField, analyzerWrapper)
: new RelativeDateMultiFieldQueryParser(AppLuceneVersion, new[] { TitleField }, analyzerWrapper);
parser.AllowLeadingWildcard = true;
Query query = ParseQuery(searchQuery, parser);
var filter = new DuplicateFilter(TitleAndYearField);

9
docs/user-guide/search.md

@ -24,6 +24,7 @@ The following fields are available for searching movies: @@ -24,6 +24,7 @@ The following fields are available for searching movies:
- `content_rating`: The movie content rating (case-sensitive)
- `language`: The movie audio stream language
- `release_date`: The movie release date (YYYYMMDD)
- `released_inthelast`: A range for the movie release date (days, weeks, months, years)
- `type`: Always `movie`
### Shows
@ -40,6 +41,7 @@ The following fields are available for searching shows: @@ -40,6 +41,7 @@ The following fields are available for searching shows:
- `content_rating`: The show content rating (case-sensitive)
- `language`: The show audio stream language
- `release_date`: The show release date (YYYYMMDD)
- `released_inthelast`: A range for the show release date (days, weeks, months, years)
- `type`: Always `show`
### Episodes
@ -53,6 +55,7 @@ The following fields are available for searching episodes: @@ -53,6 +55,7 @@ The following fields are available for searching episodes:
- `library_name`: The name of the library that contains the episode
- `language`: The episode audio stream language
- `release_date`: The episode release date (YYYYMMDD)
- `released_inthelast`: A range for the episode release date (days, weeks, months, years)
- `type`: Always `episode`
### Artists
@ -96,4 +99,8 @@ The following fields are available for searching music videos: @@ -96,4 +99,8 @@ The following fields are available for searching music videos:
### Lush Music
`mood:lush`
`mood:lush`
### Episodes from the past week
`type:episode AND released_inthelast:"1 week"`
Loading…
Cancel
Save