2012-03-16
While hacking on MuttonChop, It was necessary to create an HTTP server to handle requests from the Web client. Since the server could be quite useful for various other projects, I though it would be a good idea to take out the MuttonChop specific code and share the Server as a building block for future projects.
Originally, the server was going to use libsoup, an HTTP client/server library, for all of my HTTP serving needs but I couldn't get libsoup to create Server Sent Events so I instead opted to use GIO for low level socket communication and I had to roll my own server.
Enter the Vala
/* A Little Vala Server
* copyright 2012 Jezra Lickter
* Licensed GPLv3
*
* save as "valaserver.vala" and compile with
* valac --pkg gio-2.0 valaserver.vala
*
*/
using GLib;
//what port are we serving on?
const uint16 PORT = 8787;
namespace StatusCode {
const string FILE_NOT_FOUND = "HTTP/1.1 404 Not Found\n";
const string OK = "HTTP/1.1 200 OK\n";
const string ERROR = "HTTP/1.1 500 Internal Server Error\n";
}
struct Request {
string full_request;
string path;
string query;
HashTable<string, string> args;
string object;
string action;
string val;
}
struct Response {
string status_code;
string content_type;
string text;
uint8[] data;
}
public class WebServer {
private ThreadedSocketService tss;
private string public_dir;
private Regex ext_reg;
public WebServer() {
public_dir="public";
try {
ext_reg = new Regex("\\.(?<ext>[a-z]{2,4})$");
} catch(Error e) {
stderr.printf(e.message+"\n");
}
//make the threaded socket service with hella possible threads
tss = new ThreadedSocketService(150);
//create an IPV4 InetAddress bound to no specific IP address
InetAddress ia = new InetAddress.any(SocketFamily.IPV4);
//create a socket address based on the netadress and set the port
InetSocketAddress isa = new InetSocketAddress(ia, PORT);
//try to add the address to the ThreadedSocketService
try {
tss.add_address(isa, SocketType.STREAM, SocketProtocol.TCP, null, null);
} catch(Error e) {
stderr.printf(e.message+"\n");
return;
}
/* connect the 'run' signal that is emitted when
* there is a connection to our connection handler
*/
tss.run.connect( connection_handler );
}
public void run() {
//we need a gobject main loop
MainLoop ml = new MainLoop();
//start listening
tss.start();
stdout.printf(@"Serving on port $PORT\n");
//run the main loop
ml.run();
}
//when a request is made, handle the socket connection
private bool connection_handler(SocketConnection connection) {
string first_line ="";
size_t size = 0;
Request request = Request();
//get data input and output streams for the connection
DataInputStream dis = new DataInputStream(connection.input_stream);
DataOutputStream dos = new DataOutputStream(connection.output_stream);
//read the first line from the input stream
try {
first_line = dis.read_line( out size );
request = get_request( first_line );
} catch (Error e) {
stderr.printf(e.message+"\n");
}
//build a response based on the request
Response response = Response();
response = get_file_response(request);
serve_response( response, dos );
return false;
}
private void serve_response(Response response, DataOutputStream dos) {
try {
var data = response.data ?? response.text.data;
dos.put_string(response.status_code);
dos.put_string("Server: ValaSocket\n");
dos.put_string("Content-Type: %s\n".printf(response.content_type));
dos.put_string("Content-Length: %d\n".printf(data.length));
dos.put_string("\n");//this is the end of the return headers
/* For long string writes, a loop should be used,
* because sometimes not all data can be written in one run
* see http://live.gnome.org/Vala/GIOSamples#Writing_Data
*/
long written = 0;
while (written < data.length) {
// sum of the bytes of 'text' that already have been written to the stream
written += dos.write (data[written:data.length]);
}
} catch( Error e ) {
stderr.printf(e.message+"\n");
}
}
private Response get_file_response(Request request) {
//default request.path = index.htm
string request_path = (request.path=="/") ? "index.htm" : request.path;
string filepath= Path.build_filename(public_dir, request_path);
Response response = Response();
response.content_type = "text/plain";
response.status_code = StatusCode.ERROR;
//does the file exist?
if (FileUtils.test(filepath, GLib.FileTest.IS_REGULAR) ) {
//serve the file
bool read_failed = true;
uint8[] data = {};
try {
FileUtils.get_data(filepath, out data);
response.data = data;
response.content_type = get_content_type( filepath );
response.status_code = StatusCode.OK;
read_failed = false;
} catch (Error err) {
response.text = err.message;
response.status_code = StatusCode.ERROR;
response.content_type="text/plain";
}
} else {
//file not found
response.status_code = StatusCode.FILE_NOT_FOUND;
response.content_type = "text/plain";
response.text = "File Not Found";
}
return response;
}
private string get_content_type(string file) {
//get the extension
MatchInfo mi;
ext_reg.match( file, 0, out mi );
var ext = mi.fetch_named("ext");
string content_type = "text/plain";
if (ext!=null) {
string lower_ext = ext.down();
switch(lower_ext) {
case "htm":
case "html":
content_type="text/html";
break;
case "xml":
content_type="text/xml";
break;
case "js":
case "json":
content_type="text/javascript";
break;
case "css":
content_type="text/css";
break;
case "ico":
content_type="image/icon";
break;
case "png":
content_type="image/png";
break;
case "jpg":
content_type="image/jpeg";
break;
case "gif":
content_type="image/gif";
break;
}
}
return content_type;
}
// return a Request based on a portion of th line
private Request get_request(string line) {
Request r = Request();
r.args = new HashTable<string, string>(str_hash, str_equal);
//get the parts from the line
string[] parts = line.split(" ");
//how many parts are there?
if (parts.length == 1) {
return r;
}
//add the path to the Request
r.full_request = parts[1];
parts = r.full_request.split("?");
r.path = parts[0];
r.query = parts[1] ?? "";
//get the object and action
parts = r.path.split("/");
if (parts.length > 1) {
r.object = parts[1] ?? "";
}
if (parts.length > 2) {
r.action = parts[2] ?? "";
}
if (parts.length > 3) {
r.val = Uri.unescape_string(parts[3]) ?? "";
}
//split the query if it exists
if (r.query != "") {
string[] query_parts={};
parts = r.query.split("&");
foreach( string part in parts ) {
query_parts = part.split("=");
if (query_parts.length == 2){
r.args[query_parts[0]] = Uri.unescape_string(query_parts[1]);
}
}
}
return r;
}
}
public static void main() {
WebServer ws = new WebServer();
ws.run();
}
* copyright 2012 Jezra Lickter
* Licensed GPLv3
*
* save as "valaserver.vala" and compile with
* valac --pkg gio-2.0 valaserver.vala
*
*/
using GLib;
//what port are we serving on?
const uint16 PORT = 8787;
namespace StatusCode {
const string FILE_NOT_FOUND = "HTTP/1.1 404 Not Found\n";
const string OK = "HTTP/1.1 200 OK\n";
const string ERROR = "HTTP/1.1 500 Internal Server Error\n";
}
struct Request {
string full_request;
string path;
string query;
HashTable<string, string> args;
string object;
string action;
string val;
}
struct Response {
string status_code;
string content_type;
string text;
uint8[] data;
}
public class WebServer {
private ThreadedSocketService tss;
private string public_dir;
private Regex ext_reg;
public WebServer() {
public_dir="public";
try {
ext_reg = new Regex("\\.(?<ext>[a-z]{2,4})$");
} catch(Error e) {
stderr.printf(e.message+"\n");
}
//make the threaded socket service with hella possible threads
tss = new ThreadedSocketService(150);
//create an IPV4 InetAddress bound to no specific IP address
InetAddress ia = new InetAddress.any(SocketFamily.IPV4);
//create a socket address based on the netadress and set the port
InetSocketAddress isa = new InetSocketAddress(ia, PORT);
//try to add the address to the ThreadedSocketService
try {
tss.add_address(isa, SocketType.STREAM, SocketProtocol.TCP, null, null);
} catch(Error e) {
stderr.printf(e.message+"\n");
return;
}
/* connect the 'run' signal that is emitted when
* there is a connection to our connection handler
*/
tss.run.connect( connection_handler );
}
public void run() {
//we need a gobject main loop
MainLoop ml = new MainLoop();
//start listening
tss.start();
stdout.printf(@"Serving on port $PORT\n");
//run the main loop
ml.run();
}
//when a request is made, handle the socket connection
private bool connection_handler(SocketConnection connection) {
string first_line ="";
size_t size = 0;
Request request = Request();
//get data input and output streams for the connection
DataInputStream dis = new DataInputStream(connection.input_stream);
DataOutputStream dos = new DataOutputStream(connection.output_stream);
//read the first line from the input stream
try {
first_line = dis.read_line( out size );
request = get_request( first_line );
} catch (Error e) {
stderr.printf(e.message+"\n");
}
//build a response based on the request
Response response = Response();
response = get_file_response(request);
serve_response( response, dos );
return false;
}
private void serve_response(Response response, DataOutputStream dos) {
try {
var data = response.data ?? response.text.data;
dos.put_string(response.status_code);
dos.put_string("Server: ValaSocket\n");
dos.put_string("Content-Type: %s\n".printf(response.content_type));
dos.put_string("Content-Length: %d\n".printf(data.length));
dos.put_string("\n");//this is the end of the return headers
/* For long string writes, a loop should be used,
* because sometimes not all data can be written in one run
* see http://live.gnome.org/Vala/GIOSamples#Writing_Data
*/
long written = 0;
while (written < data.length) {
// sum of the bytes of 'text' that already have been written to the stream
written += dos.write (data[written:data.length]);
}
} catch( Error e ) {
stderr.printf(e.message+"\n");
}
}
private Response get_file_response(Request request) {
//default request.path = index.htm
string request_path = (request.path=="/") ? "index.htm" : request.path;
string filepath= Path.build_filename(public_dir, request_path);
Response response = Response();
response.content_type = "text/plain";
response.status_code = StatusCode.ERROR;
//does the file exist?
if (FileUtils.test(filepath, GLib.FileTest.IS_REGULAR) ) {
//serve the file
bool read_failed = true;
uint8[] data = {};
try {
FileUtils.get_data(filepath, out data);
response.data = data;
response.content_type = get_content_type( filepath );
response.status_code = StatusCode.OK;
read_failed = false;
} catch (Error err) {
response.text = err.message;
response.status_code = StatusCode.ERROR;
response.content_type="text/plain";
}
} else {
//file not found
response.status_code = StatusCode.FILE_NOT_FOUND;
response.content_type = "text/plain";
response.text = "File Not Found";
}
return response;
}
private string get_content_type(string file) {
//get the extension
MatchInfo mi;
ext_reg.match( file, 0, out mi );
var ext = mi.fetch_named("ext");
string content_type = "text/plain";
if (ext!=null) {
string lower_ext = ext.down();
switch(lower_ext) {
case "htm":
case "html":
content_type="text/html";
break;
case "xml":
content_type="text/xml";
break;
case "js":
case "json":
content_type="text/javascript";
break;
case "css":
content_type="text/css";
break;
case "ico":
content_type="image/icon";
break;
case "png":
content_type="image/png";
break;
case "jpg":
content_type="image/jpeg";
break;
case "gif":
content_type="image/gif";
break;
}
}
return content_type;
}
// return a Request based on a portion of th line
private Request get_request(string line) {
Request r = Request();
r.args = new HashTable<string, string>(str_hash, str_equal);
//get the parts from the line
string[] parts = line.split(" ");
//how many parts are there?
if (parts.length == 1) {
return r;
}
//add the path to the Request
r.full_request = parts[1];
parts = r.full_request.split("?");
r.path = parts[0];
r.query = parts[1] ?? "";
//get the object and action
parts = r.path.split("/");
if (parts.length > 1) {
r.object = parts[1] ?? "";
}
if (parts.length > 2) {
r.action = parts[2] ?? "";
}
if (parts.length > 3) {
r.val = Uri.unescape_string(parts[3]) ?? "";
}
//split the query if it exists
if (r.query != "") {
string[] query_parts={};
parts = r.query.split("&");
foreach( string part in parts ) {
query_parts = part.split("=");
if (query_parts.length == 2){
r.args[query_parts[0]] = Uri.unescape_string(query_parts[1]);
}
}
}
return r;
}
}
public static void main() {
WebServer ws = new WebServer();
ws.run();
}
The code is also available at http://hoof.jezra.net/snip/nV. save as "valaserver.vala" and compile with
valac --pkg gio-2.0 valaserver.vala
In the same directory where the code was compiled, create a directory named "public" and fill the directory with static HTML files. Point your browser to http://localhost:8787 to see the server in actions.
note: The default file needs to be named "index.htm"
When an HTTP request is parsed, the Request struct splits the request into controller,action,val variables based on the location of text in the requested URL. The format is host:port/controller/action/val.
In MuttonChop these variables are processed with a series of "switch" statements in order to determine what MuttonChop is supposed to do. For example to to set the player volume to 77, the controller is 'player', the action is 'volume' and the val is '77', thus the URL would be host:port/player/volume/77.
Sweet Sauce!
Tags:
2019
2016
September
June
May
April
March
2015
September
August
May
April
March
February
January
2014
December
- Tubular Music Thingy Part 2
- Beaglebone console output and a faster boot
- Tubular Music Thingy (part 1)
- get and speak the weather
- Getreel youtube-dl wrapper
November
August
July
June
May
April
February
January
2013
December
November
October
September
August
July
June
May
April
March
February
January
2012
December
November
October
September
August
July
- Two hours with the Archos 43
- HTML5 for a specific platform? I prefer to develop native apps
- a bit of dev talk about MuttonChop media player
May
- case for my status server
- my tiny todo list and some ruby
- The Camp Mug (almost) Test
- 2012 Tizen Developers Conference in San Francisco
- Freedom Jar is Full
- Web UI speed up using HTML5 Server Sent Events
- LEDs, BeagleBone, and my ToDo List
- a case for the BeagleBone
April
March
- fixing the car mirror
- Basic HTTP server in Vala using GIO Sockets
- sewing up a bling thing
- Trip to Austin
- convert hexadecimal string to an integer with Vala
February
January
2011
December
November
October
- Training for 2012: Wuggling
- ABC tune grabber/converter
- A trip to Lancaster
- a new media playing machine
September
- Don't turn Tizen into WebOS
- making some chili sauce
- grumpy kid
- beer network improvement
- Ripping my DVD collection
August
July
- ruby script to search files in a directory for a string
- Pacific Pinball Museum Mission
- A Tale of Two Mugs
- shishi odoshi prototype
June
May
April
March
- file downloader in Node.js that handles redirects
- Travelling Far Part II
- python shell-fm web interface
- not quite a letter to cherrypal
- Audio playing class in Ruby with Gstreamer
- A quick fix
February
- my resized images using Ruby and Imagemagick
- one pound of coffee
- noise-canceling headphones that actually work
- updating my dynamic IP DNS information with Ruby
- Hello World in Ruby
January
2010
December
November
- Bacon Apple Cider
- clawhammer sudo modprobe
- a web.py introduction
- The Skillet
- banjer strap on the cheap
October
- The Letter to Dell
- Linux Outlaws episode 170
- Not the 2010 Petaluma Whiskerino
- Monte Rio
- a new power switch
September
August
July
- the coffee cup review
- seriously, that thing is garbage
- keeping a GTK TextView cursor in view
- A tale of three sticker
June
- minimize/close to system tray in Python GTK
- A markdown editor/viewer in Python
- Red Phone Mumble Test
- Saturday Sassafrass
- A Friday Frolic
- Toshiba laptop review
May
- Google no longer uses Microsoft
- regarding Heybuddy and python stuff
- I'm calling you!
- heybuddy identi.ca client
- making a change holder thing
- Did I win? Yes and No.
- photograph sticker
April
- share this on facebook
- the damn computer died
- kilt alteration
- audcast streamer in vala with gstreamer, gtk and webkit
March
- The Mullet Adventure
- A Letter to the California State Legislature
- will dogfooding the frenzy leave me bitter?
- basic sitemap file maker in Python
- rock and rolling down the street
February
January
2009
December
- Time to Celebrate
- game of life : Vala, SDL
- game of life : python, clutter
- networked timed text-to-speech goodness
- battery status in a screen session
- Bright Bike
- turning gears
November
- incremental screenshot namer wrapper
- a nice little feature/bug
- drawing circles
- broken VHS fixed
- cloudy phone number finder
October
- network quitter fixer
- the hot sauce experiment
- non-delivered emails sent to AOL domains
- GIMP mathmap experiment results
- tri-force tuna gift
September
- leave early, take your time, enjoy the solitude
- N37°49'8 W122°28'48
- rotary phone computer interface in action
- python script to play the latest version of an audio broadcast
August
- rotary phone computer input device
- server log spam from Microsoft?
- creating a CAPTCHA
- hello HTML 5! a simple audio player
July
- How does that increase security?
- getting familiar with GWT, a porting experiment.
- You're Not Carnival Personnel!
- "disable" a web app's buttons using javascript and css
- litterbugs and jaywalkers
June
- a basic web-app with pyjamas
- shell script to aid in compiling Vala projects
- Banjo part 4: she's finished
- Accent Characters in Linux with Xorg
- Terminal emulator part deux!
May
- Community
- Terminal Emulator in Vala using GTK and VTE
- Where is the MPAA on this one?
- pyclutter stage fullscreen hack
- Banjo part 3
April
March
- from necessity comes something
- If you build it, they will spam
- writing blogging software ( using data from blogspot )
February
January
2008
December
- From WBEZ Chicago......
- Simple Switch Input to Enter a Command
- perplexing ponderence, pertaining penguin presents
November
- baby steps: the evolution my feature-free PHP framework
- ruining a perfectly good lamp?
- thank you bazaar
- quick not-so-little bikey bag
- Vala musings : int to string, packages, and starting with main
October
September
- my motor vehicle warranty is about to expire? really?
- Bike Trailer Part 2
- getting dandy with a hair pretty
- a not so elegant fixer up
August
June
May
- use python and gstreamer to get the tags of an audio file
- trials with gstreamer, pygst, and goom visualization
- Gaarrrrrrrrr!
- more pyclutter: get a move on - behaviourpath
- scrollwheel css div Internet Explorer 7 problem fixed
- Hello World using pyclutter - a half assed tutorial
April
I am desperatly trying to write a webserver whith SSL Support, but i have no idea how to solve that.
I woul be _VERY_ grateful for any hints or samples.
Ewww, that sound far to much like I just told you to RTFM. sorry buddy.
:-)