plugins/Unity/Launcher/backend/launcherbackend.cpp · unity8

git.iko.soy/unity8

on ec95238 help sign in

unity8/plugins/Unity/Launcher/backend/launcherbackend.cpp

584 lines 18 kB history raw

1/*

3 *

4 * Authors:

5 * Michael Terry <michael.terry@canonical.com>

6 * Michael Zanetti <michael.zanetti@canonical.com>

7 *

8 * This program is free software; you can redistribute it and/or modify

9 * it under the terms of the GNU General Public License as published by

10 * the Free Software Foundation; version 3.

11 *

12 * This program is distributed in the hope that it will be useful,

13 * but WITHOUT ANY WARRANTY; without even the implied warranty of

14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

15 * GNU General Public License for more details.

16 *

17 * You should have received a copy of the GNU General Public License

18 * along with this program. If not, see <http://www.gnu.org/licenses/>.

19 */

21#include "AccountsServiceDBusAdaptor.h"

22#include "launcherbackend.h"

24#include <QDir>

25#include <QDBusArgument>

26#include <QFileInfo>

27#include <QGSettings>

28#include <QDebug>

29#include <QStandardPaths>

31class LauncherBackendItem

32{

33public:

34 QString desktopFile;

35 QString displayName;

36 QString icon;

37 int count;

38 bool countVisible;

39};

41LauncherBackend::LauncherBackend(bool greeterMode, QObject *parent):

42 QDBusVirtualObject(parent),

43 m_greeterMode(greeterMode),

44 m_accounts(nullptr)

45{

46#ifndef LAUNCHER_TESTING

47 m_accounts = new AccountsServiceDBusAdaptor(this);

48 connect(m_accounts, SIGNAL(propertiesChanged(QString, QString, QStringList)),

49 this, SLOT(accountsListChanged(QString, QString, QStringList)));

50#endif

51 m_user = qgetenv("USER");

52 syncFromAccounts();

54 /* Set up ourselves on DBus */

55 QDBusConnection con = QDBusConnection::sessionBus();

56 if (!con.registerService("com.canonical.Unity.Launcher")) {

57 qDebug() << "Unable to register launcher name";

58 }

59 if (!con.registerVirtualObject("/com/canonical/Unity/Launcher", this, QDBusConnection::VirtualObjectRegisterOption::SubPath)) {

60 qDebug() << "Unable to register launcher object";

61 }

62}

64LauncherBackend::~LauncherBackend()

65{

66 /* Remove oursevles from DBus */

67 QDBusConnection con = QDBusConnection::sessionBus();

68 con.unregisterService("com.canonical.Unity.Launcher");

69 con.unregisterObject("/com/canonical/Unity/Launcher");

71 /* Clear data */

72 m_storedApps.clear();

74 Q_FOREACH(LauncherBackendItem *item, m_itemCache) {

75 delete item;

76 }

77 m_itemCache.clear();

78}

80QStringList LauncherBackend::storedApplications() const

81{

82 return m_storedApps;

83}

85void LauncherBackend::setStoredApplications(const QStringList &appIds)

86{

87 if (appIds.count() < m_storedApps.count()) {

88 Q_FOREACH(const QString &appId, m_storedApps) {

89 if (!appIds.contains(appId)) {

90 delete m_itemCache.take(appId);

91 }

92 }

93 }

94 m_storedApps = appIds;

95 Q_FOREACH(const QString &appId, appIds) {

96 if (!m_itemCache.contains(appId)) {

97 QString df = findDesktopFile(appId);

98 if (!df.isEmpty()) {

99 LauncherBackendItem *item = parseDesktopFile(df);

100 m_itemCache.insert(appId, item);

101 } else {

102 // Cannot find any data for that app... ignoring it.

103 qWarning() << "cannot find desktop file for" << appId << ". discarding app.";

104 m_storedApps.removeAll(appId);

105 }

106 }

107 }

108 syncToAccounts();

109}

