← Back to branch summary

~ubuntu-branches/ubuntu/vivid/muon/vivid-proposed

« back to all changes in this revision

Viewing changes to libmuon/ReviewsBackend/ReviewsBackend.h

Tags: upstream-1.3.65
Import upstream version 1.3.65

Show diffs side-by-side

added added

removed removed

Lines of Context:
libmuon/ReviewsBackend/ReviewsBackend.h
 
1
/***************************************************************************
 
2
 *   Copyright © 2011 Jonathan Thomas <echidnaman@kubuntu.org>             *
 
3
 *                                                                         *
 
4
 *   This program is free software; you can redistribute it and/or         *
 
5
 *   modify it under the terms of the GNU General Public License as        *
 
6
 *   published by the Free Software Foundation; either version 2 of        *
 
7
 *   the License or (at your option) version 3 or any later version        *
 
8
 *   accepted by the membership of KDE e.V. (or its successor approved     *
 
9
 *   by the membership of KDE e.V.), which shall act as a proxy            *
 
10
 *   defined in Section 14 of version 3 of the license.                    *
 
11
 *                                                                         *
 
12
 *   This program is distributed in the hope that it will be useful,       *
 
13
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 
14
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 
15
 *   GNU General Public License for more details.                          *
 
16
 *                                                                         *
 
17
 *   You should have received a copy of the GNU General Public License     *
 
18
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
 
19
 ***************************************************************************/
 
20
 
 
21
#ifndef REVIEWSBACKEND_H
 
22
#define REVIEWSBACKEND_H
 
23
 
 
24
#include <QtCore/QString>
 
25
#include <QtCore/QVariant>
 
26
#include <KUrl>
 
27
 
 
28
#include "libmuonprivate_export.h"
 
29
 
 
30
namespace QOAuth {
 
31
    class Interface;
 
32
}
 
33
 
 
34
class KJob;
 
35
class KTemporaryFile;
 
36
 
 
37
namespace QApt {
 
38
    class Backend;
 
39
}
 
40
 
 
41
class AbstractLoginBackend;
 
42
class Application;
 
43
class Rating;
 
44
class Review;
 
45
 
 
46
class MUONPRIVATE_EXPORT ReviewsBackend : public QObject
 
47
{
 
48
    Q_OBJECT
 
49
    Q_PROPERTY(bool hasCredentials READ hasCredentials NOTIFY loginStateChanged)
 
50
    Q_PROPERTY(QString name READ userName NOTIFY loginStateChanged)
 
51
public:
 
52
    ReviewsBackend(QObject *parent);
 
53
    ~ReviewsBackend();
 
54
 
 
55
    Q_SCRIPTABLE Rating *ratingForApplication(Application *app) const;
 
56
 
 
57
    void setAptBackend(QApt::Backend *aptBackend);
 
58
    void fetchReviews(Application* app, int page=1);
 
59
    void clearReviewCache();
 
60
    void stopPendingJobs();
 
61
    bool isFetching() const;
 
62
 
 
63
    QString userName() const;
 
64
    bool hasCredentials() const;
 
65
 
 
66
private:
 
67
    QApt::Backend *m_aptBackend;
 
68
 
 
69
    KUrl m_serverBase;
 
70
    KTemporaryFile *m_ratingsFile;
 
71
    KTemporaryFile *m_reviewsFile;
 
72
    QHash<QString, Rating *> m_ratings;
 
73
    // cache key is package name + app name, since both by their own may not be unique
 
74
    QHash<QString, QList<Review *> > m_reviewsCache;
 
75
    QHash<KJob *, Application *> m_jobHash;
 
76
 
 
77
    void fetchRatings();
 
78
    void loadRatingsFromFile(const QString &fileName);
 
79
    QString getLanguage();
 
80
    AbstractLoginBackend* m_loginBackend;
 
81
    QOAuth::Interface* m_oauthInterface;
 
82
    QList<QPair<QString, QVariantMap> > m_pendingRequests;
 
83
 
 
84
private Q_SLOTS:
 
85
    void ratingsFetched(KJob *job);
 
86
    void reviewsFetched(KJob *job);
 
87
    void informationPosted(KJob* job);
 
88
    void postInformation(const QString& path, const QVariantMap& data);
 
89
 
 
90
public slots:
 
91
    void login();
 
92
    void registerAndLogin();
 
93
    void logout();
 
94
    void submitUsefulness(Review* r, bool useful);
 
95
    void submitReview(Application* app, const QString& summary,
 
96
                      const QString& review_text, const QString& rating);
 
97
    void deleteReview(Review* r);
 
98
    void flagReview(Review* r, const QString& reason, const QString &text);
 
99
    void refreshConsumerKeys();
 
100
 
 
101
Q_SIGNALS:
 
102
    void reviewsReady(Application *app, QList<Review *>);
 
103
    void ratingsReady();
 
104
    void loginStateChanged();
 
105
};
 
106
 
 
107
#endif