cmsprincipal.java

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

/*
 * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/security/CmsPrincipal.java,v $
 * Date   : $Date: 2007-09-05 10:04:56 $
 * Version: $Revision: 1.5 $
 *
 * 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, 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.security;

import org.opencms.db.CmsDbEntryNotFoundException;
import org.opencms.file.CmsGroup;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsUser;
import org.opencms.main.CmsException;
import org.opencms.main.OpenCms;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;

import java.util.Iterator;
import java.util.List;
import java.util.Locale;

/**
 * Common methods shared among user and group principals, 
 * also contains several utility functions to deal with principal instances.<p>
 * 
 * @author Alexander Kandzior
 * 
 * @version $Revision: 1.5 $ 
 * 
 * @since 6.2.0 
 */
public abstract class CmsPrincipal implements I_CmsPrincipal, Comparable {

    /** The description of this principal. */
    protected String m_description;

    /** The flags of this principal. */
    protected int m_flags;

    /** The unique id of this principal. */
    protected CmsUUID m_id;

    /** The fully qualified name of this principal. */
    protected String m_name;

    /**
     * Empty constructor for subclassing.<p>
     */
    protected CmsPrincipal() {

        // empty constructor for subclassing
    }

    /**
     * Filters out all principals with flags greater than <code>{@link I_CmsPrincipal#FLAG_CORE_LIMIT}</code>.<p>
     * 
     * The given parameter list is directly modified, so the returned list is the same object as the input list.<p>
     * 
     * @param principals a list of <code>{@link CmsPrincipal}</code> objects
     * 
     * @return the filtered principal list
     */
    public static List filterCore(List principals) {

        Iterator it = principals.iterator();
        while (it.hasNext()) {
            CmsPrincipal p = (CmsPrincipal)it.next();
            if (p.getFlags() > I_CmsPrincipal.FLAG_CORE_LIMIT) {
                it.remove();
            }
        }
        return principals;
    }

    /**
     * Filters out all principals that do not have the given flag set,
     * but leaving principals with flags less than <code>{@link I_CmsPrincipal#FLAG_CORE_LIMIT}</code> untouched.<p>
     * 
     * The given parameter list is directly modified, so the returned list is the same object as the input list.<p>
     * 
     * @param principals a list of <code>{@link CmsPrincipal}</code> objects
     * @param flag the flag for filtering
     * 
     * @return the filtered principal list
     */
    public static List filterCoreFlag(List principals, int flag) {

        Iterator it = principals.iterator();
        while (it.hasNext()) {
            CmsPrincipal p = (CmsPrincipal)it.next();
            if ((p.getFlags() > I_CmsPrincipal.FLAG_CORE_LIMIT) && ((p.getFlags() & flag) != flag)) {
                it.remove();
            }
        }
        return principals;
    }

    /**
     * Filters out all principals that do not have the given flag set.<p>
     * 
     * The given parameter list is directly modified, so the returned list is the same object as the input list.<p>
     * 
     * @param principals the list of <code>{@link CmsPrincipal}</code> objects
     * @param flag the flag for filtering
     * 
     * @return the filtered principal list
     */
    public static List filterFlag(List principals, int flag) {

        Iterator it = principals.iterator();
        while (it.hasNext()) {
            CmsPrincipal p = (CmsPrincipal)it.next();
            if ((p.getFlags() & flag) != flag) {
                it.remove();
            }
        }
        return principals;
    }

    /**
     * Returns the provided group name prefixed with <code>{@link I_CmsPrincipal#PRINCIPAL_GROUP}.</code>.<p>
     * 
     * @param name the name to add the prefix to
     * @return the provided group name prefixed with <code>{@link I_CmsPrincipal#PRINCIPAL_GROUP}.</code>
     */
    public static String getPrefixedGroup(String name) {

        StringBuffer result = new StringBuffer(name.length() + 10);
        result.append(I_CmsPrincipal.PRINCIPAL_GROUP);
        result.append('.');
        result.append(name);
        return result.toString();
    }

    /**
     * Returns the provided user name prefixed with <code>{@link I_CmsPrincipal#PRINCIPAL_USER}.</code>.<p>
     * 
     * @param name the name to add the prefix to
     * @return the provided user name prefixed with <code>{@link I_CmsPrincipal#PRINCIPAL_USER}.</code>
     */
    public static String getPrefixedUser(String name) {

        StringBuffer result = new StringBuffer(name.length() + 10);
        result.append(I_CmsPrincipal.PRINCIPAL_USER);
        result.append('.');
        result.append(name);
        return result.toString();
    }

    /**
     * Utility function to read a prefixed principal from the OpenCms database using the 
     * provided OpenCms user context.<p>
     * 
     * The principal must be either prefixed with <code>{@link I_CmsPrincipal#PRINCIPAL_GROUP}.</code> or
     * <code>{@link I_CmsPrincipal#PRINCIPAL_USER}.</code>.<p>
     * 
     * @param cms the OpenCms user context to use when reading the principal
     * @param name the prefixed principal name
     * 
     * @return the principal read from the OpenCms database
     * 
     * @throws CmsException in case the principal could not be read
     */
    public static I_CmsPrincipal readPrefixedPrincipal(CmsObject cms, String name) throws CmsException {

        if (CmsStringUtil.isNotEmpty(name)) {
            String upperCaseName = name.toUpperCase();
            if (upperCaseName.startsWith(I_CmsPrincipal.PRINCIPAL_GROUP)) {
                // this principal is a group
                String groupName = name.substring(I_CmsPrincipal.PRINCIPAL_GROUP.length() + 1);
                return cms.readGroup(groupName);
            } else if (upperCaseName.startsWith(I_CmsPrincipal.PRINCIPAL_USER)) {
                // this principal is a user
                String userName = name.substring(I_CmsPrincipal.PRINCIPAL_USER.length() + 1);
                return cms.readUser(userName);
            }
        }
        // invalid principal name was given
        throw new CmsDbEntryNotFoundException(Messages.get().container(Messages.ERR_INVALID_PRINCIPAL_1, name));
    }

    /**
     * Utility function to read a principal by its id from the OpenCms database using the 
     * provided OpenCms user context.<p>
     * 
     * @param cms the OpenCms user context to use when reading the principal
     * @param id the id of the principal to read
     * 
     * @return the principal read from the OpenCms database
     * 
     * @throws CmsException in case the principal could not be read
     */
    public static I_CmsPrincipal readPrincipal(CmsObject cms, CmsUUID id) throws CmsException {

        try {
            // first try to read the principal as a user
            return cms.readUser(id);
        } catch (CmsException exc) {
            // assume user does not exist
        }
        try {
            // now try to read the principal as a group
            return cms.readGroup(id);
        } catch (CmsException exc) {
            //  assume group does not exist
        }
        // invalid principal name was given
        throw new CmsDbEntryNotFoundException(Messages.get().container(Messages.ERR_INVALID_PRINCIPAL_1, id));
    }

    /**
     * Utility function to read a principal of the given type from the OpenCms database using the 
     * provided OpenCms user context.<p>
     * 
     * The type must either be <code>{@link I_CmsPrincipal#PRINCIPAL_GROUP}</code> or
     * <code>{@link I_CmsPrincipal#PRINCIPAL_USER}</code>.<p>
     * 
     * @param cms the OpenCms user context to use when reading the principal
     * @param type the principal type 
     * @param name the principal name