Add Recommendations Toggle

Signed-off-by: Gary Kim <[email protected]>

Author: gary-kim

appinfo/routes.php

@@ -28,4 +28,8 @@
 	'resources' => [
 		'recommendation' => ['url' => 'api/recommendations'],
 	],
+	'routes' => [
+		['name' => 'settings#getSettings', 'url' => '/settings', 'verb' => 'GET'],
+		['name' => 'settings#setSetting', 'url' => '/settings/{key}', 'verb' => 'PUT'],
+	],
 ];

js/main.js

@@ -30,6 +30,7 @@
 use OCA\Recommendations\Service\RecommendationService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\JSONResponse;
+use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserSession;
 
@@ -41,12 +42,17 @@ class RecommendationController extends Controller {
 	/** @var RecommendationService */
 	private $recommendationService;
 
+	/** @var IConfig */
+	private $config;
+
 	public function __construct(IRequest $request,
 								IUserSession $userSession,
-								RecommendationService $recommendationService) {
+								RecommendationService $recommendationService,
+								IConfig $config) {
 		parent::__construct(Application::APP_ID, $request);
 		$this->userSession = $userSession;
 		$this->recommendationService = $recommendationService;
+		$this->config = $config;
 	}
 
 	/**
@@ -58,9 +64,11 @@ public function index(): JSONResponse {
 		if (is_null($user)) {
 			throw new Exception("Not logged in");
 		}
-
+		$response = [];
+		$response['enabled'] = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'enabled', 'true') === 'true';
+		$response['recommendations'] = $this->recommendationService->getRecommendations($user);
 		return new JSONResponse(
-			$this->recommendationService->getRecommendations($user)
+			$response
 		);
 	}
 

js/main.js.map

@@ -0,0 +1,91 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2019 Gary Kim <[email protected]>
+ *
+ * @author 2019 Gary Kim <[email protected]>
+ *
+ * @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\Recommendations\Controller;
+use OCA\Recommendations\AppInfo\Application;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\IConfig;
+use OCP\IRequest;
+use OCP\IUserSession;
+use Exception;
+
+class SettingsController extends Controller {
+
+	/** @var IConfig */
+	private $config;
+
+	/** @var IUserSession */
+	private $userSession;
+
+	public function __construct($appName, IRequest $request, IConfig $config, IUserSession $userSession) {
+		parent::__construct($appName, $request);
+		$this->config = $config;
+		$this->userSession = $userSession;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @return JSONResponse
+	 * @throws Exception
+	 */
+	public function getSettings (): JSONResponse {
+		$user = $this->userSession->getUser();
+		if (is_null($user)) {
+			throw new Exception("Not logged in");
+		}
+		return new JSONResponse([
+			'enabled' => $this->config->getUserValue($user->getUID(), Application::APP_ID, 'enabled', 'true') === 'true',
+		]);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @param $key
+	 * @param $value
+	 * @return JSONResponse
+	 * @throws Exception
+	 */
+	public function setSetting (string $key, string $value): JSONResponse {
+		$user = $this->userSession->getUser();
+		if (is_null($user)) {
+			throw new Exception("Not logged in");
+		}
+		$availableSettings = ['enabled'];
+		if (!in_array($key, $availableSettings)) {
+			return new JSONResponse([
+				'message' => 'parameter does not exist',
+			], Http::STATUS_UNPROCESSABLE_ENTITY);
+		}
+		$this->config->setUserValue($user->getUID(), Application::APP_ID, $key, $value);
+		return new JSONResponse([
+			'key' => $key,
+			'value' => $value,
+		]);
+	}
+}

lib/Controller/RecommendationController.php

@@ -20,7 +20,7 @@
   -->
 
 <template>
-	<div v-if="!hidden && !loading">
+	<div v-if="!hidden && !loading && enabled">
 		<div id="recommendations"
 			 v-if="recommendedFiles.length > 0"
 			 class="group">
@@ -51,6 +51,11 @@
 				recommendedFiles: [],
 			}
 		},
+		computed: {
+			enabled() {
+				return this.$store.state.enabled
+			}
+		},
 		methods: {
 			show () {
 				this.hidden = false;
@@ -64,9 +69,10 @@
 				this.loading = true;
 
 				fetchRecommendedFiles()
-					.then(files => {
+					.then(data => {
 						this.loading = false;
-						this.recommendedFiles = files;
+						this.recommendedFiles = data.recommendations;
+						this.$store.state.enabled = data.enabled;
 					})
 					.catch(console.error.bind(this));
 			},

lib/Controller/SettingsController.php

@@ -0,0 +1,32 @@
+<template>
+	<div id="recommendations-setting-enabled">
+		<input id="recommendationsEnabledToggle"
+			v-model="enabled"
+			class="checkbox"
+			checked="checked"
+			type="checkbox"
+			name="enabled">
+		<label for="recommendationsEnabledToggle">{{ t('recommendations', 'Recommendations enabled') }}</label>
+	</div>
+</template>
+
+<script>
+
+export default {
+	name: 'Settings',
+	computed: {
+		enabled: {
+			get() {
+				return this.$store.state.enabled
+			},
+			set(val) {
+				this.$store.dispatch('enabled', val)
+			},
+		},
+	},
+}
+</script>
+
+<style scoped>
+
+</style>

src/components/Recommendations.vue

@@ -20,9 +20,12 @@
  */
 
 import Vue from "vue";
+import Vuex from "vuex";
 
 import Nextcloud from "./mixins/Nextcloud";
 import Recommendations from "./components/Recommendations";
+import Settings from './components/Settings';
+import store from "./store/store";
 
 Vue.mixin(Nextcloud);
 OC.Plugins.register('OCA.Files.FileList', {
@@ -48,9 +51,15 @@ OC.Plugins.register('OCA.Files.FileList', {
 
 		const View = Vue.extend(Recommendations);
 		const vm = new View({
-			propsData: {}
+			propsData: {},
+			store
 		}).$mount(this.el);
 
+		// register Files App Setting
+		const settingsView = Vue.extend(Settings);
+		settingsView.prototype.$store = store;
+		OCA.Files.Settings.registerSetting(new OCA.Files.Settings.Setting('recommendations', settingsView));
+
 		fileList.$el.on('changeDirectory', data => {
 			if (data.dir.toString() === '/') {
 				vm.show();

src/components/Settings.vue

@@ -0,0 +1,46 @@
+/*
+ * @copyright 2019 Gary Kim <[email protected]>
+ *
+ * @author 2019 Gary Kim <[email protected]>
+ *
+ * @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/>.
+ */
+
+import Vue from 'vue';
+import Vuex from 'vuex';
+import Axios from '@nextcloud/axios'
+import { generateUrl } from "nextcloud-server/dist/router"
+
+Vue.use(Vuex);
+
+export default new Vuex.Store({
+	state: {
+		enabled: true,
+	},
+	mutations: {
+		enabled(state, val) {
+			state.enabled = val;
+		},
+	},
+	actions: {
+		enabled(ctx, val) {
+			ctx.commit('enabled', val);
+			Axios.put(generateUrl('apps/recommendations/settings/enabled'), {
+				value: val.toString(),
+			});
+		},
+	},
+})