User:Andre Castro/prototyping/1.2/traces: Difference between revisions

From XPUB & Lens-Based wiki
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Trance=
=Trance=
<b>About the project:</b>
<b>About the project:</b>
Traces is a story written by Giulia Ciliberto,
told by email in short parts, one per day


==Links==


'''
Front-end:
http://pzwart3.wdka.hro.nl/~slorusso/traces/'''


Form handler:
/home/acastro/public_html/cgi-bin/traces_form_handler.cgi


<b>TO DO</b>
* Emails sent must be UTF-8


Text:
/home/acastro/public_html/cgi-bin/traces-text.txt


==Links==
Database:
>>>> '''http://pzwart3.wdka.hro.nl/~slorusso/traces/'''
/home/acastro/public_html/cgi-bin/traces-database.xml




https://docs.google.com/Doc?docid=dcwxmjc8_17pr7bbsgz original text
==Part1 Form and email subscription into database==
 
http://pzwart3.wdka.hro.nl/~acastro/cgi-bin/traces_form_handler.cgi


Form handler:
/home/acastro/public_html/cgi-bin/traces_form_handler.cgi


database in:
* users subscribe their email address in front-end
http://pzwart3.wdka.hro.nl/~acastro/cgi-bin/traces-database.xml
 
==Part1 Form and email subscription into database==


* online form: where users subscribe their email address
* html page calls traces_form_handler.cgi


* cgi receives email address appends it within the today's date node in traces-database.xml
* cgi receives email address appends it within the today's date node in traces-database.xml




http://pzwart3.wdka.hro.nl/~acastro/cgi-bin/traces_form_handler.cgi:


<source lang="python">
<source lang="python">
#!/usr/bin/python2.6
#!/usr/bin/python2.6
import cgi, cgitb, lxml.etree, datetime, os
import cgi, cgitb, lxml.etree, datetime, os
from datetime import *
date_now = datetime.now()
today = date_now.strftime("%Y-%m-%d")
date_delta = timedelta(days=22)
date_old = (date_now - date_delta).strftime("%Y-%m-%d")
print date_old


today = datetime.datetime.now().strftime("%Y-%m-%d") #not sure is this is the best format


# Create instance of FieldStorage  
# Create instance of FieldStorage  
Line 43: Line 53:




print "Content-Type: text/html" 
print                       
print "<TITLE>Form</TITLE>"
print "<H4>Your form was successfully added.<br />Shortly you will receive a message at %s </H4>" % (email)


#APPEND EMAIL AND DATE TO XML FILE
#APPEND EMAIL AND DATE TO XML FILE
Line 54: Line 60:
doc = lxml.etree.parse('/home/acastro/public_html/cgi-bin/traces-database.xml')
doc = lxml.etree.parse('/home/acastro/public_html/cgi-bin/traces-database.xml')
entries = doc.find('entries') # find root element
entries = doc.find('entries') # find root element
node_today = '//date[@date="'+ str(today) + '"]'
node_today = '//date[@date="'+ str(today) + '"]'
old_node = '//date[@date="'+ str(date_old ) + '"]'
 
#remove outdated addresses
for outdated in doc.xpath(old_node):
outdated.getparent().remove(outdated)# here I grab the parent of the element to call the remove directly on it
 
#check if todays date element is present
#check if todays date element is present
if today not in doc.xpath('//@date'):  
if today not in doc.xpath('//@date'):  
Line 61: Line 73:
addrs = lxml.etree.SubElement(date, "address")#append grandchild
addrs = lxml.etree.SubElement(date, "address")#append grandchild
addrs.text = str(email)
addrs.text = str(email)
doc.write('/home/acastro/public_html/cgi-bin/traces-database.xml', xml_declaration=True,  encoding='utf-8') #write
 
else:
else:
test = doc.xpath(node_today)
test = doc.xpath(node_today)
addrs = lxml.etree.SubElement(test[0], "address")#append grandchild
addrs = lxml.etree.SubElement(test[0], "address")#append grandchild
addrs.text = email
addrs.text = email
doc.write('/home/acastro/public_html/cgi-bin/traces-database.xml', xml_declaration=True, encoding='utf-8') #write
 
doc.write('/home/acastro/public_html/cgi-bin/traces-database.xml',xml_declaration=True,encoding='utf-8') #write
 
 


else:   
else:   
Line 80: Line 95:


</source>
</source>


==part2 and 3 Days calculations and sending emails==  
==part2 and 3 Days calculations and sending emails==  




Script which parses xml database. Checks the dates and email address under each date.
/home/acastro/public_html/cgi-bin/traces_date_email.py


According the date decide what part of story will be told
Script which parses xml database.
Checks the dates and email address under each date.
According the date decides what part of story will be send


<b>WRITE MORE</b>


<source lang="python">
<source lang="python">
Line 96: Line 114:
import smtplib, email.utils
import smtplib, email.utils
from email.mime.text import MIMEText
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
from datetime import *
from datetime import *


Line 106: Line 125:


   
   
