2 // (C) 2005 Mainsoft Corporation (http://www.mainsoft.com)
6 // Permission is hereby granted, free of charge, to any person obtaining
7 // a copy of this software and associated documentation files (the
8 // "Software"), to deal in the Software without restriction, including
9 // without limitation the rights to use, copy, modify, merge, publish,
10 // distribute, sublicense, and/or sell copies of the Software, and to
11 // permit persons to whom the Software is furnished to do so, subject to
12 // the following conditions:
14 // The above copyright notice and this permission notice shall be
15 // included in all copies or substantial portions of the Software.
17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 using System.Runtime.InteropServices;
29 using System.Web.Util;
31 using System.Web.J2EE;
32 using System.Collections;
35 using javax.servlet.http;
36 using System.Collections.Specialized;
37 using System.Globalization;
39 namespace System.Web.Hosting {
40 [MonoTODO("Implement security demands on the path usage functions (and review)")]
42 internal sealed class ServletWorkerRequest : HttpWorkerRequest {
43 readonly HttpServlet _HttpServlet;
44 readonly HttpServletRequest _HttpServletRequest;
45 readonly HttpServletResponse _HttpServletResponse;
47 readonly string _requestUri;
48 readonly string _pathInfo;
50 static readonly StringDictionary _srvVarsToHeaderMap;
52 private string [][] unknownHeaders;
55 private HttpWorkerRequest.EndOfSendNotification _endOfSendCallback;
56 private object _endOfSendArgs;
58 enum KnownServerVariable {
76 static readonly Hashtable KnownServerVariableMap;
78 static ServletWorkerRequest() {
79 _srvVarsToHeaderMap = new StringDictionary();
80 _srvVarsToHeaderMap.Add("HTTP_ACCEPT", "Accept");
81 _srvVarsToHeaderMap.Add("HTTP_REFERER", "Referer");
82 _srvVarsToHeaderMap.Add("HTTP_ACCEPT_LANGUAGE", "Accept-Language");
83 _srvVarsToHeaderMap.Add("HTTP_ACCEPT_ENCODING", "Accept-Encoding");
84 _srvVarsToHeaderMap.Add("HTTP_CONNECTION", "Connection");
85 _srvVarsToHeaderMap.Add("HTTP_HOST", "Host");
86 _srvVarsToHeaderMap.Add("HTTP_USER_AGENT", "User-Agent");
87 _srvVarsToHeaderMap.Add("HTTP_SOAPACTION", "SOAPAction");
89 string[] knownServerVariableNames = Enum.GetNames(typeof(KnownServerVariable));
90 KnownServerVariableMap = CollectionsUtil.CreateCaseInsensitiveHashtable(knownServerVariableNames.Length);
91 for (int i = 0; i < knownServerVariableNames.Length; i++)
92 KnownServerVariableMap[knownServerVariableNames[i]] = (KnownServerVariable)i;
95 public ServletWorkerRequest (HttpServlet servlet, HttpServletRequest req, HttpServletResponse resp) {
96 _HttpServlet = servlet;
97 _HttpServletRequest = req;
98 _HttpServletResponse = resp;
100 _requestUri = HttpUtility.UrlDecode(req.getRequestURI());
101 const int dotInvokeLength = 7; //".invoke".Length
102 if (_requestUri.Length > dotInvokeLength &&
103 String.CompareOrdinal(".invoke", 0, _requestUri,
104 _requestUri.Length - dotInvokeLength, dotInvokeLength) == 0) {
106 _requestUri = _requestUri.Substring(0, _requestUri.Length - dotInvokeLength);
108 int paramNameStart = _requestUri.LastIndexOf('/');
109 _pathInfo = _requestUri.Substring(paramNameStart, _requestUri.Length - paramNameStart);
113 public HttpServlet Servlet {
119 public HttpServletRequest ServletRequest {
121 return _HttpServletRequest;
125 public HttpServletResponse ServletResponse {
127 return _HttpServletResponse;
131 [MonoTODO("Implement security")]
132 public override string MachineInstallDirectory {
134 return ICalls.GetMachineInstallDirectory ();
138 public override string MachineConfigPath {
139 get { return ICalls.GetMachineConfigPath (); }
142 public override void EndOfRequest () {
143 if (_endOfSendCallback != null)
144 _endOfSendCallback(this, _endOfSendArgs);
147 public override void FlushResponse (bool finalFlush) {
148 ServletOutputStream servletOutputStream = _HttpServletResponse.getOutputStream();
149 servletOutputStream.flush();
151 servletOutputStream.close();
154 public override string GetAppPath () {
155 return _HttpServletRequest.getContextPath();
158 public override string GetAppPathTranslated () {
159 return J2EEUtils.GetApplicationRealPath(_HttpServlet.getServletConfig());;
162 public override string GetFilePath () {
163 string uri = GetUriPath();
164 string pathInfo = GetPathInfo();
165 if (pathInfo != null && pathInfo.Length > 0)
166 uri = uri.Substring(0, uri.Length - pathInfo.Length);
171 public override string GetFilePathTranslated () {
172 string page = GetFilePath ();
174 if (Path.DirectorySeparatorChar != '/')
175 page = page.Replace ('/', Path.DirectorySeparatorChar);
177 if (page [0] == Path.DirectorySeparatorChar)
178 page = page.Substring (1);
180 return Path.Combine (GetAppPathTranslated (), page);
183 public override string GetHttpVerbName () {
184 return _HttpServletRequest.getMethod();
187 public override string GetHttpVersion () {
188 return _HttpServletRequest.getProtocol();
191 public override string GetLocalAddress () {
192 return _HttpServletRequest.getLocalAddr();
195 public override int GetLocalPort () {
196 return _HttpServletRequest.getLocalPort();
199 public override string GetPathInfo () {
200 return _pathInfo != null ? _pathInfo : _HttpServletRequest.getPathInfo();
203 public override string GetQueryString () {
204 return _HttpServletRequest.getQueryString();
207 public override string GetRawUrl () {
208 if (_rawUrl == null) {
209 StringBuilder builder = new StringBuilder();
210 builder.Append(GetUriPath());
211 string pathInfo = GetPathInfo();
212 string query = GetQueryString();
213 if (query != null && query.Length > 0) {
215 builder.Append(query);
218 _rawUrl = builder.ToString();
224 public override string GetRemoteAddress() {
225 return _HttpServletRequest.getRemoteAddr();
228 public override string GetRemoteName() {
229 return _HttpServletRequest.getRemoteHost();
233 public override int GetRemotePort() {
235 return _HttpServletRequest.getRemotePort();
237 catch(Exception e) { //should catch also java.lang.Throwable
238 //if servlet API is 2.3 and below - there is no
239 //method getRemotePort in ServletRequest interface...
240 //should be described as limitation.
245 public override string GetServerVariable(string name) {
246 // FIXME: We need to make a proper mapping between the standard server
247 // variables and java equivalent. probably we have to have a configuration file
248 // which associates between the two. Pay a special attention on GetUnknownRequestHeader/s
249 // while implementing. Ensure that system web "common" code correctly calls each method.
251 string headerName = _srvVarsToHeaderMap[name];
253 if (headerName != null)
254 return _HttpServletRequest.getHeader( headerName );
256 object knownVariable = KnownServerVariableMap[name];
257 if (knownVariable != null)
258 return GetKnownServerVariable((KnownServerVariable)knownVariable);
260 return _HttpServletRequest.getHeader( name );
263 string GetKnownServerVariable(KnownServerVariable index) {
265 case KnownServerVariable.AUTH_TYPE : return _HttpServletRequest.getAuthType();
266 case KnownServerVariable.CONTENT_LENGTH : return Convert.ToString(_HttpServletRequest.getContentLength());
267 case KnownServerVariable.CONTENT_TYPE : return _HttpServletRequest.getContentType();
268 case KnownServerVariable.QUERY_STRING : return GetQueryString();
269 case KnownServerVariable.REMOTE_ADDR : return GetRemoteAddress();
270 case KnownServerVariable.REMOTE_HOST : return GetRemoteName();
271 case KnownServerVariable.REMOTE_USER : return _HttpServletRequest.getRemoteUser();
272 case KnownServerVariable.REQUEST_METHOD : return GetHttpVerbName ();
273 case KnownServerVariable.REQUEST_URI : return GetUriPath();
274 case KnownServerVariable.SCRIPT_NAME : return GetFilePath ();
275 case KnownServerVariable.SERVER_NAME : return GetServerName();
276 case KnownServerVariable.SERVER_PORT : return Convert.ToString(_HttpServletRequest.getServerPort());
277 case KnownServerVariable.SERVER_PROTOCOL : return GetHttpVersion ();
278 case KnownServerVariable.SERVER_SOFTWARE : return Servlet.getServletContext().getServerInfo();
279 case KnownServerVariable.PATH_INFO : return GetPathInfo();
280 default: throw new IndexOutOfRangeException("index");
284 public override string GetUriPath() {
288 public override IntPtr GetUserToken() {
292 public override string MapPath (string path) {
293 string appVirtualPath = GetAppPath();
294 if (path.StartsWith(appVirtualPath)) {
295 path = path.Remove(0,appVirtualPath.Length);
296 if (path.StartsWith("/"))
297 path = path.Remove(0,1);
299 //string realPath = Servlet.getServletContext().getRealPath(path);
300 // if (Path.IsPathRooted(path))
302 // if (!path.StartsWith(IAppDomainConfig.WAR_ROOT_SYMBOL)&&
303 // !path.StartsWith("/") && !path.StartsWith("\\")&& !Path.IsPathRooted(path))
304 // return IAppDomainConfig.WAR_ROOT_SYMBOL + "/" + path;
305 // else if (!path.StartsWith(IAppDomainConfig.WAR_ROOT_SYMBOL)&& !Path.IsPathRooted(path))
306 // return IAppDomainConfig.WAR_ROOT_SYMBOL + path;
310 if (path.StartsWith(IAppDomainConfig.WAR_ROOT_SYMBOL)) {
314 string retVal = IAppDomainConfig.WAR_ROOT_SYMBOL;
316 if (!path.StartsWith("/") && !path.StartsWith("\\"))
324 public override void SendResponseFromFile (IntPtr handle, long offset, long length) {
325 throw new NotSupportedException();
328 public override void SendResponseFromFile (string filename, long offset, long length) {
329 using (FileStream fs = File.OpenRead (filename)) {
330 byte [] buffer = new byte [4 * 1024];
333 fs.Position = offset;
335 long remain = length;
337 while (remain > 0 && (n = fs.Read (buffer, 0, (int) Math.Min (remain, buffer.Length))) != 0){
339 SendResponseFromMemory(buffer, n);
344 public override void SendResponseFromMemory (byte [] data, int length) {
345 sbyte [] sdata = vmw.common.TypeUtils.ToSByteArray(data);
346 _HttpServletResponse.getOutputStream().write(sdata, 0 , length);
349 public override void SendStatus(int statusCode, string statusDescription) {
350 // setStatus(int, string) is deprecated
351 _HttpServletResponse.setStatus(statusCode/*, statusDescription*/);
354 public override void SendUnknownResponseHeader(string name, string value) {
358 _HttpServletResponse.addHeader(name, value);
361 public override bool HeadersSent () {
362 return _HttpServletResponse.isCommitted();
365 public override void SendCalculatedContentLength (int contentLength) {
366 _HttpServletResponse.setContentLength(contentLength);
369 public override void SendKnownResponseHeader (int index, string value) {
370 SendUnknownResponseHeader (GetKnownResponseHeaderName (index), value);
373 public override string GetKnownRequestHeader (int index) {
374 return GetUnknownRequestHeader(GetKnownRequestHeaderName (index));
377 public override string GetUnknownRequestHeader (string name) {
378 return _HttpServletRequest.getHeader(name);
381 public override string [][] GetUnknownRequestHeaders () {
382 if (unknownHeaders == null) {
383 ArrayList pairs = new ArrayList ();
384 for (java.util.Enumeration he = _HttpServletRequest.getHeaderNames(); he.hasMoreElements() ;) {
385 string key = (string) he.nextElement();
386 int index = HttpWorkerRequest.GetKnownRequestHeaderIndex (key);
389 pairs.Add (new string [] {key, _HttpServletRequest.getHeader(key)});
392 if (pairs.Count != 0) {
393 unknownHeaders = new string [pairs.Count][];
394 for (int i = 0; i < pairs.Count; i++)
395 unknownHeaders [i] = (string []) pairs [i];
398 if (unknownHeaders == null) unknownHeaders = new string [0][];
400 return unknownHeaders;
403 public override int ReadEntityBody (byte [] buffer, int size) {
404 if (buffer == null || size == 0)
406 sbyte [] sbuffer = vmw.common.TypeUtils.ToSByteArray(buffer);
407 int r = _HttpServletRequest.getInputStream().read(sbuffer, 0, size);
411 public override void SetEndOfSendNotification(System.Web.HttpWorkerRequest.EndOfSendNotification callback, object extraData) {
412 _endOfSendCallback = callback;
413 _endOfSendArgs = extraData;
416 public override string GetProtocol() {
417 return _HttpServletRequest.getScheme();
420 public override string GetServerName() {
421 return _HttpServletRequest.getServerName();
424 public override bool IsSecure() {
425 return _HttpServletRequest.isSecure();