freeipa/ipapython/version.py.in

# Authors: Rob Crittenden <rcritten@redhat.com>
#
# Copyright (C) 2007  Red Hat
# see file 'COPYING' for use and warranty information
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
#

# The full version including strings
VERSION="__VERSION__"

# A fuller version including the vendor tag (e.g. 3.3.3-34.fc20)
VENDOR_VERSION="__VENDOR_VERSION__"


# Just the numeric portion of the version so one can do direct numeric
# comparisons to see if the API is compatible.
#
# How NUM_VERSION was generated changed over time:
# Before IPA 3.1.3, it was simply concatenated decimal numbers:
#   IPA 2.2.2:  NUM_VERSION=222
#   IPA 2.2.99: NUM_VERSION=2299 (development version)
#   IPA 3.1.0:  NUM_VERSION=310
#   IPA 3.1.3:  NUM_VERSION=313
# In IPA 3.1.4 and 3.2.0, the version was taken as an octal number due to a bug
# (https://fedorahosted.org/freeipa/ticket/3622):
#   IPA 3.1.4:  NUM_VERSION=12356 (octal 030104)
#   IPA 3.2.0:  NUM_VERSION=12416 (octal 030200)
# After IPA 3.2.0, it is decimal number where each part has two digits:
#   IPA 3.2.1:  NUM_VERSION=30201
#   IPA 3.2.99: NUM_VERSION=30299 (development version)
#   IPA 3.3.0:  NUM_VERSION=30300
NUM_VERSION=__NUM_VERSION__


# The version of the API.
API_VERSION=u'__API_VERSION__'
Add a version API to the server so it knows what version it is. 435019 2008-05-08 10:45:38 -05:00			`# Authors: Rob Crittenden <rcritten@redhat.com>`
			`#`
			`# Copyright (C) 2007 Red Hat`
			`# see file 'COPYING' for use and warranty information`
			`#`
Change FreeIPA license to GPLv3+ The changes include: * Change license blobs in source files to mention GPLv3+ not GPLv2 only * Add GPLv3+ license text * Package COPYING not LICENSE as the license blobs (even the old ones) mention COPYING specifically, it is also more common, I think https://fedorahosted.org/freeipa/ticket/239 2010-12-09 06:59:11 -06:00			`# 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 3 of the License, or`
			`# (at your option) any later version.`
Add a version API to the server so it knows what version it is. 435019 2008-05-08 10:45:38 -05:00			`#`
			`# 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`
Change FreeIPA license to GPLv3+ The changes include: * Change license blobs in source files to mention GPLv3+ not GPLv2 only * Add GPLv3+ license text * Package COPYING not LICENSE as the license blobs (even the old ones) mention COPYING specifically, it is also more common, I think https://fedorahosted.org/freeipa/ticket/239 2010-12-09 06:59:11 -06:00			`# along with this program. If not, see <http://www.gnu.org/licenses/>.`
Add a version API to the server so it knows what version it is. 435019 2008-05-08 10:45:38 -05:00			`#`

			`# The full version including strings`
			`VERSION="__VERSION__"`

ipalib.version: Add VENDOR_VERSION This will allow us to make vendors' lives easier by embedding a vendor tag to installation logs. Part of the work for: https://fedorahosted.org/freeipa/ticket/4219 Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com> 2014-03-13 08:39:03 -05:00			`# A fuller version including the vendor tag (e.g. 3.3.3-34.fc20)`
			`VENDOR_VERSION="__VENDOR_VERSION__"`

Remove leading zero from IPA_NUM_VERSION The numeric IPA_NUM_VERSION contained a leading zero, so it was treated as octal value in Python code instead of decimal. https://fedorahosted.org/freeipa/ticket/3622 2013-05-13 03:39:55 -05:00
Add a version API to the server so it knows what version it is. 435019 2008-05-08 10:45:38 -05:00			`# Just the numeric portion of the version so one can do direct numeric`
			`# comparisons to see if the API is compatible.`
Remove leading zero from IPA_NUM_VERSION The numeric IPA_NUM_VERSION contained a leading zero, so it was treated as octal value in Python code instead of decimal. https://fedorahosted.org/freeipa/ticket/3622 2013-05-13 03:39:55 -05:00			`#`
			`# How NUM_VERSION was generated changed over time:`
			`# Before IPA 3.1.3, it was simply concatenated decimal numbers:`
			`# IPA 2.2.2: NUM_VERSION=222`
			`# IPA 2.2.99: NUM_VERSION=2299 (development version)`
			`# IPA 3.1.0: NUM_VERSION=310`
			`# IPA 3.1.3: NUM_VERSION=313`
			`# In IPA 3.1.4 and 3.2.0, the version was taken as an octal number due to a bug`
			`# (https://fedorahosted.org/freeipa/ticket/3622):`
			`# IPA 3.1.4: NUM_VERSION=12356 (octal 030104)`
			`# IPA 3.2.0: NUM_VERSION=12416 (octal 030200)`
			`# After IPA 3.2.0, it is decimal number where each part has two digits:`
			`# IPA 3.2.1: NUM_VERSION=30201`
			`# IPA 3.2.99: NUM_VERSION=30299 (development version)`
			`# IPA 3.3.0: NUM_VERSION=30300`
Move version.py to the common ipa directory instead of being server-based so it can be used by the client tool. Fix the client tool imports to fail more gracefully. 2008-05-30 13:21:45 -05:00			`NUM_VERSION=__NUM_VERSION__`
Add API version and have server reject incompatible clients. This patch contains 2 parts. The first part is a small utility to create and validate the current API. To do this it needs to load ipalib which on a fresh system introduces a few problems, namely that it relies on a python plugin to set the default encoding to utf8. For our purposes we can skip that. It is also important that any optional plugins be loadable so the API can be examined. The second part is a version exchange between the client and server. The version has a major and a minor version. The major verion is updated whenever existing API changes. The minor version is updated when new API is added. A request will be rejected if either the major versions don't match or if the client major version is higher than then server major version (though by implication new API would return a command not found if allowed to proceed). To determine the API version of the server from a client use the ping command. ticket 584 2011-01-13 13:29:16 -06:00
Remove leading zero from IPA_NUM_VERSION The numeric IPA_NUM_VERSION contained a leading zero, so it was treated as octal value in Python code instead of decimal. https://fedorahosted.org/freeipa/ticket/3622 2013-05-13 03:39:55 -05:00
Add API version and have server reject incompatible clients. This patch contains 2 parts. The first part is a small utility to create and validate the current API. To do this it needs to load ipalib which on a fresh system introduces a few problems, namely that it relies on a python plugin to set the default encoding to utf8. For our purposes we can skip that. It is also important that any optional plugins be loadable so the API can be examined. The second part is a version exchange between the client and server. The version has a major and a minor version. The major verion is updated whenever existing API changes. The minor version is updated when new API is added. A request will be rejected if either the major versions don't match or if the client major version is higher than then server major version (though by implication new API would return a command not found if allowed to proceed). To determine the API version of the server from a client use the ping command. ticket 584 2011-01-13 13:29:16 -06:00			`# The version of the API.`
			`API_VERSION=u'__API_VERSION__'`