diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d4ac028 --- /dev/null +++ b/.gitignore @@ -0,0 +1,195 @@ +### https://raw.github.com/github/gitignore/218a941be92679ce67d0484547e3e142b2f5f6f0/Python.gitignore + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + + +### https://raw.github.com/github/gitignore/218a941be92679ce67d0484547e3e142b2f5f6f0/Global/Emacs.gitignore + +# -*- mode: gitignore; -*- +*~ +\#*\# +/.emacs.desktop +/.emacs.desktop.lock +*.elc +auto-save-list +tramp +.\#* + +# Org-mode +.org-id-locations +*_archive + +# flymake-mode +*_flymake.* + +# eshell files +/eshell/history +/eshell/lastdir + +# elpa packages +/elpa/ + +# reftex files +*.rel + +# AUCTeX auto folder +/auto/ + +# cask packages +.cask/ +dist/ + +# Flycheck +flycheck_*.el + +# server auth directory +/server/ + +# projectiles files +.projectile + +# directory configuration +.dir-locals.el + +# network security +/network-security.data + + + diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..cca642a --- /dev/null +++ b/app/__init__.py @@ -0,0 +1,13 @@ +from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from flask_login import LoginManager +from .config import Config + +app = Flask(__name__) +app.config.from_object(Config) +db = SQLAlchemy(app) +migrate = Migrate(app, db) +login = LoginManager(app) + +from . import routes, models diff --git a/app/config.py b/app/config.py new file mode 100644 index 0000000..2de6cdf --- /dev/null +++ b/app/config.py @@ -0,0 +1,8 @@ +import os +basedir = os.path.abspath(os.path.dirname(__file__)) + + +class Config(object): + SECRET_KEY = os.environ.get('CC0_SECRET_KEY') + SQLALCHEMY_DATABASE_URI = os.environ.get("CC0_SQLALCHEMY_DATABASE_URI") or f"sqlite:///{os.path.join(basedir, 'app.db')}" + SQLALCHEMY_TRACK_MODIFICATIONS = False diff --git a/app/forms.py b/app/forms.py new file mode 100644 index 0000000..23ec097 --- /dev/null +++ b/app/forms.py @@ -0,0 +1,23 @@ +from flask_wtf import FlaskForm +from wtforms import StringField, PasswordField, BooleanField, SubmitField +from wtforms.validators import DataRequired, ValidationError, URL +from .models import CopyrightHolder + +class LoginForm(FlaskForm): + name = StringField('username', validators=[DataRequired()]) + password = PasswordField('password', validators=[DataRequired()]) + remember = BooleanField('🍪') + submit = SubmitField('login') + +class RegistrationForm(FlaskForm): + name = StringField('username', validators=[DataRequired()]) + password = PasswordField('password', validators=[DataRequired()]) + legal_name = StringField('legal name', validators=[DataRequired()]) + website = StringField('website url', validators=[DataRequired(), URL()]) + submit = SubmitField('register') + + def validate_name(self, username): + user = CopyrightHolder.query.filter_by(username=username.data).first() + + if user is not None or user in ["login", "register", "logout"]: + raise ValidationError('sorry, username in use') diff --git a/app/models.py b/app/models.py new file mode 100644 index 0000000..ff61364 --- /dev/null +++ b/app/models.py @@ -0,0 +1,50 @@ +from datetime import datetime +from werkzeug.security import generate_password_hash, check_password_hash +from flask_login import UserMixin +from . import db +from . import login + +@login.user_loader +def load_user(id): + return CopyrightHolder.query.get(int(id)) + +class CopyrightHolder(UserMixin, db.Model): + id = db.Column(db.Integer, primary_key=True) + username = db.Column(db.String(128), index=True, unique=True) + legal_name = db.Column(db.String(128), index=True) + password_hash = db.Column(db.String(128)) + email = db.Column(db.String(128), index=True, unique=True) + website = db.Column(db.String(256), index=True, unique=True) + collections = db.relationship('Collection', backref='copyright_holder', lazy='dynamic') + + def __repr__(self): + return f')>' + + def set_password(self, password): + self.password_hash = generate_password_hash(password) + def check_password(self, password): + return check_password_hash(self.password_hash, password) + def is_admin(self): + return self.id == 1 + +class Collection(db.Model): + id = db.Column(db.Integer, primary_key=True) + name = db.Column(db.String(128), index=True, unique=True) + description = db.Column(db.String(256)) + slug = db.Column(db.String(128), index=True) + copyright_holder_id = db.Column(db.Integer, db.ForeignKey('copyright_holder.id')) + password_hash = db.Column(db.String(128)) + pieces = db.relationship('Piece', backref='collection', lazy='dynamic') + def __repr__(self): + return f'' + +class Piece(db.Model): + id = db.Column(db.Integer, primary_key=True) + name = db.Column(db.String(128), index=True, unique=True) + description = db.Column(db.String(256)) + url = db.Column(db.String(128)) + timestamp = db.Column(db.DateTime, index=True, default=datetime.utcnow) + type = db.Column(db.String(10), index=True) + collection_id = db.Column(db.Integer, db.ForeignKey('collection.id')) + def __repr__(self): + return f'' diff --git a/app/routes.py b/app/routes.py new file mode 100644 index 0000000..1054909 --- /dev/null +++ b/app/routes.py @@ -0,0 +1,72 @@ +from flask import render_template, flash, redirect, url_for +from flask_login import current_user, login_user +from . import app +from . import db +from .forms import LoginForm, RegistrationForm +from .models import CopyrightHolder, Collection, Piece + +from os import scandir +from os.path import join, dirname + +@app.route('/') +def index(): + return render_template("index.html", + collections=Collection.query.all()) + +@app.route('/logout') +def logout(): + return render_template("base.html") + +@app.route('/register', methods=['GET', 'POST']) +def register(): + form = RegistrationForm() + if form.validate_on_submit(): + ch = CopyrightHolder( + username=form.name.data, + legal_name=form.legal_name.data + ) + ch.set_password(form.password.data) + db.session.add(ch) + db.session.commit() + flash(f"{ch} created") + return redirect(url_for('index')) + return render_template('register.html', title="make user", form=form) + +@app.route('/login', methods=['GET', 'POST']) +def login(): + if current_user.is_authenticated: + return redirect(url_for('index')) + form = LoginForm() + if form.validate_on_submit(): + copyright_holder = CopyrightHolder.query.filter_by(username=form.name.data).first() + if copyright_holder is None or not copyright_holder.check_password(form.password.data): + flash('bad name or wrong pass') + return redirect(url_for('login')) + login_user(copyright_holder, remember=form.remember.data) + return redirect(url_for('index')) + return render_template('login.html', title="login", form=form) + +@app.route('/') +def copyright_holder(username): + ch = CopyrightHolder.query.filter_by(username=username).first() + if ch is None: + return "404" + return render_template("copyright_holder.html", + copyright_holder=ch) + +@app.route('//new') +def new_collection(username): + return render_template("base.html") + + +@app.route('//') +def collection(username, slug): + collection = Collection.query.filter_by(slug=slug).first() + if collection is None: + return "404" + return render_template("collection.html", + copyright_holder=collection) + +@app.route('///new') +def new_piece(username, slug): + return render_template("base.html") diff --git a/app/templates/base.html b/app/templates/base.html new file mode 100644 index 0000000..9b0337b --- /dev/null +++ b/app/templates/base.html @@ -0,0 +1,36 @@ + +{% if collection %} + {{collection.name}} — public dump +

