From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

SAMYOUNG / Slackware-SBoKeeper-2.06 / lib / Slackware / SBoKeeper / Config.pm 

            

              
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

              
package Slackware::SBoKeeper::Config;
our $VERSION = '2.06';
use 5.016;
use strict;
use warnings;
use Exporter 'import';
our @EXPORT_OK = qw(read_config);
use File::Spec;
sub read_config {
        my $file     = shift;
        my $callback = shift;
        my $config = {};
        open my $fh, '<', $file
                or die "Failed to open config file $file for reading: $!\n";
        my $param = {
                File => File::Spec->rel2abs($file),
        };
        my $ln = 0;
        while (my $l = readline $fh) {
                $ln++;
                # Skip comments and blanks
                next if $l =~ /^#/ or $l =~ /^\s*$/;
                unless ($l =~ /=/) {
                        die "$file line $ln: Missing '='\n";
                }
                my ($field, $val) = split '=', $l, 2;
                $field =~ s/^\s+|\s+$//g;
                $val   =~ s/^\s+|\s+$//g;
                if ($val eq '') {
                        die "$file line $ln: Value cannot be empty\n";
                }
                unless (defined $callback->{$field}) {
                        die "$file line $ln: '$field' is not a valid field\n";
                }
                eval {
                        $config->{$field} = $callback->{$field}($val, $param);
                        1; # so that $config->{$field} being 0 won't cause problems.
                } or do {
                        my $e = $@ || 'Something went wrong';
                        chomp $e;
                        die "$file line $ln: $e\n";
                };
        }
        return $config;
}
1;
=head1 NAME
Slackware::SBoKeeper::Config - Configuration file reader
=head1 SYNOPSIS
 use Slackware::SBoKeeper::Config qw(read_config);
 my $config = read_config($file, $callbacks);
=head1 DESCRIPTION
Slackware::SBoKeeper::Config is a module that provides the C<read_config()>
subroutine, which can read L<sbokeeper> config files.
Slackware::SBoKeeper::Config is not meant to be used outside of L<sbokeeper>.
If you are looking for L<sbokeeper> user documentation, please consult its
manual.
=head1 SUBROUTINES
=over 4
=item read_config($file, $callbacks)
C<read_config> is a subroutine that reads the config file C<$file> and returns
its contents in the form of a hash ref. C<$callbacks> is a hash ref of config
fields and their respective callback subroutine references that process the
value of said field. C<$callbacks> must contain every field that is able to be
read, otherwise C<read_config> will fail on unknown fields.
Configuration files consists of lines of key-value pairs, seperated by an
equal sign (=). Blank lines and comments are ignored.
The subroutines in C<$callbacks> can take two arguments, the first is the value
of the field and the second is a hash ref of extra data that might be useful to
the subroutine. The hash ref can have the following fields:
=over 4
=item File
Absolute path of the config file being read.
=back
C<read_config> must be manually imported.
=back
=head1 AUTHOR
Written by Samuel Young, E<lt>samyoung12788@gmail.comE<gt>.
=head1 BUGS
Report bugs on my Codeberg, L<https://codeberg.org/1-1sam>.
=head1 COPYRIGHT
Copyright (C) 2024-2025 Samuel Young
This program is free software; you can redistribute it and/or modify it under
the terms of either: the GNU General Public License as published by the Free
Software Foundation; or the Artistic License.
=head1 SEE ALSO
L<sbokeeper>
=cut