ldapclient.h

/* kldapclient.h - LDAP access
 *      Copyright (C) 2002 Klarälvdalens Datakonsult AB
 *
 *      Author: Steffen Hansen <hansen@kde.org>
 *
 * This file 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 2 of the License, or
 * (at your option) any later version.
 *
 * This file 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
 
#ifndef KABC_LDAPCLIENT_H
#define KABC_LDAPCLIENT_H
 
 
#include <tqobject.h>
#include <tqstring.h>
#include <tqcstring.h>
#include <tqstringlist.h>
#include <tqmemarray.h>
#include <tqguardedptr.h>
#include <tqtimer.h>
 
#include <tdeio/job.h>
 
namespace TDEABC {
 
class LdapClient;
typedef TQValueList<TQByteArray> LdapAttrValue;
typedef TQMap<TQString,LdapAttrValue > LdapAttrMap;
 
class KABC_EXPORT LdapObject
{
  public:
    LdapObject()
      : dn( TQString::null ), client( 0 ) {}
    explicit LdapObject( const TQString& _dn, LdapClient* _cl ) : dn( _dn ), client( _cl ) {}
    LdapObject( const LdapObject& that ) { assign( that ); }
 
    LdapObject& operator=( const LdapObject& that )
    {
      assign( that );
      return *this;
    }
 
    TQString toString() const;
 
    void clear();
 
    TQString dn;
    LdapAttrMap attrs;
    LdapClient* client;
 
  protected:
    void assign( const LdapObject& that );
 
  private:
    //class LdapObjectPrivate* d;
};
 
class KABC_EXPORT LdapClient : public TQObject
{
  TQ_OBJECT
 
  public:
    LdapClient( TQObject* parent = 0, const char* name = 0 );
    virtual ~LdapClient();
 
    bool isActive() const { return mActive; }
 
  signals:
    void done();
 
    void error( const TQString& );
 
    void result( const TDEABC::LdapObject& );
 
  public slots:
    void setHost( const TQString& host );
    TQString host() const { return mHost; }
 
    void setPort( const TQString& port );
    TQString port() const { return mPort; }
 
    void setBase( const TQString& base );
    TQString base() const { return mBase; }
 
    void setBindDN( const TQString& bindDN );
    TQString bindDN() const;
 
    void setPwdBindDN( const TQString& pwdBindDN );
    TQString pwdBindDN() const;
 
    void setAttrs( const TQStringList& attrs );
    TQStringList attrs() const { return mAttrs; }
 
    void setScope( const TQString scope ) { mScope = scope; }
 
    void startQuery( const TQString& filter );
 
    void cancelQuery();
 
  protected slots:
    void slotData( TDEIO::Job*, const TQByteArray &data );
    void slotInfoMessage( TDEIO::Job*, const TQString &info );
    void slotDone();
 
  protected:
    void startParseLDIF();
    void parseLDIF( const TQByteArray& data );
    void endParseLDIF();
 
    TQString mHost;
    TQString mPort;
    TQString mBase;
    TQString mScope;
    TQStringList mAttrs;
 
    TQGuardedPtr<TDEIO::SimpleJob> mJob;
    bool mActive;
 
    LdapObject mCurrentObject;
    TQCString mBuf;
    TQCString mLastAttrName;
    TQCString mLastAttrValue;
    bool mIsBase64;
 
  private:
    class LdapClientPrivate;
    LdapClientPrivate* d;
};
 
struct LdapResult {
  TQString name;     
  TQString email;    
  int clientNumber; 
};
typedef TQValueList<LdapResult> LdapResultList;
 
 
class KABC_EXPORT LdapSearch : public TQObject
{
  TQ_OBJECT
 
  public:
    LdapSearch();
 
    void startSearch( const TQString& txt );
    void cancelSearch();
    bool isAvailable() const;
 
  signals:
    void searchData( const TQStringList& );
    void searchData( const TDEABC::LdapResultList& );
    void searchDone();
 
  private slots:
    void slotLDAPResult( const TDEABC::LdapObject& );
    void slotLDAPError( const TQString& );
    void slotLDAPDone();
    void slotDataTimer();
 
  private:
    void finish();
    void makeSearchData( TQStringList& ret, LdapResultList& resList );
    TQValueList< LdapClient* > mClients;
    TQString mSearchText;
    TQTimer mDataTimer;
    int mActiveClients;
    bool mNoLDAPLookup;
    TQValueList< LdapObject > mResults;
 
  private:
    class LdapSearchPrivate* d;
};
 
}
#endif // KABC_LDAPCLIENT_H