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
|
-- This file is part of the LrMediaWiki project and distributed under the terms
-- of the MIT license (see LICENSE.txt file in the project root directory or
-- [0]). See [1] for more information about LrMediaWiki.
--
-- Copyright (C) 2014 by the LrMediaWiki team (see CREDITS.txt file in the
-- project root directory or [2])
--
-- [0] <https://raw.githubusercontent.com/ireas/LrMediaWiki/master/LICENSE.txt>
-- [1] <https://commons.wikimedia.org/wiki/Commons:LrMediaWiki>
-- [2] <https://raw.githubusercontent.com/ireas/LrMediaWiki/master/CREDITS.txt>
-- Code status:
-- doc: missing
-- i18n: complete
local LrDate = import 'LrDate'
local LrDialogs = import 'LrDialogs'
local LrErrors = import 'LrErrors'
local LrFileUtils = import 'LrFileUtils'
local LrPathUtils = import 'LrPathUtils'
local LrView = import 'LrView'
local bind = LrView.bind
local Info = require 'Info'
local MediaWikiInterface = require 'MediaWikiInterface'
local MediaWikiUtils = require 'MediaWikiUtils'
local MediaWikiExportServiceProvider = {}
MediaWikiExportServiceProvider.processRenderedPhotos = function(functionContext, exportContext)
-- configure progess display
local exportSession = exportContext.exportSession
local photoCount = exportSession:countRenditions()
exportContext:configureProgress{
title = photoCount > 1 and LOC('$$$/LrMediaWiki/Export/Progress=Exporting ^1 photos to a MediaWiki', photoCount) or LOC '$$$/LrMediaWiki/Export/Progress/One=Exporting one photo to a MediaWiki',
}
local exportSettings = assert(exportContext.propertyTable)
-- require username, password, apipath, license, author, source
if MediaWikiUtils.isStringEmpty(exportSettings.username) then
LrErrors.throwUserError(LOC '$$$/LrMediaWiki/Export/NoUsername=No username given!')
end
if MediaWikiUtils.isStringEmpty(exportSettings.password) then
LrErrors.throwUserError(LOC '$$$/LrMediaWiki/Export/NoPassword=No password given!')
end
if MediaWikiUtils.isStringEmpty(exportSettings.api_path) then
LrErrors.throwUserError(LOC '$$$/LrMediaWiki/Export/NoApiPath=No API path given!')
end
if MediaWikiUtils.isStringEmpty(exportSettings.info_license) then
LrErrors.throwUserError(LOC '$$$/LrMediaWiki/Export/NoLicense=No license given!')
end
if MediaWikiUtils.isStringEmpty(exportSettings.info_author) then
LrErrors.throwUserError(LOC '$$$/LrMediaWiki/Export/NoAuthor=No author given!')
end
if MediaWikiUtils.isStringEmpty(exportSettings.info_source) then
LrErrors.throwUserError(LOC '$$$/LrMediaWiki/Export/NoSource=No source given!')
end
MediaWikiInterface.prepareUpload(exportSettings.username, exportSettings.password, exportSettings.api_path)
-- file names for gallery creation
local fileNames = {}
-- iterate over photos
for i, rendition in exportContext:renditions() do
-- render photo
local success, pathOrMessage = rendition:waitForRender()
if success then
local photo = rendition.photo
local catalog = photo.catalog
-- do upload to MediaWiki
local descriptionEn = photo:getPropertyForPlugin(Info.LrToolkitIdentifier, 'description_en')
local descriptionDe = photo:getPropertyForPlugin(Info.LrToolkitIdentifier, 'description_de')
local descriptionAdditional = photo:getPropertyForPlugin(Info.LrToolkitIdentifier, 'description_additional')
local description = ''
if not MediaWikiUtils.isStringEmpty(descriptionEn) then
description = '{{en|1=' .. descriptionEn .. '}}\n'
end
if not MediaWikiUtils.isStringEmpty(descriptionDe) then
description = description .. '{{de|1=' .. descriptionDe .. '}}\n'
end
if not MediaWikiUtils.isStringEmpty(descriptionAdditional) then
description = description .. descriptionAdditional
end
local hasDescription = not MediaWikiUtils.isStringEmpty(description)
local source = exportSettings.info_source
local timestampSeconds = photo:getRawMetadata('dateTimeOriginal')
local timestamp = ''
if timestampSeconds then
timestamp = os.date("!%Y-%m-%d %H:%M:%S", timestampSeconds + 978307200)
end
local author = exportSettings.info_author
local license = exportSettings.info_license
local permission = exportSettings.info_permission
local templates = exportSettings.info_templates
local additionalTemplates = photo:getPropertyForPlugin(Info.LrToolkitIdentifier, 'templates') or ''
if not MediaWikiUtils.isStringEmpty(additionalTemplates) then
templates = templates .. '\n' .. additionalTemplates
end
local other = exportSettings.info_other
local categories = exportSettings.info_categories
local additionalCategories = photo:getPropertyForPlugin(Info.LrToolkitIdentifier, 'categories') or ''
local gps = photo:getRawMetadata('gps')
if gps and gps.latitude and gps.longitude then
local location = '{{Location|' .. gps.latitude .. '|' .. gps.longitude .. '}}\n'
templates = location .. templates
end
local fileDescription = MediaWikiInterface.buildFileDescription(description, source, timestamp, author, license, templates, other, categories, additionalCategories, permission)
-- ensure that the target file name does not contain a series of spaces or
-- underscores (as this would cause the upload to fail without a proper
-- error message)
local fileName = string.gsub(LrPathUtils.leafName(pathOrMessage), '[ _]+', '_')
local message = MediaWikiInterface.uploadFile(pathOrMessage, fileDescription, hasDescription, fileName)
if message then
rendition:uploadFailed(message)
else
-- create new snapshot if the upload was successful
if MediaWikiUtils.getCreateSnapshots() then
local currentTimeStamp = LrDate.currentTime()
local currentDate = LrDate.formatShortDate(currentTimeStamp)
local currentTime = LrDate.formatShortTime(currentTimeStamp)
local snapshotTitle = LOC('$$$/LrMediaWiki/Export/Snapshot=MediaWiki export, ^1 ^2, ^3', currentDate, currentTime, exportSettings.api_path)
catalog:withWriteAccessDo('CreateDevelopSnapshot', function(context)
photo:createDevelopSnapshot(snapshotTitle, true)
end)
end
-- add configured export keyword
local keyword = MediaWikiUtils.getExportKeyword()
if not MediaWikiUtils.isStringEmpty(keyword) then
catalog:withWriteAccessDo('AddExportKeyword', function(context)
photo:addKeyword(catalog:createKeyword(keyword, {}, false, nil, true))
end)
end
-- file name for gallery creation
fileNames[#fileNames + 1] = fileName
end
LrFileUtils.delete(pathOrMessage)
else
-- rendering failed --> report failure
rendition:uploadFailed(pathOrMessage)
end
end
if (not MediaWikiUtils.isStringEmpty(exportSettings.gallery)) and fileNames then
MediaWikiInterface.addToGallery(fileNames, exportSettings.gallery)
end
end
MediaWikiExportServiceProvider.sectionsForTopOfDialog = function(viewFactory, propertyTable)
local labelAlignment = 'right';
local widthLong = 50;
return {
{
title = LOC '$$$/LrMediaWiki/Section/User/Title=Login Information',
synopsis = bind 'username',
viewFactory:column {
spacing = viewFactory:control_spacing(),
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/User/Username=Username',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'username',
immediate = true,
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/User/Password=Password',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:password_field {
value = bind 'password',
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/User/ApiPath=API path',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'api_path',
immediate = true,
width_in_chars = widthLong,
},
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/User/ApiPath/Details=Path to the api.php file',
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/User/Gallery=Gallery',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'gallery',
immediate = true,
width_in_chars = widthLong,
},
},
},
},
{
title = LOC "$$$/LrMediaWiki/Section/Licensing/Title=Upload Information",
synopsis = bind 'info_license',
viewFactory:column {
spacing = viewFactory:control_spacing(),
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Source=Source',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'info_source',
immediate = true,
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Author=Author',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'info_author',
immediate = true,
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/License=License',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:combo_box {
value = bind 'info_license',
immediate = true,
width_in_chars = widthLong - 2,
items = {
'{{Cc-by-sa-4.0}}',
'{{Cc-by-4.0}}',
'{{Cc-zero}}',
},
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Permission=Permission',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'info_permission',
immediate = true,
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/OtherTemplates=Other templates',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'info_templates',
immediate = true,
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Other=Other fields',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'info_other',
immediate = true,
width_in_chars = widthLong,
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Categories=Categories',
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:edit_field {
value = bind 'info_categories',
immediate = true,
width_in_chars = widthLong,
height_in_lines = 3,
},
viewFactory:static_text {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Categories/Details=separate with ;',
},
},
viewFactory:row {
spacing = viewFactory:label_spacing(),
viewFactory:static_text {
alignment = labelAlignment,
width = LrView.share "label_width",
},
viewFactory:push_button {
title = LOC '$$$/LrMediaWiki/Section/Licensing/Preview=Preview generated wikitext',
action = function(button)
local result, message = MediaWikiInterface.loadFileDescriptionTemplate()
if result then
local wikitext = MediaWikiInterface.buildFileDescription('<!-- description -->', propertyTable.info_source, '<!-- date -->', propertyTable.info_author, propertyTable.info_license, '<!-- {{Location}} if GPS metadata is available -->\n' .. propertyTable.info_templates, propertyTable.info_other, propertyTable.info_categories, '<!-- per-file categories -->', '<!-- permission -->')
LrDialogs.message(LOC '$$$/LrMediaWiki/Section/Licensing/Preview=Preview generated wikitext', wikitext, 'info')
else
LrDialogs.message(LOC '$$$/LrMediaWiki/Export/DescriptionError=Error reading the file description', message, 'error')
end
end,
},
},
},
},
}
end
MediaWikiExportServiceProvider.hidePrintResolution = true
MediaWikiExportServiceProvider.showSections = {'fileNaming', 'metadata', 'fileSettings', 'imageSettings', 'outputSharpening'}
MediaWikiExportServiceProvider.allowFileFormats = {'JPEG', 'TIFF'}
MediaWikiExportServiceProvider.allowColorSpaces = {'sRGB'}
MediaWikiExportServiceProvider.canExportVideo = false
MediaWikiExportServiceProvider.exportPresetFields = {
{ key = 'username', default = '' },
{ key = 'password', default = '' },
{ key = 'api_path', default = 'https://commons.wikimedia.org/w/api.php' },
{ key = 'info_source', default = '{{own}}' },
{ key = 'info_author', default = '' },
{ key = 'info_license', default = '{{Cc-by-sa-4.0}}' },
{ key = 'info_permission', default = '' },
{ key = 'info_templates', default = '' },
{ key = 'info_other', default = '' },
{ key = 'info_categories', default = '' },
{ key = 'gallery', default = '' },
}
return MediaWikiExportServiceProvider
|
