ldif.h

/*
  This file is part of libkldap.
  Copyright (c) 2004-2006 Szombathelyi György <gyurco@freemail.hu>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General  Public
  License as published by the Free Software Foundation; either
  version 2 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
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef KLDAP_LDIF_H
#define KLDAP_LDIF_H

#include <QtCore/QString>
#include <QtCore/QByteArray>

#include "ldapdn.h"
#include "kldap_export.h"

namespace KLDAP {

class KLDAP_EXPORT Ldif
{
  public:

    typedef enum {
      None, NewEntry, EndEntry, Item, Control, Err, MoreData
    } ParseValue;

    typedef enum {
      Entry_None, Entry_Add, Entry_Del, Entry_Mod, Entry_Modrdn
    } EntryType;

    typedef enum {
      Mod_None, Mod_Add, Mod_Replace, Mod_Del
    } ModType;

    Ldif();

    Ldif( const Ldif &that );
    Ldif &operator=( const Ldif &that );

    virtual ~Ldif();

    static QByteArray assembleLine( const QString &fieldname,
                                    const QByteArray &value, uint linelen=0,
                                    bool url=false );
    static QByteArray assembleLine( const QString &fieldname,
                                    const QString &value, uint linelen=0,
                                    bool url=false );

    static bool splitLine( const QByteArray &line, QString &fieldname,
                           QByteArray &value );

    static bool splitControl( const QByteArray &line, QString &oid,
                              bool &critical, QByteArray &value );

    void startParsing();

    ParseValue processLine();

    ParseValue nextItem();

    void setLdif( const QByteArray &ldif );

    void endLdif();

    EntryType entryType() const;

    int modType() const;

    LdapDN dn() const;

    QString newRdn() const;

    QString newSuperior() const;

    bool delOldRdn() const;

    QString attr() const;

    QByteArray value() const;

    bool isUrl() const;

    bool isCritical() const;

    QString oid() const;

    uint lineNumber() const;

  private:
    class LdifPrivate;
    LdifPrivate *const d;
};

}

#endif