root/freepbx/trunk/amp_conf/bin/module_admin

#!/usr/bin/php
<?php 
/** Command-line Module Administration script
 * (c) 2006 Greg MacLellan
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

define("AMP_CONF", "/etc/amportal.conf");

function out($text) {
    echo $text."\n";
}

function outn($text) {
    echo $text;
}

function error($text) {
    echo "[ERROR] ".$text."\n";
}

function fatal($text) {
    echo "[FATAL] ".$text."\n";
    exit(1);
}

function debug($text) {
    global $debug;
    
    if ($debug) echo "[DEBUG-preDB] ".$text."\n";
}


function install_parse_amportal_conf($filename) {
    $file = file($filename);
    foreach ($file as $line) {
        if (preg_match("/^\s*([a-zA-Z0-9]+)\s*=\s*(.*)\s*([;#].*)?/",$line,$matches)) { 
            $conf[ $matches[1] ] = $matches[2];
        }
    }
    return $conf;
}

function init_amportal_environment($ampconfpath) {
    global $amp_conf, $asterisk_conf, $db;
    
    if (!file_exists($ampconfpath)) {
        fatal('Cannot find conf file: '.$ampconfpath);
    }
    
    // primitive parse function, just to grab AMPWEBROOT
    $inst_amp_conf = install_parse_amportal_conf(AMP_CONF);
    
    define('AMP_BASE_INCLUDE_PATH', $inst_amp_conf['AMPWEBROOT'].'/admin');
    
    if (!file_exists(AMP_BASE_INCLUDE_PATH.'/functions.inc.php')) {
        fatal('Cannot locate '.AMP_BASE_INCLUDE_PATH.'/functions.inc.php');
    }    
    // include the functions file from WEBROOT
    include(AMP_BASE_INCLUDE_PATH.'/functions.inc.php');
    
    // now apply the real parse function (this makes some default assumptions and does a bit more error checking)
    $amp_conf = parse_amportal_conf($ampconfpath);
    
    $asterisk_conf = parse_asterisk_conf("/etc/asterisk/asterisk.conf");

    // connect to database
    if (!file_exists(AMP_BASE_INCLUDE_PATH.'/common/db_connect.php')) {
        fatal('Cannot locate '.AMP_BASE_INCLUDE_PATH.'/common/db_connect.php');
    }
    require_once(AMP_BASE_INCLUDE_PATH.'/common/db_connect.php'); //PEAR must be installed

}

function showHelp() {
    global $argv;
    out("USAGE:");
    out("  ".$argv[0]." [params] <operation> <module> [parameters.. ] ");
    out("PARAMETERS: ");
    out("  -f  Force operation (skips dependency and status checks)");
    out("      WARNING: Use at your own risk, modules have dependencies for a reason!");
    out("OPERATIONS:");
    out("  checkdepends <module>");
    out("      Check if module meets all dependencies");
    out("  delete <module>");
    out("      Disable, uninstall, and delete the specified module");
    out("  disable <module>");
    out("      Disable the specified module");
    out("  download <module>");
    out("      Download the module from the website");
    out("      If -f is used, downloads even if there is already a copy.");
    out("  enable <module>");
    out("      Enable the specified module");
    out("  info <module>");
    out("      Get information about a given module");
    out("  install <module>");
    out("      Install the module (must exist in the modules directory)");
    out("  list");
    out("      List all local modules and their current status");
    out("  listonline");
    out("      List all local and repository modules and their current status");
    out("  reversedepends <module>");
    out("      Show all modules that depend on this one");
    out("  uninstall <module>");
    out("      Disable and uninstall the specified module");
    out("  upgrade <module>");
    out("      Equivalent to running download and install");
    out("  upgradeall");
    out("      Downloads and upgrades all modules with pending updates");

    out("  --help, -h, -?           Show this help");
}

function showList($online = false) {
    $modules_local = module_getinfo();
    $modules = $modules_local;
    if ($online) {
        $modules_online = module_getonlinexml();
        $modules += $modules_online;
    }
    ksort($modules);
    
    outn(str_pad("Module", 20));
    outn(str_pad("Version", 12));
    out("Status");
    
    outn(str_repeat('-', 19).' ');
    outn(str_repeat('-', 11).' ');
    out(str_repeat('-', 19).' ');
    
    foreach (array_keys($modules) as $name) {
        
        switch ($modules[$name]['status']) {
            case MODULE_STATUS_NOTINSTALLED:
                if (isset($modules_local[$name])) {
                    $status = 'Not Installed (Locally available)';
                } else {
                    $status = 'Not Installed (Available online: '.$modules_online[$name]['version'].')';
                }
            break;
            case MODULE_STATUS_DISABLED:
                $status = 'Disabled';
            break;
            case MODULE_STATUS_NEEDUPGRADE:
                $status = 'Disabled; Pending upgrade to '.$modules[$name]['version'];
            break;
            case MODULE_STATUS_BROKEN:
                $status = 'Broken';
            break;
            default:
                // check for online upgrade
                if (isset($modules_online[$name]['version'])) {
                    $vercomp = version_compare($modules[$name]['version'], $modules_online[$name]['version']);
                    if ($vercomp < 0) {
                        $status = 'Online upgrade available ('.$modules_online[$name]['version'].')';
                    } else if ($vercomp > 0) {
                        $status = 'Newer than online version ('.$modules_online[$name]['version'].')';
                    } else {
                        $status = 'Enabled and up to date';
                    }
                } else if (isset($modules_online)) {
                    // we're connected to online, but didn't find this module
                    $status = 'Enabled; Not available online';
                } else {
                    $status = 'Enabled';
                }
            break;
        }
        
        outn(str_pad($name, 20));
        outn(str_pad($modules[$name]['dbversion'], 12));
        out($status);
    }
}

function showCheckDepends($modulename) {
    $modules = module_getinfo($modulename);
    if (!isset($modules[$modulename])) {
        fatal($modulename.' not found');
    }
    
    if (($depmods = module_reversedepends($modulename)) !== false) {
        out("The following modules depend on this one: ".implode(', ',$depmods));
        exit(1);
    } else {
        out("No enabled modules depend on this module.");
        exit(0);
    }
}
function showReverseDepends($modulename) {
    $modules = module_getinfo($modulename);
    if (!isset($modules[$modulename])) {
        fatal($modulename.' not found');
    }
    if (($errors = module_checkdepends($modules[$modulename])) !== true) {
        out("The following dependencies are not met:");
        out(' - '.implode("\n - ",$errors));
        exit(1);
    } else {
        out("All dependencies met for this module.");
        exit(0);
    }
}

function showInfo($modulename) {
    function recursive_print($array, $parentkey = '', $level=0) {
        foreach ($array as $key => $value) {
            if (is_array($value)) {
                // check if there is a numeric key in the sub-array, if so, we don't print the title
                if (!isset($value[0])) {
                    out(str_pad($key,15+($level * 3),' ',STR_PAD_LEFT).': ');
                }
                recursive_print($value, $key, $level + 1);
            } else {
                if (is_numeric($key)) {
                    // its just multiple parent keys, so we don't indent, and print the parentkey instead
                    out(str_pad($parentkey,15+(($level-1) * 3),' ',STR_PAD_LEFT).': '.$value);
                } else {
                    if ($key == 'status') {
                        switch ($value) {
                            case MODULE_STATUS_NOTINSTALLED: $value = 'Not Installed'; break;
                            case MODULE_STATUS_NEEDUPGRADE: $value = 'Disabled; Needs Upgrade'; break;
                            case MODULE_STATUS_ENABLED: $value = 'Enabled'; break;
                            case MODULE_STATUS_DISABLED: $value = 'Disabled'; break;
                            case MODULE_STATUS_BROKEN: $value = 'Broken'; break;
                        }
                    }
                    out(str_pad($key,15+($level * 3),' ',STR_PAD_LEFT).': '.$value);
                }
            }
        }
    }
    $modules = module_getinfo($modulename);
    if (!isset($modules[$modulename])) {
        fatal($modulename.' not found');
    }
    
    recursive_print($modules[$modulename]);
    
}

function doDisable($modulename, $force) {
    if (is_array($errors = module_disable($modulename, $force))) {
        out("The following error(s) occured:");
        out(' - '.implode("\n - ",$errors));
        exit(2);
    } else {
        out("Module successfully disabled");
        exit(0);
    }
}

function doEnable($modulename, $force) {
    if (is_array($errors = module_enable($modulename, $force))) {
        out("The following error(s) occured:");
        out(' - '.implode("\n - ",$errors));
        exit(2);
    } else {
        out("Module successfully enabled");
        exit(0);
    }
}

function doInstall($modulename, $force) {
    if (is_array($errors = module_install($modulename, $force))) {
        out("The following error(s) occured:");
        out(' - '.implode("\n - ",$errors));
        exit(2);
    } else {
        out("Module successfully installed");
        exit(0);
    }
}

function doUninstall($modulename, $force) {
    if (is_array($errors = module_uninstall($modulename, $force))) {
        out("The following error(s) occured:");
        out(' - '.implode("\n - ",$errors));
        exit(2);
    } else {
        out("Module successfully uninstalled");
        exit(0);
    }
}

function doDelete($modulename, $force) {
    if (is_array($errors = module_delete($modulename, $force))) {
        out("The following error(s) occured:");
        out(' - '.implode("\n - ",$errors));
        exit(2);
    } else {
        out("Module successfully deleted");
        exit(0);
    }
}

function doDownload($modulename, $force) {
    if (is_array($errors = module_download($modulename, $force, 'download_progress'))) {
        out("The following error(s) occured:");
        out(' - '.implode("\n - ",$errors));
        exit(2);
    } else {
        out("Module successfully downloaded");
        exit(0);
    }
}

function download_progress($action, $params) {
    switch ($action) {
        case 'untar':
            outn("\nUntaring..");
        break;
        case 'downloading':
            outn("\rDownloading ".$params['read'].' of '.$params['total'].' ('.round($params['read']/$params['total']*100).'%)            ');
            if ($params['read'] == $params['total']) {
                out('');
            }
        break;
        case 'done';
            out('Done');
        break;
    }
}

/****************************************************************************************************
 ****************************************************************************************************/

