3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
25 use Friendica\Network\HTTPException\InternalServerErrorException;
26 use Friendica\Util\XML;
29 * Contains the class with system relevant stuff
34 * Returns a string with a callstack. Can be used for logging.
36 * @param integer $depth optional, default 4
39 public static function callstack($depth = 4)
41 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
43 // We remove the first two items from the list since they contain data that we don't need.
48 $previous = ['class' => '', 'function' => ''];
50 // The ignore list contains all functions that are only wrapper functions
51 $ignore = ['fetchUrl', 'call_user_func_array'];
53 while ($func = array_pop($trace)) {
54 if (!empty($func['class'])) {
55 // Don't show multiple calls from the "dba" class to show the essential parts of the callstack
56 if ((($previous['class'] != $func['class']) || ($func['class'] != 'Friendica\Database\DBA')) && ($previous['function'] != 'q')) {
57 $classparts = explode("\\", $func['class']);
58 $callstack[] = array_pop($classparts).'::'.$func['function'];
61 } elseif (!in_array($func['function'], $ignore)) {
62 $callstack[] = $func['function'];
69 while ((count($callstack2) < $depth) && (count($callstack) > 0)) {
70 $callstack2[] = array_pop($callstack);
73 return implode(', ', $callstack2);
78 * Outputs a basic dfrn XML status structure to STDOUT, with a <status> variable
79 * of $st and an optional text <message> of $message and terminates the current process.
82 * @param string $message
85 public static function xmlExit($st, $message = '')
87 $result = ['status' => $st];
90 $result['message'] = $message;
94 Logger::log('xml_status returning non_zero: ' . $st . " message=" . $message);
97 header("Content-type: text/xml");
99 $xmldata = ["result" => $result];
101 echo XML::fromArray($xmldata, $xml);
107 * Send HTTP status header and exit.
109 * @param integer $val HTTP status result value
110 * @param string $message Error message. Optional.
111 * @param string $content Response body. Optional.
114 public static function httpExit($val, $message = '', $content = '')
116 Logger::log('http_status_exit ' . $val);
117 header($_SERVER["SERVER_PROTOCOL"] . ' ' . $val . ' ' . $message);
124 public static function jsonError($httpCode, $data, $content_type = 'application/json')
126 header($_SERVER["SERVER_PROTOCOL"] . ' ' . $httpCode);
127 self::jsonExit($data, $content_type);
131 * Encodes content to json.
133 * This function encodes an array to json format
134 * and adds an application/json HTTP header to the output.
135 * After finishing the process is getting killed.
137 * @param mixed $x The input content.
138 * @param string $content_type Type of the input (Default: 'application/json').
140 public static function jsonExit($x, $content_type = 'application/json') {
141 header("Content-type: $content_type");
142 echo json_encode($x);
147 * Generates a random string in the UUID format
149 * @param bool|string $prefix A given prefix (default is empty)
150 * @return string a generated UUID
153 public static function createUUID($prefix = '')
155 $guid = System::createGUID(32, $prefix);
156 return substr($guid, 0, 8) . '-' . substr($guid, 8, 4) . '-' . substr($guid, 12, 4) . '-' . substr($guid, 16, 4) . '-' . substr($guid, 20, 12);
160 * Generates a GUID with the given parameters
162 * @param int $size The size of the GUID (default is 16)
163 * @param bool|string $prefix A given prefix (default is empty)
164 * @return string a generated GUID
167 public static function createGUID($size = 16, $prefix = '')
169 if (is_bool($prefix) && !$prefix) {
171 } elseif (empty($prefix)) {
172 $prefix = hash('crc32', DI::baseUrl()->getHostname());
175 while (strlen($prefix) < ($size - 13)) {
176 $prefix .= mt_rand();
180 $prefix = substr($prefix, 0, $size - 22);
181 return str_replace('.', '', uniqid($prefix, true));
183 $prefix = substr($prefix, 0, max($size - 13, 0));
184 return uniqid($prefix);
189 * Returns the current Load of the System
193 public static function currentLoad()
195 if (!function_exists('sys_getloadavg')) {
199 $load_arr = sys_getloadavg();
201 if (!is_array($load_arr)) {
205 return max($load_arr[0], $load_arr[1]);
209 * Redirects to an external URL (fully qualified URL)
210 * If you want to route relative to the current Friendica base, use App->internalRedirect()
212 * @param string $url The new Location to redirect
213 * @param int $code The redirection code, which is used (Default is 302)
215 * @throws InternalServerErrorException If the URL is not fully qualified
217 public static function externalRedirect($url, $code = 302)
219 if (empty(parse_url($url, PHP_URL_SCHEME))) {
220 throw new InternalServerErrorException("'$url' is not a fully qualified URL, please use App->internalRedirect() instead");
225 // this is the default code for a REDIRECT
226 // We don't need a extra header here
229 header('HTTP/1.1 301 Moved Permanently');
232 header('HTTP/1.1 307 Temporary Redirect');
236 header("Location: $url");
241 * Returns the system user that is executing the script
243 * This mostly returns something like "www-data".
245 * @return string system username
247 public static function getUser()
249 if (!function_exists('posix_getpwuid') || !function_exists('posix_geteuid')) {
253 $processUser = posix_getpwuid(posix_geteuid());
254 return $processUser['name'];
258 * Checks if a given directory is usable for the system
261 * @param bool $check_writable
263 * @return boolean the directory is usable
265 public static function isDirectoryUsable($directory, $check_writable = true)
267 if ($directory == '') {
268 Logger::log('Directory is empty. This shouldn\'t happen.', Logger::DEBUG);
272 if (!file_exists($directory)) {
273 Logger::log('Path "' . $directory . '" does not exist for user ' . static::getUser(), Logger::DEBUG);
277 if (is_file($directory)) {
278 Logger::log('Path "' . $directory . '" is a file for user ' . static::getUser(), Logger::DEBUG);
282 if (!is_dir($directory)) {
283 Logger::log('Path "' . $directory . '" is not a directory for user ' . static::getUser(), Logger::DEBUG);
287 if ($check_writable && !is_writable($directory)) {
288 Logger::log('Path "' . $directory . '" is not writable for user ' . static::getUser(), Logger::DEBUG);
296 * Exit method used by asynchronous update modules
300 public static function htmlUpdateExit($o)
302 header("Content-type: text/html");
303 echo "<!DOCTYPE html><html><body>\r\n";
304 // We can remove this hack once Internet Explorer recognises HTML5 natively
306 // reportedly some versions of MSIE don't handle tabs in XMLHttpRequest documents very well
307 echo str_replace("\t", " ", $o);
309 echo "</body></html>\r\n";
313 /// @todo Move the following functions from boot.php
315 function local_user()
316 function public_contact()
317 function remote_user()
320 function is_site_admin()
321 function get_temppath()
322 function get_cachefile($file, $writemode = true)
323 function get_itemcachepath()
324 function get_spoolpath()