shell/profileengine.cpp

   1 /***************************************************************************
   2  *   Copyright 2004 Alexander Dymo <adymo@kdevelop.org>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU Library General Public License as       *
   6  *   published by the Free Software Foundation; either version 2 of the    *
   7  *   License, or (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 Library General Public     *
  15  *   License along with this program; if not, write to the                 *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  18  ***************************************************************************/
  19 #include "profileengine.h"
  20
  21 #include <QtCore/QDir>
  22
  23 #include <kurl.h>
  24 #include <kdebug.h>
  25 #include <kglobal.h>
  26 #include <kstandarddirs.h>
  27
  28 #include <interfaces/iplugin.h>
  29 #include "plugincontroller.h"
  30
  31 namespace KDevelop
  32 {
  33
  34 class ProfileEnginePrivate
  35 {
  36 public:
  37     Profile *m_rootProfile;
  38 };
  39
  40 ProfileEngine::ProfileEngine()
  41     : d(new ProfileEnginePrivate)
  42 {
  43     QStringList dirs = KGlobal::dirs()->findDirs("data", "kdevplatform/profiles");
  44
  45     d->m_rootProfile = new Profile(0, "KDevelop");
  46
  47     QString currPath = "/";
  48     QMap<QString, Profile*> passedPaths;
  49
  50     for (QStringList::const_iterator it = dirs.constBegin(); it != dirs.constEnd(); ++it)
  51         processDir(*it, currPath, passedPaths, d->m_rootProfile);
  52 }
  53
  54 ProfileEngine::~ProfileEngine()
  55 {
  56     delete d->m_rootProfile;
  57 }
  58
  59 void ProfileEngine::processDir(const QString &dir, const QString &currPath, QMap<QString, Profile*> &passedPaths, Profile *root)
  60 {
  61 //     kDebug() << "processDir:" << dir << "" << currPath;
  62
  63     QDir qDir(dir);
  64     QStringList entryList = qDir.entryList(QDir::Dirs);
  65     for (QStringList::const_iterator eit = entryList.constBegin(); eit != entryList.constEnd(); ++eit)
  66     {
  67         if ((*eit != "..") && (*eit != "."))
  68         {
  69             QString dirName = *eit;
  70             Profile *profile = 0;
  71             if (passedPaths.contains(currPath + dirName))
  72                 profile = passedPaths[currPath + dirName];
  73             else
  74             {
  75                 profile = new Profile(root, dirName);
  76                 passedPaths[currPath + dirName] = profile;
  77             }
  78             processDir(dir + *eit + '/', currPath + dirName, passedPaths, profile);
  79         }
  80     }
  81 }
  82
  83 KPluginInfo::List ProfileEngine::offers(const QString &profileName, PluginController::PluginType offerType)
  84 {
  85     ProfileListing listing;
  86     Profile *profile = 0;
  87     getProfileWithListing(listing, &profile, profileName);
  88
  89     if (!profile)
  90         return KPluginInfo::List();
  91
  92     QString constraint = QString::fromLatin1("[X-KDevelop-Version] == %1").arg(KDEVELOP_PLUGIN_VERSION);
  93     switch (offerType) {
  94         case PluginController::Global:
  95             constraint += QString::fromLatin1(" and ( [X-KDevelop-Category] == 'Global'");
  96             constraint += QString::fromLatin1(" or [X-KDevelop-Category] == 'Core')");
  97             break;
  98         case PluginController::Project:
  99             constraint += QString::fromLatin1(" and [X-KDevelop-Category] == 'Project'");
 100             break;
 101     }
 102     QString constraint_add = "";
 103     Profile::EntryList properties = profile->list(Profile::Properties);
 104     int i = 0;
 105     for (Profile::EntryList::const_iterator it = properties.begin(); it != properties.end(); ++it)
 106         constraint_add += QString::fromLatin1(" %1 '%2' in [X-KDevelop-Properties]").
 107             arg((i++)==0?"":"or").arg((*it).name);
 108     if (!constraint_add.isEmpty())
 109         constraint += " and ( " + constraint_add + " ) ";
 110
 111 // //BEGIN debug
 112 //     kDebug() << "Query for Profile:" << endl
 113 //               << constraint << endl << endl;
 114 // //END debug
 115
 116     KService::List list = KServiceTypeTrader::self()->query(QString::fromLatin1("KDevelop/Plugin"), constraint);
 117     QStringList names;
 118
 119     Profile::EntryList disableList = profile->list(Profile::ExplicitDisable);
 120 //     for (KServiceOfferList::iterator it = list.begin(); it != list.end(); ++it)
 121     KService::List::iterator it = list.begin();
 122     while (it != list.end())
 123     {
 124         QString name = (*it)->desktopEntryName();
 125         names.append(name);
 126         if (profile->hasInEntryList(disableList, name))
 127         {
 128             it = list.erase(it);
 129             continue;
 130         }
 131         ++it;
 132     }
 133
 134     Profile::EntryList enableList = profile->list(Profile::ExplicitEnable);
 135     for (Profile::EntryList::const_iterator it = enableList.begin(); it != enableList.end(); ++it)
 136     {
 137         if (names.contains((*it).name))
 138             continue;
 139         QString constraint = QString::fromLatin1("[X-KDevelop-Version] == %1").arg(KDEVELOP_PLUGIN_VERSION);
 140         constraint += QString::fromLatin1("and [X-KDE-PluginInfo-Name] == '%1'").arg((*it).name);
 141         KService::List enable = KServiceTypeTrader::self()->query(QString::fromLatin1("KDevelop/Plugin"), constraint);
 142         list += enable;
 143     }
 144
 145 //BEGIN debug
 146 //     kDebug() << "=============" << endl
 147 //         << " =============" << endl
 148 //         << "     =============   Plugins for Profile:" << endl;
 149 //     for (KService::List::const_iterator it = list.begin(); it != list.end(); ++it)
 150 //         kDebug() << "  " << (*it)->name();
 151 //     kDebug();
 152 //END debug
 153     KPluginInfo::List pluginList = KPluginInfo::fromServices( list );
 154     return pluginList;
 155 }
 156
 157 KPluginInfo::List ProfileEngine::allOffers(PluginController::PluginType offerType)
 158 {
 159     QString constraint = QString::fromLatin1("[X-KDevelop-Version] == %1").arg(KDEVELOP_PLUGIN_VERSION);
 160     switch (offerType) {
 161         case PluginController::Global: //core and global have been combined
 162             constraint += QLatin1String(" and ( [X-KDevelop-Category] == 'Global'");
 163             constraint += QLatin1String(" or [X-KDevelop-Category] == 'Core' )");
 164             break;
 165         case PluginController::Project:
 166             constraint += QString::fromLatin1(" and [X-KDevelop-Category] == 'Project'");
 167             break;
 168     }
 169     KService::List list = KServiceTypeTrader::self()->query(QString::fromLatin1("KDevelop/Plugin"), constraint);
 170     KPluginInfo::List pluginList = KPluginInfo::fromServices( list );
 171     return pluginList;
 172 }
 173
 174 void ProfileEngine::getProfileWithListing(ProfileListing &listing, Profile **profile,
 175     const QString &profileName)
 176 {
 177     if (profileName == "KDevelop")
 178         *profile = d->m_rootProfile;
 179     else
 180     {
 181         walkProfiles<ProfileListing>(listing, d->m_rootProfile);
 182         *profile = listing.profiles[profileName];
 183     }
 184 }
 185
 186 KUrl::List ProfileEngine::resources(const QString &profileName, const QString &nameFilter)
 187 {
 188     ProfileListing listing;
 189     Profile *profile = 0;
 190     getProfileWithListing(listing, &profile, profileName);
 191
 192     if (!profile)
 193         return KUrl::List();
 194
 195     return resources(profile, nameFilter);
 196 }
 197
 198 KUrl::List ProfileEngine::resources(Profile *profile, const QString &nameFilter)
 199 {
 200     return profile->resources(nameFilter);
 201 }
 202
 203 KUrl::List ProfileEngine::resourcesRecursive(const QString &profileName, const QString &nameFilter)
 204 {
 205     ProfileListing listing;
 206     Profile *profile = 0;
 207     getProfileWithListing(listing, &profile, profileName);
 208     KUrl::List resources = profile->resources(nameFilter);
 209
 210     ProfileListingEx listingEx(nameFilter);
 211     walkProfiles<ProfileListingEx>(listingEx, profile);
 212
 213     resources += listingEx.resourceList;
 214     return resources;
 215 }
 216
 217 void ProfileEngine::diffProfiles(PluginController::PluginType offerType, const QString &profile1,
 218     const QString &profile2, QStringList &unload, KPluginInfo::List &load)
 219 {
 220     KPluginInfo::List offers1 = offers(profile1, offerType);
 221     KPluginInfo::List offers2 = offers(profile2, offerType);
 222
 223     QStringList offers1List;
 224     for (KPluginInfo::List::const_iterator it = offers1.constBegin();
 225         it != offers1.constEnd(); ++it)
 226         offers1List.append(it->entryPath());
 227     QMap<QString, KPluginInfo> offers2List;
 228
 229     for (KPluginInfo::List::const_iterator it = offers2.constBegin();
 230         it != offers2.constEnd(); ++it)
 231         offers2List[it->entryPath()] = *it;
 232
 233 //    kDebug() << "OLD PROFILE:" << offers1List;
 234 //    kDebug() << "NEW PROFILE:" << offers2List;
 235
 236     for (QStringList::const_iterator it = offers1List.constBegin();
 237         it != offers1List.constEnd(); ++it)
 238     {
 239 //         kDebug() << "checking:" << *it;
 240         if (offers2List.contains(*it))
 241         {
 242 //             kDebug() << " keep";
 243             offers2.removeAll(offers2List[*it]);
 244         }
 245         else
 246         {
 247 //             kDebug() << " unload";
 248             unload.append(*it);
 249         }
 250     }
 251     load = offers2;
 252 }
 253
 254 Profile *ProfileEngine::findProfile(const QString & profileName)
 255 {
 256     Profile *profile;
 257     ProfileListing listing;
 258     getProfileWithListing(listing, &profile, profileName);
 259     return profile;
 260 }
 261
 262 void ProfileEngine::addResource(const QString &profileName, const KUrl &url)
 263 {
 264     ProfileListing listing;
 265     Profile *profile = 0;
 266     getProfileWithListing(listing, &profile, profileName);
 267
 268     if (!profile)
 269         return;
 270
 271     profile->addResource(url);
 272 }
 273
 274 Profile *ProfileEngine::rootProfile() const
 275 {
 276     return d->m_rootProfile;
 277 }
 278
 279 }