Updated licence in code files. Removed some unused methods
[pithos-web-client] / src / gr / grnet / pithos / web / client / FolderPropertiesDialog.java
1 /*\r
2  * Copyright 2011 GRNET S.A. All rights reserved.\r
3  *\r
4  * Redistribution and use in source and binary forms, with or\r
5  * without modification, are permitted provided that the following\r
6  * conditions are met:\r
7  *\r
8  *   1. Redistributions of source code must retain the above\r
9  *      copyright notice, this list of conditions and the following\r
10  *      disclaimer.\r
11  *\r
12  *   2. Redistributions in binary form must reproduce the above\r
13  *      copyright notice, this list of conditions and the following\r
14  *      disclaimer in the documentation and/or other materials\r
15  *      provided with the distribution.\r
16  *\r
17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS\r
18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR\r
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF\r
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED\r
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
28  * POSSIBILITY OF SUCH DAMAGE.\r
29  *\r
30  * The views and conclusions contained in the software and\r
31  * documentation are those of the authors and should not be\r
32  * interpreted as representing official policies, either expressed\r
33  * or implied, of GRNET S.A.\r
34  */\r
35 package gr.grnet.pithos.web.client;\r
36 \r
37 import gr.grnet.pithos.web.client.FilePropertiesDialog.Images;\r
38 import gr.grnet.pithos.web.client.rest.PostCommand;\r
39 import gr.grnet.pithos.web.client.rest.RestException;\r
40 import gr.grnet.pithos.web.client.rest.resource.FolderResource;\r
41 import gr.grnet.pithos.web.client.rest.resource.GroupResource;\r
42 import gr.grnet.pithos.web.client.rest.resource.PermissionHolder;\r
43 import gr.grnet.pithos.web.client.rest.resource.RestResourceWrapper;\r
44 \r
45 import java.util.List;\r
46 import java.util.Set;\r
47 \r
48 import com.google.gwt.core.client.GWT;\r
49 import com.google.gwt.dom.client.NativeEvent;\r
50 import com.google.gwt.event.dom.client.ChangeEvent;\r
51 import com.google.gwt.event.dom.client.ChangeHandler;\r
52 import com.google.gwt.event.dom.client.ClickEvent;\r
53 import com.google.gwt.event.dom.client.ClickHandler;\r
54 import com.google.gwt.event.dom.client.KeyCodes;\r
55 import com.google.gwt.http.client.URL;\r
56 import com.google.gwt.i18n.client.DateTimeFormat;\r
57 import com.google.gwt.json.client.JSONArray;\r
58 import com.google.gwt.json.client.JSONBoolean;\r
59 import com.google.gwt.json.client.JSONObject;\r
60 import com.google.gwt.json.client.JSONString;\r
61 import com.google.gwt.user.client.DeferredCommand;\r
62 import com.google.gwt.user.client.Event.NativePreviewEvent;\r
63 import com.google.gwt.user.client.ui.Button;\r
64 import com.google.gwt.user.client.ui.CheckBox;\r
65 import com.google.gwt.user.client.ui.DecoratedTabPanel;\r
66 import com.google.gwt.user.client.ui.DialogBox;\r
67 import com.google.gwt.user.client.ui.FlexTable;\r
68 import com.google.gwt.user.client.ui.HasHorizontalAlignment;\r
69 import com.google.gwt.user.client.ui.HorizontalPanel;\r
70 import com.google.gwt.user.client.ui.Label;\r
71 import com.google.gwt.user.client.ui.TabPanel;\r
72 import com.google.gwt.user.client.ui.TextBox;\r
73 import com.google.gwt.user.client.ui.VerticalPanel;\r
74 \r
75 /**\r
76  * The 'Folder properties' dialog box implementation.\r
77  */\r
78 public class FolderPropertiesDialog extends DialogBox {\r
79 \r
80         private List<GroupResource> groups = null;\r
81 \r
82         final PermissionsList permList;\r
83 \r
84         private CheckBox readForAll;\r
85 \r
86         /**\r
87          * The widget that holds the folderName of the folder.\r
88          */\r
89         private TextBox folderName = new TextBox();\r
90 \r
91         /**\r
92          * A flag that denotes whether the dialog will be used to create or modify a\r
93          * folder.\r
94          */\r
95         private final boolean create;\r
96 \r
97         final FolderResource folder;\r
98 \r
99         final TabPanel inner;\r
100 \r
101         /**\r
102          * The widget's constructor.\r
103          *\r
104          * @param images the image icons from the file properties dialog\r
105          * @param _create true if the dialog is displayed for creating a new\r
106          *            sub-folder of the selected folder, false if it is displayed\r
107          *            for modifying the selected folder\r
108          */\r
109         public FolderPropertiesDialog(Images images, boolean _create,  final List<GroupResource> _groups) {\r
110                 setAnimationEnabled(true);\r
111 \r
112                 // Enable IE selection for the dialog (must disable it upon closing it)\r
113                 GSS.enableIESelection();\r
114 \r
115                 create = _create;\r
116                 \r
117                 folder = ((RestResourceWrapper) GSS.get().getTreeView().getSelection()).getResource();\r
118                 permList = new PermissionsList(images, folder.getPermissions(), folder.getOwner());\r
119                 groups = _groups;\r
120 \r
121                 // Use this opportunity to set the dialog's caption.\r
122                 if (create)\r
123                         setText("Create folder");\r
124                 else\r
125                         setText("Folder properties");\r
126 \r
127                 // Outer contains inner and buttons\r
128                 VerticalPanel outer = new VerticalPanel();\r
129                 // Inner contains generalPanel and permPanel\r
130                 inner = new DecoratedTabPanel();\r
131                 inner.setAnimationEnabled(true);\r
132                 VerticalPanel generalPanel = new VerticalPanel();\r
133                 VerticalPanel permPanel = new VerticalPanel();\r
134                 final HorizontalPanel permForAll = new HorizontalPanel();\r
135                 final HorizontalPanel pathPanel = new HorizontalPanel();\r
136                 HorizontalPanel buttons = new HorizontalPanel();\r
137                 HorizontalPanel permButtons = new HorizontalPanel();\r
138 \r
139                 inner.add(generalPanel, "General");\r
140                 if (!create)\r
141                         inner.add(permPanel, "Sharing");\r
142                 inner.selectTab(0);\r
143 \r
144                 final Label folderNameNote = new Label("Please note that slashes ('/') are not allowed in folder names.", true);\r
145                 folderNameNote.setVisible(false);\r
146                 folderNameNote.setStylePrimaryName("pithos-readForAllNote");\r
147 \r
148                 FlexTable generalTable = new FlexTable();\r
149                 generalTable.setText(0, 0, "Name");\r
150                 generalTable.setText(1, 0, "Parent");\r
151                 generalTable.setText(2, 0, "Creator");\r
152                 generalTable.setText(3, 0, "Last modified");\r
153                 folderName.setText(create ? "" : folder.getName());\r
154                 folderName.getElement().setId("folderPropertiesDialog.textBox.name");\r
155                 generalTable.setWidget(0, 1, folderName);\r
156                 folderName.addChangeHandler(new ChangeHandler() {\r
157                         \r
158                         @Override\r
159                         public void onChange(ChangeEvent event) {\r
160                                 if(folderName.getText().contains("/"))\r
161                                         folderNameNote.setVisible(true);\r
162                                 else\r
163                                         folderNameNote.setVisible(false);                               \r
164                                 \r
165                         }\r
166                 });\r
167 \r
168 \r
169                 if (create)\r
170                         generalTable.setText(1, 1, folder.getName());\r
171                 else if(folder.getParentName() == null)\r
172                         generalTable.setText(1, 1, "-");\r
173                 else\r
174                         generalTable.setText(1, 1, folder.getParentName());\r
175                 generalTable.setWidget(0, 2, folderNameNote);\r
176                 generalTable.setText(2, 1, folder.getOwner());\r
177                 DateTimeFormat formatter = DateTimeFormat.getFormat("d/M/yyyy h:mm a");\r
178                 if(folder.getModificationDate() != null)\r
179                         generalTable.setText(3, 1, formatter.format(folder.getModificationDate()));\r
180                 generalTable.getFlexCellFormatter().setStyleName(0, 0, "props-labels");\r
181                 generalTable.getFlexCellFormatter().setStyleName(1, 0, "props-labels");\r
182                 generalTable.getFlexCellFormatter().setStyleName(2, 0, "props-labels");\r
183                 generalTable.getFlexCellFormatter().setStyleName(3, 0, "props-labels");\r
184                 generalTable.getFlexCellFormatter().setStyleName(0, 1, "props-values");\r
185                 generalTable.getFlexCellFormatter().setStyleName(1, 1, "props-values");\r
186                 generalTable.getFlexCellFormatter().setStyleName(2, 1, "props-values");\r
187                 generalTable.getFlexCellFormatter().setStyleName(3, 1, "props-values");\r
188                 generalTable.setCellSpacing(4);\r
189 \r
190                 // Create the 'Create/Update' button, along with a listener that hides the dialog\r
191                 // when the button is clicked and quits the application.\r
192                 String okLabel;\r
193                 if (create)\r
194                         okLabel = "Create";\r
195                 else\r
196                         okLabel = "Update";\r
197                 Button ok = new Button(okLabel, new ClickHandler() {\r
198                         @Override\r
199                         public void onClick(ClickEvent event) {                         \r
200                                 if(folderName.getText().contains("/"))\r
201                                         folderNameNote.setVisible(true);\r
202                                 else {\r
203                                         folderNameNote.setVisible(false);\r
204                                         createOrUpdateFolder();\r
205                                         closeDialog();\r
206                                 }\r
207 \r
208                         }\r
209                 });\r
210                 ok.getElement().setId("folderPropertiesDialog.button.ok");\r
211                 buttons.add(ok);\r
212                 buttons.setCellHorizontalAlignment(ok, HasHorizontalAlignment.ALIGN_CENTER);\r
213                 // Create the 'Cancel' button, along with a listener that hides the\r
214                 // dialog\r
215                 // when the button is clicked.\r
216                 Button cancel = new Button("Cancel", new ClickHandler() {\r
217                         @Override\r
218                         public void onClick(ClickEvent event) {\r
219                                 closeDialog();\r
220                         }\r
221                 });\r
222                 cancel.getElement().setId("folderPropertiesDialog.button.cancel");\r
223                 buttons.add(cancel);\r
224                 buttons.setCellHorizontalAlignment(cancel, HasHorizontalAlignment.ALIGN_CENTER);\r
225                 buttons.setSpacing(8);\r
226                 buttons.addStyleName("pithos-TabPanelBottom");\r
227 \r
228                 Button add = new Button("Add Group", new ClickHandler() {\r
229                         @Override\r
230                         public void onClick(ClickEvent event) {\r
231                                 PermissionsAddDialog dlg = new PermissionsAddDialog(groups, permList, false);\r
232                                 dlg.center();\r
233                         }\r
234                 });\r
235                 add.getElement().setId("folderPropertiesDialog.button.addGroup");\r
236                 permButtons.add(add);\r
237                 permButtons.setCellHorizontalAlignment(add, HasHorizontalAlignment.ALIGN_CENTER);\r
238 \r
239                 Button addUser = new Button("Add User", new ClickHandler() {\r
240                         @Override\r
241                         public void onClick(ClickEvent event) {\r
242                                 PermissionsAddDialog dlg = new PermissionsAddDialog(groups, permList, true);\r
243                                 dlg.center();\r
244                         }\r
245                 });\r
246                 addUser.getElement().setId("folderPropertiesDialog.button.addUser");\r
247                 permButtons.add(addUser);\r
248                 permButtons.setCellHorizontalAlignment(addUser, HasHorizontalAlignment.ALIGN_CENTER);\r
249 \r
250                 permButtons.setCellHorizontalAlignment(cancel, HasHorizontalAlignment.ALIGN_CENTER);\r
251                 permButtons.setSpacing(8);\r
252                 permButtons.addStyleName("pithos-TabPanelBottom");\r
253 \r
254                 final Label readForAllNote = new Label("When this option is enabled, the folder will be readable" +\r
255                                         " by everyone. By checking this option, you are certifying that you have the right to " +\r
256                                         "distribute this folder's contents and that it does not violate the Terms of Use.", true);\r
257                 readForAllNote.setVisible(false);\r
258                 readForAllNote.setStylePrimaryName("pithos-readForAllNote");\r
259 \r
260                 readForAll = new CheckBox();\r
261                 readForAll.getElement().setId("folderPropertiesDialog.checkBox.public");\r
262                 readForAll.setValue(folder.isReadForAll());\r
263                 readForAll.addClickHandler(new ClickHandler() {\r
264                         @Override\r
265                         public void onClick(ClickEvent event) {\r
266                                 readForAllNote.setVisible(readForAll.getValue());\r
267                         }\r
268 \r
269                 });\r
270 \r
271                 generalPanel.add(generalTable);\r
272                 permPanel.add(permList);\r
273                 permPanel.add(permButtons);\r
274 \r
275                 // Only show the read for all permission if the user is the owner.\r
276                 if (folder.getOwner().equals(GSS.get().getCurrentUserResource().getUsername())) {\r
277                         permForAll.add(new Label("Public"));\r
278                         permForAll.add(readForAll);\r
279                         permForAll.setSpacing(8);\r
280                         permForAll.addStyleName("pithos-TabPanelBottom");\r
281                         permForAll.add(readForAllNote);\r
282                         permPanel.add(permForAll);\r
283                 }\r
284                 TextBox path = new TextBox();\r
285                 path.getElement().setId("folderPropertiesDialog.textBox.link");\r
286                 path.setWidth("100%");\r
287                 path.addClickHandler(new ClickHandler() {\r
288                         @Override\r
289                         public void onClick(ClickEvent event) {\r
290                                 GSS.enableIESelection();\r
291                                 ((TextBox) event.getSource()).selectAll();\r
292                                 GSS.preventIESelection();\r
293                         }\r
294 \r
295                 });\r
296                 path.setText(folder.getUri());\r
297                 path.setTitle("Use this link for sharing the folder via e-mail, IM, etc. (crtl-C/cmd-C to copy to system clipboard)");\r
298                 path.setWidth("100%");\r
299                 path.setReadOnly(true);\r
300                 pathPanel.setWidth("100%");\r
301                 pathPanel.setHorizontalAlignment(HasHorizontalAlignment.ALIGN_LEFT);\r
302                 pathPanel.add(new Label("Link"));\r
303                 pathPanel.setSpacing(8);\r
304                 pathPanel.addStyleName("pithos-TabPanelBottom");\r
305                 pathPanel.add(path);\r
306                 permPanel.add(pathPanel);\r
307 \r
308                 outer.add(inner);\r
309                 outer.add(buttons);\r
310                 outer.setCellHorizontalAlignment(buttons, HasHorizontalAlignment.ALIGN_CENTER);\r
311                 outer.addStyleName("pithos-TabPanelBottom");\r
312 \r
313                 setWidget(outer);\r
314 \r
315                 /*if (create)\r
316                         folderName.setFocus(true);\r
317                 else\r
318                         ok.setFocus(true);*/\r
319         }\r
320 \r
321         @Override\r
322         public void center() {\r
323                 super.center();\r
324                 folderName.setFocus(true);\r
325         }\r
326 \r
327         @Override\r
328         protected void onPreviewNativeEvent(NativePreviewEvent preview) {\r
329                 super.onPreviewNativeEvent(preview);\r
330 \r
331                 NativeEvent evt = preview.getNativeEvent();\r
332                 if (evt.getType().equals("keydown"))\r
333                         // Use the popup's key preview hooks to close the dialog when either\r
334                         // enter or escape is pressed.\r
335                         switch (evt.getKeyCode()) {\r
336                                 case KeyCodes.KEY_ENTER:\r
337                                         closeDialog();\r
338                                         createOrUpdateFolder();\r
339                                         break;\r
340                                 case KeyCodes.KEY_ESCAPE:\r
341                                         closeDialog();\r
342                                         break;\r
343                         }\r
344         }\r
345 \r
346 \r
347         /**\r
348          * Enables IE selection prevention and hides the dialog\r
349          * (we disable the prevention on creation of the dialog)\r
350          */\r
351         public void closeDialog() {\r
352                 GSS.preventIESelection();\r
353                 hide();\r
354         }\r
355 \r
356         /**\r
357          * Generate an RPC request to create a new folder.\r
358          *\r
359          * @param userId the ID of the user whose namespace will be searched for\r
360          *            folders\r
361          * @param _folderName the name of the folder to create\r
362          */\r
363         private void createFolder() {\r
364                 String name = folderName.getText();\r
365                 if (!GSS.isValidResourceName(name)) {\r
366                         GSS.get().displayError("The folder name '" + name + "' is invalid");\r
367                         return;\r
368                 }\r
369                 PostCommand ep = new PostCommand(folder.getUri() + "?new=" +\r
370                                 URL.encodeComponent(name), "", 201) {\r
371 \r
372                         @Override\r
373                         public void onComplete() {\r
374                                 //TODO:CELLTREE\r
375                                 if(folder.getUri().equals(GSS.get().getTreeView().getMyFolders().getUri())){\r
376                                         GSS.get().getTreeView().updateRootNode();\r
377                                 }\r
378                                 else\r
379                                         GSS.get().getTreeView().updateNodeChildren((RestResourceWrapper) GSS.get().getTreeView().getSelection());\r
380                                 //GSS.get().getFolders().updateFolder((DnDTreeItem) GSS.get().getFolders().getCurrent());\r
381                         }\r
382 \r
383                         @Override\r
384                         public void onError(Throwable t) {\r
385                                 GWT.log("", t);\r
386                                 if(t instanceof RestException){\r
387                                         int statusCode = ((RestException)t).getHttpStatusCode();\r
388                                         if(statusCode == 405)\r
389                                                 GSS.get().displayError("You don't have the necessary" +\r
390                                                                 " permissions or a folder with same name " +\r
391                                                                 "already exists");\r
392                                         else if(statusCode == 404)\r
393                                                 GSS.get().displayError("Resource not found");\r
394                                         else\r
395                                                 GSS.get().displayError("Unable to create folder:" +\r
396                                                                 ((RestException)t).getHttpStatusText());\r
397                                 }\r
398                                 else\r
399                                         GSS.get().displayError("System error creating folder:" +\r
400                                                         t.getMessage());\r
401                         }\r
402                 };\r
403                 DeferredCommand.addCommand(ep);\r
404 \r
405         }\r
406 \r
407         /**\r
408          * Upon closing the dialog by clicking OK or pressing ENTER this method does\r
409          * the actual work of modifying folder properties or creating a new Folder\r
410          * depending on the value of the create field\r
411          *\r
412          * @param userId\r
413          */\r
414         private void createOrUpdateFolder() {\r
415                 if (create)\r
416                         createFolder();\r
417                 else\r
418                         updateFolder();\r
419 \r
420         }\r
421 \r
422         private void updateFolder() {\r
423                 permList.updatePermissionsAccordingToInput();\r
424                 Set<PermissionHolder> perms = permList.getPermissions();\r
425                 JSONObject json = new JSONObject();\r
426                 if(!folder.getName().equals(folderName.getText()))\r
427                         json.put("name", new JSONString(folderName.getText()));\r
428                 //only update the read for all perm if the user is the owner\r
429                 if (readForAll.getValue() != folder.isReadForAll())\r
430                         if (folder.getOwner().equals(GSS.get().getCurrentUserResource().getUsername()))\r
431                                 json.put("readForAll", JSONBoolean.getInstance(readForAll.getValue()));\r
432                 if (permList.hasChanges()) {\r
433                         JSONArray perma = new JSONArray();\r
434                         int i=0;\r
435                         for(PermissionHolder p : perms){\r
436                                 JSONObject po = new JSONObject();\r
437                                 if(p.getUser() != null)\r
438                                         po.put("user", new JSONString(p.getUser()));\r
439                                 if(p.getGroup() != null)\r
440                                         po.put("group", new JSONString(p.getGroup()));\r
441                                 po.put("read", JSONBoolean.getInstance(p.isRead()));\r
442                                 po.put("write", JSONBoolean.getInstance(p.isWrite()));\r
443                                 po.put("modifyACL", JSONBoolean.getInstance(p.isModifyACL()));\r
444                                 perma.set(i,po);\r
445                                 i++;\r
446                         }\r
447                         json.put("permissions", perma);\r
448                         GWT.log(json.toString(), null);\r
449                 }\r
450                 PostCommand ep = new PostCommand(folder.getUri()+"?update=", json.toString(), 200){\r
451 \r
452                         @Override\r
453                         public void onComplete() {\r
454                                 //TODO:CELLTREE\r
455                                 \r
456                                 if(getPostBody() != null && !"".equals(getPostBody().trim())){\r
457                                         \r
458                                         \r
459                                         FolderResource fres = ((RestResourceWrapper) GSS.get().getTreeView().getSelection()).getResource();\r
460                                         String initialPath = fres.getUri();\r
461                                         String newPath =  getPostBody().trim();\r
462                                         fres.setUri(newPath);\r
463                                         ((RestResourceWrapper) GSS.get().getTreeView().getSelection()).getResource().setUri(newPath);\r
464                                         ((RestResourceWrapper) GSS.get().getTreeView().getSelection()).setUri(newPath);\r
465                                         GSS.get().getTreeView().updateNodeChildren(fres.getParentURI());\r
466                                         if (permList.hasChanges()) {\r
467                                                 GSS.get().getTreeView().updateMySharedNode();\r
468                                         }\r
469                                         /*\r
470                                         if(folderItem.getParentItem() != null && ((DnDTreeItem)folderItem.getParentItem()).getFolderResource() != null){\r
471                                                 ((DnDTreeItem)folderItem.getParentItem()).getFolderResource().removeSubfolderPath(initialPath);\r
472                                                 ((DnDTreeItem)folderItem.getParentItem()).getFolderResource().getSubfolderPaths().add(newPath);\r
473                                         }*/\r
474                                 }\r
475                                 //GSS.get().getFolders().updateFolder( (DnDTreeItem) GSS.get().getFolders().getCurrent());\r
476                                 \r
477                                 GSS.get().showFileList(true);\r
478                         }\r
479 \r
480                         @Override\r
481                         public void onError(Throwable t) {\r
482                                 GWT.log("", t);\r
483                                 if(t instanceof RestException){\r
484                                         int statusCode = ((RestException)t).getHttpStatusCode();\r
485                                         if(statusCode == 405)\r
486                                                 GSS.get().displayError("You don't have the necessary permissions or" +\r
487                                                                 " a folder with same name already exists");\r
488                                         else if(statusCode == 404)\r
489                                                 GSS.get().displayError("Resource not found, or user specified in sharing does not exist");\r
490                                         else\r
491                                                 GSS.get().displayError("Unable to update folder: "+((RestException)t).getHttpStatusText());\r
492                                 }\r
493                                 else\r
494                                         GSS.get().displayError("System error moifying file: "+t.getMessage());\r
495                                 //TODO:CELLTREE\r
496                                 //GSS.get().getFolders().updateFolder( (DnDTreeItem) GSS.get().getFolders().getCurrent());\r
497                         }\r
498                 };\r
499                 DeferredCommand.addCommand(ep);\r
500         }\r
501 \r
502         public void selectTab(int _tab) {\r
503                 inner.selectTab(_tab);\r
504         }\r
505 \r
506 }\r