write.vorbiscomment.php 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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. /////////////////////////////////////////////////////////////////
  7. // See readme.txt for more details //
  8. /////////////////////////////////////////////////////////////////
  9. // //
  10. // write.vorbiscomment.php //
  11. // module for writing VorbisComment tags //
  12. // dependencies: /helperapps/vorbiscomment.exe //
  13. // ///
  14. /////////////////////////////////////////////////////////////////
  15. class getid3_write_vorbiscomment
  16. {
  17. var $filename;
  18. var $tag_data;
  19. var $warnings = array(); // any non-critical errors will be stored here
  20. var $errors = array(); // any critical errors will be stored here
  21. function getid3_write_vorbiscomment() {
  22. return true;
  23. }
  24. function WriteVorbisComment() {
  25. if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {
  26. $this->errors[] = 'PHP running in Safe Mode (backtick operator not available) - cannot call vorbiscomment, tags not written';
  27. return false;
  28. }
  29. // Create file with new comments
  30. $tempcommentsfilename = tempnam(GETID3_TEMP_DIR, 'getID3');
  31. if (is_writable($tempcommentsfilename) && is_file($tempcommentsfilename) && ($fpcomments = fopen($tempcommentsfilename, 'wb'))) {
  32. foreach ($this->tag_data as $key => $value) {
  33. foreach ($value as $commentdata) {
  34. fwrite($fpcomments, $this->CleanVorbisCommentName($key).'='.$commentdata."\n");
  35. }
  36. }
  37. fclose($fpcomments);
  38. } else {
  39. $this->errors[] = 'failed to open temporary tags file "'.$tempcommentsfilename.'", tags not written';
  40. return false;
  41. }
  42. $oldignoreuserabort = ignore_user_abort(true);
  43. if (GETID3_OS_ISWINDOWS) {
  44. if (file_exists(GETID3_HELPERAPPSDIR.'vorbiscomment.exe')) {
  45. //$commandline = '"'.GETID3_HELPERAPPSDIR.'vorbiscomment.exe" -w --raw -c "'.$tempcommentsfilename.'" "'.str_replace('/', '\\', $this->filename).'"';
  46. // vorbiscomment works fine if you copy-paste the above commandline into a command prompt,
  47. // but refuses to work with `backtick` if there are "doublequotes" present around BOTH
  48. // the metaflac pathname and the target filename. For whatever reason...??
  49. // The solution is simply ensure that the metaflac pathname has no spaces,
  50. // and therefore does not need to be quoted
  51. // On top of that, if error messages are not always captured properly under Windows
  52. // To at least see if there was a problem, compare file modification timestamps before and after writing
  53. clearstatcache();
  54. $timestampbeforewriting = filemtime($this->filename);
  55. $commandline = GETID3_HELPERAPPSDIR.'vorbiscomment.exe -w --raw -c "'.$tempcommentsfilename.'" "'.$this->filename.'" 2>&1';
  56. $VorbiscommentError = `$commandline`;
  57. if (empty($VorbiscommentError)) {
  58. clearstatcache();
  59. if ($timestampbeforewriting == filemtime($this->filename)) {
  60. $VorbiscommentError = 'File modification timestamp has not changed - it looks like the tags were not written';
  61. }
  62. }
  63. } else {
  64. $VorbiscommentError = 'vorbiscomment.exe not found in '.GETID3_HELPERAPPSDIR;
  65. }
  66. } else {
  67. $commandline = 'vorbiscomment -w --raw -c "'.$tempcommentsfilename.'" "'.$this->filename.'" 2>&1';
  68. $VorbiscommentError = `$commandline`;
  69. }
  70. // Remove temporary comments file
  71. unlink($tempcommentsfilename);
  72. ignore_user_abort($oldignoreuserabort);
  73. if (!empty($VorbiscommentError)) {
  74. $this->errors[] = 'system call to vorbiscomment failed with message: '."\n\n".$VorbiscommentError;
  75. return false;
  76. }
  77. return true;
  78. }
  79. function DeleteVorbisComment() {
  80. $this->tag_data = array(array());
  81. return $this->WriteVorbisComment();
  82. }
  83. function CleanVorbisCommentName($originalcommentname) {
  84. // A case-insensitive field name that may consist of ASCII 0x20 through 0x7D, 0x3D ('=') excluded.
  85. // ASCII 0x41 through 0x5A inclusive (A-Z) is to be considered equivalent to ASCII 0x61 through
  86. // 0x7A inclusive (a-z).
  87. // replace invalid chars with a space, return uppercase text
  88. // Thanks Chris Bolt <chris-getid3Øbolt*cx> for improving this function
  89. // note: *reg_replace() replaces nulls with empty string (not space)
  90. return strtoupper(preg_replace('#[^ -<>-}]#', ' ', str_replace("\x00", ' ', $originalcommentname)));
  91. }
  92. }
  93. ?>