1 # Copyright 2002 Katipo Communications
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along with
15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
16 # Suite 330, Boston, MA 02111-1307 USA
24 use vars qw($VERSION $AUTOLOAD),
28 $VERSION = do { my @v = '$Revision$' =~ /\d+/g;
29 shift(@v) . "." . join("_", map {sprintf "%03d", $_ } @v); };
33 C4::Context - Maintain and manipulate the context of a Koha script
39 use C4::Context("/path/to/koha.xml");
41 $config_value = C4::Context->config("config_variable");
42 $db_handle = C4::Context->dbh;
43 $stopwordhash = C4::Context->stopwords;
47 When a Koha script runs, it makes use of a certain number of things:
48 configuration settings in F</etc/koha.xml>, a connection to the Koha
49 databases, and so forth. These things make up the I<context> in which
52 This module takes care of setting up the context for a script:
53 figuring out which configuration file to load, and loading it, opening
54 a connection to the right database, and so forth.
56 Most scripts will only use one context. They can simply have
62 Other scripts may need to use several contexts. For instance, if a
63 library has two databases, one for a certain collection, and the other
64 for everything else, it might be necessary for a script to use two
65 different contexts to search both databases. Such scripts should use
66 the C<&set_context> and C<&restore_context> functions, below.
68 By default, C4::Context reads the configuration from
69 F</etc/koha.xml>. This may be overridden by setting the C<$KOHA_CONF>
70 environment variable to the pathname of a configuration file to use.
79 # In addition to what is said in the POD above, a Context object is a
80 # reference-to-hash with the following fields:
83 # A reference-to-hash whose keys and values are the
84 # configuration variables and values specified in the config
85 # file (/etc/koha.xml).
87 # A handle to the appropriate database for this context.
89 # Used by &set_dbh and &restore_dbh to hold other database
90 # handles for this context.
92 # A connection object for the Zebra server
94 use constant CONFIG_FNAME => "/etc/koha.xml";
95 # Default config file, if none is specified
97 $context = undef; # Initially, no context is set
98 @context_stack = (); # Initially, no saved contexts
101 # Reads the specified Koha config file. Returns a reference-to-hash
102 # whose keys are the configuration variables, and whose values are the
103 # configuration values (duh).
104 # Returns undef in case of error.
107 # 2004-08-10 A. Tarallo: Added code that checks if a variable is already
108 # assigned and prints a message, otherwise create a new entry in the hash to
110 # Also added code that complaints if finds a line that isn't a variable
111 # assignmet and skips the line.
112 # Added a quick hack that makes the translation between the db_schema
113 # and the DBI driver for that schema.
117 my $fname = shift; # Config file to read
119 my $retval = {}; # Return value: ref-to-hash holding the
122 my $koha = XMLin($fname, keyattr => ['id'],forcearray => ['listen']);
128 # Translates the full text name of a database into de appropiate dbi name
135 # FIXME - Should have other databases.
136 if (/mysql/i) { return("mysql"); }
137 if (/Postgres|Pg|PostgresSQL/) { return("Pg"); }
138 if (/oracle/i) { return("Oracle"); }
140 return undef; # Just in case
146 my $conf_fname = shift; # Config file name
149 # Create a new context from the given config file name, if
150 # any, then set it as the current context.
151 $context = new C4::Context($conf_fname);
152 return undef if !defined($context);
153 $context->set_context;
158 $context = new C4::Context;
159 $context = new C4::Context("/path/to/koha.xml");
161 Allocates a new context. Initializes the context from the specified
162 file, which defaults to either the file given by the C<$KOHA_CONF>
163 environment variable, or F</etc/koha.xml>.
165 C<&new> does not set this context as the new default context; for
166 that, use C<&set_context>.
172 # 2004-08-10 A. Tarallo: Added check if the conf file is not empty
176 my $conf_fname = shift; # Config file to load
179 # check that the specified config file exists and is not empty
180 undef $conf_fname unless
181 (defined $conf_fname && -e $conf_fname && -s $conf_fname);
182 # Figure out a good config file to load if none was specified.
183 if (!defined($conf_fname))
185 # If the $KOHA_CONF environment variable is set, use
186 # that. Otherwise, use the built-in default.
187 $conf_fname = $ENV{"KOHA_CONF"} || CONFIG_FNAME;
189 # Load the desired config file.
190 $self = read_config_file($conf_fname);
191 $self->{"config_file"} = $conf_fname;
195 warn "read_config_file($conf_fname) returned undef" if !defined($self->{"config"});
196 return undef if !defined($self->{"config"});
198 $self->{"dbh"} = undef; # Database handle
199 $self->{"Zconn"} = undef; # Zebra Connection
200 $self->{"Zconnauth"} = undef; # Zebra Connection for updating
201 $self->{"stopwords"} = undef; # stopwords list
202 $self->{"marcfromkohafield"} = undef; # the hash with relations between koha table fields and MARC field/subfield
203 $self->{"attrfromkohafield"} = undef; # the hash with relations between koha table fields and Bib1-attributes
204 $self->{"userenv"} = undef; # User env
205 $self->{"activeuser"} = undef; # current active user
213 $context = new C4::Context;
214 $context->set_context();
216 set_context C4::Context $context;
219 restore_context C4::Context;
221 In some cases, it might be necessary for a script to use multiple
222 contexts. C<&set_context> saves the current context on a stack, then
223 sets the context to C<$context>, which will be used in future
224 operations. To restore the previous context, use C<&restore_context>.
232 my $new_context; # The context to set
234 # Figure out whether this is a class or instance method call.
236 # We're going to make the assumption that control got here
237 # through valid means, i.e., that the caller used an instance
238 # or class method call, and that control got here through the
239 # usual inheritance mechanisms. The caller can, of course,
240 # break this assumption by playing silly buggers, but that's
241 # harder to do than doing it properly, and harder to check
243 if (ref($self) eq "")
245 # Class method. The new context is the next argument.
246 $new_context = shift;
248 # Instance method. The new context is $self.
249 $new_context = $self;
252 # Save the old context, if any, on the stack
253 push @context_stack, $context if defined($context);
255 # Set the new context
256 $context = $new_context;
259 =item restore_context
263 Restores the context set by C<&set_context>.
272 if ($#context_stack < 0)
275 die "Context stack underflow";
278 # Pop the old context and set it.
279 $context = pop @context_stack;
281 # FIXME - Should this return something, like maybe the context
282 # that was current when this was called?
287 $value = C4::Context->config("config_variable");
289 $value = C4::Context->config_variable;
291 Returns the value of a variable specified in the configuration file
292 from which the current context was created.
294 The second form is more compact, but of course may conflict with
295 method names. If there is a configuration variable called "new", then
296 C<C4::Config-E<gt>new> will not return it.
304 my $var = shift; # The config variable to return
306 return undef if !defined($context->{"config"});
307 # Presumably $self->{config} might be
308 # undefined if the config file given to &new
309 # didn't exist, and the caller didn't bother
310 # to check the return value.
312 # Return the value of the requested config variable
313 return $context->{"config"}->{$var};
316 $serverdir=C4::Context->zebraconfig("biblioserver")->{directory};
318 returns the zebra server specific details for different zebra servers
319 similar to C4:Context->config
325 my $var = shift; # The config variable to return
327 return undef if !defined($context->{"server"});
328 # Return the value of the requested config variable
329 return $context->{"server"}->{$var};
333 $sys_preference = C4::Context->preference("some_variable");
335 Looks up the value of the given system preference in the
336 systempreferences table of the Koha database, and returns it. If the
337 variable is not set, or in case of error, returns the undefined value.
342 # FIXME - The preferences aren't likely to change over the lifetime of
343 # the script (and things might break if they did change), so perhaps
344 # this function should cache the results it finds.
348 my $var = shift; # The system preference to return
349 my $retval; # Return value
350 my $dbh = C4::Context->dbh; # Database handle
351 my $sth; # Database query handle
353 # Look up systempreferences.variable==$var
354 $retval = $dbh->selectrow_array(<<EOT);
356 FROM systempreferences
357 WHERE variable='$var'
363 sub boolean_preference ($) {
365 my $var = shift; # The system preference to return
366 my $it = preference($self, $var);
367 return defined($it)? C4::Boolean::true_p($it): undef;
371 # This implements C4::Config->foo, and simply returns
372 # C4::Context->config("foo"), as described in the documentation for
375 # FIXME - Perhaps this should be extended to check &config first, and
376 # then &preference if that fails. OTOH, AUTOLOAD could lead to crappy
377 # code, so it'd probably be best to delete it altogether so as not to
378 # encourage people to use it.
383 $AUTOLOAD =~ s/.*:://; # Chop off the package name,
384 # leaving only the function name.
385 return $self->config($AUTOLOAD);
390 $Zconn = C4::Context->Zconn
391 $Zconnauth = C4::Context->Zconnauth
392 Returns a connection to the Zebra database for the current
393 context. If no connection has yet been made, this method
394 creates one and connects.
403 $context->{"Zconn"} = &new_Zconn($server,$syntax);
404 return $context->{"Zconn"};
413 ##We destroy each connection made so create a new one
414 $context->{"Zconnauth"} = &new_Zconnauth($server,$syntax);
415 return $context->{"Zconnauth"};
423 Internal helper function. creates a new database connection from
424 the data given in the current context and returns it.
432 $syntax="xml" unless $syntax;
434 my ($tcp,$host,$port)=split /:/,$context->{"listen"}->{$server}->{"content"};
435 my $o = new ZOOM::Options();
436 $o->option(async => 1);
437 $o->option(preferredRecordSyntax => $syntax); ## Authorities use marc while biblioserver is xml
438 $o->option(databaseName=>$context->{"config"}->{$server});
439 #$o->option(proxy=>$context->{"config"}->{"proxy"});## if proxyserver provided will route searches to proxy
440 my $o2= new ZOOM::Options();
442 $Zconn=create ZOOM::Connection($o);
443 $Zconn->connect($context->{"config"}->{"hostname"},$port);
448 ## Zebra handler with write permission
453 $syntax="xml" unless $syntax;
455 my ($tcp,$host,$port)=split /:/,$context->{"listen"}->{$server}->{"content"};
456 my $o = new ZOOM::Options();
457 #$o->option(async => 1);
458 $o->option(preferredRecordSyntax => $syntax);
459 $o->option(user=>$context->{"config"}->{"zebrauser"});
460 $o->option(password=>$context->{"config"}->{"zebrapass"});
461 $o->option(databaseName=>$context->{"config"}->{$server});
462 $o->option(charset=>"UTF8");
463 $Zconnauth=create ZOOM::Connection($o);
464 $Zconnauth->connect($context->config("hostname"),$port);
470 # Internal helper function (not a method!). This creates a new
471 # database connection from the data given in the current context, and
475 ##correct name for db_schme
477 if ($context->config("db_scheme")){
478 $db_driver=db_scheme2dbi($context->config("db_scheme"));
483 my $db_name = $context->config("database");
484 my $db_host = $context->config("hostname");
485 my $db_user = $context->config("user");
486 my $db_passwd = $context->config("pass");
487 my $dbh= DBI->connect("DBI:$db_driver:$db_name:$db_host",
488 $db_user, $db_passwd);
489 # Koha 3.0 is utf-8, so force utf8 communication between mySQL and koha, whatever the mysql default config.
490 # this is better than modifying my.cnf (and forcing all communications to be in utf8)
491 $dbh->do("set NAMES 'utf8'");
497 $dbh = C4::Context->dbh;
499 Returns a database handle connected to the Koha database for the
500 current context. If no connection has yet been made, this method
501 creates one, and connects to the database.
503 This database handle is cached for future use: if you call
504 C<C4::Context-E<gt>dbh> twice, you will get the same handle both
505 times. If you need a second database handle, use C<&new_dbh> and
506 possibly C<&set_dbh>.
516 if (defined($context->{"dbh"})) {
517 $sth=$context->{"dbh"}->prepare("select 1");
518 return $context->{"dbh"} if (defined($sth->execute));
521 # No database handle or it died . Create one.
522 $context->{"dbh"} = &_new_dbh();
524 return $context->{"dbh"};
529 $dbh = C4::Context->new_dbh;
531 Creates a new connection to the Koha database for the current context,
532 and returns the database handle (a C<DBI::db> object).
534 The handle is not saved anywhere: this method is strictly a
535 convenience function; the point is that it knows which database to
536 connect to so that the caller doesn't have to know.
550 $my_dbh = C4::Connect->new_dbh;
551 C4::Connect->set_dbh($my_dbh);
553 C4::Connect->restore_dbh;
555 C<&set_dbh> and C<&restore_dbh> work in a manner analogous to
556 C<&set_context> and C<&restore_context>.
558 C<&set_dbh> saves the current database handle on a stack, then sets
559 the current database handle to C<$my_dbh>.
561 C<$my_dbh> is assumed to be a good database handle.
571 # Save the current database handle on the handle stack.
572 # We assume that $new_dbh is all good: if the caller wants to
573 # screw himself by passing an invalid handle, that's fine by
575 push @{$context->{"dbh_stack"}}, $context->{"dbh"};
576 $context->{"dbh"} = $new_dbh;
581 C4::Context->restore_dbh;
583 Restores the database handle saved by an earlier call to
584 C<C4::Context-E<gt>set_dbh>.
593 if ($#{$context->{"dbh_stack"}} < 0)
596 die "DBH stack underflow";
599 # Pop the old database handle and set it.
600 $context->{"dbh"} = pop @{$context->{"dbh_stack"}};
602 # FIXME - If it is determined that restore_context should
603 # return something, then this function should, too.
606 =item marcfromkohafield
608 $dbh = C4::Context->marcfromkohafield;
610 Returns a hash with marcfromkohafield.
612 This hash is cached for future use: if you call
613 C<C4::Context-E<gt>marcfromkohafield> twice, you will get the same hash without real DB access
618 sub marcfromkohafield
622 # If the hash already exists, return it.
623 return $context->{"marcfromkohafield"} if defined($context->{"marcfromkohafield"});
625 # No hash. Create one.
626 $context->{"marcfromkohafield"} = &_new_marcfromkohafield();
628 return $context->{"marcfromkohafield"};
632 # _new_marcfromkohafield
633 # Internal helper function (not a method!).
634 sub _new_marcfromkohafield
636 my $dbh = C4::Context->dbh;
637 my $marcfromkohafield;
638 my $sth = $dbh->prepare("select marctokoha,tagfield,tagsubfield,recordtype from koha_attr where tagfield is not null ");
640 while (my ($kohafield,$tagfield,$tagsubfield,$recordtype) = $sth->fetchrow) {
642 $marcfromkohafield->{$recordtype}->{$kohafield} = [$tagfield,$tagsubfield];
645 return $marcfromkohafield;
649 #item attrfromkohafield
650 #To use as a hash of koha to z3950 attributes
651 sub _new_attrfromkohafield
653 my $dbh = C4::Context->dbh;
654 my $attrfromkohafield;
655 my $sth2 = $dbh->prepare("select marctokoha,attr from koha_attr" );
657 while (my ($marctokoha,$attr) = $sth2->fetchrow) {
659 $attrfromkohafield->{$marctokoha} = $attr;
661 return $attrfromkohafield;
663 sub attrfromkohafield
667 # If the hash already exists, return it.
668 return $context->{"attrfromkohafield"} if defined($context->{"attrfromkohafield"});
670 # No hash. Create one.
671 $context->{"attrfromkohafield"} = &_new_attrfromkohafield();
673 return $context->{"attrfromkohafield"};
677 $dbh = C4::Context->stopwords;
679 Returns a hash with stopwords.
681 This hash is cached for future use: if you call
682 C<C4::Context-E<gt>stopwords> twice, you will get the same hash without real DB access
691 # If the hash already exists, return it.
692 return $context->{"stopwords"} if defined($context->{"stopwords"});
694 # No hash. Create one.
695 $context->{"stopwords"} = &_new_stopwords();
697 return $context->{"stopwords"};
701 # Internal helper function (not a method!). This creates a new
702 # hash with stopwords
705 my $dbh = C4::Context->dbh;
707 my $sth = $dbh->prepare("select word from stopwords");
709 while (my $stopword = $sth->fetchrow_array) {
711 $stopwordlist->{$stopword} = uc($stopword);
713 $stopwordlist->{A} = "A" unless $stopwordlist;
714 return $stopwordlist;
719 C4::Context->userenv;
721 Builds a hash for user environment variables.
723 This hash shall be cached for future use: if you call
724 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
726 set_userenv is called in Auth.pm
733 my $var = $context->{"activeuser"};
734 return $context->{"userenv"}->{$var} if (defined $context->{"userenv"}->{$var});
736 warn "NO CONTEXT for $var";
741 C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $userflags, $emailaddress);
743 Informs a hash for user environment variables.
745 This hash shall be cached for future use: if you call
746 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
748 set_userenv is called in Auth.pm
753 my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress,$branchprinter)= @_;
754 my $var=$context->{"activeuser"};
756 "number" => $usernum,
758 "cardnumber" => $usercnum,
759 # "firstname" => $userfirstname,
760 # "surname" => $usersurname,
761 #possibly a law problem
762 "branch" => $userbranch,
763 "branchname" => $branchname,
764 "flags" => $userflags,
765 "emailaddress" => $emailaddress,
766 "branchprinter" => $branchprinter,
768 $context->{userenv}->{$var} = $cell;
774 C4::Context->_new_userenv($session);
776 Builds a hash for user environment variables.
778 This hash shall be cached for future use: if you call
779 C<C4::Context-E<gt>userenv> twice, you will get the same hash without real DB access
781 _new_userenv is called in Auth.pm
790 $context->{"activeuser"}=$sessionID;
795 C4::Context->_unset_userenv;
797 Destroys the hash for activeuser user environment variables.
805 undef $context->{"activeuser"} if ($context->{"activeuser"} eq $sessionID);
821 Specifies the configuration file to read.
831 Andrew Arensburger <arensb at ooblick dot com>
835 # Revision 1.45 2006/09/01 15:33:47 tgarip1957
836 # No more MARC Records - everything is MARC XML
837 # we read - write only XML
839 # Revision 1.43 2006/08/10 12:49:37 toins
840 # sync with dev_week.
842 # Revision 1.42 2006/07/04 14:36:51 toins
843 # Head & rel_2_2 merged
845 # Revision 1.41 2006/05/20 14:36:09 tgarip1957
846 # Typo error. Missing '>'
848 # Revision 1.40 2006/05/20 14:28:02 tgarip1957
849 # Adding support to read zebra database name from config files
851 # Revision 1.39 2006/05/19 09:52:54 alaurin
852 # committing new feature ip and printer management
853 # adding two fields in branches table (branchip,branchprinter)
855 # branchip : if the library enter an ip or ip range any librarian that connect from computer in this ip range will be temporarly affected to the corresponding branch .
857 # branchprinter : the library can select a default printer for a branch
859 # Revision 1.38 2006/05/14 00:22:31 tgarip1957
860 # Adding support for getting details of different zebra servers
862 # Revision 1.37 2006/05/13 19:51:39 tgarip1957
863 # Now reads koha.xml rather than koha.conf.
864 # koha.xml contains both the koha configuration and zebraserver configuration.
865 # Zebra connection is modified to allow connection to authority zebra as well.
866 # It will break head if koha.conf is not replaced with koha.xml
868 # Revision 1.36 2006/05/09 13:28:08 tipaul
869 # adding the branchname and the librarian name in every page :
870 # - modified userenv to add branchname
871 # - modifier menus.inc to have the librarian name & userenv displayed on every page. they are in a librarian_information div.
873 # Revision 1.35 2006/04/13 08:40:11 plg
874 # bug fixed: typo on Zconnauth name
876 # Revision 1.34 2006/04/10 21:40:23 tgarip1957
877 # A new handler defined for zebra Zconnauth with read/write permission. Zconnauth should only be called in biblio.pm where write operations are. Use of this handler will break things unless koha.conf contains new variables:
879 # zebraport=<your port>
880 # zebrauser=<username>
881 # zebrapass=<password>
883 # The zebra.cfg file should read:
886 # passw.c:<yourpasswordfile>
888 # Password file should be prepared with Apaches htpasswd utility in encrypted mode and should exist in a folder zebra.cfg can read
890 # Revision 1.33 2006/03/15 11:21:56 plg
891 # bug fixed: utf-8 data where not displayed correctly in screens. Supposing
892 # your data are truely utf-8 encoded in your database, they should be
893 # correctly displayed. "set names 'UTF8'" on mysql connection (C4/Context.pm)
894 # is mandatory and "binmode" to utf8 (C4/Interface/CGI/Output.pm) seemed to
895 # converted data twice, so it was removed.
897 # Revision 1.32 2006/03/03 17:25:01 hdl
898 # Bug fixing : a line missed a comment sign.
900 # Revision 1.31 2006/03/03 16:45:36 kados
901 # Remove the search that tests the Zconn -- warning, still no fault
904 # Revision 1.30 2006/02/22 00:56:59 kados
905 # First go at a connection object for Zebra. You can now get a
906 # connection object by doing:
908 # my $Zconn = C4::Context->Zconn;
910 # My initial tests indicate that as soon as your funcion ends
911 # (ie, when you're done doing something) the connection will be
912 # closed automatically. There may be some other way to make the
913 # connection more stateful, I'm not sure...