001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.content.server.command;
018
019import com.echothree.control.user.content.common.edit.ContentEditFactory;
020import com.echothree.control.user.content.common.edit.ContentPageDescriptionEdit;
021import com.echothree.control.user.content.common.form.EditContentPageDescriptionForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentPageDescriptionResult;
024import com.echothree.control.user.content.common.spec.ContentPageDescriptionSpec;
025import com.echothree.model.control.content.server.control.ContentControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.content.server.entity.ContentPage;
031import com.echothree.model.data.content.server.entity.ContentPageDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.Arrays;
043import java.util.Collections;
044import java.util.List;
045import javax.enterprise.context.RequestScoped;
046
047@RequestScoped
048public class EditContentPageDescriptionCommand
049        extends BaseAbstractEditCommand<ContentPageDescriptionSpec, ContentPageDescriptionEdit, EditContentPageDescriptionResult, ContentPageDescription, ContentPage> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.ContentPage.name(), SecurityRoles.Description.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ContentSectionName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("ContentPageName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069        
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
072                ));
073    }
074    
075    /** Creates a new instance of EditContentPageDescriptionCommand */
076    public EditContentPageDescriptionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditContentPageDescriptionResult getResult() {
082        return ContentResultFactory.getEditContentPageDescriptionResult();
083    }
084    
085    @Override
086    public ContentPageDescriptionEdit getEdit() {
087        return ContentEditFactory.getContentPageDescriptionEdit();
088    }
089    
090    @Override
091    public ContentPageDescription getEntity(EditContentPageDescriptionResult result) {
092        var contentControl = Session.getModelController(ContentControl.class);
093        ContentPageDescription contentPageDescription = null;
094        var contentCollectionName = spec.getContentCollectionName();
095        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
096        
097        if(contentCollection != null) {
098            var contentSectionName = spec.getContentSectionName();
099            var contentSection = contentControl.getContentSectionByName(contentCollection, contentSectionName);
100            
101            if(contentSection != null) {
102                var contentPageName = spec.getContentPageName();
103                var contentPage = contentControl.getContentPageByName(contentSection, contentPageName);
104                
105                if(contentPage != null) {
106                    var partyControl = Session.getModelController(PartyControl.class);
107                    var languageIsoName = spec.getLanguageIsoName();
108                    var language = partyControl.getLanguageByIsoName(languageIsoName);
109                    
110                    result.setContentPage(contentControl.getContentPageTransfer(getUserVisit(), contentPage));
111                    
112                    if(language != null) {
113                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
114                            contentPageDescription = contentControl.getContentPageDescription(contentPage, language);
115                        } else { // EditMode.UPDATE
116                            contentPageDescription = contentControl.getContentPageDescriptionForUpdate(contentPage, language);
117                        }
118
119                        if(contentPageDescription == null) {
120                            addExecutionError(ExecutionErrors.UnknownContentPageDescription.name());
121                        }
122                    } else {
123                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
124                    }
125                } else {
126                    addExecutionError(ExecutionErrors.UnknownContentPageName.name(), contentPageName);
127                }
128            } else {
129                addExecutionError(ExecutionErrors.UnknownContentSectionName.name(), contentSectionName);
130            }
131        } else {
132            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
133        }
134
135        return contentPageDescription;
136    }
137    
138    @Override
139    public ContentPage getLockEntity(ContentPageDescription contentPageDescription) {
140        return contentPageDescription.getContentPage();
141    }
142    
143    @Override
144    public void fillInResult(EditContentPageDescriptionResult result, ContentPageDescription contentPageDescription) {
145        var contentControl = Session.getModelController(ContentControl.class);
146        
147        result.setContentPageDescription(contentControl.getContentPageDescriptionTransfer(getUserVisit(), contentPageDescription));
148    }
149    
150    @Override
151    public void doLock(ContentPageDescriptionEdit edit, ContentPageDescription contentPageDescription) {
152        edit.setDescription(contentPageDescription.getDescription());
153    }
154    
155    @Override
156    public void doUpdate(ContentPageDescription contentPageDescription) {
157        var contentControl = Session.getModelController(ContentControl.class);
158        var contentPageDescriptionValue = contentControl.getContentPageDescriptionValue(contentPageDescription);
159        contentPageDescriptionValue.setDescription(edit.getDescription());
160
161        contentControl.updateContentPageDescriptionFromValue(contentPageDescriptionValue, getPartyPK());
162    }
163    
164}