Changeset 7599

Timestamp:

Feb 22, 2019, 9:54:51 AM (5 years ago)

Author:

Nicklas Nordborg

Message:

References #2150: Batch item importers in item list members view

The add/remove members modes should now work. Some more testing is probably need to check more combinations.

Location:

trunk/src

Files:

• core/net/sf/basedb/core/ItemList.java (modified) (2 diffs)
• plugins/core/net/sf/basedb/plugins/batchimport/AbstractItemImporter.java (modified) (12 diffs)
• test/TestItemList.java (modified) (1 diff)

trunk/src/core/net/sf/basedb/core/ItemList.java

@@ -562 +562 @@
       write permission
     @throws InvalidDataException If the item is null
-  */
-  public void remove(Listable item)
+    @since 3.15
+  */
+  public boolean removeItem(Listable item)
     throws PermissionDeniedException, InvalidDataException
   {
@@ -572 +573 @@
     boolean removed = item.getId() == 0 ? delayedRemove(item) : getData().getMembers().remove(item.getId());
     if (removed) getData().setSize(getData().getSize()-1);
+    return removed;
+  }
+  
+  /**
+    Remove multiple items from this list in one go.
+    @param it An iterator that returns all items to be removed,
+      null items are ignored
+    @return The numer of removed items
+    @throws PermissionDeniedException If the logged in user doesn't have 
+      write permission
+    @throws InvalidDataException If the iterator returns an item
+      of a different type than {@link #getMemberType()}
+    @since 3.15
+  */
+  public int removeItems(Iterator<? extends Listable> it)
+    throws PermissionDeniedException, InvalidDataException
+  {
+    checkPermission(Permission.WRITE);
+    checkManualMembersAllowed();
+    if (it == null) return 0;
+    int removed = 0;
+    Set<Integer> members = getData().getMembers();
+    while (it.hasNext())
+    {
+      Listable item = it.next();
+            
+      if (item == null)
+      {
+        /* #### CONTINUE-STATEMENT #### */
+        continue;
+      }
+      
+      checkMemberType(item.getType());
+      if (item.getId() == 0)
+      {
+        if (delayedRemove(item)) removed++;
+      }
+      else
+      {
+        if (members.remove(item.getId())) removed++;
+      }
+    }
+    getData().setSize(getSize() - removed);
+    return removed;
+  }
+
+  
+  /**
+    Remove an item from the list.
+    @param item The item to remove.
+    @throws PermissionDeniedException If the logged in user doesn't have
+      write permission
+    @throws InvalidDataException If the item is null
+    @deprecated In 3.15, use {@link #removeItem(Listable item)} instead
+  */
+  @Deprecated
+  public void remove(Listable item)
+    throws PermissionDeniedException, InvalidDataException
+  {
+    removeItem(item);
+  }
+  
+  /**
+    Check if the given item is a member of this list.
+    @since 3.15
+  */
+  public boolean isMember(Listable item)
+  {
+    if (item == null || item.getType() != getMemberType()) return false;
+    if (item.getId() == 0)
+    {
+      return delayed == null ? false : delayed.queue().contains(item);
+    }
+    else
+    {
+      return getData().getMembers().contains(item.getId());
+    }
   }
   

trunk/src/plugins/core/net/sf/basedb/plugins/batchimport/AbstractItemImporter.java

@@ -71 +71 @@
 import net.sf.basedb.core.Job;
 import net.sf.basedb.core.Kit;
+import net.sf.basedb.core.Listable;
 import net.sf.basedb.core.NumberOutOfRangeException;
 import net.sf.basedb.core.Permission;
@@ -478 +479 @@
 
         File file = (File)job.getValue("file");
