ExportDegreeCandidaciesByDegreeForPasswordGeneration.java

/**
 * Copyright © ${project.inceptionYear} Instituto Superior Técnico
 *
 * This file is part of Fenix IST.
 *
 * Fenix IST is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Fenix IST 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Fenix IST.  If not, see <http://www.gnu.org/licenses/>.
 */
package pt.ist.fenix.domain.student.importation;

import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.Predicate;
import org.fenixedu.academic.domain.Degree;
import org.fenixedu.academic.domain.EntryPhase;
import org.fenixedu.academic.domain.ExecutionDegree;
import org.fenixedu.academic.domain.ExecutionYear;
import org.fenixedu.academic.domain.Person;
import org.fenixedu.academic.domain.QueueJob;
import org.fenixedu.academic.domain.QueueJobResult;
import org.fenixedu.academic.domain.candidacy.CandidacySituationType;
import org.fenixedu.academic.domain.candidacy.DegreeCandidacy;
import org.fenixedu.academic.domain.candidacy.IMDCandidacy;
import org.fenixedu.academic.domain.candidacy.StudentCandidacy;
import org.fenixedu.academic.domain.degree.DegreeType;
import org.fenixedu.academic.domain.person.RoleType;
import org.fenixedu.spaces.domain.Space;

import pt.ist.fenixedu.contracts.domain.accessControl.ActiveEmployees;

public class ExportDegreeCandidaciesByDegreeForPasswordGeneration extends
        ExportDegreeCandidaciesByDegreeForPasswordGeneration_Base {

    private static final List<DegreeType> ACCEPTED_DEGREE_TYPES = Arrays.asList(DegreeType.BOLONHA_DEGREE,
            DegreeType.BOLONHA_INTEGRATED_MASTER_DEGREE);

    public ExportDegreeCandidaciesByDegreeForPasswordGeneration() {
        super();
    }

    public ExportDegreeCandidaciesByDegreeForPasswordGeneration(final ExecutionYear executionYear, final EntryPhase entryPhase) {
        super.init(executionYear, entryPhase);
    }

    @Override
    public QueueJobResult execute() throws Exception {
        final Map<Degree, Set<Person>> result = new HashMap<Degree, Set<Person>>();

        for (final ExecutionDegree executionDegree : getExecutionYear().getExecutionDegreesSet()) {
            if (!isAcceptedDegreeType(executionDegree)) {
                continue;
            }

            for (final StudentCandidacy studentCandidacy : executionDegree.getStudentCandidaciesSet()) {
                if (!(studentCandidacy instanceof DegreeCandidacy || studentCandidacy instanceof IMDCandidacy)) {
                    continue;
                }

                if (!studentCandidacy.getCandidacySituationsSet().isEmpty()) {
                    if (studentCandidacy.getActiveCandidacySituationType() == CandidacySituationType.STAND_BY
                            && studentCandidacy.getEntryPhase().equals(getEntryPhase())
                            && !RoleType.STUDENT.isMember(studentCandidacy.getPerson().getUser())
                            && studentCandidacy.getPerson().getStudent().getRegistrationsSet().isEmpty()
                            && !new ActiveEmployees().isMember(studentCandidacy.getPerson().getUser())) {
                        addPerson(result, executionDegree.getDegree(), studentCandidacy.getPerson());
                    }
                }
            }
        }

        ByteArrayOutputStream stream = null;
        PrintWriter writer = null;
        try {
            stream = new ByteArrayOutputStream();
            writer = new PrintWriter(new BufferedOutputStream(stream));

            for (final Map.Entry<Degree, Set<Person>> entry : result.entrySet()) {
                writer.println(String.format("\nCurso %s - %s ", entry.getKey().getNameI18N().getContent(),
                        getCampus(entry.getKey()).getName()));
                for (final Person person : entry.getValue()) {
                    writer.println(person.getUsername());
                }
            }
        } finally {
            writer.close();
            stream.close();
        }

        final QueueJobResult queueJobResult = new QueueJobResult();
        queueJobResult.setContentType("text/plain");
        queueJobResult.setContent(stream.toByteArray());

        return queueJobResult;
    }

    private Space getCampus(final Degree degree) {
        final Collection<Space> result = degree.getCampus(getExecutionYear());

        if (result.size() != 1) {
            throw new RuntimeException("Unexpected campus count");
        }

        return result.iterator().next();
    }

    private void addPerson(final Map<Degree, Set<Person>> result, final Degree degree, final Person person) {
        final Set<Person> persons;

        if (result.containsKey(degree)) {
            persons = result.get(degree);
        } else {
            persons = new HashSet<Person>();
            result.put(degree, persons);
        }

        persons.add(person);

    }

    private boolean isAcceptedDegreeType(final ExecutionDegree executionDegree) {
        return ACCEPTED_DEGREE_TYPES.contains(executionDegree.getDegree().getDegreeType());
    }

    public static boolean canRequestJob() {
        return QueueJob.getUndoneJobsForClass(ExportDegreeCandidaciesByDegreeForPasswordGeneration.class).isEmpty();
    }

    public static List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> readAllJobs(final ExecutionYear executionYear) {
        List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> jobList =
                new ArrayList<ExportDegreeCandidaciesByDegreeForPasswordGeneration>();

        CollectionUtils.select(executionYear.getDgesBaseProcessSet(), new Predicate() {

            @Override
            public boolean evaluate(Object arg0) {
                return arg0 instanceof ExportDegreeCandidaciesByDegreeForPasswordGeneration;
            }
        }, jobList);

        return jobList;
    }

    public static List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> readDoneJobs(final ExecutionYear executionYear) {
        List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> jobList =
                new ArrayList<ExportDegreeCandidaciesByDegreeForPasswordGeneration>();

        CollectionUtils.select(executionYear.getDgesBaseProcessSet(), new Predicate() {

            @Override
            public boolean evaluate(Object arg0) {
                return (arg0 instanceof ExportDegreeCandidaciesByDegreeForPasswordGeneration) && ((QueueJob) arg0).getDone();
            }
        }, jobList);

        return jobList;
    }

    public static List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> readUndoneJobs(final ExecutionYear executionYear) {
        return new ArrayList(CollectionUtils.subtract(readAllJobs(executionYear), readDoneJobs(executionYear)));
    }

    public static List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> readPendingJobs(final ExecutionYear executionYear) {
        List<ExportDegreeCandidaciesByDegreeForPasswordGeneration> jobList =
                new ArrayList<ExportDegreeCandidaciesByDegreeForPasswordGeneration>();

        CollectionUtils.select(executionYear.getDgesBaseProcessSet(), new Predicate() {

            @Override
            public boolean evaluate(Object arg0) {
                return (arg0 instanceof ExportDegreeCandidaciesByDegreeForPasswordGeneration)
                        && ((QueueJob) arg0).getIsNotDoneAndNotCancelled();
            }
        }, jobList);

        return jobList;
    }

}