Branch data Line data Source code
1 : : /***************************************************************************
2 : : qgssettings.cpp
3 : : --------------------------------------
4 : : Date : January 2017
5 : : Copyright : (C) 2017 by Alessandro Pasotti
6 : : Email : apasotti at boundlessgeo dot com
7 : : ***************************************************************************
8 : : * *
9 : : * This program is free software; you can redistribute it and/or modify *
10 : : * it under the terms of the GNU General Public License as published by *
11 : : * the Free Software Foundation; either version 2 of the License, or *
12 : : * (at your option) any later version. *
13 : : * *
14 : : ***************************************************************************/
15 : :
16 : :
17 : : #include <cstdlib>
18 : :
19 : : #include <QFileInfo>
20 : : #include <QSettings>
21 : : #include <QDir>
22 : :
23 : : #include "qgssettings.h"
24 : : #include "qgslogger.h"
25 : :
26 : 643 : Q_GLOBAL_STATIC( QString, sGlobalSettingsPath )
27 : :
28 : 0 : bool QgsSettings::setGlobalSettingsPath( const QString &path )
29 : : {
30 : 0 : if ( QFileInfo::exists( path ) )
31 : : {
32 : 0 : *sGlobalSettingsPath() = path;
33 : 0 : return true;
34 : : }
35 : 0 : return false;
36 : 0 : }
37 : :
38 : 628 : void QgsSettings::init()
39 : : {
40 : 628 : if ( ! sGlobalSettingsPath()->isEmpty() )
41 : : {
42 : 0 : mGlobalSettings = new QSettings( *sGlobalSettingsPath(), QSettings::IniFormat );
43 : 0 : mGlobalSettings->setIniCodec( "UTF-8" );
44 : 0 : }
45 : 628 : }
46 : :
47 : :
48 : 0 : QgsSettings::QgsSettings( const QString &organization, const QString &application, QObject *parent )
49 : 0 : {
50 : 0 : mUserSettings = new QSettings( organization, application, parent );
51 : 0 : init();
52 : 0 : }
53 : :
54 : 0 : QgsSettings::QgsSettings( QSettings::Scope scope, const QString &organization,
55 : : const QString &application, QObject *parent )
56 : 0 : {
57 : 0 : mUserSettings = new QSettings( scope, organization, application, parent );
58 : 0 : init();
59 : 0 : }
60 : :
61 : 0 : QgsSettings::QgsSettings( QSettings::Format format, QSettings::Scope scope,
62 : : const QString &organization, const QString &application, QObject *parent )
63 : 0 : {
64 : 0 : mUserSettings = new QSettings( format, scope, organization, application, parent );
65 : 0 : init();
66 : 0 : }
67 : :
68 : 0 : QgsSettings::QgsSettings( const QString &fileName, QSettings::Format format, QObject *parent )
69 : 0 : {
70 : 0 : mUserSettings = new QSettings( fileName, format, parent );
71 : 0 : init();
72 : 0 : }
73 : :
74 : 628 : QgsSettings::QgsSettings( QObject *parent )
75 : 1256 : {
76 : 628 : mUserSettings = new QSettings( parent );
77 : 628 : init();
78 : 628 : }
79 : :
80 : 626 : QgsSettings::~QgsSettings()
81 : 626 : {
82 : 626 : delete mUserSettings;
83 : 626 : delete mGlobalSettings;
84 : 626 : }
85 : :
86 : :
87 : 9 : void QgsSettings::beginGroup( const QString &prefix, const QgsSettings::Section section )
88 : : {
89 : 9 : QString pKey = prefixedKey( prefix, section );
90 : 9 : mUserSettings->beginGroup( pKey );
91 : 9 : if ( mGlobalSettings )
92 : : {
93 : 0 : mGlobalSettings->beginGroup( pKey );
94 : 0 : }
95 : 9 : }
96 : :
97 : 8 : void QgsSettings::endGroup()
98 : : {
99 : 8 : mUserSettings->endGroup();
100 : 8 : if ( mGlobalSettings )
101 : : {
102 : 0 : mGlobalSettings->endGroup();
103 : 0 : }
104 : 8 : }
105 : :
106 : 0 : QString QgsSettings::group() const
107 : : {
108 : 0 : return mUserSettings->group();
109 : : }
110 : :
111 : 8 : QStringList QgsSettings::allKeys() const
112 : : {
113 : 8 : QStringList keys = mUserSettings->allKeys();
114 : 8 : if ( mGlobalSettings )
115 : : {
116 : 0 : for ( auto &s : mGlobalSettings->allKeys() )
117 : : {
118 : 0 : if ( ! keys.contains( s ) )
119 : : {
120 : 0 : keys.append( s );
121 : 0 : }
122 : : }
123 : 0 : }
124 : 8 : return keys;
125 : 8 : }
126 : :
127 : :
128 : 1 : QStringList QgsSettings::childKeys() const
129 : : {
130 : 1 : QStringList keys = mUserSettings->childKeys();
131 : 1 : if ( mGlobalSettings )
132 : : {
133 : 0 : for ( auto &s : mGlobalSettings->childKeys() )
134 : : {
135 : 0 : if ( ! keys.contains( s ) )
136 : : {
137 : 0 : keys.append( s );
138 : 0 : }
139 : : }
140 : 0 : }
141 : 1 : return keys;
142 : 1 : }
143 : :
144 : 0 : QStringList QgsSettings::childGroups() const
145 : : {
146 : 0 : QStringList keys = mUserSettings->childGroups();
147 : 0 : if ( mGlobalSettings )
148 : : {
149 : 0 : for ( auto &s : mGlobalSettings->childGroups() )
150 : : {
151 : 0 : if ( ! keys.contains( s ) )
152 : : {
153 : 0 : keys.append( s );
154 : 0 : }
155 : : }
156 : 0 : }
157 : 0 : return keys;
158 : 0 : }
159 : 0 : QStringList QgsSettings::globalChildGroups() const
160 : : {
161 : 0 : QStringList keys;
162 : 0 : if ( mGlobalSettings )
163 : : {
164 : 0 : keys = mGlobalSettings->childGroups();
165 : 0 : }
166 : 0 : return keys;
167 : 0 : }
168 : :
169 : 0 : QString QgsSettings::globalSettingsPath()
170 : : {
171 : 0 : return *sGlobalSettingsPath();
172 : : }
173 : :
174 : 763 : QVariant QgsSettings::value( const QString &key, const QVariant &defaultValue, const QgsSettings::Section section ) const
175 : : {
176 : 763 : QString pKey = prefixedKey( key, section );
177 : 763 : if ( !mUserSettings->value( pKey ).isNull() )
178 : : {
179 : 0 : return mUserSettings->value( pKey );
180 : : }
181 : 763 : if ( mGlobalSettings )
182 : : {
183 : 0 : return mGlobalSettings->value( pKey, defaultValue );
184 : : }
185 : 763 : return defaultValue;
186 : 763 : }
187 : :
188 : 3 : bool QgsSettings::contains( const QString &key, const QgsSettings::Section section ) const
189 : : {
190 : 3 : QString pKey = prefixedKey( key, section );
191 : 6 : return mUserSettings->contains( pKey ) ||
192 : 3 : ( mGlobalSettings && mGlobalSettings->contains( pKey ) );
193 : 3 : }
194 : :
195 : 0 : QString QgsSettings::fileName() const
196 : : {
197 : 0 : return mUserSettings->fileName();
198 : : }
199 : :
200 : 0 : void QgsSettings::sync()
201 : : {
202 : 0 : mUserSettings->sync();
203 : 0 : }
204 : :
205 : 0 : void QgsSettings::remove( const QString &key, const QgsSettings::Section section )
206 : : {
207 : 0 : QString pKey = prefixedKey( key, section );
208 : 0 : mUserSettings->remove( pKey );
209 : 0 : }
210 : :
211 : 785 : QString QgsSettings::prefixedKey( const QString &key, const Section section ) const
212 : : {
213 : 785 : QString prefix;
214 : 785 : switch ( section )
215 : : {
216 : : case Section::Core :
217 : 16 : prefix = QStringLiteral( "core" );
218 : 8 : break;
219 : : case Section::Server :
220 : 0 : prefix = QStringLiteral( "server" );
221 : 0 : break;
222 : : case Section::Gui :
223 : 0 : prefix = QStringLiteral( "gui" );
224 : 0 : break;
225 : : case Section::Plugins :
226 : 0 : prefix = QStringLiteral( "plugins" );
227 : 0 : break;
228 : : case Section::Misc :
229 : 0 : prefix = QStringLiteral( "misc" );
230 : 0 : break;
231 : : case Section::Auth :
232 : 0 : prefix = QStringLiteral( "auth" );
233 : 0 : break;
234 : : case Section::App :
235 : 0 : prefix = QStringLiteral( "app" );
236 : 0 : break;
237 : : case Section::Providers :
238 : 0 : prefix = QStringLiteral( "providers" );
239 : 0 : break;
240 : : case Section::Expressions :
241 : 0 : prefix = QStringLiteral( "expressions" );
242 : 0 : break;
243 : : case Section::NoSection:
244 : 777 : return sanitizeKey( key );
245 : : }
246 : 8 : return prefix + "/" + sanitizeKey( key );
247 : 785 : }
248 : :
249 : :
250 : 0 : int QgsSettings::beginReadArray( const QString &prefix )
251 : : {
252 : 0 : int size = mUserSettings->beginReadArray( sanitizeKey( prefix ) );
253 : 0 : if ( 0 == size && mGlobalSettings )
254 : : {
255 : 0 : size = mGlobalSettings->beginReadArray( sanitizeKey( prefix ) );
256 : 0 : mUsingGlobalArray = ( size > 0 );
257 : 0 : }
258 : 0 : return size;
259 : 0 : }
260 : :
261 : 0 : void QgsSettings::beginWriteArray( const QString &prefix, int size )
262 : : {
263 : 0 : mUsingGlobalArray = false;
264 : 0 : mUserSettings->beginWriteArray( prefix, size );
265 : 0 : }
266 : :
267 : 0 : void QgsSettings::endArray()
268 : : {
269 : 0 : mUserSettings->endArray();
270 : 0 : if ( mGlobalSettings )
271 : : {
272 : 0 : mGlobalSettings->endArray();
273 : 0 : }
274 : 0 : mUsingGlobalArray = false;
275 : 0 : }
276 : :
277 : 0 : void QgsSettings::setArrayIndex( int i )
278 : : {
279 : 0 : if ( mGlobalSettings && mUsingGlobalArray )
280 : : {
281 : 0 : mGlobalSettings->setArrayIndex( i );
282 : 0 : }
283 : : else
284 : : {
285 : 0 : mUserSettings->setArrayIndex( i );
286 : : }
287 : 0 : }
288 : :
289 : 5 : void QgsSettings::setValue( const QString &key, const QVariant &value, const QgsSettings::Section section )
290 : : {
291 : : // TODO: add valueChanged signal
292 : : // Do not store if it hasn't changed from default value
293 : : // First check if the values are different and if at least one of them is valid.
294 : : // The valid check is required because different invalid QVariant types
295 : : // like QVariant(QVariant::String) and QVariant(QVariant::Int))
296 : : // may be considered different and we don't want to store the value in that case.
297 : 5 : QVariant currentValue = QgsSettings::value( prefixedKey( key, section ) );
298 : 5 : if ( ( currentValue.isValid() || value.isValid() ) && ( currentValue != value ) )
299 : : {
300 : 5 : mUserSettings->setValue( prefixedKey( key, section ), value );
301 : 5 : }
302 : : // Deliberately an "else if" because we want to remove a value from the user settings
303 : : // only if the value is different than the one stored in the global settings (because
304 : : // it would be the default anyway). The first check is necessary because the global settings
305 : : // might be a nullptr (for example in case of standalone scripts or apps).
306 : 0 : else if ( mGlobalSettings && mGlobalSettings->value( prefixedKey( key, section ) ) == currentValue )
307 : : {
308 : 0 : mUserSettings->remove( prefixedKey( key, section ) );
309 : 0 : }
310 : 5 : }
311 : :
312 : : // To lower case and clean the path
313 : 785 : QString QgsSettings::sanitizeKey( const QString &key ) const
314 : : {
315 : 785 : return QDir::cleanPath( key );
316 : : }
317 : :
318 : 0 : void QgsSettings::clear()
319 : : {
320 : 0 : mUserSettings->clear();
321 : 0 : }
|
