/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.studio.ldapbrowser.common.actions;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import org.apache.directory.api.ldap.model.schema.AttributeType;
import org.apache.directory.api.ldap.model.schema.ObjectClass;
import org.apache.directory.studio.connection.core.StudioControl;
import org.apache.directory.studio.ldapbrowser.common.dialogs.DeleteDialog;
import org.apache.directory.studio.ldapbrowser.core.BrowserCoreConstants;
import org.apache.directory.studio.ldapbrowser.core.jobs.DeleteEntriesRunnable;
import org.apache.directory.studio.ldapbrowser.core.jobs.StudioBrowserJob;
import org.apache.directory.studio.ldapbrowser.core.model.AttributeHierarchy;
import org.apache.directory.studio.ldapbrowser.core.model.IAttribute;
import org.apache.directory.studio.ldapbrowser.core.model.IBookmark;
import org.apache.directory.studio.ldapbrowser.core.model.IEntry;
import org.apache.directory.studio.ldapbrowser.core.model.IRootDSE;
import org.apache.directory.studio.ldapbrowser.core.model.ISearch;
import org.apache.directory.studio.ldapbrowser.core.model.ISearchResult;
import org.apache.directory.studio.ldapbrowser.core.model.IValue;
import org.apache.directory.studio.ldapbrowser.core.model.schema.Schema;
import org.apache.directory.studio.ldapbrowser.core.model.schema.SchemaUtils;
import org.apache.directory.studio.ldapbrowser.core.utils.CompoundModification;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.osgi.util.NLS;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
/**
* This Action implements the Delete Action. It deletes Connections, Entries, Searches, Bookmarks, Attributes or Values.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class DeleteAction extends BrowserAction
{
/**
* {@inheritDoc}
*/
public String getText()
{
try
{
Collection<IEntry> entries = getEntries();
ISearch[] searches = getSearches();
IBookmark[] bookmarks = getBookmarks();
Collection<IValue> values = getValues();
if ( entries.size() > 0 && searches.length == 0 && bookmarks.length == 0 && values.size() == 0 )
{
return entries.size() > 1 ? Messages.getString( "DeleteAction.DeleteEntries" ) : Messages.getString( "DeleteAction.DeleteEntry" ); //$NON-NLS-1$ //$NON-NLS-2$
}
if ( searches.length > 0 && entries.size() == 0 && bookmarks.length == 0 && values.size() == 0 )
{
return searches.length > 1 ? Messages.getString( "DeleteAction.DeleteSearches" ) : Messages.getString( "DeleteAction.DeleteSearch" ); //$NON-NLS-1$ //$NON-NLS-2$
}
if ( bookmarks.length > 0 && entries.size() == 0 && searches.length == 0 && values.size() == 0 )
{
return bookmarks.length > 1 ? Messages.getString( "DeleteAction.DeleteBookmarks" ) : Messages.getString( "DeleteAction.DeleteBookmark" ); //$NON-NLS-1$ //$NON-NLS-2$
}
if ( values.size() > 0 && entries.size() == 0 && searches.length == 0 && bookmarks.length == 0 )
{
return values.size() > 1 ? Messages.getString( "DeleteAction.DeleteValues" ) : Messages.getString( "DeleteAction.DeleteValue" ); //$NON-NLS-1$ //$NON-NLS-2$
}
}
catch ( Exception e )
{
}
return Messages.getString( "DeleteAction.Delete" ); //$NON-NLS-1$
}
/**
* {@inheritDoc}
*/
public ImageDescriptor getImageDescriptor()
{
return PlatformUI.getWorkbench().getSharedImages().getImageDescriptor( ISharedImages.IMG_TOOL_DELETE );
}
/**
* {@inheritDoc}
*/
public String getCommandId()
{
return IWorkbenchActionDefinitionIds.DELETE;
}
/**
* {@inheritDoc}
*/
public void run()
{
try
{
Collection<IEntry> entries = getEntries();
ISearch[] searches = getSearches();
IBookmark[] bookmarks = getBookmarks();
Collection<IValue> values = getValues();
StringBuffer message = new StringBuffer();
boolean askForTreeDeleteControl = false;
if ( entries.size() > 0 )
{
appendEntriesWarnMessage( message, entries );
if ( entries.iterator().next().getBrowserConnection().getRootDSE()
.isControlSupported( StudioControl.TREEDELETE_CONTROL.getOid() ) )
{
askForTreeDeleteControl = true;
}
}
if ( searches.length > 0 )
{
appendSearchesWarnMessage( message, searches );
}
if ( bookmarks.length > 0 )
{
appendBookmarsWarnMessage( message, bookmarks );
}
if ( values.size() > 0 )
{
boolean emptyValuesOnly = true;
for ( IValue value : values )
{
if ( !value.isEmpty() )
{
emptyValuesOnly = false;
}
}
if ( !emptyValuesOnly )
{
appendValuesWarnMessage( message, values );
}
}
DeleteDialog dialog = new DeleteDialog( getShell(), getText(), message.toString(), askForTreeDeleteControl );
if ( message.length() == 0 || dialog.open() == DeleteDialog.OK )
{
if ( entries.size() > 0 )
{
deleteEntries( entries, dialog.isUseTreeDeleteControl() );
}
if ( searches.length > 0 )
{
deleteSearches( searches );
}
if ( bookmarks.length > 0 )
{
deleteBookmarks( bookmarks );
}
if ( values.size() > 0 )
{
deleteValues( values );
}
}
}
catch ( Exception e )
{
}
}
/**
* {@inheritDoc}
*/
public boolean isEnabled()
{
try
{
Collection<IEntry> entries = getEntries();
ISearch[] searches = getSearches();
IBookmark[] bookmarks = getBookmarks();
Collection<IValue> values = getValues();
return entries.size() + searches.length + bookmarks.length + values.size() > 0;
}
catch ( Exception e )
{
//e.printStackTrace();
return false;
}
}
/**
* Gets the Entries.
*
* @return
* the Entries
* @throws Exception
* when an Entry has parent Entries
*/
protected Collection<IEntry> getEntries()
{
LinkedHashSet<IEntry> entriesSet = new LinkedHashSet<IEntry>();
for ( IEntry entry : getSelectedEntries() )
{
entriesSet.add( entry );
}
for ( ISearchResult sr : getSelectedSearchResults() )
{
entriesSet.add( sr.getEntry() );
}
Iterator<IEntry> iterator = entriesSet.iterator();
while ( iterator.hasNext() )
{
IEntry entry = iterator.next();
if ( entriesSet.contains( entry.getParententry() ) )
{
iterator.remove();
}
}
return entriesSet;
}
/**
* Appends the entries warn message.
*
* @param message the message
* @param entries the entries
*/
protected void appendEntriesWarnMessage( StringBuffer message, Collection<IEntry> entries )
{
for ( IEntry entry : entries )
{
if ( entry instanceof IRootDSE )
{
message.append( Messages.getString( "DeleteAction.DeleteRootDSE" ) ); //$NON-NLS-1$
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
}
if ( entries.size() <= 5 )
{
message.append( entries.size() == 1 ? Messages.getString( "DeleteAction.DeleteEntryQuestion" ) //$NON-NLS-1$
: Messages.getString( "DeleteAction.DeleteEntriesQuestion" ) ); //$NON-NLS-1$
for ( IEntry entry : entries )
{
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( " - " ); //$NON-NLS-1$
message.append( entry.getDn().getName() );
}
}
else
{
message.append( Messages.getString( "DeleteAction.DeleteSelectedEntriesQuestion" ) ); //$NON-NLS-1$
}
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
/**
* Deletes Entries.
*
* @param entries the Entries to delete
* @param useTreeDeleteControl true to use the tree delete control
*/
protected void deleteEntries( Collection<IEntry> entries, boolean useTreeDeleteControl )
{
new StudioBrowserJob( new DeleteEntriesRunnable( entries, useTreeDeleteControl ) ).execute();
}
/**
* Gets the Searches
*
* @return
* the Searches
* @throws Exception
*/
protected ISearch[] getSearches()
{
return getSelectedSearches();
}
protected void appendSearchesWarnMessage( StringBuffer message, ISearch[] searches )
{
if ( searches.length <= 5 )
{
message.append( searches.length == 1 ? Messages.getString( "DeleteAction.DeleteSearchQuestion" ) //$NON-NLS-1$
: Messages.getString( "DeleteAction.DeleteSearchesQuestion" ) ); //$NON-NLS-1$
for ( int i = 0; i < searches.length; i++ )
{
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( " - " ); //$NON-NLS-1$
message.append( searches[i].getName() );
}
}
else
{
message.append( Messages.getString( "DeleteAction.DeleteSelectedSearchesQuestion" ) ); //$NON-NLS-1$
}
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
/**
* Delete Searches
*
* @param searches
* the Searches to delete
*/
protected void deleteSearches( ISearch[] searches )
{
for ( ISearch search : searches )
{
search.getBrowserConnection().getSearchManager().removeSearch( search );
}
}
/**
* Get the Bookmarks
*
* @return
* @throws Exception
*/
protected IBookmark[] getBookmarks()
{
return getSelectedBookmarks();
}
protected void appendBookmarsWarnMessage( StringBuffer message, IBookmark[] bookmarks )
{
if ( bookmarks.length <= 5 )
{
message.append( bookmarks.length == 1 ? Messages.getString( "DeleteAction.DeleteBookmarkQuestion" ) //$NON-NLS-1$
: Messages.getString( "DeleteAction.DeleteBookmarksQuestion" ) ); //$NON-NLS-1$
for ( int i = 0; i < bookmarks.length; i++ )
{
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( " - " ); //$NON-NLS-1$
message.append( bookmarks[i].getName() );
}
}
else
{
message.append( Messages.getString( "DeleteAction.DeleteSelectedBookmarksQuestion" ) ); //$NON-NLS-1$
}
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
/**
* Delete Bookmarks
*
* @param bookmarks
* the Bookmarks to delete
*/
protected void deleteBookmarks( IBookmark[] bookmarks )
{
for ( IBookmark bookmark : bookmarks )
{
bookmark.getBrowserConnection().getBookmarkManager().removeBookmark( bookmark );
}
}
/**
* Gets the Values
*
* @return
* the Values
* @throws Exception
*/
protected Collection<IValue> getValues() throws Exception
{
Set<IValue> valueList = new LinkedHashSet<IValue>();
// add selected attributes
for ( IAttribute attribute : getSelectedAttributes() )
{
if ( attribute != null && attribute.getValueSize() > 0 )
{
valueList.addAll( Arrays.asList( attribute.getValues() ) );
}
}
// add selected hierarchies
for ( AttributeHierarchy ah : getSelectedAttributeHierarchies() )
{
for ( IAttribute attribute : ah )
{
if ( attribute != null && attribute.getValueSize() > 0 )
{
valueList.addAll( Arrays.asList( attribute.getValues() ) );
}
}
}
// add selected values, but not if there attributes are also selected
for ( IValue value : getSelectedValues() )
{
valueList.add( value );
}
return valueList;
}
protected void appendValuesWarnMessage( StringBuffer message, Collection<IValue> values )
{
Map<AttributeType, Integer> attributeNameToSelectedValuesCountMap = new HashMap<AttributeType, Integer>();
Set<ObjectClass> selectedObjectClasses = new HashSet<ObjectClass>();
for ( IValue value : values )
{
String type = value.getAttribute().getType();
AttributeType atd = value.getAttribute().getAttributeTypeDescription();
AttributeHierarchy ah = value.getAttribute().getEntry().getAttributeWithSubtypes( type );
// check if (part of) Rdn is selected
if ( value.isRdnPart() )
{
message.append( NLS.bind( Messages.getString( "DeleteAction.DeletePartOfRDN" ), value.toString() ) ); //$NON-NLS-1$
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
// check if a required objectClass is selected
if ( value.getAttribute().isObjectClassAttribute() )
{
selectedObjectClasses.add( value.getAttribute().getEntry().getBrowserConnection().getSchema()
.getObjectClassDescription( value.getStringValue() ) );
}
// check if ALL values of objectClass or a MUST attribute are selected
if ( !attributeNameToSelectedValuesCountMap.containsKey( atd ) )
{
attributeNameToSelectedValuesCountMap.put( atd, Integer.valueOf( 0 ) );
}
int count = ( attributeNameToSelectedValuesCountMap.get( atd ) ).intValue() + 1;
attributeNameToSelectedValuesCountMap.put( atd, Integer.valueOf( count ) );
if ( value.getAttribute().isObjectClassAttribute() && count >= ah.getValueSize() )
{
message.append( Messages.getString( "DeleteAction.DeleteObjectClass" ) ); //$NON-NLS-1$
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
continue;
}
else if ( value.getAttribute().isMustAttribute() && count >= ah.getValueSize() )
{
message.append( NLS.bind( Messages.getString( "DeleteAction.DeleteMust" ), type ) ); //$NON-NLS-1$
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
// check if a value of an operational attribute is selected
if ( !SchemaUtils.isModifiable( atd ) )
{
message.append( NLS.bind( Messages.getString( "DeleteAction.DeleteNonModifiable" ), type ) ); //$NON-NLS-1$
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
continue;
}
}
// check if a required objectClass is selected
if ( values.size() > 0 && !selectedObjectClasses.isEmpty() )
{
IEntry entry = values.iterator().next().getAttribute().getEntry();
Schema schema = entry.getBrowserConnection().getSchema();
// get remaining attributes
Collection<ObjectClass> remainingObjectClasses = entry.getObjectClassDescriptions();
remainingObjectClasses.removeAll( selectedObjectClasses );
Set<AttributeType> remainingAttributeSet = new HashSet<AttributeType>();
for ( ObjectClass ocd : remainingObjectClasses )
{
{
Collection<String> mustAttrs = SchemaUtils.getMustAttributeTypeDescriptionNamesTransitive( ocd,
schema );
for ( String mustAttr : mustAttrs )
{
AttributeType atd = entry.getBrowserConnection().getSchema()
.getAttributeTypeDescription( mustAttr );
remainingAttributeSet.add( atd );
}
Collection<String> mayAttrs = SchemaUtils.getMayAttributeTypeDescriptionNamesTransitive( ocd,
schema );
for ( String mayAttr : mayAttrs )
{
AttributeType atd = entry.getBrowserConnection().getSchema()
.getAttributeTypeDescription( mayAttr );
remainingAttributeSet.add( atd );
}
}
}
// check against attributes
IAttribute[] attributes = entry.getAttributes();
for ( IAttribute attribute : attributes )
{
if ( attribute.isMayAttribute() || attribute.isMustAttribute() )
{
if ( !remainingAttributeSet.contains( attribute.getAttributeTypeDescription() ) )
{
message.append( NLS.bind(
Messages.getString( "DeleteAction.DeleteNeededObjectClass" ), attribute.getDescription() ) ); //$NON-NLS-1$
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
}
}
}
if ( values.size() <= 5 )
{
message.append( values.size() == 1 ? Messages.getString( "DeleteAction.DeleteAttributeQuestion" ) //$NON-NLS-1$
: Messages.getString( "DeleteAction.DeleteAttributesQuestion" ) ); //$NON-NLS-1$
for ( IValue value : values )
{
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( " - " ); //$NON-NLS-1$
message.append( value.toString() );
}
}
else
{
message.append( Messages.getString( "DeleteAction.DeleteSelectedAttributesQuestion" ) ); //$NON-NLS-1$
}
message.append( BrowserCoreConstants.LINE_SEPARATOR );
message.append( BrowserCoreConstants.LINE_SEPARATOR );
}
/**
* Deletes Attributes and Values
*
* @param values
* the Values to delete
*/
protected void deleteValues( Collection<IValue> values )
{
new CompoundModification().deleteValues( values );
}
}