From 5abdcd56db16913e1b0dc0980e2cff7d45e3d9b7 Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Tue, 10 Dec 2019 13:04:04 +0100 Subject: [PATCH 1/8] Include profile context var for loggued users. --- musician/api.py | 12 +++++++++--- musician/mixins.py | 12 ++++++++++++ musician/templates/musician/base.html | 2 +- musician/views.py | 2 -- 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/musician/api.py b/musician/api.py index d712a24..55a2b73 100644 --- a/musician/api.py +++ b/musician/api.py @@ -4,6 +4,9 @@ import urllib.parse from django.conf import settings from django.urls.exceptions import NoReverseMatch +from .models import UserAccount + + DOMAINS_PATH = 'domains/' TOKEN_PATH = '/api-token-auth/' @@ -75,9 +78,12 @@ class Orchestra(object): _, output = self.request("GET", pattern_name) return output - def retreve_profile(self): - _, output = self.request("GET", 'my-account') - return output + def retrieve_profile(self): + status, output = self.request("GET", 'my-account') + if status >= 400: + raise PermissionError("Cannot retrieve profile of an anonymous user.") + return UserAccount.new_from_json(output[0]) + def verify_credentials(self): """ diff --git a/musician/mixins.py b/musician/mixins.py index 1785d98..5c65f47 100644 --- a/musician/mixins.py +++ b/musician/mixins.py @@ -46,6 +46,11 @@ class ExtendedPaginationMixin: class UserTokenRequiredMixin(UserPassesTestMixin): + """ + Checks that the request has a token that authenticates him/her. + If the user is logged adds context variable 'profile' with its information. + """ + def test_func(self): """Check that the user has an authorized token.""" token = self.request.session.get(SESSION_KEY_TOKEN, None) @@ -60,3 +65,10 @@ class UserTokenRequiredMixin(UserPassesTestMixin): return False return True + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context.update({ + 'profile': self.orchestra.retrieve_profile(), + }) + return context diff --git a/musician/templates/musician/base.html b/musician/templates/musician/base.html index 2839aee..e2c5537 100644 --- a/musician/templates/musician/base.html +++ b/musician/templates/musician/base.html @@ -59,7 +59,7 @@
diff --git a/musician/views.py b/musician/views.py index 5d7e68a..aa7ee8c 100644 --- a/musician/views.py +++ b/musician/views.py @@ -60,14 +60,12 @@ class ProfileView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) - json_data = self.orchestra.retreve_profile() try: pay_source = self.orchestra.retrieve_service_list( PaymentSource.api_name)[0] except IndexError: pay_source = {} context.update({ - 'profile': UserAccount.new_from_json(json_data[0]), 'payment': PaymentSource.new_from_json(pay_source) }) From d6a3a8f5599456321dd7d36714ad9cb2b28a0693 Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Tue, 10 Dec 2019 14:02:26 +0100 Subject: [PATCH 2/8] Code resource usage cards of the dashboard. --- musician/static/musician/css/default.css | 48 ++++++++++++++++++++++ musician/templates/musician/dashboard.html | 29 +++++++++---- musician/views.py | 32 ++++++++++++++- 3 files changed, 100 insertions(+), 9 deletions(-) diff --git a/musician/static/musician/css/default.css b/musician/static/musician/css/default.css index 23bd5b1..1d07ea0 100644 --- a/musician/static/musician/css/default.css +++ b/musician/static/musician/css/default.css @@ -172,3 +172,51 @@ h1.service-name { .service-card .card-body .service-brand i.fab { color: #9C9AA7; } + +.card.resource-usage { + border-left: 5px solid #4C426A; +} + +.card.resource-usage .progress { + height: 0.5rem; + margin-top: 0.75rem; +} + +.card.resource-usage h5.card-title { + position: relative; +} + +.card.resource-usage h5.card-title:after { + font-family: "Font Awesome 5 Free"; + font-style: normal; + font-variant: normal; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + + position: absolute; + top: 0; + right: 10px; + + color: #E8E7EB; + font-size: 2em; +} + +.card.resource-usage.resource-disk h5.card-title:after { + content: "\f0a0"; + font-weight: 900; +} + +.card.resource-usage.resource-traffic h5.card-title:after { + content: "\f362"; + font-weight: 900; +} + +.card.resource-usage.resource-mailbox h5.card-title:after { + content: "\f0e0"; + font-weight: 900; +} + +.card.resource-usage.resource-notifications h5.card-title:after { + content: "\f0f3"; + font-weight: 900; +} diff --git a/musician/templates/musician/dashboard.html b/musician/templates/musician/dashboard.html index b738440..aefea23 100644 --- a/musician/templates/musician/dashboard.html +++ b/musician/templates/musician/dashboard.html @@ -3,20 +3,33 @@ {% block content %} -

Welcome back {{ user.username }}

-

Last time you logged in was {{ user.last_login }}

+

{% trans "Welcome back" %} {{ profile.username }}

+

{% blocktrans with last_login=profile.last_login|default:"N/A" %}Last time you logged in was: {{ last_login }}{% endblocktrans %}

-
- {% for i in "1234"|make_list %} -
- Resource usage block +
+ {% for resource, usage in resource_usage.items %} +
+
+
{{ usage.verbose_name }}
+ {% include "musician/components/usage_progress_bar.html" with detail=usage %} +
{% endfor %} +
+
+
{% trans "Notifications" %}
+ {% for message in notifications %} +

{{ message }}

+ {% empty %} +

{% trans "There is no notifications at this time." %}

+ {% endfor %} +
+
-

Domains and websites

-

Little description of what to be expected...

+

{% trans "Your domains and websites" %}

+

Little description of what to be expected...

{% for domain in domains %}
diff --git a/musician/views.py b/musician/views.py index aa7ee8c..271c753 100644 --- a/musician/views.py +++ b/musician/views.py @@ -6,6 +6,7 @@ from django.http import HttpResponseRedirect from django.shortcuts import render from django.urls import reverse_lazy from django.utils.http import is_safe_url +from django.utils.translation import gettext_lazy as _ from django.views.generic.base import RedirectView, TemplateView from django.views.generic.detail import DetailView from django.views.generic.edit import FormView @@ -30,8 +31,37 @@ class DashboardView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): # TODO retrieve all data needed from orchestra raw_domains = self.orchestra.retrieve_service_list('domain') + # TODO(@slamora) update when backend provides resource usage data + resource_usage = { + 'disk': { + 'verbose_name': _('Disk usage'), + 'usage': 534, + 'total': 1024, + 'unit': 'MB', + 'percent': 50, + }, + 'traffic': { + 'verbose_name': _('Traffic'), + 'usage': 300, + 'total': 2048, + 'unit': 'MB/month', + 'percent': 25, + }, + 'mailbox': { + 'verbose_name': _('Mailbox usage'), + 'usage': 1, + 'total': 2, + 'unit': 'accounts', + 'percent': 50, + }, + } + # TODO(@slamora) update when backend supports notifications + notifications = [] + context.update({ - 'domains': raw_domains + 'domains': raw_domains, + 'resource_usage': resource_usage, + 'notifications': notifications, }) return context From 381c6f656e40f2e105ab8a1ea437e40fb35c4967 Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 12 Dec 2019 10:48:40 +0100 Subject: [PATCH 3/8] Code style of domain details card. --- musician/templates/musician/dashboard.html | 62 +++++++++++++++++----- musician/views.py | 9 ++++ 2 files changed, 57 insertions(+), 14 deletions(-) diff --git a/musician/templates/musician/dashboard.html b/musician/templates/musician/dashboard.html index aefea23..03cb6c9 100644 --- a/musician/templates/musician/dashboard.html +++ b/musician/templates/musician/dashboard.html @@ -32,22 +32,56 @@

Little description of what to be expected...

{% for domain in domains %} -
-
-

{{ domain.name }}

-
- {% for service in "123"|make_list %} -
-
-
{% cycle 'Mail' 'Mailing list' 'Databases' %}
-
- Card image cap -
-

Some quick example text to build on the card title and make up the bulk of the card's - content.

+
+
+
+
+ {{ domain.name }} +
+
+ {% trans "view configuration" %} +
+
+ {% trans "Expiration date" %}: {{ domain.expiration_date|date:"SHORT_DATE_FORMAT" }} +
+
+
+
+

{% trans "Mail" %}

+

+

+ 3 mail addresses created
+ 1 mail address left +

+
+
+

{% trans "Mail list" %}

+

+
+
+

{% trans "Databases" %}

+

+

+ 1 database created
+ 20 MB of 45MB +

+
+
+

{% trans "Software as a Service" %}

+

+

Nothing installed

+
+
+

{% trans "Disk usage" %}

+

+
+ {% include "musician/components/usage_progress_bar.html" with detail=domain.usage %} +
+
- {% endfor card %}
+ {% endfor %} + {% endblock %} diff --git a/musician/views.py b/musician/views.py index 271c753..9ce35e4 100644 --- a/musician/views.py +++ b/musician/views.py @@ -55,6 +55,15 @@ class DashboardView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): 'percent': 50, }, } + + for domain in raw_domains: + domain['usage'] = { + 'usage': 300, + 'total': 650, + 'unit': 'MB', + 'percent': 50, + } + # TODO(@slamora) update when backend supports notifications notifications = [] From 027dc365be34b04292cca0579bce385530b8d7de Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 12 Dec 2019 12:11:07 +0100 Subject: [PATCH 4/8] Code domain configuration details modal. --- musician/static/musician/css/default.css | 30 +++++++++++++++ musician/templates/musician/base.html | 1 + musician/templates/musician/dashboard.html | 45 +++++++++++++++++++++- 3 files changed, 75 insertions(+), 1 deletion(-) diff --git a/musician/static/musician/css/default.css b/musician/static/musician/css/default.css index 1d07ea0..b2fb536 100644 --- a/musician/static/musician/css/default.css +++ b/musician/static/musician/css/default.css @@ -220,3 +220,33 @@ h1.service-name { content: "\f0f3"; font-weight: 900; } + +#configDetailsModal .modal-header { + border-bottom: 0; + text-align: center; +} + +#configDetailsModal .modal-header .modal-title { + width: 100%; +} + +#configDetailsModal .modal-body { + padding-left: 4rem; + padding-right: 4rem; +} + +#configDetailsModal .modal-body label { + width: 50%; + text-align: right; + padding-right: 4%; +} + +#configDetailsModal .modal-body span { + display: inline-block; + width: 45%; +} + +#configDetailsModal .modal-footer { + border-top: 0; + justify-content: center; +} diff --git a/musician/templates/musician/base.html b/musician/templates/musician/base.html index e2c5537..9dc1ffc 100644 --- a/musician/templates/musician/base.html +++ b/musician/templates/musician/base.html @@ -93,6 +93,7 @@ + {% block extrascript %}{% endblock %} {% endblock %} diff --git a/musician/templates/musician/dashboard.html b/musician/templates/musician/dashboard.html index 03cb6c9..c6cec5a 100644 --- a/musician/templates/musician/dashboard.html +++ b/musician/templates/musician/dashboard.html @@ -39,7 +39,10 @@ {{ domain.name }}
- {% trans "view configuration" %} +
{% trans "Expiration date" %}: {{ domain.expiration_date|date:"SHORT_DATE_FORMAT" }} @@ -84,4 +87,44 @@ {% endfor %} + + +{% endblock %} +{% block extrascript %} + {% endblock %} From 07b15faf8e8a04d7e79cb4825a36598b35672cfe Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 12 Dec 2019 14:18:29 +0100 Subject: [PATCH 5/8] Support retrieving domains and its related services. --- musician/api.py | 36 ++++++++++++++++++++++++++++++++---- musician/models.py | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 4 deletions(-) diff --git a/musician/api.py b/musician/api.py index 55a2b73..0536b5c 100644 --- a/musician/api.py +++ b/musician/api.py @@ -4,7 +4,7 @@ import urllib.parse from django.conf import settings from django.urls.exceptions import NoReverseMatch -from .models import UserAccount +from .models import Domain, DatabaseService, MailService, SaasService, UserAccount DOMAINS_PATH = 'domains/' @@ -55,9 +55,11 @@ class Orchestra(object): return response.json().get("token", None) - def request(self, verb, resource, raise_exception=True): + def request(self, verb, resource, querystring=None, raise_exception=True): assert verb in ["HEAD", "GET", "POST", "PATCH", "PUT", "DELETE"] url = self.build_absolute_uri(resource) + if querystring is not None: + url = "{}?{}".format(url, querystring) verb = getattr(self.session, verb.lower()) response = verb(url, headers={"Authorization": "Token {}".format( @@ -71,11 +73,11 @@ class Orchestra(object): return status, output - def retrieve_service_list(self, service_name): + def retrieve_service_list(self, service_name, querystring=None): pattern_name = '{}-list'.format(service_name) if pattern_name not in API_PATHS: raise ValueError("Unknown service {}".format(service_name)) - _, output = self.request("GET", pattern_name) + _, output = self.request("GET", pattern_name, querystring=querystring) return output def retrieve_profile(self): @@ -84,6 +86,32 @@ class Orchestra(object): raise PermissionError("Cannot retrieve profile of an anonymous user.") return UserAccount.new_from_json(output[0]) + def retrieve_domain_list(self): + output = self.retrieve_service_list(Domain.api_name) + domains = [] + for domain_json in output: + # filter querystring + querystring = "domain={}".format(domain_json['id']) + + # retrieve services associated to a domain + domain_json['mails'] = self.retrieve_service_list( + MailService.api_name, querystring) + # TODO(@slamora): databases and sass are not related to a domain, so cannot be filtered + # domain_json['databases'] = self.retrieve_service_list(DatabaseService.api_name, querystring) + # domain_json['saas'] = self.retrieve_service_list(SaasService.api_name, querystring) + + # TODO(@slamora): update when backend provides resource disk usage data + domain_json['usage'] = { + 'usage': 300, + 'total': 650, + 'unit': 'MB', + 'percent': 50, + } + + # append to list a Domain object + domains.append(Domain.new_from_json(domain_json)) + + return domains def verify_credentials(self): """ diff --git a/musician/models.py b/musician/models.py index ba7192f..68ef088 100644 --- a/musician/models.py +++ b/musician/models.py @@ -39,6 +39,12 @@ class OrchestraModel: c.data = data return c + def __repr__(self): + return '<%s: %s>' % (self.__class__.__name__, self) + + def __str__(self): + return '%s object (%s)' % (self.__class__.__name__, self.id) + class BillingContact(OrchestraModel): param_defaults = { @@ -117,6 +123,37 @@ class DatabaseService(OrchestraModel): return super().new_from_json(data=data, users=users, usage=usage) +class Domain(OrchestraModel): + api_name = 'domain' + param_defaults = { + "id": None, + "name": None, + "records": [], + "mails": [], + "usage": {}, + } + + @classmethod + def new_from_json(cls, data, **kwargs): + records = cls.param_defaults.get("records") + if 'records' in data: + records = [DomainRecord.new_from_json(record_data) for record_data in data['records']] + + return super().new_from_json(data=data, records=records) + + def __str__(self): + return self.name + + +class DomainRecord(OrchestraModel): + param_defaults = { + "type": None, + "value": None, + } + def __str__(self): + return '<%s: %s>' % (self.type, self.value) + + class MailService(OrchestraModel): api_name = 'address' verbose_name = _('Mail addresses') From fbf12f65f22d9af29677cd3407e2edbf4ae5d9f6 Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 12 Dec 2019 14:19:39 +0100 Subject: [PATCH 6/8] Update dashboard to use retrieved domains data. --- musician/templates/musician/dashboard.html | 9 +++++++-- musician/views.py | 14 ++------------ 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/musician/templates/musician/dashboard.html b/musician/templates/musician/dashboard.html index c6cec5a..d9cbb97 100644 --- a/musician/templates/musician/dashboard.html +++ b/musician/templates/musician/dashboard.html @@ -54,7 +54,7 @@

{% trans "Mail" %}

- 3 mail addresses created
+ {{ domain.mails|length }} {% trans "mail addresses created" %}
1 mail address left

@@ -66,8 +66,13 @@

{% trans "Databases" %}

- 1 database created
+ 0 {% trans "databases created" %} + {% comment %} + + {% endcomment %}

diff --git a/musician/views.py b/musician/views.py index 9ce35e4..5b39f50 100644 --- a/musician/views.py +++ b/musician/views.py @@ -27,9 +27,7 @@ class DashboardView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) - - # TODO retrieve all data needed from orchestra - raw_domains = self.orchestra.retrieve_service_list('domain') + domains = self.orchestra.retrieve_domain_list() # TODO(@slamora) update when backend provides resource usage data resource_usage = { @@ -56,19 +54,11 @@ class DashboardView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): }, } - for domain in raw_domains: - domain['usage'] = { - 'usage': 300, - 'total': 650, - 'unit': 'MB', - 'percent': 50, - } - # TODO(@slamora) update when backend supports notifications notifications = [] context.update({ - 'domains': raw_domains, + 'domains': domains, 'resource_usage': resource_usage, 'notifications': notifications, }) From 6520798493b5e180c2d977ab0ebff6336798833e Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 12 Dec 2019 14:27:01 +0100 Subject: [PATCH 7/8] Add links to services of the domain. --- musician/templates/musician/dashboard.html | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/musician/templates/musician/dashboard.html b/musician/templates/musician/dashboard.html index d9cbb97..abee939 100644 --- a/musician/templates/musician/dashboard.html +++ b/musician/templates/musician/dashboard.html @@ -57,10 +57,12 @@ {{ domain.mails|length }} {% trans "mail addresses created" %}
1 mail address left

