├── example
    ├── shared
    │   ├── bin
    │   │   └── .gitkeep
    │   ├── utils
    │   │   ├── delay.ts
    │   │   ├── handleError.ts
    │   │   ├── index.ts
    │   │   ├── askQuestion.ts
    │   │   └── messages.ts
    │   └── config
    │   │   └── index.ts
    ├── basic
    │   └── index.ts
    ├── README.md
    └── client
    │   ├── index.ts
    │   └── client.ts
├── src
    ├── utils
    │   ├── index.ts
    │   └── createPromise.ts
    ├── types.ts
    └── index.ts
├── .github
    └── assets
    │   ├── usage.gif
    │   └── config-exemplos.png
├── .env.example
├── .prettierrc.js
├── .editorconfig
├── lib
    ├── promises
    │   ├── promises.hpp
    │   ├── verificarPresencaPromise.cpp
    │   ├── promiseWorker.cpp
    │   ├── leSimNaoPromise.cpp
    │   ├── escreverMensagemPromise.cpp
    │   ├── finalizaFuncaoPromise.cpp
    │   ├── configPromise.cpp
    │   ├── iniciaFuncaoPromise.cpp
    │   └── continuaFuncaoPromise.cpp
    ├── nodesitef.hpp
    └── nodesitef.cpp
├── .eslintrc.json
├── tsconfig.json
├── binding.gyp
├── .gitignore
├── package.json
├── README.md
└── LICENSE


/example/shared/bin/.gitkeep:
--------------------------------------------------------------------------------
1 | TODO: Adicionar nessa pastas as DLLs para o SiTef


--------------------------------------------------------------------------------
/src/utils/index.ts:
--------------------------------------------------------------------------------
1 | export { default as createPromise } from './createPromise';
2 | 


--------------------------------------------------------------------------------
/.github/assets/usage.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ddanielcruz/node-sitef/HEAD/.github/assets/usage.gif


--------------------------------------------------------------------------------
/.github/assets/config-exemplos.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ddanielcruz/node-sitef/HEAD/.github/assets/config-exemplos.png


--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
1 | # Configuração do SiTef utilizado nos exemplos
2 | SITEF_IP=
3 | SITEF_LOJA=
4 | SITEF_TERMINAL=
5 | SITEF_RESERVADO=
6 | 


--------------------------------------------------------------------------------
/.prettierrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 |   singleQuote: true,
3 |   semi: true,
4 |   trailingComma: 'es5',
5 |   tabWidth: 2,
6 | };
7 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 | 
3 | [*]
4 | indent_style = space
5 | indent_size = 2
6 | charset = utf-8
7 | trim_trailing_whitespace = true
8 | insert_final_newline = true
9 | 


--------------------------------------------------------------------------------
/example/shared/utils/delay.ts:
--------------------------------------------------------------------------------
1 | export default (milliseconds: number): Promise<void> => {
2 |   return new Promise((resolve) => {
3 |     setTimeout(() => resolve(), milliseconds);
4 |   });
5 | };
6 | 


--------------------------------------------------------------------------------
/example/shared/utils/handleError.ts:
--------------------------------------------------------------------------------
1 | import chalk from 'chalk';
2 | 
3 | export default (error: Error) => {
4 |   const message = error.message || `Erro desconhecido (${error.name}).`;
5 |   console.log(chalk.red(message), '\n');
6 | };
7 | 


--------------------------------------------------------------------------------
/example/shared/utils/index.ts:
--------------------------------------------------------------------------------
1 | export { default as askQuestion } from './askQuestion';
2 | export { default as handleError } from './handleError';
3 | export { default as delay } from './delay';
4 | export * as messages from './messages';
5 | 


--------------------------------------------------------------------------------
/src/utils/createPromise.ts:
--------------------------------------------------------------------------------
 1 | export default <T = void>(handler: Function) => {
 2 |   return new Promise<T>((resolve, reject) => {
 3 |     try {
 4 |       const value = handler();
 5 |       resolve(value);
 6 |     } catch (error) {
 7 |       reject(error);
 8 |     }
 9 |   });
10 | };
11 | 


--------------------------------------------------------------------------------
/lib/promises/promises.hpp:
--------------------------------------------------------------------------------
 1 | #ifndef PROMISES
 2 | #define PROMISES 1
 3 | 
 4 | #include "configPromise.cpp"
 5 | #include "verificarPresencaPromise.cpp"
 6 | #include "escreverMensagemPromise.cpp"
 7 | #include "leSimNaoPromise.cpp"
 8 | #include "iniciaFuncaoPromise.cpp"
 9 | #include "continuaFuncaoPromise.cpp"
10 | #include "finalizaFuncaoPromise.cpp"
11 | 
12 | #endif


--------------------------------------------------------------------------------
/.eslintrc.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "env": {
 3 |     "es2020": true,
 4 |     "node": true
 5 |   },
 6 |   "extends": ["standard", "prettier"],
 7 |   "plugins": ["@typescript-eslint", "prettier"],
 8 |   "parser": "@typescript-eslint/parser",
 9 |   "parserOptions": {
10 |     "ecmaVersion": 11,
11 |     "sourceType": "module"
12 |   },
13 |   "rules": {
14 |     "prettier/prettier": "error",
15 |     "no-unused-vars": "off"
16 |   }
17 | }
18 | 


--------------------------------------------------------------------------------
/example/shared/utils/askQuestion.ts:
--------------------------------------------------------------------------------
 1 | import readline from 'readline';
 2 | import chalk from 'chalk';
 3 | 
 4 | export default (query: string): Promise<string> => {
 5 |   const rl = readline.createInterface({
 6 |     input: process.stdin,
 7 |     output: process.stdout,
 8 |     terminal: false,
 9 |   });
10 | 
11 |   return new Promise((resolve) =>
12 |     rl.question(chalk.yellow(query), (ans) => {
13 |       rl.close();
14 |       resolve(ans);
15 |     })
16 |   );
17 | };
18 | 


--------------------------------------------------------------------------------
/example/shared/config/index.ts:
--------------------------------------------------------------------------------
 1 | import 'dotenv/config';
 2 | import { IParametrosConfiguracao } from '../../../src/types';
 3 | 
 4 | const config: IParametrosConfiguracao = {
 5 |   ip: process.env.SITEF_IP || '0.0.0.0',
 6 |   loja: process.env.SITEF_LOJA || '00000000',
 7 |   terminal: process.env.SITEF_TERMINAL || '00000000',
 8 |   reservado: process.env.SITEF_RESERVADO || '',
 9 |   parametrosAdicionais: process.env.SITEF_RESERVADO || '[00000000000000;00000000000000]',
10 | };
11 | 
12 | export default config;
13 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "module": "commonjs",
 5 |     "allowJs": true,
 6 |     "outDir": "./dist",
 7 |     "rootDir": "./src",
 8 |     "strict": true,
 9 |     "noImplicitAny": true,
10 |     "strictPropertyInitialization": false,
11 |     "moduleResolution": "node",
12 |     "baseUrl": "./src",
13 |     "allowSyntheticDefaultImports": true,
14 |     "esModuleInterop": true,
15 |     "experimentalDecorators": true,
16 |     "emitDecoratorMetadata": true,
17 |     "skipLibCheck": true,
18 |     "forceConsistentCasingInFileNames": true,
19 |     "declaration": true
20 |   },
21 |   "include": ["src"],
22 |   "exclude": ["node_modules", "example"]
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/promises/verificarPresencaPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | class VerificarPresencaPromise : public PromiseWorker<int>
 5 | {
 6 | public:
 7 |   static Value Create(const CallbackInfo &info)
 8 |   {
 9 |     VerificarPresencaPromise *worker = new VerificarPresencaPromise(info.Env());
10 |     worker->Queue();
11 |     return worker->deferredPromise.Promise();
12 |   }
13 | 
14 | protected:
15 |   void Execute() override
16 |   {
17 |     result = verificaPresencaPinPad();
18 |   }
19 | 
20 |   virtual void OnOK() override
21 |   {
22 |     deferredPromise.Resolve(Number::New(Env(), result));
23 |   }
24 | 
25 | private:
26 |   VerificarPresencaPromise(napi_env env) : PromiseWorker(env) {}
27 | };
28 | 


