commit 4184203867abc25445dd3bc52511cad9c86c3a2f
parent 5211eb4e9236eb14f3dbfa57b3d8e960bb0f98bd
Author: Oscar Benedito <oscar@oscarbenedito.com>
Date: Fri, 4 Sep 2020 19:32:41 +0200
AUN now works with any Moodle instance
Variables have also been simplified a bit.
Diffstat:
2 files changed, 103 insertions(+), 105 deletions(-)
diff --git a/atenea-updates-notifications.py b/atenea-updates-notifications.py
@@ -1,105 +0,0 @@
-#!/usr/bin/env python3
-# Atenea Updates Notifications
-# Copyright (C) 2020 Oscar Benedito <oscar@oscarbenedito.com>
-# Copyright (C) 2020 Ernesto Lanchares <e.lancha98@gmail.com>
-# Copyright (C) 2020 Ferran López <flg@tuta.io>
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <https://www.gnu.org/licenses/>.
-
-# Get notified when new documents are uploaded to Atenea (an instance of
-# Moodle). Makes use of a Gotify server.
-#
-# The script assumes there is a file name "aun_config.json" with the
-# configuration. Example:
-#
-# {
-# "notification_domain": "<gotify-domain>",
-# "time_interval": 120,
-# "api_token": "<moodle-api-token>",
-# "notification_token": "<gotify-token>",
-# "course_ids": {
-# "56145": "GD",
-# "56152": "EDPS"
-# }
-# }
-
-
-import os
-import requests
-import json
-import time
-
-
-with open(os.path.join(os.path.dirname(os.path.realpath(__file__)), 'aun_config.json'), 'r') as f:
- CONFIG = json.load(f)
-
-
-NOTIFICATION_DOMAIN = CONFIG['notification_domain']
-TIME_INTERVAL = CONFIG['time_interval']
-COURSE_IDS = CONFIG['course_ids']
-API_TOKEN = CONFIG['api_token']
-NOTIFICATION_TOKEN = CONFIG['notification_token']
-
-
-def get_updates(id):
- parameters = {
- 'wstoken': API_TOKEN,
- 'moodlewsrestformat': 'json',
- 'wsfunction': 'core_course_get_updates_since',
- 'courseid': id,
- 'since': int(time.time()) - (TIME_INTERVAL + 20)
- }
- response = requests.get('https://atenea.upc.edu/webservice/rest/server.php', params=parameters)
- return response.json()['instances']
-
-
-def get_course_docs(id):
- parameters = {
- 'wstoken': API_TOKEN,
- 'moodlewsrestformat': 'json',
- 'wsfunction': 'core_course_get_contents',
- 'courseid': id,
- }
- return requests.get('https://atenea.upc.edu/webservice/rest/server.php', params=parameters)
-
-
-def find_document(docs, doc_id):
- for module in docs:
- for doc in module['modules']:
- if doc['id'] == doc_id:
- return doc
-
-
-def send_notification(doc, course_name):
- if doc['modname'] == 'resource':
- message = 'URL: ' + doc['contents'][0]['fileurl'] + '&token=' + API_TOKEN
- else:
- message = doc['modplural']
-
- data = {
- 'title': course_name + ': ' + doc['name'],
- 'message': message,
- 'priority': 5
- }
- requests.post('https://' + NOTIFICATION_DOMAIN + '/message?token=' + NOTIFICATION_TOKEN, data = data)
-
-for id, course_name in COURSE_IDS.items():
- updates = get_updates(id)
-
- if updates != []:
- course_docs = get_course_docs(id)
-
- for update in updates:
- doc = find_document(course_docs.json(), update['id'])
- send_notification(doc, course_name)
diff --git a/moodle-updates-notifications.py b/moodle-updates-notifications.py
@@ -0,0 +1,103 @@
+#!/usr/bin/env python3
+# Moodle Updates Notifications
+# Copyright (C) 2020 Oscar Benedito <oscar@oscarbenedito.com>
+# Copyright (C) 2020 Ernesto Lanchares <e.lancha98@gmail.com>
+# Copyright (C) 2020 Ferran López <flg@tuta.io>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+# Get notified when new documents are uploaded to a Moodle instance. Makes use
+# of a Gotify server.
+#
+# The script assumes there is a file on the same directory named
+# "mun_config.json" with the configuration. Example configuration file:
+#
+# {
+# "moodle_domain": "my.moodle.domain",
+# "gotify_domain": "my.gotify.domain",
+# "time_interval": 120,
+# "moodle_api_token": "myMoodleAPIToken",
+# "gotify_token": "myGotifyToken",
+# "course_ids": {
+# "56145": "GD",
+# "56152": "EDPS"
+# }
+# }
+#
+# Note: the script assumes Moodle's web service is found at
+# https://moodle_domain/webservice
+# If that is not the case, change the moodle_domain variable so that it does.
+
+
+import os
+import requests
+import json
+import time
+
+
+with open(os.path.join(os.path.dirname(os.path.realpath(__file__)), 'mun_config.json'), 'r') as f:
+ cg = json.load(f)
+
+
+def get_updates(id):
+ parameters = {
+ 'wstoken': cg['moodle_api_token'],
+ 'moodlewsrestformat': 'json',
+ 'wsfunction': 'core_course_get_updates_since',
+ 'courseid': id,
+ 'since': int(time.time()) - (cg['time_interval'] + 20)
+ }
+ response = requests.get('https://' + cg['moodle_domain'] + '/webservice/rest/server.php', params=parameters)
+ return response.json()['instances']
+
+
+def get_course_docs(id):
+ parameters = {
+ 'wstoken': cg['moodle_api_token'],
+ 'moodlewsrestformat': 'json',
+ 'wsfunction': 'core_course_get_contents',
+ 'courseid': id,
+ }
+ return requests.get('https://' + cg['moodle_domain'] + '/webservice/rest/server.php', params=parameters)
+
+
+def find_document(docs, doc_id):
+ for module in docs:
+ for doc in module['modules']:
+ if doc['id'] == doc_id:
+ return doc
+
+
+def send_notification(doc, course_name):
+ if doc['modname'] == 'resource':
+ message = 'URL: ' + doc['contents'][0]['fileurl'] + '&token=' + cg['moodle_api_token']
+ else:
+ message = doc['modplural']
+
+ data = {
+ 'title': course_name + ': ' + doc['name'],
+ 'message': message,
+ 'priority': 5
+ }
+ requests.post('https://' + cg['gotify_domain'] + '/message?token=' + cg['gotify_token'], data = data)
+
+for id, course_name in cg['course_ids'].items():
+ updates = get_updates(id)
+
+ if updates != []:
+ course_docs = get_course_docs(id)
+
+ for update in updates:
+ doc = find_document(course_docs.json(), update['id'])
+ send_notification(doc, course_name)
