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 ",
  43                 "no_job"=>1,
  44                 );
  45
  46
  47 print vskip("10ex")."<h1 align=\"center\">!!! DO NOT DISCLOSE !!!</h1>\n".vskip("10ex");
  48
  49 print <<"HERE";
  50 <h1>The First Read/Write NTFS for Free Operating Systems</h1>
  51 <h1>The First Open Source MS-Windows Kernel API for Free OS</h1>
  52 HERE
  53
  54 my @stuff=(
  55                 "A lot of people claim themselves as Windows Programmers.\n"
  56                                 ." Now I can finally join them - I also wrote my own Microsoft Windows.",
  57                 "Why do they need ".a_href('http://www.winsupersite.com/reviews/winserver2k3_gold2.asp','5000 developers')
  58                                 ." to write Microsoft Windows when it can be just One Man Show?",
  59
  60
  61
  62                 "My first Microsoft Windows program ever written? Some 'helloworld'?"
  63                                 ." <span class=\"quote\">hal.dll</span>.",
  64                 );
  65
  66 print rightimg((map("<p class=\"stuff\">$_</p>\n",($stuff[int rand @stuff])))[0],
  67                 'captive-install-acquire-small','[ Captive Microsoft Windows Drivers Acquire Illustration ]',
  68                                 "a_href_img"=>'captive-install-acquire');
  69
  70 print <<"HERE";
  71
  72 @{[ vskip "3ex" ]}
  73
  74 <table border="1" align="center" style="text-align: center;" width="100%"><tr><th>Distribution</th>
  75                 <th>Installation Case #1<br />Filesystem and installer<br />(recommended)</th>
  76                 <th>Installation Case #2<br />Manual installation<br />(filesystem, expert user)</th>
  77                 <th>Installation Case #3<br />Command-line client<br />(no filesystem access)</th></tr>
  78 HERE
  79 my %pkg=(
  80                 1=>[qw(captive captive-lufs captive-install lufs gnome-vfs-httpcaptive ntfsprogs ntfsprogs-gnomevfs)],
  81                 2=>[qw(captive captive-lufs                 lufs)],
  82                 3=>[qw(captive)],
  83                 );
  84 my %reqpkg=(
  85                 1=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt          libgnomeui)],
  86                 2=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt)],
  87                 3=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt readline)],
  88                 );
  89 my %version=(
  90                 map(($_=>["0.9.7","0"]),qw(captive captive-lufs captive-install)),
  91                 "lufs"=>["0.9.6","1captive5"],
  92                 "gnome-vfs-httpcaptive"=>["2.3.8captive2","0"],
  93                 "ntfsprogs"=>["200309071734","1captive1"],
  94                 "ntfsprogs-gnomevfs"=>["1.0.1","0"],
  95                 );
  96 my %has_rh8=(map(($_=>1),qw(
  97                 gnome-vfs-httpcaptive
  98                 captive
  99                 captive-lufs
 100                 captive-install
 101                 )));
 102 my %has_mdk91=(map(($_=>1),qw(
 103                 gnome-vfs-httpcaptive
 104                 lufs
 105                 captive
 106                 captive-lufs
 107                 captive-install
 108                 )));
 109 my %has_devel=(map(($_=>1),qw(
 110                 ntfsprogs
 111                 )));
 112 my %pkg_nosrc=(map(($_=>1),qw(
 113                 captive-lufs
 114                 captive-install
 115                 )));
 116
 117 my $case;
 118 my $a_href_arch=sub ($$%)
 119 {
 120 my($file_base,$text,%args)=@_;
 121
 122         $text=~s/[._]\D.*$// if $case!=1 && $text!~/^[.]/;
 123         return a_href $file_base,$text,"size"=>($case==1),%args;
 124 };
 125
 126 my @dist=(
 127                 {
 128                         "name"=>"Red Hat 9<br />Shrike i386",
 129                         "out"=>sub {
 130                                 my($pkg,$version_base,$version_ext)=@_;
 131                                         my $file="$pkg-$version_base-$version_ext.i386.rpm";
 132                                         my $r=&$a_href_arch("dist/$file",$file);
 133                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 134                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 135                                         return $r;
 136                                 },
 137                         },
 138                 {
 139                         "name"=>"Red Hat 8<br />Psyche i386",
 140                         "out"=>sub {
 141                                 my($pkg,$version_base,$version_ext)=@_;
 142                                         my $file="$pkg-$version_base-$version_ext".(!$has_rh8{$pkg} ? "" : "rh8").".i386.rpm";
 143                                         my $r=&$a_href_arch("dist/$file",$file);
 144                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 145                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 146                                         if ($pkg eq "captive-install") {
 147                                                 for (qw(libxml2-2.5.4-1.i386.rpm libxml2-python-2.5.4-1.i386.rpm libxml2-devel-2.5.4-1.i386.rpm)) {
 148                                                         $r.="<br />".&$a_href_arch('ftp://ftp.redhat.com/pub/redhat/linux/9/en/os/i386/RedHat/RPMS/'.$_,$_)." of Red Hat 9";
 149                                                         }
 150                                                 }
 151                                         return $r;
 152                                 },
 153                         },
 154                 {
 155                         "name"=>"Mandrake 9.1<br />Bamboo i586",
 156                         "out"=>sub {
 157                                 my($pkg,$version_base,$version_ext)=@_;
 158                                         my $file="$pkg-$version_base-$version_ext".(!$has_mdk91{$pkg} ? ".i386.rpm" : "mdk91.i586.rpm");
 159                                         my $r=&$a_href_arch("dist/$file",$file);
 160                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 161                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 162                                         return $r;
 163                                 },
 164                         },
 165                 {
 166                         "name"=>"Debian GNU/Linux<br />'unstable' i386",
 167                         "out"=>sub {
 168                                 my($pkg,$version_base,$version_ext)=@_;
 169                                         $version_ext=~s/^\d+//;
 170                                         my $file="${pkg}_$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext)."_i386.deb";
 171                                         my $r=&$a_href_arch("dist/$file",$file);
 172                                         (my $filedev=$file)=~s/^\Q$pkg\E_/${pkg}-dev_/;
 173                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 174                                         return $r;
 175                                 },
 176                         },
 177                 {
 178                         "name"=>"Sources (.tar.gz)",
 179                         "out"=>sub {
 180                                 my($pkg,$version_base,$version_ext)=@_;
 181                                         return () if $pkg_nosrc{$pkg};
 182                                         $version_ext=~s/^\d+//;
 183                                         my $file="$pkg-$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext).".tar.gz";
 184                                         return $file,$file;
 185                                 },
 186                         },
 187                 {
 188                         "name"=>"Sources (.src.rpm)<br />(Red Hat 9 - Shrike)",
 189                         "out"=>sub {
 190                                 my($pkg,$version_base,$version_ext)=@_;
 191                                         return () if $pkg_nosrc{$pkg};
 192                                         my $file="$pkg-$version_base-$version_ext.src.rpm";
 193                                         return $file,$file;
 194                                 },
 195                         },
 196                 );
 197
 198 for my $dist (@dist) {
 199         print "<tr>";
 200                 print "<td>".$dist->{"name"}."</td>";
 201                 for my $casel (1,2,3) {
 202                         $case=$casel;
 203                         print "<td>";
 204                         print join("<br />",map({ my $pkg=$_;
 205                                 my($file,$text)=&{$dist->{"out"}}($pkg,@{$version{$pkg}});
 206                                 (!defined $text ? ($file) || () : (&$a_href_arch("dist/$file",$text)));
 207                                 } @{$pkg{$case}}));
 208                         print "</td>";
 209                         }
 210         print "</tr>\n";
 211         }
 212 print <<'HERE';
 213 </table>
 214 HERE
 215
 216 print vskip "3ex";
 217
 218 print <<"HERE";
 219 <h1>Installation notes</h1>
 220
 221 <p>You should first run <b>captive-install-acquire</b> command to check your
 222 available Microsoft Windows drivers versions. Now you can execute:</p>
 223
 224 <blockquote>
 225         <p class="quote">
 226                 # mkdir /mnt/dosc<br />
 227                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
 228         </p>
 229 </blockquote>
 230
 231
 232 <h2>Overview</h2>
 233
 234 <p>'<b>captive</b>' is the base package. It contains debugging '<b>captive-cmdline</b>' client.<br />
 235 '<b>captive-lufs</b>' permits mounting NTFS as regular filesystem. It needs '<b>lufs</b>'.<br />
 236 '<b>lufs</b>' is a daemon to enable userland process to provide filesystem functions.</p>
 237
 238 <p>Any errors from '<b>captive-lufs</b>' are written to '<b>/var/log/messages</b>'.</p>
 239
 240 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
 241
 242 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
 243
 244
 245 <h2>Package version conflicts</h2>
 246
 247 <dl>
 248
 249 <dt>@{[ a_href 'http://lufs.sourceforge.net/lufs/','lufs' ]}</dt>
 250 <dd><p><b>'captive' version required</b>: Although you may already have the
 251 original package installed you must replace it by the local 'captive'-marked
 252 version containing some 'captive'-essential fixes and extensions.</p></dd>
 253
 254 <dt>@{[ a_href 'http://linux-ntfs.sourceforge.net/','ntfsprogs' ]}</dt>
 255 <dd><p><b>Original version >=200309071734 sufficient</b>:
 256 The package downloadable here has no code patches - you can freely use the
 257 original version instead.  Unfortunately the last public release is
 258 <b>1.7.1</b> while this project requires at least
 259 @{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/','snapshot' ]} version
 260 <b>@{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/ntfsprogs-200309071734.tar.bz2','200309071734' ]}</b>
 261 which is not packaged (.rpm/.deb) yet. Packaged versions are provided here for
 262 your convenience.</p></dd>
 263
 264 </dl>
 265
 266
 267 <h2>LUFS kernel driver module</h2>
 268
 269 <p>@{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} (Linux Userland File
 270 System) needs Linux kernel module driver (<i>lufs.o</i>) compatible with your
 271 running Linux kernel. Binary driver is supplied already precompiled for many
 272 Linux kernel versions in the binary packages above (<b>.i386.rpm</b> and
 273 <b>_i386.deb</b> archives).</p>
 274
 275 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should run <span
 276 class="quote">/usr/share/lufs/prepmod</span> to see the reasons. It is always
 277 recommended to upgrade to the latest stable kernel supplied by your GNU/Linux
 278 distribution vendor. You may need to install package
 279 <b>kernel-source</b> (Red Hat) or <b>kernel-headers</b> (Debian) matching your
 280 Linux kernel version (<b>rpm&nbsp;-q&nbsp;kernel</b>) and re-run <span
 281 class="quote">/usr/share/lufs/prepmod</span>.</p>
 282
 283
 284 HERE
 285
 286
 287 print rightimg <<"HERE",'reactos','ReactOS',"a_href"=>'http://www.reactos.com/';
 288         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
 289
 290         <p>Compatibility with existing binary Microsoft Windows file system drivers was
 291         reached. Microsoft Windows kernel system components required by these drivers
 292         were analyzed and successfuly emulated in the GNU/Linux operating system.
 293         Project brings Microsoft Windows kernel emulation framework to support even
 294         other types Microsoft Windows drivers in the future.
 295         <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
 296         code base made a big asset for this functionality.</p>
 297 HERE
 298
 299
 300 print <<"HERE";
 301
 302 @{[ vskip "3ex" ]}
 303
 304 <h1>See also</h1>
 305 <ul>
 306         <li>@{[ a_href 'Preview.html.pl','<span style="font-size: larger;">Technology Preview</span>' ]}</li>
 307         <li>@{[ a_href 'CVS.html.pl','CVS Repository' ]}</li>
 308         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
 309                 <li>@{[ a_href 'doc/About.html.pl#versions','Microsoft Windows Versions Compatibility' ]}</li>
 310                 <li>@{[ a_href 'doc/Architecture.html.pl#law','Laws and Licensing Conditions' ]}</li>
 311                 <li>@{[ a_href 'doc/Details.html.pl#sandbox','Sandboxing of W32 Filesystem' ]}</li>
 312                 <li>@{[ a_href 'doc/TODO.html.pl#todo_fsck','TODO: Fsck of NTFS' ]}</li>
 313                 <li>@{[ a_href 'doc/TODO.html.pl#todo_surprise','TODO: NTFS Support for Partition Surprise' ]}</li>
 314                 <li>@{[ a_href 'doc/Related.html.pl#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
 315                 <li>@{[ a_href 'doc/Related.html.pl#vmware','Related Projects - VMware Workstation' ]}</li>
 316                 <li>@{[ a_href 'doc/LinuxNTFS.html.pl',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
 317                 </ul></li>
 318         <li>@{[ a_href 'http://cvs.jankratochvil.net/viewcvs/*checkout*/priv/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
 319         <li>Man pages<ul>
 320                 @{[
 321                         do {
 322                                 my @mans=(
 323                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
 324                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
 325                                                 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
 326                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
 327 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
 328                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
 329 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
 330                                                 );
 331                                 my @r;
 332                                 while (@mans) {
 333                                         my $file=shift @mans;
 334                                         my($section,$name)=@{shift @mans};
 335                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
 336                                         }
 337                                 @r;
 338                                 }
 339                         ]}
 340                 </ul></li>
 341         <li>@{[ a_href 'Resources.html.pl','Related Pages' ]}</li>
 342         <li>@{[ a_href 'Thanks.html.pl','Thanks' ]}</li>
 343 </ul>
 344
 345 @{[ vskip "3ex" ]}
 346
 347 <p class="stuff">
 348         Why did I install Microsoft Windows and wrote such disgusting piece of code?<br />
 349         Expecting @{[ a_href $W->{"resume_url"},"yet another challenging task" ]}!
 350 </p>
 351 HERE
 352
 353
 354 My::Web->footer();