mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-24 19:02:53 +00:00
8a70a057ef
this happens because transfersChangedEvent() is executed too often, as a workaround asign a variable that is changed just before the notifications is emmited and reset on transfer add/remove. I'm not sure if it has to be reset in the group actions so that may break the notification in some cases, in any case KGet is far less annoying now
492 lines
17 KiB
C++
492 lines
17 KiB
C++
/* This file is part of the KDE project
|
|
|
|
Copyright (C) 2005 Dario Massarin <nekkar@libero.it>
|
|
Copyright (C) 2009 Lukas Appelhans <l.appelhans@gmx.de>
|
|
Copyright (C) 2009 Matthias Fuchs <mat69@gmx.net>
|
|
|
|
Based on:
|
|
kmainwidget.{h,cpp}
|
|
Copyright (C) 2002 by Patrick Charbonnier <pch@freeshell.org>
|
|
that was based On Caitoo v.0.7.3 (c) 1998 - 2000, Matej Koss
|
|
|
|
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.
|
|
*/
|
|
|
|
#ifndef KGET_H
|
|
#define KGET_H
|
|
|
|
#include <kservice.h>
|
|
#include <kurl.h>
|
|
#include <kactioncollection.h>
|
|
#include <KNotification>
|
|
#include <ktabwidget.h>
|
|
|
|
#include <Solid/Networking>
|
|
#include <QtXml/QDomElement>
|
|
|
|
#include "kuiserverjobs.h"
|
|
#include "scheduler.h"
|
|
#include "../kget_export.h"
|
|
#include "transfer.h"
|
|
#include "transfergrouphandler.h"
|
|
|
|
class QDomElement;
|
|
class QAbstractItemView;
|
|
|
|
class KComboBox;
|
|
|
|
class TransferDataSource;
|
|
class TransferGroup;
|
|
class TransferHandler;
|
|
class TransferFactory;
|
|
class TransferTreeModel;
|
|
class TransferTreeSelectionModel;
|
|
class KGetPlugin;
|
|
class MainWindow;
|
|
class NewTransferDialog;
|
|
class TransferGroupScheduler;
|
|
class TransferHistoryStore;
|
|
|
|
|
|
/**
|
|
* This is our KGet class. This is where the user's transfers and searches are
|
|
* stored and organized.
|
|
* Use this class from the views to add or remove transfers or searches
|
|
* In order to organize the transfers inside categories we have a TransferGroup
|
|
* class. By definition, a transfer must always belong to a TransferGroup. If we
|
|
* don't want it to be displayed by the gui inside a specific group, we will put
|
|
* it in the group named "Not grouped" (better name?).
|
|
**/
|
|
|
|
class KGET_EXPORT KGet
|
|
{
|
|
friend class NewTransferDialog;
|
|
friend class NewTransferDialogHandler;
|
|
friend class GenericObserver;
|
|
friend class TransferTreeModel;
|
|
friend class UrlChecker;
|
|
public:
|
|
enum AfterFinishAction {
|
|
Quit = 0,
|
|
Shutdown = 1,
|
|
Hibernate = 2,
|
|
Suspend = 3
|
|
};
|
|
enum DeleteMode {
|
|
AutoDelete,
|
|
DeleteFiles
|
|
};
|
|
~KGet();
|
|
|
|
static KGet* self( MainWindow * mainWindow=0 );
|
|
|
|
/**
|
|
* Adds a new group to the KGet.
|
|
*
|
|
* @param groupName The name of the new group
|
|
*
|
|
* @returns true if the group has been successully added, otherwise
|
|
* it returns false, probably because a group with that named
|
|
* already exists
|
|
*/
|
|
static bool addGroup(const QString& groupName);
|
|
|
|
/**
|
|
* Removes a group from the KGet.
|
|
*
|
|
* @param groupName The name of the group to be deleted
|
|
*/
|
|
static void delGroup(TransferGroupHandler * group, bool askUser = true);
|
|
|
|
/**
|
|
* Removes specific groups from the KGet.
|
|
*
|
|
* @param groups The names of the groups to be deleted.
|
|
*/
|
|
static void delGroups(QList<TransferGroupHandler*> groups, bool askUser = true);
|
|
|
|
/**
|
|
* Changes the name of the group
|
|
*
|
|
* @param oldName the name of the group to be changed
|
|
* @param newName the new name of the group
|
|
*/
|
|
static void renameGroup(const QString& oldName, const QString& newName);
|
|
|
|
/**
|
|
* @returns the name of the available transfers groups
|
|
*/
|
|
static QStringList transferGroupNames();
|
|
|
|
/**
|
|
* Adds a new transfer to the KGet
|
|
*
|
|
* @param srcUrl The url to be downloaded
|
|
* @param destDir The destination directory. If empty we show a dialog
|
|
* where the user can choose it.
|
|
* @param suggestedFileName a suggestion of a simple filename to be saved in destDir
|
|
* @param groupName The name of the group the new transfer will belong to
|
|
* @param start Specifies if the newly added transfers should be started.
|
|
* If the group queue is already in a running state, this flag does nothing
|
|
*/
|
|
static TransferHandler * addTransfer(KUrl srcUrl, QString destDir = QString(), QString suggestedFileName = QString(),
|
|
QString groupName = QString(), bool start = false);
|
|
|
|
/**
|
|
* Adds new transfers to the KGet, it is assumed that this takes place because of loading
|
|
* that results in less checks for loaction etc.
|
|
*
|
|
* @param elements The dom elements of the transfers to add
|
|
* @param groupName The name of the group the new transfer will belong to
|
|
*/
|
|
static QList<TransferHandler*> addTransfers(const QList<QDomElement> &elements, const QString &groupName = QString());
|
|
|
|
/**
|
|
* Adds new transfers to the KGet
|
|
*
|
|
* @param srcUrls The urls to be downloaded
|
|
* @param destDir The destination directory. If empty we show a dialog
|
|
* where the user can choose it.
|
|
* @param groupName The name of the group the new transfer will belong to
|
|
* @param start Specifies if the newly added transfers should be started.
|
|
* If the group queue is already in a running state, this flag does nothing
|
|
*/
|
|
static const QList<TransferHandler *> addTransfer(KUrl::List srcUrls, QString destDir = QString(),
|
|
QString groupName = QString(), bool start=false);
|
|
|
|
/**
|
|
* Removes a transfer from the KGet
|
|
*
|
|
* @param transfer The transfer to be removed
|
|
*/
|
|
static bool delTransfer(TransferHandler * transfer, DeleteMode mode = AutoDelete);
|
|
|
|
/**
|
|
* Removes multiple transfers from the KGet
|
|
*
|
|
* @param transfers The transfers to be removed
|
|
*/
|
|
static bool delTransfers(const QList<TransferHandler*> &transfers, DeleteMode mode = AutoDelete);
|
|
|
|
/**
|
|
* Moves a transfer to a new group
|
|
*
|
|
* @param transfer The transfer to be moved
|
|
* @param groupName The name of the new transfer's group
|
|
*/
|
|
static void moveTransfer(TransferHandler * transfer, const QString& groupName);
|
|
|
|
/**
|
|
* Redownload a transfer
|
|
* @param transfer the transfer to redownload
|
|
*/
|
|
static void redownloadTransfer(TransferHandler * transfer);
|
|
|
|
/**
|
|
* @returns the list of selected transfers
|
|
*/
|
|
static QList<TransferHandler *> selectedTransfers();
|
|
|
|
/**
|
|
* @returns the list of the finished transfers
|
|
*/
|
|
static QList<TransferHandler *> finishedTransfers();
|
|
|
|
/**
|
|
* @returns the list of selected groups
|
|
*/
|
|
static QList<TransferGroupHandler *>
|
|
selectedTransferGroups();
|
|
|
|
/**
|
|
* @returns a pointer to the TransferTreeModel object
|
|
*/
|
|
static TransferTreeModel * model();
|
|
|
|
/**
|
|
* @returns a pointer to the QItemSelectionModel object
|
|
*/
|
|
static TransferTreeSelectionModel * selectionModel();
|
|
|
|
/**
|
|
* Imports the transfers and groups included in the provided xml file
|
|
*
|
|
* @param filename the file name to
|
|
*/
|
|
static void load( QString filename=QString() );
|
|
|
|
/**
|
|
* Exports all the transfers and groups to the given file
|
|
*
|
|
* @param filename the file name
|
|
* @param plain should list be in plain mode or kget mode
|
|
*/
|
|
static void save( QString filename=QString(), bool plain=false );
|
|
|
|
/**
|
|
* @returns a list of all transferfactories
|
|
*/
|
|
static QList<TransferFactory*> factories();
|
|
|
|
/**
|
|
* @returns The factory of a given transfer
|
|
*
|
|
* @param transfer the transfer about which we want to have the factory
|
|
*/
|
|
static TransferFactory * factory(TransferHandler * transfer);
|
|
|
|
/**
|
|
* @return a pointer to the KActionCollection objects
|
|
*/
|
|
static KActionCollection * actionCollection();
|
|
|
|
/**
|
|
* if running == true starts the scheduler
|
|
* if running == false stops the scheduler
|
|
*/
|
|
static void setSchedulerRunning(bool running=true);
|
|
|
|
/**
|
|
* Returns true if the scheduler has running jobs.
|
|
*/
|
|
static bool schedulerRunning();
|
|
|
|
/**
|
|
* true suspends the scheduler, any events that would result in a reschedule are ignored
|
|
* false wakes up the scheduler, events result in reschedule again
|
|
* NOTE this is a HACK for cases where the scheduler is the bottleneck, e.g. when stopping
|
|
* a lot of running transfers, or starting a lot transfers
|
|
*/
|
|
static void setSuspendScheduler(bool isSuspended);
|
|
|
|
/**
|
|
* Gets all transfers
|
|
*/
|
|
static QList<TransferHandler*> allTransfers();
|
|
|
|
/**
|
|
* Gets all transfer-groups
|
|
*/
|
|
static QList<TransferGroupHandler*> allTransferGroups();
|
|
|
|
/**
|
|
* Get the transfer with the given url
|
|
* @param src the url
|
|
*/
|
|
static TransferHandler * findTransfer(const KUrl &src);
|
|
|
|
/**
|
|
* Get the group with the given name
|
|
* @param name the name
|
|
*/
|
|
static TransferGroupHandler * findGroup(const QString &name);
|
|
|
|
/**
|
|
* Run this function for enabling the systemTray
|
|
* (will be automatically done, if there is download running)
|
|
*/
|
|
static void checkSystemTray();
|
|
|
|
/**
|
|
* This will be called when the settings have been changed
|
|
*/
|
|
static void settingsChanged();
|
|
|
|
/**
|
|
* @return a list of the groups assigned to the filename of a transfer
|
|
*/
|
|
static QList<TransferGroupHandler*> groupsFromExceptions(const KUrl &filename);
|
|
|
|
/**
|
|
* Returns true if sourceUrl matches any of the patterns
|
|
*/
|
|
static bool matchesExceptions(const KUrl &sourceUrl, const QStringList &patterns);
|
|
|
|
/**
|
|
* Scans for all the available plugins and creates the proper
|
|
* transfer DataSource object for transfers Containers
|
|
*
|
|
* @param src Source Url
|
|
* @param type the type of the DataSource that should be created e.g. <TransferDataSource type="search" />
|
|
* this is only needed when creating a "special" TransferDataSource like the search for Urls
|
|
* you can set additional information and the TransferDataSource will use it if it can
|
|
*/
|
|
static TransferDataSource * createTransferDataSource(const KUrl &src, const QDomElement &type = QDomElement(), QObject *parent = 0);
|
|
|
|
/**
|
|
* Sets the global download limit
|
|
* @param limit the new global download limit
|
|
*/
|
|
static void setGlobalDownloadLimit(int limit);
|
|
|
|
/**
|
|
* Sets the global upload limit
|
|
* @param limit the new global upload limit
|
|
*/
|
|
static void setGlobalUploadLimit(int limit);
|
|
|
|
/**
|
|
* Recalculates the global speedlimits
|
|
*/
|
|
static void calculateGlobalSpeedLimits();
|
|
|
|
/**
|
|
* Recalculates the global download-limit
|
|
*/
|
|
static void calculateGlobalDownloadLimit();
|
|
|
|
/**
|
|
* Recalculates the global upload-limit
|
|
*/
|
|
static void calculateGlobalUploadLimit();
|
|
|
|
|
|
/**
|
|
* Shows a knotification
|
|
* @param parent QWidget parent of the notification
|
|
* @param eventId Notification type
|
|
* @param text Description of the information showed by the notification
|
|
* @param icon Pixmap showed in the notification, by default 'dialog-error'
|
|
*/
|
|
static KNotification *showNotification(QWidget *parent, const QString &eventType,
|
|
const QString &text,
|
|
const QString &icon = QString("dialog-error"),
|
|
const QString &title = i18n("KGet"),
|
|
const KNotification::NotificationFlags &flags = KNotification::CloseOnTimeout);
|
|
|
|
static void loadPlugins();
|
|
|
|
/**
|
|
* Returns a download directory
|
|
* @param preferXDGDownloadDir if true the XDG_DOWNLOAD_DIR will be taken if it is not empty
|
|
* @note depending if the directories exist it will return them in the following order:
|
|
* (preferXDGDownloadDirectory >) lastDirectory > XDG_DOWNLOAD_DIR
|
|
*/
|
|
static QString generalDestDir(bool preferXDGDownloadDir = false);
|
|
|
|
|
|
private:
|
|
KGet();
|
|
|
|
class TransferData;
|
|
|
|
/**
|
|
* Scans for all the available plugins and creates the proper
|
|
* transfer object for the given src url
|
|
*
|
|
* @param src the source url
|
|
* @param dest the destination url
|
|
* @param groupName the group name
|
|
* @param start Specifies if the newly added transfers should be started.
|
|
*/
|
|
static TransferHandler * createTransfer(const KUrl &src, const KUrl &dest, const QString& groupName = QString(), bool start = false, const QDomElement * e = 0);
|
|
|
|
/**
|
|
* Creates multiple transfers with transferData
|
|
*/
|
|
static QList<TransferHandler*> createTransfers(const QList<TransferData> &transferData);
|
|
|
|
static KUrl urlInputDialog();
|
|
static QString destDirInputDialog();
|
|
static KUrl destFileInputDialog(QString destDir = QString(), const QString& suggestedFileName = QString());
|
|
|
|
static bool isValidSource(const KUrl &source);
|
|
static bool isValidDestDirectory(const QString& destDir);
|
|
|
|
static KUrl getValidDestUrl(const KUrl& destDir, const KUrl &srcUrl);
|
|
|
|
//Plugin-related functions
|
|
static KGetPlugin * createPluginFromService( const KService::Ptr &service );
|
|
|
|
/**
|
|
* Stops all downloads if there is no connection and also displays
|
|
* a message.
|
|
* If there is a connection, then the downloads will be started again
|
|
*/
|
|
static void setHasNetworkConnection(bool hasConnection);
|
|
|
|
/**
|
|
* Deletes the given file, if possible.
|
|
*
|
|
* @param url The file to delete
|
|
*
|
|
* @return true if the file was successully deleted: if the given url
|
|
* is a directory or if it is not local it returns false and shows a
|
|
* warning message.
|
|
*/
|
|
static bool safeDeleteFile( const KUrl& url );
|
|
|
|
//Interview models
|
|
static TransferTreeModel * m_transferTreeModel;
|
|
static TransferTreeSelectionModel * m_selectionModel;
|
|
|
|
//Lists of available plugins
|
|
static QList<TransferFactory *> m_transferFactories;
|
|
|
|
//pointer to the Main window
|
|
static MainWindow * m_mainWindow;
|
|
|
|
//Scheduler object
|
|
static TransferGroupScheduler * m_scheduler;
|
|
|
|
//pointer to the kget uiserver jobs manager
|
|
static KUiServerJobs *m_jobManager;
|
|
|
|
//pointer to the used TransferHistoryStore
|
|
static TransferHistoryStore *m_store;
|
|
|
|
static bool m_hasConnection;
|
|
|
|
};
|
|
|
|
class KGET_EXPORT KGet::TransferData
|
|
{
|
|
public:
|
|
TransferData(const KUrl &src, const KUrl &dest, const QString &groupName = QString(), bool start = false, const QDomElement *e = 0);
|
|
|
|
KUrl src;
|
|
KUrl dest;
|
|
QString groupName;
|
|
bool start;
|
|
const QDomElement *e;
|
|
};
|
|
|
|
class GenericObserver : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
GenericObserver(QObject *parent = 0);
|
|
virtual ~GenericObserver ();
|
|
|
|
public slots:
|
|
void groupAddedEvent(TransferGroupHandler *handler);
|
|
void groupRemovedEvent(TransferGroupHandler *handler);
|
|
void transfersAddedEvent(const QList<TransferHandler*> &handlers);
|
|
void transfersRemovedEvent(const QList<TransferHandler*> &handlers);
|
|
void transfersChangedEvent(QMap<TransferHandler*, Transfer::ChangesFlags> transfers);
|
|
void groupsChangedEvent(QMap<TransferGroupHandler*, TransferGroup::ChangesFlags> groups);
|
|
void transferMovedEvent(TransferHandler *, TransferGroupHandler *);
|
|
|
|
private slots:
|
|
void slotSave();
|
|
void slotAfterFinishAction();
|
|
void slotAbortAfterFinishAction();
|
|
void slotResolveTransferError();
|
|
void slotNotificationClosed();
|
|
void slotNetworkStatusChanged(const Solid::Networking::Status &status);
|
|
|
|
private:
|
|
bool allTransfersFinished();
|
|
|
|
void requestSave();
|
|
|
|
private:
|
|
QTimer *m_save;
|
|
QTimer *m_finishAction;
|
|
bool m_allFinished;
|
|
QHash<KNotification*, TransferHandler*> m_notifications;
|
|
};
|
|
#endif
|