Mercurial > jwe > octave

annotate scripts/deprecated/md5sum.m @ 21122:dba88797f69f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Periodic grammarcheck of documentation.
author Rik <rik@octave.org>
date Wed, 20 Jan 2016 21:14:47 -0800
parents 2b8447888e0a
children a4faec57f4c8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20913
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
1 ## Copyright (C) 2007-2015 David Bateman
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
2 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
3 ## This file is part of Octave.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
4 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
8 ## your option) any later version.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
9 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
13 ## General Public License for more details.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
14 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
18
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
20 ## @deftypefn {} {} md5sum (@var{file})
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
21 ## @deftypefnx {} {} md5sum (@var{str}, @var{opt})
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
22 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
23 ## @code{md5sum} is deprecated and will be removed in Octave version 4.6.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
24 ## For equivalent functionality replace calls like @code{md5sum (@var{file})}
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
25 ## with:
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
26 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
27 ## @example
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
28 ## hash (\"md5\", fileread (@var{file}))
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
29 ## @end example
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
30 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
31 ## And calls like @code{md5sum (@var{str}, true)} with:
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
32 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
33 ## @example
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
34 ## hash (\"md5\", fileread (@var{str}))
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
35 ## @end example
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
36 ##
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
37 ## Calculate the MD5 sum of the file @var{file}.
20928
2b8447888e0a strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 20913
diff changeset
38 ##
20913
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
39 ## If the second parameter @var{opt} exists and is true, then calculate the MD5
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
40 ## sum of the string @var{str}.
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
41 ##
21122
dba88797f69f doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20928
diff changeset
42 ## @seealso{hash, fileread}
20913
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
43 ## @end deftypefn
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
44
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
45 function r = md5sum (str, opt)
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
46
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
47 persistent warned = false;
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
48 if (! warned)
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
49 warned = true;
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
50 warning ("Octave:deprecated-function",
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
51 "md5sum is obsolete and will be removed from a future version of Octave, please use hash instead");
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
52 endif
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
53
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
54 if (nargin == 1)
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
55 r = hash ("md5", fileread (str));
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
56 elseif ((nargin == 2) && isbool (opt) && isscalar (opt) && (opt == true))
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
57 r = hash ("md5", str);
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
58 else
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
59 print_usage ();
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
60 endif
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
61
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
62 endfunction
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
63
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
64 %!assert (md5sum ("abc\0", true), "147a664a2ca9410911e61986d3f0d52a");
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
65
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
66 %!test
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
67 %! tfile = tempname ();
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
68 %! fid = fopen (tfile, "wb");
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
69 %! fwrite (fid, "abc\0");
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
70 %! fclose (fid);
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
71 %! assert (md5sum (tfile), "147a664a2ca9410911e61986d3f0d52a");
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
72 %! unlink (tfile);
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
73
69489c064cb7 New function hash to calculate MD{2/4/5} and SHA{1,244,256,384,512} hash values.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
74 %!error md5sum ();