/home/archives/aegis/branch.4/branch.25/delta28933.505/libaegis/rss.h File Reference

#include <common/nstring.h>

Go to the source code of this file.

Enumerations
enum	rss_feed_attribute { rss_feed_description, rss_feed_title, rss_feed_language }
Functions
nstring	rss_feed_filename (project *pp, const nstring &state)
nstring	rss_feed_attribute (project *pp, const nstring &filename, rss_feed_attribute attribute)
nstring	rss_get_project_url (project *pp)
void	rss_add_item_by_change (project *pp, change::pointer cp)
void	rss_add_item (const nstring &filename, project *pp, change::pointer cp)
Variables
const nstring	rss_script_name_placeholder

---

Enumeration Type Documentation

enum rss_feed_attribute

Possible RSS-related attributes that can be pulled from the project-specific attributes.

Enumerator:

rss_feed_description
rss_feed_title
rss_feed_language

Definition at line 33 of file rss.h.

---

Function Documentation

void rss_add_item	(	const nstring &	filename,
		project *	pp,
		change::pointer	cp
	)

Add an RSS item to the specified RSS feed file.

Parameters:

filename	The filename to add the new item to.
pp	The project involved.
cp	The changeset to which the new item relates.

void rss_add_item_by_change	(	project *	pp,
		change::pointer	cp
	)

Look for an RSS feed file based on change state. Add an RSS item if a feed file is found. This function should be called by each of the ae<change-state> commands.

Parameters:

pp	The project details.
cp	The changeset details.

nstring rss_feed_attribute	(	project *	pp,
		const nstring &	filename,
		rss_feed_attribute	attribute
	)

Find the RSS Channel attribute for an RSS feed file.

This function searches the project-specific attributes for an entry of the form:

 rss:feedattribute-filename = "<i>value</i>"; 

The value corresponding to the specified filename is returned. If an appropriate entry is not found, 0 is returned.

Parameters:

pp	A pointer to the project to use. This is used to find the project-specific attributes.
filename	The RSS feed filename for which the attribute is to be located.
attribute	The attribute to look for.

Returns:

The attribute's value, or the empty string if not found.

nstring rss_feed_filename	(	project *	pp,
		const nstring &	state
	)

Find the filename for an RSS feed.

This function searches the project-specific attributes for entries of the form:

 rss:feedfilename-filename = "<i>state</>"; 

When an entry with a matching state is found, the filename is returned. Available states are:

 awaiting_development
 being_developed
 awaiting_review
 being_reviewed
 awaiting_integration
 being_integrated
 completed
 

Parameters:

pp	A pointer to the project to use. This is used to find the project-specific attributes.
state	A string containing one of the above states.

Returns:

The full path to the filename associated with that state. The empty string if no filename has been associated with the specified state (this includes illegal state strings).

nstring rss_get_project_url

(

project *

pp

)

Get a URL for the specified project.

The returned URL contains a URL placeholder and includes scriptname and project name.

---

Variable Documentation

const nstring rss_script_name_placeholder

Placeholder used in feed files. When the feed is served up by aeget, the placeholder is replaced with the http script name.