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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2009-2013. All Rights Reserved.
%%
%% The contents of this file are subject to the Erlang Public License,
%% Version 1.1, (the "License"); you may not use this file except in
%% compliance with the License. You should have received a copy of the
%% Erlang Public License along with this software. If not, it can be
%% retrieved online at http://www.erlang.org/.
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and limitations
%% under the License.
%%
%% %CopyrightEnd%
%%
%%
-module(ssh_shell).
-include("ssh_connect.hrl").
%%% As this is an user interactive client it behaves like a daemon
%%% channel inspite of it being a client.
-behaviour(ssh_daemon_channel).
%% ssh_channel callbacks
-export([init/1, handle_msg/2, handle_ssh_msg/2, terminate/2]).
%% Spawn export
-export([input_loop/2]).
-record(state,
{
io, %% Io process
channel, %% Id of the ssh channel
cm %% Ssh connection manager
}
).
%%====================================================================
%% ssh_channel callbacks
%%====================================================================
%%--------------------------------------------------------------------
%% Function: init(Args) -> {ok, State}
%%
%% Description: Initiates the CLI
%%--------------------------------------------------------------------
init([ConnectionManager, ChannelId] = Args) ->
%% Make sure that we are proclib compatible as
%% this client should be runnable from the
%% erlang shell.
case get('$initial_call') of
undefined ->
Me = get_my_name(),
Ancestors = get_ancestors(),
put('$ancestors', [Me | Ancestors]),
put('$initial_call', {?MODULE, init, Args});
_ ->
ok
end,
case ssh_connection:shell(ConnectionManager, ChannelId) of
ok ->
{group_leader, GIO} =
process_info(self(), group_leader),
IoPid = spawn_link(?MODULE, input_loop,
[GIO, self()]),
{ok, #state{io = IoPid,
channel = ChannelId,
cm = ConnectionManager}};
Error ->
{stop, Error}
end.
%%--------------------------------------------------------------------
%% Function: handle_ssh_msg(Args) -> {ok, State} | {stop, ChannelId, State}
%%
%% Description: Handles channel messages received on the ssh-connection.
%%--------------------------------------------------------------------
handle_ssh_msg({ssh_cm, _, {data, _ChannelId, 0, Data}}, State) ->
%% TODO: When unicode support is ready
%% should we call this function or perhaps a new
%% function.
io:put_chars(Data),
{ok, State};
handle_ssh_msg({ssh_cm, _,
{data, _ChannelId, ?SSH_EXTENDED_DATA_STDERR, Data}},
State) ->
%% TODO: When unicode support is ready
%% should we call this function or perhaps a new
%% function.
io:put_chars(Data),
{ok, State};
handle_ssh_msg({ssh_cm, _, {eof, _ChannelId}}, State) ->
{ok, State};
handle_ssh_msg({ssh_cm, _, {signal, _, _}}, State) ->
%% Ignore signals according to RFC 4254 section 6.9.
{ok, State};
handle_ssh_msg({ssh_cm, _, {exit_signal, ChannelId, _, Error, _}}, State) ->
io:put_chars("Connection closed by peer"),
%% TODO: When unicode support is ready
%% should we call this function or perhaps a new
%% function. The error is encoded as UTF-8!
io:put_chars(Error),
{stop, ChannelId, State};
handle_ssh_msg({ssh_cm, _, {exit_status, ChannelId, 0}}, State) ->
io:put_chars("logout"),
io:put_chars("Connection closed"),
{stop, ChannelId, State};
handle_ssh_msg({ssh_cm, _, {exit_status, ChannelId, Status}}, State) ->
io:put_chars("Connection closed by peer"),
io:put_chars("Status: " ++ integer_to_list(Status)),
{stop, ChannelId, State}.
%%--------------------------------------------------------------------
%% Function: handle_msg(Args) -> {ok, State} | {stop, ChannelId, State}
%%
%% Description: Handles other channel messages
%%--------------------------------------------------------------------
handle_msg({ssh_channel_up, ChannelId, ConnectionManager},
#state{channel = ChannelId,
cm = ConnectionManager} = State) ->
{ok, State};
handle_msg({input, IoPid, eof}, #state{io = IoPid, channel = ChannelId,
cm = ConnectionManager} = State) ->
ssh_connection:send_eof(ConnectionManager, ChannelId),
{ok, State};
handle_msg({input, IoPid, Line}, #state{io = IoPid,
channel = ChannelId,
cm = ConnectionManager} = State) ->
ssh_connection:send(ConnectionManager, ChannelId, Line),
{ok, State}.
%%--------------------------------------------------------------------
%% Function: terminate(Reasons, State) -> _
%%
%% Description: Cleanup when shell channel is terminated
%%--------------------------------------------------------------------
terminate(_Reason, #state{io = IoPid}) ->
exit(IoPid, kill).
%%--------------------------------------------------------------------
%%% Internal functions
%%--------------------------------------------------------------------
input_loop(Fd, Pid) ->
case io:get_line(Fd, '>') of
eof ->
Pid ! {input, self(), eof},
ok;
Line ->
Pid ! {input, self(), Line},
input_loop (Fd, Pid)
end.
get_my_name() ->
case process_info(self(),registered_name) of
{registered_name,Name} -> Name;
_ -> self()
end.
get_ancestors() ->
case get('$ancestors') of
A when is_list(A) -> A;
_ -> []
end.
|
