Skip to content

Commit 31e0c79

Browse files
pacmancoderpacmancoder
authored
feat: set keyboard layout functionality (#22)
1 parent de4d418 commit 31e0c79

File tree

11 files changed

+508
-112
lines changed

11 files changed

+508
-112
lines changed

‎docs/NOW-spec.md

+46
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ increment major version; Protocol implementations with different major version a
336336
| NOW_CAP_SESSION_LOCK<br>0x00000001 | Session lock command support. |
337337
| NOW_CAP_SESSION_LOGOFF<br>0x00000002 | Session logoff command support. |
338338
| NOW_CAP_SESSION_MSGBOX<br>0x00000004 | Message box command support. |
339+
| NOW_CAP_SESSION_SET_KBD_LAYOUT<br>0x00000008 | Set keyboard layout command support. |
339340

340341
**execCapset (4 bytes)**: Remote execution capabilities set.
341342

@@ -552,6 +553,7 @@ The NOW_SYSTEM_SHUTDOWN_MSG structure is used to request a system shutdown.NOW_S
552553
| NOW_SESSION_LOGOFF_MSG_ID<br>0x02 | NOW_SESSION_LOGOFF_MSG |
553554
| NOW_SESSION_MESSAGE_BOX_MSG_REQ_ID<br>0x03 | NOW_SESSION_MESSAGE_BOX_MSG |
554555
| NOW_SESSION_MESSAGE_BOX_RSP_MSG_ID<br>0x04 | NOW_SESSION_MESSAGE_RSP_MSG |
556+
| NOW_SESSION_SWITCH_KBD_LAYOUT_MSG_ID<br>0x05 | NOW_SESSION_SWITCH_KBD_LAYOUT_MSG |
555557

556558
**msgFlags (2 bytes)**: The message flags.
557559

@@ -751,6 +753,50 @@ If `status` specifies error, this field should be set to `0`.
751753

752754
**status (variable)**: `NOW_STATUS` structure containing message box response status.
753755

756+
#### NOW_SESSION_SET_KBD_LAYOUT_MSG
757+
758+
The NOW_SESSION_SET_KBD_LAYOUT_MSG message is used to set the keyboard layout for the active
759+
foreground window. The request is fire-and-forget, invalid layout identifiers are ignored.
760+
761+
<table class="byte-layout">
762+
<thead>
763+
<tr>
764+
<th>0</th><th>1</th><th>2</th><th>3</th><th>4</th><th>5</th><th>6</th><th>7</th>
765+
<th>8</th><th>9</th><th>10</th><th>1</th><th>2</th><th>3</th><th>4</th><th>5</th>
766+
<th>6</th><th>7</th><th>8</th><th>9</th><th>20</th><th>1</th><th>2</th><th>3</th>
767+
<th>4</th><th>5</th><th>6</th><th>7</th><th>8</th><th>9</th><th>30</th><th>1</th>
768+
</tr>
769+
</thead>
770+
<tbody>
771+
<tr>
772+
<td colspan="32">msgSize</td>
773+
</tr>
774+
<tr>
775+
<td colspan="8">msgClass</td>
776+
<td colspan="8">msgType</td>
777+
<td colspan="16">msgFlags</td>
778+
</tr>
779+
<tr>
780+
<td colspan="32">kbdLayoutId(variable)</td>
781+
</tr>
782+
</tbody>
783+
</table>
784+
785+
**msgSize (4 bytes)**: The message size, excluding the header size (8 bytes).
786+
787+
**msgClass (1 byte)**: The message class (NOW_SESSION_MSG_CLASS_ID).
788+
789+
**msgType (1 byte)**: The message type (NOW_SESSION_SWITCH_KBD_LAYOUT_MSG_ID).
790+
791+
**msgFlags (2 bytes)**: The message flags.
792+
793+
| Flag | Meaning |
794+
|-------------------------------------|-----------------------------------------|
795+
| NOW_SET_KBD_LAYOUT_FLAG_NEXT<br>0x00000001 | Switches to next keyboard layout. kbdLayoutId field should contain empty string. Conflicts with NOW_SET_KBD_LAYOUT_FLAG_PREV. |
796+
| NOW_SET_KBD_LAYOUT_FLAG_PREV<br>0x00000002 | Switches to previous keyboard layout. kbdLayoutId field should contain empty string. Conflicts with NOW_SET_KBD_LAYOUT_FLAG_NEXT. |
797+
798+
**kbdLayoutId (variable)**: NOW_STRING structure containing the keyboard layout identifier usually represented as [Windows Keyboard Layout Identifier](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/windows-language-pack-default-values) (HKL).
799+
754800
### Execution Messages
755801

756802
#### NOW_EXEC_MSG

‎dotnet/Devolutions.NowClient/src/NowClient.cs

+37
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,43 @@ public async Task SessionMessageBoxNoResponse(MessageBoxParams msgBoxParams)
156156
await _commandWriter.WriteAsync(command);
157157
}
158158

