<?php
/**
  * Common header for all m2f scripts.
  *
  * @author Patricio Anguita
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Revision: 1.63 $
  * @internal $Id: m2f_common.php,v 1.63 2005/08/02 01:29:35 georgeocrawford Exp $
*/

// This is used to make the version number that appears in the M2F settings page. The
// displayed version number is created by concatenating the m2f version with the db
// version with a dot in between. Increment the first two components for each
// major release (0.9, 1.0, 1.2, 2.0, etc.) and then increment the third component for
// each beta or bug fix release within the major release (1.0.0, 1.0.1, 1.0.2, etc.).
$m2f_version = '1.1.3';

// This version number identifies the DB schema that this script expects. Increment
// this number each time the DB schema is changed.
$m2f_desired_db_version = 8;

// Define main path, in case this file is called outside the root path (i.e. in admin/ directory)
if (!isset($m2f_root_path)) $m2f_root_path = './';
if (!$m2f_root_path) $m2f_root_path = './';

// pnphpbb specifics by ksg-serg
if(isset($ModName)) 
{
  $phpbb_root_path = './modules/' . $ModName . '/';
  $m2f_root_path = $phpbb_root_path.'m2f/';
}

// Include install-specific mandatory configuration
if (file_exists($m2f_root_path . 'm2f_config.php'))
{
  include_once ($m2f_root_path . 'm2f_config.php');
}
else
{
  m2f_display_error("m2f_config.php not found, check your installation!");
  die;
}


// Load proper values if phpBB DB is used
if (_M2F_USE_PHPBB_DB_)
{
  $type_db = $dbms;
	$user_db = $dbuser; 
	$pass_db = $dbpasswd; 
	$name_db = $dbname; 
	$host_db = $dbhost;
}

// phpBB uses mysql4 dbms when necessary, but PEAR makes no distinction in the db type
switch ($type_db) {
  case 'mysql4':
  $type_db = 'mysql';
  break ;

  case 'postgres':
  $type_db = 'pgsql';
  break;
}

// Table Configuration
// -------------------

// Distribution list table
define("_M2F_DISTRIBUTIONLIST_TABLE_", _M2F_TABLE_PREFIX_ . 'distributionlist');

// Mailing list config table
define("_M2F_MAILINGLIST_TABLE_", _M2F_TABLE_PREFIX_ . 'mailinglist');

// MSG - Mail - Post relationship
define("_M2F_MSG_TABLE_", _M2F_TABLE_PREFIX_ . 'msg');

// Subscription info
define("_M2F_SUBSCRIPTION_TABLE_", _M2F_TABLE_PREFIX_ . 'subscription');

// Group Subscription info
define("_M2F_GROUP_SUBSCRIPTION_TABLE_", _M2F_TABLE_PREFIX_ . 'group_subscription');

// M2F Config table
define("_M2F_CONFIG_TABLE_", _M2F_TABLE_PREFIX_ . 'config');

// M2F Log table
define("_M2F_LOG_TABLE_", _M2F_TABLE_PREFIX_ . 'log');

// Distribution list config table 
define("_M2F_DISTRIBUTIONLIST_CONFIG_TABLE_", _M2F_TABLE_PREFIX_ . 'distributionlist_config');

// Cron table 
define("_M2F_CRON_TABLE_", _M2F_TABLE_PREFIX_ . 'cron');

// Sent emails Message IDs table
define("_M2F_MESSAGE_ID_TABLE_", _M2F_TABLE_PREFIX_ . 'message_id');

// Processed Message table - stores md5 hashes or message-ids
define("_M2F_MESSAGE_HASH_TABLE_", _M2F_TABLE_PREFIX_ . 'message_hash');

// Regexp Pattern Matching table
define("_M2F_PATTERN_MATCH_TABLE_", _M2F_TABLE_PREFIX_ . 'patterns');

// Link patterns to dist lists table
define("_M2F_DIST_LIST_PATTERNS_TABLE_", _M2F_TABLE_PREFIX_ . 'dist_list_patterns');

