1256 lines
42 KiB
Python
1256 lines
42 KiB
Python
# SPDX-License-Identifier: MIT
|
|
|
|
# If you're wondering why this is essentially copy pasted from the async_.py
|
|
# file, then it's due to needing two separate types to make the typing shenanigans
|
|
# a bit easier to write. It's an unfortunate design. Originally, these types were
|
|
# merged and an adapter was used to differentiate between the async and sync versions.
|
|
# However, this proved to be difficult to provide typings for, so here we are.
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import re
|
|
import threading
|
|
import time
|
|
from errno import ECONNRESET
|
|
from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Tuple, Type, Union, overload
|
|
from urllib.parse import quote as urlquote
|
|
|
|
from .. import utils
|
|
from ..channel import PartialMessageable
|
|
from ..errors import DiscordServerError, Forbidden, HTTPException, NotFound, WebhookTokenMissing
|
|
from ..flags import MessageFlags
|
|
from ..http import Route
|
|
from ..message import Message
|
|
from .async_ import BaseWebhook, _WebhookState, handle_message_parameters
|
|
|
|
__all__ = (
|
|
"SyncWebhook",
|
|
"SyncWebhookMessage",
|
|
)
|
|
|
|
_log = logging.getLogger(__name__)
|
|
|
|
if TYPE_CHECKING:
|
|
from types import TracebackType
|
|
|
|
from ..abc import Snowflake
|
|
from ..embeds import Embed
|
|
from ..file import File
|
|
from ..mentions import AllowedMentions
|
|
from ..message import Attachment
|
|
from ..types.webhook import Webhook as WebhookPayload
|
|
|
|
try:
|
|
from requests import Response, Session
|
|
except ModuleNotFoundError:
|
|
pass
|
|
|
|
MISSING = utils.MISSING
|
|
|
|
|
|
class DeferredLock:
|
|
def __init__(self, lock: threading.Lock) -> None:
|
|
self.lock = lock
|
|
self.delta: Optional[float] = None
|
|
|
|
def __enter__(self):
|
|
self.lock.acquire()
|
|
return self
|
|
|
|
def delay_by(self, delta: float) -> None:
|
|
self.delta = delta
|
|
|
|
def __exit__(
|
|
self,
|
|
type: Optional[Type[BaseException]],
|
|
value: Optional[BaseException],
|
|
traceback: Optional[TracebackType],
|
|
) -> None:
|
|
if self.delta:
|
|
time.sleep(self.delta)
|
|
self.lock.release()
|
|
|
|
|
|
class WebhookAdapter:
|
|
def __init__(self) -> None:
|
|
self._locks: Dict[Any, threading.Lock] = {}
|
|
|
|
def request(
|
|
self,
|
|
route: Route,
|
|
session: Session,
|
|
*,
|
|
payload: Optional[Dict[str, Any]] = None,
|
|
multipart: Optional[List[Dict[str, Any]]] = None,
|
|
files: Optional[List[File]] = None,
|
|
reason: Optional[str] = None,
|
|
auth_token: Optional[str] = None,
|
|
params: Optional[Dict[str, Any]] = None,
|
|
) -> Any:
|
|
headers: Dict[str, str] = {}
|
|
files = files or []
|
|
to_send: Optional[Union[str, Dict[str, Any]]] = None
|
|
bucket = (route.webhook_id, route.webhook_token)
|
|
|
|
try:
|
|
lock = self._locks[bucket]
|
|
except KeyError:
|
|
self._locks[bucket] = lock = threading.Lock()
|
|
|
|
if payload is not None:
|
|
headers["Content-Type"] = "application/json"
|
|
to_send = utils._to_json(payload)
|
|
|
|
if auth_token is not None:
|
|
headers["Authorization"] = f"Bot {auth_token}"
|
|
|
|
if reason is not None:
|
|
headers["X-Audit-Log-Reason"] = urlquote(reason, safe="/ ")
|
|
|
|
response: Optional[Response] = None
|
|
data: Optional[Union[Dict[str, Any], str]] = None
|
|
file_data: Optional[Dict[str, Any]] = None
|
|
method = route.method
|
|
url = route.url
|
|
webhook_id = route.webhook_id
|
|
|
|
with DeferredLock(lock) as lock:
|
|
for attempt in range(5):
|
|
for file in files:
|
|
file.reset(seek=attempt)
|
|
|
|
if multipart:
|
|
file_data = {}
|
|
for p in multipart:
|
|
name = p["name"]
|
|
if name == "payload_json":
|
|
to_send = {"payload_json": p["value"]}
|
|
else:
|
|
file_data[name] = (p["filename"], p["value"], p["content_type"])
|
|
|
|
try:
|
|
with session.request(
|
|
method, url, data=to_send, files=file_data, headers=headers, params=params
|
|
) as response:
|
|
_log.debug(
|
|
"Webhook ID %s with %s %s with %s has returned status code %s",
|
|
webhook_id,
|
|
method,
|
|
url,
|
|
to_send,
|
|
response.status_code,
|
|
)
|
|
response.encoding = "utf-8"
|
|
# Compatibility with aiohttp
|
|
response.status = response.status_code # type: ignore
|
|
|
|
data = response.text or None
|
|
if data and response.headers["Content-Type"] == "application/json":
|
|
data = utils._from_json(data)
|
|
|
|
remaining = response.headers.get("X-Ratelimit-Remaining")
|
|
if remaining == "0" and response.status_code != 429:
|
|
delta = utils._parse_ratelimit_header(response)
|
|
_log.debug(
|
|
"Webhook ID %s has been pre-emptively rate limited, waiting %.2f seconds",
|
|
webhook_id,
|
|
delta,
|
|
)
|
|
lock.delay_by(delta)
|
|
|
|
if 300 > response.status_code >= 200:
|
|
_log.debug("%s %s has received %s", method, url, data)
|
|
return data
|
|
|
|
if response.status_code == 429:
|
|
if not response.headers.get("Via"):
|
|
raise HTTPException(response, data)
|
|
|
|
retry_after: float = data["retry_after"] # type: ignore
|
|
_log.warning(
|
|
"Webhook ID %s is rate limited. Retrying in %.2f seconds",
|
|
webhook_id,
|
|
retry_after,
|
|
)
|
|
time.sleep(retry_after)
|
|
continue
|
|
|
|
if response.status_code >= 500:
|
|
time.sleep(1 + attempt * 2)
|
|
continue
|
|
|
|
if response.status_code == 403:
|
|
raise Forbidden(response, data)
|
|
elif response.status_code == 404:
|
|
raise NotFound(response, data)
|
|
else:
|
|
raise HTTPException(response, data)
|
|
|
|
except OSError as e:
|
|
if attempt < 4 and e.errno == ECONNRESET:
|
|
time.sleep(1 + attempt * 2)
|
|
continue
|
|
raise
|
|
|
|
if response:
|
|
if response.status_code >= 500:
|
|
raise DiscordServerError(response, data)
|
|
raise HTTPException(response, data)
|
|
|
|
raise RuntimeError("Unreachable code in HTTP handling.")
|
|
|
|
def delete_webhook(
|
|
self,
|
|
webhook_id: int,
|
|
*,
|
|
token: Optional[str] = None,
|
|
session: Session,
|
|
reason: Optional[str] = None,
|
|
):
|
|
route = Route("DELETE", "/webhooks/{webhook_id}", webhook_id=webhook_id)
|
|
return self.request(route, session, reason=reason, auth_token=token)
|
|
|
|
def delete_webhook_with_token(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
*,
|
|
session: Session,
|
|
reason: Optional[str] = None,
|
|
):
|
|
route = Route(
|
|
"DELETE",
|
|
"/webhooks/{webhook_id}/{webhook_token}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
)
|
|
return self.request(route, session, reason=reason)
|
|
|
|
def edit_webhook(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
payload: Dict[str, Any],
|
|
*,
|
|
session: Session,
|
|
reason: Optional[str] = None,
|
|
):
|
|
route = Route("PATCH", "/webhooks/{webhook_id}", webhook_id=webhook_id)
|
|
return self.request(route, session, reason=reason, payload=payload, auth_token=token)
|
|
|
|
def edit_webhook_with_token(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
payload: Dict[str, Any],
|
|
*,
|
|
session: Session,
|
|
reason: Optional[str] = None,
|
|
):
|
|
route = Route(
|
|
"PATCH",
|
|
"/webhooks/{webhook_id}/{webhook_token}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
)
|
|
return self.request(route, session, reason=reason, payload=payload)
|
|
|
|
def execute_webhook(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
*,
|
|
session: Session,
|
|
payload: Optional[Dict[str, Any]] = None,
|
|
multipart: Optional[List[Dict[str, Any]]] = None,
|
|
files: Optional[List[File]] = None,
|
|
thread_id: Optional[int] = None,
|
|
wait: bool = False,
|
|
):
|
|
params = {"wait": int(wait)}
|
|
if thread_id:
|
|
params["thread_id"] = thread_id
|
|
route = Route(
|
|
"POST",
|
|
"/webhooks/{webhook_id}/{webhook_token}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
)
|
|
return self.request(
|
|
route, session, payload=payload, multipart=multipart, files=files, params=params
|
|
)
|
|
|
|
def get_webhook_message(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
message_id: int,
|
|
*,
|
|
session: Session,
|
|
):
|
|
route = Route(
|
|
"GET",
|
|
"/webhooks/{webhook_id}/{webhook_token}/messages/{message_id}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
message_id=message_id,
|
|
)
|
|
return self.request(route, session)
|
|
|
|
def edit_webhook_message(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
message_id: int,
|
|
*,
|
|
session: Session,
|
|
payload: Optional[Dict[str, Any]] = None,
|
|
multipart: Optional[List[Dict[str, Any]]] = None,
|
|
files: Optional[List[File]] = None,
|
|
):
|
|
route = Route(
|
|
"PATCH",
|
|
"/webhooks/{webhook_id}/{webhook_token}/messages/{message_id}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
message_id=message_id,
|
|
)
|
|
return self.request(route, session, payload=payload, multipart=multipart, files=files)
|
|
|
|
def delete_webhook_message(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
message_id: int,
|
|
*,
|
|
session: Session,
|
|
):
|
|
route = Route(
|
|
"DELETE",
|
|
"/webhooks/{webhook_id}/{webhook_token}/messages/{message_id}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
message_id=message_id,
|
|
)
|
|
return self.request(route, session)
|
|
|
|
def fetch_webhook(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
*,
|
|
session: Session,
|
|
):
|
|
route = Route("GET", "/webhooks/{webhook_id}", webhook_id=webhook_id)
|
|
return self.request(route, session=session, auth_token=token)
|
|
|
|
def fetch_webhook_with_token(
|
|
self,
|
|
webhook_id: int,
|
|
token: str,
|
|
*,
|
|
session: Session,
|
|
):
|
|
route = Route(
|
|
"GET",
|
|
"/webhooks/{webhook_id}/{webhook_token}",
|
|
webhook_id=webhook_id,
|
|
webhook_token=token,
|
|
)
|
|
return self.request(route, session=session)
|
|
|
|
|
|
class _WebhookContext(threading.local):
|
|
adapter: Optional[WebhookAdapter] = None
|
|
|
|
|
|
_context = _WebhookContext()
|
|
|
|
|
|
def _get_webhook_adapter() -> WebhookAdapter:
|
|
if _context.adapter is None:
|
|
_context.adapter = WebhookAdapter()
|
|
return _context.adapter
|
|
|
|
|
|
class SyncWebhookMessage(Message):
|
|
"""Represents a message sent from your webhook.
|
|
|
|
This allows you to edit or delete a message sent by your
|
|
webhook.
|
|
|
|
This inherits from :class:`disnake.Message` with changes to
|
|
:meth:`edit` and :meth:`delete` to work.
|
|
|
|
.. versionadded:: 2.0
|
|
"""
|
|
|
|
_state: _WebhookState[SyncWebhook]
|
|
|
|
def edit(
|
|
self,
|
|
content: Optional[str] = MISSING,
|
|
embed: Optional[Embed] = MISSING,
|
|
embeds: List[Embed] = MISSING,
|
|
file: File = MISSING,
|
|
files: List[File] = MISSING,
|
|
attachments: Optional[List[Attachment]] = MISSING,
|
|
allowed_mentions: Optional[AllowedMentions] = None,
|
|
) -> SyncWebhookMessage:
|
|
"""Edits the message.
|
|
|
|
.. note::
|
|
If the original message has embeds with images that were created from local files
|
|
(using the ``file`` parameter with :meth:`Embed.set_image` or :meth:`Embed.set_thumbnail`),
|
|
those images will be removed if the message's attachments are edited in any way
|
|
(i.e. by setting ``file``/``files``/``attachments``, or adding an embed with local files).
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
content: Optional[:class:`str`]
|
|
The content to edit the message with or ``None`` to clear it.
|
|
embed: Optional[:class:`Embed`]
|
|
The new embed to replace the original with. This cannot be mixed with the
|
|
``embeds`` parameter.
|
|
Could be ``None`` to remove the embed.
|
|
embeds: List[:class:`Embed`]
|
|
The new embeds to replace the original with. Must be a maximum of 10.
|
|
This cannot be mixed with the ``embed`` parameter.
|
|
To remove all embeds ``[]`` should be passed.
|
|
file: :class:`File`
|
|
The file to upload. This cannot be mixed with the ``files`` parameter.
|
|
Files will be appended to the message, see the ``attachments`` parameter
|
|
to remove/replace existing files.
|
|
files: List[:class:`File`]
|
|
A list of files to upload. This cannot be mixed with the ``file`` parameter.
|
|
Files will be appended to the message, see the ``attachments`` parameter
|
|
to remove/replace existing files.
|
|
attachments: Optional[List[:class:`Attachment`]]
|
|
A list of attachments to keep in the message.
|
|
If ``[]`` or ``None`` is passed then all existing attachments are removed.
|
|
Keeps existing attachments if not provided.
|
|
|
|
.. versionadded:: 2.2
|
|
|
|
.. versionchanged:: 2.5
|
|
Supports passing ``None`` to clear attachments.
|
|
|
|
allowed_mentions: :class:`AllowedMentions`
|
|
Controls the mentions being processed in this message.
|
|
See :meth:`.abc.Messageable.send` for more information.
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Editing the message failed.
|
|
Forbidden
|
|
Edited a message that is not yours.
|
|
TypeError
|
|
You specified both ``embed`` and ``embeds`` or ``file`` and ``files``
|
|
ValueError
|
|
The length of ``embeds`` was invalid
|
|
WebhookTokenMissing
|
|
There is no token associated with this webhook.
|
|
|
|
Returns
|
|
-------
|
|
:class:`SyncWebhookMessage`
|
|
The newly edited message.
|
|
"""
|
|
# if no attachment list was provided but we're uploading new files,
|
|
# use current attachments as the base
|
|
if attachments is MISSING and (file or files):
|
|
attachments = self.attachments
|
|
|
|
return self._state._webhook.edit_message(
|
|
self.id,
|
|
content=content,
|
|
embeds=embeds,
|
|
embed=embed,
|
|
file=file,
|
|
files=files,
|
|
attachments=attachments,
|
|
allowed_mentions=allowed_mentions,
|
|
)
|
|
|
|
def delete(self, *, delay: Optional[float] = None) -> None:
|
|
"""Deletes the message.
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
delay: Optional[:class:`float`]
|
|
If provided, the number of seconds to wait before deleting the message.
|
|
This blocks the thread.
|
|
|
|
Raises
|
|
------
|
|
Forbidden
|
|
You do not have proper permissions to delete the message.
|
|
NotFound
|
|
The message was deleted already.
|
|
HTTPException
|
|
Deleting the message failed.
|
|
WebhookTokenMissing
|
|
There is no token associated with this webhook.
|
|
"""
|
|
if delay is not None:
|
|
time.sleep(delay)
|
|
self._state._webhook.delete_message(self.id)
|
|
|
|
|
|
class SyncWebhook(BaseWebhook):
|
|
"""Represents a synchronous Discord webhook.
|
|
|
|
For an asynchronous counterpart, see :class:`Webhook`.
|
|
|
|
.. container:: operations
|
|
|
|
.. describe:: x == y
|
|
|
|
Checks if two webhooks are equal.
|
|
|
|
.. describe:: x != y
|
|
|
|
Checks if two webhooks are not equal.
|
|
|
|
.. describe:: hash(x)
|
|
|
|
Returns the webhooks's hash.
|
|
|
|
.. versionchanged:: 1.4
|
|
Webhooks are now comparable and hashable.
|
|
|
|
Attributes
|
|
----------
|
|
id: :class:`int`
|
|
The webhook's ID
|
|
type: :class:`WebhookType`
|
|
The webhook's type.
|
|
|
|
.. versionadded:: 1.3
|
|
|
|
token: Optional[:class:`str`]
|
|
The authentication token of the webhook. If this is ``None``
|
|
then the webhook cannot be used to make requests.
|
|
guild_id: Optional[:class:`int`]
|
|
The guild ID this webhook belongs to.
|
|
channel_id: Optional[:class:`int`]
|
|
The channel ID this webhook belongs to.
|
|
user: Optional[:class:`abc.User`]
|
|
The user this webhook was created by. If the webhook was
|
|
received without authentication then this will be ``None``.
|
|
name: Optional[:class:`str`]
|
|
The default name of the webhook.
|
|
source_guild: Optional[:class:`PartialWebhookGuild`]
|
|
The guild of the channel that this webhook is following.
|
|
Only given if :attr:`type` is :attr:`WebhookType.channel_follower`.
|
|
|
|
.. versionadded:: 2.0
|
|
|
|
source_channel: Optional[:class:`PartialWebhookChannel`]
|
|
The channel that this webhook is following.
|
|
Only given if :attr:`type` is :attr:`WebhookType.channel_follower`.
|
|
|
|
.. versionadded:: 2.0
|
|
|
|
application_id: Optional[:class:`int`]
|
|
The ID of the application associated with this webhook, if it was created by an application.
|
|
|
|
.. versionadded:: 2.6
|
|
"""
|
|
|
|
__slots__: Tuple[str, ...] = ("session",)
|
|
|
|
def __init__(
|
|
self, data: WebhookPayload, session: Session, token: Optional[str] = None, state=None
|
|
) -> None:
|
|
super().__init__(data, token, state)
|
|
self.session = session
|
|
|
|
def __repr__(self) -> str:
|
|
return f"<Webhook id={self.id!r}>"
|
|
|
|
@property
|
|
def url(self) -> str:
|
|
""":class:`str` : Returns the webhook's url."""
|
|
return f"https://discord.com/api/webhooks/{self.id}/{self.token}"
|
|
|
|
@classmethod
|
|
def partial(
|
|
cls, id: int, token: str, *, session: Session = MISSING, bot_token: Optional[str] = None
|
|
) -> SyncWebhook:
|
|
"""Creates a partial :class:`Webhook`.
|
|
|
|
Parameters
|
|
----------
|
|
id: :class:`int`
|
|
The webhook's ID.
|
|
token: :class:`str`
|
|
The webhook's authentication token.
|
|
session: :class:`requests.Session`
|
|
The session to use to send requests with. Note
|
|
that the library does not manage the session and
|
|
will not close it. If not given, the ``requests``
|
|
auto session creation functions are used instead.
|
|
bot_token: Optional[:class:`str`]
|
|
The bot authentication token for authenticated requests
|
|
involving the webhook.
|
|
|
|
Returns
|
|
-------
|
|
:class:`Webhook`
|
|
A partial :class:`Webhook`.
|
|
A partial webhook is just a webhook object with an ID and a token.
|
|
"""
|
|
data: WebhookPayload = {
|
|
"id": id,
|
|
"type": 1,
|
|
"token": token,
|
|
}
|
|
import requests
|
|
|
|
if session is not MISSING:
|
|
if not isinstance(session, requests.Session):
|
|
raise TypeError(f"expected requests.Session not {session.__class__!r}")
|
|
else:
|
|
session = requests # type: ignore
|
|
return cls(data, session, token=bot_token)
|
|
|
|
@classmethod
|
|
def from_url(
|
|
cls, url: str, *, session: Session = MISSING, bot_token: Optional[str] = None
|
|
) -> SyncWebhook:
|
|
"""Creates a partial :class:`Webhook` from a webhook URL.
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`ValueError` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
url: :class:`str`
|
|
The webhook's URL.
|
|
session: :class:`requests.Session`
|
|
The session to use to send requests with. Note
|
|
that the library does not manage the session and
|
|
will not close it. If not given, the ``requests``
|
|
auto session creation functions are used instead.
|
|
bot_token: Optional[:class:`str`]
|
|
The bot authentication token for authenticated requests
|
|
involving the webhook.
|
|
|
|
Raises
|
|
------
|
|
ValueError
|
|
The URL is invalid.
|
|
|
|
Returns
|
|
-------
|
|
:class:`Webhook`
|
|
A partial :class:`Webhook`.
|
|
A partial webhook is just a webhook object with an ID and a token.
|
|
"""
|
|
m = re.search(
|
|
r"discord(?:app)?.com/api/webhooks/(?P<id>[0-9]{17,19})/(?P<token>[A-Za-z0-9\.\-\_]{60,68})",
|
|
url,
|
|
)
|
|
if m is None:
|
|
raise ValueError("Invalid webhook URL given.")
|
|
|
|
data: Dict[str, Any] = m.groupdict()
|
|
data["type"] = 1
|
|
import requests
|
|
|
|
if session is not MISSING:
|
|
if not isinstance(session, requests.Session):
|
|
raise TypeError(f"expected requests.Session not {session.__class__!r}")
|
|
else:
|
|
session = requests # type: ignore
|
|
return cls(data, session, token=bot_token) # type: ignore
|
|
|
|
def fetch(self, *, prefer_auth: bool = True) -> SyncWebhook:
|
|
"""Fetches the current webhook.
|
|
|
|
This could be used to get a full webhook from a partial webhook.
|
|
|
|
.. note::
|
|
|
|
When fetching with an unauthenticated webhook, i.e.
|
|
:meth:`is_authenticated` returns ``False``, then the
|
|
returned webhook does not contain any user information.
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
prefer_auth: :class:`bool`
|
|
Whether to use the bot token over the webhook token,
|
|
if available. Defaults to ``True``.
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Could not fetch the webhook
|
|
NotFound
|
|
Could not find the webhook by this ID
|
|
WebhookTokenMissing
|
|
This webhook does not have a token associated with it.
|
|
|
|
Returns
|
|
-------
|
|
:class:`SyncWebhook`
|
|
The fetched webhook.
|
|
"""
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
|
|
if prefer_auth and self.auth_token:
|
|
data = adapter.fetch_webhook(self.id, self.auth_token, session=self.session)
|
|
elif self.token:
|
|
data = adapter.fetch_webhook_with_token(self.id, self.token, session=self.session)
|
|
else:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
return SyncWebhook(data, self.session, token=self.auth_token, state=self._state)
|
|
|
|
def delete(self, *, reason: Optional[str] = None, prefer_auth: bool = True) -> None:
|
|
"""Deletes this Webhook.
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
reason: Optional[:class:`str`]
|
|
The reason for deleting this webhook. Shows up on the audit log.
|
|
|
|
.. versionadded:: 1.4
|
|
|
|
prefer_auth: :class:`bool`
|
|
Whether to use the bot token over the webhook token,
|
|
if available. Defaults to ``True``.
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Deleting the webhook failed.
|
|
NotFound
|
|
This webhook does not exist.
|
|
Forbidden
|
|
You do not have permissions to delete this webhook.
|
|
WebhookTokenMissing
|
|
This webhook does not have a token associated with it.
|
|
"""
|
|
if self.token is None and self.auth_token is None:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
|
|
if prefer_auth and self.auth_token:
|
|
adapter.delete_webhook(
|
|
self.id, token=self.auth_token, session=self.session, reason=reason
|
|
)
|
|
elif self.token:
|
|
adapter.delete_webhook_with_token(
|
|
self.id, self.token, session=self.session, reason=reason
|
|
)
|
|
|
|
def edit(
|
|
self,
|
|
*,
|
|
reason: Optional[str] = None,
|
|
name: Optional[str] = MISSING,
|
|
avatar: Optional[bytes] = MISSING,
|
|
channel: Optional[Snowflake] = None,
|
|
prefer_auth: bool = True,
|
|
) -> SyncWebhook:
|
|
"""Edits this Webhook.
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
name: Optional[:class:`str`]
|
|
The webhook's new default name.
|
|
avatar: Optional[:class:`bytes`]
|
|
A :term:`py:bytes-like object` representing the webhook's new default avatar.
|
|
channel: Optional[:class:`abc.Snowflake`]
|
|
The webhook's new channel. This requires an authenticated webhook.
|
|
prefer_auth: :class:`bool`
|
|
Whether to use the bot token over the webhook token
|
|
if available. Defaults to ``True``.
|
|
reason: Optional[:class:`str`]
|
|
The reason for editing this webhook. Shows up on the audit log.
|
|
|
|
.. versionadded:: 1.4
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Editing the webhook failed.
|
|
NotFound
|
|
This webhook does not exist.
|
|
WebhookTokenMissing
|
|
This webhook does not have a token associated with it
|
|
or it tried editing a channel without authentication.
|
|
|
|
Returns
|
|
-------
|
|
:class:`SyncWebhook`
|
|
The newly edited webhook.
|
|
"""
|
|
if self.token is None and self.auth_token is None:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
payload = {}
|
|
if name is not MISSING:
|
|
payload["name"] = str(name) if name is not None else None
|
|
|
|
if avatar is not MISSING:
|
|
payload["avatar"] = utils._bytes_to_base64_data(avatar) if avatar is not None else None
|
|
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
|
|
data: Optional[WebhookPayload] = None
|
|
# If a channel is given, always use the authenticated endpoint
|
|
if channel is not None:
|
|
if self.auth_token is None:
|
|
raise WebhookTokenMissing("Editing channel requires authenticated webhook")
|
|
|
|
payload["channel_id"] = channel.id
|
|
data = adapter.edit_webhook(
|
|
self.id, self.auth_token, payload=payload, session=self.session, reason=reason
|
|
)
|
|
|
|
if prefer_auth and self.auth_token:
|
|
data = adapter.edit_webhook(
|
|
self.id, self.auth_token, payload=payload, session=self.session, reason=reason
|
|
)
|
|
elif self.token:
|
|
data = adapter.edit_webhook_with_token(
|
|
self.id, self.token, payload=payload, session=self.session, reason=reason
|
|
)
|
|
|
|
if data is None:
|
|
raise RuntimeError("Unreachable code hit: data was not assigned")
|
|
|
|
return SyncWebhook(
|
|
data=data, session=self.session, token=self.auth_token, state=self._state
|
|
)
|
|
|
|
def _create_message(self, data):
|
|
state = _WebhookState(self, parent=self._state)
|
|
# state may be artificial (unlikely at this point...)
|
|
channel = self.channel
|
|
channel_id = int(data["channel_id"])
|
|
if not channel or self.channel_id != channel_id:
|
|
channel = PartialMessageable(state=self._state, id=channel_id) # type: ignore
|
|
# state is artificial
|
|
return SyncWebhookMessage(data=data, state=state, channel=channel) # type: ignore
|
|
|
|
@overload
|
|
def send(
|
|
self,
|
|
content: Optional[str] = ...,
|
|
*,
|
|
username: str = ...,
|
|
avatar_url: Any = ...,
|
|
tts: bool = ...,
|
|
file: File = ...,
|
|
files: List[File] = ...,
|
|
embed: Embed = ...,
|
|
embeds: List[Embed] = ...,
|
|
suppress_embeds: bool = ...,
|
|
flags: MessageFlags = ...,
|
|
allowed_mentions: AllowedMentions = ...,
|
|
thread: Snowflake = ...,
|
|
thread_name: str = ...,
|
|
wait: Literal[True],
|
|
) -> SyncWebhookMessage:
|
|
...
|
|
|
|
@overload
|
|
def send(
|
|
self,
|
|
content: Optional[str] = ...,
|
|
*,
|
|
username: str = ...,
|
|
avatar_url: Any = ...,
|
|
tts: bool = ...,
|
|
file: File = ...,
|
|
files: List[File] = ...,
|
|
embed: Embed = ...,
|
|
embeds: List[Embed] = ...,
|
|
suppress_embeds: bool = ...,
|
|
flags: MessageFlags = ...,
|
|
allowed_mentions: AllowedMentions = ...,
|
|
thread: Snowflake = ...,
|
|
thread_name: str = ...,
|
|
wait: Literal[False] = ...,
|
|
) -> None:
|
|
...
|
|
|
|
def send(
|
|
self,
|
|
content: Optional[str] = MISSING,
|
|
*,
|
|
username: str = MISSING,
|
|
avatar_url: Any = MISSING,
|
|
tts: bool = False,
|
|
file: File = MISSING,
|
|
files: List[File] = MISSING,
|
|
embed: Embed = MISSING,
|
|
embeds: List[Embed] = MISSING,
|
|
suppress_embeds: bool = MISSING,
|
|
flags: MessageFlags = MISSING,
|
|
allowed_mentions: AllowedMentions = MISSING,
|
|
thread: Snowflake = MISSING,
|
|
thread_name: Optional[str] = None,
|
|
wait: bool = False,
|
|
) -> Optional[SyncWebhookMessage]:
|
|
"""Sends a message using the webhook.
|
|
|
|
The content must be a type that can convert to a string through ``str(content)``.
|
|
|
|
To upload a single file, the ``file`` parameter should be used with a
|
|
single :class:`File` object.
|
|
|
|
If the ``embed`` parameter is provided, it must be of type :class:`Embed` and
|
|
it must be a rich embed type. You cannot mix the ``embed`` parameter with the
|
|
``embeds`` parameter, which must be a :class:`list` of :class:`Embed` objects to send.
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
content: Optional[:class:`str`]
|
|
The content of the message to send.
|
|
username: :class:`str`
|
|
The username to send with this message. If no username is provided
|
|
then the default username for the webhook is used.
|
|
avatar_url: :class:`str`
|
|
The avatar URL to send with this message. If no avatar URL is provided
|
|
then the default avatar for the webhook is used. If this is not a
|
|
string then it is explicitly cast using ``str``.
|
|
tts: :class:`bool`
|
|
Whether the message should be sent using text-to-speech.
|
|
file: :class:`File`
|
|
The file to upload. This cannot be mixed with the ``files`` parameter.
|
|
files: List[:class:`File`]
|
|
A list of files to upload. Must be a maximum of 10.
|
|
This cannot be mixed with the ``file`` parameter.
|
|
embed: :class:`Embed`
|
|
The rich embed for the content to send. This cannot be mixed with the ``embeds`` parameter.
|
|
embeds: List[:class:`Embed`]
|
|
A list of embeds to send with the content. Must be a maximum of 10.
|
|
This cannot be mixed with the ``embed`` parameter.
|
|
allowed_mentions: :class:`AllowedMentions`
|
|
Controls the mentions being processed in this message.
|
|
|
|
.. versionadded:: 1.4
|
|
|
|
thread: :class:`~disnake.abc.Snowflake`
|
|
The thread to send this message to.
|
|
|
|
.. versionadded:: 2.0
|
|
|
|
thread_name: :class:`str`
|
|
If in a forum channel, and thread is not specified,
|
|
the name of the newly created thread.
|
|
|
|
.. versionadded:: 2.6
|
|
|
|
suppress_embeds: :class:`bool`
|
|
Whether to suppress embeds for the message. This hides
|
|
all the embeds from the UI if set to ``True``.
|
|
|
|
.. versionadded:: 2.5
|
|
|
|
flags: :class:`MessageFlags`
|
|
The flags to set for this message.
|
|
Only :attr:`~MessageFlags.suppress_embeds` and :attr:`~MessageFlags.suppress_notifications`
|
|
are supported.
|
|
|
|
If parameter ``suppress_embeds`` is provided,
|
|
that will override the setting of :attr:`MessageFlags.suppress_embeds`.
|
|
|
|
.. versionadded:: 2.9
|
|
|
|
wait: :class:`bool`
|
|
Whether the server should wait before sending a response. This essentially
|
|
means that the return type of this function changes from ``None`` to
|
|
a :class:`WebhookMessage` if set to ``True``.
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Sending the message failed.
|
|
NotFound
|
|
This webhook was not found.
|
|
Forbidden
|
|
The authorization token for the webhook is incorrect.
|
|
TypeError
|
|
You specified both ``embed`` and ``embeds`` or ``file`` and ``files``,
|
|
or both ``thread`` and ``thread_name`` were provided.
|
|
|
|
ValueError
|
|
The length of ``embeds`` was invalid
|
|
WebhookTokenMissing
|
|
There was no token associated with this webhook.
|
|
|
|
Returns
|
|
-------
|
|
Optional[:class:`SyncWebhookMessage`]
|
|
If ``wait`` is ``True`` then the message that was sent, otherwise ``None``.
|
|
"""
|
|
if self.token is None:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
previous_mentions: Optional[AllowedMentions] = getattr(
|
|
self._state, "allowed_mentions", None
|
|
)
|
|
if content is None:
|
|
content = MISSING
|
|
|
|
thread_id: Optional[int] = None
|
|
if thread is not MISSING and thread_name is not None:
|
|
raise TypeError("only one of thread and thread_name can be provided.")
|
|
elif thread is not MISSING:
|
|
thread_id = thread.id
|
|
|
|
params = handle_message_parameters(
|
|
content=content,
|
|
username=username,
|
|
avatar_url=avatar_url,
|
|
tts=tts,
|
|
suppress_embeds=suppress_embeds,
|
|
flags=flags,
|
|
file=file,
|
|
files=files,
|
|
embed=embed,
|
|
embeds=embeds,
|
|
thread_name=thread_name,
|
|
allowed_mentions=allowed_mentions,
|
|
previous_allowed_mentions=previous_mentions,
|
|
)
|
|
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
|
|
try:
|
|
data = adapter.execute_webhook(
|
|
self.id,
|
|
self.token,
|
|
session=self.session,
|
|
payload=params.payload,
|
|
multipart=params.multipart,
|
|
files=params.files,
|
|
thread_id=thread_id,
|
|
wait=wait,
|
|
)
|
|
finally:
|
|
if params.files:
|
|
for f in params.files:
|
|
f.close()
|
|
if wait:
|
|
return self._create_message(data)
|
|
|
|
def fetch_message(self, id: int, /) -> SyncWebhookMessage:
|
|
"""Retrieves a single :class:`SyncWebhookMessage` owned by this webhook.
|
|
|
|
.. versionadded:: 2.0
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
id: :class:`int`
|
|
The message ID to look for.
|
|
|
|
Raises
|
|
------
|
|
NotFound
|
|
The specified message was not found.
|
|
Forbidden
|
|
You do not have the permissions required to get a message.
|
|
HTTPException
|
|
Retrieving the message failed.
|
|
WebhookTokenMissing
|
|
There was no token associated with this webhook.
|
|
|
|
Returns
|
|
-------
|
|
:class:`SyncWebhookMessage`
|
|
The message asked for.
|
|
"""
|
|
if self.token is None:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
data = adapter.get_webhook_message(
|
|
self.id,
|
|
self.token,
|
|
id,
|
|
session=self.session,
|
|
)
|
|
return self._create_message(data)
|
|
|
|
def edit_message(
|
|
self,
|
|
message_id: int,
|
|
*,
|
|
content: Optional[str] = MISSING,
|
|
embed: Optional[Embed] = MISSING,
|
|
embeds: List[Embed] = MISSING,
|
|
file: File = MISSING,
|
|
files: List[File] = MISSING,
|
|
attachments: Optional[List[Attachment]] = MISSING,
|
|
allowed_mentions: Optional[AllowedMentions] = None,
|
|
) -> SyncWebhookMessage:
|
|
"""Edits a message owned by this webhook.
|
|
|
|
This is a lower level interface to :meth:`WebhookMessage.edit` in case
|
|
you only have an ID.
|
|
|
|
.. note::
|
|
If the original message has embeds with images that were created from local files
|
|
(using the ``file`` parameter with :meth:`Embed.set_image` or :meth:`Embed.set_thumbnail`),
|
|
those images will be removed if the message's attachments are edited in any way
|
|
(i.e. by setting ``file``/``files``/``attachments``, or adding an embed with local files).
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
message_id: :class:`int`
|
|
The ID of the message to edit.
|
|
content: Optional[:class:`str`]
|
|
The content to edit the message with, or ``None`` to clear it.
|
|
embed: Optional[:class:`Embed`]
|
|
The new embed to replace the original with. This cannot be mixed with the
|
|
``embeds`` parameter.
|
|
Could be ``None`` to remove the embed.
|
|
embeds: List[:class:`Embed`]
|
|
The new embeds to replace the original with. Must be a maximum of 10.
|
|
This cannot be mixed with the ``embed`` parameter.
|
|
To remove all embeds ``[]`` should be passed.
|
|
file: :class:`File`
|
|
The file to upload. This cannot be mixed with the ``files`` parameter.
|
|
Files will be appended to the message, see the ``attachments`` parameter
|
|
to remove/replace existing files.
|
|
files: List[:class:`File`]
|
|
A list of files to upload. This cannot be mixed with the ``file`` parameter.
|
|
Files will be appended to the message, see the ``attachments`` parameter
|
|
to remove/replace existing files.
|
|
attachments: Optional[List[:class:`Attachment`]]
|
|
A list of attachments to keep in the message.
|
|
If ``[]`` or ``None`` is passed then all existing attachments are removed.
|
|
Keeps existing attachments if not provided.
|
|
|
|
.. versionadded:: 2.2
|
|
|
|
.. versionchanged:: 2.5
|
|
Supports passing ``None`` to clear attachments.
|
|
|
|
allowed_mentions: :class:`AllowedMentions`
|
|
Controls the mentions being processed in this message.
|
|
See :meth:`.abc.Messageable.send` for more information.
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Editing the message failed.
|
|
Forbidden
|
|
Edited a message that is not yours.
|
|
TypeError
|
|
You specified both ``embed`` and ``embeds`` or ``file`` and ``files``
|
|
ValueError
|
|
The length of ``embeds`` was invalid
|
|
WebhookTokenMissing
|
|
There was no token associated with this webhook.
|
|
"""
|
|
if self.token is None:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
# if no attachment list was provided but we're uploading new files,
|
|
# use current attachments as the base
|
|
if attachments is MISSING and (file or files):
|
|
attachments = self.fetch_message(message_id).attachments
|
|
|
|
previous_mentions: Optional[AllowedMentions] = getattr(
|
|
self._state, "allowed_mentions", None
|
|
)
|
|
params = handle_message_parameters(
|
|
content=content,
|
|
file=file,
|
|
files=files,
|
|
attachments=attachments,
|
|
embed=embed,
|
|
embeds=embeds,
|
|
allowed_mentions=allowed_mentions,
|
|
previous_allowed_mentions=previous_mentions,
|
|
)
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
try:
|
|
data = adapter.edit_webhook_message(
|
|
self.id,
|
|
self.token,
|
|
message_id,
|
|
session=self.session,
|
|
payload=params.payload,
|
|
multipart=params.multipart,
|
|
files=params.files,
|
|
)
|
|
finally:
|
|
if params.files:
|
|
for f in params.files:
|
|
f.close()
|
|
return self._create_message(data)
|
|
|
|
def delete_message(self, message_id: int, /) -> None:
|
|
"""Deletes a message owned by this webhook.
|
|
|
|
This is a lower level interface to :meth:`WebhookMessage.delete` in case
|
|
you only have an ID.
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
.. versionchanged:: 2.6
|
|
Raises :exc:`WebhookTokenMissing` instead of ``InvalidArgument``.
|
|
|
|
Parameters
|
|
----------
|
|
message_id: :class:`int`
|
|
The ID of the message to delete.
|
|
|
|
Raises
|
|
------
|
|
HTTPException
|
|
Deleting the message failed.
|
|
Forbidden
|
|
Deleted a message that is not yours.
|
|
WebhookTokenMissing
|
|
There is no token associated with this webhook.
|
|
"""
|
|
if self.token is None:
|
|
raise WebhookTokenMissing("This webhook does not have a token associated with it")
|
|
|
|
adapter: WebhookAdapter = _get_webhook_adapter()
|
|
adapter.delete_webhook_message(
|
|
self.id,
|
|
self.token,
|
|
message_id,
|
|
session=self.session,
|
|
)
|