+

{% trans "Mail list" %}

+

{% trans "Databases" %}

@@ -74,11 +76,13 @@ --> {% endcomment %}

+

{% trans "Software as a Service" %}

Nothing installed

+

{% trans "Disk usage" %}

From e6dc5cf872f04603642b845f191ed61bf61c3db1 Mon Sep 17 00:00:00 2001 From: Santiago Lamora Date: Thu, 12 Dec 2019 15:01:51 +0100 Subject: [PATCH 8/8] Show resource usage based on plan definition. --- musician/settings.py | 14 ++++++++++++++ musician/templates/musician/dashboard.html | 7 +++++-- musician/views.py | 17 +++++++++++++++++ 3 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 musician/settings.py diff --git a/musician/settings.py b/musician/settings.py new file mode 100644 index 0000000..5581061 --- /dev/null +++ b/musician/settings.py @@ -0,0 +1,14 @@ +# allowed resources limit hardcoded because cannot be retrieved from the API. +ALLOWED_RESOURCES = { + 'INDIVIDUAL': + { + # 'disk': 1024, + # 'traffic': 2048, + 'mailbox': 2, + }, + 'ASSOCIATION': { + # 'disk': 5 * 1024, + # 'traffic': 20 * 1024, + 'mailbox': 10, + } +} diff --git a/musician/templates/musician/dashboard.html b/musician/templates/musician/dashboard.html index abee939..53c694e 100644 --- a/musician/templates/musician/dashboard.html +++ b/musician/templates/musician/dashboard.html @@ -54,8 +54,11 @@

