$value) {
$value = "JSON_ERROR_$value";
if (!defined($value))
define($value, $key);
}
if (!function_exists('json_last_error')) {
function json_last_error() {
return JSON_ERROR_NONE;
}
}
abstract class endpoint_base {
public $tester = 'loki';
public $modules_path = "endpoint/";
public $root_dir = "/var/www/html"; //need to define the root directory for the location of the library (/var/www/html/)
public $brand_name = "undefined"; //Brand Name
public $family_line = "undefined"; //Family Line
public $model = "undefined"; // Model of phone, must match the model name inside of the famil_data.json file in each family folder.
public $config_files_override; //Array list of config files to override, data being the contents, key being the name of said file
public $settings = array();
public $debug = FALSE; //Enable or disable debug
public $debug_return = array(); //Debug fill. I question if this is needed, or perhaps remove above line, seems redudant to have both
public $replacement_array = array(); //Used for phpunit testing, key is {$var} value is the replacement.
public $mac; // Device mac address, should this be in settings?
public $timezone = array(); // Global timezone array
public $DateTimeZone; // timezone, as a DateTimezone object, much more flexible than just an offset and name.
public $engine; //Can be asterisk or freeswitch. This is for the reboot commands.
public $engine_location = ""; //Location of the executable for said engine above
public $system; //unix or windows or bsd. etc
public $directory_structure = array(); //Directory structure to create as an array
public $protected_files = array(); //array list of file to NOT over-write on every config file build. They are protected.
public $copy_files = array(); //array of files or directories to copy. Directories will be recursive
protected $use_system_dst = TRUE; //Use System DST correction if detected
protected $en_htmlspecialchars = TRUE; //Enable or Disable PHP's htmlspecialchars() function for variables
protected $server_type = 'file'; //Can be file or dynamic
protected $provisioning_type = 'tftp'; //can be tftp,http,ftp ??
protected $enable_encryption = FALSE; //Enable file encryption
protected $provisioning_path = ""; //Path to provisioner, used in http/https/ftp/tftp
protected $dynamic_mapping; // e.g. ARRAY('thisfile.htm'=>'# Intentionally left blank','thatfile$mac.htm'=>array('thisfile.htm','thatfile$mac.htm'));
// files not in this array are passed through untouched. Strings are returned as is. For arrays, generate_file is called for each entry, and they are combined.
protected $config_file_replacements = array();
protected $config_files = array();
protected $brand_data; //Brand Data file in array form
protected $family_data; //family data file in array form
protected $model_data; //model data from family data in array form
protected $template_data; //Merged template files for specified model in array form
protected $max_lines = array(); //Max lines from said model.
private $server_type_list = array('file', 'dynamic'); // acceptable values for $server_type
private $default_server_type = 'file'; // if server_type is invalid
private $provisioning_type_list = array('tftp', 'http', 'ftp'); //acceptable values for $provisioning_type
private $default_provisioning_type = 'tftp'; // if provisioning_type is invalid
private $initialized = FALSE; //Initialized data or not.
/* $mapfields is an array of "setting"=>array(
"possibility1"=>"result1",
"posibility2"=>"result2",
"default"=>"defaultresult");
in prepare_for_generateconfig, all of the keys in this array are gone
through. If $this->setting (in the above example) is set,
$this->setting is set to $mapfields["setting"][$this->setting], or if
it doesn't exist, it is set to $mapfields["setting"]["default"]
*/
public $mapfields = array(); // override in children.
function __construct() {
$this->root_dir = empty($this->root_dir) ? dirname(dirname(__FILE__)) . "/" : $this->root_dir;
}
/* * *PUBLIC FUNCTIONS** */
/* These can be called from outside the class */
/**
* Generate one config file. Most settings are taken from $this.
* This is a good thing to overide.
* if you do, you can do a first cut by calling
* $result=parent::generate_file, then tweaking the result,
* or if ($sourcefile=..) {} else {return parent::generate_file}
*
* Note that, if you use dynamic a server type, $filename refers to the
* FINAL output file, not the piece that we're generating. In general,
* $filename is probably unlikely to be used.
*
* @author Jort Bloem
*/
public function generate_file($filename, $extradata, $ignoredynamicmapping=FALSE, $prepare=FALSE) {
if ($prepare) {
$this->prepare_for_generateconfig();
}
# Note: server_type='dynamic' is ignored if ignoredynamicmapping, if there is no $this->dynamic_mapping, or that is not an array.
if (($ignoredynamicmapping) || ($this->server_type != 'dynamic') || (!is_array($this->dynamic_mapping)) || (!array_key_exists($extradata, $this->dynamic_mapping))) {
$data = $this->open_config_file($extradata);
return $this->parse_config_file($data);
} elseif (!is_array($this->dynamic_mapping[$extradata])) {
return $this->dynamic_mapping[$extradata];
} else {
$data = "";
foreach ($this->dynamic_mapping[$extradata] AS $recurseextradata) {
$data.=$this->generate_file($filename, $recurseextradata, TRUE);
}
return $data;
}
}
/**
* generate_config() - this shouldn't need to be overridden.
* @author Jort Bloem
*/
public function generate_all_files() {
$this->prepare_for_generateconfig();
$output = array();
foreach ($this->config_files() AS $filename => $sourcefile) {
$output[$filename] = $this->generate_file($filename, $sourcefile, FALSE, FALSE);
}
return $output;
}
/**
*
*/
public function reboot() {
}
public function __toString() {
}
public function __invoke($x) {
}
/* * *INTERNAL FUNCTIONS** */
/* These can only be called from within the parent or child classes */
/* * *ALL HOOKS BELOW** */
/**
* This is hooked into the middle of the line loop function to allow parsing of variables without having to create a sub foreach or for statement
* @param String $line The Line number.
*/
protected function parse_lines_hook($line_data, $line_total) {
return($line_data);
}
/**
* This generates a list of config files, and the files on which they
* are based.
* @author Jort Bloem
* @return array ($outputfilename=>$sourcefilename,...)
* both filenames are strings, sourcefilename may occur more
* than once.
* override this, if you feel so inclined - you probably want to call
* $result=parent::config_files() first, then modify $result as you like.
*
* You should call prepare_for_generateconfig() before calling this.
* */
protected function config_files() {
foreach (explode(",", $this->family_data['data']['configuration_files']) AS $configfile) {
$outputfile = str_replace(array_keys($this->config_file_replacements), array_values($this->config_file_replacements), $configfile);
$result[$outputfile] = $configfile;
}
return $result;
}
/**
* Override this to do any configuration testing/sorting/preparing
* Dont forget to call parent::prepare_for_generateconfig if you
* do override it.
* @author Jort Bloem
* */
protected function prepare_for_generateconfig() {
$this->initialize();
if (!in_array('$mac', $this->config_file_replacements)) {
$this->config_file_replacements['$mac'] = $this->mac;
}
if (!in_array('$model', $this->config_file_replacements)) {
$this->config_file_replacements['$model'] = $this->model;
}
foreach ($this->mapfields as $fieldname => $map) {
if (isset($this->settings[$fieldname]) AND (array_key_exists($this->settings[$fieldname], $map))) {
$this->settings[$fieldname] = $map[$this->settings[$fieldname]];
} else {
$this->settings[$fieldname] = $map['default'];
}
}
$this->mapfields = array(); // ensure it only happens once.
}
private function setup_languages() {
return $languages;
}
/**
* Takes the name of a local configuration file and either returns that file from the hard drive as a string or takes the string from the array and returns that as a string
* @param string $filename Configuration File name
* @return string Full Configuration File (From Hard Drive or Array)
* @example
*
* $full_file = $this->open_config_file("local_file.cfg");
*
* @author Andrew Nagy
*/
private function open_config_file($filename) {
//if there is no configuration file over ridding the default then load up $contents with the file's information, where $key is the name of the default configuration file
if (!isset($this->config_files_override[$filename])) {
return file_get_contents($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/" . $filename);
} else {
return($this->config_files_override[$filename]);
}
}
/**
* This will parse configuration values that are either {$variable}, {$variable|default}, {$variable.line.num}, or {$variable.line.num|default}
* It will determine the line ammount and then run the function to parse lines and then run parse config values (to replace any remaining values)
* @param string $file_contents full contents of the configuration file
* @param boolean $keep_unknown Keep Unknown variables as {$variable} instead of erasing them (blanking the space), can be used to parse these variables later
* @param integer $lines The total number of lines for this model, NULL if defining a model
* @param integer $specific_line The specific line number to manipulate. If no line number set then assume All Lines
* @return string Full Contents of the configuration file (After Parsing)
* @author Andrew Nagy
*/
private function parse_config_file($file_contents) {
$file_contents = $this->generate_info($file_contents);
$file_contents = $this->parse_conditionals($file_contents);
$file_contents = $this->parse_conditional_model($file_contents);
$file_contents = $this->parse_lines($file_contents, FALSE);
$file_contents = $this->parse_loops($file_contents, FALSE);
$file_contents = $this->replace_static_variables($file_contents);
$file_contents = $this->parse_config_values($file_contents);
return $file_contents;
}
/**
* Simple isset/==/!= statetment
* @param string $file_contents Full Contents of the configuration file
* @return string Full Contents of the configuration file (After Parsing)
* @example {if condition="$local_port == '5060'"}{/if}
* @author Andrew Nagy
*/
private function parse_conditionals($file_contents) {
$pattern = "/{if condition=\"(.*?)\"}(.*?){\/if}/si";
while (preg_match($pattern, $file_contents, $matches)) {
$function = $matches[1];
$contents = $matches[2];
if(preg_match('/isset\(\$(\w*)\)/i',$function,$fmatches)) {
if(isset($this->settings[$fmatches[1]])) {
$file_contents = preg_replace($pattern, $contents, $file_contents, 1);
}
} elseif(preg_match('/\$(.*) == \'(.*)\'/i',$function,$fmatches)) {
if(isset($this->settings[$fmatches[1]]) AND ($this->settings[$fmatches[1]] == $fmatches[2])){
$file_contents = preg_replace($pattern, $contents, $file_contents, 1);
}
} elseif(preg_match('/\$(.*) != \'(.*)\'/i',$function,$fmatches)) {
if(isset($this->settings[$fmatches[1]]) AND ($this->settings[$fmatches[1]] != $fmatches[2])){
$file_contents = preg_replace($pattern, $contents, $file_contents, 1);
}
}
$file_contents = preg_replace($pattern, "", $file_contents, 1);
}
return($file_contents);
}
/**
* Simple Model if then statement, should be called before any parsing!
* @param string $file_contents Full Contents of the configuration file
* @return string Full Contents of the configuration file (After Parsing)
* @example {if model="6757*"}{/if}
* @author Andrew Nagy
*/
private function parse_conditional_model($file_contents) {
$pattern = "/{if model=\"(.*?)\"}(.*?){\/if}/si";
while (preg_match($pattern, $file_contents, $matches)) {
//This is exactly like the fnmatch function except it will work on POSIX compliant systems
//http://php.net/manual/en/function.fnmatch.php
if (preg_match("#^" . strtr(preg_quote($matches[1], '#'), array('\*' => '.*', '\?' => '.', '\[' => '[', '\]' => ']')) . "$#i", $this->model)) {
$file_contents = preg_replace($pattern, $matches[2], $file_contents, 1);
} else {
$file_contents = preg_replace($pattern, "", $file_contents, 1);
}
}
return($file_contents);
}
/**
* Parse data between {loop_*}{/loop_*}
* @param string $line_total Total Number of Lines on the specific Phone
* @param string $file_contents Full Contents of the configuration file
* @param boolean $keep_unknown Keep Unknown variables as {$variable} instead of erasing them (blanking the space), can be used to parse these variables later
* @param integer $specific_line The specific line number to manipulate. If no line number set then assume All Lines
* @return string Full Contents of the configuration file (After Parsing)
* @example {loop_keys}{/loop_keys}
* @author Andrew Nagy
*/
private function parse_loops($file_contents, $keep_unknown=FALSE) {
//Find line looping data betwen {line_loop}{/line_loop}
$pattern = "/{loop_(.*?)}(.*?){\/loop_(.*?)}/si";
while (preg_match($pattern, $file_contents, $matches)) {
$loop_name = $matches[3];
$loop_contents = $matches[2];
//TODO: This should be $this->settings['loop'][$loop_name]
if (isset($this->settings['loops'][$loop_name])) {
$count = count($this->settings['loops'][$loop_name]);
$this->debug("Replacing loop '" . $loop_name . "' " . $count . " times");
$parsed = "";
if ($count) {
foreach ($this->settings['loops'][$loop_name] as $number => $data) {
$data['number'] = $number;
$data['count'] = $number;
$parsed .= $this->parse_config_values($this->replace_static_variables($loop_contents), $data, FALSE);
}
}
$file_contents = preg_replace($pattern, $parsed, $file_contents, 1);
} else {
$file_contents = preg_replace($pattern, "", $file_contents, 1);
$this->debug("Blanking loop '" . $loop_name . "'");
}
}
return($file_contents);
}
private function find_model($family_data) {
if (is_array($family_data['data']['model_list'])) {
$key = $this->arraysearchrecursive($this->model, $family_data, "model");
if ($key !== FALSE) {
return($family_data['data']['model_list'][$key[2]]);
}
}
throw new Exception('Could Not find model');
}
/**
* Parse each individual line through use of {$variable.line.num} or {line_loop}{/line_loop}
* @param string $line_total Total Number of Lines on the specific Phone
* @param string $file_contents Full Contents of the configuration file
* @param boolean $keep_unknown Keep Unknown variables as {$variable} instead of erasing them (blanking the space), can be used to parse these variables later
* @return string Full Contents of the configuration file (After Parsing)
* @author Andrew Nagy
*/
private function parse_lines($file_contents, $keep_unknown=FALSE) {
//Find line looping data betwen {line_loop}{/line_loop}
$pattern = "/{line_loop}(.*?){\/line_loop}/si";
while (preg_match($pattern, $file_contents, $matches)) {
$loop_contents = $matches[1];
$parsed = "";
foreach ($this->settings['line'] as $data) {
$line = $data['line'];
$data['number'] = $line;
$data['count'] = $line;
$line_settings = $this->parse_lines_hook($data, $this->max_lines);
$parsed .= $this->parse_config_values($this->replace_static_variables($loop_contents, $line_settings), $line_settings, $keep_unknown);
}
$file_contents = preg_replace($pattern, $parsed, $file_contents, 1);
}
return($file_contents);
}
private function merge_files() {
$template_data_list = $this->model_data['template_data'];
$template_data = array();
$template_data_multi = "";
//Setup defaults from global file
$template_data_multi = $this->file2json($this->root_dir . $this->modules_path . '/global_template_data.json');
$template_data_multi = $template_data_multi['template_data']['category'];
foreach ($template_data_multi as $categories) {
$subcats = $categories['subcategory'];
foreach ($subcats as $subs) {
$items = $subs['item'];
$template_data = array_merge($template_data, $items);
}
}
//Setup defaults from each template file
foreach ($template_data_list as $files) {
if (file_exists($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/" . $files)) {
$template_data_multi = $this->file2json($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/" . $files);
$template_data_multi = $template_data_multi['template_data']['category'];
foreach ($template_data_multi as $categories) {
$subcats = $categories['subcategory'];
foreach ($subcats as $subs) {
$items = $subs['item'];
$template_data = array_merge($template_data, $items);
}
}
} else {
throw new Exception("Template File: " . $files . " doesnt exist!");
}
}
if (file_exists($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/template_data_custom.json")) {
$template_data_multi = $this->file2json($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/template_data_custom.json");
$template_data_multi = $template_data_multi['template_data']['category'];
foreach ($template_data_multi as $categories) {
$subcats = $categories['subcategory'];
foreach ($subcats as $subs) {
$items = $subs['item'];
$template_data = array_merge($template_data, $items);
}
}
}
if (file_exists($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/template_data_" . $this->model . "_custom.json")) {
$template_data_multi = $this->file2json($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/template_data_" . $this->model . "_custom.json");
$template_data_multi = $template_data_multi['template_data']['category'];
foreach ($template_data_multi as $categories) {
$subcats = $categories['subcategory'];
foreach ($subcats as $subs) {
$items = $subs['item'];
$template_data = array_merge($template_data, $items);
}
}
}
return($template_data);
}
private function parse_config_values($file_contents, $data=NULL, $keep_unknown=FALSE) {
//Find all matched variables in the text file between "{$" and "}"
preg_match_all('/{(\$[^{]+?)[}]/i', $file_contents, $match);
//Result without brackets (but with the $ variable identifier)
$no_brackets = array_values(array_unique($match[1]));
//Result with brackets
$brackets = array_values(array_unique($match[0]));
foreach ($no_brackets as $variables) {
$original_variable = $variables;
$default_exp = preg_split("/\|/i", str_replace("$", "", $variables));
$variables = $default_exp[0];
$default = isset($default_exp[1]) ? $default_exp[1] : null;
if (is_array($data)) {
if (isset($data[$variables])) {
$data[$variables] = $this->replace_static_variables($data[$variables]);
$this->debug("Replacing '{" . $original_variable . "}' with " . $data[$variables]);
if (isset($data['line'])) {
$l = $data['line'];
$this->replacement_array['lines'][$l][$original_variable] = $data[$variables];
}
$file_contents = str_replace('{' . $original_variable . '}', $data[$variables], $file_contents);
continue;
}
} else {
if (isset($this->settings[$variables])) {
$this->settings[$variables] = $this->replace_static_variables($this->settings[$variables]);
$this->replacement_array['other'][$original_variable] = $this->settings[$variables];
$file_contents = str_replace('{' . $original_variable . '}', $this->settings[$variables], $file_contents);
continue;
}
}
if (!$keep_unknown) {
//read default template values here, blank unknowns or arrays (which are blanks anyways)
$key1 = $this->arraysearchrecursive('$' . $variables, $this->template_data, 'variable');
$default_hard_value = NULL;
//Check for looping statements. They are all setup logically the same. Ergo if the first multi-dimensional array has a variable key its not a loop.
if ($key1['1'] == 'variable') {
if (is_array($data)) {
$dhv = str_replace('{$count}', $data['line'], $this->template_data[$key1[0]]['default_value']);
$dhv = str_replace('{$number}', $data['line'], $dhv);
} else {
$dhv = $this->template_data[$key1[0]]['default_value'];
}
$default_hard_value = $this->replace_static_variables($dhv);
} elseif ($key1['4'] == 'variable') {
if (is_array($data)) {
$dhv = str_replace('{$count}', $data['line'], $this->template_data[$key1[0]][$key1[1]][$key1[2]][$key1[3]]['default_value']);
$dhv = str_replace('{$number}', $data['line'], $dhv);
} else {
$dhv = $this->template_data[$key1[0]][$key1[1]][$key1[2]][$key1[3]]['default_value'];
}
$default_hard_value = $this->replace_static_variables($dhv);
}
if (isset($default)) {
$default = $this->replace_static_variables($default);
$file_contents = str_replace('{' . $original_variable . '}', $default, $file_contents);
$this->replacement_array['pipes'][$original_variable] = $default;
$this->debug('Replacing {' . $original_variable . '} with default piped value of:' . $default);
} elseif (isset($default_hard_value)) {
$default_hard_value = $this->replace_static_variables($default_hard_value);
$file_contents = str_replace('{' . $original_variable . '}', $default_hard_value, $file_contents);
$this->replacement_array['json'][$original_variable] = $default_hard_value;
$this->debug("Replacing {" . $original_variable . "} with default json value of: " . $default_hard_value);
} else {
//do one last replace statice here.
$file_contents = str_replace('{' . $original_variable . '}', "", $file_contents);
$this->replacement_array['blanks'][$original_variable] = "";
$this->debug("Blanking {" . $original_variable . "}");
}
}
}
return($file_contents);
}
/**
* This will replace statically known variables
* variables: {$server.ip.*}, {$server.port.*}, {$mac}, {$model}, {$line}, {$ext}, {$displayname}, {$secret}, {$pass}, etc.
* @param string $contents
* @param string $specific_line
* @param boolean $looping
* @return string
*/
private function replace_static_variables($contents, $data=NULL) {
//bad
$this->settings['network']['local_port'] = isset($this->settings['network']['local_port']) ? $this->settings['network']['local_port'] : '5060';
$replace = array(
# These first ones have an identical field name in the object and the template.
# This is a good thing, and should be done wherever possible.
'{$mac}' => $this->mac,
'{$model}' => $this->model,
'{$provisioning_type}' => $this->provisioning_type,
'{$provisioning_path}' => $this->provisioning_path,
'{$vlan_id}' => $this->settings['network']['vlan']['id'],
'{$vlan_qos}' => $this->settings['network']['vlan']['qos'],
# These are not the same.
'{$timezone_gmtoffset}' => $this->timezone['gmtoffset'],
'{$timezone_timezone}' => $this->timezone['timezone'],
'{$timezone}' => $this->timezone['timezone'], # Should this be depricated??
'{$network_time_server}' => $this->settings['ntp'],
'{$local_port}' => $this->settings['network']['local_port'],
'{$syslog_server}' => $this->settings['network']['syslog_server'],
#old
'{$srvip}' => $this->settings['line'][0]['server_host'],
'{$server.ip.1}' => $this->settings['line'][0]['server_host'],
'{$server.port.1}' => $this->settings['line'][0]['server_port']
);
$contents = str_replace(array_keys($replace), array_values($replace), $contents);
if (is_array($data)) {
//not needed I dont think
} else {
//Find all matched variables in the text file between "{$" and "}"
preg_match_all('/{(\$[^{]+?)[}]/i', $contents, $match);
//Result without brackets (but with the $ variable identifier)
$no_brackets = array_values(array_unique($match[1]));
//Result with brackets
$brackets = array_values(array_unique($match[0]));
//loop though each variable found in the text file
foreach ($no_brackets as $variables) {
$original_variable = $variables;
$variables = str_replace("$", "", $variables);
$line_exp = preg_split("/\./i", $variables);
if ((isset($line_exp[2]) AND (($line_exp[0] == 'line') OR ($line_exp[1] == 'line')))) {
if ($line_exp[0] == 'line') {
$line = explode("|", $line_exp[1]);
$default = isset($line[1]) ? $line[1] : NULL;
$line = $line[0];
$key1 = $this->arraysearchrecursive($line, $this->settings['line'], 'line');
$var = $line_exp[2];
} elseif ($line_exp[1] == 'line') {
$line = explode("|", $line_exp[2]);
$default = isset($line[1]) ? $line[1] : NULL;
$line = $line[0];
$key1 = $this->arraysearchrecursive($line, $this->settings['line'], 'line');
$var = $line_exp[0];
//$this->settings['line'][$key1[0]]['ext'] = isset($this->settings['line'][$key1[0]]['username']) ? $this->settings['line'][$key1[0]]['username'] : NULL;
}
//If value (that line) wasn't found then ignore the next
if ($key1 !== FALSE) {
$data['number'] = $line;
$data['count'] = $line;
$line_settings = $this->parse_lines_hook($this->settings['line'][$key1[0]], $this->max_lines);
$stored = isset($line_settings[$var]) ? $line_settings[$var] : '';
$this->debug('Replacing {' . $original_variable . '} with ' . $stored);
$this->replacement_array['lines'][$line]['$' . $var] = $stored;
$contents = str_replace('{' . $original_variable . '}', $stored, $contents);
} else {
//Blank it?
$contents = str_replace('{' . $original_variable . '}', "", $contents);
$this->replacement_array['blanks'][$original_variable] = "";
$this->debug("Blanking {" . $original_variable . "}");
}
}
}
}
return($contents);
}
/**
* NOTE: Wherever possible, try $this->DateTimeZone->getOffset(new DateTime) FIRST, which takes Daylight savings into account, too.
* Turns a string like PST-7 or UTC+1 into a GMT offset in seconds
* @param Send this a timezone like PST-7
* @return Offset from GMT, in seconds (eg. -25200, =3600*-7)
* @author Jort Bloem
*/
private function get_gmtoffset($timezone) {
# Divide the timezone up into it's 3 interesting parts; the sign (+/-), hours, and if they exist, minutes.
# note that matches[0] is the entire matched string, so these 3 parts are $matches[1], [2] and [3].
preg_match('/([\-\+])([\d]+):?(\d*)/', $timezone, $matches);
# $matches is now an array; $matches[1] is the sign (+ or -); $matches[2] is number of hours, $matches[3] is minutes (or empty)
return intval($matches[1] . "1") * ($matches[2] * 3600 + $matches[3] * 60);
}
/**
* Turns an integer like -3600 (seconds) into a GMT offset like GMT-1
* @param Time offset in seconds, like 3600 or -25200 or -27000
* @return timezone (eg. GMT+1 or GMT-7 or GMT-7:30)
* @author Jort Bloem
*/
private function get_timezone($offset) {
if ($offset < 0) {
$result = "GMT-";
$offset = abs($offset);
} else {
$result = "GMT+";
}
$result.=(int) ($offset / 3600);
if ($result % 3600 > 0) {
$result.=":" . (($offset % 3600) / 60);
} else {
$result.=":00";
}
return $result;
}
/**
* Setup and fill in timezone data
* @author Jort Bloem
*/
protected function setup_timezone() {
if (isset($this->DateTimeZone) && is_object($this->DateTimeZone)) {
//We set this to allow phones to use Automatic DST
$gmt_dst_fix = !$this->use_system_dst && date('I') ? 3600 : 0;
$this->timezone = array(
'gmtoffset' => $this->DateTimeZone->getOffset(new DateTime) - $gmt_dst_fix,
'timezone' => $this->get_timezone($this->DateTimeZone->getOffset(new DateTime) - $gmt_dst_fix)
);
} else {
throw new Exception('You Must define a valid DateTimeZone object');
}
}
function debug($message) {
if ($this->debug) {
$this->debug_return[] = $message;
}
}
function file2json($file) {
if (file_exists($file)) {
$json = file_get_contents($file);
$data = json_decode($json, TRUE);
$error = json_last_error();
if ($error === JSON_ERROR_NONE) {
return($data);
} else {
$errors = array(// Taken from http://www.php.net/manual/en/function.json-last-error.php
JSON_ERROR_NONE => 'No error has occurred',
JSON_ERROR_DEPTH => 'The maximum stack depth has been exceeded',
JSON_ERROR_STATE_MISMATCH => 'Invalid or malformed JSON',
JSON_ERROR_CTRL_CHAR => 'Control character error, possibly incorrectly encoded',
JSON_ERROR_SYNTAX => 'Syntax error',
JSON_ERROR_UTF8 => 'Malformed UTF-8 characters, possibly incorrectly encoded'
);
if (array_key_exists($error, $errors)) {
$error = $errors[$error];
} else {
$error = "Unknown error $error";
}
throw new Exception("Could not decode $file: $error");
}
} else {
throw new Exception("Could not load: " . $file);
}
}
private function generate_info($file_contents) {
if ($this->server_type == "file") {
$file_contents = str_replace('{$provisioner_generated_timestamp}', date('l jS \of F Y h:i:s A'), $file_contents);
} else {
$file_contents = str_replace('{$provisioner_generated_timestamp}', 'N/A (Prevents reboot loops if set to static value)', $file_contents);
}
$file_contents = str_replace('{$provisioner_processor_info}', $this->processor_info, $file_contents);
$file_contents = str_replace('{$provisioner_timestamp}', $this->processor_info, $file_contents);
$file_contents = str_replace('{$provisioner_brand_timestamp}', $this->brand_data['data']['brands']['last_modified'] . " (" . date('l jS \of F Y h:i:s A', $this->brand_data['data']['brands']['last_modified']) . ")", $file_contents);
$file_contents = str_replace('{$provisioner_family_timestamp}', $this->brand_data['data']['brands']['last_modified'] . " (" . date('l jS \of F Y h:i:s A', $this->brand_data['data']['brands']['last_modified']) . ")", $file_contents);
return($file_contents);
}
private function initialize() {
if (!$this->initialized) {
//Check Mac address
if (empty($this->mac)) {
throw new Exception("Mac Can Not Be Blank!");
}
//First check to see if line data is filled for at least the first line
if (!isset($this->settings['line'][0])) {
throw new Exception('No Line Data Defined!');
} else {
foreach ($this->settings['line'] as $linedata) {
if (!isset($linedata['line'])) {
throw new Exception('Line not defined!');
}
}
}
if (!isset($this->processor_info)) {
throw new Exception('Undefined Processor, please set your processor_info');
}
//Load files for quicker processing
$this->family_data = $this->file2json($this->root_dir . $this->modules_path . $this->brand_name . "/" . $this->family_line . "/family_data.json");
$this->brand_data = $this->file2json($this->root_dir . $this->modules_path . $this->brand_name . "/brand_data.json");
$this->model_data = $this->find_model($this->family_data);
$this->max_lines = isset($this->model_data['lines']) ? $this->model_data['lines'] : 1;
$this->template_data = $this->merge_files();
$this->setup_timezone();
if (empty($this->engine_location)) {
if ($this->engine == 'asterisk') {
$this->engine_location = 'asterisk';
} elseif ($this->engine == 'freeswitch') {
$this->engine_location = 'freeswitch';
}
}
//TODO: fix NTP
if (!isset($this->settings['ntp'])) {
$this->settings['ntp'] = $this->settings['line'][0]['server_host'];
}
$this->server_type = (isset($this->settings['provision']['type']) && in_array($this->settings['provision']['type'], $this->server_type_list)) ? $this->settings['provision']['type'] : $this->default_server_type;
$this->provisioning_type = (isset($this->settings['provision']['protocol']) && in_array($this->settings['provision']['protocol'], $this->provisioning_type_list)) ? $this->settings['provision']['protocol'] : $this->default_provisioning_type;
$this->provisioning_path = isset($this->settings['provision']['path']) ? $this->settings['provision']['path'] : $this->provisioning_path;
$this->settings['network']['connection_type'] = isset($this->settings['network']['connection_type']) ? $this->settings['network']['connection_type'] : 'DHCP';
$this->settings['network']['ipv4'] = isset($this->settings['network']['ipv4']) ? $this->settings['network']['ipv4'] : '';
$this->settings['network']['ipv6'] = isset($this->settings['network']['ipv6']) ? $this->settings['network']['ipv6'] : '';
$this->settings['network']['subnet'] = isset($this->settings['network']['subnet']) ? $this->settings['network']['subnet'] : '';
$this->settings['network']['gateway'] = isset($this->settings['network']['gateway']) ? $this->settings['network']['gateway'] : '';
$this->settings['network']['primary_dns'] = isset($this->settings['network']['primary_dns']) ? $this->settings['network']['primary_dns'] : '';
$this->settings['network']['ppoe_username'] = isset($this->settings['network']['ppoe_username']) ? $this->settings['network']['ppoe_username'] : '';
$this->settings['network']['ppoe_password'] = isset($this->settings['network']['ppoe_password']) ? $this->settings['network']['ppoe_password'] : '';
$this->settings['network']['syslog_server'] = isset($this->settings['network']['syslog_server']) ? $this->settings['network']['syslog_server'] : '';
//TODO:fix
if (!isset($this->settings['network']['vlan']['id'])) {
$this->settings['network']['vlan']['id'] = 0;
}
if (!isset($this->settings['network']['vlan']['qos'])) {
$this->settings['network']['vlan']['qos'] = 5;
}
$this->initialized = TRUE;
}
}
/**
* Merge two arrays only if the old array is an array, otherwise just return the new array
* @param array $array_old
* @param array $array_new
* @return array
* @deprecated
*/
function array_merge_check($array_old, $array_new) {
if (is_array($array_old)) {
return(array_merge($array_old, $array_new));
} else {
return($array_new);
}
}
/**
* Search Recursively through an array
* @param string $Needle
* @param array $Haystack
* @param string $NeedleKey
* @param boolean $Strict
* @param array $Path
* @return array
*/
function arraysearchrecursive($Needle, $Haystack, $NeedleKey="", $Strict=false, $Path=array()) {
if (!is_array($Haystack))
return false;
foreach ($Haystack as $Key => $Val) {
if (is_array($Val) &&
$SubPath = $this->arraysearchrecursive($Needle, $Val, $NeedleKey, $Strict, $Path)) {
$Path = array_merge($Path, Array($Key), $SubPath);
return $Path;
} elseif ((!$Strict && $Val == $Needle &&
$Key == (strlen($NeedleKey) > 0 ? $NeedleKey : $Key)) ||
($Strict && $Val === $Needle &&
$Key == (strlen($NeedleKey) > 0 ? $NeedleKey : $Key))) {
$Path[] = $Key;
return $Path;
}
}
return false;
}
function sys_get_temp_dir() {
if (!empty($_ENV['TMP'])) {
return realpath($_ENV['TMP']);
}
if (!empty($_ENV['TMPDIR'])) {
return realpath($_ENV['TMPDIR']);
}
if (!empty($_ENV['TEMP'])) {
return realpath($_ENV['TEMP']);
}
$tempfile = tempnam(uniqid(rand(), TRUE), '');
if (file_exists($tempfile)) {
unlink($tempfile);
return realpath(dirname($tempfile));
}
}
}
//This Class is for checking for global files, which in the case of a provisioner shouldn't really need to exist, but some phones need these so we generate blanks
class Provisioner_Globals {
/**
* List all global files as reg statements here.
* This should be called statically eg: $data=Provisioner_Globals:dynamic_global_files($filename);
* Return data for global if valid
* else just return false (eg file does not exist)
* @param String $filename Name of the file: eg aastra.cfg
* @return String, data of that file: eg # This file intentionally left blank!
*/
function dynamic_global_files($file, $provisioner_path='/tmp/', $web_path='/') {
if (preg_match("/y[0]{11}[1-7].cfg/i", $file)) {
$file = 'y000000000000.cfg';
}
if (preg_match("/dialplan\.xml/i",$file)) {
return('');
}
if (preg_match("/spa.*.cfg/i", $file)) {
$file = 'spa.cfg';
}
switch ($file) {
//spa-cisco-linksys
case 'spa.cfg':
return("
3
" . $web_path . "spa\$MA.xml
~PLEASE WAIT~
Text Logo
");
break;
//yealink
//case 'y000000000000.cfg':
// return("#left blank");
// break;
//aastra
case "aastra.cfg":
return("#left blank");
break;
default:
if (file_exists($provisioner_path . $file)) {
header('Content-Description: File Transfer');
header('Content-Type: application/octet-stream');
header('Content-Disposition: attachment; filename=' . basename($provisioner_path . $file));
header('Content-Transfer-Encoding: binary');
header('Expires: 0');
header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
header('Pragma: public');
header('Content-Length: ' . filesize($provisioner_path . $file));
ob_clean();
flush();
readfile($provisioner_path . $file);
return('empty');
} else {
return(FALSE);
}
break;
}
}
}
if (!class_exists('InvalidArgumentException')) {
class InvalidArgumentException extends Exception {
}
}
class InvalidObjectException extends Exception {
}