ftp.lib.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2022-2025  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2022     Anthony Berton        <bertonanthony@gmail.com>
 * Copyright (C) 2024-2026  MDW           <mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */
 
function dol_ftp_connect($ftp_server, $ftp_port, $ftp_user, $ftp_password, $section, $ftp_passive = 0)
{
  global $langs, $conf;
 
  $ok = 1;
  $error = 0;
  $connect_id = null;
  $newsectioniso = '';
  $mesg = "";
 
  if (!is_numeric($ftp_port)) {
    $mesg = $langs->transnoentitiesnoconv("FailedToConnectToFTPServer", $ftp_server, $ftp_port);
    $ok = 0;
  }
 
  if ($ok) {
    $connecttimeout = (!getDolGlobalString('FTP_CONNECT_TIMEOUT') ? 40 : $conf->global->FTP_CONNECT_TIMEOUT);
    $tmp_conn_id = 0;
    if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
      dol_syslog('Try to connect with ssh2_connect');
      $tmp_conn_id = ssh2_connect($ftp_server, (int) $ftp_port);
    } elseif (getDolGlobalString('FTP_CONNECT_WITH_SSL')) {
      dol_syslog('Try to connect with ftp_ssl_connect');
      $connect_id = ftp_ssl_connect($ftp_server, (int) $ftp_port, $connecttimeout);
    } else {
      dol_syslog('Try to connect with ftp_connect');
      $connect_id = ftp_connect($ftp_server, (int) $ftp_port, $connecttimeout);
    }
    if (!empty($connect_id) || !empty($tmp_conn_id)) {
      if ($ftp_user) {
        if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
          dol_syslog('Try to authenticate with ssh2_auth_password');
          if (!empty($tmp_conn_id) && ssh2_auth_password($tmp_conn_id, $ftp_user, $ftp_password)) {
            // Turn on passive mode transfers (must be after a successful login
            //if ($ftp_passive) ftp_pasv($connect_id, true);
 
            // Change the dir
            $newsectioniso = mb_convert_encoding($section, 'ISO-8859-1');
            //ftp_chdir($connect_id, $newsectioniso);
            $connect_id = ssh2_sftp($tmp_conn_id);
            if (!$connect_id) {
              dol_syslog('Failed to connect to SFTP after sssh authentication', LOG_DEBUG);
              $mesg = $langs->transnoentitiesnoconv("FailedToConnectToSFTPAfterSSHAuthentication");
              $ok = 0;
              $error++;
            }
          } else {
            dol_syslog('Failed to connect to FTP with login '.$ftp_user, LOG_DEBUG);
            $mesg = $langs->transnoentitiesnoconv("FailedToConnectToFTPServerWithCredentials");
            $ok = 0;
            $error++;
          }
        } else {
          if (!empty($connect_id) && ftp_login($connect_id, $ftp_user, $ftp_password)) {
            // Turn on passive mode transfers (must be after a successful login)
            if ($ftp_passive) {
              ftp_pasv($connect_id, true);
            }
 
            // Change the dir
            $newsectioniso = mb_convert_encoding($section, 'ISO-8859-1');
            if (!ftp_chdir($connect_id, $newsectioniso)) {
              $ok = 0;
              $mesg = $langs->transnoentitiesnoconv("FailedToChdirOnFTPServer");
            }
          } else {
            $ok = 0;
            $mesg = $langs->transnoentitiesnoconv("FailedToConnectToFTPServerWithCredentials");
          }
        }
      }
    } else {
      dol_syslog('FailedToConnectToFTPServer '.$ftp_server.' '.$ftp_port, LOG_ERR);
      $mesg = $langs->transnoentitiesnoconv("FailedToConnectToFTPServer", $ftp_server, $ftp_port);
      $ok = 0;
    }
  }
 
  $arrayresult = array('conn_id' => $connect_id, 'ok' => $ok, 'mesg' => $mesg, 'curdir' => $section, 'curdiriso' => $newsectioniso);
  return $arrayresult;
}
 
 
function ftp_isdir($connect_id, $dir)
{
  if (@ftp_chdir($connect_id, $dir)) {
    ftp_cdup($connect_id);
    return 1;
  } else {
    return 0;
  }
}
 
