path: root/it.class

<?php
/*
**	Copyright (C) 1995-2007 by the ITools Authors.
**	This file is part of ITools - the Internet Tools Library
**
**	ITools 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 3 of the License, or
**	(at your option) any later version.
**
**	ITools 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.
**
**	You should have received a copy of the GNU General Public License
**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
**
**	it.class - static functions
*/

class it
{
static $error_context; # Text that will be added to all it_error mails

/**
 * Create config class with static members initialized (e.g. $home).
 * NOTE: PHP5 ONLY
 * @param $p Static members to be generated in newly created class
 *      service: Class name of created class (default: from caller path)
 *      home: Home directory of application (default: from caller path)
 *      site: Domain name of application (default: from caller path)
 *      db: Database of application (default: from caller path)
 */
static function createconfig($p = array())
{
	$stack = debug_backtrace();
	$filename = $stack[0]['file'];
	preg_match('!/www/((\w+)[^/]+)!', $filename, $parts);

	$p += array(
		'home' => $parts[0],
		'site' => $parts[1],
		'db' => strtr($parts[1], ".-", "__"),
		'service' => $parts[2],
	);

	if (class_exists($p['service'] . "_tools"))
		$extends = "extends {$p['service']}_tools ";

	$code = array("class {$p['service']} $extends{");

	foreach ($p as $name => $value)
		$code[] = "static \$$name = " . var_export($value, true) . ";";

	$code[] = "}";
	eval(implode("\n", $code));
}


/**
 * Clone an object and return copy, works for all PHP versions
 */
static function &cloneobj(&$object)
{
	$result = (is_object($object) && version_compare(zend_version(), 2, '>=')) ? clone($object) : $object;

	return $result;	# PHP internals need a tmp var to return by ref
}


/**
 * Append all arguments to a logfile (tab separated). Date will be added to filename and line
 * @param $name Name of logfile. Will be in log/ of service unless it starts with /
 * @param $args... Varargs to log, will be tab separated.
 */
static function log($name /* ... */)
{
	$args = func_get_args();
	$line = date("Y-m-d H:i:s") . "\t" . implode("\t", array_slice($args, 1));
	self::log_line($name, $line);
	return $line;
}

/**
 * Append line to a logfile. Date will be added to filename
 * @param $name Name of logfile. Will be in log/ of service unless it starts with /
 * @param $line Line to log.
 */
static function log_line($name, $line)
{
	$basefn = substr($name, 0, 1) == "/" ? $name : ($GLOBALS['ULTRAHOME'] == "/opt/ultra/bin" ? it::match('/www/[^/]*', getcwd()) : $GLOBALS['ULTRAHOME']) . "/log/$name";
	$fullfn = $basefn . "-" . date('Ymd');

	if (substr($fullfn, 0, 1) == "/")
	{
		if (!file_exists($fullfn))
		{
			$tmp = getmypid();
			@touch("$fullfn.$tmp");
			@chgrp("$fullfn.$tmp", "www");
			@chmod("$fullfn.$tmp", 0664);
			@rename("$fullfn.$tmp", $fullfn);
			@unlink($basefn);
			if (@readlink($basefn) < basename($fullfn)) # may be older due to $GLOBALS['debug_time']
				@symlink($fullfn, $basefn);
		}

		it::file_put_contents($fullfn, $line . "\n", FILE_APPEND | LOCK_EX);
	}
}


/**
 * Store timings for appending to log/timer_log-* in auto_append.php
 */
static function timerlog($label = '')
{
	if ($GLOBALS['debug_timerlog'])
		$GLOBALS['ULTRATIMERLOG'] .= sprintf(" %s:%d", $label, (gettimeofday(true) - $GLOBALS['ULTRATIME'])*1000);
}


/**
 * If display_errors is on or stdout is a tty, shows error in page or on stdout respectively
 * If display_errors is off, mails (with rate limiting) diagnostics to .diffnotice addresses or file owner or SERVER_ADMIN
 * @param $p either error title or assoc array of params, see below
 * @param $p['title'] error title, one line. also accepted in $p[0] (with priority). false means ignore error
 * @param $p['body'] error body: multiline string or any data type (will be dumped)
 * @param $p['to'] comma separated recipient list
 * @param $p['id'] id of error, used with timewindow, defaults to file and line of caller
 * @param $p['graceperiod'] in seconds. deprecated, see $p['timewindow']
 * @param $p['timewindow'] in secs. "5-35" means for an notice to be sent, a second error must occur 5 to 35 seconds after first err
 * @param $p['blockmailid'] block mail for $p['blockmail'] seconds with same id. Default: $p['to']
 * @param $p['blockmail'] number of seconds to block mails after having sent a mail [3600]
 * @param $p['backtraceskip'] number of stack levels to drop
 * @param $p['skipfiles'] files to skip in backtrace
 * @param $p['okstate'] give current ok label and ok state, e.g. telresult=1 for working. see failcount
 * @param $p['failcount'] give number of consecutive okstate failures needed for creating an error [2]
 * @param $p['omitdebuginfo'] value 1 omits long stack and var dumps, value 2 also minimal infos
 * @param $p['fatal'] exit after displaying error
 * @return always null (so users can return it::error() in error cases)
 *
 * TIMEWINDOW 5-35 (x = error occurs, no mail; m = error occurs, mail sent)
 *   time        ---|5 secs|30 secs      |------|5 secs|30 secs
 *                                                          |5 secs|30 secs
 *                  x  x                        x   x       m   x     m   x
 * BLOCKMAIL
 *   time        ---|blockmail|--|blockmail|---->
 *   blockmailid    m  x     x   m   x
 *
 * GRACPERIOD/TIMEWINDOW (DEPRECATED, graceperiod is first argument of 5-35, timewindow is difference between 5 and 35)
 *   time        ---|graceperiod|timewindow|
 *                                   |graceperiod|timewindow|--.
 *                                                             |graceperiod|timewindow|------>
 *   id             x  x     x       m    x   x                x     x
 */
static function error($p = array(), $extra = null)
{
	$p = $origp = (array)$p;
	$p['title'] = $p[0] ?: $p['title']; # handle 'it_error' => "oops" that was cast to array on the way
	$p['title'] = grapheme_substr($p['title'], 0, 2000);

	if ($extra)
		it::error('extraneous params passed to it::error');

	foreach (array_slice(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 10), 1) as $level)
		if ($level["class"] . $level["type"] . $level["function"] == "it::error")
			return null; # prevent recursion

