/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License, Version 1.0 only * (the "License"). You may not use this file except in compliance * with the License. * * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt * or http://forgerock.org/license/CDDLv1.0.html. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at legal-notices/CDDLv1_0.txt. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: * Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END * * * Copyright 2009 Sun Microsystems, Inc. * Portions Copyright 2013-2015 ForgeRock AS. */ package org.opends.guitools.controlpanel.task; import static org.forgerock.util.Utils.*; import static org.opends.messages.AdminToolMessages.*; import static org.opends.server.types.CommonSchemaElements.*; import java.io.File; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Iterator; import java.util.LinkedHashMap; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Set; import javax.naming.NamingException; import javax.naming.directory.BasicAttribute; import javax.naming.directory.DirContext; import javax.naming.directory.ModificationItem; import javax.swing.SwingUtilities; import org.forgerock.i18n.LocalizableMessage; import org.forgerock.opendj.ldap.ModificationType; import org.forgerock.opendj.ldap.schema.MatchingRule; import org.opends.guitools.controlpanel.datamodel.ControlPanelInfo; import org.opends.guitools.controlpanel.ui.ColorAndFontConstants; import org.opends.guitools.controlpanel.ui.ProgressDialog; import org.opends.guitools.controlpanel.util.Utilities; import org.opends.server.config.ConfigConstants; import org.opends.server.core.DirectoryServer; import org.opends.server.types.AttributeType; import org.opends.server.types.Attributes; import org.opends.server.types.CommonSchemaElements; import org.opends.server.types.DirectoryException; import org.opends.server.types.Entry; import org.opends.server.types.ExistingFileBehavior; import org.opends.server.types.LDIFExportConfig; import org.opends.server.types.LDIFImportConfig; import org.opends.server.types.Modification; import org.opends.server.types.ObjectClass; import org.opends.server.types.OpenDsException; import org.opends.server.types.SchemaFileElement; import org.opends.server.util.LDIFReader; import org.opends.server.util.LDIFWriter; import org.opends.server.util.ServerConstants; /** * An abstract class used to re-factor some code between the different tasks * that create elements in the schema. */ public class NewSchemaElementsTask extends Task { private final Set ocsToAdd = new LinkedHashSet<>(); private final Set attrsToAdd = new LinkedHashSet<>(); /** * Constructor of the task. * * @param info * the control panel information. * @param dlg * the progress dialog where the task progress will be displayed. * @param ocsToAdd * the object classes that must be created in order. * @param attrsToAdd * the attributes that must be created in order. */ public NewSchemaElementsTask( ControlPanelInfo info, ProgressDialog dlg, Set ocsToAdd, Set attrsToAdd) { super(info, dlg); this.ocsToAdd.addAll(ocsToAdd); this.attrsToAdd.addAll(attrsToAdd); } @Override public Set getBackends() { return Collections.emptySet(); } @Override public boolean canLaunch(Task taskToBeLaunched, Collection incompatibilityReasons) { if (state == State.RUNNING && (taskToBeLaunched.getType() == Task.Type.DELETE_SCHEMA_ELEMENT || taskToBeLaunched.getType() == Task.Type.MODIFY_SCHEMA_ELEMENT || taskToBeLaunched.getType() == Task.Type.NEW_SCHEMA_ELEMENT)) { incompatibilityReasons.add(getIncompatibilityMessage(this, taskToBeLaunched)); return false; } return true; } @Override public void runTask() { state = State.RUNNING; lastException = null; try { updateSchema(); state = State.FINISHED_SUCCESSFULLY; } catch (Throwable t) { lastException = t; state = State.FINISHED_WITH_ERROR; } } @Override public Type getType() { return Type.NEW_SCHEMA_ELEMENT; } @Override public LocalizableMessage getTaskDescription() { if (attrsToAdd.size() == 1 && ocsToAdd.isEmpty()) { return INFO_CTRL_PANEL_NEW_ATTRIBUTE_TASK_DESCRIPTION.get(attrsToAdd.iterator().next().getNameOrOID()); } else if (ocsToAdd.size() == 1 && attrsToAdd.isEmpty()) { return INFO_CTRL_PANEL_NEW_OBJECTCLASS_TASK_DESCRIPTION.get(ocsToAdd.iterator().next().getNameOrOID()); } else { final List attrNames = getElementsNameOrOID(attrsToAdd); final List ocNames = getElementsNameOrOID(ocsToAdd); if (ocNames.isEmpty()) { return INFO_CTRL_PANEL_NEW_ATTRIBUTES_TASK_DESCRIPTION.get(joinAsString(", ", attrNames)); } else if (attrNames.isEmpty()) { return INFO_CTRL_PANEL_NEW_OBJECTCLASSES_TASK_DESCRIPTION.get(joinAsString(", ", ocNames)); } else { return INFO_CTRL_PANEL_NEW_SCHEMA_ELEMENTS_TASK_DESCRIPTION.get( joinAsString(", ", attrNames), joinAsString(", ", ocNames)); } } } private List getElementsNameOrOID(final Collection schemaElements) { final List nameOrOIDs = new ArrayList<>(); for (CommonSchemaElements schemaElement : schemaElements) { nameOrOIDs.add(schemaElement.getNameOrOID()); } return nameOrOIDs; } /** * Update the schema. * * @throws OpenDsException * if an error occurs. */ private void updateSchema() throws OpenDsException { if (isServerRunning()) { updateSchemaOnline(); } else { updateSchemaOffline(); } } @Override protected String getCommandLinePath() { return null; } @Override protected List getCommandLineArguments() { return Collections.emptyList(); } /** * Add the schema elements one by one: we are not sure that the server will * handle the adds sequentially if we only send one modification. * * @throws OpenDsException */ private void updateSchemaOnline() throws OpenDsException { for (AttributeType attr : attrsToAdd) { addAttributeOnline(attr); appendNewLinesToProgress(); } for (ObjectClass oc : ocsToAdd) { addObjectClassOnline(oc); appendNewLinesToProgress(); } } private void appendNewLinesToProgress() { SwingUtilities.invokeLater(new Runnable() { @Override public void run() { getProgressDialog().appendProgressHtml(Utilities.applyFont("

