highlight: Make location of highlight's files configurable in setup file to allow...
authorJoey Hess <joey@kitenet.net>
Mon, 30 Aug 2010 17:15:49 +0000 (13:15 -0400)
committerJoey Hess <joey@kitenet.net>
Mon, 30 Aug 2010 17:15:49 +0000 (13:15 -0400)
IkiWiki/Plugin/highlight.pm
debian/changelog
doc/bugs/Highlight_extension_uses_hard_coded_paths.mdwn

index e517ac5c06aa425771dcac7256a8e3127da8d3bb..d4ade0a7b3f788c71472c82b1e359b5572731d74 100644 (file)
@@ -6,10 +6,6 @@ use strict;
 use IkiWiki 3.00;
 use Encode;
 
-# locations of highlight's files
-my $filetypes="/etc/highlight/filetypes.conf";
-my $langdefdir="/usr/share/highlight/langDefs";
-
 sub import {
        hook(type => "getsetup", id => "highlight",  call => \&getsetup);
        hook(type => "checkconfig", id => "highlight", call => \&checkconfig);
@@ -32,9 +28,29 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
+               filetypes_conf => {
+                       type => "string",
+                       example => "/etc/highlight/filetypes.conf",
+                       description => "location of highlight's filetypes.conf",
+                       safe => 0,
+                       rebuild => undef,
+               },
+               langdefdir => {
+                       type => "string",
+                       example => "/usr/share/highlight/langDefs",
+                       description => "location of highlight's langDefs directory",
+                       safe => 0,
+                       rebuild => undef,
+               },
 }
 
 sub checkconfig () {
+       if (! exists $config{filetypes_conf}) {
+               $config{filetypes_conf}="/etc/highlight/filetypes.conf";
+       }
+       if (! exists $config{langdefdir}) {
+               $config{langdefdir}="/usr/share/highlight/langDefs";
+       }
        if (exists $config{tohighlight}) {
                foreach my $file (split ' ', $config{tohighlight}) {
                        my @opts = $file=~s/^\.// ?
@@ -80,7 +96,7 @@ my %highlighters;
 
 # Parse highlight's config file to get extension => language mappings.
 sub read_filetypes () {
-       open (IN, $filetypes) || error("$filetypes: $!");
+       open (IN, $config{filetypes_conf}) || error("$config{filetypes_conf}: $!");
        while (<IN>) {
                chomp;
                if (/^\$ext\((.*)\)=(.*)$/) {
@@ -97,12 +113,12 @@ sub read_filetypes () {
 sub ext2langfile ($) {
        my $ext=shift;
 
-       my $langfile="$langdefdir/$ext.lang";
+       my $langfile="$config{langdefdir}/$ext.lang";
        return $langfile if exists $highlighters{$langfile};
 
        read_filetypes() unless $filetypes_read;
        if (exists $ext2lang{$ext}) {
-               return "$langdefdir/$ext2lang{$ext}.lang";
+               return "$config{langdefdir}/$ext2lang{$ext}.lang";
        }
        # If a language only has one common extension, it will not
        # be listed in filetypes, so check the langfile.
index d5587bfce45e3f3742b436874473639b24944843..0d36a735228c4ae6182d35b4e7ff976db829bd7e 100644 (file)
@@ -11,6 +11,8 @@ ikiwiki (3.20100816) UNRELEASED; urgency=low
   * style.css: Use relative, not absolute font sizes. Thanks, Giuseppe Bilotta.
   * htmlscrubber: Do not scrub url anchors that contain colons.
   * Danish translation update. Closes: #594673
+  * highlight: Make location of highlight's files configurable in setup
+    file to allow for nonstandard installations.
 
  -- Joey Hess <joeyh@debian.org>  Sun, 15 Aug 2010 11:45:48 -0400
 
index 1b9cb2e2d42377f8499792c34c9665610a0b2cf8..275661fb89cca3775cf43a83f1569513ad77708f 100644 (file)
@@ -1 +1,3 @@
 The [[plugins/highlight]] plugin hard codes some paths up the top of the plugin.  This means that you need to edit the ikiwiki source if you have highlight installed in a non-standard location (e.g. if you have done a user-level install of the highlight package).
+
+> configurable now, [[done]] --[[Joey]]