1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
/* kldapclient.h - LDAP access
* Copyright (C) 2002 Klarlvdalens 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 <qobject.h>
#include <qstring.h>
#include <qcstring.h>
#include <qstringlist.h>
#include <qmemarray.h>
#include <qguardedptr.h>
#include <qtimer.h>
#include <kio/job.h>
namespace KABC {
class LdapClient;
typedef QValueList<QByteArray> LdapAttrValue;
typedef QMap<QString,LdapAttrValue > LdapAttrMap;
/**
* This class is internal. Binary compatibiliy might be broken any time
* without notification. Do not use it.
*
* We mean it!
*
*/
class KABC_EXPORT LdapObject
{
public:
LdapObject()
: dn( QString::null ), client( 0 ) {}
explicit LdapObject( const QString& _dn, LdapClient* _cl ) : dn( _dn ), client( _cl ) {}
LdapObject( const LdapObject& that ) { assign( that ); }
LdapObject& operator=( const LdapObject& that )
{
assign( that );
return *this;
}
QString toString() const;
void clear();
QString dn;
LdapAttrMap attrs;
LdapClient* client;
protected:
void assign( const LdapObject& that );
private:
//class LdapObjectPrivate* d;
};
/**
* This class is internal. Binary compatibiliy might be broken any time
* without notification. Do not use it.
*
* We mean it!
*
*/
class KABC_EXPORT LdapClient : public QObject
{
Q_OBJECT
public:
LdapClient( QObject* parent = 0, const char* name = 0 );
virtual ~LdapClient();
/*! returns true if there is a query running */
bool isActive() const { return mActive; }
signals:
/*! Emitted when the query is done */
void done();
/*! Emitted in case of error */
void error( const QString& );
/*! Emitted once for each object returned
* from the query
*/
void result( const KABC::LdapObject& );
public slots:
/*!
* Set the name or IP of the LDAP server
*/
void setHost( const QString& host );
QString host() const { return mHost; }
/*!
* Set the port of the LDAP server
* if using a nonstandard port
*/
void setPort( const QString& port );
QString port() const { return mPort; }
/*!
* Set the base DN
*/
void setBase( const QString& base );
QString base() const { return mBase; }
/*!
* Set the bind DN
*/
void setBindDN( const QString& bindDN );
QString bindDN() const;
/*!
* Set the bind password DN
*/
void setPwdBindDN( const QString& pwdBindDN );
QString pwdBindDN() const;
/*! Set the attributes that should be
* returned, or an empty list if
* all attributes are wanted
*/
void setAttrs( const QStringList& attrs );
QStringList attrs() const { return mAttrs; }
void setScope( const QString scope ) { mScope = scope; }
/*!
* Start the query with filter filter
*/
void startQuery( const QString& filter );
/*!
* Abort a running query
*/
void cancelQuery();
protected slots:
void slotData( KIO::Job*, const QByteArray &data );
void slotInfoMessage( KIO::Job*, const QString &info );
void slotDone();
protected:
void startParseLDIF();
void parseLDIF( const QByteArray& data );
void endParseLDIF();
QString mHost;
QString mPort;
QString mBase;
QString mScope;
QStringList mAttrs;
QGuardedPtr<KIO::SimpleJob> mJob;
bool mActive;
LdapObject mCurrentObject;
QCString mBuf;
QCString mLastAttrName;
QCString mLastAttrValue;
bool mIsBase64;
private:
class LdapClientPrivate;
LdapClientPrivate* d;
};
/**
* Structure describing one result returned by a LDAP query
*/
struct LdapResult {
QString name; ///< full name
QString email; ///< email
int clientNumber; ///< for sorting
};
typedef QValueList<LdapResult> LdapResultList;
/**
* This class is internal. Binary compatibiliy might be broken any time
* without notification. Do not use it.
*
* We mean it!
*
*/
class KABC_EXPORT LdapSearch : public QObject
{
Q_OBJECT
public:
LdapSearch();
void startSearch( const QString& txt );
void cancelSearch();
bool isAvailable() const;
signals:
/// Results, assembled as "Full Name <email>"
/// (This signal can be emitted many times)
void searchData( const QStringList& );
/// Another form for the results, with separate fields
/// (This signal can be emitted many times)
void searchData( const KABC::LdapResultList& );
void searchDone();
private slots:
void slotLDAPResult( const KABC::LdapObject& );
void slotLDAPError( const QString& );
void slotLDAPDone();
void slotDataTimer();
private:
void finish();
void makeSearchData( QStringList& ret, LdapResultList& resList );
QValueList< LdapClient* > mClients;
QString mSearchText;
QTimer mDataTimer;
int mActiveClients;
bool mNoLDAPLookup;
QValueList< LdapObject > mResults;
private:
class LdapSearchPrivate* d;
};
}
#endif // KABC_LDAPCLIENT_H
|