neo4j-instance.sh

#!/bin/bash

bash_version=`echo $BASH_VERSION |sed -e  "s/[^0-9\.]//g"`;

username=$(whoami);
startPort=7474;
startShellPort=1337;
startBoltPort=7687;
currentVersion="3.1.1";
neo4jType="community";
docker=0;
instancesDirectory="$HOME/neo4j-instances";

function vercomp {
    if [[ $1 == $2 ]]
    then
    echo "0";
    return 0;
    fi
    local IFS=.
    local i ver1=($1) ver2=($2)
    # fill empty fields in ver1 with zeros
    for ((i=${#ver1[@]}; i<${#ver2[@]}; i++))
    do
        ver1[i]=0
    done
    for ((i=0; i<${#ver1[@]}; i++))
    do
        if [[ -z ${ver2[i]} ]]
        then
            # fill empty fields in ver2 with zeros
            ver2[i]=0
        fi
        if ((10#${ver1[i]} > 10#${ver2[i]}))
        then
        echo 1;
        return 0; # Return zero, because this is okay
        fi
        if ((10#${ver1[i]} < 10#${ver2[i]}))
        then
            echo 2;
        return 2;
        fi
    done
    echo 0;
    return 0;
}


versionResults=`vercomp "$bash_version" "4.0"`;
if [[ "$versionResults" != 2  ]]; then 
    declare -A colors;
    colors=( ["blue"]="\e[1;34m" ["green"]="\e[1;32m" ["no-color"]="\e[0m" ["red"]="\e[1;31m" ["grey"]="\e[1;37m" ["magenta"]="\e[1;95m" ["purple"]="\e[38;5;135m" ["ecru"]="\e[33m" );
fi

function usage {
    read -r -d "" output << TXT
Usage: neo4j-instance [command]

The commands are as follows:
 help                           outputs this document
 create [option]                create a new database instance
     options:
        -d <db name>            sets the name of the neo4j instance. 
                                It will use "untitled<port-number>" if not determined
        -t <neo4j type>         sets the neo4j type (community | enterprise)
        -v <neo4j version>      sets neo4j version (default: $currentVersion)
        -c
 rename-db <port> <db name>     renames the db neo4j instance
 start <port>                   starts a neo4j instance
 stop <port>                    stops a neo4j instance
 destroy <port>                 destroys a database instance
 shell <port>                   allows you to enter in shell mode
 list                           list the different databases,
                                with their ports and their statuses
 plugin list [port]             list the available plugins for neo4j
 plugin install <alias> <port>  installs a plugin
 plugin install <alias> <port>  remove a plugin

Report bugs to levi@eneservices.com
TXT
    echo "$output";
    exit 1;
}

function setup {
    if [ "$username" == 'root' ]; then
        message "script should not be ran as root" "W" "red";
        exit;
    fi    
    if [ -d $instancesDirectory ]; then
        cd $instancesDirectory
    else        
        mkdir -p $instancesDirectory;
        cd "$instancesDirectory"
    fi

    if [ ! -d ports ]; then
        mkdir ports;
    fi
}

function portIsTaken {
    port=$1;
    if [ $( uname -s ) == "Darwin" ]; then
        if lsof -nP -i "4tcp:${port}" -s TCP:LISTEN > /dev/null; then
            return 0
        fi
    else
        if (netstat -tulpn 2>&1 | sed -e 's/\s\+/ /g' | cut -d " " -f4 >&1 | grep ":$port$" > /dev/null); then
            return 0;
        fi
    fi
    return 1;
}

function databaseExists {
    if grep "^$1\$" ports/*/db-name > /dev/null 2>&1; then
        return 0;
    fi
    return 1;
}

function message {
    message=$1
    tag=$2
    color=$3

    if [ ! -z "$tag" ]; then
    tag="*${colors[${color}]}$tag${colors["no-color"]}* ";
    fi

    echo -e "$tag$message";
}

function createDatabase {
    dbName="";
    lastShellPort=$startShellPort;
    lastBoltPort=$startBoltPort;
    currenBoltPort=$startBoltPort;
    boltStatus="off";
    lastPort=$(ls ports | sort | tail -n1);
    lastSslPort=$((lastPort - 1));

    if [ -z "$lastPort" ]; then
        lastPort="$startPort";
        lastSslPort=$((lastPort - 1));
    fi    
    if [ -d "ports/$lastPort" ]; then        
        lastBoltPort=$(cat ports/$lastPort/bolt-port);
        currenBoltPort=$((lastBoltPort + 1));

        while [ -d "ports/$lastPort" ]; do
            lastShellPort=$(cat ports/$lastPort/shell-port);
            lastPort=$((lastPort + 2));
            if ( ! portIsTaken $((lastShellPort + 1)) ); then
                lastShellPort=$((lastShellPort + 1));
            fi            
        done        
        lastSslPort=$((lastPort-1));
        
        while portIsTaken $((currenBoltPort)) ; do
            currenBoltPort=$((currenBoltPort+1));        
        done                
    fi
    OPTIND=2;
    # set neo4j type and version
    while getopts "d:t:v:c" o; do
        case "$o" in
            d)  if  databaseExists "$OPTARG"; then
                    message "database name is already taken" "E" "red";
                    exit;
                fi
                dbName=$OPTARG;
                ;;
            t)  type=$OPTARG;
                (( "$type" == "community" || "$type" == "enterprise")) && neo4jType=$type;
                ;;
            v)  version=$OPTARG;
                if [[ $version =~ ^[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+$ ]]; then
                    currentVersion=$version
                fi
                ;;
            c)  docker=1;
                ;;
            *) usage;
                ;;
        esac
    done


    skeletonPath="./neo4j-skeleton/${neo4jType}-${currentVersion}"
    if [ ! -d "$skeletonPath" ]; then
        echo "Creating skeleton in ${skeletonPath}..."
        mkdir -p "${skeletonPath}"
        if hash curl; then
            curl -# -L "http://neo4j.com/artifact.php?name=neo4j-${neo4jType}-${currentVersion}-unix.tar.gz" | tar xzC "neo4j-skeleton/${neo4jType}-${currentVersion}/" --strip-components 1
        elif hash wget; then
            wget -O- "http://neo4j.com/artifact.php?name=neo4j-${neo4jType}-${currentVersion}-unix.tar.gz" | tar xzC "neo4j-skeleton/${neo4jType}-${currentVersion}/" --strip-components 1
        else
            message "please install curl or wget" "W" "blue";
            exit;
        fi
    fi
    if [ ! -d "ports/$lastPort" ]; then
        message "create database" "X" "green";        
        cp -r $skeletonPath "ports/$lastPort";
        if [ -e "${skeletonPath}/conf/neo4j.properties" ]; then
            cat "${skeletonPath}/conf/neo4j-server.properties" | sed -e "s/org.neo4j.server.webserver.port=7474/org.neo4j.server.webserver.port=$lastPort/" | sed -e "s/org.neo4j.server.webserver.https.port=7473/org.neo4j.server.webserver.https.port=$lastSslPort/" > ports/$lastPort/conf/neo4j-server.properties
            cat "${skeletonPath}/conf/neo4j.properties" | sed -e "s/^#remote_shell_port/remote_shell_port/" | sed -e "s/remote_shell_port=1337/remote_shell_port=$lastShellPort/" > ports/$lastPort/conf/neo4j.properties
            cat "${skeletonPath}/conf/neo4j.properties" | sed -e "s/^#remote_shell_port/remote_shell_port/" | sed -e "s/remote_shell_port=1337/remote_shell_port=$lastShellPort/" | sed -e "s/online_backup_enabled=true/online_backup_enabled=false/" > ports/$lastPort/conf/neo4j.properties
            currenBoltPort = $lastBoltPort;
            boltStatus='off';
        fi
        if [ -e "${skeletonPath}/conf/neo4j.conf" ]; then
            if  grep -q "#dbms.connector.http.address=0.0.0.0:7474" ${skeletonPath}/conf/neo4j.conf ; then
                cat "${skeletonPath}/conf/neo4j.conf" | sed -e "s/#dbms.connector.http.address=0.0.0.0:7474/dbms.connector.http.address=localhost:$lastPort/" | sed -e "s/dbms.connector.https.address=localhost:7473/dbms.connector.https.address=localhost:$lastSslPort/" | sed -e "s/dbms.connector.bolt.enabled=true/dbms.connector.bolt.enabled=false/" > ports/$lastPort/conf/neo4j.conf
                boltStatus='on';
            fi
            if  grep -q "#dbms.connector.http.listen_address=:7474"  ${skeletonPath}/conf/neo4j.conf ; then                
                cat "${skeletonPath}/conf/neo4j.conf" | sed -e "s/#dbms.connector.http.listen_address=:7474/dbms.connector.http.listen_address=:$lastPort/" | sed -e "s/#dbms.connector.https.listen_address=:7473/dbms.connector.https.listen_address=:$lastSslPort/" | sed -e "s/#dbms.connector.bolt.listen_address=:7687/dbms.connector.bolt.listen_address=:$lastBoltPort/" > ports/$lastPort/conf/neo4j.conf
                boltStatus='on';
            fi
        fi
        
        if [ -z "$dbName" ]; then
            dbName="untitled$lastPort";
        fi        
        echo -n "$dbName" > ports/$lastPort/db-name
        echo -n "$neo4jType" > ports/$lastPort/db-type
        echo -n "$currentVersion" > ports/$lastPort/db-version
        echo -n "$lastShellPort" > ports/$lastPort/shell-port
        echo -n "$currenBoltPort" > ports/$lastPort/bolt-port
        echo -n "$boltStatus" > ports/$lastPort/bolt-status
    fi
}

function renameDatabase {
    if [ -d "ports/$2" ]; then
        if databaseExists "$3"; then
            message "database already exists" "E" "red";
            exit 1;
        else
            echo -n "$3" > "ports/$2/db-name";
            message "database name renamed" "M" "blue";
        fi
    else
        message "port was not given" "E" "red";
    fi
}

function getPlugins {
    plugins="";
    if hash curl; then
        curl -vs http://www.diracian.com/neo4j-plugins/$currentVersion 2> /dev/null 1> plugins;
    elif hash wget; then
        wget -qO-http://www.diracian.com/neo4j-plugins/$currentVersion 2> /dev/null 1> plugins;
    fi
    cat plugins
}

function plugin {
    if [ ! -z "$3" ] && [ "$2" == "list" ] && [ -d "ports/$3" ]; then
        for i in `ls "ports/$3/plugins/" | grep '\.jar$'`; do
            OLDIFS=$IFS;
            IFS=$'\n';
            for line in `cat plugins | grep "$i" `; do
                alias=$(echo $line | cut -d"|" -f1);
                name=$(echo $line | cut -d"|" -f2);
                pad=$(printf "%-6s" "$alias");

                message "    ${colors["blue"]}[${colors["no-color"]}${colors["green"]}$pad${colors["no-color"]}${colors["blue"]}]${colors["no-color"]} - ${colors["magenta"]}$name${colors["no-color"]}";
            done
            IFS=$OLDIFS;
        done
    elif [ "$2" == "list" ]; then
        message "neo4j plugins you can install:" "M" "blue";

        plugins=$(getPlugins);
        OLDIFS=$IFS;
        IFS=$'\n';
        for line in $plugins; do
            alias=$(echo $line | cut -d"|" -f1);
            name=$(echo $line | cut -d"|" -f2);
            pad=$(printf "%-6s" "$alias");

            message "    ${colors["blue"]}[${colors["no-color"]}${colors["green"]}$pad${colors["no-color"]}${colors["blue"]}]${colors["no-color"]} - ${colors["magenta"]}$name${colors["no-color"]}";
        done
        IFS=$OLDIFS;
    elif [ "$2" == "install" ] && [ -d "ports/$4" ]; then
        for i in `cat plugins | grep "$3" | cut -d"|" -f3`; do
            url=$(echo $i | cut -d"|" -f3);
            filename=${url##*/};
            if [ -f "ports/$4/plugins/$filename" ]; then
                message "plugin is already installed." "E" "red";
            else
                if hash curl; then
                    curl -# -L "$url" -o "ports/$4/plugins/$filename";
                elif hash wget; then
                    wget "$url" -O "ports/$4/plugins/$filename";
                fi
            fi
        done
    elif [ "$2" == "remove" ] && [ -d "ports/$4" ]; then
        for i in `cat plugins | grep "$3" | cut -d"|" -f3`; do
            url=$(echo $i | cut -d"|" -f3);
            filename=${url##*/};
            if [ -f "ports/$4/plugins/$filename" ]; then
                rm "ports/$4/plugins/$filename";
                message "plugin [$3 -- $filename] was removed." "M" "blue";
            else
                message "plugin is not installed." "E" "red";
            fi
        done
    elif [ ! -d "ports/$4" ]; then
        message "port [$4] does not exists." "E" "red";
    fi
}

function displayList {
    if [ "$2" == "plugins" ]; then
        message "neo4j plugins you can install:" "M" "blue";

        if hash curl; then
            downloader_string="curl -vs";
        elif hash wget; then
            downloader_string="wget -qO-";
        fi
        plugins=$($downloader_string http://internal.www.diracian.com/neo4j-plugins/$currentVersion);

        OLDIFS=$IFS;
        IFS=$'\n';
        for line in $plugins; do
            alias=$(echo $line | cut -d"|" -f1);
            name=$(echo $line | cut -d"|" -f2);
            pad=$(printf "%-6s" "$alias");

            message "${colors["blue"]}[${colors["no-color"]}${colors["green"]}$pad${colors["no-color"]}${colors["blue"]}]${colors["no-color"]} - ${colors["magenta"]}$name${colors["no-color"]}";
        done
        IFS=$OLDIFS;

    else
        message "neo4j databases:" "M" "blue";
        message "    port - Bolt Port - Status - <Type> - [Name]"
        for x in $(ls ports); do
            dbAddon="";
            if (portIsTaken "$x"); then
                status="${colors["green"]}on ${colors["no-color"]}";
            else
                status="${colors["blue"]}off${colors["no-color"]}";
            fi
            if [ -f "ports/$x/db-name" ]; then
                dbName=$(cat "ports/$x/db-name");
                type=$(cat "ports/$x/db-type");
                version=$(cat "ports/$x/db-version");
                boltPort=$(cat "ports/$x/bolt-port");
                boltStatus=$(cat "ports/$x/bolt-status");
                if [ "$boltStatus" = "off" ]; then
                    boltPort="x";
                fi
                typeInfo=$(printf "%10s" "$type");
            #    dbAddon="- <${colors["grey"]}$typeInfo${colors["no-color"]}:${colors["ecru"]}$version${colors["no-color"]}> - db [${colors["purple"]}$dbName${colors["no-color"]}]";
                dbAddon="- <${colors["grey"]}$typeInfo${colors["no-color"]}:${colors["ecru"]}$version${colors["no-color"]}> - [${colors["purple"]}$dbName${colors["no-color"]}]";
            fi
            # message "    $x - status [$status] $dbAddon";
            message "    $x - $boltPort - [$status] $dbAddon";
        done
    fi
}

function destroyDatabase {
    if [ ! -z "$2" ] && [ -d "ports/$2" ]; then
        if (portIsTaken "$2"); then
            ./ports/"$2"/bin/neo4j stop;
        fi
        rm -r "ports/$2";
        message "database on port [$2] was deleted" "M" "blue";
    else
        if [ ! -d "ports/$2" ]; then
            message "port [$2] does not exist" "W" "red";
        else
            message "was unable to delete port [$2]" "W" "red";
        fi
    fi
}

function check {
    if [ "$1" == "start" ] && (portIsTaken "$2"); then
        message "database already started" "W" "red";
        return 1;
    elif [ "$1" == "stop" ] && (! portIsTaken "$2") && [ -d "ports/$2" ]; then
        message "database was already stopped" "W" "red";
        return 1;
    elif [ ! -d "ports/$2" ]; then
        message "database was never created for that port" "W" "red";
        return 1;
    fi
    return 0;
}

function databaseCommand {
    if (check "${@}"); then
        cd "ports/$2/bin";
        ./neo4j "$1";
    fi
}

function startDatabase {
    databaseCommand "${@}" | grep http;
}

function stopDatabase {
    databaseCommand "${@}";
}

function databaseStatus {
    databaseCommand "${@}";
}

function startShell {
    shellPort=$(cat ./ports/"$2"/shell-port);
    if (portIsTaken "$2"); then
        ./ports/"$2"/bin/neo4j-shell -port "$shellPort";
    else
        message "database has not been started" "W" "red";
    fi
}

setup;

case "$1" in
    create)
        createDatabase "${@}";
        ;;
    rename-db)
        renameDatabase "${@}";
        ;;
    start)
        startDatabase "${@}";
        ;;
    stop)
        stopDatabase "${@}";
        ;;
    destroy)
        destroyDatabase "${@}";
        ;;
    shell)
        startShell "${@}";
        ;;
    list)
        displayList "${@}";
        ;;
     plugin)
        plugin "${@}";
        ;;
    *)
        usage;
        ;;
esac