2 * Sone - SearchPage.java - Copyright © 2010 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.sone.web;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.Comparator;
24 import java.util.HashSet;
25 import java.util.List;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import net.pterodactylus.sone.data.Post;
31 import net.pterodactylus.sone.data.PostReply;
32 import net.pterodactylus.sone.data.Profile;
33 import net.pterodactylus.sone.data.Profile.Field;
34 import net.pterodactylus.sone.data.Reply;
35 import net.pterodactylus.sone.data.Sone;
36 import net.pterodactylus.sone.web.page.FreenetRequest;
37 import net.pterodactylus.util.cache.Cache;
38 import net.pterodactylus.util.cache.CacheException;
39 import net.pterodactylus.util.cache.CacheItem;
40 import net.pterodactylus.util.cache.DefaultCacheItem;
41 import net.pterodactylus.util.cache.MemoryCache;
42 import net.pterodactylus.util.cache.ValueRetriever;
43 import net.pterodactylus.util.collection.Mapper;
44 import net.pterodactylus.util.collection.Mappers;
45 import net.pterodactylus.util.collection.Pagination;
46 import net.pterodactylus.util.collection.TimedMap;
47 import net.pterodactylus.util.filter.Filter;
48 import net.pterodactylus.util.filter.Filters;
49 import net.pterodactylus.util.logging.Logging;
50 import net.pterodactylus.util.number.Numbers;
51 import net.pterodactylus.util.template.Template;
52 import net.pterodactylus.util.template.TemplateContext;
53 import net.pterodactylus.util.text.StringEscaper;
54 import net.pterodactylus.util.text.TextException;
57 * This page lets the user search for posts and replies that contain certain
60 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
62 public class SearchPage extends SoneTemplatePage {
65 private static final Logger logger = Logging.getLogger(SearchPage.class);
67 /** Short-term cache. */
68 private final Cache<List<Phrase>, Set<Hit<Post>>> hitCache = new MemoryCache<List<Phrase>, Set<Hit<Post>>>(new ValueRetriever<List<Phrase>, Set<Hit<Post>>>() {
70 @SuppressWarnings("synthetic-access")
71 public CacheItem<Set<Hit<Post>>> retrieve(List<Phrase> phrases) throws CacheException {
72 Set<Post> posts = new HashSet<Post>();
73 for (Sone sone : webInterface.getCore().getSones()) {
74 posts.addAll(sone.getPosts());
76 return new DefaultCacheItem<Set<Hit<Post>>>(getHits(Filters.filteredSet(posts, Post.FUTURE_POSTS_FILTER), phrases, new PostStringGenerator()));
79 }, new TimedMap<List<Phrase>, CacheItem<Set<Hit<Post>>>>(300000));
82 * Creates a new search page.
85 * The template to render
87 * The Sone web interface
89 public SearchPage(Template template, WebInterface webInterface) {
90 super("search.html", template, "Page.Search.Title", webInterface);
94 // SONETEMPLATEPAGE METHODS
101 protected void processTemplate(FreenetRequest request, TemplateContext templateContext) throws RedirectException {
102 super.processTemplate(request, templateContext);
103 String query = request.getHttpRequest().getParam("query").trim();
104 if (query.length() == 0) {
105 throw new RedirectException("index.html");
108 List<Phrase> phrases = parseSearchPhrases(query);
109 if (phrases.isEmpty()) {
110 throw new RedirectException("index.html");
113 Set<Sone> sones = webInterface.getCore().getSones();
114 Set<Hit<Sone>> soneHits = getHits(sones, phrases, SoneStringGenerator.COMPLETE_GENERATOR);
116 Set<Hit<Post>> postHits;
118 postHits = hitCache.get(phrases);
119 } catch (CacheException ce1) {
120 /* should never happen. */
121 logger.log(Level.SEVERE, "Could not get search results from cache!", ce1);
122 postHits = Collections.emptySet();
126 soneHits = Filters.filteredSet(soneHits, Hit.POSITIVE_FILTER);
127 postHits = Filters.filteredSet(postHits, Hit.POSITIVE_FILTER);
130 List<Hit<Sone>> sortedSoneHits = new ArrayList<Hit<Sone>>(soneHits);
131 Collections.sort(sortedSoneHits, Hit.DESCENDING_COMPARATOR);
132 List<Hit<Post>> sortedPostHits = new ArrayList<Hit<Post>>(postHits);
133 Collections.sort(sortedPostHits, Hit.DESCENDING_COMPARATOR);
135 /* extract Sones and posts. */
136 List<Sone> resultSones = Mappers.mappedList(sortedSoneHits, new HitMapper<Sone>());
137 List<Post> resultPosts = Mappers.mappedList(sortedPostHits, new HitMapper<Post>());
140 Pagination<Sone> sonePagination = new Pagination<Sone>(resultSones, webInterface.getCore().getPreferences().getPostsPerPage()).setPage(Numbers.safeParseInteger(request.getHttpRequest().getParam("sonePage"), 0));
141 Pagination<Post> postPagination = new Pagination<Post>(resultPosts, webInterface.getCore().getPreferences().getPostsPerPage()).setPage(Numbers.safeParseInteger(request.getHttpRequest().getParam("postPage"), 0));
143 templateContext.set("sonePagination", sonePagination);
144 templateContext.set("soneHits", sonePagination.getItems());
145 templateContext.set("postPagination", postPagination);
146 templateContext.set("postHits", postPagination.getItems());
154 * Collects hit information for the given objects. The objects are converted
155 * to a {@link String} using the given {@link StringGenerator}, and the
156 * {@link #calculateScore(List, String) calculated score} is stored together
157 * with the object in a {@link Hit}, and all resulting {@link Hit}s are then
161 * The type of the objects
163 * The objects to search over
165 * The phrases to search for
166 * @param stringGenerator
167 * The string generator for the objects
168 * @return The hits for the given phrases
170 private <T> Set<Hit<T>> getHits(Collection<T> objects, List<Phrase> phrases, StringGenerator<T> stringGenerator) {
171 Set<Hit<T>> hits = new HashSet<Hit<T>>();
172 for (T object : objects) {
173 String objectString = stringGenerator.generateString(object);
174 double score = calculateScore(phrases, objectString);
175 hits.add(new Hit<T>(object, score));
181 * Parses the given query into search phrases. The query is split on
182 * whitespace while allowing to group words using single or double quotes.
183 * Isolated phrases starting with a “+” are
184 * {@link Phrase.Optionality#REQUIRED}, phrases with a “-” are
185 * {@link Phrase.Optionality#FORBIDDEN}.
189 * @return The parsed phrases
191 private List<Phrase> parseSearchPhrases(String query) {
192 List<String> parsedPhrases = null;
194 parsedPhrases = StringEscaper.parseLine(query);
195 } catch (TextException te1) {
197 return Collections.emptyList();
200 List<Phrase> phrases = new ArrayList<Phrase>();
201 for (String phrase : parsedPhrases) {
202 if (phrase.startsWith("+")) {
203 if (phrase.length() > 1) {
204 phrases.add(new Phrase(phrase.substring(1), Phrase.Optionality.REQUIRED));
206 phrases.add(new Phrase("+", Phrase.Optionality.OPTIONAL));
208 } else if (phrase.startsWith("-")) {
209 if (phrase.length() > 1) {
210 phrases.add(new Phrase(phrase.substring(1), Phrase.Optionality.FORBIDDEN));
212 phrases.add(new Phrase("-", Phrase.Optionality.OPTIONAL));
215 phrases.add(new Phrase(phrase, Phrase.Optionality.OPTIONAL));
222 * Calculates the score for the given expression when using the given
226 * The phrases to search for
228 * The expression to search
229 * @return The score of the expression
231 private double calculateScore(List<Phrase> phrases, String expression) {
232 logger.log(Level.FINEST, "Calculating Score for “%s”…", expression);
233 double optionalHits = 0;
234 double requiredHits = 0;
235 int forbiddenHits = 0;
236 int requiredPhrases = 0;
237 for (Phrase phrase : phrases) {
238 String phraseString = phrase.getPhrase().toLowerCase();
239 if (phrase.getOptionality() == Phrase.Optionality.REQUIRED) {
245 while (index < expression.length()) {
246 int position = expression.toLowerCase().indexOf(phraseString, index);
247 if (position == -1) {
250 score += Math.pow(1 - position / (double) expression.length(), 2);
251 index = position + phraseString.length();
252 logger.log(Level.FINEST, "Got hit at position %d.", position);
255 logger.log(Level.FINEST, "Score: %f", score);
259 if (phrase.getOptionality() == Phrase.Optionality.REQUIRED) {
260 requiredHits += score;
262 if (phrase.getOptionality() == Phrase.Optionality.OPTIONAL) {
263 optionalHits += score;
265 if (phrase.getOptionality() == Phrase.Optionality.FORBIDDEN) {
266 forbiddenHits += matches;
269 return requiredHits * 3 + optionalHits + (requiredHits - requiredPhrases) * 5 - (forbiddenHits * 2);
273 * Converts a given object into a {@link String}.
276 * The type of the objects
277 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
279 private static interface StringGenerator<T> {
282 * Generates a {@link String} for the given object.
285 * The object to generate the {@link String} for
286 * @return The generated {@link String}
288 public String generateString(T object);
293 * Generates a {@link String} from a {@link Sone}, concatenating the name of
294 * the Sone and all {@link Profile} {@link Field} values.
296 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
298 private static class SoneStringGenerator implements StringGenerator<Sone> {
300 /** A static instance of a complete Sone string generator. */
301 public static final SoneStringGenerator COMPLETE_GENERATOR = new SoneStringGenerator(true);
304 * A static instance of a Sone string generator that will only use the
307 public static final SoneStringGenerator NAME_GENERATOR = new SoneStringGenerator(false);
309 /** Whether to generate a string from all data of a Sone. */
310 private final boolean complete;
313 * Creates a new Sone string generator.
316 * {@code true} to use the profile’s fields, {@code false} to
317 * not to use the profile‘s fields
319 private SoneStringGenerator(boolean complete) {
320 this.complete = complete;
327 public String generateString(Sone sone) {
328 StringBuilder soneString = new StringBuilder();
329 soneString.append(sone.getName());
330 Profile soneProfile = sone.getProfile();
331 if (soneProfile.getFirstName() != null) {
332 soneString.append(' ').append(soneProfile.getFirstName());
334 if (soneProfile.getMiddleName() != null) {
335 soneString.append(' ').append(soneProfile.getMiddleName());
337 if (soneProfile.getLastName() != null) {
338 soneString.append(' ').append(soneProfile.getLastName());
341 for (Field field : soneProfile.getFields()) {
342 soneString.append(' ').append(field.getValue());
345 return soneString.toString();
351 * Generates a {@link String} from a {@link Post}, concatenating the text of
352 * the post, the text of all {@link Reply}s, and the name of all
353 * {@link Sone}s that have replied.
355 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
357 private class PostStringGenerator implements StringGenerator<Post> {
363 public String generateString(Post post) {
364 StringBuilder postString = new StringBuilder();
365 postString.append(post.getText());
366 if (post.getRecipient() != null) {
367 postString.append(' ').append(SoneStringGenerator.NAME_GENERATOR.generateString(post.getRecipient()));
369 for (PostReply reply : Filters.filteredList(webInterface.getCore().getReplies(post), Reply.FUTURE_REPLY_FILTER)) {
370 postString.append(' ').append(SoneStringGenerator.NAME_GENERATOR.generateString(reply.getSone()));
371 postString.append(' ').append(reply.getText());
373 return postString.toString();
381 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
383 private static class Phrase {
386 * The optionality of a search phrase.
388 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’
391 public enum Optionality {
393 /** The phrase is optional. */
396 /** The phrase is required. */
399 /** The phrase is forbidden. */
404 /** The phrase to search for. */
405 private final String phrase;
407 /** The optionality of the phrase. */
408 private final Optionality optionality;
411 * Creates a new phrase.
414 * The phrase to search for
416 * The optionality of the phrase
418 public Phrase(String phrase, Optionality optionality) {
419 this.optionality = optionality;
420 this.phrase = phrase;
424 * Returns the phrase to search for.
426 * @return The phrase to search for
428 public String getPhrase() {
433 * Returns the optionality of the phrase.
435 * @return The optionality of the phrase
437 public Optionality getOptionality() {
449 public int hashCode() {
450 return phrase.hashCode() ^ ((optionality == Optionality.FORBIDDEN) ? (0xaaaaaaaa) : ((optionality == Optionality.REQUIRED) ? 0x55555555 : 0));
457 public boolean equals(Object object) {
458 if (!(object instanceof Phrase)) {
461 Phrase phrase = (Phrase) object;
462 return (this.optionality == phrase.optionality) && this.phrase.equals(phrase.phrase);
468 * A hit consists of a searched object and the score it got for the phrases
471 * @see SearchPage#calculateScore(List, String)
473 * The type of the searched object
474 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
476 private static class Hit<T> {
478 /** Filter for {@link Hit}s with a score of more than 0. */
479 public static final Filter<Hit<?>> POSITIVE_FILTER = new Filter<Hit<?>>() {
482 public boolean filterObject(Hit<?> hit) {
483 return hit.getScore() > 0;
488 /** Comparator that sorts {@link Hit}s descending by score. */
489 public static final Comparator<Hit<?>> DESCENDING_COMPARATOR = new Comparator<Hit<?>>() {
492 public int compare(Hit<?> leftHit, Hit<?> rightHit) {
493 return (rightHit.getScore() < leftHit.getScore()) ? -1 : ((rightHit.getScore() > leftHit.getScore()) ? 1 : 0);
498 /** The object that was searched. */
499 private final T object;
501 /** The score of the object. */
502 private final double score;
508 * The object that was searched
510 * The score of the object
512 public Hit(T object, double score) {
513 this.object = object;
518 * Returns the object that was searched.
520 * @return The object that was searched
522 public T getObject() {
527 * Returns the score of the object.
529 * @return The score of the object
531 public double getScore() {
538 * Extracts the object from a {@link Hit}.
541 * The type of the object to extract
542 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
544 public static class HitMapper<T> implements Mapper<Hit<T>, T> {
550 public T map(Hit<T> input) {
551 return input.getObject();