runtime/kioslave/settings/kio_settings.cpp

   1 /* This file is part of the KDE project
   2    Copyright (C) 2003 Joseph Wenninger <jowenn@kde.org>
   3    Copyright (C) 2008 David Faure <faure@kde.org>
   4
   5    This library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public
   7    License as published by the Free Software Foundation; either
   8    version 2 of the License, or (at your option) any later version.
   9
  10    This library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public License
  16    along with this library; see the file COPYING.LIB.  If not, write to
  17    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18    Boston, MA 02110-1301, USA.
  19 */
  20
  21 #include <kservicetypetrader.h>
  22 #include <kio/slavebase.h>
  23 #include <kcomponentdata.h>
  24 #include <kdebug.h>
  25 #include <klocale.h>
  26 #include <sys/stat.h>
  27 #include <time.h>
  28 #include <kservice.h>
  29 #include <kservicegroup.h>
  30 #include <kstandarddirs.h>
  31
  32 class SettingsProtocol : public KIO::SlaveBase
  33 {
  34 public:
  35     SettingsProtocol(const QByteArray &protocol, const QByteArray &pool, const QByteArray &app);
  36     virtual ~SettingsProtocol();
  37     virtual void get( const KUrl& url );
  38     virtual void stat(const KUrl& url);
  39     virtual void listDir(const KUrl& url);
  40
  41 private:
  42     void initSettingsData();
  43
  44 private:
  45     bool m_settingsDataLoaded;
  46     KService::List m_modules;
  47     QHash<QString, KService::Ptr> m_settingsServiceLookup;
  48     KService::List m_categories;
  49     QHash<QString, KService::Ptr> m_categoryLookup;
  50 };
  51
  52 extern "C" {
  53     KDE_EXPORT int kdemain( int, char **argv )
  54     {
  55         kDebug() << "kdemain for settings kioslave";
  56         KComponentData componentData( "kio_settings" );
  57         SettingsProtocol slave(argv[1], argv[2], argv[3]);
  58         slave.dispatchLoop();
  59         return 0;
  60     }
  61 }
  62
  63 static void createFileEntry(KIO::UDSEntry& entry, const KService::Ptr& service)
  64 {
  65     entry.clear();
  66     entry.insert(KIO::UDSEntry::UDS_NAME, KIO::encodeFileName(service->desktopEntryName()));
  67     entry.insert(KIO::UDSEntry::UDS_DISPLAY_NAME, service->name()); // translated name
  68     entry.insert(KIO::UDSEntry::UDS_FILE_TYPE, S_IFREG);
  69     entry.insert(KIO::UDSEntry::UDS_ACCESS, 0500);
  70     entry.insert(KIO::UDSEntry::UDS_MIME_TYPE, "application/x-desktop");
  71     entry.insert(KIO::UDSEntry::UDS_SIZE, 0);
  72     entry.insert(KIO::UDSEntry::UDS_LOCAL_PATH, KStandardDirs::locate("services", service->entryPath()));
  73     entry.insert(KIO::UDSEntry::UDS_MODIFICATION_TIME, time(0));
  74     entry.insert(KIO::UDSEntry::UDS_ICON_NAME, service->icon());
  75 }
  76
  77 static void createDirEntry(KIO::UDSEntry& entry, const QString& name, const QString& iconName)
  78 {
  79     entry.clear();
  80     entry.insert( KIO::UDSEntry::UDS_NAME, name );
  81     entry.insert( KIO::UDSEntry::UDS_FILE_TYPE, S_IFDIR );
  82     entry.insert( KIO::UDSEntry::UDS_ACCESS, 0500 );
  83     entry.insert( KIO::UDSEntry::UDS_MIME_TYPE, "inode/directory" );
  84     entry.insert( KIO::UDSEntry::UDS_ICON_NAME, iconName );
  85 }
  86
  87 SettingsProtocol::SettingsProtocol( const QByteArray &protocol, const QByteArray &pool, const QByteArray &app)
  88     : SlaveBase( protocol, pool, app ),
  89       m_settingsDataLoaded(false)
  90 {
  91 }
  92
  93 SettingsProtocol::~SettingsProtocol()
  94 {
  95 }
  96
  97 void SettingsProtocol::initSettingsData()
  98 {
  99     if (m_settingsDataLoaded)
 100         return;
 101
 102     // The code for settings:/ was inspired by kdebase/workspace/systemsettings/mainwindow.cpp readMenu().
 103
 104     m_modules = KServiceTypeTrader::self()->query("KCModule");
 105     m_categories = KServiceTypeTrader::self()->query("SystemSettingsCategory");
 106
 107     for (int i = 0; i < m_categories.size(); ++i) {
 108         const KService::Ptr service = m_categories.at(i);
 109         const QString category = service->property("X-KDE-System-Settings-Category").toString();
 110         m_categoryLookup.insert(category, service);
 111     }
 112     for (int i = 0; i < m_modules.size(); ++i) {
 113         const KService::Ptr service = m_modules.at(i);
 114         // Since modules have a unique name, we can just look them up by name,
 115         // no need to create a real hierarchical structure just for stat().
 116         //const QString category = service->property("X-KDE-System-Settings-Parent-Category").toString();
 117         m_settingsServiceLookup.insert(service->desktopEntryName(), service);
 118     }
 119 }
 120
 121 void SettingsProtocol::stat(const KUrl& url)
 122 {
 123     initSettingsData();
 124     const QString fileName = url.fileName();
 125     kDebug() << fileName;
 126
 127     KIO::UDSEntry entry;
 128     // Root dir?
 129     if (fileName.isEmpty()) {
 130         createDirEntry(entry, ".", "preferences-system");
 131         statEntry(entry);
 132         finished();
 133         return;
 134     }
 135
 136     // Is it a category?
 137     QHash<QString, KService::Ptr>::const_iterator it = m_categoryLookup.constFind(fileName);
 138     if (it != m_categoryLookup.constEnd()) {
 139         const KService::Ptr service = it.value();
 140         QString parentCategory = service->property("X-KDE-System-Settings-Parent-Category").toString();
 141         QString category = service->property("X-KDE-System-Settings-Category").toString();
 142         //kDebug() << "category" << service->desktopEntryName() << service->name() << "category=" << category << "parentCategory=" << parentCategory;
 143         createDirEntry(entry, category, service->icon());
 144         entry.insert(KIO::UDSEntry::UDS_DISPLAY_NAME, service->name());
 145         statEntry(entry);
 146         finished();
 147         return;
 148     } else {
 149         // Is it a config module?
 150         it = m_settingsServiceLookup.constFind(fileName);
 151         if (it != m_settingsServiceLookup.constEnd()) {
 152             const KService::Ptr service = it.value();
 153             createFileEntry(entry, service);
 154             statEntry(entry);
 155             finished();
 156             return;
 157         }
 158     }
 159
 160     error(KIO::ERR_DOES_NOT_EXIST, url.url());
 161 }
 162
 163 void SettingsProtocol::listDir(const KUrl& url)
 164 {
 165     initSettingsData();
 166     QString fileName = url.fileName();
 167     if (!fileName.isEmpty() && !m_categoryLookup.contains(fileName)) {
 168         error(KIO::ERR_DOES_NOT_EXIST, fileName);
 169         return;
 170     }
 171
 172     unsigned int count = 0;
 173     KIO::UDSEntry entry;
 174
 175     // scan for any categories at this level and add them
 176     for (int i = 0; i < m_categories.size(); ++i) {
 177         const KService::Ptr service = m_categories.at(i);
 178         QString parentCategory = service->property("X-KDE-System-Settings-Parent-Category").toString();
 179         QString category = service->property("X-KDE-System-Settings-Category").toString();
 180         //kDebug() << "category" << service->desktopEntryName() << service->name() << "category=" << category << "parentCategory=" << parentCategory;
 181         if (parentCategory == fileName) {
 182             //KUrl dirUrl = url;
 183             //dirUrl.addPath(category);
 184             createDirEntry(entry, category, service->icon());
 185             entry.insert(KIO::UDSEntry::UDS_DISPLAY_NAME, service->name());
 186             listEntry(entry, false);
 187             ++count;
 188         }
 189     }
 190
 191     // scan for any modules at this level and add them
 192     for (int i = 0; i < m_modules.size(); ++i) {
 193         const KService::Ptr service = m_modules.at(i);
 194         const QString category = service->property("X-KDE-System-Settings-Parent-Category").toString();
 195         if (!fileName.isEmpty() && category == fileName) {
 196             createFileEntry(entry, service);
 197             listEntry(entry, false);
 198             ++count;
 199         }
 200     }
 201
 202     totalSize(count);
 203     listEntry(entry, true);
 204     finished();
 205 }
 206
 207 void SettingsProtocol::get( const KUrl & url )
 208 {
 209     KService::Ptr service = KService::serviceByDesktopName(url.fileName());
 210     if (service && service->isValid()) {
 211         KUrl redirUrl;
 212         redirUrl.setPath(KStandardDirs::locate("services", service->entryPath()));
 213         redirection(redirUrl);
 214         finished();
 215     } else {
 216         error( KIO::ERR_IS_DIRECTORY, url.prettyUrl() );
 217     }
 218 }