view libervia/backend/models/core.py @ 4212:5f2d496c633f

core: get rid of `pickle`: Use of `pickle` to serialise data was a technical legacy that was causing trouble to store in database, to update (if a class was serialised, a change could break update), and to security (pickle can lead to code execution). This patch remove all use of Pickle in favour in JSON, notably: - for caching data, a Pydantic model is now used instead - for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation - in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and `to_dict` method have been implemented to do serialisation. - new methods to (de)serialise data can now be specified with Identity data types. It is notably used to (de)serialise `path` of avatars. A migration script has been created to convert data (for upgrade or downgrade), with special care for XEP-0373 case. Depending of size of database, this migration script can be long to run. rel 443
author Goffi <goffi@goffi.org>
date Fri, 23 Feb 2024 13:31:04 +0100
parents a1f7040b5a15
children 0d7bb4df2343
line wrap: on
line source

#!/usr/bin/env python3

# Libervia common models
# Copyright (C) 2009-2023 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from pydantic import BaseModel, Field


class MessageData(dict):
    pass


class MessageUpdateData(BaseModel):
    type: str

    def __init__(self, **kwargs):
        if "type" not in kwargs:
            kwargs["type"] = "reactions"
        super().__init__(**kwargs)


class MessageReactionData(MessageUpdateData):
    reactions: dict[str, list[str]] = Field(
        description="Reaction to reacting entities mapping"
    )


class MessageEdition(BaseModel):
    """Data used to send a message edition"""
    message: dict[str, str]
    subject: dict[str, str] = Field(default_factory=dict)
    extra: dict[str, str] = Field(default_factory=dict)