	if (error_reporting() == @error_reporting() || $p[0] === false || $p['title'] === false) # called with @ or suppressed
		return $p['fatal'] ? self::_exit($p) : null;

	if ($_SERVER['REMOTE_ADDR'])
		$url = "http://" . it::replace([':443$' => ""], $_SERVER['HTTP_HOST']) . $_SERVER['REQUEST_URI']; # we ignore https for easier debugging
	else
		$url = $_SERVER['SCRIPT_NAME'] . " " . implode(" ", array_slice($GLOBALS['argv'], 1)) . " (pwd " . $_SERVER['PWD'] . ")";

	$gods = strtr(trim(@file_get_contents($GLOBALS['ULTRAHOME'] . "/.diffnotice")), array("\n"=>', ')); # NOPHPLINT
	if (!$p['to'])
		unset($p['to']); # allow defaults to kick in
	$p += array(
		'title' => "it::error",
		'to' => $gods ? $gods : (get_current_user() ? get_current_user() : $_SERVER['SERVER_ADMIN']),
		'graceperiod' => 60,
		'timewindow' => 25*3600,
		'backtraceskip' => 1,
		'blockmail' => $p['okstate'] ? 60 : 3600,
		'omitdebuginfo' => false,
		'failcount' => 2,
		'id' => $p['timewindow'] ? "it_error_id_" . it_debug::backtrace(['skipfiles' => "it.class", 'levels' => 1]) : 0,
	);
	if (it::match('-', $p['timewindow']) && ($parts = explode("-", $p['timewindow'])))
		list($p['graceperiod'], $p['timewindow']) = [$parts[0], $parts[1] - $parts[0]];
	$p += array('blockmailid' => $GLOBALS['ULTRASITE'] . "." . md5($p['to']));
	$trace = it_debug::backtrace(array('skiplevels' => $p['backtraceskip'], 'skipfiles' => $p['skipfiles'])); # moved in here for performance in mass error case

