workspace/libs/plasma/packagemetadata.cpp

   1 /******************************************************************************
   2 *   Copyright 2007 by Riccardo Iaconelli  <riccardo@kde.org>                *
   3 *                                                                             *
   4 *   This library is free software; you can redistribute it and/or             *
   5 *   modify it under the terms of the GNU Library General Public               *
   6 *   License as published by the Free Software Foundation; either              *
   7 *   version 2 of the License, or (at your option) any later version.          *
   8 *                                                                             *
   9 *   This library 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 GNU          *
  12 *   Library General Public License for more details.                          *
  13 *                                                                             *
  14 *   You should have received a copy of the GNU Library General Public License *
  15 *   along with this library; see the file COPYING.LIB.  If not, write to      *
  16 *   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,      *
  17 *   Boston, MA 02110-1301, USA.                                               *
  18 *******************************************************************************/
  19
  20 #include <packagemetadata.h>
  21
  22 #include <QDir>
  23
  24 #include <KConfigGroup>
  25 #include <KDesktopFile>
  26
  27 namespace Plasma
  28 {
  29
  30 class PackageMetadata::Private
  31 {
  32     public:
  33         QString name;
  34         QString description;
  35         QString author;
  36         QString email;
  37         QString version;
  38         QString website;
  39         QString license;
  40         QString app;
  41         QString requiredVersion;
  42         QString pluginName;
  43         QString type;
  44         QString serviceType;
  45         QString language;
  46 };
  47
  48 PackageMetadata::PackageMetadata()
  49     : d(new Private)
  50 {
  51 }
  52
  53 PackageMetadata::PackageMetadata(const QString& path)
  54     : d(new Private)
  55 {
  56     read(path);
  57 }
  58
  59 PackageMetadata::~PackageMetadata()
  60 {
  61     delete d;
  62 }
  63
  64 bool PackageMetadata::isComplete() const
  65 {
  66     return ! (d->name.isEmpty() ||
  67               d->author.isEmpty() ||
  68               d->version.isEmpty() ||
  69               d->license.isEmpty() ||
  70               d->app.isEmpty() ||
  71               d->type.isEmpty());
  72 }
  73
  74 void PackageMetadata::write(const QString &filename, const QString &icon) const
  75 {
  76     KDesktopFile cfg(filename);
  77     KConfigGroup config = cfg.desktopGroup();
  78     config.writeEntry("Encoding", "UTF-8");
  79
  80     //TODO: this will be a problem for localized names?
  81     config.writeEntry("Name", d->name);
  82     config.writeEntry("Comment", d->description);
  83     if (!icon.isNull()) {
  84         config.writeEntry("Icon", icon);
  85     }
  86     config.writeEntry("X-KDE-ServiceTypes", d->serviceType);
  87     config.writeEntry("X-KDE-PluginInfo-Name", d->pluginName);
  88     config.writeEntry("X-KDE-PluginInfo-Author", d->author);
  89     config.writeEntry("X-KDE-PluginInfo-Email", d->email);
  90     config.writeEntry("X-KDE-PluginInfo-Version", d->version);
  91     config.writeEntry("X-KDE-PluginInfo-Website", d->website);
  92     config.writeEntry("X-KDE-PluginInfo-License", d->license);
  93     config.writeEntry("X-KDE-PluginInfo-Category", d->type);
  94     config.writeEntry("X-Plasma-Language", d->language);
  95     config.writeEntry("X-KDE-Plasmagik-ApplicationName", d->app);
  96     config.writeEntry("X-KDE-Plasmagik-RequiredVersion", d->requiredVersion);
  97 }
  98
  99 void PackageMetadata::read(const QString& filename)
 100 {
 101     KConfig cfg(filename);
 102     KConfigGroup config(&cfg, "Desktop Entry");
 103
 104     //TODO: this will be a problem for localized names?
 105     d->name = config.readEntry("X-KDE-PluginInfo-Name", d->name);
 106     d->description = config.readEntry("Description", d->description);
 107     d->serviceType = config.readEntry("X-KDE-ServiceTypes", d->serviceType);
 108     d->author = config.readEntry("X-KDE-PluginInfo-Author", d->author);
 109     d->email = config.readEntry("X-KDE-PluginInfo-Email", d->email);
 110     d->version = config.readEntry("X-KDE-PluginInfo-Version", d->version);
 111     d->website = config.readEntry("X-KDE-PluginInfo-Website", d->website);
 112     d->license = config.readEntry("X-KDE-PluginInfo-License", d->license);
 113     d->type = config.readEntry("X-KDE-PluginInfo-Category", d->type);
 114     d->app = config.readEntry("X-KDE-Plasmagik-ApplicationName", d->app);
 115     d->requiredVersion = config.readEntry("X-KDE-Plasmagik-RequiredVersion", d->requiredVersion);
 116 }
 117
 118 QString PackageMetadata::name() const
 119 {
 120     return d->name;
 121 }
 122
 123 QString PackageMetadata::description() const
 124 {
 125     return d->description;
 126 }
 127
 128 QString PackageMetadata::serviceType() const
 129 {
 130     return d->serviceType;
 131 }
 132
 133 QString PackageMetadata::author() const
 134 {
 135     return d->author;
 136 }
 137
 138 QString PackageMetadata::email() const
 139 {
 140     return d->email;
 141 }
 142
 143 QString PackageMetadata::version() const
 144 {
 145     return d->version;
 146 }
 147
 148 QString PackageMetadata::website() const
 149 {
 150     return d->website;
 151 }
 152
 153 QString PackageMetadata::license() const
 154 {
 155     return d->license;
 156 }
 157
 158 QString PackageMetadata::application() const
 159 {
 160     return d->app;
 161 }
 162
 163 QString PackageMetadata::requiredVersion() const
 164 {
 165     return d->requiredVersion;
 166 }
 167
 168 QString PackageMetadata::type() const
 169 {
 170     return d->type;
 171 }
 172
 173 QString PackageMetadata::implementationLanguage() const
 174 {
 175     return d->language;
 176 }
 177
 178 void PackageMetadata::setImplementationLanguage(const QString& language)
 179 {
 180     d->language = language;
 181 }
 182
 183 QString PackageMetadata::pluginName() const
 184 {
 185     return d->pluginName;
 186 }
 187
 188 void PackageMetadata::setPluginName(const QString &pluginName)
 189 {
 190     d->pluginName = pluginName;
 191 }
 192
 193 void PackageMetadata::setName(const QString &name)
 194 {
 195     d->name = name;
 196 }
 197
 198 void PackageMetadata::setDescription(const QString &description)
 199 {
 200     d->description = description;
 201 }
 202
 203 void PackageMetadata::setServiceType(const QString &serviceType)
 204 {
 205     d->serviceType = serviceType;
 206 }
 207
 208 void PackageMetadata::setAuthor(const QString &author)
 209 {
 210     d->author = author;
 211 }
 212
 213 void PackageMetadata::setEmail(const QString &email)
 214 {
 215     d->email = email;
 216 }
 217
 218 void PackageMetadata::setVersion(const QString &version)
 219 {
 220     d->version = version;
 221 }
 222
 223 void PackageMetadata::setWebsite(const QString &website)
 224 {
 225     d->website = website;
 226 }
 227
 228 void PackageMetadata::setLicense(const QString &license)
 229 {
 230     d->license = license;
 231 }
 232
 233 void PackageMetadata::setApplication(const QString &application)
 234 {
 235     d->app = application;
 236 }
 237
 238 void PackageMetadata::setRequiredVersion(const QString &requiredVersion)
 239 {
 240     d->requiredVersion = requiredVersion;
 241 }
 242
 243 void PackageMetadata::setType(const QString& type)
 244 {
 245     d->type = type;
 246 }
 247
 248 } // namespace Plasma
 249
 250