2018-11-04 09:48:33 -05:00
|
|
|
/*******************************************************************************
|
|
|
|
* plugins/FeedReader/services/p3FeedReader.h *
|
|
|
|
* *
|
|
|
|
* Copyright (C) 2012 by Thunder <retroshare.project@gmail.com> *
|
|
|
|
* *
|
|
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
|
|
* it under the terms of the GNU Affero General Public License as *
|
|
|
|
* published by the Free Software Foundation, either version 3 of the *
|
|
|
|
* License, or (at your option) any later version. *
|
|
|
|
* *
|
|
|
|
* This program is distributed in the hope that it will be useful, *
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
|
|
* GNU Affero General Public License for more details. *
|
|
|
|
* *
|
|
|
|
* You should have received a copy of the GNU Affero General Public License *
|
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>. *
|
|
|
|
* *
|
|
|
|
*******************************************************************************/
|
2012-08-02 09:17:53 -04:00
|
|
|
|
2012-08-10 14:06:29 -04:00
|
|
|
#ifndef P3_FEEDREADER
|
2012-08-02 09:17:53 -04:00
|
|
|
#define P3_FEEDREADER
|
|
|
|
|
|
|
|
#include "retroshare/rsplugin.h"
|
|
|
|
#include "plugins/rspqiservice.h"
|
|
|
|
#include "interface/rsFeedReader.h"
|
|
|
|
|
2014-11-24 17:40:29 -05:00
|
|
|
#include "retroshare/rsgxsifacetypes.h"
|
|
|
|
|
2012-08-02 09:17:53 -04:00
|
|
|
class RsFeedReaderFeed;
|
2012-09-04 19:53:04 -04:00
|
|
|
class RsFeedReaderMsg;
|
|
|
|
class p3FeedReaderThread;
|
2012-08-02 09:17:53 -04:00
|
|
|
|
2014-11-24 17:40:29 -05:00
|
|
|
class RsGxsForums;
|
2019-02-14 17:15:54 -05:00
|
|
|
struct RsGxsForumGroup;
|
2014-02-04 17:06:33 -05:00
|
|
|
|
2012-08-02 09:17:53 -04:00
|
|
|
class p3FeedReader : public RsPQIService, public RsFeedReader
|
|
|
|
{
|
|
|
|
public:
|
2014-11-24 17:40:29 -05:00
|
|
|
p3FeedReader(RsPluginHandler *pgHandler, RsGxsForums *forums);
|
2012-08-02 09:17:53 -04:00
|
|
|
|
|
|
|
/****************** FeedReader Interface *************/
|
|
|
|
virtual void stop();
|
|
|
|
virtual void setNotify(RsFeedReaderNotify *notify);
|
|
|
|
|
|
|
|
virtual uint32_t getStandardStorageTime();
|
|
|
|
virtual void setStandardStorageTime(uint32_t storageTime);
|
|
|
|
virtual uint32_t getStandardUpdateInterval();
|
|
|
|
virtual void setStandardUpdateInterval(uint32_t updateInterval);
|
|
|
|
virtual bool getStandardProxy(std::string &proxyAddress, uint16_t &proxyPort);
|
|
|
|
virtual void setStandardProxy(bool useProxy, const std::string &proxyAddress, uint16_t proxyPort);
|
2013-05-01 17:16:46 -04:00
|
|
|
virtual bool getSaveInBackground();
|
|
|
|
virtual void setSaveInBackground(bool saveInBackground);
|
2012-08-02 09:17:53 -04:00
|
|
|
|
2012-08-13 17:35:11 -04:00
|
|
|
virtual RsFeedAddResult addFolder(const std::string parentId, const std::string &name, std::string &feedId);
|
|
|
|
virtual RsFeedAddResult setFolder(const std::string &feedId, const std::string &name);
|
|
|
|
virtual RsFeedAddResult addFeed(const FeedInfo &feedInfo, std::string &feedId);
|
|
|
|
virtual RsFeedAddResult setFeed(const std::string &feedId, const FeedInfo &feedInfo);
|
|
|
|
virtual bool removeFeed(const std::string &feedId);
|
|
|
|
virtual bool addPreviewFeed(const FeedInfo &feedInfo, std::string &feedId);
|
|
|
|
virtual void getFeedList(const std::string &parentId, std::list<FeedInfo> &feedInfos);
|
|
|
|
virtual bool getFeedInfo(const std::string &feedId, FeedInfo &feedInfo);
|
|
|
|
virtual bool getMsgInfo(const std::string &feedId, const std::string &msgId, FeedMsgInfo &msgInfo);
|
|
|
|
virtual bool removeMsg(const std::string &feedId, const std::string &msgId);
|
|
|
|
virtual bool removeMsgs(const std::string &feedId, const std::list<std::string> &msgIds);
|
|
|
|
virtual bool getMessageCount(const std::string &feedId, uint32_t *msgCount, uint32_t *newCount, uint32_t *unreadCount);
|
|
|
|
virtual bool getFeedMsgList(const std::string &feedId, std::list<FeedMsgInfo> &msgInfos);
|
|
|
|
virtual bool getFeedMsgIdList(const std::string &feedId, std::list<std::string> &msgIds);
|
|
|
|
virtual bool processFeed(const std::string &feedId);
|
|
|
|
virtual bool setMessageRead(const std::string &feedId, const std::string &msgId, bool read);
|
2013-01-21 19:11:43 -05:00
|
|
|
virtual bool retransformMsg(const std::string &feedId, const std::string &msgId);
|
2014-11-24 17:40:29 -05:00
|
|
|
virtual bool clearMessageCache(const std::string &feedId);
|
2012-08-02 09:17:53 -04:00
|
|
|
|
2012-09-04 19:53:04 -04:00
|
|
|
virtual RsFeedReaderErrorState processXPath(const std::list<std::string> &xpathsToUse, const std::list<std::string> &xpathsToRemove, std::string &description, std::string &errorString);
|
2013-01-21 19:11:43 -05:00
|
|
|
virtual RsFeedReaderErrorState processXslt(const std::string &xslt, std::string &description, std::string &errorString);
|
2012-09-04 19:53:04 -04:00
|
|
|
|
2012-08-02 09:17:53 -04:00
|
|
|
/****************** p3Service STUFF ******************/
|
|
|
|
virtual int tick();
|
2014-04-23 16:48:02 -04:00
|
|
|
virtual RsServiceInfo getServiceInfo() ;
|
2012-08-02 09:17:53 -04:00
|
|
|
|
|
|
|
/****************** internal STUFF *******************/
|
2012-08-13 17:35:11 -04:00
|
|
|
bool getFeedToDownload(RsFeedReaderFeed &feed, const std::string &neededFeedId);
|
2012-08-02 09:17:53 -04:00
|
|
|
void onDownloadSuccess(const std::string &feedId, const std::string &content, std::string &icon);
|
2012-09-04 19:53:04 -04:00
|
|
|
void onDownloadError(const std::string &feedId, RsFeedReaderErrorState result, const std::string &errorString);
|
|
|
|
void onProcessSuccess_filterMsg(const std::string &feedId, std::list<RsFeedReaderMsg*> &msgs);
|
|
|
|
void onProcessSuccess_addMsgs(const std::string &feedId, std::list<RsFeedReaderMsg*> &msgs, bool single);
|
|
|
|
void onProcessError(const std::string &feedId, RsFeedReaderErrorState result, const std::string &errorString);
|
2012-08-02 09:17:53 -04:00
|
|
|
|
2012-08-13 17:35:11 -04:00
|
|
|
bool getFeedToProcess(RsFeedReaderFeed &feed, const std::string &neededFeedId);
|
2012-08-02 09:17:53 -04:00
|
|
|
|
|
|
|
void setFeedInfo(const std::string &feedId, const std::string &name, const std::string &description);
|
|
|
|
|
2014-11-24 17:40:29 -05:00
|
|
|
bool getForumGroup(const RsGxsGroupId &groupId, RsGxsForumGroup &forumGroup);
|
|
|
|
bool updateForumGroup(const RsGxsForumGroup &forumGroup, const std::string &groupName, const std::string &groupDescription);
|
|
|
|
bool waitForToken(uint32_t token);
|
|
|
|
|
2012-08-02 09:17:53 -04:00
|
|
|
protected:
|
|
|
|
/****************** p3Config STUFF *******************/
|
|
|
|
virtual RsSerialiser *setupSerialiser();
|
|
|
|
virtual bool saveList(bool &cleanup, std::list<RsItem *>&);
|
|
|
|
virtual bool loadList(std::list<RsItem *>& load);
|
|
|
|
virtual void saveDone();
|
|
|
|
|
|
|
|
private:
|
|
|
|
void cleanFeeds();
|
|
|
|
void deleteAllMsgs_locked(RsFeedReaderFeed *fi);
|
2012-08-13 17:35:11 -04:00
|
|
|
void stopPreviewThreads_locked();
|
2012-08-02 09:17:53 -04:00
|
|
|
|
2014-11-24 17:40:29 -05:00
|
|
|
private:
|
2012-08-02 09:17:53 -04:00
|
|
|
time_t mLastClean;
|
2014-11-24 17:40:29 -05:00
|
|
|
RsGxsForums *mForums;
|
2012-08-02 09:17:53 -04:00
|
|
|
RsFeedReaderNotify *mNotify;
|
2014-11-24 17:40:29 -05:00
|
|
|
volatile bool mStopped;
|
2012-08-02 09:17:53 -04:00
|
|
|
|
|
|
|
RsMutex mFeedReaderMtx;
|
2013-05-01 17:16:46 -04:00
|
|
|
std::list<RsItem*> cleanSaveData;
|
|
|
|
bool mSaveInBackground;
|
2012-08-13 17:35:11 -04:00
|
|
|
std::list<p3FeedReaderThread*> mThreads;
|
|
|
|
uint32_t mNextFeedId;
|
|
|
|
uint32_t mNextMsgId;
|
|
|
|
int32_t mNextPreviewFeedId;
|
|
|
|
int32_t mNextPreviewMsgId;
|
2012-08-02 09:17:53 -04:00
|
|
|
uint32_t mStandardUpdateInterval;
|
|
|
|
uint32_t mStandardStorageTime;
|
|
|
|
bool mStandardUseProxy;
|
|
|
|
std::string mStandardProxyAddress;
|
|
|
|
uint16_t mStandardProxyPort;
|
|
|
|
std::map<std::string, RsFeedReaderFeed*> mFeeds;
|
|
|
|
|
|
|
|
RsMutex mDownloadMutex;
|
|
|
|
std::list<std::string> mDownloadFeeds;
|
|
|
|
|
|
|
|
RsMutex mProcessMutex;
|
|
|
|
std::list<std::string> mProcessFeeds;
|
2012-08-13 17:35:11 -04:00
|
|
|
|
|
|
|
RsMutex mPreviewMutex;
|
|
|
|
p3FeedReaderThread *mPreviewDownloadThread;
|
|
|
|
p3FeedReaderThread *mPreviewProcessThread;
|
2012-08-02 09:17:53 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|