root/freepbx/trunk/amp_conf/bin/retrieve_conf

#!/usr/bin/env php

<?php

define("AMP_CONF", "/etc/amportal.conf");
define("ASTERISK_CONF", "/etc/asterisk/asterisk.conf");
define("WARNING_BANNER", "; do not edit this file, this is an auto-generated file by freepbx\n; all modifications must be done from the web gui\n\n\n" );

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 showHelp() {
  out("Optional parameters:");
  out("  --help, -h, -?           Show this help");
  out("  --debug                  Enable debug output");
  out("  --dry-run                Don't actually do anything");
}


function parse_amportal_conf2($filename) {
  $file = file($filename);
  foreach ($file as $line) {
    if (preg_match("/^\s*([\w]+)\s*=\s*\"?([\w\/\:\.\%-]*)\"?\s*([;#].*)?/",$line,$matches)) {
      $conf[ $matches[1] ] = $matches[2];
    }
  }

  // use same defaults as function.inc.php
  if ( !isset($conf["AMPDBENGINE"]) || ($conf["AMPDBENGINE"] == "")) {
    $conf["AMPDBENGINE"] = "mysql";
  }
  
  if ( !isset($conf["AMPDBNAME"]) || ($conf["AMPDBNAME"] == "")) {
    $conf["AMPDBNAME"] = "asterisk";
  }
  
  if ( !isset($conf["AMPENGINE"]) || ($conf["AMPENGINE"] == "")) {
    $conf["AMPENGINE"] = "asterisk";
  }

  return $conf;
}

function parse_asterisk_conf2($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;
}

/** Adds a trailing slash to a directory, if it doesn't already have one
 */
function addslash($dir) {
  return (($dir[ strlen($dir)-1 ] == '/') ? $dir : $dir.'/');
}


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

// **** Make sure we have STDIN etc

// 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

outn("Checking for PEAR DB..");
if (! @ include('DB.php')) {
  out("FAILED");
  fatal("PEAR must be installed (requires DB.php). Include path: ".ini_get("include_path"));
}
out("OK");


// **** Make sure we have PEAR's GetOpts.php, and include it

outn("Checking for PEAR Console::Getopt..");
if (! @ include("Console/Getopt.php")) {
  out("FAILED");
  fatal("PEAR must be installed (requires Console/Getopt.php). Include path: ".ini_get("include_path"));
}
out("OK");


// **** Parse out command-line options

$shortopts = "h?u:p:";
$longopts = array("help","debug","dry-run","run-install");

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

$debug = false;
$dryrun = false;
$run_install = false;

foreach ($args[0] as $arg) {
  switch ($arg[0]) {
    case "--help": case "h": case "?":
      showHelp();
      exit(10);
    break;
    case "--dry-run":
      out("Dry-run only, no files will be written");
      $dryrun = true;
    break;
    case "--debug":
      $debug = true;
      debug("Debug mode enabled");
    break;
    case "--run-install":
      $run_install = true;
      out("Running module install.php and install.sql scripts");
    break;
  }
}

// **** Check for amportal.conf

outn("Checking for ".AMP_CONF."..");
if (!file_exists(AMP_CONF)) {
  fatal("Does not exist, or is inaccessible");
}
out("OK");

// **** read amportal.conf

outn("Reading ".AMP_CONF."..");
$amp_conf = parse_amportal_conf2(AMP_CONF);
if (count($amp_conf) == 0) {
  fatal("FAILED");
}
out("OK");

outn("Reading ".ASTERISK_CONF."..");
$asterisk_conf = parse_asterisk_conf2(ASTERISK_CONF);
if (count($asterisk_conf) == 0) {
  fatal("FAILED");
}
out("OK");

// **** Connect to database

outn("Connecting to database..");

# the engine to be used for the SQL queries,
# if none supplied, backfall to mysql
$db_engine = "mysql";
if (isset($amp_conf["AMPDBENGINE"])){
  $db_engine = $amp_conf["AMPDBENGINE"];
}

// **** Create symlinks array
$symlink_dirs = array();
$symlink_dirs['agi-bin'] = (isset($amp_conf['ASTAGIDIR']) ? $amp_conf['ASTAGIDIR'] : '/var/lib/asterisk/agi-bin');
$symlink_dirs['sounds'] = (isset($amp_conf['ASTVARLIBDIR']) ? $amp_conf['ASTVARLIBDIR'] : '/var/lib/asterisk').'/sounds';
$symlink_dirs['bin'] = (isset($amp_conf['AMPBIN']) ? $amp_conf['AMPBIN'] : '/var/lib/asterisk/bin');
$symlink_dirs['etc'] = (isset($amp_conf['ASTETCDIR']) ? $amp_conf['ASTETCDIR'] : '/etc/asterisk');

