GNUsocial
/
gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[FileQuota] Update plugin to respect the new entities

This commit is contained in:
Diogo Peralta Cordeiro 2021-08-19 19:18:10 +01:00 committed by Hugo Sales
parent 2b457655ea
commit ab142ab52d
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
2 changed files with 59 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/Posting/Posting.php
View File

@ -26,6 +26,7 @@ use App\Core\DB\DB;
use App\Core\Event;
use App\Core\Form;
use App\Core\GSFile;
use App\Util\Exception\ClientException;
use function App\Core\I18n\_m;
use App\Core\Modules\Component;
use App\Entity\Attachment;
@ -119,7 +120,12 @@ END;
$processed_attachments = [];
foreach ($attachments as $f) { // where $f is a Symfony\Component\HttpFoundation\File\UploadedFile
$filesize = $f->getSize();
Event::handle('EnforceQuota', [$actor_id, $filesize]);
$max_file_size = Common::config('attachments', 'file_quota');
if ($max_file_size < $filesize) {
throw new ClientException(_m('No file may be larger than {quota} bytes and the file you sent was {size} bytes. ' .
'Try to upload a smaller version.', ['quota' => $max_file_size, 'size' => $filesize]));
}
Event::handle('EnforceUserFileQuota', [$filesize, $actor_id]);
$processed_attachments[] = [GSFile::sanitizeAndStoreFileAsAttachment($f), $f->getClientOriginalName()];
}

77
plugins/FileQuota/FileQuota.php
View File

@ -24,9 +24,11 @@ namespace Plugin\FileQuota;
use App\Core\Cache;
use App\Core\DB\DB;
use App\Core\Event;
use function App\Core\I18n\_m;
use App\Core\Modules\Plugin;
use App\Util\Common;
use App\Util\Exception\ClientException;
use App\Util\Exception\ServerException;
/**
* Check attachment file size quotas
@ -34,55 +36,57 @@ use App\Util\Exception\ClientException;
* @package GNUsocial
* @ccategory Attachment
*
* @authir Hugo Sales <hugo@hsal.es>
*
* @author Hugo Sales <hugo@hsal.es>
* @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class FileQuota extends Plugin
{
public function version(): string
{
return '1.0.0';
}
/**
* Check file size to ensure it repects configured file size
* Check file size to ensure it respects configured file size
* quotas. Handles per file, per user and per user-month quotas.
* Throws on quota violations
*
* @param int $filesize
* @param int $user_id
*
* @throws ClientException
* @throws ServerException
*
* @return bool
*/
public function onEnforceQuota(int $user_id, int $filesize): bool
public function onEnforceUserFileQuota(int $filesize, int $user_id): bool
{
return Event::stop;
/*
$file_quota = Common::config('attachments', 'file_quota');
if ($filesize > $file_quota) {
// TRANS: Message given if an upload is larger than the configured maximum.
throw new ClientException(_m('No file may be larger than {quota} bytes and the file you sent was {size} bytes. ' .
'Try to upload a smaller version.', ['quota' => $file_quota, 'size' => $filesize]));
}
$query = <<<END
select sum(at.size) as total
from attachment at
join attachment_to_note an with at.id = an.attachment_id
join note n with an.note_id = n.id
where n.gsactor_id = :actor_id and at.size is not null
join gsactor_to_attachment ua with at.id = ua.attachment_id
where ua.gsactor_id = :actor_id and at.size is not null
END;
$user_quota = Common::config('attachments', 'user_quota');
if ($user_quota != false) {
$cache_key_user_total = 'user-' . $user_id . 'file-quota';
$max_user_quota = Common::config('attachments', 'user_quota');
if ($max_user_quota !== false) { // If not disabled
$cache_key_user_total = "FileQuota-total-user-{$user_id}";
$user_total = Cache::get($cache_key_user_total, fn () => DB::dql($query, ['actor_id' => $user_id])[0]['total']);
Cache::set($cache_key_user_total, $user_total + $filesize);
if ($user_total + $filesize > $user_quota) {
if ($user_total + $filesize > $max_user_quota) {
// TRANS: Message given if an upload would exceed user quota.
throw new ClientException(_m('A file this large would exceed your user quota of {quota} bytes.', ['quota' => $user_quota]));
throw new ClientException(_m('A file this large would exceed your user quota of {quota} bytes.', ['quota' => $max_user_quota]));
}
}
$query .= ' AND MONTH(at.modified) = MONTH(CURRENT_DATE())'
. ' AND YEAR(at.modified) = YEAR(CURRENT_DATE())';
. ' AND YEAR(at.modified) = YEAR(CURRENT_DATE())';
$monthly_quota = Common::config('attachments', 'monthly_quota');
if ($monthly_quota != false) {
$cache_key_user_monthly = 'user-' . $user_id . 'monthly-file-quota';
if ($monthly_quota !== false) { // If not disabled
$cache_key_user_monthly = "FileQuota-monthly-user-{$user_id}";
$monthly_total = Cache::get($cache_key_user_monthly, fn () => DB::dql($query, ['actor_id' => $user_id])[0]['total']);
Cache::set($cache_key_user_monthly, $monthly_total + $filesize);
@ -90,6 +94,29 @@ END;
// TRANS: Message given if an upload would exceed user quota.
throw new ClientException(_m('A file this large would exceed your monthly quota of {quota} bytes.', ['quota' => $monthly_quota]));
}
}*/
}
return Event::next;
}
/**
* Event raised when GNU social polls the plugin for information about it.
* Adds this plugin's version information to $versions array
*
* @param &$versions array inherited from parent
*
* @return bool true hook value
*/
public function onPluginVersion(array &$versions): bool
{
$versions[] = [
'name' => 'FileQuota',
'version' => $this->version(),
'author' => 'Hugo Sales',
'homepage' => GNUSOCIAL_PROJECT_URL,
'description' => // TRANS: Plugin description.
_m('Plugin to manage user quotas.'),
];
return Event::next;
}
}