2017-08-26 08:04:21 +02:00
|
|
|
<?php
|
2017-11-19 20:15:25 +01:00
|
|
|
/**
|
|
|
|
|
* @file src/Core/System.php
|
|
|
|
|
*/
|
2017-08-26 08:04:21 +02:00
|
|
|
namespace Friendica\Core;
|
|
|
|
|
|
2017-12-17 17:35:06 +01:00
|
|
|
use Friendica\BaseObject;
|
2018-01-27 17:59:10 +01:00
|
|
|
use Friendica\Util\XML;
|
2017-08-26 08:04:21 +02:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @file include/Core/System.php
|
|
|
|
|
*
|
|
|
|
|
* @brief Contains the class with system relevant stuff
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief System methods
|
|
|
|
|
*/
|
2017-12-17 17:35:06 +01:00
|
|
|
class System extends BaseObject
|
2017-11-19 20:15:25 +01:00
|
|
|
{
|
2017-08-26 08:04:21 +02:00
|
|
|
/**
|
|
|
|
|
* @brief Retrieves the Friendica instance base URL
|
|
|
|
|
*
|
|
|
|
|
* @param bool $ssl Whether to append http or https under SSL_POLICY_SELFSIGN
|
|
|
|
|
* @return string Friendica server base URL
|
|
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function baseUrl($ssl = false)
|
|
|
|
|
{
|
2017-12-17 17:35:06 +01:00
|
|
|
return self::getApp()->get_baseurl($ssl);
|
2017-08-26 08:04:21 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Removes the baseurl from an url. This avoids some mixed content problems.
|
|
|
|
|
*
|
2017-11-19 20:15:25 +01:00
|
|
|
* @param string $orig_url The url to be cleaned
|
2017-08-26 08:04:21 +02:00
|
|
|
*
|
|
|
|
|
* @return string The cleaned url
|
|
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function removedBaseUrl($orig_url)
|
|
|
|
|
{
|
2017-12-17 17:35:06 +01:00
|
|
|
return self::getApp()->remove_baseurl($orig_url);
|
2017-08-26 08:04:21 +02:00
|
|
|
}
|
|
|
|
|
|
2017-08-26 12:01:50 +02:00
|
|
|
/**
|
|
|
|
|
* @brief Returns a string with a callstack. Can be used for logging.
|
2017-11-19 20:15:25 +01:00
|
|
|
* @param integer $depth optional, default 4
|
2017-08-26 12:01:50 +02:00
|
|
|
* @return string
|
|
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function callstack($depth = 4)
|
|
|
|
|
{
|
2017-10-17 22:51:46 +02:00
|
|
|
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
2017-08-26 12:01:50 +02:00
|
|
|
|
|
|
|
|
// We remove the first two items from the list since they contain data that we don't need.
|
|
|
|
|
array_shift($trace);
|
|
|
|
|
array_shift($trace);
|
|
|
|
|
|
2018-01-15 14:05:12 +01:00
|
|
|
$callstack = [];
|
2017-10-17 22:51:46 +02:00
|
|
|
$counter = 0;
|
2018-01-15 14:05:12 +01:00
|
|
|
$previous = ['class' => '', 'function' => ''];
|
2017-10-17 22:51:46 +02:00
|
|
|
|
|
|
|
|
// The ignore list contains all functions that are only wrapper functions
|
2018-04-10 07:55:36 +02:00
|
|
|
$ignore = ['fetchUrl', 'call_user_func_array'];
|
2017-10-17 22:51:46 +02:00
|
|
|
|
|
|
|
|
while ($func = array_pop($trace)) {
|
2017-08-26 12:01:50 +02:00
|
|
|
if (!empty($func['class'])) {
|
2018-04-13 22:09:12 +02:00
|
|
|
// Don't show multiple calls from the "dba" class to show the essential parts of the callstack
|
|
|
|
|
if ((($previous['class'] != $func['class']) || ($func['class'] != 'dba')) && ($previous['function'] != 'q')) {
|
2017-10-17 22:51:46 +02:00
|
|
|
$classparts = explode("\\", $func['class']);
|
|
|
|
|
$callstack[] = array_pop($classparts).'::'.$func['function'];
|
|
|
|
|
$previous = $func;
|
|
|
|
|
}
|
|
|
|
|
} elseif (!in_array($func['function'], $ignore)) {
|
2017-08-26 12:01:50 +02:00
|
|
|
$callstack[] = $func['function'];
|
2018-07-01 06:15:11 +02:00
|
|
|
$func['class'] = '';
|
2017-10-17 22:51:46 +02:00
|
|
|
$previous = $func;
|
2017-08-26 12:01:50 +02:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-01-15 14:05:12 +01:00
|
|
|
$callstack2 = [];
|
2017-10-17 22:51:46 +02:00
|
|
|
while ((count($callstack2) < $depth) && (count($callstack) > 0)) {
|
|
|
|
|
$callstack2[] = array_pop($callstack);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return implode(', ', $callstack2);
|
2017-08-26 12:01:50 +02:00
|
|
|
}
|
|
|
|
|
|
2017-12-13 22:55:19 +01:00
|
|
|
/**
|
|
|
|
|
* @brief Called from db initialisation when db is dead.
|
|
|
|
|
*/
|
|
|
|
|
static public function unavailable() {
|
|
|
|
|
echo <<< EOT
|
|
|
|
|
<html>
|
|
|
|
|
<head><title>System Unavailable</title></head>
|
|
|
|
|
<body>Apologies but this site is unavailable at the moment. Please try again later.</body>
|
|
|
|
|
</html>
|
|
|
|
|
EOT;
|
|
|
|
|
|
|
|
|
|
killme();
|
|
|
|
|
}
|
|
|
|
|
|
2018-01-27 17:59:10 +01:00
|
|
|
/**
|
|
|
|
|
* Generic XML return
|
|
|
|
|
* Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
|
|
|
|
|
* of $st and an optional text <message> of $message and terminates the current process.
|
|
|
|
|
*/
|
|
|
|
|
public static function xmlExit($st, $message = '')
|
|
|
|
|
{
|
|
|
|
|
$result = ['status' => $st];
|
|
|
|
|
|
|
|
|
|
if ($message != '') {
|
|
|
|
|
$result['message'] = $message;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ($st) {
|
|
|
|
|
logger('xml_status returning non_zero: ' . $st . " message=" . $message);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
header("Content-type: text/xml");
|
|
|
|
|
|
|
|
|
|
$xmldata = ["result" => $result];
|
|
|
|
|
|
|
|
|
|
echo XML::fromArray($xmldata, $xml);
|
|
|
|
|
|
|
|
|
|
killme();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @brief Send HTTP status header and exit.
|
|
|
|
|
*
|
|
|
|
|
* @param integer $val HTTP status result value
|
|
|
|
|
* @param array $description optional message
|
|
|
|
|
* 'title' => header title
|
|
|
|
|
* 'description' => optional message
|
|
|
|
|
*/
|
|
|
|
|
public static function httpExit($val, $description = [])
|
|
|
|
|
{
|
|
|
|
|
$err = '';
|
|
|
|
|
if ($val >= 400) {
|
|
|
|
|
$err = 'Error';
|
|
|
|
|
if (!isset($description["title"])) {
|
|
|
|
|
$description["title"] = $err." ".$val;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ($val >= 200 && $val < 300) {
|
|
|
|
|
$err = 'OK';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
logger('http_status_exit ' . $val);
|
|
|
|
|
header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $err);
|
|
|
|
|
|
|
|
|
|
if (isset($description["title"])) {
|
|
|
|
|
$tpl = get_markup_template('http_status.tpl');
|
2018-07-08 11:37:05 +02:00
|
|
|
echo replace_macros($tpl, ['$title' => $description["title"],
|
|
|
|
|
'$description' => defaults($description, 'description', '')]);
|
2018-01-27 17:59:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
killme();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2018-06-18 23:05:44 +02:00
|
|
|
* @brief Encodes content to json.
|
2018-01-27 17:59:10 +01:00
|
|
|
*
|
|
|
|
|
* This function encodes an array to json format
|
|
|
|
|
* and adds an application/json HTTP header to the output.
|
|
|
|
|
* After finishing the process is getting killed.
|
|
|
|
|
*
|
2018-06-18 23:05:44 +02:00
|
|
|
* @param array $x The input content.
|
|
|
|
|
* @param string $content_type Type of the input (Default: 'application/json').
|
2018-01-27 17:59:10 +01:00
|
|
|
*/
|
2018-06-18 23:05:44 +02:00
|
|
|
public static function jsonExit($x, $content_type = 'application/json') {
|
|
|
|
|
header("Content-type: $content_type");
|
2018-01-27 17:59:10 +01:00
|
|
|
echo json_encode($x);
|
|
|
|
|
killme();
|
|
|
|
|
}
|
|
|
|
|
|
2018-07-09 21:38:16 +02:00
|
|
|
/**
|
|
|
|
|
* Generates a GUID with the given parameters
|
|
|
|
|
*
|
|
|
|
|
* @param int $size The size of the GUID (default is 16)
|
|
|
|
|
* @param bool|string $prefix A given prefix (default is empty)
|
|
|
|
|
* @return string a generated GUID
|
|
|
|
|
*/
|
|
|
|
|
public static function createGUID($size = 16, $prefix = '')
|
|
|
|
|
{
|
|
|
|
|
if (is_bool($prefix) && !$prefix) {
|
|
|
|
|
$prefix = '';
|
2018-07-09 22:10:35 +02:00
|
|
|
} elseif (empty($prefix)) {
|
2018-07-09 21:38:16 +02:00
|
|
|
$prefix = hash('crc32', self::getApp()->get_hostname());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
while (strlen($prefix) < ($size - 13)) {
|
|
|
|
|
$prefix .= mt_rand();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if ($size >= 24) {
|
|
|
|
|
$prefix = substr($prefix, 0, $size - 22);
|
|
|
|
|
return str_replace('.', '', uniqid($prefix, true));
|
|
|
|
|
} else {
|
|
|
|
|
$prefix = substr($prefix, 0, max($size - 13, 0));
|
|
|
|
|
return uniqid($prefix);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-07-11 00:32:47 +02:00
|
|
|
/**
|
|
|
|
|
* Generates a process identifier for the logging
|
|
|
|
|
*
|
|
|
|
|
* @param string $prefix A given prefix
|
|
|
|
|
*
|
|
|
|
|
* @return string a generated process identifier
|
|
|
|
|
*/
|
|
|
|
|
public static function processID($prefix)
|
|
|
|
|
{
|
|
|
|
|
return uniqid($prefix . ':' . str_pad(getmypid() . ':', 8, '0') . ':');
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-26 08:04:21 +02:00
|
|
|
/// @todo Move the following functions from boot.php
|
|
|
|
|
/*
|
|
|
|
|
function killme()
|
|
|
|
|
function goaway($s)
|
|
|
|
|
function local_user()
|
|
|
|
|
function public_contact()
|
|
|
|
|
function remote_user()
|
|
|
|
|
function notice($s)
|
|
|
|
|
function info($s)
|
|
|
|
|
function is_site_admin()
|
|
|
|
|
function random_digits($digits)
|
|
|
|
|
function get_server()
|
|
|
|
|
function get_temppath()
|
|
|
|
|
function get_cachefile($file, $writemode = true)
|
|
|
|
|
function get_itemcachepath()
|
|
|
|
|
function get_spoolpath()
|
|
|
|
|
function current_load()
|
|
|
|
|
*/
|
|
|
|
|
}
|
