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