Ftp Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	Ftp ($url)
	connect ($url)
	put ($source, $dest, $mode=FTP_BINARY)
	mkdirs ($strPath)
	close ()
Öffentliche Attribute
	$verb
	$url
	$log = array()
	$mode = FTP_ASCII
	$passive = false
	$ok = true

---

Ausführliche Beschreibung

Definiert in Zeile 30 der Datei Ftp.class.php.

---

Dokumentation der Elementfunktionen

Ftp::close

(

)

Schlie�en der FTP-Verbindung.
Sollte unbedingt aufgerufen werden, damit keine unn�tigen Sockets aufbleiben.

Definiert in Zeile 212 der Datei Ftp.class.php.

     {
          if   ( !$this->ok ) // Noch alles ok?
               return;
               
          if   ( ! @ftp_quit( $this->verb ) )
          {
               // Das Schlie�en der Verbindung hat nicht funktioniert.
               // Eigentlich k�nnten wir das ignorieren, aber wir sind anst�ndig und melden eine Fehler.
               $this->log[] = 'failed to close connection';
               $this->ok = false;
               return;
          }
     }

Ftp::connect

(

$

url

)

Definiert in Zeile 49 der Datei Ftp.class.php.

Benutzt $conf, $url und Logger::error().

Wird benutzt von Ftp().

     {
          $this->url = $url;
          
          global $conf;
     
          $conf_ftp = $conf['publish']['ftp'];
          $ftp = parse_url( $this->url );
          
          // Die projektspezifischen Werte gewinnen bei �berschneidungen mit den Default-Werten
          $ftp = array_merge($conf_ftp,$ftp);
     
          // Nur FTP und FTPS (seit PHP 4.3) erlaubt
          if   ( !ereg('^ftps?$',$ftp['scheme']) )
          {
               $this->log[] = 'Unknown scheme in FTP Url: '.$ftp['scheme'];
               $this->log[] = 'Only FTP (and FTPS, if compiled in) are supported';
               $this->ok  = false;
               return;
          }
          
          if   ( function_exists('ftp_ssl_connect') && $ftp['scheme'] == 'ftps' )
               $this->verb = @ftp_ssl_connect( $ftp['host'],$ftp['port'] );
          else
               $this->verb = @ftp_connect( $ftp['host'],$ftp['port'] );

          if   ( !$this->verb )
          {
               $this->log[] = 'Cannot connect to '.$ftp['scheme'].'-server: '.$ftp['host'].':'.$ftp['port'];
               $this->ok = false;
               
               Logger::error('Cannot connect to '.$ftp['host'].':'.$ftp['port']);
               return;
          }

          $this->log[] = 'Connected to FTP server '.$ftp['host'].':'.$ftp['port'];
          
          if   ( empty($ftp['user']) )
               $ftp['user'] = 'anonymous';
               
          if   ( ! ftp_login( $this->verb,$ftp['user'],$ftp['pass'] ) )
          {
               $this->log[] = 'Unable to login as user '.$ftp['user'];
               $this->ok = false;
               return;
          }
          
          $this->log[] = 'Logged in as user '.$ftp['user'];

          $pasv = (!empty($ftp['fragment']) && $ftp['fragment'] == 'passive' );
          
          $this->log[] = 'entering passive mode '.($pasv?'on':'off');
          if   ( ! ftp_pasv($this->verb,true) )
          {
               $this->log[] = 'cannot switch PASV mode';
               $this->ok = false;
               return;
          }
          
          if   ( !empty($ftp['query']) )
          {
               parse_str( $ftp['query'],$ftp_var );
               
               if   ( isset( $ftp_var['site'] ) )
               {
                    $site_commands = explode( ',',$ftp_var['site'] );
                    foreach( $site_commands as $cmd )
                    {
                         $this->log .= 'executing SITE command: '.$cmd;

                         if   ( ! @ftp_site( $this->verb,$cmd ) )
                         {
                              $this->log[] = 'unable to do SITE command: '.$cmd;
                              $this->ok = false;
                              return;
                         }
                    }
               }
          }

          $this->path = ereg_replace( '\/$','',$ftp['path']);
          
          $this->log[] = 'Changing directory to '.$this->path;
          
          if   ( ! @ftp_chdir( $this->verb,$this->path ) )
          {
               $this->log[] = 'unable CHDIR to directory: '.$this->path;
               $this->ok = false;
               return;
          }
     }

Ftp::Ftp

(

$

url

)

Definiert in Zeile 42 der Datei Ftp.class.php.

Benutzt $url und connect().

     {
          $this->connect( $url );
     }

Ftp::mkdirs

(

$

strPath

)

Private Methode zum rekursiven Anlegen von Verzeichnissen.

Parameter:

String

Pfad

Rückgabe:

boolean true, wenn ok

Definiert in Zeile 187 der Datei Ftp.class.php.

Wird benutzt von put().

     {
          if   ( @ftp_chdir($this->verb,$strPath) )
               return true; // Verzeichnis existiert schon :)
      
          $pStrPath = dirname($strPath);
          
          if   ( !$this->mkdirs($pStrPath) )
               return false;
          
          if   ( ! @ftp_mkdir($this->verb,$strPath) )
          {
               $this->ok = false;
               $this->log[] = "failed to create remote directory: $strPath";
          }
          
          return $this->ok;
     }

Ftp::put	(	$	source,
		$	dest,
		$	mode = FTP_BINARY
	)

Kopieren einer Datei vom lokalen System auf den FTP-Server.

Parameter:

	String	Quelle
	String	Ziel
	int	FTP-Mode (BINARY oder ASCII)

Definiert in Zeile 149 der Datei Ftp.class.php.

Benutzt $mode und mkdirs().

     {
          if   ( ! $this->ok )
               return;
               
          $ftp = parse_url( $this->url );

          $dest = $this->path.'/'.$dest;
          
          $this->log .= "Copying file: $source -> $dest ...\n";

          if   ( !@ftp_put( $this->verb,$dest,$source,$this->mode ) )
          {
               if   ( !$this->mkdirs( dirname($dest) ) )
                    return; // Fehler.

               ftp_chdir( $this->verb,$this->path );

               if   ( ! @ftp_put( $this->verb,$dest,$source,$mode ) )
               {
                    $this->ok = false;
                    $this->log[] = 'FTP PUT failed...';
                    $this->log[] = 'source     : '.$source;
                    $this->log[] = 'destination: '.$dest;
                    return;
               }
               
          }
     }

---

Dokumentation der Datenelemente

Ftp::$log = array()

Definiert in Zeile 34 der Datei Ftp.class.php.

Ftp::$mode = FTP_ASCII

Definiert in Zeile 35 der Datei Ftp.class.php.

Wird benutzt von put().

Ftp::$ok = true

Definiert in Zeile 38 der Datei Ftp.class.php.

Ftp::$passive = false

Definiert in Zeile 36 der Datei Ftp.class.php.

Ftp::$url

Definiert in Zeile 33 der Datei Ftp.class.php.

Wird benutzt von connect() und Ftp().

Ftp::$verb

Definiert in Zeile 32 der Datei Ftp.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• serviceClasses/Ftp.class.php