summaryrefslogtreecommitdiffstats
path: root/libtdepim/ldapsearchdialog.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'libtdepim/ldapsearchdialog.cpp')
-rw-r--r--libtdepim/ldapsearchdialog.cpp480
1 files changed, 480 insertions, 0 deletions
diff --git a/libtdepim/ldapsearchdialog.cpp b/libtdepim/ldapsearchdialog.cpp
new file mode 100644
index 00000000..ed1aa293
--- /dev/null
+++ b/libtdepim/ldapsearchdialog.cpp
@@ -0,0 +1,480 @@
+/* ldapsearchdialogimpl.cpp - LDAP access
+ * Copyright (C) 2002 Klar�vdalens 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
+ */
+
+#include "ldapsearchdialog.h"
+#include "ldapclient.h"
+
+#include <libemailfunctions/email.h>
+
+#include <tqcheckbox.h>
+#include <tqgroupbox.h>
+#include <tqheader.h>
+#include <tqlabel.h>
+#include <tqlayout.h>
+#include <tqlistview.h>
+#include <tqpushbutton.h>
+
+#include <kabc/addresslineedit.h>
+#include <kapplication.h>
+#include <kcombobox.h>
+#include <kconfig.h>
+#include <klineedit.h>
+#include <klocale.h>
+#include <kmessagebox.h>
+
+using namespace KPIM;
+
+static TQString asUtf8( const TQByteArray &val )
+{
+ if ( val.isEmpty() )
+ return TQString();
+
+ const char *data = val.data();
+
+ //TQString::fromUtf8() bug workaround
+ if ( data[ val.size() - 1 ] == '\0' )
+ return TQString::fromUtf8( data, val.size() - 1 );
+ else
+ return TQString::fromUtf8( data, val.size() );
+}
+
+static TQString join( const KPIM::LdapAttrValue& lst, const TQString& sep )
+{
+ TQString res;
+ bool alredy = false;
+ for ( KPIM::LdapAttrValue::ConstIterator it = lst.begin(); it != lst.end(); ++it ) {
+ if ( alredy )
+ res += sep;
+ alredy = TRUE;
+ res += asUtf8( *it );
+ }
+ return res;
+}
+
+static TQMap<TQString, TQString>& adrbookattr2ldap()
+{
+ static TQMap<TQString, TQString> keys;
+
+ if ( keys.isEmpty() ) {
+ keys[ i18n( "Title" ) ] = "title";
+ keys[ i18n( "Full Name" ) ] = "cn";
+ keys[ i18n( "Email" ) ] = "mail";
+ keys[ i18n( "Home Number" ) ] = "homePhone";
+ keys[ i18n( "Work Number" ) ] = "telephoneNumber";
+ keys[ i18n( "Mobile Number" ) ] = "mobile";
+ keys[ i18n( "Fax Number" ) ] = "facsimileTelephoneNumber";
+ keys[ i18n( "Pager" ) ] = "pager";
+ keys[ i18n( "Street") ] = "street";
+ keys[ i18n( "State" ) ] = "st";
+ keys[ i18n( "Country" ) ] = "co";
+ keys[ i18n( "City" ) ] = "l";
+ keys[ i18n( "Organization" ) ] = "o";
+ keys[ i18n( "Company" ) ] = "Company";
+ keys[ i18n( "Department" ) ] = "department";
+ keys[ i18n( "Zip Code" ) ] = "postalCode";
+ keys[ i18n( "Postal Address" ) ] = "postalAddress";
+ keys[ i18n( "Description" ) ] = "description";
+ keys[ i18n( "User ID" ) ] = "uid";
+ }
+ return keys;
+}
+
+namespace KPIM {
+
+class ContactListItem : public TQListViewItem
+{
+ public:
+ ContactListItem( TQListView* parent, const KPIM::LdapAttrMap& attrs )
+ : TQListViewItem( parent ), mAttrs( attrs )
+ {
+ const KPIM::LdapAttrValue &mailAttrs = attrs[ "mail" ];
+ if ( mailAttrs.isEmpty() ) {
+ setSelectable( false );
+ setEnabled( false );
+ }
+ }
+
+ KPIM::LdapAttrMap mAttrs;
+
+ virtual TQString text( int col ) const
+ {
+ // Look up a suitable attribute for column col
+ const TQString colName = listView()->columnText( col );
+ const TQString ldapAttrName = adrbookattr2ldap()[ colName ];
+ return join( mAttrs[ ldapAttrName ], ", " );
+ }
+};
+
+}
+
+LDAPSearchDialog::LDAPSearchDialog( TQWidget* parent, const char* name )
+ : KDialogBase( Plain, i18n( "Search for Addresses in Directory" ), Help | User1 |
+ User2 | User3 | Cancel, Default, parent, name, false, true )
+{
+ setButtonCancel( KStdGuiItem::close() );
+ TQFrame *page = plainPage();
+ TQVBoxLayout *topLayout = new TQVBoxLayout( page, marginHint(), spacingHint() );
+
+ TQGroupBox *groupBox = new TQGroupBox( i18n( "Search for Addresses in Directory" ),
+ page );
+ groupBox->setFrameShape( TQGroupBox::Box );
+ groupBox->setFrameShadow( TQGroupBox::Sunken );
+ groupBox->setColumnLayout( 0, Qt::Vertical );
+ TQGridLayout *boxLayout = new TQGridLayout( groupBox->tqlayout(), 2,
+ 5, spacingHint() );
+ boxLayout->setColStretch( 1, 1 );
+
+ TQLabel *label = new TQLabel( i18n( "Search for:" ), groupBox );
+ boxLayout->addWidget( label, 0, 0 );
+
+ mSearchEdit = new KLineEdit( groupBox );
+ boxLayout->addWidget( mSearchEdit, 0, 1 );
+ label->setBuddy( mSearchEdit );
+
+ label = new TQLabel( i18n( "in" ), groupBox );
+ boxLayout->addWidget( label, 0, 2 );
+
+ mFilterCombo = new KComboBox( groupBox );
+ mFilterCombo->insertItem( i18n( "Name" ) );
+ mFilterCombo->insertItem( i18n( "Email" ) );
+ mFilterCombo->insertItem( i18n( "Home Number" ) );
+ mFilterCombo->insertItem( i18n( "Work Number" ) );
+ boxLayout->addWidget( mFilterCombo, 0, 3 );
+
+ TQSize buttonSize;
+ mSearchButton = new TQPushButton( i18n( "Stop" ), groupBox );
+ buttonSize = mSearchButton->tqsizeHint();
+ mSearchButton->setText( i18n( "Search" ) );
+ if ( buttonSize.width() < mSearchButton->tqsizeHint().width() )
+ buttonSize = mSearchButton->tqsizeHint();
+ mSearchButton->setFixedWidth( buttonSize.width() );
+
+ mSearchButton->setDefault( true );
+ boxLayout->addWidget( mSearchButton, 0, 4 );
+
+ mRecursiveCheckbox = new TQCheckBox( i18n( "Recursive search" ), groupBox );
+ mRecursiveCheckbox->setChecked( true );
+ boxLayout->addMultiCellWidget( mRecursiveCheckbox, 1, 1, 0, 4 );
+
+ mSearchType = new KComboBox( groupBox );
+ mSearchType->insertItem( i18n( "Contains" ) );
+ mSearchType->insertItem( i18n( "Starts With" ) );
+ boxLayout->addMultiCellWidget( mSearchType, 1, 1, 3, 4 );
+
+ topLayout->addWidget( groupBox );
+
+ mResultListView = new TQListView( page );
+ mResultListView->setSelectionMode( TQListView::Multi );
+ mResultListView->setAllColumnsShowFocus( true );
+ mResultListView->setShowSortIndicator( true );
+ topLayout->addWidget( mResultListView );
+
+ resize( TQSize( 600, 400).expandedTo( tqminimumSizeHint() ) );
+
+ setButtonText( User1, i18n( "Unselect All" ) );
+ setButtonText( User2, i18n( "Select All" ) );
+ setButtonText( User3, i18n( "Add Selected" ) );
+
+ mNumHosts = 0;
+ mIsOK = false;
+
+ connect( mRecursiveCheckbox, TQT_SIGNAL( toggled( bool ) ),
+ this, TQT_SLOT( slotSetScope( bool ) ) );
+ connect( mSearchButton, TQT_SIGNAL( clicked() ),
+ this, TQT_SLOT( slotStartSearch() ) );
+
+ setTabOrder(mSearchEdit, mFilterCombo);
+ setTabOrder(mFilterCombo, mSearchButton);
+ mSearchEdit->setFocus();
+
+ restoreSettings();
+}
+
+LDAPSearchDialog::~LDAPSearchDialog()
+{
+ saveSettings();
+}
+
+void LDAPSearchDialog::restoreSettings()
+{
+ // Create one KPIM::LdapClient per selected server and configure it.
+
+ // First clean the list to make sure it is empty at
+ // the beginning of the process
+ mLdapClientList.setAutoDelete( true );
+ mLdapClientList.clear();
+
+ KConfig kabConfig( "kaddressbookrc" );
+ kabConfig.setGroup( "LDAPSearch" );
+ mSearchType->setCurrentItem( kabConfig.readNumEntry( "SearchType", 0 ) );
+
+ // then read the config file and register all selected
+ // server in the list
+ KConfig* config = KABC::AddressLineEdit::config(); // singleton kabldaprc config object
+ KConfigGroupSaver saver( config, "LDAP" );
+ mNumHosts = config->readUnsignedNumEntry( "NumSelectedHosts" );
+ if ( !mNumHosts ) {
+ KMessageBox::error( this, i18n( "You must select a LDAP server before searching.\nYou can do this from the menu Settings/Configure KAddressBook." ) );
+ mIsOK = false;
+ } else {
+ mIsOK = true;
+ for ( int j = 0; j < mNumHosts; ++j ) {
+ KPIM::LdapServer ldapServer;
+
+ TQString host = config->readEntry( TQString( "SelectedHost%1" ).tqarg( j ), "" );
+ if ( !host.isEmpty() )
+ ldapServer.setHost( host );
+
+ int port = config->readUnsignedNumEntry( TQString( "SelectedPort%1" ).tqarg( j ) );
+ if ( port )
+ ldapServer.setPort( port );
+
+ TQString base = config->readEntry( TQString( "SelectedBase%1" ).tqarg( j ), "" );
+ if ( !base.isEmpty() )
+ ldapServer.setBaseDN( base );
+
+ TQString bindDN = config->readEntry( TQString( "SelectedBind%1" ).tqarg( j ), "" );
+ if ( !bindDN.isEmpty() )
+ ldapServer.setBindDN( bindDN );
+
+ TQString pwdBindDN = config->readEntry( TQString( "SelectedPwdBind%1" ).tqarg( j ), "" );
+ if ( !pwdBindDN.isEmpty() )
+ ldapServer.setPwdBindDN( pwdBindDN );
+
+ KPIM::LdapClient* ldapClient = new KPIM::LdapClient( 0, TQT_TQOBJECT(this), "ldapclient" );
+ ldapClient->setServer( ldapServer );
+
+ TQStringList attrs;
+
+ for ( TQMap<TQString,TQString>::Iterator it = adrbookattr2ldap().begin(); it != adrbookattr2ldap().end(); ++it )
+ attrs << *it;
+
+ ldapClient->setAttrs( attrs );
+
+ connect( ldapClient, TQT_SIGNAL( result( const KPIM::LdapObject& ) ),
+ this, TQT_SLOT( slotAddResult( const KPIM::LdapObject& ) ) );
+ connect( ldapClient, TQT_SIGNAL( done() ),
+ this, TQT_SLOT( slotSearchDone() ) );
+ connect( ldapClient, TQT_SIGNAL( error( const TQString& ) ),
+ this, TQT_SLOT( slotError( const TQString& ) ) );
+
+ mLdapClientList.append( ldapClient );
+ }
+
+/** CHECKIT*/
+ while ( mResultListView->header()->count() > 0 ) {
+ mResultListView->removeColumn(0);
+ }
+
+ mResultListView->addColumn( i18n( "Full Name" ) );
+ mResultListView->addColumn( i18n( "Email" ) );
+ mResultListView->addColumn( i18n( "Home Number" ) );
+ mResultListView->addColumn( i18n( "Work Number" ) );
+ mResultListView->addColumn( i18n( "Mobile Number" ) );
+ mResultListView->addColumn( i18n( "Fax Number" ) );
+ mResultListView->addColumn( i18n( "Company" ) );
+ mResultListView->addColumn( i18n( "Organization" ) );
+ mResultListView->addColumn( i18n( "Street" ) );
+ mResultListView->addColumn( i18n( "State" ) );
+ mResultListView->addColumn( i18n( "Country" ) );
+ mResultListView->addColumn( i18n( "Zip Code" ) );
+ mResultListView->addColumn( i18n( "Postal Address" ) );
+ mResultListView->addColumn( i18n( "City" ) );
+ mResultListView->addColumn( i18n( "Department" ) );
+ mResultListView->addColumn( i18n( "Description" ) );
+ mResultListView->addColumn( i18n( "User ID" ) );
+ mResultListView->addColumn( i18n( "Title" ) );
+
+ mResultListView->clear();
+ }
+}
+
+void LDAPSearchDialog::saveSettings()
+{
+ KConfig config( "kaddressbookrc" );
+ config.setGroup( "LDAPSearch" );
+ config.writeEntry( "SearchType", mSearchType->currentItem() );
+ config.sync();
+}
+
+void LDAPSearchDialog::cancelQuery()
+{
+ for ( KPIM::LdapClient* client = mLdapClientList.first(); client; client = mLdapClientList.next() ) {
+ client->cancelQuery();
+ }
+}
+
+void LDAPSearchDialog::slotAddResult( const KPIM::LdapObject& obj )
+{
+ new ContactListItem( mResultListView, obj.attrs );
+}
+
+void LDAPSearchDialog::slotSetScope( bool rec )
+{
+ for ( KPIM::LdapClient* client = mLdapClientList.first(); client; client = mLdapClientList.next() ) {
+ if ( rec )
+ client->setScope( "sub" );
+ else
+ client->setScope( "one" );
+ }
+}
+
+TQString LDAPSearchDialog::makeFilter( const TQString& query, const TQString& attr,
+ bool startsWith )
+{
+ /* The reasoning behind this filter is:
+ * If it's a person, or a distlist, show it, even if it doesn't have an email address.
+ * If it's not a person, or a distlist, only show it if it has an email attribute.
+ * This allows both resource accounts with an email address which are not a person and
+ * person entries without an email address to show up, while still not showing things
+ * like structural entries in the ldap tree. */
+ TQString result( "&(|(objectclass=person)(objectclass=groupofnames)(mail=*))(" );
+ if( query.isEmpty() )
+ // Return a filter that matches everything
+ return result + "|(cn=*)(sn=*)" + ")";
+
+ if ( attr == i18n( "Name" ) ) {
+ result += startsWith ? "|(cn=%1*)(sn=%2*)" : "|(cn=*%1*)(sn=*%2*)";
+ result = result.tqarg( query ).tqarg( query );
+ } else {
+ result += (startsWith ? "%1=%2*" : "%1=*%2*");
+ if ( attr == i18n( "Email" ) ) {
+ result = result.tqarg( "mail" ).tqarg( query );
+ } else if ( attr == i18n( "Home Number" ) ) {
+ result = result.tqarg( "homePhone" ).tqarg( query );
+ } else if ( attr == i18n( "Work Number" ) ) {
+ result = result.tqarg( "telephoneNumber" ).tqarg( query );
+ } else {
+ // Error?
+ result = TQString();
+ return result;
+ }
+ }
+ result += ")";
+ return result;
+}
+
+void LDAPSearchDialog::slotStartSearch()
+{
+ cancelQuery();
+
+ TQApplication::setOverrideCursor( TQt::waitCursor );
+ mSearchButton->setText( i18n( "Stop" ) );
+
+ disconnect( mSearchButton, TQT_SIGNAL( clicked() ),
+ this, TQT_SLOT( slotStartSearch() ) );
+ connect( mSearchButton, TQT_SIGNAL( clicked() ),
+ this, TQT_SLOT( slotStopSearch() ) );
+
+ bool startsWith = (mSearchType->currentItem() == 1);
+
+ TQString filter = makeFilter( mSearchEdit->text().stripWhiteSpace(), mFilterCombo->currentText(), startsWith );
+
+ // loop in the list and run the KPIM::LdapClients
+ mResultListView->clear();
+ for( KPIM::LdapClient* client = mLdapClientList.first(); client; client = mLdapClientList.next() ) {
+ client->startQuery( filter );
+ }
+
+ saveSettings();
+}
+
+void LDAPSearchDialog::slotStopSearch()
+{
+ cancelQuery();
+ slotSearchDone();
+}
+
+void LDAPSearchDialog::slotSearchDone()
+{
+ // If there are no more active clients, we are done.
+ for ( KPIM::LdapClient* client = mLdapClientList.first(); client; client = mLdapClientList.next() ) {
+ if ( client->isActive() )
+ return;
+ }
+
+ disconnect( mSearchButton, TQT_SIGNAL( clicked() ),
+ this, TQT_SLOT( slotStopSearch() ) );
+ connect( mSearchButton, TQT_SIGNAL( clicked() ),
+ this, TQT_SLOT( slotStartSearch() ) );
+
+ mSearchButton->setText( i18n( "Search" ) );
+ TQApplication::restoreOverrideCursor();
+}
+
+void LDAPSearchDialog::slotError( const TQString& error )
+{
+ TQApplication::restoreOverrideCursor();
+ KMessageBox::error( this, error );
+}
+
+void LDAPSearchDialog::closeEvent( TQCloseEvent* e )
+{
+ slotStopSearch();
+ e->accept();
+}
+
+/*!
+ * Returns a ", " separated list of email addresses that were
+ * checked by the user
+ */
+TQString LDAPSearchDialog::selectedEMails() const
+{
+ TQStringList result;
+ ContactListItem* cli = static_cast<ContactListItem*>( mResultListView->firstChild() );
+ while ( cli ) {
+ if ( cli->isSelected() ) {
+ TQString email = asUtf8( cli->mAttrs[ "mail" ].first() ).stripWhiteSpace();
+ if ( !email.isEmpty() ) {
+ TQString name = asUtf8( cli->mAttrs[ "cn" ].first() ).stripWhiteSpace();
+ if ( name.isEmpty() ) {
+ result << email;
+ } else {
+ result << KPIM::quoteNameIfNecessary( name ) + " <" + email + ">";
+ }
+ }
+ }
+ cli = static_cast<ContactListItem*>( cli->nextSibling() );
+ }
+
+ return result.join( ", " );
+}
+
+void LDAPSearchDialog::slotHelp()
+{
+ kapp->invokeHelp( "ldap-queries" );
+}
+
+void LDAPSearchDialog::slotUser1()
+{
+ mResultListView->selectAll( false );
+}
+
+void LDAPSearchDialog::slotUser2()
+{
+ mResultListView->selectAll( true );
+}
+
+void LDAPSearchDialog::slotUser3()
+{
+ emit addresseesAdded();
+}
+
+#include "ldapsearchdialog.moc"