Skip to content

Commit

Permalink
LUT-28235 : Archive action: adding a confirmation popup
Browse files Browse the repository at this point in the history
  • Loading branch information
@TimotheeHrl @husel-t
TimotheeHrl authored and husel-t committed Jan 6, 2025
1 parent 895dd63 commit 658b5a5
Show file tree
Hide file tree
Showing 2 changed files with 161 additions and 23 deletions.
171 changes: 152 additions & 19 deletions src/java/fr/paris/lutece/plugins/blog/web/BlogJspBean.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,6 @@ public class BlogJspBean extends ManageBlogJspBean
protected static final String PROPERTY_USE_UPLOAD_IMAGE_PLUGIN = "use_upload_image_plugin";
protected static final String PROPERTY_BLOG_ARCHIVE = "blog.manage_blog_archives.labelActionArchive";

// Properties
private static final String PROPERTY_DEFAULT_LIST_ITEM_PER_PAGE = "blog.listItems.itemsPerPage";

// Markers
protected static final String MARK_BLOG_LIST = "blog_list";
protected static final String MARK_BLOG_VERSION_LIST = "blog_version_list";
Expand Down Expand Up @@ -214,12 +211,22 @@ public class BlogJspBean extends ManageBlogJspBean
private static final String JSP_MANAGE_BLOGS = "jsp/admin/plugins/blog/ManageBlogs.jsp";

// Properties
private static final String PROPERTY_DEFAULT_LIST_ITEM_PER_PAGE = "blog.listItems.itemsPerPage";
private static final String MESSAGE_CONFIRM_REMOVE_BLOG = "blog.message.confirmRemoveBlog";
private static final String MESSAGE_ERROR_DOCUMENT_IS_PUBLISHED = "blog.message.errorDocumentIsPublished";
private static final String MESSAGE_CONFIRM_REMOVE_HISTORY_BLOG = "blog.message.confirmRemoveHistoryBlog";
private static final String ACCESS_DENIED_MESSAGE = "portal.message.user.accessDenied";
private static final String MESSAGE_CONFIRM_ARCHIVE_BLOG = "blog.message.confirmArchiveBlog";
private static final String MESSAGE_CONFIRM_ARCHIVE_MULTIPLE_BLOGS = "blog.message.confirmArchiveMultipleBlogs";
private static final String MESSAGE_CONFIRM_UNARCHIVE_MULTIPLE_BLOGS = "blog.message.confirmUnarchiveMultipleBlogs";
private static final String MESSAGE_CONFIRM_UNARCHIVE_BLOG= "blog.message.confirmUnarchiveBlog";
private static final String MESSAGE_CONFIRM_REMOVE_MULTIPE_BLOGS = "blog.message.confirmRemoveMultipleBlogs";

protected static final String MARK_BLOG_ACTION_LIST = "selection_action_list";
private static final String INFO_BLOG_UNARCHIVED = "blog.info.blog.blogUnarchived";
private static final String INFO_MULTIPLE_BLOGS_UNARCHIVED = "blog.info.blog.multipleBlogsUnarchived";
private static final String INFO_BLOG_ARCHIVED = "blog.info.blog.blogArchived";
private static final String INFO_MULTIPLE_BLOGS_ARCHIVED = "blog.info.blog.multipleBlogsArchived";
// Validations
private static final String VALIDATION_ATTRIBUTES_PREFIX = "blog.model.entity.blog.attribute.";

Expand Down Expand Up @@ -249,6 +256,11 @@ public class BlogJspBean extends ManageBlogJspBean
private static final String ACTION_UPDATE_ARCHIVE_MULTIPLE_BLOGS = "updateArchiveMultipleBlogs";
private static final String ACTION_REMOVE_MULTIPLE_BLOGS = "removeMultipleBlogs";
private static final String ACTION_EXECUTE_SELECTED_ACTION = "form_checkbox_action";
private static final String ACTION_CONFIRM_ARCHIVE_BLOG = "confirmArchiveBlog";
private static final String ACTION_ARCHIVE_BLOG = "archiveBlog";
private static final String ACTION_CONFIRM_ARCHIVE_BLOGS = "confirmArchiveBlogs";
private static final String ACTION_CONFIRM_UNARCHIVE_BLOGS = "confirmUnarchiveBlogs";

