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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
use super::{Context, Module, RootModuleConfig};
use crate::configs::username::UsernameConfig;
use crate::formatter::StringFormatter;
#[cfg(not(target_os = "windows"))]
const USERNAME_ENV_VAR: &str = "USER";
#[cfg(target_os = "windows")]
const USERNAME_ENV_VAR: &str = "USERNAME";
/// Creates a module with the current user's username
///
/// Will display the username if any of the following criteria are met:
/// - The current user is root (UID = 0) [1]
/// - The current user isn't the same as the one that is logged in (`$LOGNAME` != `$USER`) [2]
/// - The user is currently connected as an SSH session (`$SSH_CONNECTION`) [3]
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
let username = context.get_env(USERNAME_ENV_VAR)?;
let mut module = context.new_module("username");
let config: UsernameConfig = UsernameConfig::try_load(module.config);
let is_root = is_root_user();
let show_username = config.show_always
|| is_root // [1]
|| !is_login_user(&context, &username) // [2]
|| is_ssh_session(&context); // [3]
if !show_username {
return None;
}
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
formatter
.map_style(|variable| match variable {
"style" => {
let module_style = if is_root {
config.style_root
} else {
config.style_user
};
Some(Ok(module_style))
}
_ => None,
})
.map(|variable| match variable {
"user" => Some(Ok(&username)),
_ => None,
})
.parse(None)
});
module.set_segments(match parsed {
Ok(segments) => segments,
Err(error) => {
log::warn!("Error in module `username`:\n{}", error);
return None;
}
});
Some(module)
}
fn is_login_user(context: &Context, username: &str) -> bool {
context
.get_env("LOGNAME")
.map(|logname| logname == username)
.unwrap_or(true)
}
#[cfg(target_os = "windows")]
fn is_root_user() -> bool {
false
}
#[cfg(not(target_os = "windows"))]
fn is_root_user() -> bool {
nix::unistd::geteuid() == nix::unistd::ROOT
}
fn is_ssh_session(context: &Context) -> bool {
let ssh_env = ["SSH_CONNECTION", "SSH_CLIENT", "SSH_TTY"];
ssh_env.iter().any(|env| context.get_env_os(env).is_some())
}
#[cfg(test)]
mod tests {
use crate::test::ModuleRenderer;
// TODO: Add tests for if root user (UID == 0)
// Requires mocking
#[test]
fn no_env_variables() {
let actual = ModuleRenderer::new("username").collect();
let expected = None;
assert_eq!(expected, actual);
}
#[test]
#[ignore]
fn no_logname_env_variable() {
let actual = ModuleRenderer::new("username")
.env(super::USERNAME_ENV_VAR, "astronaut")
.collect();
let expected = None;
assert_eq!(expected, actual);
}
#[test]
#[ignore]
fn logname_equals_user() {
let actual = ModuleRenderer::new("username")
.env("LOGNAME", "astronaut")
.env(super::USERNAME_ENV_VAR, "astronaut")
.collect();
let expected = None;
assert_eq!(expected, actual);
}
#[test]
fn ssh_wo_username() {
// SSH connection w/o username
let actual = ModuleRenderer::new("username")
.env("SSH_CONNECTION", "192.168.223.17 36673 192.168.223.229 22")
.collect();
let expected = None;
assert_eq!(expected, actual);
}
#[test]
fn current_user_not_logname() {
let actual = ModuleRenderer::new("username")
.env("LOGNAME", "astronaut")
.env(super::USERNAME_ENV_VAR, "cosmonaut")
// Test output should not change when run by root/non-root user
.config(toml::toml! {
[username]
style_root = ""
style_user = ""
})
.collect();
let expected = Some("cosmonaut in ");
assert_eq!(expected, actual.as_deref());
}
#[test]
fn ssh_connection() {
let actual = ModuleRenderer::new("username")
.env(super::USERNAME_ENV_VAR, "astronaut")
.env("SSH_CONNECTION", "192.168.223.17 36673 192.168.223.229 22")
// Test output should not change when run by root/non-root user
.config(toml::toml! {
[username]
style_root = ""
style_user = ""
})
.collect();
let expected = Some("astronaut in ");
assert_eq!(expected, actual.as_deref());
}
#[test]
fn ssh_connection_tty() {
let actual = ModuleRenderer::new("username")
.env(super::USERNAME_ENV_VAR, "astronaut")
.env("SSH_TTY", "/dev/pts/0")
// Test output should not change when run by root/non-root user
.config(toml::toml! {
[username]
style_root = ""
style_user = ""
})
.collect();
let expected = Some("astronaut in ");
assert_eq!(expected, actual.as_deref());
}
#[test]
fn ssh_connection_client() {
let actual = ModuleRenderer::new("username")
.env(super::USERNAME_ENV_VAR, "astronaut")
.env("SSH_CLIENT", "192.168.0.101 39323 22")
// Test output should not change when run by root/non-root user
.config(toml::toml! {
[username]
style_root = ""
style_user = ""
})
.collect();
let expected = Some("astronaut in ");
assert_eq!(expected, actual.as_deref());
}
#[test]
fn show_always() {
let actual = ModuleRenderer::new("username")
.env(super::USERNAME_ENV_VAR, "astronaut")
// Test output should not change when run by root/non-root user
.config(toml::toml! {
[username]
show_always = true
style_root = ""
style_user = ""
})
.collect();
let expected = Some("astronaut in ");
assert_eq!(expected, actual.as_deref());
}
}
|