{{collection.name}}

+{% elif title %} + {{title}} — public dump +

{{title}}

+{% else %} + public dump +

public dump

+{% endif %} +{% if current_user.is_authenticated %} +

+ hi, {{current_user.legal_name}}! +

+{% endif %} + +{% with messages = get_flashed_messages() %} + {% if messages %} + {% for message in messages %} +

{{ message }}

+ {% endfor %} + {% endif %} +{% endwith %} +

welcome to the public dump

+
+ {% block content %}{% endblock %} +
diff --git a/app/templates/collection.html b/app/templates/collection.html new file mode 100644 index 0000000..8ae3e1d --- /dev/null +++ b/app/templates/collection.html @@ -0,0 +1,45 @@ +{% extends "base.html" %} +{% if current_user.is_authenticated and current_user.id == collection.copyright_holder_id %} + + new piece + +{% endif %} +{% block content %} +

pieces

+ {% for item in collection.pieces %} +

+ {{item.description}} + {% autoescape false %} + {{item.html}} + {% endautoescape %} + +

+ + CC0 + +
+ To the extent possible under law, + + + {{collection.copyright_holder}} + + + has waived all copyright and related or neighboring rights to + + + {{item.name}} + . + This work is published from: + + {{collection.country}} + . + {% endfor %} + {% endblock %} diff --git a/app/templates/copyright_holder.html b/app/templates/copyright_holder.html new file mode 100644 index 0000000..d6b4f3f --- /dev/null +++ b/app/templates/copyright_holder.html @@ -0,0 +1,21 @@ +{% extends "base.html" %} +{% block nav %} +{% if current_user.is_authenticated and current_user.id == copyright_holder.id %} + + new collection + +{% endif %} +{% endblock %} +{% block content %} +

