RefererStatsStoreItem.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.xpn.xwiki.stats.impl.xwiki;

import java.util.Date;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.stats.impl.RefererStats;
import com.xpn.xwiki.stats.impl.StatsUtil.PeriodType;
import com.xpn.xwiki.store.XWikiHibernateStore;

/**
 * Store referer statistics into the database.
 *
 * @version $Id: 0c74cb73a41dd81281de01ab4c31e2353cc16f82 $
 * @since 1.4M2
 */
public class RefererStatsStoreItem extends AbstractStatsStoreItem
{
    /**
     * Logging tools.
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(RefererStatsStoreItem.class);

    /**
     * The referer.
     */
    private String referer;

    /**
     * Create new instance of {@link RefererStatsStoreItem}.
     *
     * @param name the full name of the document.
     * @param periodDate the period date.
     * @param periodType the period type.
     * @param referer the referer.
     * @param context the XWiki context.
     */
    public RefererStatsStoreItem(String name, Date periodDate, PeriodType periodType, String referer,
        XWikiContext context)
    {
        super(name, periodDate, periodType, context);

        this.referer = referer;
    }

    @Override
    public String getId()
    {
        return String.format("%s %s %s %s", getClass(), this.name, this.referer, this.period);
    }

    @Override
    public void storeInternal(List<XWikiStatsStoreItem> stats)
    {
        RefererStatsStoreItem lastItem = (RefererStatsStoreItem) stats.get(stats.size() - 1);

        XWikiHibernateStore store = this.context.getWiki().getHibernateStore();
        if (store == null) {
            return;
        }

        RefererStats refererStat =
            new RefererStats(lastItem.name, lastItem.referer, lastItem.periodDate, lastItem.periodType);

        // Load old statistics object from database
        try {
            // TODO Fix use of deprecated call.
            store.loadXWikiCollection(refererStat, this.context, true);
        } catch (XWikiException e) {
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("Failed to load referer statictics object [" + getId() + "]");
            }
        }

        // Increment counters
        refererStat.setIntValue("pageViews", refererStat.getPageViews() + stats.size());

        // Re-save statistics object
        try {
            // TODO Fix use of deprecated call.
            store.saveXWikiCollection(refererStat, this.context, true);
        } catch (XWikiException e) {
            LOGGER.error("Failed to save referer statictics object [" + getId() + "]");
        }
    }
}