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
|
#include <QDir>
#include <QStringList>
#include <QFileInfoList>
#include <QFileInfo>
#include "broadcast/defs_broadcast.h"
#include "defs_urls.h"
#include "preferences/broadcastsettings.h"
#include "util/logger.h"
#include "util/memory.h"
namespace {
const char* kProfilesSubfolder = "broadcast_profiles";
const char* kDefaultProfile = "Connection 1"; // Must be used only when initializing profiles
const mixxx::Logger kLogger("BroadcastSettings");
} // anonymous namespace
BroadcastSettings::BroadcastSettings(
UserSettingsPointer pConfig, QObject* parent)
: QObject(parent),
m_pConfig(pConfig),
m_profiles() {
loadProfiles();
}
void BroadcastSettings::loadProfiles() {
QDir profilesFolder(getProfilesFolder());
if (!profilesFolder.exists()) {
kLogger.info() << "Profiles folder doesn't exist. Creating it.";
profilesFolder.mkpath(profilesFolder.absolutePath());
}
QStringList nameFilters("*.bcp.xml");
QFileInfoList files =
profilesFolder.entryInfoList(nameFilters, QDir::Files, QDir::Name);
// If *.bcp.xml files exist in the profiles subfolder, those will be loaded
// and instantiated in the class' internal profile list for other by it and
// Mixxx subsystems related to Live Broadcasting.
// If that directory is empty (common reasons: it has been created by the
// code at the beginning, or all profiles were deleted) then a default
// profile with default values is created. That case could also mean that
// Mixxx has just been upgraded to a new version, so "legacy format" values
// has fetched from mixxx.cfg and loaded into the fresh default profile.
// It's important to take into account that the "legacy" settings are left
// in mixxx.cfg for retro-compatibility during alpha and beta testing.
if (files.size() > 0) {
kLogger.info() << "Found" << files.size() << "profile(s)";
// Load profiles from filesystem
for (const QFileInfo& fileInfo : files) {
BroadcastProfilePtr profile =
BroadcastProfile::loadFromFile(fileInfo.absoluteFilePath());
if (profile)
addProfile(profile);
}
} else {
kLogger.info() << "No profiles found. Creating default profile.";
BroadcastProfilePtr defaultProfile(
new BroadcastProfile(kDefaultProfile));
// Upgrade from mixxx.cfg format to XML (if required)
loadLegacySettings(defaultProfile);
addProfile(defaultProfile);
saveProfile(defaultProfile);
}
}
bool BroadcastSettings::addProfile(BroadcastProfilePtr profile) {
if (!profile)
return false;
if (m_profiles.size() >= BROADCAST_MAX_CONNECTIONS) {
kLogger.warning() << "addProfile: connection limit reached."
<< "can't add more than" << QString::number(BROADCAST_MAX_CONNECTIONS)
<< "connections.";
return false;
}
// It is best to avoid using QSharedPointer::data(), especially when
// passing it to another function, as it puts the associated pointer
// at risk of being manually deleted.
// However it's fine with Qt's connect because it can be trusted that
// it won't delete the pointer.
connect(profile.data(), SIGNAL(profileNameChanged(QString, QString)),
this, SLOT(onProfileNameChanged(QString,QString)));
connect(profile.data(), SIGNAL(connectionStatusChanged(int)),
this, SLOT(onConnectionStatusChanged(int)));
m_profiles.insert(profile->getProfileName(), BroadcastProfilePtr(profile));
emit profileAdded(profile);
return true;
}
bool BroadcastSettings::saveProfile(BroadcastProfilePtr profile) {
if (!profile)
return false;
QString filename = profile->getLastFilename();
if (filename.isEmpty()) {
// there was no previous filename, find an unused filename
for (int index = 0;; ++index) {
if (index > 0) {
// add an index to the file name to make it unique
filename = filePathForProfile(profile->getProfileName() + QString::number(index));
} else {
filename = filePathForProfile(profile->getProfileName());
}
QFileInfo fileInfo(filename);
if (!fileInfo.exists()) {
break;
}
}
}
return profile->save(filename);
}
QString BroadcastSettings::filePathForProfile(const QString& profileName) {
QString filename = profileName + ".bcp.xml";
filename = BroadcastProfile::stripForbiddenChars(filename);
return QDir(getProfilesFolder()).absoluteFilePath(filename);
}
QString BroadcastSettings::filePathForProfile(BroadcastProfilePtr profile) {
if (!profile)
return QString();
return filePathForProfile(profile->getProfileName());
}
bool BroadcastSettings::deleteFileForProfile(BroadcastProfilePtr profile) {
if (!profile)
return false;
QString filename = profile->getLastFilename();
if (filename.isEmpty()) {
// no file was saved, there is no file to delete
return false;
}
QFileInfo xmlFile(filename);
if (xmlFile.exists()) {
return QFile::remove(xmlFile.absoluteFilePath());
}
return false;
}
QString BroadcastSettings::getProfilesFolder() {
QString profilesPath(m_pConfig->getSettingsPath());
profilesPath.append(QDir::separator() + QString(kProfilesSubfolder));
return profilesPath;
}
void BroadcastSettings::saveAll() {
for (const auto& kv : qAsConst(m_profiles)) {
saveProfile(kv);
}
emit profilesChanged();
}
void BroadcastSettings::onProfileNameChanged(QString oldName, QString newName) {
if (!m_profiles.contains(oldName))
return;
BroadcastProfilePtr profile = m_profiles.take(oldName);
if (profile) {
m_profiles.insert(newName, profile);
emit profileRenamed(oldName, profile);
deleteFileForProfile(profile);
saveProfile(profile);
}
}
void BroadcastSettings::onConnectionStatusChanged(int newStatus) {
Q_UNUSED(newStatus);
}
BroadcastProfilePtr BroadcastSettings::profileAt(int index) {
auto it = m_profiles.begin() + index;
return it != m_profiles.end() ? it.value() : BroadcastProfilePtr(nullptr);
}
QList<BroadcastProfilePtr> BroadcastSettings::profiles() {
return m_profiles.values();
}
void BroadcastSettings::applyModel(BroadcastSettingsModel* pModel) {
if (!pModel) {
return;
}
// TODO(Palakis): lock both lists against modifications while syncing
// Step 1: find profiles to delete from the settings
for (auto profileIter = m_profiles.begin(); profileIter != m_profiles.end();) {
QString profileName = (*profileIter)->getProfileName();
if (!pModel->getProfileByName(profileName)) {
// If profile exists in settings but not in the model,
// remove the profile from the settings
const auto removedProfile = *profileIter;
deleteFileForProfile(removedProfile);
profileIter = m_profiles.erase(profileIter);
emit profileRemoved(removedProfile);
} else {
++profileIter;
}
}
// Step 2: add new profiles
for(BroadcastProfilePtr profileCopy : pModel->profiles()) {
// Check if profile already exists in settings
BroadcastProfilePtr existingProfile =
m_profiles.value(profileCopy->getProfileName());
if (!existingProfile) {
// If no profile with the same name exists, add the new
// profile to the settings.
// The BroadcastProfile instance is a copy to separate it
// from its existence in the model
addProfile(profileCopy->valuesCopy());
}
}
// Step 3: update existing profiles
for(BroadcastProfilePtr profileCopy : pModel->profiles()) {
BroadcastProfilePtr actualProfile =
m_profiles.value(profileCopy->getProfileName());
if (actualProfile) {
profileCopy->copyValuesTo(actualProfile);
}
}
saveAll();
}
|