The Report.js analyzeReport now also finds all references to files in contentItems. Still needs module searching.

Author: mbusch3

assets/js/Components/App.js

@@ -134,6 +134,7 @@ export default function App(initialData) {
   const processNewReport = (rawReport) => {
     const tempReport = analyzeReport(rawReport, ISSUE_STATE)
     setReport(tempReport)
+    console.log(tempReport)
 
     let api = new Api(settings)
     api.setReportData(tempReport.id, {'scanCounts': tempReport.scanCounts, 'scanRules': tempReport.scanRules})

assets/js/Components/Widgets/FileReviewPreview.js

@@ -3,6 +3,7 @@ import DownloadIcon from '../Icons/DownloadIcon'
 import ExternalLinkIcon from '../Icons/ExternalLinkIcon'
 import * as Text from '../../Services/Text'
 import './FixIssuesContentPreview.css'
+import SeverityIcon from '../Icons/SeverityIcon'
 
 
 export default function FixIssuesContentPreview({
@@ -62,6 +63,28 @@ export default function FixIssuesContentPreview({
                 <div className="flex-column flex-center allow-word-break">{Text.getReadableDateTime(activeIssue.fileData.updated)}</div>
               </div>
             </div>
+            { activeIssue.fileData.references.length === 0 ? (
+              <div className="mt-3 callout-container">
+                <div className="flex-row">
+                  <div className="flex-column justify-content-start mr-2">
+                    <SeverityIcon severity="potential" className="icon-md potential-color" alt="" />
+                  </div>
+                  <div className="flex-column justify-content-start">
+                    {t('fix.message.no_references_found')}
+                  </div>
+                </div>
+              </div>
+            ) : (
+              <div className="mt-3">
+                <h3>{t('fix.label.references')}</h3>
+                  { activeIssue.fileData.references.map((reference) => (
+                    <p>
+                      <a href={reference.contentItemUrl} target="_blank" rel="noreferrer">{reference.contentItemTitle}</a>
+                    </p>
+                  )) }
+              </div>
+            )}
+            
             <div className="mt-3 flex-row justify-content-center gap-3">
               { activeIssue.fileData.downloadUrl && (
                 <button className="btn btn-secondary btn-icon-left" onClick={() => window.open(activeIssue.fileData.downloadUrl, 'download')}>

assets/js/Services/Report.js

@@ -85,6 +85,39 @@ export function analyzeReport(report, ISSUE_STATE) {
   let millisecondsInADay = 86400000 // 1000 * 60 * 60 * 24
 
   const parser = new DOMParser()
+  const fileReferences = {}
+
+  // Parse every document only once. Not every content item will have issues, but we need to parse each one anyway
+  // so we can scan them for references to course files.
+  Object.values(report.contentItems).forEach((contentItem) => {
+    if(contentItem.body) {
+      let tempBody = parser.parseFromString(contentItem.body, 'text/html')
+
+      // Get all of the links to files in the content item.
+      let links = tempBody.getElementsByTagName('a')
+      const fileUrlPattern = /\/files\/(\d+)/
+      for(let i = 0; i < links.length; i++) {
+        let link = links[i]
+        let href = link.getAttribute('href')
+        if(href) {
+          let match = href.match(fileUrlPattern)
+          if(match && match[1]) {
+            let fileId = match[1]
+            if(!fileReferences[fileId]) {
+              fileReferences[fileId] = []
+            }
+            fileReferences[fileId].push({
+              contentItemTitle: contentItem.title,
+              contentItemUrl: contentItem.url,
+              contentType: contentItem.contentType,
+            })
+          }
+        }
+      }
+
+      parsedDocuments[contentItem.id] = tempBody
+    }
+  })
 
   report.issues.forEach((issue) => {
 
@@ -98,21 +131,9 @@ export function analyzeReport(report, ISSUE_STATE) {
       // Get the relevant content item
       let contentItemId = issue.contentItemId
 
-      // We're quickly caching all of the parsed documents so we don't have to parse them for each issue.
-      let parsedDocument = null
       if(parsedDocuments[contentItemId]) {
-        parsedDocument = parsedDocuments[contentItemId]
-      }
-      else {
-        if(report?.contentItems[contentItemId]?.body) {
-          parsedDocuments[contentItemId] = parser.parseFromString(report.contentItems[contentItemId].body, 'text/html')
-          parsedDocument = parsedDocuments[contentItemId]
-        }
-      }
-      
-      if(parsedDocument) {
         // In the initial scan, whatever comes back is saved to both the issue.xpath and issue.sourceHtml variables.
-        let element = Html.findElementWithIssue(parsedDocument, issue)
+        let element = Html.findElementWithIssue(parsedDocuments[contentItemId], issue)
         if(element) {
           issue.sourceHtml = Html.toString(element)
           let elementClasses = element.getAttribute('class')
@@ -169,6 +190,10 @@ export function analyzeReport(report, ISSUE_STATE) {
     }
   })
 
+  report.files.forEach((file) => {
+    file.references = fileReferences[parseInt(file.lmsFileId)] || []
+  })
+
   let tempFilesReviewed = 0
   Object.values(report.files).forEach((file) => {
     if(file.reviewed) {
@@ -182,6 +207,7 @@ export function analyzeReport(report, ISSUE_STATE) {
   tempReport.issues = activeIssues
   tempReport.scanCounts = scanCounts
   tempReport.scanRules = scanRules
+  tempReport.files = {...report.files}
   tempReport.contentItems = usedContentItems
   tempReport.sessionIssues = sessionIssues
   tempReport.filesReviewed = tempFilesReviewed

src/Entity/Course.php

@@ -299,10 +299,7 @@ public function getFileItems($activeOnly = true): array
         $files = [];
 
         foreach ($this->fileItems as $file) {
-            // if ($activeOnly && !$file->isActive()) {
-            //     continue;
-            // }
-            $files[$file->getId()] = $file;
+            $files[] = $file;
         }
 
         return $files;

translations/en.json

@@ -202,6 +202,7 @@
   "fix.label.file_type": "File Type",
   "fix.label.file_size": "File Size",
   "fix.label.file_updated": "Last Updated",
+  "fix.label.references": "References in Course",
   "fix.label.screen_reader": "Screen Reader Text",
   "fix.label.no_error_preview": "Accessibility Barrier Not Found",
   "fix.label.no_saving": "Editing and Saving Unavailable",
@@ -236,6 +237,7 @@
   "fix.button.next_file": "Next File",
   "fix.button.scroll_to_issue": "Scroll to Issue",
   "fix.button.show_no_error_preview": "Show Content Preview",
+  "fix.message.no_references_found": "This file is not referenced anywhere in the course. If it is not needed, consider deleting it to reduce clutter.",
   "fix.msg.select_issue": "Select an issue from the list to view its details and either fix it or mark it as reviewed.",
   "fix.msg.resolved": "If you have reviewed this issue and determined that it is not an accessibility barrier, you can mark it as reviewed.",
   "fix.msg.unresolved": "This issue has been marked as reviewed. If additional changes need to be made, you can mark it as unreviewed.",