switch ($db_engine)
{
  case "pgsql":
  case "mysql":
    /* datasource in in this style:
    dbengine://username:password@host/database */
  
    $db_user = $amp_conf["AMPDBUSER"];
    $db_pass = $amp_conf["AMPDBPASS"];
    $db_host = $amp_conf["AMPDBHOST"];
    $db_name = $amp_conf["AMPDBNAME"];
  
    $datasource = $db_engine.'://'.$db_user.':'.$db_pass.'@'.$db_host.'/'.$db_name;
    $db = DB::connect($datasource); // attempt connection
    break;
  
  case "sqlite":
    require_once('DB/sqlite.php');
  
    if (!isset($amp_conf["AMPDBFILE"]))
      die("You must setup properly AMPDBFILE in /etc/amportal.conf");
  
    if (isset($amp_conf["AMPDBFILE"]) == "")
      die("AMPDBFILE in /etc/amportal.conf cannot be blank");
  
    $DSN = array (
      "database" => $amp_conf["AMPDBFILE"],
      "mode" => 0666
    );
  
    $db = new DB_sqlite();
    $db->connect( $DSN );
    break;
  
  default:
    die( "Unknown SQL engine: [$db_engine]");
}

if(DB::isError($db)) {
  out("FAILED");
  debug($db->userinfo);
  fatal("Cannot connect to database");
  
}
out("OK");


//TODO : make this engine-neutral
outn("Connecting to Asterisk manager interface..");
// connect to asterisk manager
require_once($amp_conf['AMPWEBROOT'].'/admin/common/php-asmanager.php');
$astman = new AGI_AsteriskManager(); 
if (! $res = $astman->connect("127.0.0.1", $amp_conf["AMPMGRUSER"] , $amp_conf["AMPMGRPASS"])) { 
  out("FAILED");
  fatal("Cannot connect to manager interface");
}
out("OK");

//include common functions
require_once($amp_conf['AMPWEBROOT']."/admin/extensions.class.php");
require_once($amp_conf['AMPWEBROOT']."/admin/functions.inc.php");
freepbx_log("retrieve_conf", "devel-debug", "Started retrieve_conf, DB Connection OK");

// query for our modules
// var_dump( $db );
$modules = module_getinfo();

//Putting the core module last, to move outbound-allroutes 
// last in from-internals-additional
if (array_key_exists('core', $modules)) {
        $core_tmp = $modules['core'];
        unset($modules['core']);
        $modules['core'] = $core_tmp;
}

// include any module global functions
if(is_array($modules)){
  foreach($modules as $key => $module) {
    //only use this module if it's enabled (status=2)
    if (isset($module['status']) && $module['status'] == MODULE_STATUS_ENABLED) {
      // Make sure the module is installed and up to date
      if ($run_install) module_install($key);
      // active_modules array used in genConf function
      $active_modules[] = $key;
      //include module functions
      if (is_file($amp_conf['AMPWEBROOT']."/admin/modules/{$key}/functions.inc.php")) {
        freepbx_log('retrieve_conf', 'devel-debug', 'Including '.$amp_conf['AMPWEBROOT']."/admin/modules/{$key}/functions.inc.php");
        include_once($amp_conf['AMPWEBROOT']."/admin/modules/{$key}/functions.inc.php");
        freepbx_log('retrieve_conf', 'devel-debug', $amp_conf['AMPWEBROOT']."/admin/modules/{$key}/functions.inc.php processed OK");
      }

      // create symlinks for files in appropriate sub directories
      symlink_subdirs( $amp_conf['AMPWEBROOT'].'/admin/modules/'.$key );
    }
  }
}

// create an object of the extensions class
require_once($amp_conf['AMPWEBROOT']."/admin/extensions.class.php");
$ext = new extensions;

// create objects for any module classes
// currently only 1 class can be declared per module, not sure if that will be an issue
if(isset($active_modules) && is_array($active_modules)){
  foreach($active_modules as $active_module) { 
    freepbx_log('retrieve_conf', 'devel-debug', "Creating ".$active_module."_conf class");
    $classname = $active_module."_conf";
    if(class_exists($classname)) {
      ${$classname} = new $classname;
    }
  }
}


if (!$engineinfo = engine_getinfo()) {
  freepbx_log('retrive_conf', 'fatal', "Failed to get engine information (engine_getinfo)");
  fatal("Failed to get engine_info");
}
// was setting these variables before, assume we still need them
$engine = $engineinfo['engine'];
$version = $engineinfo['version'];

