workspace/kcontrol/input/xcursor/thememodel.cpp

   1 /*
   2  * Copyright © 2005-2007 Fredrik Höglund <fredrik@kde.org>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License version 2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16  * Boston, MA 02110-1301, USA.
  17  */
  18
  19
  20 #include <KLocale>
  21 #include <KConfig>
  22 #include <KConfigGroup>
  23 #include <QStringList>
  24 #include <QDir>
  25
  26 #include "thememodel.h"
  27 #include "thememodel.moc"
  28 #include "xcursortheme.h"
  29 #include "legacytheme.h"
  30
  31 #include <X11/Xlib.h>
  32 #include <X11/Xcursor/Xcursor.h>
  33
  34 // Check for older version
  35 #if !defined(XCURSOR_LIB_MAJOR) && defined(XCURSOR_MAJOR)
  36 #  define XCURSOR_LIB_MAJOR     XCURSOR_MAJOR
  37 #  define XCURSOR_LIB_MINOR     XCURSOR_MINOR
  38 #endif
  39
  40
  41
  42 CursorThemeModel::CursorThemeModel(QObject *parent)
  43     : QAbstractTableModel(parent)
  44 {
  45     insertThemes();
  46 }
  47
  48 CursorThemeModel::~CursorThemeModel()
  49 {
  50    qDeleteAll(list);
  51    list.clear();
  52 }
  53
  54
  55 QVariant CursorThemeModel::headerData(int section, Qt::Orientation orientation, int role) const
  56 {
  57     // Only provide text for the headers
  58     if (role != Qt::DisplayRole)
  59         return QVariant();
  60
  61     // Horizontal header labels
  62     if (orientation == Qt::Horizontal)
  63     {
  64         switch (section)
  65         {
  66             case NameColumn:
  67                 return i18n("Name");
  68
  69             case DescColumn:
  70                 return i18n("Description");
  71
  72             default: return QVariant();
  73         }
  74     }
  75
  76     // Numbered vertical header lables
  77     return QString(section);
  78 }
  79
  80
  81 QVariant CursorThemeModel::data(const QModelIndex &index, int role) const
  82 {
  83     if (!index.isValid() || index.row() < 0 || index.row() >= list.count())
  84         return QVariant();
  85
  86     const CursorTheme *theme = list.at(index.row());
  87
  88     // Text label
  89     if (role == Qt::DisplayRole)
  90     {
  91         switch (index.column())
  92         {
  93             case NameColumn:
  94                 return theme->title();
  95
  96             case DescColumn:
  97                 return theme->description();
  98
  99             default: return QVariant();
 100         }
 101     }
 102
 103     // Description for the first name column
 104     if (role == CursorTheme::DisplayDetailRole && index.column() == NameColumn)
 105         return theme->description();
 106
 107     // Icon for the name column
 108     if (role == Qt::DecorationRole && index.column() == NameColumn)
 109         return theme->icon();
 110
 111     return QVariant();
 112 }
 113
 114
 115 void CursorThemeModel::sort(int column, Qt::SortOrder order)
 116 {
 117     Q_UNUSED(column);
 118     Q_UNUSED(order);
 119
 120     // Sorting of the model isn't implemented, as the KCM currently uses
 121     // a sorting proxy model.
 122 }
 123
 124
 125 const CursorTheme *CursorThemeModel::theme(const QModelIndex &index)
 126 {
 127     if (!index.isValid())
 128         return NULL;
 129
 130     if (index.row() < 0 || index.row() >= list.count())
 131         return NULL;
 132
 133     return list.at(index.row());
 134 }
 135
 136
 137 QModelIndex CursorThemeModel::findIndex(const QString &name)
 138 {
 139     uint hash = qHash(name);
 140
 141     for (int i = 0; i < list.count(); i++)
 142     {
 143         const CursorTheme *theme = list.at(i);
 144         if (theme->hash() == hash)
 145             return index(i, 0);
 146     }
 147
 148     return QModelIndex();
 149 }
 150
 151
 152 QModelIndex CursorThemeModel::defaultIndex()
 153 {
 154     return findIndex(defaultName);
 155 }
 156
 157
 158 const QStringList CursorThemeModel::searchPaths()
 159 {
 160     if (!baseDirs.isEmpty())
 161         return baseDirs;
 162
 163 #if XCURSOR_LIB_MAJOR == 1 && XCURSOR_LIB_MINOR < 1
 164     // These are the default paths Xcursor will scan for cursor themes
 165     QString path("~/.icons:/usr/share/icons:/usr/share/pixmaps:/usr/X11R6/lib/X11/icons");
 166
 167     // If XCURSOR_PATH is set, use that instead of the default path
 168     char *xcursorPath = std::getenv("XCURSOR_PATH");
 169     if (xcursorPath)
 170         path = xcursorPath;
 171 #else
 172     // Get the search path from Xcursor
 173     QString path = XcursorLibraryPath();
 174 #endif
 175
 176     // Separate the paths
 177     baseDirs = path.split(':', QString::SkipEmptyParts);
 178
 179     // Remove duplicates
 180     QMutableStringListIterator i(baseDirs);
 181     while (i.hasNext())
 182     {
 183         const QString path = i.next();
 184         QMutableStringListIterator j(i);
 185         while (j.hasNext())
 186             if (j.next() == path)
 187                 j.remove();
 188     }
 189
 190     // Expand all occurrences of ~/ to the home dir
 191     baseDirs.replaceInStrings(QRegExp("^~\\/"), QDir::home().path() + '/');
 192     return baseDirs;
 193 }
 194
 195
 196 bool CursorThemeModel::hasTheme(const QString &name) const
 197 {
 198     const uint hash = qHash(name);
 199
 200     foreach (const CursorTheme *theme, list)
 201         if (theme->hash() == hash)
 202             return true;
 203
 204     return false;
 205 }
 206
 207
 208 bool CursorThemeModel::isCursorTheme(const QString &theme, const int depth)
 209 {
 210     // Prevent infinite recursion
 211     if (depth > 10)
 212         return false;
 213
 214     // Search each icon theme directory for 'theme'
 215     foreach (const QString &baseDir, searchPaths())
 216     {
 217         QDir dir(baseDir);
 218         if (!dir.exists() || !dir.cd(theme))
 219             continue;
 220
 221         // If there's a cursors subdir, we'll assume this is a cursor theme
 222         if (dir.exists("cursors"))
 223             return true;
 224
 225         // If the theme doesn't have an index.theme file, it can't inherit any themes.
 226         if (!dir.exists("index.theme"))
 227             continue;
 228
 229         // Open the index.theme file, so we can get the list of inherited themes
 230         KConfig config(dir.path() + "/index.theme", KConfig::NoGlobals);
 231         KConfigGroup cg(&config, "Icon Theme");
 232
 233         // Recurse through the list of inherited themes, to check if one of them
 234         // is a cursor theme.
 235         QStringList inherits = cg.readEntry("Inherits", QStringList());
 236         foreach (const QString &inherit, inherits)
 237         {
 238             // Avoid possible DoS
 239             if (inherit == theme)
 240                 continue;
 241
 242             if (isCursorTheme(inherit, depth + 1))
 243                 return true;
 244         }
 245     }
 246
 247     return false;
 248 }
 249
 250
 251 bool CursorThemeModel::handleDefault(const QDir &themeDir)
 252 {
 253     QFileInfo info(themeDir.path());
 254
 255     // If "default" is a symlink
 256     if (info.isSymLink())
 257     {
 258         QFileInfo target(info.symLinkTarget());
 259         if (target.exists() && (target.isDir() || target.isSymLink()))
 260             defaultName = target.fileName();
 261
 262         return true;
 263     }
 264
 265     // If there's no cursors subdir, or if it's empty
 266     if (!themeDir.exists("cursors") || QDir(themeDir.path() + "/cursors")
 267           .entryList(QDir::Files | QDir::NoDotAndDotDot ).isEmpty())
 268     {
 269         if (themeDir.exists("index.theme"))
 270         {
 271             XCursorTheme theme(themeDir);
 272             if (!theme.inherits().isEmpty())
 273                 defaultName = theme.inherits().at(0);
 274         }
 275         return true;
 276     }
 277
 278     defaultName = QLatin1String("default");
 279     return false;
 280 }
 281
 282
 283 void CursorThemeModel::processThemeDir(const QDir &themeDir)
 284 {
 285     bool haveCursors = themeDir.exists("cursors");
 286
 287     // Special case handling of "default", since it's usually either a
 288     // symlink to another theme, or an empty theme that inherits another
 289     // theme.
 290     if (defaultName.isNull() && themeDir.dirName() == "default")
 291     {
 292         if (handleDefault(themeDir))
 293             return;
 294     }
 295
 296     // If the directory doesn't have a cursors subdir and lacks an
 297     // index.theme file it can't be a cursor theme.
 298     if (!themeDir.exists("index.theme") && !haveCursors)
 299         return;
 300
 301     // Create a cursor theme object for the theme dir
 302     XCursorTheme *theme = new XCursorTheme(themeDir);
 303
 304     // Skip this theme if it's hidden.
 305     if (theme->isHidden()) {
 306         delete theme;
 307         return;
 308     }
 309
 310     // If there's no cursors subdirectory we'll do a recursive scan
 311     // to check if the theme inherits a theme with one.
 312     if (!haveCursors)
 313     {
 314         bool foundCursorTheme = false;
 315
 316         foreach (const QString &name, theme->inherits())
 317             if (foundCursorTheme = isCursorTheme(name))
 318                 break;
 319
 320         if (!foundCursorTheme) {
 321             delete theme;
 322             return;
 323         }
 324     }
 325
 326     // Append the theme to the list
 327     list.append(theme);
 328 }
 329
 330
 331 void CursorThemeModel::insertThemes()
 332 {
 333     // Scan each base dir for Xcursor themes and add them to the list.
 334     foreach (const QString &baseDir, searchPaths())
 335     {
 336         QDir dir(baseDir);
 337         if (!dir.exists())
 338             continue;
 339
 340         // Process each subdir in the directory
 341         foreach (const QString &name, dir.entryList(QDir::Dirs | QDir::NoDotAndDotDot))
 342         {
 343             // Don't process the theme if a theme with the same name already exists
 344             // in the list. Xcursor will pick the first one it finds in that case,
 345             // and since we use the same search order, the one Xcursor picks should
 346             // be the one already in the list.
 347             if (hasTheme(name) || !dir.cd(name))
 348                 continue;
 349
 350             processThemeDir(dir);
 351             dir.cdUp(); // Return to the base dir
 352         }
 353     }
 354
 355     // Insert 'special' themes here
 356     CursorTheme *legacy = new LegacyTheme();
 357     list.append(legacy);
 358
 359     // The theme Xcursor will end up using if no theme is configured
 360     if (defaultName.isNull() || !hasTheme(defaultName))
 361         defaultName = legacy->name();
 362 }
 363
 364
 365 bool CursorThemeModel::addTheme(const QDir &dir)
 366 {
 367     XCursorTheme *theme = new XCursorTheme(dir);
 368
 369     // Don't add the theme to the list if it's hidden
 370     if (theme->isHidden()) {
 371         delete theme;
 372         return false;
 373     }
 374
 375     // ### If the theme is hidden, the user will probably find it strange that it
 376     //     doesn't appear in the list view. There also won't be a way for the user
 377     //     to delete the theme using the KCM. Perhaps a warning about this should
 378     //     be issued, and the user be given a chance to undo the installation.
 379
 380     // If an item with the same name already exists in the list,
 381     // we'll remove it before inserting the new one.
 382     for (int i = 0; i < list.count(); i++)
 383     {
 384         if (list.at(i)->hash() == theme->hash()) {
 385             removeTheme(index(i, 0));
 386             break;
 387         }
 388     }
 389
 390     // Append the theme to the list
 391     beginInsertRows(QModelIndex(), rowCount(), rowCount());
 392     list.append(theme);
 393     endInsertRows();
 394
 395     return true;
 396 }
 397
 398
 399 void CursorThemeModel::removeTheme(const QModelIndex &index)
 400 {
 401     if (!index.isValid())
 402         return;
 403
 404     beginRemoveRows(QModelIndex(), index.row(), index.row());
 405     delete list.takeAt(index.row());
 406     endRemoveRows();
 407 }
 408