<!-- Content Start -->
<h1>Project 6: You Got Served</h1>
<h3 class="warning">Due by: Friday, May 1, 2015 at 11:59pm</h3>
<h2>Introduction</h2>
<p>
Many years ago, someone invented the Internet, although some controversy still remains over <a href="http://en.wikipedia.org/wiki/Al_gore">who</a> did it. A while after the Internet was invented, people came up with the idea of displaying information on webpages. These crude documents evolved over time to become the rather frightening explosion of information that we love, hate, rely on, use to waste time, etc. Surprisingly, the fundamental idea behind it all has not changed much: A user at Computer A wants to view a webpage at Computer B. Computer A informs Computer B of this fact, and Computer B sends the file over. The entire Internet is just that, a lot of computers sending files to each other.
</p>
<p>
In the scenario above, Computer A is what we call a <strong>client</strong> and Computer B is what we call a <strong>server</strong>. Computer A could also be a server to other computers, or, if Computer B wanted some data from Computer A, Computer A could even be a server for Computer B. As you know, it's really the process on the computer that is serving as a client or a server.
</p>
<br>
<h2>Overview</h2>
<p>
Why are we bothering you with this inane (and highly incomplete) history? Because we want you to write a web server. Web servers sit out there waiting for someone to ask for a file, and then they happily send it along. Pretty straightforward, right? The concept is simple, but the implementation is a little bit messier for two reasons.
</p>
<ol>
<li>You need to conform to the HTTP protocol. You can't just send data willy-nilly. There is a specific format for telling a client what you are about to send and then sending it.</li>
<li>You have to use socket programming to send the data. It's not much worse than low-level file I/O. The main difference is that more can go wrong when you're sending data across the network instead of writing it to a file.
</li>
</ol>
<br>
<h2>Implementation Details</h2>
<p>
You should submit one or more <code>.c</code> and <code>.h</code> files and a makefile that will compile them into an executable called <code>server</code>. Here's an outline of the operations your code should perform.
</p>
<ol>
<li>Read in the command line arguments. If you don't have exactly three, quit with the following message.</li>
Usage: ./server <port> <path to root>
<li>Use the first command line argument as the port number. If it's a bad port number quit with the following message.</li>
Bad port: port
<li>Use the <code>chdir()</code> function to change the working directory to the directory specified. If the function returns an error, quit with the following message.</li>
Could not change to directory: directory
<li>Get a socket, bind it to the specified port, and then listen to it. You may need to use the <code>setsockopt()</code> function to make the socket reusable for multiple connections.</li>
<li>Try to accept a connection on the port you're listening to.</li>
<li>When you successfully accept a connection, process the request.</li>
<li>If it isn't a <code>GET</code> or <code>HEAD</code> request, ignore it.</li>
<li>If it is a <code>GET</code> or <code>HEAD</code> request:</li>
<ul>
<li>First, if the file path ends with a slash (<code>/</code>), then concatenate <code>index.html</code> onto the path.</li>
<li>Next, if the file path starts with a slash (<code>/</code>), you'll need to skip it, since a path that starts with a slash specifies an absolute path.</li>
<li>If the file the client wants is available, send the appropriate information.</li>
<li>If the file is not available, send a 404 message.</li>
</ul>
<li>Close the connection when you are done with it.</li>
<li>Go back to Step 5 and keep trying to accept more connections.</li>
</ol>
<table class="shaded" style="float: right; margin-left: 2em;">
<tbody><tr><th>Extension</th><th>Type</th></tr>
<tr style="background-color: rgb(191, 211, 229);"><td><code>html</code></td><td>text/html</td></tr>
<tr><td><code>htm</code></td><td>text/html</td></tr>
<tr style="background-color: rgb(191, 211, 229);"><td><code>jpg</code></td><td>image/jpeg</td></tr>
<tr><td><code>jpeg</code></td><td>image/jpeg</td></tr>
<tr style="background-color: rgb(191, 211, 229);"><td><code>gif</code></td><td>image/gif</td></tr>
<tr><td><code>png</code></td><td>image/png</td></tr>
<tr style="background-color: rgb(191, 211, 229);"><td><code>txt</code></td><td>text/plain</td></tr>
<tr><td><code>c</code></td><td>text/plain</td></tr>
<tr style="background-color: rgb(191, 211, 229);"><td><code>h</code></td><td>text/plain</td></tr>
<tr><td><code>pdf</code></td><td>application/pdf</td></tr>
</tbody></table>
<br>
<p>
You must support the following features.
</p>
<ul>
<li><code>GET</code></li>
<li><code>Content-Type</code> for a large variety of common file types, often called MIME types. The table to the right is the minimum list you must support.</li>
<li><code>Content-Length</code>, which will require you to determine the length of a file, either directly or by using something in the <code>stat()</code> and <code>fstat()</code> family of functions</li>
<li><code>HEAD</code></li>
<li>404 errors for non-existent files, composed of both of a 404 message and an appropriate HTML file</li>
<li>Command line options for the server to specify port and root directory</li>
<li>Compatibility with Mozilla Firefox</li>
</ul>
<br style="clear: both;">
<h2>References</h2>
<p>
In order to help you write a standards-compliant web server, you'll need to consult some references. When doing so, it is important to <strong>read smart</strong>. References are extremely dull. You need to skim them to figure out the structure of the documents. Then, you need to focus in on just the stuff you need. If you try to read the entire thing (especially in the case of <a href="rfc1945.html">RFC1945</a>), your head will explode. Note that you only need to support HTTP 1.0.
</p>
<p>Here is a list of references we suggest you start with.</p>
<ul>
<li><a href="http://beej.us/guide/bgnet/">Beej's Guide to Network Programming</a><br>An excellent guide to basic network programming in C. You can go far with the notes, but you'll probably end up supplementing your work with code from here.</li><br>
<li><a href="http://www.jmarshall.com/easy/http/">HTTP Made Really Easy</a><br>A very well put together guide to understanding the HTTP protocol. You do not need to worry about HTTP/1.1 for this project. Concentrate on the HTTP/1.0 section, and remember to read smart.</li><br>
<li><a href="rfc1945.html">RFC1945 - Hypertext Transfer Protocol -- HTTP/1.0</a><br>An RFC (Request For Comments) is a document that specifies a standard or protocol so it can be followed by various vendors. RFC1945 is for HTTP/1.0, and should provide you with more than enough information to understand the protocol. This is the source for any picky little details.
</li><br>
</ul>
<br>
<h2>Details</h2>
<p>
Unlike many assignments in this class, the standard libraries are completely available to you. Since this is a real program, we want you to have full access to all the tools you might use on the job.
</p>
<p>Here are a few standard library functions you might find useful.</p>
<ul>
<li><code>memcopy()</code> - Copies one chunk of memory into another</li>
<li><code>memset()</code> - Sets a chunk of memory to a particular value</li>
<li><code>sscanf()</code> - String version of <code>scanf()</code> that can read whitespace delimited tokens from a string</li>
<li><code>strchr()</code> and <code>strrchr()</code> - Find a <code>char</code> value in a string, starting at the front or the back</li>
</ul>
<p>You will also need a number of networking functions to do the communication. At the very least, you will probably use the functions below.</p>
<ul>
<li><code>socket()</code> - Get a socket descriptor</li>
<li><code>bind()</code> - Bind a port to a socket</li>
<li><code>listen()</code> - Get a socket ready to accept incoming connections</li>
<li><code>accept()</code> - Try to accept an incoming connection (if one is present)</li>
<li><code>recv()</code> - Receive a stream of bytes</li>
<li><code>send()</code> - Send a stream of bytes</li>
<li><code>setsockopt()</code> - Set options on a socket (particularly whether or not a port is reusable)</li>
</ul>
<p>There are a few other odd things flying around. For example, note that messages in HTTP end in CR-LF (<code>\r\n</code>), like lines of text in DOS files. Also, you need to pick a port to run your server on. A random number between 20000 and 30000 is a good idea. You should allow the port of your server to be specified at the command line when you start your server up.
</p>
<p>
Also, network byte order is not always the same as host byte order (the byte order of your machine). This will vary depending on whether you are on a Little Endian or a Big Endian architecture. In order to be sure that the byte orders of a few things are consistent (things like fields inside of the structures that specify network parameters, not things like the data that is actually sent), there are a few functions which can be used to convert between host and network byte orders. If you use these at all, it will only be in one or two places, but it is still a good idea for you to be familiar with them.
</p>
<ul>
<li><code>htonl()</code> - Convert a 32-bit integer from host byte order to network byte order</li>
<li><code>htons()</code> - Convert a 16-bit integer from host byte order to network byte order</li>
<li><code>ntohl()</code> - Convert a 32-bit integer from network byte order to host byte order</li>
<li><code>ntohs()</code> - Convert a 16-bit integer from network byte order to host byte order</li>
</ul>
<br>
<h2>Testing by Hand</h2>
<p>
A good way to learn the HTTP protocol is to talk to a server manually. A simple program called <code>nc</code> (or <code>netcat</code>, they're the same program) allows you to start doing this. <code>nc</code> will open up a port and let you type data directly into it. Doing so can let you see both sides of the HTTP communication (client and server).
</p>
<h3><code>nc</code> as a client</h3>
<p>
First, let's use <code>nc</code> to connect to a pre-existing server and manually send a request. From reading the above resources, we know that a valid way to request the root document is as follows.
</p>
GET / HTTP/1.0 <hit enter again>
<p>
Let's use <code>nc</code> to do this. Fire up <code>nc</code> and have it connect to a web server (say, <a href="http://www.google.com">google.com</a>) on port 80 as follows.
</p>
nc google.com 80
<p>So, if you run that command, and then enter the HTTP request from above, it should look like the following. The command and user input is given in <code class="green">green</code></p>
nc google.com 80
GET / HTTP/1.0
HTTP/1.0 200 OK
Date: Thu, 18 Apr 2014 17:16:55 GMT
Expires: -1
Cache-Control: private, max-age=0
Content-Type: text/html; charset=ISO-8859-1
Set-Cookie: PREF=ID=fde1ef9d7532d32d:FF=0:TM=1366305415:LM=1366305415:S=m8C7mvDa0KCfqYOK; expires=Sat, 18-Apr-2015 17:16:55 GMT; path=/; domain=.google.com
Set-Cookie: NID=67=mVjnX4KiYll7GcDvUbIsur2kVgn1YhhdRIQzBKDjHrEUUP3vR4VO5g6VcnLj9jdZFEl28bakPSK0aLR-8X6IALCwnVYt6_3CHjj9zA33wwMJjRgg7S9GaSWuBIeBQnk1; expires=Fri, 18-Oct-2014 17:16:55 GMT; path=/; domain=.google.com; HttpOnly
P3P: CP="This is not a P3P policy! See http://www.google.com/support/accounts/bin/answer.py?hl=en&answer=151657 for more info."
Server: gws
X-XSS-Protection: 1; mode=block
X-Frame-Options: SAMEORIGIN
<!doctype html><html itemscope="itemscope" itemtype="http://schema.org/WebPage"><head><meta content="Search the world's information, including webpages, images, videos and more. Google has many special features to help you find exactly what you're looking for." name="description"><meta content="noodp" name="robots"><meta itemprop="image" content="/images/google_favicon_128.png"><title>Google</title><script>(function(){
window.google={kEI:"hypwUbWkHI-ZlQWzsYDIDw",getEI:function(a){for(var b;a&&(!a.getAttribute||!(b=a.getAttribute("eid")));)a=a.parentNode;return b||google.kEI},https:function(){return"https:"==window.location.protocol},kEXPI:
...
<p>
There's a lot more junk after that, but it's critical that the server first sends a message saying <code>HTTP/1.0 200 OK</code> to indicate that it is going to send the file. What does it send if the file didn't exist? Give that a try on your own. It also sends lots of other information, and you don't have to include all of it. Regardless, you have a start for your server.
</p>
<h3><code>nc</code> as a Server</h3>
<p>
There is another important question: What does Firefox send to the server? This data is what your server is going to have to parse. You can find out by putting <code>nc</code> into listen mode like so (using port 27809 as an arbitrary choice).
</p>
nc -l 27809
<p>
Now, if you tell your web browser to connect to that server and port (for example, <a href="http://127.0.0.1:27809/">http://127.0.0.1:27809/</a>), <code>nc</code> will dump out exactly what the browser sends it. It will probably look something like the following. Again, the command is printed in <code class="green">green</code>. Everything else is the message sent from the browser.
</p>
nc -l 27809 GET / HTTP/1.1 Host: 127.0.0.1:27809 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:18.0) Gecko/20100101 Firefox/ 18.0 Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Accept-Language: en-US,en;q=0.5 Accept-Encoding: gzip, deflate Connection: keep-alive
<h2>Testing with a Browser</h2>
<p>We suggest that you test using Mozilla Firefox. Theoretically, any browser should work if you get your server right.</p>
<p>
Let's imagine that your server is running and is attached to port 27809 and you want to get file <code>joe.html</code> from it. Enter the following into the address bar in Firefox: <a href="http://127.0.0.1:27809/joe.html">http://127.0.0.1:27809/joe.html</a>.
</p>
<h2>Provided Files</h2>
<ul>
<li><a href="server.exe">server.exe</a> - Sample executable</li>
<li><a href="sample/index.html">index.html</a> - A sample HTML document (right-click to save)</li>
<li><a href="sample/amy.jpg">amy.jpg</a> - An image referenced in the sample HTML document</li>
</ul>
<h2>Turn In</h2>
<p>If everything is working correctly, the <code>J:</code> drive is mounted in Linux under <code>/mnt/classes</code>. Go to the class directory (<code>J:\FA2014-2015\CS222A</code> or <code>J:\FA2014-2015\CS222B</code>) there and create a directory called <code>Project6</code>.</p>
<p>Copy the contents of your project directory, including the makefile, the source C files, and header files into the directory you just created. <strong>Do not</strong> include any object files or executables. Running the <code>make</code> command must compile all the required C source code files and generate an executable named <code>server</code>.</p>
<p class="warning">The directory and file name must match <em>exactly</em> or you will risk scoring 0 points. Match even the spacing and capitalization specified. Automated tools are used to collect your files for grading.</p>
<p>All work must be submitted before Friday, May 1, 2015 at 11:59pm unless you are going to use a grace day.</p>
<h2>Grading</h2>
<p>
Your grade will be determined by the following categories.
</p>
<table class="shaded">
<tbody><tr>
<th>Category</th>
<th>Weight</th>
</tr>
<tr style="background-color: rgb(191, 211, 229);">
<td>
<code>GET</code> Functionality
</td>
<td>
30%
</td>
</tr>
<tr>
<td>
<code>HEAD</code> Functionality
</td>
<td>
20%
</td>
</tr>
<tr style="background-color: rgb(191, 211, 229);">
<td>
<code>Content-Type</code> (MIME) support
</td>
<td>
10%
</td>
</tr>
<tr>
<td>
<code><strong>Content-Length</strong></code><strong>
</strong></td>
<td>
10%
</td>
</tr>
<tr style="background-color: rgb(191, 211, 229);">
<td>
404 Error Support
</td>
<td>
15%
</td>
</tr>
<tr>
<td>
Correct Makefile and File Naming
</td>
<td>
5%
</td>
</tr>
<tr style="background-color: rgb(191, 211, 229);">
<td>
Programming Style
</td>
<td>
10%
</td>
</tr>
</tbody></table>
<p class="warning">Under no circumstances should any member of one team look at the code written by another team. Tools will be used to detect code similarity automatically.</p>
<p class="warning">Code that does not compile will automatically score zero points.</p>
</div>
<!-- Content End -->
</div>
<!-- Footer Start -->
<div id="footer">
<div class="block">
<div class="spacer">
<a href="http://www.etown.edu/"><img src="../../images/fightingjay.png"></a>
</div>
</div>
<div class="block">
<div class="spacer">
<strong>Elizabethtown College</strong><br>
One Alpha Drive<br>
Elizabethtown, PA 17022<br>
<a href="http://www.etown.edu/">Elizabethtown Website</a><br>
<a href="http://www.etown.edu/depts/computer-science/">Computer Science Division Website</a>
</div>
</div>
<div class="block">
<div class="spacer">
<strong>Contact Information</strong><br>
Office: Esbenshade 284B<br>
Phone: 717.361.4761<br>
E-mail: <a href="mailto:[email protected]">[email protected]</a>
</div>
</div>
<div class="block">
<div class="spacer">
<a href="http://www.entypo.com">Entypo</a> pictograms by <a href="http://danielbruce.se/">Daniel Bruce</a><br>
<a href="http://www.theleagueofmoveabletype.com/league-gothic">League Gothic</a> font from <a href="http://www.theleagueofmoveabletype.com/">The League of Moveable Type</a><br>
Header image by <a href="http://www.flickr.com/people/ellenm1/">ellenm1</a>
</div>
</div>
<div class="teeth"></div>
</div>
<!-- Footer End -->