Commit graph

559 commits

Author SHA1 Message Date
Peter Hutterer
c29b65eaf6 meson.build: add override_dependencies for all our libraries
This makes it easier to use libei as a subproject.
2022-12-12 09:07:24 +10:00
Peter Hutterer
7e058b3fa8 libei 0.4.1 2022-12-09 20:08:01 +10:00
Peter Hutterer
ddd704d6e8 libei 0.4 2022-12-09 13:32:29 +10:00
Olivier Fourdan
39f3ec007b liboeffis: protect from interrupted system calls
In various places, including the DBUS calls which can take some time, if
a SIGALRM triggers, the call will fail.

To prevent this from happening, use the wrappers when possible and make
sure to block the SIGALRM signal when issuing DBUS calls.

Signed-off-by: Olivier Fourdan <ofourdan@redhat.com>
2022-12-08 12:37:46 +10:00
Olivier Fourdan
8bcbc53c0f ei: Use the signal protected wrappers
To prevent against unexpected interrupted system calls.

Signed-off-by: Olivier Fourdan <ofourdan@redhat.com>
2022-12-08 12:37:46 +10:00
Peter Hutterer
1991b8f52d util: change the signal handler to a context-manager like macro
Change the signal-blocking helper to take a vararg list of signals to
block and provide a magic macro that works like python's context
manager, using  attribute(cleanup).

In our for loop we create a new struct with the old sigmask and a
boolean that's always true. We enter the body of the loop once and
set that boolean to false on the second run, i.e. we never do more than
one run. On loop exit, the destroy function for our struct restores the
previous signal mask.
2022-12-08 12:37:46 +10:00
Olivier Fourdan
0d3a398fee util: Add a wrapper for dup() and pipe2()
The wrappers take care of blocking the SIGALRM signal.

Signed-off-by: Olivier Fourdan <ofourdan@redhat.com>
2022-12-08 12:37:46 +10:00
Olivier Fourdan
0ac9b1b02d util: Protect system calls against signals
Most system calls will fail if interrupted by a SIGALRM. Make sure we
block SIGALRM prior to do the syscall, and restore the set of signals
afterwards.

Signed-off-by: Olivier Fourdan <ofourdan@redhat.com>
2022-12-08 12:37:46 +10:00
Olivier Fourdan
085f96c3bb util: Add block/release signals API
Add a couple of simple helper functions to block and releaset he SIGALRM
signal.

Signed-off-by: Olivier Fourdan <ofourdan@redhat.com>
2022-12-08 12:37:46 +10:00
Peter Hutterer
eeefb3dc00 liboeffis is a wrapper library for the RemoteDesktop communication
libei used to have direct portal support code (see the git history) but:
- that code was a custom proposed portal that never went anywhere
- libei has slowly changed to be more an input event transport layer since
  it is now also used sending events *to* a libei context
- a number of libei users will never need the DBus code, either because they
  don't want it or because they talk Dbus themselves na ddon't need this
  abstraction.

Luckily, it's quite easy to move this into a separate library with a
simple API that does, effectively, the same trick as the old portal backend.
This API is aiming to be as simple as possible because the tools that
require anything more complex should talk to DBus directly.

An example tool that uses the API to retrieve an EIS fd over the
RemoteDesktop portal is included in this patch.

"Öffis" is a German word meaning public transport. It also sounds like the
French Œuf, the word for egg.

Co-authored-by: Olivier Fourdan <ofourdan@redhat.com>
2022-12-08 11:22:50 +10:00
Peter Hutterer
8fc654bfb0 Purge the portal code
The original idea here was that we would have an EmulatedInput portal
that allows the application to connect directly to the EIS
implementation to exchange input events - instead of ping-ponging DBus
events through the xdg-desktop-portal as the RemoteDesktop portal
requires.

This is no longer accurate, there are suggested PRs open to add
RemoteDesktop.ConnectToEIS to achieve the same through the existing
RemoteDesktop interface [1] and to add a new InputCapture portal
to allow for events to be sent to a libei receiver context [2].

The example EmulatedInput portal is thus superfluous and can be removed
from here.

We could switch the ei_setup_backend_portal() code to use RemoteDesktop
or InputCapture, depending on the context type, the utility of this is
questionable. Interaction with portals is complex, one needs to
implement the Session/Request interfaces correctly and in the case of
InputCapture also handle the complex zones/pointer barrier setup.
libportal does some of this (or it will, anyway) so it's more useful for
an application to use libportal and then just pass the received fd to
libei.

If there is a future need for this to be handled as part of libei, we
can (re)implement this, but for now it's best to just purge all of this.

[1] https://github.com/flatpak/xdg-desktop-portal/pull/762
[2] https://github.com/flatpak/xdg-desktop-portal/pull/714
2022-12-08 10:45:47 +10:00
Peter Hutterer
97254391dc README: swap to RemoteDesktop over the nonexistent EmulatedInput portal
At least for event replaying it looks like we'll go through the
RemoteDesktop portal instead of creating another one that doesn't
provide any additional benefits.

