<?php
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\
* Logging convenience                                                       *
\* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

define("SCORE_LOG_CRITICAL", 50);
define("SCORE_LOG_ERROR", 40);
define("SCORE_LOG_WARNING", 30);
define("SCORE_LOG_INFO", 20);
define("SCORE_LOG_DEBUG", 10);
define("SCORE_LOG_NOTSET", 0);

/**
 * A shorthand way to send a LogEvent
 *
 * When parsing a user request, a flash message should give info to the user
 * When taking action, a log event should be stored by the server
 * Quite often, both of these happen at once, hence log_*() having $flash
 *
 * $flash = null (default) - log to server only, no flash message
 * $flash = true           - show the message to the user as well
 * $flash = "some string"  - log the message, flash the string
 *
 * @param string $section
 * @param int $priority
 * @param string $message
 * @param bool|string $flash
 * @param array $args
 */
function log_msg(string $section, int $priority, string $message, $flash=false, $args=array()) {
	send_event(new LogEvent($section, $priority, $message, $args));
	$threshold = defined("CLI_LOG_LEVEL") ? CLI_LOG_LEVEL : 0;

	if((PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') && ($priority >= $threshold)) {
		print date("c")." $section: $message\n";
	}
	if($flash === true) {
		flash_message($message);
	}
	else if(is_string($flash)) {
		flash_message($flash);
	}
}

// More shorthand ways of logging
/**
 * @param string $section
 * @param string $message
 * @param bool|string $flash
 * @param array $args
 */
function log_debug(   string $section, string $message, $flash=false, $args=array()) {log_msg($section, SCORE_LOG_DEBUG, $message, $flash, $args);}
/**
 * @param string $section
 * @param string $message
 * @param bool|string $flash
 * @param array $args
 */
function log_info(    string $section, string $message, $flash=false, $args=array()) {log_msg($section, SCORE_LOG_INFO, $message, $flash, $args);}
/**
 * @param string $section
 * @param string $message
 * @param bool|string $flash
 * @param array $args
 */
function log_warning( string $section, string $message, $flash=false, $args=array()) {log_msg($section, SCORE_LOG_WARNING, $message, $flash, $args);}
/**
 * @param string $section
 * @param string $message
 * @param bool|string $flash
 * @param array $args
 */
function log_error(   string $section, string $message, $flash=false, $args=array()) {log_msg($section, SCORE_LOG_ERROR, $message, $flash, $args);}
/**
 * @param string $section
 * @param string $message
 * @param bool|string $flash
 * @param array $args
 */
function log_critical(string $section, string $message, $flash=false, $args=array()) {log_msg($section, SCORE_LOG_CRITICAL, $message, $flash, $args);}


/**
 * Get a unique ID for this request, useful for grouping log messages.
 *
 * @return string
 */
function get_request_id(): string {
	static $request_id = null;
	if(!$request_id) {
		// not completely trustworthy, as a user can spoof this
		if(@$_SERVER['HTTP_X_VARNISH']) {
			$request_id = $_SERVER['HTTP_X_VARNISH'];
		}
		else {
			$request_id = "P" . uniqid();
		}
	}
	return $request_id;
}