// Set up PEAR on the path
if (_M2F_USE_LOCAL_PEAR_)
{
	$pear_root_path = $m2f_root_path . 'includes/pear/';

	if (!defined('PATH_SEPARATOR'))
	{
		$separator = strtoupper(substr(PHP_OS,0,3)=='WIN') ? ';' : ':';
		define('PATH_SEPARATOR', $separator);
	}
	
	$new_include_path = $pear_root_path . PATH_SEPARATOR . '../' . $pear_root_path . PATH_SEPARATOR . ini_get('include_path'); 
	if (function_exists('set_include_path')) 
	{ 
	  set_include_path($new_include_path); 
	} 
	else 
	{ 
	  ini_set('include_path', $new_include_path); 
	} 
}

// Load libraries
require_once('Log.php');		// PEAR Logging layer
require_once('DB.php');		// PEAR DB layer
require_once('Mail.php');	// PEAR MAIL layer
require_once('Mail/mime.php'); // PEAR Mail_mime layer

// Load compatibility functions, if needed
if (!function_exists('html_entity_decode'))
{
	require_once('Compat/Function/html_entity_decode.php');
}
if (!function_exists('is_a'))
{
	require_once('Compat/Function/is_a.php');
}

// Instatiate database reusable object
$m2f_db = DB::connect( "$type_db://$user_db:$pass_db@$host_db/$name_db" );

// Instantiate log object(s)

// FILE:
if ((_M2F_LOG_METHOD_ == 'FILE') || (_M2F_LOG_METHOD_ == 'BOTH')) 
{
	$file_log  = &Log::singleton('file', _M2F_LOG_FILE_ , '[M2F]', array('mode' => 0600, 'timeFormat' => '%X %x') , constant(_M2F_LOG_LEVEL_));
	if (!$file_log) 
	{
		m2f_display_error("[" . __FILE__ . " : " . __LINE__ . "] Could not create log in the file at " . _M2F_LOG_FILE_);
		die;
	}
}

// DATABASE:
if (!(DB::isError($m2f_db)) && ((_M2F_LOG_METHOD_ == 'DATABASE') || (_M2F_LOG_METHOD_ == 'BOTH'))) 
{
	$sql_log = &Log::singleton('sql', _M2F_LOG_TABLE_, '[M2F]', array('db' => $m2f_db, 'sequence' => _M2F_LOG_TABLE_), constant(_M2F_LOG_LEVEL_));
	if (!$sql_log) 
	{
		m2f_display_error("[" . __FILE__ . " : " . __LINE__ . "] Could not create database log");
		die;
	}
}

// Add them together
$m2f_log = &Log::singleton('composite');
if (@$file_log) $m2f_log->addChild($file_log);
if (@$sql_log) $m2f_log->addChild($sql_log);

// If there's been a database error, we can still write the error to the FILE log if it exists
if (DB::isError($m2f_db))
{
	$m2f_error_msg = 'Could not connect to the database: <br /><b>'.$m2f_db->getMessage() . '</b>';
	m2f_log(PEAR_LOG_CRIT , $m2f_error_msg , __LINE__ , __FILE__ );
	die;
}

// Report on Log creation
m2f_log(PEAR_LOG_INFO , "Log object instantiated" , __LINE__ , __FILE__ );

// Report on database connection
m2f_log(PEAR_LOG_INFO , "Connected to database" , __LINE__ , __FILE__ );

// Set default DB fetch mode to associative
$m2f_db->setFetchMode(DB_FETCHMODE_ASSOC);

// Load configuration parameters
m2f_log(PEAR_LOG_INFO , "Attempting to load config parameters" , __LINE__ , __FILE__ );
m2f_get_config_parameters();

// **********************************************************************************************
// *************************** GLOBAL FUNCTIONS START HERE **************************************
// **********************************************************************************************

// Global Logging function
function m2f_log ($log_level , $msg , $line , $file, $debug_var = '')
{
  global $m2f_log;
  $file = basename($file);
  $log_msg = "[$file, line $line] $msg";
  
  if ($debug_var != '')
  {
    $log_msg .= " = " . m2f_debug_var($debug_var);
  }
  
  $m2f_log->log($log_msg , $log_level);
  if ($log_level == PEAR_LOG_CRIT) m2f_display_error($log_msg);
}

