TDE
/
tdepim
mirror of https://mirror.git.trinitydesktop.org/gitea/TDE/tdepim
0
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
tdepim/kaddressbook/ldapsearchdialog.cpp

645 lines
21 KiB
Raw Permalink Blame History

/* ldapsearchdialogimpl.cpp - 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
*/
#include "config.h"
#include <tqcheckbox.h>
#include <tqgroupbox.h>
#include <tqheader.h>
#include <tqlabel.h>
#include <tqlayout.h>
#include <tqlistview.h>
#include <tqmap.h>
#include <tqpushbutton.h>
#include <addresseelineedit.h>
#include <tdeapplication.h>
#include <kbuttonbox.h>
#include <kcombobox.h>
#include <tdeconfig.h>
#include <klineedit.h>
#include <tdelocale.h>
#include <tdemessagebox.h>
#include "kabcore.h"
#include "ldapsearchdialog.h"
#include "kablock.h"
#ifdef TDEPIM_NEW_DISTRLISTS
#include "distributionlistpicker.h"
#endif
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;
}
class ContactListItem : public TQListViewItem
{
public:
ContactListItem( TQListView* parent, const KPIM::LdapAttrMap& attrs )
: TQListViewItem( parent ), mAttrs( attrs )
{ }
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 ], ", " );
}
};
class LDAPSearchDialog::Private
{
public:
static TQValueList<ContactListItem*> selectedItems( TQListView* );
TQMap<const ContactListItem*, TQString> itemToServer;
};
TQValueList<ContactListItem*> LDAPSearchDialog::Private::selectedItems( TQListView* view )
{
TQValueList<ContactListItem*> selected;
ContactListItem* cli = static_cast<ContactListItem*>( view->firstChild() );
while ( cli ) {
if ( cli->isSelected() )
selected.append( cli );
cli = static_cast<ContactListItem*>( cli->nextSibling() );
}
return selected;
}
LDAPSearchDialog::LDAPSearchDialog( TDEABC::AddressBook *ab, KABCore *core,
TQWidget* parent, const char* name )
: KDialogBase( Plain, i18n( "Search for Addresses in Directory" ), Help | User1 | User2 |
Cancel, Default, parent, name, false, true ),
mAddressBook( ab ), mCore( core ), d( new Private )
{
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, TQt::Vertical );
TQGridLayout *boxLayout = new TQGridLayout( groupBox->layout(), 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 LDAP attribute", "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->sizeHint();
mSearchButton->setText( i18n( "&Search" ) );
if ( buttonSize.width() < mSearchButton->sizeHint().width() )
buttonSize = mSearchButton->sizeHint();
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 );
KButtonBox *buttons = new KButtonBox( page, TQt::Horizontal );
buttons->addButton( i18n( "Select All" ), this, TQ_SLOT( slotSelectAll() ) );
buttons->addButton( i18n( "Unselect All" ), this, TQ_SLOT( slotUnselectAll() ) );
topLayout->addWidget( buttons );
resize( TQSize( 600, 400).expandedTo( minimumSizeHint() ) );
setButtonText( User1, i18n( "Add Selected" ) );
showButton( User2, false );
#ifdef TDEPIM_NEW_DISTRLISTS
showButton( User2, true );
setButtonText( User2, i18n( "Add to Distribution List..." ) );
#endif
mNumHosts = 0;
mIsOK = false;
connect( mRecursiveCheckbox, TQ_SIGNAL( toggled( bool ) ),
this, TQ_SLOT( slotSetScope( bool ) ) );
connect( mSearchButton, TQ_SIGNAL( clicked() ),
this, TQ_SLOT( slotStartSearch() ) );
setTabOrder(mSearchEdit, mFilterCombo);
setTabOrder(mFilterCombo, mSearchButton);
mSearchEdit->setFocus();
restoreSettings();
}
LDAPSearchDialog::~LDAPSearchDialog()
{
saveSettings();
delete d;
}
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();
TDEConfig kabConfig( "kaddressbookrc" );
kabConfig.setGroup( "LDAPSearch" );
mSearchType->setCurrentItem( kabConfig.readNumEntry( "SearchType", 0 ) );
// then read the config file and register all selected
// server in the list
TDEConfig* config = KPIM::LdapSearch::config();
TDEConfigGroupSaver 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::LdapClient* ldapClient = new KPIM::LdapClient( 0, this, "ldapclient" );
KPIM::LdapServer ldapServer;
KPIM::LdapSearch::readConfig( ldapServer, config, j, true );
ldapClient->setServer( ldapServer );
TQStringList attrs;
for ( TQMap<TQString,TQString>::ConstIterator it = adrbookattr2ldap().begin(); it != adrbookattr2ldap().end(); ++it )
attrs << *it;
ldapClient->setAttrs( attrs );
connect( ldapClient, TQ_SIGNAL( result( const KPIM::LdapObject& ) ),
this, TQ_SLOT( slotAddResult( const KPIM::LdapObject& ) ) );
connect( ldapClient, TQ_SIGNAL( done() ),
this, TQ_SLOT( slotSearchDone() ) );
connect( ldapClient, TQ_SIGNAL( error( const TQString& ) ),
this, TQ_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();
d->itemToServer.clear();
}
}
void LDAPSearchDialog::saveSettings()
{
TDEConfig 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 )
{
ContactListItem* item = new ContactListItem( mResultListView, obj.attrs );
d->itemToServer[item] = obj.client->server().host();
}
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.arg( query ).arg( query );
} else {
result += (startsWith ? "%1=%2*" : "%1=*%2*");
if ( attr == i18n( "Email" ) ) {
result = result.arg( "mail" ).arg( query );
} else if ( attr == i18n( "Home Number" ) ) {
result = result.arg( "homePhone" ).arg( query );
} else if ( attr == i18n( "Work Number" ) ) {
result = result.arg( "telephoneNumber" ).arg( query );
} else {
// Error?
result = TQString();
return result;
}
}
result += ")";
return result;
}
void LDAPSearchDialog::slotStartSearch()
{
cancelQuery();
TQApplication::setOverrideCursor( TQt::waitCursor );
mSearchButton->setText( i18n( "Stop" ) );
disconnect( mSearchButton, TQ_SIGNAL( clicked() ),
this, TQ_SLOT( slotStartSearch() ) );
connect( mSearchButton, TQ_SIGNAL( clicked() ),
this, TQ_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();
d->itemToServer.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, TQ_SIGNAL( clicked() ),
this, TQ_SLOT( slotStopSearch() ) );
connect( mSearchButton, TQ_SIGNAL( clicked() ),
this, TQ_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 << name + " <" + email + ">";
}
}
}
cli = static_cast<ContactListItem*>( cli->nextSibling() );
}
return result.join( ", " );
}
void LDAPSearchDialog::slotHelp()
{
kapp->invokeHelp( "ldap-queries" );
}
void LDAPSearchDialog::slotUnselectAll()
{
mResultListView->selectAll( false );
}
void LDAPSearchDialog::slotSelectAll()
{
mResultListView->selectAll( true );
}
TDEABC::Addressee LDAPSearchDialog::convertLdapAttributesToAddressee( const KPIM::LdapAttrMap& attrs )
{
TDEABC::Addressee addr;
// name
addr.setNameFromString( asUtf8( attrs["cn"].first() ) );
// email
KPIM::LdapAttrValue lst = attrs["mail"];
KPIM::LdapAttrValue::ConstIterator it = lst.begin();
bool pref = true;
if ( it != lst.end() ) {
addr.insertEmail( asUtf8( *it ), pref );
pref = false;
++it;
}
addr.setOrganization( asUtf8( attrs[ "o" ].first() ) );
if ( addr.organization().isEmpty() )
addr.setOrganization( asUtf8( attrs[ "Company" ].first() ) );
#if KDE_IS_VERSION(3,5,8)
addr.setDepartment( asUtf8( attrs[ "department" ].first() ) );
#else
addr.insertCustom( "KADDRESSBOOK", "X-Department", asUtf8( attrs[ "department" ].first() ) );
#endif
// Address
TDEABC::Address workAddr( TDEABC::Address::Work );
workAddr.setStreet( asUtf8( attrs[ "street" ].first()) );
workAddr.setLocality( asUtf8( attrs[ "l" ].first()) );
workAddr.setRegion( asUtf8( attrs[ "st" ].first()));
workAddr.setPostalCode( asUtf8( attrs[ "postalCode" ].first()) );
workAddr.setCountry( asUtf8( attrs[ "co" ].first()) );
if ( !workAddr.isEmpty() )
addr.insertAddress( workAddr );
// phone
TDEABC::PhoneNumber homeNr = asUtf8( attrs[ "homePhone" ].first() );
homeNr.setType( TDEABC::PhoneNumber::Home );
addr.insertPhoneNumber( homeNr );
TDEABC::PhoneNumber workNr = asUtf8( attrs[ "telephoneNumber" ].first() );
workNr.setType( TDEABC::PhoneNumber::Work );
addr.insertPhoneNumber( workNr );
TDEABC::PhoneNumber faxNr = asUtf8( attrs[ "facsimileTelephoneNumber" ].first() );
faxNr.setType( TDEABC::PhoneNumber::Fax );
addr.insertPhoneNumber( faxNr );
TDEABC::PhoneNumber cellNr = asUtf8( attrs[ "mobile" ].first() );
cellNr.setType( TDEABC::PhoneNumber::Cell );
addr.insertPhoneNumber( cellNr );
TDEABC::PhoneNumber pagerNr = asUtf8( attrs[ "pager" ].first() );
pagerNr.setType( TDEABC::PhoneNumber::Pager );
addr.insertPhoneNumber( pagerNr );
return addr;
}
#ifdef TDEPIM_NEW_DISTRLISTS
KPIM::DistributionList LDAPSearchDialog::selectDistributionList()
{
TQGuardedPtr<KPIM::DistributionListPickerDialog> picker = new KPIM::DistributionListPickerDialog( mCore->addressBook(), this );
picker->setLabelText( i18n( "Select a distribution list to add the selected contacts to." ) );
picker->setCaption( i18n( "Select Distribution List" ) );
picker->exec();
const KPIM::DistributionList list = KPIM::DistributionList::findByName( mCore->addressBook(), picker
? picker->selectedDistributionList() : TQString() );
delete picker;
return list;
}
#endif
TDEABC::Addressee::List LDAPSearchDialog::importContactsUnlessTheyExist( const TQValueList<ContactListItem*>& selectedItems,
TDEABC::Resource * const resource )
{
const TQDateTime now = TQDateTime::currentDateTime();
TQStringList importedAddrs;
TDEABC::Addressee::List localAddrs;
KABLock::self( mCore->addressBook() )->lock( resource );
for ( TQValueList<ContactListItem*>::ConstIterator it = selectedItems.begin(); it != selectedItems.end(); ++it ) {
const ContactListItem * const cli = *it;
TDEABC::Addressee addr = convertLdapAttributesToAddressee( cli->mAttrs );
const TDEABC::Addressee::List existing = mCore->addressBook()->findByEmail( addr.preferredEmail() );
if ( existing.isEmpty() ) {
addr.setUid( TDEApplication::randomString( 10 ) );
addr.setNote( i18n( "arguments are host name, datetime", "Imported from LDAP directory %1 on %2" ).arg( d->itemToServer[cli], TDEGlobal::locale()->formatDateTime( now ) ) );
addr.setResource( resource );
mCore->addressBook()->insertAddressee( addr );
TQString displayString;
if ( !addr.fullEmail().isEmpty() ) {
displayString = addr.fullEmail();
}
else {
displayString = addr.formattedName();
}
importedAddrs.append( displayString );
localAddrs.append( addr );
} else {
localAddrs.append( existing.first() );
}
}
KABLock::self( mCore->addressBook() )->unlock( resource );
if ( !importedAddrs.isEmpty() ) {
KMessageBox::informationList( this, i18n( "The following contact was imported into your address book:",
"The following %n contacts were imported into your address book:", importedAddrs.count() ),
importedAddrs );
emit addresseesAdded();
}
return localAddrs;
}
void LDAPSearchDialog::slotUser2()
{
#ifdef TDEPIM_NEW_DISTRLISTS
const TQValueList<ContactListItem*> selectedItems = d->selectedItems( mResultListView );
if ( selectedItems.isEmpty() ) {
KMessageBox::information( this, i18n( "Please select the contacts you want to add to the distribution list." ), i18n( "No Contacts Selected" ) );
return;
}
TDEABC::Resource *resource = mCore->requestResource( this );
if ( !resource ) return;
KPIM::DistributionList dist = selectDistributionList();
if ( dist.isEmpty() )
return;
TDEABC::Addressee::List localAddrs = importContactsUnlessTheyExist( selectedItems, resource );
if ( localAddrs.isEmpty() )
return;
for ( TDEABC::Addressee::List::ConstIterator it = localAddrs.begin(); it != localAddrs.end(); ++it ) {
dist.insertEntry( *it, TQString() );
}
KABLock::self( mCore->addressBook() )->lock( resource );
mCore->addressBook()->insertAddressee( dist );
KABLock::self( mCore->addressBook() )->unlock( resource );
emit addresseesAdded();
#endif
}
void LDAPSearchDialog::slotUser1()
{
TDEABC::Resource *resource = mCore->requestResource( this );
if ( !resource ) return;
const TQValueList<ContactListItem*> selectedItems = d->selectedItems( mResultListView );
if( selectedItems.isEmpty() )
return;
importContactsUnlessTheyExist( selectedItems, resource );
}
#include "ldapsearchdialog.moc"
View Git Blame Copy Permalink