File: muttprofile

package info (click to toggle)
muttprofile 1.0.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 184 kB
  • sloc: perl: 520; makefile: 13
file content (515 lines) | stat: -rw-r--r-- 14,674 bytes parent folder | download
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
#!/usr/bin/perl -w

# muttprofile - choose mutt profile interactively
# Copyright (C) 2000-2003 Martti Rahkila
# http://www.iki.fi/martti.rahkila/mutt/
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# (http://www.gnu.org/copyleft/gpl.html)
#
# 2000-05-10 v1.0.0
# 2003-11-20 v1.0.1 three bugfixes

### defaults
my $mutt_path = "~/.mutt"; # directory for mutt files, change with option -d
my $active_profile = "profile.active"; # symlink to the real profile, change with option -a
my $profile_regexp = "/^profile.*[^\~]\$/"; # default is "profilesomething" (/^profile.*[^\~]\$/), change with option -p


### initialize
use strict;
use Getopt::Long; # for command line options
use Term::Complete; # for interactive mode

# declarations
sub read_link; # returns name of the real active profile, otherwise false
sub create_link; # the actual beef here, make a symlink and remove old one if needed
sub expand_tilde; # if home directory was given with tilde, expands it to absolute path

my %profiles;
my %descriptions;

# versions
my $version = "1.0.1"; # major.minor.patchlevel
my $license = "This program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n(http://www.gnu.org/copyleft/gpl.html)";
my $version_string = "muttprofile $version, (c) 2000-2003 Martti Rahkila\n\n$license\n";

# set return values
my $ok = 0;
my $already_active = 1;
my $error = 2;


### main
## command line first
my ($set_active_profile,$view_config,$set_mutt_directory,$help,$set_profiles,$view_source,$version_number,$version_long);

Getopt::Long::Configure(qw/no_ignore_case/);
# command line options
unless (GetOptions( 
	    "a=s"       => \$set_active_profile,
	    "active=s"  => \$set_active_profile,
	    "d=s"       => \$set_mutt_directory,
	    "dir=s"     => \$set_mutt_directory,
	    "h"         => \$help,
	    "help"      => \$help,
	    "p=s"       => \$set_profiles,
	    "profile=s" => \$set_profiles,
            "v"         => \$view_source,
            "view"      => \$view_source,
            "V"         => \$version_number,
            "Version"   => \$version_long,
            "version"   => \$version_long
	    )
) {
    print STDERR "Invalid command line options. Exiting($error)\n";
    exit($error);
}

my $input;
my $found = 0;
my $str ="";
my $real_active_profile;

if ($help) {
    print STDOUT <<EOF
$version_string

Usage: muttprofile [options] [profile_name]

       -a --active  string         name for active profile symlink (default: profile.active)
       -d --dir     directory      alternative mutt directory (default: ~/.mutt)
       -h --help                   print this message
       -p --profile list or regexp list of profiles or regular expression to match profiles
                                   (default: profile.*)
       -v --view                   view profile source instead of making it active
       -V --version                print version information, use --version for long output

       profile name                name for profile to load/view

If no command line arguments are present or option -v|--view is used without arguments, 
muttprofile starts in interactive mode.

For details, please see perldoc -F $0
EOF
    ;
    exit($ok);
} elsif ($version_number) {
    print STDOUT "$version\n";
    exit($ok);
} elsif ($version_long) {
    print STDOUT "$version_string\n";
    exit($ok);
}

my $real_mutt_path;
# verify mutt directory settings
if ($set_mutt_directory) {
    # mutt_path is given in command line
    $real_mutt_path = expand_tilde($set_mutt_directory);
    # verify given mutt directory
    unless (-d $real_mutt_path) {
	print STDERR "Cannot find mutt directory ($set_mutt_directory). Exiting($error).\n";
	exit($error);
    }
} else {
    # we are using default mutt_path
    $real_mutt_path = expand_tilde($mutt_path);
    # verify default mutt directory
    unless (-d $real_mutt_path) {
	print STDERR "Cannot find default mutt directory ($mutt_path), Try option -d. Exiting($error).\n";
	exit($error);
    }
}

# verify name for active profile symlink
if ($set_active_profile) {
    # name for active profile is given in command line
    $active_profile = $set_active_profile;
}
if ((-e "$real_mutt_path/$active_profile") &&
    !(-l "$real_mutt_path/$active_profile")) {
    # the active profile exists but it is not a symlink
#    print STDERR "Problem with name for active profile, Try option -a or another name. Exiting($error).\n";    
    print STDERR "Problem with name for active profile ($real_mutt_path/$active_profile), Try option -a or another name. Exiting($error).\n";    
    # in 1.0.0 the exit() here was missing...
    exit($error);
}

if ($set_profiles) {
    # profile regexp is given in command line
    $profile_regexp = $set_profiles;
}

# load profiles
my @files;
opendir(DIR,$real_mutt_path);
@files = grep { eval($profile_regexp) } readdir(DIR);
closedir(DIR);

