Migrate Update notifications to Vue.js

.gitignore

@@ -32,6 +32,9 @@
 !/apps/testing
 !/apps/admin_audit
 !/apps/updatenotification
+/apps/updatenotification/js/merged.js
+/apps/updatenotification/js/merged.js.map
+/apps/updatenotification/node_modules
 !/apps/theming
 !/apps/twofactor_backupcodes
 !/apps/workflowengine

apps/updatenotification/Makefile

@@ -0,0 +1,47 @@
+app_name=updatenotification
+
+project_dir=$(CURDIR)/../$(app_name)
+build_dir=$(CURDIR)/build
+source_dir=$(build_dir)/$(app_name)
+sign_dir=$(build_dir)/sign
+
+all: package
+
+dev-setup: clean npm-update build-js
+
+npm-update:
+	rm -rf node_modules
+	npm update
+
+build-js:
+	npm run dev
+
+build-js-production:
+	npm run build
+
+clean:
+	rm -rf $(build_dir)
+
+package: clean build-js-production
+	mkdir -p $(source_dir)
+	rsync -a \
+	--exclude=/build \
+	--exclude=/docs \
+	--exclude=/js-src \
+	--exclude=/l10n/.tx \
+	--exclude=/tests \
+	--exclude=/.git \
+	--exclude=/.github \
+	--exclude=/CONTRIBUTING.md \
+	--exclude=/issue_template.md \
+	--exclude=/README.md \
+	--exclude=/.gitignore \
+	--exclude=/.scrutinizer.yml \
+	--exclude=/.travis.yml \
+	--exclude=/.drone.yml \
+	--exclude=/node_modules \
+	--exclude=/npm-debug.log \
+	--exclude=/package.json \
+	--exclude=/package-lock.json \
+	--exclude=/Makefile \
+	$(project_dir)/ $(source_dir)

apps/updatenotification/css/admin.css

@@ -1,3 +1,4 @@
+#updatenotification p,
 #oca_updatenotification_section p {
 	margin: 25px 0;
 }

apps/updatenotification/js-src/app.js

@@ -0,0 +1,53 @@
+/**
+ * @copyright (c) 2018 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ */
+
+/* global $, define */
+
+define(function (require) {
+	"use strict";
+
+	return {
+
+		/** @type {Vue|null} */
+		vm: null,
+
+		/**
+		 * Initialise the app
+		 */
+		initialise: function() {
+			var data = JSON.parse($('#updatenotification').attr('data-json'));
+			var Vue = require('vue');
+			var vSelect = require('vue-select');
+			Vue.component('v-select', vSelect.VueSelect);
+			Vue.mixin({
+				methods: {
+					t: function(app, text, vars, count, options) {
+						return OC.L10N.translate(app, text, vars, count, options);
+					},
+					n: function(app, textSingular, textPlural, count, vars, options) {
+						return OC.L10N.translatePlural(app, textSingular, textPlural, count, vars, options);
+					}
+				}
+			});
+			this.vm = new Vue(require('./components/root.vue'));
+
+			this.vm.newVersionString = data.newVersionString;
+			this.vm.lastCheckedDate = data.lastChecked;
+			this.vm.isUpdateChecked = data.isUpdateChecked;
+			this.vm.updaterEnabled = data.updaterEnabled;
+			this.vm.downloadLink = data.downloadLink;
+			this.vm.isNewVersionAvailable = data.isNewVersionAvailable;
+			this.vm.updateServerURL = data.updateServerURL;
+			this.vm.currentChannel = data.currentChannel;
+			this.vm.channels = data.channels;
+			this.vm.notifyGroups = data.notifyGroups;
+			this.vm.isDefaultUpdateServerURL = data.isDefaultUpdateServerURL;
+		}
+	};
+});

apps/updatenotification/js-src/components/root.vue

