File indexing completed on 2024-05-19 05:06:56

 /*
     SPDX-FileCopyrightText: 2004 Ace Jones <acejones@users.sourceforge.net>
     SPDX-FileCopyrightText: 2004 Thomas Baumgart <tbaumgart@kde.org>
     SPDX-FileCopyrightText: 2004 Tony B <tonybloom@users.sourceforge.net>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef WEBPRICEQUOTE_H
 #define WEBPRICEQUOTE_H
 
 #include "kmm_webconnect_export.h"
 
 // ----------------------------------------------------------------------------
 // QT Headers
 
 #include <QProcess>
 #include <QDate>
 
 // ----------------------------------------------------------------------------
 // KDE Headers
 
 // ----------------------------------------------------------------------------
 // Project Headers
 
 #include "csv/import/core/csvimportercore.h"
 
 class KJob;
 class QDate;
 class QTextCodec;
 /**
 Helper class to attend the process which is running the script, in the case
 of a local script being used to fetch the quote.
 
 @author Thomas Baumgart <tbaumgart@kde.org> & Ace Jones <acejones@users.sourceforge.net>
 */
 class KMM_WEBCONNECT_EXPORT WebPriceQuoteProcess: public QProcess
 {
     Q_OBJECT
 public:
     WebPriceQuoteProcess();
     inline void setWebID(const QString& _webID) {
         m_webID = _webID;
         m_receivedData.truncate(0);
         m_receivedError.truncate(0);
     }
 
 public Q_SLOTS:
     void slotReceivedDataFromFilter();
     void slotReceivedErrorFromFilter();
     void slotProcessExited(int exitCode, QProcess::ExitStatus exitStatus);
 
 Q_SIGNALS:
     void processExited(const QString& data, const QString& error);
 
 private:
     QString m_webID;
     QString m_receivedData;
     QString m_receivedError;
 };
 
 /**
 Helper class to run the Finance::Quote process. This is used only for the purpose of obtaining
 a list of valid sources. The actual price quotes are obtained thru WebPriceQuoteProcess.
 The class also contains functions to convert between the rather cryptic source names used
 by the Finance::Quote package, and more user-friendly names.
 
 @author Thomas Baumgart <tbaumgart@kde.org> & Ace Jones <acejones@users.sourceforge.net>, Tony B<tonybloom@users.sourceforge.net>
  */
 class KMM_WEBCONNECT_EXPORT FinanceQuoteProcess: public QProcess
 {
     Q_OBJECT
 public:
     FinanceQuoteProcess();
     void launch(const QString& scriptPath);
     bool isFinished() const {
         return(m_isDone);
     };
     const QStringList getSourceList() const;
     const QString crypticName(const QString& niceName) const;
     const QString niceName(const QString& crypticName) const;
 
 public Q_SLOTS:
     void slotReceivedDataFromFilter();
     void slotProcessExited();
 
 private:
     bool m_isDone;
     QString m_string;
     typedef QMap<QString, QString> fqNameMap;
     fqNameMap m_fqNames;
 };
 
 /**
   * @author Thomas Baumgart & Ace Jones
   *
   * This is a helper class to store information about an online source
   * for stock prices or currency exchange rates.
   */
 struct KMM_WEBCONNECT_EXPORT WebPriceQuoteSource {
     enum identifyBy {Symbol, IdentificationNumber, Name,};
     WebPriceQuoteSource() : m_webIDBy(Symbol), m_skipStripping(false) {}
     explicit WebPriceQuoteSource(const QString& name);
     WebPriceQuoteSource(const QString& name, const QString& url, const QString& csvUrl, const QString& id, const identifyBy idBy, const QString& price, const QString& date, const QString& dateformat, bool skipStripping = false);
     ~WebPriceQuoteSource() {}
 
     void write() const;
     void rename(const QString& name);
     void remove() const;
 
     QString    m_name;
     QString    m_url;
     QString    m_csvUrl;
     QString    m_webID;
     identifyBy m_webIDBy;
     QString    m_price;
     QString    m_date;
     QString    m_dateformat;
     bool       m_skipStripping;
 };
 
 /**
 Retrieves a price quote from a web-based quote source
 
 @author Ace Jones <acejones@users.sourceforge.net>
 */
 class KMM_WEBCONNECT_EXPORT WebPriceQuote: public QObject
 {
     Q_OBJECT
 public:
     explicit WebPriceQuote(QObject* = 0);
     ~WebPriceQuote();
 
     typedef enum _quoteSystemE {
         Native = 0,
         FinanceQuote,
     } quoteSystemE;
 
     void setDate(const QDate& _from, const QDate& _to);
     /**
       * This launches a web-based quote update for the given @p _webID.
       * When the quote is received back from the web source, it will be
       * emitted on the 'quote' signal.
       *
       * @param _webID the identification of the stock to fetch a price for
       * @param _kmmID an arbitrary identifier, which will be emitted in the quote
       *                signal when a price is sent back.
       * @param _source the source of the quote (must be a valid value returned
       *                by quoteSources().  Send QString() to use the default
       *                source.
       * @return bool Whether the quote fetch process was launched successfully
       */
 
     bool launch(const QString& _webID, const QString& _kmmID, const QString& _source = QString());
 
     /**
       * This returns a list of the names of the quote sources
       * currently defined.
       *
      * @param _system whether to return Native or Finance::Quote source list
      * @return QStringList of quote source names
       */
     static const QStringList quoteSources(const _quoteSystemE _system = Native);
     static const QMap<QString, PricesProfile> defaultCSVQuoteSources();
 
 Q_SIGNALS:
     void csvquote(const QString&, const QString&, MyMoneyStatement&);
     void quote(const QString&, const QString&, const QDate&, const double&);
     void failed(const QString&, const QString&);
     void status(const QString&);
     void error(const QString&);
 
 protected Q_SLOTS:
     void slotParseCSVQuote(const QString& filename);
     void slotParseQuote(const QString& data, const QString& error);
     void downloadCSV(KJob* job);
     void downloadResult(KJob* job);
 
 protected:
     static const QMap<QString, WebPriceQuoteSource> defaultQuoteSources();
 
 private:
     bool launchCSV(const QString& _webID, const QString& _kmmID, const QString& _source = QString());
     bool launchNative(const QString& _webID, const QString& _kmmID, const QString& _source = QString());
     bool launchFinanceQuote(const QString& _webID, const QString& _kmmID, const QString& _source = QString());
     void enter_loop();
 
     static const QStringList quoteSourcesNative();
     static const QStringList quoteSourcesFinanceQuote();
 
 private:
     /// \internal d-pointer class.
     class Private;
     /// \internal d-pointer instance.
     Private* const d;
 
     static QString m_financeQuoteScriptPath;
     static QStringList m_financeQuoteSources;
 
 };
 
 class KMM_WEBCONNECT_EXPORT MyMoneyDateFormat
 {
 public:
     explicit MyMoneyDateFormat(const QString& _format): m_format(_format) {}
     const QString convertDate(const QDate& _in) const;
     const QDate convertString(const QString& _in, bool _strict = true, unsigned _centurymidpoint = QDate::currentDate().year()) const;
     const QString& format() const {
         return m_format;
     }
 private:
     QString m_format;
 };
 
 namespace convertertest
 {
 
 /**
 Simple class to handle signals/slots for unit tests
 
 @author Ace Jones <acejones@users.sourceforge.net>
 */
 class KMM_WEBCONNECT_EXPORT QuoteReceiver : public QObject
 {
     Q_OBJECT
 public:
     explicit QuoteReceiver(WebPriceQuote* q, QObject *parent = 0);
     ~QuoteReceiver();
 public Q_SLOTS:
     void slotGetQuote(const QString&, const QString&, const QDate&, const double&);
     void slotStatus(const QString&);
     void slotError(const QString&);
 public:
     QStringList m_statuses;
     QStringList m_errors;
     MyMoneyMoney m_price;
     QDate m_date;
 };
 
 } // end namespace convertertest
 
 
 #endif // WEBPRICEQUOTE_H