xref: /dokuwiki/inc/media.php (revision ccef189973af1e806cd971df297b239782a1416b) 
1<?php
2/**
3 * All output and handler function needed for the media management popup
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8
9use dokuwiki\ChangeLog\MediaChangeLog;
10use dokuwiki\HTTP\DokuHTTPClient;
11use dokuwiki\Subscriptions\MediaSubscriptionSender;
12use dokuwiki\Extension\Event;
13use dokuwiki\Form\Form;
14use dokuwiki\Utf8\Sort;
15
16/**
17 * Lists pages which currently use a media file selected for deletion
18 *
19 * References uses the same visual as search results and share
20 * their CSS tags except pagenames won't be links.
21 *
22 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
23 *
24 * @param array $data
25 * @param string $id
26 */
27function media_filesinuse($data,$id){
28    global $lang;
29    echo '<h1>'.$lang['reference'].' <code>'.hsc(noNS($id)).'</code></h1>';
30    echo '<p>'.hsc($lang['ref_inuse']).'</p>';
31
32    $hidden=0; //count of hits without read permission
33    foreach($data as $row){
34        if(auth_quickaclcheck($row) >= AUTH_READ && isVisiblePage($row)){
35            echo '<div class="search_result">';
36            echo '<span class="mediaref_ref">'.hsc($row).'</span>';
37            echo '</div>';
38        }else
39            $hidden++;
40    }
41    if ($hidden){
42        print '<div class="mediaref_hidden">'.$lang['ref_hidden'].'</div>';
43    }
44}
45
46/**
47 * Handles the saving of image meta data
48 *
49 * @author Andreas Gohr <andi@splitbrain.org>
50 * @author Kate Arzamastseva <pshns@ukr.net>
51 *
52 * @param string $id media id
53 * @param int $auth permission level
54 * @param array $data
55 * @return false|string
56 */
57function media_metasave($id,$auth,$data){
58    if($auth < AUTH_UPLOAD) return false;
59    if(!checkSecurityToken()) return false;
60    global $lang;
61    global $conf;
62    $src = mediaFN($id);
63
64    $meta = new JpegMeta($src);
65    $meta->_parseAll();
66
67    foreach($data as $key => $val){
68        $val=trim($val);
69        if(empty($val)){
70            $meta->deleteField($key);
71        }else{
72            $meta->setField($key,$val);
73        }
74    }
75
76    $old = @filemtime($src);
77    if(!file_exists(mediaFN($id, $old)) && file_exists($src)) {
78        // add old revision to the attic
79        media_saveOldRevision($id);
80    }
81    $filesize_old = filesize($src);
82    if($meta->save()){
83        if($conf['fperm']) chmod($src, $conf['fperm']);
84        @clearstatcache(true, $src);
85        $new = @filemtime($src);
86        $filesize_new = filesize($src);
87        $sizechange = $filesize_new - $filesize_old;
88
89        // add a log entry to the media changelog
90        addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_EDIT, $lang['media_meta_edited'], '', null, $sizechange);
91
92        msg($lang['metasaveok'],1);
93        return $id;
94    }else{
95        msg($lang['metasaveerr'],-1);
96        return false;
97    }
98}
99
100/**
101 * check if a media is external source
102 *
103 * @author Gerrit Uitslag <klapinklapin@gmail.com>
104 *
105 * @param string $id the media ID or URL
106 * @return bool
107 */
108function media_isexternal($id){
109    if (preg_match('#^(?:https?|ftp)://#i', $id)) return true;
110    return false;
111}
112
113/**
114 * Check if a media item is public (eg, external URL or readable by @ALL)
115 *
116 * @author Andreas Gohr <andi@splitbrain.org>
117 *
118 * @param string $id  the media ID or URL
119 * @return bool
120 */
121function media_ispublic($id){
122    if(media_isexternal($id)) return true;
123    $id = cleanID($id);
124    if(auth_aclcheck(getNS($id).':*', '', array()) >= AUTH_READ) return true;
125    return false;
126}
127
128/**
129 * Display the form to edit image meta data
130 *
131 * @author Andreas Gohr <andi@splitbrain.org>
132 * @author Kate Arzamastseva <pshns@ukr.net>
133 *
134 * @param string $id media id
135 * @param int $auth permission level
136 * @return bool
137 */
138function media_metaform($id, $auth) {
139    global $lang;
140
141    if ($auth < AUTH_UPLOAD) {
142        echo '<div class="nothing">'.$lang['media_perm_upload'].'</div>'.DOKU_LF;
143        return false;
144    }
145
146    // load the field descriptions
147    static $fields = null;
148    if ($fields === null) {
149        $config_files = getConfigFiles('mediameta');
150        foreach ($config_files as $config_file) {
151            if (file_exists($config_file)) include($config_file);
152        }
153    }
154
155    $src = mediaFN($id);
156
157    // output
158    $form = new Form([
159            'action' => media_managerURL(['tab_details' => 'view'], '&'),
160            'class' => 'meta'
161    ]);
162    $form->addTagOpen('div')->addClass('no');
163    $form->setHiddenField('img', $id);
164    $form->setHiddenField('mediado', 'save');
165    foreach ($fields as $key => $field) {
166        // get current value
167        if (empty($field[0])) continue;
168        $tags = array($field[0]);
169        if (is_array($field[3])) $tags = array_merge($tags, $field[3]);
170        $value = tpl_img_getTag($tags, '', $src);
171        $value = cleanText($value);
172
173        // prepare attributes
174        $p = array(
175            'class' => 'edit',
176            'id'    => 'meta__'.$key,
177            'name'  => 'meta['.$field[0].']',
178        );
179
180        $form->addTagOpen('div')->addClass('row');
181        if ($field[2] == 'text') {
182            $form->addTextInput(
183                $p['name'],
184                ($lang[$field[1]] ? $lang[$field[1]] : $field[1] . ':')
185            )->id($p['id'])->addClass($p['class'])->val($value);
186        } else {
187            $form->addTextarea($p['name'], $lang[$field[1]])->id($p['id'])
188                ->val(formText($value))
189                ->addClass($p['class'])
190                ->attr('rows', '6')->attr('cols', '50');
191        }
192        $form->addTagClose('div');
193    }
194    $form->addTagOpen('div')->addClass('buttons');
195    $form->addButton('mediado[save]', $lang['btn_save'])->attr('type', 'submit')
196        ->attrs(['accesskey' => 's']);
197    $form->addTagClose('div');
198
199    $form->addTagClose('div');
200    echo $form->toHTML();
201    return true;
202}
203
204/**
205 * Convenience function to check if a media file is still in use
206 *
207 * @author Michael Klier <chi@chimeric.de>
208 *
209 * @param string $id media id
210 * @return array|bool
211 */
212function media_inuse($id) {
213    global $conf;
214
215    if($conf['refcheck']){
216        $mediareferences = ft_mediause($id,true);
217        if(!count($mediareferences)) {
218            return false;
219        } else {
220            return $mediareferences;
221        }
222    } else {
223        return false;
224    }
225}
226
227/**
228 * Handles media file deletions
229 *
230 * If configured, checks for media references before deletion
231 *
232 * @author             Andreas Gohr <andi@splitbrain.org>
233 *
234 * @param string $id media id
235 * @param int $auth no longer used
236 * @return int One of: 0,
237 *                     DOKU_MEDIA_DELETED,
238 *                     DOKU_MEDIA_DELETED | DOKU_MEDIA_EMPTY_NS,
239 *                     DOKU_MEDIA_NOT_AUTH,
240 *                     DOKU_MEDIA_INUSE
241 */
242function media_delete($id,$auth){
243    global $lang;
244    $auth = auth_quickaclcheck(ltrim(getNS($id).':*', ':'));
245    if($auth < AUTH_DELETE) return DOKU_MEDIA_NOT_AUTH;
246    if(media_inuse($id)) return DOKU_MEDIA_INUSE;
247
248    $file = mediaFN($id);
249
250    // trigger an event - MEDIA_DELETE_FILE
251    $data = array();
252    $data['id']   = $id;
253    $data['name'] = \dokuwiki\Utf8\PhpString::basename($file);
254    $data['path'] = $file;
255    $data['size'] = (file_exists($file)) ? filesize($file) : 0;
256
257    $data['unl'] = false;
258    $data['del'] = false;
259    $evt = new Event('MEDIA_DELETE_FILE',$data);
260    if ($evt->advise_before()) {
261        $old = @filemtime($file);
262        if(!file_exists(mediaFN($id, $old)) && file_exists($file)) {
263            // add old revision to the attic
264            media_saveOldRevision($id);
265        }
266
267        $data['unl'] = @unlink($file);
268        if($data['unl']) {
269            $sizechange = 0 - $data['size'];
270            addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE, $lang['deleted'], '', null, $sizechange);
271
272            $data['del'] = io_sweepNS($id, 'mediadir');
273        }
274    }
275    $evt->advise_after();
276    unset($evt);
277
278    if($data['unl'] && $data['del']){
279        return DOKU_MEDIA_DELETED | DOKU_MEDIA_EMPTY_NS;
280    }
281
282    return $data['unl'] ? DOKU_MEDIA_DELETED : 0;
283}
284
285/**
286 * Handle file uploads via XMLHttpRequest
287 *
288 * @param string $ns   target namespace
289 * @param int    $auth current auth check result
290 * @return false|string false on error, id of the new file on success
291 */
292function media_upload_xhr($ns,$auth){
293    if(!checkSecurityToken()) return false;
294    global $INPUT;
295
296    $id = $INPUT->get->str('qqfile');
297    list($ext,$mime) = mimetype($id);
298    $input = fopen("php://input", "r");
299    if (!($tmp = io_mktmpdir())) return false;
300    $path = $tmp.'/'.md5($id);
301    $target = fopen($path, "w");
302    $realSize = stream_copy_to_stream($input, $target);
303    fclose($target);
304    fclose($input);
305    if (isset($_SERVER["CONTENT_LENGTH"]) && ($realSize != (int)$_SERVER["CONTENT_LENGTH"])){
306        unlink($path);
307        return false;
308    }
309
310    $res = media_save(
311        array('name' => $path,
312            'mime' => $mime,
313            'ext'  => $ext),
314        $ns.':'.$id,
315        (($INPUT->get->str('ow') == 'true') ? true : false),
316        $auth,
317        'copy'
318    );
319    unlink($path);
320    if ($tmp) io_rmdir($tmp, true);
321    if (is_array($res)) {
322        msg($res[0], $res[1]);
323        return false;
324    }
325    return $res;
326}
327
328/**
329 * Handles media file uploads
330 *
331 * @author Andreas Gohr <andi@splitbrain.org>
332 * @author Michael Klier <chi@chimeric.de>
333 *
334 * @param string     $ns    target namespace
335 * @param int        $auth  current auth check result
336 * @param bool|array $file  $_FILES member, $_FILES['upload'] if false
337 * @return false|string false on error, id of the new file on success
338 */
339function media_upload($ns,$auth,$file=false){
340    if(!checkSecurityToken()) return false;
341    global $lang;
342    global $INPUT;
343
344    // get file and id
345    $id   = $INPUT->post->str('mediaid');
346    if (!$file) $file = $_FILES['upload'];
347    if(empty($id)) $id = $file['name'];
348
349    // check for errors (messages are done in lib/exe/mediamanager.php)
350    if($file['error']) return false;
351
352    // check extensions
353    list($fext,$fmime) = mimetype($file['name']);
354    list($iext,$imime) = mimetype($id);
355    if($fext && !$iext){
356        // no extension specified in id - read original one
357        $id   .= '.'.$fext;
358        $imime = $fmime;
359    }elseif($fext && $fext != $iext){
360        // extension was changed, print warning
361        msg(sprintf($lang['mediaextchange'],$fext,$iext));
362    }
363
364    $res = media_save(array('name' => $file['tmp_name'],
365                            'mime' => $imime,
366                            'ext'  => $iext), $ns.':'.$id,
367                      $INPUT->post->bool('ow'), $auth, 'copy_uploaded_file');
368    if (is_array($res)) {
369        msg($res[0], $res[1]);
370        return false;
371    }
372    return $res;
373}
374
375/**
376 * An alternative to move_uploaded_file that copies
377 *
378 * Using copy, makes sure any setgid bits on the media directory are honored
379 *
380 * @see   move_uploaded_file()
381 *
382 * @param string $from
383 * @param string $to
384 * @return bool
385 */
386function copy_uploaded_file($from, $to){
387    if(!is_uploaded_file($from)) return false;
388    $ok = copy($from, $to);
389    @unlink($from);
390    return $ok;
391}
392
393/**
394 * This generates an action event and delegates to _media_upload_action().
395 * Action plugins are allowed to pre/postprocess the uploaded file.
396 * (The triggered event is preventable.)
397 *
398 * Event data:
399 * $data[0]     fn_tmp:    the temporary file name (read from $_FILES)
400 * $data[1]     fn:        the file name of the uploaded file
401 * $data[2]     id:        the future directory id of the uploaded file
402 * $data[3]     imime:     the mimetype of the uploaded file
403 * $data[4]     overwrite: if an existing file is going to be overwritten
404 * $data[5]     move:      name of function that performs move/copy/..
405 *
406 * @triggers MEDIA_UPLOAD_FINISH
407 *
408 * @param array  $file
409 * @param string $id   media id
410 * @param bool   $ow   overwrite?
411 * @param int    $auth permission level
412 * @param string $move name of functions that performs move/copy/..
413 * @return false|array|string
414 */
415function media_save($file, $id, $ow, $auth, $move) {
416    if($auth < AUTH_UPLOAD) {
417        return array("You don't have permissions to upload files.", -1);
418    }
419
420    if (!isset($file['mime']) || !isset($file['ext'])) {
421        list($ext, $mime) = mimetype($id);
422        if (!isset($file['mime'])) {
423            $file['mime'] = $mime;
424        }
425        if (!isset($file['ext'])) {
426            $file['ext'] = $ext;
427        }
428    }
429
430    global $lang, $conf;
431
432    // get filename
433    $id   = cleanID($id);
434    $fn   = mediaFN($id);
435
436    // get filetype regexp
437    $types = array_keys(getMimeTypes());
438    $types = array_map(
439        function ($q) {
440            return preg_quote($q, "/");
441        },
442        $types
443    );
444    $regex = join('|',$types);
445
446    // because a temp file was created already
447    if(!preg_match('/\.('.$regex.')$/i',$fn)) {
448        return array($lang['uploadwrong'],-1);
449    }
450
451    //check for overwrite
452    $overwrite = file_exists($fn);
453    $auth_ow = (($conf['mediarevisions']) ? AUTH_UPLOAD : AUTH_DELETE);
454    if($overwrite && (!$ow || $auth < $auth_ow)) {
455        return array($lang['uploadexist'], 0);
456    }
457    // check for valid content
458    $ok = media_contentcheck($file['name'], $file['mime']);
459    if($ok == -1){
460        return array(sprintf($lang['uploadbadcontent'],'.' . $file['ext']),-1);
461    }elseif($ok == -2){
462        return array($lang['uploadspam'],-1);
463    }elseif($ok == -3){
464        return array($lang['uploadxss'],-1);
465    }
466
467    // prepare event data
468    $data = array();
469    $data[0] = $file['name'];
470    $data[1] = $fn;
471    $data[2] = $id;
472    $data[3] = $file['mime'];
473    $data[4] = $overwrite;
474    $data[5] = $move;
475
476    // trigger event
477    return Event::createAndTrigger('MEDIA_UPLOAD_FINISH', $data, '_media_upload_action', true);
478}
479
480/**
481 * Callback adapter for media_upload_finish() triggered by MEDIA_UPLOAD_FINISH
482 *
483 * @author Michael Klier <chi@chimeric.de>
484 *
485 * @param array $data event data
486 * @return false|array|string
487 */
488function _media_upload_action($data) {
489    // fixme do further sanity tests of given data?
490    if(is_array($data) && count($data)===6) {
491        return media_upload_finish($data[0], $data[1], $data[2], $data[3], $data[4], $data[5]);
492    } else {
493        return false; //callback error
494    }
495}
496
497/**
498 * Saves an uploaded media file
499 *
500 * @author Andreas Gohr <andi@splitbrain.org>
501 * @author Michael Klier <chi@chimeric.de>
502 * @author Kate Arzamastseva <pshns@ukr.net>
503 *
504 * @param string $fn_tmp
505 * @param string $fn
506 * @param string $id        media id
507 * @param string $imime     mime type
508 * @param bool   $overwrite overwrite existing?
509 * @param string $move      function name
510 * @return array|string
511 */
512function media_upload_finish($fn_tmp, $fn, $id, $imime, $overwrite, $move = 'move_uploaded_file') {
513    global $conf;
514    global $lang;
515    global $REV;
516
517    $old = @filemtime($fn);
518    if(!file_exists(mediaFN($id, $old)) && file_exists($fn)) {
519        // add old revision to the attic if missing
520        media_saveOldRevision($id);
521    }
522
523    // prepare directory
524    io_createNamespace($id, 'media');
525
526    $filesize_old = file_exists($fn) ? filesize($fn) : 0;
527
528    if($move($fn_tmp, $fn)) {
529        @clearstatcache(true,$fn);
530        $new = @filemtime($fn);
531        // Set the correct permission here.
532        // Always chmod media because they may be saved with different permissions than expected from the php umask.
533        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
534        chmod($fn, $conf['fmode']);
535        msg($lang['uploadsucc'],1);
536        media_notify($id,$fn,$imime,$old,$new);
537        // add a log entry to the media changelog
538        $filesize_new = filesize($fn);
539        $sizechange = $filesize_new - $filesize_old;
540        if($REV) {
541            addMediaLogEntry(
542                $new,
543                $id,
544                DOKU_CHANGE_TYPE_REVERT,
545                sprintf($lang['restored'], dformat($REV)),
546                $REV,
547                null,
548                $sizechange
549            );
550        } elseif($overwrite) {
551            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_EDIT, '', '', null, $sizechange);
552        } else {
553            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_CREATE, $lang['created'], '', null, $sizechange);
554        }
555        return $id;
556    }else{
557        return array($lang['uploadfail'],-1);
558    }
559}
560
561/**
562 * Moves the current version of media file to the media_attic
563 * directory
564 *
565 * @author Kate Arzamastseva <pshns@ukr.net>
566 *
567 * @param string $id
568 * @return int - revision date
569 */
570function media_saveOldRevision($id){
571    global $conf, $lang;
572
573    $oldf = mediaFN($id);
574    if(!file_exists($oldf)) return '';
575    $date = filemtime($oldf);
576    if (!$conf['mediarevisions']) return $date;
577
578    $medialog = new MediaChangeLog($id);
579    if (!$medialog->getRevisionInfo($date)) {
580        // there was an external edit,
581        // there is no log entry for current version of file
582        $sizechange = filesize($oldf);
583        if(!file_exists(mediaMetaFN($id, '.changes'))) {
584            addMediaLogEntry($date, $id, DOKU_CHANGE_TYPE_CREATE, $lang['created'], '', null, $sizechange);
585        } else {
586            $oldRev = $medialog->getRevisions(-1, 1); // from changelog
587            $oldRev = (int) (empty($oldRev) ? 0 : $oldRev[0]);
588            $filesize_old = filesize(mediaFN($id, $oldRev));
589            $sizechange = $sizechange - $filesize_old;
590
591            addMediaLogEntry($date, $id, DOKU_CHANGE_TYPE_EDIT, '', '', null, $sizechange);
592        }
593    }
594
595    $newf = mediaFN($id,$date);
596    io_makeFileDir($newf);
597    if(copy($oldf, $newf)) {
598        // Set the correct permission here.
599        // Always chmod media because they may be saved with different permissions than expected from the php umask.
600        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
601        chmod($newf, $conf['fmode']);
602    }
603    return $date;
604}
605
606/**
607 * This function checks if the uploaded content is really what the
608 * mimetype says it is. We also do spam checking for text types here.
609 *
610 * We need to do this stuff because we can not rely on the browser
611 * to do this check correctly. Yes, IE is broken as usual.
612 *
613 * @author Andreas Gohr <andi@splitbrain.org>
614 * @link   http://www.splitbrain.org/blog/2007-02/12-internet_explorer_facilitates_cross_site_scripting
615 * @fixme  check all 26 magic IE filetypes here?
616 *
617 * @param string $file path to file
618 * @param string $mime mimetype
619 * @return int
620 */
621function media_contentcheck($file,$mime){
622    global $conf;
623    if($conf['iexssprotect']){
624        $fh = @fopen($file, 'rb');
625        if($fh){
626            $bytes = fread($fh, 256);
627            fclose($fh);
628            if(preg_match('/<(script|a|img|html|body|iframe)[\s>]/i',$bytes)){
629                return -3; //XSS: possibly malicious content
630            }
631        }
632    }
633    if(substr($mime,0,6) == 'image/'){
634        $info = @getimagesize($file);
635        if($mime == 'image/gif' && $info[2] != 1){
636            return -1; // uploaded content did not match the file extension
637        }elseif($mime == 'image/jpeg' && $info[2] != 2){
638            return -1;
639        }elseif($mime == 'image/png' && $info[2] != 3){
640            return -1;
641        }
642        # fixme maybe check other images types as well
643    }elseif(substr($mime,0,5) == 'text/'){
644        global $TEXT;
645        $TEXT = io_readFile($file);
646        if(checkwordblock()){
647            return -2; //blocked by the spam blacklist
648        }
649    }
650    return 0;
651}
652
653/**
654 * Send a notify mail on uploads
655 *
656 * @author Andreas Gohr <andi@splitbrain.org>
657 *
658 * @param string   $id      media id
659 * @param string   $file    path to file
660 * @param string   $mime    mime type
661 * @param bool|int $old_rev revision timestamp or false
662 * @return bool
663 */
664function media_notify($id,$file,$mime,$old_rev=false,$current_rev=false){
665    global $conf;
666    if(empty($conf['notify'])) return false; //notify enabled?
667
668    $subscription = new MediaSubscriptionSender();
669    return $subscription->sendMediaDiff($conf['notify'], 'uploadmail', $id, $old_rev, $current_rev);
670}
671
672/**
673 * List all files in a given Media namespace
674 *
675 * @param string      $ns             namespace
676 * @param null|int    $auth           permission level
677 * @param string      $jump           id
678 * @param bool        $fullscreenview
679 * @param bool|string $sort           sorting order, false skips sorting
680 */
681function media_filelist($ns,$auth=null,$jump='',$fullscreenview=false,$sort=false){
682    global $conf;
683    global $lang;
684    $ns = cleanID($ns);
685
686    // check auth our self if not given (needed for ajax calls)
687    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
688
689    if (!$fullscreenview) echo '<h1 id="media__ns">:'.hsc($ns).'</h1>'.NL;
690
691    if($auth < AUTH_READ){
692        // FIXME: print permission warning here instead?
693        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
694    }else{
695        if (!$fullscreenview) {
696            media_uploadform($ns, $auth);
697            media_searchform($ns);
698        }
699
700        $dir = utf8_encodeFN(str_replace(':','/',$ns));
701        $data = array();
702        search($data,$conf['mediadir'],'search_media',
703                array('showmsg'=>true,'depth'=>1),$dir,1,$sort);
704
705        if(!count($data)){
706            echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
707        }else {
708            if ($fullscreenview) {
709                echo '<ul class="' . _media_get_list_type() . '">';
710            }
711            foreach($data as $item){
712                if (!$fullscreenview) {
713                    media_printfile($item,$auth,$jump);
714                } else {
715                    media_printfile_thumbs($item,$auth,$jump);
716                }
717            }
718            if ($fullscreenview) echo '</ul>'.NL;
719        }
720    }
721}
722
723/**
724 * Prints tabs for files list actions
725 *
726 * @author Kate Arzamastseva <pshns@ukr.net>
727 * @author Adrian Lang <mail@adrianlang.de>
728 *
729 * @param string $selected_tab - opened tab
730 */
731
732function media_tabs_files($selected_tab = ''){
733    global $lang;
734    $tabs = array();
735    foreach(array('files'  => 'mediaselect',
736                  'upload' => 'media_uploadtab',
737                  'search' => 'media_searchtab') as $tab => $caption) {
738        $tabs[$tab] = array('href'    => media_managerURL(['tab_files' => $tab], '&'),
739                            'caption' => $lang[$caption]);
740    }
741
742    html_tabs($tabs, $selected_tab);
743}
744
745/**
746 * Prints tabs for files details actions
747 *
748 * @author Kate Arzamastseva <pshns@ukr.net>
749 * @param string $image filename of the current image
750 * @param string $selected_tab opened tab
751 */
752function media_tabs_details($image, $selected_tab = '') {
753    global $lang, $conf;
754
755    $tabs = array();
756    $tabs['view'] = array('href'    => media_managerURL(['tab_details' => 'view'], '&'),
757                          'caption' => $lang['media_viewtab']);
758
759    list(, $mime) = mimetype($image);
760    if ($mime == 'image/jpeg' && file_exists(mediaFN($image))) {
761        $tabs['edit'] = array('href'    => media_managerURL(['tab_details' => 'edit'], '&'),
762                              'caption' => $lang['media_edittab']);
763    }
764    if ($conf['mediarevisions']) {
765        $tabs['history'] = array('href'    => media_managerURL(['tab_details' => 'history'], '&'),
766                                 'caption' => $lang['media_historytab']);
767    }
768
769    html_tabs($tabs, $selected_tab);
770}
771
772/**
773 * Prints options for the tab that displays a list of all files
774 *
775 * @author Kate Arzamastseva <pshns@ukr.net>
776 */
777function media_tab_files_options() {
778    global $lang;
779    global $INPUT;
780    global $ID;
781
782    $form = new Form([
783            'method' => 'get',
784            'action' => wl($ID),
785            'class' => 'options'
786    ]);
787    $form->addTagOpen('div')->addClass('no');
788    $form->setHiddenField('sectok', null);
789    $media_manager_params = media_managerURL([], '', false, true);
790    foreach ($media_manager_params as $pKey => $pVal) {
791        $form->setHiddenField($pKey, $pVal);
792    }
793    if ($INPUT->has('q')) {
794        $form->setHiddenField('q', $INPUT->str('q'));
795    }
796    $form->addHTML('<ul>'.NL);
797    foreach (array('list' => array('listType', array('thumbs', 'rows')),
798                  'sort' => array('sortBy', array('name', 'date')))
799            as $group => $content) {
800        $checked = "_media_get_${group}_type";
801        $checked = $checked();
802
803        $form->addHTML('<li class="'. $content[0] .'">');
804        foreach ($content[1] as $option) {
805            $attrs = array();
806            if ($checked == $option) {
807                $attrs['checked'] = 'checked';
808            }
809            $radio = $form->addRadioButton(
810                $group.'_dwmedia',
811                $lang['media_'.$group.'_'.$option]
812            )->val($option)->id($content[0].'__'.$option)->addClass($option);
813            $radio->attrs($attrs);
814        }
815        $form->addHTML('</li>'.NL);
816    }
817    $form->addHTML('<li>');
818    $form->addButton('', $lang['btn_apply'])->attr('type', 'submit');
819    $form->addHTML('</li>'.NL);
820    $form->addHTML('</ul>'.NL);
821    $form->addTagClose('div');
822    print $form->toHTML();
823}
824
825/**
826 * Returns type of sorting for the list of files in media manager
827 *
828 * @author Kate Arzamastseva <pshns@ukr.net>
829 *
830 * @return string - sort type
831 */
832function _media_get_sort_type() {
833    return _media_get_display_param('sort', array('default' => 'name', 'date'));
834}
835
836/**
837 * Returns type of listing for the list of files in media manager
838 *
839 * @author Kate Arzamastseva <pshns@ukr.net>
840 *
841 * @return string - list type
842 */
843function _media_get_list_type() {
844    return _media_get_display_param('list', array('default' => 'thumbs', 'rows'));
845}
846
847/**
848 * Get display parameters
849 *
850 * @param string $param   name of parameter
851 * @param array  $values  allowed values, where default value has index key 'default'
852 * @return string the parameter value
853 */
854function _media_get_display_param($param, $values) {
855    global $INPUT;
856    if (in_array($INPUT->str($param), $values)) {
857        // FIXME: Set cookie
858        return $INPUT->str($param);
859    } else {
860        $val = get_doku_pref($param, $values['default']);
861        if (!in_array($val, $values)) {
862            $val = $values['default'];
863        }
864        return $val;
865    }
866}
867
868/**
869 * Prints tab that displays a list of all files
870 *
871 * @author Kate Arzamastseva <pshns@ukr.net>
872 *
873 * @param string    $ns
874 * @param null|int  $auth permission level
875 * @param string    $jump item id
876 */
877function media_tab_files($ns,$auth=null,$jump='') {
878    global $lang;
879    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
880
881    if($auth < AUTH_READ){
882        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
883    }else{
884        media_filelist($ns,$auth,$jump,true,_media_get_sort_type());
885    }
886}
887
888/**
889 * Prints tab that displays uploading form
890 *
891 * @author Kate Arzamastseva <pshns@ukr.net>
892 *
893 * @param string   $ns
894 * @param null|int $auth permission level
895 * @param string   $jump item id
896 */
897function media_tab_upload($ns,$auth=null,$jump='') {
898    global $lang;
899    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
900
901    echo '<div class="upload">'.NL;
902    if ($auth >= AUTH_UPLOAD) {
903        echo '<p>' . $lang['mediaupload'] . '</p>';
904    }
905    media_uploadform($ns, $auth, true);
906    echo '</div>'.NL;
907}
908
909/**
910 * Prints tab that displays search form
911 *
912 * @author Kate Arzamastseva <pshns@ukr.net>
913 *
914 * @param string $ns
915 * @param null|int $auth permission level
916 */
917function media_tab_search($ns,$auth=null) {
918    global $INPUT;
919
920    $do = $INPUT->str('mediado');
921    $query = $INPUT->str('q');
922    echo '<div class="search">'.NL;
923
924    media_searchform($ns, $query, true);
925    if ($do == 'searchlist' || $query) {
926        media_searchlist($query,$ns,$auth,true,_media_get_sort_type());
927    }
928    echo '</div>'.NL;
929}
930
931/**
932 * Prints tab that displays mediafile details
933 *
934 * @author Kate Arzamastseva <pshns@ukr.net>
935 *
936 * @param string     $image media id
937 * @param string     $ns
938 * @param null|int   $auth  permission level
939 * @param string|int $rev   revision timestamp or empty string
940 */
941function media_tab_view($image, $ns, $auth=null, $rev='') {
942    global $lang;
943    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
944
945    if ($image && $auth >= AUTH_READ) {
946        $meta = new JpegMeta(mediaFN($image, $rev));
947        media_preview($image, $auth, $rev, $meta);
948        media_preview_buttons($image, $auth, $rev);
949        media_details($image, $auth, $rev, $meta);
950
951    } else {
952        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
953    }
954}
955
956/**
957 * Prints tab that displays form for editing mediafile metadata
958 *
959 * @author Kate Arzamastseva <pshns@ukr.net>
960 *
961 * @param string     $image media id
962 * @param string     $ns
963 * @param null|int   $auth permission level
964 */
965function media_tab_edit($image, $ns, $auth=null) {
966    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
967
968    if ($image) {
969        list(, $mime) = mimetype($image);
970        if ($mime == 'image/jpeg') media_metaform($image,$auth);
971    }
972}
973
974/**
975 * Prints tab that displays mediafile revisions
976 *
977 * @author Kate Arzamastseva <pshns@ukr.net>
978 *
979 * @param string     $image media id
980 * @param string     $ns
981 * @param null|int   $auth permission level
982 */
983function media_tab_history($image, $ns, $auth=null) {
984    global $lang;
985    global $INPUT;
986
987    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
988    $do = $INPUT->str('mediado');
989
990    if ($auth >= AUTH_READ && $image) {
991        if ($do == 'diff'){
992            media_diff($image, $ns, $auth);
993        } else {
994            $first = $INPUT->int('first');
995            (new dokuwiki\Ui\MediaRevisions($image))->show($first);
996        }
997    } else {
998        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
999    }
1000}
1001
1002/**
1003 * Prints mediafile details
1004 *
1005 * @param string         $image media id
1006 * @param int            $auth permission level
1007 * @param int|string     $rev revision timestamp or empty string
1008 * @param JpegMeta|bool  $meta
1009 *
1010 * @author Kate Arzamastseva <pshns@ukr.net>
1011 */
1012function media_preview($image, $auth, $rev='', $meta=false) {
1013
1014    $size = media_image_preview_size($image, $rev, $meta);
1015
1016    if ($size) {
1017        global $lang;
1018        echo '<div class="image">';
1019
1020        $more = array();
1021        if ($rev) {
1022            $more['rev'] = $rev;
1023        } else {
1024            $t = @filemtime(mediaFN($image));
1025            $more['t'] = $t;
1026        }
1027
1028        $more['w'] = $size[0];
1029        $more['h'] = $size[1];
1030        $src = ml($image, $more);
1031
1032        echo '<a href="'.$src.'" target="_blank" title="'.$lang['mediaview'].'">';
1033        echo '<img src="'.$src.'" alt="" style="max-width: '.$size[0].'px;" />';
1034        echo '</a>';
1035
1036        echo '</div>'.NL;
1037    }
1038}
1039
1040/**
1041 * Prints mediafile action buttons
1042 *
1043 * @author Kate Arzamastseva <pshns@ukr.net>
1044 *
1045 * @param string     $image media id
1046 * @param int        $auth  permission level
1047 * @param string|int $rev   revision timestamp, or empty string
1048 */
1049function media_preview_buttons($image, $auth, $rev = '') {
1050    global $lang, $conf;
1051
1052    echo '<ul class="actions">'.DOKU_LF;
1053
1054    if ($auth >= AUTH_DELETE && !$rev && file_exists(mediaFN($image))) {
1055
1056        // delete button
1057        $form = new Form([
1058            'id' => 'mediamanager__btn_delete',
1059            'action' => media_managerURL(['delete' => $image], '&'),
1060        ]);
1061        $form->addTagOpen('div')->addClass('no');
1062        $form->addButton('', $lang['btn_delete'])->attr('type', 'submit');
1063        $form->addTagClose('div');
1064        echo '<li>';
1065        echo $form->toHTML();
1066        echo '</li>'.DOKU_LF;
1067    }
1068
1069    $auth_ow = (($conf['mediarevisions']) ? AUTH_UPLOAD : AUTH_DELETE);
1070    if ($auth >= $auth_ow && !$rev) {
1071
1072        // upload new version button
1073        $form = new Form([
1074            'id' => 'mediamanager__btn_update',
1075            'action' => media_managerURL(['image' => $image, 'mediado' => 'update'], '&'),
1076        ]);
1077        $form->addTagOpen('div')->addClass('no');
1078        $form->addButton('', $lang['media_update'])->attr('type', 'submit');
1079        $form->addTagClose('div');
1080        echo '<li>';
1081        echo $form->toHTML();
1082        echo '</li>'.DOKU_LF;
1083    }
1084
1085    if ($auth >= AUTH_UPLOAD && $rev && $conf['mediarevisions'] && file_exists(mediaFN($image, $rev))) {
1086
1087        // restore button
1088        $form = new Form([
1089            'id' => 'mediamanager__btn_restore',
1090            'action'=>media_managerURL(['image' => $image], '&'),
1091        ]);
1092        $form->addTagOpen('div')->addClass('no');
1093        $form->setHiddenField('mediado', 'restore');
1094        $form->setHiddenField('rev', $rev);
1095        $form->addButton('', $lang['media_restore'])->attr('type', 'submit');
1096        $form->addTagClose('div');
1097        echo '<li>';
1098        echo $form->toHTML();
1099        echo '</li>'.DOKU_LF;
1100    }
1101
1102    echo '</ul>'.DOKU_LF;
1103}
1104
1105/**
1106 * Returns image width and height for mediamanager preview panel
1107 *
1108 * @author Kate Arzamastseva <pshns@ukr.net>
1109 * @param string         $image
1110 * @param int|string     $rev
1111 * @param JpegMeta|bool  $meta
1112 * @param int            $size
1113 * @return array|false
1114 */
1115function media_image_preview_size($image, $rev, $meta, $size = 500) {
1116    if (!preg_match("/\.(jpe?g|gif|png)$/", $image) || !file_exists(mediaFN($image, $rev))) return false;
1117
1118    $info = getimagesize(mediaFN($image, $rev));
1119    $w = (int) $info[0];
1120    $h = (int) $info[1];
1121
1122    if($meta && ($w > $size || $h > $size)){
1123        $ratio = $meta->getResizeRatio($size, $size);
1124        $w = floor($w * $ratio);
1125        $h = floor($h * $ratio);
1126    }
1127    return array($w, $h);
1128}
1129
1130/**
1131 * Returns the requested EXIF/IPTC tag from the image meta
1132 *
1133 * @author Kate Arzamastseva <pshns@ukr.net>
1134 *
1135 * @param array    $tags array with tags, first existing is returned
1136 * @param JpegMeta $meta
1137 * @param string   $alt  alternative value
1138 * @return string
1139 */
1140function media_getTag($tags,$meta,$alt=''){
1141    if($meta === false) return $alt;
1142    $info = $meta->getField($tags);
1143    if($info == false) return $alt;
1144    return $info;
1145}
1146
1147/**
1148 * Returns mediafile tags
1149 *
1150 * @author Kate Arzamastseva <pshns@ukr.net>
1151 *
1152 * @param JpegMeta $meta
1153 * @return array list of tags of the mediafile
1154 */
1155function media_file_tags($meta) {
1156    // load the field descriptions
1157    static $fields = null;
1158    if(is_null($fields)){
1159        $config_files = getConfigFiles('mediameta');
1160        foreach ($config_files as $config_file) {
1161            if(file_exists($config_file)) include($config_file);
1162        }
1163    }
1164
1165    $tags = array();
1166
1167    foreach($fields as $key => $tag){
1168        $t = array();
1169        if (!empty($tag[0])) $t = array($tag[0]);
1170        if(isset($tag[3]) && is_array($tag[3])) $t = array_merge($t,$tag[3]);
1171        $value = media_getTag($t, $meta);
1172        $tags[] = array('tag' => $tag, 'value' => $value);
1173    }
1174
1175    return $tags;
1176}
1177
1178/**
1179 * Prints mediafile tags
1180 *
1181 * @author Kate Arzamastseva <pshns@ukr.net>
1182 *
1183 * @param string        $image image id
1184 * @param int           $auth  permission level
1185 * @param string|int    $rev   revision timestamp, or empty string
1186 * @param bool|JpegMeta $meta  image object, or create one if false
1187 */
1188function media_details($image, $auth, $rev='', $meta=false) {
1189    global $lang;
1190
1191    if (!$meta) $meta = new JpegMeta(mediaFN($image, $rev));
1192    $tags = media_file_tags($meta);
1193
1194    echo '<dl>'.NL;
1195    foreach($tags as $tag){
1196        if ($tag['value']) {
1197            $value = cleanText($tag['value']);
1198            echo '<dt>'.$lang[$tag['tag'][1]].'</dt><dd>';
1199            if ($tag['tag'][2] == 'date') echo dformat($value);
1200            else echo hsc($value);
1201            echo '</dd>'.NL;
1202        }
1203    }
1204    echo '</dl>'.NL;
1205    echo '<dl>'.NL;
1206    echo '<dt>'.$lang['reference'].':</dt>';
1207    $media_usage = ft_mediause($image,true);
1208    if(count($media_usage) > 0){
1209        foreach($media_usage as $path){
1210            echo '<dd>'.html_wikilink($path).'</dd>';
1211        }
1212    }else{
1213        echo '<dd>'.$lang['nothingfound'].'</dd>';
1214    }
1215    echo '</dl>'.NL;
1216
1217}
1218
1219/**
1220 * Shows difference between two revisions of file
1221 *
1222 * @author Kate Arzamastseva <pshns@ukr.net>
1223 *
1224 * @param string $image  image id
1225 * @param string $ns
1226 * @param int $auth permission level
1227 * @param bool $fromajax
1228 * @return false|null|string
1229 */
1230function media_diff($image, $ns, $auth, $fromajax = false) {
1231    global $conf;
1232    global $INPUT;
1233
1234    if ($auth < AUTH_READ || !$image || !$conf['mediarevisions']) return '';
1235
1236    $rev1 = $INPUT->int('rev');
1237
1238    $rev2 = $INPUT->ref('rev2');
1239    if(is_array($rev2)){
1240        $rev1 = (int) $rev2[0];
1241        $rev2 = (int) $rev2[1];
1242
1243        if(!$rev1){
1244            $rev1 = $rev2;
1245            unset($rev2);
1246        }
1247    }else{
1248        $rev2 = $INPUT->int('rev2');
1249    }
1250
1251    if ($rev1 && !file_exists(mediaFN($image, $rev1))) $rev1 = false;
1252    if ($rev2 && !file_exists(mediaFN($image, $rev2))) $rev2 = false;
1253
1254    if($rev1 && $rev2){            // two specific revisions wanted
1255        // make sure order is correct (older on the left)
1256        if($rev1 < $rev2){
1257            $l_rev = $rev1;
1258            $r_rev = $rev2;
1259        }else{
1260            $l_rev = $rev2;
1261            $r_rev = $rev1;
1262        }
1263    }elseif($rev1){                // single revision given, compare to current
1264        $r_rev = '';
1265        $l_rev = $rev1;
1266    }else{                        // no revision was given, compare previous to current
1267        $r_rev = '';
1268        $medialog = new MediaChangeLog($image);
1269        $revs = $medialog->getRevisions(0, 1);
1270        if (file_exists(mediaFN($image, $revs[0]))) {
1271            $l_rev = $revs[0];
1272        } else {
1273            $l_rev = '';
1274        }
1275    }
1276
1277    // prepare event data
1278    $data = array();
1279    $data[0] = $image;
1280    $data[1] = $l_rev;
1281    $data[2] = $r_rev;
1282    $data[3] = $ns;
1283    $data[4] = $auth;
1284    $data[5] = $fromajax;
1285
1286    // trigger event
1287    return Event::createAndTrigger('MEDIA_DIFF', $data, '_media_file_diff', true);
1288}
1289
1290/**
1291 * Callback for media file diff
1292 *
1293 * @param array $data event data
1294 * @return false|null
1295 */
1296function _media_file_diff($data) {
1297    if(is_array($data) && count($data)===6) {
1298        media_file_diff($data[0], $data[1], $data[2], $data[3], $data[4], $data[5]);
1299    } else {
1300        return false;
1301    }
1302}
1303
1304/**
1305 * Shows difference between two revisions of image
1306 *
1307 * @author Kate Arzamastseva <pshns@ukr.net>
1308 *
1309 * @param string $image
1310 * @param string|int $l_rev revision timestamp, or empty string
1311 * @param string|int $r_rev revision timestamp, or empty string
1312 * @param string $ns
1313 * @param int $auth permission level
1314 * @param bool $fromajax
1315 */
1316function media_file_diff($image, $l_rev, $r_rev, $ns, $auth, $fromajax) {
1317    global $lang;
1318    global $INPUT;
1319
1320    $l_meta = new JpegMeta(mediaFN($image, $l_rev));
1321    $r_meta = new JpegMeta(mediaFN($image, $r_rev));
1322
1323    $is_img = preg_match('/\.(jpe?g|gif|png)$/', $image);
1324    if ($is_img) {
1325        $l_size = media_image_preview_size($image, $l_rev, $l_meta);
1326        $r_size = media_image_preview_size($image, $r_rev, $r_meta);
1327        $is_img = ($l_size && $r_size && ($l_size[0] >= 30 || $r_size[0] >= 30));
1328
1329        $difftype = $INPUT->str('difftype');
1330
1331        if (!$fromajax) {
1332            $form = new Form([
1333                'id' => 'mediamanager__form_diffview',
1334                'action' => media_managerURL([], '&'),
1335                'method' => 'get',
1336                'class' => 'diffView',
1337            ]);
1338            $form->addTagOpen('div')->addClass('no');
1339            $form->setHiddenField('sectok', null);
1340            $form->setHiddenField('mediado', 'diff');
1341            $form->setHiddenField('rev2[0]', $l_rev);
1342            $form->setHiddenField('rev2[1]', $r_rev);
1343            $form->addTagClose('div');
1344            echo $form->toHTML();
1345
1346            echo NL.'<div id="mediamanager__diff" >'.NL;
1347        }
1348
1349        if ($difftype == 'opacity' || $difftype == 'portions') {
1350            media_image_diff($image, $l_rev, $r_rev, $l_size, $r_size, $difftype);
1351            if (!$fromajax) echo '</div>';
1352            return;
1353        }
1354    }
1355
1356    list($l_head, $r_head) = (new dokuwiki\Ui\Diff)->diffHead($l_rev, $r_rev, $image, true);
1357
1358    ?>
1359    <div class="table">
1360    <table>
1361      <tr>
1362        <th><?php echo $l_head; ?></th>
1363        <th><?php echo $r_head; ?></th>
1364      </tr>
1365    <?php
1366
1367    echo '<tr class="image">';
1368    echo '<td>';
1369    media_preview($image, $auth, $l_rev, $l_meta);
1370    echo '</td>';
1371
1372    echo '<td>';
1373    media_preview($image, $auth, $r_rev, $r_meta);
1374    echo '</td>';
1375    echo '</tr>'.NL;
1376
1377    echo '<tr class="actions">';
1378    echo '<td>';
1379    media_preview_buttons($image, $auth, $l_rev);
1380    echo '</td>';
1381
1382    echo '<td>';
1383    media_preview_buttons($image, $auth, $r_rev);
1384    echo '</td>';
1385    echo '</tr>'.NL;
1386
1387    $l_tags = media_file_tags($l_meta);
1388    $r_tags = media_file_tags($r_meta);
1389    // FIXME r_tags-only stuff
1390    foreach ($l_tags as $key => $l_tag) {
1391        if ($l_tag['value'] != $r_tags[$key]['value']) {
1392            $r_tags[$key]['highlighted'] = true;
1393            $l_tags[$key]['highlighted'] = true;
1394        } else if (!$l_tag['value'] || !$r_tags[$key]['value']) {
1395            unset($r_tags[$key]);
1396            unset($l_tags[$key]);
1397        }
1398    }
1399
1400    echo '<tr>';
1401    foreach(array($l_tags,$r_tags) as $tags){
1402        echo '<td>'.NL;
1403
1404        echo '<dl class="img_tags">';
1405        foreach($tags as $tag){
1406            $value = cleanText($tag['value']);
1407            if (!$value) $value = '-';
1408            echo '<dt>'.$lang[$tag['tag'][1]].'</dt>';
1409            echo '<dd>';
1410            if ($tag['highlighted']) {
1411                echo '<strong>';
1412            }
1413            if ($tag['tag'][2] == 'date') echo dformat($value);
1414            else echo hsc($value);
1415            if ($tag['highlighted']) {
1416                echo '</strong>';
1417            }
1418            echo '</dd>';
1419        }
1420        echo '</dl>'.NL;
1421
1422        echo '</td>';
1423    }
1424    echo '</tr>'.NL;
1425
1426    echo '</table>'.NL;
1427    echo '</div>'.NL;
1428
1429    if ($is_img && !$fromajax) echo '</div>';
1430}
1431
1432/**
1433 * Prints two images side by side
1434 * and slider
1435 *
1436 * @author Kate Arzamastseva <pshns@ukr.net>
1437 *
1438 * @param string $image   image id
1439 * @param int    $l_rev   revision timestamp, or empty string
1440 * @param int    $r_rev   revision timestamp, or empty string
1441 * @param array  $l_size  array with width and height
1442 * @param array  $r_size  array with width and height
1443 * @param string $type
1444 */
1445function media_image_diff($image, $l_rev, $r_rev, $l_size, $r_size, $type) {
1446    if ($l_size != $r_size) {
1447        if ($r_size[0] > $l_size[0]) {
1448            $l_size = $r_size;
1449        }
1450    }
1451
1452    $l_more = array('rev' => $l_rev, 'h' => $l_size[1], 'w' => $l_size[0]);
1453    $r_more = array('rev' => $r_rev, 'h' => $l_size[1], 'w' => $l_size[0]);
1454
1455    $l_src = ml($image, $l_more);
1456    $r_src = ml($image, $r_more);
1457
1458    // slider
1459    echo '<div class="slider" style="max-width: '.($l_size[0]-20).'px;" ></div>'.NL;
1460
1461    // two images in divs
1462    echo '<div class="imageDiff ' . $type . '">'.NL;
1463    echo '<div class="image1" style="max-width: '.$l_size[0].'px;">';
1464    echo '<img src="'.$l_src.'" alt="" />';
1465    echo '</div>'.NL;
1466    echo '<div class="image2" style="max-width: '.$l_size[0].'px;">';
1467    echo '<img src="'.$r_src.'" alt="" />';
1468    echo '</div>'.NL;
1469    echo '</div>'.NL;
1470}
1471
1472/**
1473 * Restores an old revision of a media file
1474 *
1475 * @param string $image media id
1476 * @param int    $rev   revision timestamp or empty string
1477 * @param int    $auth
1478 * @return string - file's id
1479 *
1480 * @author Kate Arzamastseva <pshns@ukr.net>
1481 */
1482function media_restore($image, $rev, $auth){
1483    global $conf;
1484    if ($auth < AUTH_UPLOAD || !$conf['mediarevisions']) return false;
1485    $removed = (!file_exists(mediaFN($image)) && file_exists(mediaMetaFN($image, '.changes')));
1486    if (!$image || (!file_exists(mediaFN($image)) && !$removed)) return false;
1487    if (!$rev || !file_exists(mediaFN($image, $rev))) return false;
1488    list(,$imime,) = mimetype($image);
1489    $res = media_upload_finish(mediaFN($image, $rev),
1490        mediaFN($image),
1491        $image,
1492        $imime,
1493        true,
1494        'copy');
1495    if (is_array($res)) {
1496        msg($res[0], $res[1]);
1497        return false;
1498    }
1499    return $res;
1500}
1501
1502/**
1503 * List all files found by the search request
1504 *
1505 * @author Tobias Sarnowski <sarnowski@cosmocode.de>
1506 * @author Andreas Gohr <gohr@cosmocode.de>
1507 * @author Kate Arzamastseva <pshns@ukr.net>
1508 * @triggers MEDIA_SEARCH
1509 *
1510 * @param string $query
1511 * @param string $ns
1512 * @param null|int $auth
1513 * @param bool $fullscreen
1514 * @param string $sort
1515 */
1516function media_searchlist($query,$ns,$auth=null,$fullscreen=false,$sort='natural'){
1517    global $conf;
1518    global $lang;
1519
1520    $ns = cleanID($ns);
1521    $evdata = array(
1522        'ns'    => $ns,
1523        'data'  => array(),
1524        'query' => $query
1525    );
1526    if (!blank($query)) {
1527        $evt = new Event('MEDIA_SEARCH', $evdata);
1528        if ($evt->advise_before()) {
1529            $dir = utf8_encodeFN(str_replace(':','/',$evdata['ns']));
1530            $quoted = preg_quote($evdata['query'],'/');
1531            //apply globbing
1532            $quoted = str_replace(array('\*', '\?'), array('.*', '.'), $quoted, $count);
1533
1534            //if we use globbing file name must match entirely but may be preceded by arbitrary namespace
1535            if ($count > 0) $quoted = '^([^:]*:)*'.$quoted.'$';
1536
1537            $pattern = '/'.$quoted.'/i';
1538            search($evdata['data'],
1539                    $conf['mediadir'],
1540                    'search_media',
1541                    array('showmsg'=>false,'pattern'=>$pattern),
1542                    $dir,
1543                    1,
1544                    $sort);
1545        }
1546        $evt->advise_after();
1547        unset($evt);
1548    }
1549
1550    if (!$fullscreen) {
1551        echo '<h1 id="media__ns">'.sprintf($lang['searchmedia_in'],hsc($ns).':*').'</h1>'.NL;
1552        media_searchform($ns,$query);
1553    }
1554
1555    if(!count($evdata['data'])){
1556        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
1557    }else {
1558        if ($fullscreen) {
1559            echo '<ul class="' . _media_get_list_type() . '">';
1560        }
1561        foreach($evdata['data'] as $item){
1562            if (!$fullscreen) media_printfile($item,$item['perm'],'',true);
1563            else media_printfile_thumbs($item,$item['perm'],false,true);
1564        }
1565        if ($fullscreen) echo '</ul>'.NL;
1566    }
1567}
1568
1569/**
1570 * Formats and prints one file in the list
1571 *
1572 * @param array     $item
1573 * @param int       $auth              permission level
1574 * @param string    $jump              item id
1575 * @param bool      $display_namespace
1576 */
1577function media_printfile($item,$auth,$jump,$display_namespace=false){
1578    global $lang;
1579
1580    // Prepare zebra coloring
1581    // I always wanted to use this variable name :-D
1582    static $twibble = 1;
1583    $twibble *= -1;
1584    $zebra = ($twibble == -1) ? 'odd' : 'even';
1585
1586    // Automatically jump to recent action
1587    if($jump == $item['id']) {
1588        $jump = ' id="scroll__here" ';
1589    }else{
1590        $jump = '';
1591    }
1592
1593    // Prepare fileicons
1594    list($ext) = mimetype($item['file'],false);
1595    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
1596    $class = 'select mediafile mf_'.$class;
1597
1598    // Prepare filename
1599    $file = utf8_decodeFN($item['file']);
1600
1601    // Prepare info
1602    $info = '';
1603    if($item['isimg']){
1604        $info .= (int) $item['meta']->getField('File.Width');
1605        $info .= '&#215;';
1606        $info .= (int) $item['meta']->getField('File.Height');
1607        $info .= ' ';
1608    }
1609    $info .= '<i>'.dformat($item['mtime']).'</i>';
1610    $info .= ' ';
1611    $info .= filesize_h($item['size']);
1612
1613    // output
1614    echo '<div class="'.$zebra.'"'.$jump.' title="'.hsc($item['id']).'">'.NL;
1615    if (!$display_namespace) {
1616        echo '<a id="h_:'.$item['id'].'" class="'.$class.'">'.hsc($file).'</a> ';
1617    } else {
1618        echo '<a id="h_:'.$item['id'].'" class="'.$class.'">'.hsc($item['id']).'</a><br/>';
1619    }
1620    echo '<span class="info">('.$info.')</span>'.NL;
1621
1622    // view button
1623    $link = ml($item['id'],'',true);
1624    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
1625        'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
1626
1627    // mediamanager button
1628    $link = wl('',array('do'=>'media','image'=>$item['id'],'ns'=>getNS($item['id'])));
1629    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/mediamanager.png" '.
1630        'alt="'.$lang['btn_media'].'" title="'.$lang['btn_media'].'" class="btn" /></a>';
1631
1632    // delete button
1633    if($item['writable'] && $auth >= AUTH_DELETE){
1634        $link = DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).
1635            '&amp;sectok='.getSecurityToken();
1636        echo ' <a href="'.$link.'" class="btn_media_delete" title="'.$item['id'].'">'.
1637            '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
1638            'title="'.$lang['btn_delete'].'" class="btn" /></a>';
1639    }
1640
1641    echo '<div class="example" id="ex_'.str_replace(':','_',$item['id']).'">';
1642    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
1643    echo '</div>';
1644    if($item['isimg']) media_printimgdetail($item);
1645    echo '<div class="clearer"></div>'.NL;
1646    echo '</div>'.NL;
1647}
1648
1649/**
1650 * Display a media icon
1651 *
1652 * @param string $filename media id
1653 * @param string $size     the size subfolder, if not specified 16x16 is used
1654 * @return string html
1655 */
1656function media_printicon($filename, $size=''){
1657    list($ext) = mimetype(mediaFN($filename),false);
1658
1659    if (file_exists(DOKU_INC.'lib/images/fileicons/'.$size.'/'.$ext.'.png')) {
1660        $icon = DOKU_BASE.'lib/images/fileicons/'.$size.'/'.$ext.'.png';
1661    } else {
1662        $icon = DOKU_BASE.'lib/images/fileicons/'.$size.'/file.png';
1663    }
1664
1665    return '<img src="'.$icon.'" alt="'.$filename.'" class="icon" />';
1666}
1667
1668/**
1669 * Formats and prints one file in the list in the thumbnails view
1670 *
1671 * @author Kate Arzamastseva <pshns@ukr.net>
1672 *
1673 * @param array       $item
1674 * @param int         $auth              permission level
1675 * @param bool|string $jump              item id
1676 * @param bool        $display_namespace
1677 */
1678function media_printfile_thumbs($item,$auth,$jump=false,$display_namespace=false){
1679
1680    // Prepare filename
1681    $file = utf8_decodeFN($item['file']);
1682
1683    // output
1684    echo '<li><dl title="'.hsc($item['id']).'">'.NL;
1685
1686        echo '<dt>';
1687    if($item['isimg']) {
1688        media_printimgdetail($item, true);
1689
1690    } else {
1691        echo '<a id="d_:'.$item['id'].'" class="image" title="'.$item['id'].'" href="'.
1692            media_managerURL(['image' => hsc($item['id']), 'ns' => getNS($item['id']),
1693            'tab_details' => 'view']).'">';
1694        echo media_printicon($item['id'], '32x32');
1695        echo '</a>';
1696    }
1697    echo '</dt>'.NL;
1698    if (!$display_namespace) {
1699        $name = hsc($file);
1700    } else {
1701        $name = hsc($item['id']);
1702    }
1703    echo '<dd class="name"><a href="'.media_managerURL(['image' => hsc($item['id']), 'ns' => getNS($item['id']),
1704        'tab_details' => 'view']).'" id="h_:'.$item['id'].'">'.$name.'</a></dd>'.NL;
1705
1706    if($item['isimg']){
1707        $size = '';
1708        $size .= (int) $item['meta']->getField('File.Width');
1709        $size .= '&#215;';
1710        $size .= (int) $item['meta']->getField('File.Height');
1711        echo '<dd class="size">'.$size.'</dd>'.NL;
1712    } else {
1713        echo '<dd class="size">&#160;</dd>'.NL;
1714    }
1715    $date = dformat($item['mtime']);
1716    echo '<dd class="date">'.$date.'</dd>'.NL;
1717    $filesize = filesize_h($item['size']);
1718    echo '<dd class="filesize">'.$filesize.'</dd>'.NL;
1719    echo '</dl></li>'.NL;
1720}
1721
1722/**
1723 * Prints a thumbnail and metainfo
1724 *
1725 * @param array $item
1726 * @param bool  $fullscreen
1727 */
1728function media_printimgdetail($item, $fullscreen=false){
1729    // prepare thumbnail
1730    $size = $fullscreen ? 90 : 120;
1731
1732    $w = (int) $item['meta']->getField('File.Width');
1733    $h = (int) $item['meta']->getField('File.Height');
1734    if($w>$size || $h>$size){
1735        if (!$fullscreen) {
1736            $ratio = $item['meta']->getResizeRatio($size);
1737        } else {
1738            $ratio = $item['meta']->getResizeRatio($size,$size);
1739        }
1740        $w = floor($w * $ratio);
1741        $h = floor($h * $ratio);
1742    }
1743    $src = ml($item['id'],array('w'=>$w,'h'=>$h,'t'=>$item['mtime']));
1744    $p = array();
1745    if (!$fullscreen) {
1746        // In fullscreen mediamanager view, image resizing is done via CSS.
1747        $p['width']  = $w;
1748        $p['height'] = $h;
1749    }
1750    $p['alt']    = $item['id'];
1751    $att = buildAttributes($p);
1752
1753    // output
1754    if ($fullscreen) {
1755        echo '<a id="l_:'.$item['id'].'" class="image thumb" href="'.
1756            media_managerURL(['image' => hsc($item['id']), 'ns' => getNS($item['id']), 'tab_details' => 'view']).'">';
1757        echo '<img src="'.$src.'" '.$att.' />';
1758        echo '</a>';
1759    }
1760
1761    if ($fullscreen) return;
1762
1763    echo '<div class="detail">';
1764    echo '<div class="thumb">';
1765    echo '<a id="d_:'.$item['id'].'" class="select">';
1766    echo '<img src="'.$src.'" '.$att.' />';
1767    echo '</a>';
1768    echo '</div>';
1769
1770    // read EXIF/IPTC data
1771    $t = $item['meta']->getField(array('IPTC.Headline','xmp.dc:title'));
1772    $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
1773                'EXIF.TIFFImageDescription',
1774                'EXIF.TIFFUserComment'));
1775    if(\dokuwiki\Utf8\PhpString::strlen($d) > 250) $d = \dokuwiki\Utf8\PhpString::substr($d,0,250).'...';
1776    $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category','xmp.dc:subject'));
1777
1778    // print EXIF/IPTC data
1779    if($t || $d || $k ){
1780        echo '<p>';
1781        if($t) echo '<strong>'.hsc($t).'</strong><br />';
1782        if($d) echo hsc($d).'<br />';
1783        if($t) echo '<em>'.hsc($k).'</em>';
1784        echo '</p>';
1785    }
1786    echo '</div>';
1787}
1788
1789/**
1790 * Build link based on the current, adding/rewriting parameters
1791 *
1792 * @author Kate Arzamastseva <pshns@ukr.net>
1793 *
1794 * @param array|bool $params
1795 * @param string     $amp           separator
1796 * @param bool       $abs           absolute url?
1797 * @param bool       $params_array  return the parmeters array?
1798 * @return string|array - link or link parameters
1799 */
1800function media_managerURL($params = false, $amp = '&amp;', $abs = false, $params_array = false) {
1801    global $ID;
1802    global $INPUT;
1803
1804    $gets = array('do' => 'media');
1805    $media_manager_params = array('tab_files', 'tab_details', 'image', 'ns', 'list', 'sort');
1806    foreach ($media_manager_params as $x) {
1807        if ($INPUT->has($x)) $gets[$x] = $INPUT->str($x);
1808    }
1809
1810    if ($params) {
1811        $gets = $params + $gets;
1812    }
1813    unset($gets['id']);
1814    if (isset($gets['delete'])) {
1815        unset($gets['image']);
1816        unset($gets['tab_details']);
1817    }
1818
1819    if ($params_array) return $gets;
1820
1821    return wl($ID,$gets,$abs,$amp);
1822}
1823
1824/**
1825 * Print the media upload form if permissions are correct
1826 *
1827 * @author Andreas Gohr <andi@splitbrain.org>
1828 * @author Kate Arzamastseva <pshns@ukr.net>
1829 *
1830 * @param string $ns
1831 * @param int    $auth permission level
1832 * @param bool  $fullscreen
1833 */
1834function media_uploadform($ns, $auth, $fullscreen = false) {
1835    global $lang;
1836    global $conf;
1837    global $INPUT;
1838
1839    if ($auth < AUTH_UPLOAD) {
1840        echo '<div class="nothing">'.$lang['media_perm_upload'].'</div>'.NL;
1841        return;
1842    }
1843    $auth_ow = (($conf['mediarevisions']) ? AUTH_UPLOAD : AUTH_DELETE);
1844
1845    $update = false;
1846    $id = '';
1847    if ($auth >= $auth_ow && $fullscreen && $INPUT->str('mediado') == 'update') {
1848        $update = true;
1849        $id = cleanID($INPUT->str('image'));
1850    }
1851
1852    // The default HTML upload form
1853    $form = new Form([
1854        'id' => 'dw__upload',
1855        'enctype' => 'multipart/form-data',
1856        'action' => ($fullscreen)
1857                    ? media_managerURL(['tab_files' => 'files', 'tab_details' => 'view'], '&')
1858                    : DOKU_BASE.'lib/exe/mediamanager.php',
1859    ]);
1860    $form->addTagOpen('div')->addClass('no');
1861    $form->setHiddenField('ns', hsc($ns));  // FIXME hsc required?
1862    $form->addTagOpen('p');
1863    $form->addTextInput('upload', $lang['txt_upload'])->id('upload__file')
1864            ->attrs(['type' => 'file']);
1865    $form->addTagClose('p');
1866    $form->addTagOpen('p');
1867    $form->addTextInput('mediaid', $lang['txt_filename'])->id('upload__name')
1868            ->val(noNS($id));
1869    $form->addButton('', $lang['btn_upload'])->attr('type', 'submit');
1870    $form->addTagClose('p');
1871    if ($auth >= $auth_ow){
1872        $form->addTagOpen('p');
1873        $attrs = array();
1874        if ($update) $attrs['checked'] = 'checked';
1875        $form->addCheckbox('ow', $lang['txt_overwrt'])->id('dw__ow')->val('1')
1876            ->addClass('check')->attrs($attrs);
1877        $form->addTagClose('p');
1878    }
1879    $form->addTagClose('div');
1880
1881    if (!$fullscreen) {
1882        echo '<div class="upload">'. $lang['mediaupload'] .'</div>'.DOKU_LF;
1883    } else {
1884        echo DOKU_LF;
1885    }
1886
1887    echo '<div id="mediamanager__uploader">'.DOKU_LF;
1888    echo $form->toHTML('Upload');
1889    echo '</div>'.DOKU_LF;
1890
1891    echo '<p class="maxsize">';
1892    printf($lang['maxuploadsize'], filesize_h(media_getuploadsize()));
1893    echo ' <a class="allowedmime" href="#">'. $lang['allowedmime'] .'</a>';
1894    echo ' <span>'. implode(', ', array_keys(getMimeTypes())) .'</span>';
1895    echo '</p>'.DOKU_LF;
1896}
1897
1898/**
1899 * Returns the size uploaded files may have
1900 *
1901 * This uses a conservative approach using the lowest number found
1902 * in any of the limiting ini settings
1903 *
1904 * @returns int size in bytes
1905 */
1906function media_getuploadsize(){
1907    $okay = 0;
1908
1909    $post = (int) php_to_byte(@ini_get('post_max_size'));
1910    $suho = (int) php_to_byte(@ini_get('suhosin.post.max_value_length'));
1911    $upld = (int) php_to_byte(@ini_get('upload_max_filesize'));
1912
1913    if($post && ($post < $okay || $okay == 0)) $okay = $post;
1914    if($suho && ($suho < $okay || $okay == 0)) $okay = $suho;
1915    if($upld && ($upld < $okay || $okay == 0)) $okay = $upld;
1916
1917    return $okay;
1918}
1919
1920/**
1921 * Print the search field form
1922 *
1923 * @author Tobias Sarnowski <sarnowski@cosmocode.de>
1924 * @author Kate Arzamastseva <pshns@ukr.net>
1925 *
1926 * @param string $ns
1927 * @param string $query
1928 * @param bool $fullscreen
1929 */
1930function media_searchform($ns, $query = '', $fullscreen = false) {
1931    global $lang;
1932
1933    // The default HTML search form
1934    $form = new Form([
1935        'id'     => 'dw__mediasearch',
1936        'action' => ($fullscreen)
1937                    ? media_managerURL([], '&')
1938                    : DOKU_BASE.'lib/exe/mediamanager.php',
1939    ]);
1940    $form->addTagOpen('div')->addClass('no');
1941    $form->setHiddenField('ns', $ns);
1942    $form->setHiddenField($fullscreen ? 'mediado' : 'do', 'searchlist');
1943
1944    $form->addTagOpen('p');
1945    $form->addTextInput('q', $lang['searchmedia'])
1946            ->attr('title', sprintf($lang['searchmedia_in'], hsc($ns) .':*'))
1947            ->val($query);
1948    $form->addHTML(' ');
1949    $form->addButton('', $lang['btn_search'])->attr('type', 'submit');
1950    $form->addTagClose('p');
1951    $form->addTagClose('div');
1952    print $form->toHTML('SearchMedia');
1953}
1954
1955/**
1956 * Build a tree outline of available media namespaces
1957 *
1958 * @author Andreas Gohr <andi@splitbrain.org>
1959 *
1960 * @param string $ns
1961 */
1962function media_nstree($ns){
1963    global $conf;
1964    global $lang;
1965
1966    // currently selected namespace
1967    $ns  = cleanID($ns);
1968    if(empty($ns)){
1969        global $ID;
1970        $ns = (string)getNS($ID);
1971    }
1972
1973    $ns_dir  = utf8_encodeFN(str_replace(':','/',$ns));
1974
1975    $data = array();
1976    search($data,$conf['mediadir'],'search_index',array('ns' => $ns_dir, 'nofiles' => true));
1977
1978    // wrap a list with the root level around the other namespaces
1979    array_unshift($data, array('level' => 0, 'id' => '', 'open' =>'true',
1980                               'label' => '['.$lang['mediaroot'].']'));
1981
1982    // insert the current ns into the hierarchy if it isn't already part of it
1983    $ns_parts = explode(':', $ns);
1984    $tmp_ns = '';
1985    $pos = 0;
1986    foreach ($ns_parts as $level => $part) {
1987        if ($tmp_ns) $tmp_ns .= ':'.$part;
1988        else $tmp_ns = $part;
1989
1990        // find the namespace parts or insert them
1991        while ($data[$pos]['id'] != $tmp_ns) {
1992            if (
1993                $pos >= count($data) ||
1994                ($data[$pos]['level'] <= $level+1 && Sort::strcmp($data[$pos]['id'], $tmp_ns) > 0)
1995            ) {
1996                array_splice($data, $pos, 0, array(array('level' => $level+1, 'id' => $tmp_ns, 'open' => 'true')));
1997                break;
1998            }
1999            ++$pos;
2000        }
2001    }
2002
2003    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
2004}
2005
2006/**
2007 * Userfunction for html_buildlist
2008 *
2009 * Prints a media namespace tree item
2010 *
2011 * @author Andreas Gohr <andi@splitbrain.org>
2012 *
2013 * @param array $item
2014 * @return string html
2015 */
2016function media_nstree_item($item){
2017    global $INPUT;
2018    $pos   = strrpos($item['id'], ':');
2019    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
2020    if(empty($item['label'])) $item['label'] = $label;
2021
2022    $ret  = '';
2023    if (!($INPUT->str('do') == 'media'))
2024    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
2025    else $ret .= '<a href="'.media_managerURL(['ns' => idfilter($item['id'], false), 'tab_files' => 'files'])
2026        .'" class="idx_dir">';
2027    $ret .= $item['label'];
2028    $ret .= '</a>';
2029    return $ret;
2030}
2031
2032/**
2033 * Userfunction for html_buildlist
2034 *
2035 * Prints a media namespace tree item opener
2036 *
2037 * @author Andreas Gohr <andi@splitbrain.org>
2038 *
2039 * @param array $item
2040 * @return string html
2041 */
2042function media_nstree_li($item){
2043    $class='media level'.$item['level'];
2044    if($item['open']){
2045        $class .= ' open';
2046        $img   = DOKU_BASE.'lib/images/minus.gif';
2047        $alt   = '−';
2048    }else{
2049        $class .= ' closed';
2050        $img   = DOKU_BASE.'lib/images/plus.gif';
2051        $alt   = '+';
2052    }
2053    // TODO: only deliver an image if it actually has a subtree...
2054    return '<li class="'.$class.'">'.
2055        '<img src="'.$img.'" alt="'.$alt.'" />';
2056}
2057
2058/**
2059 * Resizes the given image to the given size
2060 *
2061 * @author  Andreas Gohr <andi@splitbrain.org>
2062 *
2063 * @param string $file filename, path to file
2064 * @param string $ext  extension
2065 * @param int    $w    desired width
2066 * @param int    $h    desired height
2067 * @return string path to resized or original size if failed
2068 */
2069function media_resize_image($file, $ext, $w, $h=0){
2070    global $conf;
2071    if(!$h) $h = $w;
2072    // we wont scale up to infinity
2073    if($w > 2000 || $h > 2000) return $file;
2074
2075    //cache
2076    $local = getCacheName($file,'.media.'.$w.'x'.$h.'.'.$ext);
2077    $mtime = (int) @filemtime($local); // 0 if not exists
2078
2079    $options = [
2080        'quality' => $conf['jpg_quality'],
2081        'imconvert' => $conf['im_convert'],
2082    ];
2083
2084    if( $mtime <= (int) @filemtime($file) ) {
2085        try {
2086            \splitbrain\slika\Slika::run($file, $options)
2087                                   ->autorotate()
2088                                   ->resize($w, $h)
2089                                   ->save($local, $ext);
2090            if($conf['fperm']) @chmod($local, $conf['fperm']);
2091        } catch (\splitbrain\slika\Exception $e) {
2092            dbglog($e->getMessage());
2093            return $file;
2094        }
2095    }
2096
2097    return $local;
2098}
2099
2100/**
2101 * Center crops the given image to the wanted size
2102 *
2103 * @author  Andreas Gohr <andi@splitbrain.org>
2104 *
2105 * @param string $file filename, path to file
2106 * @param string $ext  extension
2107 * @param int    $w    desired width
2108 * @param int    $h    desired height
2109 * @return string path to resized or original size if failed
2110 */
2111function media_crop_image($file, $ext, $w, $h=0){
2112    global $conf;
2113    if(!$h) $h = $w;
2114    // we wont scale up to infinity
2115    if($w > 2000 || $h > 2000) return $file;
2116
2117    //cache
2118    $local = getCacheName($file,'.media.'.$w.'x'.$h.'.crop.'.$ext);
2119    $mtime = (int) @filemtime($local); // 0 if not exists
2120
2121    $options = [
2122        'quality' => $conf['jpg_quality'],
2123        'imconvert' => $conf['im_convert'],
2124    ];
2125
2126    if( $mtime <= (int) @filemtime($file) ) {
2127        try {
2128            \splitbrain\slika\Slika::run($file, $options)
2129                                   ->autorotate()
2130                                    ->crop($w, $h)
2131                                    ->save($local, $ext);
2132            if($conf['fperm']) @chmod($local, $conf['fperm']);
2133        } catch (\splitbrain\slika\Exception $e) {
2134            dbglog($e->getMessage());
2135            return $file;
2136        }
2137    }
2138
2139    return $local;
2140}
2141
2142/**
2143 * Calculate a token to be used to verify fetch requests for resized or
2144 * cropped images have been internally generated - and prevent external
2145 * DDOS attacks via fetch
2146 *
2147 * @author Christopher Smith <chris@jalakai.co.uk>
2148 *
2149 * @param string  $id    id of the image
2150 * @param int     $w     resize/crop width
2151 * @param int     $h     resize/crop height
2152 * @return string token or empty string if no token required
2153 */
2154function media_get_token($id,$w,$h){
2155    // token is only required for modified images
2156    if ($w || $h || media_isexternal($id)) {
2157        $token = $id;
2158        if ($w) $token .= '.'.$w;
2159        if ($h) $token .= '.'.$h;
2160
2161        return substr(\dokuwiki\PassHash::hmac('md5', $token, auth_cookiesalt()),0,6);
2162    }
2163
2164    return '';
2165}
2166
2167/**
2168 * Download a remote file and return local filename
2169 *
2170 * returns false if download fails. Uses cached file if available and
2171 * wanted
2172 *
2173 * @author  Andreas Gohr <andi@splitbrain.org>
2174 * @author  Pavel Vitis <Pavel.Vitis@seznam.cz>
2175 *
2176 * @param string $url
2177 * @param string $ext   extension
2178 * @param int    $cache cachetime in seconds
2179 * @return false|string path to cached file
2180 */
2181function media_get_from_URL($url,$ext,$cache){
2182    global $conf;
2183
2184    // if no cache or fetchsize just redirect
2185    if ($cache==0)           return false;
2186    if (!$conf['fetchsize']) return false;
2187
2188    $local = getCacheName(strtolower($url),".media.$ext");
2189    $mtime = @filemtime($local); // 0 if not exists
2190
2191    //decide if download needed:
2192    if(($mtime == 0) || // cache does not exist
2193        ($cache != -1 && $mtime < time() - $cache) // 'recache' and cache has expired
2194    ) {
2195        if(media_image_download($url, $local)) {
2196            return $local;
2197        } else {
2198            return false;
2199        }
2200    }
2201
2202    //if cache exists use it else
2203    if($mtime) return $local;
2204
2205    //else return false
2206    return false;
2207}
2208
2209/**
2210 * Download image files
2211 *
2212 * @author Andreas Gohr <andi@splitbrain.org>
2213 *
2214 * @param string $url
2215 * @param string $file path to file in which to put the downloaded content
2216 * @return bool
2217 */
2218function media_image_download($url,$file){
2219    global $conf;
2220    $http = new DokuHTTPClient();
2221    $http->keep_alive = false; // we do single ops here, no need for keep-alive
2222
2223    $http->max_bodysize = $conf['fetchsize'];
2224    $http->timeout = 25; //max. 25 sec
2225    $http->header_regexp = '!\r\nContent-Type: image/(jpe?g|gif|png)!i';
2226
2227    $data = $http->get($url);
2228    if(!$data) return false;
2229
2230    $fileexists = file_exists($file);
2231    $fp = @fopen($file,"w");
2232    if(!$fp) return false;
2233    fwrite($fp,$data);
2234    fclose($fp);
2235    if(!$fileexists and $conf['fperm']) chmod($file, $conf['fperm']);
2236
2237    // check if it is really an image
2238    $info = @getimagesize($file);
2239    if(!$info){
2240        @unlink($file);
2241        return false;
2242    }
2243
2244    return true;
2245}
2246
2247/**
2248 * resize images using external ImageMagick convert program
2249 *
2250 * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
2251 * @author Andreas Gohr <andi@splitbrain.org>
2252 *
2253 * @param string $ext     extension
2254 * @param string $from    filename path to file
2255 * @param int    $from_w  original width
2256 * @param int    $from_h  original height
2257 * @param string $to      path to resized file
2258 * @param int    $to_w    desired width
2259 * @param int    $to_h    desired height
2260 * @return bool
2261 */
2262function media_resize_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h){
2263    global $conf;
2264
2265    // check if convert is configured
2266    if(!$conf['im_convert']) return false;
2267
2268    // prepare command
2269    $cmd  = $conf['im_convert'];
2270    $cmd .= ' -resize '.$to_w.'x'.$to_h.'!';
2271    if ($ext == 'jpg' || $ext == 'jpeg') {
2272        $cmd .= ' -quality '.$conf['jpg_quality'];
2273    }
2274    $cmd .= " $from $to";
2275
2276    @exec($cmd,$out,$retval);
2277    if ($retval == 0) return true;
2278    return false;
2279}
2280
2281/**
2282 * crop images using external ImageMagick convert program
2283 *
2284 * @author Andreas Gohr <andi@splitbrain.org>
2285 *
2286 * @param string $ext     extension
2287 * @param string $from    filename path to file
2288 * @param int    $from_w  original width
2289 * @param int    $from_h  original height
2290 * @param string $to      path to resized file
2291 * @param int    $to_w    desired width
2292 * @param int    $to_h    desired height
2293 * @param int    $ofs_x   offset of crop centre
2294 * @param int    $ofs_y   offset of crop centre
2295 * @return bool
2296 * @deprecated 2020-09-01
2297 */
2298function media_crop_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x,$ofs_y){
2299    global $conf;
2300    dbg_deprecated('splitbrain\\Slika');
2301
2302    // check if convert is configured
2303    if(!$conf['im_convert']) return false;
2304
2305    // prepare command
2306    $cmd  = $conf['im_convert'];
2307    $cmd .= ' -crop '.$to_w.'x'.$to_h.'+'.$ofs_x.'+'.$ofs_y;
2308    if ($ext == 'jpg' || $ext == 'jpeg') {
2309        $cmd .= ' -quality '.$conf['jpg_quality'];
2310    }
2311    $cmd .= " $from $to";
2312
2313    @exec($cmd,$out,$retval);
2314    if ($retval == 0) return true;
2315    return false;
2316}
2317
2318/**
2319 * resize or crop images using PHP's libGD support
2320 *
2321 * @author Andreas Gohr <andi@splitbrain.org>
2322 * @author Sebastian Wienecke <s_wienecke@web.de>
2323 *
2324 * @param string $ext     extension
2325 * @param string $from    filename path to file
2326 * @param int    $from_w  original width
2327 * @param int    $from_h  original height
2328 * @param string $to      path to resized file
2329 * @param int    $to_w    desired width
2330 * @param int    $to_h    desired height
2331 * @param int    $ofs_x   offset of crop centre
2332 * @param int    $ofs_y   offset of crop centre
2333 * @return bool
2334 * @deprecated 2020-09-01
2335 */
2336function media_resize_imageGD($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x=0,$ofs_y=0){
2337    global $conf;
2338    dbg_deprecated('splitbrain\\Slika');
2339
2340    if($conf['gdlib'] < 1) return false; //no GDlib available or wanted
2341
2342    // check available memory
2343    if(!is_mem_available(($from_w * $from_h * 4) + ($to_w * $to_h * 4))){
2344        return false;
2345    }
2346
2347    // create an image of the given filetype
2348    $image = false;
2349    if ($ext == 'jpg' || $ext == 'jpeg'){
2350        if(!function_exists("imagecreatefromjpeg")) return false;
2351        $image = @imagecreatefromjpeg($from);
2352    }elseif($ext == 'png') {
2353        if(!function_exists("imagecreatefrompng")) return false;
2354        $image = @imagecreatefrompng($from);
2355
2356    }elseif($ext == 'gif') {
2357        if(!function_exists("imagecreatefromgif")) return false;
2358        $image = @imagecreatefromgif($from);
2359    }
2360    if(!$image) return false;
2361
2362    $newimg = false;
2363    if(($conf['gdlib']>1) && function_exists("imagecreatetruecolor") && $ext != 'gif'){
2364        $newimg = @imagecreatetruecolor ($to_w, $to_h);
2365    }
2366    if(!$newimg) $newimg = @imagecreate($to_w, $to_h);
2367    if(!$newimg){
2368        imagedestroy($image);
2369        return false;
2370    }
2371
2372    //keep png alpha channel if possible
2373    if($ext == 'png' && $conf['gdlib']>1 && function_exists('imagesavealpha')){
2374        imagealphablending($newimg, false);
2375        imagesavealpha($newimg,true);
2376    }
2377
2378    //keep gif transparent color if possible
2379    if($ext == 'gif' && function_exists('imagefill') && function_exists('imagecolorallocate')) {
2380        if(function_exists('imagecolorsforindex') && function_exists('imagecolortransparent')) {
2381            $transcolorindex = @imagecolortransparent($image);
2382            if($transcolorindex >= 0 ) { //transparent color exists
2383                $transcolor = @imagecolorsforindex($image, $transcolorindex);
2384                $transcolorindex = @imagecolorallocate(
2385                    $newimg,
2386                    $transcolor['red'],
2387                    $transcolor['green'],
2388                    $transcolor['blue']
2389                );
2390                @imagefill($newimg, 0, 0, $transcolorindex);
2391                @imagecolortransparent($newimg, $transcolorindex);
2392            }else{ //filling with white
2393                $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
2394                @imagefill($newimg, 0, 0, $whitecolorindex);
2395            }
2396        }else{ //filling with white
2397            $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
2398            @imagefill($newimg, 0, 0, $whitecolorindex);
2399        }
2400    }
2401
2402    //try resampling first
2403    if(function_exists("imagecopyresampled")){
2404        if(!@imagecopyresampled($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h)) {
2405            imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
2406        }
2407    }else{
2408        imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
2409    }
2410
2411    $okay = false;
2412    if ($ext == 'jpg' || $ext == 'jpeg'){
2413        if(!function_exists('imagejpeg')){
2414            $okay = false;
2415        }else{
2416            $okay = imagejpeg($newimg, $to, $conf['jpg_quality']);
2417        }
2418    }elseif($ext == 'png') {
2419        if(!function_exists('imagepng')){
2420            $okay = false;
2421        }else{
2422            $okay =  imagepng($newimg, $to);
2423        }
2424    }elseif($ext == 'gif') {
2425        if(!function_exists('imagegif')){
2426            $okay = false;
2427        }else{
2428            $okay = imagegif($newimg, $to);
2429        }
2430    }
2431
2432    // destroy GD image ressources
2433    if($image) imagedestroy($image);
2434    if($newimg) imagedestroy($newimg);
2435
2436    return $okay;
2437}
2438
2439/**
2440 * Return other media files with the same base name
2441 * but different extensions.
2442 *
2443 * @param string   $src     - ID of media file
2444 * @param string[] $exts    - alternative extensions to find other files for
2445 * @return array            - array(mime type => file ID)
2446 *
2447 * @author Anika Henke <anika@selfthinker.org>
2448 */
2449function media_alternativefiles($src, $exts){
2450
2451    $files = array();
2452    list($srcExt, /* $srcMime */) = mimetype($src);
2453    $filebase = substr($src, 0, -1 * (strlen($srcExt)+1));
2454
2455    foreach($exts as $ext) {
2456        $fileid = $filebase.'.'.$ext;
2457        $file = mediaFN($fileid);
2458        if(file_exists($file)) {
2459            list(/* $fileExt */, $fileMime) = mimetype($file);
2460            $files[$fileMime] = $fileid;
2461        }
2462    }
2463    return $files;
2464}
2465
2466/**
2467 * Check if video/audio is supported to be embedded.
2468 *
2469 * @param string $mime      - mimetype of media file
2470 * @param string $type      - type of media files to check ('video', 'audio', or null for all)
2471 * @return boolean
2472 *
2473 * @author Anika Henke <anika@selfthinker.org>
2474 */
2475function media_supportedav($mime, $type=NULL){
2476    $supportedAudio = array(
2477        'ogg' => 'audio/ogg',
2478        'mp3' => 'audio/mpeg',
2479        'wav' => 'audio/wav',
2480    );
2481    $supportedVideo = array(
2482        'webm' => 'video/webm',
2483        'ogv' => 'video/ogg',
2484        'mp4' => 'video/mp4',
2485    );
2486    if ($type == 'audio') {
2487        $supportedAv = $supportedAudio;
2488    } elseif ($type == 'video') {
2489        $supportedAv = $supportedVideo;
2490    } else {
2491        $supportedAv = array_merge($supportedAudio, $supportedVideo);
2492    }
2493    return in_array($mime, $supportedAv);
2494}
2495
2496/**
2497 * Return track media files with the same base name
2498 * but extensions that indicate kind and lang.
2499 * ie for foo.webm search foo.sub.lang.vtt, foo.cap.lang.vtt...
2500 *
2501 * @param string   $src     - ID of media file
2502 * @return array            - array(mediaID => array( kind, srclang ))
2503 *
2504 * @author Schplurtz le Déboulonné <Schplurtz@laposte.net>
2505 */
2506function media_trackfiles($src){
2507    $kinds=array(
2508        'sub' => 'subtitles',
2509        'cap' => 'captions',
2510        'des' => 'descriptions',
2511        'cha' => 'chapters',
2512        'met' => 'metadata'
2513    );
2514
2515    $files = array();
2516    $re='/\\.(sub|cap|des|cha|met)\\.([^.]+)\\.vtt$/';
2517    $baseid=pathinfo($src, PATHINFO_FILENAME);
2518    $pattern=mediaFN($baseid).'.*.*.vtt';
2519    $list=glob($pattern);
2520    foreach($list as $track) {
2521        if(preg_match($re, $track, $matches)){
2522            $files[$baseid.'.'.$matches[1].'.'.$matches[2].'.vtt']=array(
2523                $kinds[$matches[1]],
2524                $matches[2],
2525            );
2526        }
2527    }
2528    return $files;
2529}
2530
2531/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
2532