This file is indexed.

/usr/sbin/ispell-autobuildhash is in dictionaries-common 1.26.3.

This file is owned by root:root, with mode 0o755.

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
#!/usr/bin/perl -w
#
#  script for ispell hash autorebuild in Debian systems
#
# Copyright 2003-2015 Agustin Martin Domingo <agmartin@debian.org>
#
# 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 3 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.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------

use strict;
use Debian::DictionariesCommon qw(dico_checkroot dico_activate_trigger);
use Debconf::Client::ConfModule q(:all);
use Getopt::Long;

my $debug;
my $dry_run;
my $force;
my $triggered;
my $program      = "ispell-autobuildhash";
my $varlibdir    = "/var/lib/ispell";
my $compatdir    = "/var/lib/ispell";
my $usrlibdir    = "/usr/lib/ispell";
my $usrsharedir  = "/usr/share/ispell";

# Set tmpdir base, honouring TMPDIR. Real tmpdir is set after options parsing.
my $tmpdir_base  = $ENV{'TMPDIR'} || '/tmp';
my $tmpdir;

# ---------------------------------------------------------------------
sub usage {
# ---------------------------------------------------------------------
  print STDERR "\nUsage:\tispell-autobuildhash [options]\n"
    . "\n"
    . "Options:\n"
    . "\t--debug         Show ispell-autobuildhash debugging information.\n"
    . "\t--dry-run       Show what would be done, but do nothing real.\n"
    . "\t--force         Do the job regardless of versions comparisons.\n"
    . "\t--triggered     Tell the script that is run in the triggers stage.\n";
}

# ---------------------------------------------------------------------
sub debugprint {
# ---------------------------------------------------------------------
  print STDERR "@_\n" if $debug;
}

# ---------------------------------------------------------------------
sub mymessage{
# ---------------------------------------------------------------------
  my $dict     = shift;
  my $message  = join(" ",@_);
  my $question = "dictionaries-common/ispell-autobuildhash-message";

  subst($question,"xxpell","ispell");
  subst($question,"XXpell","Ispell");
  subst($question,"hashfile",$dict);
  subst($question,"errormsg",$message);
  fset ($question,"seen","false");
  title("dictionaries-common: Running ispell-autobuildhash");
  input("critical",$question);
  go ();
}

sub old_myerror {
  my $dict = shift;
  print "
** Error: @_

This error was caused by package providing hash $dict, although it
can be made evident during other package postinst. Please complain
to the maintainer of package providing hash $dict. In the meantime
you might need to remove package providing $dict.hash\n";
  &auto_clean;
  exit 1;
}

# ---------------------------------------------------------------------
sub myerror {
# ---------------------------------------------------------------------
  my $dict = shift;
  mymessage $dict,@_;
}

