viur-core 3.8.0.dev5__tar.gz → 3.8.0.dev7__tar.gz

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viur-core
-Version: 3.8.0.dev5
+Version: 3.8.0.dev7
 Summary: The core component of ViUR, a development framework for Google App Engine
 Author-email: Mausbrand Informationssysteme GmbH <devs@viur.dev>
 Maintainer-email: Jan Max Meyer <jm@mausbrand.de>

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/bones/__init__.py

@@ -19,6 +19,7 @@ from .credential import CredentialBone
 from .date import DateBone
 from .email import EmailBone
 from .file import FileBone
+from .image import ImageBone
 from .json import JsonBone
 from .key import KeyBone
 from .numeric import NumericBone
@@ -60,6 +61,7 @@ __all = [
     "DateBone",
     "EmailBone",
     "FileBone",
+    "ImageBone",
     "JsonBone",
     "KeyBone",
     "MultipleConstraints",

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/bones/base.py

@@ -1070,7 +1070,7 @@ class BaseBone(object):
                         db_obj[name] = value
                         db.put(db_obj)
 
-                    if db.IsInTransaction():
+                    if db.is_in_transaction():
                         transact()
                     else:
                         db.run_in_transaction(transact)

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/bones/file.py

@@ -35,7 +35,8 @@ def ensureDerived(key: db.Key, srcKey, deriveMap: dict[str, t.Any], refreshKey:
     the updated results are written back to the database and the updateRelations function is called
     to ensure proper relations are maintained.
     """
-    from viur.core.skeleton import skeletonByKind, updateRelations
+    from viur.core.skeleton.utils import skeletonByKind
+    from viur.core.skeleton.tasks import updateRelations
     deriveFuncMap = conf.file_derivations
     skel = skeletonByKind("file")()
     if not skel.read(key):
@@ -226,7 +227,10 @@ class FileBone(TreeLeafBone):
         the derived files directly.
         """
         super().postSavedHandler(skel, boneName, key)
-        if current.request.get().is_deferred and current.request_data.get().get("__update_relations_bone") == "derived":
+        if (
+            current.request.get().is_deferred
+            and "derived" in current.request_data.get().get("__update_relations_bones")
+        ):
             return
         from viur.core.skeleton import RelSkel, Skeleton
 

viur_core-3.8.0.dev7/src/viur/core/bones/image.py

@@ -0,0 +1,36 @@
+import typing as t
+from .. import i18n
+from .file import FileBone
+from .string import StringBone
+from ..skeleton.relskel import RelSkel
+from ..config import conf
+
+
+class ImageBoneRelSkel(RelSkel):
+    alt = StringBone(
+        descr=i18n.translate(
+            "viur.core.image.alt",
+            defaultText="Alternative description",
+        ),
+        searchable=True,
+        languages=conf.i18n.available_languages,
+    )
+
+
+class ImageBone(FileBone):
+    type = FileBone.type + ".image"
+
+    def __init__(
+        self,
+        *,
+        public: bool = True,
+        using: t.Optional[RelSkel] = ImageBoneRelSkel,
+        validMimeTypes: None | t.Iterable[str] = ["image/*"],
+        **kwargs,
+    ):
+        super().__init__(
+            public=public,
+            using=using,
+            validMimeTypes=validMimeTypes,
+            **kwargs,
+        )

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/bones/uid.py

@@ -25,7 +25,7 @@ def generate_number(db_key: db.Key) -> int:
             raise ValueError("Can't set the Uid")
         return db_obj["count"]
 
-    if db.IsInTransaction():
+    if db.is_in_transaction():
         return transact(db_key)
     else:
         return db.run_in_transaction(transact, db_key)

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/config.py

@@ -578,13 +578,12 @@ class Email(ConfigType):
 
 
 class History(ConfigType):
-    databases: Multiple[str] = ["viur", "bigquery"]
+    databases: Multiple[str] = ["viur"]
     """All history related settings."""
     excluded_actions: Multiple[str] = []
     """List of all action that are should not be logged."""
     excluded_kinds: Multiple[str] = []
     """List of all kinds that should be logged."""
-    bigquery_table_path: str = f"""{_project_id}.history.default"""
 
 
 class I18N(ConfigType):
@@ -920,6 +919,7 @@ class Conf(ConfigType):
     skeleton_search_path: Multiple[str] = [
         "/skeletons/",  # skeletons of the project
         "/viur/core/",  # system-defined skeletons of viur-core
+        "/viur/src/viur/core/",  # fixme: test suite
         "/viur-core/core/"  # system-defined skeletons of viur-core, only used by editable installation
     ]
     """Priority, in which skeletons are loaded"""

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/db/utils.py

@@ -88,7 +88,6 @@ def key_helper(
             decoded_key = None
 
         # If it did decode, recall keyHelper with Key object
-        print(f"decoded key: {decoded_key!r}")
         if decoded_key:
             return key_helper(
                 decoded_key,

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/i18n.py

@@ -501,7 +501,7 @@ def add_missing_translation(
     key = key.lower()
 
     # Check if key already exists
-    # if db.Get(db.Key(KINDNAME, key)):  # FIXME ViUR4 should only use named keys
+    # if db.get(db.Key(KINDNAME, key)):  # FIXME ViUR4 should only use named keys
     entity = db.Query(KINDNAME).filter("name =", key).getEntry()
     if entity is not None:
         # Ensure it doesn't exist to avoid datastore conflicts

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/modules/file.py

@@ -23,10 +23,9 @@ from google.appengine.api import blobstore, images
 from google.cloud import storage
 from google.oauth2.service_account import Credentials as ServiceAccountCredentials
 
-from viur.core import conf, current, db, errors, utils
+from viur.core import conf, current, db, errors, utils, i18n
 from viur.core.bones import BaseBone, BooleanBone, KeyBone, NumericBone, StringBone
 from viur.core.decorators import *
-from viur.core.i18n import LanguageWrapper
 from viur.core.prototypes.tree import SkelType, Tree, TreeSkel
 from viur.core.skeleton import SkeletonInstance, skeletonByKind
 from viur.core.tasks import CallDeferred, DeleteEntitiesIter, PeriodicTask
@@ -199,7 +198,7 @@ def cloudfunction_thumbnailer(fileSkel, existingFiles, params):
             authRequest = google.auth.transport.requests.Request()
             expiresAt = datetime.datetime.now() + datetime.timedelta(seconds=60)
             signing_credentials = google.auth.compute_engine.IDTokenCredentials(authRequest, "")
-            content_disposition = f"""filename={fileSkel["name"]}"""
+            content_disposition = utils.build_content_disposition_header(fileSkel["name"])
             signedUrl = blob.generate_signed_url(
                 expiresAt,
                 credentials=signing_credentials,
@@ -303,6 +302,22 @@ class FileLeafSkel(TreeSkel):
     """
     kindName = "file"
 
+    name = StringBone(
+        descr="Filename",
+        caseSensitive=False,
+        searchable=True,
+        vfunc=lambda val: None if File.is_valid_filename(val) else "Invalid filename provided",
+    )
+
+    alt = StringBone(
+        descr=i18n.translate(
+            "viur.core.image.alt",
+            defaultText="Alternative description",
+        ),
+        searchable=True,
+        languages=conf.i18n.available_languages,
+    )
+
     size = StringBone(
         descr="Size",
         readOnly=True,
@@ -314,13 +329,6 @@ class FileLeafSkel(TreeSkel):
         readOnly=True,
     )
 
-    name = StringBone(
-        descr="Filename",
-        caseSensitive=False,
-        searchable=True,
-        vfunc=lambda val: None if conf.main_app.file.is_valid_filename(val) else "Invalid filename provided",
-    )
-
     mimetype = StringBone(
         descr="MIME-Type",
         readOnly=True,
@@ -713,7 +721,7 @@ class File(Tree):
         if not file:
             return ""
 
-        if isinstance(file, LanguageWrapper):
+        if isinstance(file, i18n.LanguageWrapper):
             language = language or current.language.get()
             if not language or not (file := cls.get(language)):
                 return ""
@@ -1021,12 +1029,7 @@ class File(Tree):
         if not filename:
             filename = download_filename or urlquote(blob.name.rsplit("/", 1)[-1])
 
-        content_disposition = "; ".join(
-            item for item in (
-                "attachment" if download else None,
-                f"filename={filename}" if filename else None,
-            ) if item
-        )
+        content_disposition = utils.build_content_disposition_header(filename, attachment=download)
 
         if isinstance(_CREDENTIALS, ServiceAccountCredentials):
             expiresAt = datetime.datetime.now() + datetime.timedelta(seconds=60)
@@ -1144,10 +1147,7 @@ class File(Tree):
         response = current.request.get().response
         response.headers["Content-Type"] = f"image/{file_fmt}"
         response.headers["Cache-Control"] = "public, max-age=604800"  # 7 Days
-        if download:
-            response.headers["Content-Disposition"] = f"attachment; filename={filename}"
-        else:
-            response.headers["Content-Disposition"] = f"filename={filename}"
+        response.headers["Content-Disposition"] = utils.build_content_disposition_header(filename, attachment=download)
 
         answ = requests.get(url, timeout=20)
         if not answ.ok:

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/modules/history.py

@@ -1,14 +1,13 @@
 import difflib
 import enum
-import json
 import logging
 import typing as t
+from google.cloud import exceptions, bigquery
 from viur.core import db, conf, utils, current, tasks
+from viur.core.bones import *
+from viur.core.prototypes.list import List
 from viur.core.render.json.default import CustomJsonEncoder
 from viur.core.skeleton import SkeletonInstance, Skeleton, DatabaseAdapter
-from viur.core.prototypes.list import List
-from viur.core.bones import *
-from google.cloud import exceptions, bigquery
 
 
 class HistorySkel(Skeleton):
@@ -72,15 +71,21 @@ class HistorySkel(Skeleton):
     )
 
     diff = RawBone(
-        descr="Diff",
+        descr="Human-readable diff",
         indexed=False,
     )
 
 
 class BigQueryHistory:
     """
-    Schema and connector for BigQuery history entries.
+    Connector for BigQuery history entries.
     """
+
+    PATH = f"""{conf.instance.project_id}.history.default"""
+    """
+    Path to the big query table for history entries.
+    """
+
     SCHEMA = (
         {
             "type": "STRING",
@@ -191,25 +196,27 @@ class BigQueryHistory:
             "description": "diff data",
         },
     )
+    """
+    Schema used for the BigQuery table for its initial construction.
+    Keep to the provided format!
+    """
 
-    def __init__(self, table_path: str = conf.history.bigquery_table_path):
+    def __init__(self):
         super().__init__()
 
-        self.table_path = str(table_path)
         # checks for the table_path
-        if self.table_path.count(".") != 2:
-            raise ValueError(f"The table_path {self.table_path} must have exactly 3 parts "
-                             f"that are must be separated by a dot.")
+        if self.PATH.count(".") != 2:
+            raise ValueError("{self.PATH!r} must have exactly 3 parts that separated by a dot.")
 
         self.client = bigquery.Client()
         self.table = self.select_or_create_table()
 
     def select_or_create_table(self):
         try:
-            return self.client.get_table(self.table_path)
+            return self.client.get_table(self.PATH)
 
         except exceptions.NotFound:
-            app, dataset, table = self.table_path.split(".")
+            app, dataset, table = self.PATH.split(".")
             logging.error(f"{app}:{dataset}:{table}")
             # create dataset if needed
             try:
@@ -220,16 +227,16 @@ class BigQueryHistory:
 
             # create table if needed
             try:
-                return self.client.get_table(self.table_path)
+                return self.client.get_table(self.PATH)
             except exceptions.NotFound:
-                logging.info(f"Table {self.table_path!r} does not exist, creating")
+                logging.info(f"Table {self.PATH!r} does not exist, creating")
                 self.client.create_table(
                     bigquery.Table(
-                        self.table_path,
+                        self.PATH,
                         schema=self.SCHEMA
                     )
                 )
-                return self.client.get_table(self.table_path)
+                return self.client.get_table(self.PATH)
 
     def write_row(self, data):
         if res := self.client.insert_rows(self.table, [data]):
@@ -272,11 +279,11 @@ class HistoryAdapter(DatabaseAdapter):
         self.trigger("delete", skel, None)
 
     def trigger(
-        self,
-        action: str,
-        old_skel: SkeletonInstance,
-        new_skel: SkeletonInstance,
-        change_list: t.Iterable[str] = (),
+            self,
+            action: str,
+            old_skel: SkeletonInstance,
+            new_skel: SkeletonInstance,
+            change_list: t.Iterable[str] = (),
     ) -> str | None:
 
         # skip excluded actions like login or logout
@@ -320,7 +327,7 @@ class History(List):
         "icon": "clock-history",
         "filter": {
             "orderby": "timestamp",
-            "orderdir": "1",
+            "orderdir": "desc",
         },
         "disabledActions": ["add", "clone", "delete"],
     }
@@ -334,19 +341,28 @@ class History(List):
     History format version.
     """
 
-    def __init__(self, *args, bigquery_history_cls=BigQueryHistory, **kwargs):
+    BigQueryHistoryCls = BigQueryHistory
+    """
+    The connector class used to store entries to BigQuery.
+    """
+
+    def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.bigquery_history_cls = bigquery_history_cls
-        self.bigquery = self.bigquery_history_cls and self.bigquery_history_cls()
 
-    def baseSkel(self, *args, **kwargs):
+        if self.BigQueryHistoryCls and "bigquery" in conf.history.databases:
+            assert issubclass(self.BigQueryHistoryCls, BigQueryHistory)
+            self.bigquery = self.BigQueryHistoryCls()
+        else:
+            self.bigquery = None
+
+    def skel(self, **kwargs):
         # Make all bones readonly!
-        skel = super().baseSkel(*args, **kwargs).clone()
+        skel = super().skel(**kwargs).clone()
         skel.readonly()
         return skel
 
     def canEdit(self, skel):
-        return self.canView(skel)
+        return self.canView(skel)  # this is needed to open an entry in admin (all bones are readonly!)
 
     def canDelete(self, _skel):
         return False
@@ -430,7 +446,6 @@ class History(List):
         user: t.Optional[SkeletonInstance] = None,
         tags: t.Iterable[str] = (),
         diff_excludes: t.Set[str] = set(),
-
     ):
         skel = new_skel or old_skel
         new_data = self._skel_to_dict(skel)
@@ -519,7 +534,6 @@ class History(List):
         user: t.Optional[SkeletonInstance] = None,
         tags: t.Iterable[str] = (),
         diff_excludes: t.Set[str] = set(),
-
     ) -> str | None:
 
         # create entry
@@ -547,8 +561,7 @@ class History(List):
 
         # write into BigQuery
         if self.bigquery and "bigquery" in conf.history.databases:
-            # need to do this as biquery functions modifies
-            # entry and seems to be called first
+            # need to do this as biquery functions modifies entry and seems to be called first
             if conf.instance.is_dev_server:
                 entry = entry.copy()  # need to do this as biquery functions modifiy entry
 

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/modules/translation.py

@@ -255,14 +255,17 @@ class Translation(List):
     def dump(
         self,
         *,
-        pattern: list[str] = [],
-        language: list[str] = [],
-    ) -> dict[str, str] | dict[str, dict[str, str]]:
+        pattern: list[str] | None = None,
+        language: list[str] | None = None,
+    ) -> dict[str, dict[str, str]]:
         """
         Dumps translations as JSON.
 
-        :param pattern: Required, provide fnmatch-style tramslaton key filter patterns of the translations wanted.
+        :param pattern: Optional, provide fnmatch-style translation key filter patterns of the translations wanted.
         :param language: Allows to request a specific language.
+            By default, the language of the current request is used.
+
+        :return: A dictionary with translations as JSON. Structure: ``{language: {key: value, ...}, ...}``
 
         Example calls:
 
@@ -276,11 +279,6 @@ class Translation(List):
 
         current.request.get().response.headers["Content-Type"] = "application/json"
 
-        # The pattern may not be a matcher for all!
-        for pat in pattern:
-            if not pat.strip("*?."):
-                raise errors.BadRequest("Pattern is too generic.")
-
         if (
             not (conf.debug.disable_cache and current.request.get().disableCache)
             and any(os.getenv("HTTP_HOST", "") in dlm for dlm in conf.i18n.domain_language_mapping)
@@ -294,12 +292,12 @@ class Translation(List):
         else:
             language = [current.language.get()]
 
-        return json.dumps({
+        return json.dumps({  # type: ignore
             lang: {
                 name: str(translate(name, force_lang=lang))
                 for name, values in systemTranslations.items()
                 if (conf.i18n.dump_can_view(name) or values.get("_public_"))
-                and any(fnmatch.fnmatch(name, pat) for pat in pattern)
+                and (not pattern or any(fnmatch.fnmatch(name, pat) for pat in pattern))
             }
             for lang in language
         })

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/prototypes/singleton.py

@@ -170,16 +170,22 @@ class Singleton(SkelModule):
         self.onEdited(skel)
         return self.render.editSuccess(skel)
 
-    def getContents(self) -> SkeletonInstance | None:
+    def getContents(
+        self,
+        create: bool | dict | t.Callable[[SkeletonInstance], None] = False,
+    ) -> SkeletonInstance | None:
         """
-        Returns the entity of this singleton application as :class:`viur.core.skeleton.Skeleton` object.
+        Return the entity of this singleton application as :class:`SkeletonInstance` object.
 
-        :returns: The content as Skeleton provided by :func:`viewSkel`.
+        :param create: Whether the entity should be created if it does not exist.
+            See :meth:`Skeleton.read` for more details.
+
+        :returns: The read skeleton or `None`.
         """
         skel = self.viewSkel()
         key = db.Key(self.viewSkel().kindName, self.getKey())
 
-        if not skel.read(key):
+        if not skel.read(key, create=create):
             return None
 
         return skel

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/prototypes/tree.py

@@ -3,7 +3,7 @@ import typing as t
 from deprecated.sphinx import deprecated
 from viur.core import utils, errors, db, current
 from viur.core.decorators import *
-from viur.core.bones import KeyBone, SortIndexBone
+from viur.core.bones import KeyBone, SortIndexBone, BooleanBone
 from viur.core.cache import flushCache
 from viur.core.skeleton import Skeleton, SkeletonInstance
 from viur.core.tasks import CallDeferred
@@ -31,6 +31,12 @@ class TreeSkel(Skeleton):
         readOnly=True,
     )
 
+    is_root_node = BooleanBone(
+        defaultValue=False,
+        readOnly=True,
+        visible=False,
+    )
+
     @classmethod
     def refresh(cls, skelValues):  # ViUR2 Compatibility
         super().refresh(skelValues)
@@ -160,7 +166,7 @@ class Tree(SkelModule):
         skel = self.baseSkel("node")
 
         skel["key"] = db.Key(skel.kindName, identifier)
-        skel["rootNode"] = True
+        skel["is_root_node"] = True
 
         if ensure not in (False, None):
             return skel.read(create=ensure)

{viur_core-3.8.0.dev5 → viur_core-3.8.0.dev7}/src/viur/core/request.py

@@ -14,11 +14,11 @@ import re
 import time
 import traceback
 import typing as t
+import unicodedata
 from abc import ABC, abstractmethod
 from urllib import parse
-from urllib.parse import unquote, urljoin, urlparse
+from urllib.parse import quote, unquote, urljoin, urlparse
 
-import unicodedata
 import webob
 
 from viur.core import current, db, errors, session, utils
@@ -367,6 +367,9 @@ class Router:
                 raise
             self.response.status = f"{e.status} {e.name}"
             url = e.url
+            url = unquote(url)  # decode first
+            # safe = https://url.spec.whatwg.org/#url-path-segment-string
+            url = quote(url, encoding="utf-8", safe="!$&'()*+,-./:;=?@_~")  # re-encode all in utf-8
             if url.startswith(('.', '/')):
                 url = str(urljoin(self.request.url, url))
             self.response.headers['Location'] = url

viur_core-3.8.0.dev7/src/viur/core/skeleton/__init__.py

@@ -0,0 +1,53 @@
+import logging
+import warnings
+
+from ..bones.base import getSystemInitialized
+
+from .adapter import DatabaseAdapter, ViurTagsSearchAdapter
+from .instance import SkeletonInstance
+from .meta import MetaSkel, MetaBaseSkel, BaseSkeleton
+
+from .relskel import RelSkel, RefSkel
+from .skeleton import Skeleton, SeoKeyBone, _UNDEFINED_KINDNAME
+from .utils import SkelList, skeletonByKind, listKnownSkeletons, iterAllSkelClasses
+
+
+# Forward our references to SkelInstance to the database (needed for queries)
+
+# DEPRECATED ATTRIBUTES HANDLING
+
+__DEPRECATED_NAMES = {
+    # stuff prior viur-core < 3.6
+    "seoKeyBone": ("SeoKeyBone", SeoKeyBone),
+}
+
+
+def __getattr__(attr: str) -> object:
+    if entry := __DEPRECATED_NAMES.get(attr):
+        func = entry[1]
+        msg = f"{attr} was replaced by {entry[0]}"
+        warnings.warn(msg, DeprecationWarning, stacklevel=2)
+        logging.warning(msg, stacklevel=2)
+        return func
+
+    return super(__import__(__name__).__class__).__getattribute__(attr)
+
+
+__all__ = [
+    BaseSkeleton,
+    DatabaseAdapter,
+    iterAllSkelClasses,
+    listKnownSkeletons,
+    MetaBaseSkel,
+    MetaSkel,
+    RefSkel,
+    RelSkel,
+    SeoKeyBone,
+    Skeleton,
+    skeletonByKind,
+    SkeletonInstance,
+    SkelList,
+    ViurTagsSearchAdapter,
+    getSystemInitialized,  # FIXME: This is an import from BaseBone
+    _UNDEFINED_KINDNAME
+]