mirror of
https://github.com/frappe/bench.git
synced 2024-09-30 15:59:03 +00:00
153546afd7
Goals: - Commonify bench operations in a way that intuitive - Get rid of the multiple duplicate functions because it's so hard to understand flow in the codebase ;) - Eliminate the need to guess, re-guess and pass bench info in each function that needs to do literally anything - Increase my happiness index because I just realised that I'm the top contributor of this project and I'd like to make it my own. - Adopt the principles of Least Surprise & The Principle of The Bigger Smile (of DHH) [inspired by ruby & ror] Changes: - The bench module has Bench and the action classes that can be accessed through the bench object - Used the Bench class to access properties like sites, apps & run (to execute commands in context) to reduce effort and clutter - Style improvements & minor changes included
106 lines
3.5 KiB
Python
106 lines
3.5 KiB
Python
# imports - standard imports
|
|
import json
|
|
import os
|
|
from collections import defaultdict
|
|
|
|
|
|
def get_site_config(site, bench_path='.'):
|
|
config_path = os.path.join(bench_path, 'sites', site, 'site_config.json')
|
|
if not os.path.exists(config_path):
|
|
return {}
|
|
with open(config_path) as f:
|
|
return json.load(f)
|
|
|
|
def put_site_config(site, config, bench_path='.'):
|
|
config_path = os.path.join(bench_path, 'sites', site, 'site_config.json')
|
|
with open(config_path, 'w') as f:
|
|
return json.dump(config, f, indent=1)
|
|
|
|
def update_site_config(site, new_config, bench_path='.'):
|
|
config = get_site_config(site, bench_path=bench_path)
|
|
config.update(new_config)
|
|
put_site_config(site, config, bench_path=bench_path)
|
|
|
|
def set_nginx_port(site, port, bench_path='.', gen_config=True):
|
|
set_site_config_nginx_property(site, {"nginx_port": port}, bench_path=bench_path, gen_config=gen_config)
|
|
|
|
def set_ssl_certificate(site, ssl_certificate, bench_path='.', gen_config=True):
|
|
set_site_config_nginx_property(site, {"ssl_certificate": ssl_certificate}, bench_path=bench_path, gen_config=gen_config)
|
|
|
|
def set_ssl_certificate_key(site, ssl_certificate_key, bench_path='.', gen_config=True):
|
|
set_site_config_nginx_property(site, {"ssl_certificate_key": ssl_certificate_key}, bench_path=bench_path, gen_config=gen_config)
|
|
|
|
def set_site_config_nginx_property(site, config, bench_path='.', gen_config=True):
|
|
from bench.config.nginx import make_nginx_conf
|
|
from bench.bench import Bench
|
|
|
|
if site not in Bench(bench_path).sites:
|
|
raise Exception("No such site")
|
|
update_site_config(site, config, bench_path=bench_path)
|
|
if gen_config:
|
|
make_nginx_conf(bench_path=bench_path)
|
|
|
|
def set_url_root(site, url_root, bench_path='.'):
|
|
update_site_config(site, {"host_name": url_root}, bench_path=bench_path)
|
|
|
|
def add_domain(site, domain, ssl_certificate, ssl_certificate_key, bench_path='.'):
|
|
domains = get_domains(site, bench_path)
|
|
for d in domains:
|
|
if (isinstance(d, dict) and d['domain']==domain) or d==domain:
|
|
print(f"Domain {domain} already exists")
|
|
return
|
|
|
|
if ssl_certificate_key and ssl_certificate:
|
|
domain = {
|
|
'domain' : domain,
|
|
'ssl_certificate': ssl_certificate,
|
|
'ssl_certificate_key': ssl_certificate_key
|
|
}
|
|
|
|
domains.append(domain)
|
|
update_site_config(site, { "domains": domains }, bench_path=bench_path)
|
|
|
|
def remove_domain(site, domain, bench_path='.'):
|
|
domains = get_domains(site, bench_path)
|
|
for i, d in enumerate(domains):
|
|
if (isinstance(d, dict) and d['domain']==domain) or d==domain:
|
|
domains.remove(d)
|
|
break
|
|
|
|
update_site_config(site, { 'domains': domains }, bench_path=bench_path)
|
|
|
|
def sync_domains(site, domains, bench_path='.'):
|
|
"""Checks if there is a change in domains. If yes, updates the domains list."""
|
|
changed = False
|
|
existing_domains = get_domains_dict(get_domains(site, bench_path))
|
|
new_domains = get_domains_dict(domains)
|
|
|
|
if set(existing_domains.keys()) != set(new_domains.keys()):
|
|
changed = True
|
|
|
|
else:
|
|
for d in list(existing_domains.values()):
|
|
if d != new_domains.get(d['domain']):
|
|
changed = True
|
|
break
|
|
|
|
if changed:
|
|
# replace existing domains with this one
|
|
update_site_config(site, { 'domains': domains }, bench_path='.')
|
|
|
|
return changed
|
|
|
|
def get_domains(site, bench_path='.'):
|
|
return get_site_config(site, bench_path=bench_path).get('domains') or []
|
|
|
|
def get_domains_dict(domains):
|
|
domains_dict = defaultdict(dict)
|
|
for d in domains:
|
|
if isinstance(d, str):
|
|
domains_dict[d] = { 'domain': d }
|
|
|
|
elif isinstance(d, dict):
|
|
domains_dict[d['domain']] = d
|
|
|
|
return domains_dict
|