From 5e4d6cab00cb29cd088ab7b62ab13aff103b64cb Mon Sep 17 00:00:00 2001 From: onefang Date: Sun, 19 May 2019 21:24:15 +1000 Subject: Dump OpenSim 0.9.0.1 into it's own branch. --- bin/HttpServer_OpenSim.xml | 6796 ++++++++++++++++++++++---------------------- 1 file changed, 3398 insertions(+), 3398 deletions(-) (limited to 'bin/HttpServer_OpenSim.xml') diff --git a/bin/HttpServer_OpenSim.xml b/bin/HttpServer_OpenSim.xml index 61c3ad8..7b6912e 100644 --- a/bin/HttpServer_OpenSim.xml +++ b/bin/HttpServer_OpenSim.xml @@ -4,562 +4,522 @@ HttpServer_OpenSim - + - Delegate used to find a realm/domain. + Delegate used to let authentication modules authenticate the user name and password. - - + Realm that the user want to authenticate in + User name specified by client + Can either be user password or implementation specific token. + object that will be stored in a session variable called if authentication was successful. + throw forbidden exception if too many attempts have been made. - Realms are used during HTTP Authentication + + Use to specify that the token is a HA1 token. (MD5 generated + string from realm, user name and password); Md5String(userName + ":" + realm + ":" + password); + - - - - - - A complete HTTP server, you need to add a module to it to be able to handle incoming requests. - - - - // this small example will add two web site modules, thus handling - // two different sites. In reality you should add Controller modules or something - // two the website modules to be able to handle different requests. - HttpServer server = new HttpServer(); - server.Add(new WebSiteModule("www.gauffin.com", "Gauffin Telecom AB")); - server.Add(new WebSiteModule("www.vapadi.se", "Remote PBX")); - - // start regular http - server.Start(IPAddress.Any, 80); - - // start https - server.Start(IPAddress.Any, 443, myCertificate); - - - - - - + - Initializes a new instance of the class. + Let's you decide on a system level if authentication is required. - Used to get all components used in the server.. + HTTP request from client + true if user should be authenticated. + throw if no more attempts are allowed. + If no more attempts are allowed - + - Initializes a new instance of the class. + Authentication modules are used to implement different + kind of HTTP authentication. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - Form decoders are used to convert different types of posted data to the object types. - - + Delegate used to provide information used during authentication. + Delegate used to determine if authentication is required (may be null). - + - Initializes a new instance of the class. + Initializes a new instance of the class. - A session store is used to save and retrieve sessions - + Delegate used to provide information used during authentication. - + - Initializes a new instance of the class. + name used in HTTP request. - The log writer. - - + - Initializes a new instance of the class. + Tag used for authentication. - Form decoders are used to convert different types of posted data to the object types. - The log writer. - - - - + - Initializes a new instance of the class. + Create a response that can be sent in the WWW-Authenticate header. - Form decoders are used to convert different types of posted data to the object types. - A session store is used to save and retrieve sessions - The log writer. - - - - + Realm that the user should authenticate in + Array with optional options. + A correct authentication request. + If realm is empty or null. - + - Adds the specified rule. + An authentication response have been received from the web browser. + Check if it's correct - The rule. + Contents from the Authorization header + Realm that should be authenticated + GET/POST/PUT/DELETE etc. + options to specific implementations + Authentication object that is stored for the request. A user class or something like that. + if is invalid + If any of the parameters is empty or null. - + - Add a to the server. + Used to invoke the authentication delegate that is used to lookup the user name/realm. - mode to add + Realm (domain) that user want to authenticate in + User name + Password used for validation. Some implementations got password in clear text, they are then sent to client. + object that will be stored in the request to help you identify the user if authentication was successful. + true if authentication was successful - + - Decodes the request body. + Determines if authentication is required. - The request. - Failed to decode form data. + HTTP request from browser + true if user should be authenticated. + throw from your delegate if no more attempts are allowed. + If no more attempts are allowed - + - Generate a HTTP error page (that will be added to the response body). - response status code is also set. + The "basic" authentication scheme is based on the model that the + client must authenticate itself with a user-ID and a password for + each realm. The realm value should be considered an opaque string + which can only be compared for equality with other realms on that + server. The server will service the request only if it can validate + the user-ID and password for the protection space of the Request-URI. + There are no optional authentication parameters. - Response that the page will be generated in. - . - response body contents. - + - Generate a HTTP error page (that will be added to the response body). - response status code is also set. + Initializes a new instance of the class. - Response that the page will be generated in. - exception. + Delegate used to provide information used during authentication. + Delegate used to determine if authentication is required (may be null). - + - Realms are used by the s. + Initializes a new instance of the class. - HTTP request - domain/realm. + Delegate used to provide information used during authentication. - + - Process an incoming request. + Create a response that can be sent in the WWW-Authenticate header. - connection to client - request information - response that should be filled - session information + Realm that the user should authenticate in + Not used in basic auth + A correct auth request. - + - Can be overloaded to implement stuff when a client have been connected. + An authentication response have been received from the web browser. + Check if it's correct - - Default implementation does nothing. - - client that disconnected - disconnect reason + Contents from the Authorization header + Realm that should be authenticated + GET/POST/PUT/DELETE etc. + Not used in basic auth + Authentication object that is stored for the request. A user class or something like that. + if authenticationHeader is invalid + If any of the paramters is empty or null. - + - Handle authentication + name used in http request. - - - - true if request can be handled; false if not. - Invalid authorization header - + - Will request authentication. + Implements HTTP Digest authentication. It's more secure than Basic auth since password is + encrypted with a "key" from the server. - Sends respond to client, nothing else can be done with the response after this. + Keep in mind that the password is encrypted with MD5. Use a combination of SSL and digest auth to be secure. - - - - - - - Received from a when a request have been parsed successfully. - - that received the request. - The request. - + - To be able to track request count. + Initializes a new instance of the class. - - + Delegate used to provide information used during authentication. + Delegate used to determine if authentication is required (may be null). - + - Start the web server using regular HTTP. + Initializes a new instance of the class. - IP Address to listen on, use IpAddress.Any to accept connections on all IP addresses/network cards. - Port to listen on. 80 can be a good idea =) - address is null. - Port must be a positive number. + Delegate used to provide information used during authentication. - + - Accept secure connections. + Used by test classes to be able to use hardcoded values - IP Address to listen on, use to accept connections on all IP Addresses / network cards. - Port to listen on. 80 can be a good idea =) - Certificate to use - address is null. - Port must be a positive number. - + - shut down the server and listeners + name used in http request. - + - write an entry to the log file + An authentication response have been received from the web browser. + Check if it's correct - importance of the message - log message - - - - write an entry to the log file - - object that wrote the message - importance of the message - log message + Contents from the Authorization header + Realm that should be authenticated + GET/POST/PUT/DELETE etc. + First option: true if username/password is correct but not cnonce + + Authentication object that is stored for the request. A user class or something like that. + + if authenticationHeader is invalid + If any of the paramters is empty or null. - + - Server that is handling the current request. + Gets or sets whether the token supplied in is a + HA1 generated string. - - Will be set as soon as a request arrives to the object. - - + - Modules used for authentication. The module that is is added first is used as - the default authentication module. + Encrypts parameters into a Digest string - Use the corresponding property - in the if you are using multiple websites. + Realm that the user want to log into. + User logging in + Users password. + HTTP method. + Uri/domain that generated the login prompt. + Quality of Protection. + "Number used ONCE" + Hexadecimal request counter. + "Client Number used ONCE" + Digest encrypted string - + - Form decoder providers are used to decode request body (which normally contains form data). + + Md5 hex encoded "userName:realm:password", without the quotes. + Md5 hex encoded "method:uri", without the quotes + Quality of Protection + "Number used ONCE" + Hexadecimal request counter. + Client number used once + - + - Server name sent in HTTP responses. + Create a response that can be sent in the WWW-Authenticate header. - - Do NOT include version in name, since it makes it - easier for hackers. - + Realm that the user should authenticate in + First options specifies if true if username/password is correct but not cnonce. + A correct auth request. + If realm is empty or null. - + - Name of cookie where session id is stored. + Decodes authorization header value + header value + Encoding that the buffer is in + All headers and their values if successful; otherwise null + + NameValueCollection header = DigestAuthentication.Decode("response=\"6629fae49393a05397450978507c4ef1\",\r\nc=00001", Encoding.ASCII); + + Can handle lots of whitespaces and new lines without failing. - + - Specified where logging should go. + Gets the current nonce. - - - + - + - Number of connections that can wait to be accepted by the server. + Gets the Md5 hash bin hex2. - Default is 10. + To be hashed. + - + - Gets or sets maximum number of allowed simultaneous requests. + determines if the nonce is valid or has expired. - - - This property is useful in busy systems. The HTTP server - will start queuing new requests if this limit is hit, instead - of trying to process all incoming requests directly. - - - The default number if allowed simultaneous requests are 10. - - + nonce value (check wikipedia for info) + true if the nonce has not expired. - + - Gets or sets maximum number of requests queuing to be handled. + Small design by contract implementation. - - - The WebServer will start turning requests away if response code - to indicate that the server - is too busy to be able to handle the request. - - - + - Realms are used during HTTP authentication. - Default realm is same as server name. + Check whether a parameter is empty. + Parameter value + Parameter name, or error description. + value is empty. - + - Let's to receive unhandled exceptions from the threads. + Checks whether a parameter is null. - - Exceptions will be thrown during debug mode if this event is not used, - exceptions will be printed to console and suppressed during release mode. - + Parameter value + Parameter name, or error description. + value is null. - + - Serves files that are stored in embedded resources. + Checks whether a parameter is null. + + Parameter value + Parameter name, or error description. + value is null. - + - A HttpModule can be used to serve Uri's. The module itself - decides if it should serve a Uri or not. In this way, you can - get a very flexible http application since you can let multiple modules - serve almost similar urls. + Invoked when a client have been accepted by the - Throw if you are using a and want to prompt for user name/password. + Can be used to revoke incoming connections - + - Method that process the url + Initializes a new instance of the class. - Information sent by the browser about the request - Information that is being sent back to the client. - Session used to - true if this module handled the request. + The socket. - + - Set the log writer to use. + Accepted socket. - logwriter to use. - + - Log something. + Client should be revoked. - importance of log message - message - + - If true specifies that the module doesn't consume the processing of a request so that subsequent modules - can continue processing afterwards. Default is false. + Client may not be handled. - + - Initializes a new instance of the class. - Runs to make sure the basic mime types are available, they can be cleared later - through the use of if desired. + Add a component instance + Interface type + Instance to add - + - Initializes a new instance of the class. - Runs to make sure the basic mime types are available, they can be cleared later - through the use of if desired. + Get a component. - The log writer to use when logging events + Interface type + Component if registered, otherwise null. + + Component will get created if needed. + - + + If instance cannot be created. + + - Mimtypes that this class can handle per default + Checks if the specified component interface have been added. + + true if found; otherwise false. - + - Loads resources from a namespace in the given assembly to an uri + Add a component. - The uri to map the resources to - The assembly in which the resources reside - The namespace from which to load the resources - - resourceLoader.LoadResources("/user/", typeof(User).Assembly, "MyLib.Models.User.Views"); - - will make ie the resource MyLib.Models.User.Views.stylesheet.css accessible via /user/stylesheet.css - - The amount of loaded files, giving you the possibility of making sure the resources needed gets loaded + Type being requested. + Type being created. + Type have already been mapped. - + - Returns true if the module can handle the request + Lists content type mime types. - + - Method that process the url + text/plain - Information sent by the browser about the request - Information that is being sent back to the client. - Session used to - true if this module handled the request. - + - List with all mime-type that are allowed. + text/haml - All other mime types will result in a Forbidden http status code. - + - Contains some kind of input from the browser/client. - can be QueryString, form data or any other request body content. + content type for javascript documents = application/javascript + + + RFC 4329 states that text/javascript have been superseeded by + application/javascript. You might still want to check browser versions + since older ones do not support application/javascript. + + Browser support: http://krijnhoetmer.nl/stuff/javascript/mime-types/ + - + - Base class for request data containers + text/xml - + - Adds a parameter mapped to the presented name + A list of content types - The name to map the parameter to - The parameter value - + - Returns true if the container contains the requested parameter + - Parameter id - True if parameter exists + Semicolon separated content types. - + - Returns a request parameter + Get this first content type. - The name associated with the parameter - - - - Representation of a non-initialized class instance - - Variable telling the class that it is non-initialized - - + - Initializes a new instance of the class. + Fetch a content type - form name. + Part of type ("xml" would return "application/xml") + + All content types are in lower case. - + - Initializes a new instance of the class. + Returns an enumerator that iterates through a collection. - form name. - if set to true all changes will be ignored. - this constructor should only be used by Empty - - - Creates a deep copy of the HttpInput class - The object to copy - The function makes a deep copy of quite a lot which can be slow + + An object that can be used to iterate through the collection. + - + - Add a new element. Form array elements are parsed - and added in a correct hierarchy. + Searches for the specified type - Name is converted to lower case. - - name is null. - Cannot add stuff to . + Can also be a part of a type (searching for "xml" would return true for "application/xml"). + true if type was found. - + - Returns true if the class contains a with the corresponding name. + Timeout Manager. Checks for dead clients. Clients with open connections that are not doing anything. Closes sessions opened with keepalive. - The field/query string name - True if the value exists - + - Parses an item and returns it. - This function is primarily used to parse array items as in user[name]. + Use a Thread or a Timer to monitor the ugly - - - - - Outputs the instance representing all its values joined together - + + + Causes the watcher to immediately check the connections. + - - Returns all items as an unescaped query string. + + + Environment.TickCount is an int but it counts all 32 bits so it goes positive + and negative every 24.9 days. This trims down TickCount so it doesn't wrap + for the callers. + This trims it to a 12 day interval so don't let your frame time get too long. + - + - Extracts one parameter from an array + Environment.TickCount is an int but it counts all 32 bits so it goes positive + and negative every 24.9 days. Subtracts the passed value (previously fetched by + 'EnvironmentTickCount()') and accounts for any wrapping. - Containing the string array - All but the first value - - string test1 = ExtractOne("system[user][extension][id]"); - string test2 = ExtractOne(test1); - string test3 = ExtractOne(test2); - // test1 = user[extension][id] - // test2 = extension[id] - // test3 = id - + + + subtraction of passed prevValue from current Environment.TickCount - - Resets all data contained by class + + + Environment.TickCount is an int but it counts all 32 bits so it goes positive + and negative every 24.9 days. Subtracts the passed value (previously fetched by + 'EnvironmentTickCount()') and accounts for any wrapping. + + + + subtraction of passed prevValue from current Environment.TickCount - + - Returns an enumerator that iterates through the collection. + Environment.TickCount is an int but it counts all 32 bits so it goes positive + and negative every 24.9 days. Subtracts the passed value (previously fetched by + 'EnvironmentTickCount()') and accounts for any wrapping. - - - A that can be used to iterate through the collection. - - 1 + subtraction of passed prevValue from current Environment.TickCount - + - Returns an enumerator that iterates through a collection. + We dont want to let the server to die due to exceptions thrown in worker threads. + therefore we use this delegate to give you a change to handle uncaught exceptions. + Class that the exception was thrown in. + Exception + + Server will throw a InternalServerException in release version if you dont + handle this delegate. + + + + + The request could not be understood by the server due to malformed syntax. + The client SHOULD NOT repeat the request without modifications. - - An object that can be used to iterate through the collection. - - 2 + Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php + - + - Form name as lower case + Create a new bad request exception. + reason to why the request was bad. - + - Get a form item. + Create a new bad request exception. - - Returns if item was not found. + reason to why the request was bad. + inner exception @@ -572,6 +532,12 @@ Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php + + + Initializes a new instance of the class. + + error message + All HTTP based exceptions will derive this class. @@ -597,289 +563,217 @@ status code to use in the response. - + - Initializes a new instance of the class. + The server encountered an unexpected condition which prevented it from fulfilling the request. - error message - + - This class is created as a wrapper, since there are two different cookie types in .Net (Cookie and HttpCookie). - The framework might switch class in the future and we dont want to have to replace all instances + Initializes a new instance of the class. - + - Let's copy all the cookies. + Initializes a new instance of the class. - value from cookie header. + error message. - + - Adds a cookie in the collection. + Initializes a new instance of the class. - cookie to add - cookie is null + error message. + inner exception. - + - Gets a collection enumerator on the cookie list. + The requested resource was not found in the web server. - collection enumerator - + - Remove all cookies. + Create a new exception + message describing the error + inner exception - + - Returns an enumerator that iterates through the collection. + Create a new exception - - - A that can be used to iterate through the collection. - - 1 + message describing the error - + - Remove a cookie from the collection. + The request requires user authentication. The response MUST include a + WWW-Authenticate header field (section 14.47) containing a challenge + applicable to the requested resource. + + The client MAY repeat the request with a suitable Authorization header + field (section 14.8). If the request already included Authorization + credentials, then the 401 response indicates that authorization has been + refused for those credentials. If the 401 response contains the same challenge + as the prior response, and the user agent has already attempted authentication + at least once, then the user SHOULD be presented the entity that was given in the response, + since that entity might include relevant diagnostic information. + + HTTP access authentication is explained in rfc2617: + http://www.ietf.org/rfc/rfc2617.txt + + (description is taken from + http://www.submissionchamber.com/help-guides/error-codes.php#sec10.4.2) - Name of cookie. - + - Gets the count of cookies in the collection. + Create a new unauhtorized exception. + - + - Gets the cookie of a given identifier (null if not existing). + Create a new unauhtorized exception. + reason to why the request was unauthorized. + inner exception - + - Contains a connection to a browser/client. + Create a new unauhtorized exception. + reason to why the request was unauthorized. - - - Disconnect from client - - error to report in the event. - - - - Send a response. - - Either or - HTTP status code - reason for the status code. - HTML body contents, can be null or empty. - A content type to return the body as, i.e. 'text/html' or 'text/plain', defaults to 'text/html' if null or empty - If is invalid. - - - - Send a response. - - Either or - HTTP status code - reason for the status code. - - + - Send a response. + This provider is used to let us implement any type of form decoding we want without + having to rewrite anything else in the server. - - + - send a whole buffer + - buffer to send - + Should contain boundary and type, as in: multipart/form-data; boundary=---------------------------230051238959 + Stream containing form data. + Encoding used when decoding the stream + if no parser was found. + If stream is null or not readable. + If stream contents cannot be decoded properly. - + - Send data using the stream + Add a decoder. - Contains data to send - Start position in buffer - number of bytes to send + - - + - Closes the streams and disposes of the unmanaged resources + Number of added decoders. - + - Using SSL or other encryption method. + Use with care. - + - Using SSL or other encryption method. + Decoder used for unknown content types. - - - The context have been disconnected. - - - Event can be used to clean up a context, or to reuse it. - + + Represents a field in a multipart form - + - A request have been received in the context. + + + + - + - A have been disconnected. + Interface for form content decoders. - + - Initializes a new instance of the class. + - Reason to disconnection. + Stream containing the content + Content type (with any additional info like boundry). Content type is always supplied in lower case + Stream enconding + A http form, or null if content could not be parsed. + If contents in the stream is not valid input data. - + - Gets reason to why client disconnected. + Checks if the decoder can handle the mime type + Content type (with any additional info like boundry). Content type is always supplied in lower case. + True if the decoder can parse the specified content type - + + + http://www.faqs.org/rfcs/rfc1867.html + - - - Initializes a new instance of the class. - - The request. - - + - Gets received request. + multipart/form-data - + - Returns item either from a form or a query string (checks them in that order) + form-data - - Representation of a non-initialized HttpParam - - - Initialises the class to hold a value either from a post request or a querystring request - - + - The add method is not availible for HttpParam - since HttpParam checks both Request.Form and Request.QueryString + - name identifying the value - value to add - + Stream containing the content + Content type (with any additional info like boundry). Content type is always supplied in lower case + Stream enconding + A http form, or null if content could not be parsed. + If contents in the stream is not valid input data. + If any parameter is null - + - Checks whether the form or querystring has the specified value + Checks if the decoder can handle the mime type - Name, case sensitive - true if found; otherwise false. + Content type (with any additional info like boundry). Content type is always supplied in lower case. + True if the decoder can parse the specified content type - + - Returns an enumerator that iterates through the collection. + Can handle application/x-www-form-urlencoded - - - A that can be used to iterate through the collection. - - 1 - + - Returns an enumerator that iterates through a collection. - + Stream containing the content + Content type (with any additional info like boundry). Content type is always supplied in lower case + Stream encoding - An object that can be used to iterate through the collection. + A HTTP form, or null if content could not be parsed. - 2 - - - - Fetch an item from the form or querystring (in that order). - - - Item if found; otherwise HttpInputItem.EmptyLanguageNode - - - - Container class for posted files - - - - - Creates a container for a posted file - - The identifier of the post field - The file path - The content type of the file - The name of the file uploaded - If any parameter is null or empty - - - - Creates a container for a posted file - - If any parameter is null or empty - - - Destructor disposing the file - - - - Deletes the temporary file - - True if manual dispose - - - - Disposing interface, cleans up managed resources (the temporary file) and suppresses finalization - - - - - The name/id of the file - - - - - The full file path - - - - - The name of the uploaded file - + If contents in the stream is not valid input data. - + - The type of file + Checks if the decoder can handle the mime type + Content type (with any additional info like boundry). Content type is always supplied in lower case. + True if the decoder can parse the specified content type @@ -898,28 +792,6 @@ The original xml document is stored in form["__xml__"].Value. - - - Interface for form content decoders. - - - - - - - Stream containing the content - Content type (with any additional info like boundry). Content type is always supplied in lower case - Stream enconding - A http form, or null if content could not be parsed. - If contents in the stream is not valid input data. - - - - Checks if the decoder can handle the mime type - - Content type (with any additional info like boundry). Content type is always supplied in lower case. - True if the decoder can parse the specified content type - @@ -946,9 +818,442 @@ Content type (with any additional info like boundry). Content type is always supplied in lower case. True if the decoder can parse the specified content type - + - The object form class takes an object and creates form items for it. + Helpers making it easier to work with forms. + + + + + + Used to let the website use different JavaScript libraries. + Default is + + + + + Create a <form> tag. + + name of form + action to invoke on submit + form should be posted as Ajax + HTML code + + + // without options + WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); + + // with options + WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax, "style", "display:inline", "class", "greenForm"); + + + HTML attributes or JavaScript options. + Method will ALWAYS be POST. + options must consist of name, value, name, value + + + + Creates a select list with the values in a collection. + + Name of the SELECT-tag + collection used to generate options. + delegate used to return id and title from objects. + value that should be marked as selected. + First row should contain an empty value. + string containing a SELECT-tag. + + + + + Creates a select list with the values in a collection. + + Name of the SELECT-tag + Id of the SELECT-tag + collection used to generate options. + delegate used to return id and title from objects. + value that should be marked as selected. + First row should contain an empty value. + string containing a SELECT-tag. + + + + // Class that is going to be used in a SELECT-tag. + public class User + { + private readonly string _realName; + private readonly int _id; + public User(int id, string realName) + { + _id = id; + _realName = realName; + } + public string RealName + { + get { return _realName; } + } + + public int Id + { + get { return _id; } + } + } + + // Using an inline delegate to generate the select list + public void UserInlineDelegate() + { + List<User> items = new List<User>(); + items.Add(new User(1, "adam")); + items.Add(new User(2, "bertial")); + items.Add(new User(3, "david")); + string htmlSelect = Select("users", "users", items, delegate(object o, out object id, out object value) + { + User user = (User)o; + id = user.Id; + value = user.RealName; + }, 2, true); + } + + // Using an method as delegate to generate the select list. + public void UseExternalDelegate() + { + List<User> items = new List<User>(); + items.Add(new User(1, "adam")); + items.Add(new User(2, "bertial")); + items.Add(new User(3, "david")); + string htmlSelect = Select("users", "users", items, UserOptions, 1, true); + } + + // delegate returning id and title + public static void UserOptions(object o, out object id, out object title) + { + User user = (User)o; + id = user.Id; + value = user.RealName; + } + + + name, id, collection or getIdTitle is null. + + + + Creates a select list with the values in a collection. + + Name of the SELECT-tag + Id of the SELECT-tag + collection used to generate options. + delegate used to return id and title from objects. + value that should be marked as selected. + First row should contain an empty value. + name, value collection of extra HTML attributes. + string containing a SELECT-tag. + + name, id, collection or getIdTitle is null. + Invalid HTML attribute list. + + + + Generate a list of HTML options + + collection used to generate options. + delegate used to return id and title from objects. + value that should be marked as selected. + First row should contain an empty value. + + collection or getIdTitle is null. + + + sb is null. + + + + Creates a check box. + + element name + element value + determines if the check box is selected or not. This is done differently depending on the + type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if + the box is checked or not. + a list with additional attributes (name, value, name, value). + a generated radio button + + + + Creates a check box. + + element name + element id + element value + determines if the check box is selected or not. This is done differently depending on the + type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if + the box is checked or not. + a list with additional attributes (name, value, name, value). + a generated radio button + + value in your business object. (check box will be selected if it matches the element value) + + + + + Creates a check box. + + element name + element id + determines if the check box is selected or not. This is done differently depending on the + type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if + the box is checked or not. + a list with additional attributes (name, value, name, value). + a generated radio button + will set value to "1". + + + + Creates a RadioButton. + + element name + element value + determines if the radio button is selected or not. This is done differently depending on the + type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if + the box is checked or not. + a list with additional attributes (name, value, name, value). + a generated radio button + + + + Creates a RadioButton. + + element name + element id + element value + determines if the radio button is selected or not. This is done differently depending on the + type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if + the box is checked or not. + a list with additional attributes (name, value, name, value). + a generated radio button + + + + form close tag + + + + + + Delegate used by to populate select options. + + current object (for instance a User). + Text that should be displayed in the value part of a <optiongt;-tag. + Text shown in the select list. + + // Class that is going to be used in a SELECT-tag. + public class User + { + private readonly string _realName; + private readonly int _id; + public User(int id, string realName) + { + _id = id; + _realName = realName; + } + public string RealName + { + get { return _realName; } + } + + public int Id + { + get { return _id; } + } + } + + // Using an inline delegate to generate the select list + public void UserInlineDelegate() + { + List<User> items = new List<User>(); + items.Add(new User(1, "adam")); + items.Add(new User(2, "bertial")); + items.Add(new User(3, "david")); + string htmlSelect = Select("users", "users", items, delegate(object o, out object id, out object value) + { + User user = (User)o; + id = user.Id; + value = user.RealName; + }, 2, true); + } + + // Using an method as delegate to generate the select list. + public void UseExternalDelegate() + { + List<User> items = new List<User>(); + items.Add(new User(1, "adam")); + items.Add(new User(2, "bertial")); + items.Add(new User(3, "david")); + string htmlSelect = Select("users", "users", items, UserOptions, 1, true); + } + + // delegate returning id and title + public static void UserOptions(object o, out object id, out object title) + { + User user = (User)o; + id = user.Id; + value = user.RealName; + } /// + + + + PrototypeJS implementation of the javascript functions. + + + + + Requests a url through ajax + + url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself. + optional options in format "key, value, key, value", used in JS request object. All keys should end with colon. + a link tag + onclick attribute is used by this method. + + + // plain text + JSHelper.AjaxRequest("'/user/show/1'"); + + // ajax request using this.href + string link = "<a href=\"/user/call/1\" onclick=\"" + JSHelper.AjaxRequest("this.href") + "/<call user</a>"; + + + + + + Determins if a list of strings contains a specific value + + options to check in + value to find + true if value was found + case insensitive + + + + Ajax requests that updates an element with + the fetched content + + URL to fetch. URL is NOT enclosed in quotes by the implementation. You need to do that yourself. + element to update + options in format "key, value, key, value". All keys should end with colon. + A link tag. + + + JSHelper.AjaxUpdater("'/user/show/1'", "user", "onsuccess:", "alert('hello');", "asynchronous:", "true"); + + + + + + A link that pop ups a Dialog (overlay div) + + URL to contents of dialog + link title + name, value, name, value + + A "a"-tag that popups a dialog when clicked + + Requires Control.Modal found here: http://livepipe.net/projects/control_modal/ + And the following JavaScript (load it in application.js): + + Event.observe(window, 'load', + function() { + document.getElementsByClassName('modal').each(function(link){ new Control.Modal(link); }); + } + ); + + + + WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); + + + + + create a modal dialog (usually using DIVs) + + url to fetch + dialog title + javascript/html attributes. javascript options ends with colon ':'. + + + + + Close a javascript dialog window/div. + + javascript for closing a dialog. + + + + + javascript action that should be added to the "onsubmit" event in the form tag. + + remember to encapsulate strings in '' + + All javascript option names should end with colon. + + + JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); + + + + + + Will contain helper functions for javascript. + + + + + Requests a url through ajax + + url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself. + optional options in format "key, value, key, value", used in JS request object. All keys should end with colon. + a link tag + onclick attribute is used by this method. + + + // plain text + JSHelper.AjaxRequest("'/user/show/1'"); + + // ajax request using this.href + string link = "<a href=\"/user/call/1\" onclick=\"" + JSHelper.AjaxRequest("this.href") + "/<call user</a>"; + + + + + + Ajax requests that updates an element with + the fetched content + + url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself. + element to update + options in format "key, value, key, value". All keys should end with colon. + A link tag. + + + JSHelper.AjaxUpdater("'/user/show/1'", "user", "onsuccess:", "alert('hello');", "asynchronous:", "true"); + + + + + + Opens contents in a dialog window. + + url to contents of dialog + link title + name, value, name, value, all parameter names should end with colon. + + + + Close a javascript dialog window/div. + + javascript for closing a dialog. + + + + + The object form class takes an object and creates form items for it. @@ -1063,2718 +1368,2467 @@ html - + - + Container to bind resource names to assemblies - - http://www.faqs.org/rfcs/rfc1867.html - - + - multipart/form-data + Instantiates an instance of + The dot seperated uri the resource maps to + The full resource name + The assembly the resource exists in - + - form-data + Retrieves the assembly the resource resides in - + - + Retrieves the full name/path of the assembly - Stream containing the content - Content type (with any additional info like boundry). Content type is always supplied in lower case - Stream enconding - A http form, or null if content could not be parsed. - If contents in the stream is not valid input data. - If any parameter is null - + - Checks if the decoder can handle the mime type + Retrieves the extension of the resource - Content type (with any additional info like boundry). Content type is always supplied in lower case. - True if the decoder can parse the specified content type - - - The request could not be understood by the server due to malformed syntax. - The client SHOULD NOT repeat the request without modifications. - - Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php - + + Returns the Uri without extension - - - Create a new bad request exception. - - reason to why the request was bad. + + Retrieves the full path name to the resource file - + - Create a new bad request exception. + Retrieves a stream to the resource - reason to why the request was bad. - inner exception + Null if the resource couldn't be located somehow - - - Cookies that should be set. - + + Class to handle loading of resource files - + - Adds a cookie in the collection. + Initializes a new instance of the class. - cookie to add - cookie is null - + - Copy a request cookie + Initializes a new instance of the class. - - When the cookie should expire + logger. - + - Gets a collection enumerator on the cookie list. + Loads resources from a namespace in the given assembly to an URI - collection enumerator + The URI to map the resources to + The assembly in which the resources reside + The namespace from which to load the resources + + + resourceLoader.LoadResources("/user/", typeof(User).Assembly, "MyLib.Models.User.Views"); + + Will make the resource MyLib.Models.User.Views.list.Haml accessible via /user/list.haml or /user/list/ + + The amount of loaded files, giving you the possibility of making sure the resources needed gets loaded + If a resource has already been mapped to an uri - + - Remove all cookies + Retrieves a stream for the specified resource path if loaded otherwise null + Path to the resource to retrieve a stream for + A stream or null if the resource couldn't be found - + - Returns an enumerator that iterates through the collection. + Fetch all files from the resource that matches the specified arguments. - + The path to the resource to extract - A that can be used to iterate through the collection. + a list of files if found; or an empty array if no files are found. - 1 - - - - Gets the count of cookies in the collection. - - - - - Gets the cookie of a given identifier (null if not existing). - - - - - cookie being sent back to the browser. - - - - - - cookie sent by the client/browser - - - - - - Constructor. - - cookie identifier - cookie content - id or content is null - id is empty - - - - Gets the cookie HTML representation. - - cookie string - - - - Gets the cookie identifier. - - - - - Cookie value. Set to null to remove cookie. - - - - - Constructor. - - cookie identifier - cookie content - cookie expiration date. Use DateTime.MinValue for session cookie. - id or content is null - id is empty - - - - Create a new cookie - - name identifying the cookie - cookie value - when the cookie expires. Setting DateTime.MinValue will delete the cookie when the session is closed. - Path to where the cookie is valid - Domain that the cookie is valid for. + Search path must end with an asterisk for finding arbitrary files - + - Create a new cookie + Fetch all files from the resource that matches the specified arguments. - Name and value will be used - when the cookie expires. + Where the file should reside. + Files to check + + a list of files if found; or an empty array if no files are found. + - + - Gets the cookie HTML representation. + Returns whether or not the loader has an instance of the file requested - cookie string + The name of the template/file + True if the loader can provide the file - + - When the cookie expires. - DateTime.MinValue means that the cookie expires when the session do so. + Webhelper provides helpers for common tasks in HTML. - + - Cookie is only valid under this path. + Used to let the website use different javascript libraries. + Default is - + - Inversion of control interface. + Creates a link that invokes through ajax. + url to fetch + link title + + optional options in format "key, value, key, value". + Javascript options starts with ':'. + + a link tag + + WebHelper.AjaxRequest("/users/add/", "Add user", "method:", "post", "onclick", "validate('this');"); + - + - Add a component instance + Builds a link that updates an element with the fetched ajax content. - Interface type - Instance to add + Url to fetch content from + link title + html element to update with the results of the ajax request. + optional options in format "key, value, key, value" + A link tag. - + - Get a component. + A link that pop ups a Dialog (overlay div) - Interface type - Component if registered, otherwise null. - - Component will get created if needed. - + url to contents of dialog + link title + name/value of html attributes. + A "a"-tag that popups a dialog when clicked + + WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); + - + - Checks if the specified component interface have been added. + Create/Open a dialog box using ajax - - true if found; otherwise false. + + + + - + - Add a component. + Close a javascript dialog window/div. - Type being requested. - Type being created. + javascript for closing a dialog. + - + - Contains a listener that doesn't do anything with the connections. + Create a <form> tag. + name of form + action to invoke on submit + form should be posted as ajax + html code + + WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); + - + - Listen for regular HTTP connections + Create a link tag. - IP Address to accept connections on - TCP Port to listen on, default HTTP port is 80. - Factory used to create es. - address is null. - Port must be a positive number. + url to go to + link title (text that is displayed) + html attributes, name, value, name, value + html code + + WebHelper.Link("/user/show/1", "Show user", "id", "showUser", "onclick", "return confirm('Are you shure?');"); + - + - Initializes a new instance of the class. + Build a link - IP Address to accept connections on - TCP Port to listen on, default HTTPS port is 443 - Factory used to create es. - Certificate to use + url to go to. + title of link (displayed text) + extra html attributes. + a complete link - + - Initializes a new instance of the class. + Build a link - IP Address to accept connections on - TCP Port to listen on, default HTTPS port is 443 - Factory used to create es. - Certificate to use - which HTTPS protocol to use, default is TLS. - - - Exception. + url to go to. + title of link (displayed text) + extra html attributes. + a complete link + more options - + - Will try to accept connections one more time. + Obsolete - If any exceptions is thrown. + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete - + - Can be used to create filtering of new connections. + Obsolete - Accepted socket - true if connection can be accepted; otherwise false. + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete - + - Start listen for new connections + Render errors into a UL with class "errors" - Number of connections that can stand in a queue to be accepted. - Listener have already been started. + class used by UL-tag. + items to list + an unordered html list. - + - Stop the listener + Render errors into a UL with class "errors" - + class used by UL-tag. + items to list + an unordered html list. - + - Gives you a change to receive log entries for all internals of the HTTP library. + Render errors into a UL with class "errors" - - You may not switch log writer after starting the listener. - + + - + - True if we should turn on trace logs. + Generates a list with html attributes. + StringBuilder that the options should be added to. + attributes set by user. + attributes set by any of the helper classes. - + - Catch exceptions not handled by the listener. + Generates a list with html attributes. - - Exceptions will be thrown during debug mode if this event is not used, - exceptions will be printed to console and suppressed during release mode. - + StringBuilder that the options should be added to. + - + - A request have been received from a . + Purpose of this class is to create a javascript toolkit independent javascript helper. - + - New implementation of the HTTP listener. + Generates a list with JS options. - - Use the Create methods to create a default listener. - + StringBuilder that the options should be added to. + the javascript options. name, value pairs. each string value should be escaped by YOU! + true if we should start with a comma. - + - Initializes a new instance of the class. + Removes any javascript parameters from an array of parameters - IP Address to accept connections on - TCP Port to listen on, default HTTP port is 80. - Factory used to create es. - address is null. - Port must be a positive number. + The array of parameters to remove javascript params from + An array of html parameters - + - Initializes a new instance of the class. + javascript action that should be added to the "onsubmit" event in the form tag. - The address. - The port. - The factory. - The certificate. + + All javascript option names should end with colon. + + + JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); + + - + - Initializes a new instance of the class. + Requests a url through ajax - The address. - The port. - The factory. - The certificate. - The protocol. + url to fetch + optional options in format "key, value, key, value", used in JS request object. + a link tag + All javascript option names should end with colon. + + + JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); + + - + - Creates a new instance with default factories. + Ajax requests that updates an element with + the fetched content - Address that the listener should accept connections on. - Port that listener should accept connections on. - Created HTTP listener. + Url to fetch content from + element to update + optional options in format "key, value, key, value", used in JS updater object. + A link tag. + All javascript option names should end with colon. + + + JSHelper.AjaxUpdater("/user/show/1", "userInfo", "onsuccess:", "alert('Successful!');"); + + - + - Creates a new instance with default factories. + A link that pop ups a Dialog (overlay div) - Address that the listener should accept connections on. - Port that listener should accept connections on. - Certificate to use - Created HTTP listener. + url to contents of dialog + link title + A "a"-tag that popups a dialog when clicked + name/value of html attributes + + WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); + - + - Creates a new instance with default factories. + Close a javascript dialog window/div. - Address that the listener should accept connections on. - Port that listener should accept connections on. - Certificate to use - which HTTPS protocol to use, default is TLS. - Created HTTP listener. + javascript for closing a dialog. + - + - Can be used to create filtering of new connections. + Creates a new modal dialog window - Accepted socket - - true if connection can be accepted; otherwise false. - + url to open in window. + window title (may not be supported by all js implementations) + + - + - A client have been accepted, but not handled, by the listener. + Helpers to make XML handling easier - + - redirects from one URL to another. + Serializes object to XML. + object to serialize. + XML + + Removes name spaces and adds indentation + - + - Rules are used to perform operations before a request is being handled. - Rules can be used to create routing etc. + Create an object from a XML string + Type of object + XML string + object - + - Process the incoming request. + Contains a connection to a browser/client. - incoming HTTP request - outgoing HTTP response - true if response should be sent to the browser directly (no other rules or modules will be processed). - returning true means that no modules will get the request. Returning true is typically being done - for redirects. + Remember to after you have hooked the event. - If request or response is null. + TODO: Maybe this class should be broken up into HttpClientChannel and HttpClientContext? - + - Initializes a new instance of the class. + This context have been cleaned, which means that it can be reused. - Absolute path (no server name) - Absolute path (no server name) - - server.Add(new RedirectRule("/", "/user/index")); - - + - Initializes a new instance of the class. + Context have been started (a new client have connected) - Absolute path (no server name) - Absolute path (no server name) - true if request should be redirected, false if the request URI should be replaced. - - server.Add(new RedirectRule("/", "/user/index")); - - + - Process the incoming request. + Initializes a new instance of the class. - incoming HTTP request - outgoing HTTP response - true if response should be sent to the browser directly (no other rules or modules will be processed). - - returning true means that no modules will get the request. Returning true is typically being done - for redirects. - + true if the connection is secured (SSL/TLS) + client that connected. + Stream used for communication + Used to create a . + Size of buffer to use when reading data. Must be at least 4096 bytes. + If fails + Stream must be writable and readable. - + - Gets string to match request URI with. + Process incoming body bytes. - Is compared to request.Uri.AbsolutePath + + Bytes - + - Gets where to redirect. + + + - + - Gets whether server should redirect client. + Overload to specify own type. - false means that the rule will replace - the current request URI with the new one from this class. - true means that a redirect response is sent to the client. + Must be specified before the context is being used. - - - Parses a HTTP request directly from a stream - - - + - Event driven parser used to parse incoming HTTP requests. + Start reading content. - The parser supports partial messages and keeps the states between - each parsed buffer. It's therefore important that the parser gets - ed if a client disconnects. + Make sure to call base.Start() if you override this method. - + - Parse partial or complete message. + Clean up context. - buffer containing incoming bytes - where in buffer that parsing should start - number of bytes to parse - Unparsed bytes left in buffer. - BadRequestException. + + Make sure to call base.Cleanup() if you override the method. + - + - Clear parser state. + Using SSL or other encryption method. - + - Current state in parser. + Using SSL or other encryption method. - + - A request have been successfully parsed. + Specify which logger to use. - + - More body bytes have been received. + Gets or sets the network stream. - + - Request line have been received. + Gets or sets IP address that the client connected from. - + - A header have been received. + Gets or sets port that the client connected from. - + - Gets or sets the log writer. + Disconnect from client + error to report in the event. - + - Create a new request parser + Send a response. - delegate receiving log entries. + Either or + HTTP status code + reason for the status code. + HTML body contents, can be null or empty. + A content type to return the body as, i.e. 'text/html' or 'text/plain', defaults to 'text/html' if null or empty + If is invalid. - + - Add a number of bytes to the body + Send a response. - buffer containing more body bytes. - starting offset in buffer - number of bytes, from offset, to read. - offset to continue from. + Either or + HTTP status code + reason for the status code. - + - Remove all state information for the request. + Send a response. + - + - Parse request line + send a whole buffer - - If line is incorrect - Expects the following format: "Method SP Request-URI SP HTTP-Version CRLF" + buffer to send + - + - We've parsed a new header. + Send data using the stream - Name in lower case - Value, unmodified. - If content length cannot be parsed. + Contains data to send + Start position in buffer + number of bytes to send + + - + - Parse a message + The context have been disconnected. - bytes to parse. - where in buffer that parsing should start - number of bytes to parse, starting on . - offset (where to start parsing next). - BadRequestException. + + Event can be used to clean up a context, or to reuse it. + - + - Gets or sets the log writer. + A request have been received in the context. - + - Current state in parser. + Used to create and reuse contexts. - + - A request have been successfully parsed. + Initializes a new instance of the class. + The writer. + Amount of bytes to read from the incoming socket stream. + Used to create a request parser. - + - More body bytes have been received. + True if detailed trace logs should be written. - + - Request line have been received. + Create a new context. + true if socket is running HTTPS. + Client that connected + Network/SSL stream. + A context. - + - A header have been received. + Create a new context. + true if HTTPS is used. + Remote client + Network stream, uses . + A new context (always). - + - A thread-safe lockless queue that supports multiple readers and - multiple writers + Create a secure . + Client socket (accepted by the ). + HTTPS certificate to use. + Kind of HTTPS protocol. Usually TLS or SSL. + + A created . + - - Queue head - - - Queue tail - - - Queue item count - - + - Constructor + A request have been received from one of the contexts. - + - Enqueue an item + Creates a that handles a connected client. - Item to enqeue + Client socket (accepted by the ). + + A creates . + - + - Try to dequeue an item + Server is shutting down so shut down the factory - Dequeued item if the dequeue was successful - True if an item was successfully deqeued, otherwise false - - - Gets the current number of items in the queue. Since this - is a lockless collection this value should be treated as a close - estimate - + - Provides a node container for data in a singly linked list + Custom network stream to mark sockets as reusable when disposing the stream. - - Pointer to the next node in list - - - The data contained by the node - - + - Constructor + Creates a new instance of the class for the specified . + + The that the will use to send and receive data. + + + The parameter is null. + + + The parameter is not connected. + -or- + The property of the parameter is not . + -or- + The parameter is in a nonblocking state. + - + - Constructor + Initializes a new instance of the class for the specified with the specified ownership. + + The that the will use to send and receive data. + + + Set to true to indicate that the will take ownership of the ; otherwise, false. + + + The parameter is null. + + + The parameter is not connected. + -or- + the value of the property of the parameter is not . + -or- + the parameter is in a nonblocking state. + - + - Contains server side HTTP request information. + Creates a new instance of the class for the specified with the specified access rights. + + The that the will use to send and receive data. + + + A bitwise combination of the values that specify the type of access given to the over the provided . + + + The parameter is null. + + + The parameter is not connected. + -or- + the property of the parameter is not . + -or- + the parameter is in a nonblocking state. + - + - Called during parsing of a . + Creates a new instance of the class for the specified with the specified access rights and the specified ownership. - Name of the header, should not be URL encoded - Value of the header, should not be URL encoded - If a header is incorrect. + + The that the will use to send and receive data. + + + A bitwise combination of the values that specifies the type of access given to the over the provided . + + + Set to true to indicate that the will take ownership of the ; otherwise, false. + + + The parameter is null. + + + The parameter is not connected. + -or- + The property of the parameter is not . + -or- + The parameter is in a nonblocking state. + - + - Add bytes to the body + Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. - buffer to read bytes from - where to start read - number of bytes to read - Number of bytes actually read (same as length unless we got all body bytes). - If body is not writable - bytes is null. - offset is out of range. - + - Clear everything in the request + Releases the unmanaged resources used by the and optionally releases the managed resources. + true to release both managed and unmanaged resources; false to release only unmanaged resources. - + - Decode body into a form. + Used to create es. - A list with form decoders. - If body contents is not valid for the chosen decoder. - If body is still being transferred. - + - Sets the cookies. + Creates a that handles a connected client. - The cookies. + Client socket (accepted by the ). + A creates . - + - Create a response object. + Create a secure . - Context for the connected client. - A new . + Client socket (accepted by the ). + HTTPS certificate to use. + Kind of HTTPS protocol. Usually TLS or SSL. + A created . - + - Gets kind of types accepted by the client. + A request have been received from one of the contexts. - + - Gets or sets body stream. + Server is shutting down so shut down the factory - + - Gets whether the body is complete. + Container class for posted files - + - Gets or sets kind of connection used for the session. + Creates a container for a posted file + The identifier of the post field + The file path + The content type of the file + The name of the file uploaded + If any parameter is null or empty - + - Gets or sets number of bytes in the body. + Creates a container for a posted file + If any parameter is null or empty - + + Destructor disposing the file + + - Gets cookies that was sent with the request. + The name/id of the file - + - Gets form parameters. + The full file path - + - Gets headers sent by the client. + The name of the uploaded file - + - Gets or sets version of HTTP protocol that's used. + The type of file - - Probably or . - - - + - Gets whether the request was made by Ajax (Asynchronous JavaScript) + Deletes the temporary file + True if manual dispose - + - Gets or sets requested method. + Disposing interface, cleans up managed resources (the temporary file) and suppresses finalization - - Will always be in upper case. - - - - - Gets parameter from or . - + + Container for posted form data + + + Instance to help mark a non-initialized form + + + Initializes a form container with the specified name - + - Gets variables sent in the query string + Makes a deep copy of the input + The input to copy - + - Gets or sets requested URI. + Adds a file to the collection of posted files + The file to add + If the file is already added + If file is null + If the instance is HttpForm.EmptyForm which cannot be modified - + - Gets URI absolute path divided into parts. + Checks if the form contains a specified file - - // URI is: http://gauffin.com/code/tiny/ - Console.WriteLine(request.UriParts[0]); // result: code - Console.WriteLine(request.UriParts[1]); // result: tiny - - - If you're using controllers than the first part is controller name, - the second part is method name and the third part is Id property. - - + Field name of the file parameter + True if the file exists + If the instance is HttpForm.EmptyForm which cannot be modified - + - Gets or sets path and query. + Retrieves a file held by by the form - - - Are only used during request parsing. Cannot be set after "Host" header have been - added. - + The identifier of the file + The requested file or null if the file was not found + If name is null or empty + If the instance is HttpForm.EmptyForm which cannot be modified - + - PrototypeJS implementation of the javascript functions. + Retrieves the number of files added to the + 0 if no files are added - + + Disposes all held HttpFile's and resets values + + - Purpose of this class is to create a javascript toolkit independent javascript helper. + Generic helper functions for HTTP - + - Generates a list with JS options. + Version string for HTTP v1.0 - StringBuilder that the options should be added to. - the javascript options. name, value pairs. each string value should be escaped by YOU! - true if we should start with a comma. - + - Removes any javascript parameters from an array of parameters + Version string for HTTP v1.1 - The array of parameters to remove javascript params from - An array of html parameters - + - javascript action that should be added to the "onsubmit" event in the form tag. + An empty URI - - All javascript option names should end with colon. - - - JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); - - - + - Requests a url through ajax + Parses a query string. - url to fetch - optional options in format "key, value, key, value", used in JS request object. - a link tag - All javascript option names should end with colon. - - - JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); - - + Query string (URI encoded) + A object if successful; otherwise + queryString is null. + If string cannot be parsed. - + - Ajax requests that updates an element with - the fetched content + Contains some kind of input from the browser/client. + can be QueryString, form data or any other request body content. - Url to fetch content from - element to update - optional options in format "key, value, key, value", used in JS updater object. - A link tag. - All javascript option names should end with colon. - - - JSHelper.AjaxUpdater("/user/show/1", "userInfo", "onsuccess:", "alert('Successful!');"); - - - + + Representation of a non-initialized class instance + + + Variable telling the class that it is non-initialized + + - A link that pop ups a Dialog (overlay div) + Initializes a new instance of the class. - url to contents of dialog - link title - A "a"-tag that popups a dialog when clicked - name/value of html attributes - - WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); - + form name. - + - Close a javascript dialog window/div. + Initializes a new instance of the class. - javascript for closing a dialog. - + form name. + if set to true all changes will be ignored. + this constructor should only be used by Empty - + + Creates a deep copy of the HttpInput class + The object to copy + The function makes a deep copy of quite a lot which can be slow + + - Creates a new modal dialog window + Form name as lower case - url to open in window. - window title (may not be supported by all js implementations) - - - + - Requests a url through ajax + Add a new element. Form array elements are parsed + and added in a correct hierarchy. - url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself. - optional options in format "key, value, key, value", used in JS request object. All keys should end with colon. - a link tag - onclick attribute is used by this method. - - - // plain text - JSHelper.AjaxRequest("'/user/show/1'"); - - // ajax request using this.href - string link = "<a href=\"/user/call/1\" onclick=\"" + JSHelper.AjaxRequest("this.href") + "/<call user</a>"; - - + Name is converted to lower case. + + name is null. + Cannot add stuff to . - + - Determins if a list of strings contains a specific value + Get a form item. - options to check in - value to find - true if value was found - case insensitive + + Returns if item was not found. - + - Ajax requests that updates an element with - the fetched content + Returns true if the class contains a with the corresponding name. - URL to fetch. URL is NOT enclosed in quotes by the implementation. You need to do that yourself. - element to update - options in format "key, value, key, value". All keys should end with colon. - A link tag. - - - JSHelper.AjaxUpdater("'/user/show/1'", "user", "onsuccess:", "alert('hello');", "asynchronous:", "true"); - - + The field/query string name + True if the value exists - + - A link that pop ups a Dialog (overlay div) + Parses an item and returns it. + This function is primarily used to parse array items as in user[name]. - URL to contents of dialog - link title - name, value, name, value - - A "a"-tag that popups a dialog when clicked - - Requires Control.Modal found here: http://livepipe.net/projects/control_modal/ - And the following JavaScript (load it in application.js): - - Event.observe(window, 'load', - function() { - document.getElementsByClassName('modal').each(function(link){ new Control.Modal(link); }); - } - ); - - - - WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); - + + + - + + Outputs the instance representing all its values joined together + + + + Returns all items as an unescaped query string. + + + - create a modal dialog (usually using DIVs) + Extracts one parameter from an array - url to fetch - dialog title - javascript/html attributes. javascript options ends with colon ':'. - + Containing the string array + All but the first value + + string test1 = ExtractOne("system[user][extension][id]"); + string test2 = ExtractOne(test1); + string test3 = ExtractOne(test2); + // test1 = user[extension][id] + // test2 = extension[id] + // test3 = id + - + + Resets all data contained by class + + - Close a javascript dialog window/div. + Returns an enumerator that iterates through the collection. - javascript for closing a dialog. - + + + A that can be used to iterate through the collection. + + 1 - + - javascript action that should be added to the "onsubmit" event in the form tag. + Returns an enumerator that iterates through a collection. - remember to encapsulate strings in '' - - All javascript option names should end with colon. - - - JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); - - + + + An object that can be used to iterate through the collection. + + 2 - + - Helpers making it easier to work with forms. + Base class for request data containers - - + - Used to let the website use different JavaScript libraries. - Default is + Adds a parameter mapped to the presented name + The name to map the parameter to + The parameter value - + - Create a <form> tag. + Returns a request parameter - name of form - action to invoke on submit - form should be posted as Ajax - HTML code - - - // without options - WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); - - // with options - WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax, "style", "display:inline", "class", "greenForm"); - - - HTML attributes or JavaScript options. - Method will ALWAYS be POST. - options must consist of name, value, name, value + The name associated with the parameter + - + - Creates a select list with the values in a collection. + Returns true if the container contains the requested parameter - Name of the SELECT-tag - collection used to generate options. - delegate used to return id and title from objects. - value that should be marked as selected. - First row should contain an empty value. - string containing a SELECT-tag. - + Parameter id + True if parameter exists - + - Creates a select list with the values in a collection. + represents a HTTP input item. Each item can have multiple sub items, a sub item + is made in a HTML form by using square brackets - Name of the SELECT-tag - Id of the SELECT-tag - collection used to generate options. - delegate used to return id and title from objects. - value that should be marked as selected. - First row should contain an empty value. - string containing a SELECT-tag. - - - // Class that is going to be used in a SELECT-tag. - public class User - { - private readonly string _realName; - private readonly int _id; - public User(int id, string realName) - { - _id = id; - _realName = realName; - } - public string RealName - { - get { return _realName; } - } - - public int Id - { - get { return _id; } - } - } - - // Using an inline delegate to generate the select list - public void UserInlineDelegate() - { - List<User> items = new List<User>(); - items.Add(new User(1, "adam")); - items.Add(new User(2, "bertial")); - items.Add(new User(3, "david")); - string htmlSelect = Select("users", "users", items, delegate(object o, out object id, out object value) - { - User user = (User)o; - id = user.Id; - value = user.RealName; - }, 2, true); - } - - // Using an method as delegate to generate the select list. - public void UseExternalDelegate() - { - List<User> items = new List<User>(); - items.Add(new User(1, "adam")); - items.Add(new User(2, "bertial")); - items.Add(new User(3, "david")); - string htmlSelect = Select("users", "users", items, UserOptions, 1, true); - } - - // delegate returning id and title - public static void UserOptions(object o, out object id, out object title) - { - User user = (User)o; - id = user.Id; - value = user.RealName; - } - + // becomes: + Console.WriteLine("Value: {0}", form["user"]["FirstName"].Value); - name, id, collection or getIdTitle is null. + + All names in a form SHOULD be in lowercase. + - - - Creates a select list with the values in a collection. - - Name of the SELECT-tag - Id of the SELECT-tag - collection used to generate options. - delegate used to return id and title from objects. - value that should be marked as selected. - First row should contain an empty value. - name, value collection of extra HTML attributes. - string containing a SELECT-tag. - - name, id, collection or getIdTitle is null. - Invalid HTML attribute list. + + Representation of a non-initialized . - + - Generate a list of HTML options + Initializes an input item setting its name/identifier and value - collection used to generate options. - delegate used to return id and title from objects. - value that should be marked as selected. - First row should contain an empty value. - - collection or getIdTitle is null. + Parameter name/id + Parameter value - - sb is null. + + Creates a deep copy of the item specified + The item to copy + The function makes a deep copy of quite a lot which can be slow - + - Creates a check box. + Number of values - element name - element value - determines if the check box is selected or not. This is done differently depending on the - type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if - the box is checked or not. - a list with additional attributes (name, value, name, value). - a generated radio button - + - Creates a check box. + Get a sub item - element name - element id - element value - determines if the check box is selected or not. This is done differently depending on the - type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if - the box is checked or not. - a list with additional attributes (name, value, name, value). - a generated radio button - - value in your business object. (check box will be selected if it matches the element value) - + name in lower case. + if no item was found. - + - Creates a check box. + Name of item (in lower case). - element name - element id - determines if the check box is selected or not. This is done differently depending on the - type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if - the box is checked or not. - a list with additional attributes (name, value, name, value). - a generated radio button - will set value to "1". - + - Creates a RadioButton. + Returns the first value, or null if no value exist. - element name - element value - determines if the radio button is selected or not. This is done differently depending on the - type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if - the box is checked or not. - a list with additional attributes (name, value, name, value). - a generated radio button - + - Creates a RadioButton. + Returns the last value, or null if no value exist. + + + + + Returns the list with values. - element name - element id - element value - determines if the radio button is selected or not. This is done differently depending on the - type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if - the box is checked or not. - a list with additional attributes (name, value, name, value). - a generated radio button - + - form close tag + Add another value to this item - + Value to add. + Cannot add stuff to . - + - We dont want to let the server to die due to exceptions thrown in worker threads. - therefore we use this delegate to give you a change to handle uncaught exceptions. + checks if a sub-item exists (and has a value). - Class that the exception was thrown in. - Exception - - Server will throw a InternalServerException in release version if you dont - handle this delegate. - + name in lower case + true if the sub-item exists and has a value; otherwise false. - + + Returns a formatted representation of the instance with the values of all contained parameters + + - Implements HTTP Digest authentication. It's more secure than Basic auth since password is - encrypted with a "key" from the server. + Outputs the string in a formatted manner - - Keep in mind that the password is encrypted with MD5. Use a combination of SSL and digest auth to be secure. - + A prefix to append, used internally + produce a query string - + - Authentication modules are used to implement different - kind of HTTP authentication. + + name in lower case + - + - Tag used for authentication. + Add a sub item. + Can contain array formatting, the item is then parsed and added in multiple levels + Value to add. + Argument is null. + Cannot add stuff to . - + - Initializes a new instance of the class. + Returns an enumerator that iterates through the collection. - Delegate used to provide information used during authentication. - Delegate used to determine if authentication is required (may be null). + + + A that can be used to iterate through the collection. + + 1 - + - Initializes a new instance of the class. + Returns an enumerator that iterates through a collection. - Delegate used to provide information used during authentication. + + + An object that can be used to iterate through the collection. + + 2 - + - Create a response that can be sent in the WWW-Authenticate header. + Outputs the string in a formatted manner - Realm that the user should authenticate in - Array with optional options. - A correct authentication request. - If realm is empty or null. + A prefix to append, used internally + - + - An authentication response have been received from the web browser. - Check if it's correct + New implementation of the HTTP listener. - Contents from the Authorization header - Realm that should be authenticated - GET/POST/PUT/DELETE etc. - options to specific implementations - Authentication object that is stored for the request. A user class or something like that. - if is invalid - If any of the parameters is empty or null. + + Use the Create methods to create a default listener. + - + - Used to invoke the authentication delegate that is used to lookup the user name/realm. + A client have been accepted, but not handled, by the listener. - Realm (domain) that user want to authenticate in - User name - Password used for validation. Some implementations got password in clear text, they are then sent to client. - object that will be stored in the request to help you identify the user if authentication was successful. - true if authentication was successful - + - Determines if authentication is required. + Initializes a new instance of the class. - HTTP request from browser - true if user should be authenticated. - throw from your delegate if no more attempts are allowed. - If no more attempts are allowed + IP Address to accept connections on + TCP Port to listen on, default HTTP port is 80. + Factory used to create es. + address is null. + Port must be a positive number. - + - name used in HTTP request. + Initializes a new instance of the class. + The address. + The port. + The factory. + The certificate. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - Delegate used to provide information used during authentication. - Delegate used to determine if authentication is required (may be null). + The address. + The port. + The factory. + The certificate. + The protocol. - + - Initializes a new instance of the class. + Creates a new instance with default factories. - Delegate used to provide information used during authentication. + Address that the listener should accept connections on. + Port that listener should accept connections on. + Created HTTP listener. - + - Used by test classes to be able to use hardcoded values + Creates a new instance with default factories. + Address that the listener should accept connections on. + Port that listener should accept connections on. + Certificate to use + Created HTTP listener. - + - An authentication response have been received from the web browser. - Check if it's correct + Creates a new instance with default factories. - Contents from the Authorization header - Realm that should be authenticated - GET/POST/PUT/DELETE etc. - First option: true if username/password is correct but not cnonce - - Authentication object that is stored for the request. A user class or something like that. - - if authenticationHeader is invalid - If any of the paramters is empty or null. + Address that the listener should accept connections on. + Port that listener should accept connections on. + Certificate to use + which HTTPS protocol to use, default is TLS. + Created HTTP listener. - + - Encrypts parameters into a Digest string + Can be used to create filtering of new connections. - Realm that the user want to log into. - User logging in - Users password. - HTTP method. - Uri/domain that generated the login prompt. - Quality of Protection. - "Number used ONCE" - Hexadecimal request counter. - "Client Number used ONCE" - Digest encrypted string + Accepted socket + + true if connection can be accepted; otherwise false. + - + - + Contains a listener that doesn't do anything with the connections. - Md5 hex encoded "userName:realm:password", without the quotes. - Md5 hex encoded "method:uri", without the quotes - Quality of Protection - "Number used ONCE" - Hexadecimal request counter. - Client number used once - - + - Create a response that can be sent in the WWW-Authenticate header. + Listen for regular HTTP connections - Realm that the user should authenticate in - First options specifies if true if username/password is correct but not cnonce. - A correct auth request. - If realm is empty or null. + IP Address to accept connections on + TCP Port to listen on, default HTTP port is 80. + Factory used to create es. + address is null. + Port must be a positive number. - + - Decodes authorization header value + Initializes a new instance of the class. - header value - Encoding that the buffer is in - All headers and their values if successful; otherwise null - - NameValueCollection header = DigestAuthentication.Decode("response=\"6629fae49393a05397450978507c4ef1\",\r\nc=00001", Encoding.ASCII); - - Can handle lots of whitespaces and new lines without failing. + IP Address to accept connections on + TCP Port to listen on, default HTTPS port is 443 + Factory used to create es. + Certificate to use - + - Gets the current nonce. + Initializes a new instance of the class. - + IP Address to accept connections on + TCP Port to listen on, default HTTPS port is 443 + Factory used to create es. + Certificate to use + which HTTPS protocol to use, default is TLS. - + - Gets the Md5 hash bin hex2. + Gives you a change to receive log entries for all internals of the HTTP library. - To be hashed. - + + You may not switch log writer after starting the listener. + - + - determines if the nonce is valid or has expired. + True if we should turn on trace logs. - nonce value (check wikipedia for info) - true if the nonce has not expired. - + + Exception. + + - name used in http request. + Will try to accept connections one more time. + If any exceptions is thrown. - + - Gets or sets whether the token supplied in is a - HA1 generated string. + Can be used to create filtering of new connections. + Accepted socket + true if connection can be accepted; otherwise false. - + - Generic helper functions for HTTP + Start listen for new connections + Number of connections that can stand in a queue to be accepted. + Listener have already been started. - + - Version string for HTTP v1.0 + Stop the listener + - + - Version string for HTTP v1.1 + Catch exceptions not handled by the listener. + + Exceptions will be thrown during debug mode if this event is not used, + exceptions will be printed to console and suppressed during release mode. + - + - An empty URI + A request have been received from a . - + - Parses a query string. + The purpose of this module is to serve files. - Query string (URI encoded) - A object if successful; otherwise - queryString is null. - If string cannot be parsed. - + - Delegate used to let authentication modules authenticate the user name and password. + Initializes a new instance of the class. - Realm that the user want to authenticate in - User name specified by client - Can either be user password or implementation specific token. - object that will be stored in a session variable called if authentication was successful. - throw forbidden exception if too many attempts have been made. - - - Use to specify that the token is a HA1 token. (MD5 generated - string from realm, user name and password); Md5String(userName + ":" + realm + ":" + password); - - + Uri to serve, for instance "/files/" + Path on hard drive where we should start looking for files + If true a Last-Modifed header will be sent upon requests urging web browser to cache files - + - Let's you decide on a system level if authentication is required. + Initializes a new instance of the class. - HTTP request from client - true if user should be authenticated. - throw if no more attempts are allowed. - If no more attempts are allowed + Uri to serve, for instance "/files/" + Path on hard drive where we should start looking for files - + - Arguments used when more body bytes have come. + List with all mime-type that are allowed. + All other mime types will result in a Forbidden http status code. - + - Initializes a new instance of the class. + characters that may not exist in a path. - buffer that contains the received bytes. - offset in buffer where to start processing. - number of bytes from that should be parsed. + + fileMod.ForbiddenChars = new string[]{ "\\", "..", ":" }; + - + - Initializes a new instance of the class. + Mimtypes that this class can handle per default - + - Gets or sets buffer that contains the received bytes. + Determines if the request should be handled by this module. + Invoked by the + + true if this module should handle it. - + + Illegal path + + - Gets or sets number of bytes from that should be parsed. + check if source contains any of the chars. + + + - + - Gets or sets offset in buffer where to start processing. + Method that process the Uri. + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to + Failed to find file extension + File type is forbidden. - + - Contains all HTTP Methods (according to the HTTP 1.1 specification) - - See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html - + return a file extension from an absolute Uri path (or plain filename) + + - + - The DELETE method requests that the origin server delete the resource identified by the Request-URI. + A HttpModule can be used to serve Uri's. The module itself + decides if it should serve a Uri or not. In this way, you can + get a very flexible http application since you can let multiple modules + serve almost similar urls. - - This method MAY be overridden by human intervention (or other means) on the origin server. - The client cannot be guaranteed that the operation has been carried out, even if the status code - returned from the origin server indicates that the action has been completed successfully. - - - However, the server SHOULD NOT indicate success unless, at the time the response is given, - it intends to delete the resource or move it to an inaccessible location. - - - A successful response SHOULD be 200 (OK) if the response includes an entity describing the status, - 202 (Accepted) if the action has not yet been enacted, - or 204 (No Content) if the action has been enacted but the response does not include an entity. - - - If the request passes through a cache and the Request-URI identifies one or more currently cached entities, - those entries SHOULD be treated as stale. Responses to this method are not cacheable. - + Throw if you are using a and want to prompt for user name/password. - + - The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. + Method that process the url - - - If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the - entity in the response and not the source text of the process, unless that text happens to be the output of the process. - - - The semantics of the GET method change to a "conditional GET" if the request message includes an - If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. - A conditional GET method requests that the entity be transferred only under the circumstances described - by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network - usage by allowing cached entities to be refreshed without requiring multiple requests or transferring - data already held by the client. - - + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to + true if this module handled the request. - + - The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. + Set the log writer to use. - - The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the - information sent in response to a GET request. This method can be used for obtaining meta information about - the entity implied by the request without transferring the entity-body itself. - - This method is often used for testing hypertext links for validity, accessibility, and recent modification. - + logwriter to use. - + - The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. + Log something. - - This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval. - + importance of log message + message - + - The POST method is used to request that the origin server accept the entity enclosed - in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. + If true specifies that the module doesn't consume the processing of a request so that subsequent modules + can continue processing afterwards. Default is false. - - POST is designed to allow a uniform method to cover the following functions: - - - Annotation of existing resources; - - Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles; - - Providing a block of data, such as the result of submitting a form, to a data-handling process; - - Extending a database through an append operation. - - - - If a resource has been created on the origin server, the response SHOULD be 201 (Created) and - contain an entity which describes the status of the request and refers to the new resource, and a - Location header (see section 14.30). - - - The action performed by the POST method might not result in a resource that can be identified by a URI. - In this case, either 200 (OK) or 204 (No Content) is the appropriate response status, depending on - whether or not the response includes an entity that describes the result. - - Responses to this method are not cacheable, unless the response includes appropriate Cache-Control - or Expires header fields. However, the 303 (See Other) response can be used to direct the user agent - to retrieve a cacheable resource. - - - + - The PUT method requests that the enclosed entity be stored under the supplied Request-URI. + Used to inform http server that - - - - If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a - modified version of the one residing on the origin server. - - If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new - resource by the requesting user agent, the origin server can create the resource with that URI. - - If a new resource is created, the origin server MUST inform the user agent via the 201 (Created) response. - - If an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to - indicate successful completion of the request. - - If the resource could not be created or modified with the Request-URI, an appropriate error response SHOULD be - given that reflects the nature of the problem. - - - - The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not - understand or implement and MUST return a 501 (Not Implemented) response in such cases. - - - + - The TRACE method is used to invoke a remote, application-layer loop- back of the request message. + Eventarguments used when an exception is thrown by a module + the exception - + - Contains all HTTP Methods (according to the HTTP 1.1 specification) - - See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html - + Exception thrown in a module - + - The DELETE method requests that the origin server delete the resource identified by the Request-URI. + Serves files that are stored in embedded resources. - - - This method MAY be overridden by human intervention (or other means) on the origin server. - The client cannot be guaranteed that the operation has been carried out, even if the status code - returned from the origin server indicates that the action has been completed successfully. - - - However, the server SHOULD NOT indicate success unless, at the time the response is given, - it intends to delete the resource or move it to an inaccessible location. - - - A successful response SHOULD be 200 (OK) if the response includes an entity describing the status, - 202 (Accepted) if the action has not yet been enacted, - or 204 (No Content) if the action has been enacted but the response does not include an entity. - - - If the request passes through a cache and the Request-URI identifies one or more currently cached entities, - those entries SHOULD be treated as stale. Responses to this method are not cacheable. - - - + - The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. + Initializes a new instance of the class. + Runs to make sure the basic mime types are available, they can be cleared later + through the use of if desired. - - - If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the - entity in the response and not the source text of the process, unless that text happens to be the output of the process. - - - The semantics of the GET method change to a "conditional GET" if the request message includes an - If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. - A conditional GET method requests that the entity be transferred only under the circumstances described - by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network - usage by allowing cached entities to be refreshed without requiring multiple requests or transferring - data already held by the client. - - - + - The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. + Initializes a new instance of the class. + Runs to make sure the basic mime types are available, they can be cleared later + through the use of if desired. - - The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the - information sent in response to a GET request. This method can be used for obtaining meta information about - the entity implied by the request without transferring the entity-body itself. + The log writer to use when logging events + + + + List with all mime-type that are allowed. + + All other mime types will result in a Forbidden http status code. + + + + Mimtypes that this class can handle per default + + + + + Loads resources from a namespace in the given assembly to an uri + + The uri to map the resources to + The assembly in which the resources reside + The namespace from which to load the resources + + resourceLoader.LoadResources("/user/", typeof(User).Assembly, "MyLib.Models.User.Views"); - This method is often used for testing hypertext links for validity, accessibility, and recent modification. - + will make ie the resource MyLib.Models.User.Views.stylesheet.css accessible via /user/stylesheet.css + + The amount of loaded files, giving you the possibility of making sure the resources needed gets loaded - + - The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. + Returns true if the module can handle the request - - This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval. - - + - The POST method is used to request that the origin server accept the entity enclosed - in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. + Method that process the url - - POST is designed to allow a uniform method to cover the following functions: - - - Annotation of existing resources; - - Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles; - - Providing a block of data, such as the result of submitting a form, to a data-handling process; - - Extending a database through an append operation. - - - - If a resource has been created on the origin server, the response SHOULD be 201 (Created) and - contain an entity which describes the status of the request and refers to the new resource, and a - Location header (see section 14.30). - - - The action performed by the POST method might not result in a resource that can be identified by a URI. - In this case, either 200 (OK) or 204 (No Content) is the appropriate response status, depending on - whether or not the response includes an entity that describes the result. - - Responses to this method are not cacheable, unless the response includes appropriate Cache-Control - or Expires header fields. However, the 303 (See Other) response can be used to direct the user agent - to retrieve a cacheable resource. - - + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to + true if this module handled the request. - + - The PUT method requests that the enclosed entity be stored under the supplied Request-URI. + A reverse proxy are used to act as a bridge between local (protected/hidden) websites + and public clients. + + A typical usage is to allow web servers on non standard ports to still be available + to the public clients, or allow web servers on private ips to be available. - - - - If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a - modified version of the one residing on the origin server. - - If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new - resource by the requesting user agent, the origin server can create the resource with that URI. - - If a new resource is created, the origin server MUST inform the user agent via the 201 (Created) response. - - If an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to - indicate successful completion of the request. - - If the resource could not be created or modified with the Request-URI, an appropriate error response SHOULD be - given that reflects the nature of the problem. - - - - The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not - understand or implement and MUST return a 501 (Not Implemented) response in such cases. - - - + - The TRACE method is used to invoke a remote, application-layer loop- back of the request message. + + Base url requested from browser + Base url on private web server + + // this will return contents from http://192.168.1.128/view/jonas when client requests http://www.gauffin.com/user/view/jonas + _server.Add(new ReverseProxyModule("http://www.gauffin.com/user/", "http://192.168.1.128/"); + - + - Used to create and reuse contexts. + Method that determines if an url should be handled or not by the module + Url requested by the client. + true if module should handle the url. - + - Used to create es. + Method that process the url + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to - + - Creates a that handles a connected client. + The website module let's you handle multiple websites in the same server. + It uses the "Host" header to check which site you want. - Client socket (accepted by the ). - A creates . + It's recommended that you do not + add any other modules to HttpServer if you are using the website module. Instead, + add all wanted modules to each website. - + - Create a secure . + - Client socket (accepted by the ). - HTTPS certificate to use. - Kind of HTTPS protocol. Usually TLS or SSL. - A created . + domain name that should be handled. + - + - Server is shutting down so shut down the factory + Name of site. - + - A request have been received from one of the contexts. + Method that process the url + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to - + - Initializes a new instance of the class. + Returns item either from a form or a query string (checks them in that order) - The writer. - Amount of bytes to read from the incoming socket stream. - Used to create a request parser. - + + Representation of a non-initialized HttpParam + + + Initialises the class to hold a value either from a post request or a querystring request + + - Create a new context. + The add method is not availible for HttpParam + since HttpParam checks both Request.Form and Request.QueryString - true if socket is running HTTPS. - Client that connected - Network/SSL stream. - A context. + name identifying the value + value to add + - + - Create a new context. + Checks whether the form or querystring has the specified value - true if HTTPS is used. - Remote client - Network stream, uses . - A new context (always). + Name, case sensitive + true if found; otherwise false. - + - Create a secure . + Fetch an item from the form or querystring (in that order). - Client socket (accepted by the ). - HTTPS certificate to use. - Kind of HTTPS protocol. Usually TLS or SSL. - - A created . - + + Item if found; otherwise HttpInputItem.EmptyLanguageNode - + - Creates a that handles a connected client. + Returns an enumerator that iterates through the collection. - Client socket (accepted by the ). + - A creates . + A that can be used to iterate through the collection. + 1 - + - Server is shutting down so shut down the factory + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + 2 - + - True if detailed trace logs should be written. + Contains server side HTTP request information. - + - A request have been received from one of the contexts. + Chars used to split an URL path into multiple parts. - + - Custom network stream to mark sockets as reusable when disposing the stream. + Gets or sets a value indicating whether this is secure. - + - Creates a new instance of the class for the specified . + Path and query (will be merged with the host header) and put in Uri - - The that the will use to send and receive data. - - - The parameter is null. - - - The parameter is not connected. - -or- - The property of the parameter is not . - -or- - The parameter is in a nonblocking state. - + - + - Initializes a new instance of the class for the specified with the specified ownership. + Assign a form. - - The that the will use to send and receive data. - - - Set to true to indicate that the will take ownership of the ; otherwise, false. - - - The parameter is null. - - - The parameter is not connected. - -or- - the value of the property of the parameter is not . - -or- - the parameter is in a nonblocking state. - + - + - Creates a new instance of the class for the specified with the specified access rights. + Gets whether the body is complete. - - The that the will use to send and receive data. - - - A bitwise combination of the values that specify the type of access given to the over the provided . - - - The parameter is null. - - - The parameter is not connected. - -or- - the property of the parameter is not . - -or- - the parameter is in a nonblocking state. - - + - Creates a new instance of the class for the specified with the specified access rights and the specified ownership. + Gets kind of types accepted by the client. - - The that the will use to send and receive data. - - - A bitwise combination of the values that specifies the type of access given to the over the provided . - - - Set to true to indicate that the will take ownership of the ; otherwise, false. - - - The parameter is null. - - - The parameter is not connected. - -or- - The property of the parameter is not . - -or- - The parameter is in a nonblocking state. - - + - Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. + Gets or sets body stream. - + - Releases the unmanaged resources used by the and optionally releases the managed resources. + Gets or sets kind of connection used for the session. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - + - Invoked when a client have been accepted by the + Gets or sets number of bytes in the body. - - Can be used to revoke incoming connections - - + - Initializes a new instance of the class. + Gets headers sent by the client. - The socket. - + - Client may not be handled. + Gets or sets version of HTTP protocol that's used. + + Probably or . + + - + - Accepted socket. + Gets or sets requested method. + + + Will always be in upper case. + + - + - Client should be revoked. + Gets variables sent in the query string - + - A session stored in memory. + Gets or sets requested URI. - + - Interface for sessions + Uri absolute path splitted into parts. + + // uri is: http://gauffin.com/code/tiny/ + Console.WriteLine(request.UriParts[0]); // result: code + Console.WriteLine(request.UriParts[1]); // result: tiny + + + If you're using controllers than the first part is controller name, + the second part is method name and the third part is Id property. + + - + - Remove everything from the session + Gets parameter from or . - + - Remove everything from the session + Gets form parameters. - True if the session is cleared due to expiration - + - Session id + Gets whether the request was made by Ajax (Asynchronous JavaScript) - + - Should + Gets cookies that was sent with the request. - Name of the session variable - null if it's not set - If the object cant be serialized. - + - When the session was last accessed. - This property is touched by the http server each time the - session is requested. + Creates a new object that is a copy of the current instance. + + + A new object that is a copy of this instance. + + 2 - + - Number of session variables. + Decode body into a form. + A list with form decoders. + If body contents is not valid for the chosen decoder. + If body is still being transferred. - + - Event triggered upon clearing the session + Cookies + the cookies - + - + Create a response object. - A unique id used by the sessions store to identify the session + A new . - + - Id + Called during parsing of a . - + Name of the header, should not be URL encoded + Value of the header, should not be URL encoded + If a header is incorrect. - + - Remove everything from the session + Add bytes to the body + buffer to read bytes from + where to start read + number of bytes to read + Number of bytes actually read (same as length unless we got all body bytes). + If body is not writable + bytes is null. + offset is out of range. - + - Clears the specified expire. + Clear everything in the request - True if the session is cleared due to expiration - + - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + Response that is sent back to the web browser / client. - 2 + + + A response can be sent if different ways. The easiest one is + to just fill the Body stream with content, everything else + will then be taken care of by the framework. The default content-type + is text/html, you should change it if you send anything else. + + The second and slightly more complex way is to send the response + as parts. Start with sending the header using the SendHeaders method and + then you can send the body using SendBody method, but do not forget + to set and before doing so. + + + + + // Example using response body. + class MyModule : HttpModule + { + public override bool Process(IHttpRequest request, IHttpResponse response, IHttpSession session) + { + StreamWriter writer = new StreamWriter(response.Body); + writer.WriteLine("Hello dear World!"); + writer.Flush(); + + // return true to tell webserver that we've handled the url + return true; + } + } + + + todo: add two examples, using SendHeaders/SendBody and just the Body stream. - + - Session id + Initializes a new instance of the class. + Client that send the . + Contains information of what the client want to receive. + cannot be empty. - + - Should + Initializes a new instance of the class. - Name of the session variable - null if it's not set + Client that send the . + Version of HTTP protocol that the client uses. + Type of HTTP connection used. - + - when the session was last accessed. + The body stream is used to cache the body contents + before sending everything to the client. It's the simplest + way to serve documents. - - Used to determine when the session should be removed. - - + - Number of values in the session + The chunked encoding modifies the body of a message in order to + transfer it as a series of chunks, each with its own size indicator, + followed by an OPTIONAL trailer containing entity-header fields. This + allows dynamically produced content to be transferred along with the + information necessary for the recipient to verify that it has + received the full message. - + - Flag to indicate that the session have been changed - and should be saved into the session store. + Defines the version of the HTTP Response for applications where it's required + for this to be forced. - + - Event triggered upon clearing the session + Kind of connection - + - A reverse proxy are used to act as a bridge between local (protected/hidden) websites - and public clients. - - A typical usage is to allow web servers on non standard ports to still be available - to the public clients, or allow web servers on private ips to be available. + Encoding to use when sending stuff to the client. + Default is UTF8 - + - + Number of seconds to keep connection alive - Base url requested from browser - Base url on private web server - - // this will return contents from http://192.168.1.128/view/jonas when client requests http://www.gauffin.com/user/view/jonas - _server.Add(new ReverseProxyModule("http://www.gauffin.com/user/", "http://192.168.1.128/"); - + Only used if Connection property is set to . - + - Method that determines if an url should be handled or not by the module + Status code that is sent to the client. - Url requested by the client. - true if module should handle the url. + Default is - + - Method that process the url + Information about why a specific status code was used. - Information sent by the browser about the request - Information that is being sent back to the client. - Session used to - + - Can handle application/x-www-form-urlencoded + Size of the body. MUST be specified before sending the header, + unless property Chunked is set to true. - + + Kind of content in the body - Stream containing the content - Content type (with any additional info like boundry). Content type is always supplied in lower case - Stream encoding - - A HTTP form, or null if content could not be parsed. - - If contents in the stream is not valid input data. + Default type is "text/html" - + - Checks if the decoder can handle the mime type + Headers have been sent to the client- - Content type (with any additional info like boundry). Content type is always supplied in lower case. - True if the decoder can parse the specified content type + You can not send any additional headers if they have already been sent. - + - This provider is used to let us implement any type of form decoding we want without - having to rewrite anything else in the server. + The whole response have been sent. - + - + Cookies that should be created/changed. - Should contain boundary and type, as in: multipart/form-data; boundary=---------------------------230051238959 - Stream containing form data. - Encoding used when decoding the stream - if no parser was found. - If stream is null or not readable. - If stream contents cannot be decoded properly. - + - Add a decoder. + Add another header to the document. - - + Name of the header, case sensitive, use lower cases. + Header values can span over multiple lines as long as each line starts with a white space. New line chars should be \r\n + If headers already been sent. + If value conditions have not been met. + Adding any header will override the default ones and those specified by properties. - + - Number of added decoders. + Send headers and body to the browser. + If content have already been sent. - + - Use with care. + Make sure that you have specified and sent the headers first. + + If headers have not been sent. + + offset of first byte to send + number of bytes to send. + + + This method can be used if you want to send body contents without caching them first. This + is recommended for larger files to keep the memory usage low. - + - Decoder used for unknown content types. + Make sure that you have specified and sent the headers first. + + If headers have not been sent. + + + + This method can be used if you want to send body contents without caching them first. This + is recommended for larger files to keep the memory usage low. - + - The server encountered an unexpected condition which prevented it from fulfilling the request. + Send headers to the client. + If headers already been sent. + + + - + - Initializes a new instance of the class. + Redirect client to somewhere else using the 302 status code. + Destination of the redirect + If headers already been sent. + You can not do anything more with the request when a redirect have been done. This should be your last + action. - + - Initializes a new instance of the class. + redirect to somewhere - error message. + where the redirect should go + + No body are allowed when doing redirects. + - + - Initializes a new instance of the class. + Delegate used to find a realm/domain. - error message. - inner exception. + + + + Realms are used during HTTP Authentication + + + - + - Response that is sent back to the web browser / client. - - A response can be sent if different ways. The easiest one is - to just fill the Body stream with content, everything else - will then be taken care of by the framework. The default content-type - is text/html, you should change it if you send anything else. - - The second and slighty more complex way is to send the response - as parts. Start with sending the header using the SendHeaders method and - then you can send the body using SendBody method, but do not forget - to set ContentType and ContentLength before doing so. + A complete HTTP server, you need to add a module to it to be able to handle incoming requests. - public void MyHandler(IHttpRequest request, IHttpResponse response) - { - - } + + // this small example will add two web site modules, thus handling + // two different sites. In reality you should add Controller modules or something + // two the website modules to be able to handle different requests. + HttpServer server = new HttpServer(); + server.Add(new WebSiteModule("www.gauffin.com", "Gauffin Telecom AB")); + server.Add(new WebSiteModule("www.vapadi.se", "Remote PBX")); + + // start regular http + server.Start(IPAddress.Any, 80); + + // start https + server.Start(IPAddress.Any, 443, myCertificate); + + + + - - - Add another header to the document. - - Name of the header, case sensitive, use lower cases. - Header values can span over multiple lines as long as each line starts with a white space. New line chars should be \r\n - If headers already been sent. - If value conditions have not been met. - Adding any header will override the default ones and those specified by properties. - - + - Send headers and body to the browser. + Server that is handling the current request. - If content have already been sent. + + Will be set as soon as a request arrives to the object. + - + - Make sure that you have specified ContentLength and sent the headers first. + Initializes a new instance of the class. - - If headers have not been sent. - - offest of first byte to send - number of bytes to send. - - - This method can be used if you want to send body contents without caching them first. This - is recommended for larger files to keep the memory usage low. + Used to get all components used in the server.. - + - Make sure that you have specified ContentLength and sent the headers first. + Initializes a new instance of the class. - - If headers have not been sent. - - - - This method can be used if you want to send body contents without caching them first. This - is recommended for larger files to keep the memory usage low. - + - Send headers to the client. + Initializes a new instance of the class. - If headers already been sent. - - - + Form decoders are used to convert different types of posted data to the object types. + + - + - Redirect client to somewhere else using the 302 status code. + Initializes a new instance of the class. - Destination of the redirect - If headers already been sent. - You can not do anything more with the request when a redirect have been done. This should be your last - action. + A session store is used to save and retrieve sessions + - + - redirect to somewhere + Initializes a new instance of the class. - where the redirect should go - - No body are allowed when doing redirects. - + The log writer. + - + - The body stream is used to cache the body contents - before sending everything to the client. It's the simplest - way to serve documents. + Initializes a new instance of the class. + Form decoders are used to convert different types of posted data to the object types. + The log writer. + + + - + - Defines the version of the HTTP Response for applications where it's required - for this to be forced. + Initializes a new instance of the class. + Form decoders are used to convert different types of posted data to the object types. + A session store is used to save and retrieve sessions + The log writer. + + + + - + - The chunked encoding modifies the body of a message in order to - transfer it as a series of chunks, each with its own size indicator, - followed by an OPTIONAL trailer containing entity-header fields. This - allows dynamically produced content to be transferred along with the - information necessary for the recipient to verify that it has - received the full message. + Modules used for authentication. The module that is is added first is used as + the default authentication module. + Use the corresponding property + in the if you are using multiple websites. - + - Kind of connection + Form decoder providers are used to decode request body (which normally contains form data). - + - Encoding to use when sending stuff to the client. + Server name sent in HTTP responses. - Default is UTF8 + + Do NOT include version in name, since it makes it + easier for hackers. + - + - Number of seconds to keep connection alive + Name of cookie where session id is stored. - Only used if Connection property is set to ConnectionType.KeepAlive - + - Status code that is sent to the client. + Specified where logging should go. - Default is HttpStatusCode.Ok + + + - + - Information about why a specific status code was used. + Number of connections that can wait to be accepted by the server. + Default is 10. - + - Size of the body. MUST be specified before sending the header, - unless property Chunked is set to true. + Gets or sets maximum number of allowed simultaneous requests. + + + This property is useful in busy systems. The HTTP server + will start queuing new requests if this limit is hit, instead + of trying to process all incoming requests directly. + + + The default number if allowed simultaneous requests are 10. + + - + - Kind of content in the body + Gets or sets maximum number of requests queuing to be handled. - Default is text/html + + + The WebServer will start turning requests away if response code + to indicate that the server + is too busy to be able to handle the request. + + - + - Headers have been sent to the client- + Adds the specified rule. - You can not send any additional headers if they have already been sent. + The rule. - + - The whole response have been sent. + Add a to the server. + mode to add - + - Cookies that should be created/changed. + Decodes the request body. + The request. + Failed to decode form data. - + - Type of HTTP connection + Generate a HTTP error page (that will be added to the response body). + response status code is also set. + Response that the page will be generated in. + . + response body contents. - + - Connection is closed after each request-response + Generate a HTTP error page (that will be added to the response body). + response status code is also set. + Response that the page will be generated in. + exception. - + - Connection is kept alive for X seconds (unless another request have been made) + Realms are used by the s. + HTTP request + domain/realm. - + - The website module let's you handle multiple websites in the same server. - It uses the "Host" header to check which site you want. + Process an incoming request. - It's recommended that you do not - add any other modules to HttpServer if you are using the website module. Instead, - add all wanted modules to each website. + connection to client + request information + response that should be filled + session information - + - + Can be overloaded to implement stuff when a client have been connected. - domain name that should be handled. - + + Default implementation does nothing. + + client that disconnected + disconnect reason - + - Method that process the url + Handle authentication - Information sent by the browser about the request - Information that is being sent back to the client. - Session used to + + + + true if request can be handled; false if not. + Invalid authorization header - + - Name of site. + Will request authentication. + + Sends respond to client, nothing else can be done with the response after this. + + + + - + - Used to inform http server that + Received from a when a request have been parsed successfully. + that received the request. + The request. - + - Eventarguments used when an exception is thrown by a module + To be able to track request count. - the exception + + - + - Exception thrown in a module + Start the web server using regular HTTP. + IP Address to listen on, use IpAddress.Any to accept connections on all IP addresses/network cards. + Port to listen on. 80 can be a good idea =) + address is null. + Port must be a positive number. - + - represents a HTTP input item. Each item can have multiple sub items, a sub item - is made in a HTML form by using square brackets + Accept secure connections. - - // becomes: - Console.WriteLine("Value: {0}", form["user"]["FirstName"].Value); - - - All names in a form SHOULD be in lowercase. - - - - Representation of a non-initialized . + IP Address to listen on, use to accept connections on all IP Addresses / network cards. + Port to listen on. 80 can be a good idea =) + Certificate to use + address is null. + Port must be a positive number. - + - Initializes an input item setting its name/identifier and value + shut down the server and listeners - Parameter name/id - Parameter value - - - Creates a deep copy of the item specified - The item to copy - The function makes a deep copy of quite a lot which can be slow - + - Add another value to this item + write an entry to the log file - Value to add. - Cannot add stuff to . + importance of the message + log message - + - checks if a sub-item exists (and has a value). + write an entry to the log file - name in lower case - true if the sub-item exists and has a value; otherwise false. - - - Returns a formatted representation of the instance with the values of all contained parameters + object that wrote the message + importance of the message + log message - + - Outputs the string in a formatted manner + Realms are used during HTTP authentication. + Default realm is same as server name. - A prefix to append, used internally - produce a query string - + - Add a sub item. + Let's to receive unhandled exceptions from the threads. - Can contain array formatting, the item is then parsed and added in multiple levels - Value to add. - Argument is null. - Cannot add stuff to . + + Exceptions will be thrown during debug mode if this event is not used, + exceptions will be printed to console and suppressed during release mode. + - + - Returns an enumerator that iterates through the collection. + Inversion of control interface. - - - A that can be used to iterate through the collection. - - 1 - + - Returns an enumerator that iterates through a collection. + Add a component instance - - - An object that can be used to iterate through the collection. - - 2 + Interface type + Instance to add - + - Outputs the string in a formatted manner + Get a component. - A prefix to append, used internally - + Interface type + Component if registered, otherwise null. + + Component will get created if needed. + - + - Number of values + Checks if the specified component interface have been added. + + true if found; otherwise false. - + - Get a sub item + Add a component. - name in lower case. - if no item was found. + Type being requested. + Type being created. - + - Name of item (in lower case). + Contains a connection to a browser/client. - + - Returns the first value, or null if no value exist. + Using SSL or other encryption method. - + - Returns the last value, or null if no value exist. + Using SSL or other encryption method. - + - Returns the list with values. + Disconnect from client + error to report in the event. - + - + Send a response. - name in lower case - - - - Class to handle loading of resource files + Either or + HTTP status code + reason for the status code. + HTML body contents, can be null or empty. + A content type to return the body as, i.e. 'text/html' or 'text/plain', defaults to 'text/html' if null or empty + If is invalid. - + - Initializes a new instance of the class. + Send a response. + Either or + HTTP status code + reason for the status code. - + - Initializes a new instance of the class. + Send a response. - logger. + - + - Loads resources from a namespace in the given assembly to an URI + send a whole buffer - The URI to map the resources to - The assembly in which the resources reside - The namespace from which to load the resources - - - resourceLoader.LoadResources("/user/", typeof(User).Assembly, "MyLib.Models.User.Views"); - - Will make the resource MyLib.Models.User.Views.list.Haml accessible via /user/list.haml or /user/list/ - - The amount of loaded files, giving you the possibility of making sure the resources needed gets loaded - If a resource has already been mapped to an uri + buffer to send + - + - Retrieves a stream for the specified resource path if loaded otherwise null + Send data using the stream - Path to the resource to retrieve a stream for - A stream or null if the resource couldn't be found + Contains data to send + Start position in buffer + number of bytes to send + + - + - Fetch all files from the resource that matches the specified arguments. + Closes the streams and disposes of the unmanaged resources - The path to the resource to extract - - a list of files if found; or an empty array if no files are found. - - Search path must end with an asterisk for finding arbitrary files - + - Fetch all files from the resource that matches the specified arguments. + The context have been disconnected. - Where the file should reside. - Files to check - - a list of files if found; or an empty array if no files are found. - + + Event can be used to clean up a context, or to reuse it. + - + - Returns whether or not the loader has an instance of the file requested + A request have been received in the context. - The name of the template/file - True if the loader can provide the file - + - Used when the request line have been successfully parsed. + A have been disconnected. - + - Initializes a new instance of the class. + Gets reason to why client disconnected. - The HTTP method. - The URI path. - The HTTP version. - + - Initializes a new instance of the class. + Initializes a new instance of the class. + Reason to disconnection. - + - Gets or sets http method. + - - Should be one of the methods declared in . - - + - Gets or sets the version of the HTTP protocol that the client want to use. + Gets received request. - + - Gets or sets requested URI path. + Initializes a new instance of the class. + The request. @@ -3797,428 +3851,351 @@ Request that was received. - - Container for posted form data - - - Instance to help mark a non-initialized form - - - Initializes a form container with the specified name - - - - Makes a deep copy of the input - - The input to copy - - + - Adds a file to the collection of posted files + Contains server side HTTP request information. - The file to add - If the file is already added - If file is null - If the instance is HttpForm.EmptyForm which cannot be modified - + - Checks if the form contains a specified file + Gets kind of types accepted by the client. - Field name of the file parameter - True if the file exists - If the instance is HttpForm.EmptyForm which cannot be modified - + - Retrieves a file held by by the form + Gets or sets body stream. - The identifier of the file - The requested file or null if the file was not found - If name is null or empty - If the instance is HttpForm.EmptyForm which cannot be modified - - - Disposes all held HttpFile's and resets values - + - Retrieves the number of files added to the + Gets whether the body is complete. - 0 if no files are added - + - Contains a connection to a browser/client. + Gets or sets kind of connection used for the session. - - Remember to after you have hooked the event. - - TODO: Maybe this class should be broken up into HttpClientChannel and HttpClientContext? - + - Initializes a new instance of the class. + Gets or sets number of bytes in the body. - true if the connection is secured (SSL/TLS) - client that connected. - Stream used for communication - Used to create a . - Size of buffer to use when reading data. Must be at least 4096 bytes. - If fails - Stream must be writable and readable. - + - Process incoming body bytes. + Gets cookies that was sent with the request. - - Bytes - + - + Gets form parameters. - - - + - Start reading content. + Gets headers sent by the client. - - Make sure to call base.Start() if you override this method. - - + - Clean up context. + Gets or sets version of HTTP protocol that's used. - Make sure to call base.Cleanup() if you override the method. + Probably or . + - - - Disconnect from client - - error to report in the event. - - - - Send a response. - - Either or - HTTP status code - reason for the status code. - HTML body contents, can be null or empty. - A content type to return the body as, i.e. 'text/html' or 'text/plain', defaults to 'text/html' if null or empty - If is invalid. - - + - Send a response. + Gets whether the request was made by Ajax (Asynchronous JavaScript) - Either or - HTTP status code - reason for the status code. - + - Send a response. + Gets or sets requested method. - + + Will always be in upper case. + + - + - send a whole buffer + Gets parameter from or . - buffer to send - - + - Send data using the stream + Gets variables sent in the query string - Contains data to send - Start position in buffer - number of bytes to send - - - + - This context have been cleaned, which means that it can be reused. + Gets or sets requested URI. - + - Context have been started (a new client have connected) + Gets URI absolute path divided into parts. + + // URI is: http://gauffin.com/code/tiny/ + Console.WriteLine(request.UriParts[0]); // result: code + Console.WriteLine(request.UriParts[1]); // result: tiny + + + If you're using controllers than the first part is controller name, + the second part is method name and the third part is Id property. + + - + - Overload to specify own type. + Gets or sets path and query. + - Must be specified before the context is being used. + Are only used during request parsing. Cannot be set after "Host" header have been + added. - + - Using SSL or other encryption method. + Called during parsing of a . + Name of the header, should not be URL encoded + Value of the header, should not be URL encoded + If a header is incorrect. - + - Using SSL or other encryption method. + Add bytes to the body + buffer to read bytes from + where to start read + number of bytes to read + Number of bytes actually read (same as length unless we got all body bytes). + If body is not writable + bytes is null. + offset is out of range. - + - Specify which logger to use. + Clear everything in the request - + - Gets or sets the network stream. + Decode body into a form. + A list with form decoders. + If body contents is not valid for the chosen decoder. + If body is still being transferred. - + - Gets or sets IP address that the client connected from. + Sets the cookies. + The cookies. - + - Gets or sets port that the client connected from. + Create a response object. + Context for the connected client. + A new . - + - The context have been disconnected. + Event driven parser used to parse incoming HTTP requests. - Event can be used to clean up a context, or to reuse it. + The parser supports partial messages and keeps the states between + each parsed buffer. It's therefore important that the parser gets + ed if a client disconnects. - + - A request have been received in the context. + Current state in parser. - + - Helpers to make XML handling easier + Parse partial or complete message. + buffer containing incoming bytes + where in buffer that parsing should start + number of bytes to parse + Unparsed bytes left in buffer. + BadRequestException. - + - Serializes object to XML. + A request have been successfully parsed. - object to serialize. - XML - - Removes name spaces and adds indentation - - + - Create an object from a XML string + More body bytes have been received. - Type of object - XML string - object - + - + Request line have been received. - - - - - Represents a field in a multipart form + + + A header have been received. + - + - Small design by contract implementation. + Clear parser state. - + - Check whether a parameter is empty. + Gets or sets the log writer. - Parameter value - Parameter name, or error description. - value is empty. - + - Checks whether a parameter is null. + Current state in the parsing. - Parameter value - Parameter name, or error description. - value is null. - + - Checks whether a parameter is null. + Should parse the request line - - Parameter value - Parameter name, or error description. - value is null. - + - Priority for log entries + Searching for a complete header name - - + - Very detailed logs to be able to follow the flow of the program. + Searching for colon after header name (ignoring white spaces) - + - Logs to help debug errors in the application + Searching for start of header value (ignoring white spaces) - + - Information to be able to keep track of state changes etc. + Searching for a complete header value (can span over multiple lines, as long as they are prefixed with one/more whitespaces) - + - Something did not go as we expected, but it's no problem. + Adding bytes to body - + - Something that should not fail failed, but we can still keep - on going. + Response that is sent back to the web browser / client. + + A response can be sent if different ways. The easiest one is + to just fill the Body stream with content, everything else + will then be taken care of by the framework. The default content-type + is text/html, you should change it if you send anything else. + + The second and slighty more complex way is to send the response + as parts. Start with sending the header using the SendHeaders method and + then you can send the body using SendBody method, but do not forget + to set ContentType and ContentLength before doing so. + + public void MyHandler(IHttpRequest request, IHttpResponse response) + { + + } + - + - Something failed, and we cannot handle it properly. + The body stream is used to cache the body contents + before sending everything to the client. It's the simplest + way to serve documents. - + - Interface used to write to log files. + Defines the version of the HTTP Response for applications where it's required + for this to be forced. - + - Write an entry to the log file. + The chunked encoding modifies the body of a message in order to + transfer it as a series of chunks, each with its own size indicator, + followed by an OPTIONAL trailer containing entity-header fields. This + allows dynamically produced content to be transferred along with the + information necessary for the recipient to verify that it has + received the full message. - object that is writing to the log - importance of the log message - the message - + - This class writes to the console. It colors the output depending on the logprio and includes a 3-level stacktrace (in debug mode) + Kind of connection - - + - The actual instance of this class. + Encoding to use when sending stuff to the client. + Default is UTF8 - + - Logwriters the specified source. + Number of seconds to keep connection alive - object that wrote the logentry. - Importance of the log message - The message. + Only used if Connection property is set to ConnectionType.KeepAlive - + - Get color for the specified logprio + Status code that is sent to the client. - prio for the log entry - A for the prio + Default is HttpStatusCode.Ok - + - Default log writer, writes everything to null (nowhere). + Information about why a specific status code was used. - - + - The logging instance. + Size of the body. MUST be specified before sending the header, + unless property Chunked is set to true. - + - Writes everything to null + Kind of content in the body - object that wrote the log entry. - Importance of the log message - The message. + Default is text/html - + - Response that is sent back to the web browser / client. + Headers have been sent to the client- - - - A response can be sent if different ways. The easiest one is - to just fill the Body stream with content, everything else - will then be taken care of by the framework. The default content-type - is text/html, you should change it if you send anything else. - - The second and slightly more complex way is to send the response - as parts. Start with sending the header using the SendHeaders method and - then you can send the body using SendBody method, but do not forget - to set and before doing so. - - - - - // Example using response body. - class MyModule : HttpModule - { - public override bool Process(IHttpRequest request, IHttpResponse response, IHttpSession session) - { - StreamWriter writer = new StreamWriter(response.Body); - writer.WriteLine("Hello dear World!"); - writer.Flush(); - - // return true to tell webserver that we've handled the url - return true; - } - } - - - todo: add two examples, using SendHeaders/SendBody and just the Body stream. + You can not send any additional headers if they have already been sent. - + - Initializes a new instance of the class. + The whole response have been sent. - Client that send the . - Contains information of what the client want to receive. - cannot be empty. - + - Initializes a new instance of the class. + Cookies that should be created/changed. - Client that send the . - Version of HTTP protocol that the client uses. - Type of HTTP connection used. - + Add another header to the document. @@ -4228,48 +4205,48 @@ If value conditions have not been met. Adding any header will override the default ones and those specified by properties. - + Send headers and body to the browser. If content have already been sent. - + - Make sure that you have specified and sent the headers first. + Make sure that you have specified ContentLength and sent the headers first. If headers have not been sent. - - offset of first byte to send + + offest of first byte to send number of bytes to send. - - + + This method can be used if you want to send body contents without caching them first. This is recommended for larger files to keep the memory usage low. - + - Make sure that you have specified and sent the headers first. + Make sure that you have specified ContentLength and sent the headers first. If headers have not been sent. - - - + + + This method can be used if you want to send body contents without caching them first. This is recommended for larger files to keep the memory usage low. - + Send headers to the client. If headers already been sent. - - - + + + - + Redirect client to somewhere else using the 302 status code. @@ -4278,7 +4255,7 @@ You can not do anything more with the request when a redirect have been done. This should be your last action. - + redirect to somewhere @@ -4287,1288 +4264,1311 @@ No body are allowed when doing redirects. - + - The body stream is used to cache the body contents - before sending everything to the client. It's the simplest - way to serve documents. + Type of HTTP connection - + + + Connection is closed after each request-response + + + + + Connection is kept alive for X seconds (unless another request have been made) + + + - The chunked encoding modifies the body of a message in order to - transfer it as a series of chunks, each with its own size indicator, - followed by an OPTIONAL trailer containing entity-header fields. This - allows dynamically produced content to be transferred along with the - information necessary for the recipient to verify that it has - received the full message. + Priority for log entries + - + - Defines the version of the HTTP Response for applications where it's required - for this to be forced. + Very detailed logs to be able to follow the flow of the program. - + - Kind of connection + Logs to help debug errors in the application - + - Encoding to use when sending stuff to the client. + Information to be able to keep track of state changes etc. - Default is UTF8 - + - Number of seconds to keep connection alive + Something did not go as we expected, but it's no problem. - Only used if Connection property is set to . - + - Status code that is sent to the client. + Something that should not fail failed, but we can still keep + on going. - Default is - + - Information about why a specific status code was used. + Something failed, and we cannot handle it properly. - + - Size of the body. MUST be specified before sending the header, - unless property Chunked is set to true. + Interface used to write to log files. - + - Kind of content in the body + Write an entry to the log file. - Default type is "text/html" + object that is writing to the log + importance of the log message + the message - + - Headers have been sent to the client- + This class writes to the console. It colors the output depending on the logprio and includes a 3-level stacktrace (in debug mode) - You can not send any additional headers if they have already been sent. + - + - The whole response have been sent. + The actual instance of this class. - + - Cookies that should be created/changed. + Logwriters the specified source. + object that wrote the logentry. + Importance of the log message + The message. - + - The requested resource was not found in the web server. + Get color for the specified logprio + prio for the log entry + A for the prio - + - Create a new exception + Default log writer, writes everything to null (nowhere). - message describing the error - inner exception + - + - Create a new exception + The logging instance. - message describing the error - + - Timeout Manager. Checks for dead clients. Clients with open connections that are not doing anything. Closes sessions opened with keepalive. + Writes everything to null + object that wrote the log entry. + Importance of the log message + The message. - + - Causes the watcher to immediately check the connections. + A thread-safe lockless queue that supports multiple readers and + multiple writers - + - Environment.TickCount is an int but it counts all 32 bits so it goes positive - and negative every 24.9 days. This trims down TickCount so it doesn't wrap - for the callers. - This trims it to a 12 day interval so don't let your frame time get too long. + Provides a node container for data in a singly linked list - - + + Pointer to the next node in list + + + The data contained by the node + + - Environment.TickCount is an int but it counts all 32 bits so it goes positive - and negative every 24.9 days. Subtracts the passed value (previously fetched by - 'EnvironmentTickCount()') and accounts for any wrapping. + Constructor - - - subtraction of passed prevValue from current Environment.TickCount - + - Environment.TickCount is an int but it counts all 32 bits so it goes positive - and negative every 24.9 days. Subtracts the passed value (previously fetched by - 'EnvironmentTickCount()') and accounts for any wrapping. + Constructor - - - subtraction of passed prevValue from current Environment.TickCount - + + Queue head + + + Queue tail + + + Queue item count + + + Gets the current number of items in the queue. Since this + is a lockless collection this value should be treated as a close + estimate + + - Environment.TickCount is an int but it counts all 32 bits so it goes positive - and negative every 24.9 days. Subtracts the passed value (previously fetched by - 'EnvironmentTickCount()') and accounts for any wrapping. + Constructor - subtraction of passed prevValue from current Environment.TickCount - + - Use a Thread or a Timer to monitor the ugly + Enqueue an item + Item to enqeue - + - Session store using memory for each session. + Try to dequeue an item + Dequeued item if the dequeue was successful + True if an item was successfully deqeued, otherwise false - + - A session store is used to store and load sessions on a media. - The default implementation () saves/retrieves sessions from memory. + Contains all HTTP Methods (according to the HTTP 1.1 specification) + + See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html + - + - Creates a new http session with a generated id. + The DELETE method requests that the origin server delete the resource identified by the Request-URI. - A object + + + This method MAY be overridden by human intervention (or other means) on the origin server. + The client cannot be guaranteed that the operation has been carried out, even if the status code + returned from the origin server indicates that the action has been completed successfully. + + + However, the server SHOULD NOT indicate success unless, at the time the response is given, + it intends to delete the resource or move it to an inaccessible location. + + + A successful response SHOULD be 200 (OK) if the response includes an entity describing the status, + 202 (Accepted) if the action has not yet been enacted, + or 204 (No Content) if the action has been enacted but the response does not include an entity. + + + If the request passes through a cache and the Request-URI identifies one or more currently cached entities, + those entries SHOULD be treated as stale. Responses to this method are not cacheable. + + - + - Creates a new http session with a specific id + The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. - Id used to identify the new cookie.. - A object. - Id should be generated by the store implementation if it's null or . + + If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the + entity in the response and not the source text of the process, unless that text happens to be the output of the process. + + + The semantics of the GET method change to a "conditional GET" if the request message includes an + If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. + A conditional GET method requests that the entity be transferred only under the circumstances described + by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network + usage by allowing cached entities to be refreshed without requiring multiple requests or transferring + data already held by the client. + - + - Load an existing session. + The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. - Session id (usually retrieved from a client side cookie). - A session if found; otherwise null. + + The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the + information sent in response to a GET request. This method can be used for obtaining meta information about + the entity implied by the request without transferring the entity-body itself. + + This method is often used for testing hypertext links for validity, accessibility, and recent modification. + - + - Save an updated session to the store. + The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. - Session id (usually retrieved from a client side cookie). - If Id property have not been specified. + + This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval. + - + - We use the flyweight pattern which reuses small objects - instead of creating new each time. + The POST method is used to request that the origin server accept the entity enclosed + in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. - Unused session that should be reused next time Create is called. + + POST is designed to allow a uniform method to cover the following functions: + + + Annotation of existing resources; + + Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles; + + Providing a block of data, such as the result of submitting a form, to a data-handling process; + + Extending a database through an append operation. + + + + If a resource has been created on the origin server, the response SHOULD be 201 (Created) and + contain an entity which describes the status of the request and refers to the new resource, and a + Location header (see section 14.30). + + + The action performed by the POST method might not result in a resource that can be identified by a URI. + In this case, either 200 (OK) or 204 (No Content) is the appropriate response status, depending on + whether or not the response includes an entity that describes the result. + + Responses to this method are not cacheable, unless the response includes appropriate Cache-Control + or Expires header fields. However, the 303 (See Other) response can be used to direct the user agent + to retrieve a cacheable resource. + + - + - Remove expired sessions + The PUT method requests that the enclosed entity be stored under the supplied Request-URI. + + + + If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a + modified version of the one residing on the origin server. + + If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new + resource by the requesting user agent, the origin server can create the resource with that URI. + + If a new resource is created, the origin server MUST inform the user agent via the 201 (Created) response. + + If an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to + indicate successful completion of the request. + + If the resource could not be created or modified with the Request-URI, an appropriate error response SHOULD be + given that reflects the nature of the problem. + + + + The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not + understand or implement and MUST return a 501 (Not Implemented) response in such cases. + + - + - Remove a session + The TRACE method is used to invoke a remote, application-layer loop- back of the request message. - id of the session. - + - Load a session from the store + Contains all HTTP Methods (according to the HTTP 1.1 specification) + + See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html + - - null if session is not found. - + - Number of minutes before a session expires. + The DELETE method requests that the origin server delete the resource identified by the Request-URI. - Default time is 20 minutes. + + + This method MAY be overridden by human intervention (or other means) on the origin server. + The client cannot be guaranteed that the operation has been carried out, even if the status code + returned from the origin server indicates that the action has been completed successfully. + + + However, the server SHOULD NOT indicate success unless, at the time the response is given, + it intends to delete the resource or move it to an inaccessible location. + + + A successful response SHOULD be 200 (OK) if the response includes an entity describing the status, + 202 (Accepted) if the action has not yet been enacted, + or 204 (No Content) if the action has been enacted but the response does not include an entity. + + + If the request passes through a cache and the Request-URI identifies one or more currently cached entities, + those entries SHOULD be treated as stale. Responses to this method are not cacheable. + + - + - Initializes the class setting the expirationtimer to clean the session every minute + The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. + + + If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the + entity in the response and not the source text of the process, unless that text happens to be the output of the process. + + + The semantics of the GET method change to a "conditional GET" if the request message includes an + If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. + A conditional GET method requests that the entity be transferred only under the circumstances described + by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network + usage by allowing cached entities to be refreshed without requiring multiple requests or transferring + data already held by the client. + + - + - Delegate for the cleanup timer + The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. + + The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the + information sent in response to a GET request. This method can be used for obtaining meta information about + the entity implied by the request without transferring the entity-body itself. + + This method is often used for testing hypertext links for validity, accessibility, and recent modification. + - + - Creates a new http session + The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. - + + This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval. + - + - Creates a new http session with a specific id + The POST method is used to request that the origin server accept the entity enclosed + in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. - Id used to identify the new cookie.. - A object. - Id should be generated by the store implementation if it's null or . + POST is designed to allow a uniform method to cover the following functions: + + + Annotation of existing resources; + + Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles; + + Providing a block of data, such as the result of submitting a form, to a data-handling process; + + Extending a database through an append operation. + + + + If a resource has been created on the origin server, the response SHOULD be 201 (Created) and + contain an entity which describes the status of the request and refers to the new resource, and a + Location header (see section 14.30). + + + The action performed by the POST method might not result in a resource that can be identified by a URI. + In this case, either 200 (OK) or 204 (No Content) is the appropriate response status, depending on + whether or not the response includes an entity that describes the result. + + Responses to this method are not cacheable, unless the response includes appropriate Cache-Control + or Expires header fields. However, the 303 (See Other) response can be used to direct the user agent + to retrieve a cacheable resource. + - + - Load an existing session. + The PUT method requests that the enclosed entity be stored under the supplied Request-URI. - - + + + + If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a + modified version of the one residing on the origin server. + + If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new + resource by the requesting user agent, the origin server can create the resource with that URI. + + If a new resource is created, the origin server MUST inform the user agent via the 201 (Created) response. + + If an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to + indicate successful completion of the request. + + If the resource could not be created or modified with the Request-URI, an appropriate error response SHOULD be + given that reflects the nature of the problem. + + + + The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not + understand or implement and MUST return a 501 (Not Implemented) response in such cases. + + - + - Save an updated session to the store. + The TRACE method is used to invoke a remote, application-layer loop- back of the request message. - - + - We use the flyweight pattern which reuses small objects - instead of creating new each time. + Arguments used when more body bytes have come. - EmptyLanguageNode (unused) session that should be reused next time Create is called. - + - Remove expired sessions + Initializes a new instance of the class. + buffer that contains the received bytes. + offset in buffer where to start processing. + number of bytes from that should be parsed. - + - Remove a session + Initializes a new instance of the class. - id of the session. - + - Load a session from the store + Gets or sets buffer that contains the received bytes. - - null if session is not found. - + - Number of minutes before a session expires. - Default is 20 minutes. + Gets or sets number of bytes from that should be parsed. - + - Arguments sent when a is cleared + Gets or sets offset in buffer where to start processing. - + - Instantiates the arguments for the event + Event arguments used when a new header have been parsed. - True if the session is cleared due to expiration - + - Returns true if the session is cleared due to expiration + Initializes a new instance of the class. + Name of header. + Header value. - + - Delegate for when a IHttpSession is cleared + Initializes a new instance of the class. - this is being cleared. - Arguments for the clearing - + - Used to queue incoming requests. + Gets or sets header name. - + - Initializes a new instance of the class. + Gets or sets header value. - Called when a request should be processed. - + - Used to process queued requests. + Parses a HTTP request directly from a stream - + - Gets or sets maximum number of allowed simultaneous requests. + Create a new request parser + delegate receiving log entries. - + - Gets or sets maximum number of requests queuing to be handled. + Add a number of bytes to the body + buffer containing more body bytes. + starting offset in buffer + number of bytes, from offset, to read. + offset to continue from. - + - Specifies how many requests the HTTP server is currently processing. + Remove all state information for the request. - + - Used two queue incoming requests to avoid - thread starvation. + Gets or sets the log writer. - + - Method used to process a queued request + Parse request line - Context that the request was received from. - Request to process. + + If line is incorrect + Expects the following format: "Method SP Request-URI SP HTTP-Version CRLF" - + - Event arguments used when a new header have been parsed. + We've parsed a new header. + Name in lower case + Value, unmodified. + If content length cannot be parsed. - + - Initializes a new instance of the class. + Current state in parser. - Name of header. - Header value. - + - Initializes a new instance of the class. + Parse a message + bytes to parse. + where in buffer that parsing should start + number of bytes to parse, starting on . + offset (where to start parsing next). + BadRequestException. - + - Gets or sets header name. + A request have been successfully parsed. - + - Gets or sets header value. + More body bytes have been received. - + - Contains server side HTTP request information. + Request line have been received. - + - Chars used to split an URL path into multiple parts. + A header have been received. - + - Assign a form. + Used when the request line have been successfully parsed. - - + - Creates a new object that is a copy of the current instance. + Initializes a new instance of the class. - - - A new object that is a copy of this instance. - - 2 + The HTTP method. + The URI path. + The HTTP version. - + - Decode body into a form. + Initializes a new instance of the class. - A list with form decoders. - If body contents is not valid for the chosen decoder. - If body is still being transferred. - + - Cookies + Gets or sets http method. - the cookies + + Should be one of the methods declared in . + - + - Create a response object. + Gets or sets the version of the HTTP protocol that the client want to use. - A new . - + - Called during parsing of a . + Gets or sets requested URI path. - Name of the header, should not be URL encoded - Value of the header, should not be URL encoded - If a header is incorrect. - + - Add bytes to the body + Creates request parsers when needed. - buffer to read bytes from - where to start read - number of bytes to read - Number of bytes actually read (same as length unless we got all body bytes). - If body is not writable - bytes is null. - offset is out of range. - + - Clear everything in the request + Create a new request parser. + Used when logging should be enabled. + A new request parser. - + - Gets or sets a value indicating whether this is secure. + Creates request parsers when needed. - + - Path and query (will be merged with the host header) and put in Uri + Create a new request parser. - + Used when logging should be enabled. + A new request parser. - + - Gets whether the body is complete. + cookie sent by the client/browser + - + - Gets kind of types accepted by the client. + Constructor. + cookie identifier + cookie content + id or content is null + id is empty - + - Gets or sets body stream. + Gets the cookie HTML representation. + cookie string - + - Gets or sets kind of connection used for the session. + Gets the cookie identifier. - + - Gets or sets number of bytes in the body. + Cookie value. Set to null to remove cookie. - + - Gets headers sent by the client. + This class is created as a wrapper, since there are two different cookie types in .Net (Cookie and HttpCookie). + The framework might switch class in the future and we dont want to have to replace all instances - + - Gets or sets version of HTTP protocol that's used. + Let's copy all the cookies. - - Probably or . - - + value from cookie header. - + - Gets or sets requested method. + Adds a cookie in the collection. - - - Will always be in upper case. - - + cookie to add + cookie is null - + - Gets variables sent in the query string + Gets the count of cookies in the collection. - + - Gets or sets requested URI. + Gets the cookie of a given identifier (null if not existing). - + - Uri absolute path splitted into parts. + Gets a collection enumerator on the cookie list. - - // uri is: http://gauffin.com/code/tiny/ - Console.WriteLine(request.UriParts[0]); // result: code - Console.WriteLine(request.UriParts[1]); // result: tiny - - - If you're using controllers than the first part is controller name, - the second part is method name and the third part is Id property. - - + collection enumerator - + - Gets parameter from or . + Remove all cookies. - + - Gets form parameters. + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + 1 - + - Gets whether the request was made by Ajax (Asynchronous JavaScript) + Remove a cookie from the collection. + Name of cookie. - + - Gets cookies that was sent with the request. + Used to queue incoming requests. - + - Add a component instance + Initializes a new instance of the class. - Interface type - Instance to add + Called when a request should be processed. - + - Get a component. + Used two queue incoming requests to avoid + thread starvation. - Interface type - Component if registered, otherwise null. - - Component will get created if needed. - - - - If instance cannot be created. - + - Checks if the specified component interface have been added. + Gets or sets maximum number of allowed simultaneous requests. - - true if found; otherwise false. - + - Add a component. + Gets or sets maximum number of requests queuing to be handled. - Type being requested. - Type being created. - Type have already been mapped. - + - Class to make dynamic binding of redirects. Instead of having to specify a number of similar redirect rules - a regular expression can be used to identify redirect URLs and their targets. + Specifies how many requests the HTTP server is currently processing. - - [a-z0-9]+)", "/users/${target}?find=true", RegexOptions.IgnoreCase) - ]]> - - + - Initializes a new instance of the class. + Used to process queued requests. - Expression to match URL - Expression to generate URL - - [a-zA-Z0-9]+)", "/user/${first}")); - Result of ie. /employee1 will then be /user/employee1 - ]]> - - + - Initializes a new instance of the class. + Method used to process a queued request - Expression to match URL - Expression to generate URL - Regular expression options to use, can be null - - [a-zA-Z0-9]+)", "/user/{first}", RegexOptions.IgnoreCase)); - Result of ie. /employee1 will then be /user/employee1 - ]]> - + Context that the request was received from. + Request to process. - + - Initializes a new instance of the class. + cookie being sent back to the browser. - Expression to match URL - Expression to generate URL - Regular expression options to apply - true if request should be redirected, false if the request URI should be replaced. - - [a-zA-Z0-9]+)", "/user/${first}", RegexOptions.None)); - Result of ie. /employee1 will then be /user/employee1 - ]]> - - Argument is null. - + - + - Process the incoming request. + Constructor. - incoming HTTP request - outgoing HTTP response - true if response should be sent to the browser directly (no other rules or modules will be processed). - - returning true means that no modules will get the request. Returning true is typically being done - for redirects. - - If request or response is null + cookie identifier + cookie content + cookie expiration date. Use DateTime.MinValue for session cookie. + id or content is null + id is empty - + - Container to bind resource names to assemblies + Create a new cookie + name identifying the cookie + cookie value + when the cookie expires. Setting DateTime.MinValue will delete the cookie when the session is closed. + Path to where the cookie is valid + Domain that the cookie is valid for. - + - Instantiates an instance of + Create a new cookie - The dot seperated uri the resource maps to - The full resource name - The assembly the resource exists in + Name and value will be used + when the cookie expires. - + - Retrieves a stream to the resource + Gets the cookie HTML representation. - Null if the resource couldn't be located somehow + cookie string - + - Retrieves the assembly the resource resides in + When the cookie expires. + DateTime.MinValue means that the cookie expires when the session do so. - + - Retrieves the full name/path of the assembly + Cookie is only valid under this path. - + - Retrieves the extension of the resource + Cookies that should be set. - - Returns the Uri without extension - - - Retrieves the full path name to the resource file + + + Adds a cookie in the collection. + + cookie to add + cookie is null - + - The "basic" authentication scheme is based on the model that the - client must authenticate itself with a user-ID and a password for - each realm. The realm value should be considered an opaque string - which can only be compared for equality with other realms on that - server. The server will service the request only if it can validate - the user-ID and password for the protection space of the Request-URI. - There are no optional authentication parameters. + Copy a request cookie + + When the cookie should expire - + - Initializes a new instance of the class. + Gets the count of cookies in the collection. - Delegate used to provide information used during authentication. - Delegate used to determine if authentication is required (may be null). - + - Initializes a new instance of the class. + Gets the cookie of a given identifier (null if not existing). - Delegate used to provide information used during authentication. - + - Create a response that can be sent in the WWW-Authenticate header. + Gets a collection enumerator on the cookie list. - Realm that the user should authenticate in - Not used in basic auth - A correct auth request. + collection enumerator - + - An authentication response have been received from the web browser. - Check if it's correct + Remove all cookies - Contents from the Authorization header - Realm that should be authenticated - GET/POST/PUT/DELETE etc. - Not used in basic auth - Authentication object that is stored for the request. A user class or something like that. - if authenticationHeader is invalid - If any of the paramters is empty or null. - + - name used in http request. + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + 1 - + - Current state in the parsing. + Rules are used to perform operations before a request is being handled. + Rules can be used to create routing etc. - + - Should parse the request line + Process the incoming request. + incoming HTTP request + outgoing HTTP response + true if response should be sent to the browser directly (no other rules or modules will be processed). + + returning true means that no modules will get the request. Returning true is typically being done + for redirects. + + If request or response is null. - + - Searching for a complete header name + redirects from one URL to another. - + - Searching for colon after header name (ignoring white spaces) + Initializes a new instance of the class. + Absolute path (no server name) + Absolute path (no server name) + + server.Add(new RedirectRule("/", "/user/index")); + - + - Searching for start of header value (ignoring white spaces) + Initializes a new instance of the class. + Absolute path (no server name) + Absolute path (no server name) + true if request should be redirected, false if the request URI should be replaced. + + server.Add(new RedirectRule("/", "/user/index")); + - + - Searching for a complete header value (can span over multiple lines, as long as they are prefixed with one/more whitespaces) + Gets string to match request URI with. + Is compared to request.Uri.AbsolutePath - + - Adding bytes to body + Gets where to redirect. - + - Will contain helper functions for javascript. + Gets whether server should redirect client. + + false means that the rule will replace + the current request URI with the new one from this class. + true means that a redirect response is sent to the client. + - + - Requests a url through ajax + Process the incoming request. - url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself. - optional options in format "key, value, key, value", used in JS request object. All keys should end with colon. - a link tag - onclick attribute is used by this method. - - - // plain text - JSHelper.AjaxRequest("'/user/show/1'"); - - // ajax request using this.href - string link = "<a href=\"/user/call/1\" onclick=\"" + JSHelper.AjaxRequest("this.href") + "/<call user</a>"; - - + incoming HTTP request + outgoing HTTP response + true if response should be sent to the browser directly (no other rules or modules will be processed). + + returning true means that no modules will get the request. Returning true is typically being done + for redirects. + - + - Ajax requests that updates an element with - the fetched content + Class to make dynamic binding of redirects. Instead of having to specify a number of similar redirect rules + a regular expression can be used to identify redirect URLs and their targets. - url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself. - element to update - options in format "key, value, key, value". All keys should end with colon. - A link tag. - - JSHelper.AjaxUpdater("'/user/show/1'", "user", "onsuccess:", "alert('hello');", "asynchronous:", "true"); - + [a-z0-9]+)", "/users/${target}?find=true", RegexOptions.IgnoreCase) + ]]> - + - Opens contents in a dialog window. + Initializes a new instance of the class. - url to contents of dialog - link title - name, value, name, value, all parameter names should end with colon. + Expression to match URL + Expression to generate URL + + [a-zA-Z0-9]+)", "/user/${first}")); + Result of ie. /employee1 will then be /user/employee1 + ]]> + - + - Close a javascript dialog window/div. + Initializes a new instance of the class. - javascript for closing a dialog. - + Expression to match URL + Expression to generate URL + Regular expression options to use, can be null + + [a-zA-Z0-9]+)", "/user/{first}", RegexOptions.IgnoreCase)); + Result of ie. /employee1 will then be /user/employee1 + ]]> + - + - Lists content type mime types. + Initializes a new instance of the class. + Expression to match URL + Expression to generate URL + Regular expression options to apply + true if request should be redirected, false if the request URI should be replaced. + + [a-zA-Z0-9]+)", "/user/${first}", RegexOptions.None)); + Result of ie. /employee1 will then be /user/employee1 + ]]> + + Argument is null. + - + - text/plain + Process the incoming request. + incoming HTTP request + outgoing HTTP response + true if response should be sent to the browser directly (no other rules or modules will be processed). + + returning true means that no modules will get the request. Returning true is typically being done + for redirects. + + If request or response is null - + - text/haml + Interface for sessions - + - content type for javascript documents = application/javascript + Session id - - - RFC 4329 states that text/javascript have been superseeded by - application/javascript. You might still want to check browser versions - since older ones do not support application/javascript. - - Browser support: http://krijnhoetmer.nl/stuff/javascript/mime-types/ - - + - text/xml + Should + Name of the session variable + null if it's not set + If the object cant be serialized. - + - A list of content types + When the session was last accessed. + This property is touched by the http server each time the + session is requested. - + - + Number of session variables. - Semicolon separated content types. - + - Returns an enumerator that iterates through a collection. + Remove everything from the session - - An object that can be used to iterate through the collection. - - + - Searches for the specified type + Remove everything from the session - Can also be a part of a type (searching for "xml" would return true for "application/xml"). - true if type was found. + True if the session is cleared due to expiration - + - Get this first content type. + Event triggered upon clearing the session - + - Fetch a content type + Arguments sent when a is cleared - Part of type ("xml" would return "application/xml") - - All content types are in lower case. - + - Creates request parsers when needed. + Instantiates the arguments for the event + True if the session is cleared due to expiration - + - Creates request parsers when needed. + Returns true if the session is cleared due to expiration - + - Create a new request parser. + Delegate for when a IHttpSession is cleared - Used when logging should be enabled. - A new request parser. + this is being cleared. + Arguments for the clearing - + - Create a new request parser. + A session store is used to store and load sessions on a media. + The default implementation () saves/retrieves sessions from memory. - Used when logging should be enabled. - A new request parser. - + - The request requires user authentication. The response MUST include a - WWW-Authenticate header field (section 14.47) containing a challenge - applicable to the requested resource. - - The client MAY repeat the request with a suitable Authorization header - field (section 14.8). If the request already included Authorization - credentials, then the 401 response indicates that authorization has been - refused for those credentials. If the 401 response contains the same challenge - as the prior response, and the user agent has already attempted authentication - at least once, then the user SHOULD be presented the entity that was given in the response, - since that entity might include relevant diagnostic information. - - HTTP access authentication is explained in rfc2617: - http://www.ietf.org/rfc/rfc2617.txt - - (description is taken from - http://www.submissionchamber.com/help-guides/error-codes.php#sec10.4.2) + Load a session from the store + + null if session is not found. - + - Create a new unauhtorized exception. + Number of minutes before a session expires. - + Default time is 20 minutes. - + - Create a new unauhtorized exception. + Creates a new http session with a generated id. - reason to why the request was unauthorized. - inner exception + A object - + - Create a new unauhtorized exception. + Creates a new http session with a specific id - reason to why the request was unauthorized. + Id used to identify the new cookie.. + A object. + + Id should be generated by the store implementation if it's null or . + - + - The purpose of this module is to serve files. + Load an existing session. + Session id (usually retrieved from a client side cookie). + A session if found; otherwise null. - + - Initializes a new instance of the class. + Save an updated session to the store. - Uri to serve, for instance "/files/" - Path on hard drive where we should start looking for files - If true a Last-Modifed header will be sent upon requests urging web browser to cache files + Session id (usually retrieved from a client side cookie). + If Id property have not been specified. - + - Initializes a new instance of the class. + We use the flyweight pattern which reuses small objects + instead of creating new each time. - Uri to serve, for instance "/files/" - Path on hard drive where we should start looking for files + Unused session that should be reused next time Create is called. - + - Mimtypes that this class can handle per default + Remove expired sessions - + - Determines if the request should be handled by this module. - Invoked by the + Remove a session - - true if this module should handle it. - - - Illegal path + id of the session. - + - check if source contains any of the chars. + A session stored in memory. - - - - + - Method that process the Uri. - - Information sent by the browser about the request - Information that is being sent back to the client. - Session used to - Failed to find file extension - File type is forbidden. + + + A unique id used by the sessions store to identify the session - + - return a file extension from an absolute Uri path (or plain filename) + Id - - + - + - List with all mime-type that are allowed. + Session id - All other mime types will result in a Forbidden http status code. - + - characters that may not exist in a path. + Should - - fileMod.ForbiddenChars = new string[]{ "\\", "..", ":" }; - + Name of the session variable + null if it's not set - + - Webhelper provides helpers for common tasks in HTML. + when the session was last accessed. + + Used to determine when the session should be removed. + - + - Used to let the website use different javascript libraries. - Default is + Number of values in the session - + - Creates a link that invokes through ajax. + Flag to indicate that the session have been changed + and should be saved into the session store. - url to fetch - link title - - optional options in format "key, value, key, value". - Javascript options starts with ':'. - - a link tag - - WebHelper.AjaxRequest("/users/add/", "Add user", "method:", "post", "onclick", "validate('this');"); - - + - Builds a link that updates an element with the fetched ajax content. + Remove everything from the session - Url to fetch content from - link title - html element to update with the results of the ajax request. - optional options in format "key, value, key, value" - A link tag. - + - A link that pop ups a Dialog (overlay div) + Clears the specified expire. - url to contents of dialog - link title - name/value of html attributes. - A "a"-tag that popups a dialog when clicked - - WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); - + True if the session is cleared due to expiration - + - Create/Open a dialog box using ajax + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - + 2 - + - Close a javascript dialog window/div. + Event triggered upon clearing the session - javascript for closing a dialog. - - + - Create a <form> tag. + Session store using memory for each session. - name of form - action to invoke on submit - form should be posted as ajax - html code - - WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); - - + - Create a link tag. + Initializes the class setting the expirationtimer to clean the session every minute - url to go to - link title (text that is displayed) - html attributes, name, value, name, value - html code - - WebHelper.Link("/user/show/1", "Show user", "id", "showUser", "onclick", "return confirm('Are you shure?');"); - - + - Build a link + Delegate for the cleanup timer - url to go to. - title of link (displayed text) - extra html attributes. - a complete link - + - Build a link + Load a session from the store - url to go to. - title of link (displayed text) - extra html attributes. - a complete link - more options + + null if session is not found. - + - Obsolete + Creates a new http session - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete + - + - Obsolete + Creates a new http session with a specific id - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete + Id used to identify the new cookie.. + A object. + + Id should be generated by the store implementation if it's null or . + - + - Render errors into a UL with class "errors" + Load an existing session. - class used by UL-tag. - items to list - an unordered html list. + + - + - Render errors into a UL with class "errors" + Save an updated session to the store. - class used by UL-tag. - items to list - an unordered html list. + - + - Render errors into a UL with class "errors" + We use the flyweight pattern which reuses small objects + instead of creating new each time. - - + EmptyLanguageNode (unused) session that should be reused next time Create is called. - + - Generates a list with html attributes. + Remove expired sessions - StringBuilder that the options should be added to. - attributes set by user. - attributes set by any of the helper classes. - + - Generates a list with html attributes. + Remove a session - StringBuilder that the options should be added to. - + id of the session. - + - Delegate used by to populate select options. + Number of minutes before a session expires. + Default is 20 minutes. - current object (for instance a User). - Text that should be displayed in the value part of a <optiongt;-tag. - Text shown in the select list. - - // Class that is going to be used in a SELECT-tag. - public class User - { - private readonly string _realName; - private readonly int _id; - public User(int id, string realName) - { - _id = id; - _realName = realName; - } - public string RealName - { - get { return _realName; } - } - - public int Id - { - get { return _id; } - } - } - - // Using an inline delegate to generate the select list - public void UserInlineDelegate() - { - List<User> items = new List<User>(); - items.Add(new User(1, "adam")); - items.Add(new User(2, "bertial")); - items.Add(new User(3, "david")); - string htmlSelect = Select("users", "users", items, delegate(object o, out object id, out object value) - { - User user = (User)o; - id = user.Id; - value = user.RealName; - }, 2, true); - } - - // Using an method as delegate to generate the select list. - public void UseExternalDelegate() - { - List<User> items = new List<User>(); - items.Add(new User(1, "adam")); - items.Add(new User(2, "bertial")); - items.Add(new User(3, "david")); - string htmlSelect = Select("users", "users", items, UserOptions, 1, true); - } - - // delegate returning id and title - public static void UserOptions(object o, out object id, out object title) - { - User user = (User)o; - id = user.Id; - value = user.RealName; - } /// -- cgit v1.1