forked from opnsense/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcollect_api_endpoints.py
executable file
·129 lines (115 loc) · 5.55 KB
/
collect_api_endpoints.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
#!/usr/local/bin/python
"""
Copyright (c) 2020 Ad Schellevis <[email protected]>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
"""
import os
import argparse
import re
from jinja2 import Template
EXCLUDE_CONTROLLERS = ['Core/Api/FirmwareController.php']
def parse_api_php(src_filename):
base_filename = os.path.basename(src_filename)
controller = re.sub('(?<!^)(?=[A-Z])', '_', os.path.basename(base_filename.split('Controller.php')[0])).lower()
module_name = src_filename.replace('\\', '/').split('/')[-3].lower()
data = open(src_filename).read()
function_callouts = re.findall(r"(\n\s+(private|public|protected)\s+function\s+(\w+)\((.*)\))", data)
result = list()
for idx, function in enumerate(function_callouts):
begin_marker = data.find(function_callouts[idx][0])
if idx+1 < len(function_callouts):
end_marker = data.find(function_callouts[idx+1][0])
else:
end_marker = -1
code_block = data[begin_marker+len(function[0]):end_marker]
if function[2].endswith('Action'):
record = {
'method': 'GET',
'module': module_name,
'controller': controller,
'command': function[2][:-6],
'parameters': function[3].replace(' ', ''),
'type': 'Service' if controller.find('service') > -1 else 'Resources',
'filename': base_filename
}
# find most likely method (default => GET)
if code_block.find('request->isPost(') > -1:
record['method'] = 'POST'
elif code_block.find('$this->delBase') > -1:
record['method'] = 'POST'
elif code_block.find('$this->addBase') > -1:
record['method'] = 'POST'
elif code_block.find('$this->setBase') > -1:
record['method'] = 'POST'
elif code_block.find('$this->toggleBase') > -1:
record['method'] = 'POST'
elif code_block.find('$this->searchBase') > -1:
record['method'] = '*'
result.append(record)
return sorted(result, key=lambda i: i['command'])
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('source', help='source directory')
parser.add_argument('--repo', help='target repository', default="core")
cmd_args = parser.parse_args()
# collect all endpoints
all_modules = dict()
for root, dirs, files in os.walk(cmd_args.source):
for fname in sorted(files):
filename = os.path.join(root, fname)
skip = False
for to_exclude in EXCLUDE_CONTROLLERS:
if filename.endswith(to_exclude):
skip = True
break
if not skip and filename.lower().endswith('controller.php') and filename.find('mvc/app/controllers') > -1 \
and root.endswith('Api'):
payload = parse_api_php(filename)
if len(payload) > 0:
if payload[0]['module'] not in all_modules:
all_modules[payload[0]['module']] = list()
all_modules[payload[0]['module']].append(payload)
# writeout .rst files
for module_name in all_modules:
target_filename = "%s/source/development/api/%s/%s.rst" % (
os.path.dirname(__file__), cmd_args.repo, module_name
)
print("update %s" % target_filename)
template_data = {
'title': "%s" % module_name.title(),
'title_underline': "".join('~' for x in range(len(module_name))),
'controllers': []
}
for controller in all_modules[module_name]:
payload = {
'type': controller[0]['type'],
'filename': controller[0]['filename'],
'endpoints': []
}
for endpoint in controller:
payload['endpoints'].append(endpoint)
template_data['controllers'].append(payload)
with open(target_filename, 'w') as f_out:
if os.path.isfile("%s.in" % target_filename):
template_filename = "%s.in" % target_filename
else:
template_filename = "collect_api_endpoints.in"
template = Template(open(template_filename, "r").read())
f_out.write(template.render(template_data))