Audiobook play time

bookwyrm/activitypub/book.py

@@ -59,6 +59,7 @@ class Edition(Book):
     isbn13: str = ""
     oclcNumber: str = ""
     pages: Optional[int] = None
+    audiobookPlayTime: Optional[int] = None
     physicalFormat: str = ""
     physicalFormatDetail: str = ""
     publishers: list[str] = field(default_factory=list)

bookwyrm/forms/books.py

@@ -1,10 +1,12 @@
 """ using django model forms """
+import json
+
 from django import forms
 
 from bookwyrm import models
 from bookwyrm.models.fields import ClearableFileInputWithWarning
 from .custom_form import CustomForm
-from .widgets import ArrayWidget, SelectDateWidget, Select
+from .widgets import ArrayWidget, SelectDateWidget, Select, MinutesDurationWidget
 
 
 # pylint: disable=missing-class-docstring
@@ -34,6 +36,7 @@ class Meta:
             "physical_format",
             "physical_format_detail",
             "pages",
+            "audiobook_play_time",
             "isbn_13",
             "isbn_10",
             "openlibrary_key",
@@ -74,12 +77,24 @@ class Meta:
                 attrs={"aria-describedby": "desc_cover"}
             ),
             "physical_format": Select(
-                attrs={"aria-describedby": "desc_physical_format"}
+                attrs={
+                    "aria-describedby": "desc_physical_format",
+                    "data-toggle-on-select": "true",
+                    "data-toggle-strategy": json.dumps(
+                        {
+                            "default": "toggle-target-pages",
+                            "AudiobookFormat": "toggle-target-audiobook-play-time",
+                        }
+                    ),
+                }
             ),
             "physical_format_detail": forms.TextInput(
                 attrs={"aria-describedby": "desc_physical_format_detail"}
             ),
             "pages": forms.NumberInput(attrs={"aria-describedby": "desc_pages"}),
+            "audiobook_play_time": MinutesDurationWidget(
+                attrs={"aria-describedby": "desc_audiobook_play_time"},
+            ),
             "isbn_13": forms.TextInput(attrs={"aria-describedby": "desc_isbn_13"}),
             "isbn_10": forms.TextInput(attrs={"aria-describedby": "desc_isbn_10"}),
             "openlibrary_key": forms.TextInput(
@@ -99,6 +114,17 @@ class Meta:
             "isfdb": forms.TextInput(attrs={"aria-describedby": "desc_isfdb"}),
         }
 
+    def clean_audiobook_play_time(self):
+        """Converts a raw input in seconds to minutes"""
+        data = self.cleaned_data["audiobook_play_time"]
+
+        if data in [0, None, ""]:
+            return data
+
+        data = abs(data)
+
+        return data * 60
+
 
 class EditionFromWorkForm(CustomForm):
     def __init__(self, *args, **kwargs):

bookwyrm/forms/widgets.py

@@ -12,6 +12,21 @@ def value_from_datadict(self, data, files, name):
         return [i for i in data.getlist(name) if i]
 
 
+class MinutesDurationWidget(forms.TextInput):
+    """Custom widget displaying only hh:mm"""
+
+    def format_value(self, value):
+        """Removes seconds from a hh:mm:ss string"""
+
+        if value in [0, None, ""]:
+            return value
+
+        if len(value.split(":")) == 3 and value.endswith(":00"):
+            value = value[:-3]
+
+        return value
+
+
 class Select(forms.Select):
     """custom template for select widget"""
 

bookwyrm/migrations/0180_edition_audiobook_play_time.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.20 on 2023-08-01 13:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookwyrm", "0179_populate_sort_title"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="edition",
+            name="audiobook_play_time",
+            field=models.DurationField(blank=True, null=True),
+        ),
+    ]

bookwyrm/models/book.py

@@ -299,6 +299,10 @@ class Edition(Book):
         max_length=255, choices=FormatChoices, null=True, blank=True
     )
     physical_format_detail = fields.CharField(max_length=255, blank=True, null=True)
+    audiobook_play_time = models.DurationField(
+        blank=True,
+        null=True,
+    )
     publishers = fields.ArrayField(
         models.CharField(max_length=255), blank=True, default=list
     )

bookwyrm/static/js/forms.js

@@ -58,4 +58,37 @@
             }
         }
     });
+
+    /**
+     * Toggle between two fields depending on select value
+     *
+     * @param {target} the select that will direct the toggle
+     */
+    function handleToggleOnSelect(target) {
+        const value = target.value;
+        const toggleStrategy = JSON.parse(target.dataset.toggleStrategy);
+        let selectedTarget = "";
+
+        if (value in toggleStrategy) {
+            selectedTarget = toggleStrategy[value];
+        } else {
+            selectedTarget = toggleStrategy.default;
+        }
+
+        Object.values(toggleStrategy).forEach((toggleItem) => {
+            const toggleElement = document.getElementById(toggleItem);
+
+            if (toggleItem === selectedTarget) {
+                toggleElement.classList.remove("is-hidden");
+            } else {
+                toggleElement.classList.add("is-hidden");
+            }
+        });
+    }
+
+    document.querySelectorAll("[data-toggle-on-select]").forEach((node) => {
+        handleToggleOnSelect(node);
+
+        node.addEventListener("change", () => handleToggleOnSelect(node));
+    });
 })();

