tutor 23.0.0.dev3185__tar.gz → 23.0.0.dev3188__tar.gz

{tutor-23.0.0.dev3185 → tutor-23.0.0.dev3188}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tutor
-Version: 23.0.0.dev3185
+Version: 23.0.0.dev3188
 Summary: The Docker-based Open edX distribution designed for peace of mind
 Project-URL: Homepage, https://docs.tutor.edly.io/
 Project-URL: Documentation, https://docs.tutor.edly.io/

{tutor-23.0.0.dev3185 → tutor-23.0.0.dev3188}/tutor/templates/apps/openedx/settings/lms/development.py

@@ -26,10 +26,8 @@ SESSION_COOKIE_SAMESITE = "Lax"
 # CMS authentication
 IDA_LOGOUT_URI_LIST.append("http://{{ CMS_HOST }}:8001/logout/")
 
-FEATURES["ENABLE_COURSEWARE_MICROFRONTEND"] = False
-
 # Disable enterprise integration
-FEATURES["ENABLE_ENTERPRISE_INTEGRATION"] = False
+ENABLE_ENTERPRISE_INTEGRATION = False
 SYSTEM_WIDE_ROLE_CLASSES.remove("enterprise.SystemWideEnterpriseUserRoleAssignment")
 
 LOGGING["loggers"]["oauth2_provider"] = {

{tutor-23.0.0.dev3185 → tutor-23.0.0.dev3188}/tutor/templates/apps/openedx/settings/partials/common_all.py

@@ -4,6 +4,14 @@ import os
 
 from xmodule.modulestore.modulestore_settings import update_module_store_settings
 
+# Re-bind the FEATURES proxy to this settings module, so that both flat feature
+# settings and legacy FEATURES["..."] reads and writes resolve here.
+try:
+    from openedx.core.lib.features_setting_proxy import FeaturesProxy
+    FEATURES = FeaturesProxy(globals())
+except ImportError:
+    pass
+
 # Mongodb connection parameters: simply modify `mongodb_parameters` to affect all connections to MongoDb.
 mongodb_parameters = {
     "db": "{{ MONGODB_DATABASE }}",
@@ -86,8 +94,22 @@ CACHES = {
     }
 }
 
-# The default Django contrib site is the one associated to the LMS domain name. 1 is
-# usually "example.com", so it's the next available integer.
+# The Django contrib site associated to the LMS domain name. Django creates the
+# initial "example.com" site at pk=SITE_ID during the first migration, and the LMS
+# init job (tutor/templates/jobs/init/lms.sh) renames it in place to the platform
+# domain, so that SITE_ID points at the real site instead of "example.com".
+#
+# Open edX resolves the current site from the request host first (see the
+# django-sites-extensions package) and falls back to SITE_ID only when there is no
+# request, so this setting is what request-less code paths use, such as bulk emails
+# sent from Celery workers. The CMS shares it, and the django_site table: Studio
+# requests resolve to a site matching the Studio domain when one exists ("do
+# settheme" creates one) and to this site otherwise.
+#
+# Keep the value at 2. Existing installations have their site, and whatever
+# SiteConfiguration or theme is attached to it, at that id; pointing SITE_ID
+# somewhere else leaves them raising Site.DoesNotExist (see the revert of #1323).
+# See https://github.com/overhangio/tutor/issues/1182
 SITE_ID = 2
 
 # Contact addresses
@@ -229,9 +251,9 @@ JWT_AUTH["JWT_ISSUERS"] = [
 ]
 
 # Enable/Disable some features globally
-FEATURES["ENABLE_DISCUSSION_SERVICE"] = False
-FEATURES["PREVENT_CONCURRENT_LOGINS"] = False
-FEATURES["ENABLE_CORS_HEADERS"] = True
+ENABLE_DISCUSSION_SERVICE = False
+PREVENT_CONCURRENT_LOGINS = False
+ENABLE_CORS_HEADERS = True
 
 # CORS
 CORS_ALLOW_CREDENTIALS = True

{tutor-23.0.0.dev3185 → tutor-23.0.0.dev3188}/tutor/templates/apps/openedx/settings/partials/common_cms.py

@@ -21,7 +21,7 @@ FRONTEND_LOGIN_URL = LMS_ROOT_URL + '/login'
 FRONTEND_REGISTER_URL = LMS_ROOT_URL + '/register'
 
 # Enable "reindex" button
-FEATURES["ENABLE_COURSEWARE_INDEX"] = True
+ENABLE_COURSEWARE_INDEX = True
 
 # Create folders if necessary
 for folder in [LOG_DIR, MEDIA_ROOT, STATIC_ROOT, ORA2_FILEUPLOAD_ROOT]:

{tutor-23.0.0.dev3185 → tutor-23.0.0.dev3188}/tutor/templates/apps/openedx/settings/partials/common_lms.py

@@ -21,7 +21,7 @@ OAUTH_ENFORCE_SECURE = False
 # Email settings
 DEFAULT_EMAIL_LOGO_URL = LMS_ROOT_URL + "/theming/asset/images/logo.png"
 BULK_EMAIL_SEND_USING_EDX_ACE = True
-FEATURES["ENABLE_FOOTER_MOBILE_APP_LINKS"] = False
+ENABLE_FOOTER_MOBILE_APP_LINKS = False
 
 # Branding
 MOBILE_STORE_ACE_URLS = {}
@@ -38,9 +38,9 @@ CACHES["staticfiles"] = {
 }
 
 # Enable search features
-FEATURES["ENABLE_COURSE_DISCOVERY"] = True
-FEATURES["ENABLE_COURSEWARE_SEARCH"] = True
-FEATURES["ENABLE_DASHBOARD_SEARCH"] = True
+ENABLE_COURSE_DISCOVERY = True
+ENABLE_COURSEWARE_SEARCH = True
+ENABLE_DASHBOARD_SEARCH = True
 
 # Create folders if necessary
 for folder in [DATA_DIR, LOG_DIR, MEDIA_ROOT, STATIC_ROOT, ORA2_FILEUPLOAD_ROOT]:

{tutor-23.0.0.dev3185 → tutor-23.0.0.dev3188}/tutor/templates/jobs/init/lms.sh

@@ -15,6 +15,46 @@ echo "Loading settings $DJANGO_SETTINGS_MODULE"
 
 ./manage.py lms migrate
 
+# Point the SITE_ID site at the LMS domain instead of the default "example.com"
+# site that Django auto-creates during the first migration. Otherwise, code paths
+# that run outside of an HTTP request (e.g. bulk emails sent from Celery workers)
+# fall back to SITE_ID and send links/branding for "example.com".
+# https://github.com/overhangio/tutor/issues/1182
+./manage.py lms shell -c "
+from django.conf import settings
+from django.contrib.sites.models import Site
+site_id = settings.SITE_ID
+domain = settings.LMS_BASE
+name = str(settings.PLATFORM_NAME)[:Site._meta.get_field('name').max_length]
+current = Site.objects.filter(pk=site_id).first()
+existing = Site.objects.filter(domain=domain).first()
+current_domain = current.domain if current else None
+if existing and existing.pk == site_id:
+    print(f'SITE_ID {site_id} already points at {domain}')
+elif existing:
+    # Two sites exist: the SITE_ID site and a separate site for the LMS domain.
+    # Both may have data attached (SiteConfiguration, themes, ...), so we cannot
+    # safely guess which to keep. Leave the database untouched and let the
+    # operator decide.
+    print('WARNING: cannot automatically fix SITE_ID: two candidate sites exist.')
+    print(f'WARNING:   - SITE_ID={site_id} currently points at site id={current.pk if current else None} ({current_domain!r})')
+    print(f'WARNING:   - the LMS domain {domain!r} is site id={existing.pk}')
+    print('WARNING: the database was left unchanged. Request-less features (e.g. bulk')
+    print(f'WARNING: email) will keep using {current_domain!r}.')
+    print('WARNING: to fix, review both sites, delete the one you do not need, and set')
+    print('WARNING: SITE_ID (via a plugin) to the id of the site you keep.')
+elif current is None:
+    Site.objects.create(pk=site_id, domain=domain, name=name)
+    print(f'Created site id={site_id} for {domain}')
+elif current.domain == 'example.com':
+    current.domain = domain
+    current.name = name
+    current.save()
+    print(f'Renamed default site id={site_id} from example.com to {domain}')
+else:
+    print(f'SITE_ID {site_id} points at {current.domain} - leaving unchanged')
+"
+
 # Create meilisearch indexes
 ./manage.py lms shell -c "import search.meilisearch; search.meilisearch.create_indexes()"