-
Notifications
You must be signed in to change notification settings - Fork 513
/
Copy pathresources.py
832 lines (704 loc) · 34.1 KB
/
resources.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
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
"""
This module contains Splash twisted.web Resources (HTTP API endpoints
exposed to the user).
"""
import os
import gc
import time
import json
import resource
from typing import List
from twisted.internet.base import DelayedCall
from twisted.python.failure import Failure
from twisted.web.server import NOT_DONE_YET
from twisted.web.resource import Resource
from twisted.web.static import File
from twisted.internet import reactor, defer
from twisted.python import log
import splash
from splash.argument_cache import ArgumentCache
from splash.engines.webkit.render_scripts import (
HtmlRender,
PngRender,
JsonRender,
HarRender,
JpegRender,
)
from splash.engines.chromium.render_scripts import (
ChromiumRenderHtmlScript,
ChromiumRenderPngScript,
ChromiumRenderJpegScript,
)
from splash.lua import is_supported as lua_is_supported
from splash.utils import (
get_num_fds,
get_leaks,
BinaryCapsule,
SplashJSONEncoder,
get_ru_maxrss,
to_bytes)
from splash import sentry
from splash.render_options import RenderOptions
from splash.qtutils import clear_caches
from splash.errors import (
BadOption, RenderError, InternalError,
GlobalTimeoutError, UnsupportedContentType,
ExpiredArguments,
CancelledError)
if lua_is_supported():
from splash.qtrender_lua import LuaRender
else:
LuaRender = None
class _ValidatingResource(Resource):
def render(self, request):
try:
return Resource.render(self, request)
except BadOption as e:
self._write_error(request, 400, e)
self._log_stats(request, {}, error=self._format_error(400, e))
return b"\n"
def _write_error_content(self, request, code, err,
content_type=b'text/plain'):
request.setHeader(b"content-type", content_type)
request.setResponseCode(code)
content = json.dumps(err).encode('utf8')
request.write(content)
return err
def _write_error(self, request, code, exc):
"""Can be overridden by subclasses format errors differently"""
err = self._format_error(code, exc)
return self._write_error_content(request, code, err,
content_type=b"application/json")
def _format_error(self, code, exc):
err = {
"error": code,
"type": exc.__class__.__name__,
"description": (exc.__doc__ or '').strip(),
"info": None,
}
if len(exc.args) == 1:
err['info'] = exc.args[0]
elif len(exc.args) > 1:
err['info'] = exc.args
return err
class BaseRenderResource(_ValidatingResource):
isLeaf = True
content_type = "text/html; charset=utf-8"
def __init__(self, pool, max_timeout, argument_cache,
browser_engines_enabled, dont_log_args):
Resource.__init__(self)
self.pool = pool
self.js_profiles_path = self.pool.js_profiles_path
self.max_timeout = max_timeout
self.argument_cache = argument_cache
self.browser_engines_enabled = browser_engines_enabled
self.dont_log_args = set(dont_log_args)
def render_GET(self, request):
#log.msg("%s %s %s %s" % (id(request), request.method, request.path, request.args))
request.starttime = time.time()
render_options = RenderOptions.fromrequest(request, self.max_timeout)
# process argument cache
original_options = render_options.data.copy()
expired_args = render_options.get_expired_args(self.argument_cache)
if expired_args:
error = self._write_expired_args(request, expired_args)
self._log_stats(request, original_options, error)
return b"\n"
saved_args = render_options.save_args_to_cache(self.argument_cache)
if saved_args:
value = ';'.join("{}={}".format(name, value)
for name, value in saved_args)
request.setHeader(b'X-Splash-Saved-Arguments', value.encode('utf8'))
render_options.load_cached_args(self.argument_cache)
# check arguments before starting the render
render_options.get_filters(self.pool)
render_options.get_engine(browser_engines_enabled=self.browser_engines_enabled)
timeout = render_options.get_timeout()
pool_d = self._get_render(request, render_options)
timer = reactor.callLater(timeout, pool_d.cancel)
request.notifyFinish().addErrback(self._request_failed, pool_d, timer)
pool_d.addCallback(self._cancel_timer, timer)
pool_d.addCallback(self._write_output, request)
pool_d.addErrback(self._on_timeout_error, request,
timeout=timeout, timer=timer)
pool_d.addErrback(self._on_render_error, request)
pool_d.addErrback(self._on_bad_request, request)
pool_d.addErrback(self._on_internal_error, request)
pool_d.addErrback(self._on_unhandled_internal_error, request)
pool_d.addBoth(self._finish_request, request,
options=original_options)
return NOT_DONE_YET
def render_POST(self, request):
request_content_type = request.getHeader(b'content-type').decode('latin1')
supported_types = ['application/javascript', 'application/json']
if not any(ct in request_content_type for ct in supported_types):
ex = UnsupportedContentType({
'supported': supported_types,
'received': request_content_type,
})
return self._write_error(request, 415, ex)
return self.render_GET(request)
def _cancel_timer(self, _, timer):
#log.msg("_cancelTimer")
timer.cancel()
return _
def _request_failed(self, _, pool_d, timer):
log.msg("Client disconnected: %s" % _.value)
timer.cancel()
pool_d.cancel()
def _write_output(self, data, request, content_type=None):
# log.msg("_writeOutput: %s" % id(request))
# log.msg("%r %r" % (data, content_type))
if content_type is None:
content_type = self.content_type
if isinstance(data, (dict, list)):
data = json.dumps(data, cls=SplashJSONEncoder)
return self._write_output(data, request, b"application/json")
if isinstance(data, tuple) and len(data) == 4:
data, content_type, headers, status_code = data
request.setResponseCode(status_code)
for name, value in headers:
request.setHeader(name, value)
return self._write_output(data, request, content_type)
if data is None or isinstance(data, (bool, int, float)):
return self._write_output(str(data), request, content_type)
if isinstance(data, BinaryCapsule):
return self._write_output(data.data, request, data.content_type)
if not isinstance(data, bytes):
data = data.encode('utf8')
if not isinstance(content_type, bytes):
content_type = content_type.encode('latin1')
request.setHeader(b"content-type", content_type)
if not isinstance(data, bytes):
# Twisted expects bytes as response
data = data.encode('utf-8')
request.write(data)
def _write_expired_args(self, request, expired_args):
ex = ExpiredArguments({'expired': expired_args})
return self._write_error(request, 498, ex)
def _value_for_logging(self, key, value):
if key not in self.dont_log_args:
return value
return "***"
def _log_stats(self, request, options, error=None):
options = {
key: self._value_for_logging(key, value)
for key, value in options.items()
}
msg = {
# Anything we retrieve from Twisted request object contains bytes.
# We have to convert it to unicode first for json.dump to succeed.
"path": request.path.decode('utf-8'),
"rendertime": time.time() - request.starttime,
"maxrss": resource.getrusage(resource.RUSAGE_SELF).ru_maxrss,
"load": os.getloadavg(),
"fds": get_num_fds(),
"active": len(self.pool.active),
"qsize": len(self.pool.queue.pending),
"_id": id(request),
"method": request.method.decode('ascii'),
"timestamp": int(time.time()),
"user-agent": (request.getHeader(b"user-agent").decode('utf-8')
if request.getHeader(b"user-agent") else None),
"args": options,
"status_code": request.code,
"client_ip": request.client.host
}
if error:
msg["error"] = error
msg = json.dumps(msg).encode("utf8")
log.msg(msg, system="events")
def _on_timeout_error(self, failure, request, timeout: float = None,
timer: DelayedCall = None):
failure.trap(defer.CancelledError)
msg = {}
if timer is not None:
msg['remaining'] = timer.time - timer.seconds()
if timer is not None and timer.cancelled:
ex = CancelledError(msg)
return self._write_error(request, 520, ex)
msg['timeout'] = timeout
ex = GlobalTimeoutError(msg)
return self._write_error(request, 504, ex)
def _on_render_error(self, failure, request):
failure.trap(RenderError)
# log.msg("_on_render_error: %s" % id(request))
return self._write_error(request, 502, failure.value)
def _on_internal_error(self, failure, request):
failure.trap(InternalError)
failure.printTraceback()
return self._write_error(request, 502, failure.value)
def _on_unhandled_internal_error(self, failure, request):
# failure.printTraceback()
sentry.capture(failure)
# only propagate str value to avoid exposing internal details
ex = InternalError(str(failure.value))
return self._write_error(request, 500, ex)
def _on_bad_request(self, failure, request):
failure.trap(BadOption)
# log.msg("_on_bad_request: %s" % id(request))
return self._write_error(request, 400, failure.value)
def _finish_request(self, failure, request, options):
if isinstance(failure, Failure):
# usually failure should be None or dict,
# but if _on_internal_error fails (?),
# we may get a Failure instance here
error = self._format_error(0, failure.value)
else:
error = failure
self._log_stats(request, options, error=error)
if not request._disconnected:
request.finish()
# log.msg("_finishRequest: %s" % id(request))
def _get_render(self, request, options):
raise NotImplementedError()
class RenderHtmlResource(BaseRenderResource):
content_type = "text/html; charset=utf-8"
def _get_render(self, request, options):
params = options.get_common_params(self.js_profiles_path)
engine = options.get_engine(self.browser_engines_enabled)
script = HtmlRender if engine == "webkit" else ChromiumRenderHtmlScript
return self.pool.render(script, options, **params)
class ExecuteLuaScriptResource(BaseRenderResource):
content_type = "text/plain; charset=utf-8"
def __init__(self, pool, sandboxed,
lua_package_path,
lua_sandbox_allowed_modules,
max_timeout,
argument_cache,
strict,
implicit_main,
browser_engines_enabled,
dont_log_args,
):
super().__init__(pool=pool,
max_timeout=max_timeout,
argument_cache=argument_cache,
browser_engines_enabled=browser_engines_enabled,
dont_log_args=dont_log_args)
self.sandboxed = sandboxed
self.lua_package_path = lua_package_path
self.lua_sandbox_allowed_modules = lua_sandbox_allowed_modules
self.strict = strict
self.implicit_main = implicit_main
def _get_render(self, request, options):
engine = options.get_engine(self.browser_engines_enabled)
if engine != 'webkit':
raise BadOption("engine=chromium is not supported yet")
params = dict(
proxy=options.get_proxy(),
lua_source=options.get_lua_source(),
sandboxed=self.sandboxed,
lua_package_path=self.lua_package_path,
lua_sandbox_allowed_modules=self.lua_sandbox_allowed_modules,
strict=self.strict,
implicit_main=self.implicit_main,
)
return self.pool.render(LuaRender, options, **params)
class RenderPngResource(BaseRenderResource):
content_type = "image/png"
def _get_render(self, request, options):
params = options.get_common_params(self.js_profiles_path)
params.update(options.get_png_params())
engine = options.get_engine(self.browser_engines_enabled)
script = PngRender if engine == "webkit" else ChromiumRenderPngScript
return self.pool.render(script, options, **params)
class RenderJpegResource(BaseRenderResource):
content_type = "image/jpeg"
def _get_render(self, request, options):
params = options.get_common_params(self.js_profiles_path)
params.update(options.get_jpeg_params())
engine = options.get_engine(self.browser_engines_enabled)
script = JpegRender if engine == "webkit" else ChromiumRenderJpegScript
return self.pool.render(script, options, **params)
class RenderJsonResource(BaseRenderResource):
content_type = "application/json"
def _get_render(self, request, options):
engine = options.get_engine(self.browser_engines_enabled)
if engine != 'webkit':
raise BadOption("engine=chromium is not supported yet")
params = options.get_common_params(self.js_profiles_path)
params.update(options.get_jpeg_params())
params.update(options.get_include_params())
params['request_body'] = options.get_request_body()
params['response_body'] = options.get_response_body()
return self.pool.render(JsonRender, options, **params)
class RenderHarResource(BaseRenderResource):
content_type = "application/json"
def _get_render(self, request, options):
engine = options.get_engine(self.browser_engines_enabled)
if engine != 'webkit':
raise BadOption("engine=chromium is not supported yet")
params = options.get_common_params(self.js_profiles_path)
params['request_body'] = options.get_request_body()
params['response_body'] = options.get_response_body()
return self.pool.render(HarRender, options, **params)
class DebugResource(Resource):
isLeaf = True
def __init__(self, pool, argument_cache, warn=False):
Resource.__init__(self)
self.argument_cache = argument_cache
self.pool = pool
self.warn = warn
def render_GET(self, request):
request.setHeader(b"content-type", b"application/json")
info = {
"leaks": get_leaks(),
"active": [self.get_repr(r) for r in self.pool.active],
"qsize": len(self.pool.queue.pending),
"maxrss": resource.getrusage(resource.RUSAGE_SELF).ru_maxrss,
"fds": get_num_fds(),
"argcache": len(self.argument_cache)
}
if self.warn:
info['WARNING'] = "/debug endpoint is deprecated. " \
"Please use /_debug instead."
return (json.dumps(info, sort_keys=True)).encode('utf-8')
def get_repr(self, render):
if hasattr(render, 'url'):
return render.url
return render.tab.url
class ClearCachesResource(Resource):
isLeaf = True
content_type = "application/json"
def __init__(self, argument_cache):
Resource.__init__(self)
self.argument_cache = argument_cache
def render_POST(self, request):
argcache_size = len(self.argument_cache)
self.argument_cache.clear()
clear_caches()
unreachable = gc.collect()
return json.dumps({
"status": "ok",
"pyobjects_collected": unreachable,
"cached_args_removed": argcache_size,
}, sort_keys=True).encode('utf-8')
class PingResource(Resource):
isLeaf = True
def render_GET(self, request):
request.setHeader(b"content-type", b"application/json")
return (json.dumps({
"status": "ok",
"maxrss": get_ru_maxrss(),
}, sort_keys=True)).encode('utf-8')
HARVIEWER_PATH = 'harviewer-2.0.17a' # Change to invalidate cache when updating harviewer
BOOTSTRAP_THEME = 'simplex'
CODEMIRROR_RESOURCES = """
<link href="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/codemirror.min.css" rel="stylesheet">
<link href="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/theme/mbo.min.css" rel="stylesheet">
<link href="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/addon/hint/show-hint.css" rel="stylesheet">
<script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/codemirror.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/mode/lua/lua.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/addon/hint/show-hint.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/addon/hint/anyword-hint.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/addon/edit/matchbrackets.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/5.10.0/addon/edit/closebrackets.min.js"></script>
"""
def safe_json(obj):
""" Encode JSON so that it can be embedded safely inside HTML"""
return json.dumps(obj).replace('<', '\\u003c')
class DemoUI(_ValidatingResource):
isLeaf = True
content_type = "text/html; charset=utf-8"
PATH = b'info'
def __init__(self, pool, lua_enabled, max_timeout):
Resource.__init__(self)
self.pool = pool
self.lua_enabled = lua_enabled
self.max_timeout = max_timeout
def _validate_params(self, request):
options = RenderOptions.fromrequest(request, self.max_timeout)
options.get_filters(self.pool) # check
params = options.get_common_params(self.pool.js_profiles_path)
params.update({
'save_args': options.get_save_args(),
'load_args': options.get_load_args(),
'timeout': options.get_timeout(),
'request_body': options.get_request_body(),
'response_body': options.get_response_body(),
'engine': options.get_engine(),
'har': 1,
'png': 1,
'html': 1,
})
filters = options.get('filters', default='')
if filters:
params['filters'] = filters
if self.lua_enabled:
params.update({
'lua_source': options.get_lua_source(),
})
return params
def render_GET(self, request):
params = self._validate_params(request)
url = params.get('url', '').strip()
if url and not url.lower().startswith('http'):
url = 'http://' + url
params['url'] = url
timeout = params['timeout']
params = {k: v for k, v in params.items() if v is not None}
# disable "phases" HAR Viewer feature
request.addCookie('phaseInterval', '120000')
return ("""<!DOCTYPE html><html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Splash %(version)s | %(url)s</title>
<link rel="stylesheet" href="_ui/%(harviewer_path)s/css/harViewer.css" type="text/css"/>
<link href="//maxcdn.bootstrapcdn.com/bootswatch/3.2.0/%(theme)s/bootstrap.min.css" rel="stylesheet">
<link rel="icon" type="image/x-icon" href="/_ui/favicon.ico">
<script src="//code.jquery.com/jquery-1.11.1.min.js"></script>
<script src="//code.jquery.com/jquery-migrate-1.2.1.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
%(cm_resources)s
<link rel="stylesheet" href="/_ui/style.css">
</head>
<body class="harBody no-lua" style="color:#000">
<div class="container"> <!-- style="margin: 0 auto; width: 95%%;"-->
<div class="navbar navbar-default">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-responsive-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">Splash v%(version)s</a>
</div>
<div class="navbar-collapse collapse navbar-responsive-collapse">
<ul class="nav navbar-nav">
<li><a href="http://splash.readthedocs.org">Documentation</a></li>
<li><a href="https://github.com/scrapinghub/splash">Source Code</a></li>
</ul>
<form class="navbar-form navbar-right" method="GET" action="/info">
<input type="hidden" name="wait" value="0.5">
<input type="hidden" name="images" value="1">
<input type="hidden" name="expand" value="1"> <!-- for HAR viewer -->
<input type="hidden" name="timeout" value="%(timeout)s">
<div class="btn-group" id="render-form">
<input class="form-control col-lg-8" type="text" placeholder="Paste an URL" type="text" name="url" value="%(url)s">
<a href="#" class="btn btn-default dropdown-toggle if-lua" data-toggle="dropdown">Script <b class="caret"></b></a>
<div class="dropdown-menu panel panel-default if-lua" id="lua-code-editor-panel">
<div class="panel-body2">
<textarea id="lua-code-editor" name='lua_source'></textarea>
</div>
</div>
</div>
<button class="btn btn-success" type="submit">Render!</button>
</form>
<ul class="nav navbar-nav navbar-right">
<li><a id="status">Initializing...</a></li>
</ul>
</div>
</div>
<div id="result" style="display: none;">
<span class="key">Splash Response</span><span class="colon">:</span>
<span class="obj-item"></span>
</div>
<div id="errorMessage" style="display:none">
<h4>HTTP Error <span id='errorStatus'></span></h4>
<h4>Type: <span id='errorType'></span></h4>
<p id='errorDescription' class="errorMessage"></p>
<p id='errorMessageText' class="errorMessage"></p>
<pre id='errorData'></pre>
</div>
</div>
<script> var splash = %(options)s; </script>
<script src="/_ui/main.js"> </script>
</body>
</html>
""" % dict(
version=splash.__version__,
harviewer_path=HARVIEWER_PATH,
options=safe_json({
"params": params,
"endpoint": "execute" if self.lua_enabled else "render.json",
"harviewer_path": HARVIEWER_PATH,
"lua_enabled": self.lua_enabled,
}),
timeout=timeout,
url=url,
theme=BOOTSTRAP_THEME,
cm_resources=CODEMIRROR_RESOURCES if self.lua_enabled else "",
)).encode('utf-8')
class Root(Resource):
def __init__(self, pool, ui_enabled, lua_enabled, lua_sandbox_enabled,
lua_package_path,
lua_sandbox_allowed_modules,
max_timeout,
argument_cache_max_entries,
strict_lua_runner,
browser_engines_enabled: List[str],
dont_log_args,
):
Resource.__init__(self)
self.argument_cache = ArgumentCache(argument_cache_max_entries)
self.ui_enabled = ui_enabled
self.lua_enabled = lua_enabled
self.browser_engines_enabled = browser_engines_enabled
self.max_timeout = max_timeout
self.dont_log_args = dont_log_args
_kwargs = dict(
pool=pool,
max_timeout=max_timeout,
argument_cache=self.argument_cache,
browser_engines_enabled=browser_engines_enabled,
dont_log_args=self.dont_log_args,
)
self.putChild(b"render.html", RenderHtmlResource(**_kwargs))
self.putChild(b"render.png", RenderPngResource(**_kwargs))
self.putChild(b"render.jpeg", RenderJpegResource(**_kwargs))
self.putChild(b"render.json", RenderJsonResource(**_kwargs))
self.putChild(b"render.har", RenderHarResource(**_kwargs))
self.putChild(b"_debug", DebugResource(pool, self.argument_cache))
self.putChild(b"_gc", ClearCachesResource(self.argument_cache))
self.putChild(b"_ping", PingResource())
# backwards compatibility
self.putChild(b"debug", DebugResource(pool, self.argument_cache,
warn=True))
if self.lua_enabled and ExecuteLuaScriptResource is not None:
lua_kwargs = dict(
sandboxed=lua_sandbox_enabled,
lua_package_path=lua_package_path,
lua_sandbox_allowed_modules=lua_sandbox_allowed_modules,
strict=strict_lua_runner,
**_kwargs,
)
self.putChild(b"execute", ExecuteLuaScriptResource(
implicit_main=False, **lua_kwargs))
self.putChild(b"run", ExecuteLuaScriptResource(
implicit_main=True, **lua_kwargs))
if self.ui_enabled:
root = os.path.dirname(__file__)
ui = File(os.path.join(root, 'ui'))
har_path = os.path.join(root, 'vendor', 'harviewer', 'webapp')
ui.putChild(to_bytes(HARVIEWER_PATH), File(har_path))
inspections_path = os.path.join(root, 'kernel', 'inspections')
ui.putChild(b"inspections", File(inspections_path))
examples_path = os.path.join(root, 'examples')
ui.putChild(b"examples", File(examples_path))
self.putChild(b"_ui", ui)
self.putChild(DemoUI.PATH, DemoUI(
pool=pool,
lua_enabled=self.lua_enabled,
max_timeout=max_timeout
))
def getChild(self, name, request):
if name == b"" and self.ui_enabled:
return self
return Resource.getChild(self, name, request)
def get_example_script(self):
return """
function main(splash, args)
assert(splash:go(args.url))
assert(splash:wait(0.5))
return {
html = splash:html(),
png = splash:png(),
har = splash:har(),
}
end
""".strip()
def render_GET(self, request):
""" Index page """
result = """<!DOCTYPE html><html>
<head>
<title>Splash %(version)s</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="//maxcdn.bootstrapcdn.com/bootswatch/3.2.0/%(theme)s/bootstrap.min.css" rel="stylesheet">
<link rel="stylesheet" href="/_ui/style.css">
<link rel="icon" type="image/x-icon" href="/_ui/favicon.ico">
<script src="//code.jquery.com/jquery-1.11.1.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
%(cm_resources)s
</head>
<body class="no-lua">
<div class="container">
<div class="page-header">
<h1>Splash v%(version)s</h1>
</div>
<div class="row">
<div class="col-lg-6">
<p class="lead">
Splash is a javascript rendering service.
It's a lightweight browser with an HTTP API,
implemented in Python using Twisted and QT.
</p>
<ul>
<li>Process multiple webpages in parallel</li>
<li>Get HTML results and/or take screenshots</li>
<li>Turn OFF images <a class="demo-link if-lua" href="#" onclick="splash.loadExample('disable-images', 'http://flickr.com')">Run live example</a> or use <a href="https://adblockplus.org">Adblock Plus</a>
rules to make rendering faster</li>
<li>Execute custom JavaScript in page context <a class="demo-link if-lua" href="#" onclick="splash.loadExample('run-js')">Run live example</a></li>
<li>Write Lua browsing scripts;</li>
<li>Get detailed rendering info in <a href="http://www.softwareishard.com/blog/har-12-spec/">HAR</a> format <a class="demo-link if-lua" href="#" onclick="splash.loadExample('har')">Run live example</a></li>
</ul>
<p class="lead">
Splash is free & open source.
Commercial support is also available by
<a href="http://scrapinghub.com/">Scrapinghub</a>.
</p>
<div>
<a class="btn btn-info" href="http://splash.readthedocs.org/">Documentation</a>
<div class="dropdown examples-dropdown">
<a class="btn btn-info if-lua dropdown-toggle" data-toggle="dropdown" href="#">Examples <b class="caret"></b></a>
<ul class="dropdown-menu panel panel-default if-lua">
<li><a href="#" onclick="splash.loadExample('render-multiple', '')">Take screenshots of multiple pages</a></li>
<li><a href="#" onclick="splash.loadExample('wait-for-element')">Wait for element</a></li>
<li><a href="#" onclick="splash.loadExample('scroll', 'http://scrapinghub.com')">Scroll page</a></li>
<li><a href="#" onclick="splash.loadExample('preload-jquery')">Preload jQuery</a></li>
<li><a href="#" onclick="splash.loadExample('preload-functions')">Preload functions</a></li>
<li><a href="#" onclick="splash.loadExample('multiple-pages', '')">Load multiple pages</a></li>
<li><a href="#" onclick="splash.loadExample('count-divs')">Count DIV tags</a></li>
<li><a href="#" onclick="splash.loadExample('call-later')">Call Later</a></li>
<li><a href="#" onclick="splash.loadExample('render-png')">Render PNG</a></li>
<li><a href="#" onclick="splash.loadExample('element-screenshot')">Take a screenshot of a single element</a></li>
<li><a href="#" onclick="splash.loadExample('log-requests')">Log requested URLs</a></li>
<li><a href="#" onclick="splash.loadExample('block-css')">Block CSS</a></li>
<li><a href="#" onclick="splash.loadExample('with-timeout')">Execute function with timeout</a></li>
<li><a href="#" onclick="splash.loadExample('submit-search')">Submit a search input</a></li>
</ul>
</div>
<a class="btn btn-info" href="https://github.com/scrapinghub/splash">Source code</a>
</div>
</div>
<div class="col-lg-6">
<form class="form-horizontal" method="GET" action="/info">
<input type="hidden" name="wait" value="0.5">
<input type="hidden" name="images" value="1">
<input type="hidden" name="expand" value="1"> <!-- for HAR viewer -->
<input type="hidden" name="timeout" value="%(timeout)s">
<fieldset>
<div class="">
<div class="input-group col-lg-10">
<input class="form-control" type="text" placeholder="Paste an URL" value="http://google.com" name="url">
<span class="input-group-btn">
<button class="btn btn-success" type="submit">Render me!</button>
</span>
</div>
<div class="input-group col-lg-10 if-lua">
<textarea id='lua-code-editor' name='lua_source'></textarea>
</div>
</div>
</fieldset>
</form>
</div>
</div>
</div>
<div class="tooltip top" role="tooltip" id="example-tooltip">
<div class="tooltip-arrow"></div>
<div class="tooltip-inner">
<script> var splash = %(options)s; </script>
<script src="/_ui/main.js"> </script>
</body>
</html>""" % dict(
version=splash.__version__,
theme=BOOTSTRAP_THEME,
options=safe_json({
"endpoint": "execute" if self.lua_enabled else "render.json",
"lua_enabled": self.lua_enabled,
"example_script": self.get_example_script(),
}),
cm_resources=CODEMIRROR_RESOURCES,
timeout=self.max_timeout,
)
return result.encode('utf8')