path: root/perllib/Utils.pm

#!/usr/bin/perl
#
# Utils.pm:
# Various generic utilities for FixMyStreet.
#
# Copyright (c) 2008 UK Citizens Online Democracy. All rights reserved.
# Email: matthew@mysociety.org; WWW: http://www.mysociety.org/
#
# $Id: Utils.pm,v 1.1 2008-10-09 14:20:54 matthew Exp $
#

package Utils;

use strict;
use Encode;
use File::Slurp qw();
use POSIX qw(strftime);
use mySociety::DBHandle qw(dbh);
use mySociety::GeoUtil;
use mySociety::Locale;

sub workaround_pg_bytea {
    my ( $st, $img_idx, @elements ) = @_;
    my $s = dbh()->prepare($st);
    for ( my $i = 1 ; $i <= @elements ; $i++ ) {
        if ( $i == $img_idx ) {
            $s->bind_param(
                $i,
                $elements[ $i - 1 ],
                { pg_type => DBD::Pg::PG_BYTEA }
            );
        }
        else {
            $s->bind_param( $i, $elements[ $i - 1 ] );
        }
    }
    $s->execute();
}

=head2 convert_latlon_to_en

    ( $easting, $northing ) = Utils::convert_en_to_latlon( $latitude, $longitude );

Takes the WGS84 latitude and longitude and returns OSGB36 easting and northing.

=cut

sub convert_latlon_to_en {
    my ( $latitude, $longitude ) = @_;

    local $SIG{__WARN__} = sub { die $_[0] };
    my ( $easting, $northing ) =
        mySociety::Locale::in_gb_locale {
            mySociety::GeoUtil::wgs84_to_national_grid( $latitude, $longitude, 'G' );
        };

    return ( $easting, $northing );
}

=head2 convert_en_to_latlon

    ( $latitude, $longitude ) = Utils::convert_en_to_latlon( $easting, $northing );

Takes the OSGB36 easting and northing and returns WGS84 latitude and longitude.

=cut

sub convert_en_to_latlon {
    my ( $easting, $northing ) = @_;

    my ( $latitude, $longitude ) =

      # map { truncate_coordinate($_) }
      mySociety::GeoUtil::national_grid_to_wgs84( $easting, $northing, 'G' );

    return ( $latitude, $longitude );
}

=head2 convert_en_to_latlon_truncated

    ( $lat, $lon ) = Utils::convert_en_to_latlon( $easting, $northing );

Takes the OSGB36 easting and northing and returns WGS84 latitude and longitude
(truncated using C<Utils::truncate_coordinate>).

=cut

sub convert_en_to_latlon_truncated {
    my ( $easting, $northing ) = @_;

    return
      map { truncate_coordinate($_) }
      convert_en_to_latlon( $easting, $northing );
}

=head2 truncate_coordinate

    $short = Utils::truncate_coordinate( $long );

Given a long coordinate returns a shorter one - rounded to 6 decimal places -
which is < 1m at the equator, if you're using WGS84 lat/lon.

=cut

sub truncate_coordinate {
    my $in = shift;
    my $out = mySociety::Locale::in_gb_locale {
        sprintf( '%0.6f', $in );
    };
    $out =~ s{\.?0+\z}{} if $out =~ m{\.};
    return $out;
}

sub london_categories {
    return {
        'Abandoned vehicle' => 'AbandonedVehicle',
        'Car parking' => 'Parking',
        'Dangerous structure' => 'DangerousStructure',
        'Dead animal' => 'DeadAnimal',
        'Dumped cylinder' => 'DumpedCylinder',
        'Dumped rubbish' => 'DumpedRubbish',
        'Flyposting' => 'FlyPosting',
        'Graffiti' => 'Graffiti',
        'Litter bin' => 'LitterBin',
        'Public toilet' => 'PublicToilet',
        'Refuse collection' => 'RefuseCollection',
        'Road or pavement defect' => 'Road',
        'Road or pavement obstruction' => 'Obstruction',
        'Skip problem' => 'Skip',
        'Street cleaning' => 'StreetCleaning',
        'Street drainage' => 'StreetDrainage',
        'Street furniture' => 'StreetFurniture',
        'Street needs gritting' => 'StreetGritting',
        'Street lighting' => 'StreetLighting',
        'Street sign' => 'StreetSign',
        'Traffic light' => 'TrafficLight',
        'Tree (dangerous)' => 'DangerousTree',
        'Tree (fallen branches)' => 'FallenTree',
        'Untaxed vehicle' => 'UntaxedVehicle',
    };
}

