Check in progress

Author: yurrriq

.travis.yml

@@ -5,15 +5,20 @@ before_script:
 - wget https://s3.amazonaws.com/rebar3/rebar3
 - chmod +x rebar3
 env: PATH=$PATH:.
-# script: rebar3 eunit && rebar3 as test coveralls send || cat rebar3.crashdump
-script: rebar3 as test compile
+script: rebar3 as test do xref, dialyzer, eunit, coveralls send
 cache:
   directories:
   - $HOME/.cache/rebar3/
 otp_release:
-- 19.0
-- 18.3
 - 18.0
-# - 17.5
-# - R16B03-1
-# - R15B03-1
+- 18.1
+- 18.2
+- 18.2.1
+- 18.3
+- 19.0
+- 19.1
+- 19.2
+- 19.3
+- 20.0
+- 20.1
+- 20.2

rebar.config

@@ -8,16 +8,18 @@
  [{add, elli_cache, [{erl_opts, [{i, "_build/test/lib"}]}]}]}.
 
 {deps,
- [{elli_cache, "0.1.1"},
-  {mimerl, "1.1.0"}]}.
+ [{elli_cache, "1.0.1"}]}.
 
 {profiles,
  [{test,
    [{deps,
-     [{elli, "2.0.1"},
-      {meck, "0.8.4"}]}]},
+     [{elli, "3.0.0"}]},
+    {dialyzer,
+     [{plt_extra_apps, [elli]}]}
+   ]},
   {docs,
-   [{deps, [{edown, "0.8.1"}]},
+   [{erl_opts, [{i, ["_build/test/lib"]}]},
+    {deps, [{edown, "0.8.1"}]},
     {edoc_opts,
      [
       {dir, "doc"},
@@ -26,9 +28,10 @@
       {doc_path,
        ["http://raw.github.com/elli-lib/elli/develop/doc",
         "http://raw.github.com/elli-lib/elli_cache/develop/doc"
+        "http://raw.github.com/elli-lib/elli_static/develop/doc"
        ]},
       {top_level_readme,
-       {"./README.md", "https://github.com/elli-lib/elli_cache", "develop"}}
+       {"./README.md", "https://github.com/elli-lib/elli_static", "develop"}}
      ]}]}]}.
 
 {post_hooks,

rebar.lock

@@ -3,7 +3,7 @@
   {description, "Elli middleware to serve static files."},
   {vsn, "0.0.1"},
   {registered, []},
-  {applications, [kernel, stdlib, elli, elli_cache]},
+  {applications, [kernel, stdlib, elli_cache]},
   {env, []},
 
   {maintainers,

src/elli_static.app.src

@@ -0,0 +1,127 @@
+-module(elli_static).
+
+-behaviour(elli_handler).
+-behaviour(elli_cache).
+
+
+-include_lib("elli/include/elli.hrl").
+-include_lib("kernel/include/file.hrl").
+-include_lib("elli_cache/src/elli_cache_util.hrl").
+
+
+-define(TABLE, elli_static_table).
+
+
+-export([preprocess/2,
+         handle/2, handle_event/3,
+         postprocess/3,
+         get_modified/2,
+         get_size/2
+        ]).
+
+-export_type([config/0]).
+
+-type config() :: [{binary(), {dir, file:name_all()}}].
+
+
+preprocess(Req, Config)
+  when not(?GET_OR_HEAD(Req#req.method)) ->
+    MaybeMtime = get_modified(Req, Config),
+    MaybeSize = get_size(Req, Config),
+    MaybeETag  = maybe_etag(MaybeMtime, MaybeSize),
+    rfc7232:init(Req, MaybeMtime, MaybeETag);
+preprocess(Req, _Config) ->
+    Req.
+
+
+-spec handle(elli:req(), config()) -> elli_handler:result().
+handle(_Req, []) ->
+    ignore;
+handle(Req, [{Prefix, {dir, Dir}}|Args]) ->
+    case maybe_file(Req, Prefix, Dir) of
+        {just, Filename} ->
+            {ok, [], {file, Filename}};
+        nothing ->
+            handle(Req, Args)
+    end.
+
+
+-spec handle_event(elli_handler:event(), list(), config()) -> ok.
+handle_event(elli_startup, _Args, _Config) ->
+    ets:new(?TABLE, [set, named_table, public]),
+    ok;
+handle_event(request_complete, [Req|_Args], _Config) ->
+    ReqKey = erlang:phash2(Req),
+    ets:delete(?TABLE, ReqKey),
+    ok;
+handle_event(_Event, _Args, _Config) ->
+    ok.
+
+
+postprocess(Req, {ResponseCode, _Headers, _What} = Res, Config)
+  when ?OK_GET_OR_HEAD(ResponseCode, Req#req.method) ->
+    MaybeMtime = get_modified(Req, Config),
+    MaybeSize = get_size(Req, Config),
+    MaybeETag  = maybe_etag(MaybeMtime, MaybeSize),
+    rfc7232:init(Req, MaybeMtime, MaybeETag, Res);
+postprocess(_, Res, _) ->
+    Res.
+
+
+get_modified(Req, Args) ->
+    do_it(Req, fun(#file_info{mtime = Mtime}) -> Mtime end, Args).
+
+
+get_size(Req, Args) ->
+    do_it(Req, fun(#file_info{size = Size}) -> Size end, Args).
+
+
+do_it(_Req, _Fun, []) ->
+    nothing;
+do_it(Req, Fun, [{Prefix, {dir, Dir}}|Args]) ->
+    ReqKey = erlang:phash2(Req),
+    case ets:lookup(?TABLE, ReqKey) of
+        [{ReqKey, FileInfo}] ->
+            {just, Fun(FileInfo)};
+        _ ->
+            case maybe_file(Req, Prefix, Dir) of
+                {just, Filename} ->
+                    FileInfo = file_info(Filename),
+                    ets:insert(?TABLE, {ReqKey, FileInfo}),
+                    {just, Fun(FileInfo)};
+                nothing ->
+                    do_it(Req, Fun, Args)
+            end
+    end;
+do_it(Req, Fun, [_Arg|Args]) ->
+    do_it(Req, Fun, Args).
+
+
+file_info(Filename) ->
+    case file:read_file_info(Filename, [{time, universal}]) of
+        {ok, FileInfo} -> FileInfo;
+        {error, Reason} -> throw(Reason)
+    end.
+
+
+maybe_file(Req, Prefix, Dir) ->
+    Size = byte_size(Prefix),
+    case elli_request:raw_path(Req) of
+        <<Prefix:Size/binary,"/",Path/binary>> ->
+            Filename = filename:join(Dir, Path),
+            case filelib:is_regular(Filename) of
+                true  -> {just, Filename};
+                false -> throw({404, [], <<"Not Found">>})
+            end;
+        _ ->
+            nothing
+    end.
+
+
+maybe_etag(nothing, _Size) ->
+    nothing;
+maybe_etag(_Mtime, nothing) ->
+    nothing;
+maybe_etag({just, Mtime}, {just, Size}) ->
+    ETag = list_to_binary(httpd_util:create_etag(Mtime, Size)),
+    {just, <<"\"", ETag/binary, "\"">>}.

src/elli_static.erl

@@ -0,0 +1,50 @@
+-module(elli_static_tests).
+-include_lib("eunit/include/eunit.hrl").
+-compile(export_all).
+
+elli_static_test_() ->
+    {setup,
+     fun setup/0, fun teardown/1,
+     [?_test(readme()),
+      ?_test(no_file()),
+      ?_test(not_found())]}.
+
+
+readme() ->
+    {ok, Response} = httpc:request("http://localhost:3000/elli_static/README.md"),
+    {ok, File} = file:read_file("README.md"),
+    Expected = binary_to_list(File),
+    ?assertEqual([integer_to_list(iolist_size(Expected))],
+                 proplists:get_all_values("content-length", element(2, Response))),
+    ?assertMatch({_Status, _Headers, Expected}, Response).
+
+
+no_file() ->
+    {ok, Response} = httpc:request("http://localhost:3000/elli_static/no_file"),
+    ?assertMatch({{"HTTP/1.1",404,"Not Found"}, _Headers, "Not Found"}, Response).
+
+
+not_found() ->
+    {ok, Response} = httpc:request("http://localhost:3000/not_found"),
+    ?assertMatch({{"HTTP/1.1",404,"Not Found"}, _Headers, "Not Found"}, Response).
+
+
+setup() ->
+    {ok, Dir} = file:get_cwd(),
+    Args = [{<<"/elli_static">>, {dir, Dir}}],
+    Config = [
+              {mods, [
+                      {elli_middleware_cache, [{mod, elli_static_cache}]},
+                      {elli_static, Args}
+                     ]
+              }
+             ],
+    {ok, Pid} = elli:start_link([{callback, elli_middleware},                                 
+                                 {callback_args, Config},
+                                 {port, 3000}]),
+    unlink(Pid),
+    [Pid].
+
+
+teardown(Pids) ->
+    [elli:stop(Pid) || Pid <- Pids].