akregator/src/articlemodel.cpp

   1 /*
   2     This file is part of Akregator.
   3
   4     Copyright (C) 2007 Frank Osterfeld <osterfeld@kde.org>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20     As a special exception, permission is given to link this program
  21     with any edition of Qt, and distribute the resulting executable,
  22     without including the source code for Qt in the source distribution.
  23 */
  24 #include "articlemodel.h"
  25
  26 #include "article.h"
  27 #include "articlematcher.h"
  28 #include "akregatorconfig.h"
  29 #include "feed.h"
  30
  31 #include <Syndication/Tools>
  32
  33 #include <QMimeData>
  34 #include <QString>
  35 #include <QVector>
  36
  37 #include <KLocalizedString>
  38 #include <QUrl>
  39
  40 #include <memory>
  41
  42 #include <QLocale>
  43 #include <cassert>
  44 #include <cmath>
  45
  46 using namespace Akregator;
  47
  48 class Q_DECL_HIDDEN ArticleModel::Private
  49 {
  50 private:
  51     ArticleModel *const q;
  52 public:
  53     Private(const QVector<Article> &articles, ArticleModel *qq);
  54     QVector<Article> articles;
  55     QVector<QString> titleCache;
  56
  57     void articlesAdded(const QVector<Article> &);
  58     void articlesRemoved(const QVector<Article> &);
  59     void articlesUpdated(const QVector<Article> &);
  60
  61 };
  62
  63 //like Syndication::htmlToPlainText, but without linebreaks
  64
  65 static QString stripHtml(const QString &html)
  66 {
  67     QString str(html);
  68     //TODO: preserve some formatting, such as line breaks
  69     str.remove(QRegExp(QLatin1String("<[^>]*>"))); // remove tags
  70     str = Syndication::resolveEntities(str);
  71     return str.simplified();
  72 }
  73
  74 ArticleModel::Private::Private(const QVector<Article> &articles_, ArticleModel *qq)
  75     : q(qq), articles(articles_)
  76 {
  77     const int articlesCount(articles.count());
  78     titleCache.resize(articlesCount);
  79     for (int i = 0; i < articlesCount; ++i) {
  80         titleCache[i] = stripHtml(articles[i].title());
  81     }
  82 }
  83
  84 ArticleModel::ArticleModel(const QVector<Article> &articles, QObject *parent) : QAbstractTableModel(parent), d(new Private(articles, this))
  85 {
  86 }
  87
  88 ArticleModel::~ArticleModel()
  89 {
  90     delete d;
  91 }
  92
  93 int ArticleModel::columnCount(const QModelIndex &parent) const
  94 {
  95     return parent.isValid() ? 0 : ColumnCount;
  96 }
  97
  98 int ArticleModel::rowCount(const QModelIndex &parent) const
  99 {
 100     return parent.isValid() ? 0 : d->articles.count();
 101 }
 102
 103 QVariant ArticleModel::headerData(int section, Qt::Orientation, int role) const
 104 {
 105     if (role != Qt::DisplayRole) {
 106         return QVariant();
 107     }
 108
 109     switch (section) {
 110     case ItemTitleColumn:
 111         return i18nc("Articlelist's column header", "Title");
 112     case FeedTitleColumn:
 113         return i18nc("Articlelist's column header", "Feed");
 114     case DateColumn:
 115         return i18nc("Articlelist's column header", "Date");
 116     case AuthorColumn:
 117         return i18nc("Articlelist's column header", "Author");
 118     case DescriptionColumn:
 119         return i18nc("Articlelist's column header", "Description");
 120     case ContentColumn:
 121         return i18nc("Articlelist's column header", "Content");
 122     }
 123
 124     return QVariant();
 125 }
 126
 127 QVariant ArticleModel::data(const QModelIndex &index, int role) const
 128 {
 129     if (!index.isValid() || index.row() < 0 || index.row() >= d->articles.count()) {
 130         return QVariant();
 131     }
 132     const int row = index.row();
 133     const Article &article(d->articles[row]);
 134
 135     if (article.isNull()) {
 136         return QVariant();
 137     }
 138
 139     switch (role) {
 140     case SortRole:
 141         if (index.column() == DateColumn) {
 142             return article.pubDate();
 143         }
 144     // no break
 145     case Qt::DisplayRole: {
 146         switch (index.column()) {
 147         case FeedTitleColumn:
 148             return article.feed() ? article.feed()->title() : QVariant();
 149         case DateColumn:
 150             return QLocale().toString(article.pubDate(), QLocale::ShortFormat);
 151         case ItemTitleColumn:
 152             return d->titleCache[row];
 153         case AuthorColumn:
 154             return article.authorShort();
 155         case DescriptionColumn:
 156         case ContentColumn:
 157             return article.description();
 158         }
 159     }
 160     case LinkRole: {
 161         return article.link();
 162     }
 163     case ItemIdRole:
 164     case GuidRole: {
 165         return article.guid();
 166     }
 167     case FeedIdRole: {
 168         return article.feed() ? article.feed()->xmlUrl() : QVariant();
 169     }
 170     case StatusRole: {
 171         return article.status();
 172     }
 173     case IsImportantRole: {
 174         return article.keep();
 175     }
 176     case IsDeletedRole: {
 177         return article.isDeleted();
 178     }
 179     }
 180
 181     return QVariant();
 182 }
 183
 184 void ArticleModel::clear()
 185 {
 186     beginResetModel();
 187     d->articles.clear();
 188     d->titleCache.clear();
 189     endResetModel();
 190 }
 191
 192 void ArticleModel::articlesAdded(TreeNode *, const QVector<Article> &l)
 193 {
 194     d->articlesAdded(l);
 195 }
 196
 197 void ArticleModel::articlesRemoved(TreeNode *, const QVector<Article> &l)
 198 {
 199     d->articlesRemoved(l);
 200 }
 201 void ArticleModel::articlesUpdated(TreeNode *, const QVector<Article> &l)
 202 {
 203     d->articlesUpdated(l);
 204 }
 205
 206 void ArticleModel::Private::articlesAdded(const QVector<Article> &list)
 207 {
 208     if (list.isEmpty()) { //assert?
 209         return;
 210     }
 211     const int first = articles.count();
 212     q->beginInsertRows(QModelIndex(), first, first + list.size() - 1);
 213
 214     const int oldSize = articles.size();
 215     articles << list;
 216
 217     const int newArticlesCount(articles.count());
 218     titleCache.resize(newArticlesCount);
 219     for (int i = oldSize; i < newArticlesCount; ++i) {
 220         titleCache[i] = stripHtml(articles[i].title());
 221     }
 222     q->endInsertRows();
 223 }
 224
 225 void ArticleModel::Private::articlesRemoved(const QVector<Article> &list)
 226 {
 227     //might want to avoid indexOf() in case of performance problems
 228     Q_FOREACH (const Article &i, list) {
 229         const int row = articles.indexOf(i);
 230         Q_ASSERT(row != -1);
 231         q->removeRow(row, QModelIndex());
 232     }
 233 }
 234
 235 void ArticleModel::Private::articlesUpdated(const QVector<Article> &list)
 236 {
 237     int rmin = 0;
 238     int rmax = 0;
 239
 240     const int numberOfArticles(articles.count());
 241     if (numberOfArticles > 0) {
 242         rmin = numberOfArticles - 1;
 243         //might want to avoid indexOf() in case of performance problems
 244         Q_FOREACH (const Article &i, list) {
 245             const int row = articles.indexOf(i);
 246             //TODO: figure out how why the Article might not be found in
 247             //TODO: the articles list because we should need this conditional.
 248             if (row >= 0) {
 249                 titleCache[row] = stripHtml(articles[row].title());
 250                 rmin = std::min(row, rmin);
 251                 rmax = std::max(row, rmax);
 252             }
 253         }
 254     }
 255     Q_EMIT q->dataChanged(q->index(rmin, 0), q->index(rmax, ColumnCount - 1));
 256 }
 257
 258 bool ArticleModel::rowMatches(int row, const QSharedPointer<const Filters::AbstractMatcher> &matcher) const
 259 {
 260     Q_ASSERT(matcher);
 261     return matcher->matches(article(row));
 262 }
 263
 264 Article ArticleModel::article(int row) const
 265 {
 266     if (row < 0 || row >= d->articles.count()) {
 267         return Article();
 268     }
 269     return d->articles[row];
 270 }
 271
 272 QStringList ArticleModel::mimeTypes() const
 273 {
 274     return QStringList() << QStringLiteral("text/uri-list");
 275 }
 276
 277 QMimeData *ArticleModel::mimeData(const QModelIndexList &indexes) const
 278 {
 279     QScopedPointer<QMimeData> md(new QMimeData);
 280     QList<QUrl> urls;
 281     Q_FOREACH (const QModelIndex &i, indexes) {
 282         const QUrl url = i.data(ArticleModel::LinkRole).toUrl();
 283         if (url.isValid()) {
 284             urls.push_back(url);
 285         } else {
 286             const QUrl guid(i.data(ArticleModel::GuidRole).toString());
 287             if (guid.isValid()) {
 288                 urls.push_back(guid);
 289             }
 290         }
 291     }
 292     md->setUrls(urls);
 293     return md.take();
 294 }
 295
 296 Qt::ItemFlags ArticleModel::flags(const QModelIndex &idx) const
 297 {
 298     const Qt::ItemFlags f = QAbstractTableModel::flags(idx);
 299     if (!idx.isValid()) {
 300         return f;
 301     }
 302     return f | Qt::ItemIsDragEnabled;
 303 }
 304