Hyphenate ISBN numbers and add copy button

2024-12-24 00:50:35 +00:00 · 2023-07-21 21:23:35 -04:00 · 2023-07-21 21:23:35 -04:00 · bd26da351a
commit bd26da351a
parent 07aca2f62c
12 changed files with 8044 additions and 12 deletions
--- a/bookwyrm/isbn/RangeMessage.xml
+++ b/bookwyrm/isbn/RangeMessage.xml
--- a/bookwyrm/isbn/init.py
+++ b/bookwyrm/isbn/init.py
--- a/bookwyrm/isbn/isbn.py
+++ b/bookwyrm/isbn/isbn.py
@ -0,0 +1,71 @@
+import os
+import requests
+
+from xml.etree import ElementTree
+from bookwyrm import settings
+
+
+class IsbnHyphenator:
+    __range_message_url = "https://www.isbn-international.org/export_rangemessage.xml"
+    __range_file_path = os.path.join(
+        settings.BASE_DIR, "bookwyrm", "isbn", "RangeMessage.xml"
+    )
+    __element_tree = None
+
+    def update_range_message(self):
+        response = requests.get(self.__range_message_url)
+        with open(self.__range_file_path, "w", encoding="utf-8") as file:
+            file.write(response.text)
+        self.__element_tree = None
+
+    def hyphenate(self, isbn_13):
+        if self.__element_tree is None:
+            self.__element_tree = ElementTree.parse(self.__range_file_path)
+        gs1_prefix = isbn_13[:3]
+        reg_group = self.__find_reg_group(isbn_13, gs1_prefix)
+        if reg_group is None:
+            return isbn_13  # failed to hyphenate
+        registrant = self.__find_registrant(isbn_13, gs1_prefix, reg_group)
+        if registrant is None:
+            return isbn_13  # failed to hyphenate
+        publication = isbn_13[len(gs1_prefix) + len(reg_group) + len(registrant) : -1]
+        check_digit = isbn_13[-1:]
+        return "-".join((gs1_prefix, reg_group, registrant, publication, check_digit))
+
+    def __find_reg_group(self, isbn_13, gs1_prefix):
+        for ean_ucc_el in self.__element_tree.find("EAN.UCCPrefixes").findall(
+            "EAN.UCC"
+        ):
+            if ean_ucc_el.find("Prefix").text == gs1_prefix:
+                for rule_el in ean_ucc_el.find("Rules").findall("Rule"):
+                    length = int(rule_el.find("Length").text)
+                    if length == 0:
+                        continue
+                    range = [
+                        int(x[:length]) for x in rule_el.find("Range").text.split("-")
+                    ]
+                    reg_group = isbn_13[len(gs1_prefix) : len(gs1_prefix) + length]
+                    if range[0] <= int(reg_group) <= range[1]:
+                        return reg_group
+                return None
+        return None
+
+    def __find_registrant(self, isbn_13, gs1_prefix, reg_group):
+        from_ind = len(gs1_prefix) + len(reg_group)
+        for group_el in self.__element_tree.find("RegistrationGroups").findall("Group"):
+            if group_el.find("Prefix").text == "-".join((gs1_prefix, reg_group)):
+                for rule_el in group_el.find("Rules").findall("Rule"):
+                    length = int(rule_el.find("Length").text)
+                    if length == 0:
+                        continue
+                    range = [
+                        int(x[:length]) for x in rule_el.find("Range").text.split("-")
+                    ]
+                    registrant = isbn_13[from_ind : from_ind + length]
+                    if range[0] <= int(registrant) <= range[1]:
+                        return registrant
+                return None
+        return None
+
+
+hyphenator_singleton = IsbnHyphenator()
--- a/bookwyrm/static/css/bookwyrm/components/_copy.scss
+++ b/bookwyrm/static/css/bookwyrm/components/_copy.scss
@ -28,3 +28,31 @@
 .vertical-copy button {
    width: 100%;
 }