--------------------------------------------------------------------------------
/lib/promises/promiseWorker.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include <sstream>
 3 | #include "../nodesitef.hpp"
 4 | 
 5 | template <class T>
 6 | class PromiseWorker : public Napi::AsyncWorker
 7 | {
 8 | protected:
 9 |   virtual void OnError(const Napi::Error &e) override
10 |   {
11 |     deferredPromise.Reject(e.Value());
12 |   }
13 | 
14 |   static Napi::Value Reject(Napi::Env env, const char *msg)
15 |   {
16 |     Napi::Promise::Deferred failed = Napi::Promise::Deferred::New(env);
17 |     failed.Reject(Napi::Error::New(env, msg).Value());
18 |     return failed.Promise();
19 |   }
20 | 
21 |   PromiseWorker(napi_env env) : Napi::AsyncWorker(env), deferredPromise(Napi::Promise::Deferred::New(env)), result() {}
22 | 
23 |   Napi::Promise::Deferred deferredPromise;
24 |   T result;
25 | };


--------------------------------------------------------------------------------
/binding.gyp:
--------------------------------------------------------------------------------
 1 | {
 2 |   "targets": [
 3 |     {
 4 |       "target_name": "node-sitef",
 5 |       "cflags!": [ "-fno-exceptions" ],
 6 |       "cflags_cc!": [ "-fno-exceptions" ],
 7 |       "msvs_settings": {
 8 |         "VCCLCompilerTool": { "ExceptionHandling": 1 },
 9 |       },
10 |       "conditions": [
11 |         [
12 |           'OS=="win"',
13 |           {
14 |             "defines": [
15 |               "_HAS_EXCEPTIONS=1"
16 |               ]
17 |           }
18 |         ]
19 |       ],
20 |       "sources": [
21 |         "lib/promises/*",
22 |         "lib/nodesitef.hpp",
23 |         "lib/nodesitef.cpp"
24 |       ],
25 |       "include_dirs": [
26 |         "<!@(node -p \"require('node-addon-api').include\")"
27 |       ],
28 |       'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
29 |     }
30 |   ]
31 | }
32 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | npm-debug.log*
 5 | yarn-debug.log*
 6 | yarn-error.log*
 7 | lerna-debug.log*
 8 | 
 9 | # Compiled binary addons (https://nodejs.org/api/addons.html)