	@mkdir("/tmp/alertdata");
	@chmod("/tmp/alertdata", 0777);

	if ($p['okstate'])
	{
		list($okfn, $okstatus) = explode("=", "/tmp/alertdata/okstate_" . $p['okstate']);
		$failcount = $okstatus ? 0 : (int)@file_get_contents($okfn) + 1; # NOPHPLINT
		file_put_contents($okfn, "$failcount\n"); # NOPHPLINT
		if ($failcount != $p['failcount'] && $failcount != $p['failcount'] * 2)
			return;
	}

	$toscreen = getenv('NOERRORMAILS') || ini_get('display_errors') || (defined("STDOUT") && posix_isatty(STDERR)) || EDC('astwin') || EDC('asdevel');

	if ($toscreen && !it::is_live())
		$GLOBALS['debug_noredir'] = 1;

	if (!$toscreen) # this error can only be sent by mail: find out if we want to suppress it
	{
		if (!$p['id'])
			$sendmail = true;
		else
		{
			$errstampfn = "/tmp/alertdata/errstamp_" . urlencode($p['id']);
			$errstamp = @filemtime($errstampfn);
			$errstampage = time() - $errstamp;
			$sendmail = $errstampage >= $p['graceperiod'] && $errstampage <= $p['graceperiod'] + $p['timewindow'];
			if ($errstampage > $p['graceperiod'])
			{
				@unlink($errstampfn);
				@touch($errstampfn);
			}
		}

		if ($sendmail)
		{
			$lastsentfn = "/tmp/alertdata/it_error_mailsent_" . urlencode($p['blockmailid']);
			clearstatcache();
			$sendmail = time() - max(@filemtime($lastsentfn), it_cache::get($lastsentfn, ['distributed' => true])) > $p['blockmail'] && !it_cache::get('it_error_mute_' . $GLOBALS['ULTRASITE'], ['distributed' => true]);
			if ($sendmail)
			{
				@unlink($lastsentfn);
				@touch($lastsentfn);
				if (it::is_live())
					@it_cache::put($lastsentfn, time(), ['distributed' => true, 'ttl' => 7*86400, 'safety' => 0]);
			}
		}
	}

	if ($p['fatal'] && $_SERVER['REMOTE_ADDR'])
	{
		http_response_code(500);
		echo "<!DOCTYPE html><html><head><title></title></head><body>Internal Server Error</body></html>";
	}

