xref: /dokuwiki/inc/media.php (revision cf6894df38261b3b92c75d441bbe0a0ba58d963e) 
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    echo '<input type="hidden" name="img" value="'.hsc($id).'" />'.NL;
101    foreach($fields as $key => $field){
102        // get current value
103        $tags = array($field[0]);
104        if(is_array($field[3])) $tags = array_merge($tags,$field[3]);
105        $value = tpl_img_getTag($tags,'',$src);
106
107        // prepare attributes
108        $p = array();
109        $p['class'] = 'edit';
110        $p['id']    = 'meta__'.$key;
111        $p['name']  = 'meta['.$field[0].']';
112
113        // put label
114        echo '<div class="metafield">';
115        echo '<label for="meta__'.$key.'">';
116        echo ($lang[$field[1]]) ? $lang[$field[1]] : $field[1];
117        echo ':</label>';
118
119        // put input field
120        if($field[2] == 'text'){
121            $p['value'] = $value;
122            $p['type']  = 'text';
123            $att = buildAttributes($p);
124            echo "<input $att/>".NL;
125        }else{
126            $att = buildAttributes($p);
127            echo "<textarea $att>".formText($value).'</textarea>'.NL;
128        }
129        echo '</div>'.NL;
130    }
131    echo '<div class="buttons">'.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 '</form>'.NL;
137    echo '</div>';
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
189    $id   = $_POST['id'];
190    $file = $_FILES['upload'];
191    // get id
192    if(empty($id)) $id = $file['name'];
193    $id   = cleanID($ns.':'.$id);  //FIXME handle relative and absolute names here
194    // get filename
195    $fn   = mediaFN($id);
196
197    // get filetype regexp
198    $types = array_keys(getMimeTypes());
199    $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types);
200    $regex = join('|',$types);
201
202    // because a temp file was created already
203    if(preg_match('/\.('.$regex.')$/i',$fn)){
204        //check for overwrite
205        if(@file_exists($fn) && (!$_POST['ow'] || $auth < AUTH_DELETE)){
206            msg($lang['uploadexist'],0);
207            return false;
208        }
209        // prepare directory
210        io_makeFileDir($fn);
211        if(move_uploaded_file($file['tmp_name'], $fn)) {
212            // set the correct permission here
213            if($conf['fperm']) chmod($fn, $conf['fperm']);
214            msg($lang['uploadsucc'],1);
215            return $id;
216        }else{
217            msg($lang['uploadfail'],-1);
218        }
219    }else{
220        msg($lang['uploadwrong'],-1);
221    }
222    return false;
223}
224
225
226
227/**
228 * List all files in a given Media namespace
229 */
230function media_filelist($ns,$auth=null,$jump=''){
231    global $conf;
232    global $lang;
233    $ns = cleanID($ns);
234
235    // check auth our self if not given (needed for ajax calls)
236    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
237
238    echo '<h1>:'.hsc($ns).'</h1>'.NL;
239
240    if($auth < AUTH_READ){
241        // FIXME: print permission warning here instead?
242        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
243        return;
244    }
245
246    media_uploadform($ns, $auth);
247
248    $dir = utf8_encodeFN(str_replace(':','/',$ns));
249    $data = array();
250    search($data,$conf['mediadir'],'search_media',array(),$dir);
251
252    if(!count($data)){
253        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
254        return;
255    }
256
257    foreach($data as $item){
258        media_printfile($item,$auth,$jump);
259    }
260}
261
262/**
263 * Print action links for a file depending on filetype
264 * and available permissions
265 *
266 * @todo contains inline javascript
267 */
268function media_fileactions($item,$auth){
269    global $lang;
270
271    // view button
272    $link = ml($item['id'],'',true);
273    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
274         'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
275
276
277    // no further actions if not writable
278    if(!$item['writable']) return;
279
280    // delete button
281    if($auth >= AUTH_DELETE){
282        $ask  = addslashes($lang['del_confirm']).'\\n';
283        $ask .= addslashes($item['id']);
284
285        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).'" '.
286             'onclick="return confirm(\''.$ask.'\')" onkeypress="return confirm(\''.$ask.'\')">'.
287             '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
288             'title="'.$lang['btn_delete'].'" class="btn" /></a>';
289    }
290
291    // edit button
292    if($auth >= AUTH_UPLOAD && $item['isimg'] && $item['meta']->getField('File.Mime') == 'image/jpeg'){
293        echo ' <a href="'.DOKU_BASE.'lib/exe/mediamanager.php?edit='.rawurlencode($item['id']).'">'.
294             '<img src="'.DOKU_BASE.'lib/images/pencil.png" alt="'.$lang['metaedit'].'" '.
295             'title="'.$lang['metaedit'].'" class="btn" /></a>';
296    }
297
298}
299
300/**
301 * Formats and prints one file in the list
302 */
303function media_printfile($item,$auth,$jump){
304    global $lang;
305
306    // Prepare zebra coloring
307    // I always wanted to use this variable name :-D
308    static $twibble = 1;
309    $twibble *= -1;
310    $zebra = ($twibble == -1) ? 'odd' : 'even';
311
312    // Automatically jump to recent action
313    if($jump == $item['id']) {
314        $jump = ' id="scroll__here" ';
315    }else{
316        $jump = '';
317    }
318
319    // Prepare fileicons
320    list($ext,$mime) = mimetype($item['file']);
321    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
322    $class = 'select mediafile mf_'.$class;
323
324    // Prepare filename
325    $file = utf8_decodeFN($item['file']);
326
327    // Prepare info
328    $info = '';
329    if($item['isimg']){
330        $info .= (int) $item['meta']->getField('File.Width');
331        $info .= '&#215;';
332        $info .= (int) $item['meta']->getField('File.Height');
333        $info .= ' ';
334    }
335    $info .= filesize_h($item['size']);
336
337    // ouput
338    echo '<div class="'.$zebra.'"'.$jump.'>'.NL;
339    echo '<a name="h_'.$item['id'].'" class="'.$class.'">'.$file.'</a> ';
340    echo '<span class="info">('.$info.')</span>'.NL;
341    media_fileactions($item,$auth);
342    echo '<div class="example" id="ex_'.$item['id'].'">';
343    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}<code>';
344    echo '</div>';
345    if($item['isimg']) media_printimgdetail($item);
346    echo '<div class="clearer"></div>'.NL;
347    echo '</div>'.NL;
348}
349
350/**
351 * Prints a thumbnail and metainfos
352 */
353function media_printimgdetail($item){
354    // prepare thumbnail
355    $w = (int) $item['meta']->getField('File.Width');
356    $h = (int) $item['meta']->getField('File.Height');
357    if($w>120 || $h>120){
358        $ratio = $item['meta']->getResizeRatio(120);
359        $w = floor($w * $ratio);
360        $h = floor($h * $ratio);
361    }
362    $src = ml($item['id'],array('w'=>$w,'h'=>$h));
363    $p = array();
364    $p['width']  = $w;
365    $p['height'] = $h;
366    $p['alt']    = $item['id'];
367    $p['class']  = 'thumb';
368    $att = buildAttributes($p);
369
370    // output
371    echo '<div class="detail">';
372    echo '<div class="thumb">';
373    echo '<a name="d_'.$item['id'].'" class="select">';
374    echo '<img src="'.$src.'" '.$att.' />';
375    echo '</a>';
376    echo '</div>';
377
378    //read EXIF/IPTC data
379    echo '<p>';
380    $t = $item['meta']->getField('IPTC.Headline');
381    if($t) echo '<strong>'.htmlspecialchars($t).'</strong><br />';
382
383    $t = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
384                                       'EXIF.TIFFImageDescription',
385                                       'EXIF.TIFFUserComment'));
386    if(utf8_strlen($t) > 250) $t = utf8_substr($t,0,250).'...';
387    if($t) echo htmlspecialchars($t).'<br />';
388
389    $t = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category'));
390    if($t) echo '<em>'.htmlspecialchars($t).'</em>';
391    echo '</p>';
392    echo '</div>';
393}
394
395/**
396 * Print the media upload form if permissions are correct
397 *
398 * @author Andreas Gohr <andi@splitbrain.org>
399 */
400function media_uploadform($ns, $auth){
401    global $lang;
402
403    if($auth < AUTH_UPLOAD) return; //fixme print info on missing permissions?
404
405    ?>
406    <div class="upload"><?php echo $lang['mediaupload']?></div>
407    <form action="<?php echo DOKU_BASE?>lib/exe/mediamanager.php"
408          method="post" enctype="multipart/form-data" class="upload">
409        <input type="hidden" name="ns" value="<?php echo hsc($ns)?>" />
410
411
412        <?php echo $lang['txt_upload']?>:
413        <input type="file" name="upload" class="edit" id="upload__file" /><br />
414
415        <?php echo $lang['txt_filename']?>:
416        <input type="text" name="id" class="edit" id="upload__name" />
417        <input type="submit" class="button" value="<?php echo $lang['btn_upload']?>" accesskey="s" />
418
419        <?php if($auth >= AUTH_DELETE){?>
420            <br />
421            <label for="dw__ow">
422            <input type="checkbox" name="ow" value="1" id="dw__ow" /><?php echo $lang['txt_overwrt']?>
423            </label>
424        <?php }?>
425    </form>
426    <?php
427}
428
429
430
431/**
432 * Build a tree outline of available media namespaces
433 *
434 * @author Andreas Gohr <andi@splitbrain.org>
435 */
436function media_nstree($ns){
437    global $conf;
438
439    // currently selected namespace
440    $ns  = cleanID($ns);
441    if(empty($ns)){
442        $ns = dirname(str_replace(':','/',$ID));
443        if($ns == '.') $ns ='';
444    }
445    $ns  = utf8_encodeFN(str_replace(':','/',$ns));
446
447    $data = array();
448    search($data,$conf['mediadir'],'search_index',array('ns' => $ns));
449
450    // wrap a list with the root level around the other namespaces
451    $item = array( 'level' => 0, 'id' => '', 'open' =>'true', 'label' => ':*');
452
453    echo '<ul class="idx">';
454    echo media_nstree_li($item);
455    echo media_nstree_item($item);
456    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
457    echo '</li>';
458    echo '</ul>';
459}
460
461/**
462 * Userfunction for html_buildlist
463 *
464 * Prints a media namespace tree item
465 *
466 * @author Andreas Gohr <andi@splitbrain.org>
467 */
468function media_nstree_item($item){
469    $pos   = strrpos($item['id'], ':');
470    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
471    if(!$item['label']) $item['label'] = $label;
472
473    $ret  = '';
474    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
475    $ret .= $item['label'];
476    $ret .= '</a>';
477    return $ret;
478}
479
480/**
481 * Userfunction for html_buildlist
482 *
483 * Prints a media namespace tree item opener
484 *
485 * @author Andreas Gohr <andi@splitbrain.org>
486 */
487function media_nstree_li($item){
488    $class='media level'.$item['level'];
489    if($item['open']){
490        $class .= ' open';
491        $img   = DOKU_BASE.'lib/images/minus.gif';
492    }else{
493        $class .= ' closed';
494        $img   = DOKU_BASE.'lib/images/plus.gif';
495    }
496    return '<li class="'.$class.'">'.
497           '<img src="'.$img.'" alt="*" />';
498}
499