hash.py 3.68 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

###############################################################################
#                                                                             #
# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.backend.python module of the BEAT platform.   #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform is distributed in the hope that it will be useful, but    #
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################


"""Various functions for hashing platform contributions and others"""


import hashlib
Philip ABBET's avatar
Philip ABBET committed
33 34 35 36
import simplejson
import collections
import copy
import six
37 38


Philip ABBET's avatar
Philip ABBET committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
def _sha256(s):
  """A python2/3 replacement for :py:func:`haslib.sha256`"""

  try:
    if isinstance(s, str): s = six.u(s)
    return hashlib.sha256(s.encode('utf8')).hexdigest()
  except:
    return hashlib.sha256(s).hexdigest()



def _stringify(dictionary):
  names = sorted(dictionary.keys())

  converted_dictionary = '{'
  for name in names:
    converted_dictionary += '"%s":%s,' % (name, str(dictionary[name]))

  if len(converted_dictionary) > 1:
    converted_dictionary = converted_dictionary[:-1]

  converted_dictionary += '}'

  return converted_dictionary



def hash(dictionary_or_string):
  if isinstance(dictionary_or_string, dict):
    return _sha256(_stringify(dictionary_or_string))
  else:
    return _sha256(dictionary_or_string)



def hashJSON(contents, description):
  """Hashes the pre-loaded JSON object using :py:func:`hashlib.sha256`

  Excludes description changes
  """

  if description in contents:
    contents = copy.deepcopy(contents) #temporary copy
    del contents[description]
  contents = simplejson.dumps(contents, sort_keys=True)
  return hashlib.sha256(contents).hexdigest()



def hashJSONFile(path, description):
  """Hashes the JSON file contents using :py:func:`hashlib.sha256`

  Excludes description changes
  """

  try:
    with open(path, 'rb') as f:
      return hashJSON(simplejson.load(f,
        object_pairs_hook=collections.OrderedDict), description) #preserve order
  except simplejson.JSONDecodeError:
    # falls back to normal file content hashing
    return hashFileContents(path)



104 105 106 107 108
def hashFileContents(path):
  """Hashes the file contents using :py:func:`hashlib.sha256`."""

  with open(path, 'rb') as f:
    return hashlib.sha256(f.read()).hexdigest()