diff --git a/C4/Auth.pm b/C4/Auth.pm index d816332eec..581bdd1a45 100644 --- a/C4/Auth.pm +++ b/C4/Auth.pm @@ -389,6 +389,7 @@ sub get_template_and_user { noItemTypeImages => C4::Context->preference("noItemTypeImages"), marcflavour => C4::Context->preference("marcflavour"), persona => C4::Context->preference("persona"), + OPACBaseURL => C4::Context->preference('OPACBaseURL'), ); if ( $in->{'type'} eq "intranet" ) { $template->param( @@ -460,11 +461,6 @@ sub get_template_and_user { $opac_name = C4::Context->userenv->{'branch'}; } - # FIXME Under Plack the CGI->https method always returns 'OFF' ($using_https will be set to 0 in this case) - my $opac_base_url = C4::Context->preference("OPACBaseURL"); #FIXME uses $using_https below as well - if ( !$opac_base_url ) { - $opac_base_url = $ENV{'SERVER_NAME'} . ( $ENV{'SERVER_PORT'} eq ( $using_https ? "443" : "80" ) ? '' : ":$ENV{'SERVER_PORT'}" ); - } $template->param( OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"), AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"), @@ -483,7 +479,6 @@ sub get_template_and_user { OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"), OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"), OpacAuthorities => C4::Context->preference("OpacAuthorities"), - OPACBaseURL => ( $using_https ? "https://" : "http://" ) . $opac_base_url, opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'}, opac_search_limit => $opac_search_limit, opac_limit_override => $opac_limit_override, diff --git a/C4/Auth_with_shibboleth.pm b/C4/Auth_with_shibboleth.pm index f9555fb7a0..6c53c79882 100644 --- a/C4/Auth_with_shibboleth.pm +++ b/C4/Auth_with_shibboleth.pm @@ -113,7 +113,21 @@ sub _get_uri { my $protocol = "https://"; - my $return = $protocol . C4::Context->preference('OPACBaseURL'); + my $uri = C4::Context->preference('OPACBaseURL') // ''; + if ($uri eq '') { + $debug and warn 'OPACBaseURL not set!'; + } + if ($uri =~ /(.*):\/\/(.*)/) { + my $oldprotocol = $1; + if ($oldprotocol ne 'https') { + $debug + and warn + 'Shibboleth requires OPACBaseURL to use the https protocol!'; + } + $uri = $2; + } + + my $return = $protocol . $uri; return $return; } diff --git a/C4/Context.pm b/C4/Context.pm index a51f5c7c51..452b764c2e 100644 --- a/C4/Context.pm +++ b/C4/Context.pm @@ -609,6 +609,11 @@ sub set_preference { $value = 0 if ( $type && $type eq 'YesNo' && $value eq '' ); + # force explicit protocol on OPACBaseURL + if ($var eq 'opacbaseurl' && substr($value,0,4) !~ /http/) { + $value = 'http://' . $value; + } + my $sth = $dbh->prepare( " INSERT INTO systempreferences ( variable, value ) diff --git a/catalogue/detail.pl b/catalogue/detail.pl index 74665b18b9..b7ba9a4266 100755 --- a/catalogue/detail.pl +++ b/catalogue/detail.pl @@ -397,12 +397,6 @@ if ( (C4::Context->preference("HTML5MediaEnabled") eq 'both') or (C4::Context->p $template->param( C4::HTML5Media->gethtml5media($record)); } - -# Get OPAC URL -if (C4::Context->preference('OPACBaseURL')){ - $template->param( OpacUrl => C4::Context->preference('OPACBaseURL') ); -} - # Displaying tags my $tag_quantity; diff --git a/installer/data/mysql/de-DE/mandatory/sample_notices.sql b/installer/data/mysql/de-DE/mandatory/sample_notices.sql index 944b6644e1..88cf55198c 100644 --- a/installer/data/mysql/de-DE/mandatory/sample_notices.sql +++ b/installer/data/mysql/de-DE/mandatory/sample_notices.sql @@ -101,7 +101,7 @@ VALUES ( Ihr Bibliothekskonto wurde angelegt. Bitte bestätigen Sie Ihre E-Mail-Adresse indem Sie auf folgenden Link klicken: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> Wenn Sie keine Kontoanmeldung durchgeführt haben, können Sie diese Benachrichtigung ignorieren. Sie wird in Kürze ungültig. diff --git a/installer/data/mysql/en/mandatory/sample_notices.sql b/installer/data/mysql/en/mandatory/sample_notices.sql index 7bf8086a28..8616dda812 100644 --- a/installer/data/mysql/en/mandatory/sample_notices.sql +++ b/installer/data/mysql/en/mandatory/sample_notices.sql @@ -115,7 +115,7 @@ VALUES ( Your library account has been created. Please verify your email address by clicking this link to complete the signup process: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> If you did not initiate this request, you may safely ignore this one-time message. The request will expire shortly.' ); diff --git a/installer/data/mysql/es-ES/mandatory/sample_notices.sql b/installer/data/mysql/es-ES/mandatory/sample_notices.sql index 61f4dbe6db..99494e2850 100644 --- a/installer/data/mysql/es-ES/mandatory/sample_notices.sql +++ b/installer/data/mysql/es-ES/mandatory/sample_notices.sql @@ -112,7 +112,7 @@ VALUES ( Your library account has been created. Please verify your email address by clicking this link to complete the signup process: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> If you did not initiate this request, you may safely ignore this one-time message. The request will expire shortly.' ); diff --git a/installer/data/mysql/fr-FR/1-Obligatoire/sample_notices.sql b/installer/data/mysql/fr-FR/1-Obligatoire/sample_notices.sql index 3e0c53b9bc..348597f42a 100644 --- a/installer/data/mysql/fr-FR/1-Obligatoire/sample_notices.sql +++ b/installer/data/mysql/fr-FR/1-Obligatoire/sample_notices.sql @@ -115,7 +115,7 @@ VALUES ( Votre compte de bibliothèque a été créé. Veuillez valider votre adresse email et le processus d''inscription en cliquant sur ce lien: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> Si vous n''êtes pas à l''origine de cette inscription, vous pouvez ignorer ce message.' ); diff --git a/installer/data/mysql/it-IT/necessari/notices.sql b/installer/data/mysql/it-IT/necessari/notices.sql index 9e8c9a6398..56eda213e8 100644 --- a/installer/data/mysql/it-IT/necessari/notices.sql +++ b/installer/data/mysql/it-IT/necessari/notices.sql @@ -115,7 +115,7 @@ VALUES ( Your library account has been created. Please verify your email address by clicking this link to complete the signup process: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> If you did not initiate this request, you may safely ignore this one-time message. The request will expire shortly.' ); diff --git a/installer/data/mysql/nb-NO/1-Obligatorisk/sample_notices.sql b/installer/data/mysql/nb-NO/1-Obligatorisk/sample_notices.sql index 0b283572ad..49826e8361 100644 --- a/installer/data/mysql/nb-NO/1-Obligatorisk/sample_notices.sql +++ b/installer/data/mysql/nb-NO/1-Obligatorisk/sample_notices.sql @@ -137,7 +137,7 @@ VALUES ( D har blitt registrert som bruker av biblioteket. Verifiser epostadressen din ved å klikke på lenka nedenfor: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> Dersom du ikke har bedt om å bli registret som bruker av biblioteket kan du se bort fra denne engangsmeldingen. Forespørselen vil snart gå ut på dato.' ); diff --git a/installer/data/mysql/pl-PL/mandatory/sample_notices.sql b/installer/data/mysql/pl-PL/mandatory/sample_notices.sql index a6516b6941..1a419db8fa 100644 --- a/installer/data/mysql/pl-PL/mandatory/sample_notices.sql +++ b/installer/data/mysql/pl-PL/mandatory/sample_notices.sql @@ -114,7 +114,7 @@ VALUES ( Your library account has been created. Please verify your email address by clicking this link to complete the signup process: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> If you did not initiate this request, you may safely ignore this one-time message. The request will expire shortly.' ); diff --git a/installer/data/mysql/ru-RU/mandatory/sample_notices.sql b/installer/data/mysql/ru-RU/mandatory/sample_notices.sql index 6218d3d0fc..ba2cf3df4e 100644 --- a/installer/data/mysql/ru-RU/mandatory/sample_notices.sql +++ b/installer/data/mysql/ru-RU/mandatory/sample_notices.sql @@ -115,7 +115,7 @@ VALUES ( Your library account has been created. Please verify your email address by clicking this link to complete the signup process: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> If you did not initiate this request, you may safely ignore this one-time message. The request will expire shortly.' ); diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql index 9620d67d84..0e65f8028a 100644 --- a/installer/data/mysql/sysprefs.sql +++ b/installer/data/mysql/sysprefs.sql @@ -245,7 +245,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, ` ('OPACAllowUserToChooseBranch','1','1','Allow the user to choose the branch they want to pickup their hold from','YesNo'), ('OPACAmazonCoverImages','0','','Display cover images on OPAC from Amazon Web Services','YesNo'), ('OpacAuthorities','1',NULL,'If ON, enables the search authorities link on OPAC','YesNo'), -('OPACBaseURL',NULL,NULL,'Specify the Base URL of the OPAC, e.g., opac.mylibrary.com, the http:// will be added automatically by Koha.','Free'), +('OPACBaseURL',NULL,NULL,'Specify the Base URL of the OPAC, e.g., http://opac.mylibrary.com, including the protocol (http:// or https://). Otherwise, the http:// will be added automatically by Koha upon saving.','Free'), ('opacbookbag','1','','If ON, enables display of Cart feature','YesNo'), ('OpacBrowser','0',NULL,'If ON, enables subject authorities browser on OPAC (needs to set misc/cronjob/sbuild_browser_and_cloud.pl)','YesNo'), ('OpacBrowseResults','1',NULL,'Disable/enable browsing and paging search results from the OPAC detail page.','YesNo'), diff --git a/installer/data/mysql/uk-UA/mandatory/sample_notices.sql b/installer/data/mysql/uk-UA/mandatory/sample_notices.sql index a7d6b96cc5..4aac574b43 100644 --- a/installer/data/mysql/uk-UA/mandatory/sample_notices.sql +++ b/installer/data/mysql/uk-UA/mandatory/sample_notices.sql @@ -114,7 +114,7 @@ VALUES ( Your library account has been created. Please verify your email address by clicking this link to complete the signup process: -http://<>/cgi-bin/koha/opac-registration-verify.pl?token=<> +<>/cgi-bin/koha/opac-registration-verify.pl?token=<> If you did not initiate this request, you may safely ignore this one-time message. The request will expire shortly.' ); diff --git a/installer/data/mysql/updatedatabase.pl b/installer/data/mysql/updatedatabase.pl index fe71359700..ee3a5bc312 100755 --- a/installer/data/mysql/updatedatabase.pl +++ b/installer/data/mysql/updatedatabase.pl @@ -10504,6 +10504,29 @@ if ( CheckVersion($DBversion) ) { SetVersion ($DBversion); } +$DBversion = '3.19.00.XXX'; +if ( CheckVersion($DBversion) ) { + my $OPACBaseURL = C4::Context->preference('OPACBaseURL'); + if (defined($OPACBaseURL) && substr($OPACBaseURL,0,4) ne "http") { + my $explanation = q{Specify the Base URL of the OPAC, e.g., http://opac.mylibrary.com, including the protocol (http:// or https://). Otherwise, the http:// will be added automatically by Koha upon saving.}; + $OPACBaseURL = 'http://' . $OPACBaseURL; + my $sth_OPACBaseURL = $dbh->prepare( q{ + UPDATE systempreferences SET value=?,explanation=? + WHERE variable='OPACBaseURL'; } ); + $sth_OPACBaseURL->execute($OPACBaseURL,$explanation); + } + if (defined($OPACBaseURL)) { + $dbh->do( q{ UPDATE letter + SET content=replace(content, + 'http://<>', + '<>') + WHERE content LIKE "%http://<>%"; } ); + } + + print "Upgrade to $DBversion done (Bug 5010: Fix OPACBaseURL to include protocol)\n"; + SetVersion($DBversion); +} + # DEVELOPER PROCESS, search for anything to execute in the db_update directory # SEE bug 13068 # if there is anything in the atomicupdate, read and execute it. diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref index 9a4309ca9a..aa37af46e5 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref @@ -13,10 +13,10 @@ OPAC: prog: prog - theme as the fallback theme on the OPAC. - - - "The OPAC is located at http://" + - "The OPAC is located at " - pref: OPACBaseURL class: url - - . Do not include a trailing slash in the URL. (This must be filled in correctly for RSS, unAPI, and search plugins to work.) + - . This should be a complete URL, starting with http:// or https://. Do not include a trailing slash in the URL. (This must be filled in correctly for RSS, unAPI, and search plugins to work.) - - Show - pref: LibraryName diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt index b7826162ee..570633ab53 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt @@ -445,9 +445,9 @@ function verify_images() { [% END %] - [% IF ( OpacUrl ) %] + [% IF ( OPACBaseURL ) %]
  • OPAC view: - Open in new window + Open in new window
    • [% END %]
  • diff --git a/koha-tmpl/intranet-tmpl/prog/en/xslt/MARC21slim2intranetDetail.xsl b/koha-tmpl/intranet-tmpl/prog/en/xslt/MARC21slim2intranetDetail.xsl index 5735650c62..35e78ae36f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/xslt/MARC21slim2intranetDetail.xsl +++ b/koha-tmpl/intranet-tmpl/prog/en/xslt/MARC21slim2intranetDetail.xsl @@ -940,7 +940,7 @@ OPAC view: - http:///cgi-bin/koha/opac-detail.pl?biblionumber=_blankOpen in new window. + /cgi-bin/koha/opac-detail.pl?biblionumber=_blankOpen in new window. diff --git a/koha-tmpl/intranet-tmpl/prog/en/xslt/NORMARCslim2intranetDetail.xsl b/koha-tmpl/intranet-tmpl/prog/en/xslt/NORMARCslim2intranetDetail.xsl index 9db138c07b..62df2a7b1e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/xslt/NORMARCslim2intranetDetail.xsl +++ b/koha-tmpl/intranet-tmpl/prog/en/xslt/NORMARCslim2intranetDetail.xsl @@ -588,7 +588,7 @@

    OPAC View: - http:///cgi-bin/koha/opac-detail.pl?biblionumber= + /cgi-bin/koha/opac-detail.pl?biblionumber= _blank Open in new window

    diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt index f0310d5d61..21b287128d 100644 --- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt +++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt @@ -1117,12 +1117,12 @@ [% IF ( SocialNetworks ) %] [% END %] diff --git a/opac/opac-shareshelf.pl b/opac/opac-shareshelf.pl index 3504ba1995..f967d711b8 100755 --- a/opac/opac-shareshelf.pl +++ b/opac/opac-shareshelf.pl @@ -185,8 +185,7 @@ sub send_invitekey { my ($param) = @_; my $fromaddr = C4::Context->preference('KohaAdminEmailAddress'); my $url = - 'http://' - . C4::Context->preference('OPACBaseURL') + C4::Context->preference('OPACBaseURL') . "/cgi-bin/koha/opac-shareshelf.pl?shelfnumber=" . $param->{shelfnumber} . "&op=accept&key="; diff --git a/t/Auth_with_shibboleth.t b/t/Auth_with_shibboleth.t index 82c95b99bc..6b4a727c4a 100644 --- a/t/Auth_with_shibboleth.t +++ b/t/Auth_with_shibboleth.t @@ -27,7 +27,7 @@ use C4::Context; BEGIN { if ( check_install( module => 'Test::DBIx::Class' ) ) { - plan tests => 6; + plan tests => 9; } else { plan skip_all => "Need Test::DBIx::Class" } @@ -59,6 +59,7 @@ sub mockedConfig { } ### Mock ->preference +my $OPACBaseURL = "testopac.com"; $context->mock( 'preference', \&mockedPref ); sub mockedPref { @@ -66,7 +67,7 @@ sub mockedPref { my $return; if ( $param eq 'OPACBaseURL' ) { - $return = "testopac.com"; + $return = $OPACBaseURL; } return $return; @@ -237,8 +238,29 @@ subtest "checkpw_shib tests" => sub { }; ## _get_uri +$OPACBaseURL = "testopac.com"; is( C4::Auth_with_shibboleth::_get_uri(), "https://testopac.com", "https opac uri returned" ); +$OPACBaseURL = "http://testopac.com"; +my $result; +warnings_are { $result = C4::Auth_with_shibboleth::_get_uri() } + [ { carped => + 'Shibboleth requires OPACBaseURL to use the https protocol!' }, + ], + "improper protocol - received expected warning"; +is( $result, "https://testopac.com", "https opac uri returned" ); + +$OPACBaseURL = "https://testopac.com"; +is( C4::Auth_with_shibboleth::_get_uri(), + "https://testopac.com", "https opac uri returned" ); + +$OPACBaseURL = undef; +warnings_are { $result = C4::Auth_with_shibboleth::_get_uri() } + [ { carped => 'OPACBaseURL not set!' }, + ], + "undefined OPACBaseURL - received expected warning"; +is( $result, "https://", "https opac uri returned" ); + ## _get_shib_config # Internal helper function, covered in tests above diff --git a/t/db_dependent/Auth.t b/t/db_dependent/Auth.t index f7690407a6..2cb1d5f466 100644 --- a/t/db_dependent/Auth.t +++ b/t/db_dependent/Auth.t @@ -8,7 +8,7 @@ use Modern::Perl; use CGI qw ( -utf8 ); use Test::MockModule; use List::MoreUtils qw/all any none/; -use Test::More tests => 6; +use Test::More tests => 8; use C4::Members; use Koha::AuthUtils qw/hash_password/; @@ -107,6 +107,34 @@ $dbh->{RaiseError} = 1; 'BZ9735: invalid language, then default to en'); } +# Check that there is always an OPACBaseURL set. +my $input = CGI->new(); +my ( $template1, $borrowernumber, $cookie ); +( $template1, $borrowernumber, $cookie ) = get_template_and_user( + { + template_name => "opac-detail.tt", + type => "opac", + query => $input, + authnotrequired => 1, + } +); + +ok( ( any { 'OPACBaseURL' eq $_ } keys %{$template1->{VARS}} ), + 'OPACBaseURL is in OPAC template' ); + +my ( $template2 ); +( $template2, $borrowernumber, $cookie ) = get_template_and_user( + { + template_name => "catalogue/detail.tt", + type => "intranet", + query => $input, + authnotrequired => 1, + } +); + +ok( ( any { 'OPACBaseURL' eq $_ } keys %{$template2->{VARS}} ), + 'OPACBaseURL is in Staff template' ); + my $hash1 = hash_password('password'); my $hash2 = hash_password('password'); diff --git a/t/db_dependent/Auth_with_cas.t b/t/db_dependent/Auth_with_cas.t index eb359a9fee..b67ba1e46f 100755 --- a/t/db_dependent/Auth_with_cas.t +++ b/t/db_dependent/Auth_with_cas.t @@ -38,7 +38,7 @@ my $dbh = C4::Context->dbh; $dbh->{ AutoCommit } = 0; $dbh->{ RaiseError } = 1; -C4::Context->set_preference('OPACBaseURL','localhost'); +C4::Context->set_preference('OPACBaseURL','http://localhost'); C4::Context->set_preference('staffClientBaseURL','localhost:8080'); my $opac_base_url = C4::Context->preference('OpacBaseURL'); diff --git a/t/db_dependent/Context.t b/t/db_dependent/Context.t index 8d93c99e57..7b2bafc8be 100755 --- a/t/db_dependent/Context.t +++ b/t/db_dependent/Context.t @@ -18,8 +18,34 @@ BEGIN { use_ok('C4::Context'); } -ok($koha = C4::Context->new, 'C4::Context->new'); ok($dbh = C4::Context->dbh(), 'Getting dbh from C4::Context'); + +$dbh->begin_work; +C4::Context->disable_syspref_cache(); +C4::Context->set_preference('OPACBaseURL','junk'); +C4::Context->clear_syspref_cache(); +my $OPACBaseURL = C4::Context->preference('OPACBaseURL'); +is($OPACBaseURL,'http://junk','OPACBaseURL saved with http:// when missing it'); + +C4::Context->set_preference('OPACBaseURL','https://junk'); +C4::Context->clear_syspref_cache(); +$OPACBaseURL = C4::Context->preference('OPACBaseURL'); +is($OPACBaseURL,'https://junk','OPACBaseURL saved with https:// as specified'); + +C4::Context->set_preference('OPACBaseURL','http://junk2'); +C4::Context->clear_syspref_cache(); +$OPACBaseURL = C4::Context->preference('OPACBaseURL'); +is($OPACBaseURL,'http://junk2','OPACBaseURL saved with http:// as specified'); + +C4::Context->set_preference('SillyPreference','random'); +C4::Context->clear_syspref_cache(); +my $SillyPeference = C4::Context->preference('SillyPreference'); +is($SillyPeference,'random','SillyPreference saved as specified'); +C4::Context->clear_syspref_cache(); +C4::Context->enable_syspref_cache(); +$dbh->rollback; + +ok($koha = C4::Context->new, 'C4::Context->new'); my @keys = keys %$koha; my $width = 0; if (ok(@keys)) { diff --git a/virtualshelves/sendshelf.pl b/virtualshelves/sendshelf.pl index 3696ba12dd..b2941e3102 100755 --- a/virtualshelves/sendshelf.pl +++ b/virtualshelves/sendshelf.pl @@ -101,11 +101,6 @@ if ($email) { push( @results, $dat ); } - if ( C4::Context->preference('OPACBaseURL') ) { - $template2->param( - OPACBaseURL => C4::Context->preference('OPACBaseURL') ); - } - $template2->param( BIBLIO_RESULTS => \@results, email_sender => $mail{'from'},