Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/webcheck/plugins/size.py
blob: 7f6703c16ba487c3fdcefa6f46d0ad3d61298202 (plain)
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

# size.py - plugin that lists pages that could be slow to load
#
# Copyright (C) 1998, 1999 Albert Hopkins (marduk)
# Copyright (C) 2002 Mike W. Meyer
# Copyright (C) 2005, 2006, 2011, 2013 Arthur de Jong
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
#
# The files produced as output from the software do not automatically fall
# under the copyright of the software, unless explicitly stated otherwise.

"""Present a list of pages that are large and probably slow to download."""

__title__ = "what's big"
__author__ = 'Arthur de Jong'
__outputfile__ = 'size.html'

from webcheck import config
from webcheck.db import Session, Link
from webcheck.output import render


def get_size(link, seen=None):
    """Return the size of the link and all its embedded links, counting each
    link only once."""
    # make a new list
    if seen is None:
        seen = set()
    # add this link to the list
    seen.add(link)
    # if we don't known about our total size yet, calculate
    if not hasattr(link, 'total_size'):
        # add our size
        size = link.size or 0
        # add sizes of embedded objects
        for embed in link.embedded:
            if embed not in seen:
                size += get_size(embed, seen)
        link.total_size = size
    return link.total_size


def generate(crawler):
    """Output the list of large pages."""
    session = Session()
    links = session.query(Link).filter_by(is_page=True, is_internal=True)
    links = [x for x in links
             if get_size(x) >= config.REPORT_SLOW_URL_SIZE * 1024]
    links.sort(lambda a, b: cmp(b.total_size, a.total_size))
    render(__outputfile__, crawler=crawler, title=__title__,
           links=links)
    session.close()