nextcloud/lib/private/Repair/NC15/SetVcardDatabaseUID.php

155 lines
3.9 KiB
PHP
Raw Normal View History

<?php
/**
* @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Repair\NC15;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\ILogger;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
use Sabre\VObject\Reader;
use Sabre\VObject\ParseException;
class SetVcardDatabaseUID implements IRepairStep {
const MAX_ROWS = 1000;
/** @var IDBConnection */
private $connection;
/** @var IConfig */
private $config;
/** @var ILogger */
private $logger;
private $updateQuery;
public function __construct(IDBConnection $connection, IConfig $config, ILogger $logger) {
$this->connection = $connection;
$this->config = $config;
$this->logger = $logger;
}
public function getName() {
return 'Extract the vcard uid and store it in the db';
}
/**
* @return \Generator
* @suppress SqlInjectionChecker
*/
private function getInvalidEntries() {
$builder = $this->connection->getQueryBuilder();
$builder->select('id', 'carddata')
->from('cards')
->where($builder->expr()->isNull('uid'))
->setMaxResults(self::MAX_ROWS);
do {
$result = $builder->execute();
$rows = $result->fetchAll();
foreach ($rows as $row) {
yield $row;
}
$result->closeCursor();
} while (count($rows) > 0);
}
/**
* Extract UID from vcard
*
* @param string $cardData the vcard raw data
* @param IOutput $output the output logger
* @return string the uid or empty if none
*/
private function getUID(string $cardData, IOutput $output): string {
try {
$vCard = Reader::read($cardData);
if ($vCard->UID) {
$uid = $vCard->UID->getValue();
return $uid;
}
} catch (ParseException $e) {
$output->warning('One vCard is broken. We logged the exception and will continue the repair.');
$this->logger->logException($e);
}
return '';
}
/**
* @param int $id
* @param string $uid
*/
private function update(int $id, string $uid) {
if (!$this->updateQuery) {
$builder = $this->connection->getQueryBuilder();
$this->updateQuery = $builder->update('cards')
->set('uid', $builder->createParameter('uid'))
->where($builder->expr()->eq('id', $builder->createParameter('id')));
}
$this->updateQuery->setParameter('id', $id);
$this->updateQuery->setParameter('uid', $uid);
$this->updateQuery->execute();
}
private function repair(IOutput $output): int {
$this->connection->beginTransaction();
$entries = $this->getInvalidEntries();
$count = 0;
foreach ($entries as $entry) {
$count++;
$cardData = $entry['carddata'];
if (is_resource($cardData)) {
$cardData = stream_get_contents($cardData);
}
$uid = $this->getUID($cardData, $output);
$this->update($entry['id'], $uid);
}
$this->connection->commit();
return $count;
}
private function shouldRun() {
$versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0.0');
// was added to 15.0.0.2
return version_compare($versionFromBeforeUpdate, '15.0.0.2', '<=');
}
public function run(IOutput $output) {
if ($this->shouldRun()) {
$count = $this->repair($output);
$output->info('Fixed ' . $count . ' vcards');
}
}
}