jadedctrl/ Pogger
1
0
Disbranĉigi 0
Fontkodo Issues 4 Tirpetoj Activity

Restructure Feed to fetch XML only as necessary; restrict access to data

This commit is contained in:
Jaidyn Ann 2020-11-16 21:32:06 -06:00
parent 093c90aed2
commit 3c0725b272
5 changed files with 130 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/AtomFeed.cpp
View File

@ -11,12 +11,12 @@ AtomFeed::AtomFeed ( )
description = BString("");
homeUrl = BString("");
xmlUrl = BString("");
filePath = BString("");
cachePath = BString("");
outputDir = ((App*)be_app)->cfg->outDir;
}
AtomFeed::AtomFeed ( Feed* feed ) : AtomFeed::AtomFeed()
{ filePath = feed->filePath; }
{ SetCachePath( feed->GetCachePath() ); }
// ----------------------------------------------------------------------------
@ -25,7 +25,7 @@ AtomFeed::Parse ( )
{
entries = BList();
tinyxml2::XMLDocument xml;
xml.LoadFile( filePath.String() );
xml.LoadFile( GetCachePath().String() );
Feed::Parse();
@ -34,7 +34,7 @@ AtomFeed::Parse ( )
RootParse( xfeed );
ParseEntries( xfeed );
BFile* feedFile = new BFile( filePath.String(), B_READ_WRITE );
BFile* feedFile = new BFile( GetCachePath().String(), B_READ_WRITE );
time_t tt_lastDate = lastDate.Time_t();
feedFile->WriteAttr( "LastDate", B_TIME_TYPE, 0, &tt_lastDate, sizeof(time_t) );
}

117
src/Feed.cpp
View File

