001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
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// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.document.server.command;
018
019import com.echothree.control.user.document.common.form.CreatePartyDocumentForm;
020import com.echothree.control.user.document.common.result.CreatePartyDocumentResult;
021import com.echothree.control.user.document.common.result.DocumentResultFactory;
022import com.echothree.model.control.core.common.EntityAttributeTypes;
023import com.echothree.model.control.document.server.control.DocumentControl;
024import com.echothree.model.control.document.server.logic.DocumentLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.core.server.entity.EntityAttributeType;
030import com.echothree.model.data.core.server.entity.MimeType;
031import com.echothree.model.data.core.server.entity.MimeTypeUsage;
032import com.echothree.model.data.core.server.entity.MimeTypeUsageType;
033import com.echothree.model.data.document.server.entity.Document;
034import com.echothree.model.data.document.server.entity.DocumentType;
035import com.echothree.model.data.document.server.entity.DocumentTypeUsage;
036import com.echothree.model.data.document.server.entity.DocumentTypeUsageType;
037import com.echothree.model.data.document.server.entity.PartyDocument;
038import com.echothree.model.data.document.server.entity.PartyTypeDocumentTypeUsageType;
039import com.echothree.model.data.party.server.entity.Party;
040import com.echothree.model.data.party.server.entity.PartyType;
041import com.echothree.model.data.user.common.pk.UserVisitPK;
042import com.echothree.util.common.message.ExecutionErrors;
043import com.echothree.util.common.validation.FieldDefinition;
044import com.echothree.util.common.validation.FieldType;
045import com.echothree.util.common.command.BaseResult;
046import com.echothree.util.common.persistence.type.ByteArray;
047import com.echothree.util.server.control.BaseSimpleCommand;
048import com.echothree.util.server.control.CommandSecurityDefinition;
049import com.echothree.util.server.control.PartyTypeDefinition;
050import com.echothree.util.server.control.SecurityRoleDefinition;
051import com.echothree.util.server.persistence.Session;
052import java.util.Arrays;
053import java.util.Collections;
054import java.util.List;
055
056public class CreatePartyDocumentCommand
057        extends BaseSimpleCommand<CreatePartyDocumentForm> {
058    
059    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
060    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
061    
062    static {
063        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
064                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
065                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
066                    new SecurityRoleDefinition(SecurityRoleGroups.PartyDocument.name(), SecurityRoles.Create.name())
067                    )))
068                )));
069        
070        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, true, null, null),
072                new FieldDefinition("DocumentTypeName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("MimeTypeName", FieldType.MIME_TYPE, true, null, null),
074                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
076                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
077                new FieldDefinition("Clob", FieldType.STRING, false, 1L, null)
078                ));
079    }
080    
081    /** Creates a new instance of CreatePartyDocumentCommand */
082    public CreatePartyDocumentCommand(UserVisitPK userVisitPK, CreatePartyDocumentForm form) {
083        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
084    }
085
086    private void createPartyDocument(Party party, DocumentType documentType, MimeType mimeType, ByteArray blob, String clob, CreatePartyDocumentResult result) {
087        var isDefault = Boolean.valueOf(form.getIsDefault());
088        var sortOrder = Integer.valueOf(form.getSortOrder());
089        var description = form.getDescription();
090
091        PartyDocument partyDocument = DocumentLogic.getInstance().createPartyDocument(this, party, documentType, mimeType, isDefault, sortOrder,
092                getPreferredLanguage(), description, blob, clob, getPartyPK());
093
094        if(!hasExecutionErrors()) {
095            Document document = partyDocument.getDocument();
096
097            result.setEntityRef(document.getPrimaryKey().getEntityRef());
098            result.setDocumentName(document.getLastDetail().getDocumentName());
099        }
100    }
101
102    @Override
103    protected BaseResult execute() {
104        var partyControl = Session.getModelController(PartyControl.class);
105        CreatePartyDocumentResult result = DocumentResultFactory.getCreatePartyDocumentResult();
106        String partyName = form.getPartyName();
107        Party party = partyControl.getPartyByName(partyName);
108
109        if(party != null) {
110            var documentControl = Session.getModelController(DocumentControl.class);
111            String documentTypeName = form.getDocumentTypeName();
112            DocumentType documentType = documentControl.getDocumentTypeByName(documentTypeName);
113
114            if(documentType != null) {
115                List<DocumentTypeUsage> documentTypeUsages = documentControl.getDocumentTypeUsagesByDocumentType(documentType);
116                PartyType partyType = party.getLastDetail().getPartyType();
117                Integer maximumInstances = null;
118                boolean foundPartyTypeDocumentTypeUsageType = false;
119
120                for(var documentTypeUsage : documentTypeUsages) {
121                    DocumentTypeUsageType documentTypeUsageType = documentTypeUsage.getDocumentTypeUsageType();
122                    PartyTypeDocumentTypeUsageType partyTypeDocumentTypeUsageType = documentControl.getPartyTypeDocumentTypeUsageType(partyType, documentTypeUsageType);
123
124                    if(partyTypeDocumentTypeUsageType != null) {
125                        foundPartyTypeDocumentTypeUsageType = true;
126
127                        if(maximumInstances == null) {
128                            maximumInstances = documentTypeUsage.getMaximumInstances();
129                        } else {
130                            Integer foundMaximumInstances = documentTypeUsage.getMaximumInstances();
131
132                            if(foundMaximumInstances != null && foundMaximumInstances > maximumInstances) {
133                                maximumInstances = foundMaximumInstances;
134                            }
135                        }
136                    }
137                }
138
139                if(foundPartyTypeDocumentTypeUsageType) {
140                    if(maximumInstances != null) {
141                        Long instances = documentControl.countPartyDocumentsByPartyAndDocumentType(party, documentType);
142
143                        if(instances >= maximumInstances) {
144                            addExecutionError(ExecutionErrors.MaximumInstancesExceeded.name());
145                        }
146                    }
147
148                    if(!hasExecutionErrors()) {
149                        var coreControl = getCoreControl();
150                        String mimeTypeName = form.getMimeTypeName();
151                        MimeType mimeType = coreControl.getMimeTypeByName(mimeTypeName);
152
153                        if(mimeType != null) {
154                            MimeTypeUsageType mimeTypeUsageType = documentType.getLastDetail().getMimeTypeUsageType();
155                            MimeTypeUsage mimeTypeUsage = mimeTypeUsageType == null ? null : coreControl.getMimeTypeUsage(mimeType, mimeTypeUsageType);
156
157                            if(mimeTypeUsageType == null || mimeTypeUsage != null) {
158                                EntityAttributeType entityAttributeType = mimeType.getLastDetail().getEntityAttributeType();
159                                String entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
160
161                                if(entityAttributeTypeName.equals(EntityAttributeTypes.BLOB.name())) {
162                                    ByteArray blob = form.getBlob();
163
164                                    if(blob != null) {
165                                        createPartyDocument(party, documentType, mimeType, blob, null, result);
166                                    } else {
167                                        addExecutionError(ExecutionErrors.MissingBlob.name());
168                                    }
169                                } else if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name())) {
170                                    String clob = form.getClob();
171
172                                    if(clob != null) {
173                                        createPartyDocument(party, documentType, mimeType, null, clob, result);
174                                    } else {
175                                        addExecutionError(ExecutionErrors.MissingClob.name());
176                                    }
177                                } else {
178                                    addExecutionError(ExecutionErrors.UnknownEntityAttributeTypeName.name(), entityAttributeTypeName);
179                                }
180                            } else {
181                                addExecutionError(ExecutionErrors.UnknownMimeTypeUsage.name());
182                            }
183                        } else {
184                            addExecutionError(ExecutionErrors.UnknownMimeTypeName.name(), mimeTypeName);
185                        }
186                    }
187                } else {
188                    addExecutionError(ExecutionErrors.UnknownPartyTypeDocumentTypeUsageType.name());
189                }
190            } else {
191                addExecutionError(ExecutionErrors.UnknownPartyName.name(), documentTypeName);
192            }
193        } else {
194            addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
195        }
196
197        return result;
198    }
199    
200}