# ---------------------------------------------------------------------
sub auto_clean {
# ---------------------------------------------------------------------
  if ( -d $tmpdir ){
    unlink <$tmpdir/*>;
    rmdir $tmpdir;
  }
}

# ---------------------------------------------------------------------
#      Handle autorebuilding
# ---------------------------------------------------------------------

sub autorebuild {
  my $dict            = shift;                       # The dictionary name
  my $old_remove_data = shift;
  my $zmwl            = "$usrsharedir/$dict.mwl.gz"; # the compressed munched wordlist
  my $aff             = "$usrlibdir/$dict.aff";      # the aff file
  my $hash            = "$varlibdir/$dict.hash";     # the hash file
  my $link            = "$usrlibdir/$dict.hash";     # the link to the hash
  my $desc            = "$usrlibdir/$dict.desc";     # the .desc file
  my %new_remove_data = ();

  die "$program: No argument passed to function autorebuild.\n" unless $dict;

  print STDERR "ispell-autobuildhash: Processing \'$dict\' dict.\n";

  foreach my $entry ( keys %{$old_remove_data} ){
    $new_remove_data{'remove'}{$entry}++;
    $new_remove_data{'fake-remove'}{$entry}++;
  }

  my $tempfile = "$tmpdir/$dict.mwl";
  if ( -e $aff ){
    if ( -e $zmwl ){
      # ispell does not accept this from a pipe. Need explicit files.
      my $gzip_cmd  = "gzip -dc $zmwl > $tempfile";
      my $build_cmd = "buildhash -s $tempfile $aff $hash";
      if ( $dry_run ) {
	print STDERR "$gzip_cmd\n";
	print STDERR "$build_cmd\n";
	$new_remove_data{'fake-remove'}{"$hash"}++;
	$new_remove_data{'fake-remove'}{"$link"}++;
      } else {
	debugprint("$gzip_cmd");
	system ("$gzip_cmd") == 0
	  or myerror($dict,"Could not gunzip the munched wordlist for $dict");
	debugprint("$build_cmd");
	if ( system ("$build_cmd") == 0 ){
	  $new_remove_data{'remove'}{$hash}++;
	  if ( -w  "$usrlibdir" ){
	    symlink($hash,$link) unless -e $link;
	  } else {
	    print STDERR "$program warning: Non writable \"$usrlibdir\". Not setting symlink";
	  }
	  if ( -l "$link" ){
	    # Make sure link is recorded
	    $new_remove_data{'remove'}{"$link"}++;
	  }
	} else {
	  myerror($dict,"Could not build the hash file for $dict") ;
	}
      }
    } elsif ( -e $desc ) {
      if ( -x "/usr/sbin/update-ispell-hash" ) {
	my $cmd = "update-ispell-hash -d $dict > /dev/null";
	if ( $dry_run ) {
	  print STDERR "$cmd\n";
	  $new_remove_data{'fake-remove'}{$hash}++;
	  $new_remove_data{'fake-remove'}{"$link"}++;
	} else {
	  debugprint("$cmd");
	  if ( system ("$cmd") == 0 ){
	    if ( -w  "$usrlibdir" ){
	      symlink($hash,$link) unless -e $link;
	    } else {
	      print STDERR "$program warning: Non writable \"$usrlibdir\". Not setting symlink";
	    }
	    if ( -l "$link" ){
	      # Make sure link is recorded
	      $new_remove_data{'remove'}{"$link"}++;
	    }
	  } else {
	    myerror($dict,"Problems running update-ispell-hash for $dict");
	  }
	}
	debugprint "Found and run update-ispell-hash";
      } elsif ( -x "/usr/sbin/update-ipolish-hash" ) {
	my $cmd = "update-ipolish-hash -d $dict > /dev/null";
	if ( $dry_run ) {
	  print STDERR "$cmd\n";
	  $new_remove_data{'fake-remove'}{$hash}++;
	  $new_remove_data{'fake-remove'}{"$link"}++;
	} else {
	  debugprint("$cmd");
	  if ( system ("$cmd") == 0 ){
	    $new_remove_data{'remove'}{$hash}++;
	    if ( -w  "$usrlibdir" ){
	      symlink($hash,$link) unless -e $link;
	    } else {
	      print STDERR "$program warning: Non writable \"$usrlibdir\". Not setting symlink";
	    }
	    if ( -l "$link" ){
	      # Make sure link is recorded
	      $new_remove_data{'remove'}{"$link"}++;
	    }
	  } else {
	    myerror($dict,"Problems running update-ipolish-hash for $dict");
	  }
	}
	debugprint "Found and run update-ipolish-hash";
      } else {
	myerror($dict,"Could not find any of update-ispell-hash, update-ipolish-hash");
      }
    } else {
      myerror($dict,"Could not find $zmwl");
    }
  } else {
    myerror $dict,"Could not find affix file $aff";
  }
  $new_remove_data{'status'} = "ok";
  return \%new_remove_data;
}

# ---------------------------------------------------------------------
#                   Get ispell compat version
# ---------------------------------------------------------------------

sub get_ispell_compat {
  my $ispell_compat;
  my $ispellcompatfile = "/usr/share/ispell/ispell.compat";

  if ( -e $ispellcompatfile ){
    open (my $COMPAT,"$ispellcompatfile");
    chomp ( $ispell_compat = <$COMPAT> );
    close $COMPAT;
  } elsif ( system("which ispell > /dev/null 2>&1") == 0 ){
    $ispell_compat = (split(" ",`ispell -v | head -n 1`))[4];
  }

  return $ispell_compat;
}

# ---------------------------------------------------------------------
#                        The main program
# ---------------------------------------------------------------------

# Options processing
GetOptions ('debug'     => \$debug,
	    'dry-run'   => \$dry_run,
	    'force'     => \$force,
	    'triggered' => \$triggered
  ) or usage();

# Check if we are root
dico_checkroot() unless $dry_run;

# Honour 'DICT_COMMON_DEBUG' environment variable.
unless ( $debug ){
  $debug++ if defined $ENV{'DICT_COMMON_DEBUG'};
}

unless ( $triggered or $force ){
  exit if dico_activate_trigger("ispell-autobuildhash");
}

# Prepare temporary directory
$tmpdir = `mktemp -d "$tmpdir_base/ispell-auto.XXXXXXXXXX"`
      or die "ispell-autobuildhash: Cannot make temporary directory under \"$tmpdir_base\". Aborting ...\n";
chomp $tmpdir;

$SIG{INT}     = \&auto_clean;
$SIG{KILL}    = \&auto_clean;
$SIG{TERM}    = \&auto_clean;
$SIG{__DIE__} = \&auto_clean;

print STDERR "$program: Using temporary directory \"$tmpdir\"\n"
  if $debug;

if ( my $ispell_compat = get_ispell_compat() ){
  foreach my $dict ( <$compatdir/*.compat> ){
    my $dict_compat     = "forced";
    my %old_remove_data = ();

    $dict =~ s/\.compat$//;
    $dict =~ s/.*\///;

    my $remove_file     = "$varlibdir/$dict.remove";

    # Parse dict compat file if available.
    unless ( $force ) {
      open (my $COMPAT,"$compatdir/$dict.compat");
      $dict_compat = <$COMPAT>;
      close $COMPAT;
      chomp $dict_compat if $dict_compat;
      $dict_compat = 0 unless $dict_compat;
    }

    # Parse dict remove file if available
    if ( -e "$remove_file" ){
      open (my $REMOVE,"$remove_file");
      while (<$REMOVE>){
	chomp;
	next if m/^\s*$/;
	s/^\s+//;
	s/\s+$//;
	if ( -e "$_" ){
	  $old_remove_data{$_}++;
	} else {
	  debugprint "$program: \"$_\" in $remove_file not found. Upgrading info.";
	}
      }
      close $REMOVE;
    }

    if ($force || $ispell_compat ne $dict_compat) {
      print STDERR "--\n" if ( $debug or $dry_run );
      debugprint "$dict => ispell_compat: [$ispell_compat]; dict_compat: [$dict_compat]";

      my $new_remove_data = autorebuild("$dict",\%old_remove_data);
      if ( defined $new_remove_data->{'status'} ) {
	if ( $dry_run ){
	  print STDERR "$ispell_compat > $compatdir/$dict.compat\n";
	  print STDERR "Remove: \n", join("\n",sort keys %{$new_remove_data->{'fake-remove'}}) ,"\n";
	} else {
	  # Update compat file
	  open (my $COMPAT,">","$compatdir/$dict.compat");
	  print $COMPAT "$ispell_compat\n";
	  close $COMPAT;
	  debugprint "Updated $compatdir/$dict.compat to $ispell_compat";
	  # Update remove file
	  open (my $REMOVE,">","$remove_file")
	    or die "$program: Could not open \"$remove_file\" for write.";
	  print $REMOVE join("\n",sort keys %{$new_remove_data->{'remove'}}),"\n";
	  close $REMOVE;
	}
      } else {
	debugprint " --- $program: $compatdir/$dict.compat not updated because of an error";
      }
    }
  }
} else {
  debugprint "$program: no ispell compat info. ispell may not be installed. Aborting ...\n";
}

&auto_clean unless $debug;

__END__

=head1 NAME

B<ispell-autobuildhash> - Autobuilding the ispell hash file for some dicts

=head1 SYNOPSIS

 ispell-autobuildhash [--force]

   Options:
    --debug      Show some extra ispell-autobuildhash information.
    --dry-run    Show what would be done, but do nothing real.
    --force      Rebuild the hash file for all dicts providing a
                 compat file skipping the test.
    --triggered  Tell the script that is run in the triggers stage.

=head1 DESCRIPTION

B<ispell-autobuildhash> is a script that will manage ispell hash files
autobuild, intended to be called from the dictionaries-common tools.
Depending on the ispell
compatibility level and on the compatibility level used for the hash file
if present, will decide whether it must be rebuilt or not. This script will
only work on ispell packages prepared to use it, it will do nothing for other
ispell dict packages.

=head1 OPTIONS

 --debug      Show some extra ispell-autobuildhash information.
 --dry-run    Show what would be done, but do nothing real.
 --force      Rebuild the hash file for all dicts providing a compat
              file regardless of the compatibility levels found.
 --triggered  Tell the script that is run in the triggers stage. When
              run under dpkg control, do not try to set the
              'ispell-autobuildhash' trigger, but run real
              B<ispell-autobuildhash> code. When not run under dpkg
              control, real code will always be run and '--triggered'
              option has no real effect.

=head1 PACKAGE MAINTAINERS

To use this system, B<ispell-autobuildhash> expects a F<$dict.compat> file
in F</var/lib/ispell> (I<$dict> stands for the hash or affix file basename)
containing ispell major or compatibility version for last successful build
or "0" or en empty file if hash is to be rebuild, as is for dictionary
instalation and upgrades.

When upgrading B<ispell>, script will check if version in I<$dict.compat>
is different from I<ispell.compat> and rebuild if so, updating
I<$dict.compat> with the new value. The particular way things are done depends
on whether your dict has a single source or a multiple source like ipolish has.

The most common case is having a single source. In this case you must put
the F<$dict.aff> file at F</usr/lib/ispell/$dict.aff> as usual and the munched
wordlist compressed with gzip at F</usr/share/ispell/$dict.mwl.gz>.

This script supports the way ipolish allows selection of subdictionaries
to be put in the hash file. It will detect the presence of  the main
language .desc file and call update-ipolish-hash as appropriate.

Although this script looks for the existence of a update-ispell-hash script
with supposedly similar functionality to update-ipolish-hash, this latter
does not really exists, although it might be added at some time to ispell or
to the dictionaries-common system, if enough demand is found.

If your package provides more than one ispell dictionary you will need to
do the steps above for each dictionary.

Dictionaries-common scripts will call internally this script and create a
hash file at F</var/lib/ispell/$dict.hash>. You must set a symlink to that
file from F</usr/lib/ispell/$dict.hash>.

Ispell dictionary packages using this script must make sure that
I<$dict.compat> is reset on every new install/upgrade, so hash is rebuilt.
They must also make sure that I<$dict.compat> and F</var/lib/ispell/$dict.hash>
are removed on package removal

As of version C<1.10>, B<installdeb-ispell> script will understand
C<'auto-compat'> field in F<$dict.info-ispell> file to help with this by
adding needed debhelper snippets. Put in that entry the base name(s) of
your compat file(s) and check resulting maintainer scripts after build.

Note that you are no longer suggested to ship empty files at
F</var/lib/ispell/$dict.compat> and F</var/lib/ispell/$dict.hash> to help
with reset/removal of those files, but explicitly create/update them on
install and explicitly remove them on removal.

B<ispell> maintainer should also call this script from package postinst.
When comparing versions it will get the ispell version from file
F</usr/share/ispell/ispell.compat>, or if it does not exists, from the
upstream version as given in the first line of 'B<ispell -vv> output.

=head1 AUTHOR

Agustin Martin <agmartin@debian.org>

=head1 COPYRIGHT

Copyright (C) 2003-2013 Agustin Martin <agmartin@debian.org>

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 3 of the License, or
(at your option) any later version.

=cut