// from  ben-php dot net at efros dot com   at  php.net/install.unix.commandline
if (version_compare(phpversion(),'4.3.0','<') || !defined("STDIN")) {
    define('STDIN',fopen("php://stdin","r"));
    define('STDOUT',fopen("php://stdout","r"));
    define('STDERR',fopen("php://stderr","r"));
    register_shutdown_function( create_function( '' , 'fclose(STDIN); fclose(STDOUT); fclose(STDERR); return true;' ) );
}
   
// **** Make sure we have PEAR's DB.php, and include it
if (! @ include('DB.php')) {
    fatal("PEAR must be installed (requires DB.php). Include path: ".ini_get("include_path"));
}

// **** Make sure we have PEAR's GetOpts.php, and include it
if (! @ include("Console/Getopt.php")) {
    fatal("PEAR must be installed (requires Console/Getopt.php). Include path: ".ini_get("include_path"));
}

// **** Parse out command-line options
$shortopts = "h?fc:";
$longopts = array("help","debug","config=");

$args = Console_Getopt::getopt(Console_Getopt::readPHPArgv(), $shortopts, $longopts);
if (is_object($args)) {
    // assume it's PEAR_ERROR
    out($args->message);
    exit(255);
}

$ampconfpath = AMP_CONF;

$force = false;

