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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
%% -*- erlang-indent-level: 4; indent-tabs-mode: nil; fill-column: 80 -*-
%%% 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.
%%%
-module(rlx_rel_discovery).
-export([do/3,
format_error/1]).
-include("relx.hrl").
%%============================================================================
%% API
%%============================================================================
%% @doc recursively dig down into the library directories specified in the state
%% looking for OTP Applications
-spec do(rlx_state:t(), [file:name()], [rlx_app_info:t()]) ->
{ok, [rlx_release:t()]} | relx:error().
do(State, LibDirs, AppMeta) ->
case rlx_state:get(State, disable_rel_discovery, false) of
true ->
ec_cmd_log:debug(rlx_state:log(State), "Disabled resolving of OTP releases"),
{ok, []};
false ->
ec_cmd_log:info(rlx_state:log(State),
fun() ->
["Resolving available OTP Releases from directories:\n",
rlx_string:join([[rlx_util:indent(2), LibDir] || LibDir <- LibDirs], "\n")]
end),
resolve_rel_metadata(State, LibDirs, AppMeta)
end.
-spec format_error([ErrorDetail::term()]) -> iolist().
format_error(ErrorDetails)
when erlang:is_list(ErrorDetails) ->
[[format_detail(ErrorDetail), "\n"] || ErrorDetail <- ErrorDetails].
%%%===================================================================
%%% Internal Functions
%%%===================================================================
resolve_rel_metadata(State, LibDirs, AppMeta) ->
ReleaseMeta0 = lists:flatten(rlx_dscv_util:do(fun(LibDir, FileType) ->
discover_dir(LibDir,
AppMeta,
FileType)
end, LibDirs)),
Errors = [case El of
{error, Ret} -> Ret;
_ -> El
end
|| El <- ReleaseMeta0,
case El of
{error, _} ->
true;
_ ->
false
end],
case Errors of
[] ->
ReleaseMeta1 = [RelMeta || {ok, RelMeta} <- ReleaseMeta0],
ec_cmd_log:debug(rlx_state:log(State),
fun() ->
["Resolved the following OTP Releases from the system: \n",
[[rlx_release:format(1, Rel), "\n"] || Rel <- ReleaseMeta1]]
end),
{ok, ReleaseMeta1};
_ ->
?RLX_ERROR(Errors)
end.
-spec format_detail(ErrorDetail::term()) -> iolist().
format_detail({_Module, {could_not_find, {ReleaseName, {Version, _}}}}) ->
io_lib:format("could not find app ~p ~p", [ReleaseName, Version]);
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({Module,Reason}) ->
io_lib:format("~s~n", [Module:format_error(Reason)]).
-spec discover_dir(file:name(), [rlx_app_info:t()], directory | file) ->
{ok, rlx_release:t()}
| {error, Reason::term()}
| {noresult, false}.
discover_dir(_File, _AppMeta, directory) ->
{noresult, true};
discover_dir(File, AppMeta, file) ->
is_valid_release(File, AppMeta).
-spec is_valid_release(file:name(),
[rlx_app_info:t()]) ->
{ok, rlx_release:t()}
| {error, Reason::term()}
| {noresult, false}.
is_valid_release(File, AppMeta) ->
case filename:extension(File) of
<<".rel">>->
resolve_release(File, AppMeta);
_ ->
{noresult, false}
end.
resolve_release(RelFile, AppMeta) ->
case file:consult(RelFile) of
{ok, [{release, {RelName, RelVsn},
{erts, ErtsVsn},
Apps}]} ->
build_release(RelFile, RelName, RelVsn, ErtsVsn, Apps, AppMeta);
{ok, InvalidRelease} ->
?RLX_ERROR({invalid_release_information, InvalidRelease});
{error, Reason} ->
?RLX_ERROR({unable_to_read, RelFile, Reason})
end.
build_release(RelFile, RelName, RelVsn, ErtsVsn, Apps, AppMeta) ->
Release = rlx_release:erts(rlx_release:new(RelName, RelVsn, RelFile),
ErtsVsn),
resolve_apps(Apps, AppMeta, Release, []).
resolve_apps([], _AppMeta, Release, Acc) ->
{ok, rlx_release:application_details(Release, Acc)};
resolve_apps([AppInfo | Apps], AppMeta, Release, Acc) ->
AppName = erlang:element(1, AppInfo),
AppVsn = ec_semver:parse(erlang:element(2, AppInfo)),
case find_app(AppName, AppVsn, AppMeta) of
Error = {error, _} ->
Error;
ResolvedApp ->
resolve_apps(Apps, AppMeta, Release, [ResolvedApp | Acc])
end.
find_app(AppName, AppVsn, AppMeta) ->
case ec_lists:find(fun(App) ->
NAppName = rlx_app_info:name(App),
NAppVsn = rlx_app_info:vsn(App),
AppName == NAppName andalso
AppVsn == NAppVsn
end, AppMeta) of
{ok, Head} ->
Head;
error ->
?RLX_ERROR({could_not_find, {AppName, AppVsn}})
end.
|
