TnbSftpFile.h

[詳解]

#pragma once
#include <shlobj.h>
#include "TnbConsoleHooker.h"
#include "TnbFileFinder.h"
#include "TnbStrEx.h"
#include "TnbFileName.h"
 
 
 
//TNB Library
namespace TNB
{
 
 
 
class CSftpSession : CCopyImpossible
{
public:
 
    CSftpSession(LPCTSTR lpszWinScpPath = NULL)
    {
        m_winScpPath = lpszWinScpPath;
        if ( m_winScpPath.IsEmpty() )
        {
            TCHAR buf[MAX_PATH];
            #ifdef CSIDL_PROGRAM_FILESX86
                if ( ! SUCCEEDED(::SHGetFolderPath(NULL, CSIDL_PROGRAM_FILESX86, NULL, 0, buf)) )
            #endif
            {
                ::SHGetFolderPath(NULL, CSIDL_PROGRAM_FILES, NULL, 0, buf);
            }
            CFileName fn = buf;
            m_winScpPath = fn.GetFullShortName();
        }
        m_winScpPath.TrimRight(_T("\\"));
        m_winScpPath += _T("\\");
    }
 
    ~CSftpSession(void)
    {
        Close();
    }
 
    bool Open(LPCTSTR lpszServerName, LPCTSTR lpszUserName, LPCTSTR lpszPassword, DWORD to = 10000)
    {
        if ( STRLIB::GetLen(lpszUserName) == 0 || STRLIB::GetLen(lpszPassword) == 0 )
        {
            return false;
        }
        Close();
        CStr cl = m_winScpPath + _T("WinSCP\\WinSCP.com");
        STARTUPINFO si = { 0 };
        si.cb = sizeof(STARTUPINFO);
        si.dwFlags = STARTF_USESHOWWINDOW | STARTF_USECOUNTCHARS;
        si.wShowWindow = SW_HIDE;
        si.dwXCountChars = 256;
        si.dwYCountChars = 10000;
        if ( ! m_exe.Create(NULL, cl, si) )
        {
            cl = _T("WinSCP.com");
            m_exe.Create(NULL, cl, si);
        }
        if ( m_exe.IsAlive() )
        {
            ::Sleep(1000);
            if ( m_sftp.Hook(m_exe.GetProcessId()) )
            {
                if ( m_sftp.WaitString(_T("winscp>"), to) )
                {
                    CStrVector vs = CStr(_T("not exist"))       % _T("not exist")                   // 0
                                % _T("Session started.")        % _T("セッションを開始しました")    // 1
                                % _T("Authentication failed")   % _T("認証に失敗")                   // 2
                                % _T("to the cache?")           % _T("ホスト鍵をキャッシュに追加")   // 3
                                % _T("(U)pdate")                % _T("更新((U))");                    // 4
                    cl.Format(_T("open %s:%s@%s\r"), lpszUserName, lpszPassword, lpszServerName);
                    m_sftp.SendString(cl);
                    int r = m_sftp.WaitStringEx(vs, to);
                    r = (r >= 0) ? (r / 2) : r;
                    if ( r == 4/*更新*/ )
                    {
                        m_sftp.SendString(_T("u"));
                        r = m_sftp.WaitStringEx(vs, 1000);
                        r = (r >= 0) ? (r / 2) : r;
                    }
                    if ( r == 3/*CopyKey*/ )
                    {
                        m_sftp.SendString(_T("y"));
                        r = m_sftp.WaitStringEx(vs, 1000);
                        r = (r >= 0) ? (r / 2) : r;
                    }
                    if ( r == 1 )
                    {
                        // 接続成功
                        m_currentLocalDir = ms_GetCurrentDir();
                        cl.Format(_T("lcd %s\r"), ms_DQ(m_currentLocalDir));
                        if ( SftpCommand(cl) && SftpCommand(_T("option confirm off\r")) )
                        {
                            return true;
                        }
                    }
                }
                m_sftp.SendString(_T("exit\r"));
                m_sftp.GetString();
                m_sftp.Unhook();
                m_sftp.Terminate();
            }
            m_exe.Terminate();
        }
        return false;
    }
 
