Move DirectoryReader::ReadEntries to FileRef::ReadDirectoryEntries

ppapi/proxy/ppb_file_ref_proxy.cc

 // 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.
 
 #include "ppapi/proxy/ppb_file_ref_proxy.h"
 
 #include <map>
 
 #include "base/bind.h"
 #include "ppapi/c/pp_errors.h"
 #include "ppapi/c/ppb_file_ref.h"
 #include "ppapi/c/private/ppb_file_ref_private.h"
 #include "ppapi/c/private/ppb_proxy_private.h"
 #include "ppapi/proxy/enter_proxy.h"
 #include "ppapi/proxy/host_dispatcher.h"
 #include "ppapi/proxy/plugin_dispatcher.h"
 #include "ppapi/proxy/ppapi_messages.h"
 #include "ppapi/proxy/serialized_var.h"
+#include "ppapi/shared_impl/array_writer.h"
 #include "ppapi/shared_impl/ppb_file_ref_shared.h"
 #include "ppapi/shared_impl/scoped_pp_resource.h"
 #include "ppapi/shared_impl/tracked_callback.h"
 #include "ppapi/thunk/resource_creation_api.h"
 #include "ppapi/thunk/thunk.h"
 
 using ppapi::thunk::EnterResourceNoLock;
 using ppapi::thunk::PPB_FileRef_API;
 using ppapi::thunk::ResourceCreationAPI;
 
 namespace ppapi {
 namespace proxy {
 
+namespace {
+
+void ReleaseEntries(const std::vector<PP_DirectoryEntry>& entries) {
+  ResourceTracker* tracker = PpapiGlobals::Get()->GetResourceTracker();
+  for (std::vector<PP_DirectoryEntry>::const_iterator it = entries.begin();
+       it != entries.end(); ++it)
+    tracker->ReleaseResource(it->file_ref);
+}
+
+}  // namespace
+
 class FileRef : public PPB_FileRef_Shared {
  public:
   explicit FileRef(const PPB_FileRef_CreateInfo& info);
   virtual ~FileRef();
 
   // Resource overrides.
   virtual void LastPluginRefWasDeleted() OVERRIDE;
 
   // PPB_FileRef_API implementation (not provided by PPB_FileRef_Shared).
   virtual PP_Resource GetParent() OVERRIDE;
   virtual int32_t MakeDirectory(
       PP_Bool make_ancestors,
       scoped_refptr<TrackedCallback> callback) OVERRIDE;
   virtual int32_t Touch(PP_Time last_access_time,
                         PP_Time last_modified_time,
                         scoped_refptr<TrackedCallback> callback) OVERRIDE;
   virtual int32_t Delete(scoped_refptr<TrackedCallback> callback) OVERRIDE;
   virtual int32_t Rename(PP_Resource new_file_ref,
                          scoped_refptr<TrackedCallback> callback) OVERRIDE;
   virtual int32_t Query(PP_FileInfo* info,
                         scoped_refptr<TrackedCallback> callback) OVERRIDE;
+  virtual int32_t ReadEntries(const PP_ArrayOutput& output,
+                              scoped_refptr<TrackedCallback> callback) OVERRIDE;
+  virtual int32_t ReadEntriesInHost(
+      std::vector<ppapi::PPB_FileRef_CreateInfo>* files,
+      std::vector<PP_FileType>* file_types,
+      scoped_refptr<TrackedCallback> callback) OVERRIDE;
   virtual PP_Var GetAbsolutePath() OVERRIDE;
 
   // Executes the pending callback with the given ID. See pending_callbacks_.
   void ExecuteCallback(uint32_t callback_id, int32_t result);
   void SetFileInfo(uint32_t callback_id, const PP_FileInfo& info);
+  int32_t SetReadEntriesOutput(
+      uint32_t callback_id,
+      const std::vector<ppapi::PPB_FileRef_CreateInfo>& infos,
+      const std::vector<PP_FileType>& file_types);
 
  private:
   PluginDispatcher* GetDispatcher() const {
     return PluginDispatcher::GetForResource(this);
   }
 
   // Adds a callback to the list and returns its ID.
   uint32_t SendCallback(scoped_refptr<TrackedCallback> callback);
 
   // This class can have any number of out-standing requests with completion
   // callbacks, in contrast to most resources which have one possible pending
   // callback pending (like a Flush callback).
   //
   // To keep track of them, assign integer IDs to the callbacks, which is how
   // the callback will be identified when it's passed to the host and then
   // back here. Use unsigned so that overflow is well-defined.
   uint32_t next_callback_id_;
   typedef std::map<uint32_t,
                    scoped_refptr<TrackedCallback> > PendingCallbackMap;
   PendingCallbackMap pending_callbacks_;
 
   // Used to keep pointers to PP_FileInfo instances that are written before
   // callbacks are invoked. The id of a pending file info will match that of
   // the corresponding callback.
   typedef std::map<uint32_t, PP_FileInfo*> PendingFileInfoMap;
   PendingFileInfoMap pending_file_infos_;
 
+  // Used to keep PP_ArrayOutput instances that are written before callbacks
+  // are invoked. The id of a pending array output will match that of the
+  // corresponding callback.
+  typedef std::map<uint32_t, PP_ArrayOutput> PendingReadEntriesOutputMap;
+  PendingReadEntriesOutputMap pending_read_entries_outputs_;
+
   // Holds a reference on plugin side when running out of process, so that
   // FileSystem won't die before FileRef.  See PPB_FileRef_Impl for
   // corresponding code for in-process mode.  Note that this workaround will
   // be no longer needed after FileRef refactoring.
   ScopedPPResource file_system_;
 
   DISALLOW_IMPLICIT_CONSTRUCTORS(FileRef);
 };
 
 FileRef::FileRef(const PPB_FileRef_CreateInfo& info)
     : PPB_FileRef_Shared(OBJECT_IS_PROXY, info),
       next_callback_id_(0u),
       file_system_(info.file_system_plugin_resource) {
 }
 
 FileRef::~FileRef() {
   // The callbacks map should have been cleared by LastPluginRefWasDeleted.
   DCHECK(pending_callbacks_.empty());
   DCHECK(pending_file_infos_.empty());
+  DCHECK(pending_read_entries_outputs_.empty());
 }
 
 void FileRef::LastPluginRefWasDeleted() {
   // The callback tracker will abort our callbacks for us.
   pending_callbacks_.clear();
   pending_file_infos_.clear();
+  pending_read_entries_outputs_.clear();
 }
 
 PP_Resource FileRef::GetParent() {
   PPB_FileRef_CreateInfo create_info;
   GetDispatcher()->Send(new PpapiHostMsg_PPBFileRef_GetParent(
       API_ID_PPB_FILE_REF, host_resource(), &create_info));
   return PPB_FileRef_Proxy::DeserializeFileRef(create_info);
 }
 
 int32_t FileRef::MakeDirectory(PP_Bool make_ancestors,
@@ skipping 36 matching lines @@
 int32_t FileRef::Query(PP_FileInfo* info,
                        scoped_refptr<TrackedCallback> callback) {
   // Store the pending file info id.
   int id = SendCallback(callback);
   pending_file_infos_[id] = info;
   GetDispatcher()->Send(new PpapiHostMsg_PPBFileRef_Query(
       API_ID_PPB_FILE_REF, host_resource(), id));
   return PP_OK_COMPLETIONPENDING;
 }
 
+int32_t FileRef::ReadEntries(const PP_ArrayOutput& output,
+                             scoped_refptr<TrackedCallback> callback) {
+  // Store the pending read entries output id.
+  int id = SendCallback(callback);
+  pending_read_entries_outputs_[id] = output;
+  GetDispatcher()->Send(new PpapiHostMsg_PPBFileRef_ReadEntries(
+      API_ID_PPB_FILE_REF, host_resource(), id));
+  return PP_OK_COMPLETIONPENDING;
+}
+
+int32_t FileRef::ReadEntriesInHost(
+    std::vector<ppapi::PPB_FileRef_CreateInfo>* files,
+    std::vector<PP_FileType>* file_types,
+    scoped_refptr<TrackedCallback> callback) {
+  NOTREACHED();
+  return PP_ERROR_FAILED;
+}
+
 PP_Var FileRef::GetAbsolutePath() {
   ReceiveSerializedVarReturnValue result;
   GetDispatcher()->Send(new PpapiHostMsg_PPBFileRef_GetAbsolutePath(
       API_ID_PPB_FILE_REF, host_resource(), &result));
   return result.Return(GetDispatcher());
 }
 
 void FileRef::ExecuteCallback(uint32_t callback_id, int32_t result) {
   PendingCallbackMap::iterator found = pending_callbacks_.find(callback_id);
   if (found == pending_callbacks_.end()) {
@@ skipping 11 matching lines @@
 
 void FileRef::SetFileInfo(uint32_t callback_id, const PP_FileInfo& info) {
   PendingFileInfoMap::iterator found = pending_file_infos_.find(callback_id);
   if (found == pending_file_infos_.end())
     return;
   PP_FileInfo* target_info = found->second;
   *target_info = info;
   pending_file_infos_.erase(found);
 }
 
+int32_t FileRef::SetReadEntriesOutput(
+    uint32_t callback_id,
+    const std::vector<ppapi::PPB_FileRef_CreateInfo>& infos,
+    const std::vector<PP_FileType>& file_types) {
+  PendingReadEntriesOutputMap::iterator found =
+      pending_read_entries_outputs_.find(callback_id);
+  if (found == pending_read_entries_outputs_.end())
+    return PP_OK;
+
+  PP_ArrayOutput output = found->second;
+  pending_read_entries_outputs_.erase(found);
+
+  std::vector<PP_DirectoryEntry> entries;
+  for (std::vector<ppapi::PPB_FileRef_CreateInfo>::size_type i = 0;
+       i < infos.size(); ++i) {
+    PP_DirectoryEntry entry;
+    entry.file_ref = PPB_FileRef_Proxy::DeserializeFileRef(infos[i]);
+    entry.file_type = file_types[i];
+    entries.push_back(entry);
+  }
+
+  ArrayWriter writer(output);
+  if (!writer.is_valid()) {
+    ReleaseEntries(entries);
+    entries.clear();
+    return PP_ERROR_BADARGUMENT;
+  }
+
+  writer.StoreVector(entries);
+  entries.clear();
+  return PP_OK;
+}
+
 uint32_t FileRef::SendCallback(scoped_refptr<TrackedCallback> callback) {
   // In extreme cases the IDs may wrap around, so avoid duplicates.
   while (pending_callbacks_.count(next_callback_id_))
     ++next_callback_id_;
 
   pending_callbacks_[next_callback_id_] = callback;
   return next_callback_id_++;
 }
 
 PPB_FileRef_Proxy::PPB_FileRef_Proxy(Dispatcher* dispatcher)
@@ skipping 20 matching lines @@
   IPC_BEGIN_MESSAGE_MAP(PPB_FileRef_Proxy, msg)
 #if !defined(OS_NACL)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_Create, OnMsgCreate)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_GetParent, OnMsgGetParent)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_MakeDirectory,
                         OnMsgMakeDirectory)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_Touch, OnMsgTouch)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_Delete, OnMsgDelete)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_Rename, OnMsgRename)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_Query, OnMsgQuery)