#if (scalar(@files) == 0) {
#http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=218957
if (scalar(@files) == 0 || ($#files == 0 && $files[0] eq $active_profile)) {
    # regexp matches no files
    print STDERR "No profiles found, try option -p or different regexp. Exiting($error).\n";
    exit($error);
}

my $f;
my $name;
my $desc;

foreach $f (@files) {
    next if ($f eq $active_profile);
    $name = "";
    $desc = "";
    open(FILE,"<$real_mutt_path/$f") || print STDERR "Cannot open $real_mutt_path/$f, skipping.\n";
    while (<FILE>) {
	if (/\#\s*NAME:\s*(.*)\s*$/i) {
	    $name = $1;
	    next;
	}
	if (/\#\s*DESC:\s*(.*)\s*$/i) {
	    $desc = $1;
	    next;
	}
    }
    close(FILE);
    $name = $f if ($name eq "");
    $profiles{$name} = $f;
    $descriptions{$name} = $desc;
}

# do we want view_mode
my $view_mode = 0;
if ($view_source) {
    $view_mode = 1;
}

# find active profile
$real_active_profile = read_link($real_mutt_path,$active_profile);

# do we have a profile name on the command line?
if (@ARGV) {
    $str = shift;
    if (defined($profiles{$str})) {
	$found = 1;

	# we want to wiew source
	if ($view_mode == 1) {
	    open(FILE,"<$real_mutt_path/$profiles{$str}") || 
		print STDERR "Cannot open profile $str.\n",exit($error);
	    while (<FILE>) {
		print STDOUT $_;
	    }
	    close(FILE);
	    exit($ok);
	}

	if ($real_active_profile) {
	    # symlink exists
	    if ("$profiles{$str}" eq $real_active_profile) {
		print STDOUT "Chosen profile ($profiles{$str}) is already active.\n";
		exit($already_active);
	    }
	}
	# create the link, remove old if needed
	if (create_link($real_mutt_path,$active_profile,$profiles{$str})) {
	    print STDOUT "New active profile: $profiles{$str}\n";
	    exit($ok);
	} else {
	    # something wrong here
	    print STDERR "Error creating symlink. Exiting($error).\n";
	    exit($error);
	}

    } else {
	print STDERR "Unknown profile ($str). Exiting($error).\n";
	exit($error);
    }
}

## command line clear, going for interactive mode

my $prompt = "Profile name (tab to complete, * = active profile): ";

my @list;
my $plength = 0;
my $dlength = 0;
my $i = 0;
my $k;

foreach $k (keys %profiles) {
    push(@list,$k);
    $plength = length($k) if (length($k) > $plength);
    $dlength = length($descriptions{$k}) if (length($descriptions{$k}) > $dlength);
    $i++;
}

# cutpoint for descriptions
my $max = length($prompt) + $plength;
if ($max < 80) {
    $max = 80;
}

# output format
my $mark;
my $format = "format STDOUT = \n"
    . '^ ' . '^'  . '<' x ($plength - 1) . " ^" . '<' x ($max - $plength - 5) . '~~' . "\n"
    . '$mark,$name,$desc' . "\n" . '.' . "\n";

eval($format);

print STDOUT "Available profiles ($i):\n";

#foreach $k (keys %profiles) {
#http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=218960
foreach $k (sort keys %profiles) {
    $mark = "";
    $name = "";
    $desc = "";
    if ($real_active_profile eq $profiles{$k}) {
	$mark = "*";
    }
    $name = $k;
    $desc = $descriptions{$k} if ($descriptions{$k} ne '');
    write STDOUT;
}

$found = 0;
$str ="";

# get the profile name
$str = Complete($prompt,@list);

# verify given profile name
if ($str eq '') {
    print STDERR "No profile chosen. Exiting($error).\n";
    exit($error);
}
unless (defined($profiles{$str})) {
    print STDERR "Unknown profile ($str). Exiting($error).\n";
    exit($error);
} else {
    # we have a valid profile name

    # we want to wiew source
    if ($view_mode == 1) {
	open(FILE,"<$real_mutt_path/$profiles{$str}") || 
	    print STDERR "Cannot open profile $str. Exiting($error).\n",exit($error);
	while (<FILE>) {
	    print STDOUT $_;
	}
	close(FILE);
	exit($ok);
    }

    if ($real_active_profile) {
	# symlink exists
	if ("$profiles{$str}" eq $real_active_profile) {
	    print STDOUT "Chosen profile ($profiles{$str}) is already active.\n";
	    exit($already_active);
	}
    }
    # create the link, remove old if needed
    if (create_link($real_mutt_path,$active_profile,$profiles{$str})) {
	print STDOUT "New active profile: $profiles{$str}\n";
	exit($ok);
    } else {
	# something wrong here
	print STDERR "Error creating symlink. Exiting($error).\n";
	exit($error);
    }
}
    
exit($ok);


### subs
sub read_link {
    my $real_mutt_path = shift;
    my $active_profile = shift;
    my $real_active_profile;

    if (-l "$real_mutt_path/$active_profile") {
	# symlink exists
	$real_active_profile = readlink("$real_mutt_path/$active_profile");
    } else {
	# no symlink yet
	$real_active_profile = 0;
    }
    return $real_active_profile;
}

sub create_link {
    # the beef...
    my $real_mutt_path = shift;
    my $active_profile = shift;
    my $profile = shift;
    my $link;

    chdir($real_mutt_path);
    $link = read_link($real_mutt_path,$active_profile);
    unlink($active_profile) if ($link);
    if (symlink("$profile","$active_profile")) {
	return 1;
    } else {
	return 0;
    }
}

sub expand_tilde {
    my $dir = shift;

    # tilde expansion
    if ($dir =~ /~/) {
	$dir =~ s{ ^ ~( [^/]* ) }
	{ $1 ? (getpwnam($1))[7] : ($ENV{'HOME'} || $ENV{'LOGDIR'} || (getpwuid($>))[7]) }ex;
    }
    return($dir);
}

### documentation
__END__

=head1 NAME

muttprofile - Choose a Mutt Profile

=head1 SYNOPSIS

B<muttprofile> [-a|--active string] [-d|--dir directory] [-h|--help] [-p|--profile regexp] [-v|--view] [-V|--Version] [profile]

=head1 DESCRIPTION

B<muttprofile> is a simple utility to choose a profile to be used with Mutt email-client.
It has two operating modes: command-line and interactive. Muttprofile goes to interactive
mode if no command-line arguments are present or option -v|--view is present without profile name.

Muttprofile looks for profile files in the Mutt directory, opens them and looks for
NAME and DESC definitions. It then creates a symbolic link to the profile chosen by the user. 
The rest of the work is done with a Mutt macro.

=head1 USAGE

Interactive mode:

Type the name of the profile and the program creates a symlink to load the profile.
Press <tab> to complete, <ctrl-d> to see list of choices.

Command-line options:

B<-a | --active> Set the name for active profile symlink, default is profile.active

B<-d | --dir> Set the Mutt directory, default is ~/.mutt

B<-h | --help> prints a short help and exits

B<-p | --profile> (Perl) Regexp to match profile files in Mutt directory

B<-v | --view> Instead of creating a symlink, view profile contents

B<-V | --version> prints the version information and exits (use --version for long and -V for short version)

B<profile> if profile exits, create the symlink to load it from Mutt, otherwise exit with error

=head1 INSTALL

B<Muttprofile> requires no installation, but you might have to
check the first line of the file (C<#!/usr/bin/perl -w>)
and change the path to perl if needed (C<'which perl'> might be useful here :-)

=head1 SETTING UP PROFILES

B<Muttprofile> checks the profile files for the following information:

# NAME: name for your profile

# DESC: description of your profile

This information is used for choosing and displaying available profiles.
DESC is optional, but if NAME is missing, filename is used instead.

=head1 USING MUTTPROFILE FROM MUTT

Perhaps the easiest way to invoke B<muttprofile> from B<mutt> is to bind a
key with mutt macro command. For example, adding this to your F<muttrc>-file

macro	index	<F10>	"!muttprofile\n:source ~/.mutt/profile.active\nm" "New message with profile"

binds the function key <F10> to start muttprofile, load the profile and start a new message

=head1 EXIT CODES

The default exit codes for muttprofile are:

    0 OK
    1 PROFILE ALREADY ACTIVE
    2 ERROR

These codes can be used in shell scripts etc.

=head1 FURTHER INFORMATION

Discussion of profiles with Mutt: http://www.iki.fi/martti.rahkila/mutt/

Mutt home page: http://www.mutt.org

=head1 REQUIREMENTS

B<muttprofile> requires B<Mutt> (obviously :-) and
B<Perl> version 5 or later.

The required perl modules are C<Term::Complete>
and C<Getopt::Long> that both come with the Perl distribution.

Please note that the C<Term::Complete> module in Perl 5.8.0
may produce an error. This has been fixed in Perl 5.8.1.

=head1 LICENCE

B<muttprofile> is distibuted under GNU General Public Licence (GPL), same
as Mutt. For details, see http://www.gnu.org/copyleft/gpl.html

=head1 BUGS

No known bugs at the moment. Inevitably to appear sooner or later.

=head1 VERSION HISTORY

=item 1.0.1 (current)

Two bugfixes, details can be found from
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=218957
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=218960

Additional bugfix regarding a case when active profile
exist but is a file instead of symlink.

2003-11-20 Martti Rahkila

=item 1.0.0

First public release.

2000-05-10 Martti Rahkila

=head1 AUTHOR

  Martti Rahkila
  martti.rahkila@iki.fi
  http://www.iki.fi/martti.rahkila/mutt

=head1 SEE ALSO

L<mutt(1)|mutt>, L<perl(1)|perl>

=cut