FCL/sf/app/podcatcher: engine/inc/FeedEngine.h@71493655568a (annotated)

2 29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	1	/*
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	2	* Copyright (c) 2007-2010 Sebastian Brannstrom, Lars Persson, EmbedDev AB
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	3	*
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	4	* All rights reserved.
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	5	* This component and the accompanying materials are made available
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	6	* under the terms of the License "Eclipse Public License v1.0"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	7	* which accompanies this distribution, and is available
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	8	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	9	*
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	10	* Initial Contributors:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	11	* EmbedDev AB - initial contribution.
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	12	*
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	13	* Contributors:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	14	*
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	15	* Description:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	16	*
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	17	*/
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	18
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	19	#ifndef FEEDENGINE_H_
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	20	#define FEEDENGINE_H_
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	21
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	22	#include "HttpClientObserver.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	23	#include "HttpClient.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	24	#include "FeedParser.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	25	#include "FeedInfo.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	26	#include "ShowInfo.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	27	#include <e32cmn.h>
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	28	#include "Constants.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	29	#include "FeedEngineObserver.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	30	#include "FeedTimer.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	31	#include "sqlite3.h"
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	32
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	33	class CPodcastModel;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	34	class COpmlParser;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	35
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	36	_LIT(KOpmlFeed, " <outline title=\"%S\" description=\"%S\" xmlUrl=\"%S\" htmlUrl=\"%S\"/>");
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	37	_LIT(KOpmlHeader, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<opml version=\"1.1\" xmlns:podcastSearch=\"http://digitalpodcast.com/podcastsearchservice/output_specs.html\">\n<head>\n <title>Podcast Feed List</title>\n</head>\n<body>\n <outline>");
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	38	_LIT(KOpmlFooter, " </outline>\n</body>\n</opml>");
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	39
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	40	_LIT(KSearchUrl, "http://www.digitalpodcast.com/podcastsearchservice/v2b/search/?appid=SymbianPodcatcher&keywords=%S&format=rssopml&sort=rel&searchsource=all&contentfilter=noadult&start=0&results=20");
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	41	_LIT(KSearchResultsFileName, "searchresults.opml");
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	42
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	43	const TInt KMaxUidBufLen = 20;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	44	const TInt KMaxTitleLength = 512;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	45	const TInt KMaxDescriptionLength = 1024;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	46	const TInt KMaxURLLength = 512;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	47	const TInt KMaxLineLength = 4096;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	48	const TInt KMaxSearchString = 30;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	49
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	50	enum TClientState {
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	51	EIdle,
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	52	EUpdatingFeed,
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	53	EUpdatingImage,
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	54	ESearching
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	55	};
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	56
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	57	class CFeedEngine : public CBase, public MHttpClientObserver, public MFeedParserObserver
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	58	{
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	59	public:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	60	static CFeedEngine* NewL(CPodcastModel& aPodcastModel);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	61	virtual ~CFeedEngine();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	62
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	63	public:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	64	IMPORT_C TBool AddFeedL(const CFeedInfo& item);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	65	IMPORT_C void ImportFeedsL(const TDesC& aFile);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	66	IMPORT_C TBool ExportFeedsL(TFileName& aFile);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	67	IMPORT_C void RemoveFeedL(TUint aUid);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	68	IMPORT_C TBool UpdateFeedL(TUint aFeedUid);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	69	IMPORT_C void UpdateAllFeedsL(TBool aAutoUpdate = EFalse);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	70	IMPORT_C void CancelUpdateAllFeeds();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	71	IMPORT_C const RFeedInfoArray& GetSortedFeeds();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	72	IMPORT_C CFeedInfo* GetFeedInfoByUid(TUint aFeedUid);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	73	IMPORT_C void GetStatsByFeed(TUint aFeedUid, TUint &aNumShows, TUint &aNumUnplayed);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	74	IMPORT_C void GetDownloadedStats(TUint &aNumShows, TUint &aNumUnplayed);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	75
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	76	IMPORT_C void AddObserver(MFeedEngineObserver *observer);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	77	IMPORT_C void RemoveObserver(MFeedEngineObserver *observer);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	78
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	79	void RunFeedTimer();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	80
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	81	IMPORT_C void UpdateFeed(CFeedInfo *aItem);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	82	/**
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	83	* Returns the current internal state of the feed engine4
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	84	*/
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	85	IMPORT_C TClientState ClientState();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	86
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	87	/**
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	88	* Returns the current updating client UID if clientstate is != ENotUpdateing
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	89	* @return TUint
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	90	*/
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	91	IMPORT_C TUint ActiveClientUid();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	92
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	93	IMPORT_C void SearchForFeedL(TDesC& aSearchString);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	94	IMPORT_C void AddSearchResultL(CFeedInfo *item);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	95	IMPORT_C const RFeedInfoArray& GetSearchResults();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	96
7 a7a43293ae56 Added error handling for searching teknolog parents: 2 diff changeset	97	IMPORT_C void OpmlParsingComplete(TInt aError, TUint aNumFeedsAdded);
2 29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	98	protected:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	99
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	100	static TInt CompareFeedsByTitle(const CFeedInfo &a, const CFeedInfo &b);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	101
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	102	private:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	103	void ConstructL();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	104	CFeedEngine(CPodcastModel& aPodcastModel);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	105
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	106	// from HttpClientObserver
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	107	void Connected(CHttpClient* aClient);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	108	void Disconnected(CHttpClient* aClient);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	109	void Progress(CHttpClient* aHttpClient, TInt aBytes, TInt aTotalBytes);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	110	void DownloadInfo(CHttpClient* aClient, TInt aSize);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	111	void CompleteL(CHttpClient* aClient, TInt aError);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	112	void FileError(TUint /aError/) { }
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	113	// from FeedParser
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	114	void NewShowL(CShowInfo& aItem);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	115	void ParsingCompleteL(CFeedInfo *aItem);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	116
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	117	void GetFeedImageL(CFeedInfo *aFeedInfo);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	118
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	119	void UpdateNextFeedL();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	120	void NotifyFeedUpdateComplete(TInt aError);
7 a7a43293ae56 Added error handling for searching teknolog parents: 2 diff changeset	121	void NotifyOpmlParsingComplete(TInt aError, TUint aNumFeedsAdded);
2 29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	122
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	123
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	124	private:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	125	void DBLoadFeedsL();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	126	TBool DBRemoveFeed(TUint aUid);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	127	TBool DBAddFeedL(const CFeedInfo& aTtem);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	128	CFeedInfo* DBGetFeedInfoByUidL(TUint aFeedUid);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	129	TUint DBGetFeedCount();
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	130	TBool DBUpdateFeed(const CFeedInfo& aItem);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	131	void DBGetStatsByFeed(TUint aFeedUid, TUint &aNumShows, TUint &aNumUnplayed);
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	132
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	133
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	134	private:
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	135	CHttpClient* iFeedClient;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	136	TClientState iClientState;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	137	CFeedTimer iFeedTimer;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	138
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	139	CPodcastModel& iPodcastModel;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	140
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	141	// RSS parser
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	142	CFeedParser* iParser;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	143
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	144	// the list of feeds
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	145	RFeedInfoArray iSortedFeeds;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	146
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	147	CFeedInfo *iActiveFeed;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	148	TFileName iUpdatingFeedFileName;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	149	TFileName iSearchResultsFileName;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	150	RFeedInfoArray iFeedsUpdating;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	151
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	152	// observers that will receive callbacks, not owning
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	153	RArray<MFeedEngineObserver*> iObservers;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	154
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	155	TBool iCatchupMode;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	156	TUint iCatchupCounter;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	157
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	158	sqlite3& iDB;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	159
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	160	TBuf<KDefaultSQLDataBufferLength> iSqlBuffer;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	161
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	162	COpmlParser* iOpmlParser;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	163	RFeedInfoArray iSearchResults;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	164	TBool iAutoUpdatedInitiator;
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	165	};
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	166	#endif /FEEDENGINE_H_/
29cda98b007e Initial import of Podcatcher from the Bergamot project skip parents: diff changeset	167

author	teknolog
	Sun, 28 Feb 2010 21:19:40 +0000
changeset 26	71493655568a
parent 7	a7a43293ae56
child 32	26a3f2dfba08
child 35	66c5303f3610
permissions	-rw-r--r--