file logging mechanism

.gitignore

@@ -20,6 +20,8 @@ appointment-import/tmp.sql
 *.iml
 out
 .idea
+smash/smash.log
+
 
 .coverage
 smash/htmlcov/

smash/smash/local_settings.py.template

@@ -43,3 +43,39 @@ STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
 NEXMO_API_KEY = 'API_KEY'
 NEXMO_API_SECRET = 'API_SECRET'
 NEXMO_DEFAULT_FROM = 'Scheduling'  # the sender of the message (phone number or text)
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'file': {
+            'level': 'INFO',
+            'class': 'logging.FileHandler',
+            'filename': 'smash.log',
+            'formatter': 'verbose'
+        },
+        'console': {
+            'class': 'logging.StreamHandler',
+            'level': 'WARNING',
+            'formatter': 'simple'
+        },
+    },
+    'formatters': {
+        'verbose': {
+            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
+        },
+        'simple': {
+            'format': '%(levelname)s %(message)s'
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['file'],
+            'level': 'INFO',
+        },
+        'web': {
+            'handlers': ['file', 'console'],
+            'level': 'INFO',
+        },
+    },
+}

smash/web/auth.py

+import logging
+
 from django.contrib.auth import authenticate, login, logout
+from django.contrib.auth.signals import user_logged_in, user_logged_out, user_login_failed
+from django.dispatch import receiver
+
+logger = logging.getLogger(__name__)
 
 
 def do_login(request):
-    user = authenticate(username=request.POST.get('username', 'none'),
+    user_login = request.POST.get('username', 'none')
+    user = authenticate(username=user_login,
                         password=request.POST.get('password', 'none'))
     if user is not None:
         login(request, user)
         return True, "ok"
-    return False, "login_failed"
+    else:
+        return False, "login_failed"
 
 
 def do_logout(request):
@@ -15,3 +23,33 @@ def do_logout(request):
         logout(request)
         return True, "logout"
     return False, "logout_failed"
+
+
+# code that put in logs every successful and problematic login/logout event
+# https://stackoverflow.com/questions/37618473/how-can-i-log-both-successful-and-failed-login-and-logout-attempts-in-django
+@receiver(user_logged_in)
+def user_logged_in_callback(sender, request, user, **kwargs):
+    # to cover more complex cases:
+    # http://stackoverflow.com/questions/4581789/how-do-i-get-user-ip-address-in-django
+    ip = request.META.get('REMOTE_ADDR')
+    logger.info('login user: {user} via ip: {ip}'.format(
+        user=user,
+        ip=ip
+    ))
+
+
+@receiver(user_logged_out)
+def user_logged_out_callback(sender, request, user, **kwargs):
+    ip = request.META.get('REMOTE_ADDR')
+
+    logger.info('logout user: {user} via ip: {ip}'.format(
+        user=user,
+        ip=ip
+    ))
+
+
+@receiver(user_login_failed)
+def user_login_failed_callback(sender, credentials, **kwargs):
+    logger.warning('login failed for: {credentials}'.format(
+        credentials=credentials,
+    ))

smash/web/smash_email.py

 # coding=utf-8
 
+import logging
+
 from django.conf import settings
 from django.core.mail import EmailMessage
 
+logger = logging.getLogger(__name__)
+
 
 class EmailSender(object):
     def send_email(self, subject, body, recipients, cc_recipients=None):
@@ -23,5 +27,4 @@ class EmailSender(object):
         )
         message.content_subtype = "html"
         message.send()
-
-# send_mail(subject, "", email_from, recipient_list, cc=cc_recipients, html_message=body)
+        logger.info('Email sent. Subject: ' + subject + "; Recipients: " + recipients)

smash/web/views/appointment.py

 # coding=utf-8
+import logging
 from django.contrib import messages
 from django.shortcuts import get_object_or_404, redirect
 
@@ -10,13 +11,14 @@ APPOINTMENT_LIST_GENERIC = "GENERIC"
 APPOINTMENT_LIST_UNFINISHED = "UNFINISHED"
 APPOINTMENT_LIST_APPROACHING = "APPROACHING"
 
+logger = logging.getLogger(__name__)
+
 
 def appointments(request):
     context = {
         'approaching_list': APPOINTMENT_LIST_APPROACHING,
         'full_list': APPOINTMENT_LIST_GENERIC
     }
-
     return wrap_response(request, "appointments/index.html", context)