Audiobook play time

bookwyrm/activitypub/book.py

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

bookwyrm/forms/books.py

@@ -1,4 +1,6 @@
 """ using django model forms """
+import json
+
 from django import forms
 
 from bookwyrm import models
@@ -33,6 +35,7 @@ class Meta:
             "physical_format",
             "physical_format_detail",
             "pages",
+            "audiobook_play_time",
             "isbn_13",
             "isbn_10",
             "openlibrary_key",
@@ -70,12 +73,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": forms.TextInput(
+                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(

bookwyrm/migrations/0173_edition_audiobook_play_time.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.2.16 on 2022-12-26 18:13
+
+import bookwyrm.models.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookwyrm", "0172_alter_user_preferred_language"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="edition",
+            name="audiobook_play_time",
+            field=bookwyrm.models.fields.PermissivePlayTime(
+                blank=True, max_length=255, null=True
+            ),
+        ),
+    ]

bookwyrm/models/book.py

@@ -295,6 +295,11 @@ 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 = fields.PermissivePlayTime(
+        max_length=255,
+        blank=True,
+        null=True,
+    )
     publishers = fields.ArrayField(
         models.CharField(max_length=255), blank=True, default=list
     )

bookwyrm/models/fields.py

@@ -1,6 +1,7 @@
 """ activitypub-aware django model fields """
 from dataclasses import MISSING
 import re
+import math
 from uuid import uuid4
 from urllib.parse import urljoin
 
@@ -538,3 +539,38 @@ def field_to_activity(self, value):
         if not value:
             return None
         return float(value)
+
+
+# pylint: disable=bare-except
+class PermissivePlayTime(CharField):
+    """The Play Time field can accept total runtime in `minutes`
+    or in `hours:minutes`, but stores it as `hours:minutes`"""
+
+    def to_python(self, value):
+        """Normalizes both kinds of inputs to formatted string"""
+        original_value = value
+        if value in (None, ""):
+            return value
+
+        try:
+            # check if value is in minutes only
+            value = int(value)
+            value = f"{str(math.floor(value / 60)).zfill(2)}:{str(value % 60).zfill(2)}"
+        except:
+            try:
+                # Check that the values can be converted to int
+                value = [int(i) for i in value.split(":")]
+                assert value[0] >= 0
+                assert 0 <= value[1] <= 60
+                # Then transform the values to str for storage
+                value = ":".join([str(i).zfill(2) for i in value])
+            except:
+                raise ValidationError(
+                    _(
+                        "%(value)s is not a valid duration in"
+                        " minutes or in the format hour:minutes"
+                    ),
+                    params={"value": original_value},
+                )
+
+        return value

bookwyrm/static/js/forms.js

@@ -2,7 +2,7 @@
     "use strict";
 
     /**
-     * Remoev input field
+     * Remove input field
      *
      * @param {event} the button click event
      */
@@ -58,4 +58,36 @@
             }
         }
     });
+
+    /**
+     * Toggle between two fields depending on select value
+     *
+     * @param {event} the change event on the associated select
+     */
+    function toggleOnSelect(event) {
+        const value = event.target.value;
+
+        const toggleStrategy = JSON.parse(event.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) => node.addEventListener("change", toggleOnSelect));
 })();

bookwyrm/templates/book/edit/edit_book_form.html

@@ -275,14 +275,26 @@ <h2 class="title is-4">
                     </div>
                 </div>
 
-                <div class="field">
+                <div class="field{% if form.physical_format.value == 'AudiobookFormat' %} is-hidden{% endif %}" 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{% if form.physical_format.value != 'AudiobookFormat' %} is-hidden{% endif %}" 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/publisher_info.html

@@ -2,6 +2,7 @@
 
 {% load i18n %}
 {% load humanize %}
+{% 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 %}
@@ -18,7 +19,13 @@
 
 <p>
     {% if format and not pages %}
-        {{ format }}
+        {% if format_property and format_property == "AudiobookFormat" and book.audiobook_play_time %}
+            {{ format }}<br />
+            {% trans "Play time:" %}
+            {{ book.audiobook_play_time|localized_duration }}
+        {% else %}
+            {{ format }}
+        {% endif %}
     {% elif format and pages %}
         {% blocktrans %}{{ format }}, {{ pages }} pages{% endblocktrans %}
     {% elif pages %}

bookwyrm/templatetags/book_display_tags.py

@@ -1,5 +1,9 @@
 """ template filters """
+import datetime
+
 from django import template
+import humanize
+
 from bookwyrm import models
 
 
@@ -33,3 +37,21 @@ 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)
+
+
+# pylint: disable=bare-except
+@register.filter(name="localized_duration")
+def get_localized_duration(duration):
+    """Returns a localized version of the play time"""
+
+    try:
+        values = [int(i) for i in duration.split(":")]
+        assert len(values) == 2
+        delta = (values[0] * 60) + values[1]
+    except:
+        return duration
+
+    duration = datetime.timedelta(minutes=delta)
+    duration = humanize.precisedelta(duration)
+
+    return duration

bookwyrm/tests/templatetags/test_book_display_tags.py

@@ -60,3 +60,10 @@ def test_get_book_file_links(self, *_):
         links = book_display_tags.get_book_file_links(self.book)
         self.assertTrue(links.exists())
         self.assertEqual(links[0], link)
+
+    def test_get_localized_duration(self, *_):
+        """just a little test of humanization"""
+
+        result = book_display_tags.get_localized_duration("12:34")
+
+        self.assertEqual(result, "12 hours and 34 minutes")

requirements.txt

@@ -10,6 +10,7 @@ django-model-utils==4.2.0
 django-sass-processor==1.2.2
 environs==9.5.0
 flower==1.2.0
+humanize==4.4.0
 libsass==0.22.0
 Markdown==3.3.3
 Pillow>=9.3.0