+
+.copy-tooltip {
+  overflow: visible;
+  visibility: hidden;
+  width: 140px;
+  background-color: #555;
+  color: #fff;
+  text-align: center;
+  border-radius: 6px;
+  padding: 5px;
+  position: absolute;
+  z-index: 1;
+  margin-left: -30px;
+  margin-top: -45px;
+  opacity: 0;
+  transition: opacity 0.3s;
+}
+
+.copy-tooltip::after {
+    content: "";
+    position: absolute;
+    top: 100%;
+    left: 50%;
+    margin-left: -60px;
+    border-width: 5px;
+    border-style: solid;
+    border-color: #555 transparent transparent transparent;
+  }
--- a/bookwyrm/static/css/fonts/icomoon.eot
+++ b/bookwyrm/static/css/fonts/icomoon.eot
--- a/bookwyrm/static/css/fonts/icomoon.svg
+++ b/bookwyrm/static/css/fonts/icomoon.svg
@ -39,6 +39,7 @@
 <glyph unicode="&#xe91e;" glyph-name="graphic-heart" d="M934.176 791.52c-116.128 115.072-301.824 117.472-422.112 9.216-120.32 108.256-305.952 105.856-422.144-9.216-119.712-118.528-119.712-310.688 0-429.28 34.208-33.888 353.696-350.112 353.696-350.112 37.856-37.504 99.072-37.504 136.896 0 0 0 349.824 346.304 353.696 350.112 119.744 118.592 119.744 310.752-0.032 429.28zM888.576 407.424l-353.696-350.112c-12.576-12.512-33.088-12.512-45.6 0l-353.696 350.112c-94.4 93.44-94.4 245.472 0 338.912 91.008 90.080 237.312 93.248 333.088 7.104l43.392-39.040 43.36 39.040c95.808 86.144 242.112 83.008 333.12-7.104 94.4-93.408 94.4-245.44 0.032-338.912zM296.096 719.968c8.864 0 16-7.168 16-16s-7.168-16-16-16h-0.032c-57.408 0-103.968-46.56-103.968-103.968v-0.032c0-8.832-7.168-16-16-16s-16 7.168-16 16v0c0 75.072 60.832 135.904 135.872 135.968 0.064 0 0.064 0.032 0.128 0.032z" />
 <glyph unicode="&#xe91f;" glyph-name="graphic-paperplane" d="M1009.376 954.88c-5.312 3.424-11.36 5.12-17.376 5.12-6.176 0-12.384-1.76-17.76-5.376l-960-640c-9.888-6.56-15.328-18.112-14.048-29.952 1.216-11.808 8.896-22.016 19.936-26.368l250.368-100.192 117.728-206.016c5.632-9.888 16.096-16 27.424-16.128 0.128 0 0.224 0 0.352 0 11.232 0 21.664 5.952 27.424 15.552l66.464 110.816 310.24-124.064c3.808-1.536 7.808-2.272 11.872-2.272 5.44 0 10.816 1.376 15.68 4.128 8.448 4.736 14.24 13.056 15.872 22.624l160 960c2.080 12.576-3.488 25.184-14.176 32.128zM100.352 295.136l741.6 494.432-539.2-577.184c-2.848 1.696-5.376 3.936-8.512 5.184l-193.888 77.568zM326.048 189.888c-0.064 0.128-0.16 0.192-0.224 0.32l606.176 648.8-516.768-805.184-89.184 156.064zM806.944 12.512l-273.312 109.312c-6.496 2.56-13.248 3.424-19.936 3.808l420.864 652.416-127.616-765.536z" />
 <glyph unicode="&#xe920;" glyph-name="graphic-banknote" d="M1005.28 621.248l-320 320c-15.872 15.872-38.88 22.24-60.672 16.864-11.488-2.816-21.76-8.736-29.888-16.864-7.264-7.264-12.736-16.256-15.872-26.304-14.496-47.008-39.552-87.872-76.64-124.928-49.536-49.504-114.048-87.008-182.304-126.656-72.448-41.984-147.296-85.504-208.64-146.816-52.128-52.192-87.616-110.24-108.416-177.632-7.008-22.752-0.896-47.36 15.872-64.192l320-320c15.872-15.872 38.88-22.24 60.672-16.864 11.488 2.88 21.76 8.736 29.888 16.864 7.264 7.264 12.736 16.256 15.872 26.368 14.528 47.008 39.584 87.872 76.704 124.928 49.504 49.504 113.984 86.944 182.304 126.56 72.384 42.048 147.264 85.568 208.576 146.88 52.128 52.128 87.616 110.24 108.448 177.632 6.976 22.72 0.832 47.424-15.904 64.16zM384 0c-105.984 105.984-214.016 214.048-320 320 90.944 294.432 485.12 281.568 576 576 105.984-105.952 214.048-214.016 320.064-320-90.976-294.368-485.152-281.568-576.064-576zM625.984 483.2c-10.432 8.736-20.928 14.688-31.488 17.632-10.496 2.944-20.992 4.128-31.616 3.36-10.496-0.8-21.248-3.2-32-7.328-10.752-4.192-21.568-8.736-32.448-14.016-17.184 19.744-34.368 39.264-51.552 57.376 7.744 7.008 15.264 10.56 22.496 10.816 7.264 0.32 14.24-0.448 20.864-2.112 6.752-1.696 12.928-3.136 18.624-4.256 5.76-1.12 10.752 0.128 15.136 3.808 4.64 4 7.2 9.184 7.552 15.424 0.32 6.304-2.048 12.448-7.328 18.432-6.752 7.744-14.88 12.448-24.64 14.176-9.632 1.696-19.488 1.568-29.76-0.672-10.112-2.304-19.744-6.112-28.864-11.488s-16.448-10.88-21.888-16.256c-2.080 1.984-4.16 3.936-6.24 5.888-2.304 2.112-5.184 3.264-8.64 3.2-3.488 0-6.368-1.504-8.736-4.256-2.304-2.688-3.36-5.824-2.944-9.12 0.32-3.424 1.696-6.048 4.064-8.064 2.080-1.76 4.16-3.488 6.24-5.312-8.192-9.888-14.944-20.8-20.256-32.32-5.376-11.552-8.576-23.008-9.76-34.112-1.248-11.2-0.064-21.44 3.36-30.944 3.424-9.568 9.76-17.696 19.008-25.376 15.072-12.512 32.8-17.824 53.376-16.64 20.512 1.248 42.624 7.36 66.4 20.128 18.88-21.824 37.824-43.488 56.736-63.616-8-6.752-15.008-10.624-21.184-11.872-6.176-1.312-11.68-1.184-16.672 0.32-4.992 1.568-9.632 3.808-13.888 6.688-4.256 2.944-8.448 5.44-12.64 7.488-4.128 2.048-8.384 3.2-12.736 3.264s-8.992-2.048-14.112-6.432c-5.248-4.576-7.872-9.888-7.872-15.872 0-5.952 2.752-12 8.128-18.112 5.44-6.112 12.512-11.264 21.056-15.328s18.208-6.624 28.832-7.328c10.624-0.736 21.824 0.864 33.632 5.248 11.872 4.32 23.616 12.128 35.2 23.744 5.568-5.44 11.2-10.624 16.8-15.616 2.368-2.048 5.248-3.072 8.736-2.816 3.36 0.128 6.304 1.696 8.64 4.512 2.368 2.88 3.36 6.048 3.008 9.376-0.32 3.36-1.696 5.952-4 7.808-5.632 4.512-11.264 9.248-16.864 14.24 9.568 11.744 17.248 24.128 22.944 36.384 5.696 12.32 9.056 24.192 10.176 35.2 1.12 11.072-0.192 21.056-3.808 30.112-3.584 9.184-9.952 17.056-19.072 24.64zM447.072 461.504c-9.056-0.384-16.96 2.624-23.872 9.312-2.944 2.816-4.992 6.24-6.24 10.304-1.312 4.064-1.76 8.512-1.248 13.376 0.448 4.8 1.888 9.824 4.384 14.88 2.368 5.056 5.888 10.112 10.368 15.008 16.224-16.128 32.416-33.824 48.64-52.128-12.288-6.752-22.976-10.368-32.032-10.752zM598.016 397.44c-2.88-5.312-6.176-10.048-10.048-14.176-17.952 18.112-35.872 38.016-53.76 58.432 4.576 2.048 9.376 4.192 14.56 6.368s10.368 3.616 15.552 4.512c5.312 0.8 10.56 0.576 15.808-0.672 5.184-1.312 10.112-4.128 14.688-8.576 4.512-4.512 7.36-9.184 8.512-14.24 1.248-5.12 1.312-10.304 0.448-15.616-0.928-5.344-2.816-10.656-5.76-16.032zM470.944 250.24c6.304 5.088 15.584 4.832 21.376-1.056 6.272-6.24 6.272-16.448 0-22.688-0.512-0.512-1.056-0.864-1.632-1.312l0.064-0.064c-20.256-15.392-36.896-29.248-54.848-47.2-16.224-16.192-30.88-33.248-43.552-50.56l-20.448-28c-0.64-1.152-1.408-2.208-2.368-3.2-6.272-6.24-16.48-6.24-22.72 0-5.44 5.44-6.112 13.824-2.112 20.064l-0.064 0.064 21.888 29.888c13.664 18.688 29.376 36.992 46.752 54.368 18.080 18.144 37.6 34.336 57.6 49.696h0.064zM588.096 713.12c16.192 16.192 30.816 33.184 43.52 50.592l21.248 29.12c0.768 1.376 1.632 2.752 2.816 3.936 6.304 6.304 16.512 6.304 22.816 0 5.984-6.016 6.24-15.52 0.8-21.888l0.064-0.064-21.888-30.016c-13.696-18.688-29.376-36.928-46.752-54.304-18.080-18.080-37.568-34.336-57.568-49.696l-0.128 0.064c-6.368-5.856-16.256-5.728-22.368 0.448-6.304 6.304-6.304 16.576 0 22.88 1.12 1.184 2.432 2.016 3.744 2.752 18.816 14.368 36.96 29.44 53.696 46.176z" />
