/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
package com.netscape.jndi.ldap.schema;

import java.util.Vector;

import javax.naming.Name;
import javax.naming.NameNotFoundException;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.BasicAttribute;
import javax.naming.directory.BasicAttributes;
import javax.naming.directory.ModificationItem;

import netscape.ldap.LDAPConnection;
import netscape.ldap.LDAPMatchingRuleSchema;

public class SchemaMatchingRule extends SchemaElement {

    private static final String APPLIES = "APPLIES";

    LDAPMatchingRuleSchema m_ldapMatchingRule;

    // Attribute IDs that are exposed through Netscape LdapJDK
    private static String[] m_allAttrIds = {NUMERICOID, NAME, DESC, OBSOLETE, SYNTAX, APPLIES };

    LDAPConnection m_ld;

    public SchemaMatchingRule(LDAPMatchingRuleSchema ldapMatchingRule,  SchemaManager schemaManager) {
        super(schemaManager);
        m_ldapMatchingRule = ldapMatchingRule;
        m_path = ATTRDEF + "/" + m_ldapMatchingRule.getName();
    }

    public SchemaMatchingRule(Attributes attrs,  SchemaManager schemaManager) throws NamingException {
        super(schemaManager);
        m_ldapMatchingRule = parseDefAttributes(attrs);
        m_path = ATTRDEF + "/" + m_ldapMatchingRule.getName();
    }

    /**
     * Parse Definition Attributes for a LDAP matching rule
     */
    static LDAPMatchingRuleSchema parseDefAttributes(Attributes attrs) throws NamingException {
        String name=null, oid=null, desc=null, syntax=null;
        boolean obsolete = false;
        Vector applies = new Vector();

        for (NamingEnumeration<? extends Attribute> attrEnum = attrs.getAll(); attrEnum.hasMoreElements(); ) {
            Attribute attr = attrEnum.nextElement();
            String attrName = attr.getID();
            if (attrName.equals(NAME)) {
                name = getSchemaAttrValue(attr);
            }
            else if (attrName.equals(NUMERICOID)) {
                oid = getSchemaAttrValue(attr);
            }
            else if (attrName.equals(SYNTAX)) {
                syntax = getSchemaAttrValue(attr);
            }
            else if (attrName.equals(DESC)) {
                desc = getSchemaAttrValue(attr);
            }
            else if (attrName.equals(APPLIES)) {
                for (NamingEnumeration<?> valEnum = attr.getAll(); valEnum.hasMoreElements(); ) {
                    applies.addElement(valEnum.nextElement());
                }
            }
            else if (attrName.equals(OBSOLETE)) {
                obsolete = parseTrueFalseValue(attr);
            }
            else {
                throw new NamingException("Invalid schema attribute type for matching rule definition "    + attrName);
            }
        }

        LDAPMatchingRuleSchema mrule = new LDAPMatchingRuleSchema(name, oid, desc, vectorToStringAry(applies), syntax);

        if (obsolete) {
            mrule.setQualifier(OBSOLETE, "");
        }
        return mrule;
    }


    /**
     * Exctract specified attributes from the ldapMatchingRule
     */
    Attributes extractAttributeIds(String[] attrIds) throws NamingException{
        Attributes attrs = new BasicAttributes();
        String val = null;
        for (int i = 0; i < attrIds.length; i++) {
            if (attrIds[i].equals(NUMERICOID)) {
                val = m_ldapMatchingRule.getID();
                if (val != null) {
                    attrs.put(new BasicAttribute(NUMERICOID, val));
                }
            }
            else if (attrIds[i].equals(NAME)) {
                val = m_ldapMatchingRule.getName();
                if (val != null) {
                    attrs.put(new BasicAttribute(NAME, val));
                }
            }
            else if (attrIds[i].equals(DESC)) {
                val = m_ldapMatchingRule.getDescription();
                if (val != null) {
                    attrs.put(new BasicAttribute(DESC, val));
                }
            }
            else if (attrIds[i].equals(SYNTAX)) {
                val = m_ldapMatchingRule.getSyntaxString();
                if (val != null) {
                    attrs.put(new BasicAttribute(SYNTAX, val));
                }
            }
            else if (attrIds[i].equals(APPLIES)) {
                String[] appliesToAttrs = m_ldapMatchingRule.getAttributes();
                if (appliesToAttrs != null && appliesToAttrs.length > 0) {
                    BasicAttribute applies = new BasicAttribute(APPLIES);
                    for (int a=0; a < appliesToAttrs.length; a++) {
                        applies.add(appliesToAttrs[a]);
                    }
                    attrs.put(applies);
                }
            }
            else if (attrIds[i].equals(OBSOLETE)) {
                if (m_ldapMatchingRule.getQualifier(OBSOLETE)!= null) {
                    attrs.put(new BasicAttribute(OBSOLETE, "true"));
                }
            }

            else {
                throw new NamingException("Invalid schema attribute type for matching rule definition "    + attrIds[i]);
            }
        }
        return attrs;
    }


    /**
     * DirContext Attribute Operations
     */

    public Attributes getAttributes(String name) throws NamingException {
        if (name.length() != 0) { // no subcontexts
            throw new NameNotFoundException(name); // no such object
        }
        return extractAttributeIds(m_allAttrIds);
    }

    public Attributes getAttributes(String name, String[] attrIds) throws NamingException {
        if (name.length() != 0) { // no subcontexts
            throw new NameNotFoundException(name); // no such object
        }
        return extractAttributeIds(attrIds);
    }

    public Attributes getAttributes(Name name) throws NamingException {
        return getAttributes(name.toString());
    }

    public Attributes getAttributes(Name name, String[] attrIds) throws NamingException {
        return getAttributes(name.toString(), attrIds);
    }

    public void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException {
        if (name.length() != 0) { // no subcontexts
            throw new NameNotFoundException(name); // no such object
        }
        Attributes modAttrs = extractAttributeIds(m_allAttrIds);
        modifySchemaElementAttrs(modAttrs, mod_op, attrs);
        LDAPMatchingRuleSchema modLdapMatchingRule = parseDefAttributes(modAttrs);
        m_schemaMgr.modifyMatchingRule(m_ldapMatchingRule, modLdapMatchingRule);
        m_ldapMatchingRule = modLdapMatchingRule;
    }

    public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException {
        if (name.length() != 0) { // no subcontexts
            throw new NameNotFoundException(name); // no such object
        }
        Attributes modAttrs = extractAttributeIds(m_allAttrIds);
        modifySchemaElementAttrs(modAttrs, mods);
        LDAPMatchingRuleSchema modLdapMatchingRule = parseDefAttributes(modAttrs);
        m_schemaMgr.modifyMatchingRule(m_ldapMatchingRule, modLdapMatchingRule);
        m_ldapMatchingRule = modLdapMatchingRule;
    }

    public void modifyAttributes(Name name, int mod_op, Attributes attrs) throws NamingException {
        modifyAttributes(name.toString(), mod_op, attrs);
    }

    public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException {
        modifyAttributes(name.toString(), mods);
    }

    /**
     * Search operations are not implemented because of complexity. Ir will require
     * to implement the full LDAP search filter sematics in the client. (The search
     * filter sematics is implemented by the Directory server).
     */

}