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