StudentsCtrl.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2019 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.students.www;
 
import java.util.List;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.turro.action.Actions;
import org.turro.action.Contacts;
import org.turro.action.IEntityCtrl;
import org.turro.annotation.ElephantPlugin;
import org.turro.assistant.ParticipationInfo;
import org.turro.auth.Authentication;
import org.turro.collections.KeyValueMap;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.db.WhereClause;
import org.turro.elephant.direct.DirectContent;
import org.turro.elephant.direct.DirectContents;
import org.turro.elephant.direct.IDirectContent;
import org.turro.entities.Entities;
import org.turro.entities.EntityRole;
import org.turro.entities.IElephantEntity;
import org.turro.jpa.Dao;
import org.turro.marker.ElephantMarker;
import org.turro.participation.IEntityParticipation;
import org.turro.participation.ParticipationReason;
import org.turro.plugin.contacts.ContactList;
import org.turro.plugin.contacts.IContact;
import org.turro.students.db.StudentsPU;
import org.turro.students.entities.Challenge;
 
@ElephantPlugin(label="students-ctrl")
@DirectContent(identifier="students-action")
public class StudentsCtrl implements IDirectContent, IEntityCtrl {
 
  private String entityPath, template = "related";
  private IConstructor constructor;
  private IContact challenger;
  private List<IContact> students;
  private List<Challenge> challenges;
 
  @Override
  public void setConstructor(IConstructor constructor) {
    this.constructor = constructor;
  }
 
  @Override
  public void setEntityPath(String entityPath) {
    this.entityPath = entityPath;
  }
 
  @Override
  public void setTemplate(String template) {
    this.template = template;
  }
  
  @Override
  public boolean hasContent() {
    getStudents();
    getChallenger();
    getRelatedChallenges();
    return (Contacts.isStudent(Authentication.getIContact())) ||
           (challenger != null && challenger.isWebUser()) ||
           !students.isEmpty() || !challenges.isEmpty();
  }
 
  @Override
  public void render(IConstructor constructor) {
    getMarker().process("students", template);
  }
 
  @Override
  public String parse(IConstructor constructor) {
    return getMarker().parse("students", template);
  }
 
  public boolean isMine(Challenge challenge) {
    IContact contact = Authentication.getIContact();
    return challenge.getIdChallenger().equals(contact.getId()); 
  }
  
  public Object getFollowCtrl() {
    return Entities.getController(entityPath).getParticipationControl(constructor, ParticipationReason.REASON_FOLLOW);
  }
  
  public boolean allowsQuestion() {
    IContact contact = Authentication.getIContact();
    return contact.isWebUser() && contact.isInNetworking();
  }
  
  private ElephantMarker getMarker() {
    ElephantMarker marker = new ElephantMarker(constructor);
    marker.put("actions", this);
    marker.put("entityPath", entityPath);
    marker.put("challenger", getChallenger());
    marker.put("students", getStudents());
    marker.put("challenges", getRelatedChallenges());
    return marker;
  }
  
  private List<IContact> getStudents() {
    if(students == null) {
      ContactList list = new ContactList();
      for(IEntityParticipation participation : new ParticipationInfo(entityPath, ParticipationReason.REASON_FOLLOW).getParticipations()) {
        list.add(participation.getContact());
      }
      students = list.getStudents();
    }
    return students;
  }
  
  private List<Challenge> getRelatedChallenges() {
    if(challenges == null) {
      WhereClause wc = new WhereClause();
      wc.addClause("select c from Challenge c");
      wc.addClause("where c.entityPath = :entityPath");
      wc.addNamedValue("entityPath", entityPath);
      challenges = getDao().getResultList(wc);
    }
    return challenges;
  }
  
  private IContact getChallenger() {
    if(challenger == null) {
      IElephantEntity iee = Entities.getController(entityPath);
      IContact contact = Authentication.getIContact();
      if(contact.isHHRR() || iee.hasRelatedRole(EntityRole.CHALLENGER, contact)) {
        challenger = contact;
      }
    }
    return challenger;
  }
  
  /* IDirectContent */
 
  public static String createPOST(String values) {
    return "$.post(\"" + ElephantContext.getRootWebPath() + DirectContents.DIRECT_CONTENT_PATH + getIdentifier() + "\"," +
           "{ exrino : \"" + Actions.createRightNowParameter(values) + "\" })";
  }
  
  public static String createURL(String values) {
    String exrino = Actions.createRightNowAction(values);
    return ElephantContext.getRootWebPath() +
            DirectContents.DIRECT_CONTENT_PATH + getIdentifier() +
            "?" + exrino;
  }
  
  public static String getIdentifier() {
    return StudentsCtrl.class.getAnnotation(DirectContent.class).identifier();
  }
 
  @Override
  public boolean itsMe(String id) {
    return getIdentifier().equals(id);
  }
 
  @Override
  public boolean myTurn(HttpServletRequest request) {
    return DirectContents.isYourTurn(request, getIdentifier());
  }
 
  @Override
  public void execute(ServletContext context, HttpServletRequest request, HttpServletResponse response) {
    IConstructor current = ElephantContext.getConstructor(request, response);
    KeyValueMap map = Actions.getRightNowAction(current);
    if(map != null) {
      String type = map.get("type");
    }
  }
  
  /* Iterators helpers */
  
  public long countParticipations(String root, IContact contact, String reason) {
    return ParticipationInfo.getParticipationCount(root, contact, ParticipationReason.valueOf(reason));
  }
 
  public long countResponses(IContact contact) {
    WhereClause wc = new WhereClause();
    wc.addClause("select count(sp) from Response sp");
    wc.addClause("where :student member of sp.studentIds");
    wc.addNamedValue("student", contact.getId());
    return (long) getDao().getSingleResultOrNull(wc);
  }
 
  /* Dao */
  
  private Dao _dao;
  
  private Dao getDao() {
    if(_dao == null) {
      _dao = new StudentsPU();
    }
    return _dao;
  }
 
}