69410948c9
This change improves grading performance by combining what had previously been multiple course tree traversals into a single traversal with combined filtering logic.
98 lines
3.7 KiB
Python
98 lines
3.7 KiB
Python
"""
|
|
Start Date Transformer implementation.
|
|
"""
|
|
from openedx.core.lib.block_structure.transformer import BlockStructureTransformer, FilteringTransformerMixin
|
|
from lms.djangoapps.courseware.access_utils import check_start_date
|
|
from xmodule.course_metadata_utils import DEFAULT_START_DATE
|
|
|
|
from .utils import get_field_on_block
|
|
|
|
|
|
class StartDateTransformer(FilteringTransformerMixin, BlockStructureTransformer):
|
|
"""
|
|
A transformer that enforces the 'start' and 'days_early_for_beta'
|
|
fields on blocks by removing blocks from the block structure for
|
|
which the user does not have access. The 'start' field on a
|
|
block is percolated down to its descendants, so that all blocks
|
|
enforce the 'start' field from their ancestors. The assumed
|
|
'start' value for a block is then the maximum of its parent and its
|
|
own.
|
|
|
|
For a block with multiple parents, the assumed parent start date
|
|
value is a computed minimum of the start dates of all its parents.
|
|
So as long as one parent chain allows access, the block has access.
|
|
|
|
Staff users are exempted from visibility rules.
|
|
"""
|
|
VERSION = 1
|
|
MERGED_START_DATE = 'merged_start_date'
|
|
|
|
@classmethod
|
|
def name(cls):
|
|
"""
|
|
Unique identifier for the transformer's class;
|
|
same identifier used in setup.py.
|
|
"""
|
|
return "start_date"
|
|
|
|
@classmethod
|
|
def get_merged_start_date(cls, block_structure, block_key):
|
|
"""
|
|
Returns the merged value for the start date for the block with
|
|
the given block_key in the given block_structure.
|
|
"""
|
|
return block_structure.get_transformer_block_field(
|
|
block_key, cls, cls.MERGED_START_DATE, False
|
|
)
|
|
|
|
@classmethod
|
|
def collect(cls, block_structure):
|
|
"""
|
|
Collects any information that's necessary to execute this
|
|
transformer's transform method.
|
|
"""
|
|
block_structure.request_xblock_fields('days_early_for_beta')
|
|
|
|
for block_key in block_structure.topological_traversal():
|
|
|
|
# compute merged value of start date from all parents
|
|
parents = block_structure.get_parents(block_key)
|
|
min_all_parents_start_date = min(
|
|
cls.get_merged_start_date(block_structure, parent_key)
|
|
for parent_key in parents
|
|
) if parents else None
|
|
|
|
# set the merged value for this block
|
|
block_start = get_field_on_block(block_structure.get_xblock(block_key), 'start')
|
|
if min_all_parents_start_date is None:
|
|
# no parents so just use value on block or default
|
|
merged_start_value = block_start or DEFAULT_START_DATE
|
|
|
|
elif not block_start:
|
|
# no value on this block so take value from parents
|
|
merged_start_value = min_all_parents_start_date
|
|
|
|
else:
|
|
# max of merged-start-from-all-parents and this block
|
|
merged_start_value = max(min_all_parents_start_date, block_start)
|
|
|
|
block_structure.set_transformer_block_field(
|
|
block_key,
|
|
cls,
|
|
cls.MERGED_START_DATE,
|
|
merged_start_value
|
|
)
|
|
|
|
def transform_block_filters(self, usage_info, block_structure):
|
|
# Users with staff access bypass the Start Date check.
|
|
if usage_info.has_staff_access:
|
|
return [block_structure.create_universal_filter()]
|
|
|
|
removal_condition = lambda block_key: not check_start_date(
|
|
usage_info.user,
|
|
block_structure.get_xblock_field(block_key, 'days_early_for_beta'),
|
|
self.get_merged_start_date(block_structure, block_key),
|
|
usage_info.course_key,
|
|
)
|
|
return [block_structure.create_removal_filter(removal_condition)]
|