xref: /dokuwiki/inc/media.php (revision 8cb1eb011a72ab9d73730fff0851c6d1abcabad1) 
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')) define('DOKU_INC',realpath(dirname(__FILE__).'/../').'/');
10if(!defined('NL')) define('NL',"\n");
11
12require_once(DOKU_INC.'inc/html.php');
13require_once(DOKU_INC.'inc/search.php');
14require_once(DOKU_INC.'inc/JpegMeta.php');
15
16/**
17 * Lists pages which currently use a media file selected for deletion
18 *
19 * References uses the same visual as search results and share
20 * their CSS tags except pagenames won't be links.
21 *
22 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
23 */
24function media_filesinuse($data,$id){
25    global $lang;
26    echo '<h1>'.$lang['reference'].' <code>'.hsc(noNS($id)).'</code></h1>';
27    echo '<p>'.hsc($lang['ref_inuse']).'</p>';
28
29    $hidden=0; //count of hits without read permission
30    usort($data,'sort_search_fulltext');
31    foreach($data as $row){
32        if(auth_quickaclcheck($row['id']) >= AUTH_READ){
33            echo '<div class="search_result">';
34            echo '<span class="mediaref_ref">'.$row['id'].'</span>';
35            echo ': <span class="search_cnt">'.$row['count'].' '.$lang['hits'].'</span><br />';
36            echo '<div class="search_snippet">'.$row['snippet'].'</div>';
37            echo '</div>';
38        }else
39        $hidden++;
40    }
41    if ($hidden){
42      print '<div class="mediaref_hidden">'.$lang['ref_hidden'].'</div>';
43    }
44}
45
46/**
47 * Handles the saving of image meta data
48 *
49 * @author Andreas Gohr <andi@splitbrain.org>
50 */
51function media_metasave($id,$auth,$data){
52    if($auth < AUTH_UPLOAD) return false;
53    global $lang;
54    $src = mediaFN($id);
55
56    $meta = new JpegMeta($src);
57    $meta->_parseAll();
58
59    foreach($data as $key => $val){
60        $val=trim($val);
61        if(empty($val)){
62            $meta->deleteField($key);
63        }else{
64            $meta->setField($key,$val);
65        }
66    }
67
68    if($meta->save()){
69        msg($lang['metasaveok'],1);
70        return $id;
71    }else{
72        msg($lang['metasaveerr'],-1);
73        return false;
74    }
75}
76
77/**
78 * Display the form to edit image meta data
79 *
80 * @author Andreas Gohr <andi@splitbrain.org>
81 */
82function media_metaform($id,$auth){
83    if($auth < AUTH_UPLOAD) return false;
84    global $lang;
85
86    // load the field descriptions
87    static $fields = null;
88    if(is_null($fields)){
89        include(DOKU_CONF.'mediameta.php');
90        if(@file_exists(DOKU_CONF.'mediameta.local.php')){
91            include(DOKU_CONF.'mediameta.local.php');
92        }
93    }
94
95    $src = mediaFN($id);
96
97    // output
98    echo '<h1>'.hsc(noNS($id)).'</h1>'.NL;
99    echo '<form action="'.DOKU_BASE.'lib/exe/mediamanager.php" accept-charset="utf-8" method="post" class="meta">'.NL;
100    foreach($fields as $key => $field){
101        // get current value
102        $tags = array($field[0]);
103        if(is_array($field[3])) $tags = array_merge($tags,$field[3]);
104        $value = tpl_img_getTag($tags,'',$src);
105
106        // prepare attributes
107        $p = array();
108        $p['class'] = 'edit';
109        $p['id']    = 'meta__'.$key;
110        $p['name']  = 'meta['.$field[0].']';
111
112        // put label
113        echo '<div class="metafield">';
114        echo '<label for="meta__'.$key.'">';
115        echo ($lang[$field[1]]) ? $lang[$field[1]] : $field[1];
116        echo ':</label>';
117
118        // put input field
119        if($field[2] == 'text'){
120            $p['value'] = $value;
121            $p['type']  = 'text';
122            $att = buildAttributes($p);
123            echo "<input $att/>".NL;
124        }else{
125            $att = buildAttributes($p);
126            echo "<textarea $att rows=\"6\" cols=\"50\">".formText($value).'</textarea>'.NL;
127        }
128        echo '</div>'.NL;
129    }
130    echo '<div class="buttons">'.NL;
131    echo '<input type="hidden" name="img" value="'.hsc($id).'" />'.NL;
132    echo '<input name="do[save]" type="submit" value="'.$lang['btn_save'].
133         '" title="ALT+S" accesskey="s" class="button" />'.NL;
134    echo '<input name="do[cancel]" type="submit" value="'.$lang['btn_cancel'].
135         '" title="ALT+C" accesskey="c" class="button" />'.NL;
136    echo '</div>'.NL;
137    echo '</form>'.NL;
138}
139
140/**
141 * Handles media file deletions
142 *
143 * If configured, checks for media references before deletion
144 *
145 * @author Andreas Gohr <andi@splitbrain.org>
146 * @return mixed false on error, true on delete or array with refs
147 */
148function media_delete($id,$auth){
149    if($auth < AUTH_DELETE) return false;
150    global $conf;
151    global $lang;
152
153    $mediareferences = array();
154    if($conf['refcheck']){
155        search($mediareferences,$conf['datadir'],'search_reference',array('query' => $id));
156    }
157
158    if(!count($mediareferences)){
159        $file = mediaFN($id);
160        if(@unlink($file)){
161            msg(str_replace('%s',noNS($id),$lang['deletesucc']),1);
162            io_sweepNS($id,'mediadir');
163            return true;
164        }
165        //something went wrong
166        msg(str_replace('%s',$file,$lang['deletefail']),-1);
167        return false;
168    }elseif(!$conf['refshow']){
169        msg(str_replace('%s',noNS($id),$lang['mediainuse']),0);
170        return false;
171    }
172
173    return $mediareferences;
174}
175
176/**
177 * Handles media file uploads
178 *
179 * @author Andreas Gohr <andi@splitbrain.org>
180 * @return mixed false on error, id of the new file on success
181 */
182function media_upload($ns,$auth){
183    if($auth < AUTH_UPLOAD) return false;
184    require_once(DOKU_INC.'inc/confutils.php');
185    global $lang;
186    global $conf;
187
188    // get file and id
189    $id   = $_POST['id'];
190    $file = $_FILES['upload'];
191    if(empty($id)) $id = $file['name'];
192
193    // check extensions
194    list($fext,$fmime) = mimetype($file['name']);
195    list($iext,$imime) = mimetype($id);
196    if($fext && !$iext){
197        // no extension specified in id - read original one
198        $id   .= '.'.$fext;
199        $imime = $fmime;
200    }elseif($fext && $fext != $iext){
201        // extension was changed, print warning
202        msg(sprintf($lang['mediaextchange'],$fext,$iext));
203    }
204
205    // get filename
206    $id   = cleanID($ns.':'.$id);
207    $fn   = mediaFN($id);
208
209    // get filetype regexp
210    $types = array_keys(getMimeTypes());
211    $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types);
212    $regex = join('|',$types);
213
214    // because a temp file was created already
215    if(preg_match('/\.('.$regex.')$/i',$fn)){
216        //check for overwrite
217        if(@file_exists($fn) && (!$_POST['ow'] || $auth < AUTH_DELETE)){
218            msg($lang['uploadexist'],0);
219            return false;
220        }
221        // check for valid content
222        $ok = media_contentcheck($file['tmp_name'],$imime);
223        if($ok == -1){
224            msg(sprintf($lang['uploadbadcontent'],".$iext"),-1);
225            return false;
226        }elseif($ok == -2){
227            msg($lang['uploadspam'],-1);
228            return false;
229        }
230
231        // prepare directory
232        io_createNamespace($id, 'media');
233        if(move_uploaded_file($file['tmp_name'], $fn)) {
234            // Set the correct permission here.
235            // Always chmod media because they may be saved with different permissions than expected from the php umask.
236            // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
237            chmod($fn, $conf['fmode']);
238            msg($lang['uploadsucc'],1);
239            return $id;
240        }else{
241            msg($lang['uploadfail'],-1);
242        }
243    }else{
244        msg($lang['uploadwrong'],-1);
245    }
246    return false;
247}
248
249/**
250 * This function checks if the uploaded content is really what the
251 * mimetype says it is. We also do spam checking for text types here
252 *
253 * We need to do this stuff because we can not rely on the browser
254 * to do this check correctly. Yes, IE is broken as usual.
255 *
256 * @author Andreas Gohr <andi@splitbrain.org>
257 * @link   http://weblog.philringnalda.com/2004/04/06/getting-around-ies-mime-type-mangling
258 * @fixme  check all 26 magic IE filetypes here?
259 */
260function media_contentcheck($file,$mime){
261    if(substr($mime,0,6) == 'image/'){
262        $info = @getimagesize($file);
263        if($mime == 'image/gif' && $info[2] != 1){
264            return -1;
265        }elseif($mime == 'image/jpeg' && $info[2] != 2){
266            return -1;
267        }elseif($mime == 'image/png' && $info[2] != 3){
268            return -1;
269        }
270        # fixme maybe check other images types as well
271    }elseif(substr($mime,0,5) == 'text/'){
272        global $TEXT;
273        $TEXT = io_readFile($file);
274        if(checkwordblock()){
275            msg('Content seems to be spam',-1);
276            return -2;
277        }
278    }
279    return 0;
280}
281
282/**
283 * List all files in a given Media namespace
284 */
285function media_filelist($ns,$auth=null,$jump=''){
286    global $conf;
287    global $lang;
288    $ns = cleanID($ns);
289
290    // check auth our self if not given (needed for ajax calls)
291    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
292
293    echo '<h1 id="media__ns">:'.hsc($ns).'</h1>'.NL;
294
295    if($auth < AUTH_READ){
296        // FIXME: print permission warning here instead?
297        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
298        return;
299    }
300
301    media_uploadform($ns, $auth);
302
303    $dir = utf8_encodeFN(str_replace(':','/',$ns));
304    $data = array();
305    search($data,$conf['mediadir'],'search_media',array(),$dir);
306
307    if(!count($data)){
308        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
309        return;
310    }
311
312    foreach($data as $item){
313        media_printfile($item,$auth,$jump);
314    }
315}
316
317/**
318 * Print action links for a file depending on filetype
319 * and available permissions
320 *
321 * @todo contains inline javascript
322 */
323function media_fileactions($item,$auth){
324    global $lang;
325
326    // view button
327    $link = ml($item['id'],'',true);
328    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
329         'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
330
331
332    // no further actions if not writable
333    if(!$item['writable']) return;
334
335    // delete button
336    if($auth >= AUTH_DELETE){
337        $ask  = addslashes($lang['del_confirm']).'\\n';
338        $ask .= addslashes($item['id']);
339
340        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).'" '.
341             'onclick="return confirm(\''.$ask.'\')" onkeypress="return confirm(\''.$ask.'\')">'.
342             '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
343             'title="'.$lang['btn_delete'].'" class="btn" /></a>';
344    }
345
346    // edit button
347    if($auth >= AUTH_UPLOAD && $item['isimg'] && $item['meta']->getField('File.Mime') == 'image/jpeg'){
348        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?edit='.rawurlencode($item['id']).'">'.
349             '<img src="'.DOKU_BASE.'lib/images/pencil.png" alt="'.$lang['metaedit'].'" '.
350             'title="'.$lang['metaedit'].'" class="btn" /></a>';
351    }
352
353}
354
355/**
356 * Formats and prints one file in the list
357 */
358function media_printfile($item,$auth,$jump){
359    global $lang;
360    global $conf;
361
362    // Prepare zebra coloring
363    // I always wanted to use this variable name :-D
364    static $twibble = 1;
365    $twibble *= -1;
366    $zebra = ($twibble == -1) ? 'odd' : 'even';
367
368    // Automatically jump to recent action
369    if($jump == $item['id']) {
370        $jump = ' id="scroll__here" ';
371    }else{
372        $jump = '';
373    }
374
375    // Prepare fileicons
376    list($ext,$mime) = mimetype($item['file']);
377    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
378    $class = 'select mediafile mf_'.$class;
379
380    // Prepare filename
381    $file = utf8_decodeFN($item['file']);
382
383    // Prepare info
384    $info = '';
385    if($item['isimg']){
386        $info .= (int) $item['meta']->getField('File.Width');
387        $info .= '&#215;';
388        $info .= (int) $item['meta']->getField('File.Height');
389        $info .= ' ';
390    }
391    $info .= '<i>'.date($conf['dformat'],$item['mtime']).'</i>';
392    $info .= ' ';
393    $info .= filesize_h($item['size']);
394
395    // ouput
396    echo '<div class="'.$zebra.'"'.$jump.'>'.NL;
397    echo '<a name="h_'.$item['id'].'" class="'.$class.'">'.$file.'</a> ';
398    echo '<span class="info">('.$info.')</span>'.NL;
399    media_fileactions($item,$auth);
400    echo '<div class="example" id="ex_'.$item['id'].'">';
401    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
402    echo '</div>';
403    if($item['isimg']) media_printimgdetail($item);
404    echo '<div class="clearer"></div>'.NL;
405    echo '</div>'.NL;
406}
407
408/**
409 * Prints a thumbnail and metainfos
410 */
411function media_printimgdetail($item){
412    // prepare thumbnail
413    $w = (int) $item['meta']->getField('File.Width');
414    $h = (int) $item['meta']->getField('File.Height');
415    if($w>120 || $h>120){
416        $ratio = $item['meta']->getResizeRatio(120);
417        $w = floor($w * $ratio);
418        $h = floor($h * $ratio);
419    }
420    $src = ml($item['id'],array('w'=>$w,'h'=>$h));
421    $p = array();
422    $p['width']  = $w;
423    $p['height'] = $h;
424    $p['alt']    = $item['id'];
425    $p['class']  = 'thumb';
426    $att = buildAttributes($p);
427
428    // output
429    echo '<div class="detail">';
430    echo '<div class="thumb">';
431    echo '<a name="d_'.$item['id'].'" class="select">';
432    echo '<img src="'.$src.'" '.$att.' />';
433    echo '</a>';
434    echo '</div>';
435
436    // read EXIF/IPTC data
437    $t = $item['meta']->getField('IPTC.Headline');
438    $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
439                                       'EXIF.TIFFImageDescription',
440                                       'EXIF.TIFFUserComment'));
441    if(utf8_strlen($d) > 250) $d = utf8_substr($d,0,250).'...';
442    $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category'));
443
444    // print EXIF/IPTC data
445    if($t || $d || $k ){
446        echo '<p>';
447        if($t) echo '<strong>'.htmlspecialchars($t).'</strong><br />';
448        if($d) echo htmlspecialchars($d).'<br />';
449        if($t) echo '<em>'.htmlspecialchars($k).'</em>';
450        echo '</p>';
451    }
452    echo '</div>';
453}
454
455/**
456 * Print the media upload form if permissions are correct
457 *
458 * @author Andreas Gohr <andi@splitbrain.org>
459 */
460function media_uploadform($ns, $auth){
461    global $lang;
462
463    if($auth < AUTH_UPLOAD) return; //fixme print info on missing permissions?
464
465    ?>
466    <div class="upload"><?php echo $lang['mediaupload']?></div>
467    <form action="<?php echo DOKU_BASE?>lib/exe/mediamanager.php"
468          method="post" enctype="multipart/form-data" class="upload">
469      <fieldset>
470        <input type="hidden" name="ns" value="<?php echo hsc($ns)?>" />
471
472        <p>
473          <label for="upload__file"><?php echo $lang['txt_upload']?>:</label>
474          <input type="file" name="upload" class="edit" id="upload__file" />
475        </p>
476
477        <p>
478          <label for="upload__name"><?php echo $lang['txt_filename']?>:</label>
479          <span class="nowrap">
480          <input type="text" name="id" class="edit" id="upload__name" /><input
481                 type="submit" class="button" value="<?php echo $lang['btn_upload']?>"
482                 accesskey="s" />
483          </span>
484        </p>
485
486        <?php if($auth >= AUTH_DELETE){?>
487            <p>
488              <input type="checkbox" name="ow" value="1" id="dw__ow" class="check" />
489              <label for="dw__ow" class="check"><?php echo $lang['txt_overwrt']?></label>
490            </p>
491        <?php }?>
492      </fieldset>
493    </form>
494    <?php
495}
496
497
498
499/**
500 * Build a tree outline of available media namespaces
501 *
502 * @author Andreas Gohr <andi@splitbrain.org>
503 */
504function media_nstree($ns){
505    global $conf;
506    global $lang;
507
508    // currently selected namespace
509    $ns  = cleanID($ns);
510    if(empty($ns)){
511        $ns = dirname(str_replace(':','/',$ID));
512        if($ns == '.') $ns ='';
513    }
514    $ns  = utf8_encodeFN(str_replace(':','/',$ns));
515
516    $data = array();
517    search($data,$conf['mediadir'],'search_index',array('ns' => $ns, 'nofiles' => true));
518
519    // wrap a list with the root level around the other namespaces
520    $item = array( 'level' => 0, 'id' => '',
521                   'open' =>'true', 'label' => '['.$lang['mediaroot'].']');
522
523    echo '<ul class="idx">';
524    echo media_nstree_li($item);
525    echo media_nstree_item($item);
526    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
527    echo '</li>';
528    echo '</ul>';
529}
530
531/**
532 * Userfunction for html_buildlist
533 *
534 * Prints a media namespace tree item
535 *
536 * @author Andreas Gohr <andi@splitbrain.org>
537 */
538function media_nstree_item($item){
539    $pos   = strrpos($item['id'], ':');
540    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
541    if(!$item['label']) $item['label'] = $label;
542
543    $ret  = '';
544    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
545    $ret .= $item['label'];
546    $ret .= '</a>';
547    return $ret;
548}
549
550/**
551 * Userfunction for html_buildlist
552 *
553 * Prints a media namespace tree item opener
554 *
555 * @author Andreas Gohr <andi@splitbrain.org>
556 */
557function media_nstree_li($item){
558    $class='media level'.$item['level'];
559    if($item['open']){
560        $class .= ' open';
561        $img   = DOKU_BASE.'lib/images/minus.gif';
562        $alt   = '&minus;';
563    }else{
564        $class .= ' closed';
565        $img   = DOKU_BASE.'lib/images/plus.gif';
566        $alt   = '+';
567    }
568    return '<li class="'.$class.'">'.
569           '<img src="'.$img.'" alt="'.$alt.'" />';
570}
571