From: Frank Lichtenheld Date: Wed, 1 Feb 2006 14:29:55 +0000 (+0000) Subject: Paging stuff that is independent from any backend considerations X-Git-Tag: switch-to-templates~226 X-Git-Url: https://git.deb.at/w?a=commitdiff_plain;h=720ad1b27c68b4395f55f96f0d1067fe62812a7e;p=deb%2Fpackages.git Paging stuff that is independent from any backend considerations --- diff --git a/lib/Packages/Search.pm b/lib/Packages/Search.pm new file mode 100644 index 0000000..47d2b82 --- /dev/null +++ b/lib/Packages/Search.pm @@ -0,0 +1,276 @@ +# +# Packages::Search +# +# Copyright (C) 2004-2006 Frank Lichtenheld +# +# The code is based on the old search_packages.pl script that +# was: +# +# Copyright (C) 1998 James Treacy +# Copyright (C) 2000, 2001 Josip Rodin +# Copyright (C) 2001 Adam Heath +# Copyright (C) 2004 Martin Schulze +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 1 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# + +=head1 NAME + +Packages::Search - + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=over 4 + +=cut + +package Packages::Search; + +use strict; +use warnings; + +use CGI qw( -oldstyle_urls ); +use POSIX; +use HTML::Entities; + +use Deb::Versions; +use Exporter; + +our @ISA = qw( Exporter ); + +our @EXPORT_OK = qw( nextlink prevlink indexline + resperpagelink ); +our %EXPORT_TAGS = ( all => [ @EXPORT_OK ] ); + +our $VERSION = 0.01; + +our $USE_PAGED_MODE = 1; +use constant DEFAULT_PAGE => 1; +use constant DEFAULT_RES_PER_PAGE => 50; +our %page_params = ( page => { default => DEFAULT_PAGE, + match => '(\d+)' }, + number => { default => DEFAULT_RES_PER_PAGE, + match => '(\d+)' } ); + +our $debug = 0; + +sub parse_params { + my ( $cgi, $params_def ) = @_; + + my %params_ret = ( values => {}, errors => {} ); + my %params; + if ($USE_PAGED_MODE) { + print "DEBUG: Use PAGED_MODE
" if $debug; + %params = %$params_def; + foreach (keys %page_params) { + delete $params{$_}; + } + %params = ( %params, %page_params ); + } else { + %params = %$params_def; + } + + foreach my $param ( keys %params ) { + + print "

DEBUG: Param $param
" if $debug; + + my $p_value_orig = $cgi->param($param); + + if (!defined($p_value_orig) + && defined $params_def->{$param}{alias} + && defined $cgi->param($params_def->{$param}{alias})) { + $p_value_orig = $cgi->param($params_def->{$param}{alias}); + print "DEBUG: Used alias $params_def->{$param}{alias}
" + if $debug; + } + + my @p_value = ($p_value_orig); + + print "DEBUG: Value (Orig) ".($p_value_orig||"")."
" if $debug; + + if ($params_def->{$param}{array} && defined $p_value_orig) { + @p_value = split /$params_def->{$param}{array}/, $p_value_orig; + print "DEBUG: Value (Array Split) ". + join('##',@p_value)."
" if $debug; + } + + if ($params_def->{$param}{match} && defined $p_value_orig) { + @p_value = map + { $_ =~ m/$params_def->{$param}{match}/; $_ = $1 } + @p_value; + } + @p_value = grep { defined $_ } @p_value; + + print "DEBUG: Value (Match) ". + join('##',@p_value)."
" if $debug; + + unless (@p_value) { + if (defined $params{$param}{default}) { + @p_value = ($params{$param}{default}); + } else { + @p_value = undef; + $params_ret{errors}{$param} = "undef"; + next; + } + } + + print "DEBUG: Value (Default) ". + join('##',@p_value)."
" if $debug; + my @p_value_no_replace = @p_value; + + if ($params{$param}{replace} && @p_value) { + @p_value = (); + foreach my $pattern (keys %{$params{$param}{replace}}) { + foreach (@p_value_no_replace) { + if ($_ eq $pattern) { + my $replacement = $params{$param}{replace}{$_}; + if (ref $replacement) { + push @p_value, @$replacement; + } else { + push @p_value, $replacement; + } + } else { + push @p_value, $_; + } + } + } + } + + print "DEBUG: Value (Final) ". + join('##',@p_value)."
" if $debug; + + if ($params_def->{$param}{array}) { + $params_ret{values}{$param} = { + orig => $p_value_orig, + no_replace => \@p_value_no_replace, + final => \@p_value, + }; + } else { + $params_ret{values}{$param} = { + orig => $p_value_orig, + no_replace => $p_value_no_replace[0], + final => $p_value[0], + }; + } + } + + if ($USE_PAGED_MODE) { + $cgi->delete( "page" ); + $cgi->delete( "number" ); + } + + return %params_ret; +} + +sub start { + my $params = shift; + + my $page = $params->{values}{page}{final} + || DEFAULT_PAGE; + my $res_per_page = $params->{values}{number}{final} + || DEFAULT_RES_PER_PAGE; + + return 1 if $res_per_page =~ /^all$/i; + return $res_per_page * ($page - 1) + 1; +} + +sub end { + my $params = shift; + + my $page = $params->{values}{page}{final} + || DEFAULT_PAGE; + my $res_per_page = $params->{values}{number}{final} + || DEFAULT_RES_PER_PAGE; + + return $page * $res_per_page; +} + +sub indexline { + my ($cgi, $params, $num_res) = @_; + + my $index_line = ""; + my $page = $params->{values}{page}{final} + || DEFAULT_PAGE; + my $res_per_page = $params->{values}{number}{final} + || DEFAULT_RES_PER_PAGE; + my $numpages = ceil($num_res / + $res_per_page); + for (my $i = 1; $i <= $numpages; $i++) { + if ($i == $page) { + $index_line .= $i; + } else { + $index_line .= "self_url). + "&page=$i&number=$res_per_page\">". + "$i"; + } + if ($i < $numpages) { + $index_line .= " | "; + } + } + return $index_line; +} + +sub nextlink { + my ($cgi, $params, $no_results ) = @_; + + my $page = $params->{values}{page}{final} + || DEFAULT_PAGE; + $page++; + my $res_per_page = $params->{values}{number}{final} + || DEFAULT_RES_PER_PAGE; + + if ((($page-1)*$res_per_page + 1) > $no_results) { + return ">>"; + } + + return "self_url). + "&page=$page&number=$res_per_page\">>>"; +} + +sub prevlink { + my ($cgi, $params ) = @_; + + my $page = $params->{values}{page}{final} + || DEFAULT_PAGE; + $page--; + if (!$page) { + return "<<"; + } + + my $res_per_page = $params->{values}{number}{final} + || DEFAULT_RES_PER_PAGE; + + return "self_url). + "&page=$page&number=$res_per_page\"><<"; +} + +sub resperpagelink { + my ($cgi, $params, $res_per_page ) = @_; + + my $page; + if ($res_per_page =~ /^all$/i) { + $page = 1; + } else { + $page = ceil(start( $params ) / $res_per_page); + } + + return "self_url). + "&page=$page&number=$res_per_page\">$res_per_page"; +} + + +1;