Original status: 5-Cause Known; Suggested Status: NEW

Original Target Release: shortfin_dev; Suggested Target Milestone : 5.5

These items should be added to the Keywords: RELNOTE

Original submitter: edwingo

Description:
The file name appears correctly on the browser and in the log file, but the
image does not come up when the file name is mbyte.  Everything works fine when
only ASCII is used for the file name.

Evaluation:
(by edwingo)
An I18n issue so I am requesting a waiver since we are at RC2 for the EN
release. I'll investigate and fix for a future release.

Evaluation (Entry 2):
(by edwingo)
The tutorial app stores the uploaded file contents into a new file with the same
name as the original name on the browser's system and then renders an image
component with a URL set to that file. This works for ASCII, but not in general.
Here's why, on post-back, the file name is encoded in UTF-8 (usually). On the
server, a file with that same name is used to hold the contents. Then an image
component is used with its URL property set to that same UTF-8
original-file-name. The image component tries to render something like <img
src=".../orignal-file-name"/>, but the rendering is messed up because it
contains UTF-8 chars. When the browser fetches the image src, it is not found so
the space is left blank. Based on comments in the code, it appears that JSF is
supposed to properly escape the file name according to specified URL encoding
rules but does not. I haven't checked the JSF spec. So I see some options:

1) Fix this bug in the JSF RI
2) Change the app so that it only uses URLs with ISO-8859-1 chars
3) Change the app by writing to a fixed file name

I think #3 is easiest. I haven't spent time figuring out what is the specified
behavior for the URL property of an image component. Was it intended to contain
UTF-8 chars? I think there are newer WWW specs in the works that allow for IRIs
that map them to URIs using UTF-8, but I don't know if it is widely implemented
yet. So I would recommend #3 or #2. I've tested that #3 works.

I'll re-assign this to tutorials and who I think is the RE. I'll also see if #1
is possible, but that will take some time for it to be implemented. Also, older
apps will still not work so I think that we should still change the tutorial app.

Evaluation (Entry 3):
(by gchaps)
edwingo gave me these fixes for the tutorial, which I am in the process of
updating and testing:

1) Add a constant in the java code:

   private static final String IMAGE_FILE_PATH = "/resources/image-file";

2) Modify prerender to something like:

   public void prerender() {
       String uploadedFileName = (String) this.fileNameStaticText.getValue();
       if ( uploadedFileName != null ) {
           image1.setUrl(IMAGE_FILE_PATH);
       }
   }

3) Modify the button action method to something like:

               String realPath =
                       theApplicationsServletContext.getRealPath
                       (IMAGE_FILE_PATH);
               File file = new File(realPath);
               uploadedFile.write(file);

4) You no longer need to create the "images" subdirectory of the "resources"
directory so this step of the tutorial can be removed.

5) You may need to edit other parts that refer to the "resources/images"
directory in the code and tutorial.

Evaluation (Entry 4):
(by edwingo)
This is really a bug in the JSF RI so I created the following bug
https://javaserverfaces.dev.java.net/issues/show_bug.cgi?id=463. The problem is
that the tutorial app can use an Image component with a "URL" property value
that contains non-ISO-8859-1 characters. This happens when the orignal filename
of an uploaded file contains UCS characters. The "src" attribute of the "img"
tag is not rendered correctly so when the browser fetches it, it gets a file not
found error and so nothing appears in the browser window. The workaround is to
have the app limit the URL property to ISO-8859-1 characters. For example, there
can be a separate translation step from ISO 10646 UCS chars to ISO-8859-1 chars
or maybe the app can avoid using UCS chars altogether which is what I recommend
for the tutorial app.

This is *independent* of the File Upload component. For example, you can create
an image file with a name containing non-ISO-8859-1 characters and set the "url"
property of an Image component and get the same behavior. No File Upload is
required.