topic Upload file API? in Alfresco Archive

Upload file API?

shanmmugarajak — Tue, 24 Jan 2006 16:22:51 GMT

Hi,I wanted to write code using ALFRESCO API's to upload a document, which API should I use to upload. ALFRESCO DEVELOPERS: Can you people walk me through the skeleton of how-to go about this?Also the following questions1. The uploaded file will be stored in back end (MySQL) - is my understanding co

Re: Upload file API?

paulhh — Tue, 07 Feb 2006 11:02:48 GMT

You have a choice of a web service API or Java APIs. Take a look in the wiki at the developer documentation and the samples in the source.

Cheers
Paul.

Re: Upload file API?

shanmmugarajak — Fri, 10 Feb 2006 12:38:04 GMT

Hi

Thanks for the reply on Upload File. I went through UploadFileServlet.java in org.alfresco.web.app.servlet

import org.alfresco.web.bean.FileUploadBean;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

I visitied the Java API for Alfresco - http://www.alfresco.org/resource/docs/java/repository-service-api/index.html

But I couldn't spot the FileUpload related API's there (the file upload packages are mentioned above), kindly help me on this.

Thanks
Raja

Re: Upload file API?

ajshaw — Fri, 10 Feb 2006 17:00:54 GMT

take a look at http://jakarta.apache.org/commons/fileupload/

The user guide is very good. I was just looking at this today.

Re: Upload file API?

shanmmugarajak — Wed, 15 Feb 2006 10:39:19 GMT

Hi,

I understood the nuances in getting a file uploaded. I presume Alfreso uses the Apache's Common Fileupload utility. Sorry if the following issues are very rudimentary for you developers.

As JSF is used, I have my doubt about what is equivalent for HTML input type="file"? Any JSP file in Alfresco code has this?

Also I came across the possibility of doing the same upload using MyFaces
(the link is as follows
http://www.onjava.com/pub/a/onjava/2005/07/13/jsfupload.html?page=1
)
Why has Alfresco developers opted for the Commonsupload utility? Also how should I implement my input type="file" in a JSP page, from where I can utilize the FileUploadServlet class and upload a file.

Kindly reply, thanks in advance

Thanks
Raja

Re: Upload file API?

gavinc — Wed, 15 Feb 2006 13:46:13 GMT

Yes, you're quite right, MyFaces does have upload support (they use commons fileupload nehind the scenes too) but we can't currently use it as our app has to support running in a web container and a portal container.

To use the MyFaces approach you need to have a servlet filter configured in your app. In the portal environment servlet filters don't work so you can't upload files

We have had to implement a way to allow uploading in both scenarios. We therefore use the commons fileupload project directly and deal with the differences appropriately.

The page in the app that performs the upload is /projects/web-client/source/web/jsp/wizard/add-content/upload.jsp. In this file you'll notice the use of…

<r:uploadForm>‍

…this is a simple Alfresco JSF component that outputs the relevant <form> tag for the fileupload. This form tag is different for portal and servlet containers hence the reason it's slightly hidden.

So to use the file upload capability in your own app simply use <r:uploadForm> in the way upload.jsp does.

One thing to be aware of though, the upload is done in a separate form, this is because we want to upload the file to the servlet directly and not go through the JSF lifecycle.

Hope this answers your questions.

Re: Upload file API?

sjeek — Thu, 06 Apr 2006 15:00:21 GMT

I use the "UploadForm" but when I choose a file from my system, then, my message "getFileUploadSuccessMsg" will not show.

Is only the "uploadForm" necessary? or are there other components where i could be reffering to?
http://forums.alfresco.com/viewtopic.php?t=1505

greetings

Re: Upload file API?

gavinc — Thu, 06 Apr 2006 20:11:49 GMT

I would expect what you have to work, I think you have covered the full cycle.

Have you tracked down at which point it doesn't find something it should find i.e. is your QuickUpload bean found in the code you have added to browse.jsp?

