From 9d6e64f8548fd45e06a492d0b92099c27fddd378 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Wed, 27 Oct 2010 17:47:52 +0200 Subject: [PATCH] Add blacklisting functionality. --- .../java/net/pterodactylus/sone/core/Core.java | 111 ++++++++++++++++++++- .../pterodactylus/sone/template/SoneAccessor.java | 2 + .../net/pterodactylus/sone/web/BlacklistPage.java | 70 +++++++++++++ .../pterodactylus/sone/web/BlacklistSonePage.java | 74 ++++++++++++++ .../sone/web/UnblacklistSonePage.java | 74 ++++++++++++++ .../net/pterodactylus/sone/web/WebInterface.java | 6 ++ src/main/resources/i18n/sone.en.properties | 13 +++ src/main/resources/static/css/sone.css | 4 +- src/main/resources/templates/blacklist.html | 20 ++++ src/main/resources/templates/blacklistSone.html | 3 + src/main/resources/templates/include/viewSone.html | 52 ++++++---- src/main/resources/templates/unblacklistSone.html | 3 + 12 files changed, 408 insertions(+), 24 deletions(-) create mode 100644 src/main/java/net/pterodactylus/sone/web/BlacklistPage.java create mode 100644 src/main/java/net/pterodactylus/sone/web/BlacklistSonePage.java create mode 100644 src/main/java/net/pterodactylus/sone/web/UnblacklistSonePage.java create mode 100644 src/main/resources/templates/blacklist.html create mode 100644 src/main/resources/templates/blacklistSone.html create mode 100644 src/main/resources/templates/unblacklistSone.html diff --git a/src/main/java/net/pterodactylus/sone/core/Core.java b/src/main/java/net/pterodactylus/sone/core/Core.java index e0f2649..941710c 100644 --- a/src/main/java/net/pterodactylus/sone/core/Core.java +++ b/src/main/java/net/pterodactylus/sone/core/Core.java @@ -91,6 +91,9 @@ public class Core extends AbstractService { /** The Sone downloader. */ private SoneDownloader soneDownloader; + /** The Sone blacklist. */ + private final Set blacklistedSones = new HashSet(); + /** The local Sones. */ private final Set localSones = new HashSet(); @@ -163,7 +166,17 @@ public class Core extends AbstractService { * @return The local Sones */ public Set getSones() { - return Collections.unmodifiableSet(localSones); + return Filters.filteredSet(localSones, new Filter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public boolean filterObject(Sone sone) { + return !blacklistedSones.contains(sone); + } + }); } /** @@ -189,7 +202,17 @@ public class Core extends AbstractService { * @return All known sones */ public Collection getKnownSones() { - return soneCache.values(); + return Filters.filteredCollection(soneCache.values(), new Filter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public boolean filterObject(Sone sone) { + return !blacklistedSones.contains(sone); + } + }); } /** @@ -202,13 +225,33 @@ public class Core extends AbstractService { @Override @SuppressWarnings("synthetic-access") - public boolean filterObject(Sone object) { - return !localSones.contains(object); + public boolean filterObject(Sone sone) { + return !blacklistedSones.contains(sone) && !localSones.contains(sone); } }); } /** + * Returns all blacklisted Sones. + * + * @return All blacklisted Sones + */ + public Collection getBlacklistedSones() { + return Collections.unmodifiableCollection(blacklistedSones); + } + + /** + * Checks whether the given Sone is blacklisted. + * + * @param sone + * The Sone to check + * @return {@code true} if this Sone is blacklisted, {@code false} otherwise + */ + public boolean isBlacklistedSone(Sone sone) { + return blacklistedSones.contains(sone); + } + + /** * Returns the status of the given Sone. * * @param sone @@ -329,6 +372,38 @@ public class Core extends AbstractService { } /** + * Blackslists the given Sone. + * + * @param sone + * The Sone to blacklist + */ + public void blacklistSone(Sone sone) { + if (blacklistedSones.add(sone)) { + soneDownloader.removeSone(sone); + if (localSones.remove(sone)) { + SoneInserter soneInserter = soneInserters.remove(sone); + soneInserter.stop(); + } + } + } + + /** + * Unblacklists the given Sone. + * + * @param sone + * The Sone to unblacklist + */ + public void unblacklistSone(Sone sone) { + if (blacklistedSones.remove(sone)) { + if (sone.getInsertUri() != null) { + addLocalSone(sone); + } else { + addSone(sone); + } + } + } + + /** * Creates a new Sone at a random location. * * @param name @@ -789,6 +864,23 @@ public class Core extends AbstractService { } } + /* load all blacklisted Sones. */ + int blacklistedSonesCounter = 0; + while (true) { + String blacklistedSonePrefix = "BlacklistedSone." + blacklistedSonesCounter++; + String blacklistedSoneId = configuration.getStringValue(blacklistedSonePrefix + "/ID").getValue(null); + if (blacklistedSoneId == null) { + break; + } + String blacklistedSoneName = configuration.getStringValue(blacklistedSonePrefix + "/Name").getValue(null); + String blacklistedSoneKey = configuration.getStringValue(blacklistedSonePrefix + "/Key").getValue(null); + try { + blacklistSone(getSone(blacklistedSoneId).setName(blacklistedSoneName).setRequestUri(new FreenetURI(blacklistedSoneKey))); + } catch (MalformedURLException mue1) { + logger.log(Level.WARNING, "Could not create blacklisted Sone from requestUri (“" + blacklistedSoneKey + "”)!", mue1); + } + } + /* load all remote Sones. */ for (Sone remoteSone : getRemoteSones()) { loadSone(remoteSone); @@ -897,6 +989,17 @@ public class Core extends AbstractService { } configuration.getStringValue("KnownSone." + knownSonesCounter + "/ID").setValue(null); + /* write all blacklisted Sones. */ + int blacklistedSonesCounter = 0; + for (Sone blacklistedSone : getBlacklistedSones()) { + String blacklistedSonePrefix = "BlacklistedSone." + blacklistedSonesCounter++; + configuration.getStringValue(blacklistedSonePrefix + "/ID").setValue(blacklistedSone.getId()); + configuration.getStringValue(blacklistedSonePrefix + "/Name").setValue(blacklistedSone.getName()); + configuration.getStringValue(blacklistedSonePrefix + "/Key").setValue(blacklistedSone.getRequestUri().toString()); + /* TODO - store all known stuff? */ + } + configuration.getStringValue("BlacklistedSone." + blacklistedSonesCounter + "/ID").setValue(null); + } catch (ConfigurationException ce1) { logger.log(Level.WARNING, "Could not store configuration!", ce1); } diff --git a/src/main/java/net/pterodactylus/sone/template/SoneAccessor.java b/src/main/java/net/pterodactylus/sone/template/SoneAccessor.java index f1ee6e5..bb03306 100644 --- a/src/main/java/net/pterodactylus/sone/template/SoneAccessor.java +++ b/src/main/java/net/pterodactylus/sone/template/SoneAccessor.java @@ -76,6 +76,8 @@ public class SoneAccessor extends ReflectionAccessor { } else if (member.equals("blocked")) { Sone currentSone = (Sone) dataProvider.getData("currentSone"); return (currentSone != null) && currentSone.isSoneBlocked(sone.getId()); + } else if (member.equals("blacklisted")) { + return core.isBlacklistedSone(sone); } else if (member.equals("modified")) { return sone.getModificationCounter() > 0; } else if (member.equals("status")) { diff --git a/src/main/java/net/pterodactylus/sone/web/BlacklistPage.java b/src/main/java/net/pterodactylus/sone/web/BlacklistPage.java new file mode 100644 index 0000000..50146d2 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/web/BlacklistPage.java @@ -0,0 +1,70 @@ +/* + * Sone - BlacklistPage.java - Copyright © 2010 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.web; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.Comparator; +import java.util.List; + +import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.template.SoneAccessor; +import net.pterodactylus.util.template.Template; + +/** + * This page lets the user manage Sone’s global blacklist. + * + * @author David ‘Bombe’ Roden + */ +public class BlacklistPage extends SoneTemplatePage { + + /** + * Creates a new blacklist management page. + * + * @param template + * The template to render + * @param webInterface + * The Sone web interface + */ + public BlacklistPage(Template template, WebInterface webInterface) { + super("blacklist.html", template, "Page.Blacklist.Title", webInterface); + } + + // + // TEMPLATEPAGE METHODS + // + + /** + * {@inheritDoc} + */ + @Override + protected void processTemplate(Request request, Template template) throws RedirectException { + super.processTemplate(request, template); + List blacklistedSones = new ArrayList(webInterface.core().getBlacklistedSones()); + Collections.sort(blacklistedSones, new Comparator() { + + @Override + public int compare(Sone leftSone, Sone rightSone) { + return SoneAccessor.getNiceName(leftSone).compareTo(SoneAccessor.getNiceName(rightSone)); + } + + }); + template.set("blacklistedSones", blacklistedSones); + } + +} diff --git a/src/main/java/net/pterodactylus/sone/web/BlacklistSonePage.java b/src/main/java/net/pterodactylus/sone/web/BlacklistSonePage.java new file mode 100644 index 0000000..d59ff96 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/web/BlacklistSonePage.java @@ -0,0 +1,74 @@ +/* + * Sone - BlacklistSonePage.java - Copyright © 2010 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.web; + +import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.web.page.Page.Request.Method; +import net.pterodactylus.util.template.Template; + +/** + * This page lets the user blacklist a {@link Sone}. + * + * @author David ‘Bombe’ Roden + */ +public class BlacklistSonePage extends SoneTemplatePage { + + /** + * Creates a new “blacklist Sone” page. + * + * @param template + * The template to render + * @param webInterface + * The Sone web interface + */ + public BlacklistSonePage(Template template, WebInterface webInterface) { + super("blacklistSone.html", template, "Page.BlacklistSone.Title", webInterface); + } + + // + // TEMPLATEPAGE METHODS + // + + /** + * {@inheritDoc} + */ + @Override + protected void processTemplate(Request request, Template template) throws RedirectException { + super.processTemplate(request, template); + if (request.getMethod() == Method.POST) { + String soneId = request.getHttpRequest().getPartAsStringFailsafe("sone", 36); + String returnPage = request.getHttpRequest().getPartAsStringFailsafe("returnPage", 64); + Sone sone = webInterface.core().getSone(soneId); + webInterface.core().blacklistSone(sone); + throw new RedirectException(returnPage); + } + } + + // + // SONETEMPLATEPAGE METHODS + // + + /** + * {@inheritDoc} + */ + @Override + protected boolean requiresLogin() { + return false; + } + +} diff --git a/src/main/java/net/pterodactylus/sone/web/UnblacklistSonePage.java b/src/main/java/net/pterodactylus/sone/web/UnblacklistSonePage.java new file mode 100644 index 0000000..cc57608 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/web/UnblacklistSonePage.java @@ -0,0 +1,74 @@ +/* + * Sone - UnblacklistSonePage.java - Copyright © 2010 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.web; + +import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.web.page.Page.Request.Method; +import net.pterodactylus.util.template.Template; + +/** + * This page lets the user unblacklist a {@link Sone}. + * + * @author David ‘Bombe’ Roden + */ +public class UnblacklistSonePage extends SoneTemplatePage { + + /** + * Creates a new “unblacklist Sone” page. + * + * @param template + * The template to render + * @param webInterface + * The Sone web interface + */ + public UnblacklistSonePage(Template template, WebInterface webInterface) { + super("unblacklistSone.html", template, "Page.UnblacklistSone.Title", webInterface); + } + + // + // TEMPLATEPAGE METHODS + // + + /** + * {@inheritDoc} + */ + @Override + protected void processTemplate(Request request, Template template) throws RedirectException { + super.processTemplate(request, template); + if (request.getMethod() == Method.POST) { + String soneId = request.getHttpRequest().getPartAsStringFailsafe("sone", 36); + String returnPage = request.getHttpRequest().getPartAsStringFailsafe("returnPage", 64); + Sone sone = webInterface.core().getSone(soneId); + webInterface.core().unblacklistSone(sone); + throw new RedirectException(returnPage); + } + } + + // + // SONETEMPLATEPAGE METHODS + // + + /** + * {@inheritDoc} + */ + @Override + protected boolean requiresLogin() { + return false; + } + +} diff --git a/src/main/java/net/pterodactylus/sone/web/WebInterface.java b/src/main/java/net/pterodactylus/sone/web/WebInterface.java index 2339fb3..eeeec63 100644 --- a/src/main/java/net/pterodactylus/sone/web/WebInterface.java +++ b/src/main/java/net/pterodactylus/sone/web/WebInterface.java @@ -216,6 +216,9 @@ public class WebInterface extends AbstractService { Template noPermissionTemplate = templateFactory.createTemplate(createReader("/templates/noPermission.html")); Template logoutTemplate = templateFactory.createTemplate(createReader("/templates/logout.html")); Template optionsTemplate = templateFactory.createTemplate(createReader("/templates/options.html")); + Template blacklistTemplate = templateFactory.createTemplate(createReader("/templates/blacklist.html")); + Template blacklistSoneTemplate = templateFactory.createTemplate(createReader("/templates/blacklistSone.html")); + Template unblacklistSoneTemplate = templateFactory.createTemplate(createReader("/templates/unblacklistSone.html")); Template aboutTemplate = templateFactory.createTemplate(createReader("/templates/about.html")); PageToadletFactory pageToadletFactory = new PageToadletFactory(sonePlugin.pluginRespirator().getHLSimpleClient(), "/Sone/"); @@ -243,6 +246,9 @@ public class WebInterface extends AbstractService { pageToadlets.add(pageToadletFactory.createPageToadlet(new LoginPage(loginTemplate, this), "Login")); pageToadlets.add(pageToadletFactory.createPageToadlet(new LogoutPage(logoutTemplate, this), "Logout")); pageToadlets.add(pageToadletFactory.createPageToadlet(new OptionsPage(optionsTemplate, this), "Options")); + pageToadlets.add(pageToadletFactory.createPageToadlet(new BlacklistPage(blacklistTemplate, this), "Blacklist")); + pageToadlets.add(pageToadletFactory.createPageToadlet(new BlacklistSonePage(blacklistSoneTemplate, this))); + pageToadlets.add(pageToadletFactory.createPageToadlet(new UnblacklistSonePage(unblacklistSoneTemplate, this))); pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("about.html", aboutTemplate, "Page.About.Title", this), "About")); pageToadlets.add(pageToadletFactory.createPageToadlet(new SoneTemplatePage("noPermission.html", noPermissionTemplate, "Page.NoPermission.Title", this))); pageToadlets.add(pageToadletFactory.createPageToadlet(new StaticPage("css/", "/static/css/", "text/css"))); diff --git a/src/main/resources/i18n/sone.en.properties b/src/main/resources/i18n/sone.en.properties index 7d9d401..da7c8db 100644 --- a/src/main/resources/i18n/sone.en.properties +++ b/src/main/resources/i18n/sone.en.properties @@ -18,6 +18,8 @@ Navigation.Menu.Item.Logout.Name=Logout Navigation.Menu.Item.Logout.Tooltip=Logs you out of the current Sone Navigation.Menu.Item.Options.Name=Options Navigation.Menu.Item.Options.Tooltip=Options for the Sone plugin +Navigation.Menu.Item.Blacklist.Name=Blacklist +Navigation.Menu.Item.Blacklist.Tooltip=Manages the global blacklist Navigation.Menu.Item.About.Name=About Navigation.Menu.Item.About.Tooltip=Information about Sone @@ -32,6 +34,15 @@ Page.Options.Option.ClearOnNextRestart.Description=Resets the configuration of t Page.Options.Option.ReallyClearOnNextRestart.Description=This option needs to be set to “yes” if you really, {strong}really{/strong} want to clear the plugin configuration on the next restart. Page.Options.Button.Save=Save +Page.Blacklist.Title=Blacklist - Sone +Page.Blacklist.Page.Title=Blacklist +Page.Blacklist.Text.Description=The Sone on the blacklist are prevented from being distributed with your next Sone updates, and there will be no updates fetched for these Sones. +Page.Blacklist.Text.Empty=There are currently no Sones in the blacklist. + +Page.BlacklistSone.Title=Blacklist Sone - Sone + +Page.UnblacklistSone.Title=Unblacklist Sone - Sone + Page.Login.Title=Login - Sone Page.Login.Page.Title=Login Page.Login.Label.SelectSone=Select Sone: @@ -174,6 +185,8 @@ View.Sone.Button.UnfollowSone=unfollow View.Sone.Button.FollowSone=follow View.Sone.Button.UnblockSone=unblock View.Sone.Button.BlockSone=block +View.Sone.Button.BlacklistSone=blacklist +View.Sone.Button.UnblacklistSone=unblacklist View.Sone.Status.Modified=This Sone was modified and waits to be inserted. View.Sone.Status.Unknown=This Sone has not yet been retrieved. View.Sone.Status.Idle=This Sone is idle, i.e. not being inserted or downloaded. diff --git a/src/main/resources/static/css/sone.css b/src/main/resources/static/css/sone.css index b44561d..9b74217 100644 --- a/src/main/resources/static/css/sone.css +++ b/src/main/resources/static/css/sone.css @@ -328,7 +328,7 @@ textarea { display: none; } -#sone .sone form.block button, #sone .sone form.unblock button, #sone .sone form.follow button, #sone .sone form.unfollow button { +#sone .sone form.block button, #sone .sone form.unblock button, #sone .sone form.follow button, #sone .sone form.unfollow button, #sone .sone form.blacklist button, #sone .sone form.unblacklist button { display: inline; color: rgb(28, 131, 191); background: none; @@ -337,7 +337,7 @@ textarea { padding: 0px; } -#sone .sone form.block button:hover, #sone .sone form.unblock button:hover, #sone .sone form.follow button:hover, #sone .sone form.unfollow button:hover { +#sone .sone form.block button:hover, #sone .sone form.unblock button:hover, #sone .sone form.follow button:hover, #sone .sone form.unfollow button:hover, #sone .sone form.blacklist button:hover, #sone .sone form.unblacklist button:hover { display: inline; color: rgb(255, 172, 0); } diff --git a/src/main/resources/templates/blacklist.html b/src/main/resources/templates/blacklist.html new file mode 100644 index 0000000..4968cae --- /dev/null +++ b/src/main/resources/templates/blacklist.html @@ -0,0 +1,20 @@ +<%include include/head.html> + +

<%= Page.Blacklist.Page.Title|l10n|html>

+ +

<%= Page.Blacklist.Text.Description|l10n|html>

+ +
+ <%getpage> + <%paginate list=blacklistedSones pagesize=25> + <%= page|store key=pageParameter> + <%include include/pagination.html> + <%foreach pagination.items sone> + <%include include/viewSone.html> + <%foreachelse> +

<%= Page.Blacklist.Text.Empty|l10n|html>

+ <%/foreach> + <%include include/pagination.html> +
+ +<%include include/tail.html> diff --git a/src/main/resources/templates/blacklistSone.html b/src/main/resources/templates/blacklistSone.html new file mode 100644 index 0000000..196af72 --- /dev/null +++ b/src/main/resources/templates/blacklistSone.html @@ -0,0 +1,3 @@ +<%include include/head.html> + +<%include include/tail.html> diff --git a/src/main/resources/templates/include/viewSone.html b/src/main/resources/templates/include/viewSone.html index 2a0f59e..39d42da 100644 --- a/src/main/resources/templates/include/viewSone.html +++ b/src/main/resources/templates/include/viewSone.html @@ -8,31 +8,47 @@
<%= View.Sone.Label.LastUpdate|l10n|html> <% sone.time|date format="MMM d, yyyy, HH:mm:ss">
<% sone.niceName|html>
<% sone.requestUri|substring start=4 length=43|html>
- <%ifnull ! currentSone> - <%if ! sone.current> -
+ + <%if ! sone.current> + <%if ! sone.blacklisted> + - +
-
+ <%ifnull ! currentSone> + + + + + +
+
+ + + + +
+
+ + + + +
+
+ + + + +
+ <%/if> + <%else> +
- -
-
- - - - -
-
- - - - +
<%/if> <%/if> diff --git a/src/main/resources/templates/unblacklistSone.html b/src/main/resources/templates/unblacklistSone.html new file mode 100644 index 0000000..196af72 --- /dev/null +++ b/src/main/resources/templates/unblacklistSone.html @@ -0,0 +1,3 @@ +<%include include/head.html> + +<%include include/tail.html> -- 2.7.4