File: cache-exclude

package info (click to toggle)
qdirstat 2.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 12,024 kB
  • sloc: cpp: 26,846; perl: 543; sh: 434; xml: 80; makefile: 3
file content (202 lines) | stat: -rwxr-xr-x 3,922 bytes parent folder | download | duplicates (3)
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
#!/usr/bin/perl -w
#
# cache-exclude - script to filter out a list of files from a cache file.
#
# Author:  Stefan Hundhammer <Stefan.Hundhammer@gmx.de>
# License: GPL V2
#

use strict;
use English;
use Getopt::Std;
use vars qw( $opt_l $opt_m $opt_v $opt_d $opt_h );



# Forward declarations.

sub main();

# Global variables.

my $verbose	= 0;
my $debug	= 0;

my %excludes;


# Call the main function and exit.
# DO NOT enter any other code outside a sub -
# any variables would otherwise be global.


main();
exit 0;


#-----------------------------------------------------------------------------


sub main()
{
    # Extract command line options.
    # This will set a variable opt_? for any option,
    # e.g. opt_v if option '-v' is passed on the command line.

    getopts('vdh');

    usage()			if $opt_h;
    $verbose		= 1 	if $opt_v;
    $debug		= 1 	if $opt_d;

    # One or two parameters are required
    # (yes, Perl does weird counting)
    usage() if $#ARGV < 0 || $#ARGV > 1;

    my $exclude_file_name = shift @ARGV;

    read_exclude_file( $exclude_file_name );
    filter_cache_file();
}


#-----------------------------------------------------------------------------


# Read an exclude file consisting of paths to exclude and store each path in
# the %excludes hash.

sub read_exclude_file()
{
    my ( $filename ) = @_;
    logf( "Reading excludes from $filename" );

    open( EXCLUDE, $filename ) or die "FATAL: Can't open $filename";

    while ( my $line = <EXCLUDE> )
    {
        chomp $line;            # Remove trailing newline
        $line =~ s/^\s*//;      # Remove leading  whitespace
        $line =~ s/\s*$//;      # Remove trailing whitespace

        if ( $line ne "" )
        {
            # deb( "Adding exclude \"$line\"" );
            $excludes{ $line } = 1;
        }
    }

    close( EXCLUDE );

    my $size = keys %excludes;
    logf( "Read $size exitems from exclude file $filename" );
}


#-----------------------------------------------------------------------------


# Filter a QDirStat cache file: Read stdin, filter out all file paths in the
# %exclude hash and write the remaining lines to stdout.

sub filter_cache_file()
{
    while ( my $line = <> )
    {
        my $suppress = 0;
        chomp $line;

        if ( $line !~ /^\s*$/ && $line !~ /^\s*#/ ) # skip empty and comment lines
        {
            my ( $type, $path ) = split( /\s+/, $line );

            if ( $type ne "D" ) # don't try to exclude directories
            {
                $suppress = defined $excludes{ $path };
                deb( "Excluding line $line" ) if $suppress;
            }
        }

        print "$line\n" unless $suppress;
    }
}


#-----------------------------------------------------------------------------


# Log a message to stdout if verbose mode is set
# (command line option '-v').
#
# Parameters:
#	Messages to write (any number).

sub logf()
{
    my $msg;

    if ( $verbose )
    {
	foreach $msg( @_ )
	{
	    print STDERR $msg . " ";
	}

	$OUTPUT_AUTOFLUSH = 1;	# inhibit buffering
	print STDERR "\n";
    }
}


#-----------------------------------------------------------------------------


# Log a debugging message to stdout if debug mode is set
# (command line option '-d').
#
# Parameters:
#	Messages to write (any number).

sub deb()
{
    my $msg;

    if ( $debug )
    {
	foreach $msg( @_ )
	{
	    print STDERR $msg . " ";
	}

	$OUTPUT_AUTOFLUSH = 1;	# inhibit buffering
	print STDERR "\n";
    }
}


#-----------------------------------------------------------------------------


# Print usage message and abort program.
#
# Parameters:
#	---

sub usage()
{
    die <<"USAGE-END";

cache-exclude - exclude the content of a file list from a QDirStat cache file

Usage:
	$0 [-ldh] <exclude-file>

        Redirect stdin and stdout for the input and output cache file.

	-v	verbose
	-d	debug
	-h	help (this usage message)

USAGE-END

}