core: Don't store a reference in CoreCertManager
[quassel.git] / src / common / dccconfig.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2019 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 #pragma once
22
23 #include "common-export.h"
24
25 #include <QHostAddress>
26
27 #include "syncableobject.h"
28
29 /**
30  * Class holding the core-side DCC configuration.
31  *
32  * @warning Equality and assignment operators are optimized for use in a settings page
33  *          and do not cover all attributes!
34  */
35 class COMMON_EXPORT DccConfig : public SyncableObject
36 {
37     Q_OBJECT
38     SYNCABLE_OBJECT
39
40     /// Whether DCC is enabled
41     Q_PROPERTY(bool dccEnabled READ isDccEnabled WRITE setDccEnabled)
42     /// The IP to use for outgoing traffic
43     Q_PROPERTY(QHostAddress outgoingIp READ outgoingIp WRITE setOutgoingIp)
44     /// The IP detection mode
45     Q_PROPERTY(DccConfig::IpDetectionMode ipDetectionMode READ ipDetectionMode WRITE setIpDetectionMode)
46     /// The port range selection mode
47     Q_PROPERTY(DccConfig::PortSelectionMode portSelectionMode READ portSelectionMode WRITE setPortSelectionMode)
48     /// Minimum port to use for incoming connections
49     Q_PROPERTY(quint16 minPort READ minPort WRITE setMinPort)
50     /// Maximum port to use for incoming connections
51     Q_PROPERTY(quint16 maxPort READ maxPort WRITE setMaxPort)
52     /// The chunk size to be used
53     Q_PROPERTY(int chunkSize READ chunkSize WRITE setChunkSize)
54     /// The timeout for DCC transfers
55     Q_PROPERTY(int sendTimeout READ sendTimeout WRITE setSendTimeout)
56     /// Whether passive (reverse) DCC should be used
57     Q_PROPERTY(bool usePassiveDcc READ usePassiveDcc WRITE setUsePassiveDcc)
58     /// Whether fast sending should be used
59     Q_PROPERTY(bool useFastSend READ useFastSend WRITE setUseFastSend)
60
61 public:
62     /**
63      * Mode for detecting the outgoing IP
64      */
65     enum class IpDetectionMode : quint8
66     {
67         Automatic,  ///< Automatic detection (network socket or USERHOST)
68         Manual,     ///< Manually specified IP
69     };
70     Q_ENUMS(IpDetectionMode)
71
72     /**
73      * Mode for selecting the port range for DCC
74      */
75     enum class PortSelectionMode : quint8
76     {
77         Automatic,  ///< Automatic port selection
78         Manual,     ///< Manually specified port range
79     };
80     Q_ENUMS(PortSelectionMode)
81
82     /**
83      * Constructor.
84      *
85      * Initializes the object with useful default values.
86      *
87      * @param[in] parent QObject parent
88      */
89     DccConfig(QObject* parent = nullptr);
90
91     /**
92      * Assignment operator.
93      *
94      * @note Only assigns properties relevant for config management!
95      *
96      * @param[in] other Right-hand side instance
97      * @returns The updated instance
98      */
99     DccConfig& operator=(const DccConfig& other);
100
101     /**
102      * Equality operator.
103      *
104      * @note Only compares properties relevant for config management!
105      *
106      * @param[in] other Right-hand side instance
107      * @returns Whether the two instances have equal properties
108      */
109     bool operator==(const DccConfig& other);
110
111     /// @name Getters
112     /// @{
113     bool isDccEnabled() const;
114     QHostAddress outgoingIp() const;
115     IpDetectionMode ipDetectionMode() const;
116     PortSelectionMode portSelectionMode() const;
117     quint16 minPort() const;
118     quint16 maxPort() const;
119     int chunkSize() const;
120     int sendTimeout() const;
121     bool usePassiveDcc() const;
122     bool useFastSend() const;
123     /// @}
124
125 public slots:
126     /// @name Setters
127     /// @{
128     void setDccEnabled(bool enabled);
129     void setOutgoingIp(const QHostAddress& outgoingIp);
130     void setIpDetectionMode(DccConfig::IpDetectionMode ipDetectionMode);
131     void setPortSelectionMode(DccConfig::PortSelectionMode portSelectionMode);
132     void setMinPort(quint16 port);
133     void setMaxPort(quint16 port);
134     void setChunkSize(int chunkSize);
135     void setSendTimeout(int timeout);
136     void setUsePassiveDcc(bool use);
137     void setUseFastSend(bool use);
138     /// @}
139
140 private:
141     // The given values are used as default for both initialization and settings
142     bool _dccEnabled{false};
143     QHostAddress _outgoingIp{QHostAddress::LocalHost};
144     IpDetectionMode _ipDetectionMode{IpDetectionMode::Automatic};
145     PortSelectionMode _portSelectionMode{PortSelectionMode::Automatic};
146     quint16 _minPort{1024};
147     quint16 _maxPort{32767};
148     int _chunkSize{16};
149     int _sendTimeout{180};
150     bool _usePassiveDcc{false};
151     bool _useFastSend{false};
152 };