Marmelator/pdf.js.mirror
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2026-07-05 06:35:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Simplify the NetworkManager class

Browse Source 
Store pending requests in a `WeakMap`, which allows working directly with the `XMLHttpRequest`-data and removes the need for a couple of methods.

Simplify the `PDFNetworkStreamRangeRequestReader.prototype._onDone` method, since after removing `moz-chunked-arraybuffer` support (see PR 10678) it's never called without an argument.

Stop sending the `begin`-property to the `onDone`-callbacks since it's unused. Originally this code was shared with the Firefox PDF Viewer, many years ago, and then that property mattered.

Re-factor the `status` validation, to avoid checking for a "bad" range-request response unconditionally.
This commit is contained in:
Jonas Jenwald 2026-01-25 12:41:20 +01:00
parent 95f62f3b33
commit 4d9301fceb
1 changed files with 58 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
src/display/network.js
View File

@ -31,15 +31,13 @@ if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("MOZCENTRAL")) {
const OK_RESPONSE = 200; const OK_RESPONSE = 200;
const PARTIAL_CONTENT_RESPONSE = 206; const PARTIAL_CONTENT_RESPONSE = 206;
function getArrayBuffer(xhr) { function getArrayBuffer(val) {
const data = xhr.response; return typeof val !== "string" ? val : stringToBytes(val).buffer;
if (typeof data !== "string") {
return data;
}
return stringToBytes(data).buffer;
} }
class NetworkManager { class NetworkManager {
#pendingRequests = new WeakMap();
_responseOrigin = null; _responseOrigin = null;
constructor({ url, httpHeaders, withCredentials }) { constructor({ url, httpHeaders, withCredentials }) {
@ -47,15 +45,18 @@ class NetworkManager {
this.isHttp = /^https?:/i.test(url); this.isHttp = /^https?:/i.test(url);
this.headers = createHeaders(this.isHttp, httpHeaders); this.headers = createHeaders(this.isHttp, httpHeaders);
this.withCredentials = withCredentials || false; this.withCredentials = withCredentials || false;
this.currXhrId = 0;
this.pendingRequests = Object.create(null);
} }
request(args) { request(args) {
const xhr = new XMLHttpRequest(); const xhr = new XMLHttpRequest();
const xhrId = this.currXhrId++; const pendingRequest = {
const pendingRequest = (this.pendingRequests[xhrId] = { xhr }); validateStatus: null,
onHeadersReceived: args.onHeadersReceived,
onDone: args.onDone,
onError: args.onError,
onProgress: args.onProgress,
};
this.#pendingRequests.set(xhr, pendingRequest);
xhr.open("GET", this.url); xhr.open("GET", this.url);
xhr.withCredentials = this.withCredentials; xhr.withCredentials = this.withCredentials;
@ -64,44 +65,38 @@ class NetworkManager {
} }
if (this.isHttp && "begin" in args && "end" in args) { if (this.isHttp && "begin" in args && "end" in args) {
xhr.setRequestHeader("Range", `bytes=${args.begin}-${args.end - 1}`); xhr.setRequestHeader("Range", `bytes=${args.begin}-${args.end - 1}`);
pendingRequest.expectedStatus = PARTIAL_CONTENT_RESPONSE;
// From http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.2:
// "A server MAY ignore the Range header". This means it's possible to
// get a 200 rather than a 206 response from a range request.
pendingRequest.validateStatus = status =>
status === PARTIAL_CONTENT_RESPONSE || status === OK_RESPONSE;
} else { } else {
pendingRequest.expectedStatus = OK_RESPONSE; pendingRequest.validateStatus = status => status === OK_RESPONSE;
} }
xhr.responseType = "arraybuffer"; xhr.responseType = "arraybuffer";
assert(args.onError, "Expected `onError` callback to be provided."); assert(args.onError, "Expected `onError` callback to be provided.");
xhr.onerror = () => { xhr.onerror = () => args.onError(xhr.status);
args.onError(xhr.status); xhr.onreadystatechange = this.#onStateChange.bind(this, xhr);
}; xhr.onprogress = this.#onProgress.bind(this, xhr);
xhr.onreadystatechange = this.onStateChange.bind(this, xhrId);
xhr.onprogress = this.onProgress.bind(this, xhrId);
pendingRequest.onHeadersReceived = args.onHeadersReceived;
pendingRequest.onDone = args.onDone;
pendingRequest.onError = args.onError;
pendingRequest.onProgress = args.onProgress;
xhr.send(null); xhr.send(null);
return xhrId; return xhr;
} }
onProgress(xhrId, evt) { #onProgress(xhr, evt) {
const pendingRequest = this.pendingRequests[xhrId]; const pendingRequest = this.#pendingRequests.get(xhr);
if (!pendingRequest) { pendingRequest?.onProgress?.(evt);
return; // Maybe abortRequest was called...
}
pendingRequest.onProgress?.(evt);
} }
onStateChange(xhrId, evt) { #onStateChange(xhr, evt) {
const pendingRequest = this.pendingRequests[xhrId]; const pendingRequest = this.#pendingRequests.get(xhr);
if (!pendingRequest) { if (!pendingRequest) {
return; // Maybe abortRequest was called... return; // Maybe abortRequest was called...
} }
const xhr = pendingRequest.xhr;
if (xhr.readyState >= 2 && pendingRequest.onHeadersReceived) { if (xhr.readyState >= 2 && pendingRequest.onHeadersReceived) {
pendingRequest.onHeadersReceived(); pendingRequest.onHeadersReceived();
delete pendingRequest.onHeadersReceived; delete pendingRequest.onHeadersReceived;
@ -111,13 +106,12 @@ class NetworkManager {
return; return;
} }
if (!(xhrId in this.pendingRequests)) { if (!this.#pendingRequests.has(xhr)) {
// The XHR request might have been aborted in onHeadersReceived() // The XHR request might have been aborted in onHeadersReceived()
// callback, in which case we should abort request. // callback, in which case we should abort request.
return; return;
} }
this.#pendingRequests.delete(xhr);
delete this.pendingRequests[xhrId];
// Success status == 0 can be on ftp, file and other protocols. // Success status == 0 can be on ftp, file and other protocols.
if (xhr.status === 0 && this.isHttp) { if (xhr.status === 0 && this.isHttp) {
@ -126,56 +120,33 @@ class NetworkManager {
} }
const xhrStatus = xhr.status || OK_RESPONSE; const xhrStatus = xhr.status || OK_RESPONSE;
// From http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.2: if (!pendingRequest.validateStatus(xhrStatus)) {
// "A server MAY ignore the Range header". This means it's possible to
// get a 200 rather than a 206 response from a range request.
const ok_response_on_range_request =
xhrStatus === OK_RESPONSE &&
pendingRequest.expectedStatus === PARTIAL_CONTENT_RESPONSE;
if (
!ok_response_on_range_request &&
xhrStatus !== pendingRequest.expectedStatus
) {
pendingRequest.onError(xhr.status); pendingRequest.onError(xhr.status);
return; return;
} }
const chunk = getArrayBuffer(xhr); const chunk = getArrayBuffer(xhr.response);
if (xhrStatus === PARTIAL_CONTENT_RESPONSE) { if (xhrStatus === PARTIAL_CONTENT_RESPONSE) {
const rangeHeader = xhr.getResponseHeader("Content-Range"); const rangeHeader = xhr.getResponseHeader("Content-Range");
const matches = /bytes (\d+)-(\d+)\/(\d+)/.exec(rangeHeader); if (/bytes (\d+)-(\d+)\/(\d+)/.test(rangeHeader)) {
if (matches) { pendingRequest.onDone(chunk);
pendingRequest.onDone({
begin: parseInt(matches[1], 10),
chunk,
});
} else { } else {
warn(`Missing or invalid "Content-Range" header.`); warn(`Missing or invalid "Content-Range" header.`);
pendingRequest.onError(0); pendingRequest.onError(0);
} }
} else if (chunk) { } else if (chunk) {
pendingRequest.onDone({ pendingRequest.onDone(chunk);
begin: 0,
chunk,
});
} else { } else {
pendingRequest.onError(xhr.status); pendingRequest.onError(xhr.status);
} }
} }
getRequestXhr(xhrId) { // Abort the request, if it's pending.
return this.pendingRequests[xhrId].xhr; abortRequest(xhr) {
} if (this.#pendingRequests.has(xhr)) {
this.#pendingRequests.delete(xhr);
isPendingRequest(xhrId) { xhr.abort();
return xhrId in this.pendingRequests; }
}
abortRequest(xhrId) {
const xhr = this.pendingRequests[xhrId].xhr;
delete this.pendingRequests[xhrId];
xhr.abort();
} }
} }
@ -234,7 +205,7 @@ class PDFNetworkStreamFullRequestReader {
this._manager = manager; this._manager = manager;
this._url = source.url; this._url = source.url;
this._fullRequestId = manager.request({ this._fullRequestXhr = manager.request({
onHeadersReceived: this._onHeadersReceived.bind(this), onHeadersReceived: this._onHeadersReceived.bind(this),
onDone: this._onDone.bind(this), onDone: this._onDone.bind(this),
onError: this._onError.bind(this), onError: this._onError.bind(this),
@ -261,8 +232,7 @@ class PDFNetworkStreamFullRequestReader {
} }
_onHeadersReceived() { _onHeadersReceived() {
const fullRequestXhrId = this._fullRequestId; const fullRequestXhr = this._fullRequestXhr;
const fullRequestXhr = this._manager.getRequestXhr(fullRequestXhrId);
this._manager._responseOrigin = getResponseOrigin( this._manager._responseOrigin = getResponseOrigin(
fullRequestXhr.responseURL fullRequestXhr.responseURL
@ -303,20 +273,18 @@ class PDFNetworkStreamFullRequestReader {
// requests, there will be an issue for sites where you can only // requests, there will be an issue for sites where you can only
// request the pdf once. However, if this is the case, then the // request the pdf once. However, if this is the case, then the
// server should not be returning that it can support range requests. // server should not be returning that it can support range requests.
this._manager.abortRequest(fullRequestXhrId); this._manager.abortRequest(fullRequestXhr);
} }
this._headersCapability.resolve(); this._headersCapability.resolve();
} }
_onDone(data) { _onDone(chunk) {
if (data) { if (this._requests.length > 0) {
if (this._requests.length > 0) { const requestCapability = this._requests.shift();
const requestCapability = this._requests.shift(); requestCapability.resolve({ value: chunk, done: false });
requestCapability.resolve({ value: data.chunk, done: false }); } else {
} else { this._cachedChunks.push(chunk);
this._cachedChunks.push(data.chunk);
}
} }
this._done = true; this._done = true;
if (this._cachedChunks.length > 0) { if (this._cachedChunks.length > 0) {
@ -390,10 +358,9 @@ class PDFNetworkStreamFullRequestReader {
requestCapability.resolve({ value: undefined, done: true }); requestCapability.resolve({ value: undefined, done: true });
} }
this._requests.length = 0; this._requests.length = 0;
if (this._manager.isPendingRequest(this._fullRequestId)) {
this._manager.abortRequest(this._fullRequestId); this._manager.abortRequest(this._fullRequestXhr);
} this._fullRequestXhr = null;
this._fullRequestReader = null;
} }
} }
@ -403,7 +370,7 @@ class PDFNetworkStreamRangeRequestReader {
this._manager = manager; this._manager = manager;
this._url = manager.url; this._url = manager.url;
this._requestId = manager.request({ this._requestXhr = manager.request({
begin, begin,
end, end,
onHeadersReceived: this._onHeadersReceived.bind(this), onHeadersReceived: this._onHeadersReceived.bind(this),
@ -421,9 +388,7 @@ class PDFNetworkStreamRangeRequestReader {
} }
_onHeadersReceived() { _onHeadersReceived() {
const responseOrigin = getResponseOrigin( const responseOrigin = getResponseOrigin(this._requestXhr?.responseURL);
this._manager.getRequestXhr(this._requestId)?.responseURL
);
if (responseOrigin !== this._manager._responseOrigin) { if (responseOrigin !== this._manager._responseOrigin) {
this._storedError = new Error( this._storedError = new Error(
@ -437,8 +402,7 @@ class PDFNetworkStreamRangeRequestReader {
this.onClosed?.(this); this.onClosed?.(this);
} }
_onDone(data) { _onDone(chunk) {
const chunk = data.chunk;
if (this._requests.length > 0) { if (this._requests.length > 0) {
const requestCapability = this._requests.shift(); const requestCapability = this._requests.shift();
requestCapability.resolve({ value: chunk, done: false }); requestCapability.resolve({ value: chunk, done: false });
@ -495,9 +459,8 @@ class PDFNetworkStreamRangeRequestReader {
requestCapability.resolve({ value: undefined, done: true }); requestCapability.resolve({ value: undefined, done: true });
} }
this._requests.length = 0; this._requests.length = 0;
if (this._manager.isPendingRequest(this._requestId)) {
this._manager.abortRequest(this._requestId); this._manager.abortRequest(this._requestXhr);
}
this._close(); this._close();
} }
} }