com.google.gerrit.server.mail.send.NewChangeSender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.11.0-rc3
// Copyright (C) 2009 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.server.mail.send;

import com.google.gerrit.entities.Account;
import com.google.gerrit.entities.Address;
import com.google.gerrit.exceptions.EmailException;
import com.google.gerrit.extensions.api.changes.RecipientType;
import com.google.gerrit.server.query.change.ChangeData;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/** Sends an email alerting a user to a new change for them to review. */
public abstract class NewChangeSender extends ChangeEmail {
  private final Set reviewers = new HashSet<>();
  private final Set reviewersByEmail = new HashSet<>();
  private final Set extraCC = new HashSet<>();
  private final Set extraCCByEmail = new HashSet<>();
  private final Set removedReviewers = new HashSet<>();
  private final Set removedByEmailReviewers = new HashSet<>();

  protected NewChangeSender(EmailArguments args, ChangeData changeData) {
    super(args, "newchange", changeData);
  }

  public void addReviewers(Collection cc) {
    reviewers.addAll(cc);
  }

  public void addReviewersByEmail(Collection cc) {
    reviewersByEmail.addAll(cc);
  }

  public void addExtraCC(Collection cc) {
    extraCC.addAll(cc);
  }

  public void addExtraCCByEmail(Collection cc) {
    extraCCByEmail.addAll(cc);
  }

  public void addRemovedReviewers(Collection removed) {
    removedReviewers.addAll(removed);
  }

  public void addRemovedByEmailReviewers(Collection removed) {
    removedByEmailReviewers.addAll(removed);
  }

  @Override
  protected void init() throws EmailException {
    super.init();
    String threadId = getChangeMessageThreadId();
    setHeader("References", threadId);

    switch (notify.handling()) {
      case NONE:
      case OWNER:
        break;
      case ALL:
      default:
        extraCC.stream().forEach(cc -> add(RecipientType.CC, cc));
        extraCCByEmail.stream().forEach(cc -> add(RecipientType.CC, cc));
        // $FALL-THROUGH$
      case OWNER_REVIEWERS:
        reviewers.stream().forEach(r -> add(RecipientType.TO, r, true));
        addByEmail(RecipientType.TO, reviewersByEmail, true);
        removedReviewers.stream().forEach(r -> add(RecipientType.TO, r, true));
        addByEmail(RecipientType.TO, removedByEmailReviewers, true);
        break;
    }

    rcptToAuthors(RecipientType.CC);
  }

  @Override
  protected void formatChange() throws EmailException {
    appendText(textTemplate("NewChange"));
    if (useHtml()) {
      appendHtml(soyHtmlTemplate("NewChangeHtml"));
    }
  }

  public List getReviewerNames() {
    if (reviewers.isEmpty()) {
      return null;
    }
    List names = new ArrayList<>();
    for (Account.Id id : reviewers) {
      names.add(getNameFor(id));
    }
    return names;
  }

  public List getRemovedReviewerNames() {
    if (removedReviewers.isEmpty() && removedByEmailReviewers.isEmpty()) {
      return null;
    }
    List names = new ArrayList<>();
    for (Account.Id id : removedReviewers) {
      names.add(getNameFor(id));
    }
    for (Address address : removedByEmailReviewers) {
      names.add(address.toString());
    }
    return names;
  }

  @Override
  protected void setupSoyContext() {
    super.setupSoyContext();
    soyContext.put("ownerName", getNameFor(change.getOwner()));
    soyContextEmailData.put("reviewerNames", getReviewerNames());
    soyContextEmailData.put("removedReviewerNames", getRemovedReviewerNames());
  }
}