From e1489deef88ea03a2e95d8a0fb8bd8c39a9578ee Mon Sep 17 00:00:00 2001
From: Kevin Midboe <kevin.midboe@gmail.com>
Date: Sat, 13 Jan 2024 01:55:24 +0100
Subject: [PATCH] Added logger and replaced print statements

---
 bulk_dns_update.py | 25 ++++++++++++++-----------
 logger.py          | 14 ++++++++++++++
 main.py            | 13 +++++++------
 3 files changed, 35 insertions(+), 17 deletions(-)
 create mode 100644 logger.py

diff --git a/bulk_dns_update.py b/bulk_dns_update.py
index d4d54ea..ab62cfe 100644
--- a/bulk_dns_update.py
+++ b/bulk_dns_update.py
@@ -12,6 +12,7 @@ permission: DNS:Edit for one or more zones.
 
 import re
 import requests
+from logger import logger
 
 API_KEY = ''
 
@@ -63,13 +64,13 @@ def getZones():
     data = cloudflareRequest(url)
 
     if data['success'] is False:
-        print('Request to cloudflare was unsuccessful, error:')
-        print(data['errors'])
+        logger.info('Request to cloudflare was unsuccessful, error:')
+        logger.info(data['errors'])
         raise Exception('Unexpected Cloudflare error! Check logs.')
 
     if data['result'] is None or len(data['result']) < 1:
         # TODO
-        print('no zones!')
+        logger.info('no zones!')
 
     zones = list(map(lambda zone: getZoneInfo(zone), data['result']))
     return zones
@@ -80,13 +81,13 @@ def getRecordsForZone(zoneId):
     data = cloudflareRequest(url)
 
     if data['success'] is False:
-        print('Request from cloudflare was unsuccessful, error:')
-        print(data['errors'])
+        logger.info('Request from cloudflare was unsuccessful, error:')
+        logger.info(data['errors'])
         raise Exception('Unexpected Cloudflare error! Check logs.')
 
     if data['result'] is None or len(data['result']) < 1:
         # TODO
-        print('no records!')
+        logger.info('no records!')
 
     records = list(map(lambda record: getRecordInfo(record), data['result']))
     return records
@@ -100,7 +101,7 @@ def getDDNSAddresszoneId(ddnsZone):
             continue
         return record
 
-    raise Exception('No ddns record found for zone: {}'.format(DDNS_ZONE))
+    raise Exception('No ddns record found for zone: {}'.format(ddnsZone))
 
 
 def updateRecord(zoneId, recordId, name, newIP, ttl, proxied):
@@ -114,7 +115,7 @@ def updateRecord(zoneId, recordId, name, newIP, ttl, proxied):
     }
 
     response = cloudflareUpdateRequest(url, data)
-    print('\tRecord updated: {}'.format('✅' if response['success'] is True else '❌'))
+    logger.info('\tRecord updated: {}'.format('✅' if response['success'] is True else '❌'))
 
 
 def getMatchingRecordsForZone(zoneId, oldIP):
@@ -123,22 +124,24 @@ def getMatchingRecordsForZone(zoneId, oldIP):
 
 
 def updateZone(zone, oldIP, newIP):
-    print('Updating records for {}'.format(zone['name']))
+    logger.info('Updating records for {}'.format(zone['name']))
     records = getMatchingRecordsForZone(zone['id'], oldIP)
     if len(records) < 1:
-        print('No matching records for {}\n'.format(zone['name']))
+        logger.info('No matching records for {}\n'.format(zone['name']))
         return
 
     for record in records:
-        print('\tRecord {}: {} -> {}'.format(record['name'], record['content'], newIP))
+        logger.info('\tRecord {}: {} -> {}'.format(record['name'], record['content'], newIP))
         updateRecord(zone['id'], record['id'], record['name'], newIP, record['ttl'], record['proxied'])
 
+
 def updateAllZones(oldIP, newIP):
     zones = getZones()
 
     for zone in zones:
         updateZone(zone, oldIP, newIP)
 
+
 if __name__ == '__main__':
     oldIP = input('Old IP address: ')
     newIP = input('New IP address: ')
diff --git a/logger.py b/logger.py
new file mode 100644
index 0000000..facde0f
--- /dev/null
+++ b/logger.py
@@ -0,0 +1,14 @@
+import logging
+import sys
+
+stdout_handler = logging.StreamHandler(stream=sys.stdout)
+handlers = [stdout_handler]
+
+logging.basicConfig(
+    level=logging.DEBUG, 
+    format='[%(asctime)s] %(levelname)s\t %(message)s',
+    handlers=handlers
+)
+
+logger = logging.getLogger('cloudflare-ddns')
+
diff --git a/main.py b/main.py
index 9a55304..df91c7f 100644
--- a/main.py
+++ b/main.py
@@ -2,6 +2,7 @@ import os
 import requests
 from bulk_dns_update import updateAllZones, setAPIKey, getDDNSAddresszoneId
 from dotenv import load_dotenv
+from logger import logger
 
 load_dotenv()
 
@@ -11,24 +12,24 @@ DDNS_ZONE = os.getenv('DDNS_ZONE')
 
 def publicAddress():
     global currentIP
-    print('Getting public IP from ifconfg.me...')
+    logger.info('Getting public IP from ifconfg.me...')
 
     r = requests.get('https://ifconfig.me')
     currentIP = r.text
-    print('Public IP: {}'.format(currentIP))
+    logger.info('Public IP: {}'.format(currentIP))
 
 
 def cloudflareDDNS():
-    print('Checking IP recorded in Cloudflare...')
+    logger.info('Checking IP recorded in Cloudflare...')
     ddnsRecord = getDDNSAddresszoneId(DDNS_ZONE)
     recordedIP = ddnsRecord['content']
-    print('Found ddns recorded IP: {}'.format(recordedIP))
+    logger.info('Found ddns recorded IP: {}'.format(recordedIP))
 
     if currentIP != recordedIP:
-        print('Public IP has changed, updating all A records.')
+        logger.info('Public IP has changed, updating all A records.')
         updateAllZones(recordedIP, currentIP)
     else:
-        print('is same, exiting')
+        logger.info('is same, exiting')
 
 
 def main():