	if ($toscreen || $sendmail)
	{
		$p['body'] = is_string($p['body']) || !array_key_exists('body', $p) ? $p['body'] : var_export($p['body'], true);
		if (strlen($p['body']) > 500000)
		{
			file_put_contents($datafn = "/tmp/alertdata/error-" . substr(md5($p['body']), 0, 2), $p['body']); # NOPHPLINT
			$p['body'] = "Body: " . getenv('HOSTNAME') . ":$datafn";
		}

		$body =
			($p['omitdebuginfo'] >= 2 ? "" : ($url && !$toscreen? "Title:  {$p['title']}\nUrl:    $url\n" : "") .
			($trace ? ($sendmail ? "" : "  ") . "Trace:  $trace\n" : "")) .
			(!$sendmail || $p['omitdebuginfo'] >= 2 ? "" : "Host:   " . getenv('HOSTNAME') . " at " . date("Y-m-d H:i:s") . (($t = time() - $_SERVER['REQUEST_TIME']) ? " (invoked {$t}s before)" : "") . "\n") . # no it::date() due to time- debug param
			($sendmail ? self::$error_context : "") .
			($p['id']     ? "Filter: timewindow=" . $p['graceperiod'] . "-" . ($p['graceperiod'] + $p['timewindow']) . "  (previous err: " . it::date('', $errstamp) . ")\n" : "") .
			(!$origp['blockmail'] || $p['omitdebuginfo'] || $toscreen ? "" : "Block-resend: " . $origp['blockmail'] . " seconds\n") .
			($p['body'] ? ($p['omitdebuginfo'] ? "" : "Body:\n") . trim($p['body'])."\n\n" : "");

		if ($sendmail) # we're mailing: send maximum info
		{
			$p['title'] = it::replace(['alert:|server:|^: "' => "", '(pw|passw|password\d*|secret)(=)[^&\s]*' => '$1$2*****'], it::match('[^.]*', $GLOBALS['ULTRASITE']) . ": " . $p['title']) . " (via " . getenv('HOSTNAME') . ")";

			if (!$p['omitdebuginfo'])
			{
				foreach (($trace ? debug_backtrace() : array()) as $level => $stackframe)
					if ($level >= $p['backtraceskip'] && $tracesize < 100000 && ($tracesize += strlen(print_r($stackframe, true))) < 100000) # save mem
						$stackframes[] = $stackframe;

				$rawpost = $_SERVER['REQUEST_METHOD'] == "POST" && !it::match('application/x-www-form-urlencoded|multipart/form-data', $_SERVER['CONTENT_TYPE']) ? it::file_get_contents("php://input") : "";

				$body .= ($trace and $t = it::exec('grep -h {0} `ls /tmp/alertdata/alertlog-*|tail -3` /dev/null 2>/dev/null | grep ^2 | cut -d : -f 1-2 | sort | uniq -c | tail -10', $trace)) ? "Histogram: (last 10 affected minutes in 3 days)\n$t" : "";
				$body .= "\n";
				$body .= $_GET        ? "\$_GET: "    . var_export($_GET, true) . "\n\n" : "";
				$body .= $_POST       ? "\$_POST: "   . var_export($_POST, true) . "\n\n" : "";
				$body .= $rawpost     ? "\$rawpost: " . var_export($rawpost, true) . "\n\n" : "";
				$body .= $_COOKIE     ? "\$_COOKIE: " . var_export($_COOKIE, true) . "\n\n" : "";
				$body .= $_SERVER['REMOTE_ADDR'] ? "" : "Pstree:\n" . it::exec("pstree -als " . getmypid() . " | head -n -3") . "\n";
				$body .= $_SERVER     ? "\$_SERVER: " . var_export($_SERVER, true) . "\n\n" : "";
				$body .= $_FILES      ? "\$_FILES:  " . var_export($_FILES, true) . "\n\n" : "";
				$body .= "Processes:\n" . it::exec('ps auxf | egrep -v "rotatelogs|getbanner|logaction|httpd|systemd|sd-pam"|egrep "^www|^cron"') . "\n";
				$body .= $stackframes ? "Stack: "     . print_r($stackframes, true) . "\n\n" : "";
				$body  = it::replace(array('(pw|passw|password\d*|secret)(\' => |\] => |=)[^&\s]*' => '$1$2********'), $body, array('utf8' => false));
			}

			$type = ($p['fatal'] ? "Fatal: " : "Error: ");
			$debugparams = it::replace(['^debug_' => ""], it::grep('^debug_(.*)', array_keys($GLOBALS)));
			if (!it::is_live() || array_diff($debugparams, it::match('[-\w]+', $GLOBALS['ULTRAHOME'], ['all' => true]), ["devel", "twin", "utf8check", gethostname()]))
				$type = mb_strtolower($type);

			$user = posix_getpwuid(posix_geteuid())['name'];

			it::mail([
				'From' => "\"$user@" . gethostname() . "\" <$user>",
				'To' => $p['to'],
				'Reply-To' => $p['to'],
				'Cc' => $GLOBALS['it_defaultconfig']['error_cc'],
				'Subject' => $type . substr($p['title'], 0, 160),
				'Body' => $body,
				'forcemail' => !it::is_devel(),
			]);
			$p['title'] = "Mail: " . $p['title'];
		}
		else if ($_SERVER['REMOTE_ADDR'] && EDC('edplain')) # toscreen mode: web
			echo $p['title'] . "\n";
		else if ($_SERVER['REMOTE_ADDR']) # toscreen mode: web
			echo "<pre style='z-index:10000; position:relative; background:white'>" . htmlspecialchars($p['title'] . "\n" . rtrim($body), ENT_COMPAT, "iso-8859-1") . "</pre>"; # works with iso-8859-1 or utf-8, UTF8SAFE
		else  # toscreen mode: shell (outputs to stderr)
			error_log(substr($p['title'], 0, 100000) . ($p['omitdebuginfo'] >= 2 ? "" : " in " . ($trace ? $trace : " {$p['file']}:{$p['line']}") . " Url: $url " . (EDC('verboseerrors') ? D($p['body']) : "")));
	}

