cmsprincipalselectionlist.java

来自「找了很久才找到到源代码」· Java 代码 · 共 729 行 · 第 1/2 页

/*
 * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/commons/CmsPrincipalSelectionList.java,v $
 * Date   : $Date: 2007-09-10 13:11:03 $
 * Version: $Revision: 1.4 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) 2002 - 2007 Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library 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 library 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.
 *
 * For further information about Alkacon Software GmbH, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.workplace.commons;

import org.opencms.file.CmsGroup;
import org.opencms.file.CmsUser;
import org.opencms.i18n.CmsMessageContainer;
import org.opencms.jsp.CmsJspActionElement;
import org.opencms.main.CmsException;
import org.opencms.main.CmsRuntimeException;
import org.opencms.main.OpenCms;
import org.opencms.security.CmsAccessControlEntry;
import org.opencms.security.CmsOrganizationalUnit;
import org.opencms.security.CmsPrincipal;
import org.opencms.security.CmsRole;
import org.opencms.security.I_CmsPrincipal;
import org.opencms.workplace.list.A_CmsListDefaultJsAction;
import org.opencms.workplace.list.A_CmsListDialog;
import org.opencms.workplace.list.CmsListColumnAlignEnum;
import org.opencms.workplace.list.CmsListColumnDefinition;
import org.opencms.workplace.list.CmsListDefaultAction;
import org.opencms.workplace.list.CmsListDirectAction;
import org.opencms.workplace.list.CmsListIndependentAction;
import org.opencms.workplace.list.CmsListItem;
import org.opencms.workplace.list.CmsListItemDetails;
import org.opencms.workplace.list.CmsListItemDetailsFormatter;
import org.opencms.workplace.list.CmsListMetadata;
import org.opencms.workplace.list.CmsListOrderEnum;
import org.opencms.workplace.list.I_CmsListItemComparator;

import java.text.Collator;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Set;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.PageContext;

/**
 * Principal selection dialog.<p>
 * 
 * @author Michael Moossen  
 * 
 * @version $Revision: 1.4 $ 
 * 
 * @since 6.5.6 
 */
public class CmsPrincipalSelectionList extends A_CmsListDialog {

    /** list action id constant. */
    public static final String LIST_ACTION_ICON = "ai";

    /** list action id constant. */
    public static final String LIST_ACTION_SELECT = "js";

    /** list column id constant. */
    public static final String LIST_COLUMN_DESCRIPTION = "cd";

    /** list column id constant. */
    public static final String LIST_COLUMN_DISPLAY = "cdn";

    /** list column id constant. */
    public static final String LIST_COLUMN_ICON = "ci";

    /** list column id constant. */
    public static final String LIST_COLUMN_NAME = "cn";

    /** list column id constant. */
    public static final String LIST_COLUMN_ORGUNIT = "cou";

    /** list item detail id constant. */
    public static final String LIST_DETAIL_OTHEROU = "doo";

    /** list action id constant. */
    public static final String LIST_IACTION_GROUPS = "iag";

    /** list action id constant. */
    public static final String LIST_IACTION_USERS = "iau";

    /** list id constant. */
    public static final String LIST_ID = "lus";

    /** Path to the list buttons. */
    public static final String PATH_BUTTONS = "tools/accounts/buttons/";

