LanguageTeamAction.java

/*
 * Copyright 2010, Red Hat, Inc. and individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution for a full
 * listing of individual contributors.
 *
 * This 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 2.1 of the License, or (at your option)
 * any later version.
 *
 * This software 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 this software; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
 * site: http://www.fsf.org.
 */
package org.zanata.action;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;

import org.jboss.seam.ScopeType;
import org.jboss.seam.annotations.In;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.annotations.Scope;
import org.jboss.seam.annotations.Transactional;
import org.jboss.seam.annotations.security.Restrict;
import org.jboss.seam.faces.FacesMessages;
import org.jboss.seam.international.StatusMessage.Severity;
import org.jboss.seam.security.management.JpaIdentityStore;
import org.zanata.common.LocaleId;
import org.zanata.dao.LocaleDAO;
import org.zanata.dao.LocaleMemberDAO;
import org.zanata.dao.PersonDAO;
import org.zanata.events.JoinedLanguageTeam;
import org.zanata.events.LanguageTeamPermissionChangedEvent;
import org.zanata.events.LeftLanguageTeam;
import org.zanata.i18n.Messages;
import org.zanata.model.HAccount;
import org.zanata.model.HLocale;
import org.zanata.model.HLocaleMember;
import org.zanata.model.HPerson;
import org.zanata.service.LanguageTeamService;
import org.zanata.service.LocaleService;
import org.zanata.util.Event;

@Name("languageTeamAction")
@Scope(ScopeType.PAGE)
@Slf4j
public class LanguageTeamAction implements Serializable {
    private static final long serialVersionUID = 1L;

    @In
    private LanguageTeamService languageTeamServiceImpl;

    @In
    private LocaleDAO localeDAO;

    @In
    private LocaleMemberDAO localeMemberDAO;

    @In
    private PersonDAO personDAO;

    @In
    private LocaleService localeServiceImpl;

    @In(required = false, value = JpaIdentityStore.AUTHENTICATED_USER)
    private HAccount authenticatedAccount;

    @In
    private Messages msgs;

    @In("event")
    private Event<JoinedLanguageTeam> joinLanguageTeamEvent;

    @In("event")
    private Event<LanguageTeamPermissionChangedEvent> languageTeamPermissionChangedEvent;

    @In("event")
    private Event<LeftLanguageTeam> leaveLanguageTeamEvent;

    @Getter
    @Setter
    private String language;

    @Getter
    @Setter
    private String searchTerm;
    private List<SelectablePerson> searchResults;

    public List<SelectablePerson> getSearchResults() {
        if (searchResults == null) {
            searchResults = new ArrayList<>();
        }

        return searchResults;
    }

    public boolean isUserInTeam() {
        return authenticatedAccount != null
                && this.isPersonInTeam(this.authenticatedAccount.getId());
    }

    @Restrict("#{s:hasPermission(languageTeamAction.locale, 'manage-language-team')}")
    public void addSelected() {
        for (SelectablePerson selectablePerson : getSearchResults()) {
            if (selectablePerson.isSelected()) {
                addTeamMember(selectablePerson.getPerson().getId(),
                        selectablePerson.isTranslator,
                        selectablePerson.isReviewer,
                        selectablePerson.isCoordinator);
            }
        }
    }

    public HLocale getLocale() {
        /*
         * Preload the HLocaleMember objects. This line is needed as Hibernate
         * has problems when invoking lazily loaded collections from postLoad
         * entity listener methods. In this case, the drools engine will attempt
         * to access the 'members' collection from inside the security
         * listener's postLoad method to evaluate rules.
         */
        HLocale locale =
                localeServiceImpl.getByLocaleId(new LocaleId(language));
        if (locale != null) {
            locale.getMembers();
        }
        return locale;
    }

    public List<HLocaleMember> getLocaleMembers() {
        return localeMemberDAO.findAllByLocale(new LocaleId(language));
    }

    @Transactional
    @Restrict("#{s:hasRole('admin')}")
    public void joinTribe() {
        log.debug("starting join tribe");
        if (authenticatedAccount == null) {
            log.error("failed to load auth person");
            return;
        }
        try {
            languageTeamServiceImpl.joinOrUpdateRoleInLanguageTeam(
                    this.language, authenticatedAccount.getPerson().getId(),
                    true, true, true);
            joinLanguageTeamEvent.fire(new JoinedLanguageTeam(authenticatedAccount.getUsername(), new LocaleId(language)));
            log.info("{} joined tribe {}",
                    authenticatedAccount.getUsername(), this.language);
            FacesMessages.instance().add(msgs.format("jsf.MemberOfTeam",
                    getLocale().retrieveNativeName()));
        } catch (Exception e) {
            FacesMessages.instance().add(Severity.ERROR, e.getMessage());
        }
    }

    @Transactional
    public void leaveTribe() {
        log.debug("starting leave tribe");
        if (authenticatedAccount == null) {
            log.error("failed to load auth person");
            return;
        }
        languageTeamServiceImpl.leaveLanguageTeam(this.language,
                authenticatedAccount.getPerson().getId());
        leaveLanguageTeamEvent.fire(new LeftLanguageTeam(authenticatedAccount.getUsername(), new LocaleId(language)));
        log.info("{} left tribe {}", authenticatedAccount.getUsername(),
                this.language);
        FacesMessages.instance().add(msgs.format("jsf.LeftTeam",
                getLocale().retrieveNativeName()));
    }

