def create_company(auth_user,
company_name=None,
company_manager_id=None,
company_manager_user_name=None,
company_manager_user_email=None,
user_id=None,
response=None):
"""
Creates an company and returns the newly created company in dict format.
:param company_name: The company name.
:type company_name: string
:param company_manager_id: The ID of the company manager user.
:type company_manager_id: string
:param company_manager_user_name: The user name of the company manager user.
:type company_manager_user_name: string
:param company_manager_user_email: The user email of the company manager user.
:type company_manager_user_email: string
:return: dict representation of the company object.
:rtype: dict
"""
manager = cla.controllers.user.get_or_create_user(auth_user)
for company in get_companies():
if company.get("company_name") == company_name:
cla.log.error({"error": "Company already exists"})
response.status = HTTP_409
return {
"status_code": HTTP_409,
"data": {
"error": "Company already exists.",
"company_id": company.get("company_id")
}
}
company = Company()
company.set_company_id(str(uuid.uuid4()))
company.set_company_name(company_name)
company.set_company_manager_id(manager.get_user_id())
company.set_company_acl(manager.get_lf_username())
company.save()
# Create audit trail for company
event_data = 'Company-{} created'.format(company.get_company_name())
Event.create_event(
event_type=EventType.CreateCompany,
event_company_id=company.get_company_id(),
event_data=event_data,
event_summary=event_data,
event_user_id=user_id,
contains_pii=False,
)
return {"status_code": HTTP_200, "data": company.to_dict()}
def request_company_admin_access(user_id, company_id):
"""
Send Email to company admins to inform that that a user is requesting to be a CLA Manager for their company.
"""
user = User()
try:
user.load(user_id)
except DoesNotExist as err:
return {'errors': {'user_id': str(err)}}
user_name = user.get_user_name()
company = Company()
try:
company.load(company_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
subject = 'CLA: Request for Access to Corporate Console'
# Send emails to every CLA manager
for admin in company.get_managers():
body = '''Hello {admin_name},
The following user is requesting CLA Manager access for your organization: {company_name}
{user_name} <{user_email}>
Navigate to the EasyCLA Corporate Console using the link below and add this user to your Organization's Company Access Control List. Please notify the user once they are added so that they may log in to the EasyCLA Corporate Console with their LFID.
{corporate_console_url}
- EasyCLA System
'''.format(admin_name=admin.get_user_name(),
user_name=user_name,
company_name=company.get_company_name(),
user_email=user_email,
corporate_console_url='https://{}'.format(
cla.conf['CORPORATE_BASE_URL']))
recipient = admin.get_lf_email()
email_service = get_email_service()
email_service.send(subject, body, recipient)
def request_company_ccla(user_id, user_email, company_id, project_id):
"""
Sends email to all company administrators in the company ACL to sign a CCLA for the given project.
"""
user = User()
try:
user.load(user_id)
except DoesNotExist as err:
return {'errors': {'user_id': str(err)}}
user_name = user.get_user_name()
company = Company()
try:
company.load(company_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
company_name = company.get_company_name()
project = Project()
try:
project.load(project_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
project_name = project.get_project_name()
# Send an email to sign the ccla for the project for every member in the company ACL
# account_exists=True since company already exists.
for admin in company.get_managers():
send_email_to_cla_manager(project, user_name, user_email,
admin.get_user_name(), admin.get_lf_email(),
project_name, company_name, True)
# Audit event
event_data = f'Sent email to sign ccla for {project.get_project_name()}'
Event.create_event(
event_data=event_data,
event_summary=event_data,
event_type=EventType.RequestCCLA,
event_user_id=user_id,
event_company_id=company_id,
contains_pii=False,
)
def request_company_whitelist(user_id: str,
company_id: str,
user_name: str,
user_email: str,
project_id: str,
message: str = None,
recipient_name: str = None,
recipient_email: str = None):
"""
Sends email to the specified company manager notifying them that a user has requested to be
added to their approval list.
:param user_id: The ID of the user requesting to be added to the company's approval list.
:type user_id: string
:param company_id: The ID of the company that the request is going to.
:type company_id: string
:param user_name: The name hat this user wants to be approved
:type user_name: string
:param user_email: The email address that this user wants to be approved. Must exist in the
user's list of emails.
:type user_email: string
:param project_id: The ID of the project that the request is going to.
:type project_id: string
:param message: A custom message to add to the email sent out to the manager.
:type message: string
:param recipient_name: An optional recipient name for requesting the company approval list
:type recipient_name: string
:param recipient_email: An optional recipient email for requesting the company approval list
:type recipient_email: string
"""
if project_id is None:
return {
'errors': {
'project_id': 'Project ID is missing from the request'
}
}
if company_id is None:
return {
'errors': {
'company_id': 'Company ID is missing from the request'
}
}
if user_id is None:
return {'errors': {'user_id': 'User ID is missing from the request'}}
if user_name is None:
return {
'errors': {
'user_name': 'User Name is missing from the request'
}
}
if user_email is None:
return {
'errors': {
'user_email': 'User Email is missing from the request'
}
}
if recipient_name is None:
return {
'errors': {
'recipient_name': 'Recipient Name is missing from the request'
}
}
if recipient_email is None:
return {
'errors': {
'recipient_email':
'Recipient Email is missing from the request'
}
}
if message is None:
return {'errors': {'message': 'Message is missing from the request'}}
user = User()
try:
user.load(user_id)
except DoesNotExist as err:
return {'errors': {'user_id': str(err)}}
if user_email not in user.get_user_emails():
return {
'errors': {
'user_email':
'User\'s email must match one of the user\'s existing emails in their profile'
}
}
company = Company()
try:
company.load(company_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
project = Project()
try:
project.load(project_id)
except DoesNotExist as err:
return {'errors': {'project_id': str(err)}}
company_name = company.get_company_name()
project_name = project.get_project_name()
msg = ''
if message is not None:
msg += f'<p>{user_name} included the following message in the request:</p>'
msg += f'<p>{message}</p>'
subject = f'EasyCLA: Request to Authorize {user_name} for {project_name}'
body = f'''
<p>Hello {recipient_name},</p>
<p>This is a notification email from EasyCLA regarding the project {project_name}.</p>
<p>{user_name} ({user_email}) has requested to be added to the Allow List as an authorized contributor from
{company_name} to the project {project_name}. You are receiving this message as a CLA Manager from {company} for
{project_name}.</p>
{msg}
<p>If you want to add them to the Allow List, please
<a href="https://{cla.conf['CORPORATE_BASE_URL']}#/company/{company_id}" target="_blank">log into the EasyCLA Corporate
Console</a>, where you can approve this user's request by selecting the 'Manage Approved List' and adding the
contributor's email, the contributor's entire email domain, their GitHub ID or the entire GitHub Organization for the
repository. This will permit them to begin contributing to {project_name} on behalf of {company}.</p>
<p>If you are not certain whether to add them to the Allow List, please reach out to them directly to discuss.</p>
{get_email_help_content(project.get_version() == 'v2')}
{get_email_sign_off_content()}
'''
cla.log.debug(f'request_company_approval_list - sending email '
f'to recipient {recipient_name}/{recipient_email} '
f'for user {user_name}/{user_email} '
f'for project {project_name} '
f'assigned to company {company_name}')
email_service = get_email_service()
email_service.send(subject, body, recipient_email)
# Create event
event_data = (
f'CLA: contributor {user_name} requests to be Approved for the '
f'project: {project_name} '
f'organization: {company_name} '
f'as {user_name} <{user_email}>')
Event.create_event(
event_user_id=user_id,
event_project_id=project_id,
event_company_id=company_id,
event_type=EventType.RequestCompanyWL,
event_data=event_data,
contains_pii=True,
)
def request_company_ccla(user_id, user_email, company_id, project_id):
"""
Sends email to all company administrators in the company ACL to sign a CCLA for the given project.
"""
user = User()
try:
user.load(user_id)
except DoesNotExist as err:
return {'errors': {'user_id': str(err)}}
user_name = user.get_user_name()
company = Company()
try:
company.load(company_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
company_name = company.get_company_name()
project = Project()
try:
project.load(project_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
project_name = project.get_project_name()
# Send an email to sign the ccla for the project for every member in the company ACL
# account_exists=True since company already exists.
for admin in company.get_managers():
send_email_to_cla_manager(project, user_name, user_email,
admin.get_user_name(), admin.get_lf_email(),
project_name, company_name, True)
# Audit event
event_data = f'Sent email to sign ccla for {project.get_project_name()}'
Event.create_event(
event_data=event_data,
event_summary=event_data,
event_type=EventType.RequestCCLA,
event_user_id=user_id,
event_company_id=company_id,
contains_pii=False,
)
msg = (f'user github_id {user.get_user_github_id()}'
f'user github_username {user.get_user_github_username()}'
f'user email {user_email}'
f'for project {project_name}'
f'for company {company_name}')
cla.log.debug(f'creating CCLA approval request table entry for {msg}')
# Add an entry into the CCLA request table
ccla_whitelist_request = CCLAWhitelistRequest()
ccla_whitelist_request.set_request_id(str(uuid.uuid4()))
ccla_whitelist_request.set_company_name(company_name)
ccla_whitelist_request.set_project_name(project_name)
ccla_whitelist_request.set_user_github_id(user.get_user_github_id())
ccla_whitelist_request.set_user_github_username(
user.get_user_github_username())
ccla_whitelist_request.set_user_emails({user_email})
ccla_whitelist_request.set_request_status("pending")
ccla_whitelist_request.save()
cla.log.debug(f'created CCLA approval request table entry for {msg}')
def request_company_whitelist(user_id: str,
company_id: str,
user_email: str,
project_id: str,
message: str = None,
recipient_name: str = None,
recipient_email: str = None):
"""
Sends email to the specified company manager notifying them that a user has requested to be
added to their whitelist.
:param user_id: The ID of the user requesting to be added to the company's whitelist.
:type user_id: string
:param company_id: The ID of the company that the request is going to.
:type company_id: string
:param user_email: The email address that this user wants to be whitelisted. Must exist in the
user's list of emails.
:type user_email: string
:param project_id: The ID of the project that the request is going to.
:type project_id: string
:param message: A custom message to add to the email sent out to the manager.
:type message: string
:param recipient_name: An optional recipient name for requesting the company whitelist
:type recipient_name: string
:param recipient_email: An optional recipient email for requesting the company whitelist
:type recipient_email: string
"""
if project_id is None:
return {
'errors': {
'project_id': 'Project ID is missing from the request'
}
}
if company_id is None:
return {
'errors': {
'company_id': 'Company ID is missing from the request'
}
}
if user_id is None:
return {'errors': {'user_id': 'User ID is missing from the request'}}
if user_email is None:
return {
'errors': {
'user_email': 'User Email is missing from the request'
}
}
if message is None:
return {'errors': {'message': 'Message is missing from the request'}}
user = User()
try:
user.load(user_id)
except DoesNotExist as err:
return {'errors': {'user_id': str(err)}}
emails = user.get_user_emails()
if user_email not in emails:
return {
'errors': {
'user_email': 'Must provide one of the user\'s existing emails'
}
}
company = Company()
try:
company.load(company_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
project = Project()
try:
project.load(project_id)
except DoesNotExist as err:
return {'errors': {'project_id': str(err)}}
user_name = user.get_user_name()
company_name = company.get_company_name()
project_name = project.get_project_name()
# If provided, we will use the parameter for the recipient name and email - if not provided, then we will use the
# default company manager's email
if not recipient_name and not recipient_email:
cla.log.debug(
'request_company_whitelist - recipient name and email missing from request - '
'using the company manager as the recipient')
manager_id = company.get_company_manager_id()
manager = get_user_instance()
try:
manager.load(manager_id)
except DoesNotExist as err:
return {
'errors': {
'company_id':
'No CLA Manager exists for this company - can not send email'
}
}
recipient_name = manager.get_user_name()
if manager.get_lf_email() is not None:
recipient_email = manager.get_lf_email()
else:
emails = manager.get_user_emails()
if len(emails) > 0:
recipient_email = emails[0]
else:
return {
'errors': {
'manager_email':
'Manager email is missing - unable to send to recipient'
}
}
subject = (
f'CLA: {user_name} is requesting to be whitelisted for {project_name} project '
f'as a {company_name} employee')
body = f'''Hello {recipient_name},
{user_name} is requesting to be whitelisted as a contributor for your organization ({company_name}):
{user_name} <{user_email}>
The message that was attached to the request:
{message}
You can whitelist {user_name} in the EasyCLA Corporate console. If the email above is the personal email of one of your employees, please request that they add their organization email to their GitHub profile and try signing the CLA again. If you are unsure about this request, it may be prudent to get in touch with {user_name} to clarify.
Please follow up with the user as necessary.
Click on the following link to navigate to the EasyCLA Corporate Console.
https://{cla.conf['CORPORATE_BASE_URL']}
- EasyCLA System
'''
cla.log.debug(f'request_company_whitelist - sending email '
f'to recipient {recipient_name}/{recipient_email} '
f'for project {project_name} '
f'assigned to company {company_name}')
email_service = get_email_service()
email_service.send(subject, body, recipient_email)
# Create event
event_data = f'CLA: {user.get_user_name()} requests to be whitelisted for the organization {company.get_company_name}'\
f'{user.get_user_name()} <{user.get_user_email()}>'
Event.create_event(
event_user_id=user_id,
event_project_id=project_id,
event_company_id=company_id,
event_type=EventType.RequestCompanyWL,
event_data=event_data,
contains_pii=True,
)
def fmt_company(company: Company):
return "{} ({}) - acl: {}".format(company.get_company_name(),
company.get_company_id(),
company.get_company_acl())
def request_company_whitelist(user_id,
company_id,
user_email,
project_id,
message=None):
"""
Sends email to the specified company manager notifying them that a user has requested to be
added to their whitelist.
:param user_id: The ID of the user requesting to be added to the company's whitelist.
:type user_id: string
:param company_id: The ID of the company that the request is going to.
:type company_id: string
:param user_email: The email address that this user wants to be whitelisted. Must exist in the
user's list of emails.
:type user_email: string
:param messsage: A custom message to add to the email sent out to the manager.
:type message: string
"""
user = User()
try:
user.load(user_id)
except DoesNotExist as err:
return {'errors': {'user_id': str(err)}}
emails = user.get_user_emails()
if user_email not in emails:
return {
'errors': {
'user_email': 'Must provide one of the user\'s existing emails'
}
}
company = Company()
try:
company.load(company_id)
except DoesNotExist as err:
return {'errors': {'company_id': str(err)}}
project = Project()
try:
project.load(project_id)
except DoesNotExist as err:
return {'errors': {'project_id': str(err)}}
user_name = user.get_user_name()
company_name = company.get_company_name()
project_name = project.get_project_name()
subject = '''CLA: %s is requesting to be whitelisted for %s project ''' % (
user_name, project_name)
body = '''%s is requesting to be whitelisted as a contributor for your organization (%s):
%s <%s>
The message that was attached to the request:
%s
You can whitelist %s in the CLA Corporate console. If the email above is the personal email of one of your employees, please request that they add their organization email to their GitHub profile and try signing the CLA again. If you are unsure about this request, it may be prudent to get in touch with %s to clarify.
Please follow up with the user as necessary.
Click on the following link to navigate to the CLA Corporate Console.
%s
- Linux Foundation CLA System
''' % (user_name, company_name, user_name, user_email, message, user_name,
user_name, 'https://{}'.format(cla.conf['CORPORATE_BASE_URL']))
manager_id = company.get_company_manager_id()
manager = get_user_instance()
try:
manager.load(manager_id)
except DoesNotExist as err:
return {
'errors': {
'company_id':
'No manager exists for this company - can not send email'
}
}
recipient = manager.get_user_email()
email_service = get_email_service()
email_service.send(subject, body, recipient)