moviewyrm/bookwyrm/connectors/self_connector.py

165 lines
5.5 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" using a bookwyrm instance as a source of book data """
from functools import reduce
import operator
from django.contrib.postgres.search import SearchRank, SearchQuery
2021-06-17 21:46:58 +00:00
from django.db.models import OuterRef, Subquery, F, Q
2020-03-28 19:55:53 +00:00
from bookwyrm import models
2020-04-29 17:57:20 +00:00
from .abstract_connector import AbstractConnector, SearchResult
2020-03-28 19:55:53 +00:00
class Connector(AbstractConnector):
2021-04-26 16:15:42 +00:00
"""instantiate a connector"""
2021-03-08 16:49:10 +00:00
2021-01-31 19:11:26 +00:00
# pylint: disable=arguments-differ
2021-06-26 16:12:23 +00:00
def search(self, query, min_confidence=0, raw=False, filters=None):
2021-04-26 16:15:42 +00:00
"""search your local database"""
filters = filters or []
if not query:
return []
# first, try searching unqiue identifiers
results = search_identifiers(query, *filters)
if not results:
# then try searching title/author
results = search_title_author(query, min_confidence, *filters)
2020-04-29 17:57:20 +00:00
search_results = []
for result in results:
2021-01-31 19:11:26 +00:00
if raw:
search_results.append(result)
else:
search_results.append(self.format_search_result(result))
if len(search_results) >= 10:
break
2021-01-31 19:11:26 +00:00
if not raw:
search_results.sort(key=lambda r: r.confidence, reverse=True)
2020-04-29 17:57:20 +00:00
return search_results
2020-03-28 19:55:53 +00:00
2021-03-01 20:09:21 +00:00
def isbn_search(self, query, raw=False):
2021-04-26 16:15:42 +00:00
"""search your local database"""
2021-03-01 20:09:21 +00:00
if not query:
return []
2021-03-08 16:49:10 +00:00
filters = [{f: query} for f in ["isbn_10", "isbn_13"]]
2021-03-01 20:09:21 +00:00
results = models.Edition.objects.filter(
reduce(operator.or_, (Q(**f) for f in filters))
).distinct()
# when there are multiple editions of the same work, pick the default.
# it would be odd for this to happen.
default_editions = models.Edition.objects.filter(
parent_work=OuterRef("parent_work")
).order_by("-edition_rank")
results = (
results.annotate(
default_id=Subquery(default_editions.values("id")[:1])
).filter(default_id=F("id"))
or results
)
2021-03-01 20:09:21 +00:00
search_results = []
for result in results:
if raw:
search_results.append(result)
else:
search_results.append(self.format_search_result(result))
if len(search_results) >= 10:
break
return search_results
2020-09-21 17:25:26 +00:00
def format_search_result(self, search_result):
cover = None
if search_result.cover:
cover = "%s%s" % (self.covers_url, search_result.cover)
return SearchResult(
2020-10-29 22:29:23 +00:00
title=search_result.title,
2020-11-13 17:47:35 +00:00
key=search_result.remote_id,
2020-10-29 22:29:23 +00:00
author=search_result.author_text,
2021-03-08 16:49:10 +00:00
year=search_result.published_date.year
if search_result.published_date
else None,
connector=self,
cover=cover,
2021-03-08 16:49:10 +00:00
confidence=search_result.rank if hasattr(search_result, "rank") else 1,
)
2021-03-01 20:09:21 +00:00
def format_isbn_search_result(self, search_result):
2021-03-13 21:55:20 +00:00
return self.format_search_result(search_result)
2021-03-01 20:09:21 +00:00
2020-05-10 19:56:59 +00:00
def is_work_data(self, data):
pass
2020-03-28 19:55:53 +00:00
2020-05-10 19:56:59 +00:00
def get_edition_from_work_data(self, data):
pass
2020-03-28 19:55:53 +00:00
def get_work_from_edition_data(self, data):
2020-05-10 19:56:59 +00:00
pass
2020-05-09 20:36:10 +00:00
def get_authors_from_data(self, data):
return None
2021-03-01 20:09:21 +00:00
def parse_isbn_search_data(self, data):
2021-04-26 16:15:42 +00:00
"""it's already in the right format, don't even worry about it"""
2021-03-01 20:09:21 +00:00
return data
2020-05-10 19:56:59 +00:00
def parse_search_data(self, data):
2021-04-26 16:15:42 +00:00
"""it's already in the right format, don't even worry about it"""
2020-05-10 19:56:59 +00:00
return data
2020-04-29 17:57:20 +00:00
def expand_book_data(self, book):
pass
def search_identifiers(query, *filters):
2021-04-26 16:15:42 +00:00
"""tries remote_id, isbn; defined as dedupe fields on the model"""
2021-06-18 21:29:24 +00:00
# pylint: disable=W0212
or_filters = [
2021-03-08 16:49:10 +00:00
{f.name: query}
for f in models.Edition._meta.get_fields()
if hasattr(f, "deduplication_field") and f.deduplication_field
]
results = models.Edition.objects.filter(
*filters, reduce(operator.or_, (Q(**f) for f in or_filters))
).distinct()
2021-06-17 21:46:58 +00:00
if results.count() <= 1:
return results
# when there are multiple editions of the same work, pick the default.
# it would be odd for this to happen.
default_editions = models.Edition.objects.filter(
parent_work=OuterRef("parent_work")
).order_by("-edition_rank")
return (
2021-06-17 21:48:19 +00:00
results.annotate(default_id=Subquery(default_editions.values("id")[:1])).filter(
default_id=F("id")
)
or results
)
def search_title_author(query, min_confidence, *filters):
2021-04-26 16:15:42 +00:00
"""searches for title and author"""
query = SearchQuery(query, config="simple") | SearchQuery(query, config="english")
2021-03-08 16:49:10 +00:00
results = (
2021-06-27 01:55:09 +00:00
models.Edition.objects.filter(*filters, search_vector=query)
.annotate(rank=SearchRank(F("search_vector"), query))
.filter(rank__gt=min_confidence)
2021-03-08 16:49:10 +00:00
.order_by("-rank")
)
# when there are multiple editions of the same work, pick the closest
2021-06-17 21:48:19 +00:00
editions_of_work = results.values("parent_work__id").values_list("parent_work__id")
2021-06-17 21:46:58 +00:00
# filter out multiple editions of the same work
for work_id in set(editions_of_work):
editions = results.filter(parent_work=work_id)
default = editions.order_by("-edition_rank").first()
default_rank = default.rank if default else 0
# if mutliple books have the top rank, pick the default edition
if default_rank == editions.first().rank:
yield default
else:
yield editions.first()