TnbPop3Client.h

[詳解]

#pragma once
#include "TnbSocket.h"
#include "TnbMailContent.h"
#include "TnbMd5Computer.h"
#include "TnbQueueingReporter.h"
#include "TnbListQueue.h"
 
 
 
//TNB Library
namespace TNB
{
 
 
 
class CAbstractMailClient
{
public:
 
    struct IListener
    {
        virtual ~IListener(void) {}
        virtual void OnMailResponse(LPCSTR lpszRes) = 0;
        virtual void OnMailCommand(LPCSTR lpszCmd) = 0;
    };
 
 
    //---------------------------------
 
 
    CAbstractMailClient(void) : m_socket(false), m_piRep(&m_socket), m_pListener(NULL), m_responseTimeout(5000)
    {
        m_queue.SetEnvironment(m_piRep, &m_inner);
    }
 
    virtual ~CAbstractMailClient(void)
    {
        Disconnect();
    }
 
    LPCSTR GetErrorText(void) const
    {
        return m_ascErrorText;
    }
 
    void SetListener(IListener* pListener = NULL)
    {
        m_pListener = pListener;
    }
 
    void SetServerName(LPCTSTR lpszName, WORD wPort)
    {
        Disconnect();
        m_socket.SetServer(CSocketAddress(wPort, lpszName));
        SetReportInterface(&m_socket);
    }
 
    void SetReportInterface(IReport* pReport)
    {
        Disconnect();
        m_piRep = (pReport != NULL) ? pReport : m_piRep;
        m_inner.Empty();
        m_queue.SetEnvironment(m_piRep, &m_inner);
    }
 
    void SetResponseTimeout(DWORD tm)
    {
        m_responseTimeout = tm;
    }
 
    bool Disconnect(void)
    {
        bool r = true;
        if ( m_piRep->IsConnect() )
        {
            CAscii a;
            r = QuitCommand(a);
            loop ( i, 10 )
            {
                if ( ! m_piRep->IsConnect() )
                {
                    break;
                }
                ::Sleep(100);
            }
            m_piRep->Stop();
            m_inner.Empty();
        }
        return r;
    }
 
    bool Connect(void)
    {
        Disconnect();
        m_ascErrorText.Empty();
        if ( ! m_piRep->Start() )
        {
            SetErrorText("Server Not Found.");
            return false;
        }
        if ( ! OnConnect() )
        {
            m_piRep->Stop();
            return false;
        }
        return true;
    }
 
protected:
 
    virtual bool IsValidResponse(const CAscii& a) const = 0;
 
    virtual bool QuitCommand(CAscii& _res) = 0;
 
    virtual bool OnConnect(void) = 0;
 
    bool Read(CAscii& _res)
    {
        bool r = m_inner.Read(_res, m_responseTimeout);
        if ( r )
        {
            TRACE1( "Mail-Command Response = [%s]\n", _res );
            if ( m_pListener != NULL )
            {
                m_pListener->OnMailResponse(_res);
            }
        }
        else
        {
            SetErrorText("Timeout.");
        }
        return r;
    }
 
    bool Write(LPCSTR lpszCmd)
    {
        if ( m_piRep != NULL )
        {
            CAscii a = lpszCmd;
            a += "\r\n";
            LPCSTR lpsz = a;
            return m_piRep->Send(a.GetLength(), lpsz);
        }
        return false;
    }
 
    bool Command(CAscii& _res, LPCSTR lpszCmd)
    {
        Write(lpszCmd);
        if ( m_pListener != NULL )
        {
            m_pListener->OnMailCommand(lpszCmd);
        }
        if ( ! Read(_res) )
        {
            return false;
        }
        if ( ! IsValidResponse(_res) )
        {
            SetErrorText(_res); //受信文字列をエラー文字列とする
            _res.Empty();
            return false;
        }
        return true;
    }
 
    bool Command(LPCSTR lpszCmd)
    {
        CAscii s;
        return Command(s, lpszCmd);
    }
 
    bool ReadLines(CAsciiVector& _lines)
    {
        _lines.RemoveAll();
        CAscii res;
        while ( true )
        {
            bool r = m_inner.Read(res, m_responseTimeout);
            if ( ! r )
            {
                SetErrorText("Timeout.");
                return false;
            }
            if ( res == "." )
            {
                break;
            }
            _lines.Add(res);
        }
        return true;
    }
 
