3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module\Settings;
25 use Friendica\Core\Hook;
26 use Friendica\Core\Renderer;
27 use Friendica\Database\DBA;
28 use Friendica\Database\DBStructure;
30 use Friendica\Module\BaseSettings;
33 * Module to export user data
35 class UserExport extends BaseSettings
38 * Handle the request to export data.
39 * At the moment one can export three different data set
40 * 1. The profile data that can be used by uimport to resettle
41 * to a different Friendica instance
42 * 2. The entire data-set, profile plus postings
43 * 3. A list of contacts as CSV file similar to the export of Mastodon
45 * If there is an action required through the URL / path, react
46 * accordingly and export the requested data.
48 public static function content(array $parameters = [])
50 parent::content($parameters);
53 * options shown on "Export personal data" page
54 * list of array( 'link url', 'link text', 'help text' )
57 ['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.')],
58 ['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 \x28photos are not exported\x29")],
59 ['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.")],
61 Hook::callAll('uexport_options', $options);
63 $tpl = Renderer::getMarkupTemplate("settings/userexport.tpl");
64 return Renderer::replaceMacros($tpl, [
65 '$title' => DI::l10n()->t('Export personal data'),
66 '$options' => $options
70 * raw content generated for the different choices made
71 * by the user. At the moment this returns a JSON file
72 * to the browser which then offers a save / open dialog
75 public static function rawContent(array $parameters = [])
78 if ($args->getArgc() == 3) {
79 // @TODO Replace with router-provided arguments
80 $action = $args->get(2);
81 $user = DI::app()->user;
84 header("Content-type: application/json");
85 header('Content-Disposition: attachment; filename="' . $user['nickname'] . '.' . $action . '"');
86 self::exportAll(DI::app());
90 header("Content-type: application/json");
91 header('Content-Disposition: attachment; filename="' . $user['nickname'] . '.' . $action . '"');
92 self::exportAccount(DI::app());
96 header("Content-type: application/csv");
97 header('Content-Disposition: attachment; filename="' . $user['nickname'] . '-contacts.csv'. '"');
98 self::exportContactsAsCSV();
106 private static function exportMultiRow(string $query)
108 $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
110 preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
114 $rows = DBA::p($query);
115 while ($row = DBA::fetch($rows)) {
117 foreach ($row as $k => $v) {
118 switch ($dbStructure[$table]['fields'][$k]['type']) {
120 $p[$k] = $v ?? DBA::NULL_DATETIME;
133 private static function exportRow(string $query)
135 $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
137 preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
142 if (DBA::isResult($r)) {
144 foreach ($r as $rr) {
145 foreach ($rr as $k => $v) {
146 switch ($dbStructure[$table]['fields'][$k]['type']) {
148 $result[$k] = $v ?? DBA::NULL_DATETIME;
161 * Export a list of the contacts as CSV file as e.g. Mastodon and Pleroma are doing.
163 private static function exportContactsAsCSV()
165 // write the table header (like Mastodon)
166 echo "Account address, Show boosts\n";
167 // get all the contacts
168 $contacts = DBA::select('contact', ['addr'], ['uid' => $_SESSION['uid'], 'self' => false, 'rel' => [1,3], 'deleted' => false]);
169 while ($contact = DBA::fetch($contacts)) {
170 echo $contact['addr'] . ", true\n";
172 DBA::close($contacts);
174 private static function exportAccount(App $a)
176 $user = self::exportRow(
177 sprintf("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval(local_user()))
180 $contact = self::exportMultiRow(
181 sprintf("SELECT * FROM `contact` WHERE `uid` = %d ", intval(local_user()))
185 $profile = self::exportMultiRow(
186 sprintf("SELECT *, 'default' AS `profile_name`, 1 AS `is-default` FROM `profile` WHERE `uid` = %d ", intval(local_user()))
189 $profile_fields = self::exportMultiRow(
190 sprintf("SELECT * FROM `profile_field` WHERE `uid` = %d ", intval(local_user()))
193 $photo = self::exportMultiRow(
194 sprintf("SELECT * FROM `photo` WHERE uid = %d AND profile = 1", intval(local_user()))
196 foreach ($photo as &$p) {
197 $p['data'] = bin2hex($p['data']);
200 $pconfig = self::exportMultiRow(
201 sprintf("SELECT * FROM `pconfig` WHERE uid = %d", intval(local_user()))
204 $group = self::exportMultiRow(
205 sprintf("SELECT * FROM `group` WHERE uid = %d", intval(local_user()))
208 $group_member = self::exportMultiRow(
209 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()))
213 'version' => FRIENDICA_VERSION,
214 'schema' => DB_UPDATE_VERSION,
215 'baseurl' => DI::baseUrl(),
217 'contact' => $contact,
218 'profile' => $profile,
219 'profile_fields' => $profile_fields,
221 'pconfig' => $pconfig,
223 'group_member' => $group_member,
226 echo json_encode($output, JSON_PARTIAL_OUTPUT_ON_ERROR);
230 * echoes account data and items as separated json, one per line
235 private static function exportAll(App $a)
237 self::exportAccount($a);
240 $total = DBA::count('item', ['uid' => local_user()]);
241 // chunk the output to avoid exhausting memory
243 for ($x = 0; $x < $total; $x += 500) {
244 $r = q("SELECT * FROM `item` WHERE `uid` = %d LIMIT %d, %d",
245 intval(local_user()),
250 $output = ['item' => $r];
251 echo json_encode($output, JSON_PARTIAL_OUTPUT_ON_ERROR). "\n";