001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kns.web.struts.action;
017
018import org.apache.struts.action.ActionForm;
019import org.apache.struts.action.ActionForward;
020import org.apache.struts.action.ActionMapping;
021import org.kuali.rice.core.api.util.RiceConstants;
022import org.kuali.rice.kim.api.identity.Person;
023import org.kuali.rice.kns.document.authorization.TransactionalDocumentAuthorizer;
024import org.kuali.rice.kns.document.authorization.TransactionalDocumentPresentationController;
025import org.kuali.rice.kns.service.KNSServiceLocator;
026import org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase;
027import org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase;
028import org.kuali.rice.krad.document.Copyable;
029import org.kuali.rice.krad.document.Document;
030import org.kuali.rice.krad.service.KRADServiceLocatorWeb;
031import org.kuali.rice.krad.util.GlobalVariables;
032import org.kuali.rice.krad.util.KRADConstants;
033
034import javax.servlet.http.HttpServletRequest;
035import javax.servlet.http.HttpServletResponse;
036import java.util.HashMap;
037import java.util.Map;
038import java.util.Set;
039
040/**
041 * This class handles UI actions for all shared methods of transactional documents.
042 */
043public class KualiTransactionalDocumentActionBase extends KualiDocumentActionBase {
044//    private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(KualiTransactionalDocumentActionBase.class);
045
046    /**
047     * Method that will take the current document and call its copy method if Copyable.
048     */
049    public ActionForward copy(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
050        KualiTransactionalDocumentFormBase tmpForm = (KualiTransactionalDocumentFormBase) form;
051
052        Document document = tmpForm.getDocument();
053        
054        if (!tmpForm.getDocumentActions().containsKey(KRADConstants.KUALI_ACTION_CAN_COPY)) {
055            throw buildAuthorizationException("copy", document);
056        }
057
058        ((Copyable) tmpForm.getTransactionalDocument()).toCopy();
059
060        return mapping.findForward(RiceConstants.MAPPING_BASIC);
061    }
062
063    @SuppressWarnings("unchecked")
064        protected void populateAuthorizationFields(KualiDocumentFormBase formBase){
065        super.populateAuthorizationFields(formBase);
066        Document document = formBase.getDocument();
067        Map editMode = new HashMap();
068        
069        if (formBase.isFormDocumentInitialized()) {
070                Person user = GlobalVariables.getUserSession().getPerson();
071                
072                TransactionalDocumentPresentationController documentPresentationController = (TransactionalDocumentPresentationController) getDocumentHelperService().getDocumentPresentationController(document);
073            TransactionalDocumentAuthorizer documentAuthorizer = (TransactionalDocumentAuthorizer) KNSServiceLocator
074                    .getDocumentHelperService().getDocumentAuthorizer(document);
075            Set<String> editModes = documentAuthorizer.getEditModes(document, user, documentPresentationController.getEditModes(document));
076            editMode = this.convertSetToMap(editModes);
077            if (getDataDictionaryService().getDataDictionary().getDocumentEntry(document.getClass().getName()).getUsePessimisticLocking()) {
078                editMode = getPessimisticLockService().establishLocks(document, editMode, user);
079            }            
080        }
081        formBase.setEditingMode(editMode);
082    }
083}