Tray icon missing/empty/not shown correctly #1306

emtiu · 2022-09-22T21:50:19Z

This is an attempt to combine/summarize multiple reports of the systray (notification area) icon being missing/empty/malformed, with a total of 9 users reporting as being affected, namely:

1 affected user: Tray icon missing under Elementary OS Loki #849
5 affected users: System tray icon appears during the backup, but with no icon #1098
1 affected user: No tray icon on KDE openSUSE Tumbleweed #1152
3 affected users: Systray icon missing / empty #1236 (related: No tray icons when running as root #1240)

backintime versions affected

Although the code relating to the systray icon has changed significantly since 1.1.0 (see below: "Past progress bar over systray feature (1.1.0 until 1.1.24)"), there is at least one report of version 1.3.2 being affected: #1098 (comment)

Useful logs

From #1098, 2 users reporting identical messages (both for root jobs):

Jul 20 10:35:01 j python[80624]: backintime (root/1): INFO: Take a new snapshot. Profile: 1 Main profile
Jul 20 10:35:01 j python[80624]: backintime (root/1): INFO: Call rsync to take the snapshot
Jul 20 10:35:01 j python[80629]: QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-root'
Jul 20 10:35:01 j python[80629]: QPainter::begin: Paint device returned engine == 0, type: 2
Jul 20 10:35:01 j python[80629]: QWidget::render: Cannot render with an inactive painter
Jul 20 10:35:01 j python[80629]: QSystemTrayIcon::setVisible: No Icon set
Jul 20 10:35:08 j python[80624]: backintime (root/1): INFO: Save config file
Jul 20 10:35:08 j python[80624]: backintime (root/1): INFO: Save permissions

Past progress bar over systray feature (1.1.0 until 1.1.24)

Version 1.1.0 introduced a progress bar displayed over the systray icon:

backintime/CHANGES

Line 313 in ab24e10

* add ProgressBar for rsync

… but it caused trouble, as @Germar commented: #849 (comment)

That's a problem on how I solved the progress bar in the tray icon. It will load a different icon as soon as it prints the progress bar. Should be fixed as soon as we have a proper BiT icon which will have a progress indicator by it self. I already have an idea for that...

… as well as here: #496 (comment)

I couldn't reproduce the high CPU/memory usage on Kubuntu 15.10 but the progress bar doesn't show up either. That line should render a progress bar on top of the systray icon. It's a little hack I used to show progress in systray.

In the end, it was removed in 1.2.0:

backintime/CHANGES

Line 41 in ab24e10

    
           * remove progressbar on systray icon until BiT has it's own icon (https://github.com/bit-team/backintime/issues/902)

Current best guess: backintime cannot find icon from system theme to use

