def configureRoles(gisInfo):
localLogger.write("Creating roles")
localLogger.incIndent()
results = []
try:
for configRole in portal_config.roles:
with localLogger.DisableAPILogging():
existingRole = _findRole(gisInfo, configRole["name"])
if existingRole == None:
localLogger.write("Creating role: " + configRole["name"])
with localLogger.DisableAPILogging():
result = gisInfo.gis.users.roles.create(name = configRole["name"],
description = configRole["description"],
privileges = configRole["privileges"])
if result == None:
localLogger.write("ERROR: Failed to create role")
results.append(False)
else:
gisInfo.waitForRole(result.name)
results.append(True)
else:
localLogger.write("Role already exists: " + existingRole.name)
results.append(True)
return all(results)
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()
def configureSystemProperties(gisInfo):
localLogger.write("Configuring system properties")
localLogger.incIndent()
try:
if portal_config.systemProperties == None or len(portal_config.systemProperties) == 0:
localLogger.write("No system properties to apply")
return True
system = gisInfo.gis.admin.system
curProperties = system.properties
updProperties = json.loads(json.dumps(curProperties))
for k in portal_config.systemProperties:
if k == "disableSignup":
if portal_config.systemProperties[k] == True:
portal_config.systemProperties[k] = "true"
elif portal_config.systemProperties[k] == False:
portal_config.systemProperties[k] = "false"
updProperties[k] = portal_config.systemProperties[k]
#
# Check that we are actually going to update something, as calling update
# will cause Portal to be restarted.
#
haveChanges = False
for k in curProperties:
if updProperties[k] != curProperties[k]:
haveChanges = True
for k in updProperties:
if k not in curProperties:
haveChanges = True
if not haveChanges:
localLogger.write("No system properties require changing")
return True
else:
#
# Using the following sends a gis.admin.system._con.get() call, which does not seem to work.
# gis.admin.system.properties = updProperties
# The following, therefore, uses a post command
url = system._url + "/properties/update"
params = {
"f" : "json",
"properties" : updProperties
}
localLogger.write(" Updating system properties - this may take several minutes")
result = system._con.post(path=url, postdata=params)
if "status" in result:
return result["status"] == "success"
else:
return result
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()
def _checkIfCertificateExists(gisInfo, certName):
"""
Checks whether the certificate has been registered in the portal and, if so,
returns the certificate.
"""
localLogger.write("Checking registered SSL Certificate")
for cert in gisInfo.gis.admin.security.ssl.list():
compName = _getCertificateAliasName(cert)
if compName.lower() == certName.lower():
return cert
return None
def waitForGroup(self, groupName):
first = True
for i in range(1,10):
try:
self._allGroups = None
for grp in self.allGroups:
if grp["title"] == groupName:
return grp
except:
self.ResetGIS()
if first:
first = False
localLogger.write(" waiting for group \"{}\" to be created".format(groupName))
time.sleep(5)
localLogger.write(" created group \"{}\" not found".format(groupName))
return None
def waitForRole(self, rolename):
first = True
for i in range(1,10):
try:
self._allRoles = None
for role in self.allRoles:
if role.name == rolename:
return role
except:
self.ResetGIS()
if first:
first = False
localLogger.write(" waiting for role \"{}\" to be created".format(rolename))
time.sleep(5)
localLogger.write(" created role \"{}\" not found".format(rolename))
return None
def waitForUser(self, username):
first = True
for i in range(1,10):
try:
self._allUsers = None
for usr in self.allUsers:
if usr["username"] == username:
return usr
except:
self.ResetGIS()
if first:
first = False
localLogger.write(" waiting for user \"{}\" to be created".format(username))
time.sleep(5)
localLogger.write(" created user \"{}\" not found".format(username))
return None
def configureGeneralProperties(gisInfo):
localLogger.write("Configuring general properties")
localLogger.incIndent()
try:
if portal_config.generalProperties == None or len(portal_config.generalProperties) == 0:
localLogger.write("No general properties to apply")
return True
updProperties = portal_config.generalProperties
result = gisInfo.gis.update_properties(updProperties)
return result
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()
from arcgis.gis import GIS
import getpass
from utils import localLogger
from utils.exceptions import *
# Ask for admin/publisher user name and password and site url
username = input("Enter user name: ")
password = getpass.getpass("Enter password: "******"Enter the URL of portal:")
# https://sdmsdev1w004.ordsvy.gov.uk/portal
gis = GIS(portalURL, username, password)
sysmgr = gis.admin.system
idx_status = sysmgr.index_status
print ("Checking the index status")
localLogger.write("Checking the index status")
import json
print(json.dumps(idx_status, indent=4))
# Output
{
"indexes": [
{
"name": "users",
"databaseCount": 51,
"indexCount": 51
},
{
"name": "groups",
"databaseCount": 325,
def main(args):
results = []
continueProcessing = True
#read cmd line args
parser = argparse.ArgumentParser()
parser.add_argument('-config','--config', required=True, help='PortalConfigSettings.py config file')
parser.add_argument('-url','--url', help='Portal url of the form: https://portalname.domain.com/webadaptor')
parser.add_argument('-u','--user', help='Administrator username')
parser.add_argument('-p','--password', help='Administrator password')
parser.add_argument('-us','--users', help='users.csv file')
parser.add_argument('-g','--groups', help='groups.csv file')
parser.add_argument('-l', '--log', help='Path to log file', default='python_process.log')
parser.add_argument("-ll", "--loggingLevel", help="Logging level", default="INFO",
choices = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"])
args = parser.parse_args()
#
# Import the config file
#
if not importConfigFile(args.config):
return 3
try:
localLogger.initialise(portal_config.logfile)
# localLogger.initialise(None,False,"DEBUG")
# localLogger.initialise(None)
# localLogger.initialise(None, False, args.loggingLevel)
gisInfo = GISInfo(args.url, args.user, args.password)
#
# Install the portal certificate
#
results.append(installSSLCertificate(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
#
# Configure roles
#
if continueProcessing:
results.append(configureRoles(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
#
# Creating/Updating Groups
#
if continueProcessing:
results.append(createGroups(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
#
# Creating/Updating Users
#
if continueProcessing:
results.append(createUsers(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
#
# Disable the living atlas if required. Note that we do not re-enable it if
# disableLivingAtlas has been set to True.
#
# if continueProcessing and portal_config.disableLivingAtlas:
# results.append(disableLivingAtlas(gisInfo))
# if not all(results) and not portal_config.continueOnError:
# continueProcessing = False
#
# Update security configuration
#
if continueProcessing:
results.append(configureSecurity(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
#
# Update general properties
#
if continueProcessing:
results.append(configureGeneralProperties(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
#
# Update system properties
#
if continueProcessing:
results.append(configureSystemProperties(gisInfo))
if not all(results) and not portal_config.continueOnError:
continueProcessing = False
except Exception as ex:
msg = FormatExceptions("Unexpected error", ex)
if localLogger._rootLogger != None:
localLogger.write(msg)
else:
print(msg)
if all(results):
localLogger.write("Script completed successfully")
return 0
elif continueProcessing:
localLogger.write("Script completed with errors")
return 1
else:
localLogger.write("Script execution failed")
return 2
def configureSecurity(gisInfo):
localLogger.write("Configuration security options")
localLogger.incIndent()
try:
if portal_config.securityConfig == None or len(portal_config.securityConfig) == 0:
localLogger.write("No security configuration to apply")
return True
updConfig = json.loads(json.dumps(gisInfo.gis.admin.security.config))
#
# Remove items we are not expecting
#
for k in ["userStoreConfig", "groupStoreConfig"]:
if k in updConfig:
del updConfig[k]
localLogger.write("Current default role: " + updConfig["defaultRoleForUser"])
#
# Add in our changes
#
for k in portal_config.securityConfig:
updConfig[k] = portal_config.securityConfig[k]
#
# If the defaultRoleForUser property is not account_user or account_publisher, search the
# roles to find the named role and substitute it for the role id
#
if "defaultRoleForUser" in portal_config.securityConfig and \
portal_config.securityConfig["defaultRoleForUser"] not in ["account_user", "account_publisher"]:
roleName = portal_config.securityConfig["defaultRoleForUser"]
existingRole = _findRole(gisInfo, roleName)
if existingRole == None:
localLogger.write("ERROR: Role defined for defaultRoleForUser property does not exist: " + roleName)
localLogger.write("The security configuration has NOT been updated")
return False
updConfig["defaultRoleForUser"] = existingRole.role_id
#
# Update the configuration
#
gisInfo.gis.admin.security.config = updConfig
return True
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()
def createUsers(gisInfo):
"""Create users using a CSV file called users_trek.csv"""
localLogger.write("Creating users")
localLogger.incIndent()
results = []
try:
with open("users_large_trek.csv", 'r') as users_csv:
users = csv.DictReader(users_csv)
for user in users:
foundUser = None
result = True
for extusr in gisInfo.allUsers:
if extusr["username"].lower() == user["username"].lower():
foundUser = extusr
if foundUser == None:
localLogger.write("Creating user " + user['username'] + ", role " + user['role'])
try:
foundUser = gisInfo.createUser(user)
if foundUser == None:
localLogger.write("ERROR: Failed to create user {}".format(user["username"]))
result = False
else:
foundUser = gisInfo.waitForUser(foundUser["username"])
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Failed to create user {}".format(user["username"]), ex))
result = False
else:
localLogger.write("User \"{}\" already exists".format(foundUser["username"]))
#
# The following will update the role of an existing user as well as a new user
#
if foundUser != None:
# Assign custom role to user
localLogger.write(" Assigning role: " + user['role'])
foundRole = _findRole(gisInfo, user['role'])
if foundRole == None:
localLogger.write(" ERROR: Undefined role: {}".format(user["role"]))
result = False
else:
try:
foundUser.update_role(foundRole)
except Exception as role_ex:
localLogger.write(FormatExceptions("ERROR: Failed to assign role \"{}\" to user".format(foundRole.name), role_ex))
result = False
# Now assign user to group(s)
localLogger.write(" Adding to groups:")
groups = user['groups']
group_list = [g for g in [grp.strip() for grp in groups.split(",")] if len(g) > 0]
# Search for the group
for g in group_list:
foundGroup = None
for grp in gisInfo.allGroups:
if grp["title"] == g:
foundGroup = grp
if foundGroup != None:
group_members = foundGroup.get_members()
if foundUser["username"] in group_members["users"]:
localLogger.write(" already a member of group \"{}\"".format(foundGroup["title"]))
else:
try:
groups_result = foundGroup.add_users([foundUser["username"]])
if len(groups_result['notAdded']) == 0:
localLogger.write(" added to group \"{}\"".format(foundGroup["title"]))
else:
localLogger.write(" ERROR: Not added to group \"{}\"\n result: {}".format(foundGroup["title"], groups_result))
result = False
except Exception as groups_ex:
localLogger.write(FormatExceptions("ERROR: Failed add user to group {}".format(foundGroup["title"]), groups_ex))
result = False
else:
localLogger.write(" ERROR: Group \"{}\" not found".format(g))
result = False
return all(results)
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()
def createGroups(gisInfo):
"""Create groups using a CSV file called groups_trek.csv"""
localLogger.write("Creating groups")
localLogger.incIndent()
results = []
try:
with open("groups_trek.csv", 'r') as groups_csv:
groups = csv.DictReader(groups_csv)
for group in groups:
try:
foundGroup = None
for extgrp in gisInfo.allGroups:
if extgrp["title"].lower() == group["title"].lower():
foundGroup = extgrp
if foundGroup == None:
localLogger.write("Creating group: " + group['title'])
newGroup = gisInfo.gis.groups.create_from_dict(group)
if newGroup == None:
localLogger.write(" ERROR: Failed to create group {}".format(group["title"]))
results.append(False)
else:
gisInfo.waitForGroup(newGroup["title"])
results.append(True)
else:
localLogger.write("Group \"{}\" already exists".format(foundGroup["title"]))
results.append(True)
except Exception as create_ex:
if "title" in group:
localLogger.write(FormatExceptions("ERROR: Failed to create group {}".format(group["title"]), create_ex))
else:
localLogger.write(FormatExceptions("ERROR: Failed to create group", create_ex))
results.append(False)
return all(results)
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()
def installSSLCertificate(gisInfo):
"""
Registering the certificate to be used by the Portal.
"""
localLogger.write("Working on SSL Certificate")
localLogger.incIndent()
try:
certificateAlias = portal_config.sslCertificates["alias"].lower()
certToInstall = _checkIfCertificateExists(gisInfo, certificateAlias)
localLogger.write("Checking if SSL Certificate exists")
if certToInstall == None:
localLogger.write("ERROR: Certificate with alias \"{}\" has not been registered".format(certificateAlias))
return False
installedCertificateAlias = gisInfo.gis.admin.security.ssl.properties["webServerCertificateAlias"]
certToInstallAlias = _getCertificateAliasName(certToInstall)
# Makes changes to existing Protocols and Ciphers regardless of installed certificate
ssl_protocols = ",".join(portal_config.sslCertificates["ssl_protocols"])
ssl_ciphers = ", ".join(portal_config.sslCertificates["cipher_suites"])
localLogger.write("Editing existing SSL Protocols & Cipher Suites")
gisInfo.gis.admin.security.ssl.update(certToInstallAlias,ssl_protocols, ssl_ciphers)
if certToInstallAlias != installedCertificateAlias:
#
# Install the new certificate
#
localLogger.write("Registering certificate with alias \"{}\" as the portal certificate".format(certToInstallAlias))
#portal_config.gis.admin.security.ssl.update(certToInstallAlias, portal_config.sslCertificates["ssl_protocols"],portal_config.sslCertificates["cipher_suites"])
#
# Now make the changes to existing Protocols and Ciphers
#
ssl_protocols = ",".join(portal_config.sslCertificates["ssl_protocols"])
ssl_ciphers = ", ".join(portal_config.sslCertificates["cipher_suites"])
localLogger.write("Editing SSL Protocols & Cipher Suites due to new certificate")
gisInfo.gis.admin.security.ssl.update(certToInstallAlias, ssl_protocols, ssl_ciphers)
else:
localLogger.write("Certificate with alias \"{}\" is already installed as the portal certificate".format(certToInstallAlias))
return True
except Exception as ex:
localLogger.write(FormatExceptions("ERROR: Unexpected exception thrown", ex))
return False
finally:
localLogger.decIndent()