10 | build/Release
11 | 
12 | # Dependency directories
13 | node_modules/
14 | 
15 | # Optional npm cache directory
16 | .npm
17 | 
18 | # Optional eslint cache
19 | .eslintcache
20 | 
21 | # Output of 'npm pack'
22 | *.tgz
23 | 
24 | # Yarn Integrity file
25 | .yarn-integrity
26 | 
27 | # dotenv environment variables file
28 | .env
29 | .env.test
30 | 
31 | # Visual Studio Code
32 | .vscode
33 | 
34 | # Node Addon Api examples
35 | build/
36 | node_modules/
37 | Debug/
38 | Release/
39 | *.lock
40 | *.log
41 | package-lock.json
42 | npm-debug.log*
43 | 
44 | .idea/
45 | .vscode/
46 | .DS_Store
47 | 
48 | # Custom
49 | *.dmp
50 | CliSiTef.ini
51 | **/libclisitef.so
52 | **/libemv64.so
53 | tmp/*
54 | !tmp/.gitkeep
55 | cli/
56 | _cli/
57 | dist
58 | 


--------------------------------------------------------------------------------
/lib/promises/leSimNaoPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | using std::string;
 5 | 
 6 | class LeSimNaoPromise : public PromiseWorker<int>
 7 | {
 8 | public:
 9 |   static Value Create(const CallbackInfo &info)
10 |   {
11 |     if (info.Length() < 1)
12 |       return Reject(info.Env(), "MissingArgument");
13 |     else if (!info[0].IsString())
14 |       return Reject(info.Env(), "InvalidArgument");
15 | 
16 |     string mensagem = info[0].As<Napi::String>().Utf8Value();
17 |     LeSimNaoPromise *worker = new LeSimNaoPromise(info.Env(), mensagem);
18 |     worker->Queue();
19 |     return worker->deferredPromise.Promise();
20 |   }
21 | 
22 | protected:
23 |   void Execute() override
24 |   {
25 |     result = leSimNaoPinPad(mensagem.c_str());
26 |   }
27 | 
28 |   virtual void OnOK() override
29 |   {
30 |     deferredPromise.Resolve(Number::New(Env(), result));
31 |   }
32 | 
33 | private:
34 |   LeSimNaoPromise(napi_env env, string &p_mensagem) : PromiseWorker(env), mensagem(p_mensagem) {}
35 | 
36 |   string mensagem;
37 | };
38 | 


--------------------------------------------------------------------------------
/lib/promises/escreverMensagemPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | using std::string;
 5 | 
 6 | class EscreverMensagemPromise : public PromiseWorker<int>
 7 | {
 8 | public:
 9 |   static Value Create(const CallbackInfo &info)
10 |   {
11 |     if (info.Length() < 1)
12 |       return Reject(info.Env(), "MissingArgument");
13 |     else if (!info[0].IsString())
14 |       return Reject(info.Env(), "InvalidArgument");
15 | 
16 |     string mensagem = info[0].As<Napi::String>().Utf8Value();
17 |     EscreverMensagemPromise *worker = new EscreverMensagemPromise(info.Env(), mensagem);
18 |     worker->Queue();
19 |     return worker->deferredPromise.Promise();
20 |   }
21 | 
22 | protected:
23 |   void Execute() override
24 |   {
25 |     result = escreveMensagemPermanentePinPad(mensagem.c_str());
26 |   }
27 | 
28 |   virtual void OnOK() override
29 |   {
30 |     deferredPromise.Resolve(Number::New(Env(), result));
31 |   }
32 | 
33 | private:
34 |   EscreverMensagemPromise(napi_env env, string &p_mensagem) : PromiseWorker(env), mensagem(p_mensagem) {}
35 | 
36 |   string mensagem;
37 | };
38 | 


--------------------------------------------------------------------------------
/example/basic/index.ts:
--------------------------------------------------------------------------------
 1 | import path from 'path';
 2 | import chalk from 'chalk';
 3 | 
 4 | import SiTef from '../../src';
 5 | import config from '../shared/config';
 6 | import { messages } from '../shared/utils';
 7 | 
 8 | const main = async () => {
 9 |   // Define o caminho para as DLLs do SiTef e instancia o client
10 |   const dlls = path.resolve(__dirname, '..', 'shared', 'bin', 'CliSiTef64I.dll');
11 |   const sitef = new SiTef(dlls);
12 | 
13 |   try {
14 |     // Configurando o SiTef
15 |     let response = await sitef.configurar(config);
16 |     let message = messages.configuracao[response];
17 |     if (response !== 0) throw new Error(message);
18 |     console.log(chalk.green('ConfiguraIntSiTefInterativo:'), message);
19 | 
20 |     // Verificando a presença do PinPad
21 |     response = await sitef.verificarPresenca();
22 |     message = messages.verificacaoPresenca[response];
23 |     if (response !== 1) throw new Error(message);
24 |     console.log(chalk.green('VerificaPresencaPinPad:'), message);
25 | 
26 |     // Escrevendo a mensagem permanente
27 |     response = await sitef.escreverMensagem("I'm watching you");
28 |     const title = 'EscreveMensagemPermanentePinPad:';
29 | 
30 |     if (response === 0) {
31 |       console.log(chalk.green(title), 'Mensagem escrita com sucesso.');
32 |     } else {
33 |       console.log(chalk.red(title), 'Não foi possível escrever a mensagem.');
34 |     }
35 |   } catch (error) {
36 |     return console.error(chalk.red(error.message));
37 |   }
38 | };
39 | 
40 | main();
41 | 


--------------------------------------------------------------------------------
/example/README.md:
--------------------------------------------------------------------------------
 1 | # Exemplos da biblioteca
 2 | 
 3 | Esta pasta contém exemplos de uso da biblioteca. No momento existem apenas duas aplicações console de exemplo. Futuramente pretendo colocar um exemplo utilizando em uma aplicação desktop com **Electron**.
 4 | 
 5 | O primeiro exemplo é uma aplicação console que basicamente instancia o objeto do SiTef, chama o método de **configuração**, **verifica a presença** do PinPad e **escreve uma mensagem**. É um exemplo bem simples para demonstrar o uso básico da biblioteca.
 6 | 
 7 | Já o segundo é uma aplicação console interativa. Ele permite simular o funcionamento do SiTef pelo console, desde as funcionalidades mais simples, como configuração e verificação de presença do PinPad, até a simulação de uma função.
 8 | 
 9 | ## Configuração
10 | 
11 | A configuração dos exemplos é a mesma que a da biblioteca. Portanto, adicione no **root do projeto** o arquivo `CliSiTef.ini`.
12 | 
13 | Em seguida, adicione as DLLs do SiTef na pasta **bin** (pasta vazia com apenas um arquivo `.gitkeep`), encontrada em **example/shared**. Esta pasta deve conter o arquivo `libclisitef.so` e a `libemv` do seu sistema.
14 | 
15 | Por fim, clone o arquivo `.env.example` no root do projeto e adicione as configurações do SiTef. Caso prefira, você pode configurar o client diretamente no arquivo `config/index.js`. O exemplo básico não necessita desses parâmetros, porém o cliente precisa para realizar a função. Segue exemplo de como deve ficar a estrutura:
16 | 
17 | ![Configuração dos exemplos](../.github/assets/config-exemplos.png)
18 | 


--------------------------------------------------------------------------------
/example/client/index.ts:
--------------------------------------------------------------------------------
 1 | import chalk from 'chalk';
 2 | 
 3 | import { askQuestion } from '../shared/utils';
 4 | import * as client from './client';
 5 | 
 6 | type Option = {
 7 |   title: string;
 8 |   handler: Function;
 9 | };
10 | 
11 | const createOption = (title: string, handler: Function): Option => ({
12 |   title,
13 |   handler,
14 | });
15 | 
16 | const options: { [index: string]: Option } = {
17 |   C: createOption('Configurar', client.configurar),
18 |   V: createOption('Verificar presença', client.verificarPresenca),
19 |   E: createOption('Escrever mensagem', client.escreverMensagem),
20 |   F: createOption('Simular função', client.simularFuncao),
21 |   L: createOption('Limpar console', console.clear),
22 |   M: createOption('Mostrar menu', showMenu),
23 |   S: createOption('Sair', () => console.log('Encerrando o processo...')),
24 | };
25 | 
26 | const keys = Object.keys(options);
27 | 
28 | function showMenu() {
29 |   console.log(chalk.green('\n\t\tSiTef Interativo\n'));
30 | 
31 |   for (const key in options) {
32 |     console.log(`- ${chalk.green(key + ':')} ${options[key].title}`);
33 |   }
34 | 
35 |   console.log();
36 | }
37 | 
38 | const main = async () => {
39 |   showMenu();
40 | 
41 |   do {
42 |     let option = await askQuestion('Opção: ');
43 |     option = option ? option.toUpperCase() : '';
44 | 
45 |     if (!keys.includes(option)) {
46 |       console.log(chalk.red('Opção inválida! Digite novamente.\n'));
47 |     } else {
48 |       await options[option].handler();
49 | 
50 |       if (option === 'S') {
51 |         break;
52 |       }
53 |     }
54 |   } while (true);
55 | };
56 | 
57 | main();
58 | 


--------------------------------------------------------------------------------
/lib/nodesitef.hpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include <string.h>
 3 | #include <iostream>
 4 | 
 5 | #ifdef _WIN32
 6 |     #include <windows.h>
 7 | #endif
 8 | #ifdef linux
 9 |     #include <dlfcn.h>
10 | #endif
11 | 
12 | using Napi::Boolean;
13 | using Napi::CallbackInfo;
14 | using Napi::Env;
15 | using Napi::Error;
16 | using Napi::Function;
17 | using Napi::Number;
18 | using Napi::Object;
19 | using Napi::String;
20 | using Napi::TypeError;
21 | using Napi::Value;
22 | 
23 | using std::string;
24 | 
25 | #ifndef NODESITEF_H // include guard
26 | #define NODESITEF_H 1
27 | 
28 | #include "promises/promiseWorker.cpp"
29 | 
30 | // Tipos dos métodos do SiTef
31 | typedef int (*VerificaPresencaPinPad)();
32 | typedef int (*ConfiguraIntSiTefInterativoEx)(const char *, const char *, const char *, const char *, const char *);
33 | typedef int (*IniciaFuncaoSiTefInterativo)(int, const char *, const char *, const char *, const char *, const char *, const char *);
34 | typedef int (*ContinuaFuncaoSiTefInterativo)(int *, long *, int *, int *, const char *, int, int);
35 | typedef void (*FinalizaFuncaoSiTefInterativo)(short, const char *, const char *, const char *, const char *);
36 | typedef int (*EscreveMensagemPermanentePinPad)(const char *);
37 | typedef int (*LeSimNaoPinPad)(const char *);
38 | 
39 | Value carregarDLL(const CallbackInfo &info);
40 | 
41 | int verificaPresencaPinPad();
42 | int configuraIntSiTefInterativo(const char *, const char *, const char *, const char *, const char *);
43 | int escreveMensagemPermanentePinPad(const char *);
44 | int leSimNaoPinPad(const char *);
45 | int iniciaFuncaoSiTefInterativo(int, const char *, const char *, const char *, const char *, const char *, const char *);
46 | int continuaFuncaoSiTefInterativo(int *comando, long *tipoCampo, int *tamMinimo, int *tamMaximo, char *buffer, int tamBuffer, int continua);
47 | void finalizaFuncaoSiTefInterativo(int confirma, const char *cupomFiscal, const char *dataFiscal, const char *horaFiscal, const char *paramAdicionais);
48 | 
49 | #endif /* NODESITEF_H */
50 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "node-sitef",
 3 |   "version": "1.4.0",
 4 |   "repository": "https://github.com/danielccunha/node-sitef",
 5 |   "homepage": "https://github.com/danielccunha/node-sitef",
 6 |   "author": {
 7 |     "name": "Daniel Cunha",
 8 |     "email": "danielcunha54@gmail.com",
 9 |     "url": "https://github.com/danielccunha"
10 |   },
11 |   "license": "GPL-3.0",
12 |   "bugs": "https://github.com/danielccunha/node-sitef/issues",
13 |   "main": "dist/index.js",
14 |   "scripts": {
15 |     "build": "tsc",
16 |     "prepublish": "tsc",
17 |     "publish": "npm publish --access public",
18 |     "example:basic": "ts-node example/basic",
19 |     "example:client": "ts-node example/client"
20 |   },
21 |   "dependencies": {
22 |     "bindings": "^1.5.0",
23 |     "node-addon-api": "^2.0.0"
24 |   },
25 |   "devDependencies": {
26 |     "@types/bindings": "^1.3.0",
27 |     "@types/chalk": "^2.2.0",
28 |     "@types/node": "^14.0.13",
29 |     "@typescript-eslint/eslint-plugin": "^3.3.0",
30 |     "@typescript-eslint/parser": "^3.3.0",
31 |     "dotenv": "^8.2.0",
32 |     "eslint": "^7.2.0",
33 |     "eslint-config-prettier": "^6.11.0",
34 |     "eslint-config-standard": "^14.1.1",
35 |     "eslint-plugin-import": "^2.21.2",
36 |     "eslint-plugin-node": "^11.1.0",
37 |     "eslint-plugin-prettier": "^3.1.4",
38 |     "eslint-plugin-promise": "^4.2.1",
39 |     "eslint-plugin-standard": "^4.0.1",
40 |     "moment": "^2.26.0",
41 |     "node-gyp": "^6.0.1",
42 |     "prettier": "^2.0.5",
43 |     "readline": "^1.3.0",
44 |     "ts-node": "^8.10.2",
45 |     "typescript": "^3.9.5"
46 |   },
47 |   "contributors": [
48 |     {
49 |       "name": "Daniel Cunha",
50 |       "email": "danielcunha54@gmail.com",
51 |       "url": "https://github.com/danielccunha"
52 |     },
53 |     {
54 |       "name": "Felipe Furst",
55 |       "email": "fefurst@gmail.com",
56 |       "url": "https://github.com/fefurst"
57 |     }
58 |   ],
59 |   "files": [
60 |     "dist/**/*",
61 |     "build/**/*",
62 |     "lib/**/*",
63 |     "src/**/*",
64 |     "LICENSE",
65 |     "README.md",
66 |     "package.json"
67 |   ]
68 | }
69 | 


