Make AppConfig part of the public API

Signed-off-by: Joas Schilling <coding@schilljs.com>

4 files changed, 174 insertions, 37 deletions

diff --git a/core/js/config.js b/core/js/config.js
index b034b7e8cd3..7dc742f7567 100644
--- a/core/js/config.js
+++ b/core/js/config.js
@@ -1,58 +1,80 @@
 /**
- * Copyright (c) 2011, Robin Appelman <icewind1991@gmail.com>
- * This file is licensed under the Affero General Public License version 3 or later.
- * See the COPYING-README file.
+ * @copyright Copyright (c) 2016 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/>.
+ *
  */
 
 /**
  * @namespace
+ * @deprecated Use OCP.AppConfig instead
  */
 OC.AppConfig={
-	url:OC.filePath('core','ajax','appconfig.php'),
-	getCall:function(action,data,callback){
-		data.action=action;
-		$.getJSON(OC.AppConfig.url,data,function(result){
-			if(result.status==='success'){
-				if(callback){
-					callback(result.data);
-				}
-			}
-		});
-	},
-	postCall:function(action,data,callback){
-		data.action=action;
-		$.post(OC.AppConfig.url,data,function(result){
-			if(result.status==='success'){
-				if(callback){
-					callback(result.data);
-				}
-			}
-		},'json');
-	},
+	/**
+	 * @deprecated Use OCP.AppConfig.getValue() instead
+	 */
 	getValue:function(app,key,defaultValue,callback){
-		if(typeof defaultValue=='function'){
-			callback=defaultValue;
-			defaultValue=null;
-		}
-		OC.AppConfig.getCall('getValue',{app:app,key:key,defaultValue:defaultValue},callback);
+		OCP.AppConfig.getValue(app, key, defaultValue, {
+			success: callback
+		});
 	},
+
+	/**
+	 * @deprecated Use OCP.AppConfig.setValue() instead
+	 */
 	setValue:function(app,key,value){
-		OC.AppConfig.postCall('setValue',{app:app,key:key,value:value});
+		OCP.AppConfig.setValue(app, key, value);
 	},
+
+	/**
+	 * @deprecated Use OCP.AppConfig.getApps() instead
+	 */
 	getApps:function(callback){
-		OC.AppConfig.getCall('getApps',{},callback);
+		OCP.AppConfig.getApps({
+			success: callback
+		});
 	},
+
+	/**
+	 * @deprecated Use OCP.AppConfig.getKeys() instead
+	 */
 	getKeys:function(app,callback){
-		OC.AppConfig.getCall('getKeys',{app:app},callback);
+		OCP.AppConfig.getKeys(app, {
+			success: callback
+		});
 	},
+
+	/**
+	 * @deprecated
+	 */
 	hasKey:function(app,key,callback){
-		OC.AppConfig.getCall('hasKey',{app:app,key:key},callback);
+		console.error('OC.AppConfig.hasKey is not supported anymore. Use OCP.AppConfig.getValue instead.');
 	},
+
+	/**
+	 * @deprecated Use OCP.AppConfig.deleteKey() instead
+	 */
 	deleteKey:function(app,key){
-		OC.AppConfig.postCall('deleteKey',{app:app,key:key});
+		OCP.AppConfig.deleteKey(app, key);
 	},
+
+	/**
+	 * @deprecated
+	 */
 	deleteApp:function(app){
-		OC.AppConfig.postCall('deleteApp',{app:app});
+		console.error('OC.AppConfig.deleteApp is not supported anymore.');
 	}
 };
-//TODO OC.Preferences
diff --git a/core/js/core.json b/core/js/core.json
index c98928d0fed..7e72234aaa4 100644
--- a/core/js/core.json
+++ b/core/js/core.json
@@ -39,6 +39,7 @@
 		"octemplate.js",
 		"eventsource.js",
 		"config.js",
+		"public/appconfig.js",
 		"multiselect.js",
 		"oc-requesttoken.js",
 		"setupchecks.js",
diff --git a/core/js/js.js b/core/js/js.js
index 16da273c8e1..87b4370914c 100644
--- a/core/js/js.js
+++ b/core/js/js.js
@@ -58,7 +58,8 @@ function fileDownloadPath(dir, file) {
 }
 
 /** @namespace */
-var OC={
+var OCP = {},
+	OC = {
 	PERMISSION_CREATE:4,
 	PERMISSION_READ:1,
 	PERMISSION_UPDATE:2,
diff --git a/core/js/public/appconfig.js b/core/js/public/appconfig.js
new file mode 100644
index 00000000000..82f479d75b2
--- /dev/null
+++ b/core/js/public/appconfig.js
@@ -0,0 +1,113 @@
+/**
+ * @copyright Copyright (c) 2016 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/>.
+ *
+ */
+
+/**
+ * @namespace
+ * @since 9.2.0
+ */
+OCP.AppConfig = {
+	/**
+	 * @param {string} method
+	 * @param {string} endpoint
+	 * @param {Object} [options]
+	 * @param {Object} [options.data]
+	 * @param {function} [options.success]
+	 * @param {function} [options.error]
+	 * @internal
+	 */
+	_call: function(method, endpoint, options) {
+
+		$.ajax({
+			type: method.toUpperCase(),
+			url: OC.linkToOCS('apps/provisioning_api/api/v1', 2) + 'config/apps' + endpoint,
+			data: options.data || {},
+			success: options.success,
+			error: options.error
+		})
+	},
+
+	/**
+	 * @param {Object} [options]
+	 * @param {function} [options.success]
+	 * @since 9.2.0
+	 */
+	getApps: function(options) {
+		this._call('get', '', options);
+	},
+
+	/**
+	 * @param {string} app
+	 * @param {Object} [options]
+	 * @param {function} [options.success]
+	 * @param {function} [options.error]
+	 * @since 9.2.0
+	 */
+	getKeys: function(app, options) {
+		this._call('get', '/' + app, options);
+	},
+
+	/**
+	 * @param {string} app
+	 * @param {string} key
+	 * @param {string|function} defaultValue
+	 * @param {Object} [options]
+	 * @param {function} [options.success]
+	 * @param {function} [options.error]
+	 * @since 9.2.0
+	 */
+	getValue: function(app, key, defaultValue, options) {
+		options = options || {};
+		options['data'] = {
+			defaultValue: defaultValue
+		};
+
+		this._call('get', '/' + app + '/' + key, options);
+	},
+
+	/**
+	 * @param {string} app
+	 * @param {string} key
+	 * @param {string} value
+	 * @param {Object} [options]
+	 * @param {function} [options.success]
+	 * @param {function} [options.error]
+	 * @since 9.2.0
+	 */
+	setValue: function(app, key, value, options) {
+		options = options || {};
+		options['data'] = {
+			value: value
+		};
+
+		this._call('post', '/' + app + '/' + key, options);
+	},
+
+	/**
+	 * @param {string} app
+	 * @param {string} key
+	 * @param {Object} [options]
+	 * @param {function} [options.success]
+	 * @param {function} [options.error]
+	 * @since 9.2.0
+	 */
+	deleteKey: function(app, key, options) {
+		this._call('delete', '/' + app + '/' + key, options);
+	}
+};