#!/bin/python
'''
File:    check_links.py
Version: Python 3.6.5
Author:  Nicholas Russo (http://njrusmc.net)
Purpose: Second-stage CI check to ensure links to both HTTP-accessible
         websites and local files embedded with HTML documents are resolvable.
         It also checks that images are resolvable, of the proper format, and
         less than a certain threshold size.
'''

import os
import sys
import imghdr
import requests
from bs4 import BeautifulSoup

def get_soup(uri):
    '''
    Given a URI of an html file (eg, ../index.html) or a hyperlink
    (eg, http://njrusmc.net), grab the HTML text and parse it into
    a beautifulsoup4 object and return it.

    Raises ValueError if the input file does not begin with 'http' or
    end with '.html'.
    '''
    print('\nRead URI    "{0}"'.format(uri))

    # If the input is a website, perform an HTTP GET. Else, it's a file.
    if uri.lower().startswith('http'):
        # Note that there are no header options here as it is assumed the
        # website being tested (ie, my own) will not require custom headers.
        response = requests.get(uri)
        html_text = response.text
    elif uri.lower().endswith('.html'):
        # Simply open the file and read the text using standard methods.
        with open(uri) as stream:
            html_text = stream.read()
    else:
        # If neither of the above are true, the input is invalid
        raise ValueError("input URI was not an HTTP link nor an HTML file")

    # Perform the parsing and store in a beautifulsoup object to be returned
    soup = BeautifulSoup(html_text, 'html.parser')
    return soup

def test_links(links, path):
    '''
    Given a list of links (URIs of HTML files or hyperlinks) and a directory
    base path for file lookups, validate the health of each link. For
    hyperlinks, perform a simple HTTP GET, optionally supplying a user-agent
    if the link contains type 'ua'. For files, ensure the file exists. These
    checks ensure that the links presented to viewers via HTML are valid
    links that will, at a minimum, result in a loaded webpage or a downloaded
    file.

    Raises HTTPError if the HTTP GET operation fails.
    Raises ValueError if the HTML file does not exist.
    '''
    for link in links:
        # Store some temporary variables to simplify future code.
        href = link.get('href')
        link_type = link.get('type')

        # Some links aren't hyperlinks or files, such as a 'mailto' link.
        # These can safely be skipped when the type of "skip" is seen.
        if link_type is not None and link_type == 'skip':
            print('  Skip link "{}"'.format(href[:70]))
            continue

        # If the link is a hyperlink, perform an HTTP GET. Else, it's a file.
        if href.lower().startswith('http'):
            print('  HTTP GET  "{}" ... '.format(href[:70]), end='')

            # Determine if a user-agent header is needed, when type is "ua".
            # Ternary operation not used here in case there are future choices.
            if link_type == 'ua':
                headers = {'user-agent': 'Mozilla/5.0'}
            else:
                headers = None
            response = requests.get(href, headers=headers)
            response.raise_for_status()
        else:
            # Assemble filename and test to see if file exists.
            filename = path + href
            print('  Is file?  "{}" ... '.format(filename[:70]), end='')
            if not os.path.isfile(filename):
                raise ValueError('"{}" is not a file'.format(filename))

        print('OK!')

def test_imgs(imgs, path):
    '''
    Like the test_links() function above, this validates that the image files
    are less than a maximum size (currently 512) and are of a specific subset
    of valid image types (currently jpeg, png, or gif). The list of images
    is a list of links with 'src' defined and the path is the directory base
    path for looking up the image files.

    Raises FileNotFoundError if the image file does not exist.
    Raises ValueError if the file is too large.
    Raises TypeError if the file is not a valid image type.
    '''
    max_image_size = 512000
    valid_img = ['jpeg', 'png', 'gif']

    for img in imgs:
        # Store some temporary variables to simplify future code.
        src = img.get('src')
        filename = path + src

        # Test to see if the image is a valid file.
        print('  Is image? "{}" ... '.format(filename[:70]), end='')
        if not os.path.isfile(filename):
            raise FileNotFoundError('"{}" is not an file'.format(filename))

        # Test to see if the image is less than the maximum allowed size.
        img_size = os.path.getsize(filename)
        if img_size > max_image_size:
            raise ValueError('"{0}" too big: {1}B'.format(filename, img_size))

        # Test to see if the image is in one of the acceptable image formats.
        img_type = imghdr.what(filename)
        if not img_type or not img_type in valid_img:
            raise TypeError('Image "{0}" is invalid'.format(filename))

        print('OK!')

def main(argv):
    '''
    Execution begin here based on CLI arguments. A single CLI argument is
    required, which is the URI to check. Typically this is a website
    (eg, http://njrusmc.net) or an HTML file (eg, ../index.html).
    '''
    if len(argv) != 2:
        print('usage: python check_links.py "<uri>"')
        sys.exit(1)

    # Print the CLI argument back for logging purposes.
    uri = sys.argv[1]
    print('CLI input   "{}"'.format(uri))

    # Determine the directory path one level up from where this script is.
    # That is where the index.html file should be, and all the sub directories.
    dirpath = os.path.dirname(os.path.dirname(os.path.realpath(__file__))) + '/'
    if not os.path.isdir(dirpath):
        print('{} is not a directory'.format(dirpath))

    # Parse the user input URI and grab all the links. The front page does
    # not have any images which reduces loading time.
    links = get_soup(uri).find_all('a')

    for link in links:
        # Store some temporary variables to improve readability. Note that
        # the soup object is only created once and is referenced multiple
        # times below (for links and images).
        href = link.get('href')
        soup = get_soup(dirpath + href)
        subdirpath = '{0}{1}/'.format(dirpath, os.path.dirname(href))

        # Scan the HTML data from each subpath and check the link validity.
        sublinks = soup.find_all('a')
        test_links(sublinks, subdirpath)

        # Scan the HTML data from each subpath and check the image validity.
        images = soup.find_all('img')
        test_imgs(images, subdirpath)

# Execute the main() function only when this file is called directly.
if __name__ == "__main__":
    main(sys.argv)
#
# EOF