aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Servers/OSHttpRequestPump.cs
blob: 3459cc625ca12901e1228ae82a2961683e5d882a (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
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSim Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Net;
using System.Reflection;
using System.Text.RegularExpressions;
using System.Threading;
using log4net;
using HttpServer;

namespace OpenSim.Framework.Servers
{
    /// <summary>
    /// An OSHttpRequestPump fetches incoming OSHttpRequest objects
    /// from the OSHttpRequestQueue and feeds them to all subscribed
    /// parties. Each OSHttpRequestPump encapsulates one thread to do
    /// the work and there is a fixed number of pumps for each
    /// OSHttpServer object.
    /// </summary>
    public class OSHttpRequestPump
    {
        private static readonly ILog _log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        protected OSHttpServer _server;
        protected OSHttpRequestQueue _queue;
        protected Thread _engine;

        private int _id;
        
        public string EngineID
        {
            get { return String.Format("{0}-{1}", _server.EngineID, _id); }
        }

        
        public OSHttpRequestPump()
        {
            _engine = new Thread(new ThreadStart(Engine));
            _engine.Name = EngineID;
            _engine.IsBackground = true;
            _engine.Start();

            ThreadTracker.Add(_engine);

        }

        public static OSHttpRequestPump[] Pumps(OSHttpServer server, OSHttpRequestQueue queue, int poolSize)
        {
            OSHttpRequestPump[] pumps = new OSHttpRequestPump[poolSize];
            for (int i = 0; i < pumps.Length; i++)
            {
                pumps[i]._server = server;
                pumps[i]._queue = queue;
                pumps[i]._id = i;
            }

            return pumps;
        }

        public void Start()
        {
            _engine = new Thread(new ThreadStart(Engine));
            _engine.Name = EngineID;
            _engine.IsBackground = true;
            _engine.Start();

            ThreadTracker.Add(_engine);
        }

        public void Engine()
        {
            OSHttpRequest req = null;
            
            try {
                while (true)
                {
                    // get job to do
                    req = _queue.Dequeue();

                    // get list of registered handlers
                    List<OSHttpHandler> handlers = _server.OSHttpHandlers;

                    // prune list and sort from most specific to least
                    // specific
                    handlers = MatchHandlers(req, handlers);

                    // process req
                    foreach(OSHttpHandler h in handlers)
                    {
                        OSHttpHandlerResult rc = h.Process(req);
                        // handler did not process the request, try
                        // next handler
                        if (OSHttpHandlerResult.Pass == rc) continue;
                        // handler is taking over processing of
                        // request, we are done
                        if (OSHttpHandlerResult.Detached == rc) break;
                        
                        // request was handled, we need to clean up
                        // TODO: cleanup :-)
                        
                        break;
                    }
                    
                }
            }
            catch (Exception e)
            {
                _log.DebugFormat("[{0}] something went wrong: {1}", EngineID, e.ToString());
                _log.ErrorFormat("[{0}] something went wrong: {1}, terminating this pump", EngineID, e.Message);
            }
        }

        protected List<OSHttpHandler> MatchHandlers(OSHttpRequest req, List<OSHttpHandler> handlers)
        {
            Dictionary<OSHttpHandler, int> scoredHandlers = new Dictionary<OSHttpHandler, int>();

            foreach (OSHttpHandler h in handlers)
            {
                Regex pathRegex = h.Path;
                Dictionary<string, Regex> headerRegexs = h.Headers;
                Regex endPointsRegex = h.IPEndPointWhitelist;


                // first, check whether IPEndPointWhitelist applies
                // and, if it does, whether client is on that white
                // list.
                if (null != endPointsRegex)
                {
                    // TODO: following code requires code changes to
                    // HttpServer.HttpRequest

                    // IPEndPoint remote = HttpServer.HttpRequest.RemoteIPEndPoint;
                    // Match epm = endPointsRegex.Match(remote.ToString());
                    // if (!epm.Success) continue;
                }

                // whitelist ok, now check path
                if (null != pathRegex)
                {
                    Match m = pathRegex.Match(req.HttpRequest.Uri.AbsolutePath);
                    if (!m.Success) continue;

                    scoredHandlers[h] = m.ToString().Length;
                }

                // whitelist & path ok, now check headers
                if (null != headerRegexs)
                {
                    int headersMatch = 0;

                    // go through all header Regexs and evaluate
                    // match: 
                    //     if header field not present or does not match: 
                    //         remove handler from scoredHandlers 
                    //         continue
                    //     else: 
                    //         add increment headersMatch
                    NameValueCollection headers = req.HttpRequest.Headers;
                    foreach (string tag in headerRegexs.Keys)
                    {
                        if (null != headers[tag])
                        {
                            Match hm = headerRegexs[tag].Match(headers[tag]);
                            if (hm.Success) {
                                headersMatch++;
                                continue;
                            }
                        }

                        scoredHandlers.Remove(h);
                        break;
                    }
                    // check whether h got kicked out
                    if (!scoredHandlers.ContainsKey(h)) continue;

                    scoredHandlers[h] +=  headersMatch;
                }
            }
            
            List<OSHttpHandler> matchingHandlers = new List<OSHttpHandler>(scoredHandlers.Keys);
            matchingHandlers.Sort(delegate(OSHttpHandler x, OSHttpHandler y)
                                  {
                                      return scoredHandlers[x] - scoredHandlers[y];
                                  });

            return matchingHandlers;
        }
        
    }
}