foreach ($args[0] as $arg) {
    switch ($arg[0]) {
        case "--help": case "h": case "?":
            showHelp();
            exit(10);
        break;
        case 'f': 
            $force = true;
        break;
        case "--config": case "c":
            $ampconfpath = $arg[1];
        break;
    }
}

// create $amp_conf, $db, etc
init_amportal_environment($ampconfpath);

$operation = $args[1][0];
$param = $args[1][1];

if (!isset($argv[1])) {
    showhelp();
    exit(10);
}

if ($force) {
    out('WARNING: "force" is enabled, it is possible to create problems');
}

switch ($operation ) {
    case 'list':
        showList();
    break;
    case 'listonline':
        showList(true);
    break;
    case 'checkdepends':
        if (empty($param)) {
            fatal("Missing module name");
        }
        showDepends($param);
    break;
    case 'reversedepends':
        if (empty($param)) {
            fatal("Missing module name");
        }
        showCheckDepends($param);
    break;
    case 'info':
        if (empty($param)) {
            fatal("Missing module name");
        }
        showInfo($param);
    break;
    case 'download':
        if (empty($param)) {
            fatal("Missing module name");
        }
        doDownload($param, $force);
    break;
    case 'install':
    case 'upgrade':
        if (empty($param)) {
            fatal("Missing module name");
        }
        doInstall($param, $force);
    break;
    case 'enable':
        if (empty($param)) {
            fatal("Missing module name");
        }
        doEnable($param, $force);
    break;
    case 'disable':
        if (empty($param)) {
            fatal("Missing module name");
        }
        doDisable($param, $force);
    break;
    case 'uninstall':
        if (empty($param)) {
            fatal("Missing module name");
        }
        doUninstall($param, $force);
    break;
    case 'delete':
        if (empty($param)) {
            fatal("Missing module name");
        }
        doDelete($param, $force);
    break;
    default:
    case 'help':
        showhelp();
        exit(10);
    break;
}

?>