MDL-78576 mod_lti: improve course tool deletion with contextual messages

Present different deletion messages depending on whether the tool has
usages or not.

mod/lti/amd/build/course_tools_list.min.js

@@ -1,3 +1,3 @@
-define("mod_lti/course_tools_list",["exports","core/notification","core/pending","core/ajax","core/toast","core/prefetch","core/str","core_table/dynamic","core_table/local/dynamic/selectors"],(function(_exports,_notification,_pending,_ajax,_toast,_prefetch,_str,_dynamic,Selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_ajax=_interopRequireDefault(_ajax),Selectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Selectors);_exports.init=()=>{(0,_prefetch.prefetchStrings)("mod_lti",["deletecoursetool","deletecoursetoolconfirm","coursetooldeleted"]),(0,_prefetch.prefetchStrings)("core",["delete"]),document.addEventListener("click",(event=>{const courseToolDelete=event.target.closest('[data-action="course-tool-delete"]');if(courseToolDelete){event.preventDefault();const triggerElement=courseToolDelete.closest(".dropdown").querySelector(".dropdown-toggle");_notification.default.saveCancelPromise((0,_str.get_string)("deletecoursetool","mod_lti"),(0,_str.get_string)("deletecoursetoolconfirm","mod_lti",courseToolDelete.dataset.courseToolName),(0,_str.get_string)("delete","core"),{triggerElement:triggerElement}).then((()=>{const pendingPromise=new _pending.default("mod_lti/course_tools:delete"),request={methodname:"mod_lti_delete_course_tool_type",args:{tooltypeid:courseToolDelete.dataset.courseToolId}};return _ajax.default.call([request])[0].then((0,_toast.add)((0,_str.get_string)("coursetooldeleted","mod_lti"))).then((()=>{const tableRoot=triggerElement.closest(Selectors.main.region);return(0,_dynamic.refreshTableContent)(tableRoot)})).then(pendingPromise.resolve).catch(_notification.default.exception)})).catch((()=>{}))}}))}}));
+define("mod_lti/course_tools_list",["exports","core/notification","core/pending","core/ajax","core/toast","core/str","core_table/dynamic","core_table/local/dynamic/selectors"],(function(_exports,_notification,_pending,_ajax,_toast,_str,_dynamic,Selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_ajax=_interopRequireDefault(_ajax),Selectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Selectors);_exports.init=()=>{document.addEventListener("click",(event=>{const courseToolDelete=event.target.closest('[data-action="course-tool-delete"]');if(courseToolDelete){event.preventDefault();const deleteBodyStringId=courseToolDelete.dataset.courseToolUsage>0?"deletecoursetoolwithusageconfirm":"deletecoursetoolconfirm",requiredStrings=[{key:"deletecoursetool",component:"mod_lti",param:courseToolDelete.dataset.courseToolName},{key:deleteBodyStringId,component:"mod_lti",param:courseToolDelete.dataset.courseToolName},{key:"delete",component:"core",param:courseToolDelete.dataset.courseToolName},{key:"coursetooldeleted",component:"mod_lti",param:courseToolDelete.dataset.courseToolName}],triggerElement=courseToolDelete.closest(".dropdown").querySelector(".dropdown-toggle");(0,_str.get_strings)(requiredStrings).then((_ref=>{let[modalTitle,modalBody,deleteLabel]=_ref;return _notification.default.deleteCancelPromise(modalTitle,modalBody,deleteLabel,{triggerElement:triggerElement})})).then((()=>{const pendingPromise=new _pending.default("mod_lti/course_tools:delete"),request={methodname:"mod_lti_delete_course_tool_type",args:{tooltypeid:courseToolDelete.dataset.courseToolId}};return _ajax.default.call([request])[0].then((0,_toast.add)((0,_str.get_string)("coursetooldeleted","mod_lti",courseToolDelete.dataset.courseToolName))).then((()=>{const tableRoot=triggerElement.closest(Selectors.main.region);return(0,_dynamic.refreshTableContent)(tableRoot)})).then(pendingPromise.resolve).catch(_notification.default.exception)})).catch((()=>{}))}}))}}));
 
 //# sourceMappingURL=course_tools_list.min.js.map

mod/lti/amd/src/course_tools_list.js

@@ -27,8 +27,7 @@ import Notification from 'core/notification';
 import Pending from 'core/pending';
 import Ajax from 'core/ajax';
 import {add as addToast} from 'core/toast';
-import {prefetchStrings} from 'core/prefetch';
-import {get_string as getString} from 'core/str';
+import {get_string as getString, get_strings as getStrings} from 'core/str';
 import {refreshTableContent} from 'core_table/dynamic';
 import * as Selectors from 'core_table/local/dynamic/selectors';
 
