This is an automated email from the ASF dual-hosted git repository. mraible pushed a commit to branch remove-unused-media-overlay-code in repository https://gitbox.apache.org/repos/asf/roller.git
commit 41b48d86d7711c0c607b1297a952a337d953d91d Author: Matt Raible <[email protected]> AuthorDate: Tue Nov 17 20:03:33 2026 -0700 Remove the overlay mode flag and the external media include page With the overlay mediaFileAdd action gone, nothing reads overlayMode: MediaFileImageChooser was given it but never used it, and MediaFileAdd only runs outside the overlay. The mediaFileAddExternalInclude action, its tile and its JSP aren't linked from any page either, so they go too. --- .../weblogger/ui/struts2/editor/MediaFileAdd.java | 6 +- .../weblogger/ui/struts2/editor/MediaFileBase.java | 492 ++++++++++----------- app/src/main/resources/struts.xml | 9 - .../jsps/editor/MediaFileAddExternalInclude.jsp | 63 --- app/src/main/webapp/WEB-INF/tiles.xml | 5 - .../util/StrutsParameterAnnotationTest.java | 4 +- 6 files changed, 244 insertions(+), 335 deletions(-) diff --git a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileAdd.java b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileAdd.java index c24ca3ce1..8407cf5f5 100644 --- a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileAdd.java +++ b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileAdd.java @@ -253,10 +253,8 @@ public class MediaFileAdd extends MediaFileBase implements UploadedFilesAware { // Files that were saved are listed on the success page, with // any that failed, so a partial upload is never hidden. That - // list replaces the error box; the overlay page has no list. - if (!isOverlayMode()) { - clearActionErrors(); - } + // list replaces the error box. + clearActionErrors(); this.pageTitle = "mediaFileAddSuccess.title"; return result(SUCCESS); diff --git a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileBase.java b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileBase.java index fee12e0e1..1347fd2ab 100644 --- a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileBase.java +++ b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileBase.java @@ -1,67 +1,66 @@ -/* - * 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.roller.weblogger.ui.struts2.editor; - -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.apache.roller.weblogger.WebloggerException; -import org.apache.roller.weblogger.business.MediaFileManager; -import org.apache.roller.weblogger.business.WebloggerFactory; -import org.apache.roller.weblogger.pojos.MediaFile; -import org.apache.roller.weblogger.pojos.MediaFileDirectory; -import org.apache.roller.weblogger.pojos.MediaFileDirectoryComparator; -import org.apache.roller.weblogger.pojos.MediaFileDirectoryComparator.DirectoryComparatorType; -import org.apache.roller.weblogger.pojos.WeblogPermission; -import org.apache.roller.weblogger.ui.struts2.util.UIAction; -import org.apache.struts2.interceptor.parameter.StrutsParameter; - -/** - * Base class for all actions related to media files. - * - */ -@SuppressWarnings("serial") -public class MediaFileBase extends UIAction { - - private static Log log = LogFactory.getLog(MediaFileBase.class); - private String[] selectedMediaFiles; - private String[] selectedMediaFileDirectories; - private String selectedDirectory; - private String mediaFileId; - private List<MediaFileDirectory> allDirectories; - private boolean overlayMode; - - @Override - public List<String> requiredWeblogPermissionActions() { - return Collections.singletonList(WeblogPermission.POST); - } - - /** - * Deletes media file - */ - protected void doDeleteMediaFile() { - - try { - log.debug("Processing delete of file id - " + this.mediaFileId); +/* + * 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.roller.weblogger.ui.struts2.editor; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.roller.weblogger.WebloggerException; +import org.apache.roller.weblogger.business.MediaFileManager; +import org.apache.roller.weblogger.business.WebloggerFactory; +import org.apache.roller.weblogger.pojos.MediaFile; +import org.apache.roller.weblogger.pojos.MediaFileDirectory; +import org.apache.roller.weblogger.pojos.MediaFileDirectoryComparator; +import org.apache.roller.weblogger.pojos.MediaFileDirectoryComparator.DirectoryComparatorType; +import org.apache.roller.weblogger.pojos.WeblogPermission; +import org.apache.roller.weblogger.ui.struts2.util.UIAction; +import org.apache.struts2.interceptor.parameter.StrutsParameter; + +/** + * Base class for all actions related to media files. + * + */ +@SuppressWarnings("serial") +public class MediaFileBase extends UIAction { + + private static Log log = LogFactory.getLog(MediaFileBase.class); + private String[] selectedMediaFiles; + private String[] selectedMediaFileDirectories; + private String selectedDirectory; + private String mediaFileId; + private List<MediaFileDirectory> allDirectories; + + @Override + public List<String> requiredWeblogPermissionActions() { + return Collections.singletonList(WeblogPermission.POST); + } + + /** + * Deletes media file + */ + protected void doDeleteMediaFile() { + + try { + log.debug("Processing delete of file id - " + this.mediaFileId); MediaFileManager manager = WebloggerFactory.getWeblogger() .getMediaFileManager(); MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), this.mediaFileId); @@ -70,24 +69,24 @@ public class MediaFileBase extends UIAction { return; } manager.removeMediaFile(getActionWeblog(), mediaFile); - // flush changes - WebloggerFactory.getWeblogger().flush(); - WebloggerFactory.getWeblogger().release(); - addMessage("mediaFile.delete.success"); - } catch (WebloggerException e) { - log.error("Error deleting media file", e); - addError("mediaFile.delete.error", this.mediaFileId); - } - } - - /** - * Shares media file for public gallery - */ - protected void doIncludeMediaFileInGallery() { - - try { - log.debug("Processing include-in-gallery of file id - " - + this.mediaFileId); + // flush changes + WebloggerFactory.getWeblogger().flush(); + WebloggerFactory.getWeblogger().release(); + addMessage("mediaFile.delete.success"); + } catch (WebloggerException e) { + log.error("Error deleting media file", e); + addError("mediaFile.delete.error", this.mediaFileId); + } + } + + /** + * Shares media file for public gallery + */ + protected void doIncludeMediaFileInGallery() { + + try { + log.debug("Processing include-in-gallery of file id - " + + this.mediaFileId); MediaFileManager manager = WebloggerFactory.getWeblogger() .getMediaFileManager(); MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), this.mediaFileId); @@ -96,66 +95,66 @@ public class MediaFileBase extends UIAction { return; } mediaFile.setSharedForGallery(true); - manager.updateMediaFile(getActionWeblog(), mediaFile); - // flush changes - WebloggerFactory.getWeblogger().flush(); - addMessage("mediaFile.includeInGallery.success"); - } catch (WebloggerException e) { - log.error("Error including media file in gallery", e); - addError("mediaFile.includeInGallery.error", this.mediaFileId); - } - } - - /** - * Delete selected media files. - */ - protected void doDeleteSelected() { - String[] fileIds = getSelectedMediaFiles(); - String[] dirIds = getSelectedMediaFileDirectories(); - try { - MediaFileManager manager = WebloggerFactory.getWeblogger() - .getMediaFileManager(); - - if (fileIds != null && fileIds.length > 0) { - log.debug("Processing delete of " + fileIds.length - + " media files."); - for (String fileId : fileIds) { - log.debug("Deleting media file - " + fileId); - MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), fileId); - if (mediaFile != null) { - manager.removeMediaFile(getActionWeblog(), mediaFile); - } - } - } - - WebloggerFactory.getWeblogger().getWeblogManager() - .saveWeblog(this.getActionWeblog()); - - // flush changes - WebloggerFactory.getWeblogger().flush(); - WebloggerFactory.getWeblogger().release(); - addMessage("mediaFile.delete.success"); - - } catch (WebloggerException e) { - log.error("Error deleting selected media files", e); - addError("mediaFile.delete.error"); - } - } - - /** - * Move selected media files to a directory. - */ - void doMoveSelected() { - String[] fileIds = getSelectedMediaFiles(); - String[] dirIds = getSelectedMediaFileDirectories(); - try { - int movedFiles = 0; - MediaFileManager manager = WebloggerFactory.getWeblogger() - .getMediaFileManager(); - - if (fileIds != null && fileIds.length > 0) { - log.debug("Processing move of " + fileIds.length - + " media files."); + manager.updateMediaFile(getActionWeblog(), mediaFile); + // flush changes + WebloggerFactory.getWeblogger().flush(); + addMessage("mediaFile.includeInGallery.success"); + } catch (WebloggerException e) { + log.error("Error including media file in gallery", e); + addError("mediaFile.includeInGallery.error", this.mediaFileId); + } + } + + /** + * Delete selected media files. + */ + protected void doDeleteSelected() { + String[] fileIds = getSelectedMediaFiles(); + String[] dirIds = getSelectedMediaFileDirectories(); + try { + MediaFileManager manager = WebloggerFactory.getWeblogger() + .getMediaFileManager(); + + if (fileIds != null && fileIds.length > 0) { + log.debug("Processing delete of " + fileIds.length + + " media files."); + for (String fileId : fileIds) { + log.debug("Deleting media file - " + fileId); + MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), fileId); + if (mediaFile != null) { + manager.removeMediaFile(getActionWeblog(), mediaFile); + } + } + } + + WebloggerFactory.getWeblogger().getWeblogManager() + .saveWeblog(this.getActionWeblog()); + + // flush changes + WebloggerFactory.getWeblogger().flush(); + WebloggerFactory.getWeblogger().release(); + addMessage("mediaFile.delete.success"); + + } catch (WebloggerException e) { + log.error("Error deleting selected media files", e); + addError("mediaFile.delete.error"); + } + } + + /** + * Move selected media files to a directory. + */ + void doMoveSelected() { + String[] fileIds = getSelectedMediaFiles(); + String[] dirIds = getSelectedMediaFileDirectories(); + try { + int movedFiles = 0; + MediaFileManager manager = WebloggerFactory.getWeblogger() + .getMediaFileManager(); + + if (fileIds != null && fileIds.length > 0) { + log.debug("Processing move of " + fileIds.length + + " media files."); MediaFileDirectory targetDirectory = manager .getMediaFileDirectory(getActionWeblog(), this.selectedDirectory); if (targetDirectory == null) { @@ -178,112 +177,103 @@ public class MediaFileBase extends UIAction { manager.moveMediaFile(mediaFile, targetDirectory); movedFiles++; } - } - } - - // flush changes - WebloggerFactory.getWeblogger().flush(); - WebloggerFactory.getWeblogger().release(); - if (movedFiles > 0) { - addMessage("mediaFile.move.success"); - } - - } catch (WebloggerException e) { - log.error("Error moving selected media files", e); - addError("mediaFile.move.errors"); - } - } - - /** - * Refresh the list of directories. - */ - void refreshAllDirectories() { - try { - MediaFileManager mgr = WebloggerFactory.getWeblogger().getMediaFileManager(); - - List<MediaFileDirectory> directories = mgr.getMediaFileDirectories(getActionWeblog()); - List<MediaFileDirectory> sortedDirList = new ArrayList<>(directories); - sortedDirList.sort(new MediaFileDirectoryComparator(DirectoryComparatorType.NAME)); - - setAllDirectories(sortedDirList); - - } catch (WebloggerException ex) { - log.error("Error looking up media file directories", ex); - } - } - - /** Size for display, see {@link MediaFileDisplay#formatSize(long)}. */ - public String formatSize(long bytes) { - return MediaFileDisplay.formatSize(bytes); - } - - /** File type for display, see {@link MediaFileDisplay#formatType(String, String)}. */ - public String formatType(String contentType, String fileName) { - return MediaFileDisplay.formatType(contentType, fileName); - } - - /** Icon class for a file without a thumbnail. */ - public String typeIcon(String contentType) { - return MediaFileDisplay.typeIcon(contentType); - } - - public String[] getSelectedMediaFiles() { - return selectedMediaFiles; - } - - @StrutsParameter - public void setSelectedMediaFiles(String[] selectedMediaFiles) { - this.selectedMediaFiles = selectedMediaFiles; - } - - public String getSelectedDirectory() { - return selectedDirectory; - } - - @StrutsParameter - public void setSelectedDirectory(String selectedDirectory) { - this.selectedDirectory = selectedDirectory; - } - - public List<MediaFileDirectory> getAllDirectories() { - return allDirectories; - } - - public void setAllDirectories(List<MediaFileDirectory> allDirectories) { - this.allDirectories = allDirectories; - } - - public String getMediaFileId() { - return mediaFileId; - } - - @StrutsParameter - public void setMediaFileId(String mediaFileId) { - this.mediaFileId = mediaFileId; - } - - public boolean isOverlayMode() { - return overlayMode; - - } - - public void setOverlayMode(boolean mode) { - this.overlayMode = mode; - } - - /** - * @return the selectedMediaFileDirectories - */ - public String[] getSelectedMediaFileDirectories() { - return selectedMediaFileDirectories; - } - - /** - * @param selectedMediaFileDirectories - * the selectedMediaFileDirectories to set - */ - public void setSelectedMediaFileDirectories( - String[] selectedMediaFileDirectories) { - this.selectedMediaFileDirectories = selectedMediaFileDirectories; - } -} + } + } + + // flush changes + WebloggerFactory.getWeblogger().flush(); + WebloggerFactory.getWeblogger().release(); + if (movedFiles > 0) { + addMessage("mediaFile.move.success"); + } + + } catch (WebloggerException e) { + log.error("Error moving selected media files", e); + addError("mediaFile.move.errors"); + } + } + + /** + * Refresh the list of directories. + */ + void refreshAllDirectories() { + try { + MediaFileManager mgr = WebloggerFactory.getWeblogger().getMediaFileManager(); + + List<MediaFileDirectory> directories = mgr.getMediaFileDirectories(getActionWeblog()); + List<MediaFileDirectory> sortedDirList = new ArrayList<>(directories); + sortedDirList.sort(new MediaFileDirectoryComparator(DirectoryComparatorType.NAME)); + + setAllDirectories(sortedDirList); + + } catch (WebloggerException ex) { + log.error("Error looking up media file directories", ex); + } + } + + /** Size for display, see {@link MediaFileDisplay#formatSize(long)}. */ + public String formatSize(long bytes) { + return MediaFileDisplay.formatSize(bytes); + } + + /** File type for display, see {@link MediaFileDisplay#formatType(String, String)}. */ + public String formatType(String contentType, String fileName) { + return MediaFileDisplay.formatType(contentType, fileName); + } + + /** Icon class for a file without a thumbnail. */ + public String typeIcon(String contentType) { + return MediaFileDisplay.typeIcon(contentType); + } + + public String[] getSelectedMediaFiles() { + return selectedMediaFiles; + } + + @StrutsParameter + public void setSelectedMediaFiles(String[] selectedMediaFiles) { + this.selectedMediaFiles = selectedMediaFiles; + } + + public String getSelectedDirectory() { + return selectedDirectory; + } + + @StrutsParameter + public void setSelectedDirectory(String selectedDirectory) { + this.selectedDirectory = selectedDirectory; + } + + public List<MediaFileDirectory> getAllDirectories() { + return allDirectories; + } + + public void setAllDirectories(List<MediaFileDirectory> allDirectories) { + this.allDirectories = allDirectories; + } + + public String getMediaFileId() { + return mediaFileId; + } + + @StrutsParameter + public void setMediaFileId(String mediaFileId) { + this.mediaFileId = mediaFileId; + } + + /** + * @return the selectedMediaFileDirectories + */ + public String[] getSelectedMediaFileDirectories() { + return selectedMediaFileDirectories; + } + + /** + * @param selectedMediaFileDirectories + * the selectedMediaFileDirectories to set + */ + public void setSelectedMediaFileDirectories( + String[] selectedMediaFileDirectories) { + this.selectedMediaFileDirectories = selectedMediaFileDirectories; + } +} diff --git a/app/src/main/resources/struts.xml b/app/src/main/resources/struts.xml index 99456d19a..b809b62ac 100644 --- a/app/src/main/resources/struts.xml +++ b/app/src/main/resources/struts.xml @@ -321,14 +321,6 @@ <allowed-methods>execute,save</allowed-methods> </action> - <action name="mediaFileAddExternalInclude" - class="org.apache.roller.weblogger.ui.struts2.editor.MediaFileEdit"> - <result name="input" type="tiles">.MediaFileAddExternalInclude</result> - <result name="success" type="tiles">.MediaFileAddExternalInclude</result> - <result name="error" type="tiles">.MediaFileAddExternalInclude</result> - <allowed-methods>execute,save</allowed-methods> - </action> - <action name="mediaFileView" class="org.apache.roller.weblogger.ui.struts2.editor.MediaFileView"> <result name="success" type="tiles">.MediaFileView</result> @@ -632,7 +624,6 @@ <action name="mediaFileImageChooser" class="org.apache.roller.weblogger.ui.struts2.editor.MediaFileImageChooser"> - <param name="overlayMode">true</param> <result name="input" type="tiles">.MediaFileImageChooser</result> <result name="error" type="tiles">.MediaFileImageChooser</result> <result name="success" type="tiles">.MediaFileImageChooser</result> diff --git a/app/src/main/webapp/WEB-INF/jsps/editor/MediaFileAddExternalInclude.jsp b/app/src/main/webapp/WEB-INF/jsps/editor/MediaFileAddExternalInclude.jsp deleted file mode 100644 index db2259012..000000000 --- a/app/src/main/webapp/WEB-INF/jsps/editor/MediaFileAddExternalInclude.jsp +++ /dev/null @@ -1,63 +0,0 @@ -<%-- - 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. ---%> -<%@ include file="/WEB-INF/jsps/taglibs-struts2.jsp" %> - -<p class="subtitle"> - <s:text name="mediaFile.add.title" /> -</p> - -<script> -function submitPage(frm) { - var filePointer = "<a href='" + frm.url.value + "'>" + frm.title.value + "</a>"; - parent.onClose(filePointer); -} -</script> - -<s:form id="entry" action=" " method="POST"> - <s:hidden name="salt" /> - - <table class="entryEditTable" cellpadding="0" cellspacing="0" width="100%"> - - <tr> - <td class="entryEditFormLabel"> - <label for="status">URL:</label> - </td> - <td> - <s:textfield name="url" size="50" maxlength="255" tabindex="1" /> - </td> - </tr> - - <tr> - <td class="entryEditFormLabel"> - <label for="status">Title</label> - </td> - <td> - <s:textfield name="title" size="50" maxlength="255" /> - </td> - </tr> - - </table> - - <br> - <div class="control"> - <input type="button" value="Insert" name="submit" onclick="submitPage(this.form)" /> - <input type="button" value="Cancel" onClick="javascript:window.parent.onClose();" /> - </div> - -</s:form> diff --git a/app/src/main/webapp/WEB-INF/tiles.xml b/app/src/main/webapp/WEB-INF/tiles.xml index 264e6498a..24f4c9b5f 100644 --- a/app/src/main/webapp/WEB-INF/tiles.xml +++ b/app/src/main/webapp/WEB-INF/tiles.xml @@ -229,11 +229,6 @@ <put-attribute name="styles" value="/WEB-INF/jsps/tiles/empty.jsp" /> </definition> - <definition name=".MediaFileAddExternalInclude" extends=".tiles-popuppage-only-content" > - <put-attribute name="head" value="/WEB-INF/jsps/tiles/head.jsp" /> - <put-attribute name="content" value="/WEB-INF/jsps/editor/MediaFileAddExternalInclude.jsp" /> - </definition> - <definition name=".MediaFileImageChooser" extends=".tiles-popuppage-only-content" > <put-attribute name="head" value="/WEB-INF/jsps/tiles/head.jsp" /> <put-attribute name="content" value="/WEB-INF/jsps/editor/MediaFileImageChooser.jsp" /> diff --git a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/StrutsParameterAnnotationTest.java b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/StrutsParameterAnnotationTest.java index 29db9e8d0..64c2135c6 100644 --- a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/StrutsParameterAnnotationTest.java +++ b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/StrutsParameterAnnotationTest.java @@ -71,9 +71,7 @@ public class StrutsParameterAnnotationTest { * Forms whose target cannot be read from the JSP, keyed by JSP path and * form id. An empty list skips the form. */ - private static final Map<String, List<String>> FORM_TARGETS = Map.of( - // popup that is not reachable from any page - "editor/MediaFileAddExternalInclude.jsp#entry", List.of()); + private static final Map<String, List<String>> FORM_TARGETS = Map.of(); private static final Pattern STRUTS_TAG = Pattern.compile( "<(/?)s:(\\w+)((?:[^>\"']|\"[^\"]*\"|'[^']*')*)>");
