Automated session management

When parsing a request, this module associate a pre-existing session to the request if there is one. It will also send the required cookie with the response if a session has been associated to the response object.

Introduced classes

class Session

nitcorn :: Session

A server side session

Redefined classes

redef class HttpRequest

nitcorn :: sessions $ HttpRequest

A request received over HTTP, is build by HttpRequestParser
redef class HttpRequestParser

nitcorn :: sessions $ HttpRequestParser

Utility class to parse a request string and build a HttpRequest
redef class HttpResponse

nitcorn :: sessions $ HttpResponse

A response to send over HTTP
redef class Sys

nitcorn :: sessions $ Sys

The main class of the program.

All class definitions

redef class HttpRequest

nitcorn :: sessions $ HttpRequest

A request received over HTTP, is build by HttpRequestParser
redef class HttpRequestParser

nitcorn :: sessions $ HttpRequestParser

Utility class to parse a request string and build a HttpRequest
redef class HttpResponse

nitcorn :: sessions $ HttpResponse

A response to send over HTTP
class Session

nitcorn $ Session

A server side session
redef class Sys

nitcorn :: sessions $ Sys

The main class of the program.
package_diagram nitcorn::sessions sessions md5 md5 nitcorn::sessions->md5 nitcorn::server_config server_config nitcorn::sessions->nitcorn::server_config nitcorn::http_request http_request nitcorn::sessions->nitcorn::http_request nitcorn::http_response http_response nitcorn::sessions->nitcorn::http_response nitcorn::token token nitcorn::sessions->nitcorn::token core core md5->core nitcorn::server_config->core serialization serialization nitcorn::http_request->serialization nitcorn::http_response->serialization template template nitcorn::http_response->template base64 base64 nitcorn::token->base64 ...core ... ...core->core ...serialization ... ...serialization->serialization ...template ... ...template->template ...base64 ... ...base64->base64 nitcorn::file_server file_server nitcorn::file_server->nitcorn::sessions nitcorn::nitcorn nitcorn nitcorn::nitcorn->nitcorn::file_server nitcorn::nitcorn... ... nitcorn::nitcorn...->nitcorn::nitcorn

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.
module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters
module array

core :: array

This module introduces the standard array structure.
module base64

base64 :: base64

Offers the base 64 encoding and decoding algorithms
module bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
module caching

serialization :: caching

Services for caching serialization engines
module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.
module codec_base

core :: codec_base

Base for codecs to use with streams
module codecs

core :: codecs

Group module for all codec-related manipulations
module collection

core :: collection

This module define several collection classes.
module core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
module engine_tools

serialization :: engine_tools

Advanced services for serialization engines
module environ

core :: environ

Access to the environment variables of the process
module error

core :: error

Standard error-management infrastructure.
module exec

core :: exec

Invocation and management of operating system sub-processes.
module file

core :: file

File manipulations (create, read, write, etc.)
module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision
module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints
module flat

core :: flat

All the array-based text representations
module gc

core :: gc

Access to the Nit internal garbage collection mechanism
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module list

core :: list

This module handle double linked lists
module math

core :: math

Mathematical operations
module meta

meta :: meta

Simple user-defined meta-level to manipulate types of instances as object.
module native

core :: native

Native structures for text and bytes
module numeric

core :: numeric

Advanced services for Numeric types
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module re

core :: re

Regular expression support for all services based on Pattern
module ropes

core :: ropes

Tree-based representation of a String.
module serialization

serialization :: serialization

General serialization services
module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats
module sorter

core :: sorter

This module contains classes used to compare things and sorts arrays.
module stream

core :: stream

Input and output streams of characters
module template

template :: template

Basic template system
module text

core :: text

All the classes and methods related to the manipulation of text entities
module time

core :: time

Management of time and dates
module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure
module utf8

core :: utf8

Codec for UTF-8 I/O

Parents

module http_request

nitcorn :: http_request

Provides the HttpRequest class and services to create it
module http_response

nitcorn :: http_response

Provides the HttpResponse class and http_status_codes
module md5

md5 :: md5

Native MD5 digest implementation as Text::md5
module server_config