@@ -36,30 +35,31 @@ import * as Selectors from 'core_table/local/dynamic/selectors';
  * Initialise module.
  */
 export const init = () => {
-    prefetchStrings('mod_lti', [
-        'deletecoursetool',
-        'deletecoursetoolconfirm',
-        'coursetooldeleted'
-    ]);
-
-    prefetchStrings('core', [
-        'delete',
-    ]);
-
     document.addEventListener('click', event => {
 
         const courseToolDelete = event.target.closest('[data-action="course-tool-delete"]');
         if (courseToolDelete) {
             event.preventDefault();
 
+            // A different message is used in the modal if the tool has usages within the course.
+            const usage = courseToolDelete.dataset.courseToolUsage;
+            const deleteBodyStringId = usage > 0 ? 'deletecoursetoolwithusageconfirm' : 'deletecoursetoolconfirm';
+            const requiredStrings = [
+                {key: 'deletecoursetool', component: 'mod_lti', param: courseToolDelete.dataset.courseToolName},
+                {key: deleteBodyStringId, component: 'mod_lti', param: courseToolDelete.dataset.courseToolName},
+                {key: 'delete', component: 'core', param: courseToolDelete.dataset.courseToolName},
+                {key: 'coursetooldeleted', component: 'mod_lti', param: courseToolDelete.dataset.courseToolName}
+            ];
             // Use triggerElement to return focus to the action menu toggle.
             const triggerElement = courseToolDelete.closest('.dropdown').querySelector('.dropdown-toggle');
-            Notification.saveCancelPromise(
-                getString('deletecoursetool', 'mod_lti'),
-                getString('deletecoursetoolconfirm', 'mod_lti', courseToolDelete.dataset.courseToolName),
-                getString('delete', 'core'),
-                {triggerElement}
-            ).then(() => {
+
+            getStrings(requiredStrings).then(([modalTitle, modalBody, deleteLabel]) => {
+                return Notification.deleteCancelPromise(
+                    modalTitle,
+                    modalBody,
+                    deleteLabel,
+                    {triggerElement});
+            }).then(() => {
                 const pendingPromise = new Pending('mod_lti/course_tools:delete');
 
                 const request = {
@@ -67,7 +67,7 @@ export const init = () => {
                     args: {tooltypeid: courseToolDelete.dataset.courseToolId}
                 };
                 return Ajax.call([request])[0]
-                    .then(addToast(getString('coursetooldeleted', 'mod_lti')))
+                    .then(addToast(getString('coursetooldeleted', 'mod_lti', courseToolDelete.dataset.courseToolName)))
                     .then(() => {
                         const tableRoot = triggerElement.closest(Selectors.main.region);
                         return refreshTableContent(tableRoot);

mod/lti/classes/reportbuilder/local/systemreports/course_external_tools_list.php

@@ -128,7 +128,7 @@ class course_external_tools_list extends system_report {
             ->set_type(column::TYPE_TEXT)
             ->set_is_sortable(false)
             ->add_fields("{$entitymainalias}.id, {$entitymainalias}.course, {$entitymainalias}.name")
-            ->add_callback(static function($field, $row) {
+            ->add_callback(function($field, $row) {
                 global $OUTPUT;
 
                 // Lock actions for site-level preconfigured tools.
@@ -169,7 +169,8 @@ class course_external_tools_list extends system_report {
                     [
                         'data-action' => 'course-tool-delete',
                         'data-course-tool-id' => $row->id,
-                        'data-course-tool-name' => $row->name
+                        'data-course-tool-name' => $row->name,
+                        'data-course-tool-usage' => $this->perrowtoolusage
                     ],
                 ));
 

mod/lti/lang/en/lti.php

@@ -130,7 +130,7 @@ $string['courseid'] = 'Course ID number';
 $string['courseinformation'] = 'Course information';
 $string['courselink'] = 'Go to course';
 $string['coursemisconf'] = 'Course is misconfigured';
-$string['coursetooldeleted'] = 'Course tool deleted';
+$string['coursetooldeleted'] = '{$a} removed';
 $string['createdon'] = 'Created on';
 $string['curllibrarymissing'] = 'PHP cURL extension required for the External tool.';
 $string['custom'] = 'Custom parameters';
@@ -159,8 +159,9 @@ $string['delegate'] = 'Delegate to teacher';
 $string['delegate_tool'] = 'As specified in Deep Linking definition or Delegate to teacher';
 $string['delete'] = 'Delete';
 $string['delete_confirmation'] = 'Are you sure you want to delete this preconfigured tool?';
-$string['deletecoursetool'] = 'Delete a course tool';
-$string['deletecoursetoolconfirm'] = 'Are you sure you want to delete this course tool?';
+$string['deletecoursetool'] = 'Delete {$a}';
+$string['deletecoursetoolconfirm'] = 'This will delete {$a} from the available LTI tools in your course.';
+$string['deletecoursetoolwithusageconfirm'] = '{$a} is currently being used in at least one activity in your course. If you delete this tool, the activities that use it will no longer work.<br><br>Are you sure you want to delete {$a}?';
 $string['deletetype'] = 'Delete preconfigured tool';
 $string['display_description'] = 'Display activity description when launched';
 $string['display_description_help'] = 'If selected, the activity description (specified above) will display above the tool provider\'s content.

mod/lti/tests/behat/managecoursetools.feature

@@ -107,12 +107,12 @@ Feature: Manage course tools
     And I navigate to "LTI External tools" in current page administration
     When I open the action menu in "Test tool" "table_row"
     And I choose "Delete" in the open action menu
-    Then I should see "Are you sure you want to delete this course tool?"
-    And I click on "Cancel" "button" in the "Delete a course tool" "dialogue"
+    Then I should see "This will delete Test tool from the available LTI tools in your course."
+    And I click on "Cancel" "button" in the "Delete Test tool" "dialogue"
     And I should see "Test tool" in the "reportbuilder-table" "table"
     And I open the action menu in "Test tool" "table_row"
     And I choose "Delete" in the open action menu
-    And I should see "Are you sure you want to delete this course tool?"
-    And I click on "Delete" "button" in the "Delete a course tool" "dialogue"
-    And I should see "Course tool deleted"
+    And I should see "This will delete Test tool from the available LTI tools in your course."
+    And I click on "Delete" "button" in the "Delete Test tool" "dialogue"
+    And I should see "Test tool removed"
     And I should not see "Test tool" in the "reportbuilder-table" "table"