c2cgeoportal-commons 2.7.1.156__py3-none-any.whl → 2.8.1.180__py3-none-any.whl

c2cgeoportal_commons/alembic/static/44c91d82d419_add_table_log.py

@@ -0,0 +1,70 @@
+# Copyright (c) 2023-2023, Camptocamp SA
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies,
+# either expressed or implied, of the FreeBSD Project.
+
+"""
+Add table log.
+
+Revision ID: 44c91d82d419
+Revises: 7ef947f30f20
+Create Date: 2023-01-14 10:58:44.404643
+"""
+
+import sqlalchemy as sa
+from alembic import op
+from c2c.template.config import config
+
+# revision identifiers, used by Alembic.
+revision = "44c91d82d419"
+down_revision = "7ef947f30f20"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade."""
+    staticschema = config["schema_static"]
+
+    op.create_table(
+        "log",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("date", sa.DateTime(timezone=True), nullable=False),
+        sa.Column("action", sa.Unicode, nullable=False),
+        sa.Column("element_type", sa.String(length=50), nullable=False),
+        sa.Column("element_id", sa.Integer(), nullable=False),
+        sa.Column("element_name", sa.Unicode(), nullable=False),
+        sa.Column("element_url_table", sa.Unicode(), nullable=False),
+        sa.Column("username", sa.Unicode(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+        schema=staticschema,
+    )
+
+
+def downgrade() -> None:
+    """Downgrade."""
+    staticschema = config["schema_static"]
+
+    op.drop_table("log", schema=staticschema)

c2cgeoportal_commons/alembic/static/53d671b17b20_add_timezone_on_datetime_fields.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2019, Camptocamp SA
+# Copyright (c) 2018-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_commons/alembic/static/5472fbc19f39_add_temp_password_column.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2015-2019, Camptocamp SA
+# Copyright (c) 2015-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_commons/alembic/static/76d72fb3fcb9_add_oauth2_pkce.py

@@ -0,0 +1,68 @@
+# Copyright (c) 2023, Camptocamp SA
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies,
+# either expressed or implied, of the FreeBSD Project.
+
+"""
+Add Oauth2 - PKCE.
+
+Revision ID: 76d72fb3fcb9
+Revises: 44c91d82d419
+Create Date: 2023-02-07 17:32:22.835450
+"""
+
+from alembic import op
+from c2c.template.config import config
+from sqlalchemy import Boolean, Column, String
+
+# revision identifiers, used by Alembic.
+revision = "76d72fb3fcb9"
+down_revision = "44c91d82d419"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade."""
+    staticschema = config["schema_static"]
+
+    op.add_column("oauth2_client", Column("state_required", Boolean), schema=staticschema)
+    op.add_column("oauth2_client", Column("pkce_required", Boolean), schema=staticschema)
+    op.add_column("oauth2_bearertoken", Column("state", String), schema=staticschema)
+    op.add_column("oauth2_authorizationcode", Column("state", String), schema=staticschema)
+    op.add_column("oauth2_authorizationcode", Column("challenge", String(128)), schema=staticschema)
+    op.add_column("oauth2_authorizationcode", Column("challenge_method", String(6)), schema=staticschema)
+
+
+def downgrade() -> None:
+    """Downgrade."""
+    staticschema = config["schema_static"]
+
+    op.drop_column("oauth2_client", "state_required", schema=staticschema)
+    op.drop_column("oauth2_client", "pkce_required", schema=staticschema)
+    op.drop_column("oauth2_bearertoken", "state", schema=staticschema)
+    op.drop_column("oauth2_authorizationcode", "state", schema=staticschema)
+    op.drop_column("oauth2_authorizationcode", "challenge", schema=staticschema)
+    op.drop_column("oauth2_authorizationcode", "challenge_method", schema=staticschema)

