(defroutes app-routes
  (GET "/" {}
    "Hello World"))

(defn wrap-pre*
  [handler]
  (fn [request]
    (let [response (handler request)]
      (when response
        ;; ==========
        ;; 前処理
        ;; ==========
        response))))

(defn wrap-pre
  ([handler]
   (wrap-pre handler {}))
  ([handler options]
   (-> handler
     wrap-pre*)))

(def app
  (-> app-routes
    (wrap-pre)
    (wrap-stateful-session)))
    
(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
    (run-jetty (handler/site app) {:port port})))

Compojure(Ring)でセッションを使う場合、handlerにwrap-sessionを指定してあげるとCookieセッションが使える。デフォルトだとデータの保存先はメモリ。

で、少しSession関連のモジュールを調べてみたところ、sandbarというのがwrap-sessionのラッパーで高機能かつ、インタフェースが使いやすかったので、今回はコレを使うことにしました。

Session Wrapper

sandbarはwrap-sessionのラッパーというだけでなく、セッションを使ったサイトでよく使われるような、ログインユーザの名前や権限を取得する関数等も提供されています。

brentonashworth/sandbar – GitHub

実際に組み込み後のコードはこんな感じになりました。

(ns compojuretest.core
  (:use compojure.core
        compojure.response
        ring.adapter.jetty
        ring.middleware.reload-modified
        somnium.congomongo
        [ring.util.response :only (response content-type)]
        fleet
+        (sandbar stateful-session auth))

... 省略 ...

;; =============================================
;; Routes
;; =============================================
(defroutes app-routes 
  (GET "/" {} (tpl/index {})))

+(def app
+  (-> app-routes
+    wrap-stateful-session))

;; =============================================
;; Run Server
;; =============================================
;; AutoReload Configuration
(def app (handler/site app))
(def handlerApp
    (wrap-reload-modified #'app ["src"]))

(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
    (run-jetty handlerApp {:port port})))

これで、Sessionが使えるようになります。Sessionを取り出したり設定したりするAPIは本家のwikiを見るか、行数が少ないのでソースを直接見たほうが早いかもしれません。該当箇所は以下です。

src/sandbar/stateful_session.clj at master from brentonashworth/sandbar – GitHub

保存先

上記に書いた通り、標準のSessionの保存先はメモリとなっているので、サーバの再起動等で消えてしまいます。少し不安でもあったので、ファイルかDBに保存するモジュールが無いか調べました。

その前にwrap-sessionで指定できるSessionの保存先というのはオプションで指定でき、下記の継承したものであれば良いようです。

ring-core/src/ring/middleware/session/store.clj at master from mmcgrana/ring – GitHub

SessionもMongoDBに保存したい！

せっかく今回、MongoDBを使っているので、セッションもMongoDBに格納したい！！

clojars.orgで検索してみたところ、下記のモジュールが見つかりました。

hozumi/mongodb-session – GitHub

サンプルを見たところ

(ns hello
  (:require [ring.middleware.session :as rs]
            [somnium.congomongo :as congo]
            [hozumi.mongodb-session :as mongoss]
        ...))

(congo/mongo! :db "mydb" :host "127.0.0.1")

(defroutes my-routes ....)

(def app (-> my-routes
           (rs/wrap-session {:store (mongoss/mongodb-store)})))

とあるので、既に宣言しているmongo!の周り無視して、wrap-session辺りを修正するだけで大丈夫なようです。mongodb-storeを組み込んだコードはこんな感じになりました。

(ns compojuretest.core
  (:use compojure.core
        compojure.response
        ring.adapter.jetty
        ring.middleware.reload-modified
        somnium.congomongo
        [ring.util.response :only (response content-type)]
        fleet
        (sandbar stateful-session auth))
  (:require [compojure.route :as route]
            [compojure.handler :as handl(mongoss/er]
            [clj-json.core :as json]
            [clojure.contrib.string :as string]
+            [hozumi.mongodb-session :as mongoss]))

... 省略 ...

;; =============================================
;; Routes
;; =============================================
(defroutes app-routes 
  (GET "/" {} (tpl/index {})))

(def app
  (-> app-routes
-    wrap-stateful-session
+    (wrap-stateful-session {:store (mongoss/mongodb-store)})))

;; =============================================
;; Run Server
;; =============================================
;; AutoReload Configuration
(def app (handler/site app))
(def handlerApp
    (wrap-reload-modified #'app ["src"]))

(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
    (run-jetty handlerApp {:port port})))

この状態で実際にセッションに値を格納するとMongoDBの方にring_sessionsというコレクションが出来ていると思います。ちなみに、ring_sessionsのレコードはこんな形式です。

> db.ring_sessions.find().forEach(printjson);
{
	"_id" : "c83528b0-cfce-4e0f-b70b-90adce0c21d5",
	"_date" : ISODate("2011-10-31T17:34:55.022Z"),
	"_sandbar_session" : {
		"name" : "Tatsuya Fukata"
	}
}

Cookieのオプション

wrap-sessionで生成されるCookieはデフォルトではexpires未指定でブラウザを閉じた場合に消去されるものになっています。これらのオプションを指定する場合には、wrap-sessionの引数として下記のように指定します。また、これはwrap-stateful-sessionでも同じ形式の引数で渡すことが出来ます。

(def app
  (-> app-routes
    (wrap-stateful-session
      {:cookie-attrs {:expires "Thu, 1-Jan-2030 00:00:00 GMT", :path "/"},
      :cookie-name "compojuretest-session",
      :store (mongoss/mongodb-store)})))

上記以外の詳しい指定方法については、下記のソースを参照してみてください。

ring-core/src/ring/middleware/session.clj at master from mmcgrana/ring – GitHub

WEB開発を行っていると編集した内容をすぐに確認したいですよね。以前までは、編集してはサーバプログラムを一度停止して再度起動するということをやっており、毎回手動で再起動処理を行うのが非常に面倒で、さらには再起動を忘れ、動作確認時に「あれ？」みたいな事がたまにあったので、解決策を探しているとRingのMiddlewareとして上記がありました。

これは、指定したソースディレクトリのClojureファイルが修正されたらリロードしてくれるというものです。設定は簡単で、こんな感じにします。

ただ、一つ難点があり、Fleetのテンプレートファイルのみを編集した場合には変更を検出してくれず、正常に変更を表示できません。まだ、ring-reload-modifiedのソースを見れていないので、もしかすると簡単に対応できるかもしれません。

とりあえず、設定方法は下記のようになります。

設定方法

project.cljの:dependenciesに[ring-reload-modified "0.1.1"]を追加後、下記の設定を行えば自動リロードするようになります。

変更前

(ns compojuretest.core
  (:use compojure.core
        compojure.response
        ring.adapter.jetty
        [ring.util.response :only (response content-type)]
        fleet)
  (:require [compojure.route :as route]
            [compojure.handler :as handler]))

;; ... 省略 ...

;; =============================================
;; Routes
;; =============================================
(defroutes app
  (GET "/" [] (tpl/index {})))

;; =============================================
;; Run Server
;; =============================================
(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
    (run-jetty (handler/site app) {:port port})))

変更後

(ns compojuretest.core
  (:use compojure.core
        compojure.response
        ring.adapter.jetty
+       ring.middleware.reload-modified
        [ring.util.response :only (response content-type)]
        fleet)
  (:require [compojure.route :as route]
            [compojure.handler :as handler]))

;; ... 省略 ...

;; =============================================
;; Routes
;; =============================================
(defroutes app
  (GET "/" [] (tpl/index {})))

;; =============================================
;; Run Server
;; =============================================
+ ;; AutoReload Configuration
+ (def app (handler/site app))
+ (def handlerApp 
+     (wrap-reload-modified #'app ["src"]))

(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
-     (run-jetty (handler/site app) {:port port})))
+     (run-jetty handlerApp {:port port})))

その時のコードはこんな感じです。

core.clj

(ns compojuretest.core
  (:use compojure.core
        compojure.response
        ring.adapter.jetty
        [ring.util.response :only (response content-type)]
        fleet)
  (:require [compojure.route :as route]))

;; =============================================
;; Fleet Setup 
;; =============================================
(def filters [ 
  "js" :str
  "html" :xml
  "fleet" :bypass])

(fleet-ns tpl "templates" filters)

(extend-protocol Renderable
  fleet.util.CljString
  (render [this _] (response (.toString this))))

;; =============================================
;; Routes
;; =============================================
(defroutes app 
  (GET "/" [] (tpl/index {})))

;; =============================================
;; Run Server
;; =============================================
(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
    (run-jetty app {:port port})))

index.html.fleet

< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


    
    


テスト

       

何がおかしいのか調べていて、通常のサイトとのレスポンスヘッダーを見比べてみると、Content-Typeのヘッダーがありませんでした。そこで、下記のようにしてあげると正常にContent-Typeヘッダーも生成されるようになり、文字化けが解消されました。

;; =============================================
;; Routes
;; =============================================
(defroutes app
  (GET "/" [] {:headers {"Content-Type" "text/html; charset=utf8"}
               :body (str (tpl/index {}))}))

毎回headersを書くのが怠いという方は、下記だけでも大丈夫のようです。まだ、Compojureの中身を見ていないので、変なやり方かもしれませんが。

;; =============================================
;; Routes
;; =============================================
(defroutes app
  (GET "/" [] (str (tpl/index {}))))

上記のFleet Setupで行っているextend-protocol部分でうまいこと纏め上げられるんじゃないかとも思いますがとりあえず、ベタであろうやり方を書いてみました。

追記：2011-11-17 10:31
Compojureのresponse.cljを見たところ、Stringの場合はContent-Typeを指定しているのでstr関数を挟む場合に手動で指定する必要はないようです。

src/compojure/response.clj

(extend-protocol Renderable
  nil
  (render [_ _] nil)   
  String
  (render [body _]
    (-> (response body)
        (content-type "text/html; charset=utf-8")))
  APersistentMap
  (render [resp-map _]
    (merge (response "") resp-map))
  IFn
  (render [func request]
    (render (func request) request))
  IDeref  
  (render [ref request]
    (render (deref ref) request)) 
  File      
  (render [file _] (response file))
  ISeq
  (render [coll _] (-> (response coll)
                       (content-type "text/html; charset=utf-8")))
  InputStream
  (render [stream _] (response stream))
  URL
  (render [url _]
    (if (= "file" (.getProtocol url))
      (response (io/as-file url))
      (response (io/input-stream url)))))

追記：2011-11-17 10:39
extend-protocolを下記のように編集することで、str関数を挟まなくても正常に表示されるようになりました。

(extend-protocol Renderable
  fleet.util.CljString
  (render [this _] (-> (response (.toString this))
                       (content-type "text/html; charset=utf-8"))))

Clojureの入門がてら、Herokuに自分のプロフィールサイトを作ってみる そのいち – 蟲！虫！蟲！ – #!/usr/bin/bugrammer

静的ファイルの配置場所

project.cljに「web-content」という項目を追加し、静的コンテンツのディレクトリがどこかを指定します。今回の場合は、プロジェクトディレクトリ直下のpublicディレクトリに配置するものとします。

(defproject compojureexample "1.0.0-SNAPSHOT"
  :description "Compojure Example"
  :dependencies [[org.clojure/clojure "1.2.0"]
                 [org.clojure/clojure-contrib "1.2.0"]
                 [compojure "0.6.5"]
                 [ring/ring-jetty-adapter "0.3.9"]]
;; 静的コンテンツの配置ディレクトリ
  :web-content "public")

ルーティング

次に、静的ファイルを配信するためにルーティングの設定を行います。
今回は、public直下に配置したファイルを、URLとしては、static以下がpublic直下を参照する感じで、「https://localhost:8080/static/***」のようにアクセスさせたいと思います。

src/compojureexample/core.clj

(ns compojureexample.core
  (:use compojure.core
        compojure.response
        ring.adapter.jetty)
  (:require [compojure.route :as route]))

;; =============================================
;; Routes
;; =============================================
(defroutes app
  (GET "/" _ "Hello World")
;; https://localhost:8080/***としてアクセスさせたい場合は、「/」だけでよい。
  (route/files "/static/"))

;; =============================================
;; Run Server
;; =============================================
(defn -main []
  (let [port (Integer/parseInt (get (System/getenv) "PORT" "8080"))]
    (run-jetty app {:port port})))

以上となります。

参考にしたのはこの辺です。

• ClojureでMongoDBにアクセスしてみる – asakawajunyaの日記
• congomongo: Use MongoDB from Clojure – The Changelog – Open Source moves fast. Keep up.
• aboekhoff/congomongo – GitHub

また、テンプレートエンジンについては、前回はEnliveを利用しようかと思ったんですが、実際に使ってみたところEnliveはスクレイピングしたHTMLからデータを抽出するのに適していて、今回のように既にテンプレート、データは用意されていてコントローラからテンプレート内で利用する変数のハッシュを渡して後はテンプレート側で適当に処理してくれるような軽量なものが望ましかったので、今回は諦めました。

そこで、もう少し検索したところFleetというのがあり、使ってみたところ上記の使い方が出来そうだったのでこっちを使ってみることにしました。

基本的な使い方は公式のページに書いています。

Flamefork/fleet – GitHub

また、今回はCompojureと組み合わせたところ、現バージョンではエラーになるので、下記のページを参考に修正すると正常に動作するようになりました。

Glue Fleet and Compojure Together Using Protocols – No Fluff Just Stuff

ということで、今のところCompojure + CongoMongo + Fleetで開発してみたいと思います。

その際参考にしたサイトは下記です。

• HerokuでClojure(Compojure)を使う – komagata
• Heroku | Dev Center | Getting Started With Clojure on Heroku/Cedar

で、いつものようにまともに説明を読まずにやっていたらherokuにpushして、heroku psコマンドでプロセスを確認したところ一向に立ち上がっていませんでした。で、もう一度公式の手順を一から順に観てるとProcfileを作成していないことに気づき、Procfileを作成し、pushしたところ、正常にプロセスが立ち上がりました。

たいてい動かない時というのは、自分が手順をすっぽかしてる事が多いですね・・・気を付けないと。

Heroku | Dev Center | Declaring and Scaling Process Types with Procfile

一応今のところ、Clojure(Compojure) + MongoDBという構成（テンプレートエンジンは模索中）で作ろうかと思っているので、また何かあったら書こうかと思います。それにしてもherokuコマンドだけでも色々なことができるんですね。