WUrl - Dashboard WidgetでURL上のファイルを読み込むプラグイン -

WUrlはMacのDashboard Widgetからウェブ上のファイルを読み込むことを可能とするプラグインです。
WUrlは以下の機能を提供しています。

関数名

説明

read

URLに存在するファイルの文字列を取得する。

readLine

URLのファイルで指定した行番号の文字列を取得する。

readBody

URLに存在するファイルの文字列を改行コード抜きで取得する。

lines

URLで指定したファイルの各行の文字列を配列で取得する。

line

URLで指定したファイルの行数を取得する。

download

ファイルをダウンロードする。

xml2jsonURL

URLのXMLファイルをJSON形式に変換して取得する。

プラグインをWidgetで利用する方法はコチラをご覧下さい。

プラグインをDashcodeでWidgetで利用する方法はコチラをご覧下さい。

Dashcodeを利用せずにプラグインを導入する方法はコチラを参考にして下さい。

Dashcodeを利用したWidgetの開発方法はコチラを参考にして下さい。

関数名

read

説明

指定URLに存在するファイルに含まれる全ての文字列を取得する。

定義

(String) WUrl.read(url);

引数

url: 読み込みファイルのURL。

返り値

ファイルの内容を全て文字列で返します。改行文字等も含まれます。

エラー

指定URLにファイルが存在しない場合、誤った引数を指定した場合は”undefined”を返します。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  var str = WUrl.read("http://www.adamrocker.com/index.html");
  if(!str) {
    // 読み込みに失敗したときの処理。
  }
}

関数名

readLine

説明

指定したURLのファイルの指定した行番号の文字列を取得する。

定義

(String) WUrl.readLine(url, line);

引数

url: 読み込みファイルのURL。

line: 読み込む行番号。

返り値

URLで指定したファイルの指定した行番号の文字列を返します。

エラー

指定URLが存在しない場合、行番号が不正であった場合、誤った引数を指定した場合は”undefined”を返します。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  var str = WUrl.readLine("http://www.adamrocker.com/test.txt", 7);
  if(!str) {
    // 読み込みに失敗したときの処理。
  }
}

関数名

readBody

説明

指定URLに存在するファイルに含まれる全ての文字列を取得する。

定義

(String) WUrl.readBody(url);

引数

url: 読み込みファイルのURL。

返り値

ファイルの内容を全て文字列で返します。改行文字等も含まれます。

エラー

指定URLにファイルが存在しない場合、誤った引数を指定した場合は”undefined”を返します。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  var str = WUrl.readBody("http://www.adamrocker.com/index.html");
  if(!str) {
    // 読み込みに失敗したときの処理。
  }
}

関数名

lines

説明

URLで指定ファイルの各行の文字列を配列として取得する。

定義

(Array) WUrl.lines(url);

引数

url: ファイルのURLパス。

返り値

URLで指定したファイルの各行の文字列を各要素に持つ配列。

エラー

誤った引数を指定した場合は”undefined”を返します。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  var lines = WUrl.lines("http://www.adamrocker.com/test.txt");
  if(!lines) {
    // エラー処理
  } else {
    for(var i=0; i<lines.length; i++) {
      alert(lines[i]);
    }
  }
}

関数名

line

説明

URLで指定したファイルの行数を取得する。

定義

(int) WUrl.line(url);

引数

url: ファイルが存在するURL。

返り値

指定したファイルの行数。

エラー

誤った引数を指定した場合は”undefined”を返します。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  var line = WUrl.line("http://www.adamrocker.com/test.txt");
    if(!line) {
      // エラー処理
    }
}

関数名

download

説明

指定したURLのデータをダウンロードし指定したファイル名に保存する。ダウンロードは非同期で行われます。ダウンロードの状態を取得できませんので、おまけ機能という位置づけです。

定義

(void) WUrl.download(url, file);

引数

url: ダウンロードしたいファイルのURL。

file: 保存するファイル名。絶対パスである必要がある。ディレクトリは存在している必要がある。

返り値

void

エラー

誤った引数を指定した場合は”undefined”を返します。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  WUrl.download("http://www.adamrocker.com/icon.gif", "/tmp/icon.gif");
}

関数名

xml2json

説明

指定したURLのXMLファイルをJSON形式に変換して取得する。

定義

(String) WUrl.xml2json(url);

引数

url: ファイルのURL。

返り値

指定したURLのXMLファイルをJSON形式に変換して文字列として返す。

エラー

• 誤った引数を指定した場合、XMLが不正であった場合は”undefined”を返します。
• XMLファイルの途中にコメント文が含まれる場合、XMLを解析できません。

使用例

if(window.WUrl) {//プラグインの読み込みチェック
  var json = WUrl.xml2json("http://www.adamrocker.com/dummy.xml");
  if(json) {
    // jsonをpaddingしてevalしてオブジェクトに変換
    var obj = eval("(" + json + ")");
  } else {
    // エラー処理
  }
}

備考

以下のXMLの場合、

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.google.com">
  <url name='test1'>
    <loc>blog</loc>
    <lastmod>00:00</lastmod>
  </url>
  <url name='test2'>
    <loc>wurl.html</loc>
    <lastmod>2007</lastmod>
  </url>
</urlset>

以下のJSONに変換されます。

{
  'urlset':{
    'url':[{
      '$attributes':{'name':'test1'},
      'loc':{'$value':'blog'},
      'lastmod':{'$value':'00:00'}
    },
    {
      '$attributes':{'name':'test2'},
      'loc':{'$value':'wurl.html'},
      'lastmod':{'$value':'2007'}
    }]
  }
}

各ノードの値を取得するには「$value」を利用し、各ノードの属性値を取得するには「$attributes」を利用する事に注意して下さい。
「/urlset/url/loc」の値と「/urlset/url」の属性値を取得するには以下のようにします。

if(window.WUrl) {//プラグインの読み込みチェック
  var json = WUrl.xml2json("http://www.adamrockcr.com/dummy.xml");
  if(json) {
    // jsonをpaddingしてevalしてオブジェクトに変換
    var obj = eval("(" + json + ")");
    // urlset.urlの属性値を取得する
    alert(obj.urlset.url[0].loc.$value);//'blog'
    alert(obj.urlset.url[0].$attributes.name);//'test1'
  } else {
    // エラー処理
  }
}

• 2007.11.25: バージョン1.0を公開。
• ファイルの改行コードを削除した本文を取得できるようになりました（readBody）。
• WFileからWUrlに関する部分を分離しました。

• Dashboard Widgetでローカルファイルにアクセスするプラグイン「WFile」
• Jorudan Transferを書籍紹介して頂きました
• ジョルダンの乗換案内ウィジェット「Jorudan Transfer」
• Dashcodeでウィジェット・プラグインを導入する方法
• WUrl - Dashboard WidgetでURL上のファイルを読み込むプラグイン -
• ウィジェット・プラグインを導入する方法
• Dashcodeでウィジェットを作成する方法