aboutsummaryrefslogblamecommitdiffstats
path: root/src/rcl_prv_discover.erl
blob: 56085ace17410147d6df7238627662dfe41daf12 (plain) (tree)
1
                                                                         























                                                                               



                         
                          
 

                                            






                                                                              

                                                                                
                                                                 


                                                 
                        


                                                                       


                                                                                                    


                         


                 
 




                                                                              



                                                                      
                                                                
                 

                                    
                                                    
 

                                         
                                                             
               
                     
                



                                                          

        

                                                              

                                                                          







                                                                
                                               






                                                                         
                                                 
        
 

                                                         
                                                                         

                         








                                                                        
                

                                                                          
                       
                           
                        
                      

               
%% -*- 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.
%%%
%%% @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_error/1]).

-include_lib("relcool/include/relcool.hrl").

%%============================================================================
%% API
%%============================================================================
-spec init(rcl_state:t()) -> {ok, rcl_state:t()}.
init(State) ->
    {ok, State}.

%% @doc recursively dig down into the library directories specified in the state
%% looking for OTP Applications
-spec do(rcl_state:t()) -> {ok, rcl_state:t()} | relcool:error().
do(State0) ->
    LibDirs = get_lib_dirs(State0),
    case rcl_app_discovery:do(State0, LibDirs) of
        {ok, AppMeta} ->
            case rcl_rel_discovery:do(State0, LibDirs, AppMeta) of
                {ok, Releases} ->
                    State1 = rcl_state:available_apps(State0, AppMeta),
                    {ok, rcl_state:realized_releases(State1, lists:foldl(fun add/2,
                                                                         ec_dictionary:new(ec_dict),
                                                                         Releases))};
                Error ->
                    Error
            end;
        Error ->
            Error
    end.

%% @doc this is here to comply with the signature. However, we do not actually
%% produce any errors and so simply return an empty string.
-spec format_error(any()) -> iolist().
format_error(_) ->
    "".

%%%===================================================================
%%% Internal Functions
%%%===================================================================
%% @doc only add the release if its not documented in the system
add(Rel, Dict) ->
    RelName = rcl_release:name(Rel),
    RelVsn = rcl_release:vsn(Rel),
    ec_dictionary:add({RelName, RelVsn}, Rel, Dict).

get_lib_dirs(State) ->
    LibDirs0 = rcl_state:lib_dirs(State),
    case rcl_state:get(State, disable_default_libs, false) of
        true ->
            LibDirs0;
        false ->
            lists:flatten([LibDirs0,
                           add_common_project_dirs(State),
                           add_system_lib_dir(State),
                           add_release_output_dir(State)])
    end.

-spec add_common_project_dirs(rcl_state:t()) -> [file:name()].
add_common_project_dirs(State) ->
    %% Check to see if there is a rebar.config. If so then look for a deps
    %% dir. If both are there then we add that to the lib dirs.
    case rcl_state:get(State, disable_project_subdirs, false) of
        true ->
            [];
        false ->
            Root = rcl_state:root_dir(State),
            Apps = filename:join(Root, "apps"),
            Lib = filename:join(Root, "lib"),
            Deps = filename:join(Root, "deps"),
            Ebin = filename:join(Root, "ebin"),
            lists:foldl(fun(Dir, LibDirs) ->
                                case ec_file:exists(Dir) of
                            true ->
                                [erlang:iolist_to_binary(Dir) | LibDirs];
                            false ->
                                LibDirs
                        end
                end, [], [Deps, Lib, Apps, Ebin])
    end.

-spec add_system_lib_dir(rcl_state:t()) -> [file:name()].
add_system_lib_dir(State) ->
    ExcludeSystem = rcl_state:get(State, discover_exclude_system, false),
    case ExcludeSystem of
        true ->
            [];
        false ->
            erlang:iolist_to_binary(code:lib_dir())
    end.

add_release_output_dir(State) ->
    case rcl_state:get(State, disable_discover_release_output, false) of
        true ->
            [];
        false ->
            Output = erlang:iolist_to_binary(rcl_state:output_dir(State)),
            case ec_file:exists(erlang:binary_to_list(Output)) of
                true ->
                    Output;
                false ->
                    []
            end
    end.