Gsoc 2022

GSOC/2022/ManavSarkar.md

@@ -0,0 +1,60 @@
+# Peer to Peer Messaging application GSOC 2022
+
+## Choosen Idea
+1) Change the project Push Gossip Protocol to either Pull Protocol or Hybrid protocol
+2) Updating the User Interface for the Application.
+
+## Project Description
+The Peer to Peer messaging application aims to build an application that does not rely on a central server governed by laws and influenced by third party users. Currently, we are relying on applications that are based on central server messaging that can use our private data for their benefit regardless of the privacy policies without knowing the user. We came across incidents of data breaches where the personal data of a large number of users was disclosed to hackers. Hence a solution would be to move the data from the central server to a distributed network. The distributed network will be able to provide better privacy, less dependence on the network, and freedom from central network laws.
+The application will be hugely beneficial in disaster-prone areas or remote areas where the cellular connections are too weak to communicate through general messaging applications. In this case, this application would communicate through device networking capabilities. Hence the app is reliable and the project is working for a good cause. Hence I am motivated to develop and contribute to this project. 
+
+## Proposal Detailed Approach
+I intend to propose an approach to transfer the messaging protocol of the application from the naive push protocol. The push protocol has many disadvantages and so we need to migrate to either pull protocol or hybrid protocol. The hybrid model that is used in this project is the First-Push-Then-Pull protocol.
+
+### Hybrid Protocol Implementation
+Hybrid protocol comprises both the Push protocol and Pull protocol. The approach for this protocol is First Push and then Pull. It works on the following principle.
+- As we know, the push protocol has better performance in the initial rounds. So we first take the use of the push protocol and propagate the message until some rounds.
+- Next, we will apply the pull protocol where the devices will start asking for updates.
+- In this way, we will achieve the propagation time of O(log(log N)), which is much better than O(log N) for the push protocol.
+
+**Determination of transition period**We cannot change from push protocol to pull protocol randomly. We need a definite round where the nodes will change from push to pull protocol. 
+1) First the Pull protocol works as it asks the connected devices that if there is new message with the help of method UPDATE that is being implemented.
+2) The pull protocol continues until the application is on.
+3) Now when a new message is being sent from a device, it pushes to the connected devices. The rest of devices receive the message with the help of Pull Protocol.
+4) In this way, we achieve First Push and Then Pull protocol.
+
+## Implementations in GSoC 2022
+- The app previously required to enter the name every time the app launches. 
+Now the application saves the user name and unique id(automatically generated) into the Shared Preferences that is being removed only when the app is installed. It is a key-value form of data storing way. So when the app is launched again, the app directly opens the Home Page.
+- Home Page - It contains two tabs. The tabs are created and managed by default tab controller of the Flutter. 
+    - Tab 1: Contains List of Connected and Disconnected but in network devices.
+    - Tab2: List of devices conversed with previously.
+- Provider State Management - Previously when viewing the chat page, if new message arrived from the person whom with we are chatting, the message was saved in Database but not displayed until relaunching the ChatPage. Hence the state management was required which ensured that when a new message arrived, it will be displayed instantly. This also improved the overall speed of the application as common details where available globally rather being transferring from one screen to other.
+- Hybrid Protocol as discussed previously - First Push Then Pull (FPTP) Protocol.
+- Updated the UI
+
+## App Flow 
+- ***(If first launched)*** - The app asks for the username and a random string is added to their name, to make sure its unique.
+- Then the user is taken to the HomePage.
+- One first tab, it contains the devices with whom he/she can connect with and chat.
+- On second tab, it contains the devices with which devices it has chatted previously.
+- On clicking any device name from the list, it can chat with the devices in realtime or if there is no connection, it is delivered when the app comes on network.
+
+## Merge Requests
+- https://gitlab.com/aossie/p2p-messaging-flutter/-/merge_requests/18
+- https://gitlab.com/aossie/p2p-messaging-flutter/-/merge_requests/19
+- https://gitlab.com/aossie/p2p-messaging-flutter/-/merge_requests/20
+
+## App Working Video
+Here is the video for the working application.
+
+https://drive.google.com/file/d/1Egv-RhbZmwLcs0yskrFm4Ym8IX44D1qg/view?usp=sharing
+
+## APK Link
+https://drive.google.com/file/d/1fBfJO6akTe_-GXhvtEcr_qd59W7Ah5YG/view?usp=sharing
+
+## Project Link
+https://gitlab.com/aossie/p2p-messaging-flutter
+
+## GSOC 2022 Branch Link
+https://gitlab.com/aossie/p2p-messaging-flutter/-/tree/gsoc-2022