--------------------------------------------------------------------------------
/src/types.ts:
--------------------------------------------------------------------------------
 1 | export interface ILibrary {
 2 |   carregarDLL: (path: string) => boolean;
 3 |   configuraIntSiTefInterativo: (
 4 |     ip: string,
 5 |     loja: string,
 6 |     terminal: string,
 7 |     reservado: string,
 8 |     parametrosAdicionais: string
 9 |   ) => number;
10 |   verificaPresencaPinPad: () => number;
11 |   leSimNaoPinPad: (mensagem: string) => number;
12 |   escreveMensagemPermanentePinPad: (mensagem: string) => number;
13 |   iniciaFuncaoSiTefInterativo: (
14 |     funcao: number,
15 |     valor: string,
16 |     cupomFiscal: string,
17 |     dataFiscal: string,
18 |     horaFiscal: string,
19 |     operador: string,
20 |     parametros: string
21 |   ) => number;
22 |   continuaFuncaoSiTefInterativo: (
23 |     comando: number,
24 |     tipoCampo: number,
25 |     tamMinimo: number,
26 |     tamMaximo: number,
27 |     buffer: string,
28 |     tamBuffer: number,
29 |     continua: number
30 |   ) => IResultadoContinuarFuncao;
31 |   finalizaFuncaoSiTefInterativo: (
32 |     confirma: number,
33 |     cupomFiscal: string,
34 |     dataFiscal: string,
35 |     horaFiscal: string,
36 |     parametros: string
37 |   ) => boolean;
38 | }
39 | 
40 | export interface IParametrosConfiguracao {
41 |   ip: string;
42 |   loja: string;
43 |   terminal: string;
44 |   reservado?: string;
45 |   parametrosAdicionais: string;
46 | }
47 | 
48 | export interface IParametrosIniciarFuncao {
49 |   funcao: number;
50 |   valor?: string;
51 |   cupomFiscal: string;
52 |   dataFiscal: string;
53 |   horaFiscal: string;
54 |   operador: string;
55 |   parametros?: string;
56 | }
57 | 
58 | export interface IParametrosContinuarFuncao
59 |   extends Omit<IResultadoContinuarFuncao, 'retorno'> {
60 |   tamanhoBuffer: number;
61 |   continua: number;
62 | }
63 | 
64 | export interface IResultadoContinuarFuncao {
65 |   retorno: number;
66 |   comando: number;
67 |   tipoCampo: number;
68 |   tamMinimo: number;
69 |   tamMaximo: number;
70 |   buffer: string;
71 | }
72 | 
73 | export interface IParametrosFinalizarFuncao {
74 |   confirma: number;
75 |   cupomFiscal: string;
76 |   dataFiscal: string;
77 |   horaFiscal: string;
78 |   parametros: string;
79 | }
80 | 


--------------------------------------------------------------------------------
/lib/promises/finalizaFuncaoPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | using std::string;
 5 | 
 6 | class FinalizaFuncaoPromise : public PromiseWorker<bool>
 7 | {
 8 | public:
 9 |   static Value Create(const CallbackInfo &info)
10 |   {
11 |     if (info.Length() < 5)
12 |       return Reject(info.Env(), "MissingArgument");
13 |     else if (!info[0].IsNumber() || !info[1].IsString() || !info[2].IsString() || !info[3].IsString() || !info[4].IsString())
14 |       return Reject(info.Env(), "InvalidArgument");
15 | 
16 |     int confirma = info[0].As<Number>().Int32Value();
17 |     string cupomFiscal = info[1].As<String>().Utf8Value();
18 |     string dataFiscal = info[2].As<String>().Utf8Value();
19 |     string horaFiscal = info[3].As<String>().Utf8Value();
20 |     string paramAdicionais = info[4].As<String>().Utf8Value();
21 | 
22 |     FinalizaFuncaoPromise *worker = new FinalizaFuncaoPromise(info.Env(), confirma, cupomFiscal, dataFiscal, horaFiscal, paramAdicionais);
23 |     worker->Queue();
24 |     return worker->deferredPromise.Promise();
25 |   }
26 | 
27 | protected:
28 |   void Execute() override
29 |   {
30 |     finalizaFuncaoSiTefInterativo(confirma, cupomFiscal.c_str(), dataFiscal.c_str(), horaFiscal.c_str(), paramAdicionais.c_str());
31 |     result = true;
32 |   }
33 | 
34 |   virtual void OnOK() override
35 |   {
36 |     deferredPromise.Resolve(Boolean::New(Env(), result));
37 |   }
38 | 
39 | private:
40 |   FinalizaFuncaoPromise(napi_env env,
41 |                         int &p_confirma,
42 |                         string &p_cupomFiscal,
43 |                         string &p_dataFiscal,
44 |                         string &p_horaFiscal,
45 |                         string &p_paramAdicionais) : PromiseWorker(env),
46 |                                                      confirma(p_confirma),
47 |                                                      cupomFiscal(p_cupomFiscal),
48 |                                                      dataFiscal(p_dataFiscal),
49 |                                                      horaFiscal(p_horaFiscal),
50 |                                                      paramAdicionais(p_paramAdicionais) {}
51 | 
52 |   int confirma;
53 |   string cupomFiscal;
54 |   string dataFiscal;
55 |   string horaFiscal;
56 |   string paramAdicionais;
57 | };
58 | 


--------------------------------------------------------------------------------
/lib/promises/configPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | using std::string;
 5 | 
 6 | class ConfigPromise : public PromiseWorker<int>
 7 | {
 8 | public:
 9 |   static Value Create(const CallbackInfo &info)
10 |   {
11 |     if (info.Length() < 5)
12 |       return Reject(info.Env(), "MissingArgument");
13 |     else if (!info[0].IsString() || !info[1].IsString() || !info[2].IsString() || !info[3].IsString() || !info[4].IsString())
14 |       return Reject(info.Env(), "InvalidArgument");
15 | 
16 |     string ip = info[0].As<Napi::String>().Utf8Value();
17 |     string loja = info[1].As<Napi::String>().Utf8Value();
18 |     string terminal = info[2].As<Napi::String>().Utf8Value();
19 |     string reservado = info[3].As<Napi::String>().Utf8Value();
20 |     string parametrosAdicionais = info[4].As<Napi::String>().Utf8Value();
21 |     ConfigPromise *worker = new ConfigPromise(info.Env(), ip, loja, terminal, reservado, parametrosAdicionais);
22 |     worker->Queue();
23 |     return worker->deferredPromise.Promise();
24 |   }
25 | 
26 | protected:
27 |   void Execute() override
28 |   {
29 |     result = configuraIntSiTefInterativo(ip.c_str(), loja.c_str(), terminal.c_str(), reservado.c_str(), parametrosAdicionais.c_str());
30 |   }
31 | 
32 |   virtual void OnOK() override
33 |   {
34 |     deferredPromise.Resolve(Number::New(Env(), result));
35 |   }
36 | 
37 | private:
38 |   ConfigPromise(napi_env env, string &p_ip, string &p_loja, string &p_terminal, string &p_reservado, string &p_parametrosAdicionais) : PromiseWorker(env),
39 |                                                                                                        ip(p_ip),
40 |                                                                                                        loja(p_loja),
41 |                                                                                                        terminal(p_terminal),
42 |                                                                                                        reservado(p_reservado),
43 |                                                                                                        parametrosAdicionais(p_parametrosAdicionais) {}
44 | 
45 |   string ip;
46 |   string loja;
47 |   string terminal;
48 |   string reservado;
49 |   string parametrosAdicionais;
50 | };
51 | 


