xref: /dokuwiki/inc/media.php (revision c84e50dfc87946f0fddd1485b2717cf0b4377046) 
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 * Print action links for a file depending on filetype
465 * and available permissions
466 *
467 * @todo contains inline javascript
468 */
469function media_fileactions($item,$auth){
470    global $lang;
471
472    // view button
473    $link = ml($item['id'],'',true);
474    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
475         'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
476
477
478    // no further actions if not writable
479    if(!$item['writable']) return;
480
481    // delete button
482    if($auth >= AUTH_DELETE){
483        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).
484             '&amp;sectok='.getSecurityToken().'" class="btn_media_delete" title="'.$item['id'].'">'.
485             '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
486             'title="'.$lang['btn_delete'].'" class="btn" /></a>';
487    }
488
489    // edit button
490    if($auth >= AUTH_UPLOAD && $item['isimg'] && $item['meta']->getField('File.Mime') == 'image/jpeg'){
491        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?edit='.rawurlencode($item['id']).'">'.
492             '<img src="'.DOKU_BASE.'lib/images/pencil.png" alt="'.$lang['metaedit'].'" '.
493             'title="'.$lang['metaedit'].'" class="btn" /></a>';
494    }
495
496}
497
498/**
499 * Formats and prints one file in the list
500 */
501function media_printfile($item,$auth,$jump){
502    global $lang;
503    global $conf;
504
505    // Prepare zebra coloring
506    // I always wanted to use this variable name :-D
507    static $twibble = 1;
508    $twibble *= -1;
509    $zebra = ($twibble == -1) ? 'odd' : 'even';
510
511    // Automatically jump to recent action
512    if($jump == $item['id']) {
513        $jump = ' id="scroll__here" ';
514    }else{
515        $jump = '';
516    }
517
518    // Prepare fileicons
519    list($ext,$mime,$dl) = mimetype($item['file']);
520    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
521    $class = 'select mediafile mf_'.$class;
522
523    // Prepare filename
524    $file = utf8_decodeFN($item['file']);
525
526    // Prepare info
527    $info = '';
528    if($item['isimg']){
529        $info .= (int) $item['meta']->getField('File.Width');
530        $info .= '&#215;';
531        $info .= (int) $item['meta']->getField('File.Height');
532        $info .= ' ';
533    }
534    $info .= '<i>'.strftime($conf['dformat'],$item['mtime']).'</i>';
535    $info .= ' ';
536    $info .= filesize_h($item['size']);
537
538    // ouput
539    echo '<div class="'.$zebra.'"'.$jump.'>'.NL;
540    echo '<a name="h_'.$item['id'].'" class="'.$class.'">'.$file.'</a> ';
541    echo '<span class="info">('.$info.')</span>'.NL;
542    media_fileactions($item,$auth);
543    echo '<div class="example" id="ex_'.str_replace(':','_',$item['id']).'">';
544    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
545    echo '</div>';
546    if($item['isimg']) media_printimgdetail($item);
547    echo '<div class="clearer"></div>'.NL;
548    echo '</div>'.NL;
549}
550
551/**
552 * Prints a thumbnail and metainfos
553 */
554function media_printimgdetail($item){
555    // prepare thumbnail
556    $w = (int) $item['meta']->getField('File.Width');
557    $h = (int) $item['meta']->getField('File.Height');
558    if($w>120 || $h>120){
559        $ratio = $item['meta']->getResizeRatio(120);
560        $w = floor($w * $ratio);
561        $h = floor($h * $ratio);
562    }
563    $src = ml($item['id'],array('w'=>$w,'h'=>$h));
564    $p = array();
565    $p['width']  = $w;
566    $p['height'] = $h;
567    $p['alt']    = $item['id'];
568    $p['class']  = 'thumb';
569    $att = buildAttributes($p);
570
571    // output
572    echo '<div class="detail">';
573    echo '<div class="thumb">';
574    echo '<a name="d_'.$item['id'].'" class="select">';
575    echo '<img src="'.$src.'" '.$att.' />';
576    echo '</a>';
577    echo '</div>';
578
579    // read EXIF/IPTC data
580    $t = $item['meta']->getField(array('IPTC.Headline','xmp.dc:title'));
581    $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
582                                       'EXIF.TIFFImageDescription',
583                                       'EXIF.TIFFUserComment'));
584    if(utf8_strlen($d) > 250) $d = utf8_substr($d,0,250).'...';
585    $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category','xmp.dc:subject'));
586
587    // print EXIF/IPTC data
588    if($t || $d || $k ){
589        echo '<p>';
590        if($t) echo '<strong>'.htmlspecialchars($t).'</strong><br />';
591        if($d) echo htmlspecialchars($d).'<br />';
592        if($t) echo '<em>'.htmlspecialchars($k).'</em>';
593        echo '</p>';
594    }
595    echo '</div>';
596}
597
598/**
599 * Print the media upload form if permissions are correct
600 *
601 * @author Andreas Gohr <andi@splitbrain.org>
602 */
603function media_uploadform($ns, $auth){
604    global $lang;
605
606    if($auth < AUTH_UPLOAD) return; //fixme print info on missing permissions?
607
608    // The default HTML upload form
609    $form = new Doku_Form('dw__upload', DOKU_BASE.'lib/exe/mediamanager.php', false, 'multipart/form-data');
610    $form->addElement('<div class="upload">' . $lang['mediaupload'] . '</div>');
611    $form->addElement(formSecurityToken());
612    $form->addHidden('ns', hsc($ns));
613    $form->addElement(form_makeOpenTag('p'));
614    $form->addElement(form_makeFileField('upload', $lang['txt_upload'].':', 'upload__file'));
615    $form->addElement(form_makeCloseTag('p'));
616    $form->addElement(form_makeOpenTag('p'));
617    $form->addElement(form_makeTextField('id', '', $lang['txt_filename'].':', 'upload__name'));
618    $form->addElement(form_makeButton('submit', '', $lang['btn_upload']));
619    $form->addElement(form_makeCloseTag('p'));
620
621    if($auth >= AUTH_DELETE){
622      $form->addElement(form_makeOpenTag('p'));
623      $form->addElement(form_makeCheckboxField('ow', 1, $lang['txt_overwrt'], 'dw__ow', 'check'));
624      $form->addElement(form_makeCloseTag('p'));
625    }
626    html_form('upload', $form);
627
628    // prepare flashvars for multiupload
629    $opt = array(
630        'L_gridname'  => $lang['mu_gridname'] ,
631        'L_gridsize'  => $lang['mu_gridsize'] ,
632        'L_gridstat'  => $lang['mu_gridstat'] ,
633        'L_namespace' => $lang['mu_namespace'] ,
634        'L_overwrite' => $lang['txt_overwrt'],
635        'L_browse'    => $lang['mu_browse'],
636        'L_upload'    => $lang['btn_upload'],
637        'L_toobig'    => $lang['mu_toobig'],
638        'L_ready'     => $lang['mu_ready'],
639        'L_done'      => $lang['mu_done'],
640        'L_fail'      => $lang['mu_fail'],
641        'L_authfail'  => $lang['mu_authfail'],
642        'L_progress'  => $lang['mu_progress'],
643        'L_filetypes' => $lang['mu_filetypes'],
644
645        'O_ns'        => ":$ns",
646        'O_backend'   => 'mediamanager.php?'.session_name().'='.session_id(),
647        'O_size'      => php_to_byte(ini_get('upload_max_filesize')),
648        'O_extensions'=> join('|',array_keys(getMimeTypes())),
649        'O_overwrite' => ($auth >= AUTH_DELETE),
650        'O_sectok'    => getSecurityToken(),
651        'O_authtok'   => auth_createToken(),
652    );
653    $var = buildURLparams($opt);
654    // output the flash uploader
655    ?>
656    <div id="dw__flashupload" style="display:none">
657    <div class="upload"><?php echo $lang['mu_intro']?></div>
658    <?php echo html_flashobject('multipleUpload.swf','500','190',null,$opt); ?>
659    </div>
660    <?php
661}
662
663/**
664 * Build a tree outline of available media namespaces
665 *
666 * @author Andreas Gohr <andi@splitbrain.org>
667 */
668function media_nstree($ns){
669    global $conf;
670    global $lang;
671
672    // currently selected namespace
673    $ns  = cleanID($ns);
674    if(empty($ns)){
675        $ns = dirname(str_replace(':','/',$ID));
676        if($ns == '.') $ns ='';
677    }
678    $ns  = utf8_encodeFN(str_replace(':','/',$ns));
679
680    $data = array();
681    search($data,$conf['mediadir'],'search_index',array('ns' => $ns, 'nofiles' => true));
682
683    // wrap a list with the root level around the other namespaces
684    $item = array( 'level' => 0, 'id' => '',
685                   'open' =>'true', 'label' => '['.$lang['mediaroot'].']');
686
687    echo '<ul class="idx">';
688    echo media_nstree_li($item);
689    echo media_nstree_item($item);
690    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
691    echo '</li>';
692    echo '</ul>';
693}
694
695/**
696 * Userfunction for html_buildlist
697 *
698 * Prints a media namespace tree item
699 *
700 * @author Andreas Gohr <andi@splitbrain.org>
701 */
702function media_nstree_item($item){
703    $pos   = strrpos($item['id'], ':');
704    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
705    if(!$item['label']) $item['label'] = $label;
706
707    $ret  = '';
708    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
709    $ret .= $item['label'];
710    $ret .= '</a>';
711    return $ret;
712}
713
714/**
715 * Userfunction for html_buildlist
716 *
717 * Prints a media namespace tree item opener
718 *
719 * @author Andreas Gohr <andi@splitbrain.org>
720 */
721function media_nstree_li($item){
722    $class='media level'.$item['level'];
723    if($item['open']){
724        $class .= ' open';
725        $img   = DOKU_BASE.'lib/images/minus.gif';
726        $alt   = '&minus;';
727    }else{
728        $class .= ' closed';
729        $img   = DOKU_BASE.'lib/images/plus.gif';
730        $alt   = '+';
731    }
732    return '<li class="'.$class.'">'.
733           '<img src="'.$img.'" alt="'.$alt.'" />';
734}
735
736/**
737 * Resizes the given image to the given size
738 *
739 * @author  Andreas Gohr <andi@splitbrain.org>
740 */
741function media_resize_image($file, $ext, $w, $h=0){
742  global $conf;
743
744  $info = @getimagesize($file); //get original size
745  if($info == false) return $file; // that's no image - it's a spaceship!
746
747  if(!$h) $h = round(($w * $info[1]) / $info[0]);
748
749  // we wont scale up to infinity
750  if($w > 2000 || $h > 2000) return $file;
751
752  //cache
753  $local = getCacheName($file,'.media.'.$w.'x'.$h.'.'.$ext);
754  $mtime = @filemtime($local); // 0 if not exists
755
756  if( $mtime > filemtime($file) ||
757      media_resize_imageIM($ext,$file,$info[0],$info[1],$local,$w,$h) ||
758      media_resize_imageGD($ext,$file,$info[0],$info[1],$local,$w,$h) ){
759    if($conf['fperm']) chmod($local, $conf['fperm']);
760    return $local;
761  }
762  //still here? resizing failed
763  return $file;
764}
765
766/**
767 * Crops the given image to the wanted ratio, then calls media_resize_image to scale it
768 * to the wanted size
769 *
770 * Crops are centered horizontally but prefer the upper third of an vertical
771 * image because most pics are more interesting in that area (rule of thirds)
772 *
773 * @author  Andreas Gohr <andi@splitbrain.org>
774 */
775function media_crop_image($file, $ext, $w, $h=0){
776  global $conf;
777
778  if(!$h) $h = $w;
779  $info = @getimagesize($file); //get original size
780  if($info == false) return $file; // that's no image - it's a spaceship!
781
782  // calculate crop size
783  $fr = $info[0]/$info[1];
784  $tr = $w/$h;
785  if($tr >= 1){
786    if($tr > $fr){
787        $cw = $info[0];
788        $ch = (int) $info[0]/$tr;
789    }else{
790        $cw = (int) $info[1]*$tr;
791        $ch = $info[1];
792    }
793  }else{
794    if($tr < $fr){
795        $cw = (int) $info[1]*$tr;
796        $ch = $info[1];
797    }else{
798        $cw = $info[0];
799        $ch = (int) $info[0]/$tr;
800    }
801  }
802  // calculate crop offset
803  $cx = (int) ($info[0]-$cw)/2;
804  $cy = (int) ($info[1]-$ch)/3;
805
806  //cache
807  $local = getCacheName($file,'.media.'.$cw.'x'.$ch.'.crop.'.$ext);
808  $mtime = @filemtime($local); // 0 if not exists
809
810  if( $mtime > filemtime($file) ||
811      media_crop_imageIM($ext,$file,$info[0],$info[1],$local,$cw,$ch,$cx,$cy) ||
812      media_resize_imageGD($ext,$file,$cw,$ch,$local,$cw,$ch,$cx,$cy) ){
813    if($conf['fperm']) chmod($local, $conf['fperm']);
814    return media_resize_image($local,$ext, $w, $h);
815  }
816
817  //still here? cropping failed
818  return media_resize_image($file,$ext, $w, $h);
819}
820
821/**
822 * Download a remote file and return local filename
823 *
824 * returns false if download fails. Uses cached file if available and
825 * wanted
826 *
827 * @author  Andreas Gohr <andi@splitbrain.org>
828 * @author  Pavel Vitis <Pavel.Vitis@seznam.cz>
829 */
830function media_get_from_URL($url,$ext,$cache){
831  global $conf;
832
833  // if no cache or fetchsize just redirect
834  if ($cache==0)           return false;
835  if (!$conf['fetchsize']) return false;
836
837  $local = getCacheName(strtolower($url),".media.$ext");
838  $mtime = @filemtime($local); // 0 if not exists
839
840  //decide if download needed:
841  if( ($mtime == 0) ||                           // cache does not exist
842      ($cache != -1 && $mtime < time()-$cache)   // 'recache' and cache has expired
843    ){
844      if(media_image_download($url,$local)){
845        return $local;
846      }else{
847        return false;
848      }
849  }
850
851  //if cache exists use it else
852  if($mtime) return $local;
853
854  //else return false
855  return false;
856}
857
858/**
859 * Download image files
860 *
861 * @author Andreas Gohr <andi@splitbrain.org>
862 */
863function media_image_download($url,$file){
864  global $conf;
865  $http = new DokuHTTPClient();
866  $http->max_bodysize = $conf['fetchsize'];
867  $http->timeout = 25; //max. 25 sec
868  $http->header_regexp = '!\r\nContent-Type: image/(jpe?g|gif|png)!i';
869
870  $data = $http->get($url);
871  if(!$data) return false;
872
873  $fileexists = @file_exists($file);
874  $fp = @fopen($file,"w");
875  if(!$fp) return false;
876  fwrite($fp,$data);
877  fclose($fp);
878  if(!$fileexists and $conf['fperm']) chmod($file, $conf['fperm']);
879
880  // check if it is really an image
881  $info = @getimagesize($file);
882  if(!$info){
883    @unlink($file);
884    return false;
885  }
886
887  return true;
888}
889
890/**
891 * resize images using external ImageMagick convert program
892 *
893 * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
894 * @author Andreas Gohr <andi@splitbrain.org>
895 */
896function media_resize_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h){
897  global $conf;
898
899  // check if convert is configured
900  if(!$conf['im_convert']) return false;
901
902  // prepare command
903  $cmd  = $conf['im_convert'];
904  $cmd .= ' -resize '.$to_w.'x'.$to_h.'!';
905  if ($ext == 'jpg' || $ext == 'jpeg') {
906      $cmd .= ' -quality '.$conf['jpg_quality'];
907  }
908  $cmd .= " $from $to";
909
910  @exec($cmd,$out,$retval);
911  if ($retval == 0) return true;
912  return false;
913}
914
915/**
916 * crop images using external ImageMagick convert program
917 *
918 * @author Andreas Gohr <andi@splitbrain.org>
919 */
920function media_crop_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x,$ofs_y){
921  global $conf;
922
923  // check if convert is configured
924  if(!$conf['im_convert']) return false;
925
926  // prepare command
927  $cmd  = $conf['im_convert'];
928  $cmd .= ' -crop '.$to_w.'x'.$to_h.'+'.$ofs_x.'+'.$ofs_y;
929  if ($ext == 'jpg' || $ext == 'jpeg') {
930      $cmd .= ' -quality '.$conf['jpg_quality'];
931  }
932  $cmd .= " $from $to";
933
934  @exec($cmd,$out,$retval);
935  if ($retval == 0) return true;
936  return false;
937}
938
939/**
940 * resize or crop images using PHP's libGD support
941 *
942 * @author Andreas Gohr <andi@splitbrain.org>
943 * @author Sebastian Wienecke <s_wienecke@web.de>
944 */
945function media_resize_imageGD($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x=0,$ofs_y=0){
946  global $conf;
947
948  if($conf['gdlib'] < 1) return false; //no GDlib available or wanted
949
950  // check available memory
951  if(!is_mem_available(($from_w * $from_h * 4) + ($to_w * $to_h * 4))){
952    return false;
953  }
954
955  // create an image of the given filetype
956  if ($ext == 'jpg' || $ext == 'jpeg'){
957    if(!function_exists("imagecreatefromjpeg")) return false;
958    $image = @imagecreatefromjpeg($from);
959  }elseif($ext == 'png') {
960    if(!function_exists("imagecreatefrompng")) return false;
961    $image = @imagecreatefrompng($from);
962
963  }elseif($ext == 'gif') {
964    if(!function_exists("imagecreatefromgif")) return false;
965    $image = @imagecreatefromgif($from);
966  }
967  if(!$image) return false;
968
969  if(($conf['gdlib']>1) && function_exists("imagecreatetruecolor") && $ext != 'gif'){
970    $newimg = @imagecreatetruecolor ($to_w, $to_h);
971  }
972  if(!$newimg) $newimg = @imagecreate($to_w, $to_h);
973  if(!$newimg){
974    imagedestroy($image);
975    return false;
976  }
977
978  //keep png alpha channel if possible
979  if($ext == 'png' && $conf['gdlib']>1 && function_exists('imagesavealpha')){
980    imagealphablending($newimg, false);
981    imagesavealpha($newimg,true);
982  }
983
984  //keep gif transparent color if possible
985  if($ext == 'gif' && function_exists('imagefill') && function_exists('imagecolorallocate')) {
986    if(function_exists('imagecolorsforindex') && function_exists('imagecolortransparent')) {
987      $transcolorindex = @imagecolortransparent($image);
988      if($transcolorindex >= 0 ) { //transparent color exists
989        $transcolor = @imagecolorsforindex($image, $transcolorindex);
990        $transcolorindex = @imagecolorallocate($newimg, $transcolor['red'], $transcolor['green'], $transcolor['blue']);
991        @imagefill($newimg, 0, 0, $transcolorindex);
992        @imagecolortransparent($newimg, $transcolorindex);
993      }else{ //filling with white
994        $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
995        @imagefill($newimg, 0, 0, $whitecolorindex);
996      }
997    }else{ //filling with white
998      $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
999      @imagefill($newimg, 0, 0, $whitecolorindex);
1000    }
1001  }
1002
1003  //try resampling first
1004  if(function_exists("imagecopyresampled")){
1005    if(!@imagecopyresampled($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h)) {
1006      imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1007    }
1008  }else{
1009    imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1010  }
1011
1012  $okay = false;
1013  if ($ext == 'jpg' || $ext == 'jpeg'){
1014    if(!function_exists('imagejpeg')){
1015      $okay = false;
1016    }else{
1017      $okay = imagejpeg($newimg, $to, $conf['jpg_quality']);
1018    }
1019  }elseif($ext == 'png') {
1020    if(!function_exists('imagepng')){
1021      $okay = false;
1022    }else{
1023      $okay =  imagepng($newimg, $to);
1024    }
1025  }elseif($ext == 'gif') {
1026    if(!function_exists('imagegif')){
1027      $okay = false;
1028    }else{
1029      $okay = imagegif($newimg, $to);
1030    }
1031  }
1032
1033  // destroy GD image ressources
1034  if($image) imagedestroy($image);
1035  if($newimg) imagedestroy($newimg);
1036
1037  return $okay;
1038}
1039
1040/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
1041