diff options
Diffstat (limited to 'src/rcl_prv_discover.erl')
| -rw-r--r-- | src/rcl_prv_discover.erl | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/src/rcl_prv_discover.erl b/src/rcl_prv_discover.erl new file mode 100644 index 0000000..e9a6dea --- /dev/null +++ b/src/rcl_prv_discover.erl @@ -0,0 +1,175 @@ +%% -*- mode: Erlang; fill-column: 80; comment-column: 75; -*- +%%% Copyright 2012 Erlware, LLC. All Rights Reserved. +%%% +%%% This file is provided to you under the Apache License, +%%% Version 2.0 (the "License"); you may not use this file +%%% except in compliance with the License. You may obtain +%%% a copy of the License at +%%% +%%% http://www.apache.org/licenses/LICENSE-2.0 +%%% +%%% Unless required by applicable law or agreed to in writing, +%%% software distributed under the License is distributed on an +%%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +%%% KIND, either express or implied. See the License for the +%%% specific language governing permissions and limitations +%%% under the License. +%%%--------------------------------------------------------------------------- +%%% @author Eric Merritt <[email protected]> +%%% @copyright (C) 2012 Erlware, LLC. +%%% +%%% @doc This provider uses the lib_dir setting of the state. It searches the +%%% Lib Dirs looking for all OTP Applications that are available. When it finds +%%% those OTP Applications it loads the information about them and adds them to +%%% the state of available apps. This implements the rcl_provider behaviour. +-module(rcl_prv_discover). + +-behaviour(rcl_provider). + +-export([init/1, + do/1, + format/1]). + +%%============================================================================ +%% API +%%============================================================================ +-spec init(rcl_state:t()) -> {ok, rcl_state:t()}. +init(State) -> + {ok, State}. + +-spec do(rcl_state:t()) -> {error, Reason::term()} | {ok, rcl_state:t()}. +do(State) -> + LibDirs = rcl_state:lib_dirs(State), + AppMeta = lists:flatten(ec_plists:map(fun discover_dir/1, LibDirs)), + Errors = [case El of + {error, Ret} -> Ret; + _ -> El + end + || El <- AppMeta, + case El of + {error, _} -> + true; + _ -> + false + end], + + lists:filter(fun({error, _}) -> true; + (_) -> false + end, AppMeta), + case Errors of + [] -> + {ok, rcl_state:available_apps(State, lists:flatten(AppMeta))}; + _ -> + {error, Errors} + end. + +-spec format({error, [ErrorDetail::term()]}) -> iolist(). +format({error, ErrorDetails}) -> + [[format_detail(ErrorDetail), "\n"] || ErrorDetail <- ErrorDetails]. + +%%%=================================================================== +%%% Internal Functions +%%%=================================================================== +-spec format_detail(ErrorDetail::term()) -> iolist(). +format_detail({accessing, File, eaccess}) -> + io_lib:format("permission denied accessing file ~s", [File]); +format_detail({accessing, File, Type}) -> + io_lib:format("error (~p) accessing file ~s", [Type, File]); +format_detail({error, {no_beam_files, EbinDir}}) -> + io_lib:format("no beam files found in directory ~s", [EbinDir]); +format_detail({error, {not_a_directory, EbinDir}}) -> + io_lib:format("~s is not a directory when it should be a directory", [EbinDir]); +format_detail({error, {unable_to_load_app, AppDir, _}}) -> + io_lib:format("Unable to load the application metadata from ~s", [AppDir]); +format_detail({error, {invalid_app_file, File}}) -> + io_lib:format("Application metadata file exists but is malformed: ~s", + [File]); +format_detail({error, {unversioned_app, AppDir, _AppName}}) -> + io_lib:format("Application metadata exists but version is not available: ~s", + [AppDir]). + +-spec discover_dir(file:name()) -> + [rcl_app_info:t() | {error, Reason::term()}] | + rcl_app_info:t() | {error, Reason::term()}. +discover_dir(File) -> + case filelib:is_dir(File) of + true -> + case file:list_dir(File) of + {error, Reason} -> + {error, {accessing, File, Reason}}; + {ok, List} -> + ec_plists:map(fun discover_dir/1, [filename:join([File, Dir]) || Dir <- List]) + end; + false -> + is_valid_otp_app(File) + end. + +-spec is_valid_otp_app(file:name()) -> [rcl_app_info:t() | {error, Reason::term()} | []]. +is_valid_otp_app(File) -> + %% Is this an ebin dir? + EbinDir = filename:dirname(File), + case filename:basename(EbinDir) of + "ebin" -> + case lists:suffix(".app", File) of + true -> + has_at_least_one_beam(EbinDir, File); + false -> + [] + end; + _ -> + [] + end. + +-spec has_at_least_one_beam(file:name(), file:filename()) -> + rcl_app_info:t() | {error, Reason::term()}. +has_at_least_one_beam(EbinDir, File) -> + case file:list_dir(EbinDir) of + {ok, List} -> + case lists:any(fun(NFile) -> lists:suffix(".beam", NFile) end, List) of + true -> + gather_application_info(EbinDir, File); + false -> + {error, {no_beam_files, EbinDir}} + end; + _ -> + {error, {not_a_directory, EbinDir}} + end. + +-spec gather_application_info(file:name(), file:filename()) -> + rcl_app_info:t() | {error, Reason::term()}. +gather_application_info(EbinDir, File) -> + AppDir = filename:dirname(EbinDir), + case file:consult(File) of + {ok, [{application, AppName, AppDetail}]} -> + get_vsn(AppDir, AppName, AppDetail); + {error, Reason} -> + {error, {unable_to_load_app, AppDir, Reason}}; + _ -> + {error, {invalid_app_file, File}} + end. + +-spec get_vsn(file:name(), atom(), proplists:proplist()) -> + rcl_app_info:t() | {error, Reason::term()}. +get_vsn(AppDir, AppName, AppDetail) -> + case proplists:get_value(vsn, AppDetail) of + undefined -> + {error, {unversioned_app, AppDir, AppName}}; + AppVsn -> + get_deps(AppDir, AppName, AppVsn, AppDetail) + end. + +-spec get_deps(file:name(), atom(), string(), proplists:proplist()) -> + rcl_app_info:t(). +get_deps(AppDir, AppName, AppVsn, AppDetail) -> + ActiveApps = proplists:get_value(applications, AppDetail, []), + LibraryApps = proplists:get_value(included_applications, AppDetail, []), + rcl_app_info:new(AppName, AppVsn, AppDir, ActiveApps, LibraryApps). + +%%%=================================================================== +%%% Test Functions +%%%=================================================================== + +-ifndef(NOTEST). +-include_lib("eunit/include/eunit.hrl"). + +-endif. |