download.js
9.86 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
/*eslint no-invalid-this:0*/
/*jshint -W100*/
'use strict';
var util = require('util');
var events = require('events');
var stream = require('stream');
var async = require('async');
var assign = require('object-assign');
var cutil = require('./util');
module.exports = function (encoding, client, cheerio) {
var urlCache = [];
/**
* ダウンロードイベント管理用クラス
*
* すべてのダウンロード結果はこのクラスにemit()される
* - success: ダウンロード完了時(url, buffer)
* - error: ダウンロード失敗時(error)
*/
var DownloadEvent = (function () {
function DownloadEvent() {
events.EventEmitter.call(this);
this.parallel = 3;
this.state = Object.freeze({
queue: 0, // ダウンロードキューに残っている順番待ち画像の数
complete: 0, // ダウンロードが完了した画像の数
error: 0 // ダウンロードが失敗した画像の数
});
}
util.inherits(DownloadEvent, events.EventEmitter);
/**
* URLキャッシュクリア
*/
DownloadEvent.prototype.clearCache = function () {
urlCache.length = 0;
};
return DownloadEvent;
})();
var downloadEvent = new DownloadEvent();
Object.defineProperty(client.core, 'download', {
enumerable: true,
get: function () {
return downloadEvent;
}
});
/**
* ダウンロードストリームクラス
*/
var DownloadStream = (function () {
function DownloadStream(res) {
stream.PassThrough.call(this);
this.url = (res.request) ? res.request.uri : 'base64';
this.type = res.headers['content-type'];
this.length = Number(res.headers['content-length'] || -1);
// タイムアウト時間を過ぎてもStreamの読み出しが行われていない場合は放置されているとみなす
this.__timer = setTimeout((function () {
if (! this.isUsed()) {
clearTimeout(this.__timer);
this.__timer = null;
this.emit('error', new Error('stream timeout (maybe stream is not used)'));
}
}).bind(this), client.core.timeout);
}
util.inherits(DownloadStream, stream.PassThrough);
/**
* Stream => Buffer
*
* @param cb 変換後のBufferを受け取るコールバック関数(err, buffer)
*/
DownloadStream.prototype.toBuffer = function (cb) {
if (! (cb instanceof Function)) {
throw new Error('callback is not function');
}
if (this.isUsed()) {
throw new Error('stream has already been read');
}
var buffer = [];
this.on('data', function (chunk) {
buffer.push(chunk);
});
this.on('error', function (err) {
cb.call(this, err);
});
this.on('end', function () {
cb.call(this, null, Buffer.concat(buffer));
});
};
/**
* Streamの読み出しが開始されたかどうか(on('data')/pipe()が使用された形跡でチェック)
*
* @return true: 開始された
*/
DownloadStream.prototype.isUsed = function () {
return (this._readableState.pipesCount > 0 || this.listeners('data').length > 0);
};
/**
* 手動でend()が呼ばれた場合はスキップ扱いにする
*/
DownloadStream.prototype.end = function () {
if (! this.__timer) {
return;
}
clearTimeout(this.__timer);
this.__timer = null;
this.emit('end');
};
return DownloadStream;
})();
/**
* イベント管理用クラスカウントを更新
*/
function updateState(counts) {
client.core.download.state = Object.freeze(
assign({}, client.core.download.state, counts)
);
}
/**
* ダウンロード統括管理用クラス
*/
var DownloadManager = (function () {
var jobRunning = false;
/**
* ダウンロードループ実行
*/
function downloadJob(manager) {
// 実行フラグON
jobRunning = true;
// 現在キューに入っている分を全部切り出して一時キューに移動
var qLen = manager.queue.length;
var tmp = {
queue: manager.queue.splice(0, qLen),
complete: 0,
error: 0,
applyState: function (complete, error) {
// 一時キューの処理状況をダウンロードマネージャーに反映させる
this.complete += complete;
this.error += error;
updateState({
complete: client.core.download.state.complete + complete,
error: client.core.download.state.error + error,
queue: manager.queue.length + this.queue.length - this.complete - this.error
});
}
};
// 一時キュー内のURLを順番にダウンロード(同時処理数: parallel)
async.eachLimit(tmp.queue, manager.parallel, function (url, next) {
var req = null; // リクエストオブジェクト
var strm = null; // ダウンロードストリームオブジェクト
// 失敗時の処理
var onError = function (err) {
tmp.applyState(0, 1);
err.url = url;
client.core.download.emit('error', err);
req.abort();
next();
return;
};
// ストリームで取得する場合はgzipにしない
var options = client.prepare('GET', url, {}, null);
options.param.gzip = false;
try {
req = client.request(options.param);
} catch (e) {
e.type = 'Request Exception';
onError(e);
return;
}
req
.on('response', function (res) {
if (String(res.statusCode).substr(0, 2) !== '20') {
var err = new Error('server status');
err.statusCode = res.statusCode;
err.type = 'Invalid Response';
onError(err);
return;
}
// ダウンロードストリームオブジェクトを作成してレスポンスを流し込む
strm = new DownloadStream(res);
// ダウンロード完了時
strm
.on('end', function () {
tmp.applyState(1, 0);
req.abort();
next();
})
.on('error', function (err) {
err.type = 'Stream Error';
onError(err);
});
client.core.download.emit('ready', strm);
req.pipe(strm);
})
// 複数回発生するようなのでonce
.once('error', function (err) {
err.type = 'Request Error';
return onError(err);
});
}, function (err) {
// 現在のダウンロード中にキューに追加されているURLがあるかもしれないので
// 再度loopイベントを飛ばしておく
jobRunning = false;
manager.emit('loop');
});
}
function DownloadManager() {
this.queue = []; // ダウンロード待ちURL配列
this.on('loop', (function () {
if (jobRunning) {
// 二重処理防止
return;
}
if (this.queue.length > 0) {
downloadJob(this);
} else {
client.core.download.emit('end');
}
}).bind(this));
}
util.inherits(DownloadManager, events.EventEmitter);
/**
* ダウンロードキューにURLを追加
*
* @param url ダウンロードするURL
* @return true: キューに登録された
*/
DownloadManager.prototype.addQueue = function (url) {
if (! url) {
return false;
}
if (cutil.inArray(urlCache, url)) {
// 登録/ダウンロード済み
return false;
}
urlCache.push(url);
process.nextTick((function () {
this.queue.push(url);
this.emit('loop');
}).bind(this));
return true;
};
return DownloadManager;
})();
var manager = new DownloadManager();
/**
* img要素の画像をダウンロード
*
* @param srcAttrs (imgのみ)srcよりも優先して取得する属性名(文字列 or 配列)
* @return キューに登録した数
*/
cheerio.prototype.download = function (srcAttrs) {
// ダウンロードマネージャーの設定がされていない
if (client.core.download.listeners('ready').length === 0) {
throw new Error('download manager configured no event');
}
var doc = cutil.documentInfo(this);
var $ = cheerio;
// 最初に全要素がimg要素かどうかチェック
this.each(function () {
if (! $(this).is('img')) {
throw new Error('element is not img');
}
});
// 同時実行数チェック
var parallel = parseInt(client.core.download.parallel, 10);
if (parallel < 1 || parallel > 5) {
throw new Error('valid download parallel range is 1 and 5');
}
manager.parallel = parallel;
var queued = 0;
this.each(function () {
var $elem = $(this);
// ここの$はfetch()を経由していないので_documentInfoがない
if (! $elem._root) {
$elem._root = {
0: { _documentInfo: doc }
};
}
// Base64埋め込み画像の場合はBuffer化して即返す
var b64chk = ($elem.attr('src') || '').match(/^data:(image\/\w+);base64,([\s\S]+)$/i);
if (b64chk) {
updateState({
complete: client.core.download.state.complete + 1
});
var b64buf = cutil.newBuffer(b64chk[2], 'base64');
var strm = new DownloadStream({
headers: {
'content-type': b64chk[1],
'content-length': b64buf.length
}
});
client.core.download.emit('ready', strm);
strm.write(b64buf);
strm.end();
queued++;
return;
}
var url = $elem.url({ invalid: false }, srcAttrs);
if (manager.addQueue(url)) {
queued++;
}
});
return queued;
};
};