c2cgeoportal_commons/alembic/static/7ef947f30f20_add_oauth2_tables.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020, Camptocamp SA
+# Copyright (c) 2020-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_commons/alembic/static/ae5e88f35669_add_table_user_role.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2019, Camptocamp SA
+# Copyright (c) 2018-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -59,24 +59,20 @@ def upgrade() -> None:
         schema=staticschema,
     )
     op.execute(
-        """
+        f"""
 INSERT INTO "{staticschema}"."user_role" ("user_id", "role_id")
 SELECT "user"."id", "role"."id"
 FROM "{staticschema}"."user"
-JOIN "{schema}"."role" ON "role"."name" = "user"."role_name";""".format(
-            schema=schema, staticschema=staticschema
-        )
+JOIN "{schema}"."role" ON "role"."name" = "user"."role_name";"""
     )
 
     op.add_column("user", Column("settings_role_id", Integer), schema=staticschema)
     op.execute(
-        """
+        f"""
 UPDATE "{staticschema}"."user"
 SET "settings_role_id" = "role"."id"
 FROM "{schema}"."role"
-WHERE "role"."name" = "user"."role_name";""".format(
-            schema=schema, staticschema=staticschema
-        )
+WHERE "role"."name" = "user"."role_name";"""
     )
 
     op.drop_column("user", "role_name", schema=staticschema)
@@ -90,13 +86,11 @@ def downgrade() -> None:
     op.add_column("user", Column("role_name", Unicode), schema=staticschema)
 
     op.execute(
-        """
+        f"""
 UPDATE "{staticschema}"."user"
 SET "role_name" = "role"."name"
 FROM "{schema}"."role"
-WHERE "role"."id" = "user"."settings_role_id";""".format(
-            schema=schema, staticschema=staticschema
-        )
+WHERE "role"."id" = "user"."settings_role_id";"""
     )
 
     op.drop_column("user", "settings_role_id", schema=staticschema)

c2cgeoportal_commons/lib/url.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2021, Camptocamp SA
+# Copyright (c) 2013-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_commons/lib/validators.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2019-2020, Camptocamp SA
+# Copyright (c) 2019-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_commons/models/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -41,7 +41,7 @@ except ModuleNotFoundError:
     pass
 
 
-# Should be filed on application initialisation
+# Should be filed on application initialization
 DBSession: sqlalchemy.orm.Session = None
 Base: sqlalchemy.ext.declarative.ConcreteBase = sqlalchemy.ext.declarative.declarative_base()
 DBSessions: Dict[str, sqlalchemy.orm.Session] = {}

c2cgeoportal_commons/models/main.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -26,6 +26,7 @@
 # either expressed or implied, of the FreeBSD Project.
 
 
+import enum
 import logging
 import os
 import re
@@ -38,9 +39,10 @@ from geoalchemy2 import Geometry
 from geoalchemy2.shape import to_shape
 from papyrus.geo_interface import GeoInterface
 from sqlalchemy import Column, ForeignKey, Table, UniqueConstraint, event
+from sqlalchemy.ext.declarative import AbstractConcreteBase
 from sqlalchemy.orm import Session, backref, relationship
 from sqlalchemy.schema import Index
-from sqlalchemy.types import Boolean, Enum, Integer, String, Unicode
+from sqlalchemy.types import Boolean, DateTime, Enum, Integer, String, Unicode
 
 from c2cgeoportal_commons.lib.literal import Literal
 from c2cgeoportal_commons.lib.url import get_url2
@@ -860,11 +862,6 @@ class OGCServer(Base):  # type: ignore
         return url.url() if url else "\n".join(errors)
 
 
-event.listen(OGCServer, "after_insert", cache_invalidate_cb, propagate=True)
-event.listen(OGCServer, "after_update", cache_invalidate_cb, propagate=True)
-event.listen(OGCServer, "after_delete", cache_invalidate_cb, propagate=True)
-
-
 class LayerWMS(DimensionLayer):
     """The layer_wms table representation."""
 
@@ -1748,3 +1745,100 @@ class Dimension(Base):  # type: ignore
 
     def __str__(self) -> str:
         return f"{self.name}={self.value}[{self.id}]"
