Repository navigation
Expand file tree
/
Copy paththeme.h
More file actions
475 lines (402 loc) · 14.2 KB
/
Copy paththeme.h
File metadata and controls
475 lines (402 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
/*
* Copyright (C) by Klaas Freitag <freitag@owncloud.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License
* for more details.
*/
#ifndef _THEME_H
#define _THEME_H
#include <QFileInfo>
#include <QObject>
#include "syncresult.h"
class QIcon;
class QString;
class QObject;
class QPixmap;
class QColor;
class QPaintDevice;
namespace OCC {
class SyncResult;
/**
* @brief The Theme class
* @ingroup libsync
*/
class OWNCLOUDSYNC_EXPORT Theme : public QObject
{
Q_OBJECT
public:
enum class VersionFormat {
Plain,
Url,
RichText,
OneLiner
};
Q_ENUM(VersionFormat);
/* returns a singleton instance. */
static Theme *instance();
~Theme() override;
/**
* @brief appNameGUI - Human readable application name.
*
* Use and redefine this if the human readable name contains spaces,
* special chars and such.
*
* By default, the name is derived from the APPLICATION_NAME
* cmake variable.
*
* @return QString with human readable app name.
*/
virtual QString appNameGUI() const;
/**
* @brief appName - Application name (short)
*
* Use and redefine this as an application name. Keep it straight as
* it is used for config files etc. If you need a more sophisticated
* name in the GUI, redefine appNameGUI.
*
* By default, the name is derived from the APPLICATION_SHORTNAME
* cmake variable, and should be the same. This method is only
* reimplementable for legacy reasons.
*
* Warning: Do not modify this value, as many things, e.g. settings
* depend on it! You most likely want to modify \ref appNameGUI().
*
* @return QString with app name.
*/
virtual QString appName() const;
/**
* @brief configFileName
* @return the name of the config file.
*/
virtual QString configFileName() const;
#ifndef TOKEN_AUTH_ONLY
/**
* Wehther we allow a fallback to a vanilla icon
*/
enum class IconType {
BrandedIcon,
BrandedIconWithFallbackToVanillaIcon,
VanillaIcon
};
/**
* get an sync state icon
*/
QIcon syncStateIcon(const SyncResult &status, bool sysTray = false, bool sysTrayMenuVisible = false) const;
QIcon syncStateIcon(SyncResult::Status result, bool sysTray = false, bool sysTrayMenuVisible = false) const;
virtual QIcon folderDisabledIcon() const;
virtual QIcon folderOfflineIcon(bool sysTray = false, bool sysTrayMenuVisible = false) const;
virtual QIcon applicationIcon() const;
virtual QIcon aboutIcon() const;
/**
* Whether use the dark icon theme
* The function also ensures the theme supports the dark theme
*/
bool isUsingDarkTheme() const;
/**
* Whether the branding allows the dark theme
*/
bool allowDarkTheme() const;
#endif
virtual QString statusHeaderText(SyncResult::Status) const;
/**
* Characteristics: bool if more than one sync folder is allowed
*/
virtual bool singleSyncFolder() const;
/**
* When true, client works with multiple accounts.
*/
virtual bool multiAccount() const;
/**
* URL to documentation.
*
* This is opened in the browser when the "Help" action is selected from the tray menu.
*
* If the function is overridden to return an empty string the action is removed from
* the menu.
*
* Defaults to ownCloud's client documentation website.
*/
virtual QString helpUrl() const;
/**
* The url to use for showing help on conflicts.
*
* If the function is overridden to return an empty string no help link will be shown.
*
* Defaults to helpUrl() + "conflicts.html", which is a page in ownCloud's client
* documentation website. If helpUrl() is empty, this function will also return the
* empty string.
*/
virtual QString conflictHelpUrl() const;
/**
* Setting a value here will pre-define the server url.
*
* The respective UI controls will be disabled
* Deprecated: Use overrideServerUrlV2 as it allows overrides
*/
Q_DECL_DEPRECATED_X("Use overrideServerUrlV2")
virtual QString overrideServerUrl() const;
/** Same as overrideServerUrl allows override by
* setting $OWNCLOUD_OVERRIDE_SERVER_URL
*/
QString overrideServerUrlV2() const;
/**
* This is only usefull when previous version had a different overrideServerUrl
* with a different auth type in that case You should then specify "http" or "shibboleth".
* Normaly this should be left empty.
*/
virtual QString forceConfigAuthType() const;
/**
* The default folder name without path on the server at setup time.
*/
virtual QString defaultServerFolder() const;
/**
* The default folder name without path on the client side at setup time.
*/
virtual QString defaultClientFolder() const;
/**
* Override to encforce a particular locale, i.e. "de" or "pt_BR"
*/
virtual QString enforcedLocale() const { return QString(); }
#ifndef TOKEN_AUTH_ONLY
/** colored, white or black */
QString systrayIconFlavor(bool mono, bool sysTrayMenuVisible = false) const;
/** @return color for the setup wizard */
virtual QColor wizardHeaderTitleColor() const;
virtual QColor wizardHeaderSubTitleColor() const;
/** @return color for the setup wizard. */
virtual QColor wizardHeaderBackgroundColor() const;
/** @return logo for the setup wizard. */
virtual QIcon wizardHeaderLogo() const;
/**
* The default implementation creates a
* background based on
* \ref wizardHeaderTitleColor().
*
* @return banner for the setup wizard.
*/
virtual QPixmap wizardHeaderBanner(const QSize &size) const;
#endif
/**
* The SHA sum of the released git commit
*/
QString gitSHA1(VersionFormat format = VersionFormat::Plain) const;
/**
* The used library versions
*/
QString aboutVersions(VersionFormat format = VersionFormat::Plain) const;
/**
* About dialog contents
*/
virtual QString about() const;
virtual bool aboutShowCopyright() const;
/**
* Define if the systray icons should be using mono design
*/
void setSystrayUseMonoIcons(bool mono);
/**
* Retrieve wether to use mono icons for systray
*/
bool systrayUseMonoIcons() const;
/**
* Check if mono icons are available
*/
bool monoIconsAvailable() const;
/**
* @brief Where to check for new Updates.
*/
virtual QString updateCheckUrl() const;
/**
* Default option for the newBigFolderSizeLimit.
* Size in MB of the maximum size of folder before we ask the confirmation.
* Set -1 to never ask confirmation. 0 to ask confirmation for every folder.
**/
virtual qint64 newBigFolderSizeLimit() const;
/**
* Hide the checkbox that says "Ask for confirmation before synchronizing folders larger than X MB"
* in the account wizard
*/
virtual bool wizardHideFolderSizeLimitCheckbox() const;
/**
* Hide the checkbox that says "Ask for confirmation before synchronizing external storages"
* in the account wizard
*/
virtual bool wizardHideExternalStorageConfirmationCheckbox() const;
/**
* Skip the advanced page and create a sync with the default settings
*/
virtual bool wizardSkipAdvancedPage() const;
/**
* Alternative path on the server that provides access to the webdav capabilities
*
* Attention: Make sure that this string does NOT have a leading slash and that
* it has a trailing slash, for example "remote.php/webdav/".
*/
virtual QString webDavPath() const;
/**
* @brief Sharing options
*
* Allow link sharing and or user/group sharing
*/
virtual bool linkSharing() const;
virtual bool userGroupSharing() const;
/**
* If this returns true, the user cannot configure the proxy in the network settings.
* The proxy settings will be disabled in the configuration dialog.
* Default returns false.
*/
virtual bool forceSystemNetworkProxy() const;
/**
* @brief How to handle the userID
*
* @value UserIDUserName Wizard asks for user name as ID
* @value UserIDEmail Wizard asks for an email as ID
* @value UserIDCustom Specify string in \ref customUserID
*/
enum UserIDType { UserIDUserName = 0,
UserIDEmail,
UserIDCustom };
/** @brief What to display as the userID (e.g. in the wizards)
*
* @return UserIDType::UserIDUserName, unless reimplemented
*/
virtual UserIDType userIDType() const;
/**
* @brief Allows to customize the type of user ID (e.g. user name, email)
*
* @note This string cannot be translated, but is still useful for
* referencing brand name IDs (e.g. "ACME ID", when using ACME.)
*
* @return An empty string, unless reimplemented
*/
virtual QString customUserID() const;
/**
* @brief Demo string to be displayed when no text has been
* entered for the user id (e.g. mylogin@company.com)
*
* @return An empty string, unless reimplemented
*/
virtual QString userIDHint() const;
/**
* @brief Postfix that will be enforced in a URL. e.g.
* ".myhosting.com".
*
* @return An empty string, unless reimplemented
*/
virtual QString wizardUrlPostfix() const;
/**
* @brief String that will be shown as long as no text has been entered by the user.
*
* @return An empty string, unless reimplemented
*/
virtual QString wizardUrlHint() const;
/**
* @brief the server folder that should be queried for the quota information
*
* This can be configured to show the quota infromation for a different
* folder than the root. This is the folder on which the client will do
* PROPFIND calls to get "quota-available-bytes" and "quota-used-bytes"
*
* Defaults: "/"
*/
virtual QString quotaBaseFolder() const;
/**
* The OAuth client_id, secret pair.
* Note that client that change these value cannot connect to un-branded owncloud servers.
*/
virtual QString oauthClientId() const;
virtual QString oauthClientSecret() const;
/**
* Defaults to http://localhost due to historic reasons,
* can be set to http://127.0.0.1 reasons.
* This option is only available with oauth2 not with OpenID Connect.
*/
virtual QString oauthLocalhost() const;
/**
* By default the client tries to get the OAuth access endpoint and the OAuth token endpoint from /.well-known/openid-configuration
* Setting this allow authentication without a well known url
*
* @return QPair<OAuth access endpoint, OAuth token endpoint>
*/
virtual QPair<QString, QString> oauthOverrideAuthUrl() const;
/**
* Returns the required opeidconnect scopes
*/
virtual QString openIdConnectScopes() const;
/**
* Returns the openidconnect promt type
* It is supposed to be "consent select_account".
* For Konnect it currently needs to be select_account,
* which is the current default.
*/
virtual QString openIdConnectPrompt() const;
/**
* @brief What should be output for the --version command line switch.
*
* By default, it's a combination of appName(), version(), the GIT SHA1 and some
* important dependency versions.
*/
virtual QString versionSwitchOutput() const;
/**
* @brief Whether to show the option to create folders using "virtual files".
*
* By default, this is the same as enableExperimentalFreatures()
*/
virtual bool showVirtualFilesOption() const;
virtual bool forceVirtualFilesOption() const;
/**
* @brief Whether to show options considered as experimental.
*
* By default, the options are not shown unless experimental options are
* manually enabled in the configuration file.
*/
virtual bool enableExperimentalFeatures() const;
/**
* Whether to clear cookies before checking status.php
* This is used with F5 BIG-IP seups.
*/
virtual bool connectionValidatorClearCookies() const;
/**
* Enables the response of V2/GET_CLIENT_ICON, default true.
* See #9167
*/
virtual bool enableSocketApiIconSupport() const;
/**
* Warn if we find multiple db files in the sync root.
* This can indicate that the sync dir is shared between multiple clients or accounts
*/
virtual bool warnOnMultipleDb() const;
protected:
#ifndef TOKEN_AUTH_ONLY
QIcon themeUniversalIcon(const QString &name, IconType iconType = IconType::BrandedIcon) const;
QIcon themeTrayIcon(const QString &name, bool sysTrayMenuVisible = false, IconType iconType = IconType::BrandedIconWithFallbackToVanillaIcon) const;
QIcon themeIcon(const QString &name, IconType iconType = IconType::BrandedIconWithFallbackToVanillaIcon) const;
#endif
Theme();
signals:
void systrayUseMonoIconsChanged(bool);
private:
Theme(Theme const &);
Theme &operator=(Theme const &);
QIcon loadIcon(const QString &flavor, const QString &name, IconType iconType) const;
// whether or not a theme is available
bool hasTheme(IconType type, const QString &theme) const;
static Theme *_instance;
bool _mono = false;
#ifndef TOKEN_AUTH_ONLY
mutable QMap<QString, QIcon> _iconCache;
// <<is vanilla, theme name>, bool
// caches the availability of themes for branded and unbranded themes
mutable QMap<QPair<bool, QString>, bool> _themeCache;
const bool _hasBrandedColored = hasTheme(IconType::BrandedIcon, QStringLiteral("colored"));
const bool _hasBrandedDark = hasTheme(IconType::BrandedIcon, QStringLiteral("dark"));
#endif
};
}
#endif // _THEME_H