1
// Licensed to the Software Freedom Conservancy (SFC) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The SFC licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17

18
use crate::config::ManagerConfig;
19
use crate::downloads::parse_json_from_url;
20
use crate::files::{compose_driver_path_in_cache, BrowserPath};
21
use crate::{
22
    create_http_client, parse_version, Logger, SeleniumManager, OFFLINE_REQUEST_ERR_MSG,
23
    REG_VERSION_ARG, STABLE, WINDOWS,
24
};
25
use anyhow::anyhow;
26
use anyhow::Error;
27
use reqwest::Client;
28
use std::collections::HashMap;
29
use std::path::PathBuf;
30
use std::sync::mpsc;
31
use std::sync::mpsc::{Receiver, Sender};
32

33
use crate::metadata::{
34
    create_driver_metadata, get_driver_version_from_metadata, get_metadata, write_metadata,
35
};
36
use crate::mirror::{Assets, SeleniumRelease, MIRROR_URL};
37

38
pub const IE_NAMES: &[&str] = &[
39
    "iexplorer",
40
    "ie",
41
    "internetexplorer",
42
    "internet explorer",
43
    "internet-explorer",
44
    "internet_explorer",
45
];
46
pub const IEDRIVER_NAME: &str = "IEDriverServer";
47
const DRIVER_URL: &str = "https://github.com/SeleniumHQ/selenium/releases/";
48
const IEDRIVER_RELEASE: &str = "IEDriverServer_Win32_";
49

50
pub struct IExplorerManager {
51
    pub browser_name: &'static str,
52
    pub driver_name: &'static str,
53
    pub config: ManagerConfig,
54
    pub http_client: Client,
55
    pub log: Logger,
56
    pub tx: Sender<String>,
57
    pub rx: Receiver<String>,
58
    pub download_browser: bool,
59
    pub driver_url: Option<String>,
60
}
61

62
impl IExplorerManager {
63
    pub fn new() -> Result<Box<Self>, Error> {
64
        let browser_name = IE_NAMES[0];
65
        let driver_name = IEDRIVER_NAME;
66
        let mut config = ManagerConfig::default(browser_name, driver_name);
67
        let default_timeout = config.timeout.to_owned();
68
        let default_proxy = &config.proxy;
69
        config.os = WINDOWS.to_str_vector().first().unwrap().to_string();
70
        let (tx, rx): (Sender<String>, Receiver<String>) = mpsc::channel();
71
        Ok(Box::new(IExplorerManager {
72
            browser_name,
73
            driver_name,
74
            http_client: create_http_client(default_timeout, default_proxy)?,
75
            config,
76
            log: Logger::new(),
77
            tx,
78
            rx,
79
            download_browser: false,
80
            driver_url: None,
81
        }))
82
    }
83
}
84

