Fix: redirect to home page after a paste is deleted

[Parthiv-M]

This PR fixes #1156

Changes

• Once a paste is deleted, the alert is displayed and the user is redirected to the home page after 5 seconds
• The alert has been changed to be of type alert-success (green coloured) if $STATUS equals the Paste was properly deleted. message; alert-info otherwise

[Parthiv-M]

Hi @rugk, would be great if you can take a look at this patch :)

[elrido]

With these two comments resolved, my only concern remaining is the UX one - forcing a reload without user interaction might hide the message before they see it. For this reason I prefer the current behaviour where the user has to explicitly click on the "New" button to move on to create a new paste (if that is what they want - maybe they rather take a screenshot as proof, or just close the browser tab).

Let's give the other maintainers a chance to speak up on this. If no one is opposed though, I'm willing to merge it, after updating the SRI-hashes and documenting the change in the changelog.

[Parthiv-M]

I have a suggestion from the UX perspective that could probably be better than the current method of clicking on the PrivateBin logo to go back to the home page: inside the green alert itself, we place a button that says something like <-- Back home or <-- Create new paste with the <-- being replaced by a icon.

Happy to hear feedback from the maintainers about this :)

[elrido]

[...] inside the green alert itself, we place a button that says something like <-- Back home or <-- Create new paste with the <-- being replaced by a icon.

That would be a lot better, IMHO. It could be a button with icon, maybe styled just like the new button? For example, in the bootstrap5.php template:

                <div id="status" role="alert" class="alert alert-<?php echo ($STATUS == 'Paste was properly deleted.' ? 'success' : 'info'), (empty($STATUS) ? ' hidden' : '') ?>">
                    <svg width="16" height="16" fill="currentColor" aria-hidden="true"><use href="img/bootstrap-icons.svg#info-circle" /></svg>
                    <?php echo I18n::encode($STATUS), PHP_EOL; ?>
                </div>
<?php
if ($STATUS == 'Paste was properly deleted.') :
?>
                <button type="button" class="btn btn-secondary flex-fill" onclick="$.PrivateBin.UiHelper.reloadHome()">
                    <svg width="16" height="16" fill="currentColor" aria-hidden="true"><use href="img/bootstrap-icons.svg#file-earmark" /></svg> <?php echo I18n::_('New'), PHP_EOL; ?>
                </button>
<?php
endif;
?>

Aside: I realize now that this will only work for English, as the $STATUS contains an already translated message. We may have to detect this around the below line in the controller and assign some other, boolean flag, say isDeleted to the view that we can more easily check in the above logic: https://github.com/PrivateBin/PrivateBin/blob/d69d29f3a940b443760f1e227df6628e3f4cfb3f/lib/Controller.php#L414

[Parthiv-M]

Ah, makes sense! Let me try to make these changes and update this patch

[Parthiv-M]

So, I've made the following changes:

• [x] Included a new status message in the Controller that can track the deletion and pass the deleted status to the template
• [x] Added an event listener for the New button inside the alert, because adding an onclick in the template would cause issues with loading the jquery function (due to CSP config)

Previews

The button with Bootstrap 5

The button with Bootstrap 3 has a few options, I've pushed the one that looked best to me, but it is up for suggestions/changes :)

• btn-default (pushed)

• btn-primary

• btn-secondary

[rugk]

Did not you want to name it differently than "New"? "Back"? Without context, at this position, it is quite unclear IHMO, what "new" thing can be created here?

Ideas:

• either place it back into the toolbar, where it usually is shown aka the "New" button. People likely will be accustomed to that behavior.
• Or maybe keep it there, but clarify the name more, like "Start over" or maybe just "Okay", which redirects to the home page. Just some kind of general acknowledgement that does not arise questions what new thing could be done or whether the paste will be resurrected… whatever :wink:

[Parthiv-M]

Did not you want to name it differently than "New"?

I want to go for New Paste, I'll make that change

[Parthiv-M]

Additionally, is there something I need to do to update the SRIs? And the changelog? If you can give me links to some docs, I can do that too.

[rugk]

Better than "New" in any case, though I liked the other options a bit more (with changed icons like a reload one or so of course).

About SRI: see https://github.com/PrivateBin/PrivateBin/wiki/Development#subresource-integrity-for-javascript-resources please

And the Changelog yeah, you can add an entry there if you feel like doing so.

[Parthiv-M]

Hi @rugk, I've made the following changes

• Updated the text (to Start over) and the icon (to a repeat icon)
• Updated the CHANGELOG.md file

I had one query (which is also why one test is failing in the CI): do I have to add keys and values for all the languages (every <lang-code>.json file)? If so, I can do that (and push the SRI fix) and everything should be done.