@@ -0,0 +1,180 @@
+<template>
+	<div id="updatenotification" class="followupsection">
+		<p>
+			<template v-if="isNewVersionAvailable">
+				<strong>{{newVersionAvailableString}}</strong>
+				<input v-if="updaterEnabled" type="button" @click="clickUpdaterButton" id="oca_updatenotification_button" :value="t('updatenotification', 'Open updater')">
+				<a v-if="downloadLink" :href="downloadLink" class="button" :class="{ hidden: !updaterEnabled }">{{ t('updatenotification', 'Download now') }}</a>
+			</template>
+			<template v-else-if="!isUpdateChecked">{{ t('updatenotification', 'The update check is not yet finished. Please refresh the page.') }}</template>
+			<template v-else>
+				{{ t('updatenotification', 'Your version is up to date.') }}
+				<span class="icon-info svg" :title="lastCheckedOnString"></span>
+			</template>
+
+			<template v-if="!isDefaultUpdateServerURL">
+				<br />
+				<em>{{ t('updatenotification', 'A non-default update server is in use to be checked for updates:') }} <code>{{updateServerURL}}</code></em>
+			</template>
+		</p>
+
+		<p>
+			<label for="release-channel">{{ t('updatenotification', 'Update channel:') }}</label>
+			<select id="release-channel" v-model="currentChannel" @change="changeReleaseChannel">
+				<option v-for="channel in channels" :value="channel">{{channel}}</option>
+			</select>
+			<span id="channel_save_msg" class="msg"></span><br />
+			<em>{{ t('updatenotification', 'You can always update to a newer version / experimental channel. But you can never downgrade to a more stable channel.') }}</em><br />
+			<em>{{ t('updatenotification', 'Note that after a new release it can take some time before it shows up here. We roll out new versions spread out over time to our users and sometimes skip a version when issues are found.') }}</em>
+		</p>
+
+		<p id="oca_updatenotification_groups">
+			{{ t('updatenotification', 'Notify members of the following groups about available updates:') }}
+			<v-select multiple :value="notifyGroups" :options="availableGroups"></v-select><br />
+			<em v-if="currentChannel === 'daily' || currentChannel === 'git'">{{ t('updatenotification', 'Only notification for app updates are available.') }}</em>
+			<em v-if="currentChannel === 'daily'">{{ t('updatenotification', 'The selected update channel makes dedicated notifications for the server obsolete.') }}</em>
+			<em v-if="currentChannel === 'git'">{{ t('updatenotification', 'The selected update channel does not support updates of the server.') }}</em>
+		</p>
+	</div>
+</template>
+
+<script>
+	export default {
+		name: "root",
+
+		el: '#updatenotification',
+
+		data: function () {
+			return {
+				newVersionString: '',
+				lastCheckedDate: '',
+				isUpdateChecked: false,
+				updaterEnabled: true,
+				downloadLink: '',
+				isNewVersionAvailable: false,
+				updateServerURL: '',
+				currentChannel: '',
+				channels: [],
+				notifyGroups: '',
+				availableGroups: [],
+				isDefaultUpdateServerURL: true,
+				enableChangeWatcher: false
+			};
+		},
+
+		_$el: null,
+		_$releaseChannel: null,
+		_$notifyGroups: null,
+
+		watch: {
+			notifyGroups: function(selectedOptions) {
+				if (!this.enableChangeWatcher) {
+					return;
+				}
+
+				var selectedGroups = [];
+				_.each(selectedOptions, function(group) {
+					selectedGroups.push(group.value);
+				});
+
+				OCP.AppConfig.setValue('updatenotification', 'notify_groups', JSON.stringify(selectedGroups));
+			}
+		},
+
+		computed: {
+			newVersionAvailableString: function() {
+				return t('updatenotification', 'A new version is available: {newVersionString}', {
+					newVersionString: this.newVersionString
+				});
+			},
+			lastCheckedOnString: function() {
+				return t('updatenotification', 'Checked on {lastCheckedDate}', {
+					lastCheckedDate: this.lastCheckedDate
+				});
+			}
+		},
+
+		methods: {
+			/**
+			 * Creates a new authentication token and loads the updater URL
+			 */
+			clickUpdaterButton: function() {
+				$.ajax({
+					url: OC.generateUrl('/apps/updatenotification/credentials')
+				}).success(function(data) {
+					$.ajax({
+						url: OC.getRootPath()+'/updater/',
+						headers: {
+							'X-Updater-Auth': data
+						},
+						method: 'POST',
+						success: function(data){
+							if(data !== 'false') {
+								var body = $('body');
+								$('head').remove();
+								body.html(data);
+
+								// Eval the script elements in the response
+								var dom = $(data);
+								dom.filter('script').each(function() {
+									eval(this.text || this.textContent || this.innerHTML || '');
+								});
+
+								body.removeAttr('id');
+								body.attr('id', 'body-settings');
+							}
+						},
+						error: function() {
+							OC.Notification.showTemporary(t('updatenotification', 'Could not start updater, please try the manual update'));
+							this.updaterEnabled = false;
+						}.bind(this)
+					});
+				}.bind(this));
+			},
+			changeReleaseChannel: function() {
+				this.currentChannel = this._$releaseChannel.val();
+
+				$.ajax({
+					url: OC.generateUrl('/apps/updatenotification/channel'),
+					type: 'POST',
+					data: {
+						'channel': this.currentChannel
+					},
+					success: function (data) {
+						OC.msg.finishedAction('#channel_save_msg', data);
+					}
+				});
+			}
+		},
+
+		mounted: function () {
+			this._$el = $(this.$el);
+			this._$releaseChannel = this._$el.find('#release-channel');
+			this._$notifyGroups = this._$el.find('#oca_updatenotification_groups_list');
+			this._$notifyGroups.on('change', function () {
+				this.$emit('input');
+			}.bind(this));
+
+			$.ajax({
+				url: OC.generateUrl('/settings/users/groups'),
+				dataType: 'json',
+				success: function(data) {
+					var results = [];
+					$.each(data.data.adminGroups, function(i, group) {
+						results.push({value: group.id, label: group.name});
+					});
+					$.each(data.data.groups, function(i, group) {
+						results.push({value: group.id, label: group.name});
+					});
+
+					this.availableGroups = results;
+					this.enableChangeWatcher = true;
+				}.bind(this)
+			});
+		},
+
+		updated: function () {
+			this._$el.find('.icon-info').tooltip({placement: 'right'});
+		}
+	}
+</script>