// run all of the *_get_config and _hookGet_config functions, which will populate the appropriate objects
if(isset($active_modules) && is_array($active_modules)){
  foreach($active_modules as $module) {
    $funcname = $module."_get_config";
    if (function_exists($funcname)) { 
      freepbx_log('retrieve_conf', 'devel-debug', 'Calling '.$funcname.'()');
      $funcname($engine);
    }
  }
  foreach($active_modules as $module) {
    $funcname = $module."_hookGet_config";
    if (function_exists($funcname)) { 
      freepbx_log('retrieve_conf', 'devel-debug', 'Calling '.$funcname.'()');
      $funcname($engine);
    }
  }
}

// extensions_additional.conf
// create the from-internal-additional context so other can add to it
$ext->add('from-internal-additional', 'h', '', new ext_hangup(''));
//echo $ext->get_filename();
//echo $ext->generateConf();
write_file($ext->get_filename(),$ext->generateConf());

// now we write out our conf files for modules
// check for any objects for each of the active modules
// ** conferences is an example of a module that write a conf
if(isset($active_modules) && is_array($active_modules)){
  foreach($active_modules as $active_module) { 
    $classname = $active_module."_conf";
    if(class_exists($classname) && get_class(${$classname}) !== false) {
      //echo ${$classname}->get_filename();
      //echo ${$classname}->generateConf();
      
      // if the module returns an array, it wants to write multiple files
      // ** pinsets is an example of a module that does this
      if (is_array(${$classname}->get_filename())) {
        foreach(${$classname}->get_filename() as $modconf) {
          freepbx_log('retrieve_conf', 'devel-debug', 'generateConf from '.$classname.'->'.$modconf.'');
          write_file($modconf,${$classname}->generateConf($modconf));
        }
      } else {
        freepbx_log('retrieve_conf', 'devel-debug', 'generateConf from '.$classname);
        write_file(${$classname}->get_filename(),${$classname}->generateConf());
      }
    }
  }
}

// Finally, if this is an install, re-generate ASTDB entries, as they could be restoring from backup, 
// just rebuilt the machine, blah blah. 
if ($run_install) {
  outn("Re-propogating internal device/extensions database...");
  core_users2astdb();
  core_devices2astdb();
  out("OK");
}
  


function write_file($filename,$contents) {
  global $asterisk_conf;
  freepbx_log('retrieve_conf', 'devel-debug', 'Writing '.$filename);
  if (isset($filename) && !empty($filename)) {
    if ($fd = fopen(addslash($asterisk_conf['astetcdir']).$filename, "w")) {
      fwrite($fd, WARNING_BANNER );
      fwrite($fd, $contents);
      fclose($fd);
    }
  }
}

function symlink_subdirs($moduledir) {
  global $symlink_dirs;

  foreach ($symlink_dirs as $subdir => $targetdir) {
    $dir = addslash($moduledir).$subdir;
    if (is_dir($dir)) {
      $d = opendir($dir);
      while ($file = readdir($d)) {
        if ($file[0] != '.') {
          if (file_exists(addslash($targetdir).$file)) {
            if (readlink(addslash($targetdir).$file) != addslash($dir).$file) {
              freepbx_log('retrieve-conf', 'error', addslash($targetdir).$file.' already exists, and is linked to something else!');
            } else {
              freepbx_log('retrieve-conf', 'devel-debug', addslash($targetdir).$file.' already points to '.addslash($dir).$file.' - OK');
            }
          } else {  
            if (symlink(addslash($dir).$file, addslash($targetdir).$file)) {
              freepbx_log('retrieve-conf', 'devel-debug', 'Symlinked '.addslash($dir).$file.' to '.addslash($targetdir).$file);
            } else {
              freepbx_log('Cannot symlink '.addslash($dir).$file.' to '.addslash($targetdir).$file.'. Check Permissions?');
            }
          }
        }
      }
      closedir($d);
    }
  }
}


// run legacy retrieve scripts
// TODO these legacy retrieve scripts should be obsoleted, in favor of classes like extensions class

//script to write op_server.cfg file from mysql 
$script = $amp_conf['AMPBIN'].'/retrieve_op_conf_from_mysql.pl';
exec($script);

//script to write sip conf file from mysql
$script = $amp_conf['AMPBIN'].'/retrieve_sip_conf_from_mysql.pl';
exec($script);

//script to write iax2 conf file from mysql
$script = $amp_conf['AMPBIN'].'/retrieve_iax_conf_from_mysql.pl';
exec($script);

//script to write zap conf file from mysql
$script = $amp_conf['AMPBIN'].'/retrieve_zap_conf_from_mysql.pl';
exec($script);

//script to write queues conf file from mysql
$script = $amp_conf['AMPBIN'].'/retrieve_queues_conf_from_mysql.pl';
exec($script);
  
// **** Set reload flag for AMP admin
needreload();
out("Please Reload Asterisk by visiting http://".$amp_conf["AMPWEBADDRESS"]."/admin");
?>