+    IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_ReadEntries, OnMsgReadEntries)
     IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBFileRef_GetAbsolutePath,
                         OnMsgGetAbsolutePath)
 #endif  // !defined(OS_NACL)
 
     IPC_MESSAGE_HANDLER(PpapiMsg_PPBFileRef_CallbackComplete,
                         OnMsgCallbackComplete)
     IPC_MESSAGE_HANDLER(PpapiMsg_PPBFileRef_QueryCallbackComplete,
                         OnMsgQueryCallbackComplete)
+    IPC_MESSAGE_HANDLER(PpapiMsg_PPBFileRef_ReadEntriesCallbackComplete,
+                        OnMsgReadEntriesCallbackComplete)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 // static
 void PPB_FileRef_Proxy::SerializeFileRef(PP_Resource file_ref,
                                          PPB_FileRef_CreateInfo* result) {
   EnterResourceNoLock<PPB_FileRef_API> enter(file_ref, false);
   if (enter.succeeded())
@@ skipping 87 matching lines @@
   if (enter.succeeded())
     enter.SetResult(enter.object()->Query(info, enter.callback()));
 }
 
 void PPB_FileRef_Proxy::OnMsgGetAbsolutePath(const HostResource& host_resource,
                                              SerializedVarReturnValue result) {
   EnterHostFromHostResource<PPB_FileRef_API> enter(host_resource);
   if (enter.succeeded())
     result.Return(dispatcher(), enter.object()->GetAbsolutePath());
 }
