2020-03-11 20:29:08 +00:00
|
|
|
<?php
|
2020-03-15 21:21:11 +00:00
|
|
|
|
2021-10-10 09:26:18 +01:00
|
|
|
declare(strict_types = 1);
|
|
|
|
|
2020-05-11 19:15:08 +01:00
|
|
|
// {{{ License
|
2020-08-05 17:20:08 +01:00
|
|
|
|
2020-05-11 19:15:08 +01:00
|
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
|
|
//
|
|
|
|
// GNU social is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// GNU social 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 Affero General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
|
|
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
|
2020-08-05 17:20:08 +01:00
|
|
|
|
2020-05-11 19:15:08 +01:00
|
|
|
// }}}
|
2020-03-21 20:18:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Common utility functions
|
|
|
|
*
|
|
|
|
* @package GNUsocial
|
|
|
|
* @category Util
|
|
|
|
*
|
2021-02-19 23:29:43 +00:00
|
|
|
* @author Hugo Sales <hugo@hsal.es>
|
|
|
|
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
|
2020-03-21 20:18:05 +00:00
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
|
|
|
*/
|
2020-03-11 20:29:08 +00:00
|
|
|
|
|
|
|
namespace App\Util;
|
|
|
|
|
2020-08-14 16:43:06 +01:00
|
|
|
use App\Core\Router\Router;
|
2020-07-24 00:33:00 +01:00
|
|
|
use App\Core\Security;
|
2021-09-18 03:22:27 +01:00
|
|
|
use App\Entity\Actor;
|
2020-08-08 17:10:25 +01:00
|
|
|
use App\Entity\LocalUser;
|
2020-09-04 19:46:12 +01:00
|
|
|
use App\Util\Exception\NoLoggedInUser;
|
2021-11-14 23:15:24 +00:00
|
|
|
use Egulias\EmailValidator\EmailValidator;
|
|
|
|
use Egulias\EmailValidator\Validation\RFCValidation as RFCEmailValidation;
|
2020-07-30 23:48:24 +01:00
|
|
|
use Functional as F;
|
2020-09-22 23:13:36 +01:00
|
|
|
use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
|
2021-05-12 16:45:00 +01:00
|
|
|
use Symfony\Component\HttpFoundation\Request;
|
2021-04-10 01:27:19 +01:00
|
|
|
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
|
2020-09-30 23:57:25 +01:00
|
|
|
use Symfony\Component\Yaml;
|
2020-05-13 13:10:24 +01:00
|
|
|
|
2020-03-13 22:31:56 +00:00
|
|
|
abstract class Common
|
2020-03-11 20:29:08 +00:00
|
|
|
{
|
2020-09-30 23:57:25 +01:00
|
|
|
private static array $defaults;
|
2020-09-22 23:13:36 +01:00
|
|
|
private static ?array $config = null;
|
2020-09-30 23:57:25 +01:00
|
|
|
public static function setupConfig(ContainerBagInterface $config)
|
2020-09-22 23:13:36 +01:00
|
|
|
{
|
2021-08-21 22:30:24 +01:00
|
|
|
$components = $config->has('components') ? $config->get('components') : [];
|
|
|
|
$plugins = $config->has('plugins') ? $config->get('plugins') : [];
|
2021-08-22 12:57:37 +01:00
|
|
|
self::$config = array_merge_recursive($config->get('gnusocial'), ['components' => $components], ['plugins' => $plugins]);
|
2020-09-30 23:57:25 +01:00
|
|
|
self::$defaults = $config->get('gnusocial_defaults');
|
2020-09-22 23:13:36 +01:00
|
|
|
}
|
|
|
|
|
2021-05-12 16:45:00 +01:00
|
|
|
private static ?Request $request = null;
|
|
|
|
public static function setRequest(Request $req)
|
|
|
|
{
|
|
|
|
self::$request = $req;
|
|
|
|
}
|
|
|
|
|
|
|
|
public static function route()
|
|
|
|
{
|
|
|
|
return self::$request->attributes->get('_route');
|
|
|
|
}
|
|
|
|
|
2021-10-10 09:26:18 +01:00
|
|
|
public static function isRoute(string|array $routes)
|
2021-05-12 16:45:00 +01:00
|
|
|
{
|
2021-10-10 09:26:18 +01:00
|
|
|
return \in_array(self::route(), \is_array($routes) ? $routes : [$routes]);
|
2021-05-12 16:45:00 +01:00
|
|
|
}
|
|
|
|
|
2020-05-10 21:43:15 +01:00
|
|
|
/**
|
|
|
|
* Access sysadmin's configuration preferences for GNU social
|
2021-10-18 12:29:52 +01:00
|
|
|
* Returns value if exists, null if not set
|
2020-05-10 21:43:15 +01:00
|
|
|
*/
|
2021-08-12 00:38:18 +01:00
|
|
|
public static function config(string $section, ?string $setting = null)
|
2020-03-13 22:31:56 +00:00
|
|
|
{
|
2021-11-01 19:43:23 +00:00
|
|
|
if (!\array_key_exists($section, self::$config)) {
|
2021-10-18 12:29:52 +01:00
|
|
|
return null;
|
2021-08-12 00:38:18 +01:00
|
|
|
} else {
|
2021-10-18 12:29:52 +01:00
|
|
|
if ($setting !== null) {
|
2021-11-01 19:43:23 +00:00
|
|
|
if (\array_key_exists($setting, self::$config[$section])) {
|
2021-10-18 12:29:52 +01:00
|
|
|
return self::$config[$section][$setting];
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
return self::$config[$section];
|
|
|
|
}
|
2021-08-12 00:38:18 +01:00
|
|
|
}
|
2020-03-13 22:31:56 +00:00
|
|
|
}
|
2020-05-15 16:24:24 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set sysadmin's configuration preferences for GNU social
|
2021-11-16 14:10:19 +00:00
|
|
|
*
|
2021-11-25 23:08:30 +00:00
|
|
|
* @param bool $transient keep this setting in memory only
|
2020-05-15 16:24:24 +01:00
|
|
|
*/
|
2021-11-16 14:10:19 +00:00
|
|
|
public static function setConfig(string $section, string $setting, $value, bool $transient = false): void
|
2020-05-15 16:24:24 +01:00
|
|
|
{
|
2020-09-30 23:57:25 +01:00
|
|
|
self::$config[$section][$setting] = $value;
|
2021-11-16 14:10:19 +00:00
|
|
|
if (!$transient) {
|
|
|
|
$diff = self::arrayDiffRecursive(self::$config, self::$defaults);
|
|
|
|
$yaml = (new Yaml\Dumper(indentation: 2))->dump(['parameters' => ['locals' => ['gnusocial' => $diff]]], Yaml\Yaml::DUMP_OBJECT_AS_MAP);
|
|
|
|
rename(INSTALLDIR . '/social.local.yaml', INSTALLDIR . '/social.local.yaml.back');
|
|
|
|
file_put_contents(INSTALLDIR . '/social.local.yaml', $yaml);
|
|
|
|
}
|
2020-09-30 23:57:25 +01:00
|
|
|
}
|
2020-07-25 15:42:00 +01:00
|
|
|
|
2020-09-30 23:57:25 +01:00
|
|
|
public static function getConfigDefaults()
|
|
|
|
{
|
|
|
|
return self::$defaults;
|
2020-05-15 16:24:24 +01:00
|
|
|
}
|
2020-05-16 21:42:31 +01:00
|
|
|
|
2020-08-09 13:44:47 +01:00
|
|
|
public static function user(): ?LocalUser
|
2020-07-24 00:33:00 +01:00
|
|
|
{
|
2021-09-09 01:08:45 +01:00
|
|
|
// This returns the user stored in the session. We only use
|
|
|
|
// LocalUser, but this is more generic and returns
|
|
|
|
// UserInterface, so we need a type cast
|
|
|
|
/** @var LocalUser */
|
2020-07-24 00:33:00 +01:00
|
|
|
return Security::getUser();
|
|
|
|
}
|
|
|
|
|
2021-09-18 03:22:27 +01:00
|
|
|
public static function actor(): ?Actor
|
2020-08-08 17:10:25 +01:00
|
|
|
{
|
2021-09-18 07:27:17 +01:00
|
|
|
return self::user()?->getActor();
|
2020-08-08 17:10:25 +01:00
|
|
|
}
|
|
|
|
|
2020-11-06 19:47:15 +00:00
|
|
|
public static function userNickname(): ?string
|
|
|
|
{
|
2021-04-11 19:32:28 +01:00
|
|
|
return self::ensureLoggedIn()->getNickname();
|
2020-11-06 19:47:15 +00:00
|
|
|
}
|
|
|
|
|
2021-05-02 21:42:25 +01:00
|
|
|
public static function userId(): ?int
|
2021-04-18 02:17:57 +01:00
|
|
|
{
|
|
|
|
return self::ensureLoggedIn()->getId();
|
|
|
|
}
|
|
|
|
|
2020-08-28 21:16:26 +01:00
|
|
|
public static function ensureLoggedIn(): LocalUser
|
|
|
|
{
|
|
|
|
if (($user = self::user()) == null) {
|
|
|
|
throw new NoLoggedInUser();
|
|
|
|
// TODO Maybe redirect to login page and back
|
|
|
|
} else {
|
|
|
|
return $user;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-11-23 15:06:23 +00:00
|
|
|
/**
|
|
|
|
* checks if user is logged in
|
|
|
|
*
|
|
|
|
* @return bool true if user is logged; false if it isn't
|
|
|
|
*/
|
2020-11-22 02:36:01 +00:00
|
|
|
public static function isLoggedIn(): bool
|
|
|
|
{
|
2021-10-10 09:26:18 +01:00
|
|
|
return self::user() != null;
|
2020-11-22 02:36:01 +00:00
|
|
|
}
|
|
|
|
|
2020-07-21 22:35:10 +01:00
|
|
|
/**
|
|
|
|
* Is the given string identical to a system path or route?
|
|
|
|
* This could probably be put in some other class, but at
|
|
|
|
* at the moment, only Nickname requires this functionality.
|
|
|
|
*/
|
|
|
|
public static function isSystemPath(string $str): bool
|
|
|
|
{
|
2020-08-14 01:19:26 +01:00
|
|
|
try {
|
2021-09-15 16:36:14 +01:00
|
|
|
$route = Router::match('/' . $str);
|
|
|
|
return $route['is_system_path'] ?? true;
|
2021-04-10 01:27:19 +01:00
|
|
|
} catch (ResourceNotFoundException $e) {
|
2020-08-14 01:19:26 +01:00
|
|
|
return false;
|
|
|
|
}
|
2020-07-21 22:35:10 +01:00
|
|
|
}
|
|
|
|
|
2020-11-06 19:47:15 +00:00
|
|
|
/**
|
|
|
|
* A recursive `array_diff`, while PHP itself doesn't provide one
|
|
|
|
*/
|
2021-04-10 22:57:00 +01:00
|
|
|
public static function arrayDiffRecursive($array1, $array2): array
|
2020-09-30 23:57:25 +01:00
|
|
|
{
|
2021-04-10 01:27:19 +01:00
|
|
|
$diff = [];
|
2020-09-30 23:57:25 +01:00
|
|
|
foreach ($array1 as $key => $value) {
|
2021-10-10 09:26:18 +01:00
|
|
|
if (\array_key_exists($key, $array2)) {
|
|
|
|
if (\is_array($value)) {
|
2021-04-10 22:57:00 +01:00
|
|
|
$recursive_diff = static::arrayDiffRecursive($value, $array2[$key]);
|
2021-10-10 09:26:18 +01:00
|
|
|
if (\count($recursive_diff)) {
|
2021-04-10 01:27:19 +01:00
|
|
|
$diff[$key] = $recursive_diff;
|
|
|
|
}
|
2020-09-30 23:57:25 +01:00
|
|
|
} else {
|
2021-04-10 01:27:19 +01:00
|
|
|
if ($value != $array2[$key]) {
|
|
|
|
$diff[$key] = $value;
|
2020-09-30 23:57:25 +01:00
|
|
|
}
|
|
|
|
}
|
2021-04-10 01:27:19 +01:00
|
|
|
} else {
|
|
|
|
$diff[$key] = $value;
|
2020-09-30 23:57:25 +01:00
|
|
|
}
|
|
|
|
}
|
2021-04-10 01:27:19 +01:00
|
|
|
return $diff;
|
2020-09-30 23:57:25 +01:00
|
|
|
}
|
|
|
|
|
2020-07-30 23:48:24 +01:00
|
|
|
/**
|
|
|
|
* Remove keys from the _values_ of $keys from the array $from
|
|
|
|
*/
|
2020-08-05 17:20:08 +01:00
|
|
|
public static function arrayRemoveKeys(array $from, array $keys, bool $strict = false)
|
2020-07-30 23:48:24 +01:00
|
|
|
{
|
2021-10-10 09:26:18 +01:00
|
|
|
return F\filter($from, fn ($_, $key) => !\in_array($key, $keys, $strict));
|
2020-07-30 23:48:24 +01:00
|
|
|
}
|
|
|
|
|
2020-05-16 21:42:31 +01:00
|
|
|
/**
|
|
|
|
* An internal helper function that converts a $size from php.ini for
|
|
|
|
* file size limit from the 'human-readable' shorthand into a int. If
|
|
|
|
* $size is empty (the value is not set in php.ini), returns a default
|
2020-06-23 22:22:27 +01:00
|
|
|
* value (3M)
|
2020-06-04 22:00:05 +01:00
|
|
|
*
|
2020-05-16 21:42:31 +01:00
|
|
|
* @return int the php.ini upload limit in machine-readable format
|
|
|
|
*/
|
2020-07-21 22:35:10 +01:00
|
|
|
public static function sizeStrToInt(string $size): int
|
2020-05-16 21:42:31 +01:00
|
|
|
{
|
|
|
|
// `memory_limit` can be -1 and `post_max_size` can be 0
|
|
|
|
// for unlimited. Consistency.
|
|
|
|
if (empty($size) || $size === '-1' || $size === '0') {
|
|
|
|
$size = '3M';
|
|
|
|
}
|
|
|
|
|
2021-10-10 09:26:18 +01:00
|
|
|
$suffix = mb_substr($size, -1);
|
|
|
|
$size = (int) mb_substr($size, 0, -1);
|
|
|
|
switch (mb_strtoupper($suffix)) {
|
2020-05-16 21:42:31 +01:00
|
|
|
case 'P':
|
|
|
|
$size *= 1024;
|
|
|
|
// no break
|
|
|
|
case 'T':
|
|
|
|
$size *= 1024;
|
|
|
|
// no break
|
|
|
|
case 'G':
|
|
|
|
$size *= 1024;
|
|
|
|
// no break
|
|
|
|
case 'M':
|
|
|
|
$size *= 1024;
|
|
|
|
// no break
|
|
|
|
case 'K':
|
|
|
|
$size *= 1024;
|
|
|
|
break;
|
2021-04-10 22:57:00 +01:00
|
|
|
default:
|
|
|
|
if ($suffix >= '0' && $suffix <= '9') {
|
|
|
|
$size = (int) "{$size}{$suffix}";
|
|
|
|
}
|
2020-05-16 21:42:31 +01:00
|
|
|
}
|
|
|
|
return $size;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Uses `size_str_to_int()` to find the smallest value for uploads in php.ini
|
|
|
|
*/
|
2020-07-21 22:35:10 +01:00
|
|
|
public static function getPreferredPhpUploadLimit(): int
|
2020-05-16 21:42:31 +01:00
|
|
|
{
|
|
|
|
return min(
|
2020-07-21 22:35:10 +01:00
|
|
|
self::sizeStrToInt(ini_get('post_max_size')),
|
|
|
|
self::sizeStrToInt(ini_get('upload_max_filesize')),
|
2021-10-10 09:26:18 +01:00
|
|
|
self::sizeStrToInt(ini_get('memory_limit')),
|
2020-05-16 21:42:31 +01:00
|
|
|
);
|
|
|
|
}
|
2020-11-09 21:25:57 +00:00
|
|
|
|
2021-10-21 14:54:32 +01:00
|
|
|
/**
|
|
|
|
* Uses common config 'attachments' 'file_quota' while respecting PreferredPhpUploadLimit
|
|
|
|
*/
|
|
|
|
public static function getUploadLimit(): int
|
|
|
|
{
|
|
|
|
return min(
|
|
|
|
self::getPreferredPhpUploadLimit(),
|
2021-11-01 19:43:23 +00:00
|
|
|
self::config('attachments', 'file_quota'),
|
2021-10-21 14:54:32 +01:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2020-11-09 21:25:57 +00:00
|
|
|
/**
|
|
|
|
* Clamps a value between 2 numbers
|
|
|
|
*
|
2021-04-10 01:27:19 +01:00
|
|
|
* @return float|int clamped value
|
2020-11-09 21:25:57 +00:00
|
|
|
*/
|
2021-10-10 09:26:18 +01:00
|
|
|
public static function clamp(int|float $value, int|float $min, int|float $max): int|float
|
2020-11-09 21:25:57 +00:00
|
|
|
{
|
2021-04-10 01:27:19 +01:00
|
|
|
return min(max($value, $min), $max);
|
2020-11-09 21:25:57 +00:00
|
|
|
}
|
2021-04-25 22:17:01 +01:00
|
|
|
|
|
|
|
/**
|
2021-04-27 21:52:12 +01:00
|
|
|
* If $ensure_secure is true, only allow https URLs to pass
|
2021-04-25 22:17:01 +01:00
|
|
|
*/
|
2021-04-27 21:52:12 +01:00
|
|
|
public static function isValidHttpUrl(string $url, bool $ensure_secure = false)
|
2021-04-25 22:17:01 +01:00
|
|
|
{
|
|
|
|
if (empty($url)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// (if false, we use '?' in 'https?' to say the 's' is optional)
|
2021-04-27 21:52:12 +01:00
|
|
|
$regex = $ensure_secure ? '/^https$/' : '/^https?$/';
|
2021-11-01 12:16:29 +00:00
|
|
|
return filter_var($url, \FILTER_VALIDATE_URL) !== false
|
2021-10-10 09:26:18 +01:00
|
|
|
&& preg_match($regex, parse_url($url, \PHP_URL_SCHEME));
|
2021-04-25 22:17:01 +01:00
|
|
|
}
|
2021-05-23 20:58:15 +01:00
|
|
|
|
2021-11-14 23:15:24 +00:00
|
|
|
public static function isValidEmail(string $email): bool
|
|
|
|
{
|
|
|
|
return (new EmailValidator())->isValid($email, new RFCEmailValidation());
|
|
|
|
}
|
|
|
|
|
2021-05-23 20:58:15 +01:00
|
|
|
/**
|
|
|
|
* Flatten an array of ['note' => note, 'replies' => [notes]] to an array of notes
|
|
|
|
*/
|
|
|
|
public static function flattenNoteArray(array $a): array
|
|
|
|
{
|
|
|
|
$notes = [];
|
|
|
|
foreach ($a as $n) {
|
|
|
|
$notes[] = $n['note'];
|
|
|
|
if (isset($n['replies'])) {
|
|
|
|
$notes = array_merge($notes, static::flattenNoteArray($n['replies']));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $notes;
|
|
|
|
}
|
2020-03-11 20:29:08 +00:00
|
|
|
}
|