Examples with UserLayoutChannelDescription org.apereo.portal.layout.node.UserLayoutChannelDescription used on opensource projects

Example 1 with UserLayoutChannelDescription

use of org.apereo.portal.layout.node.UserLayoutChannelDescription in project uPortal by Jasig.

the class TransientUserLayoutManagerWrapper method createUserLayoutChannelDescription.

protected IUserLayoutChannelDescription createUserLayoutChannelDescription(String nodeId, IPortletDefinition chanDef) {
    IUserLayoutChannelDescription ulnd = new UserLayoutChannelDescription();
    ulnd.setId(nodeId);
    ulnd.setName(chanDef.getName());
    ulnd.setUnremovable(true);
    ulnd.setImmutable(true);
    ulnd.setHidden(false);
    ulnd.setTitle(chanDef.getTitle());
    ulnd.setDescription(chanDef.getDescription());
    ulnd.setChannelPublishId("" + chanDef.getPortletDefinitionId().getStringId());
    ulnd.setChannelTypeId("" + chanDef.getType().getId());
    ulnd.setFunctionalName(chanDef.getFName());
    ulnd.setTimeout(chanDef.getTimeout());
    Set<IPortletDefinitionParameter> parms = chanDef.getParameters();
    for (IPortletDefinitionParameter parm : parms) {
        ulnd.setParameterValue(parm.getName(), parm.getValue());
    }
    return ulnd;
}

Example 2 with UserLayoutChannelDescription

use of org.apereo.portal.layout.node.UserLayoutChannelDescription in project uPortal by Jasig.

the class PortletMarketplaceController method isPortletFavorited.

private boolean isPortletFavorited(IUserLayout layout, String fname) {
    List<IUserLayoutNodeDescription> favorites = favoritesUtils.getFavoritePortletLayoutNodes(layout);
    for (IUserLayoutNodeDescription favorite : favorites) {
        if (favorite instanceof UserLayoutChannelDescription) {
            String channelId = ((UserLayoutChannelDescription) favorite).getChannelPublishId();
            IPortletDefinition portletDefinition = portletDefinitionRegistry.getPortletDefinition(channelId);
            String favFName = portletDefinition.getFName();
            if (fname != null && fname.equals(favFName)) {
                return true;
            }
        }
    }
    return false;
}

Example 3 with UserLayoutChannelDescription

use of org.apereo.portal.layout.node.UserLayoutChannelDescription in project uPortal by Jasig.

the class UpdatePreferencesServlet method addFavorite.

@RequestMapping(method = RequestMethod.POST, params = "action=addFavorite")
public ModelAndView addFavorite(@RequestParam String channelId, HttpServletRequest request, HttpServletResponse response) throws IOException {
    final IUserInstance ui = userInstanceManager.getUserInstance(request);
    final IPerson person = getPerson(ui, response);
    final IPortletDefinition pdef = portletDefinitionRegistry.getPortletDefinition(channelId);
    final Locale locale = RequestContextUtils.getLocale(request);
    final IAuthorizationPrincipal authPrincipal = this.getUserPrincipal(person.getUserName());
    final String targetString = PermissionHelper.permissionTargetIdForPortletDefinition(pdef);
    if (!authPrincipal.hasPermission(IPermission.PORTAL_SYSTEM, IPermission.PORTLET_FAVORITE_ACTIVITY, targetString)) {
        logger.warn("Unauthorized attempt to favorite portlet '{}' through the REST API by user '{}'", pdef.getFName(), person.getUserName());
        response.setStatus(HttpServletResponse.SC_FORBIDDEN);
        return new ModelAndView("jsonView", Collections.singletonMap("response", getMessage("error.favorite.not.permitted", "Favorite not permitted", locale)));
    }
    final UserPreferencesManager upm = (UserPreferencesManager) ui.getPreferencesManager();
    final IUserLayoutManager ulm = upm.getUserLayoutManager();
    final IUserLayoutChannelDescription channel = new UserLayoutChannelDescription(person, pdef, request.getSession());
    // get favorite tab
    final String favoriteTabNodeId = favoritesUtils.getFavoriteTabNodeId(ulm.getUserLayout());
    if (favoriteTabNodeId != null) {
        // add portlet to favorite tab
        final IUserLayoutNodeDescription node = addNodeToTab(ulm, channel, favoriteTabNodeId);
        if (node == null) {
            response.setStatus(HttpServletResponse.SC_FORBIDDEN);
            return new ModelAndView("jsonView", Collections.singletonMap("response", getMessage("error.add.portlet.in.tab", "Can''t add a new favorite", locale)));
        }
        try {
            // save the user's layout
            ulm.saveUserLayout();
        } catch (PortalException e) {
            return handlePersistError(request, response, e);
        }
        // document success for notifications
        final Map<String, String> model = new HashMap<>();
        final String channelTitle = channel.getTitle();
        model.put("response", getMessage("favorites.added.favorite", channelTitle, "Added " + channelTitle + " as a favorite.", locale));
        model.put("newNodeId", node.getId());
        return new ModelAndView("jsonView", model);
    } else {
        response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
        return new ModelAndView("jsonView", Collections.singletonMap("response", getMessage("error.finding.favorite.tab", "Can''t find favorite tab", locale)));
    }
}