sub barnet_categories {
    # The values here are KBIDs from Barnet's system: see bin/send-reports for formatting 
    #    category                   KBID
    return {    
        'Abandoned Vehicles'        => 468,
        'Accumulated Litter'        => 349,
        'Dog Bins'                  => 203,
        'Dog Fouling'               => 288,
        'Drains & Gullies'          => 256,
        'Fly Posting'               => 465,
        'Fly Tipping'               => 449,
        'Graffiti'                  => 292,
        'Gritting'                  => 200,
        'Highways'                  => 186,
        'Litter Bins Overflowing'   => 205,
        'Manhole Covers'            => 417,
        'Pavements Damaged/Cracked' => 195,
        'Potholes'                  => 204,
        'Road Signs'                => 080,
        'Roadworks'                 => 246,
        'Street Lighting'           => 251,        
    };
}

=head2 trim_text

    my $text = trim_text( $text_to_trim );

Strip leading and trailing white space from a string. Also reduces all
white space to a single space.

Trim 

=cut

sub trim_text {
    my $input = shift;
    for ($input) {
        last unless $_;
        s{\s+}{ }g;    # all whitespace to single space
        s{^ }{};       # trim leading
        s{ $}{};       # trim trailing
    }
    return $input;
}


=head2 cleanup_text

Tidy up text including removing contentious phrases,
SHOUTING and new lines and adding sentence casing. Takes an optional HASHREF
of args as follows.

=over

=item allow_multiline

Do not flatten down to a single line if true.

=back

=cut

sub cleanup_text {
    my $input = shift || '';
    my $args  = shift || {};

    # lowercase everything if looks like it might be SHOUTING
    $input = lc $input if $input !~ /[a-z]/;

    # clean up language and tradmarks
    for ($input) {

        # shit -> poo
        s{\bdog\s*shite*?\b}{dog poo}ig;

        # 'portakabin' to '[portable cabin]' (and variations)
        s{\b(porta)\s*([ck]abin|loo)\b}{[$1ble $2]}ig;
        s{kabin\]}{cabin\]}ig;
    }

    # Remove unneeded whitespace
    my @lines = grep { m/\S/ } split m/(?:\r?\n){2,}/, $input;
    for (@lines) {
        $_ = trim_text($_);
        $_ = ucfirst $_;       # start with capital
    }

    my $join_char = $args->{allow_multiline} ? "\n\n" : " ";
    $input = join $join_char, @lines;

    return $input;
}

sub prettify_epoch {
    my ( $s, $type ) = @_;
    $type = 'short' if $type eq '1';

    my @s = localtime($s);
    my $tt = '';
    $tt = strftime('%H:%M', @s) unless $type eq 'date';
    my @t = localtime();
    if (strftime('%Y%m%d', @s) eq strftime('%Y%m%d', @t)) {
        return "$tt " . _('today');
    }
    $tt .= ', ' unless $type eq 'date';
    if (strftime('%Y %U', @s) eq strftime('%Y %U', @t)) {
        $tt .= decode_utf8(strftime('%A', @s));
    } elsif ($type eq 'short') {
        $tt .= decode_utf8(strftime('%e %b %Y', @s));
    } elsif (strftime('%Y', @s) eq strftime('%Y', @t)) {
        $tt .= decode_utf8(strftime('%A %e %B %Y', @s));
    } else {
        $tt .= decode_utf8(strftime('%a %e %B %Y', @s));
    }
    return $tt;
}

# argument is duration in seconds, rounds to the nearest minute
sub prettify_duration {
    my ($s, $nearest) = @_;
    if ($nearest eq 'week') {
        $s = int(($s+60*60*24*3.5)/60/60/24/7)*60*60*24*7;
    } elsif ($nearest eq 'day') {
        $s = int(($s+60*60*12)/60/60/24)*60*60*24;
    } elsif ($nearest eq 'hour') {
        $s = int(($s+60*30)/60/60)*60*60;
    } elsif ($nearest eq 'minute') {
        $s = int(($s+30)/60)*60;
        return _('less than a minute') if $s == 0;
    }
    my @out = ();
    _part(\$s, 60*60*24*7, _('%d week'), _('%d weeks'), \@out);
    _part(\$s, 60*60*24, _('%d day'), _('%d days'), \@out);
    _part(\$s, 60*60, _('%d hour'), _('%d hours'), \@out);
    _part(\$s, 60, _('%d minute'), _('%d minutes'), \@out);
    return join(', ', @out);
}
sub _part {
    my ($s, $m, $w1, $w2, $o) = @_;
    if ($$s >= $m) {
        my $i = int($$s / $m);
        push @$o, sprintf(mySociety::Locale::nget($w1, $w2, $i), $i);
        $$s -= $i * $m;
    }
}

=head2 read_file

Reads in a UTF-8 encoded file using File::Slurp and decodes it from UTF-8.
This appears simplest, rather than getting confused with binmodes and so on.

=cut
sub read_file {
    my $filename = shift;
    my $data = File::Slurp::read_file( $filename );
    $data = Encode::decode( 'utf8', $data );
    return $data;
}

1;