    void Close(void)
    {
        if ( m_sftp.IsHooked() )
        {
            m_sftp.SendString(_T("close\r"));
            m_sftp.SendString(_T("exit\r"));
            m_sftp.GetString();
            m_sftp.Unhook();
            m_exe.WaitForExit(5000);
            m_exe.Terminate();
        }
    }
 
    bool IsValid(void) const
    {
        return m_sftp.IsAlived();
    }
 
    bool CreateRemoteDir(LPCTSTR lpszRemoteDir)
    {
        CStr cl;
        cl.Format(_T("mkdir %s\r"), ms_DQ(lpszRemoteDir));
        return SftpCommand(cl);
    }
 
    bool RemoveRemoteDir(LPCTSTR lpszRemoteDir)
    {
        CStr cl;
        cl.Format(_T("rmdir %s\r"), ms_DQ(lpszRemoteDir));
        return SftpCommand(cl);
    }
 
    bool GetCurrentRemoteDir(CStr& _currentRemoteDir)
    {
        CStr cl = _T("pwd\r");
        if ( SftpCommand(cl) )
        {
            CStrVector log = GetLastString();
            loop ( i, log )
            {
                if ( ! log[i].IsEmpty() && log[i][0] == '/' )
                {
                    _currentRemoteDir = log[i];
                    return true;
                }
            }
        }
        return false;
    }
 
    bool SetCurrentRemoteDir(LPCTSTR lpszRemoveDir)
    {
        CStr cl;
        cl.Format(_T("cd %s\r"), ms_DQ(lpszRemoveDir));
        return SftpCommand(cl);
    }
 
    bool GetRemoteFile(LPCTSTR lpszNewLocalFile, LPCTSTR lpszRemoteFile, DWORD to = 10000)
    {
        if ( ! AdjustCurrentLocalDir() )
        {
            return false;
        }
        CStr cl;
        cl.Format(_T("get -preservetime %s %s\r"), ms_DQ(lpszRemoteFile), ms_DQ(lpszNewLocalFile));
        return SftpCommand(cl, to);
    }
 
    bool PutLocalFile(LPCTSTR lpszNewRemoteFile, LPCTSTR lpszLocalFile, DWORD to = 10000)
    {
        if ( ! AdjustCurrentLocalDir() )
        {
            return false;
        }
        CStr cl;
        cl.Format(_T("put -preservetime %s %s\r"), ms_DQ(lpszLocalFile), ms_DQ(lpszNewRemoteFile));
        return SftpCommand(cl, to);
    }
 
    enum ESyncMode
    {
        SyncMode_Local,     
        SyncMode_Remote,    
        SyncMode_Both,      
    };
 
    enum ESyncCriteria
    {
        SyncCriteria_Time,  
        SyncCriteria_Size,  
        SyncCriteria_Both,  
        SyncCriteria_Non,   
    };
 
    bool Synchronize(LPCTSTR lpszRemoteDir, LPCTSTR lpszLocalDir, ESyncMode mode, ESyncCriteria criteria = SyncCriteria_Both, DWORD to = 10000, LPCTSTR lpszOption = NULL)
    {
        m_synchronizedFiles.RemoveAll();
        if ( ! AdjustCurrentLocalDir() )
        {
            return false;
        }
        CStr s1;
        switch ( mode )
        {
        case SyncMode_Local:    s1 = _T("local");   break;
        case SyncMode_Remote:   s1 = _T("remote");  break;
        case SyncMode_Both:     s1 = _T("both");    break;
        default:
            return false;
        }
        CStr s2;
        switch ( criteria )
        {
        case SyncCriteria_Time: s2 = _T("-criteria=time");  break;
        case SyncCriteria_Size: s2 = _T("-criteria=size");  break;
        case SyncCriteria_Both: s2 = _T("-criteria=both");  break;
        case SyncCriteria_Non:                              break;
        default:
            return false;
        }
        CStr s3 = lpszOption;
        //
        CStr cl;
        cl.Format(_T("synchronize %s %s %s %s %s\r"), s1, s2, s3, ms_DQ(lpszLocalDir), ms_DQ(lpszRemoteDir));
        if ( ! SftpCommand(cl, to) )
        {
            return false;
        }
        const CStrVector& log = GetLastString();
        CStr last;
        loop ( i, log )
        {
            const CStr& ss = log[i];
            INT_PTR f = ss.Find(_T('|'));
            if ( f >= 0 )
            {
                CStr s = ss.Left(f).TrimRight(_T(' '));
                if ( last != s )
                {
                    m_synchronizedFiles.Add(s);
                    last = s;
                }
            }
        }
        return true;
    }
 
