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