110

111QString LauncherBackend::desktopFile(const QString &appId) const

112{

113 LauncherBackendItem *item = m_itemCache.value(appId, nullptr);

114 if (item) {

115 return item->desktopFile;

116 }

117

118 return findDesktopFile(appId);

119}

120

121QString LauncherBackend::displayName(const QString &appId) const

122{

123 LauncherBackendItem *item = m_itemCache.value(appId, nullptr);

124 if (item) {

125 return item->displayName;

126 }

127

128 QString df = findDesktopFile(appId);

129 if (!df.isEmpty()) {

130 LauncherBackendItem *item = parseDesktopFile(df);

131 m_itemCache.insert(appId, item);

132 return item->displayName;

133 }

134

135 return QString();

136}

137

138QString LauncherBackend::icon(const QString &appId) const

139{

140 QString iconName;

141 LauncherBackendItem *item = getItem(appId);

142 if (item) {

143 iconName = item->icon;

144 }

145

146 return iconName;

147}

148

149QList<QuickListEntry> LauncherBackend::quickList(const QString &appId) const

150{

151 // TODO: Get static (from .desktop file) and dynamic (from the app itself)

152 // entries and return them here. Frontend related entries (like "Pin to launcher")

153 // don't matter here. This is just the backend part.

154 // TODO: emit quickListChanged() when the dynamic part changes

155 Q_UNUSED(appId)

156 return QList<QuickListEntry>();

157}

158

159int LauncherBackend::progress(const QString &appId) const

160{

161 // TODO: Return value for progress emblem.

162 // TODO: emit progressChanged() when this value changes.

163 Q_UNUSED(appId)

164 return -1;

165}

166

167int LauncherBackend::count(const QString &appId) const

168{

169 int count = -1;

170 LauncherBackendItem *item = getItem(appId);

171

172 if (item) {

173 if (item->countVisible) {

174 count = item->count;

175 }

176 }

177

178 return count;

179}

180

181void LauncherBackend::setCount(const QString &appId, int count) const

182{

183 LauncherBackendItem *item = getItem(appId);

184

185 bool emitchange = false;

186 if (item) {

187 emitchange = (item->count != count);

188 item->count = count;

189 }

190

191 if (emitchange) {

192 /* TODO: This needs to use the accessor to handle the visibility

193 correctly, but when we have the two properties we can just use

194 the local value */

195 Q_EMIT countChanged(appId, this->count(appId));

196 QVariant vcount(item->count);

197 emitPropChangedDbus(appId, "count", vcount);

198 }

199}

200

201bool LauncherBackend::countVisible(const QString &appId) const

202{

203 bool visible = false;

204 LauncherBackendItem *item = getItem(appId);

205

206 if (item) {

207 visible = item->countVisible;

208 }

209

210 return visible;

211}

212

213void LauncherBackend::setCountVisible(const QString &appId, bool visible) const

214{

215 LauncherBackendItem *item = getItem(appId);

216

217 bool emitchange = false;

218 if (item) {

219 emitchange = (item->countVisible != visible);

220 item->countVisible = visible;

221 } else {

222 qDebug() << "Unable to find:" << appId;

223 }

224

225 if (emitchange) {

226 /* TODO: Because we're using visible in determining the

227 count we need to emit a count changed as well */

228 Q_EMIT countChanged(appId, this->count(appId));

229 Q_EMIT countVisibleChanged(appId, item->countVisible);

230 QVariant vCountVisible(item->countVisible);

231 emitPropChangedDbus(appId, "countVisible", vCountVisible);

232 }

233}

234

235void LauncherBackend::setUser(const QString &username)

236{

237 if (m_greeterMode && m_user != username) {

238 m_user = username;

239 syncFromAccounts();

240 }

241}

242

243void LauncherBackend::triggerQuickListAction(const QString &appId, const QString &quickListId)

