2019-10-11 05:38:42 +00:00
< ? php
/**
2022-01-02 07:27:47 +00:00
* @ copyright Copyright ( C ) 2010 - 2022 , the Friendica project
2020-02-09 15:18:46 +00:00
*
2022-01-06 23:13:00 +00:00
* @ license GNU AGPL version 3 or any later version
2020-02-09 15:18:46 +00:00
*
* This program 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 .
*
* This program 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 this program . If not , see < https :// www . gnu . org / licenses />.
*
2019-10-11 05:38:42 +00:00
*/
namespace Friendica\Module\Settings ;
2022-10-17 10:37:48 +00:00
use Friendica\App ;
2019-10-11 05:38:42 +00:00
use Friendica\Core\Hook ;
use Friendica\Core\Renderer ;
2022-10-19 04:40:06 +00:00
use Friendica\Core\Session ;
2022-05-18 02:13:54 +00:00
use Friendica\Core\System ;
2019-10-11 05:38:42 +00:00
use Friendica\Database\DBA ;
2019-12-15 21:34:11 +00:00
use Friendica\DI ;
2020-09-27 10:24:15 +00:00
use Friendica\Model\Item ;
2021-01-19 07:23:01 +00:00
use Friendica\Model\Post ;
2020-01-23 04:14:14 +00:00
use Friendica\Module\BaseSettings ;
2021-04-01 23:29:21 +00:00
use Friendica\Network\HTTPException ;
2019-10-11 05:38:42 +00:00
/**
* Module to export user data
**/
2020-01-23 04:14:14 +00:00
class UserExport extends BaseSettings
2019-10-11 05:38:42 +00:00
{
/**
* Handle the request to export data .
2019-11-02 23:12:16 +00:00
* At the moment one can export three different data set
2019-10-11 05:38:42 +00:00
* 1. The profile data that can be used by uimport to resettle
* to a different Friendica instance
* 2. The entire data - set , profile plus postings
2019-11-02 23:12:16 +00:00
* 3. A list of contacts as CSV file similar to the export of Mastodon
2019-10-11 09:49:28 +00:00
*
* If there is an action required through the URL / path , react
* accordingly and export the requested data .
2021-04-01 23:29:21 +00:00
*
* @ return string
* @ throws HTTPException\ForbiddenException
* @ throws HTTPException\InternalServerErrorException
*/
2021-11-20 14:38:03 +00:00
protected function content ( array $request = []) : string
2019-10-11 05:38:42 +00:00
{
2022-10-19 04:40:06 +00:00
if ( ! Session :: getLocalUser ()) {
2021-04-01 23:29:21 +00:00
throw new HTTPException\ForbiddenException ( DI :: l10n () -> t ( 'Permission denied.' ));
}
2021-11-14 19:46:25 +00:00
parent :: content ();
2019-10-17 05:45:48 +00:00
2019-10-11 05:38:42 +00:00
/**
* options shown on " Export personal data " page
* list of array ( 'link url' , 'link text' , 'help text' )
*/
$options = [
2020-01-18 19:52:34 +00:00
[ 'settings/userexport/account' , DI :: l10n () -> t ( 'Export account' ), DI :: l10n () -> t ( 'Export your account info and contacts. Use this to make a backup of your account and/or to move it to another server.' )],
2020-01-22 06:22:45 +00:00
[ 'settings/userexport/backup' , DI :: l10n () -> t ( 'Export all' ), DI :: l10n () -> t ( " Export your account info, contacts and all your items as json. Could be a very big file, and could take a lot of time. Use this to make a full backup of your account \x28 photos are not exported \x29 " )],
2020-01-18 19:52:34 +00:00
[ 'settings/userexport/contact' , DI :: l10n () -> t ( 'Export Contacts to CSV' ), DI :: l10n () -> t ( " Export the list of the accounts you are following as CSV file. Compatible to e.g. Mastodon. " )],
2019-10-11 05:38:42 +00:00
];
Hook :: callAll ( 'uexport_options' , $options );
2019-11-02 10:24:46 +00:00
$tpl = Renderer :: getMarkupTemplate ( " settings/userexport.tpl " );
2019-10-11 05:38:42 +00:00
return Renderer :: replaceMacros ( $tpl , [
2020-01-18 19:52:34 +00:00
'$title' => DI :: l10n () -> t ( 'Export personal data' ),
2019-10-11 05:38:42 +00:00
'$options' => $options
]);
}
2021-04-01 23:29:21 +00:00
2019-10-17 05:45:48 +00:00
/**
* raw content generated for the different choices made
* by the user . At the moment this returns a JSON file
* to the browser which then offers a save / open dialog
* to the user .
2021-04-01 23:29:21 +00:00
*
* @ throws HTTPException\ForbiddenException
*/
2021-11-20 14:38:03 +00:00
protected function rawContent ( array $request = [])
2019-11-02 10:24:46 +00:00
{
2021-08-08 19:30:21 +00:00
if ( ! DI :: app () -> isLoggedIn ()) {
2021-04-01 23:29:21 +00:00
throw new HTTPException\ForbiddenException ( DI :: l10n () -> t ( 'Permission denied.' ));
}
2019-12-15 22:28:01 +00:00
$args = DI :: args ();
2019-10-17 05:45:48 +00:00
if ( $args -> getArgc () == 3 ) {
// @TODO Replace with router-provided arguments
$action = $args -> get ( 2 );
switch ( $action ) {
case " backup " :
2019-11-02 23:12:16 +00:00
header ( " Content-type: application/json " );
2021-08-09 19:48:39 +00:00
header ( 'Content-Disposition: attachment; filename="' . DI :: app () -> getLoggedInUserNickname () . '.' . $action . '"' );
2022-10-19 04:40:06 +00:00
self :: exportAll ( Session :: getLocalUser ());
2019-10-17 05:45:48 +00:00
break ;
case " account " :
2019-11-02 23:12:16 +00:00
header ( " Content-type: application/json " );
2021-08-09 19:48:39 +00:00
header ( 'Content-Disposition: attachment; filename="' . DI :: app () -> getLoggedInUserNickname () . '.' . $action . '"' );
2022-10-19 04:40:06 +00:00
self :: exportAccount ( Session :: getLocalUser ());
2019-10-17 05:45:48 +00:00
break ;
2019-11-03 11:59:14 +00:00
case " contact " :
2019-11-02 23:12:16 +00:00
header ( " Content-type: application/csv " );
2021-08-09 19:48:39 +00:00
header ( 'Content-Disposition: attachment; filename="' . DI :: app () -> getLoggedInUserNickname () . '-contacts.csv' . '"' );
2022-10-19 04:40:06 +00:00
self :: exportContactsAsCSV ( Session :: getLocalUser ());
2019-11-02 23:12:16 +00:00
break ;
2019-10-17 05:45:48 +00:00
}
2022-05-18 02:13:54 +00:00
System :: exit ();
2019-10-17 05:45:48 +00:00
}
}
2021-04-01 23:29:21 +00:00
/**
* @ param string $query
* @ return array
* @ throws \Exception
*/
2019-11-02 10:24:46 +00:00
private static function exportMultiRow ( string $query )
{
2022-07-12 21:21:16 +00:00
$dbStructure = DI :: dbaDefinition () -> getAll ();
2019-10-11 05:38:42 +00:00
preg_match ( " / \ s+from \ s+`?([a-z \ d_]+)`?/i " , $query , $match );
$table = $match [ 1 ];
$result = [];
2019-11-02 11:12:29 +00:00
$rows = DBA :: p ( $query );
while ( $row = DBA :: fetch ( $rows )) {
$p = [];
2020-08-20 13:30:50 +00:00
foreach ( $dbStructure [ $table ][ 'fields' ] as $column => $field ) {
2020-09-27 10:24:15 +00:00
if ( ! isset ( $row [ $column ])) {
continue ;
}
2020-08-20 13:30:50 +00:00
if ( $field [ 'type' ] == 'datetime' ) {
2020-09-27 10:24:15 +00:00
$p [ $column ] = $row [ $column ] ? ? DBA :: NULL_DATETIME ;
2020-08-20 13:30:50 +00:00
} else {
2020-09-27 10:24:15 +00:00
$p [ $column ] = $row [ $column ];
2019-10-11 05:38:42 +00:00
}
}
2019-11-02 11:12:29 +00:00
$result [] = $p ;
2019-10-11 05:38:42 +00:00
}
2019-11-02 11:12:29 +00:00
DBA :: close ( $rows );
2019-10-11 05:38:42 +00:00
return $result ;
}
2021-04-01 23:29:21 +00:00
/**
* @ param string $query
* @ return array
* @ throws \Exception
*/
2019-11-02 10:24:46 +00:00
private static function exportRow ( string $query )
{
2022-07-12 21:21:16 +00:00
$dbStructure = DI :: dbaDefinition () -> getAll ();
2019-10-11 05:38:42 +00:00
preg_match ( " / \ s+from \ s+`?([a-z \ d_]+)`?/i " , $query , $match );
$table = $match [ 1 ];
$result = [];
2021-10-08 04:10:45 +00:00
$rows = DBA :: p ( $query );
while ( $row = DBA :: fetch ( $rows )) {
foreach ( $row as $k => $v ) {
if ( empty ( $dbStructure [ $table ][ 'fields' ][ $k ])) {
continue ;
}
switch ( $dbStructure [ $table ][ 'fields' ][ $k ][ 'type' ]) {
case 'datetime' :
$result [ $k ] = $v ? ? DBA :: NULL_DATETIME ;
break ;
default :
$result [ $k ] = $v ;
break ;
2019-10-11 05:38:42 +00:00
}
}
}
2021-10-08 04:10:45 +00:00
DBA :: close ( $rows );
2021-04-01 23:29:21 +00:00
2019-10-11 05:38:42 +00:00
return $result ;
}
2019-11-02 23:12:16 +00:00
/**
* Export a list of the contacts as CSV file as e . g . Mastodon and Pleroma are doing .
2021-04-01 23:29:21 +00:00
*
* @ param int $user_id
* @ throws \Exception
*/
private static function exportContactsAsCSV ( int $user_id )
2019-11-02 23:12:16 +00:00
{
2021-04-01 23:29:21 +00:00
if ( ! $user_id ) {
throw new \RuntimeException ( DI :: l10n () -> t ( 'Permission denied.' ));
}
2019-11-02 23:12:16 +00:00
// write the table header (like Mastodon)
echo " Account address, Show boosts \n " ;
// get all the contacts
2021-04-01 23:29:21 +00:00
$contacts = DBA :: select ( 'contact' , [ 'addr' , 'url' ], [ 'uid' => $user_id , 'self' => false , 'rel' => [ 1 , 3 ], 'deleted' => false ]);
2019-11-03 13:03:11 +00:00
while ( $contact = DBA :: fetch ( $contacts )) {
2020-09-27 14:08:41 +00:00
echo ( $contact [ 'addr' ] ? : $contact [ 'url' ]) . " , true \n " ;
2019-11-02 23:12:16 +00:00
}
2019-11-03 13:03:11 +00:00
DBA :: close ( $contacts );
2019-11-02 23:12:16 +00:00
}
2021-04-01 23:29:21 +00:00
/**
* @ param int $user_id
* @ throws \Exception
*/
private static function exportAccount ( int $user_id )
2019-11-02 10:24:46 +00:00
{
2021-04-01 23:29:21 +00:00
if ( ! $user_id ) {
throw new \RuntimeException ( DI :: l10n () -> t ( 'Permission denied.' ));
}
2019-10-17 05:45:48 +00:00
$user = self :: exportRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT * FROM `user` WHERE `uid` = %d LIMIT 1 " , $user_id )
2019-10-11 05:38:42 +00:00
);
2019-10-17 05:45:48 +00:00
$contact = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT * FROM `contact` WHERE `uid` = %d " , $user_id )
2019-10-11 05:38:42 +00:00
);
2019-10-17 05:45:48 +00:00
$profile = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT *, 'default' AS `profile_name`, 1 AS `is-default` FROM `profile` WHERE `uid` = %d " , $user_id )
2020-01-23 00:36:20 +00:00
);
$profile_fields = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT * FROM `profile_field` WHERE `uid` = %d " , $user_id )
2019-10-11 05:38:42 +00:00
);
2019-10-17 05:45:48 +00:00
$photo = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT * FROM `photo` WHERE uid = %d AND profile = 1 " , $user_id )
2019-10-11 05:38:42 +00:00
);
foreach ( $photo as & $p ) {
$p [ 'data' ] = bin2hex ( $p [ 'data' ]);
}
2019-10-17 05:45:48 +00:00
$pconfig = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT * FROM `pconfig` WHERE uid = %d " , $user_id )
2019-10-11 05:38:42 +00:00
);
2019-10-17 05:45:48 +00:00
$group = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT * FROM `group` WHERE uid = %d " , $user_id )
2019-10-11 05:38:42 +00:00
);
2019-10-17 05:45:48 +00:00
$group_member = self :: exportMultiRow (
2021-04-01 23:29:21 +00:00
sprintf ( " SELECT `group_member`.`gid`, `group_member`.`contact-id` FROM `group_member` INNER JOIN `group` ON `group`.`id` = `group_member`.`gid` WHERE `group`.`uid` = %d " , $user_id )
2019-10-11 05:38:42 +00:00
);
$output = [
2022-10-17 10:37:48 +00:00
'version' => App :: VERSION ,
2019-10-11 05:38:42 +00:00
'schema' => DB_UPDATE_VERSION ,
2019-12-30 22:00:08 +00:00
'baseurl' => DI :: baseUrl (),
2019-10-11 05:38:42 +00:00
'user' => $user ,
'contact' => $contact ,
'profile' => $profile ,
2020-01-23 00:36:20 +00:00
'profile_fields' => $profile_fields ,
2019-10-11 05:38:42 +00:00
'photo' => $photo ,
'pconfig' => $pconfig ,
'group' => $group ,
'group_member' => $group_member ,
];
echo json_encode ( $output , JSON_PARTIAL_OUTPUT_ON_ERROR );
}
/**
* echoes account data and items as separated json , one per line
*
2021-04-01 23:29:21 +00:00
* @ param int $user_id
2020-01-19 15:29:55 +00:00
* @ throws \Exception
2019-10-11 05:38:42 +00:00
*/
2021-04-01 23:29:21 +00:00
private static function exportAll ( int $user_id )
2019-11-02 10:24:46 +00:00
{
2021-04-01 23:29:21 +00:00
if ( ! $user_id ) {
throw new \RuntimeException ( DI :: l10n () -> t ( 'Permission denied.' ));
}
self :: exportAccount ( $user_id );
2019-10-11 05:38:42 +00:00
echo " \n " ;
2021-04-01 23:29:21 +00:00
$total = Post :: count ([ 'uid' => $user_id ]);
2019-10-11 05:38:42 +00:00
// chunk the output to avoid exhausting memory
for ( $x = 0 ; $x < $total ; $x += 500 ) {
2021-04-01 23:29:21 +00:00
$items = Post :: selectToArray ( Item :: ITEM_FIELDLIST , [ 'uid' => $user_id ], [ 'limit' => [ $x , 500 ]]);
2020-09-27 10:24:15 +00:00
$output = [ 'item' => $items ];
2021-04-01 23:29:21 +00:00
echo json_encode ( $output , JSON_PARTIAL_OUTPUT_ON_ERROR ) . " \n " ;
2019-10-11 05:38:42 +00:00
}
}
}