+
+void PPB_FileRef_Proxy::OnMsgReadEntries(const HostResource& file_ref,
+                                         uint32_t callback_id) {
+  std::vector<ppapi::PPB_FileRef_CreateInfo>* files =
+      new std::vector<ppapi::PPB_FileRef_CreateInfo>();
+  std::vector<PP_FileType>* file_types = new std::vector<PP_FileType>();
+  HostCallbackParams* params = new HostCallbackParams(file_ref, callback_id);
+  EnterHostFromHostResourceForceCallback<PPB_FileRef_API> enter(
+      file_ref, callback_factory_,
+      &PPB_FileRef_Proxy::OnReadEntriesCallbackCompleteInHost,
+      base::Owned(params), base::Owned(files), base::Owned(file_types));
+  if (enter.succeeded()) {
+    enter.SetResult(enter.object()->ReadEntriesInHost(files, file_types,
+                                                      enter.callback()));
+  }
+}
+
 #endif  // !defined(OS_NACL)
 
 void PPB_FileRef_Proxy::OnMsgCallbackComplete(
     const HostResource& host_resource,
     uint32_t callback_id,
     int32_t result) {
   // Forward the callback info to the plugin resource.
   EnterPluginFromHostResource<PPB_FileRef_API> enter(host_resource);
   if (enter.succeeded())
     static_cast<FileRef*>(enter.object())->ExecuteCallback(callback_id, result);
 }
 
 void PPB_FileRef_Proxy::OnMsgQueryCallbackComplete(
     const HostResource& host_resource,
     const PP_FileInfo& info,
     uint32_t callback_id,
     int32_t result) {
   EnterPluginFromHostResource<PPB_FileRef_API> enter(host_resource);
   if (enter.succeeded()) {
     // Set the FileInfo output parameter.
     static_cast<FileRef*>(enter.object())->SetFileInfo(callback_id, info);
     static_cast<FileRef*>(enter.object())->ExecuteCallback(callback_id, result);
   }
 }
 
