workspace/kmenuedit/menuinfo.cpp

   1 /*
   2  *   Copyright (C) 2003 Waldo Bastian <bastian@kde.org>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation; either version 2 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program; if not, write to the Free Software
  16  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  *
  18  */
  19
  20 #include "menuinfo.h"
  21 #include "menufile.h"
  22
  23 #include <QRegExp>
  24
  25 #include <kdesktopfile.h>
  26 #include <khotkeys.h>
  27 #include <kstandarddirs.h>
  28 #include <kconfiggroup.h>
  29
  30 //
  31 // MenuFolderInfo
  32 //
  33
  34 static QStringList *s_allShortcuts = 0;
  35 static QStringList *s_newShortcuts = 0;
  36 static QStringList *s_freeShortcuts = 0;
  37 static QStringList *s_deletedApps = 0;
  38
  39 // Add separator
  40 void MenuFolderInfo::add(MenuSeparatorInfo *info, bool initial)
  41 {
  42    if (initial)
  43       initialLayout.append(info);
  44 }
  45
  46 // Add sub menu
  47 void MenuFolderInfo::add(MenuFolderInfo *info, bool initial)
  48 {
  49    subFolders.append(info);
  50    if (initial)
  51       initialLayout.append(info);
  52 }
  53
  54 // Remove sub menu (without deleting it)
  55 void MenuFolderInfo::take(MenuFolderInfo *info)
  56 {
  57    subFolders.take(subFolders.findRef(info));
  58 }
  59
  60 // Remove sub menu (without deleting it)
  61 bool MenuFolderInfo::takeRecursive(MenuFolderInfo *info)
  62 {
  63    int i = subFolders.findRef(info);
  64    if (i >= 0)
  65    {
  66       subFolders.take(i);
  67       return true;
  68    }
  69
  70    for(MenuFolderInfo *subFolderInfo = subFolders.first();
  71        subFolderInfo; subFolderInfo = subFolders.next())
  72    {
  73       if (subFolderInfo->takeRecursive(info))
  74          return true;
  75    }
  76    return false;
  77 }
  78
  79 // Recursively update all fullIds
  80 void MenuFolderInfo::updateFullId(const QString &parentId)
  81 {
  82    fullId = parentId + id;
  83
  84    for(MenuFolderInfo *subFolderInfo = subFolders.first();
  85        subFolderInfo; subFolderInfo = subFolders.next())
  86    {
  87       subFolderInfo->updateFullId(fullId);
  88    }
  89 }
  90
  91 // Add entry
  92 void MenuFolderInfo::add(MenuEntryInfo *entry, bool initial)
  93 {
  94    entries.append(entry);
  95    if (initial)
  96       initialLayout.append(entry);
  97 }
  98
  99 // Remove entry
 100 void MenuFolderInfo::take(MenuEntryInfo *entry)
 101 {
 102    entries.removeRef(entry);
 103 }
 104
 105
 106 // Return a unique sub-menu caption inspired by @p caption
 107 QString MenuFolderInfo::uniqueMenuCaption(const QString &caption)
 108 {
 109    QRegExp r("(.*)(?=-\\d+)");
 110    QString cap = (r.indexIn(caption) > -1) ? r.cap(1) : caption;
 111
 112    QString result = caption;
 113
 114    for(int n = 1; ++n; )
 115    {
 116       bool ok = true;
 117       for(MenuFolderInfo *subFolderInfo = subFolders.first();
 118           subFolderInfo; subFolderInfo = subFolders.next())
 119       {
 120          if (subFolderInfo->caption == result)
 121          {
 122             ok = false;
 123             break;
 124          }
 125       }
 126       if (ok)
 127          return result;
 128
 129       result = cap + QString("-%1").arg(n);
 130    }
 131    return QString(); // Never reached
 132 }
 133
 134 // Return a unique item caption inspired by @p caption
 135 QString MenuFolderInfo::uniqueItemCaption(const QString &caption, const QString &exclude)
 136 {
 137    QRegExp r("(.*)(?=-\\d+)");
 138    QString cap = (r.indexIn(caption) > -1) ? r.cap(1) : caption;
 139
 140    QString result = caption;
 141
 142    for(int n = 1; ++n; )
 143    {
 144       bool ok = true;
 145       if (result == exclude)
 146          ok = false;
 147       MenuEntryInfo *entryInfo;
 148       for(Q3PtrListIterator<MenuEntryInfo> it(entries);
 149           ok && (entryInfo = it.current()); ++it)
 150       {
 151          if (entryInfo->caption == result)
 152             ok = false;
 153       }
 154       if (ok)
 155          return result;
 156
 157       result = cap + QString("-%1").arg(n);
 158    }
 159    return QString(); // Never reached
 160 }
 161
 162 // Return a list of existing submenu ids
 163 QStringList MenuFolderInfo::existingMenuIds()
 164 {
 165    QStringList result;
 166    for(MenuFolderInfo *subFolderInfo = subFolders.first();
 167        subFolderInfo; subFolderInfo = subFolders.next())
 168    {
 169        result.append(subFolderInfo->id);
 170    }
 171    return result;
 172 }
 173
 174 void MenuFolderInfo::setDirty()
 175 {
 176    dirty = true;
 177 }
 178
 179 void MenuFolderInfo::save(MenuFile *menuFile)
 180 {
 181    if (s_deletedApps)
 182    {
 183       // Remove hotkeys for applications that have been deleted
 184       for(QStringList::ConstIterator it = s_deletedApps->begin();
 185           it != s_deletedApps->end(); ++it)
 186       {
 187          KHotKeys::menuEntryDeleted(*it);
 188       }
 189       delete s_deletedApps;
 190       s_deletedApps = 0;
 191    }
 192
 193    if (dirty)
 194    {
 195       QString local = KDesktopFile::locateLocal(directoryFile);
 196
 197       KDesktopFile *df = 0;
 198       if (directoryFile != local)
 199       {
 200          KDesktopFile orig("apps", directoryFile);
 201          df = orig.copyTo(local);
 202       }
 203       else
 204       {
 205          df = new KDesktopFile("apps", directoryFile);
 206       }
 207
 208       KConfigGroup dg( df->desktopGroup() );
 209       dg.writeEntry("Name", caption);
 210       dg.writeEntry("GenericName", genericname);
 211       dg.writeEntry("Comment", comment);
 212       dg.writeEntry("Icon", icon);
 213       dg.sync();
 214       delete df;
 215       dirty = false;
 216    }
 217
 218    // Save sub-menus
 219    for(MenuFolderInfo *subFolderInfo = subFolders.first();
 220        subFolderInfo; subFolderInfo = subFolders.next())
 221    {
 222       subFolderInfo->save(menuFile);
 223    }
 224
 225    // Save entries
 226    MenuEntryInfo *entryInfo;
 227    for(Q3PtrListIterator<MenuEntryInfo> it(entries);
 228        (entryInfo = it.current()); ++it)
 229    {
 230       if (entryInfo->needInsertion())
 231          menuFile->addEntry(fullId, entryInfo->menuId());
 232       entryInfo->save();
 233    }
 234 }
 235
 236 bool MenuFolderInfo::hasDirt()
 237 {
 238    if (dirty) return true;
 239
 240    // Check sub-menus
 241    for(MenuFolderInfo *subFolderInfo = subFolders.first();
 242        subFolderInfo; subFolderInfo = subFolders.next())
 243    {
 244       if (subFolderInfo->hasDirt()) return true;
 245    }
 246
 247    // Check entries
 248    MenuEntryInfo *entryInfo;
 249    for(Q3PtrListIterator<MenuEntryInfo> it(entries);
 250        (entryInfo = it.current()); ++it)
 251    {
 252       if (entryInfo->dirty) return true;
 253       if (entryInfo->shortcutDirty) return true;
 254    }
 255    return false;
 256 }
 257
 258 KService::Ptr MenuFolderInfo::findServiceShortcut(const KShortcut&cut)
 259 {
 260    KService::Ptr result;
 261    // Check sub-menus
 262    for(MenuFolderInfo *subFolderInfo = subFolders.first();
 263        subFolderInfo; subFolderInfo = subFolders.next())
 264    {
 265       result = subFolderInfo->findServiceShortcut(cut);
 266       if (result)
 267           return result;
 268    }
 269
 270    // Check entries
 271    MenuEntryInfo *entryInfo;
 272    for(Q3PtrListIterator<MenuEntryInfo> it(entries);
 273        (entryInfo = it.current()); ++it)
 274    {
 275       if (entryInfo->shortCut == cut)
 276          return entryInfo->service;
 277    }
 278    return KService::Ptr();
 279 }
 280
 281 void MenuFolderInfo::setInUse(bool inUse)
 282 {
 283    // Propagate to sub-menus
 284    for(MenuFolderInfo *subFolderInfo = subFolders.first();
 285        subFolderInfo; subFolderInfo = subFolders.next())
 286    {
 287       subFolderInfo->setInUse(inUse);
 288    }
 289
 290    // Propagate to entries
 291    MenuEntryInfo *entryInfo;
 292    for(Q3PtrListIterator<MenuEntryInfo> it(entries);
 293        (entryInfo = it.current()); ++it)
 294    {
 295       entryInfo->setInUse(inUse);
 296    }
 297 }
 298
 299 //
 300 // MenuEntryInfo
 301 //
 302
 303 MenuEntryInfo::~MenuEntryInfo()
 304 {
 305    m_desktopFile->markAsClean();
 306    delete m_desktopFile;
 307 }
 308
 309 KDesktopFile *MenuEntryInfo::desktopFile()
 310 {
 311    if (!m_desktopFile)
 312    {
 313       m_desktopFile = new KDesktopFile(service->entryPath());
 314    }
 315    return m_desktopFile;
 316 }
 317
 318 void MenuEntryInfo::setDirty()
 319 {
 320    if (dirty) return;
 321
 322    dirty = true;
 323
 324    QString local = KStandardDirs::locateLocal("xdgdata-apps", service->menuId());
 325    if (local != service->entryPath())
 326    {
 327       KDesktopFile *oldDf = desktopFile();
 328       m_desktopFile = oldDf->copyTo(local);
 329       delete oldDf;
 330    }
 331 }
 332
 333 bool MenuEntryInfo::needInsertion()
 334 {
 335    // If entry is dirty and previously stored under applnk, then we need to be added explicitly
 336    return dirty && !service->entryPath().startsWith('/');
 337 }
 338
 339 void MenuEntryInfo::save()
 340 {
 341    if (dirty)
 342    {
 343       m_desktopFile->sync();
 344       dirty = false;
 345    }
 346
 347    if (shortcutDirty)
 348    {
 349       if( KHotKeys::present())
 350       {
 351          KHotKeys::changeMenuEntryShortcut( service->storageId(), shortCut.toString() );
 352       }
 353       shortcutDirty = false;
 354    }
 355 }
 356
 357 void MenuEntryInfo::setCaption(const QString &_caption)
 358 {
 359    if (caption == _caption)
 360       return;
 361    caption = _caption;
 362    setDirty();
 363    desktopFile()->desktopGroup().writeEntry("Name", caption);
 364 }
 365
 366 void MenuEntryInfo::setDescription(const QString &_description)
 367 {
 368     if (description == _description)
 369         return;
 370     description = _description;
 371     setDirty();
 372     desktopFile()->desktopGroup().writeEntry("GenericName", description);
 373 }
 374
 375 void MenuEntryInfo::setIcon(const QString &_icon)
 376 {
 377    if (icon == _icon)
 378       return;
 379
 380    icon = _icon;
 381    setDirty();
 382    desktopFile()->desktopGroup().writeEntry("Icon", icon);
 383 }
 384
 385 KShortcut MenuEntryInfo::shortcut()
 386 {
 387    if (!shortcutLoaded)
 388    {
 389       shortcutLoaded = true;
 390       if( KHotKeys::present())
 391       {
 392          shortCut = KShortcut(KHotKeys::getMenuEntryShortcut( service->storageId() ));
 393       }
 394    }
 395    return shortCut;
 396 }
 397
 398 static void freeShortcut(const KShortcut &shortCut)
 399 {
 400    if (!shortCut.isEmpty())
 401    {
 402       QString shortcutKey = shortCut.toString();
 403       if (s_newShortcuts)
 404          s_newShortcuts->removeAll(shortcutKey);
 405
 406       if (!s_freeShortcuts)
 407          s_freeShortcuts = new QStringList;
 408
 409       s_freeShortcuts->append(shortcutKey);
 410    }
 411 }
 412
 413 static void allocateShortcut(const KShortcut &shortCut)
 414 {
 415    if (!shortCut.isEmpty())
 416    {
 417       QString shortcutKey = shortCut.toString();
 418       if (s_freeShortcuts)
 419           s_freeShortcuts->removeAll(shortcutKey);
 420
 421       if (!s_newShortcuts)
 422          s_newShortcuts = new QStringList;
 423
 424       s_newShortcuts->append(shortcutKey);
 425    }
 426 }
 427
 428 void MenuEntryInfo::setShortcut(const KShortcut &_shortcut)
 429 {
 430    if (shortCut == _shortcut)
 431       return;
 432
 433    freeShortcut(shortCut);
 434    allocateShortcut(_shortcut);
 435
 436    shortCut = _shortcut;
 437    if (shortCut.isEmpty())
 438       shortCut = KShortcut(); // Normalize
 439
 440    shortcutLoaded = true;
 441    shortcutDirty = true;
 442 }
 443
 444 void MenuEntryInfo::setInUse(bool inUse)
 445 {
 446    if (inUse)
 447    {
 448       KShortcut temp = shortcut();
 449       shortCut = KShortcut();
 450       if (isShortcutAvailable(temp))
 451          shortCut = temp;
 452       else
 453          shortcutDirty = true;
 454       allocateShortcut(shortCut);
 455
 456       if (s_deletedApps)
 457          s_deletedApps->removeAll(service->storageId());
 458    }
 459    else
 460    {
 461       freeShortcut(shortcut());
 462
 463       // Add to list of deleted apps
 464       if (!s_deletedApps)
 465          s_deletedApps = new QStringList;
 466
 467       s_deletedApps->append(service->storageId());
 468    }
 469 }
 470
 471 bool MenuEntryInfo::isShortcutAvailable(const KShortcut &_shortcut)
 472 {
 473    if (shortCut == _shortcut)
 474       return true;
 475
 476    QString shortcutKey = _shortcut.toString();
 477    bool available = true;
 478    if (!s_allShortcuts)
 479    {
 480       s_allShortcuts = new QStringList(KHotKeys::allShortCuts());
 481    }
 482    available = !s_allShortcuts->contains(shortcutKey);
 483    if (available && s_newShortcuts)
 484    {
 485       available = !s_newShortcuts->contains(shortcutKey);
 486    }
 487    if (!available && s_freeShortcuts)
 488    {
 489       available = s_freeShortcuts->contains(shortcutKey);
 490    }
 491    return available;
 492 }