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