kio/kio/knfsshare.h

   1 /* This file is part of the KDE project
   2    Copyright (c) 2004 Jan Schaefer <j_schaef@informatik.uni-kl.de>
   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 version 2 as published by the Free Software Foundation.
   7
   8    This library is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11    Library General Public License for more details.
  12
  13    You should have received a copy of the GNU Library General Public License
  14    along with this library; see the file COPYING.LIB.  If not, write to
  15    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16    Boston, MA 02110-1301, USA.
  17 */
  18
  19 #ifndef knfsshare_h
  20 #define knfsshare_h
  21
  22 #include <QtCore/QObject>
  23
  24 #include <kio/kio_export.h>
  25
  26 /**
  27  * Similar functionality like KFileShare,
  28  * but works only for NFS and do not need
  29  * any suid script.
  30  * It parses the /etc/exports file to get its information.
  31  * Singleton class, call instance() to get an instance.
  32  */
  33 class KIO_EXPORT KNFSShare : public QObject
  34 {
  35 Q_OBJECT
  36 public:
  37   /**
  38    * Returns the one and only instance of KNFSShare
  39    */
  40   static KNFSShare* instance();
  41
  42   /**
  43    * Whether or not the given path is shared by NFS.
  44    * @param path the path to check if it is shared by NFS.
  45    * @return whether the given path is shared by NFS.
  46    */
  47   bool isDirectoryShared( const QString & path ) const;
  48
  49   /**
  50    * Returns a list of all directories shared by NFS.
  51    * The resulting list is not sorted.
  52    * @return a list of all directories shared by NFS.
  53    */
  54   QStringList sharedDirectories() const;
  55
  56   /**
  57    * KNFSShare destructor.
  58    * Do not call!
  59    * The instance is destroyed automatically!
  60    */
  61   virtual ~KNFSShare();
  62
  63   /**
  64    * Returns the path to the used exports file,
  65    * or null if no exports file was found
  66    */
  67   QString exportsPath() const;
  68
  69 Q_SIGNALS:
  70   /**
  71    * Emitted when the /etc/exports file has changed
  72    */
  73   void changed();
  74
  75 private:
  76   KNFSShare();
  77   class KNFSSharePrivate;
  78   KNFSSharePrivate * const d;
  79
  80   Q_PRIVATE_SLOT( d, void _k_slotFileChange(const QString&) )
  81 };
  82
  83 #endif