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