aboutsummaryrefslogtreecommitdiff
path: root/back-end/src/FeedGenerator.cs
blob: de4a1e2577350a9c2328c138a71ae05231dd9064 (plain)
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
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: CMNext
* Package: Content.Publishing.Blog.Admin
* File: FeedGenerator.cs 
*
* CMNext 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.
*
* CMNext 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 https://www.gnu.org/licenses/.
*/

using System;
using System.Xml;
using System.Linq;
using System.Text;
using System.Collections.Generic;

using VNLib.Utils.IO;
using VNLib.Plugins;

using Content.Publishing.Blog.Admin.Model;

namespace Content.Publishing.Blog.Admin
{
    internal sealed class FeedGenerator : IRssFeedGenerator
    {
        const int defaultMaxItems = 20;
        const string ITUNES_XML_ATTR = "http://www.itunes.com/dtds/podcast-1.0.dtd";
        const string CONTENT_XML_ATTR = "http://purl.org/rss/1.0/modules/content/";

        public FeedGenerator(PluginBase pbase)
        { }

        public void BuildFeed(IChannelContext context, IEnumerable<PostMeta> posts, VnMemoryStream output)
        {
            _ = context.Feed ?? throw new ArgumentNullException(nameof(context.Feed));

            //Build the feed
            using XmlWriter writer = XmlWriter.Create(output, new XmlWriterSettings
            {
                Encoding = Encoding.UTF8,
                Indent = true,
                IndentChars = "  ",
                NewLineChars = "\n",
                NewLineHandling = NewLineHandling.Entitize,
                NewLineOnAttributes = false,
                CloseOutput = false,
                NamespaceHandling = NamespaceHandling.OmitDuplicates,
            });

            string currentTime = DateTime.UtcNow.ToString("R");

            //Write the feed
            writer.WriteStartDocument();
            writer.WriteStartElement("rss");
            writer.WriteAttributeString("version", "2.0");
            writer.WriteAttributeString("xmlns", "itunes", null, ITUNES_XML_ATTR);
            writer.WriteAttributeString("xmlns", "content", null, CONTENT_XML_ATTR);
          

            //Channel element
            writer.WriteStartElement("channel");

            writer.WriteElementString("title", context.BlogName);

            writer.WriteElementString("link", context.Feed.PublihUrl);

            //Description/summary
            writer.WriteElementString("description", context.Feed.Description);
            writer.WriteElementString("itunes", "summary", null, context.Feed.Description);

            writer.WriteElementString("itunes", "author", null, context.Feed.Author);

            //Itunes owner tag
            writer.WriteStartElement("itunes", "owner", null);
            writer.WriteElementString("itunes", "email", null, context.Feed.WebMaster);
            writer.WriteElementString("itunes", "name", null, context.Feed.Author);
            writer.WriteEndElement();

            //Write extended properties 
            if (context.Feed.ExtendedProperties != null)
            {
                foreach (ExtendedProperty prop in context.Feed.ExtendedProperties)
                {
                    PrintExtendedProps(prop, writer);
                }
            }

            //Author
            writer.WriteElementString("itunes", "author", null, context.Feed.Author);

            //Itunes image url
            if (context.Feed.ImageUrl != null)
            {
                WriteImageTag(writer, context.Feed.ImageUrl);
            }

            writer.WriteElementString("language", "en-us");

            writer.WriteElementString("pubDate", currentTime);
            writer.WriteElementString("lastBuildDate", currentTime);

            int maxItems = context.Feed.MaxItems ?? defaultMaxItems;
            //Take only the latest max items
            posts = posts.OrderByDescending(static p => p.Date).Take(maxItems);

            //Write the posts as items but sort in order of their pub date
            foreach (PostMeta post in posts)
            {
                writer.WriteStartElement("item");

                writer.WriteElementString("title", post.Title);
                writer.WriteElementString("itunes","title", null, post.Title);

                writer.WriteElementString("link", $"{context.Feed.PublihUrl}/{post.Id}");
               
                writer.WriteElementString("itunes", "author", null, post.Author);

                //Description is just the post summary
                writer.WriteElementString("description", post.Summary);
                writer.WriteElementString("itunes", "summary", null, post.Summary);

                //Time as iso string from unix seconds timestamp
                string pubDate = DateTimeOffset.FromUnixTimeSeconds(post.Date).ToString("R");

                writer.WriteElementString("pubDate", pubDate);
                writer.WriteElementString("published", pubDate);

                if (post.Image != null)
                {
                    WriteImageTag(writer, post.Image);
                }

                //Add extended properties as itunes tags
                if (post.ExtendedProperties != null)
                {
                    //Recursivley add extended properties
                    foreach (ExtendedProperty prop in post.ExtendedProperties)
                    {
                        PrintExtendedProps(prop, writer);
                    }
                }

                //Set post id as the guid
                writer.WriteElementString("guid", post.Id);

                writer.WriteEndElement();
            }

            //End the feed
            writer.WriteEndElement();
            writer.WriteEndElement();
            writer.WriteEndDocument();
        }

        private static void PrintExtendedProps(ExtendedProperty? prop, XmlWriter writer)
        {
            if (prop?.Name == null)
            {
                return;
            }

            //Open the element
            writer.WriteStartElement(prop.NameSpace, prop.Name, null);

            //Write the attributes
            if (prop.Attributes != null)
            {
                foreach (KeyValuePair<string, string> attr in prop.Attributes)
                {
                    writer.WriteAttributeString(attr.Key, attr.Value);
                }
            }

            //nested child elements before closing
            if (prop.Children != null)
            {
                foreach (ExtendedProperty child in prop.Children)
                {
                    PrintExtendedProps(child, writer);
                }
            }
            else
            {
                //Write the value
                writer.WriteString(prop.Value);
            }
            
            //Close the element 
            writer.WriteEndElement();
        }

        private static void WriteImageTag(XmlWriter writer, string imageUrl)
        {
            writer.WriteStartElement("itunes", "image",null);
            writer.WriteAttributeString("href", imageUrl);
            writer.WriteEndElement();
        }
    }
}