installer/onboarding.pl

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright (C) 2017 Catalyst IT
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21 use C4::Context;
  22 use C4::InstallAuth;
  23 use CGI qw ( -utf8 );
  24 use C4::Output;
  25 use C4::Members;
  26 use Koha::Patrons;
  27 use Koha::Libraries;
  28 use Koha::Database;
  29 use Koha::DateUtils;
  30 use Koha::Patron::Categories;
  31 use Koha::Patron::Category;
  32 use Koha::ItemTypes;
  33 use Koha::IssuingRule;
  34 use Koha::IssuingRules;
  35
  36 #Setting variables
  37 my $input = new CGI;
  38
  39 unless ( C4::Context->preference('Version') ) {
  40     print $input->redirect("/cgi-bin/koha/installer/install.pl");
  41     exit;
  42 }
  43
  44 my ( $user, $cookie, $sessionID, $flags ) =
  45   C4::InstallAuth::checkauth( $input, 0, undef, 'intranet' );
  46 die "Not logged in"
  47   unless $user
  48   ; # Should not happen, we should be redirect if the user is not logged in. But do not trust authentication...
  49
  50 my $step = $input->param('step') || 1;
  51 my $op   = $input->param('op')   || '';
  52
  53 my $template_params = {};
  54 $template_params->{op} = $op;
  55
  56 my $schema = Koha::Database->new()->schema();
  57
  58 my @messages;
  59
  60 if ( $step == 1 ) {
  61
  62     if ( $op eq 'add_validate_library' ) {
  63
  64         my $branchcode = $input->param('branchcode');
  65         $branchcode = uc($branchcode);
  66
  67         $branchcode =~ s|\s||g
  68           ; # Use a regular expression to check the value of the inputted branchcode
  69
  70         my $library = Koha::Library->new(
  71             {
  72                 branchcode => $branchcode,
  73                 branchname => scalar $input->param('branchname'),
  74             }
  75         );
  76
  77         eval { $library->store; };
  78         unless ($@) {
  79             push @messages, { code => 'success_on_insert_library' };
  80         }
  81         else {
  82             push @messages, { code => 'error_on_insert_library' };
  83         }
  84     }
  85
  86     $step++ if Koha::Libraries->count;
  87 }
  88 if ( $step == 2 ) {
  89     if ( $op eq "add_validate_category" ) {
  90
  91         my $searchfield = $input->param('description') // q||;
  92         my $categorycode = $input->param('categorycode');
  93         my $category;
  94         $template_params->{categorycode} = $categorycode;
  95
  96         $categorycode = $input->param('categorycode');
  97         my $description           = $input->param('description');
  98         my $overduenoticerequired = $input->param('overduenoticerequired');
  99         my $category_type         = $input->param('category_type');
 100         my $default_privacy       = $input->param('default_privacy');
 101         my $enrolmentperiod       = $input->param('enrolmentperiod');
 102         my $enrolmentperioddate = $input->param('enrolmentperioddate') || undef;
 103
 104         #Converts the string into a date format
 105         if ($enrolmentperioddate) {
 106             $enrolmentperioddate = output_pref(
 107                 {
 108                     dt         => dt_from_string($enrolmentperioddate),
 109                     dateformat => 'DateTime',
 110                     dateonly   => 1,
 111                 }
 112             );
 113         }
 114
 115         #Adds a new patron category to the database
 116         $category = Koha::Patron::Category->new(
 117             {
 118                 categorycode          => $categorycode,
 119                 description           => $description,
 120                 overduenoticerequired => $overduenoticerequired,
 121                 category_type         => $category_type,
 122                 default_privacy       => $default_privacy,
 123                 enrolmentperiod       => $enrolmentperiod,
 124                 enrolmentperioddate   => $enrolmentperioddate
 125             }
 126         );
 127
 128         eval { $category->store; };
 129
 130         unless ($@) {
 131             push @messages, { code => 'success_on_insert_category' };
 132         }
 133         else {
 134             push @messages, { code => 'error_on_insert_category' };
 135         }
 136     }
 137
 138     $step++ if Koha::Patron::Categories->count;
 139 }
 140 if ( $step == 3 ) {
 141     if ( $op eq 'add_validate_patron' ) {
 142
 143         #Create a patron
 144         my $firstpassword  = $input->param('password')  || '';
 145         my $secondpassword = $input->param('password2') || '';
 146         my $cardnumber     = $input->param('cardnumber');
 147         my $userid         = $input->param('userid');
 148
 149         my ( $is_valid, $passworderror) = Koha::AuthUtils::is_password_valid( $firstpassword );
 150
 151         if ( my $error_code = checkcardnumber($cardnumber) ) {
 152             if ( $error_code == 1 ) {
 153                 push @messages, { code => 'ERROR_cardnumber_already_exists' };
 154             }
 155             elsif ( $error_code == 2 ) {
 156                 push @messages, { code => 'ERROR_cardnumber_length' };
 157             }
 158         }
 159         elsif ( $firstpassword ne $secondpassword ) {
 160
 161             push @messages, { code => 'ERROR_password_mismatch' };
 162         }
 163         elsif ( $passworderror) {
 164                 push @messages, { code => 'ERROR_password_too_short'} if $passworderror eq 'too_short';
 165                 push @messages, { code => 'ERROR_password_too_weak'} if $passworderror eq 'too_weak';
 166                 push @messages, { code => 'ERROR_password_has_whitespaces'} if $passworderror eq 'has_whitespaces';
 167
 168         }
 169         else {
 170             my $patron_data = {
 171                 surname      => scalar $input->param('surname'),
 172                 firstname    => scalar $input->param('firstname'),
 173                 cardnumber   => scalar $input->param('cardnumber'),
 174                 branchcode   => scalar $input->param('libraries'),
 175                 categorycode => scalar $input->param('categorycode_entry'),
 176                 userid       => scalar $input->param('userid'),
 177                 password     => scalar $input->param('password'),
 178                 password2    => scalar $input->param('password2'),
 179                 privacy      => "default",
 180                 address      => "",
 181                 city         => "",
 182                 flags => 1,    # Will be superlibrarian
 183             };
 184
 185             my $patron_category =
 186               Koha::Patron::Categories->find( $patron_data->{categorycode} );
 187             $patron_data->{dateexpiry} =
 188               $patron_category->get_expiry_date( $patron_data->{dateenrolled} );
 189
 190             my $borrowernumber = C4::Members::AddMember(%$patron_data);
 191
 192             #Error handling checking if the patron was created successfully
 193             if ($borrowernumber) {
 194                 push @messages, { code => 'success_on_insert_patron' };
 195             }
 196             else {
 197                 push @messages, { code => 'error_on_insert_patron' };
 198             }
 199         }
 200     }
 201
 202     $step++ if Koha::Patrons->search( { flags => 1 } )->count;
 203 }
 204 if ( $step == 4 ) {
 205     if ( $op eq 'add_validate_itemtype' ) {
 206         my $description   = $input->param('description');
 207         my $itemtype_code = $input->param('itemtype');
 208         $itemtype_code = uc($itemtype_code);
 209
 210         my $itemtype = Koha::ItemType->new(
 211             {
 212                 itemtype    => $itemtype_code,
 213                 description => $description,
 214             }
 215         );
 216         eval { $itemtype->store; };
 217
 218         unless ($@) {
 219             push @messages, { code => 'success_on_insert_itemtype' };
 220         }
 221         else {
 222             push @messages, { code => 'error_on_insert_itemtype' };
 223         }
 224     }
 225
 226     $step++ if Koha::ItemTypes->count;
 227 }
 228 if ( $step == 5 ) {
 229
 230     if ( $op eq 'add_validate_circ_rule' ) {
 231
 232         #If no libraries exist then set the $branch value to *
 233         my $branch = $input->param('branch') || '*';
 234
 235         my $type            = $input->param('type');
 236         my $branchcode      = $input->param('branch');
 237         my $categorycode    = $input->param('categorycode');
 238         my $itemtype        = $input->param('itemtype');
 239         my $maxissueqty     = $input->param('maxissueqty');
 240         my $issuelength     = $input->param('issuelength');
 241         my $lengthunit      = $input->param('lengthunit');
 242         my $renewalsallowed = $input->param('renewalsallowed');
 243         my $renewalperiod   = $input->param('renewalperiod');
 244         my $onshelfholds    = $input->param('onshelfholds') || 0;
 245         $maxissueqty =~ s/\s//g;
 246         $maxissueqty = undef if $maxissueqty !~ /^\d+/;
 247         $issuelength = $issuelength eq q{} ? undef : $issuelength;
 248
 249         my $params = {
 250             branchcode      => $branchcode,
 251             categorycode    => $categorycode,
 252             itemtype        => $itemtype,
 253             maxissueqty     => $maxissueqty,
 254             renewalsallowed => $renewalsallowed,
 255             renewalperiod   => $renewalperiod,
 256             issuelength     => $issuelength,
 257             lengthunit      => $lengthunit,
 258             onshelfholds    => $onshelfholds,
 259         };
 260
 261         my $issuingrule = Koha::IssuingRule->new($params);
 262         eval { $issuingrule->store; };
 263
 264         unless ($@) {
 265             push @messages, { code => 'success_on_insert_circ_rule' };
 266         }
 267         else {
 268             push @messages, { code => 'error_on_insert_circ_rule' };
 269         }
 270     }
 271
 272     $step++ if Koha::IssuingRules->count;
 273 }
 274
 275 my $libraries = Koha::Libraries->search( {}, { order_by => ['branchcode'] }, );
 276 $template_params->{libraries}   = $libraries;
 277 $template_params->{group_types} = [
 278     {
 279         categorytype => 'searchdomain',
 280         categories   => [
 281             Koha::LibraryCategories->search(
 282                 { categorytype => 'searchdomain' }
 283             )
 284         ],
 285     },
 286     {
 287         categorytype => 'properties',
 288         categories   => [
 289             Koha::LibraryCategories->search( { categorytype => 'properties' } )
 290         ],
 291     },
 292 ];
 293
 294 if ( $step > 5 ) {
 295     $template_params->{all_done} = 1;    # If step 5 is complete, we are done!
 296     $step = 5;
 297 }
 298
 299 #Getting the appropriate template to display to the user
 300 my ( $template, $loggedinuser );
 301 ( $template, $loggedinuser, $cookie ) = C4::InstallAuth::get_template_and_user(
 302     {
 303         template_name   => "onboarding/onboardingstep${step}.tt",
 304         query           => $input,
 305         type            => "intranet",
 306         authnotrequired => 0,
 307         debug           => 1,
 308     }
 309 );
 310
 311 $template_params->{messages} = \@messages;
 312 my $categories = Koha::Patron::Categories->search();
 313 $template_params->{categories} = $categories;
 314
 315 my $itemtypes = Koha::ItemTypes->search();
 316 $template_params->{itemtypes} = $itemtypes;
 317
 318 $template->param(%$template_params);
 319
 320 output_html_with_http_headers $input, $cookie, $template->output;