kio/kio/kdatatool.cpp

   1 /* This file is part of the KDE project
   2    Copyright (C) 1998, 1999, 2000 Torben Weis <weis@kde.org>
   3    Copyright (C) 2001 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 "kdatatool.h"
  22
  23 #include <kstandarddirs.h>
  24 #include <kdebug.h>
  25 #include <kicon.h>
  26 #include <kcomponentdata.h>
  27 #include <ktoggleaction.h>
  28 #include <kactioncollection.h>
  29 #include <kactionmenu.h>
  30
  31 #include <kservicetypetrader.h>
  32
  33 #include <QtGui/QPixmap>
  34 #include <QtCore/QFile>
  35
  36 /*************************************************
  37  *
  38  * KDataToolInfo
  39  *
  40  *************************************************/
  41 class KDataToolInfo::KDataToolInfoPrivate
  42 {
  43 public:
  44     KDataToolInfoPrivate()
  45      : service(0)
  46     {}
  47
  48     KService::Ptr service;
  49     KComponentData componentData;
  50 };
  51
  52 KDataToolInfo::KDataToolInfo()
  53     : d(new KDataToolInfoPrivate)
  54 {
  55 }
  56
  57 KDataToolInfo::KDataToolInfo(const KService::Ptr& service, const KComponentData &componentData)
  58     : d(new KDataToolInfoPrivate)
  59 {
  60     d->service = service;
  61     d->componentData = componentData;
  62
  63     if ( !d->service && !d->service->serviceTypes().contains( "KDataTool" ) )
  64     {
  65         kDebug(30003) << "The service" << d->service->name()
  66                        << "does not feature the service type KDataTool";
  67         d->service = 0;
  68     }
  69 }
  70
  71 KDataToolInfo::KDataToolInfo( const KDataToolInfo& info )
  72     : d(new KDataToolInfoPrivate)
  73 {
  74     d->service = info.service();
  75     d->componentData = info.componentData();
  76 }
  77
  78 KDataToolInfo& KDataToolInfo::operator= ( const KDataToolInfo& info )
  79 {
  80     d->service = info.service();
  81     d->componentData = info.componentData();
  82     return *this;
  83 }
  84
  85 KDataToolInfo::~KDataToolInfo()
  86 {
  87     delete d;
  88 }
  89
  90 QString KDataToolInfo::dataType() const
  91 {
  92     if ( !d->service )
  93         return QString();
  94
  95     return d->service->property( "DataType" ).toString();
  96 }
  97
  98 QStringList KDataToolInfo::mimeTypes() const
  99 {
 100     if ( !d->service )
 101         return QStringList();
 102
 103     return d->service->property( "DataMimeTypes" ).toStringList();
 104 }
 105
 106 bool KDataToolInfo::isReadOnly() const
 107 {
 108     if ( !d->service )
 109         return true;
 110
 111     return d->service->property( "ReadOnly" ).toBool();
 112 }
 113
 114 QPixmap KDataToolInfo::icon() const
 115 {
 116     if ( !d->service )
 117         return QPixmap();
 118
 119     QPixmap pix;
 120     const QStringList lst = KGlobal::dirs()->resourceDirs("icon");
 121     QStringList::ConstIterator it = lst.begin();
 122     while (!pix.load( *it + '/' + d->service->icon() ) && it != lst.end() )
 123         it++;
 124
 125     return pix;
 126 }
 127
 128 QPixmap KDataToolInfo::miniIcon() const
 129 {
 130     if ( !d->service )
 131         return QPixmap();
 132
 133     QPixmap pix;
 134     const QStringList lst = KGlobal::dirs()->resourceDirs("mini");
 135     QStringList::ConstIterator it = lst.begin();
 136     while (!pix.load( *it + '/' + d->service->icon() ) && it != lst.end() )
 137         it++;
 138
 139     return pix;
 140 }
 141
 142 QString KDataToolInfo::iconName() const
 143 {
 144     if ( !d->service )
 145         return QString();
 146     return d->service->icon();
 147 }
 148
 149 QStringList KDataToolInfo::commands() const
 150 {
 151     if ( !d->service )
 152         return QStringList();
 153
 154     return d->service->property( "Commands" ).toStringList();
 155 }
 156
 157 QStringList KDataToolInfo::userCommands() const
 158 {
 159     if ( !d->service )
 160         return QStringList();
 161
 162     return d->service->comment().split( ',', QString::SkipEmptyParts );
 163 }
 164
 165 KDataTool* KDataToolInfo::createTool( QObject* parent ) const
 166 {
 167     if ( !d->service )
 168         return 0;
 169
 170     KDataTool* tool = d->service->createInstance<KDataTool>(parent);
 171     if ( tool )
 172         tool->setComponentData(d->componentData);
 173     return tool;
 174 }
 175
 176 KService::Ptr KDataToolInfo::service() const
 177 {
 178     return d->service;
 179 }
 180
 181 KComponentData KDataToolInfo::componentData() const
 182 {
 183     return d->componentData;
 184 }
 185
 186 QList<KDataToolInfo> KDataToolInfo::query(const QString& datatype, const QString& mimetype, const KComponentData &componentData)
 187 {
 188     QList<KDataToolInfo> lst;
 189
 190     QString constr;
 191
 192     if ( !datatype.isEmpty() )
 193     {
 194         constr = QString::fromLatin1( "DataType == '%1'" ).arg( datatype );
 195     }
 196     if ( !mimetype.isEmpty() )
 197     {
 198         QString tmp = QString::fromLatin1( "'%1' in DataMimeTypes" ).arg( mimetype );
 199         if ( constr.isEmpty() )
 200             constr = tmp;
 201         else
 202             constr = constr + " and " + tmp;
 203     }
 204 /* Bug in KServiceTypeTrader ? Test with HEAD-kdelibs!
 205     if ( componentData )
 206     {
 207         QString tmp = QString::fromLatin1( "not ('%1' in ExcludeFrom)" ).arg( componentData.componentName() );
 208         if ( constr.isEmpty() )
 209             constr = tmp;
 210         else
 211             constr = constr + " and " + tmp;
 212     } */
 213
 214     // Query the trader
 215     //kDebug() << constr;
 216     const KService::List offers = KServiceTypeTrader::self()->query( "KDataTool", constr );
 217
 218     KService::List::ConstIterator it = offers.begin();
 219     for( ; it != offers.end(); ++it )
 220     {
 221         // Temporary replacement for the non-working trader query above
 222         if (!componentData.isValid() || !(*it)->property("ExcludeFrom").toStringList()
 223              .contains(componentData.componentName())) {
 224             lst.append(KDataToolInfo(*it, componentData));
 225         } else {
 226             kDebug() << (*it)->entryPath() << " excluded.";
 227         }
 228     }
 229
 230     return lst;
 231 }
 232
 233 bool KDataToolInfo::isValid() const
 234 {
 235     return( !d->service.isNull() );
 236 }
 237
 238 /*************************************************
 239  *
 240  * KDataToolAction
 241  *
 242  *************************************************/
 243 class KDataToolAction::KDataToolActionPrivate
 244 {
 245 public:
 246     KDataToolActionPrivate() {}
 247
 248     QString command;
 249     KDataToolInfo info;
 250 };
 251
 252 KDataToolAction::KDataToolAction( const QString & text, const KDataToolInfo & info, const QString & command,
 253                                   QObject *parent )
 254     : KAction( text, parent ),
 255       d(new KDataToolActionPrivate)
 256 {
 257     setIcon( KIcon( info.iconName() ) );
 258     d->command = command;
 259     d->info = info;
 260 }
 261
 262 KDataToolAction::~KDataToolAction()
 263 {
 264     delete d;
 265 }
 266
 267 void KDataToolAction::slotActivated()
 268 {
 269     emit toolActivated( d->info, d->command );
 270 }
 271
 272 QList<QAction*> KDataToolAction::dataToolActionList( const QList<KDataToolInfo> & tools, const QObject *receiver, const char* slot, KActionCollection* parent )
 273 {
 274     QList<QAction*> actionList;
 275     if ( tools.isEmpty() )
 276         return actionList;
 277
 278     QAction *sep_action = new QAction(parent);
 279     sep_action->setSeparator(true);
 280     actionList.append( sep_action );
 281     QList<KDataToolInfo>::ConstIterator entry = tools.begin();
 282     for( ; entry != tools.end(); ++entry )
 283     {
 284         const QStringList userCommands = (*entry).userCommands();
 285         const QStringList commands = (*entry).commands();
 286         Q_ASSERT(!commands.isEmpty());
 287         if ( commands.count() != userCommands.count() )
 288             kWarning() << "KDataTool desktop file error (" << (*entry).service()->entryPath()
 289                         << ")." << commands.count() << "commands and"
 290                         << userCommands.count() << " descriptions.";
 291         QStringList::ConstIterator uit = userCommands.begin();
 292         QStringList::ConstIterator cit = commands.begin();
 293         for (; uit != userCommands.end() && cit != commands.end(); ++uit, ++cit )
 294         {
 295             //kDebug() << "creating action " << *uit << " " << *cit;
 296             const QString name = (*entry).service()->entryPath(); // something unique
 297             KDataToolAction * action = new KDataToolAction( *uit, *entry, *cit, parent );
 298             parent->addAction( name, action );
 299             connect( action, SIGNAL( toolActivated( const KDataToolInfo &, const QString & ) ),
 300                      receiver, slot );
 301             actionList.append( action );
 302         }
 303     }
 304
 305     return actionList;
 306 }
 307
 308 /*************************************************
 309  *
 310  * KDataTool
 311  *
 312  *************************************************/
 313 class KDataTool::KDataToolPrivate
 314 {
 315 public:
 316     KDataToolPrivate() {}
 317
 318     KComponentData componentData;
 319 };
 320
 321 KDataTool::KDataTool( QObject* parent )
 322     : QObject(parent), d(new KDataToolPrivate)
 323 {
 324 }
 325
 326 KDataTool::~KDataTool()
 327 {
 328     delete d;
 329 }
 330
 331 void KDataTool::setComponentData(const KComponentData &componentData)
 332 {
 333     d->componentData = componentData;
 334 }
 335
 336 const KComponentData &KDataTool::componentData() const
 337 {
 338    return d->componentData;
 339 }
 340
 341 #include "kdatatool.moc"