filechooser: Add SelectedFileInfo class to pass display names to WebKit

filechooser: Add SelectedFileInfo class to pass display names to WebKit

Files on gdata are cached locally with human unreadable names like
/blah/gdata/cache/d41d8cd98f00b204e9800998ecf8427e. When these files
are selected from the file chooser for uploading from <form>,
we should pass display names, in addition to real paths, to WebKit,
so the proper names are shown in web pages, and used for uploading.

This patch simply adds SelectedFileInfo with minimal code changes.
There should be no behavior changes.
The file selection code for Chrome OS will be changed in a separate patch.

BUG=chromium-os:27222
TEST=try bots.

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=126606

[satorux1, 2012-03-09 18:19:06]

Hi Darin and Kinuko,

Please take a look. Once I get go-ahead from you, I'll add some more reviewers
to get all the approval for submission. Thanks.

[kinuko (google), 2012-03-09 19:16:57]

The code itself looking good, added some cosmetic comments.

http://codereview.chromium.org/9651028/diff/6001/chrome/browser/ui/select_fil...
File chrome/browser/ui/select_file_dialog.h (right):

http://codereview.chromium.org/9651028/diff/6001/chrome/browser/ui/select_fil...
chrome/browser/ui/select_file_dialog.h:69: // FilePath. Used for passing extra
information (ex. display path).
"display path" sounds confusing since it's to be exposed as File.name, which
should not include the path part per spec.  "display name" or just "name" with
some description might be better?

http://codereview.chromium.org/9651028/diff/6001/content/common/view_messages.h
File content/common/view_messages.h (right):

http://codereview.chromium.org/9651028/diff/6001/content/common/view_messages...
content/common/view_messages.h:1013: /* selected files */
nit: it'd be probably ok to drop this comment as it's not adding much info...

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
File content/public/common/file_chooser_params.h (right):

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
content/public/common/file_chooser_params.h:25: FilePath display_path;
Ditto, can we avoid using the word 'path' here?  (Otherwise the consumer of this
class will need to call BaseName() to make sure it only gets 'name' part)

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
content/public/common/file_chooser_params.h:33: }
I guess clang will complain having ctor/dtor body in the header.

[satorux1, 2012-03-09 19:29:26]

http://codereview.chromium.org/9651028/diff/6001/chrome/browser/ui/select_fil...
File chrome/browser/ui/select_file_dialog.h (right):

http://codereview.chromium.org/9651028/diff/6001/chrome/browser/ui/select_fil...
chrome/browser/ui/select_file_dialog.h:69: // FilePath. Used for passing extra
information (ex. display path).
On 2012/03/09 19:16:57, kinuko (google) wrote:
> "display path" sounds confusing since it's to be exposed as File.name, which
> should not include the path part per spec.  "display name" or just "name" with
> some description might be better?

Done.

http://codereview.chromium.org/9651028/diff/6001/content/common/view_messages.h
File content/common/view_messages.h (right):

http://codereview.chromium.org/9651028/diff/6001/content/common/view_messages...
content/common/view_messages.h:1013: /* selected files */
On 2012/03/09 19:16:57, kinuko (google) wrote:
> nit: it'd be probably ok to drop this comment as it's not adding much info...

Done.

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
File content/public/common/file_chooser_params.h (right):

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
content/public/common/file_chooser_params.h:25: FilePath display_path;
On 2012/03/09 19:16:57, kinuko (google) wrote:
> Ditto, can we avoid using the word 'path' here?  (Otherwise the consumer of
this
> class will need to call BaseName() to make sure it only gets 'name' part)


Changed to display_name, and fixed the comment. Originally, I meant to put an
absolute path to display_path, but as discussed offline, we only need to put a
base name here, which is consistent with what the file system api does. updated
the comment as well.

BTW, since this now only contains the base name, should we change this to
FilePath::StringType?

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
content/public/common/file_chooser_params.h:33: }
On 2012/03/09 19:16:57, kinuko (google) wrote:
> I guess clang will complain having ctor/dtor body in the header.

If sizeof(members) is small enough, clang won't complain, but you are right it's
safer to put this in .cc. done.

[satorux1, 2012-03-09 21:38:36]

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
File content/public/common/file_chooser_params.h (right):

http://codereview.chromium.org/9651028/diff/6001/content/public/common/file_c...
content/public/common/file_chooser_params.h:25: FilePath display_path;
On 2012/03/09 19:29:26, satorux1 wrote:
> On 2012/03/09 19:16:57, kinuko (google) wrote:
> > Ditto, can we avoid using the word 'path' here?  (Otherwise the consumer of
> this
> > class will need to call BaseName() to make sure it only gets 'name' part)
> 
> 
> Changed to display_name, and fixed the comment. Originally, I meant to put an
> absolute path to display_path, but as discussed offline, we only need to put a
> base name here, which is consistent with what the file system api does.
updated
> the comment as well.
> 
> BTW, since this now only contains the base name, should we change this to
> FilePath::StringType?

Changed to FilePath::StringType

