File indexing completed on 2024-04-21 07:27:57

 /*
     This file is part of Kiten, a KDE Japanese Reference Tool...
     SPDX-FileCopyrightText: 2011 Daniel E. Moctezuma <democtezuma@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef DICTIONARYUPDATEMANAGER_H
 #define DICTIONARYUPDATEMANAGER_H
 
 #include <QDate>
 #include <QFile>
 #include <QStringList>
 
 class QAction;
 class KJob;
 class Kiten;
 class KitenConfigSkeleton;
 
 /**
  * This class handles all the update feature for the
  * EDICT and KANJIDIC dictionaries.
  *
  * @author Daniel E. Moctezuma <democtezuma@gmail.com>
  */
 class DictionaryUpdateManager : public QObject
 {
     Q_OBJECT
 
 public:
     /**
      * Constructor.
      *
      * @param parent pointer to the Kiten instance. This helps us to add
      *               QAction actions to the program.
      */
     explicit DictionaryUpdateManager(Kiten *parent);
 
 Q_SIGNALS:
     /**
      * Emitted when all the updates for EDICT and KANJIDIC finished.
      */
     void updateFinished();
 
 private Q_SLOTS:
     /**
      * Downloads an information file containing:
      *   Name of dictionary
      *   Copyright information
      *   Latest creation date
      *   Number of entries in the dictionary
      */
     void checkForUpdates();
     /**
      * Compare the downloaded information file with our
      * dictionaries and check whether or not we need to
      * update, if so, this function triggers their download.
      *
      * @param job the job that downloaded the information file.
      *            This slot should be connected to the result() signal from KJob.
      */
     void checkInfoFile(KJob *job);
     /**
      * Install the downloaded dictionary.
      *
      * @param job the job that downloaded a dictionary file.
      *            This slot should be connected to the result() signal from KJob.
      */
     void installDictionary(KJob *job);
     /**
      * Show the update results as a KMessageBox.
      */
     void showUpdateResults();
 
 private:
     /**
      * Check whether or not the update finished, if so,
      * Q_EMIT an updateFinished signal.
      */
     void checkIfUpdateFinished();
     /**
      * Return the creation date of a file.
      * Files could be:
      *   Information file
      *   EDICT
      *   KANJIDIC
      *
      * @param file file from which you want to get the creation date
      * @return creation date of the given file
      */
     QDate getFileDate(QFile &file);
     /**
      * Download a dictionary.
      * Could be:
      *   EDICT
      *   KANJIDIC
      *
      * @param url url to the dictionary you want to download
      */
     void downloadDictionary(const QString &url);
 
     /**
      * We need it to add a QAction action to the main toolbar.
      */
     Kiten *_parent;
     /**
      * Config file that we need to know the path to
      * the installed dictionaries.
      */
     KitenConfigSkeleton *_config;
     /**
      * Update action.
      */
     QAction *_actionUpdate;
     /**
      * List of dictionaries already up to date.
      */
     QStringList _succeeded;
     /**
      * List of dictionaries that failed to be updated.
      */
     QStringList _failed;
     /**
      * Counter to know how many dictionaries we are trying to
      * install (to be used inside the installDictionary private slot).
      */
     int _counter;
 };
 
 #endif