text_file = open('traces-text.txt', "r")
text_file = open('/home/acastro/public_html/cgi-bin/traces-text.txt', "r")
text = text_file.read() #CONTENT INTO VARIABLE !!!!
text = text_file.read() #CONTENT INTO VARIABLE !!!!


text_splited = text.split("\n\n@\n\n")
text_splited = text.split("\n\n@\n\n")


print text_splited[0]
print '##'
print text_splited[1]
print '##'
print len(text_splited)


f = ('traces-database.xml') # ADD ABSOLUTE PATH
f = ('/home/acastro/public_html/cgi-bin/traces-database.xml')  
database = lxml.etree.parse(f)
database = lxml.etree.parse(f)
   
   
Line 128: Line 152:
#creat list of 19 day dates, today and before today  
#creat list of 19 day dates, today and before today  
dates = []
dates = []
for day in range(19):
for day in range(20):
date = date.today()
date = date.today()
delta = timedelta(days= day)
delta = timedelta(days= day)
Line 134: Line 158:
dates.append(str(subtract))
dates.append(str(subtract))
   
   
print dates




Line 146: Line 171:
email_addrs = dateDict[date] # list of receivers
email_addrs = dateDict[date] # list of receivers
print email_addrs
print email_addrs
email_body =  "\n\n @ \n" + text_splited[i] + "\n @ "
# EMAIL - (MAKE IT UTF-8)
email_body =  '<html><body><div style="text-align: center; font-family: serif; font-size: 15px;"><br/><br/>@<br/><br/>' + text_splited[i] + '<br/><br/>@<br/><br/></div></body></html>'
msg = MIMEText(email_body) #Create the message (simple ASCII)
 
msg = MIMEMultipart('alternative') #Create Multipart msg (allows html)
msg['To'] = email.utils.formataddr(('Recipient', 'readers@traces.net'))
msg['To'] = email.utils.formataddr(('Recipient', 'readers@traces.net'))
msg['From'] = email.utils.formataddr(('Traces', 'traces@noreply.net'))
msg['From'] = email.utils.formataddr(('Traces', 'traces@noreply.net'))
msg['Subject'] = 'Traces @ part#' + str((i+1))
msg['Subject'] = 'Traces @ part#' + str((i+1))
part_html = MIMEText(email_body, 'html')
msg.attach(part_html)
server = smtplib.SMTP('localhost')
server = smtplib.SMTP('localhost')
server.set_debuglevel(False) # show communication with the server
server.set_debuglevel(False) # show communication with the server
Line 158: Line 189:
finally:
finally:
server.quit()
server.quit()
   
   
</source>
</source>

Latest revision as of 16:05, 29 March 2012

Trance

About the project: Traces is a story written by Giulia Ciliberto, told by email in short parts, one per day

Links

Front-end: http://pzwart3.wdka.hro.nl/~slorusso/traces/

Form handler: /home/acastro/public_html/cgi-bin/traces_form_handler.cgi


Text: /home/acastro/public_html/cgi-bin/traces-text.txt

Database: /home/acastro/public_html/cgi-bin/traces-database.xml


Part1 Form and email subscription into database

Form handler: /home/acastro/public_html/cgi-bin/traces_form_handler.cgi

  • users subscribe their email address in front-end
  • html page calls traces_form_handler.cgi
  • cgi receives email address appends it within the today's date node in traces-database.xml


#!/usr/bin/python2.6
import cgi, cgitb, lxml.etree, datetime, os
from datetime import *

date_now = datetime.now()
today = date_now.strftime("%Y-%m-%d") 
date_delta = timedelta(days=22)

date_old = (date_now - date_delta).strftime("%Y-%m-%d") 
print date_old


# Create instance of FieldStorage 
form = cgi.FieldStorage() 
# Get email from form 
email = form.getvalue('email') 



#APPEND EMAIL AND DATE TO XML FILE

if os.path.exists('/home/acastro/public_html/cgi-bin/traces-database.xml'):
	#open file
	doc = lxml.etree.parse('/home/acastro/public_html/cgi-bin/traces-database.xml')
	entries = doc.find('entries') # find root element

	node_today = '//date[@date="'+ str(today) + '"]'
	old_node = '//date[@date="'+ str(date_old ) + '"]'

	#remove outdated addresses
	for outdated in doc.xpath(old_node):
		outdated.getparent().remove(outdated)# here I grab the parent of the element to call the remove directly on it

	#check if todays date element is present
	if today not in doc.xpath('//@date'): 
		date = lxml.etree.SubElement(entries, "date", attrib={'date':today} )  	#append date SubElement date
		addrs = lxml.etree.SubElement(date, "address")#append grandchild
		addrs.text = str(email)

	else:
		test = doc.xpath(node_today)
		addrs = lxml.etree.SubElement(test[0], "address")#append grandchild
		addrs.text = email

	doc.write('/home/acastro/public_html/cgi-bin/traces-database.xml',xml_declaration=True,encoding='utf-8') #write



