Merge branch 'master' into reports

Author: nyaazi

.travis.yml

@@ -0,0 +1,18 @@
+language: python
+
+python:
+  - 3.6
+
+dist: xenial
+sudo: false
+
+cache: pip
+
+install:
+  - pip install --upgrade pycodestyle
+
+script:
+  - pycodestyle nyaa/ --show-source --max-line-length=100
+
+notifications:
+  email: false

README.md

@@ -1,14 +1,6 @@
 # NyaaV2
 
-## Setup:
-
-- Create your virtualenv, for example with `pyvenv venv`
-- Enter your virtualenv with `source venv/bin/activate`
-- Install dependencies with `pip install -r requirements.txt`
-- Run `python db_create.py` to create the database
-- Start the dev server with `python run.py`
-
-## Updated Setup (python 3.6.1):
+## Setup
 
 - Install dependencies https://github.com/pyenv/pyenv/wiki/Common-build-problems
 - Install `pyenv` https://github.com/pyenv/pyenv/blob/master/README.md#installation
@@ -20,7 +12,7 @@
 - Copy `config.example.py` into `config.py`
 - Change TABLE_PREFIX to `nyaa_` or `sukebei_` depending on the site
 
-## Setting up MySQL/MariaDB database for advanced functionality
+### Setting up MySQL/MariaDB database for advanced functionality
 - Enable `USE_MYSQL` flag in config.py
 - Install latest mariadb by following instructions here https://downloads.mariadb.org/mariadb/repositories/
     - Tested versions: `mysql  Ver 15.1 Distrib 10.0.30-MariaDB, for debian-linux-gnu (x86_64) using readline 5.2`
@@ -35,52 +27,56 @@
     - `CREATE DATABASE nyaav2 DEFAULT CHARACTER SET utf8 COLLATE utf8_bin;`
     - `SOURCE ~/path/to/database/nyaa_maria_vx.sql`
 
-## Finishing up
+### Finishing up
 - Run `python db_create.py` to create the database
 - Load the .sql file
     - `mysql -u user -p nyaav2`
     - `SOURCE cocks.sql`
     - Remember to change the default user password to an empty string to disable logging in
 - Start the dev server with `python run.py`
-- Deactivate `source deactivate`
+- When you are finished developing, deactivate your virtualenv with `source deactivate`
 
-# Enabling ElasticSearch
+## Enabling ElasticSearch
 
-## Basics
+### Basics
 - Install jdk `sudo apt-get install openjdk-8-jdk`
 - Install elasticsearch https://www.elastic.co/guide/en/elasticsearch/reference/current/deb.html
 - `sudo systemctl enable elasticsearch.service`
 - `sudo systemctl start elasticsearch.service`
 - Run `curl -XGET 'localhost:9200'` and make sure ES is running
 - Optional: install Kabana as a search frontend for ES
 
-## Enable MySQL Binlogging
+### Enable MySQL Binlogging
 - Add the `[mariadb]` bin-log section to my.cnf and reload mysql server
 - Connect to mysql
 - `SHOW VARIABLES LIKE 'binlog_format';`
     - Make sure it shows ROW
 - Connect to root user
 - `GRANT REPLICATION SLAVE ON *.* TO 'test'@'localhost';` where test is the user you will be running `sync_es.py` with
 
-## Setting up ES
+### Setting up ES
 - Run `./create_es.sh` and this creates two indicies: `nyaa` and `sukebei`
 - The output should show `acknowledged: true` twice
 - The safest bet is to disable the webapp here to ensure there's no database writes
 - Run `python import_to_es.py` with `SITE_FLAVOR` set to `nyaa`
 - Run `python import_to_es.py` with `SITE_FLAVOR` set to `sukebei`
 - These will take some time to run as it's indexing
 
-## Setting up sync_es.py
+### Setting up sync_es.py
 - Sync_es.py keeps the ElasticSearch index updated by reading the BinLog
 - Configure the MySQL options with the user where you granted the REPLICATION permissions
 - Connect to MySQL, run `SHOW MASTER STATUS;`.
 - Copy the output to `/var/lib/sync_es_position.json` with the contents `{"log_file": "FILE", "log_pos": POSITION}` and replace FILENAME with File (something like master1-bin.000002) in the SQL output and POSITION (something like 892528513) with Position
 - Set up `sync_es.py` as a service and run it, preferably as the system/root
 - Make sure `sync_es.py` runs within venv with the right dependencies
 