[kinuko, 2012-03-13 10:58:02]

LGTM (though you'll need more lgtm's)

[satorux1, 2012-03-13 16:56:29]

adding sky@ for chrome/browser/ui/...
jam@ for content/public/...

[sky, 2012-03-13 17:41:50]

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
File chrome/browser/file_select_helper.cc (right):

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
chrome/browser/file_select_helper.cc:217:
content::SelectedFileInfo(entry->results_[i], FilePath::StringType()));
Isn't this the same as 134-137. How about a common function?

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
File chrome/browser/file_select_helper.h (right):

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
chrome/browser/file_select_helper.h:88: int index, void* params) OVERRIDE;
nit: params on its own line (same comment for .cc).

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/ui/select_fi...
File chrome/browser/ui/select_file_dialog.h (right):

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/ui/select_fi...
chrome/browser/ui/select_file_dialog.h:72: int index, void* params) {};
params on its own line and no ;

[satorux1, 2012-03-13 18:01:28]

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
File chrome/browser/file_select_helper.cc (right):

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
chrome/browser/file_select_helper.cc:217:
content::SelectedFileInfo(entry->results_[i], FilePath::StringType()));
On 2012/03/13 17:41:50, sky wrote:
> Isn't this the same as 134-137. How about a common function?

Good idea. done.

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
File chrome/browser/file_select_helper.h (right):

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/file_select_...
chrome/browser/file_select_helper.h:88: int index, void* params) OVERRIDE;
On 2012/03/13 17:41:50, sky wrote:
> nit: params on its own line (same comment for .cc).

Done.

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/ui/select_fi...
File chrome/browser/ui/select_file_dialog.h (right):

http://codereview.chromium.org/9651028/diff/10001/chrome/browser/ui/select_fi...
chrome/browser/ui/select_file_dialog.h:72: int index, void* params) {};
On 2012/03/13 17:41:50, sky wrote:
> params on its own line and no ;

Done.

[sky, 2012-03-13 18:20:51]

LGTM

[satorux1, 2012-03-13 18:21:51]

forgot to add jam@ for content/public changes.

[jam, 2012-03-13 19:30:18]

for content api, you need to put every class/struct in a separate file. we also
try to keep the number of files in content/public to a minimum.

why make a struct just for two members instead of passing an std::pair?

[satorux1, 2012-03-13 19:39:03]

On 2012/03/13 19:30:18, John Abd-El-Malek wrote:
> for content api, you need to put every class/struct in a separate file. we
also
> try to keep the number of files in content/public to a minimum.
> 
> why make a struct just for two members instead of passing an std::pair?

1) std::pair is harder to read
2) we might want to add some more in the future (no concrete plan yet, though)

[jam, 2012-03-13 19:59:08]

On 2012/03/13 19:39:03, satorux1 wrote:
> On 2012/03/13 19:30:18, John Abd-El-Malek wrote:
> > for content api, you need to put every class/struct in a separate file. we
> also
> > try to keep the number of files in content/public to a minimum.
> > 
> > why make a struct just for two members instead of passing an std::pair?
> 
> 1) std::pair is harder to read

I understand. We just have to balance that with the cost of adding another file
(or two, depending on clang) to content/public. The more files we have in there,
the harder it is for someone new to content to look through all the API files to
find what they need.

If you feel strongly it should be a struct, then move it to a separate file.
only add a .cc file if it's necessary to avoid clang errors.

> 2) we might want to add some more in the future (no concrete plan yet, though)

[satorux1, 2012-03-13 20:52:05]

On 2012/03/13 19:59:08, John Abd-El-Malek wrote:
> On 2012/03/13 19:39:03, satorux1 wrote:
> > On 2012/03/13 19:30:18, John Abd-El-Malek wrote:
> > > for content api, you need to put every class/struct in a separate file. we
> > also
> > > try to keep the number of files in content/public to a minimum.
> > > 
> > > why make a struct just for two members instead of passing an std::pair?
> > 
> > 1) std::pair is harder to read
> 
> I understand. We just have to balance that with the cost of adding another
file
> (or two, depending on clang) to content/public. The more files we have in
there,
> the harder it is for someone new to content to look through all the API files
to
> find what they need.
> 
> If you feel strongly it should be a struct, then move it to a separate file.
> only add a .cc file if it's necessary to avoid clang errors.

Thank you for sharing your thoughts. I took another look, and I found another
reason to prefer a struct to a std::pair:

3) WebKit uses a similar struct for selected files.

So I'd like to go with a struct to be in sync with WebKit.

Uploaded a new patch. Didn't add selected_file_info.cc file, as I think the
struct is small enough so clang won't complain.


> 
> > 2) we might want to add some more in the future (no concrete plan yet,
though)

[jam, 2012-03-14 00:47:00]

lgtm with nits addressed

http://codereview.chromium.org/9651028/diff/14005/chrome/browser/file_select_...
File chrome/browser/file_select_helper.cc (right):

