Merge branch 'master' into 'master'

Added a link/button on the TS page that will show/hide instructions if the...

See merge request allianceauth/allianceauth!1618

allianceauth/framework/staticfiles/storage.py

@@ -0,0 +1,105 @@
+"""
+Custom static files storage for Alliance Auth.
+
+This module defines a custom static files storage class for
+Alliance Auth, named `AaManifestStaticFilesStorage`.
+
+Using `ManifestStaticFilesStorage` will give us a hashed name for
+our static files, which is useful for cache busting.
+
+This storage class extends Django's `ManifestStaticFilesStorage` to ignore missing files,
+which the original class does not handle, and log them in debug mode.
+It is useful for handling cases where static files may not exist, such as when a
+CSS file references a background image that is not present in the static files directory.
+
+With debug mode enabled, it will print a message for each missing file when running `collectstatic`,
+which can help identify issues with static file references during development.
+"""
+
+from django.conf import settings
+from django.contrib.staticfiles.storage import ManifestStaticFilesStorage
+
+
+class AaManifestStaticFilesStorage(ManifestStaticFilesStorage):
+    """
+    Custom static files storage that ignores missing files.
+    """
+
+    @classmethod
+    def _cleanup_name(cls, name: str) -> str:
+        """
+        Clean up the name by removing quotes.
+        This method is used to ensure that the name does not contain any quotes,
+        which can cause issues with file paths.
+
+        :param name: The name of the static file.
+        :type name: str
+        :return: The cleaned-up name without quotes.
+        :rtype: str
+        """
+
+        # Remove quotes from the name
+        return name.replace('"', "").replace("'", "")
+
+    def __init__(self, *args, **kwargs):
+        """
+        Initialize the static files storage, ignoring missing files.
+
+        :param args:
+        :type args:
+        :param kwargs:
+        :type kwargs:
+        """
+
+        self.missing_files = []
+
+        super().__init__(*args, **kwargs)
+
+    def hashed_name(self, name, content=None, filename=None):
+        """
+        Generate a hashed name for the given static file, ignoring missing files.
+
+        Ignore missing files, e.g. non-existent background image referenced from css.
+        Returns the original filename if the referenced file doesn't exist.
+
+        :param name: The name of the static file to hash.
+        :type name: str
+        :param content: The content of the static file, if available.
+        :type content: bytes | None
+        :param filename: The original filename of the static file, if available.
+        :type filename: str | None
+        :return: The hashed name of the static file, or the original name if the file is missing.
+        :rtype: str
+        """
+
+        try:
+            clean_name = self._cleanup_name(name)
+
+            return super().hashed_name(clean_name, content, filename)
+        except ValueError as e:
+            if settings.DEBUG:
+                # In debug mode, we log the missing file message
+                message = e.args[0].split(" with ")[0]
+                self.missing_files.append(message)
+                # print(f'\x1b[0;30;41m{message}\x1b[0m')
+
+            return name
+
+    def post_process(self, *args, **kwargs):
+        """
+        Post-process the static files, printing any missing files in debug mode.
+
+        :param args:
+        :type args:
+        :param kwargs:
+        :type kwargs:
+        :return:
+        :rtype:
+        """
+
+        yield from super().post_process(*args, **kwargs)
+
+        if settings.DEBUG:
+            # In debug mode, print the missing files
+            for message in sorted(set(self.missing_files)):
+                print(f"\x1b[0;30;41m{message}\x1b[0m")

allianceauth/project_template/project_name/settings/base.py

