pyladies_cz.py

#!/usr/bin/env python3

"""Create or serve the pyladies.cz website
"""

import sys
if sys.version_info < (3, 0):
    raise RuntimeError('You need Python 3.')

import os
import fnmatch
import datetime
from urllib.parse import urlencode
from pathlib import Path, PurePosixPath
import functools

from flask import Flask, render_template, url_for, send_from_directory, abort
from flask_frozen import Freezer
import yaml
import markdown
import markupsafe

from elsa import cli

app = Flask('pyladies_cz')
app.config['TEMPLATES_AUTO_RELOAD'] = True
app.config['TRAP_HTTP_EXCEPTIONS'] = True

orig_path = os.path.join(app.root_path, 'original/')
v1_path = os.path.join(orig_path, 'v1/')
MISSING = object()

class YamlIOException(Exception):
    pass

def redirect(url):
    """Return a response with a Meta redirect"""

    # With static pages, we can't use HTTP redirects.
    # Return a page wit <meta refresh> instead.
    #
    # When Frozen-Flask gets support for redirects
    # (https://github.com/Frozen-Flask/Frozen-Flask/issues/81),
    # this should be revisited.

    return render_template('meta_redirect.html', url=url)


########
## Views

@app.route('/')
def index():
    news = read_news_yaml('news.yml')
    return render_template('index.html', news=news)

@app.route('/<city_slug>/')
def city(city_slug):
    cities = read_yaml('cities.yml')
    city = cities.get(city_slug)
    if city is None:
        abort(404)
    meetups = read_meetups_yaml('meetups/' + city_slug + '.yml')
    current_meetups = [m for m in meetups if m['current']]
    past_meetups = [m for m in meetups if not m['current']]
    registration_meetups = [
        m for m in current_meetups if m.get('registration_status')=='running']
    return render_template(
        'city.html',
        city_slug=city_slug,
        city_title=city['title'],
        team_name=city.get('team-name'),
        newsletter=city.get('newsletter'),
        current_meetups=current_meetups,
        past_meetups=past_meetups,
        registration_meetups=registration_meetups,
        contacts=city.get('contacts'),
        team=read_yaml('teams/' + city_slug + '.yml', default=()),
    )

@app.route('/<city>_course/')
def course_redirect(city):
    return redirect(url_for('city', city_slug=city, _anchor='meetups'))

@app.route('/<city>_info/')
def info_redirect(city):
    return redirect(url_for('city', city_slug=city, _anchor='city-info'))

@app.route('/praha-cznic/')
def praha_cznic():
    return redirect('https://naucse.python.cz/2018/pyladies-praha-jaro-cznic/')

@app.route('/praha-ntk/')
def praha_ntk():
    return redirect('https://naucse.python.cz/2018/pyladies-praha-jaro-ntk/')

@app.route('/stan_se/')
def stan_se():
    return render_template('stan_se.html')

@app.route('/faq/')
def faq():
    return render_template('faq.html')

@app.route('/zpracovani_osobnich_udaju/')
def gdpr():
    return render_template('gdpr.html')

@app.route('/v1/')
@app.route('/v1/<path:path>')
def v1(path='index.html'):
    if path in REDIRECTS:
        return redirect(REDIRECTS[path])
    if path[-1] == '/':
        path += 'index.html'
    return send_from_directory(v1_path, path)

@app.route('/course.html')
def course_html():
    return send_from_directory(orig_path, 'course.html')

@app.route('/googlecc704f0f191eda8f.html')
def google_verification():
    # Verification page for GMail on our domain
    return send_from_directory(app.root_path, 'google-verification.html')


##########
## Template variables

@app.context_processor
def inject_cities():
    cities = {}
    for city_name, city_info in read_yaml('cities.yml').items():
        meetups = read_meetups_yaml(f'meetups/{city_name}.yml')
        meetups_nonpermanent = [m for m in meetups if m.get('start')]
        cities[city_name] = {
            **city_info,
            'active_registration': any(m.get('registration_status') == 'running' for m in meetups_nonpermanent),
        }
    return dict(cities=cities)


##########
## Helpers

md = markdown.Markdown(extensions=['meta', 'markdown.extensions.toc'])

@app.template_filter('markdown')
def convert_markdown(text, inline=False):
    result = markupsafe.Markup(md.convert(text))
    if inline and result[:3] == '<p>' and result[-4:] == '</p>':
        result = result[3:-4]
    return result

@app.template_filter('date_range')
def date_range(dates, sep='–'):
    start, end = dates
    pieces = []
    if start != end:
        if start.year != end.year:
            pieces.append('{d.day}. {d.month}. {d.year}'.format(d=start))
        elif start.month != end.month:
            pieces.append('{d.day}. {d.month}.'.format(d=start))
        else:
            pieces.append('{d.day}.'.format(d=start))
        pieces.append('–')
    pieces.append('{d.day}. {d.month}. {d.year}'.format(d=end))

    return ' '.join(pieces)


