/usr/include/GNUstep/NGObjWeb/WOContext.h is in libsope-dev 2.2.17-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | /*
Copyright (C) 2000-2005 SKYRIX Software AG
Copyright (C) 2006 Helge Hess
This file is part of SOPE.
SOPE is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.
SOPE 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 Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with SOPE; see the file COPYING. If not, write to the
Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
*/
#ifndef __NGObjWeb_WOContext_H__
#define __NGObjWeb_WOContext_H__
#import <Foundation/NSObject.h>
#include <NGObjWeb/WOPageGenerationContext.h>
#include <NGObjWeb/WOElementTrackingContext.h>
/*
WOContext
The WOContext is the central object for processing a single HTTP
transaction. It manages request, response, the session, the current
element id for component actions, the active component etc.
*/
@class NSString, NSMutableDictionary, NSMutableArray, NSMutableSet;
@class NSArray, NSDictionary, NSURL;
@class WOApplication, WOSession, WOComponent, WORequest, WOResponse;
@class WOElementID;
#define NGObjWeb_MAX_COMPONENT_NESTING_DEPTH 50
@interface WOContext : NSObject < WOPageGenerationContext >
{
@protected
WOApplication *application; // non-retained
NSString *ctxId;
WORequest *request;
WOResponse *response;
NSMutableDictionary *variables;
WOComponent *page;
WOSession *session;
NSMutableSet *awakeComponents; // components that were woken up
/* URLs */
NSURL *baseURL;
NSURL *appURL;
/* element ids */
WOElementID *elementID;
WOElementID *reqElementID;
NSString *urlPrefix; /* cached URL prefix */
/* component stack */
id componentStack[NGObjWeb_MAX_COMPONENT_NESTING_DEPTH];
id contentStack[NGObjWeb_MAX_COMPONENT_NESTING_DEPTH];
signed char componentStackCount;
/* misc */
id activeFormElement;
NSString *qpJoin;
@public /* need fast access to generation flags */
/* flags */
struct {
int savePageRequired:1; /* tracking component actions */
int inForm:1;
int xmlStyleEmptyElements:1;
int allowEmptyAttributes:1;
int hasNewSession:1; /* session was created during the run */
int isRenderingDisabled:1;
int reserved:26;
} wcFlags;
@protected
/* SOPE */
NSString *fragmentID;
/* SoObjects */
id clientObject;
NSMutableArray *traversalStack;
NSString *soRequestType; // WebDAV, XML-RPC, METHOD
id objectDispatcher;
NSString *pathInfo;
id rootURL;
id objectPermissionCache;
id activeUser;
#if WITH_DEALLOC_OBSERVERS
@private
id *deallocObservers;
unsigned short deallocObserverCount;
unsigned short deallocObserverCapacity;
#endif
}
+ (id)contextWithRequest:(WORequest *)_request;
- (id)initWithRequest:(WORequest *)_request;
+ (id)context;
- (id)init;
/* URLs */
- (NSURL *)baseURL;
- (NSURL *)applicationURL;
- (NSURL *)serverURL;
- (NSURL *)urlForKey:(NSString *)_key;
- (void)setGenerateXMLStyleEmptyElements:(BOOL)_flag;
- (BOOL)generateXMLStyleEmptyElements;
- (void)setGenerateEmptyAttributes:(BOOL)_flag;
- (BOOL)generateEmptyAttributes;
/* variables */
- (void)setObject:(id)_obj forKey:(NSString *)_key;
- (id)objectForKey:(NSString *)_key;
- (void)removeObjectForKey:(NSString *)_key;
- (void)takeValue:(id)_value forKey:(NSString *)_key;
- (id)valueForKey:(NSString *)_key;
@end
@interface WOContext(ElementIDs) < WOElementTrackingContext >
@end
@interface WOContext(URLs)
- (NSString *)componentActionURL;
- (NSString *)directActionURLForActionNamed:(NSString *)_actionName
queryDictionary:(NSDictionary *)_queryDict;
- (NSString *)urlWithRequestHandlerKey:(NSString *)_key
path:(NSString *)_path
queryString:(NSString *)_query;
- (NSString *)completeURLWithRequestHandlerKey:(NSString *)_key
path:(NSString *)_path
queryString:(NSString *)_query
isSecure:(BOOL)_isSecure
port:(int)_port;
- (NSString *)senderID; // new in WO4
- (NSString *)queryStringFromDictionary:(NSDictionary *)_queryDict;
- (void)setQueryPathSeparator:(NSString *)_sp;
- (NSString *)queryPathSeparator;
@end
@interface WOContext(PrivateMethods)
- (void)setRequestSenderID:(NSString *)_rqsid;
- (BOOL)savePageRequired;
@end
@interface WOContext(DeprecatedMethodsInWO4)
- (id)application; // use WOApplication:+application
- (void)setDistributionEnabled:(BOOL)_flag; // use methods in
- (BOOL)isDistributionEnabled; // WOSession instead
- (NSString *)url; // use componentActionURL methods
- (NSString *)urlSessionPrefix; // use componentActionURL methods
@end
@interface WOContext(SOPEAdditions)
- (BOOL)hasNewSession;
/* languages for resource lookup (non-WO) */
- (NSArray *)resourceLookupLanguages;
/* fragments */
- (void)setFragmentID:(NSString *)_fragmentID;
- (NSString *)fragmentID;
- (void)enableRendering;
- (void)disableRendering;
- (BOOL)isRenderingDisabled;
@end
#endif /* __NGObjWeb_WOContext_H__ */
|