244{

245 // TODO: execute the given quicklist action

246 Q_UNUSED(appId)

247 Q_UNUSED(quickListId)

248}

249

250void LauncherBackend::accountsListChanged(const QString &user, const QString &interface, const QStringList &changed)

251{

252 if (m_greeterMode && user == m_user &&

253 interface == "com.canonical.unity.AccountsService" &&

254 changed.contains("launcher-items")) {

255 syncFromAccounts();

256 }

257}

258

259void LauncherBackend::syncFromAccounts()

260{

261 QList<QVariantMap> apps;

262 bool defaults = true;

263

264 m_storedApps.clear();

265

266 if (m_accounts && !m_user.isEmpty()) {

267 QVariant variant = m_accounts->getUserProperty(m_user, "com.canonical.unity.AccountsService", "launcher-items");

268 if (variant.isValid() && variant.canConvert<QDBusArgument>()) {

269 apps = qdbus_cast<QList<QVariantMap>>(variant.value<QDBusArgument>());

270 defaults = isDefaultsItem(apps);

271 }

272 }

273

274 if (m_accounts && defaults) { // Checking accounts as it'll be null when !useStorage

275 QGSettings gSettings("com.canonical.Unity.Launcher", "/com/canonical/unity/launcher/");

276 Q_FOREACH(const QString &entry, gSettings.get("favorites").toStringList()) {

277 if (entry.startsWith("application://")) {

278 QString appId = entry;

279 // Transform "application://foobar.desktop" to "foobar"

280 appId.remove("application://");

281 if (appId.endsWith(".desktop")) {

282 appId.chop(8);

283 }

284 QString df = findDesktopFile(appId);

285

286 if (!df.isEmpty()) {

287 m_storedApps << appId;

288

289 if (!m_itemCache.contains(appId)) {

290 m_itemCache.insert(appId, parseDesktopFile(df));

291 }

292 }

293 }

294 }

295 } else {

296 for (const QVariant &app: apps) {

297 loadFromVariant(app.toMap());

298 }

299 }

300

301 Q_EMIT refreshApplications();

302}

303

304void LauncherBackend::syncToAccounts()

305{

306 if (m_accounts && !m_user.isEmpty()) {

307 QList<QVariantMap> items;

308

309 Q_FOREACH(const QString &appId, m_storedApps) {

310 items << itemToVariant(appId);

311 }

312

313 m_accounts->setUserProperty(m_user, "com.canonical.unity.AccountsService", "launcher-items", QVariant::fromValue(items));

314 }

315}

316

317QString LauncherBackend::findDesktopFile(const QString &appId) const

318{

319 int dashPos = -1;

320 QString helper = appId;

321

322 QStringList searchDirs = QStandardPaths::standardLocations(QStandardPaths::ApplicationsLocation);

323#ifdef LAUNCHER_TESTING

324 searchDirs << "";

325#endif

326

327 do {

328 if (dashPos != -1) {

329 helper = helper.replace(dashPos, 1, '/');

330 }

331

332 Q_FOREACH(const QString &searchDir, searchDirs) {

333 QFileInfo fileInfo(QDir(searchDir), helper + ".desktop");

334 if (fileInfo.exists()) {

335 return fileInfo.absoluteFilePath();

336 }

337 }

338

339 dashPos = helper.indexOf("-");

340 } while (dashPos != -1);

341

342 return QString();

343}

344

345LauncherBackendItem* LauncherBackend::parseDesktopFile(const QString &desktopFile) const

346{

347 QSettings settings(desktopFile, QSettings::IniFormat);

348

349 LauncherBackendItem* item = new LauncherBackendItem();

350 item->desktopFile = desktopFile;

351 item->displayName = settings.value("Desktop Entry/Name").toString();

352

353 QString iconString = settings.value("Desktop Entry/Icon").toString();

354 QString pathString = settings.value("Desktop Entry/Path").toString();

355 if (QFileInfo(iconString).exists()) {

356 item->icon = QFileInfo(iconString).absoluteFilePath();

357 } else if (QFileInfo(pathString + '/' + iconString).exists()) {

358 item->icon = pathString + '/' + iconString;

359 } else {

360 item->icon = "image://theme/" + iconString;

361 }

362

363 /* TODO: These should be looked up in a cache somewhere */

364 item->count = 0;

365 item->countVisible = false;

366

367 return item;

368}