--------------------------------------------------------------------------------
/lib/promises/iniciaFuncaoPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | using std::string;
 5 | 
 6 | class IniciaFuncaoPromise : public PromiseWorker<int>
 7 | {
 8 | public:
 9 |   static Value Create(const CallbackInfo &info)
10 |   {
11 |     if (info.Length() < 7)
12 |       return Reject(info.Env(), "MissingArgument");
13 |     else if (!info[0].IsNumber() || !info[1].IsString() || !info[2].IsString() || !info[3].IsString() ||
14 |              !info[4].IsString() || !info[5].IsString() || !info[6].IsString())
15 |       return Reject(info.Env(), "InvalidArgument");
16 | 
17 |     int funcao = info[0].As<Napi::Number>().Int32Value();
18 |     string valor = info[1].As<Napi::String>().Utf8Value();
19 |     string cupomFiscal = info[2].As<Napi::String>().Utf8Value();
20 |     string dataFiscal = info[3].As<Napi::String>().Utf8Value();
21 |     string horaFiscal = info[4].As<Napi::String>().Utf8Value();
22 |     string operador = info[5].As<Napi::String>().Utf8Value();
23 |     string paramAdicionais = info[5].As<Napi::String>().Utf8Value();
24 | 
25 |     IniciaFuncaoPromise *worker = new IniciaFuncaoPromise(info.Env(), funcao, valor, cupomFiscal, dataFiscal, horaFiscal, operador, paramAdicionais);
26 |     worker->Queue();
27 |     return worker->deferredPromise.Promise();
28 |   }
29 | 
30 | protected:
31 |   void Execute() override
32 |   {
33 |     result = iniciaFuncaoSiTefInterativo(funcao, valor.c_str(), cupomFiscal.c_str(), dataFiscal.c_str(), horaFiscal.c_str(), operador.c_str(), paramAdicionais.c_str());
34 |   }
35 | 
36 |   virtual void OnOK() override
37 |   {
38 |     deferredPromise.Resolve(Number::New(Env(), result));
39 |   }
40 | 
41 | private:
42 |   IniciaFuncaoPromise(napi_env env,
43 |                       int &p_funcao,
44 |                       string &p_valor,
45 |                       string &p_cupomFiscal,
46 |                       string &p_dataFiscal,
47 |                       string &p_horaFiscal,
48 |                       string &p_operador,
49 |                       string &p_paramAdicionais) : PromiseWorker(env),
50 |                                                    funcao(p_funcao),
51 |                                                    valor(p_valor),
52 |                                                    cupomFiscal(p_cupomFiscal),
53 |                                                    dataFiscal(p_dataFiscal),
54 |                                                    horaFiscal(p_horaFiscal),
55 |                                                    operador(p_operador),
56 |                                                    paramAdicionais(p_paramAdicionais) {}
57 | 
58 |   int funcao;
59 |   string valor;
60 |   string cupomFiscal;
61 |   string dataFiscal;
62 |   string horaFiscal;
63 |   string operador;
64 |   string paramAdicionais;
65 | };
66 | 


--------------------------------------------------------------------------------
/example/shared/utils/messages.ts:
--------------------------------------------------------------------------------
 1 | type KeyValueMap = { [index: string]: any };
 2 | 
 3 | export const configuracao: KeyValueMap = {
 4 |   '0': 'Não ocorreu erro',
 5 |   '1': 'Endereço IP inválido ou não resolvido',
 6 |   '2': 'Código da loja inválido',
 7 |   '3': 'Código de terminal inválido',
 8 |   '6': 'Erro na inicialização do Tcp/Ip',
 9 |   '7': 'Falta de memória',
10 |   '8': 'Não encontrou a CliSiTef ou ela está com problemas',
11 |   '9': 'Configuração de servidores SiTef foi excedida.',
12 |   '10':
13 |     'Erro de acesso na pasta CliSiTef (possível falta de permissão para escrita)',
14 |   '11': 'Dados inválidos passados pela automação.',
15 |   '12':
16 |     'Modo seguro não ativo (possível falta de configuração no servidor SiTef do arquivo .cha).',
17 |   '13':
18 |     'Caminho DLL inválido (o caminho completo das bibliotecas está muito grande).',
19 | };
20 | 
21 | export const verificacaoPresenca: KeyValueMap = {
22 |   '1': 'Existe um PinPad operacional conectado ao micro.',
23 |   '0': 'Não existe um PinPad conectado ao micro.',
24 |   '-1': 'Biblioteca de acesso ao PinPad não encontrada.',
25 | };
26 | 
27 | export const funcao: KeyValueMap = {
28 |   '0': 'Sucesso na execução da função.',
29 |   '10000': 'Deve ser chamada a rotina de continuidade do processo.',
30 |   '-1':
31 |     'Módulo não inicializado. O PDV tentou chamar alguma rotina sem antes executar a função configura.',
32 |   '-2': 'Operação cancelada pelo operador.',
33 |   '-3': 'O parâmetro função / modalidade é inexistente/inválido.',
34 |   '-4': 'Falta de memória no PDV.',
35 |   '-5': 'Sem comunicação com o SiTef.',
36 |   '-6': 'Operação cancelada pelo usuário (no pinpad).',
37 |   '-7': 'Reservado',
38 |   '-8':
39 |     'A CliSiTef não possui a implementação da função necessária, provavelmente está desatualizada (a CliSiTefI é mais recente).',
40 |   '-9':
41 |     'A automação chamou a rotina ContinuaFuncaoSiTefInterativo sem antes iniciar uma função iterativa.',
42 |   '-10':
43 |     'Algum parâmetro obrigatório não foi passado pela automação comercial.',
44 |   '-12':
45 |     'Erro na execução da rotina iterativa. Provavelmente o processo iterativo anterior não foi executado até o final (enquanto o retorno for igual a 10000).',
46 |   '-13':
47 |     'Documento fiscal não encontrado nos registros da CliSiTef. Retornado em funções de consulta tais como ObtemQuantidadeTransaçõesPendentes.',
48 |   '-15': 'Operação cancelada pela automação comercial.',
49 |   '-20': 'Parâmetro inválido passado para a função.',
50 |   '-21':
51 |     'Utilizada uma palavra proibida, por exemplo SENHA, para coletar dados em aberto no pinpad. Por exemplo na função ObtemDadoPinpadDiretoEx.',
52 |   '-25': 'Erro no Correspondente Bancário: Deve realizar sangria.',
53 |   '-30':
54 |     'Erro de acesso ao arquivo. Certifique-se que o usuário que roda a aplicação tem direitos de leitura/escrita.',
55 |   '-40': 'Transação negada pelo servidor SiTef.',
56 |   '-41': 'Dados inválidos.',
57 |   '-42': 'Reservado',
58 |   '-50': 'Transação não segura.',
59 |   '-100': 'Erro interno do módulo.',
60 | };
61 | 


--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
  1 | import bindings from 'bindings';
  2 | 
  3 | import {
  4 |   ILibrary,
  5 |   IParametrosConfiguracao,
  6 |   IParametrosIniciarFuncao,
  7 |   IParametrosContinuarFuncao,
  8 |   IParametrosFinalizarFuncao,
  9 |   IResultadoContinuarFuncao,
 10 | } from './types';
 11 | import { createPromise } from './utils';
 12 | 
 13 | const library: ILibrary = bindings('node-sitef');
 14 | 
 15 | export default class SiTef {
 16 |   constructor(path: string) {
 17 |     if (!path) {
 18 |       throw new Error('Informe o caminho para as DLLs do SiTef.');
 19 |     }
 20 | 
 21 |     const result = library.carregarDLL(path);
 22 |     if (!result) {
 23 |       throw new Error('Não foi possível carregar as DLLs do SiTef.');
 24 |     }
 25 |   }
 26 | 
 27 |   configurar(parametros: IParametrosConfiguracao): Promise<number> {
 28 |     const { ip, loja, terminal, reservado, parametrosAdicionais } = parametros;
 29 | 
 30 |     return createPromise<number>(() => {
 31 |       return library.configuraIntSiTefInterativo(
 32 |         ip,
 33 |         loja,
 34 |         terminal,
 35 |         reservado || '',
 36 |         parametrosAdicionais || ''
 37 |       );
 38 |     });
 39 |   }
 40 | 
 41 |   verificarPresenca(): Promise<number> {
 42 |     return createPromise<number>(() => {
 43 |       return library.verificaPresencaPinPad();
 44 |     });
 45 |   }
 46 | 
 47 |   escreverMensagem(mensagem: string): Promise<number> {
 48 |     return createPromise<number>(() => {
 49 |       return library.escreveMensagemPermanentePinPad(mensagem);
 50 |     });
 51 |   }
 52 | 
 53 |   leSimNaoPinPad(mensagem: string): Promise<number> {
 54 |     return createPromise<number>(() => {
 55 |       return library.leSimNaoPinPad(mensagem);
 56 |     });
 57 |   }
 58 | 
 59 |   iniciarFuncao(parametros: IParametrosIniciarFuncao): Promise<number> {
 60 |     return createPromise<number>(() => {
 61 |       return library.iniciaFuncaoSiTefInterativo(
 62 |         parametros.funcao,
 63 |         parametros.valor || '',
 64 |         parametros.cupomFiscal,
 65 |         parametros.dataFiscal,
 66 |         parametros.horaFiscal,
 67 |         parametros.operador,
 68 |         parametros.parametros || ''
 69 |       );
 70 |     });
 71 |   }
 72 | 
 73 |   continuarFuncao(
 74 |     parametros: IParametrosContinuarFuncao
 75 |   ): Promise<IResultadoContinuarFuncao> {
 76 |     return createPromise<IResultadoContinuarFuncao>(() => {
 77 |       return library.continuaFuncaoSiTefInterativo(
 78 |         parametros.comando,
 79 |         parametros.tipoCampo,
 80 |         parametros.tamMinimo,
 81 |         parametros.tamMaximo,
 82 |         parametros.buffer,
 83 |         parametros.tamanhoBuffer,
 84 |         parametros.continua
 85 |       );
 86 |     });
 87 |   }
 88 | 
 89 |   finalizarFuncao(parametros: IParametrosFinalizarFuncao): Promise<boolean> {
 90 |     return createPromise<boolean>(() => {
 91 |       return library.finalizaFuncaoSiTefInterativo(
 92 |         parametros.confirma,
 93 |         parametros.cupomFiscal,
 94 |         parametros.dataFiscal,
 95 |         parametros.horaFiscal,
 96 |         parametros.parametros
 97 |       );
 98 |     });
 99 |   }
100 | }
101 | 


