Source code for woob.capabilities.messages

# Copyright(C) 2010-2015 Romain Bignon
#
# This file is part of woob.
#
# woob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# woob 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with woob. If not, see <http://www.gnu.org/licenses/>.


import datetime
import time

from .base import BaseObject, Capability, Field, IntField, NotLoaded, StringField, UserError
from .date import DateField


__all__ = ["Thread", "Message", "CapMessages", "CantSendMessage", "CapMessagesPost"]


class Message(BaseObject):
    """
    Represents a message read or to send.
    """

    IS_HTML = 0x001
    "The content is HTML formatted"
    IS_UNREAD = 0x002
    "The message is unread"
    IS_RECEIVED = 0x004
    "The receiver has read this message"
    IS_NOT_RECEIVED = 0x008
    "The receiver hass not read this message"

    thread = Field("Reference to the thread", "Thread")
    title = StringField("Title of message")
    sender = StringField("Author of this message")
    receivers = Field("Receivers of the message", list)
    date = DateField("Date when the message has been sent")
    content = StringField("Body of message")
    signature = StringField("Optional signature")
    parent = Field("Parent message", "Message")
    children = Field("Children fields", list)
    flags = IntField("Flags (IS_* constants)", default=0)

    def __init__(
        self,
        thread=NotLoaded,
        id=NotLoaded,
        title=NotLoaded,
        sender=NotLoaded,
        receivers=NotLoaded,
        date=None,
        parent=NotLoaded,
        content=NotLoaded,
        signature=NotLoaded,
        children=NotLoaded,
        flags=0,
        url=None,
    ):
        super().__init__(id, url)
        self.thread = thread
        self.title = title
        self.sender = sender
        self.receivers = receivers
        self.content = content
        self.signature = signature
        self.children = children
        self.flags = flags

        if date is None:
            date = datetime.datetime.utcnow()
        self.date = date

        if isinstance(parent, Message):
            self.parent = parent
        else:
            self.parent = NotLoaded
            self._parent_id = parent

    @property
    def date_int(self):
        """
        Date of message as an integer.
        """
        return int(time.strftime("%Y%m%d%H%M%S", self.date.timetuple()))

    @property
    def full_id(self):
        """
        Full ID of message (in form '**THREAD_ID.MESSAGE_ID**')
        """
        return f"{self.thread.id}.{self.id}"

    @property
    def full_parent_id(self):
        """
        Get the full ID of the parent message (in form '**THREAD_ID.MESSAGE_ID**').
        """
        if self.parent:
            return self.parent.full_id
        elif self._parent_id is None:
            return ""
        elif self._parent_id is NotLoaded:
            return NotLoaded
        else:
            return f"{self.thread.id}.{self._parent_id}"

    def __eq__(self, msg):
        if not isinstance(msg, Message):
            return False

        if self.thread:
            return str(self.thread.id) == str(msg.thread.id) and str(self.id) == str(msg.id)
        else:
            return str(self.id) == str(msg.id)

    def __repr__(self):
        return f"<Message id={self.full_id!r} title={self.title!r} date={self.date!r} from={self.sender!r}>"


class Thread(BaseObject):
    """
    Thread containing messages.
    """

    IS_THREADS = 0x001
    IS_DISCUSSION = 0x002

    root = Field("Root message", Message)
    title = StringField("Title of thread")
    date = DateField("Date of thread")
    flags = IntField("Flags (IS_* constants)", default=IS_THREADS)

    def iter_all_messages(self):
        """
        Iter all messages of the thread.

        :rtype: iter[:class:`Message`]
        """
        if self.root:
            yield self.root
            yield from self._iter_all_messages(self.root)

    def _iter_all_messages(self, message):
        if message.children:
            for child in message.children:
                yield child
                yield from self._iter_all_messages(child)


class CapMessages(Capability):
    """
    Capability to read messages.
    """

    def iter_threads(self):
        """
        Iterates on threads, from newers to olders.

        :rtype: iter[:class:`Thread`]
        """
        raise NotImplementedError()

    def get_thread(self, id):
        """
        Get a specific thread.

        :rtype: :class:`Thread`
        """
        raise NotImplementedError()

    def iter_unread_messages(self):
        """
        Iterates on messages which hasn't been marked as read.

        :rtype: iter[:class:`Message`]
        """
        raise NotImplementedError()

    def set_message_read(self, message):
        """
        Set a message as read.

        :param message: message read (or ID)
        :type message: :class:`Message` or str
        """
        raise NotImplementedError()


class CantSendMessage(UserError):
    """
    Raised when a message can't be send.
    """


class CapMessagesPost(Capability):
    """
    This capability allow user to send a message.
    """

    def post_message(self, message):
        """
        Post a message.

        :param message: message to send
        :type message: :class:`Message`
        :raises: :class:`CantSendMessage`
        """
        raise NotImplementedError()