-        response.setSuggestedJobName("Import " + context.getItem().toString().toLowerCase() 
-            + " items from file '" + file.getName() + "'");
+        ItemList list = (ItemList)job.getValue("itemList");
+        String mode = (String)job.getValue("mode");
+        String itemTypes = context.getItem().toString().toLowerCase();
+        String jobName = "";
+        if (list != null)
+        {
+          if (mode != null && mode.contains("add"))
+          {
+            jobName = "Add members to list '"+list.getName()+"' from file '"+file.getName() + "'";
+          }
+          else if (mode != null && mode.contains("remove"))
+          {
+            jobName = "Remove members from list '"+list.getName()+"' using file '"+file.getName() + "'";
+          }
+          else
+          {
+            jobName = "Update members of list '"+list.getName()+"' from file '"+file.getName() + "'";
+          }
+        }
+        else
+        {
+          if (mode != null && mode.contains("create") && mode.contains("update"))
+          {
+            jobName = "Create and update " + itemTypes + " items from file '"+file.getName() + "'";
+          }
+          else if (mode != null && mode.contains("create"))
+          {
+            jobName = "Create " + itemTypes + " items from file '"+file.getName() + "' (no update)";
+          }
+          else
+          {
+            jobName = "Update " + itemTypes + " items from file '"+file.getName() + "' (no create)";
+          }
+        }
+        response.setSuggestedJobName(jobName);
         
         // Save context info
@@ -532 +566 @@
   private ItemQuery<I> itemQuery;
   private ItemList itemList;
-
+  boolean updateMode;
+  boolean createMode;
+  boolean addMembersMode;
+  boolean removeMembersMode;
+  
   private String lastIdentifier;
   private I lastItem;
@@ -590 +628 @@
     this.idMethod = getIdMethod(dc, (String)job.getValue("idMethod"));
     this.idMapping = (String)job.getValue(idMethod.getColumnMappingParameterName());
-    this.itemList = (ItemList)job.getValue("memberOfList");
+    this.itemList = (ItemList)job.getValue("itemList");
+    if (itemList != null) itemList = ItemList.getById(dc, itemList.getId());
     this.itemCache = new HashMap<String, BasicItem>();
     String mode = (String)job.getValue("mode");
-    boolean updateMode = mode == null || mode.contains("update");
-    boolean createMode = (mode == null || mode.contains("create")) && itemList == null;
+    this.updateMode = mode == null || mode.contains("update");
+    this.createMode = (mode == null || mode.contains("create")) && itemList == null;
+    this.removeMembersMode = mode != null && mode.contains("remove-members") && itemList != null;
+    this.addMembersMode = mode != null && mode.contains("add-members") && itemList != null;
     
     // Error handling, we don't use the error handling in AbstractFlatFileImporter
@@ -601 +642 @@
     this.failIfNotFoundItems = !createMode && "fail".equals(getErrorOption("itemNotFoundError"));
     this.updateExistingItems = updateMode;
-    this.failIfItemExists = !updateMode && "fail".equals(getErrorOption("itemExistsError"));
+    this.failIfItemExists = createMode && "fail".equals(getErrorOption("itemExistsError"));
     this.failIfMultipleFoundItems = "fail".equals(getErrorOption("multipleItemsFoundError"));
     this.failIfNotFoundReference = "fail".equals(getErrorOption("referenceNotFoundError"));
@@ -647 +688 @@
     if (Boolean.TRUE.equals((Boolean)job.getValue("includeInProject"))) includes.add(Include.IN_PROJECT);
     if (Boolean.TRUE.equals((Boolean)job.getValue("includeOthers"))) includes.add(Include.OTHERS);
-    itemQuery = idMethod.prepareQuery(dc, createItemQuery(itemList));
+    itemQuery = idMethod.prepareQuery(dc, addMembersMode ? createItemQuery() : createItemQuery(itemList));
     itemQuery.setIncludes(includes);
     
@@ -847 +888 @@
         }
       }