    bool IsConnect(void)
    {
        if ( ! m_piRep->IsConnect() )
        {
            m_ascErrorText = "Server Not Connected.";
            return false;
        }
        return true;
    }
 
    void SetErrorText(LPCSTR lpsz)
    {
        m_ascErrorText = lpsz;
    }
 
private:
    // インナークラス
    class CInner : public CQueueingReporter::IListener
    {
    public:
        void Empty(void)
        {
            m_recvLines.RemoveAll();
        }
 
        bool Read(CAscii& _res, DWORD time)
        {
            CTickCount tc;
            do
            {
                if ( ! m_recvLines.IsEmpty() )
                {
                    _res = m_recvLines.Take();
                    return true;
                }
                ::Sleep(100);
            }
            while ( ! tc.IsPassed(time) );
            return false;
        }
    protected:
        // イベント
        virtual bool OnReportEvent(const CReportEvent& ev)
        {
            ASSERT( ! ev.HasData() );
            return true;
        }
        // jyy真
        virtual size_t OnReportData(bool boIsLast, const IConstCollectionT<BYTE>& c)
        {
            if ( c.IsEmpty() )
            {
                return 0;
            }
            BYTE b = c.At(0);
            if ( b == 0 || b == 0x0A )
            {
                return 1;
            }
            loop ( i, c.GetSize() )
            {
                b = c.At(i);
                if ( b == 0 || b == 0x0D )
                {
                    CAscii a;
                    LPSTR lpsz = a.GetBuffer(i + 1);
                    loop ( j, i )
                    {
                        lpsz[j] = c.At(j);
                    }
                    lpsz[i] = 0;
                    a.ReleaseBuffer();
                    m_recvLines.Add(a);
                    return i + 1;
                }
            }
            return 0;
        }
    private:
        CListQueueT<CAscii> m_recvLines;    
    };
 
    CSocketClient       m_socket;           
    IReport*            m_piRep;            
    CQueueingReporter   m_queue;            
    CInner              m_inner;            
    CAscii              m_ascErrorText;     
    IListener*          m_pListener;        
    DWORD               m_responseTimeout;  
};
 
 
 
class CPop3Client : public CAbstractMailClient
{
    DEFSUPER(CAbstractMailClient);
public:
    
    enum EKind
    {
        POP3,   
        APOP    
    };
 
    struct TParam
    {
        int number; 
        int size;   
    };
 
    typedef CVectorT<TParam> CParamVector;  
 
 
    //----------------------------------
 
 
    CPop3Client(EKind kind = POP3) : _super(), m_kind(kind) 
    {
    }
 
    virtual ~CPop3Client(void)
    {
        Disconnect();
    }
 
    CAscii GetOpeningMessage(void) const
    {
        return m_ascOpeningMessage;
    }
 
    void SetServerName(LPCTSTR lpszName, WORD port = 110)
    {
        _super::SetServerName(lpszName, port);
    }
 
    void SetUser(LPCTSTR lpszUser, LPCTSTR lpszPassword)
    {
        m_ascUser = lpszUser;
        m_ascPassword = lpszPassword;
    }
 
    void SetKind(EKind kind)
    {
        m_kind = kind;
    }
 
    bool RequestNoop(void)
    {
        if ( IsConnect() )
        {
            return Command("NOOP");
        }
        return false;
    }
 
    bool RequestDelete(int number)
    {
        if ( IsConnect() )
        {
            return Command(CAscii::Fmt("DELE %d", number));
        }
        return false;
    }
 
    bool CancelDelete(void)
    {
        if ( Connect() )
        {
            return Command("RSET");
        }
        return false;
    }
 
    bool GetMailCount(TParam& _param)
    {
        _param.number = 0;
        _param.size = 0;
        if ( IsConnect() )
        {
            CAscii res;
            if ( Command(res, "STAT") )
            {
                m_GetTwoInt(_param, res, 4);
                return true;
            }
        }
        return false;
    }
 
    bool GetMailList(CParamVector& _list)
    {
        _list.RemoveAll();
        if ( IsConnect() )
        {
            CAscii res;
            if ( Command(res, "LIST") )
            {
                size_t c = res.ToInt(4);
                CAsciiVector va;
                if ( ReadLines(va) )
                {
                    if ( c == va.GetSize() )
                    {
                        loop ( i, va.GetSize() )
                        {
                            TParam t;
                            m_GetTwoInt(t, va[i], 0);
                            _list.Add(t);
                        }
                        return true;
                    }
                    SetErrorText("invalid list"); // 要求の 数取得できなかった。
                }
            }
        }
        return false;
    }
 
