def test_get_user_config_filename_windows():
"""get_user_config_filename in Windows"""
# prepare environment
os.environ['APPDATA'] = r"C:/Users/Test/AppData"
platform.system = MagicMock(return_value='Windows')
eq_(get_user_config_filename('Test1'),
r"C:/Users/Test/AppData/Test1/Test1.cfg")
eq_(get_user_config_filename('Test2'),
r"C:/Users/Test/AppData/Test2/Test2.cfg")
def test_get_user_config_filename_windows():
"""get_user_config_filename in Windows"""
# prepare environment
os.environ['APPDATA'] = r"C:/Users/Test/AppData"
platform.system = MagicMock(return_value='Windows')
eq_(get_user_config_filename('Test1'),
r"C:/Users/Test/AppData/Test1/Test1.cfg")
eq_(get_user_config_filename('Test2'),
r"C:/Users/Test/AppData/Test2/Test2.cfg")
def test_get_user_config_filename_darwin():
"""
get_user_config_filename in Darwin
"""
# prepare environment
os.environ['USER'] = "******"
os.environ['HOME'] = "/home/TestUser"
platform.system = MagicMock(return_value='Darwin')
eq_(get_user_config_filename('Test1'), r"/home/TestUser/.Test1.cfg")
eq_(get_user_config_filename('Test2'), r"/home/TestUser/.Test2.cfg")
def test_get_user_config_filename_linux_non_freedesktop():
"""
get_user_config_filename in Linux (non freedesktop.org)
"""
# prepare environment
os.path.exists = lambda x: False
os.environ['USER'] = "******"
os.environ['HOME'] = "/home/TestUser"
platform.system = MagicMock(return_value='Linux')
eq_(get_user_config_filename('Test1'), r"/home/TestUser/.Test1.cfg")
eq_(get_user_config_filename('Test2'), r"/home/TestUser/.Test2.cfg")
def test_get_user_config_filename_unknown():
"""
get_user_config_filename in Unknown
"""
# prepare environment
os.environ['USER'] = "******"
os.environ['HOME'] = "/home/TestUser"
platform.system = MagicMock(return_value='Unknown')
eq_(get_user_config_filename('Test1'),
r"/home/TestUser/Test1.cfg")
eq_(get_user_config_filename('Test2'),
r"/home/TestUser/Test2.cfg")
def test_get_user_config_filename_linux_non_freedesktop():
"""
get_user_config_filename in Linux (non freedesktop.org)
"""
# prepare environment
os.path.exists = lambda x: False
os.environ['USER'] = "******"
os.environ['HOME'] = "/home/TestUser"
platform.system = MagicMock(return_value='Linux')
eq_(get_user_config_filename('Test1'),
r"/home/TestUser/.Test1.cfg")
eq_(get_user_config_filename('Test2'),
r"/home/TestUser/.Test2.cfg")
def test_get_user_config_filename_linux_with_xdg_config_home():
"""
get_user_config_filename in Linux (with XDG_CONFIG_HOME)
"""
# prepare environment
os.path.exists = lambda x: True
os.environ['USER'] = "******"
os.environ['HOME'] = "/home/TestUser"
os.environ['XDG_CONFIG_HOME'] = "~/.test_config"
platform.system = MagicMock(return_value='Linux')
eq_(get_user_config_filename('Test1'),
r"/home/TestUser/.test_config/Test1/Test1.cfg")
eq_(get_user_config_filename('Test2'),
r"/home/TestUser/.test_config/Test2/Test2.cfg")
def test_get_user_config_filename_linux_with_xdg_config_home():
"""
get_user_config_filename in Linux (with XDG_CONFIG_HOME)
"""
# prepare environment
os.path.exists = lambda x: True
os.environ['USER'] = "******"
os.environ['HOME'] = "/home/TestUser"
os.environ['XDG_CONFIG_HOME'] = "~/.test_config"
platform.system = MagicMock(return_value='Linux')
eq_(get_user_config_filename('Test1'),
r"/home/TestUser/.test_config/Test1/Test1.cfg")
eq_(get_user_config_filename('Test2'),
r"/home/TestUser/.test_config/Test2/Test2.cfg")
# coding=utf-8
"""
Compatibility module
"""
__author__ = 'Alisue <*****@*****.**>'
try:
# pip install keyring
import keyring
except ImportError:
# use alternative keyring which use plaintext.
# it is strongly not recommended
import os
from notify.utils.plaintext_keyring import PlaintextKeyring
from notify.conf import get_user_config_filename
filename = os.path.splitext(get_user_config_filename())[0]
filename = filename + ".keyring"
keyring = PlaintextKeyring(filename)
try:
from email.header import Header
from email.mime.text import MIMEText
from email.utils import formatdate
except ImportError:
# old way
from email.Header import Header
from email.MIMEText import MIMEText
from email.Utils import formatdate
def setup_wizard(config):
from notify.compat import keyring
print
print "#" * 50
print "#", "#".rjust(48)
print "#", "notify setup wizard".center(46), "#"
print "#", "#".rjust(48)
print "#" * 50
print
print "Note: square bracket enclosed text indicate the current value"
print
# SMTP section
host = config.get('smtp', 'host', raw=True)
port = config.get('smtp', 'port', raw=True)
print "1. Please enter mail user agent host address [%s]" % host
host = console_input(host)
print "2. Please enter mail user agent port number [%s]" % port
print "|"
print "| The following port numbers are usually used."
print "| - 25 : A default SMTP port"
print "| - 465 : A default SMTP over SSL port"
print "| - 587 : A default submission port"
print "|"
port = console_input(port, validate_int)
# Mail section
from_addr = config.get('mail', 'from_addr', raw=True)
to_addr = config.get('mail', 'to_addr', raw=True)
subject = config.get('mail', 'subject', raw=True)
encoding = config.get('mail', 'encoding', raw=True)
print "3. Please enter an email address for 'from' [%s]" % from_addr
from_addr = console_input(from_addr, validate_email)
print "4. Please enter an email address for 'to' [%s]" % to_addr
to_addr = console_input(to_addr, validate_email)
print "5. Please enter an email subject [%s]" % subject
print "|"
print "| The following special string are available."
print "| - %(prog)s : A program name executed."
print "| - %(status)s : A exit status of executed."
print "|"
subject = console_input(subject)
print "6. Please enter an email encoding [%s]" % encoding
encoding = console_input(encoding)
# Auth section
username = config.get('auth', 'username', raw=True)
password = keyring.get_password('notify', username) or ""
print "7. Please enter an username for authentication [%s]" % username
print "|"
print "| To remove username, input 'REMOVE'"
print "|"
username = console_input(username, allow_empty=True)
if username == 'REMOVE':
username = ""
print "8. Please enter an password for authentication"
print "|"
print "| To remove password, input 'REMOVE'"
print "|"
password = console_input(password, allow_empty=True)
if password == "REMOVE":
password = ""
# save into config
config.set('smtp', 'host', host)
config.set('smtp', 'port', str(port))
config.set('mail', 'from_addr', from_addr)
config.set('mail', 'to_addr', to_addr)
config.set('mail', 'subject', subject)
config.set('mail', 'encoding', encoding)
config.set('auth', 'username', username)
# do not store password in config file
if username:
if password:
keyring.set_password('notify', username, password)
elif keyring.get_password('notify', username):
keyring.delete_password('notify', username)
# save config
import os
import codecs
from notify.conf import get_user_config_filename
filename = get_user_config_filename()
if not os.path.exists(os.path.dirname(filename)):
os.makedirs(os.path.dirname(filename))
try:
fo = codecs.open(filename, 'wb', 'utf-8')
config.write(fo)
finally:
fo.close()
def setup_wizard(config):
from notify.compat import keyring
print
print "#" * 50
print "#", "#".rjust(48)
print "#", "notify setup wizard".center(46), "#"
print "#", "#".rjust(48)
print "#" * 50
print
print "Note: square bracket enclosed text indicate the current value"
print
# SMTP section
host = config.get('smtp', 'host', raw=True)
port = config.get('smtp', 'port', raw=True)
print "1. Please enter mail user agent host address [%s]" % host
host = console_input(host)
print "2. Please enter mail user agent port number [%s]" % port
print "|"
print "| The following port numbers are usually used."
print "| - 25 : A default SMTP port"
print "| - 465 : A default SMTP over SSL port"
print "| - 587 : A default submission port"
print "|"
port = console_input(port, validate_int)
# Mail section
from_addr = config.get('mail', 'from_addr', raw=True)
to_addr = config.get('mail', 'to_addr', raw=True)
subject = config.get('mail', 'subject', raw=True)
encoding = config.get('mail', 'encoding', raw=True)
print "3. Please enter an email address for 'from' [%s]" % from_addr
from_addr = console_input(from_addr, validate_email)
print "4. Please enter an email address for 'to' [%s]" % to_addr
to_addr = console_input(to_addr, validate_email)
print "5. Please enter an email subject [%s]" % subject
print "|"
print "| The following special string are available."
print "| - %(prog)s : A program name executed."
print "| - %(status)s : A exit status of executed."
print "|"
subject = console_input(subject)
print "6. Please enter an email encoding [%s]" % encoding
encoding = console_input(encoding)
# Auth section
username = config.get('auth', 'username', raw=True)
password = keyring.get_password('notify', username) or ""
print "7. Please enter an username for authentication [%s]" % username
print "|"
print "| To remove username, input 'REMOVE'"
print "|"
username = console_input(username, allow_empty=True)
if username == 'REMOVE':
username = ""
print "8. Please enter an password for authentication"
print "|"
print "| To remove password, input 'REMOVE'"
print "|"
password = console_input(password, allow_empty=True)
if password == "REMOVE":
password = ""
# save into config
config.set('smtp', 'host', host)
config.set('smtp', 'port', str(port))
config.set('mail', 'from_addr', from_addr)
config.set('mail', 'to_addr', to_addr)
config.set('mail', 'subject', subject)
config.set('mail', 'encoding', encoding)
config.set('auth', 'username', username)
# do not store password in config file
if username:
if password:
keyring.set_password('notify', username, password)
elif keyring.get_password('notify', username):
keyring.delete_password('notify', username)
# save config
import os
import codecs
from notify.conf import get_user_config_filename
filename = get_user_config_filename()
if not os.path.exists(os.path.dirname(filename)):
os.makedirs(os.path.dirname(filename))
try:
fo = codecs.open(filename, 'wb', 'utf-8')
config.write(fo)
finally:
fo.close()