MTPyroger/pyrogram/methods/messages/copy_media_group.py
2022-01-07 10:23:45 +01:00

135 lines
5.7 KiB
Python

# 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 typing import Union, List
from pyrogram import types, utils, raw
from pyrogram.scaffold import Scaffold
class CopyMediaGroup(Scaffold):
async def copy_media_group(
self,
chat_id: Union[int, str],
from_chat_id: Union[int, str],
message_id: int,
captions: Union[List[str], str] = None,
disable_notification: bool = None,
reply_to_message_id: int = None,
schedule_date: int = None,
) -> List["types.Message"]:
"""Copy a media group by providing one of the message ids.
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).
from_chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the source chat where the original media group was sent.
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).
message_id (``int``):
Message identifier in the chat specified in *from_chat_id*.
captions (``str`` | List of ``str`` , *optional*):
New caption for media, 0-1024 characters after entities parsing for each media.
If not specified, the original caption is kept.
Pass "" (empty string) to remove the caption.
If a ``string`` is passed, it becomes a caption only for the first media.
If a list of ``string`` passed, each element becomes caption for each media element.
You can pass ``None`` in list to keep the original caption (see examples below).
disable_notification (``bool``, *optional*):
Sends the message silently.
Users will receive a notification with no sound.
reply_to_message_id (``int``, *optional*):
If the message is a reply, ID of the original message.
schedule_date (``int``, *optional*):
Date when the message will be automatically sent. Unix time.
Returns:
List of :obj:`~pyrogram.types.Message`: On success, a list of copied messages is returned.
Example:
.. code-block:: python
# Copy a media group
app.copy_media_group("me", source_chat, message_id)
app.copy_media_group("me", source_chat, message_id, captions="single caption")
app.copy_media_group("me", source_chat, message_id, captions=["caption 1", None, ""])
"""
media_group = await self.get_media_group(from_chat_id, message_id)
multi_media = []
for i, message in enumerate(media_group):
if message.photo:
file_id = message.photo.file_id
elif message.audio:
file_id = message.audio.file_id
elif message.document:
file_id = message.document.file_id
elif message.video:
file_id = message.video.file_id
else:
raise ValueError("Message with this type can't be copied.")
media = utils.get_input_media_from_file_id(file_id=file_id)
multi_media.append(
raw.types.InputSingleMedia(
media=media,
random_id=self.rnd_id(),
**await self.parser.parse(
captions[i] if isinstance(captions, list) and i < len(captions) and captions[i] else
captions if isinstance(captions, str) and i == 0 else
message.caption if message.caption and message.caption != "None" and not type(
captions) is str else "")
)
)
r = await self.send(
raw.functions.messages.SendMultiMedia(
peer=await self.resolve_peer(chat_id),
multi_media=multi_media,
silent=disable_notification or None,
reply_to_msg_id=reply_to_message_id,
schedule_date=schedule_date
),
sleep_threshold=60
)
return await utils.parse_messages(
self,
raw.types.messages.Messages(
messages=[m.message for m in filter(
lambda u: isinstance(u, (raw.types.UpdateNewMessage,
raw.types.UpdateNewChannelMessage,
raw.types.UpdateNewScheduledMessage)),
r.updates
)],
users=r.users,
chats=r.chats
)
)