www/plugins-dist/medias/lib/getid3/write.id3v1.php

   1 <?php
   2 /////////////////////////////////////////////////////////////////
   3 /// getID3() by James Heinrich <info@getid3.org>               //
   4 //  available at http://getid3.sourceforge.net                 //
   5 //            or http://www.getid3.org                         //
   6 //          also https://github.com/JamesHeinrich/getID3       //
   7 /////////////////////////////////////////////////////////////////
   8 // See readme.txt for more details                             //
   9 /////////////////////////////////////////////////////////////////
  10 //                                                             //
  11 // write.id3v1.php                                             //
  12 // module for writing ID3v1 tags                               //
  13 // dependencies: module.tag.id3v1.php                          //
  14 //                                                            ///
  15 /////////////////////////////////////////////////////////////////
  16
  17 getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.tag.id3v1.php', __FILE__, true);
  18
  19 class getid3_write_id3v1
  20 {
  21         public $filename;
  22         public $filesize;
  23         public $tag_data;
  24         public $warnings = array(); // any non-critical errors will be stored here
  25         public $errors   = array(); // any critical errors will be stored here
  26
  27         public function __construct() {
  28                 return true;
  29         }
  30
  31         public function WriteID3v1() {
  32                 // File MUST be writeable - CHMOD(646) at least
  33                 if (!empty($this->filename) && is_readable($this->filename) && is_writable($this->filename) && is_file($this->filename)) {
  34                         $this->setRealFileSize();
  35                         if (($this->filesize <= 0) || !getid3_lib::intValueSupported($this->filesize)) {
  36                                 $this->errors[] = 'Unable to WriteID3v1('.$this->filename.') because filesize ('.$this->filesize.') is larger than '.round(PHP_INT_MAX / 1073741824).'GB';
  37                                 return false;
  38                         }
  39                         if ($fp_source = fopen($this->filename, 'r+b')) {
  40                                 fseek($fp_source, -128, SEEK_END);
  41                                 if (fread($fp_source, 3) == 'TAG') {
  42                                         fseek($fp_source, -128, SEEK_END); // overwrite existing ID3v1 tag
  43                                 } else {
  44                                         fseek($fp_source, 0, SEEK_END);    // append new ID3v1 tag
  45                                 }
  46                                 $this->tag_data['track'] = (isset($this->tag_data['track']) ? $this->tag_data['track'] : (isset($this->tag_data['track_number']) ? $this->tag_data['track_number'] : (isset($this->tag_data['tracknumber']) ? $this->tag_data['tracknumber'] : '')));
  47
  48                                 $new_id3v1_tag_data = getid3_id3v1::GenerateID3v1Tag(
  49                                                                                                                 (isset($this->tag_data['title']  ) ? $this->tag_data['title']   : ''),
  50                                                                                                                 (isset($this->tag_data['artist'] ) ? $this->tag_data['artist']  : ''),
  51                                                                                                                 (isset($this->tag_data['album']  ) ? $this->tag_data['album']   : ''),
  52                                                                                                                 (isset($this->tag_data['year']   ) ? $this->tag_data['year']    : ''),
  53                                                                                                                 (isset($this->tag_data['genreid']) ? $this->tag_data['genreid'] : ''),
  54                                                                                                                 (isset($this->tag_data['comment']) ? $this->tag_data['comment'] : ''),
  55                                                                                                                 (isset($this->tag_data['track']  ) ? $this->tag_data['track']   : ''));
  56                                 fwrite($fp_source, $new_id3v1_tag_data, 128);
  57                                 fclose($fp_source);
  58                                 return true;
  59
  60                         } else {
  61                                 $this->errors[] = 'Could not fopen('.$this->filename.', "r+b")';
  62                                 return false;
  63                         }
  64                 }
  65                 $this->errors[] = 'File is not writeable: '.$this->filename;
  66                 return false;
  67         }
  68
  69         public function FixID3v1Padding() {
  70                 // ID3v1 data is supposed to be padded with NULL characters, but some taggers incorrectly use spaces
  71                 // This function rewrites the ID3v1 tag with correct padding
  72
  73                 // Initialize getID3 engine
  74                 $getID3 = new getID3;
  75                 $getID3->option_tag_id3v2  = false;
  76                 $getID3->option_tag_apetag = false;
  77                 $getID3->option_tags_html  = false;
  78                 $getID3->option_extra_info = false;
  79                 $getID3->option_tag_id3v1  = true;
  80                 $ThisFileInfo = $getID3->analyze($this->filename);
  81                 if (isset($ThisFileInfo['tags']['id3v1'])) {
  82                         foreach ($ThisFileInfo['tags']['id3v1'] as $key => $value) {
  83                                 $id3v1data[$key] = implode(',', $value);
  84                         }
  85                         $this->tag_data = $id3v1data;
  86                         return $this->WriteID3v1();
  87                 }
  88                 return false;
  89         }
  90
  91         public function RemoveID3v1() {
  92                 // File MUST be writeable - CHMOD(646) at least
  93                 if (!empty($this->filename) && is_readable($this->filename) && is_writable($this->filename) && is_file($this->filename)) {
  94                         $this->setRealFileSize();
  95                         if (($this->filesize <= 0) || !getid3_lib::intValueSupported($this->filesize)) {
  96                                 $this->errors[] = 'Unable to RemoveID3v1('.$this->filename.') because filesize ('.$this->filesize.') is larger than '.round(PHP_INT_MAX / 1073741824).'GB';
  97                                 return false;
  98                         }
  99                         if ($fp_source = fopen($this->filename, 'r+b')) {
 100
 101                                 fseek($fp_source, -128, SEEK_END);
 102                                 if (fread($fp_source, 3) == 'TAG') {
 103                                         ftruncate($fp_source, $this->filesize - 128);
 104                                 } else {
 105                                         // no ID3v1 tag to begin with - do nothing
 106                                 }
 107                                 fclose($fp_source);
 108                                 return true;
 109
 110                         } else {
 111                                 $this->errors[] = 'Could not fopen('.$this->filename.', "r+b")';
 112                         }
 113                 } else {
 114                         $this->errors[] = $this->filename.' is not writeable';
 115                 }
 116                 return false;
 117         }
 118
 119         public function setRealFileSize() {
 120                 if (PHP_INT_MAX > 2147483647) {
 121                         $this->filesize = filesize($this->filename);
 122                         return true;
 123                 }
 124                 // 32-bit PHP will not return correct values for filesize() if file is >=2GB
 125                 // but getID3->analyze() has workarounds to get actual filesize
 126                 $getID3 = new getID3;
 127                 $getID3->option_tag_id3v1  = false;
 128                 $getID3->option_tag_id3v2  = false;
 129                 $getID3->option_tag_apetag = false;
 130                 $getID3->option_tags_html  = false;
 131                 $getID3->option_extra_info = false;
 132                 $ThisFileInfo = $getID3->analyze($this->filename);
 133                 $this->filesize = $ThisFileInfo['filesize'];
 134                 return true;
 135         }
 136
 137 }