Born Neet

「Web Sockets云々の前にTCPのソケット通信わかってんの？」
「う゛…」

というやりとりが動機ってわけではないんですが、
最近、Webサーバの実装に興味深々で、
C言語でのネットワークプログラミングについて勉強を始めました。

そんな中見つけたIBMの軽量 Web サーバーという記事で、
「Portable minimal web servers」なる論文が紹介されていました。

非常に短くて素敵だったので、手始めにこいつをコードリーディングしてみることにしました。

予習

いきなりコードを見てもC初心者な僕にはさっぱりだと思ったので、
以下の4冊から関連しそうな部分を流し読みして、わかった気になっておきました。
これでもう怖くありません。
（嘘です、まだまだ読み返さないとわからないことだらけです。）

UNIXネットワークプログラミング入門

技術評論社 2003-06-05

by G-Tools , 2010/02/21

C言語によるプログラミング 応用編

システム計画研究所

オーム社 2002-09

by G-Tools , 2010/02/21

Unix/Linuxプログラミング理論と実践

長尾 高弘

アスキー・メディアワークス 2008-04-21

by G-Tools , 2010/02/21

C言語によるTCP/IPネットワークプログラミング

ピアソンエデュケーション 2001-09

by G-Tools , 2010/02/21

論文の内容

翻訳しようかと思いましたが、あんまりコードの説明もなさそうだったのでやめときました。

たぶん、

Apacheとか複雑なのもいいけど、シンプルさも大事でしょ？
ちょっとCとbashで作ってみたから、紹介するよ！
GPLだからご自由にどうぞ。

みたいなことが書いてあるはずです。

動作確認

ソースを読む前に、まずは動くか確認。
…以下の手順で問題なく動きました。

準備
cd /Users/t/c/szerver
mkdir htdocs

echo test > htdocs/index.html

設定変更
vi szerver.c
#define PORT 8080
#define DOCUMENTROOT "/Users/t/c/szerver/htdocs"

コンパイル
gcc szerver.c -o szerver

実行
./szerver.c
NW通信の警告popupが出たら「許可」

ブラウザから
http://localhost:8080/
testと表示されればOK

コードリーディング

元のソースはこちら（FTPです）

一部ハンガリー語があったので、
英訳→日訳しつつ読んでいきました。

最終的には下記のようにコメントをつけまくって理解したつもりになってます。
間違ってる部分があればご指摘いただけると幸いです。

いやぁやっぱ公開するコードの変数名とかは英語で書かないと駄目ですね。
非日本語圏の人が「gokei_keisan」とかに出くわしたら、やっぱテンパるんだろうなぁ…。

/* 
  ヘッダファイルのinclude
  TODO: 各ヘッダを何のために使ってるか
*/
#include <stdio.h>
#include <stdlib.h>
#include <syslog.h>	//syslog出力
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <fnmatch.h>
#include <libgen.h>

// デバッグログを表示したい時はdefineする
/*#define DEBUG*/

// listenポートとドキュメントルート
#define PORT 8080
#define DOCUMENTROOT "/Users/t/c/szerver/htdocs"

char		request_file[1024];	//
void		*memory_buffer;	// 応答するファイルの内容を読み込むバッファ
size_t	buffer_size;	// 読み込むファイルのサイズ（バッファのサイズ）
int			sock;	//

/*
  エラーをsyslogに吐く。
  hibaはerrorの意味
*/
void hiba( const char *hiba ){
	syslog( 0, hiba );
	exit(1);
}/*hiba*/

/*
  応答するファイルをmemory_bufferに読み込む
*/
int loadfile( ){
	struct stat	size;	// ファイル情報
	int infile;	// ディスクリプタ

	// ファイルの情報を取得
	if( stat( request_file, &size ) != 0 )
		hiba( "File not found.¥n" );

	// サイズを取得
	buffer_size = size.st_size;
	
	// サイズ文のバッファを確保
	memory_buffer=malloc( buffer_size );
	if( memory_buffer==NULL )
		hiba( "Out of memory.¥n" );

	// ファイルを開いて読み込む
	infile=open( request_file, O_RDONLY );
	if( read( infile, memory_buffer, buffer_size ) != buffer_size )
		hiba( "Unable to read file." );

	// ファイルを閉じる
	close( infile );
}/*sendfile*/	/* loadfileのタイポ */

