feat: support static reference in LibraryContentBlock

cms/djangoapps/contentstore/tests/test_libraries.py

@@ -366,6 +366,7 @@ def test_switch_to_unknown_source_library_preserves_settings(self):
         self.assertEqual(resp.status_code, 200)
 
         lc_block = modulestore().get_item(lc_block.location)
+
         # Source library id should be set to the new bad one...
         assert lc_block.source_library_id == bad_library_id
         # ...but old source library version should be preserved...

cms/djangoapps/contentstore/toggles.py

@@ -178,6 +178,25 @@ def use_add_game_block():
     return ENABLE_ADD_GAME_BLOCK_FLAG.is_enabled()
 
 
+# .. toggle_name: new_core_editors.use_new_library_content_editor
+# .. toggle_implementation: WaffleFlag
+# .. toggle_default: False
+# .. toggle_description: This flag enables the use of the new library xblock editor
+# .. toggle_use_cases: temporary
+# .. toggle_creation_date: 2023-10-30
+# .. toggle_target_removal_date: 2025-1-30
+# .. toggle_tickets: https://github.com/openedx/edx-platform/issues/33640
+# .. toggle_warning:
+ENABLE_NEW_LIBRARY_CONTENT_EDITOR_FLAG = WaffleFlag('new_core_editors.use_new_library_content_editor', __name__)
+
+
+def use_new_library_content_editor():
+    """
+    Returns a boolean if new library content block editor is enabled
+    """
+    return ENABLE_NEW_LIBRARY_CONTENT_EDITOR_FLAG.is_enabled()
+
+
 # .. toggle_name: contentstore.individualize_anonymous_user_id
 # .. toggle_implementation: CourseWaffleFlag
 # .. toggle_default: False

cms/djangoapps/contentstore/views/component.py

@@ -216,6 +216,7 @@ def container_handler(request, usage_key_string):  # pylint: disable=too-many-st
                 'unit': unit,
                 'is_unit_page': is_unit_page,
                 'is_collapsible': is_library_xblock,
+                'is_library_xblock': is_library_xblock,
                 'subsection': subsection,
                 'section': section,
                 'position': index,

cms/static/js/views/pages/container.js

@@ -120,6 +120,11 @@ function($, _, Backbone, gettext, BasePage,
                 this.unitOutlineView.render();
 
             }
+            if (this.isLibraryContentPage) {
+                this.selectedLibraryComponents = [];
+                this.storedSelectedLibraryComponents = [];
+                this.getSelectedLibraryComponents();
+            }
 
             this.listenTo(Backbone, 'move:onXBlockMoved', this.onXBlockMoved);
         },