If not, you could try the org.alfresco.web.app.servlet.FacesHelper object, it has a getManagedBean method that may help.

Re: Upload file API?

sjeek — Fri, 07 Apr 2006 06:01:12 GMT

I'm using now back the AddContentWizardBean and i added all the imports of upload.jsp also to browse.jsp

If i upload a file in upload.jsp, and I go back to browse.jsp, then the message getFileUploadSuccessMsg is been showed.
If i upload a file in browe.jsp, then notthing happend.

also, when I upload a file in "update-file", and then, when i go to browse.jsp, the message is been showed.

browse.jsp


<r:uploadForm>
                                <td style="padding-left:4px" align=right>
                                       <input type="file" name="alfFileInput"/>
                         </td>
                         <td style="padding-left:4px" align=left>
                                        <input style="margin-left:12px;" type="submit" value="<%=Application.getMessage(FacesContext.getCurrentInstance(), "upload")%>" />
                         </td>
                       <%
                                 AddContentWizard wiz = (AddContentWizard)session.getAttribute(AlfrescoFacesPortlet.MANAGED_BEAN_PREFIX + "AddContentWizard");
                                 if (wiz == null)
                                 {
                                    wiz = (AddContentWizard)session.getAttribute("AddContentWizard");
                                 }
                                 if (wiz != null && wiz.getFileName() != null) {
                                 %>
                                 <td>
                                 <%=wiz.getFileUploadSuccessMsg()%>
                                 </td>
                                <% } %>
                      </r:uploadForm>
                      <td>
                         <h:commandButton style="margin-left:12px;" value="#{ourmsg.quick_upload}" action="#{AddContentWizard.quick}" disabled="#{AddContentWizard.fileName == null}" />
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Upload file API?

sam69 — Tue, 27 Jun 2006 13:20:44 GMT

Hi sjeek !

Is your upload form working ? Because I want to do the same. Is it possible to share your code please ?
Thanks in advance !

Cheers,

Samuel

Re: Upload file API?

roman — Thu, 17 Jan 2008 14:52:17 GMT

hey guys,

same scenario…

got a wizard derived from AddContentDialog which should upload a file in the first step.

wizard configuration is working so far (i can navigate through the steps and so on).
the first step (add-content.jsp) should contain the upload form.

this is my code:


<%
boolean fileUploaded = false;

AddMarketingDocumentWizard wiz = (AddMarketingDocumentWizard)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "AddMarketingDocumentWizard");
if (wiz != null && wiz.getFileName() != null){
   fileUploaded = true;
}
%>


<%– load a bundle of properties with I18N strings –%>
<f:loadBundle basename="alfresco.messages.webclient" var="msg"/>
<f:loadBundle basename="alfresco.extension.webclient" var="swipemsg"/>


<script type="text/javascript" src="<%=request.getContextPath()%>/scripts/validation.js"> </script>
<a:errors message="#{msg.error_dialog}" styleClass="errorMessage" />

<%
if (fileUploaded)
{
PanelGenerator.generatePanelStart(out, request.getContextPath(), "yellowInner", "#ffffcc");
out.write("<img alt='' align='absmiddle' src='");
out.write(request.getContextPath());
out.write("/images/icons/info_icon.gif' />  ");
out.write(wiz.getFileUploadSuccessMsg());
PanelGenerator.generatePanelEnd(out, request.getContextPath(), "yellowInner");
out.write("<div style='padding:2px;'></div>");
}
%>

<h:panelGrid columns="1" cellpadding="2" style="padding-top: 4px; padding-bottom: 4px;"
width="100%" rowClasses="wizardSectionHeading">
<h:outputText value=" #{msg.upload_content}" escape="false" />
</h:panelGrid>