bookwyrm/templates/book/book.html

@@ -129,6 +129,10 @@ <h1 class="title" itemprop="name" dir="auto">
             <section class="is-clipped">
                 {% with book=book %}
                     <div class="content">
+                        {% include 'book/format_info.html' %}
+                    </div>
+
+                    <div class="content my-3">
                         {% include 'book/publisher_info.html' %}
                     </div>
 

bookwyrm/templates/book/edit/edit_book_form.html

@@ -286,14 +286,26 @@ <h2 class="title is-4">
                     </div>
                 </div>
 
-                <div class="field">
+                <div class="field" id="toggle-target-pages">
                     <label class="label" for="id_pages">
                         {% trans "Pages:" %}
                     </label>
                     {{ form.pages }}
 
                     {% include 'snippets/form_errors.html' with errors_list=form.pages.errors id="desc_pages" %}
                 </div>
+
+                <div class="field" id="toggle-target-audiobook-play-time">
+                    <label class="label" for="id_audiobook_play_time">
+                        {% trans "Audiobook play time:" %}
+                    </label>
+                    {{ form.audiobook_play_time }}
+                    <p class="help">
+                        {% trans "Can be filled as hours:minutes or as the total run in minutes" %}
+                    </p>
+
+                    {% include 'snippets/form_errors.html' with errors_list=form.audiobook_play_time.errors id="desc_audiobook_play_time" %}
+                </div>
             </div>
         </section>
 

bookwyrm/templates/book/format_info.html

@@ -0,0 +1,39 @@
+{% spaceless %}
+
+{% load i18n %}
+{% load book_display_tags %}
+
+{% firstof book.physical_format_detail book.get_physical_format_display as format %}
+{% firstof book.physical_format book.physical_format_detail as format_property %}
+{% with pages=book.pages %}
+{% if format or pages %}
+
+{% if format_property %}
+<meta itemprop="bookFormat" content="{{ format_property }}">
+{% if book.physical_format == "AudiobookFormat" and book.audiobook_play_time %}
+    <meta itemprop="timeRequired" content="{{ book.audiobook_play_time|iso_duration }}">
+{% endif %}
+{% endif %}
+
+{% if pages %}
+<meta itemprop="numberOfPages" content="{{ pages }}">
+{% endif %}
+
+<p>
+    {% if format and not pages %}
+        {{ format }}
+        {% if book.physical_format == "AudiobookFormat" and book.audiobook_play_time %}
+            <br />
+            {% trans "Play time:" %}
+            {{ book.audiobook_play_time|localized_duration }}
+        {% endif %}
+    {% elif format and pages %}
+        {% blocktrans %}{{ format }}, {{ pages }} pages{% endblocktrans %}
+    {% elif pages %}
+        {% blocktrans %}{{ pages }} pages{% endblocktrans %}
+    {% endif %}
+</p>
+{% endif %}
+{% endwith %}
+
+{% endspaceless %}

bookwyrm/templates/book/publisher_info.html

@@ -2,31 +2,7 @@
 
 {% load i18n %}
 {% load humanize %}
-
-{% firstof book.physical_format_detail book.get_physical_format_display as format %}
-{% firstof book.physical_format book.physical_format_detail as format_property %}
-{% with pages=book.pages %}
-{% if format or pages %}
-
-{% if format_property %}
-<meta itemprop="bookFormat" content="{{ format_property }}">
-{% endif %}
-
-{% if pages %}
-<meta itemprop="numberOfPages" content="{{ pages }}">
-{% endif %}
-
-<p>
-    {% if format and not pages %}
-        {{ format }}
-    {% elif format and pages %}
-        {% blocktrans %}{{ format }}, {{ pages }} pages{% endblocktrans %}
-    {% elif pages %}
-        {% blocktrans %}{{ pages }} pages{% endblocktrans %}
-    {% endif %}
-</p>
-{% endif %}
-{% endwith %}
+{% load book_display_tags %}
 
 {% if book.languages %}
     {% for language in book.languages %}

bookwyrm/templatetags/book_display_tags.py

@@ -1,5 +1,7 @@
 """ template filters """
 from django import template
+import humanize
+
 from bookwyrm import models
 
 
@@ -33,3 +35,25 @@ def get_book_file_links(book):
 def get_author_edition(book, author):
     """default edition for a book on the author page"""
     return book.author_edition(author)
+
+
+@register.filter(name="localized_duration")
+def get_localized_duration(duration):
+    """Returns a localized version of the play time"""
+
+    return humanize.precisedelta(duration)
+
+
+@register.filter(name="iso_duration")
+def get_iso_duration(duration):
+    """Returns an ISO8601 version of the play time"""
+    duration = abs(duration)
+    duration = str(duration).split(":")
+
+    iso_string = ["PT"]
+    if int(duration[0]) > 0:
+        iso_string.append(f"{str(duration[0]).zfill(2)}H")
+
+    iso_string.append(f"{str(duration[1]).zfill(2)}M")
+
+    return "".join(iso_string)

requirements.txt

@@ -11,6 +11,7 @@ django-sass-processor==1.2.2
 django-csp==3.7
 environs==9.5.0
 flower==1.2.0
+humanize==4.4.0
 libsass==0.22.0
 Markdown==3.4.1
 Pillow==9.4.0