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.*
24 import java.lang.String.*
26 import java.util.logging.*
27 import java.util.logging.Logger.*
30 * Base class for all [Page]s that are rendered with [Template]s and
31 * fit into Freenet’s web interface.
33 open class FreenetTemplatePage(
34 private val templateRenderer: TemplateRenderer,
36 private val invalidFormPasswordRedirectTarget: String
37 ) : FreenetPage, LinkEnabledCallback {
39 open val styleSheets: Collection<String> = emptySet()
40 open val shortcutIcon: String? get() = null
41 open val isFullAccessOnly get() = false
43 override fun getPath() = toadletPath
45 open fun getPageTitle(request: FreenetRequest) = ""
47 override fun isPrefixPage() = false
49 open fun getRedirectTarget(request: FreenetRequest): String? = null
51 open fun getAdditionalLinkNodes(request: FreenetRequest): List<Map<String, String>> = emptyList()
53 override fun isLinkExcepted(link: URI) = false
55 override fun isEnabled(toadletContext: ToadletContext) = !isFullAccessOnly
57 private val template = templatePath?.let(loaders::loadTemplate) ?: Template()
59 override fun handleRequest(request: FreenetRequest, response: Response): Response {
60 getRedirectTarget(request)?.let { redirectTarget -> return RedirectResponse(redirectTarget) }
62 if (isFullAccessOnly && !request.toadletContext.isAllowedFullAccess) {
63 return response.setStatusCode(401).setStatusText("Not authorized").setContentType("text/html")
65 val toadletContext = request.toadletContext
66 if (request.method == Method.POST) {
67 /* require form password. */
68 val formPassword = request.httpRequest.getPartAsStringFailsafe("formPassword", 32)
69 if (formPassword != toadletContext.container.formPassword) {
70 return RedirectResponse(invalidFormPasswordRedirectTarget)
73 val pageMaker = toadletContext.pageMaker
74 val pageNode = pageMaker.getPageNode(getPageTitle(request), toadletContext)
76 styleSheets.forEach(pageNode::addCustomStyleSheet)
77 getAdditionalLinkNodes(request)
78 .map { it to pageNode.headNode.addChild("link") }
79 .forEach { (linkNodeParameters, linkNode) ->
80 linkNodeParameters.forEach(linkNode::addAttribute)
82 shortcutIcon?.let { pageNode.addForwardLink("icon", it) }
85 val start = System.nanoTime()
86 templateRenderer.render(template) { templateContext ->
87 processTemplate(request, templateContext)
89 val finish = System.nanoTime()
90 logger.log(Level.FINEST, format("Template was rendered in %.2fms.", (finish - start) / 1000000.0))
92 } catch (re1: RedirectException) {
93 return RedirectResponse(re1.target ?: "")
96 pageNode.content.addChild("%", output)
98 return response.setStatusCode(200).setStatusText("OK").setContentType("text/html").write(pageNode.outer.generate())
101 open fun processTemplate(request: FreenetRequest, templateContext: TemplateContext) {
105 class RedirectException(val target: String?) : Exception() {
106 override fun toString(): String = format("RedirectException{target='%s'}", target)
111 private val logger: Logger = getLogger(FreenetTemplatePage::class.java.name)