diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..fb6c3102 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: monthly + + - package-ecosystem: npm + directory: / + schedule: + interval: monthly + open-pull-requests-limit: 10 + ignore: + - dependency-name: "*" + update-types: ["version-update:semver-major"] diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..b9487c10 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,158 @@ +name: ci + +on: +- pull_request +- push + +permissions: + contents: read + +jobs: + test: + permissions: + checks: write # for coverallsapp/github-action to create new checks + contents: read # for actions/checkout to fetch code + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + name: + - Node.js 10.x + - Node.js 11.x + - Node.js 12.x + - Node.js 13.x + - Node.js 14.x + - Node.js 15.x + - Node.js 16.x + - Node.js 17.x + - Node.js 18.x + - Node.js 19.x + - Node.js 20.x + - Node.js 21.x + - Node.js 22.x + - Node.js 23.x + - Node.js 24.x + + include: + - name: Node.js 10.x + node-version: "10.24" + npm-i: mocha@8.4.0 + + - name: Node.js 11.x + node-version: "11.15" + npm-i: mocha@8.4.0 + + - name: Node.js 12.x + node-version: "12.22" + npm-i: mocha@9.2.2 + + - name: Node.js 13.x + node-version: "13.14" + npm-i: mocha@9.2.2 + + - name: Node.js 14.x + node-version: "14.21" + npm-i: mocha@9.2.2 + + - name: Node.js 15.x + node-version: "15.14" + npm-i: mocha@9.2.2 + + - name: Node.js 16.x + node-version: "16.20" + + - name: Node.js 17.x + node-version: "17.9" + + - name: Node.js 18.x + node-version: "18.18" + + - name: Node.js 19.x + node-version: "19.9" + + - name: Node.js 20.x + node-version: "20.9" + + - name: Node.js 21.x + node-version: "21" + + - name: Node.js 22.x + node-version: "22" + + - name: Node.js 23.x + node-version: "23" + + - name: Node.js 24.x + node-version: "24" + + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + - name: Install Node.js ${{ matrix.node-version }} + shell: bash -eo pipefail -l {0} + run: | + nvm install --default ${{ matrix.node-version }} + if [[ "${{ matrix.node-version }}" == 0.* && "$(cut -d. -f2 <<< "${{ matrix.node-version }}")" -lt 10 ]]; then + nvm install --alias=npm 0.10 + nvm use ${{ matrix.node-version }} + if [[ "$(npm -v)" == 1.1.* ]]; then + nvm exec npm npm install -g npm@1.1 + ln -fs "$(which npm)" "$(dirname "$(nvm which npm)")/npm" + else + sed -i '1s;^.*$;'"$(printf '#!%q' "$(nvm which npm)")"';' "$(readlink -f "$(which npm)")" + fi + npm config set strict-ssl false + fi + dirname "$(nvm which ${{ matrix.node-version }})" >> "$GITHUB_PATH" + + - name: Remove npm module(s) ${{ matrix.npm-rm }} + run: npm rm --silent --save-dev ${{ matrix.npm-rm }} + if: matrix.npm-rm != '' + + - name: Install npm module(s) ${{ matrix.npm-i }} + run: npm install --save-dev ${{ matrix.npm-i }} + if: matrix.npm-i != '' + + - name: Install Node.js dependencies + run: npm install + + - name: List environment + id: list_env + shell: bash + run: | + echo "node@$(node -v)" + echo "npm@$(npm -v)" + npm -s ls ||: + (npm -s ls --depth=0 ||:) | awk -F'[ @]' 'NR>1 && $2 { print $2 "=" $3 }' >> "$GITHUB_OUTPUT" + + - name: Lint code + run: npm run lint + + - name: Run tests + shell: bash + run: | + if npm -ps ls nyc | grep -q nyc; then + npm run test-ci + else + npm test + fi + + - name: Collect code coverage + uses: coverallsapp/github-action@09b709cf6a16e30b0808ba050c7a6e8a5ef13f8d # master + if: steps.list_env.outputs.nyc != '' + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + flag-name: run-${{ matrix.test_number }} + parallel: true + + coverage: + permissions: + checks: write # for coverallsapp/github-action to create new checks + needs: test + runs-on: ubuntu-latest + steps: + - name: Upload code coverage + uses: coverallsapp/github-action@09b709cf6a16e30b0808ba050c7a6e8a5ef13f8d # master + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + parallel-finished: true diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 00000000..378619a3 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,66 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: ["main", "v2"] + pull_request: + # The branches below must be a subset of the branches above + branches: ["main", "v2] + schedule: + - cron: "0 0 * * 1" + +permissions: + contents: read + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + steps: + - name: Checkout repository + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@3ab4101902695724f9365a384f86c1074d94e18c # v3.24.7 + with: + languages: javascript + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + # - name: Autobuild + # uses: github/codeql-action/autobuild@3ab4101902695724f9365a384f86c1074d94e18c # v3.24.7 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@3ab4101902695724f9365a384f86c1074d94e18c # v3.24.7 + with: + category: "/language:javascript" diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml new file mode 100644 index 00000000..276db769 --- /dev/null +++ b/.github/workflows/scorecard.yml @@ -0,0 +1,74 @@ +# This workflow uses actions that are not certified by GitHub. They are provided +# by a third-party and are governed by separate terms of service, privacy +# policy, and support documentation. + +name: Scorecard supply-chain security + +on: + # For Branch-Protection check. Only the default branch is supported. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection + branch_protection_rule: + # To guarantee Maintained check is occasionally updated. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained + schedule: + - cron: '16 21 * * 1' + push: + branches: [ "main" ] + +# Declare default permissions as read only. +permissions: read-all + +jobs: + analysis: + name: Scorecard analysis + runs-on: ubuntu-latest + permissions: + # Needed to upload the results to code-scanning dashboard. + security-events: write + # Needed to publish results and get a badge (see publish_results below). + id-token: write + # Uncomment the permissions below if installing in a private repository. + # contents: read + # actions: read + + steps: + - name: "Checkout code" + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + + - name: "Run analysis" + uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0 + with: + results_file: results.sarif + results_format: sarif + # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: + # - you want to enable the Branch-Protection check on a *public* repository, or + # - you are installing Scorecard on a *private* repository + # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat. + # repo_token: ${{ secrets.SCORECARD_TOKEN }} + + # Public repositories: + # - Publish results to OpenSSF REST API for easy access by consumers + # - Allows the repository to include the Scorecard badge. + # - See https://github.com/ossf/scorecard-action#publishing-results. + # For private repositories: + # - `publish_results` will always be set to `false`, regardless + # of the value entered here. + publish_results: true + + # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF + # format to the repository Actions tab. + - name: "Upload artifact" + uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0 + with: + name: SARIF file + path: results.sarif + retention-days: 5 + + # Upload the results to GitHub's code scanning dashboard. + - name: "Upload to code-scanning" + uses: github/codeql-action/upload-sarif@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9 + with: + sarif_file: results.sarif + diff --git a/.npmrc b/.npmrc new file mode 100644 index 00000000..43c97e71 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 343dd5a1..00000000 --- a/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -sudo: false -language: node_js -node_js: - - "0.10" - - "0.12" - - "4" - - "6" - - "8" - - "10" diff --git a/CHANGELOG.md b/CHANGELOG.md index a43c1ad5..c8dd9f91 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,59 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## 2.0.1 + +- Fix [CVE-2025-48997](https://www.cve.org/CVERecord?id=CVE-2025-48997) ([GHSA-g5hg-p3ph-g8qg](https://github.com/expressjs/multer/security/advisories/GHSA-g5hg-p3ph-g8qg)) + +## 2.0.0 + +- **Breaking change: The minimum supported Node version is now 10.16.0** +- Fix [CVE-2025-47935](https://www.cve.org/CVERecord?id=CVE-2025-47935) ([GHSA-44fp-w29j-9vj5](https://github.com/expressjs/multer/security/advisories/GHSA-44fp-w29j-9vj5)) +- Fix [CVE-2025-47944](https://www.cve.org/CVERecord?id=CVE-2025-47944) ([GHSA-4pg4-qvpc-4q3h](https://github.com/expressjs/multer/security/advisories/GHSA-4pg4-qvpc-4q3h)) + +## 1.4.5-lts.2 + +- Fix out-of-band error event from busboy (#1177) + +## 1.4.5-lts.1 + +- No changes + +## 1.4.4-lts.1 + +- Bugfix: Bump busboy to fix CVE-2022-24434 (#1097) +- Breaking: Require Node.js 10.16.0 or later (#1097) + +## 1.4.4 - 2021-12-07 + +- Bugfix: Handle missing field names (#913) +- Docs: Add Vietnamese translation (#803) +- Docs: Improve Spanish translation (#948) + +## 1.4.3 - 2021-08-09 + +- Bugfix: Avoid deprecated pseudoRandomBytes function (#774) +- Docs: Add Português Brazil translation for README (#758) +- Docs: Clarify the callback calling convention (#775) +- Docs: Add example on how to link to html multipart form (#580) +- Docs: Add Spanish translation for README (#838) +- Docs: Add Math.random() to storage filename example (#841) +- Docs: Fix mistakes in russian doc (#869) +- Docs: Improve Português Brazil translation (#877) +- Docs: Update var to const in all Readmes (#1024) +- Internal: Bump mkdirp version (#862) +- Internal: Bump Standard version (#878) + +## 1.4.2 - 2019-07-16 + +- Docs: Add Russian translation for README (#662) +- Docs: Patch zh-CN README base on newest README (#670) +- Docs: Fix broken link in Readme (#679) +- Docs: Fix broken link in Chinese Readme (#730) +- Docs: Fix typo in Russian README (#738) +- Docs: Add unit for fieldSize in busboy limit params (#734) +- Internal: Make unit tests comaptible with Node.js 13.x (#752) + ## 1.4.1 - 2018-10-11 - Bugfix: Make sure that req.file.buffer always is a Buffer diff --git a/README.md b/README.md index 759a0a10..1e062ee7 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ -# Multer [![Build Status](https://travis-ci.org/expressjs/multer.svg?branch=master)](https://travis-ci.org/expressjs/multer) [![NPM version](https://badge.fury.io/js/multer.svg)](https://badge.fury.io/js/multer) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] Multer is a node.js middleware for handling `multipart/form-data`, which is primarily used for uploading files. It is written on top of [busboy](https://github.com/mscdex/busboy) for maximum efficiency. **NOTE**: Multer will not process any form which is not multipart (`multipart/form-data`). -## Translations +## Translations This README is also available in other languages: -- [简体中文](https://github.com/expressjs/multer/blob/master/doc/README-zh-cn.md) (Chinese) -- [한국어](https://github.com/expressjs/multer/blob/master/doc/README-ko.md) (Korean) -- [Русский язык](https://github.com/expressjs/multer/blob/master/doc/README-ru.md) (Russian) +| | | +| ------------------------------------------------------------------------------ | --------------- | +| [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) | Arabic | +| [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) | Chinese | +| [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) | French | +| [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) | Korean | +| [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) | Portuguese (BR) | +| [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) | Russian | +| [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) | Spanish | +| [O'zbek tili](https://github.com/expressjs/multer/blob/main/doc/README-uz.md) | Uzbek | +| [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) | Vietnamese | ## Installation ```sh -$ npm install --save multer +$ npm install multer ``` ## Usage @@ -34,11 +42,11 @@ Don't forget the `enctype="multipart/form-data"` in your form. ``` ```javascript -var express = require('express') -var multer = require('multer') -var upload = multer({ dest: 'uploads/' }) +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) -var app = express() +const app = express() app.post('/profile', upload.single('avatar'), function (req, res, next) { // req.file is the `avatar` file @@ -50,8 +58,8 @@ app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) // req.body will contain the text fields, if there were any }) -var cpUpload = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) -app.post('/cool-profile', cpUpload, function (req, res, next) { +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { // req.files is an object (String -> Array) where fieldname is the key, and the value is array of files // // e.g. @@ -65,16 +73,42 @@ app.post('/cool-profile', cpUpload, function (req, res, next) { In case you need to handle a text-only multipart form, you should use the `.none()` method: ```javascript -var express = require('express') -var app = express() -var multer = require('multer') -var upload = multer() +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() app.post('/profile', upload.none(), function (req, res, next) { // req.body contains the text fields }) ``` +Here's an example on how multer is used in a HTML form. Take special note of the `enctype="multipart/form-data"` and `name="uploaded_file"` fields: + +```html +
+
+ + + +
+
+``` + +Then in your javascript file you would add these lines to access both the file and the body. It is important that you use the `name` field value from the form in your upload function. This tells multer which field on the request it should look for the files in. If these fields aren't the same in the HTML form and on your server, your upload will fail: + +```javascript +const multer = require('multer') +const upload = multer({ dest: './public/data/uploads/' }) +app.post('/stats', upload.single('uploaded_file'), function (req, res) { + // req.file is the name of your file in the form above, here 'uploaded_file' + // req.body will hold the text fields, if there were any + console.log(req.file, req.body) +}); +``` + + + ## API ### File information @@ -115,7 +149,7 @@ In an average web app, only `dest` might be required, and configured as shown in the following example. ```javascript -var upload = multer({ dest: 'uploads/' }) +const upload = multer({ dest: 'uploads/' }) ``` If you want more control over your uploads, you'll want to use the `storage` @@ -170,16 +204,17 @@ where you are handling the uploaded files. The disk storage engine gives you full control on storing files to disk. ```javascript -var storage = multer.diskStorage({ +const storage = multer.diskStorage({ destination: function (req, file, cb) { cb(null, '/tmp/my-uploads') }, filename: function (req, file, cb) { - cb(null, file.fieldname + '-' + Date.now()) + const uniqueSuffix = Date.now() + '-' + Math.round(Math.random() * 1E9) + cb(null, file.fieldname + '-' + uniqueSuffix) } }) -var upload = multer({ storage: storage }) +const upload = multer({ storage: storage }) ``` There are two options available, `destination` and `filename`. They are both @@ -199,7 +234,7 @@ If no `filename` is given, each file will be given a random name that doesn't include any file extension. **Note:** Multer will not append any file extension for you, your function -should return a filename complete with an file extension. +should return a filename complete with a file extension. Each function gets passed both the request (`req`) and some information about the file (`file`) to aid with the decision. @@ -207,14 +242,18 @@ the file (`file`) to aid with the decision. Note that `req.body` might not have been fully populated yet. It depends on the order that the client transmits fields and files to the server. +For understanding the calling convention used in the callback (needing to pass +null as the first param), refer to +[Node.js error handling](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors) + #### `MemoryStorage` The memory storage engine stores the files in memory as `Buffer` objects. It doesn't have any options. ```javascript -var storage = multer.memoryStorage() -var upload = multer({ storage: storage }) +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) ``` When using memory storage, the file info will contain a field called @@ -233,7 +272,7 @@ The following integer values are available: Key | Description | Default --- | --- | --- `fieldNameSize` | Max field name size | 100 bytes -`fieldSize` | Max field value size | 1MB +`fieldSize` | Max field value size (in bytes) | 1MB `fields` | Max number of non-file fields | Infinity `fileSize` | For multipart forms, the max file size (in bytes) | Infinity `files` | For multipart forms, the max number of file fields | Infinity @@ -271,11 +310,11 @@ When encountering an error, Multer will delegate the error to Express. You can display a nice error page using [the standard express way](http://expressjs.com/guide/error-handling.html). If you want to catch errors specifically from Multer, you can call the -middleware function by yourself. Also, if you want to catch only [the Multer errors](https://github.com/expressjs/multer/blob/master/lib/multer-error.js), you can use the `MulterError` class that is attached to the `multer` object itself (e.g. `err instanceof multer.MulterError`). +middleware function by yourself. Also, if you want to catch only [the Multer errors](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), you can use the `MulterError` class that is attached to the `multer` object itself (e.g. `err instanceof multer.MulterError`). ```javascript -var multer = require('multer') -var upload = multer().single('avatar') +const multer = require('multer') +const upload = multer().single('avatar') app.post('/profile', function (req, res) { upload(req, res, function (err) { @@ -292,8 +331,18 @@ app.post('/profile', function (req, res) { ## Custom storage engine -For information on how to build your own storage engine, see [Multer Storage Engine](https://github.com/expressjs/multer/blob/master/StorageEngine.md). +For information on how to build your own storage engine, see [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md). ## License [MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-ar.md b/doc/README-ar.md new file mode 100644 index 00000000..ad577552 --- /dev/null +++ b/doc/README-ar.md @@ -0,0 +1,321 @@ +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] + +
+ +تعتبر Multer وسيط node.js لمعالجة `multipart/form-data`, والتي تُستخدم أساسًا لتحميل الملفات. تم بناء هذا الوسيط بالإعتماد على [busboy](https://github.com/mscdex/busboy) لأجل الحصول على أقصى قدر من الكفاءة. + +**ملاحظة**: لن يقوم Multer بمعالجة أي شكل غير متعدد الأجزاء (`multipart/form-data`). + + +## الترجمات + +هذا الملف متاح أيضًا بلغات أخرى: + +- [English](https://github.com/expressjs/multer/blob/main/README.md) (الإنجليزية) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (الإسبانية) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (الصينية) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (الكورية) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (الروسية) +- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (الفتنامية) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (البرتغالية) + + +## التنصيب + +
+ +```sh +$ npm install --save multer +``` + +
+ +## الاستعمال + +يضيف Multer كائن `body` وكائن `file` أو `files` إلى كائن `request`. يحتوي الكائن `body` على قيم مدخلات النص في الإستمارة ، بينما يحتوي الكائن `file` أو `files` على الملفات التي تم تحميلها عبر الإستمارة. + +مثال على الاستخدام الأساسي: + +لا تنسَ `enctype="multipart/form-data"` في الإستمارة الخاص بك. + +
+ +```html +
+ +
+``` + +```javascript +var express = require('express') +var multer = require('multer') +var upload = multer({ dest: 'uploads/' }) + +var app = express() + +app.post('/profile', upload.single('avatar'), function (req, res, next) { + // req.file is the `avatar` file + // req.body will hold the text fields, if there were any +}) + +app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) { + // req.files is array of `photos` files + // req.body will contain the text fields, if there were any +}) + +var uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { + // req.files is an object (String -> Array) where fieldname is the key, and the value is array of files + // + // e.g. + // req.files['avatar'][0] -> File + // req.files['gallery'] -> Array + // + // req.body will contain the text fields, if there were any +}) +``` + +
+ +إذا احتجت لمعالجة إستمارة متعددة الأجزاء للنص فقط ، فيجب عليك استخدام الدالة `.none ()`: + +
+ +```javascript +var express = require('express') +var app = express() +var multer = require('multer') +var upload = multer() + +app.post('/profile', upload.none(), function (req, res, next) { + // req.body contains the text fields +}) +``` +
+ +## واجهة برمجة التطبيقات (API) + +### معلومات الملف + +كل ملف يحتوي على المعلومات التالية: + +مفتاح | وصف | ملاحظة +--- | --- | --- +`fieldname` | اسم المُدخَل المحدد في الإستمارة | +`originalname` | اسم الملف على كمبيوتر المستخدم | +`encoding` | نوع تشفير الملف | +`mimetype` | نوع ملف ملحقات بريد إنترنت متعددة الأغراض ( MIME ) | +`size` | حجم الملف بالبايت | +`destination` | المجلد الذي تم حفظ الملف إليه | `تخزين على الاسطوانة` (`DiskStorage`) +`filename` | اسم الملف داخل "الوجهة" ( `destination` ) | `تخزين على الاسطوانة` (`DiskStorage`) +`path` | المسار الكامل للملف الذي تم تحميله | `تخزين على الاسطوانة` (`DiskStorage`) +`buffer` | "ذاكرة" (`Buffer`) للملف بأكمله | `تخزين على الذاكرة ` (`MemoryStorage`) + + +### `multer(opts)` + +يقبل Multer كائن الخيارات ، وأهمها خاصية `dest`، والتي تحدد مكان تحميل الملفات. في حال حذفت كائن الخيارات ، سيتم الاحتفاظ بالملفات في الذاكرة ولن تتم كتابتها مطلقًا على القرص. + +بشكل افتراضي ، سيقوم Multer بإعادة تسمية الملفات لتجنب تعارض الأسماء. يمكن تخصيص وظيفة إعادة التسمية وفقا لاحتياجاتك. + +فيما يلي الخيارات التي يمكن تمريرها إلى Multer: + +مفتاح | وصف +--- | --- +`dest` أو `storage` | مكان لتخزين الملفات +`fileFilter` | دالة للسيطرة على الملفات التي يتم قبولها +`limits` | حدود البيانات التي تم تحميلها +`preservePath` | الاحتفظ بالمسار الكامل للملفات بدلاً من الاسم الأساسي + +في تطبيق ويب متوسط ​​، قد تكون هناك حاجة فقط إلى `dest`، وتكوينها كما هو موضح في +المثال التالي : + +
+ +```javascript +var upload = multer({ dest: 'uploads/' }) +``` + +
+ +إذا كنت تريد مزيدًا من التحكم في عمليات التحميل ، فستحتاج إلى استخدام خيار `storage` بدلاً من `dest`. يأتي Multer مع محركات التخزين `DiskStorage` و` MemoryStorage` ؛ كما تتوفر المزيد من المحركات من أطراف ثالثة. + +#### `.single(fieldname)` + +قبول ملف واحد باسم `اسم-المُدخَل`. سيتم تخزين الملف في `req.file`. + +#### `.array(fieldname[, maxCount])` + +قبول مصفوفة من الملفات ، وكلها تحمل اسم `اسم-المُدخَل`. يظهر خطأ اختياريً إذا تم تحميل ملفات أكثر من `maxCount`. سيتم تخزين مصفوفة الملفات في `req.files`. + +#### `.fields(fields)` + +قبول مزيج من الملفات ، المحدد بواسطة `المدخلات`. سيتم تخزين كائن مع مصفوفات من الملفات في `req.files`. + +يجب أن تكون `المدخلات` عبارة عن مصفوفة من الكائنات التي توفر بشكل اساسي `name` واختيارياً `maxCount`. +مثال: + +
+ +```javascript +[ + { name: 'avatar', maxCount: 1 }, + { name: 'gallery', maxCount: 8 } +] +``` + +
+ +#### `.none()` + +قبول المدخلات النصية فقط. في حالة رفع أي ملف ، سيتم إصدار خطأ بشيفرة "LIMIT \_UNEXPECTED \_FILE". + +#### `.any()` + +قبول جميع الملفات التي تأتي عبر السلك. سيتم تخزين مصفوفة من الملفات في `req.files`. + +**تحذير:** تأكد من أنك تعالج دائمًا الملفات التي يقوم المستخدم بتحميلها. لا تقم أبداً بإضافة multer باعتبارها أداة وسيطة عامة ، حيث يمكن للمستخدم الضار تحميل الملفات إلى مسار غير متتوقع. استخدم هذه الدالة فقط على المسارات التي تتعامل فيها مع الملفات التي تم تحميلها. + +### `storage` + +#### `DiskStorage` + +يمنحك محرك تخزين القرص التحكم الكامل في تخزين الملفات على القرص. + +
+ +```javascript +var storage = multer.diskStorage({ + destination: function (req, file, cb) { + cb(null, '/tmp/my-uploads') + }, + filename: function (req, file, cb) { + cb(null, file.fieldname + '-' + Date.now()) + } +}) + +var upload = multer({ storage: storage }) +``` + +
+ +هناك خياران متاحان ، `destination` و `filename`. كلاهما يعملان على تحديد مكان تخزين الملف. + +يتم استخدام `destination` لتحديد أي مجلد يجب تخزين الملفات المحملة. يمكن أيضًا إعطاء هذا كـ`سلسلة` (مثل `'/tmp/uploads'`). إذا لم يتم إعطاء `destination` ، فسيتم استخدام الدليل الافتراضي لنظام التشغيل للملفات المؤقتة. + +**ملاحظة:** أنت مسؤول عن إنشاء الدليل عند توفر `destination` كدالة. عند المرور بسلسلة ، سوف يتأكد multer من إنشاء الدليل من أجلك. + +يتم استخدام `اسم الملف` لتحديد ما يجب تسمية الملف داخل المجلد. إذا لم يتم تقديم `اسم الملف`، فسيتم إعطاء كل ملف اسمًا عشوائيًا لا يتضمن أي امتداد للملف. + +**ملاحظة:** لن يقوم multer بإلحاق اي ملحق ملف لك، الدالة الخاص بك يجب أن تقوم بإرجاع اسم ملف كامل بملحق الملف. + +يتم تمرير كل دالة من خلال الطلب (req`) وبعض المعلومات حول الملف (`file`) للمساعدة في اتخاذ القرار. + +لاحظ أن `req.body` ربما لم يتم ملؤها بالكامل بعد. يعتمد ذلك على الترتيب الذي يقوم به العميل من خلال نقل المدخلات والملفات إلى الخادم. + +#### `MemoryStorage` + +يخزن محرك تخزين الذاكرة الملفات الموجودة في الذاكرة ككائنات `ذاكرة` (`Buffer`). ليس لديها أي خيارات. + +
+ +```javascript +var storage = multer.memoryStorage() +var upload = multer({ storage: storage }) +``` + +
+ +عند استخدام ذاكرة التخزين ، ستحتوي معلومات الملف على مُدخَل يسمى `buffer` الذي يحتوي على الملف بأكمله. + +**تحذير**: يمكن أن يؤدي تحميل ملفات كبيرة جدًا أو ملفات صغيرة نسبيًا بأعداد كبيرة و بسرعة كبيرة إلى نفاد ذاكرة التطبيق عند استخدام ذاكرة التخزين. + +### `limits` + +كائن يحدد حدود حجم الخصائص الاختيارية التالية. يقوم Multer بتمرير هذا الكائن إلى busboy مباشرة ، ويمكن العثور على تفاصيل الخصائص من خلال [صفحة busboy's](https://github.com/mscdex/busboy#busboy-methods). + +تتوفر القيم الصحيحة التالية: + +مفتاح | وصف | افتراضي +--- | --- | --- +`fieldNameSize` | الحد الأقصى لحجم اسم المُدخَل | 100 بايت +`fieldSize` | الحد الأقصى لحجم قيمة المُدخَل (بالبايت) | 1 ميغابايت +`fields` | الحد الأقصى لعدد المدخلات التى لا تعتبر من الملفات | ما لا نهاية +`fileSize` | حجم الملف الأقصى بالنسبة لإستمارة متعددة الأجزاء (بالبايت) | ما لا نهاية +`files` | الحد الأقصى لعدد المدخلات من نوع الملفات بالنسبة لإستمارة متعددة الأجزاء | ما لا نهاية +`parts` | الحد الأقصى لعدد الأجزاء (مدخلات + ملفات) بالنسبة لإستمارة متعددة الأجزاء | ما لا نهاية +`headerPairs` | الحد الأقصى لعدد أزواج الرأس (المفتاح => القيمة) المطلوب تحليلها بالنسبة لإستمارة متعددة الأجزاء | 2000 + +يمكن أن يساعد تحديد الحدود في حماية موقعك من هجمات حجب الخدمة (DoS). + +### `fileFilter` + +اضبط هذا على دالة للتحكم في الملفات التي ينبغي تحميلها وأي الملفات يجب تخطيها. يجب أن تبدو دالة كما يلي: + +
+ +```javascript +function fileFilter (req, file, cb) { + + // The function should call `cb` with a boolean + // to indicate if the file should be accepted + + // To reject this file pass `false`, like so: + cb(null, false) + + // To accept the file pass `true`, like so: + cb(null, true) + + // You can always pass an error if something goes wrong: + cb(new Error('I don\'t have a clue!')) + +} +``` + +
+ +## معالجة الأخطاء + +عند مواجهة خطأ ، سيقوم Multer بتفويض الخطأ إلى Express. يمكنك +عرض صفحة خطأ لطيفة باستخدام [طريقة Express القياسية](http://expressjs.com/guide/error-handling.html). + +إذا كنت تريد إنتقاء الأخطاء والحصول على [أخطاء Multer فقط](https://github.com/expressjs/multer/blob/main/lib/multer-error.js)، فيمكنك نداء بدالة الوسيطة من قبل نفسك. أيضًا ، إذا كنت تريد التقاط أخطاء Multer فقط ، فيمكنك استخدام صنف `MulterError` المتصل بالكائن` multer` نفسه (على سبيل المثال `err instanceof multer.MulterError`). + +
+ +```javascript +var multer = require('multer') +var upload = multer().single('avatar') + +app.post('/profile', function (req, res) { + upload(req, res, function (err) { + if (err instanceof multer.MulterError) { + // A Multer error occurred when uploading. + } else if (err) { + // An unknown error occurred when uploading. + } + + // Everything went fine. + }) +}) +``` + +
+ +## محرك التخزين الخاص بك + +للحصول على معلومات حول كيفية إنشاء محرك التخزين الخاص بك ، راجع [محرك تخزين Multer](https://github.com/expressjs/multer/blob/main/StorageEngine.md). + +## الترخيص + +[MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-es.md b/doc/README-es.md new file mode 100644 index 00000000..91f7be2b --- /dev/null +++ b/doc/README-es.md @@ -0,0 +1,308 @@ +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] + +Multer es un "*middleware*" de node.js para el manejo de `multipart/form-data`, el cuál es usado sobre todo para la subida de archivos. Está escrito sobre [busboy](https://github.com/mscdex/busboy) para maximizar su eficiencia. + +**NOTA**: Multer no procesará ningún formulario que no sea multiparte (`multipart/form-data`). + +## Traducciones + +Éste archivo README también está disponible en otros lenguajes: + +- [English](https://github.com/expressjs/multer/blob/main/README.md) (Inglés) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chino) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Coreano) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Ruso) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Portugués Brasileño) + +## Instalación + +```sh +$ npm install --save multer +``` + +## Uso + +Multer añade un objeto `body` y un objeto `file` o `files` al objeto `request`. El objeto `body` contiene los valores correspondientes a los campos de texto del formulario, los objetos `file` o `files` contienen los archivos que serán subidos mediante el formulario. + +Ejemplo básico de cómo usarlo: + +No te olvides de `enctype="multipart/form-data"` en tu formulario. + +```html +
+ +
+``` + +```javascript +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) + +const app = express() + +app.post('/profile', upload.single('avatar'), function (req, res, next) { + // req.file es el archivo del `avatar` + // req.body contendrá los campos de texto, si los hubiera. +}) + +app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) { + // req.files es el arreglo (array) de archivos `photos` + // req.body contendrá los campos de texto, si los hubiera. +}) + +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { + // req.files es un objeto (String -> Array) donde el nombre del campo es la clave (key) y el valor es el arreglo (array) de archivos + // + // Ejemplo + // req.files['avatar'][0] -> Archivo + // req.files['gallery'] -> Array + // + // req.body contendrá los campos de texto, si los hubiera. +}) +``` + +En caso de que necesites manejar un formulario multiparte (multipart form) que sólo contiene campos de texto, deberias usar el método `.none()`: + +```javascript +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() + +app.post('/profile', upload.none(), function (req, res, next) { + // req.body contiene los campos textuales +}) +``` + + +Este es un ejemplo de cómo se utiliza multer en un formulario HTML. Presta especial atención en los campos `enctype="multipart/form-data"` y `name="uploaded_file"`: + +```html +
+
+ + + +
+
+``` + +Luego en tu archivo javascript agrega estas líneas para acceder tanto al archivo (file) como al body.Es importante que uses el valor del campo `name` del formulario, en tu función de subida. Esto le indica a multer en qué campo de la petición debe buscar los archivos. Si estos campos no son los mismos en el formulario HTML y en tu servidor, la subida fallará: + +```javascript +const multer = require('multer') +const upload = multer({ dest: './public/data/uploads/' }) +app.post('/stats', upload.single('uploaded_file'), function (req, res) { + // req.file es el nombre de tu archivo en el formulario anterior, en este caso 'uploaded_file' + // req.body contendrá los campos de texto, si los hubiera. + console.log(req.file, req.body) +}); +``` + + + +## API + +### Información del archivo + +Cada archivo contiene la siguiente información: + +Clave (Key) | Descripción | Nota +--- | --- | --- +`fieldname` | Nombre del campo especificado en el formulario | +`originalname` | Nombre del archivo en la computadora del usuario | +`encoding` | Tipo de codificación del archivo | +`mimetype` | Mime type del archivo | +`size` | Tamaño del archivo en Bytes | +`destination` | La carpeta donde se guardó el archivo | `DiskStorage` +`filename` | El nombre del archivo en `destination` | `DiskStorage` +`path` | La ruta completa al archivo subido | `DiskStorage` +`buffer` | Un `Buffer` del archivo completo | `MemoryStorage` + +### `multer(opts)` + +Multer acepta un objeto para configurar sus opciones, la más básica de ellas es la propiedad `dest`, la cual informa a Multer dónde debe subir los archivos. En caso de que omitas el objeto con las opciones, los archivos serán guardados en la memoria y nunca serán escritos en el disco. + +Por defecto, Multer renombrará los archivos para evitar conflictos de nombres. La función usada para renombrarlos puede ser modificada acorde a tus necesidades. + +Las siguientes son las opciones que pueden ser utilizadas con Multer. + +Clave (key) | Descripción +--- | --- +`dest` o `storage` | Donde se guardarán los archivos +`fileFilter` | Función para controlar qué archivos son aceptados +`limits` | Límites de los datos subidos +`preservePath` | Mantiene la ruta completa de la ubicación de los archivos, en vez de sólo sus nombres + +En la aplicación web promedio es probable que sólo se requiera `dest`, siendo configurado como en el siguiente ejemplo: + +```javascript +const upload = multer({ dest: 'uploads/' }) +``` + +Si quieres más control sobre tus subidas, tendrás que usar la opción `storage` en vez de `dest`. Multer incorpora los mecanismos de almacenamiento `DiskStorage` y `MemoryStorage`; existen otros medios provistos por terceros. + +#### `.single(fieldname)` + +Acepta un único archivo con el nombre `fieldname`. Dicho archivo será guardado en `req.file`. + +#### `.array(fieldname[, maxCount])` + +Acepta un arreglo (array), de archivos, todos con el nombre `fieldname`. Opcionalmente puede generarse un error si se intentan subir una cantidad de archivos superior a `maxCount`. El arreglo (array) de archivos será guardado en `req.files`. + +#### `.fields(fields)` + +Acepta una mezcla de archivos, especificados por `field`. Un objeto con arreglos (arrays) de archivos será guardado en `req.files` + +`fields` debería ser un arreglo (array) de objetos con `name` y opcionalmente `maxCount`. +Ejemplo: + +```javascript +[ + { name: 'avatar', maxCount: 1 }, + { name: 'gallery', maxCount: 8 } +] +``` + +#### `.none()` + +Acepta sólo campos de texto. En caso de intentar subir un archivo, se generará un error con el siguiente código +"LIMIT\_UNEXPECTED\_FILE". + +#### `.any()` + +Acepta todos los archivos que han sido enviados. Un arreglo (array) conteniendo los archivos, será guardado en `req.files`. + +**ADVERTENCIA:** Asegúrate de siempre manejar los archivos que los usuarios intenten subir. Nunca uses Multer como una función middleware de manera global dado que, de esta forma, un usuario malicioso podría subir archivos por medio de rutas que no has anticipado. Usa sólo esta función en rutas en las que estás esperando archivos. + +### `storage` + +#### `DiskStorage` + +El motor de almacenamiento en disco te ofrece un control total sobre el almacenamiento de archivos en tu disco. + +```javascript +const storage = multer.diskStorage({ + destination: function (req, file, cb) { + cb(null, '/tmp/my-uploads') + }, + filename: function (req, file, cb) { + cb(null, file.fieldname + '-' + Date.now()) + } +}) + +const upload = multer({ storage: storage }) +``` + +Hay dos opciones disponibles, `destination` y `filename`. Ambas son funciones que determinan dónde debería almacenarse el archivo. + +`destination` se utiliza para determinar en qué carpeta se almacenarán los archivos subidos. Tambien se puede proporcionar como un `string` (por ejemplo: `'/tmp/uploads'`). Si no se proporciona `destination`, se utilizara el directorio predeterminado del sistema operativo para archivos temporales. + +**Nota:** Al pasar `destination` como una función, tú eres el responsable de crear los directorios donde los archivos serán almacenados. Cuando asignas un `string` a `destination`, Multer se asegurará de que el directorio sea creado en caso de no encontrarlo. + +`filename` es usado para determinar cómo debería ser nombrado el archivo dentro de la carpeta. Si `filename` no es provisto, a cada archivo se le asignará un nombre aleatorio que no incluirá ninguna extensión. + +**Nota:** Multer no añadirá ningúna extensión de archivos por ti, es tu función la que debería retornar un nombre completo, que incluya también la extensión del archivo. + +El objeto petición (`req`) y parte de la información del archivo (`file`) son pasadas a tu función para ayudar con la decisión en la nomenclatura. + +Nota que `req.body` puede que no haya sido totalmente poblado todavía. Esto depende del orden en el que el cliente transmita sus campos y archivos hacia el servidor. + +Para comprender la convención de llamada utilizada en el callback (necesitas pasar null como primer parametro), consulta en +[Node.js manejo de errores](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors) + +#### `MemoryStorage` + +El motor de almacenamiento en memoria almacena los archivos en memoria como objetos `Buffer`. Para esto no se proveen opciones. + +```javascript +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) +``` + +Al usar el almacenamiento en memoria, la información del archivo contendrá un campo llamado `buffer` que contiene el archivo entero. + +**ADVERTENCIA**: Subir archivos grandes, o relativamente pequeños pero en gran cantidad y muy rápido, puede provocar que tu aplicación se quede sin memoria cuando es usado el almacenamiento en memoria. + +### `limits` + +Un objeto especifica los límites correpondientes a los tamaños de las siguientes propiedades opcionales. Multer pasa este objeto directamente a *busboy*, los detalles de las propiedades pueden encontrarse en [la página de busboy](https://github.com/mscdex/busboy#busboy-methods). + +Los siguientes valores en números enteros están disponibles: + +Clave (Key) | Descripción | Por defecto +--- | --- | --- +`fieldNameSize` | Tamaño máximo del nombre del campo | 100 bytes +`fieldSize` | Tamaño máximo de los valores para cada campo (en bytes) | 1MB +`fields` | Número máximo de campos que no son archivos | Infinito +`fileSize` | Para formularios multiparte, el tamaño máximo de los archivos (en bytes) | Infinito +`files` | Para los formularios multiparte, el número máximo de campos para archivos | Infinito +`parts` | Para los formularios multiparte, el número máximo de partes (campos + archivos) | Infinito +`headerPairs` | Para los formularios multiparte, el número máximo de cabeceras de pares clave=>valor para analizar | 2000 + +Especificar los límites puede ayudarte a proteger tu sitio contra ataques de denegación del servicio (DoS). + +### `fileFilter` + +Asigna ésto a una función para controlar cuáles archivos deben ser subidos y cuáles deben ser omitidos. La función debería verse como ésta: + +```javascript +function fileFilter (req, file, cb) { + + // La función debe llamar a `cb` usando una variable del tipo boolean + // para indicar si el archivo debería ser aceptado o no + + // Para rechazar el archivo es necesario pasar `false`, de la siguiente forma: + cb(null, false) + + // Para aceptar el archivo es necesario pasar `true`, de la siguiente forma: + cb(null, true) + + // Siempre puedes pasar un error en caso de que algo salga mal: + cb(new Error('No tengo la menor idea!')) + +} +``` + +## Manejo de errores + +Al encontrarse con un error, Multer delegará ese error a Express. Puedes mostrar una linda página de error usando [la manera standard de Express](http://expressjs.com/guide/error-handling.html). + +Si quieres capturar los errores específicamente desde Multer, puedes llamar la función middleware tú mismo. También, si quieres capturar sólo [los errores de Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), puedes usar la clase `MulterError` que está adherida al mismo objeto `multer` (por ejemplo: `err instanceof multer.MulterError`). + +```javascript +const multer = require('multer') +const upload = multer().single('avatar') + +app.post('/profile', function (req, res) { + upload(req, res, function (err) { + if (err instanceof multer.MulterError) { + // Un error de Multer ocurrió durante la subida. + } else if (err) { + // Un error desconocido ocurrió durante la subida. + } + + // Todo salió bien. + }) +}) +``` + +## Mecanismos de almacenamiento personalizados + +Para más información acerca de cómo construir tu propio mecanismo de almacenamiento, recomendamos leer [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md). + +## Licencia + +[MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-fr.md b/doc/README-fr.md new file mode 100644 index 00000000..d829e998 --- /dev/null +++ b/doc/README-fr.md @@ -0,0 +1,341 @@ +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] + +Multer est un middleware node.js pour la gestion des données `multipart/form-data` qui est principalement utilisé pour télécharger des fichiers. +Il est écrit au-dessus de [busboy](https://github.com/mscdex/busboy) pour une efficacité maximale. + +**NOTE**: Multer ne traitera aucun formulaire qui ne soit pas un multipart (`multipart/form-data`). + +## Translations + +This README is also available in other languages: + +- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (Arabe) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Espagnol) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinois) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Coréen) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russe) +- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (Vietnamien) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Portugais du Brésil) +- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (Français) + +## Installation + +```sh +$ npm install --save multer +``` + +## Usage + +Multer ajoute un objet `body` et un objet `file` ou `files` à l'objet `request`. L'objet `body` contient les valeurs des champs texte du formulaire, l'objet `file` ou `files` contient les fichiers téléchargés via le formulaire. + +Exemple d'utilisation de base : + +N'oubliez pas le `enctype="multipart/form-data"` dans votre formulaire. + +```html +
+ +
+``` + +```javascript +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) + +const app = express() + +app.post('/profile', upload.single('avatar'), function (req, res, next) { + // req.file est le fichier `avatar` + // req.body contiendra les champs de texte, s'il y en avait +}) + +app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) { + // req.files est un tableau de fichiers "photos" + // req.body contiendra les champs de texte, s'il y en avait +}) + +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { + // req.files est un objet (String -> Array) où fieldname est la clé et la valeur est un tableau de fichiers + // + // e.g. + // req.files['avatar'][0] -> Fichier + // req.files['gallery'] -> Tableau + // + // req.body contiendra les champs de texte, s'il y en avait +}) +``` + +Dans le cas où vous auriez besoin de gérer un formulaire en plusieurs parties texte uniquement, vous devez utiliser la méthode `.none()`: + +```javascript +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() + +app.post('/profile', upload.none(), function (req, res, next) { + // req.body contiens les champs de text +}) +``` + +Voici un exemple d'utilisation de multer dans un formulaire HTML. Faites particulièrement attention aux champs `enctype="multipart/form-data"` et `name="uploaded_file"`: + +```html +
+
+ + + +
+
+``` + +Ensuite, dans votre fichier javascript, vous ajouterez ces lignes pour accéder à la fois au fichier et au corps. Il est important que vous utilisiez la valeur du champ `name` du formulaire dans votre fonction de téléchargement. Cela indique à Multer dans quel champ de la requête il doit rechercher les fichiers. Si ces champs ne sont pas les mêmes dans le formulaire HTML et sur votre serveur, votre téléchargement échouera: +```javascript +const multer = require('multer') +const upload = multer({ dest: './public/data/uploads/' }) +app.post('/stats', upload.single('uploaded_file'), function (req, res) { + // req.file est le nom de votre fichier dans le formulaire ci-dessus, ici 'uploaded_file' + // req.body contiendra les champs de texte, s'il y en avait + console.log(req.file, req.body) +}); +``` +## API + +### Informations sur les fichiers + +Chaque fichier contient les informations suivantes: + +Clé | Description | Notes +--- |------------------------------------------------| --- +`fieldname` | Nom du champ spécifié dans le formulaire | +`originalname` | Nom du fichier sur l'ordinateur de l'utilisateur | +`encoding` | Type d'encodage du fichier | +`mimetype` | Type Mime du fichier | +`size` | Taille du fichier en octets | +`destination` | TLe dossier dans lequel le fichier a été enregistré | `DiskStorage` +`filename` | Le nom du fichier dans la `destination` | `DiskStorage` +`path` | Le chemin d'accès complet au fichier téléchargé | `DiskStorage` +`buffer` | Un `Buffer` du fichier entier | `MemoryStorage` + +### `multer(opts)` + +Multer accepte un objet d'options, dont le plus basique est le `dest` +propriété, qui indique à Multer où télécharger les fichiers. Au cas où vous omettez l'objet +options, les fichiers seront conservés en mémoire et ne seront jamais écrits sur le disque. + +Par défaut, Multer renommera les fichiers afin d'éviter les conflits de nommage. Les +la fonction de renommage peut être personnalisée en fonction de vos besoins. + +Voici les options qui peuvent être transmises à Multer. + +Clé | Description +--- | --- +`dest` ou `storage` | Où stocker les fichiers +`fileFilter` | Fonction pour contrôler quels fichiers sont acceptés +`limits` | Limites des données téléchargées +`preservePath` | Conservez le chemin complet des fichiers au lieu du nom de base uniquement + +Dans une application Web moyenne, seul `dest` peut être requis et configuré comme indiqué dans +l'exemple suivant. + +```javascript +const upload = multer({ dest: 'uploads/' }) +``` + +Si vous voulez plus de contrôle sur vos téléchargements, vous voudrez utiliser le `storage` +option au lieu de `dest`. Multer est livré avec des moteurs de stockage `DiskStorage` +et `MemoryStorage`; D'autres moteurs sont disponibles auprès de tiers. + +#### `.single(fieldname)` + +Acceptez un seul fichier avec le nom `fieldname`. Le fichier unique sera stocké +dans `req.file`. + +#### `.array(fieldname[, maxCount])` + +Acceptez un tableau de fichiers, tous avec le nom `fieldname`. Eventuellement erreur si +plus de `maxCount` fichiers sont téléchargés. Le tableau de fichiers sera stocké dans +`req.files`. + +#### `.fields(fields)` + +Accepte un mélange de fichiers, spécifié par `fields`. Un objet avec des tableaux de fichiers +seront stockés dans `req.files`. + +`fields` doit être un tableau d'objets avec `name` et éventuellement un `maxCount`. +Exemple: + +```javascript +[ + { name: 'avatar', maxCount: 1 }, + { name: 'gallery', maxCount: 8 } +] +``` + +#### `.none()` + +N'acceptez que les champs de texte. Si un téléchargement de fichier est effectué, une erreur avec le code +"LIMIT\_UNEXPECTED\_FILE" sera émis. + +#### `.any()` + +Accepte tous les fichiers qui arrivent sur le fil. Un tableau de fichiers sera stocké dans +`req.files`. + +**ATTENTION:** Assurez-vous de toujours gérer les fichiers qu'un utilisateur télécharge. +N'ajoutez jamais multer en tant que middleware global car un utilisateur malveillant pourrait télécharger des +fichiers vers un itinéraire que vous n'aviez pas prévu. N'utilisez cette fonction que sur les itinéraires +où vous gérez les fichiers téléchargés. + +### `storage` + +#### `DiskStorage` + +Le moteur de stockage sur disque vous donne un contrôle total sur le stockage des fichiers sur le disque. + +```javascript +const storage = multer.diskStorage({ + destination: function (req, file, cb) { + cb(null, '/tmp/my-uploads') + }, + filename: function (req, file, cb) { + const uniqueSuffix = Date.now() + '-' + Math.round(Math.random() * 1E9) + cb(null, file.fieldname + '-' + uniqueSuffix) + } +}) + +const upload = multer({ storage: storage }) +``` + +Il y a deux options disponibles, `destination` et `filename`. Elles sont toutes les deux +des fonctions qui déterminent où le fichier doit être stocké. + +`destination` est utilisé pour déterminer dans quel dossier les fichiers téléchargés doivent +être stocké. Cela peut également être donné sous forme de `string` (par exemple `'/tmp/uploads'`). Sinon +`destination` est donné, le répertoire par défaut du système d'exploitation est utilisé pour les +fichiers temporaires. + +**Remarque:** Vous êtes responsable de la création du répertoire lorsque vous fournissez +`destination` en tant que fonction. Lors du passage d'une chaîne, multer s'assurera que +le répertoire est créé pour vous. + +`filename` est utilisé pour déterminer le nom du fichier dans le dossier. +Si aucun "nom de fichier" n'est donné, chaque fichier recevra un nom aléatoire qui n'inclut +pas d'extension de fichier. + +**Remarque:** Multer n'ajoutera aucune extension de fichier pour vous, votre fonction +doit renvoyer un nom de fichier complet avec une extension de fichier. + +Chaque fonction reçoit à la fois la requête (`req`) et des informations sur +le dossier (`file`) pour aider à la décision. + +Notez que `req.body` n'a peut-être pas encore été entièrement rempli. Cela dépend de l'ordre +où le client transmet les champs et les fichiers au serveur. + +Pour comprendre la convention d'appel utilisée dans le rappel (nécessité de passer +null comme premier paramètre), reportez-vous à +[Node.js error handling](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors) + +#### `MemoryStorage` + +Le moteur de stockage en mémoire stocke les fichiers en mémoire en tant qu'objets `Buffer`. Il +n'a pas d'options. + +```javascript +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) +``` + +Lors de l'utilisation du stockage en mémoire, les informations sur le fichier contiendront un champ appelé +`buffer` qui contient le fichier entier. + +**ATTENTION**: Le téléchargement de fichiers très volumineux ou de fichiers relativement petits en grand +nombres très rapidement, peut entraîner un manque de mémoire de votre application lorsque +le stockage en mémoire est utilisé. + +### `limits` + +Un objet spécifiant les limites de taille des propriétés facultatives suivantes. Multer passe directement cet objet dans busboy, et les détails des propriétés peuvent être trouvés sur [la page de busboy](https://github.com/mscdex/busboy#busboy-methods). + +Les valeurs entières suivantes sont disponibles : + +Clé | Description | Default +--- |---------------------------------------------------------------------------| --- +`fieldNameSize` | Taille maximale du nom de champ | 100 bytes +`fieldSize` | Max field value size (in bytes) | 1MB +`fields` | Taille maximale de la valeur du champ (en octets) | Infinity +`fileSize` | Pour les formulaires multipart, la taille maximale du fichier (en octets) | Infinity +`files` | Pour les formulaires multipart, le nombre maximal de champs de fichier | Infinity +`parts` | Pour les formulaires multipart, le nombre max de parties (champs + fichiers) | Infinity +`headerPairs` | Pour les formulaires multipart, le nombre maximum de paires clé=>valeur d'en-tête à analyser | 2000 + +Spécifier les limites peut aider à protéger votre site contre les attaques par déni de service (DoS). + +### `fileFilter` + +Définissez ceci sur une fonction pour contrôler quels fichiers doivent être téléchargés et lesquels +devrait être ignoré. La fonction devrait ressembler à ceci: + +```javascript +function fileFilter (req, file, cb) { + + // La fonction doit appeler `cb` avec un booléen + // pour indiquer si le fichier doit être accepté + + // Pour rejeter ce fichier, passez `false`, comme ceci: + cb(null, false) + + // Pour accepter le fichier, passez `true`, comme ceci: + cb(null, true) + + // Vous pouvez toujours passer une erreur si quelque chose ne va pas: + cb(new Error('I don\'t have a clue!')) + +} +``` + +## Gestion des Erreurs + +En cas d'erreur, Multer déléguera l'erreur à Express. Vous pouvez +afficher une belle page d'erreur en utilisant [la voie express standard](http://expressjs.com/guide/error-handling.html). + +Si vous souhaitez détecter les erreurs spécifiquement de Multer, vous pouvez appeler la +fonction middleware par vous-même. Aussi, si vous voulez attraper seulement [les erreurs Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), vous pouvez utiliser la classe `MulterError` qui est jointe à l'objet `multer` lui-même (par exemple `err instanceof multer.MulterError`). + +```javascript +const multer = require('multer') +const upload = multer().single('avatar') + +app.post('/profile', function (req, res) { + upload(req, res, function (err) { + if (err instanceof multer.MulterError) { + // Une erreur Multer s'est produite lors du téléchargement. + } else if (err) { + // Une erreur inconnue s'est produite lors du téléchargement. + } + + // Tout s'est bien passé. + }) +}) +``` + +## Moteur de stockage personnalisé + +Pour plus d'informations sur la création de votre propre moteur de stockage, consultez [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md). + +## License + +[MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-ko.md b/doc/README-ko.md index 51e29539..63d33078 100644 --- a/doc/README-ko.md +++ b/doc/README-ko.md @@ -1,4 +1,4 @@ -# Multer [![Build Status](https://travis-ci.org/expressjs/multer.svg?branch=master)](https://travis-ci.org/expressjs/multer) [![NPM version](https://badge.fury.io/js/multer.svg)](https://badge.fury.io/js/multer) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] Multer는 파일 업로드를 위해 사용되는 `multipart/form-data` 를 다루기 위한 node.js 의 미들웨어 입니다. 효율성을 최대화 하기 위해 [busboy](https://github.com/mscdex/busboy) 를 기반으로 하고 있습니다. @@ -7,9 +7,13 @@ Multer는 파일 업로드를 위해 사용되는 `multipart/form-data` 를 다 ## 번역 이 문서는 아래의 언어로도 제공됩니다: -- [English](https://github.com/expressjs/multer/blob/master/README.md) -- [简体中文](https://github.com/expressjs/multer/blob/master/doc/README-zh-cn.md) (중국어) -- [Русский язык](https://github.com/expressjs/multer/blob/master/doc/README-ru.md) (러시아) + +- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (아라비아 말) +- [English](https://github.com/expressjs/multer/blob/main/README.md) (영어) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (스페인어) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (중국어) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (러시아) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (포르투갈어 BR) ## 설치 @@ -24,11 +28,11 @@ Multer는 `body` 객체와 한 개의 `file` 혹은 여러개의 `files` 객체 기본 사용 예제: ```javascript -var express = require('express') -var multer = require('multer') -var upload = multer({ dest: 'uploads/' }) +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) -var app = express() +const app = express() app.post('/profile', upload.single('avatar'), function (req, res, next) { // req.file 은 `avatar` 라는 필드의 파일 정보입니다. @@ -40,8 +44,8 @@ app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) // 텍스트 필드가 있는 경우, req.body가 이를 포함할 것입니다. }) -var cpUpload = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) -app.post('/cool-profile', cpUpload, function (req, res, next) { +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { // req.files는 (String -> Array) 형태의 객체 입니다. // 필드명은 객체의 key에, 파일 정보는 배열로 value에 저장됩니다. // @@ -56,10 +60,10 @@ app.post('/cool-profile', cpUpload, function (req, res, next) { 텍스트 전용 multipart 폼을 처리해야 하는 경우, 어떠한 multer 메소드 (`.single()`, `.array()`, `fields()`) 도 사용할 수 있습니다. 아래는 `.array()` 를 사용한 예제 입니다 : ```javascript -var express = require('express') -var app = express() -var multer = require('multer') -var upload = multer() +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() app.post('/profile', upload.array(), function (req, res, next) { // req.body는 텍스트 필드를 포함합니다. @@ -102,7 +106,7 @@ Key | Description 보통의 웹 앱에서는 `dest` 옵션 정도만 필요할지도 모릅니다. 설정 방법은 아래의 예제에 나와있습니다. ```javascript -var upload = multer({ dest: 'uploads/' }) +const upload = multer({ dest: 'uploads/' }) ``` 만일 업로드를 더 제어하고 싶다면, `dest` 옵션 대신 `storage` 옵션을 사용할 수 있습니다. Multer는 스토리지 엔진인 `DiskStorage` 와 `MemoryStorage` 를 탑재하고 있습니다. 써드파티로부터 더 많은 엔진들을 사용할 수 있습니다. @@ -146,7 +150,7 @@ var upload = multer({ dest: 'uploads/' }) 디스크 스토리지 엔진은 파일을 디스크에 저장하기 위한 모든 제어 기능을 제공합니다. ```javascript -var storage = multer.diskStorage({ +const storage = multer.diskStorage({ destination: function (req, file, cb) { cb(null, '/tmp/my-uploads') }, @@ -155,7 +159,7 @@ var storage = multer.diskStorage({ } }) -var upload = multer({ storage: storage }) +const upload = multer({ storage: storage }) ``` `destination` 과 `filename` 의 두가지 옵션이 가능합니다. 두 옵션 모두 파일을 어디에 저장할 지를 정하는 함수입니다. @@ -178,8 +182,8 @@ var upload = multer({ storage: storage }) 메모리 스토리지 엔진은 파일을 메모리에 `Buffer` 객체로 저장합니다. 이에 대해서는 어떤 옵션도 없습니다. ```javascript -var storage = multer.memoryStorage() -var upload = multer({ storage: storage }) +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) ``` 메모리 스토리지 사용시, 파일 정보는 파일 전체를 포함하는 `buffer` 라고 불리는 필드를 포함할 것입니다. @@ -231,7 +235,7 @@ function fileFilter (req, file, cb) { 만일 multer 로부터 특별히 에러를 캐치하고 싶다면, 직접 미들웨어 함수를 호출하세요. ```javascript -var upload = multer().single('avatar') +const upload = multer().single('avatar') app.post('/profile', function (req, res) { upload(req, res, function (err) { @@ -247,8 +251,18 @@ app.post('/profile', function (req, res) { ## 커스텀 스토리지 엔진 -자신만의 고유한 스토리지 엔진을 구축하기 위한 정보를 얻기 위해서는 [Multer Storage Engine](https://github.com/expressjs/multer/blob/master/StorageEngine.md) 문서를 참고하세요. +자신만의 고유한 스토리지 엔진을 구축하기 위한 정보를 얻기 위해서는 [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md) 문서를 참고하세요. ## 라이센스 [MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-pt-br.md b/doc/README-pt-br.md new file mode 100644 index 00000000..a2db4104 --- /dev/null +++ b/doc/README-pt-br.md @@ -0,0 +1,315 @@ +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] + +Multer é um middleware node.js para manipulação `multipart/form-data`, que é usado principalmente para fazer upload de arquivos. Foi escrito em cima do [busboy](https://github.com/mscdex/busboy) para máxima eficiência. + +**NOTA**: Multer não processará nenhum formulário que não seja multipart (`multipart/form-data`). + +## Traduções + +Este README também está disponível em outros idiomas: + +- [English](https://github.com/expressjs/multer/blob/main/README.md) (Inglês) +- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (Árabe) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Espanhol) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinês) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Coreano) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russo) +- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (Vietnã) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Português Brasil) +- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (Francês) +- [O'zbek tili](https://github.com/expressjs/multer/blob/main/doc/README-uz.md) (Uzbequistão) + +## Instalação + +```sh +$ npm install --save multer +``` + +## Uso + +Multer adiciona um objeto `body` e um `file` ou objeto `files` para objeto `request`. O objeto `body` contém os valores dos campos de texto do formulário, o objeto `file` ou `files` contém os arquivos enviados por meio do formulário. + +Exemplo de uso básico: + +Não esqueça o `enctype="multipart/form-data"` em seu formulário. + +```html +
+ +
+``` + +```javascript +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) + +const app = express() + +app.post('/profile', upload.single('avatar'), function (req, res, next) { + // req.file é um arquivo `avatar` + // req.body conterá os campos de texto, se houver +}) + +app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) { + // req.files é um array de arquivos `photos` + // req.body conterá os campos de texto, se houver +}) + +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { + // req.files é um objeto (String -> Array) onde fieldname é a chave e o valor é array de arquivos + // + // e.g. + // req.files['avatar'][0] -> File + // req.files['gallery'] -> Array + // + // req.body conterá os campos de texto, se houver +}) +``` + +Caso você precise lidar com formulário text-only multipart, você deve usar o método `.none()`: + +```javascript +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() + +app.post('/profile', upload.none(), function (req, res, next) { + // req.body contém os campos de texto +}) +``` + +Aqui está um exemplo de como o multer é usado em um formulário HTML. Onde adicionamos `enctype="multipart/form-data"` no form e no input `name="uploaded_file"`: + +```html +
+
+ + + +
+
+``` + +Então, em seu arquivo javascript, você adicionaria essas linhas para acessar o arquivo e o corpo. É importante que você use o valor do campo `name` do formulário em sua função de upload. Isso informa ao multer em qual campo da solicitação ele deve procurar os arquivos. Se esses campos não forem iguais no formulário HTML e no seu servidor, seu upload falhará: + +```javascript +const multer = require('multer') +const upload = multer({ dest: './public/data/uploads/' }) +app.post('/stats', upload.single('uploaded_file'), function (req, res) { + // req.fileé o nome do seu arquivo no formato acima, aqui 'uploaded_file' + // req.body irá conter os campos de texto, se houver algum + console.log(req.file, req.body) +}); +``` + +## API + +### Informação de arquivo + +Cada arquivo contém as seguintes informações: + +Key | Descrição | Nota +--- | --- | --- +`fieldname` | Nome do campo especificado no formulário | +`originalname` | Nome do arquivo no computador do usuário | +`encoding` | Tipo de codificação do arquivo | +`mimetype` | Tipo Mime do arquivo | +`size` | Tamanho do arquivo em bytes | +`destination` | A pasta na qual o arquivo foi salvo | `DiskStorage` +`filename` | O nome do arquivo dentro do `destination` | `DiskStorage` +`path` | O caminho completo para o arquivo enviado | `DiskStorage` +`buffer` | O `Buffer` do arquivo inteiro | `MemoryStorage` + +### `multer(opts)` + +Multer aceita um objeto de opções, a propriedade mais básica é o `dest`, que diz ao Multer onde fazer o upload dos arquivos. No caso de você omitir o objeto de opções, os arquivos serão mantidos na memória e nunca gravados no disco. + +Por padrão, Multer irá renomear os arquivos para evitar conflitos de nomes. A função de renomeação pode ser personalizada de acordo com suas necessidades. + +A seguir estão as opções que podem ser passadas para o Multer. + +Key | Descrição +--- | --- +`dest` ou `storage` | Onde armazenar os arquivos +`fileFilter` | Função para controlar quais arquivos são aceitos +`limits` | Limites dos dados enviados +`preservePath` | Mantenha o caminho completo dos arquivos em vez de apenas o nome base + +Em um web app básico, somente o `dest` pode ser necessário, e configurado como mostrado no exemplo a seguir: + +```javascript +const upload = multer({ dest: 'uploads/' }) +``` + +Se você quiser mais controle sobre seus envios, você ter que usar a opção `storage` em vez de `dest`. Multer vem com motores de armazenamento `DiskStorage` e `MemoryStorage`; Mais mecanismos estão disponíveis de terceiros. + +#### `.single(fieldname)` + +Aceite um único arquivo com o nome `fieldname`. O arquivo único será armazenado em `req.file`. + +#### `.array(fieldname[, maxCount])` + +Aceite múltiplos arquivos, todos com o nome `fieldname`. Opcional, gera um errose forem enviados mais de `maxCount`. O array de arquivos serão armazenados em +`req.files`. + +#### `.fields(fields)` + +Aceita uma mistura de arquivos, especificada por `fields`. Um objeto com um array de arquivos será armazenado em `req.files`. + +`fields` deve ser uma matriz de objetos com `name` e opcionalmente com `maxCount`. + +Exemplo: + +```javascript +[ + { name: 'avatar', maxCount: 1 }, + { name: 'gallery', maxCount: 8 } +] +``` + +#### `.none()` + +Aceite apenas campo de texto. Se algum upload de arquivo for feito, um erro com código "LIMIT\_UNEXPECTED\_FILE" será emitido. + +#### `.any()` + +Aceita todos os arquivos que são enviados. Uma matriz de arquivos será armazenada em +`req.files`. + +**AVISO:** Certifique-se de sempre manipular os arquivos que um usuário envia. +Nunca adicione o Multer como global no middleware, já que um usuário mal-intencionado poderia fazer upload de arquivos para uma rota que você não previu. Use esta função apenas nas rotas onde você está lidando com os arquivos enviados. + +### `storage` + +#### `DiskStorage` + +O mecanismo de armazenamento em disco oferece controle total sobre o armazenamento de arquivos em disco. + +```javascript +const storage = multer.diskStorage({ + destination: function (req, file, cb) { + cb(null, '/tmp/my-uploads') + }, + filename: function (req, file, cb) { + cb(null, file.fieldname + '-' + Date.now()) + } +}) + +const upload = multer({ storage: storage }) +``` + +Existem duas opções disponíveis, `destination` e `filename`. Ambas são funções que determinam onde o arquivo deve ser armazenado. + +`destination` é usado para determinar em qual pasta os arquivos enviados devem ser armazenados. Isso também pode ser dado como uma `string` (e.g. `'/tmp/uploads'`). Se não é dada `destination`, o diretório padrão do sistema operacional para arquivos temporários é usado. + +**Nota:** Você é responsável por criar o diretório ao fornecer o "destino" com uma função. Ao passar uma string, o Multer se certificará de que o diretório foi criado para você. + +`filename` é usado para determinar qual arquivo deve ser nomeado dentro da pasta. +Se não for passado `filename`, cada arquivo receberá um nome aleatório que não inclui nenhuma extensão de arquivo. + +**Nota:** Multer não adicionará nenhuma extensão de arquivo para você, sua função é retornar um nome para o arquivo completo com a extensão de arquivo. + +Cada função é passada pelo request (`req`) e algumas informações sobre o arquivo (`file`) para ajudar com a decisão. + +Observe que `req.body` pode não ter sido totalmente preenchido ainda. Isso depende da ordem na qual o cliente transmite campos e arquivos para o servidor. + +Para entender a convenção de chamada usada no callback (precisando passar +null como o primeiro parâmetro), consulte em +[Manipulação de erros no Node.js](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors) + +#### `MemoryStorage` + +O mecanismo de armazenamento na memória, armazena os arquivos na memória como um objeto `Buffer`. Não tendo opções. +```javascript +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) +``` +Ao usar o armazenamento de memória, as informações do arquivo conterão um campo chamado `buffer` que contém o arquivo inteiro. + +**AVISO**: Fazer upload de arquivos muito grandes ou arquivos relativamente pequenos em grande número muito rapidamente pode fazer com que o aplicativo fique sem memória quando o armazenamento de memória é usado. + +### `limits` + +Um objeto que especifica os limites de tamanho das seguintes propriedades opcionais. O Multer passa diretamente o objeto para o busboy, e os detalhes das propriedades podem ser encontrados em [busboy's page](https://github.com/mscdex/busboy#busboy-methods). + +Os seguintes valores inteiros estão disponíveis: + +Key | Descrição | Padrão +--- | --- | --- +`fieldNameSize` | Tamanho máximo do nome de campo| 100 bytes +`fieldSize` | Tamanho máximo do valor do campo (in bytes) | 1MB +`fields` | Max number of non-file fields | Infinity +`fileSize` | Para formulários multipart, o tamanho máximo do arquivo (in bytes) | Infinity +`files` | Para formulários multipart, o número máximo de campos de arquivos | Infinity +`parts` | Para formulários multipart, o número máximo de parts (fields + files) | Infinity +`headerPairs` | Para formulários multipart, o número máximo do header key=>value, para analisar | 2000 + +A especificação dos limites pode ajudar a proteger seu site contra ataques de negação de serviço (DoS). + +### `fileFilter` + +Defina isso para uma função para controlar quais arquivos devem ser enviados e quais devem ser ignorados. + +A função deve ficar assim: + +```javascript +function fileFilter (req, file, cb) { + + // A função deve chamar `cb` com um booleano + // para indicar se o arquivo deve ser aceito + + // Para rejeitar este arquivo passe `false`, assim: + cb(null, false) + + // Para aceitar o arquivo passe `true`, assim: + cb(null, true) + + // Você sempre pode passar um erro se algo der errado: + cb(new Error('I don\'t have a clue!')) + +} +``` + +## Error handling + +Quando encontrar um erro, Multer delegará o erro para Express. Você pode exibir uma boa página de erro usando [the standard express way](http://expressjs.com/guide/error-handling.html). + +Se você quer pegar erros especificamente do Multer, você pode enviar para o função de middleware. Além disso, se você quiser pegar apenas [os erros do Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), você pode usar a classe `MulterError` que está ligado ao objeto `multer` (e.g. `err instanceof multer.MulterError`). + +```javascript +const multer = require('multer') +const upload = multer().single('avatar') + +app.post('/profile', function (req, res) { + upload(req, res, function (err) { + if (err instanceof multer.MulterError) { + // Ocorreu um erro durante o upload. + } else if (err) { + // Ocorreu um erro durante o upload. + } + + // Tudo correu bem. + }) +}) +``` + +## Mecanismo de armazenamento personalizado + +Para obter informações sobre como criar seu próprio mecanismo de armazenamento, veja [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md). + +## Licença + +[MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-ru.md b/doc/README-ru.md index 76c3bd80..8c968b13 100644 --- a/doc/README-ru.md +++ b/doc/README-ru.md @@ -1,16 +1,19 @@ -# Multer [![Build Status](https://travis-ci.org/expressjs/multer.svg?branch=master)](https://travis-ci.org/expressjs/multer) [![NPM version](https://badge.fury.io/js/multer.svg)](https://badge.fury.io/js/multer) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] Multer — это middleware для фреймворка express для обработки `multipart/form-data`, нужная в первую очередь при загрузке файлов. Написана как обертка над [busboy](https://github.com/mscdex/busboy) для ее максимально эффективного использования. **ВАЖНО**: Multer не обрабатывает никакой другой тип форм, кроме `multipart/form-data`. -## Переводы +## Переводы Это README также доступно на других языках: -- [English](https://github.com/expressjs/multer/blob/master/README.md) (Английский) -- [简体中文](https://github.com/expressjs/multer/blob/master/doc/README-zh-cn.md) (Китайский) -- [한국어](https://github.com/expressjs/multer/blob/master/doc/README-ko.md) (Корейский) +- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (арабский) +- [English](https://github.com/expressjs/multer/blob/main/README.md) (Английский) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Испанский) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Китайский) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Корейский) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (бр Португальский) ## Установка @@ -33,11 +36,11 @@ Multer добавляет объект `body` и объект `file` (или `fi ``` ```javascript -var express = require('express') -var multer = require('multer') -var upload = multer({ dest: 'uploads/' }) +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) -var app = express() +const app = express() app.post('/profile', upload.single('avatar'), function (req, res, next) { // req.file - файл `avatar` @@ -49,8 +52,8 @@ app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) // req.body сохранит текстовые поля, если они будут }) -var cpUpload = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) -app.post('/cool-profile', cpUpload, function (req, res, next) { +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { // req.files - объект (String -> Array), где fieldname - ключ, и значение - массив файлов // // например: @@ -64,10 +67,10 @@ app.post('/cool-profile', cpUpload, function (req, res, next) { Если вам нужно обработать multipart-форму, содержащую только текст, используйте метод `.none()`: ```javascript -var express = require('express') -var app = express() -var multer = require('multer') -var upload = multer() +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() app.post('/profile', upload.none(), function (req, res, next) { // req.body содержит текстовые поля @@ -110,13 +113,13 @@ Multer принимает объект с опциями. Базовая опц Обычно для веб-приложения нужно обязательно переопределить `dest`, как показано в примере ниже. ```javascript -var upload = multer({ dest: 'uploads/' }) +const upload = multer({ dest: 'uploads/' }) ``` Если вам нужно больше возможностей для управления приложением, можно использовать `storage` вместо `dest`. Multer поставляется с двумя движками работы с памятью, `DiskStorage` и `MemoryStorage`, другие движки можно найти у сторонних разработчиков. #### `.single(fieldname)` -Принимает один файо с именем `fieldname`. Файл будет сохранен в `req.file`. +Принимает один файл с именем `fieldname`. Файл будет сохранен в `req.file`. #### `.array(fieldname[, maxCount])` @@ -150,10 +153,10 @@ var upload = multer({ dest: 'uploads/' }) #### `DiskStorage` -Движок дискового пространства. Дает полный контроль над размещением файлов на диск. +Движок дискового пространства. Дает полный контроль над размещением файлов на диск. ```javascript -var storage = multer.diskStorage({ +const storage = multer.diskStorage({ destination: function (req, file, cb) { cb(null, '/tmp/my-uploads') }, @@ -162,16 +165,16 @@ var storage = multer.diskStorage({ } }) -var upload = multer({ storage: storage }) +const upload = multer({ storage: storage }) ``` -Доступно две опции, расположение `destination` и имя файла `filename`. Обе эти функции определяют, где будет находиться файл после загрузки. +Доступно две опции, расположение `destination` и имя файла `filename`. Обе эти функции определяют, где будет находиться файл после загрузки. `destination` используется, чтобы задать каталог, в котором будут размещены файлы. Может быть задан строкой (например, `'/tmp/uploads'`). Если не задано расположение `destination`, операционная система воспользуется для сохранения каталогом для временных файлов. -**Важно:** Вы должны создать каталог, когда используете `destination`. При передачи в качестве аргумента строки, Multer проверяет, что каталог создан. +**Важно:** Вы должны создать каталог, когда используете `destination`. При передачи в качестве аргумента строки, Multer проверяет, что каталог создан. -`filename` используется, чтобы определить, как будет назван файл внутри каталога. Если +`filename` используется, чтобы определить, как будет назван файл внутри каталога. Если имя файла `filename` не задано, каждому файлу будет сконфигурировано случайное имя без расширения файла. **Важно:** Multer не добавляет никакого файлового расширения, ваша функция должна возвращать имя файла с необходимым расширением. @@ -185,16 +188,16 @@ var upload = multer({ storage: storage }) Движок оперативной памяти сохраняет файлы в памяти как объекты типа `Buffer`. В этом случае нет никаких дополнительных опций. ```javascript -var storage = multer.memoryStorage() -var upload = multer({ storage: storage }) +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) ``` -Когда вы используете этот тип передачи, информация о файле будет содержать поле `buffer`, которое содержит весь файл. +Когда вы используете этот тип передачи, информация о файле будет содержать поле `buffer`, которое содержит весь файл. **ПРЕДУПРЕЖДЕНИЕ**: Загрузка очень больших файлов, или относительно небольших файлов в большом количестве может вызвать переполнение памяти. ### `limits` -Объект, устанавливающий ограничения. Multer прокидывает этот объект напрямую в busboy, поэтому детали можно посмотреть +Объект, устанавливающий ограничения. Multer прокидывает этот объект напрямую в busboy, поэтому детали можно посмотреть [на странице с методами busboy](https://github.com/mscdex/busboy#busboy-methods). Доступны следующие целочисленные значения: @@ -213,7 +216,7 @@ var upload = multer({ storage: storage }) ### `fileFilter` -Задает функцию для того, чтобы решать, какие файлы должны быть загружены, а какие — нет. Функция может выглядет так: +Задают функцию для того, чтобы решать, какие файлы будут загружены, а какие — нет. Функция может выглядеть так: ```javascript function fileFilter (req, file, cb) { @@ -237,11 +240,11 @@ function fileFilter (req, file, cb) { Когда выбрасывается исключение, Multer делегирует его обработку Express. Вы можете выводить страницу ошибки [стандартными для express способами](http://expressjs.com/guide/error-handling.html). -Если вы хотите отлавливать ошибки конкретно от Multer, вам нужно вызывать собственную middleware для их обработки. Еще, если вы хотите отлавливать [исключительно ошибки Multer](https://github.com/expressjs/multer/blob/master/lib/make-error.js#L1-L9), вы можете использовать класс `MulterError`, который привязан к объекту `multer` (например, `err instanceof multer.MulterError`) +Если вы хотите отлавливать ошибки конкретно от Multer, вам нужно вызывать собственную middleware для их обработки. Еще, если вы хотите отлавливать [исключительно ошибки Multer](https://github.com/expressjs/multer/blob/main/lib/make-error.js#L1-L9), вы можете использовать класс `MulterError`, который привязан к объекту `multer` (например, `err instanceof multer.MulterError`) ```javascript -var multer = require('multer') -var upload = multer().single('avatar') +const multer = require('multer') +const upload = multer().single('avatar') app.post('/profile', function (req, res) { upload(req, res, function (err) { @@ -258,8 +261,18 @@ app.post('/profile', function (req, res) { ## Собственные движки для сохранения файлов -Чтобы получить информацию, как создать собственный движок для обработки загрузки файлов, смотрите страницу [Multer Storage Engine](https://github.com/expressjs/multer/blob/master/StorageEngine.md). +Чтобы получить информацию, как создать собственный движок для обработки загрузки файлов, смотрите страницу [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md). ## Лицензия [MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-uz.md b/doc/README-uz.md new file mode 100644 index 00000000..9c37cb36 --- /dev/null +++ b/doc/README-uz.md @@ -0,0 +1,283 @@ +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] + +Multer - bu nodejs middleware bo'lib, asosan `multipart/form-data` shaklda yuborilgan fayllarni yuklashda ishlatiladi. Yuqori samaradorlikka erishish uchun [busboy](https://github.com/mscdex/busboy)ning ustiga yozilgan. + +**Muhim**: Multer `multipart` bo'lmagan har qanday formani qayta ishlamaydi. + +## Tarjimalar + +Bu README boshqa tillarda ham mavjud: + +- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (arabcha) +- [English](https://github.com/expressjs/multer/blob/main/README.md) (inglizcha) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (ispancha) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (xitoycha) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (korescha) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (portugalcha) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (ruscha) +- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (fransuzcha) + + +## O'rnatish + +```sh +$ npm install --save multer +``` + +## Foydalanish + +Multer - `request` ob'ektiga `body` va `file` yoki `files` ob'ektini qo'shadi. `body` ob'ekti formaning matn maydonlarining (fields) qiymatlarini o'z ichiga oladi, `file` yoki `files` ob'ekti forma orqali yuklangan fayllarni o'z ichiga oladi. + +Sodda ishlatish uchun namuna: + +Formada `enctype="multipart/form-data"` qo'shish esdan chiqmasin + +```html +
+ +
+``` + +```javascript +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) + +const app = express() + +app.post('/profile', upload.single('avatar'), function (req, res, next) { + // req.file - fayl `avatar` + // req.body agar matnli maydonlar (fields) bo'lsa, ularni saqlanadi +}) + +app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) { + // req.files - fayllar massivi `photos` + // req.body agar matnli maydonlar (fields) bo'lsa, ularni saqlanadi +}) + +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { + // req.files - bu ob'ekt (String -> Array), matn maydoni(fieldname) - bu key, va qiymat - fayllar massivi + // + // misol: + // req.files['avatar'][0] -> File + // req.files['gallery'] -> Array + // + // req.body agar matnli maydonlar (fields) bo'lsa, ularni saqlanadi +}) +``` + +Agarda siz faqat matndan iborat multipart form bilan ishlashingiz kerak bo'lsa, `.none()` ishlating: + +```javascript +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() + +app.post('/profile', upload.none(), function (req, res, next) { + // req.body matnli maydonlar (fields)ni o'zida saqlaydi +}) +``` + +## API + +### Fayl haqida ma'lumot + +Har bir fayl quyidagi ma'lumotlarni o'zida saqlaydi: + +Kalit(key) | Ta'rif | Eslatma +--- |----------------------------------------| --- +`fieldname` | Formada berilgan maxsus nom | +`originalname` | Foydalanuvchi kompyuteridagi fayl nomi | +`encoding` | Faylning kodlash turi | +`mimetype` | Faylning `mime` turi | +`size` | Fayl hajmi - baytda | +`destination` | Fayl saqlangan papka | `DiskStorage` +`filename` | `destination`ni ichidagi fayl nomi | `DiskStorage` +`path` | Yuklangan faylning to'liq yo'li | `DiskStorage` +`buffer` | Butun boshli fayl `Buffer` tipda | `MemoryStorage` + +### `multer(opts)` + +Multer qo'shimcha ob'ekt qabul qiladi, ulardan eng asosiysi - `dest`, +Multerga fayllarni qayerga yuklash kerakligini aytadigan xususiyat. Agarda siz qo'shimcha(`options`) ob'ektni tashlab ketsangiz, fayllar xotirada saqlanadi va hech qachon diskka yozilmaydi. + +Standart holatda - Multer nomlashda kelib chiqishi mumkin bo'lgan muammolarni oldini olish uchun fayllar nomini o'zgartiradi. O'z talablaringizga mos ravishda nomlash funksiyasini sozlay olashingiz mumkin. + +Quyidagilar Multerga qo'shimcha qiymat sifati berilishi mumkin: + +Kalit(key) | Ta'rif +--- | --- +`dest` yoki `storage` | Faylni qayerda saqlash +`fileFilter` | Qaysi fayllar qabul qilinishini boshqarish funksiyasi +`limits` | Yuklash chegarasi +`preservePath` | Asosiy nom o'rniga fayllarning to'liq yo'lini saqlash + +O'rtacha veb-ilovada faqat `dest` kerak bo'lishi mumkin va quyidagicha sozlanishi mumkin + +```javascript +const upload = multer({ dest: 'uploads/' }) +``` +Yuklamalaringizni boshqarishda ko'proq nazoratni xohlasangiz, `dest` o'rniga `storage` tanlovini ishlatishingiz kerak. Multer `DiskStorage` va `MemoryStorage` saqlash motorlari(engines) bilan keladi. Boshqa motorlar(engines) uchun uchinchi tomondan(third parties) ko'proq tanlovlar keladi. + +#### `.single(fieldname)` + +`fieldname` nomi bilan yagona faylni qabul qiladi. Yagona fayl `req.file` da saqlanadi. + +#### `.array(fieldname[, maxCount])` + +`fieldname` nomi bilan fayllar massivini qabul qiladi. Agar `maxCount` dan ko'p fayl yuklash urinishi bo'lsa, hatolikni aniqlash imkoniyatini berish mumkin. Fayllar massivi `req.files` da saqlanadi. + +#### `.fields(fields)` + +`fields`da aniqlangan fayllarni qabul qiladi. Fayllar massivini saqlash uchun `req.files` ichidagi massivda saqlanadi. + +`fields` ob'ektida `name` va `maxCount` kalitlar(keys)ni o'z ichiga olishi kerak. Misol: + +```javascript +[ + { name: 'avatar', maxCount: 1 }, + { name: 'gallery', maxCount: 8 } +] +``` + +#### `.none()` + +Faqatgina matnli maydonlar(fields)ni oladi. Agarda biror fayl yuklansa, "LIMIT\_UNEXPECTED\_FILE" xatoligi yuboriladi. + +#### `.any()` + +Ushbu so'rov barcha fayllarni qabul qiladi, fayllar `req.files` ichida saqlanadi. + +**OGOHLANTIRISH:** Foydalanuvchi yuklagan fayllarni doimo boshqarib turishni unutmang. Ularni boshqa yo'l(route)ni kutmagan holda fayllarini yuklash imkonini beradigan global middleware sifatida multerni sozlamang. Faqatgina yuklangan fayllarni boshqarish kerak bo'lgan yo'l(route)larda ushbu funksiyani ishlating. + +### `storage` + +#### `DiskStorage` + +Diskka saqlash motori(engine) sizga fayllarni saqlashda to'liq nazorat qilish imkonini beradi. + +```javascript +const storage = multer.diskStorage({ + destination: function (req, file, cb) { + cb(null, '/tmp/my-uploads') + }, + filename: function (req, file, cb) { + cb(null, file.fieldname + '-' + Date.now()) + } +}) + +const upload = multer({ storage: storage }) +``` + +`destination` va `filename` qo'shimcha tanlovlari mavjud, ular ikkala ham qaysi papkada faylni saqlash kerakligini aniqlab turadigan funksiyalardir. + +`destination` yuklangan fayllarni qaysi papkada saqlash kerakligini aniqlab turadi. Bu, `string` sifatida berilishi mumkin (masalan, `'/tmp/uploads'`). Agar `destination` berilmagan bo'lsa, operatsion tizimning vaqtinchalik fayllar uchun ishlatiladigan papkasini ishlatadi. + +**Diqqat:** `destination` ni funksiya sifatida berib bo'lganda papka ochilganligiga o'zingiz javobgar bo'lasiz. Agar `string` sifatida bersangiz, multer papkani o'zi uchun yaratishni ta'minlaydi. + +`filename` faylni papka ichida qanday nomlanganligini aniqlaydi. Agar `filename` berilmagan bo'lsa, har bir faylga fayl kengaytmasini o'z ichiga olmagan tasodifiy nom beriladi. + +**Diqqat:** Multer siz uchun fayl kengaytmasini qo'shmaydi, sizning funksiyangiz kengaytma bilan to'liq nomni qaytarishi kerak. + +Har bir funksiya `req` so'rovini va fayl haqida ma'lumotlarni (`file`) olish uchun o'tkaziladi. + +Diqqat qiling, `req.body` hali to'liq to'ldirilmagan bo'lishi mumkin. Bu mijozning maydon(field)larni va fayllarni serverga qanday yuborishiga bog'liq bo'ladi. + +Callback funktsiyasida ishlatiladigan chaqirish tartibini tushunish uchun (birinchi parametr sifatida null o‘tkazish talab etilishi) ko‘rish uchun quyidagi manzilga murojaat qiling: +[Node.js da xatoliklarni ushlash](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors) + +#### `MemoryStorage` + +Xotira saqlash motori fayllarni xotirada `Buffer` ob'ektlar sifatida saqlaydi. Uning qo'shimcha qiymatlari yo‘q. + +```javascript +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) +``` +Xotirada saqlash paytida, fayl ma'lumotlari `buffer` deb nomlanadigan maydonni o‘z ichiga oladi. + +**DIQQAT:** Juda katta fayllarni yuklash, yoki kichik fayllarni tez-tez yuklash, xotirada saqlash ishlatilganda, sizning ilovangizning xotirasini to'ldirib qo'yishi mumkin. + +### `limits` + +Quyidagi xususiyatlar o'lchov(limit)larni aniqlaydigan obyekt. Multer ushbu obyektni to'g'ridan-to'g'ri busboy ga o'tkazadi va xususiyatlar tafsilotlari [busboy sahifasida](https://github.com/mscdex/busboy#busboy-methods)dan topishingiz mumkin. + +Quyidagi butun qiymatlar mavjud: + +Kalit(key) | Ta'rif | Odatiy qiymat +--- |---------------------------------------------------------------------------------------------| --- +`fieldNameSize` | Maksimal maydon nomi o'lchami | 100 bayt +`fieldSize` | Maksimal maydon qiymati o'lchami (baytlarda) | 1MB +`fields` | Fayl bo'lmagan maydonlarning maksimal soni | Cheklanmagan +`fileSize` | Multipart form uchun faylning maksimal o'lchami (baytda) | Cheklanmagan +`files` | Multipart form uchun fayllar sonining maksimal chegarasi | Cheklanmagan +`parts` | Multipart form uchun fayllar sonining maksimal chegarasi (fieldlar va fayllar) | Cheklanmagan +`headerPairs` | Multipart form uchun ma'lumotlar (kalit va qiymat juftliklari) sonining maksimal chegarasi | 2000 + +Chegaralarni sozlash, DoS-hujumlariga qarshi saytingizni himoya qilishga yordam bera olishi mumkin + +### `fileFilter` + +Bu, qaysi fayllarni yuklashi, qaysilarini o'tkazib yuborish kerakligini boshqarish uchun funksiya sifatida sozlasa bo'ladi. Funksiya quyidagi ko'rinishda bo'lishi kerak:" + +```javascript +function fileFilter (req, file, cb) { + + // Bu funksiya, faylni qabul qilish kerakligini anglatish uchun `cb` ni + // boolean qiymat bilan chaqirish kerak. + + // Faylni qabul qilishni rad etish uchun false quyudagicha berilishi kerak: + cb(null, false) + + // Faylni qabul qiilishni tasdiqlash uchun true quyudagicha berilishi kerak: + cb(null, true) + + // Nimadir xato ketsa, siz har doim Error berishingiz mumkin: + cb(new Error('I don\'t have a clue!')) + +} +``` + +## Xatolar bilan ishlash + +Xatoga duch kelganda, Multer xatoni Expressga yuboradi. [standart express usuli](http://expressjs.com/guide/error-handling.html)dan foydalanib xatoni tartibliroq chiqarishingiz mumkin. + +Agar siz Multerdan chiqqan xatolarni aniqlamoqchi bo'lsangiz o'zingiz `middleware` funksiya yozishingiz mumkin. Shuningdek, agar siz faqat [Multer xatolarini](https://github.com/expressjs/multer/blob/main/lib/multer-error.js) ushlamoqchi bo'lsangiz, siz `multer` ob'ektiga yozilgan `MulterError` class ni ishlatishingiz mumkin (masalan, `err instanceof multer.MulterError`). + + +```javascript +const multer = require('multer') +const upload = multer().single('avatar') + +app.post('/profile', function (req, res) { + upload(req, res, function (err) { + if (err instanceof multer.MulterError) { + // Yuklanishda Multerdan xatolik yuz berganda. + } else { + // Yuklanishda noma'lum xatolik yuz berganda. + } + + // Hammasi muvaffaqqiyatli bo'lganda. + }) +}) +``` + +## Maxsus saqlash mexanizmi + +O'zingizning saqlash dvigatelingizni qanday yaratish haqida ma'lumot olish: [Maxsus saqlash mexanizmi](https://github.com/expressjs/multer/blob/main/StorageEngine.md). + +## Litsenziya + +[MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-vi.md b/doc/README-vi.md new file mode 100644 index 00000000..977858c6 --- /dev/null +++ b/doc/README-vi.md @@ -0,0 +1,300 @@ +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] + +Multer là thư viện trung gian hỗ trợ việc xử lý `multipart/form-data`, mục đích chính cho việc upload file. Thư viện này dựa trên [busboy](https://github.com/mscdex/busboy) để hiệu quả hơn. + +**CHÚ Ý**: Multer sẽ không xử lý bất kỳ form nào ngoài multipart (`multipart/form-data`). + +## Dịch: + +Các bạn có thể đọc ở các bản dịch ngôn ngữ khác: + +- [English](https://github.com/expressjs/multer/blob/main/README.md) (Tiếng Anh) +- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinese) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Korean) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russian) + +## Cài đặt + +```sh +$ npm install --save multer +``` + +## Sử dụng + +Multer gắn thêm một object `body` và một object `file` (hoặc `files` trường hợp upload nhiều file) vào object `request`. Object `body` này sẽ chứa các biến text của form, còn object `file` (hoặc `files`) sẽ chứa các file được upload qua form. + +Cách sử sụng: + +Phải thêm `enctype="multipart/form-data"` vào form của bạn. + +```html +
+ +
+``` + +```javascript +var express = require('express'); +var multer = require('multer'); +var upload = multer({ dest: 'uploads/' }); + +var app = express(); + +app.post('/profile', upload.single('avatar'), function(req, res, next) { + // req.file là 1 file `avatar` được upload + // req.body sẽ giữ thông tin gắn kèm (vd: text fields), nếu có +}); + +app.post('/photos/upload', upload.array('photos', 12), function( + req, + res, + next +) { + // req.files là một mảng của các file `photos` + // req.body sẽ giữ thông tin gắn kèm (vd: text fields), nếu có +}); + +var uploadMiddleware = upload.fields([ + { name: 'avatar', maxCount: 1 }, + { name: 'gallery', maxCount: 8 }, +]); +app.post('/cool-profile', uploadMiddleware, function(req, res, next) { + // req.files là một object kiểu (String -> Array) mà fieldname là key, và value là mảng các files + // + // vd: + // req.files['avatar'][0] -> File + // req.files['gallery'] -> Array + // + // req.body sẽ giữ thông tin gắn kèm (vd: text fields), nếu có +}); +``` + +Trong trường hợp bạn cần xử lý một multipart form chỉ chứa text, bạn nên sử dụng hàm `.none()`: + +```javascript +var express = require('express'); +var app = express(); +var multer = require('multer'); +var upload = multer(); + +app.post('/profile', upload.none(), function(req, res, next) { + // req.body sẽ giữ thông tin gắn kèm (vd: text fields) +}); +``` + +## API + +### Thông tin File được upload + +Mỗi file sẽ chứa các thông tin sau: + +| Thuộc tính | Mô tả | Ghi chú | +| -------------- | --------------------------------------------------------------- | ------------------------- | +| `fieldname` | tên mỗi thuộc tính ở trong form | +| `originalname` | Tên của file nằm trên máy của người dùng, trước khi được upload | +| `encoding` | Kiểu Encoding của file | +| `mimetype` | Mime type của file | `image/jpeg`, `image/png` | +| `size` | Kích thước của file (theo bytes) | +| `destination` | Đường dẫn tới thư mục file được lưu | `DiskStorage` | +| `filename` | Tên của file (ở trong `destination`) | `DiskStorage` | +| `path` | Đường dẫn đầy đủ tới file đã upload | `DiskStorage` | +| `buffer` | Một `Buffer` của toàn bộ file | `MemoryStorage` | + +### Tham số `multer(opts)` + +Multer chấp nhận một biến options. Cơ bản là thuộc tính `dest`, là nơi sẽ lưu +file được uplaod. Trong trường hợp bỏ qua options này, file sẽ được giữ trong +RAM và không được lưu trên ổ cứng. + +Mặc định, Multer sẽ đổi tên các file, vì vậy để tránh bị trùng lặp, bạn có thể +tùy biến hàm đổi tên này. + +Dưới đây là các tùy chọn mà bạn có thể sử dụng: + +| Thuộc tính | Mô tả | +| --------------------- | -------------------------------------------------- | +| `dest` hoặc `storage` | Nơi lưu trữ file | +| `fileFilter` | Hàm để xử lý chỉ những file nào mới được chấp nhận | +| `limits` | Giới hạn dung lượng file được upload | +| `preservePath` | Giữ đầy đủ đường dẫn tới file thay vì chỉ tên file | + +Nói chung với web app, chỉ `dest` mới cần khai báo, như bên dưới: + +```javascript +var upload = multer({ dest: 'uploads/' }); +``` + +Nếu bạn muốn tùy biến việc upload, bạn sẽ muốn dùng tùy chọn `storage` thay vì `dest`. +Multer sẽ sử dụng 1 trong 2 cách `DiskStorage` và `MemoryStorage`; Hoặc các cách khác (với các thư viện ngoài). + +#### `.single(fieldname)` + +Chấp nhận chỉ một file với tên thuộc tính `fieldname`. File này truy cập qua `req.file`. + +#### `.array(fieldname[, maxCount])` + +Chấp nhận mảng các file, tất cả đều với tên `fieldname`. Một lỗi sẽ bắn ra nếu có +nhiều hơn `maxCount` file được upload. Các file này được lưu ở `req.files`. + +#### `.fields(fields)` + +Chấp nhận nhiều file với thuộc tính `fields`. Một object với mảng các file được lưu ở `req.files`. + +`fields` là một mảng các object với thuộc tính `name` và có thể có thuộc tính `maxCount` hoặc không. + +Ví dụ: + +```javascript +[{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]; +``` + +#### `.none()` + +Chỉ chấp nhận các giá trị text trong form. Nếu bất kỳ file được đính +kèm, một lỗi với mã "LIMIT_UNEXPECTED_FILE" sẽ bắn ra. + +#### `.any()` + +Chấp nhận tất cả file đến từ bất kỳ nguồn nào. Một mảng các file sẽ được lưu +ở `req.files`. + +**CHÚ Ý:** Hãy chắc chắn bạn không bỏ qua bất kỳ file nào mà người dùng upload. +Đừng bao giờ khai báo Multer như một middleware toàn cục, vì người dùng có thể upload +các file tới một api nào đó mà bạn không biết. Chỉ sử dụng hàm này ở trên api mà bạn +muốn xử lý việc upload file. + +### `storage` + +#### `DiskStorage` + +Cơ chế lưu trữ trên ổ đĩa cho phép bạn có đầy đủ quyền để thao tác với file. + +```javascript +var storage = multer.diskStorage({ + destination: function(req, file, cb) { + cb(null, '/tmp/my-uploads'); + }, + filename: function(req, file, cb) { + cb(null, file.fieldname + '-' + Date.now()); + }, +}); + +var upload = multer({ storage: storage }); +``` + +Có 2 tùy chọn, `destination` và `filename`. Chúng đều dùng để xác định nơi nào +file sẽ được lưu trữ. + +`destination` được dùng để xác định thư mục nào file được upload. Có thể là một +`string` (vd: `'/tmp/uploads'`). Nếu không khai báo `destination`, thư mục tạm +(của hệ điều hành) sẽ được dùng để chứa các file đó. + +**Ghi chú:** Nếu bạn khai báo `destination` là một hàm, bạn phải tự tạo đường +dẫn. Còn nếu truyền vào một string, multer sẽ đảm bảo việc tạo đường dẫn đó cho bạn. + +`filename` được dùng để xác định file nào sẽ được lưu trong thư mục. Nếu không +có `filename` nào, mỗi file sẽ nhận tên ngẫu nhiên mà không bao gồm đuôi của file. + +**Ghi chú:** Multer sẽ không thêm bất kỳ đuôi file nào cho bạn, hàm của bạn nên +trả về một file với đuôi của nó. + +Mỗi hàm được truyền cả ở request (`req`) và thông tin về file (`file`) để xử lý. + +Chú ý `req.body` có thể không chứa đầy đủ thông tin, phụ thuộc việc thứ tự các +trường dữ liệu và file được gửi tới server lúc nào. + +#### `MemoryStorage` + +Memory storage lưu các file ở bộ nhớ máy dưới dạng một object `Buffer`. Nó không +có bất kỳ tùy chọn nào. + +```javascript +var storage = multer.memoryStorage(); +var upload = multer({ storage: storage }); +``` + +Khi sử dụng memory storage, thông tin file sẽ chứa một trường `buffer`, trường +này chứa toàn bộ file. + +**CHÚ Ý**: Việc upload file rất lớn, hoặc tương tự việc nhiều file nhỏ, có thể +gây ra tràn bộ nhớ khi memory storage được sử dụng. + +### `limits` + +Một object mô tả giới hạn kích thước trong thuộc tính nên được sử dụng. Multer truyền object này trực tiếp vào busboy, và chi tiết của busboy có thể xem thêm ở [busboy's page](https://github.com/mscdex/busboy#busboy-methods). + +Các số dưới dây cũng có thể được dùng: + +| Thuộc tính | Mô tả | Giá trị mặc định | +| --------------- | -------------------------------------------------------------------- | ---------------- | +| `fieldNameSize` | Độ dài tối đa của tên field | 100 bytes | +| `fieldSize` | Kích thước tối đa của mỗi field (theo bytes) | 1MB | +| `fields` | Số lượng tối đa của các fields không phải là file | Infinity | +| `fileSize` | Cho multipart forms, kích thước tối đa của file (theo bytes) | Infinity | +| `files` | Cho multipart forms, số lượng file tối đa | Infinity | +| `parts` | Cho multipart forms, số lượng tối đa của parts (gồm fields + files) | Infinity | +| `headerPairs` | Cho multipart forms, số tối đa trong header cặp key=>value để truyền | 2000 | + +Khai báo các giới hạn này giúp cho site của bạn chống lại các tấn công nguy hiểm (DoS). + +### `fileFilter` + +Dùng hàm này để xử lý các file nào cho phép và bị bỏ qua. Xem ví dụ dưới dây: + +```javascript +function fileFilter(req, file, cb) { + // hàm này sẽ gọi callback `cb` với 1 biến boolean + // để chỉ ra rằng file có được chấp nhận hay không + + // Để chặn file này, truyền `false` như sau: + cb(null, false); + + // Để chấp nhận file này, truỳen `true`, như sau: + cb(null, true); + + // Hoặc bạn có thể truyền vào 1 lỗi nếu có vấn đề xảy ra: + cb(new Error("I don't have a clue!")); +} +``` + +## Error handling + +Khi một lỗi xảy ra, Multer sẽ gửi lỗi đó cho Express. Bạn có thể hiển thị +đẹp hơn sử dụng [cách bắt lỗi chuẩn của Express](http://expressjs.com/guide/error-handling.html). + +Nếu bạn muốn bắt các lỗi cụ thể từ Multer, bạn có thể tự gọi hàm trung gian (middleware) này. Ngoài ra, nếu bạn chỉ muốn bắt [lỗi của Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), bạn có thể dùng class `MulterError` được đính kèm với chính object `multer` (vd: `err instanceof multer.MulterError`). + +```javascript +var multer = require('multer'); +var upload = multer().single('avatar'); + +app.post('/profile', function(req, res) { + upload(req, res, function(err) { + if (err instanceof multer.MulterError) { + // Một lỗi của Multer xảy ra khi upload. + } else if (err) { + // Một lỗi không xác định xảy ra khi upload. + } + + // Mọi thứ khác chạy ok. + }); +}); +``` + +## Tùy chọn storage engine + +Để làm sao tự xây dựng cơ chế lưu file riêng của mình, hãy xem [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md). + +## License + +[MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/doc/README-zh-cn.md b/doc/README-zh-cn.md index 788db1ca..31084d1c 100644 --- a/doc/README-zh-cn.md +++ b/doc/README-zh-cn.md @@ -2,7 +2,7 @@ **甚至可能存在翻译错误!你可能需要阅读原版英语[README](../README.md)** **此文档仅供参考!** -# Multer [![Build Status](https://travis-ci.org/expressjs/multer.svg?branch=master)](https://travis-ci.org/expressjs/multer) [![NPM version](https://badge.fury.io/js/multer.svg)](https://badge.fury.io/js/multer) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) +# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer] Multer 是一个 node.js 中间件,用于处理 `multipart/form-data` 类型的表单数据,它主要用于上传文件。它是写在 [busboy](https://github.com/mscdex/busboy) 之上非常高效。 @@ -10,9 +10,12 @@ Multer 是一个 node.js 中间件,用于处理 `multipart/form-data` 类型 ## 其它语言 -- [English](https://github.com/expressjs/multer/blob/master/README.md) (英语) -- [한국어](https://github.com/expressjs/multer/blob/master/doc/README-ko.md) (朝鲜语) -- [Русский язык](https://github.com/expressjs/multer/blob/master/doc/README-ru.md) (俄語) +- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (阿拉伯语) +- [English](https://github.com/expressjs/multer/blob/main/README.md) (英语) +- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (西班牙文) +- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (朝鲜语) +- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (俄語) +- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (巴西葡萄牙语) ## 安装 @@ -28,11 +31,11 @@ Multer 会添加一个 `body` 对象 以及 `file` 或 `files` 对象 到 expres 基本使用方法: ```javascript -var express = require('express') -var multer = require('multer') -var upload = multer({ dest: 'uploads/' }) +const express = require('express') +const multer = require('multer') +const upload = multer({ dest: 'uploads/' }) -var app = express() +const app = express() app.post('/profile', upload.single('avatar'), function (req, res, next) { // req.file 是 `avatar` 文件的信息 @@ -44,8 +47,8 @@ app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) // req.body 将具有文本域数据,如果存在的话 }) -var cpUpload = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) -app.post('/cool-profile', cpUpload, function (req, res, next) { +const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }]) +app.post('/cool-profile', uploadMiddleware, function (req, res, next) { // req.files 是一个对象 (String -> Array) 键是文件名,值是文件数组 // // 例如: @@ -59,10 +62,10 @@ app.post('/cool-profile', cpUpload, function (req, res, next) { 如果你需要处理一个只有文本域的表单,你应当使用 `.none()`: ```javascript -var express = require('express') -var app = express() -var multer = require('multer') -var upload = multer() +const express = require('express') +const app = express() +const multer = require('multer') +const upload = multer() app.post('/profile', upload.none(), function (req, res, next) { // req.body 包含文本域 @@ -105,7 +108,7 @@ Key | Description 通常,一般的网页应用,只需要设置 `dest` 属性,像这样: ```javascript -var upload = multer({ dest: 'uploads/' }) +const upload = multer({ dest: 'uploads/' }) ``` 如果你想在上传时进行更多的控制,你可以使用 `storage` 选项替代 `dest`。Multer 具有 `DiskStorage` 和 `MemoryStorage` 两个存储引擎;另外还可以从第三方获得更多可用的引擎。 @@ -151,7 +154,7 @@ Example: 磁盘存储引擎可以让你控制文件的存储。 ```javascript -var storage = multer.diskStorage({ +const storage = multer.diskStorage({ destination: function (req, file, cb) { cb(null, '/tmp/my-uploads') }, @@ -160,7 +163,7 @@ var storage = multer.diskStorage({ } }) -var upload = multer({ storage: storage }) +const upload = multer({ storage: storage }) ``` 有两个选项可用,`destination` 和 `filename`。他们都是用来确定文件存储位置的函数。 @@ -182,8 +185,8 @@ var upload = multer({ storage: storage }) 内存存储引擎将文件存储在内存中的 `Buffer` 对象,它没有任何选项。 ```javascript -var storage = multer.memoryStorage() -var upload = multer({ storage: storage }) +const storage = multer.memoryStorage() +const upload = multer({ storage: storage }) ``` 当使用内存存储引擎,文件信息将包含一个 `buffer` 字段,里面包含了整个文件数据。 @@ -232,11 +235,11 @@ function fileFilter (req, file, cb) { 当遇到一个错误,multer 将会把错误发送给 express。你可以使用一个比较好的错误展示页 ([express标准方式](http://expressjs.com/guide/error-handling.html))。 -如果你想捕捉 multer 发出的错误,你可以自己调用中间件程序。如果你想捕捉 [Multer 错误](https://github.com/expressjs/multer/blob/master/lib/make-error.js#L1-L9),你可以使用 `multer` 对象下的 `MulterError` 类 (即 `err instanceof multer.MulterError`)。 +如果你想捕捉 multer 发出的错误,你可以自己调用中间件程序。如果你想捕捉 [Multer 错误](https://github.com/expressjs/multer/blob/main/lib/multer-error.js),你可以使用 `multer` 对象下的 `MulterError` 类 (即 `err instanceof multer.MulterError`)。 ```javascript -var multer = require('multer') -var upload = multer().single('avatar') +const multer = require('multer') +const upload = multer().single('avatar') app.post('/profile', function (req, res) { upload(req, res, function (err) { @@ -258,3 +261,13 @@ app.post('/profile', function (req, res) { ## License [MIT](LICENSE) + +[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg +[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml +[test-url]: https://coveralls.io/r/expressjs/multer?branch=main +[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main +[npm-downloads-image]: https://badgen.net/npm/dm/multer +[npm-url]: https://npmjs.org/package/multer +[npm-version-image]: https://badgen.net/npm/v/multer +[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge +[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer \ No newline at end of file diff --git a/lib/make-middleware.js b/lib/make-middleware.js index a4bee4eb..dc3483b4 100644 --- a/lib/make-middleware.js +++ b/lib/make-middleware.js @@ -1,7 +1,6 @@ var is = require('type-is') var Busboy = require('busboy') var extend = require('xtend') -var onFinished = require('on-finished') var appendField = require('append-field') var Counter = require('./counter') @@ -10,7 +9,9 @@ var FileAppender = require('./file-appender') var removeUploadedFiles = require('./remove-uploaded-files') function drainStream (stream) { - stream.on('readable', stream.read.bind(stream)) + stream.on('readable', () => { + while (stream.read() !== null) {} + }) } function makeMiddleware (setup) { @@ -27,10 +28,14 @@ function makeMiddleware (setup) { req.body = Object.create(null) + req.on('error', function (err) { + abortWithError(err) + }) + var busboy try { - busboy = new Busboy({ headers: req.headers, limits: limits, preservePath: preservePath }) + busboy = Busboy({ headers: req.headers, limits: limits, preservePath: preservePath }) } catch (err) { return next(err) } @@ -45,12 +50,13 @@ function makeMiddleware (setup) { function done (err) { if (isDone) return isDone = true - req.unpipe(busboy) drainStream(req) - busboy.removeAllListeners() - - onFinished(req, function () { next(err) }) + req.resume() + setImmediate(() => { + busboy.removeAllListeners() + }) + next(err) } function indicateDone () { @@ -80,12 +86,13 @@ function makeMiddleware (setup) { } // handle text field data - busboy.on('field', function (fieldname, value, fieldnameTruncated, valueTruncated) { - if (fieldnameTruncated) return abortWithCode('LIMIT_FIELD_KEY') + busboy.on('field', function (fieldname, value, { nameTruncated, valueTruncated }) { + if (fieldname == null) return abortWithCode('MISSING_FIELD_NAME') + if (nameTruncated) return abortWithCode('LIMIT_FIELD_KEY') if (valueTruncated) return abortWithCode('LIMIT_FIELD_VALUE', fieldname) // Work around bug in Busboy (https://github.com/mscdex/busboy/issues/6) - if (limits && limits.hasOwnProperty('fieldNameSize')) { + if (limits && Object.prototype.hasOwnProperty.call(limits, 'fieldNameSize')) { if (fieldname.length > limits.fieldNameSize) return abortWithCode('LIMIT_FIELD_KEY') } @@ -93,14 +100,16 @@ function makeMiddleware (setup) { }) // handle files - busboy.on('file', function (fieldname, fileStream, filename, encoding, mimetype) { + busboy.on('file', function (fieldname, fileStream, { filename, encoding, mimeType }) { + if (fieldname == null) return abortWithCode('MISSING_FIELD_NAME') + // filename is not required (https://tools.ietf.org/html/rfc1867) but if // filename not present busboy only treats as file if content type is // application/octet-stream if (!filename) filename = 'undefined' // Work around bug in Busboy (https://github.com/mscdex/busboy/issues/6) - if (limits && limits.hasOwnProperty('fieldNameSize')) { + if (limits && Object.prototype.hasOwnProperty.call(limits, 'fieldNameSize')) { if (fieldname.length > limits.fieldNameSize) return abortWithCode('LIMIT_FIELD_KEY') } @@ -108,7 +117,7 @@ function makeMiddleware (setup) { fieldname: fieldname, originalname: filename, encoding: encoding, - mimetype: mimetype + mimetype: mimeType } var placeholder = appender.insertPlaceholder(file) @@ -170,7 +179,7 @@ function makeMiddleware (setup) { busboy.on('partsLimit', function () { abortWithCode('LIMIT_PART_COUNT') }) busboy.on('filesLimit', function () { abortWithCode('LIMIT_FILE_COUNT') }) busboy.on('fieldsLimit', function () { abortWithCode('LIMIT_FIELD_COUNT') }) - busboy.on('finish', function () { + busboy.on('close', function () { readFinished = true indicateDone() }) diff --git a/lib/multer-error.js b/lib/multer-error.js index f67c637a..d56b00e8 100644 --- a/lib/multer-error.js +++ b/lib/multer-error.js @@ -1,13 +1,14 @@ var util = require('util') var errorMessages = { - 'LIMIT_PART_COUNT': 'Too many parts', - 'LIMIT_FILE_SIZE': 'File too large', - 'LIMIT_FILE_COUNT': 'Too many files', - 'LIMIT_FIELD_KEY': 'Field name too long', - 'LIMIT_FIELD_VALUE': 'Field value too long', - 'LIMIT_FIELD_COUNT': 'Too many fields', - 'LIMIT_UNEXPECTED_FILE': 'Unexpected field' + LIMIT_PART_COUNT: 'Too many parts', + LIMIT_FILE_SIZE: 'File too large', + LIMIT_FILE_COUNT: 'Too many files', + LIMIT_FIELD_KEY: 'Field name too long', + LIMIT_FIELD_VALUE: 'Field value too long', + LIMIT_FIELD_COUNT: 'Too many fields', + LIMIT_UNEXPECTED_FILE: 'Unexpected field', + MISSING_FIELD_NAME: 'Field name missing' } function MulterError (code, field) { diff --git a/package.json b/package.json index 920ab10e..a5d3ac73 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "multer", "description": "Middleware for handling `multipart/form-data`.", - "version": "1.4.1", + "version": "2.0.1", "contributors": [ "Hage Yaapa (http://www.hacksparrow.com)", "Jaret Pfluger ", @@ -20,25 +20,26 @@ ], "dependencies": { "append-field": "^1.0.0", - "busboy": "^0.2.11", - "concat-stream": "^1.5.2", - "mkdirp": "^0.5.1", + "busboy": "^1.6.0", + "concat-stream": "^2.0.0", + "mkdirp": "^0.5.6", "object-assign": "^4.1.1", - "on-finished": "^2.3.0", - "type-is": "^1.6.4", - "xtend": "^4.0.0" + "type-is": "^1.6.18", + "xtend": "^4.0.2" }, "devDependencies": { - "express": "^4.13.1", - "form-data": "^1.0.0-rc1", - "fs-temp": "^1.1.2", - "mocha": "^3.5.3", + "deep-equal": "^2.0.3", + "express": "^4.21.2", + "form-data": "^4.0.2", + "fs-temp": "^1.2.1", + "mocha": "^11.5.0", + "nyc": "^15.1.0", "rimraf": "^2.4.1", - "standard": "^11.0.1", - "testdata-w3c-json-form": "^0.2.0" + "standard": "^14.3.3", + "testdata-w3c-json-form": "^1.0.0" }, "engines": { - "node": ">= 0.10.0" + "node": ">= 10.16.0" }, "files": [ "LICENSE", @@ -47,6 +48,10 @@ "lib/" ], "scripts": { - "test": "standard && mocha" + "lint": "standard", + "lint:fix": "standard --fix", + "test": "mocha --reporter spec --exit --check-leaks test/", + "test-ci": "nyc --reporter=lcov --reporter=text npm test", + "test-cov": "nyc --reporter=html --reporter=text npm test" } } diff --git a/storage/disk.js b/storage/disk.js index dfbe8893..2f77c9f1 100644 --- a/storage/disk.js +++ b/storage/disk.js @@ -5,7 +5,7 @@ var crypto = require('crypto') var mkdirp = require('mkdirp') function getFilename (req, file, cb) { - crypto.pseudoRandomBytes(16, function (err, raw) { + crypto.randomBytes(16, function (err, raw) { cb(err, err ? undefined : raw.toString('hex')) }) } diff --git a/test/_util.js b/test/_util.js index e62bdafc..a6782ad8 100644 --- a/test/_util.js +++ b/test/_util.js @@ -1,7 +1,6 @@ var fs = require('fs') var path = require('path') var stream = require('stream') -var onFinished = require('on-finished') exports.file = function file (name) { return fs.createReadStream(path.join(__dirname, 'files', name)) @@ -17,11 +16,6 @@ exports.submitForm = function submitForm (multer, form, cb) { var req = new stream.PassThrough() - req.complete = false - form.once('end', function () { - req.complete = true - }) - form.pipe(req) req.headers = { 'content-type': 'multipart/form-data; boundary=' + form.getBoundary(), @@ -29,7 +23,7 @@ exports.submitForm = function submitForm (multer, form, cb) { } multer(req, null, function (err) { - onFinished(req, function () { cb(err, req) }) + cb(err, req) }) }) } diff --git a/test/disk-storage.js b/test/disk-storage.js index 7e25a82a..bc923ab5 100644 --- a/test/disk-storage.js +++ b/test/disk-storage.js @@ -1,6 +1,7 @@ /* eslint-env mocha */ var assert = require('assert') +var deepEqual = require('deep-equal') var fs = require('fs') var path = require('path') @@ -37,12 +38,12 @@ describe('Disk Storage', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.body.name, 'Multer') + assert.strictEqual(req.body.name, 'Multer') - assert.equal(req.file.fieldname, 'small0') - assert.equal(req.file.originalname, 'small0.dat') - assert.equal(req.file.size, 1778) - assert.equal(util.fileSize(req.file.path), 1778) + assert.strictEqual(req.file.fieldname, 'small0') + assert.strictEqual(req.file.originalname, 'small0.dat') + assert.strictEqual(req.file.size, 1778) + assert.strictEqual(util.fileSize(req.file.path), 1778) done() }) @@ -66,18 +67,18 @@ describe('Disk Storage', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.body.name, 'Multer') - assert.equal(req.body.version, '') - assert.equal(req.body.year, '') + assert.strictEqual(req.body.name, 'Multer') + assert.strictEqual(req.body.version, '') + assert.strictEqual(req.body.year, '') - assert.deepEqual(req.body.checkboxfull, [ 'cb1', 'cb2' ]) - assert.deepEqual(req.body.checkboxhalfempty, [ 'cb1', '' ]) - assert.deepEqual(req.body.checkboxempty, [ '', '' ]) + assert(deepEqual(req.body.checkboxfull, ['cb1', 'cb2'])) + assert(deepEqual(req.body.checkboxhalfempty, ['cb1', ''])) + assert(deepEqual(req.body.checkboxempty, ['', ''])) - assert.equal(req.file.fieldname, 'empty') - assert.equal(req.file.originalname, 'empty.dat') - assert.equal(req.file.size, 0) - assert.equal(util.fileSize(req.file.path), 0) + assert.strictEqual(req.file.fieldname, 'empty') + assert.strictEqual(req.file.originalname, 'empty.dat') + assert.strictEqual(req.file.size, 0) + assert.strictEqual(util.fileSize(req.file.path), 0) done() }) @@ -106,42 +107,42 @@ describe('Disk Storage', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.deepEqual(req.body, {}) + assert(deepEqual(req.body, {})) - assert.equal(req.files['empty'][0].fieldname, 'empty') - assert.equal(req.files['empty'][0].originalname, 'empty.dat') - assert.equal(req.files['empty'][0].size, 0) - assert.equal(util.fileSize(req.files['empty'][0].path), 0) + assert.strictEqual(req.files.empty[0].fieldname, 'empty') + assert.strictEqual(req.files.empty[0].originalname, 'empty.dat') + assert.strictEqual(req.files.empty[0].size, 0) + assert.strictEqual(util.fileSize(req.files.empty[0].path), 0) - assert.equal(req.files['tiny0'][0].fieldname, 'tiny0') - assert.equal(req.files['tiny0'][0].originalname, 'tiny0.dat') - assert.equal(req.files['tiny0'][0].size, 122) - assert.equal(util.fileSize(req.files['tiny0'][0].path), 122) + assert.strictEqual(req.files.tiny0[0].fieldname, 'tiny0') + assert.strictEqual(req.files.tiny0[0].originalname, 'tiny0.dat') + assert.strictEqual(req.files.tiny0[0].size, 122) + assert.strictEqual(util.fileSize(req.files.tiny0[0].path), 122) - assert.equal(req.files['tiny1'][0].fieldname, 'tiny1') - assert.equal(req.files['tiny1'][0].originalname, 'tiny1.dat') - assert.equal(req.files['tiny1'][0].size, 7) - assert.equal(util.fileSize(req.files['tiny1'][0].path), 7) + assert.strictEqual(req.files.tiny1[0].fieldname, 'tiny1') + assert.strictEqual(req.files.tiny1[0].originalname, 'tiny1.dat') + assert.strictEqual(req.files.tiny1[0].size, 7) + assert.strictEqual(util.fileSize(req.files.tiny1[0].path), 7) - assert.equal(req.files['small0'][0].fieldname, 'small0') - assert.equal(req.files['small0'][0].originalname, 'small0.dat') - assert.equal(req.files['small0'][0].size, 1778) - assert.equal(util.fileSize(req.files['small0'][0].path), 1778) + assert.strictEqual(req.files.small0[0].fieldname, 'small0') + assert.strictEqual(req.files.small0[0].originalname, 'small0.dat') + assert.strictEqual(req.files.small0[0].size, 1778) + assert.strictEqual(util.fileSize(req.files.small0[0].path), 1778) - assert.equal(req.files['small1'][0].fieldname, 'small1') - assert.equal(req.files['small1'][0].originalname, 'small1.dat') - assert.equal(req.files['small1'][0].size, 315) - assert.equal(util.fileSize(req.files['small1'][0].path), 315) + assert.strictEqual(req.files.small1[0].fieldname, 'small1') + assert.strictEqual(req.files.small1[0].originalname, 'small1.dat') + assert.strictEqual(req.files.small1[0].size, 315) + assert.strictEqual(util.fileSize(req.files.small1[0].path), 315) - assert.equal(req.files['medium'][0].fieldname, 'medium') - assert.equal(req.files['medium'][0].originalname, 'medium.dat') - assert.equal(req.files['medium'][0].size, 13196) - assert.equal(util.fileSize(req.files['medium'][0].path), 13196) + assert.strictEqual(req.files.medium[0].fieldname, 'medium') + assert.strictEqual(req.files.medium[0].originalname, 'medium.dat') + assert.strictEqual(req.files.medium[0].size, 13196) + assert.strictEqual(util.fileSize(req.files.medium[0].path), 13196) - assert.equal(req.files['large'][0].fieldname, 'large') - assert.equal(req.files['large'][0].originalname, 'large.jpg') - assert.equal(req.files['large'][0].size, 2413677) - assert.equal(util.fileSize(req.files['large'][0].path), 2413677) + assert.strictEqual(req.files.large[0].fieldname, 'large') + assert.strictEqual(req.files.large[0].originalname, 'large.jpg') + assert.strictEqual(req.files.large[0].size, 2413677) + assert.strictEqual(util.fileSize(req.files.large[0].path), 2413677) done() }) @@ -155,12 +156,12 @@ describe('Disk Storage', function () { form.append('small0', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'small0') - assert.deepEqual(err.storageErrors, []) + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'small0') + assert(deepEqual(err.storageErrors, [])) var files = fs.readdirSync(uploadDir) - assert.deepEqual(files, []) + assert(deepEqual(files, [])) done() }) @@ -178,8 +179,8 @@ describe('Disk Storage', function () { form.append('tiny0', util.file('tiny0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'ENOENT') - assert.equal(path.dirname(err.path), directory) + assert.strictEqual(err.code, 'ENOENT') + assert.strictEqual(path.dirname(err.path), directory) done() }) diff --git a/test/error-handling.js b/test/error-handling.js index a0a2a0d9..c2b1f973 100644 --- a/test/error-handling.js +++ b/test/error-handling.js @@ -17,7 +17,7 @@ describe('Error Handling', function () { it('should be an instance of both `Error` and `MulterError` classes in case of the Multer\'s error', function (done) { var form = new FormData() var storage = multer.diskStorage({ destination: os.tmpdir() }) - var upload = multer({storage: storage}).fields([ + var upload = multer({ storage: storage }).fields([ { name: 'small0', maxCount: 1 } ]) @@ -25,8 +25,8 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(upload, form, function (err, req) { - assert.equal(err instanceof Error, true) - assert.equal(err instanceof multer.MulterError, true) + assert.strictEqual(err instanceof Error, true) + assert.strictEqual(err instanceof multer.MulterError, true) done() }) }) @@ -41,7 +41,7 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_PART_COUNT') + assert.strictEqual(err.code, 'LIMIT_PART_COUNT') done() }) }) @@ -57,8 +57,8 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FILE_SIZE') - assert.equal(err.field, 'small0') + assert.strictEqual(err.code, 'LIMIT_FILE_SIZE') + assert.strictEqual(err.field, 'small0') done() }) }) @@ -74,7 +74,7 @@ describe('Error Handling', function () { form.append('small1', util.file('small1.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FILE_COUNT') + assert.strictEqual(err.code, 'LIMIT_FILE_COUNT') done() }) }) @@ -88,7 +88,7 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FIELD_KEY') + assert.strictEqual(err.code, 'LIMIT_FIELD_KEY') done() }) }) @@ -101,7 +101,7 @@ describe('Error Handling', function () { form.append('blowup', 'BOOM!') util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FIELD_KEY') + assert.strictEqual(err.code, 'LIMIT_FIELD_KEY') done() }) }) @@ -114,8 +114,8 @@ describe('Error Handling', function () { form.append('field1', 'This will make the parser explode') util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FIELD_VALUE') - assert.equal(err.field, 'field1') + assert.strictEqual(err.code, 'LIMIT_FIELD_VALUE') + assert.strictEqual(err.field, 'field1') done() }) }) @@ -128,7 +128,7 @@ describe('Error Handling', function () { form.append('field1', 'BOOM!') util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FIELD_COUNT') + assert.strictEqual(err.code, 'LIMIT_FIELD_COUNT') done() }) }) @@ -142,8 +142,48 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'small0') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'small0') + done() + }) + }) + + it('should notify of missing field name', function (done) { + var req = new stream.PassThrough() + var storage = multer.memoryStorage() + var upload = multer({ storage: storage }).single('tiny0') + var boundary = 'AaB03x' + var body = [ + '--' + boundary, + 'Content-Disposition: form-data', + '', + 'test content', + '--' + boundary, + '' + ].join('\r\n') + + req.headers = { + 'content-type': 'multipart/form-data; boundary=' + boundary, + 'content-length': body.length + } + + req.end(body) + + upload(req, null, function (err) { + assert.strictEqual(err.code, 'MISSING_FIELD_NAME') + done() + }) + }) + + it('should notify of missing field name', function (done) { + var form = new FormData() + var storage = multer.memoryStorage() + var parser = multer({ storage: storage }).single('small0') + + form.append('', util.file('small0.dat')) + + util.submitForm(parser, form, function (err, req) { + assert.strictEqual(err.code, 'MISSING_FIELD_NAME') done() }) }) @@ -165,13 +205,13 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'small0') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'small0') - assert.equal(err.storageErrors.length, 1) - assert.equal(err.storageErrors[0].code, 'TEST') - assert.equal(err.storageErrors[0].field, 'tiny0') - assert.equal(err.storageErrors[0].file, req.file) + assert.strictEqual(err.storageErrors.length, 1) + assert.strictEqual(err.storageErrors[0].code, 'TEST') + assert.strictEqual(err.storageErrors[0].field, 'tiny0') + assert.strictEqual(err.storageErrors[0].file, req.file) done() }) @@ -191,7 +231,7 @@ describe('Error Handling', function () { req.end(body) upload(req, null, function (err) { - assert.equal(err.message, 'Multipart: Boundary not found') + assert.strictEqual(err.message, 'Multipart: Boundary not found') done() }) }) @@ -217,7 +257,7 @@ describe('Error Handling', function () { req.end(body) upload(req, null, function (err) { - assert.equal(err.message, 'Unexpected end of multipart data') + assert.strictEqual(err.message, 'Unexpected end of form') done() }) }) @@ -233,7 +273,7 @@ describe('Error Handling', function () { form.append('small0', util.file('small0.dat')) util.submitForm(upload, form, function (err, req) { - assert.equal(err.code, 'LIMIT_FILE_SIZE') + assert.strictEqual(err.code, 'LIMIT_FILE_SIZE') done() }) }) diff --git a/test/expected-files.js b/test/expected-files.js index 46739a92..c339a1dc 100644 --- a/test/expected-files.js +++ b/test/expected-files.js @@ -21,8 +21,8 @@ describe('Expected files', function () { form.append('notme', util.file('small0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'notme') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'notme') done() }) }) @@ -35,8 +35,8 @@ describe('Expected files', function () { form.append('notme', util.file('small1.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'notme') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'notme') done() }) }) @@ -49,8 +49,8 @@ describe('Expected files', function () { form.append('butme', util.file('small1.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'butme') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'butme') done() }) }) @@ -69,8 +69,8 @@ describe('Expected files', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.files['butme'].length, 2) - assert.equal(req.files['andme'].length, 1) + assert.strictEqual(req.files.butme.length, 2) + assert.strictEqual(req.files.andme.length, 1) done() }) @@ -89,8 +89,8 @@ describe('Expected files', function () { form.append('notme', util.file('empty.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(err.field, 'notme') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(err.field, 'notme') done() }) }) @@ -105,10 +105,10 @@ describe('Expected files', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.files.length, 3) - assert.equal(req.files[0].fieldname, 'butme') - assert.equal(req.files[1].fieldname, 'butme') - assert.equal(req.files[2].fieldname, 'andme') + assert.strictEqual(req.files.length, 3) + assert.strictEqual(req.files[0].fieldname, 'butme') + assert.strictEqual(req.files[1].fieldname, 'butme') + assert.strictEqual(req.files[2].fieldname, 'andme') done() }) }) diff --git a/test/express-integration.js b/test/express-integration.js index b86429df..ff1757b4 100644 --- a/test/express-integration.js +++ b/test/express-integration.js @@ -1,6 +1,7 @@ /* eslint-env mocha */ var assert = require('assert') +var http = require('http') var multer = require('../') var util = require('./_util') @@ -8,7 +9,6 @@ var util = require('./_util') var express = require('express') var FormData = require('form-data') var concat = require('concat-stream') -var onFinished = require('on-finished') var port = 34279 @@ -27,7 +27,7 @@ describe('Express Integration', function () { req.on('response', function (res) { res.on('error', cb) res.pipe(concat({ encoding: 'buffer' }, function (body) { - onFinished(req, function () { cb(null, res, body) }) + cb(null, res, body) })) }) } @@ -49,7 +49,7 @@ describe('Express Integration', function () { }) router.use(function (err, req, res, next) { - assert.equal(err.code, 'LIMIT_FILE_SIZE') + assert.strictEqual(err.code, 'LIMIT_FILE_SIZE') errorCalled++ res.status(500).end('ERROR') @@ -59,10 +59,10 @@ describe('Express Integration', function () { submitForm(form, '/t1/profile', function (err, res, body) { assert.ifError(err) - assert.equal(routeCalled, 0) - assert.equal(errorCalled, 1) - assert.equal(body.toString(), 'ERROR') - assert.equal(res.statusCode, 500) + assert.strictEqual(routeCalled, 0) + assert.strictEqual(errorCalled, 1) + assert.strictEqual(body.toString(), 'ERROR') + assert.strictEqual(res.statusCode, 500) done() }) @@ -88,7 +88,7 @@ describe('Express Integration', function () { }) router.use(function (err, req, res, next) { - assert.equal(err.message, 'TEST') + assert.strictEqual(err.message, 'TEST') errorCalled++ res.status(500).end('ERROR') @@ -98,12 +98,102 @@ describe('Express Integration', function () { submitForm(form, '/t2/profile', function (err, res, body) { assert.ifError(err) - assert.equal(routeCalled, 0) - assert.equal(errorCalled, 1) - assert.equal(body.toString(), 'ERROR') - assert.equal(res.statusCode, 500) + assert.strictEqual(routeCalled, 0) + assert.strictEqual(errorCalled, 1) + assert.strictEqual(body.toString(), 'ERROR') + assert.strictEqual(res.statusCode, 500) done() }) }) + + it('should not crash on malformed request', function (done) { + var upload = multer() + + app.post('/upload', upload.single('file'), function (req, res) { + res.status(500).end('Request should not be processed') + }) + + app.use(function (err, req, res, next) { + assert.strictEqual(err.message, 'Unexpected end of form') + res.status(200).end('Correct error') + }) + + var boundary = 'AaB03x' + var body = [ + '--' + boundary, + 'Content-Disposition: form-data; name="file"; filename="test.txt"', + 'Content-Type: text/plain', + '', + 'test without end boundary' + ].join('\r\n') + var options = { + hostname: 'localhost', + port, + path: '/upload', + method: 'POST', + headers: { + 'content-type': 'multipart/form-data; boundary=' + boundary, + 'content-length': body.length + } + } + + var req = http.request(options, (res) => { + assert.strictEqual(res.statusCode, 200) + done() + }) + + req.on('error', (err) => { + done(err) + }) + + req.write(body) + req.end() + }) + + it('should not crash on malformed request that causes two errors to be emitted by busboy', function (done) { + var upload = multer() + + app.post('/upload2', upload.single('file'), function (req, res) { + res.status(500).end('Request should not be processed') + }) + + app.use(function (err, req, res, next) { + assert.strictEqual(err.message, 'Malformed part header') + res.status(200).end('Correct error') + }) + + var boundary = 'AaB03x' + // this payload causes two errors to be emitted by busboy: `Malformed part header` and `Unexpected end of form` + var body = [ + '--' + boundary, + 'Content-Disposition: form-data; name="file"; filename="test.txt"', + 'Content-Type: text/plain', + '', + '--' + boundary + '--', + '' + ].join('\r\n') + var options = { + hostname: 'localhost', + port, + path: '/upload2', + method: 'POST', + headers: { + 'content-type': 'multipart/form-data; boundary=' + boundary, + 'content-length': body.length + } + } + + var req = http.request(options, (res) => { + assert.strictEqual(res.statusCode, 200) + done() + }) + + req.on('error', (err) => { + done(err) + }) + + req.write(body) + req.end() + }) }) diff --git a/test/fields.js b/test/fields.js index 29ec14f1..1bdf6459 100644 --- a/test/fields.js +++ b/test/fields.js @@ -1,6 +1,7 @@ /* eslint-env mocha */ var assert = require('assert') +var deepEqual = require('deep-equal') var stream = require('stream') var util = require('./_util') @@ -24,11 +25,11 @@ describe('Fields', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.deepEqual(req.body, { + assert(deepEqual(req.body, { name: 'Multer', key: 'value', abc: 'xyz' - }) + })) done() }) }) @@ -48,14 +49,14 @@ describe('Fields', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.deepEqual(req.body, { + assert(deepEqual(req.body, { name: 'Multer', key: '', abc: '', - checkboxfull: [ 'cb1', 'cb2' ], - checkboxhalfempty: [ 'cb1', '' ], - checkboxempty: [ '', '' ] - }) + checkboxfull: ['cb1', 'cb2'], + checkboxhalfempty: ['cb1', ''], + checkboxempty: ['', ''] + })) done() }) }) @@ -72,8 +73,8 @@ describe('Fields', function () { parser(req, null, function (err) { assert.ifError(err) - assert.equal(req.hasOwnProperty('body'), false) - assert.equal(req.hasOwnProperty('files'), false) + assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'body'), false) + assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'files'), false) done() }) }) @@ -90,8 +91,8 @@ describe('Fields', function () { parser(req, null, function (err) { assert.ifError(err) - assert.equal(req.hasOwnProperty('body'), false) - assert.equal(req.hasOwnProperty('files'), false) + assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'body'), false) + assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'files'), false) done() }) }) @@ -106,7 +107,7 @@ describe('Fields', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.deepEqual(req.body, test.expected) + assert(deepEqual(req.body, test.expected)) done() }) }) @@ -121,13 +122,13 @@ describe('Fields', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.deepEqual(req.body, { + assert(deepEqual(req.body, { obj: { - '0': 'a', - '2': 'c', - 'x': 'yz' + 0: 'a', + 2: 'c', + x: 'yz' } - }) + })) done() }) }) diff --git a/test/file-filter.js b/test/file-filter.js index ff9d14ce..1d857f44 100644 --- a/test/file-filter.js +++ b/test/file-filter.js @@ -32,11 +32,11 @@ describe('File Filter', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.files['notme'], undefined) - assert.equal(req.files['butme'][0].fieldname, 'butme') - assert.equal(req.files['butme'][0].originalname, 'tiny1.dat') - assert.equal(req.files['butme'][0].size, 7) - assert.equal(req.files['butme'][0].buffer.length, 7) + assert.strictEqual(req.files.notme, undefined) + assert.strictEqual(req.files.butme[0].fieldname, 'butme') + assert.strictEqual(req.files.butme[0].originalname, 'tiny1.dat') + assert.strictEqual(req.files.butme[0].size, 7) + assert.strictEqual(req.files.butme[0].buffer.length, 7) done() }) }) @@ -49,7 +49,7 @@ describe('File Filter', function () { form.append('test', util.file('tiny0.dat')) util.submitForm(parser, form, function (err, req) { - assert.equal(err.message, 'Fake error') + assert.strictEqual(err.message, 'Fake error') done() }) }) diff --git a/test/file-ordering.js b/test/file-ordering.js index 293ae0e7..61008afa 100644 --- a/test/file-ordering.js +++ b/test/file-ordering.js @@ -39,9 +39,9 @@ describe('File ordering', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.files.length, 2) - assert.equal(req.files[0].originalname, 'small0.dat') - assert.equal(req.files[1].originalname, 'small1.dat') + assert.strictEqual(req.files.length, 2) + assert.strictEqual(req.files[0].originalname, 'small0.dat') + assert.strictEqual(req.files[1].originalname, 'small1.dat') done() }) }) diff --git a/test/functionality.js b/test/functionality.js index 513c47d6..a4db245a 100644 --- a/test/functionality.js +++ b/test/functionality.js @@ -52,7 +52,7 @@ describe('Functionality', function () { util.submitForm(parser, env.form, function (err, req) { assert.ifError(err) assert.ok(startsWith(req.file.path, env.uploadDir)) - assert.equal(util.fileSize(req.file.path), 1778) + assert.strictEqual(util.fileSize(req.file.path), 1778) done() }) }) @@ -67,7 +67,7 @@ describe('Functionality', function () { util.submitForm(parser, env.form, function (err, req) { assert.ifError(err) - assert.equal(req.file.filename, 'small0small0.dat') + assert.strictEqual(req.file.filename, 'small0small0.dat') done() }) }) @@ -82,7 +82,7 @@ describe('Functionality', function () { util.submitForm(parser, env.form, function (err, req) { assert.ifError(err) - assert.equal(req.file.filename, 'tiny0tiny0.dat') + assert.strictEqual(req.file.filename, 'tiny0tiny0.dat') done() }) }) @@ -98,9 +98,9 @@ describe('Functionality', function () { util.submitForm(parser, env.form, function (err, req) { assert.ifError(err) - assert.equal(req.files.length, 2) - assert.equal(req.files[0].filename, 'themFilessmall0.dat') - assert.equal(req.files[1].filename, 'themFilessmall1.dat') + assert.strictEqual(req.files.length, 2) + assert.strictEqual(req.files[0].filename, 'themFilessmall0.dat') + assert.strictEqual(req.files[1].filename, 'themFilessmall1.dat') done() }) }) @@ -128,7 +128,7 @@ describe('Functionality', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.files.length, 2) + assert.strictEqual(req.files.length, 2) assert.ok(req.files[0].path.indexOf('/testforme-') >= 0) assert.ok(req.files[1].path.indexOf('/testforme-') >= 0) done() diff --git a/test/issue-232.js b/test/issue-232.js index 4ce0f107..aeddcb95 100644 --- a/test/issue-232.js +++ b/test/issue-232.js @@ -34,8 +34,8 @@ describe('Issue #232', function () { util.submitForm(parser, form, function (err, req) { assert.ok(err, 'an error was given') - assert.equal(err.code, 'LIMIT_FILE_SIZE') - assert.equal(err.field, 'file') + assert.strictEqual(err.code, 'LIMIT_FILE_SIZE') + assert.strictEqual(err.field, 'file') done() }) diff --git a/test/memory-storage.js b/test/memory-storage.js index 5ff79d96..cbc3e2e5 100644 --- a/test/memory-storage.js +++ b/test/memory-storage.js @@ -1,6 +1,7 @@ /* eslint-env mocha */ var assert = require('assert') +var deepEqual = require('deep-equal') var util = require('./_util') var multer = require('../') @@ -24,12 +25,12 @@ describe('Memory Storage', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.body.name, 'Multer') + assert.strictEqual(req.body.name, 'Multer') - assert.equal(req.file.fieldname, 'small0') - assert.equal(req.file.originalname, 'small0.dat') - assert.equal(req.file.size, 1778) - assert.equal(req.file.buffer.length, 1778) + assert.strictEqual(req.file.fieldname, 'small0') + assert.strictEqual(req.file.originalname, 'small0.dat') + assert.strictEqual(req.file.size, 1778) + assert.strictEqual(req.file.buffer.length, 1778) done() }) @@ -53,19 +54,19 @@ describe('Memory Storage', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.body.name, 'Multer') - assert.equal(req.body.version, '') - assert.equal(req.body.year, '') + assert.strictEqual(req.body.name, 'Multer') + assert.strictEqual(req.body.version, '') + assert.strictEqual(req.body.year, '') - assert.deepEqual(req.body.checkboxfull, [ 'cb1', 'cb2' ]) - assert.deepEqual(req.body.checkboxhalfempty, [ 'cb1', '' ]) - assert.deepEqual(req.body.checkboxempty, [ '', '' ]) + assert(deepEqual(req.body.checkboxfull, ['cb1', 'cb2'])) + assert(deepEqual(req.body.checkboxhalfempty, ['cb1', ''])) + assert(deepEqual(req.body.checkboxempty, ['', ''])) - assert.equal(req.file.fieldname, 'empty') - assert.equal(req.file.originalname, 'empty.dat') - assert.equal(req.file.size, 0) - assert.equal(req.file.buffer.length, 0) - assert.equal(Buffer.isBuffer(req.file.buffer), true) + assert.strictEqual(req.file.fieldname, 'empty') + assert.strictEqual(req.file.originalname, 'empty.dat') + assert.strictEqual(req.file.size, 0) + assert.strictEqual(req.file.buffer.length, 0) + assert.strictEqual(Buffer.isBuffer(req.file.buffer), true) done() }) @@ -94,42 +95,42 @@ describe('Memory Storage', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.deepEqual(req.body, {}) - - assert.equal(req.files['empty'][0].fieldname, 'empty') - assert.equal(req.files['empty'][0].originalname, 'empty.dat') - assert.equal(req.files['empty'][0].size, 0) - assert.equal(req.files['empty'][0].buffer.length, 0) - - assert.equal(req.files['tiny0'][0].fieldname, 'tiny0') - assert.equal(req.files['tiny0'][0].originalname, 'tiny0.dat') - assert.equal(req.files['tiny0'][0].size, 122) - assert.equal(req.files['tiny0'][0].buffer.length, 122) - - assert.equal(req.files['tiny1'][0].fieldname, 'tiny1') - assert.equal(req.files['tiny1'][0].originalname, 'tiny1.dat') - assert.equal(req.files['tiny1'][0].size, 7) - assert.equal(req.files['tiny1'][0].buffer.length, 7) - - assert.equal(req.files['small0'][0].fieldname, 'small0') - assert.equal(req.files['small0'][0].originalname, 'small0.dat') - assert.equal(req.files['small0'][0].size, 1778) - assert.equal(req.files['small0'][0].buffer.length, 1778) - - assert.equal(req.files['small1'][0].fieldname, 'small1') - assert.equal(req.files['small1'][0].originalname, 'small1.dat') - assert.equal(req.files['small1'][0].size, 315) - assert.equal(req.files['small1'][0].buffer.length, 315) - - assert.equal(req.files['medium'][0].fieldname, 'medium') - assert.equal(req.files['medium'][0].originalname, 'medium.dat') - assert.equal(req.files['medium'][0].size, 13196) - assert.equal(req.files['medium'][0].buffer.length, 13196) - - assert.equal(req.files['large'][0].fieldname, 'large') - assert.equal(req.files['large'][0].originalname, 'large.jpg') - assert.equal(req.files['large'][0].size, 2413677) - assert.equal(req.files['large'][0].buffer.length, 2413677) + assert(deepEqual(req.body, {})) + + assert.strictEqual(req.files.empty[0].fieldname, 'empty') + assert.strictEqual(req.files.empty[0].originalname, 'empty.dat') + assert.strictEqual(req.files.empty[0].size, 0) + assert.strictEqual(req.files.empty[0].buffer.length, 0) + + assert.strictEqual(req.files.tiny0[0].fieldname, 'tiny0') + assert.strictEqual(req.files.tiny0[0].originalname, 'tiny0.dat') + assert.strictEqual(req.files.tiny0[0].size, 122) + assert.strictEqual(req.files.tiny0[0].buffer.length, 122) + + assert.strictEqual(req.files.tiny1[0].fieldname, 'tiny1') + assert.strictEqual(req.files.tiny1[0].originalname, 'tiny1.dat') + assert.strictEqual(req.files.tiny1[0].size, 7) + assert.strictEqual(req.files.tiny1[0].buffer.length, 7) + + assert.strictEqual(req.files.small0[0].fieldname, 'small0') + assert.strictEqual(req.files.small0[0].originalname, 'small0.dat') + assert.strictEqual(req.files.small0[0].size, 1778) + assert.strictEqual(req.files.small0[0].buffer.length, 1778) + + assert.strictEqual(req.files.small1[0].fieldname, 'small1') + assert.strictEqual(req.files.small1[0].originalname, 'small1.dat') + assert.strictEqual(req.files.small1[0].size, 315) + assert.strictEqual(req.files.small1[0].buffer.length, 315) + + assert.strictEqual(req.files.medium[0].fieldname, 'medium') + assert.strictEqual(req.files.medium[0].originalname, 'medium.dat') + assert.strictEqual(req.files.medium[0].size, 13196) + assert.strictEqual(req.files.medium[0].buffer.length, 13196) + + assert.strictEqual(req.files.large[0].fieldname, 'large') + assert.strictEqual(req.files.large[0].originalname, 'large.jpg') + assert.strictEqual(req.files.large[0].size, 2413677) + assert.strictEqual(req.files.large[0].buffer.length, 2413677) done() }) diff --git a/test/none.js b/test/none.js index c31b82b2..b8e2945b 100644 --- a/test/none.js +++ b/test/none.js @@ -22,10 +22,10 @@ describe('None', function () { util.submitForm(parser, form, function (err, req) { assert.ok(err) - assert.equal(err.code, 'LIMIT_UNEXPECTED_FILE') - assert.equal(req.files, undefined) - assert.equal(req.body['key1'], 'val1') - assert.equal(req.body['key2'], 'val2') + assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE') + assert.strictEqual(req.files, undefined) + assert.strictEqual(req.body.key1, 'val1') + assert.strictEqual(req.body.key2, 'val2') done() }) }) @@ -38,9 +38,9 @@ describe('None', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.files, undefined) - assert.equal(req.body['key1'], 'val1') - assert.equal(req.body['key2'], 'val2') + assert.strictEqual(req.files, undefined) + assert.strictEqual(req.body.key1, 'val1') + assert.strictEqual(req.body.key2, 'val2') done() }) }) diff --git a/test/reuse-middleware.js b/test/reuse-middleware.js index 75bfc347..ab287041 100644 --- a/test/reuse-middleware.js +++ b/test/reuse-middleware.js @@ -30,15 +30,15 @@ describe('Reuse Middleware', function () { util.submitForm(parser, form, function (err, req) { assert.ifError(err) - assert.equal(req.body.name, 'Multer') - assert.equal(req.body.files, '' + fileCount) - assert.equal(req.files.length, fileCount) + assert.strictEqual(req.body.name, 'Multer') + assert.strictEqual(req.body.files, '' + fileCount) + assert.strictEqual(req.files.length, fileCount) req.files.forEach(function (file) { - assert.equal(file.fieldname, 'them-files') - assert.equal(file.originalname, 'small0.dat') - assert.equal(file.size, 1778) - assert.equal(file.buffer.length, 1778) + assert.strictEqual(file.fieldname, 'them-files') + assert.strictEqual(file.originalname, 'small0.dat') + assert.strictEqual(file.size, 1778) + assert.strictEqual(file.buffer.length, 1778) }) if (--pending === 0) done() diff --git a/test/select-field.js b/test/select-field.js index 5ed0aed1..a3a3eea0 100644 --- a/test/select-field.js +++ b/test/select-field.js @@ -23,11 +23,11 @@ function generateForm () { function assertSet (files, setName, fileNames) { var len = fileNames.length - assert.equal(files.length, len) + assert.strictEqual(files.length, len) for (var i = 0; i < len; i++) { - assert.equal(files[i].fieldname, setName) - assert.equal(files[i].originalname, fileNames[i]) + assert.strictEqual(files[i].fieldname, setName) + assert.strictEqual(files[i].originalname, fileNames[i]) } } @@ -49,16 +49,16 @@ describe('Select Field', function () { var file file = req.files['CA$|-|'][0] - assert.equal(file.fieldname, 'CA$|-|') - assert.equal(file.originalname, 'empty.dat') + assert.strictEqual(file.fieldname, 'CA$|-|') + assert.strictEqual(file.originalname, 'empty.dat') file = req.files['set-1'][0] - assert.equal(file.fieldname, 'set-1') - assert.equal(file.originalname, 'tiny0.dat') + assert.strictEqual(file.fieldname, 'set-1') + assert.strictEqual(file.originalname, 'tiny0.dat') file = req.files['set-2'][0] - assert.equal(file.fieldname, 'set-2') - assert.equal(file.originalname, 'tiny1.dat') + assert.strictEqual(file.fieldname, 'set-2') + assert.strictEqual(file.originalname, 'tiny1.dat') done() }) @@ -68,9 +68,9 @@ describe('Select Field', function () { util.submitForm(parser, generateForm(), function (err, req) { assert.ifError(err) - assertSet(req.files['CA$|-|'], 'CA$|-|', [ 'empty.dat' ]) - assertSet(req.files['set-1'], 'set-1', [ 'tiny0.dat', 'empty.dat', 'tiny1.dat' ]) - assertSet(req.files['set-2'], 'set-2', [ 'tiny1.dat', 'tiny0.dat', 'empty.dat' ]) + assertSet(req.files['CA$|-|'], 'CA$|-|', ['empty.dat']) + assertSet(req.files['set-1'], 'set-1', ['tiny0.dat', 'empty.dat', 'tiny1.dat']) + assertSet(req.files['set-2'], 'set-2', ['tiny1.dat', 'tiny0.dat', 'empty.dat']) done() }) diff --git a/test/unicode.js b/test/unicode.js index 85aca4c4..851b0ebc 100644 --- a/test/unicode.js +++ b/test/unicode.js @@ -2,12 +2,10 @@ var assert = require('assert') -var path = require('path') -var util = require('./_util') var multer = require('../') var temp = require('fs-temp') var rimraf = require('rimraf') -var FormData = require('form-data') +var stream = require('stream') describe('Unicode', function () { var uploadDir, upload @@ -34,21 +32,29 @@ describe('Unicode', function () { }) it('should handle unicode filenames', function (done) { - var form = new FormData() - var parser = upload.single('small0') - var filename = '\ud83d\udca9.dat' - - form.append('small0', util.file('small0.dat'), { filename: filename }) - - util.submitForm(parser, form, function (err, req) { + var req = new stream.PassThrough() + var boundary = 'AaB03x' + var body = [ + '--' + boundary, + 'Content-Disposition: form-data; name="small0"; filename="poo.dat"; filename*=utf-8\'\'%F0%9F%92%A9.dat', + 'Content-Type: text/plain', + '', + 'test with unicode filename', + '--' + boundary + '--' + ].join('\r\n') + + req.headers = { + 'content-type': 'multipart/form-data; boundary=' + boundary, + 'content-length': body.length + } + + req.end(body) + + upload.single('small0')(req, null, function (err) { assert.ifError(err) - assert.equal(path.basename(req.file.path), filename) - assert.equal(req.file.originalname, filename) - - assert.equal(req.file.fieldname, 'small0') - assert.equal(req.file.size, 1778) - assert.equal(util.fileSize(req.file.path), 1778) + assert.strictEqual(req.file.originalname, '\ud83d\udca9.dat') + assert.strictEqual(req.file.fieldname, 'small0') done() })