svc/config/systempreferences

   1 #!/usr/bin/perl
   2
   3 # Copyright 2009 Jesse Weaver
   4 #
   5 # This file is part of Koha.
   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
  21 use Modern::Perl;
  22
  23 use C4::Context;
  24 use C4::Service;
  25 use C4::Log;
  26
  27 =head1 NAME
  28
  29 svc/config/systempreferences - Web service for setting system preferences
  30
  31 =head1 SYNOPSIS
  32
  33   POST /svc/config/systempreferences/
  34
  35 =head1 DESCRIPTION
  36
  37 This service is used to set system preferences, either one at a time or in
  38 batches.
  39
  40 =head1 METHODS
  41
  42 =cut
  43
  44 our ( $query, $response ) = C4::Service->init( parameters => 'parameters_remaining_permissions' );
  45
  46 =head2 set_preference
  47
  48 =over 4
  49
  50 POST /svc/config/systempreferences/$preference
  51
  52 value=$value
  53
  54 =back
  55
  56 Used to set a single system preference.
  57
  58 =cut
  59
  60 sub set_preference {
  61     my ( $preference ) = @_;
  62
  63     unless ( C4::Context->config('demo') ) {
  64         my $value = join( ',', $query->param( 'value' ) );
  65         C4::Context->set_preference( $preference, $value );
  66     }
  67
  68     C4::Service->return_success( $response );
  69 }
  70
  71 =head2 set_preferences
  72
  73 =over 4
  74
  75 POST /svc/config/systempreferences/
  76
  77 pref_$pref1=$value1&pref_$pref2=$value2
  78
  79 =back
  80
  81 Used to set several system preferences at once. Each preference you want to set
  82 should be sent prefixed with pref. If you wanted to turn off the
  83 virtualshelves syspref, for instance, you would POST the following:
  84
  85 pref_virtualshelves=0
  86
  87 =cut
  88
  89 sub set_preferences {
  90     unless ( C4::Context->config( 'demo' ) ) {
  91         foreach my $param ( $query->param() ) {
  92             my ( $pref ) = ( $param =~ /pref_(.*)/ );
  93
  94             next if ( !defined( $pref ) );
  95
  96             my $value = join( ',', $query->multi_param( $param ) );
  97
  98             C4::Context->set_preference( $pref, $value );
  99         }
 100     }
 101
 102     C4::Service->return_success( $response );
 103 }
 104
 105 C4::Service->dispatch(
 106     [ 'POST /([A-Za-z0-9_-]+)', [ 'value' ], \&set_preference ],
 107     [ 'POST /', [], \&set_preferences ],
 108 );