WikiPageStats#

Introduction#

As a JSPWiki administrator you need some statistical information about the pages in your wiki.

The information I'd like to see per page is the following:

• Page Name
• Creator
• Creation Date/Time
• Last Modified Date/Time
• Last Modified By
• Current Page Size
• Number of versions
• Total size of all versions
• Number of Attachments
• Total size of Attachments
• Number of incoming wikilinks
• Number of outgoing wikilinks

The information should be presentable in a tabular form where you can sort it and filter it (like the %%Sortable and %%table-filter).

The following interfaces/classes are planned :

• an interface that describes the statistics of one page (com.ecyrd.jspwiki.stats.WikiPageStat)
• a basic class that implements this interface based on the current providers
• a factory class that creates and gathers all the WikiPageStat objects (com.ecyrd.jspwiki.stats.WikiPageStatFactory) . This class should provide public methods that return a List of (populated) WikiPageStat objects. (optionally with a pattern as filter to return a subset of the pagestats)
• a class that provides the information to the end user (com.ecyrd.jspwiki.stats.WikiPageStatsPlugin) :
  • a JSPWiki plugin to provide the info in HTML format
  • an MBean ?
  • a class to provide the stats in xml format for automated processing afterwards

Security#

Security is important because sensitive meta data of pages are provided, for now the access to this function should be limited to administrators.
Another reason to limit access is the fact that gathering all this info might generate quite some load on the server.

Interfaces/classes#

Interace com.ecyd.jspwiki.stats.WikiPageStat#

This interface describes what information can be stored and retrieved per page. For now we only deal with regular WikiPages, not attachments.