85
impl SeleniumManager for IExplorerManager {
86
    fn get_browser_name(&self) -> &str {
87
        self.browser_name
88
    }
89

90
    fn get_browser_names_in_path(&self) -> Vec<&str> {
91
        vec![self.get_browser_name()]
92
    }
93

94
    fn get_http_client(&self) -> &Client {
95
        &self.http_client
96
    }
97

98
    fn set_http_client(&mut self, http_client: Client) {
99
        self.http_client = http_client;
100
    }
101

102
    fn get_browser_path_map(&self) -> HashMap<BrowserPath, &str> {
103
        HashMap::from([(
104
            BrowserPath::new(WINDOWS, STABLE),
105
            r"Internet Explorer\iexplore.exe",
106
        )])
107
    }
108

109
    fn discover_browser_version(&mut self) -> Result<Option<String>, Error> {
110
        self.general_discover_browser_version(
111
            r"HKEY_LOCAL_MACHINE\Software\Microsoft\Internet Explorer",
112
            REG_VERSION_ARG,
113
            "",
114
        )
115
    }
116

117
    fn get_driver_name(&self) -> &str {
118
        self.driver_name
119
    }
120

121
    fn request_driver_version(&mut self) -> Result<String, Error> {
122
        let major_browser_version_binding = self.get_major_browser_version();
123
        let major_browser_version = major_browser_version_binding.as_str();
124
        let cache_path = self.get_cache_path()?;
125
        let mut metadata = get_metadata(self.get_logger(), &cache_path);
126

127
        match get_driver_version_from_metadata(
128
            &metadata.drivers,
129
            self.driver_name,
130
            major_browser_version,
131
        ) {
132
            Some(driver_version) => {
133
                self.log.trace(format!(
134
                    "Driver TTL is valid. Getting {} version from metadata",
135
                    &self.driver_name
136
                ));
137
                Ok(driver_version)
138
            }
139
            _ => {
140
                self.assert_online_or_err(OFFLINE_REQUEST_ERR_MSG)?;
141

142
                let selenium_releases = parse_json_from_url::<Vec<SeleniumRelease>>(
143
                    self.get_http_client(),
144
                    MIRROR_URL,
145
                )?;
146

147
                let filtered_releases: Vec<SeleniumRelease> = selenium_releases
148
                    .into_iter()
149
                    .filter(|r| {
150
                        r.assets
151
                            .iter()
152
                            .any(|url| url.browser_download_url.contains(IEDRIVER_RELEASE))
153
                    })
154
                    .collect();
155

156
                if !filtered_releases.is_empty() {
157
                    let assets = &filtered_releases.first().unwrap().assets;
158
                    let driver_releases: Vec<&Assets> = assets
159
                        .iter()
160
                        .filter(|url| url.browser_download_url.contains(IEDRIVER_RELEASE))
161
                        .collect();
162
                    let driver_url = &driver_releases.last().unwrap().browser_download_url;
163
                    self.driver_url = Some(driver_url.to_string());
164

165
                    let index_release =
166
                        driver_url.rfind(IEDRIVER_RELEASE).unwrap() + IEDRIVER_RELEASE.len();
167
                    let driver_version = parse_version(
168
                        driver_url.as_str()[index_release..].to_string(),
169
                        self.get_logger(),
170
                    )?;
171

172
                    let driver_ttl = self.get_ttl();
173
                    if driver_ttl > 0 {
174
                        metadata.drivers.push(create_driver_metadata(
175
                            major_browser_version,
176
                            self.driver_name,
177
                            &driver_version,
178
                            driver_ttl,
179
                        ));
180
                        write_metadata(&metadata, self.get_logger(), cache_path);
181
                    }
182

183
                    Ok(driver_version)
184
                } else {
185
                    Err(anyhow!(format!(
186
                        "{} release not available",
187
                        self.get_driver_name()
188
                    )))
189
                }
190
            }
191
        }
192
    }
193

194
    fn request_browser_version(&mut self) -> Result<Option<String>, Error> {
195
        Ok(None)
196
    }
197

198
    fn get_driver_url(&mut self) -> Result<String, Error> {
199
        if self.driver_url.is_some() {
200
            return Ok(self.driver_url.as_ref().unwrap().to_string());
201
        }
202

203
        let release_version = self.get_selenium_release_version()?;
204
        Ok(format!(
205
            "{}download/{}/{}{}.zip",
206
            self.get_driver_mirror_url_or_default(DRIVER_URL),
207
            release_version,
208
            IEDRIVER_RELEASE,
209
            self.get_driver_version()
210
        ))
211
    }
212

213
    fn get_driver_path_in_cache(&self) -> Result<PathBuf, Error> {
214
        Ok(compose_driver_path_in_cache(
215
            self.get_cache_path()?.unwrap_or_default(),
216
            self.driver_name,
217
            "Windows",
218
            self.get_platform_label(),
219
            self.get_driver_version(),
220
        ))
221
    }
222

223
    fn get_config(&self) -> &ManagerConfig {
224
        &self.config
225
    }
226

227
    fn get_config_mut(&mut self) -> &mut ManagerConfig {
228
        &mut self.config
229
    }
230

231
    fn set_config(&mut self, config: ManagerConfig) {
232
        self.config = config;
233
    }
234

235
    fn get_logger(&self) -> &Logger {
236
        &self.log
237
    }
238

239
    fn set_logger(&mut self, log: Logger) {
240
        self.log = log;
241
    }
242

243
    fn get_sender(&self) -> &Sender<String> {
244
        &self.tx
245
    }
246

247
    fn get_receiver(&self) -> &Receiver<String> {
248
        &self.rx
249
    }
250

251
    fn get_platform_label(&self) -> &str {
252
        "win32"
253
    }
254

255
    fn request_latest_browser_version_from_online(
256
        &mut self,
257
        _browser_version: &str,
258
    ) -> Result<String, Error> {
259
        self.unavailable_download()
260
    }
261

262
    fn request_fixed_browser_version_from_online(
263
        &mut self,
264
        _browser_version: &str,
265
    ) -> Result<String, Error> {
266
        self.unavailable_download()
267
    }
268

269
    fn get_min_browser_version_for_download(&self) -> Result<i32, Error> {
270
        self.unavailable_download()
271
    }
272

273
    fn get_browser_binary_path(&mut self, _browser_version: &str) -> Result<PathBuf, Error> {
274
        self.unavailable_download()
275
    }
276

277
    fn get_browser_url_for_download(&mut self, _browser_version: &str) -> Result<String, Error> {
278
        self.unavailable_download()
279
    }
280

281
    fn get_browser_label_for_download(
282
        &self,
283
        _browser_version: &str,
284
    ) -> Result<Option<&str>, Error> {
285
        self.unavailable_download()
286
    }
287

288
    fn is_download_browser(&self) -> bool {
289
        self.download_browser
290
    }
291

292
    fn set_download_browser(&mut self, download_browser: bool) {
293
        self.download_browser = download_browser;
294
    }
295

296
    fn is_snap(&self, _browser_path: &str) -> bool {
297
        false
298
    }
299

300
    fn get_snap_path(&self) -> Option<PathBuf> {
301
        None
302
    }
303
}
304

305