Merge pull request #32443 from nextcloud/port/background-job-admin

3 files changed, 217 insertions, 17 deletions

diff --git a/apps/settings/src/admin.js b/apps/settings/src/admin.js
index 8012dcb8863..833ed3e1ea9 100644
--- a/apps/settings/src/admin.js
+++ b/apps/settings/src/admin.js
@@ -14,22 +14,6 @@ window.addEventListener('DOMContentLoaded', () => {
 		})
 	})
 
-	$('#backgroundjobs span.crondate').tooltip({ placement: 'top' })
-
-	$('#backgroundjobs input').change(() => {
-		if ($(this).is(':checked')) {
-			const mode = $(this).val()
-			if (mode === 'ajax' || mode === 'webcron' || mode === 'cron') {
-				OCP.AppConfig.setValue('core', 'backgroundjobs_mode', mode, {
-					success: () => {
-						// clear cron errors on background job mode change
-						OCP.AppConfig.deleteKey('core', 'cronErrors')
-					}
-				})
-			}
-		}
-	})
-
 	$('#shareAPIEnabled').change(() => {
 		$('#shareAPI p:not(#enable)').toggleClass('hidden', !this.checked)
 	})
diff --git a/apps/settings/src/components/BasicSettings/BackgroundJob.vue b/apps/settings/src/components/BasicSettings/BackgroundJob.vue
new file mode 100644
index 00000000000..5413db38f91
--- /dev/null
+++ b/apps/settings/src/components/BasicSettings/BackgroundJob.vue
@@ -0,0 +1,212 @@
+<!--
+	- @copyright 2022 Carl Schwan <carl@carlschwan.eu>
+	-
+	- @author Carl Schwan <carl@carlschwan.eu>
+	-
+	- @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/>.
+	-
+-->
+
+<template>
+	<SettingsSection :title="t('settings', 'Background jobs')"
+		:description="t('settings', `For the server to work properly, it's important to configure background jobs correctly. Cron is the recommended setting. Please see the documentation for more information.`)"
+		:doc-url="backgroundJobsDocUrl">
+
+		<template v-if="lastCron !== 0">
+			<span v-if="oldExecution" class="error">
+				{{ t('settings', 'Last job execution ran {time}. Something seems wrong.', {time: relativeTime}) }}
+			</span>
+
+			<span v-else-if="longExecutionNotCron" class="warning">
+				{{ t('settings', "Some jobs haven’t been executed since {maxAgeRelativeTime}. Please consider increasing the execution frequency.", {maxAgeRelativeTime}) }}
+			</span>
+
+			<span class="warning" v-else-if="longExecutionCron">
+				{{ t('settings', "Some jobs haven’t been executed since {maxAgeRelativeTime}. Please consider switching to system cron.", {maxAgeRelativeTime}) }}
+			</span>
+
+			<span v-else>
+				{{ t('settings', 'Last job ran {relativeTime}.', {relativeTime}) }}
+			</span>
+		</template>
+
+		<span class="error" v-else>
+			{{ t('settings', 'Background job didn’t run yet!') }}
+		</span>
+
+		<CheckboxRadioSwitch type="radio"
+			:checked.sync="backgroundJobsMode"
+			name="backgroundJobsMode"
+			value="ajax"
+			class="ajaxSwitch"
+			@update:checked="onBackgroundJobModeChanged">
+			{{ t('settings', 'AJAX') }}
+		</CheckboxRadioSwitch>
+		<em>{{ t('settings', 'Execute one task with each page loaded. Use case: Single user instance.') }}</em>
+
+		<CheckboxRadioSwitch type="radio"
+			:checked.sync="backgroundJobsMode"
+			name="backgroundJobsMode"
+			value="webcron"
+			@update:checked="onBackgroundJobModeChanged">
+			{{ t('settings', 'Webcron') }}
+		</CheckboxRadioSwitch>
+		<em>{{ t('settings', 'cron.php is registered at a webcron service to call cron.php every 5 minutes over HTTP. Use case: Very small instance (1–5 users depending on the usage).') }}</em>
+
+		<CheckboxRadioSwitch type="radio"
+			:checked.sync="backgroundJobsMode"
+			value="cron"
+			name="backgroundJobsMode"
+			v-if="cliBasedCronPossible"
+			@update:checked="onBackgroundJobModeChanged">
+			{{ t('settings', 'Cron (Recommended)') }}
+		</CheckboxRadioSwitch>
+		<em v-if="cliBasedCronPossible">{{ cronLabel }}</em>
+		<em v-else>
+			{{ t('settings', 'To run this you need the PHP POSIX extension. See {linkstart}PHP documentation{linkend} for more details.', {
+				linkstart: '<a href="https://www.php.net/manual/en/book.posix.php">',
+				linkend: '</a>',
+			}) }}
+		</em>
+	</SettingsSection>
+</template>
+
+<script>
+import { loadState } from '@nextcloud/initial-state'
+import { showError } from '@nextcloud/dialogs'
+import CheckboxRadioSwitch from '@nextcloud/vue/dist/Components/CheckboxRadioSwitch'
+import SettingsSection from '@nextcloud/vue/dist/Components/SettingsSection'
+import moment from '@nextcloud/moment'
+import axios from '@nextcloud/axios'
+import { generateOcsUrl } from '@nextcloud/router'
+import confirmPassword from '@nextcloud/password-confirmation'
+
+const lastCron = loadState('settings', 'lastCron')
+const cronMaxAge = loadState('settings', 'cronMaxAge', '')
+const backgroundJobsMode = loadState('settings', 'backgroundJobsMode', 'cron')
+const cliBasedCronPossible = loadState('settings', 'cliBasedCronPossible', true)
+const cliBasedCronUser = loadState('settings', 'cliBasedCronUser', 'www-data')
+const backgroundJobsDocUrl = loadState('settings', 'backgroundJobsDocUrl')
+
+export default {
+	name: 'BackgroundJob',
+
+	components: {
+		CheckboxRadioSwitch,
+		SettingsSection,
+	},
+
+	data() {
+		return {
+			lastCron,
+			cronMaxAge,
+			backgroundJobsMode,
+			cliBasedCronPossible,
+			cliBasedCronUser,
+			backgroundJobsDocUrl,
+			relativeTime: moment(lastCron * 1000).fromNow(),
+			maxAgeRelativeTime: moment(cronMaxAge * 1000).fromNow(),
+		}
+	},
+	computed: {
+		cronLabel() {
+			let desc = t('settings', 'Use system cron service to call the cron.php file every 5 minutes. Recommended for all instances.')
+			if (this.cliBasedCronPossible) {
+				desc += ' ' + t('settings', 'The cron.php needs to be executed by the system user "{user}".', { user: this.cliBasedCronUser })
+			}
+			return desc
+		},
+		oldExecution() {
+			return Date.now() / 1000 - this.lastCron > 600
+		},
+		longExecutionNotCron() {
+			return Date.now() / 1000 - this.cronMaxAge > 12 * 3600 && this.backgroundJobsMode !== 'cron'
+		},
+		longExecutionCron() {
+			return Date.now() / 1000 - this.cronMaxAge > 12 * 3600 && this.backgroundJobsMode === 'cron'
+		}
+	},
+	methods: {
+		async onBackgroundJobModeChanged(backgroundJobsMode) {
+			const url = generateOcsUrl('/apps/provisioning_api/api/v1/config/apps/{appId}/{key}', {
+				appId: 'core',
+				key: 'backgroundjobs_mode',
+			})
+
+			await confirmPassword()
+
+			try {
+				const { data } = await axios.post(url, {
+					value: backgroundJobsMode
+				})
+				this.handleResponse({
+					status: data.ocs?.meta?.status
+				})
+			} catch (e) {
+				this.handleResponse({
+					errorMessage: t('settings', 'Unable to update background job mode'),
+					error: e,
+				})
+			}
+		},
+		async handleResponse({ status, errorMessage, error }) {
+			if (status === 'ok') {
+				await this.deleteError()
+			} else {
+				showError(errorMessage)
+				console.error(errorMessage, error)
+			}
+		},
+		async deleteError() {
+			// clear cron errors on background job mode change
+			const url = generateOcsUrl('/apps/provisioning_api/api/v1/config/apps/{appId}/{key}', {
+				appId: 'core',
+				key: 'cronErrors',
+			})
+
+			await confirmPassword()
+
+			try {
+				await axios.delete(url)
+			} catch (error) {
+				console.error(error)
+			}
+		}
+	},
+}
+</script>
+
+<style lang="scss" scoped>
+.error {
+	margin-top: 8px;
+	padding: 5px;
+	border-radius: var(--border-radius);
+	color: var(--color-primary-text);
+	background-color: var(--color-error);
+	width: initial;
+}
+.warning {
+	margin-top: 8px;
+	padding: 5px;
+	border-radius: var(--border-radius);
+	color: var(--color-primary-text);
+	background-color: var(--color-warning);
+	width: initial;
+}
+.ajaxSwitch {
+	margin-top: 1rem;
+}
+</style>
diff --git a/apps/settings/src/main-admin-basic-settings.js b/apps/settings/src/main-admin-basic-settings.js
index 522ca392e77..5a694f54e90 100644
--- a/apps/settings/src/main-admin-basic-settings.js
+++ b/apps/settings/src/main-admin-basic-settings.js
@@ -29,6 +29,7 @@ import '@nextcloud/dialogs/styles/toast.scss'
 import logger from './logger'
 
 import ProfileSettings from './components/BasicSettings/ProfileSettings'
+import BackgroundJob from './components/BasicSettings/BackgroundJob'
 
 __webpack_nonce__ = btoa(getRequestToken())
 
@@ -43,7 +44,10 @@ Vue.mixin({
 	},
 })
 
+const BackgroundJobView = Vue.extend(BackgroundJob)
+new BackgroundJobView().$mount('#vue-admin-background-job')
+
 if (profileEnabledGlobally) {
 	const ProfileSettingsView = Vue.extend(ProfileSettings)
-	new ProfileSettingsView().$mount('.vue-admin-profile-settings')
+	new ProfileSettingsView().$mount('#vue-admin-profile-settings')
 }