2020-06-22 07:56:26 +09:00
< ? php
2021-10-10 17:26:18 +09:00
declare ( strict_types = 1 );
2020-06-22 07:56:26 +09:00
// {{{ License
2020-08-15 07:37:45 +09:00
2020-06-22 07:56:26 +09: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-15 07:37:45 +09:00
2020-06-22 07:56:26 +09:00
// }}}
/**
* Handle network public feed
*
* @ package GNUsocial
* @ category Controller
*
2021-02-20 08:29:43 +09:00
* @ author Hugo Sales < hugo @ hsal . es >
2020-07-01 01:35:38 +09:00
* @ author Eliseu Amaro < eliseu @ fc . up . pt >
2021-02-20 08:29:43 +09:00
* @ copyright 2020 - 2021 Free Software Foundation , Inc http :// www . fsf . org
2020-06-22 07:56:26 +09:00
* @ license https :// www . gnu . org / licenses / agpl . html GNU AGPL v3 or later
*/
namespace App\Controller ;
2020-07-31 07:47:47 +09:00
// {{{ Imports
2021-11-16 02:00:58 +09:00
use App\Core\Cache ;
2021-11-15 22:34:34 +09:00
use App\Core\Controller ;
2020-07-31 07:47:47 +09:00
use App\Core\DB\DB ;
use App\Core\Event ;
2020-06-27 07:44:53 +09:00
use App\Core\Form ;
2020-06-22 07:56:26 +09:00
use function App\Core\I18n\_m ;
2021-10-21 21:44:30 +09:00
use App\Core\Log ;
2021-11-16 02:00:58 +09:00
use App\Entity\ActorLanguage ;
2021-08-08 03:25:10 +09:00
use App\Entity\UserNotificationPrefs ;
2020-07-26 02:56:38 +09:00
use App\Util\Common ;
2021-08-05 05:11:01 +09:00
use App\Util\Exception\AuthenticationException ;
2021-11-16 02:00:58 +09:00
use App\Util\Exception\RedirectException ;
2021-08-05 05:11:01 +09:00
use App\Util\Exception\ServerException ;
2021-09-07 03:49:03 +09:00
use App\Util\Form\ActorArrayTransformer ;
2020-07-27 12:48:35 +09:00
use App\Util\Form\ArrayTransformer ;
2021-08-06 20:12:10 +09:00
use App\Util\Form\FormFields ;
use App\Util\Formatting ;
2020-07-31 07:47:47 +09:00
use Doctrine\DBAL\Types\Types ;
use Exception ;
use Functional as F ;
2020-07-26 09:02:20 +09:00
use Misd\PhoneNumberBundle\Form\Type\PhoneNumberType ;
2020-07-22 06:02:39 +09:00
use Symfony\Component\Form\Extension\Core\Type\CheckboxType ;
2021-11-16 02:00:58 +09:00
use Symfony\Component\Form\Extension\Core\Type\IntegerType ;
2020-06-22 07:56:26 +09:00
use Symfony\Component\Form\Extension\Core\Type\SubmitType ;
2020-07-21 06:05:10 +09:00
use Symfony\Component\Form\Extension\Core\Type\TextareaType ;
2020-06-22 07:56:26 +09:00
use Symfony\Component\Form\Extension\Core\Type\TextType ;
use Symfony\Component\HttpFoundation\Request ;
2020-07-31 07:47:47 +09:00
// }}} Imports
2021-11-15 22:34:34 +09:00
class UserPanel extends Controller
2020-06-22 07:56:26 +09:00
{
2021-07-30 01:29:25 +09:00
/**
* Return main settings page forms
*
* @ throws Exception
*/
2021-11-16 02:00:58 +09:00
public function allSettings ( Request $request ) : array
2021-07-30 01:29:25 +09:00
{
2021-08-05 05:11:01 +09:00
$account_form = $this -> account ( $request );
2021-11-16 22:15:48 +09:00
$personal_form = $this -> personalInfo ( $request );
2021-08-05 05:11:01 +09:00
$notifications_form_array = $this -> notifications ( $request );
2021-07-30 01:29:25 +09:00
2021-08-05 05:11:01 +09:00
return [
'_template' => 'settings/base.html.twig' ,
2021-07-30 01:29:25 +09:00
'prof' => $personal_form -> createView (),
'acc' => $account_form -> createView (),
2021-08-05 05:11:01 +09:00
'tabbed_forms_notify' => $notifications_form_array ,
2021-11-16 02:00:58 +09:00
'open_details_query' => $this -> string ( 'open' ),
2021-07-30 01:29:25 +09:00
];
}
2020-11-07 04:47:15 +09:00
/**
* Local user personal information panel
*/
2021-11-16 22:15:48 +09:00
public function personalInfo ( Request $request )
2020-06-22 07:56:26 +09:00
{
2021-11-16 02:00:58 +09:00
$user = Common :: ensureLoggedIn ();
2021-08-05 05:11:01 +09:00
$actor = $user -> getActor ();
$extra = [ 'self_tags' => $actor -> getSelfTags ()];
2020-07-26 02:56:38 +09:00
$form_definition = [
2021-08-05 05:11:01 +09:00
[ 'nickname' , TextType :: class , [ 'label' => _m ( 'Nickname' ), 'required' => true , 'help' => _m ( '1-64 lowercase letters or numbers, no punctuation or spaces.' )]],
[ 'full_name' , TextType :: class , [ 'label' => _m ( 'Full Name' ), 'required' => false , 'help' => _m ( 'A full name is required, if empty it will be set to your nickname.' )]],
[ 'homepage' , TextType :: class , [ 'label' => _m ( 'Homepage' ), 'required' => false , 'help' => _m ( 'URL of your homepage, blog, or profile on another site.' )]],
[ 'bio' , TextareaType :: class , [ 'label' => _m ( 'Bio' ), 'required' => false , 'help' => _m ( 'Describe yourself and your interests.' )]],
[ 'location' , TextType :: class , [ 'label' => _m ( 'Location' ), 'required' => false , 'help' => _m ( 'Where you are, like "City, State (or Region), Country".' )]],
[ 'self_tags' , TextType :: class , [ 'label' => _m ( 'Self Tags' ), 'required' => false , 'help' => _m ( 'Tags for yourself (letters, numbers, -, ., and _), comma- or space-separated.' ), 'transformer' => ArrayTransformer :: class ]],
2021-08-19 02:38:54 +09:00
[ 'save_personal_info' , SubmitType :: class , [ 'label' => _m ( 'Save personal info' )]],
2020-07-26 02:56:38 +09:00
];
2021-10-26 22:47:28 +09:00
$extra_step = function ( $data , $extra_args ) use ( $user , $actor ) {
2021-07-30 01:29:25 +09:00
$user -> setNickname ( $data [ 'nickname' ]);
2021-11-16 02:00:58 +09:00
if ( ! $data [ 'full_name' ] && ! $actor -> getFullname ()) {
$actor -> setFullname ( $data [ 'nickname' ]);
}
2021-07-30 01:29:25 +09:00
};
2021-10-10 17:26:18 +09:00
return Form :: handle ( $form_definition , $request , $actor , $extra , $extra_step , [[ 'self_tags' => $extra [ 'self_tags' ]]]);
2020-06-22 07:56:26 +09:00
}
2020-07-22 06:02:39 +09:00
2020-11-07 04:47:15 +09:00
/**
* Local user account information panel
*/
2020-07-22 06:02:39 +09:00
public function account ( Request $request )
{
2021-11-16 02:00:58 +09:00
$user = Common :: ensureLoggedIn ();
2021-08-05 05:11:01 +09:00
// TODO Add support missing settings
2021-11-16 02:00:58 +09:00
2021-08-05 05:11:01 +09:00
$form = Form :: create ([
2021-10-21 21:44:30 +09:00
[ 'outgoing_email' , TextType :: class , [ 'label' => _m ( 'Outgoing email' ), 'required' => false , 'help' => _m ( 'Change the email we use to contact you' )]],
[ 'incoming_email' , TextType :: class , [ 'label' => _m ( 'Incoming email' ), 'required' => false , 'help' => _m ( 'Change the email you use to contact us (for posting, for instance)' )]],
2021-08-05 05:11:01 +09:00
[ 'old_password' , TextType :: class , [ 'label' => _m ( 'Old password' ), 'required' => false , 'help' => _m ( 'Enter your old password for verification' ), 'attr' => [ 'placeholder' => '********' ]]],
FormFields :: repeated_password ([ 'required' => false ]),
2021-11-16 02:00:58 +09:00
FormFields :: language ( $user -> getActor (), context_actor : null , label : 'Languages' , help : 'The languages you understand, so you can see primarily content in those' , multiple : true , required : false ),
[ 'phone_number' , PhoneNumberType :: class , [ 'label' => _m ( 'Phone number' ), 'required' => false , 'help' => _m ( 'Your phone number' ), 'data_class' => null ]],
[ 'save_account_info' , SubmitType :: class , [ 'label' => _m ( 'Save account info' )]],
2021-08-05 05:11:01 +09:00
]);
$form -> handleRequest ( $request );
if ( $form -> isSubmitted () && $form -> isValid ()) {
$data = $form -> getData ();
2021-10-10 17:26:18 +09:00
if ( ! \is_null ( $data [ 'old_password' ])) {
2021-08-05 05:11:01 +09:00
$data [ 'password' ] = $form -> get ( 'password' ) -> getData ();
if ( ! ( $user -> changePassword ( $data [ 'old_password' ], $data [ 'password' ]))) {
throw new AuthenticationException ( _m ( 'The provided password is incorrect' ));
}
}
unset ( $data [ 'old_password' ], $data [ 'password' ]);
2021-11-16 02:00:58 +09:00
$redirect_to_language_sorting = false ;
if ( ! \is_null ( $data [ 'languages' ])) {
$selected_langs = DB :: findBy ( 'language' , [ 'locale' => $data [ 'languages' ]]);
$existing_langs = DB :: dql (
'select l from language l join actor_language al with l.id = al.language_id where al.actor_id = :actor_id' ,
[ 'actor_id' => $user -> getId ()],
);
$new_langs = array_udiff ( $selected_langs , $existing_langs , fn ( $l , $r ) => $l -> getId () <=> $r -> getId ());
$removing_langs = array_udiff ( $existing_langs , $selected_langs , fn ( $l , $r ) => $l -> getId () <=> $r -> getId ());
foreach ( $new_langs as $l ) {
DB :: persist ( ActorLanguage :: create ([ 'actor_id' => $user -> getId (), 'language_id' => $l -> getId (), 'ordering' => 0 ]));
}
if ( ! empty ( $removing_langs )) {
$actor_langs_to_remove = DB :: findBy ( 'actor_language' , [ 'actor_id' => $user -> getId (), 'language_id' => F\map ( $removing_langs , fn ( $l ) => $l -> getId ())]);
foreach ( $actor_langs_to_remove as $lang ) {
DB :: remove ( $lang );
}
}
Cache :: delete ( ActorLanguage :: collectionCacheKey ( $user ));
DB :: flush ();
ActorLanguage :: normalizeOrdering ( $user ); // In case the user doesn't submit the other page
unset ( $data [ 'languages' ]);
$redirect_to_language_sorting = true ;
}
2021-08-05 05:11:01 +09:00
foreach ( $data as $key => $val ) {
$method = 'set' . ucfirst ( Formatting :: snakeCaseToCamelCase ( $key ));
if ( method_exists ( $user , $method )) {
$user -> { $method }( $val );
}
}
DB :: flush ();
2021-11-16 02:00:58 +09:00
if ( $redirect_to_language_sorting ) {
throw new RedirectException ( 'settings_sort_languages' , [ '_fragment' => null ]); // TODO doesn't clear fragment
}
2021-08-05 05:11:01 +09:00
}
2020-07-22 06:02:39 +09:00
2021-07-30 01:29:25 +09:00
return $form ;
2020-07-22 06:02:39 +09:00
}
2020-07-23 05:58:23 +09:00
2021-11-16 02:00:58 +09:00
public function sortLanguages ( Request $request )
{
$user = Common :: ensureLoggedIn ();
$langs = DB :: dql ( 'select l.locale, l.long_display, al.ordering from language l join actor_language al with l.id = al.language_id where al.actor_id = :id order by al.ordering ASC' , [ 'id' => $user -> getId ()]);
$form_entries = [];
foreach ( $langs as $l ) {
$form_entries [] = [ $l [ 'locale' ], IntegerType :: class , [ 'label' => _m ( $l [ 'long_display' ]), 'data' => $l [ 'ordering' ]]];
}
$form_entries [] = [ 'save_language_order' , SubmitType :: class , []];
$form_entries [] = [ 'go_back' , SubmitType :: class , [ 'label' => _m ( 'Return to settings page' )]];
$form = Form :: create ( $form_entries );
$form -> handleRequest ( $request );
if ( $form -> isSubmitted () && $form -> isValid ()) {
$go_back = $form -> get ( 'go_back' ) -> isClicked ();
$data = $form -> getData ();
asort ( $data ); // Sort by the order value
$data = array_keys ( $data ); // This keeps the order and gives us a unique number for each
foreach ( $data as $order => $locale ) {
$lang = Cache :: getHashMapKey ( 'languages' , $locale );
$actor_lang = DB :: getReference ( 'actor_language' , [ 'actor_id' => $user -> getId (), 'language_id' => $lang -> getId ()]);
$actor_lang -> setOrdering ( $order + 1 );
}
DB :: flush ();
if ( ! $go_back ) {
// Stay on same page, but force update and prevent resubmission
throw new RedirectException ( 'settings_sort_languages' );
} else {
throw new RedirectException ( 'settings' , [ 'open' => 'account' , '_fragment' => 'save_account_info_languages' ]);
}
}
return [
'_template' => 'settings/sort_languages.html.twig' ,
'form' => $form -> createView (),
];
}
2020-11-07 04:47:15 +09:00
/**
* Local user notification settings tabbed panel
*/
2020-07-27 00:05:07 +09:00
public function notifications ( Request $request )
2020-07-23 05:58:23 +09:00
{
2021-11-16 02:00:58 +09:00
$user = Common :: ensureLoggedIn ();
2020-07-31 07:47:47 +09:00
$schema = DB :: getConnection () -> getSchemaManager ();
$platform = $schema -> getDatabasePlatform ();
2020-08-06 01:31:39 +09:00
$columns = Common :: arrayRemoveKeys ( $schema -> listTableColumns ( 'user_notification_prefs' ), [ 'user_id' , 'transport' , 'created' , 'modified' ]);
2020-07-31 07:47:47 +09:00
$form_defs = [ 'placeholder' => []];
foreach ( $columns as $name => $col ) {
2020-08-06 01:31:39 +09:00
$type = $col -> getType ();
$val = $type -> convertToPHPValue ( $col -> getDefault (), $platform );
2021-11-15 22:37:29 +09:00
$type_str = $type -> getName ();
2020-08-06 01:31:39 +09:00
$label = str_replace ( '_' , ' ' , ucfirst ( $name ));
2020-08-06 08:05:06 +09:00
$labels = [
2021-09-18 11:22:27 +09:00
'target_actor_id' => 'Target Actors' ,
'dm' => 'DM' ,
2020-08-06 08:05:06 +09:00
];
$help = [
2021-11-08 22:44:35 +09:00
'target_actor_id' => 'If specified, these settings apply only to these profiles (comma- or space-separated list)' ,
'activity_by_subscribed' => 'Notify me when someone I subscribed has new activity' ,
'mention' => 'Notify me when mentions me in a notice' ,
'reply' => 'Notify me when someone replies to a notice made by me' ,
'subscription' => 'Notify me when someone subscribes to me or asks for permission to do so' ,
'favorite' => 'Notify me when someone favorites one of my notices' ,
'nudge' => 'Notify me when someone nudges me' ,
'dm' => 'Notify me when someone sends me a direct message' ,
'post_on_status_change' => 'Post a notice when my status in this service changes' ,
'enable_posting' => 'Enable posting from this service' ,
2020-08-06 08:05:06 +09:00
];
2020-08-06 01:31:39 +09:00
switch ( $type_str ) {
2020-07-31 07:47:47 +09:00
case Types :: BOOLEAN :
2020-08-06 08:05:06 +09:00
$form_defs [ 'placeholder' ][ $name ] = [ $name , CheckboxType :: class , [ 'data' => $val , 'label' => _m ( $labels [ $name ] ? ? $label ), 'help' => _m ( $help [ $name ])]];
2020-07-31 07:47:47 +09:00
break ;
case Types :: INTEGER :
2021-09-18 11:22:27 +09:00
if ( $name == 'target_actor_id' ) {
2021-08-05 05:11:01 +09:00
$form_defs [ 'placeholder' ][ $name ] = [ $name , TextType :: class , [ 'data' => $val , 'label' => _m ( $labels [ $name ]), 'help' => _m ( $help [ $name ])], 'transformer' => ActorArrayTransformer :: class ];
2020-07-31 07:47:47 +09:00
}
2020-10-12 02:19:29 +09:00
break ;
2020-07-31 07:47:47 +09:00
default :
2021-08-05 05:11:01 +09:00
// @codeCoverageIgnoreStart
Log :: critical ( " Structure of table user_notification_prefs changed in a way not accounted to in notification settings ( { $name } ): " . $type_str );
2021-11-15 22:37:29 +09:00
throw new ServerException ( _m ( 'Internal server error' ));
2021-08-05 05:11:01 +09:00
// @codeCoverageIgnoreEnd
2020-07-31 07:47:47 +09:00
}
}
2021-08-08 03:25:10 +09:00
$form_defs [ 'placeholder' ][ 'save' ] = fn ( string $transport , string $form_name ) => [ $form_name , SubmitType :: class ,
2021-08-05 05:11:01 +09:00
[ 'label' => _m ( 'Save notification settings for {transport}' , [ 'transport' => $transport ])], ];
2021-08-08 03:24:11 +09:00
2020-10-20 03:22:59 +09:00
Event :: handle ( 'AddNotificationTransport' , [ & $form_defs ]);
2020-07-31 07:47:47 +09:00
unset ( $form_defs [ 'placeholder' ]);
$tabbed_forms = [];
foreach ( $form_defs as $transport_name => $f ) {
2021-08-08 03:24:11 +09:00
unset ( $f [ 'save' ]);
$form = Form :: create ( $f );
$tabbed_forms [ $transport_name ] = $form ;
$form -> handleRequest ( $request );
if ( $form -> isSubmitted () && $form -> isValid ()) {
$data = $form -> getData ();
2021-08-08 03:25:10 +09:00
unset ( $data [ 'translation_domain' ]);
2021-08-05 05:11:01 +09:00
try {
[ $ent , $is_update ] = UserNotificationPrefs :: createOrUpdate (
array_merge ([ 'user_id' => $user -> getId (), 'transport' => $transport_name ], $data ),
2021-10-10 17:26:18 +09:00
find_by_keys : [ 'user_id' , 'transport' ],
2021-08-05 05:11:01 +09:00
);
if ( ! $is_update ) {
DB :: persist ( $ent );
}
DB :: flush ();
// @codeCoverageIgnoreStart
2021-10-10 17:26:18 +09:00
} catch ( Exception $e ) {
2021-08-05 05:11:01 +09:00
// Somehow, the exception doesn't bubble up in phpunit
2021-10-21 21:44:30 +09:00
// dd($data, $e);
2021-08-05 05:11:01 +09:00
// @codeCoverageIgnoreEnd
2021-10-21 21:44:30 +09:00
Log :: critical ( 'Exception at ' . $e -> getFile () . ':' . $e -> getLine () . ': ' . $e -> getMessage ());
2021-08-08 03:25:10 +09:00
}
2021-08-08 03:24:11 +09:00
}
2020-07-31 07:47:47 +09:00
}
2021-10-10 17:26:18 +09:00
$tabbed_forms = F\map ( $tabbed_forms , fn ( $f ) => $f -> createView ());
2021-07-30 01:29:25 +09:00
return $tabbed_forms ;
2020-07-23 05:58:23 +09:00
}
2020-07-23 23:08:31 +09:00
}