-
Notifications
You must be signed in to change notification settings - Fork 7
Making it harder to delete all rows from lists #7471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
XingY
wants to merge
4
commits into
release26.3-SNAPSHOT
Choose a base branch
from
26.3_fb_truncateList
base: release26.3-SNAPSHOT
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,6 +51,7 @@ | |
| import org.labkey.api.data.ContainerFilter; | ||
| import org.labkey.api.data.ContainerManager; | ||
| import org.labkey.api.data.DataRegionSelection; | ||
| import org.labkey.api.data.DbScope; | ||
| import org.labkey.api.data.SQLFragment; | ||
| import org.labkey.api.data.SimpleFilter; | ||
| import org.labkey.api.data.TableInfo; | ||
|
|
@@ -116,6 +117,7 @@ | |
| import org.labkey.list.model.ListDomainKindProperties; | ||
| import org.labkey.list.model.ListManager; | ||
| import org.labkey.list.model.ListManagerSchema; | ||
| import org.labkey.list.model.ListSchema; | ||
| import org.labkey.list.model.ListWriter; | ||
| import org.labkey.list.view.ListDefinitionForm; | ||
| import org.labkey.list.view.ListItemAttachmentParent; | ||
|
|
@@ -425,6 +427,103 @@ public List<Pair<Integer, Container>> getListContainerMap() | |
| } | ||
| } | ||
|
|
||
| @RequiresPermission(AdminPermission.class) | ||
| public static class TruncateListDataAction extends ConfirmAction<ListDeletionForm> | ||
| { | ||
|
Comment on lines
+430
to
+432
|
||
| private boolean canTruncate(Container listContainer, int listId) | ||
| { | ||
| ListDef listDef = ListManager.get().getList(listContainer, listId); | ||
| ListDefinitionImpl list = ListDefinitionImpl.of(listDef); | ||
|
|
||
| if (list == null || !list.getAllowDelete()) | ||
| return false; | ||
|
|
||
| return list.getContainer().hasPermission(getUser(), AdminPermission.class); | ||
| } | ||
|
|
||
| @Override | ||
| public String getConfirmText() | ||
| { | ||
| return "Confirm Delete All Data"; | ||
| } | ||
|
|
||
| @Override | ||
| public void validateCommand(ListDeletionForm form, Errors errors) | ||
| { | ||
| Container currentContainer = getContainer(); | ||
| List<String> errorMessages = new ArrayList<>(); | ||
| Collection<String> listIDs; | ||
| if (form.getListIds() != null) | ||
| listIDs = form.getListIds(); | ||
| else | ||
| listIDs = DataRegionSelection.getSelected(form.getViewContext(), true); | ||
|
|
||
| for (Pair<Integer, Container> pair : getListIdContainerPairs(listIDs, currentContainer, errorMessages)) | ||
| { | ||
| var listId = pair.first; | ||
| var listContainer = pair.second; | ||
|
|
||
| if (canTruncate(listContainer, listId)) | ||
| { | ||
| form.getListContainerMap().add(pair); | ||
| } | ||
| else | ||
| errorMessages.add(String.format("You do not have permission to delete data for list %s in container %s", listId, listContainer.getName())); | ||
| } | ||
|
|
||
| if (!errorMessages.isEmpty()) | ||
| errors.reject(ERROR_MSG, StringUtils.join(errorMessages, "\n")); | ||
|
|
||
| if (form.getListContainerMap().isEmpty()) | ||
| errors.reject(ERROR_MSG, "You must specify a list or lists to delete data from."); | ||
| } | ||
|
|
||
| @Override | ||
| public ModelAndView getConfirmView(ListDeletionForm form, BindException errors) | ||
| { | ||
| if (getPageConfig().getTitle() == null) | ||
| setTitle("Confirm Delete All Data"); | ||
| return new JspView<>("/org/labkey/list/view/truncateListData.jsp", form, errors); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean handlePost(ListDeletionForm form, BindException errors) | ||
| { | ||
| Container containerDataToDelete = getContainer(); | ||
| try (DbScope.Transaction transaction = ListSchema.getInstance().getSchema().getScope().ensureTransaction()) | ||
| { | ||
| for (Pair<Integer, Container> pair : form.getListContainerMap()) | ||
| { | ||
| Container listDefContainer = pair.second; | ||
| ListDefinition listDef = ListService.get().getList(listDefContainer, pair.first); | ||
| if (null != listDef) | ||
| { | ||
| try | ||
| { | ||
| TableInfo table = listDef.getTable(getUser(), listDefContainer); | ||
| if (table != null && table.getUpdateService() != null) | ||
| table.getUpdateService().truncateRows(getUser(), containerDataToDelete, null, null); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| errors.reject(ERROR_MSG, "Error deleting data from list '" + listDef.getName() + "': " + e.getMessage()); | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| transaction.commit(); | ||
| } | ||
|
|
||
| return !errors.hasErrors(); | ||
| } | ||
|
|
||
| @Override @NotNull | ||
| public URLHelper getSuccessURL(ListDeletionForm form) | ||
| { | ||
| return form.getReturnUrlHelper(getBeginURL(getContainer())); | ||
| } | ||
| } | ||
|
|
||
| @RequiresPermission(ReadPermission.class) | ||
| public class GridAction extends SimpleViewAction<ListQueryForm> | ||
|
|
@@ -958,10 +1057,11 @@ public Pair<AttachmentParent, String> getAttachment(ListAttachmentForm form) | |
| if (listDef == null) | ||
| throw new NotFoundException("List does not exist in this container"); | ||
|
|
||
| if (!listDef.hasListItemForEntityId(form.getEntityId(), getUser())) | ||
| Container dataContainer = listDef.getListItemContainerForDownload(form.getEntityId(), getUser(), ReadPermission.class); | ||
| if (dataContainer == null) | ||
| throw new NotFoundException("List does not have an item for the entityid"); | ||
|
|
||
| AttachmentParent parent = new ListItemAttachmentParent(form.getEntityId(), getContainer()); | ||
| AttachmentParent parent = new ListItemAttachmentParent(form.getEntityId(), dataContainer); | ||
|
|
||
| return new Pair<>(parent, form.getName()); | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,70 @@ | ||||||
| <% | ||||||
| /* | ||||||
| * Copyright (c) 2009-2016 LabKey Corporation | ||||||
| * | ||||||
| * Licensed 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. | ||||||
| */ | ||||||
| %> | ||||||
| <%@ page import="org.labkey.api.data.Container" %> | ||||||
| <%@ page import="org.labkey.api.data.TableInfo" %> | ||||||
| <%@ page import="org.labkey.api.data.TableSelector" %> | ||||||
| <%@ page import="org.labkey.api.exp.list.ListDefinition" %> | ||||||
| <%@ page import="org.labkey.api.exp.list.ListService" %> | ||||||
| <%@ page import="org.labkey.list.controllers.ListController" %> | ||||||
| <%@ page import="java.util.ArrayList" %> | ||||||
| <%@ page import="java.util.HashMap" %> | ||||||
| <%@ page import="java.util.List" %> | ||||||
| <%@ page import="java.util.Map" %> | ||||||
| <%@ page import="java.util.Objects" %> | ||||||
| <%@ page import="org.labkey.list.model.ListQuerySchema" %> | ||||||
| <%@ page import="org.labkey.api.security.User" %> | ||||||
| <%@ page extends="org.labkey.api.jsp.FormPage" %> | ||||||
| <%@ taglib prefix="labkey" uri="http://www.labkey.org/taglib"%> | ||||||
| <% | ||||||
| ListController.ListDeletionForm form = (ListController.ListDeletionForm)getModelBean(); | ||||||
| Map<Container, List<ListDefinition>> definitions = new HashMap<>(); | ||||||
| Container currentContainer = form.getContainer(); | ||||||
| String currentPath = currentContainer.getPath(); | ||||||
| User user = form.getUser(); | ||||||
| ListQuerySchema listQuerySchema = new ListQuerySchema(user, currentContainer); | ||||||
|
|
||||||
| form.getListContainerMap() | ||||||
| .stream() | ||||||
| .map(pair -> ListService.get().getList(pair.second, pair.first)) | ||||||
| .filter(Objects::nonNull) | ||||||
| .forEach(listDef -> { | ||||||
| var container = listDef.getContainer(); | ||||||
| if (!definitions.containsKey(container)) | ||||||
| definitions.put(container, new ArrayList<>()); | ||||||
| definitions.get(container).add(listDef); | ||||||
| }); | ||||||
| %> | ||||||
| <labkey:errors></labkey:errors> | ||||||
| <p>Are you sure you want to delete all data in <%= h(currentPath) %> from the following Lists? This action cannot be undone and will result in an empty list.</p> | ||||||
|
||||||
| <p>Are you sure you want to delete all data in <%= h(currentPath) %> from the following Lists? This action cannot be undone and will result in an empty list.</p> | |
| <p>Are you sure you want to delete all data in <%= h(currentPath) %> from the following Lists? This action cannot be undone and will delete all rows for these lists in the folder/container path shown, but will not affect rows in other folders/containers.</p> |
Comment on lines
+60
to
+62
Copilot
AI
Mar 3, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Row counts are computed via listQuerySchema.getTable(listDef.getName()), which resolves the list by name in the current container. If multiple selected lists share the same name but are defined in different containers, the displayed count can be for the wrong list. Consider deriving the TableInfo from the selected ListDefinition (e.g., use the list’s definition container to resolve the correct list, and apply an explicit container filter for the current container when counting rows).
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This removes the public QueryView.createDeleteAllRowsButton() method from the API module. Even though there are no in-repo references, this is a binary/source breaking change for external modules that compile against the LabKey API. Consider keeping the method (deprecated) and altering its behavior/visibility, or providing a compatible replacement path so downstream modules don’t break on upgrade.