// Infos
private static final String INFO_BLOG_CREATED = "blog.info.blog.created";
private static final String INFO_BLOG_UPDATED = "blog.info.blog.updated";
Expand Down Expand Up @@ -465,9 +477,20 @@ public String getManageBlogs( HttpServletRequest request )
boolean bPermissionArchive = RBACService.isAuthorized( Blog.PROPERTY_RESOURCE_TYPE, RBAC.WILDCARD_RESOURCES_ID, Blog.PERMISSION_ARCHIVE,
(User) getUser( ) );

HttpSession session = request.getSession();

Map<String, Object> model = new HashMap<>( );
if( session.getAttribute(PARAMETER_INFO_MESSAGE ) != null )
{
Locale locale = request.getLocale( );
String messageKey = request.getSession().getAttribute(PARAMETER_INFO_MESSAGE).toString();
model.put( PARAMETER_INFO_MESSAGE, I18nService.getLocalizedString( messageKey, locale ) );
session.removeAttribute(PARAMETER_INFO_MESSAGE);
} else {
model.put( PARAMETER_INFO_MESSAGE, null );
}

model.put( MARK_STATUS_FILTER, _nIsUnpublished );
model.put( MARK_BLOG_ACTION_LIST, _listBlogActionsList );
model.put( MARK_BLOG_LIST, listDocuments );
model.put( MARK_PAGINATOR, paginator );
model.put( MARK_BLOG_FILTER_LIST, getBlogFilterList( ) );
Expand Down Expand Up @@ -1699,6 +1722,94 @@ private void removeMultipleBlogs( List<Integer> listBlogIds )
BlogHome.remove( blogId );
}
}
/**
* Display the confirmation message before one or multiple selected blog posts are removed
*
* @param request
* The Http request
* @return the html code to confirm the action
* @throws AccessDeniedException
*/
@Action( ACTION_CONFIRM_ARCHIVE_BLOGS )
public String getconfirmArchiveBlogs( HttpServletRequest request ) throws AccessDeniedException
{
// Check if the user has the permission to archive a blog
if ( !RBACService.isAuthorized( Blog.PROPERTY_RESOURCE_TYPE, RBAC.WILDCARD_RESOURCES_ID, Blog.PERMISSION_ARCHIVE,
(User) getUser( ) ) )
{
throw new AccessDeniedException( UNAUTHORIZED );
}

// Check if one of the blog selected is currently locked. Display a message and redirect the user if it's the case
if ( checkLockMultipleBlogs( request.getSession( ).getId( ) ) )
{
UrlItem url = new UrlItem( getActionUrl( VIEW_MANAGE_BLOGS ) );
String strMessageUrl = AdminMessageService.getMessageUrl( request, BLOG_LOCKED, url.getUrl( ), AdminMessage.TYPE_STOP );
return redirect( request, strMessageUrl );
}

UrlItem url = new UrlItem( getActionUrl( ACTION_UPDATE_ARCHIVE_MULTIPLE_BLOGS ) );
url.addParameter( PARAMETER_SELECTED_BLOGS, _listSelectedBlogIds.stream( ).map( String::valueOf ).collect( Collectors.joining( "," ) ) );
url.addParameter( PARAMETER_TO_ARCHIVE, String.valueOf( true ));
// Check if there's 1 or multiple posts being archived, to adapt the content of the displayed message
String confirmationMessage = _listSelectedBlogIds.size( ) > 1 ? MESSAGE_CONFIRM_ARCHIVE_MULTIPLE_BLOGS : MESSAGE_CONFIRM_ARCHIVE_BLOG;
if( _listSelectedBlogIds.size( ) > 1 )
{
Object [ ] messageArgs = {
_listSelectedBlogIds.size( )
};
return redirect( request, AdminMessageService.getMessageUrl( request, confirmationMessage, messageArgs, url.getUrl( ), AdminMessage.TYPE_CONFIRMATION ));
}
else
{
return redirect( request, AdminMessageService.getMessageUrl( request, confirmationMessage, url.getUrl( ), AdminMessage.TYPE_CONFIRMATION ));
}
}
/**
* Display the confirmation message before one or multiple selected blog posts are archived
*
* @param request
* The Http request
* @return the html code to confirm the action
* @throws AccessDeniedException
*/
@Action( ACTION_CONFIRM_UNARCHIVE_BLOGS )
public String getconfirmUnarchiveBlogs( HttpServletRequest request ) throws AccessDeniedException
{
// Check if the user has the permission to archive a blog
if ( !RBACService.isAuthorized( Blog.PROPERTY_RESOURCE_TYPE, RBAC.WILDCARD_RESOURCES_ID, Blog.PERMISSION_ARCHIVE,
(User) getUser( ) ) )
{
String strMessage = I18nService.getLocalizedString( ACCESS_DENIED_MESSAGE, request.getLocale( ) );
throw new AccessDeniedException( strMessage );
}

// Check if one of the blog selected is currently locked. Display a message and redirect the user if it's the case
if ( checkLockMultipleBlogs( request.getSession( ).getId( ) ) )
{
UrlItem url = new UrlItem( getActionUrl( VIEW_MANAGE_BLOGS ) );
String strMessageUrl = AdminMessageService.getMessageUrl( request, BLOG_LOCKED, url.getUrl( ), AdminMessage.TYPE_STOP );
return redirect( request, strMessageUrl );
}

UrlItem url = new UrlItem( getActionUrl( ACTION_UPDATE_ARCHIVE_MULTIPLE_BLOGS ) );
url.addParameter( PARAMETER_SELECTED_BLOGS, _listSelectedBlogIds.stream( ).map( String::valueOf ).collect( Collectors.joining( "," ) ) );
url.addParameter( PARAMETER_TO_ARCHIVE, String.valueOf( false ));
// Check if there's 1 or multiple posts being archived, to adapt the content of the displayed message
String confirmationMessage = _listSelectedBlogIds.size( ) > 1 ? MESSAGE_CONFIRM_UNARCHIVE_MULTIPLE_BLOGS : MESSAGE_CONFIRM_UNARCHIVE_BLOG;
if( _listSelectedBlogIds.size( ) > 1 )
{
Object [ ] messageArgs = {
_listSelectedBlogIds.size( )
};
return redirect( request, AdminMessageService.getMessageUrl( request, confirmationMessage, messageArgs, url.getUrl( ), AdminMessage.TYPE_CONFIRMATION ));
}
else
{
return redirect( request, AdminMessageService.getMessageUrl( request, confirmationMessage, url.getUrl( ), AdminMessage.TYPE_CONFIRMATION ) );
}
}

