rss_gen/
validator.rs

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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
// Copyright © 2024 RSS Gen. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! RSS feed validator module
//!
//! This module provides functionality to validate RSS feeds, ensuring they
//! conform to the specified RSS version standards and contain valid data.

use crate::data::{RssData, RssVersion};
use crate::error::{Result, RssError, ValidationError};
use dtt::datetime::DateTime;
use url::Url;

/// Maximum allowed length for URL strings
const MAX_URL_LENGTH: usize = 2000;

/// RSS feed validator for validating the structure and content of an RSS feed.
#[derive(Debug)]
pub struct RssFeedValidator<'a> {
    rss_data: &'a RssData,
}

impl<'a> RssFeedValidator<'a> {
    /// Creates a new `RssFeedValidator` instance with the provided `RssData`.
    ///
    /// # Arguments
    ///
    /// * `rss_data` - A reference to the `RssData` to be validated.
    ///
    /// # Returns
    ///
    /// A new instance of `RssFeedValidator`.
    #[must_use]
    pub fn new(rss_data: &'a RssData) -> Self {
        RssFeedValidator { rss_data }
    }

    /// Validates the RSS feed structure and content.
    ///
    /// This method performs a comprehensive validation of the RSS feed,
    /// including structure, items, dates, and version-specific requirements.
    ///
    /// # Returns
    ///
    /// * `Ok(())` if the validation passes.
    /// * `Err(RssError::ValidationErrors)` containing a list of validation errors if any are found.
    ///
    /// # Errors
    ///
    /// This function returns an `Err(RssError::ValidationErrors)` if any validation checks fail.
    pub fn validate(&self) -> Result<()> {
        let mut errors = Vec::new();

        self.validate_rss_data(&mut errors);
        self.validate_structure(&mut errors);
        self.validate_items(&mut errors);
        self.validate_dates(&mut errors);
        self.validate_version_specific(&mut errors);

        if errors.is_empty() {
            Ok(())
        } else {
            Err(RssError::ValidationErrors(
                errors.into_iter().map(|e| e.to_string()).collect(),
            ))
        }
    }

    /// Validates the base `RssData` structure.
    fn validate_rss_data(&self, errors: &mut Vec<ValidationError>) {
        if let Err(e) = self.rss_data.validate() {
            errors.push(ValidationError {
                field: "rss_data".to_string(),
                message: e.to_string(),
            });
        }
    }

    /// Validates the overall structure of the RSS feed.
    fn validate_structure(&self, errors: &mut Vec<ValidationError>) {
        Self::validate_url(&self.rss_data.link, "channel link", errors);

        for (index, item) in self.rss_data.items.iter().enumerate() {
            Self::validate_url(
                &item.link,
                &format!("item[{}] link", index),
                errors,
            );
        }

        if self.rss_data.items.is_empty() {
            errors.push(ValidationError {
                field: "items".to_string(),
                message: "RSS feed must contain at least one item"
                    .to_string(),
            });
        }

        self.validate_guids(errors);
        self.validate_atom_link(errors);
    }

    /// Validates that all GUIDs in the feed are unique.
    fn validate_guids(&self, errors: &mut Vec<ValidationError>) {
        let mut guids = std::collections::HashSet::new();
        for item in &self.rss_data.items {
            if !guids.insert(&item.guid) {
                errors.push(ValidationError {
                    field: "guid".to_string(),
                    message: format!(
                        "Duplicate GUID found: {}",
                        item.guid
                    ),
                });
            }
        }
    }

    /// Validates the presence of atom:link for RSS 2.0 feeds.
    fn validate_atom_link(&self, errors: &mut Vec<ValidationError>) {
        if self.rss_data.version == RssVersion::RSS2_0
            && self.rss_data.atom_link.is_empty()
        {
            errors.push(ValidationError {
                field: "atom_link".to_string(),
                message: "atom:link is required for RSS 2.0 feeds"
                    .to_string(),
            });
        }
    }

