Add Repair step to regenerate birthday calendar

Signed-off-by: Georg Ehrke <developer@georgehrke.com>

3 files changed, 106 insertions, 3 deletions

diff --git a/apps/dav/lib/BackgroundJob/GenerateBirthdayCalendarBackgroundJob.php b/apps/dav/lib/BackgroundJob/GenerateBirthdayCalendarBackgroundJob.php
index c4279c5108c..dd6fca73c8f 100644
--- a/apps/dav/lib/BackgroundJob/GenerateBirthdayCalendarBackgroundJob.php
+++ b/apps/dav/lib/BackgroundJob/GenerateBirthdayCalendarBackgroundJob.php
@@ -51,6 +51,7 @@ class GenerateBirthdayCalendarBackgroundJob extends QueuedJob {
 	 */
 	public function run($arguments) {
 		$userId = $arguments['userId'];
+		$purgeBeforeGenerating = $arguments['purgeBeforeGenerating'] ?? false;
 
 		// make sure admin didn't change his mind
 		$isGloballyEnabled = $this->config->getAppValue('dav', 'generateBirthdayCalendar', 'yes');
@@ -64,6 +65,10 @@ class GenerateBirthdayCalendarBackgroundJob extends QueuedJob {
 			return;
 		}
 
+		if ($purgeBeforeGenerating) {
+			$this->birthdayService->resetForUser($userId);
+		}
+
 		$this->birthdayService->syncUser($userId);
 	}
 }
diff --git a/apps/dav/lib/CalDAV/BirthdayService.php b/apps/dav/lib/CalDAV/BirthdayService.php
index 25cf19b460d..0e8926e775a 100644
--- a/apps/dav/lib/CalDAV/BirthdayService.php
+++ b/apps/dav/lib/CalDAV/BirthdayService.php
@@ -137,9 +137,9 @@ class BirthdayService {
 	 * @throws \Sabre\DAV\Exception\BadRequest
 	 */
 	public function ensureCalendarExists($principal) {
-		$book = $this->calDavBackEnd->getCalendarByUri($principal, self::BIRTHDAY_CALENDAR_URI);
-		if (!is_null($book)) {
-			return $book;
+		$calendar = $this->calDavBackEnd->getCalendarByUri($principal, self::BIRTHDAY_CALENDAR_URI);
+		if (!is_null($calendar)) {
+			return $calendar;
 		}
 		$this->calDavBackEnd->createCalendar($principal, self::BIRTHDAY_CALENDAR_URI, [
 			'{DAV:}displayname' => 'Contact birthdays',
@@ -273,6 +273,19 @@ class BirthdayService {
 	/**
 	 * @param string $user
 	 */
+	public function resetForUser($user) {
+		$principal = 'principals/users/'.$user;
+		$calendar = $this->calDavBackEnd->getCalendarByUri($principal, self::BIRTHDAY_CALENDAR_URI);
+		$calendarObjects = $this->calDavBackEnd->getCalendarObjects($calendar['id'], CalDavBackend::CALENDAR_TYPE_CALENDAR);
+
+		foreach($calendarObjects as $calendarObject) {
+			$this->calDavBackEnd->deleteCalendarObject($calendar['id'], $calendarObject['uri'], CalDavBackend::CALENDAR_TYPE_CALENDAR);
+		}
+	}
+
+	/**
+	 * @param string $user
+	 */
 	public function syncUser($user) {
 		$principal = 'principals/users/'.$user;
 		$this->ensureCalendarExists($principal);
diff --git a/apps/dav/lib/Migration/RegenerateBirthdayCalendars.php b/apps/dav/lib/Migration/RegenerateBirthdayCalendars.php
new file mode 100644
index 00000000000..2c2b4eb0e9a
--- /dev/null
+++ b/apps/dav/lib/Migration/RegenerateBirthdayCalendars.php
@@ -0,0 +1,85 @@
+<?php
+/**
+ * @copyright 2019 Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.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 OCA\DAV\Migration;
+
+use OCA\DAV\BackgroundJob\GenerateBirthdayCalendarBackgroundJob;
+use OCP\BackgroundJob\IJobList;
+use OCP\IConfig;
+use OCP\IUser;
+use OCP\IUserManager;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class RegenerateBirthdayCalendars implements IRepairStep {
+
+	/** @var IUserManager */
+	private $userManager;
+
+	/** @var IJobList */
+	private $jobList;
+
+	/** @var IConfig */
+	private $config;
+
+	/**
+	 * @param IUserManager $userManager,
+	 * @param IJobList $jobList
+	 * @param IConfig $config
+	 */
+	public function __construct(IUserManager $userManager,
+								IJobList $jobList,
+								IConfig $config) {
+		$this->userManager = $userManager;
+		$this->jobList = $jobList;
+		$this->config = $config;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName() {
+		return 'Regenerating birthday calendars to use new icons and fix old birthday events without year';
+	}
+
+	/**
+	 * @param IOutput $output
+	 */
+	public function run(IOutput $output) {
+		// only run once
+		if ($this->config->getAppValue('dav', 'regeneratedBirthdayCalendarsForYearFix') === 'yes') {
+			$output->info('Repair step already executed');
+			return;
+		}
+
+		$output->info('Adding background jobs to regenerate birthday calendar');
+		$this->userManager->callForAllUsers(function(IUser $user) {
+			$this->jobList->add(GenerateBirthdayCalendarBackgroundJob::class, [
+				'userId' => $user->getUID(),
+				'purgeBeforeGenerating' => true
+			]);
+		});
+
+		// if all were done, no need to redo the repair during next upgrade
+		$this->config->setAppValue('dav', 'regeneratedBirthdayCalendarsForYearFix', 'yes');
+	}
+}
\ No newline at end of file