src/core/oidentdconfiggenerator.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef OIDENTDCONFIGGENERATOR_H
  22 #define OIDENTDCONFIGGENERATOR_H
  23
  24 #include <QObject>
  25 #include <QString>
  26 #include <QDir>
  27 #include <QFile>
  28 #include <QDateTime>
  29 #include <QHostAddress>
  30 #include <QMutex>
  31 #include <QByteArray>
  32
  33 #ifdef HAVE_UMASK
  34 #  include <sys/types.h>
  35 #  include <sys/stat.h>
  36 #endif /* HAVE_UMASK */
  37
  38 #include "quassel.h"
  39 #include "coreidentity.h"
  40
  41 //!  Produces oidentd configuration files
  42 /*!
  43   Upon IRC connect this class puts the clients' ident data into an oidentd configuration file.
  44
  45   The default path is <~/.oidentd.conf>.
  46
  47   For oidentd to incorporate this file, the global oidentd.conf has to state something like this:
  48
  49   user "quassel" {
  50     default {
  51       allow spoof
  52       allow spoof_all
  53     }
  54   }
  55
  56 */
  57
  58 class OidentdConfigGenerator : public QObject
  59 {
  60     Q_OBJECT
  61 public:
  62     /**
  63      * @param strict If false, any identity a user chooses is reported to servers as authoritative.
  64      *               If true, the user's quassel username is always reported.
  65      */
  66     explicit OidentdConfigGenerator(bool strict = false, QObject *parent = 0);
  67     ~OidentdConfigGenerator();
  68
  69 public slots:
  70     bool addSocket(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
  71     bool removeSocket(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
  72
  73 private:
  74     const QString sysidentForIdentity(const CoreIdentity *identity);
  75     bool init();
  76     bool writeConfig();
  77     bool parseConfig(bool readQuasselStanzas = false);
  78     bool lineByUs(const QByteArray &line);
  79
  80     bool _initialized;
  81     bool _strict;
  82     QDateTime _lastSync;
  83     QFile *_configFile;
  84     QByteArray _parsedConfig;
  85     QByteArray _quasselConfig;
  86     // Mutex isn't strictly necessary at the moment, since with the current invocation in Core only one instance at a time exists
  87     QMutex _mutex;
  88
  89     QDir _configDir;
  90     QString _configFileName;
  91     QString _configPath;
  92     QString _configTag;
  93     QRegExp _quasselStanzaRx;
  94     QString _quasselStanzaTemplate;
  95 };
  96
  97
  98 #endif // OIDENTDCONFIGGENERATOR_H