feat: Notifications mailing system

devops/lms.yml

@@ -29,6 +29,25 @@ services:
       - ./rabbitmq.cookie:/var/lib/rabbitmq/.erlang.cookie
     networks:
       - lms
+
+  utils:
+    image: lms:latest
+    command: celery -A lms.utils worker
+    volumes:
+      - ../lms/utils/:/app_dir/lms/utils/
+    environment:
+      - CELERY_RABBITMQ_ERLANG_COOKIE=AAVyo5djdSMGIZXiwEQs3JeVaBx5l14z
+      - CELERY_RABBITMQ_DEFAULT_USER=rabbit-user
+      - CELERY_RABBITMQ_DEFAULT_PASS=YgKlCvnYVzpTa3T9adG3NrMoUNe4Z5aZ
+      - CELERY_UTILS_VHOST=utils
+      - CELERY_RABBITMQ_HOST=rabbitmq
+      - CELERY_RABBITMQ_PORT=5672
+    links:
+      - rabbitmq
+    depends_on:
+      - rabbitmq
+    networks:
+      - lms
 
   checks-sandbox:
     image: lms:latest
@@ -78,6 +97,7 @@ services:
       - CELERY_RABBITMQ_ERLANG_COOKIE=AAVyo5djdSMGIZXiwEQs3JeVaBx5l14z
       - CELERY_RABBITMQ_DEFAULT_USER=rabbit-user
       - CELERY_RABBITMQ_DEFAULT_PASS=YgKlCvnYVzpTa3T9adG3NrMoUNe4Z5aZ
+      - CELERY_UTILS_VHOST=utils
       - CELERY_CHECKS_PUBLIC_VHOST=lmstests-public
       - CELERY_CHECKS_SANDBOX_VHOST=lmstests-sandbox
       - CELERY_RABBITMQ_HOST=rabbitmq

lms/lmsdb/bootstrap.py

@@ -255,6 +255,18 @@ def _add_uuid_to_users_table(table: Model, _column: Field) -> None:
             user.save()
 
 
+def _add_mail_subscription_to_users_table(
+    table: Model, _column: Field,
+) -> None:
+    log.info(
+        'Adding mail subscription for users, might take some extra time...',
+    )
+    with db_config.database.transaction():
+        for user in table:
+            user.mail_subscription = True
+            user.save()
+
+
 def _api_keys_migration() -> bool:
     User = models.User
     _add_not_null_column(User, User.api_key, _add_api_keys_to_users_table)
@@ -309,6 +321,13 @@ def _uuid_migration() -> bool:
     return True
 
 
+def _mail_subscription() -> bool:
+    User = models.User
+    _add_not_null_column(
+        User, User.mail_subscription, _add_mail_subscription_to_users_table,
+    )
+
+
 def _assessment_migration() -> bool:
     Solution = models.Solution
     _add_not_null_column(Solution, Solution.assessment)
@@ -328,6 +347,7 @@ def main():
             _api_keys_migration()
             _last_course_viewed_migration()
             _uuid_migration()
+            _mail_subscription()
 
         if models.database.table_exists(models.UserCourse.__name__.lower()):
             _add_user_course_constaint()

lms/lmsdb/models.py

@@ -172,6 +172,7 @@ class User(UserMixin, BaseModel):
     api_key = CharField()
     last_course_viewed = ForeignKeyField(Course, null=True)
     uuid = UUIDField(default=uuid4, unique=True)
+    mail_subscription = BooleanField(default=True)
 
     def get_id(self):
         return str(self.uuid)