    /** Item comparator to ensure that special principals go first. */
    private static final I_CmsListItemComparator LIST_ITEM_COMPARATOR = new I_CmsListItemComparator() {

        /**
         * @see org.opencms.workplace.list.I_CmsListItemComparator#getComparator(java.lang.String, java.util.Locale)
         */
        public Comparator getComparator(final String columnId, final Locale locale) {

            final Collator collator = Collator.getInstance(locale);
            final String overwriteAll = Messages.get().getBundle(locale).key(Messages.GUI_LABEL_OVERWRITEALL_0);
            final String allOthers = Messages.get().getBundle(locale).key(Messages.GUI_LABEL_ALLOTHERS_0);

            return new Comparator() {

                /**
                 * @see org.opencms.security.CmsAccessControlEntry#COMPARATOR_PRINCIPALS
                 * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
                 */
                public int compare(Object o1, Object o2) {

                    if ((o1 == o2) || !(o1 instanceof CmsListItem) || !(o2 instanceof CmsListItem)) {
                        return 0;
                    }
                    CmsListItem li1 = (CmsListItem)o1;
                    CmsListItem li2 = (CmsListItem)o2;

                    String id1 = (String)li1.get(LIST_COLUMN_DISPLAY);
                    String id2 = (String)li2.get(LIST_COLUMN_DISPLAY);
                    if (id1.equals(id2)) {
                        return 0;
                    } else if (id1.equals(overwriteAll)) {
                        return -1;
                    } else if (id1.equals(allOthers)) {
                        if (id2.equals(overwriteAll)) {
                            return 1;
                        } else {
                            return -1;
                        }
                    } else if (id2.equals(allOthers)) {
                        if (id1.equals(overwriteAll)) {
                            return -1;
                        } else {
                            return 1;
                        }
                    } else if (id2.equals(overwriteAll)) {
                        return 1;
                    }

                    Comparable c1 = (Comparable)li1.get(columnId);
                    Comparable c2 = (Comparable)li2.get(columnId);
                    if ((c1 instanceof String) && (c2 instanceof String)) {
                        return collator.compare(c1, c2);
                    } else if (c1 != null) {
                        if (c2 == null) {
                            return 1;
                        }
                        return c1.compareTo(c2);
                    } else if (c2 != null) {
                        return -1;
                    }
                    return 0;
                }
            };
        }

    };

    /** Cached value. */
    private Boolean m_hasPrincipalsInOtherOus;

    /** Stores the value of the request parameter for the flags. */
    private String m_paramFlags;

    /**
     * Public constructor.<p>
     * 
     * @param jsp an initialized JSP action element
     */
    public CmsPrincipalSelectionList(CmsJspActionElement jsp) {

        super(
            jsp,
            LIST_ID,
            Messages.get().container(Messages.GUI_PRINCIPALSELECTION_LIST_NAME_0),
            LIST_COLUMN_DISPLAY,
            CmsListOrderEnum.ORDER_ASCENDING,
            LIST_COLUMN_DISPLAY);
    }

    /**
     * Public constructor with JSP variables.<p>
     * 
     * @param context the JSP page context
     * @param req the JSP request
     * @param res the JSP response
     */
    public CmsPrincipalSelectionList(PageContext context, HttpServletRequest req, HttpServletResponse res) {

        this(new CmsJspActionElement(context, req, res));
    }

    /**
     * @see org.opencms.workplace.tools.CmsToolDialog#dialogTitle()
     */
    public String dialogTitle() {

        // build title
        StringBuffer html = new StringBuffer(512);
        html.append("<div class='screenTitle'>\n");
        html.append("\t<table width='100%' cellspacing='0'>\n");
        html.append("\t\t<tr>\n");
        html.append("\t\t\t<td>\n");
        if (getList().getMetadata().getIndependentAction(LIST_IACTION_USERS).isVisible()) {
            html.append(key(Messages.GUI_GROUPSELECTION_INTRO_TITLE_0));
            getList().setName(Messages.get().container(Messages.GUI_GROUPSELECTION_LIST_NAME_0));
            getList().getMetadata().getIndependentAction(LIST_DETAIL_OTHEROU);
        } else {
            html.append(key(Messages.GUI_USERSELECTION_INTRO_TITLE_1, new Object[] {""}));
            getList().setName(Messages.get().container(Messages.GUI_USERSELECTION_LIST_NAME_0));
        }
        html.append("\n\t\t\t</td>");
        html.append("\t\t</tr>\n");
        html.append("\t</table>\n");
        html.append("</div>\n");
        return html.toString();
    }

