Merge pull request #10586 from SivanC/trustedbookprovider-interstitial

Migrate to Interstitial for Trusted Book Provider read actions

Author: jimchamp

openlibrary/book_providers.py

@@ -189,10 +189,14 @@ def get_template_path(self, typ: Literal['read_button', 'download_options']) ->
         return f"book_providers/{self.short_name}_{typ}.html"
 
     def render_read_button(
-        self, ed_or_solr: Edition | dict, analytics_attr: Callable[[str], str]
+        self,
+        edition_key: str,
+        ed_or_solr: Edition | dict,
+        analytics_attr: Callable[[str], str],
     ) -> TemplateResult:
         return render_template(
             self.get_template_path('read_button'),
+            edition_key,
             self.get_best_identifier(ed_or_solr),
             analytics_attr,
         )
@@ -495,7 +499,10 @@ def get_identifiers(self, ed_or_solr: Edition | dict) -> list[str]:
             return []
 
     def render_read_button(
-        self, ed_or_solr: Edition | dict, analytics_attr: Callable[[str], str]
+        self,
+        edition_key: str,
+        ed_or_solr: Edition | dict,
+        analytics_attr: Callable[[str], str],
     ) -> TemplateResult | str:
         acq_sorted = sorted(
             (
@@ -519,7 +526,7 @@ def render_read_button(
         parsed_url = parse.urlparse(url)
         domain = parsed_url.netloc
         return render_template(
-            self.get_template_path('read_button'), acquisition, domain
+            self.get_template_path('read_button'), edition_key, acquisition, domain
         )
 
     def render_download_options(self, edition: Edition, extra_args: list | None = None):

openlibrary/i18n/messages.pot

@@ -461,19 +461,20 @@ msgstr ""
 #: interstitial.html
 #, python-format
 msgid ""
-"This book is provided by %s, a third-party Open Library Trusted Book "
-"Provider"
+"This book is provided by %(book_provider)s, a third-party Open Library "
+"Trusted Book Provider"
 msgstr ""
 
 #: interstitial.html
 #, python-format
-msgid "You will be automatically redirected to %s in %s seconds..."
+msgid "In %(time)s seconds, you will be automatically redirected to: %(url)s"
 msgstr ""
 
 #: CreateListModal.html EditButtons.html account/notifications.html
 #: account/password/reset.html account/privacy.html admin/imports-add.html
 #: admin/permissions.html books/add.html databarEdit.html interstitial.html
-#: merge/authors.html my_books/dropdown_content.html type/tag/form.html
+#: merge/authors.html my_books/dropdown_content.html support.html
+#: type/tag/form.html
 msgid "Cancel"
 msgstr ""
 
@@ -590,15 +591,7 @@ msgid "Thank you very much for improving that record!"
 msgstr ""
 
 #: BookPreview.html CreateListModal.html DonateModal.html NotesModal.html
-#: ObservationsModal.html ShareModal.html
-#: book_providers/cita_press_read_button.html
-#: book_providers/direct_read_button.html
-#: book_providers/gutenberg_read_button.html
-#: book_providers/librivox_read_button.html
-#: book_providers/openstax_read_button.html
-#: book_providers/runeberg_read_button.html
-#: book_providers/standard_ebooks_read_button.html
-#: book_providers/wikisource_read_button.html covers/author_photo.html
+#: ObservationsModal.html ShareModal.html covers/author_photo.html
 #: covers/book_cover.html covers/book_cover_single_edition.html
 #: covers/book_cover_work.html covers/change.html lib/history.html
 #: my_books/dropdown_content.html native_dialog.html
@@ -836,13 +829,6 @@ msgstr ""
 msgid "Send"
 msgstr ""
 
-#: CreateListModal.html EditButtons.html account/notifications.html
-#: account/password/reset.html account/privacy.html admin/imports-add.html
-#: admin/permissions.html books/add.html databarEdit.html merge/authors.html
-#: my_books/dropdown_content.html support.html type/tag/form.html
-msgid "Cancel"
-msgstr ""
-
 #: trending.html
 msgid "Now"
 msgstr ""
@@ -2938,36 +2924,10 @@ msgstr ""
 msgid "Read eBook from Cita Press"
 msgstr ""
 
-#: book_providers/cita_press_read_button.html
-msgid ""
-"This book is available from <a href=\"https://citapress.org/\">Cita "
-"Press</a>. Cita Press is a trusted book provider of works written by "
-"women, pairing contemporary authors and designers with open access texts "
-"to make carefully designed books available for free and open source."
-msgstr ""
-
-#: book_providers/cita_press_read_button.html
-#: book_providers/direct_read_button.html
-#: book_providers/gutenberg_read_button.html
-#: book_providers/librivox_read_button.html
-#: book_providers/openstax_read_button.html
-#: book_providers/runeberg_read_button.html
-#: book_providers/standard_ebooks_read_button.html
-#: book_providers/wikisource_read_button.html
-msgid "Learn more"
-msgstr ""
-
 #: book_providers/direct_read_button.html
 msgid "Read free online"
 msgstr ""
 
-#: book_providers/direct_read_button.html
-#, python-format
-msgid ""
-"This book is freely available from <a href=\"%s\">%s</a>, an external "
-"third-party book provider."
-msgstr ""
-
 #: book_providers/gutenberg_download_options.html
 msgid "Download an HTML from Project Gutenberg"
 msgstr ""
@@ -3007,15 +2967,6 @@ msgstr ""
 msgid "Read eBook from Project Gutenberg"
 msgstr ""
 
-#: book_providers/gutenberg_read_button.html
-msgid ""
-"This book is available from <a "
-"href=\"https://www.gutenberg.org/\">Project Gutenberg</a>. Project "
-"Gutenberg is a trusted book provider of classic ebooks, supporting "
-"thousands of volunteers in the creation and distribution of over 60,000 "
-"free eBooks."
-msgstr ""
-
 #: book_providers/ia_download_options.html
 msgid "Download a PDF from Internet Archive"
 msgstr ""
@@ -3072,14 +3023,6 @@ msgstr ""
 msgid "Audiobook"
 msgstr ""
 
-#: book_providers/librivox_read_button.html
-msgid ""
-"This book is available from <a "
-"href=\"https://librivox.org/\">LibriVox</a>. LibriVox is a trusted book "
-"provider of public domain audiobooks, narrated by volunteers, distributed"
-" for free on the internet."
-msgstr ""
-
 #: book_providers/openstax_download_options.html
 msgid "Download PDF from OpenStax"
 msgstr ""
@@ -3092,15 +3035,6 @@ msgstr ""
 msgid "Read eBook from OpenStax"
 msgstr ""
 
-#: book_providers/openstax_read_button.html
-msgid ""
-"This book is available from <a "
-"href=\"https://www.openstax.org/\">OpenStax</a>. OpenStax is a trusted "
-"book provider and a 501(c)(3) nonprofit charitable corporation dedicated "
-"to providing free high-quality, peer-reviewed, openly licensed textbooks "
-"online."
-msgstr ""
-
 #: book_providers/runeberg_download_options.html
 msgid "Download all scanned images from Project Runeberg"
 msgstr ""
@@ -3145,13 +3079,6 @@ msgstr ""
 msgid "Read eBook from Project Runeberg"
 msgstr ""
 
-#: book_providers/runeberg_read_button.html
-msgid ""
-"This book is available from <a href=\"https://runeberg.org/\">Project "
-"Runeberg</a>. Project Runeberg is a trusted book provider of classic "
-"Nordic (Scandinavian) literature in electronic form."
-msgstr ""
-
 #: book_providers/standard_ebooks_download_options.html
 msgid "Download an HTML from Standard Ebooks"
 msgstr ""
@@ -3192,15 +3119,6 @@ msgstr ""
 msgid "Read eBook from Standard eBooks"
 msgstr ""
 
-#: book_providers/standard_ebooks_read_button.html
-msgid ""
-"This book is available from <a "
-"href=\"https://standardebooks.org/\">Standard Ebooks</a>. Standard Ebooks"
-" is a trusted book provider and a volunteer-driven project that produces "
-"new editions of public domain ebooks that are lovingly formatted, open "
-"source, free of copyright restrictions, and free of cost."
-msgstr ""
-
 #: book_providers/wikisource_download_options.html
 msgid "Download PDF from Wikisource"
 msgstr ""
@@ -3229,17 +3147,6 @@ msgstr ""
 msgid "Read eBook on Wikisource"
 msgstr ""
 
-#: book_providers/wikisource_read_button.html
-msgid ""
-"This book is available from <a "
-"href=\"https://wikisource.org/\">Wikisource</a>. Wikisource, a <a "
-"href=\"https://www.wikimedia.org/\">Wikimedia Foundation</a> project, is "
-"a trusted book provider of works available under the <a "
-"href=\"https://creativecommons.org/licenses/by-sa/4.0/\">CC-BY-SA</a> "
-"open content license, such as essays, historical documents, letters, "
-"speeches, and public domain books."
-msgstr ""
-
 #: books/RelatedWorksCarousel.html
 msgid "You might also like"
 msgstr ""
@@ -7859,12 +7766,6 @@ msgstr ""
 msgid "Choose a password"
 msgstr ""
 
-#: openlibrary/plugins/upstream/borrow.py
-msgid ""
-"Your account has hit a lending limit. Please try again later or contact "
-"[email protected]."
-msgstr ""
-
 #: openlibrary/plugins/upstream/account.py
 msgid "The email address you entered is invalid"
 msgstr ""
@@ -7999,9 +7900,22 @@ msgstr ""
 msgid "Notification preferences have been updated successfully."
 msgstr ""
 
-#: openlibrary/plugins/openlibrary/lists.py
-#, python-format
-msgid "Are you sure you want to remove <strong>%(title)s</strong> from your list?"
+#: openlibrary/plugins/upstream/borrow.py
+msgid ""
+"Your account has hit a lending limit. Please try again later or contact "
+"[email protected]."
+msgstr ""
+
+#: openlibrary/plugins/worksearch/code.py
+msgid "eBook?"
+msgstr ""
+
+#: openlibrary/plugins/worksearch/code.py
+msgid "First published"
+msgstr ""
+
+#: openlibrary/plugins/worksearch/code.py
+msgid "Classic eBooks"
 msgstr ""
 
 #: openlibrary/plugins/openlibrary/code.py
@@ -8108,16 +8022,9 @@ msgstr ""
 msgid "Science"
 msgstr ""
 
-#: openlibrary/plugins/worksearch/code.py
-msgid "eBook?"
-msgstr ""
-
-#: openlibrary/plugins/worksearch/code.py
-msgid "First published"
-msgstr ""
-
-#: openlibrary/plugins/worksearch/code.py
-msgid "Classic eBooks"
+#: openlibrary/plugins/openlibrary/lists.py
+#, python-format
+msgid "Are you sure you want to remove <strong>%(title)s</strong> from your list?"
 msgstr ""
 
 #: openlibrary/core/edits.py

openlibrary/macros/LoanStatus.html

@@ -56,7 +56,7 @@
 
 $elif book_provider and book_provider.short_name != 'ia':
   $# Partner Trusted Book Provider Read Buttons
-  $:book_provider.render_read_button(doc, analytics_attr)
+  $:book_provider.render_read_button(edition_key, doc, analytics_attr)
 
 $elif availability.get('is_readable') or availability.get('status') == 'open':
   $# Open / Publicly Readable (Unrestricted)

openlibrary/plugins/openlibrary/js/index.js

@@ -518,6 +518,12 @@ jQuery(function () {
             .then(module => module.initBreadcrumbSelect(crumbs));
     }
 
+    const interstitial = document.querySelector('.interstitial');
+    if (interstitial) {
+        import (/* webpackChunkName: "interstitial" */ './interstitial')
+            .then(module => module.initInterstitial(interstitial));
+    }
+
     const leaveWaitlistLinks = document.querySelectorAll('a.leave');
     if (leaveWaitlistLinks.length && document.getElementById('leave-waitinglist-dialog')) {
         import(/* webpackChunkName: "waitlist" */ './waitlist')

openlibrary/plugins/openlibrary/js/interstitial.js

@@ -0,0 +1,13 @@
+export function initInterstitial(elem) {
+    let seconds = elem.dataset.wait
+    const url = elem.dataset.url
+    const timerElement = elem.querySelector('#timer')
+    const countdown = setInterval(() => {
+        seconds--
+        timerElement.textContent = seconds
+        if (seconds === 0) {
+            clearInterval(countdown)
+            window.location.href = url
+        }
+    }, 1000) // 1 second interval
+}

openlibrary/plugins/upstream/borrow.py

@@ -25,6 +25,7 @@
 )
 from openlibrary import accounts
 from openlibrary.accounts.model import OpenLibraryAccount
+from openlibrary.app import render_template
 from openlibrary.core import (
     lending,
     models,  # noqa: F401 side effects may be needed
@@ -143,11 +144,12 @@ def POST(self, key):  # noqa: PLR0915
             and acquisitions[0].access == "open-access"
         ):
             stats.increment('ol.loans.webbook')
-            # Change this to a template call, e.g.
-            # not sure if provider.name is a thing...
-            # XXX The problem with this approach is it will not open in a new window (maybe that's okay)
-            # render_template("interstitial", url=acquisitions[0].url, provider=provider.name, wait=5)
-            raise web.seeother(acquisitions[0].url)
+            # def with(url, provider_name="", wait=5)
+            return render_template(
+                "interstitial",
+                url=acquisitions[0].url,
+                provider_name=acquisitions[0].provider_name,
+            )
 
         archive_url = get_bookreader_stream_url(edition.ocaid) + '?ref=ol'
         if i._autoReadAloud is not None:

openlibrary/templates/book_providers/cita_press_read_button.html

@@ -1,21 +1,9 @@
-$def with(cita_press_id)
+$def with(edition_key, cita_press_id)
 
 <div class="cta-button-group">
-  <a
-      href="https://citapress.org/$cita_press_id"
+  <a href="/books/${edition_key}/-/borrow?action=read"
       title="$_('Read eBook from Cita Press')"
       class="cta-btn cta-btn--available cta-btn--read cta-btn--external cta-btn--cita-press"
       target="_blank"
-       aria-haspopup="true"
-       aria-controls="cita-press-toast"
   >$_('Read')</a>
 </div>
-
-$if render_once('cita-press-toast'):
-  <div class="toast toast--book-provider" data-toast-trigger=".cta-btn--openstax" id="cita-press-toast" style="display:none">
-    <div class="toast__body">
-      $:_('This book is available from <a href="https://citapress.org/">Cita Press</a>. Cita Press is a trusted book provider of works written by women, pairing contemporary authors and designers with open access texts to make carefully designed books available for free and open source.')
-      <a href="https://citapress.org/about/">$_('Learn more')</a>
-    </div>
-    <a class="toast__close">&times;<span class="shift">$_("Close")</span></a>
-  </div>