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 com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditContentPageCommand */
077    public EditContentPageCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    public EditContentPageResult getResult() {
083        return ContentResultFactory.getEditContentPageResult();
084    }
085    
086    @Override
087    public ContentPageEdit getEdit() {
088        return ContentEditFactory.getContentPageEdit();
089    }
090    
091    ContentSection contentSection = null;
092    
093    @Override
094    public ContentPage getEntity(EditContentPageResult result) {
095        var contentControl = Session.getModelController(ContentControl.class);
096        ContentPage contentPage = null;
097        var contentCollectionName = spec.getContentCollectionName();
098        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
099        
100        if(contentCollection != null) {
101            var contentSectionName = spec.getContentSectionName();
102            
103            contentSection = contentControl.getContentSectionByName(contentCollection, contentSectionName);
104            
105            if(contentSection != null) {
106                var contentPageName = spec.getContentPageName();
107                
108                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
109                    contentPage = contentControl.getContentPageByName(contentSection, contentPageName);
110                } else { // EditMode.UPDATE
111                    contentPage = contentControl.getContentPageByNameForUpdate(contentSection, contentPageName);
112                }
113
114                if(contentPage != null) {
115                    result.setContentPage(contentControl.getContentPageTransfer(getUserVisit(), contentPage));
116                } else {
117                    addExecutionError(ExecutionErrors.UnknownContentPageName.name(), contentPageName);
118                }
119            } else {
120                addExecutionError(ExecutionErrors.UnknownContentSectionName.name(), contentSectionName);
121            }
122        } else {
123            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
124        }
125
126        return contentPage;
127    }
128    
129    @Override
130    public ContentPage getLockEntity(ContentPage contentPage) {
131        return contentPage;
132    }
133    
134    @Override
135    public void fillInResult(EditContentPageResult result, ContentPage contentPage) {
136        var contentControl = Session.getModelController(ContentControl.class);
137        
138        result.setContentPage(contentControl.getContentPageTransfer(getUserVisit(), contentPage));
139    }
140    
141    @Override
142    public void doLock(ContentPageEdit edit, ContentPage contentPage) {
143        var contentControl = Session.getModelController(ContentControl.class);
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 contentControl = Session.getModelController(ContentControl.class);
162        var contentPageName = edit.getContentPageName();
163        var duplicateContentPage = contentControl.getContentPageByName(contentSection, contentPageName);
164
165        if(duplicateContentPage == null || contentPage.equals(duplicateContentPage)) {
166            var contentPageLayoutName = edit.getContentPageLayoutName();
167            
168            contentPageLayout = contentControl.getContentPageLayoutByName(contentPageLayoutName);
169
170            if(contentPageLayout == null) {
171                addExecutionError(ExecutionErrors.UnknownContentPageLayoutName.name(), contentPageLayoutName);
172            }
173        } else {
174            addExecutionError(ExecutionErrors.DuplicateContentPageName.name(), contentPageName);
175        }
176    }
177    
178    @Override
179    public void doUpdate(ContentPage contentPage) {
180        var contentControl = Session.getModelController(ContentControl.class);
181        var partyPK = getPartyPK();
182        var contentPageDetailValue = contentControl.getContentPageDetailValueForUpdate(contentPage);
183        var contentPageDescription = contentControl.getContentPageDescriptionForUpdate(contentPage, getPreferredLanguage());
184        var description = edit.getDescription();
185
186        contentPageDetailValue.setContentPageName(edit.getContentPageName());
187        contentPageDetailValue.setContentPageLayoutPK(contentPageLayout.getPrimaryKey());
188        contentPageDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
189        contentPageDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
190
191        contentControl.updateContentPageFromValue(contentPageDetailValue, partyPK);
192
193        if(contentPageDescription == null && description != null) {
194            contentControl.createContentPageDescription(contentPage, getPreferredLanguage(), description, partyPK);
195        } else if(contentPageDescription != null && description == null) {
196            contentControl.deleteContentPageDescription(contentPageDescription, partyPK);
197        } else if(contentPageDescription != null && description != null) {
198            var contentPageDescriptionValue = contentControl.getContentPageDescriptionValue(contentPageDescription);
199
200            contentPageDescriptionValue.setDescription(description);
201            contentControl.updateContentPageDescriptionFromValue(contentPageDescriptionValue, partyPK);
202        }
203    }
204    
205}