summaryrefslogtreecommitdiff
path: root/photoblaster/param/img_url.py
blob: 2e28571ee9d9002a4f1a5a397c2cc6f5b1184f49 (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
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
"""Img_url param class definition lives here"""
from photoblaster.param import Param, FileTooBigError
from photoblaster.config import MAX_SIZE, SPECIAL_DOWNLOADERS,\
    SPECIAL_DOWNLOADERS_MAX_SIZE,\
    BIN_IDENTIFY
from photoblaster._file import File
import urllib2
from subprocess import Popen, PIPE


class Img_url(Param):
    def __init__(self, value, key="", classname="", module=None, username=""):
        """Defines the float param type.
           Takes in a url, sends a get request to the url, writes the response
           to a temporary filename, and checks the mimetype with imagemagick.
           Img_url class is different from other params in that it has
           the attributes:
               url: the original url used to retrieve the image
               filename: the filename created to store the image
               filepath: complete path to the stored image file
               mimetype: the mimetype of the image
       Args:
           value: the image url string
           key: the intended name of the param instance
           classname: the name of the class to which the param belongs
        """
        super(Img_url, self).__init__(classname=classname)
        self.set_username(username)
        print('got username {}'.format(self.username))
        if value:
            self._file = File(
               namepart=key,
               classname=classname,
               extension="",
               is_temp=True
            )
            self._image_download(value)
            self.mimetype = self._image_mimetype(self._file.get_filepath())
            self._file.set_filepath(
                "%s.%s" % (self._file.get_filepath(), self.mimetype),
                module=module
            )
            self.url = value

    def __dict__(self):
        return {
            'filename': self.get_file().get_filename(),
            'path': self.get_file().get_filepath(),
            'url': self.url,
            'mimetype': self.mimetype
        }

    def __getitem__(self, item):
        return self.__dict__().__getitem__(item)

    def __str__(self):
        return str(self.__dict__())

    def __nonzero__(self):
        return True if self.get_file() and self.mimetype else False

    def _image_download(self, url):
        """downloads the image to the path specified in the local
        filesystem"""
        max_size = MAX_SIZE
        if self.username in SPECIAL_DOWNLOADERS:
            max_size = SPECIAL_DOWNLOADERS_MAX_SIZE
        self._download(
            url, self.get_file().get_filepath(), max_size=max_size)

    def _browser_request(self, url, data=None):
        """sends a get request to the url using browser User-Agent headers"""
        headers = {
            'User-Agent': 'Mozilla/4.0 (compatible; MSIE 5.5; Windows NT)',
            'Accept': '*/*',
        }
        req = urllib2.Request(url, data, headers)
        response = urllib2.urlopen(req)
        return response

    def _download(self, url, destination, max_size=MAX_SIZE):
        """generic download method, checks the size of the filedata"""
        response = self._browser_request(url, None)

        rawimg = response.read()
        if len(rawimg) == 0:
            self.err_warn("got zero-length file")
        if len(rawimg) > max_size:
            raise FileTooBigError(
                "file too big: max size {} KB / {} is {} KB".format(
                    str(max_size/1024),
                    url,
                    str(len(rawimg)/1024)
                )
            )
        f = open(destination, "w")
        f.write(rawimg)
        f.close()

    def _image_mimetype(self, f):
        """
        retrieves the image mimetype from the file header using imagemagick
        """
        mimetype = Popen(
            [BIN_IDENTIFY, f], stdout=PIPE
        ).communicate()[0].split(" ")[1].lower()
        return mimetype

    def get_file(self):
        return self._file

    def set_file(self, _file):
        if not isinstance(_file, File):
            raise TypeError(
                "%s is not type %s" % (type(_file), File.__class__.__name__))
        self._file = _file