Introduce admin mode

Author: homeworkprod

CHANGELOG.md

@@ -3,6 +3,9 @@
 
 ## 0.10.0 (unreleased)
 
+- Introduced admin mode. Can be entered in multi-user mode using tags which can
+  be configured in the new `admin` section.
+
 - Renamed configuration section `user` to `single_user` for clarity.
 
 - Renamed configuration property `id` in section `single_user` to `user_id` for

config_example.toml

@@ -43,6 +43,11 @@ button4 = "mystery-zone"
     "willkommen-in-der-mystery-zone",
 ]
 
+#[admin]
+#tags = [
+#    "0123456789",
+#]
+
 # Uncomment and provide user ID to enable single-user mode.
 #[single_user]
 #user_id = "00000000-0000-0000-0000-000000000000"

src/audio.rs

@@ -70,6 +70,8 @@ fn load_source(path: &Path) -> Result<Decoder<BufReader<File>>> {
 }
 
 pub(crate) enum Sound {
+    AdminModeEntered,
+    AdminModeLeft,
     SignOnSuccessful,
     SignOnFailed,
     SignOffSuccessful,
@@ -84,6 +86,8 @@ pub(crate) enum Sound {
 impl Sound {
     pub fn get_name(&self) -> String {
         match self {
+            Sound::AdminModeEntered => "admin_mode_entered".to_owned(),
+            Sound::AdminModeLeft => "admin_mode_left".to_owned(),
             Sound::SignOnSuccessful => "sign_on_successful".to_owned(),
             Sound::SignOnFailed => "sign_on_failed".to_owned(),
             Sound::SignOffSuccessful => "sign_off_successful".to_owned(),

src/client.rs

@@ -3,6 +3,7 @@
  * License: MIT
  */
 
+use std::collections::HashSet;
 use std::path::PathBuf;
 
 use anyhow::Result;
@@ -26,6 +27,7 @@ pub(crate) struct Client {
     audio_player: AudioPlayer,
     random: Random,
     user_mode: UserMode,
+    admin_tags: HashSet<Tag>,
     api_client: ApiClient,
     party_config: PartyConfig,
     event_receiver: EventReceiver,
@@ -35,6 +37,7 @@ impl Client {
     pub(crate) fn new(
         sounds_path: PathBuf,
         user_mode: UserMode,
+        admin_tags: HashSet<Tag>,
         api_config: &ApiConfig,
         party_config: PartyConfig,
         event_receiver: EventReceiver,
@@ -43,6 +46,7 @@ impl Client {
             audio_player: AudioPlayer::new(sounds_path)?,
             random: Random::new(),
             user_mode,
+            admin_tags,
             api_client: ApiClient::new(api_config, party_config.party_id.clone()),
             party_config,
             event_receiver,
@@ -119,9 +123,8 @@ impl Client {
             Event::ButtonPressed { button } => {
                 log::debug!("Button pressed: {:?}", button);
 
-                // Submit if user has identified; ignore if no user has
-                // been specified.
                 match current_user {
+                    CurrentUser::Admin => self.handle_button_press_by_admin(button)?,
                     CurrentUser::User(user_id) => {
                         self.handle_button_press_with_identified_user(user_id, button)?
                     }
@@ -166,6 +169,12 @@ impl Client {
     }
 
     fn handle_tag_read(&self, tag: &Tag) -> Result<EventHandlingResult> {
+        if self.admin_tags.contains(tag) {
+            self.play_sound(Sound::AdminModeEntered);
+            log::info!("Entering admin mode.");
+            return Ok(EventHandlingResult::SetCurrentUser(CurrentUser::Admin));
+        }
+
         log::debug!("Requesting details for tag {} ...", tag.value);
         match self.api_client.get_tag_details(tag) {
             Ok(details) => match details {
@@ -204,6 +213,21 @@ impl Client {
         }
     }
 
+    fn handle_button_press_by_admin(&self, button: Button) -> Result<EventHandlingResult> {
+        Ok(match button {
+            Button::Button1 => {
+                // Leave admin mode.
+                log::info!("Leaving admin mode.");
+                self.play_sound(Sound::AdminModeLeft);
+                EventHandlingResult::ResetCurrentUser
+            }
+            _ => {
+                // Stay in admin mode.
+                EventHandlingResult::KeepCurrentUser
+            }
+        })
+    }
+
     fn handle_button_press_with_identified_user(
         &self,
         user_id: &UserId,

src/config.rs

@@ -3,7 +3,7 @@
  * License: MIT
  */
 
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
 use std::fs::read_to_string;
 use std::path::{Path, PathBuf};
 
@@ -13,7 +13,7 @@ use serde::Deserialize;
 use crate::buttons::Button;
 use crate::devices::DeviceName;
 use crate::keycodenames::KeyName;
-use crate::model::{PartyId, UserId, UserMode};
+use crate::model::{PartyId, Tag, UserId, UserMode};
 
 #[derive(Deserialize)]
 pub(crate) struct Config {
@@ -26,10 +26,21 @@ pub(crate) struct Config {
     pub sounds_path: PathBuf,
     pub api: ApiConfig,
     pub party: PartyConfig,
+    pub admin: Option<AdminConfig>,
     pub single_user: Option<SingleUserConfig>,
 }
 
 impl Config {
+    pub fn get_admin_tags(&self) -> HashSet<Tag> {
+        self.admin
+            .as_ref()
+            .and_then(|admin_config| admin_config.tags.clone())
+            .unwrap_or_default()
+            .into_iter()
+            .map(|s| Tag { value: s })
+            .collect()
+    }
+
     pub fn get_user_mode(&self) -> UserMode {
         self.single_user
             .as_ref()
@@ -54,6 +65,11 @@ pub(crate) struct PartyConfig {
     pub whereabouts_sounds: HashMap<String, Vec<String>>,
 }
 
+#[derive(Deserialize)]
+pub(crate) struct AdminConfig {
+    pub tags: Option<HashSet<String>>,
+}
+
 #[derive(Deserialize)]
 pub(crate) struct SingleUserConfig {
     pub user_id: Option<UserId>,

src/main.rs

@@ -57,6 +57,8 @@ fn main() -> Result<()> {
 fn run(config_filename: PathBuf) -> Result<()> {
     let config = config::load_config(&config_filename)?;
 
+    let admin_tags = config.get_admin_tags();
+
     let user_mode = config.get_user_mode();
     match user_mode {
         UserMode::SingleUser(ref id) => {
@@ -86,7 +88,14 @@ fn run(config_filename: PathBuf) -> Result<()> {
         tx3,
     )?;
 
-    let client = Client::new(sounds_path, user_mode, &config.api, config.party, rx)?;
+    let client = Client::new(
+        sounds_path,
+        user_mode,
+        admin_tags,
+        &config.api,
+        config.party,
+        rx,
+    )?;
     client.run()
 }
 

src/model.rs

@@ -3,6 +3,7 @@
  * License: MIT
  */
 
+#[derive(Eq, Hash, PartialEq)]
 pub(crate) struct Tag {
     pub value: String,
 }
@@ -19,5 +20,6 @@ pub(crate) enum UserMode {
 #[derive(Clone)]
 pub(crate) enum CurrentUser {
     None,
+    Admin,
     User(UserId),
 }