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\Model\Item;
31 use Friendica\Model\Post;
32 use Friendica\Module\BaseSettings;
35 * Module to export user data
37 class UserExport extends BaseSettings
40 * Handle the request to export data.
41 * At the moment one can export three different data set
42 * 1. The profile data that can be used by uimport to resettle
43 * to a different Friendica instance
44 * 2. The entire data-set, profile plus postings
45 * 3. A list of contacts as CSV file similar to the export of Mastodon
47 * If there is an action required through the URL / path, react
48 * accordingly and export the requested data.
50 public static function content(array $parameters = [])
52 parent::content($parameters);
55 * options shown on "Export personal data" page
56 * list of array( 'link url', 'link text', 'help text' )
59 ['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.')],
60 ['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")],
61 ['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.")],
63 Hook::callAll('uexport_options', $options);
65 $tpl = Renderer::getMarkupTemplate("settings/userexport.tpl");
66 return Renderer::replaceMacros($tpl, [
67 '$title' => DI::l10n()->t('Export personal data'),
68 '$options' => $options
72 * raw content generated for the different choices made
73 * by the user. At the moment this returns a JSON file
74 * to the browser which then offers a save / open dialog
77 public static function rawContent(array $parameters = [])
80 if ($args->getArgc() == 3) {
81 // @TODO Replace with router-provided arguments
82 $action = $args->get(2);
83 $user = DI::app()->user;
86 header("Content-type: application/json");
87 header('Content-Disposition: attachment; filename="' . $user['nickname'] . '.' . $action . '"');
88 self::exportAll(DI::app());
92 header("Content-type: application/json");
93 header('Content-Disposition: attachment; filename="' . $user['nickname'] . '.' . $action . '"');
94 self::exportAccount(DI::app());
98 header("Content-type: application/csv");
99 header('Content-Disposition: attachment; filename="' . $user['nickname'] . '-contacts.csv'. '"');
100 self::exportContactsAsCSV();
108 private static function exportMultiRow(string $query)
110 $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
112 preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
116 $rows = DBA::p($query);
117 while ($row = DBA::fetch($rows)) {
119 foreach ($dbStructure[$table]['fields'] as $column => $field) {
120 if (!isset($row[$column])) {
123 if ($field['type'] == 'datetime') {
124 $p[$column] = $row[$column] ?? DBA::NULL_DATETIME;
126 $p[$column] = $row[$column];
135 private static function exportRow(string $query)
137 $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
139 preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
144 if (DBA::isResult($r)) {
146 foreach ($r as $rr) {
147 foreach ($rr as $k => $v) {
148 if (empty($dbStructure[$table]['fields'][$k])) {
151 switch ($dbStructure[$table]['fields'][$k]['type']) {
153 $result[$k] = $v ?? DBA::NULL_DATETIME;
166 * Export a list of the contacts as CSV file as e.g. Mastodon and Pleroma are doing.
168 private static function exportContactsAsCSV()
170 // write the table header (like Mastodon)
171 echo "Account address, Show boosts\n";
172 // get all the contacts
173 $contacts = DBA::select('contact', ['addr', 'url'], ['uid' => $_SESSION['uid'], 'self' => false, 'rel' => [1,3], 'deleted' => false]);
174 while ($contact = DBA::fetch($contacts)) {
175 echo ($contact['addr'] ?: $contact['url']) . ", true\n";
177 DBA::close($contacts);
179 private static function exportAccount(App $a)
181 $user = self::exportRow(
182 sprintf("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval(local_user()))
185 $contact = self::exportMultiRow(
186 sprintf("SELECT * FROM `contact` WHERE `uid` = %d ", intval(local_user()))
190 $profile = self::exportMultiRow(
191 sprintf("SELECT *, 'default' AS `profile_name`, 1 AS `is-default` FROM `profile` WHERE `uid` = %d ", intval(local_user()))
194 $profile_fields = self::exportMultiRow(
195 sprintf("SELECT * FROM `profile_field` WHERE `uid` = %d ", intval(local_user()))
198 $photo = self::exportMultiRow(
199 sprintf("SELECT * FROM `photo` WHERE uid = %d AND profile = 1", intval(local_user()))
201 foreach ($photo as &$p) {
202 $p['data'] = bin2hex($p['data']);
205 $pconfig = self::exportMultiRow(
206 sprintf("SELECT * FROM `pconfig` WHERE uid = %d", intval(local_user()))
209 $group = self::exportMultiRow(
210 sprintf("SELECT * FROM `group` WHERE uid = %d", intval(local_user()))
213 $group_member = self::exportMultiRow(
214 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()))
218 'version' => FRIENDICA_VERSION,
219 'schema' => DB_UPDATE_VERSION,
220 'baseurl' => DI::baseUrl(),
222 'contact' => $contact,
223 'profile' => $profile,
224 'profile_fields' => $profile_fields,
226 'pconfig' => $pconfig,
228 'group_member' => $group_member,
231 echo json_encode($output, JSON_PARTIAL_OUTPUT_ON_ERROR);
235 * echoes account data and items as separated json, one per line
240 private static function exportAll(App $a)
242 self::exportAccount($a);
245 $total = Post::count(['uid' => local_user()]);
246 // chunk the output to avoid exhausting memory
248 for ($x = 0; $x < $total; $x += 500) {
249 $items = Post::selectToArray(Item::ITEM_FIELDLIST, ['uid' => local_user()], ['limit' => [$x, 500]]);
250 $output = ['item' => $items];
251 echo json_encode($output, JSON_PARTIAL_OUTPUT_ON_ERROR). "\n";