Add GetSitesWithData and FreeSiteList methods to PPP_Flash_BrowserOperations interface and hook the…

ppapi/api/private/ppp_flash_browser_operations.idl

 /* Copyright (c) 2012 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.
  */
 
 /**
  * This file contains the <code>PPP_Flash_BrowserOperations</code> interface.
  */
 
 label Chrome {
   M20 = 1.0,
-  M21 = 1.2
+  M21 = 1.2,
+  M22 = 1.3
 };
 
 [assert_size(4)]
 enum PP_Flash_BrowserOperations_SettingType {
   PP_FLASH_BROWSEROPERATIONS_SETTINGTYPE_CAMERAMIC = 0,
   PP_FLASH_BROWSEROPERATIONS_SETTINGTYPE_PEERNETWORKING = 1
 };
 
 [assert_size(4)]
 enum PP_Flash_BrowserOperations_Permission {
@@ skipping 14 matching lines @@
     [in] PP_Bool success,
     [in] PP_Flash_BrowserOperations_Permission default_permission,
     [in] uint32_t site_count,
     [in, size_is(site_count)] PP_Flash_BrowserOperations_SiteSetting[] sites);
 
 /**
  * This interface allows the browser to request the plugin do things.
  */
 interface PPP_Flash_BrowserOperations {
   /**
+   * Returns a list of sites that have stored data, for use with the

[brettw, 2012/07/25 23:17:03]

Can you put these new versions at the bottom?

I try to keep "point" revisions of interfaces the same as the previous version
but with additions at the bottom (so you can downcast safely).

[Bernhard Bauer, 2012/07/26 00:18:53]

Done.

+   * "Clear site data" feature.
+   *
+   * @param[in] plugin_data_path String containing the directory where the
+   * plugin data is stored.
+   * @param[out] sites A NULL-terminated array of sites that have stored data.
+   * Use FreeSiteList on the the array when done.
+   *
+   * See also the NPP_GetSitesWithData function in NPAPI:
+   * https://wiki.mozilla.org/NPAPI:ClearSiteData
+   */
+  [version=1.3]
+  void GetSitesWithData([in] str_t plugin_data_path,
+                        [out] str_t[] sites);

[brettw, 2012/07/25 23:17:03]

We need to define how the memory management works here. We say that the plugin
and system don't necessarily share the same allocator, so we don't want this.
Probably this function should just return a PP_Var that's a string.

Can you mention how the return value is formatted? (i.e. how the sites are
separated).

[yzshen1, 2012/07/25 23:56:24]

We couldn't use PP_Var in this interface, because the broker process doesn't
have var tracker.

[Bernhard Bauer, 2012/07/26 00:18:53]

The caller passes in the list of sites to FreeSiteList() afterwards to free it.
Allocation and deallocation are both done by Flash.
The outparam is an array of char*'s (which makes it a char***), not a single
string.

+
+  /**
+   * Frees the list of sites returned by GetSitesWithData.
+   *
+   * @param[in] sites A NULL-terminated array of strings.
+   */
+  [version=1.3]
+  void FreeSiteList([inout] str_t[] sites);

[brettw, 2012/07/25 23:17:03]

Ditto with the return value instead of out param.

+
+  /**
    * This function allows the plugin to implement the "Clear site data" feature.
    *
-   * @plugin_data_path String containing the directory where the plugin data is
+   * @param[in] plugin_data_path String containing the directory where the
+   * plugin data is
    * stored. On UTF16 systems (Windows), this will be encoded as UTF-8. It will
    * be an absolute path and will not have a directory separator (slash) at the
    * end.
-   *
-   * @arg site String specifying which site to clear the data for. This will
-   * be null to clear data for all sites.
-   *
-   * @arg flags Currently always 0 in Chrome to clear all data. This may be
-   * extended in the future to clear only specific types of data.
-   *
-   * @arg max_age The maximum age in seconds to clear data for. This allows the
-   * plugin to implement "clear past hour" and "clear past data", etc.
+   * @param[in] site String specifying which site to clear the data for. This
+   * will be null to clear data for all sites.
+   * @param[in] flags Currently always 0 in Chrome to clear all data. This may
+   * be extended in the future to clear only specific types of data.
+   * @param[in] max_age The maximum age in seconds to clear data for. This
+   * allows the plugin to implement "clear past hour" and "clear past data",
+   * etc.
    *
    * @return PP_TRUE on success, PP_FALSE on failure.
    *
    * See also the NPP_ClearSiteData function in NPAPI.
    * https://wiki.mozilla.org/NPAPI:ClearSiteData
    */
-  PP_Bool ClearSiteData(str_t plugin_data_path,
-                        str_t site,
-                        uint64_t flags,
-                        uint64_t max_age);
+  PP_Bool ClearSiteData([in] str_t plugin_data_path,
+                        [in] str_t site,
+                        [in] uint64_t flags,
+                        [in] uint64_t max_age);
 
   /**
    * Requests the plugin to deauthorize content licenses. It prevents Flash from
    * playing protected content, such as movies and music the user may have
    * rented or purchased.
    *
    * @param[in] plugin_data_path String containing the directory where the
    * plugin settings are stored.
    *
    * @return <code>PP_TRUE</code> on success, <code>PP_FALSE</code> on failure.
@@ skipping 53 matching lines @@
    *
    * @return <code>PP_TRUE</code> on success, <code>PP_FALSE</code> on failure.
    */
   [version=1.2]
   PP_Bool SetSitePermission(
       [in] str_t plugin_data_path,
       [in] PP_Flash_BrowserOperations_SettingType setting_type,
       [in] uint32_t site_count,
       [in, size_is(site_count)] PP_Flash_BrowserOperations_SiteSetting[] sites);
 };