CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2026-05-27 17:16:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add redbot-setup restore cli command (#6709)

Browse Source
This commit is contained in:
Jakub Kuczys
2026-05-13 21:18:17 +02:00
committed by GitHub
parent edce32364f
commit a234fc1e02
4 changed files with 866 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
redbot/core/_downloader/__init__.py
+156
View File
@@ -12,6 +12,7 @@ from __future__ import annotations
import contextlib
import dataclasses
import json
import os
import shutil
import sys
@@ -37,6 +38,7 @@ import discord
from redbot.core import commands, Config, version_info as red_version_info
from redbot.core._cog_manager import CogManager
from redbot.core.data_manager import cog_data_path
from redbot.core.utils._internal_utils import detailed_progress
from . import errors
from .log import log
@@ -864,3 +866,157 @@ class CogUnavailableError(Exception):
self.repo_name = repo_name
self.cog_name = cog_name
super().__init__(f"Couldn't find cog {cog_name!r} in {repo_name!r}")
async def _restore_from_backup() -> None:
"""Restore cogs using `repos.json` in cog's data path.
Used by `redbot-setup restore` cli command.
"""
with _repo_manager.repos_folder.with_name("repos.json").open(encoding="utf-8") as fp:
raw_repos = json.load(fp)
with detailed_progress(unit="repos") as progress:
task_id = progress.add_task("Adding repos")
for repo_data in progress.track(raw_repos, task_id=task_id):
repo_url = repo_data["url"]
repo_name = repo_data["name"]
repo_branch = repo_data["branch"]
progress.update(task_id, description=f"Adding {repo_name!r} repo")
try:
await _repo_manager.add_repo(repo_url, repo_name, repo_branch)
except errors.ExistingGitRepo:
# this should not be possible
log.error(
"Failed to add repo %r (url: %r branch: %r) as it seems that"
" one with this name already exists.",
repo_name,
repo_url,
repo_branch,
)
except errors.AuthenticationError:
log.error(
"Failed to add repo %r (url: %r branch: %r) due to authentication failure."
" This may also mean that repository no longer exists at that URL.",
repo_name,
repo_url,
repo_branch,
)
except (errors.CloningError, OSError):
log.error(
"Failed to add repo %r (url: %r branch: %r) due to a cloning error.",
repo_name,
repo_url,
repo_branch,
)
_installed_cogs = await installed_cogs()
await _config.installed_cogs.clear()
await _config.installed_libraries.clear()
cogs_to_reinstall = []
cogs_without_repo: Dict[str, List[str]] = defaultdict(list)
for cog in _installed_cogs:
if cog.repo is None:
cogs_without_repo[cog._json_repo_name].append(cog.name)
else:
cogs_to_reinstall.append(cog)
for repo_name, cogs in cogs_without_repo.items():
log.error(
"The backup does not contain metadata about repo %r,"
" the following cogs cannot be reinstalled automatically: %s",
repo_name,
", ".join(cogs),
)
with detailed_progress(unit="cogs") as progress:
task_id = progress.add_task("Installing cogs")
cog: Installable
for cog in progress.track(cogs_to_reinstall, task_id=task_id):
progress.update(task_id, description=f"Installing {cog.name!r} cog")
if not cog.commit:
last_cog_occurrence = await cog.repo.get_last_module_occurrence(cog.name)
if last_cog_occurrence is not None and not last_cog_occurrence.disabled:
cog = last_cog_occurrence
log.warning(
"The commit that %r cog was installed from is unknown"
" - will try to reinstall from latest commit where it's still available."
)
else:
log.error(
"The commit that %r cog was installed from is unknown"
" and it could not be found in the repo."
)
continue
try:
install_result = await install_cogs(cog.repo, cog.commit, [cog.name])
except errors.UnknownRevision:
log.error(
"The commit that %r cog was installed from (%s)"
" could not be found in the repo.",
cog.name,
cog.commit,
)
continue
# we know we've only tried to install one cog so we can be specific in error messages
# below 3 should technically never happen with valid config but just in case...
if install_result.unavailable_cogs:
log.error("Could not find %r cog in %r repo", cog.name, cog.repo.name)
if install_result.already_installed:
log.error(
"Failed to reinstall %r cog from %r repo as it seems that"
" this cog is already installed.",
cog.name,
cog.repo.name,
)
if install_result.name_already_used:
log.error(
"Failed to reinstall %r cog from %r repo as it seems that"
" a cog with the same name is already installed from a different repo.",
cog.name,
cog.repo.name,
)
if install_result.incompatible_python_version:
log.error(
"Failed to reinstall %r cog from %r repo because the instance is"
" being restored into Red running with a lower Python version."
" The minimum Python version required by this cog is %s",
cog.name,
cog.repo.name,
".".join(map(str, cog.min_python_version)),
)
if install_result.incompatible_bot_version:
log.error(
"Failed to reinstall %r cog from %r repo because the instance is"
" being restored into a Red version that the cog does not support."
" The minimum version required by this cog is %s%s.",
cog.name,
cog.repo.name,
cog.min_bot_version,
(
""
if cog.min_bot_version > cog.max_bot_version
else f"and maximum allowed is: {cog.max_bot_version}"
),
)
if install_result.failed_cogs:
log.info("Failed to reinstall %r cog", cog.name)
if install_result.failed_reqs:
log.error(
"Failed to reinstall %r cog from %r repo"
" because the following requirements could not be reinstalled: %s",
cog.name,
cog.repo.name,
", ".join(install_result.failed_reqs),
)
if install_result.failed_libs:
log.error(
"Failed to reinstall shared libraries for %r cog from %r repo: %s",
cog.repo.name,
", ".join([lib.name for lib in install_result.failed_libs]),
)