nitcorn :: server_config

Classes and services to configure the server
module token

nitcorn :: token

Simple generate_token service, independent of the rest of the nitcorn framework

Children

module file_server

nitcorn :: file_server

Provides the FileServer action, which is a standard and minimal file server

Descendants

module a_star-m

a_star-m

module api

nitc :: api

Components required to build a web server about the nit model.
module api_auth

nitc :: api_auth

module api_base

nitc :: api_base

Base classes used by nitweb.
module api_docdown

nitc :: api_docdown

Nitdoc specific Markdown format handling for Nitweb
module api_feedback

nitc :: api_feedback

Feedback related features
module api_light

nitc :: api_light

Highlight and collect messages from a piece of code
module api_model

nitc :: api_model

module example_angular

popcorn :: example_angular

This is an example of how to use angular.js with popcorn
module hooks

github :: hooks

Github hook event listening with nitcorn.
module htcpcp_server

nitcorn :: htcpcp_server

A server that implements HTCPCP. At the moment there are no additions.
module loader

github :: loader

module nitcorn

nitcorn :: nitcorn

The nitcorn Web server framework creates server-side Web apps in Nit
module nitcorn_hello_world

nitcorn :: nitcorn_hello_world

Hello World Web server example
module nitweb

nitc :: nitweb

Runs a webserver based on nitcorn that render things from model.
module pop_auth

popcorn :: pop_auth

Authentification handlers.
module pop_handlers

popcorn :: pop_handlers

Route handlers.
module pop_json

popcorn :: pop_json

Introduce useful services for JSON REST API handlers.
module pop_routes

popcorn :: pop_routes

Internal routes representation.
module pop_sessions

popcorn :: pop_sessions

Session handlers
module pop_tasks

popcorn :: pop_tasks

Popcorn threaded tasks
module pop_templates

popcorn :: pop_templates

Template rendering for popcorn
module pop_tests

popcorn :: pop_tests

Popcorn testing services
module popcorn

popcorn :: popcorn

Application server abstraction on top of nitcorn.
module pthreads

nitcorn :: pthreads

Activate the use of pthreads with nitcorn
module restful

nitcorn :: restful

Support module for the nitrestful tool and the restful annotation
module restful_annot

nitcorn :: restful_annot

Example for the restful annotation documented at lib/nitcorn/restful.nit
module simple_file_server

nitcorn :: simple_file_server

Basic file server on port 80 by default, may require root to execute
# Automated session management
#
# When parsing a request, this module associate a pre-existing session
# to the request if there is one. It will also send the required cookie
# with the response if a session has been associated to the response object.
module sessions

import md5

import server_config
import http_request
import http_response
import token

# A server side session
class Session

	# Hashed id used both client and server side to identify this `Session`
	var id_hash: String is noinit

	init
	do
		loop
			var token = generate_token
			if sys.sessions.keys.has(token) then continue

			sys.sessions[token] = self
			self.id_hash = token
			break
		end
	end
end

redef class Sys
	# Active sessions
	var sessions = new HashMap[String, Session]
end

redef class HttpResponse
	# A `Session` to associate with a response
	var session: nullable Session = null is writable

	redef fun finalize
	do
		super

		var session = self.session
		if session != null then
			header["Set-Cookie"] = "nitcorn_session={session.id_hash}; HttpOnly"
		else
			# Make sure there are no cookie left client side
			header["Set-Cookie"] = "nitcorn_session=; HttpOnly; expires=Thu, 01 Jan 1970 00:00:00 GMT"
		end
	end
end

redef class HttpRequest
	# The `Session` associated to this request
	var session: nullable Session = null is writable
end

redef class HttpRequestParser
	redef fun parse_http_request(text)
	do
		var request = super
		if request != null then
			if request.cookie.keys.has("nitcorn_session") then
				var id_hash = request.cookie["nitcorn_session"]

				if sys.sessions.keys.has(id_hash) then
					# Restore the session
					request.session = sys.sessions[id_hash]
				end
			end
		end
		return request
	end
end
lib/nitcorn/sessions.nit:17,1--94,3