authinfo.h

Go to the documentation of this file.

/*
 *  This file is part of the KDE libraries
 *  Copyright (C) 2000-2001 Dawit Alemayehu <adawit@kde.org>
 *
 *  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.
 */

#ifndef KIO_AUTHINFO_H
#define KIO_AUTHINFO_H

#include "kio_export.h"

#include <QtCore/QMap>
#include <QtCore/QList>
#include <QtCore/QStringList>
#include <kurl.h>

class QDBusArgument;

namespace KIO {

class AuthInfoPrivate;

class KIO_EXPORT AuthInfo
{
    KIO_EXPORT friend QDataStream& operator<< (QDataStream& s, const AuthInfo& a);
    KIO_EXPORT friend QDataStream& operator>> (QDataStream& s, AuthInfo& a);

    KIO_EXPORT friend QDBusArgument &operator<<(QDBusArgument &argument, const AuthInfo &a);
    KIO_EXPORT friend const QDBusArgument &operator>>(const QDBusArgument &argument, AuthInfo &a);

public:
    
   AuthInfo();

   AuthInfo( const AuthInfo& info );
   
   ~AuthInfo();
   
   AuthInfo& operator=( const AuthInfo& info );

   bool isModified() const;

   void setModified( bool flag );

   KUrl url;

   QString username;

   QString password;

   QString prompt;

   QString caption;

   QString comment;

   QString commentLabel;

   QString realmValue;

   QString digestInfo;

   bool verifyPath;

   bool readOnly;

   bool keepPassword;
   
   enum FieldFlags
   {
       ExtraFieldNoFlags = 0,
       ExtraFieldReadOnly = 1<<1,
       ExtraFieldMandatory = 1<<2
   };
   
   void setExtraField(const QString &fieldName, const QVariant & value);
   
   void setExtraFieldFlags(const QString &fieldName, const FieldFlags flags);
   
   QVariant getExtraField(const QString &fieldName) const;
   
   AuthInfo::FieldFlags getExtraFieldFlags(const QString &fieldName) const;

   static void registerMetaTypes();
   
protected:
    bool modified;
private:
    friend class ::KIO::AuthInfoPrivate;
    AuthInfoPrivate * const d;
};

KIO_EXPORT QDataStream& operator<< (QDataStream& s, const AuthInfo& a);
KIO_EXPORT QDataStream& operator>> (QDataStream& s, AuthInfo& a);

KIO_EXPORT QDBusArgument &operator<<(QDBusArgument &argument, const AuthInfo &a);
KIO_EXPORT const QDBusArgument &operator>>(const QDBusArgument &argument, AuthInfo &a);

class KIO_EXPORT NetRC
{
public:

  enum LookUpModeFlag
  {
      exactOnly = 0x0002,
      defaultOnly = 0x0004,
      presetOnly = 0x0008
  };
  Q_DECLARE_FLAGS(LookUpMode, LookUpModeFlag)

  
  struct AutoLogin
  {
    QString type;
    QString machine;
    QString login;
    QString password;
    QMap<QString, QStringList> macdef;
  };

  static NetRC* self();

  bool lookup( const KUrl& url, AutoLogin& login,
               bool userealnetrc = false,
               const QString &type = QString(),
               LookUpMode mode = LookUpMode(exactOnly) | defaultOnly );
  void reload();

protected:
  QString extract( const char*, const char*, int& );
  int openf( const QString& );
  bool parse( int );

private:
  NetRC();
  ~NetRC();

private:
  static NetRC* instance;

  class NetRCPrivate;
  NetRCPrivate* const d;
};
}
Q_DECLARE_OPERATORS_FOR_FLAGS(KIO::NetRC::LookUpMode)
Q_DECLARE_METATYPE(KIO::AuthInfo)

#endif