Skip to content

Commit

Permalink
[Gloucester] Added cobrand front-end
Browse files Browse the repository at this point in the history
It includes

- Logos
- Fonts
- Emails
- Colours
- Navigation bar
- favicon
- Site message
  • Loading branch information
lucascumsille authored and chrismytton committed Dec 18, 2024
1 parent 90b926b commit 42d41a8
Show file tree
Hide file tree
Showing 20 changed files with 930 additions and 0 deletions.
282 changes: 282 additions & 0 deletions perllib/FixMyStreet/Cobrand/Gloucester.pm
Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
=head1 NAME
FixMyStreet::Cobrand::Gloucester - code specific to the Gloucester cobrand
=head1 SYNOPSIS
We integrate with Gloucester's Confirm back end.
=head1 DESCRIPTION
=cut

package FixMyStreet::Cobrand::Gloucester;
use parent 'FixMyStreet::Cobrand::Whitelabel';

use strict;
use warnings;

use Moo;

use LWP::Simple;
use URI;
use Try::Tiny;
use JSON::MaybeXS;


=pod
Confirm backends expect some extra values and have some maximum lengths for
certain fields. These roles implement that behaviour.
=cut

with 'FixMyStreet::Roles::ConfirmOpen311';
with 'FixMyStreet::Roles::ConfirmValidation';

=head2 Defaults
=over 4
=cut

sub council_area_id { '2226' }
sub council_area { 'Gloucester' }
sub council_name { 'Gloucester County Council' }
sub council_url { 'gloucester' }

=item * Users with a gloucester.gov.uk email can always be found in the admin.
=cut

sub admin_user_domain { 'gloucester.gov.uk' }

=item * Allows anonymous reporting
=cut

sub allow_anonymous_reports { 'button' }

=item * Gloucester use their own privacy policy
=cut

sub privacy_policy_url {
'https://www.gloucester.gov.uk/council-and-democracy/data-protection/privacy-notices/gloucester-county-council-general-privacy-statement/gloucester-county-council-general-privacy-statement/'
}

=item * Users can not reopen reports
=cut

sub reopening_disallowed {
my ($self, $problem) = @_;

# Only staff can reopen reports.
my $c = $self->{c};
my $user = $c->user;
return 0 if ($c->user_exists && $user->from_body && $user->from_body->cobrand_name eq $self->council_name);
return 1;
}

=item * Jobs from Confirm that are completed (marked as fixed or closed) are not displayed after 48 hours
=cut

sub report_age {
return {
closed => {
job => '48 hours',
},
fixed => {
job => '48 hours',
},
};
}

=item * We do not send questionnaires.
=cut

sub send_questionnaires { 0 }

=item * Don't show reports before the go-live date, 4th October 2023
=cut

sub cut_off_date { '2023-10-04' }

=item * Add display_name as an extra contact field
=cut

sub contact_extra_fields { [ 'display_name' ] }

=item * Custom label and hint for new report detail field
=cut

sub new_report_detail_field_label {
'Where is the location of the problem? Please be specific and identify the nearest property address or landmark to the problem.'
}

sub new_report_detail_field_hint {
"e.g. 'The drain outside number 42 is blocked'"
}

=pod
=back
=cut

=head2 open311_skip_report_fetch
Do not fetch reports from Confirm for categories that are marked private.
=cut

sub open311_skip_report_fetch {
my ( $self, $problem ) = @_;

return 1 if $problem->non_public;
}

=head2 open311_update_missing_data
Unlike the ConfirmOpen311 role, we want to fetch a central asset ID here, not a
site code.
=cut

sub open311_update_missing_data {
my ($self, $row, $h, $contact) = @_;

# In case the client hasn't given us a central asset ID, look up the
# closest asset from the WFS service at the point we're sending the report
if (!$row->get_extra_field_value('central_asset_id')) {
if (my $id = $self->lookup_site_code($row)) {
$row->update_extra_field({ name => 'central_asset_id', value => $id });
}
}
}

sub lookup_site_code_config {
my $host = FixMyStreet->config('STAGING_SITE') ? "tilma.staging.mysociety.org" : "tilma.mysociety.org";
return {
buffer => 200, # metres
url => "https://$host/mapserver/gloucester",
srsname => "urn:ogc:def:crs:EPSG::27700",
typename => "WSF",
property => "CentralAssetId",
accept_feature => sub { 1 }
};
}

=head2 open311_extra_data_include
Gloucester want report title to be in description field, along with
subcategory text, which is not otherwise captured by Confirm. Report detail
goes into the location field.
Subcategory text may need to be fetched from '_wrapped_service_code'
extra data.
=cut

around open311_extra_data_include => sub {
my ( $orig, $self, $row, $h ) = @_;
my $open311_only = $self->$orig( $row, $h );

my $category = $row->category;
my $wrapped_for_report
= $row->get_extra_field_value('_wrapped_service_code');
my $wrapped_categories
= $row->contact->get_extra_field( code => '_wrapped_service_code' );

if ( $wrapped_for_report && $wrapped_categories ) {
($category)
= grep { $_->{key} eq $wrapped_for_report }
@{ $wrapped_categories->{values} };

$category = $category->{name};
}

push @$open311_only, {
name => 'description',
value => $category . ' | ' . $row->title,
};
push @$open311_only, {
name => 'location',
value => $row->detail,
};

return $open311_only;
};