{% trans "Mail" %}

- {{ domain.mails|length }} {% trans "mail addresses created" %}
- 1 mail address left + {{ domain.mails|length }} {% trans "mail addresses created" %} + {% if domain.address_left.alert %} +
+ {{ domain.address_left.count }} mail address left + {% endif %}

diff --git a/musician/views.py b/musician/views.py index 5b39f50..4b46dcc 100644 --- a/musician/views.py +++ b/musician/views.py @@ -20,6 +20,7 @@ from .mixins import (CustomContextMixin, ExtendedPaginationMixin, UserTokenRequiredMixin) from .models import (DatabaseService, MailinglistService, MailService, PaymentSource, SaasService, UserAccount) +from .settings import ALLOWED_RESOURCES class DashboardView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): @@ -57,6 +58,22 @@ class DashboardView(CustomContextMixin, UserTokenRequiredMixin, TemplateView): # TODO(@slamora) update when backend supports notifications notifications = [] + # show resource usage based on plan definition + # TODO(@slamora): validate concept of limits with Pangea + profile_type = context['profile'].type + for domain in domains: + address_left = ALLOWED_RESOURCES[profile_type]['mailbox'] - len(domain.mails) + alert = None + if address_left == 1: + alert = 'warning' + elif address_left < 1: + alert = 'danger' + + domain.address_left = { + 'count': address_left, + 'alert': alert, + } + context.update({ 'domains': domains, 'resource_usage': resource_usage,