Add template plugin that extracts the page number from the request.
[Sone.git] / src / main / java / net / pterodactylus / sone / template / SoneAccessor.java
1 /*
2  * Sone - SoneAccessor.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.template;
19
20 import net.pterodactylus.sone.core.Core;
21 import net.pterodactylus.sone.core.Core.SoneStatus;
22 import net.pterodactylus.sone.data.Profile;
23 import net.pterodactylus.sone.data.Sone;
24 import net.pterodactylus.util.template.Accessor;
25 import net.pterodactylus.util.template.DataProvider;
26 import net.pterodactylus.util.template.ReflectionAccessor;
27
28 /**
29  * {@link Accessor} for {@link Sone}s that adds a couple of properties to Sones.
30  * <dl>
31  * <dt>niceName</dt>
32  * <dd>Will show a combination of first name, middle name, and last name, if
33  * available, otherwise the username of the Sone is returned.</dd>
34  * <dt>friend</dt>
35  * <dd>Will return {@code true} if the sone in question is a friend of the
36  * currently logged in Sone (as determined by accessing the “currentSone”
37  * variable of the given {@link DataProvider}).</dd>
38  * <dt>current</dt>
39  * <dd>Will return {@code true} if the sone in question is the currently logged
40  * in Sone.</dd>
41  * </dl>
42  *
43  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
44  */
45 public class SoneAccessor extends ReflectionAccessor {
46
47         /** The core. */
48         private final Core core;
49
50         /**
51          * Creates a new Sone accessor.
52          *
53          * @param core
54          *            The Sone core
55          */
56         public SoneAccessor(Core core) {
57                 this.core = core;
58         }
59
60         /**
61          * {@inheritDoc}
62          */
63         @Override
64         public Object get(DataProvider dataProvider, Object object, String member) {
65                 Sone sone = (Sone) object;
66                 if (member.equals("niceName")) {
67                         return getNiceName(sone);
68                 } else if (member.equals("friend")) {
69                         Sone currentSone = (Sone) dataProvider.getData("currentSone");
70                         return (currentSone != null) && currentSone.hasFriend(sone);
71                 } else if (member.equals("current")) {
72                         Sone currentSone = (Sone) dataProvider.getData("currentSone");
73                         return (currentSone != null) && currentSone.equals(sone);
74                 } else if (member.equals("blocked")) {
75                         Sone currentSone = (Sone) dataProvider.getData("currentSone");
76                         return (currentSone != null) && currentSone.isSoneBlocked(sone.getId());
77                 } else if (member.equals("modified")) {
78                         return sone.getModificationCounter() > 0;
79                 } else if (member.equals("status")) {
80                         return core.getSoneStatus(sone).toString();
81                 } else if (member.equals("unknown")) {
82                         return core.getSoneStatus(sone) == SoneStatus.unknown;
83                 } else if (member.equals("idle")) {
84                         return core.getSoneStatus(sone) == SoneStatus.idle;
85                 } else if (member.equals("inserting")) {
86                         return core.getSoneStatus(sone) == SoneStatus.inserting;
87                 } else if (member.equals("downloading")) {
88                         return core.getSoneStatus(sone) == SoneStatus.downloading;
89                 }
90                 return super.get(dataProvider, object, member);
91         }
92
93         //
94         // STATIC METHODS
95         //
96
97         /**
98          * Returns the nice name of the given Sone.
99          *
100          * @param sone
101          *            The Sone to get the nice name for
102          * @return The nice name of the Sone
103          */
104         public static String getNiceName(Sone sone) {
105                 Profile profile = sone.getProfile();
106                 String firstName = profile.getFirstName();
107                 String middleName = profile.getMiddleName();
108                 String lastName = profile.getLastName();
109                 if (firstName == null) {
110                         if (lastName == null) {
111                                 return sone.getName();
112                         }
113                         return lastName;
114                 }
115                 return firstName + ((middleName != null) ? " " + middleName : "") + ((lastName != null) ? " " + lastName : "");
116         }
117
118 }