+void PPB_FileRef_Proxy::OnMsgReadEntriesCallbackComplete(
+    const HostResource& host_resource,
+    const std::vector<ppapi::PPB_FileRef_CreateInfo>& infos,
+    const std::vector<PP_FileType>& file_types,
+    uint32_t callback_id,
+    int32_t result) {
+  CHECK_EQ(infos.size(), file_types.size());
+
+  EnterPluginFromHostResource<PPB_FileRef_API> enter(host_resource);
+  if (enter.succeeded()) {
+    int32_t set_result =

[teravest, 2013/05/02 17:32:10]

Why bother setting the read entries if the result != PP_OK?

[hamaji, 2013/05/02 18:49:40]

Done.

+        static_cast<FileRef*>(enter.object())->SetReadEntriesOutput(
+            callback_id, infos, file_types);
+    if (set_result != PP_OK)
+      result = set_result;
+    static_cast<FileRef*>(enter.object())->ExecuteCallback(
+        callback_id, result);
+  }
+}
+
 #if !defined(OS_NACL)
 void PPB_FileRef_Proxy::OnCallbackCompleteInHost(
     int32_t result,
     const HostResource& host_resource,
     uint32_t callback_id) {
   // Execute OnMsgCallbackComplete in the plugin process.
   Send(new PpapiMsg_PPBFileRef_CallbackComplete(
       API_ID_PPB_FILE_REF, host_resource, callback_id, result));
 }
 
 void PPB_FileRef_Proxy::OnQueryCallbackCompleteInHost(
     int32_t result,
     const HostResource& host_resource,
     base::internal::OwnedWrapper<PP_FileInfo> info,
     uint32_t callback_id) {
   Send(new PpapiMsg_PPBFileRef_QueryCallbackComplete(
       API_ID_PPB_FILE_REF, host_resource, *info.get(), callback_id, result));
 }
+
+void PPB_FileRef_Proxy::OnReadEntriesCallbackCompleteInHost(
+    int32_t result,
+    base::internal::OwnedWrapper<HostCallbackParams> params,

[dmichael (off chromium), 2013/05/02 19:43:54]

Can you just pass this one by value? It doesn't seem worth the complication to
pass it by pointer.

[hamaji, 2013/05/02 20:14:49]

Done.

+    base::internal::OwnedWrapper<
+      std::vector<ppapi::PPB_FileRef_CreateInfo> > files,
+    base::internal::OwnedWrapper<std::vector<PP_FileType> > file_types) {

[dmichael (off chromium), 2013/05/02 19:43:54]

^^^ For these, you might consider linked_ptr<> or auto_ptr<> so you don't have
to use base::internal stuff.

[hamaji, 2013/05/02 20:14:49]

Done. I used linked_ptr because auto_ptr is not allowed by google's C++ style. 

+  Send(new PpapiMsg_PPBFileRef_ReadEntriesCallbackComplete(
+      API_ID_PPB_FILE_REF, params.get()->host_resource,
+      *files.get(), *file_types.get(), params.get()->callback_id, result));
+}
+
 #endif  // !defined(OS_NACL)
 
 }  // namespace proxy
 }  // namespace ppapi