urlchecker.h

Go to the documentation of this file.

/***************************************************************************
*   Copyright (C) 2010 Matthias Fuchs <mat69@gmx.net>                     *
*                                                                         *
*   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 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 General Public License for more details.                          *
*                                                                         *
*   You should have received a copy of the GNU General Public License     *
*   along with this program; if not, write to the                         *
*   Free Software Foundation, Inc.,                                       *
*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .        *
***************************************************************************/

#ifndef KGET_URL_CHECKER_H
#define KGET_URL_CHECKER_H

#include "../kget_export.h"

#include <KUrl>

class Transfer;
class TransferHandler;

class KGET_EXPORT UrlChecker
{
    public:
        enum UrlType {
            Source,
            Destination,
            Folder
        };

        explicit UrlChecker(UrlType type);
        ~UrlChecker();

        static void removeDuplicates(KUrl::List &urls);

        //NOTE only first found error is reported, i.e. NotWriteable before ExistingFile if both are the case
        enum UrlError {
            //General
            NoError = 0,
            Empty,
            Invalid,

            //Source only
            NoProtocol,
            NoHost,

            //Destination and Folder only
            NotWriteable
        };

        enum UrlWarning {
            NoWarning = 0,
            //Source and Destination only
            ExistingFinishedTransfer,
            ExistingTransfer,

            //Destination only
            ExistingFile
        };

        static UrlError checkUrl(const KUrl &url, const UrlType type, bool showNotification = false);

        static UrlError checkSource(const KUrl &source, bool showNotification = false);

        static UrlError checkDestination(const KUrl &destination, bool showNotification = false);

        static UrlError checkFolder(const KUrl &folder, bool showNotification = false);

        static bool wouldOverwrite(const KUrl &source, const KUrl &dest);

        static TransferHandler *existingTransfer(const KUrl &url, const UrlType type, UrlWarning *warning = 0);

        static KUrl::List hasExistingTransferMessages(const KUrl::List &urls, const UrlType type);

        static QString message(const KUrl &url, const UrlType type, const UrlError error);

        static QString message(const KUrl &url, const UrlType type, const UrlWarning warning);

        static QString message(const KUrl::List &urls, const UrlType type, const UrlError error);

        static QString message(const KUrl::List &urls, const UrlType type, const UrlWarning warning);

        static KUrl destUrl(const KUrl &destOrFolder, const KUrl &source, const QString &fileName = QString());


        UrlType type() const;

        void setType(UrlType type);

        void clear();

        UrlError addUrl(const KUrl &url);

        bool addUrls(const KUrl::List &urls);

        void displayErrorMessages();

        KUrl::List correctUrls() const;

        void existingTransfers();

        KUrl checkExistingFile(const KUrl &source, const KUrl &destination);

        KUrl::List errorUrls()const;

        QHash<UrlError, KUrl::List> splitErrorUrls() const;

    private:
        static TransferHandler *existingSource(const KUrl &url, UrlWarning &warning);
        static TransferHandler *existingDestination(const KUrl &url, UrlWarning &warning);
        static int hasExistingDialog(const KUrl &url, const UrlChecker::UrlType type, const UrlWarning warning);//TODO description --> returncode etc.!
        static void removeTransfers(const QList<TransferHandler*> &toRemove);

        enum ExistingDialogReturn {
            Cancel = 0,

            //old stuff is overwritten/deleted
            Yes,
            YesAll,

            //new stuff is not used
            No,
            NoAll
        };

    private:
        UrlType m_type;
        KUrl::List m_correctUrls;
        QHash<UrlError, KUrl::List> m_splitErrorUrls;

        QHash<UrlWarning, QPair<KUrl, Transfer*> > m_existingTransfers;
        KUrl::List m_nonExistingUrls;

        //Existing files stuff
        bool m_cancle;
        bool m_overwriteAll;
        bool m_autoRenameAll;
        bool m_skipAll;
};


#endif