python/hashes.cc: Introduce the Hashes class.

The Hashes class is a function which calculates all supported hashes for
one input. DebImg will use this for calculating the hashes of files.

6 files changed, 164 insertions, 8 deletions

diff --git a/debian/changelog b/debian/changelog
index 8bc3e320..1f43cc8c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -30,6 +30,7 @@ python-apt (0.7.92) UNRELEASED; urgency=low
       + Closes: #468123 - there is no need anymore for binding CompType or
         CompTypeDeb, because we don't return integer values for CompType
         anymore.
+  * Introduce apt_pkg.Hashes class.
 
   [ Sebastian Heinlein ]
   * apt/progress.py: Extract the package name from the status message
@@ -45,7 +46,7 @@ python-apt (0.7.92) UNRELEASED; urgency=low
   * python/progress.cc:
     - low level code for update_status_full and pulse_items()
 
- -- Julian Andres Klode <jak@debian.org>  Tue, 07 Jul 2009 16:56:44 +0200
+ -- Julian Andres Klode <jak@debian.org>  Sun, 12 Jul 2009 18:51:57 +0200
 
 python-apt (0.7.91) experimental; urgency=low
 
diff --git a/doc/source/apt_pkg.rst b/doc/source/apt_pkg.rst
index 2af934a0..9a14266e 100644
--- a/doc/source/apt_pkg.rst
+++ b/doc/source/apt_pkg.rst
@@ -1139,15 +1139,31 @@ installation.
     the file using the parameter *destfile*. You can not combine both.
 
 
+Hashes 
+------
+The apt_pkg module also provides several hash functions. If you develop
+applications with python-apt it is often easier to use these functions instead
+of the ones provides in Python's :mod:`hashlib` module.
 
+.. class:: Hashes(object)
 
+    Calculate all supported hashes of the object. *object* may either be a
+    string, in which cases the hashes of the string are calculated, or a
+    :class:`file()` object or file descriptor, in which case the hashes of
+    its contents is calculated. The calculated hashes are then available via
+    attributes:
 
+    .. attribute:: md5
 
-Hash functions
---------------
-The apt_pkg module also provides several hash functions. If you develop
-applications with python-apt it is often easier to use these functions instead
-of the ones provides in Python's :mod:`hashlib` module.
+        The MD5 hash of the data, as string.
+
+    .. attribute:: sha1
+
+        The SHA1 hash of the data, as string.
+
+    .. attribute:: sha256
+
+        The SHA256 hash of the data, as string.
 
 .. function:: md5sum(object)
 
diff --git a/python/apt_pkgmodule.cc b/python/apt_pkgmodule.cc
index 3f4aae37..4c0fd5ed 100644
--- a/python/apt_pkgmodule.cc
+++ b/python/apt_pkgmodule.cc
@@ -618,6 +618,7 @@ extern "C" void initapt_pkg()
    ADDTYPE(Module,"IndexRecords",&PyIndexRecords_Type);
    ADDTYPE(Module,"HashString",&PyHashString_Type);
    ADDTYPE(Module,"Policy",&PyPolicy_Type);
+   ADDTYPE(Module,"Hashes",&PyHashes_Type);
    // Tag file constants
    PyModule_AddObject(Module,"REWRITE_PACKAGE_ORDER",
                       CharCharToList(TFRewritePackageOrder));
diff --git a/python/apt_pkgmodule.h b/python/apt_pkgmodule.h
index 21355072..1a2f1a1a 100644
--- a/python/apt_pkgmodule.h
+++ b/python/apt_pkgmodule.h
@@ -116,5 +116,6 @@ extern PyTypeObject PyIndexRecords_Type;
 
 // Policy
 extern PyTypeObject PyPolicy_Type;
+extern PyTypeObject PyHashes_Type;
 
 #endif