Example 4 with UserLayoutChannelDescription

use of org.apereo.portal.layout.node.UserLayoutChannelDescription in project uPortal by Jasig.

the class UpdatePreferencesServlet method addPortlet.

/**
 * Add a new channel.
 *
 * @param request
 * @param response
 * @throws IOException
 * @throws PortalException
 */
@RequestMapping(method = RequestMethod.POST, params = "action=addPortlet")
public ModelAndView addPortlet(HttpServletRequest request, HttpServletResponse response) throws IOException, PortalException {
    IUserInstance ui = userInstanceManager.getUserInstance(request);
    UserPreferencesManager upm = (UserPreferencesManager) ui.getPreferencesManager();
    IUserLayoutManager ulm = upm.getUserLayoutManager();
    final Locale locale = RequestContextUtils.getLocale(request);
    // gather the parameters we need to move a channel
    String destinationId = request.getParameter("elementID");
    String sourceId = request.getParameter("channelID");
    String method = request.getParameter("position");
    String fname = request.getParameter("fname");
    if (destinationId == null) {
        String tabName = request.getParameter("tabName");
        if (tabName != null) {
            destinationId = getTabIdFromName(ulm.getUserLayout(), tabName);
        }
    }
    IPortletDefinition definition;
    if (sourceId != null)
        definition = portletDefinitionRegistry.getPortletDefinition(sourceId);
    else if (fname != null)
        definition = portletDefinitionRegistry.getPortletDefinitionByFname(fname);
    else {
        logger.error("SourceId or fname invalid when adding a portlet");
        response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
        return new ModelAndView("jsonView", Collections.singletonMap("error", "SourceId or fname invalid"));
    }
    IUserLayoutChannelDescription channel = new UserLayoutChannelDescription(getPerson(ui, response), definition, request.getSession());
    IUserLayoutNodeDescription node;
    if (isTab(ulm, destinationId)) {
        node = addNodeToTab(ulm, channel, destinationId);
    } else {
        boolean isInsert = method != null && method.equals("insertBefore");
        // If neither an insert or type folder - Can't "insert into" non-folder
        if (!(isInsert || isFolder(ulm, destinationId))) {
            logger.error("Cannot insert into portlet element");
            response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
            return new ModelAndView("jsonView", Collections.singletonMap("error", "Cannot insert into portlet element"));
        }
        String siblingId = isInsert ? destinationId : null;
        String target = isInsert ? ulm.getParentId(destinationId) : destinationId;
        // move the channel into the column
        node = ulm.addNode(channel, target, siblingId);
    }
    if (node == null) {
        response.setStatus(HttpServletResponse.SC_FORBIDDEN);
        return new ModelAndView("jsonView", Collections.singletonMap("error", getMessage("error.add.element", "Unable to add element", locale)));
    }
    String nodeId = node.getId();
    try {
        // save the user's layout
        ulm.saveUserLayout();
        if (addedWindowState != null) {
            IPortletWindow portletWindow = this.portletWindowRegistry.getOrCreateDefaultPortletWindowByFname(request, channel.getFunctionalName());
            portletWindow.setWindowState(addedWindowState);
            this.portletWindowRegistry.storePortletWindow(request, portletWindow);
        }
    } catch (PortalException e) {
        return handlePersistError(request, response, e);
    }
    Map<String, String> model = new HashMap<>();
    model.put("response", getMessage("success.add.portlet", "Added a new channel", locale));
    model.put("newNodeId", nodeId);
    return new ModelAndView("jsonView", model);
}

