/usr/share/perl5/Config/Simple.pm is in libconfig-simple-perl 4.59-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 | package Config::Simple;
# $Id: Simple.pm,v 3.57 2006/09/12 19:15:04 sherzodr Exp $
use strict;
# uncomment the following line while debugging. Otherwise,
# it's too slow for production environment
#use diagnostics;
use Carp;
use Fcntl qw(:DEFAULT :flock);
use Text::ParseWords 'parse_line';
use vars qw($VERSION $DEFAULTNS $LC $USEQQ $errstr);
use AutoLoader 'AUTOLOAD';
$VERSION = '4.59';
$DEFAULTNS = 'default';
sub import {
my $class = shift;
for ( @_ ) {
if ( $_ eq '-lc' ) { $LC = 1; next; }
if ( $_ eq '-strict' ) { $USEQQ = 1; next; }
}
}
# delimiter used by Text::ParseWords::parse_line()
sub READ_DELIM () { return '\s*,\s*' }
# delimiter used by as_string()
sub WRITE_DELIM() { return ', ' }
sub DEBUG () { 0 }
sub new {
my $class = shift;
$class = ref($class) || $class;
my $self = {
_FILE_HANDLE => undef, # holds a reference to an opened cfg file
_FILE_NAME => undef, # holds the name of the read configuration file
_STACK => [], # currently not implemented
_DATA => {}, # actual key/value pairs are stored in _DATA
_SYNTAX => undef, # holds the syntax of the read cfg file
_SUB_SYNTAX => undef, # holds the sub-syntax (like for simplified ini)
_ARGS => {}, # holds all key/values passed to new()
_OO_INTERFACE => 1, # currently not implemented
_IS_MODIFIED => 0, # to prevent writing file back if they were not modified
};
bless ($self, $class);
$self->_init(@_) or return;
return $self;
}
sub DESTROY {
my $self = shift;
# if it was an auto save mode, write the changes
# back only if the values have been modified.
if ( $self->autosave() && $self->_is_modified() ) {
$self->write();
}
}
# initialize the object
sub _init {
my $self = shift;
if ( @_ == 1 ) {
return $self->read($_[0]);
} elsif ( @_ % 2 ) {
croak "new(): Illegal arguments detected";
} else {
$self->{_ARGS} = { @_ };
}
# if syntax was given, call syntax()
if ( exists $self->{_ARGS}->{syntax} ) {
$self->syntax($self->{_ARGS}->{syntax});
}
# if autosave was set, call autosave
if ( exists $self->{_ARGS}->{autosave} ) {
$self->autosave($self->{_ARGS}->{autosave});
}
# If filename was passed, call read()
if ( exists ($self->{_ARGS}->{filename}) ) {
return $self->read( $self->{_ARGS}->{filename} );
}
return 1;
}
sub _is_modified {
my ($self, $bool) = @_;
if ( defined $bool ) {
$self->{_IS_MODIFIED} = $bool;
}
return $self->{_IS_MODIFIED};
}
sub autosave {
my ($self, $bool) = @_;
if ( defined $bool ) {
$self->{_ARGS}->{autosave} = $bool;
}
return $self->{_ARGS}->{autosave};
}
sub syntax {
my ($self, $syntax) = @_;
if ( defined $syntax ) {
$self->{_SYNTAX} = $syntax;
}
return $self->{_SYNTAX};
}
# takes a filename or a file handle and returns a filehandle
sub _get_fh {
my ($self, $arg, $mode) = @_;
unless ( defined $arg ) {
croak "_get_fh(): filename is missing";
}
if ( ref($arg) && (ref($arg) eq 'GLOB') ) {
return ($arg, 0);
}
unless ( defined $mode ) {
$mode = O_RDONLY;
}
unless ( sysopen(FH, $arg, $mode) ) {
$self->error("couldn't open $arg: $!");
return undef;
}
return (\*FH, 1);
}
sub read {
my ($self, $file) = @_;
# making sure one object doesn't work on more than one
# file at a time
if ( defined $self->{_FILE_HANDLE} ) {
croak "Open file handle detected. If you're trying to parse another file, close() it first.";
}
unless ( defined $file ) {
croak "Usage: OBJ->read(\$file_name)";
}
$self->{_FILE_NAME} = $file;
$self->{_FILE_HANDLE} = $self->_get_fh($file, O_RDONLY) or return undef;
$self->{_SYNTAX} = $self->guess_syntax(\*FH) or return undef;
# call respective parsers
if ( $self->{_SYNTAX} eq 'ini' ) {
$self->{_DATA} = $self->parse_ini_file($file);
} elsif ( $self->{_SYNTAX} eq 'simple' ) {
$self->{_DATA} = $self->parse_cfg_file(\*FH);
} elsif ( $self->{_SYNTAX} eq 'http' ) {
$self->{_DATA} = $self->parse_http_file(\*FH);
}
if ( $self->{_DATA} ) {
return $self->{_DATA};
}
die "Something went wrong. No supported configuration file syntax found. Either the file is of wrong syntax, or there is a bug in guess_syntax() method.";
}
sub close {
my $self = shift;
my $fh = $self->{_FILE_HANDLE} or return;
unless ( close($fh) ) {
$self->error("couldn't close the file: $!");
return undef;
}
return 1;
}
# tries to guess the syntax of the configuration file.
# returns 'ini', 'simple' or 'http'.
sub guess_syntax {
my ($self, $fh) = @_;
unless ( defined $fh ) {
$fh = $self->{_FILE_HANDLE} or die "'_FILE_HANDLE' is not defined";
}
unless ( seek($fh, 0, 0) ) {
$self->error("Couldn't seek($fh, 0, 0): $!");
return undef;
}
# now we keep reading the file line by line until we can identify the
# syntax
verbose("Trying to guess the file syntax...");
my ($syntax, $sub_syntax);
while ( <$fh> ) {
# skipping empty lines and comments. They don't tell much anyway
/^(\n|\#|;)/ and next;
# If there's no alpha-numeric value in this line, ignore it
/\w/ or next;
# trim $/
chomp();
# If there's a block, it is an ini syntax
/^\s*\[\s*[^\]]+\s*\]\s*$/ and $syntax = 'ini', last;
# If we can read key/value pairs separated by '=', it still
# is an ini syntax with a default block assumed
/^\s*[\w-]+\s*=\s*.*\s*$/ and $syntax = 'ini', $self->{_SUB_SYNTAX} = 'simple-ini', last;
# If we can read key/value pairs separated by ':', it is an
# http syntax
/^\s*[\w-]+\s*:\s*.*\s*$/ and $syntax = 'http', last;
# If we can read key/value pairs separated by just whites,
# it is a simple syntax.
/^\s*[\w-]+\s+.*$/ and $syntax = 'simple', last;
}
if ( $syntax ) {
return $syntax;
}
$self->error("Couldn't identify the syntax used");
return undef;
}
sub parse_ini_file {
my ($class, $file) = @_;
my ($fh, $close_fh) = $class->_get_fh($file, O_RDONLY) or return;
unless(flock($fh, LOCK_SH) ) {
$errstr = "couldn't acquire shared lock on $fh: $!";
return undef;
}
unless ( seek($fh, 0, 0) ) {
$errstr = "couldn't seek to the beginning of the file: $!";
return undef;
}
my $bn = $DEFAULTNS;
my %data = ();
my $line;
while ( defined($line=<$fh>) ) {
# skipping comments and empty lines:
$line =~ /^\s*(\n|\#|;)/ and next;
$line =~ /\S/ or next;
chomp $line;
$line =~ s/^\s+//g;
$line =~ s/\s+$//g;
# parsing the block name:
$line =~ /^\s*\[\s*([^\]]+)\s*\]$/ and $bn = lcase($1), next;
# parsing key/value pairs
$line =~ /^\s*([^=]+?)\s*=\s*(.*)\s*$/ and $data{$bn}->{lcase($1)}=[parse_line(READ_DELIM, 0, $2)], next;
# if we came this far, the syntax couldn't be validated:
$errstr = "syntax error on line $. '$line'";
return undef;
}
unless(flock($fh, LOCK_UN) ) {
$errstr = "couldn't unlock file: $!";
return undef;
}
if ( $close_fh ) {
CORE::close($fh);
}
return \%data;
}
sub lcase {
my $str = shift;
$LC or return $str;
return lc($str);
}
sub parse_cfg_file {
my ($class, $file) = @_;
my ($fh, $close_fh) = $class->_get_fh($file, O_RDONLY) or return;
unless ( flock($fh, LOCK_SH) ) {
$errstr = "couldn't get shared lock on $fh: $!";
return undef;
}
unless ( seek($fh, 0, 0) ) {
$errstr = "couldn't seek to the start of the file: :$!";
}
my %data = ();
my $line;
while ( defined($line=<$fh>) ) {
# skipping comments and empty lines:
$line =~ /^(\n|\#)/ and next;
$line =~ /\S/ or next;
chomp $line;
$line =~ s/^\s+//g;
$line =~ s/\s+$//g;
# parsing key/value pairs
$line =~ /^\s*([\w-]+)\s+(.*)\s*$/ and $data{lcase($1)}=[parse_line(READ_DELIM, 0, $2)], next;
# if we came this far, the syntax couldn't be validated:
$errstr = "syntax error on line $.: '$line'";
return undef;
}
unless ( flock($fh, LOCK_UN) ) {
$errstr = "couldn't unlock the file: $!";
return undef;
}
if ( $close_fh ) {
CORE::close($fh);
}
return \%data;
}
sub parse_http_file {
my ($class, $file) = @_;
my ($fh, $close_fh) = $class->_get_fh($file, O_RDONLY) or return;
unless ( flock($fh, LOCK_SH) ) {
$errstr = "couldn't get shared lock on file: $!";
return undef;
}
unless( seek($fh, 0, 0) ) {
$errstr = "couldn't seek to the start of the file: $!";
return undef;
}
my %data = ();
my $line;
while ( defined($line= <$fh>) ) {
# skipping comments and empty lines:
$line =~ /^(\n|\#)/ and next;
$line =~ /\S/ or next;
# stripping $/:
chomp $line;
$line =~ s/^\s+//g;
$line =~ s/\s+$//g;
# parsing key/value pairs:
$line =~ /^\s*([\w-]+)\s*:\s*(.*)$/ and $data{lcase($1)}=[parse_line(READ_DELIM, 0, $2)], next;
# if we came this far, the syntax couldn't be validated:
$errstr = "syntax error on line $.: '$line'";
return undef;
}
unless ( flock($fh, LOCK_UN) ) {
$errstr = "couldn't unlock file: $!";
return undef;
}
if ( $close_fh ) {
CORE::close($fh);
}
return \%data;
}
sub param {
my $self = shift;
# If called with no arguments, return all the
# possible keys
unless ( @_ ) {
my $vars = $self->vars();
return keys %$vars;
}
# if called with a single argument, return the value
# matching this key
if ( @_ == 1) {
return $self->get_param(@_);
}
# if we come this far, we were called with multiple
# arguments. Go figure!
my $args = {
'-name', undef,
'-value', undef,
'-values', undef,
'-block', undef,
@_
};
if ( defined $args->{'-name'} && (defined($args->{'-value'}) || defined($args->{'-values'})) ) {
# OBJ->param(-name=>'..', -value=>'...') syntax:
return $self->set_param($args->{'-name'}, $args->{'-value'}||$args->{'-values'});
}
if ( defined($args->{'-name'}) ) {
# OBJ->param(-name=>'...') syntax:
return $self->get_param($args->{'-name'});
}
if ( defined($args->{'-block'}) && (defined($args->{'-values'}) || defined($args->{'-value'})) ) {
return $self->set_block($args->{'-block'}, $args->{'-values'}||$args->{'-value'});
}
if ( defined($args->{'-block'}) ) {
return $self->get_block($args->{'-block'});
}
if ( @_ % 2 ) {
croak "param(): illegal syntax";
}
my $nset = 0;
for ( my $i = 0; $i < @_; $i += 2 ) {
$self->set_param($_[$i], $_[$i+1]) && $nset++;
}
return $nset;
}
sub get_param {
my ($self, $arg) = @_;
unless ( $arg ) {
croak "Usage: OBJ->get_param(\$key)";
}
$arg = lcase($arg);
my $syntax = $self->{_SYNTAX} or die "'_SYNTAX' is undefined";
# If it was an ini-style, we should first
# split the argument into its block name and key
# components:
my $rv = undef;
if ( $syntax eq 'ini' ) {
my ($block_name, $key) = $arg =~ m/^([^\.]+)\.(.*)$/;
if ( defined($block_name) && defined($key) ) {
$rv = $self->{_DATA}->{$block_name}->{$key};
} else {
$rv = $self->{_DATA}->{$DEFAULTNS}->{$arg};
}
} else {
$rv = $self->{_DATA}->{$arg};
}
defined($rv) or return;
return "" if scalar(@$rv) == 0;
for ( my $i=0; $i < @$rv; $i++ ) {
$rv->[$i] =~ s/\\n/\n/g;
}
return @$rv==1 ? $rv->[0] : (wantarray ? @$rv : $rv);
}
sub get_block {
my ($self, $block_name) = @_;
unless ( $self->syntax() eq 'ini' ) {
croak "get_block() is supported only in 'ini' files";
}
unless ( defined $block_name ) {
return keys %{$self->{_DATA}};
}
my $rv = {};
while ( my ($k, $v) = each %{$self->{_DATA}->{$block_name}} ) {
$v =~ s/\\n/\n/g;
$rv->{$k} = $v->[1] ? $v : $v->[0];
}
return $rv;
}
sub set_block {
my ($self, $block_name, $values) = @_;
unless ( $self->syntax() eq 'ini' ) {
croak "set_block() is supported only in 'ini' files";
}
my $processed_values = {};
while ( my ($k, $v) = each %$values ) {
$v =~ s/\n/\\n/g;
$processed_values->{$k} = (ref($v) eq 'ARRAY') ? $v : [$v];
$self->_is_modified(1);
}
$self->{_DATA}->{$block_name} = $processed_values;
$self->_is_modified(1);
}
sub set_param {
my ($self, $key, $value) = @_;
my $syntax = $self->{_SYNTAX} or die "'_SYNTAX' is not defined";
if ( ref($value) eq 'ARRAY' ) {
for (my $i=0; $i < @$value; $i++ ) {
$value->[$i] =~ s/\n/\\n/g;
}
} else {
$value =~ s/\n/\\n/g;
}
unless ( ref($value) eq 'ARRAY' ) {
$value = [$value];
}
$key = lcase($key);
# If it was an ini syntax, we should first split the $key
# into its block_name and key components
if ( $syntax eq 'ini' ) {
my ($bn, $k) = $key =~ m/^([^\.]+)\.(.*)$/;
if ( $bn && $k ) {
$self->_is_modified(1);
return $self->{_DATA}->{$bn}->{$k} = $value;
}
# most likely the user is assuming default name space then?
# Let's hope!
$self->_is_modified(1);
return $self->{_DATA}->{$DEFAULTNS}->{$key} = $value;
}
$self->_is_modified(1);
return $self->{_DATA}->{$key} = $value;
}
sub write {
my ($self, $file) = @_;
$file ||= $self->{_FILE_NAME} or die "Neither '_FILE_NAME' nor \$filename defined";
unless ( sysopen(FH, $file, O_WRONLY|O_CREAT, 0666) ) {
$self->error("'$file' couldn't be opened for writing: $!");
return undef;
}
unless ( flock(FH, LOCK_EX) ) {
$self->error("'$file' couldn't be locked: $!");
return undef;
}
unless ( truncate(FH, 0) ) {
$self->error("'$file' couldn't be truncated: $!");
return undef;
}
print FH $self->as_string();
unless ( CORE::close(FH) ) {
$self->error("Couldn't write into '$file': $!");
return undef;
}
return 1;
}
sub save {
my $self = shift;
return $self->write(@_);
}
# generates a writable string
sub as_string {
my $self = shift;
my $syntax = $self->{_SYNTAX} or die "'_SYNTAX' is not defined";
my $sub_syntax = $self->{_SUB_SYNTAX} || '';
my $currtime = localtime;
my $STRING = undef;
if ( $syntax eq 'ini' ) {
$STRING .= "; Config::Simple $VERSION\n";
$STRING .= "; $currtime\n\n";
while ( my ($block_name, $key_values) = each %{$self->{_DATA}} ) {
unless ( $sub_syntax eq 'simple-ini' ) {
$STRING .= sprintf("[%s]\n", $block_name);
}
while ( my ($key, $value) = each %{$key_values} ) {
my $values = join (WRITE_DELIM, map { quote_values($_) } @$value);
$STRING .= sprintf("%s=%s\n", $key, $values );
}
$STRING .= "\n";
}
} elsif ( $syntax eq 'http' ) {
$STRING .= "# Config::Simple $VERSION\n";
$STRING .= "# $currtime\n\n";
while ( my ($key, $value) = each %{$self->{_DATA}} ) {
my $values = join (WRITE_DELIM, map { quote_values($_) } @$value);
$STRING .= sprintf("%s: %s\n", $key, $values);
}
} elsif ( $syntax eq 'simple' ) {
$STRING .= "# Config::Simple $VERSION\n";
$STRING .= "# $currtime\n\n";
while ( my ($key, $value) = each %{$self->{_DATA}} ) {
my $values = join (WRITE_DELIM, map { quote_values($_) } @$value);
$STRING .= sprintf("%s %s\n", $key, $values);
}
}
$STRING .= "\n";
return $STRING;
}
# quotes each value before saving into file
sub quote_values {
my $string = shift;
if ( ref($string) ) { $string = $_[0] }
$string =~ s/\\/\\\\/g;
if ( $USEQQ && ($string =~ m/\W/) ) {
$string =~ s/"/\\"/g;
$string =~ s/\n/\\n/g;
return sprintf("\"%s\"", $string);
}
return $string;
}
# deletes a variable
sub delete {
my ($self, $key) = @_;
my $syntax = $self->syntax() or die "No 'syntax' is defined";
if ( $syntax eq 'ini' ) {
my ($bn, $k) = $key =~ m/([^\.]+)\.(.*)/;
if ( defined($bn) && defined($k) ) {
delete $self->{_DATA}->{$bn}->{$k};
} else {
delete $self->{_DATA}->{$DEFAULTNS}->{$key};
}
return 1;
}
delete $self->{_DATA}->{$key};
}
# clears the '_DATA' entirely.
sub clear {
my $self = shift;
map { $self->delete($_) } $self->param;
}
1;
__END__;
=pod
=head1 NAME
Config::Simple - simple configuration file class
=head1 SYNOPSIS
use Config::Simple;
# --- Simple usage. Loads the config. file into a hash:
Config::Simple->import_from('app.ini', \%Config);
# --- OO interface:
$cfg = new Config::Simple('app.ini');
# accessing values:
$user = $cfg->param('User');
# getting the values as a hash:
%Config = $cfg->vars();
# updating value with a string
$cfg->param('User', 'sherzodR');
# updating a value with an array:
$cfg->param('Users', ['sherzodR', 'geek', 'merlyn']);
# adding a new block to an ini-file:
$cfg->param(-block=>'last-access', -values=>{'time'=>time()});
# accessing a block of an ini-file;
$mysql = $cfg->param(-block=>'mysql');
# saving the changes back to file:
$cfg->save();
# --- tie() interface
tie %Config, "Config::Simple", 'app.ini';
=head1 ABSTRACT
Reading and writing configuration files is one of the most frequent
tasks of any software design. Config::Simple is the library that helps
you with it.
Config::Simple is a class representing configuration file object.
It supports several configuration file syntax and tries to identify the
file syntax automatically. Library supports parsing, updating and creating
configuration files.
=head1 ABOUT CONFIGURATION FILES
Keeping configurable variables in your program source code is ugly, really.
And for people without much of a programming experience, configuring
your programs is like performing black magic. Besides, if you need to
access these values from within multiple files, want your programs
to be able to update configuration files or want to provide a friendlier
user interface for your configuration files, you just have to store them in
an external file. That's where Config::Simple comes into play, making it
very easy to read and write configuration files.
If you have never used configuration files before, here is a brief
overview of various syntax to choose from. Otherwise you can jump to
L</PROGRAMMING STYLE>.
=head2 SIMPLE CONFIGURATION FILE
Simple syntax is what you need for most of your projects. These
are, as the name asserts, the simplest. File consists of key/value
pairs, delimited by nothing but white space. Keys (variables) should
be strictly alpha-numeric with possible dashes (-). Values can hold
any arbitrary text. Here is an example of such a configuration file:
Alias /exec
TempFile /usr/tmp
Comments start with a pound ('#') sign and cannot share the same
line with other configuration data.
=head2 HTTP-LIKE SYNTAX
This format of separating key/value pairs is used by HTTP messages.
Each key/value is separated by semi-colon (:). Keys are alphanumeric
strings with possible '-'. Values can be any arbitrary text:
Example:
Alias: /exec
TempFile: /usr/tmp
It is OK to have spaces around ':'. Comments start with '#' and cannot
share the same line with other configuration data.
=head2 INI-FILE
These configuration files are more native to Win32 systems. Data
is organized in blocks. Each key/value pair is delimited with an
equal (=) sign. Blocks are declared on their own lines enclosed in
'[' and ']':
[BLOCK1]
KEY1=VALUE1
KEY2=VALUE2
[BLOCK2]
KEY1=VALUE1
KEY2=VALUE2
Your Winamp 2.x play list is an example of such a configuration file.
This is the perfect choice if you need to organize your configuration
file into categories:
[site]
url="http://www.handalak.com"
title="Web site of a \"Geek\""
author=sherzodr
[mysql]
dsn="dbi:mysql:db_name;host=handalak.com"
user=sherzodr
password=marley01
=head2 SIMPLIFIED INI-FILE
These files are pretty much similar to traditional ini-files, except they don't
have any block declarations. This style is handy if you do not want any categorization
in your configuration file, but still want to use '=' delimited key/value pairs.
While working with such files, Config::Simple assigns them to a default block,
called 'default' by default :-).
url = "http://www.handalak.com"
Comments can begin with either pound ('#') or semi-colon (';'). Each comment
should reside on its own line
=head1 PROGRAMMING STYLE
Most of the programs simply need to be able to read settings from a configuration
file and assign them to a hash. If that's all you need, you can simply use
its import_from() - class method with the name of the configuration file
and a reference to an existing (possibly empty) hash:
Config::Simple->import_from('myconf.cfg', \%Config);
Now your hash %Config holds all the configuration file's key/value pairs.
Keys of a hash are variable names inside your configuration file, and values
are their respective values. If "myconf.cfg" was a traditional ini-file,
keys of the hash consist of block name and variable delimited with a dot, such
as "block.var".
If that's all you need, you can stop right here. Otherwise, read on. There is
much more Config::Simple offers.
=head2 READING THE CONFIGURATION FILE
To be able to use more features of the library, you will need to use its object
interface:
$cfg = new Config::Simple('app.cfg');
The above line reads and parses the configuration file accordingly.
It tries to guess which syntax is used by passing the file to guess_syntax() method.
Alternatively, you can create an empty object, and only then read the configuration file in:
$cfg = new Config::Simple();
$cfg->read('app.cfg');
As in the first example, read() also calls guess_syntax() method on the file.
If, for any reason, it fails to guess the syntax correctly (which is less likely),
you can try to debug by using its guess_syntax() method. It expects
file handle for a configuration file and returns the name of a syntax. Return
value is one of "ini", "simple" or "http".
open(FH, "app.cfg");
printf("This file uses '%s' syntax\n", $cfg->guess_syntax(\*FH));
=head2 ACCESSING VALUES
After you read the configuration file in successfully, you can use param()
method to access the configuration values. For example:
$user = $cfg->param("User");
will return the value of "User" from either simple configuration file, or
http-styled configuration as well as simplified ini-files. To access the
value from a traditional ini-file, consider the following syntax:
$user = $cfg->param("mysql.user");
The above returns the value of "user" from within "[mysql]" block. Notice the
use of dot "." to delimit block and key names.
Config::Simple also supports vars() method, which, depending on the context
used, returns all the values either as hashref or hash:
my %Config = $cfg->vars();
print "Username: $Config{User}";
# If it was a traditional ini-file:
print "Username: $Config{'mysql.user'}";
If you call vars() in scalar context, you will end up with a reference to a hash:
my $Config = $cfg->vars();
print "Username: $Config->{User}";
If you know what you're doing, you can also have an option of importing all the
names from the configuration file into your current name space as global variables.
All the block/key names will be uppercased and will be converted to Perl's valid
variable names; that is, all the dots (block-key separator) and other '\W' characters will be
substituted with underscore '_':
$cfg = new Config::Simple('app.cfg');
$cfg->import_names();
# or, with a single line:
Config::Simple->new('app.cfg')->import_names();
print STDERR "Debugging mode is on" if $DEBUG_MODE;
In the above example, if there was a variable 'mode' under '[debug]' block,
it will be now accessible via $DEBUG_MODE, as opposed to $cfg->param('debug.mode');
C<import_names()> by default imports the values to its caller's name space.
Optionally, you can specify where to import the values by passing the name of the
name space as the first argument. It also prevents potential name collisions:
Config::Simple->new('app.cfg')->import_names('CFG');
print STDERR "Debugging mode is on" if $CFG::DEBUG_MODE;
If all you want is to import values from a configuration file, the above syntax may still
seem longer than necessary. That's why Config::Simple supports import_from() - class method,
which is called with the name of the configuration file. It will call import_names() for you:
Config::Simple->import_from('app.cfg');
The above line imports all the variables into the caller's name space. It's similar to
calling import_names() on an object. If you pass a string as the second argument,
it will treat it as the alternative name space to import the names into. As we
already showed in the very first example, you can also pass a reference to an existing
hash as the second argument. In this case, that hash will be modified with the values
of the configuration file.
# import into $CFG name space:
Config::Simple->import_from('app.cfg', 'CFG');
# import into %Config hash:
Config::Simple->import_from('app.cfg', \%Config);
The above line imports all the values to 'CFG' name space. import_from() returns
underlying Config::Simple object (which you may not even need anymore):
$cfg = Config::Simple->import_from('app.cfg', \my %Config);
$cfg->write('app.cfg.bak');
=head2 UPDATING THE VALUES
Configuration values, once read into Config::Simple, can be updated from within
your program by using the same param() method used for accessing them. For example:
$cfg->param("User", "sherzodR");
The above line changes the value of "User" to "sherzodR". Similar syntax is applicable
for ini-files as well:
$cfg->param("mysql.user", "sherzodR");
If the key you're trying to update does not exist, it will be created. For example,
to add a new "[session]" block to your ini-file, assuming this block doesn't already
exist:
$cfg->param("session.life", "+1M");
You can also delete values calling delete() method with the name of the variable:
$cfg->delete('mysql.user'); # deletes 'user' under [mysql] block
=head2 SAVING/WRITING CONFIGURATION FILES
The above updates to the configuration values are in-memory operations. They
do not reflect in the file itself. To modify the files accordingly, you need to
call either "write()" or "save()" methods on the object:
$cfg->write();
The above line writes the modifications to the configuration file. Alternatively,
you can pass a name to either write() or save() to indicate the name of the
file to create instead of modifying existing configuration file:
$cfg->write("app.cfg.bak");
If you want the changes saved at all times, you can turn C<autosave> mode on
by passing true value to $cfg->autosave(). It will make sure before your program
is terminated, all the configuration values are written back to its file:
$cfg = new Config::Simple('aff.cfg');
$cfg->autosave(1);
=head2 CREATING CONFIGURATION FILES
Occasionally, your programs may want to create their own configuration files
on the fly, possibly from a user input. To create a configuration file from
scratch using Config::Simple, simply create an empty configuration file object
and define your syntax. You can do it by either passing "syntax" option to new(),
or by calling syntax() method. Then play with param() method as you normally would.
When you're done, call write() method with the name of the configuration file:
$cfg = new Config::Simple(syntax=>'ini');
# or you could also do:
# $cfg->autosave('ini')
$cfg->param("mysql.dsn", "DBI:mysql:db;host=handalak.com");
$cfg->param("mysql.user", "sherzodr");
$cfg->param("mysql.pass", 'marley01');
$cfg->param("site.title", 'sherzodR "The Geek"');
$cfg->write("new.cfg");
This creates a file "new.cfg" with the following content:
; Config::Simple 4.43
; Sat Mar 8 00:32:49 2003
[site]
title=sherzodR "The Geek"
[mysql]
pass=marley01
dsn=DBI:mysql:db;host=handalak.com
user=sherzodr
Neat, huh? Supported syntax keywords are "ini", "simple" or "http". Currently
there is no support for creating simplified ini-files.
=head2 MULTIPLE VALUES
Ever wanted to define array of values in your single configuration variable? I have!
That's why Config::Simple supports this fancy feature as well. Simply separate your values
with a comma:
Files hp.cgi, template.html, styles.css
Now param() method returns an array of values:
@files = $cfg->param("Files");
unlink $_ for @files;
If you want a comma as part of a value, enclose the value(s) in double quotes:
CVSFiles "hp.cgi,v", "template.html,v", "styles.css,v"
In case you want either of the values to hold literal quote ("), you can
escape it with a backlash:
SiteTitle "sherzod \"The Geek\""
=head2 TIE INTERFACE
If OO style intimidates you, and C<import_from()> is too simple for you,
Config::Simple also supports tie() interface. This interface allows you to tie()
an ordinary Perl hash to the configuration file. From that point on, you can use
the variable as an ordinary Perl hash.
tie %Config, "Config::Simple", 'app.cfg';
# Using %Config as an ordinary hash
print "Username is '$Config{User}'\n";
$Config{User} = 'sherzodR';
The difference between C<import_from($file, \%Hash)> is, all the changes you make
to the hash after tie()ing it, will also reflect in the configuration file object.
If autosave() was turned on, they will also be written back to file:
tie %Config, "Config::Simple", "app.cfg";
tied(%Config)->autosave(1);
To access the method provided in OO syntax, you need to get underlying Config::Simple
object. You can do so with tied() function:
tied(%Config)->write();
WARNING: tie interface is experimental and not well tested yet. Let me know if you
encounter a problem.
=head1 MISCELLANEOUS
=head2 CASE SENSITIVITY
By default, configuration file keys and values are case sensitive. Which means,
$cfg->param("User") and $cfg->param("user") are referring to two different values.
But it is possible to force Config::Simple to ignore cases all together by enabling
C<-lc> switch while loading the library:
use Config::Simple ('-lc');
WARNING: If you call write() or save(), while working on C<-lc> mode, all the case
information of the original file will be lost. So use it if you know what you're doing.
=head2 USING QUOTES
Some people suggest if values consist of none alpha-numeric strings, they should be
enclosed in double quotes. Well, says them! Although Config::Simple supports parsing
such configuration files already, it doesn't follow this rule while writing them.
If you really need it to generate such compatible configuration files, C<-strict>
switch is what you need:
use Config::Simple '-strict';
Now, when you write the configuration data back to files, if values hold any none alpha-numeric
strings, they will be quoted accordingly. All the double quotes that are part of the
value will be escaped with a backslash.
=head2 EXCEPTION HANDLING
Config::Simple doesn't believe in dying that easily (unless you insult it using wrong syntax).
It leaves the decision to the programmer implementing the library. You can use its error() -
class method to access underlying error message. Methods that require you to check
for their return values are read() and write(). If you pass filename to new(), you will
need to check its return value as well. They return any true value indicating success,
undef otherwise:
# following new() always returns true:
$cfg = new Config::Simple();
# read() can fail:
$cfg->read('app.cfg') or die $cfg->error();
# following new() can fail:
$cfg = new Config::Simple('app.cfg') or die Config::Simple->error();
# import_from() calls read(), so it can fail:
Config::Simple->import_from('app.cfg', \%Config) or die Config::Simple->error();
# write() may fail:
$cfg->write() or die $cfg->error();
# tie() may fail, since it calls new() with a filename
tie %Config, "Config::Simple", 'app.cfg' or die Config::Simple->error();
=head1 METHODS
=over 4
=item new()
- constructor. Optionally accepts several arguments. Returns Config::Simple object.
Supported arguments are B<filename>, B<syntax>, B<autosave>. If there is a single
argument, will be treated as the name of the configuration file.
=item autosave([$bool])
- turns 'autosave' mode on if passed true argument. Returns current autosave mode
if used without arguments. In 'autosave' mode Config::Simple writes all the changes
back to its file without you having to call write() or save()
=item read()
- accepts name of the configuration file to parse. Before that, it tries to
guess the syntax of the file by calling guess_syntax() method. Then calls either of
parse_ini_file(), parse_cfg_file() or parse_http_file() accordingly. If the name
of the file is provided to the constructor - new(), there is no need to call read().
=item param([$name], [$value])
- used for accessing and updating configuration variables. If used with no arguments
returns all the available names from the configuration file.
=item delete($name)
- deletes a variable from a configuration file. $name has the same meaning and syntax
as it does in param($name)
=item clear()
- clears all the data from the object. Calling save() or turning autosave() on results
in an empty configuration file as well.
=item vars()
- depending on the context used, returns all the values available in the configuration
file either as a hash or a reference to a hash
=item import_names([$NS])
- imports all the names from the configuration file to the caller's name space. Optional
argument, if passed, will be treated as the name space variables to be imported into.
All the names will be uppercased. Non-alphanumeric strings in the values will be underscored
=item import_from($file, \%hash | $NS)
- class method. If the second argument is a reference to an existing hash, it will
load all the configuration contents into that hash. If the second argument is a
string, it will be treated as the name space variables should be imported into, just
like import_names() does.
=item get_block($name)
is mostly used for accessing blocks in ini-styled configuration files.
Returns a hashref of all the key/value pairs of a given block. Also supported by param()
method with the help of "-block" option:
$hash = $cfg->get_block('Project');
# is the same as saying:
$hash = $cfg->param(-block=>'Project');
=item set_block($name, $values)
used in assigning contents to a block in ini-styled configuration files. $name should
be the name of a [block], and $values is assumed to be a hashref mapping key/value pairs.
Also supported by param() method with the help of "-block" and "-value" (or "-values") options:
$cfg->set_block('Project', {Count=>3, 'Multiple Column' => 20});
# is the same as:
$cfg->param(-block=>'Project', -value=>{Count=>3, 'Multiple Column' => 20});
Warning: all the contents of a block, if previously existed will be wiped out.
If you want to set specific key/value pairs, use explicit method:
$cfg->param('Project.Count', 3);
=item as_string()
- returns the configuration file as a chunk of text. It is the same text used by
write() and save() to store the new configuration file back to file.
=item write()
- writes the configuration file into disk. Argument, if passed, will be treated
as the name of the file configuration variables should be saved in.
=item save()
- same as write().
=item dump()
- for debugging only. Dumps the whole Config::Simple object using Data::Dumper.
Argument, if passed, will be treated as the name of the file object should be dumped in.
The second argument specifies amount of indentation as documented in L<Data::Dumper|Data::Dumper>
manual. Default indent size is 2.
=item error()
- returns the last error message from read/write or import_* operations.
=back
=head1 TODO
=over 4
=item *
Support for lines with continuation character, '\'. Currently its support
is restricted and quite possibly buggy.
=item *
Retaining comments while writing the configuration files back and/or methods for
manipulating comments. Everyone loves comments!
=item *
Retain the order of the blocks and other variables in the configuration files.
=back
=head1 BUGS
Submit bugs and possibly patches to Sherzod B. Ruzmetov E<lt>sherzodr@cpan.orgE<gt>.
=head1 CREDITS
=over 4
=item Michael Caldwell (mjc@mjcnet.com)
whitespace support, C<-lc> switch and for various bug fixes
=item Scott Weinstein (Scott.Weinstein@lazard.com)
bug fix in TIEHASH
=item Ruslan U. Zakirov <cubic@wr.miee.ru>
default name space suggestion and patch
=item Hirosi Taguti
import_names() and import_from() idea.
=item Vitaly Kushneriuk
for bug fixes and suggestions
=back
=head1 COPYRIGHT
Copyright (C) 2002-2003 Sherzod B. Ruzmetov.
This software is free library. You can modify and/or distribute it
under the same terms as Perl itself
=head1 AUTHOR
Sherzod B. Ruzmetov E<lt>sherzodr@cpan.orgE<gt>
URI: http://author.handalak.com
=head1 SEE ALSO
L<Config::General>, L<Config::Simple>, L<Config::Tiny>
=cut
# Following methods are loaded on demand.
# returns all the keys as a hash or hashref
sub vars {
my $self = shift;
# it might seem we should have used get_param() or param()
# methods to make the task easier, but param() itself uses
# vars(), so it will result in a deep recursion
my %vars = ();
my $syntax = $self->{_SYNTAX} or die "'_SYNTAX' is not defined";
if ( $syntax eq 'ini' ) {
while ( my ($block, $values) = each %{$self->{_DATA}} ) {
while ( my ($k, $v) = each %{$values} ) {
$vars{"$block.$k"} = (@{$v} > 1) ? $v : $v->[0];
}
}
} else {
while ( my ($k, $v) = each %{$self->{_DATA}} ) {
$vars{$k} = (@{$v} > 1) ? $v : $v->[0];
}
}
return wantarray ? %vars : \%vars;
}
# imports names into the caller's namespace as global variables.
# I'm not sure how secure this method is. Hopefully someone will
# take a look at it for me
sub import_names {
my ($self, $namespace) = @_;
unless ( defined $namespace ) {
$namespace = (caller)[0];
}
if ( $namespace eq 'Config::Simple') {
croak "You cannot import into 'Config::Simple' package";
}
my %vars = $self->vars();
no strict 'refs';
while ( my ($k, $v) = each %vars ) {
$k =~ s/\W/_/g;
${$namespace . '::' . uc($k)} = $v;
}
}
# imports names from a file. Compare with import_names.
sub import_from {
my ($class, $file, $arg) = @_;
if ( ref($class) ) {
croak "import_from() is not an object method.";
}
# this is a hash support
if ( defined($arg) && (ref($arg) eq 'HASH') ) {
my $cfg = $class->new($file) or return;
map { $arg->{$_} = $cfg->param($_) } $cfg->param();
return $cfg;
}
# following is the original version of our import_from():
unless ( defined $arg ) {
$arg = (caller)[0];
}
my $cfg = $class->new($file) or return;
$cfg->import_names($arg);
return $cfg;
}
sub error {
my ($self, $msg) = @_;
if ( $msg ) {
$errstr = $msg;
}
return $errstr;
}
sub dump {
my ($self, $file, $indent) = @_;
require Data::Dumper;
my $d = new Data::Dumper([$self], [ref $self]);
$d->Indent($indent||2);
if ( defined $file ) {
sysopen(FH, $file, O_WRONLY|O_CREAT|O_TRUNC, 0666) or die $!;
print FH $d->Dump();
CORE::close(FH) or die $!;
}
return $d->Dump();
}
sub verbose {
DEBUG or return;
carp "****[$0]: " . join ("", @_);
}
#------------------
# tie() interface
#------------------
sub TIEHASH {
my ($class, $file, $args) = @_;
unless ( defined $file ) {
croak "Usage: tie \%config, 'Config::Simple', \$filename";
}
return $class->new($file);
}
sub FETCH {
my $self = shift;
return $self->param(@_);
}
sub STORE {
my $self = shift;
return $self->param(@_);
}
sub DELETE {
my $self = shift;
return $self->delete(@_);
}
sub CLEAR {
my $self = shift;
map { $self->delete($_) } $self->param();
}
sub EXISTS {
my ($self, $key) = @_;
my $vars = $self->vars();
return exists $vars->{$key};
}
sub FIRSTKEY {
my $self = shift;
# we make sure that tied hash is created ONLY if the program
# needs to use this functionality.
unless ( defined $self->{_TIED_HASH} ) {
$self->{_TIED_HASH} = $self->vars();
}
my $temp = keys %{ $self->{_TIED_HASH} };
return scalar each %{ $self->{_TIED_HASH} };
}
sub NEXTKEY {
my $self = shift;
unless ( defined $self->{_TIED_HASH} ) {
$self->{_TIED_HASH} = $self->vars();
}
return scalar each %{ $self->{_TIED_HASH} };
}
# -------------------
# deprecated methods
# -------------------
sub write_string {
my $self = shift;
return $self->as_string(@_);
}
sub hashref {
my $self = shift;
return scalar( $self->vars() );
}
sub param_hash {
my $self = shift;
return ($self->vars);
}
sub errstr {
my $self = shift;
return $self->error(@_);
}
sub block {
my $self = shift;
return $self->get_block(@_);
}
|