Backintime has no icon of its own (#215), so it uses the "save" icon (Icon=document-save in its .desktop file on Kubuntu) from any given Desktop Environment/theme as its main icon, both in menus and in the system tray. The same strategy is employed to set backintime's icon in Qt:

backintime/qt/icon.py

Line 25 in ab24e10

BIT_LOGO = QIcon.fromTheme('document-save')

It might be the case that such an icon cannot be found in certains circumstances (in order of decreasing likelihood):

the root user doesn't have the right paths set (Systray icon missing / empty #1236 (comment))
an unusual combination of theme/DE is active,
there is no DE installed (System tray icon appears during the backup, but with no icon #1098 (comment))

The text was updated successfully, but these errors were encountered:

aryoda · 2022-10-18T19:41:14Z

Perhaps my PR #1336 for issue #1244 is fixing this issue too (even though it is only meant for Wayland, not X11).

When I find the time I will look into this master issue too...

BTW: There is a difference running BiT as root user (not recommended) and with sudo:

echo $HOME

as root delivers /root
with sudo delivers /home/<user with sudo rights>
with pkexec (what the BiT root starter script calls) delivers the same as with sudo.

The home folder may affect the availability of installed icons perhaps but if
BiT was started via the desktop icon it should be at least accessible.

aryoda · 2022-11-16T22:59:04Z

Looking into all the issues I also think that a missing "standard" icon is the root cause and it is my strong suspicion that we should use QIcon::fromTheme("document-save", QIcon(":/undo.png")); (https://doc.qt.io/qt-5/qicon.html#fromTheme-1)
instead of the currently implemented

backintime/qt/icon.py

Lines 24 to 25 in e36d8dc

    
           #BackInTime Logo 
        
           BIT_LOGO            = QIcon.fromTheme('document-save')

to enable a default logo for the tray icon when the current theme does not contain the BiT logo icon.

Instead of the undo.png we could provide a self-painted logo (artists - this is your chance now ;-)

Also we should check and log if the desktop environment does support a tray icon at all and write at least a info message if not.

Here are some commands to run some diagnostics in the current environment that works from the command line.

Since the BiT starter scripts to manipulate some env vars I would suggest to add (append) these lines into the /usr/share/backintime/qt/backintime-qt script file to support tests as normal (unprivileged) and root user:

python3 -c "from PyQt5.QtWidgets import QSystemTrayIcon,QApplication; app = QApplication(['']); print('isSystemTrayAvailable: ' + str(QSystemTrayIcon.isSystemTrayAvailable()))"
python3 -c "from PyQt5.QtGui import QIcon; from PyQt5.QtWidgets import QApplication; app = QApplication(['']); print('Theme name: ' + QIcon.themeName())"
python3 -c "from PyQt5.QtGui import QIcon; from PyQt5.QtWidgets import QApplication; app = QApplication(['']); print('has theme icon <document-save>: ' + str(QIcon.hasThemeIcon('document-save')))"
python3 -c "from PyQt5.QtGui import QIcon; from PyQt5.QtWidgets import QApplication; app = QApplication(['']); print(QIcon.themeSearchPaths()); print(QIcon.fallbackSearchPaths())"

The output on my Ubuntu 20.04 with Gnome3 and X11 as user is:

isSystemTrayAvailable: True
Theme name: Yaru
has theme icon <document-save>: True
['/usr/local/share/icons', '/usr/share/icons', '/var/lib/snapd/desktop/icons', ':/icons']
[]

On Manjaro KDE Plasma with Wayland I get (as user):

isSystemTrayAvailable: True
Theme name: breeze
has theme icon <document-save>: True
['/usr/share/icons', ':/icons']
[]

emtiu · 2022-11-17T08:25:59Z

So, if I understand correctly, this would try to load document-save as backintime's icon, but fallback to undo if that's not found? Sounds like a very good solution to me!

But we'd need to check if we can reasonably expect undo to exist in situations where document-save doesn't. The best test would probably be to reproduce the abovementioned Issues, and/or ask affected users to test new code.

aryoda · 2022-11-17T09:20:38Z

undo is just an example, there are better Qt5 built-in icons (incl. a disk). Yes, I want to reproduce the prob first in my VM to understand the cause (no guessed fixing) Am 17. November 2022 09:26:10 MEZ schrieb "Michael Büker" ***@***.***>:

…

So, if I understand correctly, this would try to load `document-save` as backintime's icon, but fallback to `undo` if that's not found? Sounds like a very good solution to me! But we'd need to check if we can reasonably expect `undo` to exist in situations where `document-save` doesn't. The best test would probably be to reproduce the abovementioned Issues, and/or ask affected users to test new code. -- Reply to this email directly or view it on GitHub: #1306 (comment) You are receiving this because you commented. Message ID: ***@***.***>

aryoda · 2022-11-20T20:09:43Z

I kindly ask all affected users who still do not see the tray icon during taking a backup to run the appropriate diagnostics scripts below in a terminal and show the output in your issue (if still open) or here (if closed) to help me to identify all possible reasons. THX a lot!

If you are not sure if the tray icon is working you can force a backup check of a configured profile via

backintime --profile-id 1 --debug backup-job

and you should see the sys tray icon then for at least a few seconds (until the backup finishes).

Please show the output of

# must show the an exit code of 0 (zero)
xdpyinfo > /dev/null && echo $?

and one of the following scripts:

For BiT running as user (not as root) - works for both X11 and Wayland:

python3 -c "
from PyQt5.QtGui import QIcon;
from PyQt5.QtWidgets import QSystemTrayIcon,QApplication,QStyleFactory;
import os
qapp = QApplication(['']);
env_var = 'XDG_SESSION_TYPE'; print(f'Display Server={os.environ.get(env_var)}');
print((f'QT QPA platform plugin: {qapp.platformName()}'));
env_var = 'QT_QPA_PLATFORMTHEME'; print(f'QT_QPA_PLATFORMTHEME={os.environ.get(env_var)}');
env_var = 'QT_STYLE_OVERRIDE'; print(f'QT_STYLE_OVERRIDE={os.environ.get(env_var)}');
print(f'QT active style: {qapp.style().objectName()}');
print(f'QT fallback style: {QIcon.fallbackThemeName()}');
print(f'QT supported styles: {QStyleFactory.keys()}');
print(f'themeSearchPaths: {str(QIcon.themeSearchPaths())}');
print(f'fallbackSearchPaths: {str(QIcon.fallbackSearchPaths())}');
print(f'Is SystemTray available: {str(QSystemTrayIcon.isSystemTrayAvailable())}');
icon_name = 'document-save'; print(f'has theme icon <document-save>: {str(QIcon.hasThemeIcon(icon_name))}');"

For BiT running as root with X11 as display server:

pkexec env DISPLAY=$DISPLAY XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR XAUTHORITY=$XAUTHORITY python3 -c "
from PyQt5.QtGui import QIcon;
from PyQt5.QtWidgets import QSystemTrayIcon,QApplication,QStyleFactory;
import os
qapp = QApplication(['']);
env_var = 'XDG_SESSION_TYPE'; print(f'Display Server={os.environ.get(env_var)}');
print((f'QT QPA platform plugin: {qapp.platformName()}'));
env_var = 'QT_QPA_PLATFORMTHEME'; print(f'QT_QPA_PLATFORMTHEME={os.environ.get(env_var)}');
env_var = 'QT_STYLE_OVERRIDE'; print(f'QT_STYLE_OVERRIDE={os.environ.get(env_var)}');
print(f'QT active style: {qapp.style().objectName()}');
print(f'QT fallback style: {QIcon.fallbackThemeName()}');
print(f'QT supported styles: {QStyleFactory.keys()}');
print(f'themeSearchPaths: {str(QIcon.themeSearchPaths())}');
print(f'fallbackSearchPaths: {str(QIcon.fallbackSearchPaths())}');
print(f'Is SystemTray available: {str(QSystemTrayIcon.isSystemTrayAvailable())}');
icon_name = 'document-save'; print(f'has theme icon <document-save>: {str(QIcon.hasThemeIcon(icon_name))}');"

For BiT running as root with Wayland as display server:

pkexec env QT_QPA_PLATFORM=wayland-egl XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR XAUTHORITY=$XAUTHORITY python3 -c "
from PyQt5.QtGui import QIcon;
from PyQt5.QtWidgets import QSystemTrayIcon,QApplication,QStyleFactory;
import os
qapp = QApplication(['']);
env_var = 'XDG_SESSION_TYPE'; print(f'Display Server={os.environ.get(env_var)}');
print((f'QT QPA platform plugin: {qapp.platformName()}'));
env_var = 'QT_QPA_PLATFORMTHEME'; print(f'QT_QPA_PLATFORMTHEME={os.environ.get(env_var)}');
env_var = 'QT_STYLE_OVERRIDE'; print(f'QT_STYLE_OVERRIDE={os.environ.get(env_var)}');
print(f'QT active style: {qapp.style().objectName()}');
print(f'QT fallback style: {QIcon.fallbackThemeName()}');
print(f'QT supported styles: {QStyleFactory.keys()}');
print(f'themeSearchPaths: {str(QIcon.themeSearchPaths())}');
print(f'fallbackSearchPaths: {str(QIcon.fallbackSearchPaths())}');
print(f'Is SystemTray available: {str(QSystemTrayIcon.isSystemTrayAvailable())}');
icon_name = 'document-save'; print(f'has theme icon <document-save>: {str(QIcon.hasThemeIcon(icon_name))}');"

The output does look similar to this (with other values):

Display Server=x11
QT QPA platform plugin: xcb
QT_QPA_PLATFORMTHEME=qt5ct
QT_QPA_PLATFORMTHEME=None
QT active style: qt5ct-style
QT fallback style: 
QT supported styles: ['Breeze', 'cleanlooks', 'gtk2', 'cde', 'motif', 'plastique', 'qt5ct-style', 'Windows', 'Fusion']
themeSearchPaths: ['/home/user/.local/share/icons', '/usr/local/share/icons', '/usr/share/icons', '/var/lib/snapd/desktop/icons', ':/icons']
fallbackSearchPaths: []
Is SystemTray available: True
has theme icon <document-save>: True

aryoda · 2023-02-03T23:53:24Z

I have created a new separate bug (see # 1404) for this message (that is shown sometimes when the systray icon does not show-up) since it also occurs in other contexts (e. g. unit tests):

Jul 20 10:35:01 j python[80629]: QPainter::begin: Paint device returned engine == 0, type: 2
Jul 20 10:35:01 j python[80629]: QWidget::render: Cannot render with an inactive painter

…" issues (#1159, #1236, #1364) Candidate to fix all major sys-tray icon and missing app icon issues (#1159, #1236, #1306, #1364). Refactor qtsystrayiconplugin.py

aryoda · 2023-07-17T21:27:14Z

I have fixed all known issues (hopefully) with my PR #1480, re-testing and feed-back welcome!

aryoda · 2023-09-04T19:51:05Z

I am closing this now as fixed.

Please open a new issue in case of any problems (to get rid of this and the other related issues that are old and have along history of discussions)...

emtiu added High Qt Qt bugs, code or features Distro-Specific only for certain distributions, desktop environments or display servers Bug labels Sep 22, 2022

This was referenced Sep 22, 2022

System tray icon appears during the backup, but with no icon #1098

Closed

No tray icon on KDE openSUSE Tumbleweed #1152

Closed

Systray icon missing / empty #1236

Closed

emtiu added Meta Discussion decision or consensus needed labels Sep 23, 2022

emtiu mentioned this issue Oct 21, 2022

No systray icon when running as root #408

Closed

emtiu added this to the 1.3.3 milestone Nov 6, 2022

emtiu pinned this issue Nov 8, 2022

emtiu mentioned this issue Nov 17, 2022

[OpenSuSE rolling] Missing icons in SSH private key buttons (BiT root) #1364

Closed

aryoda mentioned this issue Nov 20, 2022

Show snapshot progress on cli #1131

Open

aryoda self-assigned this Nov 22, 2022

aryoda mentioned this issue Nov 24, 2022

GUI icons KDE Plasma compatibility fix suggestion #1159

Closed

aryoda mentioned this issue Dec 9, 2022

Wrong icon of "View last log" in backintime-qt #1386

Closed

scaramangado mentioned this issue Feb 4, 2023

backintime CLI shows Qt5 warning (QWidget::render: Cannot render with an inactive painter) #1404

Open

aryoda mentioned this issue Feb 7, 2023

BiT system tray icon process may use wrong config file and share path due to missing --config and --share-path arguments #1405

Open

buhtz modified the milestones: 1.3.3, 1.3.4 Feb 19, 2023

buhtz mentioned this issue Jul 6, 2023

Why use setThemeName() and why is it never reached? #1468

Closed

aryoda mentioned this issue Jul 17, 2023

Fix master issue 1306 (system-tray icon) and releated "missing icons" issues #1480

Merged

aryoda mentioned this issue Aug 1, 2023

Back-in-time hangs on xdpyinfo #854

Closed

buhtz modified the milestones: 2nd release from now, 1.4.0 (upcoming release) Aug 21, 2023

aryoda closed this as completed Sep 4, 2023

buhtz unpinned this issue Sep 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tray icon missing/empty/not shown correctly #1306

Tray icon missing/empty/not shown correctly #1306

emtiu commented Sep 22, 2022 •

edited

Loading

aryoda commented Oct 18, 2022 •

edited

Loading

aryoda commented Nov 16, 2022 •

edited

Loading

emtiu commented Nov 17, 2022

aryoda commented Nov 17, 2022 via email •

edited by emtiu

Loading

aryoda commented Nov 20, 2022 •

edited

Loading

aryoda commented Feb 3, 2023

aryoda commented Jul 17, 2023

aryoda commented Sep 4, 2023

Tray icon missing/empty/not shown correctly #1306

Tray icon missing/empty/not shown correctly #1306

Comments

emtiu commented Sep 22, 2022 • edited Loading

backintime versions affected

Distributions affected (where known)

Graphics/Desktop Environments (where known)

user account for backintime job

Useful logs

Past progress bar over systray feature (1.1.0 until 1.1.24)

Current best guess: backintime cannot find icon from system theme to use

aryoda commented Oct 18, 2022 • edited Loading

aryoda commented Nov 16, 2022 • edited Loading

emtiu commented Nov 17, 2022

aryoda commented Nov 17, 2022 via email • edited by emtiu Loading

aryoda commented Nov 20, 2022 • edited Loading

aryoda commented Feb 3, 2023

aryoda commented Jul 17, 2023

aryoda commented Sep 4, 2023

emtiu commented Sep 22, 2022 •

edited

Loading

aryoda commented Oct 18, 2022 •

edited

Loading

aryoda commented Nov 16, 2022 •

edited

Loading

aryoda commented Nov 17, 2022 via email •

edited by emtiu

Loading

aryoda commented Nov 20, 2022 •

edited

Loading