libkdepim/pluginloaderbase.cpp

   1 /*  -*- c++ -*-
   2     This file is part of libkdepim.
   3
   4     Copyright (c) 2002,2004 Marc Mutz <mutz@kde.org>
   5
   6     This library is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU Library General Public
   8     License as published by the Free Software Foundation; either
   9     version 2 of the License, or (at your option) any later version.
  10
  11     This library is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14     Library General Public License for more details.
  15
  16     You should have received a copy of the GNU Library General Public License
  17     along with this library; see the file COPYING.LIB.  If not, write to
  18     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19     Boston, MA 02110-1301, USA.
  20 */
  21
  22 #include "pluginloaderbase.h"
  23
  24 #include <KConfigGroup>
  25 #include <KDebug>
  26 #include <KGlobal>
  27 #include <KLibLoader>
  28 #include <KLocale>
  29 #include <KStandardDirs>
  30
  31 #include <QFile>
  32 #include <QStringList>
  33
  34 namespace KPIM {
  35
  36   PluginLoaderBase::PluginLoaderBase() : d(0) {}
  37   PluginLoaderBase::~PluginLoaderBase() {}
  38
  39
  40   QStringList PluginLoaderBase::types() const {
  41     QStringList result;
  42     for ( QMap< QString, PluginMetaData >::const_iterator it = mPluginMap.constBegin(); it != mPluginMap.constEnd() ; ++it )
  43       result.push_back( it.key() );
  44     return result;
  45   }
  46
  47   const PluginMetaData * PluginLoaderBase::infoForName( const QString & type ) const {
  48     return mPluginMap.contains( type ) ? &(const_cast<PluginLoaderBase*>(this)->mPluginMap[type]) : 0 ;
  49   }
  50
  51
  52   void PluginLoaderBase::doScan( const char * path ) {
  53     mPluginMap.clear();
  54
  55     const QStringList list =
  56       KGlobal::dirs()->findAllResources( "data", path,
  57                                          KStandardDirs::Recursive |
  58                                          KStandardDirs::NoDuplicates );
  59     for ( QStringList::const_iterator it = list.constBegin(); it != list.constEnd(); ++it ) {
  60       KConfig config( *it, KConfig::SimpleConfig);
  61       if ( config.hasGroup( "Misc" ) && config.hasGroup( "Plugin" ) ) {
  62         KConfigGroup group( &config, "Plugin" );
  63
  64         const QString type = group.readEntry( "Type" ).toLower();
  65         if ( type.isEmpty() ) {
  66           kWarning( 5300 ) << "missing or empty [Plugin]Type value in \"" << *it << "\" - skipping" << endl;
  67           continue;
  68         }
  69
  70         const QString library = group.readEntry( "X-KDE-Library" );
  71         if ( library.isEmpty() ) {
  72           kWarning( 5300 ) << "missing or empty [Plugin]X-KDE-Library value in \"" << *it << "\" - skipping" << endl;
  73           continue;
  74         }
  75
  76         KConfigGroup group2( &config, "Misc" );
  77
  78         QString name = group2.readEntry( "Name" );
  79         if ( name.isEmpty() ) {
  80           kWarning( 5300 ) << "missing or empty [Misc]Name value in \"" << *it << "\" - inserting default name" << endl;
  81           name = i18n("Unnamed plugin");
  82         }
  83
  84         QString comment = group2.readEntry( "Comment" );
  85         if ( comment.isEmpty() ) {
  86           kWarning( 5300 ) << "missing or empty [Misc]Comment value in \"" << *it << "\" - inserting default name" << endl;
  87           comment = i18n("No description available");
  88         }
  89
  90         mPluginMap.insert( type, PluginMetaData( library, name, comment ) );
  91       } else {
  92         kWarning( 5300 ) << "Desktop file \"" << *it << "\" doesn't seem to describe a plugin " << "(misses Misc and/or Plugin group)" << endl;
  93       }
  94     }
  95   }
  96
  97   KLibrary::void_function_ptr PluginLoaderBase::mainFunc( const QString & type, const char * mf_name ) const {
  98     if ( type.isEmpty() || !mPluginMap.contains( type ) )
  99       return 0;
 100
 101     const QString libName = mPluginMap[ type ].library;
 102     if ( libName.isEmpty() )
 103       return 0;
 104
 105     const KLibrary * lib = openLibrary( libName );
 106     if ( !lib )
 107       return 0;
 108
 109     PluginMetaData pmd = mPluginMap.value( type );
 110     pmd.loaded = true;
 111     mPluginMap[ type ] = pmd;
 112
 113     const QString factory_name = libName + '_' + mf_name;
 114     KLibrary::void_function_ptr sym = const_cast<KLibrary*>( lib )->resolveFunction( factory_name.toLatin1() );
 115     if ( !sym ) {
 116       kWarning( 5300 ) << "No symbol named \"" << factory_name.toLatin1() << "\" (" << factory_name << ") was found in library \"" << libName << "\"" << endl;
 117       return 0;
 118     }
 119
 120     return sym;
 121   }
 122
 123   const KLibrary * PluginLoaderBase::openLibrary( const QString & libName ) const {
 124
 125     const QString path = KLibLoader::findLibrary( libName );
 126
 127     if ( path.isEmpty() ) {
 128       kWarning( 5300 ) << "No plugin library named \"" << libName << "\" was found!" << endl;
 129       return 0;
 130     }
 131
 132     const KLibrary * library = KLibLoader::self()->library( path );
 133
 134     kDebug( !library, 5300 ) << "Could not load library '" << libName << "'" << endl;
 135
 136     return library;
 137   }
 138
 139
 140 } // namespace KMime