ldapurl.cpp

/*
  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.
*/

#include "ldapurl.h"

#include <kdebug.h>

#include <QtCore/QStringList>

using namespace KLDAP;

class LdapUrl::LdapUrlPrivate
{
  public:
    LdapUrlPrivate()
      : m_scope( Base )
    {
    }

    QMap<QString, Extension> m_extensions;
    QStringList m_attributes;
    Scope m_scope;
    QString m_filter;
};

LdapUrl::LdapUrl()
  : d( new LdapUrlPrivate )
{
}

LdapUrl::LdapUrl( const KUrl &_url )
  : KUrl( _url ), d( new LdapUrlPrivate )
{
  QString tmp = path();
  if ( tmp.startsWith( QLatin1Char('/') ) ) {
    tmp = tmp.mid( 1 );
  }
  setPath( tmp );
  parseQuery();
}

LdapUrl::LdapUrl( const LdapUrl &that )
  : KUrl( that ), d( new LdapUrlPrivate )
{
  *d = *that.d;
}

LdapUrl &LdapUrl::operator=( const LdapUrl &that )
{
  if ( this == &that ) {
    return *this;
  }

  KUrl::operator=( that );
  *d = *that.d;

  return *this;
}

LdapUrl::~LdapUrl()
{
  delete d;
}

void LdapUrl::setDn( const LdapDN &dn )
{
  QString tmp = dn.toString();
  if ( tmp.startsWith( QLatin1Char('/') ) ) {
    tmp = tmp.mid( 1 );
  }
  setPath( tmp );
}

LdapDN LdapUrl::dn() const
{
  QString tmp = path();
  if ( tmp.startsWith( QLatin1Char('/') ) ) {
    tmp = tmp.mid( 1 );
  }
  LdapDN tmpDN( tmp );
  return tmpDN;
}

QStringList LdapUrl::attributes() const
{
  return d->m_attributes;
}

void LdapUrl::setAttributes( const QStringList &attributes )
{
  d->m_attributes=attributes;
  updateQuery();
}

LdapUrl::Scope LdapUrl::scope() const
{
  return d->m_scope;
}

void LdapUrl::setScope( Scope scope )
{
  d->m_scope = scope;
  updateQuery();
}

QString LdapUrl::filter() const
{
  return d->m_filter;
}

void LdapUrl::setFilter( const QString &filter )
{
  d->m_filter = filter;
  updateQuery();
}

bool LdapUrl::hasExtension( const QString &key ) const
{
  return d->m_extensions.contains( key );
}

LdapUrl::Extension LdapUrl::extension( const QString &key ) const
{
  QMap<QString, Extension>::const_iterator it;

  it = d->m_extensions.constFind( key );
  if ( it != d->m_extensions.constEnd() ) {
    return ( *it );
  } else {
    Extension ext;
    ext.value = QLatin1String("");
    ext.critical = false;
    return ext;
  }
}

QString LdapUrl::extension( const QString &key, bool &critical ) const
{
  Extension ext;

  ext = extension( key );
  critical = ext.critical;
  return ext.value;
}

void LdapUrl::setExtension( const QString &key, const LdapUrl::Extension &ext )
{
  d->m_extensions[ key ] = ext;
  updateQuery();
}

void LdapUrl::setExtension( const QString &key, const QString &value, bool critical )
{
  Extension ext;
  ext.value = value;
  ext.critical = critical;
  setExtension( key, ext );
}

void LdapUrl::setExtension( const QString &key, int value, bool critical )
{
  Extension ext;
  ext.value = QString::number( value );
  ext.critical = critical;
  setExtension( key, ext );
}

void LdapUrl::removeExtension( const QString &key )
{
  d->m_extensions.remove( key );
  updateQuery();
}

void LdapUrl::updateQuery()
{
  QMap<QString, Extension>::const_iterator it;
  QString q( QLatin1Char('?') );

  // set the attributes to query
  if ( !d->m_attributes.isEmpty() ) {
    q += d->m_attributes.join( QLatin1String(",") );
  }

  // set the scope
  q += QLatin1Char('?');
  switch ( d->m_scope ) {
  case Sub:
    q += QLatin1String("sub");
    break;
  case One:
    q += QLatin1String("one");
    break;
  case Base:
    q += QLatin1String("base");
    break;
  }

  // set the filter
  q += QLatin1Char('?');
  if ( d->m_filter != QLatin1String("(objectClass=*)") && !d->m_filter.isEmpty() ) {
    q += QLatin1String(toPercentEncoding( d->m_filter ));
  }

  // set the extensions
  q += QLatin1Char('?');
  for ( it = d->m_extensions.constBegin(); it != d->m_extensions.constEnd(); ++it ) {
    if ( it.value().critical ) {
      q += QLatin1Char('!');
    }
    q += it.key();
    if ( !it.value().value.isEmpty() ) {
      q += QLatin1Char('=') + QLatin1String(toPercentEncoding( it.value().value ));
    }
    q += QLatin1Char(',');
  }
  while  ( q.endsWith( QLatin1Char('?') ) || q.endsWith( QLatin1Char(',') ) ) {
    q.remove( q.length() - 1, 1 );
  }

  setQuery( q );
  kDebug() << "LDAP URL updateQuery():" << prettyUrl();
}

void LdapUrl::parseQuery()
{
  Extension ext;
  QStringList extensions;
  QString q = query();
  // remove first ?
  if ( q.startsWith( QLatin1Char('?') ) ) {
    q.remove( 0, 1 );
  }

  // split into a list
  QStringList url_items = q.split( QLatin1Char('?') );

  d->m_attributes.clear();
  d->m_scope = Base;
  d->m_filter = QLatin1String("(objectClass=*)");
  d->m_extensions.clear();

  int i = 0;
  QStringList::const_iterator end( url_items.constEnd() );
  for ( QStringList::const_iterator it=url_items.constBegin();
        it != end; ++it, i++ ) {
    switch ( i ) {
    case 0:
      d->m_attributes = ( *it ).split( QLatin1Char(','), QString::SkipEmptyParts );
      break;
    case 1:
      if ( ( *it ) == QLatin1String( "sub" ) ) {
        d->m_scope = Sub;
      } else if ( ( *it ) == QLatin1String( "one" ) ) {
        d->m_scope = One;
      }
      break;
    case 2:
      d->m_filter = fromPercentEncoding( ( *it ).toLatin1() );
      break;
    case 3:
      extensions = ( *it ).split( QLatin1Char(','), QString::SkipEmptyParts );
      break;
    }
  }

  QString name, value;
  QStringList::const_iterator end2( extensions.constEnd() );
  for ( QStringList::const_iterator it=extensions.constBegin();
        it != end2; ++it ) {
    ext.critical = false;
    name = fromPercentEncoding( ( *it ).section( QLatin1Char('='), 0, 0 ).toLatin1() ).toLower();
    value = fromPercentEncoding( ( *it ).section( QLatin1Char('='), 1 ).toLatin1() );
    if ( name.startsWith( QLatin1Char('!') ) ) {
      ext.critical = true;
      name.remove( 0, 1 );
    }
    kDebug() << "LdapUrl extensions name=" << name << "value:" << value;
    ext.value = value.replace( QLatin1String("%2"), QLatin1String(",") );
    setExtension( name, ext );
  }
}