1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
use std::{
collections::HashMap,
fmt::{self, Write},
mem,
};
#[derive(Clone, Debug, PartialEq, Eq)]
/// key-value pairs inside of `Property`s
pub struct Parameter {
key: String,
val: String,
}
impl Parameter {
/// Creates a new `Parameter`
pub fn new(key: &str, val: &str) -> Self {
Parameter {
key: key.to_owned(),
val: val.to_owned(),
}
}
/// Returns a reference to the key field.
pub fn key(&self) -> &str {
&self.key
}
/// Returns a reference to the value field.
pub fn value(&self) -> &str {
&self.val
}
}
//type EntryParameters = Vec<Parameter>;
pub type EntryParameters = HashMap<String, Parameter>;
#[derive(Clone, Debug, PartialEq, Eq)]
/// key-value pairs inside of `Component`s
pub struct Property {
pub(crate) key: String,
pub(crate) val: String,
pub(crate) params: EntryParameters,
}
impl From<(&str, &str)> for Property {
fn from((key, val): (&str, &str)) -> Self {
Property::new(key, val)
}
}
impl Property {
/// Guess what this does :D
pub fn new(key: &str, val: &str) -> Self {
Property {
key: key.to_owned(),
val: val.replace('\n', "\\n"),
params: HashMap::new(),
}
}
/// if you already have `String`s I'll gladly take
pub fn new_pre_alloc(key: String, val: String) -> Self {
Property {
key,
val: val.replace('\n', "\\n"),
params: HashMap::new(),
}
}
/// Returns a reference to the key field.
pub fn key(&self) -> &str {
&self.key
}
/// Returns a reference to the value field.
pub fn value(&self) -> &str {
&self.val
}
/// Returns a reference to the parameters.
pub fn params(&self) -> &EntryParameters {
&self.params
}
/// Produces a `Vec` of `Property` from an array of other types.
pub fn from_array<P: Into<Property>, const N: usize>(array: [P; N]) -> Vec<Property> {
array.into_iter().map(Into::into).collect::<Vec<_>>()
}
/// Returns the `VALUE` parameter, if any is specified.
pub fn value_type(&self) -> Option<ValueType> {
ValueType::from_str(&self.params.get("VALUE")?.val)
}
// /// Returns the value as a certain type
// pub fn get_value<T>(&self) -> Result<T, E>
// where
// T: std::str::FromStr,
// E: std::error::Error,
// <T as std::str::FromStr::Err>: E
// {
// T::from_str(&self.val).ok()
// }
/// Returns the value as a certain type
pub fn get_value_as<F, T>(&self, converter: F) -> Option<T>
where
F: Fn(&str) -> Option<T>,
{
converter(&self.val)
}
/// Returns the value of a parameter as a certain type
pub fn get_param_as<F, T>(&self, key: &str, converter: F) -> Option<T>
where
F: Fn(&str) -> Option<T>,
{
self.params.get(key).and_then(|param| converter(¶m.val))
}
/// Appends a new parameter.
pub fn append_parameter<I: Into<Parameter>>(&mut self, into_parameter: I) -> &mut Self {
let parameter = into_parameter.into();
self.params.insert(parameter.key.clone(), parameter);
self
}
/// Creates and appends a parameter.
pub fn add_parameter(&mut self, key: &str, val: &str) -> &mut Self {
self.append_parameter(Parameter::new(key, val));
self
}
/// End of Builder Pattern.
pub fn done(&mut self) -> Self {
Property {
key: mem::take(&mut self.key),
val: mem::take(&mut self.val),
params: mem::take(&mut self.params),
}
}
/// Writes this Property to `out`
pub(crate) fn fmt_write<W: Write>(&self, out: &mut W) -> Result<(), fmt::Error> {
// A nice starting capacity for the majority of content lines
let mut line = String::with_capacity(150);
write!(line, "{}", self.key)?;
for Parameter { key, val: value } in self.params.values() {
write!(line, ";{}={}", key, value)?;
}
write!(line, ":{}", self.val)?;
write_crlf!(out, "{}", fold_line(&line))?;
Ok(())
}
}
impl TryInto<String> for Property {
type Error = std::fmt::Error;
fn try_into(self) -> Result<String, Self::Error> {
let mut out_string = String::new();
self.fmt_write(&mut out_string)?;
Ok(out_string)
}
}
/// This property defines the access classification for a calendar component.
/// [RFC 5545, Section 3.8.1.3](https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.3)
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum Class {
/// [`Public`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.3)
Public,
/// [`Private`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.3)
Private,
/// [`Confidential`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.3)
Confidential,
}
impl Class {
pub(crate) fn from_str(s: &str) -> Option<Self> {
match s {
"PUBLIC" => Some(Self::Public),
"PRIVATE" => Some(Self::Private),
"CONFIDENTIAL" => Some(Self::Confidential),
_ => None,
}
}
}
impl From<Class> for Property {
fn from(val: Class) -> Self {
Property {
key: String::from("CLASS"),
val: String::from(match val {
Class::Public => "PUBLIC",
Class::Private => "PRIVATE",
Class::Confidential => "CONFIDENTIAL",
}),
params: HashMap::new(),
}
}
}
/// see 8.3.4. [Value Data Types Registry](https://tools.ietf.org/html/rfc5545#section-8.3.4)
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum ValueType {
/// [`Binary`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.1)
Binary,
/// [`Boolean`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.2)
Boolean,
/// [`CalAddress`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.3)
CalAddress,
/// [`Date`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.4)
Date,
/// [`DateTime`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.5)
DateTime,
/// [`Duration`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6)
Duration,
/// [`Float`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.7)
Float,
/// [`Integer`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.8)
Integer,
/// [`Period`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.9)
Period,
/// [`Recur`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10)
Recur,
/// [`Text`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.11)
Text,
/// [`Time`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.12)
Time,
/// [`Uri`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.13)
Uri,
/// [`UtcOffset`](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.14)
UtcOffset,
}
impl ValueType {
pub(crate) fn from_str(s: &str) -> Option<Self> {
match s {
"BINARY" => Some(Self::Binary),
"BOOLEAN" => Some(Self::Boolean),
"CAL-ADDRESS" => Some(Self::CalAddress),
"DATE" => Some(Self::Date),
"DATE-TIME" => Some(Self::DateTime),
"DURATION" => Some(Self::Duration),
"FLOAT" => Some(Self::Float),
"INTEGER" => Some(Self::Integer),
"PERIOD" => Some(Self::Period),
"RECUR" => Some(Self::Recur),
"TEXT" => Some(Self::Text),
"TIME" => Some(Self::Time),
"URI" => Some(Self::Uri),
"UTC-OFFSET" => Some(Self::UtcOffset),
_ => None,
}
}
}
impl From<ValueType> for Parameter {
fn from(val: ValueType) -> Self {
Parameter {
key: String::from("VALUE"),
val: String::from(match val {
ValueType::Binary => "BINARY",
ValueType::Boolean => "BOOLEAN",
ValueType::CalAddress => "CAL-ADDRESS",
ValueType::Date => "DATE",
ValueType::DateTime => "DATE-TIME",
ValueType::Duration => "DURATION",
ValueType::Float => "FLOAT",
ValueType::Integer => "INTEGER",
ValueType::Period => "PERIOD",
ValueType::Recur => "RECUR",
ValueType::Text => "TEXT",
ValueType::Time => "TIME",
ValueType::Uri => "URI",
ValueType::UtcOffset => "UTC-OFFSET",
}),
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
/// Encodes the status of an `Event`
/// [RFC 5545, Section 3.8.1.11](https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.11)
pub enum EventStatus {
/// Indicates event is tentative.
Tentative,
/// Indicates event is definite.
Confirmed,
/// Indicates event was cancelled.
Cancelled,
//Custom(&str)
}
impl EventStatus {
pub(crate) fn from_str(s: &str) -> Option<Self> {
match s {
"TENTATIVE" => Some(Self::Tentative),
"CONFIRMED" => Some(Self::Confirmed),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
/// Encodes the status of a `Todo`
/// [RFC 5545, Section 3.8.1.11](https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.11)
pub enum TodoStatus {
/// Indicates to-do needs action.
NeedsAction,
/// Indicates to-do is completed.
Completed,
/// Indicates to-do is in process.
InProcess,
/// Indicates to-do was cancelled.
Cancelled,
//Custom(&str)
}
impl TodoStatus {
pub(crate) fn from_str(s: &str) -> Option<Self> {
match s {
"NEEDS-ACTION" => Some(Self::NeedsAction),
"COMPLETED" => Some(Self::Completed),
"IN-PROCESS" => Some(Self::InProcess),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
//pub enum JournalStatus{
// Draft,
// Final,
// Cancelled,
// Custom(&str)
//}
impl From<EventStatus> for Property {
fn from(val: EventStatus) -> Self {
Property {
key: String::from("STATUS"),
val: String::from(match val {
EventStatus::Tentative => "TENTATIVE",
EventStatus::Confirmed => "CONFIRMED",
EventStatus::Cancelled => "CANCELLED",
}),
params: HashMap::new(),
}
}
}
impl From<TodoStatus> for Property {
fn from(val: TodoStatus) -> Self {
Property::new_pre_alloc(
String::from("STATUS"),
String::from(match val {
TodoStatus::NeedsAction => "NEEDS-ACTION",
TodoStatus::Completed => "COMPLETED",
TodoStatus::InProcess => "IN-PROCESS",
TodoStatus::Cancelled => "CANCELLED",
//TodoStatus::Custom(s) => "CU",
}),
)
}
}
impl From<chrono::Duration> for Property {
fn from(duration: chrono::Duration) -> Self {
Property::new_pre_alloc(String::from("DURATION"), duration.to_string())
}
}
//pub enum AttendeeRole {
// /// CHAIR (RFC 5545, Section 3.2.16)
// Chair,
//
// /// REQ-PARTICIPANT (RFC 5545, Section 3.2.16)
// ReqParticipant,
//
// /// OPT-PARTICIPANT (RFC 5545, Section 3.2.16)
// OptParticipant,
//
// /// NON-PARTICIPANT (RFC 5545, Section 3.2.16)
// NonParticipant
//}
//
//pub struct Attendee {
// cn: String,
// role: AttendeeRole,
// delegated_from: String,
// part_stat: String,
// sent_by: String,
// dir: String,
//}
//
//impl Into<Property> for Attendee {
//}
// Fold a content line as described in RFC 5545, Section 3.1
#[allow(clippy::indexing_slicing)]
pub(crate) fn fold_line(line: &str) -> String {
let limit = 75;
let len = line.len();
let mut ret = String::with_capacity(len + (len / limit * 3));
let mut bytes_remaining = len;
let mut pos = 0;
let mut next_pos = limit;
while bytes_remaining > limit {
let pos_is_whitespace = |line: &str, next_pos| {
line.chars()
.nth(next_pos)
.map(char::is_whitespace)
.unwrap_or(false)
};
if pos_is_whitespace(line, next_pos) {
next_pos -= 1;
}
while !line.is_char_boundary(next_pos) {
next_pos -= 1;
if pos_is_whitespace(line, next_pos) {
next_pos -= 1;
}
}
ret.push_str(&line[pos..next_pos]);
ret.push_str("\r\n ");
bytes_remaining -= next_pos - pos;
pos = next_pos;
next_pos += limit;
}
ret.push_str(&line[len - bytes_remaining..]);
ret
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use super::*;
#[test]
fn fold_line_short() {
let line = "This is a short line";
assert_eq!(line, fold_line(line));
}
#[test]
fn fold_line_folds_on_char_boundary() {
let line = "Content lines shouldn't be folded in the middle \
of a UTF-8 character. 老虎.";
let expected = "Content lines shouldn't be folded in the middle \
of a UTF-8 character. 老\r\n 虎.";
assert_eq!(expected, fold_line(line));
}
#[cfg(feature = "parser")]
#[test]
fn preserve_spaces() {
use crate::parser::unfold;
let lines = [
r#"01234567890123456789012345678901234567890123456789012345HERE_COMES_A_SPACE( )"#,
r#"01234567890123456789012345678901234567890123456789012345HERE_COMES_A_SPACE( )<-----78901234567890123456789012345678901234567890123HERE_COMES_A_SPACE( )<---"#,
];
for line in lines {
let folded = fold_line(line);
let unfolded = unfold(&folded);
assert_eq!(line, unfolded);
}
}
}