/*
　	socketのbindまでを行う
　	kapuはport
　	nyitはopen
　	-asaは謎
*/
int kapu_nyitasa( void ){
	int kapu;
	struct sockaddr_in  barki; // サーバが接続待ちするIP、ポート情報（barki=any）

	// socketの作成
	// PF_INET(IPV4)
	// SOCK_STREAM(ストリーム)
	// 0（IPPROTO_TCPが指定される）
	kapu = socket (PF_INET, SOCK_STREAM, 0);
	if(kapu < 0)
		hiba( "Error open socket.¥n" );

	barki.sin_family=AF_INET; // アドレスファミリ（インターネット）
	barki.sin_port=htons(PORT);	// portをNWバイトオーダーで指定
	barki.sin_addr.s_addr=htonl(INADDR_ANY);	// ホスト上の全IP

	// ディスクリプタ（kapu）とポートのム結び付け
	if(bind(kapu, (struct sockaddr *) &barki, sizeof(barki)) < 0)
		hiba( "Error binding socket.¥n" );
	
	return kapu;
}/*kapu_nyitasa*/


/*
	olvasas = read
*/
int olvasas( int kapu ){
	char memoria[1024];  // リクエスト読み込みバッファ（memoria = memory）
	int n;
	
	// request_fileにDOCUMENTROOTを書き込む
	sprintf( request_file, DOCUMENTROOT );

	// memoriaにrequestを読み込む
	n=read(kapu, memoria, 1024);
	if( n < 0 )
		hiba( "Error reading socket.¥n" );

	// リクエストラインからファイル名を取得して、DOCUMENTROOT以降に追記
	sscanf(memoria, "GET %s", 
			&request_file[strlen(DOCUMENTROOT)] );
	
	// スラッシュで終わってたらindex.htmlを付ける
	if( request_file[strlen(request_file)-1]=='/' )
			sprintf(&request_file[strlen(request_file)], "index.html" );
	
	// デバッグログ
	#ifdef DEBUG
	syslog( 0, "File request: %s¥n", request_file );
	#endif

	return( n );
}/*olvasas*/
	
/*
 iras = writeっぽい
*/
int iras( int kapu ){
	// レスポンスのテンプレ
	char head_template[]="HTTP/1.0 200 OK¥r¥n¥
Server: miniserver/0.1¥r¥n¥
Connection: close¥r¥n¥
Content-Type: %s¥r¥n¥r¥n";

char	head[512];	// レスポンスするヘッダ
char  *type;
int		irt;

	// Content-Typeの設定
	type="text/html";
	if( fnmatch("*.gif", basename(request_file), 0) == 0 )
		type="image/gif";
	if( fnmatch("*.jpg", basename(request_file), 0) == 0 )
		type="image/jpeg";
	if( fnmatch("*.png", basename(request_file), 0) == 0 )
		type="image/png";
	
	// ヘッダを作成
	sprintf( head, head_template, type ); 

	// ヘッダの送信
	irt=write( kapu, head, strlen(head));
	
	// データの送信
	if( memory_buffer != NULL )
		irt=write( kapu, memory_buffer, buffer_size );
	else
		syslog( 0, "Error: no data to send.¥n" );
 
	return(1);
}/*iras*/

/*
  メインループ
*/
int  mainloop( void ){
	int new;	// 接続完了後のディスクリプタ
	int i;
	struct sockaddr_in clientname;	// 接続したクライアントの情報
	size_t size;

	// socketの作成
	sock=kapu_nyitasa();
	
	while( 1 ){
		// socketをlisten可能状態に
		if( listen (sock, 1) < 0 )
			hiba( "Error while listening." );

			// クライアントと接続
			size = sizeof (clientname);
			new = accept(sock, (struct sockaddr *) &clientname, &size);

			/*waitpid( WAIT_ANY, NULL, WNOHANG );*/
			// 子プロセスでリクエストを処理
			if( fork() != 0 ){
				olvasas( new );	// リクエストからファイル名取得
				loadfile(); // ファイルの読み込み
				iras( new ); // ヘッダ・データの送信
				shutdown( new, 2 ); // TODO: closeとの差とか
				if( memory_buffer != NULL )
					free(memory_buffer);
				return(0);
			}
	}/*while*/
}/*mainloop*/
 
/*
  終了系のシグナルを受けた時の処理
*/
void signal_handler( int signal ){
	shutdown( sock, 2 );
	hiba("Exiting...¥n");
}/*signal_handler*/	


