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.1 (2003-10-28)</dt>
  89         <dd>
  90                 <ul>
  91                         <li>Fixed (harmless) crash/hang of lufsd during post-unmount cleanup</li>
  92                         <li>Fixed captive-install-acquire Gnome UI responsiveness during network outage</li>
  93                         <li>Support for LUFS options such as uid/gid/fmask/dmask</li>
  94                         <li>Improved performance</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.1","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_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 $ntfsprogs_after=sub ($) {
 157         my($format)=@_;
 158                 return () if $case!=1;
 159                 return '<hr width="80%" />requirement: '
 160                                 .a_href('http://linux-ntfs.sourceforge.net/downloads.html#downloads','ntfsprogs')
 161                                 .' '.$format.' &ge; 1.8.0';
 162         };
 163
 164 my @dist=(
 165                 {
 166                         "name"=>"Red Hat 9<br />Shrike i386",
 167                         "out"=>sub {
 168                                 my($pkg,$version_base,$version_ext)=@_;
 169                                         return () if $pkg eq "ntfsprogs";
 170                                         my $file="$pkg-$version_base-$version_ext.i386.rpm";
 171                                         my $r=&$a_href_arch("dist/$file",$file);
 172                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 173                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 174                                         return $r;
 175                                 },
 176                         "after"=>sub { return &{$ntfsprogs_after}(".i386.rpm"); },
 177                         },
 178                 {
 179                         "name"=>"Red Hat 8<br />Psyche i386<br />"
 180                                         ."(".a_href("#libxml2_rh8","libxml2 upgrade note").")",
 181                         "out"=>sub {
 182                                 my($pkg,$version_base,$version_ext)=@_;
 183                                         return () if $pkg eq "ntfsprogs";
 184                                         my $file="$pkg-$version_base-$version_ext".(!$has_rh8{$pkg} ? "" : "rh8").".i386.rpm";
 185                                         my $r=&$a_href_arch("dist/$file",$file);
 186                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 187                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 188                                         if ($pkg eq "captive-install") {
 189                                                 for (@libxml2_rh8_pkgs) {
 190                                                         $r.="<br />".&$a_href_arch('ftp://ftp.redhat.com/pub/redhat/linux/9/en/os/i386/RedHat/RPMS/'.$_,$_)." of Red Hat 9";
 191                                                         }
 192                                                 }
 193                                         return $r;
 194                                 },
 195                         "after"=>sub { return &{$ntfsprogs_after}(".i386.rpm"); },
 196                         },
 197                 {
 198                         "name"=>'Mandrake 9.1<br />Bamboo i586<hr width="80%" />Mandrake 9.2<br />TBA i586',
 199                         "out"=>sub {
 200                                 my($pkg,$version_base,$version_ext)=@_;
 201                                         return () if $pkg eq "ntfsprogs";
 202                                         my $file="$pkg-$version_base-$version_ext".(!$has_mdk91{$pkg} ? ".i386.rpm" : "mdk91.i586.rpm");
 203                                         my $r=&$a_href_arch("dist/$file",$file);
 204                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 205                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 206                                         return $r;
 207                                 },
 208                         "after"=>sub { return &{$ntfsprogs_after}(".i386.rpm"); },
 209                         },
 210                 {
 211                         "name"=>"Debian GNU/Linux<br />'unstable' i386",
 212                         "out"=>sub {
 213                                 my($pkg,$version_base,$version_ext)=@_;
 214                                         $version_ext=~s/^\d+//;
 215                                         my $file="${pkg}_$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext)."_i386.deb";
 216                                         my $r=&$a_href_arch("dist/$file",$file);
 217                                         (my $filedev=$file)=~s/^\Q$pkg\E_/${pkg}-dev_/;
 218                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 219                                         return $r;
 220                                 },
 221                         },
 222                 {
 223                         "name"=>"Sources (.tar.gz)",
 224                         "out"=>sub {
 225                                 my($pkg,$version_base,$version_ext)=@_;
 226                                         return () if $pkg_nosrc{$pkg};
 227                                         $version_ext=~s/^\d+//;
 228                                         my $file="$pkg-$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext).".tar.gz";
 229                                         return $file,$file;
 230                                 },
 231                         "after"=>sub { return &{$ntfsprogs_after}(".tar.gz"); },
 232                         },
 233                 {
 234                         "name"=>"Sources (.src.rpm)<br />(Red Hat 9 - Shrike)",
 235                         "out"=>sub {
 236                                 my($pkg,$version_base,$version_ext)=@_;
 237                                         return () if $pkg eq "ntfsprogs";
 238                                         return () if $pkg_nosrc{$pkg};
 239                                         my $file="$pkg-$version_base-$version_ext.src.rpm";
 240                                         return $file,$file;
 241                                 },
 242                         "after"=>sub { return &{$ntfsprogs_after}(".i386.rpm (incl. -devel)"); },
 243                         },
 244                 );
 245
 246 for my $dist (@dist) {
 247         print "<tr>";
 248                 print "<td>".$dist->{"name"}."</td>";
 249                 for my $casel (1,2,3) {
 250                         $case=$casel;
 251                         print "<td>";
 252                         print join("<br />",map({ my $pkg=$_;
 253                                 my($file,$text)=&{$dist->{"out"}}($pkg,@{$version{$pkg}});
 254                                 (!defined $text ? ($file) || () : (&$a_href_arch("dist/$file",$text)));
 255                                 } @{$pkg{$case}}),map({ (!$_ ? () : (&{$_}())); } $dist->{"after"}));
 256                         print "</td>";
 257                         }
 258         print "</tr>\n";
 259         }
 260 print "<tr style=\"height: 2ex;\"></tr>\n";
 261 print "<tr>";
 262         print "<td>Package Requirements</td>";
 263         for my $case (1,23) {
 264                 print "<td".($case==23 ? ' colspan="2"' : '').">";
 265                 print join(", ",map("<span class=\"reqpkg\">$_</span>",@{$reqpkg{$case}}));
 266                 print "</td>";
 267                 }
 268 print "</tr>\n";
 269 print <<"HERE";
 270 </table>
 271
 272 <blockquote>
 273         <p><a name="libxml2_rh8"><b><i>Red Hat 8 Psyche</i> upgrade of <i>libxml2</i> package:</b></a>
 274         Upgrade only the packages already installed on your system to prevent
 275         many dependency requirements - do not use &quot;<code>rpm -U</code>&quot;,
 276         use &quot;<code>rpm -F</code>&quot; instead:</p>
 277         <blockquote><p class="quote">
 278                 <code>rpm -F @{[ join(" ",@libxml2_rh8_pkgs) ]}</code>
 279         </p></blockquote>
 280 </blockquote>
 281
 282 @{[ vskip "3ex" ]}
 283
 284
 285 <h1>Installation Notes</h1>
 286
 287 <p>You should first run <b>captive-install-acquire</b> command to check your
 288 available Microsoft Windows drivers versions. Now you can execute:</p>
 289
 290 <blockquote>
 291         <p class="quote">
 292                 # mkdir /mnt/dosc<br />
 293                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
 294         </p>
 295 </blockquote>
 296
 297
 298 <h2>Overview</h2>
 299
 300 <p>'<b>captive</b>' is the base package. It contains debugging '<b>captive-cmdline</b>' client.<br />
 301 '<b>captive-lufs</b>' permits mounting NTFS as regular filesystem. It needs '<b>lufs</b>'.<br />
 302 '<b>lufs</b>' is a daemon to enable userland process to provide filesystem functions.</p>
 303
 304 <p>Any errors from '<b>captive-lufs</b>' are written to '<b>/var/log/messages</b>'.</p>
 305
 306 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
 307
 308 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
 309
 310
 311 <h2>Package Version Conflicts</h2>
 312
 313 <dl>
 314
 315 <dt>@{[ a_href 'http://lufs.sourceforge.net/lufs/','lufs' ]}</dt>
 316 <dd><p><b>'captive' version required</b>: Although you may already have the
 317 original package installed you must replace it by the local 'captive'-marked
 318 version containing some 'captive'-essential fixes and extensions.</p></dd>
 319
 320 </dl>
 321
 322
 323 <h2>LUFS Kernel Driver Module</h2>
 324
 325 <p>@{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} (Linux Userland File
 326 System) needs Linux kernel module driver (<i>lufs.o</i>) compatible with your
 327 running Linux kernel. The binary driver is supplied already precompiled for many
 328 Linux kernel versions in the binary packages above (<b>.i386.rpm</b> and
 329 <b>_i386.deb</b> archives).</p>
 330
 331 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should run <span
 332 class="quote">/usr/share/lufs/prepmod</span> to see the reasons. It is always
 333 recommended to upgrade to the latest stable kernel supplied by your GNU/Linux
 334 distribution vendor. You may need to install package
 335 <b>kernel-source</b> (Red Hat) or <b>kernel-headers</b> (Debian) matching your
 336 Linux kernel version (<b>rpm&nbsp;-q&nbsp;kernel</b>) and re-run <span
 337 class="quote">/usr/share/lufs/prepmod</span>.</p>
 338
 339 <p><b>WARNING:</b> This 'captive' package may modify your Linux kernel
 340 sources matching your currently running kernel version. These minor
 341 modifications may include a dependencies rebuild, compiling build tools, fixes of
 342 several include files, etc. All the modifications are done at the mount(8) time
 343 by the automatically executed <span class="quote">/usr/share/lufs/prepmod</span> script.
 344 This behavior was not present in the original
 345 @{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} distribution
 346 by @{[ a_href 'http://www.malinux.net/main/','Florin Malita' ]}.</p>
 347
 348
 349 HERE
 350
 351
 352 print rightimg <<"HERE",'reactos','ReactOS',"a_href"=>'http://www.reactos.com/';
 353         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
 354
 355         <p>Compatibility with the existing binary Microsoft Windows file system drivers has been
 356         reached. Microsoft Windows kernel system components required by these drivers
 357         were analyzed and successfully emulated in the GNU/Linux operating system.
 358         The project brings the Microsoft Windows kernel emulation framework to support even
 359         other types of Microsoft Windows drivers in the future.
 360         The <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
 361         code base proved to be a big asset for this functionality.</p>
 362 HERE
 363
 364
 365 my @lists=qw(captive-announce-list captive-list captive-devel-list);
 366
 367 print <<"HERE";
 368
 369 <a name="lists"><h2>Mailing Lists</h2></a>
 370
 371 <form action="@{[ top_dir("/Mailman.pl") ]}" method="post">
 372         <table border="1" class="mailman" style="border-collapse: collapse; border-style: solid; border-width: 1px;">
 373                 <tr>@{[ map('<th>'.$_.'@jankratochvil.net</th>',@lists) ]}</tr>
 374                 <tr><td>New version announcements<br />
 375                         (low traffic, recommended)</td>
 376                                 <td>User support,<br />bug reports</td>
 377                                 <td>Development</td>
 378                                 </tr>
 379                 <tr>@{[ map({ "<td>".a_href(&{$W->{"mailman_url_sub"}}()."/listinfo/$_",'Mailman Infopage')."</td>"; } @lists) ]}</tr>
 380                 <tr>@{[ map({ "<td>".a_href(&{$W->{"pipermail_url_sub"}}()."/$_",'Archive')."</td>"; } @lists) ]}</tr>
 381                 <tr>@{[
 382                         map(('<td><input type="checkbox" name="list" value="'.$_.'"'
 383                                         .($_ ne "captive-announce-list" ? '' : ' checked="checked"')
 384                                         .' /> Subscribe?</td>'),@lists)
 385                         ]}</tr>
 386                 <tr><td colspan="3">
 387                         <table border="0" style="text-align: left;">
 388                                 <tr><td>Email address:            </td><td><input type="text"     name="email"   size="30" /></td></tr>
 389                                 <tr><td>Your new Mailman password:</td><td><input type="password" name="pw"      size="15" /></td></tr>
 390                                 <tr><td>Reenter your password:    </td><td><input type="password" name="pw-conf" size="15" /></td></tr>
 391                         </table>
 392                         <p><input type="submit" name="email-button" value="Subscribe me" /></p>
 393                 </td></tr>
 394         </table>
 395 <input type="hidden" name="back" value="/project/captive/#lists" />
 396 </form>
 397
 398
 399 @{[ vskip "3ex" ]}
 400
 401 <h1>See Also</h1>
 402 <ul>
 403         <li>@{[ a_href 'Preview.html.pl','<span style="font-size: larger;">Technology Preview</span>' ]}</li>
 404         <li>@{[ a_href 'CVS.html.pl','CVS Repository' ]}</li>
 405         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
 406                 <li>@{[ a_href 'doc/About.html.pl#versions','Microsoft Windows Versions Compatibility' ]}</li>
 407                 <li>@{[ a_href 'doc/Architecture.html.pl#law','Laws and Licensing Conditions' ]}</li>
 408                 <li>@{[ a_href 'doc/Details.html.pl#sandbox','Sandboxing of W32 Filesystem' ]}</li>
 409                 <li>@{[ a_href 'doc/TODO.html.pl#todo_fsck','TODO: Fsck of NTFS' ]}</li>
 410                 <li>@{[ a_href 'doc/TODO.html.pl#todo_surprise','TODO: NTFS Support for Partition Surprise' ]}</li>
 411                 <li>@{[ a_href 'doc/Related.html.pl#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
 412                 <li>@{[ a_href 'doc/Related.html.pl#vmware','Related Projects - VMware Workstation' ]}</li>
 413                 <li>@{[ a_href 'doc/LinuxNTFS.html.pl',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
 414                 </ul></li>
 415         <li>@{[ a_href 'http://cvs.jankratochvil.net/viewcvs/*checkout*/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
 416         <li>Man Pages<ul>
 417                 @{[
 418                         do {
 419                                 my @mans=(
 420                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
 421                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
 422                                                 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
 423                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
 424 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
 425                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
 426 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
 427                                                 );
 428                                 my @r;
 429                                 while (@mans) {
 430                                         my $file=shift @mans;
 431                                         my($section,$name)=@{shift @mans};
 432                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
 433                                         }
 434                                 @r;
 435                                 }
 436                         ]}
 437                 </ul></li>
 438         <li>@{[ a_href 'Resources.html.pl','Related Pages' ]}</li>
 439         <li>@{[ a_href 'Thanks.html.pl','Thanks' ]}</li>
 440 </ul>
 441 HERE
 442
 443
 444 My::Web->footer();