2012-05-03 14:23:29 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 18:07:57 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Frank Karlitschek <frank@karlitschek.de>
|
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
* @author Thomas Tanghus <thomas@tanghus.net>
|
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This code is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
|
|
* as published by the Free Software Foundation.
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2013-11-03 16:51:39 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 13:44:34 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* JSON Class
|
|
|
|
*/
|
|
|
|
|
2012-08-29 10:38:33 +04:00
|
|
|
// use OCP namespace for all classes that are considered public.
|
2012-05-03 14:23:29 +04:00
|
|
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
|
|
|
namespace OCP;
|
|
|
|
|
2012-05-19 12:36:57 +04:00
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* This class provides convenient functions to generate and send JSON data. Useful for Ajax calls
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use a AppFramework JSONResponse instead
|
2012-05-19 12:36:57 +04:00
|
|
|
*/
|
2012-05-03 14:23:29 +04:00
|
|
|
class JSON {
|
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* Check if the user is logged in, send json error msg if not.
|
|
|
|
*
|
|
|
|
* This method checks if a user is logged in. If not, a json error
|
|
|
|
* response will be return and the method will exit from execution
|
|
|
|
* of the script.
|
|
|
|
* The returned json will be in the format:
|
|
|
|
*
|
|
|
|
* {"status":"error","data":{"message":"Authentication error."}}
|
|
|
|
*
|
|
|
|
* Add this call to the start of all ajax method files that requires
|
|
|
|
* an authenticated user.
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
|
2017-07-19 16:50:59 +03:00
|
|
|
*
|
|
|
|
* @suppress PhanDeprecatedFunction
|
2015-02-12 02:56:13 +03:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function checkLoggedIn() {
|
2015-02-12 02:56:13 +03:00
|
|
|
\OC_JSON::checkLoggedIn();
|
2012-05-03 14:23:29 +04:00
|
|
|
}
|
|
|
|
|
2012-06-13 19:33:19 +04:00
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* Check an ajax get/post call if the request token is valid.
|
|
|
|
*
|
|
|
|
* This method checks for a valid variable 'requesttoken' in $_GET,
|
|
|
|
* $_POST and $_SERVER. If a valid token is not found, a json error
|
|
|
|
* response will be return and the method will exit from execution
|
|
|
|
* of the script.
|
|
|
|
* The returned json will be in the format:
|
|
|
|
*
|
|
|
|
* {"status":"error","data":{"message":"Token expired. Please reload page."}}
|
|
|
|
*
|
|
|
|
* Add this call to the start of all ajax method files that creates,
|
|
|
|
* updates or deletes anything.
|
|
|
|
* In cases where you e.g. use an ajax call to load a dialog containing
|
|
|
|
* a submittable form, you will need to add the requesttoken first as a
|
|
|
|
* parameter to the ajax call, then assign it to the template and finally
|
|
|
|
* add a hidden input field also named 'requesttoken' containing the value.
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead
|
2017-07-19 16:50:59 +03:00
|
|
|
*
|
|
|
|
* @suppress PhanDeprecatedFunction
|
2015-02-12 02:56:13 +03:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function callCheck() {
|
2015-02-12 02:56:13 +03:00
|
|
|
\OC_JSON::callCheck();
|
2012-06-13 19:33:19 +04:00
|
|
|
}
|
2012-05-03 14:23:29 +04:00
|
|
|
|
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* Send json success msg
|
|
|
|
*
|
|
|
|
* Return a json success message with optional extra data.
|
2017-07-22 22:10:16 +03:00
|
|
|
* @see \OCP\JSON::error() for the format to use.
|
2015-02-12 02:56:13 +03:00
|
|
|
*
|
|
|
|
* @param array $data The data to use
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use a AppFramework JSONResponse instead
|
2017-07-19 16:50:59 +03:00
|
|
|
* @suppress PhanDeprecatedFunction
|
2015-02-12 02:56:13 +03:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function success( $data = array() ) {
|
2015-02-12 02:56:13 +03:00
|
|
|
\OC_JSON::success($data);
|
2012-05-03 14:23:29 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* Send json error msg
|
|
|
|
*
|
|
|
|
* Return a json error message with optional extra data for
|
|
|
|
* error message or app specific data.
|
|
|
|
*
|
|
|
|
* Example use:
|
|
|
|
*
|
|
|
|
* $id = [some value]
|
|
|
|
* OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id)));
|
|
|
|
*
|
|
|
|
* Will return the json formatted string:
|
|
|
|
*
|
|
|
|
* {"status":"error","data":{"message":"An error happened", "id":[some value]}}
|
|
|
|
*
|
|
|
|
* @param array $data The data to use
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use a AppFramework JSONResponse instead
|
2017-07-19 16:50:59 +03:00
|
|
|
* @suppress PhanDeprecatedFunction
|
2015-02-12 02:56:13 +03:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function error( $data = array() ) {
|
2017-07-19 16:50:59 +03:00
|
|
|
\OC_JSON::error($data);
|
2012-05-03 14:23:29 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* Check if the App is enabled and send JSON error message instead
|
|
|
|
*
|
|
|
|
* This method checks if a specific app is enabled. If not, a json error
|
|
|
|
* response will be return and the method will exit from execution
|
|
|
|
* of the script.
|
|
|
|
* The returned json will be in the format:
|
|
|
|
*
|
|
|
|
* {"status":"error","data":{"message":"Application is not enabled."}}
|
|
|
|
*
|
|
|
|
* Add this call to the start of all ajax method files that requires
|
|
|
|
* a specific app to be enabled.
|
|
|
|
*
|
|
|
|
* @param string $app The app to check
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled.
|
2017-07-19 16:50:59 +03:00
|
|
|
* @suppress PhanDeprecatedFunction
|
2015-02-12 02:56:13 +03:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function checkAppEnabled( $app ) {
|
2015-02-12 02:56:13 +03:00
|
|
|
\OC_JSON::checkAppEnabled($app);
|
2012-05-03 14:23:29 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-02-12 02:56:13 +03:00
|
|
|
* Check if the user is a admin, send json error msg if not
|
|
|
|
*
|
|
|
|
* This method checks if the current user has admin rights. If not, a json error
|
|
|
|
* response will be return and the method will exit from execution
|
|
|
|
* of the script.
|
|
|
|
* The returned json will be in the format:
|
|
|
|
*
|
|
|
|
* {"status":"error","data":{"message":"Authentication error."}}
|
|
|
|
*
|
|
|
|
* Add this call to the start of all ajax method files that requires
|
|
|
|
* administrative rights.
|
|
|
|
*
|
2015-04-19 02:04:59 +03:00
|
|
|
* @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
|
2017-07-19 16:50:59 +03:00
|
|
|
* @suppress PhanDeprecatedFunction
|
2015-02-12 02:56:13 +03:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function checkAdminUser() {
|
2014-01-21 14:32:30 +04:00
|
|
|
\OC_JSON::checkAdminUser();
|
2012-05-03 14:23:29 +04:00
|
|
|
}
|
|
|
|
}
|