com.silverpeas.accesscontrol.ComponentAccessController.java Source code

Introduction

Here is the source code for com.silverpeas.accesscontrol.ComponentAccessController.java

Source

/**
 * Copyright (C) 2000 - 2013 Silverpeas
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * As a special exception to the terms and conditions of version 3.0 of
 * the GPL, you may redistribute this Program in connection with Free/Libre
 * Open Source Software ("FLOSS") applications as described in Silverpeas's
 * FLOSS exception.  You should have received a copy of the text describing
 * the FLOSS exception, and it is also available here:
 * "http://www.silverpeas.org/docs/core/legal/floss_exception.html"
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.silverpeas.accesscontrol;

import com.silverpeas.util.CollectionUtil;
import com.silverpeas.util.ComponentHelper;
import com.silverpeas.util.StringUtil;
import com.stratelia.webactiv.SilverpeasRole;
import com.stratelia.webactiv.beans.admin.Admin;
import com.stratelia.webactiv.beans.admin.ComponentInst;
import org.apache.commons.collections.CollectionUtils;
import org.silverpeas.core.admin.OrganisationController;
import org.silverpeas.core.admin.OrganisationControllerFactory;

import javax.inject.Inject;
import javax.inject.Named;
import java.util.Set;

/**
 * It controls the access of a user to a given Silverpeas component. A Silverpeas component can be
 * either a Silverpeas application instance (like a KMelia instance for example) or a user
 * personal tool or an administrative tool.
 * @author ehugonnet
 */
@Named
public class ComponentAccessController extends AbstractAccessController<String> {

    @Inject
    private OrganisationController controller;

    public ComponentAccessController() {
    }

    /**
     * For tests only.
     * @param controller the controller to set for tests.
     */
    protected void setOrganizationController(final OrganisationController controller) {
        this.controller = controller;
    }

    /**
     * Indicates that the rights are set on node as well as the component.
     * @param componentId
     * @return
     */
    public boolean isRightOnTopicsEnabled(String componentId) {
        return isThemeTracker(componentId) && StringUtil.getBooleanValue(
                getOrganisationController().getComponentParameterValue(componentId, "rightsOnTopics"));
    }

    /**
     * Indicates that the rights are set on node as well as the component.
     * @param componentId
     * @return
     */
    public boolean isCoWritingEnabled(String componentId) {
        return isThemeTracker(componentId) && StringUtil
                .getBooleanValue(getOrganisationController().getComponentParameterValue(componentId, "coWriting"));
    }

    /**
     * Indicates that the rights are set on node as well as the component.
     * @param componentId
     * @return
     */
    public boolean isSharingEnabled(String componentId) {
        return isThemeTracker(componentId) && StringUtil.getBooleanValue(
                getOrganisationController().getComponentParameterValue(componentId, "useFileSharing"));
    }

    private boolean isThemeTracker(String componentId) {
        return ComponentHelper.getInstance().isThemeTracker(componentId);
    }

    @Override
    public boolean isUserAuthorized(String userId, String componentId, final AccessControlContext context) {
        return isUserAuthorized(getUserRoles(context, userId, componentId));
    }

    public boolean isUserAuthorized(Set<SilverpeasRole> componentUserRoles) {
        return CollectionUtil.isNotEmpty(componentUserRoles);
    }

    @Override
    protected void fillUserRoles(Set<SilverpeasRole> userRoles, AccessControlContext context, String userId,
            String componentId) {
        // Personal space or user tool
        if (componentId == null || getOrganisationController().isToolAvailable(componentId)) {
            userRoles.add(SilverpeasRole.admin);
            return;
        }
        if (Admin.ADMIN_COMPONENT_ID.equals(componentId)) {
            if (getOrganisationController().getUserDetail(userId).isAccessAdmin()) {
                userRoles.add(SilverpeasRole.admin);
            }
            return;
        }

        ComponentInst componentInst = getOrganisationController().getComponentInst(componentId);
        if (componentInst == null) {
            return;
        }

        if (componentInst.isPublic() || StringUtil.getBooleanValue(
                getOrganisationController().getComponentParameterValue(componentId, "publicFiles"))) {
            userRoles.add(SilverpeasRole.user);
            if (!CollectionUtils.containsAny(AccessControlOperation.PERSIST_ACTIONS, context.getOperations())
                    && !context.getOperations().contains(AccessControlOperation.download)) {
                // In that case, it is not necessary to check deeper the user rights
                return;
            }
        }

        if (getOrganisationController().isComponentAvailable(componentId, userId)) {
            Set<SilverpeasRole> roles = SilverpeasRole
                    .from(getOrganisationController().getUserProfiles(userId, componentId));
            // If component is available, but user has no rights -> public component
            if (roles.isEmpty()) {
                userRoles.add(SilverpeasRole.user);
            } else {
                userRoles.addAll(roles);
            }
        }
    }

    /**
     * Gets the organization controller used for performing its task.
     * @return an organization controller instance.
     */
    private OrganisationController getOrganisationController() {
        if (controller == null) {
            controller = OrganisationControllerFactory.getOrganisationController();
        }
        return controller;
    }
}