// Global var debugging function
function m2f_debug_var($var)
{
  ob_start();
  print_r($var);
  $ret_str = ob_get_contents();
  ob_end_clean();
  
  return $ret_str;
}

// Check return value from DB call
function check_db_result($db_result, $sql, $line, $file)
{
  if (DB::isError($db_result))
  {
    $m2f_error_msg = "DB error. sql: '$sql' error: " . $db_result->getMessage();
    m2f_log(PEAR_LOG_CRIT , $m2f_error_msg , $line, $file);
    die;
  }
}

// For important errors which don't need to kill the script
function m2f_display_error($error)
{
	echo '<span class="code">[Mail2Forum] ' . $error . '</span><br />';
}


// Get config paramters
function m2f_get_config_parameters()
{
  global $m2f_config , $m2f_db , $m2f_root_path , $type_db,
  $m2f_desired_db_version, $m2f_version;
  
  // See if M2F tables have been created, and read additional configuration directives from the database
  $sql = "SELECT config_name, config_value FROM " . _M2F_CONFIG_TABLE_;
  $db_result =& $m2f_db->getAssoc($sql, false, array(), DB_FETCHMODE_DEFAULT, true);
  
  if (DB::isError($db_result))
  {
    m2f_log(PEAR_LOG_WARNING , "M2F config table not found (first run?), attempting to build M2F tables" , __LINE__ , __FILE__ );

    // Try to build the DB schema
    include_once($m2f_root_path."db/m2f_schema.php");
    m2f_create_tables($type_db);
    m2f_log(PEAR_LOG_NOTICE , "M2F tables created" , __LINE__ , __FILE__ );
    
    // Try again
    $sql = "SELECT config_name, config_value FROM " . _M2F_CONFIG_TABLE_;
	  $db_result =& $m2f_db->getAssoc($sql, false, array(), DB_FETCHMODE_DEFAULT, true);
    check_db_result($db_result, $sql, __LINE__, __FILE__);
  }
  
  // Check the M2F version and see if the tables need updating
  $cur_db_version = isset($db_result['_M2F_DB_VERSION_']) ? $db_result['_M2F_DB_VERSION_'][0] : 0;
  if ($cur_db_version < $m2f_desired_db_version)
  {
 	  m2f_log(PEAR_LOG_WARNING , "Updating M2F tables to DB version $m2f_desired_db_version" , __LINE__ , __FILE__);

    $current_config = $db_result;
    include_once($m2f_root_path."db/m2f_schema.php");
    m2f_update_distributionlists();
    m2f_update_tables($current_config, $type_db);
    m2f_add_hardcoded_patterns();
  	
  	// Get updated configuration
    $sql = "SELECT config_name, config_value FROM " . _M2F_CONFIG_TABLE_;
	  $db_result =& $m2f_db->getAssoc($sql, false, array(), DB_FETCHMODE_DEFAULT, true);
    check_db_result($db_result, $sql, __LINE__, __FILE__);
  }
  
  // Populate $m2f_config[] array
  $m2f_config = array();
  $m2f_config['_M2F_VERSION_'] = "$m2f_version.{$db_result['_M2F_DB_VERSION_'][0]}";
  m2f_log(PEAR_LOG_INFO , "Loading config values" , __LINE__ , __FILE__);
  foreach ($db_result as $key => $value)
  {
  	if (count($value) > 1)
  	{
  		$m2f_config[$key] = $value;
  	}
  	else
  	{
  		$m2f_config[$key] = $value[0];
  	}
  }

	// Try to set the uni-valued config directives as constants
	foreach ($m2f_config as $config_name => $config_value)
	{
		if (!defined($config_name) && !is_array($config_value))
		{
			define($config_name, $config_value);
		}
	}
	
  m2f_log(PEAR_LOG_DEBUG , "Config values: " , __LINE__ , __FILE__ , $m2f_config);
}
?>