blob: 5ecccc7d4cb27b763d8dd7236fbb8d6b7fc5febb [file] [log] [blame]
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +02001package eu.mulk.mulkcms2.benki.posts;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +01002
Matthias Andreas Benkard2d4f92e2020-02-09 16:15:07 +01003import eu.mulk.mulkcms2.benki.accesscontrol.Role;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +01004import eu.mulk.mulkcms2.benki.bookmarks.Bookmark;
5import eu.mulk.mulkcms2.benki.lazychat.LazychatMessage;
Matthias Andreas Benkardd9b95882020-01-24 11:42:49 +01006import eu.mulk.mulkcms2.benki.users.User;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +01007import eu.mulk.mulkcms2.benki.users.User_;
Matthias Andreas Benkard35cb1592020-01-24 11:05:20 +01008import io.quarkus.hibernate.orm.panache.PanacheEntityBase;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +01009import io.quarkus.security.identity.SecurityIdentity;
Matthias Andreas Benkardd9b95882020-01-24 11:42:49 +010010import java.time.OffsetDateTime;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +010011import java.util.ArrayList;
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +010012import java.util.List;
13import java.util.Objects;
Matthias Andreas Benkardf9c74272020-01-24 11:51:35 +010014import java.util.Set;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +010015import javax.annotation.CheckForNull;
Matthias Andreas Benkard6cfe16b2020-04-18 15:36:04 +020016import javax.annotation.Nullable;
Matthias Andreas Benkard06e6c812020-04-13 17:01:35 +020017import javax.json.bind.annotation.JsonbTransient;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010018import javax.persistence.Column;
19import javax.persistence.Entity;
Matthias Andreas Benkardf9c74272020-01-24 11:51:35 +010020import javax.persistence.FetchType;
Matthias Andreas Benkard0246c3e2020-01-27 05:39:08 +010021import javax.persistence.GeneratedValue;
22import javax.persistence.GenerationType;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010023import javax.persistence.Id;
Matthias Andreas Benkardd9b95882020-01-24 11:42:49 +010024import javax.persistence.Inheritance;
25import javax.persistence.InheritanceType;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010026import javax.persistence.JoinColumn;
Matthias Andreas Benkardf9c74272020-01-24 11:51:35 +010027import javax.persistence.JoinTable;
28import javax.persistence.ManyToMany;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010029import javax.persistence.ManyToOne;
Matthias Andreas Benkard0246c3e2020-01-27 05:39:08 +010030import javax.persistence.SequenceGenerator;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010031import javax.persistence.Table;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +010032import javax.persistence.criteria.CriteriaBuilder;
33import javax.persistence.criteria.CriteriaQuery;
34import javax.persistence.criteria.From;
35import javax.persistence.criteria.JoinType;
36import javax.persistence.criteria.Predicate;
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +010037import org.hibernate.Session;
38import org.jboss.logging.Logger;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010039
40@Entity
Matthias Andreas Benkard57c9a8a2020-01-24 19:09:38 +010041@Table(name = "posts", schema = "benki")
Matthias Andreas Benkardd9b95882020-01-24 11:42:49 +010042@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
43public abstract class Post extends PanacheEntityBase {
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010044
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +010045 private static Logger log = Logger.getLogger(Post.class);
46
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010047 @Id
Matthias Andreas Benkard0246c3e2020-01-27 05:39:08 +010048 @SequenceGenerator(
49 allocationSize = 1,
50 sequenceName = "posts_id_seq",
51 name = "posts_id_seq",
52 schema = "benki")
53 @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "posts_id_seq")
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010054 @Column(name = "id", nullable = false)
Matthias Andreas Benkard0246c3e2020-01-27 05:39:08 +010055 public Integer id;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010056
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010057 @Column(name = "date", nullable = true)
Matthias Andreas Benkardd9b95882020-01-24 11:42:49 +010058 public OffsetDateTime date;
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010059
Matthias Andreas Benkardaa754802020-01-24 11:55:26 +010060 @ManyToOne(fetch = FetchType.LAZY)
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +010061 @JoinColumn(name = "owner", referencedColumnName = "id")
Matthias Andreas Benkard06e6c812020-04-13 17:01:35 +020062 @JsonbTransient
Matthias Andreas Benkard35cb1592020-01-24 11:05:20 +010063 public User owner;
Matthias Andreas Benkardf9c74272020-01-24 11:51:35 +010064
65 @ManyToMany(fetch = FetchType.LAZY)
66 @JoinTable(
67 name = "user_visible_posts",
Matthias Andreas Benkard553de3e2020-01-27 05:33:15 +010068 schema = "benki",
Matthias Andreas Benkardf9c74272020-01-24 11:51:35 +010069 joinColumns = @JoinColumn(name = "message"),
70 inverseJoinColumns = @JoinColumn(name = "user"))
Matthias Andreas Benkard06e6c812020-04-13 17:01:35 +020071 @JsonbTransient
Matthias Andreas Benkardf9c74272020-01-24 11:51:35 +010072 public Set<User> visibleTo;
Matthias Andreas Benkard2d4f92e2020-02-09 16:15:07 +010073
74 @ManyToMany(fetch = FetchType.LAZY)
75 @JoinTable(
76 name = "post_targets",
77 schema = "benki",
78 joinColumns = @JoinColumn(name = "message"),
79 inverseJoinColumns = @JoinColumn(name = "target"))
Matthias Andreas Benkard06e6c812020-04-13 17:01:35 +020080 @JsonbTransient
Matthias Andreas Benkard2d4f92e2020-02-09 16:15:07 +010081 public Set<Role> targets;
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +010082
Matthias Andreas Benkard371164a2020-03-23 06:21:25 +010083 public abstract boolean isBookmark();
84
85 public abstract boolean isLazychatMessage();
86
Matthias Andreas Benkardd5ae0d52020-03-29 18:57:22 +020087 @CheckForNull
88 public abstract String getTitle();
89
90 @CheckForNull
91 public abstract String getDescriptionHtml();
92
93 @CheckForNull
94 public abstract String getUri();
95
Matthias Andreas Benkard06e6c812020-04-13 17:01:35 +020096 public Visibility getVisibility() {
97 if (targets.isEmpty()) {
98 return Visibility.PRIVATE;
99 } else if (targets.contains(Role.getWorld())) {
100 return Visibility.PUBLIC;
101 } else {
102 // FIXME: There should really be a check whether targets.equals(owner.defaultTargets) here.
103 // Otherwise the actual visibility is DISCRETIONARY.
104 return Visibility.SEMIPRIVATE;
105 }
106 }
107
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100108 protected static <T extends Post> CriteriaQuery<T> queryViewable(
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +0100109 Class<T> entityClass,
110 SecurityIdentity readerIdentity,
111 @CheckForNull User owner,
112 @CheckForNull Integer cursor,
113 CriteriaBuilder cb,
114 boolean forward) {
115 CriteriaQuery<T> query = cb.createQuery(entityClass);
116
117 var conditions = new ArrayList<Predicate>();
118
119 From<?, T> post;
120 if (readerIdentity.isAnonymous()) {
121 post = query.from(entityClass);
122 var target = post.join(Post_.targets);
123 conditions.add(cb.equal(target, Role.getWorld()));
124 } else {
125 var userName = readerIdentity.getPrincipal().getName();
126 var user = User.findByNickname(userName);
127
128 var root = query.from(User.class);
129 conditions.add(cb.equal(root, user));
Matthias Andreas Benkardca4d7942020-04-18 14:13:41 +0200130 if (entityClass.isAssignableFrom(Post.class)) {
131 post = (From<?, T>) root.join(User_.visiblePosts);
132 } else if (entityClass.isAssignableFrom(Bookmark.class)) {
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +0100133 post = (From<?, T>) root.join(User_.visibleBookmarks);
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200134 } else if (entityClass.isAssignableFrom(LazychatMessage.class)) {
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +0100135 post = (From<?, T>) root.join(User_.visibleLazychatMessages);
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200136 } else {
Matthias Andreas Benkardca4d7942020-04-18 14:13:41 +0200137 throw new IllegalArgumentException();
Matthias Andreas Benkardf5999552020-03-22 06:52:06 +0100138 }
139 }
140
141 query.select(post);
142 post.fetch(Post_.owner, JoinType.LEFT);
143
144 if (owner != null) {
145 conditions.add(cb.equal(post.get(Post_.owner), owner));
146 }
147
148 if (forward) {
149 query.orderBy(cb.desc(post.get(Post_.id)));
150 } else {
151 query.orderBy(cb.asc(post.get(Post_.id)));
152 }
153
154 if (cursor != null) {
155 if (forward) {
156 conditions.add(cb.le(post.get(Post_.id), cursor));
157 } else {
158 conditions.add(cb.gt(post.get(Post_.id), cursor));
159 }
160 }
161
162 query.where(conditions.toArray(new Predicate[0]));
163
164 return query;
165 }
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100166
Matthias Andreas Benkard6cfe16b2020-04-18 15:36:04 +0200167 public final boolean isVisibleTo(@Nullable User user) {
168 // FIXME: Make this more efficient.
169 return getVisibility() == Visibility.PUBLIC || (user != null && visibleTo.contains(user));
170 }
171
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100172 public static class PostPage<T extends Post> {
173 public @CheckForNull Integer prevCursor;
174 public @CheckForNull Integer cursor;
175 public @CheckForNull Integer nextCursor;
176 public List<T> posts;
177
178 private PostPage(
179 @CheckForNull Integer c0,
180 @CheckForNull Integer c1,
181 @CheckForNull Integer c2,
182 List<T> resultList) {
183 this.prevCursor = c0;
184 this.cursor = c1;
185 this.nextCursor = c2;
186 this.posts = resultList;
187 }
188 }
189
Matthias Andreas Benkardd5ae0d52020-03-29 18:57:22 +0200190 public static List<Post> findViewable(
191 PostFilter postFilter, Session session, SecurityIdentity viewer, @CheckForNull User owner) {
192 return findViewable(postFilter, session, viewer, owner, null, null).posts;
193 }
194
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200195 public static PostPage<Post> findViewable(
196 PostFilter postFilter,
197 Session session,
198 SecurityIdentity viewer,
199 @CheckForNull User owner,
200 @CheckForNull Integer cursor,
201 @CheckForNull Integer count) {
202 Class<? extends Post> entityClass;
203 switch (postFilter) {
204 case BOOKMARKS_ONLY:
205 entityClass = Bookmark.class;
206 break;
207 case LAZYCHAT_MESSAGES_ONLY:
208 entityClass = LazychatMessage.class;
209 break;
210 default:
211 entityClass = Post.class;
212 }
213 return findViewable(entityClass, session, viewer, owner, cursor, count);
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100214 }
215
216 protected static <T extends Post> PostPage<T> findViewable(
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200217 Class<? extends T> entityClass,
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100218 Session session,
219 SecurityIdentity viewer,
220 @CheckForNull User owner,
221 @CheckForNull Integer cursor,
222 @CheckForNull Integer count) {
223
224 if (cursor != null) {
225 Objects.requireNonNull(count);
226 }
227
228 var cb = session.getCriteriaBuilder();
229
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200230 var forwardCriteria = queryViewable(entityClass, viewer, owner, cursor, cb, true);
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100231 var forwardQuery = session.createQuery(forwardCriteria);
232
233 if (count != null) {
234 forwardQuery.setMaxResults(count + 1);
235 }
236
237 log.debug(forwardQuery.unwrap(org.hibernate.query.Query.class).getQueryString());
238
239 @CheckForNull Integer prevCursor = null;
240 @CheckForNull Integer nextCursor = null;
241
242 if (cursor != null) {
243 // Look backwards as well so we can find the prevCursor.
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200244 var backwardCriteria = queryViewable(entityClass, viewer, owner, cursor, cb, false);
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100245 var backwardQuery = session.createQuery(backwardCriteria);
246 backwardQuery.setMaxResults(count);
247 var backwardResults = backwardQuery.getResultList();
248 if (!backwardResults.isEmpty()) {
249 prevCursor = backwardResults.get(backwardResults.size() - 1).id;
250 }
251 }
252
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200253 var forwardResults = (List<T>) forwardQuery.getResultList();
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100254 if (count != null) {
255 if (forwardResults.size() == count + 1) {
256 nextCursor = forwardResults.get(count).id;
257 forwardResults.remove((int) count);
258 }
259 }
260
Matthias Andreas Benkard4940b292020-03-29 18:41:07 +0200261 return new PostPage<T>(prevCursor, cursor, nextCursor, forwardResults);
Matthias Andreas Benkard3d399f32020-03-22 07:23:07 +0100262 }
Matthias Andreas Benkard06e6c812020-04-13 17:01:35 +0200263
264 public enum Visibility {
265 PUBLIC,
266 SEMIPRIVATE,
267 DISCRETIONARY,
268 PRIVATE,
269 }
270
271 @Override
272 public boolean equals(Object o) {
273 if (this == o) {
274 return true;
275 }
276 if (!(o instanceof Post)) {
277 return false;
278 }
279 Post post = (Post) o;
280 return Objects.equals(id, post.id);
281 }
282
283 @Override
284 public int hashCode() {
285 return Objects.hash(id);
286 }
Matthias Andreas Benkard734879e2020-01-24 10:47:37 +0100287}