2020-08-03 21:51:45 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
// {{{ License
|
|
|
|
// 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/>.
|
|
|
|
// }}}
|
|
|
|
|
2021-04-15 00:30:35 +01:00
|
|
|
namespace App\Core\Modules;
|
2020-08-03 21:51:45 +01:00
|
|
|
|
2021-08-11 02:49:23 +01:00
|
|
|
use App\Core\Event;
|
|
|
|
use App\Core\Log;
|
2020-09-10 23:28:11 +01:00
|
|
|
use App\Entity\Note;
|
2020-09-21 20:09:11 +01:00
|
|
|
use App\Util\Common;
|
2021-08-11 02:49:23 +01:00
|
|
|
use App\Util\Exception\InvalidFormException;
|
|
|
|
use App\Util\Exception\NoSuchNoteException;
|
2020-09-10 23:28:11 +01:00
|
|
|
use Symfony\Component\Form\Form;
|
|
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
|
|
|
2020-11-06 19:47:15 +00:00
|
|
|
/**
|
|
|
|
* Base class for all GNU social modules (plugins and components)
|
|
|
|
*/
|
|
|
|
abstract class Module
|
2020-08-03 21:51:45 +01:00
|
|
|
{
|
2021-08-12 00:24:25 +01:00
|
|
|
public function __construct()
|
|
|
|
{
|
|
|
|
// Load Module settings
|
|
|
|
foreach (Common::config(static::class) as $aname => $avalue) {
|
|
|
|
$this->{$aname} = $avalue;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-11-06 19:47:15 +00:00
|
|
|
/**
|
|
|
|
* Serialize the class to store in the cache
|
|
|
|
*
|
|
|
|
* @param mixed $state
|
|
|
|
*/
|
2020-08-03 21:51:45 +01:00
|
|
|
public static function __set_state($state)
|
|
|
|
{
|
|
|
|
$class = get_called_class();
|
|
|
|
$obj = new $class();
|
|
|
|
foreach ($state as $k => $v) {
|
|
|
|
$obj->{$k} = $v;
|
|
|
|
}
|
|
|
|
return $obj;
|
|
|
|
}
|
2020-09-10 23:28:11 +01:00
|
|
|
|
2020-11-06 19:47:15 +00:00
|
|
|
/**
|
|
|
|
* Handle the $form submission for the note action for note if
|
|
|
|
* $note->getId() == $data['note_id']
|
2021-07-28 22:19:16 +01:00
|
|
|
*
|
|
|
|
* This function is called when a user interacts with a note, such as through favouriting or commenting
|
|
|
|
*
|
|
|
|
* @codeCoverageIgnore
|
2021-08-11 02:49:23 +01:00
|
|
|
*
|
|
|
|
* @param Request $request
|
|
|
|
* @param Form $form
|
|
|
|
* @param Note $note
|
|
|
|
* @param string $form_name
|
|
|
|
* @param callable $handle
|
|
|
|
*
|
|
|
|
* @throws InvalidFormException
|
|
|
|
* @throws NoSuchNoteException
|
|
|
|
*
|
|
|
|
* @return bool|void
|
2020-11-06 19:47:15 +00:00
|
|
|
*/
|
2020-09-10 23:28:11 +01:00
|
|
|
public static function noteActionHandle(Request $request, Form $form, Note $note, string $form_name, callable $handle)
|
|
|
|
{
|
|
|
|
if ('POST' === $request->getMethod() && $request->request->has($form_name)) {
|
|
|
|
$form->handleRequest($request);
|
|
|
|
if ($form->isSubmitted()) {
|
|
|
|
$data = $form->getData();
|
|
|
|
// Loose comparison
|
|
|
|
if ($data['note_id'] != $note->getId()) {
|
|
|
|
return Event::next;
|
|
|
|
} else {
|
|
|
|
$user = Common::user();
|
|
|
|
if (!$note->isVisibleTo($user)) {
|
|
|
|
// ^ Ensure user isn't trying to trip us up
|
2021-08-11 02:49:23 +01:00
|
|
|
Log::warning('Suspicious activity: user ' . $user->getNickname() .
|
2021-04-15 12:42:45 +01:00
|
|
|
' tried to interact with note ' . $note->getId() .
|
2020-09-10 23:28:11 +01:00
|
|
|
', but they shouldn\'t have access to it');
|
|
|
|
throw new NoSuchNoteException();
|
|
|
|
} else {
|
|
|
|
if ($form->isValid()) {
|
|
|
|
$ret = $handle($note, $data, $user);
|
|
|
|
if ($ret != null) {
|
|
|
|
return $ret;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
throw new InvalidFormException();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2020-08-03 21:51:45 +01:00
|
|
|
}
|