Changeset 27 for trunk

Timestamp:

20.07.2005 22:33:40 (3 years ago)

Author:

m

Message:

Code cleanups

Files:

• trunk/File/Bittorrent/MakeTorrent.php (modified) (17 diffs)

trunk/File/Bittorrent/MakeTorrent.php

@@ -15 +15 @@
 // | license@php.net so we can mail you a copy immediately.                 |
 // +------------------------------------------------------------------------+
-// | Author: Justin Jones <j.nagash@gmail.com>                              |
+// | Authors                                                                |
+// |   Justin Jones <j.nagash@gmail.com>                                    |
+// |   Markus Tacker <m@tacker.org>                                         |
 // +------------------------------------------------------------------------+
 //
@@ -25 +27 @@
  * from Bram Cohen's original BT client.
  *
+ * @author Justin Jones <j.nagash@gmail.com>
+ * @author Markus Tacker <m@tacker.org>
+ * @version $Id$
  * @package File_Bittorrent
  * @category File
+ */
+ 
+/**
+ * Include required classes
+ */
+require_once 'PEAR.php';
+require_once 'File/Bittorrent/Encode.php';
+
+/**
+ * Provides a class for making .torrent files
+ * from a file or directory. Produces virtually
+ * identical torrent files as btmaketorrent.py
+ * from Bram Cohen's original BT client.
  *
- * @author  Justin Jones <j.nagash@gmail.com>
- *
+ * @author Justin Jones <j.nagash@gmail.com>
+ * @author Markus Tacker <m@tacker.org>
  * @version $Id$
- */
-
-/**
- * Creates .torrent files
- *
  * @package File_Bittorrent
  * @category File
@@ -42 +55 @@
 {
     /**
-     * Path to the file or directory to create the
-     * torrent from.
-     *
-     * @var string
-     */
-    var $path = '';
-
-    /**
-     * Whether or not $path is a file
-     *
-     * @var bool
-     */
-    var $_isFile = false;
-
-    /**
-     * Where or not $path is a directory
-     *
-     * @var bool
-     */
-    var $_isDir = false;
-
-    /**
-     * The .torrent info dictionary
-     *
-     * @var array
-     */
-    var $info = array();
-
-    /**
-     * The .torrent announce URL
-     *
-     * @var string
-     */
-    var $announce = '';
-
-    /**
-     * The .torrent announce_list extension
-     *
-     * @var array
-     */
-    var $announce_list = array();
-
-    /**
-     * The .torrent creation timestamp
-     *
-     * @var int
-     */
-    var $creation_date = 0;
-
-    /**
-     * The .torrent comment
-     *
-     * @var string
-     */
-    var $comment = '';
-
-    /**
-     * The .torrent created by string
-     *
-     * @var string
-     */
-    var $created_by = 'File_Bittorrent_MakeTorrent $Rev$';
-
-    /**
-     * The .torrent suggested name (file/dir)
-     *
-     * @var string
-     */
-    var $name = '';
-
-    /**
-     * The .torrent packed piece data
-     *
-     * @var string
-     */
-    var $pieces = '';
-
-    /**
-     * The .torrent piece length
-     * The size of each piece in bytes.
-     *
-     * @var int
-     */
-    var $piece_length = 524288;
-
-    /**
-     * The list of files (if this is
-     * a multi-file torrent)
-     *
-     * @var array
-     */
-    var $files = array();
-
-    /**
-     * The data gap used to join two
-     * files into the same piece
-     *
-     * @var mixed string if it contains data or boolean false
-     */
-    var $data_gap = false;
+     * @var string Path to the file or directory to create the torrent from.
+     * @access private
+     */
+    var $_path = '';
+
+    /**
+     * @var bool Whether or not $path is a file
+     * @access private
+     */
+    var $_is_file = false;
+
+    /**
+     * @var bool Where or not $path is a directory
+     */
+    var $_is_dir = false;
+
+    /**
+     * @var string The .torrent announce URL
+     * @access private
+     */
+    var $_announce = '';
+
+    /**
+     * @var array The .torrent announce_list extension
+     * @access private
+     */
+    var $_announce_list = array();
+
+    /**
+     * @var string The .torrent comment
+     * @access private
+     */
+    var $_comment = '';
+
+    /**
+     * @var string The .torrent created by string
+     * @access private
+     */
+    var $_created_by = 'File_Bittorrent_MakeTorrent $Rev$. http://pear.php.net/package/File_Bittorrent';
+    
+    /**
+     * @var string The .torrent suggested name (file/dir)
+     * @access private
+     */
+    var $_name = '';
+
+    /**
+     * @var string The .torrent packed piece data
+     * @access private
+     */
+    var $_pieces = '';
+
+    /**
+     * @var int The size of each piece in bytes.
+     * @access private
+     */
+    var $_piece_length = 524288;
+
+    /**
+     * @var array The list of files (if this is a multi-file torrent)
+     * @access private
+     */
+    var $_files = array();
+
+    /**
+     * @var string|false The data gap used to join two files into the same piece. string if it contains data or false
+     * @access private
+     */
+    var $_data_gap = false;
+    
+    /**
+    * @var resource file pointer
+    * @access private
+    */
+    var $_fp;
 
     /**
@@ -150 +138 @@
      *
      * @param string Path to use
-     * @return voide
-     * @access public
      */
     function File_Bittorrent_MakeTorrent($path)
     {
-        $this->path = $path;
-        if (is_dir($path)) {
-            $this->_isDir = true;
-            $this->name = basename($path);
-        } else if (is_file($path)) {
-            $this->_isFile = true;
-            $this->name = basename($path);
-        } else {
-            $this->path = '';
-        }
+        $this->setPath($path);
     }
 
