Add makeconfig command. WIP

flaskbb/cli/main.py

@@ -12,6 +12,7 @@ import sys
 import os
 import time
 import requests
+import binascii
 
 import click
 from werkzeug.utils import import_string, ImportStringError
@@ -403,3 +404,95 @@ def list_urls(order_by):
     for rule in rules:
         methods = ", ".join(rule.methods)
         click.echo(column_template.format(rule.rule, rule.endpoint, methods))
+
+
+@flaskbb.command("makeconfig")
+@click.option("--debug", "-d", default=False, is_flag=True,
+              help="Creates a development config with DEBUG set to True.")
+@click.option("--output", "-o", default=".",
+              help="The path where the config file will be saved at.")
+def generate_config(debug, output):
+    configvars = {"is_debug": debug}
+
+    click.secho("The name and port number of the server.\n"
+                "This is needed to correctly generate URLs when no request "
+                "context is available.", fg="cyan")
+    configvars["server_name"] = click.prompt(
+        click.style("Server Name", fg="magenta"), type=str,
+        default="forums.flaskbb.org")
+
+    click.secho("The URL Scheme is also needed in order to generate correct "
+                "URLs when no request context is available.\n"
+                "Choose either 'https' or 'http'.", fg="cyan")
+    configvars["url_scheme"] = click.prompt(
+        click.style("URL Scheme", fg="magenta"),
+        type=click.Choice(["https", "http"]), default="https")
+
+    click.secho("For Postgres use:\n"
+                "    postgresql://flaskbb@localhost:5432/flaskbb\n"
+                "For more options see the SQLAlchemy docs:\n"
+                "    http://docs.sqlalchemy.org/en/latest/core/engines.html",
+                fg="cyan")
+    configvars["database_url"] = click.prompt(
+        click.style("Database URI", fg="magenta"),
+        default="sqlite:///" + os.path.join(
+            os.path.dirname(current_app.root_path), "flaskbb.sqlite"))
+
+    click.secho("Redis will be used for things such as the task queue, "
+                "caching and rate limiting.", fg="cyan")
+    configvars["use_redis"] = click.confirm(
+        click.style("Would you like to use redis?", fg="magenta"),
+        default=True)
+
+    if configvars.get("use_redis", False):
+        configvars["redis_url"] = click.prompt(
+            click.style("Redis URI", fg="magenta"),
+            default="redis://localhost:6379")
+    else:
+        configvars["redis_url"] = ""
+
+    click.secho("To use 'localhost' make sure that you have sendmail or\n"
+                "anything similar installed. Gmail is also supprted.",
+                fg="cyan")
+    configvars["mail_server"] = click.prompt(
+        click.style("Mail Server", fg="magenta"),
+        default="localhost")
+    configvars["mail_port"] = click.prompt(
+        click.style("Mail Server SMTP Port", fg="magenta"),
+        default="25")
+    configvars["mail_use_ssl"] = click.confirm(
+        click.style("Use SSL for sending mails?", fg="magenta"),
+        default=False)
+    configvars["mail_use_tls"] = click.confirm(
+        click.style("Use TLS for sending mails?", fg="magenta"),
+        default=False)
+    configvars["mail_username"] = click.prompt(
+        click.style("Mail Username", fg="magenta"),
+        default="")
+    configvars["mail_password"] = click.prompt(
+        click.style("Mail Password", fg="magenta"),
+        default="")
+    configvars["mail_sender_name"] = click.prompt(
+        click.style("Mail Sender Name", fg="magenta"),
+        default="FlaskBB Mailer")
+    configvars["mail_sender_address"] = click.prompt(
+        click.style("Mail Sender Address", fg="magenta"),
+        default="noreply@yourdomain.org")
+    configvars["mail_admin_address"] = click.prompt(
+        click.style("Mail Admin Email", fg="magenta"),
+        default="admin@youremailaddress.org")
+
+    config_path = os.path.join(
+        os.path.dirname(current_app.root_path), "flaskbb.cfg"
+    )
+    configvars["config_path"] = click.prompt(
+        click.style("Output Path", fg="magenta"),
+        default=config_path)
+
+    click.secho("The configuration file has been saved to: {cfg}\n"
+                "You can use it like this: flaskbb --config {cfg} run\n"
+                "Feel free to further adjust it as needed."
+                .format(cfg=config_path), fg="green")
+
+    configvars["secret_key"] = binascii.hexlify(os.urandom(24)).decode()
+    configvars["csrf_secret_key"] = binascii.hexlify(os.urandom(24)).decode()

