Skip to content

Dismissible GlobalMessage #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion oioioi/globalmessage/admin.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
from django.forms import ModelForm
from django.http import HttpRequest
from django.urls import re_path, reverse
from django.utils.translation import gettext_lazy as _

from oioioi.base import admin
from oioioi.base.permissions import is_superuser
from oioioi.globalmessage.models import GlobalMessage


class GlobalMessageAdmin(admin.ModelAdmin):
fieldsets = [
(None, {'fields': ['enabled', 'message']}),
Expand Down Expand Up @@ -33,6 +34,10 @@ def get_urls(self):

return custom_urls + urls

def save_model(self, request: HttpRequest, obj: GlobalMessage, form: ModelForm, change: bool) -> None:
obj.updated = request.timestamp
return super().save_model(request, obj, form, change)


admin.site.register(GlobalMessage, GlobalMessageAdmin)

Expand Down
20 changes: 20 additions & 0 deletions oioioi/globalmessage/migrations/0002_globalmessage_updated.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Generated by Django 4.2.11 on 2024-10-21 20:48

import django
from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('globalmessage', '0001_initial'),
]

operations = [
migrations.AddField(
model_name='globalmessage',
name='updated',
field=models.DateTimeField(default=django.utils.timezone.now, verbose_name='updated'),
preserve_default=False,
),
]
1 change: 1 addition & 0 deletions oioioi/globalmessage/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class GlobalMessage(models.Model):
enabled = models.BooleanField(default=False, verbose_name=_("enabled"))
start = models.DateTimeField(null=True, blank=True, verbose_name=_("start"))
end = models.DateTimeField(null=True, blank=True, verbose_name=_("end"))
updated = models.DateTimeField(null=False, blank=False, verbose_name=_("updated"))

def visible(self, timestamp):
return (
Expand Down
6 changes: 4 additions & 2 deletions oioioi/globalmessage/processors.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ def global_message_processor(request):
if message.visible(time):
return {
'extra_body_global_message': render_to_string(
'global-message-user.html', {'global_message': message}
'global-message-user.html',
{'global_message': message, 'updated': message.updated.strftime('%s')},
),
'extra_admin_global_message': render_to_string(
'global-message-admin.html', {'global_message': message}
'global-message-admin.html',
{'global_message': message, 'updated': message.updated.strftime('%s')},
),
}

Expand Down
4 changes: 2 additions & 2 deletions oioioi/globalmessage/templates/global-message-admin.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div id="global-message-admin" class="full-bootstrap">
<div id="global-message-admin" class="full-bootstrap" data-updated="{{ updated }}">
{% include "global-message.html" %}
</div>
</div>
4 changes: 2 additions & 2 deletions oioioi/globalmessage/templates/global-message-user.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div id="global-message-user">
<div id="global-message-user" data-updated="{{ updated }}">
{% include "global-message.html" %}
</div>
</div>
33 changes: 32 additions & 1 deletion oioioi/globalmessage/templates/global-message.html
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
<div class="alert alert-info">{{ global_message }}</div>
<div class="alert alert-info">
<button type="button" class="close" aria-label="Close" id="global-message-close" style="display:none;">
<span aria-hidden="true">×</span>
</button>
{{ global_message|safe }}
</div>
<script>
(() => {
const $globalMsgClose = document.getElementById("global-message-close");
const $globalMsgRoot =
document.getElementById("global-message-user") ||
document.getElementById("global-message-admin");
if ($globalMsgClose == null) {
throw new Error("No GlobalMessage close button found");
}
if ($globalMsgRoot == null) {
throw new Error("No GlobalMessage root element found");
}
$globalMsgClose.style.display = "";
const globalMsgData = localStorage.getItem("globalmessage_dismissed");
if (globalMsgData === $globalMsgRoot.dataset.updated) {
$globalMsgRoot.style.display = "none";
}
$globalMsgClose.addEventListener("click", (e) => {
$globalMsgRoot.style.display = "none";
localStorage.setItem(
"globalmessage_dismissed",
$globalMsgRoot.dataset.updated,
);
});
})();
</script>
Loading