Merge pull request #6 from cdrini/feature/search-catalog

Implement search catalog support with all the common fields

Author: mekarpeles

opds2/models.py

@@ -101,7 +101,7 @@ class Catalog(BaseModel):
         None,
         description="Navigation links for browsing"
     )
-    groups: Optional[List[Dict[str, Any]]] = Field(
+    groups: Optional[List['Catalog']] = Field(
         None,
         description="Grouped collections of publications"
     )

opds2/provider.py

@@ -4,12 +4,14 @@
 """
 
 from abc import ABC, abstractmethod
+from dataclasses import dataclass
 from typing import List, Optional
+from urllib.parse import urlencode
 
 from pydantic import BaseModel
 from typing import Optional
 
-from opds2.models import Metadata, Publication, Link
+from opds2.models import Metadata, Publication, Link, Catalog
 from opds2.catalog import create_catalog
 
 
@@ -79,15 +81,113 @@ def search(
         query: str,
         limit: int = 50,
         offset: int = 0,
+        sort: Optional[str] = None,
     ) -> tuple[List[DataProviderRecord], int]:
         """Search for publications matching the query.
         
         Args:
             query: Search query string
             limit: Maximum number of results to return (default: 50)
             offset: Offset for pagination (default: 0)
+            sort: Optional sorting parameter
             
         Returns:
             List of Publication objects matching the search criteria
         """
         pass
+
+    def search_catalog(
+        self,
+        title: Optional[str] = None,
+        query: str = "",
+        limit: int = 50,
+        offset: int = 0,
+        sort: Optional[str] = None,
+    ) -> Catalog:
+        """
+        Search for publications and return an OPDS Catalog.
+
+        Args:
+            title: Optional title for the catalog
+            query: Search query string
+            limit: Maximum number of results to return (default: 50)
+            offset: Offset for pagination (default: 0)
+            sort: Optional sorting parameter
+        """
+
+        if not title:
+            title = f"Search results for '{query}'"
+        results, total = self.search(
+            query=query,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+        )
+        page = (offset // limit) + 1 if limit else 1
+        publications = [record.to_publication() for record in results]
+        params: dict[str, str] = {}
+        if query:
+            params["query"] = query
+        if limit:
+            params["limit"] = str(limit)
+        if page > 1:
+            params["page"] = str(page)
+        if sort:
+            params["sort"] = sort
+        
+        links: list[Link] = []
+        base_url = self.SEARCH_URL.replace("{?query}", "")
+
+        self_url = base_url + ("?" + urlencode(params) if params else "")
+        links.append(
+            Link(
+                rel="self",
+                href=self_url,
+                type="application/opds+json",
+            )
+        )
+        links.append(
+            Link(
+                rel="first",
+                href=base_url + "?" + urlencode(params | {"page": "1"}),
+                type="application/opds+json",
+            )
+        )
+
+        if page > 1:
+            links.append(
+                Link(
+                    rel="previous",
+                    href=base_url + "?" + urlencode(params | {"page": str(page - 1)}),
+                    type="application/opds+json",
+                )
+            )
+
+        has_more = (offset + limit) < total
+        if has_more:
+            links.append(
+                Link(
+                    rel="next",
+                    href=base_url + "?" + urlencode(params | {"page": str(page + 1)}),
+                    type="application/opds+json",
+                )
+            )
+            last_page = (total + limit - 1) // limit
+            links.append(
+                Link(
+                    rel="last",
+                    href=base_url + "?" + urlencode(params | {"page": str(last_page)}),
+                    type="application/opds+json",
+                )
+            )
+
+        return Catalog(
+            metadata=Metadata(
+                title=title,
+                numberOfItems=total,
+                itemsPerPage=limit,
+                currentPage=page,
+            ),
+            publications=publications,
+            links=links,
+        )