2 * Sone - FreenetTemplatePage.java - Copyright © 2010–2019 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.web.page
20 import freenet.clients.http.*
21 import net.pterodactylus.sone.main.*
22 import net.pterodactylus.util.template.*
23 import net.pterodactylus.util.web.*
25 import java.lang.String.*
27 import java.util.logging.*
28 import java.util.logging.Logger.*
31 * Base class for all [Page]s that are rendered with [Template]s and
32 * fit into Freenet’s web interface.
34 open class FreenetTemplatePage(
35 private val path: String,
36 private val templateContextFactory: TemplateContextFactory,
37 private val loaders: Loaders,
38 private val template: Template,
39 private val invalidFormPasswordRedirectTarget: String
40 ) : FreenetPage, LinkEnabledCallback {
42 open val styleSheets: Collection<String> = emptySet()
43 open val shortcutIcon: String? get() = null
44 open val isFullAccessOnly get() = false
46 override fun getPath() = path
48 open fun getPageTitle(request: FreenetRequest) = ""
50 override fun isPrefixPage() = false
52 open fun getRedirectTarget(request: FreenetRequest): String? = null
54 open fun getAdditionalLinkNodes(request: FreenetRequest): List<Map<String, String>> = emptyList()
56 override fun isLinkExcepted(link: URI) = false
58 override fun isEnabled(toadletContext: ToadletContext) = !isFullAccessOnly
60 override fun handleRequest(request: FreenetRequest, response: Response): Response {
61 getRedirectTarget(request)?.let { redirectTarget -> return RedirectResponse(redirectTarget) }
63 if (isFullAccessOnly && !request.toadletContext.isAllowedFullAccess) {
64 return response.setStatusCode(401).setStatusText("Not authorized").setContentType("text/html")
66 val toadletContext = request.toadletContext
67 if (request.method == Method.POST) {
68 /* require form password. */
69 val formPassword = request.httpRequest.getPartAsStringFailsafe("formPassword", 32)
70 if (formPassword != toadletContext.container.formPassword) {
71 return RedirectResponse(invalidFormPasswordRedirectTarget)
74 val pageMaker = toadletContext.pageMaker
75 val pageNode = pageMaker.getPageNode(getPageTitle(request), toadletContext)
77 styleSheets.forEach(pageNode::addCustomStyleSheet)
78 getAdditionalLinkNodes(request)
79 .map { it to pageNode.headNode.addChild("link") }
80 .forEach { (linkNodeParameters, linkNode) ->
81 linkNodeParameters.forEach(linkNode::addAttribute)
83 shortcutIcon?.let { pageNode.addForwardLink("icon", it) }
85 val templateContext = templateContextFactory.createTemplateContext()
86 templateContext.mergeContext(template.initialContext)
88 val start = System.nanoTime()
89 processTemplate(request, templateContext)
90 val finish = System.nanoTime()
91 logger.log(Level.FINEST, format("Template was rendered in %.2fms.", (finish - start) / 1000000.0))
92 } catch (re1: RedirectException) {
93 return RedirectResponse(re1.target ?: "")
96 val stringWriter = StringWriter()
97 template.render(templateContext, stringWriter)
98 pageNode.content.addChild("%", stringWriter.toString())
100 return response.setStatusCode(200).setStatusText("OK").setContentType("text/html").write(pageNode.outer.generate())
103 open fun processTemplate(request: FreenetRequest, templateContext: TemplateContext) {
107 class RedirectException(val target: String?) : Exception() {
108 override fun toString(): String = format("RedirectException{target='%s'}", target)
113 private val logger: Logger = getLogger(FreenetTemplatePage::class.java.name)