gnu-social/src/Util/Common.php

241 lines
7.1 KiB
PHP
Raw Normal View History

<?php
// {{{ License
2020-08-05 17:20: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
// }}}
/**
* Common utility functions
*
* @package GNUsocial
* @category Util
*
* @author Hugo Sales <hugo@hsal.es>
* @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
namespace App\Util;
2020-08-14 16:43:06 +01:00
use App\Core\Router\Router;
use App\Core\Security;
use App\Entity\GSActor;
use App\Entity\LocalUser;
use App\Util\Exception\NoLoggedInUser;
use Exception;
2020-07-30 23:48:24 +01:00
use Functional as F;
use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
use Symfony\Component\Yaml;
abstract class Common
{
private static array $defaults;
private static ?array $config = null;
public static function setupConfig(ContainerBagInterface $config)
{
self::$config = $config->get('gnusocial');
self::$defaults = $config->get('gnusocial_defaults');
}
/**
* Access sysadmin's configuration preferences for GNU social
*/
public static function config(string $section, string $setting)
{
return self::$config[$section][$setting];
}
/**
* Set sysadmin's configuration preferences for GNU social
*
* @param mixed $value
*/
public static function setConfig(string $section, string $setting, $value): void
{
self::$config[$section][$setting] = $value;
$diff = self::array_diff_recursive(self::$config, self::$defaults);
$yaml = (new Yaml\Dumper(2))->dump(['parameters' => ['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);
}
public static function getConfigDefaults()
{
return self::$defaults;
}
public static function user(): ?LocalUser
{
return Security::getUser();
}
public static function actor(): ?GSActor
{
return self::user()->getActor();
}
public static function userNickname(): ?string
{
if (($user = self::user()) == null) {
throw new NoLoggedInUser();
} else {
return $user->getNickname();
}
}
public function getAllNotes(int $noteScope): array
{
return DB::sql('select * from note n ' .
"where n.reply_to is null and (n.scope & {$noteScope}) <> 0 " .
'order by n.created DESC',
['n' => 'App\Entity\Note']);
}
public static function ensureLoggedIn(): LocalUser
{
if (($user = self::user()) == null) {
throw new NoLoggedInUser();
// TODO Maybe redirect to login page and back
} else {
return $user;
}
}
/**
* checks if user is logged in
*
* @return bool true if user is logged; false if it isn't
*/
public static function isLoggedIn(): bool
{
return self::user() != null;
}
/**
* 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
{
try {
Router::match('/' . $str);
return true;
} catch (Exception $e) {
return false;
}
}
/**
* A recursive `array_diff`, while PHP itself doesn't provide one
*/
public function array_diff_recursive(array $array1, array $array2)
{
$difference = [];
foreach ($array1 as $key => $value) {
if (is_array($value)) {
if (!isset($array2[$key]) || !is_array($array2[$key])) {
$difference[$key] = $value;
} else {
$new_diff = self::array_diff_recursive($value, $array2[$key]);
if (!empty($new_diff)) {
$difference[$key] = $new_diff;
}
}
} elseif ((!isset($array2[$key]) || $array2[$key] != $value) && !($array2[$key] === null && $value === null)) {
$difference[$key] = $value;
}
}
return $difference ?? false;
}
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
{
2020-08-05 17:20:08 +01:00
return F\filter($from, function ($_, $key) use ($keys, $strict) { return !in_array($key, $keys, $strict); });
2020-07-30 23:48:24 +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
* value (3M)
2020-06-04 22:00:05 +01:00
*
* @return int the php.ini upload limit in machine-readable format
*/
public static function sizeStrToInt(string $size): int
{
// `memory_limit` can be -1 and `post_max_size` can be 0
// for unlimited. Consistency.
if (empty($size) || $size === '-1' || $size === '0') {
$size = '3M';
}
$suffix = substr($size, -1);
$size = (int) substr($size, 0, -1);
switch (strtoupper($suffix)) {
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;
}
return $size;
}
/**
* Uses `size_str_to_int()` to find the smallest value for uploads in php.ini
*
* @return int
*/
public static function getPreferredPhpUploadLimit(): int
{
return min(
self::sizeStrToInt(ini_get('post_max_size')),
self::sizeStrToInt(ini_get('upload_max_filesize')),
self::sizeStrToInt(ini_get('memory_limit'))
);
}
/**
* Clamps a value between 2 numbers
*
* @param int $current
* @param int $min
* @param int $max
*
* @return int clamped value
*/
public static function clamp(int $current,int $min,int $max): int
{
return min(max($current,$min),$max);
}
}