369

370/* Gets an item, and tries to create a new one if we need it to */

371LauncherBackendItem* LauncherBackend::getItem(const QString &appId) const

372{

373 LauncherBackendItem *item = m_itemCache.value(appId, nullptr);

374 if (!item) {

375 QString df = findDesktopFile(appId);

376 if (!df.isEmpty()) {

377 item = parseDesktopFile(df);

378 if (item) {

379 m_itemCache[appId] = item;

380 } else {

381 qWarning() << "Unable to parse desktop file for" << appId << "path" << df;

382 }

383 } else {

384 qDebug() << "Unable to find desktop file for:" << appId;

385 }

386 }

387

388 if (!item)

389 qWarning() << "Unable to find item for: " << appId;

390

391 return item;

392}

393

394void LauncherBackend::loadFromVariant(const QVariantMap &details)

395{

396 if (!details.contains("id")) {

397 return;

398 }

399 QString appId = details.value("id").toString();

400

401 LauncherBackendItem *item = m_itemCache.value(appId, nullptr);

402 if (item) {

403 delete item;

404 }

405

406 item = new LauncherBackendItem();

407

408 item->desktopFile = details.value("desktopFile").toString();

409 item->displayName = details.value("name").toString();

410 item->icon = details.value("icon").toString();

411 item->count = details.value("count").toInt();

412 item->countVisible = details.value("countVisible").toBool();

413

414 m_itemCache.insert(appId, item);

415 m_storedApps.append(appId);

416}

417

418QVariantMap LauncherBackend::itemToVariant(const QString &appId) const

419{

420 LauncherBackendItem *item = m_itemCache.value(appId);

421 QVariantMap details;

422 details.insert("id", appId);

423 details.insert("name", item->displayName);

424 details.insert("icon", item->icon);

425 details.insert("desktopFile", item->desktopFile);

426 details.insert("count", item->count);

427 details.insert("countVisible", item->countVisible);

428 return details;

429}

430

431bool LauncherBackend::isDefaultsItem(const QList<QVariantMap> &apps) const

432{

433 // To differentiate between an empty list and a list that hasn't been set

434 // yet (and should thus be populated with the defaults), we use a special

435 // list of one item with the 'defaults' field set to true.

436 return (apps.size() == 1 && apps[0].value("defaults").toBool());

437}

438

439bool LauncherBackend::handleMessage(const QDBusMessage& message, const QDBusConnection& connection)

440{

441 /* Check to make sure we're getting properties on our interface */

442 if (message.type() != QDBusMessage::MessageType::MethodCallMessage) {

443 return false;

444 }

445 if (message.interface() != "org.freedesktop.DBus.Properties") {

446 return false;

447 }

448 if (message.arguments()[0].toString() != "com.canonical.Unity.Launcher.Item") {

449 return false;

450 }

451

452 /* Break down the path to just the app id */

453 QString pathtemp = message.path();

454 if (!pathtemp.startsWith("/com/canonical/Unity/Launcher/")) {

455 return false;

456 }

457 pathtemp.remove("/com/canonical/Unity/Launcher/");

458 if (pathtemp.indexOf('/') >= 0) {

459 return false;

460 }

461

462 /* Find ourselves an appid */

463 QString appid = decodeAppId(pathtemp);

464 QVariantList retval;

465

466 if (message.member() == "Get") {

467 if (message.arguments()[1].toString() == "count") {

468 retval.append(QVariant::fromValue(QDBusVariant(this->count(appid))));

469 } else if (message.arguments()[1].toString() == "countVisible") {

470 retval.append(QVariant::fromValue(QDBusVariant(this->countVisible(appid))));

471 }

472 } else if (message.member() == "Set") {

473 if (message.arguments()[1].toString() == "count") {

474 this->setCount(appid, message.arguments()[2].value<QDBusVariant>().variant().toInt());

475 } else if (message.arguments()[1].toString() == "countVisible") {

476 this->setCountVisible(appid, message.arguments()[2].value<QDBusVariant>().variant().toBool());

477 }

478 } else if (message.member() == "GetAll") {

479 retval.append(this->itemToVariant(appid));

480 } else {

481 return false;

482 }

483

484 QDBusMessage reply = message.createReply(retval);

485 return connection.send(reply);

486}