@ -12,7 +12,9 @@ Feed::Feed ( BString path )
homeUrl = BString("");
xmlUrl = BString("");
updated = true;
filePath = GetCachePath( path );
fetched = false;
inputPath = path;
SetCachePath( path );
}
Feed::Feed ( )
@ -28,7 +30,7 @@ Feed::Feed ( )
void
Feed::Parse ( )
{
BFile* feedFile = new BFile( filePath.String(), B_READ_ONLY );
BFile* feedFile = new BFile( GetCachePath().String(), B_READ_ONLY );
time_t tt_lastDate = 0;
BDateTime attrLastDate = BDateTime();
@ -41,43 +43,26 @@ Feed::Parse ( )
// -------------------------------------
// -------------------------------------
// Download a remote feed's XML to the cache path.
BString
Feed::GetCachePath ( BString givenPath )
Feed::FetchRemoteFeed ( )
{
BUrl givenUrl = BUrl( givenPath );
BString protocol = givenUrl.Protocol().String();
if ( protocol == NULL && givenUrl.UrlString() != NULL )
return givenPath;
if ( protocol != BString("http") && protocol != BString("https") )
return NULL;
return FetchRemoteFeed( givenPath );
}
BString
Feed::FetchRemoteFeed ( BString givenPath )
{
BUrl givenUrl = BUrl( givenPath );
BUrl givenUrl = BUrl( inputPath );
time_t tt_lastDate = 0;
BDateTime* lastDate = new BDateTime();
BString* newHash = new BString();
char oldHash[41];
BString splitName = givenUrl.Host( );
splitName.Append( givenUrl.Path() );
splitName.ReplaceAll("/", "_");
BString filename = ((App*)be_app)->cfg->cacheDir;
filename.Append(splitName);
BFile* cacheFile = new BFile( filename, B_READ_WRITE | B_CREATE_FILE );
BFile* cacheFile = new BFile( GetCachePath(), B_READ_WRITE | B_CREATE_FILE );
cacheFile->ReadAttr( "LastHash", B_STRING_TYPE, 0, oldHash, 41 );
if ( ((App*)be_app)->cfg->verbose )
printf( "Saving %s...\n", givenPath.String() );
printf( "Saving %s...\n", inputPath.String() );
webFetch( givenUrl, cacheFile, newHash );
webFetch( BUrl(inputPath), cacheFile, newHash );
cacheFile->WriteAttr( "LastHash", B_STRING_TYPE, 0,
newHash->String(), newHash->CountChars() );
@ -85,27 +70,45 @@ Feed::FetchRemoteFeed ( BString givenPath )
if ( *(newHash) == BString(oldHash) )
updated = false;
return filename;
fetched = true;
return GetCachePath();
}
// ----------------------------------------------------------------------------
// return whether or not the feed's given URI/path is remote.
bool
Feed::IsRemote ( )
{
return isRemotePath( inputPath );
}
// return whether or not the feed seems to have been updated
bool
Feed::IsUpdated ( )
{
return updated;
}
// return whether or not feed is RSS
bool
Feed::IsRss ( )
{
EnsureCached();
tinyxml2::XMLDocument xml;
xml.LoadFile( filePath.String() );
xml.LoadFile( GetCachePath().String() );
if ( xml.FirstChildElement("rss") )
return true;
return false;
}
// return whether or not feed is Atom
bool
Feed::IsAtom ( )
{
tinyxml2::XMLDocument xml;
xml.LoadFile( filePath.String() );
xml.LoadFile( GetCachePath().String() );
if ( xml.FirstChildElement("feed") )
return true;
@ -114,6 +117,52 @@ Feed::IsAtom ( )
// ----------------------------------------------------------------------------
// ensure the feed XML is available at the cache path.
// if necessary, download it.
void
Feed::EnsureCached ( )
{
if ( IsRemote() && fetched == false )
FetchRemoteFeed();
}
// Return the 'cachePath' (location of XML file locally)
BString
Feed::GetCachePath ( )
{
if ( cachePath == NULL )
SetCachePath( inputPath );
return cachePath;
}
// Select a 'cachePath' (location of XML file locally)
// For remote files, a cache file is created in ~/config/cache/Pogger/ by default
// For local files, the same local file is used.
BString
Feed::SetCachePath ( BString givenPath )
{
BUrl givenUrl = BUrl( givenPath );
BString protocol = givenUrl.Protocol().String();
if ( protocol == NULL && givenUrl.UrlString() != NULL ) {
cachePath = givenPath;
return givenPath;
}
BString splitName = givenUrl.Host( );
splitName.Append( givenUrl.Path() );
splitName.ReplaceAll("/", "_");
BString filename = ((App*)be_app)->cfg->cacheDir;
filename.Append(splitName);
cachePath = filename;
return filename;
}
// ----------------------------------------------------------------------------
// count the amount of siblings to an element of given type name
int
Feed::xmlCountSiblings ( tinyxml2::XMLElement* xsibling, const char* sibling_name )
{
@ -127,6 +176,7 @@ Feed::xmlCountSiblings ( tinyxml2::XMLElement* xsibling, const char* sibling_nam
// ----------------------------------------------------------------------------
// add the given entry to the feed, if appropriate
bool
Feed::AddEntry ( Entry* newEntry )
{
@ -140,6 +190,7 @@ Feed::AddEntry ( Entry* newEntry )
entries.AddItem( newEntry );
return true;
}
BList Feed::GetEntries ( ) { return entries; }
bool Feed::SetTitle ( const char* titleStr ) {
if ( titleStr != NULL ) title = BString( titleStr );
@ -150,6 +201,7 @@ bool Feed::SetTitle ( tinyxml2::XMLElement* elem ) {
if ( elem != NULL ) return SetTitle( elem->GetText() );
else return false;
}
BString Feed::GetTitle ( ) { return title; }
bool Feed::SetDesc ( const char* descStr ) {
if ( descStr != NULL ) description = BString( descStr );
@ -160,7 +212,9 @@ bool Feed::SetDesc ( tinyxml2::XMLElement* elem ) {
if ( elem != NULL ) return SetDesc( elem->GetText() );
else return false;
}
BString Feed::GetDesc ( ) { return description; }
// set a feed's «home URL»
bool Feed::SetHomeUrl ( const char* homepageStr ) {
if ( homepageStr != NULL ) homeUrl = BString( homepageStr );
else return false;
@ -170,7 +224,9 @@ bool Feed::SetHomeUrl ( tinyxml2::XMLElement* elem ) {
if ( elem != NULL ) return SetHomeUrl( elem->GetText() );
else return false;
}
BString Feed::GetHomeUrl ( ) { return homeUrl; }
// set the update time for a feed
bool Feed::SetDate ( const char* dateCStr ) {
if ( dateCStr == NULL )
return false;
@ -184,4 +240,5 @@ bool Feed::SetDate ( tinyxml2::XMLElement* elem ) {
if ( elem != NULL ) return SetDate( elem->GetText() );
else return false;
}
BDateTime Feed::GetDate ( ) { return date; }

53
src/Feed.h
View File

@ -13,6 +13,36 @@ public:
Feed ( BString );
Feed ( );
virtual void Parse ( );
bool IsRemote ( );
bool IsUpdated ( );
bool IsRss ( );
bool IsAtom ( );
bool AddEntry ( Entry* );
BList GetEntries ( );
bool SetTitle ( const char* );
bool SetTitle ( tinyxml2::XMLElement* );
BString GetTitle ( );
bool SetDesc ( const char* );
bool SetDesc ( tinyxml2::XMLElement* );
BString GetDesc ( );
bool SetHomeUrl ( const char* );
bool SetHomeUrl ( tinyxml2::XMLElement* );
BString GetHomeUrl ( );
bool SetDate ( const char* );
bool SetDate ( tinyxml2::XMLElement* );
BDateTime GetDate ( );
BString SetCachePath ( BString );
BString GetCachePath ( );
protected:
void EnsureCached ( );
BString FetchRemoteFeed ( );
int xmlCountSiblings ( tinyxml2::XMLElement*, const char* );
BString title;
BString description;
BDateTime date;
@ -20,31 +50,14 @@ public:
BDateTime minDate;
BDateTime maxDate;
BString homeUrl;
BString inputPath;
BString xmlUrl;
BString filePath;
BString cachePath;
BString outputDir;
BList entries;
bool fetched;
bool updated;
virtual void Parse ( );
bool AddEntry ( Entry* );
bool SetTitle ( const char* );
bool SetTitle ( tinyxml2::XMLElement* );
bool SetDesc ( const char* );
bool SetDesc ( tinyxml2::XMLElement* );
bool SetDate ( const char* );
bool SetDate ( tinyxml2::XMLElement* );
bool SetHomeUrl ( const char* );
bool SetHomeUrl ( tinyxml2::XMLElement* );
bool IsRss ( );
bool IsAtom ( );
protected:
BString GetCachePath ( BString );
BString FetchRemoteFeed ( BString );
int xmlCountSiblings ( tinyxml2::XMLElement*, const char* );
};
#endif

6
src/Invocation.cpp
View File

@ -131,20 +131,20 @@ processFeed ( void* feedArg )
Feed* testFeed = new Feed( *(feedStr) );
BList entries;
if ( testFeed->updated == false && ((App*)be_app)->cfg->updateFeeds == true )
if ( testFeed->IsUpdated() == false && ((App*)be_app)->cfg->updateFeeds == true )
return false;
if ( testFeed->IsAtom() ) {
AtomFeed* feed = (AtomFeed*)malloc( sizeof(AtomFeed) );
feed = new AtomFeed( testFeed );
feed->Parse();
entries = feed->entries;
entries = feed->GetEntries();
}
if ( testFeed->IsRss() ) {
RssFeed* feed = (RssFeed*)malloc( sizeof(RssFeed) );
feed = new RssFeed( testFeed );
feed->Parse();
entries = feed->entries;
entries = feed->GetEntries();
}
entries.DoForEach(&processEntry);

6
src/RssFeed.cpp
View File

@ -15,7 +15,7 @@ RssFeed::RssFeed ( )
}
RssFeed::RssFeed ( Feed* feed ) : RssFeed::RssFeed()
{ filePath = feed->filePath; }
{ SetCachePath( feed->GetCachePath() ); }
// ----------------------------------------------------------------------------
@ -27,14 +27,14 @@ RssFeed::Parse ( )
Feed::Parse();
xml.LoadFile( filePath.String() );
xml.LoadFile( GetCachePath().String() );
tinyxml2::XMLElement* xchan = xml.FirstChildElement("rss")->FirstChildElement("channel");
RootParse( xchan );
ParseEntries( xchan );
time_t tt_lastDate = lastDate.Time_t();
BFile* feedFile = new BFile( filePath.String(), B_READ_ONLY );
BFile* feedFile = new BFile( GetCachePath().String(), B_READ_ONLY );
feedFile->WriteAttr( "LastDate", B_TIME_TYPE, 0, &tt_lastDate, sizeof(time_t) );
}