@@ -375,6 +376,29 @@ def on_notification_saved(
         instance.delete_instance()
 
 
+class NotificationMail(BaseModel):
+    user = ForeignKeyField(User, unique=True)
+    number = IntegerField(default=1)
+    message = TextField()
+
+    @classmethod
+    def get_or_create_notification_mail(cls, user: User, message: str):
+        instance, created = cls.get_or_create(**{
+            cls.user.name: user,
+        }, defaults={
+            cls.message.name: message,
+        })
+        if not created:
+            instance.message += f'\n{message}'
+            instance.number += 1
+            instance.save()
+        return instance
+
+    @classmethod
+    def get_instances_number(cls):
+        return cls.select(fn.Count(cls.id))
+
+
 class Exercise(BaseModel):
     subject = CharField()
     date = DateTimeField()

lms/lmsweb/__init__.py

@@ -3,6 +3,7 @@
 import typing
 
 from flask import Flask
+from flask_apscheduler import APScheduler  # type: ignore
 from flask_babel import Babel  # type: ignore
 from flask_httpauth import HTTPBasicAuth
 from flask_limiter import Limiter  # type: ignore
@@ -48,6 +49,9 @@
 
 webmail = Mail(webapp)
 
+webscheduler = APScheduler(app=webapp)
+webscheduler.start()
+
 
 # Must import files after app's creation
 from lms.lmsdb import models  # NOQA: F401, E402, I202

lms/lmsweb/config.py.example

@@ -65,6 +65,10 @@ LOCALE = 'en'
 LIMITS_PER_MINUTE = 5
 LIMITS_PER_HOUR = 50
 
+# Scheduler
+SCHEDULER_API_ENABLED = True
+DEFAULT_DO_TASKS_EVERY_HOURS = 2
+
 # Change password settings
 MAX_INVALID_PASSWORD_TRIES = 5
 

lms/lmsweb/translations/he/LC_MESSAGES/messages.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version:  1.0\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2021-10-03 22:01+0300\n"
+"POT-Creation-Date: 2021-10-05 21:56+0300\n"
 "PO-Revision-Date: 2021-09-29 11:30+0300\n"
 "Last-Translator: Or Ronai\n"
 "Language: he\n"
@@ -293,7 +293,7 @@ msgstr "חמ\"ל תרגילים"
 msgid "Name"
 msgstr "שם"
 
-#: templates/status.html:13 templates/user.html:44
+#: templates/status.html:13 templates/user.html:49
 msgid "Checked"
 msgstr "נבדק/ו"
 
@@ -341,27 +341,31 @@ msgstr "פרטי משתמש"
 msgid "Actions"
 msgstr "פעולות"
 
-#: templates/user.html:24
+#: templates/user.html:23
+msgid "Mail Subscription"
+msgstr "מנוי לדואר"
+
+#: templates/user.html:30
 msgid "Exercises Submitted"
 msgstr "תרגילים שהוגשו"
 
-#: templates/user.html:29
+#: templates/user.html:35
 msgid "Course name"
 msgstr "שם קורס"
 
-#: templates/user.html:30
+#: templates/user.html:36
 msgid "Exercise name"
 msgstr "שם תרגיל"
 
-#: templates/user.html:31
+#: templates/user.html:37
 msgid "Submission status"
 msgstr "מצב הגשה"
 
-#: templates/user.html:32
+#: templates/user.html:38
 msgid "Submission"
 msgstr "הגשה"
 
-#: templates/user.html:33
+#: templates/user.html:39
 msgid "Checker"
 msgstr "בודק"
 
@@ -465,12 +469,12 @@ msgstr "הערות בודק"
 msgid "Done Checking"
 msgstr "סיום בדיקה"
 
-#: utils/mail.py:25
+#: utils/mail.py:28
 #, python-format
 msgid "Confirmation mail - %(site_name)s"
 msgstr "מייל אימות - %(site_name)s"
 
-#: utils/mail.py:32
+#: utils/mail.py:35
 #, python-format
 msgid ""
 "Hello %(fullname)s,\n"
@@ -479,12 +483,12 @@ msgstr ""
 "שלום %(fullname)s,\n"
 "לינק האימות שלך למערכת הוא: %(link)s"
 
-#: utils/mail.py:42
+#: utils/mail.py:45
 #, python-format
 msgid "Reset password mail - %(site_name)s"
 msgstr "מייל איפוס סיסמה - %(site_name)s"
 
-#: utils/mail.py:49
+#: utils/mail.py:52
 #, python-format
 msgid ""
 "Hello %(fullname)s,\n"
@@ -493,12 +497,12 @@ msgstr ""
 "שלום %(fullname)s,\n"
 "לינק לצורך איפוס הסיסמה שלך הוא: %(link)s"
 
-#: utils/mail.py:58
+#: utils/mail.py:61
 #, python-format
 msgid "Changing password - %(site_name)s"
 msgstr "שינוי סיסמה - %(site_name)s"
 
-#: utils/mail.py:62
+#: utils/mail.py:65
 #, python-format
 msgid ""
 "Hello %(fullname)s. Your password in %(site_name)s site has been changed."
@@ -510,3 +514,15 @@ msgstr ""
 "אם אתה לא עשית את זה צור קשר עם הנהלת האתר.\n"
 "כתובת המייל: %(site_mail)s"
 
+#: utils/mail.py:77
+#, fuzzy, python-format
+msgid "New notification - %(site_name)s"
+msgstr "התראה חדשה - %(site_name)s"
+
+#: utils/mail.py:81
+#, python-format
+msgid ""
+"Hello %(fullname)s. You have %(number)d new notification/s:\n"
+"%(message)s"
+msgstr "היי %(fullname)s. יש לך %(number)d התראה/ות חדשה/ות:\n%(message)s"
+

lms/lmsweb/views.py

@@ -35,7 +35,7 @@
     PERMISSIVE_CORS, get_next_url, login_manager,
 )
 from lms.models import (
-    comments, notes, notifications, share_link, solutions, upload,
+    comments, notes, notifications, share_link, solutions, upload, users,
 )
 from lms.models.errors import (
     FileSizeError, ForbiddenPermission, LmsError,
@@ -370,6 +370,12 @@ def read_all_notification():
     return jsonify({'success': success_state})
 
 
+@webapp.route('/subscribe/<act>', methods=['PATCH'])
+def mail_subscription(act: str):
+    success_state = users.change_mail_subscription(current_user, act)
+    return jsonify({'success': success_state})
+
+
 @webapp.route('/share', methods=['POST'])
 @login_required
 def share():

lms/models/notifications.py

@@ -1,7 +1,7 @@
 import enum
 from typing import Iterable, Optional
 
-from lms.lmsdb.models import Notification, User
+from lms.lmsdb.models import Notification, NotificationMail, User
 
 
 class NotificationKind(enum.Enum):
@@ -45,6 +45,8 @@ def send(
         related_id: Optional[int] = None,
         action_url: Optional[str] = None,
 ) -> Notification:
-    return Notification.send(
+    notification = Notification.send(
         user, kind.value, message, related_id, action_url,
     )
+    NotificationMail.get_or_create_notification_mail(user, message)
+    return notification

lms/models/users.py

@@ -38,3 +38,14 @@ def auth(username: str, password: str) -> User:
 
 def generate_user_token(user: User) -> str:
     return SERIALIZER.dumps(user.mail_address, salt=retrieve_salt(user))
+
+
+def change_mail_subscription(user: User, act: str):
+    if act == 'subscribe':
+        user.mail_subscription = True
+    elif act == 'unsubscribe':
+        user.mail_subscription = False
+    else:
+        return False
+    user.save()
+    return True

lms/static/my.css

@@ -857,6 +857,12 @@ code .grader-add .fa {
   margin-bottom: 5em;
 }
 
+.mail-subscription {
+  position: relative;
+  display: inline-block;
+  margin-right: -1.4rem;
+}
+
 .user-notes {
   display: flex;
   flex-flow: row wrap;

lms/static/my.js

@@ -118,6 +118,20 @@ function trackReadAllNotificationsButton(button) {
   });
 }
 
+function trackMailSubscriptionCheckbox() {
+  const checkbox = document.getElementById('mail-subscription-checkbox');
+  if (checkbox === null) {
+    return;
+  }
+
+  checkbox.addEventListener('change', (e) => {
+    const act = (e.currentTarget.checked) ? 'subscribe' : 'unsubscribe';
+    const request = new XMLHttpRequest();
+    request.open('PATCH', `/subscribe/${act}`);
+    return request.send();
+  });
+}
+
 function postUploadMessageUpdate(feedbacks, uploadStatus, matchesSpan, missesSpan) {
   const matches = uploadStatus.exercise_matches;
   const misses = uploadStatus.exercise_misses;
@@ -158,6 +172,7 @@ window.isUserGrader = isUserGrader;
 window.addEventListener('load', () => {
   updateNotificationsBadge();
   trackReadAllNotificationsButton(document.getElementById('read-notifications'));
+  trackMailSubscriptionCheckbox();
   const codeElement = document.getElementById('code-view');
   if (codeElement !== null) {
     const codeElementData = codeElement.dataset;

lms/templates/user.html

@@ -17,6 +17,12 @@ <h2>{{ _('Actions') }}:</h2>
         <div id="change-password-user">
           <ul>
             <li><a href="{{ url_for('change_password') }}" role="button">{{ _('Change Password') }}</a></li>
+            <div class="form-check mail-subscription">
+              <input class="form-check-input" type="checkbox" value="" id="mail-subscription-checkbox"{% if current_user.mail_subscription %} checked{% endif %}>
+              <label class="form-check-label" for="mail-subscription-checkbox">
+                {{ _('Mail Subscription') }}
+              </label>
+            </div>
           </ul>
         </div>
       </div>

lms/utils/__init__.py

@@ -0,0 +1,5 @@
+from lms.utils.config import celery
+
+celery_app = celery.app
+
+__all__ = ('celery_app',)

lms/utils/config/__init__.py

@@ -0,0 +1,5 @@
+from lms.utils.config import celery
+
+celery_app = celery.app
+
+__all__ = ('celery_app',)