+<glyph unicode="&#xe92c;" glyph-name="copy" d="M640 704v256h-448l-192-192v-576h384v-256h640v768h-384zM192 869.49v-101.49h-101.49l101.49 101.49zM64 256v448h192v192h320v-192l-192-192v-256h-320zM576 613.49v-101.49h-101.49l101.49 101.49zM960 0h-512v448h192v192h320v-640z" />
 <glyph unicode="&#xe937;" glyph-name="barcode" d="M0 832h128v-640h-128zM192 832h64v-640h-64zM320 832h64v-640h-64zM512 832h64v-640h-64zM768 832h64v-640h-64zM960 832h64v-640h-64zM640 832h32v-640h-32zM448 832h32v-640h-32zM864 832h32v-640h-32zM0 128h64v-64h-64zM192 128h64v-64h-64zM320 128h64v-64h-64zM640 128h64v-64h-64zM960 128h64v-64h-64zM768 128h128v-64h-128zM448 128h128v-64h-128z" />
 <glyph unicode="&#xe97a;" glyph-name="spinner" d="M384 832c0 70.692 57.308 128 128 128s128-57.308 128-128c0-70.692-57.308-128-128-128s-128 57.308-128 128zM655.53 719.53c0 70.692 57.308 128 128 128s128-57.308 128-128c0-70.692-57.308-128-128-128s-128 57.308-128 128zM832 448c0 35.346 28.654 64 64 64s64-28.654 64-64c0-35.346-28.654-64-64-64s-64 28.654-64 64zM719.53 176.47c0 35.346 28.654 64 64 64s64-28.654 64-64c0-35.346-28.654-64-64-64s-64 28.654-64 64zM448.002 64c0 0 0 0 0 0 0 35.346 28.654 64 64 64s64-28.654 64-64c0 0 0 0 0 0 0-35.346-28.654-64-64-64s-64 28.654-64 64zM176.472 176.47c0 0 0 0 0 0 0 35.346 28.654 64 64 64s64-28.654 64-64c0 0 0 0 0 0 0-35.346-28.654-64-64-64s-64 28.654-64 64zM144.472 719.53c0 0 0 0 0 0 0 53.019 42.981 96 96 96s96-42.981 96-96c0 0 0 0 0 0 0-53.019-42.981-96-96-96s-96 42.981-96 96zM56 448c0 39.765 32.235 72 72 72s72-32.235 72-72c0-39.765-32.235-72-72-72s-72 32.235-72 72z" />
 <glyph unicode="&#xe986;" glyph-name="search" d="M992.262 88.604l-242.552 206.294c-25.074 22.566-51.89 32.926-73.552 31.926 57.256 67.068 91.842 154.078 91.842 249.176 0 212.078-171.922 384-384 384-212.076 0-384-171.922-384-384s171.922-384 384-384c95.098 0 182.108 34.586 249.176 91.844-1-21.662 9.36-48.478 31.926-73.552l206.294-242.552c35.322-39.246 93.022-42.554 128.22-7.356s31.892 92.898-7.354 128.22zM384 320c-141.384 0-256 114.616-256 256s114.616 256 256 256 256-114.616 256-256-114.614-256-256-256z" />
