openedx/core/lib/courses.py - release-ulmo - githubmirror/edx-platform

openedx/core/lib/courses.py
108 строк4 KB
Andrii
refactor: change logo_path to logo_url
23 июн 2025, 19:12
23 июн 2025, 19:1204febf0
"""
Common utility functions related to courses.
"""

from django import forms
from django.conf import settings
from django.http import Http404

from opaque_keys import InvalidKeyError
from opaque_keys.edx.locator import CourseKey
from organizations.models import Organization
from xmodule.assetstore.assetmgr import AssetManager
from xmodule.contentstore.content import StaticContent
from xmodule.contentstore.django import contentstore
from xmodule.modulestore.django import modulestore


def course_image_url(course, image_key='course_image'):
    """Try to look up the image url for the course.  If it's not found,
    log an error and return the dead link.
    image_key can be one of the three: 'course_image', 'hero_image', 'thumbnail_image' """
    if course.static_asset_path:
        # If we are a static course with the image_key attribute
        # set different than the default, return that path so that
        # courses can use custom course image paths, otherwise just
        # return the default static path.
        url = '/static/' + (course.static_asset_path or getattr(course, 'data_dir', ''))
        if hasattr(course, image_key) and getattr(course, image_key) != course.fields[image_key].default:
            url += '/' + getattr(course, image_key)
        else:
            url += '/images/' + image_key + '.jpg'
    elif not getattr(course, image_key):
        # if image_key is empty, use the default image url from settings
        url = settings.STATIC_URL + settings.DEFAULT_COURSE_ABOUT_IMAGE_URL
    else:
        loc = StaticContent.compute_location(course.id, getattr(course, image_key))
        url = StaticContent.serialize_asset_key_with_slash(loc)

    return url


def course_organization_image_url(course):
    """Return the course organization image URL or the default image URL."""
    org = Organization.objects.filter(short_name=course.id.org).first()
    return org.logo.url if org and org.logo else settings.DEFAULT_ORG_LOGO_URL


def create_course_image_thumbnail(course, dimensions):
    """Create a course image thumbnail and return the URL.

    - dimensions is a tuple of (width, height)
    """
    course_image_asset_key = StaticContent.compute_location(course.id, course.course_image)
    course_image = AssetManager.find(course_image_asset_key)  # a StaticContent obj

    _content, thumb_loc = contentstore().generate_thumbnail(course_image, dimensions=dimensions)

    return StaticContent.serialize_asset_key_with_slash(thumb_loc)


def clean_course_id(model_form, is_required=True):
    """
    Cleans and validates a course_id for use with a Django ModelForm.

    Arguments:
        model_form (form.ModelForm): The form that has a course_id.
        is_required (Boolean): Default True. When True, validates that the
            course_id is not empty.  In all cases, when course_id is supplied,
            validates that it is a valid course.

    Returns:
        (CourseKey) The cleaned and validated course_id as a CourseKey.

    NOTE: Use this method in model forms instead of a custom "clean_course_id" method!

    """
    cleaned_id = model_form.cleaned_data["course_id"]

    if not cleaned_id and not is_required:
        return None

    try:
        course_key = CourseKey.from_string(cleaned_id)
    except InvalidKeyError:
        msg = f'Course id invalid. Entered course id was: "{cleaned_id}".'
        raise forms.ValidationError(msg)  # lint-amnesty, pylint: disable=raise-missing-from

    if not modulestore().has_course(course_key):
        msg = f'Course not found. Entered course id was: "{str(course_key)}".'
        raise forms.ValidationError(msg)

    return course_key


def get_course_by_id(course_key, depth=0):
    """
    Given a course id, return the corresponding course block.

    If such a course does not exist, raises a 404.

    depth: The number of levels of children for the modulestore to cache. None means infinite depth
    """
    with modulestore().bulk_operations(course_key):
        course = modulestore().get_course(course_key, depth=depth)
    if course:
        return course
    else:
        raise Http404(f"Course not found: {str(course_key)}.")