modperl branch collapsed back to MAIN trunk, man!
[www.jankratochvil.net.git] / project / captive / Index.html.pl
1 #! /usr/bin/perl
2
3 # $Id$
4 # Main page of 'My::Project::captive'
5 # Copyright (C) 2003 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
6
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; exactly version 2 of June 1991 is required
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20
21 package project::captive::Index;
22 require 5.6.0;  # at least 'use warnings;' but we need some 5.6.0+ modules anyway
23 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
24 our $CVS_ID=q$Id$;
25 use strict;
26 use warnings;
27
28 BEGIN{ open F,"Makefile"; our $top_dir=pop @{[split /\s/,(grep /^top_srcdir/,<F>)[0]]}; eval "use lib '$top_dir'"; close F; }
29 use My::Web;
30 Wuse 'My::Project';
31 Wuse 'project::captive::ListItem';
32
33
34 # Redirect foreign visitors to our root with that disgusting introduction ad.
35 {
36         my $r=Apache->request();
37         if (my $referer=$r->header_in("Referer")) {
38                 Wuse 'WebConfig';
39                 require URI;
40                 my $refuri=URI->new_abs($referer,$r->uri());
41                 if (1
42                                 && $refuri->host() ne "localhost"
43                                 && $refuri->host() ne &{$WebConfig::WebConfig{"web_hostname_sub"}}) {
44                         use Apache::Constants qw(REDIRECT);
45                         $r->status(REDIRECT);
46                         $r->header_out("Location"=>"http://".&{$WebConfig::WebConfig{"web_hostname_sub"}}());
47                         exit 0;
48                         }
49                 }
50         }
51
52
53 my $W=My::Project->init_project(
54                 "__PACKAGE__"=>__PACKAGE__,
55                 "ListItem"=>\@project::captive::ListItem::ListItem,
56                 "no_project_data"=>1,
57                 "head_css"=>"
58 .reqpkg { font-style: italic; }
59 .stuff  { font-style: italic; font-size: larger; margin-left: 20%; margin-right: 10%; }
60 .re     { font-style: italic; }
61 table.mailman > * /* FIXME: What is it? */ > tr > th,
62 table.mailman > * /* FIXME: What is it? */ > tr > td { padding: 1ex; text-align: center; }
63 ",
64                 );
65
66
67 print <<"HERE";
68 <h1>The First Read/Write NTFS for Free Operating Systems</h1>
69 <h1>The First Open Source MS-Windows Kernel API for Free OS</h1>
70 HERE
71
72 my @stuff=(
73                 "A lot of people claim to be Windows Programmers.\n"
74                                 ." Now, I can join them at last - I have also written my own Microsoft Windows.",
75                 "Why do they need ".a_href('http://www.winsupersite.com/reviews/winserver2k3_gold2.asp','5,000 developers')
76                                 ." to write Microsoft Windows when it can be just a One Man Show?",
77
78
79
80                 "My first Microsoft Windows program ever written? Some 'helloworld'?"
81                                 ." <span class=\"quote\">hal.dll</span>.",
82                 );
83
84 print rightimg((map("<p class=\"stuff\">$_</p>\n",($stuff[int rand @stuff])))[0],
85                 'captive-install-acquire-small','[ Captive Microsoft Windows Drivers Acquire Illustration ]',
86                                 "a_href_img"=>'captive-install-acquire');
87
88 print <<"HERE";
89
90
91 @{[ vskip "3ex" ]}
92
93 <p class="stuff">
94         Why did I install Microsoft Windows and write such a disgusting piece of code?<br />
95         Expecting @{[ a_href $W->{"resume_url"},"yet another challenging task" ]}!
96 </p>
97
98 @{[ vskip "3ex" ]}
99
100
101 <table border="1" align="center" style="text-align: center;" width="100%"><tr><th>Distribution</th>
102                 <th>Installation Case #1<br />Filesystem and installer<br />(recommended)</th>
103                 <th>Installation Case #2<br />Manual installation<br />(filesystem, expert user)</th>
104                 <th>Installation Case #3<br />Command-line client<br />(no filesystem access)</th></tr>
105 HERE
106 my %pkg=(
107                 1=>[qw(captive captive-lufs captive-install lufs gnome-vfs-httpcaptive ntfsprogs ntfsprogs-gnomevfs)],
108                 2=>[qw(captive captive-lufs                 lufs)],
109                 3=>[qw(captive)],
110                 );
111 my %reqpkg=(
112                 1 =>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt readline libgnomeui)],
113                 23=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt readline)],
114                 );
115 my %version=(
116                 map(($_=>["1.0","0"]),qw(captive captive-lufs captive-install)),
117                 "lufs"=>["0.9.6","1captive6"],
118                 "gnome-vfs-httpcaptive"=>["2.3.8captive2","0"],
119                 "ntfsprogs"=>["200309071734","1captive1"],
120                 "ntfsprogs-gnomevfs"=>["1.0.2","0"],
121                 );
122 my %has_rh8=(map(($_=>1),qw(
123                 gnome-vfs-httpcaptive
124                 captive
125                 captive-lufs
126                 captive-install
127                 )));
128 my %has_mdk91=(map(($_=>1),qw(
129                 gnome-vfs-httpcaptive
130                 lufs
131                 captive
132                 captive-lufs
133                 captive-install
134                 )));
135 my %has_devel=(map(($_=>1),qw(
136                 ntfsprogs
137                 )));
138 my %pkg_nosrc=(map(($_=>1),qw(
139                 captive-lufs
140                 captive-install
141                 )));
142
143 my $case;
144 my $a_href_arch=sub ($$%)
145 {
146 my($file_base,$text,%args)=@_;
147
148         $text=~s/[._]\D.*$// if $case!=1 && $text!~/^[.]/;
149         return a_href $file_base,$text,"size"=>($case==1),%args;
150 };
151
152 my @libxml2_rh8_pkgs=qw(libxml2-2.5.4-1.i386.rpm libxml2-python-2.5.4-1.i386.rpm libxml2-devel-2.5.4-1.i386.rpm);
153
154 my @dist=(
155                 {
156                         "name"=>"Red Hat 9<br />Shrike i386",
157                         "out"=>sub {
158                                 my($pkg,$version_base,$version_ext)=@_;
159                                         my $file="$pkg-$version_base-$version_ext.i386.rpm";
160                                         my $r=&$a_href_arch("dist/$file",$file);
161                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
162                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
163                                         return $r;
164                                 },
165                         },
166                 {
167                         "name"=>"Red Hat 8<br />Psyche i386<br />"
168                                         ."(".a_href("#libxml2_rh8","libxml2 upgrade note").")",
169                         "out"=>sub {
170                                 my($pkg,$version_base,$version_ext)=@_;
171                                         my $file="$pkg-$version_base-$version_ext".(!$has_rh8{$pkg} ? "" : "rh8").".i386.rpm";
172                                         my $r=&$a_href_arch("dist/$file",$file);
173                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
174                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
175                                         if ($pkg eq "captive-install") {
176                                                 for (@libxml2_rh8_pkgs) {
177                                                         $r.="<br />".&$a_href_arch('ftp://ftp.redhat.com/pub/redhat/linux/9/en/os/i386/RedHat/RPMS/'.$_,$_)." of Red Hat 9";
178                                                         }
179                                                 }
180                                         return $r;
181                                 },
182                         },
183                 {
184                         "name"=>"Mandrake 9.1<br />Bamboo i586",
185                         "out"=>sub {
186                                 my($pkg,$version_base,$version_ext)=@_;
187                                         my $file="$pkg-$version_base-$version_ext".(!$has_mdk91{$pkg} ? ".i386.rpm" : "mdk91.i586.rpm");
188                                         my $r=&$a_href_arch("dist/$file",$file);
189                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
190                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
191                                         return $r;
192                                 },
193                         },
194                 {
195                         "name"=>"Debian GNU/Linux<br />'unstable' i386",
196                         "out"=>sub {
197                                 my($pkg,$version_base,$version_ext)=@_;
198                                         $version_ext=~s/^\d+//;
199                                         my $file="${pkg}_$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext)."_i386.deb";
200                                         my $r=&$a_href_arch("dist/$file",$file);
201                                         (my $filedev=$file)=~s/^\Q$pkg\E_/${pkg}-dev_/;
202                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
203                                         return $r;
204                                 },
205                         },
206                 {
207                         "name"=>"Sources (.tar.gz)",
208                         "out"=>sub {
209                                 my($pkg,$version_base,$version_ext)=@_;
210                                         return () if $pkg_nosrc{$pkg};
211                                         $version_ext=~s/^\d+//;
212                                         my $file="$pkg-$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext).".tar.gz";
213                                         return $file,$file;
214                                 },
215                         },
216                 {
217                         "name"=>"Sources (.src.rpm)<br />(Red Hat 9 - Shrike)",
218                         "out"=>sub {
219                                 my($pkg,$version_base,$version_ext)=@_;
220                                         return () if $pkg_nosrc{$pkg};
221                                         my $file="$pkg-$version_base-$version_ext.src.rpm";
222                                         return $file,$file;
223                                 },
224                         },
225                 );
226
227 for my $dist (@dist) {
228         print "<tr>";
229                 print "<td>".$dist->{"name"}."</td>";
230                 for my $casel (1,2,3) {
231                         $case=$casel;
232                         print "<td>";
233                         print join("<br />",map({ my $pkg=$_;
234                                 my($file,$text)=&{$dist->{"out"}}($pkg,@{$version{$pkg}});
235                                 (!defined $text ? ($file) || () : (&$a_href_arch("dist/$file",$text)));
236                                 } @{$pkg{$case}}));
237                         print "</td>";
238                         }
239         print "</tr>\n";
240         }
241 print "<tr style=\"height: 2ex;\"></tr>\n";
242 print "<tr>";
243         print "<td>Package Requirements</td>";
244         for my $case (1,23) {
245                 print "<td".($case==23 ? ' colspan="2"' : '').">";
246                 print join(", ",map("<span class=\"reqpkg\">$_</span>",@{$reqpkg{$case}}));
247                 print "</td>";
248                 }
249 print "</tr>\n";
250 print <<"HERE";
251 </table>
252
253 <blockquote>
254         <p><a name="libxml2_rh8"><b><i>Red Hat 8 Psyche</i> upgrade of <i>libxml2</i> package:</b></a>
255         Upgrade only the packages already installed on your system to prevent
256         many dependency requirements - do not use &quot;<code>rpm -U</code>&quot;,
257         use &quot;<code>rpm -F</code>&quot; instead:</p>
258         <blockquote><p class="quote">
259                 <code>rpm -F @{[ join(" ",@libxml2_rh8_pkgs) ]}</code>
260         </p></blockquote>
261 </blockquote>
262
263 @{[ vskip "3ex" ]}
264
265
266 <h1>Installation Notes</h1>
267
268 <p>You should first run <b>captive-install-acquire</b> command to check your
269 available Microsoft Windows drivers versions. Now you can execute:</p>
270
271 <blockquote>
272         <p class="quote">
273                 # mkdir /mnt/dosc<br />
274                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
275         </p>
276 </blockquote>
277
278
279 <h2>Overview</h2>
280
281 <p>'<b>captive</b>' is the base package. It contains debugging '<b>captive-cmdline</b>' client.<br />
282 '<b>captive-lufs</b>' permits mounting NTFS as regular filesystem. It needs '<b>lufs</b>'.<br />
283 '<b>lufs</b>' is a daemon to enable userland process to provide filesystem functions.</p>
284
285 <p>Any errors from '<b>captive-lufs</b>' are written to '<b>/var/log/messages</b>'.</p>
286
287 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
288
289 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
290
291
292 <h2>Package Version Conflicts</h2>
293
294 <dl>
295
296 <dt>@{[ a_href 'http://lufs.sourceforge.net/lufs/','lufs' ]}</dt>
297 <dd><p><b>'captive' version required</b>: Although you may already have the
298 original package installed you must replace it by the local 'captive'-marked
299 version containing some 'captive'-essential fixes and extensions.</p></dd>
300
301 <dt>@{[ a_href 'http://linux-ntfs.sourceforge.net/','ntfsprogs' ]}</dt>
302 <dd><p><b>Original version >=200309071734 sufficient</b>:
303 The package which is downloadable from here, has no code patches - you can freely use the
304 original version instead. Unfortunately, the last public release is
305 <b>1.7.1</b> while this project requires at least
306 @{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/','snapshot' ]} version
307 <b>@{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/ntfsprogs-200309071734.tar.bz2','200309071734' ]}</b>
308 which is not packaged (.rpm/.deb) yet. Packaged versions are provided here for
309 your convenience.</p></dd>
310
311 </dl>
312
313
314 <h2>LUFS Kernel Driver Module</h2>
315
316 <p>@{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} (Linux Userland File
317 System) needs Linux kernel module driver (<i>lufs.o</i>) compatible with your
318 running Linux kernel. The binary driver is supplied already precompiled for many
319 Linux kernel versions in the binary packages above (<b>.i386.rpm</b> and
320 <b>_i386.deb</b> archives).</p>
321
322 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should run <span
323 class="quote">/usr/share/lufs/prepmod</span> to see the reasons. It is always
324 recommended to upgrade to the latest stable kernel supplied by your GNU/Linux
325 distribution vendor. You may need to install package
326 <b>kernel-source</b> (Red Hat) or <b>kernel-headers</b> (Debian) matching your
327 Linux kernel version (<b>rpm&nbsp;-q&nbsp;kernel</b>) and re-run <span
328 class="quote">/usr/share/lufs/prepmod</span>.</p>
329
330 <p><b>WARNING:</b> This 'captive' package may modify your Linux kernel
331 sources matching your currently running kernel version. These minor
332 modifications may include a dependencies rebuild, compiling build tools, fixes of
333 several include files, etc. All the modifications are done at the mount(8) time
334 by the automatically executed <span class="quote">/usr/share/lufs/prepmod</span> script.
335 This behavior was not present in the original
336 @{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} distribution
337 by @{[ a_href 'http://www.malinux.net/main/','Florin Malita' ]}.</p>
338
339
340 HERE
341
342
343 print rightimg <<"HERE",'reactos','ReactOS',"a_href"=>'http://www.reactos.com/';
344         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
345
346         <p>Compatibility with the existing binary Microsoft Windows file system drivers has been
347         reached. Microsoft Windows kernel system components required by these drivers
348         were analyzed and successfully emulated in the GNU/Linux operating system.
349         The project brings the Microsoft Windows kernel emulation framework to support even
350         other types of Microsoft Windows drivers in the future.
351         The <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
352         code base proved to be a big asset for this functionality.</p>
353 HERE
354
355
356 my @lists=qw(captive-announce-list captive-list captive-devel-list);
357
358 print <<"HERE";
359
360 <a name="lists"><h2>Mailing Lists</h2></a>
361
362 <form action="@{[ top_dir("/Mailman.pl") ]}" method="post">
363         <table border="1" class="mailman" style="border-collapse: collapse; border-style: solid; border-width: 1px;">
364                 <tr>@{[ map("<th>$_</th>",@lists) ]}</tr>
365                 <tr><td>New version announcements<br />
366                         (low traffic, recommended)</td>
367                                 <td>User support,<br />bug reports</td>
368                                 <td>Development</td>
369                                 </tr>
370                 <tr>@{[ map({ "<td>".a_href(&{$W->{"mailman_url_sub"}}()."/listinfo/$_",'Mailman Infopage')."</td>"; } @lists) ]}</tr>
371                 <tr>@{[ map({ "<td>".a_href(&{$W->{"pipermail_url_sub"}}()."/$_",'Archive')."</td>"; } @lists) ]}</tr>
372                 <tr>@{[
373                         map(('<td><input type="checkbox" name="list" value="'.$_.'"'
374                                         .($_ ne "captive-announce-list" ? '' : ' checked="checked"')
375                                         .' /> Subscribe?</td>'),@lists)
376                         ]}</tr>
377                 <tr><td colspan="3">
378                         <table border="0" style="text-align: left;">
379                                 <tr><td>Email address:            </td><td><input type="text"     name="email"   size="30" /></td></tr>
380                                 <tr><td>Your new Mailman password:</td><td><input type="password" name="pw"      size="15" /></td></tr>
381                                 <tr><td>Reenter your password:    </td><td><input type="password" name="pw-conf" size="15" /></td></tr>
382                         </table>
383                         <p><input type="submit" name="email-button" value="Subscribe me" /></p>
384                 </td></tr>
385         </table>
386 <input type="hidden" name="back" value="/project/captive/#lists" />
387 </form>
388
389
390 @{[ vskip "3ex" ]}
391
392 <h1>See Also</h1>
393 <ul>
394         <li>@{[ a_href 'Preview.html.pl','<span style="font-size: larger;">Technology Preview</span>' ]}</li>
395         <li>@{[ a_href 'CVS.html.pl','CVS Repository' ]}</li>
396         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
397                 <li>@{[ a_href 'doc/About.html.pl#versions','Microsoft Windows Versions Compatibility' ]}</li>
398                 <li>@{[ a_href 'doc/Architecture.html.pl#law','Laws and Licensing Conditions' ]}</li>
399                 <li>@{[ a_href 'doc/Details.html.pl#sandbox','Sandboxing of W32 Filesystem' ]}</li>
400                 <li>@{[ a_href 'doc/TODO.html.pl#todo_fsck','TODO: Fsck of NTFS' ]}</li>
401                 <li>@{[ a_href 'doc/TODO.html.pl#todo_surprise','TODO: NTFS Support for Partition Surprise' ]}</li>
402                 <li>@{[ a_href 'doc/Related.html.pl#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
403                 <li>@{[ a_href 'doc/Related.html.pl#vmware','Related Projects - VMware Workstation' ]}</li>
404                 <li>@{[ a_href 'doc/LinuxNTFS.html.pl',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
405                 </ul></li>
406         <li>@{[ a_href 'http://cvs.jankratochvil.net/viewcvs/*checkout*/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
407         <li>Man Pages<ul>
408                 @{[
409                         do {
410                                 my @mans=(
411                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
412                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
413                                                 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
414                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
415 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
416                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
417 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
418                                                 );
419                                 my @r;
420                                 while (@mans) {
421                                         my $file=shift @mans;
422                                         my($section,$name)=@{shift @mans};
423                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
424                                         }
425                                 @r;
426                                 }
427                         ]}
428                 </ul></li>
429         <li>@{[ a_href 'Resources.html.pl','Related Pages' ]}</li>
430         <li>@{[ a_href 'Thanks.html.pl','Thanks' ]}</li>
431 </ul>
432 HERE
433
434
435 My::Web->footer();