--------------------------------------------------------------------------------
/lib/promises/continuaFuncaoPromise.cpp:
--------------------------------------------------------------------------------
 1 | #include <napi.h>
 2 | #include "../nodesitef.hpp"
 3 | 
 4 | using std::string;
 5 | 
 6 | class ContinuaFuncaoPromise : public PromiseWorker<int>
 7 | {
 8 | public:
 9 |   static Value Create(const CallbackInfo &info)
10 |   {
11 |     if (info.Length() < 7)
12 |       return Reject(info.Env(), "MissingArgument");
13 |     else if (!info[0].IsNumber() ||
14 |              !info[1].IsNumber() ||
15 |              !info[2].IsNumber() ||
16 |              !info[3].IsNumber() ||
17 |              !info[4].IsString() ||
18 |              !info[5].IsNumber() ||
19 |              !info[6].IsNumber())
20 |       return Reject(info.Env(), "InvalidArgument");
21 | 
22 |     int comando = info[0].ToNumber().Int32Value();
23 |     long tipoCampo = static_cast<long>(info[1].ToNumber().Int64Value());
24 |     int tamMinimo = info[2].ToNumber().Int32Value();
25 |     int tamMaximo = info[3].ToNumber().Int32Value();
26 |     int tamBuffer = info[5].ToNumber().Int32Value();
27 |     int continua = info[6].ToNumber().Int32Value();
28 | 
29 |     char buffer[20000];
30 |     strcpy(buffer, info[4].ToString().Utf8Value().c_str());
31 | 
32 |     ContinuaFuncaoPromise *worker = new ContinuaFuncaoPromise(info.Env(),
33 |                                                               comando,
34 |                                                               tipoCampo,
35 |                                                               tamMinimo,
36 |                                                               tamMaximo,
37 |                                                               buffer,
38 |                                                               tamBuffer,
39 |                                                               continua);
40 |     worker->Queue();
41 |     return worker->deferredPromise.Promise();
42 |   }
43 | 
44 | protected:
45 |   void Execute() override
46 |   {
47 |     result = continuaFuncaoSiTefInterativo(
48 |         &comando,
49 |         &tipoCampo,
50 |         &tamMinimo,
51 |         &tamMaximo,
52 |         buffer,
53 |         tamBuffer,
54 |         continua);
55 |   }
56 | 
57 |   virtual void OnOK() override
58 |   {
59 |     Object obj = Object::New(Env());
60 |     obj.Set("retorno", result);
61 |     obj.Set("comando", comando);
62 |     obj.Set("tipoCampo", tipoCampo);
63 |     obj.Set("tamMinimo", tamMinimo);
64 |     obj.Set("tamMaximo", tamMaximo);
65 |     obj.Set("buffer", buffer);
66 | 
67 |     deferredPromise.Resolve(obj);
68 |   }
69 | 
70 | private:
71 |   ContinuaFuncaoPromise(napi_env env,
72 |                         int p_comando,
73 |                         long p_tipoCampo,
74 |                         int p_tamMinimo,
75 |                         int p_tamMaximo,
76 |                         char *p_buffer,
77 |                         int p_tamBuffer,
78 |                         int p_continua) : PromiseWorker(env),
79 |                                           comando(p_comando),
80 |                                           tipoCampo(p_tipoCampo),
81 |                                           tamMinimo(p_tamMinimo),
82 |                                           tamMaximo(p_tamMaximo),
83 |                                           buffer(p_buffer),
84 |                                           tamBuffer(p_tamBuffer),
85 |                                           continua(p_continua)
86 |   {
87 |   }
88 | 
89 |   int comando;
90 |   long tipoCampo;
91 |   int tamMinimo;
92 |   int tamMaximo;
93 |   char *buffer;
94 |   int tamBuffer;
95 |   int continua;
96 | };
97 | 
98 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <div align="center">
 2 |   <h1>
 3 |    :credit_card: <i>node-sitef</i>
 4 |   </h1>
 5 | 
 6 |   <p>
 7 |   Portabilidade das DLLs do SiTef para aplicações JavaScript utilizando Node Addons
 8 |   </p>
 9 | 
