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