-
Notifications
You must be signed in to change notification settings - Fork 206
/
z_media_tag.erl
385 lines (347 loc) · 16.1 KB
/
z_media_tag.erl
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
%% @author Marc Worrell <marc@worrell.nl>
%% @copyright 2009 Marc Worrell
%% Date: 2009-03-03
%% @doc Generate media urls and html for viewing media, based on the filename, size and optional filters.
%% Does not generate media previews itself, this is done when fetching the image.
%%
%% Typical urls are like:
%% /image/2007/03/31/wedding.jpg(300x300)(crop-center)(a3ab6605e5c8ce801ac77eb76289ac12).jpg
%% /media/inline/2007/03/31/wedding.jpg
%% /media/attachment/2007/03/31/wedding.jpg
%% Copyright 2009 Marc Worrell
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
-module(z_media_tag).
-author("Marc Worrell <marc@worrell.nl").
%% interface functions
-export([
viewer/3,
tag/3,
url/3,
props2url/1,
url2props/2
]).
-include_lib("zotonic.hrl").
%% @spec viewer(MediaReference, Options, Context) -> {ok, HtmlFragMent} | {error, Reason}
%% MediaReference = Filename | RscId | MediaPropList
%% @doc Generate a html fragment for displaying a medium. This can generate audio or video player html.
viewer(undefined, _Options, _Context) ->
{ok, []};
viewer([], _Options, _Context) ->
{ok, []};
viewer(#rsc_list{list=[]}, _Options, _Context) ->
{ok, []};
viewer(#rsc_list{list=[Id|_]}, Options, Context) ->
viewer(Id, Options, Context);
viewer(Name, Options, Context) when is_atom(Name) ->
case m_rsc:name_to_id(Name, Context) of
{ok, Id} -> viewer(Id, Options, Context);
_ -> {ok, []}
end;
viewer(Id, Options, Context) when is_integer(Id) ->
case m_media:get(Id, Context) of
MediaProps when is_list(MediaProps) -> viewer(MediaProps, Options, Context);
undefined -> viewer1(Id, [], undefined, Options, Context)
end;
viewer([{_Prop, _Value}|_] = Props, Options, Context) ->
Id = proplists:get_value(id, Props),
case z_convert:to_list(proplists:get_value(filename, Props)) of
None when None == []; None == undefined ->
viewer1(Id, Props, undefined, Options, Context);
Filename ->
FilePath = filename_to_filepath(Filename, Context),
viewer1(Id, Props, FilePath, Options, Context)
end;
viewer(Filename, Options, Context) when is_binary(Filename) ->
viewer(binary_to_list(Filename), Options, Context);
viewer(Filename, Options, Context) ->
FilePath = filename_to_filepath(Filename, Context),
case z_media_identify:identify(FilePath, Context) of
{ok, Props} ->
viewer1(undefined, Props, FilePath, Options, Context);
{error, _} ->
% Unknown content type, we just can't display it.
{ok, []}
end.
%% @doc Try to generate Html for the media reference. First check if a module can do this, then
%% check the normal image tag.
viewer1(Id, Props, FilePath, Options, Context) ->
case z_notifier:first(#media_viewer{id=Id, props=Props, filename=FilePath, options=Options}, Context) of
{ok, Html} -> {ok, Html};
undefined -> tag(Props, Options, Context)
end.
%% @spec tag(MediaReference, Options, Context) -> {ok, TagString} | {error, Reason}
%% MediaReference = Filename | RscId | MediaPropList
%% @doc Generate a HTML image tag for the image with the filename and options. The medium _must_ be in
%% a format for which we can generate a preview. Note that this will never generate video or audio.
tag(What, Options, Context) ->
tag(What, Options, Context, []).
tag(undefined, _Options, _Context, _Visited) ->
{ok, []};
tag([], _Options, _Context, _Visited) ->
{ok, []};
tag(#rsc_list{list=[]}, _Options, _Context, _Visited) ->
{ok, []};
tag(#rsc_list{list=[Id|_]}, Options, Context, Visited) ->
tag(Id, Options, Context, Visited);
tag(Name, Options, Context, Visited) when is_atom(Name) ->
case m_rsc:name_to_id(Name, Context) of
{ok, Id} -> tag(Id, Options, Context, Visited);
_ -> {ok, []}
end;
tag(Id, Options, Context, Visited) when is_integer(Id) ->
case m_media:get(Id, Context) of
Props when is_list(Props) ->
case mediaprops_filename(Id, Props, Context) of
[] -> {ok, []};
Filename -> tag1(Props, Filename, Options, Context)
end;
undefined ->
NewId = case z_notifier:first(#media_stillimage{id=Id, props=[]}, Context) of
{ok, N} -> N;
_ ->
%% Use the first depiction edge
m_edge:object(Id, depiction, 1, Context)
end,
case NewId of
undefined -> {ok, []};
_ -> case lists:member(NewId, Visited) of
true -> {ok, []}; %% cycle detected
false -> tag(NewId, Options, Context, [NewId|Visited]) %% recurse
end
end
end;
tag([{_Prop, _Value}|_] = Props, Options, Context, _Visited) ->
case mediaprops_filename(proplists:get_value(id, Props), Props, Context) of
[] -> {ok, []};
Filename -> tag1(Props, Filename, Options, Context)
end;
tag(Filename, Options, Context, _Visited) when is_binary(Filename) ->
tag(binary_to_list(Filename), Options, Context);
tag(Filename, Options, Context, _Visited) when is_list(Filename) ->
FilePath = filename_to_filepath(Filename, Context),
tag1(FilePath, Filename, Options, Context);
tag({filepath, Filename, FilePath}, Options, Context, _Visited) ->
tag1(FilePath, Filename, Options, Context).
tag1(_MediaRef, {filepath, Filename, FilePath}, Options, Context) ->
tag1(FilePath, Filename, Options, Context);
tag1(MediaRef, Filename, Options, Context) ->
{url, Url, TagOpts, ImageOpts} = url1(Filename, Options, Context),
% Calculate the real size of the image using the options
TagOpts1 = case z_media_preview:size(MediaRef, ImageOpts, Context) of
{size, Width, Height, _Mime} ->
[{width,Width},{height,Height}|TagOpts];
_ ->
TagOpts
end,
% Make sure the required alt tag is present
TagOpts2 = case proplists:get_value(alt, TagOpts1) of
undefined -> [{alt,""}|TagOpts1];
_ -> TagOpts1
end,
% Filter some opts
case proplists:get_value(link, TagOpts) of
Empty when Empty == undefined; Empty == []; Empty == <<>> ->
{ok, z_tags:render_tag("img", [{src,Url}|TagOpts2])};
Link ->
HRef = iolist_to_binary(get_link(MediaRef, Link, Context)),
Tag = z_tags:render_tag("img", [{src,Url}|proplists:delete(link, TagOpts2)]),
{ok, z_tags:render_tag("a", [{href,HRef}], Tag)}
end.
% Given the media properties of an id, find the depicting file
mediaprops_filename(Id, undefined, Context) ->
case z_notifier:first({media_stillimage, Id, []}, Context) of
{ok, Filename} -> Filename;
undefined -> undefined
end;
mediaprops_filename(Id, Props, Context) ->
case z_notifier:first({media_stillimage, Id, Props}, Context) of
{ok, Filename} -> Filename;
_ -> case z_convert:to_list(proplists:get_value(preview_filename, Props)) of
[] -> z_convert:to_list(proplists:get_value(filename, Props));
Filename -> Filename
end
end.
get_link(Media, true, Context) ->
Id = media_id(Media),
case m_rsc:p(Id, website, Context) of
Empty when Empty == undefined; Empty == <<>>; Empty == [] ->
m_rsc:p(Id, page_url, Context);
Website ->
Website
end;
get_link(_Media, Id, Context) when is_integer(Id) ->
m_rsc:p(Id, page_url, Context);
get_link(_Media, HRef, _Context) when is_binary(HRef); is_list(HRef) ->
HRef.
media_id([{_,_}|_] = List) ->
proplists:get_value(id, List).
%% @doc Give the filepath for the filename being served.
%% @todo Ensure the file is really in the given directory (ie. no ..'s)
filename_to_filepath(Filename, #context{host=Host} = Context) ->
case Filename of
"/" ++ _ ->
Filename;
"lib/" ++ RelFilename ->
case z_module_indexer:find(lib, RelFilename, Context) of
{ok, Libfile} -> Libfile;
_ -> Filename
end;
_ ->
filename:join([z_utils:lib_dir(priv), "sites", Host, "files", "archive", Filename])
end.
%% @doc Give the base url for the filename being served
%% @todo Use the dispatch rules to find the correct image path (when we want that...)
filename_to_urlpath(Filename) ->
filename:join("/image/", Filename).
%% @spec url(MediaRef, Options, Context) -> {ok, Url::binary()} | {error, Reason}
%% @doc Generate the url for the image with the filename and options
url(undefined, _Options, _Context) ->
{error, enoent};
url(Id, Options, Context) when is_integer(Id) ->
case m_media:get(Id, Context) of
Props when is_list(Props) ->
url(Props, Options, Context);
undefined ->
case z_notifier:first({media_stillimage, Id, []}, Context) of
{ok, Filename} ->
{url, Url, _TagOptions, _ImageOptions} = url1(Filename, Options, Context),
{ok, Url};
_ -> {ok, <<>>}
end
end;
url([{_Prop, _Value}|_] = Props, Options, Context) ->
case z_convert:to_list(proplists:get_value(filename, Props)) of
None when None == undefined; None == <<>>; None == [] ->
case z_notifier:first({media_stillimage, proplists:get_value(id, Props), Props}, Context) of
{ok, Filename} ->
{url, Url, _TagOptions, _ImageOptions} = url1(Filename, Options, Context),
{ok, Url};
_ ->
{ok, <<>>}
end;
Filename ->
{url, Url, _TagOptions, _ImageOptions} = url1(Filename, Options, Context),
{ok, Url}
end;
url(Filename, Options, Context) ->
{url, Url, _TagOptions, _ImageOptions} = url1(Filename, Options, Context),
{ok, Url}.
%% @spec url1(Filename, Options, Context) -> {url, Url::binary(), TagOptions, ImageOpts} | {error, Reason}
%% @doc Creates an url for the given filename and filters. This does not check the filename or if it is convertible.
url1(File, Options, Context) ->
Filename = z_convert:to_list(File),
{TagOpts, ImageOpts} = lists:partition(fun is_tagopt/1, Options),
% Map all ImageOpts to an opt string
UrlProps = props2url(ImageOpts),
MimeFile = z_media_identify:guess_mime(Filename),
{_Mime,Extension} = z_media_preview:out_mime(MimeFile, ImageOpts),
Checksum = z_utils:checksum([Filename,UrlProps,Extension], Context),
PropCheck = mochiweb_util:quote_plus(lists:flatten([UrlProps,$(,Checksum,$)])),
{url, list_to_binary(filename_to_urlpath(lists:flatten([Filename,PropCheck,Extension]))),
TagOpts,
ImageOpts}.
is_tagopt({link, _}) -> true;
is_tagopt({alt, _}) -> true;
is_tagopt({title, _}) -> true;
is_tagopt({class, _}) -> true;
is_tagopt({style, _}) -> true;
% Some preview args we definitely know exist (just an optimization)
is_tagopt({width, _}) -> false;
is_tagopt({height, _}) -> false;
is_tagopt({crop, _}) -> false;
is_tagopt({gray, _}) -> false;
is_tagopt({mono, _}) -> false;
is_tagopt({extent, _}) -> false;
is_tagopt({upscale, _}) -> false;
is_tagopt({blur, _}) -> false;
is_tagopt({quality, _}) -> false;
is_tagopt({background, _}) -> false;
is_tagopt({lossless, _}) -> false;
is_tagopt({removebg, _}) -> false;
% And be sure to keep the data-xxxx args in the tag
is_tagopt({Prop, _}) ->
case z_convert:to_list(Prop) of
"data_"++_ -> true;
_ -> false
end.
props2url(Props) ->
props2url(Props, undefined, undefined, []).
props2url([], Width, Height, Acc) ->
Size = case {Width,Height} of
{undefined,undefined} -> [];
{_W,undefined} -> [integer_to_list(Width)] ++ "x";
{undefined,_H} -> [$x|integer_to_list(Height)];
{_W,_H} -> integer_to_list(Width) ++ [$x|integer_to_list(Height)]
end,
lists:flatten([$(, z_utils:combine(")(", [Size|lists:reverse(Acc)]), $)]);
props2url([{crop,None}|Rest], Width, Height, Acc) when None == false; None == undefined; None == <<>>; None == [] ->
props2url(Rest, Width, Height, Acc);
props2url([{width,Width}|Rest], _Width, Height, Acc) ->
props2url(Rest, z_convert:to_integer(Width), Height, Acc);
props2url([{height,Height}|Rest], Width, _Height, Acc) ->
props2url(Rest, Width, z_convert:to_integer(Height), Acc);
props2url([{Prop}|Rest], Width, Height, Acc) ->
props2url(Rest, Width, Height, [atom_to_list(Prop)|Acc]);
props2url([{_Prop,undefined}|Rest], Width, Height, Acc) ->
props2url(Rest, Width, Height, Acc);
props2url([{Prop,true}|Rest], Width, Height, Acc) ->
props2url(Rest, Width, Height, [atom_to_list(Prop)|Acc]);
props2url([{Prop,Value}|Rest], Width, Height, Acc) ->
props2url(Rest, Width, Height, [[atom_to_list(Prop),$-,z_convert:to_list(Value)]|Acc]).
%% @spec url2props(Url, Context) -> {Filepath,PreviewPropList,Checksum,ChecksumBaseString} | error
%% @doc Translate an url of the format "image.jpg(300x300)(crop-center)(checksum).jpg" to parts
%% @todo Map the extension to the format of the preview (.jpg or .png)
url2props(Url, Context) ->
{Filepath,Rest} = lists:splitwith(fun(C) -> C =/= $( end, Url),
PropsRoot = filename:rootname(Rest),
% Take the checksum from the string
case string:rchr(PropsRoot, $() of
0 ->
error;
LastParen ->
{Props,[$(|Check]} = lists:split(LastParen-1, PropsRoot),
Check1 = string:strip(Check, right, $)),
PropList = case Props of
"()" ++ _ -> [""|string:tokens(Props, ")(")];
_ -> string:tokens(Props, ")(")
end,
FileMime = z_media_identify:guess_mime(Rest),
{_Mime, Extension} = z_media_preview:out_mime(FileMime, PropList),
z_utils:checksum_assert([Filepath,Props,Extension], Check1, Context),
PropList1 = case PropList of
[] -> [];
[Size|RestProps]->
{W,XH} = lists:splitwith(fun(C) -> C >= $0 andalso C =< $9 end, Size),
SizeProps = case {W,XH} of
{"", "x"} -> [];
{"", ""} -> [];
{Width, ""} -> [{width,list_to_integer(Width)}];
{Width, "x"} -> [{width,list_to_integer(Width)}];
{"", [$x|Height]} -> [{height,list_to_integer(Height)}];
{Width, [$x|Height]} -> [{width,list_to_integer(Width)},{height,list_to_integer(Height)}]
end,
SizeProps ++ url2props1(RestProps, [])
end,
{Filepath,PropList1,Check1,Props}
end.
url2props1([], Acc) ->
lists:reverse(Acc);
url2props1([P|Rest], Acc) ->
{Prop,Arg} = lists:splitwith(fun(C) -> C =/= $- end, P),
Arg1 = case Arg of
[$-|A] -> A;
_ -> Arg
end,
Filter = z_media_preview:string2filter(Prop, Arg1),
url2props1(Rest, [Filter|Acc]).