+      else if (addMembersMode)
+      {
+        boolean added = itemList.add((Listable)item);
+        if (added) 
+        {
+          log("Added to list: " + idMethod + "=" + identifier, data);
+          numUpdated++;
+        }
+        else
+        {
+          log("Already member: " + idMethod + "=" + identifier, data);
+          numExisted++;
+        }
+      }
+      else if (removeMembersMode)
+      {
+        boolean removed = itemList.removeItem((Listable)item);
+        if (removed)
+        {
+          log("Removed from list: " + idMethod + "=" + identifier, data);
+          numUpdated++;
+        }
+        else
+        {
+          log("Not member: " + idMethod + "=" + identifier, data);
+          numExisted++;
+        }
+      }
       else
       {
@@ -884 +953 @@
   {
     String msg = "Parsed " + ffp.getParsedLines() + " lines";
-    if (numCreated > 0) msg += "; " + numCreated + " items created";
-    if (numUpdated > 0) msg += "; " + numUpdated + " items updated";
-    if (numExisted > 0) msg += "; " + numExisted + " items skipped because the already exists";
+    if (addMembersMode)
+    {
+      if (numUpdated > 0) msg += "; " + numUpdated + " items added to list";
+      if (numExisted > 0) msg += "; " + numExisted + " items were already members";
+    }
+    else if (removeMembersMode)
+    {
+      if (numUpdated > 0) msg += "; " + numUpdated + " items removed from list";
+      if (numExisted > 0) msg += "; " + numExisted + " items were not members";
+    }
+    else
+    {
+      if (numCreated > 0) msg += "; " + numCreated + " items created";
+      if (numUpdated > 0) msg += "; " + numUpdated + " items updated";
+      if (numExisted > 0) msg += "; " + numExisted + " items skipped because the already exists";
+    }
     if (numError > 0) msg += "; " + numError + " items skipped because of invalid values";
     if (numNotFound > 0) msg += "; " + numNotFound + " items skipped because they could not be found";
@@ -2424 +2506 @@
         List<String> allowedModes = new ArrayList<String>();
         String defaultMode = "update";
+
         if (list != null)
         {
           allowedModes.add(null); // To force the user to manually select a mode (BASE will auto-select the first option)
-          allowedModes.add("add-members");
-          allowedModes.add("remove-members");
-          defaultMode = null;
+          if (list.hasPermission(Permission.WRITE) && !list.getDisableManualMembers())
+          {
+            allowedModes.add("add-members");
+            allowedModes.add("remove-members");
+            defaultMode = null;
+          }
         }
         else if (context == null || sc.hasPermission(Permission.CREATE, context.getItem()))
@@ -2488 +2574 @@
         {
           parameters.add(new PluginParameter<ItemList>(
-            "memberOfList", "Member of list",
-            "In 'update' mode the plug-in will only update values for items if they are members of this list.",
+            "itemList", "Item list",
+            "The plug-in can either <b>add</b> or <b>remove</b> members to/from the list without updating them, " +
+            "or <b>update</b> values for items that are members of this list.",
             new ItemParameterType<>(ItemList.class, list, true, 1, Arrays.asList(list))
           ));
@@ -2621 +2708 @@
 
       String mode = (String)job.getValue("mode");
-      ItemList itemList = (ItemList)job.getValue("memberOfList");
+      ItemList itemList = (ItemList)job.getValue("itemList");
       boolean updateMode = mode == null || mode.contains("update");
-      boolean createMode = (mode == null || mode.contains("create")) && itemList == null;;
+      boolean createMode = (mode == null || mode.contains("create")) && itemList == null;
+      boolean membersMode = itemList != null && mode != null && mode.contains("members"); // 'add-members' or 'remove-members'
       
       // Error handling options
@@ -2634 +2722 @@
       parameters.add(multipleItemsFoundErrorParameter);
       if (updateMode) parameters.add(noWritePermissionToItemErrorParameter);
-      parameters.add(referenceNotFoundErrorParameter);
-      parameters.add(noUsePermissionToReferenceErrorParameter);
-      parameters.add(multipleReferencesFoundErrorParameter);
-      parameters.add(Parameters.invalidUseOfNullError(null, null, null));
-      parameters.add(stringTooLongErrorParameter);
-      parameters.add(numberFormatErrorParameter);
-      parameters.add(numberOutOfRangeErrorParameter);
-      addMoreErrorParameters(parameters);
+      if (updateMode || createMode)
+      {
+        parameters.add(referenceNotFoundErrorParameter);
+        parameters.add(noUsePermissionToReferenceErrorParameter);
+        parameters.add(multipleReferencesFoundErrorParameter);
+        parameters.add(Parameters.invalidUseOfNullError(null, null, null));
+        parameters.add(stringTooLongErrorParameter);
+        parameters.add(numberFormatErrorParameter);
+        parameters.add(numberOutOfRangeErrorParameter);
+        addMoreErrorParameters(parameters);
+      }
       
       configureOptions = new RequestInformation

trunk/src/test/TestItemList.java

@@ -341 +341 @@
       {
         Listable bm = (Listable)bl.getMemberType().getById(dc, itemId);
-        bl.remove(bm);
+        bl.removeItem(bm);
       }
       dc.commit();