This is an automated email from the ASF dual-hosted git repository. snoopdave pushed a commit to branch merge-roller-6.1.x in repository https://gitbox.apache.org/repos/asf/roller.git
commit f81bbbad8b4eca756af27bf30b78bb1bc7144e53 Merge: d425b32ae c7a12d0b0 Author: David M. Johnson <[email protected]> AuthorDate: Sat Nov 7 15:21:19 2026 -0500 Merge branch 'roller-6.1.x' into master CHANGES.md | 9 + app/pom.xml | 6 - .../business/pings/WeblogUpdatePinger.java | 284 +++++++++++++++++++-- .../weblogger/ui/struts2/admin/PingTargets.java | 5 +- .../weblogger/ui/struts2/editor/Bookmarks.java | 2 +- .../ui/struts2/editor/CategoryRemove.java | 4 +- .../weblogger/ui/struts2/editor/EntryEdit.java | 38 ++- .../weblogger/ui/struts2/editor/EntryRemove.java | 26 +- .../weblogger/ui/struts2/editor/MediaFileAdd.java | 4 +- .../weblogger/ui/struts2/editor/MediaFileEdit.java | 5 +- .../ui/struts2/editor/MediaFileImageChooser.java | 4 +- .../weblogger/ui/struts2/editor/MediaFileView.java | 5 +- .../roller/weblogger/ui/struts2/editor/Pings.java | 5 +- .../ui/struts2/editor/StylesheetEdit.java | 2 +- .../weblogger/ui/struts2/editor/TemplateEdit.java | 2 +- .../ui/struts2/util/UIActionInterceptor.java | 17 +- .../business/pings/WeblogUpdatePingerTest.java | 224 ++++++++++++++++ .../editor/EditorActionTargetBindingTest.java | 117 +++++++++ .../struts2/editor/EntryWritePermissionTest.java | 214 ++++++++++++++++ .../ui/struts2/editor/PingsTargetBindingTest.java | 107 ++++++++ .../ui/struts2/util/UIActionInterceptorTest.java | 78 ++++++ 21 files changed, 1104 insertions(+), 54 deletions(-) diff --cc app/pom.xml index 08c7d142f,cb54682e5..43c8b51ef --- a/app/pom.xml +++ b/app/pom.xml @@@ -408,18 -388,6 +408,12 @@@ limitations under the License <version>${xmlrpc-version}</version> </dependency> - <dependency> - <groupId>org.apache.xmlrpc</groupId> - <artifactId>xmlrpc-client</artifactId> - <version>${xmlrpc-version}</version> - </dependency> - + <!-- Still needed: RollerXmlRpcServlet/RollerXmlRpcServletServer use + server-side classes (PropertyHandlerMapping, XmlRpcHttpServer, etc.) + that live in this artifact. The servlet classes themselves have been + forked into Roller so their javax.servlet imports can be migrated + to jakarta.servlet in Phase 2. TODO ROL-2183: evaluate whether + these server classes can also be forked to fully drop this dep. --> <dependency> <groupId>org.apache.xmlrpc</groupId> <artifactId>xmlrpc-server</artifactId> diff --cc app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileEdit.java index c3008dbb6,76afc4ceb..ff9fed9cc --- a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileEdit.java +++ b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileEdit.java @@@ -1,272 -1,241 +1,275 @@@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. 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. For additional information regarding - * copyright in this work, please see the NOTICE file in the top level - * directory of this distribution. - */ -package org.apache.roller.weblogger.ui.struts2.editor; - -import java.io.File; -import java.io.FileInputStream; - -import org.apache.commons.lang3.StringUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.apache.roller.weblogger.util.MediaTypePolicy; -import org.apache.roller.weblogger.WebloggerException; -import org.apache.roller.weblogger.business.FileIOException; -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; +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. 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. For additional information regarding + * copyright in this work, please see the NOTICE file in the top level + * directory of this distribution. + */ +package org.apache.roller.weblogger.ui.struts2.editor; + +import java.io.File; +import java.io.FileInputStream; + +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.roller.weblogger.util.MediaTypePolicy; +import org.apache.roller.weblogger.WebloggerException; +import org.apache.roller.weblogger.business.FileIOException; +import org.apache.roller.weblogger.business.MediaFileManager; +import org.apache.roller.weblogger.business.WebloggerFactory; +import org.apache.roller.weblogger.config.WebloggerRuntimeConfig; +import org.apache.roller.weblogger.pojos.MediaFile; +import org.apache.roller.weblogger.pojos.MediaFileDirectory; +import org.apache.struts2.action.UploadedFilesAware; import org.apache.roller.weblogger.ui.core.RollerContext; import org.apache.roller.weblogger.util.RollerMessages; -import org.apache.struts2.convention.annotation.AllowedMethods; -import org.apache.struts2.interceptor.validation.SkipValidation; - -/** - * Edits metadata for a media file. - */ -@SuppressWarnings("serial") -// TODO: make this work @AllowedMethods({"execute","save"}) -public class MediaFileEdit extends MediaFileBase { - - private static Log log = LogFactory.getLog(MediaFileEdit.class); - private MediaFileBean bean = new MediaFileBean(); - private MediaFileDirectory directory; - - // file uploaded by the user, if applicable - private File uploadedFile = null; - - // content types for upload file - private String uploadedFileContentType = null; - - // filename for uploaded file - private String uploadedFileName = null; - - public MediaFileEdit() { - this.actionName = "mediaFileEdit"; - this.desiredMenu = "editor"; - this.pageTitle = "mediaFile.edit.title"; - } - - /** - * Prepares edit action. - */ - @Override - public void myPrepare() { - refreshAllDirectories(); - try { - MediaFileManager mgr = WebloggerFactory.getWeblogger().getMediaFileManager(); - // The directory always comes from the weblog, by id. - directory = null; - if (!StringUtils.isEmpty(bean.getDirectoryId())) { - setDirectory(mgr.getMediaFileDirectory(getActionWeblog(), bean.getDirectoryId())); - } - } catch (WebloggerException ex) { - log.error("Error looking up media file directory", ex); - } - - } - - /** - * Validates media file metadata to be updated. - */ - public void myValidate() { - MediaFile fileWithSameName = getDirectory().getMediaFile(getBean().getName()); - if (fileWithSameName != null && !fileWithSameName.getId().equals(getMediaFileId())) { - addError("MediaFile.error.duplicateName", getBean().getName()); - } - } - - /** - * Show form for adding a new media file. - * - * @return String The result of the action. - */ - @SkipValidation - @Override - public String execute() { - MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); - try { - MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), getMediaFileId()); - this.bean.copyFrom(mediaFile); - - } catch (FileIOException ex) { - addError("uploadFiles.error.upload", bean.getName()); - - } catch (Exception e) { - log.error("Error uploading file " + bean.getName(), e); - addError("uploadFiles.error.upload", bean.getName()); - } - - return INPUT; - } - - /** - * Save a media file. - * - * @return String The result of the action. - */ - public String save() { - myValidate(); - if (!hasActionErrors()) { - MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); - try { - MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), getMediaFileId()); - bean.copyTo(mediaFile); - if (getBooleanProp("mediafile.originalPathEdit.enabled")) { - mediaFile.setOriginalPath(bean.getOriginalPath()); - } - - if (uploadedFile != null) { - mediaFile.setLength(this.uploadedFile.length()); +import org.apache.roller.weblogger.util.URLUtilities; +import org.apache.struts2.convention.annotation.AllowedMethods; +import org.apache.struts2.dispatcher.multipart.UploadedFile; +import org.apache.struts2.interceptor.parameter.StrutsParameter; +import org.apache.struts2.interceptor.validation.SkipValidation; + +import java.util.List; + +/** + * The media file details page: a preview, facts and actions for one file, + * and a form to edit its metadata. It links back to the library page the + * user came from, which the library passes as returnQuery. + */ +@SuppressWarnings("serial") +// TODO: make this work @AllowedMethods({"execute","save"}) +public class MediaFileEdit extends MediaFileBase implements UploadedFilesAware { + + private static Log log = LogFactory.getLog(MediaFileEdit.class); + private MediaFileBean bean = new MediaFileBean(); + private MediaFileDirectory directory; + + // replacement file uploaded by the user, if applicable, injected + // by the actionFileUpload interceptor + private UploadedFile uploadedFile = null; + + // the file shown, as stored; the form edits a copy in the bean + private MediaFile mediaFile = null; + + // library query string (MediaFileView.getLibraryQuery()) to return to + private String returnQuery = null; + + public MediaFileEdit() { + this.actionName = "mediaFileEdit"; + this.desiredMenu = "editor"; + this.pageTitle = "mediaFileEdit.title"; + } + + /** + * Prepares edit action. + */ + @Override + public void myPrepare() { + refreshAllDirectories(); + try { + MediaFileManager mgr = WebloggerFactory.getWeblogger().getMediaFileManager(); ++ // The directory always comes from the weblog, by id. ++ directory = null; + if (!StringUtils.isEmpty(bean.getDirectoryId())) { + setDirectory(mgr.getMediaFileDirectory(getActionWeblog(), bean.getDirectoryId())); + } + // Loaded here, not only in execute() and save(): when field + // validation fails, Struts returns INPUT without calling save(), + // and the page still needs the file to show the form again. + if (!StringUtils.isEmpty(getMediaFileId())) { + this.mediaFile = mgr.getMediaFile(getActionWeblog(), getMediaFileId()); + } + } catch (WebloggerException ex) { + log.error("Error looking up media file or directory", ex); + } + + } + + @Override + public void withUploadedFiles(List<UploadedFile> uploadedFiles) { + this.uploadedFile = uploadedFiles.isEmpty() ? null : uploadedFiles.get(0); + } + + /** + * Validates media file metadata to be updated. + */ + public void myValidate() { + MediaFile fileWithSameName = getDirectory().getMediaFile(getBean().getName()); + if (fileWithSameName != null && !fileWithSameName.getId().equals(getMediaFileId())) { + addError("MediaFile.error.duplicateName", getBean().getName()); + } + } + + /** + * Show form for adding a new media file. + * + * @return String The result of the action. + */ + @SkipValidation + @Override + public String execute() { + MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); + try { + this.mediaFile = manager.getMediaFile(getActionWeblog(), getMediaFileId()); + if (this.mediaFile == null) { + addError("MediaFile.error.view"); + return INPUT; + } + this.bean.copyFrom(this.mediaFile); + + } catch (FileIOException ex) { + addError("uploadFiles.error.upload", bean.getName()); + + } catch (Exception e) { + log.error("Error uploading file " + bean.getName(), e); + addError("uploadFiles.error.upload", bean.getName()); + } + + return INPUT; + } + + /** + * Save a media file. + * + * @return String The result of the action. + */ + public String save() { + if (this.mediaFile == null) { + try { + this.mediaFile = WebloggerFactory.getWeblogger().getMediaFileManager() + .getMediaFile(getActionWeblog(), getMediaFileId()); + } catch (WebloggerException ex) { + log.error("Error looking up media file " + getMediaFileId(), ex); + } + } + if (this.mediaFile == null) { + addError("MediaFile.error.view"); + return INPUT; + } + myValidate(); + if (!hasActionErrors()) { + MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); + try { + MediaFile mediaFile = manager.getMediaFile(getActionWeblog(), getMediaFileId()); + this.mediaFile = mediaFile; + bean.copyTo(mediaFile); + if (getBooleanProp("mediafile.originalPathEdit.enabled")) { + mediaFile.setOriginalPath(bean.getOriginalPath()); + } + + if (uploadedFile != null + && uploadedFile.getContent() instanceof File uploadFile) { + mediaFile.setLength(uploadFile.length()); String declaredType = MediaTypePolicy.normalizeType( - this.uploadedFileContentType); + uploadedFile.getContentType()); RollerMessages errors = new RollerMessages(); if (!WebloggerFactory.getWeblogger().getFileContentManager().canSave( - getActionWeblog(), this.uploadedFileName, declaredType, - this.uploadedFile.length(), errors)) { + getActionWeblog(), uploadedFile.getOriginalName(), declaredType, + uploadFile.length(), errors)) { throw new FileIOException(errors.toString()); } // Replacing the body re-decides the type, on the same // terms as the original upload. mediaFile.setContentType(MediaTypePolicy.storedTypeFor( - this.uploadedFileName, declaredType, + uploadedFile.getOriginalName(), declaredType, RollerContext.getServletContext()::getMimeType)); - manager.updateMediaFile(getActionWeblog(), mediaFile, - new FileInputStream(this.uploadedFile)); - } else { - manager.updateMediaFile(getActionWeblog(), mediaFile); - } - - // Move file - if (!getBean().getDirectoryId().equals( - mediaFile.getDirectory().getId())) { - log.debug("Processing move of " + mediaFile.getId()); - setSelectedMediaFiles(new String[] { mediaFile.getId() }); - setSelectedDirectory(getBean().getDirectoryId()); - doMoveSelected(); - } - - WebloggerFactory.getWeblogger().flush(); - - addMessage("mediaFile.update.success"); - return SUCCESS; - - } catch (FileIOException ex) { - addError("uploadFiles.error.upload", bean.getName()); - - } catch (Exception e) { - log.error("Error uploading file " + bean.getName(), e); - addError("uploadFiles.error.upload", bean.getName()); - } - - } - return INPUT; - } - - public MediaFileBean getBean() { - return bean; - } - - public void setBean(MediaFileBean b) { - this.bean = b; - } - - public MediaFileDirectory getDirectory() { - return directory; - } - - // package-private: set by the action only, never bound from a request - void setDirectory(MediaFileDirectory directory) { - this.directory = directory; - } - - /** - * @return the uploadedFile - */ - public File getUploadedFile() { - return uploadedFile; - } - - /** - * @param uploadedFile - * the uploadedFile to set - */ - public void setUploadedFile(File uploadedFile) { - this.uploadedFile = uploadedFile; - } - - /** - * @return the uploadedFileContentType - */ - public String getUploadedFileContentType() { - return uploadedFileContentType; - } - - /** - * @param uploadedFileContentType - * the uploadedFileContentType to set - */ - public void setUploadedFileContentType(String uploadedFileContentType) { - this.uploadedFileContentType = uploadedFileContentType; - } - - /** - * @return the uploadedFileName - */ - public String getUploadedFileName() { - return uploadedFileName; - } - - /** - * @param uploadedFileName - * the uploadedFileName to set - */ - public void setUploadedFileName(String uploadedFileName) { - this.uploadedFileName = uploadedFileName; - } -} + manager.updateMediaFile(getActionWeblog(), mediaFile, + new FileInputStream(uploadFile)); + } else { + manager.updateMediaFile(getActionWeblog(), mediaFile); + } + + // Move file + if (!getBean().getDirectoryId().equals( + mediaFile.getDirectory().getId())) { + log.debug("Processing move of " + mediaFile.getId()); + setSelectedMediaFiles(new String[] { mediaFile.getId() }); + setSelectedDirectory(getBean().getDirectoryId()); + doMoveSelected(); + } + + WebloggerFactory.getWeblogger().flush(); + + addMessage("mediaFile.update.success"); + this.mediaFile = manager.getMediaFile(getActionWeblog(), getMediaFileId()); + this.bean.copyFrom(this.mediaFile); + return SUCCESS; + + } catch (FileIOException ex) { + addError("uploadFiles.error.upload", bean.getName()); + + } catch (Exception e) { + log.error("Error uploading file " + bean.getName(), e); + addError("uploadFiles.error.upload", bean.getName()); + } + + } + return INPUT; + } + + public MediaFile getMediaFile() { + return mediaFile; + } + + public String getReturnQuery() { + return returnQuery; + } + + /** + * The library page to return to. Only the query string comes from the + * request, and only URL-safe characters are kept. getLibraryURL() sets + * the weblog itself, so the link always points at this weblog's library. + */ + @StrutsParameter + public void setReturnQuery(String returnQuery) { + this.returnQuery = returnQuery != null && returnQuery.length() <= 2000 + && returnQuery.matches("[A-Za-z0-9._~%&=+*-]*") ? returnQuery : null; + } + + public String getLibraryURL() { + StringBuilder query = new StringBuilder("weblog=") + .append(URLUtilities.encode(getActionWeblog().getHandle())); + if (StringUtils.isNotEmpty(returnQuery)) { + // any weblog in the returned query is dropped; this one is used + for (String param : StringUtils.split(returnQuery, '&')) { + if (!param.equals("weblog") && !param.startsWith("weblog=")) { + query.append('&').append(param); + } + } + } else if (mediaFile != null) { + query.append("&directoryId=").append(URLUtilities.encode(mediaFile.getDirectory().getId())); + } + return WebloggerRuntimeConfig.getRelativeContextURL() + + "/roller-ui/authoring/mediaFileView.rol?" + query; + } + + @StrutsParameter(depth = 1) + public MediaFileBean getBean() { + return bean; + } + + public void setBean(MediaFileBean b) { + this.bean = b; + } + + public MediaFileDirectory getDirectory() { + return directory; + } + - public void setDirectory(MediaFileDirectory directory) { ++ // package-private: set by the action only, never bound from a request ++ void setDirectory(MediaFileDirectory directory) { + this.directory = directory; + } + +} diff --cc app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileView.java index 75693bcee,7f3dfc212..29a0f3300 --- a/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileView.java +++ b/app/src/main/java/org/apache/roller/weblogger/ui/struts2/editor/MediaFileView.java @@@ -1,480 -1,487 +1,483 @@@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. 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. For additional information regarding - * copyright in this work, please see the NOTICE file in the top level - * directory of this distribution. - */ -package org.apache.roller.weblogger.ui.struts2.editor; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -import org.apache.commons.lang3.StringUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.apache.roller.weblogger.WebloggerException; -import org.apache.roller.weblogger.business.FileIOException; -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.MediaFileComparator; -import org.apache.roller.weblogger.pojos.MediaFileComparator.MediaFileComparatorType; -import org.apache.roller.weblogger.pojos.MediaFileDirectory; -import org.apache.roller.weblogger.pojos.MediaFileFilter; -import org.apache.roller.weblogger.ui.struts2.pagers.MediaFilePager; -import org.apache.roller.weblogger.ui.struts2.util.KeyValueObject; -import org.apache.roller.weblogger.util.cache.CacheManager; -import org.apache.struts2.convention.annotation.AllowedMethods; -import org.apache.struts2.interceptor.validation.SkipValidation; - -/** - * View media files. - */ -@SuppressWarnings("serial") -// TODO: make this work @AllowedMethods({"execute","view","search","delete","deleteSelected","deleteFolder","includeInGallery","moveSelected"}) -public class MediaFileView extends MediaFileBase { - - private static Log log = LogFactory.getLog(MediaFileView.class); - - private String directoryId; - private String directoryName; - private String sortBy; - private String newDirectoryName; - - private List<MediaFile> childFiles; - private MediaFileDirectory currentDirectory; - - // Search criteria - drop-down for file type - private static List<KeyValueObject> FILE_TYPES = null; - - // Search criteria - drop-down for size filter - private static List<KeyValueObject> SIZE_FILTER_TYPES = null; - - // Search criteria - drop-down for size unit - private static List<KeyValueObject> SIZE_UNITS = null; - - // Sort options for search results. - private static List<KeyValueObject> SORT_OPTIONS = null; - - // Pager for displaying search results. - private MediaFilePager pager; - - // Path of new directory to be created. - private String newDirectoryPath; - - // a new directory the user wishes to view - private String viewDirectoryId = null; - - private MediaFileSearchBean bean = new MediaFileSearchBean(); - - public MediaFileView() { - this.actionName = "mediaFileView"; - this.desiredMenu = "editor"; - this.pageTitle = "mediaFileView.title"; - } - - /** - * Prepares view action - */ - @Override - public void myPrepare() { - - if (SIZE_FILTER_TYPES == null) { - - SIZE_FILTER_TYPES = Arrays.asList(new KeyValueObject( - "mediaFileView.gt", getText("mediaFileView.gt")), - new KeyValueObject("mediaFileView.ge", - getText("mediaFileView.ge")), new KeyValueObject( - "mediaFileView.eq", getText("mediaFileView.eq")), - new KeyValueObject("mediaFileView.le", - getText("mediaFileView.le")), new KeyValueObject( - "mediaFileView.lt", getText("mediaFileView.lt"))); - - FILE_TYPES = Arrays.asList(new KeyValueObject("mediaFileView.any", - getText("mediaFileView.any")), new KeyValueObject( - "mediaFileView.others", getText("mediaFileView.others")), - new KeyValueObject("mediaFileView.image", - getText("mediaFileView.image")), - new KeyValueObject("mediaFileView.video", - getText("mediaFileView.video")), - new KeyValueObject("mediaFileView.audio", - getText("mediaFileView.audio"))); - - SIZE_UNITS = Arrays.asList(new KeyValueObject( - "mediaFileView.bytes", getText("mediaFileView.bytes")), - new KeyValueObject("mediaFileView.kb", - getText("mediaFileView.kb")), new KeyValueObject( - "mediaFileView.mb", getText("mediaFileView.mb"))); - - SORT_OPTIONS = Arrays.asList(new KeyValueObject("name", - getText("generic.name")), new KeyValueObject( - "date_uploaded", getText("mediaFileView.date")), - new KeyValueObject("type", getText("mediaFileView.type"))); - } - - refreshAllDirectories(); - - // The current directory is set by view(), from the weblog, by id. - currentDirectory = null; - } - - /** - * Create a new directory by name. All folders placed at the root. - */ - public String createNewDirectory() { - boolean dirCreated = false; - if (StringUtils.isEmpty(this.newDirectoryName)) { - addError("mediaFile.error.view.dirNameEmpty"); - } else if (this.newDirectoryName.contains("/")) { - addError("mediaFile.error.view.dirNameInvalid"); - } else { - try { - - log.debug("Creating new directory - " + this.newDirectoryName); - MediaFileManager manager = WebloggerFactory.getWeblogger() - .getMediaFileManager(); - - if (!getActionWeblog().hasMediaFileDirectory( - this.newDirectoryName)) { - // Create - MediaFileDirectory dir = manager.createMediaFileDirectory( - getActionWeblog(), this.newDirectoryName); - // flush changes - WebloggerFactory.getWeblogger().flush(); - addMessage("mediaFile.directoryCreate.success", - this.newDirectoryName); - - // Switch to folder - setDirectoryId(dir.getId()); - - dirCreated = true; - } else { - // already exists - addMessage("mediaFile.directoryCreate.error.exists", - this.newDirectoryName); - } - - } catch (WebloggerException e) { - log.error("Error creating new directory", e); - addError("Error creating new directory"); - } - } - - if (dirCreated) { - // Refresh list of directories so the newly created directory is - // included. - refreshAllDirectories(); - } - return execute(); - - } - - /** - * Returns directory content in JSON format. - */ - public String fetchDirectoryContentLight() { - execute(); - return "success.json"; - } - - /** - * Fetches and displays list of media file for the given directory. The - * directory could be chosen by ID or path. - * - * @return String The result of the action. - */ - @SkipValidation - @Override - public String execute() { - MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); - try { - MediaFileDirectory directory; - if (StringUtils.isNotEmpty(this.directoryId)) { - directory = manager.getMediaFileDirectory(getActionWeblog(), this.directoryId); - - } else if (StringUtils.isNotEmpty(this.directoryName)) { - directory = manager.getMediaFileDirectoryByName( - getActionWeblog(), this.directoryName); - - } else { - directory = manager.getDefaultMediaFileDirectory(getActionWeblog()); - } - this.directoryId = directory.getId(); - this.directoryName = directory.getName(); - - this.childFiles = new ArrayList<>(); - this.childFiles.addAll(directory.getMediaFiles()); - - if ("type".equals(sortBy)) { - this.childFiles.sort(new MediaFileComparator(MediaFileComparatorType.TYPE)); - - } else if ("date_uploaded".equals(sortBy)) { - this.childFiles.sort(new MediaFileComparator(MediaFileComparatorType.DATE_UPLOADED)); - - } else { - // default to sort by name - sortBy = "name"; - this.childFiles.sort(new MediaFileComparator(MediaFileComparatorType.NAME)); - } - - this.currentDirectory = directory; - - // set current directory if valid - if (directory != null) { - setViewDirectoryId(directory.getId()); - } - - return SUCCESS; - - } catch (FileIOException ex) { - log.error("Error viewing media file directory ", ex); - addError("MediaFile.error.view"); - } catch (Exception e) { - log.error("Error viewing media file directory ", e); - addError("MediaFile.error.view"); - } - return SUCCESS; - } - - /** - * View the contents of another Media folder. - */ - public String view() { - try { - MediaFileManager manager = WebloggerFactory.getWeblogger() - .getMediaFileManager(); - if (!StringUtils.isEmpty(viewDirectoryId)) { - setDirectoryId(viewDirectoryId); - setCurrentDirectory(manager.getMediaFileDirectory(getActionWeblog(), viewDirectoryId)); - } - } catch (WebloggerException ex) { - log.error("Error looking up directory", ex); - } - return execute(); - } - - /** - * Save a media file. - * - * @return String The result of the action. - */ - public String search() { - - boolean valSuccess = myValidate(); - - if (valSuccess) { - MediaFileFilter filter = new MediaFileFilter(); - bean.copyTo(filter); - MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); - try { - List<MediaFile> rawResults = manager.searchMediaFiles(getActionWeblog(), filter); - boolean hasMore = false; - List<MediaFile> results = new ArrayList<>(rawResults); - if (results.size() > MediaFileSearchBean.PAGE_SIZE) { - results.remove(results.size() - 1); - hasMore = true; - } - - this.pager = new MediaFilePager(bean.getPageNum(), results, - hasMore); - - } catch (Exception e) { - log.error("Error applying search criteria", e); - addError("Error applying search criteria - check Roller logs"); - } - - } - - return SUCCESS; - } - - /** - * Delete selected media files. - * - */ - public String deleteSelected() { - doDeleteSelected(); - return execute(); - } - - /** - * Delete selected media file - * - */ - public String delete() { - doDeleteMediaFile(); - return execute(); - } - - /** - * Delete folder - */ - public String deleteFolder() { - - try { - MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); - if (directoryId != null) { - log.debug("Deleting media file folder - " + directoryId + " (" - + directoryName + ")"); - MediaFileDirectory mediaFileDir = manager - .getMediaFileDirectory(getActionWeblog(), directoryId); - manager.removeMediaFileDirectory(mediaFileDir); - refreshAllDirectories(); - WebloggerFactory.getWeblogger().getWeblogManager() - .saveWeblog(this.getActionWeblog()); - - // flush changes - WebloggerFactory.getWeblogger().flush(); - WebloggerFactory.getWeblogger().release(); - addMessage("mediaFile.deleteFolder.success"); - - // notify caches - CacheManager.invalidate(getActionWeblog()); - - // re-route to default folder - mediaFileDir = manager - .getDefaultMediaFileDirectory(getActionWeblog()); - setDirectoryId(mediaFileDir.getId()); - setDirectoryName(mediaFileDir.getName()); - } else { - log.error("(System error) No directory ID provided for media file folder delete."); - } - } catch (WebloggerException ex) { - log.error("Error deleting folder", ex); - } - return execute(); - } - - /** - * Include selected media file in gallery - * - */ - public String includeInGallery() { - doIncludeMediaFileInGallery(); - return execute(); - } - - /** - * Move selected media files to a different directory - * - */ - public String moveSelected() { - doMoveSelected(); - return execute(); - } - - public String getDirectoryId() { - return directoryId; - } - - public void setDirectoryId(String id) { - this.directoryId = id; - } - - public List<MediaFile> getChildFiles() { - return childFiles; - } - - public void setChildFiles(List<MediaFile> files) { - this.childFiles = files; - } - - public String getNewDirectoryName() { - return newDirectoryName; - } - - public void setNewDirectoryName(String newDirectoryName) { - this.newDirectoryName = newDirectoryName; - } - - public MediaFileDirectory getCurrentDirectory() { - return currentDirectory; - } - - private void setCurrentDirectory(MediaFileDirectory currentDirectory) { - this.currentDirectory = currentDirectory; - } - - public String getDirectoryName() { - return directoryName; - } - - public void setDirectoryName(String path) { - this.directoryName = path; - } - - public String getSortBy() { - return sortBy; - } - - public void setSortBy(String sortBy) { - this.sortBy = sortBy; - } - - /** - * Validates search input - */ - public boolean myValidate() { - if (StringUtils.isEmpty(bean.getName()) - && StringUtils.isEmpty(bean.getTags()) - && StringUtils.isEmpty(bean.getType()) && bean.getSize() == 0) { - addError("MediaFile.error.search.empty"); - return false; - } - return true; - } - - public MediaFileSearchBean getBean() { - return bean; - } - - public void setBean(MediaFileSearchBean b) { - this.bean = b; - } - - public List<KeyValueObject> getFileTypes() { - return FILE_TYPES; - } - - public List<KeyValueObject> getSizeFilterTypes() { - return SIZE_FILTER_TYPES; - } - - public List<KeyValueObject> getSizeUnits() { - return SIZE_UNITS; - } - - public List<KeyValueObject> getSortOptions() { - return SORT_OPTIONS; - } - - public MediaFilePager getPager() { - return pager; - } - - public void setPager(MediaFilePager pager) { - this.pager = pager; - } - - public String getNewDirectoryPath() { - return newDirectoryPath; - } - - public void setNewDirectoryPath(String newDirectoryPath) { - this.newDirectoryPath = newDirectoryPath; - } - - public String getViewDirectoryId() { - return viewDirectoryId; - } - - public void setViewDirectoryId(String viewDirectoryId) { - this.viewDirectoryId = viewDirectoryId; - } - -} +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. 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. For additional information regarding + * copyright in this work, please see the NOTICE file in the top level + * directory of this distribution. + */ +package org.apache.roller.weblogger.ui.struts2.editor; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.roller.weblogger.WebloggerException; +import org.apache.roller.weblogger.business.FileIOException; +import org.apache.roller.weblogger.business.MediaFileManager; +import org.apache.roller.weblogger.business.WebloggerFactory; +import org.apache.roller.weblogger.config.WebloggerRuntimeConfig; +import org.apache.roller.weblogger.pojos.MediaFile; +import org.apache.roller.weblogger.pojos.MediaFileDirectory; +import org.apache.roller.weblogger.pojos.MediaFileFilter; +import org.apache.roller.weblogger.ui.struts2.pagers.MediaFilePager; +import org.apache.roller.weblogger.ui.struts2.util.KeyValueObject; +import org.apache.roller.weblogger.util.URLUtilities; +import org.apache.roller.weblogger.util.cache.CacheManager; +import org.apache.struts2.convention.annotation.AllowedMethods; +import org.apache.struts2.interceptor.parameter.StrutsParameter; +import org.apache.struts2.interceptor.validation.SkipValidation; + +/** + * The media library: one page of the files in a folder, or of the files that + * match a search in that folder or in all folders. Browsing and searching are + * the same query, so both sort and page the same way. The page state travels + * in GET parameters, so links, the back button and the pager keep it. + */ +@SuppressWarnings("serial") +// TODO: make this work @AllowedMethods({"execute","view","search","delete","deleteSelected","deleteFolder","includeInGallery","moveSelected"}) +public class MediaFileView extends MediaFileBase { + + private static Log log = LogFactory.getLog(MediaFileView.class); + + private String directoryId; + private String directoryName; + private String newDirectoryName; + + private List<MediaFile> childFiles; + private MediaFileDirectory currentDirectory; + + // Search criteria - drop-down for file type + private static List<KeyValueObject> FILE_TYPES = null; + + // Search criteria - drop-down for size filter + private static List<KeyValueObject> SIZE_FILTER_TYPES = null; + + // Search criteria - drop-down for size unit + private static List<KeyValueObject> SIZE_UNITS = null; + + // Sort options + private static List<KeyValueObject> SORT_OPTIONS = null; + + // the page of files shown + private MediaFilePager pager; + + // Path of new directory to be created. + private String newDirectoryPath; + + // a new directory the user wishes to view + private String viewDirectoryId = null; + + private MediaFileSearchBean bean = new MediaFileSearchBean(); + + public MediaFileView() { + this.actionName = "mediaFileView"; + this.desiredMenu = "editor"; + this.pageTitle = "mediaFileView.title"; + } + + /** + * Prepares view action + */ + @Override + public void myPrepare() { + + if (SIZE_FILTER_TYPES == null) { + + SIZE_FILTER_TYPES = Arrays.asList(new KeyValueObject( + "mediaFileView.gt", getText("mediaFileView.gt")), + new KeyValueObject("mediaFileView.ge", + getText("mediaFileView.ge")), new KeyValueObject( + "mediaFileView.eq", getText("mediaFileView.eq")), + new KeyValueObject("mediaFileView.le", + getText("mediaFileView.le")), new KeyValueObject( + "mediaFileView.lt", getText("mediaFileView.lt"))); + + // in the order the type chips show them + FILE_TYPES = Arrays.asList( + new KeyValueObject("mediaFileView.any", getText("mediaFileView.any")), + new KeyValueObject("mediaFileView.image", getText("mediaFileView.image")), + new KeyValueObject("mediaFileView.video", getText("mediaFileView.video")), + new KeyValueObject("mediaFileView.audio", getText("mediaFileView.audio")), + new KeyValueObject("mediaFileView.others", getText("mediaFileView.others"))); + + SIZE_UNITS = Arrays.asList(new KeyValueObject( + "mediaFileView.bytes", getText("mediaFileView.bytes")), + new KeyValueObject("mediaFileView.kb", + getText("mediaFileView.kb")), new KeyValueObject( + "mediaFileView.mb", getText("mediaFileView.mb"))); + + SORT_OPTIONS = Arrays.asList( + new KeyValueObject(MediaFileSearchBean.SORT_NEWEST, getText("mediaFileView.sortNewest")), + new KeyValueObject(MediaFileSearchBean.SORT_OLDEST, getText("mediaFileView.sortOldest")), + new KeyValueObject(MediaFileSearchBean.SORT_NAME, getText("generic.name")), + new KeyValueObject(MediaFileSearchBean.SORT_TYPE, getText("mediaFileView.type"))); + } + + refreshAllDirectories(); ++ ++ // The current directory is set by view(), from the weblog, by id. ++ currentDirectory = null; + } + + /** + * Create a new directory by name. All folders placed at the root. + */ + public String createNewDirectory() { + boolean dirCreated = false; + if (StringUtils.isEmpty(this.newDirectoryName)) { + addError("mediaFile.error.view.dirNameEmpty"); + } else if (this.newDirectoryName.contains("/")) { + addError("mediaFile.error.view.dirNameInvalid"); + } else { + try { + + log.debug("Creating new directory - " + this.newDirectoryName); + MediaFileManager manager = WebloggerFactory.getWeblogger() + .getMediaFileManager(); + + if (!getActionWeblog().hasMediaFileDirectory( + this.newDirectoryName)) { + // Create + MediaFileDirectory dir = manager.createMediaFileDirectory( + getActionWeblog(), this.newDirectoryName); + // flush changes + WebloggerFactory.getWeblogger().flush(); + addMessage("mediaFile.directoryCreate.success", + this.newDirectoryName); + + // Switch to the new, empty folder + setDirectoryId(dir.getId()); + clearSearch(); + + dirCreated = true; + } else { + // already exists + addMessage("mediaFile.directoryCreate.error.exists", + this.newDirectoryName); + } + + } catch (WebloggerException e) { + log.error("Error creating new directory", e); + addError("Error creating new directory"); + } + } + + if (dirCreated) { + // Refresh list of directories so the newly created directory is + // included. + refreshAllDirectories(); + } + return execute(); + + } + + /** + * Shows a page of the library: the folder chosen by ID or name (the + * default folder otherwise), filtered by any search criteria. + * + * @return String The result of the action. + */ + @SkipValidation + @Override + public String execute() { + MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); + try { + MediaFileDirectory directory = null; + if (StringUtils.isNotEmpty(this.directoryId)) { + directory = manager.getMediaFileDirectory(getActionWeblog(), this.directoryId); + } else if (StringUtils.isNotEmpty(this.directoryName)) { + directory = manager.getMediaFileDirectoryByName( + getActionWeblog(), this.directoryName); + } + if (directory == null) { + directory = manager.getDefaultMediaFileDirectory(getActionWeblog()); + } + this.currentDirectory = directory; + this.directoryId = directory.getId(); + this.directoryName = directory.getName(); + setViewDirectoryId(directory.getId()); + + MediaFileFilter filter = new MediaFileFilter(); + bean.copyTo(filter); + if (!bean.isSearch() || !bean.isAllFolders()) { + filter.setDirectory(directory); + } + + long totalCount = manager.getMediaFileCount(getActionWeblog(), filter); + if (totalCount > 0 && filter.getStartIndex() >= totalCount) { + // past the end, e.g. after deleting the last files of the last page + bean.setPage((int) ((totalCount - 1) / MediaFileSearchBean.PAGE_SIZE)); + bean.copyTo(filter); + } + List<MediaFile> files = new ArrayList<>(manager.searchMediaFiles(getActionWeblog(), filter)); + this.childFiles = files; + this.pager = new MediaFilePager(getPagerBaseURL(), bean.getPage(), files, + totalCount, MediaFileSearchBean.PAGE_SIZE); + + } catch (FileIOException ex) { + log.error("Error viewing media file directory ", ex); + addError("MediaFile.error.view"); + } catch (Exception e) { + log.error("Error viewing media file directory ", e); + addError("MediaFile.error.view"); + } + return SUCCESS; + } + + /** + * Returns directory content in JSON format. + */ + public String fetchDirectoryContentLight() { + execute(); + return "success.json"; + } + + /** + * View the contents of another Media folder. + */ + public String view() { + if (!StringUtils.isEmpty(viewDirectoryId)) { + setDirectoryId(viewDirectoryId); + } + return execute(); + } + + /** + * Search. Kept for old links; the library searches whenever criteria are set. + */ + @SkipValidation + public String search() { + return execute(); + } + + private void clearSearch() { + MediaFileSearchBean fresh = new MediaFileSearchBean(); + fresh.setSortBy(bean.getSortBy()); + this.bean = fresh; + } + + /** + * The library state, as an encoded query string without a leading "?": + * weblog, folder, criteria, sort and page. Pages linked from the library + * pass it back so the user returns to the same place. + */ + public String getLibraryQuery() { + Map<String, String> params = stateParams(); + if (bean.getPage() > 0) { + params.put("bean.page", Integer.toString(bean.getPage())); + } + return queryString(params); + } + + private String getPagerBaseURL() { + return WebloggerRuntimeConfig.getRelativeContextURL() + + "/roller-ui/authoring/mediaFileView.rol?" + queryString(stateParams()); + } + + private Map<String, String> stateParams() { + Map<String, String> params = new LinkedHashMap<>(); + params.put("weblog", getActionWeblog().getHandle()); + if (directoryId != null) { + params.put("directoryId", directoryId); + } + params.putAll(bean.toParams()); + return params; + } + + private static String queryString(Map<String, String> params) { + return params.entrySet().stream() + .map(e -> e.getKey() + "=" + URLUtilities.encode(e.getValue())) + .collect(Collectors.joining("&")); + } + + /** True when search criteria are set, rather than browsing a folder. */ + public boolean isSearch() { + return bean.isSearch(); + } + + /** + * Delete selected media files. + * + */ + public String deleteSelected() { + doDeleteSelected(); + return execute(); + } + + /** + * Delete selected media file + * + */ + public String delete() { + doDeleteMediaFile(); + return execute(); + } + + /** + * Delete folder + */ + public String deleteFolder() { + + try { + MediaFileManager manager = WebloggerFactory.getWeblogger().getMediaFileManager(); + if (directoryId != null) { + log.debug("Deleting media file folder - " + directoryId + " (" + + directoryName + ")"); + MediaFileDirectory mediaFileDir = manager + .getMediaFileDirectory(getActionWeblog(), directoryId); + manager.removeMediaFileDirectory(mediaFileDir); + refreshAllDirectories(); + WebloggerFactory.getWeblogger().getWeblogManager() + .saveWeblog(this.getActionWeblog()); + + // flush changes + WebloggerFactory.getWeblogger().flush(); + WebloggerFactory.getWeblogger().release(); + addMessage("mediaFile.deleteFolder.success"); + + // notify caches + CacheManager.invalidate(getActionWeblog()); + + // re-route to default folder + mediaFileDir = manager + .getDefaultMediaFileDirectory(getActionWeblog()); + setDirectoryId(mediaFileDir.getId()); + setDirectoryName(mediaFileDir.getName()); + clearSearch(); + } else { + log.error("(System error) No directory ID provided for media file folder delete."); + } + } catch (WebloggerException ex) { + log.error("Error deleting folder", ex); + } + return execute(); + } + + /** + * Include selected media file in gallery + * + */ + public String includeInGallery() { + doIncludeMediaFileInGallery(); + return execute(); + } + + /** + * Move selected media files to a different directory + * + */ + public String moveSelected() { + doMoveSelected(); + return execute(); + } + + public String getDirectoryId() { + return directoryId; + } + + @StrutsParameter + public void setDirectoryId(String id) { + this.directoryId = id; + } + + public List<MediaFile> getChildFiles() { + return childFiles; + } + + public void setChildFiles(List<MediaFile> files) { + this.childFiles = files; + } + + public String getNewDirectoryName() { + return newDirectoryName; + } + + @StrutsParameter + public void setNewDirectoryName(String newDirectoryName) { + this.newDirectoryName = newDirectoryName; + } + + public MediaFileDirectory getCurrentDirectory() { + return currentDirectory; + } + - public void setCurrentDirectory(MediaFileDirectory currentDirectory) { ++ private void setCurrentDirectory(MediaFileDirectory currentDirectory) { + this.currentDirectory = currentDirectory; + } + + public String getDirectoryName() { + return directoryName; + } + + @StrutsParameter + public void setDirectoryName(String path) { + this.directoryName = path; + } + + @StrutsParameter(depth = 1) + public MediaFileSearchBean getBean() { + return bean; + } + + public void setBean(MediaFileSearchBean b) { + this.bean = b; + } + + public List<KeyValueObject> getFileTypes() { + return FILE_TYPES; + } + + public List<KeyValueObject> getSizeFilterTypes() { + return SIZE_FILTER_TYPES; + } + + public List<KeyValueObject> getSizeUnits() { + return SIZE_UNITS; + } + + public List<KeyValueObject> getSortOptions() { + return SORT_OPTIONS; + } + + public MediaFilePager getPager() { + return pager; + } + + public void setPager(MediaFilePager pager) { + this.pager = pager; + } + + public String getNewDirectoryPath() { + return newDirectoryPath; + } + + public void setNewDirectoryPath(String newDirectoryPath) { + this.newDirectoryPath = newDirectoryPath; + } + + public String getViewDirectoryId() { + return viewDirectoryId; + } + + @StrutsParameter + public void setViewDirectoryId(String viewDirectoryId) { + this.viewDirectoryId = viewDirectoryId; + } + +} diff --cc app/src/test/java/org/apache/roller/weblogger/ui/struts2/editor/EditorActionTargetBindingTest.java index 000000000,bb58838f7..b44f5e08e mode 000000,100644..100644 --- a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/editor/EditorActionTargetBindingTest.java +++ b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/editor/EditorActionTargetBindingTest.java @@@ -1,0 -1,117 +1,117 @@@ + /* + * 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.function.Function; + import java.util.function.Supplier; + -import com.opensymphony.xwork2.config.ConfigurationManager; -import com.opensymphony.xwork2.config.providers.XWorkConfigurationProvider; -import com.opensymphony.xwork2.inject.Container; -import com.opensymphony.xwork2.util.ValueStack; -import com.opensymphony.xwork2.util.ValueStackFactory; -import com.opensymphony.xwork2.util.reflection.ReflectionContextState; ++import org.apache.struts2.config.ConfigurationManager; ++import org.apache.struts2.config.providers.StrutsDefaultConfigurationProvider; ++import org.apache.struts2.inject.Container; ++import org.apache.struts2.util.ValueStack; ++import org.apache.struts2.util.ValueStackFactory; ++import org.apache.struts2.util.reflection.ReflectionContextState; + import org.apache.roller.weblogger.ui.struts2.admin.PingTargets; + import org.junit.jupiter.api.BeforeEach; + import org.junit.jupiter.api.DynamicTest; + import org.junit.jupiter.api.TestFactory; + import org.junit.jupiter.api.function.Executable; + + import java.util.Arrays; + import java.util.List; + + import static org.junit.jupiter.api.Assertions.assertNull; + + /** + * No editor or ping-target action lets a request parameter create the domain + * object it works on. Those objects are loaded only by the action, from the + * weblog, by id. + */ + class EditorActionTargetBindingTest { + + private ValueStack stack; + + @BeforeEach + void setUp() { + ConfigurationManager configurationManager = new ConfigurationManager("xwork"); - configurationManager.addContainerProvider(new XWorkConfigurationProvider()); ++ configurationManager.addContainerProvider(new StrutsDefaultConfigurationProvider()); + Container container = configurationManager.getConfiguration().getContainer(); + stack = container.getInstance(ValueStackFactory.class).createValueStack(); + } + + private void tryBind(Object action, String name, String value) { + stack.push(action); + ReflectionContextState.setCreatingNullObjects(stack.getContext(), true); + ReflectionContextState.setDenyMethodExecution(stack.getContext(), true); + try { + stack.setParameter(name, value); + } catch (RuntimeException expectedForUnwritableProperty) { + // A non-bindable property may raise; that is the point. + } finally { + ReflectionContextState.setCreatingNullObjects(stack.getContext(), false); + stack.pop(); + } + } + + private static class Case { + final String label; + final Supplier<Object> make; + final String param; + final Function<Object, Object> read; + Case(String label, Supplier<Object> make, String param, Function<Object, Object> read) { + this.label = label; this.make = make; this.param = param; this.read = read; + } + } + + private List<Case> cases() { + return Arrays.asList( + new Case("Pings.pingTarget", Pings::new, "pingTarget.pingUrl", + a -> ((Pings) a).getPingTarget()), + new Case("PingTargets.pingTarget", PingTargets::new, "pingTarget.pingUrl", + a -> ((PingTargets) a).getPingTarget()), + new Case("CategoryRemove.category", CategoryRemove::new, "category.name", + a -> ((CategoryRemove) a).getCategory()), + new Case("EntryRemove.removeEntry", EntryRemove::new, "removeEntry.anchor", + a -> ((EntryRemove) a).getRemoveEntry()), + new Case("EntryEdit.entry", EntryEdit::new, "entry.anchor", + a -> ((EntryEdit) a).getEntry()), + new Case("MediaFileEdit.directory", MediaFileEdit::new, "directory.name", + a -> ((MediaFileEdit) a).getDirectory()), + new Case("MediaFileAdd.directory", MediaFileAdd::new, "directory.name", + a -> ((MediaFileAdd) a).getDirectory()), + new Case("MediaFileView.currentDirectory", MediaFileView::new, "currentDirectory.name", + a -> ((MediaFileView) a).getCurrentDirectory()), + new Case("MediaFileImageChooser.currentDirectory", MediaFileImageChooser::new, "currentDirectory.name", + a -> ((MediaFileImageChooser) a).getCurrentDirectory()), + new Case("StylesheetEdit.template", StylesheetEdit::new, "template.name", + a -> ((StylesheetEdit) a).getTemplate()), + new Case("TemplateEdit.template", TemplateEdit::new, "template.name", + a -> ((TemplateEdit) a).getTemplate()), + new Case("Bookmarks.folder", Bookmarks::new, "folder.name", + a -> ((Bookmarks) a).getFolder()) + ); + } + + @TestFactory + Iterable<DynamicTest> requestCannotCreateTheTargetObject() { + return cases().stream().map(c -> DynamicTest.dynamicTest(c.label, (Executable) () -> { + Object action = c.make.get(); + tryBind(action, c.param, "http://attacker.example/"); + assertNull(c.read.apply(action), c.label + " must stay null after a bind attempt"); + })).collect(java.util.stream.Collectors.toList()); + } + } diff --cc app/src/test/java/org/apache/roller/weblogger/ui/struts2/editor/PingsTargetBindingTest.java index 000000000,edfda4901..3f96520dd mode 000000,100644..100644 --- a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/editor/PingsTargetBindingTest.java +++ b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/editor/PingsTargetBindingTest.java @@@ -1,0 -1,107 +1,107 @@@ + /* + * 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.Collections; + -import com.opensymphony.xwork2.config.ConfigurationManager; -import com.opensymphony.xwork2.config.providers.XWorkConfigurationProvider; -import com.opensymphony.xwork2.inject.Container; -import com.opensymphony.xwork2.util.ValueStackFactory; -import com.opensymphony.xwork2.util.ValueStack; -import com.opensymphony.xwork2.util.reflection.ReflectionContextState; ++import org.apache.struts2.config.ConfigurationManager; ++import org.apache.struts2.config.providers.StrutsDefaultConfigurationProvider; ++import org.apache.struts2.inject.Container; ++import org.apache.struts2.util.ValueStackFactory; ++import org.apache.struts2.util.ValueStack; ++import org.apache.struts2.util.reflection.ReflectionContextState; + import org.apache.roller.weblogger.business.WebloggerFactory; + import org.apache.roller.weblogger.business.Weblogger; + import org.apache.roller.weblogger.business.pings.PingTargetManager; + import org.apache.roller.weblogger.pojos.PingTarget; + import org.junit.jupiter.api.AfterEach; + import org.junit.jupiter.api.BeforeEach; + import org.junit.jupiter.api.Test; + import org.mockito.MockedStatic; + + import static org.junit.jupiter.api.Assertions.assertNull; + import static org.junit.jupiter.api.Assertions.assertSame; + import static org.mockito.Mockito.mock; + import static org.mockito.Mockito.mockStatic; + import static org.mockito.Mockito.when; + + /** + * The ping target that the Pings action works on must be one of the stored + * ping targets, selected by id. + */ + class PingsTargetBindingTest { + + private MockedStatic<WebloggerFactory> factory; + private PingTargetManager pingTargets; + private ValueStack stack; + + @BeforeEach + void setUp() throws Exception { + factory = mockStatic(WebloggerFactory.class); + pingTargets = mock(PingTargetManager.class); + when(pingTargets.getCommonPingTargets()).thenReturn(Collections.emptyList()); + Weblogger weblogger = mock(Weblogger.class); + when(weblogger.getPingTargetManager()).thenReturn(pingTargets); + factory.when(WebloggerFactory::getWeblogger).thenReturn(weblogger); + + ConfigurationManager configurationManager = new ConfigurationManager("xwork"); - configurationManager.addContainerProvider(new XWorkConfigurationProvider()); ++ configurationManager.addContainerProvider(new StrutsDefaultConfigurationProvider()); + Container container = configurationManager.getConfiguration().getContainer(); + stack = container.getInstance(ValueStackFactory.class).createValueStack(); + } + + @AfterEach + void tearDown() { + factory.close(); + } + + /** Set request parameters on the action the way the params interceptor does. */ + private void bind(Pings action, String name, String value) { + stack.push(action); + ReflectionContextState.setCreatingNullObjects(stack.getContext(), true); + ReflectionContextState.setDenyMethodExecution(stack.getContext(), true); + try { + stack.setParameter(name, value); + } finally { + ReflectionContextState.setCreatingNullObjects(stack.getContext(), false); + stack.pop(); + } + } + + @Test + void pingTargetFieldsInTheRequestDoNotMakeATarget() throws Exception { + Pings action = new Pings(); + bind(action, "pingTarget.pingUrl", "http://localhost:1/"); + action.myPrepare(); + + assertNull(action.getPingTarget()); + } + + @Test + void pingTargetIdSelectsAStoredTarget() throws Exception { + PingTarget stored = new PingTarget("target-1", "Stored", "http://ping.example.com/", false); + when(pingTargets.getPingTarget("target-1")).thenReturn(stored); + + Pings action = new Pings(); + bind(action, "pingTargetId", "target-1"); + bind(action, "pingTarget.pingUrl", "http://localhost:1/"); + action.myPrepare(); + + assertSame(stored, action.getPingTarget()); + assertSame("http://ping.example.com/", action.getPingTarget().getPingUrl()); + } + } diff --cc app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/UIActionInterceptorTest.java index 000000000,f0184e196..b75aaa68d mode 000000,100644..100644 --- a/app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/UIActionInterceptorTest.java +++ b/app/src/test/java/org/apache/roller/weblogger/ui/struts2/util/UIActionInterceptorTest.java @@@ -1,0 -1,78 +1,78 @@@ + /* + * 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.util; + + import java.util.HashMap; + import java.util.Map; + -import javax.servlet.http.HttpServletRequest; ++import jakarta.servlet.http.HttpServletRequest; + -import com.opensymphony.xwork2.ActionContext; -import com.opensymphony.xwork2.ActionInvocation; ++import org.apache.struts2.ActionContext; ++import org.apache.struts2.ActionInvocation; + import org.apache.roller.weblogger.pojos.User; + import org.apache.roller.weblogger.pojos.Weblog; + import org.apache.struts2.StrutsStatics; + import org.junit.jupiter.api.Test; + + import static org.junit.jupiter.api.Assertions.assertNull; + import static org.mockito.Mockito.mock; + import static org.mockito.Mockito.when; + + /** + * The interceptor must set the authenticated user and the action weblog from + * trusted sources only, overwriting anything bound from request parameters. + */ + class UIActionInterceptorTest { + + static class TestAction extends UIAction { + TestAction() { this.actionName = "test"; } + @Override public String execute() { return SUCCESS; } + } + + @Test + void parameterBoundUserAndWeblogAreOverwrittenWhenThereIsNoSession() throws Exception { + // An attacker-controlled request with no session: getSession(false) is null, + // so RollerSession.getRollerSession returns null. + HttpServletRequest request = mock(HttpServletRequest.class); + when(request.getSession(false)).thenReturn(null); + + // The action arrives with a user and weblog already bound from parameters. + TestAction action = new TestAction(); + User forgedUser = new User(); + forgedUser.setUserName("siteadmin"); + action.setAuthenticatedUser(forgedUser); + Weblog forgedWeblog = new Weblog(); + forgedWeblog.setHandle("team"); + action.setActionWeblog(forgedWeblog); + // No weblog handle parameter, so no weblog can resolve. + action.setWeblog(null); + + Map<String, Object> contextMap = new HashMap<>(); + contextMap.put(StrutsStatics.HTTP_REQUEST, request); - ActionContext context = new ActionContext(contextMap); ++ ActionContext context = ActionContext.of(contextMap); + + ActionInvocation invocation = mock(ActionInvocation.class); + when(invocation.getAction()).thenReturn(action); + when(invocation.getInvocationContext()).thenReturn(context); + when(invocation.invoke()).thenReturn(UIAction.SUCCESS); + + new UIActionInterceptor().doIntercept(invocation); + + assertNull(action.getAuthenticatedUser()); + assertNull(action.getActionWeblog()); + } + }
