src/main/java/net/pterodactylus/reactor/filters/TorrentSiteFilter.java

   1 /*
   2  * Reactor - KickAssTorrentsFilter.java - Copyright © 2013 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.reactor.filters;
  19
  20 import static com.google.common.base.Preconditions.checkState;
  21
  22 import java.io.UnsupportedEncodingException;
  23 import java.net.URI;
  24 import java.net.URISyntaxException;
  25 import java.net.URLEncoder;
  26
  27 import net.pterodactylus.reactor.Filter;
  28 import net.pterodactylus.reactor.State;
  29 import net.pterodactylus.reactor.queries.HttpQuery;
  30 import net.pterodactylus.reactor.states.FailedState;
  31 import net.pterodactylus.reactor.states.HtmlState;
  32 import net.pterodactylus.reactor.states.TorrentState;
  33 import net.pterodactylus.reactor.states.TorrentState.TorrentFile;
  34
  35 import org.jsoup.nodes.Document;
  36 import org.jsoup.nodes.Element;
  37 import org.jsoup.select.Elements;
  38
  39 /**
  40  * {@link Filter} implementation that parses a {@link TorrentState} from an
  41  * {@link HtmlState} which was generated by a {@link HttpQuery} to
  42  * {@code kickasstorrents.ph}.
  43  *
  44  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  45  */
  46 public abstract class TorrentSiteFilter implements Filter {
  47
  48         /**
  49          * {@inheritDoc}
  50          */
  51         @Override
  52         public State filter(State state) {
  53                 if (!state.success()) {
  54                         return FailedState.from(state);
  55                 }
  56                 checkState(state instanceof HtmlState, "state is not an HtmlState but a %s", state.getClass().getName());
  57
  58                 /* get result table. */
  59                 Document document = ((HtmlState) state).document();
  60
  61                 /* iterate over all rows. */
  62                 Elements dataRows = getDataRows(document);
  63                 TorrentState torrentState = new TorrentState();
  64                 for (Element dataRow : dataRows) {
  65                         String name = extractName(dataRow);
  66                         String size = extractSize(dataRow);
  67                         String magnetUri = extractMagnetUri(dataRow);
  68                         String downloadUri;
  69                         int fileCount = extractFileCount(dataRow);
  70                         int seedCount = extractSeedCount(dataRow);
  71                         int leechCount = extractLeechCount(dataRow);
  72                         try {
  73                                 downloadUri = new URI(((HtmlState) state).uri()).resolve(URLEncoder.encode(extractDownloadUri(dataRow), "UTF-8").replace("%2F", "/")).toString();
  74                                 TorrentFile torrentFile = new TorrentFile(name, size, magnetUri, downloadUri, fileCount, seedCount, leechCount);
  75                                 torrentState.addTorrentFile(torrentFile);
  76                         } catch (URISyntaxException use1) {
  77                                 /* ignore; if uri was wrong, we wouldn’t be here. */
  78                         } catch (UnsupportedEncodingException uee1) {
  79                                 /* ignore, all JVMs can do UTF-8. */
  80                         }
  81                 }
  82
  83                 return torrentState;
  84         }
  85
  86         //
  87         // ABSTRACT METHODS
  88         //
  89
  90         /**
  91          * Returns the data rows from the given document.
  92          *
  93          * @param document
  94          *            The document to get the data rows from
  95          * @return The data rows
  96          */
  97         protected abstract Elements getDataRows(Document document);
  98
  99         /**
 100          * Extracts the name from the given row.
 101          *
 102          * @param dataRow
 103          *            The row to extract the name from
 104          * @return The extracted name
 105          */
 106         protected abstract String extractName(Element dataRow);
 107
 108         /**
 109          * Extracts the size from the given row.
 110          *
 111          * @param dataRow
 112          *            The row to extract the size from
 113          * @return The extracted size
 114          */
 115         protected abstract String extractSize(Element dataRow);
 116
 117         /**
 118          * Extracts the magnet URI from the given row.
 119          *
 120          * @param dataRow
 121          *            The row to extract the magnet URI from
 122          * @return The extracted magnet URI
 123          */
 124         protected abstract String extractMagnetUri(Element dataRow);
 125
 126         /**
 127          * Extracts the download URI from the given row.
 128          *
 129          * @param dataRow
 130          *            The row to extract the download URI from
 131          * @return The extracted download URI
 132          */
 133         protected abstract String extractDownloadUri(Element dataRow);
 134
 135         /**
 136          * Extracts the file count from the given row.
 137          *
 138          * @param dataRow
 139          *            The row to extract the file count from
 140          * @return The extracted file count, or {@code 0} if the file count can not
 141          *         be extracted
 142          */
 143         protected abstract int extractFileCount(Element dataRow);
 144
 145         /**
 146          * Extracts the seed count from the given row.
 147          *
 148          * @param dataRow
 149          *            The row to extract the seed count from
 150          * @return The extracted seed count
 151          */
 152         protected abstract int extractSeedCount(Element dataRow);
 153
 154         /**
 155          * Extracts the leech count from the given row.
 156          *
 157          * @param dataRow
 158          *            The row to extract the leech count from
 159          * @return The extracted leech count
 160          */
 161         protected abstract int extractLeechCount(Element dataRow);
 162
 163 }