<?php
/**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
namespace Friendica\Core;
-use Exception;
-use Friendica\App;
+use Friendica\Content\Text\BBCode;
+use Friendica\Content\Text\HTML;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\DI;
+use Friendica\Model\User;
+use Friendica\Module\Response;
use Friendica\Network\HTTPException\FoundException;
+use Friendica\Network\HTTPException\InternalServerErrorException;
use Friendica\Network\HTTPException\MovedPermanentlyException;
use Friendica\Network\HTTPException\TemporaryRedirectException;
use Friendica\Util\BasePath;
use Friendica\Util\XML;
+use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerInterface;
/**
$load = System::currentLoad();
if ($load) {
if (intval($load) > $maxsysload) {
- $this->logger->warning('system load for process too high.', ['load' => $load, 'process' => 'backend', 'maxsysload' => $maxsysload]);
+ $this->logger->notice('system load for process too high.', ['load' => $load, 'process' => 'backend', 'maxsysload' => $maxsysload]);
return true;
}
}
* @param integer $depth How many calls to include in the stacks after filtering
* @param int $offset How many calls to shave off the top of the stack, for example if
* this is called from a centralized method that isn't relevant to the callstack
+ * @param bool $full If enabled, the callstack is not compacted
* @return string
*/
- public static function callstack(int $depth = 4, int $offset = 0): string
+ public static function callstack(int $depth = 4, int $offset = 0, bool $full = false): string
{
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
while ($func = array_pop($trace)) {
if (!empty($func['class'])) {
- if (in_array($previous['function'], ['insert', 'fetch', 'toArray', 'exists', 'count', 'selectFirst', 'selectToArray',
+ if (!$full && in_array($previous['function'], ['insert', 'fetch', 'toArray', 'exists', 'count', 'selectFirst', 'selectToArray',
'select', 'update', 'delete', 'selectFirstForUser', 'selectForUser'])
&& (substr($previous['class'], 0, 15) === 'Friendica\Model')) {
continue;
// Don't show multiple calls from the Database classes to show the essential parts of the callstack
$func['database'] = in_array($func['class'], ['Friendica\Database\DBA', 'Friendica\Database\Database']);
- if (!$previous['database'] || !$func['database']) {
+ if ($full || !$previous['database'] || !$func['database']) {
$classparts = explode("\\", $func['class']);
- $callstack[] = array_pop($classparts).'::'.$func['function'];
+ $callstack[] = array_pop($classparts).'::'.$func['function'] . (isset($func['line']) ? ' (' . $func['line'] . ')' : '');
$previous = $func;
}
} elseif (!in_array($func['function'], $ignore)) {
$func['database'] = ($func['function'] == 'q');
- $callstack[] = $func['function'];
+ $callstack[] = $func['function'] . (isset($func['line']) ? ' (' . $func['line'] . ')' : '');
$func['class'] = '';
$previous = $func;
}
return implode(', ', $callstack2);
}
+ /**
+ * Display current response, including setting all headers
+ *
+ * @param ResponseInterface $response
+ */
+ public static function echoResponse(ResponseInterface $response)
+ {
+ header(sprintf("HTTP/%s %s %s",
+ $response->getProtocolVersion(),
+ $response->getStatusCode(),
+ $response->getReasonPhrase())
+ );
+
+ foreach ($response->getHeaders() as $key => $header) {
+ if (is_array($header)) {
+ $header_str = implode(',', $header);
+ } else {
+ $header_str = $header;
+ }
+
+ if (is_int($key)) {
+ header($header_str);
+ } else {
+ header("$key: $header_str");
+ }
+ }
+
+ echo $response->getBody();
+ }
+
/**
* 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.
*
- * @param $st
+ * @param mixed $status
* @param string $message
* @throws \Exception
+ * @deprecated since 2023.09 Use BaseModule->httpExit() instead
*/
- public static function xmlExit($st, $message = '')
+ public static function xmlExit($status, string $message = '')
{
- $result = ['status' => $st];
+ $result = ['status' => $status];
if ($message != '') {
$result['message'] = $message;
}
- if ($st) {
- Logger::notice('xml_status returning non_zero: ' . $st . " message=" . $message);
+ if ($status) {
+ Logger::notice('xml_status returning non_zero: ' . $status . " message=" . $message);
}
- header("Content-type: text/xml");
-
- $xmldata = ["result" => $result];
-
- echo XML::fromArray($xmldata, $xml);
-
- exit();
+ self::httpExit(XML::fromArray(['result' => $result]), Response::TYPE_XML);
}
/**
* @param string $message Error message. Optional.
* @param string $content Response body. Optional.
* @throws \Exception
+ * @deprecated since 2023.09 Use BaseModule->httpError instead
*/
- public static function httpExit($val, $message = '', $content = '')
+ public static function httpError($httpCode, $message = '', $content = '')
{
- if ($val >= 400) {
- Logger::debug('Exit with error', ['code' => $val, 'message' => $message, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
+ if ($httpCode >= 400) {
+ Logger::debug('Exit with error', ['code' => $httpCode, 'message' => $message, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
}
- header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $message);
- DI::page()->exit(DI::apiResponse()->generate());
- echo $content;
+ DI::apiResponse()->setStatus($httpCode, $message);
- exit();
+ self::httpExit($content);
}
- public static function jsonError($httpCode, $data, $content_type = 'application/json')
+ /**
+ * This function adds the content and a content-type HTTP header to the output.
+ * After finishing the process is getting killed.
+ *
+ * @param string $content
+ * @param string $type
+ * @param string|null $content_type
+ * @return void
+ * @throws InternalServerErrorException
+ * @deprecated since 2023.09 Use BaseModule->httpExit() instead
+ */
+ public static function httpExit(string $content, string $type = Response::TYPE_HTML, ?string $content_type = null)
+ {
+ DI::apiResponse()->setType($type, $content_type);
+ DI::apiResponse()->addContent($content);
+ self::echoResponse(DI::apiResponse()->generate());
+
+ self::exit();
+ }
+
+ /**
+ * @deprecated since 2023.09 Use BaseModule->jsonError instead
+ */
+ public static function jsonError($httpCode, $content, $content_type = 'application/json')
{
if ($httpCode >= 400) {
Logger::debug('Exit with error', ['code' => $httpCode, 'content_type' => $content_type, 'callstack' => System::callstack(20), 'method' => DI::args()->getMethod(), 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '']);
}
- header($_SERVER["SERVER_PROTOCOL"] . ' ' . $httpCode);
- self::jsonExit($data, $content_type);
+ DI::apiResponse()->setStatus($httpCode);
+ self::jsonExit($content, $content_type);
}
/**
* and adds an application/json HTTP header to the output.
* After finishing the process is getting killed.
*
- * @param mixed $x The input content.
- * @param string $content_type Type of the input (Default: 'application/json').
- * @param integer $options JSON options
+ * @param mixed $content The input content
+ * @param string $content_type Type of the input (Default: 'application/json')
+ * @param integer $options JSON options
+ * @throws InternalServerErrorException
+ * @deprecated since 2023.09 Use BaseModule->jsonExit instead
+ */
+ public static function jsonExit($content, string $content_type = 'application/json', int $options = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT)
+ {
+ self::httpExit(json_encode($content, $options), Response::TYPE_JSON, $content_type);
+ }
+
+ /**
+ * Exit the program execution.
*/
- public static function jsonExit($x, $content_type = 'application/json', int $options = 0) {
- DI::page()->exit(DI::apiResponse()->generate());
- header("Content-type: $content_type");
- echo json_encode($x, $options);
+ public static function exit()
+ {
+ DI::page()->logRuntime(DI::config(), 'exit');
exit();
}
if (is_bool($prefix) && !$prefix) {
$prefix = '';
} elseif (empty($prefix)) {
- $prefix = hash('crc32', DI::baseUrl()->getHostname());
+ $prefix = hash('crc32', DI::baseUrl()->getHost());
}
while (strlen($prefix) < ($size - 13)) {
return max($load_arr[0], $load_arr[1]);
}
+ /**
+ * Fetch the load and number of processes
+ *
+ * @param bool $get_processes
+ * @return array
+ */
+ public static function getLoadAvg(bool $get_processes = true): array
+ {
+ $load_arr = sys_getloadavg();
+ if (empty($load_arr)) {
+ return [];
+ }
+
+ $load = [
+ 'average1' => $load_arr[0],
+ 'average5' => $load_arr[1],
+ 'average15' => $load_arr[2],
+ 'runnable' => 0,
+ 'scheduled' => 0
+ ];
+
+ if ($get_processes && @is_readable('/proc/loadavg')) {
+ $content = @file_get_contents('/proc/loadavg');
+ if (!empty($content) && preg_match("#([.\d]+)\s([.\d]+)\s([.\d]+)\s(\d+)/(\d+)#", $content, $matches)) {
+ $load['runnable'] = (float)$matches[4];
+ $load['scheduled'] = (float)$matches[5];
+ }
+ }
+
+ return $load;
+ }
+
/**
* Redirects to an external URL (fully qualified URL)
* If you want to route relative to the current Friendica base, use App->internalRedirect()
*
* @param string $url The new Location to redirect
* @param int $code The redirection code, which is used (Default is 302)
+ *
+ * @throws FoundException
+ * @throws MovedPermanentlyException
+ * @throws TemporaryRedirectException
+ *
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function externalRedirect($url, $code = 302)
{
case 307:
throw new TemporaryRedirectException();
}
-
- exit();
+ self::exit();
}
/**
* Checks if a given directory is usable for the system
*
* @param $directory
- * @param bool $check_writable
*
* @return boolean the directory is usable
*/
- public static function isDirectoryUsable($directory, $check_writable = true)
+ private static function isDirectoryUsable(string $directory): bool
{
- if ($directory == '') {
- Logger::info('Directory is empty. This shouldn\'t happen.');
+ if (empty($directory)) {
+ Logger::warning('Directory is empty. This shouldn\'t happen.');
return false;
}
if (!file_exists($directory)) {
- Logger::info('Path "' . $directory . '" does not exist for user ' . static::getUser());
+ Logger::info('Path does not exist', ['directory' => $directory, 'user' => static::getUser()]);
return false;
}
if (is_file($directory)) {
- Logger::info('Path "' . $directory . '" is a file for user ' . static::getUser());
+ Logger::warning('Path is a file', ['directory' => $directory, 'user' => static::getUser()]);
return false;
}
if (!is_dir($directory)) {
- Logger::info('Path "' . $directory . '" is not a directory for user ' . static::getUser());
+ Logger::warning('Path is not a directory', ['directory' => $directory, 'user' => static::getUser()]);
return false;
}
- if ($check_writable && !is_writable($directory)) {
- Logger::info('Path "' . $directory . '" is not writable for user ' . static::getUser());
+ if (!is_writable($directory)) {
+ Logger::warning('Path is not writable', ['directory' => $directory, 'user' => static::getUser()]);
return false;
}
*/
public static function htmlUpdateExit($o)
{
- header("Content-type: text/html");
+ DI::apiResponse()->setType(Response::TYPE_HTML);
echo "<!DOCTYPE html><html><body>\r\n";
// We can remove this hack once Internet Explorer recognises HTML5 natively
echo "<section>";
echo str_replace("\t", " ", $o);
echo "</section>";
echo "</body></html>\r\n";
- exit();
+ self::exit();
}
/**
{
$temppath = DI::config()->get("system", "temppath");
- if (($temppath != "") && System::isDirectoryUsable($temppath)) {
+ if (($temppath != "") && self::isDirectoryUsable($temppath)) {
// We have a temp path and it is usable
return BasePath::getRealPath($temppath);
}
$temppath = sys_get_temp_dir();
// Check if it is usable
- if (($temppath != "") && System::isDirectoryUsable($temppath)) {
+ if (($temppath != "") && self::isDirectoryUsable($temppath)) {
// Always store the real path, not the path through symlinks
$temppath = BasePath::getRealPath($temppath);
// To avoid any interferences with other systems we create our own directory
- $new_temppath = $temppath . "/" . DI::baseUrl()->getHostname();
+ $new_temppath = $temppath . "/" . DI::baseUrl()->getHost();
if (!is_dir($new_temppath)) {
/// @TODO There is a mkdir()+chmod() upwards, maybe generalize this (+ configurable) into a function/method?
- mkdir($new_temppath);
+ @mkdir($new_temppath);
}
- if (System::isDirectoryUsable($new_temppath)) {
+ if (self::isDirectoryUsable($new_temppath)) {
// The new path is usable, we are happy
DI::config()->set("system", "temppath", $new_temppath);
return $new_temppath;
public static function getSpoolPath()
{
$spoolpath = DI::config()->get('system', 'spoolpath');
- if (($spoolpath != "") && System::isDirectoryUsable($spoolpath)) {
+ if (($spoolpath != "") && self::isDirectoryUsable($spoolpath)) {
// We have a spool path and it is usable
return $spoolpath;
}
mkdir($spoolpath);
}
- if (System::isDirectoryUsable($spoolpath)) {
+ if (self::isDirectoryUsable($spoolpath)) {
// The new path is usable, we are happy
DI::config()->set("system", "spoolpath", $spoolpath);
return $spoolpath;
// Reaching this point means that the operating system is configured badly.
return "";
}
+
+ /**
+ * Fetch the system rules
+ * @param bool $numeric_id If set to "true", the rules are returned with a numeric id as key.
+ *
+ * @return array
+ */
+ public static function getRules(bool $numeric_id = false): array
+ {
+ $rules = [];
+ $id = 0;
+
+ if (DI::config()->get('system', 'tosdisplay')) {
+ $rulelist = DI::config()->get('system', 'tosrules') ?: DI::config()->get('system', 'tostext');
+ $msg = BBCode::toPlaintext($rulelist, false);
+ foreach (explode("\n", trim($msg)) as $line) {
+ $line = trim($line);
+ if ($line) {
+ if ($numeric_id) {
+ $rules[++$id] = $line;
+ } else {
+ $rules[] = ['id' => (string)++$id, 'text' => $line];
+ }
+ }
+ }
+ }
+
+ return $rules;
+ }
}