2 * Sone - SearchPage.java - Copyright © 2010–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.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.concurrent.TimeUnit;
28 import java.util.logging.Level;
29 import java.util.logging.Logger;
31 import net.pterodactylus.sone.data.Post;
32 import net.pterodactylus.sone.data.PostReply;
33 import net.pterodactylus.sone.data.Profile;
34 import net.pterodactylus.sone.data.Profile.Field;
35 import net.pterodactylus.sone.data.Reply;
36 import net.pterodactylus.sone.data.Sone;
37 import net.pterodactylus.sone.web.page.FreenetRequest;
38 import net.pterodactylus.util.collection.Pagination;
39 import net.pterodactylus.util.logging.Logging;
40 import net.pterodactylus.util.number.Numbers;
41 import net.pterodactylus.util.template.Template;
42 import net.pterodactylus.util.template.TemplateContext;
43 import net.pterodactylus.util.text.StringEscaper;
44 import net.pterodactylus.util.text.TextException;
46 import com.google.common.base.Function;
47 import com.google.common.base.Optional;
48 import com.google.common.base.Predicate;
49 import com.google.common.cache.CacheBuilder;
50 import com.google.common.cache.CacheLoader;
51 import com.google.common.cache.LoadingCache;
52 import com.google.common.collect.Collections2;
53 import com.google.common.collect.FluentIterable;
54 import com.google.common.collect.Ordering;
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 LoadingCache<List<Phrase>, Set<Hit<Post>>> hitCache = CacheBuilder.newBuilder().expireAfterWrite(5, TimeUnit.MINUTES).build(new CacheLoader<List<Phrase>, Set<Hit<Post>>>() {
71 @SuppressWarnings("synthetic-access")
72 public Set<Hit<Post>> load(List<Phrase> phrases) {
73 Set<Post> posts = new HashSet<Post>();
74 for (Sone sone : webInterface.getCore().getSones()) {
75 posts.addAll(sone.getPosts());
77 return getHits(Collections2.filter(posts, Post.FUTURE_POSTS_FILTER), phrases, new PostStringGenerator());
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
98 @SuppressWarnings("synthetic-access")
99 protected void processTemplate(FreenetRequest request, TemplateContext templateContext) throws RedirectException {
100 super.processTemplate(request, templateContext);
101 String query = request.getHttpRequest().getParam("query").trim();
102 if (query.length() == 0) {
103 throw new RedirectException("index.html");
106 List<Phrase> phrases = parseSearchPhrases(query);
107 if (phrases.isEmpty()) {
108 throw new RedirectException("index.html");
111 /* check for a couple of shortcuts. */
112 if (phrases.size() == 1) {
113 String phrase = phrases.get(0).getPhrase();
115 /* is it a Sone ID? */
116 redirectIfNotNull(getSoneId(phrase), "viewSone.html?sone=");
118 /* is it a post ID? */
119 redirectIfNotNull(getPostId(phrase), "viewPost.html?post=");
121 /* is it a reply ID? show the post. */
122 redirectIfNotNull(getReplyPostId(phrase), "viewPost.html?post=");
124 /* is it an album ID? */
125 redirectIfNotNull(getAlbumId(phrase), "imageBrowser.html?album=");
127 /* is it an image ID? */
128 redirectIfNotNull(getImageId(phrase), "imageBrowser.html?image=");
131 Collection<Sone> sones = webInterface.getCore().getSones();
132 Collection<Hit<Sone>> soneHits = getHits(sones, phrases, SoneStringGenerator.COMPLETE_GENERATOR);
134 Collection<Hit<Post>> postHits = hitCache.getUnchecked(phrases);
137 soneHits = Collections2.filter(soneHits, Hit.POSITIVE_FILTER);
138 postHits = Collections2.filter(postHits, Hit.POSITIVE_FILTER);
141 List<Hit<Sone>> sortedSoneHits = Ordering.from(Hit.DESCENDING_COMPARATOR).sortedCopy(soneHits);
142 List<Hit<Post>> sortedPostHits = Ordering.from(Hit.DESCENDING_COMPARATOR).sortedCopy(postHits);
144 /* extract Sones and posts. */
145 List<Sone> resultSones = FluentIterable.from(sortedSoneHits).transform(new HitMapper<Sone>()).toList();
146 List<Post> resultPosts = FluentIterable.from(sortedPostHits).transform(new HitMapper<Post>()).toList();
149 Pagination<Sone> sonePagination = new Pagination<Sone>(resultSones, webInterface.getCore().getPreferences().getPostsPerPage()).setPage(Numbers.safeParseInteger(request.getHttpRequest().getParam("sonePage"), 0));
150 Pagination<Post> postPagination = new Pagination<Post>(resultPosts, webInterface.getCore().getPreferences().getPostsPerPage()).setPage(Numbers.safeParseInteger(request.getHttpRequest().getParam("postPage"), 0));
152 templateContext.set("sonePagination", sonePagination);
153 templateContext.set("soneHits", sonePagination.getItems());
154 templateContext.set("postPagination", postPagination);
155 templateContext.set("postHits", postPagination.getItems());
163 * Collects hit information for the given objects. The objects are converted
164 * to a {@link String} using the given {@link StringGenerator}, and the
165 * {@link #calculateScore(List, String) calculated score} is stored together
166 * with the object in a {@link Hit}, and all resulting {@link Hit}s are then
170 * The type of the objects
172 * The objects to search over
174 * The phrases to search for
175 * @param stringGenerator
176 * The string generator for the objects
177 * @return The hits for the given phrases
179 private static <T> Set<Hit<T>> getHits(Collection<T> objects, List<Phrase> phrases, StringGenerator<T> stringGenerator) {
180 Set<Hit<T>> hits = new HashSet<Hit<T>>();
181 for (T object : objects) {
182 String objectString = stringGenerator.generateString(object);
183 double score = calculateScore(phrases, objectString);
184 hits.add(new Hit<T>(object, score));
190 * Parses the given query into search phrases. The query is split on
191 * whitespace while allowing to group words using single or double quotes.
192 * Isolated phrases starting with a “+” are
193 * {@link Phrase.Optionality#REQUIRED}, phrases with a “-” are
194 * {@link Phrase.Optionality#FORBIDDEN}.
198 * @return The parsed phrases
200 private static List<Phrase> parseSearchPhrases(String query) {
201 List<String> parsedPhrases = null;
203 parsedPhrases = StringEscaper.parseLine(query);
204 } catch (TextException te1) {
206 return Collections.emptyList();
209 List<Phrase> phrases = new ArrayList<Phrase>();
210 for (String phrase : parsedPhrases) {
211 if (phrase.startsWith("+")) {
212 if (phrase.length() > 1) {
213 phrases.add(new Phrase(phrase.substring(1), Phrase.Optionality.REQUIRED));
215 phrases.add(new Phrase("+", Phrase.Optionality.OPTIONAL));
217 } else if (phrase.startsWith("-")) {
218 if (phrase.length() > 1) {
219 phrases.add(new Phrase(phrase.substring(1), Phrase.Optionality.FORBIDDEN));
221 phrases.add(new Phrase("-", Phrase.Optionality.OPTIONAL));
224 phrases.add(new Phrase(phrase, Phrase.Optionality.OPTIONAL));
231 * Calculates the score for the given expression when using the given
235 * The phrases to search for
237 * The expression to search
238 * @return The score of the expression
240 private static double calculateScore(List<Phrase> phrases, String expression) {
241 logger.log(Level.FINEST, String.format("Calculating Score for “%s”…", expression));
242 double optionalHits = 0;
243 double requiredHits = 0;
244 int forbiddenHits = 0;
245 int requiredPhrases = 0;
246 for (Phrase phrase : phrases) {
247 String phraseString = phrase.getPhrase().toLowerCase();
248 if (phrase.getOptionality() == Phrase.Optionality.REQUIRED) {
254 while (index < expression.length()) {
255 int position = expression.toLowerCase().indexOf(phraseString, index);
256 if (position == -1) {
259 score += Math.pow(1 - position / (double) expression.length(), 2);
260 index = position + phraseString.length();
261 logger.log(Level.FINEST, String.format("Got hit at position %d.", position));
264 logger.log(Level.FINEST, String.format("Score: %f", score));
268 if (phrase.getOptionality() == Phrase.Optionality.REQUIRED) {
269 requiredHits += score;
271 if (phrase.getOptionality() == Phrase.Optionality.OPTIONAL) {
272 optionalHits += score;
274 if (phrase.getOptionality() == Phrase.Optionality.FORBIDDEN) {
275 forbiddenHits += matches;
278 return requiredHits * 3 + optionalHits + (requiredHits - requiredPhrases) * 5 - (forbiddenHits * 2);
283 * {@link net.pterodactylus.sone.web.page.FreenetTemplatePage.RedirectException}
284 * if the given object is not {@code null}, appending the object to the
288 * The object on which to redirect
290 * The target of the redirect
291 * @throws RedirectException
292 * if {@code object} is not {@code null}
294 private static void redirectIfNotNull(String object, String target) throws RedirectException {
295 if (object != null) {
296 throw new RedirectException(target + object);
301 * If the given phrase contains a Sone ID (optionally prefixed by
302 * “sone://”), returns said Sone ID, otherwise return {@code null}.
305 * The phrase that maybe is a Sone ID
306 * @return The Sone ID, or {@code null}
308 private String getSoneId(String phrase) {
309 String soneId = phrase.startsWith("sone://") ? phrase.substring(7) : phrase;
310 return (webInterface.getCore().getSone(soneId).isPresent()) ? soneId : null;
314 * If the given phrase contains a post ID (optionally prefixed by
315 * “post://”), returns said post ID, otherwise return {@code null}.
318 * The phrase that maybe is a post ID
319 * @return The post ID, or {@code null}
321 private String getPostId(String phrase) {
322 String postId = phrase.startsWith("post://") ? phrase.substring(7) : phrase;
323 return (webInterface.getCore().getDatabase().getPost(postId).isPresent()) ? postId : null;
327 * If the given phrase contains a reply ID (optionally prefixed by
328 * “reply://”), returns the ID of the post the reply belongs to, otherwise
329 * return {@code null}.
332 * The phrase that maybe is a reply ID
333 * @return The reply’s post ID, or {@code null}
335 private String getReplyPostId(String phrase) {
336 String replyId = phrase.startsWith("reply://") ? phrase.substring(8) : phrase;
337 Optional<PostReply> postReply = webInterface.getCore().getPostReply(replyId);
338 if (!postReply.isPresent()) {
341 return postReply.get().getPostId();
345 * If the given phrase contains an album ID (optionally prefixed by
346 * “album://”), returns said album ID, otherwise return {@code null}.
349 * The phrase that maybe is an album ID
350 * @return The album ID, or {@code null}
352 private String getAlbumId(String phrase) {
353 String albumId = phrase.startsWith("album://") ? phrase.substring(8) : phrase;
354 return webInterface.getCore().getAlbum(albumId).isPresent() ? albumId : null;
358 * If the given phrase contains an image ID (optionally prefixed by
359 * “image://”), returns said image ID, otherwise return {@code null}.
362 * The phrase that maybe is an image ID
363 * @return The image ID, or {@code null}
365 private String getImageId(String phrase) {
366 String imageId = phrase.startsWith("image://") ? phrase.substring(8) : phrase;
367 return webInterface.getCore().getImage(imageId).isPresent() ? imageId : null;
371 * Converts a given object into a {@link String}.
374 * The type of the objects
375 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
377 private static interface StringGenerator<T> {
380 * Generates a {@link String} for the given object.
383 * The object to generate the {@link String} for
384 * @return The generated {@link String}
386 public String generateString(T object);
391 * Generates a {@link String} from a {@link Sone}, concatenating the name of
392 * the Sone and all {@link Profile} {@link Field} values.
394 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
396 private static class SoneStringGenerator implements StringGenerator<Sone> {
398 /** A static instance of a complete Sone string generator. */
399 public static final SoneStringGenerator COMPLETE_GENERATOR = new SoneStringGenerator(true);
402 * A static instance of a Sone string generator that will only use the
405 public static final SoneStringGenerator NAME_GENERATOR = new SoneStringGenerator(false);
407 /** Whether to generate a string from all data of a Sone. */
408 private final boolean complete;
411 * Creates a new Sone string generator.
414 * {@code true} to use the profile’s fields, {@code false} to
415 * not to use the profile‘s fields
417 private SoneStringGenerator(boolean complete) {
418 this.complete = complete;
422 public String generateString(Sone sone) {
423 StringBuilder soneString = new StringBuilder();
424 soneString.append(sone.getName());
425 Profile soneProfile = sone.getProfile();
426 if (soneProfile.getFirstName() != null) {
427 soneString.append(' ').append(soneProfile.getFirstName());
429 if (soneProfile.getMiddleName() != null) {
430 soneString.append(' ').append(soneProfile.getMiddleName());
432 if (soneProfile.getLastName() != null) {
433 soneString.append(' ').append(soneProfile.getLastName());
436 for (Field field : soneProfile.getFields()) {
437 soneString.append(' ').append(field.getValue());
440 return soneString.toString();
446 * Generates a {@link String} from a {@link Post}, concatenating the text of
447 * the post, the text of all {@link Reply}s, and the name of all
448 * {@link Sone}s that have replied.
450 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
452 private class PostStringGenerator implements StringGenerator<Post> {
455 public String generateString(Post post) {
456 StringBuilder postString = new StringBuilder();
457 postString.append(post.getText());
458 if (post.getRecipient().isPresent()) {
459 postString.append(' ').append(SoneStringGenerator.NAME_GENERATOR.generateString(post.getRecipient().get()));
461 for (PostReply reply : Collections2.filter(webInterface.getCore().getReplies(post.getId()), Reply.FUTURE_REPLY_FILTER)) {
462 postString.append(' ').append(SoneStringGenerator.NAME_GENERATOR.generateString(reply.getSone()));
463 postString.append(' ').append(reply.getText());
465 return postString.toString();
473 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
475 private static class Phrase {
478 * The optionality of a search phrase.
480 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’
483 public enum Optionality {
485 /** The phrase is optional. */
488 /** The phrase is required. */
491 /** The phrase is forbidden. */
496 /** The phrase to search for. */
497 private final String phrase;
499 /** The optionality of the phrase. */
500 private final Optionality optionality;
503 * Creates a new phrase.
506 * The phrase to search for
508 * The optionality of the phrase
510 public Phrase(String phrase, Optionality optionality) {
511 this.optionality = optionality;
512 this.phrase = phrase;
516 * Returns the phrase to search for.
518 * @return The phrase to search for
520 public String getPhrase() {
525 * Returns the optionality of the phrase.
527 * @return The optionality of the phrase
529 public Optionality getOptionality() {
538 public int hashCode() {
539 return phrase.hashCode() ^ ((optionality == Optionality.FORBIDDEN) ? (0xaaaaaaaa) : ((optionality == Optionality.REQUIRED) ? 0x55555555 : 0));
543 public boolean equals(Object object) {
544 if (!(object instanceof Phrase)) {
547 Phrase phrase = (Phrase) object;
548 return (this.optionality == phrase.optionality) && this.phrase.equals(phrase.phrase);
554 * A hit consists of a searched object and the score it got for the phrases
557 * @see SearchPage#calculateScore(List, String)
559 * The type of the searched object
560 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
562 private static class Hit<T> {
564 /** Filter for {@link Hit}s with a score of more than 0. */
565 public static final Predicate<Hit<?>> POSITIVE_FILTER = new Predicate<Hit<?>>() {
568 public boolean apply(Hit<?> hit) {
569 return (hit == null) ? false : hit.getScore() > 0;
574 /** Comparator that sorts {@link Hit}s descending by score. */
575 public static final Comparator<Hit<?>> DESCENDING_COMPARATOR = new Comparator<Hit<?>>() {
578 public int compare(Hit<?> leftHit, Hit<?> rightHit) {
579 return (rightHit.getScore() < leftHit.getScore()) ? -1 : ((rightHit.getScore() > leftHit.getScore()) ? 1 : 0);
584 /** The object that was searched. */
585 private final T object;
587 /** The score of the object. */
588 private final double score;
594 * The object that was searched
596 * The score of the object
598 public Hit(T object, double score) {
599 this.object = object;
604 * Returns the object that was searched.
606 * @return The object that was searched
608 public T getObject() {
613 * Returns the score of the object.
615 * @return The score of the object
617 public double getScore() {
624 * Extracts the object from a {@link Hit}.
627 * The type of the object to extract
628 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
630 private static class HitMapper<T> implements Function<Hit<T>, T> {
633 public T apply(Hit<T> input) {
634 return input.getObject();