@@ -15,68 +15,68 @@ from django.contrib import messages
 from django.utils.translation import gettext_lazy as _
 
 INSTALLED_APPS = [
-    'allianceauth',  # needs to be on top of this list to support favicons in Django admin (see https://gitlab.com/allianceauth/allianceauth/-/issues/1301)
+    "allianceauth",  # needs to be on top of this list to support favicons in Django admin (see https://gitlab.com/allianceauth/allianceauth/-/issues/1301)
-    'django.contrib.admin',
+    "django.contrib.admin",
-    'django.contrib.auth',
+    "django.contrib.auth",
-    'django.contrib.contenttypes',
+    "django.contrib.contenttypes",
-    'django.contrib.sessions',
+    "django.contrib.sessions",
-    'django.contrib.messages',
+    "django.contrib.messages",
-    'django.contrib.staticfiles',
+    "django.contrib.staticfiles",
-    'django.contrib.humanize',
+    "django.contrib.humanize",
-    'django_celery_beat',
+    "django_celery_beat",
-    'solo',
+    "solo",
-    'bootstrapform',
+    "bootstrapform",
-    'django_bootstrap5',  # https://github.com/zostera/django-bootstrap5
+    "django_bootstrap5",  # https://github.com/zostera/django-bootstrap5
-    'sortedm2m',
+    "sortedm2m",
-    'esi',
+    "esi",
-    'allianceauth.framework',
+    "allianceauth.framework",
-    'allianceauth.authentication',
+    "allianceauth.authentication",
-    'allianceauth.services',
+    "allianceauth.services",
-    'allianceauth.eveonline',
+    "allianceauth.eveonline",
-    'allianceauth.groupmanagement',
+    "allianceauth.groupmanagement",
-    'allianceauth.notifications',
+    "allianceauth.notifications",
-    'allianceauth.thirdparty.navhelper',
+    "allianceauth.thirdparty.navhelper",
-    'allianceauth.analytics',
+    "allianceauth.analytics",
-    'allianceauth.menu',
+    "allianceauth.menu",
-    'allianceauth.theme',
+    "allianceauth.theme",
-    'allianceauth.theme.darkly',
+    "allianceauth.theme.darkly",
-    'allianceauth.theme.flatly',
+    "allianceauth.theme.flatly",
-    'allianceauth.theme.materia',
+    "allianceauth.theme.materia",
     "allianceauth.custom_css",
-    'allianceauth.crontab',
+    "allianceauth.crontab",
-    'sri',
+    "sri",
 ]
 
 SRI_ALGORITHM = "sha512"
 SECRET_KEY = "wow I'm a really bad default secret key"
 
 # Celery configuration
