open-dsi
/
nextcloud-server
mirror of https://github.com/nextcloud/server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #14129 from owncloud/deprecate-oc-json

Browse Source 
Deprecate `OC_JSON` and `OCP\JSON`
remotes/origin/log-external-deletes
Morris Jobke 12 years ago
parent e929d43bb6 86139fcce8
commit 64216971d4
2 changed files with 139 additions and 122 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 16
      lib/private/json.php
  2. 43
      lib/public/json.php

16
lib/private/json.php
Unescape View File

@ -6,10 +6,15 @@
* See the COPYING-README file. * See the COPYING-README file.
*/ */
/**
* Class OC_JSON
* @deprecated Use a AppFramework JSONResponse instead
*/
class OC_JSON{ class OC_JSON{
static protected $send_content_type_header = false; static protected $send_content_type_header = false;
/** /**
* set Content-Type header to jsonrequest * set Content-Type header to jsonrequest
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function setContentTypeHeader($type='application/json') { public static function setContentTypeHeader($type='application/json') {
if (!self::$send_content_type_header) { if (!self::$send_content_type_header) {
@ -22,6 +27,7 @@ class OC_JSON{
/** /**
* Check if the app is enabled, send json error msg if not * Check if the app is enabled, send json error msg if not
* @param string $app * @param string $app
* @deprecated Use the AppFramework instead. It will automatically check if the app is enabled.
*/ */
public static function checkAppEnabled($app) { public static function checkAppEnabled($app) {
if( !OC_App::isEnabled($app)) { if( !OC_App::isEnabled($app)) {
@ -33,6 +39,7 @@ class OC_JSON{
/** /**
* Check if the user is logged in, send json error msg if not * Check if the user is logged in, send json error msg if not
* @deprecated Use annotation based ACLs from the AppFramework instead
*/ */
public static function checkLoggedIn() { public static function checkLoggedIn() {
if( !OC_User::isLoggedIn()) { if( !OC_User::isLoggedIn()) {
@ -44,6 +51,7 @@ class OC_JSON{
/** /**
* Check an ajax get/post call if the request token is valid, send json error msg if not. * Check an ajax get/post call if the request token is valid, send json error msg if not.
* @deprecated Use annotation based CSRF checks from the AppFramework instead
*/ */
public static function callCheck() { public static function callCheck() {
if( !OC_Util::isCallRegistered()) { if( !OC_Util::isCallRegistered()) {
@ -55,6 +63,7 @@ class OC_JSON{
/** /**
* Check if the user is a admin, send json error msg if not. * Check if the user is a admin, send json error msg if not.
* @deprecated Use annotation based ACLs from the AppFramework instead
*/ */
public static function checkAdminUser() { public static function checkAdminUser() {
if( !OC_User::isAdminUser(OC_User::getUser())) { if( !OC_User::isAdminUser(OC_User::getUser())) {
@ -67,6 +76,7 @@ class OC_JSON{
/** /**
* Check is a given user exists - send json error msg if not * Check is a given user exists - send json error msg if not
* @param string $user * @param string $user
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function checkUserExists($user) { public static function checkUserExists($user) {
if (!OCP\User::userExists($user)) { if (!OCP\User::userExists($user)) {
@ -77,9 +87,9 @@ class OC_JSON{
} }
/** /**
* Check if the user is a subadmin, send json error msg if not * Check if the user is a subadmin, send json error msg if not
* @deprecated Use annotation based ACLs from the AppFramework instead
*/ */
public static function checkSubAdminUser() { public static function checkSubAdminUser() {
if(!OC_SubAdmin::isSubAdmin(OC_User::getUser())) { if(!OC_SubAdmin::isSubAdmin(OC_User::getUser())) {
@ -91,6 +101,7 @@ class OC_JSON{
/** /**
* Send json error msg * Send json error msg
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function error($data = array()) { public static function error($data = array()) {
$data['status'] = 'error'; $data['status'] = 'error';
@ -99,6 +110,7 @@ class OC_JSON{
/** /**
* Send json success msg * Send json success msg
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function success($data = array()) { public static function success($data = array()) {
$data['status'] = 'success'; $data['status'] = 'success';
@ -116,6 +128,7 @@ class OC_JSON{
/** /**
* Encode and print $data in json format * Encode and print $data in json format
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function encodedPrint($data, $setContentType=true) { public static function encodedPrint($data, $setContentType=true) {
if($setContentType) { if($setContentType) {
@ -126,6 +139,7 @@ class OC_JSON{
/** /**
* Encode JSON * Encode JSON
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function encode($data) { public static function encode($data) {
if (is_array($data)) { if (is_array($data)) {

43
lib/public/json.php
Unescape View File

@ -23,7 +23,6 @@
/** /**
* Public interface of ownCloud for apps to use. * Public interface of ownCloud for apps to use.
* JSON Class * JSON Class
*
*/ */
// use OCP namespace for all classes that are considered public. // use OCP namespace for all classes that are considered public.
@ -31,17 +30,18 @@
namespace OCP; namespace OCP;
/** /**
* This class provides convinient functions to generate and send JSON data. Usefull for Ajax calls * This class provides convenient functions to generate and send JSON data. Useful for Ajax calls
* @deprecated Use a AppFramework JSONResponse instead
*/ */
class JSON { class JSON {
/** /**
* Encode and print $data in JSON format * Encode and print $data in JSON format
* @param array $data The data to use * @param array $data The data to use
* @param string $setContentType the optional content type * @param bool $setContentType the optional content type
* @return string json formatted string. * @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function encodedPrint( $data, $setContentType=true ) { public static function encodedPrint( $data, $setContentType=true ) {
return(\OC_JSON::encodedPrint( $data, $setContentType )); \OC_JSON::encodedPrint($data, $setContentType);
} }
/** /**
@ -56,11 +56,10 @@ class JSON {
* *
* Add this call to the start of all ajax method files that requires * Add this call to the start of all ajax method files that requires
* an authenticated user. * an authenticated user.
* * @deprecated Use annotation based ACLs from the AppFramework instead
* @return string json formatted error string if not authenticated.
*/ */
public static function checkLoggedIn() { public static function checkLoggedIn() {
return(\OC_JSON::checkLoggedIn()); \OC_JSON::checkLoggedIn();
} }
/** /**
@ -80,11 +79,10 @@ class JSON {
* a submittable form, you will need to add the requesttoken first as a * 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 * parameter to the ajax call, then assign it to the template and finally
* add a hidden input field also named 'requesttoken' containing the value. * add a hidden input field also named 'requesttoken' containing the value.
* * @deprecated Use annotation based CSRF checks from the AppFramework instead
* @return \json|null json formatted error string if not valid.
*/ */
public static function callCheck() { public static function callCheck() {
return(\OC_JSON::callCheck()); \OC_JSON::callCheck();
} }
/** /**
@ -95,9 +93,10 @@ class JSON {
* *
* @param array $data The data to use * @param array $data The data to use
* @return string json formatted string. * @return string json formatted string.
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function success( $data = array() ) { public static function success( $data = array() ) {
return(\OC_JSON::success( $data )); \OC_JSON::success($data);
} }
/** /**
@ -117,18 +116,19 @@ class JSON {
* *
* @param array $data The data to use * @param array $data The data to use
* @return string json formatted error string. * @return string json formatted error string.
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function error( $data = array() ) { public static function error( $data = array() ) {
return(\OC_JSON::error( $data )); \OC_JSON::error( $data );
} }
/** /**
* Set Content-Type header to jsonrequest * Set Content-Type header to jsonrequest
* @param array $type The contwnt type header * @param string $type The content type header
* @return string json formatted string. * @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function setContentTypeHeader( $type='application/json' ) { public static function setContentTypeHeader( $type='application/json' ) {
return(\OC_JSON::setContentTypeHeader( $type )); \OC_JSON::setContentTypeHeader($type);
} }
/** /**
@ -145,10 +145,10 @@ class JSON {
* a specific app to be enabled. * a specific app to be enabled.
* *
* @param string $app The app to check * @param string $app The app to check
* @return string json formatted string if not enabled. * @deprecated Use the AppFramework instead. It will automatically check if the app is enabled.
*/ */
public static function checkAppEnabled( $app ) { public static function checkAppEnabled( $app ) {
return(\OC_JSON::checkAppEnabled( $app )); \OC_JSON::checkAppEnabled($app);
} }
/** /**
@ -164,7 +164,7 @@ class JSON {
* Add this call to the start of all ajax method files that requires * Add this call to the start of all ajax method files that requires
* administrative rights. * administrative rights.
* *
* @return string json formatted string if not admin user. * @deprecated Use annotation based ACLs from the AppFramework instead
*/ */
public static function checkAdminUser() { public static function checkAdminUser() {
\OC_JSON::checkAdminUser(); \OC_JSON::checkAdminUser();
@ -173,14 +173,17 @@ class JSON {
/** /**
* Encode JSON * Encode JSON
* @param array $data * @param array $data
* @return string
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function encode($data) { public static function encode($data) {
return(\OC_JSON::encode($data)); return \OC_JSON::encode($data);
} }
/** /**
* Check is a given user exists - send json error msg if not * Check is a given user exists - send json error msg if not
* @param string $user * @param string $user
* @deprecated Use a AppFramework JSONResponse instead
*/ */
public static function checkUserExists($user) { public static function checkUserExists($user) {
\OC_JSON::checkUserExists($user); \OC_JSON::checkUserExists($user);

Write Preview
Loading…
Cancel
Save