Config::IniFile::Import - Import von MS-Windows-Format-Ini-Dateien auf Variablen
Dieses Dokument beschreibt die Version 1.100 des Moduls Config::IniFiles::Import vom 27.08.2003
use Config::IniFiles::Import; ... $INI = Config::IniFiles::Import -> new( -option => value [ ... ] ); ... $INI -> Import( -loadsection => [ qw( section1 section2 ... ) ], -loadvariable => [ qw( section3::param1+param2 section4::param1 ... ) ], -protocol => filehandle , -exportto => 'Package' );
Die Definitionen von INI-Dateien werden mittels des Moduls 'Config::IniFiles' gelesen, und mit dem vorliegenden Modul auf korrespondierende Variablen importiert.
Dabei werden die Variablen-Namen wie folgt gebildet:
- Der Sektions-Name wird mit dem Parameter-Namen, getrennt durch Unterstrich verbunden und dem Package 'INI' ( Standardfall ) zugeordnet. - Es besteht aber auch die Moeglichkeit den Package-Namen frei zu waehlen.
Aus diesem Grunde gelten fuer die Sektions- und Parameter-Namen folgende Einschraenkungen:
- Die Bezeichner duerfen nur aus gueltigen Wortzeichen bestehen ( a-z, A-Z, 0-9, _ ) - Die Gross-/Kleinschreibung wird beachtet und fuehrt zu verschiedenen Variablennamen
Die INI-Dateien koennen durch die Verwendung von Substitutionen flexible gehalten werden. Fuer die Substitution ist folgende Syntax anzuwenden:
Parameter = ...{Sektion::Parameter}...
[SEKTION_1] Wert1 = bla Wert2 = foo{SEKTION_1::Wert1}foo Das ergibt fuer Wert2 den Wert 'fooblafoo'.
Es ist moeglich aus den INI-Dateien heraus auf Environment-Variable zuzugreifen. Diese werden wie folgt angesprochen:
Parameter = ...{ENV::Variable}...
Hieraus ergibt sich die Einschraenkung, dass Sektionen nicht mit 'ENV' benannt werden duerfen!!!
Es existiert z.B. die Environment-Variable 'HOME' mit dem Wert '/home/mein_verzeichnis' und dieser Wert soll dem Eintrag 'HomeDir' zugewiesen werden: HomeDir = {ENV::HOME}
Fuer die Substitution steht ein Satz von prefinierten Variablen zur Verfuegung, die wie folgt angesprochen werden koennen:
Parameter = ...{Variable}...
Folgende 'predefinierte Variablen' sind definiert:
Enthaelt den Pfad zum aktuellen Perl-Skript.
Enthaelt den Namen des User's, der das aktuelle Skript gestarten hat. ( Wird aus der Umgebungs-Variablen 'ENV{USER}' gewonnen )
Enthaelt die Uhrzeit des Programmstarts in der Form 'HH:MM'
Enthaelt die Uhrzeit des Programmstarts in der Form 'HH:MM:SS'
Enthaelt das Datum des Programmstarts in der Form 'TT.MM.JJJJ'
Enthaelt das Datum des Programmstarts in der Form 'TT.MMM.JJJJ'
Enthaelt das Datum und die Uhrzeit des Programmstarts in der Form 'TT.MM.JJJJ - HH:MM'
[SEKTION_2] Wert3 = {FindBin} Das ergibt fuer Wert3 den Pfad zum aktuellen Perl-Skript.
Durch die Option '-predef' ist es moeglich, dem Klassenkonstruktor eigene 'predefinierte Variable' zu uebergeben, oder die bestehenden zu ueberschreiben.
$INI = Config::IniFiles::Import -> new( -language => language, -predef => ... ... => ... );
Syntax: '-language' => language
Dieser Parameter beeinflusst die Schreibweise des Monatsnamens der predefinierten Variablen 'DateLong' ( Standardwert ist 'German' ).
language : Alle vom Modul 'Date::Language' unterstuetzen Sprachen.
Syntax 1: '-predef' = [ 'DateTime', key, template, language ]
Erstellt Datum- / Zeit-Variable mit dem Namen 'key', der Formatierung 'template' in der Sprache 'language' mittels des Moduls Date::Language.
template : Alle vom Modul 'Date::Language' unterstuetzen Formatierungen.
Syntax 2: '-predef' = [ 'UserValue', key, value ]
Erstellt eine frei definierbare 'predefinierte Variable' mit dem Namen 'key' und Wert 'value'.
Alle weiteren hier uebergebenen Parameterpaare ( Option / Wert ) werden an das Modul 'Config::IniFiles' weitergereicht. Die Beschreibung der Parameter ist dessen Dokumentation zu entnehmen. Nachfolgend werden jedoch die moeglichen Parameter aufgefuehrt.
$INI -> Import( -loadsection => [ qw( section1 section2 ... ) ], -loadvariable => [ qw( section3::param1+param2 section4::param1 ... ) ], -protocol => filehandle , -exportto => 'Package' );
Diese Methode liest die INI-Datei(en) ein und importiert die Daten auf Variable. Die Definition der Variablen erfolgt in dieser Methode als globale Variable ( use vars qw( ... ) ). Damit koennen Programme die dieses Modul anwenden, weiterhin mit dem Pragma 'use strict' arbeiten.
Syntax: '-loadsection' => [ qw( section1 section2 ... ) ]
Wird diese Option uebergeben, so werden nur die benannten Sektionen importiert. Andernfalls erfolgt der Import aller Sektionen.
Syntax: '-loadvariable' => [ qw( section1::par1+par2 section2::par ... ) ]
Wird diese Option uebergeben, so werden nur die benannten Variablen der jeweiligen Sektion importiert.
Syntax: '-protocol' => filehandle
Wird diese Option uebergeben, so wird der Import der Variablen in der durch den 'filehandle' uebergebenen Datei protokolliert.
Syntax: '-exportto' => 'Package'
Standardmaessig werden die Variablen in dem Package 'INI' abgelegt. Dies kann mit dieser Option beim Aufruf der Methode geaendert werden.
Die Optionen '-loadsection' und '-loadvariable' koennen kombiniert werden.
Das nachfolgende Beispiel liest die INI-Dateien 'Ini1.ini' und 'Ini2.ini' aus dem aktuellen Verzeichnis ein. Es werden die Angaben der Sektionen 'GLOBAL' und 'VERZEICHNISSE' sowie die Parameter 'Name' und 'TempDir' der Sektion 'USER' auf die entsprechenden Variablen des Package 'Cfg' des Programms importiert. Weitere eventuell vorhandene Sektionen und Variablen werden ignoriert.
Die importierten Variablen werden in der Datei 'Load.prt' im aktuellen Verzeichnis protokolliert.
[GLOBAL] Script = {FindBin} [USER] Name = {UserName} TmpDir = C:\Tmp TempDir = C:\Temp\{UserName} [VAR] Datum = {Datum} Ort = {City}
[VERZEICHNISSE] Daten = {USER::TempDir}\Daten Protokolle = {USER::TempDir}\Protokoll [UPDATE] Programme = D:\Update\Prg Dokumentation = D:\Update\Doc
#!/usr/bin/perl ############################################################################### # use Config::IniFiles::Import; use File::Spec; # $FH = FileHandle -> new( File::Spec -> catfile( qw( . Load.prt ) ), 'w' ); # print $FH "Test des Moduls : Config::IniFiles::Import\n"; print $FH '-' x 100 . "\n\n"; # $INI = Config::IniFiles::Import -> new( -predef => [ 'DateTime' , 'Datum', '%B.%Y', 'German' ], -predef => [ qw( UserValue City Berlin ) ], -file => File::Spec->catfile( qw( . Ini1.ini ) ), -import => Config::IniFiles -> new( -file => File::Spec->catfile( qw( . Ini2.ini ) ) ) ); # $INI -> Import( -loadsection => [ qw( GLOBAL VERZEICHNISSE ) ], -loadvariable => [ qw( USER::Name+TempDir VAR::Datum+Ort ) ], -protocol => $FH , -exportto => 'Cfg' ); # print "$Cfg::USER_Name\n"; # print = Name des Users print "$Cfg::VAR_Datum\n"; # print = Monatsname.Jahr in deutsch print "$Cfg::VAR_Ort\n"; # print = Berlin # ###############################################################################
Bei einer Substitution wird auf eine nicht definierte Kombination aus Sektion und Schluessel zugegriffen, oder es wird eine nicht existente predifinierte Variable angesprochen.
Das Skript wird mit dieser Fehlermeldung abgebrochen!
Die Angegeben Variable konnte nicht erzeugt werden.
Die Definition einer privaten 'predefinierten Variablen' ist falsch.
strict
vars
Carp
FindBin
Config::IniFiles Version : 2.29 ( oder neuer )
Date::Language ( TimeDate )
Bei dem Einsatz unter Windoofs ist folgender Patch in dem Modul 'Config::IniFiles' vorzunehmen:
- Im Unterprogramm 'ReadConfig' ist folgende Anweisung zu aendern: - von: 'while($self->{allowcontinue} && $val =~ s/\\$//) {' - in : 'while($self->{allowcontinue} && $val =~ s/\s\\$//) {'
0.100 - 22.09.2002 - JvB
Erste Test- und Entwicklungsversion
0.200 - 22.09.2002 - JvB
Mit der Option '-loadsection', der Import-Methode, ist es moeglich ausgewaehlte Sektione zu importieren.
0.210 - 23.09.2002 - JvB
Ueberarbeitung der Dokumentation und Straffung des Codes
0.300 - 23.09.2002 - JvB
Mit der Option '-protocol' besteht die Moeglichkeit den Variablenimport zu Protokollieren.
0.301 - 24.09.2002 - JvB
Fehlerkorrektur: - Wurde die Option '-loadsection' nicht angegeben, wurden der Variablenimport nicht durchgefuehrt.
0.400 - 14.05.2003 - JvB
Veraenderung des Importes der INI-Daten. - Die Namen der Variablen werden nach einem neuen Verfahren gebildet. - Das Package, in das der Import der Variablen erfolgt ist waehlbar.
0.500 - 14.05.2003 - JvB
Erweiterung fuer die Verarbeitung predefinierter Variablen. - FindBin, UserName
0.600 - 15.05.2003 - JvB
Erweiterung fuer den Import einzelner Parameter einer Sektion. - Mit der Option '-loadvariable' koennen nur einzelne Parameter einer Sektion uebernommen werden.
0.700 - 15.05.2003 - JvB
Weitere predefinierte Variable hinzugefuegt. - TimeShort, TimeLong, DateShort, DateLong, DateTime Veraenderung des optionalen Protokolldrucks.
0.701 - 13.06.2003 - JvB
- Korrektur der Dokumentation
0.800 - 13.06.2003 - JvB
- Erweiterung fuer frei definierbare 'predefinierte Variable'
0.900 - 18.06.2003 - JvB
- Erweiterung fuer mehrere Substitutionen in einer Zeile - Verbesserung der Dokumentation - Dokumentation ( POD ) ist eine eigenstaendige Datei
0.901 - 19.06.2003 - JvB
- Ueberarbeitung der Dokumentation
0.902 - 19.06.2003 - JvB
Fehlerkorrektur: - Bei verschachtelten Substitutionen traten teilweise Abbrueche auf.
1.000 - 20.06.2003 - JvB
- Beispiel verbessert
1.100 - 27.08.2003 - JvB
Erweiterung fuer den Zugriff auf Environment-Variable
JvB - Juergen von Brietzke - juergen.von.brietzke@t-online.de
Copyright (c) 2002, 2003 by JvB.
Dieses Modul ist freie Software. Die Benutzung und / oder Veraenderung unterliegt der selben Lizenz wie Perl.
6 POD Errors
The following errors were encountered while parsing the POD:
'=item' outside of any '=over'
You forgot a '=back' before '=head2'
To install Config::IniFiles::Import, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Config::IniFiles::Import
CPAN shell
perl -MCPAN -e shell install Config::IniFiles::Import
For more information on module installation, please visit the detailed CPAN module installation guide.