-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New INN::ovsqlite_client Perl module
INN::ovsqlite_client permits accessing an ovsqlite overview database through ovsqlite-server from a Perl script. This module provides search, add, remove and expire functions for information stored in an ovsqlite database (newsgroups and overview data associated to articles in these newsgroups). Many thanks to Bo Lindbergh for it! That's a great and useful work. Two samples are also provided in the contrib directory (ovsqlite-dump and ovsqlite-undump) to show how to use the module.
- Loading branch information
1 parent
5207ccd
commit c31453f
Showing
11 changed files
with
1,598 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| #! /usr/bin/perl -w | ||
| # fixscript will replace this line with code to load INN::Config | ||
|
|
||
| ## Example of use of INN::ovsqlite_client to dump the contents of an ovsqlite | ||
| ## overview database (groups and overview data of articles in these groups). | ||
| ## | ||
| ## Progress and errors are written to STDERR, and data to STDOUT. | ||
| ## Run for instance: | ||
| ## ovsqlite-dump > dump | ||
| ## | ||
| ## Lines beginning with "g" in the output correspond to overview information | ||
| ## about groups, whereas lines beginning with "a" correspond to the overview | ||
| ## data of articles. | ||
| ## | ||
| ## Sample written by Bo Lindbergh in December 2023. | ||
|
|
||
| use strict; | ||
| use warnings; | ||
|
|
||
| use INN::ovsqlite_client qw(:all); | ||
|
|
||
| sub dump_articles { | ||
| my ($sock, $dst, $groupname) = @_; | ||
| my ($code, $errmsg, $low, $articles); | ||
| my ($count); | ||
|
|
||
| print STDERR $groupname, "... "; | ||
| $count = 0; | ||
| $low = 1; | ||
| for (;;) { | ||
| $code = $sock->search_group( | ||
| groupname => $groupname, | ||
| low => $low, | ||
| cols => search_col_arrived | search_col_expires | ||
| | search_col_token | search_col_overview, | ||
| readsize => 0xFFFFF, | ||
| articles => $articles, | ||
| errmsg => $errmsg | ||
| ); | ||
| defined($errmsg) | ||
| and die "search_group: $errmsg"; | ||
| $code != response_artlist && $code != response_artlist_done | ||
| and die "search_group: Unexpected response code $code"; | ||
| foreach my $article (@{$articles}) { | ||
| print $dst join( | ||
| "\t", | ||
| "a", | ||
| @{$article}{qw(artnum arrived expires)}, | ||
| '@' . unpack("H*", $article->{token}) . '@', | ||
| $article->{overview} | ||
| ); | ||
| $count++; | ||
| } | ||
| $code == response_artlist_done | ||
| and last; | ||
| $low = $articles->[-1]->{artnum} + 1; | ||
| } | ||
| print STDERR $count, "\n"; | ||
| } | ||
|
|
||
| sub dump_groups { | ||
| my ($sock, $dst) = @_; | ||
| my ($code, $errmsg, $groupid, $groups); | ||
|
|
||
| $groupid = 0; | ||
| for (;;) { | ||
| $code = $sock->list_groups( | ||
| groupid => $groupid, | ||
| groups => $groups, | ||
| errmsg => $errmsg | ||
| ); | ||
| defined($errmsg) | ||
| and die "list_groups: $errmsg"; | ||
| $code != response_grouplist && $code != response_grouplist_done | ||
| and die "list_groups: Unexpected response code $code\n"; | ||
| foreach my $group (@{$groups}) { | ||
| print $dst ( | ||
| join( | ||
| "\t", | ||
| "g", | ||
| @{$group}{qw(groupname low high count flag_alias)} | ||
| ), | ||
| "\n" | ||
| ); | ||
| dump_articles($sock, $dst, $group->{groupname}); | ||
| } | ||
| last if $code == response_grouplist_done; | ||
| } | ||
| } | ||
|
|
||
| sub server_connect { | ||
| my ($mode) = @_; | ||
|
|
||
| foreach my $leaf (qw(ovsqlite.sock ovsqlite.port)) { | ||
| my ($path); | ||
|
|
||
| $path = "$INN::Config::pathrun/$leaf"; | ||
| if (-e $path) { | ||
| return INN::ovsqlite_client::->new( | ||
| path => $path, | ||
| mode => $mode | ||
| ); | ||
| } | ||
| } | ||
| die "No ovsqlite-server running?"; | ||
| } | ||
|
|
||
| dump_groups(server_connect(0), \*STDOUT); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| #! /usr/bin/perl -w | ||
| # fixscript will replace this line with code to load INN::Config | ||
|
|
||
| ## Example of use of INN::ovsqlite_client to create groups and overview data | ||
| ## for articles in these groups in an ovsqlite overview database, from a dump | ||
| ## previously generated with the ovsqlite-dump script. | ||
| ## | ||
| ## Progress and errors are written to STDERR, and data is read from STDIN. | ||
| ## Run for instance: | ||
| ## ovsqlite-undump < dump | ||
| ## | ||
| ## Already existing articles in your ovsqlite database will be reported as | ||
| ## an error. | ||
| ## | ||
| ## Sample written by Bo Lindbergh in December 2023. | ||
|
|
||
| use strict; | ||
| use warnings; | ||
|
|
||
| use INN::ovsqlite_client qw(:all); | ||
|
|
||
| sub undump_all { | ||
| my ($sock, $src) = @_; | ||
| my ($code, $errmsg, $lastname, $count); | ||
|
|
||
| $count = 0; | ||
| while (defined(my $line = readline($src))) { | ||
| if ($line =~ /^g/) { | ||
| my ($groupname, $low, $high, $flag_alias); | ||
|
|
||
| chomp $line; | ||
| (undef, $groupname, $low, $high, undef, $flag_alias) | ||
| = split(/\t/, $line); | ||
| $code = $sock->add_group( | ||
| groupname => $groupname, | ||
| low => $low, | ||
| high => $high, | ||
| flag_alias => $flag_alias, | ||
| errmsg => $errmsg | ||
| ); | ||
| defined($errmsg) | ||
| and die "add_group($groupname): $errmsg"; | ||
| if (defined($lastname)) { | ||
| print STDERR $count, "\n"; | ||
| } | ||
| print STDERR $groupname, "... "; | ||
| $lastname = $groupname; | ||
| $count = 0; | ||
| } elsif ($line =~ /^a/) { | ||
| my ($artnum, $arrived, $expires, $token, $overview); | ||
|
|
||
| defined($lastname) | ||
| or die "$.: Bad input"; | ||
| (undef, $artnum, $arrived, $expires, $token, $overview) | ||
| = split(/\t/, $line, 6); | ||
| $token =~ /^\@[0-9A-Za-z]{36}\@$/ | ||
| or die "$.: Bad input"; | ||
| $token = pack("H*", substr($token, 1, 36)); | ||
| $code = $sock->add_article( | ||
| groupname => $lastname, | ||
| artnum => $artnum, | ||
| token => $token, | ||
| arrived => $arrived, | ||
| expires => $expires, | ||
| overview => $overview, | ||
| errmsg => $errmsg | ||
| ); | ||
| defined($errmsg) | ||
| and die "add_article($lastname,$artnum): $errmsg"; | ||
| $count++; | ||
| } else { | ||
| die "$.: Bad input"; | ||
| } | ||
| } | ||
| if (defined($lastname)) { | ||
| print STDERR $count, "\n"; | ||
| } | ||
| } | ||
|
|
||
| sub server_connect { | ||
| my ($mode) = @_; | ||
|
|
||
| foreach my $leaf (qw(ovsqlite.sock ovsqlite.port)) { | ||
| my ($path); | ||
|
|
||
| $path = "$INN::Config::pathrun/$leaf"; | ||
| if (-e $path) { | ||
| return INN::ovsqlite_client::->new( | ||
| path => $path, | ||
| mode => $mode | ||
| ); | ||
| } | ||
| } | ||
| die "No ovsqlite-server running?"; | ||
| } | ||
|
|
||
| undump_all(server_connect(1), \*STDIN); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.