+
+
+class LogAction(enum.Enum):
+    """The log action enumeration."""
+
+    INSERT = enum.auto()
+    UPDATE = enum.auto()
+    DELETE = enum.auto()
+    SYNCHRONIZE = enum.auto()
+    CONVERT_TO_WMTS = enum.auto()
+    CONVERT_TO_WMS = enum.auto()
+
+
+class AbstractLog(AbstractConcreteBase, Base):  # type: ignore
+    """The abstract log table representation."""
+
+    strict_attrs = True
+    __colanderalchemy_config__ = {
+        "title": _("Log"),
+        "plural": _("Logs"),
+    }
+
+    id = Column(Integer, primary_key=True, info={"colanderalchemy": {}})
+    date = Column(
+        DateTime(timezone=True),
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Date"),
+            }
+        },
+    )
+    action = Column(
+        Enum(LogAction, native_enum=False),
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Action"),
+            }
+        },
+    )
+    element_type = Column(
+        String(50),
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Element type"),
+            }
+        },
+    )
+    element_id = Column(
+        Integer,
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Element identifier"),
+            }
+        },
+    )
+    element_name = Column(
+        Unicode,
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Element name"),
+            }
+        },
+    )
+    element_url_table = Column(
+        Unicode,
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Table segment of the element URL"),
+            }
+        },
+    )
+    username = Column(
+        Unicode,
+        nullable=False,
+        info={
+            "colanderalchemy": {
+                "title": _("Username"),
+            }
+        },
+    )
+
+
+class Log(AbstractLog):
+    """The main log table representation."""
+
+    __tablename__ = "log"
+    __table_args__ = {"schema": _schema}
+    __mapper_args__ = {
+        "polymorphic_identity": "main",
+        "concrete": True,
+    }

c2cgeoportal_commons/models/sqlalchemy.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2012-2021, Camptocamp SA
+# Copyright (c) 2012-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -38,20 +38,17 @@ class JSONEncodedDict(TypeDecorator):  # type: ignore
 
     impl = VARCHAR
 
-    @staticmethod
-    def process_bind_param(value: Optional[Dict[str, Any]], _: Dialect) -> Optional[str]:
+    def process_bind_param(self, value: Optional[Dict[str, Any]], _: Dialect) -> Optional[str]:
         return json.dumps(value) if value is not None else None
 
-    @staticmethod
-    def process_result_value(value: Optional[str], _: Dialect) -> Optional[Dict[str, Any]]:
+    def process_result_value(self, value: Optional[str], _: Dialect) -> Optional[Dict[str, Any]]:
         return json.loads(value) if value is not None else None
 
     @property
     def python_type(self) -> Type[Any]:
         return dict
 
-    @staticmethod
-    def process_literal_param(value: str, dialect: Any) -> str:
+    def process_literal_param(self, value: str, dialect: Any) -> str:
         del dialect
         return json.dumps(value)
 
@@ -59,7 +56,9 @@ class JSONEncodedDict(TypeDecorator):  # type: ignore
 class TsVector(UserDefinedType):  # type: ignore
     """A custom type for PostgreSQL's tsvector type."""
 
-    def get_col_spec(self) -> str:  # pylint: disable=no-self-use
+    cache_ok = True
+
+    def get_col_spec(self) -> str:
         return "TSVECTOR"
 
     @property

c2cgeoportal_commons/models/static.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -44,7 +44,7 @@ from sqlalchemy.types import Boolean, DateTime, Integer, String, Unicode
 
 from c2cgeoportal_commons.lib.literal import Literal
 from c2cgeoportal_commons.models import Base, _
-from c2cgeoportal_commons.models.main import Role
+from c2cgeoportal_commons.models.main import AbstractLog, Role
 
 try:
     from c2cgeoform.ext.deform_ext import RelationSelect2Widget
@@ -386,6 +386,33 @@ class OAuth2Client(Base):  # type: ignore
             }
         },
     )
