diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2f48d1c --- /dev/null +++ b/.gitignore @@ -0,0 +1,105 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# dotenv +.env + +# virtualenv +.venv +venv/ +ENV/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +# pycharm +.idea +.vscode \ No newline at end of file diff --git a/ISO8583/ISO8583.py b/ISO8583/ISO8583.py old mode 100755 new mode 100644 index a9e509f..0e01b9c --- a/ISO8583/ISO8583.py +++ b/ISO8583/ISO8583.py @@ -18,16 +18,22 @@ """ __author__ = 'Igor Vitorio Custodio ' -__version__ = '1.3.1' +__version__ = '1.4' __licence__ = 'GPL V3' -from ISOErrors import * +import sys +if sys.version_info >= (3,): + from ISO8583.ISOErrors import * +else: + from ISOErrors import * import struct - +import binascii +import ebcdic +import time class ISO8583: """Main Class to work with ISO8583 packages. - Used to create, change, send, receive, parse or work with ISO8593 Package version 1993. + Used to create, change, send, receive, parse or work with ISO8593 Package version 1987. It's 100% Python :) Enjoy it! Thanks to: Vulcanno IT Solutions @@ -48,7 +54,7 @@ class ISO8583: iso.setBit(17,17) iso.setBit(49,986) iso.setBit(99,99) - except ValueToLarge, e: + except ValueTooLarge, e: print ('Value too large :( %s' % e) except InvalidMTI, i: print ('This MTI is wrong :( %s' % i) @@ -62,7 +68,7 @@ class ISO8583: """ # Attributes - # Bitsto be set 00000000 -> _BIT_POSITION_1 ... _BIT_POSITION_8 + # Bits to be set 00000000 -> _BIT_POSITION_1 ... _BIT_POSITION_8 _BIT_POSITION_1 = 128 # 10 00 00 00 _BIT_POSITION_2 = 64 # 01 00 00 00 _BIT_POSITION_3 = 32 # 00 10 00 00 @@ -77,152 +83,198 @@ class ISO8583: _BIT_POSITION_6, _BIT_POSITION_7] _BIT_DEFAULT_VALUE = 0 - # ISO8583 contants + # ISO8583 constants _BITS_VALUE_TYPE = {} # Every _BITS_VALUE_TYPE has: - # _BITS_VALUE_TYPE[N] = [ X,Y, Z, W,K] + # _BITS_VALUE_TYPE[N] = [ X, Y, Z, W, K, L ] # N = bitnumber - # X = smallStr representation of the bit meanning + # X = smallStr representation of the bit meaning # Y = large str representation - # Z = type of the bit (B, N, A, AN, ANS, LL, LLL) + # Z = type of the bit (B, N, A, AN, ANS, LL, LLL, LLLLLL) + # V = format of indicator length indicator LL, LLL, etc (-, A[scii], B[CD]) # W = size of the information that N need to has - # K = type os values a, an, n, ansb, b - _BITS_VALUE_TYPE[1] = ['BME', 'Bit Map Extended', 'B', 16, 'b'] - _BITS_VALUE_TYPE[2] = ['2', 'Primary account number (PAN)', 'LL', 19, 'n'] - _BITS_VALUE_TYPE[3] = ['3', 'Precessing code', 'N', 6, 'n'] - _BITS_VALUE_TYPE[4] = ['4', 'Amount transaction', 'N', 12, 'n'] - _BITS_VALUE_TYPE[5] = ['5', 'Amount reconciliation', 'N', 12, 'n'] - _BITS_VALUE_TYPE[6] = ['6', 'Amount cardholder billing', 'N', 12, 'n'] - _BITS_VALUE_TYPE[7] = ['7', 'Date and time transmission', 'N', 10, 'n'] - _BITS_VALUE_TYPE[8] = ['8', 'Amount cardholder billing fee', 'N', 8, 'n'] - _BITS_VALUE_TYPE[9] = ['9', 'Conversion rate reconciliation', 'N', 8, 'n'] - _BITS_VALUE_TYPE[10] = ['10', 'Conversion rate cardholder billing', 'N', 8, 'n'] - _BITS_VALUE_TYPE[11] = ['11', 'Systems trace audit number', 'N', 6, 'n'] - _BITS_VALUE_TYPE[12] = ['12', 'Date and time local transaction', 'N', 6, 'n'] - _BITS_VALUE_TYPE[13] = ['13', 'Date effective', 'N', 4, 'n'] - _BITS_VALUE_TYPE[14] = ['14', 'Date expiration', 'N', 4, 'n'] - _BITS_VALUE_TYPE[15] = ['15', 'Date settlement', 'N', 4, 'n'] - _BITS_VALUE_TYPE[16] = ['16', 'Date conversion', 'N', 4, 'n'] - _BITS_VALUE_TYPE[17] = ['17', 'Date capture', 'N', 4, 'n'] - _BITS_VALUE_TYPE[18] = ['18', 'Message error indicator', 'N', 4, 'n'] - _BITS_VALUE_TYPE[19] = ['19', 'Country code acquiring institution', 'N', 3, 'n'] - _BITS_VALUE_TYPE[20] = ['20', 'Country code primary account number (PAN)', 'N', 3, 'n'] - _BITS_VALUE_TYPE[21] = ['21', 'Transaction life cycle identification data', 'ANS', 3, 'n'] - _BITS_VALUE_TYPE[22] = ['22', 'Point of service data code', 'N', 3, 'n'] - _BITS_VALUE_TYPE[23] = ['23', 'Card sequence number', 'N', 3, 'n'] - _BITS_VALUE_TYPE[24] = ['24', 'Function code', 'N', 3, 'n'] - _BITS_VALUE_TYPE[25] = ['25', 'Message reason code', 'N', 2, 'n'] - _BITS_VALUE_TYPE[26] = ['26', 'Merchant category code', 'N', 2, 'n'] - _BITS_VALUE_TYPE[27] = ['27', 'Point of service capability', 'N', 1, 'n'] - _BITS_VALUE_TYPE[28] = ['28', 'Date reconciliation', 'N', 8, 'n'] - _BITS_VALUE_TYPE[29] = ['29', 'Reconciliation indicator', 'N', 8, 'n'] - _BITS_VALUE_TYPE[30] = ['30', 'Amounts original', 'N', 8, 'n'] - _BITS_VALUE_TYPE[31] = ['31', 'Acquirer reference number', 'N', 8, 'n'] - _BITS_VALUE_TYPE[32] = ['32', 'Acquiring institution identification code', 'LL', 11, 'n'] - _BITS_VALUE_TYPE[33] = ['33', 'Forwarding institution identification code', 'LL', 11, 'n'] - _BITS_VALUE_TYPE[34] = ['34', 'Electronic commerce data', 'LL', 28, 'n'] - _BITS_VALUE_TYPE[35] = ['35', 'Track 2 data', 'LL', 37, 'n'] - _BITS_VALUE_TYPE[36] = ['36', 'Track 3 data', 'LLL', 104, 'n'] - _BITS_VALUE_TYPE[37] = ['37', 'Retrieval reference number', 'N', 12, 'an'] - _BITS_VALUE_TYPE[38] = ['38', 'Approval code', 'N', 6, 'an'] - _BITS_VALUE_TYPE[39] = ['39', 'Action code', 'A', 2, 'an'] - _BITS_VALUE_TYPE[40] = ['40', 'Service code', 'N', 3, 'an'] - _BITS_VALUE_TYPE[41] = ['41', 'Card acceptor terminal identification', 'N', 8, 'ans'] - _BITS_VALUE_TYPE[42] = ['42', 'Card acceptor identification code', 'A', 15, 'ans'] - _BITS_VALUE_TYPE[43] = ['43', 'Card acceptor name/location', 'A', 40, 'asn'] - _BITS_VALUE_TYPE[44] = ['44', 'Additional response data', 'LL', 25, 'an'] - _BITS_VALUE_TYPE[45] = ['45', 'Track 1 data', 'LL', 76, 'an'] - _BITS_VALUE_TYPE[46] = ['46', 'Amounts fees', 'LLL', 999, 'an'] - _BITS_VALUE_TYPE[47] = ['47', 'Additional data national', 'LLL', 999, 'an'] - _BITS_VALUE_TYPE[48] = ['48', 'Additional data private', 'LLL', 999, 'an'] - _BITS_VALUE_TYPE[49] = ['49', 'Verification data', 'A', 3, 'a'] - _BITS_VALUE_TYPE[50] = ['50', 'Currency code, settlement', 'AN', 3, 'an'] - _BITS_VALUE_TYPE[51] = ['51', 'Currency code, cardholder billing', 'A', 3, 'a'] - _BITS_VALUE_TYPE[52] = ['52', 'Personal identification number (PIN) data', 'B', 16, 'b'] - _BITS_VALUE_TYPE[53] = ['53', 'Security related control information', 'LL', 18, 'n'] - _BITS_VALUE_TYPE[54] = ['54', 'Amounts additional', 'LLL', 120, 'an'] - _BITS_VALUE_TYPE[55] = ['55', 'Integrated circuit card (ICC) system related data', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[56] = ['56', 'Original data elements', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[57] = ['57', 'Authorisation life cycle code', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[58] = ['58', 'Authorising agent institution identification code', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[59] = ['59', 'Transport data', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[60] = ['60', 'Reserved for national use', 'LL', 7, 'ans'] - _BITS_VALUE_TYPE[61] = ['61', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[62] = ['62', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[63] = ['63', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[64] = ['64', 'Message authentication code (MAC) field', 'B', 16, 'b'] - _BITS_VALUE_TYPE[65] = ['65', 'Bitmap tertiary', 'B', 16, 'b'] - _BITS_VALUE_TYPE[66] = ['66', 'Settlement code', 'N', 1, 'n'] - _BITS_VALUE_TYPE[67] = ['67', 'Extended payment data', 'N', 2, 'n'] - _BITS_VALUE_TYPE[68] = ['68', 'Receiving institution country code', 'N', 3, 'n'] - _BITS_VALUE_TYPE[69] = ['69', 'Settlement institution county code', 'N', 3, 'n'] - _BITS_VALUE_TYPE[70] = ['70', 'Network management Information code', 'N', 3, 'n'] - _BITS_VALUE_TYPE[71] = ['71', 'Message number', 'N', 4, 'n'] - _BITS_VALUE_TYPE[72] = ['72', 'Data record', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[73] = ['73', 'Date action', 'N', 6, 'n'] - _BITS_VALUE_TYPE[74] = ['74', 'Credits, number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[75] = ['75', 'Credits, reversal number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[76] = ['76', 'Debits, number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[77] = ['77', 'Debits, reversal number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[78] = ['78', 'Transfer number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[79] = ['79', 'Transfer, reversal number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[80] = ['80', 'Inquiries number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[81] = ['81', 'Authorizations, number', 'N', 10, 'n'] - _BITS_VALUE_TYPE[82] = ['82', 'Credits, processing fee amount', 'N', 12, 'n'] - _BITS_VALUE_TYPE[83] = ['83', 'Credits, transaction fee amount', 'N', 12, 'n'] - _BITS_VALUE_TYPE[84] = ['84', 'Debits, processing fee amount', 'N', 12, 'n'] - _BITS_VALUE_TYPE[85] = ['85', 'Debits, transaction fee amount', 'N', 12, 'n'] - _BITS_VALUE_TYPE[86] = ['86', 'Credits, amount', 'N', 15, 'n'] - _BITS_VALUE_TYPE[87] = ['87', 'Credits, reversal amount', 'N', 15, 'n'] - _BITS_VALUE_TYPE[88] = ['88', 'Debits, amount', 'N', 15, 'n'] - _BITS_VALUE_TYPE[89] = ['89', 'Debits, reversal amount', 'N', 15, 'n'] - _BITS_VALUE_TYPE[90] = ['90', 'Original data elements', 'N', 42, 'n'] - _BITS_VALUE_TYPE[91] = ['91', 'File update code', 'AN', 1, 'an'] - _BITS_VALUE_TYPE[92] = ['92', 'File security code', 'N', 2, 'n'] - _BITS_VALUE_TYPE[93] = ['93', 'Response indicator', 'N', 5, 'n'] - _BITS_VALUE_TYPE[94] = ['94', 'Service indicator', 'AN', 7, 'an'] - _BITS_VALUE_TYPE[95] = ['95', 'Replacement amounts', 'AN', 42, 'an'] - _BITS_VALUE_TYPE[96] = ['96', 'Message security code', 'AN', 8, 'an'] - _BITS_VALUE_TYPE[97] = ['97', 'Amount, net settlement', 'N', 16, 'n'] - _BITS_VALUE_TYPE[98] = ['98', 'Payee', 'ANS', 25, 'ans'] - _BITS_VALUE_TYPE[99] = ['99', 'Settlement institution identification code', 'LL', 11, 'n'] - _BITS_VALUE_TYPE[100] = ['100', 'Receiving institution identification code', 'LL', 11, 'n'] - _BITS_VALUE_TYPE[101] = ['101', 'File name', 'ANS', 17, 'ans'] - _BITS_VALUE_TYPE[102] = ['102', 'Account identification 1', 'LL', 28, 'ans'] - _BITS_VALUE_TYPE[103] = ['103', 'Account identification 2', 'LL', 28, 'ans'] - _BITS_VALUE_TYPE[104] = ['104', 'Transaction description', 'LLL', 100, 'ans'] - _BITS_VALUE_TYPE[105] = ['105', 'Reserved for ISO use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[106] = ['106', 'Reserved for ISO use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[107] = ['107', 'Reserved for ISO use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[108] = ['108', 'Reserved for ISO use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[109] = ['109', 'Reserved for ISO use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[110] = ['110', 'Reserved for ISO use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[111] = ['111', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[112] = ['112', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[113] = ['113', 'Reserved for private use', 'LL', 11, 'n'] - _BITS_VALUE_TYPE[114] = ['114', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[115] = ['115', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[116] = ['116', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[117] = ['117', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[118] = ['118', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[119] = ['119', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[120] = ['120', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[121] = ['121', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[122] = ['122', 'Reserved for national use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[123] = ['123', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[124] = ['124', 'Info Text', 'LLL', 255, 'ans'] - _BITS_VALUE_TYPE[125] = ['125', 'Network management information', 'LL', 50, 'ans'] - _BITS_VALUE_TYPE[126] = ['126', 'Issuer trace id', 'LL', 6, 'ans'] - _BITS_VALUE_TYPE[127] = ['127', 'Reserved for private use', 'LLL', 999, 'ans'] - _BITS_VALUE_TYPE[128] = ['128', 'Message authentication code (MAC) field', 'B', 16, 'b'] - + # K = type of values a, an, n, ans, b + # L = format of the data (A[scii], E[bcdic], P[acked]) + _BITS_VALUE_TYPE[1] = ['BME', 'Bit Map Extended', 'B', '-', 16, 'b', 'A'] + _BITS_VALUE_TYPE[2] = ['2', 'Primary account number (PAN)', 'LL', 'A', 19, 'n', 'A'] + _BITS_VALUE_TYPE[3] = ['3', 'Processing code', 'N', '-', 6, 'n', 'A'] + _BITS_VALUE_TYPE[4] = ['4', 'Amount transaction', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[5] = ['5', 'Amount reconciliation', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[6] = ['6', 'Amount cardholder billing', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[7] = ['7', 'Date and time transmission', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[8] = ['8', 'Amount cardholder billing fee', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[9] = ['9', 'Conversion rate reconciliation', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[10] = [ + '10', 'Conversion rate cardholder billing', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[11] = ['11', 'Systems trace audit number', 'N', '-', 6, 'n', 'A'] + _BITS_VALUE_TYPE[12] = [ + '12', 'Time local transaction', 'N', '-', 6, 'n', 'A'] + _BITS_VALUE_TYPE[13] = ['13', 'Date local transaction', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[14] = ['14', 'Date expiration', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[15] = ['15', 'Date settlement', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[16] = ['16', 'Date conversion', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[17] = ['17', 'Date capture', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[18] = ['18', 'Merchant Type', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[19] = [ + '19', 'Country code acquiring institution', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[20] = [ + '20', 'Country code primary account number (PAN)', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[21] = [ + '21', 'Forwarding Institution Country Code', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[22] = ['22', 'POS Entry Mode', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[23] = ['23', 'Card sequence number', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[24] = ['24', 'Function code', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[25] = ['25', 'POS condition code', 'N', '-', 2, 'n', 'A'] + _BITS_VALUE_TYPE[26] = ['26', 'POS PIN Capture Code', 'N', '-', 2, 'n', 'A'] + _BITS_VALUE_TYPE[27] = ['27', 'Auth ID Response Length', 'N', '-', 1, 'n', 'A'] + _BITS_VALUE_TYPE[28] = ['28', 'Amount, Txn Fee', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[29] = ['29', 'Amount, Reconciliation Fee', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[30] = ['30', 'Amount, Txn Processing Fee', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[31] = ['31', 'Amount, Settlement Processing Fee', 'N', '-', 8, 'n', 'A'] + _BITS_VALUE_TYPE[32] = [ + '32', 'Acquiring institution identification code', 'LL', 'A', 11, 'n', 'A'] + _BITS_VALUE_TYPE[33] = [ + '33', 'Forwarding institution identification code', 'LL', 'A', 11, 'n', 'A'] + _BITS_VALUE_TYPE[34] = ['34', 'Primary Account Number, extended', 'LL', 'A', 28, 'n', 'A'] + _BITS_VALUE_TYPE[35] = ['35', 'Track 2 data', 'LL', 'A', 37, 'n', 'A'] + _BITS_VALUE_TYPE[36] = ['36', 'Track 3 data', 'LLL', 'A', 104, 'n', 'A'] + _BITS_VALUE_TYPE[37] = ['37', 'Retrieval reference number', 'N', '-', 12, 'an', 'A'] + _BITS_VALUE_TYPE[38] = ['38', 'Approval code', 'N', '-', 6, 'an', 'A'] + _BITS_VALUE_TYPE[39] = ['39', 'Response code', 'A', '-', 2, 'an', 'A'] + _BITS_VALUE_TYPE[40] = ['40', 'Service restriction code', 'N', '-', 3, 'an', 'A'] + _BITS_VALUE_TYPE[41] = [ + '41', 'Card acceptor terminal identification', 'N', '-', 8, 'ans', 'A'] + _BITS_VALUE_TYPE[42] = [ + '42', 'Card acceptor identification code', 'A', '-', 15, 'ans', 'A'] + _BITS_VALUE_TYPE[43] = [ + '43', 'Card acceptor name/location', 'A', '-', 40, 'ans', 'A'] + _BITS_VALUE_TYPE[44] = ['44', 'Additional response data', 'LL', 'A', 25, 'an', 'A'] + _BITS_VALUE_TYPE[45] = ['45', 'Track 1 data', 'LL', 'A', 76, 'an', 'A'] + _BITS_VALUE_TYPE[46] = ['46', 'Amounts fees', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[47] = ['47', 'Additional data national', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[48] = ['48', 'Additional data private', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[49] = ['49', 'Currency code, transaction', 'AN', '-', 3, 'an', 'A'] + _BITS_VALUE_TYPE[50] = ['50', 'Currency code, settlement', 'AN', '-', 3, 'an', 'A'] + _BITS_VALUE_TYPE[51] = [ + '51', 'Currency code, cardholder billing', 'AN', '-', 3, 'an', 'A'] + _BITS_VALUE_TYPE[52] = [ + '52', 'Personal identification number (PIN) data', 'B', '-', 16, 'b', 'A'] + _BITS_VALUE_TYPE[53] = [ + '53', 'Security related control information', 'LL', 'A', 16, 'n', 'A'] + _BITS_VALUE_TYPE[54] = ['54', 'Amounts additional', 'LLL', 'A', 120, 'an', 'A'] + _BITS_VALUE_TYPE[55] = [ + '55', 'Integrated circuit card (ICC) system related data', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[56] = ['56', 'Original data elements', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[57] = [ + '57', 'Authorisation life cycle code', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[58] = [ + '58', 'Authorising agent institution identification code', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[59] = ['59', 'Transport data', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[60] = ['60', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[61] = [ + '61', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[62] = [ + '62', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[63] = [ + '63', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[64] = [ + '64', 'Message authentication code (MAC) field', 'B', '-', 16, 'b', 'A'] + _BITS_VALUE_TYPE[65] = ['65', 'Bitmap tertiary', 'B', '-', 16, 'b', 'A'] + _BITS_VALUE_TYPE[66] = ['66', 'Settlement code', 'N', '-', 1, 'n', 'A'] + _BITS_VALUE_TYPE[67] = ['67', 'Extended payment data', 'N', '-', 2, 'n', 'A'] + _BITS_VALUE_TYPE[68] = [ + '68', 'Receiving institution country code', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[69] = [ + '69', 'Settlement institution county code', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[70] = [ + '70', 'Network management Information code', 'N', '-', 3, 'n', 'A'] + _BITS_VALUE_TYPE[71] = ['71', 'Message number', 'N', '-', 4, 'n', 'A'] + _BITS_VALUE_TYPE[72] = ['72', 'Data record', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[73] = ['73', 'Date action', 'N', '-', 6, 'n', 'A'] + _BITS_VALUE_TYPE[74] = ['74', 'Credits, number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[75] = ['75', 'Credits, reversal number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[76] = ['76', 'Debits, number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[77] = ['77', 'Debits, reversal number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[78] = ['78', 'Transfer number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[79] = ['79', 'Transfer, reversal number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[80] = ['80', 'Inquiries number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[81] = ['81', 'Authorizations, number', 'N', '-', 10, 'n', 'A'] + _BITS_VALUE_TYPE[82] = [ + '82', 'Credits, processing fee amount', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[83] = [ + '83', 'Credits, transaction fee amount', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[84] = [ + '84', 'Debits, processing fee amount', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[85] = [ + '85', 'Debits, transaction fee amount', 'N', '-', 12, 'n', 'A'] + _BITS_VALUE_TYPE[86] = ['86', 'Credits, amount', 'N', '-', 16, 'n', 'A'] + _BITS_VALUE_TYPE[87] = ['87', 'Credits, reversal amount', 'N', '-', 16, 'n', 'A'] + _BITS_VALUE_TYPE[88] = ['88', 'Debits, amount', 'N', '-', 16, 'n', 'A'] + _BITS_VALUE_TYPE[89] = ['89', 'Debits, reversal amount', 'N', '-', 16, 'n', 'A'] + _BITS_VALUE_TYPE[90] = ['90', 'Original data elements', 'N', '-', 42, 'n', 'A'] + _BITS_VALUE_TYPE[91] = ['91', 'File update code', 'AN', '-', 1, 'an', 'A'] + _BITS_VALUE_TYPE[92] = ['92', 'File security code', 'N', '-', 2, 'n', 'A'] + _BITS_VALUE_TYPE[93] = ['93', 'Response indicator', 'N', '-', 5, 'n', 'A'] + _BITS_VALUE_TYPE[94] = ['94', 'Service indicator', 'AN', '-', 7, 'an', 'A'] + _BITS_VALUE_TYPE[95] = ['95', 'Replacement amounts', 'AN', '-', 42, 'an', 'A'] + _BITS_VALUE_TYPE[96] = ['96', 'Message security code', 'AN', '-', 8, 'an', 'A'] + _BITS_VALUE_TYPE[97] = ['97', 'Amount, net settlement', 'N', '-', 16, 'n', 'A'] + _BITS_VALUE_TYPE[98] = ['98', 'Payee', 'ANS', '-', 25, 'ans', 'A'] + _BITS_VALUE_TYPE[99] = [ + '99', 'Settlement institution identification code', 'LL', 'A', 11, 'n', 'A'] + _BITS_VALUE_TYPE[100] = [ + '100', 'Receiving institution identification code', 'LL', 'A', 11, 'n', 'A'] + _BITS_VALUE_TYPE[101] = ['101', 'File name', 'LL', 'ANS', 17, 'ans', 'A'] + _BITS_VALUE_TYPE[102] = [ + '102', 'Account identification 1', 'LL', 'A', 28, 'ans', 'A'] + _BITS_VALUE_TYPE[103] = [ + '103', 'Account identification 2', 'LL', 'A', 28, 'ans', 'A'] + _BITS_VALUE_TYPE[104] = [ + '104', 'Transaction description', 'LLL', 'A', 100, 'ans', 'A'] + _BITS_VALUE_TYPE[105] = ['105', 'Reserved for ISO use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[106] = ['106', 'Reserved for ISO use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[107] = ['107', 'Reserved for ISO use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[108] = ['108', 'Reserved for ISO use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[109] = ['109', 'Reserved for ISO use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[110] = ['110', 'Reserved for ISO use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[111] = [ + '111', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[112] = [ + '112', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[113] = ['113', 'Reserved for private use', 'LL', 'A', 11, 'n', 'A'] + _BITS_VALUE_TYPE[114] = [ + '114', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[115] = [ + '115', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[116] = [ + '116', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[117] = [ + '117', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[118] = [ + '118', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[119] = [ + '119', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[120] = [ + '120', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[121] = [ + '121', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[122] = [ + '122', 'Reserved for national use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[123] = [ + '123', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[124] = ['124', 'Info Text', 'LLL', 'A', 255, 'ans', 'A'] + _BITS_VALUE_TYPE[125] = [ + '125', 'Network management information', 'LL', 'A', 50, 'ans', 'A'] + _BITS_VALUE_TYPE[126] = ['126', 'Issuer trace id', 'LL', 'A', 6, 'ans', 'A'] + _BITS_VALUE_TYPE[127] = ['127', 'Reserved for private use', 'LLL', 'A', 999, 'ans', 'A'] + _BITS_VALUE_TYPE[128] = ['128', 'Message authentication code (MAC) field', 'B', '-', 16, 'b', 'A'] ################################################################################################ # Default constructor of the ISO8583 Object - def __init__(self, iso="", debug=False): + def __init__(self, iso="", debug=False, bitmap_uppercase=False, hdrlen=0): """Default Constructor of ISO8583 Package. - It inicialize a "brand new" ISO8583 package + It initialize a "brand new" ISO8583 package Example: To Enable debug you can use: pack = ISO8583(debug=True) @param: iso a String that represents the ASCII of the package. The same that you need to pass to setIsoContent() method. @@ -232,21 +284,50 @@ def __init__(self, iso="", debug=False): self.BITMAP = [] # Values self.BITMAP_VALUES = [] - # Bitmap ASCII representantion - self.BITMAP_HEX = '' + # Bitmap ASCII representation + self.BITMAP_HEX = b'' + self.BITMAP_format = 'A' # MTI - self.MESSAGE_TYPE_INDICATION = ''; + self.MESSAGE_TYPE_INDICATION = b'' + self.MTI_format = 'A' # Debug ? self.DEBUG = debug + # Bitmap uses uppercase ? + self.BITMAP_UPPERCASE = bitmap_uppercase + # Header (optional) + self.hdrlen = hdrlen + self.hdr = b'' - self.__inicializeBitmap() - self.__inicializeBitmapValues() + self.__initializeBitmap() + self.__initializeBitmapValues() if iso != "": self.setIsoContent(iso) ################################################################################################ + ################################################################################################ + # Return small bit name + def getSmallBitName(self, bit): + """Method that return the small bit name + @param: bit -> Bit that will be searched and whose name will be returned + @return: str that represents the name of the bit + """ + return self._BITS_VALUE_TYPE[bit][0] + + ################################################################################################ + + ################################################################################################ + # Return large bit name + def getLargeBitName(self, bit): + """Method that return the large bit name + @param: bit -> Bit that will be searched and whose name will be returned + @return: str that represents the name of the bit + """ + return self._BITS_VALUE_TYPE[bit][1] + + ################################################################################################ + ################################################################################################ # Return bit type def getBitType(self, bit): @@ -258,6 +339,16 @@ def getBitType(self, bit): ################################################################################################ + ################################################################################################ + # Return bit type + def getBitLenForm(self,bit): + """Method that return the bit Length Indicator Format + @param: bit -> Bit that will be searched and whose length indicator format will be returned + @return: str that represents the length indicator format of the bit + """ + return self._BITS_VALUE_TYPE[bit][3] + ################################################################################################ + ################################################################################################ # Return bit limit def getBitLimit(self, bit): @@ -265,7 +356,7 @@ def getBitLimit(self, bit): @param: bit -> Bit that will be searched and whose limit will be returned @return: int that indicate the limit of the bit """ - return self._BITS_VALUE_TYPE[bit][3] + return self._BITS_VALUE_TYPE[bit][4] ################################################################################################ @@ -276,63 +367,138 @@ def getBitValueType(self, bit): @param: bit -> Bit that will be searched and whose value type will be returned @return: str that indicate the valuye type of the bit """ - return self._BITS_VALUE_TYPE[bit][4] + return self._BITS_VALUE_TYPE[bit][5] ################################################################################################ ################################################################################################ - # Return large bit name - def getLargeBitName(self, bit): - """Method that return the large bit name - @param: bit -> Bit that will be searched and whose name will be returned - @return: str that represents the name of the bit + #Return bit type + def getBitFormat(self,bit): + """Method that return the bit Format (Ascii, Ebcdic, Packed) + @param: bit -> Bit that will be searched and whose format will be returned + @return: str that represents the format of the bit """ - return self._BITS_VALUE_TYPE[bit][1] + return self._BITS_VALUE_TYPE[bit][6] + ################################################################################################ + + ################################################################################################ + # Set the header + def setHdr(self, hdr): + """Method that sets the optional header byte string + """ + + + self.hdr = hdr + self.hdrlen = len(hdr) + + ################################################################################################ + + ################################################################################################ + # Set the header length + def setHdrlen(self, hdrlen): + """Method that sets the optional header byte length + """ + + if hdrlen < 0: # Sanitize input + hdrlen = 0 + + self.hdrlen = hdrlen + if hdrlen == 0: # Clear header + self.hdr = b'' + elif len(self.hdr) > self.hdrlen: # truncate header + self.hdr = self.hdr[0:self.hdrlen] + elif len(self.hdr) < self.hdrlen: + self.hdr = self.hdr.ljust(self.hdrlen) ################################################################################################ + ################################################################################################ + # Get the header + def getHdr(self): + """Method that gets the optional header byte string + """ + + return self.hdr + + ################################################################################################ + + ################################################################################################ + # Get the header length + def getHdrlen(self): + """Method that gets the optional header byte length + """ + + return self.hdrlen + + ################################################################################################ + + ################################################################################################ + # Set the MTI format (ASCII/BCD) + def setMTIformat(self, format='A'): + """Method that set Transaction Type (MTI) format, 'B'CD, 'A'SCII or 'E'BCDIC + """ + + if format != 'A' and format != 'B' and format != 'E': + raise InvalidFormat('Error: Invalid MTI format!') + + self.MTI_format = format + + ################################################################################################ + + ################################################################################################ + # Set the MTI format (ASCII/EBCDIC/BCD) + def setBITMAPformat(self, format='A'): + """Method that set the BITMAP format, 'A'SCII, 'E'BCDIC or 'P'acked + """ + + if format != 'A' and format != 'P' and format != 'E': + raise InvalidFormat('Error: Invalid BITMAP format!') + + self.BITMAP_format = format + + ################################################################################################ ################################################################################################ # Set the MTI - def setTransationType(self, type): - """Method that set Transation Type (MTI) + def setTransactionType(self, type): + """Method that set Transaction Type (MTI) @param: type -> MTI to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception """ type = "%s" % type if len(type) > 4: type = type[0:3] - raise ValueToLarge('Error: value up to size! MTI limit size = 4') + raise ValueTooLarge('Error: value up to size! MTI limit size = 4') - typeT = ""; - if len(type) < 4: - for cont in range(len(type), 4): - typeT += "0" - - self.MESSAGE_TYPE_INDICATION = "%s%s" % (typeT, type) + if self.MTI_format == 'A': + self.MESSAGE_TYPE_INDICATION = type.zfill(4).encode() + elif self.MTI_format == 'E': + self.MESSAGE_TYPE_INDICATION = type.zfill(4).encode('cp1148') + else: + self.MESSAGE_TYPE_INDICATION = binascii.unhexlify(type.zfill(4)) ################################################################################################ ################################################################################################ # setMTI too def setMTI(self, type): - """Method that set Transation Type (MTI) - In fact, is an alias to "setTransationType" method + """Method that set Transaction Type (MTI) + In fact, is an alias to "setTransactionType" method @param: type -> MTI to be setted """ - self.setTransationType(type) + self.setTransactionType(type) ################################################################################################ ################################################################################################ # Method that put "zeros" inside bitmap - def __inicializeBitmap(self): - """Method that inicialize/reset a internal bitmap representation + def __initializeBitmap(self): + """Method that initialize/reset a internal bitmap representation It's a internal method, so don't call! """ - if self.DEBUG == True: + if self.DEBUG is True: print('Init bitmap') if len(self.BITMAP) == 16: @@ -346,11 +512,11 @@ def __inicializeBitmap(self): ################################################################################################ # init with "0" the array of values - def __inicializeBitmapValues(self): - """Method that inicialize/reset a internal array used to save bits and values + def __initializeBitmapValues(self): + """Method that initialize/reset a internal array used to save bits and values It's a internal method, so don't call! """ - if self.DEBUG == True: + if self.DEBUG is True: print('Init bitmap_values') if len(self.BITMAP_VALUES) == 128: @@ -362,6 +528,42 @@ def __inicializeBitmapValues(self): ################################################################################################ + ################################################################################################ + # Unset a bit + def unsetBit(self, bit): + """Method used to unset a bit. + @param: bit -> bit number that want to be setted + @raise: BitNonexistent Exception Exception + """ + if self.DEBUG is True: + print('Unsetting bit inside bitmap bit[%s]' % bit) + + if bit < 1 or bit > 128: + raise BitNonexistent("Bit number %s dosen't exist!" % bit) + + # Clear the existing bit value (if present) + self.BITMAP_VALUES[bit] = self._BIT_DEFAULT_VALUE + + # calculate the position inside the bitmap + pos = 1 + if (bit % 8) == 0: + pos = (bit // 8) - 1 + else: + pos = (bit // 8) + + # need to check if the value can be there .. AN , N ... etc ... and the size + + self.BITMAP[pos] = self.BITMAP[pos] & ~self._TMP[(bit % 8) + 1] + + # Clear the continuation bit? + if bit > 64 and self.BITMAP[8:15] == [0, 0, 0, 0, 0, 0, 0]: + # need to unset bit 1 of first "bit" in bitmap + self.BITMAP[0] = self.BITMAP[0] & ~self._TMP[2] + + return True + + ################################################################################################ + ################################################################################################ # Set a value to a bit def setBit(self, bit, value): @@ -370,15 +572,15 @@ def setBit(self, bit, value): @param: bit -> bit number that want to be setted @param: value -> the value of the bit @return: True/False default True -> To be used in the future! - @raise: BitInexistent Exception, ValueToLarge Exception + @raise: BitNonexistent Exception, ValueTooLarge Exception """ - if self.DEBUG == True: - print('Setting bit inside bitmap bit[%s] = %s') % (bit, value) + if self.DEBUG is True: + print('Setting bit inside bitmap bit[%s] = %s' % (bit, value)) if bit < 1 or bit > 128: - raise BitInexistent("Bit number %s dosen't exist!" % bit) + raise BitNonexistent("Bit number %s dosen't exist!" % bit) - # caculate the position insede bitmap + # calculate the position inside the bitmap pos = 1 if self.getBitType(bit) == 'LL': @@ -387,28 +589,33 @@ def setBit(self, bit, value): if self.getBitType(bit) == 'LLL': self.__setBitTypeLLL(bit, value) + if self.getBitType(bit) == 'LLLLLL': + self.__setBitTypeLLLLLL(bit, value) + if self.getBitType(bit) == 'N': self.__setBitTypeN(bit, value) if self.getBitType(bit) == 'A': self.__setBitTypeA(bit, value) - if self.getBitType(bit) == 'ANS' or self.getBitType(bit) == 'B': + if self.getBitType(bit) == 'AN': + self.__setBitTypeAN(bit, value) + + if self.getBitType(bit) == 'ANS': self.__setBitTypeANS(bit, value) if self.getBitType(bit) == 'B': self.__setBitTypeB(bit, value) - - # Continuation bit? if bit > 64: - self.BITMAP[0] = self.BITMAP[0] | self._TMP[2] # need to set bit 1 of first "bit" in bitmap + # need to set bit 1 of first "bit" in bitmap + self.BITMAP[0] = self.BITMAP[0] | self._TMP[2] if (bit % 8) == 0: - pos = (bit / 8) - 1 + pos = (bit // 8) - 1 else: - pos = (bit / 8) + pos = (bit // 8) # need to check if the value can be there .. AN , N ... etc ... and the size @@ -439,34 +646,40 @@ def __buildBitmap(self): It's a internal method, so don't call! """ - self.BITMAP_HEX = '' + self.BITMAP_HEX = b'' for c in range(0, 16): if (self.BITMAP[0] & self._BIT_POSITION_1) != self._BIT_POSITION_1: # Only has the first bitmap - if self.DEBUG == True: - print('%d Bitmap = %d(Decimal) = %s (hexa) ' % (c, self.BITMAP[c], hex(self.BITMAP[c]))) + if self.DEBUG is True: + print('%d Bitmap = %d(Decimal) = %s (hexa) ' % + (c, self.BITMAP[c], hex(self.BITMAP[c]))) tm = hex(self.BITMAP[c])[2:] + if self.BITMAP_UPPERCASE is True: + tm = tm.upper() if len(tm) != 2: tm = '0' + tm - self.BITMAP_HEX += tm + self.BITMAP_HEX += tm.encode() if c == 7: break else: # second bitmap - if self.DEBUG == True: - print('%d Bitmap = %d(Decimal) = %s (hexa) ' % (c, self.BITMAP[c], hex(self.BITMAP[c]))) + if self.DEBUG is True: + print('%d Bitmap = %d(Decimal) = %s (hexa) ' % + (c, self.BITMAP[c], hex(self.BITMAP[c]))) tm = hex(self.BITMAP[c])[2:] + if self.BITMAP_UPPERCASE is True: + tm = tm.upper() if len(tm) != 2: tm = '0' + tm - self.BITMAP_HEX += tm + self.BITMAP_HEX += tm.encode() - ################################################################################################ + ################################################################################################ ################################################################################################ # Get a bitmap from str - def __getBitmapFromStr(self, bitmap): + def __getBitmapFromStr(self, bitmap_raw): """Method that receive a bitmap str and transfor it to ISO8583 object readable. @param: bitmap -> bitmap str to be readable It's a internal method, so don't call! @@ -474,21 +687,32 @@ def __getBitmapFromStr(self, bitmap): # Need to check if the size is correct etc... cont = 0 - if self.BITMAP_HEX != '': - self.BITMAP_HEX = '' + if self.BITMAP_HEX != b'': + self.BITMAP_HEX = b'' + + if self.BITMAP_format == 'A': + bitmap = bitmap_raw + elif self.BITMAP_format == 'E': + bitmap = bitmap_raw.decode('cp1148').encode() + else: + bitmap = binascii.hexlify(bitmap_raw[0:8]) + if (int(bitmap[0:2], 16) & self._BIT_POSITION_1) == self._BIT_POSITION_1: # Also 2nd bitmap + bitmap = binascii.hexlify(bitmap_raw[0:16]) # Now we have the full double-length bitmap unpacked for x in range(0, 32, 2): if (int(bitmap[0:2], 16) & self._BIT_POSITION_1) != self._BIT_POSITION_1: # Only 1 bitmap - if self.DEBUG == True: - print('Token[%d] %s converted to int is = %s' % (x, bitmap[x:x + 2], int(bitmap[x:x + 2], 16))) + if self.DEBUG is True: + print('Token[%d] %s converted to int is = %s' % + (x, bitmap[x:x + 2], int(bitmap[x:x + 2], 16))) self.BITMAP_HEX += bitmap[x:x + 2] self.BITMAP[cont] = int(bitmap[x:x + 2], 16) if x == 14: break else: # Second bitmap - if self.DEBUG == True: - print('Token[%d] %s converted to int is = %s' % (x, bitmap[x:x + 2], int(bitmap[x:x + 2], 16))) + if self.DEBUG is True: + print('Token[%d] %s converted to int is = %s' % + (x, bitmap[x:x + 2], int(bitmap[x:x + 2], 16))) self.BITMAP_HEX += bitmap[x:x + 2] self.BITMAP[cont] = int(bitmap[x:x + 2], 16) @@ -503,14 +727,14 @@ def showBitsFromBitmapStr(self, bitmap): Usualy is used to debug things. @param: bitmap -> bitmap str to be analized and translated to "bits" """ - bits = self.__inicializeBitsFromBitmapStr(bitmap) + bits = self.__initializeBitsFromBitmapStr(bitmap) print('Bits inside %s = %s' % (bitmap, bits)) ################################################################################################ ################################################################################################ - # inicialize a bitmap using ASCII str - def __inicializeBitsFromBitmapStr(self, bitmap): + # initialize a bitmap using ASCII str + def __initializeBitsFromBitmapStr(self, bitmap): """Method that receive a bitmap str, process it, and prepare ISO8583 object to understand and "see" the bits and values inside the ISO ASCII package. It's a internal method, so don't call! @param: bitmap -> bitmap str to be analized and translated to "bits" @@ -518,28 +742,29 @@ def __inicializeBitsFromBitmapStr(self, bitmap): bits = [] for c in range(0, 16): for d in range(1, 9): - if self.DEBUG == True: + if self.DEBUG is True: print('Value (%d)-> %s & %s = %s' % ( - d, self.BITMAP[c], self._TMP[d], (self.BITMAP[c] & self._TMP[d]))) + d, self.BITMAP[c], self._TMP[d], (self.BITMAP[c] & self._TMP[d]))) if (self.BITMAP[c] & self._TMP[d]) == self._TMP[d]: if d == 1: # e o 8 bit - if self.DEBUG == True: + if self.DEBUG is True: print('Bit %s is present !!!' % ((c + 1) * 8)) bits.append((c + 1) * 8) - self.BITMAP_VALUES[(c + 1) * 8] = 'X' + self.BITMAP_VALUES[(c + 1) * 8] = b'X' else: if (c == 0) & (d == 2): # Continuation bit - if self.DEBUG == True: + if self.DEBUG is True: print('Bit 1 is present !!!') bits.append(1) else: - if self.DEBUG == True: - print('Bit %s is present !!!' % (c * 8 + d - 1)) + if self.DEBUG is True: + print('Bit %s is present !!!' % + (c * 8 + d - 1)) bits.append(c * 8 + d - 1) - self.BITMAP_VALUES[c * 8 + d - 1] = 'X' + self.BITMAP_VALUES[c * 8 + d - 1] = b'X' bits.sort() @@ -556,25 +781,26 @@ def __getBitsFromBitmap(self): bits = [] for c in range(0, 16): for d in range(1, 9): - if self.DEBUG == True: + if self.DEBUG is True: print('Value (%d)-> %s & %s = %s' % ( - d, self.BITMAP[c], self._TMP[d], (self.BITMAP[c] & self._TMP[d]))) + d, self.BITMAP[c], self._TMP[d], (self.BITMAP[c] & self._TMP[d]))) if (self.BITMAP[c] & self._TMP[d]) == self._TMP[d]: if d == 1: # e o 8 bit - if self.DEBUG == True: + if self.DEBUG is True: print('Bit %s is present !!!' % ((c + 1) * 8)) bits.append((c + 1) * 8) else: if (c == 0) & (d == 2): # Continuation bit - if self.DEBUG == True: + if self.DEBUG is True: print('Bit 1 is present !!!') bits.append(1) else: - if self.DEBUG == True: - print('Bit %s is present !!!' % (c * 8 + d - 1)) + if self.DEBUG is True: + print('Bit %s is present !!!' % + (c * 8 + d - 1)) bits.append(c * 8 + d - 1) @@ -584,6 +810,34 @@ def __getBitsFromBitmap(self): ################################################################################################ + ################################################################################################ + # Method that receive a ISO8583 ASCII package in the network form and parse it. + def __formatValue(self,bit,value): + """Method that formats a value to the appropriate data for the bit or LL or LLL bits + @param: bit -> bit to be setted + @param: value -> value to be setted + @raise: Nothing as yet + @return: binary data that represents the format of the bit + It's a internal method, so don't call! + """ + size = "%s" % len(value) + data_form = self.getBitFormat(bit) + + if data_form == "A": + data = value.encode() + elif data_form == "E": + data = value.encode('cp1148') + else: # Packed data + # Needs to be even length, with padding on the right + if int(size) % 2 == 0: + data = binascii.unhexlify(value) + else: # Pad to the right with a single '0' character + data = binascii.unhexlify(value + '0') + + return data + + ################################################################################################ + ################################################################################################ # Set of type LL def __setBitTypeLL(self, bit, value): @@ -592,7 +846,7 @@ def __setBitTypeLL(self, bit, value): Example: pack.setBit(99,'123') -> Bit 99 is a LL type, so this bit, in ASCII form need to be 03123. To understand, 03 is the size of the information and 123 is the information/value @param: bit -> bit to be setted @param: value -> value to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception It's a internal method, so don't call! """ @@ -600,15 +854,24 @@ def __setBitTypeLL(self, bit, value): if len(value) > 99: # value = value[0:99] - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) if len(value) > self.getBitLimit(bit): - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) size = "%s" % len(value) - - self.BITMAP_VALUES[bit] = "%s%s" % (size.zfill(2), value) + data = self.__formatValue(bit, value) + lenform = self.getBitLenForm(bit) + + if lenform == 'A': + self.BITMAP_VALUES[bit] = size.zfill(2).encode() + data + elif lenform == 'E': + self.BITMAP_VALUES[bit] = size.zfill(2).encode('cp1148') + data + elif lenform == 'P': + self.BITMAP_VALUES[bit] = self.__IntToLLPack(len(value)) + data + else: + self.BITMAP_VALUES[bit] = self.__IntToLLBCD(len(value)) + data ################################################################################################ @@ -621,22 +884,68 @@ def __setBitTypeLLL(self, bit, value): To understand, 014 is the size of the information and 12345ABCD67890 is the information/value @param: bit -> bit to be setted @param: value -> value to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception It's a internal method, so don't call! """ value = "%s" % value if len(value) > 999: - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) if len(value) > self.getBitLimit(bit): - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) size = "%s" % len(value) + data = self.__formatValue(bit, value) + lenform = self.getBitLenForm(bit) + + if lenform == 'A': + self.BITMAP_VALUES[bit] = size.zfill(3).encode() + data + elif lenform == 'E': + self.BITMAP_VALUES[bit] = size.zfill(3).encode('cp1148') + data + elif lenform == 'P': + self.BITMAP_VALUES[bit] = self.__IntToLLLPack(len(value)) + data + else: + self.BITMAP_VALUES[bit] = self.__IntToLLLBCD(len(value)) + data + + ################################################################################################ + + ################################################################################################ + # Set of type LLLLLL + def __setBitTypeLLLLLL(self, bit, value): + """Method that set a bit with value in form LLLLLL + It put the size in front of the value + Example: pack.setBit(104,'12345ABCD67890') -> If Bit 104 is a LLLLLL type, so this bit, in ASCII form need to be 00001412345ABCD67890. + To understand, 000014 is the size of the information and 12345ABCD67890 is the information/value + @param: bit -> bit to be setted + @param: value -> value to be setted + @raise: ValueTooLarge Exception + It's a internal method, so don't call! + """ - self.BITMAP_VALUES[bit] = "%s%s" % (size.zfill(3), value) + value = "%s" % value + + if len(value) > 999999: + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) + if len(value) > self.getBitLimit(bit): + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) + + size = "%s" % len(value) + data = self.__formatValue(bit, value) + lenform = self.getBitLenForm(bit) + + if lenform == 'A': + self.BITMAP_VALUES[bit] = size.zfill(6).encode() + data + elif lenform == 'E': + self.BITMAP_VALUES[bit] = size.zfill(6).encode('cp1148') + data + elif lenform == 'P': + self.BITMAP_VALUES[bit] = self.__IntToLLLLLLPack(len(value)) + data + else: + self.BITMAP_VALUES[bit] = self.__IntToLLLLLLBCD(len(value)) + data ################################################################################################ @@ -645,11 +954,11 @@ def __setBitTypeLLL(self, bit, value): def __setBitTypeN(self, bit, value): """Method that set a bit with value in form N It complete the size of the bit with a default value - Example: pack.setBit(3,'30000') -> Bit 3 is a N type, so this bit, in ASCII form need to has size = 6 (ISO especification) so the value 30000 size = 5 need to receive more "1" number. + Example: pack.setBit(3,'30000') -> Bit 3 is a N type, so this bit, in ASCII form need to has size = 6 (ISO specification) so the value 30000 size = 5 need to receive more "1" number. In this case, will be "0" in the left. In the package, the bit will be sent like '030000' @param: bit -> bit to be setted @param: value -> value to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception It's a internal method, so don't call! """ @@ -657,10 +966,20 @@ def __setBitTypeN(self, bit, value): if len(value) > self.getBitLimit(bit): value = value[0:self.getBitLimit(bit)] - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) + + #self.__checkBitTypeValidity(bit, value) - self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)) + data_form = self.getBitFormat(bit) + + if data_form == "A": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode() + elif data_form == "E": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode('cp1148') + else: # Packed data - make sure that it's left zero-filled to the correct length- a multiple of 2 + unpacked_len = self.__getUnpackedLen(self.getBitLimit(bit)) + self.BITMAP_VALUES[bit] = binascii.unhexlify(value.zfill(unpacked_len)) ################################################################################################ @@ -669,11 +988,42 @@ def __setBitTypeN(self, bit, value): def __setBitTypeA(self, bit, value): """Method that set a bit with value in form A It complete the size of the bit with a default value - Example: pack.setBit(3,'30000') -> Bit 3 is a A type, so this bit, in ASCII form need to has size = 6 (ISO especification) so the value 30000 size = 5 need to receive more "1" number. + Example: pack.setBit(3,'30000') -> Bit 3 is a A type, so this bit, in ASCII form need to has size = 6 (ISO specification) so the value 30000 size = 5 need to receive more "1" number. + In this case, will be "0" in the left. In the package, the bit will be sent like '030000' + @param: bit -> bit to be setted + @param: value -> value to be setted + @raise: ValueTooLarge Exception + It's a internal method, so don't call! + """ + + value = "%s" % value + + if len(value) > self.getBitLimit(bit): + value = value[0:self.getBitLimit(bit)] + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) + + #self.__checkBitTypeValidity(bit, value) + + data_form = self.getBitFormat(bit) + + if data_form == "A": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode() + elif data_form == "E": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode('cp1148') + + ################################################################################################ + + ################################################################################################ + # Set of type AN + def __setBitTypeAN(self, bit, value): + """Method that set a bit with value in form AN + It complete the size of the bit with a default value + Example: pack.setBit(3,'30000') -> Bit 3 is a A type, so this bit, in ASCII form need to has size = 6 (ISO specification) so the value 30000 size = 5 need to receive more "1" number. In this case, will be "0" in the left. In the package, the bit will be sent like '030000' @param: bit -> bit to be setted @param: value -> value to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception It's a internal method, so don't call! """ @@ -681,10 +1031,17 @@ def __setBitTypeA(self, bit, value): if len(value) > self.getBitLimit(bit): value = value[0:self.getBitLimit(bit)] - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) + + #self.__checkBitTypeValidity(bit, value) - self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)) + data_form = self.getBitFormat(bit) + + if data_form == "A": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode() + elif data_form == "E": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode('cp1148') ################################################################################################ @@ -693,11 +1050,11 @@ def __setBitTypeA(self, bit, value): def __setBitTypeB(self, bit, value): """Method that set a bit with value in form B It complete the size of the bit with a default value - Example: pack.setBit(3,'30000') -> Bit 3 is a B type, so this bit, in ASCII form need to has size = 6 (ISO especification) so the value 30000 size = 5 need to receive more "1" number. + Example: pack.setBit(3,'30000') -> Bit 3 is a B type, so this bit, in ASCII form need to has size = 6 (ISO specification) so the value 30000 size = 5 need to receive more "1" number. In this case, will be "0" in the left. In the package, the bit will be sent like '030000' @param: bit -> bit to be setted @param: value -> value to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception It's a internal method, so don't call! """ @@ -705,10 +1062,18 @@ def __setBitTypeB(self, bit, value): if len(value) > self.getBitLimit(bit): value = value[0:self.getBitLimit(bit)] - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) + + data_form = self.getBitFormat(bit) - self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)) + if data_form == "A": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode() + elif data_form == "E": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode('cp1148') + else: # Packed data- ensure it is a multiple of 2. Also pad with zeros to the left if required + unpacked_len = self.__getUnpackedLen(self.getBitLimit(bit)) + self.BITMAP_VALUES[bit] = binascii.unhexlify(value.zfill(unpacked_len)) ################################################################################################ @@ -717,11 +1082,11 @@ def __setBitTypeB(self, bit, value): def __setBitTypeANS(self, bit, value): """Method that set a bit with value in form ANS It complete the size of the bit with a default value - Example: pack.setBit(3,'30000') -> Bit 3 is a ANS type, so this bit, in ASCII form need to has size = 6 (ISO especification) so the value 30000 size = 5 need to receive more "1" number. + Example: pack.setBit(3,'30000') -> Bit 3 is a ANS type, so this bit, in ASCII form need to has size = 6 (ISO specification) so the value 30000 size = 5 need to receive more "1" number. In this case, will be "0" in the left. In the package, the bit will be sent like '030000' @param: bit -> bit to be setted @param: value -> value to be setted - @raise: ValueToLarge Exception + @raise: ValueTooLarge Exception It's a internal method, so don't call! """ @@ -729,16 +1094,23 @@ def __setBitTypeANS(self, bit, value): if len(value) > self.getBitLimit(bit): value = value[0:self.getBitLimit(bit)] - raise ValueToLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( - bit, self.getBitType(bit), self.getBitLimit(bit))) + raise ValueTooLarge('Error: value up to size! Bit[%s] of type %s limit size = %s' % ( + bit, self.getBitType(bit), self.getBitLimit(bit))) - self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)) + #self.__checkBitTypeValidity(bit, value) + + data_form = self.getBitFormat(bit) + + if data_form == "A": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode() + elif data_form == "E": + self.BITMAP_VALUES[bit] = value.zfill(self.getBitLimit(bit)).encode('cp1148') ################################################################################################ ################################################################################################ # print os bits insede iso - def showIsoBits(self): + def showIsoBits(self, showall=False): """Method that show in detail a list of bits , values and types inside the object Example: output to (...) @@ -752,10 +1124,13 @@ def showIsoBits(self): (...) """ - for cont in range(0, 129): + for cont in range(1, 129): if self.BITMAP_VALUES[cont] != self._BIT_DEFAULT_VALUE: print("Bit[%s] of type %s has limit %s = %s" % ( - cont, self.getBitType(cont), self.getBitLimit(cont), self.BITMAP_VALUES[cont])) + cont, self.getBitType(cont), self.getBitLimit(cont), self.BITMAP_VALUES[cont])) + elif showall is True: + print("Bit[%s] of type %s has limit %s" % ( + cont, self.getBitType(cont), self.getBitLimit(cont))) ################################################################################################ @@ -783,7 +1158,7 @@ def showRawIso(self): ################################################################################################ # Return raw iso - def getRawIso(self): + def getRawIso(self, nohdr=False): """Method that return ISO8583 ASCII complete representation Example: iso = ISO8583() @@ -803,17 +1178,26 @@ def getRawIso(self): self.__buildBitmap() - if self.MESSAGE_TYPE_INDICATION == '': + if self.MESSAGE_TYPE_INDICATION == b'': raise InvalidMTI('Check MTI! Do you set it?') - resp = ""; + # Start with the header, if set (or b'' if not) + if nohdr is True: + resp = b'' + else: + resp = self.hdr resp += self.MESSAGE_TYPE_INDICATION - resp += self.BITMAP_HEX + if self.BITMAP_format == 'A': + resp += self.BITMAP_HEX + elif self.BITMAP_format == 'E': + resp += self.BITMAP_HEX.decode().encode('cp1148') + else: + resp += binascii.unhexlify(self.BITMAP_HEX) for cont in range(0, 129): if self.BITMAP_VALUES[cont] != self._BIT_DEFAULT_VALUE: - resp = "%s%s" % (resp, self.BITMAP_VALUES[cont]) + resp = resp + self.BITMAP_VALUES[cont] return resp @@ -821,48 +1205,60 @@ def getRawIso(self): ################################################################################################ # Redefine a bit - def redefineBit(self, bit, smallStr, largeStr, bitType, size, valueType): + def redefineBit(self, bit, smallStr, largeStr, bitType, LenForm, size, valueType, format): """Method that redefine a bit structure in global scope! Can be used to personalize ISO8583 structure to another specification (ISO8583 1987 for example!) - Hint: If you have a lot of "ValueToLarge Exception" maybe the especification that you are using is different of mine. So you will need to use this method :) + Hint: If you have a lot of "ValueTooLarge Exception" maybe the specification that you are using is different of mine. So you will need to use this method :) @param: bit -> bit to be redefined @param: smallStr -> a small String representantion of the bit, used to build "user friendly prints", example "2" for bit 2 @param: largeStr -> a large String representantion of the bit, used to build "user friendly prints" and to be used to inform the "main use of the bit", example "Primary account number (PAN)" for bit 2 - @param: bitType -> type the bit, used to build the values, example "LL" for bit 2. Need to be one of (B, N, AN, ANS, LL, LLL) + @param: bitType -> type the bit, used to build the values, example "LL" for bit 2. Need to be one of (B, N, AN, ANS, LL, LLL, LLLLLL) + @param: LenForm -> Length indicator format for LL and LLL fields- 'A' for ASCII, 'B' for BCD, 'P' for packed hex or '-' if bitType not LL or LLL @param: size -> limit size the bit, used to build/complete the values, example "19" for bit 2. @param: valueType -> value type the bit, used to "validate" the values, example "n" for bit 2. This mean that in bit 2 we need to have only numeric values. - Need to be one of (a, an, n, ansb, b) - @raise: BitInexistent Exception, InvalidValueType Exception + Need to be one of (a, an, n, ans, b) + @param: format -> format of the bit, encode/decode the values- 'A' for ASCII, 'E' for EBCDIC. + @raise: BitNonexistent Exception, InvalidValueType Exception """ - if self.DEBUG == True: - print('Trying to redefine the bit with (self,%s,%s,%s,%s,%s,%s)' % ( - bit, smallStr, largeStr, bitType, size, valueType)) + if self.DEBUG is True: + print('Trying to redefine the bit with (self,%s,%s,%s,%s,%s,%s,%s,%s)' % ( + bit, smallStr, largeStr, bitType, LenForm, size, valueType, format)) # validating bit position - if bit == 1 or bit == 64 or bit < 0 or bit > 128: - raise BitInexistent("Error %d cannot be changed because has a invalid number!" % bit) + if bit == 1 or bit < 0 or bit > 128: + raise BitNonexistent( + "Error %d cannot be changed because has a invalid number!" % bit) - # need to validate if the type and size is compatible! example slimit = 100 and type = LL + if bitType != "B" and bitType != "N" and bitType != "A" and bitType != "AN" and bitType != "ANS" and bitType != "LL" and bitType != "LLL" and bitType != "LLLLLL": + raise InvalidBitType( + "Error bit %d cannot be changed because %s is not a valid bitType (B, N, A, AN, ANS, LL, LLL)!" % ( + bit, bitType)) - if bitType == "B" or bitType == "N" or bitType == "AN" or bitType == "ANS" or bitType == "LL" or bitType == "LLL": - if valueType == "a" or valueType == "n" or valueType == "ansb" or valueType == "ans" or valueType == "b" or valueType == "an": - self._BITS_VALUE_TYPE[bit] = [smallStr, largeStr, bitType, size, valueType] - if self.DEBUG == True: - print('Bit %d redefined!' % bit) + if LenForm != '-' and bitType != "LL" and bitType != "LLL" and bitType != "LLLLLL": + raise InvalidLenForm("Error %d cannot be changed because has an invalid LenForm!" % bit) - else: - raise InvalidValueType( - "Error bit %d cannot be changed because %s is not a valid valueType (a, an, n ansb, b)!" % ( + if LenForm != '-' and LenForm != 'A' and LenForm != 'E' and LenForm != 'B' and LenForm != 'P': + raise InvalidLenForm("Error %d cannot be changed because has an invalid %s LenForm!" % (bit, LenForm)) + + # need to validate if the type and size is compatible! example slimit = 100 and type = LL + + if valueType != "a" and valueType != "n" and valueType != "ans" and valueType != "b" and valueType != "an": + raise InvalidValueType( + "Error bit %d cannot be changed because %s is not a valid valueType (a, an, n ans, b)!" % ( bit, valueType)) - # return - else: - raise InvalidBitType( - "Error bit %d cannot be changed because %s is not a valid bitType (Hex, N, AN, ANS, LL, LLL)!" % ( - bit, bitType)) - # return + + if format != 'A' and format != 'E' and format != 'P': + raise InvalidFormat("Error %d cannot be changed because has an invalid %s format!" % (bit, format)) + + if format == 'P' and bitType != 'B' and bitType != 'N' and bitType != 'LL' and bitType != 'LLL' and bitType != 'LLLLLL': + raise InvalidFormat("Error %d cannot be changed because has an invalid %s format (cannot be packed)!" % (bit, format)) + self._BITS_VALUE_TYPE[bit] = [smallStr, largeStr, bitType, LenForm, size, valueType, format] + + if self.DEBUG is True: + print('Bit %d redefined!' % bit) ################################################################################################ @@ -873,9 +1269,12 @@ def __setMTIFromStr(self, iso): It's a internal method, so don't call! """ - self.MESSAGE_TYPE_INDICATION = iso[0:4] + if self.MTI_format == 'A' or self.MTI_format == 'E': + self.MESSAGE_TYPE_INDICATION = iso[0:4] + else: + self.MESSAGE_TYPE_INDICATION = iso[0:2] - if self.DEBUG == True: + if self.DEBUG is True: print('MTI found was %s' % self.MESSAGE_TYPE_INDICATION) ################################################################################################ @@ -888,7 +1287,12 @@ def getMTI(self): """ # Need to validate if the MTI was setted ...etc ... - return self.MESSAGE_TYPE_INDICATION + if self.MTI_format == 'A': + return self.MESSAGE_TYPE_INDICATION.decode() + elif self.MTI_format == 'E': + return self.MESSAGE_TYPE_INDICATION.decode('cp1148') + else: + return binascii.hexlify(self.MESSAGE_TYPE_INDICATION).decode() ################################################################################################ @@ -898,8 +1302,7 @@ def getBitmap(self): """Method that return the ASCII Bitmap of the package @return: str -> with the ASCII Bitmap """ - if self.BITMAP_HEX == '': - self.__buildBitmap() + self.__buildBitmap() return self.BITMAP_HEX @@ -915,6 +1318,47 @@ def getValuesArray(self): ################################################################################################ + ################################################################################################ + + def __raiseValueTypeError(self, bit): + """ Raise a type error exception + @param: bit -> bit that caused the error + @raises: InvalidValueType -> exception with message according to + type error + """ + raise InvalidValueType( + 'Error: value of type %s has invalid type' % (self.getBitType(bit)) + ) + + ################################################################################################ + + ################################################################################################ + + def __checkBitTypeValidity(self, bit, value): + """ Verify that a bit's value has the correct type + @param: bit -> bit to be validated + @param: value -> bit's value as a string + @raises: InvalidValueType -> exception with message according to + type error + """ + + bitType = self.getBitValueType(bit) + + if bitType == 'a': + if not all(x.isspace() or x.isalpha() for x in value): + self.__raiseValueTypeError(bit) + elif bitType == 'n': + if not value.isdecimal(): + self.__raiseValueTypeError(bit) + elif bitType == 'an': + if not all(x.isspace() or x.isalnum() for x in value): + self.__raiseValueTypeError(bit) + + # No exceptions raised, return + return True + + ################################################################################################ + ################################################################################################ # Receive a str and interpret it to bits and values def __getBitFromStr(self, strWithoutMtiBitmap): @@ -923,68 +1367,241 @@ def __getBitFromStr(self, strWithoutMtiBitmap): It's a internal method, so don't call! """ - if self.DEBUG == True: + if self.DEBUG is True: print('This is the input string <%s>' % strWithoutMtiBitmap) - offset = 0; - # jump bit 1 because it was alread defined in the "__inicializeBitsFromBitmapStr" + offset = 0 + # jump bit 1 because it was alread defined in the "__initializeBitsFromBitmapStr" for cont in range(2, 129): if self.BITMAP_VALUES[cont] != self._BIT_DEFAULT_VALUE: - if self.DEBUG == True: - print('String = %s offset = %s bit = %s' % (strWithoutMtiBitmap[offset:], offset, cont)) - - if self.getBitType(cont) == 'LL': - valueSize = int(strWithoutMtiBitmap[offset:offset + 2]) - if self.DEBUG == True: + if self.DEBUG is True: + print('String = %s offset = %s bit = %s' % + (strWithoutMtiBitmap[offset:], offset, cont)) + + bitType = self.getBitType(cont) + lenform = self.getBitLenForm(cont) + + if bitType == 'LL': + if lenform == 'A': + lenoffset = 2 + valueSize = int(strWithoutMtiBitmap[offset:offset + lenoffset]) + elif lenform == 'E': + lenoffset = 2 + valueSize = int(strWithoutMtiBitmap[offset:offset + lenoffset].decode('cp1148')) + elif lenform == 'P': + lenoffset = 1 + valueSize = self.__LLPackToInt(strWithoutMtiBitmap[offset:offset + lenoffset]) + else: # 'B'(CD) + lenoffset = 1 + valueSize = self.__LLBCDToInt(strWithoutMtiBitmap[offset:offset + lenoffset]) + + if self.DEBUG is True: print('Size of the message in LL = %s' % valueSize) if valueSize > self.getBitLimit(cont): - print('This bit is larger thant the specification.') - # raise ValueToLarge("This bit is larger than the especification!") - - self.BITMAP_VALUES[cont] = strWithoutMtiBitmap[offset:offset + 2] + strWithoutMtiBitmap[ - offset + 2:offset + 2 + valueSize] + print('This bit is larger than the specification.') + # raise ValueTooLarge("This bit is larger than the specification!") + + if self.getBitFormat(cont) == 'P': + modvalueSize = self.__getPackedLen(valueSize) + else: # ASCII and EBCDIC have the same length + modvalueSize = valueSize + + self.BITMAP_VALUES[cont] = strWithoutMtiBitmap[offset:offset+lenoffset] + strWithoutMtiBitmap[ + offset+lenoffset:offset+lenoffset+ modvalueSize] + + if self.DEBUG is True: + print('\tSetting bit %s value %s' % + (cont, self.BITMAP_VALUES[cont])) + + offset += modvalueSize + lenoffset + + elif bitType == 'LLL': + if lenform == 'A': + lenoffset = 3 + valueSize = int(strWithoutMtiBitmap[offset:offset + lenoffset]) + elif lenform == 'E': + lenoffset = 3 + valueSize = int(strWithoutMtiBitmap[offset:offset + lenoffset].decode('cp1148')) + elif lenform == 'P': + lenoffset = 2 + valueSize = self.__LLLPackToInt(strWithoutMtiBitmap[offset:offset + lenoffset]) + else: # 'B'(CD) + lenoffset = 2 + valueSize = self.__LLLBCDToInt(strWithoutMtiBitmap[offset:offset + lenoffset]) + + if self.DEBUG is True: + print('Size of the message in LLL = %s' % valueSize) - if self.DEBUG == True: - print('\tSetting bit %s value %s' % (cont, self.BITMAP_VALUES[cont])) + if valueSize > self.getBitLimit(cont): + raise ValueTooLarge( + "This bit is larger than the specification!") - # fix for AppZone - their responses don't comply with specifications - if cont == 33: - offset += valueSize + 2 # replace with 17 if it fails + if self.getBitFormat(cont) == 'P': + modvalueSize = self.__getPackedLen(valueSize) else: - offset += valueSize + 2 - - if self.getBitType(cont) == 'LLL': - valueSize = int(strWithoutMtiBitmap[offset:offset + 3]) - if self.DEBUG == True: - print('Size of the message in LLL = %s' % valueSize) + modvalueSize = valueSize + + self.BITMAP_VALUES[cont] = strWithoutMtiBitmap[offset:offset+lenoffset] + strWithoutMtiBitmap[ + offset+lenoffset:offset+lenoffset+modvalueSize] + + if self.DEBUG is True: + print('\tSetting bit %s value %s' % + (cont, self.BITMAP_VALUES[cont])) + + offset += modvalueSize + lenoffset + + elif bitType == 'LLLLLL': + if lenform == 'A': + lenoffset = 6 + valueSize = int(strWithoutMtiBitmap[offset:offset + lenoffset]) + elif lenform == 'E': + lenoffset = 6 + valueSize = int(strWithoutMtiBitmap[offset:offset + lenoffset].decode('cp1148')) + elif lenform == 'P': + lenoffset = 3 + valueSize = self.__LLLLLLPackToInt(strWithoutMtiBitmap[offset:offset + lenoffset]) + else: # 'B'(CD) + lenoffset = 3 + valueSize = self.__LLLLLLBCDToInt(strWithoutMtiBitmap[offset:offset + lenoffset]) + + if self.DEBUG is True: + print('Size of the message in LLLLLL = %s' % valueSize) if valueSize > self.getBitLimit(cont): - raise ValueToLarge("This bit is larger than the especification!") - self.BITMAP_VALUES[cont] = strWithoutMtiBitmap[offset:offset + 3] + strWithoutMtiBitmap[ - offset + 3:offset + 3 + valueSize] + raise ValueTooLarge( + "This bit is larger than the specification!") + + if self.getBitFormat(cont) == 'P': + modvalueSize = self.__getPackedLen(valueSize) + else: + modvalueSize = valueSize + + self.BITMAP_VALUES[cont] = strWithoutMtiBitmap[offset:offset+lenoffset] + strWithoutMtiBitmap[ + offset+lenoffset:offset+lenoffset+modvalueSize] - if self.DEBUG == True: - print('\tSetting bit %s value %s' % (cont, self.BITMAP_VALUES[cont])) + if self.DEBUG is True: + print('\tSetting bit %s value %s' % + (cont, self.BITMAP_VALUES[cont])) - offset += valueSize + 3 + offset += modvalueSize + lenoffset # if self.getBitType(cont) == 'LLLL': # valueSize = int(strWithoutMtiBitmap[offset:offset +4]) # if valueSize > self.getBitLimit(cont): - # raise ValueToLarge("This bit is larger than the especification!") + # raise ValueTooLarge("This bit is larger than the specification!") # self.BITMAP_VALUES[cont] = '(' + strWithoutMtiBitmap[offset:offset+4] + ')' + strWithoutMtiBitmap[offset+4:offset+4+valueSize] # offset += valueSize + 4 - if self.getBitType(cont) == 'N' or self.getBitType(cont) == 'A' or self.getBitType( - cont) == 'ANS' or self.getBitType(cont) == 'B' or self.getBitType(cont) == 'AN': - self.BITMAP_VALUES[cont] = strWithoutMtiBitmap[offset:self.getBitLimit(cont) + offset] + elif bitType == 'N' or bitType == 'A' or bitType == 'ANS' or \ + bitType == 'B' or bitType == 'AN': + + origvalueSize = self.getBitLimit(cont) + + if self.getBitFormat(cont) == 'P': + modvalueSize = self.__getPackedLen(origvalueSize) + else: + modvalueSize = origvalueSize + + value = strWithoutMtiBitmap[offset:modvalueSize + offset] - if self.DEBUG == True: - print('\tSetting bit %s value %s' % (cont, self.BITMAP_VALUES[cont])) + #self.__checkBitTypeValidity(cont, value) + self.BITMAP_VALUES[cont] = value - offset += self.getBitLimit(cont) + if self.DEBUG is True: + print('\tSetting bit %s value %s' % + (cont, self.BITMAP_VALUES[cont])) + offset += modvalueSize + + ################################################################################################ + + ################################################################################################ + #Parse a Int to LLBCD length + def __IntToLLBCD(self,LLlen_int): + return binascii.unhexlify('{0:02d}'.format(int(LLlen_int))) + ################################################################################################ + + ################################################################################################ + #Parse a LLBCD length to Int + def __LLBCDToInt(self,LLlen_bcd): + return LLlen_bcd[0]//16 * 10 + LLlen_bcd[0]%16 + ################################################################################################ + + ################################################################################################ + #Parse a Int to LLLBCD length + def __IntToLLLBCD(self,LLLlen_int): + return binascii.unhexlify('{0:04d}'.format(int(LLLlen_int))) + ################################################################################################ + + ################################################################################################ + #Parse a LLLBCD length to Int + def __LLLBCDToInt(self,LLLlen_bcd): + return LLLlen_bcd[0]%16*100 + LLLlen_bcd[1]//16*10 + LLLlen_bcd[1]%16 + ################################################################################################ + + ################################################################################################ + #Parse a Int to LLLLLLBCD length + def __IntToLLLLLLBCD(self,LLLLLLlen_int): + return binascii.unhexlify('{0:06d}'.format(int(LLLLLLlen_int))) + ################################################################################################ + + ################################################################################################ + #Parse a LLLLLLBCD length to Int + def __LLLLLLBCDToInt(self,LLLLLLlen_bcd): + return LLLLLLlen_bcd[0]//16*100000 + LLLLLLlen_bcd[0]%16*10000 + LLLLLLlen_bcd[1]//16*1000 + LLLLLLlen_bcd[1]%16*100 + LLLLLLlen_bcd[2]//16*10 + LLLLLLlen_bcd[2]%16 + ################################################################################################ + + ################################################################################################ + #Parse a Int to LLPack length + def __IntToLLPack(self,LLlen_int): + return binascii.unhexlify('{0:02x}'.format(int(LLlen_int))) + ################################################################################################ + + ################################################################################################ + #Parse a Int to LLLPack length + def __IntToLLLPack(self,LLLlen_int): + return binascii.unhexlify('{0:04x}'.format(int(LLLlen_int))) + ################################################################################################ + + ################################################################################################ + #Parse a Int to LLLLLLPack length + def __IntToLLLLLLPack(self,LLLLLLlen_int): + return binascii.unhexlify('{0:06x}'.format(int(LLLLLLlen_int))) + ################################################################################################ + + ################################################################################################ + #Parse a LLPack length to Int + def __LLPackToInt(self,LLlen_pack): + return LLlen_pack[0] + ################################################################################################ + + ################################################################################################ + #Parse a LLLPack length to Int + def __LLLPackToInt(self,LLLlen_pack): + return LLLlen_pack[0]%16*256 + LLLlen_pack[1] + ################################################################################################ + + ################################################################################################ + #Parse a LLLLLLPack length to Int + def __LLLLLLPackToInt(self,LLLLLLlen_pack): + return LLLLLLlen_pack[0]*256*256 + LLLLLLlen_pack[1]*256 + LLLLLLlen_pack[2] + ################################################################################################ + + ################################################################################################ + #Get packed equivalent size + def __getPackedLen(self,origlen): + if origlen % 2 == 0: + packed_len = int(origlen/2) + else: + packed_len = int((origlen+1)/2) + return packed_len + ################################################################################################ + + ################################################################################################ + #Get packed equivalent size + def __getUnpackedLen(self,origlen): + return self.__getPackedLen(origlen)*2 ################################################################################################ ################################################################################################ @@ -994,9 +1611,9 @@ def setIsoContent(self, iso): Example: iso = '0210B238000102C080040000000000000002100000000000001700010814465469421614465701081100301000000N399915444303500019991544986020 Value not allowed009000095492' i2 = ISO8583() - # in this case, we need to redefine a bit because default bit 42 is LL and in this especification is "N" + # in this case, we need to redefine a bit because default bit 42 is LL and in this specification is "N" # the rest remain, so we use "get" :) - i2.redefineBit(42, '42', i2.getLargeBitName(42), 'N', i2.getBitLimit(42), i2.getBitValueType(42) ) + i2.redefineBit(42, i2.getSmallBitName(42), i2.getLargeBitName(42), 'N', i2.getBitLenForm(42), i2.getBitLimit(42), i2.getBitValueType(42), i2.getBitFormat(42) ) i2.setIsoContent(iso2) print ('Bitmap = %s' %i2.getBitmap()) print ('MTI = %s' %i2.getMTI() ) @@ -1009,20 +1626,45 @@ def setIsoContent(self, iso): @param: str -> complete ISO8583 string @raise: InvalidIso8583 Exception """ - if len(iso) < 20: + + if self.MTI_format == 'A' or self.MTI_format == 'E': + mti_len = 4 + else: + mti_len = 2 + + if self.BITMAP_format == 'A' or self.BITMAP_format == 'E': + bitmap_min_size = 16 + else: + bitmap_min_size = 8 + + if len(iso) < (mti_len + bitmap_min_size + self.hdrlen): raise InvalidIso8583('This is not a valid iso!!') - if self.DEBUG == True: + if self.DEBUG is True: print('ASCII to process <%s>' % iso) - self.__setMTIFromStr(iso) - isoT = iso[4:] + if self.hdrlen > 0: + self.hdr = iso[0:self.hdrlen] + if self.DEBUG is True: + print('Header found was %s' % self.hdr) + + self.__setMTIFromStr(iso[self.hdrlen:]) + if self.MTI_format == 'A' or self.MTI_format == 'E': + isoT = iso[self.hdrlen + 4:] + else: + isoT = iso[self.hdrlen + 2:] self.__getBitmapFromStr(isoT) - self.__inicializeBitsFromBitmapStr(self.BITMAP_HEX) - if self.DEBUG == True: - print('This is the array of bits (before) %s ' % self.BITMAP_VALUES) + self.__initializeBitsFromBitmapStr(self.BITMAP_HEX) + if self.DEBUG is True: + print('This is the array of bits (before) %s ' % + self.BITMAP_VALUES) + + if self.BITMAP_format == 'A' or self.BITMAP_format == 'E': + bitmap_size = len(self.BITMAP_HEX) + else: + bitmap_size = int(len(self.BITMAP_HEX)/2) - self.__getBitFromStr(iso[4 + len(self.BITMAP_HEX):]) - if self.DEBUG == True: + self.__getBitFromStr(iso[self.hdrlen + mti_len + bitmap_size:]) + if self.DEBUG is True: print('This is the array of bits (after) %s ' % self.BITMAP_VALUES) ################################################################################################ @@ -1057,7 +1699,7 @@ def __cmp__(self, obj2): """ ret = -1 # By default is different if (self.getMTI() == obj2.getMTI()) and (self.getBitmap() == obj2.getBitmap()) and ( - self.getValuesArray() == obj2.getValuesArray()): + self.getValuesArray() == obj2.getValuesArray()): ret = 0 return ret @@ -1095,7 +1737,8 @@ def getBitsAndValues(self): _TMP = {} _TMP['bit'] = "%d" % cont _TMP['type'] = self.getBitType(cont) - _TMP['value'] = self.BITMAP_VALUES[cont] + _TMP['value(raw)'] = self.BITMAP_VALUES[cont] + _TMP['value(decoded)'] = self.getBit(cont) ret.append(_TMP) return ret @@ -1106,32 +1749,116 @@ def getBitsAndValues(self): def getBit(self, bit): """Return the value of the bit @param: bit -> the number of the bit that you want the value - @raise: BitInexistent Exception, BitNotSet Exception + @raise: BitNonexistent Exception, BitNotSet Exception """ if bit < 1 or bit > 128: - raise BitInexistent("Bit number %s dosen't exist!" % bit) + raise BitNonexistent("Bit number %s dosen't exist!" % bit) # Is that bit set? isThere = False arr = self.__getBitsFromBitmap() - if self.DEBUG == True: + if self.DEBUG is True: print('This is the array of bits inside the bitmap %s' % arr) for v in arr: if v == bit: + bitType = self.getBitType(bit) value = self.BITMAP_VALUES[bit] + lenform = self.getBitLenForm(bit) + if bitType == 'LL': + if lenform == 'A': + offset = 2 + valueSize = int(value[0:0+offset]) + elif lenform == 'E': + offset = 2 + valueSize = int(value[0:0+offset].decode('cp1148')) + elif lenform == 'P': + offset = 1 + valueSize = self.__LLPackToInt(value[0:0+offset]) + else: # B(CD) + offset = 1 + valueSize = self.__LLBCDToInt(value[0:0+offset]) + elif bitType == 'LLL': + if lenform == 'A': + offset = 3 + valueSize = int(value[0:0+offset]) + elif lenform == 'E': + offset = 3 + valueSize = int(value[0:0+offset].decode('cp1148')) + elif lenform == 'P': + offset = 2 + valueSize = self.__LLLPackToInt(value[0:0+offset]) + else: # B(CD) + offset = 2 + valueSize = self.__LLLBCDToInt(value[0:0+offset]) + else: # Fixed length field + offset = 0 + isThere = True break if isThere: - return value + data_form = self.getBitFormat(bit) + if data_form == "A": + return value[offset:].decode() + elif data_form == "E": + return value[offset:].decode('cp1148') + else: # Must be packed, so has possible padding to be stripped + unpacked_data = binascii.hexlify(value[offset:]) + if bitType == 'LL' or bitType == 'LLL': + return unpacked_data[0:valueSize].decode() + else: # Must be bitType 'N' or 'B'- possibly left-padded with a zero + if self.getBitLimit(bit) % 2 == 0: + return unpacked_data[0:].decode() + else: # Skip the leading padding '0' + return unpacked_data[1:].decode() else: raise BitNotSet("Bit number %s was not set!" % bit) ################################################################################################ + ################################################################################################ + # Method that returns a timestamp in YYMMDDhhmmss format + def getYYMMDDhhmmss(self): + """Return the current date/time in YYMMDDhhmmss format + """ + return time.strftime('%y%m%d%H%M%S') + ################################################################################################ + + ################################################################################################ + # Method that return a timestamp in MMDDhhmmss format + def getMMDDhhmmss(self): + """Return the current date/time in MMDDhhmmss format + """ + return time.strftime('%m%d%H%M%S') + ################################################################################################ + + ################################################################################################ + # Method that return a timestamp in YYMMDD format + def getYYMMDD(self): + """Return the current date in YYMMDD format + """ + return time.strftime('%y%m%d') + ################################################################################################ + + ################################################################################################ + # Method that return a timestamp in MMDD format + def getMMDD(self): + """Return the current date in MMDD format + """ + return time.strftime('%m%d') + ################################################################################################ + + ################################################################################################ + # Method that return a timestamp in hhmmss format + def gethhmmss(self): + """Return the current date in hhmmss format + """ + return time.strftime('%H%M%S') + ################################################################################################ + ################################################################################################ # Method that return ISO8583 to TCPIP network form, with the size in the beginning. def getNetworkISO(self, bigEndian=True): @@ -1157,16 +1884,16 @@ def getNetworkISO(self, bigEndian=True): @raise: InvalidMTI Exception """ - netIso = "" + netIso = "".encode() asciiIso = self.getRawIso() if bigEndian: netIso = struct.pack('!h', len(asciiIso)) - if self.DEBUG == True: + if self.DEBUG is True: print('Pack Big-endian') else: netIso = struct.pack(' - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - 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 . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST b/MANIFEST index a468b01..713bc94 100755 --- a/MANIFEST +++ b/MANIFEST @@ -1,18 +1,17 @@ -INSTALL -LICENCE -README -TODO -setup.py -ISO8583\ISO8583.py -ISO8583\ISOErrors.py -ISO8583\__init__.py -doc\ISO8583.ISO8583.html -doc\ISO8583.ISOErrors.html -doc\ISO8583.html -doc\index.html -examples\echoClient.py -examples\echoServer.py -examples\example1.py -examples\example2.py -examples\example3.py -examples\example4.py +# file GENERATED by distutils, do NOT edit +INSTALL +README +TODO +setup.py +ISO8583/ISO8583.py +ISO8583/ISOErrors.py +ISO8583/__init__.py +doc/ISO8583.ISO8583.html +doc/ISO8583.ISOErrors.html +doc/ISO8583.html +examples/echoClient.py +examples/echoServer.py +examples/example1.py +examples/example2.py +examples/example3.py +examples/example4.py diff --git a/MANIFEST.in b/MANIFEST.in index 8d3cb63..1266927 100755 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,7 +2,4 @@ include INSTALL include LICENCE include TODO include doc/* -include examples/* -prune .bzr -prune examples/*UT* -prune examples/*test* \ No newline at end of file +include examples/* \ No newline at end of file diff --git a/README b/README index e91db10..549ac86 100755 --- a/README +++ b/README @@ -26,4 +26,11 @@ along with this program. If not, see . 3) That's it! -======================================================================== \ No newline at end of file +======================================================================== + + +Contributors: + - [Gia Duong Duc Minh](https://github.com/ducminhgd) + - [Le Tuan Dat](https://github.com/dat07cs) + - [R2RITO](https://github.com/R2RITO) + - Andrew Calkin andrew.calkin@gmail.com \ No newline at end of file diff --git a/TODO b/TODO old mode 100755 new mode 100644 index dab2058..e59be41 --- a/TODO +++ b/TODO @@ -1,74 +1,74 @@ -Add: - - - create a unsetBit(bitNumber) method to delete a value of a bit inside the object - - - create a ISO8583Util Class that give some util method like: - - intToBCD - - BCDToInt - - getTimeGMT (to bit 12) - - GetDateType (to bit 13) - -Fix: - - - ... - -Think about: - - - Improve ... improve ... improve - - - Add support to "BCD" sizes in LL LLL types. - ASCII LL size and ASCII value inside '123456' -> '06123456' - BCD LL size and ASCII value inside '123456' -> '\x06' + '123456' - ASCII LLL size and ASCII value inside '123456' -> '006123456' - BCD LLL size and ASCII value inside '123456' -> '\x00\x06' + '123456' - - - Improve support to "binary" data - i.setBit(3,'\x00\x01\x02') - - - Make sense setBit(1,'xxx') ? - Maybe the dialet need to have the 2º bitmap inside with no value because it's automatic that 2º be present when bit large than 64 is inside... - But .. Today work :) by the way ... xxx is ignored... - - - It's important separate the size and the value of LL and LLL types? - Example, bit 2 is LL: - Today -> i.setBit(2,'123') -> i.getBit(2) -> 03123 - Think -> i.setBit(2,'123') -> i.getBit(2) -> 123 - It was build in this way because the size can be important in some cases, but we can determine the size len(i.getBit(2)) ... - If the partner send a ISO8583 with wrong size? - - - Make a XML builder that convert a ISO8583 to a XML object and a XML to ISO8583... - - 0200 - 600000000000000 - - - 2 - 03123 - LL - - - 3 - 300000 - N - - - - - - Use log4Python to improve debug information - - - Support Python V3 - - - Improve errors: - - validate values - - - Improve the package name / structure - - today: FROM ISO8583.ISO8583 import ISO8583 - - future: FROM iso8583 import ISO8583 - - - Create more examples - - - Create benchmarks with JPOS - - - Support EBCDIC ... - +Add: + + - create a unsetBit(bitNumber) method to delete a value of a bit inside the object + + - create a ISO8583Util Class that give some util method like: + - intToBCD + - BCDToInt + - getTimeGMT (to bit 12) + - GetDateType (to bit 13) + +Fix: + + - ... + +Think about: + + - Improve ... improve ... improve + + - Add support to "BCD" sizes in LL LLL types. + ASCII LL size and ASCII value inside '123456' -> '06123456' + BCD LL size and ASCII value inside '123456' -> '\x06' + '123456' + ASCII LLL size and ASCII value inside '123456' -> '006123456' + BCD LLL size and ASCII value inside '123456' -> '\x00\x06' + '123456' + + - Improve support to "binary" data + i.setBit(3,'\x00\x01\x02') + + - Make sense setBit(1,'xxx') ? + Maybe the dialet need to have the 2º bitmap inside with no value because it's automatic that 2º be present when bit large than 64 is inside... + But .. Today work :) by the way ... xxx is ignored... + + - It's important separate the size and the value of LL and LLL types? + Example, bit 2 is LL: + Today -> i.setBit(2,'123') -> i.getBit(2) -> 03123 + Think -> i.setBit(2,'123') -> i.getBit(2) -> 123 + It was build in this way because the size can be important in some cases, but we can determine the size len(i.getBit(2)) ... + If the partner send a ISO8583 with wrong size? + + - Make a XML builder that convert a ISO8583 to a XML object and a XML to ISO8583... + + 0200 + 600000000000000 + + + 2 + 03123 + LL + + + 3 + 300000 + N + + + + + - Use log4Python to improve debug information + + - Support Python V3 + + - Improve errors: + - validate values + + - Improve the package name / structure + - today: FROM ISO8583.ISO8583 import ISO8583 + - future: FROM iso8583 import ISO8583 + + - Create more examples + + - Create benchmarks with JPOS + + - Support EBCDIC ... + - ... \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9d33278 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +ebcdic==0.7.0 diff --git a/setup.py b/setup.py index a3cc6f4..d1be970 100755 --- a/setup.py +++ b/setup.py @@ -1,75 +1,13 @@ -#!/usr/bin/env python - -from distutils.core import setup - -setup(name='ISO8583-Module', - version='1.3', - description='ISO8583 LIBRARY', - author='Igor V. Custodio', - author_email='igorvc@vulcanno.com.br', - url='http://www.vulcanno.com.br/python', - download_url='http://code.google.com/p/iso8583py/downloads/list', - packages=['ISO8583'], - classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'Environment :: Console', - 'Intended Audience :: Financial and Insurance Industry', - 'Intended Audience :: Telecommunications Industry', - 'Intended Audience :: Developers', - 'License :: OSI Approved :: GNU General Public License (GPL)', - 'Operating System :: OS Independent', - 'Operating System :: Microsoft', - 'Operating System :: POSIX :: Linux', - 'Operating System :: Unix', - 'Operating System :: MacOS', - 'Programming Language :: Python', - 'Topic :: Office/Business :: Financial', - 'Topic :: Office/Business :: Financial :: Point-Of-Sale', - 'Topic :: Communications', - 'Natural Language :: Arabic', - 'Natural Language :: Bulgarian', - 'Natural Language :: Catalan', - 'Natural Language :: Chinese (Simplified)', - 'Natural Language :: Chinese (Traditional)', - 'Natural Language :: Czech', - 'Natural Language :: Danish', - 'Natural Language :: Dutch', - 'Natural Language :: English', - 'Natural Language :: Esperanto', - 'Natural Language :: Finnish', - 'Natural Language :: French', - 'Natural Language :: German', - 'Natural Language :: Greek', - 'Natural Language :: Hebrew', - 'Natural Language :: Hungarian', - 'Natural Language :: Indonesian', - 'Natural Language :: Italian', - 'Natural Language :: Japanese', - 'Natural Language :: Korean', - 'Natural Language :: Latvian', - 'Natural Language :: Marathi', - 'Natural Language :: Persian', - 'Natural Language :: Polish', - 'Natural Language :: Portuguese', - 'Natural Language :: Portuguese (Brazilian)', - 'Natural Language :: Romanian', - 'Natural Language :: Russian', - 'Natural Language :: Slovak', - 'Natural Language :: Spanish', - 'Natural Language :: Swedish', - 'Natural Language :: Telugu', - 'Natural Language :: Thai', - 'Natural Language :: Turkish', - 'Natural Language :: Ukranian', - 'Natural Language :: Vietnamese ', - 'Programming Language :: Python :: 2.5', - 'Programming Language :: Python :: 2.6', - 'Programming Language :: Python :: 2.7', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.0', - 'Programming Language :: Python :: 3.1', - 'Programming Language :: Python :: 3.2' - - ] - ) +from setuptools import setup +from ISO8583.ISO8583 import __version__ +setup( + name='ISO8583', + version=__version__, + description='ISO8583 LIBRARY', + author='Gia Duong Duc Minh', + author_email='giaduongducminh@gmail.com', + url='https://github.com/ducminhgd/python-ISOMessage8583', + packages=['ISO8583'], + keywords='ISO8583' +)