xref: /dokuwiki/inc/media.php (revision fa8e5c7713944541c907aea2b81c6a44382a15f0)
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
9if(!defined('DOKU_INC')) die('meh.');
10if(!defined('NL')) define('NL',"\n");
11
12/**
13 * Lists pages which currently use a media file selected for deletion
14 *
15 * References uses the same visual as search results and share
16 * their CSS tags except pagenames won't be links.
17 *
18 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
19 */
20function media_filesinuse($data,$id){
21    global $lang;
22    echo '<h1>'.$lang['reference'].' <code>'.hsc(noNS($id)).'</code></h1>';
23    echo '<p>'.hsc($lang['ref_inuse']).'</p>';
24
25    $hidden=0; //count of hits without read permission
26    foreach($data as $row){
27        if(auth_quickaclcheck($row) >= AUTH_READ && isVisiblePage($row)){
28            echo '<div class="search_result">';
29            echo '<span class="mediaref_ref">'.hsc($row).'</span>';
30            echo '</div>';
31        }else
32            $hidden++;
33    }
34    if ($hidden){
35        print '<div class="mediaref_hidden">'.$lang['ref_hidden'].'</div>';
36    }
37}
38
39/**
40 * Handles the saving of image meta data
41 *
42 * @author Andreas Gohr <andi@splitbrain.org>
43 * @author Kate Arzamastseva <pshns@ukr.net>
44 */
45function media_metasave($id,$auth,$data){
46    if($auth < AUTH_UPLOAD) return false;
47    if(!checkSecurityToken()) return false;
48    global $lang;
49    global $conf;
50    $src = mediaFN($id);
51
52    $meta = new JpegMeta($src);
53    $meta->_parseAll();
54
55    foreach($data as $key => $val){
56        $val=trim($val);
57        if(empty($val)){
58            $meta->deleteField($key);
59        }else{
60            $meta->setField($key,$val);
61        }
62    }
63
64    $old = @filemtime($src);
65    if(!@file_exists(mediaFN($id, $old)) && @file_exists($src)) {
66        // add old revision to the attic
67        media_saveOldRevision($id);
68    }
69
70    if($meta->save()){
71        if($conf['fperm']) chmod($src, $conf['fperm']);
72
73        $new = @filemtime($src);
74        // add a log entry to the media changelog
75        addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_EDIT, $lang['media_meta_edited']);
76
77        msg($lang['metasaveok'],1);
78        return $id;
79    }else{
80        msg($lang['metasaveerr'],-1);
81        return false;
82    }
83}
84
85/**
86 * Display the form to edit image meta data
87 *
88 * @author Andreas Gohr <andi@splitbrain.org>
89 * @author Kate Arzamastseva <pshns@ukr.net>
90 */
91function media_metaform($id,$auth,$fullscreen = false){
92    global $lang, $config_cascade;
93
94    if($auth < AUTH_UPLOAD) {
95        echo '<div class="nothing">'.$lang['media_perm_upload'].'</div>'.NL;
96        return false;
97    }
98
99    // load the field descriptions
100    static $fields = null;
101    if(is_null($fields)){
102        $config_files = getConfigFiles('mediameta');
103        foreach ($config_files as $config_file) {
104            if(@file_exists($config_file)) include($config_file);
105        }
106    }
107
108    $src = mediaFN($id);
109
110    // output
111    if (!$fullscreen) {
112        echo '<h1>'.hsc(noNS($id)).'</h1>'.NL;
113        $action = DOKU_BASE.'lib/exe/mediamanager.php';
114    } else {
115        $action = media_managerURL(array('tab_details' => 'view'), '&');
116    }
117    echo '<form action="'.$action.'" id="mediamanager__save_meta" accept-charset="utf-8" method="post" class="meta">'.NL;
118
119    formSecurityToken();
120    foreach($fields as $key => $field){
121        // get current value
122        if (empty($field[0])) continue;
123        $tags = array($field[0]);
124        if(is_array($field[3])) $tags = array_merge($tags,$field[3]);
125        $value = tpl_img_getTag($tags,'',$src);
126        $value = cleanText($value);
127
128        // prepare attributes
129        $p = array();
130        $p['class'] = 'edit';
131        $p['id']    = 'meta__'.$key;
132        $p['name']  = 'meta['.$field[0].']';
133
134        // put label
135        echo '<div class="metafield">';
136        echo '<label for="meta__'.$key.'">';
137        echo ($lang[$field[1]]) ? $lang[$field[1]] : $field[1];
138        echo ':</label>';
139
140        // put input field
141        if($field[2] == 'text'){
142            $p['value'] = $value;
143            $p['type']  = 'text';
144            $att = buildAttributes($p);
145            echo "<input $att/>".NL;
146        }else{
147            $att = buildAttributes($p);
148            echo "<textarea $att rows=\"6\" cols=\"50\">".formText($value).'</textarea>'.NL;
149        }
150        echo '</div>'.NL;
151    }
152    echo '<div class="buttons">'.NL;
153    echo '<input type="hidden" name="img" value="'.hsc($id).'" />'.NL;
154    if (!$fullscreen) {
155        $do = 'do';
156    } else {
157        echo '<input type="hidden" name="mediado" value="save" />';
158        $do = 'mediado';
159    }
160    echo '<input name="'.$do.'[save]" type="submit" value="'.$lang['btn_save'].
161        '" title="'.$lang['btn_save'].' [S]" accesskey="s" class="button" />'.NL;
162    if (!$fullscreen)
163    echo '<input name="do[cancel]" type="submit" value="'.$lang['btn_cancel'].
164        '" title="'.$lang['btn_cancel'].' [C]" accesskey="c" class="button" />'.NL;
165    echo '</div>'.NL;
166    echo '</form>'.NL;
167}
168
169/**
170 * Convenience function to check if a media file is still in use
171 *
172 * @author Michael Klier <chi@chimeric.de>
173 */
174function media_inuse($id) {
175    global $conf;
176    $mediareferences = array();
177    if($conf['refcheck']){
178        $mediareferences = ft_mediause($id,$conf['refshow']);
179        if(!count($mediareferences)) {
180            return false;
181        } else {
182            return $mediareferences;
183        }
184    } else {
185        return false;
186    }
187}
188
189define('DOKU_MEDIA_DELETED', 1);
190define('DOKU_MEDIA_NOT_AUTH', 2);
191define('DOKU_MEDIA_INUSE', 4);
192define('DOKU_MEDIA_EMPTY_NS', 8);
193
194/**
195 * Handles media file deletions
196 *
197 * If configured, checks for media references before deletion
198 *
199 * @author Andreas Gohr <andi@splitbrain.org>
200 * @return int One of: 0,
201                       DOKU_MEDIA_DELETED,
202                       DOKU_MEDIA_DELETED | DOKU_MEDIA_EMPTY_NS,
203                       DOKU_MEDIA_NOT_AUTH,
204                       DOKU_MEDIA_INUSE
205 */
206function media_delete($id,$auth){
207    global $lang;
208    if($auth < AUTH_DELETE) return DOKU_MEDIA_NOT_AUTH;
209    if(media_inuse($id)) return DOKU_MEDIA_INUSE;
210
211    $file = mediaFN($id);
212
213    // trigger an event - MEDIA_DELETE_FILE
214    $data['id']   = $id;
215    $data['name'] = basename($file);
216    $data['path'] = $file;
217    $data['size'] = (@file_exists($file)) ? filesize($file) : 0;
218
219    $data['unl'] = false;
220    $data['del'] = false;
221    $evt = new Doku_Event('MEDIA_DELETE_FILE',$data);
222    if ($evt->advise_before()) {
223        $old = @filemtime($file);
224        if(!@file_exists(mediaFN($id, $old)) && @file_exists($file)) {
225            // add old revision to the attic
226            media_saveOldRevision($id);
227        }
228
229        $data['unl'] = @unlink($file);
230        if($data['unl']){
231            addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE, $lang['deleted']);
232            $data['del'] = io_sweepNS($id,'mediadir');
233        }
234    }
235    $evt->advise_after();
236    unset($evt);
237
238    if($data['unl'] && $data['del']){
239        return DOKU_MEDIA_DELETED | DOKU_MEDIA_EMPTY_NS;
240    }
241
242    return $data['unl'] ? DOKU_MEDIA_DELETED : 0;
243}
244
245/**
246 * Handles media file uploads
247 *
248 * @author Andreas Gohr <andi@splitbrain.org>
249 * @author Michael Klier <chi@chimeric.de>
250 * @return mixed false on error, id of the new file on success
251 */
252function media_upload($ns,$auth){
253    if(!checkSecurityToken()) return false;
254    global $lang;
255
256    // get file and id
257    $id   = $_POST['mediaid'];
258    $file = $_FILES['upload'];
259    if(empty($id)) $id = $file['name'];
260
261    // check for errors (messages are done in lib/exe/mediamanager.php)
262    if($file['error']) return false;
263
264    // check extensions
265    list($fext,$fmime,$dl) = mimetype($file['name']);
266    list($iext,$imime,$dl) = mimetype($id);
267    if($fext && !$iext){
268        // no extension specified in id - read original one
269        $id   .= '.'.$fext;
270        $imime = $fmime;
271    }elseif($fext && $fext != $iext){
272        // extension was changed, print warning
273        msg(sprintf($lang['mediaextchange'],$fext,$iext));
274    }
275
276    $res = media_save(array('name' => $file['tmp_name'],
277                            'mime' => $imime,
278                            'ext'  => $iext), $ns.':'.$id,
279                      $_REQUEST['ow'], $auth, 'move_uploaded_file');
280    if (is_array($res)) {
281        msg($res[0], $res[1]);
282        return false;
283    }
284    return $res;
285}
286
287/**
288 * This generates an action event and delegates to _media_upload_action().
289 * Action plugins are allowed to pre/postprocess the uploaded file.
290 * (The triggered event is preventable.)
291 *
292 * Event data:
293 * $data[0]     fn_tmp: the temporary file name (read from $_FILES)
294 * $data[1]     fn: the file name of the uploaded file
295 * $data[2]     id: the future directory id of the uploaded file
296 * $data[3]     imime: the mimetype of the uploaded file
297 * $data[4]     overwrite: if an existing file is going to be overwritten
298 *
299 * @triggers MEDIA_UPLOAD_FINISH
300 */
301function media_save($file, $id, $ow, $auth, $move) {
302    if($auth < AUTH_UPLOAD) {
303        return array("You don't have permissions to upload files.", -1);
304    }
305
306    if (!isset($file['mime']) || !isset($file['ext'])) {
307        list($ext, $mime) = mimetype($id);
308        if (!isset($file['mime'])) {
309            $file['mime'] = $mime;
310        }
311        if (!isset($file['ext'])) {
312            $file['ext'] = $ext;
313        }
314    }
315
316    global $lang;
317
318    // get filename
319    $id   = cleanID($id,false,true);
320    $fn   = mediaFN($id);
321
322    // get filetype regexp
323    $types = array_keys(getMimeTypes());
324    $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types);
325    $regex = join('|',$types);
326
327    // because a temp file was created already
328    if(!preg_match('/\.('.$regex.')$/i',$fn)) {
329        return array($lang['uploadwrong'],-1);
330    }
331
332    //check for overwrite
333    $overwrite = @file_exists($fn);
334    if($overwrite && (!$ow || $auth < AUTH_DELETE)) {
335        return array($lang['uploadexist'], 0);
336    }
337    // check for valid content
338    $ok = media_contentcheck($file['name'], $file['mime']);
339    if($ok == -1){
340        return array(sprintf($lang['uploadbadcontent'],'.' . $file['ext']),-1);
341    }elseif($ok == -2){
342        return array($lang['uploadspam'],-1);
343    }elseif($ok == -3){
344        return array($lang['uploadxss'],-1);
345    }
346
347    // prepare event data
348    $data[0] = $file['name'];
349    $data[1] = $fn;
350    $data[2] = $id;
351    $data[3] = $file['mime'];
352    $data[4] = $overwrite;
353    $data[5] = $move;
354
355    // trigger event
356    return trigger_event('MEDIA_UPLOAD_FINISH', $data, '_media_upload_action', true);
357}
358
359/**
360 * Callback adapter for media_upload_finish()
361 * @author Michael Klier <chi@chimeric.de>
362 */
363function _media_upload_action($data) {
364    // fixme do further sanity tests of given data?
365    if(is_array($data) && count($data)===6) {
366        return media_upload_finish($data[0], $data[1], $data[2], $data[3], $data[4], $data[5]);
367    } else {
368        return false; //callback error
369    }
370}
371
372/**
373 * Saves an uploaded media file
374 *
375 * @author Andreas Gohr <andi@splitbrain.org>
376 * @author Michael Klier <chi@chimeric.de>
377 * @author Kate Arzamastseva <pshns@ukr.net>
378 */
379function media_upload_finish($fn_tmp, $fn, $id, $imime, $overwrite, $move = 'move_uploaded_file') {
380    global $conf;
381    global $lang;
382    global $REV;
383
384    $old = @filemtime($fn);
385    if(!@file_exists(mediaFN($id, $old)) && @file_exists($fn)) {
386        // add old revision to the attic if missing
387        media_saveOldRevision($id);
388    }
389
390    // prepare directory
391    io_createNamespace($id, 'media');
392
393    if($move($fn_tmp, $fn)) {
394        @clearstatcache(true,$fn);
395        $new = @filemtime($fn);
396        // Set the correct permission here.
397        // Always chmod media because they may be saved with different permissions than expected from the php umask.
398        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
399        chmod($fn, $conf['fmode']);
400        msg($lang['uploadsucc'],1);
401        media_notify($id,$fn,$imime);
402        // add a log entry to the media changelog
403        if ($REV){
404            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_REVERT, $lang['restored'], $REV);
405        } elseif ($overwrite) {
406            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_EDIT);
407        } else {
408            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_CREATE, $lang['created']);
409        }
410        return $id;
411    }else{
412        return array($lang['uploadfail'],-1);
413    }
414}
415
416/**
417 * Moves the current version of media file to the media_attic
418 * directory
419 *
420 * @author Kate Arzamastseva <pshns@ukr.net>
421 * @param string $id
422 * @return int - revision date
423 */
424function media_saveOldRevision($id){
425    global $conf;
426    $oldf = mediaFN($id);
427    if(!@file_exists($oldf)) return '';
428    $date = filemtime($oldf);
429    $newf = mediaFN($id,$date);
430    io_makeFileDir($newf);
431    if(copy($oldf, $newf)) {
432        // Set the correct permission here.
433        // Always chmod media because they may be saved with different permissions than expected from the php umask.
434        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
435        chmod($newf, $conf['fmode']);
436    }
437    return $date;
438}
439
440/**
441 * This function checks if the uploaded content is really what the
442 * mimetype says it is. We also do spam checking for text types here.
443 *
444 * We need to do this stuff because we can not rely on the browser
445 * to do this check correctly. Yes, IE is broken as usual.
446 *
447 * @author Andreas Gohr <andi@splitbrain.org>
448 * @link   http://www.splitbrain.org/blog/2007-02/12-internet_explorer_facilitates_cross_site_scripting
449 * @fixme  check all 26 magic IE filetypes here?
450 */
451function media_contentcheck($file,$mime){
452    global $conf;
453    if($conf['iexssprotect']){
454        $fh = @fopen($file, 'rb');
455        if($fh){
456            $bytes = fread($fh, 256);
457            fclose($fh);
458            if(preg_match('/<(script|a|img|html|body|iframe)[\s>]/i',$bytes)){
459                return -3;
460            }
461        }
462    }
463    if(substr($mime,0,6) == 'image/'){
464        $info = @getimagesize($file);
465        if($mime == 'image/gif' && $info[2] != 1){
466            return -1;
467        }elseif($mime == 'image/jpeg' && $info[2] != 2){
468            return -1;
469        }elseif($mime == 'image/png' && $info[2] != 3){
470            return -1;
471        }
472        # fixme maybe check other images types as well
473    }elseif(substr($mime,0,5) == 'text/'){
474        global $TEXT;
475        $TEXT = io_readFile($file);
476        if(checkwordblock()){
477            return -2;
478        }
479    }
480    return 0;
481}
482
483/**
484 * Send a notify mail on uploads
485 *
486 * @author Andreas Gohr <andi@splitbrain.org>
487 */
488function media_notify($id,$file,$mime){
489    global $lang;
490    global $conf;
491    global $INFO;
492    if(empty($conf['notify'])) return; //notify enabled?
493
494    $ip = clientIP();
495
496    $text = rawLocale('uploadmail');
497    $text = str_replace('@DATE@',dformat(),$text);
498    $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text);
499    $text = str_replace('@IPADDRESS@',$ip,$text);
500    $text = str_replace('@HOSTNAME@',gethostsbyaddrs($ip),$text);
501    $text = str_replace('@DOKUWIKIURL@',DOKU_URL,$text);
502    $text = str_replace('@USER@',$_SERVER['REMOTE_USER'],$text);
503    $text = str_replace('@MIME@',$mime,$text);
504    $text = str_replace('@MEDIA@',ml($id,'',true,'&',true),$text);
505    $text = str_replace('@SIZE@',filesize_h(filesize($file)),$text);
506
507    if(empty($conf['mailprefix'])) {
508        $subject = '['.$conf['title'].'] '.$lang['mail_upload'].' '.$id;
509    } else {
510        $subject = '['.$conf['mailprefix'].'] '.$lang['mail_upload'].' '.$id;
511    }
512
513    mail_send($conf['notify'],$subject,$text,$conf['mailfrom']);
514}
515
516/**
517 * List all files in a given Media namespace
518 */
519function media_filelist($ns,$auth=null,$jump='',$fullscreenview=false){
520    global $conf;
521    global $lang;
522    $ns = cleanID($ns);
523
524    // check auth our self if not given (needed for ajax calls)
525    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
526
527    if (!$fullscreenview) echo '<h1 id="media__ns">:'.hsc($ns).'</h1>'.NL;
528
529    if($auth < AUTH_READ){
530        // FIXME: print permission warning here instead?
531        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
532    }else{
533        if (!$fullscreenview) media_uploadform($ns, $auth);
534
535        $dir = utf8_encodeFN(str_replace(':','/',$ns));
536        $data = array();
537        search($data,$conf['mediadir'],'search_media',
538                array('showmsg'=>true,'depth'=>1),$dir);
539
540        if(!count($data)){
541            echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
542        }else foreach($data as $item){
543            if (!$fullscreenview) media_printfile($item,$auth,$jump);
544            else media_printfile_thumbs($item,$auth,$jump);
545        }
546    }
547    if (!$fullscreenview) media_searchform($ns);
548}
549
550/**
551 * Prints mediamanager tab
552 *
553 * @author Kate Arzamastseva <pshns@ukr.net>
554 * @param string $link
555 * @param string $class
556 * @param string $name
557 * @param string $selected
558 */
559function media_tab($link, $class, $name, $selected=false) {
560    if (!empty($selected) && $selected == $class) $class .= ' selected';
561    $tab = '<a href="'.$link.'" class="'.$class.'" >'.$name.'</a>';
562    echo $tab;
563}
564
565/**
566 * Prints tabs for files list actions
567 *
568 * @author Kate Arzamastseva <pshns@ukr.net>
569 * @param string $selected - opened tab
570 */
571function media_tabs_files($selected=false){
572    global $lang;
573
574    echo '<div class="mediamanager-tabs" id="mediamanager__tabs_files">';
575
576    media_tab(media_managerURL(array('tab_files' => 'files')), 'files', $lang['mediaselect'], $selected);
577    media_tab(media_managerURL(array('tab_files' => 'upload')), 'upload', $lang['media_uploadtab'], $selected);
578    media_tab(media_managerURL(array('tab_files' => 'search')), 'search', $lang['media_searchtab'], $selected);
579
580    echo '<div class="clearer"></div>';
581    echo '</div>';
582}
583
584/**
585 * Prints tabs for files details actions
586 *
587 * @author Kate Arzamastseva <pshns@ukr.net>
588 * @param string $selected - opened tab
589 */
590function media_tabs_details($image, $selected=false){
591    global $lang;
592
593    echo '<div class="mediamanager-tabs" id="mediamanager__tabs_details">';
594
595    media_tab(media_managerURL(array('tab_details' => 'view')), 'view', $lang['media_viewtab'], $selected);
596
597    list($ext, $mime) = mimetype($image);
598    if ($mime == 'image/jpeg') {
599        media_tab(media_managerURL(array('tab_details' => 'edit')), 'edit', $lang['media_edittab'], $selected);
600    }
601    media_tab(media_managerURL(array('tab_details' => 'history')), 'history', $lang['media_historytab'], $selected);
602
603    echo '<div class="clearer"></div>';
604    echo '</div>';
605}
606
607/**
608 * Prints options for the tab that displays a list of all files
609 *
610 * @author Kate Arzamastseva <pshns@ukr.net>
611 */
612function media_tab_files_options($ns){
613    global $lang;
614
615    echo '<div class="background-container">';
616    echo $ns;
617
618    echo '<div id="mediamanager__tabs_list">';
619
620    echo '<a href="'.media_managerURL(array('view' => 'thumbs')).'" id="mediamanager__link_thumbs" >';
621    echo $lang['media_thumbsview'];
622    echo '</a>';
623
624    echo '<a href="'.media_managerURL(array('view' => 'list')).'" id="mediamanager__link_list" >';
625    echo $lang['media_listview'];
626    echo '</a>';
627
628    echo '</div>';
629
630    echo '<div id="mediamanager__sort">';
631    echo $lang['media_sort'];
632    echo '</div>';
633
634    echo '<div class="clearer"></div>';
635    echo '</div>';
636}
637
638/**
639 * Prints tab that displays a list of all files
640 *
641 * @author Kate Arzamastseva <pshns@ukr.net>
642 */
643function media_tab_files($ns,$auth=null,$jump='') {
644    global $lang;
645    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
646
647    media_tab_files_options($ns);
648
649    echo '<div class="scroll-container" >';
650    $view = $_REQUEST['view'];
651    if($auth < AUTH_READ){
652        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
653    }else{
654        if ($view == 'list') {
655            echo '<ul class="mediamanager-list" id="mediamanager__file_list">';
656        } else {
657            echo '<ul class="mediamanager-thumbs" id="mediamanager__file_list">';
658        }
659        media_filelist($ns,$auth,$jump,true);
660        echo '</ul>';
661    }
662    echo '</div>';
663}
664
665/**
666 * Prints tab that displays uploading form
667 *
668 * @author Kate Arzamastseva <pshns@ukr.net>
669 */
670function media_tab_upload($ns,$auth=null,$jump='') {
671    global $lang;
672    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
673
674    echo '<div class="background-container">';
675    echo sprintf($lang['media_upload'], $ns);
676    echo '</div>';
677
678    echo '<div class="scroll-container">';
679    if ($auth >= AUTH_UPLOAD) echo '<div class="upload">' . $lang['mediaupload'] . '</div>';
680    media_uploadform($ns, $auth, true);
681    echo '</div>';
682}
683
684/**
685 * Prints tab that displays search form
686 *
687 * @author Kate Arzamastseva <pshns@ukr.net>
688 */
689function media_tab_search($ns,$auth=null) {
690    global $lang;
691
692    $do = $_REQUEST['mediado'];
693    $query = $_REQUEST['q'];
694    if (!$query) $query = '';
695
696    echo '<div class="background-container">';
697    echo sprintf($lang['media_search'], $ns);
698    echo'</div>';
699
700    echo '<div class="scroll-container">';
701    media_searchform($ns, $query, true);
702
703    if($do == 'searchlist'){
704        $view = $_REQUEST['view'];
705        if ($view == 'list') {
706            echo '<ul class="mediamanager-list" id="mediamanager__file_list">';
707        } else {
708            echo '<ul class="mediamanager-thumbs" id="mediamanager__file_list">';
709        }
710        media_searchlist($query,$ns,$auth,true);
711        echo '</ul>';
712    }
713    echo '</div>';
714}
715
716/**
717 * Prints tab that displays mediafile details
718 *
719 * @author Kate Arzamastseva <pshns@ukr.net>
720 */
721function media_tab_view($image, $ns, $auth=null, $rev=false) {
722    global $lang, $conf;
723    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
724
725    echo '<div class="background-container">';
726    list($ext,$mime,$dl) = mimetype($image,false);
727    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
728    $class = 'select mediafile mf_'.$class;
729    echo '<a class="'.$class.'" >'.$image.'</a>';
730    echo '</div>';
731
732    echo '<div class="scroll-container">';
733    if ($image && $auth >= AUTH_READ) {
734        $meta = new JpegMeta(mediaFN($image, $rev));
735        media_preview($image, $auth, $rev, $meta);
736        media_preview_buttons($image, $auth, $rev);
737        media_details($image, $auth, $rev, $meta);
738
739    } else {
740        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>';
741    }
742    echo '</div>';
743}
744
745/**
746 * Prints tab that displays form for editing mediafile metadata
747 *
748 * @author Kate Arzamastseva <pshns@ukr.net>
749 */
750function media_tab_edit($image, $ns, $auth=null) {
751    global $lang;
752    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
753
754    echo '<div class="background-container">';
755    echo $lang['media_edit'];
756    echo '</div>';
757
758    echo '<div class="scroll-container">';
759    if ($image) {
760        list($ext, $mime) = mimetype($image);
761        if ($mime == 'image/jpeg') media_metaform($image,$auth,true);
762    }
763    echo '</div>';
764}
765
766/**
767 * Prints tab that displays mediafile revisions
768 *
769 * @author Kate Arzamastseva <pshns@ukr.net>
770 */
771function media_tab_history($image, $ns, $auth=null) {
772    global $lang;
773    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
774    $do = $_REQUEST['mediado'];
775
776    echo '<div class="background-container">';
777    echo $lang['media_history'];
778    echo '</div>';
779
780    echo '<div class="scroll-container">';
781    if ($auth >= AUTH_READ && $image) {
782        if ($do == 'diff'){
783            media_diff($image, $ns, $auth);
784        } else {
785            $first = isset($_REQUEST['first']) ? intval($_REQUEST['first']) : 0;
786            html_revisions($first, $image);
787        }
788    } else {
789        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
790    }
791    echo '</div>';
792}
793
794/**
795 * Prints mediafile details
796 *
797 * @author Kate Arzamastseva <pshns@ukr.net>
798 */
799function media_preview($image, $auth, $rev=false, $meta=false) {
800    global $lang;
801
802    echo '<div id="mediamanager__preview">';
803
804    $size = media_image_preview_size($image, $rev, $meta);
805
806    if ($size) {
807        $more = '';
808        if ($rev) {
809            $more = "rev=$rev";
810        } else {
811            $t = @filemtime(mediaFN($image));
812            $more = "t=$t";
813        }
814
815        $more .= '&w='.$size[0].'&h='.$size[1];
816
817        $src = ml($image, $more);
818        echo '<img src="'.$src.'" alt="'.$image.'" style="max-width: '.$size[0].'px;" />';
819    }
820
821    echo '</div>';
822}
823
824/**
825 * Prints mediafile action buttons
826 *
827 * @author Kate Arzamastseva <pshns@ukr.net>
828 */
829function media_preview_buttons($image, $auth, $rev=false) {
830    global $lang;
831
832    echo '<div id="mediamanager__preview_buttons">';
833
834    $more = '';
835    if ($rev) {
836        $more = "rev=$rev";
837    } else {
838        $t = @filemtime(mediaFN($image));
839        $more = "t=$t";
840    }
841    $link = ml($image,$more,true,'&');
842
843    // view original file button
844    $form = new Doku_Form(array('action'=>$link, 'target'=>'_blank'));
845    $form->addElement(form_makeButton('submit','',$lang['mediaview']));
846    $form->printForm();
847
848    if($auth >= AUTH_DELETE && !$rev){
849
850        // delete button
851        $form = new Doku_Form(array('id' => 'mediamanager__btn_delete',
852            'action'=>media_managerURL(array('delete' => $image), '&')));
853        $form->addElement(form_makeButton('submit','',$lang['btn_delete']));
854        $form->printForm();
855
856        // upload new version button
857        $form = new Doku_Form(array('id' => 'mediamanager__btn_update',
858            'action'=>media_managerURL(array('image' => $image, 'mediado' => 'update'), '&')));
859        $form->addElement(form_makeButton('submit','',$lang['media_update']));
860        $form->printForm();
861    }
862
863    if($auth >= AUTH_DELETE && $rev){
864
865        // restore button
866        $form = new Doku_Form(array('id' => 'mediamanager__btn_restore',
867            'action'=>media_managerURL(array('image' => $image), '&')));
868        $form->addHidden('mediado','restore');
869        $form->addHidden('rev',$rev);
870        $form->addElement(form_makeButton('submit','',$lang['media_restore']));
871        $form->printForm();
872    }
873
874    echo '</div>';
875}
876
877/**
878 * Returns image width and height for mediamanager preview panel
879 *
880 * @author Kate Arzamastseva <pshns@ukr.net>
881 * @param string $image
882 * @param int $rev
883 * @param JpegMeta $meta
884 * @return array
885 */
886function media_image_preview_size($image, $rev, $meta) {
887    if (!preg_match("/\.(jpe?g|gif|png)$/", $image)) return false;
888
889    $info = getimagesize(mediaFN($image, $rev));
890    $w = (int) $info[0];
891    $h = (int) $info[1];
892
893    $size = 500;
894    if($meta && ($w > $size || $h > $size)){
895        $ratio = $meta->getResizeRatio($size, $size);
896        $w = floor($w * $ratio);
897        $h = floor($h * $ratio);
898    }
899    return array($w, $h);
900}
901
902/**
903 * Returns the requested EXIF/IPTC tag from the image meta
904 *
905 * @author Kate Arzamastseva <pshns@ukr.net>
906 * @param array $tags
907 * @param JpegMeta $meta
908 * @param string $alt
909 * @return string
910 */
911function media_getTag($tags,$meta,$alt=''){
912    if($meta === false) return $alt;
913    $info = $meta->getField($tags);
914    if($info == false) return $alt;
915    return $info;
916}
917
918/**
919 * Returns mediafile tags
920 *
921 * @author Kate Arzamastseva <pshns@ukr.net>
922 * @param JpegMeta $meta
923 * @return array
924 */
925function media_file_tags($meta) {
926    global $config_cascade;
927
928    // load the field descriptions
929    static $fields = null;
930    if(is_null($fields)){
931        $config_files = getConfigFiles('mediameta');
932        foreach ($config_files as $config_file) {
933            if(@file_exists($config_file)) include($config_file);
934        }
935    }
936
937    $tags = array();
938
939    foreach($fields as $key => $tag){
940        $t = array();
941        if (!empty($tag[0])) $t = array($tag[0]);
942        if(is_array($tag[3])) $t = array_merge($t,$tag[3]);
943        $value = media_getTag($t, $meta);
944        $tags[] = array('tag' => $tag, 'value' => $value);
945    }
946
947    return $tags;
948}
949
950/**
951 * Prints mediafile tags
952 *
953 * @author Kate Arzamastseva <pshns@ukr.net>
954 */
955function media_details($image, $auth, $rev=false, $meta=false) {
956    global $lang;
957
958    if (!$meta) $meta = new JpegMeta(mediaFN($image, $rev));
959    $tags = media_file_tags($meta);
960
961    echo '<dl class="img_tags">';
962    foreach($tags as $tag){
963        if ($tag['value']) {
964            $value = cleanText($tag['value']);
965            echo '<dt>'.$lang[$tag['tag'][1]].':</dt><dd>';
966            if ($tag['tag'][2] == 'date') echo dformat($value);
967            else echo hsc($value);
968            echo '</dd>';
969        }
970    }
971    echo '</dl>';
972}
973
974/**
975 * Shows difference between two revisions of file
976 *
977 * @author Kate Arzamastseva <pshns@ukr.net>
978 */
979function media_diff($image, $ns, $auth) {
980    global $lang;
981    global $conf;
982
983    $rev1 = (int) $_REQUEST['rev'];
984
985    if(is_array($_REQUEST['rev2'])){
986        $rev1 = (int) $_REQUEST['rev2'][0];
987        $rev2 = (int) $_REQUEST['rev2'][1];
988
989        if(!$rev1){
990            $rev1 = $rev2;
991            unset($rev2);
992        }
993    }else{
994        $rev2 = (int) $_REQUEST['rev2'];
995    }
996    if($rev1 && $rev2){            // two specific revisions wanted
997        // make sure order is correct (older on the left)
998        if($rev1 < $rev2){
999            $l_rev = $rev1;
1000            $r_rev = $rev2;
1001        }else{
1002            $l_rev = $rev2;
1003            $r_rev = $rev1;
1004        }
1005    }elseif($rev1){                // single revision given, compare to current
1006        $r_rev = '';
1007        $l_rev = $rev1;
1008    }else{                        // no revision was given, compare previous to current
1009        $r_rev = '';
1010        $revs = getRevisions($image, 0, 1, 8192, true);
1011        $l_rev = $revs[0];
1012    }
1013
1014    // prepare event data
1015    $data[0] = $image;
1016    $data[1] = $l_rev;
1017    $data[2] = $r_rev;
1018    $data[3] = $ns;
1019    $data[4] = $auth;
1020
1021    // trigger event
1022    return trigger_event('MEDIA_DIFF', $data, '_media_file_diff', true);
1023
1024}
1025
1026function _media_file_diff($data) {
1027    if(is_array($data) && count($data)===5) {
1028        return media_file_diff($data[0], $data[1], $data[2], $data[3], $data[4]);
1029    } else {
1030        return false;
1031    }
1032}
1033
1034/**
1035 * Shows difference between two revisions of image
1036 *
1037 * @author Kate Arzamastseva <pshns@ukr.net>
1038 */
1039function media_file_diff($image, $l_rev, $r_rev, $ns, $auth){
1040    global $lang, $config_cascade;
1041
1042    echo '<ul id="mediamanager__diff_table">';
1043
1044    echo '<li>';
1045    media_preview($image, $auth, $l_rev, $l_meta);
1046    echo '</li>';
1047
1048    echo '<li>';
1049    media_preview($image, $auth, $r_rev, $r_meta);
1050    echo '</li>';
1051
1052    echo '<li>';
1053    media_preview_buttons($image, $auth, $l_rev);
1054    echo '</li>';
1055
1056    echo '<li>';
1057    media_preview_buttons($image, $auth, $r_rev);
1058    echo '</li>';
1059
1060    $l_meta = new JpegMeta(mediaFN($image, $l_rev));
1061    $r_meta = new JpegMeta(mediaFN($image, $r_rev));
1062
1063    $l_tags = media_file_tags($l_meta);
1064    $r_tags = media_file_tags($r_meta);
1065    foreach ($l_tags as $key => $l_tag) {
1066        if ($l_tag['value'] != $r_tags[$key]['value']) {
1067            $r_tags[$key]['class'] = 'highlighted';
1068            $l_tags[$key]['class'] = 'highlighted';
1069        } else if (!$l_tag['value'] || !$r_tags[$key]['value']) {
1070            unset($r_tags[$key]);
1071            unset($l_tags[$key]);
1072        }
1073    }
1074
1075    foreach(array($l_tags,$r_tags) as $tags){
1076        echo '<li><div>';
1077
1078        echo '<dl class="img_tags">';
1079        foreach($tags as $tag){
1080            $value = cleanText($tag['value']);
1081            if (!$value) $value = '-';
1082            echo '<dt>'.$lang[$tag['tag'][1]].':</dt>';
1083            echo '<dd class="'.$tag['class'].'" >';
1084            if ($tag['tag'][2] == 'date') echo dformat($value);
1085            else echo hsc($value);
1086            echo '</dd>';
1087        }
1088        echo '</dl>';
1089
1090        echo '</div></li>';
1091    }
1092
1093    echo '</ul>';
1094
1095    media_image_diff($image, $l_rev, $r_rev, $l_meta, 'opacity');
1096    media_image_diff($image, $l_rev, $r_rev, $l_meta, 'portions');
1097}
1098
1099/**
1100 * Prints two images side by side
1101 * and slider
1102 *
1103 * @author Kate Arzamastseva <pshns@ukr.net>
1104 * @param string $image
1105 * @param int $l_rev
1106 * @param int $r_rev
1107 * @param JpegMeta $meta
1108 */
1109function media_image_diff($image, $l_rev, $r_rev, $meta, $type) {
1110    $l_size = media_image_preview_size($image, $l_rev, $meta);
1111    $r_size = media_image_preview_size($image, $r_rev, $meta);
1112
1113    if (!$l_size || !$r_size || $l_size != $r_size || $l_size[0] < 30) return '';
1114
1115    echo '<div class="mediamanager-preview">';
1116
1117    $l_more = 'rev='.$l_rev.'&h='.$l_size[1].'&w='.$l_size[0];
1118    $r_more = 'rev='.$r_rev.'&h='.$l_size[1].'&w='.$l_size[0];
1119
1120    $l_src = ml($image, $l_more);
1121    $r_src = ml($image, $r_more);
1122
1123    echo '<div id="mediamanager__diff_'.$type.'_image1" style="background-image: url(\''.$l_src.'\'); max-width: '.$l_size[0].'px; height: '.$l_size[1].'px; " >';
1124    echo '<div id="mediamanager__diff_'.$type.'_image2" style="background-image: url(\''.$r_src.'\'); max-width: '.$l_size[0].'px; height: '.$l_size[1].'px; " >';
1125    echo '</div>';
1126    echo '</div>';
1127
1128    echo '<div id="mediamanager__'.$type.'_slider" style="max-width: '.($l_size[0]-20).'px;" ></div>';
1129    echo '</div>';
1130}
1131
1132/**
1133 * Restores an old revision of a media file
1134 *
1135 * @param string $image
1136 * @param int $rev
1137 * @param int $auth
1138 * @return string - file's id
1139 * @author Kate Arzamastseva <pshns@ukr.net>
1140 */
1141function media_restore($image, $rev, $auth){
1142    if ($auth < AUTH_DELETE) return false;
1143    if (!$image || !file_exists(mediaFN($image))) return false;
1144    if (!$rev || !file_exists(mediaFN($image, $rev))) return false;
1145    list($iext,$imime,$dl) = mimetype($image);
1146    $res = media_upload_finish(mediaFN($image, $rev),
1147        mediaFN($image),
1148        $image,
1149        $imime,
1150        true,
1151        'copy');
1152    if (is_array($res)) {
1153        msg($res[0], $res[1]);
1154        return false;
1155    }
1156    return $res;
1157}
1158
1159/**
1160 * List all files found by the search request
1161 *
1162 * @author Tobias Sarnowski <sarnowski@cosmocode.de>
1163 * @author Andreas Gohr <gohr@cosmocode.de>
1164 * @author Kate Arzamastseva <pshns@ukr.net>
1165 * @triggers MEDIA_SEARCH
1166 */
1167function media_searchlist($query,$ns,$auth=null,$fullscreen=false){
1168    global $conf;
1169    global $lang;
1170
1171    $ns = cleanID($ns);
1172
1173    if ($query) {
1174        $evdata = array(
1175                'ns'    => $ns,
1176                'data'  => array(),
1177                'query' => $query
1178                );
1179        $evt = new Doku_Event('MEDIA_SEARCH', $evdata);
1180        if ($evt->advise_before()) {
1181            $dir = utf8_encodeFN(str_replace(':','/',$evdata['ns']));
1182            $pattern = '/'.preg_quote($evdata['query'],'/').'/i';
1183            search($evdata['data'],
1184                    $conf['mediadir'],
1185                    'search_media',
1186                    array('showmsg'=>false,'pattern'=>$pattern),
1187                    $dir);
1188        }
1189        $evt->advise_after();
1190        unset($evt);
1191    }
1192
1193    if (!$fullscreen) {
1194        echo '<h1 id="media__ns">'.sprintf($lang['searchmedia_in'],hsc($ns).':*').'</h1>'.NL;
1195        media_searchform($ns,$query);
1196    }
1197
1198    if(!count($evdata['data'])){
1199        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
1200    }else foreach($evdata['data'] as $item){
1201        if (!$fullscreen) media_printfile($item,$item['perm'],'',true);
1202        else media_printfile_thumbs($item,$item['perm']);
1203    }
1204}
1205
1206/**
1207 * Print action links for a file depending on filetype
1208 * and available permissions
1209 */
1210function media_fileactions($item,$auth){
1211    global $lang;
1212
1213    // view button
1214    $link = ml($item['id'],'',true);
1215    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
1216        'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
1217
1218    // no further actions if not writable
1219    if(!$item['writable']) return;
1220
1221    // delete button
1222    if($auth >= AUTH_DELETE){
1223        $link = DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).
1224            '&amp;sectok='.getSecurityToken();
1225        echo ' <a href="'.$link.'" class="btn_media_delete" title="'.$item['id'].'">'.
1226            '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
1227            'title="'.$lang['btn_delete'].'" class="btn" /></a>';
1228    }
1229
1230    // edit button
1231    if($auth >= AUTH_UPLOAD && $item['isimg'] && $item['meta']->getField('File.Mime') == 'image/jpeg'){
1232        $link = DOKU_BASE.'lib/exe/mediamanager.php?edit='.rawurlencode($item['id']);
1233        echo ' <a href="'.$link.'">'.
1234            '<img src="'.DOKU_BASE.'lib/images/pencil.png" alt="'.$lang['metaedit'].'" '.
1235            'title="'.$lang['metaedit'].'" class="btn" /></a>';
1236    }
1237
1238}
1239
1240/**
1241 * Formats and prints one file in the list
1242 */
1243function media_printfile($item,$auth,$jump,$display_namespace=false){
1244    global $lang;
1245    global $conf;
1246
1247    // Prepare zebra coloring
1248    // I always wanted to use this variable name :-D
1249    static $twibble = 1;
1250    $twibble *= -1;
1251    $zebra = ($twibble == -1) ? 'odd' : 'even';
1252
1253    // Automatically jump to recent action
1254    if($jump == $item['id']) {
1255        $jump = ' id="scroll__here" ';
1256    }else{
1257        $jump = '';
1258    }
1259
1260    // Prepare fileicons
1261    list($ext,$mime,$dl) = mimetype($item['file'],false);
1262    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
1263    $class = 'select mediafile mf_'.$class;
1264
1265    // Prepare filename
1266    $file = utf8_decodeFN($item['file']);
1267
1268    // Prepare info
1269    $info = '';
1270    if($item['isimg']){
1271        $info .= (int) $item['meta']->getField('File.Width');
1272        $info .= '&#215;';
1273        $info .= (int) $item['meta']->getField('File.Height');
1274        $info .= ' ';
1275    }
1276    $info .= '<i>'.dformat($item['mtime']).'</i>';
1277    $info .= ' ';
1278    $info .= filesize_h($item['size']);
1279
1280    // output
1281    echo '<div class="'.$zebra.'"'.$jump.'>'.NL;
1282    if (!$display_namespace) {
1283        echo '<a name="h_:'.$item['id'].'" class="'.$class.'">'.hsc($file).'</a> ';
1284    } else {
1285        echo '<a name="h_:'.$item['id'].'" class="'.$class.'">'.hsc($item['id']).'</a><br/>';
1286    }
1287    echo '<span class="info">('.$info.')</span>'.NL;
1288    media_fileactions($item,$auth);
1289    echo '<div class="example" id="ex_'.str_replace(':','_',$item['id']).'">';
1290    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
1291    echo '</div>';
1292    if($item['isimg']) media_printimgdetail($item);
1293    echo '<div class="clearer"></div>'.NL;
1294    echo '</div>'.NL;
1295}
1296
1297function media_printicon($filename){
1298    list($ext,$mime,$dl) = mimetype(mediaFN($filename),false);
1299
1300    if (@file_exists(DOKU_INC.'lib/images/fileicons/'.$ext.'.png')) {
1301        $icon = DOKU_BASE.'lib/images/fileicons/'.$ext.'.png';
1302    } else {
1303        $icon = DOKU_BASE.'lib/images/fileicons/file.png';
1304    }
1305
1306    echo '<img src="'.$icon.'" alt="'.$filename.'" class="icon" />';
1307
1308}
1309
1310/**
1311 * Formats and prints one file in the list in the thumbnails view
1312 *
1313 * @author Kate Arzamastseva <pshns@ukr.net>
1314 */
1315function media_printfile_thumbs($item,$auth,$jump=false){
1316    global $lang;
1317    global $conf;
1318
1319    // Prepare filename
1320    $file = utf8_decodeFN($item['file']);
1321
1322    // output
1323    echo '<li><div>';
1324
1325    if($item['isimg']) {
1326        media_printimgdetail($item, true);
1327
1328    } else {
1329        echo '<a name="d_:'.$item['id'].'" class="image" title="'.$item['id'].'" href="'.
1330            media_managerURL(array('image' => hsc($item['id']))).'"><div>';
1331        media_printicon($item['id']);
1332        echo '</div></a>';
1333    }
1334    //echo '<input type=checkbox />';
1335    echo '<a href="'.media_managerURL(array('image' => hsc($item['id']))).'" name=
1336        "h_:'.$item['id'].'" class="name">'.hsc($file).'</a>';
1337    if($item['isimg']){
1338        $size = '';
1339        $size .= (int) $item['meta']->getField('File.Width');
1340        $size .= '&#215;';
1341        $size .= (int) $item['meta']->getField('File.Height');
1342        echo '<span class="size">'.$size.'</span>';
1343    } else {
1344        echo '<span class="size">&nbsp;</span>';
1345    }
1346    $date = dformat($item['mtime']);
1347    echo '<span class="date">'.$date.'</span>';
1348    $filesize = filesize_h($item['size']);
1349    echo '<span class="filesize">'.$filesize.'</span>';
1350    echo '<div class="clearer"></div>';
1351    echo '</div></li>'.NL;
1352}
1353
1354/**
1355 * Prints a thumbnail and metainfos
1356 */
1357function media_printimgdetail($item, $fullscreen=false){
1358    // prepare thumbnail
1359    if (!$fullscreen) $size = 120;
1360    else $size = 90;
1361    $w = (int) $item['meta']->getField('File.Width');
1362    $h = (int) $item['meta']->getField('File.Height');
1363    if($w>$size || $h>$size){
1364        if (!$fullscreen) {
1365            $ratio = $item['meta']->getResizeRatio($size);
1366        } else {
1367            $ratio = $item['meta']->getResizeRatio($size,$size);
1368        }
1369        $w = floor($w * $ratio);
1370        $h = floor($h * $ratio);
1371    }
1372    $src = ml($item['id'],array('w'=>$w,'h'=>$h,'t'=>$item['mtime']));
1373    $p = array();
1374    $p['width']  = $w;
1375    if (!$fullscreen) $p['height'] = $h;
1376    $p['alt']    = $item['id'];
1377    $p['class']  = 'thumb';
1378    $att = buildAttributes($p);
1379
1380    // output
1381    if ($fullscreen) {
1382        echo '<a name="d_:'.$item['id'].'" class="image" title="'.$item['id'].'" href="'.
1383            media_managerURL(array('image' => hsc($item['id']))).'">';
1384        echo '<div><img src="'.$src.'" '.$att.' /></div>';
1385        echo '</a>';
1386        return 1;
1387    }
1388
1389    echo '<div class="detail">';
1390    echo '<div class="thumb">';
1391    echo '<a name="d_:'.$item['id'].'" class="select">';
1392    echo '<img src="'.$src.'" '.$att.' />';
1393    echo '</a>';
1394    echo '</div>';
1395
1396    // read EXIF/IPTC data
1397    $t = $item['meta']->getField(array('IPTC.Headline','xmp.dc:title'));
1398    $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
1399                'EXIF.TIFFImageDescription',
1400                'EXIF.TIFFUserComment'));
1401    if(utf8_strlen($d) > 250) $d = utf8_substr($d,0,250).'...';
1402    $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category','xmp.dc:subject'));
1403
1404    // print EXIF/IPTC data
1405    if($t || $d || $k ){
1406        echo '<p>';
1407        if($t) echo '<strong>'.htmlspecialchars($t).'</strong><br />';
1408        if($d) echo htmlspecialchars($d).'<br />';
1409        if($t) echo '<em>'.htmlspecialchars($k).'</em>';
1410        echo '</p>';
1411    }
1412    echo '</div>';
1413}
1414
1415/**
1416 * Build link based on the current, adding/rewriting
1417 * parameters
1418 *
1419 * @author Kate Arzamastseva <pshns@ukr.net>
1420 * @param array $params
1421 * @param string $amp - separator
1422 * @return string - link
1423 */
1424function media_managerURL($params=false, $amp='&amp;') {
1425    global $conf;
1426    global $ID;
1427
1428    $gets = array('do' => 'media');
1429    $media_manager_params = array('tab_files', 'tab_details', 'image', 'ns', 'view');
1430    foreach ($media_manager_params as $x) {
1431        if (isset($_REQUEST[$x])) $gets[$x] = $_REQUEST[$x];
1432    }
1433
1434    if ($params) {
1435        foreach ($params as $k => $v) {
1436            $gets[$k] = $v;
1437        }
1438    }
1439    unset($gets['id']);
1440    if ($gets['delete']) {
1441        unset($gets['image']);
1442        unset($gets['tab_details']);
1443    }
1444
1445    return wl($ID,$gets,false,$amp);
1446}
1447
1448/**
1449 * Print the media upload form if permissions are correct
1450 *
1451 * @author Andreas Gohr <andi@splitbrain.org>
1452 * @author Kate Arzamastseva <pshns@ukr.net>
1453 */
1454function media_uploadform($ns, $auth, $fullscreen = false){
1455    global $lang;
1456
1457    if($auth < AUTH_UPLOAD) {
1458        echo '<div class="nothing">'.$lang['media_perm_upload'].'</div>'.NL;
1459        return;
1460    }
1461
1462    $update = false;
1463    $id = '';
1464    if ($auth >= AUTH_DELETE && $fullscreen && $_REQUEST['mediado'] == 'update') {
1465        $update = true;
1466        $id = cleanID($_REQUEST['image']);
1467    }
1468
1469    // The default HTML upload form
1470    $params = array('id'      => 'dw__upload',
1471                    'enctype' => 'multipart/form-data');
1472    if (!$fullscreen) {
1473        $params['action'] = DOKU_BASE.'lib/exe/mediamanager.php';
1474    } else {
1475        $params['action'] = media_managerURL(array('tab_files' => 'files',
1476            'tab_details' => 'view'), '&');
1477    }
1478
1479    $form = new Doku_Form($params);
1480    if (!$fullscreen) $form->addElement('<div class="upload">' . $lang['mediaupload'] . '</div>');
1481    $form->addElement(formSecurityToken());
1482    $form->addHidden('ns', hsc($ns));
1483    $form->addElement(form_makeOpenTag('p'));
1484    $form->addElement(form_makeFileField('upload', $lang['txt_upload'].':', 'upload__file'));
1485    $form->addElement(form_makeCloseTag('p'));
1486    $form->addElement(form_makeOpenTag('p'));
1487    $form->addElement(form_makeTextField('mediaid', noNS($id), $lang['txt_filename'].':', 'upload__name'));
1488    $form->addElement(form_makeButton('submit', '', $lang['btn_upload']));
1489    $form->addElement(form_makeCloseTag('p'));
1490
1491    if($auth >= AUTH_DELETE){
1492        $form->addElement(form_makeOpenTag('p'));
1493        $attrs = array();
1494        if ($update) $attrs['checked'] = 'checked';
1495        $form->addElement(form_makeCheckboxField('ow', 1, $lang['txt_overwrt'], 'dw__ow', 'check', $attrs));
1496        $form->addElement(form_makeCloseTag('p'));
1497    }
1498    html_form('upload', $form);
1499
1500    // prepare flashvars for multiupload
1501    $opt = array(
1502            'L_gridname'  => $lang['mu_gridname'] ,
1503            'L_gridsize'  => $lang['mu_gridsize'] ,
1504            'L_gridstat'  => $lang['mu_gridstat'] ,
1505            'L_namespace' => $lang['mu_namespace'] ,
1506            'L_overwrite' => $lang['txt_overwrt'],
1507            'L_browse'    => $lang['mu_browse'],
1508            'L_upload'    => $lang['btn_upload'],
1509            'L_toobig'    => $lang['mu_toobig'],
1510            'L_ready'     => $lang['mu_ready'],
1511            'L_done'      => $lang['mu_done'],
1512            'L_fail'      => $lang['mu_fail'],
1513            'L_authfail'  => $lang['mu_authfail'],
1514            'L_progress'  => $lang['mu_progress'],
1515            'L_filetypes' => $lang['mu_filetypes'],
1516            'L_info'      => $lang['mu_info'],
1517            'L_lasterr'   => $lang['mu_lasterr'],
1518
1519            'O_ns'        => ":$ns",
1520            'O_backend'   => 'mediamanager.php?'.session_name().'='.session_id(),
1521            'O_maxsize'   => php_to_byte(ini_get('upload_max_filesize')),
1522            'O_extensions'=> join('|',array_keys(getMimeTypes())),
1523            'O_overwrite' => ($auth >= AUTH_DELETE),
1524            'O_sectok'    => getSecurityToken(),
1525            'O_authtok'   => auth_createToken(),
1526            );
1527    $var = buildURLparams($opt);
1528    // output the flash uploader
1529    ?>
1530        <div id="dw__flashupload" style="display:none">
1531        <div class="upload"><?php echo $lang['mu_intro']?></div>
1532        <?php echo html_flashobject('multipleUpload.swf','500','190',null,$opt); ?>
1533        </div>
1534        <?php
1535}
1536
1537/**
1538 * Print the search field form
1539 *
1540 * @author Tobias Sarnowski <sarnowski@cosmocode.de>
1541 * @author Kate Arzamastseva <pshns@ukr.net>
1542 */
1543function media_searchform($ns,$query='',$fullscreen=false){
1544    global $lang;
1545
1546    // The default HTML search form
1547    $params = array('id' => 'dw__mediasearch');
1548    if (!$fullscreen) $params['action'] = DOKU_BASE.'lib/exe/mediamanager.php';
1549    else $params['action'] = media_managerURL(array(), '&');
1550    $form = new Doku_Form($params);
1551    if (!$fullscreen) $form->addElement('<div class="upload">' . $lang['mediasearch'] . '</div>');
1552    $form->addElement(formSecurityToken());
1553    $form->addHidden('ns', $ns);
1554    if (!$fullscreen) $form->addHidden('do', 'searchlist');
1555    else $form->addHidden('mediado', 'searchlist');
1556    $form->addElement(form_makeOpenTag('p'));
1557    $form->addElement(form_makeTextField('q', $query,$lang['searchmedia'],'','',array('title'=>sprintf($lang['searchmedia_in'],hsc($ns).':*'))));
1558    $form->addElement(form_makeButton('submit', '', $lang['btn_search']));
1559    $form->addElement(form_makeCloseTag('p'));
1560    html_form('searchmedia', $form);
1561}
1562
1563/**
1564 * Build a tree outline of available media namespaces
1565 *
1566 * @author Andreas Gohr <andi@splitbrain.org>
1567 */
1568function media_nstree($ns){
1569    global $conf;
1570    global $lang;
1571
1572    // currently selected namespace
1573    $ns  = cleanID($ns);
1574    if(empty($ns)){
1575        global $ID;
1576        $ns = dirname(str_replace(':','/',$ID));
1577        if($ns == '.') $ns ='';
1578    }
1579    $ns  = utf8_encodeFN(str_replace(':','/',$ns));
1580
1581    $data = array();
1582    search($data,$conf['mediadir'],'search_index',array('ns' => $ns, 'nofiles' => true));
1583
1584    // wrap a list with the root level around the other namespaces
1585    array_unshift($data, array('level' => 0, 'id' => '', 'open' =>'true',
1586                               'label' => '['.$lang['mediaroot'].']'));
1587
1588    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
1589}
1590
1591/**
1592 * Userfunction for html_buildlist
1593 *
1594 * Prints a media namespace tree item
1595 *
1596 * @author Andreas Gohr <andi@splitbrain.org>
1597 */
1598function media_nstree_item($item){
1599    $pos   = strrpos($item['id'], ':');
1600    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
1601    if(!$item['label']) $item['label'] = $label;
1602
1603    $ret  = '';
1604    if (!($_REQUEST['do'] == 'media'))
1605    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
1606    else $ret .= '<a href="'.media_managerURL(array('ns' => idfilter($item['id']), 'tab_files' => 'files'))
1607        .'" class="idx_dir">';
1608    $ret .= $item['label'];
1609    $ret .= '</a>';
1610    return $ret;
1611}
1612
1613/**
1614 * Userfunction for html_buildlist
1615 *
1616 * Prints a media namespace tree item opener
1617 *
1618 * @author Andreas Gohr <andi@splitbrain.org>
1619 */
1620function media_nstree_li($item){
1621    $class='media level'.$item['level'];
1622    if($item['open']){
1623        $class .= ' open';
1624        $img   = DOKU_BASE.'lib/images/minus.gif';
1625        $alt   = '&minus;';
1626    }else{
1627        $class .= ' closed';
1628        $img   = DOKU_BASE.'lib/images/plus.gif';
1629        $alt   = '+';
1630    }
1631    // TODO: only deliver an image if it actually has a subtree...
1632    return '<li class="'.$class.'">'.
1633        '<img src="'.$img.'" alt="'.$alt.'" />';
1634}
1635
1636/**
1637 * Resizes the given image to the given size
1638 *
1639 * @author  Andreas Gohr <andi@splitbrain.org>
1640 */
1641function media_resize_image($file, $ext, $w, $h=0){
1642    global $conf;
1643
1644    $info = @getimagesize($file); //get original size
1645    if($info == false) return $file; // that's no image - it's a spaceship!
1646
1647    if(!$h) $h = round(($w * $info[1]) / $info[0]);
1648
1649    // we wont scale up to infinity
1650    if($w > 2000 || $h > 2000) return $file;
1651
1652    //cache
1653    $local = getCacheName($file,'.media.'.$w.'x'.$h.'.'.$ext);
1654    $mtime = @filemtime($local); // 0 if not exists
1655
1656    if( $mtime > filemtime($file) ||
1657            media_resize_imageIM($ext,$file,$info[0],$info[1],$local,$w,$h) ||
1658            media_resize_imageGD($ext,$file,$info[0],$info[1],$local,$w,$h) ){
1659        if($conf['fperm']) chmod($local, $conf['fperm']);
1660        return $local;
1661    }
1662    //still here? resizing failed
1663    return $file;
1664}
1665
1666/**
1667 * Crops the given image to the wanted ratio, then calls media_resize_image to scale it
1668 * to the wanted size
1669 *
1670 * Crops are centered horizontally but prefer the upper third of an vertical
1671 * image because most pics are more interesting in that area (rule of thirds)
1672 *
1673 * @author  Andreas Gohr <andi@splitbrain.org>
1674 */
1675function media_crop_image($file, $ext, $w, $h=0){
1676    global $conf;
1677
1678    if(!$h) $h = $w;
1679    $info = @getimagesize($file); //get original size
1680    if($info == false) return $file; // that's no image - it's a spaceship!
1681
1682    // calculate crop size
1683    $fr = $info[0]/$info[1];
1684    $tr = $w/$h;
1685    if($tr >= 1){
1686        if($tr > $fr){
1687            $cw = $info[0];
1688            $ch = (int) $info[0]/$tr;
1689        }else{
1690            $cw = (int) $info[1]*$tr;
1691            $ch = $info[1];
1692        }
1693    }else{
1694        if($tr < $fr){
1695            $cw = (int) $info[1]*$tr;
1696            $ch = $info[1];
1697        }else{
1698            $cw = $info[0];
1699            $ch = (int) $info[0]/$tr;
1700        }
1701    }
1702    // calculate crop offset
1703    $cx = (int) ($info[0]-$cw)/2;
1704    $cy = (int) ($info[1]-$ch)/3;
1705
1706    //cache
1707    $local = getCacheName($file,'.media.'.$cw.'x'.$ch.'.crop.'.$ext);
1708    $mtime = @filemtime($local); // 0 if not exists
1709
1710    if( $mtime > filemtime($file) ||
1711            media_crop_imageIM($ext,$file,$info[0],$info[1],$local,$cw,$ch,$cx,$cy) ||
1712            media_resize_imageGD($ext,$file,$cw,$ch,$local,$cw,$ch,$cx,$cy) ){
1713        if($conf['fperm']) chmod($local, $conf['fperm']);
1714        return media_resize_image($local,$ext, $w, $h);
1715    }
1716
1717    //still here? cropping failed
1718    return media_resize_image($file,$ext, $w, $h);
1719}
1720
1721/**
1722 * Download a remote file and return local filename
1723 *
1724 * returns false if download fails. Uses cached file if available and
1725 * wanted
1726 *
1727 * @author  Andreas Gohr <andi@splitbrain.org>
1728 * @author  Pavel Vitis <Pavel.Vitis@seznam.cz>
1729 */
1730function media_get_from_URL($url,$ext,$cache){
1731    global $conf;
1732
1733    // if no cache or fetchsize just redirect
1734    if ($cache==0)           return false;
1735    if (!$conf['fetchsize']) return false;
1736
1737    $local = getCacheName(strtolower($url),".media.$ext");
1738    $mtime = @filemtime($local); // 0 if not exists
1739
1740    //decide if download needed:
1741    if( ($mtime == 0) ||                           // cache does not exist
1742            ($cache != -1 && $mtime < time()-$cache)   // 'recache' and cache has expired
1743      ){
1744        if(media_image_download($url,$local)){
1745            return $local;
1746        }else{
1747            return false;
1748        }
1749    }
1750
1751    //if cache exists use it else
1752    if($mtime) return $local;
1753
1754    //else return false
1755    return false;
1756}
1757
1758/**
1759 * Download image files
1760 *
1761 * @author Andreas Gohr <andi@splitbrain.org>
1762 */
1763function media_image_download($url,$file){
1764    global $conf;
1765    $http = new DokuHTTPClient();
1766    $http->max_bodysize = $conf['fetchsize'];
1767    $http->timeout = 25; //max. 25 sec
1768    $http->header_regexp = '!\r\nContent-Type: image/(jpe?g|gif|png)!i';
1769
1770    $data = $http->get($url);
1771    if(!$data) return false;
1772
1773    $fileexists = @file_exists($file);
1774    $fp = @fopen($file,"w");
1775    if(!$fp) return false;
1776    fwrite($fp,$data);
1777    fclose($fp);
1778    if(!$fileexists and $conf['fperm']) chmod($file, $conf['fperm']);
1779
1780    // check if it is really an image
1781    $info = @getimagesize($file);
1782    if(!$info){
1783        @unlink($file);
1784        return false;
1785    }
1786
1787    return true;
1788}
1789
1790/**
1791 * resize images using external ImageMagick convert program
1792 *
1793 * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
1794 * @author Andreas Gohr <andi@splitbrain.org>
1795 */
1796function media_resize_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h){
1797    global $conf;
1798
1799    // check if convert is configured
1800    if(!$conf['im_convert']) return false;
1801
1802    // prepare command
1803    $cmd  = $conf['im_convert'];
1804    $cmd .= ' -resize '.$to_w.'x'.$to_h.'!';
1805    if ($ext == 'jpg' || $ext == 'jpeg') {
1806        $cmd .= ' -quality '.$conf['jpg_quality'];
1807    }
1808    $cmd .= " $from $to";
1809
1810    @exec($cmd,$out,$retval);
1811    if ($retval == 0) return true;
1812    return false;
1813}
1814
1815/**
1816 * crop images using external ImageMagick convert program
1817 *
1818 * @author Andreas Gohr <andi@splitbrain.org>
1819 */
1820function media_crop_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x,$ofs_y){
1821    global $conf;
1822
1823    // check if convert is configured
1824    if(!$conf['im_convert']) return false;
1825
1826    // prepare command
1827    $cmd  = $conf['im_convert'];
1828    $cmd .= ' -crop '.$to_w.'x'.$to_h.'+'.$ofs_x.'+'.$ofs_y;
1829    if ($ext == 'jpg' || $ext == 'jpeg') {
1830        $cmd .= ' -quality '.$conf['jpg_quality'];
1831    }
1832    $cmd .= " $from $to";
1833
1834    @exec($cmd,$out,$retval);
1835    if ($retval == 0) return true;
1836    return false;
1837}
1838
1839/**
1840 * resize or crop images using PHP's libGD support
1841 *
1842 * @author Andreas Gohr <andi@splitbrain.org>
1843 * @author Sebastian Wienecke <s_wienecke@web.de>
1844 */
1845function media_resize_imageGD($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x=0,$ofs_y=0){
1846    global $conf;
1847
1848    if($conf['gdlib'] < 1) return false; //no GDlib available or wanted
1849
1850    // check available memory
1851    if(!is_mem_available(($from_w * $from_h * 4) + ($to_w * $to_h * 4))){
1852        return false;
1853    }
1854
1855    // create an image of the given filetype
1856    if ($ext == 'jpg' || $ext == 'jpeg'){
1857        if(!function_exists("imagecreatefromjpeg")) return false;
1858        $image = @imagecreatefromjpeg($from);
1859    }elseif($ext == 'png') {
1860        if(!function_exists("imagecreatefrompng")) return false;
1861        $image = @imagecreatefrompng($from);
1862
1863    }elseif($ext == 'gif') {
1864        if(!function_exists("imagecreatefromgif")) return false;
1865        $image = @imagecreatefromgif($from);
1866    }
1867    if(!$image) return false;
1868
1869    if(($conf['gdlib']>1) && function_exists("imagecreatetruecolor") && $ext != 'gif'){
1870        $newimg = @imagecreatetruecolor ($to_w, $to_h);
1871    }
1872    if(!$newimg) $newimg = @imagecreate($to_w, $to_h);
1873    if(!$newimg){
1874        imagedestroy($image);
1875        return false;
1876    }
1877
1878    //keep png alpha channel if possible
1879    if($ext == 'png' && $conf['gdlib']>1 && function_exists('imagesavealpha')){
1880        imagealphablending($newimg, false);
1881        imagesavealpha($newimg,true);
1882    }
1883
1884    //keep gif transparent color if possible
1885    if($ext == 'gif' && function_exists('imagefill') && function_exists('imagecolorallocate')) {
1886        if(function_exists('imagecolorsforindex') && function_exists('imagecolortransparent')) {
1887            $transcolorindex = @imagecolortransparent($image);
1888            if($transcolorindex >= 0 ) { //transparent color exists
1889                $transcolor = @imagecolorsforindex($image, $transcolorindex);
1890                $transcolorindex = @imagecolorallocate($newimg, $transcolor['red'], $transcolor['green'], $transcolor['blue']);
1891                @imagefill($newimg, 0, 0, $transcolorindex);
1892                @imagecolortransparent($newimg, $transcolorindex);
1893            }else{ //filling with white
1894                $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
1895                @imagefill($newimg, 0, 0, $whitecolorindex);
1896            }
1897        }else{ //filling with white
1898            $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
1899            @imagefill($newimg, 0, 0, $whitecolorindex);
1900        }
1901    }
1902
1903    //try resampling first
1904    if(function_exists("imagecopyresampled")){
1905        if(!@imagecopyresampled($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h)) {
1906            imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1907        }
1908    }else{
1909        imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1910    }
1911
1912    $okay = false;
1913    if ($ext == 'jpg' || $ext == 'jpeg'){
1914        if(!function_exists('imagejpeg')){
1915            $okay = false;
1916        }else{
1917            $okay = imagejpeg($newimg, $to, $conf['jpg_quality']);
1918        }
1919    }elseif($ext == 'png') {
1920        if(!function_exists('imagepng')){
1921            $okay = false;
1922        }else{
1923            $okay =  imagepng($newimg, $to);
1924        }
1925    }elseif($ext == 'gif') {
1926        if(!function_exists('imagegif')){
1927            $okay = false;
1928        }else{
1929            $okay = imagegif($newimg, $to);
1930        }
1931    }
1932
1933    // destroy GD image ressources
1934    if($image) imagedestroy($image);
1935    if($newimg) imagedestroy($newimg);
1936
1937    return $okay;
1938}
1939
1940/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
1941