Source code for pyrogram.methods.messages.get_chat_history

#  Pyrogram - Telegram MTProto API Client Library for Python
#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
#  This file is part of Pyrogram.
#
#  Pyrogram 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.
#
#  Pyrogram 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 Pyrogram.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations


import pyrogram
from pyrogram import raw, types, utils
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from datetime import datetime, timedelta
    from collections.abc import AsyncGenerator


async def get_chunk(
    *,
    client: pyrogram.Client,
    chat_id: int | str,
    limit: int = 0,
    offset: int = 0,
    from_message_id: int = 0,
    from_date: datetime | timedelta = utils.zero_datetime(),
    min_id: int = 0,
    max_id: int = 0,
    reverse: bool = False,
):
    messages = await client.invoke(
        raw.functions.messages.GetHistory(
            peer=await client.resolve_peer(chat_id),
            offset_id=from_message_id,
            offset_date=utils.datetime_to_timestamp(from_date),
            add_offset=offset,
            limit=limit,
            max_id=max_id,
            min_id=min_id,
            hash=0,
        ),
        sleep_threshold=60,
    )

    messages = await utils.parse_messages(client, messages, replies=0)

    if reverse:
        messages.reverse()

    return messages


class GetChatHistory:
    async def get_chat_history(
        self: pyrogram.Client,
        chat_id: int | str,
        limit: int = 0,
        offset: int = 0,
        offset_id: int = 0,
        offset_date: datetime | timedelta = utils.zero_datetime(),
        min_id: int = 0,
        max_id: int = 0,
        reverse: bool = False,
    ) -> AsyncGenerator[types.Message, None] | None:
        """Get messages from a chat history.

        The messages are returned in reverse chronological order.

        .. include:: /_includes/usable-by/users.rst

        Parameters:
            chat_id (``int`` | ``str``):
                Unique identifier (int) or username (str) of the target chat.
                For your personal cloud (Saved Messages) you can simply use "me" or "self".
                For a contact that exists in your Telegram address book you can use his phone number (str).

            limit (``int``, *optional*):
                Limits the number of messages to be retrieved.
                By default, no limit is applied and all messages are returned.

            offset (``int``, *optional*):
                Sequential number of the first message to be returned..
                Negative values are also accepted and become useful in case you set offset_id or offset_date.

            offset_id (``int``, *optional*):
                Identifier of the first message to be returned.

            offset_date (:py:obj:`~datetime.datetime`, *optional*):
                Pass a date as offset to retrieve only older messages starting from that date.

            min_id (``int``, *optional*):
                Identifier of the oldest message to be returned, inclusive.

            max_id (``int``, *optional*):
                Identifier of the newest message to be returned, inclusive.

            reverse (``bool``, *optional*):
                Pass True to return the messages in chronological order, oldest first.

        Returns:
            ``Generator``: A generator yielding :obj:`~pyrogram.types.Message` objects.

        Example:
            .. code-block:: python

                async for message in app.get_chat_history(chat_id):
                    print(message.text)
        """
        current = 0
        total = limit or (1 << 31) - 1
        limit = min(100, total)

        min_id = (min_id - 1) if min_id else 0
        max_id = (max_id + 1) if max_id else 0

        if not offset_id and not (reverse and utils.datetime_to_timestamp(offset_date)):
            offset_id = min_id + 1 if reverse else max_id

        if reverse:
            offset = offset - limit

        while True:
            messages = await get_chunk(
                client=self,
                chat_id=chat_id,
                limit=limit,
                offset=offset,
                from_message_id=offset_id,
                from_date=offset_date,
                min_id=min_id,
                max_id=max_id,
                reverse=reverse,
            )

            if not messages:
                return

            if reverse:
                min_id = messages[-1].id
                offset_id = min_id + 1
            else:
                offset_id = messages[-1].id
                offset = 0

            for message in messages:
                yield message

                current += 1

                if current >= total:
                    return