001/*
002 *  Copyright 2018 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.userdirectory.synchronize;
017
018import java.util.Collections;
019import java.util.List;
020import java.util.Map;
021
022import org.apache.avalon.framework.service.ServiceException;
023import org.apache.avalon.framework.service.ServiceManager;
024import org.apache.commons.collections4.MapUtils;
025import org.slf4j.Logger;
026
027import org.ametys.cms.repository.Content;
028import org.ametys.cms.repository.ModifiableDefaultContent;
029import org.ametys.core.user.UserManager;
030import org.ametys.plugins.contentio.synchronize.impl.SQLSynchronizableContentsCollection;
031import org.ametys.plugins.userdirectory.DeleteUserComponent;
032
033/**
034 * SQL synchronizable collection for users
035 */
036public class SQLSynchronizableUsersCollection extends SQLSynchronizableContentsCollection
037{
038    private static final String __PARAM_SQL_TABLE_LOGIN = "login";
039    private static final String __PARAM_POPULATION_ID = "populationId";
040    
041    /** The user SCC helper */
042    protected UserSCCHelper _userSCCHelper;
043
044    /** The user manager */
045    protected UserManager _userManager;
046    
047    /** The delete user component */
048    protected DeleteUserComponent _deleteUserComponent;
049    
050    @Override
051    public void service(ServiceManager smanager) throws ServiceException
052    {
053        super.service(smanager);
054        _userSCCHelper = (UserSCCHelper) smanager.lookup(UserSCCHelper.ROLE);
055        _userManager = (UserManager) smanager.lookup(UserManager.ROLE);
056        _deleteUserComponent = (DeleteUserComponent) smanager.lookup(DeleteUserComponent.ROLE);
057    }
058    
059    public boolean handleRightAssignmentContext()
060    {
061        return false;
062    }
063    
064    @Override
065    public String getIdField()
066    {
067        return UserSCCHelper.USER_UNIQUE_ID_METADATA_NAME;
068    }
069    
070    @Override
071    public Map<String, List<String>> getMapping()
072    {
073        Map<String, List<String>> mapping = super.getMapping();
074        mapping.put(getIdField(), Collections.singletonList(getLoginSQLColumnName()));
075        
076        return mapping;
077    }
078    
079    /**
080     * Get the login column name of user SQL table
081     * @return The login column name of user SQL table
082     */
083    public String getLoginSQLColumnName()
084    {
085        return (String) getParameterValues().get(__PARAM_SQL_TABLE_LOGIN);
086    }
087    
088    /**
089     * Get population Id
090     * @return The population Id
091     */
092    public String getPopulationId()
093    {
094        return (String) getParameterValues().get(__PARAM_POPULATION_ID);
095    }
096    
097    @Override
098    protected Map<String, Object> _getSearchParameters(Map<String, Object> parameters, int offset, int limit, List<Object> sort, List<String> columns)
099    {
100        // Add the sql column name for the login. 
101        String loginSQLColumn = getLoginSQLColumnName();
102        if (!columns.contains(loginSQLColumn))
103        {
104            columns.add(loginSQLColumn);
105        }
106        
107        return super._getSearchParameters(parameters, offset, limit, sort, columns);
108    }
109    
110    @Override
111    protected boolean _fillContent(Map<String, List<Object>> remoteValues, ModifiableDefaultContent content, boolean create, Logger logger)
112    {
113        boolean hasChanges = super._fillContent(remoteValues, content, create, logger);
114        
115        String newLogin = remoteValues.get(getIdField()).get(0).toString();
116        hasChanges = _userSCCHelper.synchronizeUserMetadata(newLogin, getPopulationId(), content, logger) || hasChanges;
117        
118        return hasChanges;
119    }
120    
121    
122    @Override
123    protected boolean _checkIdObjectValue(String remoteKey, Object idObjectValue, Logger logger)
124    {
125        if (!super._checkIdObjectValue(remoteKey, idObjectValue, logger))
126        {
127            return false;
128        }
129        
130        String login = idObjectValue.toString();
131        String population = getPopulationId();
132        if (_userManager.getUser(population, login) == null)
133        {
134            logger.warn("The user " + login + " don't belong to population " + population);
135            return false;
136        }
137        
138        return true;
139    }
140    
141    @Override
142    protected int _deleteContents(List<Content> contentsToRemove, Logger logger)
143    {
144        return _deleteUserComponent.deleteContentsWithLog(contentsToRemove, MapUtils.EMPTY_SORTED_MAP, MapUtils.EMPTY_SORTED_MAP, logger);
145    }
146}