-
Notifications
You must be signed in to change notification settings - Fork 6
/
StartStopServiceArcGISServer.py
392 lines (351 loc) · 14.7 KB
/
StartStopServiceArcGISServer.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
#-------------------------------------------------------------
# Name: Start or Stop Service: ArcGIS Server
# Purpose: Starts or stops a service or services in an ArcGIS Server site.
# Author: Shaun Weston ([email protected])
# Date Created: 07/10/2014
# Last Updated: 05/02/2018
# Copyright: (c) Eagle Technology
# ArcGIS Version: ArcMap 10.3+
# Python Version: 2.7+
#--------------------------------
# Import main modules
import os
import sys
import logging
import smtplib
# Set global variables
# Logging
enableLogging = "true" # Use within code - logger.info("Example..."), logger.warning("Example..."), logger.error("Example...") and to print messages - printMessage("xxx","info"), printMessage("xxx","warning"), printMessage("xxx","error")
logFile = os.path.join(os.path.dirname(__file__), "StartStopServiceArcGISServer.log") # e.g. os.path.join(os.path.dirname(__file__), "Example.log")
# Email logging
sendErrorEmail = "false"
emailServerName = "" # e.g. smtp.gmail.com
emailServerPort = 0 # e.g. 25
emailTo = ""
emailUser = ""
emailPassword = ""
emailSubject = ""
emailMessage = ""
# Proxy
enableProxy = "false"
requestProtocol = "http" # http or https
proxyURL = ""
# Output
output = None
# ArcGIS desktop installed
arcgisDesktop = "true"
# If ArcGIS desktop installed
if (arcgisDesktop == "true"):
# Import extra modules
import arcpy
# Enable data to be overwritten
arcpy.env.overwriteOutput = True
# Python version check
if sys.version_info[0] >= 3:
# Python 3.x
import urllib.request as urllib2
else:
# Python 2.x
import urllib2
import httplib
import json
import urllib
import urlparse
# Start of main function
def mainFunction(agsServerSite,username,password,startStop,allServices,userServices): # Get parameters from ArcGIS Desktop tool by seperating by comma e.g. (var1 is 1st parameter,var2 is 2nd parameter,var3 is 3rd parameter)
try:
# Get the server site details
protocol, serverName, serverPort, context = splitSiteURL(agsServerSite)
# If any of the variables are blank
if (serverName == None or serverPort == None or protocol == None or context == None):
return -1
# Add on slash to context if necessary
if not context.endswith('/'):
context += '/'
# Add on admin to context if necessary
if not context.endswith('admin/'):
context += 'admin/'
# Get token
token = getToken(username, password, serverName, serverPort)
# If token received
if (token != -1):
services = []
folder = ''
# If task is for all services
if (allServices == "true"):
# Query the root level for services
url = "https://{}:{}/arcgis/admin/services{}?f=pjson&token={}".format(serverName, serverPort, folder, token)
# Make the request
try:
serviceList = json.loads(urllib2.urlopen(url).read())
except urllib2.URLError, error:
printMessage(error,"error")
# Logging
if (enableLogging == "true"):
logger.error(error)
sys.exit()
# Add the services at the root level
for single in serviceList["services"]:
services.append(single['serviceName'] + '.' + single['type'])
# Build up list of folders and remove the System and Utilities folder
folderList = serviceList["folders"]
folderList.remove("Utilities")
folderList.remove("System")
# If there is any folders
if len(folderList) > 0:
# For each folder in the list
for folder in folderList:
# Query the folder for map services
URL = "https://{}:{}/arcgis/admin/services/{}?f=pjson&token={}".format(serverName, serverPort, folder, token)
fList = json.loads(urllib2.urlopen(URL).read())
for single in fList["services"]:
# Add the services found to the list
services.append(folder + "/" + single['serviceName'] + '.' + single['type'])
# Just for the user defined list of services
else:
services = userServices.split(",")
# For each of the services
for service in services:
# Start or stop the map service
op_service_url = "https://{}:{}/arcgis/admin/services/{}/{}?token={}&f=json".format(serverName, serverPort, service, startStop, token)
status = urllib2.urlopen(op_service_url, ' ').read()
# If successfully started/stopped
if 'success' in status:
arcpy.AddMessage(startStop + " successfully performed on " + service)
# Logging
if (enableLogging == "true"):
logger.error(startStop + " successfully performed on " + service)
# If there is an error
else:
arcpy.AddError("Failed to perform operation. Returned message from the server:")
arcpy.AddError(status)
# Logging
if (enableLogging == "true"):
logger.error("Failed to perform operation. Returned message from the server:")
logger.error(status)
# --------------------------------------- End of code --------------------------------------- #
# If called from gp tool return the arcpy parameter
if __name__ == '__main__':
# Return the output if there is any
if output:
# If ArcGIS desktop installed
if (arcgisDesktop == "true"):
arcpy.SetParameter(1, output)
# ArcGIS desktop not installed
else:
return output
# Otherwise return the result
else:
# Return the output if there is any
if output:
return output
# Logging
if (enableLogging == "true"):
# Log end of process
logger.info("Process ended.")
# Remove file handler and close log file
logMessage.flush()
logMessage.close()
logger.handlers = []
# If arcpy error
except arcpy.ExecuteError:
# Build and show the error message
errorMessage = arcpy.GetMessages(2)
printMessage(errorMessage,"error")
# Logging
if (enableLogging == "true"):
# Log error
logger.error(errorMessage)
# Log end of process
logger.info("Process ended.")
# Remove file handler and close log file
logMessage.flush()
logMessage.close()
logger.handlers = []
if (sendErrorEmail == "true"):
# Send email
sendEmail(errorMessage)
# If python error
except Exception as e:
errorMessage = ""
# Build and show the error message
# If many arguments
if (e.args):
for i in range(len(e.args)):
if (i == 0):
# Python version check
if sys.version_info[0] >= 3:
# Python 3.x
errorMessage = str(e.args[i]).encode('utf-8').decode('utf-8')
else:
# Python 2.x
errorMessage = unicode(e.args[i]).encode('utf-8')
else:
# Python version check
if sys.version_info[0] >= 3:
# Python 3.x
errorMessage = errorMessage + " " + str(e.args[i]).encode('utf-8').decode('utf-8')
else:
# Python 2.x
errorMessage = errorMessage + " " + unicode(e.args[i]).encode('utf-8')
# Else just one argument
else:
errorMessage = e
printMessage(errorMessage,"error")
# Logging
if (enableLogging == "true"):
# Log error
logger.error(errorMessage)
# Log end of process
logger.info("Process ended.")
# Remove file handler and close log file
logMessage.flush()
logMessage.close()
logger.handlers = []
if (sendErrorEmail == "true"):
# Send email
sendEmail(errorMessage)
# End of main function
# Start of get token function
def getToken(username, password, serverName, serverPort):
query_dict = {'username': username,
'password': password,
'expiration': "60",
'client': 'requestip'}
query_string = urllib.urlencode(query_dict)
url = "https://{}:{}/arcgis/admin/generateToken?f=json".format(serverName, serverPort)
try:
token = json.loads(urllib2.urlopen(url, query_string).read())
if "token" not in token or token == None:
arcpy.AddError("Failed to get token, return message from server:")
arcpy.AddError(token['messages'])
# Logging
if (enableLogging == "true"):
logger.error("Failed to get token, return message from server:")
logger.error(token['messages'])
sys.exit()
else:
# Return the token to the function which called for it
return token['token']
except urllib2.URLError, error:
arcpy.AddError("Could not connect to machine {} on port {}".format(serverName, serverPort))
arcpy.AddError(error)
# Logging
if (enableLogging == "true"):
logger.error("Could not connect to machine {} on port {}".format(serverName, serverPort))
logger.error(error)
sys.exit()
# End of get token function
# Start of split URL function
def splitSiteURL(siteURL):
try:
serverName = ''
serverPort = -1
protocol = 'http'
context = '/arcgis'
# Split up the URL provided
urllist = urlparse.urlsplit(siteURL)
# Put the URL list into a dictionary
d = urllist._asdict()
# Get the server name and port
serverNameAndPort = d['netloc'].split(":")
# User did not enter the port number, so we return -1
if (len(serverNameAndPort) == 1):
serverName = serverNameAndPort[0]
else:
if (len(serverNameAndPort) == 2):
serverName = serverNameAndPort[0]
serverPort = serverNameAndPort[1]
# Get protocol
if (d['scheme'] is not ''):
protocol = d['scheme']
# Get path
if (d['path'] is not '/' and d['path'] is not ''):
context = d['path']
# Return variables
return protocol, serverName, serverPort, context
except:
arcpy.AddError("The ArcGIS Server site URL should be in the format http(s)://<host>:<port>/arcgis")
# Logging
if (enableLogging == "true"):
logger.error("The ArcGIS Server site URL should be in the format http(s)://<host>:<port>/arcgis")
sys.exit()
return None, None, None, None
# End of split URL function
# Start of print message function
def printMessage(message,type):
# If ArcGIS desktop installed
if (arcgisDesktop == "true"):
if (type.lower() == "warning"):
arcpy.AddWarning(message)
elif (type.lower() == "error"):
arcpy.AddError(message)
else:
arcpy.AddMessage(message)
# ArcGIS desktop not installed
else:
print(message)
# End of print message function
# Start of set logging function
def setLogging(logFile):
# Create a logger
logger = logging.getLogger(os.path.basename(__file__))
logger.setLevel(logging.DEBUG)
# Setup log message handler
logMessage = logging.FileHandler(logFile)
# Setup the log formatting
logFormat = logging.Formatter("%(asctime)s: %(levelname)s - %(message)s", "%d/%m/%Y - %H:%M:%S")
# Add formatter to log message handler
logMessage.setFormatter(logFormat)
# Add log message handler to logger
logger.addHandler(logMessage)
return logger, logMessage
# End of set logging function
# Start of send email function
def sendEmail(message):
# Send an email
printMessage("Sending email...","info")
# Server and port information
smtpServer = smtplib.SMTP(emailServerName,emailServerPort)
smtpServer.ehlo()
smtpServer.starttls()
smtpServer.ehlo
# Login with sender email address and password
smtpServer.login(emailUser, emailPassword)
# Email content
header = 'To:' + emailTo + '\n' + 'From: ' + emailUser + '\n' + 'Subject:' + emailSubject + '\n'
body = header + '\n' + emailMessage + '\n' + '\n' + message
# Send the email and close the connection
smtpServer.sendmail(emailUser, emailTo, body)
# End of send email function
# This test allows the script to be used from the operating
# system command prompt (stand-alone), in a Python IDE,
# as a geoprocessing script tool, or as a module imported in
# another script
if __name__ == '__main__':
# Test to see if ArcGIS desktop installed
if ((os.path.basename(sys.executable).lower() == "arcgispro.exe") or (os.path.basename(sys.executable).lower() == "arcmap.exe") or (os.path.basename(sys.executable).lower() == "arccatalog.exe")):
arcgisDesktop = "true"
# If ArcGIS desktop installed
if (arcgisDesktop == "true"):
argv = tuple(arcpy.GetParameterAsText(i)
for i in range(arcpy.GetArgumentCount()))
# ArcGIS desktop not installed
else:
argv = sys.argv
# Delete the first argument, which is the script
del argv[0]
# Logging
if (enableLogging == "true"):
# Setup logging
logger, logMessage = setLogging(logFile)
# Log start of process
logger.info("Process started.")
# Setup the use of a proxy for requests
if (enableProxy == "true"):
# Setup the proxy
proxy = urllib2.ProxyHandler({requestProtocol : proxyURL})
openURL = urllib2.build_opener(proxy)
# Install the proxy
urllib2.install_opener(openURL)
mainFunction(*argv)