///////////////////////////////////////////////////////////////////////////// // // Project: SMB kioslave for KDE // // File: kio_smb.h // // Abstract: The main kio slave class declaration. For convenience, // in concurrent devlopment, the implementation for this class // is separated into several .cpp files -- the file containing // the implementation should be noted in the comments for each // member function. // // Author(s): Matthew Peterson // //--------------------------------------------------------------------------- // // Copyright (c) 2000 Caldera Systems, Inc. // // This program is free software; you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by the // Free Software Foundation; either version 2.1 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; see the file COPYING. If not, please obtain // a copy from http://www.gnu.org/copyleft/gpl.html // ///////////////////////////////////////////////////////////////////////////// #ifndef KIO_SMB_H_INCLUDED #define KIO_SMB_H_INCLUDED #include "config-smb.h" //-------------- // KDE includes //-------------- #include #include #include #include #include //----------------------------- // Standard C library includes //----------------------------- #include #include #include #include #include #include #include #include #include #include #include //------------------------------- // Samba client library includes //------------------------------- extern "C" { #include } //--------------------------- // kio_smb internal includes //--------------------------- #include "kio_smb_internal.h" #define MAX_XFER_BUF_SIZE 65534 #define KIO_SMB 7106 using namespace KIO; //=========================================================================== class SMBSlave : public QObject, public KIO::SlaveBase { Q_OBJECT private: //--------------------------------------------------------------------- // please make sure your private data does not duplicate existing data //--------------------------------------------------------------------- bool m_initialized_smbc; /** * From Controlcenter */ QString m_default_user; // QString m_default_workgroup; //currently unused, Alex QString m_default_password; QString m_default_encoding; /** * we store the current url, it's needed for * callback authorization method */ SMBUrl m_current_url; /** * From Controlcenter, show SHARE$ or not */ // bool m_showHiddenShares; //currently unused, Alex /** * libsmbclient need global variables to store in, * else it crashes on exit next method after use cache_stat, * looks like gcc (C/C++) failure */ struct stat st; protected: //--------------------------------------------- // Authentication functions (kio_smb_auth.cpp) //--------------------------------------------- // (please prefix functions with auth) /** * Description : Initializes the libsmbclient * Return : true on success false with errno set on error */ bool auth_initialize_smbc(); bool checkPassword(SMBUrl &url); //--------------------------------------------- // Cache functions (kio_smb_auth.cpp) //--------------------------------------------- //Stat methods //----------------------------------------- // Browsing functions (kio_smb_browse.cpp) //----------------------------------------- // (please prefix functions with browse) /** * Description : Return a stat of given SMBUrl. Calls cache_stat and * pack it in UDSEntry. UDSEntry will not be cleared * Parameter : SMBUrl the url to stat * ignore_errors do not call error(), but warning() * Return : false if any error occurred (errno), else true */ bool browse_stat_path(const SMBUrl& url, UDSEntry& udsentry, bool ignore_errors); /** * Description : call smbc_stat and return stats of the url * Parameter : SMBUrl the url to stat * Return : stat* of the url * Note : it has some problems with stat in method, looks like * something leave(or removed) on the stack. If your * method segfault on returning try to change the stat* * variable */ int cache_stat( const SMBUrl& url, struct stat* st ); //--------------------------------------------- // Configuration functions (kio_smb_config.cpp) //--------------------------------------------- // (please prefix functions with config) //--------------------------------------- // Directory functions (kio_smb_dir.cpp) //--------------------------------------- // (please prefix functions with dir) //-------------------------------------- // File IO functions (kio_smb_file.cpp) //-------------------------------------- // (please prefix functions with file) //---------------------------- // Misc functions (this file) //---------------------------- /** * Description : correct a given URL * valid URL's are * * smb://[[domain;]user[:password]@]server[:port][/share[/path[/file]]] * smb:/[[domain;]user[:password]@][group/[server[/share[/path[/file]]]]] * domain = workgroup(domain) of the user * user = username * password = password of useraccount * group = workgroup(domain) of server * server = host to connect * share = a share of the server (host) * path = a path of the share * Parameter : KUrl the url to check * Return : new KUrl if it is corrected. else the same KUrl */ KUrl checkURL(const KUrl& kurl) const; void reportError(const SMBUrl &kurl, const int &errNum); public: //----------------------------------------------------------------------- // smbclient authentication callback (note that this is called by the // global ::auth_smbc_get_data() call. void auth_smbc_get_data(const char *server,const char *share, char *workgroup, int wgmaxlen, char *username, int unmaxlen, char *password, int pwmaxlen); //----------------------------------------------------------------------- // Overwritten functions from the base class that define the operation of // this slave. (See the base class headerfile slavebase.h for more // details) //----------------------------------------------------------------------- // Functions overwritten in kio_smb.cpp SMBSlave(const QByteArray& pool, const QByteArray& app); virtual ~SMBSlave(); // Functions overwritten in kio_smb_browse.cpp virtual void listDir( const KUrl& url ); virtual void stat( const KUrl& url ); // Functions overwritten in kio_smb_config.cpp virtual void reparseConfiguration(); // Functions overwritten in kio_smb_dir.cpp virtual void copy( const KUrl& src, const KUrl &dest, int permissions, KIO::JobFlags flags ); virtual void del( const KUrl& kurl, bool isfile); virtual void mkdir( const KUrl& kurl, int permissions ); virtual void rename( const KUrl& src, const KUrl& dest, KIO::JobFlags flags ); // Functions overwritten in kio_smb_file.cpp virtual void get( const KUrl& kurl ); virtual void put( const KUrl& kurl, int permissions, KIO::JobFlags flags ); virtual void open( const KUrl& kurl, QIODevice::OpenMode mode ); virtual void read( KIO::filesize_t bytesRequested ); virtual void write( const QByteArray &fileData ); virtual void seek( KIO::filesize_t offset ); virtual void close(); // Functions not implemented (yet) //virtual void setHost(const QString& host, int port, const QString& user, const QString& pass); //virtual void openConnection(); //virtual void closeConnection(); //virtual void slave_status(); virtual void special( const QByteArray & ); private: void smbCopy(const KUrl& src, const KUrl &dest, int permissions, KIO::JobFlags flags); void smbCopyGet(const KUrl& src, const KUrl& dest, int permissions, KIO::JobFlags flags); void smbCopyPut(const KUrl& src, const KUrl& dest, int permissions, KIO::JobFlags flags); /** * Used in open(), read(), write(), and close() * FIXME Placing these in the private section above causes m_openUrl = kurl * to fail in SMBSlave::open. Need to find out why this is. */ int m_openFd; SMBUrl m_openUrl; }; //========================================================================== // the global libsmbclient authentication callback function extern "C" { void auth_smbc_get_data(SMBCCTX * context, const char *server,const char *share, char *workgroup, int wgmaxlen, char *username, int unmaxlen, char *password, int pwmaxlen); } //=========================================================================== // Main slave entrypoint (see kio_smb.cpp) extern "C" { int kdemain( int argc, char **argv ); } #endif //#endif KIO_SMB_H_INCLUDED