/*
  main関数
*/
int main( int argc, char *argv[] ){
	// syslog準備＆スタートメッセージ
	openlog( "webserver", LOG_PID, LOG_MAKEPRI(LOG_DAEMON, LOG_DEBUG) );
	syslog( 0, "Miniserver started." );
	
	// 終了系シグナルの処理
	signal( SIGINT, signal_handler );
	signal( SIGKILL, signal_handler );
	signal( SIGTERM, signal_handler );
	
	daemon( 0, 0 );	// daemon化（TODO: 初めて見た）
	mainloop();	// mainloop実行
	return(0);
}/*main*/

うーん、やっぱ自分でコード書いてみないとダメだなー。
頑張るかー。

うちのOS X10.6でも無事動いたmod_websocketですが、
証明書の設定が面倒でwss(SSL)を試してみませんでした。

実際始めてしまえばそんなに面倒じゃないんですが、
やるまでがね…。

ってわけで、手順を残しておきますので、ご自由にどうぞ。

なお、参考にしたのは以下のサイトです。
Webサーバ「lighttpd」でSSLを使うには − ＠IT
今日も明日もググったー: lighttpd ssl
Rails + lighttpd + SSL - プログラマ 福重 伸太朗 〜基本へ帰ろう〜

作業ディレクトリへ
cd lighty/lighttpd-1.4.26


lighttpdをSSL ONでコンパイルし直し
./configure --prefix=/Users/t/lighty/ --with-openssl
(network-opensslがenableの方に表示されればOK)
make
make install
cd ..


lighttpdの設定
vi etc/lighttpd/lighttpd.conf
 $SERVER["socket"] == ":8443" {
       ssl.engine                  = "enable"
       ssl.pemfile                 = "/Users/t/lighty/etc/lighttpd/ssl/server.pem"
}
:wq
※ ここではサボってますが、広く公開する場合等（っていうか原則）は、
　ドキュメントルートを分けましょう。

オレオレ証明書の作成
mkdir etc/lighttpd/ssl/
openssl req -new -x509 -keyout server.pem -out server.pem 
Generating a 1024 bit RSA private key
.........++++++
.............................++++++
writing new private key to 'server.pem'
Enter PEM pass phrase:
Verifying - Enter PEM pass phrase:
Verify failure
Enter PEM pass phrase:****
Verifying - Enter PEM pass phrase:****
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:JP
State or Province Name (full name) [Some-State]:Tokyo
Locality Name (eg, city) []:Koto
Organization Name (eg, company) [Internet Widgits Pty Ltd]:Born Neet
Organizational Unit Name (eg, section) []:    
Common Name (eg, YOUR name) []:localhost
Email Address []:

ls
server.pem
cd ~/lighty


起動
lighttpd -f etc/lighttpd/lighttpd.conf
Enter PEM pass phrase: ****


HTTPSのテスト（ブラウザから）
https://localhost:8443/
test
（証明書の警告は無視）