159+
private async Task SessionSetKbdLayoutImpl(NowMsgSessionSetKbdLayout message)
160+
{
161+
ThrowIfWorkerTerminated();
162+
163+
if (!Capabilities.SessionCapset.HasFlag(NowCapabilitySession.SetKbdLayout))
164+
{
165+
ThrowCapabilitiesError("Set keyboard layout");
166+
}
167+
168+
var command = new CommandSessionSetKbdLayout(message);
169+
await _commandWriter.WriteAsync(command);
170+
}
171+
172+
/// <summary>
173+
/// Set the next keyboard layout for the active foreground window.
174+
/// </summary>
175+
public async Task SessionSetKbdLayoutNext()
176+
{
177+
await SessionSetKbdLayoutImpl(NowMsgSessionSetKbdLayout.Next());
178+
}
179+
180+
/// <summary>
181+
/// Set the previous keyboard layout for the active foreground window.
182+
/// </summary>
183+
public async Task SessionSetKbdLayoutPrev()
184+
{
185+
await SessionSetKbdLayoutImpl(NowMsgSessionSetKbdLayout.Prev());
186+
}
187+
188+
/// <summary>
189+
/// Set a specific keyboard layout for the active foreground window.
190+
/// </summary>
191+
public async Task SessionSetKbdLayoutSpecific(string layout)
192+
{
193+
await SessionSetKbdLayoutImpl(NowMsgSessionSetKbdLayout.Specific(layout));
194+
}
195+
159196
/// <summary>
160197
/// Start a new simple remote execution session.
161198
/// (see <see cref="ExecRunParams"/> for more details).

‎dotnet/Devolutions.NowClient/src/Worker/CommandSessionSetKbdLayout.cs

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
using Devolutions.NowProto.Messages;
2+
3+
namespace Devolutions.NowClient.Worker
4+
{
5+
internal class CommandSessionSetKbdLayout(NowMsgSessionSetKbdLayout request) : IClientCommand
6+
{
7+
public async Task Execute(WorkerCtx ctx)
8+
{
9+
await ctx.NowChannel.WriteMessage(request);
10+
}
11+
}
12+
}

‎dotnet/Devolutions.NowProto.Tests/src/MsgSession.cs

+57-112
Original file line numberDiff line numberDiff line change
@@ -119,117 +119,62 @@ public void MsgBoxRspError()
119119
Assert.Throws<NowProtocolException>(() => msg.GetResponseOrThrow());
120120
}
121121

