[Presentation API] Handle multiple Presentation URLs in PresentationRequest::getAvailability()

content/renderer/presentation/presentation_dispatcher.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_RENDERER_PRESENTATION_PRESENTATION_DISPATCHER_H_
 #define CONTENT_RENDERER_PRESENTATION_PRESENTATION_DISPATCHER_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 32 matching lines @@
 class CONTENT_EXPORT PresentationDispatcher
     : public RenderFrameObserver,
       public NON_EXPORTED_BASE(blink::WebPresentationClient),
       public NON_EXPORTED_BASE(blink::mojom::PresentationServiceClient) {
  public:
   explicit PresentationDispatcher(RenderFrame* render_frame);
   ~PresentationDispatcher() override;
 
  private:
   friend class TestPresentationDispatcher;
+  friend class PresentationDispatcherTest;
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestStartSession);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestStartSessionError);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestJoinSession);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestJoinSessionError);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestSendString);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestSendArrayBuffer);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestSendBlobData);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestCloseSession);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest, TestTerminateSession);
   FRIEND_TEST_ALL_PREFIXES(PresentationDispatcherTest,
@@ skipping 41 matching lines @@
                        size_t length) override;
   void sendBlobData(const blink::WebURL& presentationUrl,
                     const blink::WebString& presentationId,
                     const uint8_t* data,
                     size_t length) override;
   void closeSession(const blink::WebURL& presentationUrl,
                     const blink::WebString& presentationId) override;
   void terminateSession(const blink::WebURL& presentationUrl,
                         const blink::WebString& presentationId) override;
   void getAvailability(
-      const blink::WebVector<blink::WebURL>& availabilityUrl,
+      const blink::WebVector<blink::WebURL>& availabilityUrls,
       std::unique_ptr<blink::WebPresentationAvailabilityCallbacks> callbacks)
       override;
   void startListening(blink::WebPresentationAvailabilityObserver*) override;
   void stopListening(blink::WebPresentationAvailabilityObserver*) override;
   void setDefaultPresentationUrls(
       const blink::WebVector<blink::WebURL>& presentationUrls) override;
 
   // RenderFrameObserver implementation.
   void DidCommitProvisionalLoad(
       bool is_new_navigation,
@@ skipping 43 matching lines @@
   // over mojo channel.
   using MessageRequestQueue = std::queue<std::unique_ptr<SendMessageRequest>>;
   MessageRequestQueue message_request_queue_;
 
   enum class ListeningState {
     INACTIVE,
     WAITING,
     ACTIVE,
   };
 
+  enum class ScreenAvailability {
+    UNKNOWN,
+    AVAILABLE,
+    UNAVAILABLE,
+    UNSUPPORTED
+  };
+
   using AvailabilityCallbacksMap =
       IDMap<std::unique_ptr<blink::WebPresentationAvailabilityCallbacks>>;
   using AvailabilityObserversSet =
       std::set<blink::WebPresentationAvailabilityObserver*>;
 
-  // Tracks status of presentation displays availability for |availability_url|.
+  // Tracks status of presentation displays availability for
+  // |availability_urls|.
   struct AvailabilityStatus {

[imcheng, 2017/01/17 20:53:17]

nit: This doesn't really contain the ScreenAvailability value so the struct name
is a bit confusing.

[mark a. foltz, 2017/01/17 21:04:24]

Maybe AvailabilityCallbacks?

[zhaobin, 2017/01/18 03:38:57]

AvailabilityListeners?

-    explicit AvailabilityStatus(const GURL& availability_url);
+    AvailabilityStatus(const std::vector<GURL>& availability_urls);

[imcheng, 2017/01/17 20:53:17]

Still needs explicit?

[zhaobin, 2017/01/18 03:38:57]

Done.

     ~AvailabilityStatus();
 
-    const GURL url;
-    bool last_known_availability;
-    ListeningState listening_state;
+    std::vector<GURL> urls;

[imcheng, 2017/01/17 20:53:17]

Can this be const?

[zhaobin, 2017/01/18 03:38:57]

Done.

     AvailabilityCallbacksMap availability_callbacks;
     AvailabilityObserversSet availability_observers;
   };
 
-  // Map of AvailabilityStatus for known URLs.
-  std::map<GURL, std::unique_ptr<AvailabilityStatus>>
-      availability_status_;
+  // Tracks listening status of |availability_url|.
+  struct ListeningStatus {
+    explicit ListeningStatus(const GURL& availability_url);
+    ~ListeningStatus();
 
-  // Updates the listening state of availability for |status| and notifies the
-  // client.
-  void UpdateListeningState(AvailabilityStatus* status);
+    const GURL url;
+    ScreenAvailability last_known_availability;
+    ListeningState listening_state;
+  };
+
+  // Map of ListeningStatus for known URLs.
+  std::map<GURL, std::unique_ptr<ListeningStatus>> listening_status_;
+
+  // Set of AvailabilityStatus for known PresentationRequest.
+  std::set<std::unique_ptr<AvailabilityStatus>> availability_set_;
+
+  // Starts listening to |url|.
+  void StartListeningToURL(const GURL& url);
+
+  // Stops listening to |url| if no PresentationAvailability is observing |url|.
+  // StartListening() must have been called first.
+  void StopListeningToURL(const GURL& url);
+
+  // Returns nullptr if there is no status for |url|.
+  ListeningStatus* GetListeningStatus(const GURL& url);

[imcheng, 2017/01/17 20:53:17]

Can this method and the 2 below be const?

[zhaobin, 2017/01/18 03:38:57]

Done.

+
+  // Returns nullptr if there is no availability status for |urls|.
+  AvailabilityStatus* GetAvailabilityStatus(const std::vector<GURL>& urls);
+
+  // Returns AVAILABLE if any url in |urls| has screen availability AVAILABLE;
+  // Returns UNSUPPORTED if any url in |urls| have screen availability
+  // UNSUPPORTED, and no url has screen availability AVAILABLE;
+  // Returns UNAVAILABLE if at least one url in |urls| has screen availability
+  // UNAVAILABLE, and no url has screen availability AVAILABLE or UNSUPPORTED;
+  // Returns UNKNOWN if all urls in |urls| have screen availability
+  // UNKNOWN.
+  ScreenAvailability GetScreenAvailability(const std::vector<GURL>& urls);
 
   DISALLOW_COPY_AND_ASSIGN(PresentationDispatcher);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_PRESENTATION_PRESENTATION_DISPATCHER_H_