2019-10-11 07:38:42 +02:00
< ? php
/**
2019-10-11 11:55:57 +02:00
* @ file src / Modules / Settings / Uexport . php
2019-10-11 07:38:42 +02:00
*/
namespace Friendica\Module\Settings ;
use Friendica\App ;
use Friendica\App\Arguments ;
use Friendica\BaseModule ;
use Friendica\Core\Hook ;
use Friendica\Core\L10n ;
use Friendica\Core\Renderer ;
use Friendica\Core\System ;
use Friendica\Database\DBA ;
use Friendica\Database\DBStructure ;
use Friendica\Module\BaseSettingsModule ;
/**
* Module to export user data
**/
class Uexport extends BaseSettingsModule
{
/**
* Handle the request to export data .
* At the moment one can export two different data set
* 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-10-11 11:49:28 +02:00
*
* If there is an action required through the URL / path , react
* accordingly and export the requested data .
2019-10-11 07:38:42 +02:00
**/
public static function content ()
{
parent :: content ();
2019-10-17 07:45:48 +02:00
self :: rawContent ();
2019-10-11 07:38:42 +02:00
/**
* options shown on " Export personal data " page
* list of array ( 'link url' , 'link text' , 'help text' )
*/
$options = [
[ 'settings/uexport/account' , L10n :: t ( 'Export account' ), 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.' )],
[ 'settings/uexport/backup' , L10n :: t ( 'Export all' ), L10n :: t ( " Export your accout 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 " )],
];
Hook :: callAll ( 'uexport_options' , $options );
$tpl = Renderer :: getMarkupTemplate ( " uexport.tpl " );
return Renderer :: replaceMacros ( $tpl , [
'$title' => L10n :: t ( 'Export personal data' ),
'$options' => $options
]);
}
2019-10-17 07:45:48 +02: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 .
**/
public static function rawContent () {
$args = self :: getClass ( Arguments :: class );
if ( $args -> getArgc () == 3 ) {
// @TODO Replace with router-provided arguments
$action = $args -> get ( 2 );
$user = self :: getApp () -> user ;
header ( " Content-type: application/json " );
header ( 'Content-Disposition: attachment; filename="' . $user [ 'nickname' ] . '.' . $action . '"' );
switch ( $action ) {
case " backup " :
self :: exportAll ( self :: getApp ());
exit ();
break ;
case " account " :
self :: exportAccount ( self :: getApp ());
exit ();
break ;
default :
exit ();
}
}
}
private static function exportMultiRow ( string $query ) {
$dbStructure = DBStructure :: definition ( self :: getApp () -> getBasePath (), false );
2019-10-11 07:38:42 +02:00
preg_match ( " / \ s+from \ s+`?([a-z \ d_]+)`?/i " , $query , $match );
$table = $match [ 1 ];
$result = [];
$r = q ( $query );
if ( DBA :: isResult ( $r )) {
foreach ( $r as $rr ) {
$p = [];
foreach ( $rr as $k => $v ) {
switch ( $dbStructure [ $table ][ 'fields' ][ $k ][ 'type' ]) {
case 'datetime' :
$p [ $k ] = $v ? ? DBA :: NULL_DATETIME ;
break ;
default :
$p [ $k ] = $v ;
break ;
}
}
$result [] = $p ;
}
}
return $result ;
}
2019-10-17 07:45:48 +02:00
private static function exportRow ( string $query ) {
$dbStructure = DBStructure :: definition ( self :: getApp () -> getBasePath (), false );
2019-10-11 07:38:42 +02:00
preg_match ( " / \ s+from \ s+`?([a-z \ d_]+)`?/i " , $query , $match );
$table = $match [ 1 ];
$result = [];
$r = q ( $query );
if ( DBA :: isResult ( $r )) {
foreach ( $r as $rr ) {
foreach ( $rr as $k => $v ) {
switch ( $dbStructure [ $table ][ 'fields' ][ $k ][ 'type' ]) {
case 'datetime' :
$result [ $k ] = $v ? ? DBA :: NULL_DATETIME ;
break ;
default :
$result [ $k ] = $v ;
break ;
}
}
}
}
return $result ;
}
2019-10-17 07:45:48 +02:00
private static function exportAccount ( App $a ) {
2019-10-11 07:38:42 +02:00
2019-10-17 07:45:48 +02:00
$user = self :: exportRow (
2019-10-11 07:38:42 +02:00
sprintf ( " SELECT * FROM `user` WHERE `uid` = %d LIMIT 1 " , intval ( local_user ()))
);
2019-10-17 07:45:48 +02:00
$contact = self :: exportMultiRow (
2019-10-11 07:38:42 +02:00
sprintf ( " SELECT * FROM `contact` WHERE `uid` = %d " , intval ( local_user ()))
);
2019-10-17 07:45:48 +02:00
$profile = self :: exportMultiRow (
2019-10-11 07:38:42 +02:00
sprintf ( " SELECT * FROM `profile` WHERE `uid` = %d " , intval ( local_user ()))
);
2019-10-17 07:45:48 +02:00
$photo = self :: exportMultiRow (
2019-10-11 07:38:42 +02:00
sprintf ( " SELECT * FROM `photo` WHERE uid = %d AND profile = 1 " , intval ( local_user ()))
);
foreach ( $photo as & $p ) {
$p [ 'data' ] = bin2hex ( $p [ 'data' ]);
}
2019-10-17 07:45:48 +02:00
$pconfig = self :: exportMultiRow (
2019-10-11 07:38:42 +02:00
sprintf ( " SELECT * FROM `pconfig` WHERE uid = %d " , intval ( local_user ()))
);
2019-10-17 07:45:48 +02:00
$group = self :: exportMultiRow (
2019-10-11 07:38:42 +02:00
sprintf ( " SELECT * FROM `group` WHERE uid = %d " , intval ( local_user ()))
);
2019-10-17 07:45:48 +02:00
$group_member = self :: exportMultiRow (
2019-10-11 07:38:42 +02: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 " , intval ( local_user ()))
);
$output = [
'version' => FRIENDICA_VERSION ,
'schema' => DB_UPDATE_VERSION ,
'baseurl' => System :: baseUrl (),
'user' => $user ,
'contact' => $contact ,
'profile' => $profile ,
'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
*
* @ param App $a
* @ throws Exception
*/
2019-10-17 07:45:48 +02:00
private static function exportAll ( App $a ) {
2019-10-11 07:38:42 +02:00
2019-10-17 07:45:48 +02:00
self :: exportAccount ( $a );
2019-10-11 07:38:42 +02:00
echo " \n " ;
2019-10-17 07:45:48 +02:00
$total = DBA :: count ( 'item' , [ 'uid' => local_user ()]);
2019-10-11 07:38:42 +02:00
// chunk the output to avoid exhausting memory
for ( $x = 0 ; $x < $total ; $x += 500 ) {
$r = q ( " SELECT * FROM `item` WHERE `uid` = %d LIMIT %d, %d " ,
intval ( local_user ()),
intval ( $x ),
intval ( 500 )
);
$output = [ 'item' => $r ];
echo json_encode ( $output , JSON_PARTIAL_OUTPUT_ON_ERROR ) . " \n " ;
}
}
}