net.sourceforge.openutils.mgnlmedia.media.tree.MediaModuleTree Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openutils-mgnlmedia Show documentation

Magnolia SimpleMedia Module: a module for Magnolia CMS for easier management multimedia assets.

There is a newer version: 5.0.10

/**
 *
 * SimpleMedia Module for Magnolia CMS (http://www.openmindlab.com/lab/products/media.html)
 * Copyright(C) 2008-2012, Openmind S.r.l. http://www.openmindonline.it
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 */

package net.sourceforge.openutils.mgnlmedia.media.tree;

import info.magnolia.cms.core.Content;
import info.magnolia.cms.core.NodeData;
import info.magnolia.cms.gui.control.Hidden;
import info.magnolia.cms.gui.control.Tree;
import info.magnolia.cms.gui.control.TreeColumn;
import info.magnolia.cms.util.NodeDataUtil;
import info.magnolia.freemarker.FreemarkerUtil;

import java.util.Map;

import javax.jcr.RepositoryException;
import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.lang.StringUtils;


/**
 * The tree for media folders browsing
 * @author molaschi
 * @version $Id: MediaModuleTree.java 3752 2012-03-10 09:00:25Z fgiust $
 */
public class MediaModuleTree extends Tree
{

    /**
     * @param name
     * @param repository
     */
    public MediaModuleTree(String name, String repository)
    {
        super(name, repository);
        // TODO Auto-generated constructor stub
    }

    /**
     * @param repository
     * @param request
     * @deprecated
     */
    @Deprecated
    public MediaModuleTree(String repository, HttpServletRequest request)
    {
        super(repository, request);
        // TODO Auto-generated constructor stub
    }

    /**
     * @param name
     * @param repository
     * @param request
     * @deprecated
     */
    @Deprecated
    public MediaModuleTree(String name, String repository, HttpServletRequest request)
    {
        super(name, repository, request);
        // TODO Auto-generated constructor stub
    }