@@ -172 +149 @@
      *
      * @param string announce url
-     * @return void
-     * @access public
+     * @return bool
      */
     function setAnnounce($announce)
     {
-        $this->announce = strval($announce);
+        $this->_announce = strval($announce);
+        return true;
     }
 
@@ -185 +162 @@
      *
      * @param array announce list
-     * @return void
-     * @access public
+     * @return bool
      */
     function setAnnounceList($announce_list)
     {
-        if (is_array($announce_list))
-        {
-            $this->announce_list = $announce_list;
-        }
+        if (!is_array($announce_list)) {
+            PEAR::raiseError(__CLASS__ . '::'. __FUNCTION__ . '() - No array given.');
+            return false;
+        }
+        $this->_announce_list = $announce_list;
+        return true;
     }
 
@@ -201 +179 @@
      *
      * @param string comment
-     * @return void
-     * @access public
+     * @return bool
      */
     function setComment($comment)
     {
-        $this->comment = strval($comment);
-    }
-
-    /**
-     * Function to set the created by timestamp
-     * for the .torrent file. If you don't want
-     * to use the servers current timestamp
-     *
-     * @param int timestamp
-     * @return void
-     * @access public
-     */
-    function setCreatedBy($created_by)
-    {
-        $this->created_by = strval($created_by);
+        $this->_comment = strval($comment);
+        return true;
     }
 
@@ -229 +193 @@
      *
      * @param string path to file/dir
-     * @return void
-     * @access public
+     * @return bool
      */
     function setPath($path)
     {
-        $this->path = $path;
+        $this->_path = $path;
         if (is_dir($path)) {
-            $this->_isDir = true;
-            $this->name = basename($path);
+            $this->_is_dir = true;
+            $this->_name = basename($path);
         } else if (is_file($path)) {
-            $this->_isFile = true;
-            $this->name = basename($path);
+            $this->_is_file = true;
+            $this->_name = basename($path);
         } else {
-            $this->path = '';
-        }
+            $this->_path = '';
+        }
+        return true;
     }
 
@@ -252 +216 @@
      *
      * @param int piece length in kilobytes
-     * @return void
-     * @access public
+     * @return bool
      */
     function setPieceLength($piece_length)
     {
-        if ($piece_length >= 32 && $piece_length <= 4096) {
-            $this->piece_length = $piece_length * 1024;
-        }
+        if ($piece_length < 32 or $piece_length > 4096) {
+            PEAR::raiseError(__CLASS__ . '::'. __FUNCTION__ . '() - Invalid piece lenth: "' . $piece_length . '"');
+            return false;
+        }
+        $this->_piece_length = $piece_length * 1024;
+        return true;
     }
 
@@ -268 +234 @@
      *
      * @return mixed false on failure or a string containing the metainfo
-     * @access public
      */
     function buildTorrent()
     {
-        if ($this->_isFile) {
-            $info = $this->_addFile($this->path);
-            if ($info !== false) {
-                $metainfo = $this->_encodeTorrent($info);
-                return $metainfo;
-            }
-        } else if ($this->_isDir) {
-            $diradd_ok = $this->_addDir($this->path);
-            if ($diradd_ok !== false) {
-                $metainfo = $this->_encodeTorrent();
-                return $metainfo;
-            }
-        } else {
-            return false;
-        }
+        if ($this->_is_file) {
+            if (!$info = $this->_addFile($this->_path)) {
+                return false;
+            }
+            if (!$metainfo = $this->_encodeTorrent($info)) {
+                return false;
+            }            
+        } else if ($this->_is_dir) {
+            if (!$diradd_ok = $this->_addDir($this->_path)) {
+                return false;
+            }
+            $metainfo = $this->_encodeTorrent();
+        }
+        return $metainfo;
     }
 
