form.rs 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. use crate::file_data::FileEngine;
  2. use crate::file_data::HasFileData;
  3. use std::ops::Deref;
  4. use std::{collections::HashMap, fmt::Debug};
  5. use dioxus_core::Event;
  6. pub type FormEvent = Event<FormData>;
  7. /// A form value that may either be a list of values or a single value
  8. #[cfg_attr(
  9. feature = "serialize",
  10. derive(serde::Serialize, serde::Deserialize),
  11. // this will serialize Text(String) -> String and VecText(Vec<String>) to Vec<String>
  12. serde(untagged)
  13. )]
  14. #[derive(Debug, Clone, PartialEq)]
  15. pub enum FormValue {
  16. Text(String),
  17. VecText(Vec<String>),
  18. }
  19. impl From<FormValue> for Vec<String> {
  20. fn from(value: FormValue) -> Self {
  21. match value {
  22. FormValue::Text(s) => vec![s],
  23. FormValue::VecText(vec) => vec,
  24. }
  25. }
  26. }
  27. impl Deref for FormValue {
  28. type Target = [String];
  29. fn deref(&self) -> &Self::Target {
  30. self.as_slice()
  31. }
  32. }
  33. impl FormValue {
  34. /// Convenient way to represent Value as slice
  35. pub fn as_slice(&self) -> &[String] {
  36. match self {
  37. FormValue::Text(s) => std::slice::from_ref(s),
  38. FormValue::VecText(vec) => vec.as_slice(),
  39. }
  40. }
  41. /// Convert into Vec<String>
  42. pub fn to_vec(self) -> Vec<String> {
  43. self.into()
  44. }
  45. }
  46. /* DOMEvent: Send + SyncTarget relatedTarget */
  47. pub struct FormData {
  48. inner: Box<dyn HasFormData>,
  49. }
  50. impl<E: HasFormData> From<E> for FormData {
  51. fn from(e: E) -> Self {
  52. Self { inner: Box::new(e) }
  53. }
  54. }
  55. impl PartialEq for FormData {
  56. fn eq(&self, other: &Self) -> bool {
  57. self.value() == other.value() && self.values() == other.values()
  58. }
  59. }
  60. impl Debug for FormData {
  61. fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  62. f.debug_struct("FormEvent")
  63. .field("value", &self.value())
  64. .field("values", &self.values())
  65. .finish()
  66. }
  67. }
  68. impl FormData {
  69. /// Create a new form event
  70. pub fn new(event: impl HasFormData + 'static) -> Self {
  71. Self {
  72. inner: Box::new(event),
  73. }
  74. }
  75. /// Get the value of the form event
  76. pub fn value(&self) -> String {
  77. self.inner.value()
  78. }
  79. /// Try to parse the value as a boolean
  80. ///
  81. /// Returns false if the value is not a boolean, or if it is false!
  82. /// Does not verify anything about the event itself, use with caution
  83. pub fn checked(&self) -> bool {
  84. self.value().parse().unwrap_or(false)
  85. }
  86. /// Get the values of the form event
  87. pub fn values(&self) -> HashMap<String, FormValue> {
  88. self.inner.values()
  89. }
  90. /// Get the files of the form event
  91. pub fn files(&self) -> Option<std::sync::Arc<dyn FileEngine>> {
  92. self.inner.files()
  93. }
  94. /// Downcast this event to a concrete event type
  95. pub fn downcast<T: 'static>(&self) -> Option<&T> {
  96. self.inner.as_any().downcast_ref::<T>()
  97. }
  98. }
  99. /// An object that has all the data for a form event
  100. pub trait HasFormData: HasFileData + std::any::Any {
  101. fn value(&self) -> String {
  102. Default::default()
  103. }
  104. fn values(&self) -> HashMap<String, FormValue> {
  105. Default::default()
  106. }
  107. /// return self as Any
  108. fn as_any(&self) -> &dyn std::any::Any;
  109. }
  110. impl FormData {
  111. #[cfg(feature = "serialize")]
  112. /// Parse the values into a struct with one field per value
  113. pub fn parsed_values<T>(&self) -> Result<T, serde_json::Error>
  114. where
  115. T: serde::de::DeserializeOwned,
  116. {
  117. use serde::Serialize;
  118. fn convert_hashmap_to_json<K, V>(hashmap: &HashMap<K, V>) -> serde_json::Result<String>
  119. where
  120. K: Serialize + std::hash::Hash + Eq,
  121. V: Serialize,
  122. {
  123. serde_json::to_string(hashmap)
  124. }
  125. let parsed_json =
  126. convert_hashmap_to_json(&self.values()).expect("Failed to parse values to JSON");
  127. serde_json::from_str(&parsed_json)
  128. }
  129. }
  130. #[cfg(feature = "serialize")]
  131. /// A serialized form data object
  132. #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Clone)]
  133. pub struct SerializedFormData {
  134. value: String,
  135. values: HashMap<String, FormValue>,
  136. files: Option<crate::file_data::SerializedFileEngine>,
  137. }
  138. #[cfg(feature = "serialize")]
  139. impl SerializedFormData {
  140. /// Create a new serialized form data object
  141. pub fn new(
  142. value: String,
  143. values: HashMap<String, FormValue>,
  144. files: Option<crate::file_data::SerializedFileEngine>,
  145. ) -> Self {
  146. Self {
  147. value,
  148. values,
  149. files,
  150. }
  151. }
  152. /// Create a new serialized form data object from a traditional form data object
  153. pub async fn async_from(data: &FormData) -> Self {
  154. Self {
  155. value: data.value(),
  156. values: data.values(),
  157. files: match data.files() {
  158. Some(files) => {
  159. let mut resolved_files = HashMap::new();
  160. for file in files.files() {
  161. let bytes = files.read_file(&file).await;
  162. resolved_files.insert(file, bytes.unwrap_or_default());
  163. }
  164. Some(crate::file_data::SerializedFileEngine {
  165. files: resolved_files,
  166. })
  167. }
  168. None => None,
  169. },
  170. }
  171. }
  172. fn from_lossy(data: &FormData) -> Self {
  173. Self {
  174. value: data.value(),
  175. values: data.values(),
  176. files: None,
  177. }
  178. }
  179. }
  180. #[cfg(feature = "serialize")]
  181. impl HasFormData for SerializedFormData {
  182. fn value(&self) -> String {
  183. self.value.clone()
  184. }
  185. fn values(&self) -> HashMap<String, FormValue> {
  186. self.values.clone()
  187. }
  188. fn as_any(&self) -> &dyn std::any::Any {
  189. self
  190. }
  191. }
  192. #[cfg(feature = "serialize")]
  193. impl HasFileData for SerializedFormData {
  194. fn files(&self) -> Option<std::sync::Arc<dyn FileEngine>> {
  195. self.files
  196. .as_ref()
  197. .map(|files| std::sync::Arc::new(files.clone()) as _)
  198. }
  199. }
  200. #[cfg(feature = "serialize")]
  201. impl serde::Serialize for FormData {
  202. fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
  203. SerializedFormData::from_lossy(self).serialize(serializer)
  204. }
  205. }
  206. #[cfg(feature = "serialize")]
  207. impl<'de> serde::Deserialize<'de> for FormData {
  208. fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
  209. let data = SerializedFormData::deserialize(deserializer)?;
  210. Ok(Self {
  211. inner: Box::new(data),
  212. })
  213. }
  214. }
  215. impl_event! {
  216. FormData;
  217. /// onchange
  218. onchange
  219. /// oninput handler
  220. oninput
  221. /// oninvalid
  222. oninvalid
  223. /// onreset
  224. onreset
  225. /// onsubmit
  226. onsubmit
  227. }