    const CStrVector& GetSynchronizedFiles(void) const
    {
        return m_synchronizedFiles;
    }
 
    bool DeleteRemoteFile(LPCTSTR lpszFileName)
    {
        CStr cl;
        cl.Format(_T("rm %s\r"), ms_DQ(lpszFileName));
        return SftpCommand(cl);
    }
 
    bool RenameRemoteFile(LPCTSTR lpszOldName, LPCTSTR lpszNewName)
    {
        CStr cl;
        cl.Format(_T("rename %s %s\r") , ms_DQ(lpszOldName), ms_DQ(lpszNewName));
        return SftpCommand(cl);
    }
 
    bool EnumRemoteFiles(CWorkMemT<WIN32_FIND_DATA>& _ls, LPCTSTR lpszRemoteDir = NULL)
    {
        CStr cl;
        cl.Format(_T("ls %s\r"), ms_DQ(lpszRemoteDir));
        if ( SftpCommand(cl) )
        {
            CVectorT<WIN32_FIND_DATA> ff;
            WIN32_FIND_DATA f = { 0 };
            SYSTEMTIME st = { 0 };
            CStrVector log = GetLastString();
            loop ( i, log )
            {
                CStr s = log[i];
                while ( s.Replace(_T("  "), _T(" ")) > 0 );
                CStrVector vs = CStrOperator::SeparatePeriod(s, ' ', false);
                if ( vs.GetSize() >= 11 )
                {
                    // WinSCP 4.36
                    // 0            1 2         3      4             5 6   7   8       9    10
                    // -rwx------   1 h-komatsu Domain Users      7534 Dec 22  9:04:25 2011 SILV ER.bmp
                    const CStr& attb = vs[0];
                    CStrVector mvs = CStrOperator::SeparatePeriod(vs[8], ':', false);
                    if ( mvs.GetSize() == 3 && attb.GetLength() >= 4 )
                    {
                        f.dwFileAttributes = (attb[0] == 'd') ? FILE_ATTRIBUTE_DIRECTORY : 0;
                        if ( attb[1] !='r' )
                        {
                            f.dwFileAttributes |= FILE_ATTRIBUTE_READONLY;
                        }
                        st.wYear = down_cast<WORD>(vs[9].ToInt());
                        st.wMonth = down_cast<WORD>(ms_ToMonth(vs[6]));
                        st.wDay = down_cast<WORD>(vs[7].ToInt());
                        st.wHour = down_cast<WORD>(mvs[0].ToInt());
                        st.wMinute = down_cast<WORD>(mvs[1].ToInt());
                        st.wSecond = down_cast<WORD>(mvs[2].ToInt());
                        ::FILETIME ft;
                        ::SystemTimeToFileTime(&st, &ft);
                        ::LocalFileTimeToFileTime(&ft, &f.ftCreationTime);
                        f.ftLastAccessTime = f.ftCreationTime;
                        f.ftLastWriteTime = f.ftCreationTime;
                        f.nFileSizeLow = vs[5].ToInt();
                        //
                        CStr txt;
                        txt.Format(_T("%d:%02d:%02d %4d "), st.wHour, st.wMinute, st.wSecond, st.wYear);
                        int l = ToInt(s.Find(txt));
                        ASSERT( l != INVALID_INDEX );
                        txt = s.Mid(l + txt.GetLength() );
                        ASSERT( txt.GetLength() < MAX_PATH );
                        STRLIB::Copy(f.cFileName, txt);
                        ff.Add(f);
                        continue;
                    }
                }
                if ( vs.GetSize() >= 8 )
                {
                    // WinSCP 4.37
                    // 0            1                    2        3   4  5        6    7
                    // -rw-rw-rw-   0                    10000000 May 21 12:43:01 2012 B.dat
                    // Drw-rw-rw-   0                           0 May 21 12:43:25 2012 ..
                    const CStr& attb = vs[0];
                    CStrVector mvs = CStrOperator::SeparatePeriod(vs[5], ':', false); //時分秒
                    if ( mvs.GetSize() == 3 && attb.GetLength() >= 4 )
                    {
                        f.dwFileAttributes = ((attb[0]|0x40) == 'd') ? FILE_ATTRIBUTE_DIRECTORY : 0;
                        if ( (attb[1]|0x40) !='r' )
                        {
                            f.dwFileAttributes |= FILE_ATTRIBUTE_READONLY;
                        }
                        st.wYear = down_cast<WORD>(vs[6].ToInt());
                        st.wMonth = down_cast<WORD>(ms_ToMonth(vs[3]));
                        st.wDay = down_cast<WORD>(vs[4].ToInt());
                        st.wHour = down_cast<WORD>(mvs[0].ToInt());
                        st.wMinute = down_cast<WORD>(mvs[1].ToInt());
                        st.wSecond = down_cast<WORD>(mvs[2].ToInt());
                        ::FILETIME ft;
                        ::SystemTimeToFileTime(&st, &ft);
                        ::LocalFileTimeToFileTime(&ft, &f.ftCreationTime);
                        f.ftLastAccessTime = f.ftCreationTime;
                        f.ftLastWriteTime = f.ftCreationTime;
                        f.nFileSizeLow = vs[2].ToInt();
                        //
                        CStr txt;
                        txt.Format(_T("%d:%02d:%02d %4d "), st.wHour, st.wMinute, st.wSecond, st.wYear);
                        int l = ToInt(s.Find(txt));
                        ASSERT( l != INVALID_INDEX );
                        txt = s.Mid(l + txt.GetLength() );
                        ASSERT( txt.GetLength() < MAX_PATH );
                        STRLIB::Copy(f.cFileName, txt);
                        ff.Add(f);
                        continue;
                    }
                }
            }
            _ls.Resize(ff);
            loop ( i, ff )
            {
                _ls[i] = ff[i];
            }
            return true;
        }
        return false;
    }
 
