Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Opds categories feed #492

Merged
merged 26 commits into from
Jun 8, 2021
Merged

Opds categories feed #492

merged 26 commits into from
Jun 8, 2021

Commits on Jun 8, 2021

  1. Broke Server.404 with /catalogBLABLABLA/root.xml 

    The new negative test-point demonstrates that Kiwix server doesn't
distinguish /catalogBLABLABLA from /catalog.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    0a3d293 View commit details
    Browse the repository at this point in the history

  2. Fixed handling of /catalogBLABLA/root.xml & alike 

    Also removed an unneeded namespace qualifier.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    5b272ac View commit details
    Browse the repository at this point in the history

  3. Fixed the double colon in OPDS date string

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    1e0ff1f View commit details
    Browse the repository at this point in the history

  4. Moved gen_date_str() to tools/otherTools.cpp

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    54b78ea View commit details
    Browse the repository at this point in the history

  5. Serving /catalog/v2/root.xml 

    Note: This commit somewhat relaxes validation of non variable
`<updated>` elements in the OPDS feed - the contents of any `<updated>`
element is replaced with the YYYY-MM-DDThh:mm:ssZ placeholder.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    3c3cf08 View commit details
    Browse the repository at this point in the history

  6. Library::getBooksCategories() 

    Note: no unit test added
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    b259afa View commit details
    Browse the repository at this point in the history

  7. Serving /catalog/v2/categories

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    2e53b51 View commit details
    Browse the repository at this point in the history

  8. Fixing the xenial build 

    Under Ubuntu 16.04/xenial, ccache seems to have issues with multiline
raw string literals used inside macros.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    a1520ce View commit details
    Browse the repository at this point in the history

  9. /catalog/v2/* XMLs are OPDS 1.2

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    feeb9f2 View commit details
    Browse the repository at this point in the history

  10. Enter InternalServer::m_library_id 

    The new field is intended to serve as a seed for generating semi-stable
OPDS feed ids that only need to change when the library is updated.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    92c2de8 View commit details
    Browse the repository at this point in the history

  11. Serving /catalog/v2/entries 

    /catalog/v2/entries is intended to play the combined role of
/catalog/root.xml and /catalog/search of the old OPDS API. Currently,
the latter role is not yet implemented.

Implementation note: instead of tweaking and reusing
`OPDSDumper::dumpOPDSFeed()`, the generation of the OPDS feed is done via `mustache`
and a new template `static/catalog_v2_entries.xml`.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    19b59fd View commit details
    Browse the repository at this point in the history

  12. Reordered several statements 

    Reordered several statements so that the next couple of commits are a
little simpler.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    208dece View commit details
    Browse the repository at this point in the history

  13. Extracted get_search_filter()

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    4aa3c79 View commit details
    Browse the repository at this point in the history

  14. A small simplification

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    70d42ae View commit details
    Browse the repository at this point in the history

  15. RequestContext::get_optional_param()

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    b60e3ff View commit details
    Browse the repository at this point in the history

  16. /catalog/v2/entries is also a search endpoint

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    07252a1 View commit details
    Browse the repository at this point in the history

  17. /catalog/v2/searchdescription.xml

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    dfad1c3 View commit details
    Browse the repository at this point in the history

  18. /catalog/v2/entries going through OPDSDumper 

    OPDSDumper sensed threats to its job security, so it lobbied to be
involved in handling the /catalog/v2 endpoints, too.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    cdacc0c View commit details
    Browse the repository at this point in the history

  19. /catalog/v2/categories goes through OPDSDumper too

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    9ca6bd0 View commit details
    Browse the repository at this point in the history

  20. Root url is normalized once in the constructor

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    f886c8c View commit details
    Browse the repository at this point in the history

  21. Reused InternalServer::search_catalog()

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    f179799 View commit details
    Browse the repository at this point in the history

  22. Pagination info in /catalog/v2/entries

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    fa42cbc View commit details
    Browse the repository at this point in the history

  23. Moved handle_catalog_v2*() methods into a new file

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    312f2cb View commit details
    Browse the repository at this point in the history

  24. OPDSDumper::dumpOPDSFeed() works via mustache 

    This changes the output of `/catalog/search` as follows:

- Entire search query (rather than only the value of the `q` parameter)
  is put in the <title> node.

- Search performed with an empty query presents itself as "All zims".

- The feed id remains stable for identical searches on the same
  library.
    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    e799f2f View commit details
    Browse the repository at this point in the history

  25. Fixed the self link in the output of /catalog/v2/entries

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    dd60235 View commit details
    Browse the repository at this point in the history

  26. Moved OPDS templates under static/templates

    @veloman-yunkan
    veloman-yunkan committed Jun 8, 2021
    Configuration menu
    Copy the full SHA
    78083f1 View commit details
    Browse the repository at this point in the history