-BROKER_URL = 'redis://localhost:6379/0'
+BROKER_URL = "redis://localhost:6379/0"
 CELERYBEAT_SCHEDULER = "allianceauth.crontab.schedulers.OffsetDatabaseScheduler"
 CELERYBEAT_SCHEDULE = {
-    'esi_cleanup_callbackredirect': {
+    "esi_cleanup_callbackredirect": {
-        'task': 'esi.tasks.cleanup_callbackredirect',
+        "task": "esi.tasks.cleanup_callbackredirect",
-        'schedule': crontab(minute='0', hour='*/4'),
+        "schedule": crontab(minute="0", hour="*/4"),
     },
-    'esi_cleanup_token': {
+    "esi_cleanup_token": {
-        'task': 'esi.tasks.cleanup_token',
+        "task": "esi.tasks.cleanup_token",
-        'schedule': crontab(minute='0', hour='0'),
+        "schedule": crontab(minute="0", hour="0"),
-        'apply_offset': True,
+        "apply_offset": True,
     },
-    'run_model_update': {
+    "run_model_update": {
-        'task': 'allianceauth.eveonline.tasks.run_model_update',
+        "task": "allianceauth.eveonline.tasks.run_model_update",
-        'schedule': crontab(minute='0', hour="*/6"),
+        "schedule": crontab(minute="0", hour="*/6"),
-        'apply_offset': True
+        "apply_offset": True,
     },
-    'check_all_character_ownership': {
+    "check_all_character_ownership": {
-        'task': 'allianceauth.authentication.tasks.check_all_character_ownership',
+        "task": "allianceauth.authentication.tasks.check_all_character_ownership",
-        'schedule': crontab(minute='0', hour='*/4'),
+        "schedule": crontab(minute="0", hour="*/4"),
-        'apply_offset': True
+        "apply_offset": True,
+    },
+    "analytics_daily_stats": {
+        "task": "allianceauth.analytics.tasks.analytics_daily_stats",
+        "schedule": crontab(minute="0", hour="2"),
     },
-    'analytics_daily_stats': {
-        'task': 'allianceauth.analytics.tasks.analytics_daily_stats',
-        'schedule': crontab(minute='0', hour='2'),
-    }
 }
 
 
@@ -85,22 +85,20 @@ PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 BASE_DIR = os.path.dirname(PROJECT_DIR)
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
+    "django.middleware.security.SecurityMiddleware",
-    'django.contrib.sessions.middleware.SessionMiddleware',
+    "django.contrib.sessions.middleware.SessionMiddleware",
-    'allianceauth.authentication.middleware.UserSettingsMiddleware',
+    "allianceauth.authentication.middleware.UserSettingsMiddleware",
-    'django.middleware.locale.LocaleMiddleware',
+    "django.middleware.locale.LocaleMiddleware",
-    'django.middleware.common.CommonMiddleware',
+    "django.middleware.common.CommonMiddleware",
-    'django.middleware.csrf.CsrfViewMiddleware',
+    "django.middleware.csrf.CsrfViewMiddleware",
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
-    'django.contrib.messages.middleware.MessageMiddleware',
+    "django.contrib.messages.middleware.MessageMiddleware",
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = 'allianceauth.urls'
+ROOT_URLCONF = "allianceauth.urls"
 
-LOCALE_PATHS = (
+LOCALE_PATHS = (os.path.join(BASE_DIR, "locale/"),)
-    os.path.join(BASE_DIR, 'locale/'),
-)
 
 LANGUAGES = (  # Sorted by Language Code alphabetical order + English at top
     ("en", _("English")),
@@ -160,58 +158,58 @@ LANGUAGE_MAPPING = {
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
-        'DIRS': [os.path.join(PROJECT_DIR, 'templates')],
+        "DIRS": [os.path.join(PROJECT_DIR, "templates")],
-        'APP_DIRS': True,
+        "APP_DIRS": True,
-        'OPTIONS': {
+        "OPTIONS": {
-            'context_processors': [
+            "context_processors": [
-                'django.template.context_processors.debug',
+                "django.template.context_processors.debug",
-                'django.template.context_processors.request',
+                "django.template.context_processors.request",
-                'django.contrib.auth.context_processors.auth',
+                "django.contrib.auth.context_processors.auth",
-                'django.contrib.messages.context_processors.messages',
+                "django.contrib.messages.context_processors.messages",
-                'django.template.context_processors.i18n',
+                "django.template.context_processors.i18n",
-                'django.template.context_processors.media',
+                "django.template.context_processors.media",
-                'django.template.context_processors.static',
+                "django.template.context_processors.static",
-                'django.template.context_processors.tz',
+                "django.template.context_processors.tz",
-                'allianceauth.context_processors.auth_settings',
+                "allianceauth.context_processors.auth_settings",
             ],
         },
     },
 ]
 
-WSGI_APPLICATION = 'allianceauth.wsgi.application'
+WSGI_APPLICATION = "allianceauth.wsgi.application"
 
 # Password validation
 # https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
     },
 ]
 
 AUTHENTICATION_BACKENDS = [
-    'allianceauth.authentication.backends.StateBackend',
+    "allianceauth.authentication.backends.StateBackend",
-    'django.contrib.auth.backends.ModelBackend'
+    "django.contrib.auth.backends.ModelBackend",
 ]
 
 # Internationalization
 # https://docs.djangoproject.com/en/1.10/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
 LANGUAGE_COOKIE_AGE = 1209600
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
@@ -219,44 +217,51 @@ USE_TZ = True
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/1.10/howto/static-files/
-STATIC_URL = '/static/'
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "allianceauth.framework.staticfiles.storage.AaManifestStaticFilesStorage",
+    },
+}
+
+STATIC_URL = "/static/"
 STATICFILES_DIRS = [
-    os.path.join(PROJECT_DIR, 'static'),
+    os.path.join(PROJECT_DIR, "static"),
 ]
-STATIC_ROOT = os.path.join(BASE_DIR, 'static')
+STATIC_ROOT = os.path.join(BASE_DIR, "static")
 
 # Bootstrap messaging css workaround
-MESSAGE_TAGS = {
+MESSAGE_TAGS = {messages.ERROR: "danger error"}
-    messages.ERROR: 'danger error'
-}
 
 CACHES = {
     "default": {
         "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": "redis://127.0.0.1:6379/1"  # change the 1 here for the DB used
+        "LOCATION": "redis://127.0.0.1:6379/1",  # change the 1 here for the DB used
     }
 }
 
 SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"
 
 DEBUG = True
-ALLOWED_HOSTS = ['*']
+ALLOWED_HOSTS = ["*"]
 DATABASES = {
-    'default': {
+    "default": {
-        'ENGINE': 'django.db.backends.sqlite3',
+        "ENGINE": "django.db.backends.sqlite3",
-        'NAME': str(os.path.join(BASE_DIR, 'alliance_auth.sqlite3')),
+        "NAME": str(os.path.join(BASE_DIR, "alliance_auth.sqlite3")),
     },
 }
 
-SITE_NAME = 'Alliance Auth'
+SITE_NAME = "Alliance Auth"
 
 DEFAULT_THEME = "allianceauth.theme.flatly.auth_hooks.FlatlyThemeHook"
 DEFAULT_THEME_DARK = "allianceauth.theme.darkly.auth_hooks.DarklyThemeHook"  # Legacy AAv3 user.profile.night_mode=1
 
-LOGIN_URL = 'auth_login_user'  # view that handles login logic
+LOGIN_URL = "auth_login_user"  # view that handles login logic
 
-LOGIN_REDIRECT_URL = 'authentication:dashboard'  # default destination when logging in if no redirect specified
+LOGIN_REDIRECT_URL = "authentication:dashboard"  # default destination when logging in if no redirect specified
-LOGOUT_REDIRECT_URL = 'authentication:dashboard'  # destination after logging out
+LOGOUT_REDIRECT_URL = "authentication:dashboard"  # destination after logging out
 # Both of these redirects accept values as per the django redirect shortcut
 # https://docs.djangoproject.com/en/1.11/topics/http/shortcuts/#redirect
 # - url names eg 'authentication:dashboard'
@@ -264,73 +269,71 @@ LOGOUT_REDIRECT_URL = 'authentication:dashboard'  # destination after logging ou
 # - absolute urls eg 'http://example.com/dashboard'
 
 # scopes required on new tokens when logging in. Cannot be blank.
-LOGIN_TOKEN_SCOPES = ['publicData']
+LOGIN_TOKEN_SCOPES = ["publicData"]
 
 EMAIL_TIMEOUT = 15
 
 # number of days email verification links are valid for
 ACCOUNT_ACTIVATION_DAYS = 1
 
-ESI_API_URL = 'https://esi.evetech.net/'
+ESI_API_URL = "https://esi.evetech.net/"
 
 LOGGING = {
-    'version': 1,
+    "version": 1,
-    'disable_existing_loggers': False,
+    "disable_existing_loggers": False,
-    'formatters': {
+    "formatters": {
-        'verbose': {
+        "verbose": {
-            'format': "[%(asctime)s] %(levelname)s [%(name)s:%(lineno)s] %(message)s",
+            "format": "[%(asctime)s] %(levelname)s [%(name)s:%(lineno)s] %(message)s",
-            'datefmt': "%d/%b/%Y %H:%M:%S"
+            "datefmt": "%d/%b/%Y %H:%M:%S",
         },
-        'simple': {
+        "simple": {"format": "%(levelname)s %(message)s"},
-            'format': '%(levelname)s %(message)s'
+    },
+    "handlers": {
+        "log_file": {
+            "level": "INFO",  # edit this line to change logging level to file
+            "class": "logging.handlers.RotatingFileHandler",
+            "filename": os.path.join(BASE_DIR, "log/allianceauth.log"),
+            "formatter": "verbose",
+            "maxBytes": 1024 * 1024 * 5,  # edit this line to change max log file size
+            "backupCount": 5,  # edit this line to change number of log backups
+        },
+        "extension_file": {
+            "level": "INFO",
+            "class": "logging.handlers.RotatingFileHandler",
+            "filename": os.path.join(BASE_DIR, "log/extensions.log"),
+            "formatter": "verbose",
+            "maxBytes": 1024 * 1024 * 5,  # edit this line to change max log file size
+            "backupCount": 5,  # edit this line to change number of log backups
+        },
+        "console": {
+            "level": "DEBUG",  # edit this line to change logging level to console
+            "class": "logging.StreamHandler",
+            "formatter": "verbose",
+        },
+        "notifications": {  # creates notifications for users with logging_notifications permission
+            "level": "ERROR",  # edit this line to change logging level to notifications
+            "class": "allianceauth.notifications.handlers.NotificationHandler",
+            "formatter": "verbose",
         },
     },
-    'handlers': {
+    "loggers": {
-        'log_file': {
+        "allianceauth": {
-            'level': 'INFO',  # edit this line to change logging level to file
+            "handlers": ["log_file", "console", "notifications"],
-            'class': 'logging.handlers.RotatingFileHandler',
+            "level": "DEBUG",
-            'filename': os.path.join(BASE_DIR, 'log/allianceauth.log'),
-            'formatter': 'verbose',
-            'maxBytes': 1024 * 1024 * 5,  # edit this line to change max log file size
-            'backupCount': 5,  # edit this line to change number of log backups
         },
-        'extension_file': {
+        "extensions": {
-            'level': 'INFO',
+            "handlers": ["extension_file", "console"],
-            'class': 'logging.handlers.RotatingFileHandler',
+            "level": "DEBUG",
-            'filename': os.path.join(BASE_DIR, 'log/extensions.log'),
-            'formatter': 'verbose',
-            'maxBytes': 1024 * 1024 * 5,  # edit this line to change max log file size
-            'backupCount': 5,  # edit this line to change number of log backups
         },
-        'console': {
+        "django": {
-            'level': 'DEBUG',  # edit this line to change logging level to console
+            "handlers": ["log_file", "console"],
-            'class': 'logging.StreamHandler',
+            "level": "ERROR",
-            'formatter': 'verbose',
         },
-        'notifications': {  # creates notifications for users with logging_notifications permission
+        "esi": {
-            'level': 'ERROR',  # edit this line to change logging level to notifications
+            "handlers": ["log_file", "console"],
-            'class': 'allianceauth.notifications.handlers.NotificationHandler',
+            "level": "DEBUG",
-            'formatter': 'verbose',
         },
     },
-    'loggers': {
-        'allianceauth': {
-            'handlers': ['log_file', 'console', 'notifications'],
-            'level': 'DEBUG',
-        },
-        'extensions': {
-            'handlers': ['extension_file', 'console'],
-            'level': 'DEBUG',
-        },
-        'django': {
-            'handlers': ['log_file', 'console'],
-            'level': 'ERROR',
-        },
-        'esi': {
-            'handlers': ['log_file', 'console'],
-            'level': 'DEBUG',
-        },
-    }
 }
 
 DEFAULT_AUTO_FIELD = "django.db.models.AutoField"

allianceauth/services/modules/teamspeak3/templates/services/teamspeak3/teamspeakjoin.html

@@ -14,6 +14,25 @@
             <div class="col-md-4">
                 <a href="ts3server://{{ public_url }}?token={{ authinfo.teamspeak3_perm_key }}&nickname={{ authinfo.teamspeak3_uid }}" class="btn btn-primary btn-block btn-lg" title="Join">{% translate "Join Server" %}</a>
                 <br>
+                <div class="bg-body-tertiary text-center">
+                    <a href="#" onclick="document.getElementById('tokenDiv').classList.toggle('hidden');">{% translate "Join button not working, click here?" %}</a>
+                </div>
+                <div class="hidden text-center" id="tokenDiv">
+                    <p>
+                        {% translate "TS3:"%} <br/>
+                        {% translate "Connect to "%}{{ public_url }} <br/>
+                        {% translate "Click the Permissions in the top toolbar"%} <br/>
+                        {% translate "Select Use Privilege Key"%} <br/>
+                        {% translate "Enter "%}{{ authinfo.teamspeak3_perm_key }}
+                    </p>
+                    <p>
+                        {% translate "TS5: "%} <br/>
+                        {% translate "Connect to "%}{{ public_url }} <br/>
+                        {% translate "Right click the server"%} <br/>
+                        {% translate "Select Use Privilege Key"%} <br/>
+                        {% translate "Enter "%}{{ authinfo.teamspeak3_perm_key }}
+                    </p>
+                </div>
                 <form class="form-signin" role="form" action="{% url 'teamspeak3:verify' %}" method="POST">
                     {% csrf_token %}