This repository has been archived by the owner on Sep 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 58
/
LocalViewer.py
105 lines (101 loc) · 5.8 KB
/
LocalViewer.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
"""
:mod:`EdgarRenderer.LocalViewer`
~~~~~~~~~~~~~~~~~~~
Edgar(tm) Renderer was created by staff of the U.S. Securities and Exchange Commission.
Data and content created by government employees within the scope of their employment
are not subject to domestic copyright protection. 17 U.S.C. 105.
"""
from arelle.webserver.bottle import static_file, redirect
from arelle.LocalViewer import LocalViewer
import os, logging, sys
import regex as re
ixviewerDirFilesPattern = re.compile(r"^ix(-dev)?.x?html|^browser-error.html|^css/|^images/|^js/|^[a-z0-9.-]+min\.(js|css)(\.map)?$|^[a-z0-9]+\.(ttf|woff2)$")
webRootDirPattern = re.compile(r"^include$|^i[x-z]viewer")
wsRootDirPattern = re.compile(r"^(AR/)?(include|i[xy]viewer[^/]*)/(.*)$")
extMimeType = {
".xhtml": "application/xhtml+xml",
".html": "text/html",
".htm": "text/html",
".xml": "application/xml",
".js": "text/javascript",
".css": "text/css",
".gif": "image/gif",
".jpg": "image/jpeg",
".jpeg": "image/jpeg",
".bmp": "image/bmp",
".jpg": "image/jpeg",
".png": "image/png",
".svg": "image/svg+xml",
".tif": "image/tiff",
".tiff": "image/tiff",
".csv": "text/csv",
".txt": "text/plain",
".json": "application/json",
".woff": "font/woff",
".woff2": "font/woff2"
}
class _LocalViewer(LocalViewer):
# plugin-specific local file handler
def getLocalFile(self, file, relpath, request):
if file == 'favicon.ico':
return static_file("arelle.ico", root=self.cntlr.imagesDir, mimetype='image/vnd.microsoft.icon')
if file == "ix":
return static_file(file, root=self.reportsFolders[0])
_report, _sep, _file = file.partition("/")
if _report.startswith("DisplayDocument.do"):
_file = file
_report = str(len(self.reportsFolders) - 1)
if file == "---xbrl.zip" and "referer" in request.headers: # no report number, get from referer header
refererPathParts = request.headers["referer"].split("/")
if len(refererPathParts) >= 4 and refererPathParts[3].isnumeric():
_report = refererPathParts[3]
_file = file
mimeType = extMimeType.get(os.path.splitext(file or "")[1], None)
if webRootDirPattern.match(_report):
return static_file(_file, root=os.path.join(self.reportsFolders[0], _report), mimetype=mimeType)
if ixviewerDirFilesPattern.match(_file): # although in ixviewer, it refers relatively to ixviewer/
return static_file(_file, root=os.path.join(self.reportsFolders[0], 'ixviewer'), mimetype=mimeType)
if _file.startswith("/ixviewer"): # ops gateway
return static_file(_file, root=self.reportsFolders[0][:-1], mimetype=mimeType)
if _file.startswith("include/"): # really in ixviewer subtree (Workstation Images are in distribution include)
return static_file(_file[8:], root=os.path.join(self.reportsFolders[0], 'include'), mimetype=mimeType)
if _file.startswith("images/") or _file.startswith("Images/"): # really in ixviewer subtree (Workstation Images are in distribution include)
return static_file(_file[7:], root=os.path.join(self.reportsFolders[0], 'include'), mimetype=mimeType)
if _report == "images": # really in ixviewer subtree (Workstation Images are in distribution include)
return static_file(_file, root=os.path.join(self.reportsFolders[0], 'include'), mimetype=mimeType)
if wsRootDirPattern.match(_file): # really in ixviewer subtree
m = wsRootDirPattern.match(_file)
return static_file(m.group(3), root=os.path.join(self.reportsFolders[0], m.group(2)), mimetype=mimeType)
if _report.isnumeric(): # in reportsFolder folder
# is it an EDGAR workstation query parameter
if _file == "DisplayDocument.do":
if "filename" in request.query:
_file = request.query["filename"]
self.cntlr.addToLog(" ?filename={}".format(_file), messageCode="localViewer:get",level=logging.DEBUG)
else:
self.cntlr.addToLog(" ?" + ", ".join([f"{k}={v}" for k,v in request.query.items()]),level=logging.DEBUG)
elif _file == "ix":
return static_file(_file, root=self.reportsFolders[0])
# check if file is in the current or parent directory (may bve
_fileDir = self.reportsFolders[int(_report)]
_fileExists = False
if os.path.exists(os.path.join(_fileDir, _file)):
_fileExists = True
elif os.path.exists(os.path.join(os.path.dirname(_fileDir), _file)):
_fileDir = os.path.dirname(_fileDir)
_fileExists = True
elif file.endswith("---xbrl.zip"):
# default zip produced for accession but local zip may have no accession number
for f in os.listdir(_fileDir):
if f.endswith(".zip"):
redirect("/{}/{}".format(_report,f))
if not _fileExists:
queryParams = ", ".join([f"{k}={v}" for k,v in request.query.items()])
if queryParams:
queryParams = "?" + queryParams
self.cntlr.addToLog("http://localhost:{}/{}{}".format(self.port,file,queryParams), messageCode="localViewer:fileNotFound",level=logging.DEBUG)
return static_file(_file, root=_fileDir, headers=self.noCacheHeaders, mimetype=mimeType) # extra_headers modification to py-bottle
return static_file(file, root="/") # probably can't get here unless path is wrong
localViewer = _LocalViewer("SEC ix viewer", os.path.dirname(__file__)) # plugin singleton local viewer class
def init(cntlr, reportsFolder): # returns browser root
return localViewer.init(cntlr, reportsFolder)