From 9d9fcac0386ba6adc7a1f6c08f82bd5c0b6cd1d2 Mon Sep 17 00:00:00 2001 From: Jeff Ames Date: Fri, 14 Aug 2009 17:16:41 +0900 Subject: Misc cleanup. --- bin/OpenSim.ini.example | 118 ++++++++++++++++++++++++------------------------ 1 file changed, 58 insertions(+), 60 deletions(-) (limited to 'bin') diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example index ff8fa5f..db993b4 100644 --- a/bin/OpenSim.ini.example +++ b/bin/OpenSim.ini.example @@ -4,7 +4,7 @@ save_crashes = false ; Directory to save crashes to if above is enabled - ; (eg default is /opensimdir/crashes/*.txt or C:\opensim\crashes\*.txt) + ; (default is /opensimdir/crashes/*.txt or C:\opensim\crashes\*.txt) crash_dir = "crashes" ; Place to create a PID file @@ -14,16 +14,16 @@ ; Set HttpProxy to the URL for your proxy server if you would like ; to proxy llHTTPRequests through a firewall ; HttpProxy = "http://proxy.com" - ; Set HttpProxyExceptions to a list of regular expressions for + ; Set HttpProxyExceptions to a list of regular expressions for ; URLs that you don't want going through the proxy such as servers ; inside your firewall, separate patterns with a ';' ; HttpProxyExceptions = ".mydomain.com;localhost" - ; Set this to true if you are connecting your OpenSimulator regions to a grid - ; Set this to false if you are running OpenSimulator in standalone mode + ; Set this to true if you are connecting your regions to a grid + ; Set this to false if you are running in standalone mode gridmode = false - - ; Set this to true if you want this OpenSimulator to run the Hypergrid functionality + + ; Set this to true if you want Hypergrid functionality hypergrid = false startup_console_commands_file = "startup_commands.txt" @@ -39,7 +39,7 @@ ; Enables EventQueueGet Service. EventQueue = true - ; Set this to the DLL containig the client stack to use. + ; Set this to the DLL containing the client stack to use. clientstack_plugin="OpenSim.Region.ClientStack.LindenUDP.dll" ; ## @@ -60,7 +60,7 @@ ; except that everything is also enclosed in a tag. ; regionload_webserver_url = "http://example.com/regions.xml"; - ; Draw objects on maptile. This step might take a long time if you've got a huge amount of + ; Draw objects on maptile. This step might take a long time if you've got a large number of ; objects, so you can turn it off here if you'd like. DrawPrimOnMapTile = true ; Use terrain texture for maptiles if true, use shaded green if false @@ -109,11 +109,11 @@ ; If you're running a region server connecting to a grid, you probably want grid mode, since this will use the ; grid asset server. If you select local in grid mode, then you will use a database as specified in asset_plugin to store assets ; locally. This will mean you won't be able to take items using your assets to other people's regions. - + ; Persistence of changed objects happens during regular sweeps. The following control that behaviour to ; prevent frequently changing objects from heavily loading the region data store. ; If both of these values are set to zero then persistence of all changed objects will happen on every sweep. - ; + ; ; Objects will be considered for persistance in the next sweep when they have not changed for this number of seconds MinimumTimeBeforePersistenceConsidered = 60 ; Objects will always be considered for persistance in the next sweep if the first change occurred this number of seconds ago @@ -129,11 +129,11 @@ ; if you would like to allow prims to be physical and move by physics with the physical checkbox in the client set this to true. physical_prim = true - ; Select a mesher here. ZeroMesher is save and fast. + ; Select a mesher here. ZeroMesher is safe and fast. ; ZeroMesher also means that the physics engine models the physics of prims ; sticking to the basic shapes the engine does support. Usually this is only a box. ; Meshmerizer gives a better handling of complex prims by using triangle meshes. - ; Note, that only ODE physics currently deals with meshed prims in a satisfactoring way + ; Note that only ODE physics currently deals with meshed prims in a satisfactory way ; meshing = ZeroMesher ;meshing = Meshmerizer @@ -165,20 +165,20 @@ ; Control user types that are allowed to create new scripts ; Only enforced if serviceside_object_permissions is true - ; - ; Current possible values are + ; + ; Current possible values are ; all - anyone can create scripts (subject to normal permissions) ; gods - only administrators can create scripts (as long as allow_grid_gods is true) - ; Default value is all + ; Default value is all ; allowed_script_creators = all ; Control user types that are allowed to edit (save) scripts ; Only enforced if serviceside_object_permissions is true - ; - ; Current possible values are + ; + ; Current possible values are ; all - anyone can edit scripts (subject to normal permissions) ; gods - only administrators can edit scripts (as long as allow_grid_gods is true) - ; Default value is all + ; Default value is all ; allowed_script_editors = all ; ## @@ -220,9 +220,9 @@ ; FLYSLOW, and the "always run" state will be the regular fly. enableflyslow = false - + ; PreJump is an additional animation state, but it probably - ; won't look right until the physics engine supports it + ; won't look right until the physics engine supports it ; (i.e delays takeoff for a moment) ; This is commented so it will come on automatically once it's @@ -290,7 +290,7 @@ ; Specifies the location and filename of the default inventory library control file. The path can be relative or absolute ; Default is ./inventory/Libraries.xml LibrariesXMLFile="./inventory/Libraries.xml" - + [Network] http_listener_port = 9000 default_location_x = 1000 @@ -337,10 +337,10 @@ [ClientStack.LindenUDP] ; This is the multiplier applied to all client throttles for outgoing UDP network data - ; If it is set to 1, then we obey the throttle settings as given to us by the client. If it is set to 3, for example, then we + ; If it is set to 1, then we obey the throttle settings as given to us by the client. If it is set to 3, for example, then we ; multiply that setting by 3 (e.g. if the client gives us a setting of 250 kilobits per second then we ; will actually push down data at a maximum rate of 750 kilobits per second). - ; + ; ; In principle, setting a multiplier greater than 1 will allow data to be pushed down to a client much faster ; than its UI allows the setting to go. This may be okay in some situations, such as standalone OpenSim ; applications on a LAN. However, the greater the multipler, the higher the risk of packet drop, resulting @@ -350,11 +350,11 @@ ; Currently this setting is 2 by default because we currently send much more texture data than is strictly ; necessary. A setting of 1 could result in slow texture transfer. This will be fixed when the transfer ; of textures at different levels of quality is improved. - ; + ; ; Pre r7113, this setting was not exposed but was effectively 8. You may want to try this if you encounter ; unexpected difficulties client_throttle_multiplier = 2; - + ; the client socket receive buffer size determines how many ; incoming requests we can process; the default on .NET is 8192 ; which is about 2 4k-sized UDP datagrams. On mono this is @@ -429,9 +429,8 @@ ; surface layer around geometries other geometries can sink into before generating a contact world_contact_surface_layer = 0.001 - ; Filtering Collisions helps keep things stable physics wise, but sometimes - ; it can be over zealous. If you notice bouncing, chances are it's being just - ; that + ; Filtering collisions helps keep things stable physics wise, but sometimes + ; it can be overzealous. If you notice bouncing, chances are it's that. filter_collisions = false ; Non Moving Terrain Contact (avatar isn't moving) @@ -551,15 +550,15 @@ ; ## Joint support ; ## - ; if you would like physics joints to be enabled through a special naming convention in the client, set this to true. + ; if you would like physics joints to be enabled through a special naming convention in the client, set this to true. ; (see NINJA Physics documentation, http://opensimulator.org/wiki/NINJA_Physics) ; default is false ;use_NINJA_physics_joints = true - + ; ## ; ## additional meshing options ; ## - + ; physical collision mesh proxies are normally created for complex prim shapes, and collisions for simple boxes and ; spheres are computed algorithmically. If you would rather have mesh proxies for simple prims, you can set this to ; true. Note that this will increase memory usage and region startup time. Default is false. @@ -602,10 +601,10 @@ ;region_limit = 0 ; enable only those methods you deem to be appropriate using a | delimited whitelist - ; for example, enabled_methods = admin_broadcast|admin_region_query|admin_save_oar|admin_save_xml + ; for example, enabled_methods = admin_broadcast|admin_region_query|admin_save_oar|admin_save_xml ; if this parameter is not specified but enabled = true, all methods will be available enabled_methods = all - + [RestPlugins] ; Change this to true to enable REST Plugins. This must be true if you wish to use @@ -739,7 +738,7 @@ ; Density of cloud cover 0.0 to 1.0 Defult 0.5 density = 0.5 - ; update interval for the cloud cover data returned by llCloud(). + ; update interval for the cloud cover data returned by llCloud(). ; default is 1000 cloud_update_rate = 1000 @@ -914,7 +913,7 @@ ; This will be created in bin, if it doesn't exist already. It will hold the data snapshots. snapshot_cache_directory = "DataSnapshot" - ; This semicolon-separated string serves to notify specific data services about the existence + ; This semicolon-separated string serves to notify specific data services about the existence ; of this sim. Uncomment if you want to index your data with this and/or other search providers. ;data_services="http://metaverseink.com/cgi-bin/register.py" @@ -997,7 +996,7 @@ DefaultCompileLanguage = lsl ; List of allowed languages (lsl,vb,js,cs) - ; AllowedCompilers=lsl,cs,js,vb. + ; AllowedCompilers=lsl,cs,js,vb. ; *warning*, non lsl languages have access to static methods such as System.IO.File. Enable at your own risk. AllowedCompilers=lsl @@ -1050,13 +1049,13 @@ ; Comma separated list of UUIDS allows the function for that list of UUIDS ; Allow_osSetRegionWaterHeight = 888760cb-a3cf-43ac-8ea4-8732fd3ee2bb - ; Allow for llCreateLink and llBreakLink to work without asking for permission + ; Allow for llCreateLink and llBreakLink to work without asking for permission ; only enable this in a trusted environment otherwise you may be subject to hijacking ; AutomaticLinkPermission = false ; Disable underground movement of prims (default true); set to ; false to allow script controlled underground positioning of - ; prims + ; prims ; DisableUndergroundMovement = true @@ -1164,7 +1163,7 @@ [MRM] ; Enables the Mini Region Modules Script Engine. WARNING: SECURITY RISK. ; default is false - Enabled = false + Enabled = false [Hypergrid] @@ -1176,7 +1175,7 @@ ; The VivoxVoice module will allow you to provide voice on your ; region(s). It uses the same voice technology as the LL grid and ; works with recent LL clients (we have tested 1.22.9.110075, so - ; anything later ought to be fine as well). + ; anything later ought to be fine as well). ; ; For this to work you need to obtain an admin account from Vivox ; that allows you to create voice accounts and region channels. @@ -1234,14 +1233,14 @@ ; In order for this to work you need a functioning freeswitch pbx set ; up. Configuration for that will be posted in the wiki soon. enabled = false - ;FreeSwitch server is going to contact us and ask us all - ;sorts of things. - freeswitch_server_user = freeswitch - freeswitch_server_pass = password - freeswitch_api_prefix = /api - ; this is the IP of your sim + ;FreeSwitch server is going to contact us and ask us all + ;sorts of things. + freeswitch_server_user = freeswitch + freeswitch_server_pass = password + freeswitch_api_prefix = /api + ; this is the IP of your sim freeswitch_service_server = ip.address.of.your.sim - ;freeswitch_service_port = 80 + ;freeswitch_service_port = 80 ; this should be the same port the region listens on freeswitch_service_port = 9000 freeswitch_realm = ip.address.of.freeswitch.server @@ -1251,15 +1250,15 @@ freeswitch_echo_server = ip.address.of.freeswitch.server freeswitch_echo_port = 50505 freeswitch_well_known_ip = ip.address.of.freeswitch.server - + ;Type the address of your http server here, hostname is allowed. This is provided so you can specify a hostname ;This is used by client for account verification. By default, it's the same as the freeswitch service server. - + ;opensim_well_known_http_address = Address_Of_your_SIM_HTTP_Server_Hostname_Allowed freeswitch_default_timeout = 5000 freeswitch_subscribe_retry = 120 - ; freeswitch_password_reset_url = + ; freeswitch_password_reset_url = [Groups] @@ -1268,19 +1267,19 @@ ; This is the current groups stub in Region.CoreModules.Avatar.Groups Module = Default - ; The PHP code for the server is available from the Flotsam project for you to deploy + ; The PHP code for the server is available from the Flotsam project for you to deploy ; to your own server. The Flotsam project is located at http://code.google.com/p/flotsam/ ; ;Module = GroupsModule - + ; Enable Group Notices - ;NoticesEnabled = true + ;NoticesEnabled = true ; This makes the Groups modules very chatty on the console. ;DebugEnabled = true - ; Specify which messaging module to use for groups messaging and if it's enabled - ;MessagingModule = GroupsMessagingModule + ; Specify which messaging module to use for groups messaging and if it's enabled + ;MessagingModule = GroupsMessagingModule ;MessagingEnabled = true ; Service connector to Groups Service [Select One] @@ -1290,9 +1289,9 @@ ;XmlRpcServiceReadKey = 1234 ;XmlRpcServiceWriteKey = 1234 - ; Disables HTTP Keep-Alive for XmlRpcGroupsServicesConnector HTTP Requests, - ; this is a work around fora problem discovered on some Windows based region servers. - ; Only disable keep alive if you see a large number (dozens) of the following Exceptions: + ; Disables HTTP Keep-Alive for XmlRpcGroupsServicesConnector HTTP Requests, + ; this is a work around fora problem discovered on some Windows based region servers. + ; Only disable keep alive if you see a large number (dozens) of the following Exceptions: ; System.Net.WebException: The request was aborted: The request was canceled. ; ; XmlRpcDisableKeepAlive = false @@ -1321,7 +1320,7 @@ ;FullUpdateRate=14 ;PacketMTU = 1400 - + ; TextureUpdateRate (mS) determines how many times per second ; texture send processing will occur. The default is 100mS. ; @@ -1371,7 +1370,6 @@ ; to customize your data - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; The below pulls in optional module config files ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -- cgit v1.1 From 23d478f2fa06d1dedabfb24cf6ff763b586173ce Mon Sep 17 00:00:00 2001 From: Kunnis Date: Sun, 9 Aug 2009 02:01:21 -0500 Subject: Adding in Reflection-based testing, to ensure that all properties are covered. --- bin/OpenSim.Data.NHibernate.Tests.dll.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'bin') diff --git a/bin/OpenSim.Data.NHibernate.Tests.dll.config b/bin/OpenSim.Data.NHibernate.Tests.dll.config index a3f681d..9b3231f 100644 --- a/bin/OpenSim.Data.NHibernate.Tests.dll.config +++ b/bin/OpenSim.Data.NHibernate.Tests.dll.config @@ -26,7 +26,7 @@ - + -- cgit v1.1 From cef16bec6dabc90fdccf82f755d24683d834208b Mon Sep 17 00:00:00 2001 From: Melanie Date: Mon, 17 Aug 2009 08:45:20 +0100 Subject: Add the OpenSim.ConsoleClient app. Usage: OpenSim.ConsoleClient -h -p -u -P host defaults to localhost, port defaults to 8003. --- bin/OpenSim.ConsoleClient.exe.config | 33 +++++++++++++++++++++++++++++++++ bin/OpenSim.ConsoleClient.ini.example | 1 + 2 files changed, 34 insertions(+) create mode 100644 bin/OpenSim.ConsoleClient.exe.config create mode 100644 bin/OpenSim.ConsoleClient.ini.example (limited to 'bin') diff --git a/bin/OpenSim.ConsoleClient.exe.config b/bin/OpenSim.ConsoleClient.exe.config new file mode 100644 index 0000000..c2d93c0 --- /dev/null +++ b/bin/OpenSim.ConsoleClient.exe.config @@ -0,0 +1,33 @@ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/bin/OpenSim.ConsoleClient.ini.example b/bin/OpenSim.ConsoleClient.ini.example new file mode 100644 index 0000000..beea7d8 --- /dev/null +++ b/bin/OpenSim.ConsoleClient.ini.example @@ -0,0 +1 @@ +[Startup] -- cgit v1.1 From 24f5bd8a0ba30a93cccb9f1ed7bb31dfab8b945f Mon Sep 17 00:00:00 2001 From: Melanie Date: Mon, 17 Aug 2009 08:48:37 +0100 Subject: Add the remote console parameters to the example file --- bin/OpenSim.Server.ini.example | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'bin') diff --git a/bin/OpenSim.Server.ini.example b/bin/OpenSim.Server.ini.example index f0c0de9..aab0566 100644 --- a/bin/OpenSim.Server.ini.example +++ b/bin/OpenSim.Server.ini.example @@ -14,6 +14,12 @@ ServiceConnectors = "OpenSim.Server.Handlers.dll:AssetServiceConnector,OpenSim.S [Network] port = 8003 +; * The following are for the remote console +; * They have no effect for the local or basic console types +; * Leave commented to diable logins to the console +;ConsoleUser = Test +;ConsolePass = secret + ; * As an example, the below configuration precisely mimicks the legacy ; * asset server. It is read by the asset IN connector (defined above) ; * and it then loads the OUT connector (a local database module). That, -- cgit v1.1 From 3d7bb7567c7452d4a1216db5656d0b02957cf950 Mon Sep 17 00:00:00 2001 From: Melanie Date: Mon, 17 Aug 2009 09:21:39 +0100 Subject: Add the ability to use -console=rest to the region server. User and pass are specified the same way as for the ROBUST server --- bin/OpenSim.ConsoleClient.exe.config | 2 +- bin/OpenSim.ini.example | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) (limited to 'bin') diff --git a/bin/OpenSim.ConsoleClient.exe.config b/bin/OpenSim.ConsoleClient.exe.config index c2d93c0..7aa974c 100644 --- a/bin/OpenSim.ConsoleClient.exe.config +++ b/bin/OpenSim.ConsoleClient.exe.config @@ -17,7 +17,7 @@ - + diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example index db993b4..a1532c5 100644 --- a/bin/OpenSim.ini.example +++ b/bin/OpenSim.ini.example @@ -292,6 +292,8 @@ LibrariesXMLFile="./inventory/Libraries.xml" [Network] + ConsoleUser = "Test" + ConsolePass = "secret" http_listener_port = 9000 default_location_x = 1000 default_location_y = 1000 -- cgit v1.1 From 30c4aa55e6f18d153f164529a3435e44754c5352 Mon Sep 17 00:00:00 2001 From: Adam Frisby Date: Tue, 18 Aug 2009 00:58:42 +1000 Subject: Added additional configuration options for MRM Security. See OpenSim.ini.example under the [MRM] section. --- bin/OpenSim.ini.example | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'bin') diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example index a1532c5..166f2c6 100644 --- a/bin/OpenSim.ini.example +++ b/bin/OpenSim.ini.example @@ -1163,10 +1163,28 @@ [MRM] - ; Enables the Mini Region Modules Script Engine. WARNING: SECURITY RISK. + ; Enables the Mini Region Modules Script Engine. ; default is false Enabled = false - + + ; Runs MRM in a Security Sandbox + ; WARNING: DISABLING IS A SECURITY RISK. + Sandboxed = true + + ; The level sandbox to use, adjust at your OWN RISK. + ; Valid values are: + ; * FullTrust + ; * SkipVerification + ; * Execution + ; * Nothing + ; * LocalIntranet + ; * Internet + ; * Everything + SandboxLevel = "Internet" + + ; Only allow Region Owners to run MRMs + ; May represent a security risk if you disable this. + OwnerOnly = true [Hypergrid] ; Keep it false for now. Making it true requires the use of a special client in order to access inventory -- cgit v1.1 From eb78ac343e68d36a84fdc7fec47797233699cccc Mon Sep 17 00:00:00 2001 From: Justin Clark-Casey (justincc) Date: Mon, 17 Aug 2009 19:48:32 +0100 Subject: Apply http://opensimulator.org/mantis/view.php?id=3538 Add ability to silence IRC relay of region joins and quits from certain users This is useful for admins who wish to remain hidden, or service bots. Thanks RemedyTomm --- bin/OpenSim.ini.example | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) (limited to 'bin') diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example index 166f2c6..9a17c58 100644 --- a/bin/OpenSim.ini.example +++ b/bin/OpenSim.ini.example @@ -679,16 +679,21 @@ ;relay_chat = true ;access_password = foobar - ;fallback_region = name of "default" region - ;MSGformat fields : 0=botnick, 1=user, 2=region, 3=message - ; must start with "PRIVMSG {0} : " or irc server will get upset - ;for : : - ;msgformat = "PRIVMSG {0} :<{1} in {2}>: {3}" - ;for : - : - msgformat = "PRIVMSG {0} : {3} - {1} of {2}" - ;for : - from : - ;msgformat = "PRIVMSG {0} : {3} - from {1}" - + ;;fallback_region = name of "default" region + ;;MSGformat fields : 0=botnick, 1=user, 2=region, 3=message + ;; must start with "PRIVMSG {0} : " or irc server will get upset + ;;for : : + ;;msgformat = "PRIVMSG {0} :<{1} in {2}>: {3}" + ;;for : - : + ;msgformat = "PRIVMSG {0} : {3} - {1} of {2}" + ;;for : - from : + ;;msgformat = "PRIVMSG {0} : {3} - from {1}" + + ;; exclude_list allows you to stop the IRC connector from announcing the + ;;arrival and departure of certain users. For example: admins, bots. + + ;exclude_list=User 1,User 2,User 3 + ;[CMS] ;enabled = true -- cgit v1.1 From cd3b7bcb03cf1fa8c5303926c79cebe77dd8af8e Mon Sep 17 00:00:00 2001 From: Teravus Ovares (Dan Olivares) Date: Tue, 18 Aug 2009 01:19:01 -0400 Subject: * Update HTTP Server with jhurliman's longheader fix. Changes 1024 with 4096. --- bin/HttpServer_OpenSim.dll | Bin 113664 -> 113664 bytes bin/HttpServer_OpenSim.pdb | Bin 304640 -> 382464 bytes bin/HttpServer_OpenSim.xml | 6806 ++++++++++++++++++++++---------------------- 3 files changed, 3403 insertions(+), 3403 deletions(-) (limited to 'bin') diff --git a/bin/HttpServer_OpenSim.dll b/bin/HttpServer_OpenSim.dll index 287321c..5414276 100644 Binary files a/bin/HttpServer_OpenSim.dll and b/bin/HttpServer_OpenSim.dll differ diff --git a/bin/HttpServer_OpenSim.pdb b/bin/HttpServer_OpenSim.pdb index 41a152a..7c00e66 100644 Binary files a/bin/HttpServer_OpenSim.pdb and b/bin/HttpServer_OpenSim.pdb differ diff --git a/bin/HttpServer_OpenSim.xml b/bin/HttpServer_OpenSim.xml index c549ebc..9c3df78 100644 --- a/bin/HttpServer_OpenSim.xml +++ b/bin/HttpServer_OpenSim.xml @@ -4,389 +4,242 @@ HttpServer_OpenSim - + - Interface for sessions + Inversion of control interface. - + - Remove everything from the session + Add a component instance + Interface type + Instance to add - + - Remove everything from the session + Get a component. - True if the session is cleared due to expiration + Interface type + Component if registered, otherwise null. + + Component will get created if needed. + - + - Session id + Checks if the specified component interface have been added. + + true if found; otherwise false. - + - Should + Add a component. - Name of the session variable - null if it's not set - If the object cant be serialized. + Type being requested. + Type being created. - + - When the session was last accessed. - This property is touched by the http server each time the - session is requested. + 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. + + Throw if you are using a and want to prompt for user name/password. + - + - Number of session variables. + 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 + true if this module handled the request. - + - Event triggered upon clearing the session + Set the log writer to use. + logwriter to use. - + - Arguments sent when a is cleared + Log something. + importance of log message + message - + - Instantiates the arguments for the event + 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. - True if the session is cleared due to expiration - + - Returns true if the session is cleared due to expiration + Container to bind resource names to assemblies - + - Delegate for when a IHttpSession is cleared + Instantiates an instance of - this is being cleared. - Arguments for the clearing + The dot seperated uri the resource maps to + The full resource name + The assembly the resource exists in - + - Contains a listener that doesn't do anything with the connections. + Retrieves a stream to the resource + Null if the resource couldn't be located somehow - + - Listen for regular HTTP connections + Retrieves the assembly the resource resides in - 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. - + - Initializes a new instance of the class. + Retrieves the full name/path of the assembly - IP Address to accept connections on - TCP Port to listen on, default HTTPS port is 443 - Factory used to create es. - Certificate to use - + - Initializes a new instance of the class. + Retrieves the extension of the resource - 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. + + Returns the Uri without extension - - - Will try to accept connections one more time. - - If any exceptions is thrown. + + Retrieves the full path name to the resource file - + - Can be used to create filtering of new connections. + The object form class takes an object and creates form items for it. - Accepted socket - true if connection can be accepted; otherwise false. - + - Start listen for new connections + Initializes a new instance of the class. - Number of connections that can stand in a queue to be accepted. - Listener have already been started. + + form name *and* id. + action to do when form is posted. + - + - Stop the listener + Initializes a new instance of the class. - + form name *and* id. + action to do when form is posted. + object to get values from - + - Gives you a change to receive log entries for all internals of the HTTP library. + Initializes a new instance of the class. - - You may not switch log writer after starting the listener. - + form action. + object to get values from. - + - True if we should turn on trace logs. + write out the FORM-tag. + generated html code - + - Catch exceptions not handled by the listener. + Writeout the form tag - - Exceptions will be thrown during debug mode if this event is not used, - exceptions will be printed to console and suppressed during release mode. - + form should be posted through ajax. + generated html code - + - A request have been received from a . + Generates a text box. + + + generated html code - + - The server encountered an unexpected condition which prevented it from fulfilling the request. + password box + + + generated html code - + - All HTTP based exceptions will derive this class. + Hiddens the specified property name. + Name of the property. + The options. + generated html code - + - Create a new HttpException + Labels the specified property name. - http status code (sent in the response) - error description + property in object. + caption + generated html code - + - Create a new HttpException + Generate a checkbox - http status code (sent in the response) - error description - inner exception + property in object + checkbox value + additional html attributes. + generated html code - + - status code to use in the response. + Write a html select tag + object property. + id column + The title column. + The options. + - + - Initializes a new instance of the class. + Selects the specified property name. + Name of the property. + The items. + The id column. + The title column. + The options. + - + - Initializes a new instance of the class. + Write a submit tag. - error message. + button caption + html submit tag - + - Initializes a new instance of the class. + html end form tag - error message. - inner exception. + html - + - Used to inform http server that - - - - - Eventarguments used when an exception is thrown by a module - - the exception - - - - Exception thrown in a module - - - - - Container to bind resource names to assemblies - - - - - Instantiates an instance of - - The dot seperated uri the resource maps to - The full resource name - The assembly the resource exists in - - - - Retrieves a stream to the resource - - Null if the resource couldn't be located somehow - - - - Retrieves the assembly the resource resides in - - - - - Retrieves the full name/path of the assembly - - - - - Retrieves the extension of the resource - - - - Returns the Uri without extension - - - Retrieves the full path name to the resource file - - - - - - - - - - - Represents a field in a multipart form - - - - Event arguments used when a new header have been parsed. - - - - - Initializes a new instance of the class. - - Name of header. - Header value. - - - - Initializes a new instance of the class. - - - - - Gets or sets header name. - - - - - Gets or sets header value. - - - - - New implementation of the HTTP listener. - - - Use the Create methods to create a default listener. - - - - - Initializes a new instance of the class. - - 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. - - - - Initializes a new instance of the class. - - The address. - The port. - The factory. - The certificate. - - - - Initializes a new instance of the class. - - The address. - The port. - The factory. - The certificate. - The protocol. - - - - Creates a new instance with default factories. - - Address that the listener should accept connections on. - Port that listener should accept connections on. - Created HTTP listener. - - - - 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. - - - - 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 - which HTTPS protocol to use, default is TLS. - Created HTTP listener. - - - - Can be used to create filtering of new connections. - - Accepted socket - - true if connection can be accepted; otherwise false. - - - - - A client have been accepted, but not handled, by the listener. - - - - - This decoder converts XML documents to form items. - Each element becomes a subitem in the form, and each attribute becomes an item. + This decoder converts XML documents to form items. + Each element becomes a subitem in the form, and each attribute becomes an item. // xml: somethingdata @@ -448,3593 +301,3643 @@ 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 - + - 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. + The server encountered an unexpected condition which prevented it from fulfilling the request. - Class that the exception was thrown in. - Exception - - Server will throw a InternalServerException in release version if you dont - handle this delegate. - - + - Implements HTTP Digest authentication. It's more secure than Basic auth since password is - encrypted with a "key" from the server. + All HTTP based exceptions will derive this class. - - Keep in mind that the password is encrypted with MD5. Use a combination of SSL and digest auth to be secure. - - + - Authentication modules are used to implement different - kind of HTTP authentication. + Create a new HttpException + http status code (sent in the response) + error description - + - Tag used for authentication. + Create a new HttpException + http status code (sent in the response) + error description + inner exception - + - Initializes a new instance of the class. + status code to use in the response. - 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. - Delegate used to provide information used during authentication. - + - Create a response that can be sent in the WWW-Authenticate header. + Initializes a new instance of the class. - Realm that the user should authenticate in - Array with optional options. - A correct authentication request. - If realm is empty or null. + error message. - + - An authentication response have been received from the web browser. - Check if it's correct + Initializes a new instance of the class. - 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. + error message. + inner exception. - + - Used to invoke the authentication delegate that is used to lookup the user name/realm. + Session store using memory for each session. - 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. + A session store is used to store and load sessions on a media. + The default implementation () saves/retrieves sessions from memory. - 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 - + - name used in HTTP request. + Creates a new http session with a generated id. + A object - + - Initializes a new instance of the class. + Creates a new http session with a specific id - Delegate used to provide information used during authentication. - Delegate used to determine if authentication is required (may be null). + Id used to identify the new cookie.. + A object. + + Id should be generated by the store implementation if it's null or . + - + - Initializes a new instance of the class. + Load an existing session. - Delegate used to provide information used during authentication. + Session id (usually retrieved from a client side cookie). + A session if found; otherwise null. - + - Used by test classes to be able to use hardcoded values + Save an updated session to the store. + Session id (usually retrieved from a client side cookie). + If Id property have not been specified. - + - An authentication response have been received from the web browser. - Check if it's correct + We use the flyweight pattern which reuses small objects + instead of creating new each time. - 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. + Unused session that should be reused next time Create is called. - + - Encrypts parameters into a Digest string + Remove expired sessions - 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 - + - + Remove a session - 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 - + id of the session. - + - Create a response that can be sent in the WWW-Authenticate header. + Load a session from the store - 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. + + null if session is not found. - + - Decodes authorization header value + Number of minutes before a session expires. - 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. + Default time is 20 minutes. - + - Gets the current nonce. + Initializes the class setting the expirationtimer to clean the session every minute - - + - Gets the Md5 hash bin hex2. + Delegate for the cleanup timer - To be hashed. - - + - determines if the nonce is valid or has expired. + Creates a new http session - nonce value (check wikipedia for info) - true if the nonce has not expired. + - + - name used in http request. + Creates a new http session with a specific id + Id used to identify the new cookie.. + A object. + + Id should be generated by the store implementation if it's null or . + - + - Gets or sets whether the token supplied in is a - HA1 generated string. + Load an existing session. + + - + - Class that receives Requests from a . + Save an updated session to the store. + - + - Client have been disconnected. + We use the flyweight pattern which reuses small objects + instead of creating new each time. - Client that was disconnected. - Reason - + EmptyLanguageNode (unused) session that should be reused next time Create is called. - + - Invoked when a client context have received a new HTTP request + Remove expired sessions - Client that received the request. - Request that was received. - - + - Delegate used to find a realm/domain. + Remove a session - - - - Realms are used during HTTP Authentication - - - + id of the session. - + - A complete HTTP server, you need to add a module to it to be able to handle incoming requests. + Load a session from the store - - - // 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); - - - - - + + null if session is not found. - + - Initializes a new instance of the class. + Number of minutes before a session expires. + Default is 20 minutes. - Used to get all components used in the server.. - + - Initializes a new instance of the class. + Cookies that should be set. - + - Initializes a new instance of the class. + Adds a cookie in the collection. - Form decoders are used to convert different types of posted data to the object types. - - + cookie to add + cookie is null - + - Initializes a new instance of the class. + Copy a request cookie - A session store is used to save and retrieve sessions - + + When the cookie should expire - + - Initializes a new instance of the class. + Gets a collection enumerator on the cookie list. - The log writer. - + collection enumerator - + - Initializes a new instance of the class. + Remove all cookies - 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. + Returns an enumerator that iterates through the collection. - 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. - - - - + + + A that can be used to iterate through the collection. + + 1 - + - Adds the specified rule. + Gets the count of cookies in the collection. - The rule. - + - Add a to the server. + Gets the cookie of a given identifier (null if not existing). - mode to add - + - Decodes the request body. + Small design by contract implementation. - The request. - Failed to decode form data. - + - Generate a HTTP error page (that will be added to the response body). - response status code is also set. + Check whether a parameter is empty. - Response that the page will be generated in. - . - response body contents. + Parameter value + Parameter name, or error description. + value is empty. - + - Generate a HTTP error page (that will be added to the response body). - response status code is also set. + Checks whether a parameter is null. - Response that the page will be generated in. - exception. + Parameter value + Parameter name, or error description. + value is null. - + - Realms are used by the s. + Checks whether a parameter is null. - HTTP request - domain/realm. + + Parameter value + Parameter name, or error description. + value is null. - + - Process an incoming request. + Parses a HTTP request directly from a stream - connection to client - request information - response that should be filled - session information - + - Can be overloaded to implement stuff when a client have been connected. + Event driven parser used to parse incoming HTTP requests. - Default implementation does nothing. + 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. - client that disconnected - disconnect reason - + - Handle authentication + Parse partial or complete message. - - - - true if request can be handled; false if not. - Invalid authorization header + buffer containing incoming bytes + where in buffer that parsing should start + number of bytes to parse + Unparsed bytes left in buffer. + BadRequestException. - + - Will request authentication. + Clear parser state. - - Sends respond to client, nothing else can be done with the response after this. - - - - - + - Received from a when a request have been parsed successfully. + Current state in parser. - that received the request. - The request. - + - To be able to track request count. + A request have been successfully parsed. - - - + - Start the web server using regular HTTP. + More body bytes have been received. - 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. - + - Accept secure connections. + Request line have been received. - 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 + A header have been received. - + - write an entry to the log file + Gets or sets the log writer. - importance of the message - log message - + - write an entry to the log file + Create a new request parser - object that wrote the message - importance of the message - log message + delegate receiving log entries. - + - Server that is handling the current request. + Add a number of bytes to the body - - Will be set as soon as a request arrives to the object. - + buffer containing more body bytes. + starting offset in buffer + number of bytes, from offset, to read. + offset to continue from. - + - Modules used for authentication. The module that is is added first is used as - the default authentication module. + Remove all state information for the request. - Use the corresponding property - in the if you are using multiple websites. - + - Form decoder providers are used to decode request body (which normally contains form data). + Parse request line + + If line is incorrect + Expects the following format: "Method SP Request-URI SP HTTP-Version CRLF" - + - Server name sent in HTTP responses. + We've parsed a new header. - - Do NOT include version in name, since it makes it - easier for hackers. - + Name in lower case + Value, unmodified. + If content length cannot be parsed. - + - Name of cookie where session id is stored. + 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. - + - Specified where logging should go. + Gets or sets the log writer. - - - - + - Number of connections that can wait to be accepted by the server. + Current state in parser. - Default is 10. - + - Gets or sets maximum number of allowed simultaneous requests. + A request have been successfully parsed. - - - 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. - - - + - Gets or sets maximum number of requests queuing to be handled. + More body bytes have been received. - - - 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. + Request line have been received. - + - Let's to receive unhandled exceptions from the threads. + A header have been received. - - Exceptions will be thrown during debug mode if this event is not used, - exceptions will be printed to console and suppressed during release mode. - - + - Webhelper provides helpers for common tasks in HTML. + The website module let's you handle multiple websites in the same server. + It uses the "Host" header to check which site you want. + 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. - + - Used to let the website use different javascript libraries. - Default is + + domain name that should be handled. + - + - Creates a link that invokes through ajax. + Method that process the url - 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');"); - + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to - + - Builds a link that updates an element with the fetched ajax content. + Name of site. - 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. - + + Container for posted form data + + - A link that pop ups a Dialog (overlay div) + Contains some kind of input from the browser/client. + can be QueryString, form data or any other request body content. - 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!');"); - - + - Create/Open a dialog box using ajax + Base class for request data containers - - - - - + - Close a javascript dialog window/div. + Adds a parameter mapped to the presented name - javascript for closing a dialog. - + The name to map the parameter to + The parameter value - + - Create a <form> tag. + Returns true if the container contains the requested parameter - name of form - action to invoke on submit - form should be posted as ajax - html code - - WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); - + Parameter id + True if parameter exists - + - Create a link tag. + Returns a request parameter - 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?');"); - + The name associated with the parameter + - + + Representation of a non-initialized class instance + + + Variable telling the class that it is non-initialized + + - Build a link + Initializes a new instance of the class. - url to go to. - title of link (displayed text) - extra html attributes. - a complete link + form name. - + - Build a link + Initializes a new instance of the class. - url to go to. - title of link (displayed text) - extra html attributes. - a complete link - more options + 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 + + - Obsolete + Add a new element. Form array elements are parsed + and added in a correct hierarchy. - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete + Name is converted to lower case. + + name is null. + Cannot add stuff to . - + - Obsolete + Returns true if the class contains a with the corresponding name. - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete - Obsolete + The field/query string name + True if the value exists - + - Render errors into a UL with class "errors" + Parses an item and returns it. + This function is primarily used to parse array items as in user[name]. - class used by UL-tag. - items to list - an unordered html list. + + + - + + Outputs the instance representing all its values joined together + + + + Returns all items as an unescaped query string. + + + - Render errors into a UL with class "errors" + Extracts one parameter from an array - class used by UL-tag. - items to list - an unordered html list. + 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 + + - Render errors into a UL with class "errors" + Returns an enumerator that iterates through the collection. - - + + + A that can be used to iterate through the collection. + + 1 - + - Generates a list with html attributes. + Returns an enumerator that iterates through a collection. - StringBuilder that the options should be added to. - attributes set by user. - attributes set by any of the helper classes. + + + An object that can be used to iterate through the collection. + + 2 - + - Generates a list with html attributes. + Form name as lower case - StringBuilder that the options should be added to. - - + - Purpose of this class is to create a javascript toolkit independent javascript helper. + Get a form item. + + Returns if item was not found. - + + Instance to help mark a non-initialized form + + + Initializes a form container with the specified name + + - Generates a list with JS options. + Makes a deep copy of the input - 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. + The input to copy - + - Removes any javascript parameters from an array of parameters + Adds a file to the collection of posted files - The array of parameters to remove javascript params from - An array of html parameters + The file to add + If the file is already added + If file is null + If the instance is HttpForm.EmptyForm which cannot be modified - + - javascript action that should be added to the "onsubmit" event in the form tag. + Checks if the form contains a specified file - - All javascript option names should end with colon. - - - JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); - - + Field name of the file parameter + True if the file exists + If the instance is HttpForm.EmptyForm which cannot be modified - + - Requests a url through ajax + Retrieves a file held by by the form - 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);"); - - + 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 + + - Ajax requests that updates an element with - the fetched content + Retrieves the number of files added to the - 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!');"); - - + 0 if no files are added - + - A link that pop ups a Dialog (overlay div) + 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 - 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!');"); - - + - Close a javascript dialog window/div. + Create a new bad request exception. - javascript for closing a dialog. - + reason to why the request was bad. - + - Creates a new modal dialog window + Create a new bad request exception. - url to open in window. - window title (may not be supported by all js implementations) - - + reason to why the request was bad. + inner exception - + - PrototypeJS implementation of the javascript functions. + A session stored in memory. - + - Requests a url through ajax + Interface for sessions - 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 + Remove everything from the session - options to check in - value to find - true if value was found - case insensitive - + - Ajax requests that updates an element with - the fetched content + Remove everything from the session - 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"); - - + True if the session is cleared due to expiration - + - A link that pop ups a Dialog (overlay div) + Session id - 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) + Should - url to fetch - dialog title - javascript/html attributes. javascript options ends with colon ':'. - + Name of the session variable + null if it's not set + If the object cant be serialized. - + - Close a javascript dialog window/div. + When the session was last accessed. + This property is touched by the http server each time the + session is requested. - javascript for closing a dialog. - - + - javascript action that should be added to the "onsubmit" event in the form tag. + Number of session variables. - remember to encapsulate strings in '' - - All javascript option names should end with colon. - - - JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); - - - + - Event driven parser used to parse incoming HTTP requests. + Event triggered upon clearing the session - - 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. - - + - 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. + A unique id used by the sessions store to identify the session - + - Clear parser state. + Id + - + - Current state in parser. + Remove everything from the session - + - A request have been successfully parsed. + Clears the specified expire. + True if the session is cleared due to expiration - + - More body bytes have been received. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + 2 - + - Request line have been received. + Session id - + - A header have been received. + Should + Name of the session variable + null if it's not set - + - Gets or sets the log writer. + when the session was last accessed. + + Used to determine when the session should be removed. + - + - Current state in the parsing. + Number of values in the session - + - Should parse the request line + Flag to indicate that the session have been changed + and should be saved into the session store. - + - Searching for a complete header name + Event triggered upon clearing the session - + - Searching for colon after header name (ignoring white spaces) + redirects from one URL to another. - + - Searching for start of header value (ignoring white spaces) + Rules are used to perform operations before a request is being handled. + Rules can be used to create routing etc. - + - Searching for a complete header value (can span over multiple lines, as long as they are prefixed with one/more whitespaces) + 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. - + - Adding bytes to body + Initializes a new instance of the class. + Absolute path (no server name) + Absolute path (no server name) + + server.Add(new RedirectRule("/", "/user/index")); + - + - Contains server side HTTP request information. + 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")); + - + - Called during parsing of a . + Process the incoming request. - Name of the header, should not be URL encoded - Value of the header, should not be URL encoded - If a header is incorrect. + 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. + - + - Add bytes to the body + Gets string to match request URI with. - 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. + Is compared to request.Uri.AbsolutePath - + - Clear everything in the request + Gets where to redirect. - + - Decode body into a form. + Gets whether server should redirect client. - A list with form decoders. - If body contents is not valid for the chosen decoder. - If body is still being transferred. + + 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. + - + - Sets the cookies. + cookie sent by the client/browser - The cookies. + - + - Create a response object. + Constructor. - Context for the connected client. - A new . + cookie identifier + cookie content + id or content is null + id is empty - + - Gets kind of types accepted by the client. + Gets the cookie HTML representation. + cookie string - + - Gets or sets body stream. + Gets the cookie identifier. - + - Gets whether the body is complete. + Cookie value. Set to null to remove cookie. - + - Gets or sets kind of connection used for the session. + Priority for log entries + - + - Gets or sets number of bytes in the body. + Very detailed logs to be able to follow the flow of the program. - + - Gets cookies that was sent with the request. + Logs to help debug errors in the application - + - Gets form parameters. + Information to be able to keep track of state changes etc. - + - Gets headers sent by the client. + Something did not go as we expected, but it's no problem. - + - Gets or sets version of HTTP protocol that's used. + Something that should not fail failed, but we can still keep + on going. - - Probably or . - - - + - Gets whether the request was made by Ajax (Asynchronous JavaScript) + Something failed, and we cannot handle it properly. - + - Gets or sets requested method. + Interface used to write to log files. - - Will always be in upper case. - - - + - Gets parameter from or . + Write an entry to the log file. + object that is writing to the log + importance of the log message + the message - + - Gets variables sent in the query string + This class writes to the console. It colors the output depending on the logprio and includes a 3-level stacktrace (in debug mode) + - + - Gets or sets requested URI. + The actual instance of this class. - + - Gets URI absolute path divided into parts. + Logwriters the specified source. - - // 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. - - + object that wrote the logentry. + Importance of the log message + The message. - + - Gets or sets path and query. + Get color for the specified logprio - - - Are only used during request parsing. Cannot be set after "Host" header have been - added. - + prio for the log entry + A for the prio - + - Delegate used to let authentication modules authenticate the user name and password. + Default log writer, writes everything to null (nowhere). - 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); - - + - + - Let's you decide on a system level if authentication is required. + The logging instance. - HTTP request from client - true if user should be authenticated. - throw if no more attempts are allowed. - If no more attempts are allowed - + - Serves files that are stored in embedded resources. + Writes everything to null + object that wrote the log entry. + Importance of the log message + The message. - + - 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. + Class that receives Requests from a . - - Throw if you are using a and want to prompt for user name/password. - - + - Method that process the url + Client have been disconnected. - 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. + Client that was disconnected. + Reason + - + - Set the log writer to use. + Invoked when a client context have received a new HTTP request - logwriter to use. + Client that received the request. + Request that was received. + - + - Log something. + Will contain helper functions for javascript. - 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. + 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>"; + + - + - 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. + 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"); + + - + - 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. + Opens contents in a dialog window. - The log writer to use when logging events + url to contents of dialog + link title + name, value, name, value, all parameter names should end with colon. - + - Mimtypes that this class can handle per default + Close a javascript dialog window/div. + javascript for closing a dialog. + - + - Loads resources from a namespace in the given assembly to an uri + Helpers making it easier to work with forms. - 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"); + + + + + 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); - 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 + // 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 - + - Returns true if the module can handle the request + 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. + - + - Method that process the url + Creates a select list with the values in a collection. - 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. + 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. - + - List with all mime-type that are allowed. + Creates a select list with the values in a collection. - All other mime types will result in a Forbidden http status code. + 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. - + - The purpose of this module is to serve files. + 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. + + - Initializes a new instance of the class. + Creates a check box. - 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 + 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 - + - Initializes a new instance of the class. + Creates a check box. - Uri to serve, for instance "/files/" - Path on hard drive where we should start looking for files + 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) + - + - Mimtypes that this class can handle per default + 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". - + - Determines if the request should be handled by this module. - Invoked by the + Creates a RadioButton. - - true if this module should handle it. + 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 - - Illegal path + + + 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 - + - check if source contains any of the chars. + form close tag - - - + - Method that process the Uri. + Arguments sent when a is cleared - 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. - + - return a file extension from an absolute Uri path (or plain filename) + Instantiates the arguments for the event - - + True if the session is cleared due to expiration - + - List with all mime-type that are allowed. + Returns true if the session is cleared due to expiration - All other mime types will result in a Forbidden http status code. - + - characters that may not exist in a path. + Delegate for when a IHttpSession is cleared + + this is being cleared. + Arguments for the clearing + + + + Used to queue incoming requests. + + + + + Initializes a new instance of the class. + + Called when a request should be processed. + + + + Used to process queued requests. + + + + + Gets or sets maximum number of allowed simultaneous requests. + + + + + Gets or sets maximum number of requests queuing to be handled. + + + + + Specifies how many requests the HTTP server is currently processing. + + + + + Used two queue incoming requests to avoid + thread starvation. + + + + + Method used to process a queued request + + Context that the request was received from. + Request to process. + + + + Creates request parsers when needed. + + + + Creates request parsers when needed. + + + + + Create a new request parser. + + Used when logging should be enabled. + A new request parser. + + + + Create a new request parser. + + Used when logging should be enabled. + A new request parser. + + + + 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 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. + + - fileMod.ForbiddenChars = new string[]{ "\\", "..", ":" }; + + // 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. - - Container for posted form data + + + 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) + { + + } + - + - Contains some kind of input from the browser/client. - can be QueryString, form data or any other request body content. + 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. - + - Base class for request data containers + Send headers and body to the browser. + If content have already been sent. - + - Adds a parameter mapped to the presented name + Make sure that you have specified ContentLength and sent the headers first. - The name to map the parameter to - The parameter value + + 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. - + - Returns true if the container contains the requested parameter + Make sure that you have specified ContentLength and sent the headers first. - Parameter id - True if parameter exists + + 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. - + - Returns a request parameter + Send headers to the client. - The name associated with the parameter - - - - Representation of a non-initialized class instance - - - Variable telling the class that it is non-initialized + If headers already been sent. + + + - + - Initializes a new instance of the class. + Redirect client to somewhere else using the 302 status code. - form name. + 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 - 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 + where the redirect should go + + No body are allowed when doing redirects. + - + - Add a new element. Form array elements are parsed - and added in a correct hierarchy. + The body stream is used to cache the body contents + before sending everything to the client. It's the simplest + way to serve documents. - Name is converted to lower case. - - name is null. - Cannot add stuff to . - + - Returns true if the class contains a with the corresponding name. + Defines the version of the HTTP Response for applications where it's required + for this to be forced. - 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]. + 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. - - - - - - Outputs the instance representing all its values joined together - - - - Returns all items as an unescaped query string. - - + - Extracts one parameter from an array + Kind of connection - 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 - + - Returns an enumerator that iterates through the collection. + Encoding to use when sending stuff to the client. - - - A that can be used to iterate through the collection. - - 1 + Default is UTF8 - + - Returns an enumerator that iterates through a collection. + Number of seconds to keep connection alive - - - An object that can be used to iterate through the collection. - - 2 + Only used if Connection property is set to ConnectionType.KeepAlive - + - Form name as lower case + Status code that is sent to the client. + Default is HttpStatusCode.Ok - + - Get a form item. + Information about why a specific status code was used. - - Returns if item was not found. - - Instance to help mark a non-initialized form - - - Initializes a form container with the specified name - - + - Makes a deep copy of the input + Size of the body. MUST be specified before sending the header, + unless property Chunked is set to true. - The input to copy - + - Adds a file to the collection of posted files + Kind of content in the body - The file to add - If the file is already added - If file is null - If the instance is HttpForm.EmptyForm which cannot be modified + Default is text/html - + - Checks if the form contains a specified file + Headers have been sent to the client- - Field name of the file parameter - True if the file exists - If the instance is HttpForm.EmptyForm which cannot be modified + You can not send any additional headers if they have already been sent. - + - Retrieves a file held by by the form + The whole response have been sent. - 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 + Cookies that should be created/changed. - 0 if no files are added - + - Small design by contract implementation. + Initializes a new instance of the class. + Client that send the . + Contains information of what the client want to receive. + cannot be empty. - + - Check whether a parameter is empty. + Initializes a new instance of the class. - Parameter value - Parameter name, or error description. - value is empty. + Client that send the . + Version of HTTP protocol that the client uses. + Type of HTTP connection used. - + - Checks whether a parameter is null. + Add another header to the document. - Parameter value - Parameter name, or error description. - value is null. + 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. - + - Checks whether a parameter is null. + Send headers and body to the browser. - - Parameter value - Parameter name, or error description. - value is null. + If content have already been sent. - + - 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. + 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. - + - Initializes a new instance of the class. + Make sure that you have specified and sent the headers first. - Delegate used to provide information used during authentication. - Delegate used to determine if authentication is required (may be null). + + 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. - + - Initializes a new instance of the class. + Send headers to the client. - Delegate used to provide information used during authentication. + If headers already been sent. + + + - + - Create a response that can be sent in the WWW-Authenticate header. + Redirect client to somewhere else using the 302 status code. - Realm that the user should authenticate in - Not used in basic auth - A correct auth request. + 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. - + - An authentication response have been received from the web browser. - Check if it's correct + redirect to somewhere - 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. + where the redirect should go + + No body are allowed when doing redirects. + - + - name used in http request. + The body stream is used to cache the body contents + before sending everything to the client. It's the simplest + way to serve documents. - + - Rules are used to perform operations before a request is being handled. - Rules can be used to create routing etc. + 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. - + - Process the incoming request. + Defines the version of the HTTP Response for applications where it's required + for this to be forced. - 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. - + - Delegate used by to populate select options. + Kind of connection - 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; - } /// - + - 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 + Encoding to use when sending stuff to the client. + Default is UTF8 - + - Let's copy all the cookies. + Number of seconds to keep connection alive - value from cookie header. + Only used if Connection property is set to . - + - Adds a cookie in the collection. + Status code that is sent to the client. - cookie to add - cookie is null + Default is - + - Gets a collection enumerator on the cookie list. + Information about why a specific status code was used. - collection enumerator - + - Remove all cookies. + Size of the body. MUST be specified before sending the header, + unless property Chunked is set to true. - + - Returns an enumerator that iterates through the collection. + Kind of content in the body - - - A that can be used to iterate through the collection. - - 1 + Default type is "text/html" - + - Remove a cookie from the collection. + Headers have been sent to the client- - Name of cookie. + You can not send any additional headers if they have already been sent. - + - Gets the count of cookies in the collection. + The whole response have been sent. - + - Gets the cookie of a given identifier (null if not existing). + Cookies that should be created/changed. - + - 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 + Used to create and reuse contexts. - + - Create a new bad request exception. + Used to create es. - reason to why the request was bad. - + - Create a new bad request exception. + Creates a that handles a connected client. - reason to why the request was bad. - inner exception + Client socket (accepted by the ). + A creates . - + - A session store is used to store and load sessions on a media. - The default implementation () saves/retrieves sessions from memory. + Create a secure . + Client socket (accepted by the ). + HTTPS certificate to use. + Kind of HTTPS protocol. Usually TLS or SSL. + A created . - + - Creates a new http session with a generated id. + A request have been received from one of the contexts. - A object - + - Creates a new http session with a specific id + Initializes a new instance of the class. - Id used to identify the new cookie.. - A object. - - Id should be generated by the store implementation if it's null or . - + The writer. + Amount of bytes to read from the incoming socket stream. + Used to create a request parser. - + - Load an existing session. + Create a new context. - Session id (usually retrieved from a client side cookie). - A session if found; otherwise null. + true if socket is running HTTPS. + Client that connected + Network/SSL stream. + A context. - + - Save an updated session to the store. + Create a new context. - Session id (usually retrieved from a client side cookie). - If Id property have not been specified. + true if HTTPS is used. + Remote client + Network stream, uses . + A new context (always). - + - We use the flyweight pattern which reuses small objects - instead of creating new each time. + Create a secure . - Unused session that should be reused next time Create is called. + Client socket (accepted by the ). + HTTPS certificate to use. + Kind of HTTPS protocol. Usually TLS or SSL. + + A created . + - + - Remove expired sessions + Creates a that handles a connected client. + Client socket (accepted by the ). + + A creates . + - + - Remove a session + True if detailed trace logs should be written. - id of the session. - + - Load a session from the store + A request have been received from one of the contexts. - - null if session is not found. - + - Number of minutes before a session expires. + Custom network stream to mark sockets as reusable when disposing the stream. - Default time is 20 minutes. - + - Contains a connection to a browser/client. + 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. + - + - Disconnect from client + Initializes a new instance of the class for the specified with the specified ownership. - error to report in the event. + + 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. + - + - Send a response. + Creates a new instance of the class for the specified with the specified access rights. - 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. + + 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. + - + - Send a response. + Creates a new instance of the class for the specified with the specified access rights and the specified ownership. - Either or - HTTP status code - reason for the status code. + + 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. + - + - Send a response. + Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. - - + - send a whole buffer + Releases the unmanaged resources used by the and optionally releases the managed resources. - buffer to send - + true to release both managed and unmanaged resources; false to release only unmanaged resources. - + - Send data using the stream + 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. - Contains data to send - Start position in buffer - number of bytes to send - - - + - Closes the streams and disposes of the unmanaged resources + Authentication modules are used to implement different + kind of HTTP authentication. - + - Using SSL or other encryption method. + Tag used for authentication. - + - Using SSL or other encryption method. + 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 context have been disconnected. + Initializes a new instance of the class. - - Event can be used to clean up a context, or to reuse it. - + Delegate used to provide information used during authentication. - + - A request have been received in the context. + Create a response that can be sent in the WWW-Authenticate header. + Realm that the user should authenticate in + Array with optional options. + A correct authentication request. + If realm is empty or null. - + - A have been disconnected. + An authentication response have been received from the web browser. + Check if it's correct + 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. - + - Initializes a new instance of the class. + Used to invoke the authentication delegate that is used to lookup the user name/realm. - Reason to disconnection. + 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 - + - Gets reason to why client disconnected. + Determines if authentication is required. + 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 - + - + name used in HTTP request. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - The request. + Delegate used to provide information used during authentication. + Delegate used to determine if authentication is required (may be null). - + - Gets received request. + Initializes a new instance of the class. + Delegate used to provide information used during authentication. - + - cookie being sent back to the browser. + Create a response that can be sent in the WWW-Authenticate header. - + Realm that the user should authenticate in + Not used in basic auth + A correct auth request. - + - cookie sent by the client/browser + An authentication response have been received from the web browser. + Check if it's correct - + 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. - + - Constructor. + name used in http request. - cookie identifier - cookie content - id or content is null - id is empty - + - Gets the cookie HTML representation. + Used to inform http server that - cookie string - + - Gets the cookie identifier. + Eventarguments used when an exception is thrown by a module + the exception - + - Cookie value. Set to null to remove cookie. + Exception thrown in a module - + - Constructor. + PrototypeJS implementation of the javascript functions. - 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 + Purpose of this class is to create a javascript toolkit independent javascript helper. - 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. - + - Create a new cookie + Generates a list with JS options. - Name and value will be used - when the cookie expires. + 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. - + - Gets the cookie HTML representation. + Removes any javascript parameters from an array of parameters - cookie string + The array of parameters to remove javascript params from + An array of html parameters - + - When the cookie expires. - DateTime.MinValue means that the cookie expires when the session do so. + javascript action that should be added to the "onsubmit" event in the form tag. + + All javascript option names should end with colon. + + + JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); + + - + - Cookie is only valid under this path. + Requests a url through ajax + 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);"); + + - + - Contains all HTTP Methods (according to the HTTP 1.1 specification) - - See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html - + Ajax requests that updates an element with + the fetched 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!');"); + + - + - The DELETE method requests that the origin server delete the resource identified by the Request-URI. + A link that pop ups a Dialog (overlay div) - - - 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. - - + 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!');"); + - + - The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. + Close a javascript dialog window/div. - - - 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. - - + javascript for closing a dialog. + - + - The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. + Creates a new modal dialog window - - 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. - + url to open in window. + window title (may not be supported by all js implementations) + + - + - The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. + Requests a url through ajax - - 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. - + 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>"; + + - + - 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. + Determins if a list of strings contains a specific value - - 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. - - + options to check in + value to find + true if value was found + case insensitive - + - The PUT method requests that the enclosed entity be stored under the supplied Request-URI. + Ajax requests that updates an element with + the fetched content - - - - 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. - - + 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 TRACE method is used to invoke a remote, application-layer loop- back of the request message. + 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!');"); + - + - Contains all HTTP Methods (according to the HTTP 1.1 specification) - - See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html - + create a modal dialog (usually using DIVs) + url to fetch + dialog title + javascript/html attributes. javascript options ends with colon ':'. + - + - The DELETE method requests that the origin server delete the resource identified by the Request-URI. + Close a javascript dialog window/div. - - - 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. - - + javascript for closing a dialog. + - + - The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. + javascript action that should be added to the "onsubmit" event in the form tag. - - - 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. - - + remember to encapsulate strings in '' + + All javascript option names should end with colon. + + + JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); + + - + - The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. + Lists content type mime types. - - 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. - - + - The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. + text/plain - - 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. + text/haml - - 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. + content type for javascript documents = application/javascript - - - 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. + 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/ - + - The TRACE method is used to invoke a remote, application-layer loop- back of the request message. + text/xml - + - Generic helper functions for HTTP + A list of content types - + - Version string for HTTP v1.0 + + Semicolon separated content types. - + - Version string for HTTP v1.1 + Returns an enumerator that iterates through a collection. + + An object that can be used to iterate through the collection. + - + - An empty URI + Searches for the specified type + Can also be a part of a type (searching for "xml" would return true for "application/xml"). + true if type was found. - + - Parses a query string. + Get this first content type. - Query string (URI encoded) - A object if successful; otherwise - queryString is null. - If string cannot be parsed. - + - The object form class takes an object and creates form items for it. + Fetch a content type + Part of type ("xml" would return "application/xml") + + All content types are in lower case. - + - Initializes a new instance of the class. + Event arguments used when a new header have been parsed. - - form name *and* id. - action to do when form is posted. - - + - Initializes a new instance of the class. + Initializes a new instance of the class. - form name *and* id. - action to do when form is posted. - object to get values from + Name of header. + Header value. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - form action. - object to get values from. - + - write out the FORM-tag. + Gets or sets header name. - generated html code - + - Writeout the form tag + Gets or sets header value. - form should be posted through ajax. - generated html code - + - Generates a text box. + 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. - - - generated html code - + - password box + - - - generated html code + 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/"); + - + - Hiddens the specified property name. + Method that determines if an url should be handled or not by the module - Name of the property. - The options. - generated html code + Url requested by the client. + true if module should handle the url. - + - Labels the specified property name. + Method that process the url - property in object. - caption - generated html code + Information sent by the browser about the request + Information that is being sent back to the client. + Session used to - + - Generate a checkbox + Contains a connection to a browser/client. - property in object - checkbox value - additional html attributes. - generated html code + + Remember to after you have hooked the event. + + TODO: Maybe this class should be broken up into HttpClientChannel and HttpClientContext? - + - Write a html select tag + Contains a connection to a browser/client. - object property. - id column - The title column. - The options. - - + - Selects the specified property name. + Disconnect from client - Name of the property. - The items. - The id column. - The title column. - The options. - + error to report in the event. - + - Write a submit tag. + Send a response. - button caption - html submit tag + 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. - + - html end form tag + Send a response. - html + Either or + HTTP status code + reason for the status code. - + - Can handle application/x-www-form-urlencoded + Send a response. + - + + send a whole buffer - 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. + buffer to send + - + - Checks if the decoder can handle the mime type + Send data using the stream - 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 + Contains data to send + Start position in buffer + number of bytes to send + + - + - The requested resource was not found in the web server. + Closes the streams and disposes of the unmanaged resources - + - Create a new exception + Using SSL or other encryption method. - message describing the error - inner exception - + - Create a new exception + Using SSL or other encryption method. - message describing the error - + - Invoked when a client have been accepted by the + The context have been disconnected. - Can be used to revoke incoming connections + Event can be used to clean up a context, or to reuse it. - + - Initializes a new instance of the class. + A request have been received in the context. - The socket. - + - Client may not be handled. + Initializes a new instance of the class. + 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. - + - Accepted socket. + Process incoming body bytes. + + Bytes - + - Client should be revoked. + + + - + - Used to queue incoming requests. + Start reading content. + + Make sure to call base.Start() if you override this method. + - + - Initializes a new instance of the class. + Clean up context. - Called when a request should be processed. + + Make sure to call base.Cleanup() if you override the method. + - + - Used to process queued requests. + Disconnect from client + error to report in the event. - - - Gets or sets maximum number of allowed simultaneous requests. - + + BadRequestException. - + - Gets or sets maximum number of requests queuing to be handled. + 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. - + - Specifies how many requests the HTTP server is currently processing. + Send a response. + Either or + HTTP status code + reason for the status code. - + - Used two queue incoming requests to avoid - thread starvation. + Send a response. + - + - Method used to process a queued request + send a whole buffer - Context that the request was received from. - Request to process. + buffer to send + - + - Used when the request line have been successfully parsed. + Send data using the stream + Contains data to send + Start position in buffer + number of bytes to send + + - + - Initializes a new instance of the class. + This context have been cleaned, which means that it can be reused. - The HTTP method. - The URI path. - The HTTP version. - + - Initializes a new instance of the class. + Context have been started (a new client have connected) - + - Gets or sets http method. + Overload to specify own type. - Should be one of the methods declared in . + Must be specified before the context is being used. - + - Gets or sets the version of the HTTP protocol that the client want to use. + Using SSL or other encryption method. + + + + + Using SSL or other encryption method. + + + + + Specify which logger to use. - + - Gets or sets requested URI path. + Gets or sets the network stream. - + - Inversion of control interface. + Gets or sets IP address that the client connected from. - + - Add a component instance + Gets or sets port that the client connected from. - Interface type - Instance to add - + - Get a component. + The context have been disconnected. - Interface type - Component if registered, otherwise null. - Component will get created if needed. + Event can be used to clean up a context, or to reuse it. - + - Checks if the specified component interface have been added. + A request have been received in the context. - - true if found; otherwise false. - + - Add a component. + Helpers to make XML handling easier - Type being requested. - Type being created. - + - Response that is sent back to the web browser / client. + Serializes object to XML. + object to serialize. + XML - - 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. - + Removes name spaces and adds indentation - - - // 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. - + - 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. + Create an object from a XML string - - public void MyHandler(IHttpRequest request, IHttpResponse response) - { - - } - + Type of object + XML string + object - + - Add another header to the document. + Can handle application/x-www-form-urlencoded - 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. - If content have already been sent. + 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. - + - Make sure that you have specified ContentLength and sent the headers first. + Checks if the decoder can handle the mime type - - 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. + 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 - + - Make sure that you have specified ContentLength and sent the headers first. + The server understood the request, but is refusing to fulfill it. + Authorization will not help and the request SHOULD NOT be repeated. + If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, + it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information + available to the client, the status code 404 (Not Found) can be used instead. + + Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php - - 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. - - - + error message - + - Redirect client to somewhere else using the 302 status code. + Invoked when a client have been accepted by the - 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. + + Can be used to revoke incoming connections + - + - redirect to somewhere + Initializes a new instance of the class. - where the redirect should go - - No body are allowed when doing redirects. - + The socket. - + - The body stream is used to cache the body contents - before sending everything to the client. It's the simplest - way to serve documents. + Client may not be handled. - + - Defines the version of the HTTP Response for applications where it's required - for this to be forced. + Accepted socket. - + - 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. + Client should be revoked. - + + Class to handle loading of resource files + + - Kind of connection + Initializes a new instance of the class. - + - Encoding to use when sending stuff to the client. + Initializes a new instance of the class. - Default is UTF8 + logger. - + - Number of seconds to keep connection alive + Loads resources from a namespace in the given assembly to an URI - Only used if Connection property is set to ConnectionType.KeepAlive + 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 - + - Status code that is sent to the client. + Retrieves a stream for the specified resource path if loaded otherwise null - Default is HttpStatusCode.Ok + Path to the resource to retrieve a stream for + A stream or null if the resource couldn't be found - + - Information about why a specific status code was used. + Fetch all files from the resource that matches the specified arguments. + 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 - + - Size of the body. MUST be specified before sending the header, - unless property Chunked is set to true. + Fetch all files from the resource that matches the specified arguments. + Where the file should reside. + Files to check + + a list of files if found; or an empty array if no files are found. + - + - Kind of content in the body + Returns whether or not the loader has an instance of the file requested - Default is text/html + The name of the template/file + True if the loader can provide the file - + - Headers have been sent to the client- + - You can not send any additional headers if they have already been sent. + + + - + + Represents a field in a multipart form + + - The whole response have 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. - + - 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. - + - Initializes a new instance of the class. + Add a decoder. - Client that send the . - Contains information of what the client want to receive. - cannot be empty. + + - + - Initializes a new instance of the class. + Number of added decoders. - Client that send the . - Version of HTTP protocol that the client uses. - Type of HTTP connection used. - + - Add another header to the document. + Use with care. - 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. + Decoder used for unknown content types. - If content have already been sent. - + - Make sure that you have specified and sent the headers first. + Delegate used to find a realm/domain. - - 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. + + + + Realms are used during HTTP Authentication + + + - + - Make sure that you have specified and sent the headers first. + A complete HTTP server, you need to add a module to it to be able to handle incoming requests. - - 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. + + + // 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); + + + + + - + - Send headers to the client. + Initializes a new instance of the class. - If headers already been sent. - - - + Used to get all components used in the server.. - + - 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. - + - redirect to somewhere + Initializes a new instance of the class. - where the redirect should go - - No body are allowed when doing redirects. - + Form decoders are used to convert different types of posted data to the object types. + + - + - 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. + A session store is used to save and retrieve sessions + - + - 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. + Initializes a new instance of the class. + 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. + The log writer. + + + - + - Kind of connection + 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. + + + + - + - Encoding to use when sending stuff to the client. + Adds the specified rule. - Default is UTF8 + The rule. - + - Number of seconds to keep connection alive + Add a to the server. - Only used if Connection property is set to . + mode to add - + - Status code that is sent to the client. + Decodes the request body. - Default is + The request. + Failed to decode form data. - + - Information about why a specific status code was used. + 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. - + - Size of the body. MUST be specified before sending the header, - unless property Chunked is set to true. + 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. - + - Kind of content in the body + Realms are used by the s. - Default type is "text/html" + HTTP request + domain/realm. - + - Headers have been sent to the client- + Process an incoming request. - You can not send any additional headers if they have already been sent. + connection to client + request information + response that should be filled + session information - + - The whole response have been sent. + Can be overloaded to implement stuff when a client have been connected. + + Default implementation does nothing. + + client that disconnected + disconnect reason - + - Cookies that should be created/changed. + Handle authentication + + + + true if request can be handled; false if not. + Invalid authorization header - + - Contains server side HTTP request information. + Will request authentication. + + Sends respond to client, nothing else can be done with the response after this. + + + + - + - Chars used to split an URL path into multiple parts. + Received from a when a request have been parsed successfully. + that received the request. + The request. - + - Assign a form. + To be able to track request count. - + + - + - Creates a new object that is a copy of the current instance. + Start the web server using regular HTTP. - - - A new object that is a copy of this instance. - - 2 + 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. - + - Decode body into a form. + Accept secure connections. - A list with form decoders. - If body contents is not valid for the chosen decoder. - If body is still being transferred. + 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. - + - Cookies + shut down the server and listeners - the cookies - + - Create a response object. + write an entry to the log file - A new . + importance of the message + log message - + - Called during parsing of a . + write an entry to the log file - Name of the header, should not be URL encoded - Value of the header, should not be URL encoded - If a header is incorrect. + object that wrote the message + importance of the message + log message - + - Add bytes to the body + Server that is handling the current request. - 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. + + Will be set as soon as a request arrives to the object. + - + - Clear everything in the request + 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. - + - Gets or sets a value indicating whether this is secure. + Form decoder providers are used to decode request body (which normally contains form data). - + - Path and query (will be merged with the host header) and put in Uri + Server name sent in HTTP responses. - + + Do NOT include version in name, since it makes it + easier for hackers. + - + - Gets whether the body is complete. + Name of cookie where session id is stored. - + - Gets kind of types accepted by the client. + Specified where logging should go. + + + - + - Gets or sets body stream. + Number of connections that can wait to be accepted by the server. + Default is 10. - + - Gets or sets kind of connection used for the session. + 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. + + - + - Gets or sets number of bytes in the body. + Gets or sets maximum number of requests queuing to be handled. + + + 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. + + - + - Gets headers sent by the client. + Realms are used during HTTP authentication. + Default realm is same as server name. - + - Gets or sets version of HTTP protocol that's used. + Let's to receive unhandled exceptions from the threads. - Probably or . + Exceptions will be thrown during debug mode if this event is not used, + exceptions will be printed to console and suppressed during release mode. - - + - Gets or sets requested method. + - - Will always be in upper case. + http://www.faqs.org/rfcs/rfc1867.html - - + - Gets variables sent in the query string + multipart/form-data - + - Gets or sets requested URI. + form-data - + - 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. - - + 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 - + - Gets parameter from or . + 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 - + - Gets form parameters. + Add a component instance + Interface type + Instance to add - + - Gets whether the request was made by Ajax (Asynchronous JavaScript) + Get a component. + Interface type + Component if registered, otherwise null. + + Component will get created if needed. + - + + If instance cannot be created. + + - Gets cookies that was sent with the request. + Checks if the specified component interface have been added. + + true if found; otherwise false. - - Class to handle loading of resource files + + + Add a component. + + Type being requested. + Type being created. + Type have already been mapped. - + - Initializes a new instance of the class. + The purpose of this module is to serve files. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - logger. + 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 - + - Loads resources from a namespace in the given assembly to an URI + Initializes a new instance of the class. - 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 + Uri to serve, for instance "/files/" + Path on hard drive where we should start looking for files - + + + Mimtypes that this class can handle per default + + + - Retrieves a stream for the specified resource path if loaded otherwise null + Determines if the request should be handled by this module. + Invoked by the - Path to the resource to retrieve a stream for - A stream or null if the resource couldn't be found + + true if this module should handle it. - + + Illegal path + + - Fetch all files from the resource that matches the specified arguments. + check if source contains any of the chars. - 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. + Method that process the Uri. - Where the file should reside. - Files to check - - a list of files if found; or an empty array if no files are found. - + 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. - + - Returns whether or not the loader has an instance of the file requested + return a file extension from an absolute Uri path (or plain filename) - The name of the template/file - True if the loader can provide the file + + - + - Will contain helper functions for javascript. + List with all mime-type that are allowed. + All other mime types will result in a Forbidden http status code. - + - Requests a url through ajax + characters that may not exist in a path. - 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>"; - + fileMod.ForbiddenChars = new string[]{ "\\", "..", ":" }; - + - Ajax requests that updates an element with - the fetched content + Contains a listener that doesn't do anything with the connections. - 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. + Listen for regular HTTP connections - url to contents of dialog - link title - name, value, name, value, all parameter names should end with colon. + 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. - + - Close a javascript dialog window/div. + Initializes a new instance of the class. - javascript for closing a dialog. - + IP Address to accept connections on + TCP Port to listen on, default HTTPS port is 443 + Factory used to create es. + Certificate to use - + - This provider is used to let us implement any type of form decoding we want without - having to rewrite anything else in the server. + 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. - + + Exception. + + - + Will try to accept connections one more time. - 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. + If any exceptions is thrown. - + - Add a decoder. + Can be used to create filtering of new connections. - - + Accepted socket + true if connection can be accepted; otherwise false. - + - Number of added decoders. + Start listen for new connections + Number of connections that can stand in a queue to be accepted. + Listener have already been started. - + - Use with care. + Stop the listener + - + - Decoder used for unknown content types. + Gives you a change to receive log entries for all internals of the HTTP library. + + You may not switch log writer after starting the listener. + - + - Type of HTTP connection + True if we should turn on trace logs. - + - Connection is closed after each request-response + 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. + - + - Connection is kept alive for X seconds (unless another request have been made) + A request have been received from a . - + - 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 + Container class for posted files - - // becomes: - Console.WriteLine("Value: {0}", form["user"]["FirstName"].Value); - - - All names in a form SHOULD be in lowercase. - - - Representation of a non-initialized . + + + 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 - + - Initializes an input item setting its name/identifier and value + Creates a container for a posted file - Parameter name/id - Parameter value + If any parameter is null or empty - - 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 + + Destructor disposing the file - + - Add another value to this item + Deletes the temporary file - Value to add. - Cannot add stuff to . + True if manual dispose - + - checks if a sub-item exists (and has a value). + Disposing interface, cleans up managed resources (the temporary file) and suppresses finalization - 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 + + + The name/id of the file + - + - Outputs the string in a formatted manner + The full file path - A prefix to append, used internally - produce a query string - + - Add a sub item. + The name of the uploaded file - Can contain array formatting, the item is then parsed and added in multiple levels - Value to add. - Argument is null. - Cannot add stuff to . - + - Returns an enumerator that iterates through the collection. + The type of file - - - A that can be used to iterate through the collection. - - 1 - + + + Implements HTTP Digest authentication. It's more secure than Basic auth since password is + encrypted with a "key" from the server. + + + Keep in mind that the password is encrypted with MD5. Use a combination of SSL and digest auth to be secure. + + + - Returns an enumerator that iterates through a collection. + Initializes a new instance of the class. - - - An object that can be used to iterate through the collection. - - 2 + Delegate used to provide information used during authentication. + Delegate used to determine if authentication is required (may be null). - + - Outputs the string in a formatted manner + Initializes a new instance of the class. - A prefix to append, used internally - + Delegate used to provide information used during authentication. - + - Number of values + Used by test classes to be able to use hardcoded values - + - Get a sub item + An authentication response have been received from the web browser. + Check if it's correct - name in lower case. - if no item was found. + 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. - + - Name of item (in lower case). + Encrypts parameters into a Digest string + 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 - + - Returns the first value, or null if no value exist. + + 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 + - + - Returns the last value, or null if no value exist. + Create a response that can be sent in the WWW-Authenticate header. + 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. - + - Returns the list with values. + 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. - + - + Gets the current nonce. - name in lower case - + - Session store using memory for each session. + Gets the Md5 hash bin hex2. + To be hashed. + - + - Initializes the class setting the expirationtimer to clean the session every minute + determines if the nonce is valid or has expired. + nonce value (check wikipedia for info) + true if the nonce has not expired. - + - Delegate for the cleanup timer + name used in http request. - + - Creates a new http session + Gets or sets whether the token supplied in is a + HA1 generated string. - - + - Creates a new http session with a specific id + Current state in the parsing. - Id used to identify the new cookie.. - A object. - - Id should be generated by the store implementation if it's null or . - - + - Load an existing session. + Should parse the request line - - - + - Save an updated session to the store. + Searching for a complete header name - - + - We use the flyweight pattern which reuses small objects - instead of creating new each time. + Searching for colon after header name (ignoring white spaces) - EmptyLanguageNode (unused) session that should be reused next time Create is called. - + - Remove expired sessions + Searching for start of header value (ignoring white spaces) - + - Remove a session + Searching for a complete header value (can span over multiple lines, as long as they are prefixed with one/more whitespaces) - id of the session. - + - Load a session from the store + Adding bytes to body - - null if session is not found. - + - Number of minutes before a session expires. - Default is 20 minutes. + 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. + + [a-z0-9]+)", "/users/${target}?find=true", RegexOptions.IgnoreCase) + ]]> + - + - redirects from one URL to another. + Initializes a new instance of the class. + 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. + Initializes a new instance of the class. - Absolute path (no server name) - Absolute path (no server name) + Expression to match URL + Expression to generate URL + Regular expression options to use, can be null - server.Add(new RedirectRule("/", "/user/index")); + [a-zA-Z0-9]+)", "/user/{first}", RegexOptions.IgnoreCase)); + Result of ie. /employee1 will then be /user/employee1 + ]]> - + - Initializes a new instance of the class. + 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. + 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. - server.Add(new RedirectRule("/", "/user/index")); + [a-zA-Z0-9]+)", "/user/${first}", RegexOptions.None)); + Result of ie. /employee1 will then be /user/employee1 + ]]> + Argument is null. + - + Process the incoming request. @@ -4045,27 +3948,63 @@ returning true means that no modules will get the request. Returning true is typically being done for redirects. + If request or response is null - + - Gets string to match request URI with. + 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 - Is compared to request.Uri.AbsolutePath - + - Gets where to redirect. + Let's copy all the cookies. + + value from cookie header. + + + + Adds a cookie in the collection. + + cookie to add + cookie is null + + + + Gets a collection enumerator on the cookie list. + + collection enumerator + + + + Remove all cookies. + + + + + Returns an enumerator that iterates through the collection. + + + + A that can be used to iterate through the collection. + + 1 + + + + Remove a cookie from the collection. + + Name of cookie. + + + + Gets the count of cookies in the collection. - + - Gets whether server should redirect client. + Gets the cookie of a given identifier (null if not existing). - - 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. - @@ -4100,1357 +4039,1418 @@ Gets or sets offset in buffer where to start processing. - + - The website module let's you handle multiple websites in the same server. - It uses the "Host" header to check which site you want. + Returns item either from a form or a query string (checks them in that order) - 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. - - - - - domain name that should be handled. - + + Representation of a non-initialized HttpParam - - - 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 + + Initialises the class to hold a value either from a post request or a querystring request - + - Name of site. + The add method is not availible for HttpParam + since HttpParam checks both Request.Form and Request.QueryString + name identifying the value + value to add + - + - Helpers making it easier to work with forms. + Checks whether the form or querystring has the specified value - + Name, case sensitive + true if found; otherwise false. - + - Used to let the website use different JavaScript libraries. - Default is + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + 1 - + - Create a <form> tag. + Returns an enumerator that iterates through a collection. - 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 + + An object that can be used to iterate through the collection. + + 2 - + - Creates a select list with the values in a collection. + Fetch an item from the form or querystring (in that order). - 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. - + + Item if found; otherwise HttpInputItem.EmptyLanguageNode - + - Creates a select list with the values in 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. - 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. + Class that the exception was thrown in. + Exception + + Server will throw a InternalServerException in release version if you dont + handle this delegate. + - + - Creates a select list with the values in a collection. + Delegate used to let authentication modules authenticate the user name and password. - 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. + 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); + + - + - Generate a list of HTML options + Let's you decide on a system level if authentication is required. - 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. + HTTP request from client + true if user should be authenticated. + throw if no more attempts are allowed. + If no more attempts are allowed - - sb is null. + + + New implementation of the HTTP listener. + + + Use the Create methods to create a default listener. + - + - Creates a check box. + Initializes a new instance of the class. - 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 + 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. - + - Creates a check box. + Initializes a new instance of the class. - 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) - + The address. + The port. + The factory. + The certificate. - + - Creates a check box. + Initializes a new instance of the class. - 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". + The address. + The port. + The factory. + The certificate. + The protocol. - + - Creates a RadioButton. + Creates a new instance with default factories. - 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 + Address that the listener should accept connections on. + Port that listener should accept connections on. + Created HTTP listener. - + - Creates a RadioButton. + Creates a new instance with default factories. - 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 + Address that the listener should accept connections on. + Port that listener should accept connections on. + Certificate to use + Created HTTP listener. - + - form close tag + 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 + which HTTPS protocol to use, default is TLS. + Created HTTP listener. - + - The server understood the request, but is refusing to fulfill it. - Authorization will not help and the request SHOULD NOT be repeated. - If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, - it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information - available to the client, the status code 404 (Not Found) can be used instead. - - Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php + Can be used to create filtering of new connections. + Accepted socket + + true if connection can be accepted; otherwise false. + - + - Initializes a new instance of the class. + A client have been accepted, but not handled, by the listener. - error message - + - Lists content type mime types. + Webhelper provides helpers for common tasks in HTML. - + - text/plain + Used to let the website use different javascript libraries. + Default is - + - text/haml + 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');"); + - + - content type for javascript documents = application/javascript + Builds a link that updates an element with the fetched ajax content. - - - 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/ - + 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. - + - text/xml + A link that pop ups a Dialog (overlay div) + + 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!');"); + + + + + Create/Open a dialog box using ajax + + + + - + - A list of content types + Close a javascript dialog window/div. + javascript for closing a dialog. + - + - + Create a <form> tag. - Semicolon separated content types. + name of form + action to invoke on submit + form should be posted as ajax + html code + + WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); + - + - Returns an enumerator that iterates through a collection. + Create a link tag. - - An object that can be used to iterate through the collection. - + 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?');"); + - + - Searches for the specified type + Build a link - Can also be a part of a type (searching for "xml" would return true for "application/xml"). - true if type was found. + url to go to. + title of link (displayed text) + extra html attributes. + a complete link - + - Get this first content type. + Build a link + url to go to. + title of link (displayed text) + extra html attributes. + a complete link + more options - + - Fetch a content type + Obsolete - Part of type ("xml" would return "application/xml") - - All content types are in lower case. + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete - + - 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. + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete + Obsolete - + - + Render errors into a UL with class "errors" - 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/"); - + class used by UL-tag. + items to list + an unordered html list. - + - Method that determines if an url should be handled or not by the module + Render errors into a UL with class "errors" - Url requested by the client. - true if module should handle the url. + class used by UL-tag. + items to list + an unordered html list. - + - Method that process the url + Render errors into a UL with class "errors" - Information sent by the browser about the request - Information that is being sent back to the client. - Session used to + + - + - Contains a connection to a browser/client. + Generates a list with html attributes. - - Remember to after you have hooked the event. - - TODO: Maybe this class should be broken up into HttpClientChannel and HttpClientContext? + StringBuilder that the options should be added to. + attributes set by user. + attributes set by any of the helper classes. - + - Initializes a new instance of the class. + Generates a list with html attributes. - 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 1024 bytes. - If fails - Stream must be writable and readable. + StringBuilder that the options should be added to. + - + - Process incoming body bytes. + cookie being sent back to the browser. - - Bytes + - + - + Constructor. - - + cookie identifier + cookie content + cookie expiration date. Use DateTime.MinValue for session cookie. + id or content is null + id is empty - + - Start reading content. + Create a new cookie - - Make sure to call base.Start() if you override this method. - + 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. - + - Clean up context. + Create a new cookie - - Make sure to call base.Cleanup() if you override the method. - + Name and value will be used + when the cookie expires. - + - Disconnect from client + Gets the cookie HTML representation. - error to report in the event. - - - BadRequestException. + cookie string - + - Send a response. + When the cookie expires. + DateTime.MinValue means that the cookie expires when the session do so. - 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. + Cookie is only valid under this path. - Either or - HTTP status code - reason for the status code. - + - Send a response. + Contains server side HTTP request information. - - + - send a whole buffer + Called during parsing of a . - buffer to send - + Name of the header, should not be URL encoded + Value of the header, should not be URL encoded + If a header is incorrect. - + - Send data using the stream + Add bytes to the body - Contains data to send - Start position in buffer - number of bytes to send - - + 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. - + - This context have been cleaned, which means that it can be reused. + Clear everything in the request - + - Context have been started (a new client have connected) + 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. - + - Overload to specify own type. + Sets the cookies. - - Must be specified before the context is being used. - + The cookies. - + - Using SSL or other encryption method. + Create a response object. + Context for the connected client. + A new . - + - Using SSL or other encryption method. + Gets kind of types accepted by the client. - + - Specify which logger to use. + Gets or sets body stream. - + - Gets or sets the network stream. + Gets whether the body is complete. - + - Gets or sets IP address that the client connected from. + Gets or sets kind of connection used for the session. - + - Gets or sets port that the client connected from. + Gets or sets number of bytes in the body. - + - The context have been disconnected. + Gets cookies that was sent with the request. - - Event can be used to clean up a context, or to reuse it. - - + - A request have been received in the context. + Gets form parameters. - + - Helpers to make XML handling easier + Gets headers sent by the client. - + - Serializes object to XML. + Gets or sets version of HTTP protocol that's used. - object to serialize. - XML - Removes name spaces and adds indentation + Probably or . + - - - Create an object from a XML string - - Type of object - XML string - object - - + - 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. + Gets whether the request was made by Ajax (Asynchronous JavaScript) - - [a-z0-9]+)", "/users/${target}?find=true", RegexOptions.IgnoreCase) - ]]> - - + - Initializes a new instance of the class. + Gets or sets requested method. - Expression to match URL - Expression to generate URL - - [a-zA-Z0-9]+)", "/user/${first}")); - Result of ie. /employee1 will then be /user/employee1 - ]]> - + + Will always be in upper case. + + - + - Initializes a new instance of the class. + Gets parameter from or . - 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 - ]]> - - + - Initializes a new instance of the class. + Gets variables sent in the query string - 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. + Gets or sets requested URI. - 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 - + - Parses a HTTP request directly from a stream + 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. + + - + - Create a new request parser + Gets or sets path and query. - delegate receiving log entries. + + + Are only used during request parsing. Cannot be set after "Host" header have been + added. + - + - Add a number of bytes to the body + Delegate used by to populate select options. - buffer containing more body bytes. - starting offset in buffer - number of bytes, from offset, to read. - offset to continue from. + 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; + } /// - + - Remove all state information for the request. + 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) - + - Parse request line + Create a new unauhtorized exception. - - If line is incorrect - Expects the following format: "Method SP Request-URI SP HTTP-Version CRLF" + - + - We've parsed a new header. + Create a new unauhtorized exception. - Name in lower case - Value, unmodified. - If content length cannot be parsed. + reason to why the request was unauthorized. + inner exception - + - Parse a message + Create a new unauhtorized exception. - bytes to parse. - where in buffer that parsing should start - number of bytes to parse, starting on . - offset (where to start parsing next). - BadRequestException. + reason to why the request was unauthorized. - + - Gets or sets the log writer. + The requested resource was not found in the web server. - + - Current state in parser. + Create a new exception + message describing the error + inner exception - + - A request have been successfully parsed. + Create a new exception + message describing the error - + - More body bytes have been received. + Type of HTTP connection - + - Request line have been received. + Connection is closed after each request-response - + - A header have been received. + Connection is kept alive for X seconds (unless another request have been made) - + - Priority for log entries + A have been disconnected. - - + - Very detailed logs to be able to follow the flow of the program. + Initializes a new instance of the class. + Reason to disconnection. - + - Logs to help debug errors in the application + Gets reason to why client disconnected. - + - Information to be able to keep track of state changes etc. + - + - Something did not go as we expected, but it's no problem. + Initializes a new instance of the class. + The request. - + - Something that should not fail failed, but we can still keep - on going. + Gets received request. - + - Something failed, and we cannot handle it properly. + Contains server side HTTP request information. - + - Interface used to write to log files. + Chars used to split an URL path into multiple parts. - + - Write an entry to the log file. + Assign a form. - 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) + Creates a new object that is a copy of the current instance. - + + + A new object that is a copy of this instance. + + 2 - + - The actual instance of this class. + 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. - + - Logwriters the specified source. + Cookies - object that wrote the logentry. - Importance of the log message - The message. + the cookies - + - Get color for the specified logprio + Create a response object. - prio for the log entry - A for the prio + A new . - + - Default log writer, writes everything to null (nowhere). + 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. - + - The logging instance. + 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. - + - Writes everything to null + Clear everything in the request - object that wrote the log entry. - Importance of the log message - The message. - + - Returns item either from a form or a query string (checks them in that order) + Gets or sets a value indicating whether this is secure. - - 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 + Path and query (will be merged with the host header) and put in Uri - name identifying the value - value to add - + - + - Checks whether the form or querystring has the specified value + Gets whether the body is complete. - Name, case sensitive - true if found; otherwise false. - + - Returns an enumerator that iterates through the collection. + Gets kind of types accepted by the client. - - - A that can be used to iterate through the collection. - - 1 - + - Returns an enumerator that iterates through a collection. + Gets or sets body stream. - - - An object that can be used to iterate through the collection. - - 2 - + - Fetch an item from the form or querystring (in that order). + Gets or sets kind of connection used for the session. - - Item if found; otherwise HttpInputItem.EmptyLanguageNode - + - Container class for posted files + Gets or sets number of bytes in the body. - + - Creates a container for a posted file + Gets headers sent by the client. - 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 + Gets or sets version of HTTP protocol that's used. - If any parameter is null or empty - - - Destructor disposing the file + + Probably or . + + - + - Deletes the temporary file + Gets or sets requested method. - True if manual dispose + + + Will always be in upper case. + + - + - Disposing interface, cleans up managed resources (the temporary file) and suppresses finalization + Gets variables sent in the query string - + - The name/id of the file + Gets or sets requested URI. - + - The full file path + 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. + + - + - The name of the uploaded file + Gets parameter from or . - + - The type of file + Gets form parameters. - + - Used to create and reuse contexts. + Gets whether the request was made by Ajax (Asynchronous JavaScript) - + - Used to create es. + Gets cookies that was sent with the request. - + - Creates a that handles a connected client. + 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 - Client socket (accepted by the ). - A creates . + + // becomes: + Console.WriteLine("Value: {0}", form["user"]["FirstName"].Value); + + + All names in a form SHOULD be in lowercase. + - + + Representation of a non-initialized . + + - Create a secure . + Initializes an input item setting its name/identifier and value - Client socket (accepted by the ). - HTTPS certificate to use. - Kind of HTTPS protocol. Usually TLS or SSL. - A created . + 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 + + - A request have been received from one of the contexts. + Add another value to this item + Value to add. + Cannot add stuff to . - + - Initializes a new instance of the class. + checks if a sub-item exists (and has a value). - The writer. - Amount of bytes to read from the incoming socket stream. - Used to create a request parser. + 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 + + - Create a new context. + Outputs the string in a formatted manner - true if socket is running HTTPS. - Client that connected - Network/SSL stream. - A context. + A prefix to append, used internally + produce a query string - + - Create a new context. + Add a sub item. - true if HTTPS is used. - Remote client - Network stream, uses . - A new context (always). + Can contain array formatting, the item is then parsed and added in multiple levels + Value to add. + Argument is null. + Cannot add stuff to . - + - Create a secure . + Returns an enumerator that iterates through the collection. - Client socket (accepted by the ). - HTTPS certificate to use. - Kind of HTTPS protocol. Usually TLS or SSL. + - A created . + A that can be used to iterate through the collection. + 1 - + - Creates a that handles a connected client. + Returns an enumerator that iterates through a collection. - Client socket (accepted by the ). + - A creates . + An object that can be used to iterate through the collection. + 2 - - - True if detailed trace logs should be written. - - - + - A request have been received from one of the contexts. + Outputs the string in a formatted manner + A prefix to append, used internally + - + - Custom network stream to mark sockets as reusable when disposing the stream. + Number of values - + - Creates a new instance of the class for the specified . + Get a sub item - - 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. - + name in lower case. + if no item was found. - + - Initializes a new instance of the class for the specified with the specified ownership. + Name of item (in lower case). - - 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. + Returns the first value, or null if no value exist. - - 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. + Returns the last value, or null if no value exist. - - 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. + Returns the list with values. - + - 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. + name in lower case + - + - + Generic helper functions for HTTP - - http://www.faqs.org/rfcs/rfc1867.html - - + - multipart/form-data + Version string for HTTP v1.0 - + - form-data + Version string for HTTP v1.1 - + - + An empty URI - 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 + Parses a query string. - 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 + Query string (URI encoded) + A object if successful; otherwise + queryString is null. + If string cannot be parsed. - + - A session stored in memory. + Used when the request line have been successfully parsed. - + - + Initializes a new instance of the class. - A unique id used by the sessions store to identify the session + The HTTP method. + The URI path. + The HTTP version. - + - Id + Initializes a new instance of the class. - - + - Remove everything from the session + Gets or sets http method. + + Should be one of the methods declared in . + - + - Clears the specified expire. + Gets or sets the version of the HTTP protocol that the client want to use. - True if the session is cleared due to expiration - + - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + Gets or sets requested URI path. - 2 - + - Session id + Contains all HTTP Methods (according to the HTTP 1.1 specification) + + See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html + - + - Should + The DELETE method requests that the origin server delete the resource identified by the Request-URI. - Name of the session variable - null if it's not set + + + 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. + + - + - when the session was last accessed. + The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. - Used to determine when the session should be removed. + + 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. + - + - Number of values in the session + 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. + - + - Flag to indicate that the session have been changed - and should be saved into the session store. + 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. + - + - Event triggered upon clearing the session + 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. + + 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. + + - + - Cookies that should be set. + 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. + + - + - Adds a cookie in the collection. + The TRACE method is used to invoke a remote, application-layer loop- back of the request message. - cookie to add - cookie is null - + - Copy a request cookie + Contains all HTTP Methods (according to the HTTP 1.1 specification) + + See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html + - - When the cookie should expire - + - Gets a collection enumerator on the cookie list. + The DELETE method requests that the origin server delete the resource identified by the Request-URI. - collection enumerator + + + 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. + + - + - Remove all cookies + 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. + + - + - Returns an enumerator that iterates through the collection. + 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. - - A that can be used to iterate through the collection. - - 1 - - - - Gets the count of cookies in the collection. - + This method is often used for testing hypertext links for validity, accessibility, and recent modification. + - + - Gets the cookie of a given identifier (null if not existing). + 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 request parsers when needed. + 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. + + 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. + + - + - Creates request parsers when needed. + 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. + + - + - Create a new request parser. + The TRACE method is used to invoke a remote, application-layer loop- back of the request message. - Used when logging should be enabled. - A new request parser. - + - Create a new request parser. + Serves files that are stored in embedded resources. - Used when logging should be enabled. - A new request parser. - + - Add a component instance + 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. - Interface type - Instance to add - + - Get a component. + 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. - Interface type - Component if registered, otherwise null. - - Component will get created if needed. - - - - If instance cannot be created. + The log writer to use when logging events - + - Checks if the specified component interface have been added. + Mimtypes that this class can handle per default - - true if found; otherwise false. - + - Add a component. + Loads resources from a namespace in the given assembly to an uri - Type being requested. - Type being created. - Type have already been mapped. - - - - 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 + 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"); - (description is taken from - http://www.submissionchamber.com/help-guides/error-codes.php#sec10.4.2) - + 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 - + - Create a new unauhtorized exception. + Returns true if the module can handle the request - - + - Create a new unauhtorized exception. + Method that process the url - reason to why the request was unauthorized. - inner exception + 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. - + - Create a new unauhtorized exception. + List with all mime-type that are allowed. - reason to why the request was unauthorized. + All other mime types will result in a Forbidden http status code. -- cgit v1.1