-## Good to go!
-- After that, enable the `USE_ELASTIC_SEARCH` flag and restart the webapp and you're good to go
+Enable the `USE_ELASTIC_SEARCH` flag in `config.py`, restart the application, and you're good to go.
 
+## Database migrations
+- Uses [flask-Migrate](https://flask-migrate.readthedocs.io/)
+- Run `./db_migrate.py db migrate` to generate the migration script after database model changes.
+- Take a look at the result in `migrations/versions/...` to make sure nothing went wrong.
+- Run `./db_migrate.py db upgrade` to upgrade your database.
 
 ## Code Quality:
 - Remember to follow PEP8 style guidelines and run `./lint.sh` before committing.

config.example.py

@@ -11,7 +11,7 @@
 
 BASE_DIR = os.path.abspath(os.path.dirname(__file__))
 if USE_MYSQL:
-    SQLALCHEMY_DATABASE_URI = ('mysql://test:test123@localhost/nyaav2')
+    SQLALCHEMY_DATABASE_URI = ('mysql://test:test123@localhost/nyaav2?charset=utf8mb4')
 else:
     SQLALCHEMY_DATABASE_URI = (
         'sqlite:///' + os.path.join(BASE_DIR, 'test.db') + '?check_same_thread=False')

db_create.py

@@ -33,9 +33,3 @@
         db.session.add(main_cat)
 
     db.session.commit()
-
-# Create fulltext index
-
-if app.config['USE_MYSQL']:
-    db.engine.execute('ALTER TABLE ' + app.config['TABLE_PREFIX'] + 'torrents ADD FULLTEXT KEY (display_name)')
-

db_migrate.py

@@ -0,0 +1,13 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+from nyaa import app, db
+from flask_script import Manager
+from flask_migrate import Migrate, MigrateCommand
+
+migrate = Migrate(app, db)
+
+manager = Manager(app)
+manager.add_command("db", MigrateCommand)
+
+if __name__ == "__main__":
+	manager.run()

es_mapping.yml

@@ -21,14 +21,19 @@ settings:
           - resolution
           - lowercase
           - my_ngram
+          - word_delimit
     filter:
       my_ngram:
         type: edgeNGram
         min_gram: 1
         max_gram: 15
       resolution:
         type: pattern_capture
-        patterns: ["(\\d+)x(\\d+)"]
+        patterns: ["(\\d+)[xX](\\d+)"]
+      word_delimit:
+        type: word_delimiter
+        preserve_original: true
+        split_on_numerics: false
     char_filter:
       my_char_filter:
         type: mapping

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

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

migrations/env.py

@@ -0,0 +1,87 @@
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+import logging
+
+# 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',
+                       current_app.config.get('SQLALCHEMY_DATABASE_URI'))
+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)
+
+    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.readthedocs.org/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.')
+
+    engine = engine_from_config(config.get_section(config.config_ini_section),
+                                prefix='sqlalchemy.',
+                                poolclass=pool.NullPool)
+
+    connection = engine.connect()
+    context.configure(connection=connection,
+                      target_metadata=target_metadata,
+                      process_revision_directives=process_revision_directives,
+                      **current_app.extensions['migrate'].configure_args)
+
+    try:
+        with context.begin_transaction():
+            context.run_migrations()
+    finally:
+        connection.close()
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

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"}

migrations/versions/3001f79b7722_add_torrents.uploader_ip.py

@@ -0,0 +1,30 @@
+"""Add uploader_ip column to torrents table.
+
+Revision ID: 3001f79b7722
+Revises: 
+Create Date: 2017-05-21 18:01:35.472717
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '3001f79b7722'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('nyaa_torrents', sa.Column('uploader_ip', sa.Binary(), nullable=True))
+    op.add_column('sukebei_torrents', sa.Column('uploader_ip', sa.Binary(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('nyaa_torrents', 'uploader_ip')
+    op.drop_column('sukebei_torrents', 'uploader_ip')
+    # ### end Alembic commands ###