xref: /dokuwiki/inc/media.php (revision bf1f3ac4f72c26ff386c08c920dda651d91c6898) 
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");
11require_once(DOKU_INC.'inc/html.php');
12require_once(DOKU_INC.'inc/search.php');
13require_once(DOKU_INC.'inc/JpegMeta.php');
14
15/**
16 * Lists pages which currently use a media file selected for deletion
17 *
18 * References uses the same visual as search results and share
19 * their CSS tags except pagenames won't be links.
20 *
21 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
22 */
23function media_filesinuse($data,$id){
24    global $lang;
25    echo '<h1>'.$lang['reference'].' <code>'.hsc(noNS($id)).'</code></h1>';
26    echo '<p>'.hsc($lang['ref_inuse']).'</p>';
27
28    $hidden=0; //count of hits without read permission
29    foreach($data as $row){
30        if(auth_quickaclcheck($row) >= AUTH_READ && isVisiblePage($row)){
31            echo '<div class="search_result">';
32            echo '<span class="mediaref_ref">'.hsc($row).'</span>';
33            echo '</div>';
34        }else
35        $hidden++;
36    }
37    if ($hidden){
38      print '<div class="mediaref_hidden">'.$lang['ref_hidden'].'</div>';
39    }
40}
41
42/**
43 * Handles the saving of image meta data
44 *
45 * @author Andreas Gohr <andi@splitbrain.org>
46 */
47function media_metasave($id,$auth,$data){
48    if($auth < AUTH_UPLOAD) return false;
49    if(!checkSecurityToken()) return false;
50    global $lang;
51    global $conf;
52    $src = mediaFN($id);
53
54    $meta = new JpegMeta($src);
55    $meta->_parseAll();
56
57    foreach($data as $key => $val){
58        $val=trim($val);
59        if(empty($val)){
60            $meta->deleteField($key);
61        }else{
62            $meta->setField($key,$val);
63        }
64    }
65
66    if($meta->save()){
67        if($conf['fperm']) chmod($src, $conf['fperm']);
68        msg($lang['metasaveok'],1);
69        return $id;
70    }else{
71        msg($lang['metasaveerr'],-1);
72        return false;
73    }
74}
75
76/**
77 * Display the form to edit image meta data
78 *
79 * @author Andreas Gohr <andi@splitbrain.org>
80 */
81function media_metaform($id,$auth){
82    if($auth < AUTH_UPLOAD) return false;
83    global $lang, $config_cascade;
84
85    // load the field descriptions
86    static $fields = null;
87    if(is_null($fields)){
88
89      foreach (array('default','local') as $config_group) {
90        if (empty($config_cascade['mediameta'][$config_group])) continue;
91        foreach ($config_cascade['mediameta'][$config_group] as $config_file) {
92          if(@file_exists($config_file)){
93            include($config_file);
94          }
95        }
96      }
97    }
98
99    $src = mediaFN($id);
100
101    // output
102    echo '<h1>'.hsc(noNS($id)).'</h1>'.NL;
103    echo '<form action="'.DOKU_BASE.'lib/exe/mediamanager.php" accept-charset="utf-8" method="post" class="meta">'.NL;
104    formSecurityToken();
105    foreach($fields as $key => $field){
106        // get current value
107        $tags = array($field[0]);
108        if(is_array($field[3])) $tags = array_merge($tags,$field[3]);
109        $value = tpl_img_getTag($tags,'',$src);
110        $value = cleanText($value);
111
112        // prepare attributes
113        $p = array();
114        $p['class'] = 'edit';
115        $p['id']    = 'meta__'.$key;
116        $p['name']  = 'meta['.$field[0].']';
117
118        // put label
119        echo '<div class="metafield">';
120        echo '<label for="meta__'.$key.'">';
121        echo ($lang[$field[1]]) ? $lang[$field[1]] : $field[1];
122        echo ':</label>';
123
124        // put input field
125        if($field[2] == 'text'){
126            $p['value'] = $value;
127            $p['type']  = 'text';
128            $att = buildAttributes($p);
129            echo "<input $att/>".NL;
130        }else{
131            $att = buildAttributes($p);
132            echo "<textarea $att rows=\"6\" cols=\"50\">".formText($value).'</textarea>'.NL;
133        }
134        echo '</div>'.NL;
135    }
136    echo '<div class="buttons">'.NL;
137    echo '<input type="hidden" name="img" value="'.hsc($id).'" />'.NL;
138    echo '<input name="do[save]" type="submit" value="'.$lang['btn_save'].
139         '" title="'.$lang['btn_save'].' [S]" accesskey="s" class="button" />'.NL;
140    echo '<input name="do[cancel]" type="submit" value="'.$lang['btn_cancel'].
141         '" title="'.$lang['btn_cancel'].' [C]" accesskey="c" class="button" />'.NL;
142    echo '</div>'.NL;
143    echo '</form>'.NL;
144}
145
146/**
147 * Conveinience 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        require_once(DOKU_INC.'inc/fulltext.php');
156        $mediareferences = ft_mediause($id,$conf['refshow']);
157        if(!count($mediareferences)) {
158            return false;
159        } else {
160            return $mediareferences;
161        }
162    } else {
163        return false;
164    }
165}
166
167/**
168 * Handles media file deletions
169 *
170 * If configured, checks for media references before deletion
171 *
172 * @author Andreas Gohr <andi@splitbrain.org>
173 * @return mixed false on error, true on delete or array with refs
174 */
175function media_delete($id,$auth){
176    if($auth < AUTH_DELETE) return false;
177    if(!checkSecurityToken()) return false;
178    global $conf;
179    global $lang;
180
181    $file = mediaFN($id);
182
183    // trigger an event - MEDIA_DELETE_FILE
184    $data['id']   = $id;
185    $data['name'] = basename($file);
186    $data['path'] = $file;
187    $data['size'] = (@file_exists($file)) ? filesize($file) : 0;
188
189    $data['unl'] = false;
190    $data['del'] = false;
191    $evt = new Doku_Event('MEDIA_DELETE_FILE',$data);
192    if ($evt->advise_before()) {
193        $data['unl'] = @unlink($file);
194        if($data['unl']){
195            addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE);
196            $data['del'] = io_sweepNS($id,'mediadir');
197        }
198    }
199    $evt->advise_after();
200    unset($evt);
201
202    if($data['unl'] && $data['del']){
203        // current namespace was removed. redirecting to root ns passing msg along
204        send_redirect(DOKU_URL.'lib/exe/mediamanager.php?msg1='.
205                rawurlencode(sprintf(noNS($id),$lang['deletesucc'])));
206    }
207
208    return $data['unl'];
209}
210
211/**
212 * Handles media file uploads
213 *
214 * This generates an action event and delegates to _media_upload_action().
215 * Action plugins are allowed to pre/postprocess the uploaded file.
216 * (The triggered event is preventable.)
217 *
218 * Event data:
219 * $data[0]     fn_tmp: the temporary file name (read from $_FILES)
220 * $data[1]     fn: the file name of the uploaded file
221 * $data[2]     id: the future directory id of the uploaded file
222 * $data[3]     imime: the mimetype of the uploaded file
223 * $data[4]     overwrite: if an existing file is going to be overwritten
224 *
225 * @triggers MEDIA_UPLOAD_FINISH
226 * @author Andreas Gohr <andi@splitbrain.org>
227 * @author Michael Klier <chi@chimeric.de>
228 * @return mixed false on error, id of the new file on success
229 */
230function media_upload($ns,$auth){
231    if($auth < AUTH_UPLOAD) return false;
232    if(!checkSecurityToken()) return false;
233    require_once(DOKU_INC.'inc/confutils.php');
234    global $lang;
235    global $conf;
236
237    // get file and id
238    $id   = $_POST['id'];
239    $file = $_FILES['upload'];
240    if(empty($id)) $id = $file['name'];
241
242    // check for data
243    if(!@filesize($file['tmp_name'])){
244        msg('No data uploaded. Disk full?',-1);
245        return false;
246    }
247
248    // check extensions
249    list($fext,$fmime,$dl) = mimetype($file['name']);
250    list($iext,$imime,$dl) = mimetype($id);
251    if($fext && !$iext){
252        // no extension specified in id - read original one
253        $id   .= '.'.$fext;
254        $imime = $fmime;
255    }elseif($fext && $fext != $iext){
256        // extension was changed, print warning
257        msg(sprintf($lang['mediaextchange'],$fext,$iext));
258    }
259
260    // get filename
261    $id   = cleanID($ns.':'.$id,false,true);
262    $fn   = mediaFN($id);
263
264    // get filetype regexp
265    $types = array_keys(getMimeTypes());
266    $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types);
267    $regex = join('|',$types);
268
269    // because a temp file was created already
270    if(preg_match('/\.('.$regex.')$/i',$fn)){
271        //check for overwrite
272        $overwrite = @file_exists($fn);
273        if($overwrite && (!$_REQUEST['ow'] || $auth < AUTH_DELETE)){
274            msg($lang['uploadexist'],0);
275            return false;
276        }
277        // check for valid content
278        $ok = media_contentcheck($file['tmp_name'],$imime);
279        if($ok == -1){
280            msg(sprintf($lang['uploadbadcontent'],".$iext"),-1);
281            return false;
282        }elseif($ok == -2){
283            msg($lang['uploadspam'],-1);
284            return false;
285        }elseif($ok == -3){
286            msg($lang['uploadxss'],-1);
287            return false;
288        }
289
290        // prepare event data
291        $data[0] = $file['tmp_name'];
292        $data[1] = $fn;
293        $data[2] = $id;
294        $data[3] = $imime;
295        $data[4] = $overwrite;
296
297        // trigger event
298        return trigger_event('MEDIA_UPLOAD_FINISH', $data, '_media_upload_action', true);
299
300    }else{
301        msg($lang['uploadwrong'],-1);
302    }
303    return false;
304}
305
306/**
307 * Callback adapter for media_upload_finish()
308 * @author Michael Klier <chi@chimeric.de>
309 */
310function _media_upload_action($data) {
311    // fixme do further sanity tests of given data?
312    if(is_array($data) && count($data)===5) {
313        return media_upload_finish($data[0], $data[1], $data[2], $data[3], $data[4]);
314    } else {
315        return false; //callback error
316    }
317}
318
319/**
320 * Saves an uploaded media file
321 *
322 * @author Andreas Gohr <andi@splitbrain.org>
323 * @author Michael Klier <chi@chimeric.de>
324 */
325function media_upload_finish($fn_tmp, $fn, $id, $imime, $overwrite) {
326    global $conf;
327    global $lang;
328
329    // prepare directory
330    io_createNamespace($id, 'media');
331
332    if(move_uploaded_file($fn_tmp, $fn)) {
333        // Set the correct permission here.
334        // Always chmod media because they may be saved with different permissions than expected from the php umask.
335        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
336        chmod($fn, $conf['fmode']);
337        msg($lang['uploadsucc'],1);
338        media_notify($id,$fn,$imime);
339        // add a log entry to the media changelog
340        if ($overwrite) {
341            addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_EDIT);
342        } else {
343            addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_CREATE);
344        }
345        return $id;
346    }else{
347        msg($lang['uploadfail'],-1);
348    }
349}
350
351/**
352 * This function checks if the uploaded content is really what the
353 * mimetype says it is. We also do spam checking for text types here.
354 *
355 * We need to do this stuff because we can not rely on the browser
356 * to do this check correctly. Yes, IE is broken as usual.
357 *
358 * @author Andreas Gohr <andi@splitbrain.org>
359 * @link   http://www.splitbrain.org/blog/2007-02/12-internet_explorer_facilitates_cross_site_scripting
360 * @fixme  check all 26 magic IE filetypes here?
361 */
362function media_contentcheck($file,$mime){
363    global $conf;
364    if($conf['iexssprotect']){
365        $fh = @fopen($file, 'rb');
366        if($fh){
367            $bytes = fread($fh, 256);
368            fclose($fh);
369            if(preg_match('/<(script|a|img|html|body|iframe)[\s>]/i',$bytes)){
370                return -3;
371            }
372        }
373    }
374    if(substr($mime,0,6) == 'image/'){
375        $info = @getimagesize($file);
376        if($mime == 'image/gif' && $info[2] != 1){
377            return -1;
378        }elseif($mime == 'image/jpeg' && $info[2] != 2){
379            return -1;
380        }elseif($mime == 'image/png' && $info[2] != 3){
381            return -1;
382        }
383        # fixme maybe check other images types as well
384    }elseif(substr($mime,0,5) == 'text/'){
385        global $TEXT;
386        $TEXT = io_readFile($file);
387        if(checkwordblock()){
388            return -2;
389        }
390    }
391    return 0;
392}
393
394/**
395 * Send a notify mail on uploads
396 *
397 * @author Andreas Gohr <andi@splitbrain.org>
398 */
399function media_notify($id,$file,$mime){
400    global $lang;
401    global $conf;
402    if(empty($conf['notify'])) return; //notify enabled?
403
404    $ip = clientIP();
405
406    $text = rawLocale('uploadmail');
407    $text = str_replace('@DATE@',strftime($conf['dformat']),$text);
408    $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text);
409    $text = str_replace('@IPADDRESS@',$ip,$text);
410    $text = str_replace('@HOSTNAME@',gethostsbyaddrs($ip),$text);
411    $text = str_replace('@DOKUWIKIURL@',DOKU_URL,$text);
412    $text = str_replace('@USER@',$_SERVER['REMOTE_USER'],$text);
413    $text = str_replace('@MIME@',$mime,$text);
414    $text = str_replace('@MEDIA@',ml($id,'',true,'&',true),$text);
415    $text = str_replace('@SIZE@',filesize_h(filesize($file)),$text);
416
417    $from = $conf['mailfrom'];
418    $from = str_replace('@USER@',$_SERVER['REMOTE_USER'],$from);
419    $from = str_replace('@NAME@',$INFO['userinfo']['name'],$from);
420    $from = str_replace('@MAIL@',$INFO['userinfo']['mail'],$from);
421
422    $subject = '['.$conf['title'].'] '.$lang['mail_upload'].' '.$id;
423
424    mail_send($conf['notify'],$subject,$text,$from);
425}
426
427/**
428 * List all files in a given Media namespace
429 */
430function media_filelist($ns,$auth=null,$jump=''){
431    global $conf;
432    global $lang;
433    $ns = cleanID($ns);
434
435    // check auth our self if not given (needed for ajax calls)
436    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
437
438    echo '<h1 id="media__ns">:'.hsc($ns).'</h1>'.NL;
439
440    if($auth < AUTH_READ){
441        // FIXME: print permission warning here instead?
442        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
443        return;
444    }
445
446    media_uploadform($ns, $auth);
447
448    $dir = utf8_encodeFN(str_replace(':','/',$ns));
449    $data = array();
450    search($data,$conf['mediadir'],'search_media',
451           array('showmsg'=>true,'depth'=>1),$dir);
452
453    if(!count($data)){
454        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
455        return;
456    }
457
458    foreach($data as $item){
459        media_printfile($item,$auth,$jump);
460    }
461}
462
463/**
464 * List all files found by the search request
465 */
466function media_searchlist($ns,$auth=null,$jump=''){
467    global $conf;
468    global $lang;
469    $ns = cleanID($ns);
470
471    // check auth our self if not given (needed for ajax calls)
472    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
473
474    echo '<h1 id="media__ns">Search</h1>'.NL;
475
476    if($auth < AUTH_READ){
477        // FIXME: print permission warning here instead?
478        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
479        return;
480    }
481
482    media_searchform($ns, $auth);
483
484    if (isset($_REQUEST['key']) && strlen($_REQUEST['key']) > 2) {
485
486        if (isset($_REQUEST['key_relative'])) {
487            $dir = utf8_encodeFN(str_replace(':','/',$ns));
488        } else {
489            $dir = '';
490        }
491
492        $data = array();
493        $evt = new Doku_Event('ACTION_MEDIA_SEARCH', $dir);
494        if ($evt->advise_before()) {
495            $pattern = '#'.str_replace('#', '\#', $_REQUEST['key']).'#';
496            search($data,$conf['mediadir'],'search_media', array('showmsg'=>true,'pattern'=>$pattern),$dir);
497
498        }
499        $evt->advise_after();
500        unset($evt);
501
502        if(!count($data)){
503            echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
504            return;
505        }
506
507        foreach($data as $item){
508            media_printfile($item,$auth,$jump,$display_namespace=true);
509        }
510    }
511}
512
513/**
514 * Print action links for a file depending on filetype
515 * and available permissions
516 *
517 * @todo contains inline javascript
518 */
519function media_fileactions($item,$auth){
520    global $lang;
521
522    // view button
523    $link = ml($item['id'],'',true);
524    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
525         'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
526
527
528    // no further actions if not writable
529    if(!$item['writable']) return;
530
531    // delete button
532    if($auth >= AUTH_DELETE){
533        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).
534             '&amp;sectok='.getSecurityToken().'" class="btn_media_delete" title="'.$item['id'].'">'.
535             '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
536             'title="'.$lang['btn_delete'].'" class="btn" /></a>';
537    }
538
539    // edit button
540    if($auth >= AUTH_UPLOAD && $item['isimg'] && $item['meta']->getField('File.Mime') == 'image/jpeg'){
541        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?edit='.rawurlencode($item['id']).'">'.
542             '<img src="'.DOKU_BASE.'lib/images/pencil.png" alt="'.$lang['metaedit'].'" '.
543             'title="'.$lang['metaedit'].'" class="btn" /></a>';
544    }
545
546}
547
548/**
549 * Formats and prints one file in the list
550 */
551function media_printfile($item,$auth,$jump,$display_namespace=false){
552    global $lang;
553    global $conf;
554
555    // Prepare zebra coloring
556    // I always wanted to use this variable name :-D
557    static $twibble = 1;
558    $twibble *= -1;
559    $zebra = ($twibble == -1) ? 'odd' : 'even';
560
561    // Automatically jump to recent action
562    if($jump == $item['id']) {
563        $jump = ' id="scroll__here" ';
564    }else{
565        $jump = '';
566    }
567
568    // Prepare fileicons
569    list($ext,$mime,$dl) = mimetype($item['file']);
570    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
571    $class = 'select mediafile mf_'.$class;
572
573    // Prepare filename
574    $file = utf8_decodeFN($item['file']);
575
576    // Prepare info
577    $info = '';
578    if($item['isimg']){
579        $info .= (int) $item['meta']->getField('File.Width');
580        $info .= '&#215;';
581        $info .= (int) $item['meta']->getField('File.Height');
582        $info .= ' ';
583    }
584    $info .= '<i>'.strftime($conf['dformat'],$item['mtime']).'</i>';
585    $info .= ' ';
586    $info .= filesize_h($item['size']);
587
588    // ouput
589    echo '<div class="'.$zebra.'"'.$jump.'>'.NL;
590    echo '<a name="h_'.$item['id'].'" class="'.$class.'">'.$file.'</a> ';
591    echo '<span class="info">('.$info.')</span>'.NL;
592    media_fileactions($item,$auth);
593    echo '<div class="example" id="ex_'.str_replace(':','_',$item['id']).'">';
594    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
595    echo '</div>';
596    if($item['isimg']) media_printimgdetail($item);
597    echo '<div class="clearer"></div>'.NL;
598    echo '</div>'.NL;
599}
600
601/**
602 * Prints a thumbnail and metainfos
603 */
604function media_printimgdetail($item){
605    // prepare thumbnail
606    $w = (int) $item['meta']->getField('File.Width');
607    $h = (int) $item['meta']->getField('File.Height');
608    if($w>120 || $h>120){
609        $ratio = $item['meta']->getResizeRatio(120);
610        $w = floor($w * $ratio);
611        $h = floor($h * $ratio);
612    }
613    $src = ml($item['id'],array('w'=>$w,'h'=>$h));
614    $p = array();
615    $p['width']  = $w;
616    $p['height'] = $h;
617    $p['alt']    = $item['id'];
618    $p['class']  = 'thumb';
619    $att = buildAttributes($p);
620
621    // output
622    echo '<div class="detail">';
623    echo '<div class="thumb">';
624    echo '<a name="d_:'.$item['id'].'" class="select">';
625    echo '<img src="'.$src.'" '.$att.' />';
626    echo '</a>';
627    echo '</div>';
628
629    // read EXIF/IPTC data
630    $t = $item['meta']->getField(array('IPTC.Headline','xmp.dc:title'));
631    $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
632                                       'EXIF.TIFFImageDescription',
633                                       'EXIF.TIFFUserComment'));
634    if(utf8_strlen($d) > 250) $d = utf8_substr($d,0,250).'...';
635    $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category','xmp.dc:subject'));
636
637    // print EXIF/IPTC data
638    if($t || $d || $k ){
639        echo '<p>';
640        if($t) echo '<strong>'.htmlspecialchars($t).'</strong><br />';
641        if($d) echo htmlspecialchars($d).'<br />';
642        if($t) echo '<em>'.htmlspecialchars($k).'</em>';
643        echo '</p>';
644    }
645    echo '</div>';
646}
647
648/**
649 * Print the media upload form if permissions are correct
650 *
651 * @author Andreas Gohr <andi@splitbrain.org>
652 */
653function media_uploadform($ns, $auth){
654    global $lang;
655
656    if($auth < AUTH_UPLOAD) return; //fixme print info on missing permissions?
657
658    // The default HTML upload form
659    $form = new Doku_Form('dw__upload', DOKU_BASE.'lib/exe/mediamanager.php', false, 'multipart/form-data');
660    $form->addElement('<div class="upload">' . $lang['mediaupload'] . '</div>');
661    $form->addElement(formSecurityToken());
662    $form->addHidden('ns', hsc($ns));
663    $form->addElement(form_makeOpenTag('p'));
664    $form->addElement(form_makeFileField('upload', $lang['txt_upload'].':', 'upload__file'));
665    $form->addElement(form_makeCloseTag('p'));
666    $form->addElement(form_makeOpenTag('p'));
667    $form->addElement(form_makeTextField('id', '', $lang['txt_filename'].':', 'upload__name'));
668    $form->addElement(form_makeButton('submit', '', $lang['btn_upload']));
669    $form->addElement(form_makeCloseTag('p'));
670
671    if($auth >= AUTH_DELETE){
672      $form->addElement(form_makeOpenTag('p'));
673      $form->addElement(form_makeCheckboxField('ow', 1, $lang['txt_overwrt'], 'dw__ow', 'check'));
674      $form->addElement(form_makeCloseTag('p'));
675    }
676    html_form('upload', $form);
677
678    // prepare flashvars for multiupload
679    $opt = array(
680        'L_gridname'  => $lang['mu_gridname'] ,
681        'L_gridsize'  => $lang['mu_gridsize'] ,
682        'L_gridstat'  => $lang['mu_gridstat'] ,
683        'L_namespace' => $lang['mu_namespace'] ,
684        'L_overwrite' => $lang['txt_overwrt'],
685        'L_browse'    => $lang['mu_browse'],
686        'L_upload'    => $lang['btn_upload'],
687        'L_toobig'    => $lang['mu_toobig'],
688        'L_ready'     => $lang['mu_ready'],
689        'L_done'      => $lang['mu_done'],
690        'L_fail'      => $lang['mu_fail'],
691        'L_authfail'  => $lang['mu_authfail'],
692        'L_progress'  => $lang['mu_progress'],
693        'L_filetypes' => $lang['mu_filetypes'],
694        'L_info'      => $lang['mu_info'],
695        'L_lasterr'   => $lang['mu_lasterr'],
696
697        'O_ns'        => ":$ns",
698        'O_backend'   => 'mediamanager.php?'.session_name().'='.session_id(),
699        'O_maxsize'   => php_to_byte(ini_get('upload_max_filesize')),
700        'O_extensions'=> join('|',array_keys(getMimeTypes())),
701        'O_overwrite' => ($auth >= AUTH_DELETE),
702        'O_sectok'    => getSecurityToken(),
703        'O_authtok'   => auth_createToken(),
704    );
705    $var = buildURLparams($opt);
706    // output the flash uploader
707    ?>
708    <div id="dw__flashupload" style="display:none">
709    <div class="upload"><?php echo $lang['mu_intro']?></div>
710    <?php echo html_flashobject('multipleUpload.swf','500','190',null,$opt); ?>
711    </div>
712    <?php
713}
714
715/**
716 * Print the search field form
717 *
718 * @author Tobias Sarnowski <sarnowski@cosmocode.de>
719 */
720function media_searchform($ns, $auth){
721    global $lang;
722
723    if (!isset($_REQUEST['key'])) {
724        $default = '';
725    } else {
726        $default = htmlspecialchars($_REQUEST['key']);
727    }
728
729    // The default HTML search form
730    $form = new Doku_Form('dw__mediasearch', DOKU_BASE.'lib/exe/mediamanager.php', false);
731    $form->addElement('<div class="upload">' . $lang['mediasearch'] . '</div>');
732    $form->addElement(formSecurityToken());
733    $form->addHidden('ns', hsc($ns));
734    $form->addHidden('call', 'mediasearchlist');
735    $form->addElement(form_makeOpenTag('p'));
736    $form->addElement(form_makeTextField('key', $default, $lang['txt_searchmediakey'].':', 'searchmedia__key'));
737    $form->addElement(form_makeButton('submit', '', $lang['btn_search']));
738    $form->addElement(form_makeCloseTag('p'));
739    if ($ns) {
740        $form->addElement(form_makeOpenTag('p'));
741        $form->addElement(form_makeCheckboxField('key_relative', true, sprintf($lang['txt_searchrelative'], $ns), 'dw__relative', 'check', isset($_REQUEST['key_relative'])?array('checked' => 'checked'):array()));
742        $form->addElement(form_makeCloseTag('p'));
743    }
744
745    html_form('searchmedia', $form);
746}
747
748/**
749 * Build a tree outline of available media namespaces
750 *
751 * @author Andreas Gohr <andi@splitbrain.org>
752 */
753function media_nstree($ns){
754    global $conf;
755    global $lang;
756
757    // currently selected namespace
758    $ns  = cleanID($ns);
759    if(empty($ns)){
760        $ns = dirname(str_replace(':','/',$ID));
761        if($ns == '.') $ns ='';
762    }
763    $ns  = utf8_encodeFN(str_replace(':','/',$ns));
764
765    $data = array();
766    search($data,$conf['mediadir'],'search_index',array('ns' => $ns, 'nofiles' => true));
767
768    // wrap a list with the root level around the other namespaces
769    $item = array( 'level' => 0, 'id' => '',
770                   'open' =>'true', 'label' => '['.$lang['mediaroot'].']');
771
772    echo '<ul class="idx">';
773    echo media_nstree_li($item);
774    echo media_nstree_item($item);
775    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
776    echo '</li>';
777    echo '</ul>';
778}
779
780/**
781 * Userfunction for html_buildlist
782 *
783 * Prints a media namespace tree item
784 *
785 * @author Andreas Gohr <andi@splitbrain.org>
786 */
787function media_nstree_item($item){
788    $pos   = strrpos($item['id'], ':');
789    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
790    if(!$item['label']) $item['label'] = $label;
791
792    $ret  = '';
793    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
794    $ret .= $item['label'];
795    $ret .= '</a>';
796    return $ret;
797}
798
799/**
800 * Userfunction for html_buildlist
801 *
802 * Prints a media namespace tree item opener
803 *
804 * @author Andreas Gohr <andi@splitbrain.org>
805 */
806function media_nstree_li($item){
807    $class='media level'.$item['level'];
808    if($item['open']){
809        $class .= ' open';
810        $img   = DOKU_BASE.'lib/images/minus.gif';
811        $alt   = '&minus;';
812    }else{
813        $class .= ' closed';
814        $img   = DOKU_BASE.'lib/images/plus.gif';
815        $alt   = '+';
816    }
817    return '<li class="'.$class.'">'.
818           '<img src="'.$img.'" alt="'.$alt.'" />';
819}
820
821/**
822 * Resizes the given image to the given size
823 *
824 * @author  Andreas Gohr <andi@splitbrain.org>
825 */
826function media_resize_image($file, $ext, $w, $h=0){
827  global $conf;
828
829  $info = @getimagesize($file); //get original size
830  if($info == false) return $file; // that's no image - it's a spaceship!
831
832  if(!$h) $h = round(($w * $info[1]) / $info[0]);
833
834  // we wont scale up to infinity
835  if($w > 2000 || $h > 2000) return $file;
836
837  //cache
838  $local = getCacheName($file,'.media.'.$w.'x'.$h.'.'.$ext);
839  $mtime = @filemtime($local); // 0 if not exists
840
841  if( $mtime > filemtime($file) ||
842      media_resize_imageIM($ext,$file,$info[0],$info[1],$local,$w,$h) ||
843      media_resize_imageGD($ext,$file,$info[0],$info[1],$local,$w,$h) ){
844    if($conf['fperm']) chmod($local, $conf['fperm']);
845    return $local;
846  }
847  //still here? resizing failed
848  return $file;
849}
850
851/**
852 * Crops the given image to the wanted ratio, then calls media_resize_image to scale it
853 * to the wanted size
854 *
855 * Crops are centered horizontally but prefer the upper third of an vertical
856 * image because most pics are more interesting in that area (rule of thirds)
857 *
858 * @author  Andreas Gohr <andi@splitbrain.org>
859 */
860function media_crop_image($file, $ext, $w, $h=0){
861  global $conf;
862
863  if(!$h) $h = $w;
864  $info = @getimagesize($file); //get original size
865  if($info == false) return $file; // that's no image - it's a spaceship!
866
867  // calculate crop size
868  $fr = $info[0]/$info[1];
869  $tr = $w/$h;
870  if($tr >= 1){
871    if($tr > $fr){
872        $cw = $info[0];
873        $ch = (int) $info[0]/$tr;
874    }else{
875        $cw = (int) $info[1]*$tr;
876        $ch = $info[1];
877    }
878  }else{
879    if($tr < $fr){
880        $cw = (int) $info[1]*$tr;
881        $ch = $info[1];
882    }else{
883        $cw = $info[0];
884        $ch = (int) $info[0]/$tr;
885    }
886  }
887  // calculate crop offset
888  $cx = (int) ($info[0]-$cw)/2;
889  $cy = (int) ($info[1]-$ch)/3;
890
891  //cache
892  $local = getCacheName($file,'.media.'.$cw.'x'.$ch.'.crop.'.$ext);
893  $mtime = @filemtime($local); // 0 if not exists
894
895  if( $mtime > filemtime($file) ||
896      media_crop_imageIM($ext,$file,$info[0],$info[1],$local,$cw,$ch,$cx,$cy) ||
897      media_resize_imageGD($ext,$file,$cw,$ch,$local,$cw,$ch,$cx,$cy) ){
898    if($conf['fperm']) chmod($local, $conf['fperm']);
899    return media_resize_image($local,$ext, $w, $h);
900  }
901
902  //still here? cropping failed
903  return media_resize_image($file,$ext, $w, $h);
904}
905
906/**
907 * Download a remote file and return local filename
908 *
909 * returns false if download fails. Uses cached file if available and
910 * wanted
911 *
912 * @author  Andreas Gohr <andi@splitbrain.org>
913 * @author  Pavel Vitis <Pavel.Vitis@seznam.cz>
914 */
915function media_get_from_URL($url,$ext,$cache){
916  global $conf;
917
918  // if no cache or fetchsize just redirect
919  if ($cache==0)           return false;
920  if (!$conf['fetchsize']) return false;
921
922  $local = getCacheName(strtolower($url),".media.$ext");
923  $mtime = @filemtime($local); // 0 if not exists
924
925  //decide if download needed:
926  if( ($mtime == 0) ||                           // cache does not exist
927      ($cache != -1 && $mtime < time()-$cache)   // 'recache' and cache has expired
928    ){
929      if(media_image_download($url,$local)){
930        return $local;
931      }else{
932        return false;
933      }
934  }
935
936  //if cache exists use it else
937  if($mtime) return $local;
938
939  //else return false
940  return false;
941}
942
943/**
944 * Download image files
945 *
946 * @author Andreas Gohr <andi@splitbrain.org>
947 */
948function media_image_download($url,$file){
949  global $conf;
950  $http = new DokuHTTPClient();
951  $http->max_bodysize = $conf['fetchsize'];
952  $http->timeout = 25; //max. 25 sec
953  $http->header_regexp = '!\r\nContent-Type: image/(jpe?g|gif|png)!i';
954
955  $data = $http->get($url);
956  if(!$data) return false;
957
958  $fileexists = @file_exists($file);
959  $fp = @fopen($file,"w");
960  if(!$fp) return false;
961  fwrite($fp,$data);
962  fclose($fp);
963  if(!$fileexists and $conf['fperm']) chmod($file, $conf['fperm']);
964
965  // check if it is really an image
966  $info = @getimagesize($file);
967  if(!$info){
968    @unlink($file);
969    return false;
970  }
971
972  return true;
973}
974
975/**
976 * resize images using external ImageMagick convert program
977 *
978 * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
979 * @author Andreas Gohr <andi@splitbrain.org>
980 */
981function media_resize_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h){
982  global $conf;
983
984  // check if convert is configured
985  if(!$conf['im_convert']) return false;
986
987  // prepare command
988  $cmd  = $conf['im_convert'];
989  $cmd .= ' -resize '.$to_w.'x'.$to_h.'!';
990  if ($ext == 'jpg' || $ext == 'jpeg') {
991      $cmd .= ' -quality '.$conf['jpg_quality'];
992  }
993  $cmd .= " $from $to";
994
995  @exec($cmd,$out,$retval);
996  if ($retval == 0) return true;
997  return false;
998}
999
1000/**
1001 * crop images using external ImageMagick convert program
1002 *
1003 * @author Andreas Gohr <andi@splitbrain.org>
1004 */
1005function media_crop_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x,$ofs_y){
1006  global $conf;
1007
1008  // check if convert is configured
1009  if(!$conf['im_convert']) return false;
1010
1011  // prepare command
1012  $cmd  = $conf['im_convert'];
1013  $cmd .= ' -crop '.$to_w.'x'.$to_h.'+'.$ofs_x.'+'.$ofs_y;
1014  if ($ext == 'jpg' || $ext == 'jpeg') {
1015      $cmd .= ' -quality '.$conf['jpg_quality'];
1016  }
1017  $cmd .= " $from $to";
1018
1019  @exec($cmd,$out,$retval);
1020  if ($retval == 0) return true;
1021  return false;
1022}
1023
1024/**
1025 * resize or crop images using PHP's libGD support
1026 *
1027 * @author Andreas Gohr <andi@splitbrain.org>
1028 * @author Sebastian Wienecke <s_wienecke@web.de>
1029 */
1030function media_resize_imageGD($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x=0,$ofs_y=0){
1031  global $conf;
1032
1033  if($conf['gdlib'] < 1) return false; //no GDlib available or wanted
1034
1035  // check available memory
1036  if(!is_mem_available(($from_w * $from_h * 4) + ($to_w * $to_h * 4))){
1037    return false;
1038  }
1039
1040  // create an image of the given filetype
1041  if ($ext == 'jpg' || $ext == 'jpeg'){
1042    if(!function_exists("imagecreatefromjpeg")) return false;
1043    $image = @imagecreatefromjpeg($from);
1044  }elseif($ext == 'png') {
1045    if(!function_exists("imagecreatefrompng")) return false;
1046    $image = @imagecreatefrompng($from);
1047
1048  }elseif($ext == 'gif') {
1049    if(!function_exists("imagecreatefromgif")) return false;
1050    $image = @imagecreatefromgif($from);
1051  }
1052  if(!$image) return false;
1053
1054  if(($conf['gdlib']>1) && function_exists("imagecreatetruecolor") && $ext != 'gif'){
1055    $newimg = @imagecreatetruecolor ($to_w, $to_h);
1056  }
1057  if(!$newimg) $newimg = @imagecreate($to_w, $to_h);
1058  if(!$newimg){
1059    imagedestroy($image);
1060    return false;
1061  }
1062
1063  //keep png alpha channel if possible
1064  if($ext == 'png' && $conf['gdlib']>1 && function_exists('imagesavealpha')){
1065    imagealphablending($newimg, false);
1066    imagesavealpha($newimg,true);
1067  }
1068
1069  //keep gif transparent color if possible
1070  if($ext == 'gif' && function_exists('imagefill') && function_exists('imagecolorallocate')) {
1071    if(function_exists('imagecolorsforindex') && function_exists('imagecolortransparent')) {
1072      $transcolorindex = @imagecolortransparent($image);
1073      if($transcolorindex >= 0 ) { //transparent color exists
1074        $transcolor = @imagecolorsforindex($image, $transcolorindex);
1075        $transcolorindex = @imagecolorallocate($newimg, $transcolor['red'], $transcolor['green'], $transcolor['blue']);
1076        @imagefill($newimg, 0, 0, $transcolorindex);
1077        @imagecolortransparent($newimg, $transcolorindex);
1078      }else{ //filling with white
1079        $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
1080        @imagefill($newimg, 0, 0, $whitecolorindex);
1081      }
1082    }else{ //filling with white
1083      $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
1084      @imagefill($newimg, 0, 0, $whitecolorindex);
1085    }
1086  }
1087
1088  //try resampling first
1089  if(function_exists("imagecopyresampled")){
1090    if(!@imagecopyresampled($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h)) {
1091      imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1092    }
1093  }else{
1094    imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1095  }
1096
1097  $okay = false;
1098  if ($ext == 'jpg' || $ext == 'jpeg'){
1099    if(!function_exists('imagejpeg')){
1100      $okay = false;
1101    }else{
1102      $okay = imagejpeg($newimg, $to, $conf['jpg_quality']);
1103    }
1104  }elseif($ext == 'png') {
1105    if(!function_exists('imagepng')){
1106      $okay = false;
1107    }else{
1108      $okay =  imagepng($newimg, $to);
1109    }
1110  }elseif($ext == 'gif') {
1111    if(!function_exists('imagegif')){
1112      $okay = false;
1113    }else{
1114      $okay = imagegif($newimg, $to);
1115    }
1116  }
1117
1118  // destroy GD image ressources
1119  if($image) imagedestroy($image);
1120  if($newimg) imagedestroy($newimg);
1121
1122  return $okay;
1123}
1124
1125/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
1126