14 | {% block content %}{% endblock %}
15 |
16 |
17 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 John Patrick Glattetre
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/overpass/templates/manage_stream.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 | {% block title %}
3 | Edit Stream
4 | {% endblock %}
5 |
6 | {% block content %}
7 | {% include "header.html" %}
8 | {% if update %}
9 |
10 | Stream settings updated.
11 |
12 | {% endif %}
13 |
36 | {% endblock %}
--------------------------------------------------------------------------------
/overpass/routes/manage_user.py:
--------------------------------------------------------------------------------
1 | from typing import Text
2 |
3 | from flask import Blueprint, redirect, url_for
4 | from flask.templating import render_template
5 | from flask_discord import Unauthorized, requires_authorization
6 | from overpass import discord
7 | from overpass.db import query_many, query_one
8 |
9 | bp = Blueprint("manage", __name__)
10 |
11 |
12 | @bp.errorhandler(Unauthorized)
13 | def redirect_discord_unauthorized(e):
14 | return redirect(url_for("auth.login"))
15 |
16 |
17 | @bp.before_request
18 | @requires_authorization
19 | def require_auth():
20 | pass
21 |
22 |
23 | @bp.route("/me")
24 | def me() -> Text:
25 | """Render a page to manage stream properties
26 |
27 | Returns:
28 | Text: Static page rendered by Flask.
29 | """
30 | discord_user = discord.fetch_user()
31 | user = query_one(
32 | "SELECT * FROM user WHERE snowflake = ?", [discord_user.id]
33 | )
34 | streams = query_many(
35 | "SELECT * FROM stream WHERE user_snowflake = ?", [discord_user.id]
36 | )
37 | if streams:
38 | for stream in streams:
39 | try:
40 | duration = stream["end_date"] - stream["start_date"]
41 | stream["duration"] = str(duration)
42 | except TypeError:
43 | continue
44 | stream["username"] = user["username"]
45 | return render_template("manage_user.html", user=user, streams=streams)
46 |
47 | return render_template("manage_user.html", user=user)
48 |
--------------------------------------------------------------------------------
/overpass/templates/header.html:
--------------------------------------------------------------------------------
1 |
2 |
27 |
--------------------------------------------------------------------------------
/config.py:
--------------------------------------------------------------------------------
1 | from genericpath import exists
2 | import os
3 | from pathlib import Path
4 | from dotenv import load_dotenv
5 |
6 | if Path(".env").exists():
7 | load_dotenv(".env")
8 |
9 |
10 | def get_secret_key():
11 | env_key = os.environ.get("OVERPASS_SECRET_KEY")
12 | if env_key:
13 | return env_key.encode()
14 |
15 | print(
16 | "No secret key found, please set the environment variable OVERPASS_SECRET_KEY"
17 | )
18 | print("Generating key for temporary usage...")
19 | return os.urandom(16)
20 |
21 |
22 | def get_database_directory(dev: bool = False) -> str:
23 | database_name = "overpass.db" if not dev else "overpass-dev.db"
24 | env_database_path = os.environ.get("OVERPASS_DATABASE_PATH")
25 | if env_database_path:
26 | database_dir = Path(env_database_path)
27 | database_dir.mkdir(exist_ok=True)
28 | return database_dir / database_name
29 | return database_name
30 |
31 |
32 | class Config(object):
33 | DEBUG = False
34 | TESTING = False
35 | DATABASE = get_database_directory()
36 | DISCORD_CLIENT_ID = os.environ.get("DISCORD_CLIENT_ID")
37 | DISCORD_CLIENT_SECRET = os.environ.get("DISCORD_CLIENT_SECRET")
38 | DISCORD_REDIRECT_URI = os.environ.get("DISCORD_REDIRECT_URI")
39 |
40 |
41 | class DevConfig(Config):
42 | DEBUG = True
43 | DATABASE = get_database_directory(dev=True)
44 | SECRET_KEY = get_secret_key()
45 |
46 |
47 | class ProdConfig(Config):
48 | SECRET_KEY = get_secret_key()
49 | SESSION_COOKIE_SECURE = True
50 | REMEMBER_COOKIE_SECURE = True
51 |
--------------------------------------------------------------------------------
/overpass/watch.py:
--------------------------------------------------------------------------------
1 | from typing import Any, Dict, Text
2 |
3 | from flask import render_template
4 |
5 | from overpass.archive import get_archived_streams
6 |
7 |
8 | def get_single_archived_stream(
9 | unique_id: str, all_metadata: bool = False, private: bool = False
10 | ) -> Dict[str, Any]:
11 | """Get a single stream from the archive
12 |
13 | Args:
14 | unique_id (str): The stream's unique ID.
15 |
16 | all_metadata (bool, optional): Return all metadata about the stream.
17 | Defaults to False.
18 |
19 | private (bool, optional):
20 | Include streams that aren't publically archived.
21 | Defaults to False.
22 |
23 | Returns:
24 | Dict[str, Any]: Dict containing information about the stream.
25 | """
26 | archived_streams = get_archived_streams(
27 | all_metadata=all_metadata, private=private
28 | )
29 | stream = next(
30 | stream
31 | for stream in archived_streams
32 | if stream["unique_id"] == unique_id
33 | )
34 | return stream
35 |
36 |
37 | def return_stream_page(unique_id: str, stream: Dict[str, Any]) -> Text:
38 | """Helper function used in the watch_stream function
39 |
40 | Args:
41 | unique_id (str): The stream's unique ID.
42 | stream (Dict[str, Any]): Metadata about the stream.
43 |
44 | Returns:
45 | Text: Static page rendered by Flask.
46 | """
47 | return render_template(
48 | "watch.html",
49 | id=unique_id,
50 | stream=stream,
51 | archive_link=stream["download"],
52 | )
53 |
--------------------------------------------------------------------------------
/overpass/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 | {% block title %}
3 | Home
4 | {% endblock %}
5 |
6 | {% block meta %}
7 |
8 | {% endblock %}
9 |
10 |
11 | {% block content %}
12 | {% if authorized %}
13 | {% include "header.html" %}
14 | {% if streams is defined and streams|length %}
15 | {% for stream in streams %}
16 |
17 |
26 | {% endfor %}
27 | {% else %}
28 |
18 | {{stream['username']}} is streaming!
19 |
20 |
25 |
29 | No one is streaming at the moment. Would you like to go live?
31 |
32 | {% endif %}
33 | {% else %}
34 |
35 |
46 | {% endif %}
47 | {% endblock %}
--------------------------------------------------------------------------------
/overpass/templates/generate_stream.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 | {% block title %}
3 | Go Live
4 | {% endblock %}
5 | {% block content %}
6 | {% include "header.html" %}
7 |
36 | Overpass
37 |
38 |
39 |
45 | Sign in
40 |Click the button to sign in with Discord.
41 |
42 |
44 |
8 | Streaming server: {{ server }}
9 |
10 |
31 | {% if key %}
32 |
33 | Stream key: {{ key }}
34 |
35 | {% endif %}
36 | {% if unlisted %}
37 |
38 | Your unlisted stream will be available here.
39 |
40 | {% endif %}
41 | {% endblock %}
--------------------------------------------------------------------------------
/docker/nginx.conf:
--------------------------------------------------------------------------------
1 | user www-data;
2 | worker_processes auto;
3 | pid /run/nginx.pid;
4 | daemon off;
5 | include /etc/nginx/modules-enabled/*.conf;
6 | rtmp_auto_push on;
7 |
8 | events {
9 | worker_connections 4096;
10 | # multi_accept on;
11 | }
12 |
13 | http {
14 |
15 | ##
16 | # Basic Settings
17 | ##
18 |
19 | sendfile on;
20 | tcp_nopush on;
21 | tcp_nodelay on;
22 | keepalive_timeout 65;
23 | types_hash_max_size 2048;
24 |
25 | include /etc/nginx/mime.types;
26 | default_type application/octet-stream;
27 |
28 | ##
29 | # Logging Settings
30 | ##
31 |
32 | log_format '$remote_addr - $remote_user [$time_local] '
33 | '"$request" $status $body_bytes_sent '
34 | '"$http_referer" "$http_user_agent"';
35 |
36 | access_log /var/log/nginx/access.log;
37 | error_log /var/log/nginx/error.log;
38 |
39 | ##
40 | # Gzip Settings
41 | ##
42 |
43 | gzip on;
44 |
45 | ##
46 | # Virtual Host Configs
47 | ##
48 |
49 | include /etc/nginx/conf.d/*.conf;
50 | include /etc/nginx/sites-enabled/*;
51 | }
52 |
53 | rtmp {
54 | server {
55 | listen 0.0.0.0:1935;
56 | on_publish http://127.0.0.1:8000/api/rtmp/connect;
57 | on_publish_done http://127.0.0.1:8000/api/rtmp/done;
58 |
59 | application live {
60 | live on;
61 | record all;
62 | record_path /archive;
63 | record_append on;
64 |
65 | hls on;
66 | hls_path /hls;
67 | hls_fragment 2s;
68 | hls_playlist_length 10s;
69 | exec_record_done bash -c "/usr/bin/ffmpeg -i $path -acodec copy -vcodec copy -movflags +faststart /archive/$basename.mp4 && rm $path";
70 | }
71 | }
72 | }
--------------------------------------------------------------------------------
/overpass/templates/archive.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 | {% block title %}
3 | Archive
4 | {% endblock %}
5 | {% block content %}
6 | {% include "header.html" %}
7 | Archive
8 | {% if archive is defined and archive|length %} 9 || Date | 13 |User | 14 |Title | 15 |Duration | 16 |17 | |
|---|---|---|---|---|
| {{ stream['start_date'] }} UTC | 23 |{{ stream['username'] }} | 24 |{{ stream['title'] }} | 25 |{{ stream["duration"] }} | 26 |27 | 31 | | 32 |
|
35 |
36 |
40 |
37 | {{ stream["description"] | nl2br }}
38 |
39 | |
41 | ||||
47 | There are no streams in the archive yet.
48 |
49 | {% endif %}
50 | {% endblock %}
--------------------------------------------------------------------------------
/overpass/rtmp_server_api.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 |
3 | from flask import current_app
4 |
5 | from overpass.db import get_db, query_one
6 |
7 |
8 | def verify_stream_key(stream_key: str) -> bool:
9 | """Validate that the stream key exists in the database
10 |
11 | Args:
12 | stream_key (str): The stream key to validate.
13 |
14 | Returns:
15 | bool: True if the key exists.
16 | """
17 | res = query_one(
18 | "SELECT * from stream WHERE stream_key = ? AND end_date IS NULL",
19 | [stream_key],
20 | )
21 | try:
22 | if res["stream_key"]:
23 | current_app.logger.info(f"Accepting stream: {stream_key}")
24 | return True
25 | except KeyError:
26 | current_app.logger.info(f"Invalid stream key: {stream_key}")
27 |
28 | return False
29 |
30 |
31 | def start_stream(stream_key: str) -> None:
32 | """Sets the stream's start date in the database.
33 |
34 | Args:
35 | stream_key (str): The stream key to update.
36 | """
37 | db = get_db()
38 | current_app.logger.info(f"Stream {stream_key} is now live!")
39 | res = query_one("SELECT * FROM stream WHERE stream_key = ?", [stream_key])
40 | db.execute(
41 | "UPDATE stream SET start_date = ? WHERE id = ?",
42 | (datetime.now().strftime("%Y-%m-%d %H:%M:%S"), res["id"]),
43 | )
44 | db.commit()
45 |
46 |
47 | def end_stream(stream_key: str) -> None:
48 | """Sets the stream's end date in the database.
49 |
50 | Args:
51 | stream_key (str): The stream key to update.
52 | """
53 | db = get_db()
54 | current_app.logger.info(f"Ending stream {stream_key}")
55 | res = query_one("SELECT * FROM stream WHERE stream_key = ?", [stream_key])
56 | db.execute(
57 | "UPDATE stream SET end_date = ? WHERE id = ?",
58 | (datetime.now().strftime("%Y-%m-%d %H:%M:%S"), res["id"]),
59 | )
60 | db.commit()
61 |
--------------------------------------------------------------------------------
/overpass/templates/watch.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 |
3 |
4 | {% block title %}
5 | Watch
6 | {% endblock %}
7 |
8 | {% block content %}
9 | {% include "header.html" %}
10 |
11 |
12 |
13 | {% if stream %}
14 |
15 |
26 | {% else %}
27 |
59 | {% else %}
60 |
49 |
50 |
58 | 50 |
{{stream['title']}}
51 |by {{stream['username']}}
52 |
53 |
57 |
54 | {{stream['description'] | nl2br}}
55 |
56 |
61 | The user is offline.
62 |
63 | {% endif %}
64 | {% endblock %}
65 |
--------------------------------------------------------------------------------
/overpass/routes/archive.py:
--------------------------------------------------------------------------------
1 | from typing import Any, Text
2 |
3 | from flask import Blueprint, abort, redirect, url_for
4 | from flask.templating import render_template
5 | from flask.wrappers import Response
6 | from flask_discord import Unauthorized, requires_authorization
7 | from overpass import discord
8 | from overpass.archive import get_archived_streams, serve_file
9 | from overpass.db import query_one
10 |
11 | bp = Blueprint("archive", __name__)
12 |
13 |
14 | @bp.errorhandler(Unauthorized)
15 | def redirect_discord_unauthorized(e) -> Any:
16 | return redirect(url_for("auth.login"))
17 |
18 |
19 | @bp.before_request
20 | @requires_authorization
21 | def require_auth() -> None:
22 | pass
23 |
24 |
25 | @bp.route("/")
26 | def list_archived_streams() -> Text:
27 | """List publically archived streams.
28 |
29 | Returns:
30 | Text: Static page rendered by Flask.
31 | """
32 | archive = get_archived_streams()
33 | return render_template("archive.html", archive=archive)
34 |
35 |
36 | @bp.route("/download/Your Discord user is not authorized to use this application.
84 |Please verify that you are a member of the target Discord server.
85 | """ 86 | -------------------------------------------------------------------------------- /overpass/archive.py: -------------------------------------------------------------------------------- 1 | from typing import Any, Dict, List 2 | from flask.helpers import send_from_directory 3 | from flask.wrappers import Response 4 | from overpass.db import get_db, query_many 5 | from flask import current_app 6 | from os import environ 7 | from pathlib import Path 8 | from overpass.stream_utils import get_username_from_snowflake 9 | 10 | 11 | def archive_stream(stream_key: str): 12 | """Archives a stream. 13 | 14 | Args: 15 | stream_key (str): The stream's stream key. 16 | """ 17 | stream_path = Path(environ.get("REC_PATH", "")) / f"{stream_key}.mp4" 18 | current_app.logger.info(f"Adding stream {stream_path} to archive") 19 | db = get_db() 20 | db.execute( 21 | "UPDATE stream SET archived_file = ? WHERE stream_key = ?", 22 | (str(stream_path), stream_key), 23 | ) 24 | db.commit() 25 | 26 | 27 | def get_archived_streams( 28 | all_metadata: bool = False, private: bool = False 29 | ) -> List[Dict[str, Any]]: 30 | """Get a list of all archived streams. 31 | 32 | Args: 33 | all_metadata (bool, optional): 34 | Get all metadata for stream. 35 | Defaults to False. 36 | 37 | private (bool, optional): 38 | Include streams that aren't publically archived. 39 | Defaults to False. 40 | 41 | Returns: 42 | List[Dict[str, Any]]: List of dicts containing the streams. 43 | """ 44 | if all_metadata: 45 | items = "*" 46 | else: 47 | items = "id, user_snowflake, start_date, end_date, title, description, category, unique_id" # noqa: E501 48 | 49 | if private: 50 | res = query_many( 51 | f"SELECT {items} FROM stream WHERE archived_file IS NOT NULL" 52 | ) 53 | else: 54 | res = query_many( 55 | f"SELECT {items} FROM stream WHERE unlisted = 0 AND archivable = 1 AND archived_file IS NOT NULL" # noqa: E501 56 | ) 57 | 58 | for stream in res: 59 | duration = stream["end_date"] - stream["start_date"] 60 | stream["duration"] = str(duration) 61 | stream["username"] = get_username_from_snowflake( 62 | stream["user_snowflake"] 63 | ) 64 | stream["download"] = f"/archive/download/{stream['unique_id']}" 65 | if not private: 66 | del stream["user_snowflake"] 67 | 68 | return res 69 | 70 | 71 | def serve_file(archived_stream: Dict[str, Any]) -> Response: 72 | """Serves an archived stream from storage. 73 | 74 | Args: 75 | archived_stream (Dict[str, Any]): 76 | Dict containing information about the stream from the database. 77 | 78 | Returns: 79 | Response: File being served by Flask's Response class. 80 | """ 81 | username = get_username_from_snowflake(archived_stream["user_snowflake"]) 82 | filename = f"{username} - {archived_stream['title']} - {archived_stream['start_date']}.mp4" 83 | return send_from_directory( 84 | environ.get("REC_PATH"), 85 | filename=f"{archived_stream['stream_key']}.mp4", 86 | as_attachment=True, 87 | attachment_filename=filename, 88 | ) 89 | -------------------------------------------------------------------------------- /overpass/routes/watch.py: -------------------------------------------------------------------------------- 1 | from typing import Any, Union 2 | 3 | from flask import Blueprint, redirect, render_template, url_for 4 | from flask_discord import Unauthorized, requires_authorization 5 | from overpass import discord 6 | from overpass.stream_utils import ( 7 | get_livestreams_by_username, 8 | get_unlisted_livestreams_by_username, 9 | ) 10 | from overpass.watch import get_single_archived_stream, return_stream_page 11 | 12 | bp = Blueprint("watch", __name__) 13 | 14 | 15 | @bp.errorhandler(Unauthorized) 16 | def redirect_discord_unauthorized(e) -> Any: 17 | return redirect(url_for("auth.login")) 18 | 19 | 20 | @bp.before_request 21 | @requires_authorization 22 | def require_auth() -> None: 23 | pass 24 | 25 | 26 | @bp.route("/User Info
9 |
10 |
27 | {% if streams is defined %}
28 |
11 |
26 |
12 |
25 |
13 | {% if user['avatar'] %}
14 |
24 |
15 | 
16 |
17 | {% endif %}
18 |
19 |
23 | {{user['username']}}
20 |Last login date: {{user['last_login_date']}} UTC
21 |Discord User ID: {{user['snowflake']}}
22 |My streams
29 || Date | 33 |Title | 34 |Duration | 35 |Status | 36 |37 | | ||
|---|---|---|---|---|---|---|
| {{ stream['start_date'] }} UTC | 44 | {% else %} 45 |Not Started Yet | 46 | {% endif %} 47 |{{ stream['title'] }} | 48 | {% if stream["duration"] %} 49 |{{ stream['duration'] }} | 50 | {% else %} 51 |N/A | 52 | {% endif %} 53 |
54 |
55 |
56 | {% if not stream["duration"] and stream["start_date"] %}
57 | LIVE
58 | {% endif %}
59 | {% if stream["archivable"] %}
60 | Archived
61 | {% else %}
62 | Not Archived
63 | {% endif %}
64 | {% if stream["unlisted"] %}
65 | Unlisted
66 | {% endif %}
67 |
68 | |
69 |
70 |
71 | Edit Stream
72 | {% if not stream["duration"] and not stream["unlisted"] %}
73 | Play
74 | {% else %}
75 | Play
76 | {% endif %}
77 | Details
78 |
79 | |
80 |
|
83 |
84 |
92 |
85 | {{ stream["description"] | nl2br }}
86 |
91 |
87 | Stream Key: {{ stream["stream_key"] }}
88 | Unique ID: {{ stream["unique_id"] }}
89 |
90 | |
93 | ||||||