AttachmentsTreeNode.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 org.xwiki.index.tree.internal.nestedpages;

import java.util.ArrayList;
import java.util.List;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Provider;

import org.xwiki.component.annotation.Component;
import org.xwiki.component.annotation.InstantiationStrategy;
import org.xwiki.component.descriptor.ComponentInstantiationStrategy;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.security.authorization.ContextualAuthorizationManager;
import org.xwiki.security.authorization.Right;

import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.doc.XWikiAttachment;
import com.xpn.xwiki.doc.XWikiDocument;

/**
 * The attachments tree node.
 * 
 * @version $Id: 71fb2a153faa4e70ac950d0b8ef93bbd38664742 $
 * @since 8.3M2
 * @since 7.4.5
 */
@Component
@Named("attachments")
@InstantiationStrategy(ComponentInstantiationStrategy.PER_LOOKUP)
public class AttachmentsTreeNode extends AbstractDocumentTreeNode
{
    @Inject
    private ContextualAuthorizationManager authorization;

    @Inject
    private Provider<XWikiContext> xcontextProvider;

    /**
     * Default constructor.
     */
    public AttachmentsTreeNode()
    {
        super("attachments");
    }

    @Override
    protected List<String> getChildren(DocumentReference documentReference, int offset, int limit) throws Exception
    {
        List<String> children = new ArrayList<String>();

        if (offset == 0 && showAddAttachment(documentReference)) {
            children.add("addAttachment:" + this.defaultEntityReferenceSerializer.serialize(documentReference));
        }

        XWikiContext xcontext = this.xcontextProvider.get();
        XWikiDocument document = xcontext.getWiki().getDocument(documentReference, xcontext);
        List<XWikiAttachment> attachments = document.getAttachmentList();
        for (XWikiAttachment attachment : subList(attachments, offset, limit)) {
            children.add(serialize(attachment.getReference()));
        }

        return children;
    }

    @Override
    protected int getChildCount(DocumentReference documentReference) throws Exception
    {
        int count = 0;

        if (showAddAttachment(documentReference)) {
            count++;
        }

        XWikiContext xcontext = this.xcontextProvider.get();
        XWikiDocument document = xcontext.getWiki().getDocument(documentReference, xcontext);
        count += document.getAttachmentList().size();

        return count;
    }

    private boolean showAddAttachment(DocumentReference documentReference)
    {
        return Boolean.TRUE.equals(getProperties().get("showAddAttachment"))
            && this.authorization.hasAccess(Right.EDIT, documentReference);
    }
}