Was this page helpful?

6.插件(Plug-in)

    內容表格
    沒有標頭

    WonderBox指令插件(command plug-in or method plug-in)

     

    Wonderbox特色

    WonderBox 簡化了分享的程序,讓分享變成再簡單不過的行為,WonderBox專利的網路穿透技術免除固定IP的需求、也不再對IP分享器做任何轉Port的繁複設定,只要接上網路,即刻與網際網路(Internet)接軌,不再需要像DropBox這類的網路硬碟,就可輕鬆隨時提供跨地域網路存取服務,容量不夠可隨心所欲加上硬碟即可。輕鬆分享,讓外界的好友連接你專屬的NAS

    免固定IP、免對IP分享器做任何轉Port的繁複設定,Plug&Play

     

    • 可設定多組帳號,並提供遠端連入服務

    • 提供遠端管理機制可線上/離線傳送訊息與檔案

    • 支援Streaming影音串流機制,邊下載邊播放

    • 支援iPhoneiPadAndroid等手持裝置使用

    • 支援在各種桌面作業系統使用Windows, Mac, Linux

    • 可自行開發插件(plug-in)擴充WonderBox功能

     

    1. 目的:

     

            利用WonderBox核心引擎機制, 開發客製化插件(plug-in)應用擴充功能。

     

    1. 插件(plug-in)結構說明:

            每組插件皆包含兩部份:

      1. 設定檔

    (假設/wbox WonderBox安裝目錄)

    (1) 設定檔必須存到/wbox/conf/ 目錄下

    (2) 設定檔必須是json 格式

      1. 執行檔

    (假設/wbox WonderBox安裝目錄)

    (1) 執行檔存放的位置是依設定檔path 所指定的檔案路徑

     

     

    先來看個簡單的範例
    (
    假設/wbox WonderBox安裝目錄)

    設定檔: hello_world.json

    所以其檔案含路徑/wbox/conf/hello_world.json

    檔案內容如下:

     

    {

    "module-plugin": [

    {

    "name": "/unet/hello_world.DiskUsage",

    "path": "ext/hello_world/hello_world_disk_usage.sh",

    "allow": [ "user", "admin" ],

    "argument": "env",

    "disable": 0

    },

    {

    "name": "/unet/hello_world.ProcessInfo",

    "path": "ext/hello_world/hello_world_process_info.sh",

    "allow": [ "user", "admin" ],

    "argument": "env",

    "disable": 0

    }

    ]

    }

     

     

    設定檔中屬性的說明:

    "name": "/unet/hello_world.ProcessInfo" 表示指令名稱, 且其中/unet/』是必要的.

    "path": "ext/hello_world/hello_world_process_info.sh" 表示執行檔的完整檔案含路徑為/wbox/ext/hello_world/hello_world_process_info.sh

    "allow": [ "user", "admin" ] 表示允許授權使用者和管理者使用該指令。

    "argument": "env" 參數是透過環境變數傳遞給執行檔。

    "disable": 0 目前開啟可使用。

     

    以上例子定義了兩個指令:

    /unet/hello_world.DiskUsage /unet/hello_world.ProcessInfo

    其對應的執行檔分別為:

    /wbox/ext/hello_world/hello_world_disk_usage.sh

    /wbox/ext/hello_world/hello_world_process_info.sh

    (記得要chmod +x 使這二個執行檔成為可執行)


    再假設此二執行檔的內容為如下之Shell Script :
    /wbox/ext/hello_world/hello_world_disk_usage.sh =>
    執行df指令
    #!/bin/bash

     

    df

    if [ "$?" != "0" ]; then

    echo "'df' execute failed"

    fi

    /wbox/ext/hello_world/hello_world_process_info.sh =>執行PS指令,並可下參數
    #!/bin/bash

     

    if [ "$WBX_PARAM_KEYWORD" == "" ]; then

    echo "need parameter 'keyword'"

    exit 1;

    fi

     

    ps -ef|grep ${WBX_PARAM_KEYWORD}

    if [ "$?" != "0" ]; then

    echo "'ps' execute failed"

    fi

     

    插件指令之使用方法: 可用瀏覽器或其他方法(curl指令),透過HTTP協定即可使用

    方法一:直接連結: (wonderbox 同網段或網路路徑可連通時)

    http://192.168.1.100:8101/unet/hello_world.DiskUsage

    方法二:透過tunnel連結(wonderbox無法直接連結時)

    http://stwp26.cyberhood.net.tw/ucloud.a103089/unet/hello_world.DiskUsage

     

    上述方法中的指令寫法說明如下:

    192.168.1.100 => Wonderbox所在的IP

    8101 => Wonderboxlisten port,預設設定於conf.json 中。

    stwp26.cyberhood.net.tw => Wonderbox連接的tunnel server

    103089 => WonderBoxService ID

    其中, tunnel server 必須在使用前先詢問Center (cloud.wonderbox.net.tw), 指令為http://cloud.wonderbox.net.tw/_rpc/v...troller_alias=103089

    ( 103089 WonderboxService ID )

    回傳值:

    0, "","",17856,9815,"cloud.wonderbox.net.tw"
    33,"61.219.98.65","192.168.1.47","stwp26.cyberhood.net.tw"
    tunnel server就是回傳值中的第2列的最後一欄  

    附帶說明 : (a) 上述回傳值第1列的第一個值若不是0, 則表指令執行有誤,

                     (b) 上述指令必須在登入後才能使用, 且寫法若搭配權限設定時, 必須再加上其他必要參數, 詳細說明請參考下方使用權限 

     

    1. 插件(plug-in)的使用權限

     

        Wonderbox 的使用者分成三種:admin, user, anonymous, 說明如下:

    (a) admin: Wonderbox 預設之管理權限使用者, 連線來自同網段、經過授權來自不同網段或透過tunnel 連結的使用者。

    (b) user: wonderBox檔案總管->權限管理->帳號管理(或是WonderBox裝置管理員->User Accounts) 中建立的使用者。

    (c) anonymous: 訪客使用者。

     

    系統會依照設定allow屬性,允許那些使用者可執行插件。插件本身可利用環境變數WBX_USER_ID得知執行使用者身份。

         

    設定範例1:

    {

    "name": "/unet/hello_world.DiskUsage",

    "path": "ext/hello_world/hello_world_disk_usage.sh",

    "allow": [ "user", "admin" ],

    "argument": "env",

    "disable": 0

    }

    設定範例2:

    {

    "name": "/unet/hello_world.DiskUsage",

    "path": "ext/hello_world/hello_world_disk_usage.sh",

    "allow": [ "admin" ],

    "argument": "env",

    "disable": 0

    }

    設定範例3:

    {

    "name": "/unet/hello_world.DiskUsage",

    "path": "ext/hello_world/hello_world_disk_usage.sh",

    "allow": [ "admin", "user", "anonymous" ],

    "argument": "env",

    "disable": 0

    }

     

    admin的密碼可以設定或不設定,差別在於:

    * 沒有設定密碼,連線來自同網段直接授權,連線來自不同網段或透過tunnel者拒絕授權。

    * 有設定密碼,連線來自同網段、不同網段或透過tunnel者都會先詢問密碼。

    密碼設定處:

    * WonderBox系統設定>安全性>Admin密碼

    * WonderBox裝置管理員>Service>Admin Password

     

    user在使用前要先登入

    http://cloud.wonderbox.net.tw/_rpc/v3/rpc.php?__dbid=0&__ver=2&__style=csv&__rpcname=SystemEx/UserLogin3&&pop3_login=2&login_name=103089_myusername&login_passwd=mypasswd

     

    (參數說明 : )

    103089WonderServiceService ID

    myusername使用者名稱

    mypasswd使用者密碼

     

    回覆內容:

     

    0, "","",681,7226,"cloud.wonderbox.net.tw"

    "DJGBHVEKFYQMTLDEAUFHCTBUA8ETCDAEDHEJHHE9D2"

     

    回傳內容中的 DJGBHVEKFYQMTLDEAUFHCTBUA8ETCDAEDHEJHHE9D2授權字串(使用插件時會用到)

     

    使用插件時,要多加一個參數u_str

    http://stwp26.cyberhood.net.tw/uclou...orld.DiskUsage?u_str=DJGBHVEKFYQMTLDEAUFHCTBUA8ETCDAEDHEJHHE9D2

    或是加在cookie 中也可以。

     

    1. 插件(plug-in)的參數,分成系統參數與自訂參數。

     

    當以環境變數的形式出現時,有以下
    系統參數(可於程式中自行運用)

    WBX_USER_ID=15

    WBX_CLIENT_IP=192.168.1.33

    WBX_NAME=/unet/hello_world.DiskUsage

    WBX_SERVICE_HOME=/home/hmc

    WBX_SERVICE_ID=103033

     

    WBX_USER_IDuser's ID0 表示admin-1 表示anonymous

    WBX_CLIENT_IPclient's IP

    WBX_NAME為指令名稱

    WBX_SERVICE_HOMEWonderBox安裝的目錄

    WBX_SERVICE_IDWonderBoxService ID

     

     

    自訂參數在環境變數的形式中,名稱會有些改變,如:

    http://192.168.1.100:8001/unet/hello...ld.ProcessInfo?keyword=Wonder

    傳遞給執行檔時,參數名稱會變為WBX_PARAM_KEYWORD

    也就是"WBX_PARAM_" + upper_case("keyword")

     

    1. 插件(plug-in)還有其他屬性:

     

    "time-out": 30000

    "argument": "json", (option)可用值:"standard", "json"(預設), "env"

    "response": "text" (option)可用值:"text"(預設), "pass-through"

     

    time-out逾時時間(millisecond)0 表示不等待,預設為60(60000 millisecond)

    argument參數傳遞給執行檔時的形式,"standard", "json"(預設), "env"

    argument: "env" 表示參數內容會放在環境變數。

    如果參數值過大,可能會造成環境變數空間不足,這時就可以考慮改用

    argument: "json" 參數會從stdinjson的格式傳入,參數名稱會保持原有的大小寫。

     

    {

    "user-id": 15,

    "client-ip": "192.168.1.33",

    "name": "/unet/hello_world.DiskUsage",

    "service-home": "/home/hmc"

    "service-id": 103033,

    "parameters": {

    "keyword": "Wonder",

    "name2": "xxx",

    "name3": "xxx"

    }

    }

     

    argument: "standard" 是將所有參數都放在執行檔後面作為引數,實務上不"env"來的方便,就不再贅述。

     

    response執行回覆的方式,"text"(預設), "pass-through"

    response: "text" 表示指令(執行檔)執行完畢後,才會一併將輸出結果傳回client

    但是有些指令執行較久,你會希望盡快看到執行中的輸出,或者輸出量大,若不即時傳client,其實就是佔用記憶體空間,這時就可以改用

    response: "pass-through" 一有輸出就即刻傳回client

    使用"pass-through" 要注意一點,就是HTTP header要自行產生,至少要以下幾行(shell script為例)

     

    echo "HTTP/1.1 200 OK"

    echo "Content-Type: text/plain"

    echo ""

     

    至此描述的WonderBox插件(plug-in)可以說是指令插件(command plug-in or method plug-in),之後還會有其他類型的插件介紹:

     

    * 事件插件(event plug-in)

    * 規則插件(policy plug-in)

    * 內置網頁

    * 中繼網站

     

    (待續)......

    如有任何問題,歡迎來信討論指教...


    官網: www.wonderbox.net.tw
    郵件地址: [email protected]

    Was this page helpful?
    標籤 (Edit tags)
    • No tags
    查看第1個(總1個)評論: 查看所有
    很棒的分享, 很實用喔
    發佈時間 22:08, 27 Nov 2013 ()
    查看第1個(總1個)評論: 查看所有
    您必須 登入 才能發佈評論。
    Powered by MindTouch Core