-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22222 from nextcloud/enh/social-index
re-index contacts with social profiles
- Loading branch information
Showing
5 changed files
with
221 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
<?php | ||
/** | ||
* @copyright 2017 Georg Ehrke <oc.list@georgehrke.com> | ||
* | ||
* @author Georg Ehrke <oc.list@georgehrke.com> | ||
* @author Morris Jobke <hey@morrisjobke.de> | ||
* @author Roeland Jago Douma <roeland@famdouma.nl> | ||
* | ||
* @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 OCA\DAV\Migration; | ||
|
||
use OCP\BackgroundJob\IJobList; | ||
use OCP\IConfig; | ||
use OCP\IDBConnection; | ||
use OCP\Migration\IOutput; | ||
use OCP\Migration\IRepairStep; | ||
|
||
class BuildSocialSearchIndex implements IRepairStep { | ||
|
||
/** @var IDBConnection */ | ||
private $db; | ||
|
||
/** @var IJobList */ | ||
private $jobList; | ||
|
||
/** @var IConfig */ | ||
private $config; | ||
|
||
/** | ||
* @param IDBConnection $db | ||
* @param IJobList $jobList | ||
* @param IConfig $config | ||
*/ | ||
public function __construct(IDBConnection $db, | ||
IJobList $jobList, | ||
IConfig $config) { | ||
$this->db = $db; | ||
$this->jobList = $jobList; | ||
$this->config = $config; | ||
} | ||
|
||
/** | ||
* @return string | ||
*/ | ||
public function getName() { | ||
return 'Register building of social profile search index as background job'; | ||
} | ||
|
||
/** | ||
* @param IOutput $output | ||
*/ | ||
public function run(IOutput $output) { | ||
// only run once | ||
if ($this->config->getAppValue('dav', 'builtSocialSearchIndex') === 'yes') { | ||
$output->info('Repair step already executed'); | ||
return; | ||
} | ||
|
||
$query = $this->db->getQueryBuilder(); | ||
$query->select($query->func()->max('cardid')) | ||
->from('cards_properties') | ||
->where($query->expr()->eq('name', $query->createNamedParameter('X-SOCIALPROFILE'))); | ||
$maxId = (int)$query->execute()->fetchColumn(); | ||
|
||
if ($maxId === 0) { | ||
return; | ||
} | ||
|
||
$output->info('Add background job'); | ||
$this->jobList->add(BuildSocialSearchIndexBackgroundJob::class, [ | ||
'offset' => 0, | ||
'stopAt' => $maxId | ||
]); | ||
|
||
// no need to redo the repair during next upgrade | ||
$this->config->setAppValue('dav', 'builtSocialSearchIndex', 'yes'); | ||
} | ||
} |
122 changes: 122 additions & 0 deletions
122
apps/dav/lib/Migration/BuildSocialSearchIndexBackgroundJob.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
<?php | ||
/** | ||
* @copyright 2020 Matthias Heinisch <nextcloud@matthiasheinisch.de> | ||
* | ||
* @author Matthias Heinisch <nextcloud@matthiasheinisch.de> | ||
* | ||
* @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 OCA\DAV\Migration; | ||
|
||
use OC\BackgroundJob\QueuedJob; | ||
use OCA\DAV\CardDAV\CardDavBackend; | ||
use OCP\AppFramework\Utility\ITimeFactory; | ||
use OCP\BackgroundJob\IJobList; | ||
use OCP\IDBConnection; | ||
use OCP\ILogger; | ||
|
||
class BuildSocialSearchIndexBackgroundJob extends QueuedJob { | ||
|
||
/** @var IDBConnection */ | ||
private $db; | ||
|
||
/** @var CardDavBackend */ | ||
private $davBackend; | ||
|
||
/** @var ILogger */ | ||
private $logger; | ||
|
||
/** @var IJobList */ | ||
private $jobList; | ||
|
||
/** @var ITimeFactory */ | ||
private $timeFactory; | ||
|
||
/** | ||
* @param IDBConnection $db | ||
* @param CardDavBackend $davBackend | ||
* @param ILogger $logger | ||
* @param IJobList $jobList | ||
* @param ITimeFactory $timeFactory | ||
*/ | ||
public function __construct(IDBConnection $db, | ||
CardDavBackend $davBackend, | ||
ILogger $logger, | ||
IJobList $jobList, | ||
ITimeFactory $timeFactory) { | ||
$this->db = $db; | ||
$this->davBackend = $davBackend; | ||
$this->logger = $logger; | ||
$this->jobList = $jobList; | ||
$this->timeFactory = $timeFactory; | ||
} | ||
|
||
public function run($arguments) { | ||
$offset = $arguments['offset']; | ||
$stopAt = $arguments['stopAt']; | ||
|
||
$this->logger->info('Indexing social profile data (' . $offset .'/' . $stopAt . ')'); | ||
|
||
$offset = $this->buildIndex($offset, $stopAt); | ||
|
||
if ($offset >= $stopAt) { | ||
$this->logger->info('All contacts with social profiles indexed'); | ||
} else { | ||
$this->jobList->add(self::class, [ | ||
'offset' => $offset, | ||
'stopAt' => $stopAt | ||
]); | ||
$this->logger->info('New social profile indexing job scheduled with offset ' . $offset); | ||
} | ||
} | ||
|
||
/** | ||
* @param int $offset | ||
* @param int $stopAt | ||
* @return int | ||
*/ | ||
private function buildIndex($offset, $stopAt) { | ||
$startTime = $this->timeFactory->getTime(); | ||
|
||
// get contacts with social profiles | ||
$query = $this->db->getQueryBuilder(); | ||
$query->select('id', 'addressbookid', 'uri', 'carddata') | ||
->from('cards', 'c') | ||
->orderBy('id', 'ASC') | ||
->where($query->expr()->like('carddata', $query->createNamedParameter('%SOCIALPROFILE%'))) | ||
->setMaxResults(100); | ||
$social_cards = $query->execute()->fetchAll(); | ||
|
||
if (empty($social_cards)) { | ||
return $stopAt; | ||
} | ||
|
||
// refresh identified contacts in order to re-index | ||
foreach ($social_cards as $contact) { | ||
$offset = $contact['id']; | ||
$this->davBackend->updateCard($contact['addressbookid'], $contact['uri'], $contact['carddata']); | ||
|
||
// stop after 15sec (to be continued with next chunk) | ||
if (($this->timeFactory->getTime() - $startTime) > 15) { | ||
break; | ||
} | ||
} | ||
|
||
return $offset; | ||
} | ||
} |