122-
/*
123-
let msg = NowSessionMsgBoxRspMsg::new_error(
124-
0x01234567,
125-
NowStatusError::from(NowStatusErrorKind::Now(NowProtoError::NotImplemented))
126-
.with_message("err")
127-
.unwrap(),
128-
)
129-
.unwrap();
130-
131-
let decoded = now_msg_roundtrip(
132-
msg,
133-
expect!["[15, 00, 00, 00, 12, 04, 00, 00, 67, 45, 23, 01, 00, 00, 00, 00, 03, 00, 01, 00, 07, 00, 00, 00, 03, 65, 72, 72, 00]"],
134-
);
135-
136-
let actual = match decoded {
137-
NowMessage::Session(NowSessionMessage::MsgBoxRsp(msg)) => msg,
138-
_ => panic!("Expected NowSessionMsgBoxRspMsg"),
139-
};
140-
141-
assert_eq!(actual.request_id(), 0x01234567);
142-
assert_eq!(
143-
actual.to_result().unwrap_err(),
144-
NowStatusError::from(NowStatusErrorKind::Now(NowProtoError::NotImplemented))
145-
.with_message("err")
146-
.unwrap()
147-
);
148-
149-
/*
150-
[TestMethod]
151-
public void MsgLockRoundtrip()
152-
{
153-
var msg = new NowMsgSessionLock();
154-
155-
var actualEncoded = new byte[(msg as INowSerialize).Size];
156-
{
157-
var cursor = new NowWriteCursor(actualEncoded);
158-
(msg as INowSerialize).Serialize(cursor);
159-
}
160-
161-
var expectedEncoded = new byte[]
162-
{
163-
0x00, 0x00, 0x00, 0x00, 0x12, 0x01, 0x00, 0x00,
164-
};
165-
166-
CollectionAssert.AreEqual(expectedEncoded, actualEncoded);
167-
}
168-
169-
[TestMethod]
170-
public void MsgLogoff()
171-
{
172-
var msg = new NowMsgSessionLogoff();
173-
174-
var actualEncoded = new byte[(msg as INowSerialize).Size];
175-
{
176-
var cursor = new NowWriteCursor(actualEncoded);
177-
(msg as INowSerialize).Serialize(cursor);
178-
}
179-
180-
var expectedEncoded = new byte[]
181-
{
182-
0x00, 0x00, 0x00, 0x00, 0x12, 0x02, 0x00, 0x00,
183-
};
184-
185-
CollectionAssert.AreEqual(expectedEncoded, actualEncoded);
186-
}
187-
188-
[TestMethod]
189-
public void MsgMessageBoxReq()
190-
{
191-
var msg = new NowMsgSessionMessageBoxReq(0x76543210, "hello")
192-
{
193-
WaitForResponse = true,
194-
Style = NowMsgSessionMessageBoxReq.MessageBoxStyle.AbortRetryIgnore,
195-
Title = "world",
196-
Timeout = 3,
197-
};
198-
199-
var actualEncoded = new byte[(msg as INowSerialize).Size];
200-
{
201-
var cursor = new NowWriteCursor(actualEncoded);
202-
(msg as INowSerialize).Serialize(cursor);
203-
}
204-
205-
var expectedEncoded = new byte[]
206-
{
207-
0x1A, 0x00, 0x00, 0x00, 0x12, 0x03, 0x0F, 0x00,
208-
0x10, 0x32, 0x54, 0x76, 0x02, 0x00, 0x00, 0x00,
209-
0x03, 0x00, 0x00, 0x00, 0x05, 0x77, 0x6F, 0x72,
210-
0x6C, 0x64, 0x00, 0x05, 0x68, 0x65, 0x6C, 0x6C,
211-
0x6F, 0x00,
212-
};
213-
214-
CollectionAssert.AreEqual(expectedEncoded, actualEncoded);
215-
}
216-
217-
[TestMethod]
218-
public void MsgMessageBoxRsp()
219-
{
220-
var encoded = new byte[]
221-
{
222-
0x08, 0x00, 0x00, 0x00, 0x12, 0x04, 0x00, 0x00,
223-
0x67, 0x45, 0x23, 0x01, 0x04, 0x00, 0x00, 0x00,
224-
};
225-
226-
var msg = NowMessage
227-
.Read(new NowReadCursor(encoded))
228-
.Deserialize<NowMsgSessionMessageBoxRsp>();
229-
230-
Assert.AreEqual((uint)0x01234567, msg.RequestId);
231-
Assert.AreEqual(NowMsgSessionMessageBoxRsp.MessageBoxResponse.Retry, msg.Response);
232-
}
233-
*/
122+
[Fact]
123+
public void SetKbdLayoutSpecific()
124+
{
125+
var msg = NowMsgSessionSetKbdLayout.Specific("00000409");
126+
127+
var encoded = new byte[]
128+
{
129+
0x0A, 0x00, 0x00, 0x00, 0x12, 0x05, 0x00, 0x00, 0x08, 0x30, 0x30, 0x30,
130+
0x30, 0x30, 0x34, 0x30, 0x39, 0x00
131+
};
132+
133+
var decoded = NowTest.MessageRoundtrip(msg, encoded);
134+
135+
Assert.Equal(msg.LayoutOption, decoded.LayoutOption);
136+
Assert.Equal(msg.Layout, decoded.Layout);
137+
138+
Assert.Equal(NowMsgSessionSetKbdLayout.SetKbdLayoutOption.Specific, msg.LayoutOption);
139+
Assert.Equal("00000409", msg.Layout);
140+
}
141+
142+
[Fact]
143+
public void SetKbdLayoutNext()
144+
{
145+
var msg = NowMsgSessionSetKbdLayout.Next();
146+
147+
var encoded = new byte[]
148+
{
149+
0x02, 0x00, 0x00, 0x00, 0x12, 0x05, 0x01, 0x00, 0x00, 0x00
150+
};
151+
152+
var decoded = NowTest.MessageRoundtrip(msg, encoded);
153+
154+
Assert.Equal(msg.LayoutOption, decoded.LayoutOption);
155+
Assert.Equal(msg.Layout, decoded.Layout);
156+
157+
Assert.Equal(NowMsgSessionSetKbdLayout.SetKbdLayoutOption.Next, msg.LayoutOption);
158+
Assert.Null(msg.Layout);
159+
}
160+
161+
[Fact]
162+
public void SetKbdLayoutPrev()
163+
{
164+
var msg = NowMsgSessionSetKbdLayout.Prev();
165+
166+
var encoded = new byte[]
167+
{
168+
0x02, 0x00, 0x00, 0x00, 0x12, 0x05, 0x02, 0x00, 0x00, 0x00
169+
};
170+
171+
var decoded = NowTest.MessageRoundtrip(msg, encoded);
172+
173+
Assert.Equal(msg.LayoutOption, decoded.LayoutOption);
174+
Assert.Equal(msg.Layout, decoded.Layout);
175+
176+
Assert.Equal(NowMsgSessionSetKbdLayout.SetKbdLayoutOption.Prev, msg.LayoutOption);
177+
Assert.Null(msg.Layout);
178+
}
234179
}
235180
}

