Package schrodinger :: Package application :: Package licensing :: Module flexlm

Module flexlm

Classes

IncompatibleLicenseError
This exception is thrown from the merge operations when incompatibilities between the old and new license prevent make merging them impossible.

LicfileError
This exception is thrown by the main code if asked to work with something that isn't an actual license file.

License
A License object represents a single FLEXlm license file.

LicenseLine
A LicenseLine object represents a single line of a FLEXlm license file.

Server
Server objects represent SERVER lines in the license file.

Vendor
Vendor objects represent VENDOR lines in the license file.

UseServer
UseServer objects represent USE_SERVER lines in the license file.

Feature
Feature objects represent FEATURE or INCREMENT lines in the license file.

Package
A Package object represents a single PACKAGE line in the license file.

Functions

[hide private]

set_logger(new_log)
Allow a client to specify our logger.

set_file_logger(new_file_log)
Allow a client to specify our file logger.

parse_line(license_line, line_num=0)
Parse a complete FLEXlm license line into it's component parts.

parse_date(date_text)
Parse a FLEXlm date string, which is in the format "dd-mmm-yyyy".

parse_expiration(exp_text)
Parse the expiration field of a FEATURE/INCREMENT line.

parse_tokens(count_text)
Parse the token-count field of a FEATURE/INCREMENT line.

parse_components(components_text)
Parse the COMPONENTS field of a PACKAGE line.

hostid_order(hostid)
Return a index that can be used to order license lines with the given hostid relative to other similar lines with different hostids.

_std_sortkey(elem)
A comparison function, used to sort license lines.

_remove_superseded_lines(elements)
Remove the superseded licenses from the given list of license lines.

_remove_replaced_lines(old_elems, new_elems)
Remove the elements from old_elems that appear in new_elems with the same issued date.

_remove_expired_lines(elements)
Remove the expired licenses from the given list of license lines.

find_license_file()
Get path to the file defining the license and the actual license file.

is_server(licfile)
Returns True if the given "license file" is actually a reference to a license server.

get_linked_path(path)
Returns the absolute path for path.

read_license_file(license_file)
Read the given license file.

Variables

[hide private]

fmt = logging.Formatter('%(message)s')

log = logging.getLogger("flexlm")

filelog = logging.getLogger("logfile")

signature_fields = ['SIGN', 'SIGN2', 'vendor_info']

date_fields = ('ISSUED', 'START')

tag_order = {'FEATURE': 4, 'INCREMENT': 5, 'PACKAGE': 3, 'SERV...

ethernet_pattern = re.compile(r'(?i)[\da-f]{8,}')

ETHERNET_HOSTID_ORDER = 10

IPADDR_HOSTID_ORDER = 20

OPEN_HOSTID_ORDER = 50

DEFAULT_HOSTID_ORDER = 100

license_index = {'library': 70, 'library_perm': 60, 'nodelocke...

implicit_supersede = True
hash(x)

sameday_replacement = True
hash(x)

SCHRODINGER = '/nfs/builds/objects/NB/2015-3/Linux-x86_64/buil...

default_license = '/nfs/builds/objects/NB/2015-3/Linux-x86_64/...

__package__ = 'schrodinger.application.licensing'

Function Details

[hide private]

parse_line(license_line, line_num=0)

Parse a complete FLEXlm license line into it's component parts.

Duplicate lines are rejected at this stage. (To detect duplicates, we just consider the digital signature fields.)

This method returns an object representing the contents of that line, This will be a Feature, Package, Server, Vendor or UseServer object.

parse_date(date_text)

Parse a FLEXlm date string, which is in the format "dd-mmm-yyyy".

A date object is returned.

parse_expiration(exp_text)

Parse the expiration field of a FEATURE/INCREMENT line. This can either be a standard dd-mm-yyyy date, "0", or "permanent". An expiration of "0" indicates a permanent license.

A date object is returned. For a permanent license, the value returned is the maximum representable date.

parse_tokens(count_text)

Parse the token-count field of a FEATURE/INCREMENT line. This can either be a positive interger, to indicate the number of tokens, "0", or "uncounted". A count of "0" indicates an uncounted licese.

An integer is returned. For an uncounted license, 0 is returned.

parse_components(components_text)

Parse the COMPONENTS field of a PACKAGE line. This is a list of features, with an optional version number and token count for each feature.

A list of (feature_name, version, count) tuples is returned.

hostid_order(hostid)


Return a index that can be used to order license lines with the
given hostid relative to other similar lines with different hostids.
This is used to construct the standard sort key.

Typical hostid types used in Schrodinger license are
1. ethernet address
2. IP range
3. ANY
4. none

We would like more restricted licenses to be listed first in the
license file.

_std_sortkey(elem)


A comparison function, used to sort license lines.

Lines are grouped into the following blocks:
1. all SERVER lines
2. all VENDOR lines
3. all uncounted licenses, ordered by name
4, the USE_SERVER lne, if any
5. all other non-suite feature/increment lines, by name
6. the GLIDE_SUITE package and feature lines
7. the SUITE package and feature lines

Within a block, lines are grouped ...
a) by feature name in feature/increment blocks,
b) FEATURE before INCREMENT, and
c) PACKAGE before FEATURE/INCREMENT,

To create this sort order, we construct the sort key

    (Block number, hostid, name, tag_order, lne number)

where tag_order is used to order FEATURE/INCREMENT and
PACKAGE/non-PACKAGE lines.  The hostid field is used to group lines
within a block; more retricted hostids are listed before more open
hostids.

_remove_superseded_lines(elements)

Remove the superseded licenses from the given list of license lines. This can be used both for Feature and Package lines.

The input list is sorted by ISSUED date, as a side effect.

_remove_replaced_lines(old_elems, new_elems)

Remove the elements from old_elems that appear in new_elems with the same issued date. This can be used both for Feature and Package lines. All input elements are assumed to have the same name.

The filtered list of old elements is returned.

_remove_expired_lines(elements)

Remove the expired licenses from the given list of license lines. This is really only useful for FEATURE/INCREMENT lines.

The input list is sorted by ISSUED date, as a side effect.

find_license_file()


Get path to the file defining the license and the actual
license file. This is the order of precedence:

   1) $SCHROD_LICENSE_FILE
   2) $LM_LICENSE_FILE
   3) $SCHRODINGER_LICENSE_FALLBACK
   4) $SCHRODINGER_LICENSE
   5) $SCHRODINGER/license
   6) /Library/Application Support/Schrodinger/license (for MacOSX)

Returns the tuple (license_file, source)

get_linked_path(path)

Returns the absolute path for path. If it is a symlink the absolute path for the linked file is returned.

read_license_file(license_file)

Read the given license file.

A License object is returned if the given file was an actual FLEXlm license file. Otherwise, a LicfileError exception is raised.

Variables Details

[hide private]

tag_order

Value:

{'FEATURE': 4,
 'INCREMENT': 5,
 'PACKAGE': 3,
 'SERVER': 0,
 'USE_SERVER': 2,
 'VENDOR': 1}

license_index

Value:

{'library': 70,
 'library_perm': 60,
 'nodelocked': 30,
 'nodelocked_perm': 20,
 'open': 10,
 'server': 50,
 'server_perm': 40,
 'server_stub': 50}

SCHRODINGER

Value:

'/nfs/builds/objects/NB/2015-3/Linux-x86_64/build-145'

default_license

Value:

'/nfs/builds/objects/NB/2015-3/Linux-x86_64/build-145/license.txt'