10 |   <a href="https://www.npmjs.com/package/node-sitef">
11 |     <img alt="npm" src="https://img.shields.io/npm/v/node-sitef?color=3a86ff">
12 |   </a>
13 |   <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/danielccunha/node-sitef?color=%233a86ff">
14 |   <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/danielccunha/node-sitef?color=%233a86ff">
15 |   <a href="https://github.com/danielccunha/node-sitef/commits/master">
16 |     <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/danielccunha/node-sitef?color=%233a86ff">
17 |   </a>
18 |   <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?color=%233a86ff">
19 | 
20 | </div>
21 | 
22 | ## :computer: Projeto
23 | 
24 | A biblioteca consiste da portabilidade da DLL do [SiTef](https://www.softwareexpress.com.br/index.php?a=1590867134) para aplicações JavaScript. Ela foi desenvolvida em C++ portando para uma classe JavaScript utilizando [Node Addons](https://nodejs.org/api/addons.html).
25 | 
26 | ![Usage GIF](.github/assets/usage.gif)
27 | 
28 | ## :wrench: Configuração
29 | 
30 | Adicione o pacote no seu projeto utilizando `yarn add node-sitef` ou `npm install node-sitef`. Após adicionar o pacote, no **root** do seu projeto, adicione o arquivo `CliSiTef.ini` para configurar o SiTef. Ele deve ser adicionado no root para que a biblioteca possa encontrá-lo.
31 | 
32 | Este passo é muito importante, pois, mesmo que você consiga instanciar o objeto do SiTef, quando você tentar executar qualquer função será retornado zero (sucesso). O motivo disso é desconhecido, é uma particularidade da DLL.
33 | 
34 | Por fim, crie uma pasta `bin` na sua aplicação (ou algum outro nome de sua preferência) e adicione as DLLs do SiTef. Elas serão utilizadas para instanciar o client.
35 | 
36 | ## :fire: Utilização
37 | 
38 | Para utilizar a biblioteca basta importá-la e instanciar o client informando o caminho para as DLLs do SiTef. Através do client que serão realizadas todas as funções do SiTef.
39 | 
40 | ```js
41 | const path = require('path');
42 | const SiTef = require('node-sitef');
43 | 
44 | // Cria o caminho para as DLLs
45 | const dllPath = path.resolve(__dirname, '..', 'bin', 'libclisitef.so');
46 | const client = new SiTef(dllPath);
47 | ```
48 | 
49 | Após instanciado basta utilizar as funções da DLL. Para mais informações basta acessar a [Wiki](https://github.com/danielccunha/node-sitef/wiki) do projeto.
50 | 
51 | Por fim, existem dois [exemplos de uso](example/README.md) na pasta `example`, o qual você pode utilizar como base. Caso queira rodar os exemplos, clone o projeto, instale as dependências e execute os exemplos.
52 | 
53 | ```sh
54 | # Clonando o projeto
55 | git clone https://github.com/danielccunha/node-sitef.git
56 | cd node-sitef
57 | 
58 | # Instalando as dependências
59 | yarn
60 | 
61 | # Executa o projeto básico, o qual apenas instancia o cliente do SiTef,
62 | # verifica a presença do PinPad e escreve uma mensagem se possível
63 | yarn example:basic
64 | 
65 | # Executa o projeto do client, que é um cliente interativo para teste das
66 | # funções da biblioteca. Nesse client é possível realizar toda a função de
67 | # pagamento descrita na documentação da Software Express
68 | yarn example:client
69 | ```
70 | 
71 | ## :rocket: Tecnologias
72 | 
73 | - [Node.js](https://nodejs.org/en/)
74 | - [C++ Addons](https://nodejs.org/api/addons.html)
75 | - [Software Express](https://www.softwareexpress.com.br/)
76 | 
77 | ## :thinking: Como contribuir
78 | 
79 | 1. Faça o fork do projeto
80 | 2. Crie uma branch para sua modificação (`git checkout -b feature/AmazingFeature`)
81 | 3. Faça o commit (`git commit -am 'Add some amazing feature'`)
82 | 4. Push (`git push origin feature/AmazingFeature`)
83 | 5. Crie um novo Pull Request
84 | 
85 | ## :busts_in_silhouette: Contribuidores
86 | 
87 | <table>
88 |   <tr>
89 |     <td align="center"><a href="https://github.com/danielccunha"><img src="https://avatars2.githubusercontent.com/u/32555455?s=460&v=4" width="75px;" alt="Daniel Cunha"/><br /><sub><b>Daniel Cunha</b></sub></a></td>
90 |     <td align="center"><a href="https://github.com/fefurst"><img src="https://avatars.githubusercontent.com/u/16591705?v=4" width="75px;" alt="Felipe Furst"/><br /><sub><b>Felipe Furst</b></sub></a></td>
91 |   </tr>
92 | </table>
93 | 
94 | ## :memo: Licença
95 | 
96 | Este projeto está sob a licença GNU General Public License v3.0. Acesse [LICENSE](LICENSE) para mais detalhes.
97 | 


--------------------------------------------------------------------------------
/example/client/client.ts:
--------------------------------------------------------------------------------
  1 | import path from 'path';
  2 | import chalk from 'chalk';
  3 | import moment from 'moment';
  4 | import 'moment/locale/pt-br';
  5 | 
  6 | import SiTef from '../../src';
  7 | import config from '../shared/config';
  8 | import { messages, askQuestion, handleError } from '../shared/utils';
  9 | 
 10 | // Define o caminho para as DLLs do SiTef e instancia o client
 11 | const dlls = path.resolve(__dirname, '..', 'shared', 'bin', 'CliSiTef64I.dll');
 12 | const sitef = new SiTef(dlls);
 13 | 
 14 | // Função auxiliar para adicionar a timestamp nos logs
 15 | const now = () => chalk.green(`[${moment().format('LTS')}]`);
 16 | 
 17 | export const configurar = async () => {
 18 |   console.log(`\n${now()} Configurando o SiTef`);
 19 | 
 20 |   try {
 21 |     const response = await sitef.configurar(config);
 22 |     const message = messages.configuracao[response];
 23 |     console.log(now(), message, '\n');
 24 |   } catch (error) {
 25 |     handleError(error);
 26 |   }
 27 | };
 28 | 
 29 | export const verificarPresenca = async () => {
 30 |   console.log(`\n${now()} Verificando a presença do PinPad`);
 31 | 
 32 |   try {
 33 |     const response = await sitef.verificarPresenca();
 34 |     const message = messages.verificacaoPresenca[response];
 35 |     console.log(now(), message, '\n');
 36 |   } catch (error) {
 37 |     handleError(error);
 38 |   }
 39 | };
 40 | 
 41 | export const escreverMensagem = async () => {
 42 |   try {
 43 |     // Lê a mensagem que será escrita no PinPad
 44 |     const question = 'Qual mensagem deseja escrever (max. 30 letras): ';
 45 |     let message = await askQuestion(question);
 46 | 
 47 |     // Escreve a mensagem e processa o retorno
 48 |     const response = await sitef.escreverMensagem(message);
 49 |     message =
 50 |       response === 0
 51 |         ? 'Mensagem escrita com sucesso.'
 52 |         : 'Não foi possível escrever a mensagem.';
 53 | 
 54 |     console.log(`\n${now()}`, message, '\n');
 55 |   } catch (error) {
 56 |     handleError(error);
 57 |   }
 58 | };
 59 | 
 60 | const criaObjetoFuncao = (funcao: string, valor: string) => ({
 61 |   funcao: parseInt(funcao),
 62 |   valor: parseFloat(valor).toFixed(2).replace('.', ','),
 63 |   cupomFiscal: '12345678',
 64 |   dataFiscal: moment().format('YYYYMMDD'),
 65 |   horaFiscal: moment().format('HHmm'),
 66 |   operador: 'Teste',
 67 |   parametros: '[10;11;12;13;14;19;20;28;29;31;32;33;34;35;36]',
 68 | });
 69 | 
 70 | export const simularFuncao = async () => {
 71 |   let bufferRetorno = '';
 72 | 
 73 |   try {
 74 |     // Lê a função e o valor da função
 75 |     const funcao = await askQuestion('Qual a função? ');
 76 |     const valor = await askQuestion('Qual o valor? ');
 77 | 
 78 |     // Inicia a função
 79 |     console.log(`\n${now()} Iniciando a função`);
 80 | 
 81 |     // Envia o objeto contendo os dados da função. Esses dados são específicos do SiTef que estou utilizando,
 82 |     // então fique a vontade para alterar os parâmetros
 83 |     const objFuncao = criaObjetoFuncao(funcao, valor);
 84 |     let retorno = await sitef.iniciarFuncao(objFuncao);
 85 | 
 86 |     // Objeto contendo os retornos do SiTef que devem ser passados para função de continuação
 87 |     let tefMessage = {
 88 |       comando: 0,
 89 |       tipoCampo: 0,
 90 |       tamMinimo: 0,
 91 |       tamMaximo: 0,
 92 |       buffer: '',
 93 |       tamanhoBuffer: 0,
 94 |       continua: 0,
 95 |     };
 96 | 
 97 |     // Inicia o ciclo da função, conforme descrito na documentação
 98 |     while (retorno === 10000) {
 99 |       // Chama a função de continuação da função e finaliza o ciclo caso o retorno seja inválido
100 |       const continua = await sitef.continuarFuncao(tefMessage);
101 |       if (!continua) break;
102 | 
103 |       const { comando: cmd, buffer, retorno: ret } = continua;
104 |       retorno = ret;
105 | 
106 |       // Escreve as mensagens de retorno e de buffer, caso retornado alguma
107 |       console.log(
108 |         now(),
109 |         messages.funcao[ret] || `Retorno desconhecido (${ret})`
110 |       );
111 |       if (buffer) console.log(now(), buffer);
112 | 
113 |       // Limpa ou escreve no buffer, dependendo do comando
114 |       if ([20, 21].includes(cmd) || (cmd >= 30 && cmd <= 35) || cmd === 42) {
115 |         bufferRetorno = await askQuestion('Retorno: ');
116 |       } else {
117 |         bufferRetorno = '';
118 |       }
119 | 
120 |       // Por fim, atualiza os parâmetros da continuação para continuar o ciclo
121 |       tefMessage = {
122 |         ...tefMessage,
123 |         ...continua,
124 |         buffer: bufferRetorno,
125 |         tamanhoBuffer: bufferRetorno.length,
126 |       };
127 |     }
128 | 
129 |     // Por fim, finaliza a função
130 |     const objFinalizacao = {
131 |       ...objFuncao,
132 |       confirma: 1,
133 |       parametros: '',
134 |     };
135 |     await sitef.finalizarFuncao(objFinalizacao);
136 | 
137 |     const message = messages.funcao[retorno];
138 |     console.log(now(), message, '\n');
139 |   } catch (error) {
140 |     handleError(error);
141 |   }
142 | };
143 | 


--------------------------------------------------------------------------------
/lib/nodesitef.cpp:
--------------------------------------------------------------------------------
  1 | #include "nodesitef.hpp"
  2 | #include "promises/promises.hpp"
  3 | 
  4 | #ifdef _WIN32
  5 | HMODULE handler;
  6 | #endif
  7 | 
  8 | #ifdef linux
  9 | void *handler;
 10 | #endif
 11 | 
 12 | Value carregarDLL(const CallbackInfo &info)
 13 | {
 14 |   Env env = info.Env();
 15 | 
 16 |   if (handler)
 17 |     return Boolean::New(env, true);
 18 | 
 19 |   if (info.Length() < 1)
 20 |     napi_throw_error(env, "0", "Informe o caminho da DLL.");
 21 |   else if (!info[0].IsString())
 22 |     napi_throw_type_error(env, "1", "O caminho informado não é uma string válida.");
 23 |   else
 24 |   {
 25 |     string path = info[0].ToString().Utf8Value();
 26 |     #ifdef _WIN32
 27 |     handler = LoadLibrary(path.c_str());
 28 |     #endif
 29 | 
 30 |     #ifdef linux
 31 |     handler = dlopen(path.c_str(), RTLD_LAZY);
 32 |     #endif
 33 | 
 34 |     if (!handler)
 35 |       napi_throw_type_error(env, "2", "Não foi possível carregar a DLL.");
 36 |     else
 37 |       return Boolean::New(env, true);
 38 |   }
 39 | 
 40 |   return env.Null();
 41 | }
 42 | 
 43 | int configuraIntSiTefInterativo(const char *ip, const char *terminal, const char *loja, const char *reservado, const char *parametrosAdicionais)
 44 | {
 45 |   if (!handler)
 46 | 
 47 |     throw("Carregue a DLL do SiTef!");
 48 | 
 49 |   #ifdef _WIN32
 50 |   ConfiguraIntSiTefInterativoEx configuraSitef = (ConfiguraIntSiTefInterativoEx)GetProcAddress(handler, "ConfiguraIntSiTefInterativoEx");
 51 |   #endif
 52 | 
 53 |   #ifdef linux
 54 |   ConfiguraIntSiTefInterativoEx configuraSitef = (ConfiguraIntSiTefInterativoEx)dlsym(handler, "ConfiguraIntSiTefInterativoEx");
 55 |   #endif
 56 | 
 57 |   return configuraSitef(
 58 |       ip,
 59 |       terminal,
 60 |       loja,
 61 |       reservado,
 62 |       parametrosAdicionais);
 63 | }
 64 | 
 65 | int verificaPresencaPinPad()
 66 | {
 67 |   if (!handler)
 68 |     throw("Carregue a DLL do SiTef!");
 69 | 
 70 |   #ifdef _WIN32
 71 |   VerificaPresencaPinPad verificaPresenca = (VerificaPresencaPinPad)GetProcAddress(handler, "VerificaPresencaPinPad");
 72 |   #endif
 73 | 
 74 |   #ifdef linux
 75 |   VerificaPresencaPinPad verificaPresenca = (VerificaPresencaPinPad)dlsym(handler, "VerificaPresencaPinPad");
 76 |   #endif
 77 | 
 78 |   return verificaPresenca();
 79 | }
 80 | 
 81 | int escreveMensagemPermanentePinPad(const char *mensagem)
 82 | {
 83 |   if (!handler)
 84 |     throw("Carregue a DLL do SiTef!");
 85 | 
 86 |   #ifdef _WIN32
 87 |   EscreveMensagemPermanentePinPad escreveMensagem = (EscreveMensagemPermanentePinPad)GetProcAddress(handler, "EscreveMensagemPermanentePinPad");
 88 |   #endif
 89 | 
 90 |   #ifdef linux
 91 |   EscreveMensagemPermanentePinPad escreveMensagem = (EscreveMensagemPermanentePinPad)dlsym(handler, "EscreveMensagemPermanentePinPad");
 92 |   #endif
 93 | 
 94 |   return escreveMensagem(mensagem);
 95 | }
 96 | 
 97 | int leSimNaoPinPad(const char *mensagem)
 98 | {
 99 |   if (!handler)
100 |     throw("Carregue a DLL do SiTef!");
101 | 
102 |   #ifdef _WIN32
103 |   LeSimNaoPinPad escreveMensagem = (LeSimNaoPinPad)GetProcAddress(handler, "LeSimNaoPinPad");
104 |   #endif
105 | 
106 |   #ifdef linux
107 |   LeSimNaoPinPad escreveMensagem = (LeSimNaoPinPad)dlsym(handler, "LeSimNaoPinPad");
108 |   #endif
109 | 
110 |   return escreveMensagem(mensagem);
111 | }
112 | 
113 | int iniciaFuncaoSiTefInterativo(int funcao, const char *valor, const char *cupomFiscal, const char *dataFiscal, const char *horaFiscal, const char *operador, const char *paramAdicionais)
114 | {
115 |   if (!handler)
116 |     throw("Carregue a DLL do SiTef!");
117 | 
118 |   #ifdef _WIN32
119 |   IniciaFuncaoSiTefInterativo iniciaFuncao = (IniciaFuncaoSiTefInterativo)GetProcAddress(handler, "IniciaFuncaoSiTefInterativo");
120 |   #endif
121 | 
122 |   #ifdef linux
123 |   IniciaFuncaoSiTefInterativo iniciaFuncao = (IniciaFuncaoSiTefInterativo)dlsym(handler, "IniciaFuncaoSiTefInterativo");
124 |   #endif
125 | 
126 |   return iniciaFuncao(
127 |       funcao,
128 |       valor,
129 |       cupomFiscal,
130 |       dataFiscal,
131 |       horaFiscal,
132 |       operador,
133 |       paramAdicionais);
134 | }
135 | 
136 | int continuaFuncaoSiTefInterativo(int *comando, long *tipoCampo, int *tamMinimo, int *tamMaximo, char *buffer, int tamBuffer, int continua)
137 | {
138 |   if (!handler)
139 |     throw("Carregue a DLL do SiTef!");
140 | 
141 |   #ifdef _WIN32
142 |   ContinuaFuncaoSiTefInterativo continuaFuncao = (ContinuaFuncaoSiTefInterativo)GetProcAddress(handler, "ContinuaFuncaoSiTefInterativo");
143 |   #endif
144 | 
145 |   #ifdef linux
146 |   ContinuaFuncaoSiTefInterativo continuaFuncao = (ContinuaFuncaoSiTefInterativo)dlsym(handler, "ContinuaFuncaoSiTefInterativo");
147 |   #endif
148 | 
149 |   return continuaFuncao(
150 |       comando,
151 |       tipoCampo,
152 |       tamMinimo,
153 |       tamMaximo,
154 |       buffer,
155 |       tamBuffer,
156 |       continua);
157 | }
158 | 
159 | void finalizaFuncaoSiTefInterativo(int confirma, const char *cupomFiscal, const char *dataFiscal, const char *horaFiscal, const char *paramAdicionais)
160 | {
161 |   if (!handler)
162 | 
163 |     throw("Carregue a DLL do SiTef!");
164 | 
165 |   #ifdef _WIN32
166 |   FinalizaFuncaoSiTefInterativo finalizaFuncao = (FinalizaFuncaoSiTefInterativo)GetProcAddress(handler, "FinalizaFuncaoSiTefInterativo");
167 |   #endif
168 | 
169 |   #ifdef linux
170 |   FinalizaFuncaoSiTefInterativo finalizaFuncao = (FinalizaFuncaoSiTefInterativo)dlsym(handler, "FinalizaFuncaoSiTefInterativo");
171 |   #endif
172 | 
173 |   finalizaFuncao(confirma, cupomFiscal, dataFiscal, horaFiscal, paramAdicionais);
174 | }
175 | 
176 | Object Init(Env env, Object exports)
177 | {
178 |   exports.Set(
179 |       String::New(env, "carregarDLL"),
180 |       Function::New(env, carregarDLL));
181 | 
182 |   exports.Set(
183 |       String::New(env, "configuraIntSiTefInterativo"),
184 |       Function::New(env, ConfigPromise::Create));
185 | 
186 |   exports.Set(
187 |       String::New(env, "verificaPresencaPinPad"),
188 |       Function::New(env, VerificarPresencaPromise::Create));
189 | 
190 |   exports.Set(
191 |       String::New(env, "leSimNaoPinPad"),
192 |       Function::New(env, LeSimNaoPromise::Create));
193 | 
194 |   exports.Set(
195 |       String::New(env, "escreveMensagemPermanentePinPad"),
196 |       Function::New(env, EscreverMensagemPromise::Create));
197 | 
198 |   exports.Set(
199 |       String::New(env, "iniciaFuncaoSiTefInterativo"),
200 |       Function::New(env, IniciaFuncaoPromise::Create));
201 | 
202 |   exports.Set(
203 |       String::New(env, "continuaFuncaoSiTefInterativo"),
204 |       Function::New(env, ContinuaFuncaoPromise::Create));
205 | 
206 |   exports.Set(
207 |       String::New(env, "finalizaFuncaoSiTefInterativo"),
208 |       Function::New(env, FinalizaFuncaoPromise::Create));
209 | 
210 |   return exports;
211 | }
212 | 
213 | NODE_API_MODULE(nodesitef, Init);
214 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------