Merge branch 'master' of github.com:easyctf/ctf-calendar

Author: Michael Zhang

.gitignore

@@ -4,3 +4,5 @@
 .env
 .secret_key
 npm-debug.log
+.coverage
+.cache

.travis.yml

@@ -0,0 +1,19 @@
+language: python
+sudo: required
+python:
+  - "2.7"
+install:
+  - sudo apt-get update
+  - sudo apt-get -y install python python-dev python-pip
+  - pip install -r requirements.txt
+  - pip install coveralls
+before_script:
+  - psql -c 'create database ctfcal;' -U postgres
+services:
+  - postgresql
+script:
+  - coverage run --source . -m pytest -v && coverage report
+after_success:
+  coveralls
+notifications:
+  email: false

config.py

@@ -5,6 +5,9 @@
 
 load_dotenv(find_dotenv())
 
+EVENT_LIST_PAGE_SIZE = 25
+USER_LIST_PAGE_SIZE = 50
+
 
 class CalendarConfig:
     def __init__(self, app_root=None, testing=False):

conftest.py

@@ -50,9 +50,9 @@ def validate_username(self, field):
 
 class EventForm(Form):
     title = StringField('Title', validators=[InputRequired(), Length(max=256)])
-    start_time = IntegerField('Start Time', validators=[InputRequired(), NumberRange(min=0, max=2147483647,
+    start_time = IntegerField('Start Time (UNIX Time)', validators=[InputRequired(), NumberRange(min=0, max=2147483647,
                                                                                      message='Start time must be between 0 and 2147483647!')])
-    duration = FloatField('Duration (hours)', validators=[InputRequired(), NumberRange(min=0, max=2147483647,
+    duration = FloatField('Duration (Hours)', validators=[InputRequired(), NumberRange(min=0, max=2147483647,
                                                                                        message='Duration must be between 0 and 2147483647!')])
     description = StringField('Description', widget=TextArea(), validators=[InputRequired(), Length(max=1024)])
     link = StringField('Link', validators=[InputRequired(), Length(max=256)])

forms.py

@@ -1,4 +1,5 @@
 from datetime import datetime, timedelta
+from functools import partial
 
 from flask_login import current_user, LoginManager
 from flask_oauthlib.provider import OAuth2Provider
@@ -92,18 +93,30 @@ class Event(db.Model):
     approved = db.Column(db.Boolean, default=False)
     title = db.Column(db.Unicode(length=256))
     start_time = db.Column(db.Integer, index=True)
-    duration = db.Column(db.Float)
+    duration = db.Column(db.Float)  # in hours
     description = db.Column(db.UnicodeText)
     link = db.Column(db.Unicode(length=256))
     removed = db.Column(db.Boolean, default=False)
 
     # OAuth2 stuff
-    client_id = db.Column(db.String(40), unique=True, default=util.generate_string(16))
-    client_secret = db.Column(db.String(55), unique=True, index=True, nullable=False, default=util.generate_string(32))
+    client_id = db.Column(db.String(40), unique=True, default=partial(util.generate_string, 16))
+    client_secret = db.Column(db.String(55), unique=True, index=True, nullable=False, default=partial(util.generate_string, 32))
     is_confidential = db.Column(db.Boolean, default=True)
     _redirect_uris = db.Column(db.Text)
     _default_scopes = db.Column(db.Text)
 
+    @property
+    def formatted_start_time(self):
+        return util.isoformat(self.start_time)
+
+    @hybrid_property
+    def end_time(self):
+        return self.start_time + self.duration * 60
+
+    @property
+    def formatted_end_time(self):
+        return util.isoformat(self.end_time)
+
     @property
     def client_type(self):
         if self.is_confidential:

models.py

@@ -13,6 +13,7 @@ passlib
 pathlib
 psycopg2
 pymysql
+pytest
 python-dotenv
 sqlalchemy
 wtforms

requirements.txt

@@ -46,7 +46,7 @@
                     <td>{{ event.description }}</td>
                     <td>
                         <time class="timeago"
-                              datetime="{{ event.start_time_format }}">{{ event.start_time_format }}</time>
+                              datetime="{{ event.formatted_start_time }}">{{ event.formatted_start_time }}</time>
                     </td>
                     <td>{{ event.duration|duration('hour') }}</td>
                     <td><a href="{{ event.link }}" target="_blank">Website</a></td>
@@ -80,6 +80,14 @@
         </table>
     </div>
 
+    <p>
+        {% if page_number == 1 %}Prev{% else %}
+            <a href="{{ url_for('events.events_%s' % tab, page_number=page_number - 1) }}">Prev</a>{% endif %}
+        / Page <b>{{ page_number }}</b> /
+        {% if last_page %}Next{% else %}
+            <a href="{{ url_for('events.events_%s' % tab, page_number=page_number + 1) }}">Next</a>{% endif %}
+    </p>
+
     <script type="text/javascript">
         $(document).ready(function () {
             $.timeago.settings.allowFuture = true;

templates/events/list.html

@@ -36,18 +36,18 @@
                     <ul class="dropdown-menu">
                         <li><a href="{{ url_for('events.events_all') }}">All Events</a></li>
                         {% if current_user.admin == true %}
-                            <li><a href="/events/unapproved">Unapproved Events</a></li>
+                            <li><a href="{{ url_for('events.events_unapproved') }}">Unapproved Events</a></li>
                         {% endif %}
                         <li role="separator" class="divider"></li>
-                        <li><a href="/events/upcoming">Upcoming Events</a></li>
-                        <li><a href="/events/past">Past Events</a></li>
+                        <li><a href="{{ url_for('events.events_upcoming') }}">Upcoming Events</a></li>
+                        <li><a href="{{ url_for('events.events_past') }}">Past Events</a></li>
                     </ul>
                 </li>
                 <li class="dropdown">
                     <a href="javascript:void(0);" class="dropdown-toggle" data-toggle="dropdown" role="button"
                        aria-haspopup="true" aria-expanded="false">Community <span class="caret"></span></a>
                     <ul class="dropdown-menu">
-                        <li><a href="/users">Find Players</a></li>
+                        <li><a href="{{ url_for('users.users_list') }}">Find Players</a></li>
                         <li><a href="http://slack.easyctf.com" target="_blank">Slack</a></li>
                     </ul>
                 </li>

templates/layout.html

@@ -1,7 +1,7 @@
 {% extends "layout.html" %}
 
 {% block title %}
-    Event List
+    User List
 {% endblock %}
 
 {% block content %}
@@ -15,4 +15,12 @@
             <br/>
         </div>
     {% endfor %}
+
+    <p>
+        {% if page_number == 1 %}Prev{% else %}
+            <a href="{{ url_for('users.users_list', page_number=page_number - 1) }}">Prev</a>{% endif %}
+        / Page <b>{{ page_number }}</b> /
+        {% if last_page %}Next{% else %}
+            <a href="{{ url_for('users.users_list', page_number=page_number + 1) }}">Next</a>{% endif %}
+    </p>
 {% endblock %}

templates/users/list.html

@@ -0,0 +1 @@
+# hei

tests/__init__.py

@@ -0,0 +1,3 @@
+class TestGeneral():
+    def test_sanity(self):
+        assert "sanity level" > 0

tests/test_general.py

@@ -1,8 +1,10 @@
 import json
+import time
 
 from flask import abort, Blueprint, redirect, render_template, url_for, flash
 from flask_login import current_user, login_required
 
+import config
 from forms import EventForm
 from models import db, Event
 from util import admin_required, isoformat
@@ -24,67 +26,137 @@ def events_create():
 
 
 @blueprint.route('/list/json')
-def events_list_json():
-    events = Event.query.filter_by().order_by(Event.start_time.desc()).all()
-    event_list = []
-    for event in events:
-        start_time = event.start_time
-        obj = {
-            'id': event.id,
-            'approved': event.approved,
-            'name': event.title,
-            'startTime': start_time * 1000,
-            'startTimeFormat': isoformat(start_time),
-            'endTime': (start_time + event.duration * 60 * 60) * 1000,
-            'duration': event.duration
-        }
-        event_list.append(obj)
+@blueprint.route('/list/json/page/<int:page_number>')
+def events_list_json(page_number=1):
+    if page_number <= 0:
+        abort(404)
+
+    page_size = config.EVENT_LIST_PAGE_SIZE
+    page_offset = (page_number - 1) * page_size
+    events = Event.query.order_by(Event.start_time.desc()).offset(page_offset).limit(page_size).all()
+    if page_number != 1 and not events:
+        abort(404)
+
+    event_list = [{
+                      'id': event.id,
+                      'approved': event.approved,
+                      'name': event.title,
+                      'startTime': event.start_time * 1000,
+                      'startTimeFormat': isoformat(event.start_time),
+                      'endTime': (event.start_time + event.duration * 60 * 60) * 1000,
+                      'duration': event.duration
+                  } for event in events]
     return json.dumps(event_list)
 
 
 @blueprint.route('/')
 @blueprint.route('/all')
-def events_all():
-    events = Event.query.filter_by(approved=True, removed=False).order_by(Event.start_time.desc()).all()
-    for event in events:
-        event.start_time_format = isoformat(event.start_time)
-    return render_template('events/list.html', tab='all', events=events)
+@blueprint.route('/all/page/<int:page_number>')
+def events_all(page_number=1):
+    if page_number <= 0:
+        abort(404)
+
+    page_size = config.EVENT_LIST_PAGE_SIZE
+    page_offset = (page_number - 1) * page_size
+    # Offset + limit for pagination is inefficient; implement page_start based pages if perf issues.
+    events = Event.query.filter_by(approved=True, removed=False).order_by(Event.start_time.desc()) \
+        .offset(page_offset).limit(page_size + 1).all()
+    if page_number != 1 and not events:
+        abort(404)
+
+    last_page = len(events) <= page_size
+    if not last_page:
+        events.pop()
+
+    return render_template('events/list.html', tab='all', page_number=page_number, last_page=last_page, events=events)
 
 
 # todo
 @blueprint.route('/upcoming')
-def events_upcoming():
-    events = Event.query.filter_by(approved=True, removed=False).order_by(Event.start_time.desc()).all()
-    for event in events:
-        event.start_time_format = isoformat(event.start_time)
-    return render_template('events/list.html', tab='upcoming', events=events)
+@blueprint.route('/upcoming/page/<int:page_number>')
+def events_upcoming(page_number=1):
+    if page_number <= 0:
+        abort(404)
+
+    page_size = config.EVENT_LIST_PAGE_SIZE
+    page_offset = (page_number - 1) * page_size
+    upcoming_events = Event.query.filter_by(approved=True, removed=False).filter(Event.start_time > time.time()) \
+        .order_by(Event.start_time.desc()).offset(page_offset).limit(page_size + 1).all()
+    if page_number != 1 and not upcoming_events:
+        abort(404)
+
+    last_page = len(upcoming_events) <= page_size
+    if not last_page:
+        upcoming_events.pop()
+
+    return render_template('events/list.html', tab='upcoming', page_number=page_number, last_page=last_page,
+                           events=upcoming_events)
 
 
 # todo
 @blueprint.route('/past')
-def events_past():
-    events = Event.query.filter_by(approved=True, removed=False).order_by(Event.start_time.desc()).all()
-    for event in events:
-        event.start_time_format = isoformat(event.start_time)
-    return render_template('events/list.html', tab='past', events=events)
+@blueprint.route('/past/page/<int:page_number>')
+def events_past(page_number=1):
+    if page_number <= 0:
+        abort(404)
+
+    page_size = config.EVENT_LIST_PAGE_SIZE
+    page_offset = (page_number - 1) * page_size
+    past_events = Event.query.filter_by(approved=True, removed=False).filter(Event.end_time <= time.time()) \
+        .order_by(Event.start_time.desc()).offset(page_offset).limit(page_size + 1).all()
+    if page_number != 1 and not past_events:
+        abort(404)
+
+    last_page = len(past_events) <= page_size
+    if not last_page:
+        past_events.pop()
+
+    return render_template('events/list.html', tab='past', page_number=page_number, last_page=last_page,
+                           events=past_events)
 
 
 @blueprint.route('/unapproved')
+@blueprint.route('/unapproved/page/<int:page_number>')
 @admin_required
-def events_unapproved():
-    unapproved_events = Event.query.filter_by(approved=False, removed=False).order_by(Event.start_time.desc()).all()
-    for event in unapproved_events:
-        event.start_time_format = isoformat(event.start_time)
-    return render_template('events/list.html', tab='unapproved', events=unapproved_events, enabled_actions=['approve'])
+def events_unapproved(page_number=1):
+    if page_number <= 0:
+        abort(404)
+
+    page_size = config.EVENT_LIST_PAGE_SIZE
+    page_offset = (page_number - 1) * page_size
+    unapproved_events = Event.query.filter_by(approved=False, removed=False).order_by(Event.start_time.desc()) \
+        .offset(page_offset).limit(page_size + 1).all()
+    if page_number != 1 and not unapproved_events:
+        abort(404)
+
+    last_page = len(unapproved_events) <= page_size
+    if not last_page:
+        unapproved_events.pop()
+
+    return render_template('events/list.html', tab='unapproved', page_number=page_number, last_page=last_page,
+                           events=unapproved_events, enabled_actions=['approve'])
 
 
 @blueprint.route('/owned')
+@blueprint.route('/owned/page/<int:page_number>')
 @login_required
-def events_owned():
-    owned_events = current_user.events.filter_by(removed=False)
-    for event in owned_events:
-        event.start_time_format = isoformat(event.start_time)
-    return render_template('events/list.html', tab='owned', events=owned_events, enabled_actions=['manage', 'remove'])
+def events_owned(page_number=1):
+    if page_number <= 0:
+        abort(404)
+
+    page_size = config.EVENT_LIST_PAGE_SIZE
+    page_offset = (page_number - 1) * page_size
+    owned_events = current_user.events.filter_by(removed=False).order_by(Event.start_time.desc()) \
+        .offset(page_offset).limit(page_size + 1).all()
+    if page_number != 1 and not owned_events:
+        abort(404)
+
+    last_page = len(owned_events) <= page_size
+    if not last_page:
+        owned_events.pop()
+
+    return render_template('events/list.html', tab='owned', page_number=page_number, last_page=last_page,
+                           events=owned_events, enabled_actions=['manage', 'remove'])
 
 
 @blueprint.route('/<int:event_id>')
@@ -115,6 +187,7 @@ def events_manage(event_id):
     event_form = EventForm(obj=event)
     if event_form.validate_on_submit():
         event_form.populate_obj(event)
+        db.session.commit()
         return redirect(url_for('.events_detail', event_id=event_id))
     return render_template('events/manage.html', event=event, event_form=event_form)