	if ($_SERVER['REMOTE_ADDR']) # additional entry in log/error_log
		error_log("it::error: " . $p['title'] . " Url: $url");

	it::log("/tmp/alertdata/alertlog", $p['title'] . " in " . ($trace ? $trace : "{$p['file']}:{$p['line']}") . " Url: $url" . ($p['body'] ? "\n" . substr(D($p['body']), 0, 5000) . "\n" : ""));

	return $p['fatal'] ? self::_exit($p) : null;
}


/**
 * Same as it::error(), plus exit
 * @see error()
 */
static function fatal($p)
{
	it::error(['fatal' => true, 'backtraceskip' => 2] + (array)$p);
}


/**
 * Print message to stderr and exit with error code
 */
static function bail($message = "Bailed.")
{
	fputs(STDERR, rtrim($message, "\n") . "\n");
	exit(1);
}

static function _exit($p)
{
	if ($GLOBALS['it_defaultconfig']['fatal_throws_exception'])
		throw new Exception($p['title']);
	exit(99);
}


/**
 * Check wether I am on a live server for this service. Honors 'aslive' and 'asdevel' debug vars
 * @return true if servertype is 'live'
 */
static function is_live()
{
	return (preg_match("/^live/", $GLOBALS['ULTRASERVERTYPE']) || !$GLOBALS['ULTRASERVERTYPE'] || EDC('aslive')) && !EDC('asdevel');
}


/**
 * Check wether I am on a development server for this service. Honors 'aslive' and 'asdevel' debug vars
 * @return true if servertype is 'devel'
 */
static function is_devel()
{
	return (preg_match("/^devel/", $GLOBALS['ULTRASERVERTYPE']) || EDC('asdevel')) && !EDC('aslive');
}


/**
 * Convert a string to ASCII-only chars, map/strip ISO-8859-1 accents
 * @param $text Text to convert
 * @return mapped/stripped version of $text contains only chars [0..127]
 */
static function toascii($text)
{
	return strtr(strtr($text,
		utf8_decode(	'ÇéâàåçêëèïîìÅÉôòûùÿøØáíóúñÑÁÂÀãÃÊËÈÍÎÏÓÔõÕÚÛÙýÝ'),
				'CeaaaceeeiiiAEoouuyooaiounNAAAaAEEEIIIOOoOUUUyY'),
		array("\xe4" => 'ae', "\xf6" => 'oe', "\xfc" => 'ue', "\xc4" => 'Ae', "\xd6" => 'Oe', "\xdc" => 'Ue', "\xe6" => 'ae', "\xc6" => 'Ae', "\xdf" => 'ss'));
}


/**
 * Check whether an IP adress lies within a given range. Supports IPv4 and IPv6
 * @param $ip IP address (192.168.42.123)
 * @param $cidrs IP range in CIDR notation (192.168.42.64/26) or array of ranges
 * @return true if $ip is within $cidr
 */
static function cidr_match($ip, $cidrs)
{
	foreach ((array)$cidrs as $cidr)
	{
		list($subnet, $mask) = explode('/', $cidr);
		$ip_bin = inet_pton($ip);
		$subnet_bin = inet_pton($subnet);
		$valid_bytes = $mask ? $mask >> 3 : 42;
		$bitmask = 256 - (1 << (8 - ($mask & 7)));
		$lastbyte_matched = $bitmask ? (ord($ip_bin[$valid_bytes]) & $bitmask) == (ord($subnet_bin[$valid_bytes]) & $bitmask) : true;

		if (substr($ip_bin, 0, $valid_bytes) == substr($subnet_bin, 0, $valid_bytes) && $lastbyte_matched)
			return true;
	}

	return false;
}


/**
 * Convert regex for preg (adds and escapes delimiter, adds modifiers)
 * @param $pattern Regex to convert
 * @param $p['casesensitive'] Regex is case sensitive (omit modifier i)
 * @param $p['multiline'] add modifier m: ^ and $ match \n
 * @param $p['singleline'] add modifier s: . matches \n
 * @param $p['utf8'] add modifier u. This is the default if default_charset is utf-8, override with $p['utf8'] = false
 * @param $p['extended'] add modifier x (non signifcant whitespace)
 *