* @author Bernhard Posselt * @author Christoph Wurst * @author Felix Moeller * @author Georg Ehrke * @author Lukas Reschke * @author Morris Jobke * @author Robin Appelman * @author Thomas Müller * @author Thomas Tanghus * @author Vincent Petry * * @license AGPL-3.0 * * 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. * * 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, version 3, * along with this program. If not, see * */ /** * Class OC_JSON * @deprecated Use a AppFramework JSONResponse instead */ class OC_JSON{ static protected $send_content_type_header = false; /** * set Content-Type header to jsonrequest * @deprecated Use a AppFramework JSONResponse instead */ public static function setContentTypeHeader($type='application/json') { if (!self::$send_content_type_header) { // We send json data header( 'Content-Type: '.$type . '; charset=utf-8'); self::$send_content_type_header = true; } } /** * Check if the app is enabled, send json error msg if not * @param string $app * @deprecated Use the AppFramework instead. It will automatically check if the app is enabled. * @suppress PhanDeprecatedFunction */ public static function checkAppEnabled($app) { if( !\OC::$server->getAppManager()->isEnabledForUser($app)) { $l = \OC::$server->getL10N('lib'); self::error(array( 'data' => array( 'message' => $l->t('Application is not enabled'), 'error' => 'application_not_enabled' ))); exit(); } } /** * Check if the user is logged in, send json error msg if not * @deprecated Use annotation based ACLs from the AppFramework instead * @suppress PhanDeprecatedFunction */ public static function checkLoggedIn() { $twoFactorAuthManger = \OC::$server->getTwoFactorAuthManager(); if( !\OC::$server->getUserSession()->isLoggedIn() || $twoFactorAuthManger->needsSecondFactor(\OC::$server->getUserSession()->getUser())) { $l = \OC::$server->getL10N('lib'); http_response_code(\OCP\AppFramework\Http::STATUS_UNAUTHORIZED); self::error(array( 'data' => array( 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ))); exit(); } } /** * 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 * @suppress PhanDeprecatedFunction */ public static function callCheck() { if(!\OC::$server->getRequest()->passesStrictCookieCheck()) { header('Location: '.\OC::$WEBROOT); exit(); } if( !(\OC::$server->getRequest()->passesCSRFCheck())) { $l = \OC::$server->getL10N('lib'); self::error(array( 'data' => array( 'message' => $l->t('Token expired. Please reload page.'), 'error' => 'token_expired' ))); exit(); } } /** * Check if the user is a admin, send json error msg if not. * @deprecated Use annotation based ACLs from the AppFramework instead * @suppress PhanDeprecatedFunction */ public static function checkAdminUser() { if( !OC_User::isAdminUser(OC_User::getUser())) { $l = \OC::$server->getL10N('lib'); self::error(array( 'data' => array( 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ))); exit(); } } /** * Check is a given user exists - send json error msg if not * @param string $user * @deprecated Use a AppFramework JSONResponse instead * @suppress PhanDeprecatedFunction */ public static function checkUserExists($user) { if (!OCP\User::userExists($user)) { $l = \OC::$server->getL10N('lib'); OCP\JSON::error(array('data' => array('message' => $l->t('Unknown user'), 'error' => 'unknown_user' ))); exit; } } /** * Check if the user is a subadmin, send json error msg if not * @deprecated Use annotation based ACLs from the AppFramework instead * @suppress PhanDeprecatedFunction */ public static function checkSubAdminUser() { $userObject = \OC::$server->getUserSession()->getUser(); $isSubAdmin = false; if($userObject !== null) { $isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject); } if(!$isSubAdmin) { $l = \OC::$server->getL10N('lib'); self::error(array( 'data' => array( 'message' => $l->t('Authentication error'), 'error' => 'authentication_error' ))); exit(); } } /** * Send json error msg * @deprecated Use a AppFramework JSONResponse instead * @suppress PhanDeprecatedFunction */ public static function error($data = array()) { $data['status'] = 'error'; self::encodedPrint($data); } /** * Send json success msg * @deprecated Use a AppFramework JSONResponse instead * @suppress PhanDeprecatedFunction */ public static function success($data = array()) { $data['status'] = 'success'; self::encodedPrint($data); } /** * Convert OC_L10N_String to string, for use in json encodings */ protected static function to_string(&$value) { if ($value instanceof \OC\L10N\L10NString) { $value = (string)$value; } } /** * Encode and print $data in json format * @deprecated Use a AppFramework JSONResponse instead * @suppress PhanDeprecatedFunction */ public static function encodedPrint($data, $setContentType=true) { if($setContentType) { self::setContentTypeHeader(); } echo self::encode($data); } /** * Encode JSON * @deprecated Use a AppFramework JSONResponse instead */ public static function encode($data) { if (is_array($data)) { array_walk_recursive($data, array('OC_JSON', 'to_string')); } return json_encode($data, JSON_HEX_TAG); } } work.git/about/?h=JS-RPC-docs-link-syntax'>aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/gwt/gwt-advanced.asciidoc
blob: f6991ef0e1abf31140e39d715c67b59d6d3b2a0c (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

---
title: Advanced Client-Side Topics
order: 10
layout: page
---

[[gwt.advanced]]
= Advanced Client-Side Topics

In the following, we mention some topics that you may encounter when integrating
widgets.

[[gwt.advanced.phases]]
== Client-Side Processing Phases

Vaadin's client-side engine reacts to changes from the server in a number of
phases, the order of which can be relevant for a connector. The processing
occurs in the [methodname]#handleUIDLMessage()# method in
[classname]#ApplicationConnection#, but the logic can be quite overwhelming, so
we describe the phases in the following summary.

. Any dependencies defined by using [classname]#@JavaScript#,
[classname]#@StyleSheet# or [classname]#@HtmlImport# on the server-side class
are loaded. Processing does not continue until the browser confirms that they
have been loaded.

. New connectors are instantiated and [methodname]#init()# is run for each
[interfacename]#Connector#.

. State objects are updated, but no state change event is fired yet.

. The connector hierarchy is updated, but no hierarchy change event is fired yet.
[methodname]#setParent()# and [methodname]#setChildren()# are run in this phase.

. Hierarchy change events are fired. This means that all state objects and the
entire hierarchy are already up to date when this happens. The DOM hierarchy
should in theory be up to date after all hierarchy events have been handled,
although there are some built-in components that for various reasons do not
always live up to this promise.

. Captions are updated, causing [methodname]#updateCaption()# to be invoked on
layouts as needed.

. [classname]#@DelegateToWidget# is handled for all changed state objects using
the annotation.

. State change events are fired for all changed state objects.

. [methodname]#updateFromUIDL()# is called for legacy connectors.

. All RPC methods received from the server are invoked.

. Connectors that are no longer included in the hierarchy are unregistered. This
calls [methodname]#onUnregister()# on the [interfacename]#Connector#.

. The layout phase starts, first checking the sizes and positions of all elements,
and then notifying any [interfacename]#ElementResizeListener#s, as well as
calling the appropriate layout method for the connectors that implement either
[classname]#SimpleManagedLayout# or [classname]#DirectionalManagedLayout#
interface.
generated by cgit v1.2.3 (git 2.39.1) at 2025-07-31 19:03:56 +0000