ATAK plugin (#3189)

* WIP ATAK plugin message handling

* Log

* Update size and regen

* Rework protos and remove compression

* Track

* Altitude

* Protos

* Protos and formatting

* Add to column

* Fixes / updates

* Doh!

* S

* Refactoring and compression fixes

src/mesh/MeshModule.cpp

@@ -67,7 +67,7 @@ meshtastic_MeshPacket *MeshModule::allocErrorResponse(meshtastic_Routing_Error e
     return r;
 }
 
-void MeshModule::callPlugins(const meshtastic_MeshPacket &mp, RxSource src)
+void MeshModule::callPlugins(meshtastic_MeshPacket &mp, RxSource src)
 {
     // LOG_DEBUG("In call modules\n");
     bool moduleFound = false;
@@ -124,9 +124,10 @@ void MeshModule::callPlugins(const meshtastic_MeshPacket &mp, RxSource src)
                 } else
                     printPacket("packet on wrong channel, but can't respond", &mp);
             } else {
-
                 ProcessMessage handled = pi.handleReceived(mp);
 
+                pi.alterReceived(mp);
+
                 // Possibly send replies (but only if the message was directed to us specifically, i.e. not for promiscious
                 // sniffing) also: we only let the one module send a reply, once that happens, remaining modules are not
                 // considered

src/mesh/MeshModule.h

@@ -64,7 +64,7 @@ class MeshModule
 
     /** For use only by MeshService
      */
-    static void callPlugins(const meshtastic_MeshPacket &mp, RxSource src = RX_SRC_RADIO);
+    static void callPlugins(meshtastic_MeshPacket &mp, RxSource src = RX_SRC_RADIO);
 
     static std::vector<MeshModule *> GetMeshModulesWithUIFrames();
     static void observeUIEvents(Observer<const UIFrameEvent *> *observer);
@@ -72,10 +72,7 @@ class MeshModule
                                                                     meshtastic_AdminMessage *request,
                                                                     meshtastic_AdminMessage *response);
 #if HAS_SCREEN
-    virtual void drawFrame(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y)
-    {
-        return;
-    }
+    virtual void drawFrame(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y) { return; }
 #endif
   protected:
     const char *name;
@@ -135,10 +132,12 @@ class MeshModule
     @return ProcessMessage::STOP if you've guaranteed you've handled this message and no other handlers should be considered for
     it
     */
-    virtual ProcessMessage handleReceived(const meshtastic_MeshPacket &mp)
-    {
-        return ProcessMessage::CONTINUE;
-    }
+    virtual ProcessMessage handleReceived(const meshtastic_MeshPacket &mp) { return ProcessMessage::CONTINUE; }
+
+    /** Called to change a particular incoming message
+        This allows the module to change the message before it is passed through the rest of the call-chain.
+    */
+    virtual void alterReceived(meshtastic_MeshPacket &mp) {}
 
     /** Messages can be received that have the want_response bit set.  If set, this callback will be invoked
      * so that subclasses can (optionally) send a response back to the original sender.
@@ -151,14 +150,8 @@ class MeshModule
     /***
      * @return true if you want to be alloced a UI screen frame
      */
-    virtual bool wantUIFrame()
-    {
-        return false;
-    }
-    virtual Observable<const UIFrameEvent *> *getUIFrameObservable()
-    {
-        return NULL;
-    }
+    virtual bool wantUIFrame() { return false; }
+    virtual Observable<const UIFrameEvent *> *getUIFrameObservable() { return NULL; }
 
     meshtastic_MeshPacket *allocAckNak(meshtastic_Routing_Error err, NodeNum to, PacketId idFrom, ChannelIndex chIndex);
 

src/mesh/ProtobufModule.h

@@ -30,6 +30,10 @@ template <class T> class ProtobufModule : protected SinglePortModule
      */
     virtual bool handleReceivedProtobuf(const meshtastic_MeshPacket &mp, T *decoded) = 0;
 
+    /** Called to make changes to a particular incoming message
+     */
+    virtual void alterReceivedProtobuf(meshtastic_MeshPacket &mp, T *decoded){};
+
     /**
      * Return a mesh packet which has been preinited with a particular protobuf data payload and port number.
      * You can then send this packet (after customizing any of the payload fields you might need) with
@@ -86,4 +90,26 @@ template <class T> class ProtobufModule : protected SinglePortModule
 
         return handleReceivedProtobuf(mp, decoded) ? ProcessMessage::STOP : ProcessMessage::CONTINUE;
     }
+
+    /** Called to alter a particular incoming message
+     */
+    virtual void alterReceived(meshtastic_MeshPacket &mp) override
+    {
+        auto &p = mp.decoded;
+
+        T scratch;
+        T *decoded = NULL;
+        if (mp.which_payload_variant == meshtastic_MeshPacket_decoded_tag && mp.decoded.portnum == ourPortNum) {
+            memset(&scratch, 0, sizeof(scratch));
+            if (pb_decode_from_bytes(p.payload.bytes, p.payload.size, fields, &scratch)) {
+                decoded = &scratch;
+            } else {
+                LOG_ERROR("Error decoding protobuf module!\n");
+                // if we can't decode it, nobody can process it!
+                return;
+            }
+        }
+
+        return alterReceivedProtobuf(mp, decoded);
+    }
 };