    bool GetMailContent(CAsciiVector& _mail, int number, int line = 0)
    {
        _mail.RemoveAll();
        if ( IsConnect() )
        {
            CAscii cmd;
            if ( line <= 0 )
            {
                cmd.Format("RETR %d", number);
            }
            else
            {
                cmd.Format("TOP %d %d", number, line);
            }
            if ( Command(cmd) )
            {
                return ReadLines(_mail);
            }
        }
        return false;
    }
 
    bool GetUidl(CAscii& _uidl, int number)
    {
        _uidl.Empty();
        if ( IsConnect() )
        {
            CAscii cmd;
            cmd.Format("UIDL %d", number);
            CAscii res;
            if ( Command(res, cmd) )
            {
                if ( res.ToInt(4) == number )
                {
                    INT_PTR p = res.ReverseFind(' ');
                    _uidl = res.Mid(p + 1);
                    return true;
                }
                SetErrorText("invalid uidl"); // 要求の uidl と異なる。
            }
        }
        return false;
    }
 
protected:
 
    virtual bool IsValidResponse(const CAscii& a) const
    {
        return a.Find("+OK") == 0;
    }
 
    virtual bool QuitCommand(CAscii& _res)
    {
        return Command(_res, "QUIT");
    }
 
    virtual bool OnConnect(void)
    {
        CAscii s;
        bool r = Read(s);
        if ( r && s.GetAt(0) == '+' )
        {
            m_ascOpeningMessage = s.Mid(4);
            if ( m_kind == POP3 )
            {
                //== POP3
                if ( Command("USER " + m_ascUser) )
                {
                    if ( Command("PASS " + m_ascPassword) )
                    {
                        return true;
                    }
                }
            }
            else
            {
                //== APOP
                INT_PTR is = s.Find('<');
                INT_PTR ie = s.Find('>', is);
                if ( is >= 0 && ie > is )
                {
                    CAscii a = s.Mid(is, ie - is + 1);
                    CAscii h = CMd5Computer::ComputeHash(a + m_ascPassword).GetString();
                    if ( Command(CAscii::Fmt("APOP %s %s", m_ascUser, h)) )
                    {
                        return true;
                    }
                }
            }
        }
        return false;
    }
 
private:
 
    CAscii      m_ascOpeningMessage;    
    CAscii      m_ascUser;              
    CAscii      m_ascPassword;          
    EKind       m_kind;                 
 
    void m_GetTwoInt(TParam& _param, const CAscii& asc, int iOffset)
    {
        INT_PTR p = asc.ReverseFind(' ');
        _param.number = asc.ToInt(iOffset);
        _param.size = asc.ToInt(p + 1);
    }
 
};
 
 
 
}; // TNB
 
 
 
#if 0
USER・PASS コマンドによってユーザ認証を行う。 
LIST コマンドでメール一覧を受け取る。 
それから各メールについて、 
RETR コマンドでメールの内容を受け取り、 
DELE コマンドでメールをサーバから削除する。 
QUIT コマンドで通信終了
 
 
サーバ         <wait for connection on TCP port 110>
クライアント  <open connection>
サーバ         +OK POP3 server ready <1896.697170952@dbc.mtview.ca.us>
--
クライアント  USER メールアカウント名<CRLF>
サーバ         +OK <CRLF>
クライアント  PASS パスワード<CRLF>
サーバ         +OK <CRLF>
--
クライアント  APOP mrose c4c9334bac560ecc979e58001b3e22fb
サーバ         +OK mrose's maildrop has 2 messages (320 octets)
--
 
クライアント  STAT
サーバ         +OK 2 320
クライアント  LIST
サーバ         +OK 2 messages (320 octets)
サーバ         1 120
サーバ         2 200
サーバ         .
 
クライアント  RETR 1
サーバ         +OK 120 octets
サーバ         <the POP3 server sends message 1>
サーバ         .
 
クライアント  DELE 1
サーバ         +OK message 1 deleted
クライアント  RETR 2
サーバ         +OK 200 octets
サーバ         <the POP3 server sends message 2>
サーバ         .
クライアント  DELE 2
サーバ         +OK message 2 deleted
 
クライアント  QUIT
サーバ         +OK dewey POP3 server signing off (maildrop empty)
クライアント  <close connection>
サーバ         <wait for next connection>
#endif