NotificationController.java

package fi.otavanopisto.muikku.plugins.timed.notifications;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.enterprise.context.Dependent;
import javax.enterprise.inject.Any;
import javax.enterprise.inject.Instance;
import javax.inject.Inject;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;

import fi.otavanopisto.muikku.controller.PluginSettingsController;
import fi.otavanopisto.muikku.mail.MailType;
import fi.otavanopisto.muikku.mail.Mailer;
import fi.otavanopisto.muikku.model.users.UserEntity;
import fi.otavanopisto.muikku.model.users.UserGroupEntity;
import fi.otavanopisto.muikku.plugins.communicator.CommunicatorController;
import fi.otavanopisto.muikku.users.UserEmailEntityController;
import fi.otavanopisto.muikku.plugins.commonlog.LogProvider;
import fi.otavanopisto.muikku.schooldata.entity.GroupUser;
import fi.otavanopisto.muikku.schooldata.entity.User;
import fi.otavanopisto.muikku.schooldata.entity.UserGroup;
import fi.otavanopisto.muikku.users.UserEntityController;
import fi.otavanopisto.muikku.users.UserGroupController;
import fi.otavanopisto.muikku.users.UserGroupEntityController;

@Dependent
public class NotificationController {

  @Inject
  private Logger logger;

  @Any
  @Inject
  private Instance<LogProvider> logProviders;

  public static final String COLLECTION_NAME = "studentNotifications";
  public static final String LOG_PROVIDER = "mongo-provider";

  @Inject
  private CommunicatorController communicatorController;

  @Inject
  private Mailer mailer;

  @Inject
  private UserEmailEntityController userEmailEntityController;

  @Inject
  private PluginSettingsController pluginSettingsController;

  @Inject
  private UserGroupController userGroupController;

  @Inject
  private UserGroupEntityController userGroupEntityController;

  @Inject
  private UserEntityController userEntityController;

  private String getRecipientEmail() {
    return pluginSettingsController.getPluginSetting("timed-notifications", "dryRunRecipientEmail");
  }

  private boolean isDryRun() {
    return StringUtils.equals(pluginSettingsController.getPluginSetting("timed-notifications", "dryRunEnabled"),
        "true");
  }

  public void sendNotification(String category, String subject, String content, UserEntity recipient) {
    HashMap<String, Object> map = new HashMap<>();
    map.put("category", category);
    map.put("recipient", recipient.getId());

    UserEntity guidanceCounselor = null;
    List<UserGroupEntity> userGroupEntities = userGroupEntityController.listUserGroupsByUserEntity(recipient);
    
    // #3089: An awkward workaround to use the latest guidance group based on its identifier. Assumes a larger
    // identifier means a more recent entity. A more proper fix would be to sync group creation dates from
    // Pyramus and include them in the Elastic index. Then again, user groups would have to be refactored
    // entirely, as Pyramus handles group members as students (one study programme) while Muikku handles
    // them as user entities (all study programmes)...
    
    userGroupEntities.sort(new Comparator<UserGroupEntity>() {
      public int compare(UserGroupEntity o1, UserGroupEntity o2) {
        long l1 = NumberUtils.toLong(StringUtils.substringAfterLast(o1.getIdentifier(), "-"), -1);
        long l2 = NumberUtils.toLong(StringUtils.substringAfterLast(o2.getIdentifier(), "-"), -1);
        return (int) (l2 - l1);
      }
    });
    
    // Choose the first staff member of the first guidance group as CC recipient for the notification

    userGroupEntities:
    for (UserGroupEntity userGroupEntity : userGroupEntities) {
      UserGroup userGroup = userGroupController.findUserGroup(userGroupEntity);

      if (userGroup.isGuidanceGroup()) {
        List<GroupUser> groupUsers = userGroupController.listUserGroupStaffMembers(userGroup);

        for (GroupUser groupUser : groupUsers) {
          User user = userGroupController.findUserByGroupUser(groupUser);
          guidanceCounselor = userEntityController.findUserEntityByUser(user);
          break userGroupEntities;
        }
      }
    }

    LogProvider provider = getProvider(LOG_PROVIDER);

    if (provider != null) {
      provider.log(COLLECTION_NAME, map);
    }

    if (isDryRun()) {
      String recipientEmail = getRecipientEmail();
      if (recipientEmail == null) {
        logger.log(Level.INFO, String.format("Sending notification %s - %s to %s", category, subject, recipient.getDefaultIdentifier()));
      }
      else {
        mailer.sendMail(MailType.HTML, Arrays.asList(recipientEmail), subject,
            "SENT TO: " + recipient.getDefaultIdentifier() + "<br/><br/><br/>" + content);
      }
    }
    else {
      ArrayList<UserEntity> recipients = new ArrayList<>();
      recipients.add(recipient);
      if (guidanceCounselor != null) {
        recipients.add(guidanceCounselor);
      }
      String studentEmail = userEmailEntityController.getUserDefaultEmailAddress(recipient, Boolean.FALSE);
      if (studentEmail != null) {
        mailer.sendMail(MailType.HTML, Arrays.asList(studentEmail), subject, content);
      }
      else {
        logger.log(Level.WARNING,
            String.format("Cannot send email notification to student %s because no email address was found",
                recipient.getDefaultIdentifier()));
      }
      communicatorController.postMessage(recipient, category, subject, content, recipients);
    }
  }

  private LogProvider getProvider(String name) {
    for (LogProvider provider : logProviders) {
      if (provider.getName().equals(name)) {
        return provider;
      }
    }
    return null;
  }

}