collections

+ {% for collection in copyright_holder.collections %} + + {% endfor %} +{% endblock %} diff --git a/app/templates/index.html b/app/templates/index.html new file mode 100644 index 0000000..4f60db0 --- /dev/null +++ b/app/templates/index.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} +{% block content %} +

collections

+ +{% endblock %} diff --git a/app/templates/login.html b/app/templates/login.html new file mode 100644 index 0000000..b14cd76 --- /dev/null +++ b/app/templates/login.html @@ -0,0 +1,23 @@ +{% extends "base.html" %} +{% block content %} +
+ {{form.hidden_tag()}} +

+ {{form.name.label}}
+ {{form.name(size=32)}} +

+ +

+ {{form.password.label}}
+ {{form.password(size=32)}} +

+ +

+ {{ form.remember()}} {{form.remember.label}} +

+ +

+ {{form.submit()}} +

+
+{% endblock %} diff --git a/app/templates/register.html b/app/templates/register.html new file mode 100644 index 0000000..06d356d --- /dev/null +++ b/app/templates/register.html @@ -0,0 +1,39 @@ +{% extends "base.html" %} +{% block content %} + {% if current_user.is_admin() %} +
+ {{form.hidden_tag()}} +

+ {{form.legal_name.label}}
+ {{form.legal_name(size=32)}} +

+

+ {{form.name.label}}
+ {{form.name(size=32)}} +

+ +

+ {{form.password.label}}
+ {{form.password(size=32)}} +

+ +

+ {{form.website.label}}
+ {{form.website(size=32)}} +

+ +

+ {{form.submit()}} +

+
+ {% else %} +

+ registrations are currently + + open + ! +

+ email me: chee-cc0@snoot.club +

