• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KNewStuff

  • knewstuff
  • knewstuff2
  • core
providerhandler.cpp
Go to the documentation of this file.
1 /*
2  This file is part of KNewStuff2.
3  Copyright (c) 2002 Cornelius Schumacher <schumacher@kde.org>
4  Copyright (c) 2003 - 2007 Josef Spillner <spillner@kde.org>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Lesser General Public
8  License as published by the Free Software Foundation; either
9  version 2.1 of the License, or (at your option) any later version.
10 
11  This library 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 GNU
14  Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public
17  License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #include "providerhandler.h"
21 
22 //#include <kconfig.h>
23 #include <kdebug.h>
24 //#include <kio/job.h>
25 #include <kglobal.h>
26 //#include <kmessagebox.h>
27 #include <klocale.h>
28 
29 #include "feed.h"
30 
31 using namespace KNS;
32 
33 ProviderHandler::ProviderHandler(const Provider& provider)
34 {
35  mValid = false;
36  mProvider = provider;
37  mProviderXML = serializeElement(provider);
38 }
39 
40 ProviderHandler::ProviderHandler(const QDomElement& providerxml)
41  :mProviderXML(providerxml)
42  ,mValid(false)
43 {
44  mProvider = deserializeElement(providerxml);
45 }
46 
47 bool ProviderHandler::isValid()
48 {
49  return mValid;
50 }
51 
52 QDomElement ProviderHandler::providerXML()
53 {
54  return mProviderXML;
55 }
56 
57 Provider *ProviderHandler::providerptr()
58 {
59  Provider *provider = new Provider();
60  provider->setName(mProvider.name());
61  //provider->setDownloadUrl(mProvider.downloadUrl());
62  provider->setUploadUrl(mProvider.uploadUrl());
63  provider->setNoUploadUrl(mProvider.noUploadUrl());
64  provider->setWebAccess(mProvider.webAccess());
65  provider->setWebService(mProvider.webService());
66  provider->setIcon(mProvider.icon());
67 
68  const QStringList feeds = mProvider.feeds();
69  for (QStringList::ConstIterator it = feeds.begin(); it != feeds.end(); ++it) {
70  Feed *feed = mProvider.downloadUrlFeed((*it));
71  provider->addDownloadUrlFeed((*it), feed);
72  }
73  return provider;
74 }
75 
76 Provider ProviderHandler::provider()
77 {
78  return mProvider;
79 }
80 
81 QDomElement ProviderHandler::serializeElement(const Provider& provider)
82 {
83  QDomDocument doc;
84 
85  QDomElement el = doc.createElement("provider");
86 
87  KTranslatable name = provider.name();
88 
89  QStringList::ConstIterator it;
90  QDomElement e;
91  const QStringList langs = name.languages();
92  for (it = langs.begin(); it != langs.end(); ++it) {
93  e = addElement(doc, el, "title", name.translated(*it));
94  e.setAttribute("lang", *it);
95  }
96 
97  /*if(provider.downloadUrl().isValid())
98  {
99  el.setAttribute("downloadurl", provider.downloadUrl().url());
100  }*/
101  if (provider.uploadUrl().isValid()) {
102  el.setAttribute("uploadurl", provider.uploadUrl().url());
103  }
104  if (provider.noUploadUrl().isValid()) {
105  el.setAttribute("nouploadurl", provider.noUploadUrl().url());
106  }
107  if (provider.webAccess().isValid()) {
108  el.setAttribute("webaccess", provider.webAccess().url());
109  }
110  if (provider.webService().isValid()) {
111  el.setAttribute("webservice", provider.webService().url());
112  }
113  if (provider.icon().isValid()) {
114  el.setAttribute("icon", provider.icon().url());
115  }
116 
117  const QStringList feeds = provider.feeds();
118  for (QStringList::ConstIterator it = feeds.begin(); it != feeds.end(); ++it) {
119  Feed *feed = provider.downloadUrlFeed((*it));
120  if ((*it).isEmpty())
121  el.setAttribute("downloadurl", feed->feedUrl().url());
122  else
123  el.setAttribute("downloadurl-" + (*it), feed->feedUrl().url());
124  }
125 
126  mValid = true;
127  return el;
128 }
129 
130 Provider ProviderHandler::deserializeElement(const QDomElement& providerxml)
131 {
132  Provider provider;
133  KTranslatable name;
134 
135  if (providerxml.tagName() != "provider") return provider;
136 
137  QString uploadurl = providerxml.attribute("uploadurl");
138  QString nouploadurl = providerxml.attribute("nouploadurl");
139  QString webservice = providerxml.attribute("webservice");
140  QString webaccess = providerxml.attribute("webaccess");
141  //provider.setDownloadUrl(KUrl(downloadurl));
142  provider.setUploadUrl(KUrl(uploadurl));
143  provider.setNoUploadUrl(KUrl(nouploadurl));
144  provider.setWebService(KUrl(webservice));
145  provider.setWebAccess(KUrl(webaccess));
146 
147  QString downloadurl = providerxml.attribute("downloadurl");
148  QString downloadlatest = providerxml.attribute("downloadurl-latest");
149  QString downloadscore = providerxml.attribute("downloadurl-score");
150  QString downloaddownloads = providerxml.attribute("downloadurl-downloads");
151 
152  if (!downloadlatest.isEmpty()) {
153  Feed *feedlatest = new Feed();
154  feedlatest->setName(i18nc("describes the feed of the latest posted entries", "Latest"));
155  feedlatest->setFeedUrl(downloadlatest);
156  provider.addDownloadUrlFeed("latest", feedlatest);
157  }
158  if (!downloadscore.isEmpty()) {
159  Feed *feedscore = new Feed();
160  feedscore->setName(i18n("Highest Rated"));
161  feedscore->setFeedUrl(downloadscore);
162  provider.addDownloadUrlFeed("score", feedscore);
163  }
164  if (!downloaddownloads.isEmpty()) {
165  Feed *feeddownloads = new Feed();
166  feeddownloads->setName(i18n("Most Downloads"));
167  feeddownloads->setFeedUrl(downloaddownloads);
168  provider.addDownloadUrlFeed("downloads", feeddownloads);
169  }
170  if (!downloadurl.isEmpty()) {
171  Feed *feedgeneric = new Feed();
172  // feedgeneric->setName(i18n("Unsorted"));
173  // Currently this is used for latest
174  feedgeneric->setName(i18nc("describes the feed of the latest posted entries", "Latest"));
175  feedgeneric->setFeedUrl(downloadurl);
176  provider.addDownloadUrlFeed(QString(), feedgeneric);
177  }
178 
179  // FIXME: what exactly is the following condition supposed to do?
180  // FIXME: make sure new KUrl in KDE 4 handles this right
181  // FIXME: this depends on freedesktop.org icon naming... introduce 'desktopicon'?
182  KUrl iconurl(providerxml.attribute("icon"));
183  if (!iconurl.isValid()) iconurl.setPath(providerxml.attribute("icon"));
184  provider.setIcon(iconurl);
185 
186  QDomNode n;
187  for (n = providerxml.firstChild(); !n.isNull(); n = n.nextSibling()) {
188  QDomElement e = n.toElement();
189  if (e.tagName() == "title") {
190  QString lang = e.attribute("lang");
191  name.addString(lang, e.text().trimmed());
192  }
193  }
194 
195  provider.setName(name);
196 
197  // Validation
198 
199  if ((provider.noUploadUrl().isValid()) && (provider.uploadUrl().isValid())) {
200  //kWarning(550) << "ProviderHandler: both uploadurl and nouploadurl given";
201  return provider;
202  }
203 
204  if ((!provider.noUploadUrl().isValid()) && (!provider.uploadUrl().isValid())) {
205  if (!provider.webService().isValid()) {
206  //kWarning(550) << "ProviderHandler: neither uploadurl nor nouploadurl nor DXS given";
207  return provider;
208  }
209  }
210 
211  // Provider is valid
212 
213  mValid = true;
214  return provider;
215 }
216 
217 // FIXME: also used in EntryHandler - make common method?
218 QDomElement ProviderHandler::addElement(QDomDocument& doc, QDomElement& parent,
219  const QString& tag, const QString& value)
220 {
221  QDomElement n = doc.createElement(tag);
222  n.appendChild(doc.createTextNode(value));
223  parent.appendChild(n);
224 
225  return n;
226 }
KNS::Feed
KNewStuff feed.
Definition: feed.h:46
KNS::Feed::feedUrl
KUrl feedUrl() const
Retrieve the URL of the feed.
Definition: feed.cpp:67
KNS::Feed::setFeedUrl
void setFeedUrl(const KUrl &feedurl)
Sets the URL for this feed.
Definition: feed.cpp:62
KNS::Feed::setName
void setName(const KTranslatable &name)
Sets the name for this feed.
Definition: feed.cpp:42
KNS::KTranslatable
String class with multiple localized representations.
Definition: ktranslatable.h:42
KNS::ProviderHandler::provider
Provider provider()
Definition: providerhandler.cpp:76
KNS::ProviderHandler::providerXML
QDomElement providerXML()
Definition: providerhandler.cpp:52
KNS::ProviderHandler::isValid
bool isValid()
Definition: providerhandler.cpp:47
KNS::ProviderHandler::ProviderHandler
ProviderHandler(const QDomElement &providerxml)
Definition: providerhandler.cpp:40
KNS::ProviderHandler::providerptr
Provider * providerptr()
Definition: providerhandler.cpp:57
KNS::Provider
KNewStuff provider container.
Definition: knewstuff2/core/provider.h:52
KNS::Provider::downloadUrlFeed
Feed * downloadUrlFeed(const QString &feedtype) const
Feed to retrieve for the given feed type.
Definition: knewstuff2/core/provider.cpp:50
KNS::Provider::uploadUrl
KUrl uploadUrl() const
Retrieves the upload URL.
Definition: knewstuff2/core/provider.cpp:84
KNS::Provider::setWebService
void setWebService(const KUrl &)
Sets the URL of the DXS, if offered by the provider.
Definition: knewstuff2/core/provider.cpp:109
KNS::Provider::webAccess
KUrl webAccess() const
Retrieves the web frontend URL.
Definition: knewstuff2/core/provider.cpp:104
KNS::Provider::addDownloadUrlFeed
void addDownloadUrlFeed(const QString &feedtype, Feed *feed)
Adds a feed URL.
Definition: knewstuff2/core/provider.cpp:44
KNS::Provider::setWebAccess
void setWebAccess(const KUrl &)
Sets the URL of a web frontend for the provider.
Definition: knewstuff2/core/provider.cpp:99
KNS::Provider::setName
void setName(const KTranslatable &name)
Sets the common name of the provider.
Definition: knewstuff2/core/provider.cpp:59
KNS::Provider::setUploadUrl
void setUploadUrl(const KUrl &)
Sets the upload URL.
Definition: knewstuff2/core/provider.cpp:79
KNS::Provider::feeds
QStringList feeds() const
Returns a list of all feeds.
Definition: knewstuff2/core/provider.cpp:119
KNS::Provider::noUploadUrl
KUrl noUploadUrl() const
Retrieves the URL where a user is led if the provider does not support uploads.
Definition: knewstuff2/core/provider.cpp:94
KNS::Provider::name
KTranslatable name() const
Retrieves the common name of the provider.
Definition: knewstuff2/core/provider.cpp:64
KNS::Provider::setIcon
void setIcon(const KUrl &)
Sets the URL for an icon for this provider.
Definition: knewstuff2/core/provider.cpp:69
KNS::Provider::setNoUploadUrl
void setNoUploadUrl(const KUrl &)
Sets the URL where a user is led if the provider does not support uploads.
Definition: knewstuff2/core/provider.cpp:89
KNS::Provider::icon
KUrl icon() const
Retrieves the icon URL for this provider.
Definition: knewstuff2/core/provider.cpp:74
KNS::Provider::webService
KUrl webService() const
Retrieves the URL to the DXS Web Service.
Definition: knewstuff2/core/provider.cpp:114
KUrl
KUrl::url
QString url(AdjustPathOption trailing=LeaveTrailingSlash) const
feed.h
kdebug.h
kglobal.h
klocale.h
i18n
QString i18n(const char *text)
i18nc
QString i18nc(const char *ctxt, const char *text)
KNS
Definition: knewstuff2/core/author.h:27
name
const char * name(StandardAction id)
providerhandler.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Jan 26 2021 00:00:00 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KNewStuff

Skip menu "KNewStuff"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal