settings/intl/
intl_controller.rs

1// Copyright 2019 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::base::{Merge, SettingInfo, SettingType};
6use crate::handler::base::Request;
7use crate::handler::setting_handler::persist::{controller as data_controller, ClientProxy};
8use crate::handler::setting_handler::{
9    controller, ControllerError, IntoHandlerResult, SettingHandlerResult,
10};
11use crate::intl::types::{HourCycle, IntlInfo, LocaleId, TemperatureUnit};
12use async_trait::async_trait;
13use settings_storage::device_storage::{DeviceStorage, DeviceStorageCompatible};
14use settings_storage::fidl_storage::FidlStorageConvertible;
15use settings_storage::storage_factory::{NoneT, StorageAccess};
16use std::collections::HashSet;
17use {fuchsia_trace as ftrace, rust_icu_uenum as uenum, rust_icu_uloc as uloc};
18
19impl DeviceStorageCompatible for IntlInfo {
20    type Loader = NoneT;
21    const KEY: &'static str = "intl_info";
22}
23
24impl FidlStorageConvertible for IntlInfo {
25    type Storable = fidl_fuchsia_settings::IntlSettings;
26    type Loader = NoneT;
27    const KEY: &'static str = "intl";
28
29    fn to_storable(self) -> Self::Storable {
30        self.into()
31    }
32
33    fn from_storable(storable: Self::Storable) -> Self {
34        storable.into()
35    }
36}
37
38impl Default for IntlInfo {
39    fn default() -> Self {
40        IntlInfo {
41            // `-x-fxdef` is a private use extension and a special marker denoting that the
42            // setting is a fallback default, and not actually set through any user action.
43            locales: Some(vec![LocaleId { id: "en-US-x-fxdef".to_string() }]),
44            temperature_unit: Some(TemperatureUnit::Celsius),
45            time_zone_id: Some("UTC".to_string()),
46            hour_cycle: Some(HourCycle::H12),
47        }
48    }
49}
50
51impl From<IntlInfo> for SettingInfo {
52    fn from(info: IntlInfo) -> SettingInfo {
53        SettingInfo::Intl(info)
54    }
55}
56
57pub struct IntlController {
58    client: ClientProxy,
59    time_zone_ids: std::collections::HashSet<String>,
60}
61
62impl StorageAccess for IntlController {
63    type Storage = DeviceStorage;
64    type Data = IntlInfo;
65    const STORAGE_KEY: &'static str = <IntlInfo as DeviceStorageCompatible>::KEY;
66}
67
68#[async_trait(?Send)]
69impl data_controller::Create for IntlController {
70    async fn create(client: ClientProxy) -> Result<Self, ControllerError> {
71        let time_zone_ids = IntlController::load_time_zones();
72        Ok(IntlController { client, time_zone_ids })
73    }
74}
75
76#[async_trait(?Send)]
77impl controller::Handle for IntlController {
78    async fn handle(&self, request: Request) -> Option<SettingHandlerResult> {
79        match request {
80            Request::SetIntlInfo(info) => Some(self.set(info).await),
81            Request::Get => Some(
82                self.client
83                    .read_setting_info::<IntlInfo>(ftrace::Id::new())
84                    .await
85                    .into_handler_result(),
86            ),
87            _ => None,
88        }
89    }
90}
91
92/// Controller for processing requests surrounding the Intl protocol, backed by a number of
93/// services, including TimeZone.
94impl IntlController {
95    /// Loads the set of valid time zones from resources.
96    fn load_time_zones() -> std::collections::HashSet<String> {
97        let _icu_data_loader = icu_data::Loader::new().expect("icu data loaded");
98
99        let time_zone_list = match uenum::open_time_zones() {
100            Ok(time_zones) => time_zones,
101            Err(err) => {
102                log::error!("Unable to load time zones: {:?}", err);
103                return HashSet::new();
104            }
105        };
106
107        time_zone_list.flatten().collect()
108    }
109
110    async fn set(&self, info: IntlInfo) -> SettingHandlerResult {
111        self.validate_intl_info(info.clone())?;
112
113        let id = ftrace::Id::new();
114        let current = self.client.read_setting::<IntlInfo>(id).await;
115        self.client.write_setting(current.merge(info).into(), id).await.into_handler_result()
116    }
117
118    #[allow(clippy::result_large_err)] // TODO(https://fxbug.dev/42069089)
119    /// Checks if the given IntlInfo is valid.
120    fn validate_intl_info(&self, info: IntlInfo) -> Result<(), ControllerError> {
121        if let Some(time_zone_id) = info.time_zone_id {
122            // Make sure the given time zone ID is valid.
123            if !self.time_zone_ids.contains(time_zone_id.as_str()) {
124                return Err(ControllerError::InvalidArgument(
125                    SettingType::Intl,
126                    "timezone id".into(),
127                    time_zone_id.into(),
128                ));
129            }
130        }
131
132        if let Some(time_zone_locale) = info.locales {
133            for locale in time_zone_locale {
134                // NB: `try_from` doesn't actually do validation, `for_language_tag` does but doesn't
135                // actually generate an error, it just ends up falling back to an empty string.
136                let loc = uloc::ULoc::for_language_tag(locale.id.as_str());
137                match loc {
138                    Ok(parsed) => {
139                        if parsed.label().is_empty() {
140                            log::error!("Locale is invalid: {:?}", locale.id);
141                            return Err(ControllerError::InvalidArgument(
142                                SettingType::Intl,
143                                "locale id".into(),
144                                locale.id.into(),
145                            ));
146                        }
147                    }
148                    Err(err) => {
149                        log::error!("Error loading locale: {:?}", err);
150                        return Err(ControllerError::InvalidArgument(
151                            SettingType::Intl,
152                            "locale id".into(),
153                            locale.id.into(),
154                        ));
155                    }
156                }
157            }
158        }
159
160        Ok(())
161    }
162}
settings/intl/intl_controller.rs

settings/intl/
intl_controller.rs