    /**
     * @see org.opencms.workplace.list.A_CmsListDialog#executeListIndepActions()
     */
    public void executeListIndepActions() {

        if (LIST_IACTION_USERS.equals(getParamListAction())) {
            getList().getMetadata().getIndependentAction(LIST_IACTION_USERS).setVisible(false);
            getList().getMetadata().getIndependentAction(LIST_IACTION_GROUPS).setVisible(true);
        } else if (LIST_IACTION_GROUPS.equals(getParamListAction())) {
            getList().getMetadata().getIndependentAction(LIST_IACTION_USERS).setVisible(true);
            getList().getMetadata().getIndependentAction(LIST_IACTION_GROUPS).setVisible(false);
        }
        super.executeListIndepActions();
    }

    /**
     * @see org.opencms.workplace.list.A_CmsListDialog#executeListMultiActions()
     */
    public void executeListMultiActions() throws CmsRuntimeException {

        throwListUnsupportedActionException();
    }

    /**
     * @see org.opencms.workplace.list.A_CmsListDialog#executeListSingleActions()
     */
    public void executeListSingleActions() throws CmsRuntimeException {

        throwListUnsupportedActionException();
    }

    /**
     * Returns the right icon path for the given list item.<p>
     * 
     * @param item the list item to get the icon path for
     * 
     * @return the icon path for the given role
     */
    public String getIconPath(CmsListItem item) {

        boolean showingUsers = isShowingUsers();
        try {
            CmsPrincipal principal;
            if (showingUsers) {
                principal = getCms().readUser((String)item.get(LIST_COLUMN_NAME));
            } else {
                principal = getCms().readGroup((String)item.get(LIST_COLUMN_NAME));
            }
            if (principal.getOuFqn().equals(getCms().getRequestContext().currentUser().getOuFqn())) {
                if (showingUsers) {
                    return PATH_BUTTONS + "user.png";
                } else {
                    return PATH_BUTTONS + "group.png";
                }
            } else {
                if (showingUsers) {
                    return PATH_BUTTONS + "user_other_ou.png";
                } else {
                    return PATH_BUTTONS + "group_other_ou.png";
                }
            }
        } catch (CmsException e) {
            if (item.get(LIST_COLUMN_DISPLAY).equals(key(Messages.GUI_LABEL_OVERWRITEALL_0))) {
                return "commons/" + CmsAccessControlEntry.PRINCIPAL_OVERWRITE_ALL_NAME.toLowerCase() + ".png";
            } else if (item.get(LIST_COLUMN_DISPLAY).equals(key(Messages.GUI_LABEL_ALLOTHERS_0))) {
                return "commons/" + CmsAccessControlEntry.PRINCIPAL_ALL_OTHERS_NAME.toLowerCase() + ".png";
            } else if (showingUsers) {
                return PATH_BUTTONS + "user.png";
            } else {
                return PATH_BUTTONS + "group.png";
            }
        }
    }

    /**
     * Returns the flags parameter value.<p>
     *
     * @return the flags parameter value
     */
    public String getParamFlags() {

        return m_paramFlags;
    }

    /**
     * Returns if the list of principals has principals of other organizational units.<p>
     * 
     * @return if the list of principals has principals of other organizational units
     */
    public boolean hasPrincipalsInOtherOus() {

        if (m_hasPrincipalsInOtherOus == null) {
            // lazzy initialization
            m_hasPrincipalsInOtherOus = Boolean.FALSE;
            try {
                Iterator itPrincipals = getPrincipals(true).iterator();
                while (itPrincipals.hasNext()) {
                    CmsPrincipal principal = (CmsPrincipal)itPrincipals.next();
                    if (!principal.getOuFqn().equals(getCms().getRequestContext().currentUser().getOuFqn())) {
                        m_hasPrincipalsInOtherOus = Boolean.TRUE;
                        break;
                    }
                }
            } catch (Exception e) {
                // ignore
            }
        }
        return m_hasPrincipalsInOtherOus.booleanValue();
    }

    /**
     * Checks if we are currently displaying users or groups.<p>
     * 
     * @return <code>true</code> if we are currently displaying users
     */
    public boolean isShowingUsers() {

        return getList().getMetadata().getIndependentAction(LIST_IACTION_GROUPS).isVisible();
    }