Documentation: Add TODO.
[usenet/newsstats.git] / doc / TODO
1                          NewsStats To-Do List
2                          ====================
3
4 This is a list of planned bug fixes, improvements and enhancements for
5 NewsStats.
6
7 Bug numbers refer to the Mantis issue tracker at <http://bugs.th-h.de/>.
8
9 * General
10   - Improve Documentation
11     The documentation is rather sparse and could use some improvement.
12   - Add a test suite
13     There is currently no kind of test suite or regression tests. Something like
14     that is badly needed.
15
16 * Additional features
17   - Add hierarchy information (GroupInfo - Bugs #19 #20 #21 #22 #23 #24 #25 #26)
18     NewsStats should be able to recognize invalid (i.e. officially not existing)
19     newsgroups and - optionally - drop them from the list of groups. On the
20     other hand, it should recognize existing, but empty groups and add them with
21     a posting count of 0 to its list.
22     NewsStats should be able to do that for any past month.
23     It would be nice to make up a kind of hierarchy database from that with
24     information like description, charter and moderation status. You should be
25     able to get a list of valid groups for any given month (with a bit of slack
26     for late creation and deletion), optionally including the previously
27     mentioned information; and you should be able to get the history of any
28     group.
29   - Add other reports
30     NewsStats should include some other kinds of reports (stats on used clients,
31     on postings hosts/servers, ...)
32
33 * Individual improvements
34   + NewsStats.pm
35     - Add error handling when reading config (Bug #13)
36       NewsStats should check if all mandatory options are set. Some syntax or
37       content related checks would be in order.
38       Some other tests - working database connection, valid database and table
39       names - would be nice.
40
41   + install/install.pl
42     - Add / enhance / test error handling
43     - General tests and optimisations
44
45   + feedlog.pl
46     - Add / enhance / test error handling
47     - General tests and optimisations
48
49   + gatherstats.pl
50     - Fix database updates when re-running (Bug #18)
51       Change REPLACE to DELETE with subsequent INSERT INTO (erase wrong data,
52       i.e. non-existent groups)
53     - Enhance TLH checks to allow for more than one TLH
54     - Make gatherstats aware of hierarchy lists (Bug #17)
55       A current (!) list of existing groups (checkgroups or INN active) should
56       be honored, with optional modifications. Non-existing groups should be
57       (logged and) dropped, existing groups with no postings should be set to 0.
58       Hierarchy elements (*.ALL) must be taken into account.
59       Perhaps invalid group names should also be checked (but what characters
60       should be considered "invalid"?)
61       GroupInfo (see above) could be an alternate solution.
62     - Add gathering of other stats (clients, hosts, ...)
63     - better modularisation (code reuse for other reports!)
64     - Add / enhance / test error handling
65     - General tests and optimisations
66
67   + groupstats.pl
68     - output: fix formatting - GetMaxLength does not work for special queries
69       like -l or -b
70     - beautify output (formats / captions)
71     - -a: improve code - it doesn't make that much sense to get first/last
72       month from database just to query that same database with a time period
73       that equals no time period ... this part of the WHERE clause should be
74       dropped instead
75     - change precedence handling of -m/-p/-a: drop -m if -p or -a are present,
76       drop -p if -a is present
77     - save report(s) to a file (Bug #27)
78     - better modularisation (code reuse for other reports!)
79     - Add / enhance / test error handling
80     - General tests and optimisations
This page took 0.010649 seconds and 3 git commands to generate.