Example 5 with UserLayoutChannelDescription

use of org.apereo.portal.layout.node.UserLayoutChannelDescription in project uPortal by Jasig.

the class UpdatePreferencesServlet method removeFavorite.

/**
 * This method removes the channelId specified from favorites. Note that even if you pass in the
 * layout channel id, it will always remove from the favorites.
 *
 * @param channelId The long channel ID that is used to determine which fname to remove from
 *     favorites
 * @param request
 * @param response
 * @return returns a mav object with a response attribute for noty
 * @throws IOException if it has problem reading the layout file.
 */
@RequestMapping(method = RequestMethod.POST, params = "action=removeFavorite")
public ModelAndView removeFavorite(@RequestParam String channelId, HttpServletRequest request, HttpServletResponse response) throws IOException {
    UserPreferencesManager upm = (UserPreferencesManager) userInstanceManager.getUserInstance(request).getPreferencesManager();
    IUserLayoutManager ulm = upm.getUserLayoutManager();
    final Locale locale = RequestContextUtils.getLocale(request);
    IPortletDefinition portletDefinition = portletDefinitionRegistry.getPortletDefinition(channelId);
    if (portletDefinition != null && StringUtils.isNotBlank(portletDefinition.getFName())) {
        String functionalName = portletDefinition.getFName();
        List<IUserLayoutNodeDescription> favoritePortlets = favoritesUtils.getFavoritePortletLayoutNodes(ulm.getUserLayout());
        // Retrieve favorites matching functional name from list of favorites
        List<IUserLayoutChannelDescription> favoritesToDelete = FavoritesUtils.getDuplicateFavoritesByFNameToDelete(favoritePortlets, functionalName);
        String resp = new String();
        for (IUserLayoutChannelDescription deleteNode : favoritesToDelete) {
            if (deleteNode != null && deleteNode instanceof UserLayoutChannelDescription) {
                UserLayoutChannelDescription channelDescription = (UserLayoutChannelDescription) deleteNode;
                try {
                    if (!ulm.deleteNode(channelDescription.getChannelSubscribeId())) {
                        logger.warn("Error deleting the node {} from favorites for user {}", channelId, (upm.getPerson() == null ? "unknown" : upm.getPerson().getID()));
                        response.setStatus(HttpServletResponse.SC_FORBIDDEN);
                        // load fail message
                        resp = getMessage("error.remove.favorite", "Can''t remove favorite", locale);
                    } else {
                        // load success message
                        resp = getMessage("success.remove.portlet", "Removed from Favorites successfully", locale);
                    }
                    // save the user's layout
                    ulm.saveUserLayout();
                } catch (PortalException e) {
                    return handlePersistError(request, response, e);
                }
            }
        }
        return new ModelAndView("jsonView", Collections.singletonMap("response", resp));
    }
    // save the user's layout
    ulm.saveUserLayout();
    return new ModelAndView("jsonView", Collections.singletonMap("response", getMessage("error.finding.favorite", "Can''t find favorite", locale)));
}