src/main/java/net/pterodactylus/sone/template/SoneAccessor.java

   1 /*
   2  * Sone - SoneAccessor.java - Copyright © 2010–2013 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.template;
  19
  20 import static com.google.common.collect.FluentIterable.from;
  21 import static java.util.Arrays.asList;
  22 import static net.pterodactylus.sone.data.Album.FLATTENER;
  23 import static net.pterodactylus.sone.data.Album.IMAGES;
  24
  25 import java.util.logging.Level;
  26 import java.util.logging.Logger;
  27
  28 import net.pterodactylus.sone.core.Core;
  29 import net.pterodactylus.sone.data.Profile;
  30 import net.pterodactylus.sone.data.Sone;
  31 import net.pterodactylus.sone.data.Sone.SoneStatus;
  32 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  33 import net.pterodactylus.sone.freenet.wot.Trust;
  34 import net.pterodactylus.sone.web.WebInterface;
  35 import net.pterodactylus.sone.web.ajax.GetTimesAjaxPage;
  36 import net.pterodactylus.util.logging.Logging;
  37 import net.pterodactylus.util.template.Accessor;
  38 import net.pterodactylus.util.template.ReflectionAccessor;
  39 import net.pterodactylus.util.template.TemplateContext;
  40
  41 /**
  42  * {@link Accessor} for {@link Sone}s that adds a couple of properties to Sones.
  43  * <dl>
  44  * <dt>niceName</dt>
  45  * <dd>Will show a combination of first name, middle name, and last name, if
  46  * available, otherwise the username of the Sone is returned.</dd>
  47  * <dt>friend</dt>
  48  * <dd>Will return {@code true} if the sone in question is a friend of the
  49  * currently logged in Sone (as determined by accessing the “currentSone”
  50  * variable of the given {@link TemplateContext}).</dd>
  51  * <dt>current</dt>
  52  * <dd>Will return {@code true} if the sone in question is the currently logged
  53  * in Sone.</dd>
  54  * </dl>
  55  *
  56  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  57  */
  58 public class SoneAccessor extends ReflectionAccessor {
  59
  60         /** The logger. */
  61         private static final Logger logger = Logging.getLogger(SoneAccessor.class);
  62
  63         /** The core. */
  64         private final Core core;
  65
  66         /**
  67          * Creates a new Sone accessor.
  68          *
  69          * @param core
  70          *            The Sone core
  71          */
  72         public SoneAccessor(Core core) {
  73                 this.core = core;
  74         }
  75
  76         /**
  77          * {@inheritDoc}
  78          */
  79         @Override
  80         public Object get(TemplateContext templateContext, Object object, String member) {
  81                 Sone sone = (Sone) object;
  82                 if (member.equals("niceName")) {
  83                         return getNiceName(sone);
  84                 } else if (member.equals("friend")) {
  85                         Sone currentSone = (Sone) templateContext.get("currentSone");
  86                         return (currentSone != null) && currentSone.hasFriend(sone.getId());
  87                 } else if (member.equals("current")) {
  88                         Sone currentSone = (Sone) templateContext.get("currentSone");
  89                         return (currentSone != null) && currentSone.equals(sone);
  90                 } else if (member.equals("modified")) {
  91                         return core.isModifiedSone(sone);
  92                 } else if (member.equals("status")) {
  93                         return sone.getStatus();
  94                 } else if (member.equals("unknown")) {
  95                         return sone.getStatus() == SoneStatus.unknown;
  96                 } else if (member.equals("idle")) {
  97                         return sone.getStatus() == SoneStatus.idle;
  98                 } else if (member.equals("inserting")) {
  99                         return sone.getStatus() == SoneStatus.inserting;
 100                 } else if (member.equals("downloading")) {
 101                         return sone.getStatus() == SoneStatus.downloading;
 102                 } else if (member.equals("new")) {
 103                         return !sone.isKnown();
 104                 } else if (member.equals("locked")) {
 105                         return core.isLocked(sone);
 106                 } else if (member.equals("lastUpdatedText")) {
 107                         return GetTimesAjaxPage.getTime((WebInterface) templateContext.get("webInterface"), sone.getTime());
 108                 } else if (member.equals("trust")) {
 109                         Sone currentSone = (Sone) templateContext.get("currentSone");
 110                         if (currentSone == null) {
 111                                 return null;
 112                         }
 113                         Trust trust = sone.getIdentity().getTrust((OwnIdentity) currentSone.getIdentity());
 114                         logger.log(Level.FINEST, String.format("Trust for %s by %s: %s", sone, currentSone, trust));
 115                         if (trust == null) {
 116                                 return new Trust(null, null, null);
 117                         }
 118                         return trust;
 119                 } else if (member.equals("allImages")) {
 120                         return from(asList(sone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES);
 121                 }
 122                 return super.get(templateContext, object, member);
 123         }
 124
 125         //
 126         // STATIC METHODS
 127         //
 128
 129         /**
 130          * Returns the nice name of the given Sone.
 131          *
 132          * @param sone
 133          *            The Sone to get the nice name for
 134          * @return The nice name of the Sone
 135          */
 136         public static String getNiceName(Sone sone) {
 137                 Profile profile = sone.getProfile();
 138                 String firstName = profile.getFirstName();
 139                 String middleName = profile.getMiddleName();
 140                 String lastName = profile.getLastName();
 141                 if (firstName == null) {
 142                         if (lastName == null) {
 143                                 return String.valueOf(sone.getName());
 144                         }
 145                         return lastName;
 146                 }
 147                 return firstName + ((middleName != null) ? " " + middleName : "") + ((lastName != null) ? " " + lastName : "");
 148         }
 149
 150 }