src/main/java/net/pterodactylus/sone/web/page/PageToadlet.java

   1 /*
   2  * Sone - PageToadlet.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 java.io.IOException;
  21 import java.io.OutputStream;
  22 import java.net.URI;
  23
  24 import net.pterodactylus.sone.utils.AutoCloseableBucket;
  25 import net.pterodactylus.util.web.Header;
  26 import net.pterodactylus.util.web.Method;
  27 import net.pterodactylus.util.web.Page;
  28 import net.pterodactylus.util.web.Response;
  29
  30 import freenet.client.HighLevelSimpleClient;
  31 import freenet.clients.http.LinkEnabledCallback;
  32 import freenet.clients.http.LinkFilterExceptedToadlet;
  33 import freenet.clients.http.Toadlet;
  34 import freenet.clients.http.ToadletContext;
  35 import freenet.clients.http.ToadletContextClosedException;
  36 import freenet.l10n.NodeL10n;
  37 import freenet.support.MultiValueTable;
  38 import freenet.support.api.HTTPRequest;
  39
  40 /**
  41  * {@link Toadlet} implementation that is wrapped around a {@link Page}.
  42  */
  43 public class PageToadlet extends Toadlet implements LinkEnabledCallback, LinkFilterExceptedToadlet {
  44
  45         /** The name of the menu item. */
  46         private final String menuName;
  47
  48         /** The page that handles processing. */
  49         private final Page<FreenetRequest> page;
  50
  51         /** The path prefix for the page. */
  52         private final String pathPrefix;
  53
  54         /**
  55          * Creates a new toadlet that hands off processing to a {@link Page}.
  56          *
  57          * @param highLevelSimpleClient
  58          *            The high-level simple client
  59          * @param menuName
  60          *            The name of the menu item
  61          * @param page
  62          *            The page to handle processing
  63          * @param pathPrefix
  64          *            Prefix that is prepended to all {@link Page#getPath()} return
  65          *            values
  66          */
  67         protected PageToadlet(HighLevelSimpleClient highLevelSimpleClient, String menuName, Page<FreenetRequest> page, String pathPrefix) {
  68                 super(highLevelSimpleClient);
  69                 this.menuName = menuName;
  70                 this.page = page;
  71                 this.pathPrefix = pathPrefix;
  72         }
  73
  74         /**
  75          * Returns the name to display in the menu.
  76          *
  77          * @return The name in the menu
  78          */
  79         public String getMenuName() {
  80                 return menuName;
  81         }
  82
  83         /**
  84          * {@inheritDoc}
  85          */
  86         @Override
  87         public String path() {
  88                 return pathPrefix + page.getPath();
  89         }
  90
  91         /**
  92          * Handles a HTTP GET request.
  93          *
  94          * @param uri
  95          *            The URI of the request
  96          * @param httpRequest
  97          *            The HTTP request
  98          * @param toadletContext
  99          *            The toadlet context
 100          * @throws IOException
 101          *             if an I/O error occurs
 102          * @throws ToadletContextClosedException
 103          *             if the toadlet context is closed
 104          */
 105         public void handleMethodGET(URI uri, HTTPRequest httpRequest, ToadletContext toadletContext) throws IOException, ToadletContextClosedException {
 106                 handleRequest(new FreenetRequest(uri, Method.GET, httpRequest, toadletContext, NodeL10n.getBase()));
 107         }
 108
 109         /**
 110          * Handles a HTTP POST request.
 111          *
 112          * @param uri
 113          *            The URI of the request
 114          * @param httpRequest
 115          *            The HTTP request
 116          * @param toadletContext
 117          *            The toadlet context
 118          * @throws IOException
 119          *             if an I/O error occurs
 120          * @throws ToadletContextClosedException
 121          *             if the toadlet context is closed
 122          */
 123         public void handleMethodPOST(URI uri, HTTPRequest httpRequest, ToadletContext toadletContext) throws IOException, ToadletContextClosedException {
 124                 handleRequest(new FreenetRequest(uri, Method.POST, httpRequest, toadletContext, NodeL10n.getBase()));
 125         }
 126
 127         /**
 128          * {@inheritDoc}
 129          */
 130         @Override
 131         public String toString() {
 132                 return getClass().getName() + "[path=" + path() + ",page=" + page + "]";
 133         }
 134
 135         /**
 136          * Handles a HTTP request.
 137          *
 138          * @param pageRequest
 139          *            The request to handle
 140          * @throws IOException
 141          *             if an I/O error occurs
 142          * @throws ToadletContextClosedException
 143          *             if the toadlet context is closed
 144          */
 145         private void handleRequest(FreenetRequest pageRequest) throws IOException, ToadletContextClosedException {
 146                 try (AutoCloseableBucket pageBucket = new AutoCloseableBucket(pageRequest.getToadletContext().getBucketFactory().makeBucket(-1));
 147                      OutputStream pageBucketOutputStream = pageBucket.getBucket().getOutputStream()) {
 148                         Response pageResponse = page.handleRequest(pageRequest, new Response(pageBucketOutputStream));
 149                         MultiValueTable<String, String> headers = new MultiValueTable<>();
 150                         if (pageResponse.getHeaders() != null) {
 151                                 for (Header header : pageResponse.getHeaders()) {
 152                                         for (String value : header) {
 153                                                 headers.put(header.getName(), value);
 154                                         }
 155                                 }
 156                         }
 157                         writeReply(pageRequest.getToadletContext(), pageResponse.getStatusCode(), pageResponse.getContentType(), pageResponse.getStatusText(), headers, pageBucket.getBucket());
 158                 }
 159         }
 160
 161         /**
 162          * {@inheritDoc}
 163          */
 164         @Override
 165         public boolean isEnabled(ToadletContext toadletContext) {
 166                 if (page instanceof LinkEnabledCallback) {
 167                         return ((LinkEnabledCallback) page).isEnabled(toadletContext);
 168                 }
 169                 return true;
 170         }
 171
 172         //
 173         // LINKFILTEREXCEPTEDTOADLET METHODS
 174         //
 175
 176         /**
 177          * {@inheritDoc}
 178          */
 179         @Override
 180         public boolean isLinkExcepted(URI link) {
 181                 return (page instanceof FreenetPage) && ((FreenetPage) page).isLinkExcepted(link);
 182         }
 183
 184 }