From 1703b5e2b995ac80245a18e9c162a864e0ae086d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustavo=20Andr=C3=A9=20dos=20Santos=20Lopes?=
 <cataphract@php.net>
Date: Thu, 10 Dec 2009 17:30:04 +0000
Subject: [PATCH] Added a new example.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@291959 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/rar/examples.xml | 119 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 117 insertions(+), 2 deletions(-)

diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml
index f47a685eba..ca5e53f70e 100644
--- a/reference/rar/examples.xml
+++ b/reference/rar/examples.xml
@@ -3,9 +3,123 @@
 
 <chapter xml:id="rar.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  &reftitle.examples;
+ 
  <para>
   <example>
-   <title>Rar extension overview example</title>
+   <title>On-the-fly decompression</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+if (!array_key_exists("i", $_GET) || !is_numeric($_GET["i"]))
+    die("Index unspecified or non-numeric");
+$index = (int) $_GET["i"];
+    
+$arch = RarArchive::open("example.rar");
+if ($arch === FALSE)
+    die("Cannot open example.rar");
+
+$entries = $arch->list();
+if ($entries === FALSE)
+    die("Cannot retrieve entries");
+
+if (!array_key_exists($index, $entries))
+    die("No such index: $index");
+
+$orfilename = $entries[$index]->getName(); //UTF-8 encoded
+
+$filesize = $entries[$index]->getUnpackedSize();
+
+/* you could check HTTP_IF_MODIFIED_SINCE here and compare with
+ * $entries[$index]->getFileTime(). You could also send a
+ * "Last modified" header */
+
+$fp = $entries[$index]->getStream();
+if ($fp === FALSE)
+    die("Cannot open file with index $index insided the archive.");
+
+$arch->close(); //no longer needed; stream is independent
+
+function detectUserAgent() {
+    if (!array_key_exists('HTTP_USER_AGENT', $_SERVER))
+        return "Other";
+    
+    $uas = $_SERVER['HTTP_USER_AGENT'];
+    if (preg_match("@Opera/@", $uas))
+        return "Opera";
+    if (preg_match("@Firefox/@", $uas))
+        return "Firefox";
+    if (preg_match("@Chrome/@", $uas))
+        return "Chrome";
+    if (preg_match("@MSIE ([0-9.]+);@", $uas, $matches)) {
+        if (((float)$matches[1]) >= 7.0)
+            return "IE";
+    }
+    
+    return "Other";
+}
+
+/*
+ * We have 3 options:
+ * - For FF and Opera, which support RFC 2231, use that format.
+ * - For IE and Chrome, use attwithfnrawpctenclong
+ *   (http://greenbytes.de/tech/tc2231/#attwithfnrawpctenclong)
+ * - For the others, convert to ISO-8859-1, if possible
+ */
+$formatRFC2231 = 'Content-Disposition: attachment; filename*=UTF-8\'\'%s';
+$formatDef = 'Content-Disposition: attachment; filename="%s"';
+
+switch (detectUserAgent()) {
+    case "Opera":
+    case "Firefox":
+        $orfilename = rawurlencode($orfilename);
+        $format = $formatRFC2231;
+        break;
+
+    case "IE":
+    case "Chrome":
+        $orfilename = rawurlencode($orfilename);
+        $format = $formatDef;
+        break;
+    default:
+        if (function_exists('iconv'))
+            $orfilename =
+                @iconv("UTF-8", "ISO-8859-1//TRANSLIT", $orfilename);
+        $format = $formatDef;
+}
+
+header(sprintf($format, $orfilename));
+//cannot send error messages from now on (headers already sent)
+
+//replace by real content type, perhaps infering from the file extension
+$contentType = "application/octet-stream";
+header("Content-Type: $contentType");
+
+header("Content-Transfer-Encoding: binary");
+
+header("Content-Length: $filesize");
+
+if ($_SERVER['REQUEST_METHOD'] == "HEAD")
+    die();
+    
+while (!feof($fp)) {
+    $s = @fread($fp, 8192);
+    if ($s === false)
+        break; //useless to send error messages
+  
+    echo $s;
+}
+]]>
+   </programlisting>
+  </example>
+ </para>
+ <para>
+  This example opens a RAR file and presents the requested file inside the RAR archive for download to the client.
+ </para>
+ 
+ <para>
+  <example>
+   <title>RAR extension filesystem extraction example</title>
    <programlisting role="php">
 <![CDATA[
 <?php
@@ -30,9 +144,10 @@ rar_close($rar_file);
   </example>
  </para>
  <para>
-  This example opens a Rar file archive and extracts each entry to the
+  This example opens a RAR file archive and extracts each entry to the
   specified directory.
  </para>
+ 
 </chapter>
 
 <!-- Keep this comment at the end of the file