src/main/java/org/apache/directory/fortress/web/model/UserListModel.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */
package org.apache.directory.fortress.web.model;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.directory.fortress.core.util.Config;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.wicket.injection.Injector;
import org.apache.wicket.model.Model;
import org.apache.wicket.spring.injection.annot.SpringBean;
import org.apache.directory.fortress.web.panel.UserListPanel;
import org.apache.directory.fortress.core.DelReviewMgr;
import org.apache.directory.fortress.core.ReviewMgr;
import org.apache.directory.fortress.core.model.AdminRole;
import org.apache.directory.fortress.core.model.OrgUnit;
import org.apache.directory.fortress.core.model.Permission;
import org.apache.directory.fortress.core.model.Role;
import org.apache.directory.fortress.core.model.Session;
import org.apache.directory.fortress.core.model.User;
import org.apache.directory.fortress.core.SecurityException;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Set;

/**
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 * @version $Rev$
 */
public class UserListModel extends Model<SerializableList<User>>
{
    /** Default serialVersionUID */
    private static final long serialVersionUID = 1L;
    
    @SpringBean
    private ReviewMgr reviewMgr;
    @SpringBean
    private DelReviewMgr delReviewMgr;
    private static final Logger LOG = LoggerFactory.getLogger(UserListModel.class.getName());
    private User user;
    private Permission perm;
    private SerializableList<User> users = null;

    /**
     * Default constructor
     */
    public UserListModel( Session session )
    {
        init( session );
    }

    
    /**
     * User contains the search arguments.
     *
     * @param user
     */
    public UserListModel( User user, Session session )
    {
        this.user = user;
        init( session );
        LOG.debug( "constructor userId: " + user.getUserId() );
    }

    
    public UserListModel( Permission perm, Session session )
    {
        this.perm = perm;
        init( session );
        LOG.debug( "constructor perm: " + perm.getObjName() );
    }
    

    private void init( Session session )
    {
        Injector.get().inject( this );
        if (Config.getInstance().getBoolean(org.apache.directory.fortress.core.GlobalIds.IS_ARBAC02))
        {
            reviewMgr.setAdmin(session);
        }
    }
    

    /**
     * This data is bound for {@link UserListPanel}
     *
     * @return T extends List<User> users data will be bound to panel data view component.
     */
    @Override
    public SerializableList<User> getObject()
    {
        if (users != null)
        {
            LOG.debug( ".getObject count: " + users.size() );
            return users;
        }
        
        if ( ( user == null ) && ( perm == null  ))
        {
            LOG.debug( ".getObject null" );
        }
        else
        {
            //log.debug(".getObject userId: " + user != null ? user.getUserId() : "null");
            users = new SerializableList<>( getList( user ) );
        }
        // guard against NPE:
        if ( users == null )
            users = new SerializableList<>( new ArrayList<User>() );

        return users;
    }

    
    @Override
    public void setObject( SerializableList<User> object )
    {
        LOG.debug(".setObject count: " + object.size() );
        users = object;
    }
    

    @Override
    public void detach()
    {
        //log.debug(".detach");
        users = null;
        user = null;
    }
    

    public List<User> getList(User user)
    {
        List<User> usersList = null;
        
        try
        {
            if ( perm != null )
            {
                Set<String> users = reviewMgr.authorizedPermissionUsers( perm );
                
                if ( CollectionUtils.isNotEmpty( users ) )
                {
                    usersList = new ArrayList<>();
                    
                    for(String userId : users)
                    {
                        User user1 = reviewMgr.readUser( new User( userId ) );
                        usersList.add( user1 );
                    }
                }
            }
            else if( StringUtils.isNotEmpty( user.getOu() ) )
            {
                usersList = reviewMgr.findUsers( new OrgUnit( user.getOu(), OrgUnit.Type.USER ) );
            }
            else if ( CollectionUtils.isNotEmpty( user.getRoles() ) )
            {
                usersList = reviewMgr.assignedUsers( new Role( user.getRoles().get( 0 ).getName() ) );
            }
            else if ( CollectionUtils.isNotEmpty( user.getAdminRoles() ) )
            {
                usersList = delReviewMgr.assignedUsers( new AdminRole( user.getAdminRoles().get( 0 ).getName() ) );
            }
            else
            {
                usersList = reviewMgr.findUsers( user );
            }
            // sort list by userId:
            if( CollectionUtils.isNotEmpty( usersList ))
            {
                Collections.sort( usersList, new Comparator<User>()
                {
                    @Override
                    public int compare(User u1, User u2)
                    {
                        return u1.getUserId().compareToIgnoreCase( u2.getUserId() );
                    }
                } );
            }
        }
        catch ( SecurityException se )
        {
            String error = ".getList caught SecurityException=" + se;
            LOG.warn( error );
        }
        
        return usersList;
    }
}