Fixed a bug that caused Eniro search results to sometimes have phone number in street...
[jenirok] / src / common / source.h
1 /*
2  * This file is part of Jenirok.
3  *
4  * Jenirok is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * Jenirok is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with Jenirok.  If not, see <http://www.gnu.org/licenses/>.
16  *
17  */
18
19 #ifndef SOURCE_H
20 #define SOURCE_H
21
22 #include <QtCore/QObject>
23 #include <QtCore/QString>
24 #include <QtCore/QTimerEvent>
25 #include <QtCore/QUrl>
26 #include <QtCore/QByteArray>
27 #include <QtNetwork/QHttp>
28
29 class Source : public QObject
30 {
31
32     Q_OBJECT
33
34 public:
35
36     struct Result
37     {
38         QString name;
39         QString street;
40         QString city;
41         QString number;
42     };
43
44     enum SearchType {YELLOW_PAGES, PERSONS, BOTH};
45
46     struct SearchDetails
47     {
48         QString query;
49         QString location;
50         SearchType type;
51         SearchDetails(QString const& query = "",
52                       QString const& location = "",
53                       SearchType type = PERSONS);
54     };
55
56
57     enum Error {NO_ERROR, CONNECTION_FAILURE, INVALID_LOGIN, TIMEOUT};
58     enum SourceId {ENIRO, MOBIL1881};
59     static int const SOURCE_COUNT = 2;
60
61     struct SourceDetails
62     {
63         SourceId type;
64         QString name;
65         QString id;
66     };
67
68     static unsigned int const DEFAULT_MAX_RESULTS = 30;
69
70     static Source* getSource(SourceId id, QObject* parent = 0);
71     static void getSources(QList<SourceDetails>& list);
72     static SourceId stringToId(QString const& str);
73     Source(QObject* parent = 0);
74     virtual ~Source();
75     static Source* getSource();
76     virtual void abort();
77     virtual void search(SearchDetails const& details) = 0;
78     void setMaxResults(unsigned int results);
79     unsigned int getMaxResults() const;
80     void setTimeout(unsigned int ms);
81     unsigned int getTimeout() const;
82     void resetTimeout();
83     void setFindNumber(bool value);
84     bool getFindNumber() const;
85     Error error() const;
86     const QString& errorString() const;
87
88 signals:
89     void resultAvailable(Source::Result const& result, Source::SearchDetails const& details);
90     void requestFinished(QVector <Source::Result> const& results, Source::SearchDetails const& details, bool error);
91
92 protected:
93     void setError(Error error, QString const& errorString = "");
94     virtual void timerEvent(QTimerEvent *te);
95     static QString ucFirst(QString& string);
96     static QString& cleanUpNumber(QString& number);
97     static QString& stripTags(QString& string);
98     static QString& htmlEntityDecode(QString& string);
99     static bool isPhoneNumber(QString const& string);
100     void fixUrl(QUrl& url);
101     QHttp http_;
102
103 private slots:
104     void httpReady(int id, bool error);
105
106 private:
107     Q_DISABLE_COPY(Source);
108     virtual void handleHttpData(int id, QByteArray const& data) = 0;
109     virtual void handleHttpError(int id) = 0;
110     unsigned int maxResults_;
111     unsigned int timeout_;
112     int timerId_;
113     bool findNumber_;
114     Error error_;
115     QString errorString_;
116     QString username_;
117     QString password_;
118     bool loggedIn_;
119
120     static QRegExp numberCleaner_;
121     static QRegExp tagStripper_;
122
123 };
124
125 #endif