    @Restrict("#{s:hasPermission(languageTeamAction.locale, 'manage-language-team')}")
    public void saveTeamCoordinator(HLocaleMember member) {
        savePermission(member, msgs.get("jsf.Translator"), member.isCoordinator());
        HPerson doneByPerson = authenticatedAccount.getPerson();
        LanguageTeamPermissionChangedEvent changedEvent =
                new LanguageTeamPermissionChangedEvent(
                        member.getPerson(), getLocale().getLocaleId(),
                        doneByPerson)
                        .changedCoordinatorPermission(member);
        languageTeamPermissionChangedEvent.fire(changedEvent);
    }

    @Restrict("#{s:hasPermission(languageTeamAction.locale, 'manage-language-team')}")
    public void saveTeamReviewer(HLocaleMember member) {
        savePermission(member, msgs.get("jsf.Reviewer"), member.isReviewer());
        HPerson doneByPerson = authenticatedAccount.getPerson();
        LanguageTeamPermissionChangedEvent changedEvent =
                new LanguageTeamPermissionChangedEvent(
                        member.getPerson(), getLocale().getLocaleId(),
                        doneByPerson)
                        .changedReviewerPermission(member);
        languageTeamPermissionChangedEvent.fire(changedEvent);
    }

    @Restrict("#{s:hasPermission(languageTeamAction.locale, 'manage-language-team')}")
    public void saveTeamTranslator(HLocaleMember member) {
        savePermission(member, msgs.get("jsf.Translator"), member.isTranslator());
        HPerson doneByPerson = authenticatedAccount.getPerson();
        LanguageTeamPermissionChangedEvent changedEvent =
                new LanguageTeamPermissionChangedEvent(
                        member.getPerson(), getLocale().getLocaleId(),
                        doneByPerson)
                        .changedTranslatorPermission(member);
        languageTeamPermissionChangedEvent.fire(changedEvent);
    }

    private void savePermission(HLocaleMember member, String permissionDesc,
            boolean isPermissionGranted) {
        this.localeDAO.makePersistent(getLocale());
        this.localeDAO.flush();
        HPerson person = member.getPerson();
        if (isPermissionGranted) {
            FacesMessages.instance().add(
                    msgs.format("jsf.AddedAPermission",
                    person.getAccount().getUsername(), permissionDesc));
        } else {
            FacesMessages.instance().add(
                    msgs.format("jsf.RemovedAPermission",
                            person.getAccount().getUsername(), permissionDesc));
        }
    }

    private void addTeamMember(final Long personId, boolean isTranslator,
            boolean isReviewer, boolean isCoordinator) {
        this.languageTeamServiceImpl.joinOrUpdateRoleInLanguageTeam(
                this.language, personId, isTranslator, isReviewer,
                isCoordinator);
    }

    @Restrict("#{s:hasPermission(languageTeamAction.locale, 'manage-language-team')}")
    public
            void removeMembership(HLocaleMember member) {
        this.languageTeamServiceImpl.leaveLanguageTeam(this.language, member
                .getPerson().getId());
    }

    public boolean isPersonInTeam(final Long personId) {
        for (HLocaleMember lm : getLocale().getMembers()) {
            if (lm.getPerson().getId().equals(personId)) {
                return true;
            }
        }
        return false;
    }

    private HLocaleMember getLocaleMember(final Long personId) {
        for (HLocaleMember lm : getLocale().getMembers()) {
            if (lm.getPerson().getId().equals(personId)) {
                return lm;
            }
        }
        return null;
    }

    public void searchForTeamMembers() {
        clearSearchResult();
        List<HPerson> results =
                this.personDAO.findAllContainingName(this.searchTerm);
        for (HPerson person : results) {
            HLocaleMember localeMember = getLocaleMember(person.getId());
            boolean isMember = localeMember != null;
            boolean isReviewer = false;
            boolean isTranslator = false;
            boolean isCoordinator = false;

            if (isMember) {
                isTranslator = localeMember.isTranslator();
                isReviewer = localeMember.isReviewer();
                isCoordinator = localeMember.isCoordinator();
            }
            getSearchResults().add(
                    new SelectablePerson(person, isMember, isTranslator,
                            isReviewer, isCoordinator));
        }
    }

    public void clearSearchResult() {
        getSearchResults().clear();
    }

    public final class SelectablePerson {
        @Getter
        private HPerson person;

        @Getter
        private boolean selected;

        @Getter
        private boolean isReviewer;

        @Getter
        private boolean isCoordinator;

        @Getter
        private boolean isTranslator;

        public SelectablePerson(HPerson person, boolean selected,
                boolean isTranslator, boolean isReviewer, boolean isCoordinator) {
            this.person = person;
            this.selected = selected;
            this.isReviewer = isReviewer;
            this.isCoordinator = isCoordinator;
            this.isTranslator = isTranslator;
        }

        public void setReviewer(boolean isReviewer) {
            this.isReviewer = isReviewer;
            refreshSelected();
        }

        public void setCoordinator(boolean isCoordinator) {
            this.isCoordinator = isCoordinator;
            refreshSelected();
        }

        public void setTranslator(boolean isTranslator) {
            this.isTranslator = isTranslator;
            refreshSelected();
        }

        private void refreshSelected() {
            this.selected = isReviewer || isTranslator || isCoordinator;
        }
    }

}