13. Exercício [Cálculo de impostos] com um serviço web

Voltamos ao exercício [TAXES] já abordado nas secções 4.2, 4.3, 8 e 10.

13.1. O servidor

Estamos a trabalhar com a seguinte arquitetura cliente-servidor:

No lado do servidor, utilizaremos novamente uma arquitetura de três camadas. A camada [DAO] será implementada pela classe ImpotsMySQL utilizada na versão com o SGBD MySQL na secção 10. A camada [business] será implementada pela classe [ImpotsMetier] já estudada. Resta apenas escrever o serviço web. Este serviço recebe um parâmetro params dos seus clientes na forma params= yes,2,200000, em que o primeiro elemento indica se o contribuinte é casado ou não, o segundo o número de filhos e o terceiro o seu salário anual.

O serviço web é o seguinte (impots_web_01):

#   !D:\Programs\ActivePython\Python2.7.2\python.exe

#    -*- coding=Utf-8 -*-
#    import of Impots* class module
from impots import *
import cgi,cgitb,re

#    allow debugging information to be displayed
cgitb.enable()
sys.stderr=sys.stdout

# ------------------------------------------------ 
#  tax web service
# ------------------------------------------------ 

#  the data required to calculate the tax has been placed in table mysqL TABLE
#  belonging to the BASE database. The table has the following structure
#    limits decimal(10,2), coeffR decimal(6,2), coeffN decimal(10,2)
#  taxable person parameters (marital status, number of children, annual salary)
#  are sent by the customer in the form params=marital status, number of children, annual salary
#  results (marital status, number of children, annual salary, tax payable) are returned to the customer
#  in the form <impot>value</impot>
#  or as <error>msg</error>, if parameters are invalid

#  the server returns unformatted text to the client
print "Content-Type: text/plain\n"

#    definition of constants
USER="root"
PWD=""
HOTE="localhost"
BASE="dbimpots"
TABLE="impots"


#  we create the [metier] layer
#    Python doesn't seem to support sessions
#  in PHP, we would have used a session to memorize the metier object
#  here, it is systematically constructed from data in the MySQL database

#    instantiation layer [metier]
try:
    metier=ImpotsMetier(ImpotsMySQL(HOTE,USER,PWD,BASE,TABLE))
except (IOError, ImpotsError) as infos:
    print ("<erreur>Une erreur s'est produite : {0}</erreur>".format(infos))
    sys.exit()

#  retrieve the line sent by the client to the server
params=cgi.FieldStorage().getlist('params')
#  if no parameters then error
if not params:
  print "<erreur>Le parametre [params] est absent<erreur>"
  sys.exit()

#  we use the params parameter  
items=params[0].strip().lower().split(',')
#  there must be only 3 fields
if len(items)!=3:
  print "<erreur>[%s] : nombre de parametres invalide</erreur>" % (params[0])
  sys.exit()
#  first parameter (marital status) must be yes/no
marie=items[0].strip()
if marie!="oui" and marie != "non":
  print "<erreur>[%s] : 1er parametre invalide</erreur>\n"% (params[0])
  sys.exit()
#  the second parameter (number of children) must be an integer
match=re.match(r"^\s*(\d+)\s*$",items[1])
if not match:
  print "<erreur>[%s] : 2ieme parametre invalide</erreur>\n"% (params[0])
  sys.exit()
enfants=int(match.groups()[0])
#  the third parameter (salary) must be an integer
match=re.match(r"^\s*(\d+)\s*$",items[2])
if not match:
  print "<erreur>[%s] : 3ieme parametre invalide</erreur>\n"% (params[0])
  sys.exit()
salaire=int(match.groups()[0])
#  tax calculation
impot=metier.calculer(marie,enfants,salaire)
#  return the result
print "<impot>%s</impot>\n" % (impot)
#    end

Notas:

• linha 5: importa os objetos do ficheiro impots.py;
• linha 9: Depurar um script CGI pode ser problemático. O módulo cgitb envia o motivo da falha em caso de erro. Para tal, é necessário redirecionar a saída de erro padrão (sys.stderr) para a saída padrão (sys.stdout) (linha 10);
• linha 26: o cabeçalho HTTP que especifica a natureza do documento que está a ser enviado, neste caso, texto não formatado. O serviço web devolve a sua resposta como uma única linha de texto:
  • <error>message</error> se houver um erro;
  • <tax>valor</tax> onde valor é o montante do imposto.
• linha 43: instanciação das camadas [dao] e [business];
• linhas 44–46: se ocorrer um erro de instanciação, o script envia a sua resposta e termina;
• linhas 49-53: o parâmetro «params» é recuperado. Se estiver em falta, o script envia a sua resposta e termina;
• linha 56: o parâmetro «yes,2,200000» é dividido em 3 campos na matriz de itens;
• linhas 58-77: verifica-se a validade dos 3 campos. Se houver um erro, o script envia a sua resposta e termina;
• linha 79: o imposto é calculado;
• linha 81: e enviado ao cliente.

Num navegador web, obtêm-se os seguintes resultados:

13.2. Um cliente programado

---

O programa (client_impots_web_01)

---

#    -*- coding=utf-8 -*-

import httplib,urllib,re

#    constant
HOST="localhost"
URL="/cgi-bin/impots_web_01b.py"
data=("oui,2,200000","non,2,200000","oui,3,200000","non,3,200000","x,y,z,t","x,2,200000", "oui,x,200000","oui,2,x");

#    connection
connexion=httplib.HTTPConnection(HOST)
#    follow-up
#   connexion.set_debuglevel(1)
#  loop over the data to be sent to the server
for params in data:
    #  parameters must be encoded before being sent to the server
    parametres = urllib.urlencode({'params': params})
    #  send request
    connexion.request("POST",URL,parametres)
    #  answer processing (text line)
    reponse=connexion.getresponse().read()
    lignes=reponse.split("\n")
    #  the text line is of the form
    #    <impot>xxx</impot>
    #  or <error>xxx</error>
    impot=re.match(r"^<impot>(\S+)</impot>\s*$",lignes[0])
    if impot:
        print "params=%s, impot=%s" % (params,impot.groups()[0])
    else:
        erreur=re.match(r"^<erreur>(.+)</erreur>\s*$",lignes[0])
        if erreur:
            print "params=%s, erreur=%s" % (params,erreur.groups()[0])
        else:
            print lignes
#    locking connection
connexion.close()

13.3. Resultados

params=oui,2,200000, impot=22504.0
params=non,2,200000, impot=33388.0
params=oui,3,200000, impot=16400.0
params=non,3,200000, impot=22504.0
params=x,y,z,t, erreur=[x,y,z,t] : nombre de parametres invalide
params=x,2,200000, erreur=[x,2,200000] : 1er parametre invalide
params=oui,x,200000, erreur=[oui,x,200000] : 2ieme parametre invalide
params=oui,2,x, erreur=[oui,2,x] : 3ieme parametre invalide