def read_yaml(filename, default=MISSING):
    """Read the given YAML file

    If the file is not found:
    - if default is given, return it
    - else, raise FileNotFoundError
    """

    # Reading YAML is slow, and we need info from cities.yml for every single
    # page. To avoid loading all the time, we cache the result.
    # To make the site react to changes in the files, we use the file size
    # and last-modified time as part of the cache key. If either changes,
    # the cache will be invalidated and the file will be read from disk again.

    try:
        info = os.stat(filename)
    except FileNotFoundError:
        if default is MISSING:
            raise
        return default
    return _read_yaml_cached(filename, info.st_size, info.st_mtime)


@functools.lru_cache()
def _read_yaml_cached(filename, size, mtime):
    with open(filename, encoding='utf-8') as file:
        try:
            data = yaml.safe_load(file)
        except Exception:
            err_message = f"""The YAML file '{filename}' can not be read by
            the yaml parser. Please check if the file exist or if the file is
            a valid yaml file."""
            raise YamlIOException(err_message)
    return data


def read_meetups_yaml(filename):
    data = read_yaml(filename)

    if data is None:
        # Treat an empty YAML file as no courses.
        # (Otherwise, the file would have to contain [])
        data = []

    today = datetime.date.today()

    for meetup in data:
        # 'date' means both start and end
        if 'date' in meetup:
            meetup['start'] = meetup['date']
            meetup['end'] = meetup['date']

        # Test that meetup doesn't end earlier than it starts
        start = meetup.get('start', None)
        end = meetup.get('end', None)
        # Only check further if meetup has got an end date
        if end is not None:
            # If end date is set, there must be a start date as well
            if start is None:
                raise ValueError(f"There's no start date for meetup {meetup}.")
            else:
                # If both dates are set, end must be the same as or later than start
                if end < start:
                    raise ValueError(
                        f"Start date is later than end date. Meetup: {meetup}."
                    )

        # Derive a URL for places that don't have one from the location
        if 'place' in meetup:
            if ('url' not in meetup['place']
                    and {'latitude', 'longitude'} <= meetup['place'].keys()):
                place = meetup['place']
                place['url'] = 'http://mapy.cz/zakladni?' + urlencode({
                    'y': place['latitude'],
                    'x': place['longitude'],
                    'z': '16',
                    'id': place['longitude'] + ',' + place['latitude'],
                    'source': 'coor',
                    'q': place['name'],
                })

        # Figure out the status of registration
        if 'registration' in meetup:
            if 'start' in meetup and meetup['start'] <= today:
                meetup['registration_status'] = 'meetup_started'
            elif 'end' in meetup['registration'] and meetup['registration']['end'] < today:
                meetup['registration_status'] = 'closed'
            else:
                meetup['registration_status'] = 'running'

        meetup['current'] = ('end' not in meetup) or (meetup['end'] >= today)

    return list(reversed(data))

def read_news_yaml(filename):
    data = read_yaml(filename)
    today = datetime.date.today()
    news = []

    for new in data:
        if new['expires'] >= today:
            news.append(new)

    return news

def pathto(name, static=False):
    if static:
        prefix = '_static/'
        if name.startswith(prefix):
            return url_for('static', filename=name[len(prefix):])
        prefix = 'v1/'
        if name.startswith(prefix):
            return url_for('v1', path=name[len(prefix):])
        return name
    return url_for(name)


@app.context_processor
def inject_context():
    return {
        'pathto': pathto,
        'today': datetime.date.today(),
    }


############
## Redirects

REDIRECTS_DATA = read_yaml('redirects.yml')

REDIRECTS = {}
for directory, pages in REDIRECTS_DATA['naucse-lessons'].items():
    for html_filename, lesson in pages.items():
        new_url = 'http://naucse.python.cz/lessons/{}/'.format(lesson)
        REDIRECTS['{}/{}'.format(directory, html_filename)] = new_url


##########
## Freezer

freezer = Freezer(app)

@freezer.register_generator
def v1():
    IGNORE = ['*.aux', '*.out', '*.log', '*.scss', '.travis.yml', '.gitignore']
    for name, dirs, files in os.walk(v1_path):
        if '.git' in dirs:
            dirs.remove('.git')
        for file in files:
            if file == '.git':
                continue
            if not any(fnmatch.fnmatch(file, ig) for ig in IGNORE):
                path = Path(name) / file
                yield {'path': PurePosixPath(path.relative_to(v1_path))}
    for path in REDIRECTS:
        yield url_for('v1', path=path)

OLD_CITIES = 'praha', 'brno', 'ostrava'

@freezer.register_generator
def course_redirect():
    for city in OLD_CITIES:
        yield {'city': city}

@freezer.register_generator
def info_redirect():
    for city in OLD_CITIES:
        yield {'city': city}

if __name__ == '__main__':
    cli(app, freezer=freezer, base_url='http://pyladies.cz')