src/meta/file/File.cpp

   1 /*
   2    Copyright (C) 2007 Maximilian Kossick <maximilian.kossick@googlemail.com>
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public License
   6    as published by the Free Software Foundation; either version 2
   7    of the License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  17 */
  18
  19 #include "File.h"
  20 #include "File_p.h"
  21
  22 #include "debug.h"
  23 #include "Meta.h"
  24 #include "meta/EditCapability.h"
  25 #include "MetaUtility.h"
  26
  27 #include <QFile>
  28 #include <QPointer>
  29 #include <QString>
  30
  31 #include <kfilemetainfo.h>
  32 #include <kfilemetainfoitem.h>
  33
  34 using namespace MetaFile;
  35
  36 class EditCapabilityImpl : public Meta::EditCapability
  37 {
  38     Q_OBJECT
  39     public:
  40         EditCapabilityImpl( MetaFile::Track *track )
  41     : Meta::EditCapability()
  42                 , m_track( track ) {}
  43
  44         virtual bool isEditable() const { return m_track->isEditable(); }
  45         virtual void setAlbum( const QString &newAlbum ) { m_track->setAlbum( newAlbum ); }
  46         virtual void setArtist( const QString &newArtist ) { m_track->setArtist( newArtist ); }
  47         virtual void setComposer( const QString &newComposer ) { m_track->setComposer( newComposer ); }
  48         virtual void setGenre( const QString &newGenre ) { m_track->setGenre( newGenre ); }
  49         virtual void setYear( const QString &newYear ) { m_track->setYear( newYear ); }
  50         virtual void setTitle( const QString &newTitle ) { m_track->setTitle( newTitle ); }
  51         virtual void setComment( const QString &newComment ) { m_track->setComment( newComment ); }
  52         virtual void setTrackNumber( int newTrackNumber ) { m_track->setTrackNumber( newTrackNumber ); }
  53         virtual void setDiscNumber( int newDiscNumber ) { m_track->setDiscNumber( newDiscNumber ); }
  54         virtual void beginMetaDataUpdate() { m_track->beginMetaDataUpdate(); }
  55         virtual void endMetaDataUpdate() { m_track->endMetaDataUpdate(); }
  56         virtual void abortMetaDataUpdate() { m_track->abortMetaDataUpdate(); }
  57
  58     private:
  59         KSharedPtr<MetaFile::Track> m_track;
  60 };
  61
  62 Track::Track( const KUrl &url )
  63     : Meta::Track()
  64     , d( new Track::Private( this ) )
  65 {
  66     d->url = url;
  67     d->metaInfo = KFileMetaInfo( url.path() );
  68     d->album = Meta::AlbumPtr( new MetaFile::FileAlbum( QPointer<MetaFile::Track::Private>( d ) ) );
  69     d->artist = Meta::ArtistPtr( new MetaFile::FileArtist( QPointer<MetaFile::Track::Private>( d ) ) );
  70     d->genre = Meta::GenrePtr( new MetaFile::FileGenre( QPointer<MetaFile::Track::Private>( d ) ) );
  71     d->composer = Meta::ComposerPtr( new MetaFile::FileComposer( QPointer<MetaFile::Track::Private>( d ) ) );
  72     d->year = Meta::YearPtr( new MetaFile::FileYear( QPointer<MetaFile::Track::Private>( d ) ) );
  73 }
  74
  75 Track::~Track()
  76 {
  77     delete d;
  78 }
  79
  80 QString
  81 Track::name() const
  82 {
  83     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::TITLE ) );
  84     if( item.isValid() )
  85         return item.value().toString();
  86     else
  87         return QString();
  88 }
  89
  90 QString
  91 Track::prettyName() const
  92 {
  93     return name();
  94 }
  95
  96 QString
  97 Track::fullPrettyName() const
  98 {
  99     return name();
 100 }
 101
 102 QString
 103 Track::sortableName() const
 104 {
 105     return name();
 106 }
 107
 108
 109 KUrl
 110 Track::playableUrl() const
 111 {
 112     return d->url;
 113 }
 114
 115 QString
 116 Track::prettyUrl() const
 117 {
 118     return d->url.path();
 119 }
 120
 121 QString
 122 Track::url() const
 123 {
 124     return d->url.url();
 125 }
 126
 127 bool
 128 Track::isPlayable() const
 129 {
 130     //simple implementation, check internet connectivity or ping server?
 131     return true;
 132 }
 133
 134 bool
 135 Track::isEditable() const
 136 {
 137     //not this probably needs more work on *nix
 138     return QFile::permissions( d->url.path() ) & QFile::WriteUser;
 139 }
 140
 141 Meta::AlbumPtr
 142 Track::album() const
 143 {
 144     return d->album;
 145 }
 146
 147 Meta::ArtistPtr
 148 Track::artist() const
 149 {
 150     return d->artist;
 151 }
 152
 153 Meta::GenrePtr
 154 Track::genre() const
 155 {
 156     return d->genre;
 157 }
 158
 159 Meta::ComposerPtr
 160 Track::composer() const
 161 {
 162     return d->composer;
 163 }
 164
 165 Meta::YearPtr
 166 Track::year() const
 167 {
 168     return d->year;
 169 }
 170
 171 void
 172 Track::setAlbum( const QString &newAlbum )
 173 {
 174     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::ALBUM ) ).setValue( newAlbum );
 175     if( !d->batchUpdate )
 176     {
 177         d->metaInfo.applyChanges();
 178         notifyObservers();
 179     }
 180 }
 181
 182 void
 183 Track::setArtist( const QString& newArtist )
 184 {
 185     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::ARTIST ) ).setValue( newArtist );
 186     if( !d->batchUpdate )
 187     {
 188         d->metaInfo.applyChanges();
 189         notifyObservers();
 190     }
 191 }
 192
 193 void
 194 Track::setGenre( const QString& newGenre )
 195 {
 196     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::GENRE ) ).setValue( newGenre );
 197     if( !d->batchUpdate )
 198     {
 199         d->metaInfo.applyChanges();
 200         notifyObservers();
 201     }
 202 }
 203
 204 void
 205 Track::setComposer( const QString& newComposer )
 206 {
 207     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::COMPOSER ) ).setValue( newComposer );
 208     if( !d->batchUpdate )
 209     {
 210         d->metaInfo.applyChanges();
 211         notifyObservers();
 212     }
 213 }
 214
 215 void
 216 Track::setYear( const QString& newYear )
 217 {
 218     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::YEAR ) ).setValue( newYear );
 219     if( !d->batchUpdate )
 220     {
 221         d->metaInfo.applyChanges();
 222         notifyObservers();
 223     }
 224 }
 225
 226 void
 227 Track::setTitle( const QString &newTitle )
 228 {
 229     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::TITLE ) ).setValue( newTitle );
 230     if( !d->batchUpdate )
 231     {
 232         d->metaInfo.applyChanges();
 233         notifyObservers();
 234     }
 235 }
 236
 237 QString
 238 Track::comment() const
 239 {
 240     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::COMMENT ) );
 241     if( item.isValid() )
 242         return item.value().toString();
 243     else
 244         return QString();
 245 }
 246
 247 void
 248 Track::setComment( const QString& newComment )
 249 {
 250     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::COMMENT ) ).setValue( newComment );
 251     if( !d->batchUpdate )
 252     {
 253         d->metaInfo.applyChanges();
 254         notifyObservers();
 255     }
 256 }
 257
 258 double
 259 Track::score() const
 260 {
 261     return 0.0;
 262 }
 263
 264 void
 265 Track::setScore( double newScore )
 266 {
 267     Q_UNUSED( newScore )
 268 }
 269
 270 int
 271 Track::rating() const
 272 {
 273     return 0;
 274 }
 275
 276 void
 277 Track::setRating( int newRating )
 278 {
 279     Q_UNUSED( newRating )
 280 }
 281
 282 int
 283 Track::trackNumber() const
 284 {
 285     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::TRACKNUMBER ) );
 286     if( item.isValid() )
 287         return item.value().toInt();
 288     else
 289         return 0;
 290 }
 291
 292 void
 293 Track::setTrackNumber( int newTrackNumber )
 294 {
 295     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::TRACKNUMBER ) ).setValue( newTrackNumber );
 296     if( !d->batchUpdate )
 297     {
 298         d->metaInfo.applyChanges();
 299         notifyObservers();
 300     }
 301 }
 302
 303 int
 304 Track::discNumber() const
 305 {
 306     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::DISCNUMBER ) );
 307     if( item.isValid() )
 308         return item.value().toInt();
 309     else
 310         return 0;
 311 }
 312
 313 void
 314 Track::setDiscNumber( int newDiscNumber )
 315 {
 316     d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::DISCNUMBER ) ).setValue( newDiscNumber );
 317     if( !d->batchUpdate )
 318     {
 319         d->metaInfo.applyChanges();
 320         notifyObservers();
 321     }
 322 }
 323
 324 int
 325 Track::length() const
 326 {
 327     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::LENGTH ) );
 328     if( item.isValid() )
 329         return item.value().toInt();
 330     else
 331         return 0;
 332 }
 333
 334 int
 335 Track::filesize() const
 336 {
 337     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::FILESIZE ) );
 338     if( item.isValid() )
 339         return item.value().toInt();
 340     else
 341         return 0;
 342 }
 343
 344 int
 345 Track::sampleRate() const
 346 {
 347     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::SAMPLERATE ) );
 348     if( item.isValid() )
 349         return item.value().toInt();
 350     else
 351         return 0;
 352 }
 353
 354 int
 355 Track::bitrate() const
 356 {
 357     KFileMetaInfoItem item = d->metaInfo.item( Meta::Field::xesamPrettyToFullFieldName( Meta::Field::BITRATE ) );
 358     if( item.isValid() )
 359         return item.value().toInt();
 360     else
 361         return 0;
 362 }
 363
 364 uint
 365 Track::lastPlayed() const
 366 {
 367     return 0;
 368 }
 369
 370 int
 371 Track::playCount() const
 372 {
 373     return 0;
 374 }
 375
 376 QString
 377 Track::type() const
 378 {
 379     return "";
 380 }
 381
 382 void
 383 Track::beginMetaDataUpdate()
 384 {
 385     d->batchUpdate = true;
 386 }
 387
 388 void
 389 Track::endMetaDataUpdate()
 390 {
 391     d->metaInfo.applyChanges();
 392     d->batchUpdate = false;
 393     notifyObservers();
 394
 395
 396 }
 397
 398 void
 399 Track::abortMetaDataUpdate()
 400 {
 401     //KFileMetaInfo does not have a method to reset the items
 402     d->metaInfo = KFileMetaInfo( d->url.path() );
 403     d->batchUpdate = false;
 404 }
 405
 406 void
 407 Track::finishedPlaying( double playedFraction )
 408 {
 409     Q_UNUSED( playedFraction );
 410     //TODO
 411 }
 412
 413 bool
 414 Track::inCollection() const
 415 {
 416     return false;
 417 }
 418
 419 Collection*
 420 Track::collection() const
 421 {
 422     return 0;
 423 }
 424
 425 bool
 426 Track::hasCapabilityInterface( Meta::Capability::Type type ) const
 427 {
 428     return type == Meta::Capability::Editable;
 429 }
 430
 431 Meta::Capability*
 432 Track::asCapabilityInterface( Meta::Capability::Type type )
 433 {
 434     switch( type )
 435     {
 436         case Meta::Capability::Editable:
 437             return new EditCapabilityImpl( this );
 438             break;
 439         default:
 440             return 0;
 441     }
 442 }
 443
 444 #include "File.moc"