budgie-wallstreet applet custom folder with whitespace

[Kai Koenig]

[ Impact ]

 * Wallstreet is an app designed to switch desktop wallpapers at a user defined interval. When a custom path to the wallpapers is selected, if there is a space in the path, Wallstreet will fail to find the selected images. As a result, no desktop wallpaper will be displayed at all.

 * This creates an issue, as it is common for users to create paths with spaces. Therefore, they may be completely unaware that a space in a folder will cause this failure, especially since selecting the folder will give no indication otherwise. Since the app will no longer correctly find these images, it will appear that the app is broken or not running with no obviousreason why.

 * When the custom path is selected, the white space is saved as %20, which is not correctly translated back when Wallstreet attempts to change the image. The method used to read the user selected folder path has been updated to correctly allow paths with white spaces.

[ Test Plan ]

 * To Reproduce:
   - create a folder with a space in it, such as "~/Pictures/Desktop Backgrounds" and save desired desktop wallpapers to this folder.
   - Enusre Wallstreet is installed
   - Run Wallstreet Control from the menu
   - Uncheck "Use Default Wallpapers"
   - Click "Browse" and select the folder with the space
   - Check "Run Wallstreet"
   - Note how the desktop wallpaper disappears (in my instance, replaced with a solid blue background)
   - at the interval selected, still no wallpaper will load

 * After applying the fix, follow the same steps listed above.
   - Wallpapers correctly are displayed.
   - Wallpapers change at the correct interval

[ Where problems could occur ]

In instances where a user has already selected a path containing a space, they may to re-select the desired folder.

---

I have a folder of background images that I want to rotate through via wallstreet.

For historical reasons, that lives in a directory that gets automatically synced across multiple of my machines and the folder name has a white space in it: ~/Pictures/Background Images

I can obviously fix this on my end by using a folder without a white space in it (and I have confirmed it works fine then), but I noticed a curious behaviour of the file/folder picker in the wallstreet control tool.

When I navigate to the folder, it gets selected and stored as: /home/kai/Pictures/Background%20Images, using a %20 as the space indicator. The applet then doesn’t work and I have this in syslog:

wallstreet-autostart.desktop[24507]: Error opening directory “/home/kai/Pictures/Background%20Images”: No such file or directory

Access to the dir this way in a shell similarly fails:

$ ls /home/kai/Pictures/Background%20Images ls: cannot access '/home/kai/Pictures/Background%20Images': No such file or directory

The correct way to access the directory would be

$ ls /home/kai/Pictures/Background\ Images/

Ideally the folder picker from wallstreet would create this notation for a folder with a white space in its name instead.

ProblemType: Bug
DistroRelease: Ubuntu 22.04
Package: budgie-wallstreet 1.4.0-1ubuntu2
ProcVersionSignature: Ubuntu 5.13.0-7619.19~1634227653~21.10~601fc07~dev-generic 5.13.14
Uname: Linux 5.13.0-7619-generic x86_64
ApportVersion: 2.20.11-0ubuntu82
Architecture: amd64
CasperMD5CheckResult: unknown
CurrentDesktop: Budgie:GNOME
Date: Sun May 1 19:37:48 2022
SourcePackage: budgie-extras
UpgradeStatus: Upgraded to jammy on 2022-04-30 (1 days ago)

[fossfreedom (fossfreedom)]

Resolved by commits https://github.com/UbuntuBudgie/budgie-extras/commit/0bb31a713c2b6dd46010cef0379ca8500c3929c4 and https://github.com/UbuntuBudgie/budgie-extras/commit/6f5f6d01657db939a61f2ec8a36805631ccac29e

Suitable for SRU when we have a similar "affects" both kinetic and jammy budgie-extras bug

[Timo Aaltonen (tjaalton)]

Hello Kai, or anyone else affected,

Accepted budgie-extras into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/budgie-extras/1.4.0-1ubuntu3 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-jammy to verification-done-jammy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-jammy. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Sam Lane (samlane00)]

Confirmed package resolves this issue.

Installed budgie-wallstreet 1.4.0-1ubuntu3 from proposed:
 - selected folder with a space in it
 - enabled wallstreet
 - confirmed the correct folder was selected and background was displayed properly
 - confirmed at the interval selected, new wallpaper correctly loaded
 - tested again on additional install

[Launchpad Janitor (janitor)]

This bug was fixed in the package budgie-extras - 1.4.0-1ubuntu3

---------------
budgie-extras (1.4.0-1ubuntu3) jammy; urgency=medium

  [ Samuel Lane ]
  * Bug-fixes
    Prevent certain applets from exiting early after login
    - ensure Showtime applet stays running after login
      Use-Idle.add-to-spawn-Showtime-Desktop.patch (LP: #1999887)
    - ensure Weathershow desktop weather does not close early
      Use-Idle.add-to-spawn-desktop-weather.patch (LP: #1999887)
    - ensure background process for Dropby stays running after login
      Fix-occasional-bail-out-of-dropby-dropover-due-to-ti.patch (LP: 1999887)
    - ensure Workspace Wallpaper Switcher stays running after login
      Use-Idle.add-to-spawn-external-app.patch (LP: #1999887)
    - fix Wallstreet when using custom directories with spaces
      Fixed-wallstreet-for-custom-dir-with-spaces.patch (LP: #1971073)
      Removed-print-statement-for-testing.patch

 -- David Mohammed <email address hidden> Sun, 21 May 2023 10:58:25 +0100

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for budgie-extras has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.