src/main/java/net/pterodactylus/sone/web/SearchPage.java

   1 /*
   2  * Sone - OptionsPage.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.web;
  19
  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;
  26 import java.util.Set;
  27
  28 import net.pterodactylus.sone.data.Post;
  29 import net.pterodactylus.sone.data.Profile;
  30 import net.pterodactylus.sone.data.Profile.Field;
  31 import net.pterodactylus.sone.data.Reply;
  32 import net.pterodactylus.sone.data.Sone;
  33 import net.pterodactylus.util.collection.Converter;
  34 import net.pterodactylus.util.collection.Converters;
  35 import net.pterodactylus.util.collection.Pagination;
  36 import net.pterodactylus.util.filter.Filter;
  37 import net.pterodactylus.util.filter.Filters;
  38 import net.pterodactylus.util.number.Numbers;
  39 import net.pterodactylus.util.template.Template;
  40 import net.pterodactylus.util.template.TemplateContext;
  41 import net.pterodactylus.util.text.StringEscaper;
  42 import net.pterodactylus.util.text.TextException;
  43
  44 /**
  45  * This page lets the user search for posts and replies that contain certain
  46  * words.
  47  *
  48  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  49  */
  50 public class SearchPage extends SoneTemplatePage {
  51
  52         /**
  53          * Creates a new search page.
  54          *
  55          * @param template
  56          *            The template to render
  57          * @param webInterface
  58          *            The Sone web interface
  59          */
  60         public SearchPage(Template template, WebInterface webInterface) {
  61                 super("search.html", template, "Page.Search.Title", webInterface);
  62         }
  63
  64         //
  65         // SONETEMPLATEPAGE METHODS
  66         //
  67
  68         /**
  69          * {@inheritDoc}
  70          */
  71         @Override
  72         protected void processTemplate(Request request, TemplateContext templateContext) throws RedirectException {
  73                 super.processTemplate(request, templateContext);
  74                 String query = request.getHttpRequest().getParam("query").trim();
  75                 if (query.length() == 0) {
  76                         throw new RedirectException("index.html");
  77                 }
  78
  79                 List<Phrase> phrases = parseSearchPhrases(query);
  80
  81                 Set<Sone> sones = webInterface.getCore().getSones();
  82                 Set<Hit<Sone>> soneHits = getHits(sones, phrases, SoneStringGenerator.COMPLETE_GENERATOR);
  83
  84                 Set<Post> posts = new HashSet<Post>();
  85                 for (Sone sone : sones) {
  86                         posts.addAll(sone.getPosts());
  87                 }
  88                 @SuppressWarnings("synthetic-access")
  89                 Set<Hit<Post>> postHits = getHits(posts, phrases, new PostStringGenerator());
  90
  91                 /* now filter. */
  92                 soneHits = Filters.filteredSet(soneHits, Hit.POSITIVE_FILTER);
  93                 postHits = Filters.filteredSet(postHits, Hit.POSITIVE_FILTER);
  94
  95                 /* now sort. */
  96                 List<Hit<Sone>> sortedSoneHits = new ArrayList<Hit<Sone>>(soneHits);
  97                 Collections.sort(sortedSoneHits, Hit.DESCENDING_COMPARATOR);
  98                 List<Hit<Post>> sortedPostHits = new ArrayList<Hit<Post>>(postHits);
  99                 Collections.sort(sortedPostHits, Hit.DESCENDING_COMPARATOR);
 100
 101                 /* extract Sones and posts. */
 102                 List<Sone> resultSones = Converters.convertList(sortedSoneHits, new HitConverter<Sone>());
 103                 List<Post> resultPosts = Converters.convertList(sortedPostHits, new HitConverter<Post>());
 104
 105                 /* pagination. */
 106                 Pagination<Sone> sonePagination = new Pagination<Sone>(resultSones, 10).setPage(Numbers.safeParseInteger(request.getHttpRequest().getParam("sonePage"), 0));
 107                 Pagination<Post> postPagination = new Pagination<Post>(resultPosts, 10).setPage(Numbers.safeParseInteger(request.getHttpRequest().getParam("postPage"), 0));
 108
 109                 templateContext.set("sonePagination", sonePagination);
 110                 templateContext.set("soneHits", sonePagination.getItems());
 111                 templateContext.set("postPagination", postPagination);
 112                 templateContext.set("postHits", postPagination.getItems());
 113
 114                 /* mark found posts and Sones as knew. */
 115                 for (Sone sone : sonePagination.getItems()) {
 116                         webInterface.getCore().markSoneKnown(sone);
 117                 }
 118                 for (Post post : postPagination.getItems()) {
 119                         webInterface.getCore().markPostKnown(post);
 120                         for (Reply reply : webInterface.getCore().getReplies(post)) {
 121                                 webInterface.getCore().markReplyKnown(reply);
 122                         }
 123                 }
 124         }
 125
 126         //
 127         // PRIVATE METHODS
 128         //
 129
 130         /**
 131          * Collects hit information for the given objects. The objects are converted
 132          * to a {@link String} using the given {@link StringGenerator}, and the
 133          * {@link #calculateScore(List, String) calculated score} is stored together
 134          * with the object in a {@link Hit}, and all resulting {@link Hit}s are then
 135          * returned.
 136          *
 137          * @param <T>
 138          *            The type of the objects
 139          * @param objects
 140          *            The objects to search over
 141          * @param phrases
 142          *            The phrases to search for
 143          * @param stringGenerator
 144          *            The string generator for the objects
 145          * @return The hits for the given phrases
 146          */
 147         private <T> Set<Hit<T>> getHits(Collection<T> objects, List<Phrase> phrases, StringGenerator<T> stringGenerator) {
 148                 Set<Hit<T>> hits = new HashSet<Hit<T>>();
 149                 for (T object : objects) {
 150                         String objectString = stringGenerator.generateString(object);
 151                         int score = calculateScore(phrases, objectString);
 152                         hits.add(new Hit<T>(object, score));
 153                 }
 154                 return hits;
 155         }
 156
 157         /**
 158          * Parses the given query into search phrases. The query is split on
 159          * whitespace while allowing to group words using single or double quotes.
 160          * Isolated phrases starting with a “+” are
 161          * {@link Phrase.Optionality#REQUIRED}, phrases with a “-” are
 162          * {@link Phrase.Optionality#FORBIDDEN}.
 163          *
 164          * @param query
 165          *            The query to parse
 166          * @return The parsed phrases
 167          */
 168         private List<Phrase> parseSearchPhrases(String query) {
 169                 List<String> parsedPhrases = null;
 170                 try {
 171                         parsedPhrases = StringEscaper.parseLine(query);
 172                 } catch (TextException te1) {
 173                         /* invalid query. */
 174                         return Collections.emptyList();
 175                 }
 176
 177                 List<Phrase> phrases = new ArrayList<Phrase>();
 178                 for (String phrase : parsedPhrases) {
 179                         if (phrase.startsWith("+")) {
 180                                 phrases.add(new Phrase(phrase.substring(1), Phrase.Optionality.REQUIRED));
 181                         } else if (phrase.startsWith("-")) {
 182                                 phrases.add(new Phrase(phrase.substring(1), Phrase.Optionality.FORBIDDEN));
 183                         }
 184                         phrases.add(new Phrase(phrase, Phrase.Optionality.OPTIONAL));
 185                 }
 186                 return phrases;
 187         }
 188
 189         /**
 190          * Calculates the score for the given expression when using the given
 191          * phrases.
 192          *
 193          * @param phrases
 194          *            The phrases to search for
 195          * @param expression
 196          *            The expression to search
 197          * @return The score of the expression
 198          */
 199         private int calculateScore(List<Phrase> phrases, String expression) {
 200                 int optionalHits = 0;
 201                 int requiredHits = 0;
 202                 int forbiddenHits = 0;
 203                 int requiredPhrases = 0;
 204                 for (Phrase phrase : phrases) {
 205                         String phraseString = phrase.getPhrase().toLowerCase();
 206                         if (phrase.getOptionality() == Phrase.Optionality.REQUIRED) {
 207                                 ++requiredPhrases;
 208                         }
 209                         int matches = 0;
 210                         int index = 0;
 211                         while (index < expression.length()) {
 212                                 int position = expression.toLowerCase().indexOf(phraseString, index);
 213                                 if (position == -1) {
 214                                         break;
 215                                 }
 216                                 index = position + phraseString.length();
 217                                 ++matches;
 218                         }
 219                         if (matches == 0) {
 220                                 continue;
 221                         }
 222                         if (phrase.getOptionality() == Phrase.Optionality.REQUIRED) {
 223                                 requiredHits += matches;
 224                         }
 225                         if (phrase.getOptionality() == Phrase.Optionality.OPTIONAL) {
 226                                 optionalHits += matches;
 227                         }
 228                         if (phrase.getOptionality() == Phrase.Optionality.FORBIDDEN) {
 229                                 forbiddenHits += matches;
 230                         }
 231                 }
 232                 return requiredHits * 3 + optionalHits + (requiredHits - requiredPhrases) * 5 - (forbiddenHits * 2);
 233         }
 234
 235         /**
 236          * Converts a given object into a {@link String}.
 237          *
 238          * @param <T>
 239          *            The type of the objects
 240          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 241          */
 242         private static interface StringGenerator<T> {
 243
 244                 /**
 245                  * Generates a {@link String} for the given object.
 246                  *
 247                  * @param object
 248                  *            The object to generate the {@link String} for
 249                  * @return The generated {@link String}
 250                  */
 251                 public String generateString(T object);
 252
 253         }
 254
 255         /**
 256          * Generates a {@link String} from a {@link Sone}, concatenating the name of
 257          * the Sone and all {@link Profile} {@link Field} values.
 258          *
 259          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 260          */
 261         private static class SoneStringGenerator implements StringGenerator<Sone> {
 262
 263                 /** A static instance of a complete Sone string generator. */
 264                 public static final SoneStringGenerator COMPLETE_GENERATOR = new SoneStringGenerator(true);
 265
 266                 /**
 267                  * A static instance of a Sone string generator that will only use the
 268                  * name of the Sone.
 269                  */
 270                 public static final SoneStringGenerator NAME_GENERATOR = new SoneStringGenerator(false);
 271
 272                 /** Whether to generate a string from all data of a Sone. */
 273                 private final boolean complete;
 274
 275                 /**
 276                  * Creates a new Sone string generator.
 277                  *
 278                  * @param complete
 279                  *            {@code true} to use the profile’s fields, {@code false} to
 280                  *            not to use the profile‘s fields
 281                  */
 282                 private SoneStringGenerator(boolean complete) {
 283                         this.complete = complete;
 284                 }
 285
 286                 /**
 287                  * {@inheritDoc}
 288                  */
 289                 @Override
 290                 public String generateString(Sone sone) {
 291                         StringBuilder soneString = new StringBuilder();
 292                         soneString.append(sone.getName());
 293                         Profile soneProfile = sone.getProfile();
 294                         if (soneProfile.getFirstName() != null) {
 295                                 soneString.append(' ').append(soneProfile.getFirstName());
 296                         }
 297                         if (soneProfile.getMiddleName() != null) {
 298                                 soneString.append(' ').append(soneProfile.getMiddleName());
 299                         }
 300                         if (soneProfile.getLastName() != null) {
 301                                 soneString.append(' ').append(soneProfile.getLastName());
 302                         }
 303                         if (complete) {
 304                                 for (Field field : soneProfile.getFields()) {
 305                                         soneString.append(' ').append(field.getValue());
 306                                 }
 307                         }
 308                         return soneString.toString();
 309                 }
 310
 311         }
 312
 313         /**
 314          * Generates a {@link String} from a {@link Post}, concatenating the text of
 315          * the post, the text of all {@link Reply}s, and the name of all
 316          * {@link Sone}s that have replied.
 317          *
 318          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 319          */
 320         private class PostStringGenerator implements StringGenerator<Post> {
 321
 322                 /**
 323                  * {@inheritDoc}
 324                  */
 325                 @Override
 326                 public String generateString(Post post) {
 327                         StringBuilder postString = new StringBuilder();
 328                         postString.append(post.getText());
 329                         if (post.getRecipient() != null) {
 330                                 postString.append(' ').append(SoneStringGenerator.NAME_GENERATOR.generateString(post.getRecipient()));
 331                         }
 332                         for (Reply reply : webInterface.getCore().getReplies(post)) {
 333                                 postString.append(' ').append(SoneStringGenerator.NAME_GENERATOR.generateString(reply.getSone()));
 334                                 postString.append(' ').append(reply.getText());
 335                         }
 336                         return postString.toString();
 337                 }
 338
 339         }
 340
 341         /**
 342          * A search phrase.
 343          *
 344          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 345          */
 346         private static class Phrase {
 347
 348                 /**
 349                  * The optionality of a search phrase.
 350                  *
 351                  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’
 352                  *         Roden</a>
 353                  */
 354                 public enum Optionality {
 355
 356                         /** The phrase is optional. */
 357                         OPTIONAL,
 358
 359                         /** The phrase is required. */
 360                         REQUIRED,
 361
 362                         /** The phrase is forbidden. */
 363                         FORBIDDEN
 364
 365                 }
 366
 367                 /** The phrase to search for. */
 368                 private final String phrase;
 369
 370                 /** The optionality of the phrase. */
 371                 private final Optionality optionality;
 372
 373                 /**
 374                  * Creates a new phrase.
 375                  *
 376                  * @param phrase
 377                  *            The phrase to search for
 378                  * @param optionality
 379                  *            The optionality of the phrase
 380                  */
 381                 public Phrase(String phrase, Optionality optionality) {
 382                         this.optionality = optionality;
 383                         this.phrase = phrase;
 384                 }
 385
 386                 /**
 387                  * Returns the phrase to search for.
 388                  *
 389                  * @return The phrase to search for
 390                  */
 391                 public String getPhrase() {
 392                         return phrase;
 393                 }
 394
 395                 /**
 396                  * Returns the optionality of the phrase.
 397                  *
 398                  * @return The optionality of the phrase
 399                  */
 400                 public Optionality getOptionality() {
 401                         return optionality;
 402                 }
 403
 404         }
 405
 406         /**
 407          * A hit consists of a searched object and the score it got for the phrases
 408          * of the search.
 409          *
 410          * @see SearchPage#calculateScore(List, String)
 411          * @param <T>
 412          *            The type of the searched object
 413          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 414          */
 415         private static class Hit<T> {
 416
 417                 /** Filter for {@link Hit}s with a score of more than 0. */
 418                 public static final Filter<Hit<?>> POSITIVE_FILTER = new Filter<Hit<?>>() {
 419
 420                         @Override
 421                         public boolean filterObject(Hit<?> hit) {
 422                                 return hit.getScore() > 0;
 423                         }
 424
 425                 };
 426
 427                 /** Comparator that sorts {@link Hit}s descending by score. */
 428                 public static final Comparator<Hit<?>> DESCENDING_COMPARATOR = new Comparator<Hit<?>>() {
 429
 430                         @Override
 431                         public int compare(Hit<?> leftHit, Hit<?> rightHit) {
 432                                 return rightHit.getScore() - leftHit.getScore();
 433                         }
 434
 435                 };
 436
 437                 /** The object that was searched. */
 438                 private final T object;
 439
 440                 /** The score of the object. */
 441                 private final int score;
 442
 443                 /**
 444                  * Creates a new hit.
 445                  *
 446                  * @param object
 447                  *            The object that was searched
 448                  * @param score
 449                  *            The score of the object
 450                  */
 451                 public Hit(T object, int score) {
 452                         this.object = object;
 453                         this.score = score;
 454                 }
 455
 456                 /**
 457                  * Returns the object that was searched.
 458                  *
 459                  * @return The object that was searched
 460                  */
 461                 public T getObject() {
 462                         return object;
 463                 }
 464
 465                 /**
 466                  * Returns the score of the object.
 467                  *
 468                  * @return The score of the object
 469                  */
 470                 public int getScore() {
 471                         return score;
 472                 }
 473
 474         }
 475
 476         /**
 477          * Extracts the object from a {@link Hit}.
 478          *
 479          * @param <T>
 480          *            The type of the object to extract
 481          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 482          */
 483         public static class HitConverter<T> implements Converter<Hit<T>, T> {
 484
 485                 /**
 486                  * {@inheritDoc}
 487                  */
 488                 @Override
 489                 public T convert(Hit<T> input) {
 490                         return input.getObject();
 491                 }
 492
 493         }
 494
 495 }