ViciDial/ViciDialSVN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added a general vicidail perl library called vicidial.pm. It is currently experiemental.

Browse Source 
git-svn-id: svn://192.168.202.10@791 3d104415-ff17-0410-8863-d5cf3c621b8a
This commit is contained in:
mikec
2008-03-11 20:37:33 +00:00
parent 8560b4f4dc
commit c59304f786
1 changed files with 458 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
agc_2-X/trunk/bin/vicidial.pm
+458
View File
@@ -0,0 +1,458 @@
package vicidial;
# vicidial.pm version 2.0.5
#
# Experimental library for general vicidial things
#
# DO NOT USE!!! CURRENTLY UNTESTED!!!
#
# Copyright (C) 2008 VICIDIAL-GROUP <info@vicidial-group.com> LICENSE: AGPLv2
#
# CHANGELOG:
# 80311-1611 - First test build
use 5.008;
use strict;
use warnings;
use Switch;
# function to perform logging for agi scripts
# ARG0 is the logging level of the script (0-3)
# ARG1 is the time stamp to go along with this log
# ARG2 is the name of the script that is currently logging
# ARG3 is the stage that script is currently in
# ARG4 is the log files name
# ARG5 is the string that is going into the log
# this function does not return a value
sub agi_output {
my $agi_log_level = $_[0];
my $now_date = $_[1];
my $script_name = $_[2];
my $process_stage = $_[3];
my $log_file_name = $_[4];
my $log_string = $_[5];
my $write_string "$now_date|$script_name|$process_stage|$log_string";
# logging to file
if ( $agi_log_level >= 2 ) {
# open the log file for writing
my $file_opened = 1;
open( Lout, ">>$log_file_name" ) || $file_opened = 0;
if ( $file_opened ) { # if the file was opened print to it and then close
print Lout "$write_string\n";
close(Lout);
} else { # else print a message to STDERR
print STDERR "Can't open $log_file_name to write $write_string: $!\n";
}
}
# loggin to STDERR
if ( ( $agi_log_level == '1' ) || ( $agi_log_level == '3' ) ) {
print STDERR "$write_string\n";
}
}
# function to get the localtime as a date hash
# does not take any arguments
# this function returns a hash with the localtime in it
# the has has the following values:
# 'sec' = the seconds
# 'min' = the minutes
# 'hour' = the hours
# 'Fhour' = the hours with a 0 infront if it it less than 10
# 'mday' = the day of the month
# 'mon' = the month of the year
# 'year' = the year
# 'wday' = the day of the week
# 'yday' = the day of the year
# 'isdst' = if day light savings time is in effect
sub get_date_hash {
# init the hash
my %date_hash = ();
# assign the values
(
$date_hash{ 'sec' },
$date_hash{ 'min' },
$date_hash{ 'hour' },
$date_hash{ 'mday' },
$date_hash{ 'mon' },
$date_hash{ 'year' },
$date_hash{ 'wday' },
$date_hash{ 'yday' },
$date_hash{ 'isdst' }
) = localtime( time );
# make the values more useful
$date_hash{ 'year' } = ( $date_hash{ 'year' } + 1900 );
$date_hash{ 'mon' }++;
if ( $date_hash{ 'mon' } < 10 ) {
$date_hash{ 'mon' } = "0$date_hash{ 'mon' }";
}
if ( $date_hash{ 'mday' } < 10 ) {
$date_hash{ 'mday' } = "0$date_hash{ 'mday' }";
}
if ( $date_hash{ 'min' } < 10 ) {
$date_hash{ 'min' } = "0$date_hash{ 'min' }";
}
if ( $date_hash{ 'sec' } < 10 ) {
$date_hash{ 'sec' } = "0$date_hash{ 'sec' }";
}
if ( $date_hash{ 'hour' } < 10 ) {
$date_hash{ 'Fhour' } = "0$date_hash{ 'hour' }";
} else {
$date_hash{ 'Fhour' } = $date_hash{ 'hour' };
}
# return the hash
return \%date_hash;
}
# function to convert a date hash to a date string
# ARG1 is a date_hash to convert
# this function returns a date string
sub get_now_date {
my %date_hash = %$_[0];
# build the string
my $now_date =
"$date_hash{ 'year' }-$date_hash{ 'mon' }-$date_hash{ 'mday' } $date_hash{ 'Fhour' }:$date_hash{ 'min' }:$date_hash{ 'sec' }";
return $now_date;
}
# function to load the astguicleint config file
# ARG0 the path to the astguiclient config file
# this function returns a hash with all of the config file values
# the has has the following values:
# 'logs_path' = the path to the log directory
# 'home_path' = the location of the astguiclient scripts
# 'agi_path' = the path to the asteirsk agi directory
# 'web_path' = the path to the apache web directory vicidial is in
# 'sounds_path' = the path to the asterisk sounds directory
# 'monitor_path' = the path to where asterisk stores the recordings
# 'done_monitor_path' = the path to put the recordings after where done compressing them
# 'fagi_log_min_servers' = minimum number of server threads for the FAGI
# 'fagi_log_max_servers' = maximum number of server threads for the FAGI
# 'fagi_log_min_spare_servers' = minimum number of spare server threads for the FAGI
# 'fagi_log_max_spare_servers' = maximum number of spare server threads for the FAGI
# 'fagi_log_max_requests' = maximum number of requests a thread should handle before dieing
# 'fagi_log_checkfordead' = seconds before looking for dead threads to kill
# 'fagi_log_checkforwait' = seconds before looking if the FAGI can kill some waitng threads
# 'server_ip' = IP address of the server
# 'active_keepalives' = which processes should be check to see if they are alive
# 'db_server' = the IP or Hostname of the database server
# 'db_database' = the database that vicidial uses
# 'db_user' = the username that is used to connect to the database
# 'db_pass' = the password that is used to connect to the database
# 'db_port' = the port number to connect to the database
# 'ftp_host' = the IP or Hostname of the ftp server to store the recordings on
# 'ftp_user' = the username that is used to connect to the recording ftp server
# 'ftp_pass' = the password that is used to connect to the recording ftp server
# 'ftp_port' = the port number to connect to the recording ftp server
# 'ftp_dir' = the directory to place the recording into on the recording ftp server
# 'ftp_http_path' = the web address to access the recording that are on the recording ftp server
# 'report_host' = the IP or Hostname of the ftp server to store the reports on
# 'report_user' = the username that is used to connect to the report ftp server
# 'report_pass' = the password that is used to connect to the report ftp server
# 'report_port' = the port number to connect to the report ftp server
# 'report_dir' = the directory to place the reports into on the report ftp server
sub load_config_file {
my $file_path = $_[0];
# init the hash
my %config_hash = ();
# open the config file and read it in
open( conf, "$file_path" ) || die "can't open $file_path: $!\n";
my @conf = <conf>;
close(conf);
# loop through the configs and set the apportiate value in the config_hash
my $i = 0;
foreach (@conf) {
my $line = $conf[$i];
$line =~ s/ |>|\n|\r|\t|\#.*|;.*//gi;
switch ( $line ) {
# Paths to various directories
case /^PATHlogs/ {
%config_hash{ 'logs_path' } = $line;
%config_hash{ 'logs_path' } =~ s/.*=//gi;
}
case /^PATHhome/ {
%config_hash{ 'home_path' } = $line;
%config_hash{ 'home_path' } =~ s/.*=//gi;
}
case /^PATHagi/ {
%config_hash{ 'agi_path' } = $line;
%config_hash{ 'agi_path' } =~ s/.*=//gi;
}
case /^PATHweb/ {
%config_hash{ 'web_path' } = $line;
%config_hash{ 'web_path' } =~ s/.*=//gi;
}
case /^PATHsounds/ {
%config_hash{ 'sounds_path' } = $line;
%config_hash{ 'sounds_path' } =~ s/.*=//gi;
}
case /^PATHmonitor/ {
%config_hash{ 'monitor_path' } = $line;
%config_hash{ 'monitor_path' } =~ s/.*=//gi;
}
case /^PATHDONEmonitor/ {
%config_hash{ 'done_monitor_path' } = $line;
%config_hash{ 'done_monitor_path' } =~ s/.*=//gi;
}
# FAGI log server settings
case /^VARfastagi_log_min_servers/ {
%config_hash{ 'fagi_log_min_servers' } = $line;
%config_hash{ 'fagi_log_min_servers' } =~ s/.*=//gi;
}
case /^VARfastagi_log_max_servers/ {
%config_hash{ 'fagi_log_max_servers' } = $line;
%config_hash{ 'fagi_log_max_servers' } =~ s/.*=//gi;
}
case /^VARfastagi_log_min_spare_servers/ {
%config_hash{ 'fagi_log_min_spare_servers' } = $line;
%config_hash{ 'fagi_log_min_spare_servers' } =~ s/.*=//gi;
}
case /^VARfastagi_log_max_spare_servers/ {
%config_hash{ 'fagi_log_max_spare_servers' } = $line;
%config_hash{ 'fagi_log_max_spare_servers' } =~ s/.*=//gi;
}
case /^VARfastagi_log_max_requests/ {
%config_hash{ 'fagi_log_max_requests' } = $line;
%config_hash{ 'fagi_log_max_requests' } =~ s/.*=//gi;
}
case /^VARfastagi_log_checkfordead/ {
%config_hash{ 'fastagi_log_checkfordead' } = $line;
%config_hash{ 'fastagi_log_checkfordead' } =~ s/.*=//gi;
}
case /^VARfastagi_log_checkforwait/ {
%config_hash{ 'fastagi_log_checkforwait' } = $line;
%config_hash{ 'fastagi_log_checkforwait' } =~ s/.*=//gi;
}
# general server settings
case /^VARserver_ip/ {
%config_hash{ 'server_ip' } = $line;
%config_hash{ 'server_ip' } =~ s/.*=//gi;
}
case /^VARactive_keepalives/ {
%config_hash{ 'active_keepalives' } = $line;
%config_hash{ 'active_keepalives' } =~ s/.*=//gi;
}
# Database server connection information
case /^VARDB_server/ {
%config_hash{ 'db_server' } = $line;
%config_hash{ 'db_server' } =~ s/.*=//gi;
}
case /^VARDB_database/ {
%config_hash{ 'db_database' } = $line;
%config_hash{ 'db_database' } =~ s/.*=//gi;
}
case /^VARDB_user/ {
%config_hash{ 'db_user' } = $line;
%config_hash{ 'db_user' } =~ s/.*=//gi;
}
case /^VARDB_pass/ {
%config_hash{ 'db_pass' } = $line;
%config_hash{ 'db_pass' } =~ s/.*=//gi;
}
case /^VARDB_port/ {
%config_hash{ 'db_port' } = $line;
%config_hash{ 'db_port' } =~ s/.*=//gi;
}
# FTP recording archive connection information
case /^VARFTP_host/ {
%config_hash{ 'ftp_host' } = $line;
%config_hash{ 'ftp_host' } =~ s/.*=//gi;
}
case /^VARFTP_user/ {
%config_hash{ 'ftp_user' } = $line;
%config_hash{ 'ftp_user' } =~ s/.*=//gi;
}
case /^VARFTP_pass/ {
%config_hash{ 'ftp_pass' } = $line;
%config_hash{ 'ftp_pass' } =~ s/.*=//gi;
}
case /^VARFTP_port/ {
%config_hash{ 'ftp_port' } = $line;
%config_hash{ 'ftp_port' } =~ s/.*=//gi;
}
case /^VARFTP_dir/ {
%config_hash{ 'ftp_dir' } = $line;
%config_hash{ 'ftp_dir' } =~ s/.*=//gi;
}
case /^VARHTTP_path/ {
%config_hash{ 'ftp_http_path' } = $line;
%config_hash{ 'ftp_http_path' } =~ s/.*=//gi;
}
# REPORT server connection information
case /^VARREPORT_host/ {
%config_hash{ 'report_host' } = $line;
%config_hash{ 'report_host' } =~ s/.*=//gi;
}
case /^VARREPORT_user/ {
%config_hash{ 'report_user/' } = $line;
%config_hash{ 'report_user/' } =~ s/.*=//gi;
}
case /^VARREPORT_pass/ {
%config_hash{ 'report_pass' } = $line;
%config_hash{ 'report_pass' } =~ s/.*=//gi;
}
case /^VARREPORT_port/ {
%config_hash{ 'report_port' } = $line;
%config_hash{ 'report_port' } =~ s/.*=//gi;
}
case /^VARREPORT_dir/ {
%config_hash{ 'report_dir' } = $line;
%config_hash{ 'report_dir' } =~ s/.*=//gi;
}
}
$i++;
}"$now_date|$script_name|$process_stage|$log_string\n";
# return the hash
return \%config_hash;
}
# function to load the system configs from the db
# ARG0 is an already connected database handle
# this function returns a hash with the servers configs in it
# the hash has the following values:
# version = the version of astguiclient that is being used
# install_date = the date that the orginal installation was done
# use_utf8 = if to use UTF8 instead of latin characters
# webroot_writable = if to place temp files in the webroot directory
# enable_qm_logging = if to use QueueMetrics
# qm_server_ip = QM servers ip address
# qm_dbname = QM DB name
# qm_login = QM DB username
# qm_pass = QM DB password
# qm_url = url to get to QM
# qm_log_id = the server ID that all VICIDIAL logs will use as an id for each record in QM
# qm_eq_prepend = field from vicidial_list to prepend to the cust. phone number in QM
# vd_agent_disable = if to disable manager actions on agents screens
# allow_sipsak_msgs = if to use sipsak
# admin_home_url = url to go to if you click the HOME link on the top of the admin page
# agent_xfer_weblog = log to a text logfile on the webserver every time call is xfered to agent
sub load_sys_config_db {
my $dbh = $_[0];
# init the hash
my %system_hash = ();
# fetch data from db
my $stmt =
"SELECT version, install_date, use_non_latin, webroot_writable, enable_queuemetrics_logging, queuemetrics_server_ip, queuemetrics_dbname, queuemetrics_login, queuemetrics_pass, queuemetrics_url, queuemetrics_log_id, queuemetrics_eq_prepend, vicidial_agent_disable, allow_sipsak_messages, admin_home_url, enable_agc_xfer_log FROM system_settingsqueuemetric LIMIT 1;";
my $sth = $dbh->prepare($stmt) or die "preparing: ", $dbh->errstr;
$sth->execute or die "executing: $stmt ", $dbh->errstr;
@ary = $sth->fetchrow_array;
$sth->finish();
# assign the hash values
%system_hash{ 'version' } = $ary[0]; # version db field
%system_hash{ 'install_date' } = $ary[1]; # install_date db field
%system_hash{ 'use_utf8' } = $ary[2]; # use_non_latin db field
%system_hash{ 'webroot_writable' } = $ary[3]; # webroot_writable db field
%system_hash{ 'enable_qm_log' } = $ary[4]; # enable_queuemetrics_logging db field
%system_hash{ 'qm_server_ip' } = $ary[5]; # queuemetrics_server_ip db field
%system_hash{ 'qm_dbname' } = $ary[6]; # queuemetrics_dbname db field
%system_hash{ 'qm_login' } = $ary[7]; # queuemetrics_login db field
%system_hash{ 'qm_pass' } = $ary[8]; # queuemetrics_pass db field
%system_hash{ 'qm_url' } = $ary[9]; # queuemetrics_url db field
%system_hash{ 'qm_log_id' } = $ary[10]; # queuemetrics_log_id db field
%system_hash{ 'qm_eq_prepend' } = $ary[11]; # queuemetrics_eq_prepend db field
%system_hash{ 'vd_agent_disable' } = $ary[12]; # vicidial_agent_disable db field
%system_hash{ 'allow_sipsak_msgs' } = $ary[13]; # allow_sipsak_messages db field
%system_hash{ 'admin_home_url' } = $ary[14]; # admin_home_url db field
%system_hash{ 'agent_xfer_weblog' } = $ary[15]; # enable_agc_xfer_log db field
# return the hash
return \%system_hash;
}
# function to load a servers configs from the db
# ARG0 is the ip of the server to load configs for
# ARG1 is an already connected database handle
# this function returns a hash with the servers configs in it
# the hash has the following values:
# server_id = the id for the server in the DB
# server_desc = the description of the server
# server_ip = the IP address of the server
# active = if the server is active or not
# ast_version = the version of asterisk used on the server
# max_vd_trunks = the maximum number of trunks vicidial can use on this server
# ast_mgr_host = the telnet host to connect to this servers Asterisk Manager interface
# localhost = what this server thinks localhost should be (usually 127.0.0.1)
# ast_mgr_port = the telnet port to connect to this servers Asterisk Manager interface
# ast_mgr_user = the username for the general connection to the manager interface
# ast_mgr_pass = the secret used to connect to the manager inferface for all of the usernames
# ast_mgr_update_user = the username to run updates from on the manager interface
# ast_mgr_listen_user = the username to listen on the manager interface
# ast_mgr_send_user = the username to send actions on the manager interface
# local_gmt = the gmt offset for this server
# vm_dump_exten = the extension to send voicemail to on this server
# dft_xfer_exten = default extension to send calls to for VICIDIAL auto dialing
# ext_context = the context where to find the vicidial extension
# sys_perf_log = if vicidial should do performance logging for this server
# vd_server_logs = if vicidial should do normal logging for this server
# agi_output = what style of logging should be done for this server
# vd_balance_active = if vicidial should do balanced dialing with this server
# vd_balance_free_trunks = the number of trunks balanced dialing must keep free
sub load_server_config_db {
my $server_ip = $_[0];
my $dbh = $_[1];
# init the hash
my %server_hash = ();
# fetch data from the DB
my $stmt =
"SELECT server_id, server_description, server_ip, active, asterisk_version, max_vicidial_trunks, telnet_host, localhost, telnet_port, ASTmgrUSERNAME, ASTmgrSECRET, ASTmgrUSERNAMEupdate, ASTmgrUSERNAMElisten, ASTmgrUSERNAMEsend, local_gmt, voicemail_dump_exten, answer_transfer_agent, ext_context, sys_perf_log, vd_server_logs, agi_output, vicidial_balance_active, balance_trunks_offlimits FROM SERVERS WHERE server_ip = '$server_ip' LIMIT 1;";
my $sth = $dbh->prepare($stmt) or die "preparing: ", $dbh->errstr;
$sth->execute or die "executing: $stmt ", $dbh->errstr;
@ary = $sth->fetchrow_array;
$sth->finish();
# assign the hash values
%server_hash{ 'server_id' } = "$ary[0]"; # server_id db field
%server_hash{ 'server_desc' } = "$ary[1]"; # server_description db field
%server_hash{ 'server_ip' } = "$ary[2]"; # server_ip db field
%server_hash{ 'active' } = "$ary[3]"; # active db field
%server_hash{ 'ast_version' } = "$ary[4]"; # asterisk_version db field
%server_hash{ 'max_vd_trunks' } = "$ary[5]"; # max_vicidial_trunks db field
%server_hash{ 'ast_mgr_host' } = "$ary[6]"; # telnet_host db field
%server_hash{ 'localhost' } = "$ary[7]"; # localhost db field
%server_hash{ 'ast_mgr_port' } = "$ary[8]"; # telnet_port db field
%server_hash{ 'ast_mgr_user' } = "$ary[9]"; # ASTmgrUSERNAME db field
%server_hash{ 'ast_mgr_pass' } = "$ary[10]"; # ASTmgrSECRET db field
%server_hash{ 'ast_mgr_update_user' } = "$ary[11]"; # ASTmgrUSERNAMEupdate db field
%server_hash{ 'ast_mgr_listen_user' } = "$ary[12]"; # ASTmgrUSERNAMElisten db field
%server_hash{ 'ast_mgr_send_user' } = "$ary[13]"; # ASTmgrUSERNAMEsend db field
%server_hash{ 'local_gmt' } = "$ary[14]"; # local_gmt db field
%server_hash{ 'vm_dump_exten' } = "$ary[15]"; # voicemail_dump_exten db field
%server_hash{ 'dft_xfer_exten' } = "$ary[16]"; # answer_transfer_agent db field
%server_hash{ 'ext_context' } = "$ary[17]"; # ext_context db field
%server_hash{ 'sys_perf_log' } = "$ary[18]"; # sys_perf_log db field
%server_hash{ 'vd_server_logs' } = "$ary[19]"; # vd_server_logs db field
%server_hash{ 'agi_output' } = "$ary[20]"; # agi_output db field
%server_hash{ 'vd_balance_active' } = "$ary[21]"; # vicidial_balance_active db field
%server_hash{ 'vd_balance_free_trunks' } = "$ary[22]"; # balance_trunks_offlimits db field
#return the hash
return \%server_hash;
}
1;