    /**
     * {@inheritDoc}
     */
    @SuppressWarnings("unchecked")
    @Override
    public String getHtmlFooter()
    {
        StringBuffer html = new StringBuffer();
        html.append("

"); //$NON-NLS-1$

        Map params = populateTemplateParameters();

        params.put("selectMedia", this.getRequest().getParameter("selectMedia") != null);

        // include the tree footer / menu divs
        html.append(FreemarkerUtil.process("net/sourceforge/openutils/mgnlmedia/controls/MediaTreeFooter.ftl", params));

        return html.toString();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void getHtmlOfSingleItem(StringBuffer html, Content parentNode, String itemType, Object item)
        throws RepositoryException
    {
        Content c = null;
        NodeData d = null;
        String handle;
        String name;
        boolean hasSub = false;
        boolean showSub = false;
        boolean isActivated = false;
        boolean permissionWrite = false;
        boolean permissionWriteParent = false;
        if (itemType.equals(ITEM_TYPE_NODEDATA))
        {
            d = (NodeData) item;
            handle = d.getHandle();
            name = d.getName();

            if (d.isGranted(info.magnolia.cms.security.Permission.WRITE))
            {
                permissionWrite = true;
            }
        }
        else
        {
            c = (Content) item;

            handle = c.getHandle();
            if (this.getColumns().size() == 0)
            {
                name = c.getName();
            }
            else
            {
                this.getColumns(0).setWebsiteNode(c);
                name = this.getColumns(0).getHtml();
            }
            if (c.isGranted(info.magnolia.cms.security.Permission.WRITE))
            {
                permissionWrite = true;
            }
            if (c.getAncestor(c.getLevel() - 1).isGranted(info.magnolia.cms.security.Permission.WRITE))
            {
                permissionWriteParent = true;
            }
            isActivated = c.getMetaData().getIsActivated();
            for (int i = 0; i < this.getItemTypes().size(); i++)
            {
                String type = (String) this.getItemTypes().get(i);

                hasSub = hasSub(c, type);

                if (hasSub)
                {
                    if (this.getPathOpen() != null
                        && (this.getPathOpen().indexOf(handle + "/") == 0 || this.getPathOpen().equals(handle)))
                    {
                        showSub = true;
                    }
                    break;
                }
            }
        }

        // get next if this node is not shown
        if (!showNode(c, d, itemType))
        {
            return;
        }

        String icon = getIcon(c, d, itemType);

        String idPre = this.getJavascriptTree() + "_" + handle; //$NON-NLS-1$
        String jsHighlightNode = this.getJavascriptTree() + ".nodeHighlight(this,'" //$NON-NLS-1$
            + handle
            + "'," //$NON-NLS-1$
            + Boolean.toString(permissionWrite)
            + ");"; //$NON-NLS-1$
        String jsResetNode = this.getJavascriptTree() + ".nodeReset(this,'" + handle + "');"; //$NON-NLS-1$ //$NON-NLS-2$
        String jsSelectNode = this.getJavascriptTree() + ".selectNode('" //$NON-NLS-1$
            + handle
            + "'," //$NON-NLS-1$
            + Boolean.toString(permissionWrite)
            + ",'" //$NON-NLS-1$
            + itemType
            + "');"; //$NON-NLS-1$
        String jsExpandNode;
        if (this.getDrawShifter())
        {
            jsExpandNode = this.getJavascriptTree() + ".expandNode('" + handle + "');"; //$NON-NLS-1$ //$NON-NLS-2$
        }
        else
        {
            jsExpandNode = jsSelectNode;
        }
        String jsHighlightLine = this.getJavascriptTree() + ".moveNodeHighlightLine('" + idPre + "_LineInter');"; //$NON-NLS-1$ //$NON-NLS-2$
        String jsResetLine = this.getJavascriptTree() + ".moveNodeResetLine('" + idPre + "_LineInter');"; //$NON-NLS-1$ //$NON-NLS-2$

        // lineInter: line between nodes, to allow set cursor between nodes
        // try to avoid blank images, setting js actions on divs should be ok
        if (permissionWriteParent)
        {
            html.append("");
        }
        else
        {
            html.append("");
        }

        html.append("");
        html.append(" "); // do not remove! //$NON-NLS-1$

        html.append("");
        if (this.getDrawShifter())
        {
            String shifter = StringUtils.EMPTY;
            if (hasSub)
            {
                if (showSub)
                {
                    if (this.getShifterCollapse() != null)
                    {
                        shifter = this.getShifterCollapse();
                    }
                }
                else
                {
                    if (this.getShifterExpand() != null)
                    {
                        shifter = this.getShifterExpand();
                    }
                }
            }
            else
            {
                if (this.getShifterEmpty() != null)
                {
                    shifter = this.getShifterEmpty();
                }
            }
            if (StringUtils.isNotEmpty(shifter))
            {
                html.append("");
            }
        }
        html.append("");
        if (StringUtils.isNotEmpty(icon))
        {
            html.append(""); //$NON-NLS-1$
        }
        String dblclick = StringUtils.EMPTY;
        String htmlEdit = this.getColumns(0).getHtmlEdit();
        if (permissionWrite && StringUtils.isNotEmpty(htmlEdit) && !this.isBrowseMode())
        // && this.getRequest().getParameter("selectMedia") == null)
        {
            dblclick = " ondblclick=\"" + this.getJavascriptTree() + ".editNodeData(this,'" + handle + "',0,'" + htmlEdit.replace("\"", """) + "');\""; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
        }
        html.append("");
        html.append(name);
        html.append(""); //$NON-NLS-1$

        // this is done because js is not executed when you get it with ajax
        html.append(new Hidden(idPre + "_PermissionWrite", Boolean.toString(permissionWrite), false).getHtml()); //$NON-NLS-1$
        html.append(new Hidden(idPre + "_ItemType", itemType, false).getHtml()); //$NON-NLS-1$
        html.append(new Hidden(idPre + "_IsActivated", Boolean.toString(isActivated), false).getHtml()); //$NON-NLS-1$

        // Put your own stuff here. Good luck!
        onGetHtmlOfSingleItem(html, parentNode, itemType, item, idPre);

        for (int i = 1; i < this.getColumns().size(); i++)
        {
            String str = StringUtils.EMPTY;
            TreeColumn tc = this.getColumns(i);
            if (!itemType.equals(ITEM_TYPE_NODEDATA))
            {
                // content node ItemType.NT_CONTENTNODE and ItemType.NT_CONTENT
                if (!tc.getIsNodeDataType() && !tc.getIsNodeDataValue())
                {
                    tc.setWebsiteNode(c);
                    tc.setId(handle);
                    str = tc.getHtml();
                }
            }
            else
            {
                if (tc.getIsNodeDataType())
                {
                    str = NodeDataUtil.getTypeName(d);
                }
                else if (tc.getIsNodeDataValue())
                {
                    final String stringValue = NodeDataUtil.getValueString(d);
                    str = StringEscapeUtils.escapeXml(stringValue);
                }
                if (StringUtils.isEmpty(str))
                {
                    str = TreeColumn.EMPTY;
                }
                tc.setName(name); // workaround, will be passed to js TreeColumn object
            }
            tc.setEvent("onmouseover", jsHighlightNode, true); //$NON-NLS-1$
            tc.setEvent("onmouseout", jsResetNode, true); //$NON-NLS-1$
            tc.setEvent("onmousedown", jsSelectNode, true); //$NON-NLS-1$
            html.append("");
            html.append(str);
            html.append("");
        }
        html.append(""); //$NON-NLS-1$
        String display = "none"; //$NON-NLS-1$
        if (showSub)
        {
            display = "block"; //$NON-NLS-1$
        }
        html.append("");
        if (hasSub)
        {
            if (showSub)
            {
                String pathRemaining = this.getPathOpen().substring(this.getPathCurrent().length());
                if (pathRemaining.length() > 0)
                {
                    // get rid of first slash (/people/franz -> people/franz)
                    String slash = "/"; //$NON-NLS-1$
                    if (this.getPathCurrent().equals("/"))
                    {
                        // first slash already removed
                        slash = StringUtils.EMPTY; // no slash needed between pathCurrent and nextChunk
                    }
                    else
                    {
                        pathRemaining = pathRemaining.substring(1);
                    }
                    String nextChunk = StringUtils.substringBefore(pathRemaining, "/"); //$NON-NLS-1$

                    String pathNext = this.getPathCurrent() + slash + nextChunk;
                    this.setPathCurrent(pathNext);
                    html.append(this.getHtmlChildren());
                }
            }
        }
        html.append("\n"); //$NON-NLS-1$
    }

}