/**
* Handles the manual archiving of multiple blog posts
*
Expand All @@ -1718,7 +1829,7 @@ public String doArchiveMultipleBlog( HttpServletRequest request ) throws AccessD
}

// Get a List of the selected posts' IDs, from the current session
_listSelectedBlogIds = getSelectedBlogPostsIds( request );
_listSelectedBlogIds = (List<Integer>) request.getSession( ).getAttribute( PARAMETER_SELECTED_BLOG_IDS_LIST );

// Check if any of the selected post is being modified by another user
if ( checkLockMultipleBlogs( request.getSession( ).getId( ) ) )
Expand All @@ -1728,17 +1839,43 @@ public String doArchiveMultipleBlog( HttpServletRequest request ) throws AccessD
return redirect( request, strMessageUrl );
}
// Archive the selected blog posts
if( request.getParameter( PARAMETER_TO_ARCHIVE ) != null)
Boolean bArchive = Boolean.parseBoolean( request.getParameter( PARAMETER_TO_ARCHIVE ) );
updateArchiveMultipleBlogs( _listSelectedBlogIds, bArchive );
HttpSession session = request.getSession();
session.setAttribute( PARAMETER_INFO_MESSAGE, getArchivedResultMessageKey( bArchive, _listSelectedBlogIds ) );
return redirectView( request, VIEW_MANAGE_BLOGS );
}

/**
* Get the key of the message to display after the archiving of multiple blog posts
* @param toArchived
* @param listBlogIds
* @return the key of the message to display
*/
private String getArchivedResultMessageKey(Boolean toArchived, List<Integer> listBlogIds)
{
if(toArchived)
{
Boolean bArchive = Boolean.parseBoolean( request.getParameter( PARAMETER_TO_ARCHIVE ) );
updateArchiveMultipleBlogs( _listSelectedBlogIds, bArchive );
} else
if(listBlogIds.size() == 1)
{
return INFO_BLOG_ARCHIVED;
}
else
{
return INFO_MULTIPLE_BLOGS_ARCHIVED;
}
}
else
{
Boolean bArchive = Boolean.parseBoolean( request.getAttribute( PARAMETER_TO_ARCHIVE ).toString( ) );
updateArchiveMultipleBlogs( _listSelectedBlogIds, bArchive );
request.removeAttribute( PARAMETER_TO_ARCHIVE );
if(listBlogIds.size() == 1)
{
return INFO_BLOG_UNARCHIVED;
}
else
{
return INFO_MULTIPLE_BLOGS_UNARCHIVED;
}
}
return redirectView( request, VIEW_MANAGE_BLOGS );
}