diff --git a/python/hashes.cc b/python/hashes.cc
new file mode 100644
index 00000000..a1ace6fc
--- /dev/null
+++ b/python/hashes.cc
@@ -0,0 +1,136 @@
+/* hashes.cc - Wrapper around apt-pkg's Hashes.
+ *
+ * Copyright 2009 Julian Andres Klode <jak@debian.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+#include <Python.h>
+#include "generic.h"
+#include "apt_pkgmodule.h"
+#include <apt-pkg/hashes.h>
+
+static PyObject *hashes_new(PyTypeObject *type,PyObject *args,
+                            PyObject *kwds)
+{
+    return CppPyObject_NEW<Hashes>(type);
+}
+
+static int hashes_init(PyObject *self, PyObject *args, PyObject *kwds)
+{
+    PyObject *object = 0;
+    int Fd;
+    char *kwlist[] = {"object",  NULL};
+
+    if (PyArg_ParseTupleAndKeywords(args, kwds, "|O:__init__", kwlist,
+                                    &object) == 0)
+        return -1;
+    if (object == 0)
+        return 0;
+    Hashes &hashes = GetCpp<Hashes>(self);
+
+    if (PyBytes_Check(object) != 0) {
+        char *s;
+        Py_ssize_t len;
+        PyBytes_AsStringAndSize(object, &s, &len);
+        hashes.Add((const unsigned char*)s, len);
+    }
+    else if ((Fd = PyObject_AsFileDescriptor(object)) != -1) {
+        struct stat St;
+        if (fstat(Fd, &St) != 0 || hashes.AddFD(Fd, St.st_size) == false) {
+            PyErr_SetFromErrno(PyExc_SystemError);
+            return -1;
+        }
+    }
+    else {
+        PyErr_SetString(PyExc_TypeError, "__init__() only understand strings"
+                                        " and files");
+        return -1;
+    }
+    return 0;
+}
+
+static PyObject *hashes_get_md5(PyObject *self, void*)
+{
+    return CppPyString(GetCpp<Hashes>(self).MD5.Result().Value());
+}
+
+static PyObject *hashes_get_sha1(PyObject *self, void*)
+{
+    return CppPyString(GetCpp<Hashes>(self).SHA1.Result().Value());
+}
+
+static PyObject *hashes_get_sha256(PyObject *self, void*)
+{
+    return CppPyString(GetCpp<Hashes>(self).SHA256.Result().Value());
+}
+
+static PyGetSetDef hashes_getset[] = {
+    {"md5",hashes_get_md5,0,"The MD5Sum of the file as a string."},
+    {"sha1",hashes_get_sha1,0,"The SHA1Sum of the file as a string."},
+    {"sha256",hashes_get_sha256,0,"The SHA256Sum of the file as a string."},
+    {}
+};
+
+static char *hashes_doc =
+    "Hashes([object: (bytes, file)])\n\n"
+    "Calculate hashes for the given object. It can be used to create all\n"
+    "supported hashes for a file.\n\n"
+    "The parameter *object* can be a bytes (3.X) / str (2.X) object, or an\n"
+    "object providing the fileno() method or an integer describing a file\n"
+    "descriptor.";
+
+PyTypeObject PyHashes_Type = {
+    PyVarObject_HEAD_INIT(&PyType_Type, 0)
+    "apt_pkg.Hashes",                  // tp_name
+    sizeof(CppPyObject<Hashes>),       // tp_basicsize
+    0,                                 // tp_itemsize
+    // Methods
+    CppDealloc<Hashes>,                // tp_dealloc
+    0,                                 // tp_print
+    0,                                 // tp_getattr
+    0,                                 // tp_setattr
+    0,                                 // tp_compare
+    0,                                 // tp_repr
+    0,                                 // tp_as_number
+    0,                                 // tp_as_sequence
+    0,                                 // tp_as_mapping
+    0,                                 // tp_hash
+    0,                                 // tp_call
+    0,                                 // tp_str
+    0,                                 // tp_getattro
+    0,                                 // tp_setattro
+    0,                                 // tp_as_buffer
+    Py_TPFLAGS_DEFAULT |               // tp_flags
+    Py_TPFLAGS_BASETYPE,
+    hashes_doc,                        // tp_doc
+    0,                                 // tp_traverse
+    0,                                 // tp_clear
+    0,                                 // tp_richcompare
+    0,                                 // tp_weaklistoffset
+    0,                                 // tp_iter
+    0,                                 // tp_iternext
+    0,                                 // tp_methods
+    0,                                 // tp_members
+    hashes_getset,                     // tp_getset
+    0,                                 // tp_base
+    0,                                 // tp_dict
+    0,                                 // tp_descr_get
+    0,                                 // tp_descr_set
+    0,                                 // tp_dictoffset
+    hashes_init,                       // tp_init
+    0,                                 // tp_alloc
+    hashes_new,                        // tp_new
+};
diff --git a/python/makefile b/python/makefile
index 6799d749..fff3a2e8 100644
--- a/python/makefile
+++ b/python/makefile
@@ -11,8 +11,9 @@ SLIBS = -lapt-pkg
 LIB_MAKES = apt-pkg/makefile
 APT_PKG_SRC = apt_pkgmodule.cc configuration.cc generic.cc tag.cc string.cc \
               cache.cc pkgrecords.cc pkgsrcrecords.cc sourcelist.cc \
-	      depcache.cc progress.cc cdrom.cc acquire.cc pkgmanager.cc \
-	      indexfile.cc metaindex.cc hashstring.cc indexrecords.cc policy.cc
+              depcache.cc progress.cc cdrom.cc acquire.cc pkgmanager.cc \
+              indexfile.cc metaindex.cc hashstring.cc indexrecords.cc \
+              policy.cc hashes.cc
 SOURCE := $(APT_PKG_SRC)
 include $(PYTHON_H) progress.h