From 1b1f5f1907fb307abd9f94cf3a1f9a2ee247c8d1 Mon Sep 17 00:00:00 2001
From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?=
 <bombe@pterodactylus.net>
Date: Wed, 10 Nov 2010 09:59:02 +0100
Subject: [PATCH] =?utf8?q?Filter=20CSS=20class=20names,=20=E2=80=9C~?=
 =?utf8?q?=E2=80=9D=20is=20not=20a=20valid=20character.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

---
 .../sone/template/CssClassNameFilter.java          | 42 ++++++++++++++++++++++
 .../net/pterodactylus/sone/web/WebInterface.java   |  2 ++
 src/main/resources/static/javascript/sone.js       | 17 +++++++--
 src/main/resources/templates/include/viewSone.html |  2 +-
 4 files changed, 59 insertions(+), 4 deletions(-)
 create mode 100644 src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java

diff --git a/src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java b/src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java
new file mode 100644
index 0000000..6ba5d6b
--- /dev/null
+++ b/src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java
@@ -0,0 +1,42 @@
+/*
+ * Sone - CssClassNameFilter.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 <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.template;
+
+import java.util.Map;
+
+import net.pterodactylus.util.template.DataProvider;
+import net.pterodactylus.util.template.Filter;
+
+/**
+ * Converts the {@link String} {@link String#valueOf(Object) representation} of
+ * an object to a valid CSS class name by converting all characters that are not
+ * US-ASCII letters or numbers to an underscore.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public class CssClassNameFilter implements Filter {
+
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override
+	public Object format(DataProvider dataProvider, Object data, Map<String, String> parameters) {
+		return String.valueOf(data).replaceAll("[^a-zA-Z0-9-]", "_");
+	}
+
+}
diff --git a/src/main/java/net/pterodactylus/sone/web/WebInterface.java b/src/main/java/net/pterodactylus/sone/web/WebInterface.java
index c0d903a..e387b44 100644
--- a/src/main/java/net/pterodactylus/sone/web/WebInterface.java
+++ b/src/main/java/net/pterodactylus/sone/web/WebInterface.java
@@ -37,6 +37,7 @@ import net.pterodactylus.sone.freenet.L10nFilter;
 import net.pterodactylus.sone.freenet.wot.Identity;
 import net.pterodactylus.sone.main.SonePlugin;
 import net.pterodactylus.sone.template.CollectionAccessor;
+import net.pterodactylus.sone.template.CssClassNameFilter;
 import net.pterodactylus.sone.template.GetPagePlugin;
 import net.pterodactylus.sone.template.IdentityAccessor;
 import net.pterodactylus.sone.template.PostAccessor;
@@ -186,6 +187,7 @@ public class WebInterface {
 		templateFactory.addFilter("xml", new XmlFilter());
 		templateFactory.addFilter("change", new RequestChangeFilter());
 		templateFactory.addFilter("match", new MatchFilter());
+		templateFactory.addFilter("css", new CssClassNameFilter());
 		templateFactory.addPlugin("getpage", new GetPagePlugin());
 		templateFactory.addPlugin("paginate", new PaginationPlugin());
 		templateFactory.setTemplateProvider(new ClassPathTemplateProvider(templateFactory));
diff --git a/src/main/resources/static/javascript/sone.js b/src/main/resources/static/javascript/sone.js
index 66314e1..05ab5a0 100644
--- a/src/main/resources/static/javascript/sone.js
+++ b/src/main/resources/static/javascript/sone.js
@@ -112,6 +112,17 @@ function getSoneStatus(soneId) {
 }
 
 /**
+ * Filters the given Sone ID, replacing all “~” characters by an underscore.
+ *
+ * @param soneId
+ *            The Sone ID to filter
+ * @returns The filtered Sone ID
+ */
+function filterSoneId(soneId) {
+	return soneId.replace(/[^a-zA-Z0-9-]/g, "_");
+}
+
+/**
  * Updates the status of the given Sone.
  *
  * @param soneId
@@ -125,14 +136,14 @@ function getSoneStatus(soneId) {
  *            The date and time of the last update (formatted for display)
  */
 function updateSoneStatus(soneId, name, status, modified, lastUpdated) {
-	$("#sone .sone." + soneId).
+	$("#sone .sone." + filterSoneId(soneId)).
 		toggleClass("unknown", status == "unknown").
 		toggleClass("idle", status == "idle").
 		toggleClass("inserting", status == "inserting").
 		toggleClass("downloading", status == "downloading").
 		toggleClass("modified", modified);
-	$("#sone .sone." + soneId + " .last-update span.time").text(lastUpdated);
-	$("#sone .sone." + soneId + " .profile-link a").text(name);
+	$("#sone .sone." + filterSoneId(soneId) + " .last-update span.time").text(lastUpdated);
+	$("#sone .sone." + filterSoneId(soneId) + " .profile-link a").text(name);
 }
 
 var watchedSones = {};
diff --git a/src/main/resources/templates/include/viewSone.html b/src/main/resources/templates/include/viewSone.html
index d4e5b67..9cebc9c 100644
--- a/src/main/resources/templates/include/viewSone.html
+++ b/src/main/resources/templates/include/viewSone.html
@@ -1,4 +1,4 @@
-<div class="sone <% sone.status|html><%if sone.modified> modified<%/if> <% sone.id|html><%if sone.local> local<%/if>">
+<div class="sone <% sone.status|html><%if sone.modified> modified<%/if> <% sone.id|css|html><%if sone.local> local<%/if>">
 	<div class="id"><% sone.id|html></div>
 	<div class="unknown-marker" title="<%= View.Sone.Status.Unknown|l10n|html>">?</div>
 	<div class="modified-marker" title="<%= View.Sone.Status.Modified|l10n|html>">!</div>
-- 
2.7.4