001/*
002 *  Copyright 2010 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.web.robots;
017
018import org.apache.avalon.framework.service.ServiceException;
019import org.apache.avalon.framework.service.ServiceManager;
020import org.apache.cocoon.generation.ServiceableGenerator;
021
022import org.ametys.core.right.RightManager;
023import org.ametys.web.repository.page.SitemapElement;
024import org.ametys.web.repository.site.Site;
025import org.ametys.web.repository.site.SiteManager;
026
027/**
028 * Abstract base class for generators dealing with robots
029 */
030public abstract class AbstractRobotsGenerator extends ServiceableGenerator
031{
032    private SiteManager _siteManager;
033    private RightManager _rightManager;
034
035    @Override
036    public void service(ServiceManager smanager) throws ServiceException
037    {
038        super.service(manager);
039        _siteManager = (SiteManager) smanager.lookup(SiteManager.ROLE);
040        _rightManager = (RightManager) smanager.lookup(RightManager.ROLE);
041    }
042    
043    /**
044     * Get site
045     * @param siteName teh site name
046     * @return the site
047     */
048    public Site getSite (String siteName)
049    {
050        return _siteManager.getSite(siteName);
051    }
052    
053    /**
054     * Determines if the page or sitemap has a restricted access
055     * @param pageOrSitemap thepage or sitemap
056     * @return true if the page or sitemap has a restricted access
057     */
058    protected boolean hasRestrictedAccess(SitemapElement pageOrSitemap)
059    {
060        return !_rightManager.hasAnonymousReadAccess(pageOrSitemap);
061    }
062
063}