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