1 package club.wpia.gigi.dbObjects;
3 import java.io.IOException;
4 import java.io.ObjectInputStream;
5 import java.io.ObjectOutputStream;
6 import java.util.ArrayList;
7 import java.util.Collections;
8 import java.util.HashSet;
9 import java.util.LinkedList;
10 import java.util.List;
11 import java.util.Locale;
13 import java.util.TreeSet;
15 import club.wpia.gigi.Gigi;
16 import club.wpia.gigi.GigiApiException;
17 import club.wpia.gigi.database.GigiPreparedStatement;
18 import club.wpia.gigi.database.GigiResultSet;
19 import club.wpia.gigi.dbObjects.CATS.CATSType;
20 import club.wpia.gigi.dbObjects.Country.CountryCodeType;
21 import club.wpia.gigi.dbObjects.Verification.VerificationType;
22 import club.wpia.gigi.email.EmailProvider;
23 import club.wpia.gigi.localisation.Language;
24 import club.wpia.gigi.output.DateSelector;
25 import club.wpia.gigi.pages.PasswordResetPage;
26 import club.wpia.gigi.passwords.PasswordStrengthChecker;
27 import club.wpia.gigi.util.CalendarUtil;
28 import club.wpia.gigi.util.DayDate;
29 import club.wpia.gigi.util.Notary;
30 import club.wpia.gigi.util.PasswordHash;
31 import club.wpia.gigi.util.TimeConditions;
34 * Represents an acting, verifiable user. Synchronizing on user means: no
35 * name-change and no verification.
37 public class User extends CertificateOwner {
39 private static final long serialVersionUID = -7915843843752264176L;
45 private Verification[] receivedVerifications;
47 private Verification[] madeVerifications;
49 private Locale locale;
51 private Set<Group> groups = new HashSet<>();
53 public static final int MINIMUM_AGE = 16;
55 public static final int MAXIMUM_PLAUSIBLE_AGE = 120;
57 public static final int POJAM_AGE = 14;
59 public static final int ADULT_AGE = 18;
61 public static final boolean POJAM_ENABLED = false;
63 public static final int EXPERIENCE_POINTS = 4;
66 * Time in months a verification is considered "recent".
68 public static final int VERIFICATION_MONTHS = TimeConditions.getInstance().getVerificationMonths();
70 private Name preferredName;
72 private Country residenceCountry;
74 protected User(GigiResultSet rs) throws GigiApiException {
75 super(rs.getInt("id"));
77 dob = new DayDate(rs.getDate("dob"));
78 email = rs.getString("email");
79 preferredName = Name.getById(rs.getInt("preferredName"));
81 if (rs.getString("country") != null) {
82 residenceCountry = Country.getCountryByCode(rs.getString("Country"), Country.CountryCodeType.CODE_2_CHARS);
85 String localeStr = rs.getString("language");
86 if (localeStr == null || localeStr.equals("")) {
87 locale = Locale.getDefault();
89 locale = Language.getLocaleFromString(localeStr);
95 public synchronized void refreshGroups() {
96 HashSet<Group> hs = new HashSet<>();
97 try (GigiPreparedStatement psg = new GigiPreparedStatement("SELECT `permission` FROM `user_groups` WHERE `user`=? AND `deleted` is NULL")) {
98 psg.setInt(1, getId());
100 try (GigiResultSet rs2 = psg.executeQuery()) {
102 hs.add(Group.getByString(rs2.getString(1)));
109 public User(String email, String password, DayDate dob, Locale locale, Country residenceCountry, NamePart... preferred) throws GigiApiException {
110 super(validate(email));
114 this.locale = locale;
115 this.preferredName = new Name(this, preferred);
116 try (GigiPreparedStatement query = new GigiPreparedStatement("INSERT INTO `users` SET `email`=?, `password`=?, `dob`=?, `language`=?, id=?, `preferredName`=?, `country` = ?")) {
117 query.setString(1, email);
118 query.setString(2, PasswordHash.hash(password));
119 query.setDate(3, dob.toSQLDate());
120 query.setString(4, locale.toString());
121 query.setInt(5, getId());
122 query.setInt(6, preferredName.getId());
123 query.setString(7, residenceCountry == null ? null : residenceCountry.getCode());
127 new EmailAddress(this, email, locale);
130 private static Void validate(String email) {
131 // Avoid storing information that obviously won't get through
132 if ( !EmailProvider.isValidMailAddress(email)) {
133 throw new IllegalArgumentException("Invalid email.");
138 public Name[] getNames() {
139 try (GigiPreparedStatement gps = new GigiPreparedStatement("SELECT `id` FROM `names` WHERE `uid`=? AND `deleted` IS NULL", true)) {
140 gps.setInt(1, getId());
141 return fetchNamesToArray(gps);
145 public Name[] getNonDeprecatedNames() {
146 try (GigiPreparedStatement gps = new GigiPreparedStatement("SELECT `id` FROM `names` WHERE `uid`=? AND `deleted` IS NULL AND `deprecated` IS NULL", true)) {
147 gps.setInt(1, getId());
148 return fetchNamesToArray(gps);
152 private Name[] fetchNamesToArray(GigiPreparedStatement gps) {
153 GigiResultSet rs = gps.executeQuery();
155 Name[] dt = new Name[rs.getRow()];
157 for (int i = 0; rs.next(); i++) {
158 dt[i] = Name.getById(rs.getInt(1));
163 public DayDate getDoB() {
167 public void setDoB(DayDate dob) throws GigiApiException {
168 synchronized (Notary.class) {
169 if (getReceivedVerifications().length != 0) {
170 throw new GigiApiException("No change after verification allowed.");
173 if ( !CalendarUtil.isOfAge(dob, User.MINIMUM_AGE)) {
174 throw new GigiApiException("Entered date of birth is below the restricted age requirements.");
177 if (CalendarUtil.isYearsInFuture(dob.end(), User.MAXIMUM_PLAUSIBLE_AGE)) {
178 throw new GigiApiException("Entered date of birth exceeds the maximum age set in our policies. Please check your DoB is correct and contact support if the issue persists.");
186 protected void setDoBAsSupport(DayDate dob) throws GigiApiException {
187 synchronized (Notary.class) {
194 public String getEmail() {
198 public void changePassword(String oldPass, String newPass) throws GigiApiException {
199 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `password` FROM `users` WHERE `id`=?")) {
200 ps.setInt(1, getId());
201 try (GigiResultSet rs = ps.executeQuery()) {
203 throw new GigiApiException("User not found... very bad.");
205 if (PasswordHash.verifyHash(oldPass, rs.getString(1)) == null) {
206 throw new GigiApiException("Old password does not match.");
210 setPassword(newPass);
213 private void setPassword(String newPass) throws GigiApiException {
214 Name[] names = getNames();
215 TreeSet<String> nameParts = new TreeSet<>();
216 for (int i = 0; i < names.length; i++) {
217 for (NamePart string : names[i].getParts()) {
218 nameParts.add(string.getValue());
221 GigiApiException gaPassword = Gigi.getPasswordChecker().checkPassword(newPass, nameParts.toArray(new String[nameParts.size()]), getEmail());
222 if (gaPassword != null) {
225 try (GigiPreparedStatement ps = new GigiPreparedStatement("UPDATE users SET `password`=? WHERE id=?")) {
226 ps.setString(1, PasswordHash.hash(newPass));
227 ps.setInt(2, getId());
232 public boolean canVerify() {
234 if ( !CalendarUtil.isOfAge(dob, POJAM_AGE)) { // PoJAM
238 if ( !CalendarUtil.isOfAge(dob, ADULT_AGE)) {
242 if (getVerificationPoints() < 100) {
246 return hasPassedCATS();
250 public boolean hasPassedCATS() {
251 try (GigiPreparedStatement query = new GigiPreparedStatement("SELECT 1 FROM `cats_passed` where `user_id`=? AND `variant_id`=?")) {
252 query.setInt(1, getId());
253 query.setInt(2, CATSType.AGENT_CHALLENGE.getId());
254 try (GigiResultSet rs = query.executeQuery()) {
264 public int getVerificationPoints() {
265 try (GigiPreparedStatement query = new GigiPreparedStatement("SELECT SUM(lastpoints) FROM ( SELECT DISTINCT ON (`from`, `method`) `from`, `points` as lastpoints FROM `notary` INNER JOIN `names` ON `names`.`id`=`to` WHERE `notary`.`deleted` is NULL AND (`expire` IS NULL OR `expire` > CURRENT_TIMESTAMP) AND `names`.`uid` = ? ORDER BY `from`, `method`, `when` DESC) as p")) {
266 query.setInt(1, getId());
268 GigiResultSet rs = query.executeQuery();
272 points = rs.getInt(1);
279 public int getExperiencePoints() {
280 try (GigiPreparedStatement query = new GigiPreparedStatement("SELECT count(*) FROM ( SELECT `names`.`uid` FROM `notary` INNER JOIN `names` ON `names`.`id` = `to` WHERE `from`=? AND `notary`.`deleted` IS NULL AND `method` = ? ::`notaryType` GROUP BY `names`.`uid`) as p")) {
281 query.setInt(1, getId());
282 query.setEnum(2, VerificationType.FACE_TO_FACE);
284 GigiResultSet rs = query.executeQuery();
288 points = rs.getInt(1) * EXPERIENCE_POINTS;
296 * Gets the maximum allowed points NOW. Note that a verification needs to
297 * re-check PoJam as it has taken place in the past.
299 * @return the maximal points @
301 @SuppressWarnings("unused")
302 public int getMaxVerifyPoints() {
303 if ( !CalendarUtil.isOfAge(dob, ADULT_AGE) && POJAM_ENABLED) {
307 int exp = getExperiencePoints();
310 if (exp >= 5 * EXPERIENCE_POINTS) {
313 if (exp >= 10 * EXPERIENCE_POINTS) {
316 if (exp >= 15 * EXPERIENCE_POINTS) {
319 if (exp >= 20 * EXPERIENCE_POINTS) {
322 if (exp >= 25 * EXPERIENCE_POINTS) {
329 public boolean isValidName(String name) {
330 for (Name n : getNames()) {
331 if (n.matches(name) && n.getVerificationPoints() >= 50) {
338 public void updateDefaultEmail(EmailAddress newMail) throws GigiApiException {
339 for (EmailAddress email : getEmails()) {
340 if (email.getAddress().equals(newMail.getAddress())) {
341 if ( !email.isVerified()) {
342 throw new GigiApiException("Email not verified.");
345 try (GigiPreparedStatement ps = new GigiPreparedStatement("UPDATE users SET email=? WHERE id=?")) {
346 ps.setString(1, newMail.getAddress());
347 ps.setInt(2, getId());
351 this.email = newMail.getAddress();
356 throw new GigiApiException("Given address not an address of the user.");
359 public void deleteEmail(EmailAddress delMail) throws GigiApiException {
360 if (getEmail().equals(delMail.getAddress())) {
361 throw new GigiApiException("Can't delete user's default e-mail.");
364 for (EmailAddress email : getEmails()) {
365 if (email.getId() == delMail.getId()) {
366 try (GigiPreparedStatement ps = new GigiPreparedStatement("UPDATE `emails` SET `deleted`=CURRENT_TIMESTAMP WHERE `id`=?")) {
367 ps.setInt(1, delMail.getId());
373 throw new GigiApiException("Email not one of user's email addresses.");
376 public synchronized Verification[] getReceivedVerifications() {
377 if (receivedVerifications == null) {
378 try (GigiPreparedStatement query = new GigiPreparedStatement("SELECT * FROM `notary` INNER JOIN `names` ON `names`.`id` = `notary`.`to` WHERE `names`.`uid`=? AND `notary`.`deleted` IS NULL ORDER BY `when` DESC")) {
379 query.setInt(1, getId());
381 GigiResultSet res = query.executeQuery();
382 List<Verification> verifications = new LinkedList<Verification>();
385 verifications.add(verificationByRes(res));
388 this.receivedVerifications = verifications.toArray(new Verification[0]);
392 return receivedVerifications;
395 public synchronized Verification[] getMadeVerifications() {
396 if (madeVerifications == null) {
397 try (GigiPreparedStatement query = new GigiPreparedStatement("SELECT * FROM notary WHERE `from`=? AND deleted is NULL ORDER BY `when` DESC")) {
398 query.setInt(1, getId());
400 try (GigiResultSet res = query.executeQuery()) {
401 List<Verification> verifications = new LinkedList<Verification>();
404 verifications.add(verificationByRes(res));
407 this.madeVerifications = verifications.toArray(new Verification[0]);
412 return madeVerifications;
415 public synchronized void invalidateMadeVerifications() {
416 madeVerifications = null;
419 public synchronized void invalidateReceivedVerifications() {
420 receivedVerifications = null;
423 private void rawUpdateUserData() {
424 try (GigiPreparedStatement update = new GigiPreparedStatement("UPDATE users SET dob=? WHERE id=?")) {
425 update.setDate(1, getDoB().toSQLDate());
426 update.setInt(2, getId());
427 update.executeUpdate();
431 public Locale getPreferredLocale() {
435 public void setPreferredLocale(Locale locale) {
436 this.locale = locale;
440 public synchronized Name getPreferredName() {
441 return preferredName;
444 public synchronized void setPreferredName(Name preferred) throws GigiApiException {
445 if (preferred.getOwner() != this) {
446 throw new GigiApiException("Cannot set a name as preferred one that does not belong to this account.");
448 this.preferredName = preferred;
449 try (GigiPreparedStatement ps = new GigiPreparedStatement("UPDATE `users` SET `preferredName`=? WHERE `id`=?")) {
450 ps.setInt(1, preferred.getId());
451 ps.setInt(2, getId());
457 public boolean isInGroup(Group g) {
458 return groups.contains(g);
461 public Set<Group> getGroups() {
462 return Collections.unmodifiableSet(groups);
465 public void grantGroup(User granter, Group toGrant) throws GigiApiException {
466 if (toGrant.isManagedBySupport() && !granter.isInGroup(Group.SUPPORTER)) {
467 throw new GigiApiException("Group may only be managed by supporter");
469 if (toGrant.isManagedBySupport() && granter == this) {
470 throw new GigiApiException("Group may only be managed by supporter that is not oneself");
473 try (GigiPreparedStatement ps = new GigiPreparedStatement("INSERT INTO `user_groups` SET `user`=?, `permission`=?::`userGroup`, `grantedby`=?")) {
474 ps.setInt(1, getId());
475 ps.setEnum(2, toGrant);
476 ps.setInt(3, granter.getId());
481 public void revokeGroup(User revoker, Group toRevoke) throws GigiApiException {
482 if (toRevoke.isManagedBySupport() && !revoker.isInGroup(Group.SUPPORTER)) {
483 throw new GigiApiException("Group may only be managed by supporter");
485 groups.remove(toRevoke);
486 try (GigiPreparedStatement ps = new GigiPreparedStatement("UPDATE `user_groups` SET `deleted`=CURRENT_TIMESTAMP, `revokedby`=? WHERE `deleted` IS NULL AND `permission`=?::`userGroup` AND `user`=?")) {
487 ps.setInt(1, revoker.getId());
488 ps.setEnum(2, toRevoke);
489 ps.setInt(3, getId());
494 public List<Organisation> getOrganisations() {
495 return getOrganisations(false);
498 public List<Organisation> getOrganisations(boolean isAdmin) {
499 List<Organisation> orgas = new ArrayList<>();
500 try (GigiPreparedStatement query = new GigiPreparedStatement("SELECT `orgid` FROM `org_admin` WHERE `memid`=? AND `deleted` IS NULL" + (isAdmin ? " AND master='y'" : ""))) {
501 query.setInt(1, getId());
502 try (GigiResultSet res = query.executeQuery()) {
504 orgas.add(Organisation.getById(res.getInt(1)));
512 public static synchronized User getById(int id) {
513 CertificateOwner co = CertificateOwner.getById(id);
514 if (co instanceof User) {
521 public static User getByEmail(String mail) {
522 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `users`.`id` FROM `users` INNER JOIN `certOwners` ON `certOwners`.`id` = `users`.`id` WHERE `email`=? AND `deleted` IS NULL")) {
523 ps.setString(1, mail);
524 GigiResultSet rs = ps.executeQuery();
529 return User.getById(rs.getInt(1));
533 public static User[] findByEmail(String mail) {
534 LinkedList<User> results = new LinkedList<User>();
535 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `users`.`id` FROM `users` INNER JOIN `certOwners` ON `certOwners`.`id` = `users`.`id` WHERE `users`.`email` LIKE ? AND `deleted` IS NULL GROUP BY `users`.`id` LIMIT 100")) {
536 ps.setString(1, mail);
537 GigiResultSet rs = ps.executeQuery();
539 results.add(User.getById(rs.getInt(1)));
541 return results.toArray(new User[results.size()]);
545 public EmailAddress[] getEmails() {
546 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `id` FROM `emails` WHERE `memid`=? AND `deleted` IS NULL")) {
547 ps.setInt(1, getId());
549 GigiResultSet rs = ps.executeQuery();
550 LinkedList<EmailAddress> data = new LinkedList<EmailAddress>();
553 data.add(EmailAddress.getById(rs.getInt(1)));
556 return data.toArray(new EmailAddress[0]);
561 public boolean isValidEmail(String email) {
562 for (EmailAddress em : getEmails()) {
563 if (em.getAddress().equals(email)) {
564 return em.isVerified();
571 public String[] getTrainings() {
572 try (GigiPreparedStatement prep = new GigiPreparedStatement("SELECT `pass_date`, `type_text`, `language`, `version` FROM `cats_passed` LEFT JOIN `cats_type` ON `cats_type`.`id`=`cats_passed`.`variant_id` WHERE `user_id`=? ORDER BY `pass_date` ASC")) {
573 prep.setInt(1, getId());
574 GigiResultSet res = prep.executeQuery();
575 List<String> entries = new LinkedList<String>();
578 StringBuilder training = new StringBuilder();
579 training.append(DateSelector.getDateFormat().format(res.getTimestamp(1)));
580 training.append(" (");
581 training.append(res.getString(2));
582 if (res.getString(3).length() > 0) {
583 training.append(" ");
584 training.append(res.getString(3));
586 if (res.getString(4).length() > 0) {
587 training.append(", ");
588 training.append(res.getString(4));
590 training.append(")");
591 entries.add(training.toString());
594 return entries.toArray(new String[0]);
599 public int generatePasswordResetTicket(User actor, String token, String privateToken) {
600 try (GigiPreparedStatement ps = new GigiPreparedStatement("INSERT INTO `passwordResetTickets` SET `memid`=?, `creator`=?, `token`=?, `private_token`=?")) {
601 ps.setInt(1, getId());
602 ps.setInt(2, getId());
603 ps.setString(3, token);
604 ps.setString(4, PasswordHash.hash(privateToken));
606 return ps.lastInsertId();
610 public static User getResetWithToken(int id, String token) {
611 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `memid` FROM `passwordResetTickets` WHERE `id`=? AND `token`=? AND `used` IS NULL AND `created` > CURRENT_TIMESTAMP - interval '1 hours' * ?::INTEGER")) {
613 ps.setString(2, token);
614 ps.setInt(3, PasswordResetPage.HOUR_MAX);
615 GigiResultSet res = ps.executeQuery();
619 return User.getById(res.getInt(1));
623 public synchronized void consumePasswordResetTicket(int id, String private_token, String newPassword) throws GigiApiException {
624 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `private_token` FROM `passwordResetTickets` WHERE `id`=? AND `memid`=? AND `used` IS NULL")) {
626 ps.setInt(2, getId());
627 GigiResultSet rs = ps.executeQuery();
629 throw new GigiApiException("Token could not be found, has already been used, or is expired.");
631 if (PasswordHash.verifyHash(private_token, rs.getString(1)) == null) {
632 throw new GigiApiException("Private token does not match.");
634 setPassword(newPassword);
636 try (GigiPreparedStatement ps = new GigiPreparedStatement("UPDATE `passwordResetTickets` SET `used` = CURRENT_TIMESTAMP WHERE `id`=?")) {
642 private Verification verificationByRes(GigiResultSet res) {
644 return new Verification(res.getInt("id"), User.getById(res.getInt("from")), Name.getById(res.getInt("to")), res.getString("location"), res.getString("method"), res.getInt("points"), res.getString("date"), res.getString("country") == null ? null : Country.getCountryByCode(res.getString("country"), CountryCodeType.CODE_2_CHARS), res.getTimestamp("expire"));
645 } catch (GigiApiException e) {
650 public boolean isInVerificationLimit() {
651 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT 1 FROM `notary` INNER JOIN `names` ON `names`.`id`=`to` WHERE `names`.`uid` = ? AND `when` > (now() - (interval '1 month' * ?::INTEGER)) AND (`expire` IS NULL OR `expire` > now()) AND `notary`.`deleted` IS NULL;")) {
652 ps.setInt(1, getId());
653 ps.setInt(2, VERIFICATION_MONTHS);
655 GigiResultSet rs = ps.executeQuery();
660 private void writeObject(ObjectOutputStream oos) throws IOException {}
662 private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException {}
664 public Country getResidenceCountry() {
665 return residenceCountry;
668 public void setResidenceCountry(Country residenceCountry) {
669 this.residenceCountry = residenceCountry;
670 rawUpdateCountryData();
673 private void rawUpdateCountryData() {
674 try (GigiPreparedStatement update = new GigiPreparedStatement("UPDATE users SET country=? WHERE id=?")) {
675 update.setString(1, residenceCountry == null ? null : residenceCountry.getCode());
676 update.setInt(2, getId());
677 update.executeUpdate();