See https://github.com/flatpak/xdg-desktop-portal/pull/762
2022-12-08 10:45:34 +10:00
Peter Hutterer
903baf27ba CI: bump to latest ci-templates 2022-12-05 15:11:41 +10:00
Peter Hutterer
d741b3b7ce CI: bump to Fedora 37
Fedora 35 is EOL
2022-12-05 15:05:01 +10:00
Peter Hutterer
7713ad5ac5 CI: purge all references to the master branch 2022-12-05 15:05:01 +10:00
Peter Hutterer
260ae90d91 meson.build: fix an indentation issue 2022-12-05 14:52:47 +10:00
Peter Hutterer
d5b813d677 doc: fix a comment in util-mem.h 2022-12-01 18:56:18 +10:00
Peter Hutterer
9d5ec147a1 doc: fix a doxygen warning about a wrong parameter name 2022-12-01 18:56:18 +10:00
Peter Hutterer
06469e737b doc: fix two references to function calls 2022-11-29 15:25:07 +10:00
Olivier Fourdan
99b0eb4587 Fix absolute events filtering
When a device has multiple regions, ei_device_pointer_motion_absolute()
would walk all of the regions and bail out if the coordinates are
outside any region.

As a matter of facts, it means that an absolute event must fall within
all the device regions to succeed.

That doesn't seem right, it should be the opposite, the coordinates must
be within at least one region.

Fix the logic by reusing the existing ei_device_in_region() function.

Signed-off-by: Olivier Fourdan <ofourdan@redhat.com>
2022-09-16 16:03:30 +02:00
Peter Hutterer
29da572dca proto: separate pre-connection properties into ConfigureProperty
This is primarily for namespacing: where a portal sets some properties
it needs to do so *before* the Connect event. By moving this out to a
different namespace we can separate this easier, avoiding a portal
accidentally sending a property event after it has already passed the fd
to the client.

Fixes #23
2022-09-07 10:07:56 +10:00
Peter Hutterer
bc78c24290 Fix some logging linebreak issues
One excessive linebreak, another one was missing.
2022-09-07 10:03:11 +10:00
Peter Hutterer
2d143904c2 proto: add versioned Configure transactions
The same socket is used for pre-connection configuration by a portal and
for the actual client that then uses the data. The portal and the client
may need different protocol versions *and* there may be different REIS
intermediaries.

So let's allow version negotiation for the configuration through
transactions: a REIS intermediary must start/finish a transaction with a
given version number.

This is only partially implemented in libreis right now: each API call
is wrapped in a transaction. Since we support version 1 only anyway,
there's no need to do anything but send our version down the wire. In
the future where we actually need to negotiate, libreis will need a
reis_dispatch() so we can wait for the server version to arrive, parse
it, etc. before sending ConfigureVersion down the wire. It's likely this
will never be needed.
2022-09-07 09:43:03 +10:00
Peter Hutterer
5535692ee0 proto: allow the client to set the protocol version
Let the client set the version number it wants on Connect. There is new
public API to query the client/server's version as set once the connect
finished (eis_client_get_version() and ei_get_version()) but there is
currently no public API for the client to select the version it actually
wants, other than whatever both support. IOW, it's not possible for the
client to say "I want version 8 but if that's not supported, use version
5".
2022-09-07 09:42:59 +10:00
Peter Hutterer
08a4ce4aac proto: add a version exchange prior to connect
Add a new protocol message "GetVersion" and the matching reply from the
server with "Version" that can be sent at any time. The server always
replies with the highest protocol version it supports, allowing the
client to choose the protocol version it wants.

These two messages also have a fixed string to make the protocol easy to
identify in hexdumps.

To avoid roundtrips on connection, libeis immediately sends the Version
message. Ideally and by the time the client actually starts, that
version is already available and we can continue without requiring a
full roundtrip.

This patch only adds the version exchange with the server, it does not
yet add the bits for the client to actually set the version.
2022-09-07 09:30:39 +10:00
Peter Hutterer
1592fdd57f Add a version macro for grepable version numbers
Makes it a lot easier than to grep for the lonely 1 or 2 in a codebase
somewhere.
2022-09-07 09:20:27 +10:00
Peter Hutterer
06210ee439 tools: drop help for obsolete --sender option from the eis-demo-server 2022-09-06 08:56:20 +10:00
Peter Hutterer
f7dc4af6e8 log: abstract the auxiliary information into a log message context
This makes the logger API both simpler and more future-proof since we
can easily shove extra information into the context now.
2022-08-11 10:09:34 +10:00
Peter Hutterer
37467881e6 Drop the trailing newline from the log messages
Punt this job to the caller, any structured logging handler doesn't need
them anyway and it makes handling of messages more awkward.

