Move user input logic into servoshell (#30238)

* cleanup and move user input logix into servoshell

* fix fmt

* moves test from servoshell file

* move command-line args into servoshell

* remove feature media-gstreamer

* fix fmt

* move user input logic code into lib to make it more testable

* remove opts_matches in fn instead get it from main2

* remove pub and fix import

* add licence in new file

* revert passing Matches, instead pass Option String

* review update, also move sanitize fn to parser file

* fmt fix

* review fix: remove extra line

ports/servoshell/Cargo.toml

@@ -65,6 +65,7 @@ surfman = { workspace = true, features = ["sm-x11", "sm-raw-window-handle"] }
 tinyfiledialogs = "3.0"
 webxr = { git = "https://github.com/servo/webxr", features = ["ipc", "glwindow", "headless"] }
 winit = "0.28.6"
+url = { workspace = true }
 
 [target.'cfg(any(target_os = "linux", target_os = "windows"))'.dependencies]
 image = { workspace = true }

ports/servoshell/app.rs

@@ -8,23 +8,21 @@ use crate::browser::Browser;
 use crate::embedder::EmbedderCallbacks;
 use crate::events_loop::{EventsLoop, WakerEvent};
 use crate::minibrowser::Minibrowser;
+use crate::parser::get_default_url;
 use crate::window_trait::WindowPortsMethods;
 use crate::{headed_window, headless_window};
 use gleam::gl;
-use winit::window::WindowId;
-use winit::event_loop::EventLoopWindowTarget;
 use servo::compositing::windowing::EmbedderEvent;
-use servo::config::opts::{self, parse_url_or_filename};
+use servo::config::opts;
 use servo::servo_config::pref;
-use servo::servo_url::ServoUrl;
 use servo::Servo;
 use std::cell::{Cell, RefCell, RefMut};
 use std::collections::HashMap;
-use std::env;
-
 use std::rc::Rc;
 use surfman::GLApi;
 use webxr::glwindow::GlWindowDiscovery;
+use winit::window::WindowId;
+use winit::event_loop::EventLoopWindowTarget;
 
 pub struct App {
     servo: Option<Servo<dyn WindowPortsMethods>>,
@@ -46,6 +44,7 @@ impl App {
         no_native_titlebar: bool,
         device_pixels_per_px: Option<f32>,
         user_agent: Option<String>,
+        url: Option<String>,
     ) {
         let events_loop = EventsLoop::new(opts::get().headless, opts::get().output_file.is_some());
 
@@ -63,6 +62,7 @@ impl App {
 
         // Handle browser state.
         let browser = Browser::new(window.clone());
+        let initial_url = get_default_url(url);
 
         let mut app = App {
             event_queue: RefCell::new(vec![]),
@@ -139,7 +139,7 @@ impl App {
                     // is ready to present, so that we can paint the minibrowser then present.
                     servo.set_external_present(app.minibrowser.is_some());
 
-                    servo.handle_events(vec![EmbedderEvent::NewBrowser(get_default_url(), servo_data.browser_id)]);
+                    servo.handle_events(vec![EmbedderEvent::NewBrowser(initial_url.to_owned(), servo_data.browser_id)]);
                     servo.setup_logging();
 
                     app.windows.insert(window.id(), window.clone());
@@ -341,17 +341,3 @@ impl App {
         self.minibrowser.as_ref().map(|x| x.borrow_mut())
     }
 }
-
-fn get_default_url() -> ServoUrl {
-    // If the url is not provided, we fallback to the homepage in prefs,
-    // or a blank page in case the homepage is not set either.
-    let cwd = env::current_dir().unwrap();
-    let cmdline_url = opts::get().url.clone();
-    let pref_url = {
-        let homepage_url = pref!(shell.homepage);
-        parse_url_or_filename(&cwd, &homepage_url).ok()
-    };
-    let blank_url = ServoUrl::parse("about:blank").ok();
-
-    cmdline_url.or(pref_url).or(blank_url).unwrap()
-}

ports/servoshell/browser.rs

@@ -3,6 +3,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
 use crate::keyutils::{CMD_OR_ALT, CMD_OR_CONTROL};
+use crate::parser::sanitize_url;
 use crate::window_trait::{WindowPortsMethods, LINE_HEIGHT};
 use arboard::Clipboard;
 use euclid::{Point2D, Vector2D};
@@ -14,10 +15,8 @@ use servo::embedder_traits::{
 };
 use servo::msg::constellation_msg::TopLevelBrowsingContextId as BrowserId;
 use servo::msg::constellation_msg::TraversalDirection;
-use servo::net_traits::pub_domains::is_reg_domain;
 use servo::script_traits::TouchEventType;
 use servo::servo_config::opts;
-use servo::servo_config::pref;
 use servo::servo_url::ServoUrl;
 use servo::webrender_api::ScrollLocation;
 use std::env;
@@ -634,23 +633,6 @@ fn get_selected_files(patterns: Vec<FilterPattern>, multiple_files: bool) -> Opt
         .expect("Thread spawning failed")
 }
 
-fn sanitize_url(request: &str) -> Option<ServoUrl> {
-    let request = request.trim();
-    ServoUrl::parse(request)
-        .ok()
-        .or_else(|| {
-            if request.contains('/') || is_reg_domain(request) {
-                ServoUrl::parse(&format!("https://{}", request)).ok()
-            } else {
-                None
-            }
-        })
-        .or_else(|| {
-            let url = pref!(shell.searchpage).replace("%s", request);
-            ServoUrl::parse(&url).ok()
-        })
-}
-
 // This is a mitigation for #25498, not a verified solution.
 // There may be codepaths in tinyfiledialog.c that this is
 // inadquate against, as it passes the string via shell to

ports/servoshell/main2.rs

@@ -10,6 +10,9 @@ extern crate log;
 #[macro_use]
 extern crate sig;
 
+#[cfg(test)]
+mod test;
+
 mod app;
 mod backtrace;
 mod browser;
@@ -21,6 +24,7 @@ mod headed_window;
 mod headless_window;
 mod keyutils;
 mod minibrowser;
+mod parser;
 mod prefs;
 mod resources;
 mod window_trait;
@@ -164,7 +168,13 @@ pub fn main() {
 
     let user_agent = opts_matches.opt_str("u");
 
-    App::run(do_not_use_native_titlebar, device_pixels_per_px, user_agent);
+    let url_opt = if !opts_matches.free.is_empty() {
+        Some(&opts_matches.free[0][..])
+    } else {
+        None
+    };
+
+    App::run(do_not_use_native_titlebar, device_pixels_per_px, user_agent, url_opt.map(|s| s.to_string()));
 
     platform::deinit(clean_shutdown)
 }

ports/servoshell/parser.rs

@@ -0,0 +1,61 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+
+use std::env;
+use std::path::Path;
+use log::warn;
+use servo::net_traits::pub_domains::is_reg_domain;
+use servo::servo_config::pref;
+use servo::servo_url::ServoUrl;
+use url::{self, Url};
+
+pub fn parse_url_or_filename(cwd: &Path, input: &str) -> Result<ServoUrl, ()> {
+    match ServoUrl::parse(input) {
+        Ok(url) => Ok(url),
+        Err(url::ParseError::RelativeUrlWithoutBase) => {
+            Url::from_file_path(&*cwd.join(input)).map(ServoUrl::from_url)
+        },
+        Err(_) => Err(()),
+    }
+}
+
+pub fn get_default_url(url_opt: Option<String>) -> ServoUrl {
+    // If the url is not provided, we fallback to the homepage in prefs,
+    // or a blank page in case the homepage is not set either.
+    let cwd = env::current_dir().unwrap();
+
+    let cmdline_url = url_opt.map(|s| s.to_string()).and_then(|url_string| {
+        parse_url_or_filename(&cwd, &url_string)
+            .map_err(|error| {
+                warn!("URL parsing failed ({:?}).", error);
+                error
+            })
+            .ok()
+    });
+
+    let pref_url = {
+        let homepage_url = pref!(shell.homepage);
+        parse_url_or_filename(&cwd, &homepage_url).ok()
+    };
+    let blank_url = ServoUrl::parse("about:blank").ok();
+
+    cmdline_url.or(pref_url).or(blank_url).unwrap()
+}
+
+pub fn sanitize_url(request: &str) -> Option<ServoUrl> {
+    let request = request.trim();
+    ServoUrl::parse(request)
+        .ok()
+        .or_else(|| {
+            if request.contains('/') || is_reg_domain(request) {
+                ServoUrl::parse(&format!("https://{}", request)).ok()
+            } else {
+                None
+            }
+        })
+        .or_else(|| {
+            let url = pref!(shell.searchpage).replace("%s", request);
+            ServoUrl::parse(&url).ok()
+        })
+}

ports/servoshell/test.rs

@@ -0,0 +1,86 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+
+use std::path::Path;
+use crate::parser::parse_url_or_filename;
+
+#[cfg(not(target_os = "windows"))]
+const FAKE_CWD: &'static str = "/fake/cwd";
+
+#[cfg(target_os = "windows")]
+const FAKE_CWD: &'static str = "C:/fake/cwd";
+
+#[test]
+fn test_argument_parsing() {
+    let fake_cwd = Path::new(FAKE_CWD);
+    assert!(parse_url_or_filename(fake_cwd, "http://example.net:invalid").is_err());
+
+    let url = parse_url_or_filename(fake_cwd, "http://example.net").unwrap();
+    assert_eq!(url.scheme(), "http");
+
+    let url = parse_url_or_filename(fake_cwd, "file:///foo/bar.html").unwrap();
+    assert_eq!(url.scheme(), "file");
+    assert_eq!(
+        url.path_segments().unwrap().collect::<Vec<_>>(),
+        ["foo", "bar.html"]
+    );
+}
+
+#[test]
+#[cfg(not(target_os = "windows"))]
+fn test_file_path_parsing() {
+    let fake_cwd = Path::new(FAKE_CWD);
+
+    let url = parse_url_or_filename(fake_cwd, "bar.html").unwrap();
+    assert_eq!(url.scheme(), "file");
+    assert_eq!(
+        url.path_segments().unwrap().collect::<Vec<_>>(),
+        ["fake", "cwd", "bar.html"]
+    );
+}
+
+#[test]
+#[cfg(target_os = "windows")]
+fn test_file_path_parsing() {
+    let fake_cwd = Path::new(FAKE_CWD);
+
+    let url = parse_url_or_filename(fake_cwd, "bar.html").unwrap();
+    assert_eq!(url.scheme(), "file");
+    assert_eq!(
+        url.path_segments().unwrap().collect::<Vec<_>>(),
+        ["C:", "fake", "cwd", "bar.html"]
+    );
+}
+
+#[test]
+#[cfg(not(target_os = "windows"))]
+// Windows file paths can't contain ?
+fn test_argument_parsing_special() {
+    let fake_cwd = Path::new(FAKE_CWD);
+
+    // '?' and '#' have a special meaning in URLs...
+    let url = parse_url_or_filename(fake_cwd, "file:///foo/bar?baz#buzz.html").unwrap();
+    assert_eq!(&*url.to_file_path().unwrap(), Path::new("/foo/bar"));
+    assert_eq!(url.scheme(), "file");
+    assert_eq!(
+        url.path_segments().unwrap().collect::<Vec<_>>(),
+        ["foo", "bar"]
+    );
+    assert_eq!(url.query(), Some("baz"));
+    assert_eq!(url.fragment(), Some("buzz.html"));
+
+    // but not in file names.
+    let url = parse_url_or_filename(fake_cwd, "./bar?baz#buzz.html").unwrap();
+    assert_eq!(
+        &*url.to_file_path().unwrap(),
+        Path::new("/fake/cwd/bar?baz#buzz.html")
+    );
+    assert_eq!(url.scheme(), "file");
+    assert_eq!(
+        url.path_segments().unwrap().collect::<Vec<_>>(),
+        ["fake", "cwd", "bar%3Fbaz%23buzz.html"]
+    );
+    assert_eq!(url.query(), None);
+    assert_eq!(url.fragment(), None);
+}