tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Fabian Arndt b24d629802 virtualmonitor: implemented capabilities check 
BUG: 485829

## Summary

Currently, the plugin just fails silently if the local device is missing the `krfb` package or if the remote device misses an `vnc://` protocol/scheme handler. You click the button and nothing happens.

One issue is, that the plugin is considered `virtualmonitor.available` in the `DeviceDelegate.qml`, even if the check for `krfb-virtualmonitor` fails and no dbus-path is provided. I investigated the behavior a bit, but ignored it in the end as this MR benefits from being shown for device constellations that _could_ provide this feature.

A warning is shown with brief instructions, how to get the plugin working correctly.

- Check if krfb-virtualmonitor is available locally
- Check default scheme handler for vnc:// on device (Linux)
- Show warnings / reasons, if no connection could be established


## Test Plan

Regarding if the devices have mentioned packages installed, we should see different behaviors.

If the remote device has no VNC client, it can not connect to out server. _A warning should be shown._

If the local device hasn't the `krfb-virtualmonitor` available, the remote device couldn't connect. _A warning should be shown._

If both problems are present, _both warnings should be shown._


If none of these are present, no warning should be shown and we should try to establish a connection.


The connection attempts failed? _A warning should be shown._
2024-05-30 23:13:54 +00:00
..
battery SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
bigscreen SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-12 01:19:07 +00:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
connectivity-report SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-08 01:13:43 +00:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-08 01:13:43 +00:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2024-02-18 01:14:07 +00:00
findthisdevice Make sure we are not using deprecated APIs 2024-04-27 17:47:29 +02:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2024-02-11 01:13:59 +00:00
mmtelephony SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
mousepad singlerelease is actually used 2024-03-02 00:03:13 +01:00
mpriscontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-12 01:19:07 +00:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-12 01:19:07 +00:00
notifications SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
pausemusic SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
presenter Drop Qt5-only code branches 2024-04-27 17:46:39 +02:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2024-02-18 01:14:07 +00:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-12 01:19:07 +00:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2024-02-18 01:14:07 +00:00
remotesystemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-12 01:19:07 +00:00
runcommand Add Qt::DBus dependency to kdeconnect_runcommand_config 2024-05-25 10:31:46 +02:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2024-02-18 01:14:07 +00:00
sendnotifications Make clang-format happy 2024-03-27 19:22:02 +01:00
sftp sftp: --warning 2024-03-06 21:58:04 +00:00
share SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
sms Remove no longer necessary Qt6Core5Compat dependency 2024-05-01 16:18:14 +02:00
systemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-12 01:19:07 +00:00
telephony SVN_SILENT made messages (.desktop file) - always resolve ours 2024-04-28 01:15:33 +00:00
virtualmonitor virtualmonitor: implemented capabilities check 2024-05-30 23:13:54 +00:00
CMakeLists.txt Cleanup all occurences of QT_MAJOR_VERSION in cmake 2023-12-28 17:49:07 +01:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-04 01:21:06 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Fix file name on plugin's readme. 2022-11-27 01:40:51 +00:00

README.txt 

Writing a plugin for KDE Connect
=================================

For the desktop client (this project):
--------------------------------------

1. Enter the "plugins" directory.
2. Copy the "ping" under a different name ("findmyphone" in this example).
3. Add "add_subdirectory(findmyphone)" to CMakeLists.txt after the others "add_subdirectory".
4. Enter the new "findmyphone" directory.
5. Edit CMakeLists.txt by replacing "ping" with "findmyphone".
6. Rename other files in this directory by replacing "ping" with "findmyphone"
7. Write a description of your plugin into "README"
8. Edit findmyphoneplugin.cpp and findmyphoneplugin.h.
  A. Change license header.
  B. Replace (case sensitive) "ping" with "findmyphone", "PingPlugin" with "FindMyPhonePlugin" and "PING" with "FINDMYPHONE".
9. Edit kdeconnect_findmyphone.json file:
  A. Replace "ping" with "findmyphone".
  B. Change name, description, icon, author, email, version, website, license info.
  C. Remove all the translations
  D. Set X-KDEConnect-SupportedPacketType and X-KDEConnect-OutgoingPacketType to the packet type your plugin will receive
     and send, respectively. In this example this is "kdeconnect.findmyphone". Make sure that this matches what is defined in
     the findmyphoneplugin.h file (in the line "#define PACKET_TYPE_..."), and also in Android.
10. Now you have an empty skeleton to implement your new plugin logic.

For Android (project kdeconnect-android):
-----------------------------------------

1. Change directory to src/org/kde/kdeconnect/Plugins.
2. Copy "PingPlugin" under a different name ("FindMyPhonePlugin" in this example).
3. Enter the new "FindMyPhonePlugin" directory.
4. Rename "PingPlugin.java" to "FindMyPhonePlugin.java"
5. Edit it. Replace (case sensitive) "Ping" with "FindMyPhone", "ping" with "findmyphone", "PING" with "FINDMYPHONE"
   and "plugin_ping" with "plugin_findmyphone".
6. Open res/values/strings.xml. Find and copy the lines "pref_plugin_ping_desc" and "pref_plugin_ping" replacing "ping"
   with "findmyphone" and edit the plugin name and description between <string> </string>).
7. Now you have an empty skeleton to implement your new plugin logic.