<%– File upload formular –%>
<r:uploadForm>
<table>
<tr>
<td><h:outputText id="text1" value="1. #{msg.locate_content}"/></td>
</tr>
<tr>
<td colspan="3">
<input style="margin-left:12px;" type="file" size="75" name="alfFileInput"/>
</td>
</tr>
<tr><td class="paddingRow"></td></tr>
<tr>
<td class="mainSubText" colspan="3">
2. <%=Application.getMessage(FacesContext.getCurrentInstance(), "click_upload")%>
</td>
</tr>
<tr>
<td colspan="3">
<input style="margin-left:12px;" type="submit" value="<%=Application.getMessage(FacesContext.getCurrentInstance(), "upload")%>" />
</td>
</tr>
</table>

</r:uploadForm>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

totally simple, show some fields + the upload form using <r:uploadForm>
(Alfresco specific tag) and a code snippet which should check if the file has been uploaded and then insert a Message (getFileUploadSuccessMsg()).

BUT IT DOESN'T WORK!

i've found the problem but i don't know how to solve it:

the source code of the output is 'correct':


…
<form name='upload-form' acceptCharset='UTF-8' method='post' enctype='multipart/form-data' action='/alfresco/uploadFileServlet'>
<input type='hidden' name='return-page' value='/alfresco/faces/jsp/wizard/container.jsp'>

<table>
<tr>
<td></td>
</tr>
<tr>
<td colspan="3">
<input style="margin-left:12px;" type="file" size="75" name="alfFileInput"/>
</td>
</tr>

<tr><td class="paddingRow"></td></tr>
<tr>
<td class="mainSubText" colspan="3">
2. Click upload
</td>
</tr>
<tr>
<td colspan="3">
<input style="margin-left:12px;" type="submit" value="Upload" />
</td>
</tr>
</table>

</form>
…
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

BUT THE GENERATED CODE OF THE PAGE is:


…
<input name="return-page" value="/alfresco/faces/jsp/wizard/container.jsp" type="hidden">

<table>
<tbody><tr>
<td></td>
</tr>
<tr>
<td colspan="3">
<input style="margin-left: 12px;" size="75" name="alfFileInput" type="file">
</td>
</tr>

<tr><td class="paddingRow"></td></tr>
<tr>
<td class="mainSubText" colspan="3">
2. Click upload
</td>
</tr>
<tr>
<td colspan="3">
<input style="margin-left: 12px;" value="Upload" type="submit">
</td>
</tr>
</tbody></table>
…
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

there are no upload-form tags in the code. this form tag should contain 'alfresco/uploadFileServlet' as action to upload the file
instead it submits the parent form which has '…wizard/container.jsp' as action.

where are the form tags and how can i manage this problem.

please help.

best regards

PS: i've found an error message in the firefox error console:
Warning: Form contains a file input, but is missing method=POST and enctype=multipart/form-data on the form. The file will not be sent.
Source File: http://localhost:9080/alfresco/faces/jsp/wizard/container.jsp
Line: 0

i think it is because the form tags are missing…

Re: Upload file API?

gavinc — Tue, 22 Jan 2008 13:32:12 GMT

For this to work correctly you need to close the JSF form before starting the r:uploadForm tag, then after the upload form, open another JSF form for the remainder of the page. See the original add-content-dialog.jsp page for an example of this.

However, I have a feeling this technique does not work from inside a 'snippet' page used in the dialog/wizard framework. Due to the way the dialog/wizard framework works you can not split forms across the snippet page. It's worth trying though.

If you look at the original add-content-dialog.jsp page you'll notice that it is a 'full' page and not a 'snippet' page.

Hope this helps.

Re: Upload file API?

roman — Tue, 22 Jan 2008 13:43:12 GMT

Thanks for the answer Gavin,

hmm, it will be very complex 🙂 but I'll try it 😎

the problem is just that i'm not starting the parent form.
It's part of the wizard dialog. i'll look for a workaround, maybe.

do you have any suggestions how i can do it better?
with a dialog instead of the wizard?

thanks for your help and thanks to Dave :wink:
roman