/**
Expand Down Expand Up @@ -1772,15 +1909,11 @@ public String doExecuteSelectedAction( HttpServletRequest request ) throws Acces
// Execute the action selected by the user
if ( selectedActionId == 0 )
{
// add parameter to the request to_archive=true
request.setAttribute( PARAMETER_TO_ARCHIVE, Boolean.TRUE.toString( ) );
return doArchiveMultipleBlog( request );
return getconfirmArchiveBlogs( request );
}
else if ( selectedActionId == 1 )
{
// add parameter to the request to_archive=false
request.setAttribute( PARAMETER_TO_ARCHIVE, Boolean.FALSE.toString( ) );
return doArchiveMultipleBlog( request );
return getconfirmUnarchiveBlogs( request );
}
else if ( selectedActionId == 2 )
{
Expand Down
13 changes: 9 additions & 4 deletions webapp/WEB-INF/templates/admin/plugins/blog/manage_blogs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,15 @@
<@tform id='form_checkbox_action' name='form_checkbox_action' method='post' class='p-0' action='jsp/admin/plugins/blog/ManageBlogs.jsp'>
<@input type='hidden' id='action' name='action' value='form_checkbox_action' />
<#assign idx=0 />
<#if info_message?? && info_message?trim !=''>
<@initToast>
<@addToast content=info_message class='text-bg-info border-0' />
</@initToast>
</#if>
<#if permission_manage_archive_blog || permission_manage_delete_blog>
<@div class='d-flex flex-row'>
<@inputGroup class='p-2'>
<@select id='select_blog_action' name='select_blog_action' title='#i18n{blog.manage_blogs.selectActionToApply}' class='p-2'>
<@select id='select_blog_action' name='select_blog_action' title='#i18n{blog.manage_blogs.selectActionToApply}' class='p-2' disabled=true>
<#if permission_manage_archive_blog>
<option value=1 >#i18n{blog.manage_blogs.labelUnarchive}</option>
<option value=0 selected>#i18n{blog.manage_blogs.labelArchive}</option>
Expand Down Expand Up @@ -202,10 +207,10 @@
</#if>
</@btnGroup>
<#if permission_manage_archive_blog>
<#if blog.isArchived() >
<@aButton href='jsp/admin/plugins/blog/ManageBlogs.jsp?action=updateArchiveMultipleBlogs&amp;to_archive=true&amp;select_blog_id=${blog.id}' title='#i18n{blog.manage_blog_archives.labelActionUnarchive}' buttonIcon='archive' hideTitle=['all'] color='warning' />
<#if blog.isArchived() >
<@aButton href='jsp/admin/plugins/blog/ManageBlogs.jsp?action=form_checkbox_action&amp;select_blog_action=1&amp;select_blog_id=${blog.id}' title='#i18n{blog.manage_blog_archives.labelActionUnarchive}' buttonIcon='archive' hideTitle=['all'] color='info' />
<#else>
<@aButton href='jsp/admin/plugins/blog/ManageBlogs.jsp?action=updateArchiveMultipleBlogs&amp;to_archive=false&amp;select_blog_id=${blog.id}' title='#i18n{blog.manage_blog_archives.labelActionArchive}' buttonIcon='archive' hideTitle=['all'] color='info' />
<@aButton href='jsp/admin/plugins/blog/ManageBlogs.jsp?action=form_checkbox_action&amp;select_blog_action=0&amp;select_blog_id=${blog.id}' title='#i18n{blog.manage_blog_archives.labelActionArchive}' buttonIcon='archive' hideTitle=['all'] color='warning' />
</#if>
</#if>
<#if permission_manage_delete_blog>
Expand Down

0 comments on commit 658b5a5

Please sign in to comment.