+ {% endif %} +{% endblock %} diff --git a/cc0.py b/cc0.py new file mode 100644 index 0000000..0025eb5 --- /dev/null +++ b/cc0.py @@ -0,0 +1,11 @@ +from app import app, db +from app.models import * + +@app.shell_context_processor +def make_shell_context(): + return { + 'db': db, + 'CopyrightHolder': CopyrightHolder, + 'Collection': Collection, + 'Piece': Piece + } diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 0000000..f8ed480 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..9452179 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +from flask import current_app +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/15f913cb40db_initial.py b/migrations/versions/15f913cb40db_initial.py new file mode 100644 index 0000000..d569e53 --- /dev/null +++ b/migrations/versions/15f913cb40db_initial.py @@ -0,0 +1,75 @@ +"""initial + +Revision ID: 15f913cb40db +Revises: +Create Date: 2020-11-16 14:47:20.578784 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '15f913cb40db' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('copyright_holder', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('username', sa.String(length=128), nullable=True), + sa.Column('legal_name', sa.String(length=128), nullable=True), + sa.Column('password_hash', sa.String(length=128), nullable=True), + sa.Column('email', sa.String(length=128), nullable=True), + sa.Column('website', sa.String(length=256), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_copyright_holder_email'), 'copyright_holder', ['email'], unique=True) + op.create_index(op.f('ix_copyright_holder_legal_name'), 'copyright_holder', ['legal_name'], unique=False) + op.create_index(op.f('ix_copyright_holder_username'), 'copyright_holder', ['username'], unique=True) + op.create_index(op.f('ix_copyright_holder_website'), 'copyright_holder', ['website'], unique=True) + op.create_table('collection', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=128), nullable=True), + sa.Column('slug', sa.String(length=128), nullable=True), + sa.Column('copyright_holder_id', sa.Integer(), nullable=True), + sa.Column('password_hash', sa.String(length=128), nullable=True), + sa.ForeignKeyConstraint(['copyright_holder_id'], ['copyright_holder.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_collection_name'), 'collection', ['name'], unique=True) + op.create_index(op.f('ix_collection_slug'), 'collection', ['slug'], unique=False) + op.create_table('piece', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=128), nullable=True), + sa.Column('url', sa.String(length=128), nullable=True), + sa.Column('timestamp', sa.DateTime(), nullable=True), + sa.Column('type', sa.String(length=10), nullable=True), + sa.Column('collection_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['collection_id'], ['collection.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_piece_name'), 'piece', ['name'], unique=True) + op.create_index(op.f('ix_piece_timestamp'), 'piece', ['timestamp'], unique=False) + op.create_index(op.f('ix_piece_type'), 'piece', ['type'], unique=False) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_piece_type'), table_name='piece') + op.drop_index(op.f('ix_piece_timestamp'), table_name='piece') + op.drop_index(op.f('ix_piece_name'), table_name='piece') + op.drop_table('piece') + op.drop_index(op.f('ix_collection_slug'), table_name='collection') + op.drop_index(op.f('ix_collection_name'), table_name='collection') + op.drop_table('collection') + op.drop_index(op.f('ix_copyright_holder_website'), table_name='copyright_holder') + op.drop_index(op.f('ix_copyright_holder_username'), table_name='copyright_holder') + op.drop_index(op.f('ix_copyright_holder_legal_name'), table_name='copyright_holder') + op.drop_index(op.f('ix_copyright_holder_email'), table_name='copyright_holder') + op.drop_table('copyright_holder') + # ### end Alembic commands ### diff --git a/migrations/versions/8bf3428c3612_descriptions.py b/migrations/versions/8bf3428c3612_descriptions.py new file mode 100644 index 0000000..0d41dd8 --- /dev/null +++ b/migrations/versions/8bf3428c3612_descriptions.py @@ -0,0 +1,30 @@ +"""descriptions + +Revision ID: 8bf3428c3612 +Revises: 15f913cb40db +Create Date: 2020-11-16 15:10:49.779287 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8bf3428c3612' +down_revision = '15f913cb40db' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('collection', sa.Column('description', sa.String(length=256), nullable=True)) + op.add_column('piece', sa.Column('description', sa.String(length=256), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('piece', 'description') + op.drop_column('collection', 'description') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..bba2b96 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +alembic==1.4.3 +SQLAlchemy==1.3.20 +Flask==1.1.2 +flask_login==0.5.0 +flask_migrate==2.5.3 +flask_sqlalchemy==2.4.4 +flask_wtf==0.14.3 +Werkzeug==1.0.1 +WTForms==2.3.3