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.printer.server.command;
018
019import com.echothree.control.user.printer.common.edit.PrinterEdit;
020import com.echothree.control.user.printer.common.edit.PrinterEditFactory;
021import com.echothree.control.user.printer.common.form.EditPrinterForm;
022import com.echothree.control.user.printer.common.result.EditPrinterResult;
023import com.echothree.control.user.printer.common.result.PrinterResultFactory;
024import com.echothree.control.user.printer.common.spec.PrinterSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.printer.server.control.PrinterControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.printer.server.entity.Printer;
030import com.echothree.model.data.printer.server.entity.PrinterGroup;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditPrinterCommand
046        extends BaseAbstractEditCommand<PrinterSpec, PrinterEdit, EditPrinterResult, Printer, Printer> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.Printer.name(), SecurityRoles.Edit.name())
057                ))
058        ));
059
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("PrinterName", FieldType.ENTITY_NAME, true, null, null)
062        );
063
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("PrinterName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("Priority", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068        );
069    }
070
071    @Inject
072    PrinterControl printerControl;
073
074    /** Creates a new instance of EditPrinterCommand */
075    public EditPrinterCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078
079    @Override
080    public EditPrinterResult getResult() {
081        return PrinterResultFactory.getEditPrinterResult();
082    }
083
084    @Override
085    public PrinterEdit getEdit() {
086        return PrinterEditFactory.getPrinterEdit();
087    }
088
089    @Override
090    public Printer getEntity(EditPrinterResult result) {
091        Printer printer;
092        var printerName = spec.getPrinterName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            printer = printerControl.getPrinterByName(printerName);
096        } else { // EditMode.UPDATE
097            printer = printerControl.getPrinterByNameForUpdate(printerName);
098        }
099
100        if(printer != null) {
101            result.setPrinter(printerControl.getPrinterTransfer(getUserVisit(), printer));
102        } else {
103            addExecutionError(ExecutionErrors.UnknownPrinterName.name(), printerName);
104        }
105
106        return printer;
107    }
108
109    @Override
110    public Printer getLockEntity(Printer printer) {
111        return printer;
112    }
113
114    @Override
115    public void fillInResult(EditPrinterResult result, Printer printer) {
116        result.setPrinter(printerControl.getPrinterTransfer(getUserVisit(), printer));
117    }
118
119    @Override
120    public void doLock(PrinterEdit edit, Printer printer) {
121        var printerDescription = printerControl.getPrinterDescription(printer, getPreferredLanguage());
122        var printerDetail = printer.getLastDetail();
123
124        edit.setPrinterName(printerDetail.getPrinterName());
125        edit.setPrinterGroupName(printerDetail.getPrinterGroup().getLastDetail().getPrinterGroupName());
126        edit.setPriority(printerDetail.getPriority().toString());
127
128        if(printerDescription != null) {
129            edit.setDescription(printerDescription.getDescription());
130        }
131    }
132
133    PrinterGroup printerGroup;
134
135    @Override
136    public void canUpdate(Printer printer) {
137        var printerName = edit.getPrinterName();
138        var duplicatePrinter = printerControl.getPrinterByName(printerName);
139
140        if(duplicatePrinter != null && !printer.equals(duplicatePrinter)) {
141            addExecutionError(ExecutionErrors.DuplicatePrinterName.name(), printerName);
142        } else {
143            var printerGroupName = edit.getPrinterGroupName();
144
145            printerGroup = printerControl.getPrinterGroupByName(printerGroupName);
146
147            if(printerGroup == null) {
148                addExecutionError(ExecutionErrors.DuplicatePrinterGroupName.name(), printerGroupName);
149            }
150        }
151    }
152
153    @Override
154    public void doUpdate(Printer printer) {
155        var partyPK = getPartyPK();
156        var printerDetailValue = printerControl.getPrinterDetailValueForUpdate(printer);
157        var printerDescription = printerControl.getPrinterDescriptionForUpdate(printer, getPreferredLanguage());
158        var description = edit.getDescription();
159
160        printerDetailValue.setPrinterName(edit.getPrinterName());
161        printerDetailValue.setPrinterGroupPK(printerGroup.getPrimaryKey());
162        printerDetailValue.setPriority(Integer.valueOf(edit.getPriority()));
163
164        printerControl.updatePrinterFromValue(printerDetailValue, partyPK);
165
166        if(printerDescription == null && description != null) {
167            printerControl.createPrinterDescription(printer, getPreferredLanguage(), description, partyPK);
168        } else if(printerDescription != null && description == null) {
169            printerControl.deletePrinterDescription(printerDescription, partyPK);
170        } else if(printerDescription != null && description != null) {
171            var printerDescriptionValue = printerControl.getPrinterDescriptionValue(printerDescription);
172
173            printerDescriptionValue.setDescription(description);
174            printerControl.updatePrinterDescriptionFromValue(printerDescriptionValue, partyPK);
175        }
176    }
177
178}