Merge branch 'master' into arp

Author: xrmx

.gitignore

@@ -28,9 +28,6 @@ pip-log.txt
 .tox
 nosetests.xml
 
-# Translations
-*.mo
-
 # Mr Developer
 .mr.developer.cfg
 .project

README.md

@@ -31,3 +31,26 @@ urlpatterns = [
 ```
 
 Profit!
+
+### Settings
+
+The optional MQTT integration has the following settings:
+
+```
+LABADMIN_MQTT_CONFIG = {
+    'HOSTNAME': 'localhost',
+    'PORT': 1883,
+    'AUTH': None,
+    'TLS': None,
+    'PROTOCOL': MQTTv311,
+    'TRANSPORT': 'tcp',
+}
+
+# Should we publish on MQTT each entrance
+LABADMIN_NOTIFY_MQTT_ENTRANCE = False
+
+# The MQTT topic where to publish
+LABADMIN_MQTT_ENTRANCE_TOPIC = 'labadmin/entrance'
+```
+
+See [Paho MQTT documentation](https://github.com/eclipse/paho.mqtt.python#single) for `LABADMIN_MQTT_CONFIG` values.

labAdmin/locale/en/LC_MESSAGES/django.mo

@@ -0,0 +1,18 @@
+# This file is distributed under the same license as the LabAdmin package.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: LabAdmin\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-01-31 15:06+0100\n"
+"PO-Revision-Date: 2017-01-31 14:56+0100\n"
+"Last-Translator: LabAdmin contributors\n"
+"Language-Team: English \n"
+"Language: en\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: views.py:84
+msgid "entrance"
+msgstr ""

labAdmin/locale/en/LC_MESSAGES/django.po

@@ -0,0 +1,22 @@
+# This file is distributed under the same license as the LabAdmin package.
+#
+# Translators:
+# Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>, 2017.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: LabAdmin\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-01-31 15:06+0100\n"
+"PO-Revision-Date: 2017-01-31 14:57+0100\n"
+"Last-Translator: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com\n"
+"Language-Team: Italian\n"
+"Language: it\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: views.py:84
+msgid "entrance"
+msgstr "entrata"

labAdmin/locale/it/LC_MESSAGES/django.mo

@@ -0,0 +1,7 @@
+from .settings import MQTT_CONFIG
+from paho.mqtt import publish
+
+
+def mqtt_publish(topic, payload):
+    config = {k.lower(): v for k, v in MQTT_CONFIG.items()}
+    publish.single(topic, payload, **config)

labAdmin/locale/it/LC_MESSAGES/django.po

@@ -0,0 +1,22 @@
+from django.conf import settings
+
+from paho.mqtt.client import MQTTv311
+
+
+BASE_MQTT_CONFIG = {
+    'HOSTNAME': 'localhost',
+    'PORT': 1883,
+    'AUTH': None,
+    'TLS': None,
+    'PROTOCOL': MQTTv311,
+    'TRANSPORT': 'tcp',
+}
+MQTT_CONFIG = {}
+
+
+USER_MQTT_CONFIG = getattr(settings, 'LABADMIN_MQTT_CONFIG', {})
+MQTT_ENTRANCE_NOTIFICATION = getattr(settings, 'LABADMIN_NOTIFY_MQTT_ENTRANCE', False)
+MQTT_ENTRANCE_TOPIC = getattr(settings, 'LABADMIN_MQTT_ENTRANCE_TOPIC', 'labadmin/entrance')
+
+MQTT_CONFIG = BASE_MQTT_CONFIG.copy()
+MQTT_CONFIG.update(USER_MQTT_CONFIG)

labAdmin/notifications.py

@@ -5,13 +5,13 @@
 from unittest.mock import mock_open, patch
 
 from django.contrib.auth.models import User
-from django.test import TestCase, Client
+from django.test import TestCase, Client, override_settings
 from django.urls import reverse
 from django.utils import timezone, dateparse
 
 from .models import (
     Card, Group, LogAccess, Role, TimeSlot, UserProfile,
-    LogCredits, Category, Device, LogDevice
+    LogCredits, Category, Device, LogDevice, LogError
 )
 from .arp import get_neighbours
 
@@ -135,6 +135,21 @@ def test_open_door_by_nfc(self):
         response = client.get(url, HTTP_AUTHORIZATION=auth)
         self.assertEqual(response.status_code, 405)
 
+    @override_settings(LABADMIN_NOTIFY_MQTT_ENTRANCE=True)
+    def test_open_door_by_nfc_mqtt_error_log(self):
+        client = Client()
+        auth = 'Token {}'.format(self.device.token)
+        url = reverse('open-door-nfc')
+        data = {
+            'nfc_id': self.card.nfc_id
+        }
+
+        mqtt_errors = LogError.objects.filter(description__endswith='failed to publish to mqtt')
+        self.assertFalse(mqtt_errors.exists())
+        response = client.post(url, data, format='json', HTTP_AUTHORIZATION=auth)
+        mqtt_errors = LogError.objects.filter(description__endswith='failed to publish to mqtt')
+        self.assertEqual(mqtt_errors.count(), 1)
+
     def test_get_card_credits(self):
 
         client = Client()

labAdmin/settings.py

@@ -1,5 +1,8 @@
+import json
+
 from django.http import HttpResponse, Http404
 from django.shortcuts import get_object_or_404
+from django.utils.translation import ugettext as _
 from django.db import transaction, IntegrityError
 
 from labAdmin.serializers import *
@@ -11,9 +14,14 @@
 from oauth2_provider.models import AccessToken
 
 from . import functions
+from .notifications import mqtt_publish
 from .permissions import (
     get_token_from_request, DeviceTokenPermission
 )
+from .settings import (
+    MQTT_ENTRANCE_NOTIFICATION,
+    MQTT_ENTRANCE_TOPIC
+)
 
 
 class LoginByNFC(APIView):
@@ -73,6 +81,16 @@ def post(self, request, format=None):
         else:
             utype = "other"
 
+        if MQTT_ENTRANCE_NOTIFICATION and log_access.opened:
+            payload = {
+                'user': user.name,
+                'state': _('entrance')
+            }
+            try:
+                mqtt_publish(MQTT_ENTRANCE_TOPIC, json.dumps(payload))
+            except Exception as e:
+                LogError(description="Api: Open Door By NFC - failed to publish to mqtt", code=e).save()
+
         data = {
             "users": UserProfileSerializer(users, many=True).data,
             "type": utype,