NOFFLE

# HG changeset patch # User enz # Date 957019556 -3600 # Node ID 526a4c34ee2e7a32c3411a2de3553abd393c9ce1 # Parent ab6cf19be6d3b9ebe3ccde4ab579875bae96f883 [svn] Applied patch from Jim Hague: support for local groups / new command line options --create and --cancel. diff -r ab6cf19be6d3 -r 526a4c34ee2e CHANGELOG.html --- a/CHANGELOG.html Sat Apr 29 14:37:59 2000 +0100 +++ b/CHANGELOG.html Sat Apr 29 15:45:56 2000 +0100 @@ -12,6 +12,14 @@

Current developer version

+ +

+Applied patch from Jim Hague: support for local groups / new command +line options --create and --cancel. +

Version 1.0pre5

NOFFLE

+ +

Features

Usenet

-It allows reading news offline with many news reader programs, -even if they do not support offline reading by themselves. -

NOFFLE is written for the -Linux -operating system and freely available under GPL -(see -http://www.fsf.org/copyleft/gpl.html). +Linux +operating system and freely available under +GPL.

While Online:

Allows reading news offline with many news clients, even if they do not support offline reading by themselves. -
+
-Groups can be retrieved in different modes: +Groups can be retrieved in overview, full or thread mode.
- In overview mode, opened articles that have not been completely downloaded -yet are marked for download. NOFFLE generates a pseudo article telling +yet are marked for download. NOFFLE generates a pseudo article body telling the human about this. +
- -In full mode, the complete articles are fetched. +In full mode, complete articles are fetched at once. +
- -Thread mode is like overview mode, but automatically downloads all -article bodies that are in the same thread as articles that already have -been read. +Thread mode is like overview mode, but opening an article marks the +whole thread for download (all later articles for some time +that are referencing the original article). +
-
+
The news feed is invoked automatically next online time by calling NOFFLE in the ip-up script. -
+
Groups can be put on the fetch list via the 'noffle' -command or automatically when someone tries to read them. Groups can be -removed from the fetch list manually or automatically, when nobody accesses -them for some time. - +command or +automatically when someone tries to read them. Groups can be automatically +removed from the fetch list, when nobody accesses them for some time. +
+NOFFLE also offers limited support for local groups. Articles posted +in local groups appear in the news database for those groups immediately, +and are expired in the same way as other articles. +

Compatibility with News Clients

-Subscribing to groups in overview mode or thread mode puts some -requirements on the news reader program. See -NOTES.txt for compatibility notes. +Subscribing to groups in overview mode or thread mode requires the +following from the news reader program: +

+It must not cache articles at all (or allow to switch the cache off), +because the article bodies change from the pseudo body +"marked for download" to the real body. +
+
+The reader should rarely open article bodies automatically, +because it will mark them unwantedly for download. +

Getting NOFFLE

-http://home.t-online.de/home/markus.enzenberger/noffle.html

-- -noffle-0.19.tar.gz - -(current release, 25 Apr 1999) +noffle-1.0pre5.tar.gz +(current release, 18 Apr 2000)
-- -noffle-0.17.tar.gz - -(last release, 25 Jan 1999) +noffle-1.0pre4.tar.gz +(current release, 13 Nov 1999)

-INSTALL.txt

-RPM packages have been created by Mario Moder -(moderm@gmx.net). They are available +RPM packages have been created by +Mario Moder. They are available at

-ftp://ftp.fbam.de/pub/linux/ +ftp://ftp.fbam.de/pub/linux/

+ + +I moved Noffle to +SourceForge +recently. You can download files from the +Noffle project page. +There is also a mailing list and a discussion forum. + +

Documentation

+Some German documentation +( +"NOFFLE Installation") +is provided by +Klaus Mödinger. +

The current version is still beta. Please send bug reports, -comments and patches to me -(markus.enzenberger@t-online.de). +comments and patches to + +markus.enzenberger@t-online.de.

-If you want to receive announcements about NOFFLE, I will put you on -my announcement list. Just send me a mail. -

Links

-NNTP information -
-(http://www.tin.org/docs.html) +NNTP information
-Leafnode - news server similar to NOFFLE -
-(http://wpxx02.toxi.uni-wuerzburg.de/~krasel/leafnode.html) +ncontr +- graphical front-end for NOFFLE by +Mark Bulmahn
-SLRN - powerful news reader for Windows and Unix -
-(http://space.mit.edu/~davis/slrn.html) + +Leafnode - news server similar to NOFFLE
-GNUS - Emacs news reader -
-(http://www.gnus.org/ +SLRN +- powerful news reader for Windows and Unix +
+WWWOFFLE +- http proxy

-Last modified 5/99, +Last modified 4/2000, Markus Enzenberger

+#include "common.h" +#include "content.h" +#include "database.h" +#include "group.h" +#include "itemlist.h" +#include "log.h" +#include "outgoing.h" + +int +Ctrl_cancel( const char *msgId ) +{ + ItemList *refs; + const char *ref; + Str server; + Bool seen = FALSE; + int res = CANCEL_OK; + + /* See if in outgoing and zap if so. */ + if ( Out_find( msgId, server ) ) + { + Out_remove( server, msgId ); + Log_inf( "'%s' cancelled from outgoing queue for '%s'.\n", + msgId, server ); + seen = TRUE; + } + + if ( ! Db_contains( msgId ) ) + { + Log_inf( "Cancel: '%s' not in database.", msgId ); + return seen ? CANCEL_OK : CANCEL_NO_SUCH_MSG; + } + + /* + Retrieve the Xrefs, remove from each group and then + remove from the database. + */ + refs = new_Itl( Db_xref( msgId ), " " ); + for( ref = Itl_first( refs ); ref != NULL; ref = Itl_next( refs ) ) + { + Str grp; + int no; + + if ( sscanf( ref, "%s:%d", grp, &no ) != 2 ) + break; + + if ( Grp_exists( grp ) ) + { + Cont_read( grp ); + Cont_delete( no ); + Cont_write(); + + if ( ! Grp_local( grp ) && ! seen ) + res = CANCEL_NEEDS_MSG; + + Log_dbg( "Removed '%s' from group '%s'.", msgId, grp ); + } + else + { + Log_inf( "Group '%s' in Xref for '%s' not found.", grp, msgId ); + } + } + del_Itl( refs ); + Db_delete( msgId ); + Log_inf( "Message '%s' cancelled.", msgId ); + return res; +} diff -r ab6cf19be6d3 -r 526a4c34ee2e control.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/control.h Sat Apr 29 15:45:56 2000 +0100 @@ -0,0 +1,25 @@ +/* + control.h + + Control actions needed by server and command line. + + $Id: control.h 32 2000-04-29 14:45:56Z enz $ +*/ + +#ifndef CONTROL_H +#define CONTROL_H + +#define CANCEL_OK 0 +#define CANCEL_NO_SUCH_MSG 1 +#define CANCEL_NEEDS_MSG 2 + +/* + Cancel a message. Return CANCEL_OK if completely cancelled, + CANCEL_NO_SUCH_MSG if no message with that ID exists, and + CANCEL_NEEDS_MSG if a 'cancel' message should be propagated upstream + to cancel the message elsewhere. + */ +int +Ctrl_cancel( const char *msgId ); + +#endif diff -r ab6cf19be6d3 -r 526a4c34ee2e database.c --- a/database.c Sat Apr 29 14:37:59 2000 +0100 +++ b/database.c Sat Apr 29 15:45:56 2000 +0100 @@ -1,7 +1,7 @@ /* database.c - $Id: database.c 3 2000-01-04 11:35:42Z enz $ + $Id: database.c 32 2000-04-29 14:45:56Z enz $ Uses GNU gdbm library. Using Berkeley db (included in libc6) was cumbersome. It is based on Berkeley db 1.85, which has severe bugs @@ -251,7 +251,7 @@ } if ( ! ( db.stat & DB_NOT_DOWNLOADED ) ) { - Log_err( "Trying to store alrady retrieved article '%s'", msgId ); + Log_err( "Trying to store already retrieved article '%s'", msgId ); return FALSE; } db.stat &= ~DB_NOT_DOWNLOADED; @@ -264,24 +264,12 @@ startPos = artTxt; while ( TRUE ) { - artTxt = Utl_getLn( lineEx, artTxt ); + artTxt = Utl_getHeaderLn( lineEx, artTxt ); if ( lineEx[ 0 ] == '\0' ) { DynStr_appLn( db.txt, lineEx ); break; } - /* Get other lines if field is split over multiple lines */ - while ( ( artTxt = Utl_getLn( line, artTxt ) ) ) - if ( isspace( line[ 0 ] ) ) - { - strncat( lineEx, "\n", MAXCHAR ); - strncat( lineEx, line, MAXCHAR ); - } - else - { - artTxt = Utl_ungetLn( startPos, artTxt ); - break; - } /* Remove fields already in overview and handle x-noffle headers correctly in case of cascading NOFFLEs */ if ( Prt_getField( field, value, lineEx ) ) @@ -514,6 +502,19 @@ return gdbm_exists( db.dbf, key ); } +void +Db_delete( const char *msgId ) +{ + datum key; + + ASSERT( db.dbf ); + if ( strcmp( msgId, db.msgId ) == 0 ) + db.msgId[ 0 ] = '\0'; + key.dptr = (void*)msgId; + key.dsize = strlen( msgId ) + 1; + gdbm_delete( db.dbf, key ); +} + static datum cursor = { NULL, 0 }; Bool diff -r ab6cf19be6d3 -r 526a4c34ee2e database.h --- a/database.h Sat Apr 29 14:37:59 2000 +0100 +++ b/database.h Sat Apr 29 15:45:56 2000 +0100 @@ -3,7 +3,7 @@ Article database. - $Id: database.h 3 2000-01-04 11:35:42Z enz $ + $Id: database.h 32 2000-04-29 14:45:56Z enz $ */ #ifndef DB_H @@ -66,6 +66,10 @@ Bool Db_contains( const char *msgId ); +/* Delete entry from database */ +void +Db_delete( const char *msgId ); + Bool Db_first( const char** msgId ); diff -r ab6cf19be6d3 -r 526a4c34ee2e group.c --- a/group.c Sat Apr 29 14:37:59 2000 +0100 +++ b/group.c Sat Apr 29 15:45:56 2000 +0100 @@ -7,7 +7,7 @@ loadGrp() and saveGrp(). This is done transparently. Access to the groups database is done by group name, by the functions defined in group.h. - $Id: group.c 3 2000-01-04 11:35:42Z enz $ + $Id: group.c 32 2000-04-29 14:45:56Z enz $ */ #include "group.h" @@ -138,6 +138,14 @@ return gdbm_exists( grp.dbf, key ); } +Bool +Grp_local( const char *name ) +{ + if ( ! loadGrp( name ) ) + return 0; + return ( strcmp( grp.serv, "(local)" ) == 0 ); +} + void Grp_create( const char *name ) { @@ -226,6 +234,12 @@ } void +Grp_setLocal( const char *name ) +{ + Grp_setServ( name, "(local)" ); +} + +void Grp_setServ( const char *name, const char *value ) { if ( loadGrp( name ) ) diff -r ab6cf19be6d3 -r 526a4c34ee2e group.h --- a/group.h Sat Apr 29 14:37:59 2000 +0100 +++ b/group.h Sat Apr 29 15:45:56 2000 +0100 @@ -3,7 +3,7 @@ Groups database - $Id: group.h 3 2000-01-04 11:35:42Z enz $ + $Id: group.h 32 2000-04-29 14:45:56Z enz $ */ #ifndef GRP_H @@ -24,6 +24,10 @@ Bool Grp_exists( const char *name ); +/* is it a local group? */ +Bool +Grp_local( const char *name ); + /* create new group and save it in database */ void Grp_create( const char *name ); @@ -66,6 +70,9 @@ Grp_setDsc( const char *name, const char *value ); void +Grp_setLocal( const char *name ); + +void Grp_setServ( const char *name, const char *value ); void diff -r ab6cf19be6d3 -r 526a4c34ee2e itemlist.c --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/itemlist.c Sat Apr 29 15:45:56 2000 +0100 @@ -0,0 +1,123 @@ +/* + itemlist.c + + $Id: itemlist.c 32 2000-04-29 14:45:56Z enz $ +*/ + +#include "itemlist.h" +#include +#include +#include +#include "common.h" +#include "log.h" + +struct ItemList +{ + char *list; + char *separators; + char *next; + size_t count; +}; + +/* Make a new item list. */ +ItemList * +new_Itl( const char *list, const char *separators ) +{ + ItemList * res; + char *p; + Bool inItem; + + res = (ItemList *) malloc( sizeof( ItemList ) ); + if ( res == NULL ) + { + Log_err( "Malloc of ItemList failed." ); + exit( EXIT_FAILURE ); + } + + res->list = (char *) malloc( strlen(list) + 2 ); + if ( res->list == NULL ) + { + Log_err( "Malloc of ItemList.list failed." ); + exit( EXIT_FAILURE ); + } + strcpy( res->list, list ); + + if ( ( res->separators = strdup( separators ) ) == NULL ) + { + Log_err( "Malloc of ItemList.separators failed." ); + exit( EXIT_FAILURE ); + } + + res->count = 0; + res->next = res->list; + + /* Separate items into strings and have final zero-length string. */ + for( p = res->list, inItem = FALSE; *p != '\0'; p++ ) + { + Bool isSep = ( strchr( separators, p[ 0 ] ) != NULL ); + + if ( inItem ) + { + if ( isSep ) + { + p[ 0 ] = '\0'; + inItem = FALSE; + res->count++; + } + } + else + { + if ( ! isSep ) + inItem = TRUE; + } + } + if ( inItem ) + res->count++; + p[ 1 ] = '\0'; + return res; +} + +/* Delete an item list. */ +void +del_Itl( ItemList *self ) +{ + if ( self == NULL ) + return; + free( self->list ); + free( self->separators ); + free( self ); +} + +/* Get first item. */ +const char * +Itl_first( ItemList *self ) +{ + self->next = self->list; + return Itl_next( self ); +} + +/* Get next item or NULL. */ +const char * +Itl_next( ItemList *self ) +{ + const char *res = self->next; + + if ( res[ 0 ] == '\0' ) + return NULL; + + while ( strchr( self->separators, res[ 0 ] ) != NULL ) + res++; + + if ( res[ 0 ] == '\0' && res[ 1 ] == '\0' ) + return NULL; + + self->next += strlen( res ) + 1; + return res; +} + +/* Get count of items in list. */ +size_t +Itl_count( const ItemList *self ) +{ + return self->count; +} diff -r ab6cf19be6d3 -r 526a4c34ee2e itemlist.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/itemlist.h Sat Apr 29 15:45:56 2000 +0100 @@ -0,0 +1,38 @@ +/* + itemlist.h + + Copy a string wiht a list of separated items (as found in several + header lines) and provide a convenient way of accessing the + individual items. + + $Id: itemlist.h 32 2000-04-29 14:45:56Z enz $ */ + +#ifndef ITEMLIST_H +#define ITEMLIST_H + +#include + +struct ItemList; +typedef struct ItemList ItemList; + +/* Make a new item list. */ +ItemList * +new_Itl( const char *list, const char *separators ); + +/* Delete an item list. */ +void +del_Itl( ItemList *self ); + +/* Get first item. */ +const char * +Itl_first( ItemList *self); + +/* Get next item or NULL. */ +const char * +Itl_next( ItemList *self ); + +/* Get count of items in list. */ +size_t +Itl_count( const ItemList *self ); + +#endif diff -r ab6cf19be6d3 -r 526a4c34ee2e noffle.1 --- a/noffle.1 Sat Apr 29 14:37:59 2000 +0100 +++ b/noffle.1 Sat Apr 29 15:45:56 2000 +0100 @@ -1,6 +1,5 @@ - .TH noffle 1 -.\" $Id: noffle.1 29 2000-04-29 12:59:10Z enz $ +.\" $Id: noffle.1 32 2000-04-29 14:45:56Z enz $ .SH NAME noffle \- Usenet package optimized for dialup connections. @@ -10,6 +9,12 @@ \-a | \-\-article |all .br .B noffle +\-c | \-\-cancel +.br +.B noffle +\-C | \-\-create +.br +.B noffle \-d | \-\-database .br .B noffle @@ -80,6 +85,20 @@ but download articles full if an article of the same thread already has been downloaded. +.PP +.B NOFFLE +also offers limited support for local news groups. Articles +posted to these appear in full in the database for the local group(s) +immediately. They are expired in the usual way. +.PP +If an article is cross-posted to a local group and a remote group, it +appears in the local group immediately and in the remote group after +the next fetch from the remove server. +.PP +Note that +.B NOFFLE +cannot exchange the contents of local groups with other news servers. + .SH OPTIONS .TP @@ -91,6 +110,19 @@ If "all" is given as message Id, all articles are shown. .TP +.B \-c, \-\-cancel +Cancel the article from the database and remove it from the queue of +outbound messages if it has not already been sent. Message Id must +contain the leading '<' and trailing '>' (quote the argument to avoid +shell interpretation of '<' and '>'). + +.TP +.B \-C, \-\-create +Create a new local newsgroup with the given name. The name should +conform to the usual newsgroup naming rules to avoid confusing +newsreaders. + +.TP .B \-d, \-\-database Write the complete content of the article database to standard output. diff -r ab6cf19be6d3 -r 526a4c34ee2e noffle.c --- a/noffle.c Sat Apr 29 14:37:59 2000 +0100 +++ b/noffle.c Sat Apr 29 15:45:56 2000 +0100 @@ -10,9 +10,10 @@ received for some seconds (to allow multiple clients connect at the same time). - $Id: noffle.c 15 2000-04-11 06:36:57Z enz $ + $Id: noffle.c 32 2000-04-29 14:45:56Z enz $ */ +#include #include #include #include @@ -22,13 +23,16 @@ #include "client.h" #include "common.h" #include "content.h" +#include "control.h" #include "config.h" #include "database.h" #include "fetch.h" #include "fetchlist.h" #include "group.h" +#include "itemlist.h" #include "log.h" #include "online.h" +#include "outgoing.h" #include "over.h" #include "pseudo.h" #include "util.h" @@ -72,6 +76,25 @@ } } +static void +doCancel( const char *msgId ) +{ + switch( Ctrl_cancel( msgId ) ) + { + case CANCEL_NO_SUCH_MSG: + printf( "No such message '%s'.\n", msgId ); + break; + + case CANCEL_OK: + printf( "Message '%s' cancelled.\n", msgId ); + break; + + case CANCEL_NEEDS_MSG: + printf( "Message '%s' cancelled in local database only.\n", msgId ); + break; + } +} + /* List articles requested from one particular server */ static void listRequested1( const char* serv ) @@ -199,7 +222,8 @@ else ++cntLeft; } - if ( autoUnsubscribe + if ( !Grp_local( grp ) + && autoUnsubscribe && difftime( now, Grp_lastAccess( grp ) ) > maxAge ) { Log_ntc( "Auto-unsubscribing from %s after %d " @@ -230,6 +254,21 @@ } static void +doCreateLocalGroup( const char * name ) +{ + if ( Grp_exists( name ) ) + fprintf( stderr, "'%s' already exists.\n", name ); + else + { + Log_inf( "Creating new local group '%s'", name ); + Grp_create( name ); + Grp_setFirstLast( name, 1, 0 ); + Grp_setLocal( name ); + printf( "New local group '%s' created.\n", name ); + } +} + +static void doList( void ) { FetchMode mode; @@ -324,6 +363,8 @@ "Usage: noffle