NetNewsWire/Evergreen/MainWindow/Detail/ArticleRenderer.swift

471 lines
12 KiB
Swift
Raw Normal View History

2017-05-27 19:43:27 +02:00
//
// ArticleRenderer.swift
// Evergreen
//
// Created by Brent Simmons on 9/8/15.
// Copyright © 2015 Ranchero Software, LLC. All rights reserved.
//
import Foundation
import RSCore
import Articles
import Account
2017-05-27 19:43:27 +02:00
var cachedStyleString = ""
var cachedTemplate = ""
2017-12-30 04:03:52 +01:00
// NOTE: THIS CODE IS A TOTAL MESS RIGHT NOW WHILE WERE EXPERIMENTING WITH DIFFERENT LAYOUTS. DONT JUDGE, YOU!
2017-05-27 19:43:27 +02:00
class ArticleRenderer {
let article: Article
let articleStyle: ArticleStyle
static var faviconImgTagCache = [Feed: String]()
static var feedIconImgTagCache = [Feed: String]()
2017-05-27 19:43:27 +02:00
lazy var longDateFormatter: DateFormatter = {
let dateFormatter = DateFormatter()
dateFormatter.dateStyle = .long
dateFormatter.timeStyle = .medium
return dateFormatter
}()
lazy var mediumDateFormatter: DateFormatter = {
let dateFormatter = DateFormatter()
dateFormatter.dateStyle = .medium
dateFormatter.timeStyle = .short
return dateFormatter
}()
lazy var shortDateFormatter: DateFormatter = {
let dateFormatter = DateFormatter()
dateFormatter.dateStyle = .short
dateFormatter.timeStyle = .short
return dateFormatter
}()
lazy var title: String = {
if let articleTitle = self.article.title {
return articleTitle
}
return ""
}()
lazy var baseURL: URL? = {
2017-10-02 09:53:58 +02:00
var s = self.article.url
2017-05-27 19:43:27 +02:00
if s == nil {
s = self.article.feed?.homePageURL
}
if s == nil {
s = self.article.feed?.url
}
if s == nil {
return nil
}
var urlComponents = URLComponents(string: s!)
if urlComponents == nil {
return nil
}
// Cant use url-with-fragment as base URL. The webview wont load. See scripting.com/rss.xml for example.
urlComponents!.fragment = nil
if let url = urlComponents!.url {
2017-05-27 19:43:27 +02:00
if url.scheme == "http" || url.scheme == "https" {
return url
}
}
return nil
}()
var html: String {
return renderedHTML()
}
init(article: Article, style: ArticleStyle) {
self.article = article
self.articleStyle = style
}
// MARK: Private
private func textInsideTag(_ text: String, _ tag: String) -> String {
return "<\(tag)>\(text)</\(tag)>"
}
private func styleString() -> String {
if let s = articleStyle.css {
return s
}
if cachedStyleString.isEmpty {
let path = Bundle.main.path(forResource: "styleSheet", ofType: "css")!
let s = try! NSString(contentsOfFile: path, encoding: String.Encoding.utf8.rawValue)
cachedStyleString = "\n\(s)\n"
}
return cachedStyleString
}
private func template() -> String {
if let s = articleStyle.template {
return s
}
if cachedTemplate.isEmpty {
let path = Bundle.main.path(forResource: "template", ofType: "html")!
let s = try! NSString(contentsOfFile: path, encoding: String.Encoding.utf8.rawValue)
cachedTemplate = s as String
}
return cachedTemplate
}
private func linkWithTextAndClass(_ text: String, _ href: String, _ className: String) -> String {
return "<a class=\"\(className)\" href=\"\(href)\">\(text)</a>"
}
private func linkWithText(_ text: String, _ href: String) -> String {
return ArticleRenderer.linkWithText(text, href)
}
private static func linkWithText(_ text: String, _ href: String) -> String {
2017-05-27 19:43:27 +02:00
return "<a href=\"\(href)\">\(text)</a>"
}
2017-12-29 20:31:47 +01:00
private func linkWithLink(_ href: String) -> String {
return linkWithText(href, href)
}
2017-05-27 19:43:27 +02:00
private func titleOrTitleLink() -> String {
2017-09-18 01:30:45 +02:00
if let link = article.preferredLink {
2017-05-27 19:43:27 +02:00
return linkWithText(title, link)
}
return title
}
private func substitutions() -> [String: String] {
var d = [String: String]()
let title = titleOrTitleLink()
d["title"] = title
2017-05-27 19:43:27 +02:00
let body = article.body == nil ? "" : article.body
d["body"] = body
2017-05-27 19:43:27 +02:00
d["avatars"] = ""
var didAddAvatar = false
if let avatarHTML = avatarImgTag() {
// d["avatars"] = avatarHTML
d["avatars"] = "<td class=\"header rightAlign avatar\">\(avatarHTML)</td>";
didAddAvatar = true
}
2017-05-27 19:43:27 +02:00
var feedLink = ""
if let feedTitle = article.feed?.nameForDisplay {
feedLink = feedTitle
if let feedURL = article.feed?.homePageURL {
feedLink = linkWithTextAndClass(feedTitle, feedURL, "feedLink")
}
}
d["feedlink"] = feedLink
d["feedlink_withfavicon"] = feedLink
// d["favicon"] = ""
if !didAddAvatar, let feed = article.feed {
if let favicon = faviconImgTag(forFeed: feed) {
d["avatars"] = "<td class=\"header rightAlign\">\(favicon)</td>";
// d["favicon"] = favicon
}
}
2017-05-27 19:43:27 +02:00
let longDate = longDateFormatter.string(from: article.logicalDatePublished)
let mediumDate = mediumDateFormatter.string(from: article.logicalDatePublished)
let shortDate = shortDateFormatter.string(from: article.logicalDatePublished)
if let permalink = article.url {
d["date_long"] = linkWithText(longDate, permalink)
d["date_medium"] = linkWithText(mediumDate, permalink)
d["date_short"] = linkWithText(shortDate, permalink)
}
else {
d["date_long"] = longDate
d["date_medium"] = mediumDate
d["date_short"] = shortDate
}
2017-12-29 20:31:47 +01:00
d["byline"] = byline()
// d["author_avatar"] = authorAvatar()
2017-12-29 20:31:47 +01:00
2017-05-27 19:43:27 +02:00
return d
}
struct Avatar {
let imageURL: String
let url: String?
func html(dimension: Int) -> String {
let imageTag = "<img src=\"\(imageURL)\" width=\(dimension) height=\(dimension) />"
if let url = url {
return linkWithText(imageTag, url)
}
return imageTag
}
}
private func faviconImgTag(forFeed feed: Feed) -> String? {
if let cachedImgTag = ArticleRenderer.faviconImgTagCache[feed] {
return cachedImgTag
}
if let favicon = appDelegate.faviconDownloader.favicon(for: feed) {
if let s = base64String(forImage: favicon) {
var dimension = min(favicon.size.height, CGFloat(avatarDimension)) // Assuming square images.
dimension = max(dimension, 16) // Some favicons say theyre < 16. Force them larger.
if dimension >= CGFloat(avatarDimension) * 0.8 { //Close enough to scale up.
dimension = CGFloat(avatarDimension)
}
let imgTag: String
if dimension >= CGFloat(avatarDimension) {
// Use rounded corners.
imgTag = "<img src=\"data:image/tiff;base64, " + s + "\" height=\(Int(dimension)) width=\(Int(dimension)) style=\"border-radius:4px\" />"
}
else {
imgTag = "<img src=\"data:image/tiff;base64, " + s + "\" height=\(Int(dimension)) width=\(Int(dimension)) />"
}
ArticleRenderer.faviconImgTagCache[feed] = imgTag
return imgTag
}
}
return nil
}
private func feedIconImgTag(forFeed feed: Feed) -> String? {
if let cachedImgTag = ArticleRenderer.feedIconImgTagCache[feed] {
return cachedImgTag
}
if let icon = appDelegate.feedIconDownloader.icon(for: feed) {
if let s = base64String(forImage: icon) {
let imgTag = "<img src=\"data:image/tiff;base64, " + s + "\" height=48 width=48 />"
ArticleRenderer.feedIconImgTagCache[feed] = imgTag
return imgTag
}
}
return nil
}
private func base64String(forImage image: NSImage) -> String? {
let d = image.tiffRepresentation
return d?.base64EncodedString()
}
private func singleArticleSpecifiedAuthor() -> Author? {
// The author of this article, if just one.
if let authors = article.authors, authors.count == 1 {
return authors.first!
}
return nil
}
private func singleFeedSpecifiedAuthor() -> Author? {
if let authors = article.feed?.authors, authors.count == 1 {
return authors.first!
}
return nil
}
private func feedAvatar() -> Avatar? {
guard let feedIconURL = article.feed?.iconURL else {
return nil
}
return Avatar(imageURL: feedIconURL, url: article.feed?.homePageURL ?? article.feed?.url)
}
private func authorAvatar() -> Avatar? {
if let author = singleArticleSpecifiedAuthor(), let imageURL = author.avatarURL {
return Avatar(imageURL: imageURL, url: author.url)
}
if let author = singleFeedSpecifiedAuthor(), let imageURL = author.avatarURL {
return Avatar(imageURL: imageURL, url: author.url)
}
return nil
}
private func avatarsToShow() -> [Avatar]? {
var avatars = [Avatar]()
if let avatar = feedAvatar() {
avatars.append(avatar)
}
if let avatar = authorAvatar() {
avatars.append(avatar)
}
return avatars.isEmpty ? nil : avatars
}
private func avatarToUse() -> Avatar? {
// Use author if article specifies an author, otherwise use feed icon.
// If no feed icon, use feed-specified author.
if let author = singleArticleSpecifiedAuthor(), let imageURL = author.avatarURL {
return Avatar(imageURL: imageURL, url: author.url)
}
if let feedIconURL = article.feed?.iconURL {
return Avatar(imageURL: feedIconURL, url: article.feed?.homePageURL ?? article.feed?.url)
}
if let author = singleFeedSpecifiedAuthor(), let imageURL = author.avatarURL {
return Avatar(imageURL: imageURL, url: author.url)
}
return nil
}
private let avatarDimension = 48
private func avatarImgTag() -> String? {
if let author = singleArticleSpecifiedAuthor(), let imageURL = author.avatarURL {
return Avatar(imageURL: imageURL, url: author.url).html(dimension: avatarDimension)
}
if let feed = article.feed, let imgTag = feedIconImgTag(forFeed: feed) {
return imgTag
}
if let feedIconURL = article.feed?.iconURL {
return Avatar(imageURL: feedIconURL, url: article.feed?.homePageURL ?? article.feed?.url).html(dimension: avatarDimension)
}
if let author = singleFeedSpecifiedAuthor(), let imageURL = author.avatarURL {
return Avatar(imageURL: imageURL, url: author.url).html(dimension: avatarDimension)
}
return nil
}
// private func authorAvatar() -> String {
//
// guard let authors = article.authors, authors.count == 1, let author = authors.first else {
// return ""
// }
// guard let avatarURL = author.avatarURL else {
// return ""
// }
//
// var imageTag = "<img src=\"\(avatarURL)\" height=64 width=64 />"
// if let authorURL = author.url {
// imageTag = linkWithText(imageTag, authorURL)
// }
// return "<div id=authorAvatar>\(imageTag)</div>"
// }
2017-12-29 20:31:47 +01:00
private func byline() -> String {
guard let authors = article.authors ?? article.feed?.authors, !authors.isEmpty else {
return ""
}
var byline = ""
var isFirstAuthor = true
for author in authors {
if !isFirstAuthor {
byline += ", "
}
isFirstAuthor = false
if let emailAddress = author.emailAddress, emailAddress.contains(" ") {
byline += emailAddress // probably name plus email address
}
else if let name = author.name, let url = author.url {
byline += linkWithText(name, url)
}
else if let name = author.name, let emailAddress = author.emailAddress {
byline += "\(name) &lt;\(emailAddress)&lg;"
// byline += linkWithText(name, "mailto:\(emailAddress)") //TODO
}
else if let name = author.name {
byline += name
}
else if let emailAddress = author.emailAddress {
byline += "&lt;\(emailAddress)&gt;" // TODO: mailto link
}
else if let url = author.url {
byline += linkWithLink(url)
}
}
return byline
2017-12-29 20:31:47 +01:00
}
2017-05-27 19:43:27 +02:00
private func renderedHTML() -> String {
var s = "<!DOCTYPE html><html><head>\n\n"
2017-05-27 19:43:27 +02:00
s += textInsideTag(title, "title")
s += textInsideTag(styleString(), "style")
s += """
<script type="text/javascript">
function startup() {
var anchors = document.getElementsByTagName("a");
for (var i = 0; i < anchors.length; i++) {
anchors[i].addEventListener("mouseenter", function() { mouseDidEnterLink(this) });
anchors[i].addEventListener("mouseleave", function() { mouseDidExitLink(this) });
}
}
function mouseDidEnterLink(anchor) {
window.webkit.messageHandlers.mouseDidEnter.postMessage(anchor.href);
}
function mouseDidExitLink(anchor) {
window.webkit.messageHandlers.mouseDidExit.postMessage(anchor.href);
}
</script>
"""
s += "\n\n</head><body onload='startup()' class=dark>\n\n"
2017-05-27 19:43:27 +02:00
s += RSMacroProcessor.renderedText(withTemplate: template(), substitutions: substitutions(), macroStart: "[[", macroEnd: "]]")
s += "\n\n</body></html>"
2017-05-27 19:43:27 +02:00
//print(s)
2017-05-27 19:43:27 +02:00
return s
}
}