For our default log handlers (fprintf) we can just append them
ourselves.

Fixes #19
2022-08-11 10:09:27 +10:00
Peter Hutterer
876d722356 log: enforce single logical messages only
For all but the simplest loggers, the current approach of "this is a
continuation of the previous message" doesn't work well. The caller
cannot know whether the *current* message is complete until it receives
the next message - but that message may never come.

Drop this approach, if we need to compile multiple messages into one,
we can handle this internally and then pass it all as one message to the
caller.
2022-08-11 10:08:48 +10:00
Peter Hutterer
2858b29f1d log: allocate the log message on demand
This avoids truncation of long log messages.
2022-08-03 10:33:01 +10:00
Peter Hutterer
07f80cc002 proto: split the client's SetProperty from the server event
This makes the code/protocol slightly more readable.
2022-08-02 03:33:32 +00:00
Peter Hutterer
0a382dec3d tools: print property values in the demo client and server 2022-08-01 10:12:06 +00:00
Peter Hutterer
27af399992 tools/demo-client: keep a ref to the ptr/kbd/abs devices
Otherwise calling unref on them on exit makes the demo client go boom.
2022-08-01 10:12:06 +00:00
Peter Hutterer
f6aaedf701 tools/demo-client: stop means stop sending events
The demo client has an inner while loop for the events, followed by
the code to send events to the server. Skip that code if our while loop
indicated we'll stop.
2022-08-01 10:12:06 +00:00
Peter Hutterer
8eee092568 eis: default the client to only the capabilities we know about
Let's not pretend we support capabilities we don't actually know about.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2022-08-01 11:52:07 +10:00
Peter Hutterer
b3e4f8fc25 test: add a few tests for reis 2022-08-01 11:50:29 +10:00
Peter Hutterer
daddc355b2 eis: add eis_client_has_capability
The EIS implementation needs to know if a client can use a given
capability. No point setting up touch devices if the client isn't
allowed those.
2022-08-01 11:50:29 +10:00
Peter Hutterer
41a106fafc eis: send out the list of existing properties on connect
Any property that was set by the server or a libreis intermediary before
connect needs to be sent to the client.

Fixes #22
2022-08-01 11:31:59 +10:00
Peter Hutterer
b4efd0fa5f test: set up libreis support in eierpecken
The basic set of functions and macros to have access to a libreis
context for our to-be-client.

Since we connect the ei context to a backend during peck_new(), we need
a new function for the case where we do want to have libreis in the
mix.
2022-08-01 11:31:59 +10:00
Peter Hutterer
223d65858d test: rename the ei AUTOCONNECT behavior to HANDLE_CONNECT
All we do here is decide whether the connect event gets handled, clients
are always effectively connected (i.e. the client does send the connect
request) since we set up the backend during init.
2022-08-01 11:26:32 +10:00
Peter Hutterer
7c08308129 util: only do flag_* operations if the bit fits
This silently ignores any bit higher than the target storage (e.g.
flag_set(some_uint32, 33)) but that's still better than silently writing
into random memory.

Add a c file for util-bits.h as well - only contains the tests but at
least that way those are picked up like all other util tests.
2022-07-29 15:43:48 +10:00
Peter Hutterer
d6afe9cef2 Remove a double semicolon 2022-07-29 13:38:28 +10:00
Peter Hutterer
0ee55051f3 proto: document that only one ConfigureName is possible 2022-07-28 14:58:35 +10:00
Peter Hutterer
ba05b9d683 proto: split the Configure messages out a bit
No functional changes though it is a protocol ABI change: group the
Configure messages into their own opcode range.
2022-07-28 11:05:10 +10:00
Peter Hutterer
a70d0af48f proto: document ConfigureCapabilities
Write a bit more of a blurb, with the goal of this eventually being the
protocol documentation.
2022-07-28 11:04:46 +10:00
Peter Hutterer
2142daadc5 eis: capabilities can only be reduced
If a REIS implementation sends multiple ConfigureCapabilities messages,
the allowed capabilities would be whichever ones were sent last rather
than the intersection of all capablities.

Fallout from 7fc9498f1d.
2022-07-28 11:01:08 +10:00
Peter Hutterer
2ec3ced24c proto: specify that Configure messages must be sent before connection
There's a very limited use for configure messages after client
connection. The name is already static after connect anyway, and
the ability to drop capabilities after connect would just complicate the
EIS implementations unnecessary.
2022-07-28 10:35:07 +10:00
Peter Hutterer
61213f3a26 proto: reformat according to the Google Style Guide
2 space indentation, see
https://developers.google.com/protocol-buffers/docs/style
2022-07-28 10:35:07 +10:00
Peter Hutterer
91a604656e reis: drop unnecessary variable rc 2022-07-28 10:35:07 +10:00