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.webanalytics.matomo.tracking.impl;
017
018import java.util.HashMap;
019import java.util.List;
020import java.util.Map;
021import java.util.Optional;
022
023import org.apache.avalon.framework.service.ServiceException;
024import org.apache.avalon.framework.service.ServiceManager;
025import org.apache.avalon.framework.service.Serviceable;
026
027import org.ametys.cms.repository.Content;
028import org.ametys.cms.repository.ContentQueryHelper;
029import org.ametys.cms.repository.ReactionableObject;
030import org.ametys.cms.repository.ReactionableObject.ReactionType;
031import org.ametys.plugins.repository.AmetysObjectIterable;
032import org.ametys.plugins.repository.AmetysObjectResolver;
033import org.ametys.plugins.repository.query.expression.AndExpression;
034import org.ametys.plugins.repository.query.expression.BooleanExpression;
035import org.ametys.plugins.repository.query.expression.Expression;
036import org.ametys.plugins.repository.query.expression.Expression.Operator;
037import org.ametys.plugins.repository.query.expression.ExpressionContext;
038import org.ametys.plugins.repository.query.expression.StringExpression;
039import org.ametys.plugins.webanalytics.matomo.tracking.AbstractMatomoEventTrackingProvider;
040import org.ametys.web.repository.content.WebContent;
041import org.ametys.web.repository.page.Page;
042import org.ametys.web.repository.site.Site;
043
044/**
045 * The matomo tracking provider for the {@link Content} like
046 */
047public class LikeMatomoTrackingProvider extends AbstractMatomoEventTrackingProvider implements Serviceable
048{
049    /** The ametys object resolver */
050    protected AmetysObjectResolver _resolver;
051    
052    public void service(ServiceManager manager) throws ServiceException
053    {
054        _resolver = (AmetysObjectResolver) manager.lookup(AmetysObjectResolver.ROLE);
055    }
056
057    @Override
058    protected List<MatomoEvent> getEvents(Site site)
059    {
060        Map<Page, Integer> nbLikesByPage = new HashMap<>();
061
062        Expression likesExpr = new BooleanExpression("likes", true);
063        Expression siteExpr = new StringExpression("site", Operator.EQ, site.getName(), ExpressionContext.newInstance().withInternal(true));
064        Expression expr = new AndExpression(likesExpr, siteExpr);
065        
066        try (AmetysObjectIterable<Content> contents = _resolver.query(ContentQueryHelper.getContentXPathQuery(expr)))
067        {
068            for (Content content : contents)
069            {
070                if (content instanceof WebContent webContent && content instanceof ReactionableObject reactionableContent)
071                {
072                    // Take the first page because we do not want to count the number of like twice or more ...
073                    Optional<Page> page = webContent.getReferencingPages()
074                        .stream()
075                        .findFirst();
076                    if (page.isPresent())
077                    {
078                        nbLikesByPage.compute(page.get(), (k, v) -> 
079                            (v == null ? 0 : v) + _getNbLike(reactionableContent)
080                        );
081                    }
082                }
083            }
084        }
085        
086        return nbLikesByPage.keySet()
087                .stream()
088                .map(p -> new MatomoEvent(
089                        p.getSitemapName() + "/" + p.getPathInSitemap(), 
090                        nbLikesByPage.get(p)))
091                .toList();
092    }
093    
094    private int _getNbLike(ReactionableObject reactionableContent)
095    {
096        return reactionableContent.getReactionUsers(ReactionType.LIKE).size();
097    }
098}