A falsely removed import added back
[pithos] / src / gr / ebs / gss / client / FileUploadGearsDialog.java
1 /*
2  * Copyright 2009 Electronic Business Systems Ltd.
3  *
4  * This file is part of GSS.
5  *
6  * GSS is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GSS is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with GSS.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 package gr.ebs.gss.client;
20
21 import gr.ebs.gss.client.rest.PostCommand;
22 import gr.ebs.gss.client.rest.RestCommand;
23 import gr.ebs.gss.client.rest.RestException;
24 import gr.ebs.gss.client.rest.resource.FileResource;
25 import gr.ebs.gss.client.rest.resource.FolderResource;
26
27 import java.util.ArrayList;
28 import java.util.Arrays;
29 import java.util.HashMap;
30 import java.util.List;
31 import java.util.Map;
32
33 import com.google.gwt.core.client.GWT;
34 import com.google.gwt.event.dom.client.ClickEvent;
35 import com.google.gwt.event.dom.client.ClickHandler;
36 import com.google.gwt.gears.client.Factory;
37 import com.google.gwt.gears.client.desktop.Desktop;
38 import com.google.gwt.gears.client.desktop.File;
39 import com.google.gwt.gears.client.desktop.OpenFilesHandler;
40 import com.google.gwt.gears.client.httprequest.HttpRequest;
41 import com.google.gwt.gears.client.httprequest.ProgressEvent;
42 import com.google.gwt.gears.client.httprequest.ProgressHandler;
43 import com.google.gwt.gears.client.httprequest.RequestCallback;
44 import com.google.gwt.http.client.URL;
45 import com.google.gwt.json.client.JSONObject;
46 import com.google.gwt.json.client.JSONString;
47 import com.google.gwt.user.client.DeferredCommand;
48 import com.google.gwt.user.client.ui.Button;
49 import com.google.gwt.user.client.ui.FlexTable;
50 import com.google.gwt.user.client.ui.HTML;
51 import com.google.gwt.user.client.ui.HasHorizontalAlignment;
52 import com.google.gwt.user.client.ui.HorizontalPanel;
53 import com.google.gwt.user.client.ui.VerticalPanel;
54
55 /**
56  * The 'File upload' dialog box implementation with Google Gears support.
57  */
58 public class FileUploadGearsDialog extends FileUploadDialog implements Updateable {
59
60         protected final Factory factory = Factory.getInstance();
61
62         /**
63          * The array of files to upload.
64          */
65         private File[] fileObjects;
66
67         /**
68          * A list of files to upload, created from files array. Used to signal
69          * finished state when empty.
70          */
71         protected List<File> selectedFiles = new ArrayList<File>();
72
73         /**
74          * The list of progress bars for individual files.
75          */
76         protected List<ProgressBar> progressBars = new ArrayList<ProgressBar>();
77
78         private Button browse;
79
80         private Button submit;
81
82         private FlexTable generalTable;
83
84         private Map<String, FileResource> toRename;
85
86         protected List<HttpRequest> requests = new ArrayList<HttpRequest>();
87         
88         private boolean canContinue = true;
89
90         /**
91          * The widget's constructor.
92          */
93         public FileUploadGearsDialog() {
94                 // Set the dialog's caption.
95                 setText("File upload");
96                 setAnimationEnabled(true);
97                 // Create a panel to hold all of the dialog widgets.
98                 VerticalPanel panel = new VerticalPanel();
99                 final HTML info = new HTML("You may select one or more files to upload.");
100                 info.addStyleName("gss-uploadNote");
101                 panel.add(info);
102                 // Add an informative label with the folder name.
103                 Object selection = GSS.get().getFolders().getCurrent().getUserObject();
104                 folder = (FolderResource) selection;
105
106                 browse = new Button("Browse...");
107
108                 HorizontalPanel fileUploadPanel = new HorizontalPanel();
109                 fileUploadPanel.add(browse);
110
111                 generalTable = new FlexTable();
112                 generalTable.setText(0, 0, "Folder");
113                 generalTable.setText(1, 0, "File");
114                 generalTable.setText(0, 1, folder.getName());
115                 generalTable.setWidget(1, 1, fileUploadPanel);
116                 generalTable.getCellFormatter().setStyleName(0, 0, "props-labels");
117                 generalTable.getCellFormatter().setStyleName(1, 0, "props-labels");
118                 generalTable.getCellFormatter().setStyleName(0, 1, "props-values");
119                 generalTable.getCellFormatter().setStyleName(1, 1, "props-values");
120                 generalTable.setCellSpacing(4);
121
122                 panel.add(generalTable);
123
124                 // Create a panel to hold the buttons.
125                 HorizontalPanel buttons = new HorizontalPanel();
126
127                 submit = new Button("Upload");
128                 submit.addClickHandler(new ClickHandler() {
129                         @Override
130                         public void onClick(ClickEvent event) {
131                                 prepareAndSubmit();
132                         }
133                 });
134                 submit.setEnabled(false);
135                 buttons.add(submit);
136                 buttons.setCellHorizontalAlignment(submit, HasHorizontalAlignment.ALIGN_CENTER);
137                 // Create the 'Cancel' button, along with a listener that hides the
138                 // dialog when the button is clicked.
139                 Button cancel = new Button("Cancel", new ClickHandler() {
140                         @Override
141                         public void onClick(ClickEvent event) {
142                                 canContinue = false;                            
143                                 cancelUpload();                         
144                                 GSS.get().showFileList(true);
145                         }
146                 });
147                 buttons.add(cancel);
148                 buttons.setCellHorizontalAlignment(cancel, HasHorizontalAlignment.ALIGN_CENTER);
149                 buttons.setSpacing(8);
150                 buttons.addStyleName("gss-DialogBox");
151
152                 browse.addClickHandler(new ClickHandler() {
153                         @Override
154                         public void onClick(ClickEvent event) {
155                                 Desktop desktop = factory.createDesktop();
156                                 desktop.openFiles(new OpenFilesHandler() {
157
158                                         @Override
159                                         public void onOpenFiles(OpenFilesEvent ofevent) {
160                                                 fileObjects = ofevent.getFiles();
161                                                 selectedFiles.addAll(Arrays.asList(fileObjects));
162                                                 for (int i = 0; i< selectedFiles.size(); i++) {
163                                                         generalTable.setText(i+1, 0, "File");
164                                                         generalTable.setText(i+1, 1, selectedFiles.get(i).getName());
165                                                         ProgressBar progress = new ProgressBar(20, 0);
166                                                         generalTable.setWidget(i+1, 2, progress);
167                                                         progressBars.add(progress);
168                                                         generalTable.getCellFormatter().setStyleName(i+1, 0, "props-labels");
169                                                         generalTable.getCellFormatter().setStyleName(i+1, 1, "props-values");
170                                                 }
171                                                 submit.setEnabled(true);
172                                         }
173                                 });
174                         }
175                 });
176
177                 panel.add(buttons);
178                 panel.setCellHorizontalAlignment(buttons, HasHorizontalAlignment.ALIGN_CENTER);
179                 panel.addStyleName("gss-DialogBox");
180                 addStyleName("gss-DialogBox");
181                 setWidget(panel);
182         }
183
184         /**
185          * Cancels the file upload.
186          */
187         private void cancelUpload() {
188                 for (HttpRequest request: requests)
189                         request.abort();
190                 hide();         
191         }
192
193         /**
194          * Check whether the specified file name exists in the selected folder.
195          */
196         private boolean canContinue(File file) {
197                 String fileName = getFilename(file.getName());
198                 if (getFileForName(fileName) == null)
199                         // For file creation, check to see if the file already exists.
200                         for (FileResource fileRes : files)
201                                 if (!fileRes.isDeleted() && fileRes.getName().equals(fileName))
202                                         return false;
203                 return true;
204         }
205
206         @Override
207         public void prepareAndSubmit() {
208                 GSS app = GSS.get();
209                 if (selectedFiles.size() == 0) {
210                         app.displayError("You must select a file!");
211                         hide();
212                         return;
213                 }
214                 for (File file: selectedFiles)
215                         if (!canContinue(file)) {
216                                 app.displayError("The file name " + file.getName() +
217                                                         " already exists in this folder");
218                                 hide();
219                                 return;
220                         }
221                 submit.setEnabled(false);
222                 browse.setVisible(false);
223                 List<String> toUpdate = new ArrayList<String>();
224                 toRename = new HashMap<String, FileResource>();
225                 for (File file: selectedFiles) {
226                         String fname = getFilename(file.getName());
227                         if (getFileForName(fname) == null) {
228                                 // We are going to create a file, so we check to see if there is a
229                                 // trashed file with the same name.
230                                 FileResource same = null;
231                                 for (FileResource fres : folder.getFiles())
232                                         if (fres.isDeleted() && fres.getName().equals(fname))
233                                                 same = fres;
234                                 // In that case add it to the list of files to rename.
235                                 if (same != null)
236                                         toRename.put(getBackupFilename(fname), same);
237                         } else
238                                 // If we are updating a file add it to the list of files to update.
239                                 toUpdate.add(fname);
240                 }
241
242                 if (!toUpdate.isEmpty()) {
243                         StringBuffer sb = new StringBuffer();
244                         for (String name: toUpdate)
245                                 sb.append(name).append("<br/>");
246                         // We are going to update existing files, so show a confirmation dialog.
247                         ConfirmationDialog confirm = new ConfirmationDialog("Are you sure " +
248                                         "you want to update the following files?<br/><i>" + sb +
249                                         "</i>", "Update") {
250
251                                 @Override
252                                 public void cancel() {
253                                         hide();
254                                 }
255
256                                 @Override
257                                 public void confirm() {
258                                         confirmRename();
259                                 }
260
261                         };
262                         confirm.center();
263                 } else
264                         confirmRename();
265         }
266
267         /**
268          * Confirm the renames of synonymous files already in the trash.
269          */
270         private void confirmRename() {
271                 if (!toRename.isEmpty()) {
272                         StringBuffer sb = new StringBuffer();
273                         for (FileResource file: toRename.values())
274                                 sb.append(file.getName()).append("<br/>");
275                         ConfirmationDialog confirm = new ConfirmationDialog("Files " +
276                                         "with the following names already exist in the trash. If" +
277                                         " you continue,<br/>the trashed files will be renamed " +
278                                         "automatically for you:<br/><i>" + sb + "</i>", "Continue") {
279
280                                 @Override
281                                 public void cancel() {
282                                         hide();
283                                 }
284
285                                 @Override
286                                 public void confirm() {
287                                         updateTrashedFiles();
288                                 }
289
290                         };
291                         confirm.center();
292                 } else
293                         uploadFiles();
294         }
295
296         /**
297          * Rename the conflicting trashed files with the supplied new names.
298          */
299         private void updateTrashedFiles() {
300                 for (final String name: toRename.keySet()) {
301                         JSONObject json = new JSONObject();
302                         json.put("name", new JSONString(name));
303                         PostCommand cf = new PostCommand(toRename.get(name).getUri() + "?update=", json.toString(), 200) {
304
305                                 @Override
306                                 public void onComplete() {
307                                         toRename.remove(name);
308                                         uploadFiles();
309                                 }
310
311                                 @Override
312                                 public void onError(Throwable t) {
313                                         GSS app = GSS.get();
314                                         GWT.log("", t);
315                                         if (t instanceof RestException) {
316                                                 int statusCode = ((RestException) t).getHttpStatusCode();
317                                                 if (statusCode == 405)
318                                                         app.displayError("You don't have the necessary permissions");
319                                                 else if (statusCode == 404)
320                                                         app.displayError("User in permissions does not exist");
321                                                 else if (statusCode == 409)
322                                                         app.displayError("A file with the same name already exists");
323                                                 else if (statusCode == 413)
324                                                         app.displayError("Your quota has been exceeded");
325                                                 else
326                                                         app.displayError("Unable to modify file:" + ((RestException) t).getHttpStatusText());
327                                         } else
328                                                 app.displayError("System error modifying file:" + t.getMessage());
329                                 }
330
331                         };
332                         DeferredCommand.addCommand(cf);
333                 }
334         }
335
336         /**
337          * Checks if the renaming step for already trashed files is complete and
338          * starts file uploads.
339          */
340         private void uploadFiles() {            
341                 if (!toRename.isEmpty()) return;
342                 if (canContinue){                                               
343                         doSend(selectedFiles);
344                 }
345         }
346
347         /**
348          * Perform the HTTP request to upload the specified file.
349          */
350         protected void doSend(final List<File> filesRemaining) {
351                 final GSS app = GSS.get();
352                 HttpRequest request = factory.createHttpRequest();
353                 requests.add(request);
354                 String method = "PUT";
355
356                 String path;
357                 final String filename = getFilename(filesRemaining.get(0).getName());
358                 path = folder.getUri();
359                 if (!path.endsWith("/"))
360                         path = path + "/";
361                 path = path + encode(filename);
362
363                 String token = app.getToken();
364                 String resource = path.substring(app.getApiPath().length()-1, path.length());
365                 String date = RestCommand.getDate();
366                 String sig = RestCommand.calculateSig(method, date, resource, RestCommand.base64decode(token));
367                 request.open(method, path);
368                 request.setRequestHeader("X-GSS-Date", date);
369                 request.setRequestHeader("Authorization", app.getCurrentUserResource().getUsername() + " " + sig);
370                 request.setRequestHeader("Accept", "application/json; charset=utf-8");
371                 request.setCallback(new RequestCallback() {
372                         @Override
373                         public void onResponseReceived(HttpRequest req) {
374                                 int state = req.getReadyState();
375                                 if (state != 4) return;
376                                 switch(req.getStatus()) {
377                                         case 201: // Created falls through to updated.
378                                         case 204:
379                                                 filesRemaining.remove(0);
380                                                 if(filesRemaining.isEmpty()){                                                   
381                                                         finish();
382                                                         break;
383                                                 }                                               
384                                                 doSend(filesRemaining);                         
385                                                 break;
386                                         case 403:
387                                                 SessionExpiredDialog dlg = new SessionExpiredDialog();
388                                                 dlg.center();
389                                                 break;
390                                         case 405:
391                                                 app.displayError("You don't have permission to " +
392                                                                 "upload file " + filename);
393                                                 break;
394                                         case 409:
395                                                 app.displayError("A folder with the name " + filename +
396                                                                 " already exists at this level");
397                                                 break;
398                                         case 413:
399                                                 app.displayError("There is not enough free space " +
400                                                                 "available for uploading " + filename);
401                                                 break;
402                                         default:
403                                                 app.displayError("Error uploading file " + filename +
404                                                                         ": " + req.getStatus());
405                                 }
406                         }
407                 });
408                 request.getUpload().setProgressHandler(new ProgressHandler() {
409                         @Override
410                         public void onProgress(ProgressEvent event) {
411                                 double pcnt = (double) event.getLoaded() / event.getTotal();
412                                 progressBars.get(0).setProgress((int) Math.floor(pcnt * 100));
413                                 if(pcnt*100 == 100)
414                                         progressBars.remove(0);
415                         }
416                 });
417                 request.send(filesRemaining.get(0).getBlob());
418         }
419
420         /**
421          * Perform the final actions after the files are uploaded.
422          */
423         protected void finish() {
424                 hide();
425                 GSS.get().showFileList(true);
426                 GSS.get().getStatusPanel().updateStats();
427         }
428
429         /**
430          * Same as URL.encode, but also encode apostrophe since browsers aren't
431          * consistent about it (FF encodes, IE does not).
432          */
433         protected String encode(String decodedURL) {
434                 String retv = decodedURL.replaceAll("@", "_"); // Replace bad character
435                 retv = URL.encodeComponent(retv);
436                 retv = retv.replaceAll("'", "%27");
437                 return retv;
438         }
439
440 }