WAN_Checker.py

#! /usr/bin/python3
"""
@author Patrick Shinn

This program is set up for all operating systems by setting adjustment.
If run on Linux, please add the following to the very top of the file:
#! /usr/bin/python3
This program is a wan checker for a server that will email me with the new IP address anytime
the server IP changes. This is setup to use a gmail server. It will then add theses changes to
the NextCloud config.php file. Use the setup.py file to generate settings before using this program.
"""
from time import sleep
import datetime
import smtplib
import os
import socket
import ipgetter

# initial variables
done = False  # universal boolean for loops
now = datetime.datetime.now()
old = ''  # stores old wan

# Reading settings file, applying settings, and preparing status file
settingsList = []
settingsFile = os.path.join(os.path.dirname(os.path.abspath(__file__)), "settings.txt")
settingsFile = settingsFile.strip('\n\t')
statusFile = os.path.join(os.path.dirname(os.path.abspath(__file__)), "status.txt")
statusFile = statusFile.strip('\n\t')
settings = open(settingsFile, 'r')
for setting in settings:
    if setting.startswith('#'):
        pass
    else:
        setting = setting.rstrip('\n')
        settingsList.append(setting)

# Settings
#############################################################################################

# File locations
phpFile = settingsList[0]           # path to NextCloud config.php
old_ip_location = settingsList[2]    # path to old wan file
logFile = settingsList[1]           # path to log file

# Email Settings
TO = settingsList[3]                # email recipient
FROM = settingsList[4]              # sender email
SUBJECT = settingsList[6]           # email subject
PASSWORD = settingsList[5]          # sender email
EMAIL_SERVER = settingsList[7]      # server address
PORT_NUMBER = settingsList[8]       # server port number
IP_TYPE = settingsList[9]           # ip tracking type, local or WAN
# End Settings
#############################################################################################

# Files opened
old_ip = open(old_ip_location, 'r')  # file containing the old WAN IP
log = open(logFile, 'a')          # log file

# Function definitions for this program
############################################################################################


def ip_check(ip_type, log_file):
    """
    :param ip_type: integer value representing the current ip type to track.
    :param log_file: file used to log errors that occur during wan dig
    :return: returns the current ip
    """
    read = ''  # stores read from loop.
    while not done:  # continues until IP can be procured
        # sends dig command to command line, reads it, then converts it to string removing all new lines, tabs

        if int(ip_type) == 1:  # if we are tracking a local IP
            s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
            s.connect(("8.8.8.8", 80))
            read = s.getsockname()[0]
            s.close()
        else:             # if we are tracking a WAN IP
            read = ipgetter.myip()
        read = str(read)
        read = read.strip("\n\t")
        # catches the listed errors and retries or returns the correct WAN IP.
        if read == ';; connection timed out; no servers could be reached':
            log_file.write('WAN Error: ' + str(read) + ' reattempting. \n')
            sleep(5)
            continue
        elif read == ' ;; connection timed out; no servers could be reached':
            log_file.write('WAN Error: ' + str(read) + ' reattempting. \n')
            sleep(5)
            continue
        elif read == '':
            log_file.write('WAN Error: ' + str(read) + ' reattempting. \n')
            sleep(5)
            continue
        elif read == "dig: couldn't get address for 'ns1.google.com': not found":
            log_file.write('WAN Error: ' + str(read) + ' reattempting. \n')
            sleep(5)
            continue
        elif read == ' ':
            log_file.write('WAN Error: ' + str(read) + ' reattempting. \n')
            sleep(5)
            continue
        else:
            break
    return read


def php_config(current_ip, php_location):
    """
    :param current_ip: ip to be written to NextCloud config.php
    :param php_location: path to NextCloud config.php
    """
    line_number = 0  # starting line number
    line_store = []  # stores lines to write to config.php
    current_ip = current_ip.strip('\n"')
    config = open(php_location, 'r')  # read the current config.php
    for line in config:
        if line_number != 8:
            line_store.append(line)  # if not line 8, copy lines verbatim to line_store for rewriting
        else:
            line_store.append("    1 => '" + current_ip + "'," + '\n')  # replace this line with the new IP address
        line_number += 1
    config.close()
    config_rewrite = open(php_location, 'w+')
    for line in line_store:
        config_rewrite.write(line)
    config_rewrite.close()