function dol_ftp_close($connect_id)
{
  // Close FTP connection
  if ($connect_id) {
    if (!getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
      return ftp_close($connect_id);
    }
  }
  return true;
}
 
function dol_ftp_delete($connect_id, $file, $newsection)
{
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    $newsection = ssh2_sftp_realpath($connect_id, ".").'/./'; // workaround for bug https://bugs.php.net/bug.php?id=64169
  }
 
  // Remote file
  $remotefile = $newsection.(preg_match('@[\\\/]$@', $newsection) ? '' : '/').$file;
  $newremotefileiso = mb_convert_encoding($remotefile, 'ISO-8859-1');
 
  //print "x".$newremotefileiso;
  dol_syslog("ftp/index.php ftp_delete ".$newremotefileiso);
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    return ssh2_sftp_unlink($connect_id, $newremotefileiso);
  } else {
    return @ftp_delete($connect_id, $newremotefileiso);
  }
}
 
function dol_ftp_get($connect_id, $localfile, $file, $newsection)
{
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    $newsection = ssh2_sftp_realpath($connect_id, ".").'/./'; // workaround for bug https://bugs.php.net/bug.php?id=64169
  }
 
  // Remote file
  $remotefile = $newsection.(preg_match('@[\\\/]$@', $newsection) ? '' : '/').$file;
  $newremotefileiso = mb_convert_encoding($remotefile, 'ISO-8859-1');
 
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    return fopen('ssh2.sftp://'.intval($connect_id).$newremotefileiso, 'r');
  } else {
    return ftp_get($connect_id, $localfile, $newremotefileiso, FTP_BINARY);
  }
}
 
function dol_ftp_put($connect_id, $file, $localfile, $newsection)
{
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    $newsection = ssh2_sftp_realpath($connect_id, ".").'/./'; // workaround for bug https://bugs.php.net/bug.php?id=64169
  }
 
  // Remote file
  $remotefile = $newsection.(preg_match('@[\\\/]$@', $newsection) ? '' : '/').$file;
  $newremotefileiso = mb_convert_encoding($remotefile, 'ISO-8859-1');
 
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    return ssh2_scp_send($connect_id, $localfile, $newremotefileiso, 0644);
  } else {
    return ftp_put($connect_id, $newremotefileiso, $localfile, FTP_BINARY);
  }
}
 
function dol_ftp_rmdir($connect_id, $file, $newsection)
{
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    $newsection = ssh2_sftp_realpath($connect_id, ".").'/./'; // workaround for bug https://bugs.php.net/bug.php?id=64169
  }
 
  // Remote file
  $remotefile = $newsection.(preg_match('@[\\\/]$@', $newsection) ? '' : '/').$file;
  $newremotefileiso = mb_convert_encoding($remotefile, 'ISO-8859-1');
 
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    return ssh2_sftp_rmdir($connect_id, $newremotefileiso);
  } else {
    return @ftp_rmdir($connect_id, $newremotefileiso);
  }
}
 
 
function dol_ftp_mkdir($connect_id, $newdir, $newsection)
{
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    $newsection = ssh2_sftp_realpath($connect_id, ".").'/./'; // workaround for bug https://bugs.php.net/bug.php?id=64169
  }
 
  // Remote file
  $newremotefileiso = $newsection.(preg_match('@[\\\/]$@', $newsection) ? '' : '/').$newdir;
  $newremotefileiso = mb_convert_encoding($newremotefileiso, 'ISO-8859-1');
 
  if (getDolGlobalString('FTP_CONNECT_WITH_SFTP')) {
    return ssh2_sftp_mkdir($connect_id, $newremotefileiso, 0777);
  } else {
    return @ftp_mkdir($connect_id, $newremotefileiso);
  }
}