app.py

"""
CUCM Call Routing Editor - A simple call routing editor for Cisco CUCM
Copyright (C) 2020  Billy Zoellers, Dean Dorton Allen Ford, PLLC

  This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License 
  as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  You should have received a copy of the GNU General Public License along with this program.
  If not, see <http://www.gnu.org/licenses/>.
"""

from flask import Flask, render_template, request, redirect, url_for, session
from flask_simplelogin import SimpleLogin, login_required
from cucm_helper import get_ucm, get_translation_patterns_with_uuids, update_translation_pattern_called_party_mask
from app_helper import is_allowed_uuid, is_allowed_dest, allowed_dest_for_value
from dotenv import load_dotenv
import os

# Configure flask app
load_dotenv()
app = Flask(__name__)
if os.getenv("SECRET_KEY") is not None:
  app.config['SECRET_KEY'] = os.getenv("SECRET_KEY")
app.config['SIMPLELOGIN_USERNAME'] = 'editor'
if os.getenv("WEBUI_PASSWORD") is None:
  raise RuntimeError('You must set WEBUI_PASSWORD using enviornment variables.')
app.config['SIMPLELOGIN_PASSWORD'] = os.getenv("WEBUI_PASSWORD")
SimpleLogin(app)

# Connect to CUCM
cucm = os.getenv("CUCM_HOST")
cucm_username = os.getenv("CUCM_USER")
cucm_password = os.getenv("CUCM_PASS")
version = os.getenv("CUCM_VERSION")
if not (cucm and cucm_username and cucm_password):
  raise RuntimeError('You must set CUCM_HOST, CUCM_USER, and CUCM_PASS using enviornment variables.')
if version is None:
  version = "12.5"
ucm = get_ucm(user=cucm_username,password=cucm_password,host=cucm,version=version)

# Load data
path = "data.json"
with open(path, "r") as handle:
 import json
 data = json.load(handle)

allowed_uuids = data['TranslationPatternUUIDs']
allowed_dests = data['CalledPartyTransformationMasks']

@app.route('/', methods=["GET"])
@login_required
def index():
  # Get session variables for alert box
  if session.get('warning'):
    warning = session.get('warning')
    session.pop('warning')
  else:
    warning = False
  if session.get('alert_text'):
    alert_text = session.get('alert_text')
    session.pop('alert_text')
  else:
    alert_text = False

  # Get list of patterns from UUIDs in data.json, translate them into a readable list
  try:
    patterns = get_translation_patterns_with_uuids(ucm=ucm, uuids=allowed_uuids)
  except Exception as err:
    return render_template("error.html", error_alert=err, error_message='Please check connection parameters.', cucm_host='not connected')
  friendly_patterns = []
  for pattern in patterns:
    friendly_pattern = {
      "uuid": pattern.uuid[1:-1],
      "description": pattern.description,
      "pattern": pattern.pattern,
      "destination_name": allowed_dest_for_value(dest=pattern.calledPartyTransformationMask, allowed_dests=allowed_dests),
      "destination": pattern.calledPartyTransformationMask,
    }
    friendly_patterns.append(friendly_pattern)
  
  return render_template("index.html", patterns=friendly_patterns, allowed_dests=allowed_dests, warning=warning, edit_text=alert_text, cucm_host=cucm)

@app.route('/', methods=["POST"])
@login_required
def index_post():
  edit_text = False
  warning = False
  uuid = request.form["uuid"]
  dest = request.form["dest"]

  if dest:
    change = change_pattern(uuid=uuid, newmask=dest)

    if ("error" in change):
      warning = True
      edit_text = change['error']
    else:
      pattern = get_translation_patterns_with_uuids(ucm=ucm, uuids=[change['uuid']])[0]
      oldmask_name = allowed_dest_for_value(dest=change['oldmask'], allowed_dests=allowed_dests)
      newmask_name = allowed_dest_for_value(dest=change['newmask'], allowed_dests=allowed_dests)
      edit_text = f"{pattern['description']} updated from {oldmask_name} ({change['oldmask']}) to {newmask_name} ({change['newmask']})"

  session['warning'] = warning
  session['alert_text'] = edit_text
  return redirect(url_for('index'))
    

## Change pattern and return message
def change_pattern(uuid, newmask):
  if not is_allowed_uuid(uuid=uuid, allowed_uuids=allowed_uuids):
    return {"error": "UUID is not in allowed list"}
  
  if not is_allowed_dest(dest=newmask, allowed_dests=allowed_dests):
    return {"error": "Destination is not in allowed list"}

  try:
    response = update_translation_pattern_called_party_mask(ucm=ucm, uuid=uuid, mask=newmask)
  except Exception as err:
    return {"error": err}

  print(f"Changed {response['uuid']}, old mask: {response['oldmask']} new mask: {response['newmask']}")
  return response

if __name__ == '__main__':
  app.run(host='0.0.0.0')