sub disambiguate_location {
my $self = shift;
my $string = shift;

my $town = 'Gloucester';

# As it's the requested example location, try to avoid a disambiguation page
$town .= ', GL20 5XA'
if $string =~ /^\s*gloucester\s+r(oa)?d,\s*tewkesbury\s*$/i;

return {
%{ $self->SUPER::disambiguate_location() },
town => $town,
centre => '51.825508771929094,-2.1263689427866654',
span => '0.53502964014244,1.07233523662321',
bounds => [
51.57753580138198, -2.687537158717889,
52.11256544152442, -1.6152019220946803,
],
};
}

=head2 is_defect
Returns true if it's a fetched job from Confirm.
=cut

sub is_defect {
my ($self, $p) = @_;
return $p->external_id && $p->external_id =~ /^JOB_/;
}

=head2 pin_colour
Green for anything completed or closed, yellow for the rest,
apart from defects which are blue.
=cut

sub pin_colour {
my ( $self, $p ) = @_;

return 'defects' if $self->is_defect($p);
return 'green' if $p->is_fixed || $p->is_closed;
return 'yellow';
}

sub path_to_pin_icons {
return '/cobrands/oxfordshire/images/';
}

=head2 open311_config
Send multiple photos as files to Open311
=cut

sub open311_config {
my ($self, $row, $h, $params) = @_;

$params->{multi_photos} = 1;
$params->{upload_files} = 1;
}

1;
20 changes: 20 additions & 0 deletions templates/email/gloucester/_email_color_overrides.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[%

color_primary = '#0054a4'
color_pale_grey = '#f0f0f0'

body_font_family = "Helvetica, sans-serif"

header_background_color = color_primary
header_text_color = color_white

secondary_column_background_color = color_pale_grey

button_background_color = color_primary
button_text_color = color_white

logo_file = 'gloucester-logo.png'
logo_width = "176" # pixel measurement, but without 'px' suffix
logo_height = "70" # pixel measurement, but without 'px' suffix

%]
59 changes: 59 additions & 0 deletions templates/email/gloucester/archive-old-enquiries.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
[%

email_summary = "Your reports on " _ site_name;

PROCESS '_email_settings.html';

INCLUDE '_email_top.html';

%]

<th style="[% td_style %][% only_column_style %]">
<h1 style="[% h1_style %]">Your reports on [% site_name %]</h1>
<p style="[% p_style %]">
Hello [% user.name %],
</p>
<p style="[% p_style %]">
I am writing to let you know about some exciting new changes.
</p>
<p style="[% p_style %]">
FixMyStreet is being updated in Gloucestershire to improve how Highway issues are being reported. All reports are still being processed as usual and you don't need to do anything.
</p>
<p style="[% p_style %]">
This change makes the reporting system quicker, more efficient and lets you know automatically when work progresses or is completed.
</p>
<p style="[% p_style %]">
This was launched on Wednesday, 4 October 2023 and as part of this process, reports made on FixMyStreet.com before the update have been closed.
</p>
<p style="[% p_style %]">
All of your reports will have been received and reviewed by Gloucestershire County Council, it is just the enquiry on FixMyStreet.com that has been closed. If your report is currently ongoing, it will still be being processed by Gloucestershire County Council and you will receive updates.
</p>
<p style="[% p_style %]">
We noticed that you have [% report_count %] old [% nget('report', 'reports', report_count) %] on the FixMyStreet.com system,
which are listed below.
</p>

[% FOR report IN reports %]
<div style="[% list_item_style %]">
[% IF report.photo %]
<a href="https://www.fixmystreet.com/report/[% report.id %]">
<img style="[% list_item_photo_style %]" src="[% inline_image(report.get_first_image_fp) %]" alt="">
</a>
[% END %]
<h2 style="[% list_item_h2_style %]"><a href="https://www.fixmystreet.com/report/[% report.id %]">
[%~ report.title | html ~%]
</a></h2>
<p style="[% list_item_p_style %]">[% report.detail | html %]</p>
<p style="[% list_item_date_style %]">
Reported [% report.time_ago %] ago.
</p>
</div>
[% END %]

<p style="[% p_style %]">
The FixMyStreet team and Gloucestershire Highways
</p>

</th>

[% INCLUDE '_email_bottom.html' %]
29 changes: 29 additions & 0 deletions templates/email/gloucester/archive-old-enquiries.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Subject: Your reports on [% site_name %]

Hello [% user.name %],

I am writing to let you know about some exciting new changes.

FixMyStreet is being updated in Gloucestershire to improve how Highway issues are being reported. All reports are still being processed as usual and you don't need to do anything.

This change makes the reporting system quicker, more efficient and lets you know automatically when work progresses or is completed.

This was launched on Wednesday, 4 October 2023 and as part of this process, reports made on FixMyStreet.com before the update have been closed.

All of your reports will have been received and reviewed by Gloucestershire County Council, it is just the enquiry on FixMyStreet.com that has been closed. If your report is currently ongoing, it will still be being processed by Gloucestershire County Council and you will receive updates.

We noticed that you have [% report_count %] old [% nget('report', 'reports', report_count) %] on the FixMyStreet.com system, which are listed below.

[% FOR report IN reports %]

[% report.title %]

Reported [% report.time_ago %] ago.

View report: https://www.fixmystreet.com/report/[% report.id %]

----

[% END %]

The FixMyStreet team and Gloucestershire Highways
Loading

0 comments on commit 42d41a8

Please sign in to comment.