apps/updatenotification/js-src/init.js

@@ -0,0 +1,31 @@
+/**
+ * @copyright Copyright (c) 2018 Joas Schilling <coding@schilljs.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/>.
+ *
+ */
+
+/* global define, $ */
+
+define(function(require) {
+	'use strict';
+
+	var App = require('./app');
+
+	$(function() {
+		App.initialise();
+	});
+});

apps/updatenotification/js-src/webpack.config.js

@@ -0,0 +1,56 @@
+var path = require('path');
+var webpack = require('webpack');
+
+module.exports = {
+	entry: './js-src/init.js',
+	output: {
+		path: path.resolve(__dirname, '../js'),
+		publicPath: '/',
+		filename: 'merged.js'
+	},
+	module: {
+		rules: [
+			{
+				test: /\.vue$/,
+				loader: 'vue-loader',
+				options: {
+					loaders: {
+					},
+					esModule: false
+					// other vue-loader options go here
+				}
+			}
+		]
+	},
+	resolve: {
+		alias: {
+			'vue-select': 'vue-select/dist/vue-select.js',
+			'vue': process.env.NODE_ENV === 'production' ? 'vue/dist/vue.min.js' : 'vue/dist/vue.js'
+		}
+	},
+	performance: {
+		hints: false
+	},
+	devtool: '#eval-source-map'
+};
+
+if (process.env.NODE_ENV === 'production') {
+	module.exports.devtool = '#source-map';
+	// http://vue-loader.vuejs.org/en/workflow/production.html
+	module.exports.plugins = (module.exports.plugins || []).concat([
+		new webpack.DefinePlugin({
+			'process.env': {
+				NODE_ENV: '"production"'
+			}
+		}),
+		new webpack.optimize.UglifyJsPlugin({
+			sourceMap: true,
+			compress: {
+				warnings: false
+			}
+		}),
+		new webpack.LoaderOptionsPlugin({
+			minimize: true
+		})
+	]);
+}