summaryrefslogtreecommitdiffstats
path: root/kmymoney2/converter/webpricequote.h
blob: ac4402da2f30a8fc83eedae73c1e56f44167e2ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/***************************************************************************
                          webpricequote.h
                             -------------------
    begin                : Thu Dec 30 2004
    copyright            : (C) 2004 by Ace Jones
    email                : Ace Jones <[email protected]>
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 WEBPRICETQUOTE_H
#define WEBPRICETQUOTE_H

// ----------------------------------------------------------------------------
// QT Headers

#include <tqobject.h>
#include <tqdatetime.h>
#include <tqstringlist.h>
#include <tqmap.h>

// ----------------------------------------------------------------------------
// KDE Headers

#include <kprocess.h>
namespace KIO {
  class Job;
};

// ----------------------------------------------------------------------------
// Project Headers

#include "../mymoney/mymoneymoney.h"

/**
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 <[email protected]> & Ace Jones <[email protected]>
*/
class WebPriceQuoteProcess: public KProcess
{
  Q_OBJECT
  
public:
  WebPriceQuoteProcess(void);
  void setSymbol(const TQString& _symbol) { m_symbol = _symbol; m_string.truncate(0); }

public slots:
  void slotReceivedDataFromFilter(KProcess*, char*, int);
  void slotProcessExited(KProcess*);

signals:
  void processExited(const TQString&);

private:
  TQString m_symbol;
  TQString m_string;
};

/**
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 <[email protected]> & Ace Jones <[email protected]>, Tony B<[email protected]>
 */
class FinanceQuoteProcess: public KProcess
{
  Q_OBJECT
  
  public:
    FinanceQuoteProcess(void);
    void launch (const TQString& scriptPath);
    bool isFinished() { return(m_isDone);};
    TQStringList getSourceList();
    const TQString crypticName(const TQString& niceName);
    const TQString niceName(const TQString& crypticName);

  public slots:
    void slotReceivedDataFromFilter(KProcess*, char*, int);
    void slotProcessExited(KProcess*);

  private:
    bool m_isDone;
    TQString m_string;
    typedef TQMap<TQString, TQString> 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 WebPriceQuoteSource
{
  WebPriceQuoteSource() {}
  WebPriceQuoteSource(const TQString& name);
  WebPriceQuoteSource(const TQString& name, const TQString& url, const TQString& sym, const TQString& price, const TQString& date, const TQString& dateformat);
  ~WebPriceQuoteSource() {}

  void write(void) const;
  void rename(const TQString& name);
  void remove(void) const;

  TQString    m_name;
  TQString    m_url;
  TQString    m_sym;
  TQString    m_price;
  TQString    m_date;
  TQString    m_dateformat;
  bool       m_skipStripping;
};

/**
Retrieves a price quote from a web-based quote source

@author Ace Jones <[email protected]>
*/
class WebPriceQuote: public TQObject
{
  Q_OBJECT
  
public:
  WebPriceQuote( TQObject* = 0, const char* = 0 );
  ~WebPriceQuote();

  typedef enum _quoteSystemE {
    Native=0,
    FinanceQuote
  } quoteSystemE;

  /**
    * This launches a web-based quote update for the given @p _symbol.
    * When the quote is received back from the web source, it will be
    * emitted on the 'quote' signal.
    *
    * @param _symbol the trading symbol of the stock to fetch a price for
    * @param _id 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 TQString() to use the default
    *                source.
    * @return bool Whether the quote fetch process was launched successfully
    */

  bool launch(const TQString& _symbol, const TQString& _id, const TQString& _source=TQString());

  /**
    * 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 TQStringList of quote source names
    */
  static TQStringList quoteSources(const _quoteSystemE _system=Native);

signals:
  void quote(const TQString&, const TQString&, const TQDate&, const double&);
  void failed(const TQString&, const TQString&);
  void status(const TQString&);
  void error(const TQString&);

protected slots:
  void slotParseQuote(const TQString&);

protected:
  static TQMap<TQString,WebPriceQuoteSource> defaultQuoteSources(void);

private:
  bool download(const KURL& u, TQString & target, TQWidget* window);
  void removeTempFile(const TQString& tmpFile);

private slots:
  void slotResult( KIO::Job * job );


private:
  bool launchNative(const TQString& _symbol, const TQString& _id, const TQString& _source=TQString());
  bool launchFinanceQuote(const TQString& _symbol, const TQString& _id, const TQString& _source=TQString());
  void enter_loop(void);

  static TQStringList quoteSourcesNative();
  static TQStringList quoteSourcesFinanceQuote();

  WebPriceQuoteProcess m_filter;
  TQString m_symbol;
  TQString m_id;
  TQDate m_date;
  double m_price;
  WebPriceQuoteSource m_source;
  static TQString m_financeQuoteScriptPath;
  static TQStringList m_financeQuoteSources;


  /**
   * Whether the download succeeded or not. Taken from KIO::NetAccess
   */
  bool bJobOK;
  static TQString* lastErrorMsg;
  static int lastErrorCode;
  TQString m_tmpFile;
};

class MyMoneyDateFormat
{
public:
  MyMoneyDateFormat(const TQString& _format): m_format(_format) {}
  TQString convertDate(const TQDate& _in) const;
  TQDate convertString(const TQString& _in, bool _strict=true, unsigned _centurymidpoint = TQDate::currentDate().year() ) const;
  const TQString& format(void) const { return m_format; }
private:
  TQString m_format;
};

namespace convertertest {

/**
Simple class to handle signals/slots for unit tests

@author Ace Jones <[email protected]>
*/
class QuoteReceiver : public TQObject
{
Q_OBJECT
  
public:
    QuoteReceiver(WebPriceQuote* q, TQObject *parent = 0, const char *name = 0);
    ~QuoteReceiver();
public slots:
  void slotGetQuote(const TQString&,const TQDate&, const double&);
  void slotStatus(const TQString&);
  void slotError(const TQString&);
public:
  TQStringList m_statuses;
  TQStringList m_errors;
  MyMoneyMoney m_price;
  TQDate m_date;
};

} // end namespace convertertest


#endif // WEBPRICETQUOTE_H

// vim:cin:si:ai:et:ts=2:sw=2: