move validation outside librarian
[librarian.git] / librarian / formats / cover / __init__.py
1 # -*- coding: utf-8 -*-
2 #
3 # This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
4 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
5 #
6 import re
7 from PIL import Image, ImageFont, ImageDraw, ImageFilter
8 from StringIO import StringIO
9 from librarian import DCNS, BuildError
10 from librarian.output import OutputFile
11 from librarian.utils import get_resource
12 from librarian.formats import Format
13
14
15 class Metric(object):
16     """Gets metrics from an object, scaling it by a factor."""
17     def __init__(self, obj, scale):
18         self._obj = obj
19         self._scale = float(scale)
20
21     def __getattr__(self, name):
22         src = getattr(self._obj, name)
23         if src and self._scale:
24             src = type(src)(self._scale * src)
25         return src
26
27
28 class TextBox(object):
29     """Creates an Image with a series of centered strings."""
30
31     SHADOW_X = 3
32     SHADOW_Y = 3
33     SHADOW_BLUR = 3
34
35     def __init__(self, max_width, max_height, padding_x=None, padding_y=None):
36         if padding_x is None:
37             padding_x = self.SHADOW_X + self.SHADOW_BLUR
38         if padding_y is None:
39             padding_y = self.SHADOW_Y + self.SHADOW_BLUR
40
41         self.max_width = max_width
42         self.max_text_width = max_width - 2 * padding_x
43         self.padding_y = padding_y
44         self.height = padding_y
45         self.img = Image.new('RGBA', (max_width, max_height))
46         self.draw = ImageDraw.Draw(self.img)
47         self.shadow_img = None
48         self.shadow_draw = None
49
50     def skip(self, height):
51         """Skips some vertical space."""
52         self.height += height
53
54     def text(self, text, color='#000', font=None, line_height=20,
55              shadow_color=None):
56         """Writes some centered text."""
57         text = re.sub(r'\s+', ' ', text)
58         if shadow_color:
59             if not self.shadow_img:
60                 self.shadow_img = Image.new('RGBA', self.img.size)
61                 self.shadow_draw = ImageDraw.Draw(self.shadow_img)
62         while text:
63             line = text
64             line_width = self.draw.textsize(line, font=font)[0]
65             while line_width > self.max_text_width:
66                 parts = line.rsplit(' ', 1)
67                 if len(parts) == 1:
68                     line_width = self.max_text_width
69                     break
70                 line = parts[0]
71                 line_width = self.draw.textsize(line, font=font)[0]
72             line = line.strip() + ' '
73
74             pos_x = (self.max_width - line_width) / 2
75
76             if shadow_color:
77                 self.shadow_draw.text(
78                         (pos_x + self.SHADOW_X, self.height + self.SHADOW_Y),
79                         line, font=font, fill=shadow_color
80                 )
81
82             self.draw.text((pos_x, self.height), line, font=font, fill=color)
83             self.height += line_height
84             # go to next line
85             text = text[len(line):]
86
87     def image(self):
88         """Creates the actual Image object."""
89         image = Image.new('RGBA', (self.max_width,
90                                    self.height + self.padding_y))
91         if self.shadow_img:
92             shadow = self.shadow_img.filter(ImageFilter.BLUR)
93             image.paste(shadow, (0, 0), shadow)
94             image.paste(self.img, (0, 0), self.img)
95         else:
96             image.paste(self.img, (0, 0))
97         return image
98
99
100 class Cover(Format):
101     """Base class for cover images generator."""
102     format_name = u"cover image"
103
104     width = 600
105     height = 800
106     background_color = '#fff'
107     background_img = None
108
109     author_top = 100
110     author_margin_left = 20
111     author_margin_right = 20
112     author_lineskip = 40
113     author_color = '#000'
114     author_shadow = None
115     author_font_ttf = get_resource('fonts/DejaVuSerif.ttf')
116     author_font_size = 30
117
118     title_top = 100
119     title_margin_left = 20
120     title_margin_right = 20
121     title_lineskip = 54
122     title_color = '#000'
123     title_shadow = None
124     title_font_ttf = get_resource('fonts/DejaVuSerif.ttf')
125     title_font_size = 40
126
127     logo_bottom = None
128     logo_width = None
129     logo_file = get_resource('res/wl-logo.png')
130     uses_dc_cover = False
131
132     format = 'JPEG'
133     scale = 1
134
135     exts = {
136         'JPEG': 'jpg',
137         'PNG': 'png',
138         }
139
140     mime_types = {
141         'JPEG': 'image/jpeg',
142         'PNG': 'image/png',
143         }
144
145     def __init__(self, doc, format=None, width=None, height=None):
146         super(Cover, self).__init__(doc)
147         self.author = ", ".join(auth for auth in doc.meta.get(DCNS('creator')))
148         self.title = doc.meta.title()
149         if format is not None:
150             self.format = format
151         scale = max(float(width or 0) / self.width, float(height or 0) / self.height)
152         if scale:
153             self.scale = scale
154
155     def pretty_author(self):
156         """Allows for decorating author's name."""
157         return self.author
158
159     def pretty_title(self):
160         """Allows for decorating title."""
161         return self.title
162
163     def image(self):
164         metr = Metric(self, self.scale)
165         img = Image.new('RGB', (metr.width, metr.height), self.background_color)
166
167         if self.background_img:
168             background = Image.open(self.background_img)
169             resized = background.resize((1024, background.height*1024/background.width), Image.ANTIALIAS)
170             resized = resized.convert('RGBA')
171             img.paste(resized, (0, 0), resized)
172             del background, resized
173
174         if metr.logo_width:
175             logo = Image.open(self.logo_file)
176             logo = logo.resize((metr.logo_width, logo.size[1] * metr.logo_width / logo.size[0]), Image.ANTIALIAS)
177             logo = logo.convert('RGBA')
178             img.paste(logo, ((metr.width - metr.logo_width) / 2,
179                              img.size[1] - logo.size[1] - metr.logo_bottom), logo)
180
181         top = metr.author_top
182         tbox = TextBox(
183             metr.width - metr.author_margin_left - metr.author_margin_right,
184             metr.height - top,
185             )
186             
187         author_font = ImageFont.truetype(
188             self.author_font_ttf, metr.author_font_size)
189         tbox.text(
190             self.pretty_author(), self.author_color, author_font,
191             metr.author_lineskip, self.author_shadow)
192         text_img = tbox.image()
193         img.paste(text_img, (metr.author_margin_left, top), text_img)
194
195         top += text_img.size[1] + metr.title_top
196         tbox = TextBox(
197             metr.width - metr.title_margin_left - metr.title_margin_right,
198             metr.height - top,
199             )
200         title_font = ImageFont.truetype(
201             self.title_font_ttf, metr.title_font_size)
202         tbox.text(
203             self.pretty_title(), self.title_color, title_font,
204             metr.title_lineskip, self.title_shadow)
205         text_img = tbox.image()
206         img.paste(text_img, (metr.title_margin_left, top), text_img)
207
208         return img
209         # imgstr = StringIO()
210         # img.save(imgstr, format=self.format, quality=95)
211         # OutputFile.from_stringing(imgstr.getvalue())
212
213     def mime_type(self):
214         return self.mime_types[self.format]
215
216     @property
217     def format_ext(self):
218         return self.exts[self.format]
219
220     def save(self, *args, **kwargs):
221         return self.image().save(format=self.format, quality=95, *args, **kwargs)
222
223     def build(self, *args, **kwargs):
224         imgstr = StringIO()
225         self.save(imgstr, *args, **kwargs)
226         return OutputFile.from_string(imgstr.getvalue())