user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH] make zlib-related modules a hard dependency
Date: Tue, 21 Apr 2020 06:57:34 +0000	[thread overview]
Message-ID: <20200421065734.14216-1-e@yhbt.net> (raw)

This allows us to simplify some of our existing code and make
future changes easier.

I doubt anybody goes through the trouble to have a Perl
installation without zlib support.  The zlib source code is even
bundled with Perl since 5.9.3 for systems without existing zlib
development headers and libraries.

Of course, zlib is also a requirement of git, too; and we're not
going to stop using git :)
---
 Makefile.PL                   |  5 +++++
 ci/deps.perl                  |  2 +-
 lib/PublicInbox/Mbox.pm       | 17 ++---------------
 lib/PublicInbox/NNTP.pm       | 11 ++---------
 lib/PublicInbox/WwwListing.pm | 13 ++++++-------
 script/public-inbox-nntpd     |  2 +-
 6 files changed, 17 insertions(+), 33 deletions(-)

diff --git a/Makefile.PL b/Makefile.PL
index ab24b9cf..27bb112c 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -132,6 +132,11 @@ WriteMakefile(
 		# `perl5' on FreeBSD
 		'Encode' => 0,
 
+		# libperl$PERL_VERSION + perl-modules-$PERL_VERSION
+		'Compress::Raw::Zlib' => 0,
+		'Compress::Zlib' => 0,
+		'IO::Compress::Gzip' => 0,
+
 		# Plack is needed for public-inbox-httpd and PublicInbox::WWW
 		# 'Plack' => 0,
 
diff --git a/ci/deps.perl b/ci/deps.perl
index b960089f..06b4fbe0 100755
--- a/ci/deps.perl
+++ b/ci/deps.perl
@@ -25,6 +25,7 @@ my $profiles = {
 		Email::MIME::ContentType
 		Encode
 		ExtUtils::MakeMaker
+		IO::Compress::Gzip
 		URI::Escape
 		), @test_essential ],
 
