Skip to content

Commit

Permalink
Disable guild join (#597)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidhozic committed Sep 12, 2024
1 parent 491e3b7 commit 6dcc575
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ v4.1.0
information.
- Fixed SQL log removal through the GUI.
- Fixed CSV and JSON reading through remote.
- Disabled the :ref:`Automatic guild discovery and join` features due to the search provider shutting down its
services. It will be reenabled in a future version.



v4.0.5
=====================
- Fixed exe build.
Expand Down
6 changes: 6 additions & 0 deletions docs/source/guide/core/web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ If you restart DAF, it will not re-login, but will just load the data from the s

Automatic guild discovery and join
======================================

.. error::

This feature is currently **disabled** due to the search provider going down its
services. It will be reenabled in a future version.

The web layer beside login with username and password, also allows (semi) automatic guild discovery and join.

To use this feature, users need to create an :class:`~daf.guild.AutoGUILD` instance, where they pass the ``auto_join``
Expand Down
12 changes: 12 additions & 0 deletions src/daf/guild/autoguild.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ class AutoGUILD:
auto_join: Optional[web.GuildDISCOVERY] = None
.. versionadded:: v2.5
.. warning::
This is temporarily disabled until a new guild provider is found.
It will be reenabled in a future version.
Optional :class:`~daf.web.GuildDISCOVERY` object which will automatically discover
and join guilds though the browser.
This will open a Google Chrome session.
Expand Down Expand Up @@ -155,6 +159,14 @@ def __init__(
self._remove_after = remove_after
self._messages: List[MessageDuplicator] = []
self.logging = logging

if auto_join is not None: # TODO: remove in future after feature is reenabled.
auto_join = None
trace(
"Automatic join feature is currently disabled and will not work. It will be reenabled in a future version.",
TraceLEVELS.WARNING
)

self.auto_join = auto_join
self.parent = None
self.guild_query_iter = None
Expand Down
4 changes: 4 additions & 0 deletions src/daf/web.py
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,10 @@ def __init__(self, id: int, name: str, url: str) -> None:
@doc.doc_category("Web")
class GuildDISCOVERY:
"""
.. warning::
This is temporarily disabled (since v4.1) until a new guild provider is found.
Client used for searching servers.
To be used with :class:`daf.guild.AutoGUILD`.
Expand Down
1 change: 1 addition & 0 deletions src/daf_gui/tod_extensions/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ def register_extensions():
def register_deprecations():
register_deprecated(daf.AutoGUILD, "include_pattern", str)
register_deprecated(daf.AutoGUILD, "exclude_pattern")
register_deprecated(daf.AutoGUILD, "auto_join")

register_deprecated(daf.AutoCHANNEL, "include_pattern", str)
register_deprecated(daf.AutoCHANNEL, "exclude_pattern")
Expand Down

0 comments on commit 6dcc575

Please sign in to comment.