src/Module/Settings/UserExport.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\Settings;
  23
  24 use Friendica\App;
  25 use Friendica\Core\Hook;
  26 use Friendica\Core\Renderer;
  27 use Friendica\Database\DBA;
  28 use Friendica\Database\DBStructure;
  29 use Friendica\DI;
  30 use Friendica\Model\Item;
  31 use Friendica\Module\BaseSettings;
  32
  33 /**
  34  * Module to export user data
  35  **/
  36 class UserExport extends BaseSettings
  37 {
  38         /**
  39          * Handle the request to export data.
  40          * At the moment one can export three different data set
  41          * 1. The profile data that can be used by uimport to resettle
  42          *    to a different Friendica instance
  43          * 2. The entire data-set, profile plus postings
  44          * 3. A list of contacts as CSV file similar to the export of Mastodon
  45          *
  46          * If there is an action required through the URL / path, react
  47          * accordingly and export the requested data.
  48          **/
  49         public static function content(array $parameters = [])
  50         {
  51                 parent::content($parameters);
  52
  53                 /**
  54                  * options shown on "Export personal data" page
  55                  * list of array( 'link url', 'link text', 'help text' )
  56                  */
  57                 $options = [
  58                         ['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.')],
  59                         ['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")],
  60                         ['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                 ];
  62                 Hook::callAll('uexport_options', $options);
  63
  64                 $tpl = Renderer::getMarkupTemplate("settings/userexport.tpl");
  65                 return Renderer::replaceMacros($tpl, [
  66                         '$title' => DI::l10n()->t('Export personal data'),
  67                         '$options' => $options
  68                 ]);
  69         }
  70         /**
  71          * raw content generated for the different choices made
  72          * by the user. At the moment this returns a JSON file
  73          * to the browser which then offers a save / open dialog
  74          * to the user.
  75          **/
  76         public static function rawContent(array $parameters = [])
  77         {
  78                 $args = DI::args();
  79                 if ($args->getArgc() == 3) {
  80                         // @TODO Replace with router-provided arguments
  81                         $action = $args->get(2);
  82                         $user = DI::app()->user;
  83                         switch ($action) {
  84                                 case "backup":
  85                                         header("Content-type: application/json");
  86                                         header('Content-Disposition: attachment; filename="' . $user['nickname'] . '.' . $action . '"');
  87                                         self::exportAll(DI::app());
  88                                         exit();
  89                                         break;
  90                                 case "account":
  91                                         header("Content-type: application/json");
  92                                         header('Content-Disposition: attachment; filename="' . $user['nickname'] . '.' . $action . '"');
  93                                         self::exportAccount(DI::app());
  94                                         exit();
  95                                         break;
  96                                 case "contact":
  97                                         header("Content-type: application/csv");
  98                                         header('Content-Disposition: attachment; filename="' . $user['nickname'] . '-contacts.csv'. '"');
  99                                         self::exportContactsAsCSV();
 100                                         exit();
 101                                         break;
 102                                 default:
 103                                         exit();
 104                         }
 105                 }
 106         }
 107         private static function exportMultiRow(string $query)
 108         {
 109                 $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
 110
 111                 preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
 112                 $table = $match[1];
 113
 114                 $result = [];
 115                 $rows = DBA::p($query);
 116                 while ($row = DBA::fetch($rows)) {
 117                         $p = [];
 118                         foreach ($dbStructure[$table]['fields'] as $column => $field) {
 119                                 if (!isset($row[$column])) {
 120                                         continue;
 121                                 }
 122                                 if ($field['type'] == 'datetime') {
 123                                         $p[$column] = $row[$column] ?? DBA::NULL_DATETIME;
 124                                 } else {
 125                                         $p[$column] = $row[$column];
 126                                 }
 127                         }
 128                         $result[] = $p;
 129                 }
 130                 DBA::close($rows);
 131                 return $result;
 132         }
 133
 134         private static function exportRow(string $query)
 135         {
 136                 $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
 137
 138                 preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
 139                 $table = $match[1];
 140
 141                 $result = [];
 142                 $r = q($query);
 143                 if (DBA::isResult($r)) {
 144
 145                         foreach ($r as $rr) {
 146                                 foreach ($rr as $k => $v) {
 147                                         if (empty($dbStructure[$table]['fields'][$k])) {
 148                                                 continue;
 149                                         }
 150                                         switch ($dbStructure[$table]['fields'][$k]['type']) {
 151                                                 case 'datetime':
 152                                                         $result[$k] = $v ?? DBA::NULL_DATETIME;
 153                                                         break;
 154                                                 default:
 155                                                         $result[$k] = $v;
 156                                                         break;
 157                                         }
 158                                 }
 159                         }
 160                 }
 161                 return $result;
 162         }
 163
 164         /**
 165          * Export a list of the contacts as CSV file as e.g. Mastodon and Pleroma are doing.
 166          **/
 167         private static function exportContactsAsCSV()
 168         {
 169                 // write the table header (like Mastodon)
 170                 echo "Account address, Show boosts\n";
 171                 // get all the contacts
 172                 $contacts = DBA::select('contact', ['addr', 'url'], ['uid' => $_SESSION['uid'], 'self' => false, 'rel' => [1,3], 'deleted' => false]);
 173                 while ($contact = DBA::fetch($contacts)) {
 174                         echo ($contact['addr'] ?: $contact['url']) . ", true\n";
 175                 }
 176                 DBA::close($contacts);
 177         }
 178         private static function exportAccount(App $a)
 179         {
 180                 $user = self::exportRow(
 181                         sprintf("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1", intval(local_user()))
 182                 );
 183
 184                 $contact = self::exportMultiRow(
 185                         sprintf("SELECT * FROM `contact` WHERE `uid` = %d ", intval(local_user()))
 186                 );
 187
 188
 189                 $profile = self::exportMultiRow(
 190                         sprintf("SELECT *, 'default' AS `profile_name`, 1 AS `is-default` FROM `profile` WHERE `uid` = %d ", intval(local_user()))
 191                 );
 192
 193                 $profile_fields = self::exportMultiRow(
 194                         sprintf("SELECT * FROM `profile_field` WHERE `uid` = %d ", intval(local_user()))
 195                 );
 196
 197                 $photo = self::exportMultiRow(
 198                         sprintf("SELECT * FROM `photo` WHERE uid = %d AND profile = 1", intval(local_user()))
 199                 );
 200                 foreach ($photo as &$p) {
 201                         $p['data'] = bin2hex($p['data']);
 202                 }
 203
 204                 $pconfig = self::exportMultiRow(
 205                         sprintf("SELECT * FROM `pconfig` WHERE uid = %d", intval(local_user()))
 206                 );
 207
 208                 $group = self::exportMultiRow(
 209                         sprintf("SELECT * FROM `group` WHERE uid = %d", intval(local_user()))
 210                 );
 211
 212                 $group_member = self::exportMultiRow(
 213                         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()))
 214                 );
 215
 216                 $output = [
 217                         'version' => FRIENDICA_VERSION,
 218                         'schema' => DB_UPDATE_VERSION,
 219                         'baseurl' => DI::baseUrl(),
 220                         'user' => $user,
 221                         'contact' => $contact,
 222                         'profile' => $profile,
 223                         'profile_fields' => $profile_fields,
 224                         'photo' => $photo,
 225                         'pconfig' => $pconfig,
 226                         'group' => $group,
 227                         'group_member' => $group_member,
 228                 ];
 229
 230                 echo json_encode($output, JSON_PARTIAL_OUTPUT_ON_ERROR);
 231         }
 232
 233         /**
 234          * echoes account data and items as separated json, one per line
 235          *
 236          * @param App $a
 237          * @throws \Exception
 238          */
 239         private static function exportAll(App $a)
 240         {
 241                 self::exportAccount($a);
 242                 echo "\n";
 243
 244                 $total = DBA::count('item', ['uid' => local_user()]);
 245                 // chunk the output to avoid exhausting memory
 246
 247                 for ($x = 0; $x < $total; $x += 500) {
 248                         $items = Item::selectToArray(Item::ITEM_FIELDLIST, ['uid' => local_user()], ['limit' => [$x, 500]]);
 249                         $output = ['item' => $items];
 250                         echo json_encode($output, JSON_PARTIAL_OUTPUT_ON_ERROR). "\n";
 251                 }
 252         }
 253 }