    /// Validates individual items in the RSS feed.
    fn validate_items(&self, errors: &mut Vec<ValidationError>) {
        for (index, item) in self.rss_data.items.iter().enumerate() {
            if let Err(e) = item.validate() {
                errors.push(ValidationError {
                    field: format!("item[{}]", index),
                    message: format!("Item validation failed: {}", e),
                });
            }
        }
    }

    /// Validates all dates in the RSS feed.
    fn validate_dates(&self, errors: &mut Vec<ValidationError>) {
        Self::validate_date(&self.rss_data.pub_date, "pubDate", errors);
        Self::validate_date(
            &self.rss_data.last_build_date,
            "lastBuildDate",
            errors,
        );

        for (index, item) in self.rss_data.items.iter().enumerate() {
            Self::validate_date(
                &item.pub_date,
                &format!("item[{}].pubDate", index),
                errors,
            );
        }
    }

    /// Validates a single date string.
    fn validate_date(
        date_str: &str,
        field: &str,
        errors: &mut Vec<ValidationError>,
    ) {
        if !date_str.is_empty() {
            if let Err(e) = Self::parse_date(date_str) {
                errors.push(ValidationError {
                    field: field.to_string(),
                    message: format!("Invalid date format: {}", e),
                });
            }
        }
    }

    /// Parses a date string into a `DateTime` object.
    ///
    /// # Arguments
    ///
    /// * `date_str` - The date string to parse.
    ///
    /// # Returns
    ///
    /// A `Result` containing the parsed `DateTime` object or an error if the parsing fails.
    ///
    /// # Errors
    ///
    /// This function returns an `Err(RssError::DateParseError)` if the date format is invalid.
    pub fn parse_date(date_str: &str) -> Result<DateTime> {
        let rss_date_format = "[weekday repr:short], [day] [month repr:short] [year] [hour]:[minute]:[second]";
        let date_without_gmt =
            date_str.strip_suffix(" GMT").ok_or_else(|| {
                RssError::DateParseError(format!(
                    "Invalid date format (missing GMT): {}",
                    date_str
                ))
            })?;

        let mut date = DateTime::parse_custom_format(
            date_without_gmt,
            rss_date_format,
        )
        .map_err(|_| {
            RssError::DateParseError(format!(
                "Failed to parse date: {}",
                date_str
            ))
        })?;

        date.offset = time::UtcOffset::UTC;
        Ok(date)
    }

    /// Validates version-specific requirements of the RSS feed.
    fn validate_version_specific(
        &self,
        errors: &mut Vec<ValidationError>,
    ) {
        match self.rss_data.version {
            RssVersion::RSS2_0 => {
                if self.rss_data.generator.is_empty() {
                    errors.push(ValidationError {
                        field: "generator".to_string(),
                        message:
                            "generator is recommended for RSS 2.0 feeds"
                                .to_string(),
                    });
                }
                if self.rss_data.atom_link.is_empty() {
                    errors.push(ValidationError {
                        field: "atom_link".to_string(),
                        message:
                            "atom:link is required for RSS 2.0 feeds"
                                .to_string(),
                    });
                }
            }
            RssVersion::RSS1_0 => {
                if self
                    .rss_data
                    .items
                    .iter()
                    .any(|item| item.guid.is_empty())
                {
                    errors.push(ValidationError {
                        field: "guid".to_string(),
                        message:
                            "All items must have a guid in RSS 1.0"
                                .to_string(),
                    });
                }
            }
            _ => {}
        }
    }

    /// Validates a URL string.
    ///
    /// # Arguments
    ///
    /// * `url` - The URL string to validate.
    /// * `field` - The field name for error reporting.
    /// * `errors` - A mutable vector to collect validation errors.
    fn validate_url(
        url: &str,
        field: &str,
        errors: &mut Vec<ValidationError>,
    ) {
        if url.len() > MAX_URL_LENGTH {
            errors.push(ValidationError {
                field: field.to_string(),
                message: format!(
                    "URL exceeds maximum length of {} characters",
                    MAX_URL_LENGTH
                ),
            });
            return;
        }

        match Url::parse(url) {
            Ok(parsed_url) => {
                if parsed_url.scheme() != "http"
                    && parsed_url.scheme() != "https"
                {
                    errors.push(ValidationError {
                        field: field.to_string(),
                        message: format!("Invalid URL scheme in {}: {}. Only HTTP and HTTPS are allowed.", field, url),
                    });
                }
            }
            Err(_) => {
                errors.push(ValidationError {
                    field: field.to_string(),
                    message: format!(
                        "Invalid URL in {}: {}",
                        field, url
                    ),
                });
            }
        }
    }
}

