]> git.k1024.org Git - pylibacl.git/blob - NEWS.md
Bump version for 0.7.0 release
[pylibacl.git] / NEWS.md
1 # News
2
3 ## Version 0.7.0
4
5 *released Sun, 23 Apr 2023*
6
7 Important: Python 3.7 is the minimum supported version, due to
8 difficulty of testing old releases, and the fact that everything older
9 has been deprecated a long time ago (e.g. 3.6 at the end of 2021).
10
11 Otherwise, a minor release:
12
13 - Improve error handling in some corner cases (not expected to have
14   any real-life impact, but who knows).
15 - Improved testing coverage and test infrastructure.
16 - Modernise parts of the C code based on recent Python version
17   guidelines.
18
19 ## Version 0.6.0
20
21 *released Sun, 29 Nov 2020*
22
23 Major release removing Python 2 support. This allow both code cleanup
24 and new features, such as:
25
26 - Support for pathlib objects in `apply_to` and `has_extended`
27   functions when running with Python 3.6 and newer.
28 - Use of built-in C API functions for bytes/unicode/pathlib conversion
29   when dealing with file names, removing custom code (with the
30   associated benefits).
31
32 Important API changes/bug fixes:
33
34 - Initialisation protocol has been changed, to disallow uninitialised
35   objects; this means that `__new__` will always create valid objects,
36   to prevent the need for checking initialisation status in all code
37   paths; this also (implicitly) fixes memory leaks on re-initialisation
38   (calling `__init__(…)` on an existing object) and segfaults (!) on
39   non-initialised object attribute access. Note ACL re-initialisation is
40   tricky and (still) leads to undefined behaviour of existing Entry
41   objects pointing to it.
42 - Fix another bug in ACL re-initialisation where failures would result
43   in invalid objects; now failed re-initialisation does not touch the
44   original object.
45 - Restore `__setstate__`/`__getstate__` support on Linux; this was
46   inadvertently removed due a typo(!) when adding support for it in
47   FreeBSD. Pickle should work again for ACL instances, although not sure
48   how stable this serialisation format actually is.
49 - Additionally, slightly change `__setstate__()` input to not allow
50   Unicode, since the serialisation format is an opaque binary format.
51 - Fix (and change) entry qualifier (which is a user/group ID) behaviour:
52   assume/require that uid_t/gid_t are unsigned types (they are with
53   glibc, MacOS and FreeBSD at least; the standard doesn't document the
54   signedness), and convert parsing and returning the qualifier to behave
55   accordingly. The breakage was most apparent on 32-bit architectures,
56   in which context the problem was originally reported (see issue #13).
57
58 Minor improvements:
59
60 - Added a `data` keyword argument to `ACL()`, which allows restoring an
61   ACL directly from a serialised form (as given by `__getstate__()`),
62   which should simplify some uses cases (`a = ACL(); a.__set
63   state__(…)`).
64 - When available, add the file path to I/O error messages, which should
65   lead to easier debugging.
66 - The test suite has changed to `pytest`, which allows increased
67   coverage via parameterisation.
68
69 ## Version 0.5.4
70
71 *released Thu, 14 Nov 2019*
72
73 Maintenance release:
74
75 - Switch build system to Python 3 by default (can be overridden if
76   needed).
77 - Internal improvements for better cpychecker support.
78 - Fix compatibility with PyPy.
79 - Test improvements (both local and on Travis), testing more variations
80   (debug, PyPy).
81 - Improve test coverage, and allow gathering test coverage results.
82 - Drop support (well, drop testing) for Python lower than 2.7.
83 - Minor documentation improvements (closes #9, #12).
84
85 ## Version 0.5.3
86
87 *released Thu, 30 Apr 2015*
88
89 FreeBSD fixes:
90
91 - Enable all FreeBSD versions after 7.x at level 2 (thanks to Garrett
92   Cooper).
93 - Make test suite pass under FreeBSD, which has a stricter behaviour
94   with regards to invalid ACLs (which we do exercise in the test suite),
95   thanks again to Garret for the bug reports.
96
97 ## Version 0.5.2
98
99 *released Sat, 24 May 2014*
100
101 No visible changes release: just fix tests when running under pypy.
102
103 ## Version 0.5.1
104
105 *released Sun, 13 May 2012*
106
107 A bug-fix only release. Critical bugs (memory leaks and possible
108 segmentation faults) have been fixed thanks to Dave Malcolm and his
109 ``cpychecker`` tool. Additionally, some compatibility issues with Python
110 3.x have been fixed (str() methods returning bytes).
111
112 The documentation has been improved and changed from epydoc to sphinx;
113 note however that the documentation is still auto-generated from the
114 docstrings.
115
116 Project reorganisation: the project home page has been moved from
117 SourceForge to GitHub.
118
119 ## Version 0.5
120
121 *released Sun, 27 Dec 2009*
122
123 Added support for Python 3.x and improved support for Unicode filenames.
124
125 ## Version 0.4
126
127 *released Sat, 28 Jun 2008*
128
129 ### License
130
131
132 Starting with this version, pylibacl is licensed under LGPL 2.1,
133 Febryary 1999 or any later versions (see README.rst and COPYING).
134
135 ### Linux support
136
137 A few more Linux-specific functions:
138
139 - add the ACL.equiv_mode() method, which will return the equivalent
140   octal mode if this is a basic ACL and raise an IOError exception
141   otherwise
142
143 - add the acl_extended(...) function, which will check if an fd or path
144   has an extended ACL
145
146 ### FreeBSD support
147
148 FreeBSD 7.x will have almost all the acl manipulation functions that
149 Linux has, with the exception of __getstate__/__setstate__. As a
150 workaround, use the str() and ACL(text=...) methods to pass around
151 textual representations.
152
153 ### Interface
154
155 At module level there are now a few constants exported for easy-checking
156 at runtime what features have been compiled in:
157
158 - `HAS_ACL_FROM_MODE`, denoting whether the ACL constructor supports
159   the `mode=0xxx` parameter
160
161 - `HAS_ACL_CHECK`, denoting whether ACL instances support the
162   `check()` method
163
164 - `HAS_ACL_ENTRY`, denoting whether ACL manipulation is possible and
165   the Entry and Permset classes are available
166
167 - `HAS_EXTENEDED_CHECK`, denoting whether the `acl_extended()`
168   function is supported
169
170 - `HAS_EQUIV_MODE`, denoting whether ACL instances support the
171   `equiv_mode()` method
172
173 ### Internals
174
175 Many functions have now unittests, which is a good thing.
176
177
178 ## Version 0.3
179
180 *released Sun, 21 Oct 2007*
181
182 ### Linux support
183
184 Under Linux, implement more functions from libacl:
185
186 - add `ACL(mode=...)`, implementing `acl_from_mode`.
187 - add `ACL.to_any_text()`, implementing `acl_to_any_text`.
188 - add ACL comparison, using `acl_cmp`.
189 - add `ACL.check()`, which is a more descriptive function than
190   validate.