scc_access/scc_access.py

Thu, 11 Oct 2018 15:25:55 +0300

author
Iannis <i.binietoglou@impworks.gr>
date
Thu, 11 Oct 2018 15:25:55 +0300
changeset 30
4669876326d4
parent 28
2d90204710af
parent 29
3e3e5bda6b77
child 31
020e80de1f64
permissions
-rw-r--r--

Merge from Moritz branch. Clean-up is still needed.

victor@7 1 import requests
moritz@29 2
ioannis@17 3 try:
ioannis@17 4 import urllib.parse as urlparse # Python 3
ioannis@17 5 except ImportError:
ioannis@17 6 import urlparse # Python 2
victor@7 7
victor@7 8 import argparse
madrouin@24 9 import datetime
madrouin@24 10 import logging
victor@7 11 import os
victor@7 12 import re
i@28 13 from io import StringIO
madrouin@24 14 import sys
victor@7 15 import time
madrouin@24 16 import urlparse
victor@7 17 from zipfile import ZipFile
madrouin@24 18
i@14 19 import yaml
victor@7 20
madrouin@24 21 requests.packages.urllib3.disable_warnings()
i@14 22 logger = logging.getLogger(__name__)
victor@7 23
victor@7 24 # The regex to find the measurement id from the measurement page
victor@7 25 # This should be read from the uploaded file, but would require an extra NetCDF module.
victor@7 26 regex = "<h3>Measurement (?P<measurement_id>.{12}) <small>"
victor@7 27
victor@7 28
victor@7 29 class SCC:
madrouin@24 30 """A simple class that will attempt to upload a file on the SCC server.
i@14 31
victor@7 32 The uploading is done by simulating a normal browser session. In the current
madrouin@20 33 version no check is performed, and no feedback is given if the upload
madrouin@20 34 was successful. If everything is setup correctly, it will work.
victor@7 35 """
victor@7 36
i@14 37 def __init__(self, auth, output_dir, base_url):
moritz@29 38
victor@7 39 self.auth = auth
victor@7 40 self.output_dir = output_dir
i@14 41 self.base_url = base_url
victor@7 42 self.session = requests.Session()
moritz@29 43 self.session.auth = auth
moritz@29 44 self.session.verify = False
i@14 45 self.login_url = urlparse.urljoin(self.base_url, 'accounts/login/')
i@14 46 self.upload_url = urlparse.urljoin(self.base_url, 'data_processing/measurements/quick/')
moritz@29 47 self.download_preprocessed_pattern = urlparse.urljoin(self.base_url,
moritz@29 48 'data_processing/measurements/{0}/download-preprocessed/')
moritz@29 49 self.download_optical_pattern = urlparse.urljoin(self.base_url,
moritz@29 50 'data_processing/measurements/{0}/download-optical/')
moritz@29 51 self.download_graph_pattern = urlparse.urljoin(self.base_url,
moritz@29 52 'data_processing/measurements/{0}/download-plots/')
i@14 53 self.delete_measurement_pattern = urlparse.urljoin(self.base_url, 'admin/database/measurements/{0}/delete/')
i@14 54 self.api_base_url = urlparse.urljoin(self.base_url, 'api/v1/')
moritz@29 55 self.list_measurements_pattern = urlparse.urljoin(self.base_url, 'data_processing/measurements/')
i@14 56
i@14 57 def login(self, credentials):
victor@7 58 """ Login the the website. """
victor@7 59 logger.debug("Attempting to login to SCC, username %s." % credentials[0])
moritz@29 60 login_credentials = {'username': credentials[0],
moritz@29 61 'password': credentials[1]}
victor@7 62
i@14 63 logger.debug("Accessing login page at %s." % self.login_url)
victor@7 64
victor@7 65 # Get upload form
moritz@29 66 login_page = self.session.get(self.login_url)
victor@7 67
i@30 68 # TODO: Do we need this? Mortiz removed it.
i@14 69 if login_page.status_code != 200:
i@14 70 logger.error('Could not access login pages. Status code %s' % login_page.status_code)
i@14 71 sys.exit(1)
victor@7 72
victor@7 73 logger.debug("Submiting credentials.")
victor@7 74 # Submit the login data
i@14 75 login_submit = self.session.post(self.login_url,
moritz@29 76 data=login_credentials,
victor@7 77 headers={'X-CSRFToken': login_page.cookies['csrftoken'],
moritz@29 78 'referer': self.login_url})
victor@7 79 return login_submit
victor@7 80
victor@7 81 def logout(self):
victor@7 82 pass
victor@7 83
madrouin@20 84 def upload_file(self, filename, system_id, rs_filename=None):
madrouin@20 85 """ Upload a filename for processing with a specific system. If the
victor@7 86 upload is successful, it returns the measurement id. """
victor@7 87 # Get submit page
moritz@29 88 upload_page = self.session.get(self.upload_url)
victor@7 89
victor@7 90 # Submit the data
victor@7 91 upload_data = {'system': system_id}
victor@7 92 files = {'data': open(filename, 'rb')}
victor@7 93
madrouin@20 94 if rs_filename is not None:
madrouin@20 95 files['sounding_file'] = open(rs_filename, 'rb')
madrouin@20 96
i@14 97 logger.info("Uploading of file %s started." % filename)
victor@7 98
i@14 99 upload_submit = self.session.post(self.upload_url,
victor@7 100 data=upload_data,
victor@7 101 files=files,
victor@7 102 headers={'X-CSRFToken': upload_page.cookies['csrftoken'],
moritz@29 103 'referer': self.upload_url})
victor@7 104
victor@7 105 if upload_submit.status_code != 200:
i@14 106 logger.warning("Connection error. Status code: %s" % upload_submit.status_code)
victor@7 107 return False
victor@7 108
victor@7 109 # Check if there was a redirect to a new page.
i@14 110 if upload_submit.url == self.upload_url:
victor@7 111 measurement_id = False
i@14 112 logger.error("Uploaded file rejected! Try to upload manually to see the error.")
victor@7 113 else:
victor@7 114 measurement_id = re.findall(regex, upload_submit.text)[0]
madrouin@23 115 logger.info("Successfully uploaded measurement with id %s." % measurement_id)
victor@7 116
victor@7 117 return measurement_id
victor@7 118
victor@7 119 def download_files(self, measurement_id, subdir, download_url):
victor@7 120 """ Downloads some files from the download_url to the specified
madrouin@20 121 subdir. This method is used to download preprocessed file, optical
victor@7 122 files etc.
victor@7 123 """
victor@7 124 # Get the file
moritz@29 125 request = self.session.get(download_url, stream=True)
moritz@29 126
moritz@29 127 if not request.ok:
moritz@29 128 raise Exception("Could not download files for measurement '%s'" % measurement_id)
victor@7 129
victor@7 130 # Create the dir if it does not exist
victor@7 131 local_dir = os.path.join(self.output_dir, measurement_id, subdir)
victor@7 132 if not os.path.exists(local_dir):
victor@7 133 os.makedirs(local_dir)
victor@7 134
victor@7 135 # Save the file by chunk, needed if the file is big.
ioannis@17 136 memory_file = StringIO()
victor@7 137
victor@7 138 for chunk in request.iter_content(chunk_size=1024):
victor@7 139 if chunk: # filter out keep-alive new chunks
victor@7 140 memory_file.write(chunk)
victor@7 141 memory_file.flush()
victor@7 142
victor@7 143 zip_file = ZipFile(memory_file)
victor@7 144
victor@7 145 for ziped_name in zip_file.namelist():
victor@7 146 basename = os.path.basename(ziped_name)
victor@7 147
victor@7 148 local_file = os.path.join(local_dir, basename)
victor@7 149
victor@7 150 with open(local_file, 'wb') as f:
victor@7 151 f.write(zip_file.read(ziped_name))
victor@7 152
victor@7 153 def download_preprocessed(self, measurement_id):
victor@7 154 """ Download preprocessed files for the measurement id. """
victor@7 155 # Construct the download url
i@14 156 download_url = self.download_preprocessed_pattern.format(measurement_id)
victor@7 157 self.download_files(measurement_id, 'scc_preprocessed', download_url)
victor@7 158
victor@7 159 def download_optical(self, measurement_id):
victor@7 160 """ Download optical files for the measurement id. """
victor@7 161 # Construct the download url
moritz@29 162 download_url = self.download_optical_pattern.format(measurement_id)
victor@7 163 self.download_files(measurement_id, 'scc_optical', download_url)
victor@7 164
victor@7 165 def download_graphs(self, measurement_id):
victor@7 166 """ Download profile graphs for the measurement id. """
victor@7 167 # Construct the download url
i@14 168 download_url = self.download_graph_pattern.format(measurement_id)
victor@7 169 self.download_files(measurement_id, 'scc_plots', download_url)
victor@7 170
victor@7 171 def rerun_processing(self, measurement_id, monitor=True):
madrouin@26 172 measurement, status = self.get_measurement(measurement_id)
victor@7 173
victor@7 174 if measurement:
moritz@29 175 request = self.session.get(measurement.rerun_processing_url, stream=True)
victor@7 176
victor@7 177 if request.status_code != 200:
i@14 178 logger.error(
i@14 179 "Could not rerun processing for %s. Status code: %s" % (measurement_id, request.status_code))
victor@7 180 return
victor@7 181
victor@7 182 if monitor:
victor@7 183 self.monitor_processing(measurement_id)
victor@7 184
victor@7 185 def rerun_all(self, measurement_id, monitor=True):
victor@7 186 logger.debug("Started rerun_all procedure.")
victor@7 187
victor@7 188 logger.debug("Getting measurement %s" % measurement_id)
madrouin@26 189 measurement, status = self.get_measurement(measurement_id)
victor@7 190
victor@7 191 if measurement:
victor@7 192 logger.debug("Attempting to rerun all processing through %s." % measurement.rerun_all_url)
victor@7 193
moritz@29 194 request = self.session.get(measurement.rerun_all_url, stream=True)
victor@7 195
victor@7 196 if request.status_code != 200:
victor@7 197 logger.error("Could not rerun pre processing for %s. Status code: %s" %
victor@7 198 (measurement_id, request.status_code))
victor@7 199 return
victor@7 200
victor@7 201 if monitor:
victor@7 202 self.monitor_processing(measurement_id)
victor@7 203
i@30 204 def process(self, filename, system_id, monitor, rs_filename=None):
victor@7 205 """ Upload a file for processing and wait for the processing to finish.
victor@7 206 If the processing is successful, it will download all produced files.
victor@7 207 """
victor@7 208 logger.info("--- Processing started on %s. ---" % datetime.datetime.now())
victor@7 209 # Upload file
madrouin@26 210 logger.info("--- Uploading file")
madrouin@21 211 measurement_id = self.upload_file(filename, system_id, rs_filename=rs_filename)
victor@7 212
madrouin@26 213 logger.info("--- Monitoring processing")
moritz@29 214 if monitor:
moritz@29 215 return self.monitor_processing(measurement_id)
moritz@29 216 return None
victor@7 217
victor@7 218 def monitor_processing(self, measurement_id):
victor@7 219 """ Monitor the processing progress of a measurement id"""
victor@7 220
madrouin@24 221 # try to deal with error 404
madrouin@24 222 error_count = 0
madrouin@24 223 error_max = 6
madrouin@26 224 time_sleep = 10
madrouin@24 225
madrouin@25 226 # try to wait for measurement to appear in API
madrouin@24 227 measurement = None
madrouin@26 228 logger.info("looking for measurement %s in SCC", measurement_id)
madrouin@26 229 while error_count < error_max:
madrouin@26 230 time.sleep(time_sleep)
madrouin@26 231 measurement, status = self.get_measurement(measurement_id)
madrouin@26 232 if status != 200 and error_count < error_max:
madrouin@26 233 logger.error("measurement not found. waiting %ds", time_sleep)
madrouin@24 234 error_count += 1
madrouin@26 235 else:
madrouin@26 236 break
madrouin@24 237
madrouin@24 238 if error_count == error_max:
madrouin@24 239 logger.critical("measurement %s doesn't seem to exist", measurement_id)
madrouin@26 240 sys.exit(1)
madrouin@26 241
madrouin@26 242 logger.info('measurement %s found', measurement_id)
madrouin@24 243
victor@7 244 if measurement is not None:
victor@7 245 while measurement.is_running:
madrouin@24 246 logger.info("Measurement is being processed (status: %s, %s, %s). Please wait.", measurement.upload, measurement.pre_processing, measurement.processing)
victor@7 247 time.sleep(10)
madrouin@26 248 measurement, status = self.get_measurement(measurement_id)
madrouin@24 249
madrouin@26 250 logger.info("Measurement processing finished (status: %s, %s, %s).",measurement.upload, measurement.pre_processing, measurement.processing)
victor@7 251 if measurement.pre_processing == 127:
victor@7 252 logger.info("Downloading preprocessed files.")
victor@7 253 self.download_preprocessed(measurement_id)
victor@7 254 if measurement.processing == 127:
victor@7 255 logger.info("Downloading optical files.")
victor@7 256 self.download_optical(measurement_id)
victor@7 257 logger.info("Downloading graphs.")
victor@7 258 self.download_graphs(measurement_id)
victor@7 259 logger.info("--- Processing finished. ---")
victor@7 260 return measurement
victor@7 261
victor@7 262 def get_status(self, measurement_id):
victor@7 263 """ Get the processing status for a measurement id through the API. """
i@14 264 measurement_url = urlparse.urljoin(self.api_base_url, 'measurements/?id__exact=%s' % measurement_id)
victor@7 265
moritz@29 266 response = self.session.get(measurement_url)
victor@7 267
victor@7 268 response_dict = response.json()
victor@7 269
victor@7 270 if response_dict['objects']:
victor@7 271 measurement_list = response_dict['objects']
i@14 272 measurement = Measurement(self.base_url, measurement_list[0])
i@14 273 return measurement.upload, measurement.pre_processing, measurement.processing
victor@7 274 else:
victor@7 275 logger.error("No measurement with id %s found on the SCC." % measurement_id)
victor@7 276 return None
victor@7 277
victor@7 278 def get_measurement(self, measurement_id):
i@14 279 measurement_url = urlparse.urljoin(self.api_base_url, 'measurements/%s/' % measurement_id)
victor@7 280
moritz@29 281 response = self.session.get(measurement_url)
victor@7 282
moritz@29 283 if not response.ok:
i@14 284 logger.error('Could not access API. Status code %s.' % response.status_code)
madrouin@26 285 return None, response.status_code
i@14 286
victor@7 287 response_dict = response.json()
victor@7 288
victor@7 289 if response_dict:
moritz@29 290 measurement = Measurement(self.base_url, response_dict)
madrouin@26 291 return measurement, response.status_code
victor@7 292 else:
victor@7 293 logger.error("No measurement with id %s found on the SCC." % measurement_id)
madrouin@26 294 return None, response.status_code
victor@7 295
victor@7 296 def delete_measurement(self, measurement_id):
victor@7 297 """ Deletes a measurement with the provided measurement id. The user
madrouin@20 298 should have the appropriate permissions.
madrouin@20 299
victor@7 300 The procedures is performed directly through the web interface and
victor@7 301 NOT through the API.
victor@7 302 """
victor@7 303 # Get the measurement object
madrouin@26 304 measurement, status = self.get_measurement(measurement_id)
victor@7 305
victor@7 306 # Check that it exists
victor@7 307 if measurement is None:
victor@7 308 logger.warning("Nothing to delete.")
victor@7 309 return None
victor@7 310
victor@7 311 # Go the the page confirming the deletion
moritz@29 312 delete_url = self.delete_measurement_pattern.format(measurement_id)
victor@7 313
moritz@29 314 confirm_page = self.session.get(delete_url)
victor@7 315
victor@7 316 # Check that the page opened properly
victor@7 317 if confirm_page.status_code != 200:
victor@7 318 logger.warning("Could not open delete page. Status: {0}".format(confirm_page.status_code))
victor@7 319 return None
victor@7 320
victor@7 321 # Delete the measurement
victor@7 322 delete_page = self.session.post(delete_url,
victor@7 323 data={'post': 'yes'},
victor@7 324 headers={'X-CSRFToken': confirm_page.cookies['csrftoken'],
victor@7 325 'referer': delete_url}
victor@7 326 )
victor@7 327 if delete_page.status_code != 200:
victor@7 328 logger.warning("Something went wrong. Delete page status: {0}".format(
victor@7 329 delete_page.status_code))
victor@7 330 return None
victor@7 331
victor@7 332 logger.info("Deleted measurement {0}".format(measurement_id))
victor@7 333 return True
victor@7 334
victor@7 335 def available_measurements(self):
victor@7 336 """ Get a list of available measurement on the SCC. """
i@14 337 measurement_url = urlparse.urljoin(self.api_base_url, 'measurements')
moritz@29 338 response = self.session.get(measurement_url)
victor@7 339 response_dict = response.json()
victor@7 340
victor@7 341 measurements = None
victor@7 342 if response_dict:
victor@7 343 measurement_list = response_dict['objects']
i@14 344 measurements = [Measurement(self.base_url, measurement_dict) for measurement_dict in measurement_list]
victor@7 345 logger.info("Found %s measurements on the SCC." % len(measurements))
victor@7 346 else:
victor@7 347 logger.warning("No response received from the SCC when asked for available measurements.")
victor@7 348
victor@7 349 return measurements
victor@7 350
moritz@29 351 def list_measurements(self, station=None, system=None, start=None, stop=None, upload_status=None,
moritz@29 352 processing_status=None, optical_processing=None):
moritz@29 353
moritz@29 354 # Need to set to empty string if not specified, we won't get any results
moritz@29 355 params = {
moritz@29 356 "station": station if station is not None else "",
moritz@29 357 "system": system if system is not None else "",
moritz@29 358 "stop": stop if stop is not None else "",
moritz@29 359 "start": start if start is not None else "",
moritz@29 360 "upload_status": upload_status if upload_status is not None else "",
moritz@29 361 "preprocessing_status": processing_status if processing_status is not None else "",
moritz@29 362 "optical_processing_status": optical_processing if optical_processing is not None else ""
moritz@29 363 }
moritz@29 364 resp = self.session.get(self.list_measurements_pattern, params=params).text
moritz@29 365 tbl_rgx = re.compile(r'<table id="measurements">(.*?)</table>', re.DOTALL)
moritz@29 366 entry_rgx = re.compile(r'<tr>(.*?)</tr>', re.DOTALL)
moritz@29 367 measurement_rgx = re.compile(
moritz@29 368 r'.*?<td><a[^>]*>(\w+)</a>.*?<td>.*?<td>([\w-]+ [\w:]+)</td>.*<td data-order="([-]?\d+),([-]?\d+),([-]?\d+)".*',
moritz@29 369 re.DOTALL)
moritz@29 370 matches = tbl_rgx.findall(resp)
moritz@29 371 if len(matches) != 1:
moritz@29 372 return []
moritz@29 373
moritz@29 374 ret = []
moritz@29 375 for entry in entry_rgx.finditer(matches[0]):
moritz@29 376 m = measurement_rgx.match(entry.string[entry.start(0):entry.end(0)])
moritz@29 377 if m:
moritz@29 378 name, date, upload, preproc, optical = m.groups()
moritz@29 379 ret.append(
moritz@29 380 Measurement(self.base_url, {"id": name, "upload": int(upload), "pre_processing": int(preproc),
moritz@29 381 "processing": int(optical)}))
moritz@29 382
moritz@29 383 return ret
moritz@29 384
victor@7 385 def measurement_id_for_date(self, t1, call_sign='bu', base_number=0):
victor@7 386 """ Give the first available measurement id on the SCC for the specific
madrouin@20 387 date.
victor@7 388 """
victor@7 389 date_str = t1.strftime('%Y%m%d')
i@14 390 search_url = urlparse.urljoin(self.api_base_url, 'measurements/?id__startswith=%s' % date_str)
victor@7 391
moritz@29 392 response = self.session.get(search_url)
victor@7 393
victor@7 394 response_dict = response.json()
victor@7 395
victor@7 396 measurement_id = None
victor@7 397
victor@7 398 if response_dict:
victor@7 399 measurement_list = response_dict['objects']
victor@7 400 existing_ids = [measurement_dict['id'] for measurement_dict in measurement_list]
victor@7 401
victor@7 402 measurement_number = base_number
victor@7 403 measurement_id = "%s%s%02i" % (date_str, call_sign, measurement_number)
victor@7 404
victor@7 405 while measurement_id in existing_ids:
victor@7 406 measurement_number = measurement_number + 1
victor@7 407 measurement_id = "%s%s%02i" % (date_str, call_sign, measurement_number)
victor@7 408 if measurement_number == 100:
victor@7 409 raise ValueError('No available measurement id found.')
victor@7 410
victor@7 411 return measurement_id
victor@7 412
victor@7 413
ioannis@17 414 class ApiObject(object):
victor@7 415 """ A generic class object. """
victor@7 416
i@14 417 def __init__(self, base_url, dict_response):
i@14 418 self.base_url = base_url
victor@7 419
victor@7 420 if dict_response:
victor@7 421 # Add the dictionary key value pairs as object properties
victor@7 422 for key, value in dict_response.items():
ioannis@17 423 # logger.debug('Setting key {0} to value {1}'.format(key, value))
ioannis@17 424 try:
ioannis@17 425 setattr(self, key, value)
ioannis@17 426 except:
ioannis@17 427 logger.warning('Could not set attribute {0} to value {1}'.format(key, value))
victor@7 428 self.exists = True
victor@7 429 else:
victor@7 430 self.exists = False
victor@7 431
victor@7 432
victor@7 433 class Measurement(ApiObject):
victor@7 434 """ This class represents the measurement object as returned in the SCC API.
victor@7 435 """
victor@7 436
victor@7 437 @property
victor@7 438 def is_running(self):
victor@7 439 """ Returns True if the processing has not finished.
victor@7 440 """
victor@7 441 if self.upload == 0:
victor@7 442 return False
victor@7 443 if self.pre_processing == -127:
victor@7 444 return False
victor@7 445 if self.pre_processing == 127:
victor@7 446 if self.processing in [127, -127]:
victor@7 447 return False
victor@7 448 return True
victor@7 449
victor@7 450 @property
victor@7 451 def rerun_processing_url(self):
i@14 452 url_pattern = urlparse.urljoin(self.base_url, 'data_processing/measurements/{0}/rerun-optical/')
i@14 453 return url_pattern.format(self.id)
victor@7 454
victor@7 455 @property
victor@7 456 def rerun_all_url(self):
i@14 457 ulr_pattern = urlparse.urljoin(self.base_url, 'data_processing/measurements/{0}/rerun-all/')
i@14 458 return ulr_pattern.format(self.id)
victor@7 459
victor@7 460 def __str__(self):
victor@7 461 return "%s: %s, %s, %s" % (self.id,
victor@7 462 self.upload,
victor@7 463 self.pre_processing,
victor@7 464 self.processing)
victor@7 465
victor@7 466
madrouin@20 467 def upload_file(filename, system_id, settings, rs_filename=None):
victor@7 468 """ Shortcut function to upload a file to the SCC. """
victor@7 469 logger.info("Uploading file %s, using sytem %s" % (filename, system_id))
victor@7 470
i@14 471 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 472 scc.login(settings['website_credentials'])
madrouin@20 473 measurement_id = scc.upload_file(filename, system_id, rs_filename=rs_filename)
victor@7 474 scc.logout()
victor@7 475 return measurement_id
victor@7 476
victor@7 477
madrouin@21 478 def process_file(filename, system_id, settings, rs_filename=None):
victor@7 479 """ Shortcut function to process a file to the SCC. """
victor@7 480 logger.info("Processing file %s, using sytem %s" % (filename, system_id))
victor@7 481
i@14 482 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 483 scc.login(settings['website_credentials'])
madrouin@21 484 measurement = scc.process(filename, system_id, rs_filename=rs_filename)
victor@7 485 scc.logout()
victor@7 486 return measurement
victor@7 487
victor@7 488
moritz@29 489 def delete_measurement(measurement_ids, settings):
moritz@29 490 """ Shortcut function to delete measurements from the SCC. """
moritz@29 491 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
moritz@29 492 scc.login(settings['website_credentials'])
moritz@29 493 for m_id in measurement_ids:
moritz@29 494 logger.info("Deleting %s" % m_id)
moritz@29 495 scc.delete_measurement(m_id)
moritz@29 496 scc.logout()
moritz@29 497
moritz@29 498
moritz@29 499 def rerun_all(measurement_ids, monitor, settings):
moritz@29 500 """ Shortcut function to rerun measurements from the SCC. """
i@14 501
i@14 502 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 503 scc.login(settings['website_credentials'])
moritz@29 504 for m_id in measurement_ids:
moritz@29 505 logger.info("Rerunning all products for %s" % m_id)
moritz@29 506 scc.rerun_all(m_id, monitor)
victor@7 507 scc.logout()
victor@7 508
victor@7 509
moritz@29 510 def rerun_processing(measurement_ids, monitor, settings):
victor@7 511 """ Shortcut function to delete a measurement from the SCC. """
i@14 512
i@14 513 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 514 scc.login(settings['website_credentials'])
moritz@29 515 for m_id in measurement_ids:
moritz@29 516 logger.info("Rerunning (optical) processing for %s" % m_id)
moritz@29 517 scc.rerun_processing(m_id, monitor)
moritz@29 518 scc.logout()
moritz@29 519
moritz@29 520
moritz@29 521 def list_measurements(settings, station=None, system=None, start=None, stop=None, upload_status=None,
moritz@29 522 preprocessing_status=None,
moritz@29 523 optical_processing=None):
moritz@29 524 """List all available measurements"""
moritz@29 525 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
moritz@29 526 scc.login(settings['website_credentials'])
moritz@29 527 ret = scc.list_measurements(station=station, system=system, start=start, stop=stop, upload_status=upload_status,
moritz@29 528 processing_status=preprocessing_status, optical_processing=optical_processing)
moritz@29 529 for entry in ret:
moritz@29 530 print("%s" % entry.id)
victor@7 531 scc.logout()
victor@7 532
victor@7 533
moritz@29 534 def download_measurements(measurement_ids, download_preproc, download_optical, download_graph, settings):
moritz@29 535 """Download all measurements for the specified IDs"""
i@14 536 scc = SCC(settings['basic_credentials'], settings['output_dir'], settings['base_url'])
i@14 537 scc.login(settings['website_credentials'])
moritz@29 538 for m_id in measurement_ids:
moritz@29 539 if download_preproc:
moritz@29 540 logger.info("Downloading preprocessed files for '%s'" % m_id)
moritz@29 541 scc.download_preprocessed(m_id)
moritz@29 542 logger.info("Complete")
moritz@29 543 if download_optical:
moritz@29 544 logger.info("Downloading optical files for '%s'" % m_id)
moritz@29 545 scc.download_optical(m_id)
moritz@29 546 logger.info("Complete")
moritz@29 547 if download_graph:
moritz@29 548 logger.info("Downloading profile graph files for '%s'" % m_id)
moritz@29 549 scc.download_graphs(m_id)
moritz@29 550 logger.info("Complete")
i@14 551
i@14 552
moritz@29 553 def settings_from_path(config_file_path):
i@14 554 """ Read the configuration file.
i@14 555
i@14 556 The file should be in YAML syntax."""
i@14 557
i@14 558 if not os.path.isfile(config_file_path):
moritz@29 559 raise argparse.ArgumentTypeError("Wrong path for configuration file (%s)" % config_file_path)
i@14 560
i@14 561 with open(config_file_path) as yaml_file:
i@14 562 try:
i@14 563 settings = yaml.safe_load(yaml_file)
i@14 564 logger.debug("Read settings file(%s)" % config_file_path)
moritz@29 565 except Exception:
moritz@29 566 raise argparse.ArgumentTypeError("Could not parse YAML file (%s)" % config_file_path)
i@14 567
i@14 568 # YAML limitation: does not read tuples
i@14 569 settings['basic_credentials'] = tuple(settings['basic_credentials'])
i@14 570 settings['website_credentials'] = tuple(settings['website_credentials'])
i@14 571 return settings
i@14 572
i@14 573
moritz@29 574 # Setup for command specific parsers
moritz@29 575 def setup_delete(parser):
moritz@29 576 def delete_from_args(parsed):
moritz@29 577 delete_measurement(parsed.IDs, parsed.config)
moritz@29 578
moritz@29 579 parser.add_argument("IDs", nargs="+", help="measurement IDs to delete.")
moritz@29 580 parser.set_defaults(execute=delete_from_args)
moritz@29 581
moritz@29 582
moritz@29 583 def setup_rerun_all(parser):
moritz@29 584 def rerun_all_from_args(parsed):
moritz@29 585 rerun_all(parsed.IDs, parsed.process, parsed.config)
moritz@29 586
moritz@29 587 parser.add_argument("IDs", nargs="+", help="Measurement IDs to rerun.")
moritz@29 588 parser.add_argument("-p", "--process", help="Wait for the results of the processing.",
moritz@29 589 action="store_true")
moritz@29 590 parser.set_defaults(execute=rerun_all_from_args)
moritz@29 591
moritz@29 592
moritz@29 593 def setup_rerun_processing(parser):
moritz@29 594 def rerun_processing_from_args(parsed):
moritz@29 595 rerun_processing(parsed.IDs, parsed.process, parsed.config)
moritz@29 596
moritz@29 597 parser.add_argument("IDs", nargs="+", help="Measurement IDs to rerun the processing on.")
moritz@29 598 parser.add_argument("-p", "--process", help="Wait for the results of the processing.",
moritz@29 599 action="store_true")
moritz@29 600 parser.set_defaults(execute=rerun_processing_from_args)
moritz@29 601
moritz@29 602
moritz@29 603 def setup_process_file(parser):
moritz@29 604 def process_file_from_args(parsed):
i@30 605 process_file(parsed.file, parsed.system, parsed.process, parsed.config, parsed.radiosounding)
moritz@29 606
moritz@29 607 parser.add_argument("filename", help="Measurement file name or path.")
moritz@29 608 parser.add_argument("system", help="Processing system id.")
i@30 609 parser.add_argument("--radiosounding", default=None, help="Radiosounding file name or path")
moritz@29 610 parser.add_argument("-p", "--process", help="Wait for the results of the processing.",
moritz@29 611 action="store_true")
moritz@29 612 parser.set_defaults(execute=process_file_from_args)
moritz@29 613
moritz@29 614
moritz@29 615 def setup_upload_file(parser):
moritz@29 616 def upload_file_from_args(parsed):
i@30 617 upload_file(parsed.file, parsed.system, parsed.config, parsed.radiosounding)
moritz@29 618
moritz@29 619 parser.add_argument("filename", help="Measurement file name or path.")
moritz@29 620 parser.add_argument("system", help="Processing system id.")
i@30 621 parser.add_argument("--radiosounding", default=None, help="Radiosounding file name or path")
i@30 622
moritz@29 623 parser.set_defaults(execute=upload_file_from_args)
moritz@29 624
moritz@29 625
moritz@29 626 def setup_list_measurements(parser):
moritz@29 627 def list_measurements_from_args(parsed):
moritz@29 628 list_measurements(parsed.config, station=parsed.station, system=parsed.system, start=parsed.start,
moritz@29 629 stop=parsed.stop,
moritz@29 630 upload_status=parsed.upload_status, preprocessing_status=parsed.preprocessing_status,
moritz@29 631 optical_processing=parsed.optical_processing_status)
moritz@29 632
moritz@29 633 def status(arg):
moritz@29 634 if -127 <= int(arg) <= 127:
moritz@29 635 return arg
moritz@29 636 else:
moritz@29 637 raise argparse.ArgumentTypeError("Status must be between -127 and 127")
moritz@29 638
moritz@29 639 def date(arg):
moritz@29 640 if re.match(r'\d{4}-\d{2}-\d{2}', arg):
moritz@29 641 return arg
moritz@29 642 else:
moritz@29 643 raise argparse.ArgumentTypeError("Date must be in format 'YYYY-MM-DD'")
moritz@29 644
moritz@29 645 parser.add_argument("--station", help="Filter for only the selected station")
moritz@29 646 parser.add_argument("--system", help="Filter for only the selected station")
moritz@29 647 parser.add_argument("--start", help="Filter for only the selected station", type=date)
moritz@29 648 parser.add_argument("--stop", help="Filter for only the selected station", type=date)
moritz@29 649 parser.add_argument("--upload-status", help="Filter for only the selected station", type=status)
moritz@29 650 parser.add_argument("--preprocessing-status", help="Filter for only the selected station", type=status)
moritz@29 651 parser.add_argument("--optical-processing-status", help="Filter for only the selected station", type=status)
moritz@29 652 parser.set_defaults(execute=list_measurements_from_args)
moritz@29 653
moritz@29 654
moritz@29 655 def setup_download_measurements(parser):
moritz@29 656 def download_measurements_from_args(parsed):
moritz@29 657 preproc = parsed.download_preprocessed
moritz@29 658 optical = parsed.download_optical
moritz@29 659 graphs = parsed.download_profile_graphs
moritz@29 660 if not preproc and not graphs:
moritz@29 661 optical = True
moritz@29 662 download_measurements(parsed.IDs, preproc, optical, graphs, parsed.config)
moritz@29 663
moritz@29 664 parser.add_argument("IDs", help="Measurement IDs that should be downloaded.", nargs="+")
moritz@29 665 parser.add_argument("--download-preprocessed", action="store_true", help="Download preprocessed files.")
moritz@29 666 parser.add_argument("--download-optical", action="store_true",
moritz@29 667 help="Download optical files (default if no other download is used).")
moritz@29 668 parser.add_argument("--download-profile-graphs", action="store_true", help="Download profile graph files.")
moritz@29 669 parser.set_defaults(execute=download_measurements_from_args)
moritz@29 670
moritz@29 671
victor@7 672 def main():
victor@7 673 # Define the command line arguments.
victor@7 674 parser = argparse.ArgumentParser()
moritz@29 675 subparsers = parser.add_subparsers()
moritz@29 676
moritz@29 677 delete_parser = subparsers.add_parser("delete", help="Deletes a measurement.")
moritz@29 678 rerun_all_parser = subparsers.add_parser("rerun-all", help="Rerun a measurement.")
moritz@29 679 rerun_processing_parser = subparsers.add_parser("rerun-processing",
moritz@29 680 help="Rerun processing routings for a measurement.")
moritz@29 681 process_file_parser = subparsers.add_parser("process-file", help="Process a file.")
moritz@29 682 upload_file_parser = subparsers.add_parser("upload-file", help="Upload a file.")
moritz@29 683 list_parser = subparsers.add_parser("list", help="List all measurements.")
moritz@29 684 download_parser = subparsers.add_parser("download", help="Download selected measurements.")
moritz@29 685
moritz@29 686 setup_delete(delete_parser)
moritz@29 687 setup_rerun_all(rerun_all_parser)
moritz@29 688 setup_rerun_processing(rerun_processing_parser)
moritz@29 689 setup_process_file(process_file_parser)
moritz@29 690 setup_upload_file(upload_file_parser)
moritz@29 691 setup_list_measurements(list_parser)
moritz@29 692 setup_download_measurements(download_parser)
victor@7 693
victor@7 694 # Verbosity settings from http://stackoverflow.com/a/20663028
victor@7 695 parser.add_argument('-d', '--debug', help="Print debugging information.", action="store_const",
victor@7 696 dest="loglevel", const=logging.DEBUG, default=logging.INFO,
victor@7 697 )
victor@7 698 parser.add_argument('-s', '--silent', help="Show only warning and error messages.", action="store_const",
victor@7 699 dest="loglevel", const=logging.WARNING
victor@7 700 )
victor@7 701
moritz@29 702 home = os.path.expanduser("~")
moritz@29 703 default_config_location = os.path.abspath(os.path.join(home, ".scc_access.yaml"))
moritz@29 704 parser.add_argument("-c", "--config", help="Path to the config file.", type=settings_from_path,
moritz@29 705 default=default_config_location)
moritz@29 706
victor@7 707 args = parser.parse_args()
victor@7 708
victor@7 709 # Get the logger with the appropriate level
victor@7 710 logging.basicConfig(format='%(levelname)s: %(message)s', level=args.loglevel)
victor@7 711
moritz@29 712 # Dispatch to appropriate function
moritz@29 713 args.execute(args)
moritz@29 714
i@14 715
moritz@29 716 # When running through terminal
moritz@29 717 if __name__ == '__main__':
moritz@29 718 main()

mercurial