cms/cms-backd/src/sitemap.rs

// -*- coding: utf-8 -*-
//
// Simple CMS
//
// Copyright (C) 2011-2024 Michael Büsch <m@bues.ch>
//
// Licensed under the Apache License version 2.0
// or the MIT license, at your option.
// SPDX-License-Identifier: Apache-2.0 OR MIT

use crate::{
    comm::{CmsComm, CommGetPage, CommPage, CommSubPages},
    config::CmsConfig,
};
use anyhow as ah;
use chrono::prelude::*;
use cms_ident::{CheckedIdent, UrlComp};
use std::{fmt::Write as _, sync::Arc, write as wr, writeln as ln};

const MAX_DEPTH: usize = 64;
const DEFAULT_ELEMS_ALLOC: usize = 256;
const DEFAULT_HTML_ALLOC: usize = 1024 * 16;

fn xml_escape(mut s: String) -> String {
    if !s.is_empty() {
        if s.contains('&') {
            s = s.replace('&', "&amp;");
        }
        if s.contains('\'') {
            s = s.replace('\'', "&apos;");
        }
        if s.contains('"') {
            s = s.replace('"', "&quot;");
        }
        if s.contains('>') {
            s = s.replace('>', "&gt;");
        }
        if s.contains('<') {
            s = s.replace('<', "&lt;");
        }
    }
    s
}

pub struct SiteMapContext<'a> {
    pub comm: &'a mut CmsComm,
    pub config: Arc<CmsConfig>,
    pub root: &'a CheckedIdent,
    pub protocol: &'a str,
}

struct SiteMapElem {
    loc: String,
    lastmod: String,
    changefreq: String,
    priority: String,
}

async fn do_build_elems(
    ctx: &mut SiteMapContext<'_>,
    elems: &mut Vec<SiteMapElem>,
    ident: &CheckedIdent,
    stamp: DateTime<Utc>,
    nav_stop: bool,
    depth: usize,
) -> ah::Result<()> {
    if depth >= MAX_DEPTH {
        return Ok(());
    }

    let loc = ident.url(UrlComp {
        protocol: Some(ctx.protocol),
        domain: Some(ctx.config.domain()),
        base: Some(ctx.config.url_base()),
    });
    let lastmod;
    let changefreq;
    let priority;
    if depth == 1 {
        // Main groups
        lastmod = String::new();
        changefreq = "monthly".to_string();
        priority = "0.3".to_string();
    } else {
        // Pages, main page and sub groups
        lastmod = stamp.format("%Y-%m-%dT%H:%M:%SZ").to_string();
        changefreq = String::new();
        priority = "0.7".to_string();
    }

    elems.push(SiteMapElem {
        loc,
        lastmod,
        changefreq,
        priority,
    });

    if !nav_stop {
        let Ok(CommSubPages {
            mut names,
            nav_stops,
            stamps,
            ..
        }) = ctx.comm.get_db_sub_pages(ident).await
        else {
            return Ok(());
        };

        names.sort_unstable();
        for i in 0..names.len() {
            let sub_ident = ident.clone_append(&names[i]).into_checked()?;
            Box::pin(do_build_elems(
                ctx,
                elems,
                &sub_ident,
                stamps[i],
                nav_stops[i],
                depth + 1,
            ))
            .await?;
        }
    }

    Ok(())
}

async fn build_elems(
    ctx: &mut SiteMapContext<'_>,
    elems: &mut Vec<SiteMapElem>,
    ident: &CheckedIdent,
) -> ah::Result<()> {
    let Ok(CommPage { stamp, .. }) = ctx
        .comm
        .get_db_page(CommGetPage {
            path: ident.clone(),
            get_stamp: true,
            ..Default::default()
        })
        .await
    else {
        return Ok(());
    };
    do_build_elems(ctx, elems, ident, stamp.unwrap_or_default(), false, 0).await
}

async fn build_user_elems(
    ctx: &mut SiteMapContext<'_>,
    elems: &mut Vec<SiteMapElem>,
) -> ah::Result<()> {
    let user_site_map = ctx.comm.get_db_string("site-map").await?;
    for line in user_site_map.lines() {
        let line = line.trim();
        if line.is_empty() || line.starts_with('#') {
            continue;
        }
        let mut line = line.split_whitespace();
        let Some(loc) = line.next() else {
            continue;
        };
        let loc = format!("{}://{}/{}", ctx.protocol, ctx.config.domain(), loc);
        let priority = line.next().unwrap_or("0.7");
        let changefreq = line.next().unwrap_or("always");
        elems.push(SiteMapElem {
            loc,
            lastmod: String::new(),
            changefreq: changefreq.to_string(),
            priority: priority.to_string(),
        });
    }
    Ok(())
}

/// Site map generator.
/// Specification: https://www.sitemaps.org/protocol.html
pub struct SiteMap {
    elems: Vec<SiteMapElem>,
}

impl SiteMap {
    pub async fn build(mut ctx: SiteMapContext<'_>) -> ah::Result<Self> {
        let mut elems = Vec::with_capacity(DEFAULT_ELEMS_ALLOC);
        let root = ctx.root.clone();
        build_elems(&mut ctx, &mut elems, &root).await?;
        build_user_elems(&mut ctx, &mut elems).await?;
        Ok(Self { elems })
    }

    #[rustfmt::skip]
    pub fn get_xml(&self) -> ah::Result<String> {
        let mut b = String::with_capacity(DEFAULT_HTML_ALLOC);
        ln!(b, r#"<?xml version="1.0" encoding="UTF-8"?>"#)?;
        wr!(b, r#"<urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9" "#)?;
        wr!(b, r#"xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" "#)?;
        wr!(b, r#"xsi:schemaLocation="https://www.sitemaps.org/schemas/sitemap/0.9 "#)?;
        ln!(b, r#"https://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">"#)?;
        for elem in &self.elems {
            let loc = xml_escape(elem.loc.clone());
            let lastmod = xml_escape(elem.lastmod.clone());
            let changefreq = xml_escape(elem.changefreq.clone());
            let priority = xml_escape(elem.priority.clone());

            ln!(b, r#"<url>"#)?;
            if !loc.is_empty() {
                ln!(b, r#"<loc>{loc}</loc>"#)?;
            }
            if !lastmod.is_empty() {
                ln!(b, r#"<lastmod>{lastmod}</lastmod>"#)?;
            }
            if !changefreq.is_empty() {
                ln!(b, r#"<changefreq>{changefreq}</changefreq>"#)?;
            }
            if !priority.is_empty() {
                ln!(b, r#"<priority>{priority}</priority>"#)?;
            }
            ln!(b, r#"</url>"#)?;
        }
        wr!(b, r#"</urlset>"#)?;
        Ok(b)
    }
}

// vim: ts=4 sw=4 expandtab