001/*
002 *  Copyright 2025 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.pagesubscription;
017
018import java.time.Period;
019import java.time.ZonedDateTime;
020import java.util.Map;
021
022import org.apache.avalon.framework.service.ServiceException;
023import org.apache.avalon.framework.service.ServiceManager;
024import org.apache.avalon.framework.service.Serviceable;
025
026import org.ametys.core.trace.ForensicLogger;
027import org.ametys.core.user.UserIdentity;
028import org.ametys.core.user.population.UserPopulationDAO;
029import org.ametys.core.user.status.PersonalDataPolicy;
030import org.ametys.core.user.status.UserStatusInfo;
031import org.ametys.plugins.pagesubscription.type.SubscriptionType;
032import org.ametys.plugins.pagesubscription.type.SubscriptionTypeExtensionPoint;
033import org.ametys.plugins.repository.AmetysObjectIterable;
034import org.ametys.runtime.config.Config;
035import org.ametys.runtime.plugin.component.AbstractLogEnabled;
036import org.ametys.web.repository.site.Site;
037import org.ametys.web.repository.site.SiteManager;
038
039/**
040 * Remove subscription from unknown user
041 */
042public class SubscriptionDataPolicy extends AbstractLogEnabled implements PersonalDataPolicy, Serviceable
043{
044    /** The site manager */
045    protected SiteManager _siteManager;
046    /** The subscription type extension point */
047    protected SubscriptionTypeExtensionPoint _subscriptionTypeEP;
048    private Period _retentionPeriod;
049
050    public void service(ServiceManager manager) throws ServiceException
051    {
052        _siteManager = (SiteManager) manager.lookup(SiteManager.ROLE);
053        _subscriptionTypeEP = (SubscriptionTypeExtensionPoint) manager.lookup(SubscriptionTypeExtensionPoint.ROLE);
054        Long config = Config.getInstance().<Long>getValue("page-subscription.retention", false, null);
055        // disable the processing if config is negative
056        _retentionPeriod = config != null && config >= 0 ? Period.ofMonths(config.intValue()) : null;
057    }
058    
059    public AnonymizationResult process(UserStatusInfo userStatusInfo)
060    {
061        if (_retentionPeriod == null)
062        {
063            return AnonymizationResult.TOO_EARLY;
064        }
065        else if (userStatusInfo.getMissingSinceDate().isBefore(ZonedDateTime.now().minus(_retentionPeriod)))
066        {
067            UserIdentity userIdentity = userStatusInfo.getUserIdentity();
068            try (AmetysObjectIterable<Site> sites = _siteManager.getSites())
069            {
070                long deletedSubscriptions = 0;
071                for (Site site : sites)
072                {
073                    for (String typeId : _subscriptionTypeEP.getExtensionsIds())
074                    {
075                        SubscriptionType subscriptionType = _subscriptionTypeEP.getExtension(typeId);
076                        deletedSubscriptions += subscriptionType.unsubscribeAll(site, userIdentity);
077                    }
078                }
079                
080                if (deletedSubscriptions > 0)
081                {
082                    ForensicLogger.info("data.policy.gdpr.remove.page.subscriptions", Map.of("handled", Long.toString(deletedSubscriptions), "identity", userIdentity), UserPopulationDAO.SYSTEM_USER_IDENTITY);
083                    return AnonymizationResult.PROCESSED;
084                }
085                else
086                {
087                    return AnonymizationResult.NO_DATA;
088                }
089            }
090            catch (Exception e)
091            {
092                getLogger().error("An error prevented to remove all the subscription of the unknown user '" + userIdentity, e);
093                return AnonymizationResult.ERROR;
094            }
095        }
096        else
097        {
098            return AnonymizationResult.TOO_EARLY;
099        }
100    }
101}