Merge pull request #16 from Goddchen/feature/clipboard

feat: implement clipboard support

Author: Goddchen

CHANGELOG.md

@@ -36,3 +36,7 @@
 ## 0.5.0
 
 - Add key event support
+
+## 0.6.0
+
+- Add clipboard support

lib/src/client/remote_frame_buffer_client.dart

@@ -13,6 +13,7 @@ import 'package:dart_rfb/src/constants.dart';
 import 'package:dart_rfb/src/extensions/byte_data_extensions.dart';
 import 'package:dart_rfb/src/extensions/int_extensions.dart';
 import 'package:dart_rfb/src/extensions/raw_socket_extensions.dart';
+import 'package:dart_rfb/src/protocol/client_cut_text_message.dart';
 import 'package:dart_rfb/src/protocol/client_init_message.dart';
 import 'package:dart_rfb/src/protocol/encoding_type.dart';
 import 'package:dart_rfb/src/protocol/frame_buffer_update_message.dart';
@@ -24,6 +25,7 @@ import 'package:dart_rfb/src/protocol/protocol_version_handshake_message.dart';
 import 'package:dart_rfb/src/protocol/security_handshake_message.dart';
 import 'package:dart_rfb/src/protocol/security_result_handshake_message.dart';
 import 'package:dart_rfb/src/protocol/security_type.dart';
+import 'package:dart_rfb/src/protocol/server_cut_text_message.dart';
 import 'package:dart_rfb/src/protocol/server_init_message.dart';
 import 'package:dart_rfb/src/protocol/set_encodings_message.dart';
 import 'package:dart_rfb/src/protocol/set_pixel_format_message.dart';
@@ -35,25 +37,32 @@ import 'package:logging/logging.dart';
 class RemoteFrameBufferClient {
   static final Logger logger = Logger('RemoteFrameBufferClient');
 
-  final StreamController<RemoteFrameBufferClientUpdate>
-      _updateStreamController =
-      StreamController<RemoteFrameBufferClientUpdate>.broadcast();
-
   Option<Config> _config = none();
 
-  Option<RawSocket> _socket = none();
+  Option<String> _password = none();
 
   bool _readLoopRunning = false;
 
-  Option<String> _password = none();
-
   Option<RemoteFrameBufferProtocolVersion> _selectedProtocolVersion = none();
 
   Option<RemoteFrameBufferSecurityType> _selectedSecurityType = none();
 
+  Option<RawSocket> _socket = none();
+
+  final StreamController<String> _serverClipBoardStreamController =
+      StreamController<String>();
+
+  final StreamController<RemoteFrameBufferClientUpdate>
+      _updateStreamController =
+      StreamController<RemoteFrameBufferClientUpdate>.broadcast();
+
   /// The config used by the underlying session.
   Option<Config> get config => _config;
 
+  /// A [Stream] that will give access to the server's clipboard updates.
+  Stream<String> get serverClipBoardStream =>
+      _serverClipBoardStreamController.stream;
+
   /// A [Stream] that will give access to all incoming framebuffer updates.
   Stream<RemoteFrameBufferClientUpdate> get updateStream =>
       _updateStreamController.stream;
@@ -116,6 +125,19 @@ class RemoteFrameBufferClient {
         ),
       );
 
+  void sendClientCutText({
+    required final String text,
+  }) =>
+      _socket.match(
+        () {},
+        (final RawSocket socket) {
+          final RemoteFrameBufferClientCutTextMessage message =
+              RemoteFrameBufferClientCutTextMessage(text: text);
+          logger.info('> $message');
+          socket.write(message.toBytes().buffer.asUint8List());
+        },
+      );
+
   void sendKeyEvent({
     required final RemoteFrameBufferClientKeyEvent keyEvent,
   }) =>
@@ -234,13 +256,20 @@ class RemoteFrameBufferClient {
                     // no data, just ignore for now
                     break;
                   case 3: // ServerCutText
-                    final int length =
-                        (await socket.readSync(length: 7).run()).getUint32(3);
-                    socket.readSync(length: length);
+                    final RemoteFrameBufferServerCutTextMessage message =
+                        (await RemoteFrameBufferServerCutTextMessage
+                                    .readFromSocket(socket: socket)
+                                .run())
+                            .getOrElse(
+                      (final Object error) => throw Exception(
+                        'Error reading server cut text: $error',
+                      ),
+                    );
+                    logger.info('< $message');
+                    _serverClipBoardStreamController.add(message.text);
                     break;
                   default:
-                    logger.log(
-                      Level.INFO,
+                    logger.info(
                       'Receive unsupported message type: $messageType',
                     );
                     break;

lib/src/protocol/client_cut_text_message.dart

@@ -0,0 +1,32 @@
+import 'dart:convert';
+import 'dart:typed_data';
+
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+part 'client_cut_text_message.freezed.dart';
+
+@freezed
+class RemoteFrameBufferClientCutTextMessage
+    with _$RemoteFrameBufferClientCutTextMessage {
+  const factory RemoteFrameBufferClientCutTextMessage({
+    required final String text,
+  }) = _RemoteFrameBufferClientCutTextMessage;
+
+  const RemoteFrameBufferClientCutTextMessage._();
+
+  ByteData toBytes() {
+    final String text = this.text.replaceAll('\r', '');
+    return ByteData.sublistView(
+      (BytesBuilder()
+            ..add(
+              (ByteData(8)
+                    ..setUint8(0, 6)
+                    ..setUint32(4, text.length))
+                  .buffer
+                  .asUint8List(),
+            )
+            ..add(latin1.encode(text)))
+          .toBytes(),
+    );
+  }
+}

lib/src/protocol/client_cut_text_message.freezed.dart

@@ -0,0 +1,50 @@
+import 'dart:convert';
+import 'dart:io';
+import 'dart:typed_data';
+
+import 'package:dart_rfb/src/extensions/raw_socket_extensions.dart';
+import 'package:fpdart/fpdart.dart';
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+part 'server_cut_text_message.freezed.dart';
+
+@freezed
+class RemoteFrameBufferServerCutTextMessage
+    with _$RemoteFrameBufferServerCutTextMessage {
+  const factory RemoteFrameBufferServerCutTextMessage({
+    required final String text,
+  }) = _RemoteFrameBufferServerCutTextMessage;
+
+  const RemoteFrameBufferServerCutTextMessage._();
+
+  ByteData toBytes() => ByteData.sublistView(
+        (BytesBuilder()
+              ..add(
+                (ByteData(8)
+                      ..setUint8(0, 3)
+                      ..setUint32(4, text.length))
+                    .buffer
+                    .asUint8List(),
+              )
+              ..add(latin1.encode(text.replaceAll('\r', ''))))
+            .toBytes(),
+      );
+
+  static TaskEither<Object, RemoteFrameBufferServerCutTextMessage>
+      readFromSocket({
+    required final RawSocket socket,
+  }) =>
+          TaskEither<Object, RemoteFrameBufferServerCutTextMessage>.tryCatch(
+            () async {
+              final int length =
+                  (await socket.readSync(length: 7).run()).getUint32(3);
+              final String text = latin1.decode(
+                (await socket.readSync(length: length).run())
+                    .buffer
+                    .asUint8List(),
+              );
+              return RemoteFrameBufferServerCutTextMessage(text: text);
+            },
+            (final Object error, final _) => error,
+          );
+}