def send_mail(log_txt, current_ip, sender, recipient, sub, password, server_address, server_port, status_file):
    """
    :param log_txt: log for errors
    :param current_ip: what the ip to be sent is
    :param sender: sender email address
    :param recipient: receiving email address
    :param sub: subject of email
    :param password: password of sender email
    :param server_address: address of the server
    :param server_port: server port being used
    :param status_file: email status file
    :return:

    This function takes the various inputs and emails the new server ip address to the receiving address.
    If the server failed to connect within the limit, a status is written to an external file letting
    the program know that it failed to connect on the last run, so it will try again.
    """
    record = open(status_file, 'w')
    fail_send = False
    server = smtplib.SMTP(server_address, server_port)  # server to be connected to
    log_txt.write('\nThe IP changed to: ' + current_ip + ' on ' + str(now) + '\n')
    msg = 'Your IP Address has changed to: ' + current_ip
    body = '\r\n'.join([
        'To: %s' % recipient,
        'From: %s' % sender,
        'Subject: %s' % sub,
        '',
        msg])

    try:
        server.ehlo()
        server.starttls()
        server.ehlo()
        log_txt.write("Successful connection to server. \n")
    except (ConnectionError, ConnectionRefusedError, ConnectionAbortedError, ConnectionResetError) as error:
        log_txt.write("Connection to server failed: '" + str(error) + "', exiting.  Will reattempt on next run. \n")
        record.write('1')  # if the server connection failed, will try again next run
        fail_send = True  # letting the program know the message didn't send.
    if fail_send is True:
        return 0  # if the server failed to connect, no email is sent and program ends.
    else:
        record.write('0')  # if the connection was successful, the program will
        try:  # email the new ip
            server.login(sender, password)
            server.sendmail(sender, recipient, body)
            log_txt.write('The message was sent successfully. \n \n')
        except (ConnectionError, ConnectionRefusedError, ConnectionAbortedError, ConnectionResetError,
                smtplib.SMTPAuthenticationError) as error:
            # if the email is not sent, wait for 5 seconds and try again.
            log_txt.write("Message send Failure: '" + str(error) + "'. \n")

    # Closing all opened files
    log_txt.close()
    server.quit()


def status_read(status_file):
    """
    :param status_file: status file of email
    :return: email status

    Reads the status and returns a value of 1 or 0
    """
    state = ''
    status = open(status_file, 'r')
    for line in status:
        line = line.strip('\n')
        state = int(line)
    return state


# End Definitions
##############################################################################################

# Program start
new = ip_check(IP_TYPE, log)  # sets the new ip to check against.
currentState = status_read(statusFile)

for ip in old_ip:  # This iterates over the old WAN IP and appends it to the old variable.
    ip.strip('\n')
    old += ip

if new != old or currentState != 0:  # if the ip has changed or something went wrong on the last run
    # Updates the old wan to the current wan
    old_ip.close()
    old_ip = open(old_ip_location, 'w')
    old_ip.write(new)
    old_ip.close()

    # php_config function call updates owncloud config.php to accept new wan
    if phpFile.lower() == 'none':  # if the user has no php file, pass this part
        pass
    else:  # else try to use the user config to rewrite it.
        try:  # if the file is found, rewrite it
            php_config(new, phpFile)
        except FileNotFoundError:  # continue the program and send the email
            log.write("php file not found at: " + str(phpFile) + " file not updated")

    # Sends new ip to email
    send_mail(log, new, FROM, TO, SUBJECT, PASSWORD, EMAIL_SERVER, PORT_NUMBER, statusFile)
    log.close()

else:  # executes if the wan hasn't changed, do nothing.
    old_ip.close()
    log.close()