README.md

@@ -114,3 +114,49 @@ There are 6 main parts the above idea can be broken into,
 - use the 'hopping message' architecture to relay messages
 - offline storage of undelivered messages
 
+# Peer to Peer Messaging application GSOC 2022
+
+## Choosen Idea
+1) Change the project Push Gossip Protocol to either Pull Protocol or Hybrid protocol
+2) Updating the User Interface for the Application.
+
+## Project Description
+The Peer to Peer messaging application aims to build an application that does not rely on a central server governed by laws and influenced by third party users. Currently, we are relying on applications that are based on central server messaging that can use our private data for their benefit regardless of the privacy policies without knowing the user. We came across incidents of data breaches where the personal data of a large number of users was disclosed to hackers. Hence a solution would be to move the data from the central server to a distributed network. The distributed network will be able to provide better privacy, less dependence on the network, and freedom from central network laws.
+The application will be hugely beneficial in disaster-prone areas or remote areas where the cellular connections are too weak to communicate through general messaging applications. In this case, this application would communicate through device networking capabilities. Hence the app is reliable and the project is working for a good cause. Hence I am motivated to develop and contribute to this project. 
+
+## Proposal Detailed Approach
+I intend to propose an approach to transfer the messaging protocol of the application from the naive push protocol. The push protocol has many disadvantages and so we need to migrate to either pull protocol or hybrid protocol. The hybrid model that is used in this project is the First-Push-Then-Pull protocol.
+
+### Hybrid Protocol Implementation
+Hybrid protocol comprises both the Push protocol and Pull protocol. The approach for this protocol is First Push and then Pull. It works on the following principle.
+- As we know, the push protocol has better performance in the initial rounds. So we first take the use of the push protocol and propagate the message until some rounds.
+- Next, we will apply the pull protocol where the devices will start asking for updates.
+- In this way, we will achieve the propagation time of O(log(log N)), which is much better than O(log N) for the push protocol.
+
+**Determination of transition period**We cannot change from push protocol to pull protocol randomly. We need a definite round where the nodes will change from push to pull protocol. 
+1) First the Pull protocol works as it asks the connected devices that if there is new message with the help of method UPDATE that is being implemented.
+2) The pull protocol continues until the application is on.
+3) Now when a new message is being sent from a device, it pushes to the connected devices. The rest of devices receive the message with the help of Pull Protocol.
+4) In this way, we achieve First Push and Then Pull protocol.
+
+## Implementations in GSoC 2022
+- The app previously required to enter the name every time the app launches. 
+Now the application saves the user name and unique id(automatically generated) into the Shared Preferences that is being removed only when the app is installed. It is a key-value form of data storing way. So when the app is launched again, the app directly opens the Home Page.
+- Home Page - It contains two tabs. The tabs are created and managed by default tab controller of the Flutter. 
+    - Tab 1: Contains List of Connected and Disconnected but in network devices.
+    - Tab2: List of devices conversed with previously.
+- Provider State Management - Previously when viewing the chat page, if new message arrived from the person whom with we are chatting, the message was saved in Database but not displayed until relaunching the ChatPage. Hence the state management was required which ensured that when a new message arrived, it will be displayed instantly. This also improved the overall speed of the application as common details where available globally rather being transferring from one screen to other.
+- Hybrid Protocol as discussed previously - First Push Then Pull (FPTP) Protocol.
+- Updated the UI
+
+## App Flow 
+- ***(If first launched)*** - The app asks for the username and a random string is added to their name, to make sure its unique.
+- Then the user is taken to the HomePage.
+- One first tab, it contains the devices with whom he/she can connect with and chat.
+- On second tab, it contains the devices with which devices it has chatted previously.
+- On clicking any device name from the list, it can chat with the devices in realtime or if there is no connection, it is delivered when the app comes on network.
+
+## Merge Requests
+- https://gitlab.com/aossie/p2p-messaging-flutter/-/merge_requests/18
+- https://gitlab.com/aossie/p2p-messaging-flutter/-/merge_requests/19
+- https://gitlab.com/aossie/p2p-messaging-flutter/-/merge_requests/20

