Use manifest.json files to download collections #436
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,12 +16,12 @@ | |
| from django.views.generic.base import TemplateView | ||
| from django.views.generic.base import View | ||
| from kolibri.core.content.api import cache_forever | ||
| from kolibri.core.content.zip_wsgi import add_security_headers | ||
| from kolibri.core.content.zip_wsgi import get_embedded_file | ||
| from kolibri.core.decorators import cache_no_user_data | ||
| from kolibri.core.tasks.api import _job_to_response | ||
| from kolibri.core.tasks.api import _remoteimport | ||
| from kolibri.core.tasks.exceptions import JobNotFound | ||
| from kolibri.core.tasks.job import State | ||
| from kolibri.core.tasks.main import queue | ||
| from kolibri.utils import conf | ||
|
|
@@ -35,6 +35,13 @@ | |
| APPS_BUNDLE_PATHS.append(os.path.join(os.path.dirname(__file__), "apps")) | ||
|
|
||
|
|
||
| COLLECTION_PATHS = os.path.join( | ||
| os.path.dirname(__file__), "static", "collections" | ||
| ) | ||
| if conf.OPTIONS["Explore"]["CONTENT_COLLECTIONS_PATH"]: | ||
| COLLECTION_PATHS = conf.OPTIONS["Explore"]["CONTENT_COLLECTIONS_PATH"] | ||
|
|
||
|
|
||
| @method_decorator(cache_no_user_data, name="dispatch") | ||
| class ExploreView(TemplateView): | ||
| template_name = "explore/explore.html" | ||
|
|
@@ -112,46 +119,84 @@ def get(self, request, app): | |
|
|
||
| @method_decorator(csrf_exempt, name="dispatch") | ||
| class EndlessLearningCollection(View): | ||
| grade_collections = { | ||
| "primary": { | ||
| "small": { | ||
| "title": "2 GB", | ||
| "subtitle": "Small", | ||
| "channels": 13, | ||
| "size": 2, | ||
| "text": "Primary", | ||
| "token": "kopip-lakip", | ||
| "available": True, | ||
| }, | ||
| "large": { | ||
| "title": "5 GB", | ||
| "subtitle": "Large", | ||
| "channels": 14, | ||
| "size": 5, | ||
| "text": "Primary", | ||
| "token": "vofog-gufap", | ||
| "available": True, | ||
| }, | ||
| }, | ||
| "intermediate": { | ||
| "small": { | ||
| "title": "3 GB", | ||
| "subtitle": "Small", | ||
| "channels": 22, | ||
| "size": 3, | ||
| "text": "Intermediate", | ||
| "token": "kopip-lakip", | ||
| "available": True, | ||
| }, | ||
| "large": { | ||
| "title": "6 GB", | ||
| "subtitle": "Large", | ||
| "channels": 22, | ||
| "size": 6, | ||
| "text": "Intermediate", | ||
| "token": "vofog-gufap", | ||
| "available": True, | ||
| }, | ||
| }, | ||
| "secondary": { | ||
| "small": { | ||
| "title": "3 GB", | ||
| "subtitle": "Small", | ||
| "channels": 23, | ||
| "size": 3, | ||
| "text": "Secondary", | ||
| "token": "kopip-lakip", | ||
| "available": True, | ||
| }, | ||
| "large": { | ||
| "title": "6 GB", | ||
| "subtitle": "Large", | ||
| "channels": 24, | ||
| "size": 6, | ||
| "text": "Secondary", | ||
| "token": "vofog-gufap", | ||
| "available": True, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| BASE_URL = "https://kolibri-content.endlessos.org/" | ||
|
|
||
| def check_collection_availability(self): | ||
| free_space_gb = get_free_space() / 1024**3 | ||
| for collections in self.grade_collections.values(): | ||
| for v in collections.values(): | ||
| v["available"] = v["size"] < free_space_gb | ||
|
|
||
| def get(self, request): | ||
| job_ids = request.session.get("job_ids", []) | ||
| try: | ||
| jobs = [queue.fetch_job(job) for job in job_ids] | ||
| except JobNotFound: | ||
| request.session["job_ids"] = [] | ||
| jobs = [] | ||
| running = [job for job in jobs if job.state == State.RUNNING] | ||
| pid, _, _ = get_status() | ||
|
|
||
|
|
@@ -184,7 +229,7 @@ def get(self, request): | |
| collection = request.session.get("downloading") | ||
| self.check_collection_availability() | ||
| jobs_response = { | ||
| "collections": self.grade_collections, | ||
| "collection": collection, | ||
| "jobs": [_job_to_response(job) for job in jobs], | ||
| } | ||
|
|
@@ -194,25 +239,30 @@ def get(self, request): | |
| ) | ||
|
|
||
| def post(self, request): | ||
| grade = "primary" | ||
| collection = "small" | ||
| if request.body: | ||
| data = json.loads(request.body) | ||
| collection = data.get("collection", "small") | ||
| grade = data.get("grade", "primary") | ||
|
|
||
| collection_manifest = os.path.join( | ||
| COLLECTION_PATHS, f"{grade}-{collection}.json" | ||
| ) | ||
|
|
||
| if not os.path.exists(collection_manifest): | ||
| raise Http404("Collection manifest not found") | ||
|
|
||
| manifest = {} | ||
| with open(collection_manifest) as f: | ||
| manifest = json.load(f) | ||
| channels = manifest.get("channels", []) | ||
|
|
||
| job_ids = [] | ||
| pid, _, _ = get_status() | ||
| for channel in channels: | ||
| task = { | ||
| "channel_id": channel["id"], | ||
| "baseurl": self.BASE_URL, | ||
| "started_by_username": "endless", | ||
| "type": "REMOTEIMPORT", | ||
|
|
@@ -223,6 +273,10 @@ def post(self, request): | |
| _remoteimport, | ||
| task["channel_id"], | ||
| task["baseurl"], | ||
| # Done this way to convert [] to None | ||
| node_ids=channel.get("include_node_ids") or None, | ||
| # Done this way to convert [] to None | ||
| exclude_node_ids=channel.get("exclude_node_ids") or None, | ||
|
Comment on lines
+276
to
+279
There was a problem hiding this comment. 👍 there's a subtle difference in how It's worth noting this behaviour will be different with learningequality/kolibri#9460. Setting Once we have Kolibri with my changes applied, the manifest file code should actually never create a manifest file with the latter: if it includes all the nodes from a channel, it ends up with Hopefully in a future iteration we can pass a manifest file directly to the remoteimport task so we don't need to deal with all this :) |
||
| extra_metadata=task, | ||
| track_progress=True, | ||
| cancellable=True, | ||
|
|
@@ -232,7 +286,7 @@ def post(self, request): | |
| # Two weeks session expiry | ||
| request.session.set_expiry(1209600) | ||
| request.session["job_ids"] = job_ids | ||
| request.session["downloading"] = f"{grade}-{collection}" | ||
| return HttpResponse( | ||
| json.dumps(job_ids), content_type="application/json" | ||
| ) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like "grade" is an awkward word to use here since it's very specific to our current implementation, but at the same time the alternatives I can think of ("group", "category") would be terrrible and confusing, so 🤷