PHP's md5_file in JavaScript

Here’s what our current JavaScript equivalent to PHP's md5_file looks like.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
module.exports = function md5_file (str_filename) { // eslint-disable-line camelcase
// discuss at: http://locutus.io/php/md5_file/
// original by: Kevin van Zonneveld (http://kvz.io)
// input by: Brett Zamir (http://brett-zamir.me)
// bugfixed by: Kevin van Zonneveld (http://kvz.io)
// note 1: Relies on file_get_contents which does not work in the browser, so Node only.
// note 2: Keep in mind that in accordance with PHP, the whole file is buffered and then
// note 2: hashed. We'd recommend Node's native crypto modules for faster and more
// note 2: efficient hashing
// example 1: md5_file('test/never-change.txt')
// returns 1: 'bc3aa724b0ec7dce4c26e7f4d0d9b064'

var fileGetContents = require('../filesystem/file_get_contents')
var md5 = require('../strings/md5')
var buf = fileGetContents(str_filename)

if (buf === false) {
return false
}

return md5(buf)
}
[ View on GitHub | Edit on GitHub | Source on GitHub ]

How to use

You you can install via npm install locutus and require it via require('locutus/php/strings/md5_file'). You could also require the strings module in full so that you could access strings.md5_file instead.

If you intend to target the browser, you can then use a module bundler such as Browserify, webpack or rollup.js.

ES5/ES6

This function targets ES5, but as of Locutus 2.0.2 we also support ES6 functions. Locutus transpiles to ES5 before publishing to npm.

A community effort

Not unlike Wikipedia, Locutus is an ongoing community effort. Our philosophy follows The McDonald’s Theory. This means that we don't consider it to be a bad thing that many of our functions are first iterations, which may still have their fair share of issues. We hope that these flaws will inspire others to come up with better ideas.

This way of working also means that we don't offer any production guarantees, and recommend to use Locutus inspiration and learning purposes only.

Notes

  • Relies on file_get_contents which does not work in the browser, so Node only.

  • Keep in mind that in accordance with PHP, the whole file is buffered and then hashed. We’d recommend Node’s native crypto modules for faster and more efficient hashing

Examples

Please note that these examples are distilled from test cases that automatically verify our functions still work correctly. This could explain some quirky ones.

#codeexpected result
1md5_file('test/never-change.txt')'bc3aa724b0ec7dce4c26e7f4d0d9b064'

« More PHP strings functions