3 * All output and handler function needed for the media management popup
5 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author Andreas Gohr <andi@splitbrain.org>
9 if(!defined('DOKU_INC')) die('meh.');
10 if(!defined('NL')) define('NL',"\n");
11 require_once(DOKU_INC
.'inc/html.php');
12 require_once(DOKU_INC
.'inc/search.php');
13 require_once(DOKU_INC
.'inc/JpegMeta.php');
16 * Lists pages which currently use a media file selected for deletion
18 * References uses the same visual as search results and share
19 * their CSS tags except pagenames won't be links.
21 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
23 function media_filesinuse($data,$id){
25 echo '<h1>'.$lang['reference'].' <code>'.hsc(noNS($id)).'</code></h1>';
26 echo '<p>'.hsc($lang['ref_inuse']).'</p>';
28 $hidden=0; //count of hits without read permission
29 foreach($data as $row){
30 if(auth_quickaclcheck($row) >= AUTH_READ
&& isVisiblePage($row)){
31 echo '<div class="search_result">';
32 echo '<span class="mediaref_ref">'.hsc($row).'</span>';
38 print '<div class="mediaref_hidden">'.$lang['ref_hidden'].'</div>';
43 * Handles the saving of image meta data
45 * @author Andreas Gohr <andi@splitbrain.org>
47 function media_metasave($id,$auth,$data){
48 if($auth < AUTH_UPLOAD
) return false;
49 if(!checkSecurityToken()) return false;
54 $meta = new JpegMeta($src);
57 foreach($data as $key => $val){
60 $meta->deleteField($key);
62 $meta->setField($key,$val);
67 if($conf['fperm']) chmod($src, $conf['fperm']);
68 msg($lang['metasaveok'],1);
71 msg($lang['metasaveerr'],-1);
77 * Display the form to edit image meta data
79 * @author Andreas Gohr <andi@splitbrain.org>
81 function media_metaform($id,$auth){
82 if($auth < AUTH_UPLOAD
) return false;
83 global $lang, $config_cascade;
85 // load the field descriptions
86 static $fields = null;
89 foreach (array('default','local') as $config_group) {
90 if (empty($config_cascade['mediameta'][$config_group])) continue;
91 foreach ($config_cascade['mediameta'][$config_group] as $config_file) {
92 if(@file_exists
($config_file)){
93 include($config_file);
102 echo '<h1>'.hsc(noNS($id)).'</h1>'.NL
;
103 echo '<form action="'.DOKU_BASE
.'lib/exe/mediamanager.php" accept-charset="utf-8" method="post" class="meta">'.NL
;
105 foreach($fields as $key => $field){
107 $tags = array($field[0]);
108 if(is_array($field[3])) $tags = array_merge($tags,$field[3]);
109 $value = tpl_img_getTag($tags,'',$src);
110 $value = cleanText($value);
112 // prepare attributes
114 $p['class'] = 'edit';
115 $p['id'] = 'meta__'.$key;
116 $p['name'] = 'meta['.$field[0].']';
119 echo '<div class="metafield">';
120 echo '<label for="meta__'.$key.'">';
121 echo ($lang[$field[1]]) ?
$lang[$field[1]] : $field[1];
125 if($field[2] == 'text'){
126 $p['value'] = $value;
128 $att = buildAttributes($p);
129 echo "<input $att/>".NL
;
131 $att = buildAttributes($p);
132 echo "<textarea $att rows=\"6\" cols=\"50\">".formText($value).'</textarea>'.NL
;
136 echo '<div class="buttons">'.NL
;
137 echo '<input type="hidden" name="img" value="'.hsc($id).'" />'.NL
;
138 echo '<input name="do[save]" type="submit" value="'.$lang['btn_save'].
139 '" title="'.$lang['btn_save'].' [S]" accesskey="s" class="button" />'.NL
;
140 echo '<input name="do[cancel]" type="submit" value="'.$lang['btn_cancel'].
141 '" title="'.$lang['btn_cancel'].' [C]" accesskey="c" class="button" />'.NL
;
147 * Conveinience function to check if a media file is still in use
149 * @author Michael Klier <chi@chimeric.de>
151 function media_inuse($id) {
153 $mediareferences = array();
154 if($conf['refcheck']){
155 require_once(DOKU_INC
.'inc/fulltext.php');
156 $mediareferences = ft_mediause($id,$conf['refshow']);
157 if(!count($mediareferences)) {
160 return $mediareferences;
168 * Handles media file deletions
170 * If configured, checks for media references before deletion
172 * @author Andreas Gohr <andi@splitbrain.org>
173 * @return mixed false on error, true on delete or array with refs
175 function media_delete($id,$auth){
176 if($auth < AUTH_DELETE
) return false;
177 if(!checkSecurityToken()) return false;
181 $file = mediaFN($id);
183 // trigger an event - MEDIA_DELETE_FILE
185 $data['name'] = basename($file);
186 $data['path'] = $file;
187 $data['size'] = (@file_exists
($file)) ?
filesize($file) : 0;
189 $data['unl'] = false;
190 $data['del'] = false;
191 $evt = new Doku_Event('MEDIA_DELETE_FILE',$data);
192 if ($evt->advise_before()) {
193 $data['unl'] = @unlink
($file);
195 addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE
);
196 $data['del'] = io_sweepNS($id,'mediadir');
199 $evt->advise_after();
202 if($data['unl'] && $data['del']){
203 // current namespace was removed. redirecting to root ns passing msg along
204 send_redirect(DOKU_URL
.'lib/exe/mediamanager.php?msg1='.
205 rawurlencode(sprintf(noNS($id),$lang['deletesucc'])));
212 * Handles media file uploads
214 * This generates an action event and delegates to _media_upload_action().
215 * Action plugins are allowed to pre/postprocess the uploaded file.
216 * (The triggered event is preventable.)
219 * $data[0] fn_tmp: the temporary file name (read from $_FILES)
220 * $data[1] fn: the file name of the uploaded file
221 * $data[2] id: the future directory id of the uploaded file
222 * $data[3] imime: the mimetype of the uploaded file
223 * $data[4] overwrite: if an existing file is going to be overwritten
225 * @triggers MEDIA_UPLOAD_FINISH
226 * @author Andreas Gohr <andi@splitbrain.org>
227 * @author Michael Klier <chi@chimeric.de>
228 * @return mixed false on error, id of the new file on success
230 function media_upload($ns,$auth){
231 if($auth < AUTH_UPLOAD
) return false;
232 if(!checkSecurityToken()) return false;
233 require_once(DOKU_INC
.'inc/confutils.php');
239 $file = $_FILES['upload'];
240 if(empty($id)) $id = $file['name'];
243 if(!@filesize
($file['tmp_name'])){
244 msg('No data uploaded. Disk full?',-1);
249 list($fext,$fmime,$dl) = mimetype($file['name']);
250 list($iext,$imime,$dl) = mimetype($id);
252 // no extension specified in id - read original one
255 }elseif($fext && $fext != $iext){
256 // extension was changed, print warning
257 msg(sprintf($lang['mediaextchange'],$fext,$iext));
261 $id = cleanID($ns.':'.$id,false,true);
264 // get filetype regexp
265 $types = array_keys(getMimeTypes());
266 $types = array_map(create_function('$q','return preg_quote($q,"/");'),$types);
267 $regex = join('|',$types);
269 // because a temp file was created already
270 if(preg_match('/\.('.$regex.')$/i',$fn)){
271 //check for overwrite
272 $overwrite = @file_exists
($fn);
273 if($overwrite && (!$_REQUEST['ow'] ||
$auth < AUTH_DELETE
)){
274 msg($lang['uploadexist'],0);
277 // check for valid content
278 $ok = media_contentcheck($file['tmp_name'],$imime);
280 msg(sprintf($lang['uploadbadcontent'],".$iext"),-1);
283 msg($lang['uploadspam'],-1);
286 msg($lang['uploadxss'],-1);
290 // prepare event data
291 $data[0] = $file['tmp_name'];
295 $data[4] = $overwrite;
298 return trigger_event('MEDIA_UPLOAD_FINISH', $data, '_media_upload_action', true);
301 msg($lang['uploadwrong'],-1);
307 * Callback adapter for media_upload_finish()
308 * @author Michael Klier <chi@chimeric.de>
310 function _media_upload_action($data) {
311 // fixme do further sanity tests of given data?
312 if(is_array($data) && count($data)===5) {
313 return media_upload_finish($data[0], $data[1], $data[2], $data[3], $data[4]);
315 return false; //callback error
320 * Saves an uploaded media file
322 * @author Andreas Gohr <andi@splitbrain.org>
323 * @author Michael Klier <chi@chimeric.de>
325 function media_upload_finish($fn_tmp, $fn, $id, $imime, $overwrite) {
330 io_createNamespace($id, 'media');
332 if(move_uploaded_file($fn_tmp, $fn)) {
333 // Set the correct permission here.
334 // Always chmod media because they may be saved with different permissions than expected from the php umask.
335 // (Should normally chmod to $conf['fperm'] only if $conf['fperm'] is set.)
336 chmod($fn, $conf['fmode']);
337 msg($lang['uploadsucc'],1);
338 media_notify($id,$fn,$imime);
339 // add a log entry to the media changelog
341 addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_EDIT
);
343 addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_CREATE
);
347 msg($lang['uploadfail'],-1);
352 * This function checks if the uploaded content is really what the
353 * mimetype says it is. We also do spam checking for text types here.
355 * We need to do this stuff because we can not rely on the browser
356 * to do this check correctly. Yes, IE is broken as usual.
358 * @author Andreas Gohr <andi@splitbrain.org>
359 * @link http://www.splitbrain.org/blog/2007-02/12-internet_explorer_facilitates_cross_site_scripting
360 * @fixme check all 26 magic IE filetypes here?
362 function media_contentcheck($file,$mime){
364 if($conf['iexssprotect']){
365 $fh = @fopen
($file, 'rb');
367 $bytes = fread($fh, 256);
369 if(preg_match('/<(script|a|img|html|body|iframe)[\s>]/i',$bytes)){
374 if(substr($mime,0,6) == 'image/'){
375 $info = @getimagesize
($file);
376 if($mime == 'image/gif' && $info[2] != 1){
378 }elseif($mime == 'image/jpeg' && $info[2] != 2){
380 }elseif($mime == 'image/png' && $info[2] != 3){
383 # fixme maybe check other images types as well
384 }elseif(substr($mime,0,5) == 'text/'){
386 $TEXT = io_readFile($file);
387 if(checkwordblock()){
395 * Send a notify mail on uploads
397 * @author Andreas Gohr <andi@splitbrain.org>
399 function media_notify($id,$file,$mime){
402 if(empty($conf['notify'])) return; //notify enabled?
406 $text = rawLocale('uploadmail');
407 $text = str_replace('@DATE@',strftime($conf['dformat']),$text);
408 $text = str_replace('@BROWSER@',$_SERVER['HTTP_USER_AGENT'],$text);
409 $text = str_replace('@IPADDRESS@',$ip,$text);
410 $text = str_replace('@HOSTNAME@',gethostsbyaddrs($ip),$text);
411 $text = str_replace('@DOKUWIKIURL@',DOKU_URL
,$text);
412 $text = str_replace('@USER@',$_SERVER['REMOTE_USER'],$text);
413 $text = str_replace('@MIME@',$mime,$text);
414 $text = str_replace('@MEDIA@',ml($id,'',true,'&',true),$text);
415 $text = str_replace('@SIZE@',filesize_h(filesize($file)),$text);
417 $from = $conf['mailfrom'];
418 $from = str_replace('@USER@',$_SERVER['REMOTE_USER'],$from);
419 $from = str_replace('@NAME@',$INFO['userinfo']['name'],$from);
420 $from = str_replace('@MAIL@',$INFO['userinfo']['mail'],$from);
422 $subject = '['.$conf['title'].'] '.$lang['mail_upload'].' '.$id;
424 mail_send($conf['notify'],$subject,$text,$from);
428 * List all files in a given Media namespace
430 function media_filelist($ns,$auth=null,$jump=''){
435 // check auth our self if not given (needed for ajax calls)
436 if(is_null($auth)) $auth = auth_quickaclcheck("$ns:*");
438 echo '<h1 id="media__ns">:'.hsc($ns).'</h1>'.NL
;
440 if($auth < AUTH_READ
){
441 // FIXME: print permission warning here instead?
442 echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL
;
446 media_uploadform($ns, $auth);
448 $dir = utf8_encodeFN(str_replace(':','/',$ns));
450 search($data,$conf['mediadir'],'search_media',
451 array('showmsg'=>true,'depth'=>1),$dir);
454 echo '<div class="nothing">'.$lang['nothingfound'].'</div>'.NL
;
458 foreach($data as $item){
459 media_printfile($item,$auth,$jump);
464 * Print action links for a file depending on filetype
465 * and available permissions
467 * @todo contains inline javascript
469 function media_fileactions($item,$auth){
473 $link = ml($item['id'],'',true);
474 echo ' <a href="'.$link.'" target="_blank"><img src="'.DOKU_BASE
.'lib/images/magnifier.png" '.
475 'alt="'.$lang['mediaview'].'" title="'.$lang['mediaview'].'" class="btn" /></a>';
478 // no further actions if not writable
479 if(!$item['writable']) return;
482 if($auth >= AUTH_DELETE
){
483 echo ' <a href="'.DOKU_BASE
.'lib/exe/mediamanager.php?delete='.rawurlencode($item['id']).
484 '&sectok='.getSecurityToken().'" class="btn_media_delete" title="'.$item['id'].'">'.
485 '<img src="'.DOKU_BASE
.'lib/images/trash.png" alt="'.$lang['btn_delete'].'" '.
486 'title="'.$lang['btn_delete'].'" class="btn" /></a>';
490 if($auth >= AUTH_UPLOAD
&& $item['isimg'] && $item['meta']->getField('File.Mime') == 'image/jpeg'){
491 echo ' <a href="'.DOKU_BASE
.'lib/exe/mediamanager.php?edit='.rawurlencode($item['id']).'">'.
492 '<img src="'.DOKU_BASE
.'lib/images/pencil.png" alt="'.$lang['metaedit'].'" '.
493 'title="'.$lang['metaedit'].'" class="btn" /></a>';
499 * Formats and prints one file in the list
501 function media_printfile($item,$auth,$jump){
505 // Prepare zebra coloring
506 // I always wanted to use this variable name :-D
509 $zebra = ($twibble == -1) ?
'odd' : 'even';
511 // Automatically jump to recent action
512 if($jump == $item['id']) {
513 $jump = ' id="scroll__here" ';
519 list($ext,$mime,$dl) = mimetype($item['file']);
520 $class = preg_replace('/[^_\-a-z0-9]+/i','_',$ext);
521 $class = 'select mediafile mf_'.$class;
524 $file = utf8_decodeFN($item['file']);
529 $info .= (int) $item['meta']->getField('File.Width');
531 $info .= (int) $item['meta']->getField('File.Height');
534 $info .= '<i>'.strftime($conf['dformat'],$item['mtime']).'</i>';
536 $info .= filesize_h($item['size']);
539 echo '<div class="'.$zebra.'"'.$jump.'>'.NL
;
540 echo '<a name="h_'.$item['id'].'" class="'.$class.'">'.$file.'</a> ';
541 echo '<span class="info">('.$info.')</span>'.NL
;
542 media_fileactions($item,$auth);
543 echo '<div class="example" id="ex_'.str_replace(':','_',$item['id']).'">';
544 echo $lang['mediausage'].' <code>{{:'.$item['id'].'}}</code>';
546 if($item['isimg']) media_printimgdetail($item);
547 echo '<div class="clearer"></div>'.NL
;
552 * Prints a thumbnail and metainfos
554 function media_printimgdetail($item){
556 $w = (int) $item['meta']->getField('File.Width');
557 $h = (int) $item['meta']->getField('File.Height');
558 if($w>120 ||
$h>120){
559 $ratio = $item['meta']->getResizeRatio(120);
560 $w = floor($w * $ratio);
561 $h = floor($h * $ratio);
563 $src = ml($item['id'],array('w'=>$w,'h'=>$h));
567 $p['alt'] = $item['id'];
568 $p['class'] = 'thumb';
569 $att = buildAttributes($p);
572 echo '<div class="detail">';
573 echo '<div class="thumb">';
574 echo '<a name="d_'.$item['id'].'" class="select">';
575 echo '<img src="'.$src.'" '.$att.' />';
579 // read EXIF/IPTC data
580 $t = $item['meta']->getField(array('IPTC.Headline','xmp.dc:title'));
581 $d = $item['meta']->getField(array('IPTC.Caption','EXIF.UserComment',
582 'EXIF.TIFFImageDescription',
583 'EXIF.TIFFUserComment'));
584 if(utf8_strlen($d) > 250) $d = utf8_substr($d,0,250).'...';
585 $k = $item['meta']->getField(array('IPTC.Keywords','IPTC.Category','xmp.dc:subject'));
587 // print EXIF/IPTC data
590 if($t) echo '<strong>'.htmlspecialchars($t).'</strong><br />';
591 if($d) echo htmlspecialchars($d).'<br />';
592 if($t) echo '<em>'.htmlspecialchars($k).'</em>';
599 * Print the media upload form if permissions are correct
601 * @author Andreas Gohr <andi@splitbrain.org>
603 function media_uploadform($ns, $auth){
606 if($auth < AUTH_UPLOAD
) return; //fixme print info on missing permissions?
608 // The default HTML upload form
609 $form = new Doku_Form('dw__upload', DOKU_BASE
.'lib/exe/mediamanager.php', false, 'multipart/form-data');
610 $form->addElement('<div class="upload">' . $lang['mediaupload'] . '</div>');
611 $form->addElement(formSecurityToken());
612 $form->addHidden('ns', hsc($ns));
613 $form->addElement(form_makeOpenTag('p'));
614 $form->addElement(form_makeFileField('upload', $lang['txt_upload'].':', 'upload__file'));
615 $form->addElement(form_makeCloseTag('p'));
616 $form->addElement(form_makeOpenTag('p'));
617 $form->addElement(form_makeTextField('id', '', $lang['txt_filename'].':', 'upload__name'));
618 $form->addElement(form_makeButton('submit', '', $lang['btn_upload']));
619 $form->addElement(form_makeCloseTag('p'));
621 if($auth >= AUTH_DELETE
){
622 $form->addElement(form_makeOpenTag('p'));
623 $form->addElement(form_makeCheckboxField('ow', 1, $lang['txt_overwrt'], 'dw__ow', 'check'));
624 $form->addElement(form_makeCloseTag('p'));
626 html_form('upload', $form);
628 // prepare flashvars for multiupload
630 'L_gridname' => $lang['mu_gridname'] ,
631 'L_gridsize' => $lang['mu_gridsize'] ,
632 'L_gridstat' => $lang['mu_gridstat'] ,
633 'L_namespace' => $lang['mu_namespace'] ,
634 'L_overwrite' => $lang['txt_overwrt'],
635 'L_browse' => $lang['mu_browse'],
636 'L_upload' => $lang['btn_upload'],
637 'L_toobig' => $lang['mu_toobig'],
638 'L_ready' => $lang['mu_ready'],
639 'L_done' => $lang['mu_done'],
640 'L_fail' => $lang['mu_fail'],
641 'L_authfail' => $lang['mu_authfail'],
642 'L_progress' => $lang['mu_progress'],
643 'L_filetypes' => $lang['mu_filetypes'],
644 'L_info' => $lang['mu_info'],
645 'L_lasterr' => $lang['mu_lasterr'],
648 'O_backend' => 'mediamanager.php?'.session_name().'='.session_id(),
649 'O_maxsize' => php_to_byte(ini_get('upload_max_filesize')),
650 'O_extensions'=> join('|',array_keys(getMimeTypes())),
651 'O_overwrite' => ($auth >= AUTH_DELETE
),
652 'O_sectok' => getSecurityToken(),
653 'O_authtok' => auth_createToken(),
655 $var = buildURLparams($opt);
656 // output the flash uploader
658 <div id
="dw__flashupload" style
="display:none">
659 <div
class="upload"><?php
echo $lang['mu_intro']?
></div
>
660 <?php
echo html_flashobject('multipleUpload.swf','500','190',null,$opt); ?
>
666 * Build a tree outline of available media namespaces
668 * @author Andreas Gohr <andi@splitbrain.org>
670 function media_nstree($ns){
674 // currently selected namespace
677 $ns = dirname(str_replace(':','/',$ID));
678 if($ns == '.') $ns ='';
680 $ns = utf8_encodeFN(str_replace(':','/',$ns));
683 search($data,$conf['mediadir'],'search_index',array('ns' => $ns, 'nofiles' => true));
685 // wrap a list with the root level around the other namespaces
686 $item = array( 'level' => 0, 'id' => '',
687 'open' =>'true', 'label' => '['.$lang['mediaroot'].']');
689 echo '<ul class="idx">';
690 echo media_nstree_li($item);
691 echo media_nstree_item($item);
692 echo html_buildlist($data,'idx','media_nstree_item','media_nstree_li');
698 * Userfunction for html_buildlist
700 * Prints a media namespace tree item
702 * @author Andreas Gohr <andi@splitbrain.org>
704 function media_nstree_item($item){
705 $pos = strrpos($item['id'], ':');
706 $label = substr($item['id'], $pos > 0 ?
$pos +
1 : 0);
707 if(!$item['label']) $item['label'] = $label;
710 $ret .= '<a href="'.DOKU_BASE
.'lib/exe/mediamanager.php?ns='.idfilter($item['id']).'" class="idx_dir">';
711 $ret .= $item['label'];
717 * Userfunction for html_buildlist
719 * Prints a media namespace tree item opener
721 * @author Andreas Gohr <andi@splitbrain.org>
723 function media_nstree_li($item){
724 $class='media level'.$item['level'];
727 $img = DOKU_BASE
.'lib/images/minus.gif';
731 $img = DOKU_BASE
.'lib/images/plus.gif';
734 return '<li class="'.$class.'">'.
735 '<img src="'.$img.'" alt="'.$alt.'" />';
739 * Resizes the given image to the given size
741 * @author Andreas Gohr <andi@splitbrain.org>
743 function media_resize_image($file, $ext, $w, $h=0){
746 $info = @getimagesize
($file); //get original size
747 if($info == false) return $file; // that's no image - it's a spaceship!
749 if(!$h) $h = round(($w * $info[1]) / $info[0]);
751 // we wont scale up to infinity
752 if($w > 2000 ||
$h > 2000) return $file;
755 $local = getCacheName($file,'.media.'.$w.'x'.$h.'.'.$ext);
756 $mtime = @filemtime
($local); // 0 if not exists
758 if( $mtime > filemtime($file) ||
759 media_resize_imageIM($ext,$file,$info[0],$info[1],$local,$w,$h) ||
760 media_resize_imageGD($ext,$file,$info[0],$info[1],$local,$w,$h) ){
761 if($conf['fperm']) chmod($local, $conf['fperm']);
764 //still here? resizing failed
769 * Crops the given image to the wanted ratio, then calls media_resize_image to scale it
772 * Crops are centered horizontally but prefer the upper third of an vertical
773 * image because most pics are more interesting in that area (rule of thirds)
775 * @author Andreas Gohr <andi@splitbrain.org>
777 function media_crop_image($file, $ext, $w, $h=0){
781 $info = @getimagesize
($file); //get original size
782 if($info == false) return $file; // that's no image - it's a spaceship!
784 // calculate crop size
785 $fr = $info[0]/$info[1];
790 $ch = (int) $info[0]/$tr;
792 $cw = (int) $info[1]*$tr;
797 $cw = (int) $info[1]*$tr;
801 $ch = (int) $info[0]/$tr;
804 // calculate crop offset
805 $cx = (int) ($info[0]-$cw)/2;
806 $cy = (int) ($info[1]-$ch)/3;
809 $local = getCacheName($file,'.media.'.$cw.'x'.$ch.'.crop.'.$ext);
810 $mtime = @filemtime
($local); // 0 if not exists
812 if( $mtime > filemtime($file) ||
813 media_crop_imageIM($ext,$file,$info[0],$info[1],$local,$cw,$ch,$cx,$cy) ||
814 media_resize_imageGD($ext,$file,$cw,$ch,$local,$cw,$ch,$cx,$cy) ){
815 if($conf['fperm']) chmod($local, $conf['fperm']);
816 return media_resize_image($local,$ext, $w, $h);
819 //still here? cropping failed
820 return media_resize_image($file,$ext, $w, $h);
824 * Download a remote file and return local filename
826 * returns false if download fails. Uses cached file if available and
829 * @author Andreas Gohr <andi@splitbrain.org>
830 * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
832 function media_get_from_URL($url,$ext,$cache){
835 // if no cache or fetchsize just redirect
836 if ($cache==0) return false;
837 if (!$conf['fetchsize']) return false;
839 $local = getCacheName(strtolower($url),".media.$ext");
840 $mtime = @filemtime
($local); // 0 if not exists
842 //decide if download needed:
843 if( ($mtime == 0) ||
// cache does not exist
844 ($cache != -1 && $mtime < time()-$cache) // 'recache' and cache has expired
846 if(media_image_download($url,$local)){
853 //if cache exists use it else
854 if($mtime) return $local;
861 * Download image files
863 * @author Andreas Gohr <andi@splitbrain.org>
865 function media_image_download($url,$file){
867 $http = new DokuHTTPClient();
868 $http->max_bodysize
= $conf['fetchsize'];
869 $http->timeout
= 25; //max. 25 sec
870 $http->header_regexp
= '!\r\nContent-Type: image/(jpe?g|gif|png)!i';
872 $data = $http->get($url);
873 if(!$data) return false;
875 $fileexists = @file_exists
($file);
876 $fp = @fopen
($file,"w");
877 if(!$fp) return false;
880 if(!$fileexists and $conf['fperm']) chmod($file, $conf['fperm']);
882 // check if it is really an image
883 $info = @getimagesize
($file);
893 * resize images using external ImageMagick convert program
895 * @author Pavel Vitis <Pavel.Vitis@seznam.cz>
896 * @author Andreas Gohr <andi@splitbrain.org>
898 function media_resize_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h){
901 // check if convert is configured
902 if(!$conf['im_convert']) return false;
905 $cmd = $conf['im_convert'];
906 $cmd .= ' -resize '.$to_w.'x'.$to_h.'!';
907 if ($ext == 'jpg' ||
$ext == 'jpeg') {
908 $cmd .= ' -quality '.$conf['jpg_quality'];
910 $cmd .= " $from $to";
912 @exec
($cmd,$out,$retval);
913 if ($retval == 0) return true;
918 * crop images using external ImageMagick convert program
920 * @author Andreas Gohr <andi@splitbrain.org>
922 function media_crop_imageIM($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x,$ofs_y){
925 // check if convert is configured
926 if(!$conf['im_convert']) return false;
929 $cmd = $conf['im_convert'];
930 $cmd .= ' -crop '.$to_w.'x'.$to_h.'+'.$ofs_x.'+'.$ofs_y;
931 if ($ext == 'jpg' ||
$ext == 'jpeg') {
932 $cmd .= ' -quality '.$conf['jpg_quality'];
934 $cmd .= " $from $to";
936 @exec
($cmd,$out,$retval);
937 if ($retval == 0) return true;
942 * resize or crop images using PHP's libGD support
944 * @author Andreas Gohr <andi@splitbrain.org>
945 * @author Sebastian Wienecke <s_wienecke@web.de>
947 function media_resize_imageGD($ext,$from,$from_w,$from_h,$to,$to_w,$to_h,$ofs_x=0,$ofs_y=0){
950 if($conf['gdlib'] < 1) return false; //no GDlib available or wanted
952 // check available memory
953 if(!is_mem_available(($from_w * $from_h * 4) +
($to_w * $to_h * 4))){
957 // create an image of the given filetype
958 if ($ext == 'jpg' ||
$ext == 'jpeg'){
959 if(!function_exists("imagecreatefromjpeg")) return false;
960 $image = @imagecreatefromjpeg
($from);
961 }elseif($ext == 'png') {
962 if(!function_exists("imagecreatefrompng")) return false;
963 $image = @imagecreatefrompng
($from);
965 }elseif($ext == 'gif') {
966 if(!function_exists("imagecreatefromgif")) return false;
967 $image = @imagecreatefromgif
($from);
969 if(!$image) return false;
971 if(($conf['gdlib']>1) && function_exists("imagecreatetruecolor") && $ext != 'gif'){
972 $newimg = @imagecreatetruecolor
($to_w, $to_h);
974 if(!$newimg) $newimg = @imagecreate
($to_w, $to_h);
976 imagedestroy($image);
980 //keep png alpha channel if possible
981 if($ext == 'png' && $conf['gdlib']>1 && function_exists('imagesavealpha')){
982 imagealphablending($newimg, false);
983 imagesavealpha($newimg,true);
986 //keep gif transparent color if possible
987 if($ext == 'gif' && function_exists('imagefill') && function_exists('imagecolorallocate')) {
988 if(function_exists('imagecolorsforindex') && function_exists('imagecolortransparent')) {
989 $transcolorindex = @imagecolortransparent
($image);
990 if($transcolorindex >= 0 ) { //transparent color exists
991 $transcolor = @imagecolorsforindex
($image, $transcolorindex);
992 $transcolorindex = @imagecolorallocate
($newimg, $transcolor['red'], $transcolor['green'], $transcolor['blue']);
993 @imagefill
($newimg, 0, 0, $transcolorindex);
994 @imagecolortransparent
($newimg, $transcolorindex);
995 }else{ //filling with white
996 $whitecolorindex = @imagecolorallocate
($newimg, 255, 255, 255);
997 @imagefill
($newimg, 0, 0, $whitecolorindex);
999 }else{ //filling with white
1000 $whitecolorindex = @imagecolorallocate
($newimg, 255, 255, 255);
1001 @imagefill
($newimg, 0, 0, $whitecolorindex);
1005 //try resampling first
1006 if(function_exists("imagecopyresampled")){
1007 if(!@imagecopyresampled
($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h)) {
1008 imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1011 imagecopyresized($newimg, $image, 0, 0, $ofs_x, $ofs_y, $to_w, $to_h, $from_w, $from_h);
1015 if ($ext == 'jpg' ||
$ext == 'jpeg'){
1016 if(!function_exists('imagejpeg')){
1019 $okay = imagejpeg($newimg, $to, $conf['jpg_quality']);
1021 }elseif($ext == 'png') {
1022 if(!function_exists('imagepng')){
1025 $okay = imagepng($newimg, $to);
1027 }elseif($ext == 'gif') {
1028 if(!function_exists('imagegif')){
1031 $okay = imagegif($newimg, $to);
1035 // destroy GD image ressources
1036 if($image) imagedestroy($image);
1037 if($newimg) imagedestroy($newimg);
1042 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */