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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
|
from __future__ import absolute_import
from __future__ import print_function
# #START_LICENSE###########################################################
#
#
# This file is part of the Environment for Tree Exploration program
# (ETE). http://etetoolkit.org
#
# ETE 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.
#
# ETE 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 ETE. If not, see <http://www.gnu.org/licenses/>.
#
#
# ABOUT THE ETE PACKAGE
# =====================
#
# ETE is distributed under the GPL copyleft license (2008-2015).
#
# If you make use of ETE in published work, please cite:
#
# Jaime Huerta-Cepas, Joaquin Dopazo and Toni Gabaldon.
# ETE: a python Environment for Tree Exploration. Jaime BMC
# Bioinformatics 2010,:24doi:10.1186/1471-2105-11-24
#
# Note that extra references to the specific methods implemented in
# the toolkit may be available in the documentation.
#
# More info at http://etetoolkit.org. Contact: huerta@embl.de
#
#
# #END_LICENSE#############################################################
import sys
import os
import time
import cgi
from hashlib import md5
import six.moves.cPickle
from six.moves import map
ALL = ["WebTreeApplication"]
class WebTreeApplication(object):
""" Provides a basic WSGI application object which can handle ETE
tree visualization and interactions. Please, see the
webplugin example provided with the ETE installation package
(http://pypi.python.org/pypi/ete3)."""
def __init__(self):
# Redirects normal output msgs to stderr, since stdout in web
# application is for the browser
sys.stdout = sys.stderr
self.TreeConstructor = None
self.NODE_TARGET_ACTIONS = ["node", "face"]
self.TREE_TARGET_ACTIONS = ["layout", "search"]
self.actions = []
self._layout = None
self._tree_style = None
self._width = None
self._height = None
self._size_units = "px"
self._custom_tree_renderer = None
self._treeid2layout = {}
self._external_app_handler = None
self._treeid2tree = {}
self._treeid2cache = {}
self._treeid2index = {}
self.queries = {}
self.CONFIG = {
"temp_dir":"/var/www/webplugin/",
"temp_url":"http://localhost/webplugin/tmp",
"DISPLAY" :":0" # Used by ete to render images
}
def set_tree_size(self, w, h, units="px"):
""" Fix the size of tree image """
self._width = w
self._height = h
self._size_units = units
def set_external_app_handler(self, handler):
""" Sets a custom function that will extend current WSGI
application."""
self._external_app_handler = handler
def set_external_tree_renderer(self, handler):
""" If the tree needs to be processed every time is going to
be drawn, the task can be delegated. """
self._custom_tree_renderer = handler
def register_action(self, name, target, handler, checker, html_generator):
""" Adds a new web interactive function associated to tree
nodes. """
self.actions.append([name, target, handler, checker, html_generator])
def set_tree_loader(self, TreeConstructor):
""" Delegate tree constructor. It allows to customize the Tree
class used to create new tree instances. """
self._tree = TreeConstructor
def set_default_layout_fn(self, layout_fn):
""" Fix the layout function used to render the tree. """
self._layout = layout_fn
def set_tree_style(self, handler):
""" Fix a :class:`TreeStyle` instance to render tree images. """
self._tree_style = handler
def _get_html_map(self, img_map, treeid, mapid, tree):
# Scans for node-enabled actions.
nid2actions = {}
nid2face_actions = {}
for n in tree.traverse():
for aindex, (action, target, handler, checker, html_generator) in enumerate(self.actions):
if target == "node" and (not checker or checker(n)):
nid2actions.setdefault(int(n._nid), []).append(aindex)
elif target == "face" and (not checker or checker(n)):
nid2face_actions.setdefault(int(n._nid), []).append(aindex)
html_map = '<MAP NAME="%s" class="ete_tree_img">' %(mapid)
if img_map["nodes"]:
for x1, y1, x2, y2, nodeid, text in img_map["nodes"]:
text = "" if not text else text
area = img_map["node_areas"].get(int(nodeid), [0,0,0,0])
html_map += """ <AREA SHAPE="rect" COORDS="%s,%s,%s,%s" onMouseOut='unhighlight_node();' onMouseOver='highlight_node("#%s", "%s", %s, %s, %s, %s);' onClick='show_context_menu("%s", "%s", "%s");' href="javascript:void('%s');">""" %\
(int(x1), int(y1), int(x2), int(y2),
treeid, text, area[0], area[1], area[2]-area[0], area[3]-area[1],
treeid, nodeid, ','.join(map(str, nid2actions.get(nodeid,[]))), str(nodeid) )
if img_map["faces"]:
for x1, y1, x2, y2, nodeid, text in img_map["faces"]:
text = "" if not text else text
area = img_map["node_areas"].get(int(nodeid), [0,0,0,0])
html_map += """ <AREA SHAPE="rect" COORDS="%s,%s,%s,%s" onMouseOut='unhighlight_node(); hide_face_popup();' onMouseOver='highlight_node("#%s", "%s", %s, %s, %s, %s); show_face_popup("%s", "%s", "%s", "%s");' onClick='show_context_menu("%s", "%s", "%s", "%s");' href="javascript:void('%s');">""" %\
(int(x1),int(y1),int(x2),int(y2),
treeid, text, area[0], area[1], area[2]-area[0], area[3]-area[1],
treeid, nodeid, ','.join(map(str, nid2actions.get(nodeid,[])+nid2face_actions.get(nodeid,[]) )), text,
treeid, nodeid, ','.join(map(str, nid2actions.get(nodeid,[])+nid2face_actions.get(nodeid,[]) )), text,
text,
)
html_map += '</MAP>'
return html_map
def _load_tree(self, treeid, tree=None, cache_file=None):
# if a tree is given, it overwrites previous versions
if tree and isinstance(tree, str):
tree = self._tree(tree)
self._treeid2tree[treeid] = tree
self._load_tree_index(treeid)
elif tree:
self._treeid2tree[treeid] = tree
self._load_tree_index(treeid)
self._treeid2cache[treeid] = cache_file if cache_file else "%s.pkl" %treeid
# if no tree is given, and not in memmory, it tries to loaded
# from previous sessions
if treeid not in self._treeid2tree:
self._load_tree_from_path(self._treeid2cache[treeid])
# Returns True if tree and indexes are loaded
return (treeid in self._treeid2tree) and (treeid in self._treeid2index)
def _load_tree_from_path(self, pkl_path):
tree_path = os.path.join(self.CONFIG["temp_dir"], pkl_path)
if os.path.exists(tree_path):
print(six.moves.cPickle.load(open(tree_path)))
t = self._treeid2tree[treeid] = six.moves.cPickle.load(open(tree_path))
self._load_tree_index(treeid)
return True
else:
return False
def _load_tree_index(self, treeid):
if not self._treeid2index.get(treeid, {}):
tree_index = self._treeid2index[treeid] = {}
t = self._treeid2tree[treeid]
for n in t.traverse():
if hasattr(n, "_nid"):
tree_index[str(n._nid)] = n
return True
else:
return False
def _dump_tree_to_file(self, t, treeid):
tree_path = os.path.join(self.CONFIG["temp_dir"], treeid+".pkl")
six.moves.cPickle.dump(t, open(tree_path, "wb"))
#open(tree_path, "w").write(t.write(features=[]))
def _get_tree_img(self, treeid, pre_drawing_action=None):
img_url = os.path.join(self.CONFIG["temp_url"], treeid+".png?"+str(time.time()))
img_path = os.path.join(self.CONFIG["temp_dir"], treeid+".png")
t = self._treeid2tree[treeid]
tree_index = self._treeid2index[treeid]
if pre_drawing_action:
atype, handler, arguments = pre_drawing_action
if atype in set(["node", "face"]) and len(arguments)==1 and handler:
nid = arguments[0]
node = tree_index.get(str(nid), None)
handler(node)
elif atype == "tree":
handler(t, arguments[0])
elif atype == "search":
handler(t, arguments[0])
elif atype == "layout":
self._treeid2layout[treeid] = handler
layout_fn = self._treeid2layout.get(treeid, self._layout)
mapid = "img_map_"+str(time.time())
img_map = _render_tree(t, img_path, self.CONFIG["DISPLAY"], layout = layout_fn,
tree_style = self._tree_style,
w=self._width,
h=self._height,
units=self._size_units)
html_map = self._get_html_map(img_map, treeid, mapid, t)
for n in t.traverse():
self._treeid2index[treeid][str(n._nid)]=n
if hasattr(n, "_QtItem_"):
n._QtItem_ = None
delattr(n, "_QtItem_")
tree_actions = []
for aindex, (action, target, handler, checker, html_generator) in enumerate(self.actions):
if target in self.TREE_TARGET_ACTIONS and (not checker or checker(t)):
tree_actions.append(aindex)
try:
version_tag = __version__
except NameError:
version_tag = "ete3"
self._dump_tree_to_file(t, treeid)
ete_publi = '<div style="margin:0px;padding:0px;text-align:left;"><a href="http://etetoolkit.org" style="font-size:7pt;" target="_blank" >%s</a></div>' %\
(version_tag)
img_html = """<img id="%s" class="ete_tree_img" src="%s" USEMAP="#%s" onLoad='javascript:bind_popup();' onclick='javascript:show_context_menu("%s", "", "%s");' >""" %\
(treeid, img_url, mapid, treeid, ','.join(map(str, tree_actions)))
tree_div_id = "ETE_tree_"+str(treeid)
return html_map+ '<div id="%s" >'%tree_div_id + img_html + ete_publi + "</div>"
# WSGI web application
def __call__(self, environ, start_response):
""" This function is executed when the application is called
by the WSGI apache module. It is, therefore, in charge of
answering web requests."""
path = environ['PATH_INFO'].split("/")
start_response('202 OK', [('content-type', 'text/plain')])
if environ['REQUEST_METHOD'].upper() == 'GET' and environ['QUERY_STRING']:
self.queries = cgi.parse_qs(environ['QUERY_STRING'])
elif environ['REQUEST_METHOD'].upper() == 'POST' and environ['wsgi.input']:
self.queries = cgi.parse_qs(environ['wsgi.input'].read())
else:
self.queries = {}
method = path[1]
treeid = self.queries.get("treeid", [None])[0]
nodeid = self.queries.get("nid", [None])[0]
textface = self.queries.get("textface", [None])[0]
actions = self.queries.get("show_actions", [None])[0]
tree = self.queries.get("tree", [None])[0]
search_term = self.queries.get("search_term", [None])[0]
aindex = self.queries.get("aindex", [None])[0]
if method == "draw":
# if not treeid is given, generate one
if not treeid:
treeid = md5(str(time.time())).hexdigest()
if not self._load_tree(treeid, tree):
return "draw: Cannot load the tree: %s" %treeid
if self._custom_tree_renderer:
t = self._treeid2tree[treeid]
return self._custom_tree_renderer(t, treeid, self)
elif t and treeid:
return self._get_tree_img(treeid=treeid)
else:
return "No tree to draw"
elif method == "get_menu":
if not self._load_tree(treeid):
return "get_menu: Cannot load the tree: %s" %treeid
if nodeid:
tree_index = self._treeid2index[treeid]
node = tree_index[nodeid]
else:
node = None
if textface:
header = str(textface).strip()
else:
header = "Menu"
html = """<div id="ete_popup_header"><span id="ete_popup_header_text">%s</span><div id="ete_close_popup" onClick='hide_popup();'></div></div><ul>""" %\
(header)
for i in map(int, actions.split(",")):
aname, target, handler, checker, html_generator = self.actions[i]
if html_generator:
html += html_generator(i, treeid, nodeid, textface, node)
else:
html += """<li><a href='javascript:void(0);' onClick='hide_popup(); run_action("%s", "%s", "%s");'> %s </a></li> """ %\
(treeid, nodeid, i, aname)
html += '</ul>'
return html
elif method == "action":
if not self._load_tree(treeid):
return "action: Cannot load the tree: %s" %treeid
if aindex is None:
# just refresh tree
return self._get_tree_img(treeid=treeid)
else:
aname, target, handler, checker, html_generator = self.actions[int(aindex)]
if target in set(["node", "face", "layout"]):
return self._get_tree_img(treeid=treeid, pre_drawing_action=[target, handler, [nodeid]])
elif target in set(["search"]):
return self._get_tree_img(treeid=treeid, pre_drawing_action=[target, handler, [search_term]])
elif target in set(["refresh"]):
return self._get_tree_img(treeid=treeid)
return "Bad guy"
elif self._external_app_handler:
return self._external_app_handler(environ, start_response, self.queries)
else:
return '\n'.join(map(str, list(environ.items()))) + str(self.queries) + '\t\n'.join(environ['wsgi.input'])
def _render_tree(t, img_path, display, layout=None, tree_style=None,
w=None, h=None, units="px"):
os.environ["DISPLAY"]=display
return t.render(img_path, layout = layout, tree_style=tree_style,
w=w, h=h, units=units)
|