moved UExport to src/Module/Settings/Uexport

This commit is contained in:
Tobias Diekershoff 2019-10-11 07:38:42 +02:00
parent fb562fc25b
commit 46172b641d
4 changed files with 209 additions and 4 deletions

View File

@ -129,8 +129,8 @@ function settings_init(App $a)
$tabs[] = [ $tabs[] = [
'label' => L10n::t('Export personal data'), 'label' => L10n::t('Export personal data'),
'url' => 'uexport', 'url' => 'settings/uexport',
'selected' => (($a->argc == 1) && ($a->argv[0] === 'uexport')?'active':''), 'selected' => (($a->argc > 1) && ($a->argv[1] === 'uexport')?'active':''),
'accesskey' => 'e', 'accesskey' => 'e',
]; ];

View File

@ -87,8 +87,8 @@ class BaseSettingsModule extends BaseModule
$tabs[] = [ $tabs[] = [
'label' => L10n::t('Export personal data'), 'label' => L10n::t('Export personal data'),
'url' => 'uexport', 'url' => 'settings/uexport',
'selected' => (($a->argc == 1) && ($a->argv[0] === 'uexport') ? 'active' : ''), 'selected' => (($a->argc > 1) && ($a->argv[1] === 'uexport') ? 'active' : ''),
'accesskey' => 'e', 'accesskey' => 'e',
]; ];

View File

@ -0,0 +1,204 @@
<?php
/**
* @file mod/uexport.php
*/
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
**/
public static function content()
{
parent::content();
$args = self::getClass(Arguments::class);
$action = $args->get(2);
if ($args->getArgc() > 2) {
header("Content-type: application/json");
header('Content-Disposition: attachment; filename="' . $a->user['nickname'] . '.' . $action . '"');
switch ($action) {
case "backup":
SELF::uexport_all($a);
exit();
break;
case "account":
SELF::uexport_account($a);
exit();
break;
default:
exit();
}
}
/**
* 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 \x28photos 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
]);
}
private function uexport_multirow($query) {
global $dbStructure;
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;
}
private function uexport_row($query) {
global $dbStructure;
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;
}
private function uexport_account($a) {
echo "<p>in uexport_account</p>";
$user = SELF::uexport_row(
sprintf("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval(local_user()))
);
$contact = SELF::uexport_multirow(
sprintf("SELECT * FROM `contact` WHERE `uid` = %d ", intval(local_user()))
);
$profile = SELF::uexport_multirow(
sprintf("SELECT * FROM `profile` WHERE `uid` = %d ", intval(local_user()))
);
$photo = SELF::uexport_multirow(
sprintf("SELECT * FROM `photo` WHERE uid = %d AND profile = 1", intval(local_user()))
);
foreach ($photo as &$p) {
$p['data'] = bin2hex($p['data']);
}
$pconfig = SELF::uexport_multirow(
sprintf("SELECT * FROM `pconfig` WHERE uid = %d", intval(local_user()))
);
$group = SELF::uexport_multirow(
sprintf("SELECT * FROM `group` WHERE uid = %d", intval(local_user()))
);
$group_member = SELF::uexport_multirow(
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
*/
private function uexport_all(App $a) {
SELF::uexport_account($a);
echo "\n";
$total = 0;
$r = q("SELECT count(*) as `total` FROM `item` WHERE `uid` = %d ",
intval(local_user())
);
if (DBA::isResult($r)) {
$total = $r[0]['total'];
}
// 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";
}
}
}

View File

@ -203,6 +203,7 @@ return [
'/verify' => [Module\Settings\TwoFactor\Verify::class, [R::GET, R::POST]], '/verify' => [Module\Settings\TwoFactor\Verify::class, [R::GET, R::POST]],
], ],
'/delegation[/{action}/{user_id}]' => [Module\Settings\Delegation::class, [R::GET, R::POST]], '/delegation[/{action}/{user_id}]' => [Module\Settings\Delegation::class, [R::GET, R::POST]],
'/uexport[/{action}]' => [Module\Settings\Uexport::class, [R::GET, R::POST]],
], ],
'/randprof' => [Module\RandomProfile::class, [R::GET]], '/randprof' => [Module\RandomProfile::class, [R::GET]],