@@ -48,6 +78,17 @@ $(function() {
$('.mobile-app-content iframe').attr('src', '/');
$('.mobile-app-content').addClass('splash-off');
});
+
+ $('.navigation-entries').sortable({
+ handle: '.handle',
+ update: function(event, ui) {
+ var new_order = $('.navigation-entries li').map(function() { return $(this).data('pk'); }).get().join();
+ $.ajax({
+ url: $('.navigation-entries').data('order-url'),
+ data: {'new-order': new_order}
+ });
+ }
+ });
});
diff --git a/combo/apps/pwa/templates/combo/pwa/navigation.html b/combo/apps/pwa/templates/combo/pwa/navigation.html
new file mode 100644
index 00000000..4d7a7187
--- /dev/null
+++ b/combo/apps/pwa/templates/combo/pwa/navigation.html
@@ -0,0 +1,37 @@
+{% load combo %}
+
+
diff --git a/combo/apps/pwa/templatetags/__init__.py b/combo/apps/pwa/templatetags/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/combo/apps/pwa/templatetags/pwa.py b/combo/apps/pwa/templatetags/pwa.py
new file mode 100644
index 00000000..d7a9cfdd
--- /dev/null
+++ b/combo/apps/pwa/templatetags/pwa.py
@@ -0,0 +1,36 @@
+# combo - content management system
+# Copyright (C) 2015-2018 Entr'ouvert
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see
.
+
+from django import template
+from django.conf import settings
+
+from combo.apps.pwa.models import PwaNavigationEntry
+
+
+register = template.Library()
+
+@register.simple_tag(takes_context=True)
+def pwa_navigation(context):
+ if settings.TEMPLATE_VARS.get('pwa_display') not in ('standalone', 'fullscreen'):
+ return ''
+ pwa_navigation_template = template.loader.get_template('combo/pwa/navigation.html')
+ context = {
+ 'entries': PwaNavigationEntry.objects.all(),
+ 'user': context.get('user'),
+ 'render_skeleton': context.get('render_skeleton'),
+ 'site_base': context['request'].build_absolute_uri('/')[:-1],
+ }
+ return pwa_navigation_template.render(context)
diff --git a/combo/apps/pwa/urls.py b/combo/apps/pwa/urls.py
index 766c8f2e..0c9850b3 100644
--- a/combo/apps/pwa/urls.py
+++ b/combo/apps/pwa/urls.py
@@ -20,6 +20,10 @@ from combo.urls_utils import decorated_includes, manager_required
from .manager_views import (
ManagerHomeView,
+ ManagerAddNavigationEntry,
+ ManagerEditNavigationEntry,
+ ManagerDeleteNavigationEntry,
+ manager_navigation_order,
)
from .views import (
manifest_json,
@@ -32,6 +36,18 @@ from .views import (
pwa_manager_urls = [
url('^$', ManagerHomeView.as_view(), name='pwa-manager-homepage'),
+ url('^navigation/add/$',
+ ManagerAddNavigationEntry.as_view(),
+ name='pwa-manager-navigation-add'),
+ url('^navigation/edit/(?P
\w+)/$',
+ ManagerEditNavigationEntry.as_view(),
+ name='pwa-manager-navigation-edit'),
+ url('^navigation/delete/(?P\w+)/$',
+ ManagerDeleteNavigationEntry.as_view(),
+ name='pwa-manager-navigation-delete'),
+ url('^navigation/order/$',
+ manager_navigation_order,
+ name='pwa-manager-navigation-order'),
]
urlpatterns = [
diff --git a/combo/data/utils.py b/combo/data/utils.py
index 669a9ad7..0765d8bc 100644
--- a/combo/data/utils.py
+++ b/combo/data/utils.py
@@ -22,7 +22,7 @@ from django.utils.translation import ugettext_lazy as _
from combo.apps.assets.models import Asset
from combo.apps.maps.models import MapLayer
-from combo.apps.pwa.models import PwaSettings
+from combo.apps.pwa.models import PwaSettings, PwaNavigationEntry
from .models import Page
@@ -42,6 +42,7 @@ def export_site():
'assets': Asset.export_all_for_json(),
'pwa': {
'settings': PwaSettings.export_for_json(),
+ 'navigation': PwaNavigationEntry.export_all_for_json(),
}
}
@@ -74,6 +75,7 @@ def import_site(data, if_empty=False, clean=False):
Asset.objects.all().delete()
Page.objects.all().delete()
PwaSettings.objects.all().delete()
+ PwaNavigationEntry.objects.all().delete()
with transaction.atomic():
MapLayer.load_serialized_objects(data.get('map-layers') or [])
@@ -84,5 +86,8 @@ def import_site(data, if_empty=False, clean=False):
with transaction.atomic():
Page.load_serialized_pages(data.get('pages') or [])
- with transaction.atomic():
- PwaSettings.load_serialized_settings((data.get('pwa') or {}).get('settings'))
+ if data.get('pwa'):
+ with transaction.atomic():
+ PwaSettings.load_serialized_settings(data['pwa'].get('settings'))
+ with transaction.atomic():
+ PwaNavigationEntry.load_serialized_objects(data['pwa'].get('navigation'))
diff --git a/tests/test_import_export.py b/tests/test_import_export.py
index 6f90bc36..668d3d3f 100644
--- a/tests/test_import_export.py
+++ b/tests/test_import_export.py
@@ -1,3 +1,4 @@
+import base64
import datetime
import json
import os
@@ -9,12 +10,12 @@ import pytest
from django.contrib.auth.models import Group
from django.core.files import File
from django.core.management import call_command
-from django.utils.encoding import force_bytes
+from django.utils.encoding import force_bytes, force_text
from django.utils.six import BytesIO, StringIO
from combo.apps.assets.models import Asset
from combo.apps.maps.models import MapLayer, Map
-from combo.apps.pwa.models import PwaSettings
+from combo.apps.pwa.models import PwaSettings, PwaNavigationEntry
from combo.data.models import Page, TextCell
from combo.data.utils import export_site, import_site, MissingGroups
@@ -213,3 +214,39 @@ def test_import_export_pwa_settings(app):
import_site(data=json.loads(output))
assert PwaSettings.singleton().offline_retry_button is False
assert PwaSettings.singleton().offline_text == 'Hello world'
+
+def test_import_export_pwa_navigation(app, some_data):
+ page = Page.objects.get(slug='one')
+ entry1 = PwaNavigationEntry(label='a', url='/', order=0)
+ entry2 = PwaNavigationEntry(link_page=page, order=1, icon=File(BytesIO(b'te\30st'), 'test.png'))
+ entry1.save()
+ entry2.save()
+ output = get_output_of_command('export_site')
+ import_site(data={}, clean=True)
+ assert PwaNavigationEntry.objects.all().count() == 0
+
+ import_site(data=json.loads(output))
+ assert PwaNavigationEntry.objects.all().count() == 2
+ # check identical file was not touched
+ assert os.path.basename(PwaNavigationEntry.objects.get(order=1).icon.file.name) == 'test.png'
+ assert PwaNavigationEntry.objects.get(order=1).icon.read() == b'te\30st'
+
+ # check a second import doesn't create additional entries
+ import_site(data=json.loads(output))
+ assert PwaNavigationEntry.objects.all().count() == 2
+
+ # check with a change in icon file content
+ data = json.loads(output)
+ data['pwa']['navigation'][1]['icon:base64'] = force_text(base64.encodestring(b'TEST'))
+ import_site(data=data)
+ assert PwaNavigationEntry.objects.all().count() == 2
+ assert PwaNavigationEntry.objects.get(order=1).icon.read() == b'TEST'
+
+ # check with a change in icon file name
+ data = json.loads(output)
+ data['pwa']['navigation'][1]['fields']['icon'] = 'pwa/test2.png'
+ data['pwa']['navigation'][1]['icon:base64'] = force_text(base64.encodestring(b'TEST2'))
+ import_site(data=data)
+ assert PwaNavigationEntry.objects.all().count() == 2
+ assert os.path.basename(PwaNavigationEntry.objects.get(order=1).icon.file.name) == 'test2.png'
+ assert PwaNavigationEntry.objects.get(order=1).icon.read() == b'TEST2'
diff --git a/tests/test_pwa.py b/tests/test_pwa.py
index f4fbae36..c5fc11a1 100644
--- a/tests/test_pwa.py
+++ b/tests/test_pwa.py
@@ -9,11 +9,16 @@ except ImportError:
pywebpush = None
from django.conf import settings
+from django.core.files import File
from django.core.urlresolvers import reverse
+from django.template import Context, Template
from django.test import override_settings
+from django.test.client import RequestFactory
+from django.utils.six import BytesIO
from combo.apps.notifications.models import Notification
-from combo.apps.pwa.models import PushSubscription, PwaSettings
+from combo.apps.pwa.models import PushSubscription, PwaSettings, PwaNavigationEntry
+from combo.data.models import Page
from .test_manager import login
@@ -78,6 +83,64 @@ def test_pwa_manager(app, admin_user):
assert resp.form['offline_text'].value == 'You are offline.'
assert resp.form['offline_retry_button'].checked is False
+ resp = app.get('/manage/pwa/')
+ resp = resp.click('Add a navigation entry')
+ resp.form['label'] = 'Hello'
+ resp.form['url'] = 'https://www.example.net'
+ resp = resp.form.submit().follow()
+ assert PwaNavigationEntry.objects.all().count() == 1
+
+ page = Page(title='test', slug='test')
+ page.save()
+
+ resp = resp.click('Add a navigation entry')
+ resp.form['link_page'] = page.id
+ resp = resp.form.submit().follow()
+ assert PwaNavigationEntry.objects.all().count() == 2
+
+ for i in range(3):
+ resp = resp.click('Add a navigation entry')
+ resp.form['label'] = 'Hello %s' % i
+ resp.form['url'] = 'https://www.example.net'
+ resp = resp.form.submit().follow()
+
+ # max 5 items
+ assert 'Add a navigation entry' not in resp.text
+
+ # reorder items, reverse them all
+ entries = PwaNavigationEntry.objects.all()
+ app.get('/manage/pwa/navigation/order/?new-order=%s' %
+ ','.join(reversed([str(x.id) for x in entries])))
+ entries = PwaNavigationEntry.objects.all()
+ assert entries[0].label == 'Hello 2'
+
+ # remove first item
+ resp = app.get('/manage/pwa/')
+ resp = resp.click(href='delete', index=0)
+ resp = resp.form.submit().follow()
+ assert 'Hello 2' not in resp.text
+ assert 'Add a navigation entry' in resp.text
+
+ # rename item
+ resp = resp.click('Hello 1')
+ resp.form['label'] = 'Hello 12'
+ resp = resp.form.submit().follow()
+ assert PwaNavigationEntry.objects.all()[0].label == 'Hello 12'
+
+ # check error handling
+ resp = resp.click('Hello 12')
+ resp.form['label'] = ''
+ resp.form['url'] = ''
+ resp = resp.form.submit()
+ assert 'A label is required' in resp.text
+ assert 'An URL is required' in resp.text
+
+ resp.form['url'] = 'foobar'
+ resp.form['link_page'] = page.id
+ resp = resp.form.submit()
+ assert 'An URL cannot be specified' in resp.text
+
+
def test_pwa_offline_page(app):
PwaSettings.objects.all().delete()
resp = app.get('/__pwa__/offline/')
@@ -91,3 +154,27 @@ def test_pwa_offline_page(app):
resp = app.get('/__pwa__/offline/')
assert 'You are offline.' in resp.text
assert 'Retry' not in resp.text
+
+
+def test_pwa_navigation_templatetag(app):
+ page = Page(title='One', slug='one')
+ page.save()
+ entry1 = PwaNavigationEntry(label='a', url='/', notification_count=True,
+ use_user_name_as_label=True, order=0)
+ entry2 = PwaNavigationEntry(link_page=page, order=1, icon=File(BytesIO(b'te\30st'), 'test.png'))
+ entry1.save()
+ entry2.save()
+ t = Template('{% load pwa %}{% pwa_navigation %}')
+ assert t.render(Context({})) == ''
+
+ with override_settings(TEMPLATE_VARS={'pwa_display': 'standalone'}):
+ request = RequestFactory().get('/')
+ nav = t.render(Context({'request': request}))
+ assert 'a' in nav
+ assert 'One' in nav
+ assert nav.count('background-image') == 1
+ assert nav.count('data-notification-count-url=') == 1
+ assert nav.count('data-pwa-user-name=""') == 1
+
+ nav = t.render(Context({'request': request, 'render_skeleton': True}))
+ assert 'data-pwa-user-name="{% block placeholder-user-name %}' in nav