001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.ContentPageEdit;
021import com.echothree.control.user.content.common.form.EditContentPageForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentPageResult;
024import com.echothree.control.user.content.common.spec.ContentPageSpec;
025import com.echothree.model.control.content.server.control.ContentControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.content.server.entity.ContentPage;
030import com.echothree.model.data.content.server.entity.ContentPageLayout;
031import com.echothree.model.data.content.server.entity.ContentSection;
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 java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditContentPageCommand
047        extends BaseAbstractEditCommand<ContentPageSpec, ContentPageEdit, EditContentPageResult, ContentPage, ContentPage> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ContentPage.name(), SecurityRoles.Edit.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("ContentSectionName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("ContentPageName", FieldType.ENTITY_NAME, true, null, null)
065        );
066        
067        EDIT_FIELD_DEFINITIONS = List.of(
068                new FieldDefinition("ContentPageName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("ContentPageLayoutName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
071                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
072                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
073        );
074    }
075
076    @Inject
077    ContentControl contentControl;
078
079    
080    /** Creates a new instance of EditContentPageCommand */
081    public EditContentPageCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditContentPageResult getResult() {
087        return ContentResultFactory.getEditContentPageResult();
088    }
089    
090    @Override
091    public ContentPageEdit getEdit() {
092        return ContentEditFactory.getContentPageEdit();
093    }
094    
095    ContentSection contentSection = null;
096    
097    @Override
098    public ContentPage getEntity(EditContentPageResult result) {
099        ContentPage contentPage = null;
100        var contentCollectionName = spec.getContentCollectionName();
101        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
102        
103        if(contentCollection != null) {
104            var contentSectionName = spec.getContentSectionName();
105            
106            contentSection = contentControl.getContentSectionByName(contentCollection, contentSectionName);
107            
108            if(contentSection != null) {
109                var contentPageName = spec.getContentPageName();
110                
111                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
112                    contentPage = contentControl.getContentPageByName(contentSection, contentPageName);
113                } else { // EditMode.UPDATE
114                    contentPage = contentControl.getContentPageByNameForUpdate(contentSection, contentPageName);
115                }
116
117                if(contentPage != null) {
118                    result.setContentPage(contentControl.getContentPageTransfer(getUserVisit(), contentPage));
119                } else {
120                    addExecutionError(ExecutionErrors.UnknownContentPageName.name(), contentPageName);
121                }
122            } else {
123                addExecutionError(ExecutionErrors.UnknownContentSectionName.name(), contentSectionName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
127        }
128
129        return contentPage;
130    }
131    
132    @Override
133    public ContentPage getLockEntity(ContentPage contentPage) {
134        return contentPage;
135    }
136    
137    @Override
138    public void fillInResult(EditContentPageResult result, ContentPage contentPage) {
139        result.setContentPage(contentControl.getContentPageTransfer(getUserVisit(), contentPage));
140    }
141    
142    @Override
143    public void doLock(ContentPageEdit edit, ContentPage contentPage) {
144        var contentPageDescription = contentControl.getContentPageDescription(contentPage, getPreferredLanguage());
145        var contentPageDetail = contentPage.getLastDetail();
146
147        edit.setContentPageName(contentPageDetail.getContentPageName());
148        edit.setContentPageLayoutName(contentPageDetail.getContentPageLayout().getLastDetail().getContentPageLayoutName());
149        edit.setIsDefault(contentPageDetail.getIsDefault().toString());
150        edit.setSortOrder(contentPageDetail.getSortOrder().toString());
151
152        if(contentPageDescription != null) {
153            edit.setDescription(contentPageDescription.getDescription());
154        }
155    }
156    
157    ContentPageLayout contentPageLayout = null;
158    
159    @Override
160    public void canUpdate(ContentPage contentPage) {
161        var contentPageName = edit.getContentPageName();
162        var duplicateContentPage = contentControl.getContentPageByName(contentSection, contentPageName);
163
164        if(duplicateContentPage == null || contentPage.equals(duplicateContentPage)) {
165            var contentPageLayoutName = edit.getContentPageLayoutName();
166            
167            contentPageLayout = contentControl.getContentPageLayoutByName(contentPageLayoutName);
168
169            if(contentPageLayout == null) {
170                addExecutionError(ExecutionErrors.UnknownContentPageLayoutName.name(), contentPageLayoutName);
171            }
172        } else {
173            addExecutionError(ExecutionErrors.DuplicateContentPageName.name(), contentPageName);
174        }
175    }
176    
177    @Override
178    public void doUpdate(ContentPage contentPage) {
179        var partyPK = getPartyPK();
180        var contentPageDetailValue = contentControl.getContentPageDetailValueForUpdate(contentPage);
181        var contentPageDescription = contentControl.getContentPageDescriptionForUpdate(contentPage, getPreferredLanguage());
182        var description = edit.getDescription();
183
184        contentPageDetailValue.setContentPageName(edit.getContentPageName());
185        contentPageDetailValue.setContentPageLayoutPK(contentPageLayout.getPrimaryKey());
186        contentPageDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
187        contentPageDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
188
189        contentControl.updateContentPageFromValue(contentPageDetailValue, partyPK);
190
191        if(contentPageDescription == null && description != null) {
192            contentControl.createContentPageDescription(contentPage, getPreferredLanguage(), description, partyPK);
193        } else if(contentPageDescription != null && description == null) {
194            contentControl.deleteContentPageDescription(contentPageDescription, partyPK);
195        } else if(contentPageDescription != null && description != null) {
196            var contentPageDescriptionValue = contentControl.getContentPageDescriptionValue(contentPageDescription);
197
198            contentPageDescriptionValue.setDescription(description);
199            contentControl.updateContentPageDescriptionFromValue(contentPageDescriptionValue, partyPK);
200        }
201    }
202    
203}