    bool ExistRemoteFile(WIN32_FIND_DATA& _fd, LPCTSTR lpszRemoteFile)
    {
        CStr rf = lpszRemoteFile;
        rf += _T("*"); //ワイルドにする
        CWorkMemT<WIN32_FIND_DATA> ls;
        if ( EnumRemoteFiles(ls, rf) )
        {
            loop ( i, ls.GetSize() )
            {
                if ( STRLIB::Compare(ls[i].cFileName, lpszRemoteFile, -1, NORM_IGNORECASE) == 0 )
                {
                    _fd = ls[i];
                    return true;
                }
            }
        }
        return false;
    }
 
    bool ExistRemoteFile(LPCTSTR lpszRemoteFile)
    {
        WIN32_FIND_DATA fd;
        return ExistRemoteFile(fd, lpszRemoteFile);
    }
 
    const CStrVector& GetLastString(void) const
    {
        return m_sftp.GetLastString();
    }
 
    void SetLastString(const CStrVector& vs)
    {
        m_sftp.SetLastString(vs);
    }
 
    static void TerminateWinscp(void)
    {
        CWorkMemT<DWORD> pids;
        loop ( j, 3 )
        {
            if ( CProcessHandle::EnumProcesses(pids, _T("WinSCP.com")) )
            {
                loop ( i, pids.GetSize() )
                {
                    CProcessHandle::TerminateProcessId(pids[i]);
                }
            }
            if ( CProcessHandle::EnumProcesses(pids, _T("WinSCP.exe")) )
            {
                loop ( i, pids.GetSize() )
                {
                    CProcessHandle::TerminateProcessId(pids[i]);
                }
            }
        }
    }
 
protected:
 