http://codereview.chromium.org/9651028/diff/14005/chrome/browser/file_select_...
chrome/browser/file_select_helper.cc:227: =
ConvertToSelectedFileInfoList(entry->results_);
nit: the "=" should be on the previous line per the style guide

http://codereview.chromium.org/9651028/diff/14005/chrome/browser/file_select_...
File chrome/browser/file_select_helper.h (right):

http://codereview.chromium.org/9651028/diff/14005/chrome/browser/file_select_...
chrome/browser/file_select_helper.h:16: #include
"content/public/common/selected_file_info.h"
nit: forward declare

http://codereview.chromium.org/9651028/diff/14005/chrome/browser/ui/select_fi...
File chrome/browser/ui/select_file_dialog.h (right):

http://codereview.chromium.org/9651028/diff/14005/chrome/browser/ui/select_fi...
chrome/browser/ui/select_file_dialog.h:15: #include
"content/public/common/selected_file_info.h"
nit: forward declare

http://codereview.chromium.org/9651028/diff/14005/content/browser/renderer_ho...
File content/browser/renderer_host/render_view_host_impl.cc (right):

http://codereview.chromium.org/9651028/diff/14005/content/browser/renderer_ho...
content/browser/renderer_host/render_view_host_impl.cc:725: const
content::SelectedFileInfo& file = files[i];
nit: content:: not needed since you're already in the content namespace. also
above

http://codereview.chromium.org/9651028/diff/14005/content/browser/renderer_ho...
File content/browser/renderer_host/render_view_host_impl.h (right):

http://codereview.chromium.org/9651028/diff/14005/content/browser/renderer_ho...
content/browser/renderer_host/render_view_host_impl.h:22: #include
"content/public/common/selected_file_info.h"
nit: forward declare

http://codereview.chromium.org/9651028/diff/14005/content/public/browser/rend...
File content/public/browser/render_view_host.h (right):

http://codereview.chromium.org/9651028/diff/14005/content/public/browser/rend...
content/public/browser/render_view_host.h:13: #include
"content/public/common/selected_file_info.h"
nit: forward declare

http://codereview.chromium.org/9651028/diff/14005/content/public/common/selec...
File content/public/common/selected_file_info.h (right):

http://codereview.chromium.org/9651028/diff/14005/content/public/common/selec...
content/public/common/selected_file_info.h:29: SelectedFileInfo() {}
nit: is this necessary?

http://codereview.chromium.org/9651028/diff/14005/content/renderer/render_vie...
File content/renderer/render_view_impl.h (right):

http://codereview.chromium.org/9651028/diff/14005/content/renderer/render_vie...
content/renderer/render_view_impl.h:31: #include
"content/public/common/selected_file_info.h"
nit: forward declare instead

[satorux1, 2012-03-14 06:20:59]

https://chromiumcodereview.appspot.com/9651028/diff/14005/chrome/browser/file...
File chrome/browser/file_select_helper.cc (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/chrome/browser/file...
chrome/browser/file_select_helper.cc:227: =
ConvertToSelectedFileInfoList(entry->results_);
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: the "=" should be on the previous line per the style guide

Done.

https://chromiumcodereview.appspot.com/9651028/diff/14005/chrome/browser/file...
File chrome/browser/file_select_helper.h (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/chrome/browser/file...
chrome/browser/file_select_helper.h:16: #include
"content/public/common/selected_file_info.h"
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: forward declare

Done.

https://chromiumcodereview.appspot.com/9651028/diff/14005/chrome/browser/ui/s...
File chrome/browser/ui/select_file_dialog.h (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/chrome/browser/ui/s...
chrome/browser/ui/select_file_dialog.h:15: #include
"content/public/common/selected_file_info.h"
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: forward declare

Done.

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/browser/ren...
File content/browser/renderer_host/render_view_host_impl.cc (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/browser/ren...
content/browser/renderer_host/render_view_host_impl.cc:725: const
content::SelectedFileInfo& file = files[i];
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: content:: not needed since you're already in the content namespace. also
> above

Done.

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/browser/ren...
File content/browser/renderer_host/render_view_host_impl.h (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/browser/ren...
content/browser/renderer_host/render_view_host_impl.h:22: #include
"content/public/common/selected_file_info.h"
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: forward declare

Done.

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/public/brow...
File content/public/browser/render_view_host.h (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/public/brow...
content/public/browser/render_view_host.h:13: #include
"content/public/common/selected_file_info.h"
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: forward declare

Done.

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/public/comm...
File content/public/common/selected_file_info.h (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/public/comm...
content/public/common/selected_file_info.h:29: SelectedFileInfo() {}
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: is this necessary?

This was needed for serialization for IPC to work.

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/renderer/re...
File content/renderer/render_view_impl.h (right):

https://chromiumcodereview.appspot.com/9651028/diff/14005/content/renderer/re...
content/renderer/render_view_impl.h:31: #include
"content/public/common/selected_file_info.h"
On 2012/03/14 00:47:01, John Abd-El-Malek wrote:
> nit: forward declare instead

Done.