@@ -35,7 +36,6 @@ my $profiles = {
 		DBD::SQLite
 		DBI
 		Filesys::Notify::Simple
-		IO::Compress::Gzip
 		Inline::C
 		Net::Server
 		Plack
diff --git a/lib/PublicInbox/Mbox.pm b/lib/PublicInbox/Mbox.pm
index 9995140c..97bec5e7 100644
--- a/lib/PublicInbox/Mbox.pm
+++ b/lib/PublicInbox/Mbox.pm
@@ -152,8 +152,7 @@ sub thread_cb {
 
 sub thread_mbox {
 	my ($ctx, $over, $sfx) = @_;
-	eval { require PublicInbox::MboxGz };
-	return need_gzip($ctx) if $@;
+	require PublicInbox::MboxGz;
 	my $msgs = $ctx->{msgs} = $over->get_thread($ctx->{mid}, {});
 	return [404, [qw(Content-Type text/plain)], []] if !@$msgs;
 	$ctx->{prev} = $msgs->[-1];
@@ -221,8 +220,7 @@ sub results_cb {
 sub mbox_all {
 	my ($ctx, $query) = @_;
 
-	eval { require PublicInbox::MboxGz };
-	return need_gzip($ctx) if $@;
+	require PublicInbox::MboxGz;
 	return mbox_all_ids($ctx) if $query eq '';
 	my $qopts = $ctx->{qopts} = { mset => 2 };
 	my $srch = $ctx->{srch} = $ctx->{-inbox}->search or
@@ -236,15 +234,4 @@ sub mbox_all {
 	PublicInbox::MboxGz->response($ctx, \&results_cb, 'results-'.$query);
 }
 
-sub need_gzip {
-	html_oneshot($_[0], 501, \<<EOF);
-<pre>gzipped mbox not available
-
-The administrator needs to install the Compress::Raw::Zlib Perl module
-to support gzipped mboxes.
-
-<a href="../">Return to index</a></pre>
-EOF
-}
-
 1;
diff --git a/lib/PublicInbox/NNTP.pm b/lib/PublicInbox/NNTP.pm
index c79f198b..e9c66cd1 100644
--- a/lib/PublicInbox/NNTP.pm
+++ b/lib/PublicInbox/NNTP.pm
@@ -38,8 +38,7 @@ NEWNEWS\r
 LIST ACTIVE ACTIVE.TIMES NEWSGROUPS OVERVIEW.FMT\r
 HDR\r
 OVER\r
-
-my $have_deflate;
+COMPRESS DEFLATE\r
 
 sub greet ($) { $_[0]->write($_[0]->{nntpd}->{greet}) };
 
@@ -903,7 +902,7 @@ sub cmd_starttls ($) {
 sub cmd_compress ($$) {
 	my ($self, $alg) = @_;
 	return '503 Only DEFLATE is supported' if uc($alg) ne 'DEFLATE';
-	return r502 if $self->compressed || !$have_deflate;
+	return r502 if $self->compressed;
 	PublicInbox::NNTPdeflate->enable($self);
 	$self->requeue;
 	undef
@@ -990,10 +989,4 @@ sub busy {
 	($self->{rbuf} || $self->{wbuf} || $self->not_idle_long($now));
 }
 
-# this is an import to prevent "perl -c" from complaining about fields
-sub import {
-	$have_deflate = eval { require PublicInbox::NNTPdeflate } and
-		$CAPABILITIES .= "COMPRESS DEFLATE\r\n";
-}
-
 1;
diff --git a/lib/PublicInbox/WwwListing.pm b/lib/PublicInbox/WwwListing.pm
index 42a0c0d8..38a37dda 100644
--- a/lib/PublicInbox/WwwListing.pm
+++ b/lib/PublicInbox/WwwListing.pm
@@ -14,14 +14,13 @@ use bytes (); # bytes::length
 use HTTP::Date qw(time2str);
 use Digest::SHA ();
 use File::Spec ();
+use IO::Compress::Gzip qw(gzip);
 *try_cat = \&PublicInbox::Inbox::try_cat;
 our $json;
-if (eval { require IO::Compress::Gzip }) {
-	for my $mod (qw(JSON::MaybeXS JSON JSON::PP)) {
-		eval "require $mod" or next;
-		# ->ascii encodes non-ASCII to "\uXXXX"
-		$json = $mod->new->ascii(1) and last;
-	}
+for my $mod (qw(JSON::MaybeXS JSON JSON::PP)) {
+	eval "require $mod" or next;
+	# ->ascii encodes non-ASCII to "\uXXXX"
+	$json = $mod->new->ascii(1) and last;
 }
 
 sub list_all_i {
@@ -220,7 +219,7 @@ sub js ($$) {
 		$repo->{reference} = $abs2urlpath->{$abs};
 	}
 	my $out;
-	IO::Compress::Gzip::gzip(\($json->encode($manifest)) => \$out);
+	gzip(\($json->encode($manifest)) => \$out);
 	$manifest = undef;
 	[ 200, [ qw(Content-Type application/gzip),
 		 'Last-Modified', time2str($mtime),
diff --git a/script/public-inbox-nntpd b/script/public-inbox-nntpd
index ce42de2d..f42db6fe 100755
--- a/script/public-inbox-nntpd
+++ b/script/public-inbox-nntpd
@@ -6,7 +6,7 @@
 use strict;
 use warnings;
 use PublicInbox::Daemon;
-use PublicInbox::NNTP; # need to call import
+use PublicInbox::NNTPdeflate; # loads PublicInbox::NNTP
 use PublicInbox::NNTPD;
 my $nntpd = PublicInbox::NNTPD->new;
 PublicInbox::Daemon::run('0.0.0.0:119',

             reply	other threads:[~2020-04-21  6:57 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-21  6:57 Eric Wong [this message]
2020-04-21  7:22 ` [squash] wwwaltid: use gzipfilter up front Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200421065734.14216-1-e@yhbt.net \
    --to=e@yhbt.net \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).