summary refs log tree commit diff stats
path: root/main.go
blob: 4b62f27587864ca437233a9eb5315935fc39c79f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
package main

import (
	"fmt"
	"log"
	"net/http"
	"time"

	"github.com/gorilla/handlers"
	"github.com/gorilla/mux"
)

const getwtxt = "0.1"

func main() {

	// StrictSlash(true) allows /api and /api/
	// to serve the same content without duplicating
	// handlers/paths
	index := mux.NewRouter().StrictSlash(true)
	api := index.PathPrefix("/api").Subrouter()

	// <3 gorilla/mux
	index.Path("/").
		Methods("GET").
		HandlerFunc(indexHandler)
	index.Path("/css").
		Methods("GET").
		HandlerFunc(cssHandler)
	index.Path("/api").
		Methods("GET").
		HandlerFunc(apiBaseHandler)
	// twtxt will add support for other formats later.
	// Maybe json? Making this future-proof.
	api.Path("/{format:(?:plain)}").
		Methods("GET").
		HandlerFunc(apiFormatHandler)
	// Specifying the endpoint with and without query information.
	// Will return 404 on empty queries otherwise.
	api.Path("/{format:(?:plain)}/{endpoint:(?:mentions|users|tweets)}").
		Methods("GET").
		HandlerFunc(apiEndpointHandler)
	// Using stdlib net/url to validate the input URLs rather than regex.
	// Validating a URL with regex is unwieldly
	api.Path("/{format:(?:plain)}/{endpoint:(?:mentions|users|tweets)}").
		Queries("url", "{url}", "q", "{query}").
		Methods("GET").
		HandlerFunc(apiEndpointHandler)
	// This is for submitting new users
	api.Path("/{format:(?:plain)}/{endpoint:users}").
		Queries("url", "{url}", "nickname", "{nickname:[a-zA-Z0-9_-]+}").
		Methods("POST").
		HandlerFunc(apiEndpointPOSTHandler)
	// Show all observed tags
	api.Path("/{format:(?:plain)}/tags").
		Methods("GET").
		HandlerFunc(apiTagsBaseHandler)
	// Requests tweets with a specific tag
	api.Path("/{format:(?:plain)}/tags/{tags:[a-zA-Z0-9_-]+}").
		Methods("GET").
		HandlerFunc(apiTagsHandler)

	// format the port for the http.Server object
	portnum := fmt.Sprintf(":%v", confObj.port)
	// defines options for the http server.
	// handlers.CompressHandler gzips all responses.
	// Write/Read timeouts are self explanatory.
	server := &http.Server{
		Handler:      handlers.CompressHandler(index),
		Addr:         portnum,
		WriteTimeout: 15 * time.Second,
		ReadTimeout:  15 * time.Second,
	}

	log.Printf("Listening on port %v\n", confObj.port)
	err := server.ListenAndServe()
	if err != nil {
		log.Printf("%v\n", err)
	}

	closelog <- true
}
//: understand and more malleable, easier to rewrite and remould into radically</span> <span class="Comment">//: different shapes without breaking in subtle corner cases. The premise is</span> <span class="Comment">//: that understandability and rewrite-friendliness are related in a virtuous</span> <span class="Comment">//: cycle. Doing one well makes it easier to do the other.</span> <span class="Comment">//:</span> <span class="Comment">//: Lower down, this file contains a legal, bare-bones C++ program. It doesn't</span> <span class="Comment">//: do anything yet; subsequent files will contain :(...) directives to insert</span> <span class="Comment">//: lines into it. For example:</span> <span class="Comment">//: :(after &quot;more events&quot;)</span> <span class="Comment">//: This directive means: insert the following lines after a line in the</span> <span class="Comment">//: program containing the words &quot;more events&quot;.</span> <span class="Comment">//:</span> <span class="Comment">//: A simple tool is included to 'tangle' all the files together in sequence</span> <span class="Comment">//: according to their directives into a single source file containing all the</span> <span class="Comment">//: code for the project, and then feed the source file to the compiler.</span> <span class="Comment">//: (It'll drop these comments starting with a '//:' prefix that only make</span> <span class="Comment">//: sense before tangling.)</span> <span class="Comment">//:</span> <span class="Comment">//: Directives free up the programmer to order code for others to read rather</span> <span class="Comment">//: than as forced by the computer or compiler. Each individual feature can be</span> <span class="Comment">//: organized in a self-contained 'layer' that adds code to many different data</span> <span class="Comment">//: structures and functions all over the program. The right decomposition into</span> <span class="Comment">//: layers will let each layer make sense in isolation.</span> <span class="Comment">//:</span> <span class="Comment">//: &quot;If I look at any small part of it, I can see what is going on -- I don't</span> <span class="Comment">//: need to refer to other parts to understand what something is doing.</span> <span class="Comment">//:</span> <span class="Comment">//: If I look at any large part in overview, I can see what is going on -- I</span> <span class="Comment">//: don't need to know all the details to get it.</span> <span class="Comment">//:</span> <span class="Comment">//: Every level of detail is as locally coherent and as well thought-out as</span> <span class="Comment">//: any other level.&quot;</span> <span class="Comment">//:</span> <span class="Comment">//: -- Richard Gabriel, &quot;The Quality Without A Name&quot;</span> <span class="Comment">//: (<a href="http://dreamsongs.com/Files/PatternsOfSoftware.pdf">http://dreamsongs.com/Files/PatternsOfSoftware.pdf</a>, page 42)</span> <span class="Comment">//:</span> <span class="Comment">//: Directives are powerful; they permit inserting or modifying any point in</span> <span class="Comment">//: the program. Using them tastefully requires mapping out specific lines as</span> <span class="Comment">//: waypoints for future layers to hook into. Often such waypoints will be in</span> <span class="Comment">//: comments, capitalized to hint that other layers rely on their presence.</span> <span class="Comment">//:</span> <span class="Comment">//: A single waypoint might have many different code fragments hooking into</span> <span class="Comment">//: it from all over the codebase. Use 'before' directives to insert</span> <span class="Comment">//: code at a location in order, top to bottom, and 'after' directives to</span> <span class="Comment">//: insert code in reverse order. By convention waypoints intended for insertion</span> <span class="Comment">//: before begin with 'End'. Notice below how the layers line up above the &quot;End</span> <span class="Comment">//: Foo&quot; waypoint.</span> <span class="Comment">//:</span> <span class="Comment">//: File 001 File 002 File 003</span> <span class="Comment">//: ============ =================== ===================</span> <span class="Comment">//: // Foo</span> <span class="Comment">//: ------------</span> <span class="Comment">//: &lt;---- :(before &quot;End Foo&quot;)</span> <span class="Comment">//: ....</span> <span class="Comment">//: ...</span> <span class="Comment">//: ------------</span> <span class="Comment">//: &lt;---------------------------- :(before &quot;End Foo&quot;)</span> <span class="Comment">//: ....</span> <span class="Comment">//: ...</span> <span class="Comment">//: // End Foo</span> <span class="Comment">//: ============</span> <span class="Comment">//:</span> <span class="Comment">//: Here's part of a layer in color: <a href="http://i.imgur.com/0eONnyX.png">http://i.imgur.com/0eONnyX.png</a>. Directives</span> <span class="Comment">//: are shaded dark.</span> <span class="Comment">//:</span> <span class="Comment">//: Layers do more than just shuffle code around. In a well-organized codebase</span> <span class="Comment">//: it should be possible to stop loading after any file/layer, build and run</span> <span class="Comment">//: the program, and pass all tests for loaded features. (Relevant is</span> <span class="Comment">//: <a href="http://youtube.com/watch?v=c8N72t7aScY">http://youtube.com/watch?v=c8N72t7aScY</a>, a scene from &quot;2001: A Space</span> <span class="Comment">//: Odyssey&quot;.) Get into the habit of running the included script called</span> <span class="Comment">//: 'test_all_layers' before you commit any changes.</span> <span class="Comment">//:</span> <span class="Comment">//: This 'subsetting guarantee' ensures that this directory contains a</span> <span class="Comment">//: cleaned-up narrative of the evolution of this codebase. Organizing</span> <span class="Comment">//: autobiographically allows a newcomer to rapidly orient himself, reading the</span> <span class="Comment">//: first few files to understand a simple gestalt of a program's core purpose</span> <span class="Comment">//: and features, and later gradually working his way through other features as</span> <span class="Comment">//: the need arises.</span> <span class="Comment">//:</span> <span class="Comment">//: Programmers shouldn't need to understand everything about a program to hack</span> <span class="Comment">//: on it. But they shouldn't be prevented from a thorough understanding of</span> <span class="Comment">//: each aspect either. The goal of layers is to reward curiosity.</span> <span class="Comment">// Includes</span> <span class="Comment">// End Includes</span> <span class="Comment">// Types</span> <span class="Comment">// End Types</span> <span class="Comment">// prototypes are auto-generated in the makefile; define your functions in any order</span> <span class="PreProc">#include </span><span class="Constant">&quot;function_list&quot;</span> <span class="Comment">// by convention, files ending with '_list' are auto-generated</span> <span class="Comment">// Globals</span> <span class="Comment">// End Globals</span> int main<span class="Delimiter">(</span>int argc<span class="Delimiter">,</span> char* argv[]<span class="Delimiter">)</span> <span class="Delimiter">{</span> atexit<span class="Delimiter">(</span>teardown<span class="Delimiter">);</span> <span class="Comment">// End One-time Setup</span> <span class="Comment">// End Commandline Parsing</span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// End Main</span> <span class="Delimiter">}</span> <span class="Comment">//: our first directive; will move the include above the program</span> <span class="Delimiter">:(before &quot;End Includes&quot;)</span> <span class="PreProc">#include</span><span class="Constant">&lt;stdlib.h&gt;</span> <span class="Comment">//: Without directives or with the :(code) directive, lines get added at the</span> <span class="Comment">//: end.</span> <span class="Delimiter">:(code)</span> void setup<span class="Delimiter">()</span> <span class="Delimiter">{</span> <span class="Comment">// End Setup</span> <span class="Delimiter">}</span> void teardown<span class="Delimiter">()</span> <span class="Delimiter">{</span> <span class="Comment">// End Teardown</span> <span class="Delimiter">}</span> </pre> </body> </html> <!-- vim: set foldmethod=manual : -->