001/**
002 * Copyright 2005-2018 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.util.GlobalVariables;
031import org.kuali.rice.krad.util.KRADConstants;
032
033import javax.servlet.http.HttpServletRequest;
034import javax.servlet.http.HttpServletResponse;
035import java.util.HashMap;
036import java.util.Map;
037import java.util.Set;
038
039/**
040 * This class handles UI actions for all shared methods of transactional documents.
041 *
042 * @deprecated Use {@link org.kuali.rice.krad.document.TransactionalDocumentControllerBase}.
043 */
044@Deprecated
045public class KualiTransactionalDocumentActionBase extends KualiDocumentActionBase {
046//    private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(KualiTransactionalDocumentActionBase.class);
047
048    /**
049     * Method that will take the current document and call its copy method if Copyable.
050     */
051    public ActionForward copy(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
052        KualiTransactionalDocumentFormBase tmpForm = (KualiTransactionalDocumentFormBase) form;
053
054        Document document = tmpForm.getDocument();
055        
056        if (!tmpForm.getDocumentActions().containsKey(KRADConstants.KUALI_ACTION_CAN_COPY)) {
057            throw buildAuthorizationException("copy", document);
058        }
059
060        ((Copyable) tmpForm.getTransactionalDocument()).toCopy();
061
062        return mapping.findForward(RiceConstants.MAPPING_BASIC);
063    }
064
065    @SuppressWarnings("unchecked")
066        protected void populateAuthorizationFields(KualiDocumentFormBase formBase){
067        super.populateAuthorizationFields(formBase);
068        Document document = formBase.getDocument();
069        Map editMode = new HashMap();
070        
071        if (formBase.isFormDocumentInitialized()) {
072                Person user = GlobalVariables.getUserSession().getPerson();
073                
074                TransactionalDocumentPresentationController documentPresentationController = (TransactionalDocumentPresentationController) getDocumentHelperService().getDocumentPresentationController(document);
075            TransactionalDocumentAuthorizer documentAuthorizer = (TransactionalDocumentAuthorizer) KNSServiceLocator
076                    .getDocumentHelperService().getDocumentAuthorizer(document);
077            Set<String> editModes = documentAuthorizer.getEditModes(document, user, documentPresentationController.getEditModes(document));
078            editMode = this.convertSetToMap(editModes);
079            if (getDataDictionaryService().getDataDictionary().getDocumentEntry(document.getClass().getName()).getUsePessimisticLocking()) {
080                editMode = getPessimisticLockService().establishLocks(document, editMode, user);
081            }            
082        }
083        formBase.setEditingMode(editMode);
084    }
085}