@@ -299 +263 @@
     function _encodeTorrent($info = array())
     {
-        require_once 'File/Bittorrent/Encode.php';
-        $benc = new File_Bittorrent_Encode;
-
         $bencdata = array();
         $bencdata['info'] = array();
-        if ($this->_isFile) {
+        if ($this->_is_file) {
             $bencdata['info']['length'] = $info['length'];
             $bencdata['info']['md5sum'] = $info['md5sum'];
-        } else if ($this->_isDir) {
-            if ($this->data_gap !== false) {
-                $this->pieces .= pack('H*', sha1($this->data_gap));
-                $this->data_gap = false;
-            }
-            $bencdata['info']['files'] = $this->files;
+        } else if ($this->_is_dir) {
+            if ($this->_data_gap !== false) {
+                $this->_pieces .= pack('H*', sha1($this->_data_gap));
+                $this->_data_gap = false;
+            }
+            $bencdata['info']['files'] = $this->_files;
         } else {
+            PEAR::raiseError(__CLASS__ . '::'. __FUNCTION__ . '() - Use ' .  __CLASS__ . '::setPath() to define a file or directory.');
             return false;
         }
-        $bencdata['info']['name'] = $this->name;
-        $bencdata['info']['piece length'] = $this->piece_length;
-        $bencdata['info']['pieces'] = $this->pieces;
-        $bencdata['announce'] = $this->announce;
-        //$bencdata['announce-list'] = array($this->announce)
-        $bencdata['creation date'] = time();
-        $bencdata['comment'] = $this->comment;
-        $bencdata['created by'] = $this->created_by;
-        return $benc->encode_array($bencdata);
+        $bencdata['info']['name']         = $this->_name;
+        $bencdata['info']['piece length'] = $this->_piece_length;
+        $bencdata['info']['pieces']       = $this->_pieces;
+        $bencdata['announce']             = $this->_announce;
+        $bencdata['creation date']        = time();
+        $bencdata['comment']              = $this->_comment;
+        $bencdata['created by']           = $this->_created_by;
+        // $bencdata['announce-list'] = array($this->_announce)
+        // Encode it
+        $Encoder = new File_Bittorrent_Encode;
+        return $Encoder->encode_array($bencdata);
     }
 
@@ -333 +297 @@
      * @param string path to the file
      * @return mixed false on failure or file metainfo data
-     * @access private
-     */
+     * @access private
+     */
     function _addFile($file)
     {
-        $fp = &File_Bittorrent_MakeTorrent::_openfile($file);
-        if ($fp) {
-            $filelength = 0;
-            $md5sum = md5_file($file);
-            $piece_length = $this->piece_length;
-
-            while (!feof($fp)) {
-                $data = '';
-                $datalength = 0;
-
-                if ($this->_isDir && $this->data_gap !== false) {
-                    $data = $this->data_gap;
-                    $datalength = strlen($data);
-                    $this->data_gap = false;
+        if (!$this->_openFile($file)) return false;
+        
+        $filelength = 0;
+        $md5sum = md5_file($file);
+
+        while (!feof($this->_fp)) {
+            $data = '';
+            $datalength = 0;
+
+            if ($this->_is_dir && $this->_data_gap !== false) {
+                $data = $this->_data_gap;
+                $datalength = strlen($data);
+                $this->_data_gap = false;
+            }
+
+            while (!feof($this->_fp) && ($datalength < $this->_piece_length)) {
+                $readlength = 8192;
+                if (($datalength + 8192) > $this->_piece_length) {
+                    $readlength = $this->_piece_length - $datalength;
                 }
 
-                while ( !feof($fp) && ($datalength < $piece_length) ) {
-                    $readlength = 8192;
-                    if ( ($datalength + 8192) > $piece_length ) {
-                        $readlength = $piece_length - $datalength;
-                    }
-
-                    $tmpdata = fread($fp, $readlength);
-                    $actual_readlength = strlen($tmpdata);
-                    $datalength += $actual_readlength;
-                    $filelength += $actual_readlength;
-
-                    $data .= $tmpdata;
-
-                    flush();
+                $tmpdata = fread($this->_fp, $readlength);
+                $actual_readlength = strlen($tmpdata);
+                $datalength += $actual_readlength;
+                $filelength += $actual_readlength;
+
+                $data .= $tmpdata;
+
+                flush();
+            }
+
+            // We've either reached the end of the file, or
+            // we have a whole piece, or both.
+            if ($datalength == $this->_piece_length) {
+                // We have a piece.
+                $this->_pieces .= pack('H*', sha1($data));
+            }
+            if (($datalength != $this->_piece_length) && feof($this->_fp)) {
+                // We've reached the end of the file, and
+                // we dont have a whole piece.
+                if ($this->_is_dir) {
+                    $this->_data_gap = $data;
+                } else {
+                    $this->_pieces .= pack('H*', sha1($data));
                 }
-
-                /* We've either reached the end of the file, or
-                 * we have a whole piece, or
-                 * both.
-                 */
-                if ($datalength == $piece_length) {
-                    // We have a piece.
-                    $this->pieces .= pack('H*', sha1($data));
-                }
-                if ( ($datalength != $piece_length) && feof($fp) ) {
-                    // We've reached the end of the file, and
-                    // we dont have a whole piece.
-                    if ($this->_isDir) {
-                        $this->data_gap = $data;
-                    } else {
-                        $this->pieces .= pack('H*', sha1($data));
-                    }
-                }
-            }
-            // Close the file pointer.
-            File_Bittorrent_MakeTorrent::_closefile($fp);
-            $info = array(
-                    'length' => $filelength,
-                    'md5sum' => $md5sum
-                    );
-            return $info;
-        }
-        return false;
+            }
+        }
+
+        // Close the file pointer.
+        $this->_closeFile();
+        $info = array(
+            'length' => $filelength,
+            'md5sum' => $md5sum
+        );
+        return $info;
     }
 
@@ -418 +378 @@
                 $filedata['path'][] = basename($file);
                 $dirname = dirname($file);
-                while ( basename($dirname) != $this->name ) {
+                while (basename($dirname) != $this->_name) {
                     $filedata['path'][] = basename($dirname);
                     $dirname = dirname($dirname);
                 }
                 $filedata['path'] = array_reverse($filedata['path'], false);
-                $this->files[] = $filedata;
+                $this->_files[] = $filedata;
             }
         }
@@ -446 +406 @@
             if ($dh = opendir($current_dir)) {
                 while ( ($file = readdir($dh)) !== false ) {
-                    if ($file !== '.' && $file !== '..') {
-                        $current_file = $current_dir . '/' . $file;
-
-                        if ( is_file($current_file) ) {
-                            $file_list[] = $current_dir . '/' . $file;
-                        } else if ( is_dir($current_file) ) {
-                            $stack[] = $current_file;
-                        }
+                    if ($file{0} =='.') continue;
+                    $current_file = $current_dir . '/' . $file;
+                    if (is_file($current_file)) {
+                        $file_list[] = $current_dir . '/' . $file;
+                    } else if (is_dir($current_file)) {
+                        $stack[] = $current_file;
                     }
                 }
@@ -469 +427 @@
      * @access private
      */
-    function _filesize($file) {
+    function _filesize($file)
+    {
         $size = @filesize($file);
         if ($size == 0) {
-            $size = exec('du -b "'.$file.'"');
+            if (PHP_OS != 'Linux') return false; 
+            $size = exec('du -b ' . escapeshellarg($file));
         }
         return $size;
@@ -482 +442 @@
      *
      * @param string path to the file
-     * @return mixed file pointer or false
-     * @access private
-     */
-    function &_openfile($file) {
-        $fsize = File_Bittorrent_MakeTorrent::_filesize($file);
+     * @return bool
+     * @access private
+     */
+    function _openFile($file)
+    {
+        $fsize = $this->_filesize($file);
         if ($fsize <= 2*1024*1024*1024) {
-            $fp = fopen($file, 'r');
+            if (!$this->_fp = fopen($file, 'r')) {
+                PEAR::raiseError(__CLASS__ . '::'. __FUNCTION__ . '() - Failed to open "' . $file . '"');
+                return false;
+            }
             $this->_fopen = true;
         } else {
-            $fp = popen('cat "'.$file.'"', 'r');
+            if (PHP_OS != 'Linux') {
+                PEAR::raiseError(__CLASS__ . '::'. __FUNCTION__ . '() - File size is greater than 2GB. This is only supported under Linux.');
+                return false;
+            }
+            $this->_fp = popen('cat ' . escapeshellarg($file), 'r');
             $this->_fopen = false;
         }
-        return $fp;
+        return true;
     }
 
@@ -500 +468 @@
      * Internal function to close a file pointer
      *
-     * @param resource File Pointer
-     * @access private
-     */
-    function _closefile(&$fp)
-    {
-        if ($this->_fopen == true) {
-            fclose($fp);
-        } else {
-            pclose($fp);
+     * @access private
+     */
+    function _closeFile()
+    {
+        if ($this->_fopen) {
+            fclose($this->_fp);
+        } else {
+            pclose($this->_fp);
         }
     }