forked from rommapp/romm
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__init__.py
More file actions
298 lines (254 loc) · 10.7 KB
/
Copy path__init__.py
File metadata and controls
298 lines (254 loc) · 10.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
import os
from typing import Final, overload
import yarl
from dotenv import load_dotenv
from utils.database import safe_int, safe_str_to_bool
load_dotenv()
# Supplying a string literal for fallback guarantees a `str` result
@overload
def _get_env(var: str, fallback: str) -> str: ...
@overload
def _get_env(var: str, fallback: None = None) -> str | None: ...
def _get_env(var: str, fallback: str | None = None) -> str | None:
val = os.environ.get(var) or fallback
return val.strip() if val else val
ROMM_BASE_URL: Final[str] = _get_env("ROMM_BASE_URL", "http://0.0.0.0")
ROMM_PORT: Final[int] = safe_int(_get_env("ROMM_PORT"), 8080)
# GUNICORN
DEV_MODE: Final[bool] = safe_str_to_bool(_get_env("DEV_MODE"))
DEV_HOST: Final[str] = _get_env("DEV_HOST", "127.0.0.1")
DEV_PORT: Final[int] = safe_int(_get_env("DEV_PORT"), 5000)
DEV_SQL_ECHO: Final[bool] = safe_str_to_bool(_get_env("DEV_SQL_ECHO"))
# PATHS
ROMM_BASE_PATH: Final[str] = _get_env("ROMM_BASE_PATH", "/romm")
ROMM_TMP_PATH: Final[str | None] = _get_env("ROMM_TMP_PATH")
LIBRARY_BASE_PATH: Final[str] = f"{ROMM_BASE_PATH}/library"
RESOURCES_BASE_PATH: Final[str] = f"{ROMM_BASE_PATH}/resources"
ASSETS_BASE_PATH: Final[str] = f"{ROMM_BASE_PATH}/assets"
FRONTEND_RESOURCES_PATH: Final[str] = "/assets/romm/resources"
# SEVEN ZIP
SEVEN_ZIP_TIMEOUT: Final[int] = safe_int(_get_env("SEVEN_ZIP_TIMEOUT"), 60)
# ROM PATCHER
ROM_PATCHER_TIMEOUT: Final[int] = safe_int(_get_env("ROM_PATCHER_TIMEOUT"), 120)
# RomPatcher.js loads the whole ROM into memory in Node, so cap inputs to avoid OOM.
ROM_PATCHER_MAX_FILE_SIZE_BYTES: Final[int] = safe_int(
_get_env("ROM_PATCHER_MAX_FILE_SIZE_BYTES"), 4 * 1024 * 1024 * 1024 # 4 GiB
)
# Limit concurrent patch subprocesses to bound total memory use.
ROM_PATCHER_MAX_CONCURRENCY: Final[int] = max(
1, safe_int(_get_env("ROM_PATCHER_MAX_CONCURRENCY"), 2)
)
# DATABASE
DB_HOST: Final[str | None] = _get_env("DB_HOST")
DB_PORT: Final[int] = safe_int(_get_env("DB_PORT"), 3306)
DB_USER: Final[str | None] = _get_env("DB_USER")
DB_PASSWD: Final[str | None] = _get_env("DB_PASSWD")
DB_NAME: Final[str] = _get_env("DB_NAME", "romm")
DB_QUERY_JSON: Final[str | None] = _get_env("DB_QUERY_JSON")
ROMM_DB_DRIVER: Final[str] = _get_env("ROMM_DB_DRIVER", "mariadb")
# REDIS
REDIS_HOST: Final[str | None] = _get_env("REDIS_HOST")
REDIS_PORT: Final[int] = safe_int(_get_env("REDIS_PORT"), 6379)
REDIS_PASSWORD: Final[str | None] = _get_env("REDIS_PASSWORD")
REDIS_USERNAME: Final[str | None] = _get_env("REDIS_USERNAME")
REDIS_DB: Final[int] = safe_int(_get_env("REDIS_DB"), 0)
REDIS_SSL: Final[bool] = safe_str_to_bool(_get_env("REDIS_SSL"))
REDIS_URL: Final[str] = str(
yarl.URL.build(
scheme="rediss" if REDIS_SSL else "redis",
user=REDIS_USERNAME or None,
password=REDIS_PASSWORD or None,
host=REDIS_HOST or "127.0.0.1",
port=REDIS_PORT,
path=f"/{REDIS_DB}",
)
)
# IGDB
IGDB_CLIENT_ID: Final[str | None] = _get_env("IGDB_CLIENT_ID")
IGDB_CLIENT_SECRET: Final[str | None] = _get_env("IGDB_CLIENT_SECRET")
# MOBYGAMES
MOBYGAMES_API_KEY: Final[str | None] = _get_env("MOBYGAMES_API_KEY")
# SCREENSCRAPER
SCREENSCRAPER_USER: Final[str | None] = _get_env("SCREENSCRAPER_USER")
SCREENSCRAPER_PASSWORD: Final[str | None] = _get_env("SCREENSCRAPER_PASSWORD")
# Developer credentials, injected at build time.
SCREENSCRAPER_DEV_ID: Final[str | None] = _get_env("SCREENSCRAPER_DEV_ID")
SCREENSCRAPER_DEV_PASSWORD: Final[str | None] = _get_env("SCREENSCRAPER_DEV_PASSWORD")
# STEAMGRIDDB
STEAMGRIDDB_API_KEY: Final[str | None] = _get_env("STEAMGRIDDB_API_KEY")
# RETROACHIEVEMENTS
RETROACHIEVEMENTS_API_KEY: Final[str | None] = _get_env("RETROACHIEVEMENTS_API_KEY")
REFRESH_RETROACHIEVEMENTS_CACHE_DAYS: Final[int] = safe_int(
_get_env("REFRESH_RETROACHIEVEMENTS_CACHE_DAYS"), 30
)
# LAUNCHBOX
LAUNCHBOX_BASE_PATH: Final[str] = f"{ROMM_BASE_PATH}/launchbox"
LAUNCHBOX_API_ENABLED: Final[bool] = safe_str_to_bool(_get_env("LAUNCHBOX_API_ENABLED"))
# PLAYMATCH
PLAYMATCH_API_ENABLED: Final[bool] = safe_str_to_bool(_get_env("PLAYMATCH_API_ENABLED"))
# HASHEOUS
HASHEOUS_API_ENABLED: Final[bool] = safe_str_to_bool(_get_env("HASHEOUS_API_ENABLED"))
# THEGAMESDB
TGDB_API_ENABLED: Final[bool] = safe_str_to_bool(_get_env("TGDB_API_ENABLED"))
# FLASHPOINT
FLASHPOINT_API_ENABLED: Final[bool] = safe_str_to_bool(
_get_env("FLASHPOINT_API_ENABLED")
)
# HOWLONGTOBEAT
HLTB_API_ENABLED: Final[bool] = safe_str_to_bool(_get_env("HLTB_API_ENABLED"))
# AUTH
ROMM_AUTH_SECRET_KEY: Final[str] = _get_env("ROMM_AUTH_SECRET_KEY", "")
if not ROMM_AUTH_SECRET_KEY:
raise ValueError("ROMM_AUTH_SECRET_KEY environment variable is not set!")
OAUTH_ACCESS_TOKEN_EXPIRE_SECONDS: Final[int] = safe_int(
_get_env("OAUTH_ACCESS_TOKEN_EXPIRE_SECONDS"), 30 * 60
) # 30 minutes, in seconds
OAUTH_REFRESH_TOKEN_EXPIRE_SECONDS: Final[int] = safe_int(
_get_env("OAUTH_REFRESH_TOKEN_EXPIRE_SECONDS"), 7 * 24 * 60 * 60
) # 7 days, in seconds
SESSION_MAX_AGE_SECONDS: Final[int] = safe_int(
_get_env("SESSION_MAX_AGE_SECONDS"), 14 * 24 * 60 * 60
) # 14 days, in seconds
DISABLE_CSRF_PROTECTION: Final[bool] = safe_str_to_bool(
_get_env("DISABLE_CSRF_PROTECTION")
)
DISABLE_DOWNLOAD_ENDPOINT_AUTH: Final[bool] = safe_str_to_bool(
_get_env("DISABLE_DOWNLOAD_ENDPOINT_AUTH")
)
DISABLE_USERPASS_LOGIN: Final[bool] = safe_str_to_bool(
_get_env("DISABLE_USERPASS_LOGIN")
)
DISABLE_SETUP_WIZARD: Final[bool] = safe_str_to_bool(_get_env("DISABLE_SETUP_WIZARD"))
INVITE_TOKEN_EXPIRY_SECONDS: Final[int] = safe_int(
_get_env("INVITE_TOKEN_EXPIRY_SECONDS"), 10 * 60
)
# OIDC
OIDC_ENABLED: Final[bool] = safe_str_to_bool(_get_env("OIDC_ENABLED"))
OIDC_AUTOLOGIN: Final[bool] = safe_str_to_bool(_get_env("OIDC_AUTOLOGIN"))
OIDC_ALLOW_REGISTRATION: Final[bool] = safe_str_to_bool(
_get_env("OIDC_ALLOW_REGISTRATION", "true")
)
OIDC_PROVIDER: Final[str] = _get_env("OIDC_PROVIDER", "")
OIDC_CLIENT_ID: Final[str] = _get_env("OIDC_CLIENT_ID", "")
OIDC_CLIENT_SECRET: Final[str] = _get_env("OIDC_CLIENT_SECRET", "")
OIDC_REDIRECT_URI: Final[str] = _get_env("OIDC_REDIRECT_URI", "")
OIDC_SERVER_APPLICATION_URL: Final[str] = _get_env("OIDC_SERVER_APPLICATION_URL", "")
OIDC_SERVER_METADATA_URL: Final[str | None] = _get_env("OIDC_SERVER_METADATA_URL")
OIDC_CLAIM_ROLES: Final[str] = _get_env("OIDC_CLAIM_ROLES", "")
OIDC_ROLE_VIEWER: Final[str | None] = _get_env("OIDC_ROLE_VIEWER")
OIDC_ROLE_EDITOR: Final[str | None] = _get_env("OIDC_ROLE_EDITOR")
OIDC_ROLE_ADMIN: Final[str | None] = _get_env("OIDC_ROLE_ADMIN")
OIDC_TLS_CACERTFILE: Final[str | None] = _get_env("OIDC_TLS_CACERTFILE")
OIDC_USERNAME_ATTRIBUTE: Final[str] = _get_env(
"OIDC_USERNAME_ATTRIBUTE", "preferred_username"
)
OIDC_RP_INITIATED_LOGOUT: Final[bool] = safe_str_to_bool(
_get_env("OIDC_RP_INITIATED_LOGOUT")
)
OIDC_END_SESSION_ENDPOINT: Final[str] = _get_env("OIDC_END_SESSION_ENDPOINT", "")
# SCANS
SCAN_TIMEOUT: Final[int] = safe_int(_get_env("SCAN_TIMEOUT"), 60 * 60 * 4) # 4 hours
SCAN_WORKERS: Final[int] = max(1, safe_int(_get_env("SCAN_WORKERS"), 1))
# TASKS
TASK_TIMEOUT: Final[int] = safe_int(_get_env("TASK_TIMEOUT"), 60 * 5) # 5 minutes
TASK_RESULT_TTL: Final[int] = safe_int(
_get_env("TASK_RESULT_TTL"), 24 * 60 * 60
) # 24 hours
ENABLE_RESCAN_ON_FILESYSTEM_CHANGE: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_RESCAN_ON_FILESYSTEM_CHANGE")
)
RESCAN_ON_FILESYSTEM_CHANGE_DELAY: Final[int] = safe_int(
_get_env("RESCAN_ON_FILESYSTEM_CHANGE_DELAY"),
5, # 5 minutes
)
ENABLE_SCHEDULED_RESCAN: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_SCHEDULED_RESCAN")
)
SCHEDULED_RESCAN_CRON: Final[str] = _get_env(
"SCHEDULED_RESCAN_CRON",
"0 3 * * *", # At 3:00 AM every day
)
ENABLE_SCHEDULED_UPDATE_SWITCH_TITLEDB: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_SCHEDULED_UPDATE_SWITCH_TITLEDB")
)
SCHEDULED_UPDATE_SWITCH_TITLEDB_CRON: Final[str] = _get_env(
"SCHEDULED_UPDATE_SWITCH_TITLEDB_CRON",
"0 4 * * *", # At 4:00 AM every day
)
ENABLE_SCHEDULED_UPDATE_LAUNCHBOX_METADATA: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_SCHEDULED_UPDATE_LAUNCHBOX_METADATA")
)
SCHEDULED_UPDATE_LAUNCHBOX_METADATA_CRON: Final[str] = _get_env(
"SCHEDULED_UPDATE_LAUNCHBOX_METADATA_CRON",
"0 4 * * *", # At 4:00 AM every day
)
ENABLE_SCHEDULED_CONVERT_IMAGES_TO_WEBP: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_SCHEDULED_CONVERT_IMAGES_TO_WEBP")
)
SCHEDULED_CONVERT_IMAGES_TO_WEBP_CRON: Final[str] = _get_env(
"SCHEDULED_CONVERT_IMAGES_TO_WEBP_CRON",
"0 4 * * *", # At 4:00 AM every day
)
ENABLE_SCHEDULED_RETROACHIEVEMENTS_PROGRESS_SYNC: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_SCHEDULED_RETROACHIEVEMENTS_PROGRESS_SYNC")
)
SCHEDULED_RETROACHIEVEMENTS_PROGRESS_SYNC_CRON: Final[str] = _get_env(
"SCHEDULED_RETROACHIEVEMENTS_PROGRESS_SYNC_CRON",
"0 4 * * *", # At 4:00 AM every day
)
# SYNC
SYNC_BASE_PATH: Final[str] = f"{ROMM_BASE_PATH}/sync"
ENABLE_SYNC_FOLDER_WATCHER: Final[bool] = safe_str_to_bool(
_get_env("ENABLE_SYNC_FOLDER_WATCHER")
)
SYNC_FOLDER_SCAN_DELAY: Final[int] = safe_int(
_get_env("SYNC_FOLDER_SCAN_DELAY"), 2 # 2 minutes
)
ENABLE_SYNC_PUSH_PULL: Final[bool] = safe_str_to_bool(_get_env("ENABLE_SYNC_PUSH_PULL"))
SYNC_PUSH_PULL_CRON: Final[str] = _get_env(
"SYNC_PUSH_PULL_CRON",
"*/30 * * * *", # Every 30 minutes
)
SYNC_SSH_KEYS_PATH: Final[str] = _get_env(
"SYNC_SSH_KEYS_PATH", f"{SYNC_BASE_PATH}/keys"
)
SYNC_SSH_KNOWN_HOSTS_PATH: Final[str] = _get_env(
"SYNC_SSH_KNOWN_HOSTS_PATH", f"{SYNC_BASE_PATH}/known_hosts"
)
# EMULATION
DISABLE_EMULATOR_JS: Final[bool] = safe_str_to_bool(_get_env("DISABLE_EMULATOR_JS"))
DISABLE_RUFFLE_RS: Final[bool] = safe_str_to_bool(_get_env("DISABLE_RUFFLE_RS"))
# FRONTEND
KIOSK_MODE: Final[bool] = safe_str_to_bool(_get_env("KIOSK_MODE"))
DISABLE_LOGS_VIEWER: Final[bool] = safe_str_to_bool(_get_env("DISABLE_LOGS_VIEWER"))
# LOGGING
LOGLEVEL: Final[str] = _get_env("LOGLEVEL", "INFO").upper()
FORCE_COLOR: Final[bool] = safe_str_to_bool(_get_env("FORCE_COLOR"))
NO_COLOR: Final[bool] = safe_str_to_bool(_get_env("NO_COLOR"))
# YOUTUBE
YOUTUBE_BASE_URL: Final[str] = _get_env(
"YOUTUBE_BASE_URL", "https://www.youtube.com"
).rstrip("/")
# TINFOIL
TINFOIL_WELCOME_MESSAGE: Final[str] = _get_env(
"TINFOIL_WELCOME_MESSAGE", "RomM Switch Library"
)
# EMULATOR STREAMING
STREAMING_BROKER_SECRET: Final[str] = _get_env("STREAMING_BROKER_SECRET", "")
STREAMING_SAVE_TIMEOUT: Final[int] = safe_int(
_get_env("STREAMING_SAVE_TIMEOUT"), 45
) # 45 seconds
# SENTRY
SENTRY_DSN: Final[str | None] = _get_env("SENTRY_DSN")
# TESTING
IS_PYTEST_RUN: Final = bool(_get_env("PYTEST_VERSION"))
# PROXY
def has_proxy_env() -> bool:
return any(
_get_env(var)
for var in (
"HTTP_PROXY",
"HTTPS_PROXY",
"NO_PROXY",
)
)