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.rest.GetCommand;
24 import gr.ebs.gss.client.rest.RestException;
25 import gr.ebs.gss.client.rest.resource.FileResource;
26 import gr.ebs.gss.client.rest.resource.FolderResource;
27 import gr.ebs.gss.client.rest.resource.OtherUserResource;
28 import gr.ebs.gss.client.rest.resource.OthersResource;
29 import gr.ebs.gss.client.rest.resource.RestResource;
30 import gr.ebs.gss.client.rest.resource.RestResourceWrapper;
31 import gr.ebs.gss.client.rest.resource.TrashResource;
32 import gr.ebs.gss.client.rest.resource.UserResource;
34 import java.util.ArrayList;
35 import java.util.Arrays;
36 import java.util.Date;
37 import java.util.HashMap;
38 import java.util.List;
40 import com.google.gwt.core.client.EntryPoint;
41 import com.google.gwt.core.client.GWT;
42 import com.google.gwt.event.logical.shared.ResizeEvent;
43 import com.google.gwt.event.logical.shared.ResizeHandler;
44 import com.google.gwt.event.logical.shared.SelectionEvent;
45 import com.google.gwt.event.logical.shared.SelectionHandler;
46 import com.google.gwt.event.logical.shared.ValueChangeEvent;
47 import com.google.gwt.event.logical.shared.ValueChangeHandler;
48 import com.google.gwt.i18n.client.DateTimeFormat;
49 import com.google.gwt.resources.client.ClientBundle;
50 import com.google.gwt.resources.client.ImageResource;
51 import com.google.gwt.user.client.Command;
52 import com.google.gwt.user.client.Cookies;
53 import com.google.gwt.user.client.DOM;
54 import com.google.gwt.user.client.DeferredCommand;
55 import com.google.gwt.user.client.Event;
56 import com.google.gwt.user.client.History;
57 import com.google.gwt.user.client.Window;
58 import com.google.gwt.user.client.ui.AbstractImagePrototype;
59 import com.google.gwt.user.client.ui.DecoratedTabPanel;
60 import com.google.gwt.user.client.ui.DockPanel;
61 import com.google.gwt.user.client.ui.HasHorizontalAlignment;
62 import com.google.gwt.user.client.ui.HasVerticalAlignment;
63 import com.google.gwt.user.client.ui.HorizontalSplitPanel;
64 import com.google.gwt.user.client.ui.RootPanel;
65 import com.google.gwt.user.client.ui.TabPanel;
66 import com.google.gwt.user.client.ui.VerticalPanel;
68 * Entry point classes define <code>onModuleLoad()</code>.
70 public class GSS implements EntryPoint, ResizeHandler {
73 * A constant that denotes the completion of an IncrementalCommand.
75 public static final boolean DONE = false;
77 public static final int VISIBLE_FILE_COUNT = 100;
80 * Instantiate an application-level image bundle. This object will provide
81 * programmatic access to all the images needed by widgets.
83 private static Images images = (Images) GWT.create(Images.class);
85 private GlassPanel glassPanel = new GlassPanel();
88 * An aggregate image bundle that pulls together all the images for this
89 * application into a single bundle.
91 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, CellTreeView.Images {
93 @Source("gr/ebs/gss/resources/document.png")
94 ImageResource folders();
96 @Source("gr/ebs/gss/resources/edit_group_22.png")
97 ImageResource groups();
99 @Source("gr/ebs/gss/resources/search.png")
100 ImageResource search();
104 * The single GSS instance.
106 private static GSS singleton;
109 * Gets the singleton GSS instance.
111 * @return the GSS object
113 public static GSS get() {
114 if (GSS.singleton == null)
115 GSS.singleton = new GSS();
116 return GSS.singleton;
120 * The Application Clipboard implementation;
122 private Clipboard clipboard = new Clipboard();
124 private UserResource currentUserResource;
127 * The top panel that contains the menu bar.
129 private TopPanel topPanel;
132 * The panel that contains the various system messages.
134 private MessagePanel messagePanel = new MessagePanel(GSS.images);
137 * The bottom panel that contains the status bar.
139 private StatusPanel statusPanel = new StatusPanel(GSS.images);
142 * The top right panel that displays the logged in user details
144 private UserDetailsPanel userDetailsPanel = new UserDetailsPanel();
147 * The file list widget.
149 private FileList fileList;
152 * The group list widget.
154 private Groups groups = new Groups(images);
157 * The search result widget.
159 private SearchResults searchResults;
162 * The tab panel that occupies the right side of the screen.
164 private TabPanel inner = new DecoratedTabPanel(){
166 public void onBrowserEvent(com.google.gwt.user.client.Event event) {
167 if (DOM.eventGetType(event) == Event.ONCONTEXTMENU){
168 if(isFileListShowing()){
169 getFileList().showContextMenu(event);
176 * The split panel that will contain the left and right panels.
178 private HorizontalSplitPanel splitPanel = new HorizontalSplitPanel();
181 * The horizontal panel that will contain the search and status panels.
183 private DockPanel searchStatus = new DockPanel();
188 private Search search;
191 * The widget that displays the tree of folders.
194 private CellTreeView treeView = new CellTreeView(images);
196 * The currently selected item in the application, for use by the Edit menu
197 * commands. Potential types are Folder, File, User and Group.
199 private Object currentSelection;
202 * The authentication token of the current user.
204 private String token;
207 * The WebDAV password of the current user
209 private String webDAVPassword;
213 public HashMap<String, String> userFullNameMap = new HashMap<String, String>();
216 public void onModuleLoad() {
217 // Initialize the singleton before calling the constructors of the
218 // various widgets that might call GSS.get().
220 RootPanel.get().add(glassPanel, 0, 0);
221 parseUserCredentials();
223 topPanel = new TopPanel(GSS.images);
224 topPanel.setWidth("100%");
226 messagePanel.setWidth("100%");
227 messagePanel.setVisible(false);
229 search = new Search(images);
230 searchStatus.add(search, DockPanel.WEST);
231 searchStatus.add(userDetailsPanel, DockPanel.EAST);
232 searchStatus.setCellHorizontalAlignment(userDetailsPanel, HasHorizontalAlignment.ALIGN_RIGHT);
233 searchStatus.setCellVerticalAlignment(search, HasVerticalAlignment.ALIGN_MIDDLE);
234 searchStatus.setCellVerticalAlignment(userDetailsPanel, HasVerticalAlignment.ALIGN_MIDDLE);
235 searchStatus.setWidth("100%");
237 fileList = new FileList(images);
239 searchResults = new SearchResults(images);
241 // Inner contains the various lists.
242 inner.sinkEvents(Event.ONCONTEXTMENU);
243 inner.setAnimationEnabled(true);
244 inner.getTabBar().addStyleName("gss-MainTabBar");
245 inner.getDeckPanel().addStyleName("gss-MainTabPanelBottom");
246 inner.add(fileList, createHeaderHTML(AbstractImagePrototype.create(images.folders()), "Files"), true);
248 inner.add(groups, createHeaderHTML(AbstractImagePrototype.create(images.groups()), "Groups"), true);
249 inner.add(searchResults, createHeaderHTML(AbstractImagePrototype.create(images.search()), "Search Results"), true);
250 //inner.add(new CellTreeView(images), createHeaderHTML(AbstractImagePrototype.create(images.search()), "Cell tree sample"), true);
251 inner.setWidth("100%");
254 inner.addSelectionHandler(new SelectionHandler<Integer>() {
257 public void onSelection(SelectionEvent<Integer> event) {
258 int tabIndex = event.getSelectedItem();
259 // TreeItem treeItem = GSS.get().getFolders().getCurrent();
262 // Files tab selected
263 fileList.clearSelectedRows();
264 fileList.updateCurrentlyShowingStats();
267 // Groups tab selected
268 groups.updateCurrentlyShowingStats();
269 updateHistory("Groups");
272 // Search tab selected
273 searchResults.clearSelectedRows();
274 searchResults.updateCurrentlyShowingStats();
275 updateHistory("Search");
280 // If the application starts with no history token, redirect to a new "Files" state
281 String initToken = History.getToken();
282 if(initToken.length() == 0)
283 History.newItem("Files");
284 // Add history listener to handle any history events
285 History.addValueChangeHandler(new ValueChangeHandler<String>() {
287 public void onValueChange(ValueChangeEvent<String> event) {
288 String tokenInput = event.getValue();
289 String historyToken = handleSpecialFolderNames(tokenInput);
291 if(historyToken.equals("Search"))
293 else if(historyToken.equals("Groups"))
295 else if(historyToken.equals("Files")|| historyToken.length()==0)
299 PopupTree popupTree = GSS.get().getFolders().getPopupTree();
300 TreeItem treeObj = GSS.get().getFolders().getPopupTree().getTreeItem(historyToken);
301 SelectionEvent.fire(popupTree, treeObj);
304 } catch (IndexOutOfBoundsException e) {
310 // Add the left and right panels to the split panel.
311 splitPanel.setLeftWidget(treeView);
312 splitPanel.setRightWidget(inner);
313 splitPanel.setSplitPosition("25%");
314 splitPanel.setSize("100%", "100%");
315 splitPanel.addStyleName("gss-splitPanel");
317 // Create a dock panel that will contain the menu bar at the top,
318 // the shortcuts to the left, the status bar at the bottom and the
319 // right panel taking the rest.
320 VerticalPanel outer = new VerticalPanel();
322 outer.add(searchStatus);
323 outer.add(messagePanel);
324 outer.add(splitPanel);
325 outer.add(statusPanel);
326 outer.setWidth("100%");
327 outer.setCellHorizontalAlignment(messagePanel, HasHorizontalAlignment.ALIGN_CENTER);
331 // Hook the window resize event, so that we can adjust the UI.
332 Window.addResizeHandler(this);
333 // Clear out the window's built-in margin, because we want to take
334 // advantage of the entire client area.
335 Window.setMargin("0px");
336 // Finally, add the outer panel to the RootPanel, so that it will be
338 RootPanel.get().add(outer);
339 // Call the window resized handler to get the initial sizes setup. Doing
340 // this in a deferred command causes it to occur after all widgets'
341 // sizes have been computed by the browser.
342 DeferredCommand.addCommand(new Command() {
345 public void execute() {
346 onWindowResized(Window.getClientHeight());
352 * Fetches the User object for the specified username.
354 * @param username the username of the user
356 private void fetchUser(final String username) {
357 String path = getApiPath() + username + "/";
358 GetCommand<UserResource> getUserCommand = new GetCommand<UserResource>(UserResource.class, username, path, null) {
361 public void onComplete() {
363 currentUserResource = getResult();
364 final String announcement = currentUserResource.getAnnouncement();
365 if (announcement != null)
366 DeferredCommand.addCommand(new Command() {
369 public void execute() {
370 displayInformation(announcement);
376 public void onError(Throwable t) {
377 GWT.log("Fetching user error", t);
378 if (t instanceof RestException)
379 GSS.get().displayError("No user found:" + ((RestException) t).getHttpStatusText());
381 GSS.get().displayError("System error fetching user data:" + t.getMessage());
385 DeferredCommand.addCommand(getUserCommand);
389 * Parse and store the user credentials to the appropriate fields.
391 private void parseUserCredentials() {
392 Configuration conf = (Configuration) GWT.create(Configuration.class);
393 String cookie = conf.authCookie();
394 String auth = Cookies.getCookie(cookie);
397 // Redundant, but silences warnings about possible auth NPE, below.
400 int sepIndex = auth.indexOf(conf.cookieSeparator());
403 token = auth.substring(sepIndex + 1);
404 final String username = auth.substring(0, sepIndex);
405 if (username == null)
408 refreshWebDAVPassword();
410 DeferredCommand.addCommand(new Command() {
413 public void execute() {
420 * Redirect the user to the login page for authentication.
422 protected void authenticateUser() {
423 Configuration conf = (Configuration) GWT.create(Configuration.class);
424 Window.Location.assign(conf.loginUrl() + "?next=" + GWT.getModuleBaseURL());
428 * Clear the cookie and redirect the user to the logout page.
431 Configuration conf = (Configuration) GWT.create(Configuration.class);
432 String cookie = conf.authCookie();
433 String domain = Window.Location.getHostName();
434 String path = Window.Location.getPath();
435 Cookies.setCookie(cookie, "", null, domain, path, false);
436 Window.Location.assign(conf.logoutUrl());
440 * Creates an HTML fragment that places an image & caption together, for use
443 * @param imageProto an image prototype for an image
444 * @param caption the group caption
445 * @return the header HTML fragment
447 private String createHeaderHTML(AbstractImagePrototype imageProto, String caption) {
448 String captionHTML = "<table class='caption' cellpadding='0' "
449 + "cellspacing='0'>" + "<tr><td class='lcaption'>" + imageProto.getHTML()
450 + "</td><td id =" + caption +" class='rcaption'><b style='white-space:nowrap'> "
451 + caption + "</b></td></tr></table>";
455 private void onWindowResized(int height) {
456 // Adjust the split panel to take up the available room in the window.
457 int newHeight = height - splitPanel.getAbsoluteTop() - 44;
460 splitPanel.setHeight("" + newHeight);
461 inner.setHeight("" + newHeight);
462 /*if(isFileListShowing()){
463 getFileList().setHeight("" + (newHeight-50));
468 public void onResize(ResizeEvent event) {
469 int height = event.getHeight();
470 onWindowResized(height);
473 public boolean isFileListShowing() {
474 int tab = inner.getTabBar().getSelectedTab();
480 public boolean isSearchResultsShowing() {
481 int tab = inner.getTabBar().getSelectedTab();
488 * Make the user list visible.
490 public void showUserList() {
495 * Make the file list visible.
497 public void showFileList() {
498 fileList.updateFileCache(false, true /*clear selection*/);
503 * Make the file list visible.
507 public void showFileList(boolean update) {
508 /*TreeItem currentFolder = getFolders().getCurrent();
509 if (currentFolder != null) {
510 List<FileResource> files = null;
511 Object cachedObject = currentFolder.getUserObject();
512 if (cachedObject instanceof FolderResource) {
513 FolderResource folder = (FolderResource) cachedObject;
514 files = folder.getFiles();
515 } else if (cachedObject instanceof TrashResource) {
516 TrashResource folder = (TrashResource) cachedObject;
517 files = folder.getFiles();
520 getFileList().setFiles(files);
522 RestResource currentFolder = getTreeView().getSelection();
523 GWT.log("SELECTED:"+currentFolder);
524 if(currentFolder!=null){
525 GWT.log("SELECTED:"+currentFolder.getClass());
526 List<FileResource> files = null;
527 if (currentFolder instanceof RestResourceWrapper) {
528 RestResourceWrapper folder = (RestResourceWrapper) currentFolder;
529 files = folder.getResource().getFiles();
530 } else if (currentFolder instanceof TrashResource) {
531 TrashResource folder = (TrashResource) currentFolder;
532 files = folder.getFiles();
534 else if(currentFolder instanceof OthersResource){
535 files = new ArrayList<FileResource>();
537 else if(currentFolder instanceof OtherUserResource){
538 files = ((OtherUserResource)currentFolder).getFiles();
541 getFileList().setFiles(files);
543 fileList.updateFileCache(update, true /*clear selection*/);
547 public void showFileList(RestResource r,boolean update) {
548 /*TreeItem currentFolder = getFolders().getCurrent();
549 if (currentFolder != null) {
550 List<FileResource> files = null;
551 Object cachedObject = currentFolder.getUserObject();
552 if (cachedObject instanceof FolderResource) {
553 FolderResource folder = (FolderResource) cachedObject;
554 files = folder.getFiles();
555 } else if (cachedObject instanceof TrashResource) {
556 TrashResource folder = (TrashResource) cachedObject;
557 files = folder.getFiles();
560 getFileList().setFiles(files);
562 RestResource currentFolder = r;
563 GWT.log("SELECTED:"+currentFolder);
564 if(currentFolder!=null){
565 List<FileResource> files = null;
566 if (currentFolder instanceof RestResourceWrapper) {
567 RestResourceWrapper folder = (RestResourceWrapper) currentFolder;
568 files = folder.getResource().getFiles();
569 } else if (currentFolder instanceof TrashResource) {
570 TrashResource folder = (TrashResource) currentFolder;
571 files = folder.getFiles();
574 getFileList().setFiles(files);
576 fileList.updateFileCache(update, true /*clear selection*/);
581 * Make the search results visible.
583 * @param query the search query string
585 public void showSearchResults(String query) {
586 searchResults.updateFileCache(query);
587 searchResults.updateCurrentlyShowingStats();
592 * Display the 'loading' indicator.
594 public void showLoadingIndicator() {
595 topPanel.getLoading().setVisible(true);
599 * Hide the 'loading' indicator.
601 public void hideLoadingIndicator() {
602 topPanel.getLoading().setVisible(false);
606 * A native JavaScript method to reach out to the browser's window and
607 * invoke its resizeTo() method.
609 * @param x the new width
610 * @param y the new height
612 public static native void resizeTo(int x, int y) /*-{
617 * A helper method that returns true if the user's list is currently visible
618 * and false if it is hidden.
620 * @return true if the user list is visible
622 public boolean isUserListVisible() {
623 return inner.getTabBar().getSelectedTab() == 1;
627 * Display an error message.
629 * @param msg the message to display
631 public void displayError(String msg) {
632 messagePanel.displayError(msg);
636 * Display a warning message.
638 * @param msg the message to display
640 public void displayWarning(String msg) {
641 messagePanel.displayWarning(msg);
645 * Display an informational message.
647 * @param msg the message to display
649 public void displayInformation(String msg) {
650 messagePanel.displayInformation(msg);
654 * Retrieve the folders.
656 * @return the folders
658 public Folders getFolders() {
663 * Retrieve the search.
672 * Retrieve the currentSelection.
674 * @return the currentSelection
676 public Object getCurrentSelection() {
677 return currentSelection;
681 * Modify the currentSelection.
683 * @param newCurrentSelection the currentSelection to set
685 public void setCurrentSelection(Object newCurrentSelection) {
686 currentSelection = newCurrentSelection;
690 * Retrieve the groups.
694 public Groups getGroups() {
699 * Retrieve the fileList.
701 * @return the fileList
703 public FileList getFileList() {
707 public SearchResults getSearchResults() {
708 return searchResults;
712 * Retrieve the topPanel.
714 * @return the topPanel
716 TopPanel getTopPanel() {
721 * Retrieve the clipboard.
723 * @return the clipboard
725 public Clipboard getClipboard() {
729 public StatusPanel getStatusPanel() {
734 * Retrieve the userDetailsPanel.
736 * @return the userDetailsPanel
738 public UserDetailsPanel getUserDetailsPanel() {
739 return userDetailsPanel;
744 public String getToken() {
748 public String getWebDAVPassword() {
749 return webDAVPassword;
752 public void removeGlassPanel() {
753 glassPanel.removeFromParent();
757 * Retrieve the currentUserResource.
759 * @return the currentUserResource
761 public UserResource getCurrentUserResource() {
762 return currentUserResource;
766 * Modify the currentUserResource.
768 * @param newUser the new currentUserResource
770 public void setCurrentUserResource(UserResource newUser) {
771 currentUserResource = newUser;
774 public static native void preventIESelection() /*-{
775 $doc.body.onselectstart = function () { return false; };
778 public static native void enableIESelection() /*-{
779 if ($doc.body.onselectstart != null)
780 $doc.body.onselectstart = null;
784 * @return the absolute path of the API root URL
786 public String getApiPath() {
787 Configuration conf = (Configuration) GWT.create(Configuration.class);
788 return GWT.getModuleBaseURL() + conf.apiPath();
791 public void refreshWebDAVPassword() {
792 Configuration conf = (Configuration) GWT.create(Configuration.class);
793 String domain = Window.Location.getHostName();
794 String path = Window.Location.getPath();
795 String cookie = conf.webdavCookie();
796 webDAVPassword = Cookies.getCookie(cookie);
797 Cookies.setCookie(cookie, "", null, domain, path, false);
801 * Convert server date to local time according to browser timezone
802 * and format it according to localized pattern.
803 * Time is always formatted to 24hr format.
804 * NB: This assumes that server runs in UTC timezone. Otherwise
805 * we would need to adjust for server time offset as well.
810 public static String formatLocalDateTime(Date date) {
811 Date convertedDate = new Date(date.getTime() - date.getTimezoneOffset());
812 final DateTimeFormat dateFormatter = DateTimeFormat.getShortDateFormat();
813 final DateTimeFormat timeFormatter = DateTimeFormat.getFormat("HH:mm");
814 String datePart = dateFormatter.format(convertedDate);
815 String timePart = timeFormatter.format(convertedDate);
816 return datePart + " " + timePart;
820 * History support for folder navigation
821 * adds a new browser history entry
825 public void updateHistory(String key){
826 // Replace any whitespace of the initial string to "+"
827 // String result = key.replaceAll("\\s","+");
828 // Add a new browser history entry.
829 // History.newItem(result);
830 History.newItem(key);
834 * This method examines the token input and add a "/" at the end in case it's omitted.
835 * This happens only in Files/trash/, Files/shared/, Files/others.
838 * @return the formated token with a "/" at the end or the same tokenInput parameter
841 private String handleSpecialFolderNames(String tokenInput){
842 List<String> pathsToCheck = Arrays.asList("Files/trash", "Files/shared", "Files/others");
843 if(pathsToCheck.contains(tokenInput))
844 return tokenInput + "/";
850 * Reject illegal resource names, like '.' or '..' or slashes '/'.
852 static boolean isValidResourceName(String name) {
853 if (".".equals(name) || "..".equals(name) || name.contains("/"))
858 public void putUserToMap(String _userName, String _userFullName){
859 userFullNameMap.put(_userName, _userFullName);
862 public String findUserFullName(String _userName){
863 return userFullNameMap.get(_userName);
865 public String getUserFullName(String _userName) {
867 if (GSS.get().findUserFullName(_userName) == null)
868 //if there is no userFullName found then the map fills with the given _userName,
869 //so userFullName = _userName
870 GSS.get().putUserToMap(_userName, _userName);
871 else if(GSS.get().findUserFullName(_userName).indexOf('@') != -1){
872 //if the userFullName = _userName the GetUserCommand updates the userFullName in the map
873 GetUserCommand guc = new GetUserCommand(_userName);
876 return GSS.get().findUserFullName(_userName);
879 * Retrieve the treeView.
881 * @return the treeView
883 public CellTreeView getTreeView() {
887 public void onResourceUpdate(RestResource resource){
888 if(resource instanceof RestResourceWrapper){
889 if(getTreeView().getSelection()!=null&&getTreeView().getSelection().getUri().equals(resource.getUri()))
890 showFileList(resource,true);