チャットサンプル(wss版）の準備
cp -p srv/www/htdocs/ws_chat.html srv/www/htdocs/wss_chat.html 
vi srv/www/htdocs/wss_chat.html 
var ws = new WebSocket("wss://127.0.0.1:8443/chat");
:wq


chatサーバの起動
mod_websocket/src/sample/ws_chat 9001
ポップアップが出るので許可する


Chatのテスト（Chromeから）
http://localhost:8080/wss_chat.html
https://localhost:8443/wss_chat.html
（wss通信だけじゃなくwss_chat.html取得の通信も暗号化すべき）
動いた！！

ん…wssってこれでいいんだっけ？

何か間違ってる気がするので突っ込みに期待…
…じゃなく後で勉強しとこう。

nori2048さんに早速突っ込みをいただきました。（2010/2/20 00:10）
コメント欄も合わせてご覧下さい。
（記事にも追記しています。）

先日失敗したmod_websocket on snow leopardですが、
作者のnori0428さんが早くも修正版をリリースしてくださいました。

動かないと文句を付けた手前、早く試してみないと…と思ってたんですが、
今週は忙しくて週末になってしまいました。
というわけで、リベンジです。
（僕は何もしてませんが）

結果は…
…無事、動きました！！

Mac OS 10.6の人は以下の手順で使えると思いますよー。
（wssはスルーしてますが）

作業ディレクトリ
mdkir lighty
cd lighty

mod_websocketのダウンロード
git clone git://github.com/nori0428/mod_websocket.git

lighttpdのダウンロード
curl -O http://download.lighttpd.net/lighttpd/releases-1.4.x/lighttpd-1.4.26.tar.gz

とりあえず、makeに必須のライブラリをインストール
sudo port install autoconf
sudo port install Automake
sudo port install pcre
zlibとbzip2はデフォルトで入ってるっぽい。

そしてmod_websocketへ
tar xf lighttpd-1.4.26.tar.gz
cd lighttpd-1.4.26

パッチ当て
patch -p1 < ../mod_websocket/src/mod_websocket.patch

cp ../mod_websocket/src/mod_websocket.c src/


ホームディレクトリ内にインストール
./autogen.sh
./configure --prefix=/Users/t/lighty/
make
make install

確認（ファイルがあればOK）
ls -l ../lib/mod_websocket.*
-rwxr-xr-x  1 t  staff   1022  2 19 01:58 ../lib/mod_websocket.la
-rwxr-xr-x  1 t  staff  26016  2 19 01:58 ../lib/mod_websocket.so

パス追加
vi ~/.profile
export PATH=/Users/t/lighty/sbin:$PATH
:wq
source ~/.profile

lighttpdの設定
mkdir -p ../etc/lighttpd
cp -p doc/lighttpd.conf ../etc/lighttpd/
cd ..
vi etc/lighttpd/lighttpd.conf
server.modules              = ( "mod_websocket", 
server.port                = 8080
server.document-root        = "/Users/t/lighty/srv/www/htdocs/"
server.errorlog             = "/Users/t/lighty/var/log/lighttpd/error.log"
accesslog.filename          = "/Users/t/lighty/var/log/lighttpd/access.log"
websocket.server = (
      "/echo" => ( "host" => "127.0.0.1", "port" => 9000 ),
      "/chat" => ( "host" => "127.0.0.1", "port" => 9001 )
)
:wq

ディスクトリとテストコンテンツの作成
mkdir -p srv/www/htdocs
mkdir -p var/log/lighttpd
mkdir -p var/run/lighttpd
echo test > srv/www/htdocs/index.html

起動（confファイルを指定しないと何かエラーになる）
lighttpd -t -f etc/lighttpd/lighttpd.conf
Syntax OK
lighttpd -f etc/lighttpd/lighttpd.conf

Webサーバのテスト（ブラウザから）
http://localhost:8080/
test

チャットサンプルの準備
cp mod_websocket/html/ws_chat.html srv/www/htdocs/
vi srv/www/htdocs/ws_chat.html 
var ws = new WebSocket("ws://127.0.0.1:8080/chat");
:wq

libevent（ソースからインストールし直さないとダメっぽい）
sudo port uninstall libevent
curl -O http://www.monkey.org/~provos/libevent-1.4.13-stable.tar.gz
tar xf libevent-1.4.13-stable.tar.gz 
cd libevent-1.4.13-stable
make
sudo make install

サンプルのmake
cd ..
cd mod_websocket/src/sample
make

chatサーバの起動
cd ~/lighty
mod_websocket/src/sample/ws_chat 9001
ポップアップが出るので 「許可」

Chatのテスト（Chromeから）
http://localhost:8080/ws_chat.html
動いた！！

wss(ssl)を有効化するのと、自分でサンプル作ってみるのが宿題。
あと、ソースも読んでみないと。

よーし、弄り倒すぞー。

今日昼間、ふとメールチェックしていると、
html5-developers-jpに素敵な投稿がありました。

「lighttpdでwebsocketできるモジュール作ったよ！」

これは試してみるしかないでしょう、と今日はこのことしか考えてませんでした。
が、残業やらなんやらで気づけばこの時間です。
まぁ仕事なんで仕方ない。

愚痴はこのぐらいにして、早速やってみます。

基本的にはINSTALL at master from nori0428's mod_websocket - GitHubの通りのことをやっただけです。
なんかうまく行きませんでしたが、誰かの役に立つかもしれないので、一応ログを残しておきます。

インストール

準備
mdkir lighty
cd lighty

mod_websocketのダウンロード
git clone git://github.com/nori0428/mod_websocket.git

lighttpdのダウンロード
curl -O http://download.lighttpd.net/lighttpd/releases-1.4.x/lighttpd-1.4.26.tar.gz
tar xf lighttpd-1.4.26.tar.gz

cd lighttpd-1.4.26

パッチ当て（実は初！）
patch -p1 < ../mod_websocket/src/mod_websocket.patch

cp ../mod_websocket/src/mod_websocket.c src/

./autogen.sh
configure.ac:1: error: possibly undefined macro: dnl
      If this token and others are legitimate, please use m4_pattern_allow.
      See the Autoconf documentation.
configure.ac:71: error: possibly undefined macro: AC_DEFINE
→エラー…

sudo port install autoconf

aclocal.m4:14: error: this file was generated for autoconf 2.61.
You have another version of autoconf.  If you want to use that,
you should regenerate the build system entirely.
→まだエラー

sudo port install Automake
→行けた

./configure --prefix=/Users/t/lighty/
checking for pcre-config... no
configure: error: pcre-config not found, install the pcre-devel package or build with --without-pcre
→またエラー

sudo port install pcre
→ようやく行けた

make
Undefined symbols:
  "_network_write_chunkqueue", referenced from:
      _websocket_write_request in mod_websocket.o
→もうやになってきた…

sudo port install gcc45
※ gccいっぱいありすぎ→MacPortsからインストールしたgccについて混乱中 - hnwの日記
※ 4時間かかるらしいので中断

んーわからん。
lighty単体をインストールしてみる
cd ..
rm -rf lighttpd-1.4.26
tar -xf lighttpd-1.4.26.tar.gz
cd lighttpd-1.4.26
./configure --prefix=/Users/t/lighty/
make
make install
→普通にできた。

もっかい1から
cd lighttpd-1.4.26
　：
　：
駄目だこりゃ。　

うーん、今日のところは寝るとしよう。
（gccのせいかもしれないので、アップデートだけ流しておこう）
→gccのアップデートは意味なかったです。[2010/2/17 8:00]

もっとじっくり触りたいのに、時間が足りないなー。
とりあえず、今週末の遊び道具はこいつで決まりかな。
（Cの勉強も兼ねてソースも読もうっと）

なんと2月初投稿…。
最近はわりとコンスタントにポストできてたのになぁ。

今日はiPhoneの話題です。

iPhoneで辞書を使いたい、で、やっぱ英辞郎のデータがいいよね、
ってこと探して2つぐらいアプリを見つけたんだけど、どっちも1000円して手を出しづらい。

どうしようかなぁと思ってたら、PDIC形式の辞書データを使えるpdicoなるアプリを発見。
既にPC版の英辞郎を持ってる僕としては「これは！」って感じだったので、
早速使ってみました。

辞書データの使い回しがどこまで許されるのかよくわからんけど、
PCの方をアンインストールしちゃえばなんの問題もないでしょう。
※ どうせ最近macしか使ってないからPC版の英辞郎起動すらしてないし。

というわけで以下手順。

辞書ファイルの準備

まずは、英辞郎をインストール。
CDを入れて自動再生に任せるだけですね。
ちなみに使ったのは大学時代に買った第3版です。

Personal Dictionary for EIJIRO IIIを起動。
Tool→辞書の変換。
C:\Program Files\PDIC_for_EIJIRO_III内のDICファイルを全て選択。
デスクトップにeijiro.dicとかの名前で保存。
（途中なんかダイアログが出てくるけどよくわからんので「以降自動処理」で。）

※ pdicoは複数の辞書ファイルを同時に使えるので、上記手順は必須じゃないです。
　また、その場合インストールしなくても、D:\EIJIROとかのデータが使えます。

pdicoへの転送

まず、PCとiPhoneを同じ無線LANにつなぎましょう。

pdicoを起動して設定を開きます。

辞書を追加から、 ファイル名は上で作った「eijiro.dic」を指定して次へ。

ブラウザからiPhoneのIPアドレス:8080にアクセス。
（アクセス先はpdico上に表示されています。）

辞書ファイルを選んで送信。
※ Windows Defenderが邪魔してきたら止めちゃいましょう。
※ 途中で電源に接続すると失敗するかもしれません。

まとめ

はい、これだけでiPhone上で英辞郎をインクリメンタル検索できる環境が整っちゃいます。
素晴らしいアプリですね！
検索もかなりサクサク動いてストレスはありません。

あとは検索履歴と部分一致（今は前方一致）、大/小文字無視とかが
できれば言う事なしですね。

PCの英辞郎を既に持ってる人は是非使ってみて下さい。