--- a/bookwyrm/static/css/fonts/icomoon.ttf
+++ b/bookwyrm/static/css/fonts/icomoon.ttf
--- a/bookwyrm/static/css/fonts/icomoon.woff
+++ b/bookwyrm/static/css/fonts/icomoon.woff
--- a/bookwyrm/static/css/vendor/icons.css
+++ b/bookwyrm/static/css/vendor/icons.css
@ -1,10 +1,10 @@
@font-face {
  font-family: 'icomoon';
-  src:  url('../fonts/icomoon.eot?r7jc98');
-  src:  url('../fonts/icomoon.eot?r7jc98#iefix') format('embedded-opentype'),
-    url('../fonts/icomoon.ttf?r7jc98') format('truetype'),
-    url('../fonts/icomoon.woff?r7jc98') format('woff'),
-    url('../fonts/icomoon.svg?r7jc98#icomoon') format('svg');
+  src:  url('../fonts/icomoon.eot?nr4nq7');
+  src:  url('../fonts/icomoon.eot?nr4nq7#iefix') format('embedded-opentype'),
+    url('../fonts/icomoon.ttf?nr4nq7') format('truetype'),
+    url('../fonts/icomoon.woff?nr4nq7') format('woff'),
+    url('../fonts/icomoon.svg?nr4nq7#icomoon') format('svg');
  font-weight: normal;
  font-style: normal;
  font-display: block;
@ -122,6 +122,9 @@
 .icon-graphic-banknote:before {
  content: "\e920";
 }
+.icon-copy:before {
+  content: "\e92c";
+}
 .icon-search:before {
  content: "\e986";
 }
--- a/bookwyrm/static/js/bookwyrm.js
+++ b/bookwyrm/static/js/bookwyrm.js
@ -65,6 +65,9 @@ let BookWyrm = new (class {
                .querySelectorAll('input[type="file"]')
                .forEach(bookwyrm.disableIfTooLarge.bind(bookwyrm));
            document.querySelectorAll("[data-copytext]").forEach(bookwyrm.copyText.bind(bookwyrm));
+            document
+                .querySelectorAll("[data-copywithtooltip]")
+                .forEach(bookwyrm.copyWithTooltip.bind(bookwyrm));
            document
                .querySelectorAll(".modal.is-active")
                .forEach(bookwyrm.handleActiveModal.bind(bookwyrm));
@ -524,6 +527,20 @@ let BookWyrm = new (class {
        textareaEl.parentNode.appendChild(copyButtonEl);
    }

+    copyWithTooltip(copyButtonEl) {
+        const text = document.getElementById(copyButtonEl.dataset.contentId).innerHTML;
+        const tooltipEl = document.getElementById(copyButtonEl.dataset.tooltipId);
+        copyButtonEl.addEventListener("click", () => {
+            navigator.clipboard.writeText(text);
+            tooltipEl.style.visibility = "visible";
+            tooltipEl.style.opacity = 1;
+            setTimeout(function() {
+                tooltipEl.style.visibility = "hidden";
+                tooltipEl.style.opacity = 0;
+            }, 3000)
+        })
+    }
+
    /**
     * Handle the details dropdown component.
     *
--- a/bookwyrm/templates/book/book_identifiers.html
+++ b/bookwyrm/templates/book/book_identifiers.html
@ -4,42 +4,48 @@
 {% if book.isbn_13 or book.oclc_number or book.asin or book.aasin or book.isfdb %}
 <dl>
    {% if book.isbn_13 %}
-        <div class="is-flex">
+        <div class="is-flex is-flex-wrap-wrap">
            <dt class="mr-1">{% trans "ISBN:" %}</dt>
-            <dd itemprop="isbn">{{ book.isbn_13 }}</dd>
+            <dd itemprop="isbn" class="mr-1" id="isbn_content">{{ hyphenated_isbn13 }}</dd>
+            <div>
+                <button class="button is-small" data-copywithtooltip data-content-id="isbn_content" data-tooltip-id="isbn_tooltip">
+                    <span class="icon icon-copy" title="{% trans "Copy ISBN" %}"></span>
+                </button>
+                <span class="copy-tooltip" id="isbn_tooltip">{% trans "Copied ISBN!" %}</span>
+            </div>
        </div>
    {% endif %}

    {% if book.oclc_number %}
-        <div class="is-flex">
+        <div class="is-flex is-flex-wrap-wrap">
            <dt class="mr-1">{% trans "OCLC Number:" %}</dt>
            <dd>{{ book.oclc_number }}</dd>
        </div>
    {% endif %}

    {% if book.asin %}
-        <div class="is-flex">
+        <div class="is-flex is-flex-wrap-wrap">
            <dt class="mr-1">{% trans "ASIN:" %}</dt>
            <dd>{{ book.asin }}</dd>
        </div>
    {% endif %}

    {% if book.aasin %}
-        <div class="is-flex">
+        <div class="is-flex is-flex-wrap-wrap">
            <dt class="mr-1">{% trans "Audible ASIN:" %}</dt>
            <dd>{{ book.aasin }}</dd>
        </div>
    {% endif %}

    {% if book.isfdb %}
-        <div class="is-flex">
+        <div class="is-flex is-flex-wrap-wrap">
            <dt class="mr-1">{% trans "ISFDB ID:" %}</dt>
            <dd>{{ book.isfdb }}</dd>
        </div>
    {% endif %}

    {% if book.goodreads_key %}
-        <div class="is-flex">
+        <div class="is-flex is-flex-wrap-wrap">
            <dt class="mr-1">{% trans "Goodreads:" %}</dt>
            <dd>{{ book.goodreads_key }}</dd>
        </div>
--- a/bookwyrm/views/books/books.py
+++ b/bookwyrm/views/books/books.py
@ -14,6 +14,7 @@ from bookwyrm import forms, models
 from bookwyrm.activitypub import ActivitypubResponse
 from bookwyrm.connectors import connector_manager, ConnectorException
 from bookwyrm.connectors.abstract_connector import get_image
+from bookwyrm.isbn.isbn import hyphenator_singleton as hyphenator
 from bookwyrm.settings import PAGE_LENGTH
 from bookwyrm.views.helpers import is_api_request, maybe_redirect_local_path

@ -90,6 +91,7 @@ class Book(View):
            "rating": reviews.aggregate(Avg("rating"))["rating__avg"],
            "lists": lists,
            "update_error": kwargs.get("update_error", False),
+            "hyphenated_isbn13": hyphenator.hyphenate(book.isbn_13),
        }

        if request.user.is_authenticated: