xref: /dokuwiki/inc/media.php (revision 0877a1f1933ccf27f4a66c74955cd2b65fa0d300)
13df72098SAndreas Gohr<?php
23df72098SAndreas Gohr/**
33df72098SAndreas Gohr * All output and handler function needed for the media management popup
43df72098SAndreas Gohr *
53df72098SAndreas Gohr * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
63df72098SAndreas Gohr * @author     Andreas Gohr <andi@splitbrain.org>
73df72098SAndreas Gohr */
83df72098SAndreas Gohr
9fa8adffeSAndreas Gohrif(!defined('DOKU_INC')) die('meh.');
103df72098SAndreas Gohrif(!defined('NL')) define('NL',"\n");
113df72098SAndreas Gohr
123df72098SAndreas Gohr/**
133df72098SAndreas Gohr * Lists pages which currently use a media file selected for deletion
143df72098SAndreas Gohr *
153df72098SAndreas Gohr * References uses the same visual as search results and share
163df72098SAndreas Gohr * their CSS tags except pagenames won't be links.
173df72098SAndreas Gohr *
183df72098SAndreas Gohr * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
1942ea7f44SGerrit Uitslag *
2042ea7f44SGerrit Uitslag * @param array $data
2142ea7f44SGerrit Uitslag * @param string $id
223df72098SAndreas Gohr */
233df72098SAndreas Gohrfunction media_filesinuse($data,$id){
243df72098SAndreas Gohr    global $lang;
253df72098SAndreas Gohr    echo '<h1>'.$lang['reference'].' <code>'.hsc(noNS($id)).'</code></h1>';
263df72098SAndreas Gohr    echo '<p>'.hsc($lang['ref_inuse']).'</p>';
273df72098SAndreas Gohr
283df72098SAndreas Gohr    $hidden=0; //count of hits without read permission
293df72098SAndreas Gohr    foreach($data as $row){
30a05e297aSAndreas Gohr        if(auth_quickaclcheck($row) >= AUTH_READ && isVisiblePage($row)){
313df72098SAndreas Gohr            echo '<div class="search_result">';
32a05e297aSAndreas Gohr            echo '<span class="mediaref_ref">'.hsc($row).'</span>';
333df72098SAndreas Gohr            echo '</div>';
343df72098SAndreas Gohr        }else
353df72098SAndreas Gohr            $hidden++;
363df72098SAndreas Gohr    }
373df72098SAndreas Gohr    if ($hidden){
383df72098SAndreas Gohr        print '<div class="mediaref_hidden">'.$lang['ref_hidden'].'</div>';
393df72098SAndreas Gohr    }
403df72098SAndreas Gohr}
413df72098SAndreas Gohr
423df72098SAndreas Gohr/**
433df72098SAndreas Gohr * Handles the saving of image meta data
443df72098SAndreas Gohr *
453df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
46cf832786SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
47e0c26282SGerrit Uitslag *
48e0c26282SGerrit Uitslag * @param string $id media id
49e0c26282SGerrit Uitslag * @param int $auth permission level
50e0c26282SGerrit Uitslag * @param array $data
5142ea7f44SGerrit Uitslag * @return false|string
523df72098SAndreas Gohr */
533df72098SAndreas Gohrfunction media_metasave($id,$auth,$data){
543df72098SAndreas Gohr    if($auth < AUTH_UPLOAD) return false;
55f2ea8432SAndreas Gohr    if(!checkSecurityToken()) return false;
563df72098SAndreas Gohr    global $lang;
570b308644SOtto Vainio    global $conf;
583df72098SAndreas Gohr    $src = mediaFN($id);
593df72098SAndreas Gohr
603df72098SAndreas Gohr    $meta = new JpegMeta($src);
613df72098SAndreas Gohr    $meta->_parseAll();
623df72098SAndreas Gohr
633df72098SAndreas Gohr    foreach($data as $key => $val){
643df72098SAndreas Gohr        $val=trim($val);
653df72098SAndreas Gohr        if(empty($val)){
663df72098SAndreas Gohr            $meta->deleteField($key);
673df72098SAndreas Gohr        }else{
683df72098SAndreas Gohr            $meta->setField($key,$val);
693df72098SAndreas Gohr        }
703df72098SAndreas Gohr    }
713df72098SAndreas Gohr
72cf832786SKate Arzamastseva    $old = @filemtime($src);
7379e79377SAndreas Gohr    if(!file_exists(mediaFN($id, $old)) && file_exists($src)) {
74cf832786SKate Arzamastseva        // add old revision to the attic
75cf832786SKate Arzamastseva        media_saveOldRevision($id);
76cf832786SKate Arzamastseva    }
77ac3ed4afSGerrit Uitslag    $filesize_old = filesize($src);
783df72098SAndreas Gohr    if($meta->save()){
790b308644SOtto Vainio        if($conf['fperm']) chmod($src, $conf['fperm']);
80ac3ed4afSGerrit Uitslag        @clearstatcache(true, $src);
81cf832786SKate Arzamastseva        $new = @filemtime($src);
82ac3ed4afSGerrit Uitslag        $filesize_new = filesize($src);
83ac3ed4afSGerrit Uitslag        $sizechange = $filesize_new - $filesize_old;
84ac3ed4afSGerrit Uitslag
85cf832786SKate Arzamastseva        // add a log entry to the media changelog
86ac3ed4afSGerrit Uitslag        addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_EDIT, $lang['media_meta_edited'], '', null, $sizechange);
87cf832786SKate Arzamastseva
883df72098SAndreas Gohr        msg($lang['metasaveok'],1);
893df72098SAndreas Gohr        return $id;
903df72098SAndreas Gohr    }else{
913df72098SAndreas Gohr        msg($lang['metasaveerr'],-1);
923df72098SAndreas Gohr        return false;
933df72098SAndreas Gohr    }
943df72098SAndreas Gohr}
953df72098SAndreas Gohr
963df72098SAndreas Gohr/**
97d54f7963SKlap-in * check if a media is external source
98d54f7963SKlap-in *
99d54f7963SKlap-in * @author Gerrit Uitslag <klapinklapin@gmail.com>
10042ea7f44SGerrit Uitslag *
101d54f7963SKlap-in * @param string $id the media ID or URL
102d54f7963SKlap-in * @return bool
103d54f7963SKlap-in */
104d54f7963SKlap-infunction media_isexternal($id){
105fe578fe9SElan Ruusamäe    if (preg_match('#^(?:https?|ftp)://#i', $id)) return true;
106d54f7963SKlap-in    return false;
107d54f7963SKlap-in}
108d54f7963SKlap-in
109d54f7963SKlap-in/**
110add8678fSAndreas Gohr * Check if a media item is public (eg, external URL or readable by @ALL)
111add8678fSAndreas Gohr *
112add8678fSAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
11342ea7f44SGerrit Uitslag *
114add8678fSAndreas Gohr * @param string $id  the media ID or URL
115add8678fSAndreas Gohr * @return bool
116add8678fSAndreas Gohr */
117add8678fSAndreas Gohrfunction media_ispublic($id){
118d54f7963SKlap-in    if(media_isexternal($id)) return true;
119add8678fSAndreas Gohr    $id = cleanID($id);
120add8678fSAndreas Gohr    if(auth_aclcheck(getNS($id).':*', '', array()) >= AUTH_READ) return true;
121add8678fSAndreas Gohr    return false;
122add8678fSAndreas Gohr}
123add8678fSAndreas Gohr
124add8678fSAndreas Gohr/**
1253df72098SAndreas Gohr * Display the form to edit image meta data
1263df72098SAndreas Gohr *
1273df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
128d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
129e0c26282SGerrit Uitslag *
130e0c26282SGerrit Uitslag * @param string $id media id
131e0c26282SGerrit Uitslag * @param int $auth permission level
132e0c26282SGerrit Uitslag * @return bool
1333df72098SAndreas Gohr */
13430fd72fbSKate Arzamastsevafunction media_metaform($id,$auth){
135ebc28e69SAndreas Gohr    global $lang;
1363df72098SAndreas Gohr
13788a71175SKate Arzamastseva    if($auth < AUTH_UPLOAD) {
13888a71175SKate Arzamastseva        echo '<div class="nothing">'.$lang['media_perm_upload'].'</div>'.NL;
13988a71175SKate Arzamastseva        return false;
14088a71175SKate Arzamastseva    }
14188a71175SKate Arzamastseva
1423df72098SAndreas Gohr    // load the field descriptions
1433df72098SAndreas Gohr    static $fields = null;
1443df72098SAndreas Gohr    if(is_null($fields)){
1453e98e685SKate Arzamastseva        $config_files = getConfigFiles('mediameta');
1463e98e685SKate Arzamastseva        foreach ($config_files as $config_file) {
14779e79377SAndreas Gohr            if(file_exists($config_file)) include($config_file);
1483df72098SAndreas Gohr        }
1493df72098SAndreas Gohr    }
1503df72098SAndreas Gohr
1513df72098SAndreas Gohr    $src = mediaFN($id);
1523df72098SAndreas Gohr
1533df72098SAndreas Gohr    // output
15428db35adSdploeger    $form = new Doku_Form(array('action' => media_managerURL(array('tab_details' => 'view'), '&'),
15595b451bcSAdrian Lang                                'class' => 'meta'));
15695b451bcSAdrian Lang    $form->addHidden('img', $id);
15795b451bcSAdrian Lang    $form->addHidden('mediado', 'save');
1583df72098SAndreas Gohr    foreach($fields as $key => $field){
1593df72098SAndreas Gohr        // get current value
1603e98e685SKate Arzamastseva        if (empty($field[0])) continue;
1613df72098SAndreas Gohr        $tags = array($field[0]);
1623df72098SAndreas Gohr        if(is_array($field[3])) $tags = array_merge($tags,$field[3]);
1633df72098SAndreas Gohr        $value = tpl_img_getTag($tags,'',$src);
164ca6a0701SAndreas Gohr        $value = cleanText($value);
1653df72098SAndreas Gohr
1663df72098SAndreas Gohr        // prepare attributes
1673df72098SAndreas Gohr        $p = array();
1683df72098SAndreas Gohr        $p['class'] = 'edit';
1693df72098SAndreas Gohr        $p['id']    = 'meta__'.$key;
1703df72098SAndreas Gohr        $p['name']  = 'meta['.$field[0].']';
171699c5072SAnika Henke        $p_attrs    = array('class' => 'edit');
1723df72098SAndreas Gohr
17395b451bcSAdrian Lang        $form->addElement('<div class="row">');
1743df72098SAndreas Gohr        if($field[2] == 'text'){
175699c5072SAnika Henke            $form->addElement(form_makeField('text', $p['name'], $value, ($lang[$field[1]]) ? $lang[$field[1]] : $field[1] . ':', $p['id'], $p['class'], $p_attrs));
1763df72098SAndreas Gohr        }else{
1773df72098SAndreas Gohr            $att = buildAttributes($p);
178699c5072SAnika Henke            $form->addElement('<label for="meta__'.$key.'">'.$lang[$field[1]].'</label>');
17995b451bcSAdrian Lang            $form->addElement("<textarea $att rows=\"6\" cols=\"50\">".formText($value).'</textarea>');
1803df72098SAndreas Gohr        }
18194add303SAnika Henke        $form->addElement('</div>'.NL);
1823df72098SAndreas Gohr    }
18395b451bcSAdrian Lang    $form->addElement('<div class="buttons">');
18495b451bcSAdrian Lang    $form->addElement(form_makeButton('submit', '', $lang['btn_save'], array('accesskey' => 's', 'name' => 'mediado[save]')));
18594add303SAnika Henke    $form->addElement('</div>'.NL);
18695b451bcSAdrian Lang    $form->printForm();
187ebc28e69SAndreas Gohr
188ebc28e69SAndreas Gohr    return true;
1893df72098SAndreas Gohr}
1903df72098SAndreas Gohr
191666cdec5SMichael Klier/**
19287229c84SAdrian Lang * Convenience function to check if a media file is still in use
193666cdec5SMichael Klier *
194666cdec5SMichael Klier * @author Michael Klier <chi@chimeric.de>
195e0c26282SGerrit Uitslag *
196e0c26282SGerrit Uitslag * @param string $id media id
197e0c26282SGerrit Uitslag * @return array|bool
198666cdec5SMichael Klier */
199666cdec5SMichael Klierfunction media_inuse($id) {
200666cdec5SMichael Klier    global $conf;
201ebc28e69SAndreas Gohr
202666cdec5SMichael Klier    if($conf['refcheck']){
203ffec1009SMichael Hamann        $mediareferences = ft_mediause($id,true);
204666cdec5SMichael Klier        if(!count($mediareferences)) {
2056dae2464SAndreas Gohr            return false;
206666cdec5SMichael Klier        } else {
207666cdec5SMichael Klier            return $mediareferences;
208666cdec5SMichael Klier        }
209666cdec5SMichael Klier    } else {
210666cdec5SMichael Klier        return false;
211666cdec5SMichael Klier    }
212666cdec5SMichael Klier}
213a05e297aSAndreas Gohr
21487229c84SAdrian Langdefine('DOKU_MEDIA_DELETED', 1);
21587229c84SAdrian Langdefine('DOKU_MEDIA_NOT_AUTH', 2);
21687229c84SAdrian Langdefine('DOKU_MEDIA_INUSE', 4);
21787229c84SAdrian Langdefine('DOKU_MEDIA_EMPTY_NS', 8);
21887229c84SAdrian Lang
2193df72098SAndreas Gohr/**
2203df72098SAndreas Gohr * Handles media file deletions
2213df72098SAndreas Gohr *
2223df72098SAndreas Gohr * If configured, checks for media references before deletion
2233df72098SAndreas Gohr *
2243df72098SAndreas Gohr * @author             Andreas Gohr <andi@splitbrain.org>
22542ea7f44SGerrit Uitslag *
226ebc28e69SAndreas Gohr * @param string $id media id
22722db8df7SAndreas Gohr * @param int $auth no longer used
22887229c84SAdrian Lang * @return int One of: 0,
22963703ba5SAndreas Gohr *                     DOKU_MEDIA_DELETED,
23063703ba5SAndreas Gohr *                     DOKU_MEDIA_DELETED | DOKU_MEDIA_EMPTY_NS,
23163703ba5SAndreas Gohr *                     DOKU_MEDIA_NOT_AUTH,
23263703ba5SAndreas Gohr *                     DOKU_MEDIA_INUSE
2333df72098SAndreas Gohr */
2343df72098SAndreas Gohrfunction media_delete($id,$auth){
2356183fb05SKate Arzamastseva    global $lang;
236ff04e8b7SAndreas Gohr    $auth = auth_quickaclcheck(ltrim(getNS($id).':*', ':'));
23787229c84SAdrian Lang    if($auth < AUTH_DELETE) return DOKU_MEDIA_NOT_AUTH;
23887229c84SAdrian Lang    if(media_inuse($id)) return DOKU_MEDIA_INUSE;
2393df72098SAndreas Gohr
2403df72098SAndreas Gohr    $file = mediaFN($id);
2414a961e72SMichal Kolodziejski
2424a961e72SMichal Kolodziejski    // trigger an event - MEDIA_DELETE_FILE
24359bc3b48SGerrit Uitslag    $data = array();
244666cdec5SMichael Klier    $data['id']   = $id;
2453009a773SAndreas Gohr    $data['name'] = utf8_basename($file);
2464a961e72SMichal Kolodziejski    $data['path'] = $file;
24779e79377SAndreas Gohr    $data['size'] = (file_exists($file)) ? filesize($file) : 0;
248666cdec5SMichael Klier
249666cdec5SMichael Klier    $data['unl'] = false;
250666cdec5SMichael Klier    $data['del'] = false;
2514a961e72SMichal Kolodziejski    $evt = new Doku_Event('MEDIA_DELETE_FILE',$data);
2524a961e72SMichal Kolodziejski    if ($evt->advise_before()) {
2536183fb05SKate Arzamastseva        $old = @filemtime($file);
25479e79377SAndreas Gohr        if(!file_exists(mediaFN($id, $old)) && file_exists($file)) {
2556183fb05SKate Arzamastseva            // add old revision to the attic
2566183fb05SKate Arzamastseva            media_saveOldRevision($id);
2576183fb05SKate Arzamastseva        }
2586183fb05SKate Arzamastseva
259666cdec5SMichael Klier        $data['unl'] = @unlink($file);
260666cdec5SMichael Klier        if($data['unl']) {
261ac3ed4afSGerrit Uitslag            $sizechange = 0 - $data['size'];
262ac3ed4afSGerrit Uitslag            addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE, $lang['deleted'], '', null, $sizechange);
263ac3ed4afSGerrit Uitslag
264666cdec5SMichael Klier            $data['del'] = io_sweepNS($id, 'mediadir');
2653df72098SAndreas Gohr        }
2664a961e72SMichal Kolodziejski    }
2674a961e72SMichal Kolodziejski    $evt->advise_after();
2684a961e72SMichal Kolodziejski    unset($evt);
2694a961e72SMichal Kolodziejski
270666cdec5SMichael Klier    if($data['unl'] && $data['del']){
27187229c84SAdrian Lang        return DOKU_MEDIA_DELETED | DOKU_MEDIA_EMPTY_NS;
2723df72098SAndreas Gohr    }
2733df72098SAndreas Gohr
27487229c84SAdrian Lang    return $data['unl'] ? DOKU_MEDIA_DELETED : 0;
2753df72098SAndreas Gohr}
2763df72098SAndreas Gohr
2773df72098SAndreas Gohr/**
2782d6cc64fSKate Arzamastseva * Handle file uploads via XMLHttpRequest
2792d6cc64fSKate Arzamastseva *
280ebc28e69SAndreas Gohr * @param string $ns   target namespace
281ebc28e69SAndreas Gohr * @param int    $auth current auth check result
28242ea7f44SGerrit Uitslag * @return false|string false on error, id of the new file on success
2832d6cc64fSKate Arzamastseva */
2842d6cc64fSKate Arzamastsevafunction media_upload_xhr($ns,$auth){
285da45d883SKate Arzamastseva    if(!checkSecurityToken()) return false;
2868108113cSTom N Harris    global $INPUT;
287da45d883SKate Arzamastseva
2888108113cSTom N Harris    $id = $INPUT->get->str('qqfile');
289ebc28e69SAndreas Gohr    list($ext,$mime) = mimetype($id);
2902d6cc64fSKate Arzamastseva    $input = fopen("php://input", "r");
2912d6cc64fSKate Arzamastseva    if (!($tmp = io_mktmpdir())) return false;
29262231793SKate Arzamastseva    $path = $tmp.'/'.md5($id);
2932d6cc64fSKate Arzamastseva    $target = fopen($path, "w");
294063fb5b5SAndreas Gohr    $realSize = stream_copy_to_stream($input, $target);
2952d6cc64fSKate Arzamastseva    fclose($target);
296063fb5b5SAndreas Gohr    fclose($input);
297fed6fccbSAnika Henke    if (isset($_SERVER["CONTENT_LENGTH"]) && ($realSize != (int)$_SERVER["CONTENT_LENGTH"])){
298063fb5b5SAndreas Gohr        unlink($path);
299063fb5b5SAndreas Gohr        return false;
300063fb5b5SAndreas Gohr    }
301063fb5b5SAndreas Gohr
3022d6cc64fSKate Arzamastseva    $res = media_save(
3032d6cc64fSKate Arzamastseva        array('name' => $path,
3042d6cc64fSKate Arzamastseva            'mime' => $mime,
3052d6cc64fSKate Arzamastseva            'ext'  => $ext),
3062d6cc64fSKate Arzamastseva        $ns.':'.$id,
307d1264f55S錢政維        (($INPUT->get->str('ow') == 'true') ? true : false),
3082d6cc64fSKate Arzamastseva        $auth,
3092d6cc64fSKate Arzamastseva        'copy'
3102d6cc64fSKate Arzamastseva    );
3112d6cc64fSKate Arzamastseva    unlink($path);
312900a9e9eSGerrit Uitslag    if ($tmp) io_rmdir($tmp, true);
3132d6cc64fSKate Arzamastseva    if (is_array($res)) {
3142d6cc64fSKate Arzamastseva        msg($res[0], $res[1]);
3152d6cc64fSKate Arzamastseva        return false;
3162d6cc64fSKate Arzamastseva    }
3172d6cc64fSKate Arzamastseva    return $res;
3182d6cc64fSKate Arzamastseva}
3192d6cc64fSKate Arzamastseva
3202d6cc64fSKate Arzamastseva/**
3213df72098SAndreas Gohr * Handles media file uploads
3223df72098SAndreas Gohr *
3233df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
32411d9dfa5SMichael Klier * @author Michael Klier <chi@chimeric.de>
32542ea7f44SGerrit Uitslag *
326ebc28e69SAndreas Gohr * @param string     $ns    target namespace
327ebc28e69SAndreas Gohr * @param int        $auth  current auth check result
328ebc28e69SAndreas Gohr * @param bool|array $file  $_FILES member, $_FILES['upload'] if false
32942ea7f44SGerrit Uitslag * @return false|string false on error, id of the new file on success
3303df72098SAndreas Gohr */
3312d6cc64fSKate Arzamastsevafunction media_upload($ns,$auth,$file=false){
332f2ea8432SAndreas Gohr    if(!checkSecurityToken()) return false;
3333df72098SAndreas Gohr    global $lang;
3348108113cSTom N Harris    global $INPUT;
3353df72098SAndreas Gohr
33644409c3dSAndreas Gohr    // get file and id
3378108113cSTom N Harris    $id   = $INPUT->post->str('mediaid');
3382d6cc64fSKate Arzamastseva    if (!$file) $file = $_FILES['upload'];
3393df72098SAndreas Gohr    if(empty($id)) $id = $file['name'];
34044409c3dSAndreas Gohr
34199766eefSAndreas Gohr    // check for errors (messages are done in lib/exe/mediamanager.php)
34299766eefSAndreas Gohr    if($file['error']) return false;
3439676dc23SAndreas Gohr
34444409c3dSAndreas Gohr    // check extensions
345ebc28e69SAndreas Gohr    list($fext,$fmime) = mimetype($file['name']);
346ebc28e69SAndreas Gohr    list($iext,$imime) = mimetype($id);
34744409c3dSAndreas Gohr    if($fext && !$iext){
3488cb1eb01SAndreas Gohr        // no extension specified in id - read original one
34944409c3dSAndreas Gohr        $id   .= '.'.$fext;
3508cb1eb01SAndreas Gohr        $imime = $fmime;
35144409c3dSAndreas Gohr    }elseif($fext && $fext != $iext){
35244409c3dSAndreas Gohr        // extension was changed, print warning
35344409c3dSAndreas Gohr        msg(sprintf($lang['mediaextchange'],$fext,$iext));
35444409c3dSAndreas Gohr    }
35544409c3dSAndreas Gohr
356ffb291f2SAdrian Lang    $res = media_save(array('name' => $file['tmp_name'],
357ffb291f2SAdrian Lang                            'mime' => $imime,
358ffb291f2SAdrian Lang                            'ext'  => $iext), $ns.':'.$id,
35971f17ac4SAndreas Gohr                      $INPUT->post->bool('ow'), $auth, 'copy_uploaded_file');
360ffb291f2SAdrian Lang    if (is_array($res)) {
361ffb291f2SAdrian Lang        msg($res[0], $res[1]);
362ffb291f2SAdrian Lang        return false;
363ffb291f2SAdrian Lang    }
364ffb291f2SAdrian Lang    return $res;
365ffb291f2SAdrian Lang}
366ffb291f2SAdrian Lang
367ffb291f2SAdrian Lang/**
36871f17ac4SAndreas Gohr * An alternative to move_uploaded_file that copies
36971f17ac4SAndreas Gohr *
37071f17ac4SAndreas Gohr * Using copy, makes sure any setgid bits on the media directory are honored
37171f17ac4SAndreas Gohr *
37271f17ac4SAndreas Gohr * @see   move_uploaded_file()
37342ea7f44SGerrit Uitslag *
37471f17ac4SAndreas Gohr * @param string $from
37571f17ac4SAndreas Gohr * @param string $to
37671f17ac4SAndreas Gohr * @return bool
37771f17ac4SAndreas Gohr */
37871f17ac4SAndreas Gohrfunction copy_uploaded_file($from, $to){
37971f17ac4SAndreas Gohr    if(!is_uploaded_file($from)) return false;
38071f17ac4SAndreas Gohr    $ok = copy($from, $to);
38171f17ac4SAndreas Gohr    @unlink($from);
38271f17ac4SAndreas Gohr    return $ok;
38371f17ac4SAndreas Gohr}
38471f17ac4SAndreas Gohr
38571f17ac4SAndreas Gohr/**
386ffb291f2SAdrian Lang * This generates an action event and delegates to _media_upload_action().
387ffb291f2SAdrian Lang * Action plugins are allowed to pre/postprocess the uploaded file.
388ffb291f2SAdrian Lang * (The triggered event is preventable.)
389ffb291f2SAdrian Lang *
390ffb291f2SAdrian Lang * Event data:
391ffb291f2SAdrian Lang * $data[0]     fn_tmp:    the temporary file name (read from $_FILES)
392ffb291f2SAdrian Lang * $data[1]     fn:        the file name of the uploaded file
393ffb291f2SAdrian Lang * $data[2]     id:        the future directory id of the uploaded file
394ffb291f2SAdrian Lang * $data[3]     imime:     the mimetype of the uploaded file
395ffb291f2SAdrian Lang * $data[4]     overwrite: if an existing file is going to be overwritten
39652a281e8SGerrit Uitslag * $data[5]     move:      name of function that performs move/copy/..
397ffb291f2SAdrian Lang *
398ffb291f2SAdrian Lang * @triggers MEDIA_UPLOAD_FINISH
39942ea7f44SGerrit Uitslag *
400e0c26282SGerrit Uitslag * @param array  $file
40152a281e8SGerrit Uitslag * @param string $id   media id
40242ea7f44SGerrit Uitslag * @param bool   $ow   overwrite?
403e0c26282SGerrit Uitslag * @param int    $auth permission level
40452a281e8SGerrit Uitslag * @param string $move name of functions that performs move/copy/..
40542ea7f44SGerrit Uitslag * @return false|array|string
406e0c26282SGerrit Uitslag */
407ffb291f2SAdrian Langfunction media_save($file, $id, $ow, $auth, $move) {
408ffb291f2SAdrian Lang    if($auth < AUTH_UPLOAD) {
409ffb291f2SAdrian Lang        return array("You don't have permissions to upload files.", -1);
410ffb291f2SAdrian Lang    }
411ffb291f2SAdrian Lang
412ffb291f2SAdrian Lang    if (!isset($file['mime']) || !isset($file['ext'])) {
413ffb291f2SAdrian Lang        list($ext, $mime) = mimetype($id);
414ffb291f2SAdrian Lang        if (!isset($file['mime'])) {
415ffb291f2SAdrian Lang            $file['mime'] = $mime;
416ffb291f2SAdrian Lang        }
417ffb291f2SAdrian Lang        if (!isset($file['ext'])) {
418ffb291f2SAdrian Lang            $file['ext'] = $ext;
419ffb291f2SAdrian Lang        }
420ffb291f2SAdrian Lang    }
421ffb291f2SAdrian Lang
42292cac9a9SKate Arzamastseva    global $lang, $conf;
423ffb291f2SAdrian Lang
4243df72098SAndreas Gohr    // get filename
4253543c6deSAndreas Gohr    $id   = cleanID($id);
4263df72098SAndreas Gohr    $fn   = mediaFN($id);
4273df72098SAndreas Gohr
4283df72098SAndreas Gohr    // get filetype regexp
4293df72098SAndreas Gohr    $types = array_keys(getMimeTypes());
430bad6fc0dSAndreas Gohr    $types = array_map(
431bad6fc0dSAndreas Gohr        function ($q) {
432bad6fc0dSAndreas Gohr            return preg_quote($q, "/");
433bad6fc0dSAndreas Gohr        },
434bad6fc0dSAndreas Gohr        $types
435bad6fc0dSAndreas Gohr    );
4363df72098SAndreas Gohr    $regex = join('|',$types);
4373df72098SAndreas Gohr
4383df72098SAndreas Gohr    // because a temp file was created already
439ffb291f2SAdrian Lang    if(!preg_match('/\.('.$regex.')$/i',$fn)) {
440ffb291f2SAdrian Lang        return array($lang['uploadwrong'],-1);
441ffb291f2SAdrian Lang    }
442ffb291f2SAdrian Lang
4433df72098SAndreas Gohr    //check for overwrite
44479e79377SAndreas Gohr    $overwrite = file_exists($fn);
445e5d185e1SKate Arzamastseva    $auth_ow = (($conf['mediarevisions']) ? AUTH_UPLOAD : AUTH_DELETE);
446e5d185e1SKate Arzamastseva    if($overwrite && (!$ow || $auth < $auth_ow)) {
447ffb291f2SAdrian Lang        return array($lang['uploadexist'], 0);
4483df72098SAndreas Gohr    }
4498cb1eb01SAndreas Gohr    // check for valid content
450ffb291f2SAdrian Lang    $ok = media_contentcheck($file['name'], $file['mime']);
4518cb1eb01SAndreas Gohr    if($ok == -1){
452ffb291f2SAdrian Lang        return array(sprintf($lang['uploadbadcontent'],'.' . $file['ext']),-1);
4538cb1eb01SAndreas Gohr    }elseif($ok == -2){
454ffb291f2SAdrian Lang        return array($lang['uploadspam'],-1);
45526ceae18SAndreas Gohr    }elseif($ok == -3){
456ffb291f2SAdrian Lang        return array($lang['uploadxss'],-1);
4578cb1eb01SAndreas Gohr    }
4588cb1eb01SAndreas Gohr
45911d9dfa5SMichael Klier    // prepare event data
46059bc3b48SGerrit Uitslag    $data = array();
461ffb291f2SAdrian Lang    $data[0] = $file['name'];
46211d9dfa5SMichael Klier    $data[1] = $fn;
46311d9dfa5SMichael Klier    $data[2] = $id;
464ffb291f2SAdrian Lang    $data[3] = $file['mime'];
46599c8d7f2Smichael    $data[4] = $overwrite;
466ffb291f2SAdrian Lang    $data[5] = $move;
46711d9dfa5SMichael Klier
46811d9dfa5SMichael Klier    // trigger event
46911d9dfa5SMichael Klier    return trigger_event('MEDIA_UPLOAD_FINISH', $data, '_media_upload_action', true);
47011d9dfa5SMichael Klier}
47111d9dfa5SMichael Klier
47211d9dfa5SMichael Klier/**
47342ea7f44SGerrit Uitslag * Callback adapter for media_upload_finish() triggered by MEDIA_UPLOAD_FINISH
47442ea7f44SGerrit Uitslag *
47511d9dfa5SMichael Klier * @author Michael Klier <chi@chimeric.de>
47642ea7f44SGerrit Uitslag *
47742ea7f44SGerrit Uitslag * @param array $data event data
47842ea7f44SGerrit Uitslag * @return false|array|string
47911d9dfa5SMichael Klier */
48011d9dfa5SMichael Klierfunction _media_upload_action($data) {
48111d9dfa5SMichael Klier    // fixme do further sanity tests of given data?
482ffb291f2SAdrian Lang    if(is_array($data) && count($data)===6) {
483ffb291f2SAdrian Lang        return media_upload_finish($data[0], $data[1], $data[2], $data[3], $data[4], $data[5]);
48411d9dfa5SMichael Klier    } else {
48511d9dfa5SMichael Klier        return false; //callback error
48611d9dfa5SMichael Klier    }
48711d9dfa5SMichael Klier}
48811d9dfa5SMichael Klier
48911d9dfa5SMichael Klier/**
49011d9dfa5SMichael Klier * Saves an uploaded media file
49111d9dfa5SMichael Klier *
49211d9dfa5SMichael Klier * @author Andreas Gohr <andi@splitbrain.org>
49311d9dfa5SMichael Klier * @author Michael Klier <chi@chimeric.de>
494cbe26ad6SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
49542ea7f44SGerrit Uitslag *
49642ea7f44SGerrit Uitslag * @param string $fn_tmp
49742ea7f44SGerrit Uitslag * @param string $fn
49842ea7f44SGerrit Uitslag * @param string $id        media id
49942ea7f44SGerrit Uitslag * @param string $imime     mime type
50042ea7f44SGerrit Uitslag * @param bool   $overwrite overwrite existing?
50142ea7f44SGerrit Uitslag * @param string $move      function name
50242ea7f44SGerrit Uitslag * @return array|string
50311d9dfa5SMichael Klier */
504ffb291f2SAdrian Langfunction media_upload_finish($fn_tmp, $fn, $id, $imime, $overwrite, $move = 'move_uploaded_file') {
50511d9dfa5SMichael Klier    global $conf;
50611d9dfa5SMichael Klier    global $lang;
5079c1bd4bcSKate Arzamastseva    global $REV;
50811d9dfa5SMichael Klier
509e4f389efSKate Arzamastseva    $old = @filemtime($fn);
51079e79377SAndreas Gohr    if(!file_exists(mediaFN($id, $old)) && file_exists($fn)) {
511e4f389efSKate Arzamastseva        // add old revision to the attic if missing
512cbe26ad6SKate Arzamastseva        media_saveOldRevision($id);
513e4f389efSKate Arzamastseva    }
514e4f389efSKate Arzamastseva
5153df72098SAndreas Gohr    // prepare directory
516cc7d0c94SBen Coburn    io_createNamespace($id, 'media');
51711d9dfa5SMichael Klier
518ac3ed4afSGerrit Uitslag    $filesize_old = file_exists($fn) ? filesize($fn) : 0;
519ac3ed4afSGerrit Uitslag
520ffb291f2SAdrian Lang    if($move($fn_tmp, $fn)) {
52123846a98SKate Arzamastseva        @clearstatcache(true,$fn);
522dad6764eSKate Arzamastseva        $new = @filemtime($fn);
52374400ea5SBen Coburn        // Set the correct permission here.
52474400ea5SBen Coburn        // Always chmod media because they may be saved with different permissions than expected from the php umask.
52574400ea5SBen Coburn        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
52674400ea5SBen Coburn        chmod($fn, $conf['fmode']);
5273df72098SAndreas Gohr        msg($lang['uploadsucc'],1);
52868ef8942SKate Arzamastseva        media_notify($id,$fn,$imime,$old);
52999c8d7f2Smichael        // add a log entry to the media changelog
530ac3ed4afSGerrit Uitslag        $filesize_new = filesize($fn);
531ac3ed4afSGerrit Uitslag        $sizechange = $filesize_new - $filesize_old;
5329c1bd4bcSKate Arzamastseva        if($REV) {
533ac3ed4afSGerrit Uitslag            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_REVERT, sprintf($lang['restored'], dformat($REV)), $REV, null, $sizechange);
5349c1bd4bcSKate Arzamastseva        } elseif($overwrite) {
535ac3ed4afSGerrit Uitslag            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_EDIT, '', '', null, $sizechange);
53699c8d7f2Smichael        } else {
537ac3ed4afSGerrit Uitslag            addMediaLogEntry($new, $id, DOKU_CHANGE_TYPE_CREATE, $lang['created'], '', null, $sizechange);
53899c8d7f2Smichael        }
5393df72098SAndreas Gohr        return $id;
5403df72098SAndreas Gohr    }else{
541ffb291f2SAdrian Lang        return array($lang['uploadfail'],-1);
5423df72098SAndreas Gohr    }
5433df72098SAndreas Gohr}
5443df72098SAndreas Gohr
5458cb1eb01SAndreas Gohr/**
546cbe26ad6SKate Arzamastseva * Moves the current version of media file to the media_attic
547cbe26ad6SKate Arzamastseva * directory
548cbe26ad6SKate Arzamastseva *
549cbe26ad6SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
55042ea7f44SGerrit Uitslag *
551cbe26ad6SKate Arzamastseva * @param string $id
552cbe26ad6SKate Arzamastseva * @return int - revision date
553e4f389efSKate Arzamastseva */
554cbe26ad6SKate Arzamastsevafunction media_saveOldRevision($id){
555dbf57c96SKate Arzamastseva    global $conf, $lang;
556dbf57c96SKate Arzamastseva
557e4f389efSKate Arzamastseva    $oldf = mediaFN($id);
55879e79377SAndreas Gohr    if(!file_exists($oldf)) return '';
559e4f389efSKate Arzamastseva    $date = filemtime($oldf);
560e5d185e1SKate Arzamastseva    if (!$conf['mediarevisions']) return $date;
561e5d185e1SKate Arzamastseva
562047bad06SGerrit Uitslag    $medialog = new MediaChangeLog($id);
563047bad06SGerrit Uitslag    if (!$medialog->getRevisionInfo($date)) {
564dbf57c96SKate Arzamastseva        // there was an external edit,
565dbf57c96SKate Arzamastseva        // there is no log entry for current version of file
566ac3ed4afSGerrit Uitslag        $sizechange = filesize($oldf);
56779e79377SAndreas Gohr        if(!file_exists(mediaMetaFN($id, '.changes'))) {
568ac3ed4afSGerrit Uitslag            addMediaLogEntry($date, $id, DOKU_CHANGE_TYPE_CREATE, $lang['created'], '', null, $sizechange);
569dbf57c96SKate Arzamastseva        } else {
570ac3ed4afSGerrit Uitslag            $oldRev = $medialog->getRevisions(-1, 1); // from changelog
571ac3ed4afSGerrit Uitslag            $oldRev = (int) (empty($oldRev) ? 0 : $oldRev[0]);
572ac3ed4afSGerrit Uitslag            $filesize_old = filesize(mediaFN($id, $oldRev));
573ac3ed4afSGerrit Uitslag            $sizechange = $sizechange - $filesize_old;
574ac3ed4afSGerrit Uitslag
575ac3ed4afSGerrit Uitslag            addMediaLogEntry($date, $id, DOKU_CHANGE_TYPE_EDIT, '', '', null, $sizechange);
576dbf57c96SKate Arzamastseva        }
577dbf57c96SKate Arzamastseva    }
578dbf57c96SKate Arzamastseva
579e4f389efSKate Arzamastseva    $newf = mediaFN($id,$date);
580e4f389efSKate Arzamastseva    io_makeFileDir($newf);
581cbe26ad6SKate Arzamastseva    if(copy($oldf, $newf)) {
582e4f389efSKate Arzamastseva        // Set the correct permission here.
583e4f389efSKate Arzamastseva        // Always chmod media because they may be saved with different permissions than expected from the php umask.
584e4f389efSKate Arzamastseva        // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
585e4f389efSKate Arzamastseva        chmod($newf, $conf['fmode']);
586e4f389efSKate Arzamastseva    }
587e4f389efSKate Arzamastseva    return $date;
588e4f389efSKate Arzamastseva}
589e4f389efSKate Arzamastseva
590e4f389efSKate Arzamastseva/**
5918cb1eb01SAndreas Gohr * This function checks if the uploaded content is really what the
59226ceae18SAndreas Gohr * mimetype says it is. We also do spam checking for text types here.
5938cb1eb01SAndreas Gohr *
5948cb1eb01SAndreas Gohr * We need to do this stuff because we can not rely on the browser
5958cb1eb01SAndreas Gohr * to do this check correctly. Yes, IE is broken as usual.
5968cb1eb01SAndreas Gohr *
5978cb1eb01SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
59826ceae18SAndreas Gohr * @link   http://www.splitbrain.org/blog/2007-02/12-internet_explorer_facilitates_cross_site_scripting
5998cb1eb01SAndreas Gohr * @fixme  check all 26 magic IE filetypes here?
60042ea7f44SGerrit Uitslag *
60142ea7f44SGerrit Uitslag * @param string $file path to file
60242ea7f44SGerrit Uitslag * @param string $mime mimetype
60342ea7f44SGerrit Uitslag * @return int
6048cb1eb01SAndreas Gohr */
6058cb1eb01SAndreas Gohrfunction media_contentcheck($file,$mime){
60626ceae18SAndreas Gohr    global $conf;
60726ceae18SAndreas Gohr    if($conf['iexssprotect']){
60826ceae18SAndreas Gohr        $fh = @fopen($file, 'rb');
60926ceae18SAndreas Gohr        if($fh){
61026ceae18SAndreas Gohr            $bytes = fread($fh, 256);
61126ceae18SAndreas Gohr            fclose($fh);
61226ceae18SAndreas Gohr            if(preg_match('/<(script|a|img|html|body|iframe)[\s>]/i',$bytes)){
61342ea7f44SGerrit Uitslag                return -3; //XSS: possibly malicious content
61426ceae18SAndreas Gohr            }
61526ceae18SAndreas Gohr        }
61626ceae18SAndreas Gohr    }
6178cb1eb01SAndreas Gohr    if(substr($mime,0,6) == 'image/'){
6188cb1eb01SAndreas Gohr        $info = @getimagesize($file);
6198cb1eb01SAndreas Gohr        if($mime == 'image/gif' && $info[2] != 1){
62042ea7f44SGerrit Uitslag            return -1; // uploaded content did not match the file extension
6218cb1eb01SAndreas Gohr        }elseif($mime == 'image/jpeg' && $info[2] != 2){
6228cb1eb01SAndreas Gohr            return -1;
6238cb1eb01SAndreas Gohr        }elseif($mime == 'image/png' && $info[2] != 3){
6248cb1eb01SAndreas Gohr            return -1;
6258cb1eb01SAndreas Gohr        }
6268cb1eb01SAndreas Gohr        # fixme maybe check other images types as well
6278cb1eb01SAndreas Gohr    }elseif(substr($mime,0,5) == 'text/'){
6288cb1eb01SAndreas Gohr        global $TEXT;
6298cb1eb01SAndreas Gohr        $TEXT = io_readFile($file);
6308cb1eb01SAndreas Gohr        if(checkwordblock()){
63142ea7f44SGerrit Uitslag            return -2; //blocked by the spam blacklist
6328cb1eb01SAndreas Gohr        }
6338cb1eb01SAndreas Gohr    }
6348cb1eb01SAndreas Gohr    return 0;
6358cb1eb01SAndreas Gohr}
6363df72098SAndreas Gohr
6373df72098SAndreas Gohr/**
63875030359SAndreas Gohr * Send a notify mail on uploads
63975030359SAndreas Gohr *
64075030359SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
64142ea7f44SGerrit Uitslag *
64242ea7f44SGerrit Uitslag * @param string   $id      media id
64342ea7f44SGerrit Uitslag * @param string   $file    path to file
64442ea7f44SGerrit Uitslag * @param string   $mime    mime type
64542ea7f44SGerrit Uitslag * @param bool|int $old_rev revision timestamp or false
64642ea7f44SGerrit Uitslag * @return bool
64775030359SAndreas Gohr */
64868ef8942SKate Arzamastsevafunction media_notify($id,$file,$mime,$old_rev=false){
64975030359SAndreas Gohr    global $conf;
650ebc28e69SAndreas Gohr    if(empty($conf['notify'])) return false; //notify enabled?
65175030359SAndreas Gohr
652b5460ee2SMichael Hamann    $subscription = new Subscription();
6531253a9dcSAndreas Gohr    return $subscription->send_media_diff($conf['notify'], 'uploadmail', $id, $old_rev);
65475030359SAndreas Gohr}
65575030359SAndreas Gohr
65675030359SAndreas Gohr/**
6573df72098SAndreas Gohr * List all files in a given Media namespace
65842ea7f44SGerrit Uitslag *
65921d806cdSGerrit Uitslag * @param string      $ns             namespace
66042ea7f44SGerrit Uitslag * @param null|int    $auth           permission level
66142ea7f44SGerrit Uitslag * @param string      $jump           id
66242ea7f44SGerrit Uitslag * @param bool        $fullscreenview
6638702de7fSGerrit Uitslag * @param bool|string $sort           sorting order, false skips sorting
6643df72098SAndreas Gohr */
665abc306f4SKate Arzamastsevafunction media_filelist($ns,$auth=null,$jump='',$fullscreenview=false,$sort=false){
6663df72098SAndreas Gohr    global $conf;
6673df72098SAndreas Gohr    global $lang;
6683df72098SAndreas Gohr    $ns = cleanID($ns);
6693df72098SAndreas Gohr
6703df72098SAndreas Gohr    // check auth our self if not given (needed for ajax calls)
6713df72098SAndreas Gohr    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
6723df72098SAndreas Gohr
673d9162c6cSKate Arzamastseva    if (!$fullscreenview) echo '<h1 id="media__ns">:'.hsc($ns).'</h1>'.NL;
6743df72098SAndreas Gohr
6753df72098SAndreas Gohr    if($auth < AUTH_READ){
6763df72098SAndreas Gohr        // FIXME: print permission warning here instead?
6773df72098SAndreas Gohr        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
67856fe6664SAndreas Gohr    }else{
67989274c0dSChristopher Smith        if (!$fullscreenview) {
68089274c0dSChristopher Smith            media_uploadform($ns, $auth);
68189274c0dSChristopher Smith            media_searchform($ns);
68289274c0dSChristopher Smith        }
6833df72098SAndreas Gohr
6843df72098SAndreas Gohr        $dir = utf8_encodeFN(str_replace(':','/',$ns));
6853df72098SAndreas Gohr        $data = array();
6861a7f560eSAndreas Gohr        search($data,$conf['mediadir'],'search_media',
687abc306f4SKate Arzamastseva                array('showmsg'=>true,'depth'=>1),$dir,1,$sort);
6883df72098SAndreas Gohr
6893df72098SAndreas Gohr        if(!count($data)){
6903df72098SAndreas Gohr            echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
6915b9353faSKate Arzamastseva        }else {
6925b9353faSKate Arzamastseva            if ($fullscreenview) {
693554a8c9fSAdrian Lang                echo '<ul class="' . _media_get_list_type() . '">';
6945b9353faSKate Arzamastseva            }
6955b9353faSKate Arzamastseva            foreach($data as $item){
6965b9353faSKate Arzamastseva                if (!$fullscreenview) {
6975b9353faSKate Arzamastseva                    media_printfile($item,$auth,$jump);
6985b9353faSKate Arzamastseva                } else {
6995b9353faSKate Arzamastseva                    media_printfile_thumbs($item,$auth,$jump);
7005b9353faSKate Arzamastseva                }
7015b9353faSKate Arzamastseva            }
70294add303SAnika Henke            if ($fullscreenview) echo '</ul>'.NL;
7033df72098SAndreas Gohr        }
70456fe6664SAndreas Gohr    }
705d9162c6cSKate Arzamastseva}
706d9162c6cSKate Arzamastseva
707d9162c6cSKate Arzamastseva/**
708d9162c6cSKate Arzamastseva * Prints tabs for files list actions
709d9162c6cSKate Arzamastseva *
710d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
71195b451bcSAdrian Lang * @author Adrian Lang <mail@adrianlang.de>
71295b451bcSAdrian Lang *
713035e07f1SKate Arzamastseva * @param string $selected_tab - opened tab
714d9162c6cSKate Arzamastseva */
71595b451bcSAdrian Lang
716035e07f1SKate Arzamastsevafunction media_tabs_files($selected_tab = ''){
717d9162c6cSKate Arzamastseva    global $lang;
71895b451bcSAdrian Lang    $tabs = array();
71995b451bcSAdrian Lang    foreach(array('files'  => 'mediaselect',
72095b451bcSAdrian Lang                  'upload' => 'media_uploadtab',
72195b451bcSAdrian Lang                  'search' => 'media_searchtab') as $tab => $caption) {
72295b451bcSAdrian Lang        $tabs[$tab] = array('href'    => media_managerURL(array('tab_files' => $tab), '&'),
72395b451bcSAdrian Lang                            'caption' => $lang[$caption]);
72495b451bcSAdrian Lang    }
725d9162c6cSKate Arzamastseva
72695b451bcSAdrian Lang    html_tabs($tabs, $selected_tab);
727d9162c6cSKate Arzamastseva}
728d9162c6cSKate Arzamastseva
729d9162c6cSKate Arzamastseva/**
730d9162c6cSKate Arzamastseva * Prints tabs for files details actions
731d9162c6cSKate Arzamastseva *
732d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
733ebc28e69SAndreas Gohr * @param string $image filename of the current image
734ebc28e69SAndreas Gohr * @param string $selected_tab opened tab
735d9162c6cSKate Arzamastseva */
736035e07f1SKate Arzamastsevafunction media_tabs_details($image, $selected_tab = ''){
737e5d185e1SKate Arzamastseva    global $lang, $conf;
738d9162c6cSKate Arzamastseva
73995b451bcSAdrian Lang    $tabs = array();
74095b451bcSAdrian Lang    $tabs['view'] = array('href'    => media_managerURL(array('tab_details' => 'view'), '&'),
74195b451bcSAdrian Lang                          'caption' => $lang['media_viewtab']);
742d9162c6cSKate Arzamastseva
743ebc28e69SAndreas Gohr    list(, $mime) = mimetype($image);
74479e79377SAndreas Gohr    if ($mime == 'image/jpeg' && file_exists(mediaFN($image))) {
74595b451bcSAdrian Lang        $tabs['edit'] = array('href'    => media_managerURL(array('tab_details' => 'edit'), '&'),
74695b451bcSAdrian Lang                              'caption' => $lang['media_edittab']);
747dd9ba38eSKate Arzamastseva    }
748e5d185e1SKate Arzamastseva    if ($conf['mediarevisions']) {
74995b451bcSAdrian Lang        $tabs['history'] = array('href'    => media_managerURL(array('tab_details' => 'history'), '&'),
75095b451bcSAdrian Lang                                 'caption' => $lang['media_historytab']);
751e5d185e1SKate Arzamastseva    }
752d9162c6cSKate Arzamastseva
75395b451bcSAdrian Lang    html_tabs($tabs, $selected_tab);
754d9162c6cSKate Arzamastseva}
755d9162c6cSKate Arzamastseva
756d9162c6cSKate Arzamastseva/**
757d9162c6cSKate Arzamastseva * Prints options for the tab that displays a list of all files
758d9162c6cSKate Arzamastseva *
759d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
760d9162c6cSKate Arzamastseva */
76195b451bcSAdrian Langfunction media_tab_files_options(){
7628108113cSTom N Harris    global $lang;
7638108113cSTom N Harris    global $INPUT;
764b7e5821dSAndreas Gohr    global $ID;
765554a8c9fSAdrian Lang    $form = new Doku_Form(array('class' => 'options', 'method' => 'get',
76638b2bf35SAnika Henke                                'action' => wl($ID)));
76738b2bf35SAnika Henke    $media_manager_params = media_managerURL(array(), '', false, true);
76838b2bf35SAnika Henke    foreach($media_manager_params as $pKey => $pVal){
76938b2bf35SAnika Henke        $form->addHidden($pKey, $pVal);
77038b2bf35SAnika Henke    }
77195b451bcSAdrian Lang    $form->addHidden('sectok', null);
7728108113cSTom N Harris    if ($INPUT->has('q')) {
7738108113cSTom N Harris        $form->addHidden('q', $INPUT->str('q'));
774554a8c9fSAdrian Lang    }
77594add303SAnika Henke    $form->addElement('<ul>'.NL);
77695b451bcSAdrian Lang    foreach(array('list' => array('listType', array('thumbs', 'rows')),
777554a8c9fSAdrian Lang                  'sort' => array('sortBy', array('name', 'date')))
77895b451bcSAdrian Lang            as $group => $content) {
779554a8c9fSAdrian Lang        $checked = "_media_get_${group}_type";
780554a8c9fSAdrian Lang        $checked = $checked();
781d9162c6cSKate Arzamastseva
78295b451bcSAdrian Lang        $form->addElement('<li class="' . $content[0] . '">');
78395b451bcSAdrian Lang        foreach($content[1] as $option) {
78495b451bcSAdrian Lang            $attrs = array();
785554a8c9fSAdrian Lang            if ($checked == $option) {
78695b451bcSAdrian Lang                $attrs['checked'] = 'checked';
78795b451bcSAdrian Lang            }
788815f94e6Slisps            $form->addElement(form_makeRadioField($group . '_dwmedia', $option,
78995b451bcSAdrian Lang                                       $lang['media_' . $group . '_' . $option],
79095b451bcSAdrian Lang                                                  $content[0] . '__' . $option,
79195b451bcSAdrian Lang                                                  $option, $attrs));
79295b451bcSAdrian Lang        }
79394add303SAnika Henke        $form->addElement('</li>'.NL);
79495b451bcSAdrian Lang    }
79595b451bcSAdrian Lang    $form->addElement('<li>');
796abc306f4SKate Arzamastseva    $form->addElement(form_makeButton('submit', '', $lang['btn_apply']));
79794add303SAnika Henke    $form->addElement('</li>'.NL);
79894add303SAnika Henke    $form->addElement('</ul>'.NL);
799abc306f4SKate Arzamastseva    $form->printForm();
800d9162c6cSKate Arzamastseva}
801d9162c6cSKate Arzamastseva
802d9162c6cSKate Arzamastseva/**
80387deddfaSKate Arzamastseva * Returns type of sorting for the list of files in media manager
80487deddfaSKate Arzamastseva *
80587deddfaSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
80642ea7f44SGerrit Uitslag *
80787deddfaSKate Arzamastseva * @return string - sort type
80887deddfaSKate Arzamastseva */
80987deddfaSKate Arzamastsevafunction _media_get_sort_type() {
810554a8c9fSAdrian Lang    return _media_get_display_param('sort', array('default' => 'name', 'date'));
81187deddfaSKate Arzamastseva}
812554a8c9fSAdrian Lang
8136ffaeda9SGerrit Uitslag/**
8146ffaeda9SGerrit Uitslag * Returns type of listing for the list of files in media manager
8156ffaeda9SGerrit Uitslag *
8166ffaeda9SGerrit Uitslag * @author Kate Arzamastseva <pshns@ukr.net>
81742ea7f44SGerrit Uitslag *
8186ffaeda9SGerrit Uitslag * @return string - list type
8196ffaeda9SGerrit Uitslag */
820554a8c9fSAdrian Langfunction _media_get_list_type() {
821554a8c9fSAdrian Lang    return _media_get_display_param('list', array('default' => 'thumbs', 'rows'));
82287deddfaSKate Arzamastseva}
823554a8c9fSAdrian Lang
8246ffaeda9SGerrit Uitslag/**
8256ffaeda9SGerrit Uitslag * Get display parameters
8266ffaeda9SGerrit Uitslag *
8276ffaeda9SGerrit Uitslag * @param string $param   name of parameter
8286ffaeda9SGerrit Uitslag * @param array  $values  allowed values, where default value has index key 'default'
8296ffaeda9SGerrit Uitslag * @return string the parameter value
8306ffaeda9SGerrit Uitslag */
831554a8c9fSAdrian Langfunction _media_get_display_param($param, $values) {
8328108113cSTom N Harris    global $INPUT;
8338108113cSTom N Harris    if (in_array($INPUT->str($param), $values)) {
834554a8c9fSAdrian Lang        // FIXME: Set cookie
8358108113cSTom N Harris        return $INPUT->str($param);
836554a8c9fSAdrian Lang    } else {
8373629bc8cSAdrian Lang        $val = get_doku_pref($param, $values['default']);
8383629bc8cSAdrian Lang        if (!in_array($val, $values)) {
8393629bc8cSAdrian Lang            $val = $values['default'];
8403629bc8cSAdrian Lang        }
8413629bc8cSAdrian Lang        return $val;
842554a8c9fSAdrian Lang    }
84387deddfaSKate Arzamastseva}
84487deddfaSKate Arzamastseva
84587deddfaSKate Arzamastseva/**
846d9162c6cSKate Arzamastseva * Prints tab that displays a list of all files
847d9162c6cSKate Arzamastseva *
848d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
84942ea7f44SGerrit Uitslag *
85042ea7f44SGerrit Uitslag * @param string    $ns
85142ea7f44SGerrit Uitslag * @param null|int  $auth permission level
85242ea7f44SGerrit Uitslag * @param string    $jump item id
853d9162c6cSKate Arzamastseva */
854d9162c6cSKate Arzamastsevafunction media_tab_files($ns,$auth=null,$jump='') {
855d9162c6cSKate Arzamastseva    global $lang;
856d9162c6cSKate Arzamastseva    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
857d9162c6cSKate Arzamastseva
858d9162c6cSKate Arzamastseva    if($auth < AUTH_READ){
85988a71175SKate Arzamastseva        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
860d9162c6cSKate Arzamastseva    }else{
86195b451bcSAdrian Lang        media_filelist($ns,$auth,$jump,true,_media_get_sort_type());
862d9162c6cSKate Arzamastseva    }
863d9162c6cSKate Arzamastseva}
864d9162c6cSKate Arzamastseva
865d9162c6cSKate Arzamastseva/**
866d9162c6cSKate Arzamastseva * Prints tab that displays uploading form
867d9162c6cSKate Arzamastseva *
868d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
86942ea7f44SGerrit Uitslag *
87042ea7f44SGerrit Uitslag * @param string   $ns
87142ea7f44SGerrit Uitslag * @param null|int $auth permission level
87242ea7f44SGerrit Uitslag * @param string   $jump item id
873d9162c6cSKate Arzamastseva */
874d9162c6cSKate Arzamastsevafunction media_tab_upload($ns,$auth=null,$jump='') {
875d9162c6cSKate Arzamastseva    global $lang;
876d9162c6cSKate Arzamastseva    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
877d9162c6cSKate Arzamastseva
87894add303SAnika Henke    echo '<div class="upload">'.NL;
87995b451bcSAdrian Lang    if ($auth >= AUTH_UPLOAD) {
88095b451bcSAdrian Lang        echo '<p>' . $lang['mediaupload'] . '</p>';
88195b451bcSAdrian Lang    }
882d9162c6cSKate Arzamastseva    media_uploadform($ns, $auth, true);
88394add303SAnika Henke    echo '</div>'.NL;
884d9162c6cSKate Arzamastseva}
885d9162c6cSKate Arzamastseva
886d9162c6cSKate Arzamastseva/**
887d9162c6cSKate Arzamastseva * Prints tab that displays search form
888d9162c6cSKate Arzamastseva *
889d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
89042ea7f44SGerrit Uitslag *
89142ea7f44SGerrit Uitslag * @param string $ns
89242ea7f44SGerrit Uitslag * @param null|int $auth permission level
893d9162c6cSKate Arzamastseva */
894d9162c6cSKate Arzamastsevafunction media_tab_search($ns,$auth=null) {
8958108113cSTom N Harris    global $INPUT;
896d9162c6cSKate Arzamastseva
8978108113cSTom N Harris    $do = $INPUT->str('mediado');
8988108113cSTom N Harris    $query = $INPUT->str('q');
89994add303SAnika Henke    echo '<div class="search">'.NL;
900d9162c6cSKate Arzamastseva
901d9162c6cSKate Arzamastseva    media_searchform($ns, $query, true);
9022dba8df4SAdrian Lang    if ($do == 'searchlist' || $query) {
90395b451bcSAdrian Lang        media_searchlist($query,$ns,$auth,true,_media_get_sort_type());
90495b451bcSAdrian Lang    }
90594add303SAnika Henke    echo '</div>'.NL;
906d9162c6cSKate Arzamastseva}
907d9162c6cSKate Arzamastseva
908d9162c6cSKate Arzamastseva/**
909d9162c6cSKate Arzamastseva * Prints tab that displays mediafile details
910d9162c6cSKate Arzamastseva *
911d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
912e0c26282SGerrit Uitslag *
913e0c26282SGerrit Uitslag * @param string     $image media id
914e0c26282SGerrit Uitslag * @param string     $ns
915e0c26282SGerrit Uitslag * @param null|int   $auth  permission level
91642ea7f44SGerrit Uitslag * @param string|int $rev   revision timestamp or empty string
917d9162c6cSKate Arzamastseva */
918e0c26282SGerrit Uitslagfunction media_tab_view($image, $ns, $auth=null, $rev='') {
919ebc28e69SAndreas Gohr    global $lang;
920d9162c6cSKate Arzamastseva    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
921d9162c6cSKate Arzamastseva
922e136d6ccSKate Arzamastseva    if ($image && $auth >= AUTH_READ) {
923dd9ba38eSKate Arzamastseva        $meta = new JpegMeta(mediaFN($image, $rev));
924dd9ba38eSKate Arzamastseva        media_preview($image, $auth, $rev, $meta);
925e136d6ccSKate Arzamastseva        media_preview_buttons($image, $auth, $rev);
926dd9ba38eSKate Arzamastseva        media_details($image, $auth, $rev, $meta);
927e136d6ccSKate Arzamastseva
928e136d6ccSKate Arzamastseva    } else {
92994add303SAnika Henke        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
930e136d6ccSKate Arzamastseva    }
931d9162c6cSKate Arzamastseva}
932d9162c6cSKate Arzamastseva
933d9162c6cSKate Arzamastseva/**
934d9162c6cSKate Arzamastseva * Prints tab that displays form for editing mediafile metadata
935d9162c6cSKate Arzamastseva *
936d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
937e0c26282SGerrit Uitslag *
938e0c26282SGerrit Uitslag * @param string     $image media id
939e0c26282SGerrit Uitslag * @param string     $ns
940e0c26282SGerrit Uitslag * @param null|int   $auth permission level
941d9162c6cSKate Arzamastseva */
942d9162c6cSKate Arzamastsevafunction media_tab_edit($image, $ns, $auth=null) {
943d9162c6cSKate Arzamastseva    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
944d9162c6cSKate Arzamastseva
9451eeeced2SKate Arzamastseva    if ($image) {
946ebc28e69SAndreas Gohr        list(, $mime) = mimetype($image);
94730fd72fbSKate Arzamastseva        if ($mime == 'image/jpeg') media_metaform($image,$auth);
9481eeeced2SKate Arzamastseva    }
949d9162c6cSKate Arzamastseva}
950d9162c6cSKate Arzamastseva
951d9162c6cSKate Arzamastseva/**
952d9162c6cSKate Arzamastseva * Prints tab that displays mediafile revisions
953d9162c6cSKate Arzamastseva *
954d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
955e0c26282SGerrit Uitslag *
956e0c26282SGerrit Uitslag * @param string     $image media id
957e0c26282SGerrit Uitslag * @param string     $ns
958e0c26282SGerrit Uitslag * @param null|int   $auth permission level
959d9162c6cSKate Arzamastseva */
960d9162c6cSKate Arzamastsevafunction media_tab_history($image, $ns, $auth=null) {
961d9162c6cSKate Arzamastseva    global $lang;
9628108113cSTom N Harris    global $INPUT;
9638108113cSTom N Harris
964d9162c6cSKate Arzamastseva    if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
9658108113cSTom N Harris    $do = $INPUT->str('mediado');
966d9162c6cSKate Arzamastseva
9672e55802cSKate Arzamastseva    if ($auth >= AUTH_READ && $image) {
9682e55802cSKate Arzamastseva        if ($do == 'diff'){
9692e55802cSKate Arzamastseva            media_diff($image, $ns, $auth);
9702e55802cSKate Arzamastseva        } else {
9718108113cSTom N Harris            $first = $INPUT->int('first');
9728e69fd30SKate Arzamastseva            html_revisions($first, $image);
9732e55802cSKate Arzamastseva        }
97488a71175SKate Arzamastseva    } else {
97588a71175SKate Arzamastseva        echo '<div class="nothing">'.$lang['media_perm_read'].'</div>'.NL;
9762e55802cSKate Arzamastseva    }
9773df72098SAndreas Gohr}
9783df72098SAndreas Gohr
9793df72098SAndreas Gohr/**
9801eeeced2SKate Arzamastseva * Prints mediafile details
9811eeeced2SKate Arzamastseva *
9826ffaeda9SGerrit Uitslag * @param string         $image media id
983e0c26282SGerrit Uitslag * @param int            $auth permission level
98459bc3b48SGerrit Uitslag * @param int|string     $rev revision timestamp or empty string
9856ffaeda9SGerrit Uitslag * @param JpegMeta|bool  $meta
98642ea7f44SGerrit Uitslag *
9871eeeced2SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
9881eeeced2SKate Arzamastseva */
98959bc3b48SGerrit Uitslagfunction media_preview($image, $auth, $rev='', $meta=false) {
990e136d6ccSKate Arzamastseva
991e136d6ccSKate Arzamastseva    $size = media_image_preview_size($image, $rev, $meta);
992e136d6ccSKate Arzamastseva
993e136d6ccSKate Arzamastseva    if ($size) {
99459f3611bSAnika Henke        global $lang;
99594add303SAnika Henke        echo '<div class="image">';
99694add303SAnika Henke
9975b9353faSKate Arzamastseva        $more = array();
998e136d6ccSKate Arzamastseva        if ($rev) {
9995b9353faSKate Arzamastseva            $more['rev'] = $rev;
1000e136d6ccSKate Arzamastseva        } else {
1001e136d6ccSKate Arzamastseva            $t = @filemtime(mediaFN($image));
10025b9353faSKate Arzamastseva            $more['t'] = $t;
100388a71175SKate Arzamastseva        }
100423786fd7SKate Arzamastseva
10055b9353faSKate Arzamastseva        $more['w'] = $size[0];
10065b9353faSKate Arzamastseva        $more['h'] = $size[1];
1007e136d6ccSKate Arzamastseva        $src = ml($image, $more);
100859f3611bSAnika Henke
100959f3611bSAnika Henke        echo '<a href="'.$src.'" target="_blank" title="'.$lang['mediaview'].'">';
101095b451bcSAdrian Lang        echo '<img src="'.$src.'" alt="" style="max-width: '.$size[0].'px;" />';
101159f3611bSAnika Henke        echo '</a>';
1012e136d6ccSKate Arzamastseva
101394add303SAnika Henke        echo '</div>'.NL;
101494add303SAnika Henke    }
1015e136d6ccSKate Arzamastseva}
1016e136d6ccSKate Arzamastseva
1017e136d6ccSKate Arzamastseva/**
1018e136d6ccSKate Arzamastseva * Prints mediafile action buttons
1019e136d6ccSKate Arzamastseva *
1020e136d6ccSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1021e0c26282SGerrit Uitslag *
1022e0c26282SGerrit Uitslag * @param string     $image media id
1023e0c26282SGerrit Uitslag * @param int        $auth  permission level
1024e0c26282SGerrit Uitslag * @param string|int $rev   revision timestamp, or empty string
1025e136d6ccSKate Arzamastseva */
1026e0c26282SGerrit Uitslagfunction media_preview_buttons($image, $auth, $rev='') {
1027e5d185e1SKate Arzamastseva    global $lang, $conf;
1028e136d6ccSKate Arzamastseva
102994add303SAnika Henke    echo '<ul class="actions">'.NL;
10301eeeced2SKate Arzamastseva
103179e79377SAndreas Gohr    if($auth >= AUTH_DELETE && !$rev && file_exists(mediaFN($image))){
1032e136d6ccSKate Arzamastseva
1033e136d6ccSKate Arzamastseva        // delete button
10347d7ab775SKate Arzamastseva        $form = new Doku_Form(array('id' => 'mediamanager__btn_delete',
10356183fb05SKate Arzamastseva            'action'=>media_managerURL(array('delete' => $image), '&')));
103670c3cc9aSKate Arzamastseva        $form->addElement(form_makeButton('submit','',$lang['btn_delete']));
103795b451bcSAdrian Lang        echo '<li>';
103870c3cc9aSKate Arzamastseva        $form->printForm();
103994add303SAnika Henke        echo '</li>'.NL;
1040e5d185e1SKate Arzamastseva    }
1041e5d185e1SKate Arzamastseva
1042e5d185e1SKate Arzamastseva    $auth_ow = (($conf['mediarevisions']) ? AUTH_UPLOAD : AUTH_DELETE);
1043e5d185e1SKate Arzamastseva    if($auth >= $auth_ow && !$rev){
1044e5d185e1SKate Arzamastseva
1045e136d6ccSKate Arzamastseva        // upload new version button
1046ed69a2aeSKate Arzamastseva        $form = new Doku_Form(array('id' => 'mediamanager__btn_update',
10476183fb05SKate Arzamastseva            'action'=>media_managerURL(array('image' => $image, 'mediado' => 'update'), '&')));
104870c3cc9aSKate Arzamastseva        $form->addElement(form_makeButton('submit','',$lang['media_update']));
104995b451bcSAdrian Lang        echo '<li>';
105070c3cc9aSKate Arzamastseva        $form->printForm();
105194add303SAnika Henke        echo '</li>'.NL;
105270c3cc9aSKate Arzamastseva    }
1053e136d6ccSKate Arzamastseva
105479e79377SAndreas Gohr    if($auth >= AUTH_UPLOAD && $rev && $conf['mediarevisions'] && file_exists(mediaFN($image, $rev))){
1055e136d6ccSKate Arzamastseva
1056e136d6ccSKate Arzamastseva        // restore button
10577d7ab775SKate Arzamastseva        $form = new Doku_Form(array('id' => 'mediamanager__btn_restore',
10586183fb05SKate Arzamastseva            'action'=>media_managerURL(array('image' => $image), '&')));
10599c1bd4bcSKate Arzamastseva        $form->addHidden('mediado','restore');
10609c1bd4bcSKate Arzamastseva        $form->addHidden('rev',$rev);
10619c1bd4bcSKate Arzamastseva        $form->addElement(form_makeButton('submit','',$lang['media_restore']));
106295b451bcSAdrian Lang        echo '<li>';
10639c1bd4bcSKate Arzamastseva        $form->printForm();
106494add303SAnika Henke        echo '</li>'.NL;
10659c1bd4bcSKate Arzamastseva    }
1066e136d6ccSKate Arzamastseva
106794add303SAnika Henke    echo '</ul>'.NL;
10682e55802cSKate Arzamastseva}
10692e55802cSKate Arzamastseva
10702e55802cSKate Arzamastseva/**
1071fa8e5c77SKate Arzamastseva * Returns image width and height for mediamanager preview panel
1072fa8e5c77SKate Arzamastseva *
1073fa8e5c77SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1074fa8e5c77SKate Arzamastseva * @param string         $image
1075e0c26282SGerrit Uitslag * @param int|string     $rev
107659bc3b48SGerrit Uitslag * @param JpegMeta|bool  $meta
1077ebc28e69SAndreas Gohr * @param int            $size
107842ea7f44SGerrit Uitslag * @return array|false
1079fa8e5c77SKate Arzamastseva */
10806dd095f5SKate Arzamastsevafunction media_image_preview_size($image, $rev, $meta, $size = 500) {
108192cac9a9SKate Arzamastseva    if (!preg_match("/\.(jpe?g|gif|png)$/", $image) || !file_exists(mediaFN($image, $rev))) return false;
1082fa8e5c77SKate Arzamastseva
1083fa8e5c77SKate Arzamastseva    $info = getimagesize(mediaFN($image, $rev));
1084fa8e5c77SKate Arzamastseva    $w = (int) $info[0];
1085fa8e5c77SKate Arzamastseva    $h = (int) $info[1];
1086fa8e5c77SKate Arzamastseva
1087fa8e5c77SKate Arzamastseva    if($meta && ($w > $size || $h > $size)){
1088fa8e5c77SKate Arzamastseva        $ratio = $meta->getResizeRatio($size, $size);
1089fa8e5c77SKate Arzamastseva        $w = floor($w * $ratio);
1090fa8e5c77SKate Arzamastseva        $h = floor($h * $ratio);
1091fa8e5c77SKate Arzamastseva    }
1092fa8e5c77SKate Arzamastseva    return array($w, $h);
1093fa8e5c77SKate Arzamastseva}
1094fa8e5c77SKate Arzamastseva
1095fa8e5c77SKate Arzamastseva/**
1096fa8e5c77SKate Arzamastseva * Returns the requested EXIF/IPTC tag from the image meta
1097fa8e5c77SKate Arzamastseva *
1098fa8e5c77SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1099e0c26282SGerrit Uitslag *
110042ea7f44SGerrit Uitslag * @param array    $tags array with tags, first existing is returned
1101fa8e5c77SKate Arzamastseva * @param JpegMeta $meta
110242ea7f44SGerrit Uitslag * @param string   $alt  alternative value
1103fa8e5c77SKate Arzamastseva * @return string
1104fa8e5c77SKate Arzamastseva */
1105fa8e5c77SKate Arzamastsevafunction media_getTag($tags,$meta,$alt=''){
1106fa8e5c77SKate Arzamastseva    if($meta === false) return $alt;
1107fa8e5c77SKate Arzamastseva    $info = $meta->getField($tags);
1108fa8e5c77SKate Arzamastseva    if($info == false) return $alt;
1109fa8e5c77SKate Arzamastseva    return $info;
1110fa8e5c77SKate Arzamastseva}
1111fa8e5c77SKate Arzamastseva
1112fa8e5c77SKate Arzamastseva/**
1113e136d6ccSKate Arzamastseva * Returns mediafile tags
11142e55802cSKate Arzamastseva *
11152e55802cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1116e0c26282SGerrit Uitslag *
1117e136d6ccSKate Arzamastseva * @param JpegMeta $meta
111842ea7f44SGerrit Uitslag * @return array list of tags of the mediafile
11192e55802cSKate Arzamastseva */
1120e136d6ccSKate Arzamastsevafunction media_file_tags($meta) {
1121532850edSKate Arzamastseva    // load the field descriptions
11223e98e685SKate Arzamastseva    static $fields = null;
11233e98e685SKate Arzamastseva    if(is_null($fields)){
11243e98e685SKate Arzamastseva        $config_files = getConfigFiles('mediameta');
11253e98e685SKate Arzamastseva        foreach ($config_files as $config_file) {
112679e79377SAndreas Gohr            if(file_exists($config_file)) include($config_file);
1127532850edSKate Arzamastseva        }
1128532850edSKate Arzamastseva    }
11291eeeced2SKate Arzamastseva
1130e136d6ccSKate Arzamastseva    $tags = array();
1131dd9ba38eSKate Arzamastseva
11323e98e685SKate Arzamastseva    foreach($fields as $key => $tag){
11333e98e685SKate Arzamastseva        $t = array();
11343e98e685SKate Arzamastseva        if (!empty($tag[0])) $t = array($tag[0]);
11350e80bb5eSChristopher Smith        if(isset($tag[3]) && is_array($tag[3])) $t = array_merge($t,$tag[3]);
1136e136d6ccSKate Arzamastseva        $value = media_getTag($t, $meta);
1137e136d6ccSKate Arzamastseva        $tags[] = array('tag' => $tag, 'value' => $value);
1138e136d6ccSKate Arzamastseva    }
1139e136d6ccSKate Arzamastseva
1140e136d6ccSKate Arzamastseva    return $tags;
1141e136d6ccSKate Arzamastseva}
1142e136d6ccSKate Arzamastseva
1143e136d6ccSKate Arzamastseva/**
1144e136d6ccSKate Arzamastseva * Prints mediafile tags
1145e136d6ccSKate Arzamastseva *
1146e136d6ccSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
114742ea7f44SGerrit Uitslag *
1148e0c26282SGerrit Uitslag * @param string        $image image id
1149e0c26282SGerrit Uitslag * @param int           $auth  permission level
1150e0c26282SGerrit Uitslag * @param string|int    $rev   revision timestamp, or empty string
1151e0c26282SGerrit Uitslag * @param bool|JpegMeta $meta  image object, or create one if false
1152e0c26282SGerrit Uitslag */
1153e0c26282SGerrit Uitslagfunction media_details($image, $auth, $rev='', $meta=false) {
1154e136d6ccSKate Arzamastseva    global $lang;
1155e136d6ccSKate Arzamastseva
1156e136d6ccSKate Arzamastseva    if (!$meta) $meta = new JpegMeta(mediaFN($image, $rev));
1157e136d6ccSKate Arzamastseva    $tags = media_file_tags($meta);
1158e136d6ccSKate Arzamastseva
115994add303SAnika Henke    echo '<dl>'.NL;
1160e136d6ccSKate Arzamastseva    foreach($tags as $tag){
1161e136d6ccSKate Arzamastseva        if ($tag['value']) {
1162e136d6ccSKate Arzamastseva            $value = cleanText($tag['value']);
1163fde860beSGerrit Uitslag            echo '<dt>'.$lang[$tag['tag'][1]].'</dt><dd>';
1164e136d6ccSKate Arzamastseva            if ($tag['tag'][2] == 'date') echo dformat($value);
11653e98e685SKate Arzamastseva            else echo hsc($value);
116694add303SAnika Henke            echo '</dd>'.NL;
11671eeeced2SKate Arzamastseva        }
1168e136d6ccSKate Arzamastseva    }
116994add303SAnika Henke    echo '</dl>'.NL;
117022e68399Sflammy    echo '<dl>'.NL;
117122e68399Sflammy    echo '<dt>'.$lang['reference'].':</dt>';
117222e68399Sflammy    $media_usage = ft_mediause($image,true);
117322e68399Sflammy    if(count($media_usage) > 0){
117422e68399Sflammy        foreach($media_usage as $path){
117522e68399Sflammy            echo '<dd>'.html_wikilink($path).'</dd>';
117622e68399Sflammy        }
117722e68399Sflammy    }else{
117822e68399Sflammy        echo '<dd>'.$lang['nothingfound'].'</dd>';
117922e68399Sflammy    }
118022e68399Sflammy    echo '</dl>'.NL;
118122e68399Sflammy
11821eeeced2SKate Arzamastseva}
11832e55802cSKate Arzamastseva
11842e55802cSKate Arzamastseva/**
11852e55802cSKate Arzamastseva * Shows difference between two revisions of file
11862e55802cSKate Arzamastseva *
11872e55802cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
118842ea7f44SGerrit Uitslag *
1189e0c26282SGerrit Uitslag * @param string $image  image id
1190e0c26282SGerrit Uitslag * @param string $ns
1191e0c26282SGerrit Uitslag * @param int $auth permission level
1192e0c26282SGerrit Uitslag * @param bool $fromajax
119342ea7f44SGerrit Uitslag * @return false|null|string
1194e0c26282SGerrit Uitslag */
1195b4b31bacSKate Arzamastsevafunction media_diff($image, $ns, $auth, $fromajax = false) {
11962e55802cSKate Arzamastseva    global $conf;
11978108113cSTom N Harris    global $INPUT;
11982e55802cSKate Arzamastseva
1199e5d185e1SKate Arzamastseva    if ($auth < AUTH_READ || !$image || !$conf['mediarevisions']) return '';
12004ee15585SKate Arzamastseva
12018108113cSTom N Harris    $rev1 = $INPUT->int('rev');
12022e55802cSKate Arzamastseva
12034ba05e11SAndreas Gohr    $rev2 = $INPUT->ref('rev2');
12044ba05e11SAndreas Gohr    if(is_array($rev2)){
12054ba05e11SAndreas Gohr        $rev1 = (int) $rev2[0];
12064ba05e11SAndreas Gohr        $rev2 = (int) $rev2[1];
12072e55802cSKate Arzamastseva
12082e55802cSKate Arzamastseva        if(!$rev1){
12092e55802cSKate Arzamastseva            $rev1 = $rev2;
12102e55802cSKate Arzamastseva            unset($rev2);
12112e55802cSKate Arzamastseva        }
12122e55802cSKate Arzamastseva    }else{
12138108113cSTom N Harris        $rev2 = $INPUT->int('rev2');
12142e55802cSKate Arzamastseva    }
12156dd095f5SKate Arzamastseva
12166dd095f5SKate Arzamastseva    if ($rev1 && !file_exists(mediaFN($image, $rev1))) $rev1 = false;
12176dd095f5SKate Arzamastseva    if ($rev2 && !file_exists(mediaFN($image, $rev2))) $rev2 = false;
12186dd095f5SKate Arzamastseva
12192e55802cSKate Arzamastseva    if($rev1 && $rev2){            // two specific revisions wanted
12202e55802cSKate Arzamastseva        // make sure order is correct (older on the left)
12212e55802cSKate Arzamastseva        if($rev1 < $rev2){
12222e55802cSKate Arzamastseva            $l_rev = $rev1;
12232e55802cSKate Arzamastseva            $r_rev = $rev2;
12242e55802cSKate Arzamastseva        }else{
12252e55802cSKate Arzamastseva            $l_rev = $rev2;
12262e55802cSKate Arzamastseva            $r_rev = $rev1;
12272e55802cSKate Arzamastseva        }
12282e55802cSKate Arzamastseva    }elseif($rev1){                // single revision given, compare to current
12292e55802cSKate Arzamastseva        $r_rev = '';
12302e55802cSKate Arzamastseva        $l_rev = $rev1;
12312e55802cSKate Arzamastseva    }else{                        // no revision was given, compare previous to current
12322e55802cSKate Arzamastseva        $r_rev = '';
1233047bad06SGerrit Uitslag        $medialog = new MediaChangeLog($image);
1234047bad06SGerrit Uitslag        $revs = $medialog->getRevisions(0, 1);
1235e5d185e1SKate Arzamastseva        if (file_exists(mediaFN($image, $revs[0]))) {
12362e55802cSKate Arzamastseva            $l_rev = $revs[0];
1237e5d185e1SKate Arzamastseva        } else {
1238e5d185e1SKate Arzamastseva            $l_rev = '';
1239e5d185e1SKate Arzamastseva        }
12402e55802cSKate Arzamastseva    }
1241dd9ba38eSKate Arzamastseva
124259e81a43SKate Arzamastseva    // prepare event data
124359bc3b48SGerrit Uitslag    $data = array();
124459e81a43SKate Arzamastseva    $data[0] = $image;
124559e81a43SKate Arzamastseva    $data[1] = $l_rev;
124659e81a43SKate Arzamastseva    $data[2] = $r_rev;
124759e81a43SKate Arzamastseva    $data[3] = $ns;
124859e81a43SKate Arzamastseva    $data[4] = $auth;
1249b4b31bacSKate Arzamastseva    $data[5] = $fromajax;
125059e81a43SKate Arzamastseva
125159e81a43SKate Arzamastseva    // trigger event
1252fa8e5c77SKate Arzamastseva    return trigger_event('MEDIA_DIFF', $data, '_media_file_diff', true);
125359e81a43SKate Arzamastseva}
125459e81a43SKate Arzamastseva
12556ffaeda9SGerrit Uitslag/**
12566ffaeda9SGerrit Uitslag * Callback for media file diff
12576ffaeda9SGerrit Uitslag *
125842ea7f44SGerrit Uitslag * @param array $data event data
125942ea7f44SGerrit Uitslag * @return false|null
12606ffaeda9SGerrit Uitslag */
1261fa8e5c77SKate Arzamastsevafunction _media_file_diff($data) {
1262b4b31bacSKate Arzamastseva    if(is_array($data) && count($data)===6) {
12636ffaeda9SGerrit Uitslag        media_file_diff($data[0], $data[1], $data[2], $data[3], $data[4], $data[5]);
126459e81a43SKate Arzamastseva    } else {
126559e81a43SKate Arzamastseva        return false;
126659e81a43SKate Arzamastseva    }
126759e81a43SKate Arzamastseva}
126859e81a43SKate Arzamastseva
126959e81a43SKate Arzamastseva/**
127059e81a43SKate Arzamastseva * Shows difference between two revisions of image
127159e81a43SKate Arzamastseva *
127259e81a43SKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1273e0c26282SGerrit Uitslag *
1274e0c26282SGerrit Uitslag * @param string $image
1275e0c26282SGerrit Uitslag * @param string|int $l_rev revision timestamp, or empty string
1276e0c26282SGerrit Uitslag * @param string|int $r_rev revision timestamp, or empty string
1277e0c26282SGerrit Uitslag * @param string $ns
1278e0c26282SGerrit Uitslag * @param int $auth permission level
1279e0c26282SGerrit Uitslag * @param bool $fromajax
128059e81a43SKate Arzamastseva */
1281b4b31bacSKate Arzamastsevafunction media_file_diff($image, $l_rev, $r_rev, $ns, $auth, $fromajax){
12828108113cSTom N Harris    global $lang;
12838108113cSTom N Harris    global $INPUT;
12844ee15585SKate Arzamastseva
128550fc55feSKate Arzamastseva    $l_meta = new JpegMeta(mediaFN($image, $l_rev));
128650fc55feSKate Arzamastseva    $r_meta = new JpegMeta(mediaFN($image, $r_rev));
128750fc55feSKate Arzamastseva
1288ebc28e69SAndreas Gohr    $is_img = preg_match('/\.(jpe?g|gif|png)$/', $image);
12894ee15585SKate Arzamastseva    if ($is_img) {
129050fc55feSKate Arzamastseva        $l_size = media_image_preview_size($image, $l_rev, $l_meta);
129150fc55feSKate Arzamastseva        $r_size = media_image_preview_size($image, $r_rev, $r_meta);
129250fc55feSKate Arzamastseva        $is_img = ($l_size && $r_size && ($l_size[0] >= 30 || $r_size[0] >= 30));
129350fc55feSKate Arzamastseva
12948108113cSTom N Harris        $difftype = $INPUT->str('difftype');
12954ee15585SKate Arzamastseva
1296b4b31bacSKate Arzamastseva        if (!$fromajax) {
12979a71fb5cSAnika Henke            $form = new Doku_Form(array(
12989a71fb5cSAnika Henke                'action' => media_managerURL(array(), '&'),
1299eaac63bbSAdrian Lang                'method' => 'get',
13009a71fb5cSAnika Henke                'id' => 'mediamanager__form_diffview',
13019a71fb5cSAnika Henke                'class' => 'diffView'
13029a71fb5cSAnika Henke            ));
130395b451bcSAdrian Lang            $form->addHidden('sectok', null);
13045b9353faSKate Arzamastseva            $form->addElement('<input type="hidden" name="rev2[]" value="'.$l_rev.'" ></input>');
13055b9353faSKate Arzamastseva            $form->addElement('<input type="hidden" name="rev2[]" value="'.$r_rev.'" ></input>');
13064ee15585SKate Arzamastseva            $form->addHidden('mediado', 'diff');
13074ee15585SKate Arzamastseva            $form->printForm();
13084ee15585SKate Arzamastseva
130994add303SAnika Henke            echo NL.'<div id="mediamanager__diff" >'.NL;
1310b4b31bacSKate Arzamastseva        }
13114ee15585SKate Arzamastseva
1312b4b31bacSKate Arzamastseva        if ($difftype == 'opacity' || $difftype == 'portions') {
131350fc55feSKate Arzamastseva            media_image_diff($image, $l_rev, $r_rev, $l_size, $r_size, $difftype);
1314b4b31bacSKate Arzamastseva            if (!$fromajax) echo '</div>';
1315ebc28e69SAndreas Gohr            return;
1316b4b31bacSKate Arzamastseva        }
13174ee15585SKate Arzamastseva    }
1318e136d6ccSKate Arzamastseva
131995b451bcSAdrian Lang    list($l_head, $r_head) = html_diff_head($l_rev, $r_rev, $image, true);
1320e136d6ccSKate Arzamastseva
132195b451bcSAdrian Lang    ?>
1322c7b28ffdSAnika Henke    <div class="table">
132395b451bcSAdrian Lang    <table>
132495b451bcSAdrian Lang      <tr>
132595b451bcSAdrian Lang        <th><?php echo $l_head; ?></th>
132695b451bcSAdrian Lang        <th><?php echo $r_head; ?></th>
132795b451bcSAdrian Lang      </tr>
132895b451bcSAdrian Lang    <?php
132995b451bcSAdrian Lang
133095b451bcSAdrian Lang    echo '<tr class="image">';
133195b451bcSAdrian Lang    echo '<td>';
1332e136d6ccSKate Arzamastseva    media_preview($image, $auth, $l_rev, $l_meta);
133395b451bcSAdrian Lang    echo '</td>';
1334e136d6ccSKate Arzamastseva
133595b451bcSAdrian Lang    echo '<td>';
1336e136d6ccSKate Arzamastseva    media_preview($image, $auth, $r_rev, $r_meta);
133795b451bcSAdrian Lang    echo '</td>';
133894add303SAnika Henke    echo '</tr>'.NL;
1339e136d6ccSKate Arzamastseva
134095b451bcSAdrian Lang    echo '<tr class="actions">';
134195b451bcSAdrian Lang    echo '<td>';
1342e136d6ccSKate Arzamastseva    media_preview_buttons($image, $auth, $l_rev);
134395b451bcSAdrian Lang    echo '</td>';
1344e136d6ccSKate Arzamastseva
134595b451bcSAdrian Lang    echo '<td>';
1346e136d6ccSKate Arzamastseva    media_preview_buttons($image, $auth, $r_rev);
134795b451bcSAdrian Lang    echo '</td>';
134894add303SAnika Henke    echo '</tr>'.NL;
1349e136d6ccSKate Arzamastseva
1350e136d6ccSKate Arzamastseva    $l_tags = media_file_tags($l_meta);
1351e136d6ccSKate Arzamastseva    $r_tags = media_file_tags($r_meta);
135295b451bcSAdrian Lang    // FIXME r_tags-only stuff
1353e136d6ccSKate Arzamastseva    foreach ($l_tags as $key => $l_tag) {
1354e136d6ccSKate Arzamastseva        if ($l_tag['value'] != $r_tags[$key]['value']) {
135595b451bcSAdrian Lang            $r_tags[$key]['highlighted'] = true;
135695b451bcSAdrian Lang            $l_tags[$key]['highlighted'] = true;
1357e136d6ccSKate Arzamastseva        } else if (!$l_tag['value'] || !$r_tags[$key]['value']) {
1358e136d6ccSKate Arzamastseva            unset($r_tags[$key]);
1359e136d6ccSKate Arzamastseva            unset($l_tags[$key]);
1360e136d6ccSKate Arzamastseva        }
1361e136d6ccSKate Arzamastseva    }
1362e136d6ccSKate Arzamastseva
136395b451bcSAdrian Lang    echo '<tr>';
1364e136d6ccSKate Arzamastseva    foreach(array($l_tags,$r_tags) as $tags){
136594add303SAnika Henke        echo '<td>'.NL;
1366e136d6ccSKate Arzamastseva
1367e136d6ccSKate Arzamastseva        echo '<dl class="img_tags">';
1368e136d6ccSKate Arzamastseva        foreach($tags as $tag){
1369e136d6ccSKate Arzamastseva            $value = cleanText($tag['value']);
1370e136d6ccSKate Arzamastseva            if (!$value) $value = '-';
1371fde860beSGerrit Uitslag            echo '<dt>'.$lang[$tag['tag'][1]].'</dt>';
137295b451bcSAdrian Lang            echo '<dd>';
137395b451bcSAdrian Lang            if ($tag['highlighted']) {
137495b451bcSAdrian Lang                echo '<strong>';
137595b451bcSAdrian Lang            }
1376e136d6ccSKate Arzamastseva            if ($tag['tag'][2] == 'date') echo dformat($value);
1377e136d6ccSKate Arzamastseva            else echo hsc($value);
137895b451bcSAdrian Lang            if ($tag['highlighted']) {
137995b451bcSAdrian Lang                echo '</strong>';
138095b451bcSAdrian Lang            }
1381e136d6ccSKate Arzamastseva            echo '</dd>';
1382e136d6ccSKate Arzamastseva        }
138394add303SAnika Henke        echo '</dl>'.NL;
1384e136d6ccSKate Arzamastseva
138595b451bcSAdrian Lang        echo '</td>';
1386e136d6ccSKate Arzamastseva    }
138794add303SAnika Henke    echo '</tr>'.NL;
1388e136d6ccSKate Arzamastseva
138994add303SAnika Henke    echo '</table>'.NL;
1390c7b28ffdSAnika Henke    echo '</div>'.NL;
1391e136d6ccSKate Arzamastseva
1392b4b31bacSKate Arzamastseva    if ($is_img && !$fromajax) echo '</div>';
1393e136d6ccSKate Arzamastseva}
1394e136d6ccSKate Arzamastseva
1395e136d6ccSKate Arzamastseva/**
1396e136d6ccSKate Arzamastseva * Prints two images side by side
1397fa8e5c77SKate Arzamastseva * and slider
1398e136d6ccSKate Arzamastseva *
1399e136d6ccSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
140042ea7f44SGerrit Uitslag *
140142ea7f44SGerrit Uitslag * @param string $image   image id
1402e0c26282SGerrit Uitslag * @param int    $l_rev   revision timestamp, or empty string
1403e0c26282SGerrit Uitslag * @param int    $r_rev   revision timestamp, or empty string
140442ea7f44SGerrit Uitslag * @param array  $l_size  array with width and height
140542ea7f44SGerrit Uitslag * @param array  $r_size  array with width and height
140650fc55feSKate Arzamastseva * @param string $type
1407e136d6ccSKate Arzamastseva */
140850fc55feSKate Arzamastsevafunction media_image_diff($image, $l_rev, $r_rev, $l_size, $r_size, $type) {
140950fc55feSKate Arzamastseva    if ($l_size != $r_size) {
141050fc55feSKate Arzamastseva        if ($r_size[0] > $l_size[0]) {
141150fc55feSKate Arzamastseva            $l_size = $r_size;
141250fc55feSKate Arzamastseva        }
141350fc55feSKate Arzamastseva    }
1414e136d6ccSKate Arzamastseva
14155b9353faSKate Arzamastseva    $l_more = array('rev' => $l_rev, 'h' => $l_size[1], 'w' => $l_size[0]);
14165b9353faSKate Arzamastseva    $r_more = array('rev' => $r_rev, 'h' => $l_size[1], 'w' => $l_size[0]);
1417e136d6ccSKate Arzamastseva
1418e136d6ccSKate Arzamastseva    $l_src = ml($image, $l_more);
1419e136d6ccSKate Arzamastseva    $r_src = ml($image, $r_more);
1420e136d6ccSKate Arzamastseva
142169143ff2SKate Arzamastseva    // slider
14229a71fb5cSAnika Henke    echo '<div class="slider" style="max-width: '.($l_size[0]-20).'px;" ></div>'.NL;
142369143ff2SKate Arzamastseva
142495b451bcSAdrian Lang    // two images in divs
14259a71fb5cSAnika Henke    echo '<div class="imageDiff ' . $type . '">'.NL;
142695b451bcSAdrian Lang    echo '<div class="image1" style="max-width: '.$l_size[0].'px;">';
14275b9353faSKate Arzamastseva    echo '<img src="'.$l_src.'" alt="" />';
14289a71fb5cSAnika Henke    echo '</div>'.NL;
142995b451bcSAdrian Lang    echo '<div class="image2" style="max-width: '.$l_size[0].'px;">';
14305b9353faSKate Arzamastseva    echo '<img src="'.$r_src.'" alt="" />';
14319a71fb5cSAnika Henke    echo '</div>'.NL;
14329a71fb5cSAnika Henke    echo '</div>'.NL;
14331eeeced2SKate Arzamastseva}
14341eeeced2SKate Arzamastseva
14351eeeced2SKate Arzamastseva/**
14369c1bd4bcSKate Arzamastseva * Restores an old revision of a media file
14379c1bd4bcSKate Arzamastseva *
143842ea7f44SGerrit Uitslag * @param string $image media id
143942ea7f44SGerrit Uitslag * @param int    $rev   revision timestamp or empty string
14409c1bd4bcSKate Arzamastseva * @param int    $auth
14419c1bd4bcSKate Arzamastseva * @return string - file's id
144242ea7f44SGerrit Uitslag *
14439c1bd4bcSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
14449c1bd4bcSKate Arzamastseva */
14459c1bd4bcSKate Arzamastsevafunction media_restore($image, $rev, $auth){
1446e5d185e1SKate Arzamastseva    global $conf;
144780525638SKate Arzamastseva    if ($auth < AUTH_UPLOAD || !$conf['mediarevisions']) return false;
144892cac9a9SKate Arzamastseva    $removed = (!file_exists(mediaFN($image)) && file_exists(mediaMetaFN($image, '.changes')));
144992cac9a9SKate Arzamastseva    if (!$image || (!file_exists(mediaFN($image)) && !$removed)) return false;
14509c1bd4bcSKate Arzamastseva    if (!$rev || !file_exists(mediaFN($image, $rev))) return false;
1451ebc28e69SAndreas Gohr    list(,$imime,) = mimetype($image);
14529c1bd4bcSKate Arzamastseva    $res = media_upload_finish(mediaFN($image, $rev),
14539c1bd4bcSKate Arzamastseva        mediaFN($image),
14549c1bd4bcSKate Arzamastseva        $image,
14559c1bd4bcSKate Arzamastseva        $imime,
14569c1bd4bcSKate Arzamastseva        true,
14579c1bd4bcSKate Arzamastseva        'copy');
14589c1bd4bcSKate Arzamastseva    if (is_array($res)) {
14599c1bd4bcSKate Arzamastseva        msg($res[0], $res[1]);
14609c1bd4bcSKate Arzamastseva        return false;
14619c1bd4bcSKate Arzamastseva    }
14629c1bd4bcSKate Arzamastseva    return $res;
14639c1bd4bcSKate Arzamastseva}
14649c1bd4bcSKate Arzamastseva
14659c1bd4bcSKate Arzamastseva/**
1466bf1f3ac4Ssarnowski * List all files found by the search request
1467c9f56829SAndreas Gohr *
1468c9f56829SAndreas Gohr * @author Tobias Sarnowski <sarnowski@cosmocode.de>
1469c9f56829SAndreas Gohr * @author Andreas Gohr <gohr@cosmocode.de>
1470d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1471c9f56829SAndreas Gohr * @triggers MEDIA_SEARCH
1472e0c26282SGerrit Uitslag *
1473e0c26282SGerrit Uitslag * @param string $query
1474e0c26282SGerrit Uitslag * @param string $ns
1475e0c26282SGerrit Uitslag * @param null|int $auth
1476e0c26282SGerrit Uitslag * @param bool $fullscreen
1477e0c26282SGerrit Uitslag * @param string $sort
1478bf1f3ac4Ssarnowski */
147900e3e394SChristopher Smithfunction media_searchlist($query,$ns,$auth=null,$fullscreen=false,$sort='natural'){
1480bf1f3ac4Ssarnowski    global $conf;
1481bf1f3ac4Ssarnowski    global $lang;
14828e69fd30SKate Arzamastseva
1483bf1f3ac4Ssarnowski    $ns = cleanID($ns);
148456fe6664SAndreas Gohr    $evdata = array(
148556fe6664SAndreas Gohr        'ns'    => $ns,
148656fe6664SAndreas Gohr        'data'  => array(),
148756fe6664SAndreas Gohr        'query' => $query
148856fe6664SAndreas Gohr    );
148959bc3b48SGerrit Uitslag    if ($query) {
149056fe6664SAndreas Gohr        $evt = new Doku_Event('MEDIA_SEARCH', $evdata);
1491bf1f3ac4Ssarnowski        if ($evt->advise_before()) {
149256fe6664SAndreas Gohr            $dir = utf8_encodeFN(str_replace(':','/',$evdata['ns']));
149356fe6664SAndreas Gohr            $pattern = '/'.preg_quote($evdata['query'],'/').'/i';
149456fe6664SAndreas Gohr            search($evdata['data'],
149556fe6664SAndreas Gohr                    $conf['mediadir'],
149656fe6664SAndreas Gohr                    'search_media',
149756fe6664SAndreas Gohr                    array('showmsg'=>false,'pattern'=>$pattern),
149800e3e394SChristopher Smith                    $dir,
149900e3e394SChristopher Smith                    1,
150000e3e394SChristopher Smith                    $sort);
1501bf1f3ac4Ssarnowski        }
1502bf1f3ac4Ssarnowski        $evt->advise_after();
1503bf1f3ac4Ssarnowski        unset($evt);
150456fe6664SAndreas Gohr    }
1505bf1f3ac4Ssarnowski
1506d9162c6cSKate Arzamastseva    if (!$fullscreen) {
150756fe6664SAndreas Gohr        echo '<h1 id="media__ns">'.sprintf($lang['searchmedia_in'],hsc($ns).':*').'</h1>'.NL;
150856fe6664SAndreas Gohr        media_searchform($ns,$query);
1509d9162c6cSKate Arzamastseva    }
151056fe6664SAndreas Gohr
151156fe6664SAndreas Gohr    if(!count($evdata['data'])){
1512bf1f3ac4Ssarnowski        echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL;
15135b9353faSKate Arzamastseva    }else {
15145b9353faSKate Arzamastseva        if ($fullscreen) {
1515554a8c9fSAdrian Lang            echo '<ul class="' . _media_get_list_type() . '">';
15165b9353faSKate Arzamastseva        }
15175b9353faSKate Arzamastseva        foreach($evdata['data'] as $item){
1518d9162c6cSKate Arzamastseva            if (!$fullscreen) media_printfile($item,$item['perm'],'',true);
1519db738de5SKate Arzamastseva            else media_printfile_thumbs($item,$item['perm'],false,true);
1520bf1f3ac4Ssarnowski        }
152194add303SAnika Henke        if ($fullscreen) echo '</ul>'.NL;
15225b9353faSKate Arzamastseva    }
1523bf1f3ac4Ssarnowski}
1524bf1f3ac4Ssarnowski
1525bf1f3ac4Ssarnowski/**
15263df72098SAndreas Gohr * Formats and prints one file in the list
1527e0c26282SGerrit Uitslag *
1528e0c26282SGerrit Uitslag * @param array     $item
1529e0c26282SGerrit Uitslag * @param int       $auth              permission level
1530e0c26282SGerrit Uitslag * @param string    $jump              item id
1531e0c26282SGerrit Uitslag * @param bool      $display_namespace
15323df72098SAndreas Gohr */
1533bf1f3ac4Ssarnowskifunction media_printfile($item,$auth,$jump,$display_namespace=false){
153464c9cfd5SAndreas Gohr    global $lang;
153564c9cfd5SAndreas Gohr
15363df72098SAndreas Gohr    // Prepare zebra coloring
15373df72098SAndreas Gohr    // I always wanted to use this variable name :-D
15383df72098SAndreas Gohr    static $twibble = 1;
15393df72098SAndreas Gohr    $twibble *= -1;
15403df72098SAndreas Gohr    $zebra = ($twibble == -1) ? 'odd' : 'even';
15413df72098SAndreas Gohr
15423df72098SAndreas Gohr    // Automatically jump to recent action
15433df72098SAndreas Gohr    if($jump == $item['id']) {
15443df72098SAndreas Gohr        $jump = ' id="scroll__here" ';
15453df72098SAndreas Gohr    }else{
15463df72098SAndreas Gohr        $jump = '';
15473df72098SAndreas Gohr    }
15483df72098SAndreas Gohr
15493df72098SAndreas Gohr    // Prepare fileicons
1550ebc28e69SAndreas Gohr    list($ext) = mimetype($item['file'],false);
15513df72098SAndreas Gohr    $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
15523df72098SAndreas Gohr    $class = 'select mediafile mf_'.$class;
15533df72098SAndreas Gohr
15543df72098SAndreas Gohr    // Prepare filename
15553df72098SAndreas Gohr    $file = utf8_decodeFN($item['file']);
15563df72098SAndreas Gohr
15573df72098SAndreas Gohr    // Prepare info
15583df72098SAndreas Gohr    $info = '';
15593df72098SAndreas Gohr    if($item['isimg']){
15603df72098SAndreas Gohr        $info .= (int) $item['meta']->getField('File.Width');
15613df72098SAndreas Gohr        $info .= '&#215;';
15623df72098SAndreas Gohr        $info .= (int) $item['meta']->getField('File.Height');
15633df72098SAndreas Gohr        $info .= ' ';
15643df72098SAndreas Gohr    }
1565f2263577SAndreas Gohr    $info .= '<i>'.dformat($item['mtime']).'</i>';
15665e7fa82eSAndreas Gohr    $info .= ' ';
15673df72098SAndreas Gohr    $info .= filesize_h($item['size']);
15683df72098SAndreas Gohr
1569c9f56829SAndreas Gohr    // output
157002eb484fSAndreas Gohr    echo '<div class="'.$zebra.'"'.$jump.' title="'.hsc($item['id']).'">'.NL;
1571c9f56829SAndreas Gohr    if (!$display_namespace) {
157263e967bdSAnika Henke        echo '<a id="h_:'.$item['id'].'" class="'.$class.'">'.hsc($file).'</a> ';
1573c9f56829SAndreas Gohr    } else {
157463e967bdSAnika Henke        echo '<a id="h_:'.$item['id'].'" class="'.$class.'">'.hsc($item['id']).'</a><br/>';
1575c9f56829SAndreas Gohr    }
15763df72098SAndreas Gohr    echo '<span class="info">('.$info.')</span>'.NL;
157730fd72fbSKate Arzamastseva
157830fd72fbSKate Arzamastseva    // view button
157930fd72fbSKate Arzamastseva    $link = ml($item['id'],'',true);
158030fd72fbSKate Arzamastseva    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/magnifier.png" '.
158130fd72fbSKate Arzamastseva        'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
158230fd72fbSKate Arzamastseva
1583f20ead66SAndreas Gohr    // mediamanager button
1584eea07c23SAnika Henke    $link = wl('',array('do'=>'media','image'=>$item['id'],'ns'=>getNS($item['id'])));
1585f20ead66SAndreas Gohr    echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE.'lib/images/mediamanager.png" '.
1586f20ead66SAndreas Gohr        'alt="'.$lang['btn_media'].'" title="'.$lang['btn_media'].'" class="btn" /></a>';
1587f20ead66SAndreas Gohr
1588f20ead66SAndreas Gohr    // delete button
1589f20ead66SAndreas Gohr    if($item['writable'] && $auth >= AUTH_DELETE){
1590f20ead66SAndreas Gohr        $link = DOKU_BASE.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).
1591f20ead66SAndreas Gohr            '&amp;sectok='.getSecurityToken();
1592f20ead66SAndreas Gohr        echo ' <a href="'.$link.'" class="btn_media_delete" title="'.$item['id'].'">'.
1593f20ead66SAndreas Gohr            '<img src="'.DOKU_BASE.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
1594f20ead66SAndreas Gohr            'title="'.$lang['btn_delete'].'" class="btn" /></a>';
1595f20ead66SAndreas Gohr    }
1596f20ead66SAndreas Gohr
1597f495da32SAnika Henke    echo '<div class="example" id="ex_'.str_replace(':','_',$item['id']).'">';
15980b173dceSAndreas Gohr    echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
159964c9cfd5SAndreas Gohr    echo '</div>';
16003df72098SAndreas Gohr    if($item['isimg']) media_printimgdetail($item);
16013df72098SAndreas Gohr    echo '<div class="clearer"></div>'.NL;
16023df72098SAndreas Gohr    echo '</div>'.NL;
16033df72098SAndreas Gohr}
16043df72098SAndreas Gohr
1605c6571d58SAndreas Gohr/**
1606c6571d58SAndreas Gohr * Display a media icon
1607c6571d58SAndreas Gohr *
160842ea7f44SGerrit Uitslag * @param string $filename media id
1609c6571d58SAndreas Gohr * @param string $size     the size subfolder, if not specified 16x16 is used
161042ea7f44SGerrit Uitslag * @return string html
1611c6571d58SAndreas Gohr */
1612c6571d58SAndreas Gohrfunction media_printicon($filename, $size=''){
1613ebc28e69SAndreas Gohr    list($ext) = mimetype(mediaFN($filename),false);
161423786fd7SKate Arzamastseva
161579e79377SAndreas Gohr    if (file_exists(DOKU_INC.'lib/images/fileicons/'.$size.'/'.$ext.'.png')) {
1616c6571d58SAndreas Gohr        $icon = DOKU_BASE.'lib/images/fileicons/'.$size.'/'.$ext.'.png';
161723786fd7SKate Arzamastseva    } else {
1618c6571d58SAndreas Gohr        $icon = DOKU_BASE.'lib/images/fileicons/'.$size.'/file.png';
161923786fd7SKate Arzamastseva    }
162023786fd7SKate Arzamastseva
1621421ec38eSKate Arzamastseva    return '<img src="'.$icon.'" alt="'.$filename.'" class="icon" />';
162223786fd7SKate Arzamastseva}
162323786fd7SKate Arzamastseva
16243df72098SAndreas Gohr/**
1625d9162c6cSKate Arzamastseva * Formats and prints one file in the list in the thumbnails view
1626d9162c6cSKate Arzamastseva *
1627d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1628e0c26282SGerrit Uitslag *
1629e0c26282SGerrit Uitslag * @param array       $item
163042ea7f44SGerrit Uitslag * @param int         $auth              permission level
163142ea7f44SGerrit Uitslag * @param bool|string $jump              item id
1632e0c26282SGerrit Uitslag * @param bool        $display_namespace
1633d9162c6cSKate Arzamastseva */
1634db738de5SKate Arzamastsevafunction media_printfile_thumbs($item,$auth,$jump=false,$display_namespace=false){
1635d9162c6cSKate Arzamastseva
1636d9162c6cSKate Arzamastseva    // Prepare filename
1637d9162c6cSKate Arzamastseva    $file = utf8_decodeFN($item['file']);
1638d9162c6cSKate Arzamastseva
1639030dd1d9SKate Arzamastseva    // output
164002eb484fSAndreas Gohr    echo '<li><dl title="'.hsc($item['id']).'">'.NL;
164123786fd7SKate Arzamastseva
164295b451bcSAdrian Lang        echo '<dt>';
16436b467722SKate Arzamastseva    if($item['isimg']) {
16446b467722SKate Arzamastseva        media_printimgdetail($item, true);
164523786fd7SKate Arzamastseva
16466b467722SKate Arzamastseva    } else {
164763e967bdSAnika Henke        echo '<a id="d_:'.$item['id'].'" class="image" title="'.$item['id'].'" href="'.
164830fd72fbSKate Arzamastseva            media_managerURL(array('image' => hsc($item['id']), 'ns' => getNS($item['id']),
164995b451bcSAdrian Lang            'tab_details' => 'view')).'">';
1650c6571d58SAndreas Gohr        echo media_printicon($item['id'], '32x32');
165195b451bcSAdrian Lang        echo '</a>';
16526b467722SKate Arzamastseva    }
165394add303SAnika Henke    echo '</dt>'.NL;
1654db738de5SKate Arzamastseva    if (!$display_namespace) {
1655db738de5SKate Arzamastseva        $name = hsc($file);
1656db738de5SKate Arzamastseva    } else {
1657db738de5SKate Arzamastseva        $name = hsc($item['id']);
1658db738de5SKate Arzamastseva    }
165995b451bcSAdrian Lang    echo '<dd class="name"><a href="'.media_managerURL(array('image' => hsc($item['id']), 'ns' => getNS($item['id']),
166063e967bdSAnika Henke        'tab_details' => 'view')).'" id="h_:'.$item['id'].'">'.$name.'</a></dd>'.NL;
1661db738de5SKate Arzamastseva
1662d9162c6cSKate Arzamastseva    if($item['isimg']){
1663322111f0SKate Arzamastseva        $size = '';
1664322111f0SKate Arzamastseva        $size .= (int) $item['meta']->getField('File.Width');
1665322111f0SKate Arzamastseva        $size .= '&#215;';
1666322111f0SKate Arzamastseva        $size .= (int) $item['meta']->getField('File.Height');
166794add303SAnika Henke        echo '<dd class="size">'.$size.'</dd>'.NL;
16686b467722SKate Arzamastseva    } else {
1669e260f93bSAnika Henke        echo '<dd class="size">&#160;</dd>'.NL;
1670d9162c6cSKate Arzamastseva    }
1671322111f0SKate Arzamastseva    $date = dformat($item['mtime']);
167294add303SAnika Henke    echo '<dd class="date">'.$date.'</dd>'.NL;
1673322111f0SKate Arzamastseva    $filesize = filesize_h($item['size']);
167494add303SAnika Henke    echo '<dd class="filesize">'.$filesize.'</dd>'.NL;
167595b451bcSAdrian Lang    echo '</dl></li>'.NL;
1676d9162c6cSKate Arzamastseva}
1677d9162c6cSKate Arzamastseva
1678d9162c6cSKate Arzamastseva/**
16795381a7eeSElan Ruusamäe * Prints a thumbnail and metainfo
1680e0c26282SGerrit Uitslag *
1681e0c26282SGerrit Uitslag * @param array $item
1682e0c26282SGerrit Uitslag * @param bool  $fullscreen
16833df72098SAndreas Gohr */
1684d9162c6cSKate Arzamastsevafunction media_printimgdetail($item, $fullscreen=false){
16853df72098SAndreas Gohr    // prepare thumbnail
168633e91473SAdrian Lang    $size = $fullscreen ? 90 : 120;
168733e91473SAdrian Lang
16883df72098SAndreas Gohr    $w = (int) $item['meta']->getField('File.Width');
16893df72098SAndreas Gohr    $h = (int) $item['meta']->getField('File.Height');
1690d9162c6cSKate Arzamastseva    if($w>$size || $h>$size){
16916b467722SKate Arzamastseva        if (!$fullscreen) {
1692d9162c6cSKate Arzamastseva            $ratio = $item['meta']->getResizeRatio($size);
16936b467722SKate Arzamastseva        } else {
16946b467722SKate Arzamastseva            $ratio = $item['meta']->getResizeRatio($size,$size);
16956b467722SKate Arzamastseva        }
16963df72098SAndreas Gohr        $w = floor($w * $ratio);
16973df72098SAndreas Gohr        $h = floor($h * $ratio);
16983df72098SAndreas Gohr    }
169996dedb92SKate Arzamastseva    $src = ml($item['id'],array('w'=>$w,'h'=>$h,'t'=>$item['mtime']));
17003df72098SAndreas Gohr    $p = array();
17016316bc71SKate Arzamastseva    if (!$fullscreen) {
170233e91473SAdrian Lang        // In fullscreen mediamanager view, image resizing is done via CSS.
17033df72098SAndreas Gohr        $p['width']  = $w;
17046316bc71SKate Arzamastseva        $p['height'] = $h;
17056316bc71SKate Arzamastseva    }
17063df72098SAndreas Gohr    $p['alt']    = $item['id'];
17073df72098SAndreas Gohr    $att = buildAttributes($p);
17083df72098SAndreas Gohr
17093df72098SAndreas Gohr    // output
1710d9162c6cSKate Arzamastseva    if ($fullscreen) {
171163e967bdSAnika Henke        echo '<a id="l_:'.$item['id'].'" class="image thumb" href="'.
171230fd72fbSKate Arzamastseva            media_managerURL(array('image' => hsc($item['id']), 'ns' => getNS($item['id']), 'tab_details' => 'view')).'">';
171380326249SAnika Henke        echo '<img src="'.$src.'" '.$att.' />';
1714d9162c6cSKate Arzamastseva        echo '</a>';
1715d9162c6cSKate Arzamastseva    }
17166316bc71SKate Arzamastseva
171733e91473SAdrian Lang    if ($fullscreen) return;
1718d9162c6cSKate Arzamastseva
17193df72098SAndreas Gohr    echo '<div class="detail">';
17203df72098SAndreas Gohr    echo '<div class="thumb">';
172163e967bdSAnika Henke    echo '<a id="d_:'.$item['id'].'" class="select">';
17223df72098SAndreas Gohr    echo '<img src="'.$src.'" '.$att.' />';
17233df72098SAndreas Gohr    echo '</a>';
17243df72098SAndreas Gohr    echo '</div>';
17253df72098SAndreas Gohr
17263df72098SAndreas Gohr    // read EXIF/IPTC data
172749ac3837Shakan.sandell    $t = $item['meta']->getField(array('IPTC.Headline','xmp.dc:title'));
17280b173dceSAndreas Gohr    $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
17293df72098SAndreas Gohr                'EXIF.TIFFImageDescription',
17303df72098SAndreas Gohr                'EXIF.TIFFUserComment'));
17310b173dceSAndreas Gohr    if(utf8_strlen($d) > 250) $d = utf8_substr($d,0,250).'...';
173249ac3837Shakan.sandell    $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category','xmp.dc:subject'));
17333df72098SAndreas Gohr
17340b173dceSAndreas Gohr    // print EXIF/IPTC data
17350b173dceSAndreas Gohr    if($t || $d || $k ){
17360b173dceSAndreas Gohr        echo '<p>';
173765cc1598SPhy        if($t) echo '<strong>'.hsc($t).'</strong><br />';
173865cc1598SPhy        if($d) echo hsc($d).'<br />';
173965cc1598SPhy        if($t) echo '<em>'.hsc($k).'</em>';
17403df72098SAndreas Gohr        echo '</p>';
17410b173dceSAndreas Gohr    }
17423df72098SAndreas Gohr    echo '</div>';
17433df72098SAndreas Gohr}
17443df72098SAndreas Gohr
17453df72098SAndreas Gohr/**
174642ea7f44SGerrit Uitslag * Build link based on the current, adding/rewriting parameters
1747d9162c6cSKate Arzamastseva *
1748d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
174942ea7f44SGerrit Uitslag *
1750ebc28e69SAndreas Gohr * @param array|bool $params
175142ea7f44SGerrit Uitslag * @param string     $amp           separator
175242ea7f44SGerrit Uitslag * @param bool       $abs           absolute url?
175342ea7f44SGerrit Uitslag * @param bool       $params_array  return the parmeters array?
175442ea7f44SGerrit Uitslag * @return string|array - link or link parameters
1755d9162c6cSKate Arzamastseva */
1756035e07f1SKate Arzamastsevafunction media_managerURL($params=false, $amp='&amp;', $abs=false, $params_array=false) {
1757d9162c6cSKate Arzamastseva    global $ID;
17588108113cSTom N Harris    global $INPUT;
1759d9162c6cSKate Arzamastseva
176023846a98SKate Arzamastseva    $gets = array('do' => 'media');
1761554a8c9fSAdrian Lang    $media_manager_params = array('tab_files', 'tab_details', 'image', 'ns', 'list', 'sort');
176223846a98SKate Arzamastseva    foreach ($media_manager_params as $x) {
17638108113cSTom N Harris        if ($INPUT->has($x)) $gets[$x] = $INPUT->str($x);
176423846a98SKate Arzamastseva    }
1765d9162c6cSKate Arzamastseva
1766d9162c6cSKate Arzamastseva    if ($params) {
1767554a8c9fSAdrian Lang        $gets = $params + $gets;
1768d9162c6cSKate Arzamastseva    }
1769d9162c6cSKate Arzamastseva    unset($gets['id']);
1770554a8c9fSAdrian Lang    if (isset($gets['delete'])) {
17711eeeced2SKate Arzamastseva        unset($gets['image']);
17721eeeced2SKate Arzamastseva        unset($gets['tab_details']);
17731eeeced2SKate Arzamastseva    }
1774d9162c6cSKate Arzamastseva
1775035e07f1SKate Arzamastseva    if ($params_array) return $gets;
1776035e07f1SKate Arzamastseva
17776dd095f5SKate Arzamastseva    return wl($ID,$gets,$abs,$amp);
1778d9162c6cSKate Arzamastseva}
1779d9162c6cSKate Arzamastseva
1780d9162c6cSKate Arzamastseva/**
17813df72098SAndreas Gohr * Print the media upload form if permissions are correct
17823df72098SAndreas Gohr *
17833df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
1784d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1785e0c26282SGerrit Uitslag *
1786e0c26282SGerrit Uitslag * @param string $ns
1787e0c26282SGerrit Uitslag * @param int    $auth permission level
1788e0c26282SGerrit Uitslag * @param bool  $fullscreen
17893df72098SAndreas Gohr */
1790d9162c6cSKate Arzamastsevafunction media_uploadform($ns, $auth, $fullscreen = false){
17918108113cSTom N Harris    global $lang;
17928108113cSTom N Harris    global $conf;
17938108113cSTom N Harris    global $INPUT;
17943df72098SAndreas Gohr
179588a71175SKate Arzamastseva    if($auth < AUTH_UPLOAD) {
179688a71175SKate Arzamastseva        echo '<div class="nothing">'.$lang['media_perm_upload'].'</div>'.NL;
179788a71175SKate Arzamastseva        return;
179888a71175SKate Arzamastseva    }
179992cac9a9SKate Arzamastseva    $auth_ow = (($conf['mediarevisions']) ? AUTH_UPLOAD : AUTH_DELETE);
18003df72098SAndreas Gohr
180170c3cc9aSKate Arzamastseva    $update = false;
180270c3cc9aSKate Arzamastseva    $id = '';
18038108113cSTom N Harris    if ($auth >= $auth_ow && $fullscreen && $INPUT->str('mediado') == 'update') {
180470c3cc9aSKate Arzamastseva        $update = true;
18058108113cSTom N Harris        $id = cleanID($INPUT->str('image'));
180670c3cc9aSKate Arzamastseva    }
180770c3cc9aSKate Arzamastseva
1808d00ec455SAndreas Gohr    // The default HTML upload form
1809d9162c6cSKate Arzamastseva    $params = array('id'      => 'dw__upload',
1810d9162c6cSKate Arzamastseva                    'enctype' => 'multipart/form-data');
181198f03b57SKate Arzamastseva    if (!$fullscreen) {
18129de3b571SKate Arzamastseva        $params['action'] = DOKU_BASE.'lib/exe/mediamanager.php';
181398f03b57SKate Arzamastseva    } else {
181498f03b57SKate Arzamastseva        $params['action'] = media_managerURL(array('tab_files' => 'files',
18156183fb05SKate Arzamastseva            'tab_details' => 'view'), '&');
181698f03b57SKate Arzamastseva    }
1817d9162c6cSKate Arzamastseva
1818d9162c6cSKate Arzamastseva    $form = new Doku_Form($params);
1819c472bad9SKate Arzamastseva    if (!$fullscreen) echo '<div class="upload">' . $lang['mediaupload'] . '</div>';
18209f5dde7fSMichael Klier    $form->addElement(formSecurityToken());
18219f5dde7fSMichael Klier    $form->addHidden('ns', hsc($ns));
18229f5dde7fSMichael Klier    $form->addElement(form_makeOpenTag('p'));
1823fde860beSGerrit Uitslag    $form->addElement(form_makeFileField('upload', $lang['txt_upload'], 'upload__file'));
18249f5dde7fSMichael Klier    $form->addElement(form_makeCloseTag('p'));
18259f5dde7fSMichael Klier    $form->addElement(form_makeOpenTag('p'));
1826fde860beSGerrit Uitslag    $form->addElement(form_makeTextField('mediaid', noNS($id), $lang['txt_filename'], 'upload__name'));
18279f5dde7fSMichael Klier    $form->addElement(form_makeButton('submit', '', $lang['btn_upload']));
18289f5dde7fSMichael Klier    $form->addElement(form_makeCloseTag('p'));
1829cf6894dfSAndreas Gohr
183092cac9a9SKate Arzamastseva    if($auth >= $auth_ow){
18319f5dde7fSMichael Klier        $form->addElement(form_makeOpenTag('p'));
183270c3cc9aSKate Arzamastseva        $attrs = array();
183370c3cc9aSKate Arzamastseva        if ($update) $attrs['checked'] = 'checked';
183470c3cc9aSKate Arzamastseva        $form->addElement(form_makeCheckboxField('ow', 1, $lang['txt_overwrt'], 'dw__ow', 'check', $attrs));
18359f5dde7fSMichael Klier        $form->addElement(form_makeCloseTag('p'));
18363df72098SAndreas Gohr    }
1837c472bad9SKate Arzamastseva
183894add303SAnika Henke    echo NL.'<div id="mediamanager__uploader">'.NL;
18399f5dde7fSMichael Klier    html_form('upload', $form);
1840f940e4a0SAndreas Gohr
184194add303SAnika Henke    echo '</div>'.NL;
1842f940e4a0SAndreas Gohr
1843f940e4a0SAndreas Gohr    echo '<p class="maxsize">';
1844f940e4a0SAndreas Gohr    printf($lang['maxuploadsize'],filesize_h(media_getuploadsize()));
1845f940e4a0SAndreas Gohr    echo '</p>'.NL;
1846f940e4a0SAndreas Gohr
1847f940e4a0SAndreas Gohr}
1848f940e4a0SAndreas Gohr
1849f940e4a0SAndreas Gohr/**
1850f940e4a0SAndreas Gohr * Returns the size uploaded files may have
1851f940e4a0SAndreas Gohr *
1852f940e4a0SAndreas Gohr * This uses a conservative approach using the lowest number found
1853f940e4a0SAndreas Gohr * in any of the limiting ini settings
1854f940e4a0SAndreas Gohr *
1855f940e4a0SAndreas Gohr * @returns int size in bytes
1856f940e4a0SAndreas Gohr */
1857f940e4a0SAndreas Gohrfunction media_getuploadsize(){
1858f940e4a0SAndreas Gohr    $okay = 0;
1859f940e4a0SAndreas Gohr
1860f940e4a0SAndreas Gohr    $post = (int) php_to_byte(@ini_get('post_max_size'));
1861f940e4a0SAndreas Gohr    $suho = (int) php_to_byte(@ini_get('suhosin.post.max_value_length'));
1862f940e4a0SAndreas Gohr    $upld = (int) php_to_byte(@ini_get('upload_max_filesize'));
1863f940e4a0SAndreas Gohr
1864f940e4a0SAndreas Gohr    if($post && ($post < $okay || $okay == 0)) $okay = $post;
1865f940e4a0SAndreas Gohr    if($suho && ($suho < $okay || $okay == 0)) $okay = $suho;
1866f940e4a0SAndreas Gohr    if($upld && ($upld < $okay || $okay == 0)) $okay = $upld;
1867f940e4a0SAndreas Gohr
1868f940e4a0SAndreas Gohr    return $okay;
18699f5dde7fSMichael Klier}
18703df72098SAndreas Gohr
18713df72098SAndreas Gohr/**
1872bf1f3ac4Ssarnowski * Print the search field form
1873bf1f3ac4Ssarnowski *
1874bf1f3ac4Ssarnowski * @author Tobias Sarnowski <sarnowski@cosmocode.de>
1875d9162c6cSKate Arzamastseva * @author Kate Arzamastseva <pshns@ukr.net>
1876e0c26282SGerrit Uitslag *
1877e0c26282SGerrit Uitslag * @param string $ns
1878e0c26282SGerrit Uitslag * @param string $query
1879e0c26282SGerrit Uitslag * @param bool $fullscreen
1880bf1f3ac4Ssarnowski */
1881d9162c6cSKate Arzamastsevafunction media_searchform($ns,$query='',$fullscreen=false){
1882bf1f3ac4Ssarnowski    global $lang;
1883bf1f3ac4Ssarnowski
1884bf1f3ac4Ssarnowski    // The default HTML search form
1885d9162c6cSKate Arzamastseva    $params = array('id' => 'dw__mediasearch');
1886554a8c9fSAdrian Lang    if (!$fullscreen) {
1887554a8c9fSAdrian Lang        $params['action'] = DOKU_BASE.'lib/exe/mediamanager.php';
1888554a8c9fSAdrian Lang    } else {
1889554a8c9fSAdrian Lang        $params['action'] = media_managerURL(array(), '&');
1890554a8c9fSAdrian Lang    }
1891d9162c6cSKate Arzamastseva    $form = new Doku_Form($params);
1892c9f56829SAndreas Gohr    $form->addHidden('ns', $ns);
1893554a8c9fSAdrian Lang    $form->addHidden($fullscreen ? 'mediado' : 'do', 'searchlist');
1894554a8c9fSAdrian Lang
1895bf1f3ac4Ssarnowski    $form->addElement(form_makeOpenTag('p'));
1896554a8c9fSAdrian Lang    $form->addElement(form_makeTextField('q', $query,$lang['searchmedia'],'','',array('title'=>sprintf($lang['searchmedia_in'],hsc($ns).':*'))));
1897bf1f3ac4Ssarnowski    $form->addElement(form_makeButton('submit', '', $lang['btn_search']));
1898bf1f3ac4Ssarnowski    $form->addElement(form_makeCloseTag('p'));
1899bf1f3ac4Ssarnowski    html_form('searchmedia', $form);
1900bf1f3ac4Ssarnowski}
1901bf1f3ac4Ssarnowski
1902bf1f3ac4Ssarnowski/**
19033df72098SAndreas Gohr * Build a tree outline of available media namespaces
19043df72098SAndreas Gohr *
19053df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
1906e0c26282SGerrit Uitslag *
1907e0c26282SGerrit Uitslag * @param string $ns
19083df72098SAndreas Gohr */
19093df72098SAndreas Gohrfunction media_nstree($ns){
19103df72098SAndreas Gohr    global $conf;
1911256ca81eSAndreas Gohr    global $lang;
19123df72098SAndreas Gohr
19133df72098SAndreas Gohr    // currently selected namespace
19143df72098SAndreas Gohr    $ns  = cleanID($ns);
19153df72098SAndreas Gohr    if(empty($ns)){
1916de3eb1d7SAdrian Lang        global $ID;
1917dd90013aSMichael Hamann        $ns = (string)getNS($ID);
19183df72098SAndreas Gohr    }
1919dd90013aSMichael Hamann
1920dd90013aSMichael Hamann    $ns_dir  = utf8_encodeFN(str_replace(':','/',$ns));
19213df72098SAndreas Gohr
19223df72098SAndreas Gohr    $data = array();
1923dd90013aSMichael Hamann    search($data,$conf['mediadir'],'search_index',array('ns' => $ns_dir, 'nofiles' => true));
19243df72098SAndreas Gohr
19253df72098SAndreas Gohr    // wrap a list with the root level around the other namespaces
1926a1dee2b9SAdrian Lang    array_unshift($data, array('level' => 0, 'id' => '', 'open' =>'true',
1927a1dee2b9SAdrian Lang                               'label' => '['.$lang['mediaroot'].']'));
19283df72098SAndreas Gohr
1929dd90013aSMichael Hamann    // insert the current ns into the hierarchy if it isn't already part of it
1930dd90013aSMichael Hamann    $ns_parts = explode(':', $ns);
1931dd90013aSMichael Hamann    $tmp_ns = '';
1932dd90013aSMichael Hamann    $pos = 0;
1933dd90013aSMichael Hamann    foreach ($ns_parts as $level => $part) {
1934dd90013aSMichael Hamann        if ($tmp_ns) $tmp_ns .= ':'.$part;
1935dd90013aSMichael Hamann        else $tmp_ns = $part;
1936dd90013aSMichael Hamann
1937dd90013aSMichael Hamann        // find the namespace parts or insert them
1938dd90013aSMichael Hamann        while ($data[$pos]['id'] != $tmp_ns) {
1939dd90013aSMichael Hamann            if ($pos >= count($data) || ($data[$pos]['level'] <= $level+1 && strnatcmp(utf8_encodeFN($data[$pos]['id']), utf8_encodeFN($tmp_ns)) > 0)) {
1940dd90013aSMichael Hamann                array_splice($data, $pos, 0, array(array('level' => $level+1, 'id' => $tmp_ns, 'open' => 'true')));
1941dd90013aSMichael Hamann                break;
1942dd90013aSMichael Hamann            }
1943dd90013aSMichael Hamann            ++$pos;
1944dd90013aSMichael Hamann        }
1945dd90013aSMichael Hamann    }
1946dd90013aSMichael Hamann
19473df72098SAndreas Gohr    echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
19483df72098SAndreas Gohr}
19493df72098SAndreas Gohr
19503df72098SAndreas Gohr/**
19513df72098SAndreas Gohr * Userfunction for html_buildlist
19523df72098SAndreas Gohr *
19533df72098SAndreas Gohr * Prints a media namespace tree item
19543df72098SAndreas Gohr *
19553df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
195642ea7f44SGerrit Uitslag *
195742ea7f44SGerrit Uitslag * @param array $item
195842ea7f44SGerrit Uitslag * @return string html
19593df72098SAndreas Gohr */
19603df72098SAndreas Gohrfunction media_nstree_item($item){
19618108113cSTom N Harris    global $INPUT;
19623df72098SAndreas Gohr    $pos   = strrpos($item['id'], ':');
19633df72098SAndreas Gohr    $label = substr($item['id'], $pos > 0 ? $pos + 1 : 0);
19640e80bb5eSChristopher Smith    if(empty($item['label'])) $item['label'] = $label;
19653df72098SAndreas Gohr
19663df72098SAndreas Gohr    $ret  = '';
19678108113cSTom N Harris    if (!($INPUT->str('do') == 'media'))
19683df72098SAndreas Gohr    $ret .= '<a href="'.DOKU_BASE.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
1969370d3435SAdrian Lang    else $ret .= '<a href="'.media_managerURL(array('ns' => idfilter($item['id'], false), 'tab_files' => 'files'))
197023846a98SKate Arzamastseva        .'" class="idx_dir">';
19713df72098SAndreas Gohr    $ret .= $item['label'];
19723df72098SAndreas Gohr    $ret .= '</a>';
19733df72098SAndreas Gohr    return $ret;
19743df72098SAndreas Gohr}
19753df72098SAndreas Gohr
19763df72098SAndreas Gohr/**
19773df72098SAndreas Gohr * Userfunction for html_buildlist
19783df72098SAndreas Gohr *
19793df72098SAndreas Gohr * Prints a media namespace tree item opener
19803df72098SAndreas Gohr *
19813df72098SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
198242ea7f44SGerrit Uitslag *
198342ea7f44SGerrit Uitslag * @param array $item
198442ea7f44SGerrit Uitslag * @return string html
19853df72098SAndreas Gohr */
19863df72098SAndreas Gohrfunction media_nstree_li($item){
19873df72098SAndreas Gohr    $class='media level'.$item['level'];
19883df72098SAndreas Gohr    if($item['open']){
19893df72098SAndreas Gohr        $class .= ' open';
19903df72098SAndreas Gohr        $img   = DOKU_BASE.'lib/images/minus.gif';
1991e260f93bSAnika Henke        $alt   = '−';
19923df72098SAndreas Gohr    }else{
19933df72098SAndreas Gohr        $class .= ' closed';
19943df72098SAndreas Gohr        $img   = DOKU_BASE.'lib/images/plus.gif';
19957af1b404SAnika Henke        $alt   = '+';
19963df72098SAndreas Gohr    }
1997231b8c34SPierre Spring    // TODO: only deliver an image if it actually has a subtree...
19983df72098SAndreas Gohr    return '<li class="'.$class.'">'.
19997af1b404SAnika Henke        '<img src="'.$img.'" alt="'.$alt.'" />';
20003df72098SAndreas Gohr}
200113c08e2fSMichael Klier
200213c08e2fSMichael Klier/**
200313c08e2fSMichael Klier * Resizes the given image to the given size
200413c08e2fSMichael Klier *
200513c08e2fSMichael Klier * @author  Andreas Gohr <andi@splitbrain.org>
200642ea7f44SGerrit Uitslag *
200742ea7f44SGerrit Uitslag * @param string $file filename, path to file
200842ea7f44SGerrit Uitslag * @param string $ext  extension
200942ea7f44SGerrit Uitslag * @param int    $w    desired width
201042ea7f44SGerrit Uitslag * @param int    $h    desired height
201142ea7f44SGerrit Uitslag * @return string path to resized or original size if failed
201213c08e2fSMichael Klier */
201313c08e2fSMichael Klierfunction media_resize_image($file, $ext, $w, $h=0){
201413c08e2fSMichael Klier    global $conf;
201513c08e2fSMichael Klier
201613c08e2fSMichael Klier    $info = @getimagesize($file); //get original size
201713c08e2fSMichael Klier    if($info == false) return $file; // that's no image - it's a spaceship!
201813c08e2fSMichael Klier
201913c08e2fSMichael Klier    if(!$h) $h = round(($w * $info[1]) / $info[0]);
202077450f40Slisps    if(!$w) $w = round(($h * $info[0]) / $info[1]);
202113c08e2fSMichael Klier
202213c08e2fSMichael Klier    // we wont scale up to infinity
202313c08e2fSMichael Klier    if($w > 2000 || $h > 2000) return $file;
202413c08e2fSMichael Klier
2025f0b65004SChristopher Smith    // resize necessary? - (w,h) = native dimensions
2026f0b65004SChristopher Smith    if(($w == $info[0]) && ($h == $info[1])) return $file;
2027f0b65004SChristopher Smith
202813c08e2fSMichael Klier    //cache
202913c08e2fSMichael Klier    $local = getCacheName($file,'.media.'.$w.'x'.$h.'.'.$ext);
203013c08e2fSMichael Klier    $mtime = @filemtime($local); // 0 if not exists
203113c08e2fSMichael Klier
203213c08e2fSMichael Klier    if($mtime > filemtime($file) ||
203313c08e2fSMichael Klier        media_resize_imageIM($ext, $file, $info[0], $info[1], $local, $w, $h) ||
203442ea7f44SGerrit Uitslag        media_resize_imageGD($ext, $file, $info[0], $info[1], $local, $w, $h)
203542ea7f44SGerrit Uitslag    ) {
20360e80bb5eSChristopher Smith        if(!empty($conf['fperm'])) @chmod($local, $conf['fperm']);
203713c08e2fSMichael Klier        return $local;
203813c08e2fSMichael Klier    }
203913c08e2fSMichael Klier    //still here? resizing failed
204013c08e2fSMichael Klier    return $file;
204113c08e2fSMichael Klier}
204213c08e2fSMichael Klier
204313c08e2fSMichael Klier/**
204413c08e2fSMichael Klier * Crops the given image to the wanted ratio, then calls media_resize_image to scale it
204513c08e2fSMichael Klier * to the wanted size
204613c08e2fSMichael Klier *
204713c08e2fSMichael Klier * Crops are centered horizontally but prefer the upper third of an vertical
204813c08e2fSMichael Klier * image because most pics are more interesting in that area (rule of thirds)
204913c08e2fSMichael Klier *
205013c08e2fSMichael Klier * @author  Andreas Gohr <andi@splitbrain.org>
205142ea7f44SGerrit Uitslag *
205242ea7f44SGerrit Uitslag * @param string $file filename, path to file
205342ea7f44SGerrit Uitslag * @param string $ext  extension
205442ea7f44SGerrit Uitslag * @param int    $w    desired width
205542ea7f44SGerrit Uitslag * @param int    $h    desired height
205642ea7f44SGerrit Uitslag * @return string path to resized or original size if failed
205713c08e2fSMichael Klier */
205813c08e2fSMichael Klierfunction media_crop_image($file, $ext, $w, $h=0){
205913c08e2fSMichael Klier    global $conf;
206013c08e2fSMichael Klier
206113c08e2fSMichael Klier    if(!$h) $h = $w;
206213c08e2fSMichael Klier    $info = @getimagesize($file); //get original size
206313c08e2fSMichael Klier    if($info == false) return $file; // that's no image - it's a spaceship!
206413c08e2fSMichael Klier
206513c08e2fSMichael Klier    // calculate crop size
206613c08e2fSMichael Klier    $fr = $info[0]/$info[1];
206713c08e2fSMichael Klier    $tr = $w/$h;
2068fd9d3278SChristopher Smith
2069fd9d3278SChristopher Smith    // check if the crop can be handled completely by resize,
2070fd9d3278SChristopher Smith    // i.e. the specified width & height match the aspect ratio of the source image
2071fd9d3278SChristopher Smith    if ($w == round($h*$fr)) {
2072fd9d3278SChristopher Smith        return media_resize_image($file, $ext, $w);
2073fd9d3278SChristopher Smith    }
2074fd9d3278SChristopher Smith
207513c08e2fSMichael Klier    if($tr >= 1){
207613c08e2fSMichael Klier        if($tr > $fr){
207713c08e2fSMichael Klier            $cw = $info[0];
2078d02ff930SChristopher Smith            $ch = (int) ($info[0]/$tr);
207913c08e2fSMichael Klier        }else{
2080d02ff930SChristopher Smith            $cw = (int) ($info[1]*$tr);
208113c08e2fSMichael Klier            $ch = $info[1];
208213c08e2fSMichael Klier        }
208313c08e2fSMichael Klier    }else{
208413c08e2fSMichael Klier        if($tr < $fr){
2085d02ff930SChristopher Smith            $cw = (int) ($info[1]*$tr);
208613c08e2fSMichael Klier            $ch = $info[1];
208713c08e2fSMichael Klier        }else{
208813c08e2fSMichael Klier            $cw = $info[0];
2089d02ff930SChristopher Smith            $ch = (int) ($info[0]/$tr);
209013c08e2fSMichael Klier        }
209113c08e2fSMichael Klier    }
209213c08e2fSMichael Klier    // calculate crop offset
2093d02ff930SChristopher Smith    $cx = (int) (($info[0]-$cw)/2);
2094d02ff930SChristopher Smith    $cy = (int) (($info[1]-$ch)/3);
209513c08e2fSMichael Klier
209613c08e2fSMichael Klier    //cache
209713c08e2fSMichael Klier    $local = getCacheName($file,'.media.'.$cw.'x'.$ch.'.crop.'.$ext);
209813c08e2fSMichael Klier    $mtime = @filemtime($local); // 0 if not exists
209913c08e2fSMichael Klier
21002e0ce437SAndreas Gohr    if( $mtime > @filemtime($file) ||
210113c08e2fSMichael Klier            media_crop_imageIM($ext,$file,$info[0],$info[1],$local,$cw,$ch,$cx,$cy) ||
210213c08e2fSMichael Klier            media_resize_imageGD($ext,$file,$cw,$ch,$local,$cw,$ch,$cx,$cy) ){
21030e80bb5eSChristopher Smith        if(!empty($conf['fperm'])) @chmod($local, $conf['fperm']);
210413c08e2fSMichael Klier        return media_resize_image($local,$ext, $w, $h);
210513c08e2fSMichael Klier    }
210613c08e2fSMichael Klier
210713c08e2fSMichael Klier    //still here? cropping failed
210813c08e2fSMichael Klier    return media_resize_image($file,$ext, $w, $h);
210913c08e2fSMichael Klier}
211013c08e2fSMichael Klier
211113c08e2fSMichael Klier/**
21120f4e0092SChristopher Smith * Calculate a token to be used to verify fetch requests for resized or
21130f4e0092SChristopher Smith * cropped images have been internally generated - and prevent external
21140f4e0092SChristopher Smith * DDOS attacks via fetch
21150f4e0092SChristopher Smith *
21163c124064SAndreas Gohr * @author Christopher Smith <chris@jalakai.co.uk>
21173c124064SAndreas Gohr *
21180f4e0092SChristopher Smith * @param string  $id    id of the image
21190f4e0092SChristopher Smith * @param int     $w     resize/crop width
21200f4e0092SChristopher Smith * @param int     $h     resize/crop height
212142ea7f44SGerrit Uitslag * @return string token or empty string if no token required
21220f4e0092SChristopher Smith */
21230f4e0092SChristopher Smithfunction media_get_token($id,$w,$h){
21240f4e0092SChristopher Smith    // token is only required for modified images
2125cc036f74SKlap-in    if ($w || $h || media_isexternal($id)) {
21263c124064SAndreas Gohr        $token = $id;
21270f4e0092SChristopher Smith        if ($w) $token .= '.'.$w;
21280f4e0092SChristopher Smith        if ($h) $token .= '.'.$h;
21290f4e0092SChristopher Smith
21303c124064SAndreas Gohr        return substr(PassHash::hmac('md5', $token, auth_cookiesalt()),0,6);
21310f4e0092SChristopher Smith    }
21320f4e0092SChristopher Smith
21330f4e0092SChristopher Smith    return '';
21340f4e0092SChristopher Smith}
21350f4e0092SChristopher Smith
21360f4e0092SChristopher Smith/**
213713c08e2fSMichael Klier * Download a remote file and return local filename
213813c08e2fSMichael Klier *
213913c08e2fSMichael Klier * returns false if download fails. Uses cached file if available and
214013c08e2fSMichael Klier * wanted
214113c08e2fSMichael Klier *
214213c08e2fSMichael Klier * @author  Andreas Gohr <andi@splitbrain.org>
214313c08e2fSMichael Klier * @author  Pavel Vitis <Pavel.Vitis@seznam.cz>
214442ea7f44SGerrit Uitslag *
214542ea7f44SGerrit Uitslag * @param string $url
214642ea7f44SGerrit Uitslag * @param string $ext   extension
214742ea7f44SGerrit Uitslag * @param int    $cache cachetime in seconds
214842ea7f44SGerrit Uitslag * @return false|string path to cached file
214913c08e2fSMichael Klier */
215013c08e2fSMichael Klierfunction media_get_from_URL($url,$ext,$cache){
215113c08e2fSMichael Klier    global $conf;
215213c08e2fSMichael Klier
215313c08e2fSMichael Klier    // if no cache or fetchsize just redirect
215413c08e2fSMichael Klier    if ($cache==0)           return false;
215513c08e2fSMichael Klier    if (!$conf['fetchsize']) return false;
215613c08e2fSMichael Klier
215713c08e2fSMichael Klier    $local = getCacheName(strtolower($url),".media.$ext");
215813c08e2fSMichael Klier    $mtime = @filemtime($local); // 0 if not exists
215913c08e2fSMichael Klier
216013c08e2fSMichael Klier    //decide if download needed:
216113c08e2fSMichael Klier    if(($mtime == 0) || // cache does not exist
216213c08e2fSMichael Klier        ($cache != -1 && $mtime < time() - $cache) // 'recache' and cache has expired
216313c08e2fSMichael Klier    ) {
216413c08e2fSMichael Klier        if(media_image_download($url, $local)) {
216513c08e2fSMichael Klier            return $local;
216613c08e2fSMichael Klier        } else {
216713c08e2fSMichael Klier            return false;
216813c08e2fSMichael Klier        }
216913c08e2fSMichael Klier    }
217013c08e2fSMichael Klier
217113c08e2fSMichael Klier    //if cache exists use it else
217213c08e2fSMichael Klier    if($mtime) return $local;
217313c08e2fSMichael Klier
217413c08e2fSMichael Klier    //else return false
217513c08e2fSMichael Klier    return false;
217613c08e2fSMichael Klier}
217713c08e2fSMichael Klier
217813c08e2fSMichael Klier/**
217913c08e2fSMichael Klier * Download image files
218013c08e2fSMichael Klier *
218113c08e2fSMichael Klier * @author Andreas Gohr <andi@splitbrain.org>
218242ea7f44SGerrit Uitslag *
218342ea7f44SGerrit Uitslag * @param string $url
218442ea7f44SGerrit Uitslag * @param string $file path to file in which to put the downloaded content
218542ea7f44SGerrit Uitslag * @return bool
218613c08e2fSMichael Klier */
218713c08e2fSMichael Klierfunction media_image_download($url,$file){
218813c08e2fSMichael Klier    global $conf;
218913c08e2fSMichael Klier    $http = new DokuHTTPClient();
2190a5951419SAndreas Gohr    $http->keep_alive = false; // we do single ops here, no need for keep-alive
2191a5951419SAndreas Gohr
219213c08e2fSMichael Klier    $http->max_bodysize = $conf['fetchsize'];
219313c08e2fSMichael Klier    $http->timeout = 25; //max. 25 sec
219413c08e2fSMichael Klier    $http->header_regexp = '!\r\nContent-Type: image/(jpe?g|gif|png)!i';
219513c08e2fSMichael Klier
219613c08e2fSMichael Klier    $data = $http->get($url);
219713c08e2fSMichael Klier    if(!$data) return false;
219813c08e2fSMichael Klier
219979e79377SAndreas Gohr    $fileexists = file_exists($file);
220013c08e2fSMichael Klier    $fp = @fopen($file,"w");
220113c08e2fSMichael Klier    if(!$fp) return false;
220213c08e2fSMichael Klier    fwrite($fp,$data);
220313c08e2fSMichael Klier    fclose($fp);
220413c08e2fSMichael Klier    if(!$fileexists and $conf['fperm']) chmod($file, $conf['fperm']);
220513c08e2fSMichael Klier
220613c08e2fSMichael Klier    // check if it is really an image
220713c08e2fSMichael Klier    $info = @getimagesize($file);
220813c08e2fSMichael Klier    if(!$info){
220913c08e2fSMichael Klier        @unlink($file);
221013c08e2fSMichael Klier        return false;
221113c08e2fSMichael Klier    }
221213c08e2fSMichael Klier
221313c08e2fSMichael Klier    return true;
221413c08e2fSMichael Klier}
221513c08e2fSMichael Klier
221613c08e2fSMichael Klier/**
221713c08e2fSMichael Klier * resize images using external ImageMagick convert program
221813c08e2fSMichael Klier *
221913c08e2fSMichael Klier * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
222013c08e2fSMichael Klier * @author Andreas Gohr <andi@splitbrain.org>
222142ea7f44SGerrit Uitslag *
222242ea7f44SGerrit Uitslag * @param string $ext     extension
222342ea7f44SGerrit Uitslag * @param string $from    filename path to file
222442ea7f44SGerrit Uitslag * @param int    $from_w  original width
222542ea7f44SGerrit Uitslag * @param int    $from_h  original height
222642ea7f44SGerrit Uitslag * @param string $to      path to resized file
222742ea7f44SGerrit Uitslag * @param int    $to_w    desired width
222842ea7f44SGerrit Uitslag * @param int    $to_h    desired height
222942ea7f44SGerrit Uitslag * @return bool
223013c08e2fSMichael Klier */
223113c08e2fSMichael Klierfunction media_resize_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h){
223213c08e2fSMichael Klier    global $conf;
223313c08e2fSMichael Klier
223413c08e2fSMichael Klier    // check if convert is configured
223513c08e2fSMichael Klier    if(!$conf['im_convert']) return false;
223613c08e2fSMichael Klier
223713c08e2fSMichael Klier    // prepare command
223813c08e2fSMichael Klier    $cmd  = $conf['im_convert'];
223913c08e2fSMichael Klier    $cmd .= ' -resize '.$to_w.'x'.$to_h.'!';
224013c08e2fSMichael Klier    if ($ext == 'jpg' || $ext == 'jpeg') {
224113c08e2fSMichael Klier        $cmd .= ' -quality '.$conf['jpg_quality'];
224213c08e2fSMichael Klier    }
224313c08e2fSMichael Klier    $cmd .= " $from $to";
224413c08e2fSMichael Klier
224513c08e2fSMichael Klier    @exec($cmd,$out,$retval);
224613c08e2fSMichael Klier    if ($retval == 0) return true;
224713c08e2fSMichael Klier    return false;
224813c08e2fSMichael Klier}
224913c08e2fSMichael Klier
225013c08e2fSMichael Klier/**
225113c08e2fSMichael Klier * crop images using external ImageMagick convert program
225213c08e2fSMichael Klier *
225313c08e2fSMichael Klier * @author Andreas Gohr <andi@splitbrain.org>
225442ea7f44SGerrit Uitslag *
225542ea7f44SGerrit Uitslag * @param string $ext     extension
225642ea7f44SGerrit Uitslag * @param string $from    filename path to file
225742ea7f44SGerrit Uitslag * @param int    $from_w  original width
225842ea7f44SGerrit Uitslag * @param int    $from_h  original height
225942ea7f44SGerrit Uitslag * @param string $to      path to resized file
226042ea7f44SGerrit Uitslag * @param int    $to_w    desired width
226142ea7f44SGerrit Uitslag * @param int    $to_h    desired height
226242ea7f44SGerrit Uitslag * @param int    $ofs_x   offset of crop centre
226342ea7f44SGerrit Uitslag * @param int    $ofs_y   offset of crop centre
226442ea7f44SGerrit Uitslag * @return bool
226513c08e2fSMichael Klier */
226613c08e2fSMichael Klierfunction media_crop_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x,$ofs_y){
226713c08e2fSMichael Klier    global $conf;
226813c08e2fSMichael Klier
226913c08e2fSMichael Klier    // check if convert is configured
227013c08e2fSMichael Klier    if(!$conf['im_convert']) return false;
227113c08e2fSMichael Klier
227213c08e2fSMichael Klier    // prepare command
227313c08e2fSMichael Klier    $cmd  = $conf['im_convert'];
227413c08e2fSMichael Klier    $cmd .= ' -crop '.$to_w.'x'.$to_h.'+'.$ofs_x.'+'.$ofs_y;
227513c08e2fSMichael Klier    if ($ext == 'jpg' || $ext == 'jpeg') {
227613c08e2fSMichael Klier        $cmd .= ' -quality '.$conf['jpg_quality'];
227713c08e2fSMichael Klier    }
227813c08e2fSMichael Klier    $cmd .= " $from $to";
227913c08e2fSMichael Klier
228013c08e2fSMichael Klier    @exec($cmd,$out,$retval);
228113c08e2fSMichael Klier    if ($retval == 0) return true;
228213c08e2fSMichael Klier    return false;
228313c08e2fSMichael Klier}
228413c08e2fSMichael Klier
228513c08e2fSMichael Klier/**
228613c08e2fSMichael Klier * resize or crop images using PHP's libGD support
228713c08e2fSMichael Klier *
228813c08e2fSMichael Klier * @author Andreas Gohr <andi@splitbrain.org>
228913c08e2fSMichael Klier * @author Sebastian Wienecke <s_wienecke@web.de>
229042ea7f44SGerrit Uitslag *
229142ea7f44SGerrit Uitslag * @param string $ext     extension
229242ea7f44SGerrit Uitslag * @param string $from    filename path to file
229342ea7f44SGerrit Uitslag * @param int    $from_w  original width
229442ea7f44SGerrit Uitslag * @param int    $from_h  original height
229542ea7f44SGerrit Uitslag * @param string $to      path to resized file
229642ea7f44SGerrit Uitslag * @param int    $to_w    desired width
229742ea7f44SGerrit Uitslag * @param int    $to_h    desired height
229842ea7f44SGerrit Uitslag * @param int    $ofs_x   offset of crop centre
229942ea7f44SGerrit Uitslag * @param int    $ofs_y   offset of crop centre
230042ea7f44SGerrit Uitslag * @return bool
230113c08e2fSMichael Klier */
230213c08e2fSMichael Klierfunction media_resize_imageGD($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x=0,$ofs_y=0){
230313c08e2fSMichael Klier    global $conf;
230413c08e2fSMichael Klier
230513c08e2fSMichael Klier    if($conf['gdlib'] < 1) return false; //no GDlib available or wanted
230613c08e2fSMichael Klier
230713c08e2fSMichael Klier    // check available memory
230813c08e2fSMichael Klier    if(!is_mem_available(($from_w * $from_h * 4) + ($to_w * $to_h * 4))){
230913c08e2fSMichael Klier        return false;
231013c08e2fSMichael Klier    }
231113c08e2fSMichael Klier
231213c08e2fSMichael Klier    // create an image of the given filetype
231359bc3b48SGerrit Uitslag    $image = false;
231413c08e2fSMichael Klier    if ($ext == 'jpg' || $ext == 'jpeg'){
231513c08e2fSMichael Klier        if(!function_exists("imagecreatefromjpeg")) return false;
231613c08e2fSMichael Klier        $image = @imagecreatefromjpeg($from);
231713c08e2fSMichael Klier    }elseif($ext == 'png') {
231813c08e2fSMichael Klier        if(!function_exists("imagecreatefrompng")) return false;
231913c08e2fSMichael Klier        $image = @imagecreatefrompng($from);
232013c08e2fSMichael Klier
232113c08e2fSMichael Klier    }elseif($ext == 'gif') {
232213c08e2fSMichael Klier        if(!function_exists("imagecreatefromgif")) return false;
232313c08e2fSMichael Klier        $image = @imagecreatefromgif($from);
232413c08e2fSMichael Klier    }
232513c08e2fSMichael Klier    if(!$image) return false;
232613c08e2fSMichael Klier
232759bc3b48SGerrit Uitslag    $newimg = false;
232813c08e2fSMichael Klier    if(($conf['gdlib']>1) && function_exists("imagecreatetruecolor") && $ext != 'gif'){
232913c08e2fSMichael Klier        $newimg = @imagecreatetruecolor ($to_w, $to_h);
233013c08e2fSMichael Klier    }
233113c08e2fSMichael Klier    if(!$newimg) $newimg = @imagecreate($to_w, $to_h);
233213c08e2fSMichael Klier    if(!$newimg){
233313c08e2fSMichael Klier        imagedestroy($image);
233413c08e2fSMichael Klier        return false;
233513c08e2fSMichael Klier    }
233613c08e2fSMichael Klier
233713c08e2fSMichael Klier    //keep png alpha channel if possible
233813c08e2fSMichael Klier    if($ext == 'png' && $conf['gdlib']>1 && function_exists('imagesavealpha')){
233913c08e2fSMichael Klier        imagealphablending($newimg, false);
234013c08e2fSMichael Klier        imagesavealpha($newimg,true);
234113c08e2fSMichael Klier    }
234213c08e2fSMichael Klier
234313c08e2fSMichael Klier    //keep gif transparent color if possible
234413c08e2fSMichael Klier    if($ext == 'gif' && function_exists('imagefill') && function_exists('imagecolorallocate')) {
234513c08e2fSMichael Klier        if(function_exists('imagecolorsforindex') && function_exists('imagecolortransparent')) {
234613c08e2fSMichael Klier            $transcolorindex = @imagecolortransparent($image);
234713c08e2fSMichael Klier            if($transcolorindex >= 0 ) { //transparent color exists
234813c08e2fSMichael Klier                $transcolor = @imagecolorsforindex($image, $transcolorindex);
234913c08e2fSMichael Klier                $transcolorindex = @imagecolorallocate($newimg, $transcolor['red'], $transcolor['green'], $transcolor['blue']);
235013c08e2fSMichael Klier                @imagefill($newimg, 0, 0, $transcolorindex);
235113c08e2fSMichael Klier                @imagecolortransparent($newimg, $transcolorindex);
235213c08e2fSMichael Klier            }else{ //filling with white
235313c08e2fSMichael Klier                $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
235413c08e2fSMichael Klier                @imagefill($newimg, 0, 0, $whitecolorindex);
235513c08e2fSMichael Klier            }
235613c08e2fSMichael Klier        }else{ //filling with white
235713c08e2fSMichael Klier            $whitecolorindex = @imagecolorallocate($newimg, 255, 255, 255);
235813c08e2fSMichael Klier            @imagefill($newimg, 0, 0, $whitecolorindex);
235913c08e2fSMichael Klier        }
236013c08e2fSMichael Klier    }
236113c08e2fSMichael Klier
236213c08e2fSMichael Klier    //try resampling first
236313c08e2fSMichael Klier    if(function_exists("imagecopyresampled")){
236413c08e2fSMichael Klier        if(!@imagecopyresampled($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h)) {
236513c08e2fSMichael Klier            imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
236613c08e2fSMichael Klier        }
236713c08e2fSMichael Klier    }else{
236813c08e2fSMichael Klier        imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
236913c08e2fSMichael Klier    }
237013c08e2fSMichael Klier
237113c08e2fSMichael Klier    $okay = false;
237213c08e2fSMichael Klier    if ($ext == 'jpg' || $ext == 'jpeg'){
237313c08e2fSMichael Klier        if(!function_exists('imagejpeg')){
237413c08e2fSMichael Klier            $okay = false;
237513c08e2fSMichael Klier        }else{
237613c08e2fSMichael Klier            $okay = imagejpeg($newimg, $to, $conf['jpg_quality']);
237713c08e2fSMichael Klier        }
237813c08e2fSMichael Klier    }elseif($ext == 'png') {
237913c08e2fSMichael Klier        if(!function_exists('imagepng')){
238013c08e2fSMichael Klier            $okay = false;
238113c08e2fSMichael Klier        }else{
238213c08e2fSMichael Klier            $okay =  imagepng($newimg, $to);
238313c08e2fSMichael Klier        }
238413c08e2fSMichael Klier    }elseif($ext == 'gif') {
238513c08e2fSMichael Klier        if(!function_exists('imagegif')){
238613c08e2fSMichael Klier            $okay = false;
238713c08e2fSMichael Klier        }else{
238813c08e2fSMichael Klier            $okay = imagegif($newimg, $to);
238913c08e2fSMichael Klier        }
239013c08e2fSMichael Klier    }
239113c08e2fSMichael Klier
239213c08e2fSMichael Klier    // destroy GD image ressources
239313c08e2fSMichael Klier    if($image) imagedestroy($image);
239413c08e2fSMichael Klier    if($newimg) imagedestroy($newimg);
239513c08e2fSMichael Klier
239613c08e2fSMichael Klier    return $okay;
239713c08e2fSMichael Klier}
239813c08e2fSMichael Klier
23993d7a9e0aSAnika Henke/**
24003d7a9e0aSAnika Henke * Return other media files with the same base name
240179e53fe5SAnika Henke * but different extensions.
24023d7a9e0aSAnika Henke *
24033d7a9e0aSAnika Henke * @param string   $src     - ID of media file
240442ea7f44SGerrit Uitslag * @param string[] $exts    - alternative extensions to find other files for
240542ea7f44SGerrit Uitslag * @return array            - array(mime type => file ID)
24063d7a9e0aSAnika Henke *
24073d7a9e0aSAnika Henke * @author Anika Henke <anika@selfthinker.org>
24083d7a9e0aSAnika Henke */
240979e53fe5SAnika Henkefunction media_alternativefiles($src, $exts){
24103d7a9e0aSAnika Henke
24113d7a9e0aSAnika Henke    $files = array();
241259bc3b48SGerrit Uitslag    list($srcExt, /* $srcMime */) = mimetype($src);
24133d7a9e0aSAnika Henke    $filebase = substr($src, 0, -1 * (strlen($srcExt)+1));
24143d7a9e0aSAnika Henke
24153d7a9e0aSAnika Henke    foreach($exts as $ext) {
24163d7a9e0aSAnika Henke        $fileid = $filebase.'.'.$ext;
24173d7a9e0aSAnika Henke        $file = mediaFN($fileid);
24183d7a9e0aSAnika Henke        if(file_exists($file)) {
241959bc3b48SGerrit Uitslag            list(/* $fileExt */, $fileMime) = mimetype($file);
242079e53fe5SAnika Henke            $files[$fileMime] = $fileid;
242199f943f6SAnika Henke        }
24223d7a9e0aSAnika Henke    }
24233d7a9e0aSAnika Henke    return $files;
24243d7a9e0aSAnika Henke}
24253d7a9e0aSAnika Henke
2426f50634f0SAnika Henke/**
2427f50634f0SAnika Henke * Check if video/audio is supported to be embedded.
2428f50634f0SAnika Henke *
2429b83a74f1SAnika Henke * @param string $mime      - mimetype of media file
243042ea7f44SGerrit Uitslag * @param string $type      - type of media files to check ('video', 'audio', or null for all)
2431f50634f0SAnika Henke * @return boolean
2432f50634f0SAnika Henke *
2433f50634f0SAnika Henke * @author Anika Henke <anika@selfthinker.org>
2434f50634f0SAnika Henke */
2435f50634f0SAnika Henkefunction media_supportedav($mime, $type=NULL){
2436f50634f0SAnika Henke    $supportedAudio = array(
2437f50634f0SAnika Henke        'ogg' => 'audio/ogg',
2438f50634f0SAnika Henke        'mp3' => 'audio/mpeg',
2439f50634f0SAnika Henke        'wav' => 'audio/wav',
2440f50634f0SAnika Henke    );
2441f50634f0SAnika Henke    $supportedVideo = array(
2442f50634f0SAnika Henke        'webm' => 'video/webm',
2443f50634f0SAnika Henke        'ogv' => 'video/ogg',
2444f50634f0SAnika Henke        'mp4' => 'video/mp4',
2445f50634f0SAnika Henke    );
2446f50634f0SAnika Henke    if ($type == 'audio') {
2447f50634f0SAnika Henke        $supportedAv = $supportedAudio;
2448f50634f0SAnika Henke    } elseif ($type == 'video') {
2449f50634f0SAnika Henke        $supportedAv = $supportedVideo;
2450f50634f0SAnika Henke    } else {
2451f50634f0SAnika Henke        $supportedAv = array_merge($supportedAudio, $supportedVideo);
2452f50634f0SAnika Henke    }
2453f50634f0SAnika Henke    return in_array($mime, $supportedAv);
2454f50634f0SAnika Henke}
2455f50634f0SAnika Henke
2456*0877a1f1SSchplurtz le Déboulonné/**
2457*0877a1f1SSchplurtz le Déboulonné * Return track media files with the same base name
2458*0877a1f1SSchplurtz le Déboulonné * but extensions that indicate kind and lang.
2459*0877a1f1SSchplurtz le Déboulonné * ie for foo.webm search foo.sub.lang.vtt, foo.cap.lang.vtt...
2460*0877a1f1SSchplurtz le Déboulonné *
2461*0877a1f1SSchplurtz le Déboulonné * @param string   $src     - ID of media file
2462*0877a1f1SSchplurtz le Déboulonné * @return array            - array(mediaID => array( kind, srclang, lang ))
2463*0877a1f1SSchplurtz le Déboulonné *
2464*0877a1f1SSchplurtz le Déboulonné * @author Schplurtz le Déboulonné <Schplurtz@laposte.net>
2465*0877a1f1SSchplurtz le Déboulonné */
2466*0877a1f1SSchplurtz le Déboulonnéfunction media_trackfiles($src){
2467*0877a1f1SSchplurtz le Déboulonné    global $code2lang;
2468*0877a1f1SSchplurtz le Déboulonné    $kinds=array(
2469*0877a1f1SSchplurtz le Déboulonné        'sub' => 'subtitles',
2470*0877a1f1SSchplurtz le Déboulonné        'cap' => 'captions',
2471*0877a1f1SSchplurtz le Déboulonné        'des' => 'descriptions',
2472*0877a1f1SSchplurtz le Déboulonné        'cha' => 'chapters',
2473*0877a1f1SSchplurtz le Déboulonné        'met' => 'metadata'
2474*0877a1f1SSchplurtz le Déboulonné    );
2475*0877a1f1SSchplurtz le Déboulonné
2476*0877a1f1SSchplurtz le Déboulonné    $files = array();
2477*0877a1f1SSchplurtz le Déboulonné    $re='/\\.(sub|cap|des|cha|met)\\.([^.]+)\\.vtt$/';
2478*0877a1f1SSchplurtz le Déboulonné    $baseid=pathinfo($src, PATHINFO_FILENAME);
2479*0877a1f1SSchplurtz le Déboulonné    $pattern=mediaFN($baseid).'.*.*.vtt';
2480*0877a1f1SSchplurtz le Déboulonné    $list=glob($pattern);
2481*0877a1f1SSchplurtz le Déboulonné    foreach($list as $track) {
2482*0877a1f1SSchplurtz le Déboulonné        if(preg_match($re, $track, $matches)){
2483*0877a1f1SSchplurtz le Déboulonné            $files[$baseid.'.'.$matches[1].'.'.$matches[2].'.vtt']=array(
2484*0877a1f1SSchplurtz le Déboulonné                $kinds[$matches[1]],
2485*0877a1f1SSchplurtz le Déboulonné                $matches[2],
2486*0877a1f1SSchplurtz le Déboulonné                $code2lang[$matches[2]]
2487*0877a1f1SSchplurtz le Déboulonné            );
2488*0877a1f1SSchplurtz le Déboulonné        }
2489*0877a1f1SSchplurtz le Déboulonné    }
2490*0877a1f1SSchplurtz le Déboulonné    return $files;
2491*0877a1f1SSchplurtz le Déboulonné}
2492*0877a1f1SSchplurtz le Déboulonné
2493365be586SAndreas Gohr/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
2494