‎dotnet/Devolutions.NowProto/src/Capabilities/NowCapabilitySession.cs

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ public enum NowCapabilitySession : ushort
2828
/// NOW-PROTO: NOW_CAP_SESSION_MSGBOX
2929
/// </summary>
3030
Msgbox = 0x0004,
31+
/// <summary>
32+
/// Set keyboard layout command support.
33+
///
34+
/// NOW-PROTO: NOW_CAP_SESSION_SET_KBD_LAYOUT
35+
/// </summary>
36+
SetKbdLayout = 0x0008,
3137

3238
All = Lock | Logoff | Msgbox,
3339
}

‎dotnet/Devolutions.NowProto/src/Exceptions/NowDecodeException.cs

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ public enum ErrorKind
2020
UnexpectedMessageKind,
2121
InvalidDataStreamFlags,
2222
InvalidApartmentStateFlags,
23+
InvalidKbdLayoutFlags,
2324
}
2425

2526
private static string KindToMessage(ErrorKind kind)
@@ -31,6 +32,7 @@ private static string KindToMessage(ErrorKind kind)
3132
ErrorKind.UnexpectedMessageKind => "Unexpected message kind.",
3233
ErrorKind.InvalidDataStreamFlags => "Invalid data stream flags.",
3334
ErrorKind.InvalidApartmentStateFlags => "Invalid apartment state flags.",
35+
ErrorKind.InvalidKbdLayoutFlags => "Invalid keyboard layout flags.",
3436
_ => throw new UnreachableException("Should not be constructed with invalid kind."),
3537
};
3638
}

0 commit comments

Comments
 (0)