PTT-BOT

Overview

Ptt-bot 是一個開放原始碼的專案，它的目標在於提供開發者在開發批踢踢機器人所需要的底層架構與函式和上層應用程式，解決需要開發時會遇到的各種底層惱人的問題。Ptt-bot 由 JavaScript1 編寫，並需要在 node.JS 的環境下運行。Ptt-bot 使用 node.JS 原生的 Net 套件進行 Telnet2 的連線，並利用 iconv-lite 和 String.js 套件分別解決 Big5編碼3 與字串解析的問題。

Ptt-bot is an open source node.js project for crawling data from PTT4.

關鍵字:　批踢踢機器人、自動化、PTT Crawler

How to use it?

當您想要某個功能時，可以藉由base-method組合您想要的機器人。舉一個可以自動爬某版文章內容為例:

/*  與Ptt-sever建立連線  */
myBot.login( id, ps, function(){ //請自行輸入帳號密碼

    /*  登入完後即停留在主功能表 */ 
    console.log('已進入主功能表');

});

/*  進入欲收集的電影版版中 */
myBot.toBoard('movie',function(){

    console.log('已進入movie板，接著收集文章!');

});

/*  從編號54635的文章開始收集 */
_indexForArticle = 54635; //global

/*  往後收集5篇文章    */
for( var _=0;_<5;_++ ){

    /*  先進入文章中  */
    myBot.toArticle(_+_indexForArticle,function(){ 

        console.log('進入'+_indexForArticle+'文章中');

    });

    /*  接著下載文章  */
    myBot.loadArticle(function(){

        /*  從getArticle()取得文章內容 */
        fs.writeFile('./'+'movie'+_indexForArticle+'_withoutANSI.txt', iconv.encode( myBot.escapeANSI( myBot.getArticle() ),'big5' ), function (err) {

            if (err) throw err;
            console.log('movie'+_indexForArticle+' 已經被儲存囉!');
            _indexForArticle++;

        });

    });

}

以上程式碼收錄在mybot.js中，然而以上的功能也已被寫入collectArticleFromBoard()中，只需要輸入版名、起始文章編號、欲收集總數和欲儲存的路徑便可以直接執行。

/*  與Ptt-sever建立連線  */
myBot.login( id, ps, function(){ //請自行輸入帳號密碼

    /*  登入完後即停留在主功能表    */
    console.log('已進入主功能表');

});

/*  直接執行收集文章的功能 */
myBot.collectArticleFromBoard('movie',54600,100,'./');

若您有開發了有趣的功能，請您別吝嗇分享給我們! 讓我們也可以收錄於applied-method中。:)

Development

第一次可以先執行此指令, 以安裝所有套件。或自行個別安裝(參閱 Require)。

    npm i LiveScript
    ./package.ls
    npm i

Require

string.js

    npm install --save string

iconv-lite

    npm install iconv-lite

Base-method

login(id, ps, callback)

執行登入ptt-sever的功能，登入完後會停留在【主功能表】的頁面。開發者需要自行輸入機器人的帳號及密碼，並且回傳已連上ptt:23的connection物件。connection物件擁有write()等功能，connection物件詳細內容需參考Net原生套件b1。
```
var conn = myBot.login('yourID','yourPassword',function(){  

    /* callback: 登入後執行的回呼涵數 */
    console.log( myBot.getScreen() );//取得【主功能表】的頁面

});
```
sendPressAnyKey(callback)

當頁面要求"按任意鍵繼續"時，可以執行此函數。
sendCtrlL(callback)

當頁面出現漏字時，可以執行此函數，要求重新傳送完整當頁頁面。
sendPageUp(callback)

在【看板列表】和【文章列表】下皆可執行此函數，類似在批踢踢瀏覽時的往上翻頁的動作。
sendPageDown(callback)

在【看板列表】和【文章列表】下皆可執行此函數，類似在批踢踢瀏覽時的往下翻頁的動作。
sendLeft(callback)

類似在批踢踢瀏覽時按左鍵的功能。
sendRight(callback)

類似在批踢踢瀏覽時按右鍵的功能。
getScreen()

取得目前頁面含色碼的資料，一般放在某指令的回呼函數，以取得執行完該函數的頁面內容。
getArticle()

當進入某篇文章時，若希望下載該篇文章完整內容，須先執行loadArticle()，並在loadArticle()的回呼函數執行getArticle()取得完整內容。
```
/* 在某篇文章內 */    
bot.loadArticle(function(){

    /* 取得去除色碼的完整內容 */
    console.log( escapeANSI( bot.getArticle() ) );

});
```
escapeANSI(str)

去除頁面的所有色碼及位移碼。
toMain(callback)

在任何頁面下，皆可以執行此函數回到【主功能表】。
toBoard(BoardName,callback)

在任何頁面下，皆可以執行此函數到某版的【文章列表】，請輸入正確版看板名稱。
toArticle(NumStr,callback)

僅能在某版的【文章列表】下使用，進入某篇文章編號為NumStr的文章內。
loadArticle(callback)

下載文章，僅能在【文章內】，通常和getArticle()連同使用，詳細舉例可以參考getArticle()內容。

execFuntion(func)

執行函數的內容。因為Ptt-bot的後端為先紀錄開發者為機器人下的所有指令，紀錄完後才開始執行連線，因此若在指令間放置其他函數會造成問題

/* 不行的寫法 */
sendPageUp();//第一次翻上頁
console.log('hi');//此函數會比第一次翻上頁還要先被執行 
sendPageUp();

/* 可以的寫法 */
sendPageUp();//第一次翻上頁
execFuntion(function(){
    console.log('hi');//會依序在翻第一次翻上頁後，才執行
});
sendPageUp();

Applied-method

collectArticleFromBoard(boardName,startIndex,totalAmount,targetDic)

收集某個版的文章內容(含色碼)，從編號為startIndex的文章開始，收集共totalAmount篇文章，收集後的文章內容，存放於targetDic路徑中。
collectArticleFromBoardWithoutANSI(boardName,startIndex,totalAmount,targetDic)

收集某個版的文章內容(不含色碼)，從編號為startIndex的文章開始，收集共totalAmount篇文章，收集後的文章內容，存放於targetDic路徑中。

References

Contribute to ptt-bot

我們都希望Ptt-bot這個專案能夠持續的進步! 若有發現臭蟲或問題，請幫我們在Issue留言告知我們詳細情形。若願意分享您的程式碼，也請歡迎Pull Request。:)

mbilab / ptt-bot

readme