2 * Copyright 2007, 2008, 2009, 2010 Electronic Business Systems Ltd.
4 * This file is part of GSS.
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.
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.
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/>.
19 package gr.ebs.gss.client;
21 import gr.ebs.gss.client.clipboard.Clipboard;
22 import gr.ebs.gss.client.commands.GetUserCommand;
23 import gr.ebs.gss.client.dnd.DnDFocusPanel;
24 import gr.ebs.gss.client.dnd.DnDSimpleFocusPanel;
25 import gr.ebs.gss.client.rest.GetCommand;
26 import gr.ebs.gss.client.rest.RestException;
27 import gr.ebs.gss.client.rest.resource.FileResource;
28 import gr.ebs.gss.client.rest.resource.FolderResource;
29 import gr.ebs.gss.client.rest.resource.TrashResource;
30 import gr.ebs.gss.client.rest.resource.UserResource;
32 import java.util.Arrays;
33 import java.util.Date;
34 import java.util.HashMap;
35 import java.util.Iterator;
36 import java.util.List;
38 import com.allen_sauer.gwt.dnd.client.DragContext;
39 import com.allen_sauer.gwt.dnd.client.PickupDragController;
40 import com.allen_sauer.gwt.dnd.client.VetoDragException;
41 import com.google.gwt.core.client.EntryPoint;
42 import com.google.gwt.core.client.GWT;
43 import com.google.gwt.event.logical.shared.ResizeEvent;
44 import com.google.gwt.event.logical.shared.ResizeHandler;
45 import com.google.gwt.event.logical.shared.SelectionEvent;
46 import com.google.gwt.event.logical.shared.SelectionHandler;
47 import com.google.gwt.event.logical.shared.ValueChangeEvent;
48 import com.google.gwt.event.logical.shared.ValueChangeHandler;
49 import com.google.gwt.i18n.client.DateTimeFormat;
50 import com.google.gwt.resources.client.ClientBundle;
51 import com.google.gwt.resources.client.ImageResource;
52 import com.google.gwt.user.client.Command;
53 import com.google.gwt.user.client.Cookies;
54 import com.google.gwt.user.client.DOM;
55 import com.google.gwt.user.client.DeferredCommand;
56 import com.google.gwt.user.client.History;
57 import com.google.gwt.user.client.Window;
58 import com.google.gwt.user.client.ui.AbsolutePanel;
59 import com.google.gwt.user.client.ui.AbstractImagePrototype;
60 import com.google.gwt.user.client.ui.DecoratedTabPanel;
61 import com.google.gwt.user.client.ui.DockPanel;
62 import com.google.gwt.user.client.ui.HTML;
63 import com.google.gwt.user.client.ui.HasHorizontalAlignment;
64 import com.google.gwt.user.client.ui.HasVerticalAlignment;
65 import com.google.gwt.user.client.ui.HorizontalSplitPanel;
66 import com.google.gwt.user.client.ui.Label;
67 import com.google.gwt.user.client.ui.RootPanel;
68 import com.google.gwt.user.client.ui.TabPanel;
69 import com.google.gwt.user.client.ui.TreeItem;
70 import com.google.gwt.user.client.ui.VerticalPanel;
71 import com.google.gwt.user.client.ui.Widget;
74 * Entry point classes define <code>onModuleLoad()</code>.
76 public class GSS implements EntryPoint, ResizeHandler {
79 * A constant that denotes the completion of an IncrementalCommand.
81 public static final boolean DONE = false;
83 public static final int VISIBLE_FILE_COUNT = 100;
86 * Instantiate an application-level image bundle. This object will provide
87 * programmatic access to all the images needed by widgets.
89 private static Images images = (Images) GWT.create(Images.class);
91 private GlassPanel glassPanel = new GlassPanel();
94 * An aggregate image bundle that pulls together all the images for this
95 * application into a single bundle.
97 public interface Images extends ClientBundle, TopPanel.Images, StatusPanel.Images, FileMenu.Images, EditMenu.Images, SettingsMenu.Images, GroupMenu.Images, FilePropertiesDialog.Images, MessagePanel.Images, FileList.Images, SearchResults.Images, Search.Images, Groups.Images, Folders.Images {
99 @Source("gr/ebs/gss/resources/document.png")
100 ImageResource folders();
102 @Source("gr/ebs/gss/resources/edit_group_22.png")
103 ImageResource groups();
105 @Source("gr/ebs/gss/resources/search.png")
106 ImageResource search();
110 * The single GSS instance.
112 private static GSS singleton;
115 * Gets the singleton GSS instance.
117 * @return the GSS object
119 public static GSS get() {
120 if (GSS.singleton == null)
121 GSS.singleton = new GSS();
122 return GSS.singleton;
126 * The Application Clipboard implementation;
128 private Clipboard clipboard = new Clipboard();
130 private UserResource currentUserResource;
133 * The top panel that contains the menu bar.
135 private TopPanel topPanel;
138 * The panel that contains the various system messages.
140 private MessagePanel messagePanel = new MessagePanel(GSS.images);
143 * The bottom panel that contains the status bar.
145 private StatusPanel statusPanel = new StatusPanel(GSS.images);
148 * The top right panel that displays the logged in user details
150 private UserDetailsPanel userDetailsPanel = new UserDetailsPanel();
153 * The file list widget.
155 private FileList fileList;
158 * The group list widget.
160 private Groups groups = new Groups(images);
163 * The search result widget.
165 private SearchResults searchResults;
168 * The tab panel that occupies the right side of the screen.
170 private TabPanel inner = new DecoratedTabPanel();
173 * The split panel that will contain the left and right panels.
175 private HorizontalSplitPanel splitPanel = new HorizontalSplitPanel();
178 * The horizontal panel that will contain the search and status panels.
180 private DockPanel searchStatus = new DockPanel();
185 private Search search;
188 * The widget that displays the tree of folders.
190 private Folders folders = new Folders(images);
193 * The currently selected item in the application, for use by the Edit menu
194 * commands. Potential types are Folder, File, User and Group.
196 private Object currentSelection;
199 * The authentication token of the current user.
201 private String token;
204 * The WebDAV password of the current user
206 private String webDAVPassword;
208 private PickupDragController dragController;
210 public HashMap<String, String> userFullNameMap = new HashMap<String, String>();
213 public void onModuleLoad() {
214 // Initialize the singleton before calling the constructors of the
215 // various widgets that might call GSS.get().
217 RootPanel.get().add(glassPanel, 0, 0);
218 parseUserCredentials();
219 dragController = new PickupDragController(RootPanel.get(), false) {
222 public void previewDragStart() throws VetoDragException {
223 super.previewDragStart();
224 if (context.selectedWidgets.isEmpty())
225 throw new VetoDragException();
227 if(context.draggable != null)
228 if(context.draggable instanceof DnDFocusPanel){
229 DnDFocusPanel toDrop = (DnDFocusPanel) context.draggable;
230 // prevent drag and drop for trashed files and for
231 // unselected tree items
232 if(toDrop.getFiles() != null && folders.isTrashItem(folders.getCurrent()))
233 throw new VetoDragException();
234 else if(toDrop.getItem() != null && !toDrop.getItem().equals(folders.getCurrent()))
235 throw new VetoDragException();
236 else if(toDrop.getItem() != null && !toDrop.getItem().isDraggable())
237 throw new VetoDragException();
239 } else if (context.draggable instanceof DnDSimpleFocusPanel) {
240 DnDSimpleFocusPanel toDrop = (DnDSimpleFocusPanel) context.draggable;
241 // prevent drag and drop for trashed files and for
242 // unselected tree items
243 if(toDrop.getFiles() != null && folders.isTrashItem(folders.getCurrent()))
244 throw new VetoDragException();
249 protected Widget newDragProxy(DragContext aContext) {
250 AbsolutePanel container = new AbsolutePanel();
252 DOM.setStyleAttribute(container.getElement(), "overflow", "visible");
253 if(aContext.draggable!=null && aContext.draggable.getParent()!= null && aContext.draggable.getParent() instanceof FileTable){
254 if(getFileList().getSelectedFiles().size()>1){
255 html=new HTML(getFileList().getSelectedFiles().size()+ " files");
260 proxy = new FileTable(1,8);
261 proxy.addStyleName("gss-List");
262 FileTable draggableTable = (FileTable) context.draggable.getParent();
263 int dragRow = FileTable.getWidgetRow(context.draggable, draggableTable);
264 FileTable.copyRow(draggableTable, proxy, dragRow, 0);
268 for (Iterator iterator = aContext.selectedWidgets.iterator(); iterator.hasNext();) {
269 Widget widget = (Widget) iterator.next();
270 if (widget instanceof DnDFocusPanel) {
271 DnDFocusPanel book = (DnDFocusPanel) widget;
272 html = book.cloneHTML();
273 } else if (widget instanceof DnDSimpleFocusPanel) {
274 DnDSimpleFocusPanel book = (DnDSimpleFocusPanel) widget;
275 html = book.cloneHTML();
278 container.add(new Label("Drag ME"));
286 dragController.setBehaviorDragProxy(true);
287 dragController.setBehaviorMultipleSelection(false);
288 topPanel = new TopPanel(GSS.images);
289 topPanel.setWidth("100%");
291 messagePanel.setWidth("100%");
292 messagePanel.setVisible(false);
294 search = new Search(images);
295 searchStatus.add(search, DockPanel.WEST);
296 searchStatus.add(userDetailsPanel, DockPanel.EAST);
297 searchStatus.setCellHorizontalAlignment(userDetailsPanel, HasHorizontalAlignment.ALIGN_RIGHT);
298 searchStatus.setCellVerticalAlignment(search, HasVerticalAlignment.ALIGN_MIDDLE);
299 searchStatus.setCellVerticalAlignment(userDetailsPanel, HasVerticalAlignment.ALIGN_MIDDLE);
300 searchStatus.setWidth("100%");
302 fileList = new FileList(images);
304 searchResults = new SearchResults(images);
306 // Inner contains the various lists.
307 inner.setAnimationEnabled(true);
308 inner.getTabBar().addStyleName("gss-MainTabBar");
309 inner.getDeckPanel().addStyleName("gss-MainTabPanelBottom");
310 inner.add(fileList, createHeaderHTML(AbstractImagePrototype.create(images.folders()), "Files"), true);
312 inner.add(groups, createHeaderHTML(AbstractImagePrototype.create(images.groups()), "Groups"), true);
313 inner.add(searchResults, createHeaderHTML(AbstractImagePrototype.create(images.search()), "Search Results"), true);
314 inner.setWidth("100%");
317 inner.addSelectionHandler(new SelectionHandler<Integer>() {
320 public void onSelection(SelectionEvent<Integer> event) {
321 int tabIndex = event.getSelectedItem();
322 // TreeItem treeItem = GSS.get().getFolders().getCurrent();
325 // Files tab selected
326 fileList.clearSelectedRows();
327 fileList.updateCurrentlyShowingStats();
330 // Groups tab selected
331 groups.updateCurrentlyShowingStats();
332 updateHistory("Groups");
335 // Search tab selected
336 searchResults.clearSelectedRows();
337 searchResults.updateCurrentlyShowingStats();
338 updateHistory("Search");
343 // If the application starts with no history token, redirect to a new "Files" state
344 String initToken = History.getToken();
345 if(initToken.length() == 0)
346 History.newItem("Files");
347 // Add history listener to handle any history events
348 History.addValueChangeHandler(new ValueChangeHandler<String>() {
350 public void onValueChange(ValueChangeEvent<String> event) {
351 String tokenInput = event.getValue();
352 String historyToken = handleSpecialFolderNames(tokenInput);
354 if(historyToken.equals("Search"))
356 else if(historyToken.equals("Groups"))
358 else if(historyToken.equals("Files")|| historyToken.length()==0)
361 PopupTree popupTree = GSS.get().getFolders().getPopupTree();
362 TreeItem treeObj = GSS.get().getFolders().getPopupTree().getTreeItem(historyToken);
363 SelectionEvent.fire(popupTree, treeObj);
365 } catch (IndexOutOfBoundsException e) {
371 // Add the left and right panels to the split panel.
372 splitPanel.setLeftWidget(folders);
373 splitPanel.setRightWidget(inner);
374 splitPanel.setSplitPosition("25%");
375 splitPanel.setSize("100%", "100%");
376 splitPanel.addStyleName("gss-splitPanel");
378 // Create a dock panel that will contain the menu bar at the top,
379 // the shortcuts to the left, the status bar at the bottom and the
380 // right panel taking the rest.
381 VerticalPanel outer = new VerticalPanel();
383 outer.add(searchStatus);
384 outer.add(messagePanel);
385 outer.add(splitPanel);
386 outer.add(statusPanel);
387 outer.setWidth("100%");
388 outer.setCellHorizontalAlignment(messagePanel, HasHorizontalAlignment.ALIGN_CENTER);
392 // Hook the window resize event, so that we can adjust the UI.
393 Window.addResizeHandler(this);
394 // Clear out the window's built-in margin, because we want to take
395 // advantage of the entire client area.
396 Window.setMargin("0px");
397 // Finally, add the outer panel to the RootPanel, so that it will be
399 RootPanel.get().add(outer);
400 // Call the window resized handler to get the initial sizes setup. Doing
401 // this in a deferred command causes it to occur after all widgets'
402 // sizes have been computed by the browser.
403 DeferredCommand.addCommand(new Command() {
406 public void execute() {
407 onWindowResized(Window.getClientHeight());
413 * Fetches the User object for the specified username.
415 * @param username the username of the user
417 private void fetchUser(final String username) {
418 String path = getApiPath() + username + "/";
419 GetCommand<UserResource> getUserCommand = new GetCommand<UserResource>(UserResource.class, username, path, null) {
422 public void onComplete() {
423 currentUserResource = getResult();
424 final String announcement = currentUserResource.getAnnouncement();
425 if (announcement != null)
426 DeferredCommand.addCommand(new Command() {
429 public void execute() {
430 displayInformation(announcement);
436 public void onError(Throwable t) {
437 GWT.log("Fetching user error", t);
438 if (t instanceof RestException)
439 GSS.get().displayError("No user found:" + ((RestException) t).getHttpStatusText());
441 GSS.get().displayError("System error fetching user data:" + t.getMessage());
445 DeferredCommand.addCommand(getUserCommand);
449 * Parse and store the user credentials to the appropriate fields.
451 private void parseUserCredentials() {
452 Configuration conf = (Configuration) GWT.create(Configuration.class);
453 String cookie = conf.authCookie();
454 String auth = Cookies.getCookie(cookie);
457 // Redundant, but silences warnings about possible auth NPE, below.
460 int sepIndex = auth.indexOf(conf.cookieSeparator());
463 token = auth.substring(sepIndex + 1);
464 final String username = auth.substring(0, sepIndex);
465 if (username == null)
468 refreshWebDAVPassword();
470 DeferredCommand.addCommand(new Command() {
473 public void execute() {
480 * Redirect the user to the login page for authentication.
482 protected void authenticateUser() {
483 Configuration conf = (Configuration) GWT.create(Configuration.class);
484 Window.Location.assign(conf.loginUrl() + "?next=" + GWT.getModuleBaseURL());
488 * Clear the cookie and redirect the user to the logout page.
491 Configuration conf = (Configuration) GWT.create(Configuration.class);
492 String cookie = conf.authCookie();
493 String domain = Window.Location.getHostName();
494 String path = Window.Location.getPath();
495 Cookies.setCookie(cookie, "", null, domain, path, false);
496 Window.Location.assign(conf.logoutUrl());
500 * Creates an HTML fragment that places an image & caption together, for use
503 * @param imageProto an image prototype for an image
504 * @param caption the group caption
505 * @return the header HTML fragment
507 private String createHeaderHTML(AbstractImagePrototype imageProto, String caption) {
508 String captionHTML = "<table class='caption' cellpadding='0' " + "cellspacing='0'>" + "<tr><td class='lcaption'>" + imageProto.getHTML() + "</td><td class='rcaption'><b style='white-space:nowrap'> " + caption + "</b></td></tr></table>";
512 private void onWindowResized(int height) {
513 // Adjust the split panel to take up the available room in the window.
514 int newHeight = height - splitPanel.getAbsoluteTop() - 44;
517 splitPanel.setHeight("" + newHeight);
521 public void onResize(ResizeEvent event) {
522 int height = event.getHeight();
523 onWindowResized(height);
526 public boolean isFileListShowing() {
527 int tab = inner.getTabBar().getSelectedTab();
533 public boolean isSearchResultsShowing() {
534 int tab = inner.getTabBar().getSelectedTab();
541 * Make the user list visible.
543 public void showUserList() {
548 * Make the file list visible.
550 public void showFileList() {
551 fileList.updateFileCache(false, true /*clear selection*/);
556 * Make the file list visible.
560 public void showFileList(boolean update) {
561 TreeItem currentFolder = getFolders().getCurrent();
562 if (currentFolder != null) {
563 List<FileResource> files = null;
564 Object cachedObject = currentFolder.getUserObject();
565 if (cachedObject instanceof FolderResource) {
566 FolderResource folder = (FolderResource) cachedObject;
567 files = folder.getFiles();
568 } else if (cachedObject instanceof TrashResource) {
569 TrashResource folder = (TrashResource) cachedObject;
570 files = folder.getFiles();
573 getFileList().setFiles(files);
575 fileList.updateFileCache(update, true /*clear selection*/);
580 * Make the search results visible.
582 * @param query the search query string
584 public void showSearchResults(String query) {
585 searchResults.updateFileCache(query);
586 searchResults.updateCurrentlyShowingStats();
591 * Display the 'loading' indicator.
593 public void showLoadingIndicator() {
594 topPanel.getLoading().setVisible(true);
598 * Hide the 'loading' indicator.
600 public void hideLoadingIndicator() {
601 topPanel.getLoading().setVisible(false);
605 * A native JavaScript method to reach out to the browser's window and
606 * invoke its resizeTo() method.
608 * @param x the new width
609 * @param y the new height
611 public static native void resizeTo(int x, int y) /*-{
616 * A helper method that returns true if the user's list is currently visible
617 * and false if it is hidden.
619 * @return true if the user list is visible
621 public boolean isUserListVisible() {
622 return inner.getTabBar().getSelectedTab() == 1;
626 * Display an error message.
628 * @param msg the message to display
630 public void displayError(String msg) {
631 messagePanel.displayError(msg);
635 * Display a warning message.
637 * @param msg the message to display
639 public void displayWarning(String msg) {
640 messagePanel.displayWarning(msg);
644 * Display an informational message.
646 * @param msg the message to display
648 public void displayInformation(String msg) {
649 messagePanel.displayInformation(msg);
653 * Retrieve the folders.
655 * @return the folders
657 public Folders getFolders() {
662 * Retrieve the search.
671 * Retrieve the currentSelection.
673 * @return the currentSelection
675 public Object getCurrentSelection() {
676 return currentSelection;
680 * Modify the currentSelection.
682 * @param newCurrentSelection the currentSelection to set
684 public void setCurrentSelection(Object newCurrentSelection) {
685 currentSelection = newCurrentSelection;
689 * Retrieve the groups.
693 public Groups getGroups() {
698 * Retrieve the fileList.
700 * @return the fileList
702 public FileList getFileList() {
706 public SearchResults getSearchResults() {
707 return searchResults;
711 * Retrieve the topPanel.
713 * @return the topPanel
715 TopPanel getTopPanel() {
720 * Retrieve the clipboard.
722 * @return the clipboard
724 public Clipboard getClipboard() {
728 public StatusPanel getStatusPanel() {
733 * Retrieve the userDetailsPanel.
735 * @return the userDetailsPanel
737 public UserDetailsPanel getUserDetailsPanel() {
738 return userDetailsPanel;
742 * Retrieve the dragController.
744 * @return the dragController
746 public PickupDragController getDragController() {
747 return dragController;
750 public String getToken() {
754 public String getWebDAVPassword() {
755 return webDAVPassword;
758 public void removeGlassPanel() {
759 glassPanel.removeFromParent();
763 * Retrieve the currentUserResource.
765 * @return the currentUserResource
767 public UserResource getCurrentUserResource() {
768 return currentUserResource;
772 * Modify the currentUserResource.
774 * @param newUser the new currentUserResource
776 public void setCurrentUserResource(UserResource newUser) {
777 currentUserResource = newUser;
780 public static native void preventIESelection() /*-{
781 $doc.body.onselectstart = function () { return false; };
784 public static native void enableIESelection() /*-{
785 if ($doc.body.onselectstart != null)
786 $doc.body.onselectstart = null;
790 * @return the absolute path of the API root URL
792 public String getApiPath() {
793 Configuration conf = (Configuration) GWT.create(Configuration.class);
794 return GWT.getModuleBaseURL() + conf.apiPath();
797 public void refreshWebDAVPassword() {
798 Configuration conf = (Configuration) GWT.create(Configuration.class);
799 String domain = Window.Location.getHostName();
800 String path = Window.Location.getPath();
801 String cookie = conf.webdavCookie();
802 webDAVPassword = Cookies.getCookie(cookie);
803 Cookies.setCookie(cookie, "", null, domain, path, false);
807 * Convert server date to local time according to browser timezone
808 * and format it according to localized pattern.
809 * Time is always formatted to 24hr format.
810 * NB: This assumes that server runs in UTC timezone. Otherwise
811 * we would need to adjust for server time offset as well.
816 public static String formatLocalDateTime(Date date) {
817 Date convertedDate = new Date(date.getTime() - date.getTimezoneOffset());
818 final DateTimeFormat dateFormatter = DateTimeFormat.getShortDateFormat();
819 final DateTimeFormat timeFormatter = DateTimeFormat.getFormat("HH:mm");
820 String datePart = dateFormatter.format(convertedDate);
821 String timePart = timeFormatter.format(convertedDate);
822 return datePart + " " + timePart;
826 * History support for folder navigation
827 * adds a new browser history entry
831 public void updateHistory(String key){
832 // Replace any whitespace of the initial string to "+"
833 // String result = key.replaceAll("\\s","+");
834 // Add a new browser history entry.
835 // History.newItem(result);
836 History.newItem(key);
840 * This method examines the token input and add a "/" at the end in case it's omitted.
841 * This happens only in Files/trash/, Files/shared/, Files/others.
844 * @return the formated token with a "/" at the end or the same tokenInput parameter
847 private String handleSpecialFolderNames(String tokenInput){
848 List<String> pathsToCheck = Arrays.asList("Files/trash", "Files/shared", "Files/others");
849 if(pathsToCheck.contains(tokenInput))
850 return tokenInput + "/";
856 * Reject illegal resource names, like '.' or '..' or slashes '/'.
858 static boolean isValidResourceName(String name) {
859 if (".".equals(name) || "..".equals(name) || name.contains("/"))
864 public void putUserToMap(String _userName, String _userFullName){
865 userFullNameMap.put(_userName, _userFullName);
868 public String findUserFullName(String _userName){
869 return userFullNameMap.get(_userName);
872 public String getUserFullName(String _userName) {
873 if (GSS.get().findUserFullName(_userName) == null)
874 //if there is no userFullName found then the map fills with the given _userName,
875 //so userFullName = _userName
876 GSS.get().putUserToMap(_userName, _userName);
877 else if(GSS.get().findUserFullName(_userName).indexOf('@') != -1){
878 //if the userFullName = _userName the GetUserCommand updates the userFullName in the map
879 GetUserCommand guc = new GetUserCommand(_userName);
882 return GSS.get().findUserFullName(_userName);