Add command to change user-agent

Author: antoyo

config/config

@@ -10,3 +10,6 @@ search-engine wikipedia http://en.wikipedia.org/w/index.php?search={}
 set hint-chars = hjklasdfgyuiopqwertnmzxcvb
 
 set cookie-accept = always
+
+# User agents.
+add-user-agent firefox Mozilla/5.0 (X11; Linux x86_64; rv:63.0) Gecko/20100101 Firefox/63.0

src/app/mod.rs

@@ -42,6 +42,7 @@ mod search_engine;
 mod server;
 mod test_utils;
 mod url;
+pub mod user_agent;
 
 use std::cell::Cell;
 use std::collections::HashMap;
@@ -105,7 +106,12 @@ use titanium_common::Percentage::{self, All, Percent};
 use bookmarks::BookmarkManager;
 use commands::AppCommand;
 use commands::AppCommand::*;
-use completers::{BookmarkCompleter, FileCompleter, TagCompleter};
+use completers::{
+    BookmarkCompleter,
+    FileCompleter,
+    TagCompleter,
+    UserAgentCompleter,
+};
 use config_dir::ConfigDir;
 use download_list_view::DownloadListView;
 use download_list_view::Msg::{
@@ -120,11 +126,13 @@ use self::config::default_config;
 use self::dialog::handle_script_dialog;
 use self::file_chooser::handle_file_chooser;
 use self::Msg::*;
+use self::user_agent::UserAgentManager;
 use settings::AppSettings;
 use settings::AppSettingsVariant::{
     self,
     HintChars,
     HomePage,
+    WebkitUserAgent,
 };
 use urls::canonicalize_url;
 use webview::WebView;
@@ -159,6 +167,7 @@ const INIT_SCROLL_TEXT: &str = "[top]";
 const RED: RGBA = RGBA { red: 1.0, green: 0.3, blue: 0.2, alpha: 1.0 };
 const YELLOW: RGBA = RGBA { red: 1.0, green: 1.0, blue: 0.0, alpha: 1.0 };
 const TAG_COMPLETER: &str = "__tag";
+pub const USER_AGENT_COMPLETER: &str = "select-user-agent";
 
 static MODES: Modes = &[
     Mode { name: "follow", prefix: "f", show_count: false },
@@ -186,6 +195,8 @@ pub struct Model {
     scroll_text: String,
     search_engines: HashMap<String, String>,
     title: String,
+    user_agents: HashMap<String, String>,
+    user_agent_manager: UserAgentManager,
     web_context: WebContext,
 }
 
@@ -300,6 +311,8 @@ impl Widget for App {
             scroll_text: INIT_SCROLL_TEXT.to_string(),
             search_engines: HashMap::new(),
             title: APP_NAME.to_string(),
+            user_agents: HashMap::new(),
+            user_agent_manager: UserAgentManager,
             web_context,
         }
     }
@@ -408,6 +421,7 @@ impl Widget for App {
                 "win-open" => Box::new(BookmarkCompleter::new("win-open")),
                 "private-win-open" => Box::new(BookmarkCompleter::new("private-win-open")),
                 TAG_COMPLETER => Box::new(TagCompleter::new()),
+                USER_AGENT_COMPLETER => Box::new(UserAgentCompleter::new()),
             },
             DarkTheme: true,
             Title: self.model.title.clone(),
@@ -462,6 +476,14 @@ impl App {
         self.mg.emit(Info(format!("Added mark {}", mark as char)));
     }
 
+    fn add_user_agent(&mut self, user_agent: &str) {
+        let mut params = user_agent.splitn(2, ' ');
+        if let (Some(name), Some(user_agent)) = (params.next(), params.next()) {
+            self.model.user_agents.insert(name.to_string(), user_agent.to_string());
+            self.model.user_agent_manager.add(name);
+        }
+    }
+
     fn adjust_in_follow_mode(&mut self, mode: &str) {
         self.model.in_follow_mode.set(mode == "follow");
     }
@@ -555,6 +577,7 @@ impl App {
         match *command {
             ActivateSelection => self.activate_selection(),
             AdblockUpdate => handle_error!(self.adblock_update()),
+            AddUserAgent(ref user_agent) => self.add_user_agent(user_agent),
             Back => self.history_back(),
             BackwardSearch(ref input) => {
                 self.webview.emit(SearchBackward(true));
@@ -617,6 +640,7 @@ impl App {
             SearchEngine(ref args) => self.add_search_engine(args),
             SearchNext => self.webview.emit(PageSearchNext),
             SearchPrevious => self.webview.emit(PageSearchPrevious),
+            SelectUserAgent(ref name) => self.select_user_agent(name),
             Stop => self.webview.widget().stop_loading(),
             UrlIncrement => self.url_increment(),
             UrlDecrement => self.url_decrement(),
@@ -762,6 +786,13 @@ impl App {
         }
     }
 
+    fn select_user_agent(&mut self, name: &str) {
+        if let Some(user_agent) = self.model.user_agents.get(name).cloned() {
+            self.info(format!("Set user agent to: {}", user_agent));
+            self.setting_changed(WebkitUserAgent(user_agent));
+        }
+    }
+
     fn set_mode(&mut self, mode: &'static str) {
         self.adjust_in_follow_mode(mode);
         self.mg.emit(SetMode(mode));

src/app/user_agent.rs

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2018 Boucher, Antoni <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+use std::cell::Cell;
+use std::rc::Rc;
+
+thread_local! {
+    static MANAGER: Rc<Cell<Vec<String>>> = Rc::new(Cell::new(vec![]));
+}
+
+pub struct UserAgentManager;
+
+impl UserAgentManager {
+    pub fn add(&self, name: &str) {
+        MANAGER.with(|key| {
+            let mut names = key.take();
+            names.push(name.to_string());
+            key.set(names);
+        })
+    }
+
+    pub fn get_all(&self) -> Vec<String> {
+        MANAGER.with(|key| {
+            let names = key.take();
+            let result = names.clone();
+            key.set(names);
+            result
+        })
+    }
+}

src/commands.rs

@@ -25,6 +25,8 @@ pub enum AppCommand {
     ActivateSelection,
     #[help(text="Update the host file used by the adblocker")]
     AdblockUpdate,
+    #[help(text="Add a new user agent")]
+    AddUserAgent(String),
     #[help(text="Go back in the history")]
     Back,
     #[special_command(incremental, identifier="?")]
@@ -139,6 +141,8 @@ pub enum AppCommand {
     SearchNext,
     #[completion(hidden)]
     SearchPrevious,
+    #[help(text="Select a user agent by name")]
+    SelectUserAgent(String),
     #[help(text="Stop loading the current page")]
     Stop,
     #[completion(hidden)]

src/completers.rs

@@ -26,6 +26,8 @@ use std::path::{Path, PathBuf};
 use mg::completion::{Completer, CompletionCell, CompletionResult};
 use mg::completion::Column::{self, AllVisible, Expand};
 
+use app::USER_AGENT_COMPLETER;
+use app::user_agent::UserAgentManager;
 use bookmarks::{BookmarkInput, BookmarkManager};
 use download::download_dir;
 
@@ -238,6 +240,40 @@ impl Completer for TagCompleter {
     }
 }
 
+/// A user agent completer.
+pub struct UserAgentCompleter {
+    manager: UserAgentManager,
+}
+
+impl UserAgentCompleter {
+    pub fn new() -> Self {
+        Self {
+            manager: UserAgentManager,
+        }
+    }
+}
+
+impl Completer for UserAgentCompleter {
+    fn columns(&self) -> Vec<Column> {
+        vec![AllVisible]
+    }
+
+    fn complete_result(&self, value: &str) -> String {
+        format!("{} {}", USER_AGENT_COMPLETER, value)
+    }
+
+    fn completions(&mut self, input: &str) -> Vec<CompletionResult> {
+        let mut results = vec![];
+        let names = self.manager.get_all();
+        for name in names {
+            if name.contains(input) {
+                results.push(CompletionResult::new(&[&name]));
+            }
+        }
+        results
+    }
+}
+
 /// Split at whitespaces and at the # character.
 /// The # character will be kept in the words while the spaces are dropped.
 fn split_whitespace_and_hash(input: &str) -> Vec<String> {

src/main.rs

@@ -79,8 +79,6 @@
  * TODO: shortcut to insert the password in insert mode?
  * TODO: shortcut to open in the same window.
  *
- * FIXME: web extension panics with newer webkit2gtk-webextension crate.
- *
  * FIXME: slow startup (The update function was slow to execute for message NewApp: 1943ms).
  * Perhaps should init table and cleanup download folder in another thread.
  *
@@ -92,7 +90,6 @@
  *
  * FIXME: config file marks not created.
  *
- * TODO: set user agent.
  * TODO: may need to enable fullscreen API (in config) to allow real fullscreen.
  * Most probably needs to hide the status bar in the signal enter_fullscreen.
  *
@@ -139,6 +136,7 @@
  *
  * TODO: Command to know which pages are in which process:
  * * to check whether the pages are distributed evenly between the processes.
+ * * maybe to know if a process is stuck.
  *
  * TODO: hide HTML in title/bookmarks?
  *
@@ -179,13 +177,11 @@
  * TODO: webkit_web_view_get_main_resource() to get source code
  * TODO: Show hints on elements with an ID (to be able to navigate to their anchor).
  *
- * FIXME: angular form needs the typing action to be done in order to submit: https://grafana.int.adgear.com/
+ * FIXME: angular form needs the typing action to be done in order to submit: https://www.codingame.com/start
  *
  * FIXME: seems slower when running as normal user (and faster as root), so perhaps the config slow
  * it down. Looks like it is slowed down by the hard drive.
  *
- * TODO: switch to relm-epoll, a crate that polls epoll from glib.
- *
  * TODO: plugin to hide disqus.
  *
  * TODO: downloading a non-existing file (http://download.microsoft.com/download/8/8/8/888f34b7-4f54-4f06-8dac-fa29b19f33dd/msxml3.msi) causes an error.

titanium-web-extension/src/login_form.rs

@@ -123,6 +123,11 @@ fn get_login_form(document: &DOMDocument) -> Option<DOMHTMLFormElement> {
 
 /// Load the password in the login form.
 pub fn load_password(document: &DOMDocument, password: &str) {
+    // TODO: trigger change event (https://stackoverflow.com/questions/23892547/what-is-the-best-way-to-trigger-onchange-event-in-react-js/46012210#46012210):
+    // var nativeInputValueSetter = Object.getOwnPropertyDescriptor(window.HTMLInputElement.prototype, "value").set;
+    // nativeInputValueSetter.call(element, 'react 16 value');
+    // var ev2 = new Event('input', { bubbles: true});
+    // element.dispatchEvent(ev2);
     let password_inputs =
         find_login_form(document)
             .and_then(|login_form| login_form.query_selector_all("input[type='password']").ok());
@@ -141,6 +146,7 @@ pub fn load_password(document: &DOMDocument, password: &str) {
 
 /// Load the username in the login form.
 pub fn load_username(document: &DOMDocument, username: &str) {
+    // TODO: trigger change event:
     let username_inputs =
         find_login_form(document)
             .and_then(|login_form|