", ColorAndFontConstants.progressFont)); } }); } private void updateSchemaOffline() throws OpenDsException { // Group the changes in the same schema file. final Map> hmAttrs = copy(attrsToAdd); final Map> hmOcs = copy(ocsToAdd); final Set allFileNames = new LinkedHashSet<>(hmAttrs.keySet()); allFileNames.addAll(hmOcs.keySet()); for (String fileName : allFileNames) { List attrs = get(hmAttrs, fileName); List ocs = get(hmOcs, fileName); if ("".equals(fileName)) { fileName = null; } updateSchemaOffline(fileName, attrs, ocs); appendNewLinesToProgress(); } } private List get(Map> hmElems, String fileName) { List elems = hmElems.get(fileName); if (elems != null) { return elems; } return Collections.emptyList(); } private Map> copy(Set elemsToAdd) { Map> hmElems = new LinkedHashMap<>(); for (T elem : elemsToAdd) { String fileName = CommonSchemaElements.getSchemaFile(elem); if (fileName == null) { fileName = ""; } List elems = hmElems.get(fileName); if (elems == null) { elems = new ArrayList<>(); hmElems.put(fileName, elems); } elems.add(elem); } return hmElems; } private void addAttributeOnline(final AttributeType attribute) throws OpenDsException { addSchemaElementOnline(attribute, INFO_CTRL_PANEL_CREATING_ATTRIBUTE_PROGRESS.get(attribute.getNameOrOID())); } private void addObjectClassOnline(final ObjectClass objectClass) throws OpenDsException { addSchemaElementOnline(objectClass, INFO_CTRL_PANEL_CREATING_OBJECTCLASS_PROGRESS.get(objectClass.getNameOrOID())); } private void addSchemaElementOnline(final CommonSchemaElements schemaElement, final LocalizableMessage progressMsg) throws OpenDsException { SwingUtilities.invokeLater(new Runnable() { @Override public void run() { printEquivalentCommandLineToAddOnline(schemaElement); getProgressDialog().appendProgressHtml( Utilities.getProgressWithPoints(progressMsg, ColorAndFontConstants.progressFont)); } }); try { final BasicAttribute attr = new BasicAttribute(getAttributeName(schemaElement)); attr.add(getElementDefinition(schemaElement)); final ModificationItem mod = new ModificationItem(DirContext.ADD_ATTRIBUTE, attr); getInfo().getDirContext().modifyAttributes( ConfigConstants.DN_DEFAULT_SCHEMA_ROOT, new ModificationItem[] { mod }); } catch (NamingException ne) { throw new OnlineUpdateException(ERR_CTRL_PANEL_ERROR_UPDATING_SCHEMA.get(ne), ne); } notifyConfigurationElementCreated(schemaElement); SwingUtilities.invokeLater(new Runnable() { @Override public void run() { getProgressDialog().appendProgressHtml(Utilities.getProgressDone(ColorAndFontConstants.progressFont)); } }); } private String getValueOffline(CommonSchemaElements element) { final Map> props = element.getExtraProperties(); List previousValues = props.get(ServerConstants.SCHEMA_PROPERTY_FILENAME); setExtraProperty(element, ServerConstants.SCHEMA_PROPERTY_FILENAME, null); String attributeWithoutFileDefinition = getElementDefinition(element); if (previousValues != null && !previousValues.isEmpty()) { element.setExtraProperty(ServerConstants.SCHEMA_PROPERTY_FILENAME, new ArrayList(previousValues)); } return attributeWithoutFileDefinition; } private String getElementDefinition(CommonSchemaElements element) { final List names = new ArrayList<>(element.getNormalizedNames()); if (element instanceof AttributeType) { return getAttributeTypeDefinition((AttributeType) element, names); } else if (element instanceof ObjectClass) { return getObjectClassDefinition((ObjectClass) element, names); } else { throw new IllegalArgumentException("Unsupported schema element: " + element.getClass().getName()); } } private String getAttributeTypeDefinition(final AttributeType attributeType, final List names) { final StringBuilder buffer = new StringBuilder(); buffer.append("( ").append(attributeType.getOID()); appendCollection(buffer, "NAME", names); appendDescription(buffer, attributeType.getDescription()); appendIfTrue(buffer, " OBSOLETE", attributeType.isObsolete()); final AttributeType superiorType = attributeType.getSuperiorType(); final String superiorTypeOID = superiorType != null ? superiorType.getOID() : null; appendIfNotNull(buffer, " SUP ", superiorTypeOID); addMatchingRuleIfNotNull(buffer, " EQUALITY ", attributeType.getEqualityMatchingRule()); addMatchingRuleIfNotNull(buffer, " ORDERING ", attributeType.getOrderingMatchingRule()); addMatchingRuleIfNotNull(buffer, " SUBSTR ", attributeType.getSubstringMatchingRule()); appendIfNotNull(buffer, " SYNTAX ", attributeType.getSyntax().getOID()); appendIfTrue(buffer, " SINGLE-VALUE", attributeType.isSingleValue()); appendIfTrue(buffer, " COLLECTIVE", attributeType.isCollective()); appendIfTrue(buffer, " NO-USER-MODIFICATION", attributeType.isNoUserModification()); appendIfNotNull(buffer, " USAGE ", attributeType.getUsage()); final MatchingRule approximateMatchingRule = attributeType.getApproximateMatchingRule(); if (approximateMatchingRule != null) { buffer.append(" ").append(ServerConstants.SCHEMA_PROPERTY_APPROX_RULE).append(" '") .append(approximateMatchingRule.getOID()).append("'"); } appendExtraProperties(buffer, attributeType.getExtraProperties()); buffer.append(")"); return buffer.toString(); } private void addMatchingRuleIfNotNull(final StringBuilder buffer, final String label, final MatchingRule matchingRule) { if (matchingRule != null) { append(buffer, label, matchingRule.getOID()); } } private String getObjectClassDefinition(final ObjectClass objectClass, final List names) { final StringBuilder buffer = new StringBuilder(); buffer.append("( "); buffer.append(objectClass.getOID()); appendCollection(buffer, "NAME", names); appendDescription(buffer, objectClass.getDescription()); appendIfTrue(buffer, " OBSOLETE", objectClass.isObsolete()); appendOIDs(buffer, "SUP", objectClass.getSuperiorClasses()); appendIfNotNull(buffer, " ", objectClass.getObjectClassType()); appendOIDs(buffer, "MUST", objectClass.getRequiredAttributes()); appendOIDs(buffer, "MAY", objectClass.getOptionalAttributes()); appendExtraProperties(buffer, objectClass.getExtraProperties()); buffer.append(")"); return buffer.toString(); } private void appendOIDs(final StringBuilder buffer, final String label, final Collection schemaElements) { if (!schemaElements.isEmpty()) { final Iterator iterator = schemaElements.iterator(); final String firstOID = iterator.next().getOID(); buffer.append(" ").append(label).append(" ( ").append(firstOID); while (iterator.hasNext()) { buffer.append(" $ ").append(iterator.next().getOID()); } buffer.append(" )"); } } private void appendIfTrue(final StringBuilder buffer, final String label, final boolean labelIsActive) { if (labelIsActive) { buffer.append(label); } } private void appendIfNotNull(final StringBuilder buffer, final String label, final Object value) { if (value != null) { append(buffer, label, value.toString()); } } private void append(final StringBuilder buffer, final String label, final String value) { buffer.append(label).append(value); } private void appendDescription(final StringBuilder buffer, final String description) { if (description != null && !description.isEmpty()) { buffer.append(" DESC '"); buffer.append(description); buffer.append("'"); } } private void appendExtraProperties( final StringBuilder buffer, final Map> extraProperties) { for (final Map.Entry> e : extraProperties.entrySet()) { appendCollection(buffer, e.getKey(), e.getValue()); } } private void appendCollection(final StringBuilder buffer, final String property, final Collection values) { final Iterator iterator = values.iterator(); final boolean isMultiValued = values.size() > 1; if (iterator.hasNext()) { final String first = iterator.next(); buffer.append(" ").append(property); buffer.append(isMultiValued ? " ( '" : " '").append(first).append("' "); while (iterator.hasNext()) { buffer.append("'").append(iterator.next()).append("' "); } if (isMultiValued) { buffer.append(")"); } } } private void printEquivalentCommandLineToAddOnline(CommonSchemaElements element) { List args = new ArrayList<>(); args.add("-a"); args.addAll(getObfuscatedCommandLineArguments(getConnectionCommandLineArguments(true, true))); args.add(getNoPropertiesFileArgument()); final String equivalentCmdLine = getEquivalentCommandLine(getCommandLinePath("ldapmodify"), args); final String elementID = element.getNameOrOID(); final LocalizableMessage msg = element instanceof AttributeType ? INFO_CTRL_PANEL_EQUIVALENT_CMD_TO_ADD_ATTRIBUTE_ONLINE.get(elementID) : INFO_CTRL_PANEL_EQUIVALENT_CMD_TO_ADD_OBJECTCLASS_ONLINE.get(elementID); final StringBuilder sb = new StringBuilder(); final String attName = getAttributeName(element); sb.append(msg).append("
") .append(equivalentCmdLine).append("
") .append("dn: cn=schema
") .append("changetype: modify
") .append("add: ").append(attName).append("
") .append(attName).append(": ").append(getElementDefinition(element)).append("


"); getProgressDialog().appendProgressHtml(Utilities.applyFont(sb.toString(), ColorAndFontConstants.progressFont)); } private String getAttributeName(CommonSchemaElements element) { return element instanceof AttributeType ? ConfigConstants.ATTR_ATTRIBUTE_TYPES : ConfigConstants.ATTR_OBJECTCLASSES; } private void updateSchemaOffline( String file, final List attributes, final List objectClasses) throws OpenDsException { final List schemaElements = new ArrayList(attributes); schemaElements.addAll(objectClasses); if (file == null) { file = ConfigConstants.FILE_USER_SCHEMA_ELEMENTS; } File f = new File(file); if (!f.isAbsolute()) { f = new File(DirectoryServer.getEnvironmentConfig().getSchemaDirectory(), file); } final String fileName = f.getAbsolutePath(); final boolean isSchemaFileDefined = isSchemaFileDefined(fileName); SwingUtilities.invokeLater(new Runnable() { @Override public void run() { final ProgressDialog progressDialog = getProgressDialog(); final String command = equivalentCommandToAddOffline(fileName, isSchemaFileDefined, schemaElements); progressDialog.appendProgressHtml(Utilities.applyFont(command, ColorAndFontConstants.progressFont)); if (attributes.size() == 1 && objectClasses.isEmpty()) { String attributeName = attributes.get(0).getNameOrOID(); progressDialog.appendProgressHtml(Utilities.getProgressWithPoints( INFO_CTRL_PANEL_CREATING_ATTRIBUTE_PROGRESS.get(attributeName), ColorAndFontConstants.progressFont)); } else if (objectClasses.size() == 1 && attributes.isEmpty()) { String ocName = objectClasses.get(0).getNameOrOID(); progressDialog.appendProgressHtml(Utilities.getProgressWithPoints( INFO_CTRL_PANEL_CREATING_OBJECTCLASS_PROGRESS.get(ocName), ColorAndFontConstants.progressFont)); } else { progressDialog.appendProgressHtml(Utilities.getProgressWithPoints( INFO_CTRL_PANEL_UPDATING_SCHEMA_FILE_PROGRESS.get(fileName), ColorAndFontConstants.progressFont)); } } }); if (isSchemaFileDefined) { updateSchemaFile(fileName, schemaElements); } else { updateSchemaUndefinedFile(fileName, schemaElements); } for (CommonSchemaElements schemaElement : schemaElements) { notifyConfigurationElementCreated(schemaElement); } SwingUtilities.invokeLater(new Runnable() { @Override public void run() { getProgressDialog().appendProgressHtml(Utilities.getProgressDone(ColorAndFontConstants.progressFont)); } }); } private String equivalentCommandToAddOffline( String schemaFile, boolean isSchemaFileDefined, List schemaElements) { List names = getElementsNameOrOID(schemaElements); final String namesString = joinAsString(", ", names); final StringBuilder sb = new StringBuilder(); if (isSchemaFileDefined) { sb.append(INFO_CTRL_PANEL_EQUIVALENT_CMD_TO_ADD_SCHEMA_ELEMENT_OFFLINE.get(namesString, schemaFile)) .append("
"); } else { sb.append(INFO_CTRL_PANEL_EQUIVALENT_CMD_TO_ADD_SCHEMA_ENTRY_OFFLINE.get(namesString, schemaFile)) .append("
"); for (String line : getSchemaEntryLines()) { sb.append(line); sb.append("
"); } } for (CommonSchemaElements schemaElement : schemaElements) { sb.append(getAttributeName(schemaElement)).append(": ").append(getValueOffline(schemaElement)).append("
"); } sb.append("


"); return sb.toString(); } /** * Returns whether the file defined in the schema element exists or not. * * @param schemaFile * the path to the schema file. * @return true if the schema file is defined and * false otherwise. */ private boolean isSchemaFileDefined(String schemaFile) { try (LDIFReader reader = new LDIFReader(new LDIFImportConfig(schemaFile))) { return reader.readEntry() != null; } catch (Throwable t) { return false; } } /** * Returns the list of LDIF lines that are enough to create the entry * containing only the schema element associated with this task. * * @return the list of LDIF lines that are enough to create the entry * containing only the schema element associated with this task. */ private List getSchemaEntryLines() { List lines = new ArrayList<>(); lines.add("dn: cn=schema"); lines.add("objectClass: top"); lines.add("objectClass: ldapSubentry"); lines.add("objectClass: subschema"); return lines; } /** * Updates the contents of the schema file. * * @param schemaFile * the schema file. * @param isSchemaFileDefined * whether the schema is defined or not. * @param attributes * the attributes to add. * @param objectClasses * the object classes to add. * @throws OpenDsException * if an error occurs updating the schema file. */ private void updateSchemaFile(String schemaFile, List schemaElements) throws OpenDsException { try (final LDIFExportConfig exportConfig = new LDIFExportConfig(schemaFile, ExistingFileBehavior.OVERWRITE)) { try (final LDIFReader reader = new LDIFReader(new LDIFImportConfig(schemaFile))) { final Entry schemaEntry = reader.readEntry(); addElementsToEntry(schemaElements, schemaEntry); try (final LDIFWriter writer = new LDIFWriter(exportConfig)) { writer.writeEntry(schemaEntry); exportConfig.getWriter().newLine(); } } catch (Throwable t) { throw new OfflineUpdateException(ERR_CTRL_PANEL_ERROR_UPDATING_SCHEMA.get(t), t); } } } private void addElementsToEntry(List schemaElements, Entry schemaEntry) throws DirectoryException { for (CommonSchemaElements schemaElement : schemaElements) { final Modification mod = new Modification(ModificationType.ADD, Attributes.create(getAttributeName(schemaElement).toLowerCase(), getValueOffline(schemaElement))); schemaEntry.applyModification(mod); } } private void updateSchemaUndefinedFile(String schemaFile, List schemaElements) throws OfflineUpdateException { try (LDIFExportConfig exportConfig = new LDIFExportConfig(schemaFile, ExistingFileBehavior.FAIL)) { List lines = getSchemaEntryLines(); for (final CommonSchemaElements schemaElement : schemaElements) { lines.add(getAttributeName(schemaElement) + ": " + getValueOffline(schemaElement)); } for (String line : lines) { final boolean wrapLines = exportConfig.getWrapColumn() > 1; LDIFWriter.writeLDIFLine( new StringBuilder(line), exportConfig.getWriter(), wrapLines, exportConfig.getWrapColumn()); } exportConfig.getWriter().newLine(); } catch (Throwable t) { throw new OfflineUpdateException(ERR_CTRL_PANEL_ERROR_UPDATING_SCHEMA.get(t), t); } } }