servo: Merge #5430 - Allow passing a path to --userscripts (from Manishearth:userscript_path); r=kmcallister

r? @kmcallister

Source-Repo: https://github.com/servo/servo
Source-Revision: afbc51a746af79f3daf14d77002a47967ef3d38e

servo/components/script/dom/htmlheadelement.rs

@@ -3,22 +3,16 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 use dom::bindings::codegen::Bindings::HTMLHeadElementBinding;
-use dom::bindings::codegen::Bindings::NodeBinding::NodeMethods;
+use dom::bindings::codegen::InheritTypes::{HTMLElementCast, HTMLHeadElementDerived};
-use dom::bindings::codegen::Bindings::DocumentBinding::DocumentMethods;
+use dom::bindings::js::{JSRef, Temporary};
-use dom::bindings::codegen::InheritTypes::{HTMLElementCast, HTMLHeadElementDerived, NodeCast};
-use dom::bindings::js::{JSRef, OptionalRootable, Temporary, RootedReference};
 use dom::document::Document;
 use dom::eventtarget::{EventTarget, EventTargetTypeId};
 use dom::element::ElementTypeId;
-use dom::element::AttributeHandlers;
 use dom::htmlelement::{HTMLElement, HTMLElementTypeId};
-use dom::node::{Node, NodeHelpers, NodeTypeId};
+use dom::node::{Node, NodeTypeId};
+use dom::userscripts::load_script;
 use dom::virtualmethods::VirtualMethods;
 use util::str::DOMString;
-use util::opts;
-use util::resource_files::resources_dir_path;
-use std::borrow::ToOwned;
-use std::fs::read_dir;
 
 #[dom_struct]
 pub struct HTMLHeadElement {
@@ -51,34 +45,6 @@ impl<'a> VirtualMethods for JSRef<'a, HTMLHeadElement> {
         Some(htmlelement as &VirtualMethods)
     }
     fn bind_to_tree(&self, _tree_in_doc: bool) {
-        if !opts::get().userscripts {
+        load_script(*self);
-            return;
-        }
-
-        let node: &JSRef<Node> = NodeCast::from_borrowed_ref(self);
-        let first_child = node.GetFirstChild().root();
-        let doc = node.owner_doc().root();
-        let doc = doc.r();
-
-        let mut path = resources_dir_path();
-        path.push("user-agent-js");
-        let mut files = match read_dir(&path) {
-            Ok(d) => d.filter_map(|e| e.ok()).map(|e| e.path()).collect::<Vec<_>>(),
-            Err(_) => return
-        };
-
-        files.sort();
-
-        for file in files {
-            let name = match file.into_os_string().into_string() {
-                Ok(ref s) if s.ends_with(".js") => "file://".to_owned() + &s[..],
-                _ => continue
-            };
-            let new_script = doc.CreateElement("script".to_owned()).unwrap().root();
-            let new_script = new_script.r();
-            new_script.set_string_attribute(&atom!("src"), name);
-            let new_script_node: &JSRef<Node> = NodeCast::from_borrowed_ref(&new_script);
-            node.InsertBefore(*new_script_node, first_child.r()).unwrap();
-        }
     }
 }

servo/components/script/dom/mod.rs

@@ -317,6 +317,7 @@ pub mod treewalker;
 pub mod uievent;
 pub mod urlhelper;
 pub mod urlsearchparams;
+pub mod userscripts;
 pub mod validitystate;
 pub mod virtualmethods;
 pub mod websocket;

servo/components/script/dom/userscripts.rs

