Changeset 5475

Timestamp:

07/11/14 14:05:50 (10 years ago)

Author:

Twan Goosen

Message:

Added PageParameters? constructor to VC details page to make URL bookmarkable.
Fixes #591

Location:

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui

Files:

• Application.java (modified) (2 diffs)
• ApplicationSession.java (modified) (2 diffs)
• pages/BasePage.java (modified) (1 diff)
• pages/BrowsePrivateCollectionsPage.java (modified) (2 diffs)
• pages/BrowsePublicCollectionsPage.java (modified) (2 diffs)
• pages/VirtualCollectionDetailsPage.java (modified) (11 diffs)

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/Application.java

@@ -9 +9 @@
 import eu.clarin.cmdi.virtualcollectionregistry.gui.pages.EditVirtualCollectionPage;
 import eu.clarin.cmdi.virtualcollectionregistry.gui.pages.LoginPage;
+import eu.clarin.cmdi.virtualcollectionregistry.gui.pages.VirtualCollectionDetailsPage;
 import java.io.BufferedReader;
 import java.io.FileInputStream;
@@ -74 +75 @@
         mountBookmarkablePage("/admin", AdminPage.class);
 
+        // details of an existing collection by ID, e.g. /details/123
+        mount(new MixedParamHybridUrlCodingStrategy("/details",
+                VirtualCollectionDetailsPage.class, new String[]{VirtualCollectionDetailsPage.PARAM_VC_ID}));
         // editing an existing collection by ID, e.g. /edit/123
         mount(new MixedParamHybridUrlCodingStrategy("/edit",

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/ApplicationSession.java

@@ -3 +3 @@
 import de.mpg.aai.shhaa.model.AuthAttribute;
 import de.mpg.aai.shhaa.model.AuthPrincipal;
+import eu.clarin.cmdi.virtualcollectionregistry.model.User;
 import java.security.Principal;
 import java.util.regex.Pattern;
@@ -69 +70 @@
     }
 
+    /**
+     *
+     * @param user user to check for
+     * @return whether the specified user is the user currently signed in (false
+     * if {@link #isSignedIn() } returns false)
+     */
+    public boolean isCurrentUser(User user) {
+        return isSignedIn() && getUser().equals(user.getName());
+    }
+
     public String getUser() {
         return user;

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/BasePage.java

@@ -83 +83 @@
     }
 
+    @Override
+    public ApplicationSession getSession() {
+        return (ApplicationSession) super.getSession();
+    }
+    
+    
+
 } // class BasePage

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/BrowsePrivateCollectionsPage.java

@@ -1 +1 @@
 package eu.clarin.cmdi.virtualcollectionregistry.gui.pages;
-
 
 import org.apache.wicket.Component;
@@ -255 +254 @@
     }
 
-    private void doDetails(AjaxRequestTarget target,
-            IModel<VirtualCollection> vc) {
-        setResponsePage(new VirtualCollectionDetailsPage(vc, getPage()));
-    }
-
+    private void doDetails(AjaxRequestTarget target, IModel<VirtualCollection> vc) {
+        setResponsePage(VirtualCollectionDetailsPage.class, VirtualCollectionDetailsPage.createPageParameters(vc.getObject(), getPageReference()));
+    }
 
 } // class BrowsePrivateCollectionsPage

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/BrowsePublicCollectionsPage.java

