Add logic for the basic app installation flow

Author: lazarkov

examples/tv-app/tv-common/include/AppTv.h

@@ -142,7 +142,8 @@ class DLL_EXPORT ContentAppFactoryImpl : public ContentAppFactory
 protected:
     ContentAppImpl mContentApps[APP_LIBRARY_SIZE] = {
         ContentAppImpl("Vendor1", 1, "exampleid", 11, "Version1", "34567890"),
-        ContentAppImpl("Vendor2", 65521, "exampleString", 32768, "Version2", "20202021"),
+        // ContentAppImpl("Vendor2", 65521, "exampleString", 32768, "Version2", "20202021"),
+        ContentAppImpl("Vendor2", 2, "exampleString", 10, "Version2", "20202021"),
         ContentAppImpl("Vendor3", 9050, "App3", 22, "Version3", "20202021"),
         ContentAppImpl("TestSuiteVendor", 1111, "applicationId", 22, "v2", "20202021")
     };

examples/tv-app/tv-common/src/AppTv.cpp

@@ -98,6 +98,12 @@ class MyUserPrompter : public UserPrompter
 
     // tv should override this with a dialog prompt
     inline void PromptCommissioningFailed(const char * commissioneeName, CHIP_ERROR error) override { return; }
+
+    // tv should override this with a dialog prompt
+    inline void PromptForAppInstallOKPermission(uint16_t vendorId, uint16_t productId, const char * commissioneeName) override
+    {
+        return;
+    }
 };
 
 MyUserPrompter gMyUserPrompter;
@@ -146,6 +152,16 @@ class MyPasscodeService : public PasscodeService
 };
 MyPasscodeService gMyPasscodeService;
 
+class MyAppInstallationService : public AppInstallationService
+{
+    bool HasContentApp(uint16_t vendorId, uint16_t productId) override
+    {
+        return ContentAppPlatform::GetInstance().LoadContentAppByClient(vendorId, productId) != nullptr;
+    }
+};
+
+MyAppInstallationService gMyAppInstallationService;
+
 class MyPostCommissioningListener : public PostCommissioningListener
 {
     void CommissioningCompleted(uint16_t vendorId, uint16_t productId, NodeId nodeId, Messaging::ExchangeManager & exchangeMgr,
@@ -623,6 +639,7 @@ CHIP_ERROR AppTvInit()
     if (cdc != nullptr)
     {
         cdc->SetPasscodeService(&gMyPasscodeService);
+        cdc->SetAppInstallationService(&gMyAppInstallationService);
         cdc->SetUserPrompter(&gMyUserPrompter);
         cdc->SetPostCommissioningListener(&gMyPostCommissioningListener);
     }

src/controller/CommissionerDiscoveryController.cpp

@@ -244,6 +244,21 @@ void CommissionerDiscoveryController::InternalOk()
     CharSpan rotatingIdSpan(rotatingIdBuffer, 2 * rotatingIdLength);
 
     uint8_t targetAppCount = client->GetNumTargetAppInfos();
+
+    bool isContentAppInstalled = mAppInstallationService->HasContentApp(client->GetVendorId(), client->GetProductId());
+
+    if (!isContentAppInstalled) {
+        ChipLogError(AppServer, "UX InternalOk: app not installed.");
+
+        // dialog
+        ChipLogDetail(Controller,
+                        "------PROMPT USER: %s is requesting to install app on this TV, accept? [" ChipLogFormatMEI "," ChipLogFormatMEI "]",
+                        client->GetDeviceName(), ChipLogValueMEI(client->GetVendorId()), ChipLogValueMEI(client->GetProductId()));
+
+        mUserPrompter->PromptForAppInstallOKPermission(client->GetVendorId(), client->GetProductId(), client->GetDeviceName());
+        return;
+    }
+
     if (targetAppCount > 0)
     {
         ChipLogDetail(AppServer, "UX InternalOk: checking for each target app specified");
@@ -583,6 +598,7 @@ void CommissionerDiscoveryController::Cancel()
     }
     client->SetUDCClientProcessingState(UDCClientProcessingState::kUserDeclined);
     mPendingConsent = false;
+    ResetState();
 }
 
 void CommissionerDiscoveryController::CommissioningSucceeded(uint16_t vendorId, uint16_t productId, NodeId nodeId,

src/controller/CommissionerDiscoveryController.h

@@ -150,6 +150,22 @@ class DLL_EXPORT UserPrompter
      */
     virtual void PromptCommissioningFailed(const char * commissioneeName, CHIP_ERROR error) = 0;
 
+    /**
+     * @brief
+     *   Called to prompt the user for consent to allow the given commissioneeName/vendorId/productId to be commissioned.
+     * For example "[commissioneeName] is requesting permission to cast to this TV, approve?"
+     *
+     * If user responds with OK then implementor should call CommissionerRespondOk();
+     * If user responds with Cancel then implementor should call CommissionerRespondCancel();
+     *
+     *  @param[in]    vendorId           The vendorId in the DNS-SD advertisement of the requesting commissionee.
+     *  @param[in]    productId          The productId in the DNS-SD advertisement of the requesting commissionee.
+     *  @param[in]    commissioneeName   The commissioneeName in the DNS-SD advertisement of the requesting commissionee.
+     *
+     */
+    virtual void PromptForAppInstallOKPermission(uint16_t vendorId, uint16_t productId, const char * commissioneeName) = 0;
+
+
     virtual ~UserPrompter() = default;
 };
 
@@ -204,6 +220,27 @@ class DLL_EXPORT PasscodeService
     virtual ~PasscodeService() = default;
 };
 
+class DLL_EXPORT AppInstallationService
+{
+public:
+    /**
+     * @brief
+     *   Called to get the setup passcode from the content app corresponding to the given vendorId/productId.
+     *
+     * This will be called by the main chip thread so any blocking work should be moved to a separate thread.
+     *
+     * After attempting to obtain the passcode, implementor should call HandleContentAppPasscodeResponse();
+     *
+     *  @param[in]    vendorId           The vendorId in the DNS-SD advertisement of the requesting commissionee.
+     *  @param[in]    productId          The productId in the DNS-SD advertisement of the requesting commissionee.
+     *  @param[in]    rotatingId         The rotatingId in the DNS-SD advertisement of the requesting commissionee.
+     *
+     */
+    virtual bool HasContentApp(uint16_t vendorId, uint16_t productId) = 0;
+
+    virtual ~AppInstallationService() = default;
+};
+
 class DLL_EXPORT PostCommissioningListener
 {
 public:
@@ -392,6 +429,11 @@ class CommissionerDiscoveryController : public chip::Protocols::UserDirectedComm
     inline void SetPasscodeService(PasscodeService * passcodeService) { mPasscodeService = passcodeService; }
     inline PasscodeService * GetPasscodeService() { return mPasscodeService; }
 
+    /**
+     * Assign an AppInstallationService
+     */
+    inline void SetAppInstallationService(AppInstallationService * appInstallationService) { mAppInstallationService = appInstallationService; }
+
     /**
      * Assign a Commissioner Callback to perform commissioning once user consent has been given
      */
@@ -430,6 +472,7 @@ class CommissionerDiscoveryController : public chip::Protocols::UserDirectedComm
     UserDirectedCommissioningServer * mUdcServer           = nullptr;
     UserPrompter * mUserPrompter                           = nullptr;
     PasscodeService * mPasscodeService                     = nullptr;
+    AppInstallationService * mAppInstallationService       = nullptr;
     CommissionerCallback * mCommissionerCallback           = nullptr;
     PostCommissioningListener * mPostCommissioningListener = nullptr;
 };