@@ -369,11 +374,13 @@ function($, _, Backbone, gettext, BasePage,
                 var useNewTextEditor = primaryHeader.attr('use-new-editor-text'),
                     useNewVideoEditor = primaryHeader.attr('use-new-editor-video'),
                     useNewProblemEditor = primaryHeader.attr('use-new-editor-problem'),
+                    useNewLibraryContentEditor = primaryHeader.attr('use-new-editor-library-content'),
                     blockType = primaryHeader.attr('data-block-type');
 
                 if((useNewTextEditor === 'True' && blockType === 'html')
                         || (useNewVideoEditor === 'True' && blockType === 'video')
                         || (useNewProblemEditor === 'True' && blockType === 'problem')
+                        || (useNewLibraryContentEditor === 'True' && blockType === 'library_content')
                 ) {
                     var destinationUrl = primaryHeader.attr('authoring_MFE_base_url') + '/' + blockType + '/' + encodeURI(primaryHeader.attr('data-usage-id'));
                     window.location.href = destinationUrl;
@@ -638,12 +645,11 @@ function($, _, Backbone, gettext, BasePage,
         getSelectedLibraryComponents: function() {
             var self = this;
             var locator = this.$el.find('.studio-xblock-wrapper').data('locator');
-            console.log(ModuleUtils);
             $.getJSON(
                 ModuleUtils.getUpdateUrl(locator) + '/handler/get_block_ids',
                 function(data) {
-                    self.selectedLibraryComponents = Array.from(data.source_block_ids);
-                    self.storedSelectedLibraryComponents = Array.from(data.source_block_ids);
+                    self.selectedLibraryComponents = Array.from(data.candidates);
+                    self.storedSelectedLibraryComponents = Array.from(data.candidates);
                 }
             );
         },
@@ -654,7 +660,7 @@ function($, _, Backbone, gettext, BasePage,
             e.preventDefault();
             $.postJSON(
                 ModuleUtils.getUpdateUrl(locator) + '/handler/submit_studio_edits',
-                {values: {source_block_ids: self.storedSelectedLibraryComponents}},
+                {values: {candidates: self.storedSelectedLibraryComponents}},
                 function() {
                     self.selectedLibraryComponents = Array.from(self.storedSelectedLibraryComponents);
                     self.toggleSaveButton();
@@ -664,6 +670,7 @@ function($, _, Backbone, gettext, BasePage,
 
         toggleLibraryComponent: function(event) {
             var componentId = $(event.target).closest('.studio-xblock-wrapper').data('locator');
+
             var storeIndex = this.storedSelectedLibraryComponents.indexOf(componentId);
             if (storeIndex > -1) {
                 this.storedSelectedLibraryComponents.splice(storeIndex, 1);

cms/templates/container.html

@@ -176,7 +176,15 @@ <h3 class="sr">${_("Page Actions")}</h3>
                             <span class="action-button-text">${_("Preview")}</span>
                         </a>
                     </li>
+
                 % else:
+                    % if is_library_xblock:
+                    <li class="action-item action-save nav-item">
+                        <a href="#" class="button button-save action-button save-button is-hidden">
+                            <span class="action-button-text">${_("Save changes")}</span>
+                        </a>
+                    </li>
+                    % endif
                     <li class="action-item action-edit nav-item">
                         <a href="#" class="button button-edit action-button edit-button">
                             <span class="icon fa fa-pencil" aria-hidden="true"></span>

cms/templates/studio_xblock_wrapper.html

@@ -7,12 +7,20 @@
 from openedx.core.djangolib.js_utils import (
     dump_js_escaped_json, js_escaped_string
 )
-from cms.djangoapps.contentstore.toggles import use_new_text_editor, use_new_problem_editor, use_new_video_editor, use_video_gallery_flow, use_tagging_taxonomy_list_page
+from cms.djangoapps.contentstore.toggles import(
+    use_new_text_editor,
+    use_new_problem_editor,
+    use_new_video_editor,
+    use_new_library_content_editor,
+    use_video_gallery_flow,
+    use_tagging_taxonomy_list_page,
+)
 %>
 <%
 use_new_editor_text = use_new_text_editor()
 use_new_editor_video = use_new_video_editor()
 use_new_editor_problem = use_new_problem_editor()
+use_new_editor_library_content = use_new_library_content_editor()
 use_new_video_gallery_flow = use_video_gallery_flow()
 use_tagging = use_tagging_taxonomy_list_page()
 xblock_url = xblock_studio_url(xblock)
@@ -67,6 +75,7 @@
     use-new-editor-text = ${use_new_editor_text}
     use-new-editor-video = ${use_new_editor_video}
     use-new-editor-problem = ${use_new_editor_problem}
+    use-new-editor-library-content = ${use_new_editor_library_content}
     use-video-gallery-flow = ${use_new_video_gallery_flow}
     authoring_MFE_base_url = ${get_editor_page_base_url(xblock.location.course_key)}
     data-block-type = ${xblock.scope_ids.block_type}

lms/djangoapps/course_blocks/transformers/library_content.py

@@ -83,7 +83,8 @@ def transform_block_filters(self, usage_info, block_structure):
             if library_children:
                 all_library_children.update(library_children)
                 selected = []
-                mode = block_structure.get_xblock_field(block_key, 'mode')
+                shuffle = block_structure.get_xblock_field(block_key, 'shuffle')
+                manual = block_structure.get_xblock_field(block_key, 'manual')
                 max_count = block_structure.get_xblock_field(block_key, 'max_count')
                 if max_count < 0:
                     max_count = len(library_children)
@@ -98,9 +99,21 @@ def transform_block_filters(self, usage_info, block_structure):
                     if usage_key in library_children:
                         selected.append(selected_block)
 
+                #Get "canidate" blocks which have been manually selected
+                candidates = state_dict.get('candidates', [])
+
                 # Update selected
                 previous_count = len(selected)
-                block_keys = LibraryContentBlock.make_selection(selected, library_children, max_count, mode)
+                block_keys = LibraryContentBlock.make_selection(
+                    old_selected=list(map(tuple, selected)),
+                    library_children=library_children,
+                    candidates=[
+                        child for child in library_children if [child.block_type, child.block_id] in candidates
+                    ],
+                    max_count=max_count,
+                    manual=manual,
+                    shuffle=shuffle,
+                )
                 selected = block_keys['selected']
 
                 # Save back any changes

openedx/core/djangoapps/content_libraries/api.py

@@ -131,6 +131,7 @@
 from openedx.core.djangolib import blockstore_cache
 from openedx.core.djangolib.blockstore_cache import BundleCache
 from xmodule.library_root_xblock import LibraryRoot as LibraryRootV1
+
 from xmodule.modulestore import ModuleStoreEnum
 from xmodule.modulestore.django import modulestore
 from xmodule.modulestore.exceptions import ItemNotFoundError

openedx/core/djangoapps/content_libraries/tasks.py

@@ -322,6 +322,7 @@ def _sync_children(
     source_blocks = []
     library_key = dest_block.source_library_key
     filter_children = (dest_block.capa_type != ANY_CAPA_TYPE_VALUE)
+
     library = library_api.get_v1_or_v2_library(library_key, version=library_version)
     if not library:
         task.status.fail(f"Requested library {library_key} not found.")