ssh2_scp_send

(PECL ssh2 >= 0.9.0)

ssh2_scp_send — SCP 経由でファイルを送信する

説明

ssh2_scp_send(
    resource $session,
    string $local_file,
    string $remote_file,
    int $create_mode = 0644
): bool

ローカルファイルシステムからリモートサーバーに SCP プロトコルを使用してコピーします。

パラメータ

session: ssh2_connect() のコールによって取得した SSH 接続リンク ID。
local_file: ローカルファイルへのパス。
remote_file: リモートファイルへのパス。
create_mode: ファイルは create_mode で指定されたモードで作成されます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

例

例1 SCP 経由でのファイルのアップロード

<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

ssh2_scp_send($connection, '/local/filename', '/remote/filename', 0644);
?>

参考

ssh2_scp_recv() - SCP 経由でファイルを要求する
copy() - ファイルをコピーする

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

stefanov at uk dot ibm dot com ¶

16 years ago

In addition to my previous post, I figured out that sftp->fopen->file_get_contents->fwrite has much better performance than ssh2_scp_send.

I've used the following code to test:

<?php
$srcFile = '/var/tmp/dir1/file_to_send.txt';
$dstFile = '/var/tmp/dir2/file_received.txt';

// Create connection the the remote host
$conn = ssh2_connect('my.server.com', 22);

// Create SFTP session
$sftp = ssh2_sftp($conn);

$sftpStream = @fopen('ssh2.sftp://'.$sftp.$dstFile, 'w');

try {

    if (!$sftpStream) {
        throw new Exception("Could not open remote file: $dstFile");
    }
    
    $data_to_send = @file_get_contents($srcFile);
    
    if ($data_to_send === false) {
        throw new Exception("Could not open local file: $srcFile.");
    }
    
    if (@fwrite($sftpStream, $data_to_send) === false) {
        throw new Exception("Could not send data from file: $srcFile.");
    }
    
    fclose($sftpStream);
                    
} catch (Exception $e) {
    error_log('Exception: ' . $e->getMessage());
    fclose($sftpStream);
}
?>

For the test I've sent three files with total size of 6kB, and the times to send including connect to the server were:

SFTP -> 15 sec.
ssh2_scp_send -> 22 sec.

Cheers,

Pimmy

down

emmanuel dot kartmann at prosdk dot com ¶

14 years ago

On Windows, I had trouble using ssh2_scp_send: files copied to a remote server where incomplete (truncated) and/or locked (error message : "access denied"). The back-end is also on Windows, using CopSSH (cygwin-based SSH server).



The SSH session was kept open - and the file were never flushed to disk.



There's a workaround though - make an explicit call to "exit" to close the session (flushing file content to disk):



<?php

  $objConnection = ssh2_connect($strHost, $strPort, $methods, $callbacks);

  ssh2_auth_password($objConnection, $strUser, $strPassword);

  ssh2_scp_send($objConnection , $strSource, $strDest);



  // Add this to flush buffers/close session

  ssh2_exec($objConnection, 'exit');

?>

down

stefanov at uk dot ibm dot com ¶

16 years ago

After some testing I figured out that ssh2_scp_send does not work exactly as the standard scp command:

- Works: ssh2_scp_send($conn, '/var/tmp/file_01.txt', /var/tmp/file_02.txt');
- Wrong: ssh2_scp_send($conn, '/var/tmp/file_01.txt', /var/tmp'); (Creates file with name 'tmp')
- Fails: ssh2_scp_send($conn, '/var/tmp/file_01.txt', /var/tmp/');
- Fails: ssh2_scp_send($conn, '/dirname', /var/tmp/'); (No recursion)
- Fails: ssh2_scp_send($conn, '/dirname/*', /var/tmp/'); (Cannot copy more than one file.)

Cheers,

Pimmy

down

-2

j dot patus at simpledino dot com ¶

7 years ago

In case the command:

$sftpStream = @fopen('ssh2.sftp://'.$sftp.$dstFile, 'w');

causes you a segmentation fault, try using:

$sftpStream = @fopen('ssh2.sftp://'.intval($sftp).$dstFile, 'w');

Credit: http://stackoverflow.com/questions/7414175/php-sftp-seg-fault

＋add a note