2 * Rhynodge - KickAssTorrentsFilter.java - Copyright © 2013 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.rhynodge.filters;
20 import static com.google.common.base.Preconditions.checkState;
22 import java.io.UnsupportedEncodingException;
24 import java.net.URISyntaxException;
25 import java.net.URLEncoder;
27 import net.pterodactylus.rhynodge.Filter;
28 import net.pterodactylus.rhynodge.State;
29 import net.pterodactylus.rhynodge.queries.HttpQuery;
30 import net.pterodactylus.rhynodge.states.FailedState;
31 import net.pterodactylus.rhynodge.states.HtmlState;
32 import net.pterodactylus.rhynodge.states.TorrentState;
33 import net.pterodactylus.rhynodge.states.TorrentState.TorrentFile;
35 import org.jetbrains.annotations.NotNull;
36 import org.jsoup.nodes.Document;
37 import org.jsoup.nodes.Element;
38 import org.jsoup.select.Elements;
41 * {@link Filter} implementation that parses a {@link TorrentState} from an
42 * {@link HtmlState} which was generated by a {@link HttpQuery} to
43 * {@code kickasstorrents.ph}.
45 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
47 public abstract class TorrentSiteFilter implements Filter {
54 public State filter(@NotNull State state) {
55 if (!state.success()) {
56 return FailedState.from(state);
58 checkState(state instanceof HtmlState, "state is not an HtmlState but a %s", state.getClass().getName());
60 /* get result table. */
61 Document document = ((HtmlState) state).document();
63 /* iterate over all rows. */
64 Elements dataRows = getDataRows(document);
65 TorrentState torrentState = new TorrentState();
66 for (Element dataRow : dataRows) {
67 String name = extractName(dataRow);
68 String size = extractSize(dataRow);
69 String magnetUri = extractMagnetUri(dataRow);
70 String downloadUri = extractDownloadUri(dataRow);
71 int fileCount = extractFileCount(dataRow);
72 int seedCount = extractSeedCount(dataRow);
73 int leechCount = extractLeechCount(dataRow);
75 if ((downloadUri != null) && (downloadUri.length() > 0)) {
76 downloadUri = new URI(((HtmlState) state).uri()).resolve(URLEncoder.encode(downloadUri, "UTF-8").replace("%2F", "/")).toString();
80 TorrentFile torrentFile = new TorrentFile(name, size, magnetUri, downloadUri, fileCount, seedCount, leechCount);
81 torrentState.addTorrentFile(torrentFile);
82 } catch (URISyntaxException use1) {
83 /* ignore; if uri was wrong, we wouldn’t be here. */
84 } catch (UnsupportedEncodingException uee1) {
85 /* ignore, all JVMs can do UTF-8. */
97 * Returns the data rows from the given document.
100 * The document to get the data rows from
101 * @return The data rows
103 protected abstract Elements getDataRows(Document document);
106 * Extracts the name from the given row.
109 * The row to extract the name from
110 * @return The extracted name
112 protected abstract String extractName(Element dataRow);
115 * Extracts the size from the given row.
118 * The row to extract the size from
119 * @return The extracted size
121 protected abstract String extractSize(Element dataRow);
124 * Extracts the magnet URI from the given row.
127 * The row to extract the magnet URI from
128 * @return The extracted magnet URI
130 protected abstract String extractMagnetUri(Element dataRow);
133 * Extracts the download URI from the given row.
136 * The row to extract the download URI from
137 * @return The extracted download URI
139 protected abstract String extractDownloadUri(Element dataRow);
142 * Extracts the file count from the given row.
145 * The row to extract the file count from
146 * @return The extracted file count, or {@code 0} if the file count can not
149 protected abstract int extractFileCount(Element dataRow);
152 * Extracts the seed count from the given row.
155 * The row to extract the seed count from
156 * @return The extracted seed count
158 protected abstract int extractSeedCount(Element dataRow);
161 * Extracts the leech count from the given row.
164 * The row to extract the leech count from
165 * @return The extracted leech count
167 protected abstract int extractLeechCount(Element dataRow);