@@ -11 +11 @@
 @SuppressWarnings("serial")
 public class BrowsePublicCollectionsPage extends BasePage {
+
     private class ActionsPanel extends Panel {
+
         public ActionsPanel(String id, IModel<VirtualCollection> model) {
             super(id, model);
             setRenderBodyOnly(true);
 
-            final AjaxLink<VirtualCollection> detailsLink =
-                new AjaxLink<VirtualCollection>("details", model) {
-                @Override
-                public void onClick(AjaxRequestTarget target) {
-                    doDetails(target, getModel());
-                }
-            };
+            final AjaxLink<VirtualCollection> detailsLink
+                    = new AjaxLink<VirtualCollection>("details", model) {
+                        @Override
+                        public void onClick(AjaxRequestTarget target) {
+                            doDetails(target, getModel());
+                        }
+                    };
             add(detailsLink);
         }
@@ -29 +31 @@
     public BrowsePublicCollectionsPage() {
         super();
-        final VirtualCollectionTable table =
-            new VirtualCollectionTable("collectionsTable", false) {
-                @Override
-                protected Panel createActionColumn(String componentId,
-                        IModel<VirtualCollection> model) {
-                    return new ActionsPanel(componentId, model);
-                }
+        final VirtualCollectionTable table
+                = new VirtualCollectionTable("collectionsTable", false) {
+                    @Override
+                    protected Panel createActionColumn(String componentId,
+                            IModel<VirtualCollection> model) {
+                        return new ActionsPanel(componentId, model);
+                    }
 
-                @Override
-                protected Panel createActionPanel(String componentId,
-                        IModel<VirtualCollection> model) {
-                    return new ActionsPanel(componentId, model);
-                }
-        };
+                    @Override
+                    protected Panel createActionPanel(String componentId,
+                            IModel<VirtualCollection> model) {
+                        return new ActionsPanel(componentId, model);
+                    }
+                };
         add(table);
     }
 
-    private void doDetails(AjaxRequestTarget target,
-            IModel<VirtualCollection> vc) {
-        setResponsePage(new VirtualCollectionDetailsPage(vc, getPage()));
+    private void doDetails(AjaxRequestTarget target, IModel<VirtualCollection> vc) {
+        setResponsePage(VirtualCollectionDetailsPage.class, VirtualCollectionDetailsPage.createPageParameters(vc.getObject(), getPageReference()));
     }
 

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/VirtualCollectionDetailsPage.java

@@ -1 +1 @@
 package eu.clarin.cmdi.virtualcollectionregistry.gui.pages;
 
+import eu.clarin.cmdi.virtualcollectionregistry.gui.Application;
 import eu.clarin.cmdi.virtualcollectionregistry.gui.DateConverter;
+import eu.clarin.cmdi.virtualcollectionregistry.gui.DetachableVirtualCollectionModel;
 import eu.clarin.cmdi.virtualcollectionregistry.gui.VolatileEntityModel;
+import eu.clarin.cmdi.virtualcollectionregistry.gui.border.AjaxToggleBorder;
+import eu.clarin.cmdi.virtualcollectionregistry.model.Creator;
+import eu.clarin.cmdi.virtualcollectionregistry.model.Resource;
+import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollection;
+import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollection.Type;
 import java.sql.Date;
 import java.util.Collection;
@@ -9 +16 @@
 import java.util.List;
 import java.util.Locale;
-
-import org.apache.wicket.Application;
 import org.apache.wicket.Component;
+import org.apache.wicket.IPageMap;
 import org.apache.wicket.Page;
+import org.apache.wicket.PageParameters;
+import org.apache.wicket.PageReference;
+import org.apache.wicket.Session;
+import org.apache.wicket.authorization.Action;
+import org.apache.wicket.authorization.AuthorizationException;
+import org.apache.wicket.authorization.UnauthorizedActionException;
 import org.apache.wicket.behavior.AbstractBehavior;
 import org.apache.wicket.extensions.ajax.markup.html.repeater.data.table.AjaxFallbackDefaultDataTable;
@@ -38 +50 @@
 import org.apache.wicket.util.string.Strings;
 
-import eu.clarin.cmdi.virtualcollectionregistry.gui.border.AjaxToggleBorder;
-import eu.clarin.cmdi.virtualcollectionregistry.model.Creator;
-import eu.clarin.cmdi.virtualcollectionregistry.model.Resource;
-import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollection;
-import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollection.Type;
-
-
 @SuppressWarnings("serial")
 public class VirtualCollectionDetailsPage extends BasePage {
+
+    public static final String PARAM_VC_ID = "id";
+    public static final String PARAM_BACK_PAGE_ID = "backPage";
+    public static final String PARAM_BACK_PAGE_VERSION = "backPageVersion";
+    public static final String PARAM_BACK_PAGE_PAGEMAP_NAME = "backPageMapName";
+
     private static final IConverter convEnum = new IConverter() {
         @Override
         public String convertToString(Object o, Locale locale) {
             final Enum<?> enumObj = (Enum<?>) o;
-            final String key =
-                enumObj.getDeclaringClass().getSimpleName() + "." +
-                enumObj.name();
+            final String key
+                    = enumObj.getDeclaringClass().getSimpleName() + "."
+                    + enumObj.name();
             final String value = Application.get().getResourceSettings()
                     .getLocalizer().getString(key, null);
@@ -75 +86 @@
      */
     private static final class HideIfEmptyBehavior extends AbstractBehavior {
+
         private final List<Component> components = new LinkedList<Component>();
 
@@ -85 +97 @@
         public void hideEmptyComponents() {
             for (Component component : components) {
-              Object obj = component.getDefaultModelObject();
-              if (obj == null) {
-                  component.setVisible(false);
-              } else {
-                  if (obj instanceof Collection<?>) {
-                      if (((Collection<?>) obj).isEmpty()) {
-                          component.setVisible(false);
-                      }
-                  }
-              }
+                Object obj = component.getDefaultModelObject();
+                if (obj == null) {
+                    component.setVisible(false);
+                } else {
+                    if (obj instanceof Collection<?>) {
+                        if (((Collection<?>) obj).isEmpty()) {
+                            component.setVisible(false);
+                        }
+                    }
+                }
             }
         }
@@ -113 +125 @@
         @Override
         public IConverter getConverter(Class<?> type) {
-            if (VirtualCollection.Type.class.isAssignableFrom(type) ||
-                VirtualCollection.Purpose.class.isAssignableFrom(type) ||
-                VirtualCollection.Reproducibility.class.isAssignableFrom(type)) {
+            if (VirtualCollection.Type.class.isAssignableFrom(type)
+                    || VirtualCollection.Purpose.class.isAssignableFrom(type)
+                    || VirtualCollection.Reproducibility.class.isAssignableFrom(type)) {
                 return convEnum;
             }
@@ -125 +137 @@
     } // class VirtualCollectionDetailsPage.TypeLabel
 
-
     private final HideIfEmptyBehavior hideIfEmpty = new HideIfEmptyBehavior();
 
-
-    public VirtualCollectionDetailsPage(final IModel<VirtualCollection> model,
-            final Page previousPage) {
+    public VirtualCollectionDetailsPage(PageParameters params) {
+        this(getVirtualCollectionModel(params), getPageReference(params));
+    }
+
+    public VirtualCollectionDetailsPage(final IModel<VirtualCollection> model, final PageReference previousPage) {
         super(new CompoundPropertyModel<VirtualCollection>(model));
-        if (previousPage == null) {
-            throw new IllegalArgumentException("previousPage == null");
-        }
+        if (model == null) {
+            setResponsePage(Application.get().getHomePage());
+        } else {
+            checkAccess(model.getObject());
+        }
+
         final Link<Void> backLink = new Link<Void>("back") {
             @Override
             public void onClick() {
-                setResponsePage(previousPage);
+                if (previousPage == null) {
+                    setResponsePage(getApplication().getHomePage());
+                } else {
+                    setResponsePage(previousPage.getPage());
+                }
             }
         };
@@ -173 +193 @@
                 item.add(new Label("email").add(hideIfEmpty));
                 item.add(new Label("telephone").add(hideIfEmpty));
-                final IModel<String> siteModel =
-                    new ComponentPropertyModel<String>("website");
+                final IModel<String> siteModel
+                        = new ComponentPropertyModel<String>("website");
                 item.add(new ExternalLink("website", siteModel, siteModel)
                         .setPopupSettings(new PopupSettings())
@@ -191 +211 @@
             @Override
             protected ListItem<Creator> newItem(int index) {
-                final IModel<Creator> model =
-                    getListItemModel(getModel(), index);
+                final IModel<Creator> model
+                        = getListItemModel(getModel(), index);
                 return new OddEvenListItem<Creator>(index, model) {
                     @Override
@@ -213 +233 @@
         cols[0] = new PropertyColumn<Resource>(
                 new Model<String>("Type"), "type") {
-            @Override
-            public void populateItem(Item<ICellPopulator<Resource>> item,
-                    String componentId, IModel<Resource> model) {
-                final Resource.Type type = model.getObject().getType();
-                item.add(new Label(componentId,
-                        convEnum.convertToString(type, getLocale())));
-            }
-        };
+                    @Override
+                    public void populateItem(Item<ICellPopulator<Resource>> item,
+                            String componentId, IModel<Resource> model) {
+                        final Resource.Type type = model.getObject().getType();
+                        item.add(new Label(componentId,
+                                        convEnum.convertToString(type, getLocale())));
+                    }
+                };
         cols[1] = new PropertyColumn<Resource>(
                 new Model<String>("Reference"), "ref");
 
         @SuppressWarnings("unchecked")
-        final DataTable<Resource> resourcesTable =
-            new AjaxFallbackDefaultDataTable<Resource>("resourcesTable",
-                    cols,
-                    new SortableDataProvider<Resource>() {
-                        @Override
-                        public Iterator<? extends Resource>
+        final DataTable<Resource> resourcesTable
+                = new AjaxFallbackDefaultDataTable<Resource>("resourcesTable",
+                        cols,
+                        new SortableDataProvider<Resource>() {
+                            @Override
+                            public Iterator<? extends Resource>
                             iterator(int first, int count) {
-                            return model.getObject().getResources().listIterator(first);
-                        }
-
-                        @Override
-                        public IModel<Resource> model(Resource resource) {
-                            return new VolatileEntityModel<Resource>(resource);
-                        }
-
-                        @Override
-                        public int size() {
-                            return model.getObject().getResources().size();
-                        }
-                    },
-                    64);
+                                return model.getObject().getResources().listIterator(first);
+                            }
+
+                            @Override
+                            public IModel<Resource> model(Resource resource) {
+                                return new VolatileEntityModel<Resource>(resource);
+                            }
+
+                            @Override
+                            public int size() {
+                                return model.getObject().getResources().size();
+                            }
+                        },
+                        64);
         resources.add(resourcesTable);
         resources.setVisible(model.getObject().getType() == Type.EXTENSIONAL);
@@ -259 +279 @@
     }
 
+    private static IModel<VirtualCollection> getVirtualCollectionModel(PageParameters params) {
+        final Long collectionId = params.getAsLong(PARAM_VC_ID);
+        if (collectionId == null) {
+            Session.get().error("Collection could not be retrieved, id not provided");
+            return null;
+        }
+        return new DetachableVirtualCollectionModel(collectionId);
+    }
+
+    private static PageReference getPageReference(PageParameters params) {
+        final Integer pageId = params.getAsInteger(PARAM_BACK_PAGE_ID);
+        final Integer pageVersion = params.getAsInteger(PARAM_BACK_PAGE_VERSION);
+        final String pageMap = params.getString(PARAM_BACK_PAGE_PAGEMAP_NAME);
+        if (pageId != null && pageVersion != null) {
+            for (IPageMap map : Session.get().getPageMaps()) {
+                if (pageMap == null && map.getName() == null || pageMap != null && pageMap.equals(map.getName())) {
+                    final Page page = map.get(pageId, pageVersion);
+                    if (page != null) {
+                        return page.getPageReference();
+                    }
+                }
+            }
+        }
+        return null;
+    }
+
+    public static PageParameters createPageParameters(VirtualCollection vc, PageReference pageReference) {
+        final PageParameters params = new PageParameters();
+        params.put(VirtualCollectionDetailsPage.PARAM_VC_ID, vc.getId());
+
+        if (pageReference != null) {
+            params.put(VirtualCollectionDetailsPage.PARAM_BACK_PAGE_ID, pageReference.getPageNumber());
+            params.put(VirtualCollectionDetailsPage.PARAM_BACK_PAGE_VERSION, pageReference.getPageVersion());
+            if (pageReference.getPageMapName() != null) {
+                params.put(VirtualCollectionDetailsPage.PARAM_BACK_PAGE_PAGEMAP_NAME, pageReference.getPageMapName());
+            }
+        }
+        return params;
+    }
+
+    /**
+     * 
+     * @param vc collection to check for
+     * @throws UnauthorizedActionException if the VC is private and the current
+     * user is not the owner
+     */
+    private void checkAccess(final VirtualCollection vc) throws UnauthorizedActionException {
+        if (vc.isPrivate()
+                && !getSession().isCurrentUser(vc.getOwner())) {
+            // user trying to access other user's collection
+            throw new UnauthorizedActionException(this, Component.RENDER);
+        }
+    }
+
     @Override
     protected void onBeforeRender() {