else:  
	#Create a new file
	root = lxml.etree.Element('email-address')
	entries = lxml.etree.SubElement(root, 'entries')
	dates = lxml.etree.SubElement(entries, "date", attrib={'date':today} )  	#append date
	addrs = lxml.etree.SubElement(dates, "address")#append grandchild
	addrs.text = str(email)
	tree = lxml.etree.ElementTree(root)
	tree.write('/home/acastro/public_html/cgi-bin/traces-database.xml', pretty_print=True, xml_declaration=True,encoding='utf-8')
	tree.close()


part2 and 3 Days calculations and sending emails

/home/acastro/public_html/cgi-bin/traces_date_email.py

Script which parses xml database. Checks the dates and email address under each date. According the date decides what part of story will be send


#! /usr/bin/python
# coding: utf-8
import lxml.etree, re
import smtplib, email.utils
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
from datetime import *

# Script that:
# 1: parses xml database. 
# 2: Checks the dates and email address under each date 
# 3: Sends the corresponding email part

#CRON IT FOR 1 x per Day

 
text_file = open('/home/acastro/public_html/cgi-bin/traces-text.txt', "r")
text = text_file.read() #CONTENT INTO VARIABLE !!!!

text_splited = text.split("\n\n@\n\n")

print text_splited[0]
print '##'
print text_splited[1]
print '##'
print len(text_splited)

f = ('/home/acastro/public_html/cgi-bin/traces-database.xml') 
database = lxml.etree.parse(f)
 
dates = database.xpath('//date') # database find dates 
#create the dictionary {date: [address, address]}
dateDict = {}
for date_subscription in dates:
 
	date_is_attr = date_subscription.get("date")
	myAddrs = database.xpath("//date[@date='{0}']/address/text()".format(date_is_attr))
	dateDict[date_is_attr] = myAddrs
#print dateDict


#creat list of 19 day dates, today and before today 
dates = []
for day in range(20):
	date = date.today()
	delta = timedelta(days= day)
	subtract = date - delta	
	dates.append(str(subtract))
 
print dates


#checks the dates when emails were subscribe 
#matchs them with the dates list
#sends the corresponding email part
for date in dateDict.keys():
	print date
	for i, value in enumerate(dates):

		if str(date) == value:
			email_addrs = dateDict[date] # list of receivers
			print email_addrs
			
			email_body =  '<html><body><div style="text-align: center; font-family: serif; font-size: 15px;"><br/><br/>@<br/><br/>' + text_splited[i] + '<br/><br/>@<br/><br/></div></body></html>'		
		

			msg = MIMEMultipart('alternative') #Create Multipart msg (allows html)
			msg['To'] = email.utils.formataddr(('Recipient', 'readers@traces.net'))
			msg['From'] = email.utils.formataddr(('Traces', 'traces@noreply.net'))
			msg['Subject'] = 'Traces @ part#' + str((i+1))

			part_html = MIMEText(email_body, 'html')
			msg.attach(part_html)

			server = smtplib.SMTP('localhost')
			server.set_debuglevel(False) # show communication with the server
			try:
				server.sendmail('traces@noreply.net', email_addrs, msg.as_string())
			finally:
				server.quit()




Examples on sending email

  • multipart email - allows imgs attachments
import smtplib, email.utils
from email.mime.text import MIMEText
from email.mime.image import MIMEImage
from email.mime.multipart import MIMEMultipart

#Reference: http://docs.python.org/library/email-examples.html


# address list
addr = ['andrecastro@c-e-m.org', 'andrecastro83@gmail.com']#, 'silviolorusso@gmail.com']

msg = MIMEMultipart()
#msg = MIMEText('This is the b@dy of the message.') #Create the message (simple ASCII)
msg['To'] = email.utils.formataddr(('Recipient', 'readers@traces.net'))
msg['From'] = email.utils.formataddr(('Traces', 'traces@noreply.net'))
msg['Subject'] = 'Traces Multipart - test'

msg.attach( MIMEText('This is the b@dy of the email') )

#attach a picture
fp = open('animpnky_e0.gif', 'rb')
img = MIMEImage(fp.read())
fp.close()
msg.attach(img)


server = smtplib.SMTP('localhost')
server.set_debuglevel(False) # show communication with the server
try:
    server.sendmail('traces@noreply.net', addr, msg.as_string())
finally:
    server.quit()


  • text email - plain text
import smtplib, email.utils
from email.mime.text import MIMEText

# address list
addr = ['andrecastro@c-e-m.org', 'andrecastro83@gmail.com']
#, 'silviolorusso@gmail.com']

msg = MIMEText('This is the b@dy of the message.') #Create the message (simple ASCII)
msg['To'] = email.utils.formataddr(('Recipient', 'readers@traces.net'))
msg['From'] = email.utils.formataddr(('Traces', 'traces@noreply.net'))
msg['Subject'] = 'Traces plain - test '


server = smtplib.SMTP('localhost')
server.set_debuglevel(False) # show communication with the server
try:
    server.sendmail('traces@noreply.net', addr, msg.as_string())
finally:
    server.quit()