/// Validates the provided `RssData` and returns a `Result` indicating success or failure.
///
/// # Arguments
///
/// * `rss_data` - A reference to the `RssData` to be validated.
///
/// # Returns
///
/// * `Ok(())` if the validation passes.
/// * `Err(RssError::ValidationErrors)` containing a list of validation errors if any are found.
///
/// # Errors
///
/// This function returns an `Err(RssError::ValidationErrors)` if any validation checks fail.
pub fn validate_rss_feed(rss_data: &RssData) -> Result<()> {
    let validator = RssFeedValidator::new(rss_data);
    validator.validate()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::data::RssItem;

    #[test]
    fn test_valid_rss_feed() {
        let mut rss_data = RssData::new(Some(RssVersion::RSS2_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed")
            .atom_link("https://example.com/feed.xml")
            .pub_date("Mon, 01 Jan 2024 00:00:00 GMT")
            .generator("RSS Gen Test");

        rss_data.add_item(
            RssItem::new()
                .title("Test Item")
                .link("https://example.com/item1")
                .description("A test item")
                .guid("unique-id-1")
                .pub_date("Mon, 01 Jan 2024 00:00:00 GMT"),
        );

        let validator = RssFeedValidator::new(&rss_data);
        assert!(validator.validate().is_ok());
    }

    #[test]
    fn test_invalid_rss_feed() {
        let rss_data = RssData::new(Some(RssVersion::RSS2_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed")
            .pub_date("Invalid Date");

        let validator = RssFeedValidator::new(&rss_data);
        let result = validator.validate();
        assert!(result.is_err());
        if let Err(RssError::ValidationErrors(errors)) = result {
            assert!(errors
                .iter()
                .any(|e| e.contains("atom:link is required")));
            assert!(errors.iter().any(|e| e
                .contains("RSS feed must contain at least one item")));
            assert!(errors
                .iter()
                .any(|e| e.contains("Invalid date format")));
        } else {
            panic!("Expected ValidationErrors");
        }
    }

    #[test]
    fn test_validate_url_valid() {
        let rss_data = RssData::new(None);
        let mut errors = Vec::new();

        RssFeedValidator::validate_url(
            "https://example.com",
            "test",
            &mut errors,
        );
        RssFeedValidator::validate_url(
            "http://example.com",
            "test",
            &mut errors,
        );
        RssFeedValidator::validate_url(
            "https://sub.example.com/path?query=value",
            "test",
            &mut errors,
        );

        assert!(errors.is_empty());
        assert!(rss_data.link.is_empty());
    }

    #[test]
    fn test_validate_url_invalid() {
        let mut errors = Vec::new();

        RssFeedValidator::validate_url(
            "not a url",
            "test",
            &mut errors,
        );
        RssFeedValidator::validate_url(
            "ftp://example.com",
            "test",
            &mut errors,
        );
        RssFeedValidator::validate_url("http://", "test", &mut errors);
        RssFeedValidator::validate_url("https://", "test", &mut errors);
        RssFeedValidator::validate_url(
            "file:///path/to/file",
            "test",
            &mut errors,
        );

        assert_eq!(errors.len(), 5);
    }

    #[test]
    fn test_validate_structure_with_urls() {
        let mut rss_data = RssData::new(Some(RssVersion::RSS2_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed")
            .atom_link("https://example.com/feed.xml");

        rss_data.add_item(
            RssItem::new()
                .title("Test Item")
                .link("https://example.com/item1")
                .description("A test item")
                .guid("unique-id-1"),
        );

        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_structure(&mut errors);
        assert!(errors.is_empty());

        // Test with invalid URL
        rss_data.link = "not a url".to_string();
        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_structure(&mut errors);
        assert!(errors
            .iter()
            .any(|e| e.message.contains("Invalid URL")));
    }

    #[test]
    fn test_validate_version_specific_rss2_0() {
        let mut rss_data = RssData::new(Some(RssVersion::RSS2_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed")
            .atom_link("https://example.com/feed.xml")
            .generator("RSS Gen Test");

        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_version_specific(&mut errors);
        assert!(errors.is_empty());

        // Test without generator
        rss_data.generator = String::new();
        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_version_specific(&mut errors);
        assert!(errors
            .iter()
            .any(|e| e.message.contains("generator is recommended")));

        // Test without atom:link
        rss_data.atom_link = String::new();
        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_version_specific(&mut errors);
        assert!(errors
            .iter()
            .any(|e| e.message.contains("atom:link is required")));
    }

    #[test]
    fn test_validate_version_specific_rss1_0() {
        let mut rss_data = RssData::new(Some(RssVersion::RSS1_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed");

        rss_data.add_item(
            RssItem::new()
                .title("Test Item")
                .link("https://example.com/item1")
                .description("A test item")
                .guid("unique-id-1"),
        );

        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_version_specific(&mut errors);
        assert!(errors.is_empty());

        // Test without guid
        rss_data.items[0].guid = String::new();
        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_version_specific(&mut errors);
        assert!(errors.iter().any(|e| e
            .message
            .contains("All items must have a guid in RSS 1.0")));
    }

    #[test]
    fn test_validate_version_specific_older_versions() {
        for version in &[
            RssVersion::RSS0_90,
            RssVersion::RSS0_91,
            RssVersion::RSS0_92,
        ] {
            let rss_data = RssData::new(Some(*version))
                .title("Test Feed")
                .link("https://example.com")
                .description("A test feed");

            let validator = RssFeedValidator::new(&rss_data);
            let mut errors = Vec::new();
            validator.validate_version_specific(&mut errors);
            assert!(
                errors.is_empty(),
                "Unexpected errors for version {:?}",
                version
            );
        }
    }

    #[test]
    fn test_parse_date_valid() {
        let valid_date = "Mon, 01 Jan 2024 00:00:00 GMT";
        assert!(RssFeedValidator::parse_date(valid_date).is_ok());
    }

    #[test]
    fn test_parse_date_invalid() {
        let invalid_date = "Invalid Date";
        assert!(RssFeedValidator::parse_date(invalid_date).is_err());
    }

    #[test]
    fn test_validate_guids() {
        let mut rss_data = RssData::new(Some(RssVersion::RSS2_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed");

        rss_data.add_item(RssItem::new().guid("guid1"));
        rss_data.add_item(RssItem::new().guid("guid2"));
        rss_data.add_item(RssItem::new().guid("guid1")); // Duplicate

        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_guids(&mut errors);

        assert_eq!(errors.len(), 1);
        assert!(errors[0]
            .message
            .contains("Duplicate GUID found: guid1"));
    }

    #[test]
    fn test_validate_atom_link() {
        let rss_data = RssData::new(Some(RssVersion::RSS2_0))
            .title("Test Feed")
            .link("https://example.com")
            .description("A test feed");

        let validator = RssFeedValidator::new(&rss_data);
        let mut errors = Vec::new();
        validator.validate_atom_link(&mut errors);

        assert_eq!(errors.len(), 1);
        assert!(errors[0]
            .message
            .contains("atom:link is required for RSS 2.0 feeds"));

        let rss_data_with_atom =
            rss_data.atom_link("https://example.com/feed.xml");
        let validator = RssFeedValidator::new(&rss_data_with_atom);
        let mut errors = Vec::new();
        validator.validate_atom_link(&mut errors);

        assert!(errors.is_empty());
    }

    #[test]
    fn test_validate_rss_data() {
        let invalid_rss_data = RssData::new(Some(RssVersion::RSS2_0)); // Missing required fields

        let validator = RssFeedValidator::new(&invalid_rss_data);
        let mut errors = Vec::new();
        validator.validate_rss_data(&mut errors);

        assert!(!errors.is_empty());
        assert!(errors[0].message.contains("Title is missing"));
    }
}