papyru 2.10.4.dev77__tar.gz → 2.11.0__tar.gz

{papyru-2.10.4.dev77/papyru.egg-info → papyru-2.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: papyru
-Version: 2.10.4.dev77
+Version: 2.11.0
 Summary: minimal REST library with OpenAPI-based validation for django
 Home-page: http://www.puzzleyou.net/
 Author: puzzleYOU GmbH

papyru-2.11.0/papyru/create_variant/component.py

@@ -0,0 +1,35 @@
+from papyru import XMLHelper
+
+from .edit_template.ean import insert_ean
+from .edit_template.manufacturer_address import insert_manufacturer_address
+from .edit_template.motive import insert_motive
+from .edit_template.title import insert_title
+from .edit_template.xml import ImageInfo
+from .resi import import_into_resi
+
+
+def create_component(template: str,
+                     motive_image_info: ImageInfo,
+                     resi_instance: object,
+                     resi_url: str,
+                     disposition_component: str,
+                     disposition_manufacturer_address: str,
+                     disposition_title=None,
+                     motive_title=None,
+                     disposition_ean=None,
+                     ean=None,
+                     properties=None,
+                     ) -> str:
+
+    doc = XMLHelper(template)
+    insert_motive(doc, motive_image_info)
+    insert_title(doc, motive_title, disposition_title, resi_instance, resi_url)
+    insert_ean(doc, ean, disposition_ean, resi_instance, resi_url)
+    insert_manufacturer_address(doc, disposition_manufacturer_address,
+                                resi_instance, resi_url)
+
+    return import_into_resi(doc.serialize(doc.root),
+                            resi_instance,
+                            resi_url,
+                            properties,
+                            disposition_component)

papyru-2.11.0/papyru/create_variant/constants.py

@@ -0,0 +1,42 @@
+"""
+Constants for specific templates
+
+These constants are used in specific templates to ensure that SVG
+components are generated correctly, e.g.:
+
+- https://masa.productdesignerd.puzzleandplay.de/
+  templates/single-image-4-3-landscape/structure/original
+- https://masa.productdesignerd.puzzleandplay.de/
+  templates/box_small_500_landscape_grey/structure/original
+"""
+
+from .edit_template.render_text import (Alignment, HorizontalAlignment,
+                                        RGBAColor, VerticalAlignment)
+
+# Preview types can be overwritten by ShopAttributes in Masa.
+PREVIEW_TYPE_BOX = 'box'
+PREVIEW_TYPE_PARTS = 'pieces'
+
+PREVIEW_IMAGE_FORMAT = 'jpeg'
+PREVIEW_MIME_TYPE = 'image/%s' % PREVIEW_IMAGE_FORMAT
+PREVIEW_QUALITY_LEVEL = 90
+DEFAULT_PREVIEW_SIZE = 1500
+
+MOTIVE_PLACEHOLDER_ID = 'img-main'
+MOTIVE_USE_ID = 'img-main-use'
+
+TITLE_PLACEHOLDER_ID = 'txt-main'
+TITLE_ALIGNMENT = Alignment(
+    vertical=VerticalAlignment.Top, horizontal=HorizontalAlignment.Center)
+TITLE_FONT = 'FreeSerif'
+TITLE_COLOR_FOREGROUND = RGBAColor(255, 255, 255, 1.0)
+TITLE_COLOR_BACKGROUND = RGBAColor(0, 0, 0, 0.0)
+
+EAN_PLACEHOLDER_ID = 'img-ean'
+
+MANUFACTURER_ADDRESS_PLACEHOLDER_ID = 'manufacturer-address'
+MANUFACTURER_ADDRESS_ALIGNMENT = Alignment(
+    vertical=VerticalAlignment.Center, horizontal=HorizontalAlignment.Center)
+MANUFACTURER_ADDRESS_FONT = 'Open Sans'
+MANUFACTURER_ADDRESS_COLOR_FOREGROUND = RGBAColor(0, 0, 0, 1.0)
+MANUFACTURER_ADDRESS_COLOR_BACKGROUND = RGBAColor(0, 0, 0, 0.0)

papyru-2.11.0/papyru/create_variant/edit_template/ean.py

@@ -0,0 +1,64 @@
+from os import getpid
+from subprocess import PIPE, Popen
+
+from papyru import XMLHelper
+from papyru.create_variant.constants import EAN_PLACEHOLDER_ID
+from papyru.create_variant.resi import import_into_resi
+
+from .xml import ImageInfo, find_placeholder, fit_image
+
+
+def insert_ean(doc: XMLHelper,
+               ean: str,
+               disposition: str,
+               resi_instance: object,
+               resi_url: str,
+               ) -> XMLHelper:
+    ph = find_placeholder(doc, 'image', EAN_PLACEHOLDER_ID)
+
+    if ph is None:
+        return doc
+
+    width = float(doc.get_attribute(ph.wrapper, 'width'))
+    height = float(doc.get_attribute(ph.wrapper, 'height'))
+
+    ean_location = _create_ean(ean, width, height, disposition,
+                               resi_instance, resi_url)
+
+    return fit_image(doc,
+                     EAN_PLACEHOLDER_ID,
+                     ImageInfo(location=ean_location,
+                               width=width,
+                               height=height))
+
+
+def _create_ean(ean: str,
+                width: int,
+                height: int,
+                disposition: str,
+                resi_instance: any,
+                resi_url: str) -> str:
+    _, ean_bytes = resi_instance.provide_version_bytes(
+        generate_barcode_svg(ean).encode(),
+        {
+            "convert": "image/png",
+            "stretch": {
+                "width": int(width),
+                "height": int(height),
+            }
+        },
+        track=str(getpid()))
+
+    return import_into_resi(
+        ean_bytes, resi_instance, resi_url, None, disposition)
+
+
+def generate_barcode_svg(text: str) -> str:
+    call = ['barcode', '-e', 'EAN', '-S']
+
+    with Popen(call, stdin=PIPE, stdout=PIPE, stderr=PIPE, text=True) as proc:
+        out, err = proc.communicate(input=text)
+        if err != '':
+            raise Exception("call barcode failed: %s" % err)
+
+        return out.replace('Helvetica', 'Open Sans')

papyru-2.11.0/papyru/create_variant/edit_template/manufacturer_address.py

@@ -0,0 +1,67 @@
+from logging import getLogger
+
+from papyru import XMLHelper
+from papyru.create_variant.constants import (
+    MANUFACTURER_ADDRESS_ALIGNMENT, MANUFACTURER_ADDRESS_COLOR_BACKGROUND,
+    MANUFACTURER_ADDRESS_COLOR_FOREGROUND, MANUFACTURER_ADDRESS_FONT,
+    MANUFACTURER_ADDRESS_PLACEHOLDER_ID)
+from papyru.create_variant.resi import import_into_resi
+
+from .render_text import TextConfig, render_text
+from .xml import (ImageInfo, find_placeholder, fit_image,
+                  replace_text_with_image)
+
+log = getLogger(__name__)
+
+
+def insert_manufacturer_address(doc: XMLHelper,
+                                disposition: str,
+                                resi_instance: object,
+                                resi_url: str,
+                                ) -> XMLHelper:
+    ph = find_placeholder(doc, 'text', MANUFACTURER_ADDRESS_PLACEHOLDER_ID)
+    if ph is None:
+        log.warning('no manufacturer address found')
+        return doc
+
+    width = float(doc.get_attribute(ph.wrapper, 'width'))
+    height = float(doc.get_attribute(ph.wrapper, 'height'))
+
+    address = '\n'.join(map(
+        lambda tspan: tspan.text,
+        ph.placeholder.findall(
+            './/{%s}tspan' % doc.default_namespace)))
+    location = _create_text_manufacturer_address(
+                  address, width, height, disposition, resi_instance, resi_url)
+
+    return fit_image(
+        replace_text_with_image(doc, MANUFACTURER_ADDRESS_PLACEHOLDER_ID),
+        MANUFACTURER_ADDRESS_PLACEHOLDER_ID,
+        ImageInfo(location=location,
+                  width=width,
+                  height=height))
+
+
+def _create_text_manufacturer_address(address: str,
+                                      width: int,
+                                      height: int,
+                                      disposition: str,
+                                      resi_instance: any,
+                                      resi_url: str) -> str:
+    text_bytes = render_text(
+        TextConfig(
+            text=address,
+            width=int(width),
+            height=int(height),
+            alignment=MANUFACTURER_ADDRESS_ALIGNMENT,
+            font_name=MANUFACTURER_ADDRESS_FONT,
+            fg_color=MANUFACTURER_ADDRESS_COLOR_FOREGROUND,
+            bg_color=MANUFACTURER_ADDRESS_COLOR_BACKGROUND),
+        resi_instance)
+
+    return import_into_resi(
+        text_bytes,
+        resi_instance,
+        resi_url,
+        None,
+        disposition)

papyru-2.11.0/papyru/create_variant/edit_template/motive.py

@@ -0,0 +1,14 @@
+from functools import reduce
+
+from papyru import XMLHelper
+from papyru.create_variant.constants import (MOTIVE_PLACEHOLDER_ID,
+                                             MOTIVE_USE_ID)
+
+from .xml import ImageInfo, fit_image
+
+
+def insert_motive(doc: XMLHelper, motive_info: ImageInfo) -> XMLHelper:
+    return reduce(lambda acc, el: fit_image(acc, el, motive_info),
+                  [MOTIVE_PLACEHOLDER_ID,
+                   MOTIVE_USE_ID],
+                  doc)

papyru-2.11.0/papyru/create_variant/edit_template/render_text.py

@@ -0,0 +1,107 @@
+from dataclasses import dataclass
+from enum import Enum
+from os import path
+from subprocess import run
+from tempfile import TemporaryDirectory
+from uuid import uuid4
+
+
+@dataclass(frozen=True)
+class RGBAColor:
+    red: int
+    green: int
+    blue: int
+    alpha: float
+
+
+class VerticalAlignment(Enum):
+    Center = 0x01
+    Top = 0x02
+    Bottom = 0x03
+
+
+class HorizontalAlignment(Enum):
+    Center = 0x01
+    Left = 0x02
+    Right = 0x03
+
+
+@dataclass(frozen=True)
+class Alignment:
+    vertical: VerticalAlignment
+    horizontal: HorizontalAlignment
+
+
+@dataclass(frozen=True)
+class TextConfig:
+    text: str
+    fg_color: RGBAColor
+    bg_color: RGBAColor
+    font_name: str
+    alignment: Alignment
+    width: int
+    height: int
+
+
+def render_text(config: TextConfig, resi_instance: object) -> bytes:
+    # see `convert -list gravity`
+    def _get_gravity(alignment: Alignment) -> str:
+        h = ''
+        v = ''
+
+        if alignment.horizontal == HorizontalAlignment.Left:
+            h = 'West'
+        elif alignment.horizontal == HorizontalAlignment.Right:
+            h = 'East'
+
+        if alignment.vertical == VerticalAlignment.Top:
+            v = 'North'
+        elif alignment.vertical == VerticalAlignment.Bottom:
+            v = 'South'
+
+        if h == '' and v == '':
+            return 'Center'
+
+        return '%s%s' % (v, h)
+
+    def _get_font(font_name, resi_instance):
+        fonts_dir = resi_instance.fonts_directory()
+
+        if fonts_dir is None or not path.exists(fonts_dir):
+            raise Exception('missing fonts directory')
+
+        return path.join(fonts_dir, font_name)
+
+    with TemporaryDirectory() as temp_dir:
+        out_filename = path.join(temp_dir, '%s.png' % uuid4())
+
+        text = config.text
+        draw_operators = (
+            ('-fill', _imagemagick_color_string(config.fg_color),
+             '-font', '%s' % _get_font(config.font_name, resi_instance),
+             '-gravity', _get_gravity(config.alignment),
+             'label:%s' % text)
+            if text != ''
+            else ('xc:none',))
+
+        resp = run([
+            'magick',
+            '-colorspace', 'RGB',
+            '-size', '%sx%s' % (config.width, config.height),
+            '-background', _imagemagick_color_string(config.bg_color),
+            *draw_operators,
+            'PNG32:%s' % out_filename
+        ])
+
+        if resp.returncode != 0:
+            raise Exception('could not render text "%s"' % config.text)
+
+        with open(out_filename, 'rb') as f:
+            return f.read()
+
+
+def _imagemagick_color_string(color: RGBAColor) -> str:
+    return 'rgba(%d, %d, %d, %0.2f)' % (color.red,
+                                        color.green,
+                                        color.blue,
+                                        color.alpha)

papyru-2.11.0/papyru/create_variant/edit_template/title.py

@@ -0,0 +1,59 @@
+from papyru import XMLHelper
+from papyru.create_variant.constants import (TITLE_ALIGNMENT,
+                                             TITLE_COLOR_BACKGROUND,
+                                             TITLE_COLOR_FOREGROUND,
+                                             TITLE_FONT, TITLE_PLACEHOLDER_ID)
+from papyru.create_variant.resi import import_into_resi
+
+from .render_text import TextConfig, render_text
+from .xml import (ImageInfo, find_placeholder, fit_image,
+                  replace_text_with_image)
+
+
+def insert_title(doc: XMLHelper,
+                 title: str,
+                 disposition: str,
+                 resi_instance: object,
+                 resi_url: any
+                 ) -> XMLHelper:
+    if title is None:
+        return doc
+
+    ph = find_placeholder(doc, 'text', TITLE_PLACEHOLDER_ID)
+
+    if ph is None:
+        return doc
+
+    width = float(doc.get_attribute(ph.wrapper, 'width'))
+    height = float(doc.get_attribute(ph.wrapper, 'height'))
+
+    title_location = _create_title_image(title, width, height, disposition,
+                                         resi_instance, resi_url)
+
+    return fit_image(
+        replace_text_with_image(doc, TITLE_PLACEHOLDER_ID),
+        TITLE_PLACEHOLDER_ID,
+        ImageInfo(location=title_location,
+                  width=width,
+                  height=height))
+
+
+def _create_title_image(title: str,
+                        width: int,
+                        height: int,
+                        disposition: str,
+                        resi_instance: any,
+                        resi_url: str
+                        ) -> str:
+    text_bytes = render_text(
+        TextConfig(text=title,
+                   width=int(width),
+                   height=int(height),
+                   alignment=TITLE_ALIGNMENT,
+                   font_name=TITLE_FONT,
+                   fg_color=TITLE_COLOR_FOREGROUND,
+                   bg_color=TITLE_COLOR_BACKGROUND),
+        resi_instance)
+
+    return import_into_resi(
+        text_bytes, resi_instance, resi_url, None, disposition)

papyru-2.11.0/papyru/create_variant/edit_template/xml.py

@@ -0,0 +1,126 @@
+from dataclasses import dataclass
+from xml.etree.ElementTree import Element, SubElement
+
+from papyru import XMLHelper
+
+
+@dataclass(frozen=True)
+class PlaceholderInfo:
+    wrapper: Element
+    placeholder: Element
+
+
+@dataclass(frozen=True)
+class ImageInfo:
+    location: str
+    width: int
+    height: int
+
+
+def find_placeholder(doc: XMLHelper,
+                     placeholder_tag: str,
+                     placeholder_id: str) -> PlaceholderInfo:
+
+    wrapper = doc.root.find('.//{%s}svg/{%s}%s[@id="%s"]/..'
+                            % (doc.default_namespace,
+                               doc.default_namespace,
+                               placeholder_tag,
+                               placeholder_id))
+
+    if wrapper is None:
+        return None
+
+    placeholder = wrapper.find('./{%s}%s[@id="%s"]'
+                               % (doc.default_namespace,
+                                  placeholder_tag,
+                                  placeholder_id))
+
+    if placeholder is None:
+        return None
+
+    return PlaceholderInfo(wrapper=wrapper,
+                           placeholder=placeholder)
+
+
+def replace_text_with_image(doc: XMLHelper,
+                            placeholder_id: str) -> XMLHelper:
+    ph = find_placeholder(doc, 'text', placeholder_id)
+
+    if ph is None:
+        return doc
+
+    ph.wrapper.remove(ph.placeholder)
+
+    replacement = SubElement(ph.wrapper,
+                             '{%s}image' % doc.default_namespace)
+
+    doc.set_attribute(
+        replacement, 'id', doc.get_attribute(ph.placeholder, 'id'))
+
+    doc.set_attribute(replacement, 'x', '0')
+    doc.set_attribute(replacement, 'y', '0')
+
+    doc.set_attribute(
+        replacement, 'width', doc.get_attribute(ph.wrapper, 'width'))
+
+    doc.set_attribute(
+        replacement, 'height', doc.get_attribute(ph.wrapper, 'height'))
+
+    return doc
+
+
+def fit_image(doc: XMLHelper,
+              placeholder_id: str,
+              image_info: ImageInfo) -> XMLHelper:
+    ph = find_placeholder(doc, 'image', placeholder_id)
+
+    if ph is None:
+        return doc
+
+    wrapper_dims = (float(doc.get_attribute(ph.wrapper, 'width')),
+                    float(doc.get_attribute(ph.wrapper, 'height')))
+
+    image_dims = (float(image_info.width),
+                  float(image_info.height))
+
+    viewbox = _fit_dimensions(wrapper_dims, image_dims)
+
+    doc.set_attribute(ph.wrapper,
+                      'viewBox',
+                      '%s %s %s %s' % viewbox)
+
+    has_xlink = doc.namespace('xlink') is not None
+    doc.set_attribute(ph.placeholder,
+                      'href', image_info.location,
+                      'xlink' if has_xlink else None)
+
+    doc.set_attribute(ph.placeholder, 'x', '0.0')
+    doc.set_attribute(ph.placeholder, 'y', '0.0')
+    doc.set_attribute(ph.placeholder, 'width', '%s' % image_dims[0])
+    doc.set_attribute(ph.placeholder, 'height', '%s' % image_dims[1])
+
+    _set_changed(doc, ph.placeholder)
+
+    return doc
+
+
+def _set_changed(document: XMLHelper, element: Element):
+    if document.has_attribute(element, 'is-unchanged', 'pap'):
+        document.set_attribute(element, 'is-unchanged', 'false', 'pap')
+
+
+def _fit_dimensions(container_dims: (float, float),
+                    element_dims: (float, float)
+                    ) -> (float, float, float, float):
+    aspect_container = container_dims[0] / container_dims[1]
+    aspect_element = element_dims[0] / element_dims[1]
+
+    e_w = element_dims[0]
+    e_h = element_dims[1]
+
+    if aspect_container > aspect_element:
+        h = element_dims[0] / aspect_container
+        return (0.0, (e_h - h) / 2, e_w, h)
+    else:
+        w = element_dims[1] * aspect_container
+        return ((e_w - w) / 2, 0.0, w, e_h)

papyru-2.11.0/papyru/create_variant/resi.py

@@ -0,0 +1,25 @@
+from os import getpid
+from typing import Optional
+
+import resi
+
+
+def import_into_resi(data: bytes,
+                     resi_instance: resi.Instance,
+                     resi_url: str,
+                     properties: Optional[resi.VersionProperties] = None,
+                     disposition: Optional[str] = None
+                     ) -> str:
+
+    if properties is not None:
+        properties.is_derived = False
+
+    with resi_instance.import_image_binary(data,
+                                           properties=properties,
+                                           track=str(getpid())) as img:
+        if disposition is not None:
+            img.set_properties(disposition=disposition)
+
+        location = '%s/images/%s' % (resi_url, img.ref_number)
+
+    return location

{papyru-2.10.4.dev77 → papyru-2.11.0/papyru.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: papyru
-Version: 2.10.4.dev77
+Version: 2.11.0
 Summary: minimal REST library with OpenAPI-based validation for django
 Home-page: http://www.puzzleyou.net/
 Author: puzzleYOU GmbH

{papyru-2.10.4.dev77 → papyru-2.11.0}/papyru.egg-info/SOURCES.txt

@@ -22,6 +22,17 @@ papyru.egg-info/SOURCES.txt
 papyru.egg-info/dependency_links.txt
 papyru.egg-info/requires.txt
 papyru.egg-info/top_level.txt
+papyru/create_variant/__init__.py
+papyru/create_variant/component.py
+papyru/create_variant/constants.py
+papyru/create_variant/resi.py
+papyru/create_variant/edit_template/__init__.py
+papyru/create_variant/edit_template/ean.py
+papyru/create_variant/edit_template/manufacturer_address.py
+papyru/create_variant/edit_template/motive.py
+papyru/create_variant/edit_template/render_text.py
+papyru/create_variant/edit_template/title.py
+papyru/create_variant/edit_template/xml.py
 papyru/static/__init__.py
 papyru/static/apps.py
 papyru/static/urls.py

{papyru-2.10.4.dev77 → papyru-2.11.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='papyru',
-    version='2.10.4.dev77',
+    version='2.11.0',
     description=(
         'minimal REST library with OpenAPI-based validation for django'),
     author='puzzleYOU GmbH',
@@ -12,6 +12,8 @@ setup(
     platforms=['any'],
     packages=[
         'papyru',
+        'papyru.create_variant',
+        'papyru.create_variant.edit_template',
         'papyru.static',
         'papyru.varspool',
         'papyru.varspool.command'