__init__.py

from fabric.api import (abort, cd, env, hide, local, run, settings,
                        task)
from fabric.contrib.files import (contains, exists, sed)
from fabric.contrib.console import (confirm)
from fabric.colors import blue, red, green
import cache
import db
import files
from contextlib import contextmanager
import re


# Source your local environment variables to make Drush work properly
env.shell = "/bin/bash -l -c -i"


@contextmanager
def _mute():
    """
    Run a fabric command without reporting any responses to the user.
    """
    with settings(warn_only='true'):
        with hide('running', 'stdout', 'stderr', 'warnings'):
            yield


def _header(txt):
    wrapper = "------------------------------------------------------"
    return blue(wrapper + "\n" + txt + "\n" + wrapper, bold=True)


def _which_download_app():
    """
    Find the path to a download application, prefering wget.
    Abort if neither is found.
    """
    with _mute():
        path = local("which wget", True)
        if path.return_code != 1:
            return path
        else:
            path = local("which curl", True)
            if path.return_code != 1:
                return path + " -O"
            else:
                abort("Please install wget or curl on your local system.")


def _cleanup_drush_output(o):
    """
    Cleanup drush output to get raw message string.
    """
    # Remove linebreaks
    r = ' '.join(o.splitlines())
    # Remove Drush decoration which can show up anywhere in the message
    r = re.sub('\[success\]', '', r)
    # Remove extraneous white space
    r = re.sub('\s+', ' ', r)
    return r


def confirm_overwrite(warning):
    answer = confirm(red(warning), default=False)
    if answer is not True:
        exit('Quiting')
    else:
        pass


def htaccess_exists(path):
    htaccess = path + '/.htaccess'
    if exists(htaccess):
        return True
    else:
        return False


def rewrite_base_enabled(path):
    """Check to see if RewriteBase is enabled on a Drupal site

    Args:
        path: Full path to a Drupal website

    Returns:
        A boolean. True is RewriteBase is enabled, False if not.
    """
    htaccess = path + '/.htaccess'
    # Look for an existing RewriteBase directive
    if contains(htaccess, "^.[^#]*RewriteBase \/.*$", escape=False):
        return True
    else:
        return False


@task
def site_install(path, db_user, db_pass, db_host, db_name):
    """Install a fresh Drupal site

    Use Drush to setup the Drupal structure in database


    Args:
        path: Directory of the website
        db_user: Database user to use when creating and running the Drupal site
        db_pass: That user's password
        db_host: Database host
        db_name: Database name
    """
    db_url = 'mysql://%s:%s@%s/%s' % (db_user, db_pass, db_host, db_name)
    warning = """
WARNING: This is an inherently insecure method for interacting with the
database since the database password will be written to the command line
and will be visible to anyone who can access the .mysql_history. Additionally,
while this command is being run the password is exposed to anyone who can run
the ps command on the server. Unfortunately this is the only method that
Drush currently supports.

Do you still wish to proceed?
"""
    confirm_overwrite(warning)

    with cd(path):
        run("drush site-install standard --db-url=" + db_url)


@task
def download(parent, name=None):
    """Download the latest Drupal project

    Args:
        parent: Parent directory where the site will be created
        name: Directory name for the site. Defaults to the Drupal project name
            (default None)

    Usage:
        $ fab -H localhost download:'/path/to/web/dir','vanilla'

        Will download the latest Drupal project to /path/to/web/dir/vanilla
    """
    with cd(parent):
        if not name:
            run("drush dl")
        else:
            run("drush dl --drupal-project-rename=%s" % name)


@task
def rewrite_base_enable(path, base=None):
    """Change the RewriteBase variable on a Drupal site

    Args:
        parent: Path to the website base
        base: RewriteBase string to add to the .htaccess file (default: None)

    Usage:
        $ fab -H localhost rewrite_base_enable:'/path/to/web/dir/site-name','site-name'

        Will modify the .htaccess file at /path/to/web/dir/site-name/.htaccess
        adding this RewriteBase directive:
            RewriteBase /site-name

        $ fab -H localhost rewrite_base_enable:'/path/to/web/dir'

        Will modify the .htaccess file at /path/to/web/dir/.htaccess
        adding this RewriteBase directive:
            RewriteBase /
    """
    htaccess = path + '/.htaccess'
    if htaccess_exists(path):
        if not rewrite_base_enabled(path):
            # sed the RewriteBase rule
            sed(htaccess, "^.*# RewriteBase /$", "  RewriteBase " + base)


@task
def vanilla_site(parent, name, db_name, base_url=None, rewrite_base=None):
    """Setup a complete, vanilla Drupal install

    Download Drupal, configure the settings.php database file, configure
    the .htaccess file, and then populate the database with the default
    Drupal structure.

    Args:
        parent: Parent directory where the site will be created
        name: Directory name for the site
        db_name: Name of the database that will be created for this site
        base_url: Base URL value to write in the settings.php file.
            If left blank, this value will remain commented out in settings.php
            ( default=None )
        rewrite_base: RewriteBase value to write in the .htaccess file.
            If left blank, this value will remain commented out in .htaccess
            ( default=None )

    Usage:
        $ fab -H 127.0.0.1 vanilla_site:'/path/to/web/dir','vanilla','drupal_vanilla'

        Will create a site at /path/to/web/dir/vanilla on your local machine.
        It will create a database called drupal_vanilla, populating with with
        the base Drupal tables.

        $ fab -H example.com vanilla_site:'/var/www/html,'special','drupal_dev_01','http://www.example.com/special','/special'

        Will create a site at http://example.com/special with the appropriate
        Apache config options to make it work in a sub-directory. Results
        will depend on your Apache configuration.
    """

    # TODO check for trailing slash
    path = parent + '/' + name

    print _header("Checking dependencies")
    if exists(path):
        warning = """
A folder already exists at your destination path.

Do you wish to overwrite?
"""
        confirm_overwrite(warning)
        run("chmod -R u+w %s" % path)
        run("rm -rf %s" % path)

    if db.mysql_cnf_password_set():
        password = db.get_mysql_pass()
        print
        print green("You're ready to build a Drupal site.")
        print
    else:
        exit('No MySQL credentials were found. Quitting.')

    print _header("Downloading Drupal.")
    download(parent, name)

    print _header("Configuring the RewriteBase in the .htaccess file.")
    rewrite_base_enable(path, rewrite_base)

    print _header("Making the files directory and a settings.php file")
    files.setup_files(path)
    files.setup_settings(path, db_name)

    print _header("Creating the database and loading Drupal structure.")
    site_install(path, 'bkennedy', password, '127.0.0.1', db_name)

    with cd(path):
        cache.clear()

    print _header("Your Drupal site is ready to go.")

    # run("drush dl -y devel backup_migrate")
    # Send an email as part of the Jenkins build or at least print the URL