+    state_required = Column(
+        Boolean,
+        default=False,
+        info={
+            "colanderalchemy": {
+                "title": _("State required"),
+                "description": _(
+                    "The state is required for this client (see: "
+                    "https://auth0.com/docs/secure/attack-protection/state-parameters)."
+                ),
+            }
+        },
+    )
+    pkce_required = Column(
+        Boolean,
+        default=False,
+        info={
+            "colanderalchemy": {
+                "title": _("PKCE required"),
+                "description": _(
+                    "PKCE is required for this client (see: "
+                    "https://auth0.com/docs/get-started/authentication-and-authorization-flow/"
+                    "authorization-code-flow-with-proof-key-for-code-exchange-pkce)."
+                ),
+            }
+        },
+    )
 
 
 class OAuth2BearerToken(Base):  # type: ignore
@@ -406,6 +433,7 @@ class OAuth2BearerToken(Base):  # type: ignore
     access_token = Column(Unicode(100), unique=True)
     refresh_token = Column(Unicode(100), unique=True)
     expire_at = Column(DateTime(timezone=True))  # in one hour
+    state = Column(String)
 
 
 class OAuth2AuthorizationCode(Base):  # type: ignore
@@ -425,4 +453,18 @@ class OAuth2AuthorizationCode(Base):  # type: ignore
     user = relationship(User)
     redirect_uri = Column(Unicode)
     code = Column(Unicode(100), unique=True)
+    state = Column(String)
+    challenge = Column(String(128))
+    challenge_method = Column(String(6))
     expire_at = Column(DateTime(timezone=True))  # in 10 minutes
+
+
+class Log(AbstractLog):
+    """The static log table representation."""
+
+    __tablename__ = "log"
+    __table_args__ = {"schema": _schema}
+    __mapper_args__ = {
+        "polymorphic_identity": "static",
+        "concrete": True,
+    }

c2cgeoportal_commons/testing/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2021, Camptocamp SA
+# Copyright (c) 2018-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -77,7 +77,8 @@ def generate_mappers() -> None:
 
     # import or define all models here to ensure they are attached to the
     # Base.metadata prior to any initialization routines
-    import c2cgeoportal_commons.models.main  # noqa: ignore=F401
+    import c2cgeoportal_commons.models.main  # pylint: disable=unused-import,import-outside-toplevel
+    import c2cgeoportal_commons.models.static  # pylint: disable=import-outside-toplevel
 
     # run configure_mappers after defining all of the models to ensure
     # all relationships can be setup

{c2cgeoportal_commons-2.7.1.156.dist-info → c2cgeoportal_commons-2.8.1.180.dist-info}/METADATA

@@ -1,11 +1,13 @@
 Metadata-Version: 2.1
 Name: c2cgeoportal-commons
-Version: 2.7.1.156
+Version: 2.8.1.180
 Summary: c2cgeoportal commons
 Home-page: https://github.com/camptocamp/c2cgeoportal/
 Author: Camptocamp
 Author-email: info@camptocamp.com
+License: UNKNOWN
 Keywords: web gis geoportail c2cgeoportal geocommune pyramid
+Platform: UNKNOWN
 Classifier: Development Status :: 6 - Mature
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Pyramid
@@ -18,15 +20,15 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering :: GIS
 Classifier: Typing :: Typed
 Description-Content-Type: text/markdown
-Requires-Dist: c2c.template
 Requires-Dist: GeoAlchemy2
+Requires-Dist: c2c.template
+Requires-Dist: jinja2 (>=3.1.3)
 Requires-Dist: papyrus
 Requires-Dist: pyramid
+Requires-Dist: setuptools (>=65.5.1)
 Requires-Dist: sqlalchemy
 Requires-Dist: transaction
 Requires-Dist: zope.event
-Requires-Dist: jinja2 (>=2.11.3)
-Requires-Dist: setuptools (>=65.5.1)
 Provides-Extra: broadcast
 Requires-Dist: c2cwsgiutils ; extra == 'broadcast'
 Provides-Extra: testing
@@ -65,3 +67,5 @@ use `common/testing/initialized.py` to create the database (`development.ini` at
 ```
 make test
 ```
+
+