SetDefaultClass.java

package servlets.admin.userManagement;

import dbProcs.Getter;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;
import java.io.IOException;
import java.io.PrintWriter;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.owasp.encoder.Encode;
import servlets.Register;
import utils.ShepherdLogManager;
import utils.Validate;

/**
 * This is the control class for the Set Default Class functionality <br>
 * <br>
 * This file is part of the Security Shepherd Project.
 *
 * <p>The Security Shepherd project is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.<br>
 *
 * <p>The Security Shepherd project is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU General Public License for more details.<br>
 *
 * <p>You should have received a copy of the GNU General Public License along with the Security
 * Shepherd project. If not, see <http://www.gnu.org/licenses/>.
 *
 * @author Mark Denihan
 */
public class SetDefaultClass extends HttpServlet {

  private static final long serialVersionUID = 1L;
  private static final Logger log = LogManager.getLogger(SetDefaultClass.class);

  /**
   * Initiated by assignPlayers.jsp. A number of players can be assigned to a new class. Changing
   * the actual class of the player is handed by Setter.changePlayerClass
   *
   * @param classId The identifier of the class to add the players to
   * @param players[] An array of player identifiers to add to the specified class
   * @param csrfToken
   */
  public void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    // Setting IpAddress To Log and taking header for original IP if forwarded from proxy
    ShepherdLogManager.setRequestIp(request.getRemoteAddr(), request.getHeader("X-Forwarded-For"));
    log.debug("*** servlets.Admin.SetDefaultClass ***");
    response.setCharacterEncoding("UTF-8");
    request.setCharacterEncoding("UTF-8");
    PrintWriter out = response.getWriter();
    out.print(getServletInfo());
    HttpSession ses = request.getSession(true);
    Cookie tokenCookie = Validate.getToken(request.getCookies());
    Object tokenParmeter = request.getParameter("csrfToken");
    if (Validate.validateAdminSession(ses, tokenCookie, tokenParmeter)) {
      ShepherdLogManager.setRequestIp(
          request.getRemoteAddr(),
          request.getHeader("X-Forwarded-For"),
          ses.getAttribute("userName").toString());
      String htmlOutput = new String();

      if (Validate.validateTokens(tokenCookie, tokenParmeter)) {
        String[] classInfo = new String[2];
        try {
          log.debug("Getting ApplicationRoot");
          String ApplicationRoot = getServletContext().getRealPath("");
          log.debug("Servlet root = " + ApplicationRoot);

          log.debug("Getting Parameters");
          String classId = (String) request.getParameter("classId");
          log.debug("classId = " + classId);

          if (classId
              .isEmpty()) // Null Submitted - Change default class to unassigned players group
          {
            log.debug("Null Class submitted");
            Register.setDefaultClass(
                ""); // Empty string is caught in the Register Servlet and sets the user to the
            // Unassigned Group
            htmlOutput = "Default Class Set To Unassigned Players";
            log.debug(htmlOutput);
          } else {
            // validate class identifier
            classInfo = Getter.getClassInfo(ApplicationRoot, classId);
            if (classInfo != null && !classInfo[0].isEmpty()) // Class Exists
            {
              log.debug("Valid Class Submitted");
              Register.setDefaultClass(classId);
              htmlOutput = "Default class has been set to " + Encode.forHtml(classInfo[0]);
              log.debug(htmlOutput);
            }
          }
          if (htmlOutput.isEmpty()) {
            htmlOutput =
                "<h3 class='title'>Default Class is Unchanged</h3>"
                    + "<p>Invalid data was submitted. Please try again.</p>";
          } else // Function must have completed if this isn't empty
          {
            htmlOutput =
                "<h3 class='title'>Default Class Updated</h3>" + "<p>" + htmlOutput + "</p>";
          }
          out.write(htmlOutput);
        } catch (Exception e) {
          log.error("SetDefaultClass Error: " + e.toString());
          out.print(
              "<h3 class=\"title\">Set Default Class Failure</h3>"
                  + "<p>"
                  + "<font color=\"red\">An error Occurred! Please try again.</font>"
                  + "<p>");
        }
      } else {
        log.debug("CSRF Tokens did not match");
        out.print(
            "<h3 class=\"title\">Player Assignment Failure</h3>"
                + "<p>"
                + "<font color=\"red\">An error Occurred! Please try again.</font>"
                + "<p>");
      }
    } else {
      out.print(
          "<h3 class=\"title\">Failure</h3><p><font color=\"red\">An error Occurred! Please try non"
              + " administrator functions!</font><p>");
    }
    log.debug("*** SetDefaultClass END ***");
  }
}