android/app/build.gradle

@@ -26,7 +26,7 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 33
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'

android/app/src/main/AndroidManifest.xml

@@ -5,12 +5,10 @@
          In most cases you can leave this as-is, but you if you want to provide
          additional functionality it is fine to subclass or reimplement
          FlutterApplication and put your custom class here. -->
-    <application
-        android:name="io.flutter.app.FlutterApplication"
+  <application android:name="${applicationName}"
         android:label="flutter_nearby_connections_example"
         android:icon="@mipmap/ic_launcher">
-        <activity
-            android:name=".MainActivity"
+      <activity android:name="io.flutter.embedding.android.FlutterActivity"
             android:launchMode="singleTop"
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"

android/app/src/main/kotlin/com/aossie/p2p/MainActivity.kt

@@ -1,6 +1,3 @@
 package com.aossie.p2p
 
 import io.flutter.embedding.android.FlutterActivity
-
-class MainActivity: FlutterActivity() {
-}

android/build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.kotlin_version = '1.5.10'
+    ext.kotlin_version = '1.6.10'
     repositories {
         google()
         jcenter()

lib/classes/Global.dart

@@ -1,24 +1,76 @@
+/// It the Global state management class.
+/// This is used over all the application.
+
 import 'dart:async';
-import 'package:pointycastle/api.dart' as crypto;
+import 'package:flutter/material.dart';
 import 'package:flutter_nearby_connections/flutter_nearby_connections.dart';
-import 'Payload.dart';
-
+import 'package:flutter_nearby_connections_example/p2p/AdhocHousekeeping.dart';
+import '../database/DatabaseHelper.dart';
 import 'Msg.dart';
 
-class Global {
-  static List<Device> devices = [];
-  static List<Device> connectedDevices = [];
+class Global extends ChangeNotifier {
+  List<Device> devices = [];
+  List<Device> connectedDevices = [];
   static NearbyService? nearbyService;
-  static StreamSubscription? subscription;
+  static StreamSubscription? deviceSubscription;
 
   static StreamSubscription? receivedDataSubscription;
   static List<Msg> messages = [
     Msg("1", "test", "sent", '2'),
     Msg("2", "test2", "sent", '4')
   ];
   static Map<String, String> publicKeys = Map();
-  static Map<String,Map<String, Msg>> conversations =
-      Map(); //converser  mapped to conversation
+  Map<String, Map<String, Msg>> conversations = Map();
   static String myName = '';
   static Map<String, dynamic> cache = Map();
+  static final GlobalKey<ScaffoldState> scaffoldKey =
+      GlobalKey<ScaffoldState>();
+  // Global({
+  //   this.conversations = Map,
+  // });
+  void sentToConversations(Msg msg, String converser,
+      {bool addToTable = true}) {
+    if (conversations[converser] == null) {
+      conversations[converser] = {};
+    }
+    conversations[converser]![msg.id] = msg;
+    if (addToTable) {
+      insertIntoConversationsTable(msg, converser);
+    }
+    notifyListeners();
+    // First push the new message for one time when new message is sent
+    broadcast(scaffoldKey.currentContext!);
+  }
+
+  void receivedToConversations(dynamic decodedMessage, BuildContext context) {
+    if (conversations[decodedMessage['sender']] == null) {
+      conversations[decodedMessage['sender']] = Map();
+    }
+    if (conversations[decodedMessage['sender']] != null &&
+        !(conversations[decodedMessage['sender']]!
+            .containsKey(decodedMessage['id']))) {
+      conversations[decodedMessage['sender']]![decodedMessage["id"]] = Msg(
+        decodedMessage['message'],
+        "received",
+        decodedMessage['Timestamp'],
+        decodedMessage["id"],
+      );
+      insertIntoConversationsTable(
+          Msg(decodedMessage['message'], "received",
+              decodedMessage['Timestamp'], decodedMessage["id"]),
+          decodedMessage['sender']);
+    }
+
+    notifyListeners();
+  }
+
+  void updateDevices(List<Device> devices) {
+    this.devices = devices;
+    notifyListeners();
+  }
+
+  void updateConnectedDevices(List<Device> devices) {
+    this.connectedDevices = devices;
+    notifyListeners();
+  }
 }

lib/classes/Msg.dart

@@ -1,10 +1,10 @@
-
+/// Message model
 
 class Msg {
   String message;
   String msgtype; //sent or received
   String timestamp;
-  String ack='false';
+  String ack = 'false';
   String id;
-  Msg(this.message, this.msgtype,this.timestamp,this.id);
+  Msg(this.message, this.msgtype, this.timestamp, this.id);
 }

lib/classes/Payload.dart

@@ -1,18 +1,17 @@
-
-class Payload{
-  String id='';
-  String sender='';
-  String receiver='';
-  String message='';
-  String timestamp='';
-  bool broadcast=true;
-  String type='Payload';
-  Payload(this.id,this.sender,this.receiver,this.message,this.timestamp);
-
+/// This is the model to transfer the message from one device to another.
+class Payload {
+  String id = '';
+  String sender = '';
+  String receiver = '';
+  String message = '';
+  String timestamp = '';
+  bool broadcast = true;
+  String type = 'Payload';
+  Payload(this.id, this.sender, this.receiver, this.message, this.timestamp);
 }
-class Ack{
-  String id='';
-  String type="Ack";
-  Ack(this.id);
 
-}
+class Ack {
+  String id = '';
+  String type = "Ack";
+  Ack(this.id);
+}

lib/components/message_panel.dart

@@ -0,0 +1,74 @@
+/// This component is used in the ChatPage.
+/// It is the message bar where the message is typed on and sent to
+/// connected devices.
+import 'package:flutter/material.dart';
+import 'package:nanoid/nanoid.dart';
+import 'package:provider/provider.dart';
+
+import '../classes/Global.dart';
+import '../classes/Msg.dart';
+import '../classes/Payload.dart';
+import '../database/DatabaseHelper.dart';
+
+class MessagePanel extends StatefulWidget {
+  const MessagePanel({Key? key, required this.converser}) : super(key: key);
+  final String converser;
+
+  @override
+  State<MessagePanel> createState() => _MessagePanelState();
+}
+
+class _MessagePanelState extends State<MessagePanel> {
+  TextEditingController myController = TextEditingController();
+  @override
+  Widget build(BuildContext context) {
+    return TextFormField(
+      controller: myController,
+      decoration: InputDecoration(
+        icon: Icon(Icons.person),
+        hintText: 'Send Message?',
+        labelText: 'Send Message ',
+        suffixIcon: IconButton(
+          onPressed: () {
+            var msgId = nanoid(21);
+            var data = {
+              "sender": "$Global.myName",
+              "receiver": "$widget.device.deviceName",
+              "message": "$myController.text",
+              "id": "$msgId",
+              "Timestamp": "${DateTime.now().toUtc().toString()}",
+              "type": "Payload"
+            };
+            Global.cache[msgId] = Payload(
+              msgId,
+              Global.myName,
+              widget.converser,
+              myController.text,
+              DateTime.now().toUtc().toString(),
+            );
+            insertIntoMessageTable(
+              Payload(
+                msgId,
+                Global.myName,
+                widget.converser,
+                myController.text,
+                DateTime.now().toUtc().toString(),
+              ),
+            );
+
+            Provider.of<Global>(context, listen: false).sentToConversations(
+              Msg(myController.text, "sent", data["Timestamp"]!, msgId),
+              widget.converser,
+            );
+
+            // refreshMessages();
+            myController.clear();
+          },
+          icon: Icon(
+            Icons.send,
+          ),
+        ),
+      ),
+    );
+  }
+}