@@ -0,0 +1,52 @@
+/* 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 http://mozilla.org/MPL/2.0/. */
+
+use dom::bindings::codegen::Bindings::NodeBinding::NodeMethods;
+use dom::bindings::codegen::Bindings::DocumentBinding::DocumentMethods;
+use dom::bindings::codegen::InheritTypes::NodeCast;
+use dom::bindings::js::{JSRef, OptionalRootable, RootedReference};
+use dom::element::AttributeHandlers;
+use dom::htmlheadelement::HTMLHeadElement;
+use dom::node::{Node, NodeHelpers};
+use util::opts;
+use util::resource_files::resources_dir_path;
+use std::borrow::ToOwned;
+use std::fs::read_dir;
+use std::path::PathBuf;
+
+
+pub fn load_script(head: JSRef<HTMLHeadElement>) {
+    if let Some(ref path_str) = opts::get().userscripts {
+        let node: &JSRef<Node> = NodeCast::from_borrowed_ref(&head);
+        let first_child = node.GetFirstChild().root();
+        let doc = node.owner_doc().root();
+        let doc = doc.r();
+
+        let path = if &**path_str == "" {
+            let mut p = resources_dir_path();
+            p.push("user-agent-js");
+            p
+        } else {
+            PathBuf::new(path_str)
+        };
+
+        let mut files = read_dir(&path).ok().expect("Bad path passed to --userscripts")
+                                       .filter_map(|e| e.ok())
+                                       .map(|e| e.path()).collect::<Vec<_>>();
+
+        files.sort();
+
+        for file in files {
+            let name = match file.into_os_string().into_string() {
+                Ok(ref s) if s.ends_with(".js") => "file://".to_owned() + &s[..],
+                _ => continue
+            };
+            let new_script = doc.CreateElement("script".to_owned()).unwrap().root();
+            let new_script = new_script.r();
+            new_script.set_string_attribute(&atom!("src"), name);
+            let new_script_node: &JSRef<Node> = NodeCast::from_borrowed_ref(&new_script);
+            node.InsertBefore(*new_script_node, first_child.r()).unwrap();
+        }
+    }
+}

servo/components/util/opts.rs

@@ -59,7 +59,11 @@ pub struct Opts {
     pub nonincremental_layout: bool,
 
     pub nossl: bool,
-    pub userscripts: bool,
+
+    /// Where to load userscripts from, if any. An empty string will load from
+    /// the resources/user-agent-js directory, and if the option isn't passed userscripts
+    /// won't be loaded
+    pub userscripts: Option<String>,
 
     pub output_file: Option<String>,
     pub headless: bool,
@@ -183,7 +187,7 @@ pub fn default_opts() -> Opts {
         layout_threads: 1,
         nonincremental_layout: false,
         nossl: false,
-        userscripts: false,
+        userscripts: None,
         output_file: None,
         headless: true,
         hard_fail: true,
@@ -224,7 +228,7 @@ pub fn from_cmdline_args(args: &[String]) -> bool {
         getopts::optopt("y", "layout-threads", "Number of threads to use for layout", "1"),
         getopts::optflag("i", "nonincremental-layout", "Enable to turn off incremental layout."),
         getopts::optflag("", "no-ssl", "Disables ssl certificate verification."),
-        getopts::optflag("", "userscripts", "Uses userscripts in resources/user-agent-js"),
+        getopts::optflagopt("", "userscripts", "Uses userscripts in resources/user-agent-js, or a specified full path",""),
         getopts::optflag("z", "headless", "Headless mode"),
         getopts::optflag("f", "hard-fail", "Exit on task failure instead of displaying about:failure"),
         getopts::optflagopt("", "devtools", "Start remote devtools server on port", "6000"),
@@ -301,7 +305,6 @@ pub fn from_cmdline_args(args: &[String]) -> bool {
 
     let nonincremental_layout = opt_match.opt_present("i");
     let nossl = opt_match.opt_present("no-ssl");
-    let userscripts = opt_match.opt_present("userscripts");
 
     let mut bubble_inline_sizes_separately = debug_options.contains(&"bubble-widths");
     let trace_layout = debug_options.contains(&"trace-layout");
@@ -337,7 +340,7 @@ pub fn from_cmdline_args(args: &[String]) -> bool {
         layout_threads: layout_threads,
         nonincremental_layout: nonincremental_layout,
         nossl: nossl,
-        userscripts: userscripts,
+        userscripts: opt_match.opt_default("userscripts", ""),
         output_file: opt_match.opt_str("o"),
         headless: opt_match.opt_present("z"),
         hard_fail: opt_match.opt_present("f"),