client.js
19.7 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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
'use strict';
var request = require('request');
var urlParser = require('url');
var RSVP = require('rsvp');
var each = require('foreach');
var typeOf = require('type-of');
var assign = require('object-assign');
var prettyjson = require('prettyjson');
var spawnSync = require('spawn-sync');
var path = require('path');
var cutil = require('./cheerio/util');
// os-localeは最初に実行した段階で結果をcacheに持つので
// fetch()前に別のモジュールがos-localeを実行していた場合に
// オプション内容によっては予期しない結果が返ることがある
var importFresh = require('import-fresh');
var osLocale = null;
try {
osLocale = importFresh('os-locale');
} catch (e) {}
/**
* <meta[http-equiv=refresh]>からURLを取得する正規表現
*/
var reMetaRefresh = {
/*eslint-disable key-spacing*/
comment : /<!--[\s\S]*?-->/g,
tag : /<\s*meta\s[\s\S]*http-equiv\s*=\s*["']?refresh["']?[\s\S]*?>/i,
url : /\d\s*;\s*URL\s*=\s*["']?\s*(.*?)["'\s>]/i
/*eslint-enable key-spacing*/
};
/**
* http(s)リクエスト処理メインモジュール
*/
module.exports = {
/**
* プロパティ
*/
/*eslint-disable key-spacing*/
core : null, // cheerio-httpcli本体
encoding : null, // encodingモジュール
cheerio : null, // 拡張cheerioオブジェクト
engine : request, // requestモジュール
jar : request.jar(), // クッキー
/*eslint-enable key-spacing*/
/**
* メソッド
*/
/**
* プロパティや内部情報の初期化
*/
reset: function () {
// クッキーオブジェクト作り直し
this.jar = request.jar();
},
/**
* promise/callbackに両対応したエラー終了処理(promise実行後)
*
* @param err Errorオブジェクトもしくはエラーメッセージ文字列
* @param options prepareで作成したオプション情報
* @param extra Errorオブジェクトに追加する情報
* @param result 処理結果オブジェクト
* @param reject (promise処理時のみ)reject関数
*/
fail: function (err, options, extra, result, reject) {
extra = extra || {};
result = result || {};
var error = (err instanceof Error) ? err : new Error(err);
if (options.param.uri) {
error.url = options.param.uri;
}
if (options.param.form) {
error.param = options.param.form;
} else if (options.param.qs) {
error.param = options.param.qs;
}
each(extra, function (exVal, exKey) {
if (typeOf(exVal) !== 'undefined') {
error[exKey] = exVal;
}
});
// callback形式
if (typeOf(options.callback) === 'function') {
return options.callback(error, result.$, result.response, result.body);
}
// promise形式
if (reject) {
each(result, function (val, name) {
if (typeOf(val) !== 'undefined') {
error[name] = val;
}
});
return reject(error);
}
// 同期処理
result.error = error;
return result;
},
/**
* promise/callbackに両対応したエラー終了処理(promise実行前)
*
* @param err Errorオブジェクトもしくはエラーメッセージ文字列
* @param options prepareで作成したオプション情報
* @param extra Errorオブジェクトに追加する情報
* @param result 処理結果オブジェクト
* @param reject (promise処理時のみ)reject関数
*/
error: function (err, options, extra, result) {
extra = extra || {};
result = result || {};
// callback形式 or 同期処理
if (typeOf(options.callback) === 'function' || options.callback === 'sync') {
return this.fail(err, options, extra, result);
}
// promise形式(promiseオブジェクトを返す)
return new RSVP.Promise((function (resolve, reject) {
return this.fail(err, options, extra, result, reject);
}).bind(this));
},
/**
* レスポンスからリダイレクト先のURLを取得
*
* @param res requestモジュールで取得したレスポンスオブジェクト
* @param body コンテンツのBuffer
* @return string リダイレクト先のURL(なければnull)
*/
checkRedirect: function (res, body) {
// POST後のリダイレクトはrequestモジュールでは自動で飛んでくれない(と思う)
if (/^30\d$/.test(res.statusCode) && res.headers.location) {
return urlParser.resolve(res.request.uri.href, res.headers.location);
}
// ここから先はHTMLの場合のみ
if (! this.core.followMetaRefresh || ! /html/.test(res.headers['content-type'])) {
return null;
}
// METAタグのrefreshがHTML内にあればリダイレクト
// IEの時だけリダイレクトとか考慮するのが面倒なのでコメントは全部削除
var chkBody = (body || '').toString('utf-8').replace(reMetaRefresh.comment, '');
var metaRefresh = chkBody.match(reMetaRefresh.tag);
if (metaRefresh) {
var refreshUrl = (metaRefresh[0].match(reMetaRefresh.url) || [])[1];
// refreshのURLが相対パスの場合があるので絶対パス化
return urlParser.resolve(res.request.uri.href, refreshUrl);
}
return null;
},
/**
* リクエスト処理
*
* @param param requestモジュールでのhttpアクセス時に指定するパラメータ
* @param retry 内部処理用引数(リトライ回数)
* @param callback リクエスト完了時のコールバック関数(err, response, body(buffer))
*/
request: function (param, retry, callback) {
if (typeOf(retry) === 'function') {
callback = retry;
retry = 0;
}
// レスポンスのサイズを計測するためのバッファ
var buffer = '';
var maxDataSize = this.core.maxDataSize;
// リクエスト実行
var req = request(param, (function (err, res, body) {
if (err) {
if (callback) {
callback(err, res, body);
return;
}
req.emit('error', err);
return;
}
// requestモジュールが対応していないタイプのリダイレクトチェック
var location = this.checkRedirect(res, body);
if (location) {
retry = retry || 0;
if (retry > 5) {
err = new Error('redirect limit over');
if (callback) {
callback(err, res, body);
return;
}
req.emit('error', err);
return;
}
// パラメータの調整
if (! /^30\d$/.test(res.statusCode)) {
// METAタグrefreshの場合はリファラーを更新
param.headers.Referer = param.uri;
}
var parsed = urlParser.parse(location);
param.headers.Host = parsed.host;
param.uri = location;
param.method = 'GET';
delete param.form;
delete param.qs;
this.request(param, retry + 1, callback);
return;
}
if (callback) {
callback(null, res, body);
return;
}
}).bind(this)).on('data', function (chunk) {
if (maxDataSize != null) {
// バッファにチャンクを追加
buffer += chunk;
// 制限を超過したら中止
if (buffer.length > maxDataSize) {
req.abort();
callback(new Error('data size limit over'));
return;
}
}
});
return req;
},
/**
* 非同期http通信処理本体
*
* @param options prepareで作成したオプション情報
* @param resolve (promise処理時のみ)resolve関数
* @param reject (promise処理時のみ)reject関数
*/
execute: function (options, resolve, reject) {
// リクエスト実行
this.request(options.param, (function (err, res, body) {
// レスポンスから処理結果オブジェクト作成
var obj = this.responseToResult(err, res, body, options);
if (obj.err) {
this.fail(obj.err, options, obj.extra, obj.result, reject);
return;
}
// promise処理時とcallback処理時で処理の返し方を切り替え
var result = obj.result;
if (typeOf(options.callback) === 'function') {
options.callback(result.error, result.$, result.response, result.body);
} else {
resolve(result);
}
}).bind(this));
},
/**
* リクエストオプションからクッキー連想配列を作成
*
* @param options prepareで作成したオプション情報
* @return {名前: 値}のクッキー連想配列
*/
getCookiesFromOption: function (options) {
var cookies = {};
each(options.param.jar.getCookies(options.param.uri), function (c) {
cookies[c.key] = c.value;
});
return cookies;
},
/**
* 同期http通信処理本体
*
* @param options prepareで作成したオプション情報
* @return リクエスト処理結果オブジェクト
* {
* err: request処理結果のerr
* $: request処理結果のbodyをcheerioでパースしたオブジェクト
* response: toJSON()したrequest処理結果のres
* body: UTF-8化したrequest処理結果のbody
* }
*/
executeSync: function (options) {
var args = {
param: options.param,
core: {},
cookies: this.getCookiesFromOption(options)
};
// jarはJSON化せず別途cookie付加するのでここではセットしない
delete args.param.jar;
// workerに渡すcoreオプション取得(関数やdownloadオブジェクトは渡さない)
each(this.core, function (val, key) {
if (typeOf(val) !== 'function' && key !== 'download') {
args.core[key] = val;
}
});
// spawnSyncでworker.jsでリクエスト処理を行う
var worker = [ path.join(__dirname, 'worker.js') ];
var result = spawnSync(process.execPath, worker, {
input: JSON.stringify(args),
encoding: 'utf-8'
});
var message = (result.status === 0) ? result.stderr : null;
// worker.jsが出力したJSONを取得して処理結果オブジェクトを作成
var json = {};
try {
json = JSON.parse(result.stdout);
} catch (e) {
message = 'An error occurred during the sync request: ' + e.message;
if (cutil.isWebpacked()) {
cutil.colorMessage(
'WARNING',
'synced http request have been disabled in this environment (eg Webpacked)'
);
}
}
// worker.jsのjarが取得したcookieをこちらのjarにセット
var Cookie = require('tough-cookie').Cookie;
if (json.response && typeOf(json.cookies) === 'array') {
each(json.cookies, (function (c) {
this.jar.setCookie(
Cookie.fromJSON(c).toString(),
json.response.request.uri.href
);
}).bind(this));
}
options.param.jar = this.jar;
var err = (message) ? new Error(message) : null;
var body = (json.body) ? cutil.newBuffer(json.body) : null;
var obj = this.responseToResult(err, json.response, body, options);
if (obj.err) {
return this.fail(obj.err, options, obj.extra, obj.result);
}
return obj.result;
},
/**
* request処理で取得したresponoseオブジェクトから処理結果オブジェクト作成
*
* @param err request処理結果のerr
* @param res request処理結果のres
* @param body request処理結果のbody
* @param options prepareで作成したオプション情報
* @return 処理結果オブジェクトおよび処理過程で発生したエラー情報
* {
* err: エラーオブジェクト or エラー文字列
* extra: 処理結果エラーオブジェクトに付加する追加情報
* result: 処理結果オブジェクト
* }
*/
responseToResult: function (err, res, body, options) {
// 処理結果格納先
var result = {};
// クッキー取得
if (res) {
res.cookies = this.getCookiesFromOption(options);
Object.freeze(res.cookies);
}
result.response = res;
if (err) {
return {
err: err,
result: result
};
}
if ((body || []).length === 0) {
return {
err: 'no content',
extra: { statusCode: res.statusCode },
result: result
};
}
// Buffer状態のHTMLコンテンツからエンコーディングを判定してUTF-8に変換
var enc = options.encode || this.encoding.detect(body);
if (enc) {
enc = enc.toLowerCase();
try {
body = this.encoding.convert(enc, body);
} catch (e) {
return {
err: e,
extra: { charset: enc },
result: result
};
}
}
result.body = body.toString('utf8');
// cheerioでHTMLコンテンツをパース & 現在のページ情報を追加
var cheerioOpt = {
decodeEntities: true,
xmlMode: (! this.core.forceHtml && (
(res && /[\/\+]xml\b/.test(res.headers['content-type'])) ||
/\.(rss|rdf|atom|opml|xslt?)\b/.test(options.param.uri)
// Content-Typeか拡張子でXMLであると判別された場合はxmlModeをON
))
};
result.$ = this.cheerio.load(result.body, cheerioOpt);
result.$._root._documentInfo = {
url: res.request.uri.href,
encoding: enc,
isXml: cheerioOpt.xmlMode
};
result.$.documentInfo = function () {
return this._root._documentInfo;
};
// 素の$.htmlはエンティティ化してしまうので退避
result.$.entityHtml = result.$.html;
result.$.html = function () {
return cutil.decodeEntities(
this.entityHtml.apply(this, Array.prototype.slice.call(arguments))
);
};
// HTMLが取得できてもレスポンスステータスが20xでない場合(ソフト404など)はエラーとして処理する
if (String(res.statusCode).substr(0, 2) !== '20') {
return {
err: 'server status',
extra: { statusCode: res.statusCode },
result: result
};
}
if (this.core.referer) {
// 次のリクエスト時に今アクセスしたURLをRefererとする
this.core.set('headers', {
referer: result.$._root._documentInfo.url
});
}
return { result: result };
},
/**
* デフォルトのリクエストヘッダに指定したヘッダが存在するかチェック
*
* @param header リクエストヘッダ名
* @return true or false
*/
hasHeader: function (header) {
header = header.toLowerCase();
return (Object.keys(this.core.headers).filter(function (h) {
return (h.toLowerCase() === header);
}).length > 0);
},
/**
* リクエスト時に必要なオプション情報を作成
*
* @param method リクエストメソッド
* @param url リクエスト先のURL
* @param param リクエストパラメータ
* @param encode 取得先のHTMLのエンコーディング(default: 自動判定)
* @param callback リクエスト完了時のコールバック関数(err, cheerio, response, body)
* @return オプション情報オブジェクト
*/
prepare: function (method, url, param, encode, callback) {
// 省略されている引数に合わせて調整
if (typeOf(encode) === 'function') {
callback = encode;
encode = null;
} else if (typeOf(param) === 'function') {
callback = param;
param = null;
encode = null;
}
if (! encode && typeOf(param) === 'string' && param.indexOf('=') === -1) {
// 第3引数が文字列でパラメータの指定でもない => paramが省略されてencodeが指定されている
encode = param;
param = null;
}
var cli = this.core;
// デフォルトはChromeとして振る舞う
if (! this.hasHeader('User-Agent')) {
cli.set('browser', 'chrome');
}
// OSのロケールからAcceptLanguageを設定
if (! this.hasHeader('Accept-Language')) {
if (cutil.isWebpacked()) {
cutil.colorMessage(
'WARNING',
'auto detection of Accept-Language has been disabled in this environment (eg Webpack)'
);
}
try {
// spawn: trueだとexecFileSyncを使うのでできればfalseにしたいが
// windowsだとロケールを取得できる確実な環境変数がなさそう
var locale = osLocale.sync({ spawn: (process.platform === 'win32') });
if (locale) {
locale = locale.replace(/_/g, '-');
// en-USだとロケール取得に失敗した可能性があるので何もしない
if (locale !== 'en-US') {
cli.set('headers', {
'Accept-Language': locale.replace(/_/g, '-') + ',en-US'
});
}
}
} catch (/*eslint-disable no-unused-vars*/ e /*eslint-enable no-unused-vars*/) {
// ロケールが取得できない場合は何もしない
}
}
// Acceptヘッダにそれっぽいのを付加しておく
if (! this.hasHeader('Accept')) {
cli.set('headers', {
Accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'
});
}
// リクエストヘッダ作成
var parsed = urlParser.parse(url);
var reqHeader = assign({ Host: parsed.host }, cli.headers);
var options = {
param: {
uri: url,
method: method,
encoding: null, // Bufferでコンテンツを取得する
headers: reqHeader,
timeout: cli.timeout,
gzip: cli.gzip,
time: true,
followRedirect: true,
jar: this.jar,
agentOptions: cli.agentOptions
},
encode: encode,
callback: callback
};
if ((typeOf(param) === 'object' && Object.keys(param).length > 0) || (param || '').length > 0) {
options.param[(method === 'GET') ? 'qs' : 'form'] = param;
}
return options;
},
/**
* リクエスト処理スタート
*
* @param method リクエストメソッド
* @param url リクエスト先のURL
* @param param リクエストパラメータ
* @param encode 取得先のHTMLのエンコーディング(default: 自動判定)
* @param callback リクエスト完了時のコールバック関数(err, cheerio, response, body)
*/
run: function (method, url, param, encode, callback) {
var isSync = false;
if (callback === 'sync') {
// Electron上ではSync系メソッドはサポート外
// ※process.execPathで別スクリプトを実行する性質上
if (process.versions.electron) {
throw new Error('sync request is not support on Electron');
}
isSync = true;
callback = null;
}
var options = this.prepare(method, url, param, encode, callback);
// デバッグ情報
if (this.core.debug) {
var label = '[DEBUG]';
var debugParams = {};
debugParams[label] = {};
each([ 'uri', 'method', 'headers', 'qs', 'form' ], function (v) {
if (options.param[v]) {
debugParams[label][v] = options.param[v];
}
});
var cookies = this.getCookiesFromOption(options);
if (Object.keys(cookies).length > 0) {
debugParams[label].cookies = cookies;
}
process.stderr.write(prettyjson.render(debugParams) + '\n\n');
}
// 同期処理
if (isSync) {
return this.executeSync(options);
}
// 非同期処理
if (typeOf(options.callback) !== 'function') {
// callbackを指定しなかった場合はpromiseオブジェクトを返す
return new RSVP.Promise((function (resolve, reject) {
this.execute(options, resolve, reject);
}).bind(this));
}
this.execute(options);
/*eslint-disable consistent-return*/ return; /*eslint-enable consistent-return*/
}
};