def validate_email(self, field):
field.data = field.data.lower()
if email_valid_p(field.data) != 1:
raise validators.ValidationError(
_("Supplied email address %(email)s is invalid.",
email=field.data)
)
# is email registered?
try:
User.query.filter(User.email == field.data).one()
except SQLAlchemyError:
raise validators.ValidationError(
_("Supplied email address %(email)s is not registered.",
email=field.data)
)
def task_submit_elaborate_specific_parameter(key, value, opts, args):
"""Elaborate specific cli parameters for oaiharvest."""
if key in ("-r", "--repository"):
task_set_option('repository', get_repository_names(value))
elif key in ("--workflow"):
task_set_option('workflow', get_repository_names(value))
elif key in ("-i", "--identifier"):
task_set_option('identifiers', get_identifier_names(value))
elif key in ("-d", "--dates"):
task_set_option('dates', get_dates(value))
if value is not None and task_get_option("dates") is None:
raise StandardError("Date format not valid.")
elif key in ("--notify-email-to",):
if email_valid_p(value):
task_set_option('notify-email-to', value)
else:
raise StandardError("E-mail format not valid.")
elif key in ("--create-ticket-in",):
task_set_option('create-ticket-in', value)
else:
return False
return True
def task_submit_elaborate_specific_parameter(key, value, opts, args):
"""Elaborate specific cli parameters for oaiharvest."""
if key in ("-r", "--repository"):
task_set_option('repository', get_repository_names(value))
elif key in ("--workflow"):
task_set_option('workflow', get_repository_names(value))
elif key in ("-i", "--identifier"):
task_set_option('identifiers', get_identifier_names(value))
elif key in ("-d", "--dates"):
task_set_option('dates', get_dates(value))
if value is not None and task_get_option("dates") is None:
raise StandardError("Date format not valid.")
elif key in ("--notify-email-to", ):
if email_valid_p(value):
task_set_option('notify-email-to', value)
else:
raise StandardError("E-mail format not valid.")
elif key in ("--create-ticket-in", ):
task_set_option('create-ticket-in', value)
else:
return False
return True
def Mail_New_Record_Notification(parameters, curdir, form, user_info=None):
"""
This function sends a mail giving notification about the submission
of a new item to the relevant recipients, including:
+ The record's Submitter(s);
+ The site ADMIN;
+ The record-type's "managers" (signified by the "submit_managers"
parameter);
The mail contains details of the new item's reference number(s), its
title and its author(s). It also contains a link to the item in the
Invenio repository.
@param parameters: (dictionary) - contains the following parameter
strings used by this function:
+ item_status: (string) - the status of the new item. It can be
either "ADDED" (in which case the new item has been integrated
into the repository), or "APPROVAL" (in which case the item is
awaiting a referee's approval before being integrated into the
repository, and the mail should state this fact);
+ mail_submitters: (string) - a flag containing "Y" or "N" (defaulting
to "Y"). Determines whether or not the notification mail will be
sent to the submitters;
+ item_managers: (string) - a comma-separated list of email
addresses, each of which corresponds to a "manager" for the class
of item that has been submitted. These managers will receive the
notification message sent by this function;
+ author_file: (string) - the name of a file that contains the names
of the item's authors (one author per line);
+ title_file: (string) - the name of a file that contains the title
of the new item;
+ owners_file: (string) - the name of a file that contains the email
addresses of the "owners" of the submitted item. I.e. those who
will be classed as "submitters" of the item and will therefore
have modification rights over it. The mail will be sent to these
people. There should be one email-address per line in this file;
+ rn_file1: (string) - the name of the the file containing the item's
principal reference number;
+ rn_file2: (string) - the name of the file containing the item's
additional reference number(s) (e.g. sometimes two reference numbers
are allocated during the submission process;
@param curdir: (string) - the current submission's working directory. All
files containing data related to the submission are stored here and
therefore all of the files referred to in the "parameters" dictionary
are considered to be within "curdir";
@param form: (string) - a dictionary-like structure containing the fields
that were present in the WebSubmit submission form;
@return: (string) - an empty string;
"""
global sysno ## (I'm really sorry for that! :-O )
sequence_id = bibtask_allocate_sequenceid(curdir)
## Read items from the parameters array into local vars:
item_status = parameters["item_status"]
mail_submitters = parameters["mail_submitters"]
item_managers = parameters["item_managers"]
author_file = parameters["author_file"]
title_file = parameters["title_file"]
owners_file = parameters["owners_file"]
rn_file1 = parameters["rn_file1"]
rn_file2 = parameters["rn_file2"]
## Now wash the parameters' values:
##
## item_status:
try:
## If item_status isn't "added" or "approval", make it "added" by
## default. Else, keep its value:
item_status = (item_status.upper() in ("ADDED", "APPROVAL") \
and item_status.upper()) or "ADDED"
except AttributeError:
## Oops - item_status wasn't a string (NoneType?) Anyway, default
## it to "ADDED".
item_status = "ADDED"
## mail_submitters:
try:
## If mail_submitters isn't "Y" or "N", make it "Y" by
## default. Else, keep its value:
mail_submitters = (mail_submitters.upper() in ("Y", "N") \
and mail_submitters.upper()) or "Y"
except AttributeError:
## Oops - mail_submitters wasn't a string (NoneType?) Anyway, default
## it to "Y".
mail_submitters = "Y"
## item_managers:
## A string in which the item_managers' email addresses will be stored:
managers_email = ""
try:
## We assume that the email addresses of item managers are
## separated by commas.
item_managers_list = item_managers.split(",")
for manager in item_managers_list:
manager_address = manager.strip()
## Test that this manager's email address is OK, adding it if so:
if email_valid_p(manager_address):
## This address is OK - add it to the string of manager
## addresses:
managers_email += "%s," % manager_address
## Strip the trailing comma from managers_email (if there is one):
managers_email = managers_email.strip().rstrip(",")
except AttributeError:
## Oops - item_managers doesn't seem to be a string? Treat it as
## though it were empty:
managers_email = ""
## author_file:
authors = ""
try:
## Read in the authors from author_file, putting them into the "authors"
## variable, one per line:
fp_author_file = open("%s/%s" % (curdir, author_file), "r")
for author in fp_author_file:
authors += "%s\n" % author.strip()
fp_author_file.close()
except IOError:
## Unable to correctly read from "author_file", Skip it as though
## there were no authors:
authors = "-"
## title_file:
title = ""
try:
## Read in the lines from title_file, putting them into the "title"
## variable on one line:
fp_title_file = open("%s/%s" % (curdir, title_file), "r")
for line in fp_title_file:
title += "%s " % line.strip()
fp_title_file.close()
title = title.strip()
except IOError:
## Unable to correctly read from "title_file", Skip it as though
## there were no title:
title = "-"
## owners_file:
## A string in which the item_owners' email addresses will be stored:
owners_email = ""
try:
fp_owners_file = open("%s/%s" % (curdir, owners_file), "r")
for line in fp_owners_file:
owner_address = line.strip()
## Test that this owner's email address is OK, adding it if so:
if email_valid_p(owner_address):
## This address is OK - add it to the string of item owner
## addresses:
owners_email += "%s," % owner_address
## Strip the trailing comma from owners_email (if there is one):
owners_email = owners_email.strip().rstrip(",")
except IOError:
## Unable to correctly read from "owners_file", Skip it as though
## there were no title:
owners_email = ""
## Add "SuE" (the submitter) into the list of document "owners":
try:
fp_sue = open("%s/SuE" % curdir, "r")
sue = fp_sue.readline()
fp_sue.close()
except IOError:
sue = ""
else:
if sue.lower() not in owners_email.lower().split(","):
## The submitter is not listed in the "owners" mails,
## add her:
owners_email = "%s,%s" % (sue, owners_email)
owners_email = owners_email.strip().rstrip(",")
## rn_file1 & rn_file2:
reference_numbers = ""
try:
fp_rnfile1 = open("%s/%s" % (curdir, rn_file1), "r")
for line in fp_rnfile1:
reference_number = line.strip()
reference_number = \
reference_number.replace("\n", "").replace("\r", "").\
replace(" ", "")
if reference_number != "":
## Add this reference number into the "reference numbers"
## variable:
reference_numbers += "%s " % reference_number
fp_rnfile1.close()
except IOError:
reference_numbers = ""
try:
fp_rnfile2 = open("%s/%s" % (curdir, rn_file2), "r")
for line in fp_rnfile2:
reference_number = line.strip()
reference_number = \
reference_number.replace("\n", "").replace("\r", "").\
replace(" ", "")
if reference_number != "":
## Add this reference number into the "reference numbers"
## variable:
reference_numbers += "%s " % reference_number
fp_rnfile2.close()
except IOError:
pass
## Strip any trailing whitespace from the reference numbers:
reference_numbers = reference_numbers.strip()
## Now build the email from the information we've collected:
email_txt = """
The following item has been submitted to %(sitename)s:
Reference(s): %(reference)s
Title: %(title)s
Author(s): %(author)s
""" % { 'sitename' : CFG_SITE_NAME,
'reference' : reference_numbers,
'title' : title,
'author' : authors,
}
if item_status == "ADDED":
## The item has been added into the repository.
email_txt += """
It will soon be made available and you will be able to check it at the
following URL:
<%(siteurl)s/%(CFG_SITE_RECORD)s/%(record-id)s>
Please report any problems to <%(sitesupportemail)s>.
""" % { 'siteurl' : CFG_SITE_URL,
'CFG_SITE_RECORD' : CFG_SITE_RECORD,
'record-id' : sysno,
'sitesupportemail' : CFG_SITE_SUPPORT_EMAIL,
}
else:
## The item has not yet been added - instead it awaits the
## approval of a referee. Let the email reflect this detail:
email_txt += """
The item is now awaiting a referee's approval before being integrated
into the repository. You will be alerted by email as soon as a decision
has been taken.
"""
## Finish the message with a signature:
email_txt += """
Thank you for submitting your item into %(sitename)s.
""" % { 'sitename' : CFG_SITE_NAME, }
## Send the email:
if mail_submitters == "Y" and len(owners_email) != "":
## Mail-to is "owners_email":
if managers_email != "":
## Managers should also be copied into the mail:
owners_email += ",%s" % managers_email
## Post the mail:
scheduled_send_email(CFG_EMAIL_FROM_ADDRESS, owners_email, \
"[%s] Submitted" % reference_numbers, \
email_txt, copy_to_admin=CFG_WEBSUBMIT_COPY_MAILS_TO_ADMIN, \
other_bibtasklet_arguments=['-I', str(sequence_id)])
elif managers_email != "":
## Although it's not desirable to mail the submitters, if "managers"
## have been given, it is reasonable to mail them:
scheduled_send_email(CFG_EMAIL_FROM_ADDRESS, managers_email, \
"[%s] Submitted" % reference_numbers, \
email_txt, copy_to_admin=CFG_WEBSUBMIT_COPY_MAILS_TO_ADMIN, \
other_bibtasklet_arguments=['-I', str(sequence_id)])
elif CFG_WEBSUBMIT_COPY_MAILS_TO_ADMIN:
## We don't want to mail the "owners". Let's mail the admin instead:
scheduled_send_email(CFG_EMAIL_FROM_ADDRESS, CFG_SITE_ADMIN_EMAIL, \
"[%s] Submitted" % reference_numbers, email_txt, \
other_bibtasklet_arguments=['-I', str(sequence_id)])
## Return an empty string
return ""
def Send_Delete_Mail(parameters, curdir, form, user_info=None):
"""
In the event of a record having been deleted, this function is used
to the mail the submitter (and possibly the record "managers")
informing them about the record's deletion.
@parameters:
+ edsrn: The name of the file in the current submission's
working directory, in which the record's report number
is stored.
+ record_managers: A comma-separated string of the email
addresses of the record's managers. If given,
they will be (blind*) copied into the mail.
* At this time, they are only blind copied
because of send_email's behaviour of
blind copying everyone if "To" contains
multiple addresses. Anyway, blind was
wanted . . .
@return: empty string.
@Exceptions raised: None.
"""
## Get any addresses to which the mail should be copied:
## Get report number:
report_number_file = parameters["edsrn"]
report_number = \
Send_Delete_Mail_read_file("%s/%s" % \
(curdir, \
report_number_file)).strip()
########
## Get the "record_managers" parameter AND WASH THE EMAIL ADDRESSES
## TO BE SURE THAT THEY'RE VALID:
raw_record_managers = parameters["record_managers"]
record_managers = ""
try:
## We assume that the email addresses of item managers are
## separated by commas.
raw_record_managers_list = raw_record_managers.split(",")
for manager in raw_record_managers_list:
manager_address = manager.strip()
## Test that this manager's email address is OK, adding it if so:
if email_valid_p(manager_address):
## This address is OK - add it to the string of manager
## addresses:
record_managers += "%s," % manager_address
## Strip the trailing comma from record_managers (if there is one):
record_managers = record_managers.strip().rstrip(",")
except AttributeError:
## record_managers doesn't seem to be a string? Treat it as
## though it were empty:
record_managers = ""
##
########
## User email address:
user_email = user_info["email"]
## Concatenate the user's email address with the managers' addresses.
## Note: What we want to do here is send the mail to the user as "To"
## and to the managers as "bcc". At the time of writing though,
## send_email doesn't appear to allow email headers. It does have a
## strange behaviour though: If "To" contains more than one address,
## comma separated, ALL addresses will be put in "bcc" and the mail
## will appear to be sent to "undisclosed recipients".
if record_managers != "":
if user_email != "guest":
email_recipients = "%s,%s" % (user_email, record_managers)
else:
## Can't send mails to "guest"! Send only to managers.
email_recipients = record_managers
elif user_email == "guest":
## The user is a guest and there are no managers to send the mail
## to. Drop out quietly.
return ""
else:
## No managers to send the mail to. Send it only to the user.
email_recipients = user_email
mail_subj = "Document %s deleted from %s" \
% (report_number, CFG_SITE_NAME)
mail_body = CFG_MAIL_BODY % \
{ 'report-number' : report_number,
'deleter' : user_email,
'site-name' : CFG_SITE_NAME,
}
send_email(CFG_SITE_SUPPORT_EMAIL,
email_recipients,
mail_subj,
mail_body,
copy_to_admin=CFG_WEBSUBMIT_COPY_MAILS_TO_ADMIN)
##
return ""
def Send_Delete_Mail(parameters, curdir, form, user_info=None):
"""
In the event of a record having been deleted, this function is used
to the mail the submitter (and possibly the record "managers")
informing them about the record's deletion.
@parameters:
+ edsrn: The name of the file in the current submission's
working directory, in which the record's report number
is stored.
+ record_managers: A comma-separated string of the email
addresses of the record's managers. If given,
they will be (blind*) copied into the mail.
* At this time, they are only blind copied
because of send_email's behaviour of
blind copying everyone if "To" contains
multiple addresses. Anyway, blind was
wanted . . .
@return: empty string.
@Exceptions raised: None.
"""
## Get any addresses to which the mail should be copied:
## Get report number:
report_number_file = parameters["edsrn"]
report_number = \
Send_Delete_Mail_read_file("%s/%s" % \
(curdir, \
report_number_file)).strip()
########
## Get the "record_managers" parameter AND WASH THE EMAIL ADDRESSES
## TO BE SURE THAT THEY'RE VALID:
raw_record_managers = parameters["record_managers"]
record_managers = ""
try:
## We assume that the email addresses of item managers are
## separated by commas.
raw_record_managers_list = raw_record_managers.split(",")
for manager in raw_record_managers_list:
manager_address = manager.strip()
## Test that this manager's email address is OK, adding it if so:
if email_valid_p(manager_address):
## This address is OK - add it to the string of manager
## addresses:
record_managers += "%s," % manager_address
## Strip the trailing comma from record_managers (if there is one):
record_managers = record_managers.strip().rstrip(",")
except AttributeError:
## record_managers doesn't seem to be a string? Treat it as
## though it were empty:
record_managers = ""
##
########
## User email address:
user_email = user_info["email"]
## Concatenate the user's email address with the managers' addresses.
## Note: What we want to do here is send the mail to the user as "To"
## and to the managers as "bcc". At the time of writing though,
## send_email doesn't appear to allow email headers. It does have a
## strange behaviour though: If "To" contains more than one address,
## comma separated, ALL addresses will be put in "bcc" and the mail
## will appear to be sent to "undisclosed recipients".
if record_managers != "":
if user_email != "guest":
email_recipients = "%s,%s" % (user_email, record_managers)
else:
## Can't send mails to "guest"! Send only to managers.
email_recipients = record_managers
elif user_email == "guest":
## The user is a guest and there are no managers to send the mail
## to. Drop out quietly.
return ""
else:
## No managers to send the mail to. Send it only to the user.
email_recipients = user_email
mail_subj = "Document %s deleted from %s" \
% (report_number, CFG_SITE_NAME)
mail_body = CFG_MAIL_BODY % \
{ 'report-number' : report_number,
'deleter' : user_email,
'site-name' : CFG_SITE_NAME,
}
send_email(CFG_SITE_SUPPORT_EMAIL,
email_recipients,
mail_subj,
mail_body,
copy_to_admin=CFG_WEBSUBMIT_COPY_MAILS_TO_ADMIN)
##
return ""
