studio

studio copied to clipboard

This code aims to extract metadata from IMS content package. This Pr is a part of GSoC Project linked with the issue #4081.

Summary

Description of the change(s) you made

• Check if imsmanifest.xml is present in file or not
• Metadata may also be present in imsmetadata.xml we need to check this file as well
• Extract metadata through extractIMSMetadata

Manual verification steps performed

1. IMS content package is a zip file and these format presents contains .zip format:
   • QTI
   • HTML5_DEPENDENCY
   • HTML5_ZIP
2. Use jszip to load the uploaded ZIP file asynchronously.
3. Once loaded, parse imsmanifest.xmland imsmetadata.xml file and read the file as text.
4. Then parse the text to json so that we can extract the data.
5. Example of metadata:

{
  title,
  description,
  language,
  folders: [
    {
      title,
      files: [
        {
          identifierref,
          resourceHref,
          title,
        },
        {
          identifierref,
          resourceHref,
          title,
        }
      ]
    },
    {
      title,
      files: [
        {
          identifierref,
          resourceHref,
          title,
        },
      ],
    },
  ],
}

6. Once metadata is extracted, map the topic node to the resource node in frontend.
7. We use extra_fields to map topic node with resource node and render in frontend.

Comments

Checking for sub manifest files present in content packe is yet to be implemented.

Contributor's Checklist

PR process:

• [ ] If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
• [ ] If this includes an internal dependency change, a link to the diff is provided
• [ ] The docs label has been added if this introduces a change that needs to be updated in the user docs?
• [ ] If any Python requirements have changed, the updated requirements.txt files also included in this PR
• [ ] Opportunities for using Google Analytics here are noted
• [ ] Migrations are safe for a large db

Studio-specifc:

• [ ] All user-facing strings are translated properly
• [ ] The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
• [ ] All UI components are LTR and RTL compliant
• [ ] Views are organized into pages, components, and layouts directories as described in the docs
• [ ] Users' storage used is recalculated properly on any changes to main tree files
• [ ] If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

• [ ] Code is clean and well-commented
• [ ] Contributor has fully tested the PR manually
• [ ] If there are any front-end changes, before/after screenshots are included
• [ ] Critical user journeys are covered by Gherkin stories
• [ ] Any new interactions have been added to the QA Sheet
• [ ] Critical and brittle code paths are covered by unit tests

---

Reviewer's Checklist

This section is for reviewers to fill out.

• [ ] Automated test coverage is satisfactory
• [ ] PR is fully functional
• [ ] PR has been tested for accessibility regressions
• [ ] External dependency files were updated if necessary (yarn and pip)
• [ ] Documentation is updated
• [ ] Contributor is in AUTHORS.md