Repository navigation
Expand file tree
/
Copy pathAdbClient.Async.cs
More file actions
1295 lines (1067 loc) · 59.9 KB
/
Copy pathAdbClient.Async.cs
File metadata and controls
1295 lines (1067 loc) · 59.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#if HAS_TASK
// <copyright file="AdbClient.Async.cs" company="The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere">
// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
// </copyright>
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
namespace AdvancedSharpAdbClient
{
public partial class AdbClient
{
/// <inheritdoc/>
public async Task<int> GetAdbVersionAsync(CancellationToken cancellationToken = default)
{
using IAdbSocket socket = CreateAdbSocket();
await socket.SendAdbRequestAsync("host:version", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
string version = await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
return int.Parse(version, NumberStyles.HexNumber);
}
/// <inheritdoc/>
public async Task KillAdbAsync(CancellationToken cancellationToken = default)
{
using IAdbSocket socket = CreateAdbSocket();
await socket.SendAdbRequestAsync("host:kill", cancellationToken).ConfigureAwait(false);
// The host will immediately close the connection after the kill
// command has been sent; no need to read the response.
}
/// <inheritdoc/>
public async Task<IEnumerable<DeviceData>> GetDevicesAsync(CancellationToken cancellationToken = default)
{
using IAdbSocket socket = CreateAdbSocket();
await socket.SendAdbRequestAsync("host:devices-l", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
string reply = await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
string[] data = reply.Split(separator, StringSplitOptions.RemoveEmptyEntries);
return data.Select(x => new DeviceData(x));
}
/// <inheritdoc/>
public async Task<int> CreateForwardAsync(DeviceData device, string local, string remote, bool allowRebind, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
string rebind = allowRebind ? string.Empty : "norebind:";
await socket.SendAdbRequestAsync($"host-serial:{device.Serial}:forward:{rebind}{local};{remote}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
string portString = await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
return portString != null && int.TryParse(portString, out int port) ? port : 0;
}
/// <inheritdoc/>
public async Task<int> CreateReverseForwardAsync(DeviceData device, string remote, string local, bool allowRebind, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
string rebind = allowRebind ? string.Empty : "norebind:";
await socket.SendAdbRequestAsync($"reverse:forward:{rebind}{remote};{local}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
string portString = await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
return portString != null && int.TryParse(portString, out int port) ? port : 0;
}
/// <inheritdoc/>
public async Task RemoveReverseForwardAsync(DeviceData device, string remote, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"reverse:killforward:{remote}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task RemoveAllReverseForwardsAsync(DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"reverse:killforward-all", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task RemoveForwardAsync(DeviceData device, int localPort, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SendAdbRequestAsync($"host-serial:{device.Serial}:killforward:tcp:{localPort}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task RemoveAllForwardsAsync(DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SendAdbRequestAsync($"host-serial:{device.Serial}:killforward-all", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task<IEnumerable<ForwardData>> ListForwardAsync(DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SendAdbRequestAsync($"host-serial:{device.Serial}:list-forward", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
string data = await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
string[] parts = data.Split(separator, StringSplitOptions.RemoveEmptyEntries);
return parts.Select(ForwardData.FromString).OfType<ForwardData>();
}
/// <inheritdoc/>
public async Task<IEnumerable<ForwardData>> ListReverseForwardAsync(DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"reverse:list-forward", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
string data = await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
string[] parts = data.Split(separator, StringSplitOptions.RemoveEmptyEntries);
return parts.Select(ForwardData.FromString).OfType<ForwardData>();
}
/// <inheritdoc/>
public async Task ExecuteServerCommandAsync(string target, string command, CancellationToken cancellationToken = default)
{
using IAdbSocket socket = CreateAdbSocket();
await ExecuteServerCommandAsync(target, command, socket, cancellationToken);
}
/// <inheritdoc/>
public virtual async Task ExecuteServerCommandAsync(string target, string command, IAdbSocket socket, CancellationToken cancellationToken = default)
{
scoped DefaultInterpolatedStringHandler request = new(1, 2);
if (!string.IsNullOrWhiteSpace(target))
{
request.AppendLiteral(target);
request.AppendFormatted(':');
}
request.AppendLiteral(command);
await socket.SendAdbRequestAsync(request.ToStringAndClear(), cancellationToken);
await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
try
{
using StreamReader reader = new(socket.GetShellStream());
// Previously, we would loop while reader.Peek() >= 0. Turns out that this would
// break too soon in certain cases (about every 10 loops, so it appears to be a timing
// issue). Checking for reader.ReadLine() to return null appears to be much more robust
// -- one of the integration test fetches output 1000 times and found no truncations.
while (!cancellationToken.IsCancellationRequested)
{
if (await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false) == null) { break; }
}
}
catch (Exception e)
{
// If a cancellation was requested, this main loop is interrupted with an exception
// because the socket is closed. In that case, we don't need to throw a ShellCommandUnresponsiveException.
// In all other cases, something went wrong, and we want to report it to the user.
if (!cancellationToken.IsCancellationRequested)
{
throw new ShellCommandUnresponsiveException(e);
}
}
}
/// <inheritdoc/>
public async Task ExecuteRemoteCommandAsync(string command, DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken);
await ExecuteServerCommandAsync("shell", command, socket, cancellationToken);
}
/// <inheritdoc/>
public async Task ExecuteServerCommandAsync(string target, string command, IShellOutputReceiver? receiver, Encoding encoding, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(encoding);
using IAdbSocket socket = CreateAdbSocket();
await ExecuteServerCommandAsync(target, command, socket, receiver, encoding, cancellationToken);
}
/// <inheritdoc/>
public virtual async Task ExecuteServerCommandAsync(string target, string command, IAdbSocket socket, IShellOutputReceiver? receiver, Encoding encoding, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(encoding);
scoped DefaultInterpolatedStringHandler request = new(1, 2);
if (!string.IsNullOrWhiteSpace(target))
{
request.AppendLiteral(target);
request.AppendFormatted(':');
}
request.AppendLiteral(command);
await socket.SendAdbRequestAsync(request.ToStringAndClear(), cancellationToken);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
try
{
using StreamReader reader = new(socket.GetShellStream(), encoding);
// Previously, we would loop while reader.Peek() >= 0. Turns out that this would
// break too soon in certain cases (about every 10 loops, so it appears to be a timing
// issue). Checking for reader.ReadLine() to return null appears to be much more robust
// -- one of the integration test fetches output 1000 times and found no truncations.
while (!cancellationToken.IsCancellationRequested)
{
string? line = await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false);
if (line == null) { break; }
if (receiver != null && await receiver.AddOutputAsync(line, cancellationToken) == false) { break; }
}
}
catch (Exception e)
{
// If a cancellation was requested, this main loop is interrupted with an exception
// because the socket is closed. In that case, we don't need to throw a ShellCommandUnresponsiveException.
// In all other cases, something went wrong, and we want to report it to the user.
if (!cancellationToken.IsCancellationRequested)
{
throw new ShellCommandUnresponsiveException(e);
}
}
finally
{
receiver?.Flush();
}
}
/// <inheritdoc/>
public async Task ExecuteRemoteCommandAsync(string command, DeviceData device, IShellOutputReceiver? receiver, Encoding encoding, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(encoding);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken);
await ExecuteServerCommandAsync("shell", command, socket, receiver, encoding, cancellationToken);
}
#if COMP_NETSTANDARD2_1
/// <inheritdoc/>
public async IAsyncEnumerable<string> ExecuteServerEnumerableAsync(string target, string command, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(encoding);
using IAdbSocket socket = CreateAdbSocket();
await foreach (string? line in ExecuteServerEnumerableAsync(target, command, socket, encoding, cancellationToken).ConfigureAwait(false))
{
yield return line;
}
}
/// <inheritdoc/>
public virtual async IAsyncEnumerable<string> ExecuteServerEnumerableAsync(string target, string command, IAdbSocket socket, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(encoding);
scoped DefaultInterpolatedStringHandler request = new(1, 2);
if (!string.IsNullOrWhiteSpace(target))
{
request.AppendLiteral(target);
request.AppendFormatted(':');
}
request.AppendLiteral(command);
await socket.SendAdbRequestAsync(request.ToStringAndClear(), cancellationToken);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
using StreamReader reader = new(socket.GetShellStream(), encoding);
// Previously, we would loop while reader.Peek() >= 0. Turns out that this would
// break too soon in certain cases (about every 10 loops, so it appears to be a timing
// issue). Checking for reader.ReadLine() to return null appears to be much more robust
// -- one of the integration test fetches output 1000 times and found no truncations.
while (!cancellationToken.IsCancellationRequested)
{
string? line = null;
try
{
line = await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false);
}
catch (Exception e)
{
// If a cancellation was requested, this main loop is interrupted with an exception
// because the socket is closed. In that case, we don't need to throw a ShellCommandUnresponsiveException.
// In all other cases, something went wrong, and we want to report it to the user.
if (!cancellationToken.IsCancellationRequested)
{
throw new ShellCommandUnresponsiveException(e);
}
}
if (line == null) { yield break; }
yield return line;
}
}
/// <inheritdoc/>
public async IAsyncEnumerable<string> ExecuteRemoteEnumerableAsync(string command, DeviceData device, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
{
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(encoding);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken);
await foreach (string? line in ExecuteServerEnumerableAsync("shell", command, socket, encoding, cancellationToken).ConfigureAwait(false))
{
yield return line;
}
}
/// <inheritdoc/>
public async IAsyncEnumerable<LogEntry> RunLogServiceAsync(DeviceData device, [EnumeratorCancellation] CancellationToken cancellationToken = default, params LogId[] logNames)
{
EnsureDevice(device);
// The 'log' service has been deprecated, see
// https://android.googlesource.com/platform/system/core/+/7aa39a7b199bb9803d3fd47246ee9530b4a96177
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
scoped DefaultInterpolatedStringHandler request = new(19, logNames.Length);
request.AppendLiteral("shell:logcat -B");
foreach (LogId logName in logNames)
{
request.AppendLiteral(" -b ");
request.AppendLiteral(logName.ToString().ToLowerInvariant());
}
await socket.SendAdbRequestAsync(request.ToStringAndClear(), cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
#if COMP_NETSTANDARD2_1
await
#endif
using Stream stream = socket.GetShellStream();
LogReader reader = new(stream);
while (!cancellationToken.IsCancellationRequested)
{
LogEntry? entry = null;
try
{
entry = await reader.ReadEntryAsync(cancellationToken).ConfigureAwait(false);
}
catch (EndOfStreamException)
{
// This indicates the end of the stream; the entry will remain null.
}
if (entry != null)
{
yield return entry;
}
else
{
yield break;
}
}
}
#endif
/// <inheritdoc/>
public async Task RunLogServiceAsync(DeviceData device, Action<LogEntry> messageSink, CancellationToken cancellationToken = default, params LogId[] logNames)
{
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(messageSink);
// The 'log' service has been deprecated, see
// https://android.googlesource.com/platform/system/core/+/7aa39a7b199bb9803d3fd47246ee9530b4a96177
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
scoped DefaultInterpolatedStringHandler request = new(19, logNames.Length);
request.AppendLiteral("shell:logcat -B");
foreach (LogId logName in logNames)
{
request.AppendLiteral(" -b ");
request.AppendLiteral(logName.ToString().ToLowerInvariant());
}
await socket.SendAdbRequestAsync(request.ToStringAndClear(), cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
#if COMP_NETSTANDARD2_1
await
#endif
using Stream stream = socket.GetShellStream();
LogReader reader = new(stream);
while (!cancellationToken.IsCancellationRequested)
{
LogEntry? entry = null;
try
{
entry = await reader.ReadEntryAsync(cancellationToken).ConfigureAwait(false);
}
catch (EndOfStreamException)
{
// This indicates the end of the stream; the entry will remain null.
}
if (entry != null)
{
messageSink(entry);
}
else
{
break;
}
}
}
/// <inheritdoc/>
public async Task<Framebuffer> GetFrameBufferAsync(DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
Framebuffer framebuffer = CreateFramebuffer(device);
await framebuffer.RefreshAsync(true, cancellationToken).ConfigureAwait(false);
// Convert the framebuffer to an image, and return that.
return framebuffer;
}
/// <inheritdoc/>
public async Task RebootAsync(string into, DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"reboot:{into}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task<string> PairAsync(string host, int port, string code, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(host);
using IAdbSocket socket = CreateAdbSocket();
string address = host.Contains(':') ? host : $"{host}:{port}";
await socket.SendAdbRequestAsync($"host:pair:{code}:{address}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
return await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task<string> ConnectAsync(string host, int port = DefaultPort, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(host);
using IAdbSocket socket = CreateAdbSocket();
string address = host.Contains(':') ? host : $"{host}:{port}";
await socket.SendAdbRequestAsync($"host:connect:{address}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
return await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public async Task<string> DisconnectAsync(string host, int port = DefaultPort, CancellationToken cancellationToken = default)
{
ArgumentNullException.ThrowIfNull(host);
using IAdbSocket socket = CreateAdbSocket();
string address = host.Contains(':') ? host : $"{host}:{port}";
await socket.SendAdbRequestAsync($"host:disconnect:{address}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
return await socket.ReadStringAsync(cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
public Task RootAsync(DeviceData device, CancellationToken cancellationToken = default) => RootAsync("root:", device, cancellationToken);
/// <inheritdoc/>
public Task UnrootAsync(DeviceData device, CancellationToken cancellationToken = default) => RootAsync("unroot:", device, cancellationToken);
/// <summary>
/// Restarts the ADB daemon running on the device with or without root privileges.
/// </summary>
/// <param name="request">The command of root or unroot.</param>
/// <param name="device">The device on which to restart ADB with root privileges.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
/// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
protected async Task RootAsync(string request, DeviceData device, CancellationToken cancellationToken = default)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync(request, cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
// ADB will send some additional data
byte[] buffer = new byte[1024];
int read = await socket.ReadAsync(buffer, cancellationToken).ConfigureAwait(false);
string responseMessage =
#if HAS_BUFFERS
Encoding.GetString(buffer.AsSpan(0, read));
#else
Encoding.GetString(buffer, 0, read);
#endif
// see https://android.googlesource.com/platform/packages/modules/adb/+/refs/heads/main/daemon/restart_service.cpp
// for possible return strings
if (!responseMessage.Contains("restarting", StringComparison.OrdinalIgnoreCase))
{
throw new AdbException(responseMessage);
}
else
{
// Give adbd some time to kill itself and come back up.
// We can't use wait-for-device because devices (e.g. adb over network) might not come back.
await Task.Delay(3000, cancellationToken).ConfigureAwait(false);
}
}
/// <inheritdoc/>
public virtual async Task InstallAsync(DeviceData device, Stream apk, Action<InstallProgressEventArgs>? callback = null, CancellationToken cancellationToken = default, params string[] arguments)
{
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Preparing));
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(apk);
if (!apk.CanRead || !apk.CanSeek)
{
throw new ArgumentOutOfRangeException(nameof(apk), "The apk stream must be a readable and seekable stream");
}
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
scoped DefaultInterpolatedStringHandler requestBuilder = new(31, (arguments?.Length ?? 0) + 1);
requestBuilder.AppendLiteral("exec:cmd package 'install'");
if (arguments != null)
{
foreach (string argument in arguments)
{
requestBuilder.AppendFormatted(' ');
requestBuilder.AppendLiteral(argument);
}
}
// add size parameter [required for streaming installs]
// do last to override any user specified value
requestBuilder.AppendLiteral(" -S ");
requestBuilder.AppendFormatted(apk.Length);
await socket.SendAdbRequestAsync(requestBuilder.ToStringAndClear(), cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
byte[] buffer = new byte[32 * 1024];
int read;
long totalBytesToProcess = apk.Length;
long totalBytesRead = 0;
#if HAS_BUFFERS
while ((read = await apk.ReadAsync(buffer, cancellationToken).ConfigureAwait(false)) > 0)
#else
while ((read = await apk.ReadAsync(buffer, 0, buffer.Length, cancellationToken).ConfigureAwait(false)) > 0)
#endif
{
#if COMP_NETSTANDARD2_1
await socket.SendAsync(buffer.AsMemory(0, read), cancellationToken).ConfigureAwait(false);
#else
await socket.SendAsync(buffer, read, cancellationToken).ConfigureAwait(false);
#endif
totalBytesRead += read;
callback?.Invoke(new InstallProgressEventArgs(0, 1, totalBytesToProcess == 0 ? 0 : totalBytesRead * 100d / totalBytesToProcess));
}
callback?.Invoke(new InstallProgressEventArgs(1, 1, 100));
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Installing));
read = await socket.ReadAsync(buffer, cancellationToken).ConfigureAwait(false);
string value =
#if HAS_BUFFERS
Encoding.GetString(buffer.AsSpan(0, read));
#else
Encoding.GetString(buffer, 0, read);
#endif
if (!value.Contains("Success"))
{
throw new AdbException(value);
}
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Finished));
}
/// <inheritdoc/>
public async Task InstallMultipleAsync(DeviceData device, Stream baseAPK, IEnumerable<Stream> splitAPKs, Action<InstallProgressEventArgs>? callback = null, CancellationToken cancellationToken = default, params string[] arguments)
{
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Preparing));
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(baseAPK);
ArgumentNullException.ThrowIfNull(splitAPKs);
if (!baseAPK.CanRead || !baseAPK.CanSeek)
{
throw new ArgumentOutOfRangeException(nameof(baseAPK), "The apk stream must be a readable and seekable stream");
}
if (splitAPKs.Any(apk => apk == null || !apk.CanRead || !apk.CanSeek))
{
throw new ArgumentOutOfRangeException(nameof(splitAPKs), "The apk stream must be a readable and seekable stream");
}
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.CreateSession));
string session = await InstallCreateAsync(device, cancellationToken, arguments).ConfigureAwait(false);
int splitAPKsCount = splitAPKs.Count();
void OnMainSyncProgressChanged(string? sender, double args) =>
callback?.Invoke(new InstallProgressEventArgs(sender == null ? 1 : 0, splitAPKsCount + 1, args / 2));
await InstallWriteAsync(device, baseAPK, nameof(baseAPK), session, OnMainSyncProgressChanged, cancellationToken).ConfigureAwait(false);
int progressCount = 1;
Dictionary<string, double> status = new(splitAPKsCount);
void OnSplitSyncProgressChanged(string? sender, double args)
{
lock (status)
{
if (sender == null)
{
progressCount++;
}
else if (sender is string path)
{
status[path] = args;
}
callback?.Invoke(new InstallProgressEventArgs(progressCount, splitAPKsCount + 1, (status.Values.Select(x => x / splitAPKsCount).Sum() + 100) / 2));
}
}
await splitAPKs.Select((splitAPK, index) => InstallWriteAsync(device, splitAPK, $"{nameof(splitAPK)}{index}", session, OnSplitSyncProgressChanged, cancellationToken)).WhenAll().ConfigureAwait(false);
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Installing));
await InstallCommitAsync(device, session, cancellationToken).ConfigureAwait(false);
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Finished));
}
/// <inheritdoc/>
public async Task InstallMultipleAsync(DeviceData device, IEnumerable<Stream> splitAPKs, string packageName, Action<InstallProgressEventArgs>? callback = null, CancellationToken cancellationToken = default, params string[] arguments)
{
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Preparing));
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(splitAPKs);
ArgumentNullException.ThrowIfNull(packageName);
if (splitAPKs.Any(apk => apk == null || !apk.CanRead || !apk.CanSeek))
{
throw new ArgumentOutOfRangeException(nameof(splitAPKs), "The apk stream must be a readable and seekable stream");
}
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.CreateSession));
string session = await InstallCreateAsync(device, packageName, cancellationToken, arguments).ConfigureAwait(false);
int progressCount = 0;
int splitAPKsCount = splitAPKs.Count();
Dictionary<string, double> status = new(splitAPKsCount);
void OnSyncProgressChanged(string? sender, double args)
{
lock (status)
{
if (sender == null)
{
progressCount++;
}
else if (sender is string path)
{
status[path] = args;
}
callback?.Invoke(new InstallProgressEventArgs(progressCount, splitAPKsCount, status.Values.Select(x => x / splitAPKsCount).Sum()));
}
}
await splitAPKs.Select((splitAPK, index) => InstallWriteAsync(device, splitAPK, $"{nameof(splitAPK)}{index}", session, OnSyncProgressChanged, cancellationToken)).WhenAll().ConfigureAwait(false);
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Installing));
await InstallCommitAsync(device, session, cancellationToken).ConfigureAwait(false);
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Finished));
}
/// <inheritdoc/>
public async Task<string> InstallCreateAsync(DeviceData device, CancellationToken cancellationToken = default, params string[] arguments)
{
EnsureDevice(device);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
scoped DefaultInterpolatedStringHandler requestBuilder = new(33, arguments?.Length ?? 0);
requestBuilder.AppendLiteral("exec:cmd package 'install-create'");
if (arguments != null)
{
foreach (string argument in arguments)
{
requestBuilder.AppendFormatted(' ');
requestBuilder.AppendLiteral(argument);
}
}
await socket.SendAdbRequestAsync(requestBuilder.ToStringAndClear(), cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
using StreamReader reader = new(socket.GetShellStream(), Encoding);
string result = await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false)
?? throw new AdbException($"The {nameof(result)} of {nameof(InstallCreateAsync)} is null.");
if (!result.Contains("Success"))
{
throw new AdbException(await reader.ReadToEndAsync(cancellationToken).ConfigureAwait(false));
}
int arr = result.IndexOf(']') - 1 - result.IndexOf('[');
string session = result.Substring(result.IndexOf('[') + 1, arr);
return session;
}
/// <inheritdoc/>
public async Task<string> InstallCreateAsync(DeviceData device, string packageName, CancellationToken cancellationToken = default, params string[] arguments)
{
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(packageName);
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
scoped DefaultInterpolatedStringHandler requestBuilder = new(37 + packageName.Length, arguments?.Length ?? 0);
requestBuilder.AppendLiteral("exec:cmd package 'install-create'");
requestBuilder.AppendFormatted(" -p ");
requestBuilder.AppendLiteral(packageName);
if (arguments != null)
{
foreach (string argument in arguments)
{
requestBuilder.AppendFormatted(' ');
requestBuilder.AppendLiteral(argument);
}
}
await socket.SendAdbRequestAsync(requestBuilder.ToStringAndClear(), cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
using StreamReader reader = new(socket.GetShellStream(), Encoding);
string result = await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false)
?? throw new AdbException($"The {nameof(result)} of {nameof(InstallCreateAsync)} is null.");
if (!result.Contains("Success"))
{
throw new AdbException(await reader.ReadToEndAsync(cancellationToken).ConfigureAwait(false));
}
int arr = result.IndexOf(']') - 1 - result.IndexOf('[');
string session = result.Substring(result.IndexOf('[') + 1, arr);
return session;
}
/// <inheritdoc/>
public virtual async Task InstallWriteAsync(DeviceData device, Stream apk, string apkName, string session, Action<double>? callback = null, CancellationToken cancellationToken = default)
{
callback?.Invoke(0);
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(apk);
ArgumentNullException.ThrowIfNull(apkName);
ArgumentNullException.ThrowIfNull(session);
if (!apk.CanRead || !apk.CanSeek)
{
throw new ArgumentOutOfRangeException(nameof(apk), "The apk stream must be a readable and seekable stream");
}
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"exec:cmd package 'install-write' -S {apk.Length} {session} {apkName}.apk", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
byte[] buffer = new byte[32 * 1024];
int read;
long totalBytesToProcess = apk.Length;
long totalBytesRead = 0;
#if HAS_BUFFERS
while ((read = await apk.ReadAsync(buffer, cancellationToken).ConfigureAwait(false)) > 0)
#else
while ((read = await apk.ReadAsync(buffer, 0, buffer.Length, cancellationToken).ConfigureAwait(false)) > 0)
#endif
{
#if COMP_NETSTANDARD2_1
await socket.SendAsync(buffer.AsMemory(0, read), cancellationToken).ConfigureAwait(false);
#else
await socket.SendAsync(buffer, read, cancellationToken).ConfigureAwait(false);
#endif
totalBytesRead += read;
callback?.Invoke(totalBytesToProcess == 0 ? 0 : totalBytesRead * 100d / totalBytesToProcess);
}
read = await socket.ReadAsync(buffer, cancellationToken).ConfigureAwait(false);
string value =
#if HAS_BUFFERS
Encoding.GetString(buffer.AsSpan(0, read));
#else
Encoding.GetString(buffer, 0, read);
#endif
if (!value.Contains("Success"))
{
throw new AdbException(value);
}
callback?.Invoke(100);
}
/// <summary>
/// Asynchronously write an apk into the given install session.
/// </summary>
/// <param name="device">The device on which to install the application.</param>
/// <param name="apk">A <see cref="Stream"/> which represents the application to install.</param>
/// <param name="apkName">The name of the application.</param>
/// <param name="session">The session ID of the install session.</param>
/// <param name="callback">An optional parameter which, when specified, returns progress notifications.
/// The progress is reported as a value between 0 and 100, representing the percentage of the apk which has been transferred.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> which can be used to cancel the asynchronous operation.</param>
/// <returns>A <see cref="Task"/> which represents the asynchronous operation.</returns>
protected virtual async Task InstallWriteAsync(DeviceData device, Stream apk, string apkName, string session, Action<string?, double>? callback, CancellationToken cancellationToken = default)
{
callback?.Invoke(apkName, 0);
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(apk);
ArgumentNullException.ThrowIfNull(apkName);
ArgumentNullException.ThrowIfNull(session);
if (!apk.CanRead || !apk.CanSeek)
{
throw new ArgumentOutOfRangeException(nameof(apk), "The apk stream must be a readable and seekable stream");
}
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"exec:cmd package 'install-write' -S {apk.Length} {session} {apkName}.apk", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
byte[] buffer = new byte[32 * 1024];
int read;
long totalBytesToProcess = apk.Length;
long totalBytesRead = 0;
#if COMP_NETSTANDARD2_1
while ((read = await apk.ReadAsync(buffer, cancellationToken).ConfigureAwait(false)) > 0)
{
await socket.SendAsync(buffer.AsMemory(0, read), cancellationToken).ConfigureAwait(false);
#else
while ((read = await apk.ReadAsync(buffer, 0, buffer.Length, cancellationToken).ConfigureAwait(false)) > 0)
{
await socket.SendAsync(buffer, read, cancellationToken).ConfigureAwait(false);
#endif
totalBytesRead += read;
callback?.Invoke(apkName, totalBytesToProcess == 0 ? 0 : totalBytesRead * 100d / totalBytesToProcess);
}
callback?.Invoke(apkName, 100);
read = await socket.ReadAsync(buffer, cancellationToken).ConfigureAwait(false);
string value =
#if HAS_BUFFERS
Encoding.GetString(buffer.AsSpan(0, read));
#else
Encoding.GetString(buffer, 0, read);
#endif
if (!value.Contains("Success"))
{
throw new AdbException(value);
}
callback?.Invoke(null, 100);
}
/// <inheritdoc/>
public async Task InstallCommitAsync(DeviceData device, string session, CancellationToken cancellationToken = default)
{
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
await socket.SendAdbRequestAsync($"exec:cmd package 'install-commit' {session}", cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
using StreamReader reader = new(socket.GetShellStream(), Encoding);
string? result = await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false);
if (result?.Contains("Success") != true)
{
throw new AdbException(await reader.ReadToEndAsync(cancellationToken).ConfigureAwait(false));
}
}
#if HAS_WINRT
/// <inheritdoc/>
public virtual async Task InstallAsync(DeviceData device, IRandomAccessStream apk, Action<InstallProgressEventArgs>? callback = null, CancellationToken cancellationToken = default, params string[] arguments)
{
callback?.Invoke(new InstallProgressEventArgs(PackageInstallProgressState.Preparing));
EnsureDevice(device);
ArgumentNullException.ThrowIfNull(apk);
if (!apk.CanRead)
{
throw new ArgumentOutOfRangeException(nameof(apk), "The apk stream must be a readable stream");
}
using IAdbSocket socket = CreateAdbSocket();
await socket.SetDeviceAsync(device, cancellationToken).ConfigureAwait(false);
scoped DefaultInterpolatedStringHandler requestBuilder = new(30, (arguments?.Length ?? 0) + 1);
requestBuilder.AppendLiteral("exec:cmd package 'install'");
if (arguments != null)
{
foreach (string argument in arguments)
{
requestBuilder.AppendFormatted(' ');
requestBuilder.AppendLiteral(argument);
}
}
// add size parameter [required for streaming installs]
// do last to override any user specified value
requestBuilder.AppendLiteral(" -S ");
requestBuilder.AppendFormatted(apk.Size);
await socket.SendAdbRequestAsync(requestBuilder.ToStringAndClear(), cancellationToken).ConfigureAwait(false);
_ = await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
byte[] buffer = new byte[32 * 1024];
ulong totalBytesToProcess = apk.Size;
ulong totalBytesRead = 0;
while (true)