/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*     Zhiqiang Yang <zhiqiang.yang@nokia.com>

* 

* Description:

*     The header file of the file manager utilities

*/

#ifndef FMUTILS_H

#define FMUTILS_H

#include "fmcommon.h"

#include <QString>

class FmDriverInfo

{

public:

    enum driveState

    {

        EDriveNotPresent = 0x1, // true when Drive have not inserted, for example, MMC Card

        EDriveAvailable = 0x2,  // false when drive is locked or corrupted, for example MMC Card

        EDriveLocked = 0x4,

        EDriveCorrupted = 0x8,

        EDriveWriteProtected = 0x10,

        EDriveRemovable = 0x20,

        EDriveRom = 0x40,

        EDriveFormattable = 0x80,

        EDriveFormatted = 0x100,

        EDriveLockable = 0x200,

        EDrivePasswordProtected = 0x400,

        EDriveBackupped = 0x800,

        EDriveConnected = 0x1000,

        EDriveEjectable = 0x2000,

        EDriveInUse = 0x4000,

        EDriveMassStorage = 0x8000,

        EDriveRam = 0x10000,

        EDriveUsbMemory = 0x20000,

     };

    Q_DECLARE_FLAGS( DriveState, driveState )

    FmDriverInfo( quint64 s, quint64 f, const QString &n, const QString &vN, const quint32 driveState ) :

        mSize( s ), mFreeSize( f ), mName( n ), mVolumeName( vN ), mDriveState( driveState ) {}

    FmDriverInfo( const FmDriverInfo &other )

    {

        *this = other;

    }

    FmDriverInfo &operator= ( const FmDriverInfo &rhs )

    {

        this->mSize = rhs.mSize;

        this->mFreeSize = rhs.mFreeSize;

        this->mName = rhs.mName;

        this->mVolumeName = rhs.mVolumeName;

        this->mDriveState = rhs.mDriveState;

        return *this;

    }

    quint64 size() const { return mSize; }

    quint64 freeSize() const { return mFreeSize; }

    QString name() const { return mName; }

    QString volumeName() const { return mVolumeName; }

    DriveState driveState() const { return mDriveState; }

private:

    quint64 mSize;

    quint64 mFreeSize;

    QString mName;

    QString mVolumeName;

    DriveState mDriveState;

};

Q_DECLARE_OPERATORS_FOR_FLAGS( FmDriverInfo::DriveState )

class FmUtils

{

public:

    static QString getDriveNameFromPath( const QString &path );

	static QString getDriveLetterFromPath( const QString &path );

    static FmDriverInfo queryDriverInfo( const QString &driverName );

    static QString formatStorageSize( quint64 size );

    static int removeDrivePwd( const QString &driverName, const QString &Pwd );

    static int unlockDrive( const QString &driverName, const QString &Pwd );

    static int checkDrivePwd( const QString &driverName, const QString &pwd);

    static int setDrivePwd( const QString &driverName, const QString &oldPwd, const QString &newPwd);

    static void emptyPwd( QString &pwd );

    static int renameDrive( const QString &driverName, const QString &newVolumeName);

    static int ejectDrive( const QString &driverName );

    static QString getFileType( const QString &filePath  );

    static quint64 getDriveDetailsResult( const QString &folderPath, const QString &extension );

    static bool isDriveC( const QString &driverName );

    static bool isDrive( const QString &path );

	static void createDefaultFolders( const QString &driverName );

    static QString fillPathWithSplash( const QString &filePath );

    static QString removePathSplash( const QString &filePath );

    static QString formatPath( const QString &path  );

    static bool checkDriveAccessFilter( const QString &driveName );

    static QString checkDriveToFolderFilter( const QString &path );

    static QString checkFolderToDriveFilter( const QString &path );

    static int isPathAccessabel( const QString &path );

    static bool isDriveAvailable( const QString &path );

    static bool isPathEqual( const QString &pathFst, const QString &pathLast );

    /// fill driveList of drives can be shown in driveListView

    static void getDriveList( QStringList &driveList, bool isHideUnAvailableDrive );

    static QString fillDriveVolume( QString driveName, bool isFillWithDefaultVolume );

    static int launchFile( const QString &filePath );

    static void sendFiles( QStringList &filePathList );

    static QString getBurConfigPath( QString appPath );

    static bool isDefaultFolder( const QString &folderPath  );

    static QString Localize( const QString &path );

    static int getMaxFileNameLength();

    static bool checkMaxPathLength( const QString& path );

    static bool checkFolderFileName( const QString& name );

    /**

     * check file or folder path is illegal or not.

     *

	 * @param  fileName file/folder name, used to check illegal characters

     * @param  path file/folder path, used to check if path is available to use.

     * @param  errString if return false, errString will be set for error note.

     * @return true for not illegal and false for illegal path.

     */

    static bool checkNewFolderOrFile( const QString& fileName, const QString &path, QString &errString );

    /*

     * get the volume name of the disk, if it is null, then return the default name.

     * @param diskName the driver letter.

     * @param defaultName whether it is the default name.

     * @return the volume name.

     */

    static QString getVolumeNameWithDefaultNameIfNull( const QString &diskName, bool &defaultName );

};

#endif