source: main/tags/2.21/gsdl/perllib/ghtml.pm@ 33212

Last change on this file since 33212 was 1178, checked in by sjboddie, 24 years ago

modified perl dmsafe function to handle backslashes

  • Property svn:keywords set to Author Date Id Revision
File size: 12.6 KB
Line 
1###########################################################################
2#
3# ghtml.pm -- this used to be called html.pm but it clashed
4# with the existing html module under windows
5#
6# A component of the Greenstone digital library software
7# from the New Zealand Digital Library Project at the
8# University of Waikato, New Zealand.
9#
10# Copyright (C) 1999 New Zealand Digital Library Project
11#
12# This program is free software; you can redistribute it and/or modify
13# it under the terms of the GNU General Public License as published by
14# the Free Software Foundation; either version 2 of the License, or
15# (at your option) any later version.
16#
17# This program is distributed in the hope that it will be useful,
18# but WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20# GNU General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with this program; if not, write to the Free Software
24# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25#
26###########################################################################
27
28package ghtml;
29
30# htmlsafe(TEXT)
31#
32# Converts SGML meta characters in TEXT to entity references.
33#
34sub htmlsafe
35{
36 $_[0] =~ s/&/&/og;
37 $_[0] =~ s/</&lt;/og;
38 $_[0] =~ s/>/&gt;/og;
39}
40
41# urlsafe(TEXT)
42#
43# Converts characters not allowed in a URL to their hex representation.
44#
45sub urlsafe
46{
47 $_[0] =~ s/[\x09\x20\x22\x3c\x3e\x5b\x5c\x5d\x5e\x60\x7b\x7c\x7d\x7e\?\=\&\+_\/]/sprintf("%%%2x", ord($&))/ge;
48}
49
50# dmsafe
51#
52# Converts characters which could make display.pl or html crack to their entity references.
53# Don't use this on dm macros as they will no longer be recognisable by dm (which
54# by the way, is the whole idea).
55# -- Rodger 12/1/98
56sub dmsafe {
57 my ($s) = $_[0];
58 $s =~ s/&/&amp;/og; # for html
59 $s =~ s/</&lt;/og; # for html
60 $s =~ s/>/&gt;/og; # for html
61 $s =~ s/\_/&#095;/og; # for dm (we have a convention of starting macros with _
62 $s =~ s/\"/&quot;/og; # for html (don't want to be interpreted as a quote)
63 $s =~ s/\{/&#123;/og; # for dm blocks
64 $s =~ s/\}/&#125;/og; # for dm blocks
65 $s =~ s/\\/&#092;/og; # for dm (dm removes naturally occurring backquotes)
66 return $s;
67}
68
69
70# named entry to the standard html font
71%charnetosf = ("Agrave"=> "192", "Aacute"=> "193", "Acirc" => "194", "Atilde"=> "195",
72 "Auml" => "196", "Aring" => "197", "AElig" => "198", "Ccedil"=> "199",
73 "Egrave"=> "200", "Eacute"=> "201", "Ecirc" => "202", "Euml" => "203",
74 "Igrave"=> "204", "Iacute"=> "205", "Icirc" => "206", "Iuml" => "207",
75 "ETH" => "208", "Ntilde"=> "209", "Ograve"=> "210", "Oacute"=> "211",
76 "Ocirc" => "212", "Otilde"=> "213", "Ouml" => "214",
77 "Oslash"=> "216", "Ugrave"=> "217", "Uacute"=> "218", "Ucirc" => "219",
78 "Uuml" => "220", "Yacute"=> "221", "THORN" => "222", "szlig" => "223",
79 "agrave"=> "224", "aacute"=> "225", "acirc" => "226", "atilde"=> "227",
80 "auml" => "228", "aring" => "229", "aelig" => "230", "ccedil"=> "231",
81 "egrave"=> "232", "eacute"=> "233", "ecirc" => "234", "euml" => "235",
82 "igrave"=> "236", "iacute"=> "237", "icirc" => "238", "iuml" => "239",
83 "eth" => "240", "ntidle"=> "241", "ograve"=> "242", "oacute"=> "243",
84 "ocirc" => "244", "otilde"=> "245", "ouml" => "246",
85 "oslash"=> "248", "ugrave"=> "249", "uacute"=> "250", "ucirc" => "251",
86 "uuml" => "252", "yacute"=> "253", "thorn" => "254", "yuml" => "255");
87
88%symnetosf = ("quot" => "34", "amp" => "38", "lt" => "60", "gt" => "62",
89 "nbsp" => "160", "iexcl" => "161", "cent" => "162", "pound" => "163",
90 "curren"=> "164", "yen" => "165", "brvbar"=> "166", "sect" => "167",
91 "uml" => "168", "copy" => "169", "ordf" => "170", "laquo" => "171",
92 "not" => "172", "shy" => "173", "reg" => "174", "macr" => "175",
93 "deg" => "176", "plusmn"=> "177", "sup2" => "178", "sup3" => "179",
94 "acute" => "180", "micro" => "181", "para" => "182", "middot"=> "183",
95 "cedil" => "184", "sup1" => "185", "ordm" => "186", "raquo" => "187",
96 "frac14"=> "188", "frac12"=> "189", "frac34"=> "190", "iquest"=> "191",
97 "times" => "215", "divide"=> "247");
98
99
100
101# standard font to plain text
102%sftotxt = ("32" => " ", "33" => "!", "34" => "\"", "35" => "\#", "36" => "\$",
103 "37" => "\%", "38" => "&", "39" => "'", "40" => "(", "41" => ")",
104 "42" => "*", "43" => "+", "44" => ",", "45" => "-", "46" => ".",
105 "47" => "/", "48" => "0", "49" => "1", "50" => "2", "51" => "3",
106 "52" => "4", "53" => "5", "54" => "6", "55" => "7", "56" => "8",
107 "57" => "9", "58" => ":", "59" => ";", "60" => "<", "61" => "=",
108 "62" => ">", "63" => "?", "64" => "\@", "65" => "A", "66" => "B",
109 "57" => "9", "58" => ":", "59" => ";", "61" => "=",
110 "63" => "?", "64" => "\@", "65" => "A", "66" => "B",
111 "67" => "C", "68" => "D", "69" => "E", "70" => "F", "71" => "G",
112 "72" => "H", "73" => "I", "74" => "J", "75" => "K", "76" => "L",
113 "77" => "M", "78" => "N", "79" => "O", "80" => "P", "81" => "Q",
114 "82" => "R", "83" => "S", "84" => "T", "85" => "U", "86" => "V",
115 "87" => "W", "88" => "X", "89" => "Y", "90" => "Z", "91" => "[",
116 "92" => "\\", "93" => "]", "94" => "^", "95" => "_", "96" => "`",
117 "97" => "a", "98" => "b", "99" => "c", "100" => "d", "101" => "e",
118 "102" => "f", "103" => "g", "104" => "h", "105" => "i", "106" => "j",
119 "107" => "k", "108" => "l", "109" => "m", "110" => "n", "111" => "o",
120 "112" => "p", "113" => "q", "114" => "r", "115" => "s", "116" => "t",
121 "117" => "u", "118" => "v", "119" => "w", "120" => "x", "121" => "y",
122 "122" => "z", "123" => "{", "124" => "|", "125" => "}", "126" => "~",
123 "130" => ",", "131" => "f", "132" => "\"", "133" => "...", "139" => "<",
124 "140" => "OE", "145" => "'", "146" => "'", "147" => "\"", "148" => "\"",
125 "149" => "o", "150" => "--", "151" => "-", "152" => "~", "153" => "TM",
126 "155" => ">", "156" => "oe", "159" => "Y", "160" => " ", "178" => "2",
127 "179" => "3", "185" => "1", "188" => "1/4", "189" => "1/2", "190" => "3/4",
128 "192" => "A", "193" => "A", "194" => "A", "195" => "A", "196" => "A",
129 "197" => "A", "198" => "AE", "199" => "C", "200" => "E", "201" => "E",
130 "202" => "E", "203" => "E", "204" => "I", "205" => "I", "206" => "I",
131 "207" => "I", "208" => "D", "209" => "N", "210" => "O", "211" => "O",
132 "212" => "O", "213" => "O", "214" => "O", "215" => "*", "216" => "O",
133 "217" => "U", "218" => "U", "219" => "U", "220" => "U", "221" => "Y",
134 "223" => "ss", "224" => "a", "225" => "a", "226" => "a", "227" => "a",
135 "228" => "a", "229" => "a", "230" => "ae", "231" => "c", "232" => "e",
136 "233" => "e", "234" => "e", "235" => "e", "236" => "i", "237" => "i",
137 "238" => "i", "239" => "i", "241" => "n", "242" => "o", "243" => "o",
138 "244" => "o", "245" => "o", "246" => "o", "247" => "/", "248" => "o",
139 "249" => "u", "250" => "u", "251" => "u", "252" => "u", "253" => "y",
140 "255" => "y", "8218" => ",");
141
142
143# returns the character in the standard html font. It assumes that the
144# & and ; have been stripped off the string.
145sub getcharequiv {
146 my ($entity, $convertsymbols) = @_;
147
148 # replace &#8218 with comma (",")
149 $entity =~ s/8218/044/;
150
151 # a numeric entity
152 if ($entity =~ /^\#0*(\d+)/) {
153 return pack("c", $1);
154 }
155
156 # a named character entity
157 if (defined $charnetosf{$entity}) {
158 return pack("c", $charnetosf{$entity});
159 }
160
161 # a named symbol entity
162 if ($convertsymbols && defined $symnetosf{$entity}) {
163 return pack("c", $symnetosf{$entity});
164 }
165
166 return "&$entity;"; # unknown character
167}
168
169# convert character entities from named equivalents to html font
170sub convertcharentities {
171 # args: the text that you want to convert
172
173 $_[0] =~ s/&([^;]+);/&getcharequiv($1,0)/ge;
174}
175
176# convert any entities from named equivalents to html font
177sub convertallentities {
178 # args: the text that you want to convert
179
180 $_[0] =~ s/&([^;]+);/&getcharequiv($1,1)/ge;
181}
182
183sub html2txt {
184 # args: the text that you want converted to ascii,
185 # and whether to strip out sgml tags
186
187 # strip out sgml tags if needed
188 $_[0] =~ s/<[^>]>//g if $_[1];
189
190 # convert the char entities to the standard html font
191 &convertcharentities($_[0]);
192
193 # convert the html character set to a plain ascii character set
194 my $pos = 0;
195 while ($pos < length($_[0])) {
196 my $charnum = ord(substr($_[0], $pos, 1));
197 if ($charnum >= 32) { # only convert characters above #32
198 my $replacechars = " ";
199 $replacechars = $sftotxt{$charnum} if defined $sftotxt{$charnum};
200 substr($_[0], $pos, 1) = $replacechars;
201 $pos += length ($replacechars);
202
203 } else {
204 $pos ++;
205 }
206 }
207}
208
209
210sub guess_mime_type {
211 my ($filename) = @_;
212
213 my ($fileext) = $filename =~ /\.(\w+)$/;
214 return "unknown" unless defined $fileext;
215
216 my %mime_type = ("ai"=>"application/postscript", "aif"=>"audio/x-aiff",
217 "aifc"=>"audio/x-aiff", "aiff"=>"audio/x-aiff",
218 "au"=>"audio/basic", "avi"=>"video/x-msvideo",
219 "bcpio"=>"application/x-bcpio", "bin"=>"application/octet-stream",
220 "cdf"=>"application/x-netcdf", "class"=>"application/octet-stream",
221 "cpio"=>"application/x-cpio", "cpt"=>"application/mac-compactpro",
222 "csh"=>"application/x-csh", "dcr"=>"application/x-director",
223 "dir"=>"application/x-director", "dms"=>"application/octet-stream",
224 "doc"=>"application/msword", "dvi"=>"application/x-dvi",
225 "dxr"=>"application/x-director", "eps"=>"application/postscript",
226 "etx"=>"text/x-setext",
227 "exe"=>"application/octet-stream", "gif"=>"image/gif",
228 "gtar"=>"application/x-gtar", "hdf"=>"application/x-hdf",
229 "hqx"=>"application/mac-binhex40", "htm"=>"text/html",
230 "html"=>"text/html", "ice"=>"x-conference/x-cooltalk",
231 "ief"=>"image/ief", "jpe"=>"image/jpeg",
232 "jpeg"=>"image/jpeg", "jpg"=>"image/jpeg",
233 "kar"=>"audio/midi", "latex"=>"application/x-latex",
234 "lha"=>"application/octet-stream", "lzh"=>"application/octet-stream",
235 "man"=>"application/x-troff-man", "mcf"=>"image/vasa",
236 "me"=>"application/x-troff-me", "mid"=>"audio/midi",
237 "midi"=>"audio/midi", "mif"=>"application/x-mif",
238 "mov"=>"video/quicktime", "movie"=>"video/x-sgi-movie",
239 "mp2"=>"audio/mpeg", "mpe"=>"video/mpeg",
240 "mpeg"=>"video/mpeg", "mpg"=>"video/mpeg",
241 "mpga"=>"audio/mpeg", "ms"=>"application/x-troff-ms",
242 "nc"=>"application/x-netcdf", "oda"=>"application/oda",
243 "pbm"=>"image/x-portable-bitmap", "pdb"=>"chemical/x-pdb",
244 "pdf"=>"application/pdf", "pgm"=>"image/x-portable-graymap",
245 "png"=>"image/png", "pnm"=>"image/x-portable-anymap",
246 "ppm"=>"image/x-portable-pixmap", "ppt"=>"application/powerpoint",
247 "ps"=>"application/postscript", "qt"=>"video/quicktime",
248 "ra"=>"audio/x-realaudio", "ram"=>"audio/x-pn-realaudio",
249 "ras"=>"image/x-cmu-raster", "rgb"=>"image/x-rgb",
250 "roff"=>"application/x-troff", "rpm"=>"audio/x-pn-realaudio-plugin",
251 "rtf"=>"application/rtf", "rtx"=>"text/richtext",
252 "sgm"=>"text/x-sgml", "sgml"=>"text/x-sgml",
253 "sh"=>"application/x-sh", "shar"=>"application/x-shar",
254 "sit"=>"application/x-stuffit", "skd"=>"application/x-koan",
255 "skm"=>"application/x-koan", "skp"=>"application/x-koan",
256 "skt"=>"application/x-koan", "snd"=>"audio/basic",
257 "src"=>"application/x-wais-source", "sv4cpio"=>"application/x-sv4cpio",
258 "sv4crc"=>"application/x-sv4crc", "t"=>"application/x-troff",
259 "tar"=>"application/x-tar", "tcl"=>"application/x-tcl",
260 "tex"=>"application/x-tex", "texi"=>"application/x-texinfo",
261 "texinfo"=>"application/x-texinfo", "tif"=>"image/tiff",
262 "tiff"=>"image/tiff", "tr"=>"application/x-troff",
263 "tsv"=>"text/tab-separated-values", "txt"=>"text/plain",
264 "ustar"=>"application/x-ustar", "vcd"=>"application/x-cdlink",
265 "vrml"=>"x-world/x-vrml", "wav"=>"audio/x-wav",
266 "wrl"=>"x-world/x-vrml", "xbm"=>"image/x-xbitmap",
267 "xpm"=>"image/x-xpixmap", "xwd"=>"image/x-xwindowdump",
268 "xyz"=>"chemical/x-pdb", "zip"=>"application/zip");
269
270 return $mime_type{$fileext} if (defined $mime_type{$fileext});
271
272 return "unknown";
273}
274
275
2761;
Note: See TracBrowser for help on using the repository browser.