src/main/kotlin/net/pterodactylus/sone/web/page/FreenetTemplatePage.kt

   1 /*
   2  * Sone - FreenetTemplatePage.java - Copyright © 2010–2019 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.web.page
  19
  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.*
  25 import java.net.*
  26 import java.util.logging.*
  27 import java.util.logging.Logger.*
  28
  29 /**
  30  * Base class for all [Page]s that are rendered with [Template]s and
  31  * fit into Freenet’s web interface.
  32  */
  33 open class FreenetTemplatePage(
  34                 private val path: String,
  35                 private val templateRenderer: TemplateRenderer,
  36                 loaders: Loaders,
  37                 template: Template,
  38                 private val invalidFormPasswordRedirectTarget: String
  39 ) : FreenetPage, LinkEnabledCallback {
  40
  41         open val styleSheets: Collection<String> = emptySet()
  42         open val shortcutIcon: String? get() = null
  43         open val isFullAccessOnly get() = false
  44
  45         override fun getPath() = path
  46
  47         open fun getPageTitle(request: FreenetRequest) = ""
  48
  49         override fun isPrefixPage() = false
  50
  51         open fun getRedirectTarget(request: FreenetRequest): String? = null
  52
  53         open fun getAdditionalLinkNodes(request: FreenetRequest): List<Map<String, String>> = emptyList()
  54
  55         override fun isLinkExcepted(link: URI) = false
  56
  57         override fun isEnabled(toadletContext: ToadletContext) = !isFullAccessOnly
  58
  59         private val template = templatePath?.let(loaders::loadTemplate) ?: template
  60
  61         override fun handleRequest(request: FreenetRequest, response: Response): Response {
  62                 getRedirectTarget(request)?.let { redirectTarget -> return RedirectResponse(redirectTarget) }
  63
  64                 if (isFullAccessOnly && !request.toadletContext.isAllowedFullAccess) {
  65                         return response.setStatusCode(401).setStatusText("Not authorized").setContentType("text/html")
  66                 }
  67                 val toadletContext = request.toadletContext
  68                 if (request.method == Method.POST) {
  69                         /* require form password. */
  70                         val formPassword = request.httpRequest.getPartAsStringFailsafe("formPassword", 32)
  71                         if (formPassword != toadletContext.container.formPassword) {
  72                                 return RedirectResponse(invalidFormPasswordRedirectTarget)
  73                         }
  74                 }
  75                 val pageMaker = toadletContext.pageMaker
  76                 val pageNode = pageMaker.getPageNode(getPageTitle(request), toadletContext)
  77
  78                 styleSheets.forEach(pageNode::addCustomStyleSheet)
  79                 getAdditionalLinkNodes(request)
  80                                 .map { it to pageNode.headNode.addChild("link") }
  81                                 .forEach { (linkNodeParameters, linkNode) ->
  82                                         linkNodeParameters.forEach(linkNode::addAttribute)
  83                                 }
  84                 shortcutIcon?.let { pageNode.addForwardLink("icon", it) }
  85
  86                 val output = try {
  87                         val start = System.nanoTime()
  88                         templateRenderer.render(template) { templateContext ->
  89                                 processTemplate(request, templateContext)
  90                         }.also {
  91                                 val finish = System.nanoTime()
  92                                 logger.log(Level.FINEST, format("Template was rendered in %.2fms.", (finish - start) / 1000000.0))
  93                         }
  94                 } catch (re1: RedirectException) {
  95                         return RedirectResponse(re1.target ?: "")
  96                 }
  97
  98                 pageNode.content.addChild("%", output)
  99
 100                 return response.setStatusCode(200).setStatusText("OK").setContentType("text/html").write(pageNode.outer.generate())
 101         }
 102
 103         open fun processTemplate(request: FreenetRequest, templateContext: TemplateContext) {
 104                 /* do nothing. */
 105         }
 106
 107         class RedirectException(val target: String?) : Exception() {
 108                 override fun toString(): String = format("RedirectException{target='%s'}", target)
 109         }
 110
 111 }
 112
 113 private val logger: Logger = getLogger(FreenetTemplatePage::class.java.name)