//! ## AuthActivity //! //! `auth_activity` is the module which implements the authentication activity /* * * Copyright (C) 2020-2021 Christian Visintin - christian.visintin1997@gmail.com * * This file is part of "TermSCP" * * TermSCP is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * TermSCP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with TermSCP. If not, see . * */ // Sub modules mod bookmarks; mod update; mod view; // Dependencies extern crate crossterm; extern crate tui; // locals use super::{Activity, Context}; use crate::filetransfer::FileTransferProtocol; use crate::system::bookmarks_client::BookmarksClient; use crate::ui::context::FileTransferParams; use crate::ui::layout::view::View; use crate::utils::git; // Includes use crossterm::terminal::{disable_raw_mode, enable_raw_mode}; // -- components const COMPONENT_TEXT_HEADER: &str = "TEXT_HEADER"; const COMPONENT_TEXT_NEW_VERSION: &str = "TEXT_NEW_VERSION"; const COMPONENT_TEXT_FOOTER: &str = "TEXT_FOOTER"; const COMPONENT_TEXT_HELP: &str = "TEXT_HELP"; const COMPONENT_TEXT_ERROR: &str = "TEXT_ERROR"; const COMPONENT_INPUT_ADDR: &str = "INPUT_ADDRESS"; const COMPONENT_INPUT_PORT: &str = "INPUT_PORT"; const COMPONENT_INPUT_USERNAME: &str = "INPUT_USERNAME"; const COMPONENT_INPUT_PASSWORD: &str = "INPUT_PASSWORD"; const COMPONENT_INPUT_BOOKMARK_NAME: &str = "INPUT_BOOKMARK_NAME"; const COMPONENT_RADIO_PROTOCOL: &str = "RADIO_PROTOCOL"; const COMPONENT_RADIO_QUIT: &str = "RADIO_QUIT"; const COMPONENT_RADIO_BOOKMARK_DEL_BOOKMARK: &str = "RADIO_DELETE_BOOKMARK"; const COMPONENT_RADIO_BOOKMARK_DEL_RECENT: &str = "RADIO_DELETE_RECENT"; const COMPONENT_RADIO_BOOKMARK_SAVE_PWD: &str = "RADIO_SAVE_PASSWORD"; const COMPONENT_BOOKMARKS_LIST: &str = "BOOKMARKS_LIST"; const COMPONENT_RECENTS_LIST: &str = "RECENTS_LIST"; // Store keys const STORE_KEY_LATEST_VERSION: &str = "AUTH_LATEST_VERSION"; /// ### AuthActivity /// /// AuthActivity is the data holder for the authentication activity pub struct AuthActivity { pub submit: bool, // becomes true after user has submitted fields pub quit: bool, // Becomes true if user has pressed esc pub setup: bool, // Becomes true if user has requested setup context: Option, view: View, bookmarks_client: Option, redraw: bool, // Should ui actually be redrawned? bookmarks_list: Vec, // List of bookmarks recents_list: Vec, // list of recents } impl Default for AuthActivity { fn default() -> Self { Self::new() } } impl AuthActivity { /// ### new /// /// Instantiates a new AuthActivity pub fn new() -> AuthActivity { AuthActivity { submit: false, quit: false, setup: false, context: None, view: View::init(), bookmarks_client: None, redraw: true, // True at startup bookmarks_list: Vec::new(), recents_list: Vec::new(), } } /// ### on_create /// /// If enabled in configuration, check for updates from Github fn check_for_updates(&mut self) { // Check version only if unset in the store let ctx: &Context = self.context.as_ref().unwrap(); if !ctx.store.isset(STORE_KEY_LATEST_VERSION) { let mut new_version: Option = match ctx.config_client.as_ref() { Some(client) => { if client.get_check_for_updates() { // Send request match git::check_for_updates(env!("CARGO_PKG_VERSION")) { Ok(version) => version, Err(err) => { // Report error self.mount_error( format!("Could not check for new updates: {}", err).as_str(), ); // None None } } } else { None } } None => None, }; let ctx: &mut Context = self.context.as_mut().unwrap(); // Set version into the store (or just a flag) match new_version.take() { Some(new_version) => ctx.store.set_string(STORE_KEY_LATEST_VERSION, new_version), // If Some, set String None => ctx.store.set(STORE_KEY_LATEST_VERSION), // If None, just set flag } } } } impl Activity for AuthActivity { /// ### on_create /// /// `on_create` is the function which must be called to initialize the activity. /// `on_create` must initialize all the data structures used by the activity /// Context is taken from activity manager and will be released only when activity is destroyed fn on_create(&mut self, mut context: Context) { // Initialize file transfer params context.ft_params = Some(FileTransferParams::default()); // Set context self.context = Some(context); // Clear terminal self.context.as_mut().unwrap().clear_screen(); // Put raw mode on enabled let _ = enable_raw_mode(); // Init bookmarks client if self.bookmarks_client.is_none() { self.init_bookmarks_client(); } // Verify error state from context if let Some(err) = self.context.as_mut().unwrap().get_error() { self.mount_error(err.as_str()); } // If check for updates is enabled, check for updates self.check_for_updates(); // Initialize view self.init(); } /// ### on_draw /// /// `on_draw` is the function which draws the graphical interface. /// This function must be called at each tick to refresh the interface fn on_draw(&mut self) { // Context must be something if self.context.is_none() { return; } // Read one event if let Ok(Some(event)) = self.context.as_ref().unwrap().input_hnd.read_event() { // Set redraw to true self.redraw = true; // Handle event on view and update let msg = self.view.on(event); self.update(msg); } // Redraw if necessary if self.redraw { // View self.view(); // Set redraw to false self.redraw = false; } } /// ### on_destroy /// /// `on_destroy` is the function which cleans up runtime variables and data before terminating the activity. /// This function must be called once before terminating the activity. /// This function finally releases the context fn on_destroy(&mut self) -> Option { // Disable raw mode let _ = disable_raw_mode(); self.context.as_ref()?; // Clear terminal and return match self.context.take() { Some(mut ctx) => { ctx.clear_screen(); Some(ctx) } None => None, } } }