{% for key,name in systems_list %} diff --git a/project/utils/manifest.py b/project/manager_frontend/utils/manifest.py similarity index 97% rename from project/utils/manifest.py rename to project/manager_frontend/utils/manifest.py index 81ff255..bedccca 100644 --- a/project/utils/manifest.py +++ b/project/manager_frontend/utils/manifest.py @@ -5,7 +5,7 @@ import json import xml.etree.cElementTree as ET -class ManifestParser(object): +class RecalboxManifestParser(object): """ Recalbox XML manifest parser """ diff --git a/project/utils/views.py b/project/manager_frontend/utils/views.py similarity index 94% rename from project/utils/views.py rename to project/manager_frontend/utils/views.py index 7515f74..9c90f5b 100644 --- a/project/utils/views.py +++ b/project/manager_frontend/utils/views.py @@ -1,15 +1,11 @@ """ Some common class based views - -TODO: Move this into 'manager_frontend' app """ import json from django.views.generic.edit import TemplateResponseMixin, FormMixin, ProcessFormView from django.http import HttpResponse -from project.manager_frontend.forms.roms import RomUploadForm, RomDeleteForm - class MultiFormView(TemplateResponseMixin, FormMixin, ProcessFormView): """ This is a huge rewrite and mixing of some CBV views and mixins to be able @@ -29,9 +25,9 @@ class MultiFormView(TemplateResponseMixin, FormMixin, ProcessFormView): Both must be unique through the forms of the view. - WARNING: This view should implement some warnings about needed stuff like - form attributes and form object names if not defined. So actually - you'll have to remember of this yourself. + TODO: This view should implement some warnings about needed stuff like + form attributes and form object names if not defined. So actually + you'll have to remember of this yourself. """ # The patterns used to find method/names from form 'form_key' attribute getformkwargs_pattern = 'get_{}_form_kwargs' diff --git a/project/manager_frontend/views/bios.py b/project/manager_frontend/views/bios.py index 6958aef..93e5566 100644 --- a/project/manager_frontend/views/bios.py +++ b/project/manager_frontend/views/bios.py @@ -1,19 +1,19 @@ """ Views for Bios views """ -import os, re +import os from operator import itemgetter from django.conf import settings -from django.views.generic import TemplateView -from django.views.generic.edit import FormView from django.core.urlresolvers import reverse from django.contrib import messages from django.http import Http404, HttpResponseBadRequest from django.utils.translation import ugettext as _ +from project.recalbox_manifest import manifest as RECALBOX_MANIFEST + from project.manager_frontend.forms.bios import BiosDeleteForm, BiosUploadForm -from project.utils.views import MultiFormView, JsonMixin +from project.manager_frontend.utils.views import MultiFormView, JsonMixin class BiosListView(MultiFormView): """ @@ -49,7 +49,7 @@ def get_bios_manifest(self): """ bios_dict = {} - for system_key, system_datas in settings.RECALBOX_MANIFEST.items(): + for system_key, system_datas in RECALBOX_MANIFEST.items(): system_name = system_datas.get('name', system_key) if len(system_datas.get('bios', []))>0: for md5hash,filename in system_datas['bios']: diff --git a/project/manager_frontend/views/config.py b/project/manager_frontend/views/config.py index acc632b..c4fe7cd 100644 --- a/project/manager_frontend/views/config.py +++ b/project/manager_frontend/views/config.py @@ -4,8 +4,6 @@ import os from django.conf import settings -from django.shortcuts import render -from django.views.generic import TemplateView from django.views.generic.edit import FormView from django.core.urlresolvers import reverse from django.contrib import messages diff --git a/project/manager_frontend/views/logs.py b/project/manager_frontend/views/logs.py index 384b23b..0fead4b 100644 --- a/project/manager_frontend/views/logs.py +++ b/project/manager_frontend/views/logs.py @@ -2,7 +2,6 @@ Views for logs files """ from django.conf import settings -from django.shortcuts import render from django.views.generic import TemplateView class LogsView(TemplateView): diff --git a/project/manager_frontend/views/monitor.py b/project/manager_frontend/views/monitor.py index e98c351..e3f6ea9 100644 --- a/project/manager_frontend/views/monitor.py +++ b/project/manager_frontend/views/monitor.py @@ -2,7 +2,6 @@ Monitoring views """ from django.conf import settings -from django.shortcuts import render from django.views.generic import TemplateView # Compatibility support for Recalbox versions from 3.2.x to 3.3.x diff --git a/project/manager_frontend/views/roms.py b/project/manager_frontend/views/roms.py index 45e69c5..4b896ac 100644 --- a/project/manager_frontend/views/roms.py +++ b/project/manager_frontend/views/roms.py @@ -1,18 +1,19 @@ """ Views for roms """ -import json, os +import os from operator import itemgetter from django.conf import settings -from django.views.generic import TemplateView from django.core.urlresolvers import reverse from django.contrib import messages from django.http import Http404, HttpResponseBadRequest from django.utils.translation import ugettext as _ +from project.recalbox_manifest import manifest as RECALBOX_MANIFEST + from project.manager_frontend.forms.roms import RomUploadForm, RomDeleteForm -from project.utils.views import MultiFormView, JsonMixin +from project.manager_frontend.utils.views import MultiFormView, JsonMixin class RomListView(MultiFormView): @@ -42,7 +43,7 @@ def init_system(self): 'name': self.system_key }) # Get the system manifest part if any, else a default dict - self.system_manifest = settings.RECALBOX_MANIFEST.get(self.system_key, default_manifest) + self.system_manifest = RECALBOX_MANIFEST.get(self.system_key, default_manifest) def get_rom_choices(self): rom_list = [] diff --git a/project/manager_frontend/views/systems.py b/project/manager_frontend/views/systems.py index 44f0464..55e78ec 100644 --- a/project/manager_frontend/views/systems.py +++ b/project/manager_frontend/views/systems.py @@ -10,6 +10,8 @@ from django.contrib import messages from django.utils.translation import ugettext as _ +from project.recalbox_manifest import manifest as RECALBOX_MANIFEST + from project.manager_frontend.forms.systems import SystemCreateForm class SystemsListView(FormView): @@ -29,14 +31,14 @@ def get_system_list(self): # Only display directories if os.path.isdir(os.path.join(path, item)) and not item.startswith('.'): # Try to find the dirname in the system manifest - if item in settings.RECALBOX_MANIFEST: - existing_sys.append( (item, settings.RECALBOX_MANIFEST[item]['name']) ) + if item in RECALBOX_MANIFEST: + existing_sys.append( (item, RECALBOX_MANIFEST[item]['name']) ) # Unknowed dirname else: existing_sys.append( (item, item) ) # Get system available: the ones that dont allready have a directory in systems dir - for sys_key, sys_values in settings.RECALBOX_MANIFEST.items(): + for sys_key, sys_values in RECALBOX_MANIFEST.items(): if sys_key not in [v[0] for v in existing_sys]: available_sys.append( (sys_key, sys_values['name']) ) @@ -50,6 +52,7 @@ def get_context_data(self, **kwargs): context.update({ 'systems_path': settings.RECALBOX_ROMS_PATH, 'systems_list': self.existing_systems, + 'available_systems': self.available_systems, }) return context @@ -63,11 +66,8 @@ def get_form_kwargs(self): def form_valid(self, form): new_system = form.save() - ## Throw a message to tell about upload success - #if is_backuped: - #messages.success(self.request, _('File has been backuped then edited')) - #else: - #messages.success(self.request, _('File has been edited')) + # Throw a message to tell about upload success + messages.success(self.request, _('System "{}" has been created').format(new_system['name'])) return super(SystemsListView, self).form_valid(form) diff --git a/project/recalbox_manifest/__init__.py b/project/recalbox_manifest/__init__.py new file mode 100644 index 0000000..79f80a7 --- /dev/null +++ b/project/recalbox_manifest/__init__.py @@ -0,0 +1,17 @@ +""" +Recalbox manifest to know everything about supported systems +""" +import os, json +from .registry import manifest + +def autodiscover(): + """ + Dummy loader actually, this should be backward compatible for futur assets + discovery per app + """ + from django.conf import settings + from .parser import RecalboxManifestParser + # Fill the registry with the whole JSON manifest + manifest.update( + RecalboxManifestParser(settings.RECALBOX_MANIFEST_FILEPATH).read() + ) diff --git a/project/recalbox_manifest/parser.py b/project/recalbox_manifest/parser.py new file mode 100644 index 0000000..acd0251 --- /dev/null +++ b/project/recalbox_manifest/parser.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +""" +Manifest parser +""" +import json +import xml.etree.cElementTree as ET + +class RecalboxManifestParser(object): + """ + Recalbox XML manifest parser + """ + def __init__(self, filepath): + self.filepath = filepath + + def get_system_extensions(self, node): + if node.find("extensions") is None: + return [] + return [item.text for item in node.find("extensions").findall("extension")] + + def get_system_download_links(self, node): + if node.find("download_links") is None: + return [] + return [item.text for item in node.find("download_links").findall("link")] + + def get_system_bios(self, node): + if node.find("bios") is None: + return [] + return [(item.get('md5', ''), item.text) for item in node.find("bios").findall("file")] + + def get_system_extra_comments(self, node): + if node.find("extra_comments") is None: + return [] + return [item.text for item in node.find("extra_comments").findall("comment")] + + def read(self): + """ + Return the manifest as a Python dictionnary + """ + manifest = {} + + print "self.filepath:", self.filepath + + tree = ET.parse(self.filepath) + + root = tree.getroot() + + for node in root: + system_key = node.get('key') + manifest[system_key] = { + 'name': node.get('name'), + 'extensions': self.get_system_extensions(node), + 'download_links': self.get_system_download_links(node), + 'bios': self.get_system_bios(node), + 'extra_comments': self.get_system_extra_comments(node), + } + + return manifest + + def json(self): + """ + Return the manifest as a JSON string + """ + return json.dumps(self.read(), indent=4) diff --git a/project/recalbox_manifest/registry.py b/project/recalbox_manifest/registry.py new file mode 100644 index 0000000..b1fb9a3 --- /dev/null +++ b/project/recalbox_manifest/registry.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +""" +Recalbox manifest registry +""" +# Just a dummy dict waiting to be filled +manifest = {} diff --git a/project/settings.py b/project/settings.py index 293f794..97f9b54 100644 --- a/project/settings.py +++ b/project/settings.py @@ -13,7 +13,7 @@ # Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os -from utils.manifest import ManifestParser +from manager_frontend.utils.manifest import RecalboxManifestParser gettext = lambda s: s @@ -55,6 +55,7 @@ 'autobreadcrumbs', 'project.assets_cartographer', + 'project.recalbox_manifest', 'project.manager_frontend', #'ajaxuploader', @@ -151,6 +152,9 @@ os.path.join(PROJECT_DIR, "webapp_statics"), ) +# For Django messages framework to avoid database requests +MESSAGE_STORAGE = 'django.contrib.messages.storage.cookie.CookieStorage' + # For assets management ASSETS_PACKAGED = not(DEBUG) ASSETS_STRICT = False @@ -159,8 +163,6 @@ "javascripts": "assets/javascript_tag.html", "stylesheets": "assets/stylesheet_tag.html", } -# For Django messages framework, we could use this settings to avoid database requests -#MESSAGE_STORAGE = 'django.contrib.messages.storage.cookie.CookieStorage' # # Recalbox needed paths @@ -187,8 +189,5 @@ 'bios': [], } -# Recalbox manifest about system roms and bios -RECALBOX_MANIFEST = ManifestParser(RECALBOX_MANIFEST_FILEPATH).read() - # Blocking time during psutil watch for cpu charge in second (float number) RECALBOX_PSUTIL_CPU_INTERVAL = 0.5 # 0.1 seems a little too low but 1.0 add 1s on page loading time diff --git a/project/urls.py b/project/urls.py index 017c5cc..7536b29 100644 --- a/project/urls.py +++ b/project/urls.py @@ -18,12 +18,18 @@ from django.contrib import admin from django.views.generic import TemplateView +# Discover crumbs from enabled apps import autobreadcrumbs autobreadcrumbs.autodiscover() +# Load asset manifest in memory from project import assets_cartographer assets_cartographer.autodiscover() +# Load Recalbox manifest in memory +from project import recalbox_manifest +recalbox_manifest.autodiscover() + urlpatterns = [ url(r'^admin/', include(admin.site.urls)), url(r'^', include('project.manager_frontend.urls', namespace='manager')),