487

488QString LauncherBackend::introspect(const QString &path) const

489{

490 /* This case we should just list the nodes */

491 if (path == "/com/canonical/Unity/Launcher/" || path == "/com/canonical/Unity/Launcher") {

492 QString nodes;

493

494 Q_FOREACH(const QString &appId, m_itemCache.keys()) {

495 nodes.append("<node name=\"");

496 nodes.append(encodeAppId(appId));

497 nodes.append("\"/>\n");

498 }

499

500 return nodes;

501 }

502

503 /* Should not happen, but let's handle it */

504 if (!path.startsWith("/com/canonical/Unity/Launcher")) {

505 return "";

506 }

507

508 /* Now we should be looking at a node */

509 QString nodeiface =

510 "<interface name=\"com.canonical.Unity.Launcher.Item\">"

511 "<property name=\"count\" type=\"i\" access=\"readwrite\" />"

512 "<property name=\"countVisible\" type=\"b\" access=\"readwrite\" />"

513 "</interface>";

514 return nodeiface;

515}

516

517QString LauncherBackend::decodeAppId(const QString& path)

518{

519 QByteArray bytes = path.toUtf8();

520 QByteArray decoded;

521

522 for (int i = 0; i < bytes.size(); ++i) {

523 char chr = bytes.at(i);

524

525 if (chr == '_') {

526 QString number;

527 number.append(bytes.at(i+1));

528 number.append(bytes.at(i+2));

529

530 bool okay;

531 char newchar = number.toUInt(&okay, 16);

532 if (okay)

533 decoded.append(newchar);

534

535 i += 2;

536 } else {

537 decoded.append(chr);

538 }

539 }

540

541 return QString::fromUtf8(decoded);

542}

543

544QString LauncherBackend::encodeAppId(const QString& appId)

545{

546 QByteArray bytes = appId.toUtf8();

547 QString encoded;

548

549 for (int i = 0; i < bytes.size(); ++i) {

550 uchar chr = bytes.at(i);

551

552 if ((chr >= 'a' && chr <= 'z') ||

553 (chr >= 'A' && chr <= 'Z') ||

554 (chr >= '0' && chr <= '9'&& i != 0)) {

555 encoded.append(chr);

556 } else {

557 QString hexval = QString("_%1").arg(chr, 2, 16, QChar('0'));

558 encoded.append(hexval.toUpper());

559 }

560 }

561

562 return encoded;

563}

564

565void LauncherBackend::emitPropChangedDbus(const QString& appId, const QString& property, QVariant &value) const

566{

567 QString path("/com/canonical/Unity/Launcher/");

568 path.append(encodeAppId(appId));

569

570 QDBusMessage message = QDBusMessage::createSignal(path, "org.freedesktop.DBus.Properties", "PropertiesChanged");

571

572 QList<QVariant> arguments;

573 QVariantHash changedprops;

574 changedprops[property] = QVariant::fromValue(QDBusVariant(value));

575 QVariantList deletedprops;

576

577 arguments.append(changedprops);

578 arguments.append(deletedprops);

579

580 message.setArguments(arguments);

581

582 QDBusConnection con = QDBusConnection::sessionBus();

583 con.send(message);

584}