/* ======================================================================
The Bodington System Software License, Version 1.0
 
Copyright (c) 2001 The University of Leeds.  All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
 
2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
 
3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.
 
4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.
 
5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.
 
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
=========================================================
 
This software was originally created by the University of Leeds and may contain voluntary
contributions from others.  For more information on the Bodington Open Source Project, please
see http://bodington.org/
 
====================================================================== */
package org.bodington.server.resources;

import java.util.Enumeration;
import java.util.Vector;

import org.bodington.database.PrimaryKey;
import org.bodington.server.BuildingServerException;
import org.bodington.server.BuildingSessionManagerImpl;
import org.bodington.server.Quota;
import org.bodington.server.QuotaExceededException;
import org.bodington.server.QuotaFactory;
import org.bodington.server.QuotaMetadatum;
import org.bodington.server.UploadedFileSession;
import org.bodington.server.realm.Permission;

/**
 * Decorator that adds quotas to ResourceTree
 * @author buckett
 */
public class ResourceTreeQuota implements ResourceTree
{
    private ResourceTree resourceTree;
    
    public ResourceTreeQuota(ResourceTree resourceTree)
    {
        this.resourceTree = resourceTree;
    }
    

    public synchronized void addResource(Resource parent, Resource newresource)
        throws BuildingServerException
    {
        if ( parent != null )
        {
            QuotaMetadatum quota = QuotaFactory.getQuota(parent, QuotaFactory.RESOURCES);
            checkQuota(parent, quota, 1);
            resourceTree.addResource(parent, newresource);
            quota.adjustUsage(1);
        }
        else
        {
            resourceTree.addResource(parent, newresource);
        }

    }

    public int countDescendents(PrimaryKey resource_id)
        throws BuildingServerException
    {
        return resourceTree.countDescendents(resource_id);
    }

    public Resource findResource(String delimited_name)
        throws BuildingServerException
    {
        return resourceTree.findResource(delimited_name);
    }

    public Resource findResource(String[] names) throws BuildingServerException
    {
        return resourceTree.findResource(names);
    }

    public Resource findRootResource() throws BuildingServerException
    {
        return resourceTree.findRootResource();
    }

    public boolean isInside(Resource a, Resource b)
        throws BuildingServerException
    {
        return resourceTree.isInside(a, b);
    }

    public void loadResources() throws BuildingServerException
    {
        resourceTree.loadResources();
    }

    public synchronized void moveResource(Resource newparent, Resource resource)
        throws BuildingServerException
    {
        QuotaMetadatum sourceResQuota = QuotaFactory.getQuota(resource, QuotaFactory.RESOURCES);
        QuotaMetadatum destResQuota = QuotaFactory.getQuota(newparent, QuotaFactory.RESOURCES);
        QuotaMetadatum sourceFileQuota = QuotaFactory.getQuota(resource, QuotaFactory.FILES);
        QuotaMetadatum destFileQuota = QuotaFactory.getQuota(newparent, QuotaFactory.FILES);
        
        boolean ignoreResources = sourceResQuota.getResource().equals(destResQuota.getResource());
        boolean ignoreFiles = sourceFileQuota.getResource().equals(destFileQuota.getResource());
        
        if (destResQuota.hasQuota())
            if (!sourceResQuota.hasQuota())
                throw new BuildingServerException("You cannot move resources from an area without a resource quota to an area with one.");
        
        int extraResources = sumResourceQuota(resource);
        if (!ignoreResources)
            checkQuota(newparent, destResQuota, extraResources);

        synchronized (sourceFileQuota.getLock())
        {
            int extraFiles = sumFileQuota(resource);
            synchronized (destFileQuota.getLock())
            {
                
                if (!ignoreFiles)
                    checkQuota(newparent, destFileQuota, extraFiles);
                resourceTree.moveResource(newparent, resource);
                if (!ignoreResources)
                {
                    destResQuota.adjustUsage(extraResources);
                    sourceResQuota.adjustUsage(-extraResources);
                }
                if (!ignoreFiles)
                {
                    destFileQuota.adjustUsage(extraFiles);
                    sourceFileQuota.adjustUsage(-extraFiles);
                }
            }
            
        }
        
    }

    public void removeResource(Resource r) throws BuildingServerException
    {
        resourceTree.removeResource(r);
    }

    public void sortResources(Resource parent, Vector siblings)
        throws BuildingServerException
    {
        resourceTree.sortResources(parent, siblings);
    }

    public boolean isDeleted(Resource resource) throws BuildingServerException
    {
        return resourceTree.isDeleted(resource);
    }

    private void checkQuota(Resource parent, QuotaMetadatum quota, int increase) throws QuotaExceededException
    {
        if (!parent.checkPermission(Permission.SYSADMIN) && quota.hasQuota() && !(quota.getUsage() + increase <= quota.getQuota()))
            throw new QuotaExceededException(quota, increase);
    }
    
    /*
     * Walk down the tree looking at the resource included in this quota
     */
    private int sumResourceQuota(Resource resource) throws BuildingServerException
    {
        Quota quota = QuotaFactory.getQuota(resource, QuotaFactory.RESOURCES);
        if (resource.equals(quota.getResource())) return 0;
        int sum = 1;
        Enumeration children = resource.findChildren();
        while (children.hasMoreElements())
        {
            sum += sumResourceQuota((Resource)children.nextElement());
        }
        return sum;
    }
    
    
    private int sumFileQuota(Resource resource) throws BuildingServerException
    {
        Quota quota = QuotaFactory.getQuota(resource, QuotaFactory.RESOURCES);
        if (resource.equals(quota.getResource())) return 0;
        UploadedFileSession session = BuildingSessionManagerImpl.getSession(
            resource).getUploadedFileSession();
        UploadedFileSummary[] summaries = session
            .getFileAndDescendentSummaries((String) null, true);
        int sum = 0;
        for (int i = 0; i < summaries.length; i++)
        {
            sum += summaries[i].getSize();
        }
        Enumeration children = resource.findChildren();
        while (children.hasMoreElements())
        {
            sum += sumFileQuota((Resource)children.nextElement());
        }
        return sum;
        
    }
  
}