    bool SftpCommand(LPCTSTR lpszCommandLine, DWORD to = 1000)
    {
        CStr cl = lpszCommandLine;
        cl.Trim(_T(' '));
        if ( m_sftp.SendString(cl) )
        {
            CStrVector vs = CStr(_T("(A)bort,")) % _T("中止((A))") % _T("No session.") % _T("セッションなし") % _T("winscp>");
            int r = m_sftp.WaitStringEx(vs, to);
            r = (r >= 0) ? (r / 2) : r;
            if ( r == 2/*winscp>*/ )
            {
                return true;
            }
            if ( r == 1 )
            {
                Close();
            }
            else if ( r == 0/*abort*/ )
            {
                m_sftp.SendString(_T("a"));
                m_sftp.WaitString(_T("winscp>"), 1000);
            }
        }
        return false;
    }
 
    bool AdjustCurrentLocalDir(void)
    {
        CStr cp = ms_GetCurrentDir();
        if ( m_currentLocalDir != cp )
        {
            CStr cl;
            cl.Format(_T("lcd %s\r"), ms_DQ(cp));
            if ( ! SftpCommand(cl) )
            {
                return false;
            }
            m_currentLocalDir = cp;
        }
        return true;
    }
 
private:
    static CStr ms_GetCurrentDir(void)
    {
        CStr str;
        DWORD dwRc = ::GetCurrentDirectory(MAX_PATH, str.GetBuffer(MAX_PATH));
        str.ReleaseBuffer();
        ASSERTLIB( dwRc != 0 );
        IgnoreUnusedValue (dwRc);
        return str; 
    }
    static CStr ms_DQ(LPCTSTR lpsz)
    {
        CStr s = lpsz;
        if ( ! s.IsEmpty() )
        {
            s = s.Sandwich(_T("\""), _T("\""));
        }
        return s;
    }
    static int ms_ToMonth(LPCTSTR lpsz)
    {
        const LPCTSTR m[] =
        {
            _T("jan"), _T("feb"), _T("mar"), _T("apr"), 
            _T("may"), _T("jun"), _T("jul"), _T("aug"), 
            _T("sep"), _T("oct"), _T("nov"), _T("dec")
        };
        CStr s = LowerString(lpsz);
        loop ( i, countof(m) )
        {
            if ( s.IsEqual(m[i]) )
            {
                return ToInt(i + 1);
            }
        }
        return -1;
    }
    CProcessHandle  m_exe;                  
    CConsoleHooker  m_sftp;                 
    CStr            m_currentLocalDir;      
    CStr            m_winScpPath;           
    CStrVector       m_synchronizedFiles;   
    friend class CSftpSessionTest;
};
 
 
 
class CSftpFileFinder : public CAbstractFileFinder
{
    DEFSUPER(CAbstractFileFinder);
public:
 
    CSftpFileFinder(void) : _super()
    {
    }
 
    void Initialize(CSftpSession* pSftp)
    {
        Finish();
        m_pSftp = pSftp;
    }
 
    virtual ~CSftpFileFinder(void)
    {
        OnFinish();
    }
 
protected:
 
    virtual bool OnStart(WIN32_FIND_DATA& _data, LPCTSTR lpszName)
    {
        CStr s = lpszName;
        s.Replace(_T('\\'), _T('/'));
        s.Replace(_T("//"), _T("/"));
        Finish();
        if ( m_pSftp != NULL )
        {
            if ( m_pSftp->EnumRemoteFiles(m_list, s) )
            {
                m_pos = 0;
                return OnNext(_data);
            }
        }
        return false;
    }
 
    virtual bool OnNext(WIN32_FIND_DATA& _data)
    {
        if ( m_list.GetSize() > m_pos )
        {
            _data = m_list[m_pos];
            m_pos++;
            return true;
        }
        return false;
    }
 
    virtual void OnFinish(void)
    {
        m_list.Resize(0);
        m_pos = 0;
    }
 
private:
    CSftpSession*                   m_pSftp;        
    CWorkMemT<WIN32_FIND_DATA>      m_list;
    INDEX                           m_pos;
    friend class CSftpFileFinderTest;
};
 
 
 
}; // TNB
 
 
/*
    WinSCP のコマンドリファレンス
    http://sourceforge.jp/projects/winscp/wiki/script_commands
  キャッシュキーの場所
    HKEY_CURRENT_USER\Software\Martin Prikryl\WinSCP 2\SshHostKeys
  */