// Copyright (C) 2018 Vincent Ambo // // This file is part of Converse. // // Converse is free software: you can redistribute it and/or modify it // under the terms of the GNU Affero General Public License as // published by the Free Software Foundation, either version 3 of the // License, or (at your option) any later version. // // This program is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public // License along with this program. If not, see // . //! This module defines a rendering actor used for processing Converse //! data into whatever format is needed by the templates and rendering //! them. use actix::prelude::*; use errors::*; use md5; use models::*; use tera::{escape_html, Context, Tera}; use chrono::prelude::{DateTime, Utc}; use comrak::{ComrakOptions, markdown_to_html}; pub struct Renderer { pub tera: Tera, pub comrak: ComrakOptions, } impl Actor for Renderer { type Context = actix::Context; } /// Represents a data formatted for human consumption #[derive(Debug, Serialize)] struct FormattedDate(String); impl From> for FormattedDate { fn from(date: DateTime) -> Self { FormattedDate(format!("{}", date.format("%a %d %B %Y, %R"))) } } /// Message used to render the index page. pub struct IndexPage { pub threads: Vec, } message!(IndexPage, Result); #[derive(Debug, Serialize)] struct IndexThread { id: i32, title: String, sticky: bool, posted: FormattedDate, author_name: String, post_author: String, } impl Handler for Renderer { type Result = Result; fn handle(&mut self, msg: IndexPage, _: &mut Self::Context) -> Self::Result { let threads: Vec = msg.threads .into_iter() .map(|thread| IndexThread { id: thread.thread_id, title: escape_html(&thread.title), sticky: thread.sticky, posted: thread.posted.into(), author_name: thread.thread_author, post_author: thread.post_author, }) .collect(); let mut ctx = Context::new(); ctx.add("threads", &threads); Ok(self.tera.render("index.html", &ctx)?) } } /// Message used to render a thread. pub struct ThreadPage { pub current_user: i32, pub thread: Thread, pub posts: Vec, } message!(ThreadPage, Result); // "Renderable" structures with data transformations applied. #[derive(Debug, Serialize)] struct RenderablePost { id: i32, body: String, posted: FormattedDate, author_name: String, author_gravatar: String, editable: bool, } /// This structure represents the transformed thread data with /// Markdown rendering and other changes applied. #[derive(Debug, Serialize)] struct RenderableThreadPage { id: i32, title: String, posts: Vec, } /// Helper function for computing Gravatar links. fn md5_hex(input: &[u8]) -> String { format!("{:x}", md5::compute(input)) } fn prepare_thread(comrak: &ComrakOptions, page: ThreadPage) -> RenderableThreadPage { let user = page.current_user; let posts = page.posts.into_iter().map(|post| { let editable = user != 1 && post.user_id == user; RenderablePost { id: post.id, body: markdown_to_html(&post.body, comrak), posted: post.posted.into(), author_name: post.author_name.clone(), author_gravatar: md5_hex(post.author_email.as_bytes()), editable, } }).collect(); RenderableThreadPage { posts, id: page.thread.id, title: escape_html(&page.thread.title), } } impl Handler for Renderer { type Result = Result; fn handle(&mut self, msg: ThreadPage, _: &mut Self::Context) -> Self::Result { let renderable = prepare_thread(&self.comrak, msg); Ok(self.tera.render("thread.html", &renderable)?) } } /// The different types of editing modes supported by the editing /// template: #[derive(Debug, Serialize)] pub enum EditingMode { NewThread, PostReply, EditPost, } impl Default for EditingMode { fn default() -> EditingMode { EditingMode::NewThread } } /// This struct represents the context submitted to the template used /// for rendering the new thread, edit post and reply to thread forms. #[derive(Default, Serialize)] pub struct FormContext { /// Which editing mode is to be used by the template? pub mode: EditingMode, /// Potential alerts to display to the user (e.g. input validation /// results) pub alerts: Vec<&'static str>, /// Either the title to be used in the subject field or the title /// of the thread the user is responding to. pub title: Option, /// Body of the post being edited, if present. pub post: Option, /// ID of the thread being replied to or the post being edited. pub id: Option, } /// Message used to render new thread page. /// /// It can optionally contain a vector of warnings to display to the /// user in alert boxes, such as input validation errors. #[derive(Default)] pub struct NewThreadPage { pub alerts: Vec<&'static str>, pub title: Option, pub post: Option, } message!(NewThreadPage, Result); impl Handler for Renderer { type Result = Result; fn handle(&mut self, msg: NewThreadPage, _: &mut Self::Context) -> Self::Result { let ctx = FormContext { alerts: msg.alerts, title: msg.title, post: msg.post, ..Default::default() }; Ok(self.tera.render("post.html", &ctx)?) } } /// Message used to render post editing page. pub struct EditPostPage { pub id: i32, pub post: String, } message!(EditPostPage, Result); impl Handler for Renderer { type Result = Result; fn handle(&mut self, msg: EditPostPage, _: &mut Self::Context) -> Self::Result { let ctx = FormContext { mode: EditingMode::EditPost, id: Some(msg.id), post: Some(msg.post), ..Default::default() }; Ok(self.tera.render("post.html", &ctx)?) } } /// Message used to render search results #[derive(Serialize)] pub struct SearchResultPage { pub query: String, pub results: Vec, } message!(SearchResultPage, Result); impl Handler for Renderer { type Result = Result; fn handle(&mut self, msg: SearchResultPage, _: &mut Self::Context) -> Self::Result { Ok(self.tera.render("search.html", &msg)?) } }