flaskbb/cli/utils.py

@@ -12,11 +12,11 @@
 import sys
 import os
 import re
-
+import binascii
 
 import click
 
-from flask import __version__ as flask_version
+from flask import current_app, __version__ as flask_version
 from flask_themes2 import get_theme
 
 from flaskbb import __version__
@@ -137,3 +137,161 @@ def get_version(ctx, param, value):
         'python_version': sys.version.split("\n")[0]
     }, color=ctx.color)
     ctx.exit()
+
+
+CONFIG_TEMPLATE = """
+import os
+import datetime
+from flaskbb.configs.default import DefaultConfig
+
+# Flask Settings
+# ------------------------------
+# There is a whole bunch of more settings available here:
+# http://flask.pocoo.org/docs/0.11/config/#builtin-configuration-values
+DEBUG = {is_debug}
+TESTING = False
+
+# Server Name - REQUIRED for Celery/Mailing
+# The name and port number of the server.
+# Required for subdomain support (e.g.: 'myapp.dev:5000') and
+# URL generation without a request context but with an application context
+# which we need in order to generate URLs (with the celery application)
+# Note that localhost does not support subdomains so setting this to
+# “localhost” does not help.
+# Example for the FlaskBB forums: SERVER_NAME = "forums.flaskbb.org"
+SERVER_NAME = {server_name}
+
+# Prefer HTTPS over HTTP
+PREFERRED_URL_SCHEME = "{url_scheme}"
+
+# If SEND_LOGS is set to True, the admins (see the mail configuration) will
+# recieve the error logs per email.
+SEND_LOGS = False
+
+# The filename for the info and error logs. The logfiles are stored at
+# flaskbb/logs
+INFO_LOG = "info.log"
+ERROR_LOG = "error.log"
+
+# Database
+# ------------------------------
+#SQLALCHEMY_DATABASE_URI = "{database_url}"
+
+# This option will be removed as soon as Flask-SQLAlchemy removes it.
+# At the moment it is just used to suppress the super annoying warning
+SQLALCHEMY_TRACK_MODIFICATIONS = False
+# This will print all SQL statements
+SQLALCHEMY_ECHO = False
+
+# Security - IMPORTANT
+# ------------------------------
+# This is the secret key that is used for session signing.
+# You can generate a secure key with os.urandom(24)
+SECRET_KEY = "{secret_key}"
+
+# You can generate the WTF_CSRF_SECRET_KEY the same way as you have
+# generated the SECRET_KEY. If no WTF_CSRF_SECRET_KEY is provided, it will
+# use the SECRET_KEY.
+WTF_CSRF_ENABLED = True
+WTF_CSRF_SECRET_KEY = "{csrf_secret_key}"
+
+# Full-Text-Search
+# ------------------------------
+# This will use the "whoosh_index" directory to store the search indexes
+WHOOSHEE_DIR = os.path.join(DefaultConfig._basedir, "whoosh_index", DefaultConfig._version_str)
+# How long should whooshee try to acquire write lock? (defaults to 2)
+WHOOSHEE_WRITER_TIMEOUT = 2
+# Minimum number of characters for the search (defaults to 3)
+WHOOSHEE_MIN_STRING_LEN = 3
+
+# Auth
+# ------------------------------
+LOGIN_VIEW = "auth.login"
+REAUTH_VIEW = "auth.reauth"
+LOGIN_MESSAGE_CATEGORY = "info"
+REFRESH_MESSAGE_CATEGORY = "info"
+
+# The name of the cookie to store the “remember me” information in.
+REMEMBER_COOKIE_NAME = "remember_token"
+# The amount of time before the cookie expires, as a datetime.timedelta object.
+# Default: 365 days (1 non-leap Gregorian year)
+REMEMBER_COOKIE_DURATION = datetime.timedelta(days=365)
+# If the “Remember Me” cookie should cross domains,
+# set the domain value here (i.e. .example.com would allow the cookie
+# to be used on all subdomains of example.com).
+REMEMBER_COOKIE_DOMAIN = None
+# Limits the “Remember Me” cookie to a certain path.
+REMEMBER_COOKIE_PATH = "/"
+# Restricts the “Remember Me” cookie’s scope to secure channels (typically HTTPS).
+REMEMBER_COOKIE_SECURE = None
+# Prevents the “Remember Me” cookie from being accessed by client-side scripts.
+REMEMBER_COOKIE_HTTPONLY = False
+
+# Redis
+# ------------------------------
+# If redis is enabled, it can be used for:
+#   - Sending non blocking emails via Celery (Task Queue)
+#   - Caching
+#   - Rate Limiting
+REDIS_ENABLED = {use_redis}
+REDIS_URL = {redis_url}
+REDIS_DATABASE = 0
+
+# Celery
+# ------------------------------
+CELERY_BROKER_URL = REDIS_URL
+CELERY_RESULT_BACKEND = REDIS_URL
+
+# Rate Limiting via Flask-Limiter
+# -------------------------------
+# A full list with configuration values is available at the flask-limiter
+# docs, but you actually just need those settings below.
+# You can disabled the Rate Limiter here as well - it will overwrite
+# the setting from the admin panel!
+# RATELIMIT_ENABLED = True
+# You can choose from:
+#   memory:// (default)
+#   redis://host:port
+#   memcached://host:port
+# Using the redis storage requires the installation of the redis package,
+# which will be installed if you enable REDIS_ENABLE while memcached
+# relies on the pymemcache package.
+RATELIMIT_STORAGE_URL = REDIS_URL
+
+# Caching
+# ------------------------------
+# For all available caching types, have a look at the Flask-Cache docs
+# https://pythonhosted.org/Flask-Caching/#configuring-flask-caching
+CACHE_TYPE = "simple" if not REDIS_ENABLED else "redis"
+CACHE_DEFAULT_TIMEOUT = 60
+
+# Mail
+# ------------------------------
+# Google Mail Example
+#MAIL_SERVER = "smtp.gmail.com"
+#MAIL_PORT = 465
+#MAIL_USE_SSL = True
+#MAIL_USERNAME = "your_username@gmail.com"
+#MAIL_PASSWORD = "your_password"
+#MAIL_DEFAULT_SENDER = ("Your Name", "your_username@gmail.com")
+
+# Local SMTP Server
+MAIL_SERVER = "{mail_server}"
+MAIL_PORT = {mail_port}
+MAIL_USE_SSL = {mail_use_ssl}
+MAIL_USE_TLS = {mail_use_tls}
+MAIL_USERNAME = "{mail_username}"
+MAIL_PASSWORD = "{mail_password}"
+MAIL_DEFAULT_SENDER = ("{mail_sender_name}", "{mail_sender_address}")
+# Where to logger should send the emails to
+ADMINS = ["{mail_admin_address}"]
+
+# FlaskBB Settings
+# ------------------------------ #
+# URL Prefixes
+FORUM_URL_PREFIX = ""
+USER_URL_PREFIX = "/user"
+MESSAGE_URL_PREFIX = "/message"
+AUTH_URL_PREFIX = "/auth"
+ADMIN_URL_PREFIX = "/admin"
+"""